blob: a682459a137caaddca625a5712790e98b22b0511 [file] [log] [blame]
henrike@webrtc.org28e20752013-07-10 00:45:361/*
kjellanderb24317b2016-02-10 15:54:432 * Copyright 2012 The WebRTC project authors. All Rights Reserved.
henrike@webrtc.org28e20752013-07-10 00:45:363 *
kjellanderb24317b2016-02-10 15:54:434 * 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:369 */
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:3613//
deadbeefb10f32f2017-02-08 09:38:2114// 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:3619// 1. Create a PeerConnectionFactoryInterface. Check constructors for more
20// information about input parameters.
deadbeefb10f32f2017-02-08 09:38:2121//
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:3634// observer function OnIceCandidate. The candidates must also be serialized and
35// sent to the remote peer.
deadbeefb10f32f2017-02-08 09:38:2136//
henrike@webrtc.org28e20752013-07-10 00:45:3637// 6. Once an answer is received from the remote peer, call
deadbeefb10f32f2017-02-08 09:38:2138// SetRemoteDescription with the remote answer.
39//
henrike@webrtc.org28e20752013-07-10 00:45:3640// 7. Once a remote candidate is received from the remote peer, provide it to
deadbeefb10f32f2017-02-08 09:38:2141// 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:3649// 1. Create PeerConnectionFactoryInterface if it doesn't exist.
deadbeefb10f32f2017-02-08 09:38:2150//
henrike@webrtc.org28e20752013-07-10 00:45:3651// 2. Create a new PeerConnection.
deadbeefb10f32f2017-02-08 09:38:2152//
henrike@webrtc.org28e20752013-07-10 00:45:3653// 3. Provide the remote offer to the new PeerConnection object by calling
deadbeefb10f32f2017-02-08 09:38:2154// SetRemoteDescription.
55//
henrike@webrtc.org28e20752013-07-10 00:45:3656// 4. Generate an answer to the remote offer by calling CreateAnswer and send it
57// back to the remote peer.
deadbeefb10f32f2017-02-08 09:38:2158//
henrike@webrtc.org28e20752013-07-10 00:45:3659// 5. Provide the local answer to the new PeerConnection by calling
deadbeefb10f32f2017-02-08 09:38:2160// 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:3666
Mirko Bonadei92ea95e2017-09-15 04:47:3167#ifndef API_PEERCONNECTIONINTERFACE_H_
68#define API_PEERCONNECTIONINTERFACE_H_
henrike@webrtc.org28e20752013-07-10 00:45:3669
kwibergd1fe2812016-04-27 13:47:2970#include <memory>
henrike@webrtc.org28e20752013-07-10 00:45:3671#include <string>
kwiberg0eb15ed2015-12-17 11:04:1572#include <utility>
henrike@webrtc.org28e20752013-07-10 00:45:3673#include <vector>
74
Mirko Bonadei92ea95e2017-09-15 04:47:3175#include "api/audio_codecs/audio_decoder_factory.h"
76#include "api/audio_codecs/audio_encoder_factory.h"
77#include "api/datachannelinterface.h"
78#include "api/dtmfsenderinterface.h"
79#include "api/jsep.h"
80#include "api/mediastreaminterface.h"
81#include "api/rtcerror.h"
Elad Alon99c3fe52017-10-13 14:29:4082#include "api/rtceventlogoutput.h"
Mirko Bonadei92ea95e2017-09-15 04:47:3183#include "api/rtpreceiverinterface.h"
84#include "api/rtpsenderinterface.h"
85#include "api/stats/rtcstatscollectorcallback.h"
86#include "api/statstypes.h"
Jonas Orelandbdcee282017-10-10 12:01:4087#include "api/turncustomizer.h"
Mirko Bonadei92ea95e2017-09-15 04:47:3188#include "api/umametrics.h"
89#include "call/callfactoryinterface.h"
90#include "logging/rtc_event_log/rtc_event_log_factory_interface.h"
91#include "media/base/mediachannel.h"
92#include "media/base/videocapturer.h"
93#include "p2p/base/portallocator.h"
Mirko Bonadei92ea95e2017-09-15 04:47:3194#include "rtc_base/network.h"
95#include "rtc_base/rtccertificate.h"
96#include "rtc_base/rtccertificategenerator.h"
97#include "rtc_base/socketaddress.h"
98#include "rtc_base/sslstreamadapter.h"
henrike@webrtc.org28e20752013-07-10 00:45:3699
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52100namespace rtc {
jiayl@webrtc.org61e00b02015-03-04 22:17:38101class SSLIdentity;
henrike@webrtc.org28e20752013-07-10 00:45:36102class Thread;
103}
104
105namespace cricket {
zhihuang38ede132017-06-15 19:52:32106class MediaEngineInterface;
henrike@webrtc.org28e20752013-07-10 00:45:36107class WebRtcVideoDecoderFactory;
108class WebRtcVideoEncoderFactory;
109}
110
111namespace webrtc {
112class AudioDeviceModule;
gyzhou95aa9642016-12-13 22:06:26113class AudioMixer;
zhihuang38ede132017-06-15 19:52:32114class CallFactoryInterface;
henrike@webrtc.org28e20752013-07-10 00:45:36115class MediaConstraintsInterface;
Magnus Jedvert58b03162017-09-15 17:02:47116class VideoDecoderFactory;
117class VideoEncoderFactory;
henrike@webrtc.org28e20752013-07-10 00:45:36118
119// MediaStream container interface.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52120class StreamCollectionInterface : public rtc::RefCountInterface {
henrike@webrtc.org28e20752013-07-10 00:45:36121 public:
122 // TODO(ronghuawu): Update the function names to c++ style, e.g. find -> Find.
123 virtual size_t count() = 0;
124 virtual MediaStreamInterface* at(size_t index) = 0;
125 virtual MediaStreamInterface* find(const std::string& label) = 0;
126 virtual MediaStreamTrackInterface* FindAudioTrack(
127 const std::string& id) = 0;
128 virtual MediaStreamTrackInterface* FindVideoTrack(
129 const std::string& id) = 0;
130
131 protected:
132 // Dtor protected as objects shouldn't be deleted via this interface.
133 ~StreamCollectionInterface() {}
134};
135
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52136class StatsObserver : public rtc::RefCountInterface {
henrike@webrtc.org28e20752013-07-10 00:45:36137 public:
nissee8abe3e2017-01-18 13:00:34138 virtual void OnComplete(const StatsReports& reports) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36139
140 protected:
141 virtual ~StatsObserver() {}
142};
143
Steve Anton79e79602017-11-20 18:25:56144// For now, kDefault is interpreted as kPlanB.
145// TODO(bugs.webrtc.org/8530): Switch default to kUnifiedPlan.
146enum class SdpSemantics { kDefault, kPlanB, kUnifiedPlan };
147
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52148class PeerConnectionInterface : public rtc::RefCountInterface {
henrike@webrtc.org28e20752013-07-10 00:45:36149 public:
150 // See http://dev.w3.org/2011/webrtc/editor/webrtc.html#state-definitions .
151 enum SignalingState {
152 kStable,
153 kHaveLocalOffer,
154 kHaveLocalPrAnswer,
155 kHaveRemoteOffer,
156 kHaveRemotePrAnswer,
157 kClosed,
158 };
159
henrike@webrtc.org28e20752013-07-10 00:45:36160 enum IceGatheringState {
161 kIceGatheringNew,
162 kIceGatheringGathering,
163 kIceGatheringComplete
164 };
165
166 enum IceConnectionState {
167 kIceConnectionNew,
168 kIceConnectionChecking,
169 kIceConnectionConnected,
170 kIceConnectionCompleted,
171 kIceConnectionFailed,
172 kIceConnectionDisconnected,
173 kIceConnectionClosed,
Guo-wei Shieh3d564c12015-08-19 23:51:15174 kIceConnectionMax,
henrike@webrtc.org28e20752013-07-10 00:45:36175 };
176
hnsl04833622017-01-09 16:35:45177 // TLS certificate policy.
178 enum TlsCertPolicy {
179 // For TLS based protocols, ensure the connection is secure by not
180 // circumventing certificate validation.
181 kTlsCertPolicySecure,
182 // For TLS based protocols, disregard security completely by skipping
183 // certificate validation. This is insecure and should never be used unless
184 // security is irrelevant in that particular context.
185 kTlsCertPolicyInsecureNoCheck,
186 };
187
henrike@webrtc.org28e20752013-07-10 00:45:36188 struct IceServer {
Joachim Bauch7c4e7452015-05-28 21:06:30189 // TODO(jbauch): Remove uri when all code using it has switched to urls.
Emad Omaradab1d2d2017-06-16 22:43:11190 // List of URIs associated with this server. Valid formats are described
191 // in RFC7064 and RFC7065, and more may be added in the future. The "host"
192 // part of the URI may contain either an IP address or a hostname.
henrike@webrtc.org28e20752013-07-10 00:45:36193 std::string uri;
Joachim Bauch7c4e7452015-05-28 21:06:30194 std::vector<std::string> urls;
henrike@webrtc.org28e20752013-07-10 00:45:36195 std::string username;
196 std::string password;
hnsl04833622017-01-09 16:35:45197 TlsCertPolicy tls_cert_policy = kTlsCertPolicySecure;
Emad Omaradab1d2d2017-06-16 22:43:11198 // If the URIs in |urls| only contain IP addresses, this field can be used
199 // to indicate the hostname, which may be necessary for TLS (using the SNI
200 // extension). If |urls| itself contains the hostname, this isn't
201 // necessary.
202 std::string hostname;
Diogo Real1dca9d52017-08-29 19:18:32203 // List of protocols to be used in the TLS ALPN extension.
204 std::vector<std::string> tls_alpn_protocols;
Diogo Real7bd1f1b2017-09-08 19:50:41205 // List of elliptic curves to be used in the TLS elliptic curves extension.
206 std::vector<std::string> tls_elliptic_curves;
hnsl04833622017-01-09 16:35:45207
deadbeefd1a38b52016-12-10 21:15:33208 bool operator==(const IceServer& o) const {
209 return uri == o.uri && urls == o.urls && username == o.username &&
Emad Omaradab1d2d2017-06-16 22:43:11210 password == o.password && tls_cert_policy == o.tls_cert_policy &&
Diogo Real1dca9d52017-08-29 19:18:32211 hostname == o.hostname &&
Diogo Real7bd1f1b2017-09-08 19:50:41212 tls_alpn_protocols == o.tls_alpn_protocols &&
213 tls_elliptic_curves == o.tls_elliptic_curves;
deadbeefd1a38b52016-12-10 21:15:33214 }
215 bool operator!=(const IceServer& o) const { return !(*this == o); }
henrike@webrtc.org28e20752013-07-10 00:45:36216 };
217 typedef std::vector<IceServer> IceServers;
218
buildbot@webrtc.org41451d42014-05-03 05:39:45219 enum IceTransportsType {
pthatcher@webrtc.orgfd630a52015-01-14 23:19:06220 // TODO(pthatcher): Rename these kTransporTypeXXX, but update
221 // Chromium at the same time.
buildbot@webrtc.org41451d42014-05-03 05:39:45222 kNone,
223 kRelay,
224 kNoHost,
225 kAll
226 };
227
pthatcher@webrtc.orgfd630a52015-01-14 23:19:06228 // https://tools.ietf.org/html/draft-ietf-rtcweb-jsep-08#section-4.1.1
229 enum BundlePolicy {
230 kBundlePolicyBalanced,
231 kBundlePolicyMaxBundle,
232 kBundlePolicyMaxCompat
233 };
buildbot@webrtc.org41451d42014-05-03 05:39:45234
Peter Thatcheraf55ccc2015-05-21 14:48:41235 // https://tools.ietf.org/html/draft-ietf-rtcweb-jsep-09#section-4.1.1
236 enum RtcpMuxPolicy {
237 kRtcpMuxPolicyNegotiate,
238 kRtcpMuxPolicyRequire,
239 };
240
Jiayang Liucac1b382015-04-30 19:35:24241 enum TcpCandidatePolicy {
242 kTcpCandidatePolicyEnabled,
243 kTcpCandidatePolicyDisabled
244 };
245
honghaiz60347052016-06-01 01:29:12246 enum CandidateNetworkPolicy {
247 kCandidateNetworkPolicyAll,
248 kCandidateNetworkPolicyLowCost
249 };
250
honghaiz1f429e32015-09-28 14:57:34251 enum ContinualGatheringPolicy {
252 GATHER_ONCE,
253 GATHER_CONTINUALLY
254 };
255
Honghai Zhangf7ddc062016-09-01 22:34:01256 enum class RTCConfigurationType {
257 // A configuration that is safer to use, despite not having the best
258 // performance. Currently this is the default configuration.
259 kSafe,
260 // An aggressive configuration that has better performance, although it
261 // may be riskier and may need extra support in the application.
262 kAggressive
263 };
264
Henrik Boström87713d02015-08-25 07:53:21265 // TODO(hbos): Change into class with private data and public getters.
nissec36b31b2016-04-12 06:25:29266 // TODO(nisse): In particular, accessing fields directly from an
267 // application is brittle, since the organization mirrors the
268 // organization of the implementation, which isn't stable. So we
269 // need getters and setters at least for fields which applications
270 // are interested in.
pthatcher@webrtc.orgfd630a52015-01-14 23:19:06271 struct RTCConfiguration {
Niels Möller71bdda02016-03-31 10:59:59272 // This struct is subject to reorganization, both for naming
273 // consistency, and to group settings to match where they are used
274 // in the implementation. To do that, we need getter and setter
275 // methods for all settings which are of interest to applications,
276 // Chrome in particular.
277
Honghai Zhangf7ddc062016-09-01 22:34:01278 RTCConfiguration() = default;
oprypin803dc292017-02-01 09:55:59279 explicit RTCConfiguration(RTCConfigurationType type) {
Honghai Zhangf7ddc062016-09-01 22:34:01280 if (type == RTCConfigurationType::kAggressive) {
Honghai Zhangaecd9822016-09-02 23:58:17281 // These parameters are also defined in Java and IOS configurations,
282 // so their values may be overwritten by the Java or IOS configuration.
283 bundle_policy = kBundlePolicyMaxBundle;
284 rtcp_mux_policy = kRtcpMuxPolicyRequire;
285 ice_connection_receiving_timeout =
286 kAggressiveIceConnectionReceivingTimeout;
287
288 // These parameters are not defined in Java or IOS configuration,
289 // so their values will not be overwritten.
290 enable_ice_renomination = true;
Honghai Zhangf7ddc062016-09-01 22:34:01291 redetermine_role_on_ice_restart = false;
292 }
Honghai Zhangbfd398c2016-08-31 05:07:42293 }
294
deadbeef293e9262017-01-11 20:28:30295 bool operator==(const RTCConfiguration& o) const;
296 bool operator!=(const RTCConfiguration& o) const;
297
nissec36b31b2016-04-12 06:25:29298 bool dscp() { return media_config.enable_dscp; }
299 void set_dscp(bool enable) { media_config.enable_dscp = enable; }
Niels Möller71bdda02016-03-31 10:59:59300
301 // TODO(nisse): The corresponding flag in MediaConfig and
302 // elsewhere should be renamed enable_cpu_adaptation.
nissec36b31b2016-04-12 06:25:29303 bool cpu_adaptation() {
304 return media_config.video.enable_cpu_overuse_detection;
305 }
Niels Möller71bdda02016-03-31 10:59:59306 void set_cpu_adaptation(bool enable) {
nissec36b31b2016-04-12 06:25:29307 media_config.video.enable_cpu_overuse_detection = enable;
Niels Möller71bdda02016-03-31 10:59:59308 }
309
nissec36b31b2016-04-12 06:25:29310 bool suspend_below_min_bitrate() {
311 return media_config.video.suspend_below_min_bitrate;
312 }
Niels Möller71bdda02016-03-31 10:59:59313 void set_suspend_below_min_bitrate(bool enable) {
nissec36b31b2016-04-12 06:25:29314 media_config.video.suspend_below_min_bitrate = enable;
Niels Möller71bdda02016-03-31 10:59:59315 }
316
317 // TODO(nisse): The negation in the corresponding MediaConfig
318 // attribute is inconsistent, and it should be renamed at some
319 // point.
nissec36b31b2016-04-12 06:25:29320 bool prerenderer_smoothing() {
321 return !media_config.video.disable_prerenderer_smoothing;
322 }
Niels Möller71bdda02016-03-31 10:59:59323 void set_prerenderer_smoothing(bool enable) {
nissec36b31b2016-04-12 06:25:29324 media_config.video.disable_prerenderer_smoothing = !enable;
Niels Möller71bdda02016-03-31 10:59:59325 }
326
honghaiz4edc39c2015-09-01 16:53:56327 static const int kUndefined = -1;
328 // Default maximum number of packets in the audio jitter buffer.
329 static const int kAudioJitterBufferMaxPackets = 50;
Honghai Zhangaecd9822016-09-02 23:58:17330 // ICE connection receiving timeout for aggressive configuration.
331 static const int kAggressiveIceConnectionReceivingTimeout = 1000;
deadbeefb10f32f2017-02-08 09:38:21332
333 ////////////////////////////////////////////////////////////////////////
334 // The below few fields mirror the standard RTCConfiguration dictionary:
335 // https://www.w3.org/TR/webrtc/#rtcconfiguration-dictionary
336 ////////////////////////////////////////////////////////////////////////
337
pthatcher@webrtc.orgfd630a52015-01-14 23:19:06338 // TODO(pthatcher): Rename this ice_servers, but update Chromium
339 // at the same time.
340 IceServers servers;
deadbeefb10f32f2017-02-08 09:38:21341 // TODO(pthatcher): Rename this ice_transport_type, but update
342 // Chromium at the same time.
343 IceTransportsType type = kAll;
Taylor Brandstettera1c30352016-05-13 15:15:11344 BundlePolicy bundle_policy = kBundlePolicyBalanced;
zhihuang4dfb8ce2016-11-23 18:30:12345 RtcpMuxPolicy rtcp_mux_policy = kRtcpMuxPolicyRequire;
deadbeefb10f32f2017-02-08 09:38:21346 std::vector<rtc::scoped_refptr<rtc::RTCCertificate>> certificates;
347 int ice_candidate_pool_size = 0;
348
349 //////////////////////////////////////////////////////////////////////////
350 // The below fields correspond to constraints from the deprecated
351 // constraints interface for constructing a PeerConnection.
352 //
353 // rtc::Optional fields can be "missing", in which case the implementation
354 // default will be used.
355 //////////////////////////////////////////////////////////////////////////
356
357 // If set to true, don't gather IPv6 ICE candidates.
358 // TODO(deadbeef): Remove this? IPv6 support has long stopped being
359 // experimental
360 bool disable_ipv6 = false;
361
zhihuangb09b3f92017-03-07 22:40:51362 // If set to true, don't gather IPv6 ICE candidates on Wi-Fi.
363 // Only intended to be used on specific devices. Certain phones disable IPv6
364 // when the screen is turned off and it would be better to just disable the
365 // IPv6 ICE candidates on Wi-Fi in those cases.
366 bool disable_ipv6_on_wifi = false;
367
deadbeefd21eab3e2017-07-26 23:50:11368 // By default, the PeerConnection will use a limited number of IPv6 network
369 // interfaces, in order to avoid too many ICE candidate pairs being created
370 // and delaying ICE completion.
371 //
372 // Can be set to INT_MAX to effectively disable the limit.
373 int max_ipv6_networks = cricket::kDefaultMaxIPv6Networks;
374
deadbeefb10f32f2017-02-08 09:38:21375 // If set to true, use RTP data channels instead of SCTP.
376 // TODO(deadbeef): Remove this. We no longer commit to supporting RTP data
377 // channels, though some applications are still working on moving off of
378 // them.
379 bool enable_rtp_data_channel = false;
380
381 // Minimum bitrate at which screencast video tracks will be encoded at.
382 // This means adding padding bits up to this bitrate, which can help
383 // when switching from a static scene to one with motion.
384 rtc::Optional<int> screencast_min_bitrate;
385
386 // Use new combined audio/video bandwidth estimation?
387 rtc::Optional<bool> combined_audio_video_bwe;
388
389 // Can be used to disable DTLS-SRTP. This should never be done, but can be
390 // useful for testing purposes, for example in setting up a loopback call
391 // with a single PeerConnection.
392 rtc::Optional<bool> enable_dtls_srtp;
393
394 /////////////////////////////////////////////////
395 // The below fields are not part of the standard.
396 /////////////////////////////////////////////////
397
398 // Can be used to disable TCP candidate generation.
Taylor Brandstettera1c30352016-05-13 15:15:11399 TcpCandidatePolicy tcp_candidate_policy = kTcpCandidatePolicyEnabled;
deadbeefb10f32f2017-02-08 09:38:21400
401 // Can be used to avoid gathering candidates for a "higher cost" network,
402 // if a lower cost one exists. For example, if both Wi-Fi and cellular
403 // interfaces are available, this could be used to avoid using the cellular
404 // interface.
honghaiz60347052016-06-01 01:29:12405 CandidateNetworkPolicy candidate_network_policy =
406 kCandidateNetworkPolicyAll;
deadbeefb10f32f2017-02-08 09:38:21407
408 // The maximum number of packets that can be stored in the NetEq audio
409 // jitter buffer. Can be reduced to lower tolerated audio latency.
Taylor Brandstettera1c30352016-05-13 15:15:11410 int audio_jitter_buffer_max_packets = kAudioJitterBufferMaxPackets;
deadbeefb10f32f2017-02-08 09:38:21411
412 // Whether to use the NetEq "fast mode" which will accelerate audio quicker
413 // if it falls behind.
Taylor Brandstettera1c30352016-05-13 15:15:11414 bool audio_jitter_buffer_fast_accelerate = false;
deadbeefb10f32f2017-02-08 09:38:21415
416 // Timeout in milliseconds before an ICE candidate pair is considered to be
417 // "not receiving", after which a lower priority candidate pair may be
418 // selected.
419 int ice_connection_receiving_timeout = kUndefined;
420
421 // Interval in milliseconds at which an ICE "backup" candidate pair will be
422 // pinged. This is a candidate pair which is not actively in use, but may
423 // be switched to if the active candidate pair becomes unusable.
424 //
425 // This is relevant mainly to Wi-Fi/cell handoff; the application may not
426 // want this backup cellular candidate pair pinged frequently, since it
427 // consumes data/battery.
428 int ice_backup_candidate_pair_ping_interval = kUndefined;
429
430 // Can be used to enable continual gathering, which means new candidates
431 // will be gathered as network interfaces change. Note that if continual
432 // gathering is used, the candidate removal API should also be used, to
433 // avoid an ever-growing list of candidates.
Taylor Brandstettera1c30352016-05-13 15:15:11434 ContinualGatheringPolicy continual_gathering_policy = GATHER_ONCE;
deadbeefb10f32f2017-02-08 09:38:21435
436 // If set to true, candidate pairs will be pinged in order of most likely
437 // to work (which means using a TURN server, generally), rather than in
438 // standard priority order.
Taylor Brandstettera1c30352016-05-13 15:15:11439 bool prioritize_most_likely_ice_candidate_pairs = false;
deadbeefb10f32f2017-02-08 09:38:21440
nissec36b31b2016-04-12 06:25:29441 struct cricket::MediaConfig media_config;
deadbeefb10f32f2017-02-08 09:38:21442
deadbeefb10f32f2017-02-08 09:38:21443 // If set to true, only one preferred TURN allocation will be used per
444 // network interface. UDP is preferred over TCP and IPv6 over IPv4. This
445 // can be used to cut down on the number of candidate pairings.
Honghai Zhangb9e7b4a2016-07-01 03:52:02446 bool prune_turn_ports = false;
deadbeefb10f32f2017-02-08 09:38:21447
Taylor Brandstettere9851112016-07-01 18:11:13448 // If set to true, this means the ICE transport should presume TURN-to-TURN
449 // candidate pairs will succeed, even before a binding response is received.
deadbeefb10f32f2017-02-08 09:38:21450 // This can be used to optimize the initial connection time, since the DTLS
451 // handshake can begin immediately.
Taylor Brandstettere9851112016-07-01 18:11:13452 bool presume_writable_when_fully_relayed = false;
deadbeefb10f32f2017-02-08 09:38:21453
Honghai Zhang4cedf2b2016-08-31 15:18:11454 // If true, "renomination" will be added to the ice options in the transport
455 // description.
deadbeefb10f32f2017-02-08 09:38:21456 // See: https://tools.ietf.org/html/draft-thatcher-ice-renomination-00
Honghai Zhang4cedf2b2016-08-31 15:18:11457 bool enable_ice_renomination = false;
deadbeefb10f32f2017-02-08 09:38:21458
459 // If true, the ICE role is re-determined when the PeerConnection sets a
460 // local transport description that indicates an ICE restart.
461 //
462 // This is standard RFC5245 ICE behavior, but causes unnecessary role
463 // thrashing, so an application may wish to avoid it. This role
464 // re-determining was removed in ICEbis (ICE v2).
Honghai Zhangbfd398c2016-08-31 05:07:42465 bool redetermine_role_on_ice_restart = true;
deadbeefb10f32f2017-02-08 09:38:21466
skvlad51072462017-02-02 19:50:14467 // If set, the min interval (max rate) at which we will send ICE checks
468 // (STUN pings), in milliseconds.
469 rtc::Optional<int> ice_check_min_interval;
deadbeefb10f32f2017-02-08 09:38:21470
Steve Anton300bf8e2017-07-14 17:13:10471 // ICE Periodic Regathering
472 // If set, WebRTC will periodically create and propose candidates without
473 // starting a new ICE generation. The regathering happens continuously with
474 // interval specified in milliseconds by the uniform distribution [a, b].
475 rtc::Optional<rtc::IntervalRange> ice_regather_interval_range;
476
Jonas Orelandbdcee282017-10-10 12:01:40477 // Optional TurnCustomizer.
478 // With this class one can modify outgoing TURN messages.
479 // The object passed in must remain valid until PeerConnection::Close() is
480 // called.
481 webrtc::TurnCustomizer* turn_customizer = nullptr;
482
Steve Anton79e79602017-11-20 18:25:56483 // Configure the SDP semantics used by this PeerConnection. Note that the
484 // WebRTC 1.0 specification requires kUnifiedPlan semantics. The
485 // RtpTransceiver API is only available with kUnifiedPlan semantics.
486 //
487 // kPlanB will cause PeerConnection to create offers and answers with at
488 // most one audio and one video m= section with multiple RtpSenders and
489 // RtpReceivers specified as multiple a=ssrc lines within the section. This
490 // will also cause PeerConnection to reject offers/answers with multiple m=
491 // sections of the same media type.
492 //
493 // kUnifiedPlan will cause PeerConnection to create offers and answers with
494 // multiple m= sections where each m= section maps to one RtpSender and one
495 // RtpReceiver (an RtpTransceiver), either both audio or both video. Plan B
496 // style offers or answers will be rejected in calls to SetLocalDescription
497 // or SetRemoteDescription.
498 //
499 // For users who only send at most one audio and one video track, this
500 // choice does not matter and should be left as kDefault.
501 //
502 // For users who wish to send multiple audio/video streams and need to stay
503 // interoperable with legacy WebRTC implementations, specify kPlanB.
504 //
505 // For users who wish to send multiple audio/video streams and/or wish to
506 // use the new RtpTransceiver API, specify kUnifiedPlan.
507 //
508 // TODO(steveanton): Implement support for kUnifiedPlan.
509 SdpSemantics sdp_semantics = SdpSemantics::kDefault;
510
deadbeef293e9262017-01-11 20:28:30511 //
512 // Don't forget to update operator== if adding something.
513 //
buildbot@webrtc.org41451d42014-05-03 05:39:45514 };
515
deadbeefb10f32f2017-02-08 09:38:21516 // See: https://www.w3.org/TR/webrtc/#idl-def-rtcofferansweroptions
jiayl@webrtc.orgb18bf5e2014-08-04 18:34:16517 struct RTCOfferAnswerOptions {
518 static const int kUndefined = -1;
519 static const int kMaxOfferToReceiveMedia = 1;
520
521 // The default value for constraint offerToReceiveX:true.
522 static const int kOfferToReceiveMediaTrue = 1;
523
deadbeefb10f32f2017-02-08 09:38:21524 // These have been removed from the standard in favor of the "transceiver"
525 // API, but given that we don't support that API, we still have them here.
526 //
527 // offer_to_receive_X set to 1 will cause a media description to be
528 // generated in the offer, even if no tracks of that type have been added.
529 // Values greater than 1 are treated the same.
530 //
531 // If set to 0, the generated directional attribute will not include the
532 // "recv" direction (meaning it will be "sendonly" or "inactive".
Honghai Zhang4cedf2b2016-08-31 15:18:11533 int offer_to_receive_video = kUndefined;
534 int offer_to_receive_audio = kUndefined;
deadbeefb10f32f2017-02-08 09:38:21535
Honghai Zhang4cedf2b2016-08-31 15:18:11536 bool voice_activity_detection = true;
537 bool ice_restart = false;
deadbeefb10f32f2017-02-08 09:38:21538
539 // If true, will offer to BUNDLE audio/video/data together. Not to be
540 // confused with RTCP mux (multiplexing RTP and RTCP together).
Honghai Zhang4cedf2b2016-08-31 15:18:11541 bool use_rtp_mux = true;
jiayl@webrtc.orgb18bf5e2014-08-04 18:34:16542
Honghai Zhang4cedf2b2016-08-31 15:18:11543 RTCOfferAnswerOptions() = default;
jiayl@webrtc.orgb18bf5e2014-08-04 18:34:16544
545 RTCOfferAnswerOptions(int offer_to_receive_video,
546 int offer_to_receive_audio,
547 bool voice_activity_detection,
548 bool ice_restart,
549 bool use_rtp_mux)
550 : offer_to_receive_video(offer_to_receive_video),
551 offer_to_receive_audio(offer_to_receive_audio),
552 voice_activity_detection(voice_activity_detection),
553 ice_restart(ice_restart),
554 use_rtp_mux(use_rtp_mux) {}
555 };
556
wu@webrtc.orgb9a088b2014-02-13 23:18:49557 // Used by GetStats to decide which stats to include in the stats reports.
558 // |kStatsOutputLevelStandard| includes the standard stats for Javascript API;
559 // |kStatsOutputLevelDebug| includes both the standard stats and additional
560 // stats for debugging purposes.
561 enum StatsOutputLevel {
562 kStatsOutputLevelStandard,
563 kStatsOutputLevelDebug,
564 };
565
henrike@webrtc.org28e20752013-07-10 00:45:36566 // Accessor methods to active local streams.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52567 virtual rtc::scoped_refptr<StreamCollectionInterface>
henrike@webrtc.org28e20752013-07-10 00:45:36568 local_streams() = 0;
569
570 // Accessor methods to remote streams.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52571 virtual rtc::scoped_refptr<StreamCollectionInterface>
henrike@webrtc.org28e20752013-07-10 00:45:36572 remote_streams() = 0;
573
574 // Add a new MediaStream to be sent on this PeerConnection.
575 // Note that a SessionDescription negotiation is needed before the
576 // remote peer can receive the stream.
deadbeefb10f32f2017-02-08 09:38:21577 //
578 // This has been removed from the standard in favor of a track-based API. So,
579 // this is equivalent to simply calling AddTrack for each track within the
580 // stream, with the one difference that if "stream->AddTrack(...)" is called
581 // later, the PeerConnection will automatically pick up the new track. Though
582 // this functionality will be deprecated in the future.
perkj@webrtc.orgfd0efb62014-11-06 12:16:36583 virtual bool AddStream(MediaStreamInterface* stream) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36584
585 // Remove a MediaStream from this PeerConnection.
deadbeefb10f32f2017-02-08 09:38:21586 // Note that a SessionDescription negotiation is needed before the
henrike@webrtc.org28e20752013-07-10 00:45:36587 // remote peer is notified.
588 virtual void RemoveStream(MediaStreamInterface* stream) = 0;
589
deadbeefb10f32f2017-02-08 09:38:21590 // Add a new MediaStreamTrack to be sent on this PeerConnection, and return
591 // the newly created RtpSender.
592 //
deadbeefe1f9d832016-01-14 23:35:42593 // |streams| indicates which stream labels the track should be associated
594 // with.
595 virtual rtc::scoped_refptr<RtpSenderInterface> AddTrack(
596 MediaStreamTrackInterface* track,
nisse7f067662017-03-08 14:59:45597 std::vector<MediaStreamInterface*> streams) = 0;
deadbeefe1f9d832016-01-14 23:35:42598
599 // Remove an RtpSender from this PeerConnection.
600 // Returns true on success.
nisse7f067662017-03-08 14:59:45601 virtual bool RemoveTrack(RtpSenderInterface* sender) = 0;
deadbeefe1f9d832016-01-14 23:35:42602
deadbeef8d60a942017-02-27 22:47:33603 // Returns pointer to a DtmfSender on success. Otherwise returns null.
deadbeefb10f32f2017-02-08 09:38:21604 //
605 // This API is no longer part of the standard; instead DtmfSenders are
606 // obtained from RtpSenders. Which is what the implementation does; it finds
607 // an RtpSender for |track| and just returns its DtmfSender.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52608 virtual rtc::scoped_refptr<DtmfSenderInterface> CreateDtmfSender(
henrike@webrtc.org28e20752013-07-10 00:45:36609 AudioTrackInterface* track) = 0;
610
deadbeef70ab1a12015-09-28 23:53:55611 // TODO(deadbeef): Make these pure virtual once all subclasses implement them.
deadbeefb10f32f2017-02-08 09:38:21612
613 // Creates a sender without a track. Can be used for "early media"/"warmup"
614 // use cases, where the application may want to negotiate video attributes
615 // before a track is available to send.
616 //
617 // The standard way to do this would be through "addTransceiver", but we
618 // don't support that API yet.
619 //
deadbeeffac06552015-11-25 19:26:01620 // |kind| must be "audio" or "video".
deadbeefb10f32f2017-02-08 09:38:21621 //
deadbeefbd7d8f72015-12-19 00:58:44622 // |stream_id| is used to populate the msid attribute; if empty, one will
623 // be generated automatically.
deadbeeffac06552015-11-25 19:26:01624 virtual rtc::scoped_refptr<RtpSenderInterface> CreateSender(
deadbeefbd7d8f72015-12-19 00:58:44625 const std::string& kind,
626 const std::string& stream_id) {
deadbeeffac06552015-11-25 19:26:01627 return rtc::scoped_refptr<RtpSenderInterface>();
628 }
629
deadbeefb10f32f2017-02-08 09:38:21630 // Get all RtpSenders, created either through AddStream, AddTrack, or
631 // CreateSender. Note that these are "Plan B SDP" RtpSenders, not "Unified
632 // Plan SDP" RtpSenders, which means that all senders of a specific media
633 // type share the same media description.
deadbeef70ab1a12015-09-28 23:53:55634 virtual std::vector<rtc::scoped_refptr<RtpSenderInterface>> GetSenders()
635 const {
636 return std::vector<rtc::scoped_refptr<RtpSenderInterface>>();
637 }
638
deadbeefb10f32f2017-02-08 09:38:21639 // Get all RtpReceivers, created when a remote description is applied.
640 // Note that these are "Plan B SDP" RtpReceivers, not "Unified Plan SDP"
641 // RtpReceivers, which means that all receivers of a specific media type
642 // share the same media description.
643 //
644 // It is also possible to have a media description with no associated
645 // RtpReceivers, if the directional attribute does not indicate that the
646 // remote peer is sending any media.
deadbeef70ab1a12015-09-28 23:53:55647 virtual std::vector<rtc::scoped_refptr<RtpReceiverInterface>> GetReceivers()
648 const {
649 return std::vector<rtc::scoped_refptr<RtpReceiverInterface>>();
650 }
651
wu@webrtc.orgb9a088b2014-02-13 23:18:49652 virtual bool GetStats(StatsObserver* observer,
653 MediaStreamTrackInterface* track,
654 StatsOutputLevel level) = 0;
hbos74e1a4f2016-09-16 06:33:01655 // Gets stats using the new stats collection API, see webrtc/api/stats/. These
656 // will replace old stats collection API when the new API has matured enough.
hbose3810152016-12-13 10:35:19657 // TODO(hbos): Default implementation that does nothing only exists as to not
658 // break third party projects. As soon as they have been updated this should
659 // be changed to "= 0;".
660 virtual void GetStats(RTCStatsCollectorCallback* callback) {}
wu@webrtc.orgb9a088b2014-02-13 23:18:49661
deadbeefb10f32f2017-02-08 09:38:21662 // Create a data channel with the provided config, or default config if none
663 // is provided. Note that an offer/answer negotiation is still necessary
664 // before the data channel can be used.
665 //
666 // Also, calling CreateDataChannel is the only way to get a data "m=" section
667 // in SDP, so it should be done before CreateOffer is called, if the
668 // application plans to use data channels.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52669 virtual rtc::scoped_refptr<DataChannelInterface> CreateDataChannel(
henrike@webrtc.org28e20752013-07-10 00:45:36670 const std::string& label,
671 const DataChannelInit* config) = 0;
672
deadbeefb10f32f2017-02-08 09:38:21673 // Returns the more recently applied description; "pending" if it exists, and
674 // otherwise "current". See below.
henrike@webrtc.org28e20752013-07-10 00:45:36675 virtual const SessionDescriptionInterface* local_description() const = 0;
676 virtual const SessionDescriptionInterface* remote_description() const = 0;
deadbeefb10f32f2017-02-08 09:38:21677
deadbeeffe4a8a42016-12-21 01:56:17678 // A "current" description the one currently negotiated from a complete
679 // offer/answer exchange.
680 virtual const SessionDescriptionInterface* current_local_description() const {
681 return nullptr;
682 }
683 virtual const SessionDescriptionInterface* current_remote_description()
684 const {
685 return nullptr;
686 }
deadbeefb10f32f2017-02-08 09:38:21687
deadbeeffe4a8a42016-12-21 01:56:17688 // A "pending" description is one that's part of an incomplete offer/answer
689 // exchange (thus, either an offer or a pranswer). Once the offer/answer
690 // exchange is finished, the "pending" description will become "current".
691 virtual const SessionDescriptionInterface* pending_local_description() const {
692 return nullptr;
693 }
694 virtual const SessionDescriptionInterface* pending_remote_description()
695 const {
696 return nullptr;
697 }
henrike@webrtc.org28e20752013-07-10 00:45:36698
699 // Create a new offer.
700 // The CreateSessionDescriptionObserver callback will be called when done.
701 virtual void CreateOffer(CreateSessionDescriptionObserver* observer,
jiayl@webrtc.orgb18bf5e2014-08-04 18:34:16702 const MediaConstraintsInterface* constraints) {}
703
704 // TODO(jiayl): remove the default impl and the old interface when chromium
705 // code is updated.
706 virtual void CreateOffer(CreateSessionDescriptionObserver* observer,
707 const RTCOfferAnswerOptions& options) {}
708
henrike@webrtc.org28e20752013-07-10 00:45:36709 // Create an answer to an offer.
710 // The CreateSessionDescriptionObserver callback will be called when done.
711 virtual void CreateAnswer(CreateSessionDescriptionObserver* observer,
htaa2a49d92016-03-04 10:51:39712 const RTCOfferAnswerOptions& options) {}
713 // Deprecated - use version above.
714 // TODO(hta): Remove and remove default implementations when all callers
715 // are updated.
716 virtual void CreateAnswer(CreateSessionDescriptionObserver* observer,
717 const MediaConstraintsInterface* constraints) {}
718
henrike@webrtc.org28e20752013-07-10 00:45:36719 // Sets the local session description.
deadbeef1dcb1642017-03-30 04:08:16720 // The PeerConnection takes the ownership of |desc| even if it fails.
henrike@webrtc.org28e20752013-07-10 00:45:36721 // The |observer| callback will be called when done.
deadbeef1dcb1642017-03-30 04:08:16722 // TODO(deadbeef): Change |desc| to be a unique_ptr, to make it clear
723 // that this method always takes ownership of it.
henrike@webrtc.org28e20752013-07-10 00:45:36724 virtual void SetLocalDescription(SetSessionDescriptionObserver* observer,
725 SessionDescriptionInterface* desc) = 0;
726 // Sets the remote session description.
deadbeef1dcb1642017-03-30 04:08:16727 // The PeerConnection takes the ownership of |desc| even if it fails.
henrike@webrtc.org28e20752013-07-10 00:45:36728 // The |observer| callback will be called when done.
729 virtual void SetRemoteDescription(SetSessionDescriptionObserver* observer,
730 SessionDescriptionInterface* desc) = 0;
deadbeefb10f32f2017-02-08 09:38:21731 // Deprecated; Replaced by SetConfiguration.
deadbeefa67696b2015-09-29 18:56:26732 // TODO(deadbeef): Remove once Chrome is moved over to SetConfiguration.
henrike@webrtc.org28e20752013-07-10 00:45:36733 virtual bool UpdateIce(const IceServers& configuration,
deadbeefa67696b2015-09-29 18:56:26734 const MediaConstraintsInterface* constraints) {
735 return false;
736 }
htaa2a49d92016-03-04 10:51:39737 virtual bool UpdateIce(const IceServers& configuration) { return false; }
deadbeefb10f32f2017-02-08 09:38:21738
deadbeef46c73892016-11-17 03:42:04739 // TODO(deadbeef): Make this pure virtual once all Chrome subclasses of
740 // PeerConnectionInterface implement it.
741 virtual PeerConnectionInterface::RTCConfiguration GetConfiguration() {
742 return PeerConnectionInterface::RTCConfiguration();
743 }
deadbeef293e9262017-01-11 20:28:30744
deadbeefa67696b2015-09-29 18:56:26745 // Sets the PeerConnection's global configuration to |config|.
deadbeef293e9262017-01-11 20:28:30746 //
747 // The members of |config| that may be changed are |type|, |servers|,
748 // |ice_candidate_pool_size| and |prune_turn_ports| (though the candidate
749 // pool size can't be changed after the first call to SetLocalDescription).
750 // Note that this means the BUNDLE and RTCP-multiplexing policies cannot be
751 // changed with this method.
752 //
deadbeefa67696b2015-09-29 18:56:26753 // Any changes to STUN/TURN servers or ICE candidate policy will affect the
754 // next gathering phase, and cause the next call to createOffer to generate
deadbeef293e9262017-01-11 20:28:30755 // new ICE credentials, as described in JSEP. This also occurs when
756 // |prune_turn_ports| changes, for the same reasoning.
757 //
758 // If an error occurs, returns false and populates |error| if non-null:
759 // - INVALID_MODIFICATION if |config| contains a modified parameter other
760 // than one of the parameters listed above.
761 // - INVALID_RANGE if |ice_candidate_pool_size| is out of range.
762 // - SYNTAX_ERROR if parsing an ICE server URL failed.
763 // - INVALID_PARAMETER if a TURN server is missing |username| or |password|.
764 // - INTERNAL_ERROR if an unexpected error occurred.
765 //
deadbeefa67696b2015-09-29 18:56:26766 // TODO(deadbeef): Make this pure virtual once all Chrome subclasses of
767 // PeerConnectionInterface implement it.
768 virtual bool SetConfiguration(
deadbeef293e9262017-01-11 20:28:30769 const PeerConnectionInterface::RTCConfiguration& config,
770 RTCError* error) {
771 return false;
772 }
773 // Version without error output param for backwards compatibility.
774 // TODO(deadbeef): Remove once chromium is updated.
775 virtual bool SetConfiguration(
deadbeef1e234612016-12-24 09:43:32776 const PeerConnectionInterface::RTCConfiguration& config) {
deadbeefa67696b2015-09-29 18:56:26777 return false;
778 }
deadbeefb10f32f2017-02-08 09:38:21779
henrike@webrtc.org28e20752013-07-10 00:45:36780 // Provides a remote candidate to the ICE Agent.
781 // A copy of the |candidate| will be created and added to the remote
782 // description. So the caller of this method still has the ownership of the
783 // |candidate|.
henrike@webrtc.org28e20752013-07-10 00:45:36784 virtual bool AddIceCandidate(const IceCandidateInterface* candidate) = 0;
785
deadbeefb10f32f2017-02-08 09:38:21786 // Removes a group of remote candidates from the ICE agent. Needed mainly for
787 // continual gathering, to avoid an ever-growing list of candidates as
788 // networks come and go.
Honghai Zhang7fb69db2016-03-14 18:59:18789 virtual bool RemoveIceCandidates(
790 const std::vector<cricket::Candidate>& candidates) {
791 return false;
792 }
793
deadbeefb10f32f2017-02-08 09:38:21794 // Register a metric observer (used by chromium).
795 //
796 // There can only be one observer at a time. Before the observer is
797 // destroyed, RegisterUMAOberver(nullptr) should be called.
buildbot@webrtc.org1567b8c2014-05-08 19:54:16798 virtual void RegisterUMAObserver(UMAObserver* observer) = 0;
799
zstein4b979802017-06-02 21:37:37800 // 0 <= min <= current <= max should hold for set parameters.
801 struct BitrateParameters {
802 rtc::Optional<int> min_bitrate_bps;
803 rtc::Optional<int> current_bitrate_bps;
804 rtc::Optional<int> max_bitrate_bps;
805 };
806
807 // SetBitrate limits the bandwidth allocated for all RTP streams sent by
808 // this PeerConnection. Other limitations might affect these limits and
809 // are respected (for example "b=AS" in SDP).
810 //
811 // Setting |current_bitrate_bps| will reset the current bitrate estimate
812 // to the provided value.
zstein83dc6b62017-07-17 22:09:30813 virtual RTCError SetBitrate(const BitrateParameters& bitrate) = 0;
zstein4b979802017-06-02 21:37:37814
Alex Narest78609d52017-10-20 08:37:47815 // Sets current strategy. If not set default WebRTC allocator will be used.
816 // May be changed during an active session. The strategy
817 // ownership is passed with std::unique_ptr
818 // TODO(alexnarest): Make this pure virtual when tests will be updated
819 virtual void SetBitrateAllocationStrategy(
820 std::unique_ptr<rtc::BitrateAllocationStrategy>
821 bitrate_allocation_strategy) {}
822
henrika5f6bf242017-11-01 10:06:56823 // Enable/disable playout of received audio streams. Enabled by default. Note
824 // that even if playout is enabled, streams will only be played out if the
825 // appropriate SDP is also applied. Setting |playout| to false will stop
826 // playout of the underlying audio device but starts a task which will poll
827 // for audio data every 10ms to ensure that audio processing happens and the
828 // audio statistics are updated.
829 // TODO(henrika): deprecate and remove this.
830 virtual void SetAudioPlayout(bool playout) {}
831
832 // Enable/disable recording of transmitted audio streams. Enabled by default.
833 // Note that even if recording is enabled, streams will only be recorded if
834 // the appropriate SDP is also applied.
835 // TODO(henrika): deprecate and remove this.
836 virtual void SetAudioRecording(bool recording) {}
837
henrike@webrtc.org28e20752013-07-10 00:45:36838 // Returns the current SignalingState.
839 virtual SignalingState signaling_state() = 0;
Taylor Brandstettercb423c42017-10-22 18:52:32840
841 // Returns the aggregate state of all ICE *and* DTLS transports.
842 // TODO(deadbeef): Implement "PeerConnectionState" according to the standard,
843 // to aggregate ICE+DTLS state, and change the scope of IceConnectionState to
844 // be just the ICE layer. See: crbug.com/webrtc/6145
henrike@webrtc.org28e20752013-07-10 00:45:36845 virtual IceConnectionState ice_connection_state() = 0;
Taylor Brandstettercb423c42017-10-22 18:52:32846
henrike@webrtc.org28e20752013-07-10 00:45:36847 virtual IceGatheringState ice_gathering_state() = 0;
848
ivoc14d5dbe2016-07-04 14:06:55849 // Starts RtcEventLog using existing file. Takes ownership of |file| and
850 // passes it on to Call, which will take the ownership. If the
851 // operation fails the file will be closed. The logging will stop
852 // automatically after 10 minutes have passed, or when the StopRtcEventLog
853 // function is called.
Elad Alon99c3fe52017-10-13 14:29:40854 // TODO(eladalon): Deprecate and remove this.
ivoc14d5dbe2016-07-04 14:06:55855 virtual bool StartRtcEventLog(rtc::PlatformFile file,
856 int64_t max_size_bytes) {
857 return false;
858 }
859
Elad Alon99c3fe52017-10-13 14:29:40860 // Start RtcEventLog using an existing output-sink. Takes ownership of
861 // |output| and passes it on to Call, which will take the ownership. If the
Bjorn Tereliusde939432017-11-20 16:38:14862 // operation fails the output will be closed and deallocated. The event log
863 // will send serialized events to the output object every |output_period_ms|.
864 virtual bool StartRtcEventLog(std::unique_ptr<RtcEventLogOutput> output,
865 int64_t output_period_ms) {
Elad Alon99c3fe52017-10-13 14:29:40866 return false;
867 }
868
ivoc14d5dbe2016-07-04 14:06:55869 // Stops logging the RtcEventLog.
870 // TODO(ivoc): Make this pure virtual when Chrome is updated.
871 virtual void StopRtcEventLog() {}
872
deadbeefb10f32f2017-02-08 09:38:21873 // Terminates all media, closes the transports, and in general releases any
874 // resources used by the PeerConnection. This is an irreversible operation.
deadbeefd07061c2017-04-20 20:19:00875 //
876 // Note that after this method completes, the PeerConnection will no longer
877 // use the PeerConnectionObserver interface passed in on construction, and
878 // thus the observer object can be safely destroyed.
henrike@webrtc.org28e20752013-07-10 00:45:36879 virtual void Close() = 0;
880
881 protected:
882 // Dtor protected as objects shouldn't be deleted via this interface.
883 ~PeerConnectionInterface() {}
884};
885
deadbeefb10f32f2017-02-08 09:38:21886// PeerConnection callback interface, used for RTCPeerConnection events.
887// Application should implement these methods.
henrike@webrtc.org28e20752013-07-10 00:45:36888class PeerConnectionObserver {
889 public:
890 enum StateType {
891 kSignalingState,
892 kIceState,
893 };
894
henrike@webrtc.org28e20752013-07-10 00:45:36895 // Triggered when the SignalingState changed.
896 virtual void OnSignalingChange(
perkjdfb769d2016-02-09 11:09:43897 PeerConnectionInterface::SignalingState new_state) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36898
Taylor Brandstetter98cde262016-05-31 20:02:21899 // TODO(deadbeef): Once all subclasses override the scoped_refptr versions
900 // of the below three methods, make them pure virtual and remove the raw
901 // pointer version.
902
henrike@webrtc.org28e20752013-07-10 00:45:36903 // Triggered when media is received on a new stream from remote peer.
nisse7f067662017-03-08 14:59:45904 virtual void OnAddStream(rtc::scoped_refptr<MediaStreamInterface> stream) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36905
906 // Triggered when a remote peer close a stream.
nisse7f067662017-03-08 14:59:45907 virtual void OnRemoveStream(
908 rtc::scoped_refptr<MediaStreamInterface> stream) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36909
Taylor Brandstetter98cde262016-05-31 20:02:21910 // Triggered when a remote peer opens a data channel.
911 virtual void OnDataChannel(
nisse7f067662017-03-08 14:59:45912 rtc::scoped_refptr<DataChannelInterface> data_channel) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36913
Taylor Brandstetter98cde262016-05-31 20:02:21914 // Triggered when renegotiation is needed. For example, an ICE restart
915 // has begun.
fischman@webrtc.orgd7568a02014-01-13 22:04:12916 virtual void OnRenegotiationNeeded() = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36917
Taylor Brandstetter98cde262016-05-31 20:02:21918 // Called any time the IceConnectionState changes.
deadbeefb10f32f2017-02-08 09:38:21919 //
920 // Note that our ICE states lag behind the standard slightly. The most
921 // notable differences include the fact that "failed" occurs after 15
922 // seconds, not 30, and this actually represents a combination ICE + DTLS
923 // state, so it may be "failed" if DTLS fails while ICE succeeds.
henrike@webrtc.org28e20752013-07-10 00:45:36924 virtual void OnIceConnectionChange(
perkjdfb769d2016-02-09 11:09:43925 PeerConnectionInterface::IceConnectionState new_state) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36926
Taylor Brandstetter98cde262016-05-31 20:02:21927 // Called any time the IceGatheringState changes.
henrike@webrtc.org28e20752013-07-10 00:45:36928 virtual void OnIceGatheringChange(
perkjdfb769d2016-02-09 11:09:43929 PeerConnectionInterface::IceGatheringState new_state) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:36930
Taylor Brandstetter98cde262016-05-31 20:02:21931 // A new ICE candidate has been gathered.
henrike@webrtc.org28e20752013-07-10 00:45:36932 virtual void OnIceCandidate(const IceCandidateInterface* candidate) = 0;
933
Honghai Zhang7fb69db2016-03-14 18:59:18934 // Ice candidates have been removed.
935 // TODO(honghaiz): Make this a pure virtual method when all its subclasses
936 // implement it.
937 virtual void OnIceCandidatesRemoved(
938 const std::vector<cricket::Candidate>& candidates) {}
939
Peter Thatcher54360512015-07-08 18:08:35940 // Called when the ICE connection receiving status changes.
941 virtual void OnIceConnectionReceivingChange(bool receiving) {}
942
Henrik Boström933d8b02017-10-10 17:05:16943 // This is called when a receiver and its track is created.
944 // TODO(zhihuang): Make this pure virtual when all subclasses implement it.
zhihuang81c3a032016-11-17 20:06:24945 virtual void OnAddTrack(
946 rtc::scoped_refptr<RtpReceiverInterface> receiver,
zhihuangc63b8942016-12-02 23:41:10947 const std::vector<rtc::scoped_refptr<MediaStreamInterface>>& streams) {}
zhihuang81c3a032016-11-17 20:06:24948
Henrik Boström933d8b02017-10-10 17:05:16949 // TODO(hbos,deadbeef): Add |OnAssociatedStreamsUpdated| with |receiver| and
950 // |streams| as arguments. This should be called when an existing receiver its
951 // associated streams updated. https://crbug.com/webrtc/8315
952 // This may be blocked on supporting multiple streams per sender or else
953 // this may count as the removal and addition of a track?
954 // https://crbug.com/webrtc/7932
955
956 // Called when a receiver is completely removed. This is current (Plan B SDP)
957 // behavior that occurs when processing the removal of a remote track, and is
958 // called when the receiver is removed and the track is muted. When Unified
959 // Plan SDP is supported, transceivers can change direction (and receivers
960 // stopped) but receivers are never removed.
961 // https://w3c.github.io/webrtc-pc/#process-remote-track-removal
962 // TODO(hbos,deadbeef): When Unified Plan SDP is supported and receivers are
963 // no longer removed, deprecate and remove this callback.
964 // TODO(hbos,deadbeef): Make pure virtual when all subclasses implement it.
965 virtual void OnRemoveTrack(
966 rtc::scoped_refptr<RtpReceiverInterface> receiver) {}
967
henrike@webrtc.org28e20752013-07-10 00:45:36968 protected:
969 // Dtor protected as objects shouldn't be deleted via this interface.
970 ~PeerConnectionObserver() {}
971};
972
deadbeefb10f32f2017-02-08 09:38:21973// PeerConnectionFactoryInterface is the factory interface used for creating
974// PeerConnection, MediaStream and MediaStreamTrack objects.
975//
976// The simplest method for obtaiing one, CreatePeerConnectionFactory will
977// create the required libjingle threads, socket and network manager factory
978// classes for networking if none are provided, though it requires that the
979// application runs a message loop on the thread that called the method (see
980// explanation below)
981//
982// If an application decides to provide its own threads and/or implementation
983// of networking classes, it should use the alternate
984// CreatePeerConnectionFactory method which accepts threads as input, and use
985// the CreatePeerConnection version that takes a PortAllocator as an argument.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:52986class PeerConnectionFactoryInterface : public rtc::RefCountInterface {
henrike@webrtc.org28e20752013-07-10 00:45:36987 public:
wu@webrtc.org97077a32013-10-25 21:18:33988 class Options {
989 public:
deadbeefb10f32f2017-02-08 09:38:21990 Options() : crypto_options(rtc::CryptoOptions::NoGcm()) {}
991
992 // If set to true, created PeerConnections won't enforce any SRTP
993 // requirement, allowing unsecured media. Should only be used for
994 // testing/debugging.
995 bool disable_encryption = false;
996
997 // Deprecated. The only effect of setting this to true is that
998 // CreateDataChannel will fail, which is not that useful.
999 bool disable_sctp_data_channels = false;
1000
1001 // If set to true, any platform-supported network monitoring capability
1002 // won't be used, and instead networks will only be updated via polling.
1003 //
1004 // This only has an effect if a PeerConnection is created with the default
1005 // PortAllocator implementation.
1006 bool disable_network_monitor = false;
phoglund@webrtc.org006521d2015-02-12 09:23:591007
1008 // Sets the network types to ignore. For instance, calling this with
1009 // ADAPTER_TYPE_ETHERNET | ADAPTER_TYPE_LOOPBACK will ignore Ethernet and
1010 // loopback interfaces.
deadbeefb10f32f2017-02-08 09:38:211011 int network_ignore_mask = rtc::kDefaultNetworkIgnoreMask;
Joachim Bauch04e5b492015-05-29 07:40:391012
1013 // Sets the maximum supported protocol version. The highest version
1014 // supported by both ends will be used for the connection, i.e. if one
1015 // party supports DTLS 1.0 and the other DTLS 1.2, DTLS 1.0 will be used.
deadbeefb10f32f2017-02-08 09:38:211016 rtc::SSLProtocolVersion ssl_max_version = rtc::SSL_PROTOCOL_DTLS_12;
jbauchcb560652016-08-04 12:20:321017
1018 // Sets crypto related options, e.g. enabled cipher suites.
1019 rtc::CryptoOptions crypto_options;
wu@webrtc.org97077a32013-10-25 21:18:331020 };
1021
deadbeef7914b8c2017-04-21 10:23:331022 // Set the options to be used for subsequently created PeerConnections.
wu@webrtc.org97077a32013-10-25 21:18:331023 virtual void SetOptions(const Options& options) = 0;
buildbot@webrtc.org41451d42014-05-03 05:39:451024
deadbeefd07061c2017-04-20 20:19:001025 // |allocator| and |cert_generator| may be null, in which case default
1026 // implementations will be used.
1027 //
1028 // |observer| must not be null.
1029 //
1030 // Note that this method does not take ownership of |observer|; it's the
1031 // responsibility of the caller to delete it. It can be safely deleted after
1032 // Close has been called on the returned PeerConnection, which ensures no
1033 // more observer callbacks will be invoked.
deadbeef41b07982015-12-01 23:01:241034 virtual rtc::scoped_refptr<PeerConnectionInterface> CreatePeerConnection(
1035 const PeerConnectionInterface::RTCConfiguration& configuration,
kwibergd1fe2812016-04-27 13:47:291036 std::unique_ptr<cricket::PortAllocator> allocator,
Henrik Boströmd03c23b2016-06-01 09:44:181037 std::unique_ptr<rtc::RTCCertificateGeneratorInterface> cert_generator,
hbosd7973cc2016-05-27 13:08:531038 PeerConnectionObserver* observer) = 0;
buildbot@webrtc.org41451d42014-05-03 05:39:451039
deadbeefb10f32f2017-02-08 09:38:211040 // Deprecated; should use RTCConfiguration for everything that previously
1041 // used constraints.
htaa2a49d92016-03-04 10:51:391042 virtual rtc::scoped_refptr<PeerConnectionInterface> CreatePeerConnection(
1043 const PeerConnectionInterface::RTCConfiguration& configuration,
deadbeefb10f32f2017-02-08 09:38:211044 const MediaConstraintsInterface* constraints,
kwibergd1fe2812016-04-27 13:47:291045 std::unique_ptr<cricket::PortAllocator> allocator,
Henrik Boströmd03c23b2016-06-01 09:44:181046 std::unique_ptr<rtc::RTCCertificateGeneratorInterface> cert_generator,
hbosd7973cc2016-05-27 13:08:531047 PeerConnectionObserver* observer) = 0;
htaa2a49d92016-03-04 10:51:391048
buildbot@webrtc.orgd4e598d2014-07-29 17:36:521049 virtual rtc::scoped_refptr<MediaStreamInterface>
henrike@webrtc.org28e20752013-07-10 00:45:361050 CreateLocalMediaStream(const std::string& label) = 0;
1051
deadbeefe814a0d2017-02-26 02:15:091052 // Creates an AudioSourceInterface.
deadbeefb10f32f2017-02-08 09:38:211053 // |options| decides audio processing settings.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:521054 virtual rtc::scoped_refptr<AudioSourceInterface> CreateAudioSource(
htaa2a49d92016-03-04 10:51:391055 const cricket::AudioOptions& options) = 0;
1056 // Deprecated - use version above.
deadbeeffe0fd412017-01-13 19:47:561057 // Can use CopyConstraintsIntoAudioOptions to bridge the gap.
htaa2a49d92016-03-04 10:51:391058 virtual rtc::scoped_refptr<AudioSourceInterface> CreateAudioSource(
henrike@webrtc.org28e20752013-07-10 00:45:361059 const MediaConstraintsInterface* constraints) = 0;
1060
deadbeef39e14da2017-02-13 17:49:581061 // Creates a VideoTrackSourceInterface from |capturer|.
1062 // TODO(deadbeef): We should aim to remove cricket::VideoCapturer from the
1063 // API. It's mainly used as a wrapper around webrtc's provided
1064 // platform-specific capturers, but these should be refactored to use
1065 // VideoTrackSourceInterface directly.
deadbeef112b2e92017-02-11 04:13:371066 // TODO(deadbeef): Make pure virtual once downstream mock PC factory classes
1067 // are updated.
perkja3ede6c2016-03-08 00:27:481068 virtual rtc::scoped_refptr<VideoTrackSourceInterface> CreateVideoSource(
deadbeef112b2e92017-02-11 04:13:371069 std::unique_ptr<cricket::VideoCapturer> capturer) {
1070 return nullptr;
1071 }
1072
htaa2a49d92016-03-04 10:51:391073 // A video source creator that allows selection of resolution and frame rate.
deadbeef8d60a942017-02-27 22:47:331074 // |constraints| decides video resolution and frame rate but can be null.
1075 // In the null case, use the version above.
deadbeef112b2e92017-02-11 04:13:371076 //
1077 // |constraints| is only used for the invocation of this method, and can
1078 // safely be destroyed afterwards.
1079 virtual rtc::scoped_refptr<VideoTrackSourceInterface> CreateVideoSource(
1080 std::unique_ptr<cricket::VideoCapturer> capturer,
1081 const MediaConstraintsInterface* constraints) {
1082 return nullptr;
1083 }
1084
1085 // Deprecated; please use the versions that take unique_ptrs above.
1086 // TODO(deadbeef): Remove these once safe to do so.
1087 virtual rtc::scoped_refptr<VideoTrackSourceInterface> CreateVideoSource(
1088 cricket::VideoCapturer* capturer) {
1089 return CreateVideoSource(std::unique_ptr<cricket::VideoCapturer>(capturer));
1090 }
perkja3ede6c2016-03-08 00:27:481091 virtual rtc::scoped_refptr<VideoTrackSourceInterface> CreateVideoSource(
henrike@webrtc.org28e20752013-07-10 00:45:361092 cricket::VideoCapturer* capturer,
deadbeef112b2e92017-02-11 04:13:371093 const MediaConstraintsInterface* constraints) {
1094 return CreateVideoSource(std::unique_ptr<cricket::VideoCapturer>(capturer),
1095 constraints);
1096 }
henrike@webrtc.org28e20752013-07-10 00:45:361097
1098 // Creates a new local VideoTrack. The same |source| can be used in several
1099 // tracks.
perkja3ede6c2016-03-08 00:27:481100 virtual rtc::scoped_refptr<VideoTrackInterface> CreateVideoTrack(
1101 const std::string& label,
1102 VideoTrackSourceInterface* source) = 0;
henrike@webrtc.org28e20752013-07-10 00:45:361103
deadbeef8d60a942017-02-27 22:47:331104 // Creates an new AudioTrack. At the moment |source| can be null.
buildbot@webrtc.orgd4e598d2014-07-29 17:36:521105 virtual rtc::scoped_refptr<AudioTrackInterface>
henrike@webrtc.org28e20752013-07-10 00:45:361106 CreateAudioTrack(const std::string& label,
1107 AudioSourceInterface* source) = 0;
1108
wu@webrtc.orga9890802013-12-13 00:21:031109 // Starts AEC dump using existing file. Takes ownership of |file| and passes
1110 // it on to VoiceEngine (via other objects) immediately, which will take
wu@webrtc.orga8910d22014-01-23 22:12:451111 // the ownerhip. If the operation fails, the file will be closed.
ivocd66b44d2016-01-15 11:06:361112 // A maximum file size in bytes can be specified. When the file size limit is
1113 // reached, logging is stopped automatically. If max_size_bytes is set to a
1114 // value <= 0, no limit will be used, and logging will continue until the
1115 // StopAecDump function is called.
1116 virtual bool StartAecDump(rtc::PlatformFile file, int64_t max_size_bytes) = 0;
wu@webrtc.orga9890802013-12-13 00:21:031117
ivoc797ef122015-10-22 10:25:411118 // Stops logging the AEC dump.
1119 virtual void StopAecDump() = 0;
1120
henrike@webrtc.org28e20752013-07-10 00:45:361121 protected:
1122 // Dtor and ctor protected as objects shouldn't be created or deleted via
1123 // this interface.
1124 PeerConnectionFactoryInterface() {}
1125 ~PeerConnectionFactoryInterface() {} // NOLINT
1126};
1127
1128// Create a new instance of PeerConnectionFactoryInterface.
Taylor Brandstettera8415fe2016-03-23 17:38:071129//
1130// This method relies on the thread it's called on as the "signaling thread"
1131// for the PeerConnectionFactory it creates.
1132//
1133// As such, if the current thread is not already running an rtc::Thread message
1134// loop, an application using this method must eventually either call
1135// rtc::Thread::Current()->Run(), or call
1136// rtc::Thread::Current()->ProcessMessages() within the application's own
1137// message loop.
kwiberg1e4e8cb2017-01-31 09:48:081138rtc::scoped_refptr<PeerConnectionFactoryInterface> CreatePeerConnectionFactory(
1139 rtc::scoped_refptr<AudioEncoderFactory> audio_encoder_factory,
1140 rtc::scoped_refptr<AudioDecoderFactory> audio_decoder_factory);
1141
henrike@webrtc.org28e20752013-07-10 00:45:361142// Create a new instance of PeerConnectionFactoryInterface.
Taylor Brandstettera8415fe2016-03-23 17:38:071143//
danilchape9021a32016-05-17 08:52:021144// |network_thread|, |worker_thread| and |signaling_thread| are
1145// the only mandatory parameters.
Taylor Brandstettera8415fe2016-03-23 17:38:071146//
deadbeefb10f32f2017-02-08 09:38:211147// If non-null, a reference is added to |default_adm|, and ownership of
1148// |video_encoder_factory| and |video_decoder_factory| is transferred to the
1149// returned factory.
1150// TODO(deadbeef): Use rtc::scoped_refptr<> and std::unique_ptr<> to make this
1151// ownership transfer and ref counting more obvious.
danilchape9021a32016-05-17 08:52:021152rtc::scoped_refptr<PeerConnectionFactoryInterface> CreatePeerConnectionFactory(
1153 rtc::Thread* network_thread,
buildbot@webrtc.orgd4e598d2014-07-29 17:36:521154 rtc::Thread* worker_thread,
1155 rtc::Thread* signaling_thread,
henrike@webrtc.org28e20752013-07-10 00:45:361156 AudioDeviceModule* default_adm,
kwiberg1e4e8cb2017-01-31 09:48:081157 rtc::scoped_refptr<AudioEncoderFactory> audio_encoder_factory,
1158 rtc::scoped_refptr<AudioDecoderFactory> audio_decoder_factory,
1159 cricket::WebRtcVideoEncoderFactory* video_encoder_factory,
1160 cricket::WebRtcVideoDecoderFactory* video_decoder_factory);
1161
peah17675ce2017-06-30 14:24:041162// Create a new instance of PeerConnectionFactoryInterface with optional
1163// external audio mixed and audio processing modules.
1164//
1165// If |audio_mixer| is null, an internal audio mixer will be created and used.
1166// If |audio_processing| is null, an internal audio processing module will be
1167// created and used.
1168rtc::scoped_refptr<PeerConnectionFactoryInterface> CreatePeerConnectionFactory(
1169 rtc::Thread* network_thread,
1170 rtc::Thread* worker_thread,
1171 rtc::Thread* signaling_thread,
1172 AudioDeviceModule* default_adm,
1173 rtc::scoped_refptr<AudioEncoderFactory> audio_encoder_factory,
1174 rtc::scoped_refptr<AudioDecoderFactory> audio_decoder_factory,
1175 cricket::WebRtcVideoEncoderFactory* video_encoder_factory,
1176 cricket::WebRtcVideoDecoderFactory* video_decoder_factory,
1177 rtc::scoped_refptr<AudioMixer> audio_mixer,
1178 rtc::scoped_refptr<AudioProcessing> audio_processing);
1179
Magnus Jedvert58b03162017-09-15 17:02:471180// Create a new instance of PeerConnectionFactoryInterface with optional video
1181// codec factories. These video factories represents all video codecs, i.e. no
1182// extra internal video codecs will be added.
1183rtc::scoped_refptr<PeerConnectionFactoryInterface> CreatePeerConnectionFactory(
1184 rtc::Thread* network_thread,
1185 rtc::Thread* worker_thread,
1186 rtc::Thread* signaling_thread,
1187 rtc::scoped_refptr<AudioDeviceModule> default_adm,
1188 rtc::scoped_refptr<AudioEncoderFactory> audio_encoder_factory,
1189 rtc::scoped_refptr<AudioDecoderFactory> audio_decoder_factory,
1190 std::unique_ptr<VideoEncoderFactory> video_encoder_factory,
1191 std::unique_ptr<VideoDecoderFactory> video_decoder_factory,
1192 rtc::scoped_refptr<AudioMixer> audio_mixer,
1193 rtc::scoped_refptr<AudioProcessing> audio_processing);
1194
gyzhou95aa9642016-12-13 22:06:261195// Create a new instance of PeerConnectionFactoryInterface with external audio
1196// mixer.
1197//
1198// If |audio_mixer| is null, an internal audio mixer will be created and used.
1199rtc::scoped_refptr<PeerConnectionFactoryInterface>
1200CreatePeerConnectionFactoryWithAudioMixer(
1201 rtc::Thread* network_thread,
1202 rtc::Thread* worker_thread,
1203 rtc::Thread* signaling_thread,
1204 AudioDeviceModule* default_adm,
kwiberg1e4e8cb2017-01-31 09:48:081205 rtc::scoped_refptr<AudioEncoderFactory> audio_encoder_factory,
1206 rtc::scoped_refptr<AudioDecoderFactory> audio_decoder_factory,
1207 cricket::WebRtcVideoEncoderFactory* video_encoder_factory,
1208 cricket::WebRtcVideoDecoderFactory* video_decoder_factory,
1209 rtc::scoped_refptr<AudioMixer> audio_mixer);
1210
danilchape9021a32016-05-17 08:52:021211// Create a new instance of PeerConnectionFactoryInterface.
1212// Same thread is used as worker and network thread.
danilchape9021a32016-05-17 08:52:021213inline rtc::scoped_refptr<PeerConnectionFactoryInterface>
1214CreatePeerConnectionFactory(
1215 rtc::Thread* worker_and_network_thread,
1216 rtc::Thread* signaling_thread,
1217 AudioDeviceModule* default_adm,
kwiberg1e4e8cb2017-01-31 09:48:081218 rtc::scoped_refptr<AudioEncoderFactory> audio_encoder_factory,
1219 rtc::scoped_refptr<AudioDecoderFactory> audio_decoder_factory,
1220 cricket::WebRtcVideoEncoderFactory* video_encoder_factory,
1221 cricket::WebRtcVideoDecoderFactory* video_decoder_factory) {
1222 return CreatePeerConnectionFactory(
1223 worker_and_network_thread, worker_and_network_thread, signaling_thread,
1224 default_adm, audio_encoder_factory, audio_decoder_factory,
1225 video_encoder_factory, video_decoder_factory);
1226}
1227
zhihuang38ede132017-06-15 19:52:321228// This is a lower-level version of the CreatePeerConnectionFactory functions
1229// above. It's implemented in the "peerconnection" build target, whereas the
1230// above methods are only implemented in the broader "libjingle_peerconnection"
1231// build target, which pulls in the implementations of every module webrtc may
1232// use.
1233//
1234// If an application knows it will only require certain modules, it can reduce
1235// webrtc's impact on its binary size by depending only on the "peerconnection"
1236// target and the modules the application requires, using
1237// CreateModularPeerConnectionFactory instead of one of the
1238// CreatePeerConnectionFactory methods above. For example, if an application
1239// only uses WebRTC for audio, it can pass in null pointers for the
1240// video-specific interfaces, and omit the corresponding modules from its
1241// build.
1242//
1243// If |network_thread| or |worker_thread| are null, the PeerConnectionFactory
1244// will create the necessary thread internally. If |signaling_thread| is null,
1245// the PeerConnectionFactory will use the thread on which this method is called
1246// as the signaling thread, wrapping it in an rtc::Thread object if needed.
1247//
1248// If non-null, a reference is added to |default_adm|, and ownership of
1249// |video_encoder_factory| and |video_decoder_factory| is transferred to the
1250// returned factory.
1251//
peaha9cc40b2017-06-29 15:32:091252// If |audio_mixer| is null, an internal audio mixer will be created and used.
1253//
zhihuang38ede132017-06-15 19:52:321254// TODO(deadbeef): Use rtc::scoped_refptr<> and std::unique_ptr<> to make this
1255// ownership transfer and ref counting more obvious.
1256//
1257// TODO(deadbeef): Encapsulate these modules in a struct, so that when a new
1258// module is inevitably exposed, we can just add a field to the struct instead
1259// of adding a whole new CreateModularPeerConnectionFactory overload.
1260rtc::scoped_refptr<PeerConnectionFactoryInterface>
1261CreateModularPeerConnectionFactory(
1262 rtc::Thread* network_thread,
1263 rtc::Thread* worker_thread,
1264 rtc::Thread* signaling_thread,
zhihuang38ede132017-06-15 19:52:321265 std::unique_ptr<cricket::MediaEngineInterface> media_engine,
1266 std::unique_ptr<CallFactoryInterface> call_factory,
1267 std::unique_ptr<RtcEventLogFactoryInterface> event_log_factory);
1268
henrike@webrtc.org28e20752013-07-10 00:45:361269} // namespace webrtc
1270
Mirko Bonadei92ea95e2017-09-15 04:47:311271#endif // API_PEERCONNECTIONINTERFACE_H_