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., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, 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/gstcaps.h>
  30
  31 G_BEGIN_DECLS
  32
  33 typedef struct _GstBuffer GstBuffer;
  34
  35 extern GType _gst_buffer_type;
  36
  37 /**
  38  * GST_BUFFER_TRACE_NAME:
  39  *
  40  * The name used for tracing memory allocations.
  41  */
  42 #define GST_BUFFER_TRACE_NAME           "GstBuffer"
  43
  44 #define GST_TYPE_BUFFER                         (_gst_buffer_type)
  45 #define GST_IS_BUFFER(obj)                      (GST_IS_MINI_OBJECT_TYPE(obj, GST_TYPE_BUFFER))
  46 #define GST_BUFFER_CAST(obj)                    ((GstBuffer *)(obj))
  47 #define GST_BUFFER(obj)                         (GST_BUFFER_CAST(obj))
  48
  49 /**
  50  * GST_BUFFER_FLAGS:
  51  * @buf: a #GstBuffer.
  52  *
  53  * A flags word containing #GstBufferFlag flags set on this buffer.
  54  */
  55 #define GST_BUFFER_FLAGS(buf)                   GST_MINI_OBJECT_FLAGS(buf)
  56 /**
  57  * GST_BUFFER_FLAG_IS_SET:
  58  * @buf: a #GstBuffer.
  59  * @flag: the #GstBufferFlag to check.
  60  *
  61  * Gives the status of a specific flag on a buffer.
  62  */
  63 #define GST_BUFFER_FLAG_IS_SET(buf,flag)        GST_MINI_OBJECT_FLAG_IS_SET (buf, flag)
  64 /**
  65  * GST_BUFFER_FLAG_SET:
  66  * @buf: a #GstBuffer.
  67  * @flag: the #GstBufferFlag to set.
  68  *
  69  * Sets a buffer flag on a buffer.
  70  */
  71 #define GST_BUFFER_FLAG_SET(buf,flag)           GST_MINI_OBJECT_FLAG_SET (buf, flag)
  72 /**
  73  * GST_BUFFER_FLAG_UNSET:
  74  * @buf: a #GstBuffer.
  75  * @flag: the #GstBufferFlag to clear.
  76  *
  77  * Clears a buffer flag.
  78  */
  79 #define GST_BUFFER_FLAG_UNSET(buf,flag)         GST_MINI_OBJECT_FLAG_UNSET (buf, flag)
  80
  81 /**
  82  * GST_BUFFER_DATA:
  83  * @buf: a #GstBuffer.
  84  *
  85  * A pointer to the data element of this buffer.
  86  */
  87 #define GST_BUFFER_DATA(buf)                    (GST_BUFFER_CAST(buf)->data)
  88 /**
  89  * GST_BUFFER_SIZE:
  90  * @buf: a #GstBuffer.
  91  *
  92  * The size in bytes of the data in this buffer.
  93  */
  94 #define GST_BUFFER_SIZE(buf)                    (GST_BUFFER_CAST(buf)->size)
  95 /**
  96  * GST_BUFFER_TIMESTAMP:
  97  * @buf: a #GstBuffer.:
  98  *
  99  * The timestamp in nanoseconds (as a #GstClockTime) of the data in the buffer.
 100  * Value will be %GST_CLOCK_TIME_NONE if the timestamp is unknown.
 101  *
 102  */
 103 #define GST_BUFFER_TIMESTAMP(buf)               (GST_BUFFER_CAST(buf)->timestamp)
 104 /**
 105  * GST_BUFFER_DURATION:
 106  * @buf: a #GstBuffer.
 107  *
 108  * The duration in nanoseconds (as a #GstClockTime) of the data in the buffer.
 109  * Value will be %GST_CLOCK_TIME_NONE if the duration is unknown.
 110  */
 111 #define GST_BUFFER_DURATION(buf)                (GST_BUFFER_CAST(buf)->duration)
 112 /**
 113  * GST_BUFFER_CAPS:
 114  * @buf: a #GstBuffer.
 115  *
 116  * The caps for this buffer.
 117  */
 118 #define GST_BUFFER_CAPS(buf)                    (GST_BUFFER_CAST(buf)->caps)
 119 /**
 120  * GST_BUFFER_OFFSET:
 121  * @buf: a #GstBuffer.
 122  *
 123  * The offset in the source file of the beginning of this buffer.
 124  */
 125 #define GST_BUFFER_OFFSET(buf)                  (GST_BUFFER_CAST(buf)->offset)
 126 /**
 127  * GST_BUFFER_OFFSET_END:
 128  * @buf: a #GstBuffer.
 129  *
 130  * The offset in the source file of the end of this buffer.
 131  */
 132 #define GST_BUFFER_OFFSET_END(buf)              (GST_BUFFER_CAST(buf)->offset_end)
 133 /**
 134  * GST_BUFFER_MALLOCDATA:
 135  * @buf: a #GstBuffer.
 136  *
 137  * A pointer to any data allocated for this buffer using g_malloc(). If this is
 138  * non-NULL, this memory will be freed at the end of the buffer's lifecycle
 139  * (i.e. when its refcount becomes zero).
 140  */
 141 #define GST_BUFFER_MALLOCDATA(buf)              (GST_BUFFER_CAST(buf)->malloc_data)
 142 /**
 143  * GST_BUFFER_FREE_FUNC:
 144  * @buf: a #GstBuffer.
 145  *
 146  * A pointer to a function that will be called on the buffer's malloc_data when
 147  * this buffer is finalized. Defaults to g_free().
 148  *
 149  * Note that the free function only affects the buffer's malloc_data; if the
 150  * buffer's malloc_data is %NULL, the function will not be called.
 151  *
 152  * Since: 0.10.22
 153  */
 154 #define GST_BUFFER_FREE_FUNC(buf)               (GST_BUFFER_CAST(buf)->free_func)
 155
 156 /**
 157  * GST_BUFFER_OFFSET_NONE:
 158  *
 159  * Constant for no-offset return results.
 160  */
 161 #define GST_BUFFER_OFFSET_NONE  ((guint64)-1)
 162
 163 /**
 164  * GST_BUFFER_DURATION_IS_VALID:
 165  * @buffer: a #GstBuffer
 166  *
 167  * Tests if the duration is known.
 168  */
 169 #define GST_BUFFER_DURATION_IS_VALID(buffer)    (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DURATION (buffer)))
 170 /**
 171  * GST_BUFFER_TIMESTAMP_IS_VALID:
 172  * @buffer: a #GstBuffer
 173  *
 174  * Tests if the timestamp is known.
 175  */
 176 #define GST_BUFFER_TIMESTAMP_IS_VALID(buffer)   (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_TIMESTAMP (buffer)))
 177 /**
 178  * GST_BUFFER_OFFSET_IS_VALID:
 179  * @buffer: a #GstBuffer
 180  *
 181  * Tests if the start offset is known.
 182  */
 183 #define GST_BUFFER_OFFSET_IS_VALID(buffer)      (GST_BUFFER_OFFSET (buffer) != GST_BUFFER_OFFSET_NONE)
 184 /**
 185  * GST_BUFFER_OFFSET_END_IS_VALID:
 186  * @buffer: a #GstBuffer
 187  *
 188  * Tests if the end offset is known.
 189  */
 190 #define GST_BUFFER_OFFSET_END_IS_VALID(buffer)  (GST_BUFFER_OFFSET_END (buffer) != GST_BUFFER_OFFSET_NONE)
 191 /**
 192  * GST_BUFFER_IS_DISCONT:
 193  * @buffer: a #GstBuffer
 194  *
 195  * Tests if the buffer marks a discontinuity in the stream.
 196  *
 197  * Since: 0.10.9
 198  */
 199 #define GST_BUFFER_IS_DISCONT(buffer)   (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DISCONT))
 200
 201 /**
 202  * GstBufferFlag:
 203  * @GST_BUFFER_FLAG_READONLY: the buffer is read-only. This means the data of
 204  * the buffer should not be modified. The metadata might still be modified.
 205  * @GST_BUFFER_FLAG_PREROLL: the buffer is part of a preroll and should not be
 206  * displayed.
 207  * @GST_BUFFER_FLAG_DISCONT: the buffer marks a discontinuity in the stream.
 208  * This typically occurs after a seek or a dropped buffer from a live or
 209  * network source.
 210  * @GST_BUFFER_FLAG_IN_CAPS: the buffer has been added as a field in a #GstCaps.
 211  * @GST_BUFFER_FLAG_GAP: the buffer has been created to fill a gap in the
 212  * stream and contains media neutral data (elements can switch to optimized code
 213  * path that ignores the buffer content).
 214  * @GST_BUFFER_FLAG_DELTA_UNIT: this unit cannot be decoded independently.
 215  * @GST_BUFFER_FLAG_MEDIA1: a flag whose use is specific to the caps of the buffer. Since: 0.10.23.
 216  * @GST_BUFFER_FLAG_MEDIA2: a flag whose use is specific to the caps of the buffer. Since: 0.10.23.
 217  * @GST_BUFFER_FLAG_MEDIA3: a flag whose use is specific to the caps of the buffer. Since: 0.10.23.
 218  * @GST_BUFFER_FLAG_MEDIA4: a flag whose use is specific to the caps of the buffer. Since: 0.10.33.
 219  * @GST_BUFFER_FLAG_LAST: additional flags can be added starting from this flag.
 220  *
 221  * A set of buffer flags used to describe properties of a #GstBuffer.
 222  */
 223 typedef enum {
 224   GST_BUFFER_FLAG_READONLY   = GST_MINI_OBJECT_FLAG_READONLY,
 225   GST_BUFFER_FLAG_PREROLL    = (GST_MINI_OBJECT_FLAG_LAST << 0),
 226   GST_BUFFER_FLAG_DISCONT    = (GST_MINI_OBJECT_FLAG_LAST << 1),
 227   GST_BUFFER_FLAG_IN_CAPS    = (GST_MINI_OBJECT_FLAG_LAST << 2),
 228   GST_BUFFER_FLAG_GAP        = (GST_MINI_OBJECT_FLAG_LAST << 3),
 229   GST_BUFFER_FLAG_DELTA_UNIT = (GST_MINI_OBJECT_FLAG_LAST << 4),
 230   GST_BUFFER_FLAG_MEDIA1     = (GST_MINI_OBJECT_FLAG_LAST << 5),
 231   GST_BUFFER_FLAG_MEDIA2     = (GST_MINI_OBJECT_FLAG_LAST << 6),
 232   GST_BUFFER_FLAG_MEDIA3     = (GST_MINI_OBJECT_FLAG_LAST << 7),
 233   GST_BUFFER_FLAG_MEDIA4     = (GST_MINI_OBJECT_FLAG_LAST << 8),
 234   GST_BUFFER_FLAG_LAST       = (GST_MINI_OBJECT_FLAG_LAST << 16)
 235 } GstBufferFlag;
 236
 237 /**
 238  * GstBuffer:
 239  * @mini_object: the parent structure
 240  * @data: pointer to the buffer data
 241  * @size: size of buffer data
 242  * @timestamp: timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
 243  *     timestamp is not known or relevant.
 244  * @duration: duration in time of the buffer data, can be #GST_CLOCK_TIME_NONE
 245  *     when the duration is not known or relevant.
 246  * @caps: the #GstCaps describing the data format in this buffer
 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  * @malloc_data: a pointer to the allocated memory associated with this buffer.
 255  *     When the buffer is freed, this data will freed with @free_func.
 256  * @free_func: a custom function that will be called with @malloc_data, defaults
 257  *     to g_free(). Since 0.10.22.
 258  * @parent: the parent buffer if this is a subbuffer. Since 0.10.26.
 259  *
 260  * The structure of a #GstBuffer. Use the associated macros to access the public
 261  * variables.
 262  */
 263 struct _GstBuffer {
 264   GstMiniObject          mini_object;
 265
 266   /*< public >*/ /* with COW */
 267   /* pointer to data and its size */
 268   guint8                *data;
 269   guint                  size;
 270
 271   /* timestamp */
 272   GstClockTime           timestamp;
 273   GstClockTime           duration;
 274
 275   /* the media type of this buffer */
 276   GstCaps               *caps;
 277
 278   /* media specific offset */
 279   guint64                offset;
 280   guint64                offset_end;
 281
 282   guint8                *malloc_data;
 283
 284   /* ABI Added */
 285   GFreeFunc              free_func;
 286   GstBuffer             *parent;
 287   gpointer               priv;
 288
 289   gpointer               owner_priv;
 290 };
 291
 292 /* allocation */
 293 GstBuffer * gst_buffer_new               (void);
 294 GstBuffer * gst_buffer_new_and_alloc     (guint size);
 295 GstBuffer * gst_buffer_try_new_and_alloc (guint size);
 296
 297 /**
 298  * gst_buffer_set_data:
 299  * @buf: a #GstBuffer
 300  * @data: The data (a #guint8 *) to set on the buffer.
 301  * @size: The size (in bytes, as a #guint) of the data being set.
 302  *
 303  * A convenience function to set the data and size on a buffer.
 304  * This will replace any existing data pointer set on this buffer, but will
 305  * not change GST_BUFFER_MALLOCDATA(), if any. Callers should ensure that
 306  * GST_BUFFER_MALLOCDATA() is non-NULL, or should free that and set it to NULL.
 307  *
 308  * No checks are done on the data or size arguments passed.
 309  */
 310 #define         gst_buffer_set_data(buf, data, size)    \
 311 G_STMT_START {                                          \
 312   GST_BUFFER_DATA (buf) = data;                         \
 313   GST_BUFFER_SIZE (buf) = size;                         \
 314 } G_STMT_END
 315
 316 /* refcounting */
 317 /**
 318  * gst_buffer_ref:
 319  * @buf: a #GstBuffer.
 320  *
 321  * Increases the refcount of the given buffer by one.
 322  *
 323  * Note that the refcount affects the writeability
 324  * of @buf and its metadata, see gst_buffer_is_writable() and
 325  * gst_buffer_is_metadata_writable(). It is
 326  * important to note that keeping additional references to
 327  * GstBuffer instances can potentially increase the number
 328  * of memcpy operations in a pipeline.
 329  *
 330  * Returns: (transfer full): @buf
 331  */
 332 #ifdef _FOOL_GTK_DOC_
 333 G_INLINE_FUNC GstBuffer * gst_buffer_ref (GstBuffer * buf);
 334 #endif
 335
 336 static inline GstBuffer *
 337 gst_buffer_ref (GstBuffer * buf)
 338 {
 339   return (GstBuffer *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (buf));
 340 }
 341
 342 /**
 343  * gst_buffer_unref:
 344  * @buf: (transfer full): a #GstBuffer.
 345  *
 346  * Decreases the refcount of the buffer. If the refcount reaches 0, the buffer
 347  * will be freed. If GST_BUFFER_MALLOCDATA() is non-NULL, this pointer will
 348  * also be freed at this time.
 349  */
 350 #ifdef _FOOL_GTK_DOC_
 351 G_INLINE_FUNC void gst_buffer_unref (GstBuffer * buf);
 352 #endif
 353
 354 static inline void
 355 gst_buffer_unref (GstBuffer * buf)
 356 {
 357   gst_mini_object_unref (GST_MINI_OBJECT_CAST (buf));
 358 }
 359
 360 /* copy buffer */
 361 /**
 362  * gst_buffer_copy:
 363  * @buf: a #GstBuffer.
 364  *
 365  * Create a copy of the given buffer. This will also make a newly allocated
 366  * copy of the data the source buffer contains.
 367  *
 368  * Returns: (transfer full): a new copy of @buf.
 369  */
 370 #ifdef _FOOL_GTK_DOC_
 371 G_INLINE_FUNC GstBuffer * gst_buffer_copy (const GstBuffer * buf);
 372 #endif
 373
 374 static inline GstBuffer *
 375 gst_buffer_copy (const GstBuffer * buf)
 376 {
 377   return GST_BUFFER (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (buf)));
 378 }
 379
 380
 381 /**
 382  * GstBufferCopyFlags:
 383  * @GST_BUFFER_COPY_FLAGS: flag indicating that buffer flags should be copied
 384  * @GST_BUFFER_COPY_TIMESTAMPS: flag indicating that buffer timestamp, duration,
 385  * offset and offset_end should be copied
 386  * @GST_BUFFER_COPY_CAPS: flag indicating that buffer caps should be copied
 387  *
 388  * A set of flags that can be provided to the gst_buffer_copy_metadata()
 389  * function to specify which metadata fields should be copied.
 390  *
 391  * Since: 0.10.13
 392  */
 393 typedef enum {
 394   GST_BUFFER_COPY_FLAGS      = (1 << 0),
 395   GST_BUFFER_COPY_TIMESTAMPS = (1 << 1),
 396   GST_BUFFER_COPY_CAPS       = (1 << 2)
 397 } GstBufferCopyFlags;
 398
 399 /**
 400  * GST_BUFFER_COPY_ALL:
 401  *
 402  * Combination of all possible fields that can be copied with
 403  * gst_buffer_copy_metadata().
 404  *
 405  * Since: 0.10.13
 406  */
 407 #define GST_BUFFER_COPY_ALL (GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS | GST_BUFFER_COPY_CAPS)
 408
 409 /* copies metadata into newly allocated buffer */
 410 void            gst_buffer_copy_metadata        (GstBuffer *dest, const GstBuffer *src,
 411                                                  GstBufferCopyFlags flags);
 412
 413 /**
 414  * gst_buffer_is_writable:
 415  * @buf: a #GstBuffer
 416  *
 417  * Tests if you can safely write data into a buffer's data array or validly
 418  * modify the caps and timestamp metadata. Metadata in a GstBuffer is always
 419  * writable, but it is only safe to change it when there is only one owner
 420  * of the buffer - ie, the refcount is 1.
 421  */
 422 #define         gst_buffer_is_writable(buf)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (buf))
 423 /**
 424  * gst_buffer_make_writable:
 425  * @buf: (transfer full): a #GstBuffer
 426  *
 427  * Makes a writable buffer from the given buffer. If the source buffer is
 428  * already writable, this will simply return the same buffer. A copy will
 429  * otherwise be made using gst_buffer_copy().
 430  *
 431  * Returns: (transfer full): a writable buffer which may or may not be the
 432  *     same as @buf
 433  */
 434 #define         gst_buffer_make_writable(buf)   GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (buf)))
 435
 436 /* Ensure that the metadata of the buffer is writable, even if the buffer data
 437  * isn't */
 438 gboolean        gst_buffer_is_metadata_writable (GstBuffer *buf);
 439 GstBuffer*      gst_buffer_make_metadata_writable (GstBuffer *buf);
 440
 441 /**
 442  * gst_buffer_replace:
 443  * @obuf: (inout) (transfer full): pointer to a pointer to a #GstBuffer to be
 444  *     replaced.
 445  * @nbuf: (transfer none) (allow-none): pointer to a #GstBuffer that will
 446  *     replace the buffer pointed to by @obuf.
 447  *
 448  * Modifies a pointer to a #GstBuffer to point to a different #GstBuffer. The
 449  * modification is done atomically (so this is useful for ensuring thread safety
 450  * in some cases), and the reference counts are updated appropriately (the old
 451  * buffer is unreffed, the new is reffed).
 452  *
 453  * Either @nbuf or the #GstBuffer pointed to by @obuf may be NULL.
 454  */
 455 #define         gst_buffer_replace(obuf,nbuf) \
 456 G_STMT_START {                                                                \
 457   GstBuffer **___obufaddr = (GstBuffer **)(obuf);         \
 458   gst_mini_object_replace ((GstMiniObject **)___obufaddr, \
 459       GST_MINI_OBJECT_CAST (nbuf));                       \
 460 } G_STMT_END
 461
 462 GstCaps*        gst_buffer_get_caps             (GstBuffer *buffer);
 463 void            gst_buffer_set_caps             (GstBuffer *buffer, GstCaps *caps);
 464
 465 /* creating a subbuffer */
 466 GstBuffer*      gst_buffer_create_sub           (GstBuffer *parent, guint offset, guint size);
 467
 468 /* span, two buffers, intelligently */
 469 gboolean        gst_buffer_is_span_fast         (GstBuffer *buf1, GstBuffer *buf2);
 470 GstBuffer*      gst_buffer_span                 (GstBuffer *buf1, guint32 offset, GstBuffer *buf2, guint32 len);
 471
 472 /* metadata */
 473 #include <gst/gstmeta.h>
 474
 475 GstMeta *       gst_buffer_get_meta_by_api      (GstBuffer *buffer, GQuark api);
 476
 477 GstMeta *       gst_buffer_get_meta             (GstBuffer *buffer, const GstMetaInfo *info, gboolean create);
 478 gboolean        gst_buffer_remove_meta          (GstBuffer *buffer, GstMeta *meta);
 479
 480 GstMeta *       gst_buffer_iterate_meta         (GstBuffer *buffer, gpointer *state);
 481
 482 /**
 483  * gst_value_set_buffer:
 484  * @v: a #GValue to receive the data
 485  * @b: (transfer none): a #GstBuffer to assign to the GstValue
 486  *
 487  * Sets @b as the value of @v.  Caller retains reference to buffer.
 488  */
 489 #define         gst_value_set_buffer(v,b)       g_value_set_boxed((v),(b))
 490 /**
 491  * gst_value_take_buffer:
 492  * @v: a #GValue to receive the data
 493  * @b: (transfer full): a #GstBuffer to assign to the GstValue
 494  *
 495  * Sets @b as the value of @v.  Caller gives away reference to buffer.
 496  */
 497 #define         gst_value_take_buffer(v,b)      g_value_take_boxed(v,(b))
 498 /**
 499  * gst_value_get_buffer:
 500  * @v: a #GValue to query
 501  *
 502  * Receives a #GstBuffer as the value of @v. Does not return a reference to
 503  * the buffer, so the pointer is only valid for as long as the caller owns
 504  * a reference to @v.
 505  *
 506  * Returns: (transfer none): buffer
 507  */
 508 #define         gst_value_get_buffer(v)         GST_BUFFER_CAST (g_value_get_boxed(v))
 509
 510 G_END_DECLS
 511
 512 #endif /* __GST_BUFFER_H__ */