2 * Copyright (C) 2009 Axis Communications <dev-gstreamer at axis dot com>
3 * @author Jonas Holmberg <jonas dot holmberg at axis dot com>
5 * gstbufferlist.h: Header for GstBufferList object
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
23 #ifndef __GST_BUFFER_LIST_H__
24 #define __GST_BUFFER_LIST_H__
26 #include <gst/gstbuffer.h>
30 #define GST_TYPE_BUFFER_LIST (gst_buffer_list_get_type ())
31 #define GST_IS_BUFFER_LIST(obj) (GST_MINI_OBJECT_TYPE(obj) == GST_TYPE_BUFFER_LIST)
32 #define GST_BUFFER_LIST_CAST(obj) ((GstBufferList *)obj)
33 #define GST_BUFFER_LIST(obj) (GST_BUFFER_LIST_CAST(obj))
35 typedef struct _GstBufferList GstBufferList;
36 typedef struct _GstBufferListIterator GstBufferListIterator;
39 * GstBufferListDoFunction:
40 * @buffer: (transfer full): the #GstBuffer
41 * @user_data: user data
43 * A function for accessing the last buffer returned by
44 * gst_buffer_list_iterator_next(). The function can leave @buffer in the list,
45 * replace @buffer in the list or remove @buffer from the list, depending on
46 * the return value. If the function returns NULL, @buffer will be removed from
47 * the list, otherwise @buffer will be replaced with the returned buffer.
49 * The last buffer returned by gst_buffer_list_iterator_next() will be replaced
50 * with the buffer returned from the function. The function takes ownership of
51 * @buffer and if a different value than @buffer is returned, @buffer must be
52 * unreffed. If NULL is returned, the buffer will be removed from the list. The
53 * list must be writable.
55 * Returns: (transfer full): the buffer to replace @buffer in the list, or NULL
56 * to remove @buffer from the list
60 typedef GstBuffer* (*GstBufferListDoFunction) (GstBuffer * buffer, gpointer user_data);
64 * @GST_BUFFER_LIST_CONTINUE: Retrieve next buffer
65 * @GST_BUFFER_LIST_SKIP_GROUP: Skip to next group
66 * @GST_BUFFER_LIST_END: End iteration
68 * The result of the #GstBufferListFunc.
73 GST_BUFFER_LIST_CONTINUE,
74 GST_BUFFER_LIST_SKIP_GROUP,
80 * @buffer: pointer the buffer
81 * @group: the group index of @buffer
82 * @idx: the index in @group of @buffer
83 * @user_data: user data passed to gst_buffer_list_foreach()
85 * A function that will be called from gst_buffer_list_foreach(). The @buffer
86 * field will point to a the reference of the buffer at @idx in @group.
88 * When this function returns #GST_BUFFER_LIST_CONTINUE, the next buffer will be
89 * returned. When #GST_BUFFER_LIST_SKIP_GROUP is returned, all remaining buffers
90 * in the current group will be skipped and the first buffer of the next group
91 * is returned (if any). When GST_BUFFER_LIST_END is returned,
92 * gst_buffer_list_foreach() will return.
94 * When @buffer is set to NULL, the item will be removed from the bufferlist.
95 * When @buffer has been made writable, the new buffer reference can be assigned
96 * to @buffer. This function is responsible for unreffing the old buffer when
97 * removing or modifying.
99 * Returns: a #GstBufferListItem
103 typedef GstBufferListItem (*GstBufferListFunc) (GstBuffer **buffer, guint group, guint idx,
107 GType gst_buffer_list_get_type (void);
110 GstBufferList *gst_buffer_list_new (void);
114 * gst_buffer_list_ref:
115 * @list: a #GstBufferList
117 * Increases the refcount of the given buffer list by one.
119 * Note that the refcount affects the writeability of @list and its data, see
120 * gst_buffer_list_make_writable(). It is important to note that keeping
121 * additional references to GstBufferList instances can potentially increase
122 * the number of memcpy operations in a pipeline.
124 * Returns: (transfer full): @list
128 #ifdef _FOOL_GTK_DOC_
129 G_INLINE_FUNC GstBufferList * gst_buffer_list_ref (GstBufferList * list);
132 static inline GstBufferList *
133 gst_buffer_list_ref (GstBufferList * list)
135 return GST_BUFFER_LIST_CAST (gst_mini_object_ref (GST_MINI_OBJECT_CAST (
140 * gst_buffer_list_unref:
141 * @list: (transfer full): a #GstBufferList
143 * Decreases the refcount of the buffer list. If the refcount reaches 0, the
144 * buffer list will be freed.
148 #ifdef _FOOL_GTK_DOC_
149 G_INLINE_FUNC void gst_buffer_list_unref (GstBufferList * list);
153 gst_buffer_list_unref (GstBufferList * list)
155 gst_mini_object_unref (GST_MINI_OBJECT_CAST (list));
160 * gst_buffer_list_copy:
161 * @list: a #GstBufferList
163 * Create a shallow copy of the given buffer list. This will make a newly
164 * allocated copy of the source list with copies of buffer pointers. The
165 * refcount of buffers pointed to will be increased by one.
167 * Returns: (transfer full): a new copy of @list.
171 #ifdef _FOOL_GTK_DOC_
172 G_INLINE_FUNC GstBufferList * gst_buffer_list_copy (const GstBufferList * list);
175 static inline GstBufferList *
176 gst_buffer_list_copy (const GstBufferList * list)
178 return GST_BUFFER_LIST_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (list)));
182 * gst_buffer_list_is_writable:
183 * @list: a #GstBufferList
185 * Tests if you can safely add buffers and groups into a buffer list.
189 #define gst_buffer_list_is_writable(list) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (list))
192 * gst_buffer_list_make_writable:
193 * @list: (transfer full): a #GstBufferList
195 * Makes a writable buffer list from the given buffer list. If the source buffer
196 * list is already writable, this will simply return the same buffer list. A
197 * copy will otherwise be made using gst_buffer_list_copy().
199 * Returns: (transfer full): a writable list, which may or may not be the
204 #define gst_buffer_list_make_writable(list) GST_BUFFER_LIST_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (list)))
206 guint gst_buffer_list_n_groups (GstBufferList *list);
208 void gst_buffer_list_foreach (GstBufferList *list,
209 GstBufferListFunc func,
211 GstBuffer * gst_buffer_list_get (GstBufferList *list, guint group, guint idx);
214 GstBufferListIterator * gst_buffer_list_iterate (GstBufferList *list);
215 void gst_buffer_list_iterator_free (GstBufferListIterator *it);
217 guint gst_buffer_list_iterator_n_buffers (const GstBufferListIterator *it);
218 GstBuffer * gst_buffer_list_iterator_next (GstBufferListIterator *it);
219 gboolean gst_buffer_list_iterator_next_group (GstBufferListIterator *it);
221 void gst_buffer_list_iterator_add (GstBufferListIterator *it, GstBuffer *buffer);
222 void gst_buffer_list_iterator_add_list (GstBufferListIterator *it, GList *list);
223 void gst_buffer_list_iterator_add_group (GstBufferListIterator *it);
224 void gst_buffer_list_iterator_remove (GstBufferListIterator *it);
225 GstBuffer * gst_buffer_list_iterator_steal (GstBufferListIterator *it);
226 void gst_buffer_list_iterator_take (GstBufferListIterator *it, GstBuffer *buffer);
228 GstBuffer * gst_buffer_list_iterator_do (GstBufferListIterator *it, GstBufferListDoFunction do_func,
232 GstBuffer * gst_buffer_list_iterator_merge_group (const GstBufferListIterator *it);
236 #endif /* __GST_BUFFER_LIST_H__ */