GstCodecs.H264Dpb¶

Fields¶

None

Methods¶

	`add` (picture)
	`bump` (drain)
	`clear` ()
	`delete_unused` ()
	`free` ()
	`get_interlaced` ()
	`get_long_ref_by_long_term_pic_num` (long_term_pic_num)
	`get_lowest_frame_num_short_ref` ()
	`get_max_num_frames` ()
	`get_max_num_reorder_frames` ()
	`get_picture` (system_frame_number)
	`get_pictures_all` ()
	`get_pictures_long_term_ref` (include_second_field)
	`get_pictures_short_term_ref` (include_non_existing, include_second_field)
	`get_short_ref_by_pic_num` (pic_num)
	`get_size` ()
	`has_empty_frame_buffer` ()
	`mark_all_non_ref` ()
	`needs_bump` (to_insert, latency_mode)
	`num_ref_frames` ()
	`set_interlaced` (interlaced)
	`set_last_output` (picture)
	`set_max_num_frames` (max_num_frames)
	`set_max_num_reorder_frames` (max_num_reorder_frames)

Details¶

class GstCodecs.H264Dpb¶

add(picture)¶

Parameters:: picture (GstCodecs.H264Picture) – a GstCodecs.H264Picture

Store the picture

bump(drain)¶

Parameters:: drain (bool) – whether draining or not
Returns:: a GstCodecs.H264Picture which is needed to be outputted
Return type:: GstCodecs.H264Picture or None

Perform bumping process as defined in C.4.5.3 “Bumping” process. If drain is True, self will remove a GstCodecs.H264Picture from internal array so that returned GstCodecs.H264Picture could hold the last reference of it

New in version 1.20.

clear()¶: Clear all stored GstCodecs.H264Picture

delete_unused()¶: Delete already outputted and not referenced all pictures from dpb

free()¶: Free the self

get_interlaced()¶

Returns:: True if self is configured for interlaced stream
Return type:: bool

New in version 1.20.

get_long_ref_by_long_term_pic_num(long_term_pic_num)¶

Parameters:: long_term_pic_num (int) – a long term picture number
Returns:: a GstCodecs.H264Picture
Return type:: GstCodecs.H264Picture or None

Find a long term reference picture which has matching long term picture number

New in version 1.20.

get_lowest_frame_num_short_ref()¶

Returns:: a GstCodecs.H264Picture
Return type:: GstCodecs.H264Picture or None

Find a short term reference picture which has the lowest frame_num_wrap

get_max_num_frames()¶

Returns:: the number of maximum frames
Return type:: int

New in version 1.20.

get_max_num_reorder_frames()¶

Returns:: Maximum number of reorder frames
Return type:: int

New in version 1.22.2.

get_picture(system_frame_number)¶

Parameters:: system_frame_number (int) –
Returns:: the picture identified with the specified system_frame_number, or None if DPB does not contain a GstCodecs.H264Picture corresponding to the system_frame_number
Return type:: GstCodecs.H264Picture or None

New in version 1.18.

get_pictures_all()¶

Returns:: a GLib.Array of GstCodecs.H264Picture stored in self
Return type:: [GstCodecs.H264Picture]

get_pictures_long_term_ref(include_second_field)¶

Parameters:: include_second_field (bool) – True if the second field pictures need to be included
Returns:: an array of GstCodecs.H264Picture pointer
Return type:: out: [GstCodecs.H264Picture]

Retrieve all long-term reference pictures from self. The picture will be appended to the array.

New in version 1.20.

get_pictures_short_term_ref(include_non_existing, include_second_field)¶

Parameters:

include_non_existing (bool) – True if non-existing pictures need to be included
include_second_field (bool) – True if the second field pictures need to be included

Returns:

an array of GstCodecs.H264Picture pointers

Return type:

out: [GstCodecs.H264Picture]

Retrieve all short-term reference pictures from self. The picture will be appended to the array.

New in version 1.20.

get_short_ref_by_pic_num(pic_num)¶

Parameters:: pic_num (int) – a picture number
Returns:: a GstCodecs.H264Picture
Return type:: GstCodecs.H264Picture or None

Find a short term reference picture which has matching picture number

get_size()¶

Returns:: the length of stored dpb array
Return type:: int

has_empty_frame_buffer()¶

Returns:: True if self still has empty frame buffers.
Return type:: bool

New in version 1.20.

mark_all_non_ref()¶: Mark all pictures are not referenced

needs_bump(to_insert, latency_mode)¶

Parameters:

to_insert (GstCodecs.H264Picture) – the current GstCodecs.H264Picture to insert to dpb.
latency_mode (GstCodecs.H264DpbBumpMode) – The required GstCodecs.H264DpbBumpMode for bumping.

Returns:

True if bumping is required

Return type:

bool

New in version 1.20.

num_ref_frames()¶

Returns:: The number of referenced frames
Return type:: int

New in version 1.20.

set_interlaced(interlaced)¶

Parameters:: interlaced (bool) – True if interlaced

New in version 1.20.

set_last_output(picture)¶

Parameters:: picture (GstCodecs.H264Picture) – a GstCodecs.H264Picture of the last output.

Notify the DPB that picture is output directly without storing in the DPB.

New in version 1.20.

set_max_num_frames(max_num_frames)¶

Parameters:: max_num_frames (int) – the maximum number of picture

Set the number of maximum allowed frames to store

New in version 1.20.

set_max_num_reorder_frames(max_num_reorder_frames)¶

Parameters:: max_num_reorder_frames (int) – the max number of reorder frames, which should not exceed the max size of DPB.

New in version 1.20.