henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 1 | /* |
kjellander | b24317b | 2016-02-10 07:54:43 -0800 | [diff] [blame] | 2 | * Copyright 2012 The WebRTC project authors. All Rights Reserved. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 3 | * |
kjellander | b24317b | 2016-02-10 07:54:43 -0800 | [diff] [blame] | 4 | * Use of this source code is governed by a BSD-style license |
| 5 | * that can be found in the LICENSE file in the root of the source |
| 6 | * tree. An additional intellectual property rights grant can be found |
| 7 | * in the file PATENTS. All contributing project authors may |
| 8 | * be found in the AUTHORS file in the root of the source tree. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 9 | */ |
| 10 | |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 11 | // This file contains declarations of interfaces that wrap SDP-related |
| 12 | // constructs; session descriptions and ICE candidates. The inner "cricket::" |
| 13 | // objects shouldn't be accessed directly; the intention is that an application |
| 14 | // using the PeerConnection API only creates these objects from strings, and |
| 15 | // them passes them into the PeerConnection. |
| 16 | // |
| 17 | // Though in the future, we're planning to provide an SDP parsing API, with a |
| 18 | // structure more friendly than cricket::SessionDescription. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 19 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 20 | #ifndef API_JSEP_H_ |
| 21 | #define API_JSEP_H_ |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 22 | |
pbos | 9baddf2 | 2017-01-02 06:44:41 -0800 | [diff] [blame] | 23 | #include <stddef.h> |
| 24 | |
Steve Anton | 88f2cb9 | 2017-12-05 12:47:32 -0800 | [diff] [blame] | 25 | #include <memory> |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 26 | #include <string> |
| 27 | #include <vector> |
| 28 | |
Danil Chapovalov | 0bc58cf | 2018-06-21 13:32:56 +0200 | [diff] [blame] | 29 | #include "absl/types/optional.h" |
Steve Anton | 10542f2 | 2019-01-11 09:11:00 -0800 | [diff] [blame] | 30 | #include "api/rtc_error.h" |
Harald Alvestrand | 11146cd | 2020-02-20 11:40:37 +0100 | [diff] [blame] | 31 | #include "rtc_base/deprecation.h" |
Steve Anton | 10542f2 | 2019-01-11 09:11:00 -0800 | [diff] [blame] | 32 | #include "rtc_base/ref_count.h" |
Mirko Bonadei | 3b56ee7 | 2018-10-15 17:15:12 +0200 | [diff] [blame] | 33 | #include "rtc_base/system/rtc_export.h" |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 34 | |
| 35 | namespace cricket { |
tommi | 6f59a4f | 2016-03-11 14:05:09 -0800 | [diff] [blame] | 36 | class Candidate; |
Honghai Zhang | 7fb69db | 2016-03-14 11:59:18 -0700 | [diff] [blame] | 37 | class SessionDescription; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 38 | } // namespace cricket |
| 39 | |
| 40 | namespace webrtc { |
| 41 | |
| 42 | struct SdpParseError { |
| 43 | public: |
| 44 | // The sdp line that causes the error. |
| 45 | std::string line; |
| 46 | // Explains the error. |
| 47 | std::string description; |
| 48 | }; |
| 49 | |
| 50 | // Class representation of an ICE candidate. |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 51 | // |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 52 | // An instance of this interface is supposed to be owned by one class at |
| 53 | // a time and is therefore not expected to be thread safe. |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 54 | // |
| 55 | // An instance can be created by CreateIceCandidate. |
Mirko Bonadei | 35214fc | 2019-09-23 14:54:28 +0200 | [diff] [blame] | 56 | class RTC_EXPORT IceCandidateInterface { |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 57 | public: |
| 58 | virtual ~IceCandidateInterface() {} |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 59 | // If present, this is the value of the "a=mid" attribute of the candidate's |
| 60 | // m= section in SDP, which identifies the m= section. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 61 | virtual std::string sdp_mid() const = 0; |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 62 | // This indicates the index (starting at zero) of m= section this candidate |
Steve Anton | 88f2cb9 | 2017-12-05 12:47:32 -0800 | [diff] [blame] | 63 | // is associated with. Needed when an endpoint doesn't support MIDs. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 64 | virtual int sdp_mline_index() const = 0; |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 65 | // Only for use internally. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 66 | virtual const cricket::Candidate& candidate() const = 0; |
zhihuang | d7e771d | 2017-02-16 11:29:39 -0800 | [diff] [blame] | 67 | // The URL of the ICE server which this candidate was gathered from. |
| 68 | // TODO(zhihuang): Remove the default implementation once the subclasses |
| 69 | // implement this method. |
Steve Anton | 845bb73 | 2017-12-05 12:50:26 -0800 | [diff] [blame] | 70 | virtual std::string server_url() const; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 71 | // Creates a SDP-ized form of this candidate. |
| 72 | virtual bool ToString(std::string* out) const = 0; |
| 73 | }; |
| 74 | |
| 75 | // Creates a IceCandidateInterface based on SDP string. |
deadbeef | 8d60a94 | 2017-02-27 14:47:33 -0800 | [diff] [blame] | 76 | // Returns null if the sdp string can't be parsed. |
| 77 | // |error| may be null. |
Mirko Bonadei | 3b56ee7 | 2018-10-15 17:15:12 +0200 | [diff] [blame] | 78 | RTC_EXPORT IceCandidateInterface* CreateIceCandidate(const std::string& sdp_mid, |
| 79 | int sdp_mline_index, |
| 80 | const std::string& sdp, |
| 81 | SdpParseError* error); |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 82 | |
Steve Anton | 27ab0e5 | 2018-07-23 15:11:53 -0700 | [diff] [blame] | 83 | // Creates an IceCandidateInterface based on a parsed candidate structure. |
Mirko Bonadei | 3b56ee7 | 2018-10-15 17:15:12 +0200 | [diff] [blame] | 84 | RTC_EXPORT std::unique_ptr<IceCandidateInterface> CreateIceCandidate( |
Steve Anton | 27ab0e5 | 2018-07-23 15:11:53 -0700 | [diff] [blame] | 85 | const std::string& sdp_mid, |
| 86 | int sdp_mline_index, |
| 87 | const cricket::Candidate& candidate); |
| 88 | |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 89 | // This class represents a collection of candidates for a specific m= section. |
| 90 | // Used in SessionDescriptionInterface. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 91 | class IceCandidateCollection { |
| 92 | public: |
| 93 | virtual ~IceCandidateCollection() {} |
| 94 | virtual size_t count() const = 0; |
| 95 | // Returns true if an equivalent |candidate| exist in the collection. |
| 96 | virtual bool HasCandidate(const IceCandidateInterface* candidate) const = 0; |
| 97 | virtual const IceCandidateInterface* at(size_t index) const = 0; |
| 98 | }; |
| 99 | |
Steve Anton | 88f2cb9 | 2017-12-05 12:47:32 -0800 | [diff] [blame] | 100 | // Enum that describes the type of the SessionDescriptionInterface. |
| 101 | // Corresponds to RTCSdpType in the WebRTC specification. |
| 102 | // https://w3c.github.io/webrtc-pc/#dom-rtcsdptype |
| 103 | enum class SdpType { |
| 104 | kOffer, // Description must be treated as an SDP offer. |
| 105 | kPrAnswer, // Description must be treated as an SDP answer, but not a final |
| 106 | // answer. |
Eldar Rello | 5ab79e6 | 2019-10-09 18:29:44 +0300 | [diff] [blame] | 107 | kAnswer, // Description must be treated as an SDP final answer, and the |
| 108 | // offer-answer exchange must be considered complete after |
| 109 | // receiving this. |
| 110 | kRollback // Resets any pending offers and sets signaling state back to |
| 111 | // stable. |
Steve Anton | 88f2cb9 | 2017-12-05 12:47:32 -0800 | [diff] [blame] | 112 | }; |
| 113 | |
| 114 | // Returns the string form of the given SDP type. String forms are defined in |
| 115 | // SessionDescriptionInterface. |
Mirko Bonadei | 3ac6375 | 2019-11-05 09:56:32 +0100 | [diff] [blame] | 116 | RTC_EXPORT const char* SdpTypeToString(SdpType type); |
Steve Anton | 88f2cb9 | 2017-12-05 12:47:32 -0800 | [diff] [blame] | 117 | |
| 118 | // Returns the SdpType from its string form. The string form can be one of the |
| 119 | // constants defined in SessionDescriptionInterface. Passing in any other string |
| 120 | // results in nullopt. |
Danil Chapovalov | 0bc58cf | 2018-06-21 13:32:56 +0200 | [diff] [blame] | 121 | absl::optional<SdpType> SdpTypeFromString(const std::string& type_str); |
Steve Anton | 88f2cb9 | 2017-12-05 12:47:32 -0800 | [diff] [blame] | 122 | |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 123 | // Class representation of an SDP session description. |
| 124 | // |
| 125 | // An instance of this interface is supposed to be owned by one class at a time |
| 126 | // and is therefore not expected to be thread safe. |
| 127 | // |
| 128 | // An instance can be created by CreateSessionDescription. |
Mirko Bonadei | 3b56ee7 | 2018-10-15 17:15:12 +0200 | [diff] [blame] | 129 | class RTC_EXPORT SessionDescriptionInterface { |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 130 | public: |
Steve Anton | 88f2cb9 | 2017-12-05 12:47:32 -0800 | [diff] [blame] | 131 | // String representations of the supported SDP types. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 132 | static const char kOffer[]; |
| 133 | static const char kPrAnswer[]; |
| 134 | static const char kAnswer[]; |
Eldar Rello | 5ab79e6 | 2019-10-09 18:29:44 +0300 | [diff] [blame] | 135 | static const char kRollback[]; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 136 | |
| 137 | virtual ~SessionDescriptionInterface() {} |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 138 | |
| 139 | // Only for use internally. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 140 | virtual cricket::SessionDescription* description() = 0; |
| 141 | virtual const cricket::SessionDescription* description() const = 0; |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 142 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 143 | // Get the session id and session version, which are defined based on |
| 144 | // RFC 4566 for the SDP o= line. |
| 145 | virtual std::string session_id() const = 0; |
| 146 | virtual std::string session_version() const = 0; |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 147 | |
Steve Anton | 88f2cb9 | 2017-12-05 12:47:32 -0800 | [diff] [blame] | 148 | // Returns the type of this session description as an SdpType. Descriptions of |
| 149 | // the various types are found in the SdpType documentation. |
| 150 | // TODO(steveanton): Remove default implementation once Chromium has been |
| 151 | // updated. |
| 152 | virtual SdpType GetType() const; |
| 153 | |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 154 | // kOffer/kPrAnswer/kAnswer |
Steve Anton | 88f2cb9 | 2017-12-05 12:47:32 -0800 | [diff] [blame] | 155 | // TODO(steveanton): Remove this in favor of |GetType| that returns SdpType. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 156 | virtual std::string type() const = 0; |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 157 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 158 | // Adds the specified candidate to the description. |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 159 | // |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 160 | // Ownership is not transferred. |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 161 | // |
| 162 | // Returns false if the session description does not have a media section |
| 163 | // that corresponds to |candidate.sdp_mid()| or |
| 164 | // |candidate.sdp_mline_index()|. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 165 | virtual bool AddCandidate(const IceCandidateInterface* candidate) = 0; |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 166 | |
| 167 | // Removes the candidates from the description, if found. |
| 168 | // |
Honghai Zhang | 7fb69db | 2016-03-14 11:59:18 -0700 | [diff] [blame] | 169 | // Returns the number of candidates removed. |
| 170 | virtual size_t RemoveCandidates( |
Steve Anton | 845bb73 | 2017-12-05 12:50:26 -0800 | [diff] [blame] | 171 | const std::vector<cricket::Candidate>& candidates); |
Honghai Zhang | 7fb69db | 2016-03-14 11:59:18 -0700 | [diff] [blame] | 172 | |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 173 | // Returns the number of m= sections in the session description. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 174 | virtual size_t number_of_mediasections() const = 0; |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 175 | |
| 176 | // Returns a collection of all candidates that belong to a certain m= |
| 177 | // section. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 178 | virtual const IceCandidateCollection* candidates( |
| 179 | size_t mediasection_index) const = 0; |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 180 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 181 | // Serializes the description to SDP. |
| 182 | virtual bool ToString(std::string* out) const = 0; |
| 183 | }; |
| 184 | |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 185 | // Creates a SessionDescriptionInterface based on the SDP string and the type. |
deadbeef | 8d60a94 | 2017-02-27 14:47:33 -0800 | [diff] [blame] | 186 | // Returns null if the sdp string can't be parsed or the type is unsupported. |
| 187 | // |error| may be null. |
Steve Anton | 88f2cb9 | 2017-12-05 12:47:32 -0800 | [diff] [blame] | 188 | // TODO(steveanton): This function is deprecated. Please use the functions below |
| 189 | // which take an SdpType enum instead. Remove this once it is no longer used. |
Mirko Bonadei | 3b56ee7 | 2018-10-15 17:15:12 +0200 | [diff] [blame] | 190 | RTC_EXPORT SessionDescriptionInterface* CreateSessionDescription( |
| 191 | const std::string& type, |
| 192 | const std::string& sdp, |
| 193 | SdpParseError* error); |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 194 | |
Steve Anton | 88f2cb9 | 2017-12-05 12:47:32 -0800 | [diff] [blame] | 195 | // Creates a SessionDescriptionInterface based on the SDP string and the type. |
| 196 | // Returns null if the SDP string cannot be parsed. |
| 197 | // If using the signature with |error_out|, details of the parsing error may be |
| 198 | // written to |error_out| if it is not null. |
Mirko Bonadei | 3b56ee7 | 2018-10-15 17:15:12 +0200 | [diff] [blame] | 199 | RTC_EXPORT std::unique_ptr<SessionDescriptionInterface> |
| 200 | CreateSessionDescription(SdpType type, const std::string& sdp); |
| 201 | RTC_EXPORT std::unique_ptr<SessionDescriptionInterface> |
| 202 | CreateSessionDescription(SdpType type, |
| 203 | const std::string& sdp, |
| 204 | SdpParseError* error_out); |
Steve Anton | 88f2cb9 | 2017-12-05 12:47:32 -0800 | [diff] [blame] | 205 | |
Steve Anton | d9e4a06 | 2018-07-24 18:23:33 -0700 | [diff] [blame] | 206 | // Creates a SessionDescriptionInterface based on a parsed SDP structure and the |
| 207 | // given type, ID and version. |
| 208 | std::unique_ptr<SessionDescriptionInterface> CreateSessionDescription( |
| 209 | SdpType type, |
| 210 | const std::string& session_id, |
| 211 | const std::string& session_version, |
| 212 | std::unique_ptr<cricket::SessionDescription> description); |
| 213 | |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 214 | // CreateOffer and CreateAnswer callback interface. |
Mirko Bonadei | ac19414 | 2018-10-22 17:08:37 +0200 | [diff] [blame] | 215 | class RTC_EXPORT CreateSessionDescriptionObserver |
| 216 | : public rtc::RefCountInterface { |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 217 | public: |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 218 | // This callback transfers the ownership of the |desc|. |
| 219 | // TODO(deadbeef): Make this take an std::unique_ptr<> to avoid confusion |
| 220 | // around ownership. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 221 | virtual void OnSuccess(SessionDescriptionInterface* desc) = 0; |
Harald Alvestrand | 5081c0c | 2018-03-09 15:18:03 +0100 | [diff] [blame] | 222 | // The OnFailure callback takes an RTCError, which consists of an |
| 223 | // error code and a string. |
| 224 | // RTCError is non-copyable, so it must be passed using std::move. |
| 225 | // Earlier versions of the API used a string argument. This version |
Harald Alvestrand | 11146cd | 2020-02-20 11:40:37 +0100 | [diff] [blame] | 226 | // is removed; its functionality was the same as passing |
| 227 | // error.message. |
| 228 | virtual void OnFailure(RTCError error) = 0; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 229 | |
| 230 | protected: |
Steve Anton | 845bb73 | 2017-12-05 12:50:26 -0800 | [diff] [blame] | 231 | ~CreateSessionDescriptionObserver() override = default; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 232 | }; |
| 233 | |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 234 | // SetLocalDescription and SetRemoteDescription callback interface. |
Mirko Bonadei | ac19414 | 2018-10-22 17:08:37 +0200 | [diff] [blame] | 235 | class RTC_EXPORT SetSessionDescriptionObserver : public rtc::RefCountInterface { |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 236 | public: |
| 237 | virtual void OnSuccess() = 0; |
Harald Alvestrand | 5081c0c | 2018-03-09 15:18:03 +0100 | [diff] [blame] | 238 | // See description in CreateSessionDescriptionObserver for OnFailure. |
Harald Alvestrand | 11146cd | 2020-02-20 11:40:37 +0100 | [diff] [blame] | 239 | virtual void OnFailure(RTCError error) = 0; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 240 | |
| 241 | protected: |
Steve Anton | 845bb73 | 2017-12-05 12:50:26 -0800 | [diff] [blame] | 242 | ~SetSessionDescriptionObserver() override = default; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 243 | }; |
| 244 | |
| 245 | } // namespace webrtc |
| 246 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 247 | #endif // API_JSEP_H_ |