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_DTS_OR_PTS:
  98  * @buf: a #GstBuffer.:
  99  *
 100  * Returns the buffer decoding timestamp (dts) if valid, else the buffer
 101  * presentation time (pts)
 102  */
 103 #define GST_BUFFER_DTS_OR_PTS(buf)              (GST_BUFFER_DTS_IS_VALID(buf) ? GST_BUFFER_DTS(buf) : GST_BUFFER_PTS (buf))
 104 /**
 105  * GST_BUFFER_DURATION:
 106  * @buf: a #GstBuffer.
 107  *
 108  * The duration in nanoseconds (as a #GstClockTime) of the data in the buffer.
 109  * Value will be %GST_CLOCK_TIME_NONE if the duration is unknown.
 110  */
 111 #define GST_BUFFER_DURATION(buf)                (GST_BUFFER_CAST(buf)->duration)
 112 /**
 113  * GST_BUFFER_OFFSET:
 114  * @buf: a #GstBuffer.
 115  *
 116  * The offset in the source file of the beginning of this buffer.
 117  */
 118 #define GST_BUFFER_OFFSET(buf)                  (GST_BUFFER_CAST(buf)->offset)
 119 /**
 120  * GST_BUFFER_OFFSET_END:
 121  * @buf: a #GstBuffer.
 122  *
 123  * The offset in the source file of the end of this buffer.
 124  */
 125 #define GST_BUFFER_OFFSET_END(buf)              (GST_BUFFER_CAST(buf)->offset_end)
 126
 127 /**
 128  * GST_BUFFER_OFFSET_NONE:
 129  *
 130  * Constant for no-offset return results.
 131  */
 132 #define GST_BUFFER_OFFSET_NONE  ((guint64)-1)
 133
 134 /**
 135  * GST_BUFFER_DURATION_IS_VALID:
 136  * @buffer: a #GstBuffer
 137  *
 138  * Tests if the duration is known.
 139  */
 140 #define GST_BUFFER_DURATION_IS_VALID(buffer)    (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DURATION (buffer)))
 141 /**
 142  * GST_BUFFER_PTS_IS_VALID:
 143  * @buffer: a #GstBuffer
 144  *
 145  * Tests if the pts is known.
 146  */
 147 #define GST_BUFFER_PTS_IS_VALID(buffer)   (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_PTS (buffer)))
 148 /**
 149  * GST_BUFFER_DTS_IS_VALID:
 150  * @buffer: a #GstBuffer
 151  *
 152  * Tests if the dts is known.
 153  */
 154 #define GST_BUFFER_DTS_IS_VALID(buffer)   (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DTS (buffer)))
 155 /**
 156  * GST_BUFFER_OFFSET_IS_VALID:
 157  * @buffer: a #GstBuffer
 158  *
 159  * Tests if the start offset is known.
 160  */
 161 #define GST_BUFFER_OFFSET_IS_VALID(buffer)      (GST_BUFFER_OFFSET (buffer) != GST_BUFFER_OFFSET_NONE)
 162 /**
 163  * GST_BUFFER_OFFSET_END_IS_VALID:
 164  * @buffer: a #GstBuffer
 165  *
 166  * Tests if the end offset is known.
 167  */
 168 #define GST_BUFFER_OFFSET_END_IS_VALID(buffer)  (GST_BUFFER_OFFSET_END (buffer) != GST_BUFFER_OFFSET_NONE)
 169 /**
 170  * GST_BUFFER_IS_DISCONT:
 171  * @buffer: a #GstBuffer
 172  *
 173  * Tests if the buffer marks a discontinuity in the stream.
 174  */
 175 #define GST_BUFFER_IS_DISCONT(buffer)   (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DISCONT))
 176
 177 /**
 178  * GstBufferFlags:
 179  * @GST_BUFFER_FLAG_LIVE:        the buffer is live data and should be discarded in
 180  *                               the PAUSED state.
 181  * @GST_BUFFER_FLAG_DECODE_ONLY: the buffer contains data that should be dropped
 182  *                               because it will be clipped against the segment
 183  *                               boundaries or because it does not contain data
 184  *                               that should be shown to the user.
 185  * @GST_BUFFER_FLAG_DISCONT:     the buffer marks a data discontinuity in the stream.
 186  *                               This typically occurs after a seek or a dropped buffer
 187  *                               from a live or network source.
 188  * @GST_BUFFER_FLAG_RESYNC:      the buffer timestamps might have a discontinuity
 189  *                               and this buffer is a good point to resynchronize.
 190  * @GST_BUFFER_FLAG_CORRUPTED:   the buffer data is corrupted.
 191  * @GST_BUFFER_FLAG_MARKER:      the buffer contains a media specific marker. for
 192  *                               video this is typically the end of a frame boundary, for audio
 193  *                               this is usually the start of a talkspurt.
 194  * @GST_BUFFER_FLAG_HEADER:      the buffer contains header information that is
 195  *                               needed to decode the following data.
 196  * @GST_BUFFER_FLAG_GAP:         the buffer has been created to fill a gap in the
 197  *                               stream and contains media neutral data (elements can
 198  *                               switch to optimized code path that ignores the buffer
 199  *                               content).
 200  * @GST_BUFFER_FLAG_DROPPABLE:   the buffer can be dropped without breaking the
 201  *                               stream, for example to reduce bandwidth.
 202  * @GST_BUFFER_FLAG_DELTA_UNIT:  this unit cannot be decoded independently.
 203  * @GST_BUFFER_FLAG_TAG_MEMORY:  this flag is set when memory of the buffer
 204  *                               is added/removed
 205  * @GST_BUFFER_FLAG_SYNC_AFTER:  Elements which write to disk or permanent
 206  *                               storage should ensure the data is synced after
 207  *                               writing the contents of this buffer. (Since 1.6)
 208  * @GST_BUFFER_FLAG_LAST:        additional media specific flags can be added starting from
 209  *                               this flag.
 210  *
 211  * A set of buffer flags used to describe properties of a #GstBuffer.
 212  */
 213 typedef enum {
 214   GST_BUFFER_FLAG_LIVE        = (GST_MINI_OBJECT_FLAG_LAST << 0),
 215   GST_BUFFER_FLAG_DECODE_ONLY = (GST_MINI_OBJECT_FLAG_LAST << 1),
 216   GST_BUFFER_FLAG_DISCONT     = (GST_MINI_OBJECT_FLAG_LAST << 2),
 217   GST_BUFFER_FLAG_RESYNC      = (GST_MINI_OBJECT_FLAG_LAST << 3),
 218   GST_BUFFER_FLAG_CORRUPTED   = (GST_MINI_OBJECT_FLAG_LAST << 4),
 219   GST_BUFFER_FLAG_MARKER      = (GST_MINI_OBJECT_FLAG_LAST << 5),
 220   GST_BUFFER_FLAG_HEADER      = (GST_MINI_OBJECT_FLAG_LAST << 6),
 221   GST_BUFFER_FLAG_GAP         = (GST_MINI_OBJECT_FLAG_LAST << 7),
 222   GST_BUFFER_FLAG_DROPPABLE   = (GST_MINI_OBJECT_FLAG_LAST << 8),
 223   GST_BUFFER_FLAG_DELTA_UNIT  = (GST_MINI_OBJECT_FLAG_LAST << 9),
 224   GST_BUFFER_FLAG_TAG_MEMORY  = (GST_MINI_OBJECT_FLAG_LAST << 10),
 225   GST_BUFFER_FLAG_SYNC_AFTER  = (GST_MINI_OBJECT_FLAG_LAST << 11),
 226
 227   GST_BUFFER_FLAG_LAST        = (GST_MINI_OBJECT_FLAG_LAST << 16)
 228 } GstBufferFlags;
 229
 230 /**
 231  * GstBuffer:
 232  * @mini_object: the parent structure
 233  * @pool: pointer to the pool owner of the buffer
 234  * @pts: presentation timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
 235  *     pts is not known or relevant. The pts contains the timestamp when the
 236  *     media should be presented to the user.
 237  * @dts: decoding timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
 238  *     dts is not known or relevant. The dts contains the timestamp when the
 239  *     media should be processed.
 240  * @duration: duration in time of the buffer data, can be #GST_CLOCK_TIME_NONE
 241  *     when the duration is not known or relevant.
 242  * @offset: a media specific offset for the buffer data.
 243  *     For video frames, this is the frame number of this buffer.
 244  *     For audio samples, this is the offset of the first sample in this buffer.
 245  *     For file data or compressed data this is the byte offset of the first
 246  *       byte in this buffer.
 247  * @offset_end: the last offset contained in this buffer. It has the same
 248  *     format as @offset.
 249  *
 250  * The structure of a #GstBuffer. Use the associated macros to access the public
 251  * variables.
 252  */
 253 struct _GstBuffer {
 254   GstMiniObject          mini_object;
 255
 256   /*< public >*/ /* with COW */
 257   GstBufferPool         *pool;
 258
 259   /* timestamp */
 260   GstClockTime           pts;
 261   GstClockTime           dts;
 262   GstClockTime           duration;
 263
 264   /* media specific offset */
 265   guint64                offset;
 266   guint64                offset_end;
 267 };
 268
 269 GType       gst_buffer_get_type            (void);
 270
 271 guint       gst_buffer_get_max_memory      (void);
 272
 273 /* allocation */
 274 GstBuffer * gst_buffer_new                 (void);
 275 GstBuffer * gst_buffer_new_allocate        (GstAllocator * allocator, gsize size,
 276                                             GstAllocationParams * params);
 277 GstBuffer * gst_buffer_new_wrapped_full    (GstMemoryFlags flags, gpointer data, gsize maxsize,
 278                                             gsize offset, gsize size, gpointer user_data,
 279                                             GDestroyNotify notify);
 280 GstBuffer * gst_buffer_new_wrapped         (gpointer data, gsize size);
 281
 282 /* memory blocks */
 283 guint       gst_buffer_n_memory             (GstBuffer *buffer);
 284 void        gst_buffer_insert_memory        (GstBuffer *buffer, gint idx, GstMemory *mem);
 285 void        gst_buffer_replace_memory_range (GstBuffer *buffer, guint idx, gint length, GstMemory *mem);
 286 GstMemory * gst_buffer_peek_memory          (GstBuffer *buffer, guint idx);
 287 GstMemory * gst_buffer_get_memory_range     (GstBuffer *buffer, guint idx, gint length);
 288 void        gst_buffer_remove_memory_range  (GstBuffer *buffer, guint idx, gint length);
 289
 290 void        gst_buffer_prepend_memory       (GstBuffer *buffer, GstMemory *mem);
 291 void        gst_buffer_append_memory        (GstBuffer *buffer, GstMemory *mem);
 292 void        gst_buffer_replace_memory       (GstBuffer *buffer, guint idx, GstMemory *mem);
 293 void        gst_buffer_replace_all_memory   (GstBuffer *buffer, GstMemory *mem);
 294 GstMemory * gst_buffer_get_memory           (GstBuffer *buffer, guint idx);
 295 GstMemory * gst_buffer_get_all_memory       (GstBuffer *buffer);
 296 void        gst_buffer_remove_memory        (GstBuffer *buffer, guint idx);
 297 void        gst_buffer_remove_all_memory    (GstBuffer *buffer);
 298
 299 gboolean    gst_buffer_find_memory         (GstBuffer *buffer, gsize offset, gsize size,
 300                                             guint *idx, guint *length, gsize *skip);
 301
 302 gboolean    gst_buffer_is_memory_range_writable  (GstBuffer *buffer, guint idx, gint length);
 303 gboolean    gst_buffer_is_all_memory_writable    (GstBuffer *buffer);
 304
 305 gsize       gst_buffer_fill                (GstBuffer *buffer, gsize offset,
 306                                             gconstpointer src, gsize size);
 307 gsize       gst_buffer_extract             (GstBuffer *buffer, gsize offset,
 308                                             gpointer dest, gsize size);
 309 gint        gst_buffer_memcmp              (GstBuffer *buffer, gsize offset,
 310                                             gconstpointer mem, gsize size);
 311 gsize       gst_buffer_memset              (GstBuffer *buffer, gsize offset,
 312                                             guint8 val, gsize size);
 313
 314 gsize       gst_buffer_get_sizes_range     (GstBuffer *buffer, guint idx, gint length,
 315                                             gsize *offset, gsize *maxsize);
 316 gboolean    gst_buffer_resize_range        (GstBuffer *buffer, guint idx, gint length,
 317                                             gssize offset, gssize size);
 318
 319 gsize       gst_buffer_get_sizes           (GstBuffer *buffer, gsize *offset, gsize *maxsize);
 320 gsize       gst_buffer_get_size            (GstBuffer *buffer);
 321 void        gst_buffer_resize              (GstBuffer *buffer, gssize offset, gssize size);
 322 void        gst_buffer_set_size            (GstBuffer *buffer, gssize size);
 323
 324 gboolean    gst_buffer_map_range           (GstBuffer *buffer, guint idx, gint length,
 325                                             GstMapInfo *info, GstMapFlags flags);
 326 gboolean    gst_buffer_map                 (GstBuffer *buffer, GstMapInfo *info, GstMapFlags flags);
 327
 328 void        gst_buffer_unmap               (GstBuffer *buffer, GstMapInfo *info);
 329 void        gst_buffer_extract_dup         (GstBuffer *buffer, gsize offset,
 330                                             gsize size, gpointer *dest,
 331                                             gsize *dest_size);
 332
 333 /* refcounting */
 334 /**
 335  * gst_buffer_ref:
 336  * @buf: a #GstBuffer.
 337  *
 338  * Increases the refcount of the given buffer by one.
 339  *
 340  * Note that the refcount affects the writability
 341  * of @buf and its metadata, see gst_buffer_is_writable().
 342  * It is important to note that keeping additional references to
 343  * GstBuffer instances can potentially increase the number
 344  * of memcpy operations in a pipeline.
 345  *
 346  * Returns: (transfer full): @buf
 347  */
 348 #ifdef _FOOL_GTK_DOC_
 349 G_INLINE_FUNC GstBuffer * gst_buffer_ref (GstBuffer * buf);
 350 #endif
 351
 352 static inline GstBuffer *
 353 gst_buffer_ref (GstBuffer * buf)
 354 {
 355   return (GstBuffer *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (buf));
 356 }
 357
 358 /**
 359  * gst_buffer_unref:
 360  * @buf: (transfer full): a #GstBuffer.
 361  *
 362  * Decreases the refcount of the buffer. If the refcount reaches 0, the buffer
 363  * with the associated metadata and memory will be freed.
 364  */
 365 #ifdef _FOOL_GTK_DOC_
 366 G_INLINE_FUNC void gst_buffer_unref (GstBuffer * buf);
 367 #endif
 368
 369 static inline void
 370 gst_buffer_unref (GstBuffer * buf)
 371 {
 372   gst_mini_object_unref (GST_MINI_OBJECT_CAST (buf));
 373 }
 374
 375 /* copy buffer */
 376 /**
 377  * gst_buffer_copy:
 378  * @buf: a #GstBuffer.
 379  *
 380  * Create a copy of the given buffer. This will only copy the buffer's
 381  * data to a newly allocated memory if needed (if the type of memory
 382  * requires it), otherwise the underlying data is just referenced.
 383  * Check gst_buffer_copy_deep() if you want to force the data
 384  * to be copied to newly allocated memory.
 385  *
 386  * Returns: (transfer full): a new copy of @buf.
 387  */
 388 #ifdef _FOOL_GTK_DOC_
 389 G_INLINE_FUNC GstBuffer * gst_buffer_copy (const GstBuffer * buf);
 390 #endif
 391
 392 static inline GstBuffer *
 393 gst_buffer_copy (const GstBuffer * buf)
 394 {
 395   return GST_BUFFER (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (buf)));
 396 }
 397
 398 GstBuffer * gst_buffer_copy_deep (const GstBuffer * buf);
 399
 400 /**
 401  * GstBufferCopyFlags:
 402  * @GST_BUFFER_COPY_NONE: copy nothing
 403  * @GST_BUFFER_COPY_FLAGS: flag indicating that buffer flags should be copied
 404  * @GST_BUFFER_COPY_TIMESTAMPS: flag indicating that buffer pts, dts,
 405  *   duration, offset and offset_end should be copied
 406  * @GST_BUFFER_COPY_MEMORY: flag indicating that buffer memory should be reffed
 407  *   and appended to already existing memory. Unless the memory is marked as
 408  *   NO_SHARE, no actual copy of the memory is made but it is simply reffed.
 409  *   Add @GST_BUFFER_COPY_DEEP to force a real copy.
 410  * @GST_BUFFER_COPY_MERGE: flag indicating that buffer memory should be
 411  *   merged
 412  * @GST_BUFFER_COPY_META: flag indicating that buffer meta should be
 413  *   copied
 414  * @GST_BUFFER_COPY_DEEP: flag indicating that memory should always be
 415  *   copied instead of reffed (Since 1.2)
 416  *
 417  * A set of flags that can be provided to the gst_buffer_copy_into()
 418  * function to specify which items should be copied.
 419  */
 420 typedef enum {
 421   GST_BUFFER_COPY_NONE           = 0,
 422   GST_BUFFER_COPY_FLAGS          = (1 << 0),
 423   GST_BUFFER_COPY_TIMESTAMPS     = (1 << 1),
 424   GST_BUFFER_COPY_META           = (1 << 2),
 425   GST_BUFFER_COPY_MEMORY         = (1 << 3),
 426   GST_BUFFER_COPY_MERGE          = (1 << 4),
 427   GST_BUFFER_COPY_DEEP           = (1 << 5)
 428 } GstBufferCopyFlags;
 429
 430 /**
 431  * GST_BUFFER_COPY_METADATA:
 432  *
 433  * Combination of all possible metadata fields that can be copied with
 434  * gst_buffer_copy_into().
 435  */
 436 #define GST_BUFFER_COPY_METADATA       (GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS |\
 437                                         GST_BUFFER_COPY_META)
 438
 439 /**
 440  * GST_BUFFER_COPY_ALL:
 441  *
 442  * Combination of all possible fields that can be copied with
 443  * gst_buffer_copy_into().
 444  */
 445 #define GST_BUFFER_COPY_ALL  ((GstBufferCopyFlags)(GST_BUFFER_COPY_METADATA | GST_BUFFER_COPY_MEMORY))
 446
 447 /* copies memory or metadata into newly allocated buffer */
 448 gboolean        gst_buffer_copy_into            (GstBuffer *dest, GstBuffer *src,
 449                                                  GstBufferCopyFlags flags,
 450                                                  gsize offset, gsize size);
 451
 452 /**
 453  * gst_buffer_is_writable:
 454  * @buf: a #GstBuffer
 455  *
 456  * Tests if you can safely write to a buffer's metadata or its memory array.
 457  * It is only safe to change buffer metadata when the current reference is
 458  * writable, i.e. nobody can see the modifications you will make.
 459  */
 460 #define         gst_buffer_is_writable(buf)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (buf))
 461 /**
 462  * gst_buffer_make_writable:
 463  * @buf: (transfer full): a #GstBuffer
 464  *
 465  * Returns a writable copy of @buf. If the source buffer is
 466  * already writable, this will simply return the same buffer.
 467  *
 468  * Use this function to ensure that a buffer can be safely modified before
 469  * making changes to it, including changing the metadata such as PTS/DTS.
 470  *
 471  * If the reference count of the source buffer @buf is exactly one, the caller
 472  * is the sole owner and this function will return the buffer object unchanged.
 473  *
 474  * If there is more than one reference on the object, a copy will be made using
 475  * gst_buffer_copy(). The passed-in @buf will be unreffed in that case, and the
 476  * caller will now own a reference to the new returned buffer object. Note
 477  * that this just copies the buffer structure itself, the underlying memory is
 478  * not copied if it can be shared amongst multiple buffers.
 479  *
 480  * In short, this function unrefs the buf in the argument and refs the buffer
 481  * that it returns. Don't access the argument after calling this function unless
 482  * you have an additional reference to it.
 483  *
 484  * Returns: (transfer full): a writable buffer which may or may not be the
 485  *     same as @buf
 486  */
 487 #define         gst_buffer_make_writable(buf)   GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (buf)))
 488
 489 /**
 490  * gst_buffer_replace:
 491  * @obuf: (inout) (transfer full) (nullable): pointer to a pointer to
 492  *     a #GstBuffer to be replaced.
 493  * @nbuf: (transfer none) (allow-none): pointer to a #GstBuffer that will
 494  *     replace the buffer pointed to by @obuf.
 495  *
 496  * Modifies a pointer to a #GstBuffer to point to a different #GstBuffer. The
 497  * modification is done atomically (so this is useful for ensuring thread safety
 498  * in some cases), and the reference counts are updated appropriately (the old
 499  * buffer is unreffed, the new is reffed).
 500  *
 501  * Either @nbuf or the #GstBuffer pointed to by @obuf may be %NULL.
 502  *
 503  * Returns: %TRUE when @obuf was different from @nbuf.
 504  */
 505 #ifdef _FOOL_GTK_DOC_
 506 G_INLINE_FUNC gboolean gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf);
 507 #endif
 508
 509 static inline gboolean
 510 gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf)
 511 {
 512   return gst_mini_object_replace ((GstMiniObject **) obuf, (GstMiniObject *) nbuf);
 513 }
 514
 515 /* creating a region */
 516 GstBuffer*      gst_buffer_copy_region          (GstBuffer *parent, GstBufferCopyFlags flags,
 517                                                  gsize offset, gsize size);
 518
 519 /* append two buffers */
 520 GstBuffer*      gst_buffer_append_region        (GstBuffer *buf1, GstBuffer *buf2,
 521                                                  gssize offset, gssize size);
 522 GstBuffer*      gst_buffer_append               (GstBuffer *buf1, GstBuffer *buf2);
 523
 524 /* metadata */
 525 #include <gst/gstmeta.h>
 526
 527 /**
 528  * GstBufferForeachMetaFunc:
 529  * @buffer: a #GstBuffer
 530  * @meta: (out) (nullable): a pointer to a #GstMeta
 531  * @user_data: user data passed to gst_buffer_foreach_meta()
 532  *
 533  * A function that will be called from gst_buffer_foreach_meta(). The @meta
 534  * field will point to a the reference of the meta.
 535  *
 536  * @buffer should not be modified from this callback.
 537  *
 538  * When this function returns %TRUE, the next meta will be
 539  * returned. When %FALSE is returned, gst_buffer_foreach_meta() will return.
 540  *
 541  * When @meta is set to %NULL, the item will be removed from the buffer.
 542  *
 543  * Returns: %FALSE when gst_buffer_foreach_meta() should stop
 544  */
 545 typedef gboolean (*GstBufferForeachMetaFunc)    (GstBuffer *buffer, GstMeta **meta,
 546                                                  gpointer user_data);
 547
 548 GstMeta *       gst_buffer_get_meta             (GstBuffer *buffer, GType api);
 549 GstMeta *       gst_buffer_add_meta             (GstBuffer *buffer, const GstMetaInfo *info,
 550                                                  gpointer params);
 551 gboolean        gst_buffer_remove_meta          (GstBuffer *buffer, GstMeta *meta);
 552
 553 GstMeta *       gst_buffer_iterate_meta         (GstBuffer *buffer, gpointer *state);
 554
 555 gboolean        gst_buffer_foreach_meta         (GstBuffer *buffer,
 556                                                  GstBufferForeachMetaFunc func,
 557                                                  gpointer user_data);
 558
 559 /**
 560  * gst_value_set_buffer:
 561  * @v: a #GValue to receive the data
 562  * @b: (transfer none): a #GstBuffer to assign to the GstValue
 563  *
 564  * Sets @b as the value of @v.  Caller retains reference to buffer.
 565  */
 566 #define         gst_value_set_buffer(v,b)       g_value_set_boxed((v),(b))
 567 /**
 568  * gst_value_take_buffer:
 569  * @v: a #GValue to receive the data
 570  * @b: (transfer full): a #GstBuffer to assign to the GstValue
 571  *
 572  * Sets @b as the value of @v.  Caller gives away reference to buffer.
 573  */
 574 #define         gst_value_take_buffer(v,b)      g_value_take_boxed(v,(b))
 575 /**
 576  * gst_value_get_buffer:
 577  * @v: a #GValue to query
 578  *
 579  * Receives a #GstBuffer as the value of @v. Does not return a reference to
 580  * the buffer, so the pointer is only valid for as long as the caller owns
 581  * a reference to @v.
 582  *
 583  * Returns: (transfer none): buffer
 584  */
 585 #define         gst_value_get_buffer(v)         GST_BUFFER_CAST (g_value_get_boxed(v))
 586
 587 typedef struct _GstParentBufferMeta GstParentBufferMeta;
 588
 589 /**
 590  * GstParentBufferMeta:
 591  * @parent: the parent #GstMeta structure
 592  * @buffer: the #GstBuffer on which a reference is being held.
 593  *
 594  * The #GstParentBufferMeta is a #GstMeta which can be attached to a #GstBuffer
 595  * to hold a reference to another buffer that is only released when the child
 596  * #GstBuffer is released.
 597  *
 598  * Typically, #GstParentBufferMeta is used when the child buffer is directly
 599  * using the #GstMemory of the parent buffer, and wants to prevent the parent
 600  * buffer from being returned to a buffer pool until the #GstMemory is available
 601  * for re-use.
 602  *
 603  * Since: 1.6
 604  */
 605 struct _GstParentBufferMeta
 606 {
 607   GstMeta parent;
 608
 609   /*< public >*/
 610   GstBuffer *buffer;
 611 };
 612
 613 GType gst_parent_buffer_meta_api_get_type (void);
 614 #define GST_TYPE_PARENT_BUFFER_META_API_TYPE (gst_parent_buffer_meta_api_get_type())
 615
 616 /**
 617  * gst_buffer_get_parent_buffer_meta:
 618  * @b: a #GstBuffer
 619  *
 620  * Find and return a #GstParentBufferMeta if one exists on the
 621  * buffer
 622  */
 623 #define gst_buffer_get_parent_buffer_meta(b) \
 624   ((GstParentBufferMeta*)gst_buffer_get_meta((b),GST_PARENT_BUFFER_META_API_TYPE))
 625
 626 const GstMetaInfo *gst_parent_buffer_meta_get_info (void);
 627 #define GST_PARENT_BUFFER_META_INFO (gst_parent_buffer_meta_get_info())
 628
 629 /* implementation */
 630 GstParentBufferMeta *gst_buffer_add_parent_buffer_meta (GstBuffer *buffer,
 631     GstBuffer *ref);
 632
 633 G_END_DECLS
 634
 635 #endif /* __GST_BUFFER_H__ */