package shaka

Get desktop application:
View/edit binary Protocol Buffers messages

• optional bytes content_id = 1

  An identifier supplied by a content provider, used to identify a piece of content and derive key IDs and content keys.

• optional string policy = 2

  A policy name that refers to a stored policy in Widevine service.

• repeated CommonEncryptionRequest.Track tracks = 3

• repeated ModularDrmType drm_types = 4

  Indicates the drm system types whose PSSH should be generated. An empty list implies [ WIDEVINE ].

• optional uint32 first_crypto_period_index = 8

  Optional starting period, if multiple keys are being requested for content that will rotate keys.

• optional uint32 crypto_period_count = 9

  Optional count of periods to return keys for, starting with first_crypto_period_index. If this count is set, then first_crypto_period_index must be provided in the request as well.

• optional bytes pssh_data = 10

  'pssh' box data which can be used in lieu of the content_id field in order to request keys for Widevine CENC content.

• optional uint32 asset_id = 11

  Widevine asset ID which can be used in lieu of the content_id field in order to request keys for Widevine "Classic" packaged content.

• optional bytes group_id = 12

  Optional value which can be used to indicate a group. If present the CommonEncryptionResponse will contain pssh data belonging to this group.

• optional uint32 crypto_period_seconds = 13

  Optional value representing the duration of each crypto period in seconds.

• optional CommonEncryptionRequest.ProtectionScheme protection_scheme = 14

  Protection scheme identifying the encryption algorithm. The protection scheme is represented as a uint32 value. The uint32 contains 4 bytes each representing a single ascii character in one of the 4CC protection scheme values. The protection scheme to set in the generated 'pssh' box data. This protection scheme value may be encoded into the content. If the protection scheme is available in the content, it will supercede this value.

• optional bool enable_entitlement_license = 16

  Enable entitlement license if set to true.

• optional string video_feature = 19

  Video feature identifier, which is used in conjunction with |content_id| to derive key IDs and content keys. For example, it can be used to generate different keys for HDR and SDR. The value is propagated to PSSH. Ignored for tracks with type “AUDIO”. Current values are "HDR".

Used in: CommonEncryptionRequest

• UNSPECIFIED = 0

  Defaults to 'cenc'

• CENC = 1667591779

  'cenc' (AES-CTR) = 0x63656E63

• CBC1 = 1667392305

  'cbc1' (AES-CBC) = 0x63626331

• CENS = 1667591795

  'cens' (AES-CTR subsample) =

• CBCS = 1667392371

  0x63656E73

  'cbcs' (AES-CBC subsample) = 0x63626373

A list of tracks whose PSSHes and keys should be returned.

Used in: CommonEncryptionRequest

• optional string type = 1

• optional CommonEncryptionResponse.Status status = 1

• repeated CommonEncryptionResponse.Drm drm = 3

• repeated CommonEncryptionResponse.Track tracks = 4

• optional bytes content_id = 6

  The content_id associated with the response. The content_id is either the content_id from the request or from the PSSH in the request.

A list of DRM systems whose PSSH is returned.

Used in: CommonEncryptionResponse

• optional ModularDrmType type = 1

  The DRM system, e.g. widevine or playready.

• optional string system_id = 2

  Registered system Id for the DRM system.

Indicates the result of the operation.

Used in: CommonEncryptionResponse

• OK = 0

• SIGNATURE_FAILED = 1

• CONTENT_ID_MISSING = 2

• POLICY_UNKNOWN = 3

• TRACK_TYPE_MISSING = 4

• TRACK_TYPE_UNKNOWN = 5

• MALFORMED_REQUEST = 6

• ACCESS_DENIED = 7

• INTERNAL_ERROR = 8

• INVALID_WIDEVINE_PSSH = 9

• TOO_MANY_CONTENT_SPECIFIERS = 10

• ASSET_NOT_FOUND = 11

• ASSET_MISSING_KEY = 12

• CONTENT_ID_MISMATCH = 13

• KEY_ID_MISMATCH = 14

• INVALID_GROUP_TRACK_TYPE = 15

• KEY_ROTATION_WITH_UNSUPPORTED_DRM_TYPE = 16

• NO_REQUESTED_CRYPTO_PERIODS = 17

A list of tracks and their PSSH and key data. If crypto_period_count was given in the request, then there will be a separate Track message in the response for each period.

Used in: CommonEncryptionResponse

• optional string type = 1

  Track type. SD, HD, UHD1, UHD2 or AUDIO.

• optional bytes key_id = 2

• optional bytes key = 3

• optional bytes iv = 4

• repeated Track.Pssh pssh = 5

• optional uint32 crypto_period_index = 6

Used in: Track

• optional ModularDrmType drm_type = 1

• optional bytes data = 2

  Contains only PSSH data, i.e. no PSSH box header. Can be omitted if |boxes| is present. This field should become deprecated as it may not be populated when entitlement licenses become more widely used.

• optional bytes boxes = 3

  Contains full PSSH boxes (there can be more than one PSSH box). Always populated.

• optional uint32 bandwidth = 1

• optional MediaInfo.VideoInfo video_info = 2

  Note that DASH IOP v3.0 explicitly mentions that a segment should only have one {video, audio, text} track.

• optional MediaInfo.AudioInfo audio_info = 3

• optional MediaInfo.TextInfo text_info = 4

• repeated MediaInfo.ContentProtectionXml content_protections = 5

• optional MediaInfo.ProtectedContent protected_content = 15

  This is set if the content is protected with a content protection, i.e. encrypted.

• optional uint32 reference_time_scale = 13

  This is the reference time scale if there are multiple VideoInfo and/or AudioInfo.

• optional uint64 presentation_time_offset = 16

• optional MediaInfo.ContainerType container_type = 14

• optional Range init_range = 6

  VOD only.

• optional Range index_range = 7

• optional string media_file_name = 8

• repeated Range subsegment_ranges = 23

  END VOD only.

• optional float media_duration_seconds = 9

  VOD and static LIVE.

• optional string init_segment_name = 10

  LIVE only.

• optional string segment_template = 11

• optional float segment_duration_seconds = 12

  This value is the user input “segment duration”. This value is not necessarily the same as the value passed to MpdNotifier::NotifyNewSegment().

  END LIVE only.

• optional string media_file_url = 17

  URL fields for the corresponding file_name fields above. The file names are adjusted to be relative to DASH MPD or HLS media playlist, or with base url prepended.

• optional string init_segment_url = 18

• optional string segment_template_url = 19

• repeated string hls_characteristics = 20

  HLS only. Defines CHARACTERISTICS attribute of the stream.

• repeated string dash_accessibilities = 21

  DASH only. Defines Accessibility elements of the stream. It should be in the format: scheme_id_uri=value.

• repeated string dash_roles = 22

  DASH only. Defines Role elements of the stream. The value can be a valid Role value defined in "urn:mpeg:dash:role:2011" scheme or in the format: scheme_id_uri=value (to be implemented).

• optional double availability_time_offset = 24

  LOW LATENCY DASH only. Defines the availabilityTimeOffset in seconds. Equal to the segment time minus the chunk duration.

• optional uint64 segment_duration = 25

  LOW LATENCY DASH only. Defines the segment duration with respect to the reference time scale. Equal to the target segment duration times the reference time scale.

• optional bool forced_subtitle = 26

  Marks stream as a Forced Narrative subtitle stream, indicated using forced-subtitle role in DASH and FORCED=YES in HLS

• optional uint32 index = 28

  stream index for consistent ordering of streams

• optional string dash_label = 29

  DASH only. Label element.

Used in: AudioInfo

• optional uint32 channel_mask = 1

  EC3 Channel map bit fields, encoded based on ETSI TS 102 366 V1.3.1 Digital Audio Compression (AC-3, Enhanced AC-3) Standard E.1.3.1.8. Or AC4 Channel mask bit fields, encoded based on ETSI TS 103 190-2 V1.2.1 Digital Audio Compression (AC-4) Standard; Part 2: Immersive and personalized audio E.10.14.

• optional uint32 channel_mpeg_value = 2

  EC3 Channel configuration descriptor with MPEG scheme fields, encoded based on ETSI TS 102 366 V1.4.1 Digital Audio Compression (AC-3, Enhanced AC-3) Standard I.1.2.1. Or AC4 Channel configuration descriptor with MPEG scheme fields, encoded based on ETSI TS 103 190-2 V1.2.1 Digital Audio Compression (AC-4) Standard; Part 2: Immersive and personalized audio G.3.2.

• optional uint32 ec3_joc_complexity = 3

  Dolby Digital Plus JOC decoding complexity fields, ETSI TS 103 420 v1.2.1 Backwards-compatible object audio carriage using Enhanced AC-3 Standard C.3.2.3.

• optional bool ac4_ims_flag = 4

  AC4 Immersive stereo flag field, based on Dolby AC-4 in MPEG-DASH for Online Delivery Specification 2.5.3. https://developer.dolby.com/tools-media/online-delivery-kits/dolby-ac-4/

• optional bool ac4_cbi_flag = 5

  AC4 Channel-based audio (CBI) flag field, encoded based on ETSI TS 103 190-2 Digital Audio Compression (AC-4) Standard; Part 2: Immersive and personalized audio 4.3.

Used in: MediaInfo

• optional string codec = 1

• optional uint32 sampling_frequency = 2

• optional uint32 time_scale = 3

• optional uint32 num_channels = 4

• optional string language = 5

• optional bytes decoder_config = 6

• optional AudioCodecSpecificData codec_specific_data = 7

Used in: MediaInfo

• CONTAINER_UNKNOWN = 0

• CONTAINER_MP4 = 1

• CONTAINER_MPEG2_TS = 2

• CONTAINER_WEBM = 3

• CONTAINER_TEXT = 4

• CONTAINER_PACKED_AUDIO = 5

TODO(rkuroiwa): Remove this. <ContentProtection> element that must be added should be done by directly using the MpdBuilder interface. Use this to specify ContentProtection elements that should be set in the MPD, if ContentProtectionEntry is not sufficient.

Used in: MediaInfo

• optional string scheme_id_uri = 1

  These two string fields are specified by the MPD spec. Just for clarification, the string set in |value| is the rhs of 'value' field in <ContentProtection>.

• optional string value = 2

• repeated ContentProtectionXml.AttributeNameValuePair attributes = 3

• repeated ContentProtectionXml.Element subelements = 4

Used in: ContentProtectionXml, Element

• optional string name = 1

• optional string value = 2

Used in: ContentProtectionXml

• optional string name = 1

• repeated AttributeNameValuePair attributes = 2

• repeated Element subelements = 3

Used in: MediaInfo

• optional bytes default_key_id = 1

  The default key ID for the encrypted media.

• repeated ProtectedContent.ContentProtectionEntry content_protection_entry = 2

• optional string protection_scheme = 3

  Specifies the protection scheme: 'cenc', 'cens', 'cbc1', 'cbcs'. "cbca" is also valid which is a place holder for SAMPLE-AES encryption.

• optional bool include_mspr_pro = 4

Used in: ProtectedContent

• optional string uuid = 1

  Human readable UUID of the DRM.

• optional string name_version = 2

  Human readable DRM name and version string. e.g. "My Content Protection v1.0"

• optional bytes pssh = 3

  The raw 'pssh' box for the media.

Used in: MediaInfo

• optional string codec = 1

• optional string language = 2

• optional TextInfo.TextType type = 3

Used in: TextInfo

• UNKNOWN = 0

• CAPTION = 1

• SUBTITLE = 2

Used in: MediaInfo

• optional string codec = 1

• optional uint32 width = 2

  The width and height of the actual number of pixels. This will not be the same as the visual width and height if the sample aspect ratio (sar) is not 1:1.

• optional uint32 height = 3

• optional uint32 time_scale = 4

• optional uint64 frame_duration = 5

  Relative to |time_scale|. IOW |time_scale| / |frame_duration| is the framerate.

• optional bytes decoder_config = 6

• optional uint32 pixel_width = 7

  pixel_width:pixel_height is the the sample aspect ratio (sar) of the video. Note that (pixel_width * width):(pixel_height * height) is the picture aspect ratio, or the @par attribute set on AdaptationSet element.

• optional uint32 pixel_height = 8

• optional uint32 playback_rate = 9

  playback_rate: the playout capability (e.g., 4x, 8x, 16x fast foward) of the trick play stream.

• optional uint32 transfer_characteristics = 10

  Transfer characteristics. Useful to determine the VIDEO-RANGE for HLS, i.e. whether it is SDR or HDR.

• optional uint32 color_primaries = 11

• optional uint32 matrix_coefficients = 12

• optional string supplemental_codec = 13

  Fro Dolby Vision back compatiable content.

• optional uint32 compatible_brand = 14

Used in: CommonEncryptionRequest, CommonEncryptionResponse.Drm, CommonEncryptionResponse.Track.Pssh

• WIDEVINE = 0

Used in: MediaInfo

• optional uint64 begin = 1

• optional uint64 end = 2

A generic protobuf used as the request format of various Modular DRM APIs.

• optional bytes request = 1

• optional bytes signature = 2

• optional string signer = 3

  Identifies the entity sending / signing the request.

• optional bytes response = 1

• optional bytes signature = 2