GstVideoColorVolumeTransformation

Processing window in dynamic metadata defined in SMPTE ST 2094-40:2016 and CTA-861-G Annex S HDR Dynamic Metadata Syntax Type 4.

Members

window_upper_left_corner_x (guint16) –

the x coordinate of the top left pixel of the w-th processing

window_upper_left_corner_y (guint16) –

the y coordinate of the top left pixel of the w-th processing

window_lower_right_corner_x (guint16) –

the x coordinate of the lower right pixel of the w-th processing

window_lower_right_corner_y (guint16) –

the y coordinate of the lower right pixel of the w-th processing

center_of_ellipse_x (guint16) –

the x coordinate of the center position of the concentric internal and external ellipses of the elliptical pixel selector in the w-th processing window

center_of_ellipse_y (guint16) –

the y coordinate of the center position of the concentric internal and external ellipses of the elliptical pixel selector in the w-th processing window

rotation_angle (guint8) –

the clockwise rotation angle in degree of arc with respect to the positive direction of the x-axis of the concentric internal and external ellipses of the elliptical pixel selector in the w-th processing window

semimajor_axis_internal_ellipse (guint16) –

the semi-major axis value of the internal ellipse of the elliptical pixel selector in amount of pixels in the w-th processing window

semimajor_axis_external_ellipse (guint16) –

the semi-major axis value of the external ellipse of the elliptical pixel selector in amount of pixels in the w-th processing window

semiminor_axis_external_ellipse (guint16) –

the semi-minor axis value of the external ellipse of the elliptical pixel selector in amount of pixels in the w-th processing window

overlap_process_option (guint8) –

one of the two methods of combining rendered pixels in the w-th processing window in an image with at least one elliptical pixel selector

maxscl (guint32 *) –

the maximum of the i-th color component of linearized RGB values in the w-th processing window in the scene

average_maxrgb (guint32) –

the average of linearized maxRGB values in the w-th processing window in the scene

num_distributions (guint8) –
No description available
distribution_index (guint8 *) –

the interpretation of the corresponding distribution_values[w][i] value. Values of 0 through 98 indicate that distribution_values[w][i] contains the value below which distribution_index[w][i] percent of the linearized maxRGB values in the scene for the w-th processing window fall. A value of 99 indicates that distribution_values[w][i] contains the value below which 99.98% of the linearized maxRGB values in the scene for the w-th processing window fall.The value shall be in the range of 0 to 99, inclusive

distribution_values (guint32 *) –

the linearized maxRGB value at the percentile specified by distribution_index[w][i] in the w-th processing window in the scene. The value shall be in the range of 0 to 100,000, inclusive, representing 0 to 10,000 cd/m2.

fraction_bright_pixels (guint16) –

the fraction of selected pixels in the image that contains the brightest pixel in the scene

tone_mapping_flag (guint8) –

true if the tone mapping function in the w-th processing window is present

knee_point_x (guint16) –

the x coordinate of the separation point between the linear part and the curved part of the tone mapping function

knee_point_y (guint16) –

the y coordinate of the separation point between the linear part and the curved part of the tone mapping function

num_bezier_curve_anchors (guint8) –

the number of the intermediate anchor parameters of the tone mapping function in the w-th processing window. Maximum value should be 9.

bezier_curve_anchors (guint16 *) –

the i-th intermediate anchor parameter of the tone mapping function in the w-th processing window in the scene

color_saturation_mapping_flag (guint8) –

shall be equal to zero in this version of the standard.

color_saturation_weight (guint8) –

a number that shall adjust the color saturation gain in the w-th processing window in the scene

Since : 1.30

GstVideo.VideoColorVolumeTransformation

Processing window in dynamic metadata defined in SMPTE ST 2094-40:2016 and CTA-861-G Annex S HDR Dynamic Metadata Syntax Type 4.

Members

window_upper_left_corner_x (Number) –

the x coordinate of the top left pixel of the w-th processing

window_upper_left_corner_y (Number) –

the y coordinate of the top left pixel of the w-th processing

window_lower_right_corner_x (Number) –

the x coordinate of the lower right pixel of the w-th processing

window_lower_right_corner_y (Number) –

the y coordinate of the lower right pixel of the w-th processing

center_of_ellipse_x (Number) –

the x coordinate of the center position of the concentric internal and external ellipses of the elliptical pixel selector in the w-th processing window

center_of_ellipse_y (Number) –

the y coordinate of the center position of the concentric internal and external ellipses of the elliptical pixel selector in the w-th processing window

rotation_angle (Number) –

the clockwise rotation angle in degree of arc with respect to the positive direction of the x-axis of the concentric internal and external ellipses of the elliptical pixel selector in the w-th processing window

semimajor_axis_internal_ellipse (Number) –

the semi-major axis value of the internal ellipse of the elliptical pixel selector in amount of pixels in the w-th processing window

semimajor_axis_external_ellipse (Number) –

the semi-major axis value of the external ellipse of the elliptical pixel selector in amount of pixels in the w-th processing window

semiminor_axis_external_ellipse (Number) –

the semi-minor axis value of the external ellipse of the elliptical pixel selector in amount of pixels in the w-th processing window

overlap_process_option (Number) –

one of the two methods of combining rendered pixels in the w-th processing window in an image with at least one elliptical pixel selector

maxscl ([ Number ]) –

the maximum of the i-th color component of linearized RGB values in the w-th processing window in the scene

average_maxrgb (Number) –

the average of linearized maxRGB values in the w-th processing window in the scene

num_distributions (Number) –
No description available
distribution_index ([ Number ]) –

the interpretation of the corresponding distribution_values[w][i] value. Values of 0 through 98 indicate that distribution_values[w][i] contains the value below which distribution_index[w][i] percent of the linearized maxRGB values in the scene for the w-th processing window fall. A value of 99 indicates that distribution_values[w][i] contains the value below which 99.98% of the linearized maxRGB values in the scene for the w-th processing window fall.The value shall be in the range of 0 to 99, inclusive

distribution_values ([ Number ]) –

the linearized maxRGB value at the percentile specified by distribution_index[w][i] in the w-th processing window in the scene. The value shall be in the range of 0 to 100,000, inclusive, representing 0 to 10,000 cd/m2.

fraction_bright_pixels (Number) –

the fraction of selected pixels in the image that contains the brightest pixel in the scene

tone_mapping_flag (Number) –

true if the tone mapping function in the w-th processing window is present

knee_point_x (Number) –

the x coordinate of the separation point between the linear part and the curved part of the tone mapping function

knee_point_y (Number) –

the y coordinate of the separation point between the linear part and the curved part of the tone mapping function

num_bezier_curve_anchors (Number) –

the number of the intermediate anchor parameters of the tone mapping function in the w-th processing window. Maximum value should be 9.

bezier_curve_anchors ([ Number ]) –

the i-th intermediate anchor parameter of the tone mapping function in the w-th processing window in the scene

color_saturation_mapping_flag (Number) –

shall be equal to zero in this version of the standard.

color_saturation_weight (Number) –

a number that shall adjust the color saturation gain in the w-th processing window in the scene

Since : 1.30

GstVideo.VideoColorVolumeTransformation

Processing window in dynamic metadata defined in SMPTE ST 2094-40:2016 and CTA-861-G Annex S HDR Dynamic Metadata Syntax Type 4.

Members

window_upper_left_corner_x (int) –

the x coordinate of the top left pixel of the w-th processing

window_upper_left_corner_y (int) –

the y coordinate of the top left pixel of the w-th processing

window_lower_right_corner_x (int) –

the x coordinate of the lower right pixel of the w-th processing

window_lower_right_corner_y (int) –

the y coordinate of the lower right pixel of the w-th processing

center_of_ellipse_x (int) –

the x coordinate of the center position of the concentric internal and external ellipses of the elliptical pixel selector in the w-th processing window

center_of_ellipse_y (int) –

the y coordinate of the center position of the concentric internal and external ellipses of the elliptical pixel selector in the w-th processing window

rotation_angle (int) –

the clockwise rotation angle in degree of arc with respect to the positive direction of the x-axis of the concentric internal and external ellipses of the elliptical pixel selector in the w-th processing window

semimajor_axis_internal_ellipse (int) –

the semi-major axis value of the internal ellipse of the elliptical pixel selector in amount of pixels in the w-th processing window

semimajor_axis_external_ellipse (int) –

the semi-major axis value of the external ellipse of the elliptical pixel selector in amount of pixels in the w-th processing window

semiminor_axis_external_ellipse (int) –

the semi-minor axis value of the external ellipse of the elliptical pixel selector in amount of pixels in the w-th processing window

overlap_process_option (int) –

one of the two methods of combining rendered pixels in the w-th processing window in an image with at least one elliptical pixel selector

maxscl ([ int ]) –

the maximum of the i-th color component of linearized RGB values in the w-th processing window in the scene

average_maxrgb (int) –

the average of linearized maxRGB values in the w-th processing window in the scene

num_distributions (int) –
No description available
distribution_index ([ int ]) –

the interpretation of the corresponding distribution_values[w][i] value. Values of 0 through 98 indicate that distribution_values[w][i] contains the value below which distribution_index[w][i] percent of the linearized maxRGB values in the scene for the w-th processing window fall. A value of 99 indicates that distribution_values[w][i] contains the value below which 99.98% of the linearized maxRGB values in the scene for the w-th processing window fall.The value shall be in the range of 0 to 99, inclusive

distribution_values ([ int ]) –

the linearized maxRGB value at the percentile specified by distribution_index[w][i] in the w-th processing window in the scene. The value shall be in the range of 0 to 100,000, inclusive, representing 0 to 10,000 cd/m2.

fraction_bright_pixels (int) –

the fraction of selected pixels in the image that contains the brightest pixel in the scene

tone_mapping_flag (int) –

true if the tone mapping function in the w-th processing window is present

knee_point_x (int) –

the x coordinate of the separation point between the linear part and the curved part of the tone mapping function

knee_point_y (int) –

the y coordinate of the separation point between the linear part and the curved part of the tone mapping function

num_bezier_curve_anchors (int) –

the number of the intermediate anchor parameters of the tone mapping function in the w-th processing window. Maximum value should be 9.

bezier_curve_anchors ([ int ]) –

the i-th intermediate anchor parameter of the tone mapping function in the w-th processing window in the scene

color_saturation_mapping_flag (int) –

shall be equal to zero in this version of the standard.

color_saturation_weight (int) –

a number that shall adjust the color saturation gain in the w-th processing window in the scene

Since : 1.30

GstVideoContentLightLevel

Content light level information specified in CEA-861.3, Appendix A.

Members

max_content_light_level (guint16) –

the maximum content light level (abbreviated to MaxCLL) in candelas per square meter (cd/m^2 and nit)

max_frame_average_light_level (guint16) –

the maximum frame average light level (abbreviated to MaxFLL) in candelas per square meter (cd/m^2 and nit)

Since : 1.18

GstVideo.VideoContentLightLevel

Content light level information specified in CEA-861.3, Appendix A.

Members

max_content_light_level (Number) –

the maximum content light level (abbreviated to MaxCLL) in candelas per square meter (cd/m^2 and nit)

max_frame_average_light_level (Number) –

the maximum frame average light level (abbreviated to MaxFLL) in candelas per square meter (cd/m^2 and nit)

Since : 1.18

GstVideo.VideoContentLightLevel

Content light level information specified in CEA-861.3, Appendix A.

Members

max_content_light_level (int) –

the maximum content light level (abbreviated to MaxCLL) in candelas per square meter (cd/m^2 and nit)

max_frame_average_light_level (int) –

the maximum frame average light level (abbreviated to MaxFLL) in candelas per square meter (cd/m^2 and nit)

Since : 1.18

Methods

gst_video_content_light_level_add_to_caps 

gboolean
gst_video_content_light_level_add_to_caps (const GstVideoContentLightLevel * linfo,
                                           GstCaps * caps)

Parse caps and update linfo

Parameters:

linfo –

a GstVideoContentLightLevel

caps –

a GstCaps

Returns –

TRUE if linfo was successfully set to caps

Since : 1.18

GstVideo.VideoContentLightLevel.prototype.add_to_caps 

function GstVideo.VideoContentLightLevel.prototype.add_to_caps(caps: Gst.Caps): {
    // javascript wrapper for 'gst_video_content_light_level_add_to_caps'
}

Parse caps and update linfo

Parameters:

a GstVideo.VideoContentLightLevel

caps (Gst.Caps) –

a Gst.Caps

Returns (Number) –

true if linfo was successfully set to caps

Since : 1.18

GstVideo.VideoContentLightLevel.add_to_caps 

def GstVideo.VideoContentLightLevel.add_to_caps (self, caps):
    #python wrapper for 'gst_video_content_light_level_add_to_caps'

Parse caps and update linfo

Parameters:

a GstVideo.VideoContentLightLevel

caps (Gst.Caps) –

a Gst.Caps

Returns (bool) –

True if linfo was successfully set to caps

Since : 1.18

gst_video_content_light_level_from_caps 

gboolean
gst_video_content_light_level_from_caps (GstVideoContentLightLevel * linfo,
                                         const GstCaps * caps)

Parse caps and update linfo

Parameters:

linfo –

a GstVideoContentLightLevel

caps –

a GstCaps

Returns –

if caps has GstVideoContentLightLevel and could be parsed

Since : 1.18

GstVideo.VideoContentLightLevel.prototype.from_caps 

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

Parse caps and update linfo

Parameters:

a GstVideo.VideoContentLightLevel

caps (Gst.Caps) –

a Gst.Caps

Returns (Number) –

if caps has GstVideo.VideoContentLightLevel and could be parsed

Since : 1.18

GstVideo.VideoContentLightLevel.from_caps 

def GstVideo.VideoContentLightLevel.from_caps (self, caps):
    #python wrapper for 'gst_video_content_light_level_from_caps'

Parse caps and update linfo

Parameters:

a GstVideo.VideoContentLightLevel

caps (Gst.Caps) –

a Gst.Caps

Returns (bool) –

if caps has GstVideo.VideoContentLightLevel and could be parsed

Since : 1.18

gst_video_content_light_level_from_string 

gboolean
gst_video_content_light_level_from_string (GstVideoContentLightLevel * linfo,
                                           const gchar * level)

Parse the value of content-light-level caps field and update minfo with the parsed values.

Parameters:

linfo –

a GstVideoContentLightLevel

level –

a content-light-level string from caps

Returns –

TRUE if linfo points to valid GstVideoContentLightLevel.

Since : 1.18

GstVideo.VideoContentLightLevel.prototype.from_string 

function GstVideo.VideoContentLightLevel.prototype.from_string(level: String): {
    // javascript wrapper for 'gst_video_content_light_level_from_string'
}

Parse the value of content-light-level caps field and update minfo with the parsed values.

Parameters:

a GstVideo.VideoContentLightLevel

level (String) –

a content-light-level string from caps

Returns (Number) –

true if linfo points to valid GstVideo.VideoContentLightLevel.

Since : 1.18

GstVideo.VideoContentLightLevel.from_string 

def GstVideo.VideoContentLightLevel.from_string (self, level):
    #python wrapper for 'gst_video_content_light_level_from_string'

Parse the value of content-light-level caps field and update minfo with the parsed values.

Parameters:

a GstVideo.VideoContentLightLevel

level (str) –

a content-light-level string from caps

Returns (bool) –

True if linfo points to valid GstVideo.VideoContentLightLevel.

Since : 1.18

gst_video_content_light_level_init 

gst_video_content_light_level_init (GstVideoContentLightLevel * linfo)

Initialize linfo

Parameters:

linfo –

a GstVideoContentLightLevel

Since : 1.18

GstVideo.VideoContentLightLevel.prototype.init 

function GstVideo.VideoContentLightLevel.prototype.init(): {
    // javascript wrapper for 'gst_video_content_light_level_init'
}

Initialize linfo

Parameters:

a GstVideo.VideoContentLightLevel

Since : 1.18

GstVideo.VideoContentLightLevel.init 

def GstVideo.VideoContentLightLevel.init (self):
    #python wrapper for 'gst_video_content_light_level_init'

Initialize linfo

Parameters:

a GstVideo.VideoContentLightLevel

Since : 1.18

gst_video_content_light_level_is_equal 

gboolean
gst_video_content_light_level_is_equal (const GstVideoContentLightLevel * linfo,
                                        const GstVideoContentLightLevel * other)

Checks equality between linfo and other.

Parameters:

linfo –

a GstVideoContentLightLevel

other –

a GstVideoContentLightLevel

Returns –

TRUE if linfo and other are equal.

Since : 1.20

GstVideo.VideoContentLightLevel.prototype.is_equal 

function GstVideo.VideoContentLightLevel.prototype.is_equal(other: GstVideo.VideoContentLightLevel): {
    // javascript wrapper for 'gst_video_content_light_level_is_equal'
}

Checks equality between linfo and other.

Parameters:

a GstVideo.VideoContentLightLevel

a GstVideo.VideoContentLightLevel

Returns (Number) –

true if linfo and other are equal.

Since : 1.20

GstVideo.VideoContentLightLevel.is_equal 

def GstVideo.VideoContentLightLevel.is_equal (self, other):
    #python wrapper for 'gst_video_content_light_level_is_equal'

Checks equality between linfo and other.

Parameters:

a GstVideo.VideoContentLightLevel

a GstVideo.VideoContentLightLevel

Returns (bool) –

True if linfo and other are equal.

Since : 1.20

gst_video_content_light_level_to_string 

gchar *
gst_video_content_light_level_to_string (const GstVideoContentLightLevel * linfo)

Convert linfo to its string representation.

Parameters:

linfo –

a GstVideoContentLightLevel

Returns ( [transfer: full]) –

a string representation of linfo.

Since : 1.18

GstVideo.VideoContentLightLevel.prototype.to_string 

function GstVideo.VideoContentLightLevel.prototype.to_string(): {
    // javascript wrapper for 'gst_video_content_light_level_to_string'
}

Convert linfo to its string representation.

Parameters:

a GstVideo.VideoContentLightLevel

Returns (String) –

a string representation of linfo.

Since : 1.18

GstVideo.VideoContentLightLevel.to_string 

def GstVideo.VideoContentLightLevel.to_string (self):
    #python wrapper for 'gst_video_content_light_level_to_string'

Convert linfo to its string representation.

Parameters:

a GstVideo.VideoContentLightLevel

Returns (str) –

a string representation of linfo.

Since : 1.18

GstVideoHDR10Plus

Dynamic HDR 10+ metadata defined in SMPTE2094-40 and CTA-861-G Annex S HDR Dynamic Metadata Syntax Type 4.

Members

application_identifier (guint8) –

the application identifier

application_version (guint8) –

the application version

num_windows (guint8) –

the number of processing windows. The first processing window shall be for the entire picture

processing_window (GstVideoColorVolumeTransformation *) –

the color volume transformation for the processing window.

targeted_system_display_maximum_luminance (guint32) –

the nominal maximum display luminance of the targeted system display in units of 0.0001 candelas per square meter

targeted_system_display_actual_peak_luminance_flag (guint8) –

shall be equal to zero in this version of the standard

num_rows_targeted_system_display_actual_peak_luminance (guint8) –

the number of rows in the targeted_system_display_actual_peak_luminance array

num_cols_targeted_system_display_actual_peak_luminance (guint8) –

the number of columns in the targeted_system_display_actual_peak_luminance array

targeted_system_display_actual_peak_luminance (guint8 *) –

the normalized actual peak luminance of the targeted system display

mastering_display_actual_peak_luminance_flag (guint8) –

shall be equal to 0 for this version of this Standard

num_rows_mastering_display_actual_peak_luminance (guint8) –

the number of rows in the mastering_display_actual_peak_luminance array

num_cols_mastering_display_actual_peak_luminance (guint8) –

the number of columns in the mastering_display_actual_peak_luminance array.

mastering_display_actual_peak_luminance (guint8 *) –

the normalized actual peak luminance of the mastering display used for mastering the image essence

Since : 1.30

GstVideo.VideoHDR10Plus

Dynamic HDR 10+ metadata defined in SMPTE2094-40 and CTA-861-G Annex S HDR Dynamic Metadata Syntax Type 4.

Members

application_identifier (Number) –

the application identifier

application_version (Number) –

the application version

num_windows (Number) –

the number of processing windows. The first processing window shall be for the entire picture

processing_window ([ GstVideo.VideoColorVolumeTransformation ]) –

the color volume transformation for the processing window.

targeted_system_display_maximum_luminance (Number) –

the nominal maximum display luminance of the targeted system display in units of 0.0001 candelas per square meter

targeted_system_display_actual_peak_luminance_flag (Number) –

shall be equal to zero in this version of the standard

num_rows_targeted_system_display_actual_peak_luminance (Number) –

the number of rows in the targeted_system_display_actual_peak_luminance array

num_cols_targeted_system_display_actual_peak_luminance (Number) –

the number of columns in the targeted_system_display_actual_peak_luminance array

targeted_system_display_actual_peak_luminance ([ Number ]) –

the normalized actual peak luminance of the targeted system display

mastering_display_actual_peak_luminance_flag (Number) –

shall be equal to 0 for this version of this Standard

num_rows_mastering_display_actual_peak_luminance (Number) –

the number of rows in the mastering_display_actual_peak_luminance array

num_cols_mastering_display_actual_peak_luminance (Number) –

the number of columns in the mastering_display_actual_peak_luminance array.

mastering_display_actual_peak_luminance ([ Number ]) –

the normalized actual peak luminance of the mastering display used for mastering the image essence

Since : 1.30

GstVideo.VideoHDR10Plus

Dynamic HDR 10+ metadata defined in SMPTE2094-40 and CTA-861-G Annex S HDR Dynamic Metadata Syntax Type 4.

Members

application_identifier (int) –

the application identifier

application_version (int) –

the application version

num_windows (int) –

the number of processing windows. The first processing window shall be for the entire picture

processing_window ([ GstVideo.VideoColorVolumeTransformation ]) –

the color volume transformation for the processing window.

targeted_system_display_maximum_luminance (int) –

the nominal maximum display luminance of the targeted system display in units of 0.0001 candelas per square meter

targeted_system_display_actual_peak_luminance_flag (int) –

shall be equal to zero in this version of the standard

num_rows_targeted_system_display_actual_peak_luminance (int) –

the number of rows in the targeted_system_display_actual_peak_luminance array

num_cols_targeted_system_display_actual_peak_luminance (int) –

the number of columns in the targeted_system_display_actual_peak_luminance array

targeted_system_display_actual_peak_luminance ([ int ]) –

the normalized actual peak luminance of the targeted system display

mastering_display_actual_peak_luminance_flag (int) –

shall be equal to 0 for this version of this Standard

num_rows_mastering_display_actual_peak_luminance (int) –

the number of rows in the mastering_display_actual_peak_luminance array

num_cols_mastering_display_actual_peak_luminance (int) –

the number of columns in the mastering_display_actual_peak_luminance array.

mastering_display_actual_peak_luminance ([ int ]) –

the normalized actual peak luminance of the mastering display used for mastering the image essence

Since : 1.30

GstVideoHDRMeta

Dynamic HDR data should be included in video user data

Members

meta (GstMeta) –

parent GstMeta

format (GstVideoHDRFormat) –

The type of dynamic HDR contained in the meta.

data (guint8 *) –

contains the dynamic HDR data

size (gsize) –

The size in bytes of data

Since : 1.30

GstVideo.VideoHDRMeta

Dynamic HDR data should be included in video user data

Members

meta (Gst.Meta) –

parent Gst.Meta

The type of dynamic HDR contained in the meta.

data (Number) –

contains the dynamic HDR data

size (Number) –

The size in bytes of data

Since : 1.30

GstVideo.VideoHDRMeta

Dynamic HDR data should be included in video user data

Members

meta (Gst.Meta) –

parent Gst.Meta

The type of dynamic HDR contained in the meta.

data (int) –

contains the dynamic HDR data

size (int) –

The size in bytes of data

Since : 1.30

GstVideoMasteringDisplayInfo

Mastering display color volume information defined by SMPTE ST 2086 (a.k.a static HDR metadata).

Members

display_primaries (GstVideoMasteringDisplayInfoCoordinates *) –

the xy coordinates of primaries in the CIE 1931 color space. the index 0 contains red, 1 is for green and 2 is for blue. each value is normalized to 50000 (meaning that in unit of 0.00002)

the xy coordinates of white point in the CIE 1931 color space. each value is normalized to 50000 (meaning that in unit of 0.00002)

max_display_mastering_luminance (guint32) –

the maximum value of display luminance in unit of 0.0001 candelas per square metre (cd/m^2 and nit)

min_display_mastering_luminance (guint32) –

the minimum value of display luminance in unit of 0.0001 candelas per square metre (cd/m^2 and nit)

Since : 1.18

GstVideo.VideoMasteringDisplayInfo

Mastering display color volume information defined by SMPTE ST 2086 (a.k.a static HDR metadata).

Members

display_primaries ([ GstVideo.VideoMasteringDisplayInfoCoordinates ]) –

the xy coordinates of primaries in the CIE 1931 color space. the index 0 contains red, 1 is for green and 2 is for blue. each value is normalized to 50000 (meaning that in unit of 0.00002)

the xy coordinates of white point in the CIE 1931 color space. each value is normalized to 50000 (meaning that in unit of 0.00002)

max_display_mastering_luminance (Number) –

the maximum value of display luminance in unit of 0.0001 candelas per square metre (cd/m^2 and nit)

min_display_mastering_luminance (Number) –

the minimum value of display luminance in unit of 0.0001 candelas per square metre (cd/m^2 and nit)

Since : 1.18

GstVideo.VideoMasteringDisplayInfo

Mastering display color volume information defined by SMPTE ST 2086 (a.k.a static HDR metadata).

Members

display_primaries ([ GstVideo.VideoMasteringDisplayInfoCoordinates ]) –

the xy coordinates of primaries in the CIE 1931 color space. the index 0 contains red, 1 is for green and 2 is for blue. each value is normalized to 50000 (meaning that in unit of 0.00002)

the xy coordinates of white point in the CIE 1931 color space. each value is normalized to 50000 (meaning that in unit of 0.00002)

max_display_mastering_luminance (int) –

the maximum value of display luminance in unit of 0.0001 candelas per square metre (cd/m^2 and nit)

min_display_mastering_luminance (int) –

the minimum value of display luminance in unit of 0.0001 candelas per square metre (cd/m^2 and nit)

Since : 1.18

Methods

gst_video_mastering_display_info_add_to_caps 

gboolean
gst_video_mastering_display_info_add_to_caps (const GstVideoMasteringDisplayInfo * minfo,
                                              GstCaps * caps)

Set string representation of minfo to caps

Parameters:

minfo –

a GstVideoMasteringDisplayInfo

caps –

a GstCaps

Returns –

TRUE if minfo was successfully set to caps

Since : 1.18

GstVideo.VideoMasteringDisplayInfo.prototype.add_to_caps 

function GstVideo.VideoMasteringDisplayInfo.prototype.add_to_caps(caps: Gst.Caps): {
    // javascript wrapper for 'gst_video_mastering_display_info_add_to_caps'
}

Set string representation of minfo to caps

Parameters:

a GstVideo.VideoMasteringDisplayInfo

caps (Gst.Caps) –

a Gst.Caps

Returns (Number) –

true if minfo was successfully set to caps

Since : 1.18

GstVideo.VideoMasteringDisplayInfo.add_to_caps 

def GstVideo.VideoMasteringDisplayInfo.add_to_caps (self, caps):
    #python wrapper for 'gst_video_mastering_display_info_add_to_caps'

Set string representation of minfo to caps

Parameters:

a GstVideo.VideoMasteringDisplayInfo

caps (Gst.Caps) –

a Gst.Caps

Returns (bool) –

True if minfo was successfully set to caps

Since : 1.18

gst_video_mastering_display_info_from_caps 

gboolean
gst_video_mastering_display_info_from_caps (GstVideoMasteringDisplayInfo * minfo,
                                            const GstCaps * caps)

Parse caps and update minfo

Parameters:

minfo –

a GstVideoMasteringDisplayInfo

caps –

a GstCaps

Returns –

TRUE if caps has GstVideoMasteringDisplayInfo and could be parsed

Since : 1.18

GstVideo.VideoMasteringDisplayInfo.prototype.from_caps 

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

Parse caps and update minfo

Parameters:

a GstVideo.VideoMasteringDisplayInfo

caps (Gst.Caps) –

a Gst.Caps

Returns (Number) –

true if caps has GstVideo.VideoMasteringDisplayInfo and could be parsed

Since : 1.18

GstVideo.VideoMasteringDisplayInfo.from_caps 

def GstVideo.VideoMasteringDisplayInfo.from_caps (self, caps):
    #python wrapper for 'gst_video_mastering_display_info_from_caps'

Parse caps and update minfo

Parameters:

a GstVideo.VideoMasteringDisplayInfo

caps (Gst.Caps) –

a Gst.Caps

Returns (bool) –

True if caps has GstVideo.VideoMasteringDisplayInfo and could be parsed

Since : 1.18

gst_video_mastering_display_info_init 

gst_video_mastering_display_info_init (GstVideoMasteringDisplayInfo * minfo)

Initialize minfo

Parameters:

minfo –

a GstVideoMasteringDisplayInfo

Since : 1.18

GstVideo.VideoMasteringDisplayInfo.prototype.init 

function GstVideo.VideoMasteringDisplayInfo.prototype.init(): {
    // javascript wrapper for 'gst_video_mastering_display_info_init'
}

Initialize minfo

Parameters:

a GstVideo.VideoMasteringDisplayInfo

Since : 1.18

GstVideo.VideoMasteringDisplayInfo.init 

def GstVideo.VideoMasteringDisplayInfo.init (self):
    #python wrapper for 'gst_video_mastering_display_info_init'

Initialize minfo

Parameters:

a GstVideo.VideoMasteringDisplayInfo

Since : 1.18

gst_video_mastering_display_info_is_equal 

gboolean
gst_video_mastering_display_info_is_equal (const GstVideoMasteringDisplayInfo * minfo,
                                           const GstVideoMasteringDisplayInfo * other)

Checks equality between minfo and other.

Parameters:

minfo –

a GstVideoMasteringDisplayInfo

other –

a GstVideoMasteringDisplayInfo

Returns –

TRUE if minfo and other are equal.

Since : 1.18

GstVideo.VideoMasteringDisplayInfo.prototype.is_equal 

function GstVideo.VideoMasteringDisplayInfo.prototype.is_equal(other: GstVideo.VideoMasteringDisplayInfo): {
    // javascript wrapper for 'gst_video_mastering_display_info_is_equal'
}

Checks equality between minfo and other.

Parameters:

a GstVideo.VideoMasteringDisplayInfo

a GstVideo.VideoMasteringDisplayInfo

Returns (Number) –

true if minfo and other are equal.

Since : 1.18

GstVideo.VideoMasteringDisplayInfo.is_equal 

def GstVideo.VideoMasteringDisplayInfo.is_equal (self, other):
    #python wrapper for 'gst_video_mastering_display_info_is_equal'

Checks equality between minfo and other.

Parameters:

a GstVideo.VideoMasteringDisplayInfo

a GstVideo.VideoMasteringDisplayInfo

Returns (bool) –

True if minfo and other are equal.

Since : 1.18

gst_video_mastering_display_info_to_string 

gchar *
gst_video_mastering_display_info_to_string (const GstVideoMasteringDisplayInfo * minfo)

Convert minfo to its string representation

Parameters:

minfo –

a GstVideoMasteringDisplayInfo

Returns ( [transfer: full]) –

a string representation of minfo

Since : 1.18

GstVideo.VideoMasteringDisplayInfo.prototype.to_string 

function GstVideo.VideoMasteringDisplayInfo.prototype.to_string(): {
    // javascript wrapper for 'gst_video_mastering_display_info_to_string'
}

Convert minfo to its string representation

Parameters:

a GstVideo.VideoMasteringDisplayInfo

Returns (String) –

a string representation of minfo

Since : 1.18

GstVideo.VideoMasteringDisplayInfo.to_string 

def GstVideo.VideoMasteringDisplayInfo.to_string (self):
    #python wrapper for 'gst_video_mastering_display_info_to_string'

Convert minfo to its string representation

Parameters:

a GstVideo.VideoMasteringDisplayInfo

Returns (str) –

a string representation of minfo

Since : 1.18

Functions

gst_video_mastering_display_info_from_string 

gboolean
gst_video_mastering_display_info_from_string (GstVideoMasteringDisplayInfo * minfo,
                                              const gchar * mastering)

Extract GstVideoMasteringDisplayInfo from mastering

Parameters:

minfo ( [out]) –

a GstVideoMasteringDisplayInfo

mastering –

a GstStructure representing GstVideoMasteringDisplayInfo

Returns –

TRUE if minfo was filled with mastering

Since : 1.18

GstVideo.prototype.video_mastering_display_info_from_string 

function GstVideo.prototype.video_mastering_display_info_from_string(mastering: String): {
    // javascript wrapper for 'gst_video_mastering_display_info_from_string'
}

Extract GstVideo.VideoMasteringDisplayInfo from mastering

Parameters:

mastering (String) –

a Gst.Structure representing GstVideo.VideoMasteringDisplayInfo

Returns a tuple made of:

(Number ) –

true if minfo was filled with mastering

true if minfo was filled with mastering

Since : 1.18

GstVideo.video_mastering_display_info_from_string 

def GstVideo.video_mastering_display_info_from_string (mastering):
    #python wrapper for 'gst_video_mastering_display_info_from_string'

Extract GstVideo.VideoMasteringDisplayInfo from mastering

Parameters:

mastering (str) –

a Gst.Structure representing GstVideo.VideoMasteringDisplayInfo

Returns a tuple made of:

(bool ) –

True if minfo was filled with mastering

True if minfo was filled with mastering

Since : 1.18

GstVideoMasteringDisplayInfoCoordinates

Used to represent display_primaries and white_point of GstVideoMasteringDisplayInfo struct. See GstVideoMasteringDisplayInfo

Members

x (guint16) –

the x coordinate of CIE 1931 color space in unit of 0.00002.

y (guint16) –

the y coordinate of CIE 1931 color space in unit of 0.00002.

Since : 1.18

GstVideo.VideoMasteringDisplayInfoCoordinates

Used to represent display_primaries and white_point of GstVideo.VideoMasteringDisplayInfo struct. See GstVideo.VideoMasteringDisplayInfo

Members

x (Number) –

the x coordinate of CIE 1931 color space in unit of 0.00002.

y (Number) –

the y coordinate of CIE 1931 color space in unit of 0.00002.

Since : 1.18

GstVideo.VideoMasteringDisplayInfoCoordinates

Used to represent display_primaries and white_point of GstVideo.VideoMasteringDisplayInfo struct. See GstVideo.VideoMasteringDisplayInfo

Members

x (int) –

the x coordinate of CIE 1931 color space in unit of 0.00002.

y (int) –

the y coordinate of CIE 1931 color space in unit of 0.00002.

Since : 1.18

Functions

gst_buffer_add_video_hdr_meta 

GstVideoHDRMeta *
gst_buffer_add_video_hdr_meta (GstBuffer * buffer,
                               GstVideoHDRFormat format,
                               const guint8 * data,
                               gsize size)

Attaches GstVideoHDRMeta metadata to buffer with the given parameters.

Parameters:

buffer –

a GstBuffer

format –

The type of dynamic HDR contained in the meta.

data –

contains the dynamic HDR data

size –

The size in bytes of data

Returns ( [transfer: none]) –

the GstVideoHDRMeta on buffer.

Since : 1.30

GstVideo.prototype.buffer_add_video_hdr_meta 

function GstVideo.prototype.buffer_add_video_hdr_meta(buffer: Gst.Buffer, format: GstVideo.VideoHDRFormat, data: Number, size: Number): {
    // javascript wrapper for 'gst_buffer_add_video_hdr_meta'
}

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

Parameters:

buffer (Gst.Buffer) –

a Gst.Buffer

The type of dynamic HDR contained in the meta.

data (Number) –

contains the dynamic HDR data

size (Number) –

The size in bytes of data

Returns (GstVideo.VideoHDRMeta) –

the GstVideo.VideoHDRMeta on buffer.

Since : 1.30

GstVideo.buffer_add_video_hdr_meta 

def GstVideo.buffer_add_video_hdr_meta (buffer, format, data, size):
    #python wrapper for 'gst_buffer_add_video_hdr_meta'

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

Parameters:

buffer (Gst.Buffer) –

a Gst.Buffer

The type of dynamic HDR contained in the meta.

data (int) –

contains the dynamic HDR data

size (int) –

The size in bytes of data

Returns (GstVideo.VideoHDRMeta) –

the GstVideo.VideoHDRMeta on buffer.

Since : 1.30

gst_video_hdr_format_from_string 

GstVideoHDRFormat
gst_video_hdr_format_from_string (const gchar * format)

Parameters:

format ( [nullable]) –

a GstVideoHDRFormat

Returns –

the GstVideoHDRFormat for format or GST_VIDEO_HDR_FORMAT_NONE when the string is not a known format.

Since : 1.30

GstVideo.prototype.video_hdr_format_from_string 

function GstVideo.prototype.video_hdr_format_from_string(format: String): {
    // javascript wrapper for 'gst_video_hdr_format_from_string'
}

Parameters:

format (String) –

a GstVideo.VideoHDRFormat

Returns (GstVideo.VideoHDRFormat) –

the GstVideo.VideoHDRFormat for format or GST_VIDEO_HDR_FORMAT_NONE when the string is not a known format.

Since : 1.30

GstVideo.video_hdr_format_from_string 

def GstVideo.video_hdr_format_from_string (format):
    #python wrapper for 'gst_video_hdr_format_from_string'

Parameters:

format (str) –

a GstVideo.VideoHDRFormat

Returns (GstVideo.VideoHDRFormat) –

the GstVideo.VideoHDRFormat for format or GST_VIDEO_HDR_FORMAT_NONE when the string is not a known format.

Since : 1.30

gst_video_hdr_format_to_string 

const gchar *
gst_video_hdr_format_to_string (GstVideoHDRFormat format)

Parameters:

format –

a GstVideoHDRFormat

Returns ( [nullable]) –

a string containing a descriptive name for the GstVideoHDRFormat if there is one, or NULL otherwise.

Since : 1.30

GstVideo.prototype.video_hdr_format_to_string 

function GstVideo.prototype.video_hdr_format_to_string(format: GstVideo.VideoHDRFormat): {
    // javascript wrapper for 'gst_video_hdr_format_to_string'
}

Parameters:

a GstVideo.VideoHDRFormat

Returns (String) –

a string containing a descriptive name for the GstVideo.VideoHDRFormat if there is one, or null otherwise.

Since : 1.30

GstVideo.video_hdr_format_to_string 

def GstVideo.video_hdr_format_to_string (format):
    #python wrapper for 'gst_video_hdr_format_to_string'

Parameters:

a GstVideo.VideoHDRFormat

Returns (str) –

a string containing a descriptive name for the GstVideo.VideoHDRFormat if there is one, or None otherwise.

Since : 1.30

gst_video_hdr_parse_hdr10_plus 

gboolean
gst_video_hdr_parse_hdr10_plus (const guint8 * data,
                                gsize size,
                                GstVideoHDR10Plus * hdr10_plus)

Parse HDR10+ (SMPTE2094-40) user data and store in hdr10_plus For more details, see: https://www.atsc.org/wp-content/uploads/2018/02/S34-301r2-A341-Amendment-2094-40-1.pdf and SMPTE ST2094-40

Parameters:

data –

HDR10+ data

size –

size of data

hdr10_plus ( [out]) –

GstVideoHDR10Plus structure to fill in.

Returns –

TRUE if data was successfully parsed to hdr10_plus

Since : 1.30

GstVideo.prototype.video_hdr_parse_hdr10_plus 

function GstVideo.prototype.video_hdr_parse_hdr10_plus(data: Number, size: Number): {
    // javascript wrapper for 'gst_video_hdr_parse_hdr10_plus'
}

Parse HDR10+ (SMPTE2094-40) user data and store in hdr10_plus For more details, see: https://www.atsc.org/wp-content/uploads/2018/02/S34-301r2-A341-Amendment-2094-40-1.pdf and SMPTE ST2094-40

Parameters:

data (Number) –

HDR10+ data

size (Number) –

size of data

Returns a tuple made of:

(Number ) –

true if data was successfully parsed to hdr10_plus

hdr10_plus (GstVideo.VideoHDR10Plus ) –

true if data was successfully parsed to hdr10_plus

Since : 1.30

GstVideo.video_hdr_parse_hdr10_plus 

def GstVideo.video_hdr_parse_hdr10_plus (data, size):
    #python wrapper for 'gst_video_hdr_parse_hdr10_plus'

Parse HDR10+ (SMPTE2094-40) user data and store in hdr10_plus For more details, see: https://www.atsc.org/wp-content/uploads/2018/02/S34-301r2-A341-Amendment-2094-40-1.pdf and SMPTE ST2094-40

Parameters:

data (int) –

HDR10+ data

size (int) –

size of data

Returns a tuple made of:

(bool ) –

True if data was successfully parsed to hdr10_plus

hdr10_plus (GstVideo.VideoHDR10Plus ) –

True if data was successfully parsed to hdr10_plus

Since : 1.30

Function Macros

gst_buffer_get_video_hdr_meta 

#define gst_buffer_get_video_hdr_meta(b) \
        ((GstVideoHDRMeta*)gst_buffer_get_meta((b), GST_VIDEO_HDR_META_API_TYPE))

Gets the GstVideoHDRMeta that might be present on b.

Parameters:

b –

A GstBuffer

Returns –

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

Since : 1.30

Enumerations

GstVideoHDRFormat

Enum value describing the most common video for High Dynamic Range (HDR) formats.

Members
GST_VIDEO_HDR_FORMAT_NONE (0) –

No HDR format detected.

GST_VIDEO_HDR_FORMAT_HDR10 (1) –

HDR10 format

GST_VIDEO_HDR_FORMAT_HDR10_PLUS (2) –

HDR10+ format

Since : 1.30

GstVideo.VideoHDRFormat

Enum value describing the most common video for High Dynamic Range (HDR) formats.

Members
GstVideo.VideoHDRFormat.NONE (0) –

No HDR format detected.

GstVideo.VideoHDRFormat.HDR10 (1) –

HDR10 format

GstVideo.VideoHDRFormat.HDR10_PLUS (2) –

HDR10+ format

Since : 1.30

GstVideo.VideoHDRFormat

Enum value describing the most common video for High Dynamic Range (HDR) formats.

Members
GstVideo.VideoHDRFormat.NONE (0) –

No HDR format detected.

GstVideo.VideoHDRFormat.HDR10 (1) –

HDR10 format

GstVideo.VideoHDRFormat.HDR10_PLUS (2) –

HDR10+ format

Since : 1.30

Constants

GST_VIDEO_HDR10_PLUS_MAX_BYTES 

#define GST_VIDEO_HDR10_PLUS_MAX_BYTES 1024

Specify the max size for a HDR10+ content

Since : 1.30

GstVideo.VIDEO_HDR10_PLUS_MAX_BYTES

Specify the max size for a HDR10+ content

Since : 1.30

GstVideo.VIDEO_HDR10_PLUS_MAX_BYTES

Specify the max size for a HDR10+ content

Since : 1.30

GST_VIDEO_HDR10_PLUS_MAX_COLS_MD_APL 

#define GST_VIDEO_HDR10_PLUS_MAX_COLS_MD_APL 25

Specifies the number of columns in the targeted_system_display_actual_peak_luminance array. Defined in CTA-861-G.

Since : 1.30

GstVideo.VIDEO_HDR10_PLUS_MAX_COLS_MD_APL

Specifies the number of columns in the targeted_system_display_actual_peak_luminance array. Defined in CTA-861-G.

Since : 1.30

GstVideo.VIDEO_HDR10_PLUS_MAX_COLS_MD_APL

Specifies the number of columns in the targeted_system_display_actual_peak_luminance array. Defined in CTA-861-G.

Since : 1.30

GST_VIDEO_HDR10_PLUS_MAX_ROWS_TSD_APL 

#define GST_VIDEO_HDR10_PLUS_MAX_ROWS_TSD_APL 25

Specifies the number of columns in the targeted_system_display_actual_peak_luminance array. Defined in CTA-861-G.

Since : 1.30

GstVideo.VIDEO_HDR10_PLUS_MAX_ROWS_TSD_APL

Specifies the number of columns in the targeted_system_display_actual_peak_luminance array. Defined in CTA-861-G.

Since : 1.30

GstVideo.VIDEO_HDR10_PLUS_MAX_ROWS_TSD_APL

Specifies the number of columns in the targeted_system_display_actual_peak_luminance array. Defined in CTA-861-G.

Since : 1.30

GST_VIDEO_HDR10_PLUS_NUM_WINDOWS 

#define GST_VIDEO_HDR10_PLUS_NUM_WINDOWS 1

Number of windows in HDR10+ dynamic metadata. Defined in CTA-861-G. Shall be 1.

Since : 1.30

GstVideo.VIDEO_HDR10_PLUS_NUM_WINDOWS

Number of windows in HDR10+ dynamic metadata. Defined in CTA-861-G. Shall be 1.

Since : 1.30

GstVideo.VIDEO_HDR10_PLUS_NUM_WINDOWS

Number of windows in HDR10+ dynamic metadata. Defined in CTA-861-G. Shall be 1.

Since : 1.30

The results of the search are