1 /* GStreamer
2 * Copyright (C) 2009 Axis Communications <dev-gstreamer at axis dot com>
3 * @author Jonas Holmberg <jonas dot holmberg at axis dot com>
4 *
5 * gstbufferlist.h: Header for GstBufferList object
6 *
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.
11 *
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.
16 *
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., 51 Franklin St, Fifth Floor,
20 * Boston, MA 02110-1301, USA.
21 */
22
23 #ifndef __GST_BUFFER_LIST_H__
24 #define __GST_BUFFER_LIST_H__
25
26 #include <gst/gstbuffer.h>
27
28 G_BEGIN_DECLS
29
30 GST_API GType _gst_buffer_list_type;
31
32 #define GST_TYPE_BUFFER_LIST (_gst_buffer_list_type)
33 #define GST_IS_BUFFER_LIST(obj) (GST_IS_MINI_OBJECT_TYPE(obj, GST_TYPE_BUFFER_LIST))
34 #define GST_BUFFER_LIST_CAST(obj) ((GstBufferList *)obj)
35 #define GST_BUFFER_LIST(obj) (GST_BUFFER_LIST_CAST(obj))
36
37 typedef struct _GstBufferList GstBufferList;
38
39 /**
40 * GstBufferListFunc:
41 * @buffer: (out) (nullable): pointer to the buffer
42 * @idx: the index of @buffer
43 * @user_data: user data passed to gst_buffer_list_foreach()
44 *
45 * A function that will be called from gst_buffer_list_foreach(). The @buffer
46 * field will point to a the reference of the buffer at @idx.
47 *
48 * When this function returns %TRUE, the next buffer will be
49 * returned. When %FALSE is returned, gst_buffer_list_foreach() will return.
50 *
51 * When @buffer is set to %NULL, the item will be removed from the bufferlist.
52 * When @buffer has been made writable, the new buffer reference can be assigned
53 * to @buffer. This function is responsible for unreffing the old buffer when
54 * removing or modifying.
55 *
56 * Returns: %FALSE when gst_buffer_list_foreach() should stop
57 */
58 typedef gboolean (*GstBufferListFunc) (GstBuffer **buffer, guint idx,
59 gpointer user_data);
60
61 #ifndef GST_DISABLE_MINIOBJECT_INLINE_FUNCTIONS
62 /* refcounting */
63 static inline GstBufferList *
gst_buffer_list_ref(GstBufferList * list)64 gst_buffer_list_ref (GstBufferList * list)
65 {
66 return GST_BUFFER_LIST_CAST (gst_mini_object_ref (GST_MINI_OBJECT_CAST (
67 list)));
68 }
69
70 static inline void
gst_buffer_list_unref(GstBufferList * list)71 gst_buffer_list_unref(GstBufferList* list)
72 {
73 gst_mini_object_unref (GST_MINI_OBJECT_CAST (list));
74 }
75
76 static inline void
gst_clear_buffer_list(GstBufferList ** list_ptr)77 gst_clear_buffer_list (GstBufferList ** list_ptr)
78 {
79 gst_clear_mini_object ((GstMiniObject **) list_ptr);
80 }
81
82 /* copy */
83 static inline GstBufferList *
gst_buffer_list_copy(const GstBufferList * list)84 gst_buffer_list_copy (const GstBufferList * list)
85 {
86 return GST_BUFFER_LIST_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (list)));
87 }
88
89 static inline gboolean
gst_buffer_list_replace(GstBufferList ** old_list,GstBufferList * new_list)90 gst_buffer_list_replace (GstBufferList **old_list, GstBufferList *new_list)
91 {
92 return gst_mini_object_replace ((GstMiniObject **) old_list,
93 (GstMiniObject *) new_list);
94 }
95
96 static inline gboolean
gst_buffer_list_take(GstBufferList ** old_list,GstBufferList * new_list)97 gst_buffer_list_take (GstBufferList **old_list, GstBufferList *new_list)
98 {
99 return gst_mini_object_take ((GstMiniObject **) old_list,
100 (GstMiniObject *) new_list);
101 }
102 #else /* GST_DISABLE_MINIOBJECT_INLINE_FUNCTIONS */
103 GST_API
104 GstBufferList * gst_buffer_list_ref (GstBufferList * list);
105
106 GST_API
107 void gst_buffer_list_unref (GstBufferList * list);
108
109 GST_API
110 void gst_clear_buffer_list (GstBufferList ** list_ptr);
111
112 GST_API
113 GstBufferList * gst_buffer_list_copy (const GstBufferList * list);
114
115 GST_API
116 gboolean gst_buffer_list_replace (GstBufferList ** old_list,
117 GstBufferList * new_list);
118
119 GST_API
120 gboolean gst_buffer_list_take (GstBufferList ** old_list,
121 GstBufferList * new_list);
122 #endif /* GST_DISABLE_MINIOBJECT_INLINE_FUNCTIONS */
123
124 /**
125 * gst_buffer_list_is_writable:
126 * @list: a #GstBufferList
127 *
128 * Tests if you can safely add buffers and groups into a buffer list.
129 */
130 #define gst_buffer_list_is_writable(list) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (list))
131
132 /**
133 * gst_buffer_list_make_writable:
134 * @list: (transfer full): a #GstBufferList
135 *
136 * Makes a writable buffer list from the given buffer list. If the source buffer
137 * list is already writable, this will simply return the same buffer list. A
138 * copy will otherwise be made using gst_buffer_list_copy().
139 *
140 * Returns: (transfer full): a writable list, which may or may not be the
141 * same as @list
142 */
143 #define gst_buffer_list_make_writable(list) GST_BUFFER_LIST_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (list)))
144
145 GST_API
146 GType gst_buffer_list_get_type (void);
147
148 /* allocation */
149
150 GST_API
151 GstBufferList * gst_buffer_list_new (void) G_GNUC_MALLOC;
152
153 GST_API
154 GstBufferList * gst_buffer_list_new_sized (guint size) G_GNUC_MALLOC;
155
156 GST_API
157 guint gst_buffer_list_length (GstBufferList *list);
158
159 GST_API
160 GstBuffer * gst_buffer_list_get (GstBufferList *list, guint idx);
161
162 GST_API
163 GstBuffer * gst_buffer_list_get_writable (GstBufferList *list, guint idx);
164
165 GST_API
166 void gst_buffer_list_insert (GstBufferList *list, gint idx, GstBuffer *buffer);
167
168 GST_API
169 void gst_buffer_list_remove (GstBufferList *list, guint idx, guint length);
170
171 GST_API
172 gboolean gst_buffer_list_foreach (GstBufferList *list,
173 GstBufferListFunc func,
174 gpointer user_data);
175 GST_API
176 GstBufferList * gst_buffer_list_copy_deep (const GstBufferList * list);
177
178 GST_API
179 gsize gst_buffer_list_calculate_size (GstBufferList * list);
180
181 #define gst_buffer_list_add(l,b) gst_buffer_list_insert((l),-1,(b));
182
183 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstBufferList, gst_buffer_list_unref)
184
185 G_END_DECLS
186
187 #endif /* __GST_BUFFER_LIST_H__ */
188