blob: 5984815ad048e9587f6aacaa44e477db1d54a53d [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
34#include "talk/base/basictypes.h"
35#include "talk/base/buffer.h"
mallinath@webrtc.org1112c302013-09-23 20:34:45 +000036#include "talk/base/dscp.h"
henrike@webrtc.org28e20752013-07-10 00:45:36 +000037#include "talk/base/logging.h"
38#include "talk/base/sigslot.h"
39#include "talk/base/socket.h"
40#include "talk/base/window.h"
41#include "talk/media/base/codec.h"
42#include "talk/media/base/constants.h"
43#include "talk/media/base/streamparams.h"
44// TODO(juberti): re-evaluate this include
45#include "talk/session/media/audiomonitor.h"
46
47namespace talk_base {
48class 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;
65
66// Used in AudioOptions and VideoOptions to signify "unset" values.
67template <class T>
68class Settable {
69 public:
70 Settable() : set_(false), val_() {}
71 explicit Settable(T val) : set_(true), val_(val) {}
72
73 bool IsSet() const {
74 return set_;
75 }
76
77 bool Get(T* out) const {
78 *out = val_;
79 return set_;
80 }
81
82 T GetWithDefaultIfUnset(const T& default_value) const {
83 return set_ ? val_ : default_value;
84 }
85
86 virtual void Set(T val) {
87 set_ = true;
88 val_ = val;
89 }
90
91 void Clear() {
92 Set(T());
93 set_ = false;
94 }
95
96 void SetFrom(const Settable<T>& o) {
97 // Set this value based on the value of o, iff o is set. If this value is
98 // set and o is unset, the current value will be unchanged.
99 T val;
100 if (o.Get(&val)) {
101 Set(val);
102 }
103 }
104
105 std::string ToString() const {
106 return set_ ? talk_base::ToString(val_) : "";
107 }
108
109 bool operator==(const Settable<T>& o) const {
110 // Equal if both are unset with any value or both set with the same value.
111 return (set_ == o.set_) && (!set_ || (val_ == o.val_));
112 }
113
114 bool operator!=(const Settable<T>& o) const {
115 return !operator==(o);
116 }
117
118 protected:
119 void InitializeValue(const T &val) {
120 val_ = val;
121 }
122
123 private:
124 bool set_;
125 T val_;
126};
127
128class SettablePercent : public Settable<float> {
129 public:
130 virtual void Set(float val) {
131 if (val < 0) {
132 val = 0;
133 }
134 if (val > 1.0) {
135 val = 1.0;
136 }
137 Settable<float>::Set(val);
138 }
139};
140
141template <class T>
142static std::string ToStringIfSet(const char* key, const Settable<T>& val) {
143 std::string str;
144 if (val.IsSet()) {
145 str = key;
146 str += ": ";
147 str += val.ToString();
148 str += ", ";
149 }
150 return str;
151}
152
153// Options that can be applied to a VoiceMediaChannel or a VoiceMediaEngine.
154// Used to be flags, but that makes it hard to selectively apply options.
155// We are moving all of the setting of options to structs like this,
156// but some things currently still use flags.
157struct AudioOptions {
158 void SetAll(const AudioOptions& change) {
159 echo_cancellation.SetFrom(change.echo_cancellation);
160 auto_gain_control.SetFrom(change.auto_gain_control);
wu@webrtc.org97077a32013-10-25 21:18:33 +0000161 rx_auto_gain_control.SetFrom(change.rx_auto_gain_control);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000162 noise_suppression.SetFrom(change.noise_suppression);
163 highpass_filter.SetFrom(change.highpass_filter);
164 stereo_swapping.SetFrom(change.stereo_swapping);
165 typing_detection.SetFrom(change.typing_detection);
wu@webrtc.org97077a32013-10-25 21:18:33 +0000166 aecm_generate_comfort_noise.SetFrom(change.aecm_generate_comfort_noise);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000167 conference_mode.SetFrom(change.conference_mode);
168 adjust_agc_delta.SetFrom(change.adjust_agc_delta);
169 experimental_agc.SetFrom(change.experimental_agc);
170 experimental_aec.SetFrom(change.experimental_aec);
sergeyu@chromium.org9cf037b2014-02-07 19:03:26 +0000171 experimental_ns.SetFrom(change.experimental_ns);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000172 aec_dump.SetFrom(change.aec_dump);
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000173 experimental_acm.SetFrom(change.experimental_acm);
wu@webrtc.org97077a32013-10-25 21:18:33 +0000174 tx_agc_target_dbov.SetFrom(change.tx_agc_target_dbov);
175 tx_agc_digital_compression_gain.SetFrom(
176 change.tx_agc_digital_compression_gain);
177 tx_agc_limiter.SetFrom(change.tx_agc_limiter);
178 rx_agc_target_dbov.SetFrom(change.rx_agc_target_dbov);
179 rx_agc_digital_compression_gain.SetFrom(
180 change.rx_agc_digital_compression_gain);
181 rx_agc_limiter.SetFrom(change.rx_agc_limiter);
182 recording_sample_rate.SetFrom(change.recording_sample_rate);
183 playout_sample_rate.SetFrom(change.playout_sample_rate);
wu@webrtc.orgde305012013-10-31 15:40:38 +0000184 dscp.SetFrom(change.dscp);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000185 }
186
187 bool operator==(const AudioOptions& o) const {
188 return echo_cancellation == o.echo_cancellation &&
189 auto_gain_control == o.auto_gain_control &&
wu@webrtc.org97077a32013-10-25 21:18:33 +0000190 rx_auto_gain_control == o.rx_auto_gain_control &&
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000191 noise_suppression == o.noise_suppression &&
192 highpass_filter == o.highpass_filter &&
193 stereo_swapping == o.stereo_swapping &&
194 typing_detection == o.typing_detection &&
wu@webrtc.org97077a32013-10-25 21:18:33 +0000195 aecm_generate_comfort_noise == o.aecm_generate_comfort_noise &&
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000196 conference_mode == o.conference_mode &&
197 experimental_agc == o.experimental_agc &&
198 experimental_aec == o.experimental_aec &&
sergeyu@chromium.org9cf037b2014-02-07 19:03:26 +0000199 experimental_ns == o.experimental_ns &&
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000200 adjust_agc_delta == o.adjust_agc_delta &&
wu@webrtc.org97077a32013-10-25 21:18:33 +0000201 aec_dump == o.aec_dump &&
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000202 experimental_acm == o.experimental_acm &&
wu@webrtc.org97077a32013-10-25 21:18:33 +0000203 tx_agc_target_dbov == o.tx_agc_target_dbov &&
204 tx_agc_digital_compression_gain == o.tx_agc_digital_compression_gain &&
205 tx_agc_limiter == o.tx_agc_limiter &&
206 rx_agc_target_dbov == o.rx_agc_target_dbov &&
207 rx_agc_digital_compression_gain == o.rx_agc_digital_compression_gain &&
208 rx_agc_limiter == o.rx_agc_limiter &&
209 recording_sample_rate == o.recording_sample_rate &&
wu@webrtc.orgde305012013-10-31 15:40:38 +0000210 playout_sample_rate == o.playout_sample_rate &&
211 dscp == o.dscp;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000212 }
213
214 std::string ToString() const {
215 std::ostringstream ost;
216 ost << "AudioOptions {";
217 ost << ToStringIfSet("aec", echo_cancellation);
218 ost << ToStringIfSet("agc", auto_gain_control);
wu@webrtc.org97077a32013-10-25 21:18:33 +0000219 ost << ToStringIfSet("rx_agc", rx_auto_gain_control);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000220 ost << ToStringIfSet("ns", noise_suppression);
221 ost << ToStringIfSet("hf", highpass_filter);
222 ost << ToStringIfSet("swap", stereo_swapping);
223 ost << ToStringIfSet("typing", typing_detection);
wu@webrtc.org97077a32013-10-25 21:18:33 +0000224 ost << ToStringIfSet("comfort_noise", aecm_generate_comfort_noise);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000225 ost << ToStringIfSet("conference", conference_mode);
226 ost << ToStringIfSet("agc_delta", adjust_agc_delta);
227 ost << ToStringIfSet("experimental_agc", experimental_agc);
228 ost << ToStringIfSet("experimental_aec", experimental_aec);
sergeyu@chromium.org9cf037b2014-02-07 19:03:26 +0000229 ost << ToStringIfSet("experimental_ns", experimental_ns);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000230 ost << ToStringIfSet("aec_dump", aec_dump);
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000231 ost << ToStringIfSet("experimental_acm", experimental_acm);
wu@webrtc.org97077a32013-10-25 21:18:33 +0000232 ost << ToStringIfSet("tx_agc_target_dbov", tx_agc_target_dbov);
233 ost << ToStringIfSet("tx_agc_digital_compression_gain",
234 tx_agc_digital_compression_gain);
235 ost << ToStringIfSet("tx_agc_limiter", tx_agc_limiter);
236 ost << ToStringIfSet("rx_agc_target_dbov", rx_agc_target_dbov);
237 ost << ToStringIfSet("rx_agc_digital_compression_gain",
238 rx_agc_digital_compression_gain);
239 ost << ToStringIfSet("rx_agc_limiter", rx_agc_limiter);
240 ost << ToStringIfSet("recording_sample_rate", recording_sample_rate);
241 ost << ToStringIfSet("playout_sample_rate", playout_sample_rate);
wu@webrtc.orgde305012013-10-31 15:40:38 +0000242 ost << ToStringIfSet("dscp", dscp);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000243 ost << "}";
244 return ost.str();
245 }
246
247 // Audio processing that attempts to filter away the output signal from
248 // later inbound pickup.
249 Settable<bool> echo_cancellation;
250 // Audio processing to adjust the sensitivity of the local mic dynamically.
251 Settable<bool> auto_gain_control;
wu@webrtc.org97077a32013-10-25 21:18:33 +0000252 // Audio processing to apply gain to the remote audio.
253 Settable<bool> rx_auto_gain_control;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000254 // Audio processing to filter out background noise.
255 Settable<bool> noise_suppression;
256 // Audio processing to remove background noise of lower frequencies.
257 Settable<bool> highpass_filter;
258 // Audio processing to swap the left and right channels.
259 Settable<bool> stereo_swapping;
260 // Audio processing to detect typing.
261 Settable<bool> typing_detection;
wu@webrtc.org97077a32013-10-25 21:18:33 +0000262 Settable<bool> aecm_generate_comfort_noise;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000263 Settable<bool> conference_mode;
264 Settable<int> adjust_agc_delta;
265 Settable<bool> experimental_agc;
266 Settable<bool> experimental_aec;
sergeyu@chromium.org9cf037b2014-02-07 19:03:26 +0000267 Settable<bool> experimental_ns;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000268 Settable<bool> aec_dump;
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000269 Settable<bool> experimental_acm;
wu@webrtc.org97077a32013-10-25 21:18:33 +0000270 // Note that tx_agc_* only applies to non-experimental AGC.
271 Settable<uint16> tx_agc_target_dbov;
272 Settable<uint16> tx_agc_digital_compression_gain;
273 Settable<bool> tx_agc_limiter;
274 Settable<uint16> rx_agc_target_dbov;
275 Settable<uint16> rx_agc_digital_compression_gain;
276 Settable<bool> rx_agc_limiter;
277 Settable<uint32> recording_sample_rate;
278 Settable<uint32> playout_sample_rate;
wu@webrtc.orgde305012013-10-31 15:40:38 +0000279 // Set DSCP value for packet sent from audio channel.
280 Settable<bool> dscp;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000281};
282
283// Options that can be applied to a VideoMediaChannel or a VideoMediaEngine.
284// Used to be flags, but that makes it hard to selectively apply options.
285// We are moving all of the setting of options to structs like this,
286// but some things currently still use flags.
287struct VideoOptions {
henrike@webrtc.orgf45a5502014-03-13 18:51:34 +0000288 enum HighestBitrate {
289 NORMAL,
290 HIGH,
291 VERY_HIGH
292 };
293
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000294 VideoOptions() {
295 process_adaptation_threshhold.Set(kProcessCpuThreshold);
296 system_low_adaptation_threshhold.Set(kLowSystemCpuThreshold);
297 system_high_adaptation_threshhold.Set(kHighSystemCpuThreshold);
henrike@webrtc.org704bf9e2014-02-27 17:52:04 +0000298 unsignalled_recv_stream_limit.Set(kNumDefaultUnsignalledVideoRecvStreams);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000299 }
300
301 void SetAll(const VideoOptions& change) {
302 adapt_input_to_encoder.SetFrom(change.adapt_input_to_encoder);
303 adapt_input_to_cpu_usage.SetFrom(change.adapt_input_to_cpu_usage);
henrike@webrtc.org28654cb2013-07-22 21:07:49 +0000304 adapt_cpu_with_smoothing.SetFrom(change.adapt_cpu_with_smoothing);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000305 adapt_view_switch.SetFrom(change.adapt_view_switch);
wu@webrtc.orgcadf9042013-08-30 21:24:16 +0000306 video_adapt_third.SetFrom(change.video_adapt_third);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000307 video_noise_reduction.SetFrom(change.video_noise_reduction);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000308 video_one_layer_screencast.SetFrom(change.video_one_layer_screencast);
309 video_high_bitrate.SetFrom(change.video_high_bitrate);
wu@webrtc.org1e6cb2c2014-03-24 17:01:50 +0000310 video_start_bitrate.SetFrom(change.video_start_bitrate);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000311 video_temporal_layer_screencast.SetFrom(
312 change.video_temporal_layer_screencast);
wu@webrtc.org97077a32013-10-25 21:18:33 +0000313 video_temporal_layer_realtime.SetFrom(
314 change.video_temporal_layer_realtime);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000315 video_leaky_bucket.SetFrom(change.video_leaky_bucket);
henrike@webrtc.orgf45a5502014-03-13 18:51:34 +0000316 video_highest_bitrate.SetFrom(change.video_highest_bitrate);
wu@webrtc.orgcadf9042013-08-30 21:24:16 +0000317 cpu_overuse_detection.SetFrom(change.cpu_overuse_detection);
henrike@webrtc.orge9793ab2014-03-18 14:36:23 +0000318 cpu_underuse_threshold.SetFrom(change.cpu_underuse_threshold);
319 cpu_overuse_threshold.SetFrom(change.cpu_overuse_threshold);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000320 conference_mode.SetFrom(change.conference_mode);
321 process_adaptation_threshhold.SetFrom(change.process_adaptation_threshhold);
322 system_low_adaptation_threshhold.SetFrom(
323 change.system_low_adaptation_threshhold);
324 system_high_adaptation_threshhold.SetFrom(
325 change.system_high_adaptation_threshhold);
326 buffered_mode_latency.SetFrom(change.buffered_mode_latency);
wu@webrtc.orgcecfd182013-10-30 05:18:12 +0000327 lower_min_bitrate.SetFrom(change.lower_min_bitrate);
wu@webrtc.orgde305012013-10-31 15:40:38 +0000328 dscp.SetFrom(change.dscp);
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000329 suspend_below_min_bitrate.SetFrom(change.suspend_below_min_bitrate);
henrike@webrtc.org704bf9e2014-02-27 17:52:04 +0000330 unsignalled_recv_stream_limit.SetFrom(change.unsignalled_recv_stream_limit);
henrike@webrtc.org10bd88e2014-03-11 21:07:25 +0000331 use_simulcast_adapter.SetFrom(change.use_simulcast_adapter);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000332 }
333
334 bool operator==(const VideoOptions& o) const {
335 return adapt_input_to_encoder == o.adapt_input_to_encoder &&
336 adapt_input_to_cpu_usage == o.adapt_input_to_cpu_usage &&
henrike@webrtc.org28654cb2013-07-22 21:07:49 +0000337 adapt_cpu_with_smoothing == o.adapt_cpu_with_smoothing &&
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000338 adapt_view_switch == o.adapt_view_switch &&
wu@webrtc.orgcadf9042013-08-30 21:24:16 +0000339 video_adapt_third == o.video_adapt_third &&
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000340 video_noise_reduction == o.video_noise_reduction &&
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000341 video_one_layer_screencast == o.video_one_layer_screencast &&
342 video_high_bitrate == o.video_high_bitrate &&
wu@webrtc.org1e6cb2c2014-03-24 17:01:50 +0000343 video_start_bitrate == o.video_start_bitrate &&
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000344 video_temporal_layer_screencast == o.video_temporal_layer_screencast &&
wu@webrtc.org97077a32013-10-25 21:18:33 +0000345 video_temporal_layer_realtime == o.video_temporal_layer_realtime &&
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000346 video_leaky_bucket == o.video_leaky_bucket &&
henrike@webrtc.orgf45a5502014-03-13 18:51:34 +0000347 video_highest_bitrate == o.video_highest_bitrate &&
wu@webrtc.orgcadf9042013-08-30 21:24:16 +0000348 cpu_overuse_detection == o.cpu_overuse_detection &&
henrike@webrtc.orge9793ab2014-03-18 14:36:23 +0000349 cpu_underuse_threshold == o.cpu_underuse_threshold &&
350 cpu_overuse_threshold == o.cpu_overuse_threshold &&
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000351 conference_mode == o.conference_mode &&
352 process_adaptation_threshhold == o.process_adaptation_threshhold &&
353 system_low_adaptation_threshhold ==
354 o.system_low_adaptation_threshhold &&
355 system_high_adaptation_threshhold ==
356 o.system_high_adaptation_threshhold &&
wu@webrtc.orgcecfd182013-10-30 05:18:12 +0000357 buffered_mode_latency == o.buffered_mode_latency &&
wu@webrtc.orgde305012013-10-31 15:40:38 +0000358 lower_min_bitrate == o.lower_min_bitrate &&
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000359 dscp == o.dscp &&
henrike@webrtc.org704bf9e2014-02-27 17:52:04 +0000360 suspend_below_min_bitrate == o.suspend_below_min_bitrate &&
henrike@webrtc.org10bd88e2014-03-11 21:07:25 +0000361 unsignalled_recv_stream_limit == o.unsignalled_recv_stream_limit &&
362 use_simulcast_adapter == o.use_simulcast_adapter;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000363 }
364
365 std::string ToString() const {
366 std::ostringstream ost;
367 ost << "VideoOptions {";
368 ost << ToStringIfSet("encoder adaption", adapt_input_to_encoder);
369 ost << ToStringIfSet("cpu adaption", adapt_input_to_cpu_usage);
henrike@webrtc.org28654cb2013-07-22 21:07:49 +0000370 ost << ToStringIfSet("cpu adaptation smoothing", adapt_cpu_with_smoothing);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000371 ost << ToStringIfSet("adapt view switch", adapt_view_switch);
wu@webrtc.orgcadf9042013-08-30 21:24:16 +0000372 ost << ToStringIfSet("video adapt third", video_adapt_third);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000373 ost << ToStringIfSet("noise reduction", video_noise_reduction);
wu@webrtc.orgcadf9042013-08-30 21:24:16 +0000374 ost << ToStringIfSet("1 layer screencast", video_one_layer_screencast);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000375 ost << ToStringIfSet("high bitrate", video_high_bitrate);
wu@webrtc.org1e6cb2c2014-03-24 17:01:50 +0000376 ost << ToStringIfSet("start bitrate", video_start_bitrate);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000377 ost << ToStringIfSet("video temporal layer screencast",
378 video_temporal_layer_screencast);
wu@webrtc.org97077a32013-10-25 21:18:33 +0000379 ost << ToStringIfSet("video temporal layer realtime",
380 video_temporal_layer_realtime);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000381 ost << ToStringIfSet("leaky bucket", video_leaky_bucket);
henrike@webrtc.orgf45a5502014-03-13 18:51:34 +0000382 ost << ToStringIfSet("highest video bitrate", video_highest_bitrate);
wu@webrtc.orgcadf9042013-08-30 21:24:16 +0000383 ost << ToStringIfSet("cpu overuse detection", cpu_overuse_detection);
henrike@webrtc.orge9793ab2014-03-18 14:36:23 +0000384 ost << ToStringIfSet("cpu underuse threshold", cpu_underuse_threshold);
385 ost << ToStringIfSet("cpu overuse threshold", cpu_overuse_threshold);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000386 ost << ToStringIfSet("conference mode", conference_mode);
387 ost << ToStringIfSet("process", process_adaptation_threshhold);
388 ost << ToStringIfSet("low", system_low_adaptation_threshhold);
389 ost << ToStringIfSet("high", system_high_adaptation_threshhold);
390 ost << ToStringIfSet("buffered mode latency", buffered_mode_latency);
wu@webrtc.orgcecfd182013-10-30 05:18:12 +0000391 ost << ToStringIfSet("lower min bitrate", lower_min_bitrate);
wu@webrtc.orgde305012013-10-31 15:40:38 +0000392 ost << ToStringIfSet("dscp", dscp);
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000393 ost << ToStringIfSet("suspend below min bitrate",
394 suspend_below_min_bitrate);
henrike@webrtc.org704bf9e2014-02-27 17:52:04 +0000395 ost << ToStringIfSet("num channels for early receive",
396 unsignalled_recv_stream_limit);
henrike@webrtc.org10bd88e2014-03-11 21:07:25 +0000397 ost << ToStringIfSet("use simulcast adapter", use_simulcast_adapter);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000398 ost << "}";
399 return ost.str();
400 }
401
402 // Encoder adaption, which is the gd callback in LMI, and TBA in WebRTC.
403 Settable<bool> adapt_input_to_encoder;
404 // Enable CPU adaptation?
405 Settable<bool> adapt_input_to_cpu_usage;
henrike@webrtc.org28654cb2013-07-22 21:07:49 +0000406 // Enable CPU adaptation smoothing?
407 Settable<bool> adapt_cpu_with_smoothing;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000408 // Enable Adapt View Switch?
409 Settable<bool> adapt_view_switch;
wu@webrtc.orgcadf9042013-08-30 21:24:16 +0000410 // Enable video adapt third?
411 Settable<bool> video_adapt_third;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000412 // Enable denoising?
413 Settable<bool> video_noise_reduction;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000414 // Experimental: Enable one layer screencast?
415 Settable<bool> video_one_layer_screencast;
416 // Experimental: Enable WebRtc higher bitrate?
417 Settable<bool> video_high_bitrate;
wu@webrtc.org1e6cb2c2014-03-24 17:01:50 +0000418 // Experimental: Enable WebRtc higher start bitrate?
419 Settable<int> video_start_bitrate;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000420 // Experimental: Enable WebRTC layered screencast.
421 Settable<bool> video_temporal_layer_screencast;
wu@webrtc.org97077a32013-10-25 21:18:33 +0000422 // Experimental: Enable WebRTC temporal layer strategy for realtime video.
423 Settable<bool> video_temporal_layer_realtime;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000424 // Enable WebRTC leaky bucket when sending media packets.
425 Settable<bool> video_leaky_bucket;
henrike@webrtc.orgf45a5502014-03-13 18:51:34 +0000426 // Set highest bitrate mode for video.
427 Settable<int> video_highest_bitrate;
wu@webrtc.orgcadf9042013-08-30 21:24:16 +0000428 // Enable WebRTC Cpu Overuse Detection, which is a new version of the CPU
429 // adaptation algorithm. So this option will override the
430 // |adapt_input_to_cpu_usage|.
431 Settable<bool> cpu_overuse_detection;
henrike@webrtc.orge9793ab2014-03-18 14:36:23 +0000432 // Low threshold for cpu overuse adaptation in ms. (Adapt up)
433 Settable<int> cpu_underuse_threshold;
434 // High threshold for cpu overuse adaptation in ms. (Adapt down)
435 Settable<int> cpu_overuse_threshold;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000436 // Use conference mode?
437 Settable<bool> conference_mode;
438 // Threshhold for process cpu adaptation. (Process limit)
439 SettablePercent process_adaptation_threshhold;
440 // Low threshhold for cpu adaptation. (Adapt up)
441 SettablePercent system_low_adaptation_threshhold;
442 // High threshhold for cpu adaptation. (Adapt down)
443 SettablePercent system_high_adaptation_threshhold;
444 // Specify buffered mode latency in milliseconds.
445 Settable<int> buffered_mode_latency;
wu@webrtc.orgcecfd182013-10-30 05:18:12 +0000446 // Make minimum configured send bitrate even lower than usual, at 30kbit.
447 Settable<bool> lower_min_bitrate;
wu@webrtc.orgde305012013-10-31 15:40:38 +0000448 // Set DSCP value for packet sent from video channel.
449 Settable<bool> dscp;
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000450 // Enable WebRTC suspension of video. No video frames will be sent when the
451 // bitrate is below the configured minimum bitrate.
452 Settable<bool> suspend_below_min_bitrate;
henrike@webrtc.org704bf9e2014-02-27 17:52:04 +0000453 // Limit on the number of early receive channels that can be created.
454 Settable<int> unsignalled_recv_stream_limit;
henrike@webrtc.org10bd88e2014-03-11 21:07:25 +0000455 // Enable use of simulcast adapter.
456 Settable<bool> use_simulcast_adapter;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000457};
458
459// A class for playing out soundclips.
460class SoundclipMedia {
461 public:
462 enum SoundclipFlags {
463 SF_LOOP = 1,
464 };
465
466 virtual ~SoundclipMedia() {}
467
468 // Plays a sound out to the speakers with the given audio stream. The stream
469 // must be 16-bit little-endian 16 kHz PCM. If a stream is already playing
470 // on this SoundclipMedia, it is stopped. If clip is NULL, nothing is played.
471 // Returns whether it was successful.
472 virtual bool PlaySound(const char *clip, int len, int flags) = 0;
473};
474
475struct RtpHeaderExtension {
476 RtpHeaderExtension() : id(0) {}
477 RtpHeaderExtension(const std::string& u, int i) : uri(u), id(i) {}
478 std::string uri;
479 int id;
480 // TODO(juberti): SendRecv direction;
481
482 bool operator==(const RtpHeaderExtension& ext) const {
483 // id is a reserved word in objective-c. Therefore the id attribute has to
484 // be a fully qualified name in order to compile on IOS.
485 return this->id == ext.id &&
486 uri == ext.uri;
487 }
488};
489
490// Returns the named header extension if found among all extensions, NULL
491// otherwise.
492inline const RtpHeaderExtension* FindHeaderExtension(
493 const std::vector<RtpHeaderExtension>& extensions,
494 const std::string& name) {
495 for (std::vector<RtpHeaderExtension>::const_iterator it = extensions.begin();
496 it != extensions.end(); ++it) {
497 if (it->uri == name)
498 return &(*it);
499 }
500 return NULL;
501}
502
503enum MediaChannelOptions {
504 // Tune the stream for conference mode.
505 OPT_CONFERENCE = 0x0001
506};
507
508enum VoiceMediaChannelOptions {
509 // Tune the audio stream for vcs with different target levels.
510 OPT_AGC_MINUS_10DB = 0x80000000
511};
512
513// DTMF flags to control if a DTMF tone should be played and/or sent.
514enum DtmfFlags {
515 DF_PLAY = 0x01,
516 DF_SEND = 0x02,
517};
518
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000519class MediaChannel : public sigslot::has_slots<> {
520 public:
521 class NetworkInterface {
522 public:
523 enum SocketType { ST_RTP, ST_RTCP };
mallinath@webrtc.org1112c302013-09-23 20:34:45 +0000524 virtual bool SendPacket(
525 talk_base::Buffer* packet,
526 talk_base::DiffServCodePoint dscp = talk_base::DSCP_NO_CHANGE) = 0;
527 virtual bool SendRtcp(
528 talk_base::Buffer* packet,
529 talk_base::DiffServCodePoint dscp = talk_base::DSCP_NO_CHANGE) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000530 virtual int SetOption(SocketType type, talk_base::Socket::Option opt,
531 int option) = 0;
532 virtual ~NetworkInterface() {}
533 };
534
535 MediaChannel() : network_interface_(NULL) {}
536 virtual ~MediaChannel() {}
537
henrike@webrtc.org1e09a712013-07-26 19:17:59 +0000538 // Sets the abstract interface class for sending RTP/RTCP data.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000539 virtual void SetInterface(NetworkInterface *iface) {
henrike@webrtc.org1e09a712013-07-26 19:17:59 +0000540 talk_base::CritScope cs(&network_interface_crit_);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000541 network_interface_ = iface;
542 }
543
544 // Called when a RTP packet is received.
wu@webrtc.orga9890802013-12-13 00:21:03 +0000545 virtual void OnPacketReceived(talk_base::Buffer* packet,
546 const talk_base::PacketTime& packet_time) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000547 // Called when a RTCP packet is received.
wu@webrtc.orga9890802013-12-13 00:21:03 +0000548 virtual void OnRtcpReceived(talk_base::Buffer* packet,
549 const talk_base::PacketTime& packet_time) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000550 // Called when the socket's ability to send has changed.
551 virtual void OnReadyToSend(bool ready) = 0;
552 // Creates a new outgoing media stream with SSRCs and CNAME as described
553 // by sp.
554 virtual bool AddSendStream(const StreamParams& sp) = 0;
555 // Removes an outgoing media stream.
556 // ssrc must be the first SSRC of the media stream if the stream uses
557 // multiple SSRCs.
558 virtual bool RemoveSendStream(uint32 ssrc) = 0;
559 // Creates a new incoming media stream with SSRCs and CNAME as described
560 // by sp.
561 virtual bool AddRecvStream(const StreamParams& sp) = 0;
562 // Removes an incoming media stream.
563 // ssrc must be the first SSRC of the media stream if the stream uses
564 // multiple SSRCs.
565 virtual bool RemoveRecvStream(uint32 ssrc) = 0;
566
567 // Mutes the channel.
568 virtual bool MuteStream(uint32 ssrc, bool on) = 0;
569
570 // Sets the RTP extension headers and IDs to use when sending RTP.
571 virtual bool SetRecvRtpHeaderExtensions(
572 const std::vector<RtpHeaderExtension>& extensions) = 0;
573 virtual bool SetSendRtpHeaderExtensions(
574 const std::vector<RtpHeaderExtension>& extensions) = 0;
mallinath@webrtc.org92fdfeb2014-02-17 18:49:41 +0000575 // Returns the absoulte sendtime extension id value from media channel.
576 virtual int GetRtpSendTimeExtnId() const {
577 return -1;
578 }
sergeyu@chromium.org4b26e2e2014-01-15 23:15:54 +0000579 // Sets the initial bandwidth to use when sending starts.
580 virtual bool SetStartSendBandwidth(int bps) = 0;
581 // Sets the maximum allowed bandwidth to use when sending data.
582 virtual bool SetMaxSendBandwidth(int bps) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000583
henrike@webrtc.org1e09a712013-07-26 19:17:59 +0000584 // Base method to send packet using NetworkInterface.
585 bool SendPacket(talk_base::Buffer* packet) {
586 return DoSendPacket(packet, false);
587 }
588
589 bool SendRtcp(talk_base::Buffer* packet) {
590 return DoSendPacket(packet, true);
591 }
592
593 int SetOption(NetworkInterface::SocketType type,
594 talk_base::Socket::Option opt,
595 int option) {
596 talk_base::CritScope cs(&network_interface_crit_);
597 if (!network_interface_)
598 return -1;
599
600 return network_interface_->SetOption(type, opt, option);
601 }
602
wu@webrtc.orgde305012013-10-31 15:40:38 +0000603 protected:
604 // This method sets DSCP |value| on both RTP and RTCP channels.
605 int SetDscp(talk_base::DiffServCodePoint value) {
606 int ret;
607 ret = SetOption(NetworkInterface::ST_RTP,
608 talk_base::Socket::OPT_DSCP,
609 value);
610 if (ret == 0) {
611 ret = SetOption(NetworkInterface::ST_RTCP,
612 talk_base::Socket::OPT_DSCP,
613 value);
614 }
615 return ret;
616 }
617
henrike@webrtc.org1e09a712013-07-26 19:17:59 +0000618 private:
619 bool DoSendPacket(talk_base::Buffer* packet, bool rtcp) {
620 talk_base::CritScope cs(&network_interface_crit_);
621 if (!network_interface_)
622 return false;
623
624 return (!rtcp) ? network_interface_->SendPacket(packet) :
625 network_interface_->SendRtcp(packet);
626 }
627
628 // |network_interface_| can be accessed from the worker_thread and
629 // from any MediaEngine threads. This critical section is to protect accessing
630 // of network_interface_ object.
631 talk_base::CriticalSection network_interface_crit_;
632 NetworkInterface* network_interface_;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000633};
634
635enum SendFlags {
636 SEND_NOTHING,
637 SEND_RINGBACKTONE,
638 SEND_MICROPHONE
639};
640
wu@webrtc.org97077a32013-10-25 21:18:33 +0000641// The stats information is structured as follows:
642// Media are represented by either MediaSenderInfo or MediaReceiverInfo.
643// Media contains a vector of SSRC infos that are exclusively used by this
644// media. (SSRCs shared between media streams can't be represented.)
645
646// Information about an SSRC.
647// This data may be locally recorded, or received in an RTCP SR or RR.
648struct SsrcSenderInfo {
649 SsrcSenderInfo()
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000650 : ssrc(0),
wu@webrtc.org97077a32013-10-25 21:18:33 +0000651 timestamp(0) {
652 }
653 uint32 ssrc;
654 double timestamp; // NTP timestamp, represented as seconds since epoch.
655};
656
657struct SsrcReceiverInfo {
658 SsrcReceiverInfo()
659 : ssrc(0),
660 timestamp(0) {
661 }
662 uint32 ssrc;
663 double timestamp;
664};
665
666struct MediaSenderInfo {
667 MediaSenderInfo()
668 : bytes_sent(0),
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000669 packets_sent(0),
670 packets_lost(0),
671 fraction_lost(0.0),
wu@webrtc.org97077a32013-10-25 21:18:33 +0000672 rtt_ms(0) {
673 }
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000674 void add_ssrc(const SsrcSenderInfo& stat) {
675 local_stats.push_back(stat);
676 }
677 // Temporary utility function for call sites that only provide SSRC.
678 // As more info is added into SsrcSenderInfo, this function should go away.
679 void add_ssrc(uint32 ssrc) {
680 SsrcSenderInfo stat;
681 stat.ssrc = ssrc;
682 add_ssrc(stat);
683 }
684 // Utility accessor for clients that are only interested in ssrc numbers.
685 std::vector<uint32> ssrcs() const {
686 std::vector<uint32> retval;
687 for (std::vector<SsrcSenderInfo>::const_iterator it = local_stats.begin();
688 it != local_stats.end(); ++it) {
689 retval.push_back(it->ssrc);
690 }
691 return retval;
692 }
693 // Utility accessor for clients that make the assumption only one ssrc
694 // exists per media.
695 // This will eventually go away.
696 uint32 ssrc() const {
697 if (local_stats.size() > 0) {
698 return local_stats[0].ssrc;
699 } else {
700 return 0;
701 }
702 }
wu@webrtc.org97077a32013-10-25 21:18:33 +0000703 int64 bytes_sent;
704 int packets_sent;
705 int packets_lost;
706 float fraction_lost;
707 int rtt_ms;
708 std::string codec_name;
709 std::vector<SsrcSenderInfo> local_stats;
710 std::vector<SsrcReceiverInfo> remote_stats;
711};
712
henrike@webrtc.org704bf9e2014-02-27 17:52:04 +0000713template<class T>
714struct VariableInfo {
715 VariableInfo()
716 : min_val(),
717 mean(0.0),
718 max_val(),
719 variance(0.0) {
720 }
721 T min_val;
722 double mean;
723 T max_val;
724 double variance;
725};
726
wu@webrtc.org97077a32013-10-25 21:18:33 +0000727struct MediaReceiverInfo {
728 MediaReceiverInfo()
729 : bytes_rcvd(0),
730 packets_rcvd(0),
731 packets_lost(0),
732 fraction_lost(0.0) {
733 }
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000734 void add_ssrc(const SsrcReceiverInfo& stat) {
735 local_stats.push_back(stat);
736 }
737 // Temporary utility function for call sites that only provide SSRC.
738 // As more info is added into SsrcSenderInfo, this function should go away.
739 void add_ssrc(uint32 ssrc) {
740 SsrcReceiverInfo stat;
741 stat.ssrc = ssrc;
742 add_ssrc(stat);
743 }
744 std::vector<uint32> ssrcs() const {
745 std::vector<uint32> retval;
746 for (std::vector<SsrcReceiverInfo>::const_iterator it = local_stats.begin();
747 it != local_stats.end(); ++it) {
748 retval.push_back(it->ssrc);
749 }
750 return retval;
751 }
752 // Utility accessor for clients that make the assumption only one ssrc
753 // exists per media.
754 // This will eventually go away.
755 uint32 ssrc() const {
756 if (local_stats.size() > 0) {
757 return local_stats[0].ssrc;
758 } else {
759 return 0;
760 }
761 }
762
wu@webrtc.org97077a32013-10-25 21:18:33 +0000763 int64 bytes_rcvd;
764 int packets_rcvd;
765 int packets_lost;
766 float fraction_lost;
767 std::vector<SsrcReceiverInfo> local_stats;
768 std::vector<SsrcSenderInfo> remote_stats;
769};
770
771struct VoiceSenderInfo : public MediaSenderInfo {
772 VoiceSenderInfo()
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000773 : ext_seqnum(0),
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000774 jitter_ms(0),
775 audio_level(0),
776 aec_quality_min(0.0),
777 echo_delay_median_ms(0),
778 echo_delay_std_ms(0),
779 echo_return_loss(0),
wu@webrtc.org967bfff2013-09-19 05:49:50 +0000780 echo_return_loss_enhancement(0),
781 typing_noise_detected(false) {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000782 }
783
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000784 int ext_seqnum;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000785 int jitter_ms;
786 int audio_level;
787 float aec_quality_min;
788 int echo_delay_median_ms;
789 int echo_delay_std_ms;
790 int echo_return_loss;
791 int echo_return_loss_enhancement;
wu@webrtc.org967bfff2013-09-19 05:49:50 +0000792 bool typing_noise_detected;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000793};
794
wu@webrtc.org97077a32013-10-25 21:18:33 +0000795struct VoiceReceiverInfo : public MediaReceiverInfo {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000796 VoiceReceiverInfo()
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000797 : ext_seqnum(0),
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000798 jitter_ms(0),
799 jitter_buffer_ms(0),
800 jitter_buffer_preferred_ms(0),
801 delay_estimate_ms(0),
802 audio_level(0),
henrike@webrtc.orgb8c254a2014-02-14 23:38:45 +0000803 expand_rate(0),
804 decoding_calls_to_silence_generator(0),
805 decoding_calls_to_neteq(0),
806 decoding_normal(0),
807 decoding_plc(0),
808 decoding_cng(0),
809 decoding_plc_cng(0) {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000810 }
811
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000812 int ext_seqnum;
813 int jitter_ms;
814 int jitter_buffer_ms;
815 int jitter_buffer_preferred_ms;
816 int delay_estimate_ms;
817 int audio_level;
818 // fraction of synthesized speech inserted through pre-emptive expansion
819 float expand_rate;
henrike@webrtc.orgb8c254a2014-02-14 23:38:45 +0000820 int decoding_calls_to_silence_generator;
821 int decoding_calls_to_neteq;
822 int decoding_normal;
823 int decoding_plc;
824 int decoding_cng;
825 int decoding_plc_cng;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000826};
827
wu@webrtc.org97077a32013-10-25 21:18:33 +0000828struct VideoSenderInfo : public MediaSenderInfo {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000829 VideoSenderInfo()
wu@webrtc.org97077a32013-10-25 21:18:33 +0000830 : packets_cached(0),
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000831 firs_rcvd(0),
henrike@webrtc.org704bf9e2014-02-27 17:52:04 +0000832 plis_rcvd(0),
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000833 nacks_rcvd(0),
sergeyu@chromium.org9cf037b2014-02-07 19:03:26 +0000834 input_frame_width(0),
835 input_frame_height(0),
836 send_frame_width(0),
837 send_frame_height(0),
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000838 framerate_input(0),
839 framerate_sent(0),
840 nominal_bitrate(0),
841 preferred_bitrate(0),
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000842 adapt_reason(0),
843 capture_jitter_ms(0),
wu@webrtc.org9caf2762013-12-11 18:25:07 +0000844 avg_encode_ms(0),
845 encode_usage_percent(0),
846 capture_queue_delay_ms_per_s(0) {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000847 }
848
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000849 std::vector<SsrcGroup> ssrc_groups;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000850 int packets_cached;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000851 int firs_rcvd;
henrike@webrtc.org704bf9e2014-02-27 17:52:04 +0000852 int plis_rcvd;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000853 int nacks_rcvd;
sergeyu@chromium.org9cf037b2014-02-07 19:03:26 +0000854 int input_frame_width;
855 int input_frame_height;
856 int send_frame_width;
857 int send_frame_height;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000858 int framerate_input;
859 int framerate_sent;
860 int nominal_bitrate;
861 int preferred_bitrate;
862 int adapt_reason;
sergeyu@chromium.org5bc25c42013-12-05 00:24:06 +0000863 int capture_jitter_ms;
864 int avg_encode_ms;
wu@webrtc.org9caf2762013-12-11 18:25:07 +0000865 int encode_usage_percent;
866 int capture_queue_delay_ms_per_s;
henrike@webrtc.org704bf9e2014-02-27 17:52:04 +0000867 VariableInfo<int> adapt_frame_drops;
868 VariableInfo<int> effects_frame_drops;
869 VariableInfo<double> capturer_frame_time;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000870};
871
wu@webrtc.org97077a32013-10-25 21:18:33 +0000872struct VideoReceiverInfo : public MediaReceiverInfo {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000873 VideoReceiverInfo()
wu@webrtc.org97077a32013-10-25 21:18:33 +0000874 : packets_concealed(0),
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000875 firs_sent(0),
henrike@webrtc.org704bf9e2014-02-27 17:52:04 +0000876 plis_sent(0),
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000877 nacks_sent(0),
878 frame_width(0),
879 frame_height(0),
880 framerate_rcvd(0),
881 framerate_decoded(0),
882 framerate_output(0),
883 framerate_render_input(0),
wu@webrtc.org97077a32013-10-25 21:18:33 +0000884 framerate_render_output(0),
885 decode_ms(0),
886 max_decode_ms(0),
887 jitter_buffer_ms(0),
888 min_playout_delay_ms(0),
889 render_delay_ms(0),
890 target_delay_ms(0),
891 current_delay_ms(0) {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000892 }
893
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000894 std::vector<SsrcGroup> ssrc_groups;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000895 int packets_concealed;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000896 int firs_sent;
henrike@webrtc.org704bf9e2014-02-27 17:52:04 +0000897 int plis_sent;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000898 int nacks_sent;
899 int frame_width;
900 int frame_height;
901 int framerate_rcvd;
902 int framerate_decoded;
903 int framerate_output;
904 // Framerate as sent to the renderer.
905 int framerate_render_input;
906 // Framerate that the renderer reports.
907 int framerate_render_output;
wu@webrtc.org97077a32013-10-25 21:18:33 +0000908
909 // All stats below are gathered per-VideoReceiver, but some will be correlated
910 // across MediaStreamTracks. NOTE(hta): when sinking stats into per-SSRC
911 // structures, reflect this in the new layout.
912
913 // Current frame decode latency.
914 int decode_ms;
915 // Maximum observed frame decode latency.
916 int max_decode_ms;
917 // Jitter (network-related) latency.
918 int jitter_buffer_ms;
919 // Requested minimum playout latency.
920 int min_playout_delay_ms;
921 // Requested latency to account for rendering delay.
922 int render_delay_ms;
923 // Target overall delay: network+decode+render, accounting for
924 // min_playout_delay_ms.
925 int target_delay_ms;
926 // Current overall delay, possibly ramping towards target_delay_ms.
927 int current_delay_ms;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000928};
929
wu@webrtc.org97077a32013-10-25 21:18:33 +0000930struct DataSenderInfo : public MediaSenderInfo {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000931 DataSenderInfo()
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
wu@webrtc.org97077a32013-10-25 21:18:33 +0000938struct DataReceiverInfo : public MediaReceiverInfo {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000939 DataReceiverInfo()
wu@webrtc.org97077a32013-10-25 21:18:33 +0000940 : ssrc(0) {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000941 }
942
943 uint32 ssrc;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000944};
945
946struct BandwidthEstimationInfo {
947 BandwidthEstimationInfo()
948 : available_send_bandwidth(0),
949 available_recv_bandwidth(0),
950 target_enc_bitrate(0),
951 actual_enc_bitrate(0),
952 retransmit_bitrate(0),
953 transmit_bitrate(0),
wu@webrtc.orgb9a088b2014-02-13 23:18:49 +0000954 bucket_delay(0),
955 total_received_propagation_delta_ms(0) {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000956 }
957
958 int available_send_bandwidth;
959 int available_recv_bandwidth;
960 int target_enc_bitrate;
961 int actual_enc_bitrate;
962 int retransmit_bitrate;
963 int transmit_bitrate;
964 int bucket_delay;
wu@webrtc.orgb9a088b2014-02-13 23:18:49 +0000965 // The following stats are only valid when
966 // StatsOptions::include_received_propagation_stats is true.
967 int total_received_propagation_delta_ms;
968 std::vector<int> recent_received_propagation_delta_ms;
969 std::vector<int64> recent_received_packet_group_arrival_time_ms;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000970};
971
972struct VoiceMediaInfo {
973 void Clear() {
974 senders.clear();
975 receivers.clear();
976 }
977 std::vector<VoiceSenderInfo> senders;
978 std::vector<VoiceReceiverInfo> receivers;
979};
980
981struct VideoMediaInfo {
982 void Clear() {
983 senders.clear();
984 receivers.clear();
985 bw_estimations.clear();
986 }
987 std::vector<VideoSenderInfo> senders;
988 std::vector<VideoReceiverInfo> receivers;
989 std::vector<BandwidthEstimationInfo> bw_estimations;
990};
991
992struct DataMediaInfo {
993 void Clear() {
994 senders.clear();
995 receivers.clear();
996 }
997 std::vector<DataSenderInfo> senders;
998 std::vector<DataReceiverInfo> receivers;
999};
1000
wu@webrtc.orgb9a088b2014-02-13 23:18:49 +00001001struct StatsOptions {
1002 StatsOptions() : include_received_propagation_stats(false) {}
1003
1004 bool include_received_propagation_stats;
1005};
1006
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001007class VoiceMediaChannel : public MediaChannel {
1008 public:
1009 enum Error {
1010 ERROR_NONE = 0, // No error.
1011 ERROR_OTHER, // Other errors.
1012 ERROR_REC_DEVICE_OPEN_FAILED = 100, // Could not open mic.
1013 ERROR_REC_DEVICE_MUTED, // Mic was muted by OS.
1014 ERROR_REC_DEVICE_SILENT, // No background noise picked up.
1015 ERROR_REC_DEVICE_SATURATION, // Mic input is clipping.
1016 ERROR_REC_DEVICE_REMOVED, // Mic was removed while active.
1017 ERROR_REC_RUNTIME_ERROR, // Processing is encountering errors.
1018 ERROR_REC_SRTP_ERROR, // Generic SRTP failure.
1019 ERROR_REC_SRTP_AUTH_FAILED, // Failed to authenticate packets.
1020 ERROR_REC_TYPING_NOISE_DETECTED, // Typing noise is detected.
1021 ERROR_PLAY_DEVICE_OPEN_FAILED = 200, // Could not open playout.
1022 ERROR_PLAY_DEVICE_MUTED, // Playout muted by OS.
1023 ERROR_PLAY_DEVICE_REMOVED, // Playout removed while active.
1024 ERROR_PLAY_RUNTIME_ERROR, // Errors in voice processing.
1025 ERROR_PLAY_SRTP_ERROR, // Generic SRTP failure.
1026 ERROR_PLAY_SRTP_AUTH_FAILED, // Failed to authenticate packets.
1027 ERROR_PLAY_SRTP_REPLAY, // Packet replay detected.
1028 };
1029
1030 VoiceMediaChannel() {}
1031 virtual ~VoiceMediaChannel() {}
1032 // Sets the codecs/payload types to be used for incoming media.
1033 virtual bool SetRecvCodecs(const std::vector<AudioCodec>& codecs) = 0;
1034 // Sets the codecs/payload types to be used for outgoing media.
1035 virtual bool SetSendCodecs(const std::vector<AudioCodec>& codecs) = 0;
1036 // Starts or stops playout of received audio.
1037 virtual bool SetPlayout(bool playout) = 0;
1038 // Starts or stops sending (and potentially capture) of local audio.
1039 virtual bool SetSend(SendFlags flag) = 0;
henrike@webrtc.org1e09a712013-07-26 19:17:59 +00001040 // Sets the renderer object to be used for the specified remote audio stream.
1041 virtual bool SetRemoteRenderer(uint32 ssrc, AudioRenderer* renderer) = 0;
1042 // Sets the renderer object to be used for the specified local audio stream.
1043 virtual bool SetLocalRenderer(uint32 ssrc, AudioRenderer* renderer) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001044 // Gets current energy levels for all incoming streams.
1045 virtual bool GetActiveStreams(AudioInfo::StreamList* actives) = 0;
1046 // Get the current energy level of the stream sent to the speaker.
1047 virtual int GetOutputLevel() = 0;
1048 // Get the time in milliseconds since last recorded keystroke, or negative.
1049 virtual int GetTimeSinceLastTyping() = 0;
1050 // Temporarily exposed field for tuning typing detect options.
1051 virtual void SetTypingDetectionParameters(int time_window,
1052 int cost_per_typing, int reporting_threshold, int penalty_decay,
1053 int type_event_delay) = 0;
1054 // Set left and right scale for speaker output volume of the specified ssrc.
1055 virtual bool SetOutputScaling(uint32 ssrc, double left, double right) = 0;
1056 // Get left and right scale for speaker output volume of the specified ssrc.
1057 virtual bool GetOutputScaling(uint32 ssrc, double* left, double* right) = 0;
1058 // Specifies a ringback tone to be played during call setup.
1059 virtual bool SetRingbackTone(const char *buf, int len) = 0;
1060 // Plays or stops the aforementioned ringback tone
1061 virtual bool PlayRingbackTone(uint32 ssrc, bool play, bool loop) = 0;
1062 // Returns if the telephone-event has been negotiated.
1063 virtual bool CanInsertDtmf() { return false; }
1064 // Send and/or play a DTMF |event| according to the |flags|.
1065 // The DTMF out-of-band signal will be used on sending.
1066 // The |ssrc| should be either 0 or a valid send stream ssrc.
henrike@webrtc.org9de257d2013-07-17 14:42:53 +00001067 // The valid value for the |event| are 0 to 15 which corresponding to
1068 // DTMF event 0-9, *, #, A-D.
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001069 virtual bool InsertDtmf(uint32 ssrc, int event, int duration, int flags) = 0;
1070 // Gets quality stats for the channel.
1071 virtual bool GetStats(VoiceMediaInfo* info) = 0;
1072 // Gets last reported error for this media channel.
1073 virtual void GetLastMediaError(uint32* ssrc,
1074 VoiceMediaChannel::Error* error) {
1075 ASSERT(error != NULL);
1076 *error = ERROR_NONE;
1077 }
1078 // Sets the media options to use.
1079 virtual bool SetOptions(const AudioOptions& options) = 0;
1080 virtual bool GetOptions(AudioOptions* options) const = 0;
1081
1082 // Signal errors from MediaChannel. Arguments are:
1083 // ssrc(uint32), and error(VoiceMediaChannel::Error).
1084 sigslot::signal2<uint32, VoiceMediaChannel::Error> SignalMediaError;
1085};
1086
1087class VideoMediaChannel : public MediaChannel {
1088 public:
1089 enum Error {
1090 ERROR_NONE = 0, // No error.
1091 ERROR_OTHER, // Other errors.
1092 ERROR_REC_DEVICE_OPEN_FAILED = 100, // Could not open camera.
1093 ERROR_REC_DEVICE_NO_DEVICE, // No camera.
1094 ERROR_REC_DEVICE_IN_USE, // Device is in already use.
1095 ERROR_REC_DEVICE_REMOVED, // Device is removed.
1096 ERROR_REC_SRTP_ERROR, // Generic sender SRTP failure.
1097 ERROR_REC_SRTP_AUTH_FAILED, // Failed to authenticate packets.
1098 ERROR_REC_CPU_MAX_CANT_DOWNGRADE, // Can't downgrade capture anymore.
1099 ERROR_PLAY_SRTP_ERROR = 200, // Generic receiver SRTP failure.
1100 ERROR_PLAY_SRTP_AUTH_FAILED, // Failed to authenticate packets.
1101 ERROR_PLAY_SRTP_REPLAY, // Packet replay detected.
1102 };
1103
1104 VideoMediaChannel() : renderer_(NULL) {}
1105 virtual ~VideoMediaChannel() {}
1106 // Sets the codecs/payload types to be used for incoming media.
1107 virtual bool SetRecvCodecs(const std::vector<VideoCodec>& codecs) = 0;
1108 // Sets the codecs/payload types to be used for outgoing media.
1109 virtual bool SetSendCodecs(const std::vector<VideoCodec>& codecs) = 0;
1110 // Gets the currently set codecs/payload types to be used for outgoing media.
1111 virtual bool GetSendCodec(VideoCodec* send_codec) = 0;
1112 // Sets the format of a specified outgoing stream.
1113 virtual bool SetSendStreamFormat(uint32 ssrc, const VideoFormat& format) = 0;
1114 // Starts or stops playout of received video.
1115 virtual bool SetRender(bool render) = 0;
1116 // Starts or stops transmission (and potentially capture) of local video.
1117 virtual bool SetSend(bool send) = 0;
1118 // Sets the renderer object to be used for the specified stream.
1119 // If SSRC is 0, the renderer is used for the 'default' stream.
1120 virtual bool SetRenderer(uint32 ssrc, VideoRenderer* renderer) = 0;
1121 // If |ssrc| is 0, replace the default capturer (engine capturer) with
1122 // |capturer|. If |ssrc| is non zero create a new stream with |ssrc| as SSRC.
1123 virtual bool SetCapturer(uint32 ssrc, VideoCapturer* capturer) = 0;
1124 // Gets quality stats for the channel.
wu@webrtc.orgb9a088b2014-02-13 23:18:49 +00001125 virtual bool GetStats(const StatsOptions& options, VideoMediaInfo* info) = 0;
1126 // This is needed for MediaMonitor to use the same template for voice, video
1127 // and data MediaChannels.
1128 bool GetStats(VideoMediaInfo* info) {
1129 return GetStats(StatsOptions(), info);
1130 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001131
1132 // Send an intra frame to the receivers.
1133 virtual bool SendIntraFrame() = 0;
1134 // Reuqest each of the remote senders to send an intra frame.
1135 virtual bool RequestIntraFrame() = 0;
1136 // Sets the media options to use.
1137 virtual bool SetOptions(const VideoOptions& options) = 0;
1138 virtual bool GetOptions(VideoOptions* options) const = 0;
1139 virtual void UpdateAspectRatio(int ratio_w, int ratio_h) = 0;
1140
1141 // Signal errors from MediaChannel. Arguments are:
1142 // ssrc(uint32), and error(VideoMediaChannel::Error).
1143 sigslot::signal2<uint32, Error> SignalMediaError;
1144
1145 protected:
1146 VideoRenderer *renderer_;
1147};
1148
1149enum DataMessageType {
mallinath@webrtc.org1112c302013-09-23 20:34:45 +00001150 // Chrome-Internal use only. See SctpDataMediaChannel for the actual PPID
1151 // values.
1152 DMT_NONE = 0,
1153 DMT_CONTROL = 1,
1154 DMT_BINARY = 2,
1155 DMT_TEXT = 3,
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001156};
1157
1158// Info about data received in DataMediaChannel. For use in
1159// DataMediaChannel::SignalDataReceived and in all of the signals that
1160// signal fires, on up the chain.
1161struct ReceiveDataParams {
1162 // The in-packet stream indentifier.
1163 // For SCTP, this is really SID, not SSRC.
1164 uint32 ssrc;
1165 // The type of message (binary, text, or control).
1166 DataMessageType type;
1167 // A per-stream value incremented per packet in the stream.
1168 int seq_num;
1169 // A per-stream value monotonically increasing with time.
1170 int timestamp;
1171
1172 ReceiveDataParams() :
1173 ssrc(0),
1174 type(DMT_TEXT),
1175 seq_num(0),
1176 timestamp(0) {
1177 }
1178};
1179
1180struct SendDataParams {
1181 // The in-packet stream indentifier.
1182 // For SCTP, this is really SID, not SSRC.
1183 uint32 ssrc;
1184 // The type of message (binary, text, or control).
1185 DataMessageType type;
1186
1187 // For SCTP, whether to send messages flagged as ordered or not.
1188 // If false, messages can be received out of order.
1189 bool ordered;
1190 // For SCTP, whether the messages are sent reliably or not.
1191 // If false, messages may be lost.
1192 bool reliable;
1193 // For SCTP, if reliable == false, provide partial reliability by
1194 // resending up to this many times. Either count or millis
1195 // is supported, not both at the same time.
1196 int max_rtx_count;
1197 // For SCTP, if reliable == false, provide partial reliability by
1198 // resending for up to this many milliseconds. Either count or millis
1199 // is supported, not both at the same time.
1200 int max_rtx_ms;
1201
1202 SendDataParams() :
1203 ssrc(0),
1204 type(DMT_TEXT),
1205 // TODO(pthatcher): Make these true by default?
1206 ordered(false),
1207 reliable(false),
1208 max_rtx_count(0),
1209 max_rtx_ms(0) {
1210 }
1211};
1212
1213enum SendDataResult { SDR_SUCCESS, SDR_ERROR, SDR_BLOCK };
1214
1215class DataMediaChannel : public MediaChannel {
1216 public:
1217 enum Error {
1218 ERROR_NONE = 0, // No error.
1219 ERROR_OTHER, // Other errors.
1220 ERROR_SEND_SRTP_ERROR = 200, // Generic SRTP failure.
1221 ERROR_SEND_SRTP_AUTH_FAILED, // Failed to authenticate packets.
1222 ERROR_RECV_SRTP_ERROR, // Generic SRTP failure.
1223 ERROR_RECV_SRTP_AUTH_FAILED, // Failed to authenticate packets.
1224 ERROR_RECV_SRTP_REPLAY, // Packet replay detected.
1225 };
1226
1227 virtual ~DataMediaChannel() {}
1228
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001229 virtual bool SetSendCodecs(const std::vector<DataCodec>& codecs) = 0;
1230 virtual bool SetRecvCodecs(const std::vector<DataCodec>& codecs) = 0;
wu@webrtc.orga9890802013-12-13 00:21:03 +00001231
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001232 virtual bool MuteStream(uint32 ssrc, bool on) { return false; }
1233 // TODO(pthatcher): Implement this.
1234 virtual bool GetStats(DataMediaInfo* info) { return true; }
1235
1236 virtual bool SetSend(bool send) = 0;
1237 virtual bool SetReceive(bool receive) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001238
1239 virtual bool SendData(
1240 const SendDataParams& params,
1241 const talk_base::Buffer& payload,
1242 SendDataResult* result = NULL) = 0;
1243 // Signals when data is received (params, data, len)
1244 sigslot::signal3<const ReceiveDataParams&,
1245 const char*,
1246 size_t> SignalDataReceived;
1247 // Signal errors from MediaChannel. Arguments are:
1248 // ssrc(uint32), and error(DataMediaChannel::Error).
1249 sigslot::signal2<uint32, DataMediaChannel::Error> SignalMediaError;
wu@webrtc.orgd64719d2013-08-01 00:00:07 +00001250 // Signal when the media channel is ready to send the stream. Arguments are:
1251 // writable(bool)
1252 sigslot::signal1<bool> SignalReadyToSend;
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001253};
1254
1255} // namespace cricket
1256
1257#endif // TALK_MEDIA_BASE_MEDIACHANNEL_H_