Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(189)

Side by Side Diff: talk/app/webrtc/webrtcsession.h

Issue 1610243002: Move talk/app/webrtc to webrtc/api (Closed) Base URL: https://chromium.googlesource.com/external/webrtc.git@master
Patch Set: Removed processing of api.gyp for Chromium builds Created 4 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « talk/app/webrtc/webrtcsdp_unittest.cc ('k') | talk/app/webrtc/webrtcsession.cc » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 /*
2 * libjingle
3 * Copyright 2012 Google Inc.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright notice,
11 * this list of conditions and the following disclaimer in the documentation
12 * and/or other materials provided with the distribution.
13 * 3. The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
19 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28 #ifndef TALK_APP_WEBRTC_WEBRTCSESSION_H_
29 #define TALK_APP_WEBRTC_WEBRTCSESSION_H_
30
31 #include <string>
32 #include <vector>
33
34 #include "talk/app/webrtc/datachannel.h"
35 #include "talk/app/webrtc/dtmfsender.h"
36 #include "talk/app/webrtc/mediacontroller.h"
37 #include "talk/app/webrtc/mediastreamprovider.h"
38 #include "talk/app/webrtc/peerconnectioninterface.h"
39 #include "talk/app/webrtc/statstypes.h"
40 #include "talk/session/media/mediasession.h"
41 #include "webrtc/base/sigslot.h"
42 #include "webrtc/base/sslidentity.h"
43 #include "webrtc/base/thread.h"
44 #include "webrtc/media/base/mediachannel.h"
45 #include "webrtc/p2p/base/transportcontroller.h"
46
47 namespace cricket {
48
49 class ChannelManager;
50 class DataChannel;
51 class StatsReport;
52 class VideoCapturer;
53 class VideoChannel;
54 class VoiceChannel;
55
56 } // namespace cricket
57
58 namespace webrtc {
59
60 class IceRestartAnswerLatch;
61 class JsepIceCandidate;
62 class MediaStreamSignaling;
63 class WebRtcSessionDescriptionFactory;
64
65 extern const char kBundleWithoutRtcpMux[];
66 extern const char kCreateChannelFailed[];
67 extern const char kInvalidCandidates[];
68 extern const char kInvalidSdp[];
69 extern const char kMlineMismatch[];
70 extern const char kPushDownTDFailed[];
71 extern const char kSdpWithoutDtlsFingerprint[];
72 extern const char kSdpWithoutSdesCrypto[];
73 extern const char kSdpWithoutIceUfragPwd[];
74 extern const char kSdpWithoutSdesAndDtlsDisabled[];
75 extern const char kSessionError[];
76 extern const char kSessionErrorDesc[];
77 extern const char kDtlsSetupFailureRtp[];
78 extern const char kDtlsSetupFailureRtcp[];
79 extern const char kEnableBundleFailed[];
80
81 // Maximum number of received video streams that will be processed by webrtc
82 // even if they are not signalled beforehand.
83 extern const int kMaxUnsignalledRecvStreams;
84
85 // ICE state callback interface.
86 class IceObserver {
87 public:
88 IceObserver() {}
89 // Called any time the IceConnectionState changes
90 // TODO(honghaiz): Change the name to OnIceConnectionStateChange so as to
91 // conform to the w3c standard.
92 virtual void OnIceConnectionChange(
93 PeerConnectionInterface::IceConnectionState new_state) {}
94 // Called any time the IceGatheringState changes
95 virtual void OnIceGatheringChange(
96 PeerConnectionInterface::IceGatheringState new_state) {}
97 // New Ice candidate have been found.
98 virtual void OnIceCandidate(const IceCandidateInterface* candidate) = 0;
99
100 // Called whenever the state changes between receiving and not receiving.
101 virtual void OnIceConnectionReceivingChange(bool receiving) {}
102
103 protected:
104 ~IceObserver() {}
105
106 private:
107 RTC_DISALLOW_COPY_AND_ASSIGN(IceObserver);
108 };
109
110 // Statistics for all the transports of the session.
111 typedef std::map<std::string, cricket::TransportStats> TransportStatsMap;
112 typedef std::map<std::string, std::string> ProxyTransportMap;
113
114 // TODO(pthatcher): Think of a better name for this. We already have
115 // a TransportStats in transport.h. Perhaps TransportsStats?
116 struct SessionStats {
117 ProxyTransportMap proxy_to_transport;
118 TransportStatsMap transport_stats;
119 };
120
121 // A WebRtcSession manages general session state. This includes negotiation
122 // of both the application-level and network-level protocols: the former
123 // defines what will be sent and the latter defines how it will be sent. Each
124 // network-level protocol is represented by a Transport object. Each Transport
125 // participates in the network-level negotiation. The individual streams of
126 // packets are represented by TransportChannels. The application-level protocol
127 // is represented by SessionDecription objects.
128 class WebRtcSession : public AudioProviderInterface,
129 public VideoProviderInterface,
130 public DtmfProviderInterface,
131 public DataChannelProviderInterface,
132 public sigslot::has_slots<> {
133 public:
134 enum State {
135 STATE_INIT = 0,
136 STATE_SENTOFFER, // Sent offer, waiting for answer.
137 STATE_RECEIVEDOFFER, // Received an offer. Need to send answer.
138 STATE_SENTPRANSWER, // Sent provisional answer. Need to send answer.
139 STATE_RECEIVEDPRANSWER, // Received provisional answer, waiting for answer.
140 STATE_INPROGRESS, // Offer/answer exchange completed.
141 STATE_CLOSED, // Close() was called.
142 };
143
144 enum Error {
145 ERROR_NONE = 0, // no error
146 ERROR_CONTENT = 1, // channel errors in SetLocalContent/SetRemoteContent
147 ERROR_TRANSPORT = 2, // transport error of some kind
148 };
149
150 WebRtcSession(webrtc::MediaControllerInterface* media_controller,
151 rtc::Thread* signaling_thread,
152 rtc::Thread* worker_thread,
153 cricket::PortAllocator* port_allocator);
154 virtual ~WebRtcSession();
155
156 // These are const to allow them to be called from const methods.
157 rtc::Thread* signaling_thread() const { return signaling_thread_; }
158 rtc::Thread* worker_thread() const { return worker_thread_; }
159 cricket::PortAllocator* port_allocator() const { return port_allocator_; }
160
161 // The ID of this session.
162 const std::string& id() const { return sid_; }
163
164 bool Initialize(
165 const PeerConnectionFactoryInterface::Options& options,
166 const MediaConstraintsInterface* constraints,
167 rtc::scoped_ptr<DtlsIdentityStoreInterface> dtls_identity_store,
168 const PeerConnectionInterface::RTCConfiguration& rtc_configuration);
169 // Deletes the voice, video and data channel and changes the session state
170 // to STATE_CLOSED.
171 void Close();
172
173 // Returns true if we were the initial offerer.
174 bool initial_offerer() const { return initial_offerer_; }
175
176 // Returns the current state of the session. See the enum above for details.
177 // Each time the state changes, we will fire this signal.
178 State state() const { return state_; }
179 sigslot::signal2<WebRtcSession*, State> SignalState;
180
181 // Returns the last error in the session. See the enum above for details.
182 Error error() const { return error_; }
183 const std::string& error_desc() const { return error_desc_; }
184
185 void RegisterIceObserver(IceObserver* observer) {
186 ice_observer_ = observer;
187 }
188
189 virtual cricket::VoiceChannel* voice_channel() {
190 return voice_channel_.get();
191 }
192 virtual cricket::VideoChannel* video_channel() {
193 return video_channel_.get();
194 }
195 virtual cricket::DataChannel* data_channel() {
196 return data_channel_.get();
197 }
198
199 void SetSdesPolicy(cricket::SecurePolicy secure_policy);
200 cricket::SecurePolicy SdesPolicy() const;
201
202 // Get current ssl role from transport.
203 bool GetSslRole(const std::string& transport_name, rtc::SSLRole* role);
204
205 // Get current SSL role for this channel's transport.
206 // If |transport| is null, returns false.
207 bool GetSslRole(const cricket::BaseChannel* channel, rtc::SSLRole* role);
208
209 void CreateOffer(
210 CreateSessionDescriptionObserver* observer,
211 const PeerConnectionInterface::RTCOfferAnswerOptions& options,
212 const cricket::MediaSessionOptions& session_options);
213 void CreateAnswer(CreateSessionDescriptionObserver* observer,
214 const MediaConstraintsInterface* constraints,
215 const cricket::MediaSessionOptions& session_options);
216 // The ownership of |desc| will be transferred after this call.
217 bool SetLocalDescription(SessionDescriptionInterface* desc,
218 std::string* err_desc);
219 // The ownership of |desc| will be transferred after this call.
220 bool SetRemoteDescription(SessionDescriptionInterface* desc,
221 std::string* err_desc);
222 bool ProcessIceMessage(const IceCandidateInterface* ice_candidate);
223
224 bool SetIceTransports(PeerConnectionInterface::IceTransportsType type);
225
226 cricket::IceConfig ParseIceConfig(
227 const PeerConnectionInterface::RTCConfiguration& config) const;
228
229 void SetIceConfig(const cricket::IceConfig& ice_config);
230
231 // Start gathering candidates for any new transports, or transports doing an
232 // ICE restart.
233 void MaybeStartGathering();
234
235 const SessionDescriptionInterface* local_description() const {
236 return local_desc_.get();
237 }
238 const SessionDescriptionInterface* remote_description() const {
239 return remote_desc_.get();
240 }
241
242 // Get the id used as a media stream track's "id" field from ssrc.
243 virtual bool GetLocalTrackIdBySsrc(uint32_t ssrc, std::string* track_id);
244 virtual bool GetRemoteTrackIdBySsrc(uint32_t ssrc, std::string* track_id);
245
246 // AudioMediaProviderInterface implementation.
247 void SetAudioPlayout(uint32_t ssrc, bool enable) override;
248 void SetAudioSend(uint32_t ssrc,
249 bool enable,
250 const cricket::AudioOptions& options,
251 cricket::AudioRenderer* renderer) override;
252 void SetAudioPlayoutVolume(uint32_t ssrc, double volume) override;
253 void SetRawAudioSink(uint32_t ssrc,
254 rtc::scoped_ptr<AudioSinkInterface> sink) override;
255
256 // Implements VideoMediaProviderInterface.
257 bool SetCaptureDevice(uint32_t ssrc, cricket::VideoCapturer* camera) override;
258 void SetVideoPlayout(
259 uint32_t ssrc,
260 bool enable,
261 rtc::VideoSinkInterface<cricket::VideoFrame>* sink) override;
262 void SetVideoSend(uint32_t ssrc,
263 bool enable,
264 const cricket::VideoOptions* options) override;
265
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
272 // Implements DataChannelProviderInterface.
273 bool SendData(const cricket::SendDataParams& params,
274 const rtc::Buffer& payload,
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;
281
282 // Returns stats for all channels of all transports.
283 // This avoids exposing the internal structures used to track them.
284 virtual bool GetTransportStats(SessionStats* stats);
285
286 // Get stats for a specific channel
287 bool GetChannelTransportStats(cricket::BaseChannel* ch, SessionStats* stats);
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
298 cricket::DataChannelType data_channel_type() const;
299
300 bool IceRestartPending() const;
301
302 void ResetIceRestartLatch();
303
304 // Called when an RTCCertificate is generated or retrieved by
305 // WebRTCSessionDescriptionFactory. Should happen before setLocalDescription.
306 void OnCertificateReady(
307 const rtc::scoped_refptr<rtc::RTCCertificate>& certificate);
308 void OnDtlsSetupFailure(cricket::BaseChannel*, bool rtcp);
309
310 // For unit test.
311 bool waiting_for_certificate_for_testing() const;
312 const rtc::scoped_refptr<rtc::RTCCertificate>& certificate_for_testing();
313
314 void set_metrics_observer(
315 webrtc::MetricsObserverInterface* metrics_observer) {
316 metrics_observer_ = metrics_observer;
317 }
318
319 // Called when voice_channel_, video_channel_ and data_channel_ are created
320 // and destroyed. As a result of, for example, setting a new description.
321 sigslot::signal0<> SignalVoiceChannelCreated;
322 sigslot::signal0<> SignalVoiceChannelDestroyed;
323 sigslot::signal0<> SignalVideoChannelCreated;
324 sigslot::signal0<> SignalVideoChannelDestroyed;
325 sigslot::signal0<> SignalDataChannelCreated;
326 sigslot::signal0<> SignalDataChannelDestroyed;
327 // Called when the whole session is destroyed.
328 sigslot::signal0<> SignalDestroyed;
329
330 // Called when a valid data channel OPEN message is received.
331 // std::string represents the data channel label.
332 sigslot::signal2<const std::string&, const InternalDataChannelInit&>
333 SignalDataChannelOpenMessage;
334
335 private:
336 // Indicates the type of SessionDescription in a call to SetLocalDescription
337 // and SetRemoteDescription.
338 enum Action {
339 kOffer,
340 kPrAnswer,
341 kAnswer,
342 };
343
344 // Log session state.
345 void LogState(State old_state, State new_state);
346
347 // Updates the state, signaling if necessary.
348 virtual void SetState(State state);
349
350 // Updates the error state, signaling if necessary.
351 // TODO(ronghuawu): remove the SetError method that doesn't take |error_desc|.
352 virtual void SetError(Error error, const std::string& error_desc);
353
354 bool UpdateSessionState(Action action, cricket::ContentSource source,
355 std::string* err_desc);
356 static Action GetAction(const std::string& type);
357 // Push the media parts of the local or remote session description
358 // down to all of the channels.
359 bool PushdownMediaDescription(cricket::ContentAction action,
360 cricket::ContentSource source,
361 std::string* error_desc);
362
363 bool PushdownTransportDescription(cricket::ContentSource source,
364 cricket::ContentAction action,
365 std::string* error_desc);
366
367 // Helper methods to push local and remote transport descriptions.
368 bool PushdownLocalTransportDescription(
369 const cricket::SessionDescription* sdesc,
370 cricket::ContentAction action,
371 std::string* error_desc);
372 bool PushdownRemoteTransportDescription(
373 const cricket::SessionDescription* sdesc,
374 cricket::ContentAction action,
375 std::string* error_desc);
376
377 // Returns true and the TransportInfo of the given |content_name|
378 // from |description|. Returns false if it's not available.
379 static bool GetTransportDescription(
380 const cricket::SessionDescription* description,
381 const std::string& content_name,
382 cricket::TransportDescription* info);
383
384 cricket::BaseChannel* GetChannel(const std::string& content_name);
385 // Cause all the BaseChannels in the bundle group to have the same
386 // transport channel.
387 bool EnableBundle(const cricket::ContentGroup& bundle);
388
389 // Enables media channels to allow sending of media.
390 void EnableChannels();
391 // Returns the media index for a local ice candidate given the content name.
392 // Returns false if the local session description does not have a media
393 // content called |content_name|.
394 bool GetLocalCandidateMediaIndex(const std::string& content_name,
395 int* sdp_mline_index);
396 // Uses all remote candidates in |remote_desc| in this session.
397 bool UseCandidatesInSessionDescription(
398 const SessionDescriptionInterface* remote_desc);
399 // Uses |candidate| in this session.
400 bool UseCandidate(const IceCandidateInterface* candidate);
401 // Deletes the corresponding channel of contents that don't exist in |desc|.
402 // |desc| can be null. This means that all channels are deleted.
403 void RemoveUnusedChannels(const cricket::SessionDescription* desc);
404
405 // Allocates media channels based on the |desc|. If |desc| doesn't have
406 // the BUNDLE option, this method will disable BUNDLE in PortAllocator.
407 // This method will also delete any existing media channels before creating.
408 bool CreateChannels(const cricket::SessionDescription* desc);
409
410 // Helper methods to create media channels.
411 bool CreateVoiceChannel(const cricket::ContentInfo* content);
412 bool CreateVideoChannel(const cricket::ContentInfo* content);
413 bool CreateDataChannel(const cricket::ContentInfo* content);
414
415 // Listens to SCTP CONTROL messages on unused SIDs and process them as OPEN
416 // messages.
417 void OnDataChannelMessageReceived(cricket::DataChannel* channel,
418 const cricket::ReceiveDataParams& params,
419 const rtc::Buffer& payload);
420
421 std::string BadStateErrMsg(State state);
422 void SetIceConnectionState(PeerConnectionInterface::IceConnectionState state);
423 void SetIceConnectionReceiving(bool receiving);
424
425 bool ValidateBundleSettings(const cricket::SessionDescription* desc);
426 bool HasRtcpMuxEnabled(const cricket::ContentInfo* content);
427 // Below methods are helper methods which verifies SDP.
428 bool ValidateSessionDescription(const SessionDescriptionInterface* sdesc,
429 cricket::ContentSource source,
430 std::string* err_desc);
431
432 // Check if a call to SetLocalDescription is acceptable with |action|.
433 bool ExpectSetLocalDescription(Action action);
434 // Check if a call to SetRemoteDescription is acceptable with |action|.
435 bool ExpectSetRemoteDescription(Action action);
436 // Verifies a=setup attribute as per RFC 5763.
437 bool ValidateDtlsSetupAttribute(const cricket::SessionDescription* desc,
438 Action action);
439
440 // Returns true if we are ready to push down the remote candidate.
441 // |remote_desc| is the new remote description, or NULL if the current remote
442 // description should be used. Output |valid| is true if the candidate media
443 // index is valid.
444 bool ReadyToUseRemoteCandidate(const IceCandidateInterface* candidate,
445 const SessionDescriptionInterface* remote_desc,
446 bool* valid);
447
448 void OnTransportControllerConnectionState(cricket::IceConnectionState state);
449 void OnTransportControllerReceiving(bool receiving);
450 void OnTransportControllerGatheringState(cricket::IceGatheringState state);
451 void OnTransportControllerCandidatesGathered(
452 const std::string& transport_name,
453 const cricket::Candidates& candidates);
454
455 std::string GetSessionErrorMsg();
456
457 // Invoked when TransportController connection completion is signaled.
458 // Reports stats for all transports in use.
459 void ReportTransportStats();
460
461 // Gather the usage of IPv4/IPv6 as best connection.
462 void ReportBestConnectionState(const cricket::TransportStats& stats);
463
464 void ReportNegotiatedCiphers(const cricket::TransportStats& stats);
465
466 void OnSentPacket_w(cricket::TransportChannel* channel,
467 const rtc::SentPacket& sent_packet);
468
469 rtc::Thread* const signaling_thread_;
470 rtc::Thread* const worker_thread_;
471 cricket::PortAllocator* const port_allocator_;
472
473 State state_ = STATE_INIT;
474 Error error_ = ERROR_NONE;
475 std::string error_desc_;
476
477 const std::string sid_;
478 bool initial_offerer_ = false;
479
480 rtc::scoped_ptr<cricket::TransportController> transport_controller_;
481 MediaControllerInterface* media_controller_;
482 rtc::scoped_ptr<cricket::VoiceChannel> voice_channel_;
483 rtc::scoped_ptr<cricket::VideoChannel> video_channel_;
484 rtc::scoped_ptr<cricket::DataChannel> data_channel_;
485 cricket::ChannelManager* channel_manager_;
486 IceObserver* ice_observer_;
487 PeerConnectionInterface::IceConnectionState ice_connection_state_;
488 bool ice_connection_receiving_;
489 rtc::scoped_ptr<SessionDescriptionInterface> local_desc_;
490 rtc::scoped_ptr<SessionDescriptionInterface> remote_desc_;
491 // If the remote peer is using a older version of implementation.
492 bool older_version_remote_peer_;
493 bool dtls_enabled_;
494 // Specifies which kind of data channel is allowed. This is controlled
495 // by the chrome command-line flag and constraints:
496 // 1. If chrome command-line switch 'enable-sctp-data-channels' is enabled,
497 // constraint kEnableDtlsSrtp is true, and constaint kEnableRtpDataChannels is
498 // not set or false, SCTP is allowed (DCT_SCTP);
499 // 2. If constraint kEnableRtpDataChannels is true, RTP is allowed (DCT_RTP);
500 // 3. If both 1&2 are false, data channel is not allowed (DCT_NONE).
501 cricket::DataChannelType data_channel_type_;
502 rtc::scoped_ptr<IceRestartAnswerLatch> ice_restart_latch_;
503
504 rtc::scoped_ptr<WebRtcSessionDescriptionFactory>
505 webrtc_session_desc_factory_;
506
507 // Member variables for caching global options.
508 cricket::AudioOptions audio_options_;
509 cricket::VideoOptions video_options_;
510 MetricsObserverInterface* metrics_observer_;
511
512 // Declares the bundle policy for the WebRTCSession.
513 PeerConnectionInterface::BundlePolicy bundle_policy_;
514
515 // Declares the RTCP mux policy for the WebRTCSession.
516 PeerConnectionInterface::RtcpMuxPolicy rtcp_mux_policy_;
517
518 RTC_DISALLOW_COPY_AND_ASSIGN(WebRtcSession);
519 };
520 } // namespace webrtc
521
522 #endif // TALK_APP_WEBRTC_WEBRTCSESSION_H_
OLDNEW
« no previous file with comments | « talk/app/webrtc/webrtcsdp_unittest.cc ('k') | talk/app/webrtc/webrtcsession.cc » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698