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