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 gsize       gst_buffer_fill                (GstBuffer *buffer, gsize offset,
 293                                             gconstpointer src, gsize size);
 294 gsize       gst_buffer_extract             (GstBuffer *buffer, gsize offset,
 295                                             gpointer dest, gsize size);
 296 gint        gst_buffer_memcmp              (GstBuffer *buffer, gsize offset,
 297                                             gconstpointer mem, gsize size);
 298 gsize       gst_buffer_memset              (GstBuffer *buffer, gsize offset,
 299                                             guint8 val, gsize size);
 300
 301 gsize       gst_buffer_get_sizes           (GstBuffer *buffer, gsize *offset, gsize *maxsize);
 302 void        gst_buffer_resize              (GstBuffer *buffer, gssize offset, gssize size);
 303
 304 /**
 305  * gst_buffer_get_size:
 306  * @b: a #GstBuffer.
 307  *
 308  * Get the size of @b.
 309  */
 310 #define     gst_buffer_get_size(b)         gst_buffer_get_sizes ((b), NULL, NULL)
 311 /**
 312  * gst_buffer_set_size:
 313  * @b: a #GstBuffer.
 314  * @s: a new size
 315  *
 316  * Set the size of @b to @s. This will remove or trim the memory blocks
 317  * in the buffer.
 318  */
 319 #define     gst_buffer_set_size(b,s)       gst_buffer_resize ((b), 0, (s))
 320
 321 gboolean    gst_buffer_map_range           (GstBuffer *buffer, guint idx, gint length,
 322                                             GstMapInfo *info, GstMapFlags flags);
 323 #define     gst_buffer_map(b,i,f)          gst_buffer_map_range ((b), 0, -1, (i), (f))
 324
 325 void        gst_buffer_unmap               (GstBuffer *buffer, GstMapInfo *info);
 326
 327
 328 /* refcounting */
 329 /**
 330  * gst_buffer_ref:
 331  * @buf: a #GstBuffer.
 332  *
 333  * Increases the refcount of the given buffer by one.
 334  *
 335  * Note that the refcount affects the writeability
 336  * of @buf and its metadata, see gst_buffer_is_writable() and
 337  * gst_buffer_is_metadata_writable(). It is
 338  * important to note that keeping additional references to
 339  * GstBuffer instances can potentially increase the number
 340  * of memcpy operations in a pipeline.
 341  *
 342  * Returns: (transfer full): @buf
 343  */
 344 #ifdef _FOOL_GTK_DOC_
 345 G_INLINE_FUNC GstBuffer * gst_buffer_ref (GstBuffer * buf);
 346 #endif
 347
 348 static inline GstBuffer *
 349 gst_buffer_ref (GstBuffer * buf)
 350 {
 351   return (GstBuffer *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (buf));
 352 }
 353
 354 /**
 355  * gst_buffer_unref:
 356  * @buf: (transfer full): a #GstBuffer.
 357  *
 358  * Decreases the refcount of the buffer. If the refcount reaches 0, the buffer
 359  * with the associated metadata and memory will be freed.
 360  */
 361 #ifdef _FOOL_GTK_DOC_
 362 G_INLINE_FUNC void gst_buffer_unref (GstBuffer * buf);
 363 #endif
 364
 365 static inline void
 366 gst_buffer_unref (GstBuffer * buf)
 367 {
 368   gst_mini_object_unref (GST_MINI_OBJECT_CAST (buf));
 369 }
 370
 371 /* copy buffer */
 372 /**
 373  * gst_buffer_copy:
 374  * @buf: a #GstBuffer.
 375  *
 376  * Create a copy of the given buffer. This will also make a newly allocated
 377  * copy of the data the source buffer contains.
 378  *
 379  * Returns: (transfer full): a new copy of @buf.
 380  */
 381 #ifdef _FOOL_GTK_DOC_
 382 G_INLINE_FUNC GstBuffer * gst_buffer_copy (const GstBuffer * buf);
 383 #endif
 384
 385 static inline GstBuffer *
 386 gst_buffer_copy (const GstBuffer * buf)
 387 {
 388   return GST_BUFFER (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (buf)));
 389 }
 390
 391
 392 /**
 393  * GstBufferCopyFlags:
 394  * @GST_BUFFER_COPY_NONE: copy nothing
 395  * @GST_BUFFER_COPY_FLAGS: flag indicating that buffer flags should be copied
 396  * @GST_BUFFER_COPY_TIMESTAMPS: flag indicating that buffer pts, dts,
 397  * duration, offset and offset_end should be copied
 398  * @GST_BUFFER_COPY_MEMORY: flag indicating that buffer memory should be copied
 399  * and appended to already existing memory
 400  * @GST_BUFFER_COPY_MERGE: flag indicating that buffer memory should be
 401  * merged
 402  * @GST_BUFFER_COPY_META: flag indicating that buffer meta should be
 403  * copied
 404  *
 405  * A set of flags that can be provided to the gst_buffer_copy_into()
 406  * function to specify which items should be copied.
 407  */
 408 typedef enum {
 409   GST_BUFFER_COPY_NONE           = 0,
 410   GST_BUFFER_COPY_FLAGS          = (1 << 0),
 411   GST_BUFFER_COPY_TIMESTAMPS     = (1 << 1),
 412   GST_BUFFER_COPY_META           = (1 << 2),
 413   GST_BUFFER_COPY_MEMORY         = (1 << 3),
 414   GST_BUFFER_COPY_MERGE          = (1 << 4)
 415 } GstBufferCopyFlags;
 416
 417 /**
 418  * GST_BUFFER_COPY_METADATA:
 419  *
 420  * Combination of all possible metadata fields that can be copied with
 421  * gst_buffer_copy_into().
 422  */
 423 #define GST_BUFFER_COPY_METADATA       (GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS |\
 424                                         GST_BUFFER_COPY_META)
 425
 426 /**
 427  * GST_BUFFER_COPY_ALL:
 428  *
 429  * Combination of all possible fields that can be copied with
 430  * gst_buffer_copy_into().
 431  */
 432 #define GST_BUFFER_COPY_ALL  ((GstBufferCopyFlags)(GST_BUFFER_COPY_METADATA | GST_BUFFER_COPY_MEMORY))
 433
 434 /* copies memory or metadata into newly allocated buffer */
 435 void            gst_buffer_copy_into            (GstBuffer *dest, GstBuffer *src,
 436                                                  GstBufferCopyFlags flags,
 437                                                  gsize offset, gsize size);
 438
 439 /**
 440  * gst_buffer_is_writable:
 441  * @buf: a #GstBuffer
 442  *
 443  * Tests if you can safely write data into a buffer's data array or validly
 444  * modify the caps and timestamp metadata. Metadata in a GstBuffer is always
 445  * writable, but it is only safe to change it when there is only one owner
 446  * of the buffer - ie, the refcount is 1.
 447  */
 448 #define         gst_buffer_is_writable(buf)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (buf))
 449 /**
 450  * gst_buffer_make_writable:
 451  * @buf: (transfer full): a #GstBuffer
 452  *
 453  * Makes a writable buffer from the given buffer. If the source buffer is
 454  * already writable, this will simply return the same buffer. A copy will
 455  * otherwise be made using gst_buffer_copy().
 456  *
 457  * Returns: (transfer full): a writable buffer which may or may not be the
 458  *     same as @buf
 459  */
 460 #define         gst_buffer_make_writable(buf)   GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (buf)))
 461
 462 /**
 463  * gst_buffer_replace:
 464  * @obuf: (inout) (transfer full): pointer to a pointer to a #GstBuffer to be
 465  *     replaced.
 466  * @nbuf: (transfer none) (allow-none): pointer to a #GstBuffer that will
 467  *     replace the buffer pointed to by @obuf.
 468  *
 469  * Modifies a pointer to a #GstBuffer to point to a different #GstBuffer. The
 470  * modification is done atomically (so this is useful for ensuring thread safety
 471  * in some cases), and the reference counts are updated appropriately (the old
 472  * buffer is unreffed, the new is reffed).
 473  *
 474  * Either @nbuf or the #GstBuffer pointed to by @obuf may be NULL.
 475  *
 476  * Returns: TRUE when @obuf was different from @nbuf.
 477  */
 478 #ifdef _FOOL_GTK_DOC_
 479 G_INLINE_FUNC gboolean gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf);
 480 #endif
 481
 482 static inline gboolean
 483 gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf)
 484 {
 485   return gst_mini_object_replace ((GstMiniObject **) obuf, (GstMiniObject *) nbuf);
 486 }
 487
 488 /* creating a region */
 489 GstBuffer*      gst_buffer_copy_region          (GstBuffer *parent, GstBufferCopyFlags flags,
 490                                                  gsize offset, gsize size);
 491
 492 /* append two buffers */
 493 GstBuffer*      gst_buffer_append               (GstBuffer *buf1, GstBuffer *buf2);
 494
 495 /* metadata */
 496 #include <gst/gstmeta.h>
 497
 498 /**
 499  * GstBufferForeachMetaFunc:
 500  * @buffer: a #GstBuffer
 501  * @meta: a pointer to a #GstMeta
 502  * @user_data: user data passed to gst_buffer_foreach_meta()
 503  *
 504  * A function that will be called from gst_buffer_foreach_meta(). The @meta
 505  * field will point to a the reference of the meta.
 506  *
 507  * @buffer should not be modified from this callback.
 508  *
 509  * When this function returns %TRUE, the next meta will be
 510  * returned. When %FALSE is returned, gst_buffer_foreach_meta() will return.
 511  *
 512  * When @meta is set to NULL, the item will be removed from the buffer.
 513  *
 514  * Returns: %FALSE when gst_buffer_foreach_meta() should stop
 515  */
 516 typedef gboolean (*GstBufferForeachMetaFunc)    (GstBuffer *buffer, GstMeta **meta,
 517                                                  gpointer user_data);
 518
 519 GstMeta *       gst_buffer_get_meta             (GstBuffer *buffer, GType api);
 520 GstMeta *       gst_buffer_add_meta             (GstBuffer *buffer, const GstMetaInfo *info,
 521                                                  gpointer params);
 522 gboolean        gst_buffer_remove_meta          (GstBuffer *buffer, GstMeta *meta);
 523
 524 GstMeta *       gst_buffer_iterate_meta         (GstBuffer *buffer, gpointer *state);
 525
 526 void            gst_buffer_foreach_meta         (GstBuffer *buffer,
 527                                                  GstBufferForeachMetaFunc func,
 528                                                  gpointer user_data);
 529
 530 /**
 531  * gst_value_set_buffer:
 532  * @v: a #GValue to receive the data
 533  * @b: (transfer none): a #GstBuffer to assign to the GstValue
 534  *
 535  * Sets @b as the value of @v.  Caller retains reference to buffer.
 536  */
 537 #define         gst_value_set_buffer(v,b)       g_value_set_boxed((v),(b))
 538 /**
 539  * gst_value_take_buffer:
 540  * @v: a #GValue to receive the data
 541  * @b: (transfer full): a #GstBuffer to assign to the GstValue
 542  *
 543  * Sets @b as the value of @v.  Caller gives away reference to buffer.
 544  */
 545 #define         gst_value_take_buffer(v,b)      g_value_take_boxed(v,(b))
 546 /**
 547  * gst_value_get_buffer:
 548  * @v: a #GValue to query
 549  *
 550  * Receives a #GstBuffer as the value of @v. Does not return a reference to
 551  * the buffer, so the pointer is only valid for as long as the caller owns
 552  * a reference to @v.
 553  *
 554  * Returns: (transfer none): buffer
 555  */
 556 #define         gst_value_get_buffer(v)         GST_BUFFER_CAST (g_value_get_boxed(v))
 557
 558 G_END_DECLS
 559
 560 #endif /* __GST_BUFFER_H__ */