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