GstVideo Codec utility function

Returns ( [transfer: none]) –

The previously set user_data

GstVideo.VideoCodecFrame.prototype.get_user_data

function GstVideo.VideoCodecFrame.prototype.get_user_data(): {
    // javascript wrapper for 'gst_video_codec_frame_get_user_data'
}

Gets private data set on the frame by the subclass via GstVideo.VideoCodecFrame.prototype.set_user_data previously.

Parameters:

frame (GstVideo.VideoCodecFrame) –

Returns (Object) –

The previously set user_data

GstVideo.VideoCodecFrame.get_user_data

def GstVideo.VideoCodecFrame.get_user_data (self):
    #python wrapper for 'gst_video_codec_frame_get_user_data'

Gets private data set on the frame by the subclass via GstVideo.VideoCodecFrame.set_user_data previously.

Parameters:

frame (GstVideo.VideoCodecFrame) –

Returns (object) –

The previously set user_data

gst_video_codec_frame_ref

GstVideoCodecFrame *
gst_video_codec_frame_ref (GstVideoCodecFrame * frame)

Increases the refcount of the given frame by one.

Parameters:

frame –

Returns –

buf

GstVideo.VideoCodecFrame.prototype.ref

function GstVideo.VideoCodecFrame.prototype.ref(): {
    // javascript wrapper for 'gst_video_codec_frame_ref'
}

Increases the refcount of the given frame by one.

Parameters:

frame (GstVideo.VideoCodecFrame) –

Returns (GstVideo.VideoCodecFrame) –

buf

GstVideo.VideoCodecFrame.ref

def GstVideo.VideoCodecFrame.ref (self):
    #python wrapper for 'gst_video_codec_frame_ref'

Increases the refcount of the given frame by one.

Parameters:

frame (GstVideo.VideoCodecFrame) –

Returns (GstVideo.VideoCodecFrame) –

buf

gst_video_codec_frame_set_user_data

gst_video_codec_frame_set_user_data (GstVideoCodecFrame * frame,
                                     gpointer user_data,
                                     GDestroyNotify notify)

Sets user_data on the frame and the GDestroyNotify that will be called when the frame is freed. Allows to attach private data by the subclass to frames.

If a user_data was previously set, then the previous set notify will be called before the user_data is replaced.

Parameters:

frame –

user_data –

private data

notify ( [closure]) –

a GDestroyNotify

GstVideo.VideoCodecFrame.prototype.set_user_data

function GstVideo.VideoCodecFrame.prototype.set_user_data(user_data: Object, notify: GLib.DestroyNotify): {
    // javascript wrapper for 'gst_video_codec_frame_set_user_data'
}

Sets user_data on the frame and the GLib.DestroyNotify that will be called when the frame is freed. Allows to attach private data by the subclass to frames.

If a user_data was previously set, then the previous set notify will be called before the user_data is replaced.

Parameters:

frame (GstVideo.VideoCodecFrame) –

user_data (Object) –

private data

notify (GLib.DestroyNotify) –

a GLib.DestroyNotify

GstVideo.VideoCodecFrame.set_user_data

def GstVideo.VideoCodecFrame.set_user_data (self, *user_data, notify):
    #python wrapper for 'gst_video_codec_frame_set_user_data'

Sets user_data on the frame and the GLib.DestroyNotify that will be called when the frame is freed. Allows to attach private data by the subclass to frames.

If a user_data was previously set, then the previous set notify will be called before the user_data is replaced.

Parameters:

frame (GstVideo.VideoCodecFrame) –

user_data (variadic) –

private data

notify (GLib.DestroyNotify) –

a GLib.DestroyNotify

gst_video_codec_frame_unref

gst_video_codec_frame_unref (GstVideoCodecFrame * frame)

Decreases the refcount of the frame. If the refcount reaches 0, the frame will be freed.

Parameters:

frame –

GstVideo.VideoCodecFrame.prototype.unref

function GstVideo.VideoCodecFrame.prototype.unref(): {
    // javascript wrapper for 'gst_video_codec_frame_unref'
}

Decreases the refcount of the frame. If the refcount reaches 0, the frame will be freed.

Parameters:

frame (GstVideo.VideoCodecFrame) –

GstVideo.VideoCodecFrame.unref

def GstVideo.VideoCodecFrame.unref (self):
    #python wrapper for 'gst_video_codec_frame_unref'

Decreases the refcount of the frame. If the refcount reaches 0, the frame will be freed.

Parameters:

frame (GstVideo.VideoCodecFrame) –

GstVideoCodecState

Structure representing the state of an incoming or outgoing video stream for encoders and decoders.

Decoders and encoders will receive such a state through their respective set_format vmethods.

Decoders and encoders can set the downstream state, by using the gst_video_decoder_set_output_state or gst_video_encoder_set_output_state methods.

Members

info (GstVideoInfo) –

The GstVideoInfo describing the stream

caps (GstCaps *) –

The GstCaps used in the caps negotiation of the pad.

codec_data (GstBuffer *) –

a GstBuffer corresponding to the 'codec_data' field of a stream, or NULL.

allocation_caps (GstCaps *) –

The GstCaps for allocation query and pool negotiation. Since: 1.10

mastering_display_info (GstVideoMasteringDisplayInfo *) –

Mastering display color volume information (HDR metadata) for the stream.

content_light_level (GstVideoContentLightLevel *) –

Content light level information for the stream.

Methods

gst_video_codec_state_ref

GstVideoCodecState *
gst_video_codec_state_ref (GstVideoCodecState * state)

Increases the refcount of the given state by one.

Parameters:

state –

a GstVideoCodecState

Returns –

buf

GstVideo.VideoCodecState.prototype.ref

function GstVideo.VideoCodecState.prototype.ref(): {
    // javascript wrapper for 'gst_video_codec_state_ref'
}

Increases the refcount of the given state by one.

Parameters:

state (GstVideo.VideoCodecState) –

Returns (GstVideo.VideoCodecState) –

buf

GstVideo.VideoCodecState.ref

def GstVideo.VideoCodecState.ref (self):
    #python wrapper for 'gst_video_codec_state_ref'

Increases the refcount of the given state by one.

Parameters:

state (GstVideo.VideoCodecState) –

Returns (GstVideo.VideoCodecState) –

buf

gst_video_codec_state_unref

gst_video_codec_state_unref (GstVideoCodecState * state)

Decreases the refcount of the state. If the refcount reaches 0, the state will be freed.

Parameters:

state –

a GstVideoCodecState

GstVideo.VideoCodecState.prototype.unref

function GstVideo.VideoCodecState.prototype.unref(): {
    // javascript wrapper for 'gst_video_codec_state_unref'
}

Decreases the refcount of the state. If the refcount reaches 0, the state will be freed.

Parameters:

state (GstVideo.VideoCodecState) –

GstVideo.VideoCodecState.unref

def GstVideo.VideoCodecState.unref (self):
    #python wrapper for 'gst_video_codec_state_unref'

Decreases the refcount of the state. If the refcount reaches 0, the state will be freed.

Parameters:

state (GstVideo.VideoCodecState) –

Function Macros

GST_VIDEO_CODEC_FRAME_FLAGS

#define GST_VIDEO_CODEC_FRAME_FLAGS(frame) ((frame)->flags)

The entire set of flags for the frame

Parameters:

frame –

GST_VIDEO_CODEC_FRAME_FLAG_IS_SET

#define GST_VIDEO_CODEC_FRAME_FLAG_IS_SET(frame,flag)   !!(GST_VIDEO_CODEC_FRAME_FLAGS(frame) & (flag))

Checks whether the given flag is set

Parameters:

frame –

flag –

a flag to check for

GST_VIDEO_CODEC_FRAME_FLAG_SET

#define GST_VIDEO_CODEC_FRAME_FLAG_SET(frame,flag)     (GST_VIDEO_CODEC_FRAME_FLAGS(frame) |= (flag))

This macro sets the given bits

Parameters:

frame –

flag –

Flag to set, can be any number of bits in guint32.

GST_VIDEO_CODEC_FRAME_FLAG_UNSET

#define GST_VIDEO_CODEC_FRAME_FLAG_UNSET(frame,flag)   (GST_VIDEO_CODEC_FRAME_FLAGS(frame) &= ~(flag))

This macro usets the given bits.

Parameters:

frame –

flag –

Flag to unset

GST_VIDEO_CODEC_FRAME_IS_DECODE_ONLY

#define GST_VIDEO_CODEC_FRAME_IS_DECODE_ONLY(frame)     (GST_VIDEO_CODEC_FRAME_FLAG_IS_SET(frame, GST_VIDEO_CODEC_FRAME_FLAG_DECODE_ONLY))

Tests if the buffer should only be decoded but not sent downstream.

Parameters:

frame –

GST_VIDEO_CODEC_FRAME_IS_FORCE_KEYFRAME

#define GST_VIDEO_CODEC_FRAME_IS_FORCE_KEYFRAME(frame)      (GST_VIDEO_CODEC_FRAME_FLAG_IS_SET(frame, GST_VIDEO_CODEC_FRAME_FLAG_FORCE_KEYFRAME))

Tests if the frame must be encoded as a keyframe. Applies only to frames provided to encoders. Decoders can safely ignore this field.

Parameters:

frame –

GST_VIDEO_CODEC_FRAME_IS_FORCE_KEYFRAME_HEADERS

#define GST_VIDEO_CODEC_FRAME_IS_FORCE_KEYFRAME_HEADERS(frame)      (GST_VIDEO_CODEC_FRAME_FLAG_IS_SET(frame, GST_VIDEO_CODEC_FRAME_FLAG_FORCE_KEYFRAME_HEADERS))

Tests if encoder should output stream headers before outputting the resulting encoded buffer for the given frame.

Applies only to frames provided to encoders. Decoders can safely ignore this field.

Parameters:

frame –

GST_VIDEO_CODEC_FRAME_IS_SYNC_POINT

#define GST_VIDEO_CODEC_FRAME_IS_SYNC_POINT(frame)      (GST_VIDEO_CODEC_FRAME_FLAG_IS_SET(frame, GST_VIDEO_CODEC_FRAME_FLAG_SYNC_POINT))

Tests if the frame is a synchronization point (like a keyframe).

Decoder implementations can use this to detect keyframes.

Parameters:

frame –

GST_VIDEO_CODEC_FRAME_SET_DECODE_ONLY

#define GST_VIDEO_CODEC_FRAME_SET_DECODE_ONLY(frame)    (GST_VIDEO_CODEC_FRAME_FLAG_SET(frame, GST_VIDEO_CODEC_FRAME_FLAG_DECODE_ONLY))

Sets the buffer to not be sent downstream.

Decoder implementation can use this if they have frames that are not meant to be displayed.

Encoder implementation can safely ignore this field.

Parameters:

frame –

GST_VIDEO_CODEC_FRAME_SET_FORCE_KEYFRAME

#define GST_VIDEO_CODEC_FRAME_SET_FORCE_KEYFRAME(frame)     (GST_VIDEO_CODEC_FRAME_FLAG_SET(frame, GST_VIDEO_CODEC_FRAME_FLAG_FORCE_KEYFRAME))

GST_VIDEO_CODEC_FRAME_SET_FORCE_KEYFRAME_HEADERS

#define GST_VIDEO_CODEC_FRAME_SET_FORCE_KEYFRAME_HEADERS(frame)     (GST_VIDEO_CODEC_FRAME_FLAG_SET(frame, GST_VIDEO_CODEC_FRAME_FLAG_FORCE_KEYFRAME_HEADERS))

GST_VIDEO_CODEC_FRAME_SET_SYNC_POINT

#define GST_VIDEO_CODEC_FRAME_SET_SYNC_POINT(frame)     (GST_VIDEO_CODEC_FRAME_FLAG_SET(frame, GST_VIDEO_CODEC_FRAME_FLAG_SYNC_POINT))

Sets the frame to be a synchronization point (like a keyframe).

Encoder implementations should set this accordingly.

Decoder implementing parsing features should set this when they detect such a synchronization point.

Parameters:

frame –