1 /* 2 * Copyright (c) 2012 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 // This class estimates the incoming available bandwidth. 12 13 #ifndef WEBRTC_MODULES_REMOTE_BITRATE_ESTIMATOR_INCLUDE_REMOTE_BITRATE_ESTIMATOR_H_ 14 #define WEBRTC_MODULES_REMOTE_BITRATE_ESTIMATOR_INCLUDE_REMOTE_BITRATE_ESTIMATOR_H_ 15 16 #include <map> 17 #include <vector> 18 19 #include "webrtc/common_types.h" 20 #include "webrtc/modules/include/module.h" 21 #include "webrtc/modules/include/module_common_types.h" 22 #include "webrtc/modules/rtp_rtcp/include/rtp_rtcp_defines.h" 23 #include "webrtc/typedefs.h" 24 25 namespace webrtc { 26 27 class Clock; 28 29 // RemoteBitrateObserver is used to signal changes in bitrate estimates for 30 // the incoming streams. 31 class RemoteBitrateObserver { 32 public: 33 // Called when a receive channel group has a new bitrate estimate for the 34 // incoming streams. 35 virtual void OnReceiveBitrateChanged(const std::vector<unsigned int>& ssrcs, 36 unsigned int bitrate) = 0; 37 ~RemoteBitrateObserver()38 virtual ~RemoteBitrateObserver() {} 39 }; 40 41 struct ReceiveBandwidthEstimatorStats { ReceiveBandwidthEstimatorStatsReceiveBandwidthEstimatorStats42 ReceiveBandwidthEstimatorStats() : total_propagation_time_delta_ms(0) {} 43 44 // The "propagation_time_delta" of a frame is defined as (d_arrival - d_sent), 45 // where d_arrival is the delta of the arrival times of the frame and the 46 // previous frame, d_sent is the delta of the sent times of the frame and 47 // the previous frame. The sent time is calculated from the RTP timestamp. 48 49 // |total_propagation_time_delta_ms| is the sum of the propagation_time_deltas 50 // of all received frames, except that it's is adjusted to 0 when it becomes 51 // negative. 52 int total_propagation_time_delta_ms; 53 // The propagation_time_deltas for the frames arrived in the last 54 // kProcessIntervalMs using the clock passed to 55 // RemoteBitrateEstimatorFactory::Create. 56 std::vector<int> recent_propagation_time_delta_ms; 57 // The arrival times for the frames arrived in the last kProcessIntervalMs 58 // using the clock passed to RemoteBitrateEstimatorFactory::Create. 59 std::vector<int64_t> recent_arrival_time_ms; 60 }; 61 62 class RemoteBitrateEstimator : public CallStatsObserver, public Module { 63 public: 64 static const int kDefaultMinBitrateBps = 30000; ~RemoteBitrateEstimator()65 virtual ~RemoteBitrateEstimator() {} 66 IncomingPacketFeedbackVector(const std::vector<PacketInfo> & packet_feedback_vector)67 virtual void IncomingPacketFeedbackVector( 68 const std::vector<PacketInfo>& packet_feedback_vector) { 69 assert(false); 70 } 71 72 // Called for each incoming packet. Updates the incoming payload bitrate 73 // estimate and the over-use detector. If an over-use is detected the 74 // remote bitrate estimate will be updated. Note that |payload_size| is the 75 // packet size excluding headers. 76 // Note that |arrival_time_ms| can be of an arbitrary time base. 77 virtual void IncomingPacket(int64_t arrival_time_ms, 78 size_t payload_size, 79 const RTPHeader& header, 80 bool was_paced) = 0; 81 82 // Removes all data for |ssrc|. 83 virtual void RemoveStream(unsigned int ssrc) = 0; 84 85 // Returns true if a valid estimate exists and sets |bitrate_bps| to the 86 // estimated payload bitrate in bits per second. |ssrcs| is the list of ssrcs 87 // currently being received and of which the bitrate estimate is based upon. 88 virtual bool LatestEstimate(std::vector<unsigned int>* ssrcs, 89 unsigned int* bitrate_bps) const = 0; 90 91 // Returns true if the statistics are available. 92 virtual bool GetStats(ReceiveBandwidthEstimatorStats* output) const = 0; 93 94 virtual void SetMinBitrate(int min_bitrate_bps) = 0; 95 96 protected: 97 static const int64_t kProcessIntervalMs = 500; 98 static const int64_t kStreamTimeOutMs = 2000; 99 }; 100 101 } // namespace webrtc 102 103 #endif // WEBRTC_MODULES_REMOTE_BITRATE_ESTIMATOR_INCLUDE_REMOTE_BITRATE_ESTIMATOR_H_ 104