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 PacketSender { | 36 class Callback { |
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 ~PacketSender() {} | 51 virtual ~Callback() {} |
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 PacketSender* packet_sender, | 71 Callback* callback, |
72 int target_bitrate_bps); | 72 int bitrate_kbps, |
| 73 int max_bitrate_kbps, |
| 74 int min_bitrate_kbps); |
73 | 75 |
74 virtual ~PacedSender(); | 76 virtual ~PacedSender(); |
75 | 77 |
76 // Temporarily pause all sending. | 78 // Temporarily pause all sending. |
77 void Pause(); | 79 void Pause(); |
78 | 80 |
79 // Resume sending packets. | 81 // Resume sending packets. |
80 void Resume(); | 82 void Resume(); |
81 | 83 |
82 // Enable bitrate probing. Enabled by default, mostly here to simplify | 84 // Enable bitrate probing. Enabled by default, mostly here to simplify |
83 // testing. Must be called before any packets are being sent to have an | 85 // testing. Must be called before any packets are being sent to have an |
84 // effect. | 86 // effect. |
85 void SetProbingEnabled(bool enabled); | 87 void SetProbingEnabled(bool enabled); |
86 | 88 |
87 // Sets the estimated capacity of the network. | 89 // Set target bitrates for the pacer. |
88 // |bitrate_bps| is our estimate of what we are allowed to send on average. | 90 // We will pace out bursts of packets at a bitrate of |max_bitrate_kbps|. |
89 // We will pace out bursts of packets at a bitrate of | 91 // |bitrate_kbps| is our estimate of what we are allowed to send on average. |
90 // |bitrate_bps| * kDefaultPaceMultiplier. | 92 // Padding packets will be utilized to reach |min_bitrate| unless enough media |
91 void SetEstimatedBitrate(uint32_t bitrate_bps); | 93 // packets are available. |
92 | 94 void UpdateBitrate(int bitrate_kbps, |
93 // Sets the bitrate that has been allocated for encoders. | 95 int max_bitrate_kbps, |
94 // |allocated_bitrate| might be higher that the estimated available network | 96 int min_bitrate_kbps); |
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); | |
100 | 97 |
101 // Returns true if we send the packet now, else it will add the packet | 98 // Returns true if we send the packet now, else it will add the packet |
102 // information to the queue and call TimeToSendPacket when it's time to send. | 99 // information to the queue and call TimeToSendPacket when it's time to send. |
103 void InsertPacket(RtpPacketSender::Priority priority, | 100 void InsertPacket(RtpPacketSender::Priority priority, |
104 uint32_t ssrc, | 101 uint32_t ssrc, |
105 uint16_t sequence_number, | 102 uint16_t sequence_number, |
106 int64_t capture_time_ms, | 103 int64_t capture_time_ms, |
107 size_t bytes, | 104 size_t bytes, |
108 bool retransmission) override; | 105 bool retransmission) override; |
109 | 106 |
(...skipping 20 matching lines...) Expand all Loading... |
130 private: | 127 private: |
131 // Updates the number of bytes that can be sent for the next time interval. | 128 // Updates the number of bytes that can be sent for the next time interval. |
132 void UpdateBytesPerInterval(int64_t delta_time_in_ms) | 129 void UpdateBytesPerInterval(int64_t delta_time_in_ms) |
133 EXCLUSIVE_LOCKS_REQUIRED(critsect_); | 130 EXCLUSIVE_LOCKS_REQUIRED(critsect_); |
134 | 131 |
135 bool SendPacket(const paced_sender::Packet& packet) | 132 bool SendPacket(const paced_sender::Packet& packet) |
136 EXCLUSIVE_LOCKS_REQUIRED(critsect_); | 133 EXCLUSIVE_LOCKS_REQUIRED(critsect_); |
137 void SendPadding(size_t padding_needed) EXCLUSIVE_LOCKS_REQUIRED(critsect_); | 134 void SendPadding(size_t padding_needed) EXCLUSIVE_LOCKS_REQUIRED(critsect_); |
138 | 135 |
139 Clock* const clock_; | 136 Clock* const clock_; |
140 PacketSender* const packet_sender_; | 137 Callback* const callback_; |
141 | 138 |
142 std::unique_ptr<CriticalSectionWrapper> critsect_; | 139 std::unique_ptr<CriticalSectionWrapper> critsect_; |
143 bool paused_ GUARDED_BY(critsect_); | 140 bool paused_ GUARDED_BY(critsect_); |
144 bool probing_enabled_; | 141 bool probing_enabled_; |
145 // This is the media budget, keeping track of how many bits of media | 142 // This is the media budget, keeping track of how many bits of media |
146 // we can pace out during the current interval. | 143 // we can pace out during the current interval. |
147 std::unique_ptr<paced_sender::IntervalBudget> media_budget_ | 144 std::unique_ptr<paced_sender::IntervalBudget> media_budget_ |
148 GUARDED_BY(critsect_); | 145 GUARDED_BY(critsect_); |
149 // This is the padding budget, keeping track of how many bits of padding we're | 146 // This is the padding budget, keeping track of how many bits of padding we're |
150 // allowed to send out during the current interval. This budget will be | 147 // allowed to send out during the current interval. This budget will be |
151 // utilized when there's no media to send. | 148 // utilized when there's no media to send. |
152 std::unique_ptr<paced_sender::IntervalBudget> padding_budget_ | 149 std::unique_ptr<paced_sender::IntervalBudget> padding_budget_ |
153 GUARDED_BY(critsect_); | 150 GUARDED_BY(critsect_); |
154 | 151 |
155 std::unique_ptr<BitrateProber> prober_ GUARDED_BY(critsect_); | 152 std::unique_ptr<BitrateProber> prober_ GUARDED_BY(critsect_); |
156 // Actual configured bitrates (media_budget_ may temporarily be higher in | 153 // Actual configured bitrates (media_budget_ may temporarily be higher in |
157 // order to meet pace time constraint). | 154 // order to meet pace time constraint). |
158 uint32_t estimated_bitrate_bps_ GUARDED_BY(critsect_); | 155 int bitrate_bps_ GUARDED_BY(critsect_); |
159 uint32_t min_send_bitrate_kbps_ GUARDED_BY(critsect_); | 156 int max_bitrate_kbps_ GUARDED_BY(critsect_); |
160 uint32_t pacing_bitrate_kbps_ GUARDED_BY(critsect_); | |
161 | 157 |
162 int64_t time_last_update_us_ GUARDED_BY(critsect_); | 158 int64_t time_last_update_us_ GUARDED_BY(critsect_); |
163 | 159 |
164 std::unique_ptr<paced_sender::PacketQueue> packets_ GUARDED_BY(critsect_); | 160 std::unique_ptr<paced_sender::PacketQueue> packets_ GUARDED_BY(critsect_); |
165 uint64_t packet_counter_; | 161 uint64_t packet_counter_; |
166 }; | 162 }; |
167 } // namespace webrtc | 163 } // namespace webrtc |
168 #endif // WEBRTC_MODULES_PACING_PACED_SENDER_H_ | 164 #endif // WEBRTC_MODULES_PACING_PACED_SENDER_H_ |
OLD | NEW |