bitrate_controller.h revision 2e10b8e4a05c041a3c39ddc7499bdffdb67999fa
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 * Usage: this class will register multiple RtcpBitrateObserver's one at each 11 * RTCP module. It will aggregate the results and run one bandwidth estimation 12 * and push the result to the encoders via BitrateObserver(s). 13 */ 14 15#ifndef WEBRTC_MODULES_BITRATE_CONTROLLER_INCLUDE_BITRATE_CONTROLLER_H_ 16#define WEBRTC_MODULES_BITRATE_CONTROLLER_INCLUDE_BITRATE_CONTROLLER_H_ 17 18#include "webrtc/modules/rtp_rtcp/interface/rtp_rtcp_defines.h" 19 20namespace webrtc { 21 22class BitrateObserver { 23 /* 24 * Observer class for the encoders, each encoder should implement this class 25 * to get the target bitrate. It also get the fraction loss and rtt to 26 * optimize its settings for this type of network. |target_bitrate| is the 27 * target media/payload bitrate excluding packet headers, measured in bits 28 * per second. 29 */ 30 public: 31 virtual void OnNetworkChanged(const uint32_t target_bitrate, 32 const uint8_t fraction_loss, // 0 - 255. 33 const uint32_t rtt) = 0; 34 35 virtual ~BitrateObserver() {} 36}; 37 38class BitrateController { 39/* 40 * This class collects feedback from all streams sent to a peer (via 41 * RTCPBandwidthObservers). It does one aggregated send side bandwidth 42 * estimation and divide the available bitrate between all its registered 43 * BitrateObservers. 44 */ 45 public: 46 static BitrateController* CreateBitrateController(); 47 virtual ~BitrateController() {} 48 49 virtual RtcpBandwidthObserver* CreateRtcpBandwidthObserver() = 0; 50 51 // Gets the available payload bandwidth in bits per second. Note that 52 // this bandwidth excludes packet headers. 53 virtual bool AvailableBandwidth(uint32_t* bandwidth) const = 0; 54 55 /* 56 * Set the start and max send bitrate used by the bandwidth management. 57 * 58 * observer, updates bitrates if already in use. 59 * min_bitrate_kbit = 0 equals no min bitrate. 60 * max_bitrate_kit = 0 equals no max bitrate. 61 */ 62 virtual void SetBitrateObserver(BitrateObserver* observer, 63 const uint32_t start_bitrate, 64 const uint32_t min_bitrate, 65 const uint32_t max_bitrate) = 0; 66 67 virtual void RemoveBitrateObserver(BitrateObserver* observer) = 0; 68}; 69} // namespace webrtc 70#endif // WEBRTC_MODULES_BITRATE_CONTROLLER_INCLUDE_BITRATE_CONTROLLER_H_ 71