OLD | NEW |
1 /* | 1 /* |
2 * Copyright (c) 2012 The WebRTC project authors. All Rights Reserved. | 2 * Copyright (c) 2012 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 | 10 |
(...skipping 15 matching lines...) Expand all Loading... |
26 class CriticalSectionWrapper; | 26 class CriticalSectionWrapper; |
27 | 27 |
28 namespace paced_sender { | 28 namespace paced_sender { |
29 class IntervalBudget; | 29 class IntervalBudget; |
30 struct Packet; | 30 struct Packet; |
31 class PacketQueue; | 31 class PacketQueue; |
32 } // namespace paced_sender | 32 } // namespace paced_sender |
33 | 33 |
34 class PacedSender : public Module, public RtpPacketSender { | 34 class PacedSender : public Module, public RtpPacketSender { |
35 public: | 35 public: |
36 class Callback { | 36 class PacketSender { |
37 public: | 37 public: |
38 // Note: packets sent as a result of a callback should not pass by this | 38 // Note: packets sent as a result of a callback should not pass by this |
39 // module again. | 39 // module again. |
40 // Called when it's time to send a queued packet. | 40 // Called when it's time to send a queued packet. |
41 // Returns false if packet cannot be sent. | 41 // Returns false if packet cannot be sent. |
42 virtual bool TimeToSendPacket(uint32_t ssrc, | 42 virtual bool TimeToSendPacket(uint32_t ssrc, |
43 uint16_t sequence_number, | 43 uint16_t sequence_number, |
44 int64_t capture_time_ms, | 44 int64_t capture_time_ms, |
45 bool retransmission) = 0; | 45 bool retransmission) = 0; |
46 // Called when it's a good time to send a padding data. | 46 // Called when it's a good time to send a padding data. |
47 // Returns the number of bytes sent. | 47 // Returns the number of bytes sent. |
48 virtual size_t TimeToSendPadding(size_t bytes) = 0; | 48 virtual size_t TimeToSendPadding(size_t bytes) = 0; |
49 | 49 |
50 protected: | 50 protected: |
51 virtual ~Callback() {} | 51 virtual ~PacketSender() {} |
52 }; | 52 }; |
53 | 53 |
54 // Expected max pacer delay in ms. If ExpectedQueueTimeMs() is higher than | 54 // Expected max pacer delay in ms. If ExpectedQueueTimeMs() is higher than |
55 // this value, the packet producers should wait (eg drop frames rather than | 55 // this value, the packet producers should wait (eg drop frames rather than |
56 // encoding them). Bitrate sent may temporarily exceed target set by | 56 // encoding them). Bitrate sent may temporarily exceed target set by |
57 // UpdateBitrate() so that this limit will be upheld. | 57 // UpdateBitrate() so that this limit will be upheld. |
58 static const int64_t kMaxQueueLengthMs; | 58 static const int64_t kMaxQueueLengthMs; |
59 // Pace in kbits/s until we receive first estimate. | 59 // Pace in kbits/s until we receive first estimate. |
60 static const int kDefaultInitialPaceKbps = 2000; | 60 static const int kDefaultInitialPaceKbps = 2000; |
61 // Pacing-rate relative to our target send rate. | 61 // Pacing-rate relative to our target send rate. |
62 // Multiplicative factor that is applied to the target bitrate to calculate | 62 // Multiplicative factor that is applied to the target bitrate to calculate |
63 // the number of bytes that can be transmitted per interval. | 63 // the number of bytes that can be transmitted per interval. |
64 // Increasing this factor will result in lower delays in cases of bitrate | 64 // Increasing this factor will result in lower delays in cases of bitrate |
65 // overshoots from the encoder. | 65 // overshoots from the encoder. |
66 static const float kDefaultPaceMultiplier; | 66 static const float kDefaultPaceMultiplier; |
67 | 67 |
68 static const size_t kMinProbePacketSize = 200; | 68 static const size_t kMinProbePacketSize = 200; |
69 | 69 |
70 PacedSender(Clock* clock, | 70 PacedSender(Clock* clock, |
71 Callback* callback, | 71 PacketSender* packet_sender, |
72 int bitrate_kbps, | 72 int target_bitrate_bps); |
73 int max_bitrate_kbps, | |
74 int min_bitrate_kbps); | |
75 | 73 |
76 virtual ~PacedSender(); | 74 virtual ~PacedSender(); |
77 | 75 |
78 // Temporarily pause all sending. | 76 // Temporarily pause all sending. |
79 void Pause(); | 77 void Pause(); |
80 | 78 |
81 // Resume sending packets. | 79 // Resume sending packets. |
82 void Resume(); | 80 void Resume(); |
83 | 81 |
84 // Enable bitrate probing. Enabled by default, mostly here to simplify | 82 // Enable bitrate probing. Enabled by default, mostly here to simplify |
85 // testing. Must be called before any packets are being sent to have an | 83 // testing. Must be called before any packets are being sent to have an |
86 // effect. | 84 // effect. |
87 void SetProbingEnabled(bool enabled); | 85 void SetProbingEnabled(bool enabled); |
88 | 86 |
89 // Set target bitrates for the pacer. | 87 // Sets the estimated capacity of the network. |
90 // We will pace out bursts of packets at a bitrate of |max_bitrate_kbps|. | 88 // |bitrate_bps| is our estimate of what we are allowed to send on average. |
91 // |bitrate_kbps| is our estimate of what we are allowed to send on average. | 89 // We will pace out bursts of packets at a bitrate of |
92 // Padding packets will be utilized to reach |min_bitrate| unless enough media | 90 // |bitrate_bps| * kDefaultPaceMultiplier. |
93 // packets are available. | 91 void SetEstimatedBitrate(uint32_t bitrate_bps); |
94 void UpdateBitrate(int bitrate_kbps, | 92 |
95 int max_bitrate_kbps, | 93 // Sets the bitrate that has been allocated for encoders. |
96 int min_bitrate_kbps); | 94 // |allocated_bitrate| might be higher that the estimated available network |
| 95 // bitrate and if so, the pacer will send with |allocated_bitrate|. |
| 96 // Padding packets will be utilized to reach |padding_bitrate| unless enough |
| 97 // media packets are available. |
| 98 void SetAllocatedSendBitrate(int allocated_bitrate_bps, |
| 99 int padding_bitrate_bps); |
97 | 100 |
98 // Returns true if we send the packet now, else it will add the packet | 101 // Returns true if we send the packet now, else it will add the packet |
99 // information to the queue and call TimeToSendPacket when it's time to send. | 102 // information to the queue and call TimeToSendPacket when it's time to send. |
100 void InsertPacket(RtpPacketSender::Priority priority, | 103 void InsertPacket(RtpPacketSender::Priority priority, |
101 uint32_t ssrc, | 104 uint32_t ssrc, |
102 uint16_t sequence_number, | 105 uint16_t sequence_number, |
103 int64_t capture_time_ms, | 106 int64_t capture_time_ms, |
104 size_t bytes, | 107 size_t bytes, |
105 bool retransmission) override; | 108 bool retransmission) override; |
106 | 109 |
(...skipping 20 matching lines...) Expand all Loading... |
127 private: | 130 private: |
128 // Updates the number of bytes that can be sent for the next time interval. | 131 // Updates the number of bytes that can be sent for the next time interval. |
129 void UpdateBytesPerInterval(int64_t delta_time_in_ms) | 132 void UpdateBytesPerInterval(int64_t delta_time_in_ms) |
130 EXCLUSIVE_LOCKS_REQUIRED(critsect_); | 133 EXCLUSIVE_LOCKS_REQUIRED(critsect_); |
131 | 134 |
132 bool SendPacket(const paced_sender::Packet& packet) | 135 bool SendPacket(const paced_sender::Packet& packet) |
133 EXCLUSIVE_LOCKS_REQUIRED(critsect_); | 136 EXCLUSIVE_LOCKS_REQUIRED(critsect_); |
134 void SendPadding(size_t padding_needed) EXCLUSIVE_LOCKS_REQUIRED(critsect_); | 137 void SendPadding(size_t padding_needed) EXCLUSIVE_LOCKS_REQUIRED(critsect_); |
135 | 138 |
136 Clock* const clock_; | 139 Clock* const clock_; |
137 Callback* const callback_; | 140 PacketSender* const packet_sender_; |
138 | 141 |
139 std::unique_ptr<CriticalSectionWrapper> critsect_; | 142 std::unique_ptr<CriticalSectionWrapper> critsect_; |
140 bool paused_ GUARDED_BY(critsect_); | 143 bool paused_ GUARDED_BY(critsect_); |
141 bool probing_enabled_; | 144 bool probing_enabled_; |
142 // This is the media budget, keeping track of how many bits of media | 145 // This is the media budget, keeping track of how many bits of media |
143 // we can pace out during the current interval. | 146 // we can pace out during the current interval. |
144 std::unique_ptr<paced_sender::IntervalBudget> media_budget_ | 147 std::unique_ptr<paced_sender::IntervalBudget> media_budget_ |
145 GUARDED_BY(critsect_); | 148 GUARDED_BY(critsect_); |
146 // This is the padding budget, keeping track of how many bits of padding we're | 149 // This is the padding budget, keeping track of how many bits of padding we're |
147 // allowed to send out during the current interval. This budget will be | 150 // allowed to send out during the current interval. This budget will be |
148 // utilized when there's no media to send. | 151 // utilized when there's no media to send. |
149 std::unique_ptr<paced_sender::IntervalBudget> padding_budget_ | 152 std::unique_ptr<paced_sender::IntervalBudget> padding_budget_ |
150 GUARDED_BY(critsect_); | 153 GUARDED_BY(critsect_); |
151 | 154 |
152 std::unique_ptr<BitrateProber> prober_ GUARDED_BY(critsect_); | 155 std::unique_ptr<BitrateProber> prober_ GUARDED_BY(critsect_); |
153 // Actual configured bitrates (media_budget_ may temporarily be higher in | 156 // Actual configured bitrates (media_budget_ may temporarily be higher in |
154 // order to meet pace time constraint). | 157 // order to meet pace time constraint). |
155 int bitrate_bps_ GUARDED_BY(critsect_); | 158 uint32_t estimated_bitrate_bps_ GUARDED_BY(critsect_); |
156 int max_bitrate_kbps_ GUARDED_BY(critsect_); | 159 uint32_t min_send_bitrate_kbps_ GUARDED_BY(critsect_); |
| 160 uint32_t pacing_bitrate_kbps_ GUARDED_BY(critsect_); |
157 | 161 |
158 int64_t time_last_update_us_ GUARDED_BY(critsect_); | 162 int64_t time_last_update_us_ GUARDED_BY(critsect_); |
159 | 163 |
160 std::unique_ptr<paced_sender::PacketQueue> packets_ GUARDED_BY(critsect_); | 164 std::unique_ptr<paced_sender::PacketQueue> packets_ GUARDED_BY(critsect_); |
161 uint64_t packet_counter_; | 165 uint64_t packet_counter_; |
162 }; | 166 }; |
163 } // namespace webrtc | 167 } // namespace webrtc |
164 #endif // WEBRTC_MODULES_PACING_PACED_SENDER_H_ | 168 #endif // WEBRTC_MODULES_PACING_PACED_SENDER_H_ |
OLD | NEW |