Generalize UlpfecPacketGenerator into AugmentedPacketGenerator. (pt. 8)

webrtc/modules/rtp_rtcp/source/fec_test_helper.h

 /*
  *  Copyright (c) 2012 The WebRTC project authors. All Rights Reserved.
  *
  *  Use of this source code is governed by a BSD-style license
  *  that can be found in the LICENSE file in the root of the source
  *  tree. An additional intellectual property rights grant can be found
  *  in the file PATENTS.  All contributing project authors may
  *  be found in the AUTHORS file in the root of the source tree.
  */
 
 #ifndef WEBRTC_MODULES_RTP_RTCP_SOURCE_FEC_TEST_HELPER_H_
 #define WEBRTC_MODULES_RTP_RTCP_SOURCE_FEC_TEST_HELPER_H_
 
+#include <memory>
+
 #include "webrtc/base/basictypes.h"
 #include "webrtc/base/random.h"
 #include "webrtc/modules/include/module_common_types.h"
 #include "webrtc/modules/rtp_rtcp/source/forward_error_correction.h"
 
 namespace webrtc {
 namespace test {
 namespace fec {
 
-struct RawRtpPacket : public ForwardErrorCorrection::Packet {
+struct AugmentedPacket : public ForwardErrorCorrection::Packet {
   WebRtcRTPHeader header;
 };
 
+// TODO(brandtr): Consider merging MediaPacketGenerator and
+// AugmentedPacketGenerator into a single class, since their functionality is
+// similar.
+
 // This class generates media packets corresponding to a single frame.
 class MediaPacketGenerator {
  public:
   MediaPacketGenerator(uint32_t min_packet_size,
                        uint32_t max_packet_size,
                        uint32_t ssrc,
                        Random* random)
       : min_packet_size_(min_packet_size),
         max_packet_size_(max_packet_size),
         ssrc_(ssrc),
@@ skipping 11 matching lines @@
  private:
   uint32_t min_packet_size_;
   uint32_t max_packet_size_;
   uint32_t ssrc_;
   Random* random_;
 
   ForwardErrorCorrection::PacketList media_packets_;
   uint16_t fec_seq_num_;
 };
 
+// This class generates media packets with a certain structure of the payload.
+class AugmentedPacketGenerator {
+ public:
+  explicit AugmentedPacketGenerator(uint32_t ssrc);
+
+  // Prepare for generating a new set of packets, corresponding to a frame.
+  void NewFrame(size_t num_packets);
+
+  // Increment and return the sequence number.

[philipel, 2016/09/22 11:29:30]

// Increment and returns the newly incremented sequence number.

[brandtr, 2016/09/22 14:21:39]

Done.

+  uint16_t NextSeqNum();

[philipel, 2016/09/22 11:29:30]

I think NextPacketSeqNum might be a better name in this case, WDYT?

[brandtr, 2016/09/22 14:21:39]

Yep, that works.

+
+  // Return the next packet in the current frame.
+  std::unique_ptr<AugmentedPacket> NextPacket(size_t offset, size_t length);
+
+ protected:
+  // Given |header|, writes the appropriate RTP header fields in |data|.
+  static void WriteRtpHeader(const RTPHeader& header, uint8_t* data);
+
+  size_t num_packets_;  // Number of packets to generate.

[philipel, 2016/09/22 11:29:30]

Move comment above |num_packets_|

[brandtr, 2016/09/22 14:21:39]

Done.

+
+ private:
+  uint32_t ssrc_;
+  uint16_t seq_num_;
+  uint32_t timestamp_;
+};
+
 // This class generates media and ULPFEC packets (both encapsulated in RED)
 // for a single frame.
-class UlpfecPacketGenerator {
+class UlpfecPacketGenerator : public AugmentedPacketGenerator {
  public:
-  UlpfecPacketGenerator();
+  explicit UlpfecPacketGenerator(uint32_t ssrc);
 
-  void NewFrame(int num_packets);
+  // Creates a new AugmentedPacket with the RED header added to the packet.
+  static std::unique_ptr<AugmentedPacket> BuildMediaRedPacket(
+      const AugmentedPacket& packet);
 
-  uint16_t NextSeqNum();
-
-  RawRtpPacket* NextPacket(int offset, size_t length);
-
-  // Creates a new RtpPacket with the RED header added to the packet.
-  RawRtpPacket* BuildMediaRedPacket(const RawRtpPacket* packet);
-
-  // Creates a new RtpPacket with FEC payload and red header. Does this by
-  // creating a new fake media RtpPacket, clears the marker bit and adds a RED
-  // header. Finally replaces the payload with the content of |packet->data|.
-  RawRtpPacket* BuildFecRedPacket(const ForwardErrorCorrection::Packet* packet);
-
-  void SetRedHeader(ForwardErrorCorrection::Packet* red_packet,
-                    uint8_t payload_type,
-                    size_t header_length) const;
+  // Creates a new AugmentedPacket with FEC payload and RED header. Does this by
+  // creating a new fake media AugmentedPacket, clears the marker bit and adds a
+  // RED header. Finally replaces the payload with the content of
+  // |packet->data|.
+  std::unique_ptr<AugmentedPacket> BuildUlpfecRedPacket(
+      const ForwardErrorCorrection::Packet& packet);
 
  private:
-  static void BuildRtpHeader(uint8_t* data, const RTPHeader* header);
-
-  int num_packets_;
-  uint16_t seq_num_;
-  uint32_t timestamp_;
+  static void SetRedHeader(uint8_t payload_type,
+                           size_t header_length,
+                           AugmentedPacket* red_packet);
 };
 
 }  // namespace fec
 }  // namespace test
 }  // namespace webrtc
 
 #endif  // WEBRTC_MODULES_RTP_RTCP_SOURCE_FEC_TEST_HELPER_H_