blob: 632fc3ca9f15b7146e32e17d33de2e7808e1e246 [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
deadbeefd21eab32017-07-26 16:50:11 -0700355 // By default, the PeerConnection will use a limited number of IPv6 network
356 // interfaces, in order to avoid too many ICE candidate pairs being created
357 // and delaying ICE completion.
358 //
359 // Can be set to INT_MAX to effectively disable the limit.
360 int max_ipv6_networks = cricket::kDefaultMaxIPv6Networks;
361
deadbeefb10f32f2017-02-08 01:38:21 -0800362 // If set to true, use RTP data channels instead of SCTP.
363 // TODO(deadbeef): Remove this. We no longer commit to supporting RTP data
364 // channels, though some applications are still working on moving off of
365 // them.
366 bool enable_rtp_data_channel = false;
367
368 // Minimum bitrate at which screencast video tracks will be encoded at.
369 // This means adding padding bits up to this bitrate, which can help
370 // when switching from a static scene to one with motion.
371 rtc::Optional<int> screencast_min_bitrate;
372
373 // Use new combined audio/video bandwidth estimation?
374 rtc::Optional<bool> combined_audio_video_bwe;
375
376 // Can be used to disable DTLS-SRTP. This should never be done, but can be
377 // useful for testing purposes, for example in setting up a loopback call
378 // with a single PeerConnection.
379 rtc::Optional<bool> enable_dtls_srtp;
380
381 /////////////////////////////////////////////////
382 // The below fields are not part of the standard.
383 /////////////////////////////////////////////////
384
385 // Can be used to disable TCP candidate generation.
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700386 TcpCandidatePolicy tcp_candidate_policy = kTcpCandidatePolicyEnabled;
deadbeefb10f32f2017-02-08 01:38:21 -0800387
388 // Can be used to avoid gathering candidates for a "higher cost" network,
389 // if a lower cost one exists. For example, if both Wi-Fi and cellular
390 // interfaces are available, this could be used to avoid using the cellular
391 // interface.
honghaiz60347052016-05-31 18:29:12 -0700392 CandidateNetworkPolicy candidate_network_policy =
393 kCandidateNetworkPolicyAll;
deadbeefb10f32f2017-02-08 01:38:21 -0800394
395 // The maximum number of packets that can be stored in the NetEq audio
396 // jitter buffer. Can be reduced to lower tolerated audio latency.
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700397 int audio_jitter_buffer_max_packets = kAudioJitterBufferMaxPackets;
deadbeefb10f32f2017-02-08 01:38:21 -0800398
399 // Whether to use the NetEq "fast mode" which will accelerate audio quicker
400 // if it falls behind.
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700401 bool audio_jitter_buffer_fast_accelerate = false;
deadbeefb10f32f2017-02-08 01:38:21 -0800402
403 // Timeout in milliseconds before an ICE candidate pair is considered to be
404 // "not receiving", after which a lower priority candidate pair may be
405 // selected.
406 int ice_connection_receiving_timeout = kUndefined;
407
408 // Interval in milliseconds at which an ICE "backup" candidate pair will be
409 // pinged. This is a candidate pair which is not actively in use, but may
410 // be switched to if the active candidate pair becomes unusable.
411 //
412 // This is relevant mainly to Wi-Fi/cell handoff; the application may not
413 // want this backup cellular candidate pair pinged frequently, since it
414 // consumes data/battery.
415 int ice_backup_candidate_pair_ping_interval = kUndefined;
416
417 // Can be used to enable continual gathering, which means new candidates
418 // will be gathered as network interfaces change. Note that if continual
419 // gathering is used, the candidate removal API should also be used, to
420 // avoid an ever-growing list of candidates.
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700421 ContinualGatheringPolicy continual_gathering_policy = GATHER_ONCE;
deadbeefb10f32f2017-02-08 01:38:21 -0800422
423 // If set to true, candidate pairs will be pinged in order of most likely
424 // to work (which means using a TURN server, generally), rather than in
425 // standard priority order.
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700426 bool prioritize_most_likely_ice_candidate_pairs = false;
deadbeefb10f32f2017-02-08 01:38:21 -0800427
nissec36b31b2016-04-11 23:25:29 -0700428 struct cricket::MediaConfig media_config;
deadbeefb10f32f2017-02-08 01:38:21 -0800429
430 // This doesn't currently work. For a while we were working on adding QUIC
431 // data channel support to PeerConnection, but decided on a different
432 // approach, and that code hasn't been updated for a while.
zhihuang9763d562016-08-05 11:14:50 -0700433 bool enable_quic = false;
deadbeefb10f32f2017-02-08 01:38:21 -0800434
435 // If set to true, only one preferred TURN allocation will be used per
436 // network interface. UDP is preferred over TCP and IPv6 over IPv4. This
437 // can be used to cut down on the number of candidate pairings.
Honghai Zhangb9e7b4a2016-06-30 20:52:02 -0700438 bool prune_turn_ports = false;
deadbeefb10f32f2017-02-08 01:38:21 -0800439
Taylor Brandstettere9851112016-07-01 11:11:13 -0700440 // If set to true, this means the ICE transport should presume TURN-to-TURN
441 // candidate pairs will succeed, even before a binding response is received.
deadbeefb10f32f2017-02-08 01:38:21 -0800442 // This can be used to optimize the initial connection time, since the DTLS
443 // handshake can begin immediately.
Taylor Brandstettere9851112016-07-01 11:11:13 -0700444 bool presume_writable_when_fully_relayed = false;
deadbeefb10f32f2017-02-08 01:38:21 -0800445
Honghai Zhang4cedf2b2016-08-31 08:18:11 -0700446 // If true, "renomination" will be added to the ice options in the transport
447 // description.
deadbeefb10f32f2017-02-08 01:38:21 -0800448 // See: https://tools.ietf.org/html/draft-thatcher-ice-renomination-00
Honghai Zhang4cedf2b2016-08-31 08:18:11 -0700449 bool enable_ice_renomination = false;
deadbeefb10f32f2017-02-08 01:38:21 -0800450
451 // If true, the ICE role is re-determined when the PeerConnection sets a
452 // local transport description that indicates an ICE restart.
453 //
454 // This is standard RFC5245 ICE behavior, but causes unnecessary role
455 // thrashing, so an application may wish to avoid it. This role
456 // re-determining was removed in ICEbis (ICE v2).
Honghai Zhangbfd398c2016-08-30 22:07:42 -0700457 bool redetermine_role_on_ice_restart = true;
deadbeefb10f32f2017-02-08 01:38:21 -0800458
skvlad51072462017-02-02 11:50:14 -0800459 // If set, the min interval (max rate) at which we will send ICE checks
460 // (STUN pings), in milliseconds.
461 rtc::Optional<int> ice_check_min_interval;
deadbeefb10f32f2017-02-08 01:38:21 -0800462
Steve Anton300bf8e2017-07-14 10:13:10 -0700463
464 // ICE Periodic Regathering
465 // If set, WebRTC will periodically create and propose candidates without
466 // starting a new ICE generation. The regathering happens continuously with
467 // interval specified in milliseconds by the uniform distribution [a, b].
468 rtc::Optional<rtc::IntervalRange> ice_regather_interval_range;
469
deadbeef293e9262017-01-11 12:28:30 -0800470 //
471 // Don't forget to update operator== if adding something.
472 //
buildbot@webrtc.org41451d42014-05-03 05:39:45 +0000473 };
474
deadbeefb10f32f2017-02-08 01:38:21 -0800475 // See: https://www.w3.org/TR/webrtc/#idl-def-rtcofferansweroptions
jiayl@webrtc.orgb18bf5e2014-08-04 18:34:16 +0000476 struct RTCOfferAnswerOptions {
477 static const int kUndefined = -1;
478 static const int kMaxOfferToReceiveMedia = 1;
479
480 // The default value for constraint offerToReceiveX:true.
481 static const int kOfferToReceiveMediaTrue = 1;
482
deadbeefb10f32f2017-02-08 01:38:21 -0800483 // These have been removed from the standard in favor of the "transceiver"
484 // API, but given that we don't support that API, we still have them here.
485 //
486 // offer_to_receive_X set to 1 will cause a media description to be
487 // generated in the offer, even if no tracks of that type have been added.
488 // Values greater than 1 are treated the same.
489 //
490 // If set to 0, the generated directional attribute will not include the
491 // "recv" direction (meaning it will be "sendonly" or "inactive".
Honghai Zhang4cedf2b2016-08-31 08:18:11 -0700492 int offer_to_receive_video = kUndefined;
493 int offer_to_receive_audio = kUndefined;
deadbeefb10f32f2017-02-08 01:38:21 -0800494
Honghai Zhang4cedf2b2016-08-31 08:18:11 -0700495 bool voice_activity_detection = true;
496 bool ice_restart = false;
deadbeefb10f32f2017-02-08 01:38:21 -0800497
498 // If true, will offer to BUNDLE audio/video/data together. Not to be
499 // confused with RTCP mux (multiplexing RTP and RTCP together).
Honghai Zhang4cedf2b2016-08-31 08:18:11 -0700500 bool use_rtp_mux = true;
jiayl@webrtc.orgb18bf5e2014-08-04 18:34:16 +0000501
Honghai Zhang4cedf2b2016-08-31 08:18:11 -0700502 RTCOfferAnswerOptions() = default;
jiayl@webrtc.orgb18bf5e2014-08-04 18:34:16 +0000503
504 RTCOfferAnswerOptions(int offer_to_receive_video,
505 int offer_to_receive_audio,
506 bool voice_activity_detection,
507 bool ice_restart,
508 bool use_rtp_mux)
509 : offer_to_receive_video(offer_to_receive_video),
510 offer_to_receive_audio(offer_to_receive_audio),
511 voice_activity_detection(voice_activity_detection),
512 ice_restart(ice_restart),
513 use_rtp_mux(use_rtp_mux) {}
514 };
515
wu@webrtc.orgb9a088b2014-02-13 23:18:49 +0000516 // Used by GetStats to decide which stats to include in the stats reports.
517 // |kStatsOutputLevelStandard| includes the standard stats for Javascript API;
518 // |kStatsOutputLevelDebug| includes both the standard stats and additional
519 // stats for debugging purposes.
520 enum StatsOutputLevel {
521 kStatsOutputLevelStandard,
522 kStatsOutputLevelDebug,
523 };
524
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000525 // Accessor methods to active local streams.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000526 virtual rtc::scoped_refptr<StreamCollectionInterface>
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000527 local_streams() = 0;
528
529 // Accessor methods to remote streams.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000530 virtual rtc::scoped_refptr<StreamCollectionInterface>
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000531 remote_streams() = 0;
532
533 // Add a new MediaStream to be sent on this PeerConnection.
534 // Note that a SessionDescription negotiation is needed before the
535 // remote peer can receive the stream.
deadbeefb10f32f2017-02-08 01:38:21 -0800536 //
537 // This has been removed from the standard in favor of a track-based API. So,
538 // this is equivalent to simply calling AddTrack for each track within the
539 // stream, with the one difference that if "stream->AddTrack(...)" is called
540 // later, the PeerConnection will automatically pick up the new track. Though
541 // this functionality will be deprecated in the future.
perkj@webrtc.orgfd0efb62014-11-06 12:16:36 +0000542 virtual bool AddStream(MediaStreamInterface* stream) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000543
544 // Remove a MediaStream from this PeerConnection.
deadbeefb10f32f2017-02-08 01:38:21 -0800545 // Note that a SessionDescription negotiation is needed before the
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000546 // remote peer is notified.
547 virtual void RemoveStream(MediaStreamInterface* stream) = 0;
548
deadbeefb10f32f2017-02-08 01:38:21 -0800549 // Add a new MediaStreamTrack to be sent on this PeerConnection, and return
550 // the newly created RtpSender.
551 //
deadbeefe1f9d832016-01-14 15:35:42 -0800552 // |streams| indicates which stream labels the track should be associated
553 // with.
554 virtual rtc::scoped_refptr<RtpSenderInterface> AddTrack(
555 MediaStreamTrackInterface* track,
nisse7f067662017-03-08 06:59:45 -0800556 std::vector<MediaStreamInterface*> streams) = 0;
deadbeefe1f9d832016-01-14 15:35:42 -0800557
558 // Remove an RtpSender from this PeerConnection.
559 // Returns true on success.
nisse7f067662017-03-08 06:59:45 -0800560 virtual bool RemoveTrack(RtpSenderInterface* sender) = 0;
deadbeefe1f9d832016-01-14 15:35:42 -0800561
deadbeef8d60a942017-02-27 14:47:33 -0800562 // Returns pointer to a DtmfSender on success. Otherwise returns null.
deadbeefb10f32f2017-02-08 01:38:21 -0800563 //
564 // This API is no longer part of the standard; instead DtmfSenders are
565 // obtained from RtpSenders. Which is what the implementation does; it finds
566 // an RtpSender for |track| and just returns its DtmfSender.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000567 virtual rtc::scoped_refptr<DtmfSenderInterface> CreateDtmfSender(
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000568 AudioTrackInterface* track) = 0;
569
deadbeef70ab1a12015-09-28 16:53:55 -0700570 // TODO(deadbeef): Make these pure virtual once all subclasses implement them.
deadbeefb10f32f2017-02-08 01:38:21 -0800571
572 // Creates a sender without a track. Can be used for "early media"/"warmup"
573 // use cases, where the application may want to negotiate video attributes
574 // before a track is available to send.
575 //
576 // The standard way to do this would be through "addTransceiver", but we
577 // don't support that API yet.
578 //
deadbeeffac06552015-11-25 11:26:01 -0800579 // |kind| must be "audio" or "video".
deadbeefb10f32f2017-02-08 01:38:21 -0800580 //
deadbeefbd7d8f72015-12-18 16:58:44 -0800581 // |stream_id| is used to populate the msid attribute; if empty, one will
582 // be generated automatically.
deadbeeffac06552015-11-25 11:26:01 -0800583 virtual rtc::scoped_refptr<RtpSenderInterface> CreateSender(
deadbeefbd7d8f72015-12-18 16:58:44 -0800584 const std::string& kind,
585 const std::string& stream_id) {
deadbeeffac06552015-11-25 11:26:01 -0800586 return rtc::scoped_refptr<RtpSenderInterface>();
587 }
588
deadbeefb10f32f2017-02-08 01:38:21 -0800589 // Get all RtpSenders, created either through AddStream, AddTrack, or
590 // CreateSender. Note that these are "Plan B SDP" RtpSenders, not "Unified
591 // Plan SDP" RtpSenders, which means that all senders of a specific media
592 // type share the same media description.
deadbeef70ab1a12015-09-28 16:53:55 -0700593 virtual std::vector<rtc::scoped_refptr<RtpSenderInterface>> GetSenders()
594 const {
595 return std::vector<rtc::scoped_refptr<RtpSenderInterface>>();
596 }
597
deadbeefb10f32f2017-02-08 01:38:21 -0800598 // Get all RtpReceivers, created when a remote description is applied.
599 // Note that these are "Plan B SDP" RtpReceivers, not "Unified Plan SDP"
600 // RtpReceivers, which means that all receivers of a specific media type
601 // share the same media description.
602 //
603 // It is also possible to have a media description with no associated
604 // RtpReceivers, if the directional attribute does not indicate that the
605 // remote peer is sending any media.
deadbeef70ab1a12015-09-28 16:53:55 -0700606 virtual std::vector<rtc::scoped_refptr<RtpReceiverInterface>> GetReceivers()
607 const {
608 return std::vector<rtc::scoped_refptr<RtpReceiverInterface>>();
609 }
610
wu@webrtc.orgb9a088b2014-02-13 23:18:49 +0000611 virtual bool GetStats(StatsObserver* observer,
612 MediaStreamTrackInterface* track,
613 StatsOutputLevel level) = 0;
hbos74e1a4f2016-09-15 23:33:01 -0700614 // Gets stats using the new stats collection API, see webrtc/api/stats/. These
615 // will replace old stats collection API when the new API has matured enough.
hbose3810152016-12-13 02:35:19 -0800616 // TODO(hbos): Default implementation that does nothing only exists as to not
617 // break third party projects. As soon as they have been updated this should
618 // be changed to "= 0;".
619 virtual void GetStats(RTCStatsCollectorCallback* callback) {}
wu@webrtc.orgb9a088b2014-02-13 23:18:49 +0000620
deadbeefb10f32f2017-02-08 01:38:21 -0800621 // Create a data channel with the provided config, or default config if none
622 // is provided. Note that an offer/answer negotiation is still necessary
623 // before the data channel can be used.
624 //
625 // Also, calling CreateDataChannel is the only way to get a data "m=" section
626 // in SDP, so it should be done before CreateOffer is called, if the
627 // application plans to use data channels.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000628 virtual rtc::scoped_refptr<DataChannelInterface> CreateDataChannel(
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000629 const std::string& label,
630 const DataChannelInit* config) = 0;
631
deadbeefb10f32f2017-02-08 01:38:21 -0800632 // Returns the more recently applied description; "pending" if it exists, and
633 // otherwise "current". See below.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000634 virtual const SessionDescriptionInterface* local_description() const = 0;
635 virtual const SessionDescriptionInterface* remote_description() const = 0;
deadbeefb10f32f2017-02-08 01:38:21 -0800636
deadbeeffe4a8a42016-12-20 17:56:17 -0800637 // A "current" description the one currently negotiated from a complete
638 // offer/answer exchange.
639 virtual const SessionDescriptionInterface* current_local_description() const {
640 return nullptr;
641 }
642 virtual const SessionDescriptionInterface* current_remote_description()
643 const {
644 return nullptr;
645 }
deadbeefb10f32f2017-02-08 01:38:21 -0800646
deadbeeffe4a8a42016-12-20 17:56:17 -0800647 // A "pending" description is one that's part of an incomplete offer/answer
648 // exchange (thus, either an offer or a pranswer). Once the offer/answer
649 // exchange is finished, the "pending" description will become "current".
650 virtual const SessionDescriptionInterface* pending_local_description() const {
651 return nullptr;
652 }
653 virtual const SessionDescriptionInterface* pending_remote_description()
654 const {
655 return nullptr;
656 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000657
658 // Create a new offer.
659 // The CreateSessionDescriptionObserver callback will be called when done.
660 virtual void CreateOffer(CreateSessionDescriptionObserver* observer,
jiayl@webrtc.orgb18bf5e2014-08-04 18:34:16 +0000661 const MediaConstraintsInterface* constraints) {}
662
663 // TODO(jiayl): remove the default impl and the old interface when chromium
664 // code is updated.
665 virtual void CreateOffer(CreateSessionDescriptionObserver* observer,
666 const RTCOfferAnswerOptions& options) {}
667
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000668 // Create an answer to an offer.
669 // The CreateSessionDescriptionObserver callback will be called when done.
670 virtual void CreateAnswer(CreateSessionDescriptionObserver* observer,
htaa2a49d92016-03-04 02:51:39 -0800671 const RTCOfferAnswerOptions& options) {}
672 // Deprecated - use version above.
673 // TODO(hta): Remove and remove default implementations when all callers
674 // are updated.
675 virtual void CreateAnswer(CreateSessionDescriptionObserver* observer,
676 const MediaConstraintsInterface* constraints) {}
677
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000678 // Sets the local 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.
deadbeef1dcb1642017-03-29 21:08:16 -0700681 // TODO(deadbeef): Change |desc| to be a unique_ptr, to make it clear
682 // that this method always takes ownership of it.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000683 virtual void SetLocalDescription(SetSessionDescriptionObserver* observer,
684 SessionDescriptionInterface* desc) = 0;
685 // Sets the remote session description.
deadbeef1dcb1642017-03-29 21:08:16 -0700686 // The PeerConnection takes the ownership of |desc| even if it fails.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000687 // The |observer| callback will be called when done.
688 virtual void SetRemoteDescription(SetSessionDescriptionObserver* observer,
689 SessionDescriptionInterface* desc) = 0;
deadbeefb10f32f2017-02-08 01:38:21 -0800690 // Deprecated; Replaced by SetConfiguration.
deadbeefa67696b2015-09-29 11:56:26 -0700691 // TODO(deadbeef): Remove once Chrome is moved over to SetConfiguration.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000692 virtual bool UpdateIce(const IceServers& configuration,
deadbeefa67696b2015-09-29 11:56:26 -0700693 const MediaConstraintsInterface* constraints) {
694 return false;
695 }
htaa2a49d92016-03-04 02:51:39 -0800696 virtual bool UpdateIce(const IceServers& configuration) { return false; }
deadbeefb10f32f2017-02-08 01:38:21 -0800697
deadbeef46c73892016-11-16 19:42:04 -0800698 // TODO(deadbeef): Make this pure virtual once all Chrome subclasses of
699 // PeerConnectionInterface implement it.
700 virtual PeerConnectionInterface::RTCConfiguration GetConfiguration() {
701 return PeerConnectionInterface::RTCConfiguration();
702 }
deadbeef293e9262017-01-11 12:28:30 -0800703
deadbeefa67696b2015-09-29 11:56:26 -0700704 // Sets the PeerConnection's global configuration to |config|.
deadbeef293e9262017-01-11 12:28:30 -0800705 //
706 // The members of |config| that may be changed are |type|, |servers|,
707 // |ice_candidate_pool_size| and |prune_turn_ports| (though the candidate
708 // pool size can't be changed after the first call to SetLocalDescription).
709 // Note that this means the BUNDLE and RTCP-multiplexing policies cannot be
710 // changed with this method.
711 //
deadbeefa67696b2015-09-29 11:56:26 -0700712 // Any changes to STUN/TURN servers or ICE candidate policy will affect the
713 // next gathering phase, and cause the next call to createOffer to generate
deadbeef293e9262017-01-11 12:28:30 -0800714 // new ICE credentials, as described in JSEP. This also occurs when
715 // |prune_turn_ports| changes, for the same reasoning.
716 //
717 // If an error occurs, returns false and populates |error| if non-null:
718 // - INVALID_MODIFICATION if |config| contains a modified parameter other
719 // than one of the parameters listed above.
720 // - INVALID_RANGE if |ice_candidate_pool_size| is out of range.
721 // - SYNTAX_ERROR if parsing an ICE server URL failed.
722 // - INVALID_PARAMETER if a TURN server is missing |username| or |password|.
723 // - INTERNAL_ERROR if an unexpected error occurred.
724 //
deadbeefa67696b2015-09-29 11:56:26 -0700725 // TODO(deadbeef): Make this pure virtual once all Chrome subclasses of
726 // PeerConnectionInterface implement it.
727 virtual bool SetConfiguration(
deadbeef293e9262017-01-11 12:28:30 -0800728 const PeerConnectionInterface::RTCConfiguration& config,
729 RTCError* error) {
730 return false;
731 }
732 // Version without error output param for backwards compatibility.
733 // TODO(deadbeef): Remove once chromium is updated.
734 virtual bool SetConfiguration(
deadbeef1e234612016-12-24 01:43:32 -0800735 const PeerConnectionInterface::RTCConfiguration& config) {
deadbeefa67696b2015-09-29 11:56:26 -0700736 return false;
737 }
deadbeefb10f32f2017-02-08 01:38:21 -0800738
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000739 // Provides a remote candidate to the ICE Agent.
740 // A copy of the |candidate| will be created and added to the remote
741 // description. So the caller of this method still has the ownership of the
742 // |candidate|.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000743 virtual bool AddIceCandidate(const IceCandidateInterface* candidate) = 0;
744
deadbeefb10f32f2017-02-08 01:38:21 -0800745 // Removes a group of remote candidates from the ICE agent. Needed mainly for
746 // continual gathering, to avoid an ever-growing list of candidates as
747 // networks come and go.
Honghai Zhang7fb69db2016-03-14 11:59:18 -0700748 virtual bool RemoveIceCandidates(
749 const std::vector<cricket::Candidate>& candidates) {
750 return false;
751 }
752
deadbeefb10f32f2017-02-08 01:38:21 -0800753 // Register a metric observer (used by chromium).
754 //
755 // There can only be one observer at a time. Before the observer is
756 // destroyed, RegisterUMAOberver(nullptr) should be called.
buildbot@webrtc.org1567b8c2014-05-08 19:54:16 +0000757 virtual void RegisterUMAObserver(UMAObserver* observer) = 0;
758
zstein4b979802017-06-02 14:37:37 -0700759 // 0 <= min <= current <= max should hold for set parameters.
760 struct BitrateParameters {
761 rtc::Optional<int> min_bitrate_bps;
762 rtc::Optional<int> current_bitrate_bps;
763 rtc::Optional<int> max_bitrate_bps;
764 };
765
766 // SetBitrate limits the bandwidth allocated for all RTP streams sent by
767 // this PeerConnection. Other limitations might affect these limits and
768 // are respected (for example "b=AS" in SDP).
769 //
770 // Setting |current_bitrate_bps| will reset the current bitrate estimate
771 // to the provided value.
zstein83dc6b62017-07-17 15:09:30 -0700772 virtual RTCError SetBitrate(const BitrateParameters& bitrate) = 0;
zstein4b979802017-06-02 14:37:37 -0700773
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000774 // Returns the current SignalingState.
775 virtual SignalingState signaling_state() = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000776 virtual IceConnectionState ice_connection_state() = 0;
777 virtual IceGatheringState ice_gathering_state() = 0;
778
ivoc14d5dbe2016-07-04 07:06:55 -0700779 // Starts RtcEventLog using existing file. Takes ownership of |file| and
780 // passes it on to Call, which will take the ownership. If the
781 // operation fails the file will be closed. The logging will stop
782 // automatically after 10 minutes have passed, or when the StopRtcEventLog
783 // function is called.
784 // TODO(ivoc): Make this pure virtual when Chrome is updated.
785 virtual bool StartRtcEventLog(rtc::PlatformFile file,
786 int64_t max_size_bytes) {
787 return false;
788 }
789
790 // Stops logging the RtcEventLog.
791 // TODO(ivoc): Make this pure virtual when Chrome is updated.
792 virtual void StopRtcEventLog() {}
793
deadbeefb10f32f2017-02-08 01:38:21 -0800794 // Terminates all media, closes the transports, and in general releases any
795 // resources used by the PeerConnection. This is an irreversible operation.
deadbeefd07061c2017-04-20 13:19:00 -0700796 //
797 // Note that after this method completes, the PeerConnection will no longer
798 // use the PeerConnectionObserver interface passed in on construction, and
799 // thus the observer object can be safely destroyed.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000800 virtual void Close() = 0;
801
802 protected:
803 // Dtor protected as objects shouldn't be deleted via this interface.
804 ~PeerConnectionInterface() {}
805};
806
deadbeefb10f32f2017-02-08 01:38:21 -0800807// PeerConnection callback interface, used for RTCPeerConnection events.
808// Application should implement these methods.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000809class PeerConnectionObserver {
810 public:
811 enum StateType {
812 kSignalingState,
813 kIceState,
814 };
815
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000816 // Triggered when the SignalingState changed.
817 virtual void OnSignalingChange(
perkjdfb769d2016-02-09 03:09:43 -0800818 PeerConnectionInterface::SignalingState new_state) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000819
Taylor Brandstetter98cde262016-05-31 13:02:21 -0700820 // TODO(deadbeef): Once all subclasses override the scoped_refptr versions
821 // of the below three methods, make them pure virtual and remove the raw
822 // pointer version.
823
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000824 // Triggered when media is received on a new stream from remote peer.
nisse7f067662017-03-08 06:59:45 -0800825 virtual void OnAddStream(rtc::scoped_refptr<MediaStreamInterface> stream) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000826
827 // Triggered when a remote peer close a stream.
nisse7f067662017-03-08 06:59:45 -0800828 virtual void OnRemoveStream(
829 rtc::scoped_refptr<MediaStreamInterface> stream) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000830
Taylor Brandstetter98cde262016-05-31 13:02:21 -0700831 // Triggered when a remote peer opens a data channel.
832 virtual void OnDataChannel(
nisse7f067662017-03-08 06:59:45 -0800833 rtc::scoped_refptr<DataChannelInterface> data_channel) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000834
Taylor Brandstetter98cde262016-05-31 13:02:21 -0700835 // Triggered when renegotiation is needed. For example, an ICE restart
836 // has begun.
fischman@webrtc.orgd7568a02014-01-13 22:04:12 +0000837 virtual void OnRenegotiationNeeded() = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000838
Taylor Brandstetter98cde262016-05-31 13:02:21 -0700839 // Called any time the IceConnectionState changes.
deadbeefb10f32f2017-02-08 01:38:21 -0800840 //
841 // Note that our ICE states lag behind the standard slightly. The most
842 // notable differences include the fact that "failed" occurs after 15
843 // seconds, not 30, and this actually represents a combination ICE + DTLS
844 // state, so it may be "failed" if DTLS fails while ICE succeeds.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000845 virtual void OnIceConnectionChange(
perkjdfb769d2016-02-09 03:09:43 -0800846 PeerConnectionInterface::IceConnectionState new_state) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000847
Taylor Brandstetter98cde262016-05-31 13:02:21 -0700848 // Called any time the IceGatheringState changes.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000849 virtual void OnIceGatheringChange(
perkjdfb769d2016-02-09 03:09:43 -0800850 PeerConnectionInterface::IceGatheringState new_state) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000851
Taylor Brandstetter98cde262016-05-31 13:02:21 -0700852 // A new ICE candidate has been gathered.
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000853 virtual void OnIceCandidate(const IceCandidateInterface* candidate) = 0;
854
Honghai Zhang7fb69db2016-03-14 11:59:18 -0700855 // Ice candidates have been removed.
856 // TODO(honghaiz): Make this a pure virtual method when all its subclasses
857 // implement it.
858 virtual void OnIceCandidatesRemoved(
859 const std::vector<cricket::Candidate>& candidates) {}
860
Peter Thatcher54360512015-07-08 11:08:35 -0700861 // Called when the ICE connection receiving status changes.
862 virtual void OnIceConnectionReceivingChange(bool receiving) {}
863
zhihuang81c3a032016-11-17 12:06:24 -0800864 // Called when a track is added to streams.
865 // TODO(zhihuang) Make this a pure virtual method when all its subclasses
866 // implement it.
867 virtual void OnAddTrack(
868 rtc::scoped_refptr<RtpReceiverInterface> receiver,
zhihuangc63b8942016-12-02 15:41:10 -0800869 const std::vector<rtc::scoped_refptr<MediaStreamInterface>>& streams) {}
zhihuang81c3a032016-11-17 12:06:24 -0800870
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000871 protected:
872 // Dtor protected as objects shouldn't be deleted via this interface.
873 ~PeerConnectionObserver() {}
874};
875
deadbeefb10f32f2017-02-08 01:38:21 -0800876// PeerConnectionFactoryInterface is the factory interface used for creating
877// PeerConnection, MediaStream and MediaStreamTrack objects.
878//
879// The simplest method for obtaiing one, CreatePeerConnectionFactory will
880// create the required libjingle threads, socket and network manager factory
881// classes for networking if none are provided, though it requires that the
882// application runs a message loop on the thread that called the method (see
883// explanation below)
884//
885// If an application decides to provide its own threads and/or implementation
886// of networking classes, it should use the alternate
887// CreatePeerConnectionFactory method which accepts threads as input, and use
888// the CreatePeerConnection version that takes a PortAllocator as an argument.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000889class PeerConnectionFactoryInterface : public rtc::RefCountInterface {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000890 public:
wu@webrtc.org97077a32013-10-25 21:18:33 +0000891 class Options {
892 public:
deadbeefb10f32f2017-02-08 01:38:21 -0800893 Options() : crypto_options(rtc::CryptoOptions::NoGcm()) {}
894
895 // If set to true, created PeerConnections won't enforce any SRTP
896 // requirement, allowing unsecured media. Should only be used for
897 // testing/debugging.
898 bool disable_encryption = false;
899
900 // Deprecated. The only effect of setting this to true is that
901 // CreateDataChannel will fail, which is not that useful.
902 bool disable_sctp_data_channels = false;
903
904 // If set to true, any platform-supported network monitoring capability
905 // won't be used, and instead networks will only be updated via polling.
906 //
907 // This only has an effect if a PeerConnection is created with the default
908 // PortAllocator implementation.
909 bool disable_network_monitor = false;
phoglund@webrtc.org006521d2015-02-12 09:23:59 +0000910
911 // Sets the network types to ignore. For instance, calling this with
912 // ADAPTER_TYPE_ETHERNET | ADAPTER_TYPE_LOOPBACK will ignore Ethernet and
913 // loopback interfaces.
deadbeefb10f32f2017-02-08 01:38:21 -0800914 int network_ignore_mask = rtc::kDefaultNetworkIgnoreMask;
Joachim Bauch04e5b492015-05-29 09:40:39 +0200915
916 // Sets the maximum supported protocol version. The highest version
917 // supported by both ends will be used for the connection, i.e. if one
918 // party supports DTLS 1.0 and the other DTLS 1.2, DTLS 1.0 will be used.
deadbeefb10f32f2017-02-08 01:38:21 -0800919 rtc::SSLProtocolVersion ssl_max_version = rtc::SSL_PROTOCOL_DTLS_12;
jbauchcb560652016-08-04 05:20:32 -0700920
921 // Sets crypto related options, e.g. enabled cipher suites.
922 rtc::CryptoOptions crypto_options;
wu@webrtc.org97077a32013-10-25 21:18:33 +0000923 };
924
deadbeef7914b8c2017-04-21 03:23:33 -0700925 // Set the options to be used for subsequently created PeerConnections.
wu@webrtc.org97077a32013-10-25 21:18:33 +0000926 virtual void SetOptions(const Options& options) = 0;
buildbot@webrtc.org41451d42014-05-03 05:39:45 +0000927
deadbeefd07061c2017-04-20 13:19:00 -0700928 // |allocator| and |cert_generator| may be null, in which case default
929 // implementations will be used.
930 //
931 // |observer| must not be null.
932 //
933 // Note that this method does not take ownership of |observer|; it's the
934 // responsibility of the caller to delete it. It can be safely deleted after
935 // Close has been called on the returned PeerConnection, which ensures no
936 // more observer callbacks will be invoked.
deadbeef41b07982015-12-01 15:01:24 -0800937 virtual rtc::scoped_refptr<PeerConnectionInterface> CreatePeerConnection(
938 const PeerConnectionInterface::RTCConfiguration& configuration,
kwibergd1fe2812016-04-27 06:47:29 -0700939 std::unique_ptr<cricket::PortAllocator> allocator,
Henrik Boströmd03c23b2016-06-01 11:44:18 +0200940 std::unique_ptr<rtc::RTCCertificateGeneratorInterface> cert_generator,
hbosd7973cc2016-05-27 06:08:53 -0700941 PeerConnectionObserver* observer) = 0;
buildbot@webrtc.org41451d42014-05-03 05:39:45 +0000942
deadbeefb10f32f2017-02-08 01:38:21 -0800943 // Deprecated; should use RTCConfiguration for everything that previously
944 // used constraints.
htaa2a49d92016-03-04 02:51:39 -0800945 virtual rtc::scoped_refptr<PeerConnectionInterface> CreatePeerConnection(
946 const PeerConnectionInterface::RTCConfiguration& configuration,
deadbeefb10f32f2017-02-08 01:38:21 -0800947 const MediaConstraintsInterface* constraints,
kwibergd1fe2812016-04-27 06:47:29 -0700948 std::unique_ptr<cricket::PortAllocator> allocator,
Henrik Boströmd03c23b2016-06-01 11:44:18 +0200949 std::unique_ptr<rtc::RTCCertificateGeneratorInterface> cert_generator,
hbosd7973cc2016-05-27 06:08:53 -0700950 PeerConnectionObserver* observer) = 0;
htaa2a49d92016-03-04 02:51:39 -0800951
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000952 virtual rtc::scoped_refptr<MediaStreamInterface>
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000953 CreateLocalMediaStream(const std::string& label) = 0;
954
deadbeefe814a0d2017-02-25 18:15:09 -0800955 // Creates an AudioSourceInterface.
deadbeefb10f32f2017-02-08 01:38:21 -0800956 // |options| decides audio processing settings.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +0000957 virtual rtc::scoped_refptr<AudioSourceInterface> CreateAudioSource(
htaa2a49d92016-03-04 02:51:39 -0800958 const cricket::AudioOptions& options) = 0;
959 // Deprecated - use version above.
deadbeeffe0fd412017-01-13 11:47:56 -0800960 // Can use CopyConstraintsIntoAudioOptions to bridge the gap.
htaa2a49d92016-03-04 02:51:39 -0800961 virtual rtc::scoped_refptr<AudioSourceInterface> CreateAudioSource(
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000962 const MediaConstraintsInterface* constraints) = 0;
963
deadbeef39e14da2017-02-13 09:49:58 -0800964 // Creates a VideoTrackSourceInterface from |capturer|.
965 // TODO(deadbeef): We should aim to remove cricket::VideoCapturer from the
966 // API. It's mainly used as a wrapper around webrtc's provided
967 // platform-specific capturers, but these should be refactored to use
968 // VideoTrackSourceInterface directly.
deadbeef112b2e92017-02-10 20:13:37 -0800969 // TODO(deadbeef): Make pure virtual once downstream mock PC factory classes
970 // are updated.
perkja3ede6c2016-03-08 01:27:48 +0100971 virtual rtc::scoped_refptr<VideoTrackSourceInterface> CreateVideoSource(
deadbeef112b2e92017-02-10 20:13:37 -0800972 std::unique_ptr<cricket::VideoCapturer> capturer) {
973 return nullptr;
974 }
975
htaa2a49d92016-03-04 02:51:39 -0800976 // A video source creator that allows selection of resolution and frame rate.
deadbeef8d60a942017-02-27 14:47:33 -0800977 // |constraints| decides video resolution and frame rate but can be null.
978 // In the null case, use the version above.
deadbeef112b2e92017-02-10 20:13:37 -0800979 //
980 // |constraints| is only used for the invocation of this method, and can
981 // safely be destroyed afterwards.
982 virtual rtc::scoped_refptr<VideoTrackSourceInterface> CreateVideoSource(
983 std::unique_ptr<cricket::VideoCapturer> capturer,
984 const MediaConstraintsInterface* constraints) {
985 return nullptr;
986 }
987
988 // Deprecated; please use the versions that take unique_ptrs above.
989 // TODO(deadbeef): Remove these once safe to do so.
990 virtual rtc::scoped_refptr<VideoTrackSourceInterface> CreateVideoSource(
991 cricket::VideoCapturer* capturer) {
992 return CreateVideoSource(std::unique_ptr<cricket::VideoCapturer>(capturer));
993 }
perkja3ede6c2016-03-08 01:27:48 +0100994 virtual rtc::scoped_refptr<VideoTrackSourceInterface> CreateVideoSource(
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000995 cricket::VideoCapturer* capturer,
deadbeef112b2e92017-02-10 20:13:37 -0800996 const MediaConstraintsInterface* constraints) {
997 return CreateVideoSource(std::unique_ptr<cricket::VideoCapturer>(capturer),
998 constraints);
999 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001000
1001 // Creates a new local VideoTrack. The same |source| can be used in several
1002 // tracks.
perkja3ede6c2016-03-08 01:27:48 +01001003 virtual rtc::scoped_refptr<VideoTrackInterface> CreateVideoTrack(
1004 const std::string& label,
1005 VideoTrackSourceInterface* source) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001006
deadbeef8d60a942017-02-27 14:47:33 -08001007 // Creates an new AudioTrack. At the moment |source| can be null.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +00001008 virtual rtc::scoped_refptr<AudioTrackInterface>
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001009 CreateAudioTrack(const std::string& label,
1010 AudioSourceInterface* source) = 0;
1011
wu@webrtc.orga9890802013-12-13 00:21:03 +00001012 // Starts AEC dump using existing file. Takes ownership of |file| and passes
1013 // it on to VoiceEngine (via other objects) immediately, which will take
wu@webrtc.orga8910d22014-01-23 22:12:45 +00001014 // the ownerhip. If the operation fails, the file will be closed.
ivocd66b44d2016-01-15 03:06:36 -08001015 // A maximum file size in bytes can be specified. When the file size limit is
1016 // reached, logging is stopped automatically. If max_size_bytes is set to a
1017 // value <= 0, no limit will be used, and logging will continue until the
1018 // StopAecDump function is called.
1019 virtual bool StartAecDump(rtc::PlatformFile file, int64_t max_size_bytes) = 0;
wu@webrtc.orga9890802013-12-13 00:21:03 +00001020
ivoc797ef122015-10-22 03:25:41 -07001021 // Stops logging the AEC dump.
1022 virtual void StopAecDump() = 0;
1023
ivoc14d5dbe2016-07-04 07:06:55 -07001024 // This function is deprecated and will be removed when Chrome is updated to
1025 // use the equivalent function on PeerConnectionInterface.
1026 // TODO(ivoc) Remove after Chrome is updated.
ivocc1513ee2016-05-13 08:30:39 -07001027 virtual bool StartRtcEventLog(rtc::PlatformFile file,
1028 int64_t max_size_bytes) = 0;
ivoc14d5dbe2016-07-04 07:06:55 -07001029 // This function is deprecated and will be removed when Chrome is updated to
1030 // use the equivalent function on PeerConnectionInterface.
1031 // TODO(ivoc) Remove after Chrome is updated.
ivoc112a3d82015-10-16 02:22:18 -07001032 virtual bool StartRtcEventLog(rtc::PlatformFile file) = 0;
1033
ivoc14d5dbe2016-07-04 07:06:55 -07001034 // This function is deprecated and will be removed when Chrome is updated to
1035 // use the equivalent function on PeerConnectionInterface.
1036 // TODO(ivoc) Remove after Chrome is updated.
ivoc112a3d82015-10-16 02:22:18 -07001037 virtual void StopRtcEventLog() = 0;
1038
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001039 protected:
1040 // Dtor and ctor protected as objects shouldn't be created or deleted via
1041 // this interface.
1042 PeerConnectionFactoryInterface() {}
1043 ~PeerConnectionFactoryInterface() {} // NOLINT
1044};
1045
1046// Create a new instance of PeerConnectionFactoryInterface.
Taylor Brandstettera8415fe2016-03-23 10:38:07 -07001047//
1048// This method relies on the thread it's called on as the "signaling thread"
1049// for the PeerConnectionFactory it creates.
1050//
1051// As such, if the current thread is not already running an rtc::Thread message
1052// loop, an application using this method must eventually either call
1053// rtc::Thread::Current()->Run(), or call
1054// rtc::Thread::Current()->ProcessMessages() within the application's own
1055// message loop.
kwiberg1e4e8cb2017-01-31 01:48:08 -08001056rtc::scoped_refptr<PeerConnectionFactoryInterface> CreatePeerConnectionFactory(
1057 rtc::scoped_refptr<AudioEncoderFactory> audio_encoder_factory,
1058 rtc::scoped_refptr<AudioDecoderFactory> audio_decoder_factory);
1059
1060// Deprecated variant of the above.
1061// TODO(kwiberg): Remove.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +00001062rtc::scoped_refptr<PeerConnectionFactoryInterface>
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001063CreatePeerConnectionFactory();
1064
1065// Create a new instance of PeerConnectionFactoryInterface.
Taylor Brandstettera8415fe2016-03-23 10:38:07 -07001066//
danilchape9021a32016-05-17 01:52:02 -07001067// |network_thread|, |worker_thread| and |signaling_thread| are
1068// the only mandatory parameters.
Taylor Brandstettera8415fe2016-03-23 10:38:07 -07001069//
deadbeefb10f32f2017-02-08 01:38:21 -08001070// If non-null, a reference is added to |default_adm|, and ownership of
1071// |video_encoder_factory| and |video_decoder_factory| is transferred to the
1072// returned factory.
1073// TODO(deadbeef): Use rtc::scoped_refptr<> and std::unique_ptr<> to make this
1074// ownership transfer and ref counting more obvious.
danilchape9021a32016-05-17 01:52:02 -07001075rtc::scoped_refptr<PeerConnectionFactoryInterface> CreatePeerConnectionFactory(
1076 rtc::Thread* network_thread,
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52 +00001077 rtc::Thread* worker_thread,
1078 rtc::Thread* signaling_thread,
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001079 AudioDeviceModule* default_adm,
kwiberg1e4e8cb2017-01-31 01:48:08 -08001080 rtc::scoped_refptr<AudioEncoderFactory> audio_encoder_factory,
1081 rtc::scoped_refptr<AudioDecoderFactory> audio_decoder_factory,
1082 cricket::WebRtcVideoEncoderFactory* video_encoder_factory,
1083 cricket::WebRtcVideoDecoderFactory* video_decoder_factory);
1084
1085// Deprecated variant of the above.
1086// TODO(kwiberg): Remove.
1087rtc::scoped_refptr<PeerConnectionFactoryInterface> CreatePeerConnectionFactory(
1088 rtc::Thread* network_thread,
1089 rtc::Thread* worker_thread,
1090 rtc::Thread* signaling_thread,
1091 AudioDeviceModule* default_adm,
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001092 cricket::WebRtcVideoEncoderFactory* encoder_factory,
1093 cricket::WebRtcVideoDecoderFactory* decoder_factory);
1094
peah17675ce2017-06-30 07:24:04 -07001095// Create a new instance of PeerConnectionFactoryInterface with optional
1096// external audio mixed and audio processing modules.
1097//
1098// If |audio_mixer| is null, an internal audio mixer will be created and used.
1099// If |audio_processing| is null, an internal audio processing module will be
1100// created and used.
1101rtc::scoped_refptr<PeerConnectionFactoryInterface> CreatePeerConnectionFactory(
1102 rtc::Thread* network_thread,
1103 rtc::Thread* worker_thread,
1104 rtc::Thread* signaling_thread,
1105 AudioDeviceModule* default_adm,
1106 rtc::scoped_refptr<AudioEncoderFactory> audio_encoder_factory,
1107 rtc::scoped_refptr<AudioDecoderFactory> audio_decoder_factory,
1108 cricket::WebRtcVideoEncoderFactory* video_encoder_factory,
1109 cricket::WebRtcVideoDecoderFactory* video_decoder_factory,
1110 rtc::scoped_refptr<AudioMixer> audio_mixer,
1111 rtc::scoped_refptr<AudioProcessing> audio_processing);
1112
gyzhou95aa9642016-12-13 14:06:26 -08001113// Create a new instance of PeerConnectionFactoryInterface with external audio
1114// mixer.
1115//
1116// If |audio_mixer| is null, an internal audio mixer will be created and used.
1117rtc::scoped_refptr<PeerConnectionFactoryInterface>
1118CreatePeerConnectionFactoryWithAudioMixer(
1119 rtc::Thread* network_thread,
1120 rtc::Thread* worker_thread,
1121 rtc::Thread* signaling_thread,
1122 AudioDeviceModule* default_adm,
kwiberg1e4e8cb2017-01-31 01:48:08 -08001123 rtc::scoped_refptr<AudioEncoderFactory> audio_encoder_factory,
1124 rtc::scoped_refptr<AudioDecoderFactory> audio_decoder_factory,
1125 cricket::WebRtcVideoEncoderFactory* video_encoder_factory,
1126 cricket::WebRtcVideoDecoderFactory* video_decoder_factory,
1127 rtc::scoped_refptr<AudioMixer> audio_mixer);
1128
1129// Deprecated variant of the above.
1130// TODO(kwiberg): Remove.
1131rtc::scoped_refptr<PeerConnectionFactoryInterface>
1132CreatePeerConnectionFactoryWithAudioMixer(
1133 rtc::Thread* network_thread,
1134 rtc::Thread* worker_thread,
1135 rtc::Thread* signaling_thread,
1136 AudioDeviceModule* default_adm,
gyzhou95aa9642016-12-13 14:06:26 -08001137 cricket::WebRtcVideoEncoderFactory* encoder_factory,
1138 cricket::WebRtcVideoDecoderFactory* decoder_factory,
1139 rtc::scoped_refptr<AudioMixer> audio_mixer);
1140
danilchape9021a32016-05-17 01:52:02 -07001141// Create a new instance of PeerConnectionFactoryInterface.
1142// Same thread is used as worker and network thread.
danilchape9021a32016-05-17 01:52:02 -07001143inline rtc::scoped_refptr<PeerConnectionFactoryInterface>
1144CreatePeerConnectionFactory(
1145 rtc::Thread* worker_and_network_thread,
1146 rtc::Thread* signaling_thread,
1147 AudioDeviceModule* default_adm,
kwiberg1e4e8cb2017-01-31 01:48:08 -08001148 rtc::scoped_refptr<AudioEncoderFactory> audio_encoder_factory,
1149 rtc::scoped_refptr<AudioDecoderFactory> audio_decoder_factory,
1150 cricket::WebRtcVideoEncoderFactory* video_encoder_factory,
1151 cricket::WebRtcVideoDecoderFactory* video_decoder_factory) {
1152 return CreatePeerConnectionFactory(
1153 worker_and_network_thread, worker_and_network_thread, signaling_thread,
1154 default_adm, audio_encoder_factory, audio_decoder_factory,
1155 video_encoder_factory, video_decoder_factory);
1156}
1157
1158// Deprecated variant of the above.
1159// TODO(kwiberg): Remove.
1160inline rtc::scoped_refptr<PeerConnectionFactoryInterface>
1161CreatePeerConnectionFactory(
1162 rtc::Thread* worker_and_network_thread,
1163 rtc::Thread* signaling_thread,
1164 AudioDeviceModule* default_adm,
danilchape9021a32016-05-17 01:52:02 -07001165 cricket::WebRtcVideoEncoderFactory* encoder_factory,
1166 cricket::WebRtcVideoDecoderFactory* decoder_factory) {
1167 return CreatePeerConnectionFactory(
1168 worker_and_network_thread, worker_and_network_thread, signaling_thread,
1169 default_adm, encoder_factory, decoder_factory);
1170}
1171
zhihuang38ede132017-06-15 12:52:32 -07001172// This is a lower-level version of the CreatePeerConnectionFactory functions
1173// above. It's implemented in the "peerconnection" build target, whereas the
1174// above methods are only implemented in the broader "libjingle_peerconnection"
1175// build target, which pulls in the implementations of every module webrtc may
1176// use.
1177//
1178// If an application knows it will only require certain modules, it can reduce
1179// webrtc's impact on its binary size by depending only on the "peerconnection"
1180// target and the modules the application requires, using
1181// CreateModularPeerConnectionFactory instead of one of the
1182// CreatePeerConnectionFactory methods above. For example, if an application
1183// only uses WebRTC for audio, it can pass in null pointers for the
1184// video-specific interfaces, and omit the corresponding modules from its
1185// build.
1186//
1187// If |network_thread| or |worker_thread| are null, the PeerConnectionFactory
1188// will create the necessary thread internally. If |signaling_thread| is null,
1189// the PeerConnectionFactory will use the thread on which this method is called
1190// as the signaling thread, wrapping it in an rtc::Thread object if needed.
1191//
1192// If non-null, a reference is added to |default_adm|, and ownership of
1193// |video_encoder_factory| and |video_decoder_factory| is transferred to the
1194// returned factory.
1195//
peaha9cc40b2017-06-29 08:32:09 -07001196// If |audio_mixer| is null, an internal audio mixer will be created and used.
1197//
zhihuang38ede132017-06-15 12:52:32 -07001198// TODO(deadbeef): Use rtc::scoped_refptr<> and std::unique_ptr<> to make this
1199// ownership transfer and ref counting more obvious.
1200//
1201// TODO(deadbeef): Encapsulate these modules in a struct, so that when a new
1202// module is inevitably exposed, we can just add a field to the struct instead
1203// of adding a whole new CreateModularPeerConnectionFactory overload.
1204rtc::scoped_refptr<PeerConnectionFactoryInterface>
1205CreateModularPeerConnectionFactory(
1206 rtc::Thread* network_thread,
1207 rtc::Thread* worker_thread,
1208 rtc::Thread* signaling_thread,
1209 AudioDeviceModule* default_adm,
1210 rtc::scoped_refptr<AudioEncoderFactory> audio_encoder_factory,
1211 rtc::scoped_refptr<AudioDecoderFactory> audio_decoder_factory,
1212 cricket::WebRtcVideoEncoderFactory* video_encoder_factory,
1213 cricket::WebRtcVideoDecoderFactory* video_decoder_factory,
1214 rtc::scoped_refptr<AudioMixer> audio_mixer,
1215 std::unique_ptr<cricket::MediaEngineInterface> media_engine,
1216 std::unique_ptr<CallFactoryInterface> call_factory,
1217 std::unique_ptr<RtcEventLogFactoryInterface> event_log_factory);
1218
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001219} // namespace webrtc
1220
Henrik Kjellander15583c12016-02-10 10:53:12 +01001221#endif // WEBRTC_API_PEERCONNECTIONINTERFACE_H_