refactor(766): refactored boolean returns to status code in IComposer

roc-streaming · Dec 23, 2024 · 434ea85 · 434ea85
1 parent 264c175
commit 434ea85
Show file tree

Hide file tree

Showing 20 changed files with 125 additions and 109 deletions.
diff --git a/src/internal_modules/roc_audio/packetizer.cpp b/src/internal_modules/roc_audio/packetizer.cpp
@@ -196,9 +196,10 @@ status::StatusCode Packetizer::create_packet_() {
         return status::StatusNoMem;
     }
 
-    if (!composer_.prepare(*pp, buffer, payload_size_)) {
+    status::StatusCode status = composer_.prepare(*pp, buffer, payload_size_);
+    if (status != status::StatusOK) {
         roc_log(LogError, "packetizer: can't prepare packet");
-        return status::StatusNoMem;
+        return status;
     }
     pp->add_flags(packet::Packet::FlagPrepared);
 
@@ -213,7 +214,8 @@ void Packetizer::pad_packet_(size_t written_payload_size) {
         return;
     }
 
-    if (!composer_.pad(*packet_, payload_size_ - written_payload_size)) {
+    if (composer_.pad(*packet_, payload_size_ - written_payload_size)
+        != status::StatusOK) {
         roc_panic("packetizer: can't pad packet: orig_size=%lu actual_size=%lu",
                   (unsigned long)payload_size_, (unsigned long)written_payload_size);
     }

diff --git a/src/internal_modules/roc_fec/block_writer.cpp b/src/internal_modules/roc_fec/block_writer.cpp
@@ -223,9 +223,9 @@ status::StatusCode BlockWriter::write_source_packet_(const packet::PacketPtr& pp
 
     fill_packet_fec_fields_(pp, (packet::seqnum_t)cur_packet_);
 
-    if (!source_composer_.compose(*pp)) {
-        // TODO(gh-183): forward status from composer
-        return status::StatusBadBuffer;
+    status::StatusCode status = source_composer_.compose(*pp);
+    if (status != status::StatusOK) {
+        return status;
     }
     pp->add_flags(packet::Packet::FlagComposed);
 
@@ -261,16 +261,17 @@ status::StatusCode BlockWriter::make_repair_packet_(packet::seqnum_t pack_n,
         return status::StatusNoMem;
     }
 
-    if (!repair_composer_.align(buffer, 0, block_encoder_.buffer_alignment())) {
+    status::StatusCode status =
+        repair_composer_.align(buffer, 0, block_encoder_.buffer_alignment());
+    if (status != status::StatusOK) {
         roc_log(LogError, "fec block writer: can't align packet buffer");
-        // TODO(gh-183): forward status from composer
-        return status::StatusBadBuffer;
+        return status;
     }
 
-    if (!repair_composer_.prepare(*packet, buffer, cur_payload_size_)) {
+    status = repair_composer_.prepare(*packet, buffer, cur_payload_size_);
+    if (status != status::StatusOK) {
         roc_log(LogError, "fec block writer: can't prepare packet");
-        // TODO(gh-183): forward status from composer
-        return status::StatusBadBuffer;
+        return status;
     }
     packet->add_flags(packet::Packet::FlagPrepared);
 
@@ -304,9 +305,9 @@ status::StatusCode BlockWriter::compose_repair_packets_() {
             continue;
         }
 
-        if (!repair_composer_.compose(*rp)) {
-            // TODO(gh-183): forward status from composer
-            return status::StatusBadBuffer;
+        status::StatusCode status = repair_composer_.compose(*rp);
+        if (status != status::StatusOK) {
+            return status;
         }
         rp->add_flags(packet::Packet::FlagComposed);
     }

diff --git a/src/internal_modules/roc_fec/composer.h b/src/internal_modules/roc_fec/composer.h
@@ -41,7 +41,7 @@ class Composer : public packet::IComposer, public core::NonCopyable<> {
     }
 
     //! Adjust buffer to align payload.
-    virtual bool
+    virtual status::StatusCode
     align(core::Slice<uint8_t>& buffer, size_t header_size, size_t payload_alignment) {
         if ((unsigned long)buffer.data() % payload_alignment != 0) {
             roc_panic("fec composer: unexpected non-aligned buffer");
@@ -59,18 +59,18 @@ class Composer : public packet::IComposer, public core::NonCopyable<> {
                     LogDebug,
                     "fec composer: not enough space for alignment: padding=%lu cap=%lu",
                     (unsigned long)padding, (unsigned long)buffer.capacity());
-                return false;
+                return status::StatusBadBuffer;
             }
 
             buffer.reslice(padding, padding);
-            return true;
+            return status::StatusOK;
         } else {
             return inner_composer_->align(buffer, header_size, payload_alignment);
         }
     }
 
     //! Prepare buffer for composing a packet.
-    virtual bool
+    virtual status::StatusCode
     prepare(packet::Packet& packet, core::Slice<uint8_t>& buffer, size_t payload_size) {
         core::Slice<uint8_t> payload_id = buffer.subslice(0, 0);
 
@@ -80,7 +80,7 @@ class Composer : public packet::IComposer, public core::NonCopyable<> {
                         "fec composer: not enough space for fec header: size=%lu cap=%lu",
                         (unsigned long)sizeof(PayloadID),
                         (unsigned long)payload_id.capacity());
-                return false;
+                return status::StatusBadBuffer;
             }
             payload_id.reslice(0, sizeof(PayloadID));
         }
@@ -89,8 +89,10 @@ class Composer : public packet::IComposer, public core::NonCopyable<> {
             payload_id.subslice(payload_id.size(), payload_id.size());
 
         if (inner_composer_) {
-            if (!inner_composer_->prepare(packet, payload, payload_size)) {
-                return false;
+            status::StatusCode result =
+                inner_composer_->prepare(packet, payload, payload_size);
+            if (result != status::StatusOK) {
+                return result;
             }
         } else {
             payload.reslice(0, payload_size);
@@ -104,7 +106,7 @@ class Composer : public packet::IComposer, public core::NonCopyable<> {
                         "fec composer: not enough space for fec header: size=%lu cap=%lu",
                         (unsigned long)sizeof(PayloadID),
                         (unsigned long)payload_id.capacity());
-                return false;
+                return status::StatusBadBuffer;
             }
             payload_id.reslice(0, sizeof(PayloadID));
         }
@@ -123,21 +125,21 @@ class Composer : public packet::IComposer, public core::NonCopyable<> {
 
         buffer.reslice(0, payload_id.size() + payload.size());
 
-        return true;
+        return status::StatusOK;
     }
 
     //! Pad packet.
-    virtual bool pad(packet::Packet& packet, size_t padding_size) {
+    virtual status::StatusCode pad(packet::Packet& packet, size_t padding_size) {
         if (inner_composer_) {
             return inner_composer_->pad(packet, padding_size);
         }
 
         // padding not supported
-        return false;
+        return status::StatusBadOperation;
     }
 
     //! Compose packet to buffer.
-    virtual bool compose(packet::Packet& packet) {
+    virtual status::StatusCode compose(packet::Packet& packet) {
         if (!packet.fec()) {
             roc_panic("fec composer: unexpected non-fec packet");
         }
@@ -167,7 +169,7 @@ class Composer : public packet::IComposer, public core::NonCopyable<> {
             return inner_composer_->compose(packet);
         }
 
-        return true;
+        return status::StatusOK;
     }
 
 private:

diff --git a/src/internal_modules/roc_packet/icomposer.h b/src/internal_modules/roc_packet/icomposer.h
@@ -42,7 +42,7 @@ class IComposer : public core::ArenaAllocation {
     //! @returns
     //!  true if the buffer was successfully adjusted or false if the @p buffer
     //!  capacity is not enough.
-    virtual bool
+    virtual status::StatusCode
     align(core::Slice<uint8_t>& buffer, size_t header_size, size_t payload_alignment) = 0;
 
     //! Prepare buffer for composing a packet.
@@ -55,7 +55,7 @@ class IComposer : public core::ArenaAllocation {
     //! @returns
     //!  true if the packet was successfully prepared or false if the @p buffer
     //!  capacity is not enough.
-    virtual bool
+    virtual status::StatusCode
     prepare(Packet& packet, core::Slice<uint8_t>& buffer, size_t payload_size) = 0;
 
     //! Pad packet.
@@ -66,15 +66,15 @@ class IComposer : public core::ArenaAllocation {
     //! @returns
     //!  true if the packet was successfully padded or false if parameters
     //!  are invalid or padding is not supported.
-    virtual bool pad(Packet& packet, size_t padding_size) = 0;
+    virtual status::StatusCode pad(Packet& packet, size_t padding_size) = 0;
 
     //! Compose packet to buffer.
     //! @remarks
     //!  Formats @p packet headers and payloads to the buffer attached to it during
     //!  a previous prepare() call.
     //! @returns
     //!  true if the packet was successfully composed or false if an error occurred.
-    virtual bool compose(Packet& packet) = 0;
+    virtual status::StatusCode compose(Packet& packet) = 0;
 };
 
 } // namespace packet

diff --git a/src/internal_modules/roc_packet/shipper.cpp b/src/internal_modules/roc_packet/shipper.cpp
@@ -46,7 +46,7 @@ status::StatusCode Shipper::write(const PacketPtr& packet) {
     }
 
     if (!packet->has_flags(Packet::FlagComposed)) {
-        if (!composer_.compose(*packet)) {
+        if (composer_.compose(*packet) != status::StatusOK) {
             roc_log(LogError, "shipper: can't compose packet");
             return status::StatusNoMem;
         }

diff --git a/src/internal_modules/roc_rtcp/communicator.cpp b/src/internal_modules/roc_rtcp/communicator.cpp
@@ -576,9 +576,10 @@ status::StatusCode Communicator::generate_packet_(PacketType packet_type,
     packet_buffer.reslice(0, 0);
 
     // Prepare packet to be able to hold our RTCP packet data
-    if (!packet_composer_.prepare(*packet, packet_buffer, payload_buffer.size())) {
+    status = packet_composer_.prepare(*packet, packet_buffer, payload_buffer.size());
+    if (status != status::StatusOK) {
         roc_log(LogError, "rtcp communicator: can't prepare packet");
-        return status::StatusNoMem;
+        return status;
     }
     packet->add_flags(packet::Packet::FlagPrepared);
 

diff --git a/src/internal_modules/roc_rtcp/composer.cpp b/src/internal_modules/roc_rtcp/composer.cpp
@@ -22,9 +22,9 @@ status::StatusCode Composer::init_status() const {
     return status::StatusOK;
 }
 
-bool Composer::align(core::Slice<uint8_t>& buffer,
-                     size_t header_size,
-                     size_t payload_alignment) {
+status::StatusCode Composer::align(core::Slice<uint8_t>& buffer,
+                                   size_t header_size,
+                                   size_t payload_alignment) {
     if ((unsigned long)buffer.data() % payload_alignment != 0) {
         roc_panic("rtcp composer: unexpected non-aligned buffer");
     }
@@ -35,51 +35,51 @@ bool Composer::align(core::Slice<uint8_t>& buffer,
         roc_log(LogDebug,
                 "rtcp composer: not enough space for alignment: padding=%lu cap=%lu",
                 (unsigned long)padding, (unsigned long)buffer.capacity());
-        return false;
+        return status::StatusBadBuffer;
     }
 
     buffer.reslice(padding, padding);
-    return true;
+    return status::StatusOK;
 }
 
-bool Composer::prepare(packet::Packet& packet,
-                       core::Slice<uint8_t>& buffer,
-                       size_t payload_size) {
+status::StatusCode Composer::prepare(packet::Packet& packet,
+                                     core::Slice<uint8_t>& buffer,
+                                     size_t payload_size) {
     buffer.reslice(0, payload_size);
 
     packet.add_flags(packet::Packet::FlagControl);
     packet.add_flags(packet::Packet::FlagRTCP);
 
     packet.rtcp()->payload = buffer;
 
-    return true;
+    return status::StatusOK;
 }
 
-bool Composer::pad(packet::Packet& packet, size_t padding_size) {
+status::StatusCode Composer::pad(packet::Packet& packet, size_t padding_size) {
     // not supported
 
     (void)packet;
     (void)padding_size;
 
-    return false;
+    return status::StatusBadOperation;
 }
 
-bool Composer::compose(packet::Packet& packet) {
+status::StatusCode Composer::compose(packet::Packet& packet) {
     if (!packet.rtcp()) {
         roc_panic("rtcp composer: unexpected non-rctp packet");
     }
 
     if (!packet.rtcp()->payload) {
         roc_log(LogError, "rtcp composer: unexpected null data");
-        return false;
+        return status::StatusBadOperation;
     }
 
     if (packet.rtcp()->payload.size() == 0) {
         roc_log(LogError, "rtcp composer: unexpected zero data");
-        return false;
+        return status::StatusBadOperation;
     }
 
-    return true;
+    return status::StatusOK;
 }
 
 } // namespace rtcp

diff --git a/src/internal_modules/roc_rtcp/composer.h b/src/internal_modules/roc_rtcp/composer.h
@@ -33,18 +33,18 @@ class Composer : public packet::IComposer, public core::NonCopyable<> {
     virtual status::StatusCode init_status() const;
 
     //! Adjust buffer to align payload.
-    virtual bool
+    virtual status::StatusCode
     align(core::Slice<uint8_t>& buffer, size_t header_size, size_t payload_alignment);
 
     //! Prepare buffer for composing a packet.
-    virtual bool
+    virtual status::StatusCode
     prepare(packet::Packet& packet, core::Slice<uint8_t>& buffer, size_t payload_size);
 
     //! Pad packet.
-    virtual bool pad(packet::Packet& packet, size_t padding_size);
+    virtual status::StatusCode pad(packet::Packet& packet, size_t padding_size);
 
     //! Compose packet to buffer.
-    virtual bool compose(packet::Packet& packet);
+    virtual status::StatusCode compose(packet::Packet& packet);
 };
 
 } // namespace rtcp