blob: 99af95bebb7709896d71736ea5817da177578b50 [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
Tomas Gunnarsson651586c2022-01-07 18:33:12 +0000239 // Part of ApplyRemoteDescription steps specific to Unified Plan.
240 void ApplyRemoteDescriptionUpdateTransceiverState(SdpType sdp_type);
241
Tomas Gunnarssonb625edf2022-01-07 16:22:14 +0000242 // Part of ApplyRemoteDescription steps specific to plan b.
243 void PlanBUpdateSendersAndReceivers(
244 const cricket::ContentInfo* audio_content,
245 const cricket::AudioContentDescription* audio_desc,
246 const cricket::ContentInfo* video_content,
247 const cricket::VideoContentDescription* video_desc);
248
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000249 // Implementation of the offer/answer exchange operations. These are chained
Artem Titov880fa812021-07-30 22:30:23 +0200250 // onto the `operations_chain_` when the public CreateOffer(), CreateAnswer(),
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000251 // SetLocalDescription() and SetRemoteDescription() methods are invoked.
252 void DoCreateOffer(
253 const PeerConnectionInterface::RTCOfferAnswerOptions& options,
254 rtc::scoped_refptr<CreateSessionDescriptionObserver> observer);
255 void DoCreateAnswer(
256 const PeerConnectionInterface::RTCOfferAnswerOptions& options,
257 rtc::scoped_refptr<CreateSessionDescriptionObserver> observer);
258 void DoSetLocalDescription(
259 std::unique_ptr<SessionDescriptionInterface> desc,
260 rtc::scoped_refptr<SetLocalDescriptionObserverInterface> observer);
261 void DoSetRemoteDescription(
262 std::unique_ptr<SessionDescriptionInterface> desc,
263 rtc::scoped_refptr<SetRemoteDescriptionObserverInterface> observer);
264
265 // Update the state, signaling if necessary.
266 void ChangeSignalingState(
267 PeerConnectionInterface::SignalingState signaling_state);
268
Henrik Boströmf8187e02021-04-26 21:04:26 +0200269 RTCError UpdateSessionState(
270 SdpType type,
271 cricket::ContentSource source,
272 const cricket::SessionDescription* description,
273 const std::map<std::string, const cricket::ContentGroup*>&
274 bundle_groups_by_mid);
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000275
276 bool IsUnifiedPlan() const RTC_RUN_ON(signaling_thread());
277
Harald Alvestrand763f5a92020-10-22 10:39:40 +0000278 // Signals from MediaStreamObserver.
279 void OnAudioTrackAdded(AudioTrackInterface* track,
280 MediaStreamInterface* stream)
281 RTC_RUN_ON(signaling_thread());
282 void OnAudioTrackRemoved(AudioTrackInterface* track,
283 MediaStreamInterface* stream)
284 RTC_RUN_ON(signaling_thread());
285 void OnVideoTrackAdded(VideoTrackInterface* track,
286 MediaStreamInterface* stream)
287 RTC_RUN_ON(signaling_thread());
288 void OnVideoTrackRemoved(VideoTrackInterface* track,
289 MediaStreamInterface* stream)
290 RTC_RUN_ON(signaling_thread());
291
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000292 // | desc_type | is the type of the description that caused the rollback.
293 RTCError Rollback(SdpType desc_type);
294 void OnOperationsChainEmpty();
295
296 // Runs the algorithm **set the associated remote streams** specified in
297 // https://w3c.github.io/webrtc-pc/#set-associated-remote-streams.
298 void SetAssociatedRemoteStreams(
299 rtc::scoped_refptr<RtpReceiverInternal> receiver,
300 const std::vector<std::string>& stream_ids,
301 std::vector<rtc::scoped_refptr<MediaStreamInterface>>* added_streams,
302 std::vector<rtc::scoped_refptr<MediaStreamInterface>>* removed_streams);
303
304 bool CheckIfNegotiationIsNeeded();
305 void GenerateNegotiationNeededEvent();
306 // Helper method which verifies SDP.
Henrik Boströmf8187e02021-04-26 21:04:26 +0200307 RTCError ValidateSessionDescription(
308 const SessionDescriptionInterface* sdesc,
309 cricket::ContentSource source,
310 const std::map<std::string, const cricket::ContentGroup*>&
311 bundle_groups_by_mid) RTC_RUN_ON(signaling_thread());
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000312
313 // Updates the local RtpTransceivers according to the JSEP rules. Called as
314 // part of setting the local/remote description.
315 RTCError UpdateTransceiversAndDataChannels(
316 cricket::ContentSource source,
317 const SessionDescriptionInterface& new_session,
318 const SessionDescriptionInterface* old_local_description,
Henrik Boströmf8187e02021-04-26 21:04:26 +0200319 const SessionDescriptionInterface* old_remote_description,
320 const std::map<std::string, const cricket::ContentGroup*>&
321 bundle_groups_by_mid);
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000322
323 // Associate the given transceiver according to the JSEP rules.
324 RTCErrorOr<
325 rtc::scoped_refptr<RtpTransceiverProxyWithInternal<RtpTransceiver>>>
326 AssociateTransceiver(cricket::ContentSource source,
327 SdpType type,
328 size_t mline_index,
329 const cricket::ContentInfo& content,
330 const cricket::ContentInfo* old_local_content,
331 const cricket::ContentInfo* old_remote_content)
332 RTC_RUN_ON(signaling_thread());
333
Harald Alvestrand85466662021-04-19 21:21:36 +0000334 // Returns the media section in the given session description that is
335 // associated with the RtpTransceiver. Returns null if none found or this
336 // RtpTransceiver is not associated. Logic varies depending on the
337 // SdpSemantics specified in the configuration.
338 const cricket::ContentInfo* FindMediaSectionForTransceiver(
339 const RtpTransceiver* transceiver,
340 const SessionDescriptionInterface* sdesc) const;
341
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000342 // Either creates or destroys the transceiver's BaseChannel according to the
343 // given media section.
344 RTCError UpdateTransceiverChannel(
345 rtc::scoped_refptr<RtpTransceiverProxyWithInternal<RtpTransceiver>>
346 transceiver,
347 const cricket::ContentInfo& content,
348 const cricket::ContentGroup* bundle_group) RTC_RUN_ON(signaling_thread());
349
350 // Either creates or destroys the local data channel according to the given
351 // media section.
352 RTCError UpdateDataChannel(cricket::ContentSource source,
353 const cricket::ContentInfo& content,
354 const cricket::ContentGroup* bundle_group)
355 RTC_RUN_ON(signaling_thread());
Harald Alvestrandc06e3742020-10-01 10:23:33 +0000356 // Check if a call to SetLocalDescription is acceptable with a session
357 // description of the given type.
358 bool ExpectSetLocalDescription(SdpType type);
359 // Check if a call to SetRemoteDescription is acceptable with a session
360 // description of the given type.
361 bool ExpectSetRemoteDescription(SdpType type);
362
363 // The offer/answer machinery assumes the media section MID is present and
364 // unique. To support legacy end points that do not supply a=mid lines, this
365 // method will modify the session description to add MIDs generated according
366 // to the SDP semantics.
367 void FillInMissingRemoteMids(cricket::SessionDescription* remote_description);
368
369 // Returns an RtpTransciever, if available, that can be used to receive the
370 // given media type according to JSEP rules.
371 rtc::scoped_refptr<RtpTransceiverProxyWithInternal<RtpTransceiver>>
372 FindAvailableTransceiverToReceive(cricket::MediaType media_type) const;
373
Artem Titov880fa812021-07-30 22:30:23 +0200374 // Returns a MediaSessionOptions struct with options decided by `options`,
Harald Alvestrandc06e3742020-10-01 10:23:33 +0000375 // the local MediaStreams and DataChannels.
376 void GetOptionsForOffer(const PeerConnectionInterface::RTCOfferAnswerOptions&
377 offer_answer_options,
378 cricket::MediaSessionOptions* session_options);
379 void GetOptionsForPlanBOffer(
380 const PeerConnectionInterface::RTCOfferAnswerOptions&
381 offer_answer_options,
382 cricket::MediaSessionOptions* session_options)
383 RTC_RUN_ON(signaling_thread());
384 void GetOptionsForUnifiedPlanOffer(
385 const PeerConnectionInterface::RTCOfferAnswerOptions&
386 offer_answer_options,
387 cricket::MediaSessionOptions* session_options)
388 RTC_RUN_ON(signaling_thread());
389
390 // Returns a MediaSessionOptions struct with options decided by
Artem Titov880fa812021-07-30 22:30:23 +0200391 // `constraints`, the local MediaStreams and DataChannels.
Harald Alvestrandc06e3742020-10-01 10:23:33 +0000392 void GetOptionsForAnswer(const PeerConnectionInterface::RTCOfferAnswerOptions&
393 offer_answer_options,
394 cricket::MediaSessionOptions* session_options);
395 void GetOptionsForPlanBAnswer(
396 const PeerConnectionInterface::RTCOfferAnswerOptions&
397 offer_answer_options,
398 cricket::MediaSessionOptions* session_options)
399 RTC_RUN_ON(signaling_thread());
400 void GetOptionsForUnifiedPlanAnswer(
401 const PeerConnectionInterface::RTCOfferAnswerOptions&
402 offer_answer_options,
403 cricket::MediaSessionOptions* session_options)
404 RTC_RUN_ON(signaling_thread());
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000405
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000406 const char* SessionErrorToString(SessionError error) const;
407 std::string GetSessionErrorMsg();
408 // Returns the last error in the session. See the enum above for details.
409 SessionError session_error() const {
410 RTC_DCHECK_RUN_ON(signaling_thread());
411 return session_error_;
412 }
413 const std::string& session_error_desc() const { return session_error_desc_; }
414
415 RTCError HandleLegacyOfferOptions(
416 const PeerConnectionInterface::RTCOfferAnswerOptions& options);
417 void RemoveRecvDirectionFromReceivingTransceiversOfType(
418 cricket::MediaType media_type) RTC_RUN_ON(signaling_thread());
419 void AddUpToOneReceivingTransceiverOfType(cricket::MediaType media_type);
420
421 std::vector<
422 rtc::scoped_refptr<RtpTransceiverProxyWithInternal<RtpTransceiver>>>
423 GetReceivingTransceiversOfType(cricket::MediaType media_type)
424 RTC_RUN_ON(signaling_thread());
425
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000426 // Runs the algorithm specified in
427 // https://w3c.github.io/webrtc-pc/#process-remote-track-removal
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000428 // This method will update the following lists:
Artem Titov880fa812021-07-30 22:30:23 +0200429 // `remove_list` is the list of transceivers for which the receiving track is
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000430 // being removed.
Artem Titov880fa812021-07-30 22:30:23 +0200431 // `removed_streams` is the list of streams which no longer have a receiving
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000432 // track so should be removed.
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000433 void ProcessRemovalOfRemoteTrack(
Harald Alvestrand85466662021-04-19 21:21:36 +0000434 const rtc::scoped_refptr<RtpTransceiverProxyWithInternal<RtpTransceiver>>
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000435 transceiver,
436 std::vector<rtc::scoped_refptr<RtpTransceiverInterface>>* remove_list,
437 std::vector<rtc::scoped_refptr<MediaStreamInterface>>* removed_streams);
438
439 void RemoveRemoteStreamsIfEmpty(
440 const std::vector<rtc::scoped_refptr<MediaStreamInterface>>&
441 remote_streams,
442 std::vector<rtc::scoped_refptr<MediaStreamInterface>>* removed_streams);
443
Artem Titov880fa812021-07-30 22:30:23 +0200444 // Remove all local and remote senders of type `media_type`.
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000445 // Called when a media type is rejected (m-line set to port 0).
446 void RemoveSenders(cricket::MediaType media_type);
447
Artem Titov880fa812021-07-30 22:30:23 +0200448 // Loops through the vector of `streams` and finds added and removed
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000449 // StreamParams since last time this method was called.
450 // For each new or removed StreamParam, OnLocalSenderSeen or
451 // OnLocalSenderRemoved is invoked.
452 void UpdateLocalSenders(const std::vector<cricket::StreamParams>& streams,
453 cricket::MediaType media_type);
454
Artem Titov880fa812021-07-30 22:30:23 +0200455 // Makes sure a MediaStreamTrack is created for each StreamParam in `streams`,
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000456 // and existing MediaStreamTracks are removed if there is no corresponding
Artem Titov880fa812021-07-30 22:30:23 +0200457 // StreamParam. If `default_track_needed` is true, a default MediaStreamTrack
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000458 // is created if it doesn't exist; if false, it's removed if it exists.
Artem Titov880fa812021-07-30 22:30:23 +0200459 // `media_type` is the type of the `streams` and can be either audio or video.
460 // If a new MediaStream is created it is added to `new_streams`.
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000461 void UpdateRemoteSendersList(
462 const std::vector<cricket::StreamParams>& streams,
463 bool default_track_needed,
464 cricket::MediaType media_type,
465 StreamCollection* new_streams);
466
Taylor Brandstetterd0acbd82021-01-25 13:44:55 -0800467 // Enables media channels to allow sending of media.
Harald Alvestrand48171ec2021-04-20 15:06:03 +0000468 // This enables media to flow on all configured audio/video channels.
Taylor Brandstetterd0acbd82021-01-25 13:44:55 -0800469 void EnableSending();
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000470 // Push the media parts of the local or remote session description
Taylor Brandstetterd0acbd82021-01-25 13:44:55 -0800471 // down to all of the channels.
Henrik Boströmf8187e02021-04-26 21:04:26 +0200472 RTCError PushdownMediaDescription(
473 SdpType type,
474 cricket::ContentSource source,
475 const std::map<std::string, const cricket::ContentGroup*>&
476 bundle_groups_by_mid);
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000477
478 RTCError PushdownTransportDescription(cricket::ContentSource source,
479 SdpType type);
480 // Helper function to remove stopped transceivers.
481 void RemoveStoppedTransceivers();
Artem Titov880fa812021-07-30 22:30:23 +0200482 // Deletes the corresponding channel of contents that don't exist in `desc`.
483 // `desc` can be null. This means that all channels are deleted.
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000484 void RemoveUnusedChannels(const cricket::SessionDescription* desc);
485
486 // Report inferred negotiated SDP semantics from a local/remote answer to the
487 // UMA observer.
488 void ReportNegotiatedSdpSemantics(const SessionDescriptionInterface& answer);
489
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000490 // Finds remote MediaStreams without any tracks and removes them from
Artem Titov880fa812021-07-30 22:30:23 +0200491 // `remote_streams_` and notifies the observer that the MediaStreams no longer
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000492 // exist.
493 void UpdateEndedRemoteMediaStreams();
494
Artem Titov880fa812021-07-30 22:30:23 +0200495 // Uses all remote candidates in `remote_desc` in this session.
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000496 bool UseCandidatesInSessionDescription(
497 const SessionDescriptionInterface* remote_desc);
Artem Titov880fa812021-07-30 22:30:23 +0200498 // Uses `candidate` in this session.
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000499 bool UseCandidate(const IceCandidateInterface* candidate);
500 // Returns true if we are ready to push down the remote candidate.
Artem Titov880fa812021-07-30 22:30:23 +0200501 // `remote_desc` is the new remote description, or NULL if the current remote
502 // description should be used. Output `valid` is true if the candidate media
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000503 // index is valid.
504 bool ReadyToUseRemoteCandidate(const IceCandidateInterface* candidate,
505 const SessionDescriptionInterface* remote_desc,
506 bool* valid);
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000507
508 RTCErrorOr<const cricket::ContentInfo*> FindContentInfo(
509 const SessionDescriptionInterface* description,
510 const IceCandidateInterface* candidate) RTC_RUN_ON(signaling_thread());
511
512 // Functions for dealing with transports.
513 // Note that cricket code uses the term "channel" for what other code
514 // refers to as "transport".
515
Artem Titov880fa812021-07-30 22:30:23 +0200516 // Allocates media channels based on the `desc`. If `desc` doesn't have
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000517 // the BUNDLE option, this method will disable BUNDLE in PortAllocator.
518 // This method will also delete any existing media channels before creating.
519 RTCError CreateChannels(const cricket::SessionDescription& desc);
520
521 // Helper methods to create media channels.
522 cricket::VoiceChannel* CreateVoiceChannel(const std::string& mid);
523 cricket::VideoChannel* CreateVideoChannel(const std::string& mid);
524 bool CreateDataChannel(const std::string& mid);
525
526 // Destroys and clears the BaseChannel associated with the given transceiver,
527 // if such channel is set.
528 void DestroyTransceiverChannel(
529 rtc::scoped_refptr<RtpTransceiverProxyWithInternal<RtpTransceiver>>
530 transceiver);
531
532 // Destroys the RTP data channel transport and/or the SCTP data channel
533 // transport and clears it.
Florent Castellidcb9ffc2021-06-29 14:58:23 +0200534 void DestroyDataChannelTransport(RTCError error);
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000535
536 // Destroys the given ChannelInterface.
537 // The channel cannot be accessed after this method is called.
538 void DestroyChannelInterface(cricket::ChannelInterface* channel);
Artem Titov880fa812021-07-30 22:30:23 +0200539 // Generates MediaDescriptionOptions for the `session_opts` based on existing
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000540 // local description or remote description.
541
542 void GenerateMediaDescriptionOptions(
543 const SessionDescriptionInterface* session_desc,
544 RtpTransceiverDirection audio_direction,
545 RtpTransceiverDirection video_direction,
546 absl::optional<size_t>* audio_index,
547 absl::optional<size_t>* video_index,
548 absl::optional<size_t>* data_index,
549 cricket::MediaSessionOptions* session_options);
550
551 // Generates the active MediaDescriptionOptions for the local data channel
552 // given the specified MID.
553 cricket::MediaDescriptionOptions GetMediaDescriptionOptionsForActiveData(
554 const std::string& mid) const;
555
556 // Generates the rejected MediaDescriptionOptions for the local data channel
557 // given the specified MID.
558 cricket::MediaDescriptionOptions GetMediaDescriptionOptionsForRejectedData(
559 const std::string& mid) const;
560
Taylor Brandstetterd0acbd82021-01-25 13:44:55 -0800561 // Based on number of transceivers per media type, enabled or disable
562 // payload type based demuxing in the affected channels.
Henrik Boströmf8187e02021-04-26 21:04:26 +0200563 bool UpdatePayloadTypeDemuxingState(
564 cricket::ContentSource source,
565 const std::map<std::string, const cricket::ContentGroup*>&
566 bundle_groups_by_mid);
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000567
Harald Alvestrand42b983a2021-10-19 21:50:01 +0000568 // Updates the error state, signaling if necessary.
569 void SetSessionError(SessionError error, const std::string& error_desc);
570
571 // Implements AddIceCandidate without reporting usage, but returns the
572 // particular success/error value that should be reported (and can be utilized
573 // for other purposes).
574 AddIceCandidateResult AddIceCandidateInternal(
575 const IceCandidateInterface* candidate);
576
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000577 // ==================================================================
578 // Access to pc_ variables
579 cricket::ChannelManager* channel_manager() const;
Harald Alvestrande15fb152020-10-19 13:28:05 +0000580 TransceiverList* transceivers();
581 const TransceiverList* transceivers() const;
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000582 DataChannelController* data_channel_controller();
583 const DataChannelController* data_channel_controller() const;
584 cricket::PortAllocator* port_allocator();
585 const cricket::PortAllocator* port_allocator() const;
Harald Alvestrande15fb152020-10-19 13:28:05 +0000586 RtpTransmissionManager* rtp_manager();
587 const RtpTransmissionManager* rtp_manager() const;
Harald Alvestrandf01bd6c2020-10-23 13:30:46 +0000588 JsepTransportController* transport_controller();
589 const JsepTransportController* transport_controller() const;
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000590 // ===================================================================
Harald Alvestrand763f5a92020-10-22 10:39:40 +0000591 const cricket::AudioOptions& audio_options() { return audio_options_; }
592 const cricket::VideoOptions& video_options() { return video_options_; }
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000593
594 PeerConnection* const pc_;
595
596 std::unique_ptr<WebRtcSessionDescriptionFactory> webrtc_session_desc_factory_
597 RTC_GUARDED_BY(signaling_thread());
598
599 std::unique_ptr<SessionDescriptionInterface> current_local_description_
600 RTC_GUARDED_BY(signaling_thread());
601 std::unique_ptr<SessionDescriptionInterface> pending_local_description_
602 RTC_GUARDED_BY(signaling_thread());
603 std::unique_ptr<SessionDescriptionInterface> current_remote_description_
604 RTC_GUARDED_BY(signaling_thread());
605 std::unique_ptr<SessionDescriptionInterface> pending_remote_description_
606 RTC_GUARDED_BY(signaling_thread());
607
608 PeerConnectionInterface::SignalingState signaling_state_
609 RTC_GUARDED_BY(signaling_thread()) = PeerConnectionInterface::kStable;
610
611 // Whether this peer is the caller. Set when the local description is applied.
612 absl::optional<bool> is_caller_ RTC_GUARDED_BY(signaling_thread());
613
Harald Alvestrand6f04b652020-10-09 11:42:17 +0000614 // Streams added via AddStream.
615 const rtc::scoped_refptr<StreamCollection> local_streams_
616 RTC_GUARDED_BY(signaling_thread());
617 // Streams created as a result of SetRemoteDescription.
618 const rtc::scoped_refptr<StreamCollection> remote_streams_
619 RTC_GUARDED_BY(signaling_thread());
620
621 std::vector<std::unique_ptr<MediaStreamObserver>> stream_observers_
622 RTC_GUARDED_BY(signaling_thread());
623
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000624 // The operations chain is used by the offer/answer exchange methods to ensure
625 // they are executed in the right order. For example, if
626 // SetRemoteDescription() is invoked while CreateOffer() is still pending, the
627 // SRD operation will not start until CreateOffer() has completed. See
628 // https://w3c.github.io/webrtc-pc/#dfn-operations-chain.
629 rtc::scoped_refptr<rtc::OperationsChain> operations_chain_
630 RTC_GUARDED_BY(signaling_thread());
631
Harald Alvestrandbc9ca252020-10-05 13:08:41 +0000632 // One PeerConnection has only one RTCP CNAME.
633 // https://tools.ietf.org/html/draft-ietf-rtcweb-rtp-usage-26#section-4.9
634 const std::string rtcp_cname_;
635
636 // MIDs will be generated using this generator which will keep track of
637 // all the MIDs that have been seen over the life of the PeerConnection.
638 rtc::UniqueStringGenerator mid_generator_ RTC_GUARDED_BY(signaling_thread());
639
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000640 // List of content names for which the remote side triggered an ICE restart.
641 std::set<std::string> pending_ice_restarts_
642 RTC_GUARDED_BY(signaling_thread());
643
644 std::unique_ptr<LocalIceCredentialsToReplace>
645 local_ice_credentials_to_replace_ RTC_GUARDED_BY(signaling_thread());
646
647 bool remote_peer_supports_msid_ RTC_GUARDED_BY(signaling_thread()) = false;
648 bool is_negotiation_needed_ RTC_GUARDED_BY(signaling_thread()) = false;
Harald Alvestrand42b983a2021-10-19 21:50:01 +0000649 uint32_t negotiation_needed_event_id_ RTC_GUARDED_BY(signaling_thread()) = 0;
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000650 bool update_negotiation_needed_on_empty_chain_
651 RTC_GUARDED_BY(signaling_thread()) = false;
Henrik Boström4ea80f32021-06-09 10:29:50 +0200652 // If PT demuxing is successfully negotiated one time we will allow PT
653 // demuxing for the rest of the session so that PT-based apps default to PT
654 // demuxing in follow-up O/A exchanges.
Harald Alvestrand42b983a2021-10-19 21:50:01 +0000655 bool pt_demuxing_has_been_used_audio_ RTC_GUARDED_BY(signaling_thread()) =
656 false;
657 bool pt_demuxing_has_been_used_video_ RTC_GUARDED_BY(signaling_thread()) =
658 false;
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000659
660 // In Unified Plan, if we encounter remote SDP that does not contain an a=msid
661 // line we create and use a stream with a random ID for our receivers. This is
662 // to support legacy endpoints that do not support the a=msid attribute (as
663 // opposed to streamless tracks with "a=msid:-").
664 rtc::scoped_refptr<MediaStreamInterface> missing_msid_default_stream_
665 RTC_GUARDED_BY(signaling_thread());
666
Harald Alvestranda474fbf2020-10-01 16:47:23 +0000667 SessionError session_error_ RTC_GUARDED_BY(signaling_thread()) =
668 SessionError::kNone;
669 std::string session_error_desc_ RTC_GUARDED_BY(signaling_thread());
670
Harald Alvestrand763f5a92020-10-22 10:39:40 +0000671 // Member variables for caching global options.
672 cricket::AudioOptions audio_options_ RTC_GUARDED_BY(signaling_thread());
673 cricket::VideoOptions video_options_ RTC_GUARDED_BY(signaling_thread());
674
675 // This object should be used to generate any SSRC that is not explicitly
676 // specified by the user (or by the remote party).
677 // The generator is not used directly, instead it is passed on to the
678 // channel manager and the session description factory.
Tomas Gunnarsson64099bc2021-04-09 09:51:37 +0200679 // TODO(bugs.webrtc.org/12666): This variable is used from both the signaling
680 // and worker threads. See if we can't restrict usage to a single thread.
681 rtc::UniqueRandomIdGenerator ssrc_generator_;
Harald Alvestrand763f5a92020-10-22 10:39:40 +0000682
683 // A video bitrate allocator factory.
684 // This can be injected using the PeerConnectionDependencies,
685 // or else the CreateBuiltinVideoBitrateAllocatorFactory() will be called.
686 // Note that one can still choose to override this in a MediaEngine
687 // if one wants too.
688 std::unique_ptr<webrtc::VideoBitrateAllocatorFactory>
Harald Alvestrand42b983a2021-10-19 21:50:01 +0000689 video_bitrate_allocator_factory_ RTC_GUARDED_BY(signaling_thread());
Harald Alvestrand763f5a92020-10-22 10:39:40 +0000690
Harald Alvestrandcdcfab02020-09-28 13:02:07 +0000691 rtc::WeakPtrFactory<SdpOfferAnswerHandler> weak_ptr_factory_
692 RTC_GUARDED_BY(signaling_thread());
693};
694
695} // namespace webrtc
696
697#endif // PC_SDP_OFFER_ANSWER_H_