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