blob: 29b8d7a12f0c800ba429f80c1f5e9a47d4802713 [file] [log] [blame]
skvladdc1c62c2016-03-16 19:07:43 -07001/*
2 * Copyright 2015 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
Steve Anton10542f22019-01-11 09:11:00 -080011#ifndef API_RTP_PARAMETERS_H_
12#define API_RTP_PARAMETERS_H_
skvladdc1c62c2016-03-16 19:07:43 -070013
Yves Gerey988cc082018-10-23 12:03:01 +020014#include <stdint.h>
Taylor Brandstetter0cd086b2016-04-20 16:23:10 -070015#include <string>
deadbeefe702b302017-02-04 12:09:01 -080016#include <unordered_map>
skvladdc1c62c2016-03-16 19:07:43 -070017#include <vector>
18
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +020019#include "absl/types/optional.h"
Steve Anton10542f22019-01-11 09:11:00 -080020#include "api/media_types.h"
Mirko Bonadeiac194142018-10-22 17:08:37 +020021#include "rtc_base/system/rtc_export.h"
sakal1fd95952016-06-22 00:46:15 -070022
skvladdc1c62c2016-03-16 19:07:43 -070023namespace webrtc {
24
deadbeefe702b302017-02-04 12:09:01 -080025// These structures are intended to mirror those defined by:
26// http://draft.ortc.org/#rtcrtpdictionaries*
27// Contains everything specified as of 2017 Jan 24.
28//
29// They are used when retrieving or modifying the parameters of an
30// RtpSender/RtpReceiver, or retrieving capabilities.
31//
32// Note on conventions: Where ORTC may use "octet", "short" and "unsigned"
33// types, we typically use "int", in keeping with our style guidelines. The
34// parameter's actual valid range will be enforced when the parameters are set,
35// rather than when the parameters struct is built. An exception is made for
36// SSRCs, since they use the full unsigned 32-bit range, and aren't expected to
37// be used for any numeric comparisons/operations.
38//
39// Additionally, where ORTC uses strings, we may use enums for things that have
40// a fixed number of supported values. However, for things that can be extended
41// (such as codecs, by providing an external encoder factory), a string
42// identifier is used.
43
44enum class FecMechanism {
45 RED,
46 RED_AND_ULPFEC,
47 FLEXFEC,
48};
49
50// Used in RtcpFeedback struct.
51enum class RtcpFeedbackType {
deadbeefe702b302017-02-04 12:09:01 -080052 CCM,
Elad Alonfadb1812019-05-24 13:40:02 +020053 LNTF, // "goog-lntf"
deadbeefe702b302017-02-04 12:09:01 -080054 NACK,
55 REMB, // "goog-remb"
56 TRANSPORT_CC,
57};
58
deadbeefe814a0d2017-02-25 18:15:09 -080059// Used in RtcpFeedback struct when type is NACK or CCM.
deadbeefe702b302017-02-04 12:09:01 -080060enum class RtcpFeedbackMessageType {
61 // Equivalent to {type: "nack", parameter: undefined} in ORTC.
62 GENERIC_NACK,
63 PLI, // Usable with NACK.
64 FIR, // Usable with CCM.
65};
66
67enum class DtxStatus {
68 DISABLED,
69 ENABLED,
70};
71
Taylor Brandstetter49fcc102018-05-16 14:20:41 -070072// Based on the spec in
73// https://w3c.github.io/webrtc-pc/#idl-def-rtcdegradationpreference.
74// These options are enforced on a best-effort basis. For instance, all of
75// these options may suffer some frame drops in order to avoid queuing.
76// TODO(sprang): Look into possibility of more strictly enforcing the
77// maintain-framerate option.
78// TODO(deadbeef): Default to "balanced", as the spec indicates?
deadbeefe702b302017-02-04 12:09:01 -080079enum class DegradationPreference {
Taylor Brandstetter49fcc102018-05-16 14:20:41 -070080 // Don't take any actions based on over-utilization signals. Not part of the
81 // web API.
82 DISABLED,
Taylor Brandstetter49fcc102018-05-16 14:20:41 -070083 // On over-use, request lower resolution, possibly causing down-scaling.
Åsa Persson90bc1e12019-05-31 13:29:35 +020084 MAINTAIN_FRAMERATE,
85 // On over-use, request lower frame rate, possibly causing frame drops.
deadbeefe702b302017-02-04 12:09:01 -080086 MAINTAIN_RESOLUTION,
Taylor Brandstetter49fcc102018-05-16 14:20:41 -070087 // Try to strike a "pleasing" balance between frame rate or resolution.
deadbeefe702b302017-02-04 12:09:01 -080088 BALANCED,
89};
90
Mirko Bonadei66e76792019-04-02 11:33:59 +020091RTC_EXPORT extern const double kDefaultBitratePriority;
deadbeefe702b302017-02-04 12:09:01 -080092
93struct RtcpFeedback {
deadbeefe814a0d2017-02-25 18:15:09 -080094 RtcpFeedbackType type = RtcpFeedbackType::CCM;
deadbeefe702b302017-02-04 12:09:01 -080095
96 // Equivalent to ORTC "parameter" field with slight differences:
97 // 1. It's an enum instead of a string.
98 // 2. Generic NACK feedback is represented by a GENERIC_NACK message type,
99 // rather than an unset "parameter" value.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200100 absl::optional<RtcpFeedbackMessageType> message_type;
deadbeefe702b302017-02-04 12:09:01 -0800101
deadbeefe814a0d2017-02-25 18:15:09 -0800102 // Constructors for convenience.
Stefan Holmer1acbd682017-09-01 15:29:28 +0200103 RtcpFeedback();
104 explicit RtcpFeedback(RtcpFeedbackType type);
105 RtcpFeedback(RtcpFeedbackType type, RtcpFeedbackMessageType message_type);
Mirko Bonadei2ffed6d2018-07-20 11:09:32 +0200106 RtcpFeedback(const RtcpFeedback&);
Stefan Holmer1acbd682017-09-01 15:29:28 +0200107 ~RtcpFeedback();
deadbeefe814a0d2017-02-25 18:15:09 -0800108
deadbeefe702b302017-02-04 12:09:01 -0800109 bool operator==(const RtcpFeedback& o) const {
110 return type == o.type && message_type == o.message_type;
111 }
112 bool operator!=(const RtcpFeedback& o) const { return !(*this == o); }
113};
114
115// RtpCodecCapability is to RtpCodecParameters as RtpCapabilities is to
116// RtpParameters. This represents the static capabilities of an endpoint's
117// implementation of a codec.
118struct RtpCodecCapability {
Stefan Holmer1acbd682017-09-01 15:29:28 +0200119 RtpCodecCapability();
120 ~RtpCodecCapability();
121
deadbeefe702b302017-02-04 12:09:01 -0800122 // Build MIME "type/subtype" string from |name| and |kind|.
123 std::string mime_type() const { return MediaTypeToString(kind) + "/" + name; }
124
125 // Used to identify the codec. Equivalent to MIME subtype.
126 std::string name;
127
128 // The media type of this codec. Equivalent to MIME top-level type.
129 cricket::MediaType kind = cricket::MEDIA_TYPE_AUDIO;
130
131 // Clock rate in Hertz. If unset, the codec is applicable to any clock rate.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200132 absl::optional<int> clock_rate;
deadbeefe702b302017-02-04 12:09:01 -0800133
134 // Default payload type for this codec. Mainly needed for codecs that use
135 // that have statically assigned payload types.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200136 absl::optional<int> preferred_payload_type;
deadbeefe702b302017-02-04 12:09:01 -0800137
138 // Maximum packetization time supported by an RtpReceiver for this codec.
139 // TODO(deadbeef): Not implemented.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200140 absl::optional<int> max_ptime;
deadbeefe702b302017-02-04 12:09:01 -0800141
Åsa Persson90bc1e12019-05-31 13:29:35 +0200142 // Preferred packetization time for an RtpReceiver or RtpSender of this codec.
deadbeefe702b302017-02-04 12:09:01 -0800143 // TODO(deadbeef): Not implemented.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200144 absl::optional<int> ptime;
deadbeefe702b302017-02-04 12:09:01 -0800145
146 // The number of audio channels supported. Unused for video codecs.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200147 absl::optional<int> num_channels;
deadbeefe702b302017-02-04 12:09:01 -0800148
149 // Feedback mechanisms supported for this codec.
150 std::vector<RtcpFeedback> rtcp_feedback;
151
152 // Codec-specific parameters that must be signaled to the remote party.
deadbeefe814a0d2017-02-25 18:15:09 -0800153 //
deadbeefe702b302017-02-04 12:09:01 -0800154 // Corresponds to "a=fmtp" parameters in SDP.
deadbeefe814a0d2017-02-25 18:15:09 -0800155 //
156 // Contrary to ORTC, these parameters are named using all lowercase strings.
Åsa Persson90bc1e12019-05-31 13:29:35 +0200157 // This helps make the mapping to SDP simpler, if an application is using SDP.
158 // Boolean values are represented by the string "1".
deadbeefe702b302017-02-04 12:09:01 -0800159 std::unordered_map<std::string, std::string> parameters;
160
161 // Codec-specific parameters that may optionally be signaled to the remote
162 // party.
163 // TODO(deadbeef): Not implemented.
164 std::unordered_map<std::string, std::string> options;
165
166 // Maximum number of temporal layer extensions supported by this codec.
167 // For example, a value of 1 indicates that 2 total layers are supported.
168 // TODO(deadbeef): Not implemented.
169 int max_temporal_layer_extensions = 0;
170
171 // Maximum number of spatial layer extensions supported by this codec.
172 // For example, a value of 1 indicates that 2 total layers are supported.
173 // TODO(deadbeef): Not implemented.
174 int max_spatial_layer_extensions = 0;
175
Åsa Persson90bc1e12019-05-31 13:29:35 +0200176 // Whether the implementation can send/receive SVC layers with distinct SSRCs.
177 // Always false for audio codecs. True for video codecs that support scalable
178 // video coding with MRST.
deadbeefe702b302017-02-04 12:09:01 -0800179 // TODO(deadbeef): Not implemented.
180 bool svc_multi_stream_support = false;
181
182 bool operator==(const RtpCodecCapability& o) const {
183 return name == o.name && kind == o.kind && clock_rate == o.clock_rate &&
184 preferred_payload_type == o.preferred_payload_type &&
185 max_ptime == o.max_ptime && ptime == o.ptime &&
186 num_channels == o.num_channels && rtcp_feedback == o.rtcp_feedback &&
187 parameters == o.parameters && options == o.options &&
188 max_temporal_layer_extensions == o.max_temporal_layer_extensions &&
189 max_spatial_layer_extensions == o.max_spatial_layer_extensions &&
190 svc_multi_stream_support == o.svc_multi_stream_support;
191 }
192 bool operator!=(const RtpCodecCapability& o) const { return !(*this == o); }
193};
194
195// Used in RtpCapabilities; represents the capabilities/preferences of an
196// implementation for a header extension.
197//
198// Just called "RtpHeaderExtension" in ORTC, but the "Capability" suffix was
199// added here for consistency and to avoid confusion with
200// RtpHeaderExtensionParameters.
201//
202// Note that ORTC includes a "kind" field, but we omit this because it's
203// redundant; if you call "RtpReceiver::GetCapabilities(MEDIA_TYPE_AUDIO)",
204// you know you're getting audio capabilities.
205struct RtpHeaderExtensionCapability {
Johannes Kron07ba2b92018-09-26 13:33:35 +0200206 // URI of this extension, as defined in RFC8285.
deadbeefe702b302017-02-04 12:09:01 -0800207 std::string uri;
208
209 // Preferred value of ID that goes in the packet.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200210 absl::optional<int> preferred_id;
deadbeefe702b302017-02-04 12:09:01 -0800211
212 // If true, it's preferred that the value in the header is encrypted.
213 // TODO(deadbeef): Not implemented.
214 bool preferred_encrypt = false;
215
deadbeefe814a0d2017-02-25 18:15:09 -0800216 // Constructors for convenience.
Stefan Holmer1acbd682017-09-01 15:29:28 +0200217 RtpHeaderExtensionCapability();
218 explicit RtpHeaderExtensionCapability(const std::string& uri);
219 RtpHeaderExtensionCapability(const std::string& uri, int preferred_id);
220 ~RtpHeaderExtensionCapability();
deadbeefe814a0d2017-02-25 18:15:09 -0800221
deadbeefe702b302017-02-04 12:09:01 -0800222 bool operator==(const RtpHeaderExtensionCapability& o) const {
223 return uri == o.uri && preferred_id == o.preferred_id &&
224 preferred_encrypt == o.preferred_encrypt;
225 }
226 bool operator!=(const RtpHeaderExtensionCapability& o) const {
227 return !(*this == o);
228 }
229};
230
Johannes Kron07ba2b92018-09-26 13:33:35 +0200231// RTP header extension, see RFC8285.
Stefan Holmer1acbd682017-09-01 15:29:28 +0200232struct RtpExtension {
233 RtpExtension();
234 RtpExtension(const std::string& uri, int id);
235 RtpExtension(const std::string& uri, int id, bool encrypt);
236 ~RtpExtension();
237 std::string ToString() const;
238 bool operator==(const RtpExtension& rhs) const {
239 return uri == rhs.uri && id == rhs.id && encrypt == rhs.encrypt;
240 }
241 static bool IsSupportedForAudio(const std::string& uri);
242 static bool IsSupportedForVideo(const std::string& uri);
243 // Return "true" if the given RTP header extension URI may be encrypted.
244 static bool IsEncryptionSupported(const std::string& uri);
245
246 // Returns the named header extension if found among all extensions,
247 // nullptr otherwise.
248 static const RtpExtension* FindHeaderExtensionByUri(
249 const std::vector<RtpExtension>& extensions,
250 const std::string& uri);
251
252 // Return a list of RTP header extensions with the non-encrypted extensions
253 // removed if both the encrypted and non-encrypted extension is present for
254 // the same URI.
255 static std::vector<RtpExtension> FilterDuplicateNonEncrypted(
256 const std::vector<RtpExtension>& extensions);
257
258 // Header extension for audio levels, as defined in:
259 // http://tools.ietf.org/html/draft-ietf-avtext-client-to-mixer-audio-level-03
260 static const char kAudioLevelUri[];
Stefan Holmer1acbd682017-09-01 15:29:28 +0200261
262 // Header extension for RTP timestamp offset, see RFC 5450 for details:
263 // http://tools.ietf.org/html/rfc5450
264 static const char kTimestampOffsetUri[];
Stefan Holmer1acbd682017-09-01 15:29:28 +0200265
266 // Header extension for absolute send time, see url for details:
267 // http://www.webrtc.org/experiments/rtp-hdrext/abs-send-time
268 static const char kAbsSendTimeUri[];
Stefan Holmer1acbd682017-09-01 15:29:28 +0200269
Chen Xingcd8a6e22019-07-01 10:56:51 +0200270 // Header extension for absolute capture time, see url for details:
271 // http://www.webrtc.org/experiments/rtp-hdrext/abs-capture-time
272 static const char kAbsoluteCaptureTimeUri[];
273
Stefan Holmer1acbd682017-09-01 15:29:28 +0200274 // Header extension for coordination of video orientation, see url for
275 // details:
276 // http://www.etsi.org/deliver/etsi_ts/126100_126199/126114/12.07.00_60/ts_126114v120700p.pdf
277 static const char kVideoRotationUri[];
Stefan Holmer1acbd682017-09-01 15:29:28 +0200278
279 // Header extension for video content type. E.g. default or screenshare.
280 static const char kVideoContentTypeUri[];
Stefan Holmer1acbd682017-09-01 15:29:28 +0200281
282 // Header extension for video timing.
283 static const char kVideoTimingUri[];
Stefan Holmer1acbd682017-09-01 15:29:28 +0200284
Johnny Leee0c8b232018-09-11 16:50:49 -0400285 // Header extension for video frame marking.
286 static const char kFrameMarkingUri[];
Johnny Leee0c8b232018-09-11 16:50:49 -0400287
Danil Chapovalovf3119ef2018-09-25 12:20:37 +0200288 // Experimental codec agnostic frame descriptor.
Elad Alonccb9b752019-02-19 13:01:31 +0100289 static const char kGenericFrameDescriptorUri00[];
290 static const char kGenericFrameDescriptorUri01[];
291 // TODO(bugs.webrtc.org/10243): Remove once dependencies have been updated.
Danil Chapovalovf3119ef2018-09-25 12:20:37 +0200292 static const char kGenericFrameDescriptorUri[];
Danil Chapovalovf3119ef2018-09-25 12:20:37 +0200293
Stefan Holmer1acbd682017-09-01 15:29:28 +0200294 // Header extension for transport sequence number, see url for details:
295 // http://www.ietf.org/id/draft-holmer-rmcat-transport-wide-cc-extensions
296 static const char kTransportSequenceNumberUri[];
Johannes Kron7ff164e2019-02-07 12:50:18 +0100297 static const char kTransportSequenceNumberV2Uri[];
Stefan Holmer1acbd682017-09-01 15:29:28 +0200298
299 static const char kPlayoutDelayUri[];
Stefan Holmer1acbd682017-09-01 15:29:28 +0200300
Steve Antonbb50ce52018-03-26 10:24:32 -0700301 // Header extension for identifying media section within a transport.
302 // https://tools.ietf.org/html/draft-ietf-mmusic-sdp-bundle-negotiation-49#section-15
303 static const char kMidUri[];
Steve Antonbb50ce52018-03-26 10:24:32 -0700304
Stefan Holmer1acbd682017-09-01 15:29:28 +0200305 // Encryption of Header Extensions, see RFC 6904 for details:
306 // https://tools.ietf.org/html/rfc6904
307 static const char kEncryptHeaderExtensionsUri[];
308
Johannes Krond0b69a82018-12-03 14:18:53 +0100309 // Header extension for color space information.
310 static const char kColorSpaceUri[];
Johannes Krond0b69a82018-12-03 14:18:53 +0100311
Amit Hilbuch77938e62018-12-21 09:23:38 -0800312 // Header extension for RIDs and Repaired RIDs
313 // https://tools.ietf.org/html/draft-ietf-avtext-rid-09
314 // https://tools.ietf.org/html/draft-ietf-mmusic-rid-15
315 static const char kRidUri[];
Amit Hilbuch77938e62018-12-21 09:23:38 -0800316 static const char kRepairedRidUri[];
Amit Hilbuch77938e62018-12-21 09:23:38 -0800317
Johannes Kron07ba2b92018-09-26 13:33:35 +0200318 // Inclusive min and max IDs for two-byte header extensions and one-byte
319 // header extensions, per RFC8285 Section 4.2-4.3.
320 static constexpr int kMinId = 1;
321 static constexpr int kMaxId = 255;
Johannes Kron78cdde32018-10-05 10:00:46 +0200322 static constexpr int kMaxValueSize = 255;
Johannes Kron07ba2b92018-09-26 13:33:35 +0200323 static constexpr int kOneByteHeaderExtensionMaxId = 14;
Johannes Kron78cdde32018-10-05 10:00:46 +0200324 static constexpr int kOneByteHeaderExtensionMaxValueSize = 16;
Stefan Holmer1acbd682017-09-01 15:29:28 +0200325
326 std::string uri;
327 int id = 0;
328 bool encrypt = false;
329};
330
deadbeefe814a0d2017-02-25 18:15:09 -0800331// TODO(deadbeef): This is missing the "encrypt" flag, which is unimplemented.
332typedef RtpExtension RtpHeaderExtensionParameters;
deadbeefe702b302017-02-04 12:09:01 -0800333
334struct RtpFecParameters {
335 // If unset, a value is chosen by the implementation.
deadbeefe814a0d2017-02-25 18:15:09 -0800336 // Works just like RtpEncodingParameters::ssrc.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200337 absl::optional<uint32_t> ssrc;
deadbeefe702b302017-02-04 12:09:01 -0800338
339 FecMechanism mechanism = FecMechanism::RED;
340
deadbeefe814a0d2017-02-25 18:15:09 -0800341 // Constructors for convenience.
Stefan Holmer1acbd682017-09-01 15:29:28 +0200342 RtpFecParameters();
343 explicit RtpFecParameters(FecMechanism mechanism);
344 RtpFecParameters(FecMechanism mechanism, uint32_t ssrc);
Mirko Bonadei2ffed6d2018-07-20 11:09:32 +0200345 RtpFecParameters(const RtpFecParameters&);
Stefan Holmer1acbd682017-09-01 15:29:28 +0200346 ~RtpFecParameters();
deadbeefe814a0d2017-02-25 18:15:09 -0800347
deadbeefe702b302017-02-04 12:09:01 -0800348 bool operator==(const RtpFecParameters& o) const {
349 return ssrc == o.ssrc && mechanism == o.mechanism;
350 }
351 bool operator!=(const RtpFecParameters& o) const { return !(*this == o); }
352};
353
354struct RtpRtxParameters {
355 // If unset, a value is chosen by the implementation.
deadbeefe814a0d2017-02-25 18:15:09 -0800356 // Works just like RtpEncodingParameters::ssrc.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200357 absl::optional<uint32_t> ssrc;
deadbeefe702b302017-02-04 12:09:01 -0800358
deadbeefe814a0d2017-02-25 18:15:09 -0800359 // Constructors for convenience.
Stefan Holmer1acbd682017-09-01 15:29:28 +0200360 RtpRtxParameters();
361 explicit RtpRtxParameters(uint32_t ssrc);
Mirko Bonadei2ffed6d2018-07-20 11:09:32 +0200362 RtpRtxParameters(const RtpRtxParameters&);
Stefan Holmer1acbd682017-09-01 15:29:28 +0200363 ~RtpRtxParameters();
deadbeefe814a0d2017-02-25 18:15:09 -0800364
deadbeefe702b302017-02-04 12:09:01 -0800365 bool operator==(const RtpRtxParameters& o) const { return ssrc == o.ssrc; }
366 bool operator!=(const RtpRtxParameters& o) const { return !(*this == o); }
367};
368
Mirko Bonadei66e76792019-04-02 11:33:59 +0200369struct RTC_EXPORT RtpEncodingParameters {
Stefan Holmer1acbd682017-09-01 15:29:28 +0200370 RtpEncodingParameters();
Mirko Bonadei2ffed6d2018-07-20 11:09:32 +0200371 RtpEncodingParameters(const RtpEncodingParameters&);
Stefan Holmer1acbd682017-09-01 15:29:28 +0200372 ~RtpEncodingParameters();
373
deadbeefe702b302017-02-04 12:09:01 -0800374 // If unset, a value is chosen by the implementation.
deadbeefe814a0d2017-02-25 18:15:09 -0800375 //
376 // Note that the chosen value is NOT returned by GetParameters, because it
377 // may change due to an SSRC conflict, in which case the conflict is handled
378 // internally without any event. Another way of looking at this is that an
379 // unset SSRC acts as a "wildcard" SSRC.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200380 absl::optional<uint32_t> ssrc;
deadbeefe702b302017-02-04 12:09:01 -0800381
Henrik Grunelle1301a82018-12-13 12:13:22 +0000382 // Can be used to reference a codec in the |codecs| member of the
383 // RtpParameters that contains this RtpEncodingParameters. If unset, the
384 // implementation will choose the first possible codec (if a sender), or
385 // prepare to receive any codec (for a receiver).
386 // TODO(deadbeef): Not implemented. Implementation of RtpSender will always
387 // choose the first codec from the list.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200388 absl::optional<int> codec_payload_type;
deadbeefe702b302017-02-04 12:09:01 -0800389
390 // Specifies the FEC mechanism, if set.
deadbeefe814a0d2017-02-25 18:15:09 -0800391 // TODO(deadbeef): Not implemented. Current implementation will use whatever
392 // FEC codecs are available, including red+ulpfec.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200393 absl::optional<RtpFecParameters> fec;
deadbeefe702b302017-02-04 12:09:01 -0800394
395 // Specifies the RTX parameters, if set.
deadbeefe814a0d2017-02-25 18:15:09 -0800396 // TODO(deadbeef): Not implemented with PeerConnection senders/receivers.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200397 absl::optional<RtpRtxParameters> rtx;
deadbeefe702b302017-02-04 12:09:01 -0800398
399 // Only used for audio. If set, determines whether or not discontinuous
400 // transmission will be used, if an available codec supports it. If not
401 // set, the implementation default setting will be used.
deadbeefe814a0d2017-02-25 18:15:09 -0800402 // TODO(deadbeef): Not implemented. Current implementation will use a CN
403 // codec as long as it's present.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200404 absl::optional<DtxStatus> dtx;
deadbeefe702b302017-02-04 12:09:01 -0800405
Seth Hampson24722b32017-12-22 09:36:42 -0800406 // The relative bitrate priority of this encoding. Currently this is
Seth Hampsona881ac02018-02-12 14:14:39 -0800407 // implemented for the entire rtp sender by using the value of the first
408 // encoding parameter.
409 // TODO(webrtc.bugs.org/8630): Implement this per encoding parameter.
410 // Currently there is logic for how bitrate is distributed per simulcast layer
411 // in the VideoBitrateAllocator. This must be updated to incorporate relative
412 // bitrate priority.
Seth Hampson24722b32017-12-22 09:36:42 -0800413 double bitrate_priority = kDefaultBitratePriority;
deadbeefe702b302017-02-04 12:09:01 -0800414
Tim Haloun648d28a2018-10-18 16:52:22 -0700415 // The relative DiffServ Code Point priority for this encoding, allowing
416 // packets to be marked relatively higher or lower without affecting
417 // bandwidth allocations. See https://w3c.github.io/webrtc-dscp-exp/ . NB
418 // we follow chromium's translation of the allowed string enum values for
419 // this field to 1.0, 0.5, et cetera, similar to bitrate_priority above.
420 // TODO(http://crbug.com/webrtc/8630): Implement this per encoding parameter.
421 double network_priority = kDefaultBitratePriority;
422
Seth Hampsonf209cb52018-02-06 14:28:16 -0800423 // Indicates the preferred duration of media represented by a packet in
424 // milliseconds for this encoding. If set, this will take precedence over the
425 // ptime set in the RtpCodecParameters. This could happen if SDP negotiation
426 // creates a ptime for a specific codec, which is later changed in the
427 // RtpEncodingParameters by the application.
428 // TODO(bugs.webrtc.org/8819): Not implemented.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200429 absl::optional<int> ptime;
Seth Hampsonf209cb52018-02-06 14:28:16 -0800430
deadbeefe702b302017-02-04 12:09:01 -0800431 // If set, this represents the Transport Independent Application Specific
432 // maximum bandwidth defined in RFC3890. If unset, there is no maximum
Seth Hampsona881ac02018-02-12 14:14:39 -0800433 // bitrate. Currently this is implemented for the entire rtp sender by using
434 // the value of the first encoding parameter.
435 //
deadbeefe702b302017-02-04 12:09:01 -0800436 // Just called "maxBitrate" in ORTC spec.
deadbeefe814a0d2017-02-25 18:15:09 -0800437 //
438 // TODO(deadbeef): With ORTC RtpSenders, this currently sets the total
439 // bandwidth for the entire bandwidth estimator (audio and video). This is
440 // just always how "b=AS" was handled, but it's not correct and should be
441 // fixed.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200442 absl::optional<int> max_bitrate_bps;
deadbeefe702b302017-02-04 12:09:01 -0800443
Åsa Persson55659812018-06-18 17:51:32 +0200444 // Specifies the minimum bitrate in bps for video.
445 // TODO(asapersson): Not implemented for ORTC API.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200446 absl::optional<int> min_bitrate_bps;
Åsa Persson613591a2018-05-29 09:21:31 +0200447
Åsa Persson8c1bf952018-09-13 10:42:19 +0200448 // Specifies the maximum framerate in fps for video.
Åsa Persson23eba222018-10-02 14:47:06 +0200449 // TODO(asapersson): Different framerates are not supported per simulcast
450 // layer. If set, the maximum |max_framerate| is currently used.
Åsa Persson8c1bf952018-09-13 10:42:19 +0200451 // Not supported for screencast.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200452 absl::optional<int> max_framerate;
deadbeefe702b302017-02-04 12:09:01 -0800453
Åsa Persson23eba222018-10-02 14:47:06 +0200454 // Specifies the number of temporal layers for video (if the feature is
455 // supported by the codec implementation).
456 // TODO(asapersson): Different number of temporal layers are not supported
457 // per simulcast layer.
Ilya Nikolaevskiy9f6a0d52019-02-05 10:29:41 +0100458 // Screencast support is experimental.
Åsa Persson23eba222018-10-02 14:47:06 +0200459 absl::optional<int> num_temporal_layers;
460
deadbeefe702b302017-02-04 12:09:01 -0800461 // For video, scale the resolution down by this factor.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200462 absl::optional<double> scale_resolution_down_by;
deadbeefe702b302017-02-04 12:09:01 -0800463
464 // Scale the framerate down by this factor.
465 // TODO(deadbeef): Not implemented.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200466 absl::optional<double> scale_framerate_down_by;
deadbeefe702b302017-02-04 12:09:01 -0800467
Seth Hampsona881ac02018-02-12 14:14:39 -0800468 // For an RtpSender, set to true to cause this encoding to be encoded and
469 // sent, and false for it not to be encoded and sent. This allows control
470 // across multiple encodings of a sender for turning simulcast layers on and
471 // off.
472 // TODO(webrtc.bugs.org/8807): Updating this parameter will trigger an encoder
473 // reset, but this isn't necessarily required.
deadbeefdbe2b872016-03-22 15:42:00 -0700474 bool active = true;
deadbeefe702b302017-02-04 12:09:01 -0800475
476 // Value to use for RID RTP header extension.
477 // Called "encodingId" in ORTC.
deadbeefe702b302017-02-04 12:09:01 -0800478 std::string rid;
479
480 // RIDs of encodings on which this layer depends.
481 // Called "dependencyEncodingIds" in ORTC spec.
482 // TODO(deadbeef): Not implemented.
483 std::vector<std::string> dependency_rids;
Taylor Brandstetter0cd086b2016-04-20 16:23:10 -0700484
485 bool operator==(const RtpEncodingParameters& o) const {
deadbeefe702b302017-02-04 12:09:01 -0800486 return ssrc == o.ssrc && codec_payload_type == o.codec_payload_type &&
487 fec == o.fec && rtx == o.rtx && dtx == o.dtx &&
Tim Haloun648d28a2018-10-18 16:52:22 -0700488 bitrate_priority == o.bitrate_priority &&
489 network_priority == o.network_priority && ptime == o.ptime &&
Seth Hampson24722b32017-12-22 09:36:42 -0800490 max_bitrate_bps == o.max_bitrate_bps &&
Åsa Persson8c1bf952018-09-13 10:42:19 +0200491 min_bitrate_bps == o.min_bitrate_bps &&
deadbeefe702b302017-02-04 12:09:01 -0800492 max_framerate == o.max_framerate &&
Åsa Persson23eba222018-10-02 14:47:06 +0200493 num_temporal_layers == o.num_temporal_layers &&
deadbeefe702b302017-02-04 12:09:01 -0800494 scale_resolution_down_by == o.scale_resolution_down_by &&
495 scale_framerate_down_by == o.scale_framerate_down_by &&
496 active == o.active && rid == o.rid &&
497 dependency_rids == o.dependency_rids;
Taylor Brandstetter0cd086b2016-04-20 16:23:10 -0700498 }
Taylor Brandstetterdb0cd9e2016-05-16 11:40:30 -0700499 bool operator!=(const RtpEncodingParameters& o) const {
500 return !(*this == o);
501 }
Taylor Brandstetter0cd086b2016-04-20 16:23:10 -0700502};
503
504struct RtpCodecParameters {
Stefan Holmer1acbd682017-09-01 15:29:28 +0200505 RtpCodecParameters();
Mirko Bonadei2ffed6d2018-07-20 11:09:32 +0200506 RtpCodecParameters(const RtpCodecParameters&);
Stefan Holmer1acbd682017-09-01 15:29:28 +0200507 ~RtpCodecParameters();
508
deadbeefe702b302017-02-04 12:09:01 -0800509 // Build MIME "type/subtype" string from |name| and |kind|.
510 std::string mime_type() const { return MediaTypeToString(kind) + "/" + name; }
511
512 // Used to identify the codec. Equivalent to MIME subtype.
513 std::string name;
514
515 // The media type of this codec. Equivalent to MIME top-level type.
516 cricket::MediaType kind = cricket::MEDIA_TYPE_AUDIO;
517
518 // Payload type used to identify this codec in RTP packets.
deadbeefe814a0d2017-02-25 18:15:09 -0800519 // This must always be present, and must be unique across all codecs using
deadbeefe702b302017-02-04 12:09:01 -0800520 // the same transport.
521 int payload_type = 0;
522
523 // If unset, the implementation default is used.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200524 absl::optional<int> clock_rate;
deadbeefe702b302017-02-04 12:09:01 -0800525
526 // The number of audio channels used. Unset for video codecs. If unset for
527 // audio, the implementation default is used.
deadbeefe814a0d2017-02-25 18:15:09 -0800528 // TODO(deadbeef): The "implementation default" part isn't fully implemented.
529 // Only defaults to 1, even though some codecs (such as opus) should really
530 // default to 2.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200531 absl::optional<int> num_channels;
deadbeefe702b302017-02-04 12:09:01 -0800532
533 // The maximum packetization time to be used by an RtpSender.
534 // If |ptime| is also set, this will be ignored.
535 // TODO(deadbeef): Not implemented.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200536 absl::optional<int> max_ptime;
deadbeefe702b302017-02-04 12:09:01 -0800537
538 // The packetization time to be used by an RtpSender.
539 // If unset, will use any time up to max_ptime.
540 // TODO(deadbeef): Not implemented.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200541 absl::optional<int> ptime;
deadbeefe702b302017-02-04 12:09:01 -0800542
543 // Feedback mechanisms to be used for this codec.
deadbeefe814a0d2017-02-25 18:15:09 -0800544 // TODO(deadbeef): Not implemented with PeerConnection senders/receivers.
deadbeefe702b302017-02-04 12:09:01 -0800545 std::vector<RtcpFeedback> rtcp_feedback;
546
547 // Codec-specific parameters that must be signaled to the remote party.
deadbeefe814a0d2017-02-25 18:15:09 -0800548 //
deadbeefe702b302017-02-04 12:09:01 -0800549 // Corresponds to "a=fmtp" parameters in SDP.
deadbeefe814a0d2017-02-25 18:15:09 -0800550 //
551 // Contrary to ORTC, these parameters are named using all lowercase strings.
Åsa Persson90bc1e12019-05-31 13:29:35 +0200552 // This helps make the mapping to SDP simpler, if an application is using SDP.
553 // Boolean values are represented by the string "1".
deadbeefe702b302017-02-04 12:09:01 -0800554 std::unordered_map<std::string, std::string> parameters;
Taylor Brandstetter0cd086b2016-04-20 16:23:10 -0700555
556 bool operator==(const RtpCodecParameters& o) const {
deadbeefe702b302017-02-04 12:09:01 -0800557 return name == o.name && kind == o.kind && payload_type == o.payload_type &&
558 clock_rate == o.clock_rate && num_channels == o.num_channels &&
559 max_ptime == o.max_ptime && ptime == o.ptime &&
560 rtcp_feedback == o.rtcp_feedback && parameters == o.parameters;
Taylor Brandstetter0cd086b2016-04-20 16:23:10 -0700561 }
Taylor Brandstetterdb0cd9e2016-05-16 11:40:30 -0700562 bool operator!=(const RtpCodecParameters& o) const { return !(*this == o); }
skvladdc1c62c2016-03-16 19:07:43 -0700563};
564
Åsa Persson90bc1e12019-05-31 13:29:35 +0200565// RtpCapabilities is used to represent the static capabilities of an endpoint.
566// An application can use these capabilities to construct an RtpParameters.
Mirko Bonadei66e76792019-04-02 11:33:59 +0200567struct RTC_EXPORT RtpCapabilities {
Stefan Holmer1acbd682017-09-01 15:29:28 +0200568 RtpCapabilities();
569 ~RtpCapabilities();
570
deadbeefe702b302017-02-04 12:09:01 -0800571 // Supported codecs.
572 std::vector<RtpCodecCapability> codecs;
573
574 // Supported RTP header extensions.
575 std::vector<RtpHeaderExtensionCapability> header_extensions;
576
deadbeefe814a0d2017-02-25 18:15:09 -0800577 // Supported Forward Error Correction (FEC) mechanisms. Note that the RED,
578 // ulpfec and flexfec codecs used by these mechanisms will still appear in
579 // |codecs|.
deadbeefe702b302017-02-04 12:09:01 -0800580 std::vector<FecMechanism> fec;
581
582 bool operator==(const RtpCapabilities& o) const {
583 return codecs == o.codecs && header_extensions == o.header_extensions &&
584 fec == o.fec;
585 }
586 bool operator!=(const RtpCapabilities& o) const { return !(*this == o); }
587};
588
Florent Castellidacec712018-05-24 16:24:21 +0200589struct RtcpParameters final {
590 RtcpParameters();
Mirko Bonadei2ffed6d2018-07-20 11:09:32 +0200591 RtcpParameters(const RtcpParameters&);
Florent Castellidacec712018-05-24 16:24:21 +0200592 ~RtcpParameters();
593
594 // The SSRC to be used in the "SSRC of packet sender" field. If not set, one
595 // will be chosen by the implementation.
596 // TODO(deadbeef): Not implemented.
Danil Chapovalov0bc58cf2018-06-21 13:32:56 +0200597 absl::optional<uint32_t> ssrc;
Florent Castellidacec712018-05-24 16:24:21 +0200598
599 // The Canonical Name (CNAME) used by RTCP (e.g. in SDES messages).
600 //
601 // If empty in the construction of the RtpTransport, one will be generated by
602 // the implementation, and returned in GetRtcpParameters. Multiple
603 // RtpTransports created by the same OrtcFactory will use the same generated
604 // CNAME.
605 //
606 // If empty when passed into SetParameters, the CNAME simply won't be
607 // modified.
608 std::string cname;
609
610 // Send reduced-size RTCP?
611 bool reduced_size = false;
612
613 // Send RTCP multiplexed on the RTP transport?
614 // Not used with PeerConnection senders/receivers
615 bool mux = true;
616
617 bool operator==(const RtcpParameters& o) const {
618 return ssrc == o.ssrc && cname == o.cname &&
619 reduced_size == o.reduced_size && mux == o.mux;
620 }
621 bool operator!=(const RtcpParameters& o) const { return !(*this == o); }
622};
623
Mirko Bonadeiac194142018-10-22 17:08:37 +0200624struct RTC_EXPORT RtpParameters {
Stefan Holmer1acbd682017-09-01 15:29:28 +0200625 RtpParameters();
Mirko Bonadei2ffed6d2018-07-20 11:09:32 +0200626 RtpParameters(const RtpParameters&);
Stefan Holmer1acbd682017-09-01 15:29:28 +0200627 ~RtpParameters();
628
deadbeefe702b302017-02-04 12:09:01 -0800629 // Used when calling getParameters/setParameters with a PeerConnection
630 // RtpSender, to ensure that outdated parameters are not unintentionally
631 // applied successfully.
deadbeefe702b302017-02-04 12:09:01 -0800632 std::string transaction_id;
633
634 // Value to use for MID RTP header extension.
635 // Called "muxId" in ORTC.
636 // TODO(deadbeef): Not implemented.
637 std::string mid;
638
Taylor Brandstetter0cd086b2016-04-20 16:23:10 -0700639 std::vector<RtpCodecParameters> codecs;
640
deadbeefe702b302017-02-04 12:09:01 -0800641 std::vector<RtpHeaderExtensionParameters> header_extensions;
642
643 std::vector<RtpEncodingParameters> encodings;
644
Florent Castellidacec712018-05-24 16:24:21 +0200645 // Only available with a Peerconnection RtpSender.
646 // In ORTC, our API includes an additional "RtpTransport"
647 // abstraction on which RTCP parameters are set.
648 RtcpParameters rtcp;
649
Florent Castelli87b3c512018-07-18 16:00:28 +0200650 // When bandwidth is constrained and the RtpSender needs to choose between
651 // degrading resolution or degrading framerate, degradationPreference
652 // indicates which is preferred. Only for video tracks.
deadbeefe702b302017-02-04 12:09:01 -0800653 DegradationPreference degradation_preference =
654 DegradationPreference::BALANCED;
655
Taylor Brandstetter0cd086b2016-04-20 16:23:10 -0700656 bool operator==(const RtpParameters& o) const {
deadbeefe702b302017-02-04 12:09:01 -0800657 return mid == o.mid && codecs == o.codecs &&
658 header_extensions == o.header_extensions &&
Florent Castellidacec712018-05-24 16:24:21 +0200659 encodings == o.encodings && rtcp == o.rtcp &&
deadbeefe702b302017-02-04 12:09:01 -0800660 degradation_preference == o.degradation_preference;
Taylor Brandstetter0cd086b2016-04-20 16:23:10 -0700661 }
Taylor Brandstetterdb0cd9e2016-05-16 11:40:30 -0700662 bool operator!=(const RtpParameters& o) const { return !(*this == o); }
skvladdc1c62c2016-03-16 19:07:43 -0700663};
664
665} // namespace webrtc
666
Steve Anton10542f22019-01-11 09:11:00 -0800667#endif // API_RTP_PARAMETERS_H_