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