pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 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 | |
stefan@webrtc.org | 82462aa | 2014-10-23 11:57:05 +0000 | [diff] [blame^] | 11 | #ifndef WEBRTC_MODULES_PACING_INCLUDE_PACED_SENDER_H_ |
| 12 | #define WEBRTC_MODULES_PACING_INCLUDE_PACED_SENDER_H_ |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 13 | |
| 14 | #include <list> |
pwestin@webrtc.org | 52aa019 | 2013-04-25 17:35:56 +0000 | [diff] [blame] | 15 | #include <set> |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 16 | |
pbos@webrtc.org | 38344ed | 2014-09-24 06:05:00 +0000 | [diff] [blame] | 17 | #include "webrtc/base/thread_annotations.h" |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 18 | #include "webrtc/modules/interface/module.h" |
| 19 | #include "webrtc/system_wrappers/interface/scoped_ptr.h" |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 20 | #include "webrtc/typedefs.h" |
| 21 | |
| 22 | namespace webrtc { |
stefan@webrtc.org | 82462aa | 2014-10-23 11:57:05 +0000 | [diff] [blame^] | 23 | class BitrateProber; |
stefan@webrtc.org | 88e0dda | 2014-07-04 09:20:42 +0000 | [diff] [blame] | 24 | class Clock; |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 25 | class CriticalSectionWrapper; |
stefan@webrtc.org | 88e0dda | 2014-07-04 09:20:42 +0000 | [diff] [blame] | 26 | |
stefan@webrtc.org | c3cc375 | 2013-06-04 09:36:56 +0000 | [diff] [blame] | 27 | namespace paced_sender { |
| 28 | class IntervalBudget; |
| 29 | struct Packet; |
| 30 | class PacketList; |
| 31 | } // namespace paced_sender |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 32 | |
| 33 | class PacedSender : public Module { |
| 34 | public: |
| 35 | enum Priority { |
| 36 | kHighPriority = 0, // Pass through; will be sent immediately. |
| 37 | kNormalPriority = 2, // Put in back of the line. |
| 38 | kLowPriority = 3, // Put in back of the low priority line. |
| 39 | }; |
pwestin@webrtc.org | db41856 | 2013-03-22 23:39:29 +0000 | [diff] [blame] | 40 | // Low priority packets are mixed with the normal priority packets |
| 41 | // while we are paused. |
| 42 | |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 43 | class Callback { |
| 44 | public: |
| 45 | // Note: packets sent as a result of a callback should not pass by this |
| 46 | // module again. |
| 47 | // Called when it's time to send a queued packet. |
hclam@chromium.org | 2e402ce | 2013-06-20 20:18:31 +0000 | [diff] [blame] | 48 | // Returns false if packet cannot be sent. |
stefan@webrtc.org | 9b82f5a | 2013-11-13 15:29:21 +0000 | [diff] [blame] | 49 | virtual bool TimeToSendPacket(uint32_t ssrc, |
| 50 | uint16_t sequence_number, |
| 51 | int64_t capture_time_ms, |
| 52 | bool retransmission) = 0; |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 53 | // Called when it's a good time to send a padding data. |
stefan@webrtc.org | 88e0dda | 2014-07-04 09:20:42 +0000 | [diff] [blame] | 54 | // Returns the number of bytes sent. |
stefan@webrtc.org | c3cc375 | 2013-06-04 09:36:56 +0000 | [diff] [blame] | 55 | virtual int TimeToSendPadding(int bytes) = 0; |
jiayl@webrtc.org | 9fd8d87 | 2014-02-27 22:32:40 +0000 | [diff] [blame] | 56 | |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 57 | protected: |
| 58 | virtual ~Callback() {} |
| 59 | }; |
stefan@webrtc.org | 19a40ff | 2013-11-27 14:16:20 +0000 | [diff] [blame] | 60 | |
| 61 | static const int kDefaultMaxQueueLengthMs = 2000; |
stefan@webrtc.org | 88e0dda | 2014-07-04 09:20:42 +0000 | [diff] [blame] | 62 | // Pace in kbits/s until we receive first estimate. |
| 63 | static const int kDefaultInitialPaceKbps = 2000; |
| 64 | // Pacing-rate relative to our target send rate. |
| 65 | // Multiplicative factor that is applied to the target bitrate to calculate |
| 66 | // the number of bytes that can be transmitted per interval. |
| 67 | // Increasing this factor will result in lower delays in cases of bitrate |
| 68 | // overshoots from the encoder. |
| 69 | static const float kDefaultPaceMultiplier; |
stefan@webrtc.org | 19a40ff | 2013-11-27 14:16:20 +0000 | [diff] [blame] | 70 | |
stefan@webrtc.org | 82462aa | 2014-10-23 11:57:05 +0000 | [diff] [blame^] | 71 | PacedSender(Clock* clock, |
| 72 | Callback* callback, |
| 73 | int bitrate_kbps, |
| 74 | int max_bitrate_kbps, |
stefan@webrtc.org | 88e0dda | 2014-07-04 09:20:42 +0000 | [diff] [blame] | 75 | int min_bitrate_kbps); |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 76 | |
| 77 | virtual ~PacedSender(); |
| 78 | |
| 79 | // Enable/disable pacing. |
| 80 | void SetStatus(bool enable); |
| 81 | |
stefan@webrtc.org | c3cc375 | 2013-06-04 09:36:56 +0000 | [diff] [blame] | 82 | bool Enabled() const; |
| 83 | |
pwestin@webrtc.org | db41856 | 2013-03-22 23:39:29 +0000 | [diff] [blame] | 84 | // Temporarily pause all sending. |
| 85 | void Pause(); |
| 86 | |
| 87 | // Resume sending packets. |
| 88 | void Resume(); |
| 89 | |
stefan@webrtc.org | 82462aa | 2014-10-23 11:57:05 +0000 | [diff] [blame^] | 90 | // Set target bitrates for the pacer. |
| 91 | // We will pace out bursts of packets at a bitrate of |max_bitrate_kbps|. |
| 92 | // |bitrate_kbps| is our estimate of what we are allowed to send on average. |
| 93 | // Padding packets will be utilized to reach |min_bitrate| unless enough media |
| 94 | // packets are available. |
| 95 | void UpdateBitrate(int bitrate_kbps, |
| 96 | int max_bitrate_kbps, |
| 97 | int min_bitrate_kbps); |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 98 | |
| 99 | // Returns true if we send the packet now, else it will add the packet |
| 100 | // information to the queue and call TimeToSendPacket when it's time to send. |
pwestin@webrtc.org | b0061f9 | 2013-04-27 00:41:08 +0000 | [diff] [blame] | 101 | virtual bool SendPacket(Priority priority, |
| 102 | uint32_t ssrc, |
| 103 | uint16_t sequence_number, |
| 104 | int64_t capture_time_ms, |
stefan@webrtc.org | 9b82f5a | 2013-11-13 15:29:21 +0000 | [diff] [blame] | 105 | int bytes, |
| 106 | bool retransmission); |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 107 | |
stefan@webrtc.org | 19a40ff | 2013-11-27 14:16:20 +0000 | [diff] [blame] | 108 | // Sets the max length of the pacer queue in milliseconds. |
| 109 | // A negative queue size is interpreted as infinite. |
| 110 | virtual void set_max_queue_length_ms(int max_queue_length_ms); |
| 111 | |
stefan@webrtc.org | dd393e7 | 2013-12-13 22:03:27 +0000 | [diff] [blame] | 112 | // Returns the time since the oldest queued packet was enqueued. |
pwestin@webrtc.org | b0061f9 | 2013-04-27 00:41:08 +0000 | [diff] [blame] | 113 | virtual int QueueInMs() const; |
stefan@webrtc.org | bfacda6 | 2013-03-27 16:36:01 +0000 | [diff] [blame] | 114 | |
stefan@webrtc.org | 82462aa | 2014-10-23 11:57:05 +0000 | [diff] [blame^] | 115 | virtual size_t QueueSizePackets() const; |
| 116 | |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 117 | // Returns the number of milliseconds until the module want a worker thread |
| 118 | // to call Process. |
pbos@webrtc.org | 0193158 | 2013-07-31 15:18:19 +0000 | [diff] [blame] | 119 | virtual int32_t TimeUntilNextProcess() OVERRIDE; |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 120 | |
| 121 | // Process any pending packets in the queue(s). |
pbos@webrtc.org | 0193158 | 2013-07-31 15:18:19 +0000 | [diff] [blame] | 122 | virtual int32_t Process() OVERRIDE; |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 123 | |
stefan@webrtc.org | 82462aa | 2014-10-23 11:57:05 +0000 | [diff] [blame^] | 124 | protected: |
| 125 | virtual bool ProbingExperimentIsEnabled() const; |
| 126 | |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 127 | private: |
hclam@chromium.org | 2e402ce | 2013-06-20 20:18:31 +0000 | [diff] [blame] | 128 | // Return true if next packet in line should be transmitted. |
| 129 | // Return packet list that contains the next packet. |
stefan@webrtc.org | 82462aa | 2014-10-23 11:57:05 +0000 | [diff] [blame^] | 130 | bool ShouldSendNextPacket(paced_sender::PacketList** packet_list, bool probe) |
pbos@webrtc.org | 03c817e | 2014-07-07 10:20:35 +0000 | [diff] [blame] | 131 | EXCLUSIVE_LOCKS_REQUIRED(critsect_); |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 132 | |
pwestin@webrtc.org | db41856 | 2013-03-22 23:39:29 +0000 | [diff] [blame] | 133 | // Local helper function to GetNextPacket. |
pbos@webrtc.org | 03c817e | 2014-07-07 10:20:35 +0000 | [diff] [blame] | 134 | paced_sender::Packet GetNextPacketFromList(paced_sender::PacketList* packets) |
| 135 | EXCLUSIVE_LOCKS_REQUIRED(critsect_); |
pwestin@webrtc.org | db41856 | 2013-03-22 23:39:29 +0000 | [diff] [blame] | 136 | |
pbos@webrtc.org | 03c817e | 2014-07-07 10:20:35 +0000 | [diff] [blame] | 137 | bool SendPacketFromList(paced_sender::PacketList* packet_list) |
| 138 | EXCLUSIVE_LOCKS_REQUIRED(critsect_); |
stefan@webrtc.org | 19a40ff | 2013-11-27 14:16:20 +0000 | [diff] [blame] | 139 | |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 140 | // Updates the number of bytes that can be sent for the next time interval. |
pbos@webrtc.org | 03c817e | 2014-07-07 10:20:35 +0000 | [diff] [blame] | 141 | void UpdateBytesPerInterval(uint32_t delta_time_in_ms) |
| 142 | EXCLUSIVE_LOCKS_REQUIRED(critsect_); |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 143 | |
| 144 | // Updates the buffers with the number of bytes that we sent. |
pbos@webrtc.org | 03c817e | 2014-07-07 10:20:35 +0000 | [diff] [blame] | 145 | void UpdateMediaBytesSent(int num_bytes) EXCLUSIVE_LOCKS_REQUIRED(critsect_); |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 146 | |
pbos@webrtc.org | 03c817e | 2014-07-07 10:20:35 +0000 | [diff] [blame] | 147 | Clock* const clock_; |
| 148 | Callback* const callback_; |
| 149 | |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 150 | scoped_ptr<CriticalSectionWrapper> critsect_; |
pbos@webrtc.org | 03c817e | 2014-07-07 10:20:35 +0000 | [diff] [blame] | 151 | bool enabled_ GUARDED_BY(critsect_); |
| 152 | bool paused_ GUARDED_BY(critsect_); |
| 153 | int max_queue_length_ms_ GUARDED_BY(critsect_); |
stefan@webrtc.org | c3cc375 | 2013-06-04 09:36:56 +0000 | [diff] [blame] | 154 | // This is the media budget, keeping track of how many bits of media |
| 155 | // we can pace out during the current interval. |
pbos@webrtc.org | 03c817e | 2014-07-07 10:20:35 +0000 | [diff] [blame] | 156 | scoped_ptr<paced_sender::IntervalBudget> media_budget_ GUARDED_BY(critsect_); |
stefan@webrtc.org | c3cc375 | 2013-06-04 09:36:56 +0000 | [diff] [blame] | 157 | // This is the padding budget, keeping track of how many bits of padding we're |
pbos@webrtc.org | 709e297 | 2014-03-19 10:59:52 +0000 | [diff] [blame] | 158 | // allowed to send out during the current interval. This budget will be |
| 159 | // utilized when there's no media to send. |
pbos@webrtc.org | 03c817e | 2014-07-07 10:20:35 +0000 | [diff] [blame] | 160 | scoped_ptr<paced_sender::IntervalBudget> padding_budget_ |
| 161 | GUARDED_BY(critsect_); |
stefan@webrtc.org | c3cc375 | 2013-06-04 09:36:56 +0000 | [diff] [blame] | 162 | |
stefan@webrtc.org | 82462aa | 2014-10-23 11:57:05 +0000 | [diff] [blame^] | 163 | scoped_ptr<BitrateProber> prober_ GUARDED_BY(critsect_); |
| 164 | int bitrate_bps_ GUARDED_BY(critsect_); |
| 165 | |
stefan@webrtc.org | 89fd1e8 | 2014-07-15 16:40:38 +0000 | [diff] [blame] | 166 | int64_t time_last_update_us_ GUARDED_BY(critsect_); |
stefan@webrtc.org | 82462aa | 2014-10-23 11:57:05 +0000 | [diff] [blame^] | 167 | // Only accessed via process thread. |
| 168 | int64_t time_last_media_send_us_; |
pbos@webrtc.org | 03c817e | 2014-07-07 10:20:35 +0000 | [diff] [blame] | 169 | int64_t capture_time_ms_last_queued_ GUARDED_BY(critsect_); |
| 170 | int64_t capture_time_ms_last_sent_ GUARDED_BY(critsect_); |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 171 | |
pbos@webrtc.org | 03c817e | 2014-07-07 10:20:35 +0000 | [diff] [blame] | 172 | scoped_ptr<paced_sender::PacketList> high_priority_packets_ |
| 173 | GUARDED_BY(critsect_); |
| 174 | scoped_ptr<paced_sender::PacketList> normal_priority_packets_ |
| 175 | GUARDED_BY(critsect_); |
| 176 | scoped_ptr<paced_sender::PacketList> low_priority_packets_ |
| 177 | GUARDED_BY(critsect_); |
pwestin@webrtc.org | b518017 | 2012-11-09 20:56:23 +0000 | [diff] [blame] | 178 | }; |
| 179 | } // namespace webrtc |
stefan@webrtc.org | 82462aa | 2014-10-23 11:57:05 +0000 | [diff] [blame^] | 180 | #endif // WEBRTC_MODULES_PACING_INCLUDE_PACED_SENDER_H_ |