Line data    Source code

       1             : /*
       2             :  *  Copyright (c) 2016 The WebRTC project authors. All Rights Reserved.
       3             :  *
       4             :  *  Use of this source code is governed by a BSD-style license
       5             :  *  that can be found in the LICENSE file in the root of the source
       6             :  *  tree. An additional intellectual property rights grant can be found
       7             :  *  in the file PATENTS.  All contributing project authors may
       8             :  *  be found in the AUTHORS file in the root of the source tree.
       9             :  */
      10             : 
      11             : #ifndef WEBRTC_MODULES_RTP_RTCP_INCLUDE_FLEXFEC_SENDER_H_
      12             : #define WEBRTC_MODULES_RTP_RTCP_INCLUDE_FLEXFEC_SENDER_H_
      13             : 
      14             : #include <memory>
      15             : #include <vector>
      16             : 
      17             : #include "webrtc/base/basictypes.h"
      18             : #include "webrtc/base/random.h"
      19             : #include "webrtc/base/sequenced_task_checker.h"
      20             : #include "webrtc/config.h"
      21             : #include "webrtc/modules/include/module_common_types.h"
      22             : #include "webrtc/modules/rtp_rtcp/include/flexfec_sender.h"
      23             : #include "webrtc/modules/rtp_rtcp/source/rtp_header_extension.h"
      24             : #include "webrtc/modules/rtp_rtcp/source/rtp_packet_to_send.h"
      25             : #include "webrtc/modules/rtp_rtcp/source/ulpfec_generator.h"
      26             : #include "webrtc/system_wrappers/include/clock.h"
      27             : 
      28             : namespace webrtc {
      29             : 
      30             : class RtpPacketToSend;
      31             : 
      32             : // Note that this class is not thread safe, and thus requires external
      33             : // synchronization.
      34             : 
      35           0 : class FlexfecSender {
      36             :  public:
      37             :   FlexfecSender(int payload_type,
      38             :                 uint32_t ssrc,
      39             :                 uint32_t protected_media_ssrc,
      40             :                 const std::vector<RtpExtension>& rtp_header_extensions,
      41             :                 Clock* clock);
      42             :   ~FlexfecSender();
      43             : 
      44           0 :   uint32_t ssrc() const { return ssrc_; }
      45             : 
      46             :   // Sets the FEC rate, max frames sent before FEC packets are sent,
      47             :   // and what type of generator matrices are used.
      48             :   void SetFecParameters(const FecProtectionParams& params);
      49             : 
      50             :   // Adds a media packet to the internal buffer. When enough media packets
      51             :   // have been added, the FEC packets are generated and stored internally.
      52             :   // These FEC packets are then obtained by calling GetFecPackets().
      53             :   // Returns true if the media packet was successfully added.
      54             :   bool AddRtpPacketAndGenerateFec(const RtpPacketToSend& packet);
      55             : 
      56             :   // Returns true if there are generated FEC packets available.
      57             :   bool FecAvailable() const;
      58             : 
      59             :   // Returns generated FlexFEC packets.
      60             :   std::vector<std::unique_ptr<RtpPacketToSend>> GetFecPackets();
      61             : 
      62             :   // Returns the overhead, per packet, for FlexFEC.
      63             :   size_t MaxPacketOverhead() const;
      64             : 
      65             :  private:
      66             :   // Utility.
      67             :   Clock* const clock_;
      68             :   Random random_;
      69             :   int64_t last_generated_packet_ms_;
      70             : 
      71             :   // Config.
      72             :   const int payload_type_;
      73             :   const uint32_t timestamp_offset_;
      74             :   const uint32_t ssrc_;
      75             :   const uint32_t protected_media_ssrc_;
      76             :   // Sequence number of next packet to generate.
      77             :   uint16_t seq_num_;
      78             : 
      79             :   // Implementation.
      80             :   UlpfecGenerator ulpfec_generator_;
      81             :   const RtpHeaderExtensionMap rtp_header_extension_map_;
      82             : };
      83             : 
      84             : }  // namespace webrtc
      85             : 
      86             : #endif  // WEBRTC_MODULES_RTP_RTCP_INCLUDE_FLEXFEC_SENDER_H_