blob: a42e9bacec2a023dc5138ca33057182ba0bc31b9 [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(
Harald Alvestrand5b661302022-01-28 13:08:34 +000097 PeerConnectionSdpMethods* pc,
Harald Alvestrand763f5a92020-10-22 10:39:40 +000098 const PeerConnectionInterface::RTCConfiguration& configuration,
Harald Alvestrand66c40362022-01-28 17:41:30 +000099 PeerConnectionDependencies& dependencies,
100 ConnectionContext* context);
Harald Alvestrand763f5a92020-10-22 10:39:40 +0000101
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000102 void ResetSessionDescFactory() {
103 RTC_DCHECK_RUN_ON(signaling_thread());
104 webrtc_session_desc_factory_.reset();
105 }
106 const WebRtcSessionDescriptionFactory* webrtc_session_desc_factory() const {
107 RTC_DCHECK_RUN_ON(signaling_thread());
108 return webrtc_session_desc_factory_.get();
109 }
110
111 // Change signaling state to Closed, and perform appropriate actions.
112 void Close();
113
114 // Called as part of destroying the owning PeerConnection.
115 void PrepareForShutdown();
116
Harald Alvestrandf01bd6c2020-10-23 13:30:46 +0000117 // Implementation of SdpStateProvider
118 PeerConnectionInterface::SignalingState signaling_state() const override;
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000119
Harald Alvestrandf01bd6c2020-10-23 13:30:46 +0000120 const SessionDescriptionInterface* local_description() const override;
121 const SessionDescriptionInterface* remote_description() const override;
122 const SessionDescriptionInterface* current_local_description() const override;
123 const SessionDescriptionInterface* current_remote_description()
124 const override;
125 const SessionDescriptionInterface* pending_local_description() const override;
126 const SessionDescriptionInterface* pending_remote_description()
127 const override;
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000128
Harald Alvestrandf01bd6c2020-10-23 13:30:46 +0000129 bool NeedsIceRestart(const std::string& content_name) const override;
130 bool IceRestartPending(const std::string& content_name) const override;
131 absl::optional<rtc::SSLRole> GetDtlsRole(
132 const std::string& mid) const override;
Harald Alvestrandd89ce532020-10-21 08:59:22 +0000133
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000134 void RestartIce();
135
136 // JSEP01
137 void CreateOffer(
138 CreateSessionDescriptionObserver* observer,
139 const PeerConnectionInterface::RTCOfferAnswerOptions& options);
140 void CreateAnswer(
141 CreateSessionDescriptionObserver* observer,
142 const PeerConnectionInterface::RTCOfferAnswerOptions& options);
143
144 void SetLocalDescription(
145 std::unique_ptr<SessionDescriptionInterface> desc,
146 rtc::scoped_refptr<SetLocalDescriptionObserverInterface> observer);
147 void SetLocalDescription(
148 rtc::scoped_refptr<SetLocalDescriptionObserverInterface> observer);
149 void SetLocalDescription(SetSessionDescriptionObserver* observer,
150 SessionDescriptionInterface* desc);
151 void SetLocalDescription(SetSessionDescriptionObserver* observer);
152
153 void SetRemoteDescription(
154 std::unique_ptr<SessionDescriptionInterface> desc,
155 rtc::scoped_refptr<SetRemoteDescriptionObserverInterface> observer);
156 void SetRemoteDescription(SetSessionDescriptionObserver* observer,
157 SessionDescriptionInterface* desc);
158
159 PeerConnectionInterface::RTCConfiguration GetConfiguration();
160 RTCError SetConfiguration(
161 const PeerConnectionInterface::RTCConfiguration& configuration);
162 bool AddIceCandidate(const IceCandidateInterface* candidate);
163 void AddIceCandidate(std::unique_ptr<IceCandidateInterface> candidate,
164 std::function<void(RTCError)> callback);
165 bool RemoveIceCandidates(const std::vector<cricket::Candidate>& candidates);
166 // Adds a locally generated candidate to the local description.
167 void AddLocalIceCandidate(const JsepIceCandidate* candidate);
168 void RemoveLocalIceCandidates(
169 const std::vector<cricket::Candidate>& candidates);
170 bool ShouldFireNegotiationNeededEvent(uint32_t event_id);
171
Harald Alvestrand6f04b652020-10-09 11:42:17 +0000172 bool AddStream(MediaStreamInterface* local_stream);
173 void RemoveStream(MediaStreamInterface* local_stream);
174
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000175 absl::optional<bool> is_caller();
176 bool HasNewIceCredentials();
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000177 void UpdateNegotiationNeeded();
178
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000179 // Destroys all BaseChannels and destroys the SCTP data channel, if present.
180 void DestroyAllChannels();
181
Harald Alvestrand6f04b652020-10-09 11:42:17 +0000182 rtc::scoped_refptr<StreamCollectionInterface> local_streams();
183 rtc::scoped_refptr<StreamCollectionInterface> remote_streams();
184
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000185 private:
Tomas Gunnarsson1c7c09b2022-01-12 13:11:04 +0100186 class RemoteDescriptionOperation;
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000187 class ImplicitCreateSessionDescriptionObserver;
Harald Alvestrand1f7eab62020-10-18 16:51:47 +0000188
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000189 friend class ImplicitCreateSessionDescriptionObserver;
190 class SetSessionDescriptionObserverAdapter;
Harald Alvestrand1f7eab62020-10-18 16:51:47 +0000191
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000192 friend class SetSessionDescriptionObserverAdapter;
193
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000194 enum class SessionError {
195 kNone, // No error.
196 kContent, // Error in BaseChannel SetLocalContent/SetRemoteContent.
197 kTransport, // Error from the underlying transport.
198 };
199
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000200 // Represents the [[LocalIceCredentialsToReplace]] internal slot in the spec.
201 // It makes the next CreateOffer() produce new ICE credentials even if
202 // RTCOfferAnswerOptions::ice_restart is false.
203 // https://w3c.github.io/webrtc-pc/#dfn-localufragstoreplace
204 // TODO(hbos): When JsepTransportController/JsepTransport supports rollback,
205 // move this type of logic to JsepTransportController/JsepTransport.
206 class LocalIceCredentialsToReplace;
207
Harald Alvestrand9cd199d2020-10-27 07:10:43 +0000208 // Only called by the Create() function.
Harald Alvestrand66c40362022-01-28 17:41:30 +0000209 explicit SdpOfferAnswerHandler(PeerConnectionSdpMethods* pc,
210 ConnectionContext* context);
Harald Alvestrand9cd199d2020-10-27 07:10:43 +0000211 // Called from the `Create()` function. Can only be called
212 // once. Modifies dependencies.
213 void Initialize(
214 const PeerConnectionInterface::RTCConfiguration& configuration,
215 PeerConnectionDependencies& dependencies);
216
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000217 rtc::Thread* signaling_thread() const;
218 // Non-const versions of local_description()/remote_description(), for use
219 // internally.
220 SessionDescriptionInterface* mutable_local_description()
221 RTC_RUN_ON(signaling_thread()) {
222 return pending_local_description_ ? pending_local_description_.get()
223 : current_local_description_.get();
224 }
225 SessionDescriptionInterface* mutable_remote_description()
226 RTC_RUN_ON(signaling_thread()) {
227 return pending_remote_description_ ? pending_remote_description_.get()
228 : current_remote_description_.get();
229 }
230
231 // Synchronous implementations of SetLocalDescription/SetRemoteDescription
232 // that return an RTCError instead of invoking a callback.
233 RTCError ApplyLocalDescription(
Henrik Boströmf8187e02021-04-26 21:04:26 +0200234 std::unique_ptr<SessionDescriptionInterface> desc,
235 const std::map<std::string, const cricket::ContentGroup*>&
236 bundle_groups_by_mid);
Tomas Gunnarsson0dd75392022-01-17 19:19:56 +0100237 void ApplyRemoteDescription(
238 std::unique_ptr<RemoteDescriptionOperation> operation);
239
240 RTCError ReplaceRemoteDescription(
Henrik Boströmf8187e02021-04-26 21:04:26 +0200241 std::unique_ptr<SessionDescriptionInterface> desc,
Tomas Gunnarsson0dd75392022-01-17 19:19:56 +0100242 SdpType sdp_type,
243 std::unique_ptr<SessionDescriptionInterface>* replaced_description)
244 RTC_RUN_ON(signaling_thread());
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000245
Tomas Gunnarsson651586c2022-01-07 18:33:12 +0000246 // Part of ApplyRemoteDescription steps specific to Unified Plan.
247 void ApplyRemoteDescriptionUpdateTransceiverState(SdpType sdp_type);
248
Tomas Gunnarssonb625edf2022-01-07 16:22:14 +0000249 // Part of ApplyRemoteDescription steps specific to plan b.
250 void PlanBUpdateSendersAndReceivers(
251 const cricket::ContentInfo* audio_content,
252 const cricket::AudioContentDescription* audio_desc,
253 const cricket::ContentInfo* video_content,
254 const cricket::VideoContentDescription* video_desc);
255
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000256 // Implementation of the offer/answer exchange operations. These are chained
Artem Titov880fa812021-07-30 22:30:23 +0200257 // onto the `operations_chain_` when the public CreateOffer(), CreateAnswer(),
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000258 // SetLocalDescription() and SetRemoteDescription() methods are invoked.
259 void DoCreateOffer(
260 const PeerConnectionInterface::RTCOfferAnswerOptions& options,
261 rtc::scoped_refptr<CreateSessionDescriptionObserver> observer);
262 void DoCreateAnswer(
263 const PeerConnectionInterface::RTCOfferAnswerOptions& options,
264 rtc::scoped_refptr<CreateSessionDescriptionObserver> observer);
265 void DoSetLocalDescription(
266 std::unique_ptr<SessionDescriptionInterface> desc,
267 rtc::scoped_refptr<SetLocalDescriptionObserverInterface> observer);
268 void DoSetRemoteDescription(
Tomas Gunnarsson1c7c09b2022-01-12 13:11:04 +0100269 std::unique_ptr<RemoteDescriptionOperation> operation);
270
271 // Called after a DoSetRemoteDescription operation completes.
272 void SetRemoteDescriptionPostProcess(bool was_answer)
273 RTC_RUN_ON(signaling_thread());
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000274
275 // Update the state, signaling if necessary.
276 void ChangeSignalingState(
277 PeerConnectionInterface::SignalingState signaling_state);
278
Henrik Boströmf8187e02021-04-26 21:04:26 +0200279 RTCError UpdateSessionState(
280 SdpType type,
281 cricket::ContentSource source,
282 const cricket::SessionDescription* description,
283 const std::map<std::string, const cricket::ContentGroup*>&
284 bundle_groups_by_mid);
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000285
286 bool IsUnifiedPlan() const RTC_RUN_ON(signaling_thread());
287
Harald Alvestrand763f5a92020-10-22 10:39:40 +0000288 // Signals from MediaStreamObserver.
289 void OnAudioTrackAdded(AudioTrackInterface* track,
290 MediaStreamInterface* stream)
291 RTC_RUN_ON(signaling_thread());
292 void OnAudioTrackRemoved(AudioTrackInterface* track,
293 MediaStreamInterface* stream)
294 RTC_RUN_ON(signaling_thread());
295 void OnVideoTrackAdded(VideoTrackInterface* track,
296 MediaStreamInterface* stream)
297 RTC_RUN_ON(signaling_thread());
298 void OnVideoTrackRemoved(VideoTrackInterface* track,
299 MediaStreamInterface* stream)
300 RTC_RUN_ON(signaling_thread());
301
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000302 // | desc_type | is the type of the description that caused the rollback.
303 RTCError Rollback(SdpType desc_type);
304 void OnOperationsChainEmpty();
305
306 // Runs the algorithm **set the associated remote streams** specified in
307 // https://w3c.github.io/webrtc-pc/#set-associated-remote-streams.
308 void SetAssociatedRemoteStreams(
309 rtc::scoped_refptr<RtpReceiverInternal> receiver,
310 const std::vector<std::string>& stream_ids,
311 std::vector<rtc::scoped_refptr<MediaStreamInterface>>* added_streams,
312 std::vector<rtc::scoped_refptr<MediaStreamInterface>>* removed_streams);
313
314 bool CheckIfNegotiationIsNeeded();
315 void GenerateNegotiationNeededEvent();
316 // Helper method which verifies SDP.
Henrik Boströmf8187e02021-04-26 21:04:26 +0200317 RTCError ValidateSessionDescription(
318 const SessionDescriptionInterface* sdesc,
319 cricket::ContentSource source,
320 const std::map<std::string, const cricket::ContentGroup*>&
321 bundle_groups_by_mid) RTC_RUN_ON(signaling_thread());
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000322
323 // Updates the local RtpTransceivers according to the JSEP rules. Called as
324 // part of setting the local/remote description.
325 RTCError UpdateTransceiversAndDataChannels(
326 cricket::ContentSource source,
327 const SessionDescriptionInterface& new_session,
328 const SessionDescriptionInterface* old_local_description,
Henrik Boströmf8187e02021-04-26 21:04:26 +0200329 const SessionDescriptionInterface* old_remote_description,
330 const std::map<std::string, const cricket::ContentGroup*>&
331 bundle_groups_by_mid);
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000332
333 // Associate the given transceiver according to the JSEP rules.
334 RTCErrorOr<
335 rtc::scoped_refptr<RtpTransceiverProxyWithInternal<RtpTransceiver>>>
336 AssociateTransceiver(cricket::ContentSource source,
337 SdpType type,
338 size_t mline_index,
339 const cricket::ContentInfo& content,
340 const cricket::ContentInfo* old_local_content,
341 const cricket::ContentInfo* old_remote_content)
342 RTC_RUN_ON(signaling_thread());
343
Harald Alvestrand85466662021-04-19 21:21:36 +0000344 // Returns the media section in the given session description that is
345 // associated with the RtpTransceiver. Returns null if none found or this
346 // RtpTransceiver is not associated. Logic varies depending on the
347 // SdpSemantics specified in the configuration.
348 const cricket::ContentInfo* FindMediaSectionForTransceiver(
349 const RtpTransceiver* transceiver,
350 const SessionDescriptionInterface* sdesc) const;
351
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000352 // Either creates or destroys the transceiver's BaseChannel according to the
353 // given media section.
354 RTCError UpdateTransceiverChannel(
355 rtc::scoped_refptr<RtpTransceiverProxyWithInternal<RtpTransceiver>>
356 transceiver,
357 const cricket::ContentInfo& content,
358 const cricket::ContentGroup* bundle_group) RTC_RUN_ON(signaling_thread());
359
360 // Either creates or destroys the local data channel according to the given
361 // media section.
362 RTCError UpdateDataChannel(cricket::ContentSource source,
363 const cricket::ContentInfo& content,
364 const cricket::ContentGroup* bundle_group)
365 RTC_RUN_ON(signaling_thread());
Harald Alvestrandc06e3742020-10-01 10:23:33 +0000366 // Check if a call to SetLocalDescription is acceptable with a session
367 // description of the given type.
368 bool ExpectSetLocalDescription(SdpType type);
369 // Check if a call to SetRemoteDescription is acceptable with a session
370 // description of the given type.
371 bool ExpectSetRemoteDescription(SdpType type);
372
373 // The offer/answer machinery assumes the media section MID is present and
374 // unique. To support legacy end points that do not supply a=mid lines, this
375 // method will modify the session description to add MIDs generated according
376 // to the SDP semantics.
377 void FillInMissingRemoteMids(cricket::SessionDescription* remote_description);
378
379 // Returns an RtpTransciever, if available, that can be used to receive the
380 // given media type according to JSEP rules.
381 rtc::scoped_refptr<RtpTransceiverProxyWithInternal<RtpTransceiver>>
382 FindAvailableTransceiverToReceive(cricket::MediaType media_type) const;
383
Artem Titov880fa812021-07-30 22:30:23 +0200384 // Returns a MediaSessionOptions struct with options decided by `options`,
Harald Alvestrandc06e3742020-10-01 10:23:33 +0000385 // the local MediaStreams and DataChannels.
386 void GetOptionsForOffer(const PeerConnectionInterface::RTCOfferAnswerOptions&
387 offer_answer_options,
388 cricket::MediaSessionOptions* session_options);
389 void GetOptionsForPlanBOffer(
390 const PeerConnectionInterface::RTCOfferAnswerOptions&
391 offer_answer_options,
392 cricket::MediaSessionOptions* session_options)
393 RTC_RUN_ON(signaling_thread());
394 void GetOptionsForUnifiedPlanOffer(
395 const PeerConnectionInterface::RTCOfferAnswerOptions&
396 offer_answer_options,
397 cricket::MediaSessionOptions* session_options)
398 RTC_RUN_ON(signaling_thread());
399
400 // Returns a MediaSessionOptions struct with options decided by
Artem Titov880fa812021-07-30 22:30:23 +0200401 // `constraints`, the local MediaStreams and DataChannels.
Harald Alvestrandc06e3742020-10-01 10:23:33 +0000402 void GetOptionsForAnswer(const PeerConnectionInterface::RTCOfferAnswerOptions&
403 offer_answer_options,
404 cricket::MediaSessionOptions* session_options);
405 void GetOptionsForPlanBAnswer(
406 const PeerConnectionInterface::RTCOfferAnswerOptions&
407 offer_answer_options,
408 cricket::MediaSessionOptions* session_options)
409 RTC_RUN_ON(signaling_thread());
410 void GetOptionsForUnifiedPlanAnswer(
411 const PeerConnectionInterface::RTCOfferAnswerOptions&
412 offer_answer_options,
413 cricket::MediaSessionOptions* session_options)
414 RTC_RUN_ON(signaling_thread());
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000415
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000416 const char* SessionErrorToString(SessionError error) const;
417 std::string GetSessionErrorMsg();
418 // Returns the last error in the session. See the enum above for details.
419 SessionError session_error() const {
420 RTC_DCHECK_RUN_ON(signaling_thread());
421 return session_error_;
422 }
423 const std::string& session_error_desc() const { return session_error_desc_; }
424
425 RTCError HandleLegacyOfferOptions(
426 const PeerConnectionInterface::RTCOfferAnswerOptions& options);
427 void RemoveRecvDirectionFromReceivingTransceiversOfType(
428 cricket::MediaType media_type) RTC_RUN_ON(signaling_thread());
429 void AddUpToOneReceivingTransceiverOfType(cricket::MediaType media_type);
430
431 std::vector<
432 rtc::scoped_refptr<RtpTransceiverProxyWithInternal<RtpTransceiver>>>
433 GetReceivingTransceiversOfType(cricket::MediaType media_type)
434 RTC_RUN_ON(signaling_thread());
435
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000436 // Runs the algorithm specified in
437 // https://w3c.github.io/webrtc-pc/#process-remote-track-removal
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000438 // This method will update the following lists:
Artem Titov880fa812021-07-30 22:30:23 +0200439 // `remove_list` is the list of transceivers for which the receiving track is
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000440 // being removed.
Artem Titov880fa812021-07-30 22:30:23 +0200441 // `removed_streams` is the list of streams which no longer have a receiving
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000442 // track so should be removed.
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000443 void ProcessRemovalOfRemoteTrack(
Harald Alvestrand85466662021-04-19 21:21:36 +0000444 const rtc::scoped_refptr<RtpTransceiverProxyWithInternal<RtpTransceiver>>
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000445 transceiver,
446 std::vector<rtc::scoped_refptr<RtpTransceiverInterface>>* remove_list,
447 std::vector<rtc::scoped_refptr<MediaStreamInterface>>* removed_streams);
448
449 void RemoveRemoteStreamsIfEmpty(
450 const std::vector<rtc::scoped_refptr<MediaStreamInterface>>&
451 remote_streams,
452 std::vector<rtc::scoped_refptr<MediaStreamInterface>>* removed_streams);
453
Artem Titov880fa812021-07-30 22:30:23 +0200454 // Remove all local and remote senders of type `media_type`.
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000455 // Called when a media type is rejected (m-line set to port 0).
456 void RemoveSenders(cricket::MediaType media_type);
457
Artem Titov880fa812021-07-30 22:30:23 +0200458 // Loops through the vector of `streams` and finds added and removed
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000459 // StreamParams since last time this method was called.
460 // For each new or removed StreamParam, OnLocalSenderSeen or
461 // OnLocalSenderRemoved is invoked.
462 void UpdateLocalSenders(const std::vector<cricket::StreamParams>& streams,
463 cricket::MediaType media_type);
464
Artem Titov880fa812021-07-30 22:30:23 +0200465 // Makes sure a MediaStreamTrack is created for each StreamParam in `streams`,
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000466 // and existing MediaStreamTracks are removed if there is no corresponding
Artem Titov880fa812021-07-30 22:30:23 +0200467 // StreamParam. If `default_track_needed` is true, a default MediaStreamTrack
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000468 // is created if it doesn't exist; if false, it's removed if it exists.
Artem Titov880fa812021-07-30 22:30:23 +0200469 // `media_type` is the type of the `streams` and can be either audio or video.
470 // If a new MediaStream is created it is added to `new_streams`.
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000471 void UpdateRemoteSendersList(
472 const std::vector<cricket::StreamParams>& streams,
473 bool default_track_needed,
474 cricket::MediaType media_type,
475 StreamCollection* new_streams);
476
Taylor Brandstetterd0acbd82021-01-25 13:44:55 -0800477 // Enables media channels to allow sending of media.
Harald Alvestrand48171ec2021-04-20 15:06:03 +0000478 // This enables media to flow on all configured audio/video channels.
Taylor Brandstetterd0acbd82021-01-25 13:44:55 -0800479 void EnableSending();
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000480 // Push the media parts of the local or remote session description
Taylor Brandstetterd0acbd82021-01-25 13:44:55 -0800481 // down to all of the channels.
Henrik Boströmf8187e02021-04-26 21:04:26 +0200482 RTCError PushdownMediaDescription(
483 SdpType type,
484 cricket::ContentSource source,
485 const std::map<std::string, const cricket::ContentGroup*>&
486 bundle_groups_by_mid);
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000487
488 RTCError PushdownTransportDescription(cricket::ContentSource source,
489 SdpType type);
490 // Helper function to remove stopped transceivers.
491 void RemoveStoppedTransceivers();
Artem Titov880fa812021-07-30 22:30:23 +0200492 // Deletes the corresponding channel of contents that don't exist in `desc`.
493 // `desc` can be null. This means that all channels are deleted.
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000494 void RemoveUnusedChannels(const cricket::SessionDescription* desc);
495
496 // Report inferred negotiated SDP semantics from a local/remote answer to the
497 // UMA observer.
498 void ReportNegotiatedSdpSemantics(const SessionDescriptionInterface& answer);
499
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000500 // Finds remote MediaStreams without any tracks and removes them from
Artem Titov880fa812021-07-30 22:30:23 +0200501 // `remote_streams_` and notifies the observer that the MediaStreams no longer
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000502 // exist.
503 void UpdateEndedRemoteMediaStreams();
504
Tomas Gunnarsson0dd75392022-01-17 19:19:56 +0100505 // Uses all remote candidates in the currently set remote_description().
506 // If no remote description is currently set (nullptr), the return value will
507 // be true. If `UseCandidate()` fails for any candidate in the remote
508 // description, the return value will be false.
509 bool UseCandidatesInRemoteDescription();
Artem Titov880fa812021-07-30 22:30:23 +0200510 // Uses `candidate` in this session.
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000511 bool UseCandidate(const IceCandidateInterface* candidate);
512 // Returns true if we are ready to push down the remote candidate.
Artem Titov880fa812021-07-30 22:30:23 +0200513 // `remote_desc` is the new remote description, or NULL if the current remote
514 // description should be used. Output `valid` is true if the candidate media
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000515 // index is valid.
516 bool ReadyToUseRemoteCandidate(const IceCandidateInterface* candidate,
517 const SessionDescriptionInterface* remote_desc,
518 bool* valid);
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000519
520 RTCErrorOr<const cricket::ContentInfo*> FindContentInfo(
521 const SessionDescriptionInterface* description,
522 const IceCandidateInterface* candidate) RTC_RUN_ON(signaling_thread());
523
524 // Functions for dealing with transports.
525 // Note that cricket code uses the term "channel" for what other code
526 // refers to as "transport".
527
Artem Titov880fa812021-07-30 22:30:23 +0200528 // Allocates media channels based on the `desc`. If `desc` doesn't have
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000529 // the BUNDLE option, this method will disable BUNDLE in PortAllocator.
530 // This method will also delete any existing media channels before creating.
531 RTCError CreateChannels(const cricket::SessionDescription& desc);
532
533 // Helper methods to create media channels.
534 cricket::VoiceChannel* CreateVoiceChannel(const std::string& mid);
535 cricket::VideoChannel* CreateVideoChannel(const std::string& mid);
536 bool CreateDataChannel(const std::string& mid);
537
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000538 // Destroys the RTP data channel transport and/or the SCTP data channel
539 // transport and clears it.
Florent Castellidcb9ffc2021-06-29 14:58:23 +0200540 void DestroyDataChannelTransport(RTCError error);
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000541
Artem Titov880fa812021-07-30 22:30:23 +0200542 // Generates MediaDescriptionOptions for the `session_opts` based on existing
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000543 // local description or remote description.
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000544 void GenerateMediaDescriptionOptions(
545 const SessionDescriptionInterface* session_desc,
546 RtpTransceiverDirection audio_direction,
547 RtpTransceiverDirection video_direction,
548 absl::optional<size_t>* audio_index,
549 absl::optional<size_t>* video_index,
550 absl::optional<size_t>* data_index,
551 cricket::MediaSessionOptions* session_options);
552
553 // Generates the active MediaDescriptionOptions for the local data channel
554 // given the specified MID.
555 cricket::MediaDescriptionOptions GetMediaDescriptionOptionsForActiveData(
556 const std::string& mid) const;
557
558 // Generates the rejected MediaDescriptionOptions for the local data channel
559 // given the specified MID.
560 cricket::MediaDescriptionOptions GetMediaDescriptionOptionsForRejectedData(
561 const std::string& mid) const;
562
Taylor Brandstetterd0acbd82021-01-25 13:44:55 -0800563 // Based on number of transceivers per media type, enabled or disable
564 // payload type based demuxing in the affected channels.
Henrik Boströmf8187e02021-04-26 21:04:26 +0200565 bool UpdatePayloadTypeDemuxingState(
566 cricket::ContentSource source,
567 const std::map<std::string, const cricket::ContentGroup*>&
568 bundle_groups_by_mid);
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000569
Harald Alvestrand42b983a2021-10-19 21:50:01 +0000570 // Updates the error state, signaling if necessary.
571 void SetSessionError(SessionError error, const std::string& error_desc);
572
573 // Implements AddIceCandidate without reporting usage, but returns the
574 // particular success/error value that should be reported (and can be utilized
575 // for other purposes).
576 AddIceCandidateResult AddIceCandidateInternal(
577 const IceCandidateInterface* candidate);
578
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000579 // ==================================================================
580 // Access to pc_ variables
581 cricket::ChannelManager* channel_manager() const;
Harald Alvestrande15fb152020-10-19 13:28:05 +0000582 TransceiverList* transceivers();
583 const TransceiverList* transceivers() const;
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000584 DataChannelController* data_channel_controller();
585 const DataChannelController* data_channel_controller() const;
586 cricket::PortAllocator* port_allocator();
587 const cricket::PortAllocator* port_allocator() const;
Harald Alvestrande15fb152020-10-19 13:28:05 +0000588 RtpTransmissionManager* rtp_manager();
589 const RtpTransmissionManager* rtp_manager() const;
Harald Alvestrandf01bd6c2020-10-23 13:30:46 +0000590 JsepTransportController* transport_controller();
591 const JsepTransportController* transport_controller() const;
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000592 // ===================================================================
Harald Alvestrand763f5a92020-10-22 10:39:40 +0000593 const cricket::AudioOptions& audio_options() { return audio_options_; }
594 const cricket::VideoOptions& video_options() { return video_options_; }
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000595
Harald Alvestrand5b661302022-01-28 13:08:34 +0000596 PeerConnectionSdpMethods* const pc_;
Harald Alvestrand66c40362022-01-28 17:41:30 +0000597 ConnectionContext* const context_;
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000598
599 std::unique_ptr<WebRtcSessionDescriptionFactory> webrtc_session_desc_factory_
600 RTC_GUARDED_BY(signaling_thread());
601
602 std::unique_ptr<SessionDescriptionInterface> current_local_description_
603 RTC_GUARDED_BY(signaling_thread());
604 std::unique_ptr<SessionDescriptionInterface> pending_local_description_
605 RTC_GUARDED_BY(signaling_thread());
606 std::unique_ptr<SessionDescriptionInterface> current_remote_description_
607 RTC_GUARDED_BY(signaling_thread());
608 std::unique_ptr<SessionDescriptionInterface> pending_remote_description_
609 RTC_GUARDED_BY(signaling_thread());
610
611 PeerConnectionInterface::SignalingState signaling_state_
612 RTC_GUARDED_BY(signaling_thread()) = PeerConnectionInterface::kStable;
613
614 // Whether this peer is the caller. Set when the local description is applied.
615 absl::optional<bool> is_caller_ RTC_GUARDED_BY(signaling_thread());
616
Harald Alvestrand6f04b652020-10-09 11:42:17 +0000617 // Streams added via AddStream.
618 const rtc::scoped_refptr<StreamCollection> local_streams_
619 RTC_GUARDED_BY(signaling_thread());
620 // Streams created as a result of SetRemoteDescription.
621 const rtc::scoped_refptr<StreamCollection> remote_streams_
622 RTC_GUARDED_BY(signaling_thread());
623
624 std::vector<std::unique_ptr<MediaStreamObserver>> stream_observers_
625 RTC_GUARDED_BY(signaling_thread());
626
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000627 // The operations chain is used by the offer/answer exchange methods to ensure
628 // they are executed in the right order. For example, if
629 // SetRemoteDescription() is invoked while CreateOffer() is still pending, the
630 // SRD operation will not start until CreateOffer() has completed. See
631 // https://w3c.github.io/webrtc-pc/#dfn-operations-chain.
632 rtc::scoped_refptr<rtc::OperationsChain> operations_chain_
633 RTC_GUARDED_BY(signaling_thread());
634
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000635 // One PeerConnection has only one RTCP CNAME.
636 // https://tools.ietf.org/html/draft-ietf-rtcweb-rtp-usage-26#section-4.9
637 const std::string rtcp_cname_;
638
639 // MIDs will be generated using this generator which will keep track of
640 // all the MIDs that have been seen over the life of the PeerConnection.
641 rtc::UniqueStringGenerator mid_generator_ RTC_GUARDED_BY(signaling_thread());
642
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000643 // List of content names for which the remote side triggered an ICE restart.
644 std::set<std::string> pending_ice_restarts_
645 RTC_GUARDED_BY(signaling_thread());
646
647 std::unique_ptr<LocalIceCredentialsToReplace>
648 local_ice_credentials_to_replace_ RTC_GUARDED_BY(signaling_thread());
649
650 bool remote_peer_supports_msid_ RTC_GUARDED_BY(signaling_thread()) = false;
651 bool is_negotiation_needed_ RTC_GUARDED_BY(signaling_thread()) = false;
Harald Alvestrand42b983a2021-10-19 21:50:01 +0000652 uint32_t negotiation_needed_event_id_ RTC_GUARDED_BY(signaling_thread()) = 0;
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000653 bool update_negotiation_needed_on_empty_chain_
654 RTC_GUARDED_BY(signaling_thread()) = false;
Henrik Boström4ea80f32021-06-09 10:29:50 +0200655 // If PT demuxing is successfully negotiated one time we will allow PT
656 // demuxing for the rest of the session so that PT-based apps default to PT
657 // demuxing in follow-up O/A exchanges.
Harald Alvestrand42b983a2021-10-19 21:50:01 +0000658 bool pt_demuxing_has_been_used_audio_ RTC_GUARDED_BY(signaling_thread()) =
659 false;
660 bool pt_demuxing_has_been_used_video_ RTC_GUARDED_BY(signaling_thread()) =
661 false;
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000662
663 // In Unified Plan, if we encounter remote SDP that does not contain an a=msid
664 // line we create and use a stream with a random ID for our receivers. This is
665 // to support legacy endpoints that do not support the a=msid attribute (as
666 // opposed to streamless tracks with "a=msid:-").
667 rtc::scoped_refptr<MediaStreamInterface> missing_msid_default_stream_
668 RTC_GUARDED_BY(signaling_thread());
669
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000670 SessionError session_error_ RTC_GUARDED_BY(signaling_thread()) =
671 SessionError::kNone;
672 std::string session_error_desc_ RTC_GUARDED_BY(signaling_thread());
673
Harald Alvestrand763f5a92020-10-22 10:39:40 +0000674 // Member variables for caching global options.
675 cricket::AudioOptions audio_options_ RTC_GUARDED_BY(signaling_thread());
676 cricket::VideoOptions video_options_ RTC_GUARDED_BY(signaling_thread());
677
Harald Alvestrand763f5a92020-10-22 10:39:40 +0000678 // A video bitrate allocator factory.
679 // This can be injected using the PeerConnectionDependencies,
680 // or else the CreateBuiltinVideoBitrateAllocatorFactory() will be called.
681 // Note that one can still choose to override this in a MediaEngine
682 // if one wants too.
683 std::unique_ptr<webrtc::VideoBitrateAllocatorFactory>
Harald Alvestrand42b983a2021-10-19 21:50:01 +0000684 video_bitrate_allocator_factory_ RTC_GUARDED_BY(signaling_thread());
Harald Alvestrand763f5a92020-10-22 10:39:40 +0000685
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000686 rtc::WeakPtrFactory<SdpOfferAnswerHandler> weak_ptr_factory_
687 RTC_GUARDED_BY(signaling_thread());
688};
689
690} // namespace webrtc
691
692#endif // PC_SDP_OFFER_ANSWER_H_