Codec utilities

GstPbutils.H264LevelLimits

Since : 1.30

GstPbutils.prototype.codec_utils_aac_caps_set_level_and_profile

function GstPbutils.prototype.codec_utils_aac_caps_set_level_and_profile(caps: Gst.Caps, audio_config: [ Number ], len: Number): {
    // javascript wrapper for 'gst_codec_utils_aac_caps_set_level_and_profile'
}

Sets the level and profile on caps if it can be determined from audio_config. See GstPbutils.prototype.codec_utils_aac_get_level and GstPbutils.prototype.codec_utils_aac_get_profile for more details on the parameters. caps must be audio/mpeg caps with an "mpegversion" field of either 2 or 4. If mpegversion is 4, the "base-profile" field is also set in caps.

GstPbutils.prototype.codec_utils_aac_get_channels

function GstPbutils.prototype.codec_utils_aac_get_channels(audio_config: [ Number ], len: Number): {
    // javascript wrapper for 'gst_codec_utils_aac_get_channels'
}

Returns the channels of the given AAC stream.

Since : 1.10

GstPbutils.prototype.codec_utils_aac_get_index_from_sample_rate

function GstPbutils.prototype.codec_utils_aac_get_index_from_sample_rate(rate: Number): {
    // javascript wrapper for 'gst_codec_utils_aac_get_index_from_sample_rate'
}

Translates the sample rate to the index corresponding to it in AAC spec.

GstPbutils.prototype.codec_utils_aac_get_level

function GstPbutils.prototype.codec_utils_aac_get_level(audio_config: [ Number ], len: Number): {
    // javascript wrapper for 'gst_codec_utils_aac_get_level'
}

Determines the level of a stream as defined in ISO/IEC 14496-3. For AAC LC streams, the constraints from the AAC audio profile are applied. For AAC Main, LTP, SSR and others, the Main profile is used.

The audio_config parameter follows the following format, starting from the most significant bit of the first byte:

• Bit 0:4 contains the AudioObjectType (if this is 0x5, then the real AudioObjectType is carried after the rate and channel data)
• Bit 5:8 contains the sample frequency index (if this is 0xf, then the next 24 bits define the actual sample frequency, and subsequent fields are appropriately shifted).
• Bit 9:12 contains the channel configuration

GstPbutils.prototype.codec_utils_aac_get_profile

function GstPbutils.prototype.codec_utils_aac_get_profile(audio_config: [ Number ], len: Number): {
    // javascript wrapper for 'gst_codec_utils_aac_get_profile'
}

Returns the profile of the given AAC stream as a string. The profile is normally determined using the AudioObjectType field which is in the first 5 bits of audio_config

GstPbutils.prototype.codec_utils_aac_get_sample_rate

function GstPbutils.prototype.codec_utils_aac_get_sample_rate(audio_config: [ Number ], len: Number): {
    // javascript wrapper for 'gst_codec_utils_aac_get_sample_rate'
}

Translates the sample rate index found in AAC headers to the actual sample rate.

Since : 1.10

GstPbutils.prototype.codec_utils_aac_get_sample_rate_from_index

function GstPbutils.prototype.codec_utils_aac_get_sample_rate_from_index(sr_idx: Number): {
    // javascript wrapper for 'gst_codec_utils_aac_get_sample_rate_from_index'
}

Translates the sample rate index found in AAC headers to the actual sample rate.

GstPbutils.prototype.codec_utils_av1_create_av1c_from_caps

function GstPbutils.prototype.codec_utils_av1_create_av1c_from_caps(caps: Gst.Caps): {
    // javascript wrapper for 'gst_codec_utils_av1_create_av1c_from_caps'
}

Creates the corresponding AV1 Codec Configuration Record

Since : 1.26

GstPbutils.prototype.codec_utils_av1_create_caps_from_av1c

function GstPbutils.prototype.codec_utils_av1_create_caps_from_av1c(av1c: Gst.Buffer): {
    // javascript wrapper for 'gst_codec_utils_av1_create_caps_from_av1c'
}

Parses the provided av1c and returns the corresponding caps

Since : 1.26

GstPbutils.prototype.codec_utils_av1_get_level

function GstPbutils.prototype.codec_utils_av1_get_level(seq_level_idx: Number): {
    // javascript wrapper for 'gst_codec_utils_av1_get_level'
}

Transform a seq_level_idx into the level string

Since : 1.26

GstPbutils.prototype.codec_utils_av1_get_seq_level_idx

function GstPbutils.prototype.codec_utils_av1_get_seq_level_idx(level: String): {
    // javascript wrapper for 'gst_codec_utils_av1_get_seq_level_idx'
}

Transform a level string from the caps into the seq_level_idx

Since : 1.26

GstPbutils.prototype.codec_utils_caps_from_mime_codec

function GstPbutils.prototype.codec_utils_caps_from_mime_codec(codecs_field: String): {
    // javascript wrapper for 'gst_codec_utils_caps_from_mime_codec'
}

Converts a RFC 6381 compatible codec string to Gst.Caps. More than one codec string can be present (separated by ,).

Registered codecs can be found at http://mp4ra.org/#/codecs

Since : 1.22

GstPbutils.prototype.codec_utils_caps_get_mime_codec

function GstPbutils.prototype.codec_utils_caps_get_mime_codec(caps: Gst.Caps): {
    // javascript wrapper for 'gst_codec_utils_caps_get_mime_codec'
}

Converts caps to a RFC 6381 compatible codec string if possible.

Useful for providing the 'codecs' field inside the 'Content-Type' HTTP header for containerized formats, such as mp4 or matroska.

Registered codecs can be found at http://mp4ra.org/#/codecs

Since : 1.20

GstPbutils.prototype.codec_utils_h264_caps_set_level_and_profile

function GstPbutils.prototype.codec_utils_h264_caps_set_level_and_profile(caps: Gst.Caps, sps: [ Number ], len: Number): {
    // javascript wrapper for 'gst_codec_utils_h264_caps_set_level_and_profile'
}

Sets the level and profile in caps if it can be determined from sps. See GstPbutils.prototype.codec_utils_h264_get_level and GstPbutils.prototype.codec_utils_h264_get_profile for more details on the parameters.

GstPbutils.prototype.codec_utils_h264_get_level

function GstPbutils.prototype.codec_utils_h264_get_level(sps: [ Number ], len: Number): {
    // javascript wrapper for 'gst_codec_utils_h264_get_level'
}

Converts the level indication (level_idc) in the stream's sequence parameter set into a string. The SPS is expected to have the same format as for GstPbutils.prototype.codec_utils_h264_get_profile.

GstPbutils.prototype.codec_utils_h264_get_level_idc

function GstPbutils.prototype.codec_utils_h264_get_level_idc(level: String): {
    // javascript wrapper for 'gst_codec_utils_h264_get_level_idc'
}

Transform a level string from the caps into the level_idc

GstPbutils.prototype.codec_utils_h264_get_level_limits

function GstPbutils.prototype.codec_utils_h264_get_level_limits(width: Number, height: Number, fps_n: Number, fps_d: Number, bitrate: Number, max_dec_frame_buffering: Number, profile_idc: Number): {
    // javascript wrapper for 'gst_codec_utils_h264_get_level_limits'
}

Finds the minimum H.264 level that can handle the given video parameters based on the constraints defined in H.264 specification Annex A.

Since : 1.30

GstPbutils.prototype.codec_utils_h264_get_profile

function GstPbutils.prototype.codec_utils_h264_get_profile(sps: [ Number ], len: Number): {
    // javascript wrapper for 'gst_codec_utils_h264_get_profile'
}

Converts the profile indication (profile_idc) in the stream's sequence parameter set into a string. The SPS is expected to have the following format, as defined in the H.264 specification. The SPS is viewed as a bitstream here, with bit 0 being the most significant bit of the first byte.

• Bit 0:7 - Profile indication
• Bit 8 - constraint_set0_flag
• Bit 9 - constraint_set1_flag
• Bit 10 - constraint_set2_flag
• Bit 11 - constraint_set3_flag
• Bit 12 - constraint_set3_flag
• Bit 13:15 - Reserved
• Bit 16:24 - Level indication

GstPbutils.prototype.codec_utils_h264_get_profile_flags_level

function GstPbutils.prototype.codec_utils_h264_get_profile_flags_level(codec_data: [ Number ], len: Number): {
    // javascript wrapper for 'gst_codec_utils_h264_get_profile_flags_level'
}

Parses profile, flags, and level from a H264 AVCC extradata/sequence_header. These are most commonly retrieved from a video/x-h264 caps with a codec_data buffer.

The format of H264 AVCC extradata/sequence_header is documented in the ITU-T H.264 specification section 7.3.2.1.1 as well as in ISO/IEC 14496-15 section 5.3.3.1.2.

Since : 1.20

GstPbutils.prototype.codec_utils_h265_caps_set_level_tier_and_profile

function GstPbutils.prototype.codec_utils_h265_caps_set_level_tier_and_profile(caps: Gst.Caps, profile_tier_level: [ Number ], len: Number): {
    // javascript wrapper for 'gst_codec_utils_h265_caps_set_level_tier_and_profile'
}

Sets the level, tier and profile in caps if it can be determined from profile_tier_level. See GstPbutils.prototype.codec_utils_h265_get_level, GstPbutils.prototype.codec_utils_h265_get_tier and GstPbutils.prototype.codec_utils_h265_get_profile for more details on the parameters.

Since : 1.4

GstPbutils.prototype.codec_utils_h265_get_level

function GstPbutils.prototype.codec_utils_h265_get_level(profile_tier_level: [ Number ], len: Number): {
    // javascript wrapper for 'gst_codec_utils_h265_get_level'
}

Converts the level indication (general_level_idc) in the stream's profile_tier_level structure into a string. The profiel_tier_level is expected to have the same format as for GstPbutils.prototype.codec_utils_h264_get_profile.

Since : 1.4

GstPbutils.prototype.codec_utils_h265_get_level_idc

function GstPbutils.prototype.codec_utils_h265_get_level_idc(level: String): {
    // javascript wrapper for 'gst_codec_utils_h265_get_level_idc'
}

Transform a level string from the caps into the level_idc

Since : 1.4

GstPbutils.prototype.codec_utils_h265_get_profile

function GstPbutils.prototype.codec_utils_h265_get_profile(profile_tier_level: [ Number ], len: Number): {
    // javascript wrapper for 'gst_codec_utils_h265_get_profile'
}

Converts the profile indication (general_profile_idc) in the stream's profile_level_tier structure into a string. The profile_tier_level is expected to have the following format, as defined in the H.265 specification. The profile_tier_level is viewed as a bitstream here, with bit 0 being the most significant bit of the first byte.

• Bit 0:1 - general_profile_space
• Bit 2 - general_tier_flag
• Bit 3:7 - general_profile_idc
• Bit 8:39 - gernal_profile_compatibility_flags
• Bit 40 - general_progressive_source_flag
• Bit 41 - general_interlaced_source_flag
• Bit 42 - general_non_packed_constraint_flag
• Bit 43 - general_frame_only_constraint_flag
• Bit 44:87 - See below
• Bit 88:95 - general_level_idc

Since : 1.4

GstPbutils.prototype.codec_utils_h265_get_tier

function GstPbutils.prototype.codec_utils_h265_get_tier(profile_tier_level: [ Number ], len: Number): {
    // javascript wrapper for 'gst_codec_utils_h265_get_tier'
}

Converts the tier indication (general_tier_flag) in the stream's profile_tier_level structure into a string. The profile_tier_level is expected to have the same format as for GstPbutils.prototype.codec_utils_h264_get_profile.

Since : 1.4

GstPbutils.prototype.codec_utils_h266_caps_set_level_tier_and_profile

function GstPbutils.prototype.codec_utils_h266_caps_set_level_tier_and_profile(caps: Gst.Caps, decoder_configuration: [ Number ], len: Number): {
    // javascript wrapper for 'gst_codec_utils_h266_caps_set_level_tier_and_profile'
}

Sets the level, tier and profile in caps if it can be determined from decoder_configuration. See GstPbutils.prototype.codec_utils_h266_get_level, GstPbutils.prototype.codec_utils_h266_get_tier and GstPbutils.prototype.codec_utils_h266_get_profile for more details on the parameters.

Since : 1.26

GstPbutils.prototype.codec_utils_h266_get_level

function GstPbutils.prototype.codec_utils_h266_get_level(ptl_record: [ Number ], len: Number): {
    // javascript wrapper for 'gst_codec_utils_h266_get_level'
}

Converts the level indication (general_level_idc) in the stream's ptl_record structure into a string.

Since : 1.26

GstPbutils.prototype.codec_utils_h266_get_level_idc

function GstPbutils.prototype.codec_utils_h266_get_level_idc(level: String): {
    // javascript wrapper for 'gst_codec_utils_h266_get_level_idc'
}

Transform a level string from the caps into the level_idc

Since : 1.26

GstPbutils.prototype.codec_utils_h266_get_profile

function GstPbutils.prototype.codec_utils_h266_get_profile(ptl_record: [ Number ], len: Number): {
    // javascript wrapper for 'gst_codec_utils_h266_get_profile'
}

Converts the profile indication (general_profile_idc) in the stream's ptl_record structure into a string.

Since : 1.26

GstPbutils.prototype.codec_utils_h266_get_tier

function GstPbutils.prototype.codec_utils_h266_get_tier(ptl_record: [ Number ], len: Number): {
    // javascript wrapper for 'gst_codec_utils_h266_get_tier'
}

Converts the tier indication (general_tier_flag) in the stream's ptl_record structure into a string.

Since : 1.26

GstPbutils.prototype.codec_utils_mpeg4video_caps_set_level_and_profile

function GstPbutils.prototype.codec_utils_mpeg4video_caps_set_level_and_profile(caps: Gst.Caps, vis_obj_seq: [ Number ], len: Number): {
    // javascript wrapper for 'gst_codec_utils_mpeg4video_caps_set_level_and_profile'
}

Sets the level and profile in caps if it can be determined from vis_obj_seq. See GstPbutils.prototype.codec_utils_mpeg4video_get_level and GstPbutils.prototype.codec_utils_mpeg4video_get_profile for more details on the parameters.

GstPbutils.prototype.codec_utils_mpeg4video_get_level

function GstPbutils.prototype.codec_utils_mpeg4video_get_level(vis_obj_seq: [ Number ], len: Number): {
    // javascript wrapper for 'gst_codec_utils_mpeg4video_get_level'
}

Converts the level indication in the stream's visual object sequence into a string. vis_obj_seq is expected to be the data following the visual object sequence start code. Only the first byte (profile_and_level_indication) is used.

GstPbutils.prototype.codec_utils_mpeg4video_get_profile

function GstPbutils.prototype.codec_utils_mpeg4video_get_profile(vis_obj_seq: [ Number ], len: Number): {
    // javascript wrapper for 'gst_codec_utils_mpeg4video_get_profile'
}

Converts the profile indication in the stream's visual object sequence into a string. vis_obj_seq is expected to be the data following the visual object sequence start code. Only the first byte (profile_and_level_indication) is used.

GstPbutils.prototype.codec_utils_opus_create_caps

function GstPbutils.prototype.codec_utils_opus_create_caps(rate: Number, channels: Number, channel_mapping_family: Number, stream_count: Number, coupled_count: Number, channel_mapping: [ Number ]): {
    // javascript wrapper for 'gst_codec_utils_opus_create_caps'
}

Creates Opus caps from the given parameters.

Since : 1.8

GstPbutils.prototype.codec_utils_opus_create_caps_from_header

function GstPbutils.prototype.codec_utils_opus_create_caps_from_header(header: Gst.Buffer, comments: Gst.Buffer): {
    // javascript wrapper for 'gst_codec_utils_opus_create_caps_from_header'
}

Creates Opus caps from the given OpusHead header and comment header comments.

Since : 1.8

GstPbutils.prototype.codec_utils_opus_create_header

function GstPbutils.prototype.codec_utils_opus_create_header(rate: Number, channels: Number, channel_mapping_family: Number, stream_count: Number, coupled_count: Number, channel_mapping: [ Number ], pre_skip: Number, output_gain: Number): {
    // javascript wrapper for 'gst_codec_utils_opus_create_header'
}

Creates OpusHead header from the given parameters.

Since : 1.8

GstPbutils.prototype.codec_utils_opus_parse_caps

function GstPbutils.prototype.codec_utils_opus_parse_caps(caps: Gst.Caps): {
    // javascript wrapper for 'gst_codec_utils_opus_parse_caps'
}

Parses Opus caps and fills the different fields with defaults if possible.

Since : 1.8

GstPbutils.prototype.codec_utils_opus_parse_header

function GstPbutils.prototype.codec_utils_opus_parse_header(header: Gst.Buffer): {
    // javascript wrapper for 'gst_codec_utils_opus_parse_header'
}

Parses the OpusHead header.

Since : 1.8

GstPbutils.prototype.codec_utils_vp9_estimate_level_idc_from_caps

function GstPbutils.prototype.codec_utils_vp9_estimate_level_idc_from_caps(caps: Gst.Caps): {
    // javascript wrapper for 'gst_codec_utils_vp9_estimate_level_idc_from_caps'
}

Estimates the vp9 level as defined in https://www.webmproject.org/vp9/mp4/#vp-codec-configuration-box, using the resolution and, if available, frame rate found in the structure passed in.

Since : 1.30

GstPbutils.prototype.codec_utils_vp9_get_level

function GstPbutils.prototype.codec_utils_vp9_get_level(level_idc: Number): {
    // javascript wrapper for 'gst_codec_utils_vp9_get_level'
}

Converts the level indication in the vpcC record into a string.

Since : 1.30

GstPbutils.prototype.codec_utils_vp9_get_level_idc

function GstPbutils.prototype.codec_utils_vp9_get_level_idc(level: String): {
    // javascript wrapper for 'gst_codec_utils_vp9_get_level_idc'
}

Transform a level string from the caps into the level_idc

Since : 1.30

GstPbutils.prototype.codec_utils_vpx_caps_get_config

function GstPbutils.prototype.codec_utils_vpx_caps_get_config(caps: Gst.Caps): {
    // javascript wrapper for 'gst_codec_utils_vpx_caps_get_config'
}

Parses VP8/VP9 caps and extracts normalized VPX configuration fields. Unlike GstPbutils.prototype.codec_utils_vpx_caps_set_format_fields, this getter includes the colorimetry-derived fields needed to build a full vpcC record.

Since : 1.30

GstPbutils.prototype.codec_utils_vpx_caps_set_format_fields

function GstPbutils.prototype.codec_utils_vpx_caps_set_format_fields(caps: Gst.Caps, profile: Number, level: Number, bit_depth: Number, chroma_subsampling: Number): {
    // javascript wrapper for 'gst_codec_utils_vpx_caps_set_format_fields'
}

Sets VPX format fields in caps from parsed VPX configuration values. This setter handles the VPX format-field subset shared between VP9 CodecPrivate and vpcC signaling. Any field set to -1 is treated as unknown and not written. For VP8 caps, only profile 0, 8-bit depth, and chroma subsampling 1 are accepted.

Since : 1.30

GstPbutils.prototype.codec_utils_vpx_create_vpcc_from_caps

function GstPbutils.prototype.codec_utils_vpx_create_vpcc_from_caps(caps: Gst.Caps): {
    // javascript wrapper for 'gst_codec_utils_vpx_create_vpcc_from_caps'
}

Creates a vpcC record for VP8/VP9 as per the VP Codec ISO Media File Format Binding definition found at https://www.webmproject.org/vp9/mp4/#vp-codec-configuration-box

Since : 1.30