henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 1 | /* |
kjellander | b24317b | 2016-02-10 15:54:43 | [diff] [blame] | 2 | * Copyright 2012 The WebRTC project authors. All Rights Reserved. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 3 | * |
kjellander | b24317b | 2016-02-10 15:54:43 | [diff] [blame] | 4 | * 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.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 9 | */ |
| 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.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 13 | // |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 14 | // 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.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 19 | // 1. Create a PeerConnectionFactoryInterface. Check constructors for more |
| 20 | // information about input parameters. |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 21 | // |
| 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.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 34 | // observer function OnIceCandidate. The candidates must also be serialized and |
| 35 | // sent to the remote peer. |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 36 | // |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 37 | // 6. Once an answer is received from the remote peer, call |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 38 | // SetRemoteDescription with the remote answer. |
| 39 | // |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 40 | // 7. Once a remote candidate is received from the remote peer, provide it to |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 41 | // 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.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 49 | // 1. Create PeerConnectionFactoryInterface if it doesn't exist. |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 50 | // |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 51 | // 2. Create a new PeerConnection. |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 52 | // |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 53 | // 3. Provide the remote offer to the new PeerConnection object by calling |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 54 | // SetRemoteDescription. |
| 55 | // |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 56 | // 4. Generate an answer to the remote offer by calling CreateAnswer and send it |
| 57 | // back to the remote peer. |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 58 | // |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 59 | // 5. Provide the local answer to the new PeerConnection by calling |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 60 | // 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.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 66 | |
Mirko Bonadei | 92ea95e | 2017-09-15 04:47:31 | [diff] [blame] | 67 | #ifndef API_PEERCONNECTIONINTERFACE_H_ |
| 68 | #define API_PEERCONNECTIONINTERFACE_H_ |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 69 | |
kwiberg | d1fe281 | 2016-04-27 13:47:29 | [diff] [blame] | 70 | #include <memory> |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 71 | #include <string> |
kwiberg | 0eb15ed | 2015-12-17 11:04:15 | [diff] [blame] | 72 | #include <utility> |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 73 | #include <vector> |
| 74 | |
Mirko Bonadei | 92ea95e | 2017-09-15 04:47:31 | [diff] [blame] | 75 | #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 Alon | 99c3fe5 | 2017-10-13 14:29:40 | [diff] [blame] | 82 | #include "api/rtceventlogoutput.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 04:47:31 | [diff] [blame] | 83 | #include "api/rtpreceiverinterface.h" |
| 84 | #include "api/rtpsenderinterface.h" |
| 85 | #include "api/stats/rtcstatscollectorcallback.h" |
| 86 | #include "api/statstypes.h" |
Jonas Oreland | bdcee28 | 2017-10-10 12:01:40 | [diff] [blame] | 87 | #include "api/turncustomizer.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 04:47:31 | [diff] [blame] | 88 | #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 Bonadei | 92ea95e | 2017-09-15 04:47:31 | [diff] [blame] | 94 | #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.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 99 | |
buildbot@webrtc.org | d4e598d | 2014-07-29 17:36:52 | [diff] [blame] | 100 | namespace rtc { |
jiayl@webrtc.org | 61e00b0 | 2015-03-04 22:17:38 | [diff] [blame] | 101 | class SSLIdentity; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 102 | class Thread; |
| 103 | } |
| 104 | |
| 105 | namespace cricket { |
zhihuang | 38ede13 | 2017-06-15 19:52:32 | [diff] [blame] | 106 | class MediaEngineInterface; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 107 | class WebRtcVideoDecoderFactory; |
| 108 | class WebRtcVideoEncoderFactory; |
| 109 | } |
| 110 | |
| 111 | namespace webrtc { |
| 112 | class AudioDeviceModule; |
gyzhou | 95aa964 | 2016-12-13 22:06:26 | [diff] [blame] | 113 | class AudioMixer; |
zhihuang | 38ede13 | 2017-06-15 19:52:32 | [diff] [blame] | 114 | class CallFactoryInterface; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 115 | class MediaConstraintsInterface; |
Magnus Jedvert | 58b0316 | 2017-09-15 17:02:47 | [diff] [blame] | 116 | class VideoDecoderFactory; |
| 117 | class VideoEncoderFactory; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 118 | |
| 119 | // MediaStream container interface. |
buildbot@webrtc.org | d4e598d | 2014-07-29 17:36:52 | [diff] [blame] | 120 | class StreamCollectionInterface : public rtc::RefCountInterface { |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 121 | 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.org | d4e598d | 2014-07-29 17:36:52 | [diff] [blame] | 136 | class StatsObserver : public rtc::RefCountInterface { |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 137 | public: |
nisse | e8abe3e | 2017-01-18 13:00:34 | [diff] [blame] | 138 | virtual void OnComplete(const StatsReports& reports) = 0; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 139 | |
| 140 | protected: |
| 141 | virtual ~StatsObserver() {} |
| 142 | }; |
| 143 | |
Steve Anton | 79e7960 | 2017-11-20 18:25:56 | [diff] [blame] | 144 | // For now, kDefault is interpreted as kPlanB. |
| 145 | // TODO(bugs.webrtc.org/8530): Switch default to kUnifiedPlan. |
| 146 | enum class SdpSemantics { kDefault, kPlanB, kUnifiedPlan }; |
| 147 | |
buildbot@webrtc.org | d4e598d | 2014-07-29 17:36:52 | [diff] [blame] | 148 | class PeerConnectionInterface : public rtc::RefCountInterface { |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 149 | 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.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 160 | 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 Shieh | 3d564c1 | 2015-08-19 23:51:15 | [diff] [blame] | 174 | kIceConnectionMax, |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 175 | }; |
| 176 | |
hnsl | 0483362 | 2017-01-09 16:35:45 | [diff] [blame] | 177 | // 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.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 188 | struct IceServer { |
Joachim Bauch | 7c4e745 | 2015-05-28 21:06:30 | [diff] [blame] | 189 | // TODO(jbauch): Remove uri when all code using it has switched to urls. |
Emad Omara | dab1d2d | 2017-06-16 22:43:11 | [diff] [blame] | 190 | // 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.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 193 | std::string uri; |
Joachim Bauch | 7c4e745 | 2015-05-28 21:06:30 | [diff] [blame] | 194 | std::vector<std::string> urls; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 195 | std::string username; |
| 196 | std::string password; |
hnsl | 0483362 | 2017-01-09 16:35:45 | [diff] [blame] | 197 | TlsCertPolicy tls_cert_policy = kTlsCertPolicySecure; |
Emad Omara | dab1d2d | 2017-06-16 22:43:11 | [diff] [blame] | 198 | // 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 Real | 1dca9d5 | 2017-08-29 19:18:32 | [diff] [blame] | 203 | // List of protocols to be used in the TLS ALPN extension. |
| 204 | std::vector<std::string> tls_alpn_protocols; |
Diogo Real | 7bd1f1b | 2017-09-08 19:50:41 | [diff] [blame] | 205 | // List of elliptic curves to be used in the TLS elliptic curves extension. |
| 206 | std::vector<std::string> tls_elliptic_curves; |
hnsl | 0483362 | 2017-01-09 16:35:45 | [diff] [blame] | 207 | |
deadbeef | d1a38b5 | 2016-12-10 21:15:33 | [diff] [blame] | 208 | bool operator==(const IceServer& o) const { |
| 209 | return uri == o.uri && urls == o.urls && username == o.username && |
Emad Omara | dab1d2d | 2017-06-16 22:43:11 | [diff] [blame] | 210 | password == o.password && tls_cert_policy == o.tls_cert_policy && |
Diogo Real | 1dca9d5 | 2017-08-29 19:18:32 | [diff] [blame] | 211 | hostname == o.hostname && |
Diogo Real | 7bd1f1b | 2017-09-08 19:50:41 | [diff] [blame] | 212 | tls_alpn_protocols == o.tls_alpn_protocols && |
| 213 | tls_elliptic_curves == o.tls_elliptic_curves; |
deadbeef | d1a38b5 | 2016-12-10 21:15:33 | [diff] [blame] | 214 | } |
| 215 | bool operator!=(const IceServer& o) const { return !(*this == o); } |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 216 | }; |
| 217 | typedef std::vector<IceServer> IceServers; |
| 218 | |
buildbot@webrtc.org | 41451d4 | 2014-05-03 05:39:45 | [diff] [blame] | 219 | enum IceTransportsType { |
pthatcher@webrtc.org | fd630a5 | 2015-01-14 23:19:06 | [diff] [blame] | 220 | // TODO(pthatcher): Rename these kTransporTypeXXX, but update |
| 221 | // Chromium at the same time. |
buildbot@webrtc.org | 41451d4 | 2014-05-03 05:39:45 | [diff] [blame] | 222 | kNone, |
| 223 | kRelay, |
| 224 | kNoHost, |
| 225 | kAll |
| 226 | }; |
| 227 | |
pthatcher@webrtc.org | fd630a5 | 2015-01-14 23:19:06 | [diff] [blame] | 228 | // 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.org | 41451d4 | 2014-05-03 05:39:45 | [diff] [blame] | 234 | |
Peter Thatcher | af55ccc | 2015-05-21 14:48:41 | [diff] [blame] | 235 | // https://tools.ietf.org/html/draft-ietf-rtcweb-jsep-09#section-4.1.1 |
| 236 | enum RtcpMuxPolicy { |
| 237 | kRtcpMuxPolicyNegotiate, |
| 238 | kRtcpMuxPolicyRequire, |
| 239 | }; |
| 240 | |
Jiayang Liu | cac1b38 | 2015-04-30 19:35:24 | [diff] [blame] | 241 | enum TcpCandidatePolicy { |
| 242 | kTcpCandidatePolicyEnabled, |
| 243 | kTcpCandidatePolicyDisabled |
| 244 | }; |
| 245 | |
honghaiz | 6034705 | 2016-06-01 01:29:12 | [diff] [blame] | 246 | enum CandidateNetworkPolicy { |
| 247 | kCandidateNetworkPolicyAll, |
| 248 | kCandidateNetworkPolicyLowCost |
| 249 | }; |
| 250 | |
honghaiz | 1f429e3 | 2015-09-28 14:57:34 | [diff] [blame] | 251 | enum ContinualGatheringPolicy { |
| 252 | GATHER_ONCE, |
| 253 | GATHER_CONTINUALLY |
| 254 | }; |
| 255 | |
Honghai Zhang | f7ddc06 | 2016-09-01 22:34:01 | [diff] [blame] | 256 | 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öm | 87713d0 | 2015-08-25 07:53:21 | [diff] [blame] | 265 | // TODO(hbos): Change into class with private data and public getters. |
nisse | c36b31b | 2016-04-12 06:25:29 | [diff] [blame] | 266 | // 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.org | fd630a5 | 2015-01-14 23:19:06 | [diff] [blame] | 271 | struct RTCConfiguration { |
Niels Möller | 71bdda0 | 2016-03-31 10:59:59 | [diff] [blame] | 272 | // 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 Zhang | f7ddc06 | 2016-09-01 22:34:01 | [diff] [blame] | 278 | RTCConfiguration() = default; |
oprypin | 803dc29 | 2017-02-01 09:55:59 | [diff] [blame] | 279 | explicit RTCConfiguration(RTCConfigurationType type) { |
Honghai Zhang | f7ddc06 | 2016-09-01 22:34:01 | [diff] [blame] | 280 | if (type == RTCConfigurationType::kAggressive) { |
Honghai Zhang | aecd982 | 2016-09-02 23:58:17 | [diff] [blame] | 281 | // 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 Zhang | f7ddc06 | 2016-09-01 22:34:01 | [diff] [blame] | 291 | redetermine_role_on_ice_restart = false; |
| 292 | } |
Honghai Zhang | bfd398c | 2016-08-31 05:07:42 | [diff] [blame] | 293 | } |
| 294 | |
deadbeef | 293e926 | 2017-01-11 20:28:30 | [diff] [blame] | 295 | bool operator==(const RTCConfiguration& o) const; |
| 296 | bool operator!=(const RTCConfiguration& o) const; |
| 297 | |
nisse | c36b31b | 2016-04-12 06:25:29 | [diff] [blame] | 298 | bool dscp() { return media_config.enable_dscp; } |
| 299 | void set_dscp(bool enable) { media_config.enable_dscp = enable; } |
Niels Möller | 71bdda0 | 2016-03-31 10:59:59 | [diff] [blame] | 300 | |
| 301 | // TODO(nisse): The corresponding flag in MediaConfig and |
| 302 | // elsewhere should be renamed enable_cpu_adaptation. |
nisse | c36b31b | 2016-04-12 06:25:29 | [diff] [blame] | 303 | bool cpu_adaptation() { |
| 304 | return media_config.video.enable_cpu_overuse_detection; |
| 305 | } |
Niels Möller | 71bdda0 | 2016-03-31 10:59:59 | [diff] [blame] | 306 | void set_cpu_adaptation(bool enable) { |
nisse | c36b31b | 2016-04-12 06:25:29 | [diff] [blame] | 307 | media_config.video.enable_cpu_overuse_detection = enable; |
Niels Möller | 71bdda0 | 2016-03-31 10:59:59 | [diff] [blame] | 308 | } |
| 309 | |
nisse | c36b31b | 2016-04-12 06:25:29 | [diff] [blame] | 310 | bool suspend_below_min_bitrate() { |
| 311 | return media_config.video.suspend_below_min_bitrate; |
| 312 | } |
Niels Möller | 71bdda0 | 2016-03-31 10:59:59 | [diff] [blame] | 313 | void set_suspend_below_min_bitrate(bool enable) { |
nisse | c36b31b | 2016-04-12 06:25:29 | [diff] [blame] | 314 | media_config.video.suspend_below_min_bitrate = enable; |
Niels Möller | 71bdda0 | 2016-03-31 10:59:59 | [diff] [blame] | 315 | } |
| 316 | |
| 317 | // TODO(nisse): The negation in the corresponding MediaConfig |
| 318 | // attribute is inconsistent, and it should be renamed at some |
| 319 | // point. |
nisse | c36b31b | 2016-04-12 06:25:29 | [diff] [blame] | 320 | bool prerenderer_smoothing() { |
| 321 | return !media_config.video.disable_prerenderer_smoothing; |
| 322 | } |
Niels Möller | 71bdda0 | 2016-03-31 10:59:59 | [diff] [blame] | 323 | void set_prerenderer_smoothing(bool enable) { |
nisse | c36b31b | 2016-04-12 06:25:29 | [diff] [blame] | 324 | media_config.video.disable_prerenderer_smoothing = !enable; |
Niels Möller | 71bdda0 | 2016-03-31 10:59:59 | [diff] [blame] | 325 | } |
| 326 | |
honghaiz | 4edc39c | 2015-09-01 16:53:56 | [diff] [blame] | 327 | static const int kUndefined = -1; |
| 328 | // Default maximum number of packets in the audio jitter buffer. |
| 329 | static const int kAudioJitterBufferMaxPackets = 50; |
Honghai Zhang | aecd982 | 2016-09-02 23:58:17 | [diff] [blame] | 330 | // ICE connection receiving timeout for aggressive configuration. |
| 331 | static const int kAggressiveIceConnectionReceivingTimeout = 1000; |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 332 | |
| 333 | //////////////////////////////////////////////////////////////////////// |
| 334 | // The below few fields mirror the standard RTCConfiguration dictionary: |
| 335 | // https://www.w3.org/TR/webrtc/#rtcconfiguration-dictionary |
| 336 | //////////////////////////////////////////////////////////////////////// |
| 337 | |
pthatcher@webrtc.org | fd630a5 | 2015-01-14 23:19:06 | [diff] [blame] | 338 | // TODO(pthatcher): Rename this ice_servers, but update Chromium |
| 339 | // at the same time. |
| 340 | IceServers servers; |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 341 | // TODO(pthatcher): Rename this ice_transport_type, but update |
| 342 | // Chromium at the same time. |
| 343 | IceTransportsType type = kAll; |
Taylor Brandstetter | a1c3035 | 2016-05-13 15:15:11 | [diff] [blame] | 344 | BundlePolicy bundle_policy = kBundlePolicyBalanced; |
zhihuang | 4dfb8ce | 2016-11-23 18:30:12 | [diff] [blame] | 345 | RtcpMuxPolicy rtcp_mux_policy = kRtcpMuxPolicyRequire; |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 346 | 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 | |
zhihuang | b09b3f9 | 2017-03-07 22:40:51 | [diff] [blame] | 362 | // 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 | |
deadbeef | d21eab3e | 2017-07-26 23:50:11 | [diff] [blame] | 368 | // 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 | |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 375 | // 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 Brandstetter | a1c3035 | 2016-05-13 15:15:11 | [diff] [blame] | 399 | TcpCandidatePolicy tcp_candidate_policy = kTcpCandidatePolicyEnabled; |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 400 | |
| 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. |
honghaiz | 6034705 | 2016-06-01 01:29:12 | [diff] [blame] | 405 | CandidateNetworkPolicy candidate_network_policy = |
| 406 | kCandidateNetworkPolicyAll; |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 407 | |
| 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 Brandstetter | a1c3035 | 2016-05-13 15:15:11 | [diff] [blame] | 410 | int audio_jitter_buffer_max_packets = kAudioJitterBufferMaxPackets; |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 411 | |
| 412 | // Whether to use the NetEq "fast mode" which will accelerate audio quicker |
| 413 | // if it falls behind. |
Taylor Brandstetter | a1c3035 | 2016-05-13 15:15:11 | [diff] [blame] | 414 | bool audio_jitter_buffer_fast_accelerate = false; |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 415 | |
| 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 Brandstetter | a1c3035 | 2016-05-13 15:15:11 | [diff] [blame] | 434 | ContinualGatheringPolicy continual_gathering_policy = GATHER_ONCE; |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 435 | |
| 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 Brandstetter | a1c3035 | 2016-05-13 15:15:11 | [diff] [blame] | 439 | bool prioritize_most_likely_ice_candidate_pairs = false; |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 440 | |
nisse | c36b31b | 2016-04-12 06:25:29 | [diff] [blame] | 441 | struct cricket::MediaConfig media_config; |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 442 | |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 443 | // 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 Zhang | b9e7b4a | 2016-07-01 03:52:02 | [diff] [blame] | 446 | bool prune_turn_ports = false; |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 447 | |
Taylor Brandstetter | e985111 | 2016-07-01 18:11:13 | [diff] [blame] | 448 | // 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. |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 450 | // This can be used to optimize the initial connection time, since the DTLS |
| 451 | // handshake can begin immediately. |
Taylor Brandstetter | e985111 | 2016-07-01 18:11:13 | [diff] [blame] | 452 | bool presume_writable_when_fully_relayed = false; |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 453 | |
Honghai Zhang | 4cedf2b | 2016-08-31 15:18:11 | [diff] [blame] | 454 | // If true, "renomination" will be added to the ice options in the transport |
| 455 | // description. |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 456 | // See: https://tools.ietf.org/html/draft-thatcher-ice-renomination-00 |
Honghai Zhang | 4cedf2b | 2016-08-31 15:18:11 | [diff] [blame] | 457 | bool enable_ice_renomination = false; |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 458 | |
| 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 Zhang | bfd398c | 2016-08-31 05:07:42 | [diff] [blame] | 465 | bool redetermine_role_on_ice_restart = true; |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 466 | |
skvlad | 5107246 | 2017-02-02 19:50:14 | [diff] [blame] | 467 | // 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; |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 470 | |
Steve Anton | 300bf8e | 2017-07-14 17:13:10 | [diff] [blame] | 471 | // 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 Oreland | bdcee28 | 2017-10-10 12:01:40 | [diff] [blame] | 477 | // 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 Anton | 79e7960 | 2017-11-20 18:25:56 | [diff] [blame] | 483 | // 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 | |
deadbeef | 293e926 | 2017-01-11 20:28:30 | [diff] [blame] | 511 | // |
| 512 | // Don't forget to update operator== if adding something. |
| 513 | // |
buildbot@webrtc.org | 41451d4 | 2014-05-03 05:39:45 | [diff] [blame] | 514 | }; |
| 515 | |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 516 | // See: https://www.w3.org/TR/webrtc/#idl-def-rtcofferansweroptions |
jiayl@webrtc.org | b18bf5e | 2014-08-04 18:34:16 | [diff] [blame] | 517 | 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 | |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 524 | // 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 Zhang | 4cedf2b | 2016-08-31 15:18:11 | [diff] [blame] | 533 | int offer_to_receive_video = kUndefined; |
| 534 | int offer_to_receive_audio = kUndefined; |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 535 | |
Honghai Zhang | 4cedf2b | 2016-08-31 15:18:11 | [diff] [blame] | 536 | bool voice_activity_detection = true; |
| 537 | bool ice_restart = false; |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 538 | |
| 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 Zhang | 4cedf2b | 2016-08-31 15:18:11 | [diff] [blame] | 541 | bool use_rtp_mux = true; |
jiayl@webrtc.org | b18bf5e | 2014-08-04 18:34:16 | [diff] [blame] | 542 | |
Honghai Zhang | 4cedf2b | 2016-08-31 15:18:11 | [diff] [blame] | 543 | RTCOfferAnswerOptions() = default; |
jiayl@webrtc.org | b18bf5e | 2014-08-04 18:34:16 | [diff] [blame] | 544 | |
| 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.org | b9a088b | 2014-02-13 23:18:49 | [diff] [blame] | 557 | // 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.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 566 | // Accessor methods to active local streams. |
buildbot@webrtc.org | d4e598d | 2014-07-29 17:36:52 | [diff] [blame] | 567 | virtual rtc::scoped_refptr<StreamCollectionInterface> |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 568 | local_streams() = 0; |
| 569 | |
| 570 | // Accessor methods to remote streams. |
buildbot@webrtc.org | d4e598d | 2014-07-29 17:36:52 | [diff] [blame] | 571 | virtual rtc::scoped_refptr<StreamCollectionInterface> |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 572 | 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. |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 577 | // |
| 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.org | fd0efb6 | 2014-11-06 12:16:36 | [diff] [blame] | 583 | virtual bool AddStream(MediaStreamInterface* stream) = 0; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 584 | |
| 585 | // Remove a MediaStream from this PeerConnection. |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 586 | // Note that a SessionDescription negotiation is needed before the |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 587 | // remote peer is notified. |
| 588 | virtual void RemoveStream(MediaStreamInterface* stream) = 0; |
| 589 | |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 590 | // Add a new MediaStreamTrack to be sent on this PeerConnection, and return |
| 591 | // the newly created RtpSender. |
| 592 | // |
deadbeef | e1f9d83 | 2016-01-14 23:35:42 | [diff] [blame] | 593 | // |streams| indicates which stream labels the track should be associated |
| 594 | // with. |
| 595 | virtual rtc::scoped_refptr<RtpSenderInterface> AddTrack( |
| 596 | MediaStreamTrackInterface* track, |
nisse | 7f06766 | 2017-03-08 14:59:45 | [diff] [blame] | 597 | std::vector<MediaStreamInterface*> streams) = 0; |
deadbeef | e1f9d83 | 2016-01-14 23:35:42 | [diff] [blame] | 598 | |
| 599 | // Remove an RtpSender from this PeerConnection. |
| 600 | // Returns true on success. |
nisse | 7f06766 | 2017-03-08 14:59:45 | [diff] [blame] | 601 | virtual bool RemoveTrack(RtpSenderInterface* sender) = 0; |
deadbeef | e1f9d83 | 2016-01-14 23:35:42 | [diff] [blame] | 602 | |
deadbeef | 8d60a94 | 2017-02-27 22:47:33 | [diff] [blame] | 603 | // Returns pointer to a DtmfSender on success. Otherwise returns null. |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 604 | // |
| 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.org | d4e598d | 2014-07-29 17:36:52 | [diff] [blame] | 608 | virtual rtc::scoped_refptr<DtmfSenderInterface> CreateDtmfSender( |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 609 | AudioTrackInterface* track) = 0; |
| 610 | |
deadbeef | 70ab1a1 | 2015-09-28 23:53:55 | [diff] [blame] | 611 | // TODO(deadbeef): Make these pure virtual once all subclasses implement them. |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 612 | |
| 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 | // |
deadbeef | fac0655 | 2015-11-25 19:26:01 | [diff] [blame] | 620 | // |kind| must be "audio" or "video". |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 621 | // |
deadbeef | bd7d8f7 | 2015-12-19 00:58:44 | [diff] [blame] | 622 | // |stream_id| is used to populate the msid attribute; if empty, one will |
| 623 | // be generated automatically. |
deadbeef | fac0655 | 2015-11-25 19:26:01 | [diff] [blame] | 624 | virtual rtc::scoped_refptr<RtpSenderInterface> CreateSender( |
deadbeef | bd7d8f7 | 2015-12-19 00:58:44 | [diff] [blame] | 625 | const std::string& kind, |
| 626 | const std::string& stream_id) { |
deadbeef | fac0655 | 2015-11-25 19:26:01 | [diff] [blame] | 627 | return rtc::scoped_refptr<RtpSenderInterface>(); |
| 628 | } |
| 629 | |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 630 | // 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. |
deadbeef | 70ab1a1 | 2015-09-28 23:53:55 | [diff] [blame] | 634 | virtual std::vector<rtc::scoped_refptr<RtpSenderInterface>> GetSenders() |
| 635 | const { |
| 636 | return std::vector<rtc::scoped_refptr<RtpSenderInterface>>(); |
| 637 | } |
| 638 | |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 639 | // 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. |
deadbeef | 70ab1a1 | 2015-09-28 23:53:55 | [diff] [blame] | 647 | virtual std::vector<rtc::scoped_refptr<RtpReceiverInterface>> GetReceivers() |
| 648 | const { |
| 649 | return std::vector<rtc::scoped_refptr<RtpReceiverInterface>>(); |
| 650 | } |
| 651 | |
wu@webrtc.org | b9a088b | 2014-02-13 23:18:49 | [diff] [blame] | 652 | virtual bool GetStats(StatsObserver* observer, |
| 653 | MediaStreamTrackInterface* track, |
| 654 | StatsOutputLevel level) = 0; |
hbos | 74e1a4f | 2016-09-16 06:33:01 | [diff] [blame] | 655 | // 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. |
hbos | e381015 | 2016-12-13 10:35:19 | [diff] [blame] | 657 | // 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.org | b9a088b | 2014-02-13 23:18:49 | [diff] [blame] | 661 | |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 662 | // 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.org | d4e598d | 2014-07-29 17:36:52 | [diff] [blame] | 669 | virtual rtc::scoped_refptr<DataChannelInterface> CreateDataChannel( |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 670 | const std::string& label, |
| 671 | const DataChannelInit* config) = 0; |
| 672 | |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 673 | // Returns the more recently applied description; "pending" if it exists, and |
| 674 | // otherwise "current". See below. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 675 | virtual const SessionDescriptionInterface* local_description() const = 0; |
| 676 | virtual const SessionDescriptionInterface* remote_description() const = 0; |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 677 | |
deadbeef | fe4a8a4 | 2016-12-21 01:56:17 | [diff] [blame] | 678 | // 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 | } |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 687 | |
deadbeef | fe4a8a4 | 2016-12-21 01:56:17 | [diff] [blame] | 688 | // 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.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 698 | |
| 699 | // Create a new offer. |
| 700 | // The CreateSessionDescriptionObserver callback will be called when done. |
| 701 | virtual void CreateOffer(CreateSessionDescriptionObserver* observer, |
jiayl@webrtc.org | b18bf5e | 2014-08-04 18:34:16 | [diff] [blame] | 702 | 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.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 709 | // Create an answer to an offer. |
| 710 | // The CreateSessionDescriptionObserver callback will be called when done. |
| 711 | virtual void CreateAnswer(CreateSessionDescriptionObserver* observer, |
hta | a2a49d9 | 2016-03-04 10:51:39 | [diff] [blame] | 712 | 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.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 719 | // Sets the local session description. |
deadbeef | 1dcb164 | 2017-03-30 04:08:16 | [diff] [blame] | 720 | // The PeerConnection takes the ownership of |desc| even if it fails. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 721 | // The |observer| callback will be called when done. |
deadbeef | 1dcb164 | 2017-03-30 04:08:16 | [diff] [blame] | 722 | // TODO(deadbeef): Change |desc| to be a unique_ptr, to make it clear |
| 723 | // that this method always takes ownership of it. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 724 | virtual void SetLocalDescription(SetSessionDescriptionObserver* observer, |
| 725 | SessionDescriptionInterface* desc) = 0; |
| 726 | // Sets the remote session description. |
deadbeef | 1dcb164 | 2017-03-30 04:08:16 | [diff] [blame] | 727 | // The PeerConnection takes the ownership of |desc| even if it fails. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 728 | // The |observer| callback will be called when done. |
| 729 | virtual void SetRemoteDescription(SetSessionDescriptionObserver* observer, |
| 730 | SessionDescriptionInterface* desc) = 0; |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 731 | // Deprecated; Replaced by SetConfiguration. |
deadbeef | a67696b | 2015-09-29 18:56:26 | [diff] [blame] | 732 | // TODO(deadbeef): Remove once Chrome is moved over to SetConfiguration. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 733 | virtual bool UpdateIce(const IceServers& configuration, |
deadbeef | a67696b | 2015-09-29 18:56:26 | [diff] [blame] | 734 | const MediaConstraintsInterface* constraints) { |
| 735 | return false; |
| 736 | } |
hta | a2a49d9 | 2016-03-04 10:51:39 | [diff] [blame] | 737 | virtual bool UpdateIce(const IceServers& configuration) { return false; } |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 738 | |
deadbeef | 46c7389 | 2016-11-17 03:42:04 | [diff] [blame] | 739 | // 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 | } |
deadbeef | 293e926 | 2017-01-11 20:28:30 | [diff] [blame] | 744 | |
deadbeef | a67696b | 2015-09-29 18:56:26 | [diff] [blame] | 745 | // Sets the PeerConnection's global configuration to |config|. |
deadbeef | 293e926 | 2017-01-11 20:28:30 | [diff] [blame] | 746 | // |
| 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 | // |
deadbeef | a67696b | 2015-09-29 18:56:26 | [diff] [blame] | 753 | // 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 |
deadbeef | 293e926 | 2017-01-11 20:28:30 | [diff] [blame] | 755 | // 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 | // |
deadbeef | a67696b | 2015-09-29 18:56:26 | [diff] [blame] | 766 | // TODO(deadbeef): Make this pure virtual once all Chrome subclasses of |
| 767 | // PeerConnectionInterface implement it. |
| 768 | virtual bool SetConfiguration( |
deadbeef | 293e926 | 2017-01-11 20:28:30 | [diff] [blame] | 769 | 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( |
deadbeef | 1e23461 | 2016-12-24 09:43:32 | [diff] [blame] | 776 | const PeerConnectionInterface::RTCConfiguration& config) { |
deadbeef | a67696b | 2015-09-29 18:56:26 | [diff] [blame] | 777 | return false; |
| 778 | } |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 779 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 780 | // 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.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 784 | virtual bool AddIceCandidate(const IceCandidateInterface* candidate) = 0; |
| 785 | |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 786 | // 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 Zhang | 7fb69db | 2016-03-14 18:59:18 | [diff] [blame] | 789 | virtual bool RemoveIceCandidates( |
| 790 | const std::vector<cricket::Candidate>& candidates) { |
| 791 | return false; |
| 792 | } |
| 793 | |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 794 | // 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.org | 1567b8c | 2014-05-08 19:54:16 | [diff] [blame] | 798 | virtual void RegisterUMAObserver(UMAObserver* observer) = 0; |
| 799 | |
zstein | 4b97980 | 2017-06-02 21:37:37 | [diff] [blame] | 800 | // 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. |
zstein | 83dc6b6 | 2017-07-17 22:09:30 | [diff] [blame] | 813 | virtual RTCError SetBitrate(const BitrateParameters& bitrate) = 0; |
zstein | 4b97980 | 2017-06-02 21:37:37 | [diff] [blame] | 814 | |
Alex Narest | 78609d5 | 2017-10-20 08:37:47 | [diff] [blame] | 815 | // 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 | |
henrika | 5f6bf24 | 2017-11-01 10:06:56 | [diff] [blame] | 823 | // 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.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 838 | // Returns the current SignalingState. |
| 839 | virtual SignalingState signaling_state() = 0; |
Taylor Brandstetter | cb423c4 | 2017-10-22 18:52:32 | [diff] [blame] | 840 | |
| 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.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 845 | virtual IceConnectionState ice_connection_state() = 0; |
Taylor Brandstetter | cb423c4 | 2017-10-22 18:52:32 | [diff] [blame] | 846 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 847 | virtual IceGatheringState ice_gathering_state() = 0; |
| 848 | |
ivoc | 14d5dbe | 2016-07-04 14:06:55 | [diff] [blame] | 849 | // 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 Alon | 99c3fe5 | 2017-10-13 14:29:40 | [diff] [blame] | 854 | // TODO(eladalon): Deprecate and remove this. |
ivoc | 14d5dbe | 2016-07-04 14:06:55 | [diff] [blame] | 855 | virtual bool StartRtcEventLog(rtc::PlatformFile file, |
| 856 | int64_t max_size_bytes) { |
| 857 | return false; |
| 858 | } |
| 859 | |
Elad Alon | 99c3fe5 | 2017-10-13 14:29:40 | [diff] [blame] | 860 | // 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 Terelius | de93943 | 2017-11-20 16:38:14 | [diff] [blame] | 862 | // 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 Alon | 99c3fe5 | 2017-10-13 14:29:40 | [diff] [blame] | 866 | return false; |
| 867 | } |
| 868 | |
ivoc | 14d5dbe | 2016-07-04 14:06:55 | [diff] [blame] | 869 | // Stops logging the RtcEventLog. |
| 870 | // TODO(ivoc): Make this pure virtual when Chrome is updated. |
| 871 | virtual void StopRtcEventLog() {} |
| 872 | |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 873 | // Terminates all media, closes the transports, and in general releases any |
| 874 | // resources used by the PeerConnection. This is an irreversible operation. |
deadbeef | d07061c | 2017-04-20 20:19:00 | [diff] [blame] | 875 | // |
| 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.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 879 | virtual void Close() = 0; |
| 880 | |
| 881 | protected: |
| 882 | // Dtor protected as objects shouldn't be deleted via this interface. |
| 883 | ~PeerConnectionInterface() {} |
| 884 | }; |
| 885 | |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 886 | // PeerConnection callback interface, used for RTCPeerConnection events. |
| 887 | // Application should implement these methods. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 888 | class PeerConnectionObserver { |
| 889 | public: |
| 890 | enum StateType { |
| 891 | kSignalingState, |
| 892 | kIceState, |
| 893 | }; |
| 894 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 895 | // Triggered when the SignalingState changed. |
| 896 | virtual void OnSignalingChange( |
perkj | dfb769d | 2016-02-09 11:09:43 | [diff] [blame] | 897 | PeerConnectionInterface::SignalingState new_state) = 0; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 898 | |
Taylor Brandstetter | 98cde26 | 2016-05-31 20:02:21 | [diff] [blame] | 899 | // 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.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 903 | // Triggered when media is received on a new stream from remote peer. |
nisse | 7f06766 | 2017-03-08 14:59:45 | [diff] [blame] | 904 | virtual void OnAddStream(rtc::scoped_refptr<MediaStreamInterface> stream) = 0; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 905 | |
| 906 | // Triggered when a remote peer close a stream. |
nisse | 7f06766 | 2017-03-08 14:59:45 | [diff] [blame] | 907 | virtual void OnRemoveStream( |
| 908 | rtc::scoped_refptr<MediaStreamInterface> stream) = 0; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 909 | |
Taylor Brandstetter | 98cde26 | 2016-05-31 20:02:21 | [diff] [blame] | 910 | // Triggered when a remote peer opens a data channel. |
| 911 | virtual void OnDataChannel( |
nisse | 7f06766 | 2017-03-08 14:59:45 | [diff] [blame] | 912 | rtc::scoped_refptr<DataChannelInterface> data_channel) = 0; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 913 | |
Taylor Brandstetter | 98cde26 | 2016-05-31 20:02:21 | [diff] [blame] | 914 | // Triggered when renegotiation is needed. For example, an ICE restart |
| 915 | // has begun. |
fischman@webrtc.org | d7568a0 | 2014-01-13 22:04:12 | [diff] [blame] | 916 | virtual void OnRenegotiationNeeded() = 0; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 917 | |
Taylor Brandstetter | 98cde26 | 2016-05-31 20:02:21 | [diff] [blame] | 918 | // Called any time the IceConnectionState changes. |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 919 | // |
| 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.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 924 | virtual void OnIceConnectionChange( |
perkj | dfb769d | 2016-02-09 11:09:43 | [diff] [blame] | 925 | PeerConnectionInterface::IceConnectionState new_state) = 0; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 926 | |
Taylor Brandstetter | 98cde26 | 2016-05-31 20:02:21 | [diff] [blame] | 927 | // Called any time the IceGatheringState changes. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 928 | virtual void OnIceGatheringChange( |
perkj | dfb769d | 2016-02-09 11:09:43 | [diff] [blame] | 929 | PeerConnectionInterface::IceGatheringState new_state) = 0; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 930 | |
Taylor Brandstetter | 98cde26 | 2016-05-31 20:02:21 | [diff] [blame] | 931 | // A new ICE candidate has been gathered. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 932 | virtual void OnIceCandidate(const IceCandidateInterface* candidate) = 0; |
| 933 | |
Honghai Zhang | 7fb69db | 2016-03-14 18:59:18 | [diff] [blame] | 934 | // 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 Thatcher | 5436051 | 2015-07-08 18:08:35 | [diff] [blame] | 940 | // Called when the ICE connection receiving status changes. |
| 941 | virtual void OnIceConnectionReceivingChange(bool receiving) {} |
| 942 | |
Henrik Boström | 933d8b0 | 2017-10-10 17:05:16 | [diff] [blame] | 943 | // This is called when a receiver and its track is created. |
| 944 | // TODO(zhihuang): Make this pure virtual when all subclasses implement it. |
zhihuang | 81c3a03 | 2016-11-17 20:06:24 | [diff] [blame] | 945 | virtual void OnAddTrack( |
| 946 | rtc::scoped_refptr<RtpReceiverInterface> receiver, |
zhihuang | c63b894 | 2016-12-02 23:41:10 | [diff] [blame] | 947 | const std::vector<rtc::scoped_refptr<MediaStreamInterface>>& streams) {} |
zhihuang | 81c3a03 | 2016-11-17 20:06:24 | [diff] [blame] | 948 | |
Henrik Boström | 933d8b0 | 2017-10-10 17:05:16 | [diff] [blame] | 949 | // 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.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 968 | protected: |
| 969 | // Dtor protected as objects shouldn't be deleted via this interface. |
| 970 | ~PeerConnectionObserver() {} |
| 971 | }; |
| 972 | |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 973 | // 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.org | d4e598d | 2014-07-29 17:36:52 | [diff] [blame] | 986 | class PeerConnectionFactoryInterface : public rtc::RefCountInterface { |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 987 | public: |
wu@webrtc.org | 97077a3 | 2013-10-25 21:18:33 | [diff] [blame] | 988 | class Options { |
| 989 | public: |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 990 | 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.org | 006521d | 2015-02-12 09:23:59 | [diff] [blame] | 1007 | |
| 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. |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 1011 | int network_ignore_mask = rtc::kDefaultNetworkIgnoreMask; |
Joachim Bauch | 04e5b49 | 2015-05-29 07:40:39 | [diff] [blame] | 1012 | |
| 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. |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 1016 | rtc::SSLProtocolVersion ssl_max_version = rtc::SSL_PROTOCOL_DTLS_12; |
jbauch | cb56065 | 2016-08-04 12:20:32 | [diff] [blame] | 1017 | |
| 1018 | // Sets crypto related options, e.g. enabled cipher suites. |
| 1019 | rtc::CryptoOptions crypto_options; |
wu@webrtc.org | 97077a3 | 2013-10-25 21:18:33 | [diff] [blame] | 1020 | }; |
| 1021 | |
deadbeef | 7914b8c | 2017-04-21 10:23:33 | [diff] [blame] | 1022 | // Set the options to be used for subsequently created PeerConnections. |
wu@webrtc.org | 97077a3 | 2013-10-25 21:18:33 | [diff] [blame] | 1023 | virtual void SetOptions(const Options& options) = 0; |
buildbot@webrtc.org | 41451d4 | 2014-05-03 05:39:45 | [diff] [blame] | 1024 | |
deadbeef | d07061c | 2017-04-20 20:19:00 | [diff] [blame] | 1025 | // |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. |
deadbeef | 41b0798 | 2015-12-01 23:01:24 | [diff] [blame] | 1034 | virtual rtc::scoped_refptr<PeerConnectionInterface> CreatePeerConnection( |
| 1035 | const PeerConnectionInterface::RTCConfiguration& configuration, |
kwiberg | d1fe281 | 2016-04-27 13:47:29 | [diff] [blame] | 1036 | std::unique_ptr<cricket::PortAllocator> allocator, |
Henrik Boström | d03c23b | 2016-06-01 09:44:18 | [diff] [blame] | 1037 | std::unique_ptr<rtc::RTCCertificateGeneratorInterface> cert_generator, |
hbos | d7973cc | 2016-05-27 13:08:53 | [diff] [blame] | 1038 | PeerConnectionObserver* observer) = 0; |
buildbot@webrtc.org | 41451d4 | 2014-05-03 05:39:45 | [diff] [blame] | 1039 | |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 1040 | // Deprecated; should use RTCConfiguration for everything that previously |
| 1041 | // used constraints. |
hta | a2a49d9 | 2016-03-04 10:51:39 | [diff] [blame] | 1042 | virtual rtc::scoped_refptr<PeerConnectionInterface> CreatePeerConnection( |
| 1043 | const PeerConnectionInterface::RTCConfiguration& configuration, |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 1044 | const MediaConstraintsInterface* constraints, |
kwiberg | d1fe281 | 2016-04-27 13:47:29 | [diff] [blame] | 1045 | std::unique_ptr<cricket::PortAllocator> allocator, |
Henrik Boström | d03c23b | 2016-06-01 09:44:18 | [diff] [blame] | 1046 | std::unique_ptr<rtc::RTCCertificateGeneratorInterface> cert_generator, |
hbos | d7973cc | 2016-05-27 13:08:53 | [diff] [blame] | 1047 | PeerConnectionObserver* observer) = 0; |
hta | a2a49d9 | 2016-03-04 10:51:39 | [diff] [blame] | 1048 | |
buildbot@webrtc.org | d4e598d | 2014-07-29 17:36:52 | [diff] [blame] | 1049 | virtual rtc::scoped_refptr<MediaStreamInterface> |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 1050 | CreateLocalMediaStream(const std::string& label) = 0; |
| 1051 | |
deadbeef | e814a0d | 2017-02-26 02:15:09 | [diff] [blame] | 1052 | // Creates an AudioSourceInterface. |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 1053 | // |options| decides audio processing settings. |
buildbot@webrtc.org | d4e598d | 2014-07-29 17:36:52 | [diff] [blame] | 1054 | virtual rtc::scoped_refptr<AudioSourceInterface> CreateAudioSource( |
hta | a2a49d9 | 2016-03-04 10:51:39 | [diff] [blame] | 1055 | const cricket::AudioOptions& options) = 0; |
| 1056 | // Deprecated - use version above. |
deadbeef | fe0fd41 | 2017-01-13 19:47:56 | [diff] [blame] | 1057 | // Can use CopyConstraintsIntoAudioOptions to bridge the gap. |
hta | a2a49d9 | 2016-03-04 10:51:39 | [diff] [blame] | 1058 | virtual rtc::scoped_refptr<AudioSourceInterface> CreateAudioSource( |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 1059 | const MediaConstraintsInterface* constraints) = 0; |
| 1060 | |
deadbeef | 39e14da | 2017-02-13 17:49:58 | [diff] [blame] | 1061 | // 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. |
deadbeef | 112b2e9 | 2017-02-11 04:13:37 | [diff] [blame] | 1066 | // TODO(deadbeef): Make pure virtual once downstream mock PC factory classes |
| 1067 | // are updated. |
perkj | a3ede6c | 2016-03-08 00:27:48 | [diff] [blame] | 1068 | virtual rtc::scoped_refptr<VideoTrackSourceInterface> CreateVideoSource( |
deadbeef | 112b2e9 | 2017-02-11 04:13:37 | [diff] [blame] | 1069 | std::unique_ptr<cricket::VideoCapturer> capturer) { |
| 1070 | return nullptr; |
| 1071 | } |
| 1072 | |
hta | a2a49d9 | 2016-03-04 10:51:39 | [diff] [blame] | 1073 | // A video source creator that allows selection of resolution and frame rate. |
deadbeef | 8d60a94 | 2017-02-27 22:47:33 | [diff] [blame] | 1074 | // |constraints| decides video resolution and frame rate but can be null. |
| 1075 | // In the null case, use the version above. |
deadbeef | 112b2e9 | 2017-02-11 04:13:37 | [diff] [blame] | 1076 | // |
| 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 | } |
perkj | a3ede6c | 2016-03-08 00:27:48 | [diff] [blame] | 1091 | virtual rtc::scoped_refptr<VideoTrackSourceInterface> CreateVideoSource( |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 1092 | cricket::VideoCapturer* capturer, |
deadbeef | 112b2e9 | 2017-02-11 04:13:37 | [diff] [blame] | 1093 | const MediaConstraintsInterface* constraints) { |
| 1094 | return CreateVideoSource(std::unique_ptr<cricket::VideoCapturer>(capturer), |
| 1095 | constraints); |
| 1096 | } |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 1097 | |
| 1098 | // Creates a new local VideoTrack. The same |source| can be used in several |
| 1099 | // tracks. |
perkj | a3ede6c | 2016-03-08 00:27:48 | [diff] [blame] | 1100 | virtual rtc::scoped_refptr<VideoTrackInterface> CreateVideoTrack( |
| 1101 | const std::string& label, |
| 1102 | VideoTrackSourceInterface* source) = 0; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 1103 | |
deadbeef | 8d60a94 | 2017-02-27 22:47:33 | [diff] [blame] | 1104 | // Creates an new AudioTrack. At the moment |source| can be null. |
buildbot@webrtc.org | d4e598d | 2014-07-29 17:36:52 | [diff] [blame] | 1105 | virtual rtc::scoped_refptr<AudioTrackInterface> |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 1106 | CreateAudioTrack(const std::string& label, |
| 1107 | AudioSourceInterface* source) = 0; |
| 1108 | |
wu@webrtc.org | a989080 | 2013-12-13 00:21:03 | [diff] [blame] | 1109 | // 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.org | a8910d2 | 2014-01-23 22:12:45 | [diff] [blame] | 1111 | // the ownerhip. If the operation fails, the file will be closed. |
ivoc | d66b44d | 2016-01-15 11:06:36 | [diff] [blame] | 1112 | // 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.org | a989080 | 2013-12-13 00:21:03 | [diff] [blame] | 1117 | |
ivoc | 797ef12 | 2015-10-22 10:25:41 | [diff] [blame] | 1118 | // Stops logging the AEC dump. |
| 1119 | virtual void StopAecDump() = 0; |
| 1120 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 1121 | 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 Brandstetter | a8415fe | 2016-03-23 17:38:07 | [diff] [blame] | 1129 | // |
| 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. |
kwiberg | 1e4e8cb | 2017-01-31 09:48:08 | [diff] [blame] | 1138 | rtc::scoped_refptr<PeerConnectionFactoryInterface> CreatePeerConnectionFactory( |
| 1139 | rtc::scoped_refptr<AudioEncoderFactory> audio_encoder_factory, |
| 1140 | rtc::scoped_refptr<AudioDecoderFactory> audio_decoder_factory); |
| 1141 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 1142 | // Create a new instance of PeerConnectionFactoryInterface. |
Taylor Brandstetter | a8415fe | 2016-03-23 17:38:07 | [diff] [blame] | 1143 | // |
danilchap | e9021a3 | 2016-05-17 08:52:02 | [diff] [blame] | 1144 | // |network_thread|, |worker_thread| and |signaling_thread| are |
| 1145 | // the only mandatory parameters. |
Taylor Brandstetter | a8415fe | 2016-03-23 17:38:07 | [diff] [blame] | 1146 | // |
deadbeef | b10f32f | 2017-02-08 09:38:21 | [diff] [blame] | 1147 | // 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. |
danilchap | e9021a3 | 2016-05-17 08:52:02 | [diff] [blame] | 1152 | rtc::scoped_refptr<PeerConnectionFactoryInterface> CreatePeerConnectionFactory( |
| 1153 | rtc::Thread* network_thread, |
buildbot@webrtc.org | d4e598d | 2014-07-29 17:36:52 | [diff] [blame] | 1154 | rtc::Thread* worker_thread, |
| 1155 | rtc::Thread* signaling_thread, |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 1156 | AudioDeviceModule* default_adm, |
kwiberg | 1e4e8cb | 2017-01-31 09:48:08 | [diff] [blame] | 1157 | 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 | |
peah | 17675ce | 2017-06-30 14:24:04 | [diff] [blame] | 1162 | // 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. |
| 1168 | rtc::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 Jedvert | 58b0316 | 2017-09-15 17:02:47 | [diff] [blame] | 1180 | // 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. |
| 1183 | rtc::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 | |
gyzhou | 95aa964 | 2016-12-13 22:06:26 | [diff] [blame] | 1195 | // 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. |
| 1199 | rtc::scoped_refptr<PeerConnectionFactoryInterface> |
| 1200 | CreatePeerConnectionFactoryWithAudioMixer( |
| 1201 | rtc::Thread* network_thread, |
| 1202 | rtc::Thread* worker_thread, |
| 1203 | rtc::Thread* signaling_thread, |
| 1204 | AudioDeviceModule* default_adm, |
kwiberg | 1e4e8cb | 2017-01-31 09:48:08 | [diff] [blame] | 1205 | 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 | |
danilchap | e9021a3 | 2016-05-17 08:52:02 | [diff] [blame] | 1211 | // Create a new instance of PeerConnectionFactoryInterface. |
| 1212 | // Same thread is used as worker and network thread. |
danilchap | e9021a3 | 2016-05-17 08:52:02 | [diff] [blame] | 1213 | inline rtc::scoped_refptr<PeerConnectionFactoryInterface> |
| 1214 | CreatePeerConnectionFactory( |
| 1215 | rtc::Thread* worker_and_network_thread, |
| 1216 | rtc::Thread* signaling_thread, |
| 1217 | AudioDeviceModule* default_adm, |
kwiberg | 1e4e8cb | 2017-01-31 09:48:08 | [diff] [blame] | 1218 | 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 | |
zhihuang | 38ede13 | 2017-06-15 19:52:32 | [diff] [blame] | 1228 | // 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 | // |
peah | a9cc40b | 2017-06-29 15:32:09 | [diff] [blame] | 1252 | // If |audio_mixer| is null, an internal audio mixer will be created and used. |
| 1253 | // |
zhihuang | 38ede13 | 2017-06-15 19:52:32 | [diff] [blame] | 1254 | // 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. |
| 1260 | rtc::scoped_refptr<PeerConnectionFactoryInterface> |
| 1261 | CreateModularPeerConnectionFactory( |
| 1262 | rtc::Thread* network_thread, |
| 1263 | rtc::Thread* worker_thread, |
| 1264 | rtc::Thread* signaling_thread, |
zhihuang | 38ede13 | 2017-06-15 19:52:32 | [diff] [blame] | 1265 | 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.org | 28e2075 | 2013-07-10 00:45:36 | [diff] [blame] | 1269 | } // namespace webrtc |
| 1270 | |
Mirko Bonadei | 92ea95e | 2017-09-15 04:47:31 | [diff] [blame] | 1271 | #endif // API_PEERCONNECTIONINTERFACE_H_ |