GstVideo Ancillary

A collection of objects and methods to assist with handling Ancillary Data present in Vertical Blanking Interval as well as Closed Caption.

GstVideoAFDMeta

Active Format Description (AFD)

For details, see Table 6.14 Active Format in:

ATSC Digital Television Standard: Part 4 – MPEG-2 Video System Characteristics

https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf

and Active Format Description in Complete list of AFD codes

https://en.wikipedia.org/wiki/Active_Format_Description#Complete_list_of_AFD_codes

and SMPTE ST2016-1

Members

meta (GstMeta) –

parent GstMeta

field (guint8) –

0 for progressive or field 1 and 1 for field 2

spec (GstVideoAFDSpec) –

GstVideoAFDSpec that applies to afd

afd (GstVideoAFDValue) –

GstVideoAFDValue AFD value


GstVideo.VideoAFDMeta

Active Format Description (AFD)

For details, see Table 6.14 Active Format in:

ATSC Digital Television Standard: Part 4 – MPEG-2 Video System Characteristics

https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf

and Active Format Description in Complete list of AFD codes

https://en.wikipedia.org/wiki/Active_Format_Description#Complete_list_of_AFD_codes

and SMPTE ST2016-1

Members

meta (Gst.Meta) –

parent Gst.Meta

field (Number) –

0 for progressive or field 1 and 1 for field 2

GstVideo.VideoAFDSpec that applies to afd


GstVideo.VideoAFDMeta

Active Format Description (AFD)

For details, see Table 6.14 Active Format in:

ATSC Digital Television Standard: Part 4 – MPEG-2 Video System Characteristics

https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf

and Active Format Description in Complete list of AFD codes

https://en.wikipedia.org/wiki/Active_Format_Description#Complete_list_of_AFD_codes

and SMPTE ST2016-1

Members

meta (Gst.Meta) –

parent Gst.Meta

field (int) –

0 for progressive or field 1 and 1 for field 2

GstVideo.VideoAFDSpec that applies to afd


Functions

gst_video_afd_meta_get_info

const GstMetaInfo *
gst_video_afd_meta_get_info ()
Returns
No description available

GstVideo.VideoAFDMeta.prototype.get_info

function GstVideo.VideoAFDMeta.prototype.get_info(): {
    // javascript wrapper for 'gst_video_afd_meta_get_info'
}
Returns ( Gst.MetaInfo ) –
No description available

GstVideo.VideoAFDMeta.get_info

def GstVideo.VideoAFDMeta.get_info ():
    #python wrapper for 'gst_video_afd_meta_get_info'
Returns ( Gst.MetaInfo ) –
No description available

GstVideoAncillary

Video Ancillary data, according to SMPTE-291M specification.

Note that the contents of the data are always stored as 8bit data (i.e. do not contain the parity check bits).

Members

DID (guint8) –

The Data Identifier

SDID_block_number (guint8) –

The Secondary Data Identifier (if type 2) or the Data Block Number (if type 1)

data_count (guint8) –

The amount of data (in bytes) in data (max 255 bytes)

data (guint8 *) –

The user data content of the Ancillary packet. Does not contain the ADF, DID, SDID nor CS.


GstVideo.VideoAncillary

Video Ancillary data, according to SMPTE-291M specification.

Note that the contents of the data are always stored as 8bit data (i.e. do not contain the parity check bits).

Members

DID (Number) –

The Data Identifier

SDID_block_number (Number) –

The Secondary Data Identifier (if type 2) or the Data Block Number (if type 1)

data_count (Number) –

The amount of data (in bytes) in data (max 255 bytes)

data ([ Number ]) –

The user data content of the Ancillary packet. Does not contain the ADF, DID, SDID nor CS.


GstVideo.VideoAncillary

Video Ancillary data, according to SMPTE-291M specification.

Note that the contents of the data are always stored as 8bit data (i.e. do not contain the parity check bits).

Members

DID (int) –

The Data Identifier

SDID_block_number (int) –

The Secondary Data Identifier (if type 2) or the Data Block Number (if type 1)

data_count (int) –

The amount of data (in bytes) in data (max 255 bytes)

data ([ int ]) –

The user data content of the Ancillary packet. Does not contain the ADF, DID, SDID nor CS.


GstVideoBarMeta

Bar data should be included in video user data whenever the rectangular picture area containing useful information does not extend to the full height or width of the coded frame and AFD alone is insufficient to describe the extent of the image.

Note: either vertical or horizontal bars are specified, but not both.

For more details, see:

https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf

and SMPTE ST2016-1

Members

meta (GstMeta) –

parent GstMeta

field (guint8) –

0 for progressive or field 1 and 1 for field 2

is_letterbox (gboolean) –

if true then bar data specifies letterbox, otherwise pillarbox

bar_data1 (guint) –

If is_letterbox is true, then the value specifies the last line of a horizontal letterbox bar area at top of reconstructed frame. Otherwise, it specifies the last horizontal luminance sample of a vertical pillarbox bar area at the left side of the reconstructed frame

bar_data2 (guint) –

If is_letterbox is true, then the value specifies the first line of a horizontal letterbox bar area at bottom of reconstructed frame. Otherwise, it specifies the first horizontal luminance sample of a vertical pillarbox bar area at the right side of the reconstructed frame.


GstVideo.VideoBarMeta

Bar data should be included in video user data whenever the rectangular picture area containing useful information does not extend to the full height or width of the coded frame and AFD alone is insufficient to describe the extent of the image.

Note: either vertical or horizontal bars are specified, but not both.

For more details, see:

https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf

and SMPTE ST2016-1

Members

meta (Gst.Meta) –

parent Gst.Meta

field (Number) –

0 for progressive or field 1 and 1 for field 2

is_letterbox (Number) –

if true then bar data specifies letterbox, otherwise pillarbox

bar_data1 (Number) –

If is_letterbox is true, then the value specifies the last line of a horizontal letterbox bar area at top of reconstructed frame. Otherwise, it specifies the last horizontal luminance sample of a vertical pillarbox bar area at the left side of the reconstructed frame

bar_data2 (Number) –

If is_letterbox is true, then the value specifies the first line of a horizontal letterbox bar area at bottom of reconstructed frame. Otherwise, it specifies the first horizontal luminance sample of a vertical pillarbox bar area at the right side of the reconstructed frame.


GstVideo.VideoBarMeta

Bar data should be included in video user data whenever the rectangular picture area containing useful information does not extend to the full height or width of the coded frame and AFD alone is insufficient to describe the extent of the image.

Note: either vertical or horizontal bars are specified, but not both.

For more details, see:

https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf

and SMPTE ST2016-1

Members

meta (Gst.Meta) –

parent Gst.Meta

field (int) –

0 for progressive or field 1 and 1 for field 2

is_letterbox (bool) –

if true then bar data specifies letterbox, otherwise pillarbox

bar_data1 (int) –

If is_letterbox is true, then the value specifies the last line of a horizontal letterbox bar area at top of reconstructed frame. Otherwise, it specifies the last horizontal luminance sample of a vertical pillarbox bar area at the left side of the reconstructed frame

bar_data2 (int) –

If is_letterbox is true, then the value specifies the first line of a horizontal letterbox bar area at bottom of reconstructed frame. Otherwise, it specifies the first horizontal luminance sample of a vertical pillarbox bar area at the right side of the reconstructed frame.


Functions

gst_video_bar_meta_get_info

const GstMetaInfo *
gst_video_bar_meta_get_info ()
Returns
No description available

GstVideo.VideoBarMeta.prototype.get_info

function GstVideo.VideoBarMeta.prototype.get_info(): {
    // javascript wrapper for 'gst_video_bar_meta_get_info'
}
Returns ( Gst.MetaInfo ) –
No description available

GstVideo.VideoBarMeta.get_info

def GstVideo.VideoBarMeta.get_info ():
    #python wrapper for 'gst_video_bar_meta_get_info'
Returns ( Gst.MetaInfo ) –
No description available

GstVideoCaptionMeta

Extra buffer metadata providing Closed Caption.

Members

meta (GstMeta) –

parent GstMeta

caption_type (GstVideoCaptionType) –

The type of Closed Caption contained in the meta.

data (guint8 *) –

The Closed Caption data.

size (gsize) –

The size in bytes of data


GstVideo.VideoCaptionMeta

Extra buffer metadata providing Closed Caption.

Members

meta (Gst.Meta) –

parent Gst.Meta

caption_type (GstVideo.VideoCaptionType) –

The type of Closed Caption contained in the meta.

data ([ Number ]) –

The Closed Caption data.

size (Number) –

The size in bytes of data


GstVideo.VideoCaptionMeta

Extra buffer metadata providing Closed Caption.

Members

meta (Gst.Meta) –

parent Gst.Meta

caption_type (GstVideo.VideoCaptionType) –

The type of Closed Caption contained in the meta.

data ([ int ]) –

The Closed Caption data.

size (int) –

The size in bytes of data


Functions

gst_video_caption_meta_get_info

const GstMetaInfo *
gst_video_caption_meta_get_info ()
Returns
No description available

GstVideo.VideoCaptionMeta.prototype.get_info

function GstVideo.VideoCaptionMeta.prototype.get_info(): {
    // javascript wrapper for 'gst_video_caption_meta_get_info'
}
Returns ( Gst.MetaInfo ) –
No description available

GstVideo.VideoCaptionMeta.get_info

def GstVideo.VideoCaptionMeta.get_info ():
    #python wrapper for 'gst_video_caption_meta_get_info'
Returns ( Gst.MetaInfo ) –
No description available

GstVideoVBIEncoder

An encoder for writing ancillary data to the Vertical Blanking Interval lines of component signals.


GstVideoVBIEncoder

An encoder for writing ancillary data to the Vertical Blanking Interval lines of component signals.


GstVideoVBIEncoder

An encoder for writing ancillary data to the Vertical Blanking Interval lines of component signals.


Constructors

gst_video_vbi_encoder_new

GstVideoVBIEncoder *
gst_video_vbi_encoder_new (GstVideoFormat format,
                           guint32 pixel_width)

Create a new GstVideoVBIEncoder for the specified format and pixel_width.

Parameters:

format

a GstVideoFormat

pixel_width

The width in pixel to use

Returns

The new GstVideoVBIEncoder or NULL if the format and/or pixel_width is not supported.

Since : 1.16


GstVideo.VideoVBIEncoder.prototype.new

function GstVideo.VideoVBIEncoder.prototype.new(format: GstVideo.VideoFormat, pixel_width: Number): {
    // javascript wrapper for 'gst_video_vbi_encoder_new'
}

Create a new GstVideo.VideoVBIEncoder for the specified format and pixel_width.

Parameters:

pixel_width ( Number ) –

The width in pixel to use

Returns ( GstVideo.VideoVBIEncoder ) –

The new GstVideo.VideoVBIEncoder or null if the format and/or pixel_width is not supported.

Since : 1.16


GstVideo.VideoVBIEncoder.new

def GstVideo.VideoVBIEncoder.new (format, pixel_width):
    #python wrapper for 'gst_video_vbi_encoder_new'

Create a new GstVideo.VideoVBIEncoder for the specified format and pixel_width.

Parameters:

pixel_width ( int ) –

The width in pixel to use

Returns ( GstVideo.VideoVBIEncoder ) –

The new GstVideo.VideoVBIEncoder or None if the format and/or pixel_width is not supported.

Since : 1.16


Methods

gst_video_vbi_encoder_add_ancillary

gboolean
gst_video_vbi_encoder_add_ancillary (GstVideoVBIEncoder * encoder,
                                     gboolean composite,
                                     guint8 DID,
                                     guint8 SDID_block_number,
                                     const guint8 * data,
                                     guint data_count)

Stores Video Ancillary data, according to SMPTE-291M specification.

Note that the contents of the data are always read as 8bit data (i.e. do not contain the parity check bits).

Parameters:

encoder

a GstVideoVBIEncoder

composite

TRUE if composite ADF should be created, component otherwise

DID

The Data Identifier

SDID_block_number

The Secondary Data Identifier (if type 2) or the Data Block Number (if type 1)

data ( [array length=data_count] ) –

The user data content of the Ancillary packet. Does not contain the ADF, DID, SDID nor CS.

data_count

The amount of data (in bytes) in data (max 255 bytes)

Returns

TRUE if enough space was left in the current line, FALSE otherwise.

Since : 1.16


GstVideo.VideoVBIEncoder.prototype.add_ancillary

function GstVideo.VideoVBIEncoder.prototype.add_ancillary(composite: Number, DID: Number, SDID_block_number: Number, data: [ Number ], data_count: Number): {
    // javascript wrapper for 'gst_video_vbi_encoder_add_ancillary'
}

Stores Video Ancillary data, according to SMPTE-291M specification.

Note that the contents of the data are always read as 8bit data (i.e. do not contain the parity check bits).

Parameters:

composite ( Number ) –

true if composite ADF should be created, component otherwise

DID ( Number ) –

The Data Identifier

SDID_block_number ( Number ) –

The Secondary Data Identifier (if type 2) or the Data Block Number (if type 1)

data ( [ Number ] ) –

The user data content of the Ancillary packet. Does not contain the ADF, DID, SDID nor CS.

data_count ( Number ) –

The amount of data (in bytes) in data (max 255 bytes)

Returns ( Number ) –

true if enough space was left in the current line, false otherwise.

Since : 1.16


GstVideo.VideoVBIEncoder.add_ancillary

def GstVideo.VideoVBIEncoder.add_ancillary (self, composite, DID, SDID_block_number, data, data_count):
    #python wrapper for 'gst_video_vbi_encoder_add_ancillary'

Stores Video Ancillary data, according to SMPTE-291M specification.

Note that the contents of the data are always read as 8bit data (i.e. do not contain the parity check bits).

Parameters:

composite ( bool ) –

True if composite ADF should be created, component otherwise

DID ( int ) –

The Data Identifier

SDID_block_number ( int ) –

The Secondary Data Identifier (if type 2) or the Data Block Number (if type 1)

data ( [ int ] ) –

The user data content of the Ancillary packet. Does not contain the ADF, DID, SDID nor CS.

data_count ( int ) –

The amount of data (in bytes) in data (max 255 bytes)

Returns ( bool ) –

True if enough space was left in the current line, False otherwise.

Since : 1.16


gst_video_vbi_encoder_copy

GstVideoVBIEncoder *
gst_video_vbi_encoder_copy (const GstVideoVBIEncoder * encoder)

Parameters:

encoder
No description available
Returns
No description available

GstVideo.VideoVBIEncoder.prototype.copy

function GstVideo.VideoVBIEncoder.prototype.copy(): {
    // javascript wrapper for 'gst_video_vbi_encoder_copy'
}

Parameters:

encoder ( GstVideo.VideoVBIEncoder ) –
No description available
Returns ( GstVideo.VideoVBIEncoder ) –
No description available

GstVideo.VideoVBIEncoder.copy

def GstVideo.VideoVBIEncoder.copy (self):
    #python wrapper for 'gst_video_vbi_encoder_copy'

Parameters:

encoder ( GstVideo.VideoVBIEncoder ) –
No description available
Returns ( GstVideo.VideoVBIEncoder ) –
No description available

gst_video_vbi_encoder_free

gst_video_vbi_encoder_free (GstVideoVBIEncoder * encoder)

Frees the encoder.

Parameters:

encoder

a GstVideoVBIEncoder

Since : 1.16


GstVideo.VideoVBIEncoder.prototype.free

function GstVideo.VideoVBIEncoder.prototype.free(): {
    // javascript wrapper for 'gst_video_vbi_encoder_free'
}

Frees the encoder.

Parameters:

Since : 1.16


GstVideo.VideoVBIEncoder.free

def GstVideo.VideoVBIEncoder.free (self):
    #python wrapper for 'gst_video_vbi_encoder_free'

Frees the encoder.

Parameters:

Since : 1.16


gst_video_vbi_encoder_write_line

gst_video_vbi_encoder_write_line (GstVideoVBIEncoder * encoder,
                                  guint8 * data)

Parameters:

encoder
No description available
data
No description available

GstVideo.VideoVBIEncoder.prototype.write_line

function GstVideo.VideoVBIEncoder.prototype.write_line(data: Number): {
    // javascript wrapper for 'gst_video_vbi_encoder_write_line'
}

Parameters:

encoder ( GstVideo.VideoVBIEncoder ) –
No description available
data ( Number ) –
No description available

GstVideo.VideoVBIEncoder.write_line

def GstVideo.VideoVBIEncoder.write_line (self, data):
    #python wrapper for 'gst_video_vbi_encoder_write_line'

Parameters:

encoder ( GstVideo.VideoVBIEncoder ) –
No description available
data ( int ) –
No description available

GstVideoVBIParser

A parser for detecting and extracting GstVideoAncillary data from Vertical Blanking Interval lines of component signals.


GstVideoVBIParser

A parser for detecting and extracting GstVideoAncillary data from Vertical Blanking Interval lines of component signals.


GstVideoVBIParser

A parser for detecting and extracting GstVideoAncillary data from Vertical Blanking Interval lines of component signals.


Constructors

gst_video_vbi_parser_new

GstVideoVBIParser *
gst_video_vbi_parser_new (GstVideoFormat format,
                          guint32 pixel_width)

Create a new GstVideoVBIParser for the specified format and pixel_width.

Parameters:

format

a GstVideoFormat

pixel_width

The width in pixel to use

Returns

The new GstVideoVBIParser or NULL if the format and/or pixel_width is not supported.

Since : 1.16


GstVideo.VideoVBIParser.prototype.new

function GstVideo.VideoVBIParser.prototype.new(format: GstVideo.VideoFormat, pixel_width: Number): {
    // javascript wrapper for 'gst_video_vbi_parser_new'
}

Create a new GstVideo.VideoVBIParser for the specified format and pixel_width.

Parameters:

pixel_width ( Number ) –

The width in pixel to use

Returns ( GstVideo.VideoVBIParser ) –

The new GstVideo.VideoVBIParser or null if the format and/or pixel_width is not supported.

Since : 1.16


GstVideo.VideoVBIParser.new

def GstVideo.VideoVBIParser.new (format, pixel_width):
    #python wrapper for 'gst_video_vbi_parser_new'

Create a new GstVideo.VideoVBIParser for the specified format and pixel_width.

Parameters:

pixel_width ( int ) –

The width in pixel to use

Returns ( GstVideo.VideoVBIParser ) –

The new GstVideo.VideoVBIParser or None if the format and/or pixel_width is not supported.

Since : 1.16


Methods

gst_video_vbi_parser_add_line

gst_video_vbi_parser_add_line (GstVideoVBIParser * parser,
                               const guint8 * data)

Provide a new line of data to the parser. Call gst_video_vbi_parser_get_ancillary to get the Ancillary data that might be present on that line.

Parameters:

parser

a GstVideoVBIParser

data ( [array] [transfer: none] ) –

The line of data to parse

Since : 1.16


GstVideo.VideoVBIParser.prototype.add_line

function GstVideo.VideoVBIParser.prototype.add_line(data: [ Number ]): {
    // javascript wrapper for 'gst_video_vbi_parser_add_line'
}

Provide a new line of data to the parser. Call GstVideo.VideoVBIParser.prototype.get_ancillary to get the Ancillary data that might be present on that line.

Parameters:

data ( [ Number ] ) –

The line of data to parse

Since : 1.16


GstVideo.VideoVBIParser.add_line

def GstVideo.VideoVBIParser.add_line (self, data):
    #python wrapper for 'gst_video_vbi_parser_add_line'

Provide a new line of data to the parser. Call GstVideo.VideoVBIParser.get_ancillary to get the Ancillary data that might be present on that line.

Parameters:

data ( [ int ] ) –

The line of data to parse

Since : 1.16


gst_video_vbi_parser_copy

GstVideoVBIParser *
gst_video_vbi_parser_copy (const GstVideoVBIParser * parser)

Parameters:

parser
No description available
Returns
No description available

GstVideo.VideoVBIParser.prototype.copy

function GstVideo.VideoVBIParser.prototype.copy(): {
    // javascript wrapper for 'gst_video_vbi_parser_copy'
}

Parameters:

parser ( GstVideo.VideoVBIParser ) –
No description available
Returns ( GstVideo.VideoVBIParser ) –
No description available

GstVideo.VideoVBIParser.copy

def GstVideo.VideoVBIParser.copy (self):
    #python wrapper for 'gst_video_vbi_parser_copy'

Parameters:

parser ( GstVideo.VideoVBIParser ) –
No description available
Returns ( GstVideo.VideoVBIParser ) –
No description available

gst_video_vbi_parser_free

gst_video_vbi_parser_free (GstVideoVBIParser * parser)

Frees the parser.

Parameters:

parser

a GstVideoVBIParser

Since : 1.16


GstVideo.VideoVBIParser.prototype.free

function GstVideo.VideoVBIParser.prototype.free(): {
    // javascript wrapper for 'gst_video_vbi_parser_free'
}

Frees the parser.

Parameters:

Since : 1.16


GstVideo.VideoVBIParser.free

def GstVideo.VideoVBIParser.free (self):
    #python wrapper for 'gst_video_vbi_parser_free'

Frees the parser.

Parameters:

Since : 1.16


gst_video_vbi_parser_get_ancillary

GstVideoVBIParserResult
gst_video_vbi_parser_get_ancillary (GstVideoVBIParser * parser,
                                    GstVideoAncillary * anc)

Parse the line provided previously by gst_video_vbi_parser_add_line.

Parameters:

parser

a GstVideoVBIParser

anc ( [out] ) –

a GstVideoAncillary to start the eventual ancillary data

Returns

GST_VIDEO_VBI_PARSER_RESULT_OK if ancillary data was found and anc was filled. GST_VIDEO_VBI_PARSER_RESULT_DONE if there wasn't any data.

Since : 1.16


GstVideo.VideoVBIParser.prototype.get_ancillary

function GstVideo.VideoVBIParser.prototype.get_ancillary(): {
    // javascript wrapper for 'gst_video_vbi_parser_get_ancillary'
}

Parse the line provided previously by GstVideo.VideoVBIParser.prototype.add_line.

Parameters:

Returns a tuple made of:

GstVideo.VideoVBIParserResult.OK if ancillary data was found and anc was filled. GstVideo.VideoVBIParserResult.DONE if there wasn't any data.

GstVideo.VideoVBIParserResult.OK if ancillary data was found and anc was filled. GstVideo.VideoVBIParserResult.DONE if there wasn't any data.

Since : 1.16


GstVideo.VideoVBIParser.get_ancillary

def GstVideo.VideoVBIParser.get_ancillary (self):
    #python wrapper for 'gst_video_vbi_parser_get_ancillary'

Parse the line provided previously by GstVideo.VideoVBIParser.add_line.

Parameters:

Returns a tuple made of:

GstVideo.VideoVBIParserResult.OK if ancillary data was found and anc was filled. GstVideo.VideoVBIParserResult.DONE if there wasn't any data.

GstVideo.VideoVBIParserResult.OK if ancillary data was found and anc was filled. GstVideo.VideoVBIParserResult.DONE if there wasn't any data.

Since : 1.16


Functions

gst_buffer_add_video_afd_meta

GstVideoAFDMeta *
gst_buffer_add_video_afd_meta (GstBuffer * buffer,
                               guint8 field,
                               GstVideoAFDSpec spec,
                               GstVideoAFDValue afd)

Attaches GstVideoAFDMeta metadata to buffer with the given parameters.

Parameters:

buffer

a GstBuffer

field

0 for progressive or field 1 and 1 for field 2

spec

GstVideoAFDSpec that applies to AFD value

afd

GstVideoAFDValue AFD enumeration

Returns ( [transfer: none] ) –

the GstVideoAFDMeta on buffer.

Since : 1.18


GstVideo.prototype.buffer_add_video_afd_meta

function GstVideo.prototype.buffer_add_video_afd_meta(buffer: Gst.Buffer, field: Number, spec: GstVideo.VideoAFDSpec, afd: GstVideo.VideoAFDValue): {
    // javascript wrapper for 'gst_buffer_add_video_afd_meta'
}

Attaches GstVideo.VideoAFDMeta metadata to buffer with the given parameters.

Parameters:

buffer ( Gst.Buffer ) –

a Gst.Buffer

field ( Number ) –

0 for progressive or field 1 and 1 for field 2

spec ( GstVideo.VideoAFDSpec ) –

GstVideo.VideoAFDSpec that applies to AFD value

GstVideo.VideoAFDValue AFD enumeration

Returns ( GstVideo.VideoAFDMeta ) –

the GstVideo.VideoAFDMeta on buffer.

Since : 1.18


GstVideo.buffer_add_video_afd_meta

def GstVideo.buffer_add_video_afd_meta (buffer, field, spec, afd):
    #python wrapper for 'gst_buffer_add_video_afd_meta'

Attaches GstVideo.VideoAFDMeta metadata to buffer with the given parameters.

Parameters:

buffer ( Gst.Buffer ) –

a Gst.Buffer

field ( int ) –

0 for progressive or field 1 and 1 for field 2

spec ( GstVideo.VideoAFDSpec ) –

GstVideo.VideoAFDSpec that applies to AFD value

GstVideo.VideoAFDValue AFD enumeration

Returns ( GstVideo.VideoAFDMeta ) –

the GstVideo.VideoAFDMeta on buffer.

Since : 1.18


gst_buffer_add_video_bar_meta

GstVideoBarMeta *
gst_buffer_add_video_bar_meta (GstBuffer * buffer,
                               guint8 field,
                               gboolean is_letterbox,
                               guint bar_data1,
                               guint bar_data2)

Attaches GstVideoBarMeta metadata to buffer with the given parameters.

Parameters:

buffer

a GstBuffer

field

0 for progressive or field 1 and 1 for field 2

is_letterbox

if true then bar data specifies letterbox, otherwise pillarbox

bar_data1

If is_letterbox is true, then the value specifies the last line of a horizontal letterbox bar area at top of reconstructed frame. Otherwise, it specifies the last horizontal luminance sample of a vertical pillarbox bar area at the left side of the reconstructed frame

bar_data2

If is_letterbox is true, then the value specifies the first line of a horizontal letterbox bar area at bottom of reconstructed frame. Otherwise, it specifies the first horizontal luminance sample of a vertical pillarbox bar area at the right side of the reconstructed frame.

Returns ( [transfer: none] ) –

the GstVideoBarMeta on buffer.

See Table 6.11 Bar Data Syntax

https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf

Since : 1.18


GstVideo.prototype.buffer_add_video_bar_meta

function GstVideo.prototype.buffer_add_video_bar_meta(buffer: Gst.Buffer, field: Number, is_letterbox: Number, bar_data1: Number, bar_data2: Number): {
    // javascript wrapper for 'gst_buffer_add_video_bar_meta'
}

Attaches GstVideo.VideoBarMeta metadata to buffer with the given parameters.

Parameters:

buffer ( Gst.Buffer ) –

a Gst.Buffer

field ( Number ) –

0 for progressive or field 1 and 1 for field 2

is_letterbox ( Number ) –

if true then bar data specifies letterbox, otherwise pillarbox

bar_data1 ( Number ) –

If is_letterbox is true, then the value specifies the last line of a horizontal letterbox bar area at top of reconstructed frame. Otherwise, it specifies the last horizontal luminance sample of a vertical pillarbox bar area at the left side of the reconstructed frame

bar_data2 ( Number ) –

If is_letterbox is true, then the value specifies the first line of a horizontal letterbox bar area at bottom of reconstructed frame. Otherwise, it specifies the first horizontal luminance sample of a vertical pillarbox bar area at the right side of the reconstructed frame.

Returns ( GstVideo.VideoBarMeta ) –

the GstVideo.VideoBarMeta on buffer.

See Table 6.11 Bar Data Syntax

https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf

Since : 1.18


GstVideo.buffer_add_video_bar_meta

def GstVideo.buffer_add_video_bar_meta (buffer, field, is_letterbox, bar_data1, bar_data2):
    #python wrapper for 'gst_buffer_add_video_bar_meta'

Attaches GstVideo.VideoBarMeta metadata to buffer with the given parameters.

Parameters:

buffer ( Gst.Buffer ) –

a Gst.Buffer

field ( int ) –

0 for progressive or field 1 and 1 for field 2

is_letterbox ( bool ) –

if true then bar data specifies letterbox, otherwise pillarbox

bar_data1 ( int ) –

If is_letterbox is true, then the value specifies the last line of a horizontal letterbox bar area at top of reconstructed frame. Otherwise, it specifies the last horizontal luminance sample of a vertical pillarbox bar area at the left side of the reconstructed frame

bar_data2 ( int ) –

If is_letterbox is true, then the value specifies the first line of a horizontal letterbox bar area at bottom of reconstructed frame. Otherwise, it specifies the first horizontal luminance sample of a vertical pillarbox bar area at the right side of the reconstructed frame.

Returns ( GstVideo.VideoBarMeta ) –

the GstVideo.VideoBarMeta on buffer.

See Table 6.11 Bar Data Syntax

https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf

Since : 1.18


gst_buffer_add_video_caption_meta

GstVideoCaptionMeta *
gst_buffer_add_video_caption_meta (GstBuffer * buffer,
                                   GstVideoCaptionType caption_type,
                                   const guint8 * data,
                                   gsize size)

Attaches GstVideoCaptionMeta metadata to buffer with the given parameters.

Parameters:

buffer

a GstBuffer

caption_type

The type of Closed Caption to add

data ( [array length=size] [transfer: none] ) –

The Closed Caption data

size

The size of data in bytes

Returns ( [transfer: none] ) –

the GstVideoCaptionMeta on buffer.

Since : 1.16


GstVideo.prototype.buffer_add_video_caption_meta

function GstVideo.prototype.buffer_add_video_caption_meta(buffer: Gst.Buffer, caption_type: GstVideo.VideoCaptionType, data: [ Number ], size: Number): {
    // javascript wrapper for 'gst_buffer_add_video_caption_meta'
}

Attaches GstVideo.VideoCaptionMeta metadata to buffer with the given parameters.

Parameters:

buffer ( Gst.Buffer ) –

a Gst.Buffer

caption_type ( GstVideo.VideoCaptionType ) –

The type of Closed Caption to add

data ( [ Number ] ) –

The Closed Caption data

size ( Number ) –

The size of data in bytes

Returns ( GstVideo.VideoCaptionMeta ) –

the GstVideo.VideoCaptionMeta on buffer.

Since : 1.16


GstVideo.buffer_add_video_caption_meta

def GstVideo.buffer_add_video_caption_meta (buffer, caption_type, data, size):
    #python wrapper for 'gst_buffer_add_video_caption_meta'

Attaches GstVideo.VideoCaptionMeta metadata to buffer with the given parameters.

Parameters:

buffer ( Gst.Buffer ) –

a Gst.Buffer

caption_type ( GstVideo.VideoCaptionType ) –

The type of Closed Caption to add

data ( [ int ] ) –

The Closed Caption data

size ( int ) –

The size of data in bytes

Returns ( GstVideo.VideoCaptionMeta ) –

the GstVideo.VideoCaptionMeta on buffer.

Since : 1.16


gst_video_afd_meta_api_get_type

GType
gst_video_afd_meta_api_get_type ()
Returns
No description available

GstVideo.prototype.video_afd_meta_api_get_type

function GstVideo.prototype.video_afd_meta_api_get_type(): {
    // javascript wrapper for 'gst_video_afd_meta_api_get_type'
}
Returns ( GObject.Type ) –
No description available

GstVideo.video_afd_meta_api_get_type

def GstVideo.video_afd_meta_api_get_type ():
    #python wrapper for 'gst_video_afd_meta_api_get_type'
Returns ( GObject.Type ) –
No description available

gst_video_bar_meta_api_get_type

GType
gst_video_bar_meta_api_get_type ()
Returns
No description available

GstVideo.prototype.video_bar_meta_api_get_type

function GstVideo.prototype.video_bar_meta_api_get_type(): {
    // javascript wrapper for 'gst_video_bar_meta_api_get_type'
}
Returns ( GObject.Type ) –
No description available

GstVideo.video_bar_meta_api_get_type

def GstVideo.video_bar_meta_api_get_type ():
    #python wrapper for 'gst_video_bar_meta_api_get_type'
Returns ( GObject.Type ) –
No description available

gst_video_caption_meta_api_get_type

GType
gst_video_caption_meta_api_get_type ()
Returns
No description available

GstVideo.prototype.video_caption_meta_api_get_type

function GstVideo.prototype.video_caption_meta_api_get_type(): {
    // javascript wrapper for 'gst_video_caption_meta_api_get_type'
}
Returns ( GObject.Type ) –
No description available

GstVideo.video_caption_meta_api_get_type

def GstVideo.video_caption_meta_api_get_type ():
    #python wrapper for 'gst_video_caption_meta_api_get_type'
Returns ( GObject.Type ) –
No description available

gst_video_caption_type_from_caps

GstVideoCaptionType
gst_video_caption_type_from_caps (const GstCaps * caps)

Parses fixed Closed Caption GstCaps and returns the corresponding caption type, or GST_VIDEO_CAPTION_TYPE_UNKNOWN.

Parameters:

caps

Fixed GstCaps to parse

Returns

GstVideoCaptionType.

Since : 1.16


GstVideo.VideoCaptionType.prototype.from_caps

function GstVideo.VideoCaptionType.prototype.from_caps(caps: Gst.Caps): {
    // javascript wrapper for 'gst_video_caption_type_from_caps'
}

Parses fixed Closed Caption Gst.Caps and returns the corresponding caption type, or GstVideo.VideoCaptionType.UNKNOWN.

Parameters:

caps ( Gst.Caps ) –

Fixed Gst.Caps to parse

Since : 1.16


GstVideo.VideoCaptionType.from_caps

def GstVideo.VideoCaptionType.from_caps (caps):
    #python wrapper for 'gst_video_caption_type_from_caps'

Parses fixed Closed Caption Gst.Caps and returns the corresponding caption type, or GstVideo.VideoCaptionType.UNKNOWN.

Parameters:

caps ( Gst.Caps ) –

Fixed Gst.Caps to parse

Since : 1.16


gst_video_caption_type_to_caps

GstCaps *
gst_video_caption_type_to_caps (GstVideoCaptionType type)

Creates new caps corresponding to type.

Parameters:

Returns ( [transfer: full] ) –

new GstCaps

Since : 1.16


GstVideo.VideoCaptionType.prototype.to_caps

function GstVideo.VideoCaptionType.prototype.to_caps(type: GstVideo.VideoCaptionType): {
    // javascript wrapper for 'gst_video_caption_type_to_caps'
}

Creates new caps corresponding to type.

Returns ( Gst.Caps ) –

new Gst.Caps

Since : 1.16


GstVideo.VideoCaptionType.to_caps

def GstVideo.VideoCaptionType.to_caps (type):
    #python wrapper for 'gst_video_caption_type_to_caps'

Creates new caps corresponding to type.

Returns ( Gst.Caps ) –

new Gst.Caps

Since : 1.16


Function Macros

GST_VIDEO_ANCILLARY_DID16

#define GST_VIDEO_ANCILLARY_DID16(anc) ((guint16)((anc)->DID) << 8 | (guint16)((anc)->SDID_block_number))

Returns the GstVideoAncillaryDID16 of the ancillary data.

Parameters:

anc

a GstVideoAncillary

Returns

a GstVideoAncillaryDID16 identifier


gst_buffer_get_video_afd_meta

#define gst_buffer_get_video_afd_meta(b) \
        ((GstVideoAFDMeta*)gst_buffer_get_meta((b),GST_VIDEO_AFD_META_API_TYPE))

Gets the GstVideoAFDMeta that might be present on b.

Note: there may be two GstVideoAFDMeta structs for interlaced video.

Parameters:

b

A GstBuffer

Returns

The first GstVideoAFDMeta present on b, or NULL if no GstVideoAFDMeta are present


gst_buffer_get_video_bar_meta

#define gst_buffer_get_video_bar_meta(b) \
        ((GstVideoBarMeta*)gst_buffer_get_meta((b),GST_VIDEO_BAR_META_API_TYPE))

Gets the GstVideoBarMeta that might be present on b.

Parameters:

b

A GstBuffer

Returns

The first GstVideoBarMeta present on b, or NULL if no GstVideoBarMeta are present


gst_buffer_get_video_caption_meta

#define gst_buffer_get_video_caption_meta(b) \
        ((GstVideoCaptionMeta*)gst_buffer_get_meta((b),GST_VIDEO_CAPTION_META_API_TYPE))

Gets the GstVideoCaptionMeta that might be present on b.

Parameters:

b

A GstBuffer

Returns

The first GstVideoCaptionMeta present on b, or NULL if no GstVideoCaptionMeta are present


Enumerations

GstVideoAFDSpec

Enumeration of the different standards that may apply to AFD data:

  1. ETSI/DVB: https://www.etsi.org/deliver/etsi_ts/101100_101199/101154/02.01.01_60/ts_101154v020101p.pdf

  2. ATSC A/53: https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf

  3. SMPTE ST2016-1:

Members
GST_VIDEO_AFD_SPEC_DVB_ETSI (0) –

AFD value is from DVB/ETSI standard

GST_VIDEO_AFD_SPEC_ATSC_A53 (1) –

AFD value is from ATSC A/53 standard

GST_VIDEO_AFD_SPEC_SMPTE_ST2016_1 (2) –
No description available

GstVideo.VideoAFDSpec

Enumeration of the different standards that may apply to AFD data:

  1. ETSI/DVB: https://www.etsi.org/deliver/etsi_ts/101100_101199/101154/02.01.01_60/ts_101154v020101p.pdf

  2. ATSC A/53: https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf

  3. SMPTE ST2016-1:

Members
GstVideo.VideoAFDSpec.DVB_ETSI (0) –

AFD value is from DVB/ETSI standard

GstVideo.VideoAFDSpec.ATSC_A53 (1) –

AFD value is from ATSC A/53 standard

GstVideo.VideoAFDSpec.SMPTE_ST2016_1 (2) –
No description available

GstVideo.VideoAFDSpec

Enumeration of the different standards that may apply to AFD data:

  1. ETSI/DVB: https://www.etsi.org/deliver/etsi_ts/101100_101199/101154/02.01.01_60/ts_101154v020101p.pdf

  2. ATSC A/53: https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf

  3. SMPTE ST2016-1:

Members
GstVideo.VideoAFDSpec.DVB_ETSI (0) –

AFD value is from DVB/ETSI standard

GstVideo.VideoAFDSpec.ATSC_A53 (1) –

AFD value is from ATSC A/53 standard

GstVideo.VideoAFDSpec.SMPTE_ST2016_1 (2) –
No description available

GstVideoAFDValue

Enumeration of the various values for Active Format Description (AFD)

AFD should be included in video user data whenever the rectangular picture area containing useful information does not extend to the full height or width of the coded frame. AFD data may also be included in user data when the rectangular picture area containing useful information extends to the full height and width of the coded frame.

For details, see Table 6.14 Active Format in:

ATSC Digital Television Standard: Part 4 – MPEG-2 Video System Characteristics

https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf

and Active Format Description in Complete list of AFD codes

https://en.wikipedia.org/wiki/Active_Format_Description#Complete_list_of_AFD_codes

and SMPTE ST2016-1

Notes:

  1. AFD 0 is undefined for ATSC and SMPTE ST2016-1, indicating that AFD data is not available: If Bar Data is not present, AFD '0000' indicates that exact information is not available and the active image should be assumed to be the same as the coded frame. AFD '0000'. AFD '0000' accompanied by Bar Data signals that the active image‚Äôs aspect ratio is narrower than 16:9, but is not 4:3 or 14:9. As the exact aspect ratio cannot be conveyed by AFD alone, wherever possible, AFD ‘0000’ should be accompanied by Bar Data to define the exact vertical or horizontal extent of the active image.
  2. AFD 0 is reserved for DVB/ETSI
  3. values 1, 5, 6, 7, and 12 are reserved for both ATSC and DVB/ETSI
  4. values 2 and 3 are not recommended for ATSC, but are valid for DVB/ETSI
Members
GST_VIDEO_AFD_UNAVAILABLE (0) –

Unavailable (see note 0 below).

GST_VIDEO_AFD_16_9_TOP_ALIGNED (2) –

For 4:3 coded frame, letterbox 16:9 image, at top of the coded frame. For 16:9 coded frame, full frame 16:9 image, the same as the coded frame.

GST_VIDEO_AFD_14_9_TOP_ALIGNED (3) –

For 4:3 coded frame, letterbox 14:9 image, at top of the coded frame. For 16:9 coded frame, pillarbox 14:9 image, horizontally centered in the coded frame.

GST_VIDEO_AFD_GREATER_THAN_16_9 (4) –

For 4:3 coded frame, letterbox image with an aspect ratio greater than 16:9, vertically centered in the coded frame. For 16:9 coded frame, letterbox image with an aspect ratio greater than 16:9.

GST_VIDEO_AFD_4_3_FULL_16_9_FULL (8) –

For 4:3 coded frame, full frame 4:3 image, the same as the coded frame. For 16:9 coded frame, full frame 16:9 image, the same as the coded frame.

GST_VIDEO_AFD_4_3_FULL_4_3_PILLAR (9) –

For 4:3 coded frame, full frame 4:3 image, the same as the coded frame. For 16:9 coded frame, pillarbox 4:3 image, horizontally centered in the coded frame.

GST_VIDEO_AFD_16_9_LETTER_16_9_FULL (10) –

For 4:3 coded frame, letterbox 16:9 image, vertically centered in the coded frame with all image areas protected. For 16:9 coded frame, full frame 16:9 image, with all image areas protected.

GST_VIDEO_AFD_14_9_LETTER_14_9_PILLAR (11) –

For 4:3 coded frame, letterbox 14:9 image, vertically centered in the coded frame. For 16:9 coded frame, pillarbox 14:9 image, horizontally centered in the coded frame.

GST_VIDEO_AFD_4_3_FULL_14_9_CENTER (13) –

For 4:3 coded frame, full frame 4:3 image, with alternative 14:9 center. For 16:9 coded frame, pillarbox 4:3 image, with alternative 14:9 center.

GST_VIDEO_AFD_16_9_LETTER_14_9_CENTER (14) –

For 4:3 coded frame, letterbox 16:9 image, with alternative 14:9 center. For 16:9 coded frame, full frame 16:9 image, with alternative 14:9 center.

GST_VIDEO_AFD_16_9_LETTER_4_3_CENTER (15) –

For 4:3 coded frame, letterbox 16:9 image, with alternative 4:3 center. For 16:9 coded frame, full frame 16:9 image, with alternative 4:3 center.


GstVideo.VideoAFDValue

Enumeration of the various values for Active Format Description (AFD)

AFD should be included in video user data whenever the rectangular picture area containing useful information does not extend to the full height or width of the coded frame. AFD data may also be included in user data when the rectangular picture area containing useful information extends to the full height and width of the coded frame.

For details, see Table 6.14 Active Format in:

ATSC Digital Television Standard: Part 4 – MPEG-2 Video System Characteristics

https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf

and Active Format Description in Complete list of AFD codes

https://en.wikipedia.org/wiki/Active_Format_Description#Complete_list_of_AFD_codes

and SMPTE ST2016-1

Notes:

  1. AFD 0 is undefined for ATSC and SMPTE ST2016-1, indicating that AFD data is not available: If Bar Data is not present, AFD '0000' indicates that exact information is not available and the active image should be assumed to be the same as the coded frame. AFD '0000'. AFD '0000' accompanied by Bar Data signals that the active image‚Äôs aspect ratio is narrower than 16:9, but is not 4:3 or 14:9. As the exact aspect ratio cannot be conveyed by AFD alone, wherever possible, AFD ‘0000’ should be accompanied by Bar Data to define the exact vertical or horizontal extent of the active image.
  2. AFD 0 is reserved for DVB/ETSI
  3. values 1, 5, 6, 7, and 12 are reserved for both ATSC and DVB/ETSI
  4. values 2 and 3 are not recommended for ATSC, but are valid for DVB/ETSI
Members
GstVideo.VideoAFDValue.UNAVAILABLE (0) –

Unavailable (see note 0 below).

GstVideo.VideoAFDValue.16_9_TOP_ALIGNED (2) –

For 4:3 coded frame, letterbox 16:9 image, at top of the coded frame. For 16:9 coded frame, full frame 16:9 image, the same as the coded frame.

GstVideo.VideoAFDValue.14_9_TOP_ALIGNED (3) –

For 4:3 coded frame, letterbox 14:9 image, at top of the coded frame. For 16:9 coded frame, pillarbox 14:9 image, horizontally centered in the coded frame.

GstVideo.VideoAFDValue.GREATER_THAN_16_9 (4) –

For 4:3 coded frame, letterbox image with an aspect ratio greater than 16:9, vertically centered in the coded frame. For 16:9 coded frame, letterbox image with an aspect ratio greater than 16:9.

GstVideo.VideoAFDValue.4_3_FULL_16_9_FULL (8) –

For 4:3 coded frame, full frame 4:3 image, the same as the coded frame. For 16:9 coded frame, full frame 16:9 image, the same as the coded frame.

GstVideo.VideoAFDValue.4_3_FULL_4_3_PILLAR (9) –

For 4:3 coded frame, full frame 4:3 image, the same as the coded frame. For 16:9 coded frame, pillarbox 4:3 image, horizontally centered in the coded frame.

GstVideo.VideoAFDValue.16_9_LETTER_16_9_FULL (10) –

For 4:3 coded frame, letterbox 16:9 image, vertically centered in the coded frame with all image areas protected. For 16:9 coded frame, full frame 16:9 image, with all image areas protected.

GstVideo.VideoAFDValue.14_9_LETTER_14_9_PILLAR (11) –

For 4:3 coded frame, letterbox 14:9 image, vertically centered in the coded frame. For 16:9 coded frame, pillarbox 14:9 image, horizontally centered in the coded frame.

GstVideo.VideoAFDValue.4_3_FULL_14_9_CENTER (13) –

For 4:3 coded frame, full frame 4:3 image, with alternative 14:9 center. For 16:9 coded frame, pillarbox 4:3 image, with alternative 14:9 center.

GstVideo.VideoAFDValue.16_9_LETTER_14_9_CENTER (14) –

For 4:3 coded frame, letterbox 16:9 image, with alternative 14:9 center. For 16:9 coded frame, full frame 16:9 image, with alternative 14:9 center.

GstVideo.VideoAFDValue.16_9_LETTER_4_3_CENTER (15) –

For 4:3 coded frame, letterbox 16:9 image, with alternative 4:3 center. For 16:9 coded frame, full frame 16:9 image, with alternative 4:3 center.


GstVideo.VideoAFDValue

Enumeration of the various values for Active Format Description (AFD)

AFD should be included in video user data whenever the rectangular picture area containing useful information does not extend to the full height or width of the coded frame. AFD data may also be included in user data when the rectangular picture area containing useful information extends to the full height and width of the coded frame.

For details, see Table 6.14 Active Format in:

ATSC Digital Television Standard: Part 4 – MPEG-2 Video System Characteristics

https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf

and Active Format Description in Complete list of AFD codes

https://en.wikipedia.org/wiki/Active_Format_Description#Complete_list_of_AFD_codes

and SMPTE ST2016-1

Notes:

  1. AFD 0 is undefined for ATSC and SMPTE ST2016-1, indicating that AFD data is not available: If Bar Data is not present, AFD '0000' indicates that exact information is not available and the active image should be assumed to be the same as the coded frame. AFD '0000'. AFD '0000' accompanied by Bar Data signals that the active image‚Äôs aspect ratio is narrower than 16:9, but is not 4:3 or 14:9. As the exact aspect ratio cannot be conveyed by AFD alone, wherever possible, AFD ‘0000’ should be accompanied by Bar Data to define the exact vertical or horizontal extent of the active image.
  2. AFD 0 is reserved for DVB/ETSI
  3. values 1, 5, 6, 7, and 12 are reserved for both ATSC and DVB/ETSI
  4. values 2 and 3 are not recommended for ATSC, but are valid for DVB/ETSI
Members
GstVideo.VideoAFDValue.UNAVAILABLE (0) –

Unavailable (see note 0 below).

GstVideo.VideoAFDValue.16_9_TOP_ALIGNED (2) –

For 4:3 coded frame, letterbox 16:9 image, at top of the coded frame. For 16:9 coded frame, full frame 16:9 image, the same as the coded frame.

GstVideo.VideoAFDValue.14_9_TOP_ALIGNED (3) –

For 4:3 coded frame, letterbox 14:9 image, at top of the coded frame. For 16:9 coded frame, pillarbox 14:9 image, horizontally centered in the coded frame.

GstVideo.VideoAFDValue.GREATER_THAN_16_9 (4) –

For 4:3 coded frame, letterbox image with an aspect ratio greater than 16:9, vertically centered in the coded frame. For 16:9 coded frame, letterbox image with an aspect ratio greater than 16:9.

GstVideo.VideoAFDValue.4_3_FULL_16_9_FULL (8) –

For 4:3 coded frame, full frame 4:3 image, the same as the coded frame. For 16:9 coded frame, full frame 16:9 image, the same as the coded frame.

GstVideo.VideoAFDValue.4_3_FULL_4_3_PILLAR (9) –

For 4:3 coded frame, full frame 4:3 image, the same as the coded frame. For 16:9 coded frame, pillarbox 4:3 image, horizontally centered in the coded frame.

GstVideo.VideoAFDValue.16_9_LETTER_16_9_FULL (10) –

For 4:3 coded frame, letterbox 16:9 image, vertically centered in the coded frame with all image areas protected. For 16:9 coded frame, full frame 16:9 image, with all image areas protected.

GstVideo.VideoAFDValue.14_9_LETTER_14_9_PILLAR (11) –

For 4:3 coded frame, letterbox 14:9 image, vertically centered in the coded frame. For 16:9 coded frame, pillarbox 14:9 image, horizontally centered in the coded frame.

GstVideo.VideoAFDValue.4_3_FULL_14_9_CENTER (13) –

For 4:3 coded frame, full frame 4:3 image, with alternative 14:9 center. For 16:9 coded frame, pillarbox 4:3 image, with alternative 14:9 center.

GstVideo.VideoAFDValue.16_9_LETTER_14_9_CENTER (14) –

For 4:3 coded frame, letterbox 16:9 image, with alternative 14:9 center. For 16:9 coded frame, full frame 16:9 image, with alternative 14:9 center.

GstVideo.VideoAFDValue.16_9_LETTER_4_3_CENTER (15) –

For 4:3 coded frame, letterbox 16:9 image, with alternative 4:3 center. For 16:9 coded frame, full frame 16:9 image, with alternative 4:3 center.


GstVideoAncillaryDID

Members
GST_VIDEO_ANCILLARY_DID_UNDEFINED (0) –
No description available
GST_VIDEO_ANCILLARY_DID_DELETION (128) –
No description available
GST_VIDEO_ANCILLARY_DID_HANC_3G_AUDIO_DATA_FIRST (160) –
No description available
GST_VIDEO_ANCILLARY_DID_HANC_3G_AUDIO_DATA_LAST (167) –
No description available
GST_VIDEO_ANCILLARY_DID_HANC_HDTV_AUDIO_DATA_FIRST (224) –
No description available
GST_VIDEO_ANCILLARY_DID_HANC_HDTV_AUDIO_DATA_LAST (231) –
No description available
GST_VIDEO_ANCILLARY_DID_HANC_SDTV_AUDIO_DATA_1_FIRST (236) –
No description available
GST_VIDEO_ANCILLARY_DID_HANC_SDTV_AUDIO_DATA_1_LAST (239) –
No description available
GST_VIDEO_ANCILLARY_DID_CAMERA_POSITION (240) –
No description available
GST_VIDEO_ANCILLARY_DID_HANC_ERROR_DETECTION (244) –
No description available
GST_VIDEO_ANCILLARY_DID_HANC_SDTV_AUDIO_DATA_2_FIRST (248) –
No description available
GST_VIDEO_ANCILLARY_DID_HANC_SDTV_AUDIO_DATA_2_LAST (255) –
No description available

GstVideo.VideoAncillaryDID

Members
GstVideo.VideoAncillaryDID.UNDEFINED (0) –
No description available
GstVideo.VideoAncillaryDID.DELETION (128) –
No description available
GstVideo.VideoAncillaryDID.HANC_3G_AUDIO_DATA_FIRST (160) –
No description available
GstVideo.VideoAncillaryDID.HANC_3G_AUDIO_DATA_LAST (167) –
No description available
GstVideo.VideoAncillaryDID.HANC_HDTV_AUDIO_DATA_FIRST (224) –
No description available
GstVideo.VideoAncillaryDID.HANC_HDTV_AUDIO_DATA_LAST (231) –
No description available
GstVideo.VideoAncillaryDID.HANC_SDTV_AUDIO_DATA_1_FIRST (236) –
No description available
GstVideo.VideoAncillaryDID.HANC_SDTV_AUDIO_DATA_1_LAST (239) –
No description available
GstVideo.VideoAncillaryDID.CAMERA_POSITION (240) –
No description available
GstVideo.VideoAncillaryDID.HANC_ERROR_DETECTION (244) –
No description available
GstVideo.VideoAncillaryDID.HANC_SDTV_AUDIO_DATA_2_FIRST (248) –
No description available
GstVideo.VideoAncillaryDID.HANC_SDTV_AUDIO_DATA_2_LAST (255) –
No description available

GstVideo.VideoAncillaryDID

Members
GstVideo.VideoAncillaryDID.UNDEFINED (0) –
No description available
GstVideo.VideoAncillaryDID.DELETION (128) –
No description available
GstVideo.VideoAncillaryDID.HANC_3G_AUDIO_DATA_FIRST (160) –
No description available
GstVideo.VideoAncillaryDID.HANC_3G_AUDIO_DATA_LAST (167) –
No description available
GstVideo.VideoAncillaryDID.HANC_HDTV_AUDIO_DATA_FIRST (224) –
No description available
GstVideo.VideoAncillaryDID.HANC_HDTV_AUDIO_DATA_LAST (231) –
No description available
GstVideo.VideoAncillaryDID.HANC_SDTV_AUDIO_DATA_1_FIRST (236) –
No description available
GstVideo.VideoAncillaryDID.HANC_SDTV_AUDIO_DATA_1_LAST (239) –
No description available
GstVideo.VideoAncillaryDID.CAMERA_POSITION (240) –
No description available
GstVideo.VideoAncillaryDID.HANC_ERROR_DETECTION (244) –
No description available
GstVideo.VideoAncillaryDID.HANC_SDTV_AUDIO_DATA_2_FIRST (248) –
No description available
GstVideo.VideoAncillaryDID.HANC_SDTV_AUDIO_DATA_2_LAST (255) –
No description available

GstVideoAncillaryDID16

Some know types of Ancillary Data identifiers.

Members
GST_VIDEO_ANCILLARY_DID16_S334_EIA_708 (24833) –

CEA 708 Ancillary data according to SMPTE 334

GST_VIDEO_ANCILLARY_DID16_S334_EIA_608 (24834) –

CEA 608 Ancillary data according to SMPTE 334

GST_VIDEO_ANCILLARY_DID16_S2016_3_AFD_BAR (16645) –

AFD/Bar Ancillary data according to SMPTE 2016-3 (Since: 1.18)


GstVideo.VideoAncillaryDID16

Some know types of Ancillary Data identifiers.

Members
GstVideo.VideoAncillaryDID16.S334_EIA_708 (24833) –

CEA 708 Ancillary data according to SMPTE 334

GstVideo.VideoAncillaryDID16.S334_EIA_608 (24834) –

CEA 608 Ancillary data according to SMPTE 334

GstVideo.VideoAncillaryDID16.S2016_3_AFD_BAR (16645) –

AFD/Bar Ancillary data according to SMPTE 2016-3 (Since: 1.18)


GstVideo.VideoAncillaryDID16

Some know types of Ancillary Data identifiers.

Members
GstVideo.VideoAncillaryDID16.S334_EIA_708 (24833) –

CEA 708 Ancillary data according to SMPTE 334

GstVideo.VideoAncillaryDID16.S334_EIA_608 (24834) –

CEA 608 Ancillary data according to SMPTE 334

GstVideo.VideoAncillaryDID16.S2016_3_AFD_BAR (16645) –

AFD/Bar Ancillary data according to SMPTE 2016-3 (Since: 1.18)


GstVideoCaptionType

The various known types of Closed Caption (CC).

Members
GST_VIDEO_CAPTION_TYPE_UNKNOWN (0) –

Unknown type of CC

GST_VIDEO_CAPTION_TYPE_CEA608_RAW (1) –

CEA-608 as byte pairs. Note that this format is not recommended since is does not specify to which field the caption comes from and therefore assumes it comes from the first field (and that there is no information on the second field). Use GST_VIDEO_CAPTION_TYPE_CEA708_RAW if you wish to store CEA-608 from two fields and prefix each byte pair with 0xFC for the first field and 0xFD for the second field.

GST_VIDEO_CAPTION_TYPE_CEA608_S334_1A (2) –

CEA-608 as byte triplets as defined in SMPTE S334-1 Annex A. The second and third byte of the byte triplet is the raw CEA608 data, the first byte is a bitfield: The top/7th bit is 0 for the second field, 1 for the first field, bit 6 and 5 are 0 and bits 4 to 0 are a 5 bit unsigned integer that represents the line offset relative to the base-line of the original image format (line 9 for 525-line field 1, line 272 for 525-line field 2, line 5 for 625-line field 1 and line 318 for 625-line field 2).

GST_VIDEO_CAPTION_TYPE_CEA708_RAW (3) –

CEA-708 as cc_data byte triplets. They can also contain 608-in-708 and the first byte of each triplet has to be inspected for detecting the type.

GST_VIDEO_CAPTION_TYPE_CEA708_CDP (4) –

CEA-708 (and optionally CEA-608) in a CDP (Caption Distribution Packet) defined by SMPTE S-334-2. Contains the whole CDP (starting with 0x9669).


GstVideo.VideoCaptionType

The various known types of Closed Caption (CC).

Members
GstVideo.VideoCaptionType.UNKNOWN (0) –

Unknown type of CC

GstVideo.VideoCaptionType.CEA608_RAW (1) –

CEA-608 as byte pairs. Note that this format is not recommended since is does not specify to which field the caption comes from and therefore assumes it comes from the first field (and that there is no information on the second field). Use GST_VIDEO_CAPTION_TYPE_CEA708_RAW if you wish to store CEA-608 from two fields and prefix each byte pair with 0xFC for the first field and 0xFD for the second field.

GstVideo.VideoCaptionType.CEA608_S334_1A (2) –

CEA-608 as byte triplets as defined in SMPTE S334-1 Annex A. The second and third byte of the byte triplet is the raw CEA608 data, the first byte is a bitfield: The top/7th bit is 0 for the second field, 1 for the first field, bit 6 and 5 are 0 and bits 4 to 0 are a 5 bit unsigned integer that represents the line offset relative to the base-line of the original image format (line 9 for 525-line field 1, line 272 for 525-line field 2, line 5 for 625-line field 1 and line 318 for 625-line field 2).

GstVideo.VideoCaptionType.CEA708_RAW (3) –

CEA-708 as cc_data byte triplets. They can also contain 608-in-708 and the first byte of each triplet has to be inspected for detecting the type.

GstVideo.VideoCaptionType.CEA708_CDP (4) –

CEA-708 (and optionally CEA-608) in a CDP (Caption Distribution Packet) defined by SMPTE S-334-2. Contains the whole CDP (starting with 0x9669).


GstVideo.VideoCaptionType

The various known types of Closed Caption (CC).

Members
GstVideo.VideoCaptionType.UNKNOWN (0) –

Unknown type of CC

GstVideo.VideoCaptionType.CEA608_RAW (1) –

CEA-608 as byte pairs. Note that this format is not recommended since is does not specify to which field the caption comes from and therefore assumes it comes from the first field (and that there is no information on the second field). Use GST_VIDEO_CAPTION_TYPE_CEA708_RAW if you wish to store CEA-608 from two fields and prefix each byte pair with 0xFC for the first field and 0xFD for the second field.

GstVideo.VideoCaptionType.CEA608_S334_1A (2) –

CEA-608 as byte triplets as defined in SMPTE S334-1 Annex A. The second and third byte of the byte triplet is the raw CEA608 data, the first byte is a bitfield: The top/7th bit is 0 for the second field, 1 for the first field, bit 6 and 5 are 0 and bits 4 to 0 are a 5 bit unsigned integer that represents the line offset relative to the base-line of the original image format (line 9 for 525-line field 1, line 272 for 525-line field 2, line 5 for 625-line field 1 and line 318 for 625-line field 2).

GstVideo.VideoCaptionType.CEA708_RAW (3) –

CEA-708 as cc_data byte triplets. They can also contain 608-in-708 and the first byte of each triplet has to be inspected for detecting the type.

GstVideo.VideoCaptionType.CEA708_CDP (4) –

CEA-708 (and optionally CEA-608) in a CDP (Caption Distribution Packet) defined by SMPTE S-334-2. Contains the whole CDP (starting with 0x9669).


GstVideoVBIParserResult

Return values for GstVideoVBIParser

Members
GST_VIDEO_VBI_PARSER_RESULT_DONE (0) –

No line were provided, or no more Ancillary data was found.

GST_VIDEO_VBI_PARSER_RESULT_OK (1) –

A GstVideoAncillary was found.

GST_VIDEO_VBI_PARSER_RESULT_ERROR (2) –

An error occurred


GstVideo.VideoVBIParserResult

Return values for GstVideo.VideoVBIParser

Members
GstVideo.VideoVBIParserResult.DONE (0) –

No line were provided, or no more Ancillary data was found.

GstVideo.VideoVBIParserResult.OK (1) –

A GstVideo.VideoAncillary was found.

GstVideo.VideoVBIParserResult.ERROR (2) –

An error occurred


GstVideo.VideoVBIParserResult

Return values for GstVideo.VideoVBIParser

Members
GstVideo.VideoVBIParserResult.DONE (0) –

No line were provided, or no more Ancillary data was found.

GstVideo.VideoVBIParserResult.OK (1) –

A GstVideo.VideoAncillary was found.

GstVideo.VideoVBIParserResult.ERROR (2) –

An error occurred


Constants

GST_VIDEO_AFD_META_API_TYPE

#define GST_VIDEO_AFD_META_API_TYPE (gst_video_afd_meta_api_get_type())

GST_VIDEO_AFD_META_INFO

#define GST_VIDEO_AFD_META_INFO (gst_video_afd_meta_get_info())

GST_VIDEO_BAR_META_API_TYPE

#define GST_VIDEO_BAR_META_API_TYPE (gst_video_bar_meta_api_get_type())

GST_VIDEO_BAR_META_INFO

#define GST_VIDEO_BAR_META_INFO (gst_video_bar_meta_get_info())

GST_VIDEO_CAPTION_META_API_TYPE

#define GST_VIDEO_CAPTION_META_API_TYPE (gst_video_caption_meta_api_get_type())

GST_VIDEO_CAPTION_META_INFO

#define GST_VIDEO_CAPTION_META_INFO (gst_video_caption_meta_get_info())

The results of the search are