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_API 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_NON_DROPPABLE: This buffer is important and should not be dropped.
 214  *                                 This can be used to mark important buffers, e.g. to flag
 215  *                                 RTP packets carrying keyframes or codec setup data for RTP
 216  *                                 Forward Error Correction purposes, or to prevent still video
 217  *                                 frames from being dropped by elements due to QoS. (Since 1.14)
 218  * @GST_BUFFER_FLAG_LAST:          additional media specific flags can be added starting from
 219  *                                 this flag.
 220  *
 221  * A set of buffer flags used to describe properties of a #GstBuffer.
 222  */
 223 typedef enum {
 224   GST_BUFFER_FLAG_LIVE          = (GST_MINI_OBJECT_FLAG_LAST << 0),
 225   GST_BUFFER_FLAG_DECODE_ONLY   = (GST_MINI_OBJECT_FLAG_LAST << 1),
 226   GST_BUFFER_FLAG_DISCONT       = (GST_MINI_OBJECT_FLAG_LAST << 2),
 227   GST_BUFFER_FLAG_RESYNC        = (GST_MINI_OBJECT_FLAG_LAST << 3),
 228   GST_BUFFER_FLAG_CORRUPTED     = (GST_MINI_OBJECT_FLAG_LAST << 4),
 229   GST_BUFFER_FLAG_MARKER        = (GST_MINI_OBJECT_FLAG_LAST << 5),
 230   GST_BUFFER_FLAG_HEADER        = (GST_MINI_OBJECT_FLAG_LAST << 6),
 231   GST_BUFFER_FLAG_GAP           = (GST_MINI_OBJECT_FLAG_LAST << 7),
 232   GST_BUFFER_FLAG_DROPPABLE     = (GST_MINI_OBJECT_FLAG_LAST << 8),
 233   GST_BUFFER_FLAG_DELTA_UNIT    = (GST_MINI_OBJECT_FLAG_LAST << 9),
 234   GST_BUFFER_FLAG_TAG_MEMORY    = (GST_MINI_OBJECT_FLAG_LAST << 10),
 235   GST_BUFFER_FLAG_SYNC_AFTER    = (GST_MINI_OBJECT_FLAG_LAST << 11),
 236   GST_BUFFER_FLAG_NON_DROPPABLE = (GST_MINI_OBJECT_FLAG_LAST << 12),
 237
 238   GST_BUFFER_FLAG_LAST          = (GST_MINI_OBJECT_FLAG_LAST << 16)
 239 } GstBufferFlags;
 240
 241 /**
 242  * GstBuffer:
 243  * @mini_object: the parent structure
 244  * @pool: pointer to the pool owner of the buffer
 245  * @pts: presentation timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
 246  *     pts is not known or relevant. The pts contains the timestamp when the
 247  *     media should be presented to the user.
 248  * @dts: decoding timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
 249  *     dts is not known or relevant. The dts contains the timestamp when the
 250  *     media should be processed.
 251  * @duration: duration in time of the buffer data, can be #GST_CLOCK_TIME_NONE
 252  *     when the duration is not known or relevant.
 253  * @offset: a media specific offset for the buffer data.
 254  *     For video frames, this is the frame number of this buffer.
 255  *     For audio samples, this is the offset of the first sample in this buffer.
 256  *     For file data or compressed data this is the byte offset of the first
 257  *       byte in this buffer.
 258  * @offset_end: the last offset contained in this buffer. It has the same
 259  *     format as @offset.
 260  *
 261  * The structure of a #GstBuffer. Use the associated macros to access the public
 262  * variables.
 263  */
 264 struct _GstBuffer {
 265   GstMiniObject          mini_object;
 266
 267   /*< public >*/ /* with COW */
 268   GstBufferPool         *pool;
 269
 270   /* timestamp */
 271   GstClockTime           pts;
 272   GstClockTime           dts;
 273   GstClockTime           duration;
 274
 275   /* media specific offset */
 276   guint64                offset;
 277   guint64                offset_end;
 278 };
 279
 280 GST_API
 281 GType       gst_buffer_get_type            (void);
 282
 283 GST_API
 284 guint       gst_buffer_get_max_memory      (void);
 285
 286 /* allocation */
 287
 288 GST_API
 289 GstBuffer * gst_buffer_new                 (void);
 290
 291 GST_API
 292 GstBuffer * gst_buffer_new_allocate        (GstAllocator * allocator, gsize size,
 293                                             GstAllocationParams * params);
 294 GST_API
 295 GstBuffer * gst_buffer_new_wrapped_full    (GstMemoryFlags flags, gpointer data, gsize maxsize,
 296                                             gsize offset, gsize size, gpointer user_data,
 297                                             GDestroyNotify notify);
 298 GST_API
 299 GstBuffer * gst_buffer_new_wrapped         (gpointer data, gsize size);
 300
 301 /* memory blocks */
 302
 303 GST_API
 304 guint       gst_buffer_n_memory             (GstBuffer *buffer);
 305
 306 GST_API
 307 void        gst_buffer_insert_memory        (GstBuffer *buffer, gint idx, GstMemory *mem);
 308
 309 GST_API
 310 void        gst_buffer_replace_memory_range (GstBuffer *buffer, guint idx, gint length, GstMemory *mem);
 311
 312 GST_API
 313 GstMemory * gst_buffer_peek_memory          (GstBuffer *buffer, guint idx);
 314
 315 GST_API
 316 GstMemory * gst_buffer_get_memory_range     (GstBuffer *buffer, guint idx, gint length);
 317
 318 GST_API
 319 void        gst_buffer_remove_memory_range  (GstBuffer *buffer, guint idx, gint length);
 320
 321 GST_API
 322 void        gst_buffer_prepend_memory       (GstBuffer *buffer, GstMemory *mem);
 323
 324 GST_API
 325 void        gst_buffer_append_memory        (GstBuffer *buffer, GstMemory *mem);
 326
 327 GST_API
 328 void        gst_buffer_replace_memory       (GstBuffer *buffer, guint idx, GstMemory *mem);
 329
 330 GST_API
 331 void        gst_buffer_replace_all_memory   (GstBuffer *buffer, GstMemory *mem);
 332
 333 GST_API
 334 GstMemory * gst_buffer_get_memory           (GstBuffer *buffer, guint idx);
 335
 336 GST_API
 337 GstMemory * gst_buffer_get_all_memory       (GstBuffer *buffer);
 338
 339 GST_API
 340 void        gst_buffer_remove_memory        (GstBuffer *buffer, guint idx);
 341
 342 GST_API
 343 void        gst_buffer_remove_all_memory    (GstBuffer *buffer);
 344
 345 GST_API
 346 gboolean    gst_buffer_find_memory         (GstBuffer *buffer, gsize offset, gsize size,
 347                                             guint *idx, guint *length, gsize *skip);
 348 GST_API
 349 gboolean    gst_buffer_is_memory_range_writable  (GstBuffer *buffer, guint idx, gint length);
 350
 351 GST_API
 352 gboolean    gst_buffer_is_all_memory_writable    (GstBuffer *buffer);
 353
 354 GST_API
 355 gsize       gst_buffer_fill                (GstBuffer *buffer, gsize offset,
 356                                             gconstpointer src, gsize size);
 357 GST_API
 358 gsize       gst_buffer_extract             (GstBuffer *buffer, gsize offset,
 359                                             gpointer dest, gsize size);
 360 GST_API
 361 gint        gst_buffer_memcmp              (GstBuffer *buffer, gsize offset,
 362                                             gconstpointer mem, gsize size);
 363 GST_API
 364 gsize       gst_buffer_memset              (GstBuffer *buffer, gsize offset,
 365                                             guint8 val, gsize size);
 366 GST_API
 367 gsize       gst_buffer_get_sizes_range     (GstBuffer *buffer, guint idx, gint length,
 368                                             gsize *offset, gsize *maxsize);
 369 GST_API
 370 gboolean    gst_buffer_resize_range        (GstBuffer *buffer, guint idx, gint length,
 371                                             gssize offset, gssize size);
 372 GST_API
 373 gsize       gst_buffer_get_sizes           (GstBuffer *buffer, gsize *offset, gsize *maxsize);
 374
 375 GST_API
 376 gsize       gst_buffer_get_size            (GstBuffer *buffer);
 377
 378 GST_API
 379 void        gst_buffer_resize              (GstBuffer *buffer, gssize offset, gssize size);
 380
 381 GST_API
 382 void        gst_buffer_set_size            (GstBuffer *buffer, gssize size);
 383
 384 GST_API
 385 gboolean    gst_buffer_map_range           (GstBuffer *buffer, guint idx, gint length,
 386                                             GstMapInfo *info, GstMapFlags flags);
 387 GST_API
 388 gboolean    gst_buffer_map                 (GstBuffer *buffer, GstMapInfo *info, GstMapFlags flags);
 389
 390 GST_API
 391 void        gst_buffer_unmap               (GstBuffer *buffer, GstMapInfo *info);
 392
 393 GST_API
 394 void        gst_buffer_extract_dup         (GstBuffer *buffer, gsize offset,
 395                                             gsize size, gpointer *dest,
 396                                             gsize *dest_size);
 397 GST_API
 398 GstBufferFlags gst_buffer_get_flags        (GstBuffer * buffer);
 399
 400 GST_API
 401 gboolean       gst_buffer_has_flags        (GstBuffer * buffer, GstBufferFlags flags);
 402
 403 GST_API
 404 gboolean       gst_buffer_set_flags        (GstBuffer * buffer, GstBufferFlags flags);
 405
 406 GST_API
 407 gboolean       gst_buffer_unset_flags      (GstBuffer * buffer, GstBufferFlags flags);
 408
 409
 410
 411 /* refcounting */
 412 /**
 413  * gst_buffer_ref:
 414  * @buf: a #GstBuffer.
 415  *
 416  * Increases the refcount of the given buffer by one.
 417  *
 418  * Note that the refcount affects the writability
 419  * of @buf and its metadata, see gst_buffer_is_writable().
 420  * It is important to note that keeping additional references to
 421  * GstBuffer instances can potentially increase the number
 422  * of memcpy operations in a pipeline.
 423  *
 424  * Returns: (transfer full): @buf
 425  */
 426 static inline GstBuffer *
 427 gst_buffer_ref (GstBuffer * buf)
 428 {
 429   return (GstBuffer *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (buf));
 430 }
 431
 432 /**
 433  * gst_buffer_unref:
 434  * @buf: (transfer full): a #GstBuffer.
 435  *
 436  * Decreases the refcount of the buffer. If the refcount reaches 0, the buffer
 437  * with the associated metadata and memory will be freed.
 438  */
 439 static inline void
 440 gst_buffer_unref (GstBuffer * buf)
 441 {
 442   gst_mini_object_unref (GST_MINI_OBJECT_CAST (buf));
 443 }
 444
 445 /**
 446  * gst_clear_buffer: (skip)
 447  * @buf_ptr: a pointer to a #GstBuffer reference
 448  *
 449  * Clears a reference to a #GstBuffer.
 450  *
 451  * @buf_ptr must not be %NULL.
 452  *
 453  * If the reference is %NULL then this function does nothing. Otherwise, the
 454  * reference count of the buffer is decreased and the pointer is set to %NULL.
 455  *
 456  * Since: 1.16
 457  */
 458 static inline void
 459 gst_clear_buffer (GstBuffer ** buf_ptr)
 460 {
 461   gst_clear_mini_object (buf_ptr);
 462 }
 463
 464 /* copy buffer */
 465 /**
 466  * gst_buffer_copy:
 467  * @buf: a #GstBuffer.
 468  *
 469  * Create a copy of the given buffer. This will only copy the buffer's
 470  * data to a newly allocated memory if needed (if the type of memory
 471  * requires it), otherwise the underlying data is just referenced.
 472  * Check gst_buffer_copy_deep() if you want to force the data
 473  * to be copied to newly allocated memory.
 474  *
 475  * Returns: (transfer full): a new copy of @buf.
 476  */
 477 static inline GstBuffer *
 478 gst_buffer_copy (const GstBuffer * buf)
 479 {
 480   return GST_BUFFER (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (buf)));
 481 }
 482
 483 GST_API
 484 GstBuffer * gst_buffer_copy_deep (const GstBuffer * buf);
 485
 486 /**
 487  * GstBufferCopyFlags:
 488  * @GST_BUFFER_COPY_NONE: copy nothing
 489  * @GST_BUFFER_COPY_FLAGS: flag indicating that buffer flags should be copied
 490  * @GST_BUFFER_COPY_TIMESTAMPS: flag indicating that buffer pts, dts,
 491  *   duration, offset and offset_end should be copied
 492  * @GST_BUFFER_COPY_MEMORY: flag indicating that buffer memory should be reffed
 493  *   and appended to already existing memory. Unless the memory is marked as
 494  *   NO_SHARE, no actual copy of the memory is made but it is simply reffed.
 495  *   Add @GST_BUFFER_COPY_DEEP to force a real copy.
 496  * @GST_BUFFER_COPY_MERGE: flag indicating that buffer memory should be
 497  *   merged
 498  * @GST_BUFFER_COPY_META: flag indicating that buffer meta should be
 499  *   copied
 500  * @GST_BUFFER_COPY_DEEP: flag indicating that memory should always be
 501  *   copied instead of reffed (Since 1.2)
 502  *
 503  * A set of flags that can be provided to the gst_buffer_copy_into()
 504  * function to specify which items should be copied.
 505  */
 506 typedef enum {
 507   GST_BUFFER_COPY_NONE           = 0,
 508   GST_BUFFER_COPY_FLAGS          = (1 << 0),
 509   GST_BUFFER_COPY_TIMESTAMPS     = (1 << 1),
 510   GST_BUFFER_COPY_META           = (1 << 2),
 511   GST_BUFFER_COPY_MEMORY         = (1 << 3),
 512   GST_BUFFER_COPY_MERGE          = (1 << 4),
 513   GST_BUFFER_COPY_DEEP           = (1 << 5)
 514 } GstBufferCopyFlags;
 515
 516 /**
 517  * GST_BUFFER_COPY_METADATA: (value 7) (type GstBufferCopyFlags)
 518  *
 519  * Combination of all possible metadata fields that can be copied with
 520  * gst_buffer_copy_into().
 521  */
 522 #define GST_BUFFER_COPY_METADATA       ((GstBufferCopyFlags) (GST_BUFFER_COPY_FLAGS |\
 523                                           GST_BUFFER_COPY_TIMESTAMPS | GST_BUFFER_COPY_META))
 524
 525 /**
 526  * GST_BUFFER_COPY_ALL: (value 15) (type GstBufferCopyFlags)
 527  *
 528  * Combination of all possible fields that can be copied with
 529  * gst_buffer_copy_into().
 530  */
 531 #define GST_BUFFER_COPY_ALL  ((GstBufferCopyFlags)(GST_BUFFER_COPY_METADATA | GST_BUFFER_COPY_MEMORY))
 532
 533 /* copies memory or metadata into newly allocated buffer */
 534
 535 GST_API
 536 gboolean        gst_buffer_copy_into            (GstBuffer *dest, GstBuffer *src,
 537                                                  GstBufferCopyFlags flags,
 538                                                  gsize offset, gsize size);
 539
 540 /**
 541  * gst_buffer_is_writable:
 542  * @buf: a #GstBuffer
 543  *
 544  * Tests if you can safely write to a buffer's metadata or its memory array.
 545  * It is only safe to change buffer metadata when the current reference is
 546  * writable, i.e. nobody can see the modifications you will make.
 547  */
 548 #define         gst_buffer_is_writable(buf)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (buf))
 549 /**
 550  * gst_buffer_make_writable:
 551  * @buf: (transfer full): a #GstBuffer
 552  *
 553  * Returns a writable copy of @buf. If the source buffer is
 554  * already writable, this will simply return the same buffer.
 555  *
 556  * Use this function to ensure that a buffer can be safely modified before
 557  * making changes to it, including changing the metadata such as PTS/DTS.
 558  *
 559  * If the reference count of the source buffer @buf is exactly one, the caller
 560  * is the sole owner and this function will return the buffer object unchanged.
 561  *
 562  * If there is more than one reference on the object, a copy will be made using
 563  * gst_buffer_copy(). The passed-in @buf will be unreffed in that case, and the
 564  * caller will now own a reference to the new returned buffer object. Note
 565  * that this just copies the buffer structure itself, the underlying memory is
 566  * not copied if it can be shared amongst multiple buffers.
 567  *
 568  * In short, this function unrefs the buf in the argument and refs the buffer
 569  * that it returns. Don't access the argument after calling this function unless
 570  * you have an additional reference to it.
 571  *
 572  * Returns: (transfer full): a writable buffer which may or may not be the
 573  *     same as @buf
 574  */
 575 #define         gst_buffer_make_writable(buf)   GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (buf)))
 576
 577 /**
 578  * gst_buffer_replace:
 579  * @obuf: (inout) (transfer full) (nullable): pointer to a pointer to
 580  *     a #GstBuffer to be replaced.
 581  * @nbuf: (transfer none) (allow-none): pointer to a #GstBuffer that will
 582  *     replace the buffer pointed to by @obuf.
 583  *
 584  * Modifies a pointer to a #GstBuffer to point to a different #GstBuffer. The
 585  * modification is done atomically (so this is useful for ensuring thread safety
 586  * in some cases), and the reference counts are updated appropriately (the old
 587  * buffer is unreffed, the new is reffed).
 588  *
 589  * Either @nbuf or the #GstBuffer pointed to by @obuf may be %NULL.
 590  *
 591  * Returns: %TRUE when @obuf was different from @nbuf.
 592  */
 593 static inline gboolean
 594 gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf)
 595 {
 596   return gst_mini_object_replace ((GstMiniObject **) obuf, (GstMiniObject *) nbuf);
 597 }
 598
 599 /* creating a region */
 600
 601 GST_API
 602 GstBuffer*      gst_buffer_copy_region          (GstBuffer *parent, GstBufferCopyFlags flags,
 603                                                  gsize offset, gsize size);
 604
 605 /* append two buffers */
 606
 607 GST_API
 608 GstBuffer*      gst_buffer_append_region        (GstBuffer *buf1, GstBuffer *buf2,
 609                                                  gssize offset, gssize size);
 610 GST_API
 611 GstBuffer*      gst_buffer_append               (GstBuffer *buf1, GstBuffer *buf2);
 612
 613 /* metadata */
 614 #include <gst/gstmeta.h>
 615
 616 /**
 617  * GstBufferForeachMetaFunc:
 618  * @buffer: a #GstBuffer
 619  * @meta: (out) (nullable): a pointer to a #GstMeta
 620  * @user_data: user data passed to gst_buffer_foreach_meta()
 621  *
 622  * A function that will be called from gst_buffer_foreach_meta(). The @meta
 623  * field will point to a the reference of the meta.
 624  *
 625  * @buffer should not be modified from this callback.
 626  *
 627  * When this function returns %TRUE, the next meta will be
 628  * returned. When %FALSE is returned, gst_buffer_foreach_meta() will return.
 629  *
 630  * When @meta is set to %NULL, the item will be removed from the buffer.
 631  *
 632  * Returns: %FALSE when gst_buffer_foreach_meta() should stop
 633  */
 634 typedef gboolean (*GstBufferForeachMetaFunc)    (GstBuffer *buffer, GstMeta **meta,
 635                                                  gpointer user_data);
 636
 637 GST_API
 638 GstMeta *       gst_buffer_get_meta             (GstBuffer *buffer, GType api);
 639
 640 GST_API
 641 guint           gst_buffer_get_n_meta           (GstBuffer *buffer, GType api_type);
 642
 643 GST_API
 644 GstMeta *       gst_buffer_add_meta             (GstBuffer *buffer, const GstMetaInfo *info,
 645                                                  gpointer params);
 646 GST_API
 647 gboolean        gst_buffer_remove_meta          (GstBuffer *buffer, GstMeta *meta);
 648
 649 GST_API
 650 GstMeta *       gst_buffer_iterate_meta         (GstBuffer *buffer, gpointer *state);
 651
 652 GST_API
 653 GstMeta *       gst_buffer_iterate_meta_filtered (GstBuffer * buffer,
 654                                                   gpointer  * state,
 655                                                   GType       meta_api_type);
 656 GST_API
 657 gboolean        gst_buffer_foreach_meta         (GstBuffer *buffer,
 658                                                  GstBufferForeachMetaFunc func,
 659                                                  gpointer user_data);
 660
 661 /**
 662  * gst_value_set_buffer:
 663  * @v: a #GValue to receive the data
 664  * @b: (transfer none): a #GstBuffer to assign to the GstValue
 665  *
 666  * Sets @b as the value of @v.  Caller retains reference to buffer.
 667  */
 668 #define         gst_value_set_buffer(v,b)       g_value_set_boxed((v),(b))
 669 /**
 670  * gst_value_take_buffer:
 671  * @v: a #GValue to receive the data
 672  * @b: (transfer full): a #GstBuffer to assign to the GstValue
 673  *
 674  * Sets @b as the value of @v.  Caller gives away reference to buffer.
 675  */
 676 #define         gst_value_take_buffer(v,b)      g_value_take_boxed(v,(b))
 677 /**
 678  * gst_value_get_buffer:
 679  * @v: a #GValue to query
 680  *
 681  * Receives a #GstBuffer as the value of @v. Does not return a reference to
 682  * the buffer, so the pointer is only valid for as long as the caller owns
 683  * a reference to @v.
 684  *
 685  * Returns: (transfer none): buffer
 686  */
 687 #define         gst_value_get_buffer(v)         GST_BUFFER_CAST (g_value_get_boxed(v))
 688
 689 typedef struct _GstParentBufferMeta GstParentBufferMeta;
 690
 691 /**
 692  * GstParentBufferMeta:
 693  * @parent: the parent #GstMeta structure
 694  * @buffer: the #GstBuffer on which a reference is being held.
 695  *
 696  * The #GstParentBufferMeta is a #GstMeta which can be attached to a #GstBuffer
 697  * to hold a reference to another buffer that is only released when the child
 698  * #GstBuffer is released.
 699  *
 700  * Typically, #GstParentBufferMeta is used when the child buffer is directly
 701  * using the #GstMemory of the parent buffer, and wants to prevent the parent
 702  * buffer from being returned to a buffer pool until the #GstMemory is available
 703  * for re-use.
 704  *
 705  * Since: 1.6
 706  */
 707 struct _GstParentBufferMeta
 708 {
 709   GstMeta parent;
 710
 711   /*< public >*/
 712   GstBuffer *buffer;
 713 };
 714
 715 GST_API
 716 GType gst_parent_buffer_meta_api_get_type (void);
 717 #ifndef GST_DISABLE_DEPRECATED
 718 #define GST_TYPE_PARENT_BUFFER_META_API_TYPE GST_PARENT_BUFFER_META_API_TYPE
 719 #endif
 720 #define GST_PARENT_BUFFER_META_API_TYPE (gst_parent_buffer_meta_api_get_type())
 721
 722 /**
 723  * gst_buffer_get_parent_buffer_meta:
 724  * @b: a #GstBuffer
 725  *
 726  * Find and return a #GstParentBufferMeta if one exists on the
 727  * buffer
 728  */
 729 #define gst_buffer_get_parent_buffer_meta(b) \
 730   ((GstParentBufferMeta*)gst_buffer_get_meta((b),GST_PARENT_BUFFER_META_API_TYPE))
 731
 732 GST_API
 733 const GstMetaInfo *gst_parent_buffer_meta_get_info (void);
 734 #define GST_PARENT_BUFFER_META_INFO (gst_parent_buffer_meta_get_info())
 735
 736 /* implementation */
 737
 738 GST_API
 739 GstParentBufferMeta *gst_buffer_add_parent_buffer_meta (GstBuffer *buffer,
 740     GstBuffer *ref);
 741
 742 typedef struct _GstReferenceTimestampMeta GstReferenceTimestampMeta;
 743
 744 /**
 745  * GstReferenceTimestampMeta:
 746  * @parent: the parent #GstMeta structure
 747  * @reference: identifier for the timestamp reference.
 748  * @timestamp: timestamp
 749  * @duration: duration, or %GST_CLOCK_TIME_NONE
 750  *
 751  * #GstReferenceTimestampMeta can be used to attach alternative timestamps and
 752  * possibly durations to a #GstBuffer. These are generally not according to
 753  * the pipeline clock and could be e.g. the NTP timestamp when the media was
 754  * captured.
 755  *
 756  * The reference is stored as a #GstCaps in @reference. Examples of valid
 757  * references would be "timestamp/x-drivername-stream" for timestamps that are locally
 758  * generated by some driver named "drivername" when generating the stream,
 759  * e.g. based on a frame counter, or "timestamp/x-ntp, host=pool.ntp.org,
 760  * port=123" for timestamps based on a specific NTP server.
 761  *
 762  * Since: 1.14
 763  */
 764 struct _GstReferenceTimestampMeta
 765 {
 766   GstMeta parent;
 767
 768   /*< public >*/
 769   GstCaps *reference;
 770   GstClockTime timestamp, duration;
 771 };
 772
 773 GST_API
 774 GType gst_reference_timestamp_meta_api_get_type (void);
 775 #define GST_REFERENCE_TIMESTAMP_META_API_TYPE (gst_reference_timestamp_meta_api_get_type())
 776
 777 GST_API
 778 const GstMetaInfo *gst_reference_timestamp_meta_get_info (void);
 779 #define GST_REFERENCE_TIMESTAMP_META_INFO (gst_reference_timestamp_meta_get_info())
 780
 781 /* implementation */
 782
 783 GST_API
 784 GstReferenceTimestampMeta * gst_buffer_add_reference_timestamp_meta (GstBuffer  * buffer,
 785                                                                      GstCaps    * reference,
 786                                                                      GstClockTime timestamp,
 787                                                                      GstClockTime duration);
 788
 789 GST_API
 790 GstReferenceTimestampMeta * gst_buffer_get_reference_timestamp_meta (GstBuffer * buffer,
 791                                                                      GstCaps   * reference);
 792
 793 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
 794 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstBuffer, gst_buffer_unref)
 795 #endif
 796
 797 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
 798 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstBufferPool, gst_object_unref)
 799 #endif
 800
 801 G_END_DECLS
 802
 803 #endif /* __GST_BUFFER_H__ */