blob: 65c1278320b1c4e8a7265e1d91edc7f1ea4e57f0 [file] [log] [blame]
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001/*
kjellanderb24317b2016-02-10 07:54:43 -08002 * Copyright 2012 The WebRTC project authors. All Rights Reserved.
henrike@webrtc.org28e20752013-07-10 00:45:36 +00003 *
kjellanderb24317b2016-02-10 07:54:43 -08004 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
henrike@webrtc.org28e20752013-07-10 00:45:36 +00009 */
10
11// This file contains the PeerConnection interface as defined in
12// http://dev.w3.org/2011/webrtc/editor/webrtc.html#peer-to-peer-connections.
henrike@webrtc.org28e20752013-07-10 00:45:36 +000013//
deadbeefb10f32f2017-02-08 01:38:21 -080014// The PeerConnectionFactory class provides factory methods to create
15// PeerConnection, MediaStream and MediaStreamTrack objects.
16//
17// The following steps are needed to setup a typical call using WebRTC:
18//
henrike@webrtc.org28e20752013-07-10 00:45:36 +000019// 1. Create a PeerConnectionFactoryInterface. Check constructors for more
20// information about input parameters.
deadbeefb10f32f2017-02-08 01:38:21 -080021//
22// 2. Create a PeerConnection object. Provide a configuration struct which
23// points to STUN and/or TURN servers used to generate ICE candidates, and
24// provide an object that implements the PeerConnectionObserver interface,
25// which is used to receive callbacks from the PeerConnection.
26//
27// 3. Create local MediaStreamTracks using the PeerConnectionFactory and add
28// them to PeerConnection by calling AddTrack (or legacy method, AddStream).
29//
30// 4. Create an offer, call SetLocalDescription with it, serialize it, and send
31// it to the remote peer
32//
33// 5. Once an ICE candidate has been gathered, the PeerConnection will call the
henrike@webrtc.org28e20752013-07-10 00:45:36 +000034// observer function OnIceCandidate. The candidates must also be serialized and
35// sent to the remote peer.
deadbeefb10f32f2017-02-08 01:38:21 -080036//
henrike@webrtc.org28e20752013-07-10 00:45:36 +000037// 6. Once an answer is received from the remote peer, call
deadbeefb10f32f2017-02-08 01:38:21 -080038// SetRemoteDescription with the remote answer.
39//
henrike@webrtc.org28e20752013-07-10 00:45:36 +000040// 7. Once a remote candidate is received from the remote peer, provide it to
deadbeefb10f32f2017-02-08 01:38:21 -080041// the PeerConnection by calling AddIceCandidate.
42//
43// The receiver of a call (assuming the application is "call"-based) can decide
44// to accept or reject the call; this decision will be taken by the application,
45// not the PeerConnection.
46//
47// If the application decides to accept the call, it should:
48//
henrike@webrtc.org28e20752013-07-10 00:45:36 +000049// 1. Create PeerConnectionFactoryInterface if it doesn't exist.
deadbeefb10f32f2017-02-08 01:38:21 -080050//
henrike@webrtc.org28e20752013-07-10 00:45:36 +000051// 2. Create a new PeerConnection.
deadbeefb10f32f2017-02-08 01:38:21 -080052//
henrike@webrtc.org28e20752013-07-10 00:45:36 +000053// 3. Provide the remote offer to the new PeerConnection object by calling
deadbeefb10f32f2017-02-08 01:38:21 -080054// SetRemoteDescription.
55//
henrike@webrtc.org28e20752013-07-10 00:45:36 +000056// 4. Generate an answer to the remote offer by calling CreateAnswer and send it
57// back to the remote peer.
deadbeefb10f32f2017-02-08 01:38:21 -080058//
henrike@webrtc.org28e20752013-07-10 00:45:36 +000059// 5. Provide the local answer to the new PeerConnection by calling
deadbeefb10f32f2017-02-08 01:38:21 -080060// SetLocalDescription with the answer.
61//
62// 6. Provide the remote ICE candidates by calling AddIceCandidate.
63//
64// 7. Once a candidate has been gathered, the PeerConnection will call the
65// observer function OnIceCandidate. Send these candidates to the remote peer.
henrike@webrtc.org28e20752013-07-10 00:45:36 +000066
Henrik Kjellander15583c12016-02-10 10:53:12 +010067#ifndef WEBRTC_API_PEERCONNECTIONINTERFACE_H_
68#define WEBRTC_API_PEERCONNECTIONINTERFACE_H_
henrike@webrtc.org28e20752013-07-10 00:45:36 +000069
kwibergd1fe2812016-04-27 06:47:29 -070070#include <memory>
henrike@webrtc.org28e20752013-07-10 00:45:36 +000071#include <string>
kwiberg0eb15ed2015-12-17 03:04:15 -080072#include <utility>
henrike@webrtc.org28e20752013-07-10 00:45:36 +000073#include <vector>
74
kwiberg087bd342017-02-10 08:15:44 -080075#include "webrtc/api/audio_codecs/audio_decoder_factory.h"
ossueb1fde42017-05-02 06:46:30 -070076#include "webrtc/api/audio_codecs/audio_encoder_factory.h"
Henrik Kjellander15583c12016-02-10 10:53:12 +010077#include "webrtc/api/datachannelinterface.h"
Henrik Kjellander15583c12016-02-10 10:53:12 +010078#include "webrtc/api/dtmfsenderinterface.h"
79#include "webrtc/api/jsep.h"
80#include "webrtc/api/mediastreaminterface.h"
deadbeef6038e972017-02-16 23:31:33 -080081#include "webrtc/api/rtcerror.h"
Henrik Kjellander15583c12016-02-10 10:53:12 +010082#include "webrtc/api/rtpreceiverinterface.h"
83#include "webrtc/api/rtpsenderinterface.h"
kwiberg087bd342017-02-10 08:15:44 -080084#include "webrtc/api/stats/rtcstatscollectorcallback.h"
Henrik Kjellander15583c12016-02-10 10:53:12 +010085#include "webrtc/api/statstypes.h"
86#include "webrtc/api/umametrics.h"
zhihuang38ede132017-06-15 12:52:32 -070087#include "webrtc/call/callfactoryinterface.h"
88#include "webrtc/logging/rtc_event_log/rtc_event_log_factory_interface.h"
nissec36b31b2016-04-11 23:25:29 -070089#include "webrtc/media/base/mediachannel.h"
deadbeef112b2e92017-02-10 20:13:37 -080090#include "webrtc/media/base/videocapturer.h"
deadbeef41b07982015-12-01 15:01:24 -080091#include "webrtc/p2p/base/portallocator.h"
Edward Lemurc20978e2017-07-06 19:44:34 +020092#include "webrtc/rtc_base/fileutils.h"
93#include "webrtc/rtc_base/network.h"
94#include "webrtc/rtc_base/rtccertificate.h"
95#include "webrtc/rtc_base/rtccertificategenerator.h"
96#include "webrtc/rtc_base/socketaddress.h"
97#include "webrtc/rtc_base/sslstreamadapter.h"
henrike@webrtc.org28e20752013-07-10 00:45:36 +000098
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +000099namespace rtc {
jiayl@webrtc.org61e00b02015-03-04 22:17:38 +0000100class SSLIdentity;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000101class Thread;
102}
103
104namespace cricket {
zhihuang38ede132017-06-15 12:52:32 -0700105class MediaEngineInterface;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000106class WebRtcVideoDecoderFactory;
107class WebRtcVideoEncoderFactory;
108}
109
110namespace webrtc {
111class AudioDeviceModule;
gyzhou95aa9642016-12-13 14:06:26 -0800112class AudioMixer;
zhihuang38ede132017-06-15 12:52:32 -0700113class CallFactoryInterface;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000114class MediaConstraintsInterface;
115
116// MediaStream container interface.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000117class StreamCollectionInterface : public rtc::RefCountInterface {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000118 public:
119 // TODO(ronghuawu): Update the function names to c++ style, e.g. find -> Find.
120 virtual size_t count() = 0;
121 virtual MediaStreamInterface* at(size_t index) = 0;
122 virtual MediaStreamInterface* find(const std::string& label) = 0;
123 virtual MediaStreamTrackInterface* FindAudioTrack(
124 const std::string& id) = 0;
125 virtual MediaStreamTrackInterface* FindVideoTrack(
126 const std::string& id) = 0;
127
128 protected:
129 // Dtor protected as objects shouldn't be deleted via this interface.
130 ~StreamCollectionInterface() {}
131};
132
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000133class StatsObserver : public rtc::RefCountInterface {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000134 public:
nissee8abe3e2017-01-18 05:00:34 -0800135 virtual void OnComplete(const StatsReports& reports) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000136
137 protected:
138 virtual ~StatsObserver() {}
139};
140
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000141class PeerConnectionInterface : public rtc::RefCountInterface {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000142 public:
143 // See http://dev.w3.org/2011/webrtc/editor/webrtc.html#state-definitions .
144 enum SignalingState {
145 kStable,
146 kHaveLocalOffer,
147 kHaveLocalPrAnswer,
148 kHaveRemoteOffer,
149 kHaveRemotePrAnswer,
150 kClosed,
151 };
152
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000153 enum IceGatheringState {
154 kIceGatheringNew,
155 kIceGatheringGathering,
156 kIceGatheringComplete
157 };
158
159 enum IceConnectionState {
160 kIceConnectionNew,
161 kIceConnectionChecking,
162 kIceConnectionConnected,
163 kIceConnectionCompleted,
164 kIceConnectionFailed,
165 kIceConnectionDisconnected,
166 kIceConnectionClosed,
Guo-wei Shieh3d564c12015-08-19 16:51:15 -0700167 kIceConnectionMax,
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000168 };
169
hnsl04833622017-01-09 08:35:45 -0800170 // TLS certificate policy.
171 enum TlsCertPolicy {
172 // For TLS based protocols, ensure the connection is secure by not
173 // circumventing certificate validation.
174 kTlsCertPolicySecure,
175 // For TLS based protocols, disregard security completely by skipping
176 // certificate validation. This is insecure and should never be used unless
177 // security is irrelevant in that particular context.
178 kTlsCertPolicyInsecureNoCheck,
179 };
180
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000181 struct IceServer {
Joachim Bauch7c4e7452015-05-28 23:06:30 +0200182 // TODO(jbauch): Remove uri when all code using it has switched to urls.
Emad Omaradab1d2d2017-06-16 15:43:11 -0700183 // List of URIs associated with this server. Valid formats are described
184 // in RFC7064 and RFC7065, and more may be added in the future. The "host"
185 // part of the URI may contain either an IP address or a hostname.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000186 std::string uri;
Joachim Bauch7c4e7452015-05-28 23:06:30 +0200187 std::vector<std::string> urls;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000188 std::string username;
189 std::string password;
hnsl04833622017-01-09 08:35:45 -0800190 TlsCertPolicy tls_cert_policy = kTlsCertPolicySecure;
Emad Omaradab1d2d2017-06-16 15:43:11 -0700191 // If the URIs in |urls| only contain IP addresses, this field can be used
192 // to indicate the hostname, which may be necessary for TLS (using the SNI
193 // extension). If |urls| itself contains the hostname, this isn't
194 // necessary.
195 std::string hostname;
hnsl04833622017-01-09 08:35:45 -0800196
deadbeefd1a38b52016-12-10 13:15:33 -0800197 bool operator==(const IceServer& o) const {
198 return uri == o.uri && urls == o.urls && username == o.username &&
Emad Omaradab1d2d2017-06-16 15:43:11 -0700199 password == o.password && tls_cert_policy == o.tls_cert_policy &&
200 hostname == o.hostname;
deadbeefd1a38b52016-12-10 13:15:33 -0800201 }
202 bool operator!=(const IceServer& o) const { return !(*this == o); }
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000203 };
204 typedef std::vector<IceServer> IceServers;
205
buildbot@webrtc.org41451d42014-05-03 05:39:45 +0000206 enum IceTransportsType {
pthatcher@webrtc.orgfd630a52015-01-14 23:19:06 +0000207 // TODO(pthatcher): Rename these kTransporTypeXXX, but update
208 // Chromium at the same time.
buildbot@webrtc.org41451d42014-05-03 05:39:45 +0000209 kNone,
210 kRelay,
211 kNoHost,
212 kAll
213 };
214
pthatcher@webrtc.orgfd630a52015-01-14 23:19:06 +0000215 // https://tools.ietf.org/html/draft-ietf-rtcweb-jsep-08#section-4.1.1
216 enum BundlePolicy {
217 kBundlePolicyBalanced,
218 kBundlePolicyMaxBundle,
219 kBundlePolicyMaxCompat
220 };
buildbot@webrtc.org41451d42014-05-03 05:39:45 +0000221
Peter Thatcheraf55ccc2015-05-21 07:48:41 -0700222 // https://tools.ietf.org/html/draft-ietf-rtcweb-jsep-09#section-4.1.1
223 enum RtcpMuxPolicy {
224 kRtcpMuxPolicyNegotiate,
225 kRtcpMuxPolicyRequire,
226 };
227
Jiayang Liucac1b382015-04-30 12:35:24 -0700228 enum TcpCandidatePolicy {
229 kTcpCandidatePolicyEnabled,
230 kTcpCandidatePolicyDisabled
231 };
232
honghaiz60347052016-05-31 18:29:12 -0700233 enum CandidateNetworkPolicy {
234 kCandidateNetworkPolicyAll,
235 kCandidateNetworkPolicyLowCost
236 };
237
honghaiz1f429e32015-09-28 07:57:34 -0700238 enum ContinualGatheringPolicy {
239 GATHER_ONCE,
240 GATHER_CONTINUALLY
241 };
242
Honghai Zhangf7ddc062016-09-01 15:34:01 -0700243 enum class RTCConfigurationType {
244 // A configuration that is safer to use, despite not having the best
245 // performance. Currently this is the default configuration.
246 kSafe,
247 // An aggressive configuration that has better performance, although it
248 // may be riskier and may need extra support in the application.
249 kAggressive
250 };
251
Henrik Boström87713d02015-08-25 09:53:21 +0200252 // TODO(hbos): Change into class with private data and public getters.
nissec36b31b2016-04-11 23:25:29 -0700253 // TODO(nisse): In particular, accessing fields directly from an
254 // application is brittle, since the organization mirrors the
255 // organization of the implementation, which isn't stable. So we
256 // need getters and setters at least for fields which applications
257 // are interested in.
pthatcher@webrtc.orgfd630a52015-01-14 23:19:06 +0000258 struct RTCConfiguration {
Niels Möller71bdda02016-03-31 12:59:59 +0200259 // This struct is subject to reorganization, both for naming
260 // consistency, and to group settings to match where they are used
261 // in the implementation. To do that, we need getter and setter
262 // methods for all settings which are of interest to applications,
263 // Chrome in particular.
264
Honghai Zhangf7ddc062016-09-01 15:34:01 -0700265 RTCConfiguration() = default;
oprypin803dc292017-02-01 01:55:59 -0800266 explicit RTCConfiguration(RTCConfigurationType type) {
Honghai Zhangf7ddc062016-09-01 15:34:01 -0700267 if (type == RTCConfigurationType::kAggressive) {
Honghai Zhangaecd9822016-09-02 16:58:17 -0700268 // These parameters are also defined in Java and IOS configurations,
269 // so their values may be overwritten by the Java or IOS configuration.
270 bundle_policy = kBundlePolicyMaxBundle;
271 rtcp_mux_policy = kRtcpMuxPolicyRequire;
272 ice_connection_receiving_timeout =
273 kAggressiveIceConnectionReceivingTimeout;
274
275 // These parameters are not defined in Java or IOS configuration,
276 // so their values will not be overwritten.
277 enable_ice_renomination = true;
Honghai Zhangf7ddc062016-09-01 15:34:01 -0700278 redetermine_role_on_ice_restart = false;
279 }
Honghai Zhangbfd398c2016-08-30 22:07:42 -0700280 }
281
deadbeef293e9262017-01-11 12:28:30 -0800282 bool operator==(const RTCConfiguration& o) const;
283 bool operator!=(const RTCConfiguration& o) const;
284
nissec36b31b2016-04-11 23:25:29 -0700285 bool dscp() { return media_config.enable_dscp; }
286 void set_dscp(bool enable) { media_config.enable_dscp = enable; }
Niels Möller71bdda02016-03-31 12:59:59 +0200287
288 // TODO(nisse): The corresponding flag in MediaConfig and
289 // elsewhere should be renamed enable_cpu_adaptation.
nissec36b31b2016-04-11 23:25:29 -0700290 bool cpu_adaptation() {
291 return media_config.video.enable_cpu_overuse_detection;
292 }
Niels Möller71bdda02016-03-31 12:59:59 +0200293 void set_cpu_adaptation(bool enable) {
nissec36b31b2016-04-11 23:25:29 -0700294 media_config.video.enable_cpu_overuse_detection = enable;
Niels Möller71bdda02016-03-31 12:59:59 +0200295 }
296
nissec36b31b2016-04-11 23:25:29 -0700297 bool suspend_below_min_bitrate() {
298 return media_config.video.suspend_below_min_bitrate;
299 }
Niels Möller71bdda02016-03-31 12:59:59 +0200300 void set_suspend_below_min_bitrate(bool enable) {
nissec36b31b2016-04-11 23:25:29 -0700301 media_config.video.suspend_below_min_bitrate = enable;
Niels Möller71bdda02016-03-31 12:59:59 +0200302 }
303
304 // TODO(nisse): The negation in the corresponding MediaConfig
305 // attribute is inconsistent, and it should be renamed at some
306 // point.
nissec36b31b2016-04-11 23:25:29 -0700307 bool prerenderer_smoothing() {
308 return !media_config.video.disable_prerenderer_smoothing;
309 }
Niels Möller71bdda02016-03-31 12:59:59 +0200310 void set_prerenderer_smoothing(bool enable) {
nissec36b31b2016-04-11 23:25:29 -0700311 media_config.video.disable_prerenderer_smoothing = !enable;
Niels Möller71bdda02016-03-31 12:59:59 +0200312 }
313
honghaiz4edc39c2015-09-01 09:53:56 -0700314 static const int kUndefined = -1;
315 // Default maximum number of packets in the audio jitter buffer.
316 static const int kAudioJitterBufferMaxPackets = 50;
Honghai Zhangaecd9822016-09-02 16:58:17 -0700317 // ICE connection receiving timeout for aggressive configuration.
318 static const int kAggressiveIceConnectionReceivingTimeout = 1000;
deadbeefb10f32f2017-02-08 01:38:21 -0800319
320 ////////////////////////////////////////////////////////////////////////
321 // The below few fields mirror the standard RTCConfiguration dictionary:
322 // https://www.w3.org/TR/webrtc/#rtcconfiguration-dictionary
323 ////////////////////////////////////////////////////////////////////////
324
pthatcher@webrtc.orgfd630a52015-01-14 23:19:06 +0000325 // TODO(pthatcher): Rename this ice_servers, but update Chromium
326 // at the same time.
327 IceServers servers;
deadbeefb10f32f2017-02-08 01:38:21 -0800328 // TODO(pthatcher): Rename this ice_transport_type, but update
329 // Chromium at the same time.
330 IceTransportsType type = kAll;
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700331 BundlePolicy bundle_policy = kBundlePolicyBalanced;
zhihuang4dfb8ce2016-11-23 10:30:12 -0800332 RtcpMuxPolicy rtcp_mux_policy = kRtcpMuxPolicyRequire;
deadbeefb10f32f2017-02-08 01:38:21 -0800333 std::vector<rtc::scoped_refptr<rtc::RTCCertificate>> certificates;
334 int ice_candidate_pool_size = 0;
335
336 //////////////////////////////////////////////////////////////////////////
337 // The below fields correspond to constraints from the deprecated
338 // constraints interface for constructing a PeerConnection.
339 //
340 // rtc::Optional fields can be "missing", in which case the implementation
341 // default will be used.
342 //////////////////////////////////////////////////////////////////////////
343
344 // If set to true, don't gather IPv6 ICE candidates.
345 // TODO(deadbeef): Remove this? IPv6 support has long stopped being
346 // experimental
347 bool disable_ipv6 = false;
348
zhihuangb09b3f92017-03-07 14:40:51 -0800349 // If set to true, don't gather IPv6 ICE candidates on Wi-Fi.
350 // Only intended to be used on specific devices. Certain phones disable IPv6
351 // when the screen is turned off and it would be better to just disable the
352 // IPv6 ICE candidates on Wi-Fi in those cases.
353 bool disable_ipv6_on_wifi = false;
354
deadbeefb10f32f2017-02-08 01:38:21 -0800355 // If set to true, use RTP data channels instead of SCTP.
356 // TODO(deadbeef): Remove this. We no longer commit to supporting RTP data
357 // channels, though some applications are still working on moving off of
358 // them.
359 bool enable_rtp_data_channel = false;
360
361 // Minimum bitrate at which screencast video tracks will be encoded at.
362 // This means adding padding bits up to this bitrate, which can help
363 // when switching from a static scene to one with motion.
364 rtc::Optional<int> screencast_min_bitrate;
365
366 // Use new combined audio/video bandwidth estimation?
367 rtc::Optional<bool> combined_audio_video_bwe;
368
369 // Can be used to disable DTLS-SRTP. This should never be done, but can be
370 // useful for testing purposes, for example in setting up a loopback call
371 // with a single PeerConnection.
372 rtc::Optional<bool> enable_dtls_srtp;
373
374 /////////////////////////////////////////////////
375 // The below fields are not part of the standard.
376 /////////////////////////////////////////////////
377
378 // Can be used to disable TCP candidate generation.
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700379 TcpCandidatePolicy tcp_candidate_policy = kTcpCandidatePolicyEnabled;
deadbeefb10f32f2017-02-08 01:38:21 -0800380
381 // Can be used to avoid gathering candidates for a "higher cost" network,
382 // if a lower cost one exists. For example, if both Wi-Fi and cellular
383 // interfaces are available, this could be used to avoid using the cellular
384 // interface.
honghaiz60347052016-05-31 18:29:12 -0700385 CandidateNetworkPolicy candidate_network_policy =
386 kCandidateNetworkPolicyAll;
deadbeefb10f32f2017-02-08 01:38:21 -0800387
388 // The maximum number of packets that can be stored in the NetEq audio
389 // jitter buffer. Can be reduced to lower tolerated audio latency.
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700390 int audio_jitter_buffer_max_packets = kAudioJitterBufferMaxPackets;
deadbeefb10f32f2017-02-08 01:38:21 -0800391
392 // Whether to use the NetEq "fast mode" which will accelerate audio quicker
393 // if it falls behind.
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700394 bool audio_jitter_buffer_fast_accelerate = false;
deadbeefb10f32f2017-02-08 01:38:21 -0800395
396 // Timeout in milliseconds before an ICE candidate pair is considered to be
397 // "not receiving", after which a lower priority candidate pair may be
398 // selected.
399 int ice_connection_receiving_timeout = kUndefined;
400
401 // Interval in milliseconds at which an ICE "backup" candidate pair will be
402 // pinged. This is a candidate pair which is not actively in use, but may
403 // be switched to if the active candidate pair becomes unusable.
404 //
405 // This is relevant mainly to Wi-Fi/cell handoff; the application may not
406 // want this backup cellular candidate pair pinged frequently, since it
407 // consumes data/battery.
408 int ice_backup_candidate_pair_ping_interval = kUndefined;
409
410 // Can be used to enable continual gathering, which means new candidates
411 // will be gathered as network interfaces change. Note that if continual
412 // gathering is used, the candidate removal API should also be used, to
413 // avoid an ever-growing list of candidates.
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700414 ContinualGatheringPolicy continual_gathering_policy = GATHER_ONCE;
deadbeefb10f32f2017-02-08 01:38:21 -0800415
416 // If set to true, candidate pairs will be pinged in order of most likely
417 // to work (which means using a TURN server, generally), rather than in
418 // standard priority order.
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700419 bool prioritize_most_likely_ice_candidate_pairs = false;
deadbeefb10f32f2017-02-08 01:38:21 -0800420
nissec36b31b2016-04-11 23:25:29 -0700421 struct cricket::MediaConfig media_config;
deadbeefb10f32f2017-02-08 01:38:21 -0800422
423 // This doesn't currently work. For a while we were working on adding QUIC
424 // data channel support to PeerConnection, but decided on a different
425 // approach, and that code hasn't been updated for a while.
zhihuang9763d562016-08-05 11:14:50 -0700426 bool enable_quic = false;
deadbeefb10f32f2017-02-08 01:38:21 -0800427
428 // If set to true, only one preferred TURN allocation will be used per
429 // network interface. UDP is preferred over TCP and IPv6 over IPv4. This
430 // can be used to cut down on the number of candidate pairings.
Honghai Zhangb9e7b4a2016-06-30 20:52:02 -0700431 bool prune_turn_ports = false;
deadbeefb10f32f2017-02-08 01:38:21 -0800432
Taylor Brandstettere9851112016-07-01 11:11:13 -0700433 // If set to true, this means the ICE transport should presume TURN-to-TURN
434 // candidate pairs will succeed, even before a binding response is received.
deadbeefb10f32f2017-02-08 01:38:21 -0800435 // This can be used to optimize the initial connection time, since the DTLS
436 // handshake can begin immediately.
Taylor Brandstettere9851112016-07-01 11:11:13 -0700437 bool presume_writable_when_fully_relayed = false;
deadbeefb10f32f2017-02-08 01:38:21 -0800438
Honghai Zhang4cedf2b2016-08-31 08:18:11 -0700439 // If true, "renomination" will be added to the ice options in the transport
440 // description.
deadbeefb10f32f2017-02-08 01:38:21 -0800441 // See: https://tools.ietf.org/html/draft-thatcher-ice-renomination-00
Honghai Zhang4cedf2b2016-08-31 08:18:11 -0700442 bool enable_ice_renomination = false;
deadbeefb10f32f2017-02-08 01:38:21 -0800443
444 // If true, the ICE role is re-determined when the PeerConnection sets a
445 // local transport description that indicates an ICE restart.
446 //
447 // This is standard RFC5245 ICE behavior, but causes unnecessary role
448 // thrashing, so an application may wish to avoid it. This role
449 // re-determining was removed in ICEbis (ICE v2).
Honghai Zhangbfd398c2016-08-30 22:07:42 -0700450 bool redetermine_role_on_ice_restart = true;
deadbeefb10f32f2017-02-08 01:38:21 -0800451
skvlad51072462017-02-02 11:50:14 -0800452 // If set, the min interval (max rate) at which we will send ICE checks
453 // (STUN pings), in milliseconds.
454 rtc::Optional<int> ice_check_min_interval;
deadbeefb10f32f2017-02-08 01:38:21 -0800455
Steve Anton300bf8e2017-07-14 10:13:10 -0700456
457 // ICE Periodic Regathering
458 // If set, WebRTC will periodically create and propose candidates without
459 // starting a new ICE generation. The regathering happens continuously with
460 // interval specified in milliseconds by the uniform distribution [a, b].
461 rtc::Optional<rtc::IntervalRange> ice_regather_interval_range;
462
deadbeef293e9262017-01-11 12:28:30 -0800463 //
464 // Don't forget to update operator== if adding something.
465 //
buildbot@webrtc.org41451d42014-05-03 05:39:45 +0000466 };
467
deadbeefb10f32f2017-02-08 01:38:21 -0800468 // See: https://www.w3.org/TR/webrtc/#idl-def-rtcofferansweroptions
jiayl@webrtc.orgb18bf5e2014-08-04 18:34:16 +0000469 struct RTCOfferAnswerOptions {
470 static const int kUndefined = -1;
471 static const int kMaxOfferToReceiveMedia = 1;
472
473 // The default value for constraint offerToReceiveX:true.
474 static const int kOfferToReceiveMediaTrue = 1;
475
deadbeefb10f32f2017-02-08 01:38:21 -0800476 // These have been removed from the standard in favor of the "transceiver"
477 // API, but given that we don't support that API, we still have them here.
478 //
479 // offer_to_receive_X set to 1 will cause a media description to be
480 // generated in the offer, even if no tracks of that type have been added.
481 // Values greater than 1 are treated the same.
482 //
483 // If set to 0, the generated directional attribute will not include the
484 // "recv" direction (meaning it will be "sendonly" or "inactive".
Honghai Zhang4cedf2b2016-08-31 08:18:11 -0700485 int offer_to_receive_video = kUndefined;
486 int offer_to_receive_audio = kUndefined;
deadbeefb10f32f2017-02-08 01:38:21 -0800487
Honghai Zhang4cedf2b2016-08-31 08:18:11 -0700488 bool voice_activity_detection = true;
489 bool ice_restart = false;
deadbeefb10f32f2017-02-08 01:38:21 -0800490
491 // If true, will offer to BUNDLE audio/video/data together. Not to be
492 // confused with RTCP mux (multiplexing RTP and RTCP together).
Honghai Zhang4cedf2b2016-08-31 08:18:11 -0700493 bool use_rtp_mux = true;
jiayl@webrtc.orgb18bf5e2014-08-04 18:34:16 +0000494
Honghai Zhang4cedf2b2016-08-31 08:18:11 -0700495 RTCOfferAnswerOptions() = default;
jiayl@webrtc.orgb18bf5e2014-08-04 18:34:16 +0000496
497 RTCOfferAnswerOptions(int offer_to_receive_video,
498 int offer_to_receive_audio,
499 bool voice_activity_detection,
500 bool ice_restart,
501 bool use_rtp_mux)
502 : offer_to_receive_video(offer_to_receive_video),
503 offer_to_receive_audio(offer_to_receive_audio),
504 voice_activity_detection(voice_activity_detection),
505 ice_restart(ice_restart),
506 use_rtp_mux(use_rtp_mux) {}
507 };
508
wu@webrtc.orgb9a088b2014-02-13 23:18:49 +0000509 // Used by GetStats to decide which stats to include in the stats reports.
510 // |kStatsOutputLevelStandard| includes the standard stats for Javascript API;
511 // |kStatsOutputLevelDebug| includes both the standard stats and additional
512 // stats for debugging purposes.
513 enum StatsOutputLevel {
514 kStatsOutputLevelStandard,
515 kStatsOutputLevelDebug,
516 };
517
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000518 // Accessor methods to active local streams.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000519 virtual rtc::scoped_refptr<StreamCollectionInterface>
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000520 local_streams() = 0;
521
522 // Accessor methods to remote streams.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000523 virtual rtc::scoped_refptr<StreamCollectionInterface>
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000524 remote_streams() = 0;
525
526 // Add a new MediaStream to be sent on this PeerConnection.
527 // Note that a SessionDescription negotiation is needed before the
528 // remote peer can receive the stream.
deadbeefb10f32f2017-02-08 01:38:21 -0800529 //
530 // This has been removed from the standard in favor of a track-based API. So,
531 // this is equivalent to simply calling AddTrack for each track within the
532 // stream, with the one difference that if "stream->AddTrack(...)" is called
533 // later, the PeerConnection will automatically pick up the new track. Though
534 // this functionality will be deprecated in the future.
perkj@webrtc.orgfd0efb62014-11-06 12:16:36 +0000535 virtual bool AddStream(MediaStreamInterface* stream) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000536
537 // Remove a MediaStream from this PeerConnection.
deadbeefb10f32f2017-02-08 01:38:21 -0800538 // Note that a SessionDescription negotiation is needed before the
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000539 // remote peer is notified.
540 virtual void RemoveStream(MediaStreamInterface* stream) = 0;
541
deadbeefb10f32f2017-02-08 01:38:21 -0800542 // Add a new MediaStreamTrack to be sent on this PeerConnection, and return
543 // the newly created RtpSender.
544 //
deadbeefe1f9d832016-01-14 15:35:42 -0800545 // |streams| indicates which stream labels the track should be associated
546 // with.
547 virtual rtc::scoped_refptr<RtpSenderInterface> AddTrack(
548 MediaStreamTrackInterface* track,
nisse7f067662017-03-08 06:59:45 -0800549 std::vector<MediaStreamInterface*> streams) = 0;
deadbeefe1f9d832016-01-14 15:35:42 -0800550
551 // Remove an RtpSender from this PeerConnection.
552 // Returns true on success.
nisse7f067662017-03-08 06:59:45 -0800553 virtual bool RemoveTrack(RtpSenderInterface* sender) = 0;
deadbeefe1f9d832016-01-14 15:35:42 -0800554
deadbeef8d60a942017-02-27 14:47:33 -0800555 // Returns pointer to a DtmfSender on success. Otherwise returns null.
deadbeefb10f32f2017-02-08 01:38:21 -0800556 //
557 // This API is no longer part of the standard; instead DtmfSenders are
558 // obtained from RtpSenders. Which is what the implementation does; it finds
559 // an RtpSender for |track| and just returns its DtmfSender.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000560 virtual rtc::scoped_refptr<DtmfSenderInterface> CreateDtmfSender(
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000561 AudioTrackInterface* track) = 0;
562
deadbeef70ab1a12015-09-28 16:53:55 -0700563 // TODO(deadbeef): Make these pure virtual once all subclasses implement them.
deadbeefb10f32f2017-02-08 01:38:21 -0800564
565 // Creates a sender without a track. Can be used for "early media"/"warmup"
566 // use cases, where the application may want to negotiate video attributes
567 // before a track is available to send.
568 //
569 // The standard way to do this would be through "addTransceiver", but we
570 // don't support that API yet.
571 //
deadbeeffac06552015-11-25 11:26:01 -0800572 // |kind| must be "audio" or "video".
deadbeefb10f32f2017-02-08 01:38:21 -0800573 //
deadbeefbd7d8f72015-12-18 16:58:44 -0800574 // |stream_id| is used to populate the msid attribute; if empty, one will
575 // be generated automatically.
deadbeeffac06552015-11-25 11:26:01 -0800576 virtual rtc::scoped_refptr<RtpSenderInterface> CreateSender(
deadbeefbd7d8f72015-12-18 16:58:44 -0800577 const std::string& kind,
578 const std::string& stream_id) {
deadbeeffac06552015-11-25 11:26:01 -0800579 return rtc::scoped_refptr<RtpSenderInterface>();
580 }
581
deadbeefb10f32f2017-02-08 01:38:21 -0800582 // Get all RtpSenders, created either through AddStream, AddTrack, or
583 // CreateSender. Note that these are "Plan B SDP" RtpSenders, not "Unified
584 // Plan SDP" RtpSenders, which means that all senders of a specific media
585 // type share the same media description.
deadbeef70ab1a12015-09-28 16:53:55 -0700586 virtual std::vector<rtc::scoped_refptr<RtpSenderInterface>> GetSenders()
587 const {
588 return std::vector<rtc::scoped_refptr<RtpSenderInterface>>();
589 }
590
deadbeefb10f32f2017-02-08 01:38:21 -0800591 // Get all RtpReceivers, created when a remote description is applied.
592 // Note that these are "Plan B SDP" RtpReceivers, not "Unified Plan SDP"
593 // RtpReceivers, which means that all receivers of a specific media type
594 // share the same media description.
595 //
596 // It is also possible to have a media description with no associated
597 // RtpReceivers, if the directional attribute does not indicate that the
598 // remote peer is sending any media.
deadbeef70ab1a12015-09-28 16:53:55 -0700599 virtual std::vector<rtc::scoped_refptr<RtpReceiverInterface>> GetReceivers()
600 const {
601 return std::vector<rtc::scoped_refptr<RtpReceiverInterface>>();
602 }
603
wu@webrtc.orgb9a088b2014-02-13 23:18:49 +0000604 virtual bool GetStats(StatsObserver* observer,
605 MediaStreamTrackInterface* track,
606 StatsOutputLevel level) = 0;
hbos74e1a4f2016-09-15 23:33:01 -0700607 // Gets stats using the new stats collection API, see webrtc/api/stats/. These
608 // will replace old stats collection API when the new API has matured enough.
hbose3810152016-12-13 02:35:19 -0800609 // TODO(hbos): Default implementation that does nothing only exists as to not
610 // break third party projects. As soon as they have been updated this should
611 // be changed to "= 0;".
612 virtual void GetStats(RTCStatsCollectorCallback* callback) {}
wu@webrtc.orgb9a088b2014-02-13 23:18:49 +0000613
deadbeefb10f32f2017-02-08 01:38:21 -0800614 // Create a data channel with the provided config, or default config if none
615 // is provided. Note that an offer/answer negotiation is still necessary
616 // before the data channel can be used.
617 //
618 // Also, calling CreateDataChannel is the only way to get a data "m=" section
619 // in SDP, so it should be done before CreateOffer is called, if the
620 // application plans to use data channels.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000621 virtual rtc::scoped_refptr<DataChannelInterface> CreateDataChannel(
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000622 const std::string& label,
623 const DataChannelInit* config) = 0;
624
deadbeefb10f32f2017-02-08 01:38:21 -0800625 // Returns the more recently applied description; "pending" if it exists, and
626 // otherwise "current". See below.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000627 virtual const SessionDescriptionInterface* local_description() const = 0;
628 virtual const SessionDescriptionInterface* remote_description() const = 0;
deadbeefb10f32f2017-02-08 01:38:21 -0800629
deadbeeffe4a8a42016-12-20 17:56:17 -0800630 // A "current" description the one currently negotiated from a complete
631 // offer/answer exchange.
632 virtual const SessionDescriptionInterface* current_local_description() const {
633 return nullptr;
634 }
635 virtual const SessionDescriptionInterface* current_remote_description()
636 const {
637 return nullptr;
638 }
deadbeefb10f32f2017-02-08 01:38:21 -0800639
deadbeeffe4a8a42016-12-20 17:56:17 -0800640 // A "pending" description is one that's part of an incomplete offer/answer
641 // exchange (thus, either an offer or a pranswer). Once the offer/answer
642 // exchange is finished, the "pending" description will become "current".
643 virtual const SessionDescriptionInterface* pending_local_description() const {
644 return nullptr;
645 }
646 virtual const SessionDescriptionInterface* pending_remote_description()
647 const {
648 return nullptr;
649 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000650
651 // Create a new offer.
652 // The CreateSessionDescriptionObserver callback will be called when done.
653 virtual void CreateOffer(CreateSessionDescriptionObserver* observer,
jiayl@webrtc.orgb18bf5e2014-08-04 18:34:16 +0000654 const MediaConstraintsInterface* constraints) {}
655
656 // TODO(jiayl): remove the default impl and the old interface when chromium
657 // code is updated.
658 virtual void CreateOffer(CreateSessionDescriptionObserver* observer,
659 const RTCOfferAnswerOptions& options) {}
660
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000661 // Create an answer to an offer.
662 // The CreateSessionDescriptionObserver callback will be called when done.
663 virtual void CreateAnswer(CreateSessionDescriptionObserver* observer,
htaa2a49d92016-03-04 02:51:39 -0800664 const RTCOfferAnswerOptions& options) {}
665 // Deprecated - use version above.
666 // TODO(hta): Remove and remove default implementations when all callers
667 // are updated.
668 virtual void CreateAnswer(CreateSessionDescriptionObserver* observer,
669 const MediaConstraintsInterface* constraints) {}
670
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000671 // Sets the local session description.
deadbeef1dcb1642017-03-29 21:08:16 -0700672 // The PeerConnection takes the ownership of |desc| even if it fails.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000673 // The |observer| callback will be called when done.
deadbeef1dcb1642017-03-29 21:08:16 -0700674 // TODO(deadbeef): Change |desc| to be a unique_ptr, to make it clear
675 // that this method always takes ownership of it.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000676 virtual void SetLocalDescription(SetSessionDescriptionObserver* observer,
677 SessionDescriptionInterface* desc) = 0;
678 // Sets the remote session description.
deadbeef1dcb1642017-03-29 21:08:16 -0700679 // The PeerConnection takes the ownership of |desc| even if it fails.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000680 // The |observer| callback will be called when done.
681 virtual void SetRemoteDescription(SetSessionDescriptionObserver* observer,
682 SessionDescriptionInterface* desc) = 0;
deadbeefb10f32f2017-02-08 01:38:21 -0800683 // Deprecated; Replaced by SetConfiguration.
deadbeefa67696b2015-09-29 11:56:26 -0700684 // TODO(deadbeef): Remove once Chrome is moved over to SetConfiguration.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000685 virtual bool UpdateIce(const IceServers& configuration,
deadbeefa67696b2015-09-29 11:56:26 -0700686 const MediaConstraintsInterface* constraints) {
687 return false;
688 }
htaa2a49d92016-03-04 02:51:39 -0800689 virtual bool UpdateIce(const IceServers& configuration) { return false; }
deadbeefb10f32f2017-02-08 01:38:21 -0800690
deadbeef46c73892016-11-16 19:42:04 -0800691 // TODO(deadbeef): Make this pure virtual once all Chrome subclasses of
692 // PeerConnectionInterface implement it.
693 virtual PeerConnectionInterface::RTCConfiguration GetConfiguration() {
694 return PeerConnectionInterface::RTCConfiguration();
695 }
deadbeef293e9262017-01-11 12:28:30 -0800696
deadbeefa67696b2015-09-29 11:56:26 -0700697 // Sets the PeerConnection's global configuration to |config|.
deadbeef293e9262017-01-11 12:28:30 -0800698 //
699 // The members of |config| that may be changed are |type|, |servers|,
700 // |ice_candidate_pool_size| and |prune_turn_ports| (though the candidate
701 // pool size can't be changed after the first call to SetLocalDescription).
702 // Note that this means the BUNDLE and RTCP-multiplexing policies cannot be
703 // changed with this method.
704 //
deadbeefa67696b2015-09-29 11:56:26 -0700705 // Any changes to STUN/TURN servers or ICE candidate policy will affect the
706 // next gathering phase, and cause the next call to createOffer to generate
deadbeef293e9262017-01-11 12:28:30 -0800707 // new ICE credentials, as described in JSEP. This also occurs when
708 // |prune_turn_ports| changes, for the same reasoning.
709 //
710 // If an error occurs, returns false and populates |error| if non-null:
711 // - INVALID_MODIFICATION if |config| contains a modified parameter other
712 // than one of the parameters listed above.
713 // - INVALID_RANGE if |ice_candidate_pool_size| is out of range.
714 // - SYNTAX_ERROR if parsing an ICE server URL failed.
715 // - INVALID_PARAMETER if a TURN server is missing |username| or |password|.
716 // - INTERNAL_ERROR if an unexpected error occurred.
717 //
deadbeefa67696b2015-09-29 11:56:26 -0700718 // TODO(deadbeef): Make this pure virtual once all Chrome subclasses of
719 // PeerConnectionInterface implement it.
720 virtual bool SetConfiguration(
deadbeef293e9262017-01-11 12:28:30 -0800721 const PeerConnectionInterface::RTCConfiguration& config,
722 RTCError* error) {
723 return false;
724 }
725 // Version without error output param for backwards compatibility.
726 // TODO(deadbeef): Remove once chromium is updated.
727 virtual bool SetConfiguration(
deadbeef1e234612016-12-24 01:43:32 -0800728 const PeerConnectionInterface::RTCConfiguration& config) {
deadbeefa67696b2015-09-29 11:56:26 -0700729 return false;
730 }
deadbeefb10f32f2017-02-08 01:38:21 -0800731
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000732 // Provides a remote candidate to the ICE Agent.
733 // A copy of the |candidate| will be created and added to the remote
734 // description. So the caller of this method still has the ownership of the
735 // |candidate|.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000736 virtual bool AddIceCandidate(const IceCandidateInterface* candidate) = 0;
737
deadbeefb10f32f2017-02-08 01:38:21 -0800738 // Removes a group of remote candidates from the ICE agent. Needed mainly for
739 // continual gathering, to avoid an ever-growing list of candidates as
740 // networks come and go.
Honghai Zhang7fb69db2016-03-14 11:59:18 -0700741 virtual bool RemoveIceCandidates(
742 const std::vector<cricket::Candidate>& candidates) {
743 return false;
744 }
745
deadbeefb10f32f2017-02-08 01:38:21 -0800746 // Register a metric observer (used by chromium).
747 //
748 // There can only be one observer at a time. Before the observer is
749 // destroyed, RegisterUMAOberver(nullptr) should be called.
buildbot@webrtc.org1567b8c2014-05-08 19:54:16 +0000750 virtual void RegisterUMAObserver(UMAObserver* observer) = 0;
751
zstein4b979802017-06-02 14:37:37 -0700752 // 0 <= min <= current <= max should hold for set parameters.
753 struct BitrateParameters {
754 rtc::Optional<int> min_bitrate_bps;
755 rtc::Optional<int> current_bitrate_bps;
756 rtc::Optional<int> max_bitrate_bps;
757 };
758
759 // SetBitrate limits the bandwidth allocated for all RTP streams sent by
760 // this PeerConnection. Other limitations might affect these limits and
761 // are respected (for example "b=AS" in SDP).
762 //
763 // Setting |current_bitrate_bps| will reset the current bitrate estimate
764 // to the provided value.
zstein83dc6b62017-07-17 15:09:30 -0700765 virtual RTCError SetBitrate(const BitrateParameters& bitrate) = 0;
zstein4b979802017-06-02 14:37:37 -0700766
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000767 // Returns the current SignalingState.
768 virtual SignalingState signaling_state() = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000769 virtual IceConnectionState ice_connection_state() = 0;
770 virtual IceGatheringState ice_gathering_state() = 0;
771
ivoc14d5dbe2016-07-04 07:06:55 -0700772 // Starts RtcEventLog using existing file. Takes ownership of |file| and
773 // passes it on to Call, which will take the ownership. If the
774 // operation fails the file will be closed. The logging will stop
775 // automatically after 10 minutes have passed, or when the StopRtcEventLog
776 // function is called.
777 // TODO(ivoc): Make this pure virtual when Chrome is updated.
778 virtual bool StartRtcEventLog(rtc::PlatformFile file,
779 int64_t max_size_bytes) {
780 return false;
781 }
782
783 // Stops logging the RtcEventLog.
784 // TODO(ivoc): Make this pure virtual when Chrome is updated.
785 virtual void StopRtcEventLog() {}
786
deadbeefb10f32f2017-02-08 01:38:21 -0800787 // Terminates all media, closes the transports, and in general releases any
788 // resources used by the PeerConnection. This is an irreversible operation.
deadbeefd07061c2017-04-20 13:19:00 -0700789 //
790 // Note that after this method completes, the PeerConnection will no longer
791 // use the PeerConnectionObserver interface passed in on construction, and
792 // thus the observer object can be safely destroyed.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000793 virtual void Close() = 0;
794
795 protected:
796 // Dtor protected as objects shouldn't be deleted via this interface.
797 ~PeerConnectionInterface() {}
798};
799
deadbeefb10f32f2017-02-08 01:38:21 -0800800// PeerConnection callback interface, used for RTCPeerConnection events.
801// Application should implement these methods.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000802class PeerConnectionObserver {
803 public:
804 enum StateType {
805 kSignalingState,
806 kIceState,
807 };
808
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000809 // Triggered when the SignalingState changed.
810 virtual void OnSignalingChange(
perkjdfb769d2016-02-09 03:09:43 -0800811 PeerConnectionInterface::SignalingState new_state) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000812
Taylor Brandstetter98cde262016-05-31 13:02:21 -0700813 // TODO(deadbeef): Once all subclasses override the scoped_refptr versions
814 // of the below three methods, make them pure virtual and remove the raw
815 // pointer version.
816
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000817 // Triggered when media is received on a new stream from remote peer.
nisse7f067662017-03-08 06:59:45 -0800818 virtual void OnAddStream(rtc::scoped_refptr<MediaStreamInterface> stream) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000819
820 // Triggered when a remote peer close a stream.
nisse7f067662017-03-08 06:59:45 -0800821 virtual void OnRemoveStream(
822 rtc::scoped_refptr<MediaStreamInterface> stream) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000823
Taylor Brandstetter98cde262016-05-31 13:02:21 -0700824 // Triggered when a remote peer opens a data channel.
825 virtual void OnDataChannel(
nisse7f067662017-03-08 06:59:45 -0800826 rtc::scoped_refptr<DataChannelInterface> data_channel) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000827
Taylor Brandstetter98cde262016-05-31 13:02:21 -0700828 // Triggered when renegotiation is needed. For example, an ICE restart
829 // has begun.
fischman@webrtc.orgd7568a02014-01-13 22:04:12 +0000830 virtual void OnRenegotiationNeeded() = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000831
Taylor Brandstetter98cde262016-05-31 13:02:21 -0700832 // Called any time the IceConnectionState changes.
deadbeefb10f32f2017-02-08 01:38:21 -0800833 //
834 // Note that our ICE states lag behind the standard slightly. The most
835 // notable differences include the fact that "failed" occurs after 15
836 // seconds, not 30, and this actually represents a combination ICE + DTLS
837 // state, so it may be "failed" if DTLS fails while ICE succeeds.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000838 virtual void OnIceConnectionChange(
perkjdfb769d2016-02-09 03:09:43 -0800839 PeerConnectionInterface::IceConnectionState new_state) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000840
Taylor Brandstetter98cde262016-05-31 13:02:21 -0700841 // Called any time the IceGatheringState changes.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000842 virtual void OnIceGatheringChange(
perkjdfb769d2016-02-09 03:09:43 -0800843 PeerConnectionInterface::IceGatheringState new_state) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000844
Taylor Brandstetter98cde262016-05-31 13:02:21 -0700845 // A new ICE candidate has been gathered.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000846 virtual void OnIceCandidate(const IceCandidateInterface* candidate) = 0;
847
Honghai Zhang7fb69db2016-03-14 11:59:18 -0700848 // Ice candidates have been removed.
849 // TODO(honghaiz): Make this a pure virtual method when all its subclasses
850 // implement it.
851 virtual void OnIceCandidatesRemoved(
852 const std::vector<cricket::Candidate>& candidates) {}
853
Peter Thatcher54360512015-07-08 11:08:35 -0700854 // Called when the ICE connection receiving status changes.
855 virtual void OnIceConnectionReceivingChange(bool receiving) {}
856
zhihuang81c3a032016-11-17 12:06:24 -0800857 // Called when a track is added to streams.
858 // TODO(zhihuang) Make this a pure virtual method when all its subclasses
859 // implement it.
860 virtual void OnAddTrack(
861 rtc::scoped_refptr<RtpReceiverInterface> receiver,
zhihuangc63b8942016-12-02 15:41:10 -0800862 const std::vector<rtc::scoped_refptr<MediaStreamInterface>>& streams) {}
zhihuang81c3a032016-11-17 12:06:24 -0800863
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000864 protected:
865 // Dtor protected as objects shouldn't be deleted via this interface.
866 ~PeerConnectionObserver() {}
867};
868
deadbeefb10f32f2017-02-08 01:38:21 -0800869// PeerConnectionFactoryInterface is the factory interface used for creating
870// PeerConnection, MediaStream and MediaStreamTrack objects.
871//
872// The simplest method for obtaiing one, CreatePeerConnectionFactory will
873// create the required libjingle threads, socket and network manager factory
874// classes for networking if none are provided, though it requires that the
875// application runs a message loop on the thread that called the method (see
876// explanation below)
877//
878// If an application decides to provide its own threads and/or implementation
879// of networking classes, it should use the alternate
880// CreatePeerConnectionFactory method which accepts threads as input, and use
881// the CreatePeerConnection version that takes a PortAllocator as an argument.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000882class PeerConnectionFactoryInterface : public rtc::RefCountInterface {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000883 public:
wu@webrtc.org97077a32013-10-25 21:18:33 +0000884 class Options {
885 public:
deadbeefb10f32f2017-02-08 01:38:21 -0800886 Options() : crypto_options(rtc::CryptoOptions::NoGcm()) {}
887
888 // If set to true, created PeerConnections won't enforce any SRTP
889 // requirement, allowing unsecured media. Should only be used for
890 // testing/debugging.
891 bool disable_encryption = false;
892
893 // Deprecated. The only effect of setting this to true is that
894 // CreateDataChannel will fail, which is not that useful.
895 bool disable_sctp_data_channels = false;
896
897 // If set to true, any platform-supported network monitoring capability
898 // won't be used, and instead networks will only be updated via polling.
899 //
900 // This only has an effect if a PeerConnection is created with the default
901 // PortAllocator implementation.
902 bool disable_network_monitor = false;
phoglund@webrtc.org006521d2015-02-12 09:23:59 +0000903
904 // Sets the network types to ignore. For instance, calling this with
905 // ADAPTER_TYPE_ETHERNET | ADAPTER_TYPE_LOOPBACK will ignore Ethernet and
906 // loopback interfaces.
deadbeefb10f32f2017-02-08 01:38:21 -0800907 int network_ignore_mask = rtc::kDefaultNetworkIgnoreMask;
Joachim Bauch04e5b492015-05-29 09:40:39 +0200908
909 // Sets the maximum supported protocol version. The highest version
910 // supported by both ends will be used for the connection, i.e. if one
911 // party supports DTLS 1.0 and the other DTLS 1.2, DTLS 1.0 will be used.
deadbeefb10f32f2017-02-08 01:38:21 -0800912 rtc::SSLProtocolVersion ssl_max_version = rtc::SSL_PROTOCOL_DTLS_12;
jbauchcb560652016-08-04 05:20:32 -0700913
914 // Sets crypto related options, e.g. enabled cipher suites.
915 rtc::CryptoOptions crypto_options;
wu@webrtc.org97077a32013-10-25 21:18:33 +0000916 };
917
deadbeef7914b8c2017-04-21 03:23:33 -0700918 // Set the options to be used for subsequently created PeerConnections.
wu@webrtc.org97077a32013-10-25 21:18:33 +0000919 virtual void SetOptions(const Options& options) = 0;
buildbot@webrtc.org41451d42014-05-03 05:39:45 +0000920
deadbeefd07061c2017-04-20 13:19:00 -0700921 // |allocator| and |cert_generator| may be null, in which case default
922 // implementations will be used.
923 //
924 // |observer| must not be null.
925 //
926 // Note that this method does not take ownership of |observer|; it's the
927 // responsibility of the caller to delete it. It can be safely deleted after
928 // Close has been called on the returned PeerConnection, which ensures no
929 // more observer callbacks will be invoked.
deadbeef41b07982015-12-01 15:01:24 -0800930 virtual rtc::scoped_refptr<PeerConnectionInterface> CreatePeerConnection(
931 const PeerConnectionInterface::RTCConfiguration& configuration,
kwibergd1fe2812016-04-27 06:47:29 -0700932 std::unique_ptr<cricket::PortAllocator> allocator,
Henrik Boströmd03c23b2016-06-01 11:44:18 +0200933 std::unique_ptr<rtc::RTCCertificateGeneratorInterface> cert_generator,
hbosd7973cc2016-05-27 06:08:53 -0700934 PeerConnectionObserver* observer) = 0;
buildbot@webrtc.org41451d42014-05-03 05:39:45 +0000935
deadbeefb10f32f2017-02-08 01:38:21 -0800936 // Deprecated; should use RTCConfiguration for everything that previously
937 // used constraints.
htaa2a49d92016-03-04 02:51:39 -0800938 virtual rtc::scoped_refptr<PeerConnectionInterface> CreatePeerConnection(
939 const PeerConnectionInterface::RTCConfiguration& configuration,
deadbeefb10f32f2017-02-08 01:38:21 -0800940 const MediaConstraintsInterface* constraints,
kwibergd1fe2812016-04-27 06:47:29 -0700941 std::unique_ptr<cricket::PortAllocator> allocator,
Henrik Boströmd03c23b2016-06-01 11:44:18 +0200942 std::unique_ptr<rtc::RTCCertificateGeneratorInterface> cert_generator,
hbosd7973cc2016-05-27 06:08:53 -0700943 PeerConnectionObserver* observer) = 0;
htaa2a49d92016-03-04 02:51:39 -0800944
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000945 virtual rtc::scoped_refptr<MediaStreamInterface>
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000946 CreateLocalMediaStream(const std::string& label) = 0;
947
deadbeefe814a0d2017-02-25 18:15:09 -0800948 // Creates an AudioSourceInterface.
deadbeefb10f32f2017-02-08 01:38:21 -0800949 // |options| decides audio processing settings.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000950 virtual rtc::scoped_refptr<AudioSourceInterface> CreateAudioSource(
htaa2a49d92016-03-04 02:51:39 -0800951 const cricket::AudioOptions& options) = 0;
952 // Deprecated - use version above.
deadbeeffe0fd412017-01-13 11:47:56 -0800953 // Can use CopyConstraintsIntoAudioOptions to bridge the gap.
htaa2a49d92016-03-04 02:51:39 -0800954 virtual rtc::scoped_refptr<AudioSourceInterface> CreateAudioSource(
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000955 const MediaConstraintsInterface* constraints) = 0;
956
deadbeef39e14da2017-02-13 09:49:58 -0800957 // Creates a VideoTrackSourceInterface from |capturer|.
958 // TODO(deadbeef): We should aim to remove cricket::VideoCapturer from the
959 // API. It's mainly used as a wrapper around webrtc's provided
960 // platform-specific capturers, but these should be refactored to use
961 // VideoTrackSourceInterface directly.
deadbeef112b2e92017-02-10 20:13:37 -0800962 // TODO(deadbeef): Make pure virtual once downstream mock PC factory classes
963 // are updated.
perkja3ede6c2016-03-08 01:27:48 +0100964 virtual rtc::scoped_refptr<VideoTrackSourceInterface> CreateVideoSource(
deadbeef112b2e92017-02-10 20:13:37 -0800965 std::unique_ptr<cricket::VideoCapturer> capturer) {
966 return nullptr;
967 }
968
htaa2a49d92016-03-04 02:51:39 -0800969 // A video source creator that allows selection of resolution and frame rate.
deadbeef8d60a942017-02-27 14:47:33 -0800970 // |constraints| decides video resolution and frame rate but can be null.
971 // In the null case, use the version above.
deadbeef112b2e92017-02-10 20:13:37 -0800972 //
973 // |constraints| is only used for the invocation of this method, and can
974 // safely be destroyed afterwards.
975 virtual rtc::scoped_refptr<VideoTrackSourceInterface> CreateVideoSource(
976 std::unique_ptr<cricket::VideoCapturer> capturer,
977 const MediaConstraintsInterface* constraints) {
978 return nullptr;
979 }
980
981 // Deprecated; please use the versions that take unique_ptrs above.
982 // TODO(deadbeef): Remove these once safe to do so.
983 virtual rtc::scoped_refptr<VideoTrackSourceInterface> CreateVideoSource(
984 cricket::VideoCapturer* capturer) {
985 return CreateVideoSource(std::unique_ptr<cricket::VideoCapturer>(capturer));
986 }
perkja3ede6c2016-03-08 01:27:48 +0100987 virtual rtc::scoped_refptr<VideoTrackSourceInterface> CreateVideoSource(
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000988 cricket::VideoCapturer* capturer,
deadbeef112b2e92017-02-10 20:13:37 -0800989 const MediaConstraintsInterface* constraints) {
990 return CreateVideoSource(std::unique_ptr<cricket::VideoCapturer>(capturer),
991 constraints);
992 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000993
994 // Creates a new local VideoTrack. The same |source| can be used in several
995 // tracks.
perkja3ede6c2016-03-08 01:27:48 +0100996 virtual rtc::scoped_refptr<VideoTrackInterface> CreateVideoTrack(
997 const std::string& label,
998 VideoTrackSourceInterface* source) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000999
deadbeef8d60a942017-02-27 14:47:33 -08001000 // Creates an new AudioTrack. At the moment |source| can be null.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +00001001 virtual rtc::scoped_refptr<AudioTrackInterface>
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001002 CreateAudioTrack(const std::string& label,
1003 AudioSourceInterface* source) = 0;
1004
wu@webrtc.orga9890802013-12-13 00:21:03 +00001005 // Starts AEC dump using existing file. Takes ownership of |file| and passes
1006 // it on to VoiceEngine (via other objects) immediately, which will take
wu@webrtc.orga8910d22014-01-23 22:12:45 +00001007 // the ownerhip. If the operation fails, the file will be closed.
ivocd66b44d2016-01-15 03:06:36 -08001008 // A maximum file size in bytes can be specified. When the file size limit is
1009 // reached, logging is stopped automatically. If max_size_bytes is set to a
1010 // value <= 0, no limit will be used, and logging will continue until the
1011 // StopAecDump function is called.
1012 virtual bool StartAecDump(rtc::PlatformFile file, int64_t max_size_bytes) = 0;
wu@webrtc.orga9890802013-12-13 00:21:03 +00001013
ivoc797ef122015-10-22 03:25:41 -07001014 // Stops logging the AEC dump.
1015 virtual void StopAecDump() = 0;
1016
ivoc14d5dbe2016-07-04 07:06:55 -07001017 // This function is deprecated and will be removed when Chrome is updated to
1018 // use the equivalent function on PeerConnectionInterface.
1019 // TODO(ivoc) Remove after Chrome is updated.
ivocc1513ee2016-05-13 08:30:39 -07001020 virtual bool StartRtcEventLog(rtc::PlatformFile file,
1021 int64_t max_size_bytes) = 0;
ivoc14d5dbe2016-07-04 07:06:55 -07001022 // This function is deprecated and will be removed when Chrome is updated to
1023 // use the equivalent function on PeerConnectionInterface.
1024 // TODO(ivoc) Remove after Chrome is updated.
ivoc112a3d82015-10-16 02:22:18 -07001025 virtual bool StartRtcEventLog(rtc::PlatformFile file) = 0;
1026
ivoc14d5dbe2016-07-04 07:06:55 -07001027 // This function is deprecated and will be removed when Chrome is updated to
1028 // use the equivalent function on PeerConnectionInterface.
1029 // TODO(ivoc) Remove after Chrome is updated.
ivoc112a3d82015-10-16 02:22:18 -07001030 virtual void StopRtcEventLog() = 0;
1031
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001032 protected:
1033 // Dtor and ctor protected as objects shouldn't be created or deleted via
1034 // this interface.
1035 PeerConnectionFactoryInterface() {}
1036 ~PeerConnectionFactoryInterface() {} // NOLINT
1037};
1038
1039// Create a new instance of PeerConnectionFactoryInterface.
Taylor Brandstettera8415fe2016-03-23 10:38:07 -07001040//
1041// This method relies on the thread it's called on as the "signaling thread"
1042// for the PeerConnectionFactory it creates.
1043//
1044// As such, if the current thread is not already running an rtc::Thread message
1045// loop, an application using this method must eventually either call
1046// rtc::Thread::Current()->Run(), or call
1047// rtc::Thread::Current()->ProcessMessages() within the application's own
1048// message loop.
kwiberg1e4e8cb2017-01-31 01:48:08 -08001049rtc::scoped_refptr<PeerConnectionFactoryInterface> CreatePeerConnectionFactory(
1050 rtc::scoped_refptr<AudioEncoderFactory> audio_encoder_factory,
1051 rtc::scoped_refptr<AudioDecoderFactory> audio_decoder_factory);
1052
1053// Deprecated variant of the above.
1054// TODO(kwiberg): Remove.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +00001055rtc::scoped_refptr<PeerConnectionFactoryInterface>
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001056CreatePeerConnectionFactory();
1057
1058// Create a new instance of PeerConnectionFactoryInterface.
Taylor Brandstettera8415fe2016-03-23 10:38:07 -07001059//
danilchape9021a32016-05-17 01:52:02 -07001060// |network_thread|, |worker_thread| and |signaling_thread| are
1061// the only mandatory parameters.
Taylor Brandstettera8415fe2016-03-23 10:38:07 -07001062//
deadbeefb10f32f2017-02-08 01:38:21 -08001063// If non-null, a reference is added to |default_adm|, and ownership of
1064// |video_encoder_factory| and |video_decoder_factory| is transferred to the
1065// returned factory.
1066// TODO(deadbeef): Use rtc::scoped_refptr<> and std::unique_ptr<> to make this
1067// ownership transfer and ref counting more obvious.
danilchape9021a32016-05-17 01:52:02 -07001068rtc::scoped_refptr<PeerConnectionFactoryInterface> CreatePeerConnectionFactory(
1069 rtc::Thread* network_thread,
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +00001070 rtc::Thread* worker_thread,
1071 rtc::Thread* signaling_thread,
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001072 AudioDeviceModule* default_adm,
kwiberg1e4e8cb2017-01-31 01:48:08 -08001073 rtc::scoped_refptr<AudioEncoderFactory> audio_encoder_factory,
1074 rtc::scoped_refptr<AudioDecoderFactory> audio_decoder_factory,
1075 cricket::WebRtcVideoEncoderFactory* video_encoder_factory,
1076 cricket::WebRtcVideoDecoderFactory* video_decoder_factory);
1077
1078// Deprecated variant of the above.
1079// TODO(kwiberg): Remove.
1080rtc::scoped_refptr<PeerConnectionFactoryInterface> CreatePeerConnectionFactory(
1081 rtc::Thread* network_thread,
1082 rtc::Thread* worker_thread,
1083 rtc::Thread* signaling_thread,
1084 AudioDeviceModule* default_adm,
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001085 cricket::WebRtcVideoEncoderFactory* encoder_factory,
1086 cricket::WebRtcVideoDecoderFactory* decoder_factory);
1087
peah17675ce2017-06-30 07:24:04 -07001088// Create a new instance of PeerConnectionFactoryInterface with optional
1089// external audio mixed and audio processing modules.
1090//
1091// If |audio_mixer| is null, an internal audio mixer will be created and used.
1092// If |audio_processing| is null, an internal audio processing module will be
1093// created and used.
1094rtc::scoped_refptr<PeerConnectionFactoryInterface> CreatePeerConnectionFactory(
1095 rtc::Thread* network_thread,
1096 rtc::Thread* worker_thread,
1097 rtc::Thread* signaling_thread,
1098 AudioDeviceModule* default_adm,
1099 rtc::scoped_refptr<AudioEncoderFactory> audio_encoder_factory,
1100 rtc::scoped_refptr<AudioDecoderFactory> audio_decoder_factory,
1101 cricket::WebRtcVideoEncoderFactory* video_encoder_factory,
1102 cricket::WebRtcVideoDecoderFactory* video_decoder_factory,
1103 rtc::scoped_refptr<AudioMixer> audio_mixer,
1104 rtc::scoped_refptr<AudioProcessing> audio_processing);
1105
gyzhou95aa9642016-12-13 14:06:26 -08001106// Create a new instance of PeerConnectionFactoryInterface with external audio
1107// mixer.
1108//
1109// If |audio_mixer| is null, an internal audio mixer will be created and used.
1110rtc::scoped_refptr<PeerConnectionFactoryInterface>
1111CreatePeerConnectionFactoryWithAudioMixer(
1112 rtc::Thread* network_thread,
1113 rtc::Thread* worker_thread,
1114 rtc::Thread* signaling_thread,
1115 AudioDeviceModule* default_adm,
kwiberg1e4e8cb2017-01-31 01:48:08 -08001116 rtc::scoped_refptr<AudioEncoderFactory> audio_encoder_factory,
1117 rtc::scoped_refptr<AudioDecoderFactory> audio_decoder_factory,
1118 cricket::WebRtcVideoEncoderFactory* video_encoder_factory,
1119 cricket::WebRtcVideoDecoderFactory* video_decoder_factory,
1120 rtc::scoped_refptr<AudioMixer> audio_mixer);
1121
1122// Deprecated variant of the above.
1123// TODO(kwiberg): Remove.
1124rtc::scoped_refptr<PeerConnectionFactoryInterface>
1125CreatePeerConnectionFactoryWithAudioMixer(
1126 rtc::Thread* network_thread,
1127 rtc::Thread* worker_thread,
1128 rtc::Thread* signaling_thread,
1129 AudioDeviceModule* default_adm,
gyzhou95aa9642016-12-13 14:06:26 -08001130 cricket::WebRtcVideoEncoderFactory* encoder_factory,
1131 cricket::WebRtcVideoDecoderFactory* decoder_factory,
1132 rtc::scoped_refptr<AudioMixer> audio_mixer);
1133
danilchape9021a32016-05-17 01:52:02 -07001134// Create a new instance of PeerConnectionFactoryInterface.
1135// Same thread is used as worker and network thread.
danilchape9021a32016-05-17 01:52:02 -07001136inline rtc::scoped_refptr<PeerConnectionFactoryInterface>
1137CreatePeerConnectionFactory(
1138 rtc::Thread* worker_and_network_thread,
1139 rtc::Thread* signaling_thread,
1140 AudioDeviceModule* default_adm,
kwiberg1e4e8cb2017-01-31 01:48:08 -08001141 rtc::scoped_refptr<AudioEncoderFactory> audio_encoder_factory,
1142 rtc::scoped_refptr<AudioDecoderFactory> audio_decoder_factory,
1143 cricket::WebRtcVideoEncoderFactory* video_encoder_factory,
1144 cricket::WebRtcVideoDecoderFactory* video_decoder_factory) {
1145 return CreatePeerConnectionFactory(
1146 worker_and_network_thread, worker_and_network_thread, signaling_thread,
1147 default_adm, audio_encoder_factory, audio_decoder_factory,
1148 video_encoder_factory, video_decoder_factory);
1149}
1150
1151// Deprecated variant of the above.
1152// TODO(kwiberg): Remove.
1153inline rtc::scoped_refptr<PeerConnectionFactoryInterface>
1154CreatePeerConnectionFactory(
1155 rtc::Thread* worker_and_network_thread,
1156 rtc::Thread* signaling_thread,
1157 AudioDeviceModule* default_adm,
danilchape9021a32016-05-17 01:52:02 -07001158 cricket::WebRtcVideoEncoderFactory* encoder_factory,
1159 cricket::WebRtcVideoDecoderFactory* decoder_factory) {
1160 return CreatePeerConnectionFactory(
1161 worker_and_network_thread, worker_and_network_thread, signaling_thread,
1162 default_adm, encoder_factory, decoder_factory);
1163}
1164
zhihuang38ede132017-06-15 12:52:32 -07001165// This is a lower-level version of the CreatePeerConnectionFactory functions
1166// above. It's implemented in the "peerconnection" build target, whereas the
1167// above methods are only implemented in the broader "libjingle_peerconnection"
1168// build target, which pulls in the implementations of every module webrtc may
1169// use.
1170//
1171// If an application knows it will only require certain modules, it can reduce
1172// webrtc's impact on its binary size by depending only on the "peerconnection"
1173// target and the modules the application requires, using
1174// CreateModularPeerConnectionFactory instead of one of the
1175// CreatePeerConnectionFactory methods above. For example, if an application
1176// only uses WebRTC for audio, it can pass in null pointers for the
1177// video-specific interfaces, and omit the corresponding modules from its
1178// build.
1179//
1180// If |network_thread| or |worker_thread| are null, the PeerConnectionFactory
1181// will create the necessary thread internally. If |signaling_thread| is null,
1182// the PeerConnectionFactory will use the thread on which this method is called
1183// as the signaling thread, wrapping it in an rtc::Thread object if needed.
1184//
1185// If non-null, a reference is added to |default_adm|, and ownership of
1186// |video_encoder_factory| and |video_decoder_factory| is transferred to the
1187// returned factory.
1188//
peaha9cc40b2017-06-29 08:32:09 -07001189// If |audio_mixer| is null, an internal audio mixer will be created and used.
1190//
zhihuang38ede132017-06-15 12:52:32 -07001191// TODO(deadbeef): Use rtc::scoped_refptr<> and std::unique_ptr<> to make this
1192// ownership transfer and ref counting more obvious.
1193//
1194// TODO(deadbeef): Encapsulate these modules in a struct, so that when a new
1195// module is inevitably exposed, we can just add a field to the struct instead
1196// of adding a whole new CreateModularPeerConnectionFactory overload.
1197rtc::scoped_refptr<PeerConnectionFactoryInterface>
1198CreateModularPeerConnectionFactory(
1199 rtc::Thread* network_thread,
1200 rtc::Thread* worker_thread,
1201 rtc::Thread* signaling_thread,
1202 AudioDeviceModule* default_adm,
1203 rtc::scoped_refptr<AudioEncoderFactory> audio_encoder_factory,
1204 rtc::scoped_refptr<AudioDecoderFactory> audio_decoder_factory,
1205 cricket::WebRtcVideoEncoderFactory* video_encoder_factory,
1206 cricket::WebRtcVideoDecoderFactory* video_decoder_factory,
1207 rtc::scoped_refptr<AudioMixer> audio_mixer,
1208 std::unique_ptr<cricket::MediaEngineInterface> media_engine,
1209 std::unique_ptr<CallFactoryInterface> call_factory,
1210 std::unique_ptr<RtcEventLogFactoryInterface> event_log_factory);
1211
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001212} // namespace webrtc
1213
Henrik Kjellander15583c12016-02-10 10:53:12 +01001214#endif // WEBRTC_API_PEERCONNECTIONINTERFACE_H_