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/gstallocator.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 #define GST_BUFFER_IS_DISCONT(buffer)   (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DISCONT))
 168
 169 /**
 170  * GstBufferFlags:
 171  * @GST_BUFFER_FLAG_LIVE:        the buffer is live data and should be discarded in
 172  *                               the PAUSED state.
 173  * @GST_BUFFER_FLAG_DECODE_ONLY: the buffer contains data that should be dropped
 174  *                               because it will be clipped against the segment
 175  *                               boundaries or because it does not contain data
 176  *                               that should be shown to the user.
 177  * @GST_BUFFER_FLAG_DISCONT:     the buffer marks a data discontinuity in the stream.
 178  *                               This typically occurs after a seek or a dropped buffer
 179  *                               from a live or network source.
 180  * @GST_BUFFER_FLAG_RESYNC:      the buffer timestamps might have a discontinuity
 181  *                               and this buffer is a good point to resynchronize.
 182  * @GST_BUFFER_FLAG_CORRUPTED:   the buffer data is corrupted.
 183  * @GST_BUFFER_FLAG_MARKER:      the buffer contains a media specific marker. for
 184  *                               video this is typically the end of a frame boundary, for audio
 185  *                               this is usually the start of a talkspurt.
 186  * @GST_BUFFER_FLAG_HEADER:      the buffer contains header information that is
 187  *                               needed to decode the following data.
 188  * @GST_BUFFER_FLAG_GAP:         the buffer has been created to fill a gap in the
 189  *                               stream and contains media neutral data (elements can
 190  *                               switch to optimized code path that ignores the buffer
 191  *                               content).
 192  * @GST_BUFFER_FLAG_DROPPABLE:   the buffer can be dropped without breaking the
 193  *                               stream, for example to reduce bandwidth.
 194  * @GST_BUFFER_FLAG_DELTA_UNIT:  this unit cannot be decoded independently.
 195  * @GST_BUFFER_FLAG_LAST:        additional media specific flags can be added starting from
 196  *                               this flag.
 197  *
 198  * A set of buffer flags used to describe properties of a #GstBuffer.
 199  */
 200 typedef enum {
 201   GST_BUFFER_FLAG_LIVE        = (GST_MINI_OBJECT_FLAG_LAST << 0),
 202   GST_BUFFER_FLAG_DECODE_ONLY = (GST_MINI_OBJECT_FLAG_LAST << 1),
 203   GST_BUFFER_FLAG_DISCONT     = (GST_MINI_OBJECT_FLAG_LAST << 2),
 204   GST_BUFFER_FLAG_RESYNC      = (GST_MINI_OBJECT_FLAG_LAST << 3),
 205   GST_BUFFER_FLAG_CORRUPTED   = (GST_MINI_OBJECT_FLAG_LAST << 4),
 206   GST_BUFFER_FLAG_MARKER      = (GST_MINI_OBJECT_FLAG_LAST << 5),
 207   GST_BUFFER_FLAG_HEADER      = (GST_MINI_OBJECT_FLAG_LAST << 6),
 208   GST_BUFFER_FLAG_GAP         = (GST_MINI_OBJECT_FLAG_LAST << 7),
 209   GST_BUFFER_FLAG_DROPPABLE   = (GST_MINI_OBJECT_FLAG_LAST << 8),
 210   GST_BUFFER_FLAG_DELTA_UNIT  = (GST_MINI_OBJECT_FLAG_LAST << 9),
 211
 212   GST_BUFFER_FLAG_LAST        = (GST_MINI_OBJECT_FLAG_LAST << 16)
 213 } GstBufferFlags;
 214
 215 /**
 216  * GstBuffer:
 217  * @mini_object: the parent structure
 218  * @pool: pointer to the pool owner of the buffer
 219  * @pts: presentation timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
 220  *     pts is not known or relevant. The pts contains the timestamp when the
 221  *     media should be presented to the user.
 222  * @dts: decoding timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
 223  *     dts is not known or relevant. The dts contains the timestamp when the
 224  *     media should be processed.
 225  * @duration: duration in time of the buffer data, can be #GST_CLOCK_TIME_NONE
 226  *     when the duration is not known or relevant.
 227  * @offset: a media specific offset for the buffer data.
 228  *     For video frames, this is the frame number of this buffer.
 229  *     For audio samples, this is the offset of the first sample in this buffer.
 230  *     For file data or compressed data this is the byte offset of the first
 231  *       byte in this buffer.
 232  * @offset_end: the last offset contained in this buffer. It has the same
 233  *     format as @offset.
 234  *
 235  * The structure of a #GstBuffer. Use the associated macros to access the public
 236  * variables.
 237  */
 238 struct _GstBuffer {
 239   GstMiniObject          mini_object;
 240
 241   /*< public >*/ /* with COW */
 242   GstBufferPool         *pool;
 243
 244   /* timestamp */
 245   GstClockTime           pts;
 246   GstClockTime           dts;
 247   GstClockTime           duration;
 248
 249   /* media specific offset */
 250   guint64                offset;
 251   guint64                offset_end;
 252 };
 253
 254 GType       gst_buffer_get_type            (void);
 255
 256 /* allocation */
 257 GstBuffer * gst_buffer_new                 (void);
 258 GstBuffer * gst_buffer_new_allocate        (GstAllocator * allocator, gsize size,
 259                                             GstAllocationParams * params);
 260 GstBuffer * gst_buffer_new_wrapped_full    (GstMemoryFlags flags, gpointer data, gsize maxsize,
 261                                             gsize offset, gsize size, gpointer user_data,
 262                                             GDestroyNotify notify);
 263 GstBuffer * gst_buffer_new_wrapped         (gpointer data, gsize size);
 264
 265 /* memory blocks */
 266 guint       gst_buffer_n_memory             (GstBuffer *buffer);
 267 void        gst_buffer_insert_memory        (GstBuffer *buffer, gint idx, GstMemory *mem);
 268 void        gst_buffer_replace_memory_range (GstBuffer *buffer, guint idx, gint length, GstMemory *mem);
 269 GstMemory * gst_buffer_peek_memory          (GstBuffer *buffer, guint idx);
 270 GstMemory * gst_buffer_get_memory_range     (GstBuffer *buffer, guint idx, gint length);
 271 void        gst_buffer_remove_memory_range  (GstBuffer *buffer, guint idx, gint length);
 272
 273 void        gst_buffer_prepend_memory       (GstBuffer *buffer, GstMemory *mem);
 274 void        gst_buffer_append_memory        (GstBuffer *buffer, GstMemory *mem);
 275 void        gst_buffer_replace_memory       (GstBuffer *buffer, guint idx, GstMemory *mem);
 276 void        gst_buffer_replace_all_memory   (GstBuffer *buffer, GstMemory *mem);
 277 GstMemory * gst_buffer_get_memory           (GstBuffer *buffer, guint idx);
 278 GstMemory * gst_buffer_get_all_memory       (GstBuffer *buffer);
 279 void        gst_buffer_remove_memory        (GstBuffer *buffer, guint idx);
 280 void        gst_buffer_remove_all_memory    (GstBuffer *buffer);
 281
 282 gboolean    gst_buffer_find_memory         (GstBuffer *buffer, gsize offset, gsize size,
 283                                             guint *idx, guint *length, gsize *skip);
 284
 285 gsize       gst_buffer_fill                (GstBuffer *buffer, gsize offset,
 286                                             gconstpointer src, gsize size);
 287 gsize       gst_buffer_extract             (GstBuffer *buffer, gsize offset,
 288                                             gpointer dest, gsize size);
 289 gint        gst_buffer_memcmp              (GstBuffer *buffer, gsize offset,
 290                                             gconstpointer mem, gsize size);
 291 gsize       gst_buffer_memset              (GstBuffer *buffer, gsize offset,
 292                                             guint8 val, gsize size);
 293
 294 gsize       gst_buffer_get_sizes_range     (GstBuffer *buffer, guint idx, gint length,
 295                                             gsize *offset, gsize *maxsize);
 296 void        gst_buffer_resize_range        (GstBuffer *buffer, guint idx, gint length,
 297                                             gssize offset, gssize size);
 298
 299 gsize       gst_buffer_get_sizes           (GstBuffer *buffer, gsize *offset, gsize *maxsize);
 300 gsize       gst_buffer_get_size            (GstBuffer *buffer);
 301 void        gst_buffer_resize              (GstBuffer *buffer, gssize offset, gssize size);
 302 void        gst_buffer_set_size            (GstBuffer *buffer, gssize size);
 303
 304 gboolean    gst_buffer_map_range           (GstBuffer *buffer, guint idx, gint length,
 305                                             GstMapInfo *info, GstMapFlags flags);
 306 gboolean    gst_buffer_map                 (GstBuffer *buffer, GstMapInfo *info, GstMapFlags flags);
 307
 308 void        gst_buffer_unmap               (GstBuffer *buffer, GstMapInfo *info);
 309
 310
 311 /* refcounting */
 312 /**
 313  * gst_buffer_ref:
 314  * @buf: a #GstBuffer.
 315  *
 316  * Increases the refcount of the given buffer by one.
 317  *
 318  * Note that the refcount affects the writeability
 319  * of @buf and its metadata, see gst_buffer_is_writable().
 320  * It is important to note that keeping additional references to
 321  * GstBuffer instances can potentially increase the number
 322  * of memcpy operations in a pipeline.
 323  *
 324  * Returns: (transfer full): @buf
 325  */
 326 #ifdef _FOOL_GTK_DOC_
 327 G_INLINE_FUNC GstBuffer * gst_buffer_ref (GstBuffer * buf);
 328 #endif
 329
 330 static inline GstBuffer *
 331 gst_buffer_ref (GstBuffer * buf)
 332 {
 333   return (GstBuffer *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (buf));
 334 }
 335
 336 /**
 337  * gst_buffer_unref:
 338  * @buf: (transfer full): a #GstBuffer.
 339  *
 340  * Decreases the refcount of the buffer. If the refcount reaches 0, the buffer
 341  * with the associated metadata and memory will be freed.
 342  */
 343 #ifdef _FOOL_GTK_DOC_
 344 G_INLINE_FUNC void gst_buffer_unref (GstBuffer * buf);
 345 #endif
 346
 347 static inline void
 348 gst_buffer_unref (GstBuffer * buf)
 349 {
 350   gst_mini_object_unref (GST_MINI_OBJECT_CAST (buf));
 351 }
 352
 353 /* copy buffer */
 354 /**
 355  * gst_buffer_copy:
 356  * @buf: a #GstBuffer.
 357  *
 358  * Create a copy of the given buffer. This will also make a newly allocated
 359  * copy of the data the source buffer contains.
 360  *
 361  * Returns: (transfer full): a new copy of @buf.
 362  */
 363 #ifdef _FOOL_GTK_DOC_
 364 G_INLINE_FUNC GstBuffer * gst_buffer_copy (const GstBuffer * buf);
 365 #endif
 366
 367 static inline GstBuffer *
 368 gst_buffer_copy (const GstBuffer * buf)
 369 {
 370   return GST_BUFFER (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (buf)));
 371 }
 372
 373
 374 /**
 375  * GstBufferCopyFlags:
 376  * @GST_BUFFER_COPY_NONE: copy nothing
 377  * @GST_BUFFER_COPY_FLAGS: flag indicating that buffer flags should be copied
 378  * @GST_BUFFER_COPY_TIMESTAMPS: flag indicating that buffer pts, dts,
 379  * duration, offset and offset_end should be copied
 380  * @GST_BUFFER_COPY_MEMORY: flag indicating that buffer memory should be copied
 381  * and appended to already existing memory
 382  * @GST_BUFFER_COPY_MERGE: flag indicating that buffer memory should be
 383  * merged
 384  * @GST_BUFFER_COPY_META: flag indicating that buffer meta should be
 385  * copied
 386  *
 387  * A set of flags that can be provided to the gst_buffer_copy_into()
 388  * function to specify which items should be copied.
 389  */
 390 typedef enum {
 391   GST_BUFFER_COPY_NONE           = 0,
 392   GST_BUFFER_COPY_FLAGS          = (1 << 0),
 393   GST_BUFFER_COPY_TIMESTAMPS     = (1 << 1),
 394   GST_BUFFER_COPY_META           = (1 << 2),
 395   GST_BUFFER_COPY_MEMORY         = (1 << 3),
 396   GST_BUFFER_COPY_MERGE          = (1 << 4)
 397 } GstBufferCopyFlags;
 398
 399 /**
 400  * GST_BUFFER_COPY_METADATA:
 401  *
 402  * Combination of all possible metadata fields that can be copied with
 403  * gst_buffer_copy_into().
 404  */
 405 #define GST_BUFFER_COPY_METADATA       (GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS |\
 406                                         GST_BUFFER_COPY_META)
 407
 408 /**
 409  * GST_BUFFER_COPY_ALL:
 410  *
 411  * Combination of all possible fields that can be copied with
 412  * gst_buffer_copy_into().
 413  */
 414 #define GST_BUFFER_COPY_ALL  ((GstBufferCopyFlags)(GST_BUFFER_COPY_METADATA | GST_BUFFER_COPY_MEMORY))
 415
 416 /* copies memory or metadata into newly allocated buffer */
 417 void            gst_buffer_copy_into            (GstBuffer *dest, GstBuffer *src,
 418                                                  GstBufferCopyFlags flags,
 419                                                  gsize offset, gsize size);
 420
 421 /**
 422  * gst_buffer_is_writable:
 423  * @buf: a #GstBuffer
 424  *
 425  * Tests if you can safely write to a buffer's metadata or its memory array.
 426  * It is only safe to change buffer metadata when the current reference is
 427  * writable, i.e. nobody can see the modifications you will make.
 428  */
 429 #define         gst_buffer_is_writable(buf)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (buf))
 430 /**
 431  * gst_buffer_make_writable:
 432  * @buf: (transfer full): a #GstBuffer
 433  *
 434  * Makes a writable buffer from the given buffer. If the source buffer is
 435  * already writable, this will simply return the same buffer. A copy will
 436  * otherwise be made using gst_buffer_copy().
 437  *
 438  * Returns: (transfer full): a writable buffer which may or may not be the
 439  *     same as @buf
 440  */
 441 #define         gst_buffer_make_writable(buf)   GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (buf)))
 442
 443 /**
 444  * gst_buffer_replace:
 445  * @obuf: (inout) (transfer full): pointer to a pointer to a #GstBuffer to be
 446  *     replaced.
 447  * @nbuf: (transfer none) (allow-none): pointer to a #GstBuffer that will
 448  *     replace the buffer pointed to by @obuf.
 449  *
 450  * Modifies a pointer to a #GstBuffer to point to a different #GstBuffer. The
 451  * modification is done atomically (so this is useful for ensuring thread safety
 452  * in some cases), and the reference counts are updated appropriately (the old
 453  * buffer is unreffed, the new is reffed).
 454  *
 455  * Either @nbuf or the #GstBuffer pointed to by @obuf may be NULL.
 456  *
 457  * Returns: TRUE when @obuf was different from @nbuf.
 458  */
 459 #ifdef _FOOL_GTK_DOC_
 460 G_INLINE_FUNC gboolean gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf);
 461 #endif
 462
 463 static inline gboolean
 464 gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf)
 465 {
 466   return gst_mini_object_replace ((GstMiniObject **) obuf, (GstMiniObject *) nbuf);
 467 }
 468
 469 /* creating a region */
 470 GstBuffer*      gst_buffer_copy_region          (GstBuffer *parent, GstBufferCopyFlags flags,
 471                                                  gsize offset, gsize size);
 472
 473 /* append two buffers */
 474 GstBuffer*      gst_buffer_append_region        (GstBuffer *buf1, GstBuffer *buf2,
 475                                                  gssize offset, gssize size);
 476 GstBuffer*      gst_buffer_append               (GstBuffer *buf1, GstBuffer *buf2);
 477
 478 /* metadata */
 479 #include <gst/gstmeta.h>
 480
 481 /**
 482  * GstBufferForeachMetaFunc:
 483  * @buffer: a #GstBuffer
 484  * @meta: a pointer to a #GstMeta
 485  * @user_data: user data passed to gst_buffer_foreach_meta()
 486  *
 487  * A function that will be called from gst_buffer_foreach_meta(). The @meta
 488  * field will point to a the reference of the meta.
 489  *
 490  * @buffer should not be modified from this callback.
 491  *
 492  * When this function returns %TRUE, the next meta will be
 493  * returned. When %FALSE is returned, gst_buffer_foreach_meta() will return.
 494  *
 495  * When @meta is set to NULL, the item will be removed from the buffer.
 496  *
 497  * Returns: %FALSE when gst_buffer_foreach_meta() should stop
 498  */
 499 typedef gboolean (*GstBufferForeachMetaFunc)    (GstBuffer *buffer, GstMeta **meta,
 500                                                  gpointer user_data);
 501
 502 GstMeta *       gst_buffer_get_meta             (GstBuffer *buffer, GType api);
 503 GstMeta *       gst_buffer_add_meta             (GstBuffer *buffer, const GstMetaInfo *info,
 504                                                  gpointer params);
 505 gboolean        gst_buffer_remove_meta          (GstBuffer *buffer, GstMeta *meta);
 506
 507 GstMeta *       gst_buffer_iterate_meta         (GstBuffer *buffer, gpointer *state);
 508
 509 gboolean        gst_buffer_foreach_meta         (GstBuffer *buffer,
 510                                                  GstBufferForeachMetaFunc func,
 511                                                  gpointer user_data);
 512
 513 /**
 514  * gst_value_set_buffer:
 515  * @v: a #GValue to receive the data
 516  * @b: (transfer none): a #GstBuffer to assign to the GstValue
 517  *
 518  * Sets @b as the value of @v.  Caller retains reference to buffer.
 519  */
 520 #define         gst_value_set_buffer(v,b)       g_value_set_boxed((v),(b))
 521 /**
 522  * gst_value_take_buffer:
 523  * @v: a #GValue to receive the data
 524  * @b: (transfer full): a #GstBuffer to assign to the GstValue
 525  *
 526  * Sets @b as the value of @v.  Caller gives away reference to buffer.
 527  */
 528 #define         gst_value_take_buffer(v,b)      g_value_take_boxed(v,(b))
 529 /**
 530  * gst_value_get_buffer:
 531  * @v: a #GValue to query
 532  *
 533  * Receives a #GstBuffer as the value of @v. Does not return a reference to
 534  * the buffer, so the pointer is only valid for as long as the caller owns
 535  * a reference to @v.
 536  *
 537  * Returns: (transfer none): buffer
 538  */
 539 #define         gst_value_get_buffer(v)         GST_BUFFER_CAST (g_value_get_boxed(v))
 540
 541 G_END_DECLS
 542
 543 #endif /* __GST_BUFFER_H__ */