gstpbutils.global

Undocumented in source.

Members

Functions

codecUtilsAacCapsSetLevelAndProfile
bool codecUtilsAacCapsSetLevelAndProfile(gst.caps.Caps caps, ubyte[] audioConfig)

Sets the level and profile on caps if it can be determined from audio_config. See gstpbutils.global.codecUtilsAacGetLevel and gstpbutils.global.codecUtilsAacGetProfile 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.

codecUtilsAacGetChannels
uint codecUtilsAacGetChannels(ubyte[] audioConfig)

Returns the channels of the given AAC stream.

codecUtilsAacGetIndexFromSampleRate
int codecUtilsAacGetIndexFromSampleRate(uint rate)

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

codecUtilsAacGetLevel
string codecUtilsAacGetLevel(ubyte[] audioConfig)

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.

codecUtilsAacGetProfile
string codecUtilsAacGetProfile(ubyte[] audioConfig)

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

codecUtilsAacGetSampleRate
uint codecUtilsAacGetSampleRate(ubyte[] audioConfig)

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

codecUtilsAacGetSampleRateFromIndex
uint codecUtilsAacGetSampleRateFromIndex(uint srIdx)

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

codecUtilsCapsFromMimeCodec
gst.caps.Caps codecUtilsCapsFromMimeCodec(string codecsField)

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

codecUtilsCapsGetMimeCodec
string codecUtilsCapsGetMimeCodec(gst.caps.Caps caps)

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

codecUtilsH264CapsSetLevelAndProfile
bool codecUtilsH264CapsSetLevelAndProfile(gst.caps.Caps caps, ubyte[] sps)

Sets the level and profile in caps if it can be determined from sps. See gstpbutils.global.codecUtilsH264GetLevel and gstpbutils.global.codecUtilsH264GetProfile for more details on the parameters.

codecUtilsH264GetLevel
string codecUtilsH264GetLevel(ubyte[] sps)

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.global.codecUtilsH264GetProfile.

codecUtilsH264GetLevelIdc
ubyte codecUtilsH264GetLevelIdc(string level)

Transform a level string from the caps into the level_idc

codecUtilsH264GetProfile
string codecUtilsH264GetProfile(ubyte[] sps)

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.

codecUtilsH264GetProfileFlagsLevel
bool codecUtilsH264GetProfileFlagsLevel(ubyte[] codecData, ubyte profile, ubyte flags, ubyte 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.

codecUtilsH265CapsSetLevelTierAndProfile
bool codecUtilsH265CapsSetLevelTierAndProfile(gst.caps.Caps caps, ubyte[] profileTierLevel)

Sets the level, tier and profile in caps if it can be determined from profile_tier_level. See gstpbutils.global.codecUtilsH265GetLevel, gstpbutils.global.codecUtilsH265GetTier and gstpbutils.global.codecUtilsH265GetProfile for more details on the parameters.

codecUtilsH265GetLevel
string codecUtilsH265GetLevel(ubyte[] profileTierLevel)

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.global.codecUtilsH264GetProfile.

codecUtilsH265GetLevelIdc
ubyte codecUtilsH265GetLevelIdc(string level)

Transform a level string from the caps into the level_idc

codecUtilsH265GetProfile
string codecUtilsH265GetProfile(ubyte[] profileTierLevel)

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.

codecUtilsH265GetTier
string codecUtilsH265GetTier(ubyte[] profileTierLevel)

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.global.codecUtilsH264GetProfile.

codecUtilsMpeg4videoCapsSetLevelAndProfile
bool codecUtilsMpeg4videoCapsSetLevelAndProfile(gst.caps.Caps caps, ubyte[] visObjSeq)

Sets the level and profile in caps if it can be determined from vis_obj_seq. See gstpbutils.global.codecUtilsMpeg4videoGetLevel and gstpbutils.global.codecUtilsMpeg4videoGetProfile for more details on the parameters.

codecUtilsMpeg4videoGetLevel
string codecUtilsMpeg4videoGetLevel(ubyte[] visObjSeq)

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.

codecUtilsMpeg4videoGetProfile
string codecUtilsMpeg4videoGetProfile(ubyte[] visObjSeq)

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.

codecUtilsOpusCreateCapsFromHeader
gst.caps.Caps codecUtilsOpusCreateCapsFromHeader(gst.buffer.Buffer header, gst.buffer.Buffer comments)

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

encodingListAllTargets
gstpbutils.encoding_target.EncodingTarget[] encodingListAllTargets(string categoryname)

List all available #GstEncodingTarget for the specified category, or all categories if categoryname is null.

encodingListAvailableCategories
string[] encodingListAvailableCategories()

Lists all #GstEncodingTarget categories present on disk.

installPluginsAsync
gstpbutils.types.InstallPluginsReturn installPluginsAsync(string[] details, gstpbutils.install_plugins_context.InstallPluginsContext ctx, gstpbutils.types.InstallPluginsResultFunc func)

Requests plugin installation without blocking. Once the plugins have been installed or installation has failed, func will be called with the result of the installation and your provided user_data pointer.

installPluginsInstallationInProgress
bool installPluginsInstallationInProgress()

Checks whether plugin installation (initiated by this application only) is currently in progress.

installPluginsSupported
bool installPluginsSupported()

Checks whether plugin installation is likely to be supported by the current environment. This currently only checks whether the helper script that is to be provided by the distribution or operating system vendor exists.

installPluginsSync
gstpbutils.types.InstallPluginsReturn installPluginsSync(string[] details, gstpbutils.install_plugins_context.InstallPluginsContext ctx)

Requests plugin installation and block until the plugins have been installed or installation has failed.

isMissingPluginMessage
bool isMissingPluginMessage(gst.message.Message msg)

Checks whether msg is a missing plugins message.

missingDecoderInstallerDetailNew
string missingDecoderInstallerDetailNew(gst.caps.Caps decodeCaps)

Returns an opaque string containing all the details about the missing element to be passed to an external installer called via gstpbutils.global.installPluginsAsync or gstpbutils.global.installPluginsSync.

missingDecoderMessageNew
gst.message.Message missingDecoderMessageNew(gst.element.Element element, gst.caps.Caps decodeCaps)

Creates a missing-plugin message for element to notify the application that a decoder element for a particular set of (fixed) caps is missing. This function is mainly for use in plugins.

missingElementInstallerDetailNew
string missingElementInstallerDetailNew(string factoryName)

Returns an opaque string containing all the details about the missing element to be passed to an external installer called via gstpbutils.global.installPluginsAsync or gstpbutils.global.installPluginsSync.

missingElementMessageNew
gst.message.Message missingElementMessageNew(gst.element.Element element, string factoryName)

Creates a missing-plugin message for element to notify the application that a certain required element is missing. This function is mainly for use in plugins.

missingEncoderInstallerDetailNew
string missingEncoderInstallerDetailNew(gst.caps.Caps encodeCaps)

Returns an opaque string containing all the details about the missing element to be passed to an external installer called via gstpbutils.global.installPluginsAsync or gstpbutils.global.installPluginsSync.

missingEncoderMessageNew
gst.message.Message missingEncoderMessageNew(gst.element.Element element, gst.caps.Caps encodeCaps)

Creates a missing-plugin message for element to notify the application that an encoder element for a particular set of (fixed) caps is missing. This function is mainly for use in plugins.

missingPluginMessageGetDescription
string missingPluginMessageGetDescription(gst.message.Message msg)

Returns a localised string describing the missing feature, for use in error dialogs and the like. Should never return NULL unless msg is not a valid missing-plugin message.

missingPluginMessageGetInstallerDetail
string missingPluginMessageGetInstallerDetail(gst.message.Message msg)

Returns an opaque string containing all the details about the missing element to be passed to an external installer called via gstpbutils.global.installPluginsAsync or gstpbutils.global.installPluginsSync.

missingUriSinkInstallerDetailNew
string missingUriSinkInstallerDetailNew(string protocol)

Returns an opaque string containing all the details about the missing element to be passed to an external installer called via gstpbutils.global.installPluginsAsync or gstpbutils.global.installPluginsSync.

missingUriSinkMessageNew
gst.message.Message missingUriSinkMessageNew(gst.element.Element element, string protocol)

Creates a missing-plugin message for element to notify the application that a sink element for a particular URI protocol is missing. This function is mainly for use in plugins.

missingUriSourceInstallerDetailNew
string missingUriSourceInstallerDetailNew(string protocol)

Returns an opaque string containing all the details about the missing element to be passed to an external installer called via gstpbutils.global.installPluginsAsync or gstpbutils.global.installPluginsSync.

missingUriSourceMessageNew
gst.message.Message missingUriSourceMessageNew(gst.element.Element element, string protocol)

Creates a missing-plugin message for element to notify the application that a source element for a particular URI protocol is missing. This function is mainly for use in plugins.

pbUtilsAddCodecDescriptionToTagList
bool pbUtilsAddCodecDescriptionToTagList(gst.tag_list.TagList taglist, string codecTag, gst.caps.Caps caps)

Adds a codec tag describing the format specified by caps to taglist.

pbUtilsGetCapsDescriptionFlags
gstpbutils.types.PbUtilsCapsDescriptionFlags pbUtilsGetCapsDescriptionFlags(gst.caps.Caps caps)

Returns flags that describe the format of the caps if known. No flags are set for unknown caps.

pbUtilsGetCodecDescription
string pbUtilsGetCodecDescription(gst.caps.Caps caps)

Returns a localised (as far as this is possible) string describing the media format specified in caps, for use in error dialogs or other messages to be seen by the user. Should never return NULL unless caps is invalid.

pbUtilsGetDecoderDescription
string pbUtilsGetDecoderDescription(gst.caps.Caps caps)

Returns a localised string describing an decoder for the format specified in caps, for use in error dialogs or other messages to be seen by the user.

pbUtilsGetElementDescription
string pbUtilsGetElementDescription(string factoryName)

Returns a localised string describing the given element, for use in error dialogs or other messages to be seen by the user.

pbUtilsGetEncoderDescription
string pbUtilsGetEncoderDescription(gst.caps.Caps caps)

Returns a localised string describing an encoder for the format specified in caps, for use in error dialogs or other messages to be seen by the user.

pbUtilsGetFileExtensionFromCaps
string pbUtilsGetFileExtensionFromCaps(gst.caps.Caps caps)

Returns a possible file extension for the given caps, if known.

pbUtilsGetSinkDescription
string pbUtilsGetSinkDescription(string protocol)

Returns a localised string describing a sink element handling the protocol specified in protocol, for use in error dialogs or other messages to be seen by the user.

pbUtilsGetSourceDescription
string pbUtilsGetSourceDescription(string protocol)

Returns a localised string describing a source element handling the protocol specified in protocol, for use in error dialogs or other messages to be seen by the user.

pbUtilsInit
void pbUtilsInit()

Initialises the base utils support library. This function is not thread-safe. Applications should call it after calling gst.global.init_, plugins should call it from their plugin_init function.

pluginsBaseVersion
void pluginsBaseVersion(uint major, uint minor, uint micro, uint nano)

Gets the version number of the GStreamer Plugins Base libraries.

pluginsBaseVersionString
string pluginsBaseVersionString()

This function returns a string that is useful for describing this version of GStreamer's gst-plugins-base libraries to the outside world: user agent strings, logging, about dialogs ...