gstreamer/gst/gstbufferlist.h
Thibault Saunier 949fba4b1f doc: Fix hotdoc warnings
* Making sure that `static inline` function are in the GIR (by first
  defining them, and make sure to mark as skiped)
* Do not try to link to unexisting symbols
* Also generate GIR information about gst_tracers
2019-05-13 16:34:09 -04:00

247 lines
8.2 KiB
C

/* GStreamer
* Copyright (C) 2009 Axis Communications <dev-gstreamer at axis dot com>
* @author Jonas Holmberg <jonas dot holmberg at axis dot com>
*
* gstbufferlist.h: Header for GstBufferList object
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef __GST_BUFFER_LIST_H__
#define __GST_BUFFER_LIST_H__
#include <gst/gstbuffer.h>
G_BEGIN_DECLS
GST_API GType _gst_buffer_list_type;
#define GST_TYPE_BUFFER_LIST (_gst_buffer_list_type)
#define GST_IS_BUFFER_LIST(obj) (GST_IS_MINI_OBJECT_TYPE(obj, GST_TYPE_BUFFER_LIST))
#define GST_BUFFER_LIST_CAST(obj) ((GstBufferList *)obj)
#define GST_BUFFER_LIST(obj) (GST_BUFFER_LIST_CAST(obj))
typedef struct _GstBufferList GstBufferList;
/**
* GstBufferListFunc:
* @buffer: (out) (nullable): pointer the buffer
* @idx: the index of @buffer
* @user_data: user data passed to gst_buffer_list_foreach()
*
* 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.
*
* Returns: %FALSE when gst_buffer_list_foreach() should stop
*/
typedef gboolean (*GstBufferListFunc) (GstBuffer **buffer, guint idx,
gpointer user_data);
/* refcounting */
/**
* gst_buffer_list_ref: (skip)
* @list: a #GstBufferList
*
* 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.
*
* Returns: (transfer full): @list
*/
static inline GstBufferList* gst_buffer_list_ref(GstBufferList* list);
static inline GstBufferList *
gst_buffer_list_ref (GstBufferList * list)
{
return GST_BUFFER_LIST_CAST (gst_mini_object_ref (GST_MINI_OBJECT_CAST (
list)));
}
/**
* gst_buffer_list_unref: (skip)
* @list: (transfer full): a #GstBufferList
*
* Decreases the refcount of the buffer list. If the refcount reaches 0, the
* buffer list will be freed.
*/
static inline void gst_buffer_list_unref(GstBufferList* list);
static inline void
gst_buffer_list_unref(GstBufferList* list)
{
gst_mini_object_unref (GST_MINI_OBJECT_CAST (list));
}
/**
* gst_clear_buffer_list: (skip)
* @list_ptr: a pointer to a #GstBufferList reference
*
* 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
*/
static inline void
gst_clear_buffer_list (GstBufferList ** list_ptr)
{
gst_clear_mini_object ((GstMiniObject **) list_ptr);
}
/* copy */
/**
* gst_buffer_list_copy: (skip)
* @list: a #GstBufferList
*
* Create 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.
*
* Returns: (transfer full): a new copy of @list.
*/
static inline GstBufferList* gst_buffer_list_copy(const GstBufferList* list);
static inline GstBufferList *
gst_buffer_list_copy (const GstBufferList * list)
{
return GST_BUFFER_LIST_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (list)));
}
/**
* gst_buffer_list_replace:
* @old_list: (inout) (transfer full) (nullable): pointer to a pointer to a
* #GstBufferList to be replaced.
* @new_list: (transfer none) (allow-none): pointer to a #GstBufferList that
* will replace the buffer list pointed to by @old_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.
*
* Returns: %TRUE if @new_list was different from @old_list
*
* Since: 1.16
*/
static inline gboolean
gst_buffer_list_replace (GstBufferList **old_list, GstBufferList *new_list)
{
return gst_mini_object_replace ((GstMiniObject **) old_list,
(GstMiniObject *) new_list);
}
/**
* gst_buffer_list_take:
* @old_list: (inout) (transfer full): pointer to a pointer to a #GstBufferList
* to be replaced.
* @new_list: (transfer full) (allow-none): pointer to a #GstBufferList
* that will replace the bufferlist pointed to by @old_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.
*
* Returns: %TRUE if @new_list was different from @old_list
*
* Since: 1.16
*/
static inline gboolean
gst_buffer_list_take (GstBufferList **old_list, GstBufferList *new_list)
{
return gst_mini_object_take ((GstMiniObject **) old_list,
(GstMiniObject *) new_list);
}
/**
* gst_buffer_list_is_writable:
* @list: a #GstBufferList
*
* Tests if you can safely add buffers and groups into a buffer list.
*/
#define gst_buffer_list_is_writable(list) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (list))
/**
* gst_buffer_list_make_writable:
* @list: (transfer full): a #GstBufferList
*
* 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().
*
* Returns: (transfer full): a writable list, which may or may not be the
* same as @list
*/
#define gst_buffer_list_make_writable(list) GST_BUFFER_LIST_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (list)))
GST_API
GType gst_buffer_list_get_type (void);
/* allocation */
GST_API
GstBufferList * gst_buffer_list_new (void) G_GNUC_MALLOC;
GST_API
GstBufferList * gst_buffer_list_new_sized (guint size) G_GNUC_MALLOC;
GST_API
guint gst_buffer_list_length (GstBufferList *list);
GST_API
GstBuffer * gst_buffer_list_get (GstBufferList *list, guint idx);
GST_API
GstBuffer * gst_buffer_list_get_writable (GstBufferList *list, guint idx);
GST_API
void gst_buffer_list_insert (GstBufferList *list, gint idx, GstBuffer *buffer);
GST_API
void gst_buffer_list_remove (GstBufferList *list, guint idx, guint length);
GST_API
gboolean gst_buffer_list_foreach (GstBufferList *list,
GstBufferListFunc func,
gpointer user_data);
GST_API
GstBufferList * gst_buffer_list_copy_deep (const GstBufferList * list);
GST_API
gsize gst_buffer_list_calculate_size (GstBufferList * list);
#define gst_buffer_list_add(l,b) gst_buffer_list_insert((l),-1,(b));
#ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstBufferList, gst_buffer_list_unref)
#endif
G_END_DECLS
#endif /* __GST_BUFFER_LIST_H__ */