0b3a7f86f10ae29f31af2c491291425ee40eea74
[platform/upstream/gstreamer.git] / gst / gstbuffer.h
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *
5  * gstbuffer.h: Header for GstBuffer 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., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
22
23
24 #ifndef __GST_BUFFER_H__
25 #define __GST_BUFFER_H__
26
27 #include <gst/gstminiobject.h>
28 #include <gst/gstclock.h>
29 #include <gst/gstmemory.h>
30
31 G_BEGIN_DECLS
32
33 GST_EXPORT GType _gst_buffer_type;
34
35 typedef struct _GstBuffer GstBuffer;
36 typedef struct _GstBufferPool GstBufferPool;
37
38 #define GST_TYPE_BUFFER                         (_gst_buffer_type)
39 #define GST_IS_BUFFER(obj)                      (GST_IS_MINI_OBJECT_TYPE(obj, GST_TYPE_BUFFER))
40 #define GST_BUFFER_CAST(obj)                    ((GstBuffer *)(obj))
41 #define GST_BUFFER(obj)                         (GST_BUFFER_CAST(obj))
42
43 /**
44  * GST_BUFFER_FLAGS:
45  * @buf: a #GstBuffer.
46  *
47  * A flags word containing #GstBufferFlag flags set on this buffer.
48  */
49 #define GST_BUFFER_FLAGS(buf)                   GST_MINI_OBJECT_FLAGS(buf)
50 /**
51  * GST_BUFFER_FLAG_IS_SET:
52  * @buf: a #GstBuffer.
53  * @flag: the #GstBufferFlag to check.
54  *
55  * Gives the status of a specific flag on a buffer.
56  */
57 #define GST_BUFFER_FLAG_IS_SET(buf,flag)        GST_MINI_OBJECT_FLAG_IS_SET (buf, flag)
58 /**
59  * GST_BUFFER_FLAG_SET:
60  * @buf: a #GstBuffer.
61  * @flag: the #GstBufferFlag to set.
62  *
63  * Sets a buffer flag on a buffer.
64  */
65 #define GST_BUFFER_FLAG_SET(buf,flag)           GST_MINI_OBJECT_FLAG_SET (buf, flag)
66 /**
67  * GST_BUFFER_FLAG_UNSET:
68  * @buf: a #GstBuffer.
69  * @flag: the #GstBufferFlag to clear.
70  *
71  * Clears a buffer flag.
72  */
73 #define GST_BUFFER_FLAG_UNSET(buf,flag)         GST_MINI_OBJECT_FLAG_UNSET (buf, flag)
74
75
76 /**
77  * GST_BUFFER_PTS:
78  * @buf: a #GstBuffer.:
79  *
80  * The presentation timestamp (pts) in nanoseconds (as a #GstClockTime)
81  * of the data in the buffer. This is the timestamp when the media should be
82  * presented to the user.
83  * Value will be %GST_CLOCK_TIME_NONE if the pts is unknown.
84  */
85 #define GST_BUFFER_PTS(buf)                     (GST_BUFFER_CAST(buf)->pts)
86 /**
87  * GST_BUFFER_DTS:
88  * @buf: a #GstBuffer.:
89  *
90  * The decoding timestamp (dts) in nanoseconds (as a #GstClockTime)
91  * of the data in the buffer. This is the timestamp when the media should be
92  * decoded or processed otherwise.
93  * Value will be %GST_CLOCK_TIME_NONE if the dts is unknown.
94  */
95 #define GST_BUFFER_DTS(buf)                     (GST_BUFFER_CAST(buf)->dts)
96 /**
97  * GST_BUFFER_DURATION:
98  * @buf: a #GstBuffer.
99  *
100  * The duration in nanoseconds (as a #GstClockTime) of the data in the buffer.
101  * Value will be %GST_CLOCK_TIME_NONE if the duration is unknown.
102  */
103 #define GST_BUFFER_DURATION(buf)                (GST_BUFFER_CAST(buf)->duration)
104 /**
105  * GST_BUFFER_OFFSET:
106  * @buf: a #GstBuffer.
107  *
108  * The offset in the source file of the beginning of this buffer.
109  */
110 #define GST_BUFFER_OFFSET(buf)                  (GST_BUFFER_CAST(buf)->offset)
111 /**
112  * GST_BUFFER_OFFSET_END:
113  * @buf: a #GstBuffer.
114  *
115  * The offset in the source file of the end of this buffer.
116  */
117 #define GST_BUFFER_OFFSET_END(buf)              (GST_BUFFER_CAST(buf)->offset_end)
118
119 /**
120  * GST_BUFFER_OFFSET_NONE:
121  *
122  * Constant for no-offset return results.
123  */
124 #define GST_BUFFER_OFFSET_NONE  ((guint64)-1)
125
126 /**
127  * GST_BUFFER_DURATION_IS_VALID:
128  * @buffer: a #GstBuffer
129  *
130  * Tests if the duration is known.
131  */
132 #define GST_BUFFER_DURATION_IS_VALID(buffer)    (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DURATION (buffer)))
133 /**
134  * GST_BUFFER_PTS_IS_VALID:
135  * @buffer: a #GstBuffer
136  *
137  * Tests if the pts is known.
138  */
139 #define GST_BUFFER_PTS_IS_VALID(buffer)   (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_PTS (buffer)))
140 /**
141  * GST_BUFFER_DTS_IS_VALID:
142  * @buffer: a #GstBuffer
143  *
144  * Tests if the dts is known.
145  */
146 #define GST_BUFFER_DTS_IS_VALID(buffer)   (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DTS (buffer)))
147 /**
148  * GST_BUFFER_OFFSET_IS_VALID:
149  * @buffer: a #GstBuffer
150  *
151  * Tests if the start offset is known.
152  */
153 #define GST_BUFFER_OFFSET_IS_VALID(buffer)      (GST_BUFFER_OFFSET (buffer) != GST_BUFFER_OFFSET_NONE)
154 /**
155  * GST_BUFFER_OFFSET_END_IS_VALID:
156  * @buffer: a #GstBuffer
157  *
158  * Tests if the end offset is known.
159  */
160 #define GST_BUFFER_OFFSET_END_IS_VALID(buffer)  (GST_BUFFER_OFFSET_END (buffer) != GST_BUFFER_OFFSET_NONE)
161 /**
162  * GST_BUFFER_IS_DISCONT:
163  * @buffer: a #GstBuffer
164  *
165  * Tests if the buffer marks a discontinuity in the stream.
166  *
167  * Since: 0.10.9
168  */
169 #define GST_BUFFER_IS_DISCONT(buffer)   (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DISCONT))
170
171 /**
172  * GstBufferFlags:
173  * @GST_BUFFER_FLAG_LIVE:        the buffer is live data and should be discarded in
174  *                               the PAUSED state.
175  * @GST_BUFFER_FLAG_DECODE_ONLY: the buffer contains data that should be dropped
176  *                               because it will be clipped against the segment
177  *                               boundaries or because it does not contain data
178  *                               that should be shown to the user.
179  * @GST_BUFFER_FLAG_DISCONT:     the buffer marks a data discontinuity in the stream.
180  *                               This typically occurs after a seek or a dropped buffer
181  *                               from a live or network source.
182  * @GST_BUFFER_FLAG_RESYNC:      the buffer timestamps might have a discontinuity
183  *                               and this buffer is a good point to resynchronize.
184  * @GST_BUFFER_FLAG_CORRUPTED:   the buffer data is corrupted.
185  * @GST_BUFFER_FLAG_MARKER:      the buffer contains a media specific marker. for
186  *                               video this is typically the end of a frame boundary, for audio
187  *                               this is usually the end of a talkspurt.
188  * @GST_BUFFER_FLAG_HEADER:      the buffer contains header information that is
189  *                               needed to decode the following data. The buffer
190  *                               is also part of the headers of the STREAM_CONFIG event.
191  * @GST_BUFFER_FLAG_GAP:         the buffer has been created to fill a gap in the
192  *                               stream and contains media neutral data (elements can
193  *                               switch to optimized code path that ignores the buffer
194  *                               content).
195  * @GST_BUFFER_FLAG_DROPPABLE:   the buffer can be dropped without breaking the
196  *                               stream, for example to reduce bandwidth.
197  * @GST_BUFFER_FLAG_DELTA_UNIT:  this unit cannot be decoded independently.
198  * @GST_BUFFER_FLAG_LAST:        additional media specific flags can be added starting from
199  *                               this flag.
200  *
201  * A set of buffer flags used to describe properties of a #GstBuffer.
202  */
203 typedef enum {
204   GST_BUFFER_FLAG_LIVE        = (GST_MINI_OBJECT_FLAG_LAST << 0),
205   GST_BUFFER_FLAG_DECODE_ONLY = (GST_MINI_OBJECT_FLAG_LAST << 1),
206   GST_BUFFER_FLAG_DISCONT     = (GST_MINI_OBJECT_FLAG_LAST << 2),
207   GST_BUFFER_FLAG_RESYNC      = (GST_MINI_OBJECT_FLAG_LAST << 3),
208   GST_BUFFER_FLAG_CORRUPTED   = (GST_MINI_OBJECT_FLAG_LAST << 4),
209   GST_BUFFER_FLAG_MARKER      = (GST_MINI_OBJECT_FLAG_LAST << 5),
210   GST_BUFFER_FLAG_HEADER      = (GST_MINI_OBJECT_FLAG_LAST << 6),
211   GST_BUFFER_FLAG_GAP         = (GST_MINI_OBJECT_FLAG_LAST << 7),
212   GST_BUFFER_FLAG_DROPPABLE   = (GST_MINI_OBJECT_FLAG_LAST << 8),
213   GST_BUFFER_FLAG_DELTA_UNIT  = (GST_MINI_OBJECT_FLAG_LAST << 9),
214
215   GST_BUFFER_FLAG_LAST        = (GST_MINI_OBJECT_FLAG_LAST << 16)
216 } GstBufferFlags;
217
218 /**
219  * GstBuffer:
220  * @mini_object: the parent structure
221  * @pool: pointer to the pool owner of the buffer
222  * @pts: presentation timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
223  *     pts is not known or relevant. The pts contains the timestamp when the
224  *     media should be presented to the user.
225  * @dts: decoding timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
226  *     dts is not known or relevant. The dts contains the timestamp when the
227  *     media should be processed.
228  * @duration: duration in time of the buffer data, can be #GST_CLOCK_TIME_NONE
229  *     when the duration is not known or relevant.
230  * @offset: a media specific offset for the buffer data.
231  *     For video frames, this is the frame number of this buffer.
232  *     For audio samples, this is the offset of the first sample in this buffer.
233  *     For file data or compressed data this is the byte offset of the first
234  *       byte in this buffer.
235  * @offset_end: the last offset contained in this buffer. It has the same
236  *     format as @offset.
237  *
238  * The structure of a #GstBuffer. Use the associated macros to access the public
239  * variables.
240  */
241 struct _GstBuffer {
242   GstMiniObject          mini_object;
243
244   /*< public >*/ /* with COW */
245   GstBufferPool         *pool;
246
247   /* timestamp */
248   GstClockTime           pts;
249   GstClockTime           dts;
250   GstClockTime           duration;
251
252   /* media specific offset */
253   guint64                offset;
254   guint64                offset_end;
255 };
256
257 GType       gst_buffer_get_type            (void);
258
259 /* allocation */
260 GstBuffer * gst_buffer_new                 (void);
261 GstBuffer * gst_buffer_new_allocate        (GstAllocator * allocator, gsize size,
262                                             GstAllocationParams * params);
263 GstBuffer * gst_buffer_new_wrapped_full    (GstMemoryFlags flags, gpointer data, gsize maxsize,
264                                             gsize offset, gsize size, gpointer user_data,
265                                             GDestroyNotify notify);
266 GstBuffer * gst_buffer_new_wrapped         (gpointer data, gsize size);
267
268 /* memory blocks */
269 guint       gst_buffer_n_memory             (GstBuffer *buffer);
270 void        gst_buffer_insert_memory        (GstBuffer *buffer, gint idx, GstMemory *mem);
271 void        gst_buffer_replace_memory_range (GstBuffer *buffer, guint idx, gint length, GstMemory *mem);
272 GstMemory * gst_buffer_peek_memory          (GstBuffer *buffer, guint idx);
273 GstMemory * gst_buffer_get_memory_range     (GstBuffer *buffer, guint idx, gint length);
274 void        gst_buffer_remove_memory_range  (GstBuffer *buffer, guint idx, gint length);
275
276 #define     gst_buffer_prepend_memory(b,m)     gst_buffer_insert_memory ((b), 0, (m))
277 #define     gst_buffer_append_memory(b,m)      gst_buffer_insert_memory ((b), -1, (m))
278 #define     gst_buffer_replace_memory(b,i,m)   gst_buffer_replace_memory_range ((b), (i), 1, (m))
279 #define     gst_buffer_replace_all_memory(b,m) gst_buffer_replace_memory ((b), 0, -1, (m))
280 #define     gst_buffer_get_memory(b,i)         gst_buffer_get_memory_range ((b), (i), 1)
281 #define     gst_buffer_get_all_memory(b)       gst_buffer_get_memory_range ((b), 0, -1)
282 /**
283  * gst_buffer_remove_memory:
284  * @b: a #GstBuffer.
285  * @i: an index
286  *
287  * Remove the memory block in @b at @i.
288  */
289 #define     gst_buffer_remove_memory(b,i)      gst_buffer_remove_memory_range ((b), (i), 1)
290 #define     gst_buffer_remove_all_memory(b)    gst_buffer_remove_memory_range ((b), 0, -1)
291
292 gboolean    gst_buffer_find_memory         (GstBuffer *buffer, gsize offset, gsize size,
293                                             guint *idx, guint *length, gsize *skip);
294
295 gsize       gst_buffer_fill                (GstBuffer *buffer, gsize offset,
296                                             gconstpointer src, gsize size);
297 gsize       gst_buffer_extract             (GstBuffer *buffer, gsize offset,
298                                             gpointer dest, gsize size);
299 gint        gst_buffer_memcmp              (GstBuffer *buffer, gsize offset,
300                                             gconstpointer mem, gsize size);
301 gsize       gst_buffer_memset              (GstBuffer *buffer, gsize offset,
302                                             guint8 val, gsize size);
303
304 gsize       gst_buffer_get_sizes_range     (GstBuffer *buffer, guint idx, gint length,
305                                             gsize *offset, gsize *maxsize);
306 void        gst_buffer_resize_range        (GstBuffer *buffer, guint idx, gint length,
307                                             gssize offset, gssize size);
308
309 #define     gst_buffer_get_sizes(b,of,ms)  gst_buffer_get_sizes_range ((b), 0, -1, (of), (ms))
310 /**
311  * gst_buffer_get_size:
312  * @b: a #GstBuffer.
313  *
314  * Get the size of @b.
315  */
316 #define     gst_buffer_get_size(b)         gst_buffer_get_sizes_range ((b), 0, -1, NULL, NULL)
317 #define     gst_buffer_resize(b,of,s)      gst_buffer_resize_range ((b), 0, -1, (of), (s))
318 /**
319  * gst_buffer_set_size:
320  * @b: a #GstBuffer.
321  * @s: a new size
322  *
323  * Set the size of @b to @s. This will remove or trim the memory blocks
324  * in the buffer.
325  */
326 #define     gst_buffer_set_size(b,s)       gst_buffer_resize_range ((b), 0, -1, 0, (s))
327
328 gboolean    gst_buffer_map_range           (GstBuffer *buffer, guint idx, gint length,
329                                             GstMapInfo *info, GstMapFlags flags);
330 #define     gst_buffer_map(b,i,f)          gst_buffer_map_range ((b), 0, -1, (i), (f))
331
332 void        gst_buffer_unmap               (GstBuffer *buffer, GstMapInfo *info);
333
334
335 /* refcounting */
336 /**
337  * gst_buffer_ref:
338  * @buf: a #GstBuffer.
339  *
340  * Increases the refcount of the given buffer by one.
341  *
342  * Note that the refcount affects the writeability
343  * of @buf and its metadata, see gst_buffer_is_writable() and
344  * gst_buffer_is_metadata_writable(). It is
345  * important to note that keeping additional references to
346  * GstBuffer instances can potentially increase the number
347  * of memcpy operations in a pipeline.
348  *
349  * Returns: (transfer full): @buf
350  */
351 #ifdef _FOOL_GTK_DOC_
352 G_INLINE_FUNC GstBuffer * gst_buffer_ref (GstBuffer * buf);
353 #endif
354
355 static inline GstBuffer *
356 gst_buffer_ref (GstBuffer * buf)
357 {
358   return (GstBuffer *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (buf));
359 }
360
361 /**
362  * gst_buffer_unref:
363  * @buf: (transfer full): a #GstBuffer.
364  *
365  * Decreases the refcount of the buffer. If the refcount reaches 0, the buffer
366  * with the associated metadata and memory will be freed.
367  */
368 #ifdef _FOOL_GTK_DOC_
369 G_INLINE_FUNC void gst_buffer_unref (GstBuffer * buf);
370 #endif
371
372 static inline void
373 gst_buffer_unref (GstBuffer * buf)
374 {
375   gst_mini_object_unref (GST_MINI_OBJECT_CAST (buf));
376 }
377
378 /* copy buffer */
379 /**
380  * gst_buffer_copy:
381  * @buf: a #GstBuffer.
382  *
383  * Create a copy of the given buffer. This will also make a newly allocated
384  * copy of the data the source buffer contains.
385  *
386  * Returns: (transfer full): a new copy of @buf.
387  */
388 #ifdef _FOOL_GTK_DOC_
389 G_INLINE_FUNC GstBuffer * gst_buffer_copy (const GstBuffer * buf);
390 #endif
391
392 static inline GstBuffer *
393 gst_buffer_copy (const GstBuffer * buf)
394 {
395   return GST_BUFFER (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (buf)));
396 }
397
398
399 /**
400  * GstBufferCopyFlags:
401  * @GST_BUFFER_COPY_NONE: copy nothing
402  * @GST_BUFFER_COPY_FLAGS: flag indicating that buffer flags should be copied
403  * @GST_BUFFER_COPY_TIMESTAMPS: flag indicating that buffer pts, dts,
404  * duration, offset and offset_end should be copied
405  * @GST_BUFFER_COPY_MEMORY: flag indicating that buffer memory should be copied
406  * and appended to already existing memory
407  * @GST_BUFFER_COPY_MERGE: flag indicating that buffer memory should be
408  * merged
409  * @GST_BUFFER_COPY_META: flag indicating that buffer meta should be
410  * copied
411  *
412  * A set of flags that can be provided to the gst_buffer_copy_into()
413  * function to specify which items should be copied.
414  */
415 typedef enum {
416   GST_BUFFER_COPY_NONE           = 0,
417   GST_BUFFER_COPY_FLAGS          = (1 << 0),
418   GST_BUFFER_COPY_TIMESTAMPS     = (1 << 1),
419   GST_BUFFER_COPY_META           = (1 << 2),
420   GST_BUFFER_COPY_MEMORY         = (1 << 3),
421   GST_BUFFER_COPY_MERGE          = (1 << 4)
422 } GstBufferCopyFlags;
423
424 /**
425  * GST_BUFFER_COPY_METADATA:
426  *
427  * Combination of all possible metadata fields that can be copied with
428  * gst_buffer_copy_into().
429  */
430 #define GST_BUFFER_COPY_METADATA       (GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS |\
431                                         GST_BUFFER_COPY_META)
432
433 /**
434  * GST_BUFFER_COPY_ALL:
435  *
436  * Combination of all possible fields that can be copied with
437  * gst_buffer_copy_into().
438  */
439 #define GST_BUFFER_COPY_ALL  ((GstBufferCopyFlags)(GST_BUFFER_COPY_METADATA | GST_BUFFER_COPY_MEMORY))
440
441 /* copies memory or metadata into newly allocated buffer */
442 void            gst_buffer_copy_into            (GstBuffer *dest, GstBuffer *src,
443                                                  GstBufferCopyFlags flags,
444                                                  gsize offset, gsize size);
445
446 /**
447  * gst_buffer_is_writable:
448  * @buf: a #GstBuffer
449  *
450  * Tests if you can safely write data into a buffer's data array or validly
451  * modify the caps and timestamp metadata. Metadata in a GstBuffer is always
452  * writable, but it is only safe to change it when there is only one owner
453  * of the buffer - ie, the refcount is 1.
454  */
455 #define         gst_buffer_is_writable(buf)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (buf))
456 /**
457  * gst_buffer_make_writable:
458  * @buf: (transfer full): a #GstBuffer
459  *
460  * Makes a writable buffer from the given buffer. If the source buffer is
461  * already writable, this will simply return the same buffer. A copy will
462  * otherwise be made using gst_buffer_copy().
463  *
464  * Returns: (transfer full): a writable buffer which may or may not be the
465  *     same as @buf
466  */
467 #define         gst_buffer_make_writable(buf)   GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (buf)))
468
469 /**
470  * gst_buffer_replace:
471  * @obuf: (inout) (transfer full): pointer to a pointer to a #GstBuffer to be
472  *     replaced.
473  * @nbuf: (transfer none) (allow-none): pointer to a #GstBuffer that will
474  *     replace the buffer pointed to by @obuf.
475  *
476  * Modifies a pointer to a #GstBuffer to point to a different #GstBuffer. The
477  * modification is done atomically (so this is useful for ensuring thread safety
478  * in some cases), and the reference counts are updated appropriately (the old
479  * buffer is unreffed, the new is reffed).
480  *
481  * Either @nbuf or the #GstBuffer pointed to by @obuf may be NULL.
482  *
483  * Returns: TRUE when @obuf was different from @nbuf.
484  */
485 #ifdef _FOOL_GTK_DOC_
486 G_INLINE_FUNC gboolean gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf);
487 #endif
488
489 static inline gboolean
490 gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf)
491 {
492   return gst_mini_object_replace ((GstMiniObject **) obuf, (GstMiniObject *) nbuf);
493 }
494
495 /* creating a region */
496 GstBuffer*      gst_buffer_copy_region          (GstBuffer *parent, GstBufferCopyFlags flags,
497                                                  gsize offset, gsize size);
498
499 /* append two buffers */
500 GstBuffer*      gst_buffer_append               (GstBuffer *buf1, GstBuffer *buf2);
501
502 /* metadata */
503 #include <gst/gstmeta.h>
504
505 /**
506  * GstBufferForeachMetaFunc:
507  * @buffer: a #GstBuffer
508  * @meta: a pointer to a #GstMeta
509  * @user_data: user data passed to gst_buffer_foreach_meta()
510  *
511  * A function that will be called from gst_buffer_foreach_meta(). The @meta
512  * field will point to a the reference of the meta.
513  *
514  * @buffer should not be modified from this callback.
515  *
516  * When this function returns %TRUE, the next meta will be
517  * returned. When %FALSE is returned, gst_buffer_foreach_meta() will return.
518  *
519  * When @meta is set to NULL, the item will be removed from the buffer.
520  *
521  * Returns: %FALSE when gst_buffer_foreach_meta() should stop
522  */
523 typedef gboolean (*GstBufferForeachMetaFunc)    (GstBuffer *buffer, GstMeta **meta,
524                                                  gpointer user_data);
525
526 GstMeta *       gst_buffer_get_meta             (GstBuffer *buffer, GType api);
527 GstMeta *       gst_buffer_add_meta             (GstBuffer *buffer, const GstMetaInfo *info,
528                                                  gpointer params);
529 gboolean        gst_buffer_remove_meta          (GstBuffer *buffer, GstMeta *meta);
530
531 GstMeta *       gst_buffer_iterate_meta         (GstBuffer *buffer, gpointer *state);
532
533 void            gst_buffer_foreach_meta         (GstBuffer *buffer,
534                                                  GstBufferForeachMetaFunc func,
535                                                  gpointer user_data);
536
537 /**
538  * gst_value_set_buffer:
539  * @v: a #GValue to receive the data
540  * @b: (transfer none): a #GstBuffer to assign to the GstValue
541  *
542  * Sets @b as the value of @v.  Caller retains reference to buffer.
543  */
544 #define         gst_value_set_buffer(v,b)       g_value_set_boxed((v),(b))
545 /**
546  * gst_value_take_buffer:
547  * @v: a #GValue to receive the data
548  * @b: (transfer full): a #GstBuffer to assign to the GstValue
549  *
550  * Sets @b as the value of @v.  Caller gives away reference to buffer.
551  */
552 #define         gst_value_take_buffer(v,b)      g_value_take_boxed(v,(b))
553 /**
554  * gst_value_get_buffer:
555  * @v: a #GValue to query
556  *
557  * Receives a #GstBuffer as the value of @v. Does not return a reference to
558  * the buffer, so the pointer is only valid for as long as the caller owns
559  * a reference to @v.
560  *
561  * Returns: (transfer none): buffer
562  */
563 #define         gst_value_get_buffer(v)         GST_BUFFER_CAST (g_value_get_boxed(v))
564
565 G_END_DECLS
566
567 #endif /* __GST_BUFFER_H__ */