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