henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 1 | /* |
kjellander | b24317b | 2016-02-10 07:54:43 -0800 | [diff] [blame] | 2 | * Copyright 2012 The WebRTC project authors. All Rights Reserved. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 3 | * |
kjellander | b24317b | 2016-02-10 07:54:43 -0800 | [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 +0000 | [diff] [blame] | 9 | */ |
| 10 | |
Henrik Kjellander | 15583c1 | 2016-02-10 10:53:12 +0100 | [diff] [blame] | 11 | #ifndef WEBRTC_API_WEBRTCSESSION_H_ |
| 12 | #define WEBRTC_API_WEBRTCSESSION_H_ |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 13 | |
deadbeef | 0ed85b2 | 2016-02-23 17:24:52 -0800 | [diff] [blame] | 14 | #include <set> |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 15 | #include <string> |
deadbeef | cbecd35 | 2015-09-23 11:50:27 -0700 | [diff] [blame] | 16 | #include <vector> |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 17 | |
Henrik Kjellander | 15583c1 | 2016-02-10 10:53:12 +0100 | [diff] [blame] | 18 | #include "webrtc/api/datachannel.h" |
| 19 | #include "webrtc/api/dtmfsender.h" |
| 20 | #include "webrtc/api/mediacontroller.h" |
| 21 | #include "webrtc/api/mediastreamprovider.h" |
| 22 | #include "webrtc/api/peerconnectioninterface.h" |
| 23 | #include "webrtc/api/statstypes.h" |
buildbot@webrtc.org | a09a999 | 2014-08-13 17:26:08 +0000 | [diff] [blame] | 24 | #include "webrtc/base/sigslot.h" |
Henrik Boström | 5e56c59 | 2015-08-11 10:33:13 +0200 | [diff] [blame] | 25 | #include "webrtc/base/sslidentity.h" |
buildbot@webrtc.org | a09a999 | 2014-08-13 17:26:08 +0000 | [diff] [blame] | 26 | #include "webrtc/base/thread.h" |
kjellander | a96e2d7 | 2016-02-04 23:52:28 -0800 | [diff] [blame] | 27 | #include "webrtc/media/base/mediachannel.h" |
Honghai Zhang | 7fb69db | 2016-03-14 11:59:18 -0700 | [diff] [blame] | 28 | #include "webrtc/p2p/base/candidate.h" |
Tommi | f888bb5 | 2015-12-12 01:37:01 +0100 | [diff] [blame] | 29 | #include "webrtc/p2p/base/transportcontroller.h" |
kjellander@webrtc.org | 9b8df25 | 2016-02-12 06:47:59 +0100 | [diff] [blame] | 30 | #include "webrtc/pc/mediasession.h" |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 31 | |
| 32 | namespace cricket { |
henrike@webrtc.org | b0ecc1c | 2014-03-26 22:44:28 +0000 | [diff] [blame] | 33 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 34 | class ChannelManager; |
| 35 | class DataChannel; |
| 36 | class StatsReport; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 37 | class VideoCapturer; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 38 | class VideoChannel; |
| 39 | class VoiceChannel; |
henrike@webrtc.org | b0ecc1c | 2014-03-26 22:44:28 +0000 | [diff] [blame] | 40 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 41 | } // namespace cricket |
| 42 | |
| 43 | namespace webrtc { |
buildbot@webrtc.org | 41451d4 | 2014-05-03 05:39:45 +0000 | [diff] [blame] | 44 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 45 | class IceRestartAnswerLatch; |
buildbot@webrtc.org | 41451d4 | 2014-05-03 05:39:45 +0000 | [diff] [blame] | 46 | class JsepIceCandidate; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 47 | class MediaStreamSignaling; |
wu@webrtc.org | 91053e7 | 2013-08-10 07:18:04 +0000 | [diff] [blame] | 48 | class WebRtcSessionDescriptionFactory; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 49 | |
henrike@webrtc.org | 1e09a71 | 2013-07-26 19:17:59 +0000 | [diff] [blame] | 50 | extern const char kBundleWithoutRtcpMux[]; |
sergeyu@chromium.org | 4b26e2e | 2014-01-15 23:15:54 +0000 | [diff] [blame] | 51 | extern const char kCreateChannelFailed[]; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 52 | extern const char kInvalidCandidates[]; |
| 53 | extern const char kInvalidSdp[]; |
| 54 | extern const char kMlineMismatch[]; |
sergeyu@chromium.org | 4b26e2e | 2014-01-15 23:15:54 +0000 | [diff] [blame] | 55 | extern const char kPushDownTDFailed[]; |
henrike@webrtc.org | b90991d | 2014-03-04 19:54:57 +0000 | [diff] [blame] | 56 | extern const char kSdpWithoutDtlsFingerprint[]; |
| 57 | extern const char kSdpWithoutSdesCrypto[]; |
mallinath@webrtc.org | 19f27e6 | 2013-10-13 17:18:27 +0000 | [diff] [blame] | 58 | extern const char kSdpWithoutIceUfragPwd[]; |
sergeyu@chromium.org | 4b26e2e | 2014-01-15 23:15:54 +0000 | [diff] [blame] | 59 | extern const char kSdpWithoutSdesAndDtlsDisabled[]; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 60 | extern const char kSessionError[]; |
sergeyu@chromium.org | 4b26e2e | 2014-01-15 23:15:54 +0000 | [diff] [blame] | 61 | extern const char kSessionErrorDesc[]; |
pthatcher@webrtc.org | 4eeef58 | 2015-03-16 19:34:23 +0000 | [diff] [blame] | 62 | extern const char kDtlsSetupFailureRtp[]; |
| 63 | extern const char kDtlsSetupFailureRtcp[]; |
deadbeef | cbecd35 | 2015-09-23 11:50:27 -0700 | [diff] [blame] | 64 | extern const char kEnableBundleFailed[]; |
| 65 | |
buildbot@webrtc.org | 53df88c | 2014-08-07 22:46:01 +0000 | [diff] [blame] | 66 | // Maximum number of received video streams that will be processed by webrtc |
| 67 | // even if they are not signalled beforehand. |
| 68 | extern const int kMaxUnsignalledRecvStreams; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 69 | |
| 70 | // ICE state callback interface. |
| 71 | class IceObserver { |
| 72 | public: |
wu@webrtc.org | 364f204 | 2013-11-20 21:49:41 +0000 | [diff] [blame] | 73 | IceObserver() {} |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 74 | // Called any time the IceConnectionState changes |
Peter Thatcher | 5436051 | 2015-07-08 11:08:35 -0700 | [diff] [blame] | 75 | // TODO(honghaiz): Change the name to OnIceConnectionStateChange so as to |
| 76 | // conform to the w3c standard. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 77 | virtual void OnIceConnectionChange( |
| 78 | PeerConnectionInterface::IceConnectionState new_state) {} |
| 79 | // Called any time the IceGatheringState changes |
| 80 | virtual void OnIceGatheringChange( |
| 81 | PeerConnectionInterface::IceGatheringState new_state) {} |
| 82 | // New Ice candidate have been found. |
| 83 | virtual void OnIceCandidate(const IceCandidateInterface* candidate) = 0; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 84 | |
Honghai Zhang | 7fb69db | 2016-03-14 11:59:18 -0700 | [diff] [blame] | 85 | // Some local ICE candidates have been removed. |
| 86 | virtual void OnIceCandidatesRemoved( |
| 87 | const std::vector<cricket::Candidate>& candidates) = 0; |
| 88 | |
Peter Thatcher | 5436051 | 2015-07-08 11:08:35 -0700 | [diff] [blame] | 89 | // Called whenever the state changes between receiving and not receiving. |
| 90 | virtual void OnIceConnectionReceivingChange(bool receiving) {} |
| 91 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 92 | protected: |
| 93 | ~IceObserver() {} |
wu@webrtc.org | 364f204 | 2013-11-20 21:49:41 +0000 | [diff] [blame] | 94 | |
| 95 | private: |
henrikg | 3c089d7 | 2015-09-16 05:37:44 -0700 | [diff] [blame] | 96 | RTC_DISALLOW_COPY_AND_ASSIGN(IceObserver); |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 97 | }; |
| 98 | |
deadbeef | d59daf8 | 2015-10-14 15:02:44 -0700 | [diff] [blame] | 99 | // Statistics for all the transports of the session. |
| 100 | typedef std::map<std::string, cricket::TransportStats> TransportStatsMap; |
| 101 | typedef std::map<std::string, std::string> ProxyTransportMap; |
| 102 | |
| 103 | // TODO(pthatcher): Think of a better name for this. We already have |
| 104 | // a TransportStats in transport.h. Perhaps TransportsStats? |
| 105 | struct SessionStats { |
| 106 | ProxyTransportMap proxy_to_transport; |
| 107 | TransportStatsMap transport_stats; |
| 108 | }; |
| 109 | |
| 110 | // A WebRtcSession manages general session state. This includes negotiation |
| 111 | // of both the application-level and network-level protocols: the former |
| 112 | // defines what will be sent and the latter defines how it will be sent. Each |
| 113 | // network-level protocol is represented by a Transport object. Each Transport |
| 114 | // participates in the network-level negotiation. The individual streams of |
| 115 | // packets are represented by TransportChannels. The application-level protocol |
| 116 | // is represented by SessionDecription objects. |
| 117 | class WebRtcSession : public AudioProviderInterface, |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 118 | public VideoProviderInterface, |
wu@webrtc.org | 7818752 | 2013-10-07 23:32:02 +0000 | [diff] [blame] | 119 | public DtmfProviderInterface, |
deadbeef | d59daf8 | 2015-10-14 15:02:44 -0700 | [diff] [blame] | 120 | public DataChannelProviderInterface, |
| 121 | public sigslot::has_slots<> { |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 122 | public: |
deadbeef | d59daf8 | 2015-10-14 15:02:44 -0700 | [diff] [blame] | 123 | enum State { |
| 124 | STATE_INIT = 0, |
| 125 | STATE_SENTOFFER, // Sent offer, waiting for answer. |
| 126 | STATE_RECEIVEDOFFER, // Received an offer. Need to send answer. |
| 127 | STATE_SENTPRANSWER, // Sent provisional answer. Need to send answer. |
| 128 | STATE_RECEIVEDPRANSWER, // Received provisional answer, waiting for answer. |
| 129 | STATE_INPROGRESS, // Offer/answer exchange completed. |
| 130 | STATE_CLOSED, // Close() was called. |
| 131 | }; |
| 132 | |
| 133 | enum Error { |
| 134 | ERROR_NONE = 0, // no error |
| 135 | ERROR_CONTENT = 1, // channel errors in SetLocalContent/SetRemoteContent |
| 136 | ERROR_TRANSPORT = 2, // transport error of some kind |
| 137 | }; |
| 138 | |
stefan | c1aeaf0 | 2015-10-15 07:26:07 -0700 | [diff] [blame] | 139 | WebRtcSession(webrtc::MediaControllerInterface* media_controller, |
buildbot@webrtc.org | d4e598d | 2014-07-29 17:36:52 +0000 | [diff] [blame] | 140 | rtc::Thread* signaling_thread, |
| 141 | rtc::Thread* worker_thread, |
deadbeef | ab9b2d1 | 2015-10-14 11:33:11 -0700 | [diff] [blame] | 142 | cricket::PortAllocator* port_allocator); |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 143 | virtual ~WebRtcSession(); |
| 144 | |
deadbeef | d59daf8 | 2015-10-14 15:02:44 -0700 | [diff] [blame] | 145 | // These are const to allow them to be called from const methods. |
| 146 | rtc::Thread* signaling_thread() const { return signaling_thread_; } |
| 147 | rtc::Thread* worker_thread() const { return worker_thread_; } |
| 148 | cricket::PortAllocator* port_allocator() const { return port_allocator_; } |
| 149 | |
| 150 | // The ID of this session. |
| 151 | const std::string& id() const { return sid_; } |
| 152 | |
Henrik Lundin | 64dad83 | 2015-05-11 12:44:23 +0200 | [diff] [blame] | 153 | bool Initialize( |
| 154 | const PeerConnectionFactoryInterface::Options& options, |
Henrik Boström | 5e56c59 | 2015-08-11 10:33:13 +0200 | [diff] [blame] | 155 | rtc::scoped_ptr<DtlsIdentityStoreInterface> dtls_identity_store, |
Henrik Lundin | 64dad83 | 2015-05-11 12:44:23 +0200 | [diff] [blame] | 156 | const PeerConnectionInterface::RTCConfiguration& rtc_configuration); |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 157 | // Deletes the voice, video and data channel and changes the session state |
deadbeef | d59daf8 | 2015-10-14 15:02:44 -0700 | [diff] [blame] | 158 | // to STATE_CLOSED. |
| 159 | void Close(); |
| 160 | |
| 161 | // Returns true if we were the initial offerer. |
| 162 | bool initial_offerer() const { return initial_offerer_; } |
| 163 | |
| 164 | // Returns the current state of the session. See the enum above for details. |
| 165 | // Each time the state changes, we will fire this signal. |
| 166 | State state() const { return state_; } |
| 167 | sigslot::signal2<WebRtcSession*, State> SignalState; |
| 168 | |
| 169 | // Returns the last error in the session. See the enum above for details. |
| 170 | Error error() const { return error_; } |
| 171 | const std::string& error_desc() const { return error_desc_; } |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 172 | |
| 173 | void RegisterIceObserver(IceObserver* observer) { |
| 174 | ice_observer_ = observer; |
| 175 | } |
| 176 | |
| 177 | virtual cricket::VoiceChannel* voice_channel() { |
| 178 | return voice_channel_.get(); |
| 179 | } |
| 180 | virtual cricket::VideoChannel* video_channel() { |
| 181 | return video_channel_.get(); |
| 182 | } |
| 183 | virtual cricket::DataChannel* data_channel() { |
| 184 | return data_channel_.get(); |
| 185 | } |
| 186 | |
deadbeef | 0ed85b2 | 2016-02-23 17:24:52 -0800 | [diff] [blame] | 187 | cricket::BaseChannel* GetChannel(const std::string& content_name); |
| 188 | |
henrike@webrtc.org | b90991d | 2014-03-04 19:54:57 +0000 | [diff] [blame] | 189 | void SetSdesPolicy(cricket::SecurePolicy secure_policy); |
| 190 | cricket::SecurePolicy SdesPolicy() const; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 191 | |
sergeyu@chromium.org | 0be6aa0 | 2013-08-23 23:21:25 +0000 | [diff] [blame] | 192 | // Get current ssl role from transport. |
Taylor Brandstetter | f475d36 | 2016-01-08 15:35:57 -0800 | [diff] [blame] | 193 | bool GetSslRole(const std::string& transport_name, rtc::SSLRole* role); |
| 194 | |
| 195 | // Get current SSL role for this channel's transport. |
| 196 | // If |transport| is null, returns false. |
| 197 | bool GetSslRole(const cricket::BaseChannel* channel, rtc::SSLRole* role); |
sergeyu@chromium.org | 0be6aa0 | 2013-08-23 23:21:25 +0000 | [diff] [blame] | 198 | |
jiayl@webrtc.org | b18bf5e | 2014-08-04 18:34:16 +0000 | [diff] [blame] | 199 | void CreateOffer( |
| 200 | CreateSessionDescriptionObserver* observer, |
deadbeef | ab9b2d1 | 2015-10-14 11:33:11 -0700 | [diff] [blame] | 201 | const PeerConnectionInterface::RTCOfferAnswerOptions& options, |
| 202 | const cricket::MediaSessionOptions& session_options); |
wu@webrtc.org | 91053e7 | 2013-08-10 07:18:04 +0000 | [diff] [blame] | 203 | void CreateAnswer(CreateSessionDescriptionObserver* observer, |
deadbeef | ab9b2d1 | 2015-10-14 11:33:11 -0700 | [diff] [blame] | 204 | const cricket::MediaSessionOptions& session_options); |
henrike@webrtc.org | 28654cb | 2013-07-22 21:07:49 +0000 | [diff] [blame] | 205 | // The ownership of |desc| will be transferred after this call. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 206 | bool SetLocalDescription(SessionDescriptionInterface* desc, |
| 207 | std::string* err_desc); |
henrike@webrtc.org | 28654cb | 2013-07-22 21:07:49 +0000 | [diff] [blame] | 208 | // The ownership of |desc| will be transferred after this call. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 209 | bool SetRemoteDescription(SessionDescriptionInterface* desc, |
| 210 | std::string* err_desc); |
| 211 | bool ProcessIceMessage(const IceCandidateInterface* ice_candidate); |
buildbot@webrtc.org | 41451d4 | 2014-05-03 05:39:45 +0000 | [diff] [blame] | 212 | |
Honghai Zhang | 7fb69db | 2016-03-14 11:59:18 -0700 | [diff] [blame] | 213 | bool RemoveRemoteIceCandidates( |
| 214 | const std::vector<cricket::Candidate>& candidates); |
| 215 | |
mallinath@webrtc.org | 3d81b1b | 2014-09-09 14:38:10 +0000 | [diff] [blame] | 216 | bool SetIceTransports(PeerConnectionInterface::IceTransportsType type); |
buildbot@webrtc.org | 41451d4 | 2014-05-03 05:39:45 +0000 | [diff] [blame] | 217 | |
honghaiz | 1f429e3 | 2015-09-28 07:57:34 -0700 | [diff] [blame] | 218 | cricket::IceConfig ParseIceConfig( |
| 219 | const PeerConnectionInterface::RTCConfiguration& config) const; |
| 220 | |
deadbeef | d59daf8 | 2015-10-14 15:02:44 -0700 | [diff] [blame] | 221 | void SetIceConfig(const cricket::IceConfig& ice_config); |
| 222 | |
| 223 | // Start gathering candidates for any new transports, or transports doing an |
| 224 | // ICE restart. |
| 225 | void MaybeStartGathering(); |
| 226 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 227 | const SessionDescriptionInterface* local_description() const { |
| 228 | return local_desc_.get(); |
| 229 | } |
| 230 | const SessionDescriptionInterface* remote_description() const { |
| 231 | return remote_desc_.get(); |
| 232 | } |
| 233 | |
| 234 | // Get the id used as a media stream track's "id" field from ssrc. |
Peter Boström | 0c4e06b | 2015-10-07 12:23:21 +0200 | [diff] [blame] | 235 | virtual bool GetLocalTrackIdBySsrc(uint32_t ssrc, std::string* track_id); |
| 236 | virtual bool GetRemoteTrackIdBySsrc(uint32_t ssrc, std::string* track_id); |
xians@webrtc.org | 4cb0128 | 2014-06-12 14:57:05 +0000 | [diff] [blame] | 237 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 238 | // AudioMediaProviderInterface implementation. |
solenberg | d4cec0d | 2015-10-09 08:55:48 -0700 | [diff] [blame] | 239 | void SetAudioPlayout(uint32_t ssrc, bool enable) override; |
Peter Boström | 0c4e06b | 2015-10-07 12:23:21 +0200 | [diff] [blame] | 240 | void SetAudioSend(uint32_t ssrc, |
kjellander@webrtc.org | 14665ff | 2015-03-04 12:58:35 +0000 | [diff] [blame] | 241 | bool enable, |
| 242 | const cricket::AudioOptions& options, |
Taylor Brandstetter | 1a018dc | 2016-03-08 12:37:39 -0800 | [diff] [blame] | 243 | cricket::AudioSource* source) override; |
Peter Boström | 0c4e06b | 2015-10-07 12:23:21 +0200 | [diff] [blame] | 244 | void SetAudioPlayoutVolume(uint32_t ssrc, double volume) override; |
deadbeef | 2d110be | 2016-01-13 12:00:26 -0800 | [diff] [blame] | 245 | void SetRawAudioSink(uint32_t ssrc, |
| 246 | rtc::scoped_ptr<AudioSinkInterface> sink) override; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 247 | |
skvlad | dc1c62c | 2016-03-16 19:07:43 -0700 | [diff] [blame] | 248 | RtpParameters GetAudioRtpParameters(uint32_t ssrc) const override; |
| 249 | bool SetAudioRtpParameters(uint32_t ssrc, |
| 250 | const RtpParameters& parameters) override; |
| 251 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 252 | // Implements VideoMediaProviderInterface. |
Peter Boström | 0c4e06b | 2015-10-07 12:23:21 +0200 | [diff] [blame] | 253 | bool SetCaptureDevice(uint32_t ssrc, cricket::VideoCapturer* camera) override; |
nisse | 08582ff | 2016-02-04 01:24:52 -0800 | [diff] [blame] | 254 | void SetVideoPlayout( |
| 255 | uint32_t ssrc, |
| 256 | bool enable, |
| 257 | rtc::VideoSinkInterface<cricket::VideoFrame>* sink) override; |
Peter Boström | 0c4e06b | 2015-10-07 12:23:21 +0200 | [diff] [blame] | 258 | void SetVideoSend(uint32_t ssrc, |
kjellander@webrtc.org | 14665ff | 2015-03-04 12:58:35 +0000 | [diff] [blame] | 259 | bool enable, |
| 260 | const cricket::VideoOptions* options) override; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 261 | |
skvlad | dc1c62c | 2016-03-16 19:07:43 -0700 | [diff] [blame] | 262 | RtpParameters GetVideoRtpParameters(uint32_t ssrc) const override; |
| 263 | bool SetVideoRtpParameters(uint32_t ssrc, |
| 264 | const RtpParameters& parameters) override; |
| 265 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 266 | // Implements DtmfProviderInterface. |
| 267 | virtual bool CanInsertDtmf(const std::string& track_id); |
| 268 | virtual bool InsertDtmf(const std::string& track_id, |
| 269 | int code, int duration); |
| 270 | virtual sigslot::signal0<>* GetOnDestroyedSignal(); |
| 271 | |
wu@webrtc.org | 7818752 | 2013-10-07 23:32:02 +0000 | [diff] [blame] | 272 | // Implements DataChannelProviderInterface. |
kjellander@webrtc.org | 14665ff | 2015-03-04 12:58:35 +0000 | [diff] [blame] | 273 | bool SendData(const cricket::SendDataParams& params, |
kjellander | 194e3bc | 2016-03-19 12:12:52 -0700 | [diff] [blame] | 274 | const rtc::Buffer& payload, |
kjellander@webrtc.org | 14665ff | 2015-03-04 12:58:35 +0000 | [diff] [blame] | 275 | cricket::SendDataResult* result) override; |
| 276 | bool ConnectDataChannel(DataChannel* webrtc_data_channel) override; |
| 277 | void DisconnectDataChannel(DataChannel* webrtc_data_channel) override; |
| 278 | void AddSctpDataStream(int sid) override; |
| 279 | void RemoveSctpDataStream(int sid) override; |
| 280 | bool ReadyToSendData() const override; |
wu@webrtc.org | 7818752 | 2013-10-07 23:32:02 +0000 | [diff] [blame] | 281 | |
pthatcher@webrtc.org | c04a97f | 2015-03-16 19:31:40 +0000 | [diff] [blame] | 282 | // Returns stats for all channels of all transports. |
| 283 | // This avoids exposing the internal structures used to track them. |
deadbeef | d59daf8 | 2015-10-14 15:02:44 -0700 | [diff] [blame] | 284 | virtual bool GetTransportStats(SessionStats* stats); |
pthatcher@webrtc.org | c04a97f | 2015-03-16 19:31:40 +0000 | [diff] [blame] | 285 | |
deadbeef | cbecd35 | 2015-09-23 11:50:27 -0700 | [diff] [blame] | 286 | // Get stats for a specific channel |
deadbeef | d59daf8 | 2015-10-14 15:02:44 -0700 | [diff] [blame] | 287 | bool GetChannelTransportStats(cricket::BaseChannel* ch, SessionStats* stats); |
deadbeef | cbecd35 | 2015-09-23 11:50:27 -0700 | [diff] [blame] | 288 | |
| 289 | // virtual so it can be mocked in unit tests |
| 290 | virtual bool GetLocalCertificate( |
| 291 | const std::string& transport_name, |
| 292 | rtc::scoped_refptr<rtc::RTCCertificate>* certificate); |
| 293 | |
| 294 | // Caller owns returned certificate |
| 295 | virtual bool GetRemoteSSLCertificate(const std::string& transport_name, |
| 296 | rtc::SSLCertificate** cert); |
| 297 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 298 | cricket::DataChannelType data_channel_type() const; |
| 299 | |
deadbeef | 0ed85b2 | 2016-02-23 17:24:52 -0800 | [diff] [blame] | 300 | bool IceRestartPending(const std::string& content_name) const; |
wu@webrtc.org | 91053e7 | 2013-08-10 07:18:04 +0000 | [diff] [blame] | 301 | |
Henrik Boström | d828198 | 2015-08-27 10:12:24 +0200 | [diff] [blame] | 302 | // Called when an RTCCertificate is generated or retrieved by |
wu@webrtc.org | 91053e7 | 2013-08-10 07:18:04 +0000 | [diff] [blame] | 303 | // WebRTCSessionDescriptionFactory. Should happen before setLocalDescription. |
Henrik Boström | d828198 | 2015-08-27 10:12:24 +0200 | [diff] [blame] | 304 | void OnCertificateReady( |
| 305 | const rtc::scoped_refptr<rtc::RTCCertificate>& certificate); |
pthatcher@webrtc.org | 4eeef58 | 2015-03-16 19:34:23 +0000 | [diff] [blame] | 306 | void OnDtlsSetupFailure(cricket::BaseChannel*, bool rtcp); |
wu@webrtc.org | 91053e7 | 2013-08-10 07:18:04 +0000 | [diff] [blame] | 307 | |
| 308 | // For unit test. |
Henrik Boström | d828198 | 2015-08-27 10:12:24 +0200 | [diff] [blame] | 309 | bool waiting_for_certificate_for_testing() const; |
deadbeef | cbecd35 | 2015-09-23 11:50:27 -0700 | [diff] [blame] | 310 | const rtc::scoped_refptr<rtc::RTCCertificate>& certificate_for_testing(); |
wu@webrtc.org | 91053e7 | 2013-08-10 07:18:04 +0000 | [diff] [blame] | 311 | |
guoweis@webrtc.org | 7169afd | 2014-12-04 17:59:29 +0000 | [diff] [blame] | 312 | void set_metrics_observer( |
| 313 | webrtc::MetricsObserverInterface* metrics_observer) { |
| 314 | metrics_observer_ = metrics_observer; |
| 315 | } |
| 316 | |
deadbeef | ab9b2d1 | 2015-10-14 11:33:11 -0700 | [diff] [blame] | 317 | // Called when voice_channel_, video_channel_ and data_channel_ are created |
| 318 | // and destroyed. As a result of, for example, setting a new description. |
| 319 | sigslot::signal0<> SignalVoiceChannelCreated; |
| 320 | sigslot::signal0<> SignalVoiceChannelDestroyed; |
| 321 | sigslot::signal0<> SignalVideoChannelCreated; |
| 322 | sigslot::signal0<> SignalVideoChannelDestroyed; |
| 323 | sigslot::signal0<> SignalDataChannelCreated; |
| 324 | sigslot::signal0<> SignalDataChannelDestroyed; |
deadbeef | 057ecf0 | 2016-01-20 14:30:43 -0800 | [diff] [blame] | 325 | // Called when the whole session is destroyed. |
| 326 | sigslot::signal0<> SignalDestroyed; |
deadbeef | ab9b2d1 | 2015-10-14 11:33:11 -0700 | [diff] [blame] | 327 | |
| 328 | // Called when a valid data channel OPEN message is received. |
| 329 | // std::string represents the data channel label. |
| 330 | sigslot::signal2<const std::string&, const InternalDataChannelInit&> |
| 331 | SignalDataChannelOpenMessage; |
| 332 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 333 | private: |
| 334 | // Indicates the type of SessionDescription in a call to SetLocalDescription |
| 335 | // and SetRemoteDescription. |
| 336 | enum Action { |
| 337 | kOffer, |
| 338 | kPrAnswer, |
| 339 | kAnswer, |
| 340 | }; |
wu@webrtc.org | 91053e7 | 2013-08-10 07:18:04 +0000 | [diff] [blame] | 341 | |
deadbeef | d59daf8 | 2015-10-14 15:02:44 -0700 | [diff] [blame] | 342 | // Log session state. |
| 343 | void LogState(State old_state, State new_state); |
| 344 | |
| 345 | // Updates the state, signaling if necessary. |
| 346 | virtual void SetState(State state); |
| 347 | |
| 348 | // Updates the error state, signaling if necessary. |
| 349 | // TODO(ronghuawu): remove the SetError method that doesn't take |error_desc|. |
| 350 | virtual void SetError(Error error, const std::string& error_desc); |
| 351 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 352 | bool UpdateSessionState(Action action, cricket::ContentSource source, |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 353 | std::string* err_desc); |
| 354 | static Action GetAction(const std::string& type); |
pthatcher@webrtc.org | 592470b | 2015-03-16 21:15:37 +0000 | [diff] [blame] | 355 | // Push the media parts of the local or remote session description |
| 356 | // down to all of the channels. |
| 357 | bool PushdownMediaDescription(cricket::ContentAction action, |
| 358 | cricket::ContentSource source, |
| 359 | std::string* error_desc); |
| 360 | |
deadbeef | d59daf8 | 2015-10-14 15:02:44 -0700 | [diff] [blame] | 361 | bool PushdownTransportDescription(cricket::ContentSource source, |
| 362 | cricket::ContentAction action, |
| 363 | std::string* error_desc); |
| 364 | |
| 365 | // Helper methods to push local and remote transport descriptions. |
| 366 | bool PushdownLocalTransportDescription( |
| 367 | const cricket::SessionDescription* sdesc, |
| 368 | cricket::ContentAction action, |
| 369 | std::string* error_desc); |
| 370 | bool PushdownRemoteTransportDescription( |
| 371 | const cricket::SessionDescription* sdesc, |
| 372 | cricket::ContentAction action, |
| 373 | std::string* error_desc); |
| 374 | |
| 375 | // Returns true and the TransportInfo of the given |content_name| |
| 376 | // from |description|. Returns false if it's not available. |
| 377 | static bool GetTransportDescription( |
| 378 | const cricket::SessionDescription* description, |
| 379 | const std::string& content_name, |
| 380 | cricket::TransportDescription* info); |
| 381 | |
deadbeef | cbecd35 | 2015-09-23 11:50:27 -0700 | [diff] [blame] | 382 | // Cause all the BaseChannels in the bundle group to have the same |
| 383 | // transport channel. |
| 384 | bool EnableBundle(const cricket::ContentGroup& bundle); |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 385 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 386 | // Enables media channels to allow sending of media. |
| 387 | void EnableChannels(); |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 388 | // Returns the media index for a local ice candidate given the content name. |
| 389 | // Returns false if the local session description does not have a media |
| 390 | // content called |content_name|. |
| 391 | bool GetLocalCandidateMediaIndex(const std::string& content_name, |
| 392 | int* sdp_mline_index); |
| 393 | // Uses all remote candidates in |remote_desc| in this session. |
| 394 | bool UseCandidatesInSessionDescription( |
| 395 | const SessionDescriptionInterface* remote_desc); |
| 396 | // Uses |candidate| in this session. |
| 397 | bool UseCandidate(const IceCandidateInterface* candidate); |
| 398 | // Deletes the corresponding channel of contents that don't exist in |desc|. |
| 399 | // |desc| can be null. This means that all channels are deleted. |
deadbeef | cbecd35 | 2015-09-23 11:50:27 -0700 | [diff] [blame] | 400 | void RemoveUnusedChannels(const cricket::SessionDescription* desc); |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 401 | |
| 402 | // Allocates media channels based on the |desc|. If |desc| doesn't have |
| 403 | // the BUNDLE option, this method will disable BUNDLE in PortAllocator. |
| 404 | // This method will also delete any existing media channels before creating. |
| 405 | bool CreateChannels(const cricket::SessionDescription* desc); |
| 406 | |
| 407 | // Helper methods to create media channels. |
henrike@webrtc.org | 1e09a71 | 2013-07-26 19:17:59 +0000 | [diff] [blame] | 408 | bool CreateVoiceChannel(const cricket::ContentInfo* content); |
| 409 | bool CreateVideoChannel(const cricket::ContentInfo* content); |
| 410 | bool CreateDataChannel(const cricket::ContentInfo* content); |
| 411 | |
henrika@webrtc.org | aebb1ad | 2014-01-14 10:00:58 +0000 | [diff] [blame] | 412 | // Listens to SCTP CONTROL messages on unused SIDs and process them as OPEN |
| 413 | // messages. |
| 414 | void OnDataChannelMessageReceived(cricket::DataChannel* channel, |
| 415 | const cricket::ReceiveDataParams& params, |
kjellander | 194e3bc | 2016-03-19 12:12:52 -0700 | [diff] [blame] | 416 | const rtc::Buffer& payload); |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 417 | |
sergeyu@chromium.org | 4b26e2e | 2014-01-15 23:15:54 +0000 | [diff] [blame] | 418 | std::string BadStateErrMsg(State state); |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 419 | void SetIceConnectionState(PeerConnectionInterface::IceConnectionState state); |
Peter Thatcher | 5436051 | 2015-07-08 11:08:35 -0700 | [diff] [blame] | 420 | void SetIceConnectionReceiving(bool receiving); |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 421 | |
sergeyu@chromium.org | 0be6aa0 | 2013-08-23 23:21:25 +0000 | [diff] [blame] | 422 | bool ValidateBundleSettings(const cricket::SessionDescription* desc); |
henrike@webrtc.org | 1e09a71 | 2013-07-26 19:17:59 +0000 | [diff] [blame] | 423 | bool HasRtcpMuxEnabled(const cricket::ContentInfo* content); |
sergeyu@chromium.org | 0be6aa0 | 2013-08-23 23:21:25 +0000 | [diff] [blame] | 424 | // Below methods are helper methods which verifies SDP. |
| 425 | bool ValidateSessionDescription(const SessionDescriptionInterface* sdesc, |
| 426 | cricket::ContentSource source, |
sergeyu@chromium.org | 4b26e2e | 2014-01-15 23:15:54 +0000 | [diff] [blame] | 427 | std::string* err_desc); |
sergeyu@chromium.org | 0be6aa0 | 2013-08-23 23:21:25 +0000 | [diff] [blame] | 428 | |
| 429 | // Check if a call to SetLocalDescription is acceptable with |action|. |
| 430 | bool ExpectSetLocalDescription(Action action); |
| 431 | // Check if a call to SetRemoteDescription is acceptable with |action|. |
| 432 | bool ExpectSetRemoteDescription(Action action); |
| 433 | // Verifies a=setup attribute as per RFC 5763. |
| 434 | bool ValidateDtlsSetupAttribute(const cricket::SessionDescription* desc, |
| 435 | Action action); |
henrike@webrtc.org | 1e09a71 | 2013-07-26 19:17:59 +0000 | [diff] [blame] | 436 | |
jiayl@webrtc.org | e10d28c | 2014-07-17 17:07:49 +0000 | [diff] [blame] | 437 | // Returns true if we are ready to push down the remote candidate. |
| 438 | // |remote_desc| is the new remote description, or NULL if the current remote |
| 439 | // description should be used. Output |valid| is true if the candidate media |
| 440 | // index is valid. |
| 441 | bool ReadyToUseRemoteCandidate(const IceCandidateInterface* candidate, |
| 442 | const SessionDescriptionInterface* remote_desc, |
| 443 | bool* valid); |
| 444 | |
deadbeef | cbecd35 | 2015-09-23 11:50:27 -0700 | [diff] [blame] | 445 | void OnTransportControllerConnectionState(cricket::IceConnectionState state); |
| 446 | void OnTransportControllerReceiving(bool receiving); |
| 447 | void OnTransportControllerGatheringState(cricket::IceGatheringState state); |
| 448 | void OnTransportControllerCandidatesGathered( |
| 449 | const std::string& transport_name, |
Honghai Zhang | 7fb69db | 2016-03-14 11:59:18 -0700 | [diff] [blame] | 450 | const std::vector<cricket::Candidate>& candidates); |
| 451 | void OnTransportControllerCandidatesRemoved( |
| 452 | const std::vector<cricket::Candidate>& candidates); |
deadbeef | cbecd35 | 2015-09-23 11:50:27 -0700 | [diff] [blame] | 453 | |
sergeyu@chromium.org | 4b26e2e | 2014-01-15 23:15:54 +0000 | [diff] [blame] | 454 | std::string GetSessionErrorMsg(); |
| 455 | |
deadbeef | cbecd35 | 2015-09-23 11:50:27 -0700 | [diff] [blame] | 456 | // Invoked when TransportController connection completion is signaled. |
| 457 | // Reports stats for all transports in use. |
| 458 | void ReportTransportStats(); |
| 459 | |
| 460 | // Gather the usage of IPv4/IPv6 as best connection. |
jbauch | ac8869e | 2015-07-03 01:36:14 -0700 | [diff] [blame] | 461 | void ReportBestConnectionState(const cricket::TransportStats& stats); |
| 462 | |
| 463 | void ReportNegotiatedCiphers(const cricket::TransportStats& stats); |
guoweis@webrtc.org | 7169afd | 2014-12-04 17:59:29 +0000 | [diff] [blame] | 464 | |
stefan | c1aeaf0 | 2015-10-15 07:26:07 -0700 | [diff] [blame] | 465 | void OnSentPacket_w(cricket::TransportChannel* channel, |
| 466 | const rtc::SentPacket& sent_packet); |
| 467 | |
deadbeef | d59daf8 | 2015-10-14 15:02:44 -0700 | [diff] [blame] | 468 | rtc::Thread* const signaling_thread_; |
| 469 | rtc::Thread* const worker_thread_; |
| 470 | cricket::PortAllocator* const port_allocator_; |
| 471 | |
| 472 | State state_ = STATE_INIT; |
| 473 | Error error_ = ERROR_NONE; |
| 474 | std::string error_desc_; |
| 475 | |
| 476 | const std::string sid_; |
| 477 | bool initial_offerer_ = false; |
| 478 | |
| 479 | rtc::scoped_ptr<cricket::TransportController> transport_controller_; |
stefan | c1aeaf0 | 2015-10-15 07:26:07 -0700 | [diff] [blame] | 480 | MediaControllerInterface* media_controller_; |
buildbot@webrtc.org | d4e598d | 2014-07-29 17:36:52 +0000 | [diff] [blame] | 481 | rtc::scoped_ptr<cricket::VoiceChannel> voice_channel_; |
| 482 | rtc::scoped_ptr<cricket::VideoChannel> video_channel_; |
| 483 | rtc::scoped_ptr<cricket::DataChannel> data_channel_; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 484 | cricket::ChannelManager* channel_manager_; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 485 | IceObserver* ice_observer_; |
| 486 | PeerConnectionInterface::IceConnectionState ice_connection_state_; |
Peter Thatcher | 5436051 | 2015-07-08 11:08:35 -0700 | [diff] [blame] | 487 | bool ice_connection_receiving_; |
buildbot@webrtc.org | d4e598d | 2014-07-29 17:36:52 +0000 | [diff] [blame] | 488 | rtc::scoped_ptr<SessionDescriptionInterface> local_desc_; |
| 489 | rtc::scoped_ptr<SessionDescriptionInterface> remote_desc_; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 490 | // If the remote peer is using a older version of implementation. |
| 491 | bool older_version_remote_peer_; |
mallinath@webrtc.org | a27be8e | 2013-09-27 23:04:10 +0000 | [diff] [blame] | 492 | bool dtls_enabled_; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 493 | // Specifies which kind of data channel is allowed. This is controlled |
| 494 | // by the chrome command-line flag and constraints: |
| 495 | // 1. If chrome command-line switch 'enable-sctp-data-channels' is enabled, |
| 496 | // constraint kEnableDtlsSrtp is true, and constaint kEnableRtpDataChannels is |
| 497 | // not set or false, SCTP is allowed (DCT_SCTP); |
| 498 | // 2. If constraint kEnableRtpDataChannels is true, RTP is allowed (DCT_RTP); |
| 499 | // 3. If both 1&2 are false, data channel is not allowed (DCT_NONE). |
| 500 | cricket::DataChannelType data_channel_type_; |
deadbeef | 0ed85b2 | 2016-02-23 17:24:52 -0800 | [diff] [blame] | 501 | // List of content names for which the remote side triggered an ICE restart. |
| 502 | std::set<std::string> pending_ice_restarts_; |
wu@webrtc.org | 91053e7 | 2013-08-10 07:18:04 +0000 | [diff] [blame] | 503 | |
buildbot@webrtc.org | d4e598d | 2014-07-29 17:36:52 +0000 | [diff] [blame] | 504 | rtc::scoped_ptr<WebRtcSessionDescriptionFactory> |
wu@webrtc.org | 91053e7 | 2013-08-10 07:18:04 +0000 | [diff] [blame] | 505 | webrtc_session_desc_factory_; |
| 506 | |
henrike@webrtc.org | 6e3dbc2 | 2014-03-25 17:09:47 +0000 | [diff] [blame] | 507 | // Member variables for caching global options. |
| 508 | cricket::AudioOptions audio_options_; |
| 509 | cricket::VideoOptions video_options_; |
guoweis@webrtc.org | 7169afd | 2014-12-04 17:59:29 +0000 | [diff] [blame] | 510 | MetricsObserverInterface* metrics_observer_; |
henrike@webrtc.org | 6e3dbc2 | 2014-03-25 17:09:47 +0000 | [diff] [blame] | 511 | |
pthatcher@webrtc.org | 877ac76 | 2015-02-04 22:03:09 +0000 | [diff] [blame] | 512 | // Declares the bundle policy for the WebRTCSession. |
| 513 | PeerConnectionInterface::BundlePolicy bundle_policy_; |
| 514 | |
Peter Thatcher | af55ccc | 2015-05-21 07:48:41 -0700 | [diff] [blame] | 515 | // Declares the RTCP mux policy for the WebRTCSession. |
| 516 | PeerConnectionInterface::RtcpMuxPolicy rtcp_mux_policy_; |
| 517 | |
henrikg | 3c089d7 | 2015-09-16 05:37:44 -0700 | [diff] [blame] | 518 | RTC_DISALLOW_COPY_AND_ASSIGN(WebRtcSession); |
wu@webrtc.org | 364f204 | 2013-11-20 21:49:41 +0000 | [diff] [blame] | 519 | }; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 520 | } // namespace webrtc |
| 521 | |
Henrik Kjellander | 15583c1 | 2016-02-10 10:53:12 +0100 | [diff] [blame] | 522 | #endif // WEBRTC_API_WEBRTCSESSION_H_ |