OLD | NEW |
---|---|
1 /* | 1 /* |
2 * Copyright (c) 2015 The WebRTC project authors. All Rights Reserved. | 2 * Copyright (c) 2015 The WebRTC project authors. All Rights Reserved. |
3 * | 3 * |
4 * Use of this source code is governed by a BSD-style license | 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 | 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 | 6 * tree. An additional intellectual property rights grant can be found |
7 * in the file PATENTS. All contributing project authors may | 7 * in the file PATENTS. All contributing project authors may |
8 * be found in the AUTHORS file in the root of the source tree. | 8 * be found in the AUTHORS file in the root of the source tree. |
9 * | 9 * |
10 * Usage: this class will register multiple RtcpBitrateObserver's one at each | 10 * Usage: this class will register multiple RtcpBitrateObserver's one at each |
stefan-webrtc
2016/03/11 13:43:53
Change this comment to be C++ style and separate i
mflodman
2016/03/11 14:26:05
Done, and moved to the class as in style guide.
| |
11 * RTCP module. It will aggregate the results and run one bandwidth estimation | 11 * RTCP module. It will aggregate the results and run one bandwidth estimation |
12 * and push the result to the encoders via BitrateObserver(s). | 12 * and push the result to the encoders via BitrateAllocatorObserver(s). |
13 */ | 13 */ |
14 | 14 |
15 #ifndef WEBRTC_CALL_BITRATE_ALLOCATOR_H_ | 15 #ifndef WEBRTC_CALL_BITRATE_ALLOCATOR_H_ |
16 #define WEBRTC_CALL_BITRATE_ALLOCATOR_H_ | 16 #define WEBRTC_CALL_BITRATE_ALLOCATOR_H_ |
17 | 17 |
18 #include <list> | 18 #include <list> |
19 #include <map> | 19 #include <map> |
20 #include <utility> | 20 #include <utility> |
21 | 21 |
22 #include "webrtc/base/criticalsection.h" | 22 #include "webrtc/base/criticalsection.h" |
23 #include "webrtc/base/scoped_ptr.h" | 23 #include "webrtc/base/scoped_ptr.h" |
24 #include "webrtc/base/thread_annotations.h" | 24 #include "webrtc/base/thread_annotations.h" |
25 | 25 |
26 namespace webrtc { | 26 namespace webrtc { |
27 | 27 |
28 class BitrateObserver; | 28 class BitrateAllocatorObserver { |
mflodman
2016/03/11 12:45:03
This is mainly to disconnect the send streams from
stefan-webrtc
2016/03/11 13:43:53
Probably a good idea to make it clear that send st
mflodman
2016/03/11 14:26:05
Done.
| |
29 public: | |
30 virtual void OnBitrateUpdated(uint32_t bitrate_bps, | |
31 uint8_t fraction_loss, | |
32 int64_t rtt) = 0; | |
33 virtual ~BitrateAllocatorObserver() {} | |
34 }; | |
29 | 35 |
30 class BitrateAllocator { | 36 class BitrateAllocator { |
31 public: | 37 public: |
32 BitrateAllocator(); | 38 BitrateAllocator(); |
33 | 39 |
34 // Allocate target_bitrate across the registered BitrateObservers. | 40 // Allocate target_bitrate across the registered BitrateAllocatorObservers. |
35 // Returns actual bitrate allocated (might be higher than target_bitrate if | 41 // Returns actual bitrate allocated (might be higher than target_bitrate if |
36 // for instance EnforceMinBitrate() is enabled. | 42 // for instance EnforceMinBitrate() is enabled. |
37 uint32_t OnNetworkChanged(uint32_t target_bitrate, | 43 uint32_t OnNetworkChanged(uint32_t target_bitrate, |
38 uint8_t fraction_loss, | 44 uint8_t fraction_loss, |
39 int64_t rtt); | 45 int64_t rtt); |
40 | 46 |
41 // Set the start and max send bitrate used by the bandwidth management. | 47 // Set the start and max send bitrate used by the bandwidth management. |
42 // | 48 // |
43 // |observer| updates bitrates if already in use. | 49 // |observer| updates bitrates if already in use. |
44 // |min_bitrate_bps| = 0 equals no min bitrate. | 50 // |min_bitrate_bps| = 0 equals no min bitrate. |
45 // |max_bitrate_bps| = 0 equals no max bitrate. | 51 // |max_bitrate_bps| = 0 equals no max bitrate. |
46 // Returns bitrate allocated for the bitrate observer. | 52 // Returns bitrate allocated for the bitrate observer. |
47 int AddBitrateObserver(BitrateObserver* observer, | 53 int AddObserver(BitrateAllocatorObserver* observer, |
48 uint32_t min_bitrate_bps, | 54 uint32_t min_bitrate_bps, |
49 uint32_t max_bitrate_bps); | 55 uint32_t max_bitrate_bps); |
50 | 56 |
51 void RemoveBitrateObserver(BitrateObserver* observer); | 57 void RemoveObserver(BitrateAllocatorObserver* observer); |
52 | 58 |
53 void GetMinMaxBitrateSumBps(int* min_bitrate_sum_bps, | 59 void GetMinMaxBitrateSumBps(int* min_bitrate_sum_bps, |
54 int* max_bitrate_sum_bps) const; | 60 int* max_bitrate_sum_bps) const; |
55 | 61 |
56 // This method controls the behavior when the available bitrate is lower than | 62 // This method controls the behavior when the available bitrate is lower than |
57 // the minimum bitrate, or the sum of minimum bitrates. | 63 // the minimum bitrate, or the sum of minimum bitrates. |
58 // When true, the bitrate will never be set lower than the minimum bitrate(s). | 64 // When true, the bitrate will never be set lower than the minimum bitrate(s). |
59 // When false, the bitrate observers will be allocated rates up to their | 65 // When false, the bitrate observers will be allocated rates up to their |
60 // respective minimum bitrate, satisfying one observer after the other. | 66 // respective minimum bitrate, satisfying one observer after the other. |
61 void EnforceMinBitrate(bool enforce_min_bitrate); | 67 void EnforceMinBitrate(bool enforce_min_bitrate); |
62 | 68 |
63 private: | 69 private: |
64 struct BitrateConfiguration { | 70 struct BitrateConfiguration { |
65 BitrateConfiguration(uint32_t min_bitrate, uint32_t max_bitrate) | 71 BitrateConfiguration(uint32_t min_bitrate, uint32_t max_bitrate) |
66 : min_bitrate(min_bitrate), max_bitrate(max_bitrate) {} | 72 : min_bitrate(min_bitrate), max_bitrate(max_bitrate) {} |
67 uint32_t min_bitrate; | 73 uint32_t min_bitrate; |
68 uint32_t max_bitrate; | 74 uint32_t max_bitrate; |
69 }; | 75 }; |
70 struct ObserverConfiguration { | 76 struct ObserverConfiguration { |
71 ObserverConfiguration(BitrateObserver* observer, uint32_t bitrate) | 77 ObserverConfiguration(BitrateAllocatorObserver* observer, uint32_t bitrate) |
72 : observer(observer), min_bitrate(bitrate) {} | 78 : observer(observer), min_bitrate(bitrate) {} |
73 BitrateObserver* const observer; | 79 BitrateAllocatorObserver* const observer; |
74 uint32_t min_bitrate; | 80 uint32_t min_bitrate; |
75 }; | 81 }; |
76 typedef std::pair<BitrateObserver*, BitrateConfiguration> | 82 typedef std::pair<BitrateAllocatorObserver*, BitrateConfiguration> |
77 BitrateObserverConfiguration; | 83 BitrateObserverConfiguration; |
78 typedef std::list<BitrateObserverConfiguration> BitrateObserverConfList; | 84 typedef std::list<BitrateObserverConfiguration> BitrateObserverConfList; |
79 typedef std::multimap<uint32_t, ObserverConfiguration> ObserverSortingMap; | 85 typedef std::multimap<uint32_t, ObserverConfiguration> ObserverSortingMap; |
80 typedef std::map<BitrateObserver*, int> ObserverBitrateMap; | 86 typedef std::map<BitrateAllocatorObserver*, int> ObserverBitrateMap; |
81 | 87 |
82 BitrateObserverConfList::iterator FindObserverConfigurationPair( | 88 BitrateObserverConfList::iterator FindObserverConfigurationPair( |
83 const BitrateObserver* observer) EXCLUSIVE_LOCKS_REQUIRED(crit_sect_); | 89 const BitrateAllocatorObserver* observer) |
90 EXCLUSIVE_LOCKS_REQUIRED(crit_sect_); | |
84 ObserverBitrateMap AllocateBitrates() EXCLUSIVE_LOCKS_REQUIRED(crit_sect_); | 91 ObserverBitrateMap AllocateBitrates() EXCLUSIVE_LOCKS_REQUIRED(crit_sect_); |
85 ObserverBitrateMap NormalRateAllocation(uint32_t bitrate, | 92 ObserverBitrateMap NormalRateAllocation(uint32_t bitrate, |
86 uint32_t sum_min_bitrates) | 93 uint32_t sum_min_bitrates) |
87 EXCLUSIVE_LOCKS_REQUIRED(crit_sect_); | 94 EXCLUSIVE_LOCKS_REQUIRED(crit_sect_); |
88 | 95 |
89 ObserverBitrateMap LowRateAllocation(uint32_t bitrate) | 96 ObserverBitrateMap LowRateAllocation(uint32_t bitrate) |
90 EXCLUSIVE_LOCKS_REQUIRED(crit_sect_); | 97 EXCLUSIVE_LOCKS_REQUIRED(crit_sect_); |
91 | 98 |
92 rtc::CriticalSection crit_sect_; | 99 rtc::CriticalSection crit_sect_; |
93 // Stored in a list to keep track of the insertion order. | 100 // Stored in a list to keep track of the insertion order. |
94 BitrateObserverConfList bitrate_observers_ GUARDED_BY(crit_sect_); | 101 BitrateObserverConfList bitrate_observers_ GUARDED_BY(crit_sect_); |
95 bool bitrate_observers_modified_ GUARDED_BY(crit_sect_); | 102 bool bitrate_observers_modified_ GUARDED_BY(crit_sect_); |
96 bool enforce_min_bitrate_ GUARDED_BY(crit_sect_); | 103 bool enforce_min_bitrate_ GUARDED_BY(crit_sect_); |
97 uint32_t last_bitrate_bps_ GUARDED_BY(crit_sect_); | 104 uint32_t last_bitrate_bps_ GUARDED_BY(crit_sect_); |
98 uint8_t last_fraction_loss_ GUARDED_BY(crit_sect_); | 105 uint8_t last_fraction_loss_ GUARDED_BY(crit_sect_); |
99 int64_t last_rtt_ GUARDED_BY(crit_sect_); | 106 int64_t last_rtt_ GUARDED_BY(crit_sect_); |
100 }; | 107 }; |
101 } // namespace webrtc | 108 } // namespace webrtc |
102 #endif // WEBRTC_CALL_BITRATE_ALLOCATOR_H_ | 109 #endif // WEBRTC_CALL_BITRATE_ALLOCATOR_H_ |
OLD | NEW |