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 #include <gst/gstcaps.h>
  31
  32 G_BEGIN_DECLS
  33
  34 GST_EXPORT GType _gst_buffer_type;
  35
  36 typedef struct _GstBuffer GstBuffer;
  37 typedef struct _GstBufferPool GstBufferPool;
  38
  39 #include <gst/gstmeta.h>
  40
  41 #define GST_TYPE_BUFFER                         (_gst_buffer_type)
  42 #define GST_IS_BUFFER(obj)                      (GST_IS_MINI_OBJECT_TYPE(obj, GST_TYPE_BUFFER))
  43 #define GST_BUFFER_CAST(obj)                    ((GstBuffer *)(obj))
  44 #define GST_BUFFER(obj)                         (GST_BUFFER_CAST(obj))
  45
  46 /**
  47  * GST_BUFFER_FLAGS:
  48  * @buf: a #GstBuffer.
  49  *
  50  * A flags word containing #GstBufferFlags flags set on this buffer.
  51  */
  52 #define GST_BUFFER_FLAGS(buf)                   GST_MINI_OBJECT_FLAGS(buf)
  53 /**
  54  * GST_BUFFER_FLAG_IS_SET:
  55  * @buf: a #GstBuffer.
  56  * @flag: the #GstBufferFlags flag to check.
  57  *
  58  * Gives the status of a specific flag on a buffer.
  59  */
  60 #define GST_BUFFER_FLAG_IS_SET(buf,flag)        GST_MINI_OBJECT_FLAG_IS_SET (buf, flag)
  61 /**
  62  * GST_BUFFER_FLAG_SET:
  63  * @buf: a #GstBuffer.
  64  * @flag: the #GstBufferFlags flag to set.
  65  *
  66  * Sets a buffer flag on a buffer.
  67  */
  68 #define GST_BUFFER_FLAG_SET(buf,flag)           GST_MINI_OBJECT_FLAG_SET (buf, flag)
  69 /**
  70  * GST_BUFFER_FLAG_UNSET:
  71  * @buf: a #GstBuffer.
  72  * @flag: the #GstBufferFlags flag to clear.
  73  *
  74  * Clears a buffer flag.
  75  */
  76 #define GST_BUFFER_FLAG_UNSET(buf,flag)         GST_MINI_OBJECT_FLAG_UNSET (buf, flag)
  77
  78
  79 /**
  80  * GST_BUFFER_PTS:
  81  * @buf: a #GstBuffer.:
  82  *
  83  * The presentation timestamp (pts) in nanoseconds (as a #GstClockTime)
  84  * of the data in the buffer. This is the timestamp when the media should be
  85  * presented to the user.
  86  * Value will be %GST_CLOCK_TIME_NONE if the pts is unknown.
  87  */
  88 #define GST_BUFFER_PTS(buf)                     (GST_BUFFER_CAST(buf)->pts)
  89 /**
  90  * GST_BUFFER_DTS:
  91  * @buf: a #GstBuffer.:
  92  *
  93  * The decoding timestamp (dts) in nanoseconds (as a #GstClockTime)
  94  * of the data in the buffer. This is the timestamp when the media should be
  95  * decoded or processed otherwise.
  96  * Value will be %GST_CLOCK_TIME_NONE if the dts is unknown.
  97  */
  98 #define GST_BUFFER_DTS(buf)                     (GST_BUFFER_CAST(buf)->dts)
  99 /**
 100  * GST_BUFFER_DTS_OR_PTS:
 101  * @buf: a #GstBuffer.:
 102  *
 103  * Returns the buffer decoding timestamp (dts) if valid, else the buffer
 104  * presentation time (pts)
 105  *
 106  * Since: 1.8
 107  */
 108 #define GST_BUFFER_DTS_OR_PTS(buf)              (GST_BUFFER_DTS_IS_VALID(buf) ? GST_BUFFER_DTS(buf) : GST_BUFFER_PTS (buf))
 109 /**
 110  * GST_BUFFER_DURATION:
 111  * @buf: a #GstBuffer.
 112  *
 113  * The duration in nanoseconds (as a #GstClockTime) of the data in the buffer.
 114  * Value will be %GST_CLOCK_TIME_NONE if the duration is unknown.
 115  */
 116 #define GST_BUFFER_DURATION(buf)                (GST_BUFFER_CAST(buf)->duration)
 117 /**
 118  * GST_BUFFER_OFFSET:
 119  * @buf: a #GstBuffer.
 120  *
 121  * The offset in the source file of the beginning of this buffer.
 122  */
 123 #define GST_BUFFER_OFFSET(buf)                  (GST_BUFFER_CAST(buf)->offset)
 124 /**
 125  * GST_BUFFER_OFFSET_END:
 126  * @buf: a #GstBuffer.
 127  *
 128  * The offset in the source file of the end of this buffer.
 129  */
 130 #define GST_BUFFER_OFFSET_END(buf)              (GST_BUFFER_CAST(buf)->offset_end)
 131
 132 /**
 133  * GST_BUFFER_OFFSET_NONE:
 134  *
 135  * Constant for no-offset return results.
 136  */
 137 #define GST_BUFFER_OFFSET_NONE  ((guint64)-1)
 138
 139 /**
 140  * GST_BUFFER_DURATION_IS_VALID:
 141  * @buffer: a #GstBuffer
 142  *
 143  * Tests if the duration is known.
 144  */
 145 #define GST_BUFFER_DURATION_IS_VALID(buffer)    (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DURATION (buffer)))
 146 /**
 147  * GST_BUFFER_PTS_IS_VALID:
 148  * @buffer: a #GstBuffer
 149  *
 150  * Tests if the pts is known.
 151  */
 152 #define GST_BUFFER_PTS_IS_VALID(buffer)   (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_PTS (buffer)))
 153 /**
 154  * GST_BUFFER_DTS_IS_VALID:
 155  * @buffer: a #GstBuffer
 156  *
 157  * Tests if the dts is known.
 158  */
 159 #define GST_BUFFER_DTS_IS_VALID(buffer)   (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DTS (buffer)))
 160 /**
 161  * GST_BUFFER_OFFSET_IS_VALID:
 162  * @buffer: a #GstBuffer
 163  *
 164  * Tests if the start offset is known.
 165  */
 166 #define GST_BUFFER_OFFSET_IS_VALID(buffer)      (GST_BUFFER_OFFSET (buffer) != GST_BUFFER_OFFSET_NONE)
 167 /**
 168  * GST_BUFFER_OFFSET_END_IS_VALID:
 169  * @buffer: a #GstBuffer
 170  *
 171  * Tests if the end offset is known.
 172  */
 173 #define GST_BUFFER_OFFSET_END_IS_VALID(buffer)  (GST_BUFFER_OFFSET_END (buffer) != GST_BUFFER_OFFSET_NONE)
 174 /**
 175  * GST_BUFFER_IS_DISCONT:
 176  * @buffer: a #GstBuffer
 177  *
 178  * Tests if the buffer marks a discontinuity in the stream.
 179  */
 180 #define GST_BUFFER_IS_DISCONT(buffer)   (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DISCONT))
 181
 182 /**
 183  * GstBufferFlags:
 184  * @GST_BUFFER_FLAG_LIVE:        the buffer is live data and should be discarded in
 185  *                               the PAUSED state.
 186  * @GST_BUFFER_FLAG_DECODE_ONLY: the buffer contains data that should be dropped
 187  *                               because it will be clipped against the segment
 188  *                               boundaries or because it does not contain data
 189  *                               that should be shown to the user.
 190  * @GST_BUFFER_FLAG_DISCONT:     the buffer marks a data discontinuity in the stream.
 191  *                               This typically occurs after a seek or a dropped buffer
 192  *                               from a live or network source.
 193  * @GST_BUFFER_FLAG_RESYNC:      the buffer timestamps might have a discontinuity
 194  *                               and this buffer is a good point to resynchronize.
 195  * @GST_BUFFER_FLAG_CORRUPTED:   the buffer data is corrupted.
 196  * @GST_BUFFER_FLAG_MARKER:      the buffer contains a media specific marker. for
 197  *                               video this is typically the end of a frame boundary, for audio
 198  *                               this is usually the start of a talkspurt.
 199  * @GST_BUFFER_FLAG_HEADER:      the buffer contains header information that is
 200  *                               needed to decode the following data.
 201  * @GST_BUFFER_FLAG_GAP:         the buffer has been created to fill a gap in the
 202  *                               stream and contains media neutral data (elements can
 203  *                               switch to optimized code path that ignores the buffer
 204  *                               content).
 205  * @GST_BUFFER_FLAG_DROPPABLE:   the buffer can be dropped without breaking the
 206  *                               stream, for example to reduce bandwidth.
 207  * @GST_BUFFER_FLAG_DELTA_UNIT:  this unit cannot be decoded independently.
 208  * @GST_BUFFER_FLAG_TAG_MEMORY:  this flag is set when memory of the buffer
 209  *                               is added/removed
 210  * @GST_BUFFER_FLAG_SYNC_AFTER:  Elements which write to disk or permanent
 211  *                               storage should ensure the data is synced after
 212  *                               writing the contents of this buffer. (Since 1.6)
 213  * @GST_BUFFER_FLAG_LAST:        additional media specific flags can be added starting from
 214  *                               this flag.
 215  *
 216  * A set of buffer flags used to describe properties of a #GstBuffer.
 217  */
 218 typedef enum {
 219   GST_BUFFER_FLAG_LIVE        = (GST_MINI_OBJECT_FLAG_LAST << 0),
 220   GST_BUFFER_FLAG_DECODE_ONLY = (GST_MINI_OBJECT_FLAG_LAST << 1),
 221   GST_BUFFER_FLAG_DISCONT     = (GST_MINI_OBJECT_FLAG_LAST << 2),
 222   GST_BUFFER_FLAG_RESYNC      = (GST_MINI_OBJECT_FLAG_LAST << 3),
 223   GST_BUFFER_FLAG_CORRUPTED   = (GST_MINI_OBJECT_FLAG_LAST << 4),
 224   GST_BUFFER_FLAG_MARKER      = (GST_MINI_OBJECT_FLAG_LAST << 5),
 225   GST_BUFFER_FLAG_HEADER      = (GST_MINI_OBJECT_FLAG_LAST << 6),
 226   GST_BUFFER_FLAG_GAP         = (GST_MINI_OBJECT_FLAG_LAST << 7),
 227   GST_BUFFER_FLAG_DROPPABLE   = (GST_MINI_OBJECT_FLAG_LAST << 8),
 228   GST_BUFFER_FLAG_DELTA_UNIT  = (GST_MINI_OBJECT_FLAG_LAST << 9),
 229   GST_BUFFER_FLAG_TAG_MEMORY  = (GST_MINI_OBJECT_FLAG_LAST << 10),
 230   GST_BUFFER_FLAG_SYNC_AFTER  = (GST_MINI_OBJECT_FLAG_LAST << 11),
 231
 232   GST_BUFFER_FLAG_LAST        = (GST_MINI_OBJECT_FLAG_LAST << 16)
 233 } GstBufferFlags;
 234
 235 /**
 236  * GstBuffer:
 237  * @mini_object: the parent structure
 238  * @pool: pointer to the pool owner of the buffer
 239  * @pts: presentation timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
 240  *     pts is not known or relevant. The pts contains the timestamp when the
 241  *     media should be presented to the user.
 242  * @dts: decoding timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
 243  *     dts is not known or relevant. The dts contains the timestamp when the
 244  *     media should be processed.
 245  * @duration: duration in time of the buffer data, can be #GST_CLOCK_TIME_NONE
 246  *     when the duration is not known or relevant.
 247  * @offset: a media specific offset for the buffer data.
 248  *     For video frames, this is the frame number of this buffer.
 249  *     For audio samples, this is the offset of the first sample in this buffer.
 250  *     For file data or compressed data this is the byte offset of the first
 251  *       byte in this buffer.
 252  * @offset_end: the last offset contained in this buffer. It has the same
 253  *     format as @offset.
 254  *
 255  * The structure of a #GstBuffer. Use the associated macros to access the public
 256  * variables.
 257  */
 258 struct _GstBuffer {
 259   GstMiniObject          mini_object;
 260
 261   /*< public >*/ /* with COW */
 262   GstBufferPool         *pool;
 263
 264   /* timestamp */
 265   GstClockTime           pts;
 266   GstClockTime           dts;
 267   GstClockTime           duration;
 268
 269   /* media specific offset */
 270   guint64                offset;
 271   guint64                offset_end;
 272 };
 273
 274 GST_EXPORT
 275 GType       gst_buffer_get_type            (void);
 276
 277 GST_EXPORT
 278 guint       gst_buffer_get_max_memory      (void);
 279
 280 /* allocation */
 281
 282 GST_EXPORT
 283 GstBuffer * gst_buffer_new                 (void);
 284
 285 GST_EXPORT
 286 GstBuffer * gst_buffer_new_allocate        (GstAllocator * allocator, gsize size,
 287                                             GstAllocationParams * params);
 288 GST_EXPORT
 289 GstBuffer * gst_buffer_new_wrapped_full    (GstMemoryFlags flags, gpointer data, gsize maxsize,
 290                                             gsize offset, gsize size, gpointer user_data,
 291                                             GDestroyNotify notify);
 292 GST_EXPORT
 293 GstBuffer * gst_buffer_new_wrapped         (gpointer data, gsize size);
 294
 295 /* memory blocks */
 296
 297 GST_EXPORT
 298 guint       gst_buffer_n_memory             (GstBuffer *buffer);
 299
 300 GST_EXPORT
 301 void        gst_buffer_insert_memory        (GstBuffer *buffer, gint idx, GstMemory *mem);
 302
 303 GST_EXPORT
 304 void        gst_buffer_replace_memory_range (GstBuffer *buffer, guint idx, gint length, GstMemory *mem);
 305
 306 GST_EXPORT
 307 GstMemory * gst_buffer_peek_memory          (GstBuffer *buffer, guint idx);
 308
 309 GST_EXPORT
 310 GstMemory * gst_buffer_get_memory_range     (GstBuffer *buffer, guint idx, gint length);
 311
 312 GST_EXPORT
 313 void        gst_buffer_remove_memory_range  (GstBuffer *buffer, guint idx, gint length);
 314
 315 GST_EXPORT
 316 void        gst_buffer_prepend_memory       (GstBuffer *buffer, GstMemory *mem);
 317
 318 GST_EXPORT
 319 void        gst_buffer_append_memory        (GstBuffer *buffer, GstMemory *mem);
 320
 321 GST_EXPORT
 322 void        gst_buffer_replace_memory       (GstBuffer *buffer, guint idx, GstMemory *mem);
 323
 324 GST_EXPORT
 325 void        gst_buffer_replace_all_memory   (GstBuffer *buffer, GstMemory *mem);
 326
 327 GST_EXPORT
 328 GstMemory * gst_buffer_get_memory           (GstBuffer *buffer, guint idx);
 329
 330 GST_EXPORT
 331 GstMemory * gst_buffer_get_all_memory       (GstBuffer *buffer);
 332
 333 GST_EXPORT
 334 void        gst_buffer_remove_memory        (GstBuffer *buffer, guint idx);
 335
 336 GST_EXPORT
 337 void        gst_buffer_remove_all_memory    (GstBuffer *buffer);
 338
 339 GST_EXPORT
 340 gboolean    gst_buffer_find_memory         (GstBuffer *buffer, gsize offset, gsize size,
 341                                             guint *idx, guint *length, gsize *skip);
 342 GST_EXPORT
 343 gboolean    gst_buffer_is_memory_range_writable  (GstBuffer *buffer, guint idx, gint length);
 344
 345 GST_EXPORT
 346 gboolean    gst_buffer_is_all_memory_writable    (GstBuffer *buffer);
 347
 348 GST_EXPORT
 349 gsize       gst_buffer_fill                (GstBuffer *buffer, gsize offset,
 350                                             gconstpointer src, gsize size);
 351 GST_EXPORT
 352 gsize       gst_buffer_extract             (GstBuffer *buffer, gsize offset,
 353                                             gpointer dest, gsize size);
 354 GST_EXPORT
 355 gint        gst_buffer_memcmp              (GstBuffer *buffer, gsize offset,
 356                                             gconstpointer mem, gsize size);
 357 GST_EXPORT
 358 gsize       gst_buffer_memset              (GstBuffer *buffer, gsize offset,
 359                                             guint8 val, gsize size);
 360 GST_EXPORT
 361 gsize       gst_buffer_get_sizes_range     (GstBuffer *buffer, guint idx, gint length,
 362                                             gsize *offset, gsize *maxsize);
 363 GST_EXPORT
 364 gboolean    gst_buffer_resize_range        (GstBuffer *buffer, guint idx, gint length,
 365                                             gssize offset, gssize size);
 366 GST_EXPORT
 367 gsize       gst_buffer_get_sizes           (GstBuffer *buffer, gsize *offset, gsize *maxsize);
 368
 369 GST_EXPORT
 370 gsize       gst_buffer_get_size            (GstBuffer *buffer);
 371
 372 GST_EXPORT
 373 void        gst_buffer_resize              (GstBuffer *buffer, gssize offset, gssize size);
 374
 375 GST_EXPORT
 376 void        gst_buffer_set_size            (GstBuffer *buffer, gssize size);
 377
 378 GST_EXPORT
 379 gboolean    gst_buffer_map_range           (GstBuffer *buffer, guint idx, gint length,
 380                                             GstMapInfo *info, GstMapFlags flags);
 381 GST_EXPORT
 382 gboolean    gst_buffer_map                 (GstBuffer *buffer, GstMapInfo *info, GstMapFlags flags);
 383
 384 GST_EXPORT
 385 void        gst_buffer_unmap               (GstBuffer *buffer, GstMapInfo *info);
 386
 387 GST_EXPORT
 388 void        gst_buffer_extract_dup         (GstBuffer *buffer, gsize offset,
 389                                             gsize size, gpointer *dest,
 390                                             gsize *dest_size);
 391 GST_EXPORT
 392 GstBufferFlags gst_buffer_get_flags        (GstBuffer * buffer);
 393
 394 GST_EXPORT
 395 gboolean       gst_buffer_has_flags        (GstBuffer * buffer, GstBufferFlags flags);
 396
 397 GST_EXPORT
 398 gboolean       gst_buffer_set_flags        (GstBuffer * buffer, GstBufferFlags flags);
 399
 400 GST_EXPORT
 401 gboolean       gst_buffer_unset_flags      (GstBuffer * buffer, GstBufferFlags flags);
 402
 403
 404
 405 /* refcounting */
 406 /**
 407  * gst_buffer_ref:
 408  * @buf: a #GstBuffer.
 409  *
 410  * Increases the refcount of the given buffer by one.
 411  *
 412  * Note that the refcount affects the writability
 413  * of @buf and its metadata, see gst_buffer_is_writable().
 414  * It is important to note that keeping additional references to
 415  * GstBuffer instances can potentially increase the number
 416  * of memcpy operations in a pipeline.
 417  *
 418  * Returns: (transfer full): @buf
 419  */
 420 static inline GstBuffer *
 421 gst_buffer_ref (GstBuffer * buf)
 422 {
 423   return (GstBuffer *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (buf));
 424 }
 425
 426 /**
 427  * gst_buffer_unref:
 428  * @buf: (transfer full): a #GstBuffer.
 429  *
 430  * Decreases the refcount of the buffer. If the refcount reaches 0, the buffer
 431  * with the associated metadata and memory will be freed.
 432  */
 433 static inline void
 434 gst_buffer_unref (GstBuffer * buf)
 435 {
 436   gst_mini_object_unref (GST_MINI_OBJECT_CAST (buf));
 437 }
 438
 439 /* copy buffer */
 440 /**
 441  * gst_buffer_copy:
 442  * @buf: a #GstBuffer.
 443  *
 444  * Create a copy of the given buffer. This will only copy the buffer's
 445  * data to a newly allocated memory if needed (if the type of memory
 446  * requires it), otherwise the underlying data is just referenced.
 447  * Check gst_buffer_copy_deep() if you want to force the data
 448  * to be copied to newly allocated memory.
 449  *
 450  * Returns: (transfer full): a new copy of @buf.
 451  */
 452 static inline GstBuffer *
 453 gst_buffer_copy (const GstBuffer * buf)
 454 {
 455   return GST_BUFFER (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (buf)));
 456 }
 457
 458 GST_EXPORT
 459 GstBuffer * gst_buffer_copy_deep (const GstBuffer * buf);
 460
 461 /**
 462  * GstBufferCopyFlags:
 463  * @GST_BUFFER_COPY_NONE: copy nothing
 464  * @GST_BUFFER_COPY_FLAGS: flag indicating that buffer flags should be copied
 465  * @GST_BUFFER_COPY_TIMESTAMPS: flag indicating that buffer pts, dts,
 466  *   duration, offset and offset_end should be copied
 467  * @GST_BUFFER_COPY_MEMORY: flag indicating that buffer memory should be reffed
 468  *   and appended to already existing memory. Unless the memory is marked as
 469  *   NO_SHARE, no actual copy of the memory is made but it is simply reffed.
 470  *   Add @GST_BUFFER_COPY_DEEP to force a real copy.
 471  * @GST_BUFFER_COPY_MERGE: flag indicating that buffer memory should be
 472  *   merged
 473  * @GST_BUFFER_COPY_META: flag indicating that buffer meta should be
 474  *   copied
 475  * @GST_BUFFER_COPY_DEEP: flag indicating that memory should always be
 476  *   copied instead of reffed (Since 1.2)
 477  *
 478  * A set of flags that can be provided to the gst_buffer_copy_into()
 479  * function to specify which items should be copied.
 480  */
 481 typedef enum {
 482   GST_BUFFER_COPY_NONE           = 0,
 483   GST_BUFFER_COPY_FLAGS          = (1 << 0),
 484   GST_BUFFER_COPY_TIMESTAMPS     = (1 << 1),
 485   GST_BUFFER_COPY_META           = (1 << 2),
 486   GST_BUFFER_COPY_MEMORY         = (1 << 3),
 487   GST_BUFFER_COPY_MERGE          = (1 << 4),
 488   GST_BUFFER_COPY_DEEP           = (1 << 5)
 489 } GstBufferCopyFlags;
 490
 491 /**
 492  * GST_BUFFER_COPY_METADATA: (value 7) (type GstBufferCopyFlags)
 493  *
 494  * Combination of all possible metadata fields that can be copied with
 495  * gst_buffer_copy_into().
 496  */
 497 #define GST_BUFFER_COPY_METADATA       ((GstBufferCopyFlags) (GST_BUFFER_COPY_FLAGS |\
 498                                           GST_BUFFER_COPY_TIMESTAMPS | GST_BUFFER_COPY_META))
 499
 500 /**
 501  * GST_BUFFER_COPY_ALL: (value 15) (type GstBufferCopyFlags)
 502  *
 503  * Combination of all possible fields that can be copied with
 504  * gst_buffer_copy_into().
 505  */
 506 #define GST_BUFFER_COPY_ALL  ((GstBufferCopyFlags)(GST_BUFFER_COPY_METADATA | GST_BUFFER_COPY_MEMORY))
 507
 508 /* copies memory or metadata into newly allocated buffer */
 509
 510 GST_EXPORT
 511 gboolean        gst_buffer_copy_into            (GstBuffer *dest, GstBuffer *src,
 512                                                  GstBufferCopyFlags flags,
 513                                                  gsize offset, gsize size);
 514
 515 /**
 516  * gst_buffer_is_writable:
 517  * @buf: a #GstBuffer
 518  *
 519  * Tests if you can safely write to a buffer's metadata or its memory array.
 520  * It is only safe to change buffer metadata when the current reference is
 521  * writable, i.e. nobody can see the modifications you will make.
 522  */
 523 #define         gst_buffer_is_writable(buf)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (buf))
 524 /**
 525  * gst_buffer_make_writable:
 526  * @buf: (transfer full): a #GstBuffer
 527  *
 528  * Returns a writable copy of @buf. If the source buffer is
 529  * already writable, this will simply return the same buffer.
 530  *
 531  * Use this function to ensure that a buffer can be safely modified before
 532  * making changes to it, including changing the metadata such as PTS/DTS.
 533  *
 534  * If the reference count of the source buffer @buf is exactly one, the caller
 535  * is the sole owner and this function will return the buffer object unchanged.
 536  *
 537  * If there is more than one reference on the object, a copy will be made using
 538  * gst_buffer_copy(). The passed-in @buf will be unreffed in that case, and the
 539  * caller will now own a reference to the new returned buffer object. Note
 540  * that this just copies the buffer structure itself, the underlying memory is
 541  * not copied if it can be shared amongst multiple buffers.
 542  *
 543  * In short, this function unrefs the buf in the argument and refs the buffer
 544  * that it returns. Don't access the argument after calling this function unless
 545  * you have an additional reference to it.
 546  *
 547  * Returns: (transfer full): a writable buffer which may or may not be the
 548  *     same as @buf
 549  */
 550 #define         gst_buffer_make_writable(buf)   GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (buf)))
 551
 552 /**
 553  * gst_buffer_replace:
 554  * @obuf: (inout) (transfer full) (nullable): pointer to a pointer to
 555  *     a #GstBuffer to be replaced.
 556  * @nbuf: (transfer none) (allow-none): pointer to a #GstBuffer that will
 557  *     replace the buffer pointed to by @obuf.
 558  *
 559  * Modifies a pointer to a #GstBuffer to point to a different #GstBuffer. The
 560  * modification is done atomically (so this is useful for ensuring thread safety
 561  * in some cases), and the reference counts are updated appropriately (the old
 562  * buffer is unreffed, the new is reffed).
 563  *
 564  * Either @nbuf or the #GstBuffer pointed to by @obuf may be %NULL.
 565  *
 566  * Returns: %TRUE when @obuf was different from @nbuf.
 567  */
 568 static inline gboolean
 569 gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf)
 570 {
 571   return gst_mini_object_replace ((GstMiniObject **) obuf, (GstMiniObject *) nbuf);
 572 }
 573
 574 /* creating a region */
 575
 576 GST_EXPORT
 577 GstBuffer*      gst_buffer_copy_region          (GstBuffer *parent, GstBufferCopyFlags flags,
 578                                                  gsize offset, gsize size);
 579
 580 /* append two buffers */
 581
 582 GST_EXPORT
 583 GstBuffer*      gst_buffer_append_region        (GstBuffer *buf1, GstBuffer *buf2,
 584                                                  gssize offset, gssize size);
 585 GST_EXPORT
 586 GstBuffer*      gst_buffer_append               (GstBuffer *buf1, GstBuffer *buf2);
 587
 588 /* metadata */
 589 #include <gst/gstmeta.h>
 590
 591 /**
 592  * GstBufferForeachMetaFunc:
 593  * @buffer: a #GstBuffer
 594  * @meta: (out) (nullable): a pointer to a #GstMeta
 595  * @user_data: user data passed to gst_buffer_foreach_meta()
 596  *
 597  * A function that will be called from gst_buffer_foreach_meta(). The @meta
 598  * field will point to a the reference of the meta.
 599  *
 600  * @buffer should not be modified from this callback.
 601  *
 602  * When this function returns %TRUE, the next meta will be
 603  * returned. When %FALSE is returned, gst_buffer_foreach_meta() will return.
 604  *
 605  * When @meta is set to %NULL, the item will be removed from the buffer.
 606  *
 607  * Returns: %FALSE when gst_buffer_foreach_meta() should stop
 608  */
 609 typedef gboolean (*GstBufferForeachMetaFunc)    (GstBuffer *buffer, GstMeta **meta,
 610                                                  gpointer user_data);
 611
 612 GST_EXPORT
 613 GstMeta *       gst_buffer_get_meta             (GstBuffer *buffer, GType api);
 614
 615 GST_EXPORT
 616 GstMeta *       gst_buffer_add_meta             (GstBuffer *buffer, const GstMetaInfo *info,
 617                                                  gpointer params);
 618 GST_EXPORT
 619 gboolean        gst_buffer_remove_meta          (GstBuffer *buffer, GstMeta *meta);
 620
 621 GST_EXPORT
 622 GstMeta *       gst_buffer_iterate_meta         (GstBuffer *buffer, gpointer *state);
 623
 624 GST_EXPORT
 625 GstMeta *       gst_buffer_iterate_meta_filtered (GstBuffer * buffer,
 626                                                   gpointer  * state,
 627                                                   GType       meta_api_type);
 628 GST_EXPORT
 629 gboolean        gst_buffer_foreach_meta         (GstBuffer *buffer,
 630                                                  GstBufferForeachMetaFunc func,
 631                                                  gpointer user_data);
 632
 633 /**
 634  * gst_value_set_buffer:
 635  * @v: a #GValue to receive the data
 636  * @b: (transfer none): a #GstBuffer to assign to the GstValue
 637  *
 638  * Sets @b as the value of @v.  Caller retains reference to buffer.
 639  */
 640 #define         gst_value_set_buffer(v,b)       g_value_set_boxed((v),(b))
 641 /**
 642  * gst_value_take_buffer:
 643  * @v: a #GValue to receive the data
 644  * @b: (transfer full): a #GstBuffer to assign to the GstValue
 645  *
 646  * Sets @b as the value of @v.  Caller gives away reference to buffer.
 647  */
 648 #define         gst_value_take_buffer(v,b)      g_value_take_boxed(v,(b))
 649 /**
 650  * gst_value_get_buffer:
 651  * @v: a #GValue to query
 652  *
 653  * Receives a #GstBuffer as the value of @v. Does not return a reference to
 654  * the buffer, so the pointer is only valid for as long as the caller owns
 655  * a reference to @v.
 656  *
 657  * Returns: (transfer none): buffer
 658  */
 659 #define         gst_value_get_buffer(v)         GST_BUFFER_CAST (g_value_get_boxed(v))
 660
 661 typedef struct _GstParentBufferMeta GstParentBufferMeta;
 662
 663 /**
 664  * GstParentBufferMeta:
 665  * @parent: the parent #GstMeta structure
 666  * @buffer: the #GstBuffer on which a reference is being held.
 667  *
 668  * The #GstParentBufferMeta is a #GstMeta which can be attached to a #GstBuffer
 669  * to hold a reference to another buffer that is only released when the child
 670  * #GstBuffer is released.
 671  *
 672  * Typically, #GstParentBufferMeta is used when the child buffer is directly
 673  * using the #GstMemory of the parent buffer, and wants to prevent the parent
 674  * buffer from being returned to a buffer pool until the #GstMemory is available
 675  * for re-use.
 676  *
 677  * Since: 1.6
 678  */
 679 struct _GstParentBufferMeta
 680 {
 681   GstMeta parent;
 682
 683   /*< public >*/
 684   GstBuffer *buffer;
 685 };
 686
 687 GST_EXPORT
 688 GType gst_parent_buffer_meta_api_get_type (void);
 689 #ifndef GST_DISABLE_DEPRECATED
 690 #define GST_TYPE_PARENT_BUFFER_META_API_TYPE GST_PARENT_BUFFER_META_API_TYPE
 691 #endif
 692 #define GST_PARENT_BUFFER_META_API_TYPE (gst_parent_buffer_meta_api_get_type())
 693
 694 /**
 695  * gst_buffer_get_parent_buffer_meta:
 696  * @b: a #GstBuffer
 697  *
 698  * Find and return a #GstParentBufferMeta if one exists on the
 699  * buffer
 700  */
 701 #define gst_buffer_get_parent_buffer_meta(b) \
 702   ((GstParentBufferMeta*)gst_buffer_get_meta((b),GST_PARENT_BUFFER_META_API_TYPE))
 703
 704 GST_EXPORT
 705 const GstMetaInfo *gst_parent_buffer_meta_get_info (void);
 706 #define GST_PARENT_BUFFER_META_INFO (gst_parent_buffer_meta_get_info())
 707
 708 /* implementation */
 709
 710 GST_EXPORT
 711 GstParentBufferMeta *gst_buffer_add_parent_buffer_meta (GstBuffer *buffer,
 712     GstBuffer *ref);
 713
 714 typedef struct _GstReferenceTimestampMeta GstReferenceTimestampMeta;
 715
 716 /**
 717  * GstReferenceTimestampMeta:
 718  * @parent: the parent #GstMeta structure
 719  * @reference: identifier for the timestamp reference.
 720  * @timestamp: timestamp
 721  * @duration: duration, or %GST_CLOCK_TIME_NONE
 722  *
 723  * #GstReferenceTimestampMeta can be used to attach alternative timestamps and
 724  * possibly durations to a #GstBuffer. These are generally not according to
 725  * the pipeline clock and could be e.g. the NTP timestamp when the media was
 726  * captured.
 727  *
 728  * The reference is stored as a #GstCaps in @reference. Examples of valid
 729  * references would be "timestamp/x-drivername-stream" for timestamps that are locally
 730  * generated by some driver named "drivername" when generating the stream,
 731  * e.g. based on a frame counter, or "timestamp/x-ntp, host=pool.ntp.org,
 732  * port=123" for timestamps based on a specific NTP server.
 733  *
 734  * Since: 1.14
 735  */
 736 struct _GstReferenceTimestampMeta
 737 {
 738   GstMeta parent;
 739
 740   /*< public >*/
 741   GstCaps *reference;
 742   GstClockTime timestamp, duration;
 743 };
 744
 745 GST_EXPORT
 746 GType gst_reference_timestamp_meta_api_get_type (void);
 747 #define GST_REFERENCE_TIMESTAMP_META_API_TYPE (gst_reference_timestamp_meta_api_get_type())
 748
 749 GST_EXPORT
 750 const GstMetaInfo *gst_reference_timestamp_meta_get_info (void);
 751 #define GST_REFERENCE_TIMESTAMP_META_INFO (gst_reference_timestamp_meta_get_info())
 752
 753 /* implementation */
 754
 755 GST_EXPORT
 756 GstReferenceTimestampMeta * gst_buffer_add_reference_timestamp_meta (GstBuffer  * buffer,
 757                                                                      GstCaps    * reference,
 758                                                                      GstClockTime timestamp,
 759                                                                      GstClockTime duration);
 760
 761 GST_EXPORT
 762 GstReferenceTimestampMeta * gst_buffer_get_reference_timestamp_meta (GstBuffer * buffer,
 763                                                                      GstCaps   * reference);
 764
 765 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
 766 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstBuffer, gst_buffer_unref)
 767 #endif
 768
 769 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
 770 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstBufferPool, gst_object_unref)
 771 #endif
 772
 773 G_END_DECLS
 774
 775 #endif /* __GST_BUFFER_H__ */