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., 51 Franklin St, Fifth Floor,
  20  * Boston, MA 02110-1301, 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 #GstBufferFlags 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 #GstBufferFlags flag 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 #GstBufferFlags flag 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 #GstBufferFlags flag 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_TAG_MEMORY:  this flag is set when memory of the buffer
 196  *                               is added/removed
 197  * @GST_BUFFER_FLAG_LAST:        additional media specific flags can be added starting from
 198  *                               this flag.
 199  *
 200  * A set of buffer flags used to describe properties of a #GstBuffer.
 201  */
 202 typedef enum {
 203   GST_BUFFER_FLAG_LIVE        = (GST_MINI_OBJECT_FLAG_LAST << 0),
 204   GST_BUFFER_FLAG_DECODE_ONLY = (GST_MINI_OBJECT_FLAG_LAST << 1),
 205   GST_BUFFER_FLAG_DISCONT     = (GST_MINI_OBJECT_FLAG_LAST << 2),
 206   GST_BUFFER_FLAG_RESYNC      = (GST_MINI_OBJECT_FLAG_LAST << 3),
 207   GST_BUFFER_FLAG_CORRUPTED   = (GST_MINI_OBJECT_FLAG_LAST << 4),
 208   GST_BUFFER_FLAG_MARKER      = (GST_MINI_OBJECT_FLAG_LAST << 5),
 209   GST_BUFFER_FLAG_HEADER      = (GST_MINI_OBJECT_FLAG_LAST << 6),
 210   GST_BUFFER_FLAG_GAP         = (GST_MINI_OBJECT_FLAG_LAST << 7),
 211   GST_BUFFER_FLAG_DROPPABLE   = (GST_MINI_OBJECT_FLAG_LAST << 8),
 212   GST_BUFFER_FLAG_DELTA_UNIT  = (GST_MINI_OBJECT_FLAG_LAST << 9),
 213   GST_BUFFER_FLAG_TAG_MEMORY  = (GST_MINI_OBJECT_FLAG_LAST << 10),
 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 guint       gst_buffer_get_max_memory      (void);
 260
 261 /* allocation */
 262 GstBuffer * gst_buffer_new                 (void);
 263 GstBuffer * gst_buffer_new_allocate        (GstAllocator * allocator, gsize size,
 264                                             GstAllocationParams * params);
 265 GstBuffer * gst_buffer_new_wrapped_full    (GstMemoryFlags flags, gpointer data, gsize maxsize,
 266                                             gsize offset, gsize size, gpointer user_data,
 267                                             GDestroyNotify notify);
 268 GstBuffer * gst_buffer_new_wrapped         (gpointer data, gsize size);
 269
 270 /* memory blocks */
 271 guint       gst_buffer_n_memory             (GstBuffer *buffer);
 272 void        gst_buffer_insert_memory        (GstBuffer *buffer, gint idx, GstMemory *mem);
 273 void        gst_buffer_replace_memory_range (GstBuffer *buffer, guint idx, gint length, GstMemory *mem);
 274 GstMemory * gst_buffer_peek_memory          (GstBuffer *buffer, guint idx);
 275 GstMemory * gst_buffer_get_memory_range     (GstBuffer *buffer, guint idx, gint length);
 276 void        gst_buffer_remove_memory_range  (GstBuffer *buffer, guint idx, gint length);
 277
 278 void        gst_buffer_prepend_memory       (GstBuffer *buffer, GstMemory *mem);
 279 void        gst_buffer_append_memory        (GstBuffer *buffer, GstMemory *mem);
 280 void        gst_buffer_replace_memory       (GstBuffer *buffer, guint idx, GstMemory *mem);
 281 void        gst_buffer_replace_all_memory   (GstBuffer *buffer, GstMemory *mem);
 282 GstMemory * gst_buffer_get_memory           (GstBuffer *buffer, guint idx);
 283 GstMemory * gst_buffer_get_all_memory       (GstBuffer *buffer);
 284 void        gst_buffer_remove_memory        (GstBuffer *buffer, guint idx);
 285 void        gst_buffer_remove_all_memory    (GstBuffer *buffer);
 286
 287 gboolean    gst_buffer_find_memory         (GstBuffer *buffer, gsize offset, gsize size,
 288                                             guint *idx, guint *length, gsize *skip);
 289
 290 gboolean    gst_buffer_is_memory_range_writable  (GstBuffer *buffer, guint idx, gint length);
 291 gboolean    gst_buffer_is_all_memory_writable    (GstBuffer *buffer);
 292
 293 gsize       gst_buffer_fill                (GstBuffer *buffer, gsize offset,
 294                                             gconstpointer src, gsize size);
 295 gsize       gst_buffer_extract             (GstBuffer *buffer, gsize offset,
 296                                             gpointer dest, gsize size);
 297 gint        gst_buffer_memcmp              (GstBuffer *buffer, gsize offset,
 298                                             gconstpointer mem, gsize size);
 299 gsize       gst_buffer_memset              (GstBuffer *buffer, gsize offset,
 300                                             guint8 val, gsize size);
 301
 302 gsize       gst_buffer_get_sizes_range     (GstBuffer *buffer, guint idx, gint length,
 303                                             gsize *offset, gsize *maxsize);
 304 gboolean    gst_buffer_resize_range        (GstBuffer *buffer, guint idx, gint length,
 305                                             gssize offset, gssize size);
 306
 307 gsize       gst_buffer_get_sizes           (GstBuffer *buffer, gsize *offset, gsize *maxsize);
 308 gsize       gst_buffer_get_size            (GstBuffer *buffer);
 309 void        gst_buffer_resize              (GstBuffer *buffer, gssize offset, gssize size);
 310 void        gst_buffer_set_size            (GstBuffer *buffer, gssize size);
 311
 312 gboolean    gst_buffer_map_range           (GstBuffer *buffer, guint idx, gint length,
 313                                             GstMapInfo *info, GstMapFlags flags);
 314 gboolean    gst_buffer_map                 (GstBuffer *buffer, GstMapInfo *info, GstMapFlags flags);
 315
 316 void        gst_buffer_unmap               (GstBuffer *buffer, GstMapInfo *info);
 317 void        gst_buffer_extract_dup         (GstBuffer *buffer, gsize offset,
 318                                             gsize size, gpointer *dest,
 319                                             gsize *dest_size);
 320
 321 /* refcounting */
 322 /**
 323  * gst_buffer_ref:
 324  * @buf: a #GstBuffer.
 325  *
 326  * Increases the refcount of the given buffer by one.
 327  *
 328  * Note that the refcount affects the writability
 329  * of @buf and its metadata, see gst_buffer_is_writable().
 330  * It is important to note that keeping additional references to
 331  * GstBuffer instances can potentially increase the number
 332  * of memcpy operations in a pipeline.
 333  *
 334  * Returns: (transfer full): @buf
 335  */
 336 #ifdef _FOOL_GTK_DOC_
 337 G_INLINE_FUNC GstBuffer * gst_buffer_ref (GstBuffer * buf);
 338 #endif
 339
 340 static inline GstBuffer *
 341 gst_buffer_ref (GstBuffer * buf)
 342 {
 343   return (GstBuffer *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (buf));
 344 }
 345
 346 /**
 347  * gst_buffer_unref:
 348  * @buf: (transfer full): a #GstBuffer.
 349  *
 350  * Decreases the refcount of the buffer. If the refcount reaches 0, the buffer
 351  * with the associated metadata and memory will be freed.
 352  */
 353 #ifdef _FOOL_GTK_DOC_
 354 G_INLINE_FUNC void gst_buffer_unref (GstBuffer * buf);
 355 #endif
 356
 357 static inline void
 358 gst_buffer_unref (GstBuffer * buf)
 359 {
 360   gst_mini_object_unref (GST_MINI_OBJECT_CAST (buf));
 361 }
 362
 363 /* copy buffer */
 364 /**
 365  * gst_buffer_copy:
 366  * @buf: a #GstBuffer.
 367  *
 368  * Create a copy of the given buffer. This will also make a newly allocated
 369  * copy of the data the source buffer contains.
 370  *
 371  * Returns: (transfer full): a new copy of @buf.
 372  */
 373 #ifdef _FOOL_GTK_DOC_
 374 G_INLINE_FUNC GstBuffer * gst_buffer_copy (const GstBuffer * buf);
 375 #endif
 376
 377 static inline GstBuffer *
 378 gst_buffer_copy (const GstBuffer * buf)
 379 {
 380   return GST_BUFFER (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (buf)));
 381 }
 382
 383
 384 /**
 385  * GstBufferCopyFlags:
 386  * @GST_BUFFER_COPY_NONE: copy nothing
 387  * @GST_BUFFER_COPY_FLAGS: flag indicating that buffer flags should be copied
 388  * @GST_BUFFER_COPY_TIMESTAMPS: flag indicating that buffer pts, dts,
 389  *   duration, offset and offset_end should be copied
 390  * @GST_BUFFER_COPY_MEMORY: flag indicating that buffer memory should be reffed
 391  *   and appended to already existing memory. Unless the memory is marked as
 392  *   NO_SHARE, no actual copy of the memory is made but it is simply reffed.
 393  *   Add @GST_BUFFER_COPY_DEEP to force a real copy.
 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  * @GST_BUFFER_COPY_DEEP: flag indicating that memory should always be
 399  *   copied instead of reffed (Since 1.2)
 400  *
 401  * A set of flags that can be provided to the gst_buffer_copy_into()
 402  * function to specify which items should be copied.
 403  */
 404 typedef enum {
 405   GST_BUFFER_COPY_NONE           = 0,
 406   GST_BUFFER_COPY_FLAGS          = (1 << 0),
 407   GST_BUFFER_COPY_TIMESTAMPS     = (1 << 1),
 408   GST_BUFFER_COPY_META           = (1 << 2),
 409   GST_BUFFER_COPY_MEMORY         = (1 << 3),
 410   GST_BUFFER_COPY_MERGE          = (1 << 4),
 411   GST_BUFFER_COPY_DEEP           = (1 << 5)
 412 } GstBufferCopyFlags;
 413
 414 /**
 415  * GST_BUFFER_COPY_METADATA:
 416  *
 417  * Combination of all possible metadata fields that can be copied with
 418  * gst_buffer_copy_into().
 419  */
 420 #define GST_BUFFER_COPY_METADATA       (GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS |\
 421                                         GST_BUFFER_COPY_META)
 422
 423 /**
 424  * GST_BUFFER_COPY_ALL:
 425  *
 426  * Combination of all possible fields that can be copied with
 427  * gst_buffer_copy_into().
 428  */
 429 #define GST_BUFFER_COPY_ALL  ((GstBufferCopyFlags)(GST_BUFFER_COPY_METADATA | GST_BUFFER_COPY_MEMORY))
 430
 431 /* copies memory or metadata into newly allocated buffer */
 432 gboolean        gst_buffer_copy_into            (GstBuffer *dest, GstBuffer *src,
 433                                                  GstBufferCopyFlags flags,
 434                                                  gsize offset, gsize size);
 435
 436 /**
 437  * gst_buffer_is_writable:
 438  * @buf: a #GstBuffer
 439  *
 440  * Tests if you can safely write to a buffer's metadata or its memory array.
 441  * It is only safe to change buffer metadata when the current reference is
 442  * writable, i.e. nobody can see the modifications you will make.
 443  */
 444 #define         gst_buffer_is_writable(buf)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (buf))
 445 /**
 446  * gst_buffer_make_writable:
 447  * @buf: (transfer full): a #GstBuffer
 448  *
 449  * Makes a writable buffer from the given buffer. If the source buffer is
 450  * already writable, this will simply return the same buffer. A copy will
 451  * otherwise be made using gst_buffer_copy().
 452  *
 453  * Returns: (transfer full): a writable buffer which may or may not be the
 454  *     same as @buf
 455  */
 456 #define         gst_buffer_make_writable(buf)   GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (buf)))
 457
 458 /**
 459  * gst_buffer_replace:
 460  * @obuf: (inout) (transfer full): pointer to a pointer to a #GstBuffer to be
 461  *     replaced.
 462  * @nbuf: (transfer none) (allow-none): pointer to a #GstBuffer that will
 463  *     replace the buffer pointed to by @obuf.
 464  *
 465  * Modifies a pointer to a #GstBuffer to point to a different #GstBuffer. The
 466  * modification is done atomically (so this is useful for ensuring thread safety
 467  * in some cases), and the reference counts are updated appropriately (the old
 468  * buffer is unreffed, the new is reffed).
 469  *
 470  * Either @nbuf or the #GstBuffer pointed to by @obuf may be %NULL.
 471  *
 472  * Returns: %TRUE when @obuf was different from @nbuf.
 473  */
 474 #ifdef _FOOL_GTK_DOC_
 475 G_INLINE_FUNC gboolean gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf);
 476 #endif
 477
 478 static inline gboolean
 479 gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf)
 480 {
 481   return gst_mini_object_replace ((GstMiniObject **) obuf, (GstMiniObject *) nbuf);
 482 }
 483
 484 /* creating a region */
 485 GstBuffer*      gst_buffer_copy_region          (GstBuffer *parent, GstBufferCopyFlags flags,
 486                                                  gsize offset, gsize size);
 487
 488 /* append two buffers */
 489 GstBuffer*      gst_buffer_append_region        (GstBuffer *buf1, GstBuffer *buf2,
 490                                                  gssize offset, gssize size);
 491 GstBuffer*      gst_buffer_append               (GstBuffer *buf1, GstBuffer *buf2);
 492
 493 /* metadata */
 494 #include <gst/gstmeta.h>
 495
 496 /**
 497  * GstBufferForeachMetaFunc:
 498  * @buffer: a #GstBuffer
 499  * @meta: a pointer to a #GstMeta
 500  * @user_data: user data passed to gst_buffer_foreach_meta()
 501  *
 502  * A function that will be called from gst_buffer_foreach_meta(). The @meta
 503  * field will point to a the reference of the meta.
 504  *
 505  * @buffer should not be modified from this callback.
 506  *
 507  * When this function returns %TRUE, the next meta will be
 508  * returned. When %FALSE is returned, gst_buffer_foreach_meta() will return.
 509  *
 510  * When @meta is set to %NULL, the item will be removed from the buffer.
 511  *
 512  * Returns: %FALSE when gst_buffer_foreach_meta() should stop
 513  */
 514 typedef gboolean (*GstBufferForeachMetaFunc)    (GstBuffer *buffer, GstMeta **meta,
 515                                                  gpointer user_data);
 516
 517 GstMeta *       gst_buffer_get_meta             (GstBuffer *buffer, GType api);
 518 GstMeta *       gst_buffer_add_meta             (GstBuffer *buffer, const GstMetaInfo *info,
 519                                                  gpointer params);
 520 gboolean        gst_buffer_remove_meta          (GstBuffer *buffer, GstMeta *meta);
 521
 522 GstMeta *       gst_buffer_iterate_meta         (GstBuffer *buffer, gpointer *state);
 523
 524 gboolean        gst_buffer_foreach_meta         (GstBuffer *buffer,
 525                                                  GstBufferForeachMetaFunc func,
 526                                                  gpointer user_data);
 527
 528 /**
 529  * gst_value_set_buffer:
 530  * @v: a #GValue to receive the data
 531  * @b: (transfer none): a #GstBuffer to assign to the GstValue
 532  *
 533  * Sets @b as the value of @v.  Caller retains reference to buffer.
 534  */
 535 #define         gst_value_set_buffer(v,b)       g_value_set_boxed((v),(b))
 536 /**
 537  * gst_value_take_buffer:
 538  * @v: a #GValue to receive the data
 539  * @b: (transfer full): a #GstBuffer to assign to the GstValue
 540  *
 541  * Sets @b as the value of @v.  Caller gives away reference to buffer.
 542  */
 543 #define         gst_value_take_buffer(v,b)      g_value_take_boxed(v,(b))
 544 /**
 545  * gst_value_get_buffer:
 546  * @v: a #GValue to query
 547  *
 548  * Receives a #GstBuffer as the value of @v. Does not return a reference to
 549  * the buffer, so the pointer is only valid for as long as the caller owns
 550  * a reference to @v.
 551  *
 552  * Returns: (transfer none): buffer
 553  */
 554 #define         gst_value_get_buffer(v)         GST_BUFFER_CAST (g_value_get_boxed(v))
 555
 556 G_END_DECLS
 557
 558 #endif /* __GST_BUFFER_H__ */