blob: f86b900b9117205439b67c9a481ba291d726e243 [file] [log] [blame]
Harald Alvestrandcdcfab02020-09-28 13:02:07 +00001/*
2 * Copyright 2020 The WebRTC project authors. All Rights Reserved.
3 *
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.
9 */
10
11#ifndef PC_SDP_OFFER_ANSWER_H_
12#define PC_SDP_OFFER_ANSWER_H_
13
Harald Alvestrand1f7eab62020-10-18 16:51:47 +000014#include <stddef.h>
15#include <stdint.h>
Florent Castellidcb9ffc2021-06-29 14:58:23 +020016
Harald Alvestrand1f7eab62020-10-18 16:51:47 +000017#include <functional>
Harald Alvestrandcdcfab02020-09-28 13:02:07 +000018#include <map>
19#include <memory>
20#include <set>
21#include <string>
22#include <utility>
23#include <vector>
24
Harald Alvestrand1f7eab62020-10-18 16:51:47 +000025#include "absl/types/optional.h"
Harald Alvestrand763f5a92020-10-22 10:39:40 +000026#include "api/audio_options.h"
Harald Alvestrand1f7eab62020-10-18 16:51:47 +000027#include "api/candidate.h"
28#include "api/jsep.h"
Harald Alvestrandcdcfab02020-09-28 13:02:07 +000029#include "api/jsep_ice_candidate.h"
Harald Alvestrand1f7eab62020-10-18 16:51:47 +000030#include "api/media_stream_interface.h"
31#include "api/media_types.h"
Harald Alvestrandcdcfab02020-09-28 13:02:07 +000032#include "api/peer_connection_interface.h"
Harald Alvestrand1f7eab62020-10-18 16:51:47 +000033#include "api/rtc_error.h"
34#include "api/rtp_transceiver_direction.h"
35#include "api/rtp_transceiver_interface.h"
36#include "api/scoped_refptr.h"
Artem Titovd15a5752021-02-10 14:31:24 +010037#include "api/sequence_checker.h"
Harald Alvestrand1f7eab62020-10-18 16:51:47 +000038#include "api/set_local_description_observer_interface.h"
39#include "api/set_remote_description_observer_interface.h"
Harald Alvestrandcdcfab02020-09-28 13:02:07 +000040#include "api/transport/data_channel_transport_interface.h"
41#include "api/turn_customizer.h"
Tomas Gunnarsson2efb8a52021-04-01 16:26:57 +020042#include "api/uma_metrics.h"
Harald Alvestrandf01bd6c2020-10-23 13:30:46 +000043#include "api/video/video_bitrate_allocator_factory.h"
Harald Alvestrand763f5a92020-10-22 10:39:40 +000044#include "media/base/media_channel.h"
Harald Alvestrand1f7eab62020-10-18 16:51:47 +000045#include "media/base/stream_params.h"
46#include "p2p/base/port_allocator.h"
47#include "pc/channel.h"
48#include "pc/channel_interface.h"
49#include "pc/channel_manager.h"
Harald Alvestrandcdcfab02020-09-28 13:02:07 +000050#include "pc/data_channel_controller.h"
51#include "pc/ice_server_parsing.h"
52#include "pc/jsep_transport_controller.h"
Harald Alvestrand1f7eab62020-10-18 16:51:47 +000053#include "pc/media_session.h"
54#include "pc/media_stream_observer.h"
Harald Alvestrandcdcfab02020-09-28 13:02:07 +000055#include "pc/peer_connection_factory.h"
56#include "pc/peer_connection_internal.h"
57#include "pc/rtc_stats_collector.h"
Harald Alvestrand1f7eab62020-10-18 16:51:47 +000058#include "pc/rtp_receiver.h"
Harald Alvestrandcdcfab02020-09-28 13:02:07 +000059#include "pc/rtp_sender.h"
60#include "pc/rtp_transceiver.h"
Harald Alvestrand763f5a92020-10-22 10:39:40 +000061#include "pc/rtp_transmission_manager.h"
Harald Alvestrandcdcfab02020-09-28 13:02:07 +000062#include "pc/sctp_transport.h"
Harald Alvestrandf01bd6c2020-10-23 13:30:46 +000063#include "pc/sdp_state_provider.h"
Harald Alvestrand1f7eab62020-10-18 16:51:47 +000064#include "pc/session_description.h"
Harald Alvestrandcdcfab02020-09-28 13:02:07 +000065#include "pc/stats_collector.h"
66#include "pc/stream_collection.h"
Harald Alvestrand1f7eab62020-10-18 16:51:47 +000067#include "pc/transceiver_list.h"
Harald Alvestrandcdcfab02020-09-28 13:02:07 +000068#include "pc/webrtc_session_description_factory.h"
Harald Alvestrand1f7eab62020-10-18 16:51:47 +000069#include "rtc_base/checks.h"
Harald Alvestrandcdcfab02020-09-28 13:02:07 +000070#include "rtc_base/experiments/field_trial_parser.h"
71#include "rtc_base/operations_chain.h"
72#include "rtc_base/race_checker.h"
Harald Alvestrandf01bd6c2020-10-23 13:30:46 +000073#include "rtc_base/rtc_certificate.h"
74#include "rtc_base/ssl_stream_adapter.h"
Harald Alvestrandf01bd6c2020-10-23 13:30:46 +000075#include "rtc_base/third_party/sigslot/sigslot.h"
Harald Alvestrand1f7eab62020-10-18 16:51:47 +000076#include "rtc_base/thread.h"
77#include "rtc_base/thread_annotations.h"
Harald Alvestrandcdcfab02020-09-28 13:02:07 +000078#include "rtc_base/unique_id_generator.h"
79#include "rtc_base/weak_ptr.h"
80
81namespace webrtc {
82
Harald Alvestrandcdcfab02020-09-28 13:02:07 +000083// SdpOfferAnswerHandler is a component
84// of the PeerConnection object as defined
85// by the PeerConnectionInterface API surface.
86// The class is responsible for the following:
87// - Parsing and interpreting SDP.
88// - Generating offers and answers based on the current state.
89// This class lives on the signaling thread.
Harald Alvestrandf01bd6c2020-10-23 13:30:46 +000090class SdpOfferAnswerHandler : public SdpStateProvider,
91 public sigslot::has_slots<> {
Harald Alvestrandcdcfab02020-09-28 13:02:07 +000092 public:
Harald Alvestrandcdcfab02020-09-28 13:02:07 +000093 ~SdpOfferAnswerHandler();
94
Harald Alvestrand9cd199d2020-10-27 07:10:43 +000095 // Creates an SdpOfferAnswerHandler. Modifies dependencies.
96 static std::unique_ptr<SdpOfferAnswerHandler> Create(
97 PeerConnection* pc,
Harald Alvestrand763f5a92020-10-22 10:39:40 +000098 const PeerConnectionInterface::RTCConfiguration& configuration,
Harald Alvestrand9cd199d2020-10-27 07:10:43 +000099 PeerConnectionDependencies& dependencies);
Harald Alvestrand763f5a92020-10-22 10:39:40 +0000100
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000101 void ResetSessionDescFactory() {
102 RTC_DCHECK_RUN_ON(signaling_thread());
103 webrtc_session_desc_factory_.reset();
104 }
105 const WebRtcSessionDescriptionFactory* webrtc_session_desc_factory() const {
106 RTC_DCHECK_RUN_ON(signaling_thread());
107 return webrtc_session_desc_factory_.get();
108 }
109
110 // Change signaling state to Closed, and perform appropriate actions.
111 void Close();
112
113 // Called as part of destroying the owning PeerConnection.
114 void PrepareForShutdown();
115
Harald Alvestrandf01bd6c2020-10-23 13:30:46 +0000116 // Implementation of SdpStateProvider
117 PeerConnectionInterface::SignalingState signaling_state() const override;
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000118
Harald Alvestrandf01bd6c2020-10-23 13:30:46 +0000119 const SessionDescriptionInterface* local_description() const override;
120 const SessionDescriptionInterface* remote_description() const override;
121 const SessionDescriptionInterface* current_local_description() const override;
122 const SessionDescriptionInterface* current_remote_description()
123 const override;
124 const SessionDescriptionInterface* pending_local_description() const override;
125 const SessionDescriptionInterface* pending_remote_description()
126 const override;
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000127
Harald Alvestrandf01bd6c2020-10-23 13:30:46 +0000128 bool NeedsIceRestart(const std::string& content_name) const override;
129 bool IceRestartPending(const std::string& content_name) const override;
130 absl::optional<rtc::SSLRole> GetDtlsRole(
131 const std::string& mid) const override;
Harald Alvestrandd89ce532020-10-21 08:59:22 +0000132
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000133 void RestartIce();
134
135 // JSEP01
136 void CreateOffer(
137 CreateSessionDescriptionObserver* observer,
138 const PeerConnectionInterface::RTCOfferAnswerOptions& options);
139 void CreateAnswer(
140 CreateSessionDescriptionObserver* observer,
141 const PeerConnectionInterface::RTCOfferAnswerOptions& options);
142
143 void SetLocalDescription(
144 std::unique_ptr<SessionDescriptionInterface> desc,
145 rtc::scoped_refptr<SetLocalDescriptionObserverInterface> observer);
146 void SetLocalDescription(
147 rtc::scoped_refptr<SetLocalDescriptionObserverInterface> observer);
148 void SetLocalDescription(SetSessionDescriptionObserver* observer,
149 SessionDescriptionInterface* desc);
150 void SetLocalDescription(SetSessionDescriptionObserver* observer);
151
152 void SetRemoteDescription(
153 std::unique_ptr<SessionDescriptionInterface> desc,
154 rtc::scoped_refptr<SetRemoteDescriptionObserverInterface> observer);
155 void SetRemoteDescription(SetSessionDescriptionObserver* observer,
156 SessionDescriptionInterface* desc);
157
158 PeerConnectionInterface::RTCConfiguration GetConfiguration();
159 RTCError SetConfiguration(
160 const PeerConnectionInterface::RTCConfiguration& configuration);
161 bool AddIceCandidate(const IceCandidateInterface* candidate);
162 void AddIceCandidate(std::unique_ptr<IceCandidateInterface> candidate,
163 std::function<void(RTCError)> callback);
164 bool RemoveIceCandidates(const std::vector<cricket::Candidate>& candidates);
165 // Adds a locally generated candidate to the local description.
166 void AddLocalIceCandidate(const JsepIceCandidate* candidate);
167 void RemoveLocalIceCandidates(
168 const std::vector<cricket::Candidate>& candidates);
169 bool ShouldFireNegotiationNeededEvent(uint32_t event_id);
170
Harald Alvestrand6f04b652020-10-09 11:42:17 +0000171 bool AddStream(MediaStreamInterface* local_stream);
172 void RemoveStream(MediaStreamInterface* local_stream);
173
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000174 absl::optional<bool> is_caller();
175 bool HasNewIceCredentials();
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000176 void UpdateNegotiationNeeded();
177
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000178 // Destroys all BaseChannels and destroys the SCTP data channel, if present.
179 void DestroyAllChannels();
180
Harald Alvestrand6f04b652020-10-09 11:42:17 +0000181 rtc::scoped_refptr<StreamCollectionInterface> local_streams();
182 rtc::scoped_refptr<StreamCollectionInterface> remote_streams();
183
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000184 private:
185 class ImplicitCreateSessionDescriptionObserver;
Harald Alvestrand1f7eab62020-10-18 16:51:47 +0000186
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000187 friend class ImplicitCreateSessionDescriptionObserver;
188 class SetSessionDescriptionObserverAdapter;
Harald Alvestrand1f7eab62020-10-18 16:51:47 +0000189
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000190 friend class SetSessionDescriptionObserverAdapter;
191
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000192 enum class SessionError {
193 kNone, // No error.
194 kContent, // Error in BaseChannel SetLocalContent/SetRemoteContent.
195 kTransport, // Error from the underlying transport.
196 };
197
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000198 // Represents the [[LocalIceCredentialsToReplace]] internal slot in the spec.
199 // It makes the next CreateOffer() produce new ICE credentials even if
200 // RTCOfferAnswerOptions::ice_restart is false.
201 // https://w3c.github.io/webrtc-pc/#dfn-localufragstoreplace
202 // TODO(hbos): When JsepTransportController/JsepTransport supports rollback,
203 // move this type of logic to JsepTransportController/JsepTransport.
204 class LocalIceCredentialsToReplace;
205
Harald Alvestrand9cd199d2020-10-27 07:10:43 +0000206 // Only called by the Create() function.
207 explicit SdpOfferAnswerHandler(PeerConnection* pc);
208 // Called from the `Create()` function. Can only be called
209 // once. Modifies dependencies.
210 void Initialize(
211 const PeerConnectionInterface::RTCConfiguration& configuration,
212 PeerConnectionDependencies& dependencies);
213
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000214 rtc::Thread* signaling_thread() const;
215 // Non-const versions of local_description()/remote_description(), for use
216 // internally.
217 SessionDescriptionInterface* mutable_local_description()
218 RTC_RUN_ON(signaling_thread()) {
219 return pending_local_description_ ? pending_local_description_.get()
220 : current_local_description_.get();
221 }
222 SessionDescriptionInterface* mutable_remote_description()
223 RTC_RUN_ON(signaling_thread()) {
224 return pending_remote_description_ ? pending_remote_description_.get()
225 : current_remote_description_.get();
226 }
227
228 // Synchronous implementations of SetLocalDescription/SetRemoteDescription
229 // that return an RTCError instead of invoking a callback.
230 RTCError ApplyLocalDescription(
Henrik Boströmf8187e02021-04-26 21:04:26 +0200231 std::unique_ptr<SessionDescriptionInterface> desc,
232 const std::map<std::string, const cricket::ContentGroup*>&
233 bundle_groups_by_mid);
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000234 RTCError ApplyRemoteDescription(
Henrik Boströmf8187e02021-04-26 21:04:26 +0200235 std::unique_ptr<SessionDescriptionInterface> desc,
236 const std::map<std::string, const cricket::ContentGroup*>&
237 bundle_groups_by_mid);
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000238
239 // Implementation of the offer/answer exchange operations. These are chained
240 // onto the |operations_chain_| when the public CreateOffer(), CreateAnswer(),
241 // SetLocalDescription() and SetRemoteDescription() methods are invoked.
242 void DoCreateOffer(
243 const PeerConnectionInterface::RTCOfferAnswerOptions& options,
244 rtc::scoped_refptr<CreateSessionDescriptionObserver> observer);
245 void DoCreateAnswer(
246 const PeerConnectionInterface::RTCOfferAnswerOptions& options,
247 rtc::scoped_refptr<CreateSessionDescriptionObserver> observer);
248 void DoSetLocalDescription(
249 std::unique_ptr<SessionDescriptionInterface> desc,
250 rtc::scoped_refptr<SetLocalDescriptionObserverInterface> observer);
251 void DoSetRemoteDescription(
252 std::unique_ptr<SessionDescriptionInterface> desc,
253 rtc::scoped_refptr<SetRemoteDescriptionObserverInterface> observer);
254
255 // Update the state, signaling if necessary.
256 void ChangeSignalingState(
257 PeerConnectionInterface::SignalingState signaling_state);
258
Henrik Boströmf8187e02021-04-26 21:04:26 +0200259 RTCError UpdateSessionState(
260 SdpType type,
261 cricket::ContentSource source,
262 const cricket::SessionDescription* description,
263 const std::map<std::string, const cricket::ContentGroup*>&
264 bundle_groups_by_mid);
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000265
266 bool IsUnifiedPlan() const RTC_RUN_ON(signaling_thread());
267
Harald Alvestrand763f5a92020-10-22 10:39:40 +0000268 // Signals from MediaStreamObserver.
269 void OnAudioTrackAdded(AudioTrackInterface* track,
270 MediaStreamInterface* stream)
271 RTC_RUN_ON(signaling_thread());
272 void OnAudioTrackRemoved(AudioTrackInterface* track,
273 MediaStreamInterface* stream)
274 RTC_RUN_ON(signaling_thread());
275 void OnVideoTrackAdded(VideoTrackInterface* track,
276 MediaStreamInterface* stream)
277 RTC_RUN_ON(signaling_thread());
278 void OnVideoTrackRemoved(VideoTrackInterface* track,
279 MediaStreamInterface* stream)
280 RTC_RUN_ON(signaling_thread());
281
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000282 // | desc_type | is the type of the description that caused the rollback.
283 RTCError Rollback(SdpType desc_type);
284 void OnOperationsChainEmpty();
285
286 // Runs the algorithm **set the associated remote streams** specified in
287 // https://w3c.github.io/webrtc-pc/#set-associated-remote-streams.
288 void SetAssociatedRemoteStreams(
289 rtc::scoped_refptr<RtpReceiverInternal> receiver,
290 const std::vector<std::string>& stream_ids,
291 std::vector<rtc::scoped_refptr<MediaStreamInterface>>* added_streams,
292 std::vector<rtc::scoped_refptr<MediaStreamInterface>>* removed_streams);
293
294 bool CheckIfNegotiationIsNeeded();
295 void GenerateNegotiationNeededEvent();
296 // Helper method which verifies SDP.
Henrik Boströmf8187e02021-04-26 21:04:26 +0200297 RTCError ValidateSessionDescription(
298 const SessionDescriptionInterface* sdesc,
299 cricket::ContentSource source,
300 const std::map<std::string, const cricket::ContentGroup*>&
301 bundle_groups_by_mid) RTC_RUN_ON(signaling_thread());
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000302
303 // Updates the local RtpTransceivers according to the JSEP rules. Called as
304 // part of setting the local/remote description.
305 RTCError UpdateTransceiversAndDataChannels(
306 cricket::ContentSource source,
307 const SessionDescriptionInterface& new_session,
308 const SessionDescriptionInterface* old_local_description,
Henrik Boströmf8187e02021-04-26 21:04:26 +0200309 const SessionDescriptionInterface* old_remote_description,
310 const std::map<std::string, const cricket::ContentGroup*>&
311 bundle_groups_by_mid);
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000312
313 // Associate the given transceiver according to the JSEP rules.
314 RTCErrorOr<
315 rtc::scoped_refptr<RtpTransceiverProxyWithInternal<RtpTransceiver>>>
316 AssociateTransceiver(cricket::ContentSource source,
317 SdpType type,
318 size_t mline_index,
319 const cricket::ContentInfo& content,
320 const cricket::ContentInfo* old_local_content,
321 const cricket::ContentInfo* old_remote_content)
322 RTC_RUN_ON(signaling_thread());
323
Harald Alvestrand85466662021-04-19 21:21:36 +0000324 // Returns the media section in the given session description that is
325 // associated with the RtpTransceiver. Returns null if none found or this
326 // RtpTransceiver is not associated. Logic varies depending on the
327 // SdpSemantics specified in the configuration.
328 const cricket::ContentInfo* FindMediaSectionForTransceiver(
329 const RtpTransceiver* transceiver,
330 const SessionDescriptionInterface* sdesc) const;
331
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000332 // Either creates or destroys the transceiver's BaseChannel according to the
333 // given media section.
334 RTCError UpdateTransceiverChannel(
335 rtc::scoped_refptr<RtpTransceiverProxyWithInternal<RtpTransceiver>>
336 transceiver,
337 const cricket::ContentInfo& content,
338 const cricket::ContentGroup* bundle_group) RTC_RUN_ON(signaling_thread());
339
340 // Either creates or destroys the local data channel according to the given
341 // media section.
342 RTCError UpdateDataChannel(cricket::ContentSource source,
343 const cricket::ContentInfo& content,
344 const cricket::ContentGroup* bundle_group)
345 RTC_RUN_ON(signaling_thread());
Harald Alvestrandc06e3742020-10-01 10:23:33 +0000346 // Check if a call to SetLocalDescription is acceptable with a session
347 // description of the given type.
348 bool ExpectSetLocalDescription(SdpType type);
349 // Check if a call to SetRemoteDescription is acceptable with a session
350 // description of the given type.
351 bool ExpectSetRemoteDescription(SdpType type);
352
353 // The offer/answer machinery assumes the media section MID is present and
354 // unique. To support legacy end points that do not supply a=mid lines, this
355 // method will modify the session description to add MIDs generated according
356 // to the SDP semantics.
357 void FillInMissingRemoteMids(cricket::SessionDescription* remote_description);
358
359 // Returns an RtpTransciever, if available, that can be used to receive the
360 // given media type according to JSEP rules.
361 rtc::scoped_refptr<RtpTransceiverProxyWithInternal<RtpTransceiver>>
362 FindAvailableTransceiverToReceive(cricket::MediaType media_type) const;
363
364 // Returns a MediaSessionOptions struct with options decided by |options|,
365 // the local MediaStreams and DataChannels.
366 void GetOptionsForOffer(const PeerConnectionInterface::RTCOfferAnswerOptions&
367 offer_answer_options,
368 cricket::MediaSessionOptions* session_options);
369 void GetOptionsForPlanBOffer(
370 const PeerConnectionInterface::RTCOfferAnswerOptions&
371 offer_answer_options,
372 cricket::MediaSessionOptions* session_options)
373 RTC_RUN_ON(signaling_thread());
374 void GetOptionsForUnifiedPlanOffer(
375 const PeerConnectionInterface::RTCOfferAnswerOptions&
376 offer_answer_options,
377 cricket::MediaSessionOptions* session_options)
378 RTC_RUN_ON(signaling_thread());
379
380 // Returns a MediaSessionOptions struct with options decided by
381 // |constraints|, the local MediaStreams and DataChannels.
382 void GetOptionsForAnswer(const PeerConnectionInterface::RTCOfferAnswerOptions&
383 offer_answer_options,
384 cricket::MediaSessionOptions* session_options);
385 void GetOptionsForPlanBAnswer(
386 const PeerConnectionInterface::RTCOfferAnswerOptions&
387 offer_answer_options,
388 cricket::MediaSessionOptions* session_options)
389 RTC_RUN_ON(signaling_thread());
390 void GetOptionsForUnifiedPlanAnswer(
391 const PeerConnectionInterface::RTCOfferAnswerOptions&
392 offer_answer_options,
393 cricket::MediaSessionOptions* session_options)
394 RTC_RUN_ON(signaling_thread());
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000395
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000396 const char* SessionErrorToString(SessionError error) const;
397 std::string GetSessionErrorMsg();
398 // Returns the last error in the session. See the enum above for details.
399 SessionError session_error() const {
400 RTC_DCHECK_RUN_ON(signaling_thread());
401 return session_error_;
402 }
403 const std::string& session_error_desc() const { return session_error_desc_; }
404
405 RTCError HandleLegacyOfferOptions(
406 const PeerConnectionInterface::RTCOfferAnswerOptions& options);
407 void RemoveRecvDirectionFromReceivingTransceiversOfType(
408 cricket::MediaType media_type) RTC_RUN_ON(signaling_thread());
409 void AddUpToOneReceivingTransceiverOfType(cricket::MediaType media_type);
410
411 std::vector<
412 rtc::scoped_refptr<RtpTransceiverProxyWithInternal<RtpTransceiver>>>
413 GetReceivingTransceiversOfType(cricket::MediaType media_type)
414 RTC_RUN_ON(signaling_thread());
415
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000416 // Runs the algorithm specified in
417 // https://w3c.github.io/webrtc-pc/#process-remote-track-removal
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000418 // This method will update the following lists:
419 // |remove_list| is the list of transceivers for which the receiving track is
420 // being removed.
421 // |removed_streams| is the list of streams which no longer have a receiving
422 // track so should be removed.
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000423 void ProcessRemovalOfRemoteTrack(
Harald Alvestrand85466662021-04-19 21:21:36 +0000424 const rtc::scoped_refptr<RtpTransceiverProxyWithInternal<RtpTransceiver>>
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000425 transceiver,
426 std::vector<rtc::scoped_refptr<RtpTransceiverInterface>>* remove_list,
427 std::vector<rtc::scoped_refptr<MediaStreamInterface>>* removed_streams);
428
429 void RemoveRemoteStreamsIfEmpty(
430 const std::vector<rtc::scoped_refptr<MediaStreamInterface>>&
431 remote_streams,
432 std::vector<rtc::scoped_refptr<MediaStreamInterface>>* removed_streams);
433
434 // Remove all local and remote senders of type |media_type|.
435 // Called when a media type is rejected (m-line set to port 0).
436 void RemoveSenders(cricket::MediaType media_type);
437
438 // Loops through the vector of |streams| and finds added and removed
439 // StreamParams since last time this method was called.
440 // For each new or removed StreamParam, OnLocalSenderSeen or
441 // OnLocalSenderRemoved is invoked.
442 void UpdateLocalSenders(const std::vector<cricket::StreamParams>& streams,
443 cricket::MediaType media_type);
444
445 // Makes sure a MediaStreamTrack is created for each StreamParam in |streams|,
446 // and existing MediaStreamTracks are removed if there is no corresponding
447 // StreamParam. If |default_track_needed| is true, a default MediaStreamTrack
448 // is created if it doesn't exist; if false, it's removed if it exists.
449 // |media_type| is the type of the |streams| and can be either audio or video.
450 // If a new MediaStream is created it is added to |new_streams|.
451 void UpdateRemoteSendersList(
452 const std::vector<cricket::StreamParams>& streams,
453 bool default_track_needed,
454 cricket::MediaType media_type,
455 StreamCollection* new_streams);
456
Taylor Brandstetterd0acbd82021-01-25 13:44:55 -0800457 // Enables media channels to allow sending of media.
Harald Alvestrand48171ec2021-04-20 15:06:03 +0000458 // This enables media to flow on all configured audio/video channels.
Taylor Brandstetterd0acbd82021-01-25 13:44:55 -0800459 void EnableSending();
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000460 // Push the media parts of the local or remote session description
Taylor Brandstetterd0acbd82021-01-25 13:44:55 -0800461 // down to all of the channels.
Henrik Boströmf8187e02021-04-26 21:04:26 +0200462 RTCError PushdownMediaDescription(
463 SdpType type,
464 cricket::ContentSource source,
465 const std::map<std::string, const cricket::ContentGroup*>&
466 bundle_groups_by_mid);
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000467
468 RTCError PushdownTransportDescription(cricket::ContentSource source,
469 SdpType type);
470 // Helper function to remove stopped transceivers.
471 void RemoveStoppedTransceivers();
472 // Deletes the corresponding channel of contents that don't exist in |desc|.
473 // |desc| can be null. This means that all channels are deleted.
474 void RemoveUnusedChannels(const cricket::SessionDescription* desc);
475
476 // Report inferred negotiated SDP semantics from a local/remote answer to the
477 // UMA observer.
478 void ReportNegotiatedSdpSemantics(const SessionDescriptionInterface& answer);
479
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000480 // Finds remote MediaStreams without any tracks and removes them from
481 // |remote_streams_| and notifies the observer that the MediaStreams no longer
482 // exist.
483 void UpdateEndedRemoteMediaStreams();
484
485 // Uses all remote candidates in |remote_desc| in this session.
486 bool UseCandidatesInSessionDescription(
487 const SessionDescriptionInterface* remote_desc);
488 // Uses |candidate| in this session.
489 bool UseCandidate(const IceCandidateInterface* candidate);
490 // Returns true if we are ready to push down the remote candidate.
491 // |remote_desc| is the new remote description, or NULL if the current remote
492 // description should be used. Output |valid| is true if the candidate media
493 // index is valid.
494 bool ReadyToUseRemoteCandidate(const IceCandidateInterface* candidate,
495 const SessionDescriptionInterface* remote_desc,
496 bool* valid);
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000497
498 RTCErrorOr<const cricket::ContentInfo*> FindContentInfo(
499 const SessionDescriptionInterface* description,
500 const IceCandidateInterface* candidate) RTC_RUN_ON(signaling_thread());
501
502 // Functions for dealing with transports.
503 // Note that cricket code uses the term "channel" for what other code
504 // refers to as "transport".
505
506 // Allocates media channels based on the |desc|. If |desc| doesn't have
507 // the BUNDLE option, this method will disable BUNDLE in PortAllocator.
508 // This method will also delete any existing media channels before creating.
509 RTCError CreateChannels(const cricket::SessionDescription& desc);
510
511 // Helper methods to create media channels.
512 cricket::VoiceChannel* CreateVoiceChannel(const std::string& mid);
513 cricket::VideoChannel* CreateVideoChannel(const std::string& mid);
514 bool CreateDataChannel(const std::string& mid);
515
516 // Destroys and clears the BaseChannel associated with the given transceiver,
517 // if such channel is set.
518 void DestroyTransceiverChannel(
519 rtc::scoped_refptr<RtpTransceiverProxyWithInternal<RtpTransceiver>>
520 transceiver);
521
522 // Destroys the RTP data channel transport and/or the SCTP data channel
523 // transport and clears it.
Florent Castellidcb9ffc2021-06-29 14:58:23 +0200524 void DestroyDataChannelTransport(RTCError error);
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000525
526 // Destroys the given ChannelInterface.
527 // The channel cannot be accessed after this method is called.
528 void DestroyChannelInterface(cricket::ChannelInterface* channel);
529 // Generates MediaDescriptionOptions for the |session_opts| based on existing
530 // local description or remote description.
531
532 void GenerateMediaDescriptionOptions(
533 const SessionDescriptionInterface* session_desc,
534 RtpTransceiverDirection audio_direction,
535 RtpTransceiverDirection video_direction,
536 absl::optional<size_t>* audio_index,
537 absl::optional<size_t>* video_index,
538 absl::optional<size_t>* data_index,
539 cricket::MediaSessionOptions* session_options);
540
541 // Generates the active MediaDescriptionOptions for the local data channel
542 // given the specified MID.
543 cricket::MediaDescriptionOptions GetMediaDescriptionOptionsForActiveData(
544 const std::string& mid) const;
545
546 // Generates the rejected MediaDescriptionOptions for the local data channel
547 // given the specified MID.
548 cricket::MediaDescriptionOptions GetMediaDescriptionOptionsForRejectedData(
549 const std::string& mid) const;
550
Taylor Brandstetterd0acbd82021-01-25 13:44:55 -0800551 // Based on number of transceivers per media type, enabled or disable
552 // payload type based demuxing in the affected channels.
Henrik Boströmf8187e02021-04-26 21:04:26 +0200553 bool UpdatePayloadTypeDemuxingState(
554 cricket::ContentSource source,
555 const std::map<std::string, const cricket::ContentGroup*>&
556 bundle_groups_by_mid);
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000557
558 // ==================================================================
559 // Access to pc_ variables
560 cricket::ChannelManager* channel_manager() const;
Harald Alvestrande15fb152020-10-19 13:28:05 +0000561 TransceiverList* transceivers();
562 const TransceiverList* transceivers() const;
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000563 DataChannelController* data_channel_controller();
564 const DataChannelController* data_channel_controller() const;
565 cricket::PortAllocator* port_allocator();
566 const cricket::PortAllocator* port_allocator() const;
Harald Alvestrande15fb152020-10-19 13:28:05 +0000567 RtpTransmissionManager* rtp_manager();
568 const RtpTransmissionManager* rtp_manager() const;
Harald Alvestrandf01bd6c2020-10-23 13:30:46 +0000569 JsepTransportController* transport_controller();
570 const JsepTransportController* transport_controller() const;
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000571 // ===================================================================
Harald Alvestrand763f5a92020-10-22 10:39:40 +0000572 const cricket::AudioOptions& audio_options() { return audio_options_; }
573 const cricket::VideoOptions& video_options() { return video_options_; }
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000574
575 PeerConnection* const pc_;
576
577 std::unique_ptr<WebRtcSessionDescriptionFactory> webrtc_session_desc_factory_
578 RTC_GUARDED_BY(signaling_thread());
579
580 std::unique_ptr<SessionDescriptionInterface> current_local_description_
581 RTC_GUARDED_BY(signaling_thread());
582 std::unique_ptr<SessionDescriptionInterface> pending_local_description_
583 RTC_GUARDED_BY(signaling_thread());
584 std::unique_ptr<SessionDescriptionInterface> current_remote_description_
585 RTC_GUARDED_BY(signaling_thread());
586 std::unique_ptr<SessionDescriptionInterface> pending_remote_description_
587 RTC_GUARDED_BY(signaling_thread());
588
589 PeerConnectionInterface::SignalingState signaling_state_
590 RTC_GUARDED_BY(signaling_thread()) = PeerConnectionInterface::kStable;
591
592 // Whether this peer is the caller. Set when the local description is applied.
593 absl::optional<bool> is_caller_ RTC_GUARDED_BY(signaling_thread());
594
Harald Alvestrand6f04b652020-10-09 11:42:17 +0000595 // Streams added via AddStream.
596 const rtc::scoped_refptr<StreamCollection> local_streams_
597 RTC_GUARDED_BY(signaling_thread());
598 // Streams created as a result of SetRemoteDescription.
599 const rtc::scoped_refptr<StreamCollection> remote_streams_
600 RTC_GUARDED_BY(signaling_thread());
601
602 std::vector<std::unique_ptr<MediaStreamObserver>> stream_observers_
603 RTC_GUARDED_BY(signaling_thread());
604
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000605 // The operations chain is used by the offer/answer exchange methods to ensure
606 // they are executed in the right order. For example, if
607 // SetRemoteDescription() is invoked while CreateOffer() is still pending, the
608 // SRD operation will not start until CreateOffer() has completed. See
609 // https://w3c.github.io/webrtc-pc/#dfn-operations-chain.
610 rtc::scoped_refptr<rtc::OperationsChain> operations_chain_
611 RTC_GUARDED_BY(signaling_thread());
612
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000613 // One PeerConnection has only one RTCP CNAME.
614 // https://tools.ietf.org/html/draft-ietf-rtcweb-rtp-usage-26#section-4.9
615 const std::string rtcp_cname_;
616
617 // MIDs will be generated using this generator which will keep track of
618 // all the MIDs that have been seen over the life of the PeerConnection.
619 rtc::UniqueStringGenerator mid_generator_ RTC_GUARDED_BY(signaling_thread());
620
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000621 // List of content names for which the remote side triggered an ICE restart.
622 std::set<std::string> pending_ice_restarts_
623 RTC_GUARDED_BY(signaling_thread());
624
625 std::unique_ptr<LocalIceCredentialsToReplace>
626 local_ice_credentials_to_replace_ RTC_GUARDED_BY(signaling_thread());
627
628 bool remote_peer_supports_msid_ RTC_GUARDED_BY(signaling_thread()) = false;
629 bool is_negotiation_needed_ RTC_GUARDED_BY(signaling_thread()) = false;
630 uint32_t negotiation_needed_event_id_ = 0;
631 bool update_negotiation_needed_on_empty_chain_
632 RTC_GUARDED_BY(signaling_thread()) = false;
Henrik Boström4ea80f32021-06-09 10:29:50 +0200633 // If PT demuxing is successfully negotiated one time we will allow PT
634 // demuxing for the rest of the session so that PT-based apps default to PT
635 // demuxing in follow-up O/A exchanges.
636 bool pt_demuxing_has_been_used_audio_ = false;
637 bool pt_demuxing_has_been_used_video_ = false;
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000638
639 // In Unified Plan, if we encounter remote SDP that does not contain an a=msid
640 // line we create and use a stream with a random ID for our receivers. This is
641 // to support legacy endpoints that do not support the a=msid attribute (as
642 // opposed to streamless tracks with "a=msid:-").
643 rtc::scoped_refptr<MediaStreamInterface> missing_msid_default_stream_
644 RTC_GUARDED_BY(signaling_thread());
645
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000646 // Updates the error state, signaling if necessary.
647 void SetSessionError(SessionError error, const std::string& error_desc);
648
Tomas Gunnarsson2efb8a52021-04-01 16:26:57 +0200649 // Implements AddIceCandidate without reporting usage, but returns the
650 // particular success/error value that should be reported (and can be utilized
651 // for other purposes).
652 AddIceCandidateResult AddIceCandidateInternal(
653 const IceCandidateInterface* candidate);
654
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000655 SessionError session_error_ RTC_GUARDED_BY(signaling_thread()) =
656 SessionError::kNone;
657 std::string session_error_desc_ RTC_GUARDED_BY(signaling_thread());
658
Harald Alvestrand763f5a92020-10-22 10:39:40 +0000659 // Member variables for caching global options.
660 cricket::AudioOptions audio_options_ RTC_GUARDED_BY(signaling_thread());
661 cricket::VideoOptions video_options_ RTC_GUARDED_BY(signaling_thread());
662
663 // This object should be used to generate any SSRC that is not explicitly
664 // specified by the user (or by the remote party).
665 // The generator is not used directly, instead it is passed on to the
666 // channel manager and the session description factory.
Tomas Gunnarsson64099bc2021-04-09 09:51:37 +0200667 // TODO(bugs.webrtc.org/12666): This variable is used from both the signaling
668 // and worker threads. See if we can't restrict usage to a single thread.
669 rtc::UniqueRandomIdGenerator ssrc_generator_;
Harald Alvestrand763f5a92020-10-22 10:39:40 +0000670
671 // A video bitrate allocator factory.
672 // This can be injected using the PeerConnectionDependencies,
673 // or else the CreateBuiltinVideoBitrateAllocatorFactory() will be called.
674 // Note that one can still choose to override this in a MediaEngine
675 // if one wants too.
676 std::unique_ptr<webrtc::VideoBitrateAllocatorFactory>
677 video_bitrate_allocator_factory_;
678
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000679 rtc::WeakPtrFactory<SdpOfferAnswerHandler> weak_ptr_factory_
680 RTC_GUARDED_BY(signaling_thread());
681};
682
683} // namespace webrtc
684
685#endif // PC_SDP_OFFER_ANSWER_H_