Copyright © 2024 World Wide Web Consortium. W3C® liability, trademark and permissive document license rules apply.
This document defines a set of ECMAScript APIs in WebIDL to extend the WebRTC specification to enable configuration of encoding parameters for Scalable Video Coding (SVC). Discovery of SVC encoder and decoder capabilities is handled by the Media Capabilities specification.
This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/.
The API is based on preliminary work done in the W3C ORTC Community Group.
This document was published by the Web Real-Time Communications Working Group as a Working Draft using the Recommendation track.
Publication as a Working Draft does not imply endorsement by W3C and its Members.
This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.
This document was produced by a group operating under the W3C Patent Policy. W3C maintains a public list of any patent disclosures made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.
This document is governed by the 03 November 2023 W3C Process Document.
This section is non-normative.
This specification extends the WebRTC specification [WEBRTC] to enable configuration of encoding parameters for Scalable Video Coding (SVC). Discovery of SVC encoder and decoder capabilities is handled by the Media Capabilities API [Media-Capabilities].
      This specification does not change the behavior of WebRTC objects and
      methods. Therefore, restrictions relating to Offer/Answer negotiation and
      encoding parameters remain, as described in [WEBRTC] Section 5.2:
      "setParameters() does not cause SDP renegotiation and can
      only be used to change what the media stack is sending or receiving within the
      envelope negotiated by Offer/Answer."
    
As a result, this specification can configure encoding parameters for codecs that do not negotiate SVC support in Offer/Answer, such as the VP8 [RFC6386], VP9 [VP9] and AV1 [AV1] codecs. Configuraton of temporal scalability can also be supported for the H.264 [ITU-T-REC-H.264] and H.265 [ITU-T-REC-H.265] codecs.
As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.
The key words MAY, MUST, and SHOULD in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.
This specification defines conformance criteria that apply to a single product: the user agent that implements the interfaces that it contains.
Conformance requirements phrased as algorithms or specific steps may be implemented in any manner, so long as the end result is equivalent. In particular, the algorithms defined in this specification are intended to be easy to follow, and not intended to be performant.
Implementations that use ECMAScript to implement the APIs defined in this specification MUST implement them in a manner consistent with the ECMAScript Bindings defined in the Web IDL specification [WEBIDL], as this specification uses that specification and terminology.
The term "simulcast envelope" is defined in [WEBRTC] Section 5.4.1.
This specification references objects, methods, internal slots and dictionaries defined in [WEBRTC].
For Scalable Video Coding (SVC), the terms "single-session transmission" (SST) and "multi-session transmission" (MST) are defined in [RFC6190]. This specification only supports SST but not MST.
The term "Single Real-time Transport Protocol stream Single Transport" (SRST), defined in [RFC7656] Section 3.7, refers to SVC implementations that transmit all layers within a single transport, using a single Real-time Transport Protocol (RTP) stream and synchronization source (SSRC). The term "Multiple RTP stream Single Transport" (MRST), also defined in [RFC7656] Section 3.7, refers to implementations that transmit all layers within a single transport, using multiple RTP streams with a distinct SSRC for each layer. This specification only supports SRST, not MRST. Codecs with RTP payload specifications supporting SRST include VP8 [RFC7741], VP9 [VP9-PAYLOAD], AV1 [AV1-RTP-SPEC], H.264 [RFC6184] and H.265 [RFC7798].
        The term "S mode" refers to a scalability mode in which multiple
        encodings are sent on the same SSRC. This includes the "S2T1", "S2T1h",
        "S2T2", "S2T2h", "S2T3", "S2T3h", "S3T1", "S3T1h", "S3T2", "S3T2h",
        "S3T3" and "S3T3h" scalabilityMode values.
      
The term Selective Forwarding Middlebox (SFM) is defined in Section 3.7 of [RFC7667].
        This specification enables the configuration of encoding parameters for SVC
        by extending the RTCRtpEncodingParameters dictionary.
      
RTCRtpEncodingParameters Dictionary ExtensionsWebIDLpartial dictionary RTCRtpEncodingParameters {
             DOMString scalabilityMode;
};
        RTCRtpEncodingParameters MembersscalabilityMode of type DOMStringA case-sensitive identifier of the scalability mode to be used for this stream. Scalability modes are defined in Section 5.
          [WEBRTC] describes error handling in addTransceiver()
          (Section 5.1) and setParameters() (Section 5.2),
          including use of RTCError to indicate a
          "hardware-encoder-error"
          due to an unsupported encoding parameter, as well as other errors.
          Implementations utilize RTCError and other errors
          in the prescribed manner when an invalid
          scalabilityMode value is provided to
          setParameters() or addTransceiver().
        
addTransceiver()
           [WEBRTC] Section 5.1 describes validation of
           sendEncodings within
           addTransceiver(). To validate
           scalabilityMode, add
           the following steps after step 3 of
           addTransceiver sendEncodings validation steps:
           
RTCRtpEncodingParameters.codec
               value codec exists and where the same encoding's scalabilityMode
               value is not supported by codec, throw an OperationError.
             scalabilityMode value is
               not supported by any codec in the list of implemented send codecs
               for kind, throw an OperationError.
             RTCRtpEncodingParameters stored in
               sendEncodings contains more than 1
               encoding with an active
               member with a value of true and
               sendEncodings contains any encoding whose
               scalabilityMode value
               represents an "S mode" and whose
               active member has a
               value of true, throw an
               OperationError.
             
           When the addTransceiver() and
           setCodecPreferences() methods are called
           prior to conclusion of the Offer/Answer negotiation, the negotiated
           codec and its capabilities may not be known. In this situation the
           scalabilityMode values configured
           in sendEncodings may not be supported
           by the eventually negotiated codec. However, an error will only result
           if the requested scalabilityMode value is
           invalid for any supported codec, or if mixed simulcast transport is requested.
        
          So as to ensure that the desired scalabilityMode
          values can be applied, setCodecPreferences() can be
          used to prefer or only include codecs supporting the desired configuration.
          For example, if temporal scalability is desired along with spatial simulcast,
          when addTransceiver() is called,
          sendEncodings can be configured to send multiple
          simulcast streams with different resolutions, with each stream
          utilizing temporal scalability. If only the VP8, VP9 and AV1 codec implementations
          support temporal scalability, setCodecPreferences()
          can be used to remove the H.264/AVC codec from the Offer, improving the
          chances that a codec supporting temporal scalability is negotiated.
        
          When sendEncodings is used to
          request the sending of multiple simulcast streams using
          addTransceiver(), an "S mode" cannot
          be requested. The browser may only be configured to send
          simulcast encodings with multiple SSRCs and RIDs, or
          alternatively, to send all simulcast encodings on a single
          RTP stream. Simultaneously using both simulcast transport
          techniques is not permitted.
        
setParameters()
           [WEBRTC] Section 5.2 describes validation of parameters
           within setParameters(). Insert the following
           conditions under which the operation causes a promise rejected
           with an InvalidModificationError (step 4) of
           setParameters validation steps:
           
RTCRtpEncodingParameters.codec value codec, where the same encoding's
               scalabilityMode value is not supported by codec.
             [[SendCodecs]] is empty
               and encodings contains any encoding whose
               scalabilityMode value is
               not supported by any codec in the
               list of implemented send codecs for kind.
             [[SendCodecs]] is not empty
               and encodings contains an encoding whose
               scalabilityMode value is
               not supported by the codec used for the encoding's RTP stream.
             RTCRtpEncodingParameters stored in
               encodings contains more than one
               encoding with an active
               member with a value of true and
               encodings contains any encoding whose
               scalabilityMode value
               represents an "S mode" and whose
               active member has a
               value of true.
             
           The "L1T1" scalability mode enables SVC encoding to be turned off
           using setParameters(). If "L1T1" is set using
           setParameters() then it will be returned in response
           to getParameters().
         
getParameters()
           Before the initial negotiation has completed,
           getParameters() returns the
           scalabilityMode value for each
           encoding in encodings, as last set by
           addTransceiver() or
           setParameters(). If no
           scalabilityMode value
           was provided for an encoding in encodings,
           or if a value was not successfully set, then
           getParameters() will not return a
           scalabilityMode value
           for that encoding.
         
           After the initial negotiation has completed, getParameters()
           returns the currently configured scalabilityMode
           value for each encoding in encodings which had a value before the
           initial negotiation. This MAY be different from the values requested in
           addTransceiver() or setParameters().
           For example, if the codecs selected during negotiation do not include an
           encoder supporting the desired scalabilityMode
           value, the user agent MAY select another value. If the configuration is not
           satisfactory, setParameters() can be used to change it.
         
           If addTransceiver() or setParameters()
           did not provide a scalabilityMode value for
           an encoding in encodings, then after the initial negotiation
           has completed, getParameters() will not return a
           scalabilityMode value and the encoder will use
           the default scalabilityMode of the codec for
           that encoding's RTP stream. The default scalabilityMode
           for each codec is implementation dependent. The default
           scalabilityMode SHOULD be one of the
           temporal scalability modes (e.g. "L1T1","L1T2","L1T3", etc.).
         
This section is non-normative.
SVC is most often employed in video conferencing, where a conferencing server such as a SFM selectively forwards layers to participants based on their device characteristics and available bandwidth. In such an environment, the application will negotiate codecs to be sent and received with the conferencing server. However, since scalability modes are not negotiated in Offer/Answer, the application needs to determine which scalability modes the browser and conference server support by other means.
            The [Media-Capabilities] API enables discovery of encoder and decoder
            support for scalable video coding. scalabilityMode
            is used to query whether an encoder supports a 
            scalabilityMode value, indicating whether
            it is "supported", "smooth" and "power efficient".
          
            The [Media-Capabilities] API also provides information on decoder support
            for spatial scalablity modes. spatialScalability
            indicates whether a decoder has the ability to support spatial prediction,
            which requires the ability to use frames of a resolution different than
            the current resolution as a dependency. If spatialScalability
            is set to true, the decoder can decode any
            scalabilityMode value supported by the encoder.
            If spatialScalability is set to false
            or is absent, the decoder cannot decode spatial scalability modes, but can
            can decode all other scalabilityMode values
            supported by the encoder.
          
  
            Once an application has determined which combination of codecs and
            scalabilityMode values it has available to use,
            it needs to determine which of these combinations are supported by the SFM. 
            One way to handle this is for the SFM to indicate the combination of codecs
            and scalability modes it can forward in the form of receiver capabilities
            After receiving the SFM's capabilities, the application can compute the
            intersection of codec and scalabilityMode values
            supported by the browser's RTCRtpSender and the
            SFM's receiver. This
            can be used to determine the arguments passed to the browser's
            addTransceiver() and setParameters()
            methods.
          
Here are some examples:
            There are situations in which computing the intersection of the browser and
            SFM capabilities needs to take RTP header extensions into account. If the
            SFM cannot parse codec payloads
            (either because it is not designed to do so, or because the payloads are encrypted), 
            then negotiation of an RTP header extension (such as the AV1 Dependency Descriptor
            defined in Appendix A of [AV1-RTP-SPEC]) could be required for the
            SFM to forward a particular codec.
            To take this into account, the RTP header extensions required for forwarding of a 
            codec could be added to the SFM's receiver capabilities. The application could
            then compute the intersection of codec, header extension and
            scalabilityMode values supported
            by the browser's RTCRtpSender and the
            SFM's receiver.
          
      The scalabilityMode values supported in this specification,
      as well as their associated identifiers and characteristics, are provided in the table
      below. The names of the scalabilityMode values (which are
      case sensitive) are provided, along with the scalability mode identifiers assigned in
      [AV1] Section 6.7.5, and links to dependency diagrams provided in Section 9.
    
      While the [AV1] and VP9 [VP9] specifications support all the
      scalabilityMode values defined in the table, other codec
      specifications do not. For example, VP8 [RFC6386], H.264 [RFC6184] and
      H.265 [RFC7798] only support temporal scalability (e.g. "L1T2", "L1T3").
      Also VP8 [RFC6386], H.264 [RFC6184] and H.265 [RFC7798] only permit transport
      of simulcast on distinct SSRCs, so that "S" modes (where multiple encodings are
      transported on a single RTP stream) are not supported.
    
| Scalability Mode Identifier | Spatial Layers | Resolution Ratio | Temporal Layers | Inter-layer dependency | AV1 scalability_mode_idc | 
|---|---|---|---|---|---|
| "L1T1" | 1 | 1 | N/A | ||
| "L1T2" | 1 | 2 | SCALABILITY_L1T2 | ||
| "L1T3" | 1 | 3 | SCALABILITY_L1T3 | ||
| "L2T1" | 2 | 2:1 | 1 | Yes | SCALABILITY_L2T1 | 
| "L2T2" | 2 | 2:1 | 2 | Yes | SCALABILITY_L2T2 | 
| "L2T3" | 2 | 2:1 | 3 | Yes | SCALABILITY_L2T3 | 
| "L3T1" | 3 | 2:1 | 1 | Yes | SCALABILITY_L3T1 | 
| "L3T2" | 3 | 2:1 | 2 | Yes | SCALABILITY_L3T2 | 
| "L3T3" | 3 | 2:1 | 3 | Yes | SCALABILITY_L3T3 | 
| "L2T1h" | 2 | 1.5:1 | 1 | Yes | SCALABILITY_L2T1h | 
| "L2T2h" | 2 | 1.5:1 | 2 | Yes | SCALABILITY_L2T2h | 
| "L2T3h" | 2 | 1.5:1 | 3 | Yes | SCALABILITY_L2T3h | 
| "L3T1h" | 3 | 1.5:1 | 1 | Yes | |
| "L3T2h" | 3 | 1.5:1 | 2 | Yes | |
| "L3T3h" | 3 | 1.5:1 | 3 | Yes | |
| "S2T1" | 2 | 2:1 | 1 | No | SCALABILITY_S2T1 | 
| "S2T2" | 2 | 2:1 | 2 | No | SCALABILITY_S2T2 | 
| "S2T3" | 2 | 2:1 | 3 | No | SCALABILITY_S2T3 | 
| "S2T1h" | 2 | 1.5:1 | 1 | No | SCALABILITY_S2T1h | 
| "S2T2h" | 2 | 1.5:1 | 2 | No | SCALABILITY_S2T2h | 
| "S2T3h" | 2 | 1.5:1 | 3 | No | SCALABILITY_S2T3h | 
| "S3T1" | 3 | 2:1 | 1 | No | SCALABILITY_S3T1 | 
| "S3T2" | 3 | 2:1 | 2 | No | SCALABILITY_S3T2 | 
| "S3T3" | 3 | 2:1 | 3 | No | SCALABILITY_S3T3 | 
| "S3T1h" | 3 | 1.5:1 | 1 | No | SCALABILITY_S3T1h | 
| "S3T2h" | 3 | 1.5:1 | 2 | No | SCALABILITY_S3T2h | 
| "S3T3h" | 3 | 1.5:1 | 3 | No | SCALABILITY_S3T3h | 
| "L2T2_KEY" | 2 | 2:1 | 2 | Yes | SCALABILITY_L3T2_KEY | 
| "L2T2_KEY_SHIFT" | 2 | 2:1 | 2 | Yes | SCALABILITY_L3T2_KEY_SHIFT | 
| "L2T3_KEY" | 2 | 2:1 | 3 | Yes | SCALABILITY_L3T3_KEY | 
| "L2T3_KEY_SHIFT" | 2 | 2:1 | 3 | Yes | SCALABILITY_L3T3_KEY_SHIFT | 
| "L3T1_KEY" | 3 | 2:1 | 1 | Yes | |
| "L3T2_KEY" | 3 | 2:1 | 2 | Yes | SCALABILITY_L4T5_KEY | 
| "L3T2_KEY_SHIFT" | 3 | 2:1 | 2 | Yes | SCALABILITY_L4T5_KEY_SHIFT | 
| "L3T3_KEY" | 3 | 2:1 | 3 | Yes | SCALABILITY_L4T7_KEY | 
| "L3T3_KEY_SHIFT" | 3 | 2:1 | 3 | Yes | SCALABILITY_L4T7_KEY_SHIFT | 
scalabilityMode valuesWhen proposing a scalabilityMode value, the following principles should be followed:
scalabilityMode MUST define entries to the table in
            Section 5, including values for the Scalabilty Mode Identifier, spatial and
            temporal layers, Resolution Ratio, Inter-layer dependency and the corresponding
            AV1 scalability_mode_idc value (if assigned).
          LxTy to denote a scalabilityMode with x
            spatial layers using a 2:1 resolution ratio and y temporal layers.
            LxTyh denotes x spatial layers with a 1.5:1 resolution ratio and
            y temporal layers. SxTy denotes a scalabilityMode
            with x simulcast encodings with a 2:1 resolution ratio, with each
            simulcast encoding containing y temporal layers. SxTyh denotes
            a 1.5:1 resolution ratio. LxTy_KEY denotes a scalabilityMode
            with x spatial layers using a 2:1 resolution ratio and y temporal layers in which spatial layers only
            depend on lower spatial layers at a key frame. LxTy_KEY_SHIFT modes denotes a
            scalabilityMode with x spatial layers using a 2:1 resolution ratio and
            y temporal layers in which spatial layers only depend on lower spatial layers at a key frame and subsequent
            frames have their temporal identifier shifted upward.
          This section is non-normative.
This example extends [WEBRTC] Section 7.1 (Example 1) to demonstrate sending three spatial simulcast layers each with three temporal layers, using an SSRC and RID for each simulcast layer. Only the "sendEncodings" attribute is changed from the original example.
const signaling = new SignalingChannel(); // handles JSON.stringify/parse
const constraints = {audio: true, video: true};
const configuration = {'iceServers': [{'urls': 'stun:stun.example.org'}]};
let pc;
// call start() to initiate
async function start() {
  pc = new RTCPeerConnection(configuration);
  // let the "negotiationneeded" event trigger offer generation
  pc.onnegotiationneeded = async () => {
    try {
      await pc.setLocalDescription();
      // send the offer to the other peer
      signaling.send({description: pc.localDescription});
    } catch (err) {
      console.error(err);
    }
  };
  try {
    // get a local stream, show it in a self-view and add it to be sent
    const stream = await navigator.mediaDevices.getUserMedia(constraints);
    selfView.srcObject = stream;
    pc.addTransceiver(stream.getAudioTracks()[0], {direction: 'sendonly'});
    pc.addTransceiver(stream.getVideoTracks()[0], {
      direction: 'sendonly',
      sendEncodings: [
        {rid: 'q', scaleResolutionDownBy: 4.0, scalabilityMode: 'L1T3'},
        {rid: 'h', scaleResolutionDownBy: 2.0, scalabilityMode: 'L1T3'},
        {rid: 'f', scalabilityMode: 'L1T3'}
      ]
    });
  } catch (err) {
    console.error(err);
  }
}
signaling.onmessage = async ({data: {description, candidate}}) => {
  try {
    if (description) {
      await pc.setRemoteDescription(description);
      // if we got an offer, we need to reply with an answer
      if (description.type == 'offer') {
        await pc.setLocalDescription();
        signaling.send({description: pc.localDescription});
      }
    } else if (candidate) {
      await pc.addIceCandidate(candidate);
    }
  } catch (err) {
    console.error(err);
  }
};This is an example with two spatial layers (with a 2:1 ratio) and three temporal layers.
let sendEncodings = [
  {scalabilityMode: 'L2T3'}
];This is an example of mixed codec simulcast, with each simulcast layer having 3 temporal layers.
let sendEncodings = [
  {rid: 'q', codec: {clockRate: 90000, mimeType: 'video/AV1'}, scaleResolutionDownBy: 4.0, scalabilityMode: 'L1T3'},
  {rid: 'h', codec: {clockRate: 90000, mimeType: 'video/VP8'}, scaleResolutionDownBy: 2.0, scalabilityMode: 'L1T3'},
  {rid: 'f', codec: {clockRate: 90000, mimeType: 'video/VP8'}, scalabilityMode: 'L1T3'}
];This is an example with three spatial simulcast layers each with three temporal layers on a single SSRC.
let sendEncodings = [
  {scalabilityMode: 'S3T3'}
]This section is non-normative.
        This is an example of encodingInfo(configuration)
        returned by a browser implementing [WEBRTC] and [Media-Capabilities].
      
const contentType = 'video/VP9';
const configuration = {
  type: 'webrtc',
  video: {
    contentType,
    width: 640,
    height: 480,
    bitrate: 10000,
    framerate: 29.97,
    scalabilityMode: 'L3T3_KEY'
  }
};
try {
  const info = await navigator.mediaCapabilities.encodingInfo(configuration);
  if (!info.supported) {
    console.log(`${contentType} is unsupported.`);
    return;
  }
  console.log(`${contentType} is ${info.smooth || 'NOT '}smooth, and ` +
              `${info.powerEfficient || 'NOT '}power efficient`);
} catch (err) {
  console.error(err, ' caused encodingInfo to fail');
}This section is non-normative.
This is an example of receiver capabilities returned by an SFM that only supports forwarding of VP8, VP9 and AV1 temporal scalability modes.
 "codecs": [
    {
      "clockRate": 90000,
      "mimeType": "video/VP8",
      "scalabilityModes": [
        "L1T1",
        "L1T2",
        "L1T3"
      ]
    },
    {
      "clockRate": 90000,
      "mimeType": "video/VP9",
      "scalabilityModes": [
        "L1T1",
        "L1T2",
        "L1T3"
      ]
    },
    {
      "clockRate": 90000,
      "mimeType": "video/AV1",
      "scalabilityModes": [
        "L1T1",
        "L1T2",
        "L1T3"
      ]
    }
]This section is non-normative.
This section is non-normative; it specifies no new behaviour, but instead summarizes information already present in other parts of the specification. The privacy considerations for the WebRTC APIs are described in [WEBRTC] Section 13.
        In WebRTC, the use of scalable coding tools is not
        negotiated between peers, so neither supported
        scalabilityMode values nor
        decoder support for spatial prediction is exposed in SDP.
      
        By attempting to set
        scalabilityMode values for
        each codec using the setParameters() API,
        an application can determine the values supported by the
        encoder, by noting which configuration attempts succeed
        and which ones fail. However, this does not indicate
        whether a scalabilityMode
        value is supported by a hardware or software encoder
        (or both). Since setParameters()
        is not supported for the RTCRtpReceiver, equivalent
        experiments cannot be run to determine decoder support.
      
        Since the scalabilityMode 
        values supported by software encoders are typically
        a superset of those supported in hardware, the information
        available from these experiments has a high correlation
        with the browser in use, which is already available to
        web pages. Once media is flowing, information on
        performance characteristics or whether a
        scalabilityMode value
        is decodable for the codec in use can be obtained,
        which provides more information on hardware capabilities.
      
As noted in [Media-Capabilities] Section 3.1, the Media Capabilities API "will likely provide more accurate and consistent information" than is available from this specification. As noted in [Media-Capabilities] Section 3.1, "This information is expected to have a high correlation with other information already available to the web pages as a given class of device is expected to have very similar decoding/encoding capabilities."
This section is non-normative.
This section is non-normative; it specifies no new behaviour, but instead summarizes information already present in other parts of the specification. WebRTC protocol security considerations are described in [RFC8827] and the security and privacy considerations for the WebRTC APIs are described in [WEBRTC] Section 13.
Dependency diagrams for the scability modes defined in this specification are provided below.
The editors wish to thank Robin Raymond, Michael Horowitz, Harald Alvestrand, Chris Cunningham, Danil Chapovalov, Florent Castelli, Erik Språng and Henrik Boström for their contributions to this specification, which evolved from the ORTC API developed in the W3C ORTC CG.
Referenced in:
Referenced in: