GstBufferList

GstBufferList

gst_buffer_list_new

GstBufferList *
gst_buffer_list_new ()

Creates a new, empty GstBufferList.

gst_buffer_list_new_sized

GstBufferList *
gst_buffer_list_new_sized (guint size)

Creates a new, empty GstBufferList. The list will have size space preallocated so that memory reallocations can be avoided.

gst_buffer_list_calculate_size

gsize
gst_buffer_list_calculate_size (GstBufferList * list)

Calculates the size of the data contained in list by adding the size of all buffers.

Since : 1.14

gst_buffer_list_copy

GstBufferList *
gst_buffer_list_copy (const GstBufferList * list)

Creates a shallow copy of the given buffer list. This will make a newly allocated copy of the source list with copies of buffer pointers. The refcount of buffers pointed to will be increased by one.

gst_buffer_list_copy_deep

GstBufferList *
gst_buffer_list_copy_deep (const GstBufferList * list)

Creates a copy of the given buffer list. This will make a newly allocated copy of the buffers that the source buffer list contains.

Since : 1.6

gst_buffer_list_foreach

gboolean
gst_buffer_list_foreach (GstBufferList * list,
                         GstBufferListFunc func,
                         gpointer user_data)

Calls func with data for each buffer in list.

func can modify the passed buffer pointer or its contents. The return value of func defines if this function returns or if the remaining buffers in the list should be skipped.

gst_buffer_list_get

GstBuffer *
gst_buffer_list_get (GstBufferList * list,
                     guint idx)

Gets the buffer at idx.

You must make sure that idx does not exceed the number of buffers available.

gst_buffer_list_get_writable

GstBuffer *
gst_buffer_list_get_writable (GstBufferList * list,
                              guint idx)

Gets the buffer at idx, ensuring it is a writable buffer.

You must make sure that idx does not exceed the number of buffers available.

Since : 1.14

gst_buffer_list_insert

gst_buffer_list_insert (GstBufferList * list,
                        gint idx,
                        GstBuffer * buffer)

Inserts buffer at idx in list. Other buffers are moved to make room for this new buffer.

A -1 value for idx will append the buffer at the end.

gst_buffer_list_length

guint
gst_buffer_list_length (GstBufferList * list)

Returns the number of buffers in list.

gst_buffer_list_ref

GstBufferList *
gst_buffer_list_ref (GstBufferList * list)

Increases the refcount of the given buffer list by one.

Note that the refcount affects the writability of list and its data, see gst_buffer_list_make_writable. It is important to note that keeping additional references to GstBufferList instances can potentially increase the number of memcpy operations in a pipeline.

gst_buffer_list_remove

gst_buffer_list_remove (GstBufferList * list,
                        guint idx,
                        guint length)

Removes length buffers starting from idx in list. The following buffers are moved to close the gap.

gst_buffer_list_unref

gst_buffer_list_unref (GstBufferList * list)

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

gst_buffer_list_replace

gboolean
gst_buffer_list_replace (GstBufferList ** old_list,
                         GstBufferList * new_list)

Modifies a pointer to a GstBufferList to point to a different GstBufferList. The modification is done atomically (so this is useful for ensuring thread safety in some cases), and the reference counts are updated appropriately (the old buffer list is unreffed, the new is reffed).

Either new_list or the GstBufferList pointed to by old_list may be NULL.

Since : 1.16

gst_buffer_list_take

gboolean
gst_buffer_list_take (GstBufferList ** old_list,
                      GstBufferList * new_list)

Modifies a pointer to a GstBufferList to point to a different GstBufferList. This function is similar to gst_buffer_list_replace except that it takes ownership of new_list.

Since : 1.16

gst_clear_buffer_list

gst_clear_buffer_list (GstBufferList ** list_ptr)

Clears a reference to a GstBufferList.

list_ptr must not be NULL.

If the reference is NULL then this function does nothing. Otherwise, the reference count of the list is decreased and the pointer is set to NULL.

Since : 1.16

GST_BUFFER_LIST_CAST

#define GST_BUFFER_LIST_CAST(obj) ((GstBufferList *)obj)

gst_buffer_list_add

#define gst_buffer_list_add(l,b) gst_buffer_list_insert((l),-1,(b));

Append b at the end of l.

gst_buffer_list_is_writable

#define gst_buffer_list_is_writable(list) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (list))

Tests if you can safely add buffers and groups into a buffer list.

gst_buffer_list_make_writable

#define gst_buffer_list_make_writable(list) GST_BUFFER_LIST_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (list)))

Makes a writable buffer list from the given buffer list. If the source buffer list is already writable, this will simply return the same buffer list. A copy will otherwise be made using gst_buffer_list_copy.

GstBufferListFunc

gboolean
(*GstBufferListFunc) (GstBuffer ** buffer,
                      guint idx,
                      gpointer user_data)

A function that will be called from gst_buffer_list_foreach. The buffer field will point to a the reference of the buffer at idx.

When this function returns TRUE, the next buffer will be returned. When FALSE is returned, gst_buffer_list_foreach will return.

When buffer is set to NULL, the item will be removed from the bufferlist. When buffer has been made writable, the new buffer reference can be assigned to buffer. This function is responsible for unreffing the old buffer when removing or modifying.