blob: cb50490c022f5426c01d7586bb30877ec6fcd485 [file] [log] [blame]
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001/*
2 * libjingle
3 * Copyright 2004 Google Inc.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright notice,
11 * this list of conditions and the following disclaimer in the documentation
12 * and/or other materials provided with the distribution.
13 * 3. The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
19 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28#ifndef TALK_MEDIA_BASE_MEDIACHANNEL_H_
29#define TALK_MEDIA_BASE_MEDIACHANNEL_H_
30
31#include <string>
32#include <vector>
33
buildbot@webrtc.orga09a9992014-08-13 17:26:08 +000034#include "talk/media/base/codec.h"
35#include "talk/media/base/constants.h"
36#include "talk/media/base/streamparams.h"
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +000037#include "webrtc/base/basictypes.h"
38#include "webrtc/base/buffer.h"
39#include "webrtc/base/dscp.h"
40#include "webrtc/base/logging.h"
41#include "webrtc/base/sigslot.h"
42#include "webrtc/base/socket.h"
43#include "webrtc/base/window.h"
henrike@webrtc.org28e20752013-07-10 00:45:36 +000044// TODO(juberti): re-evaluate this include
45#include "talk/session/media/audiomonitor.h"
46
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +000047namespace rtc {
henrike@webrtc.org28e20752013-07-10 00:45:36 +000048class Buffer;
49class RateLimiter;
50class Timing;
51}
52
53namespace cricket {
54
55class AudioRenderer;
56struct RtpHeader;
57class ScreencastId;
58struct VideoFormat;
59class VideoCapturer;
60class VideoRenderer;
61
62const int kMinRtpHeaderExtensionId = 1;
63const int kMaxRtpHeaderExtensionId = 255;
64const int kScreencastDefaultFps = 5;
wu@webrtc.orgcfe5e9c2014-03-27 17:03:58 +000065const int kHighStartBitrate = 1500;
henrike@webrtc.org28e20752013-07-10 00:45:36 +000066
67// Used in AudioOptions and VideoOptions to signify "unset" values.
68template <class T>
69class Settable {
70 public:
71 Settable() : set_(false), val_() {}
72 explicit Settable(T val) : set_(true), val_(val) {}
73
74 bool IsSet() const {
75 return set_;
76 }
77
78 bool Get(T* out) const {
79 *out = val_;
80 return set_;
81 }
82
83 T GetWithDefaultIfUnset(const T& default_value) const {
84 return set_ ? val_ : default_value;
85 }
86
pthatcher@webrtc.org40b276e2014-12-12 02:44:30 +000087 void Set(T val) {
henrike@webrtc.org28e20752013-07-10 00:45:36 +000088 set_ = true;
89 val_ = val;
90 }
91
92 void Clear() {
93 Set(T());
94 set_ = false;
95 }
96
97 void SetFrom(const Settable<T>& o) {
98 // Set this value based on the value of o, iff o is set. If this value is
99 // set and o is unset, the current value will be unchanged.
100 T val;
101 if (o.Get(&val)) {
102 Set(val);
103 }
104 }
105
106 std::string ToString() const {
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000107 return set_ ? rtc::ToString(val_) : "";
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000108 }
109
110 bool operator==(const Settable<T>& o) const {
111 // Equal if both are unset with any value or both set with the same value.
112 return (set_ == o.set_) && (!set_ || (val_ == o.val_));
113 }
114
115 bool operator!=(const Settable<T>& o) const {
116 return !operator==(o);
117 }
118
119 protected:
120 void InitializeValue(const T &val) {
121 val_ = val;
122 }
123
124 private:
125 bool set_;
126 T val_;
127};
128
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000129template <class T>
130static std::string ToStringIfSet(const char* key, const Settable<T>& val) {
131 std::string str;
132 if (val.IsSet()) {
133 str = key;
134 str += ": ";
135 str += val.ToString();
136 str += ", ";
137 }
138 return str;
139}
140
141// Options that can be applied to a VoiceMediaChannel or a VoiceMediaEngine.
142// Used to be flags, but that makes it hard to selectively apply options.
143// We are moving all of the setting of options to structs like this,
144// but some things currently still use flags.
145struct AudioOptions {
146 void SetAll(const AudioOptions& change) {
147 echo_cancellation.SetFrom(change.echo_cancellation);
148 auto_gain_control.SetFrom(change.auto_gain_control);
wu@webrtc.org97077a32013-10-25 21:18:33 +0000149 rx_auto_gain_control.SetFrom(change.rx_auto_gain_control);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000150 noise_suppression.SetFrom(change.noise_suppression);
151 highpass_filter.SetFrom(change.highpass_filter);
152 stereo_swapping.SetFrom(change.stereo_swapping);
153 typing_detection.SetFrom(change.typing_detection);
wu@webrtc.org97077a32013-10-25 21:18:33 +0000154 aecm_generate_comfort_noise.SetFrom(change.aecm_generate_comfort_noise);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000155 conference_mode.SetFrom(change.conference_mode);
156 adjust_agc_delta.SetFrom(change.adjust_agc_delta);
157 experimental_agc.SetFrom(change.experimental_agc);
158 experimental_aec.SetFrom(change.experimental_aec);
sergeyu@chromium.org9cf037b2014-02-07 19:03:26 +0000159 experimental_ns.SetFrom(change.experimental_ns);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000160 aec_dump.SetFrom(change.aec_dump);
wu@webrtc.org97077a32013-10-25 21:18:33 +0000161 tx_agc_target_dbov.SetFrom(change.tx_agc_target_dbov);
162 tx_agc_digital_compression_gain.SetFrom(
163 change.tx_agc_digital_compression_gain);
164 tx_agc_limiter.SetFrom(change.tx_agc_limiter);
165 rx_agc_target_dbov.SetFrom(change.rx_agc_target_dbov);
166 rx_agc_digital_compression_gain.SetFrom(
167 change.rx_agc_digital_compression_gain);
168 rx_agc_limiter.SetFrom(change.rx_agc_limiter);
169 recording_sample_rate.SetFrom(change.recording_sample_rate);
170 playout_sample_rate.SetFrom(change.playout_sample_rate);
wu@webrtc.orgde305012013-10-31 15:40:38 +0000171 dscp.SetFrom(change.dscp);
buildbot@webrtc.orgb4c7b092014-08-25 12:11:58 +0000172 combined_audio_video_bwe.SetFrom(change.combined_audio_video_bwe);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000173 }
174
175 bool operator==(const AudioOptions& o) const {
176 return echo_cancellation == o.echo_cancellation &&
177 auto_gain_control == o.auto_gain_control &&
wu@webrtc.org97077a32013-10-25 21:18:33 +0000178 rx_auto_gain_control == o.rx_auto_gain_control &&
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000179 noise_suppression == o.noise_suppression &&
180 highpass_filter == o.highpass_filter &&
181 stereo_swapping == o.stereo_swapping &&
182 typing_detection == o.typing_detection &&
wu@webrtc.org97077a32013-10-25 21:18:33 +0000183 aecm_generate_comfort_noise == o.aecm_generate_comfort_noise &&
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000184 conference_mode == o.conference_mode &&
185 experimental_agc == o.experimental_agc &&
186 experimental_aec == o.experimental_aec &&
sergeyu@chromium.org9cf037b2014-02-07 19:03:26 +0000187 experimental_ns == o.experimental_ns &&
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000188 adjust_agc_delta == o.adjust_agc_delta &&
wu@webrtc.org97077a32013-10-25 21:18:33 +0000189 aec_dump == o.aec_dump &&
190 tx_agc_target_dbov == o.tx_agc_target_dbov &&
191 tx_agc_digital_compression_gain == o.tx_agc_digital_compression_gain &&
192 tx_agc_limiter == o.tx_agc_limiter &&
193 rx_agc_target_dbov == o.rx_agc_target_dbov &&
194 rx_agc_digital_compression_gain == o.rx_agc_digital_compression_gain &&
195 rx_agc_limiter == o.rx_agc_limiter &&
196 recording_sample_rate == o.recording_sample_rate &&
wu@webrtc.orgde305012013-10-31 15:40:38 +0000197 playout_sample_rate == o.playout_sample_rate &&
buildbot@webrtc.orgb4c7b092014-08-25 12:11:58 +0000198 dscp == o.dscp &&
199 combined_audio_video_bwe == o.combined_audio_video_bwe;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000200 }
201
202 std::string ToString() const {
203 std::ostringstream ost;
204 ost << "AudioOptions {";
205 ost << ToStringIfSet("aec", echo_cancellation);
206 ost << ToStringIfSet("agc", auto_gain_control);
wu@webrtc.org97077a32013-10-25 21:18:33 +0000207 ost << ToStringIfSet("rx_agc", rx_auto_gain_control);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000208 ost << ToStringIfSet("ns", noise_suppression);
209 ost << ToStringIfSet("hf", highpass_filter);
210 ost << ToStringIfSet("swap", stereo_swapping);
211 ost << ToStringIfSet("typing", typing_detection);
wu@webrtc.org97077a32013-10-25 21:18:33 +0000212 ost << ToStringIfSet("comfort_noise", aecm_generate_comfort_noise);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000213 ost << ToStringIfSet("conference", conference_mode);
214 ost << ToStringIfSet("agc_delta", adjust_agc_delta);
215 ost << ToStringIfSet("experimental_agc", experimental_agc);
216 ost << ToStringIfSet("experimental_aec", experimental_aec);
sergeyu@chromium.org9cf037b2014-02-07 19:03:26 +0000217 ost << ToStringIfSet("experimental_ns", experimental_ns);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000218 ost << ToStringIfSet("aec_dump", aec_dump);
wu@webrtc.org97077a32013-10-25 21:18:33 +0000219 ost << ToStringIfSet("tx_agc_target_dbov", tx_agc_target_dbov);
220 ost << ToStringIfSet("tx_agc_digital_compression_gain",
221 tx_agc_digital_compression_gain);
222 ost << ToStringIfSet("tx_agc_limiter", tx_agc_limiter);
223 ost << ToStringIfSet("rx_agc_target_dbov", rx_agc_target_dbov);
224 ost << ToStringIfSet("rx_agc_digital_compression_gain",
225 rx_agc_digital_compression_gain);
226 ost << ToStringIfSet("rx_agc_limiter", rx_agc_limiter);
227 ost << ToStringIfSet("recording_sample_rate", recording_sample_rate);
228 ost << ToStringIfSet("playout_sample_rate", playout_sample_rate);
wu@webrtc.orgde305012013-10-31 15:40:38 +0000229 ost << ToStringIfSet("dscp", dscp);
buildbot@webrtc.orgb4c7b092014-08-25 12:11:58 +0000230 ost << ToStringIfSet("combined_audio_video_bwe", combined_audio_video_bwe);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000231 ost << "}";
232 return ost.str();
233 }
234
235 // Audio processing that attempts to filter away the output signal from
236 // later inbound pickup.
237 Settable<bool> echo_cancellation;
238 // Audio processing to adjust the sensitivity of the local mic dynamically.
239 Settable<bool> auto_gain_control;
wu@webrtc.org97077a32013-10-25 21:18:33 +0000240 // Audio processing to apply gain to the remote audio.
241 Settable<bool> rx_auto_gain_control;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000242 // Audio processing to filter out background noise.
243 Settable<bool> noise_suppression;
244 // Audio processing to remove background noise of lower frequencies.
245 Settable<bool> highpass_filter;
246 // Audio processing to swap the left and right channels.
247 Settable<bool> stereo_swapping;
248 // Audio processing to detect typing.
249 Settable<bool> typing_detection;
wu@webrtc.org97077a32013-10-25 21:18:33 +0000250 Settable<bool> aecm_generate_comfort_noise;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000251 Settable<bool> conference_mode;
252 Settable<int> adjust_agc_delta;
253 Settable<bool> experimental_agc;
254 Settable<bool> experimental_aec;
sergeyu@chromium.org9cf037b2014-02-07 19:03:26 +0000255 Settable<bool> experimental_ns;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000256 Settable<bool> aec_dump;
wu@webrtc.org97077a32013-10-25 21:18:33 +0000257 // Note that tx_agc_* only applies to non-experimental AGC.
258 Settable<uint16> tx_agc_target_dbov;
259 Settable<uint16> tx_agc_digital_compression_gain;
260 Settable<bool> tx_agc_limiter;
261 Settable<uint16> rx_agc_target_dbov;
262 Settable<uint16> rx_agc_digital_compression_gain;
263 Settable<bool> rx_agc_limiter;
264 Settable<uint32> recording_sample_rate;
265 Settable<uint32> playout_sample_rate;
wu@webrtc.orgde305012013-10-31 15:40:38 +0000266 // Set DSCP value for packet sent from audio channel.
267 Settable<bool> dscp;
buildbot@webrtc.orgb4c7b092014-08-25 12:11:58 +0000268 // Enable combined audio+bandwidth BWE.
269 Settable<bool> combined_audio_video_bwe;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000270};
271
272// Options that can be applied to a VideoMediaChannel or a VideoMediaEngine.
273// Used to be flags, but that makes it hard to selectively apply options.
274// We are moving all of the setting of options to structs like this,
275// but some things currently still use flags.
276struct VideoOptions {
henrike@webrtc.orgf45a5502014-03-13 18:51:34 +0000277 enum HighestBitrate {
278 NORMAL,
279 HIGH,
280 VERY_HIGH
281 };
282
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000283 VideoOptions() {
284 process_adaptation_threshhold.Set(kProcessCpuThreshold);
285 system_low_adaptation_threshhold.Set(kLowSystemCpuThreshold);
286 system_high_adaptation_threshhold.Set(kHighSystemCpuThreshold);
henrike@webrtc.org704bf9e2014-02-27 17:52:04 +0000287 unsignalled_recv_stream_limit.Set(kNumDefaultUnsignalledVideoRecvStreams);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000288 }
289
290 void SetAll(const VideoOptions& change) {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000291 adapt_input_to_cpu_usage.SetFrom(change.adapt_input_to_cpu_usage);
henrike@webrtc.org28654cb2013-07-22 21:07:49 +0000292 adapt_cpu_with_smoothing.SetFrom(change.adapt_cpu_with_smoothing);
wu@webrtc.orgcadf9042013-08-30 21:24:16 +0000293 video_adapt_third.SetFrom(change.video_adapt_third);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000294 video_noise_reduction.SetFrom(change.video_noise_reduction);
wu@webrtc.org1e6cb2c2014-03-24 17:01:50 +0000295 video_start_bitrate.SetFrom(change.video_start_bitrate);
henrike@webrtc.orgf45a5502014-03-13 18:51:34 +0000296 video_highest_bitrate.SetFrom(change.video_highest_bitrate);
wu@webrtc.orgcadf9042013-08-30 21:24:16 +0000297 cpu_overuse_detection.SetFrom(change.cpu_overuse_detection);
henrike@webrtc.orge9793ab2014-03-18 14:36:23 +0000298 cpu_underuse_threshold.SetFrom(change.cpu_underuse_threshold);
299 cpu_overuse_threshold.SetFrom(change.cpu_overuse_threshold);
buildbot@webrtc.org27626a62014-06-16 13:39:40 +0000300 cpu_underuse_encode_rsd_threshold.SetFrom(
301 change.cpu_underuse_encode_rsd_threshold);
302 cpu_overuse_encode_rsd_threshold.SetFrom(
303 change.cpu_overuse_encode_rsd_threshold);
henrike@webrtc.orgb0ecc1c2014-03-26 22:44:28 +0000304 cpu_overuse_encode_usage.SetFrom(change.cpu_overuse_encode_usage);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000305 conference_mode.SetFrom(change.conference_mode);
306 process_adaptation_threshhold.SetFrom(change.process_adaptation_threshhold);
307 system_low_adaptation_threshhold.SetFrom(
308 change.system_low_adaptation_threshhold);
309 system_high_adaptation_threshhold.SetFrom(
310 change.system_high_adaptation_threshhold);
311 buffered_mode_latency.SetFrom(change.buffered_mode_latency);
wu@webrtc.orgde305012013-10-31 15:40:38 +0000312 dscp.SetFrom(change.dscp);
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000313 suspend_below_min_bitrate.SetFrom(change.suspend_below_min_bitrate);
henrike@webrtc.org704bf9e2014-02-27 17:52:04 +0000314 unsignalled_recv_stream_limit.SetFrom(change.unsignalled_recv_stream_limit);
henrike@webrtc.org10bd88e2014-03-11 21:07:25 +0000315 use_simulcast_adapter.SetFrom(change.use_simulcast_adapter);
henrike@webrtc.orgdce3feb2014-03-26 01:17:30 +0000316 screencast_min_bitrate.SetFrom(change.screencast_min_bitrate);
buildbot@webrtc.org44a317a2014-06-17 07:49:15 +0000317 use_payload_padding.SetFrom(change.use_payload_padding);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000318 }
319
320 bool operator==(const VideoOptions& o) const {
pbos@webrtc.org43336b62014-10-14 19:12:06 +0000321 return adapt_input_to_cpu_usage == o.adapt_input_to_cpu_usage &&
322 adapt_cpu_with_smoothing == o.adapt_cpu_with_smoothing &&
323 video_adapt_third == o.video_adapt_third &&
324 video_noise_reduction == o.video_noise_reduction &&
325 video_start_bitrate == o.video_start_bitrate &&
pbos@webrtc.org43336b62014-10-14 19:12:06 +0000326 video_highest_bitrate == o.video_highest_bitrate &&
327 cpu_overuse_detection == o.cpu_overuse_detection &&
328 cpu_underuse_threshold == o.cpu_underuse_threshold &&
329 cpu_overuse_threshold == o.cpu_overuse_threshold &&
330 cpu_underuse_encode_rsd_threshold ==
331 o.cpu_underuse_encode_rsd_threshold &&
332 cpu_overuse_encode_rsd_threshold ==
333 o.cpu_overuse_encode_rsd_threshold &&
334 cpu_overuse_encode_usage == o.cpu_overuse_encode_usage &&
335 conference_mode == o.conference_mode &&
336 process_adaptation_threshhold == o.process_adaptation_threshhold &&
337 system_low_adaptation_threshhold ==
338 o.system_low_adaptation_threshhold &&
339 system_high_adaptation_threshhold ==
340 o.system_high_adaptation_threshhold &&
341 buffered_mode_latency == o.buffered_mode_latency && dscp == o.dscp &&
342 suspend_below_min_bitrate == o.suspend_below_min_bitrate &&
343 unsignalled_recv_stream_limit == o.unsignalled_recv_stream_limit &&
344 use_simulcast_adapter == o.use_simulcast_adapter &&
345 screencast_min_bitrate == o.screencast_min_bitrate &&
346 use_payload_padding == o.use_payload_padding;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000347 }
348
349 std::string ToString() const {
350 std::ostringstream ost;
351 ost << "VideoOptions {";
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000352 ost << ToStringIfSet("cpu adaption", adapt_input_to_cpu_usage);
henrike@webrtc.org28654cb2013-07-22 21:07:49 +0000353 ost << ToStringIfSet("cpu adaptation smoothing", adapt_cpu_with_smoothing);
wu@webrtc.orgcadf9042013-08-30 21:24:16 +0000354 ost << ToStringIfSet("video adapt third", video_adapt_third);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000355 ost << ToStringIfSet("noise reduction", video_noise_reduction);
wu@webrtc.org1e6cb2c2014-03-24 17:01:50 +0000356 ost << ToStringIfSet("start bitrate", video_start_bitrate);
henrike@webrtc.orgf45a5502014-03-13 18:51:34 +0000357 ost << ToStringIfSet("highest video bitrate", video_highest_bitrate);
wu@webrtc.orgcadf9042013-08-30 21:24:16 +0000358 ost << ToStringIfSet("cpu overuse detection", cpu_overuse_detection);
henrike@webrtc.orge9793ab2014-03-18 14:36:23 +0000359 ost << ToStringIfSet("cpu underuse threshold", cpu_underuse_threshold);
360 ost << ToStringIfSet("cpu overuse threshold", cpu_overuse_threshold);
buildbot@webrtc.org27626a62014-06-16 13:39:40 +0000361 ost << ToStringIfSet("cpu underuse encode rsd threshold",
362 cpu_underuse_encode_rsd_threshold);
363 ost << ToStringIfSet("cpu overuse encode rsd threshold",
364 cpu_overuse_encode_rsd_threshold);
henrike@webrtc.orgb0ecc1c2014-03-26 22:44:28 +0000365 ost << ToStringIfSet("cpu overuse encode usage",
366 cpu_overuse_encode_usage);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000367 ost << ToStringIfSet("conference mode", conference_mode);
368 ost << ToStringIfSet("process", process_adaptation_threshhold);
369 ost << ToStringIfSet("low", system_low_adaptation_threshhold);
370 ost << ToStringIfSet("high", system_high_adaptation_threshhold);
371 ost << ToStringIfSet("buffered mode latency", buffered_mode_latency);
wu@webrtc.orgde305012013-10-31 15:40:38 +0000372 ost << ToStringIfSet("dscp", dscp);
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000373 ost << ToStringIfSet("suspend below min bitrate",
374 suspend_below_min_bitrate);
henrike@webrtc.org704bf9e2014-02-27 17:52:04 +0000375 ost << ToStringIfSet("num channels for early receive",
376 unsignalled_recv_stream_limit);
henrike@webrtc.org10bd88e2014-03-11 21:07:25 +0000377 ost << ToStringIfSet("use simulcast adapter", use_simulcast_adapter);
henrike@webrtc.orgdce3feb2014-03-26 01:17:30 +0000378 ost << ToStringIfSet("screencast min bitrate", screencast_min_bitrate);
buildbot@webrtc.org44a317a2014-06-17 07:49:15 +0000379 ost << ToStringIfSet("payload padding", use_payload_padding);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000380 ost << "}";
381 return ost.str();
382 }
383
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000384 // Enable CPU adaptation?
385 Settable<bool> adapt_input_to_cpu_usage;
henrike@webrtc.org28654cb2013-07-22 21:07:49 +0000386 // Enable CPU adaptation smoothing?
387 Settable<bool> adapt_cpu_with_smoothing;
wu@webrtc.orgcadf9042013-08-30 21:24:16 +0000388 // Enable video adapt third?
389 Settable<bool> video_adapt_third;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000390 // Enable denoising?
391 Settable<bool> video_noise_reduction;
wu@webrtc.org1e6cb2c2014-03-24 17:01:50 +0000392 // Experimental: Enable WebRtc higher start bitrate?
393 Settable<int> video_start_bitrate;
henrike@webrtc.orgf45a5502014-03-13 18:51:34 +0000394 // Set highest bitrate mode for video.
wu@webrtc.orgcfe5e9c2014-03-27 17:03:58 +0000395 Settable<HighestBitrate> video_highest_bitrate;
wu@webrtc.orgcadf9042013-08-30 21:24:16 +0000396 // Enable WebRTC Cpu Overuse Detection, which is a new version of the CPU
397 // adaptation algorithm. So this option will override the
398 // |adapt_input_to_cpu_usage|.
399 Settable<bool> cpu_overuse_detection;
buildbot@webrtc.org27626a62014-06-16 13:39:40 +0000400 // Low threshold (t1) for cpu overuse adaptation. (Adapt up)
401 // Metric: encode usage (m1). m1 < t1 => underuse.
henrike@webrtc.orge9793ab2014-03-18 14:36:23 +0000402 Settable<int> cpu_underuse_threshold;
buildbot@webrtc.org27626a62014-06-16 13:39:40 +0000403 // High threshold (t1) for cpu overuse adaptation. (Adapt down)
404 // Metric: encode usage (m1). m1 > t1 => overuse.
henrike@webrtc.orge9793ab2014-03-18 14:36:23 +0000405 Settable<int> cpu_overuse_threshold;
buildbot@webrtc.org27626a62014-06-16 13:39:40 +0000406 // Low threshold (t2) for cpu overuse adaptation. (Adapt up)
407 // Metric: relative standard deviation of encode time (m2).
408 // Optional threshold. If set, (m1 < t1 && m2 < t2) => underuse.
409 // Note: t2 will have no effect if t1 is not set.
410 Settable<int> cpu_underuse_encode_rsd_threshold;
411 // High threshold (t2) for cpu overuse adaptation. (Adapt down)
412 // Metric: relative standard deviation of encode time (m2).
413 // Optional threshold. If set, (m1 > t1 || m2 > t2) => overuse.
414 // Note: t2 will have no effect if t1 is not set.
415 Settable<int> cpu_overuse_encode_rsd_threshold;
henrike@webrtc.orgb0ecc1c2014-03-26 22:44:28 +0000416 // Use encode usage for cpu detection.
417 Settable<bool> cpu_overuse_encode_usage;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000418 // Use conference mode?
419 Settable<bool> conference_mode;
420 // Threshhold for process cpu adaptation. (Process limit)
pthatcher@webrtc.org40b276e2014-12-12 02:44:30 +0000421 Settable<float> process_adaptation_threshhold;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000422 // Low threshhold for cpu adaptation. (Adapt up)
pthatcher@webrtc.org40b276e2014-12-12 02:44:30 +0000423 Settable<float> system_low_adaptation_threshhold;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000424 // High threshhold for cpu adaptation. (Adapt down)
pthatcher@webrtc.org40b276e2014-12-12 02:44:30 +0000425 Settable<float> system_high_adaptation_threshhold;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000426 // Specify buffered mode latency in milliseconds.
427 Settable<int> buffered_mode_latency;
wu@webrtc.orgde305012013-10-31 15:40:38 +0000428 // Set DSCP value for packet sent from video channel.
429 Settable<bool> dscp;
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000430 // Enable WebRTC suspension of video. No video frames will be sent when the
431 // bitrate is below the configured minimum bitrate.
432 Settable<bool> suspend_below_min_bitrate;
henrike@webrtc.org704bf9e2014-02-27 17:52:04 +0000433 // Limit on the number of early receive channels that can be created.
434 Settable<int> unsignalled_recv_stream_limit;
henrike@webrtc.org10bd88e2014-03-11 21:07:25 +0000435 // Enable use of simulcast adapter.
436 Settable<bool> use_simulcast_adapter;
henrike@webrtc.orgdce3feb2014-03-26 01:17:30 +0000437 // Force screencast to use a minimum bitrate
438 Settable<int> screencast_min_bitrate;
buildbot@webrtc.org44a317a2014-06-17 07:49:15 +0000439 // Enable payload padding.
440 Settable<bool> use_payload_padding;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000441};
442
443// A class for playing out soundclips.
444class SoundclipMedia {
445 public:
446 enum SoundclipFlags {
447 SF_LOOP = 1,
448 };
449
450 virtual ~SoundclipMedia() {}
451
452 // Plays a sound out to the speakers with the given audio stream. The stream
453 // must be 16-bit little-endian 16 kHz PCM. If a stream is already playing
454 // on this SoundclipMedia, it is stopped. If clip is NULL, nothing is played.
455 // Returns whether it was successful.
456 virtual bool PlaySound(const char *clip, int len, int flags) = 0;
457};
458
459struct RtpHeaderExtension {
460 RtpHeaderExtension() : id(0) {}
461 RtpHeaderExtension(const std::string& u, int i) : uri(u), id(i) {}
462 std::string uri;
463 int id;
464 // TODO(juberti): SendRecv direction;
465
466 bool operator==(const RtpHeaderExtension& ext) const {
467 // id is a reserved word in objective-c. Therefore the id attribute has to
468 // be a fully qualified name in order to compile on IOS.
469 return this->id == ext.id &&
470 uri == ext.uri;
471 }
472};
473
474// Returns the named header extension if found among all extensions, NULL
475// otherwise.
476inline const RtpHeaderExtension* FindHeaderExtension(
477 const std::vector<RtpHeaderExtension>& extensions,
478 const std::string& name) {
479 for (std::vector<RtpHeaderExtension>::const_iterator it = extensions.begin();
480 it != extensions.end(); ++it) {
481 if (it->uri == name)
482 return &(*it);
483 }
484 return NULL;
485}
486
487enum MediaChannelOptions {
488 // Tune the stream for conference mode.
489 OPT_CONFERENCE = 0x0001
490};
491
492enum VoiceMediaChannelOptions {
493 // Tune the audio stream for vcs with different target levels.
494 OPT_AGC_MINUS_10DB = 0x80000000
495};
496
497// DTMF flags to control if a DTMF tone should be played and/or sent.
498enum DtmfFlags {
499 DF_PLAY = 0x01,
500 DF_SEND = 0x02,
501};
502
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000503class MediaChannel : public sigslot::has_slots<> {
504 public:
505 class NetworkInterface {
506 public:
507 enum SocketType { ST_RTP, ST_RTCP };
mallinath@webrtc.org1112c302013-09-23 20:34:45 +0000508 virtual bool SendPacket(
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000509 rtc::Buffer* packet,
510 rtc::DiffServCodePoint dscp = rtc::DSCP_NO_CHANGE) = 0;
mallinath@webrtc.org1112c302013-09-23 20:34:45 +0000511 virtual bool SendRtcp(
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000512 rtc::Buffer* packet,
513 rtc::DiffServCodePoint dscp = rtc::DSCP_NO_CHANGE) = 0;
514 virtual int SetOption(SocketType type, rtc::Socket::Option opt,
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000515 int option) = 0;
516 virtual ~NetworkInterface() {}
517 };
518
519 MediaChannel() : network_interface_(NULL) {}
520 virtual ~MediaChannel() {}
521
henrike@webrtc.org1e09a712013-07-26 19:17:59 +0000522 // Sets the abstract interface class for sending RTP/RTCP data.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000523 virtual void SetInterface(NetworkInterface *iface) {
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000524 rtc::CritScope cs(&network_interface_crit_);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000525 network_interface_ = iface;
526 }
527
528 // Called when a RTP packet is received.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000529 virtual void OnPacketReceived(rtc::Buffer* packet,
530 const rtc::PacketTime& packet_time) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000531 // Called when a RTCP packet is received.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000532 virtual void OnRtcpReceived(rtc::Buffer* packet,
533 const rtc::PacketTime& packet_time) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000534 // Called when the socket's ability to send has changed.
535 virtual void OnReadyToSend(bool ready) = 0;
536 // Creates a new outgoing media stream with SSRCs and CNAME as described
537 // by sp.
538 virtual bool AddSendStream(const StreamParams& sp) = 0;
539 // Removes an outgoing media stream.
540 // ssrc must be the first SSRC of the media stream if the stream uses
541 // multiple SSRCs.
542 virtual bool RemoveSendStream(uint32 ssrc) = 0;
543 // Creates a new incoming media stream with SSRCs and CNAME as described
544 // by sp.
545 virtual bool AddRecvStream(const StreamParams& sp) = 0;
546 // Removes an incoming media stream.
547 // ssrc must be the first SSRC of the media stream if the stream uses
548 // multiple SSRCs.
549 virtual bool RemoveRecvStream(uint32 ssrc) = 0;
550
551 // Mutes the channel.
552 virtual bool MuteStream(uint32 ssrc, bool on) = 0;
553
554 // Sets the RTP extension headers and IDs to use when sending RTP.
555 virtual bool SetRecvRtpHeaderExtensions(
556 const std::vector<RtpHeaderExtension>& extensions) = 0;
557 virtual bool SetSendRtpHeaderExtensions(
558 const std::vector<RtpHeaderExtension>& extensions) = 0;
mallinath@webrtc.org92fdfeb2014-02-17 18:49:41 +0000559 // Returns the absoulte sendtime extension id value from media channel.
560 virtual int GetRtpSendTimeExtnId() const {
561 return -1;
562 }
sergeyu@chromium.org4b26e2e2014-01-15 23:15:54 +0000563 // Sets the maximum allowed bandwidth to use when sending data.
564 virtual bool SetMaxSendBandwidth(int bps) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000565
henrike@webrtc.org1e09a712013-07-26 19:17:59 +0000566 // Base method to send packet using NetworkInterface.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000567 bool SendPacket(rtc::Buffer* packet) {
henrike@webrtc.org1e09a712013-07-26 19:17:59 +0000568 return DoSendPacket(packet, false);
569 }
570
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000571 bool SendRtcp(rtc::Buffer* packet) {
henrike@webrtc.org1e09a712013-07-26 19:17:59 +0000572 return DoSendPacket(packet, true);
573 }
574
575 int SetOption(NetworkInterface::SocketType type,
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000576 rtc::Socket::Option opt,
henrike@webrtc.org1e09a712013-07-26 19:17:59 +0000577 int option) {
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000578 rtc::CritScope cs(&network_interface_crit_);
henrike@webrtc.org1e09a712013-07-26 19:17:59 +0000579 if (!network_interface_)
580 return -1;
581
582 return network_interface_->SetOption(type, opt, option);
583 }
584
wu@webrtc.orgde305012013-10-31 15:40:38 +0000585 protected:
586 // This method sets DSCP |value| on both RTP and RTCP channels.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000587 int SetDscp(rtc::DiffServCodePoint value) {
wu@webrtc.orgde305012013-10-31 15:40:38 +0000588 int ret;
589 ret = SetOption(NetworkInterface::ST_RTP,
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000590 rtc::Socket::OPT_DSCP,
wu@webrtc.orgde305012013-10-31 15:40:38 +0000591 value);
592 if (ret == 0) {
593 ret = SetOption(NetworkInterface::ST_RTCP,
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000594 rtc::Socket::OPT_DSCP,
wu@webrtc.orgde305012013-10-31 15:40:38 +0000595 value);
596 }
597 return ret;
598 }
599
henrike@webrtc.org1e09a712013-07-26 19:17:59 +0000600 private:
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000601 bool DoSendPacket(rtc::Buffer* packet, bool rtcp) {
602 rtc::CritScope cs(&network_interface_crit_);
henrike@webrtc.org1e09a712013-07-26 19:17:59 +0000603 if (!network_interface_)
604 return false;
605
606 return (!rtcp) ? network_interface_->SendPacket(packet) :
607 network_interface_->SendRtcp(packet);
608 }
609
610 // |network_interface_| can be accessed from the worker_thread and
611 // from any MediaEngine threads. This critical section is to protect accessing
612 // of network_interface_ object.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000613 rtc::CriticalSection network_interface_crit_;
henrike@webrtc.org1e09a712013-07-26 19:17:59 +0000614 NetworkInterface* network_interface_;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000615};
616
617enum SendFlags {
618 SEND_NOTHING,
619 SEND_RINGBACKTONE,
620 SEND_MICROPHONE
621};
622
wu@webrtc.org97077a32013-10-25 21:18:33 +0000623// The stats information is structured as follows:
624// Media are represented by either MediaSenderInfo or MediaReceiverInfo.
625// Media contains a vector of SSRC infos that are exclusively used by this
626// media. (SSRCs shared between media streams can't be represented.)
627
628// Information about an SSRC.
629// This data may be locally recorded, or received in an RTCP SR or RR.
630struct SsrcSenderInfo {
631 SsrcSenderInfo()
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000632 : ssrc(0),
wu@webrtc.org97077a32013-10-25 21:18:33 +0000633 timestamp(0) {
634 }
635 uint32 ssrc;
636 double timestamp; // NTP timestamp, represented as seconds since epoch.
637};
638
639struct SsrcReceiverInfo {
640 SsrcReceiverInfo()
641 : ssrc(0),
642 timestamp(0) {
643 }
644 uint32 ssrc;
645 double timestamp;
646};
647
648struct MediaSenderInfo {
649 MediaSenderInfo()
650 : bytes_sent(0),
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000651 packets_sent(0),
652 packets_lost(0),
653 fraction_lost(0.0),
wu@webrtc.org97077a32013-10-25 21:18:33 +0000654 rtt_ms(0) {
655 }
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000656 void add_ssrc(const SsrcSenderInfo& stat) {
657 local_stats.push_back(stat);
658 }
659 // Temporary utility function for call sites that only provide SSRC.
660 // As more info is added into SsrcSenderInfo, this function should go away.
661 void add_ssrc(uint32 ssrc) {
662 SsrcSenderInfo stat;
663 stat.ssrc = ssrc;
664 add_ssrc(stat);
665 }
666 // Utility accessor for clients that are only interested in ssrc numbers.
667 std::vector<uint32> ssrcs() const {
668 std::vector<uint32> retval;
669 for (std::vector<SsrcSenderInfo>::const_iterator it = local_stats.begin();
670 it != local_stats.end(); ++it) {
671 retval.push_back(it->ssrc);
672 }
673 return retval;
674 }
675 // Utility accessor for clients that make the assumption only one ssrc
676 // exists per media.
677 // This will eventually go away.
678 uint32 ssrc() const {
679 if (local_stats.size() > 0) {
680 return local_stats[0].ssrc;
681 } else {
682 return 0;
683 }
684 }
wu@webrtc.org97077a32013-10-25 21:18:33 +0000685 int64 bytes_sent;
686 int packets_sent;
687 int packets_lost;
688 float fraction_lost;
689 int rtt_ms;
690 std::string codec_name;
691 std::vector<SsrcSenderInfo> local_stats;
692 std::vector<SsrcReceiverInfo> remote_stats;
693};
694
henrike@webrtc.org704bf9e2014-02-27 17:52:04 +0000695template<class T>
696struct VariableInfo {
697 VariableInfo()
698 : min_val(),
699 mean(0.0),
700 max_val(),
701 variance(0.0) {
702 }
703 T min_val;
704 double mean;
705 T max_val;
706 double variance;
707};
708
wu@webrtc.org97077a32013-10-25 21:18:33 +0000709struct MediaReceiverInfo {
710 MediaReceiverInfo()
711 : bytes_rcvd(0),
712 packets_rcvd(0),
713 packets_lost(0),
714 fraction_lost(0.0) {
715 }
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000716 void add_ssrc(const SsrcReceiverInfo& stat) {
717 local_stats.push_back(stat);
718 }
719 // Temporary utility function for call sites that only provide SSRC.
720 // As more info is added into SsrcSenderInfo, this function should go away.
721 void add_ssrc(uint32 ssrc) {
722 SsrcReceiverInfo stat;
723 stat.ssrc = ssrc;
724 add_ssrc(stat);
725 }
726 std::vector<uint32> ssrcs() const {
727 std::vector<uint32> retval;
728 for (std::vector<SsrcReceiverInfo>::const_iterator it = local_stats.begin();
729 it != local_stats.end(); ++it) {
730 retval.push_back(it->ssrc);
731 }
732 return retval;
733 }
734 // Utility accessor for clients that make the assumption only one ssrc
735 // exists per media.
736 // This will eventually go away.
737 uint32 ssrc() const {
738 if (local_stats.size() > 0) {
739 return local_stats[0].ssrc;
740 } else {
741 return 0;
742 }
743 }
744
wu@webrtc.org97077a32013-10-25 21:18:33 +0000745 int64 bytes_rcvd;
746 int packets_rcvd;
747 int packets_lost;
748 float fraction_lost;
buildbot@webrtc.org7e71b772014-06-13 01:14:01 +0000749 std::string codec_name;
wu@webrtc.org97077a32013-10-25 21:18:33 +0000750 std::vector<SsrcReceiverInfo> local_stats;
751 std::vector<SsrcSenderInfo> remote_stats;
752};
753
754struct VoiceSenderInfo : public MediaSenderInfo {
755 VoiceSenderInfo()
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000756 : ext_seqnum(0),
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000757 jitter_ms(0),
758 audio_level(0),
759 aec_quality_min(0.0),
760 echo_delay_median_ms(0),
761 echo_delay_std_ms(0),
762 echo_return_loss(0),
wu@webrtc.org967bfff2013-09-19 05:49:50 +0000763 echo_return_loss_enhancement(0),
764 typing_noise_detected(false) {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000765 }
766
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000767 int ext_seqnum;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000768 int jitter_ms;
769 int audio_level;
770 float aec_quality_min;
771 int echo_delay_median_ms;
772 int echo_delay_std_ms;
773 int echo_return_loss;
774 int echo_return_loss_enhancement;
wu@webrtc.org967bfff2013-09-19 05:49:50 +0000775 bool typing_noise_detected;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000776};
777
wu@webrtc.org97077a32013-10-25 21:18:33 +0000778struct VoiceReceiverInfo : public MediaReceiverInfo {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000779 VoiceReceiverInfo()
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000780 : ext_seqnum(0),
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000781 jitter_ms(0),
782 jitter_buffer_ms(0),
783 jitter_buffer_preferred_ms(0),
784 delay_estimate_ms(0),
785 audio_level(0),
henrike@webrtc.orgb8c254a2014-02-14 23:38:45 +0000786 expand_rate(0),
787 decoding_calls_to_silence_generator(0),
788 decoding_calls_to_neteq(0),
789 decoding_normal(0),
790 decoding_plc(0),
791 decoding_cng(0),
buildbot@webrtc.orgb525a9d2014-06-03 09:42:15 +0000792 decoding_plc_cng(0),
793 capture_start_ntp_time_ms(-1) {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000794 }
795
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000796 int ext_seqnum;
797 int jitter_ms;
798 int jitter_buffer_ms;
799 int jitter_buffer_preferred_ms;
800 int delay_estimate_ms;
801 int audio_level;
802 // fraction of synthesized speech inserted through pre-emptive expansion
803 float expand_rate;
henrike@webrtc.orgb8c254a2014-02-14 23:38:45 +0000804 int decoding_calls_to_silence_generator;
805 int decoding_calls_to_neteq;
806 int decoding_normal;
807 int decoding_plc;
808 int decoding_cng;
809 int decoding_plc_cng;
buildbot@webrtc.orgb525a9d2014-06-03 09:42:15 +0000810 // Estimated capture start time in NTP time in ms.
811 int64 capture_start_ntp_time_ms;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000812};
813
wu@webrtc.org97077a32013-10-25 21:18:33 +0000814struct VideoSenderInfo : public MediaSenderInfo {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000815 VideoSenderInfo()
wu@webrtc.org97077a32013-10-25 21:18:33 +0000816 : packets_cached(0),
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000817 firs_rcvd(0),
henrike@webrtc.org704bf9e2014-02-27 17:52:04 +0000818 plis_rcvd(0),
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000819 nacks_rcvd(0),
wu@webrtc.org987f2c92014-03-28 16:22:19 +0000820 input_frame_width(0),
821 input_frame_height(0),
822 send_frame_width(0),
823 send_frame_height(0),
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000824 framerate_input(0),
825 framerate_sent(0),
826 nominal_bitrate(0),
827 preferred_bitrate(0),
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000828 adapt_reason(0),
buildbot@webrtc.org71dffb72014-06-24 07:24:49 +0000829 adapt_changes(0),
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000830 capture_jitter_ms(0),
wu@webrtc.org9caf2762013-12-11 18:25:07 +0000831 avg_encode_ms(0),
832 encode_usage_percent(0),
833 capture_queue_delay_ms_per_s(0) {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000834 }
835
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000836 std::vector<SsrcGroup> ssrc_groups;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000837 int packets_cached;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000838 int firs_rcvd;
henrike@webrtc.org704bf9e2014-02-27 17:52:04 +0000839 int plis_rcvd;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000840 int nacks_rcvd;
wu@webrtc.org987f2c92014-03-28 16:22:19 +0000841 int input_frame_width;
842 int input_frame_height;
843 int send_frame_width;
844 int send_frame_height;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000845 int framerate_input;
846 int framerate_sent;
847 int nominal_bitrate;
848 int preferred_bitrate;
849 int adapt_reason;
buildbot@webrtc.org71dffb72014-06-24 07:24:49 +0000850 int adapt_changes;
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000851 int capture_jitter_ms;
852 int avg_encode_ms;
wu@webrtc.org9caf2762013-12-11 18:25:07 +0000853 int encode_usage_percent;
854 int capture_queue_delay_ms_per_s;
henrike@webrtc.org704bf9e2014-02-27 17:52:04 +0000855 VariableInfo<int> adapt_frame_drops;
856 VariableInfo<int> effects_frame_drops;
857 VariableInfo<double> capturer_frame_time;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000858};
859
wu@webrtc.org97077a32013-10-25 21:18:33 +0000860struct VideoReceiverInfo : public MediaReceiverInfo {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000861 VideoReceiverInfo()
wu@webrtc.org97077a32013-10-25 21:18:33 +0000862 : packets_concealed(0),
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000863 firs_sent(0),
henrike@webrtc.org704bf9e2014-02-27 17:52:04 +0000864 plis_sent(0),
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000865 nacks_sent(0),
866 frame_width(0),
867 frame_height(0),
868 framerate_rcvd(0),
869 framerate_decoded(0),
870 framerate_output(0),
871 framerate_render_input(0),
wu@webrtc.org97077a32013-10-25 21:18:33 +0000872 framerate_render_output(0),
873 decode_ms(0),
874 max_decode_ms(0),
875 jitter_buffer_ms(0),
876 min_playout_delay_ms(0),
877 render_delay_ms(0),
878 target_delay_ms(0),
buildbot@webrtc.org0581f0b2014-05-06 21:36:31 +0000879 current_delay_ms(0),
buildbot@webrtc.orgb525a9d2014-06-03 09:42:15 +0000880 capture_start_ntp_time_ms(-1) {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000881 }
882
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000883 std::vector<SsrcGroup> ssrc_groups;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000884 int packets_concealed;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000885 int firs_sent;
henrike@webrtc.org704bf9e2014-02-27 17:52:04 +0000886 int plis_sent;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000887 int nacks_sent;
888 int frame_width;
889 int frame_height;
890 int framerate_rcvd;
891 int framerate_decoded;
892 int framerate_output;
893 // Framerate as sent to the renderer.
894 int framerate_render_input;
895 // Framerate that the renderer reports.
896 int framerate_render_output;
wu@webrtc.org97077a32013-10-25 21:18:33 +0000897
898 // All stats below are gathered per-VideoReceiver, but some will be correlated
899 // across MediaStreamTracks. NOTE(hta): when sinking stats into per-SSRC
900 // structures, reflect this in the new layout.
901
902 // Current frame decode latency.
903 int decode_ms;
904 // Maximum observed frame decode latency.
905 int max_decode_ms;
906 // Jitter (network-related) latency.
907 int jitter_buffer_ms;
908 // Requested minimum playout latency.
909 int min_playout_delay_ms;
910 // Requested latency to account for rendering delay.
911 int render_delay_ms;
912 // Target overall delay: network+decode+render, accounting for
913 // min_playout_delay_ms.
914 int target_delay_ms;
915 // Current overall delay, possibly ramping towards target_delay_ms.
916 int current_delay_ms;
buildbot@webrtc.org0581f0b2014-05-06 21:36:31 +0000917
918 // Estimated capture start time in NTP time in ms.
919 int64 capture_start_ntp_time_ms;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000920};
921
wu@webrtc.org97077a32013-10-25 21:18:33 +0000922struct DataSenderInfo : public MediaSenderInfo {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000923 DataSenderInfo()
wu@webrtc.org97077a32013-10-25 21:18:33 +0000924 : ssrc(0) {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000925 }
926
927 uint32 ssrc;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000928};
929
wu@webrtc.org97077a32013-10-25 21:18:33 +0000930struct DataReceiverInfo : public MediaReceiverInfo {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000931 DataReceiverInfo()
wu@webrtc.org97077a32013-10-25 21:18:33 +0000932 : ssrc(0) {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000933 }
934
935 uint32 ssrc;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000936};
937
938struct BandwidthEstimationInfo {
939 BandwidthEstimationInfo()
940 : available_send_bandwidth(0),
941 available_recv_bandwidth(0),
942 target_enc_bitrate(0),
943 actual_enc_bitrate(0),
944 retransmit_bitrate(0),
945 transmit_bitrate(0),
wu@webrtc.orgb9a088b2014-02-13 23:18:49 +0000946 bucket_delay(0),
947 total_received_propagation_delta_ms(0) {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000948 }
949
950 int available_send_bandwidth;
951 int available_recv_bandwidth;
952 int target_enc_bitrate;
953 int actual_enc_bitrate;
954 int retransmit_bitrate;
955 int transmit_bitrate;
956 int bucket_delay;
wu@webrtc.orgb9a088b2014-02-13 23:18:49 +0000957 // The following stats are only valid when
958 // StatsOptions::include_received_propagation_stats is true.
959 int total_received_propagation_delta_ms;
960 std::vector<int> recent_received_propagation_delta_ms;
tkchin@webrtc.org14146e42014-10-31 00:14:39 +0000961 std::vector<int64_t> recent_received_packet_group_arrival_time_ms;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000962};
963
964struct VoiceMediaInfo {
965 void Clear() {
966 senders.clear();
967 receivers.clear();
968 }
969 std::vector<VoiceSenderInfo> senders;
970 std::vector<VoiceReceiverInfo> receivers;
971};
972
973struct VideoMediaInfo {
974 void Clear() {
975 senders.clear();
976 receivers.clear();
977 bw_estimations.clear();
978 }
979 std::vector<VideoSenderInfo> senders;
980 std::vector<VideoReceiverInfo> receivers;
981 std::vector<BandwidthEstimationInfo> bw_estimations;
982};
983
984struct DataMediaInfo {
985 void Clear() {
986 senders.clear();
987 receivers.clear();
988 }
989 std::vector<DataSenderInfo> senders;
990 std::vector<DataReceiverInfo> receivers;
991};
992
wu@webrtc.orgb9a088b2014-02-13 23:18:49 +0000993struct StatsOptions {
994 StatsOptions() : include_received_propagation_stats(false) {}
995
996 bool include_received_propagation_stats;
997};
998
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000999class VoiceMediaChannel : public MediaChannel {
1000 public:
1001 enum Error {
1002 ERROR_NONE = 0, // No error.
1003 ERROR_OTHER, // Other errors.
1004 ERROR_REC_DEVICE_OPEN_FAILED = 100, // Could not open mic.
1005 ERROR_REC_DEVICE_MUTED, // Mic was muted by OS.
1006 ERROR_REC_DEVICE_SILENT, // No background noise picked up.
1007 ERROR_REC_DEVICE_SATURATION, // Mic input is clipping.
1008 ERROR_REC_DEVICE_REMOVED, // Mic was removed while active.
1009 ERROR_REC_RUNTIME_ERROR, // Processing is encountering errors.
1010 ERROR_REC_SRTP_ERROR, // Generic SRTP failure.
1011 ERROR_REC_SRTP_AUTH_FAILED, // Failed to authenticate packets.
1012 ERROR_REC_TYPING_NOISE_DETECTED, // Typing noise is detected.
1013 ERROR_PLAY_DEVICE_OPEN_FAILED = 200, // Could not open playout.
1014 ERROR_PLAY_DEVICE_MUTED, // Playout muted by OS.
1015 ERROR_PLAY_DEVICE_REMOVED, // Playout removed while active.
1016 ERROR_PLAY_RUNTIME_ERROR, // Errors in voice processing.
1017 ERROR_PLAY_SRTP_ERROR, // Generic SRTP failure.
1018 ERROR_PLAY_SRTP_AUTH_FAILED, // Failed to authenticate packets.
1019 ERROR_PLAY_SRTP_REPLAY, // Packet replay detected.
1020 };
1021
1022 VoiceMediaChannel() {}
1023 virtual ~VoiceMediaChannel() {}
1024 // Sets the codecs/payload types to be used for incoming media.
1025 virtual bool SetRecvCodecs(const std::vector<AudioCodec>& codecs) = 0;
1026 // Sets the codecs/payload types to be used for outgoing media.
1027 virtual bool SetSendCodecs(const std::vector<AudioCodec>& codecs) = 0;
1028 // Starts or stops playout of received audio.
1029 virtual bool SetPlayout(bool playout) = 0;
1030 // Starts or stops sending (and potentially capture) of local audio.
1031 virtual bool SetSend(SendFlags flag) = 0;
henrike@webrtc.org1e09a712013-07-26 19:17:59 +00001032 // Sets the renderer object to be used for the specified remote audio stream.
1033 virtual bool SetRemoteRenderer(uint32 ssrc, AudioRenderer* renderer) = 0;
1034 // Sets the renderer object to be used for the specified local audio stream.
1035 virtual bool SetLocalRenderer(uint32 ssrc, AudioRenderer* renderer) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001036 // Gets current energy levels for all incoming streams.
1037 virtual bool GetActiveStreams(AudioInfo::StreamList* actives) = 0;
1038 // Get the current energy level of the stream sent to the speaker.
1039 virtual int GetOutputLevel() = 0;
1040 // Get the time in milliseconds since last recorded keystroke, or negative.
1041 virtual int GetTimeSinceLastTyping() = 0;
1042 // Temporarily exposed field for tuning typing detect options.
1043 virtual void SetTypingDetectionParameters(int time_window,
1044 int cost_per_typing, int reporting_threshold, int penalty_decay,
1045 int type_event_delay) = 0;
1046 // Set left and right scale for speaker output volume of the specified ssrc.
1047 virtual bool SetOutputScaling(uint32 ssrc, double left, double right) = 0;
1048 // Get left and right scale for speaker output volume of the specified ssrc.
1049 virtual bool GetOutputScaling(uint32 ssrc, double* left, double* right) = 0;
1050 // Specifies a ringback tone to be played during call setup.
1051 virtual bool SetRingbackTone(const char *buf, int len) = 0;
1052 // Plays or stops the aforementioned ringback tone
1053 virtual bool PlayRingbackTone(uint32 ssrc, bool play, bool loop) = 0;
1054 // Returns if the telephone-event has been negotiated.
1055 virtual bool CanInsertDtmf() { return false; }
1056 // Send and/or play a DTMF |event| according to the |flags|.
1057 // The DTMF out-of-band signal will be used on sending.
1058 // The |ssrc| should be either 0 or a valid send stream ssrc.
henrike@webrtc.org9de257d2013-07-17 14:42:53 +00001059 // The valid value for the |event| are 0 to 15 which corresponding to
1060 // DTMF event 0-9, *, #, A-D.
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001061 virtual bool InsertDtmf(uint32 ssrc, int event, int duration, int flags) = 0;
1062 // Gets quality stats for the channel.
1063 virtual bool GetStats(VoiceMediaInfo* info) = 0;
1064 // Gets last reported error for this media channel.
1065 virtual void GetLastMediaError(uint32* ssrc,
1066 VoiceMediaChannel::Error* error) {
1067 ASSERT(error != NULL);
1068 *error = ERROR_NONE;
1069 }
1070 // Sets the media options to use.
1071 virtual bool SetOptions(const AudioOptions& options) = 0;
1072 virtual bool GetOptions(AudioOptions* options) const = 0;
1073
1074 // Signal errors from MediaChannel. Arguments are:
1075 // ssrc(uint32), and error(VoiceMediaChannel::Error).
1076 sigslot::signal2<uint32, VoiceMediaChannel::Error> SignalMediaError;
1077};
1078
1079class VideoMediaChannel : public MediaChannel {
1080 public:
1081 enum Error {
1082 ERROR_NONE = 0, // No error.
1083 ERROR_OTHER, // Other errors.
1084 ERROR_REC_DEVICE_OPEN_FAILED = 100, // Could not open camera.
1085 ERROR_REC_DEVICE_NO_DEVICE, // No camera.
1086 ERROR_REC_DEVICE_IN_USE, // Device is in already use.
1087 ERROR_REC_DEVICE_REMOVED, // Device is removed.
1088 ERROR_REC_SRTP_ERROR, // Generic sender SRTP failure.
1089 ERROR_REC_SRTP_AUTH_FAILED, // Failed to authenticate packets.
1090 ERROR_REC_CPU_MAX_CANT_DOWNGRADE, // Can't downgrade capture anymore.
1091 ERROR_PLAY_SRTP_ERROR = 200, // Generic receiver SRTP failure.
1092 ERROR_PLAY_SRTP_AUTH_FAILED, // Failed to authenticate packets.
1093 ERROR_PLAY_SRTP_REPLAY, // Packet replay detected.
1094 };
1095
1096 VideoMediaChannel() : renderer_(NULL) {}
1097 virtual ~VideoMediaChannel() {}
1098 // Sets the codecs/payload types to be used for incoming media.
1099 virtual bool SetRecvCodecs(const std::vector<VideoCodec>& codecs) = 0;
1100 // Sets the codecs/payload types to be used for outgoing media.
1101 virtual bool SetSendCodecs(const std::vector<VideoCodec>& codecs) = 0;
1102 // Gets the currently set codecs/payload types to be used for outgoing media.
1103 virtual bool GetSendCodec(VideoCodec* send_codec) = 0;
1104 // Sets the format of a specified outgoing stream.
1105 virtual bool SetSendStreamFormat(uint32 ssrc, const VideoFormat& format) = 0;
1106 // Starts or stops playout of received video.
1107 virtual bool SetRender(bool render) = 0;
1108 // Starts or stops transmission (and potentially capture) of local video.
1109 virtual bool SetSend(bool send) = 0;
1110 // Sets the renderer object to be used for the specified stream.
1111 // If SSRC is 0, the renderer is used for the 'default' stream.
1112 virtual bool SetRenderer(uint32 ssrc, VideoRenderer* renderer) = 0;
1113 // If |ssrc| is 0, replace the default capturer (engine capturer) with
1114 // |capturer|. If |ssrc| is non zero create a new stream with |ssrc| as SSRC.
1115 virtual bool SetCapturer(uint32 ssrc, VideoCapturer* capturer) = 0;
1116 // Gets quality stats for the channel.
wu@webrtc.orgb9a088b2014-02-13 23:18:49 +00001117 virtual bool GetStats(const StatsOptions& options, VideoMediaInfo* info) = 0;
1118 // This is needed for MediaMonitor to use the same template for voice, video
1119 // and data MediaChannels.
1120 bool GetStats(VideoMediaInfo* info) {
1121 return GetStats(StatsOptions(), info);
1122 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001123
1124 // Send an intra frame to the receivers.
1125 virtual bool SendIntraFrame() = 0;
1126 // Reuqest each of the remote senders to send an intra frame.
1127 virtual bool RequestIntraFrame() = 0;
1128 // Sets the media options to use.
1129 virtual bool SetOptions(const VideoOptions& options) = 0;
1130 virtual bool GetOptions(VideoOptions* options) const = 0;
1131 virtual void UpdateAspectRatio(int ratio_w, int ratio_h) = 0;
1132
1133 // Signal errors from MediaChannel. Arguments are:
1134 // ssrc(uint32), and error(VideoMediaChannel::Error).
1135 sigslot::signal2<uint32, Error> SignalMediaError;
1136
1137 protected:
1138 VideoRenderer *renderer_;
1139};
1140
1141enum DataMessageType {
mallinath@webrtc.org1112c302013-09-23 20:34:45 +00001142 // Chrome-Internal use only. See SctpDataMediaChannel for the actual PPID
1143 // values.
1144 DMT_NONE = 0,
1145 DMT_CONTROL = 1,
1146 DMT_BINARY = 2,
1147 DMT_TEXT = 3,
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001148};
1149
1150// Info about data received in DataMediaChannel. For use in
1151// DataMediaChannel::SignalDataReceived and in all of the signals that
1152// signal fires, on up the chain.
1153struct ReceiveDataParams {
1154 // The in-packet stream indentifier.
1155 // For SCTP, this is really SID, not SSRC.
1156 uint32 ssrc;
1157 // The type of message (binary, text, or control).
1158 DataMessageType type;
1159 // A per-stream value incremented per packet in the stream.
1160 int seq_num;
1161 // A per-stream value monotonically increasing with time.
1162 int timestamp;
1163
1164 ReceiveDataParams() :
1165 ssrc(0),
1166 type(DMT_TEXT),
1167 seq_num(0),
1168 timestamp(0) {
1169 }
1170};
1171
1172struct SendDataParams {
1173 // The in-packet stream indentifier.
1174 // For SCTP, this is really SID, not SSRC.
1175 uint32 ssrc;
1176 // The type of message (binary, text, or control).
1177 DataMessageType type;
1178
1179 // For SCTP, whether to send messages flagged as ordered or not.
1180 // If false, messages can be received out of order.
1181 bool ordered;
1182 // For SCTP, whether the messages are sent reliably or not.
1183 // If false, messages may be lost.
1184 bool reliable;
1185 // For SCTP, if reliable == false, provide partial reliability by
1186 // resending up to this many times. Either count or millis
1187 // is supported, not both at the same time.
1188 int max_rtx_count;
1189 // For SCTP, if reliable == false, provide partial reliability by
1190 // resending for up to this many milliseconds. Either count or millis
1191 // is supported, not both at the same time.
1192 int max_rtx_ms;
1193
1194 SendDataParams() :
1195 ssrc(0),
1196 type(DMT_TEXT),
1197 // TODO(pthatcher): Make these true by default?
1198 ordered(false),
1199 reliable(false),
1200 max_rtx_count(0),
1201 max_rtx_ms(0) {
1202 }
1203};
1204
1205enum SendDataResult { SDR_SUCCESS, SDR_ERROR, SDR_BLOCK };
1206
1207class DataMediaChannel : public MediaChannel {
1208 public:
1209 enum Error {
1210 ERROR_NONE = 0, // No error.
1211 ERROR_OTHER, // Other errors.
1212 ERROR_SEND_SRTP_ERROR = 200, // Generic SRTP failure.
1213 ERROR_SEND_SRTP_AUTH_FAILED, // Failed to authenticate packets.
1214 ERROR_RECV_SRTP_ERROR, // Generic SRTP failure.
1215 ERROR_RECV_SRTP_AUTH_FAILED, // Failed to authenticate packets.
1216 ERROR_RECV_SRTP_REPLAY, // Packet replay detected.
1217 };
1218
1219 virtual ~DataMediaChannel() {}
1220
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001221 virtual bool SetSendCodecs(const std::vector<DataCodec>& codecs) = 0;
1222 virtual bool SetRecvCodecs(const std::vector<DataCodec>& codecs) = 0;
wu@webrtc.orga9890802013-12-13 00:21:03 +00001223
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001224 virtual bool MuteStream(uint32 ssrc, bool on) { return false; }
1225 // TODO(pthatcher): Implement this.
1226 virtual bool GetStats(DataMediaInfo* info) { return true; }
1227
1228 virtual bool SetSend(bool send) = 0;
1229 virtual bool SetReceive(bool receive) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001230
1231 virtual bool SendData(
1232 const SendDataParams& params,
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +00001233 const rtc::Buffer& payload,
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001234 SendDataResult* result = NULL) = 0;
1235 // Signals when data is received (params, data, len)
1236 sigslot::signal3<const ReceiveDataParams&,
1237 const char*,
1238 size_t> SignalDataReceived;
1239 // Signal errors from MediaChannel. Arguments are:
1240 // ssrc(uint32), and error(DataMediaChannel::Error).
1241 sigslot::signal2<uint32, DataMediaChannel::Error> SignalMediaError;
wu@webrtc.orgd64719d2013-08-01 00:00:07 +00001242 // Signal when the media channel is ready to send the stream. Arguments are:
1243 // writable(bool)
1244 sigslot::signal1<bool> SignalReadyToSend;
buildbot@webrtc.org1d66be22014-05-29 22:54:24 +00001245 // Signal for notifying that the remote side has closed the DataChannel.
1246 sigslot::signal1<uint32> SignalStreamClosedRemotely;
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001247};
1248
1249} // namespace cricket
1250
1251#endif // TALK_MEDIA_BASE_MEDIACHANNEL_H_