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 #include <gst/gstmemory.h>
  31
  32 G_BEGIN_DECLS
  33
  34 extern GType _gst_buffer_type;
  35
  36 typedef struct _GstBuffer GstBuffer;
  37 typedef struct _GstBufferPool GstBufferPool;
  38
  39 /**
  40  * GST_BUFFER_TRACE_NAME:
  41  *
  42  * The name used for tracing memory allocations.
  43  */
  44 #define GST_BUFFER_TRACE_NAME           "GstBuffer"
  45
  46 #define GST_TYPE_BUFFER                         (_gst_buffer_type)
  47 #define GST_IS_BUFFER(obj)                      (GST_IS_MINI_OBJECT_TYPE(obj, GST_TYPE_BUFFER))
  48 #define GST_BUFFER_CAST(obj)                    ((GstBuffer *)(obj))
  49 #define GST_BUFFER(obj)                         (GST_BUFFER_CAST(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_OFFSET:
 116  * @buf: a #GstBuffer.
 117  *
 118  * The offset in the source file of the beginning of this buffer.
 119  */
 120 #define GST_BUFFER_OFFSET(buf)                  (GST_BUFFER_CAST(buf)->offset)
 121 /**
 122  * GST_BUFFER_OFFSET_END:
 123  * @buf: a #GstBuffer.
 124  *
 125  * The offset in the source file of the end of this buffer.
 126  */
 127 #define GST_BUFFER_OFFSET_END(buf)              (GST_BUFFER_CAST(buf)->offset_end)
 128 /**
 129  * GST_BUFFER_MALLOCDATA:
 130  * @buf: a #GstBuffer.
 131  *
 132  * A pointer to any data allocated for this buffer using g_malloc(). If this is
 133  * non-NULL, this memory will be freed at the end of the buffer's lifecycle
 134  * (i.e. when its refcount becomes zero).
 135  */
 136 #define GST_BUFFER_MALLOCDATA(buf)              (GST_BUFFER_CAST(buf)->malloc_data)
 137 /**
 138  * GST_BUFFER_FREE_FUNC:
 139  * @buf: a #GstBuffer.
 140  *
 141  * A pointer to a function that will be called on the buffer's malloc_data when
 142  * this buffer is finalized. Defaults to g_free().
 143  *
 144  * Note that the free function only affects the buffer's malloc_data; if the
 145  * buffer's malloc_data is %NULL, the function will not be called.
 146  *
 147  * Since: 0.10.22
 148  */
 149 #define GST_BUFFER_FREE_FUNC(buf)               (GST_BUFFER_CAST(buf)->free_func)
 150
 151 /**
 152  * GST_BUFFER_OFFSET_NONE:
 153  *
 154  * Constant for no-offset return results.
 155  */
 156 #define GST_BUFFER_OFFSET_NONE  ((guint64)-1)
 157
 158 /**
 159  * GST_BUFFER_DURATION_IS_VALID:
 160  * @buffer: a #GstBuffer
 161  *
 162  * Tests if the duration is known.
 163  */
 164 #define GST_BUFFER_DURATION_IS_VALID(buffer)    (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DURATION (buffer)))
 165 /**
 166  * GST_BUFFER_TIMESTAMP_IS_VALID:
 167  * @buffer: a #GstBuffer
 168  *
 169  * Tests if the timestamp is known.
 170  */
 171 #define GST_BUFFER_TIMESTAMP_IS_VALID(buffer)   (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_TIMESTAMP (buffer)))
 172 /**
 173  * GST_BUFFER_OFFSET_IS_VALID:
 174  * @buffer: a #GstBuffer
 175  *
 176  * Tests if the start offset is known.
 177  */
 178 #define GST_BUFFER_OFFSET_IS_VALID(buffer)      (GST_BUFFER_OFFSET (buffer) != GST_BUFFER_OFFSET_NONE)
 179 /**
 180  * GST_BUFFER_OFFSET_END_IS_VALID:
 181  * @buffer: a #GstBuffer
 182  *
 183  * Tests if the end offset is known.
 184  */
 185 #define GST_BUFFER_OFFSET_END_IS_VALID(buffer)  (GST_BUFFER_OFFSET_END (buffer) != GST_BUFFER_OFFSET_NONE)
 186 /**
 187  * GST_BUFFER_IS_DISCONT:
 188  * @buffer: a #GstBuffer
 189  *
 190  * Tests if the buffer marks a discontinuity in the stream.
 191  *
 192  * Since: 0.10.9
 193  */
 194 #define GST_BUFFER_IS_DISCONT(buffer)   (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DISCONT))
 195
 196 /**
 197  * GstBufferFlag:
 198  * the buffer should not be modified. The metadata might still be modified.
 199  * @GST_BUFFER_FLAG_PREROLL: the buffer is part of a preroll and should not be
 200  * displayed.
 201  * @GST_BUFFER_FLAG_DISCONT: the buffer marks a discontinuity in the stream.
 202  * This typically occurs after a seek or a dropped buffer from a live or
 203  * network source.
 204  * @GST_BUFFER_FLAG_IN_CAPS: the buffer has been added as a field in a #GstCaps.
 205  * @GST_BUFFER_FLAG_GAP: the buffer has been created to fill a gap in the
 206  * stream and contains media neutral data (elements can switch to optimized code
 207  * path that ignores the buffer content).
 208  * @GST_BUFFER_FLAG_DELTA_UNIT: this unit cannot be decoded independently.
 209  * @GST_BUFFER_FLAG_MEDIA1: a flag whose use is specific to the caps of the buffer. Since: 0.10.23.
 210  * @GST_BUFFER_FLAG_MEDIA2: a flag whose use is specific to the caps of the buffer. Since: 0.10.23.
 211  * @GST_BUFFER_FLAG_MEDIA3: a flag whose use is specific to the caps of the buffer. Since: 0.10.23.
 212  * @GST_BUFFER_FLAG_MEDIA4: a flag whose use is specific to the caps of the buffer. Since: 0.10.33.
 213  * @GST_BUFFER_FLAG_LAST: additional flags can be added starting from this flag.
 214  *
 215  * A set of buffer flags used to describe properties of a #GstBuffer.
 216  */
 217 typedef enum {
 218   GST_BUFFER_FLAG_PREROLL    = (GST_MINI_OBJECT_FLAG_LAST << 0),
 219   GST_BUFFER_FLAG_DISCONT    = (GST_MINI_OBJECT_FLAG_LAST << 1),
 220   GST_BUFFER_FLAG_IN_CAPS    = (GST_MINI_OBJECT_FLAG_LAST << 2),
 221   GST_BUFFER_FLAG_GAP        = (GST_MINI_OBJECT_FLAG_LAST << 3),
 222   GST_BUFFER_FLAG_DELTA_UNIT = (GST_MINI_OBJECT_FLAG_LAST << 4),
 223   GST_BUFFER_FLAG_MEDIA1     = (GST_MINI_OBJECT_FLAG_LAST << 5),
 224   GST_BUFFER_FLAG_MEDIA2     = (GST_MINI_OBJECT_FLAG_LAST << 6),
 225   GST_BUFFER_FLAG_MEDIA3     = (GST_MINI_OBJECT_FLAG_LAST << 7),
 226   GST_BUFFER_FLAG_MEDIA4     = (GST_MINI_OBJECT_FLAG_LAST << 8),
 227   GST_BUFFER_FLAG_LAST       = (GST_MINI_OBJECT_FLAG_LAST << 16)
 228 } GstBufferFlag;
 229
 230 /**
 231  * GstBuffer:
 232  * @mini_object: the parent structure
 233  * @pool: pointer to the pool owner of the buffer
 234  * @caps: the #GstCaps describing the data format in this buffer
 235  * @timestamp: timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
 236  *     timestamp is not known or relevant.
 237  * @duration: duration in time of the buffer data, can be #GST_CLOCK_TIME_NONE
 238  *     when the duration is not known or relevant.
 239  * @offset: a media specific offset for the buffer data.
 240  *     For video frames, this is the frame number of this buffer.
 241  *     For audio samples, this is the offset of the first sample in this buffer.
 242  *     For file data or compressed data this is the byte offset of the first
 243  *       byte in this buffer.
 244  * @offset_end: the last offset contained in this buffer. It has the same
 245  *     format as @offset.
 246  *
 247  * The structure of a #GstBuffer. Use the associated macros to access the public
 248  * variables.
 249  */
 250 struct _GstBuffer {
 251   GstMiniObject          mini_object;
 252
 253   /*< public >*/ /* with COW */
 254   GstBufferPool         *pool;
 255
 256   /* timestamp */
 257   GstClockTime           timestamp;
 258   GstClockTime           duration;
 259
 260   /* media specific offset */
 261   guint64                offset;
 262   guint64                offset_end;
 263 };
 264
 265 /* allocation */
 266 GstBuffer * gst_buffer_new                 (void);
 267 GstBuffer * gst_buffer_new_and_alloc       (guint size);
 268
 269 /* memory blocks */
 270 guint       gst_buffer_n_memory            (GstBuffer *buffer);
 271 void        gst_buffer_take_memory         (GstBuffer *buffer, GstMemory *mem);
 272 GstMemory * gst_buffer_peek_memory         (GstBuffer *buffer, guint idx, GstMapFlags flags);
 273 void        gst_buffer_remove_memory_range (GstBuffer *buffer, guint idx, guint length);
 274
 275 /**
 276  * gst_buffer_remove_memory:
 277  * @b: a #GstBuffer.
 278  * @i: an index
 279  *
 280  * Remove the memory block in @b at @i.
 281  */
 282 #define     gst_buffer_remove_memory(b,i)  gst_buffer_remove_memory_range ((b), (i), 1)
 283
 284 void        gst_buffer_fill                (GstBuffer *buffer, gsize offset,
 285                                             gconstpointer src, gsize size);
 286 void        gst_buffer_extract             (GstBuffer *buffer, gsize offset,
 287                                             gpointer dest, gsize size);
 288 gint        gst_buffer_memcmp              (GstBuffer *buffer, gsize offset,
 289                                             gconstpointer mem, gsize size);
 290
 291 gsize       gst_buffer_get_size            (GstBuffer *buffer);
 292 void        gst_buffer_resize              (GstBuffer *buffer, gsize offset, gsize size);
 293
 294 /**
 295  * gst_buffer_remove_memory:
 296  * @b: a #GstBuffer.
 297  * @s: a new size
 298  *
 299  * Set the size of @b to @s. This will remove or trim the memory blocks
 300  * in the buffer.
 301  */
 302 #define     gst_buffer_set_size(b,s)       gst_buffer_resize ((b), 0, (s))
 303
 304 /* getting memory */
 305 gpointer    gst_buffer_map                 (GstBuffer *buffer, gsize *size, gsize *maxsize,
 306                                             GstMapFlags flags);
 307 gboolean    gst_buffer_unmap               (GstBuffer *buffer, gpointer data, gsize size);
 308
 309 /* refcounting */
 310 /**
 311  * gst_buffer_ref:
 312  * @buf: a #GstBuffer.
 313  *
 314  * Increases the refcount of the given buffer by one.
 315  *
 316  * Note that the refcount affects the writeability
 317  * of @buf and its metadata, see gst_buffer_is_writable() and
 318  * gst_buffer_is_metadata_writable(). It is
 319  * important to note that keeping additional references to
 320  * GstBuffer instances can potentially increase the number
 321  * of memcpy operations in a pipeline.
 322  *
 323  * Returns: (transfer full): @buf
 324  */
 325 #ifdef _FOOL_GTK_DOC_
 326 G_INLINE_FUNC GstBuffer * gst_buffer_ref (GstBuffer * buf);
 327 #endif
 328
 329 static inline GstBuffer *
 330 gst_buffer_ref (GstBuffer * buf)
 331 {
 332   return (GstBuffer *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (buf));
 333 }
 334
 335 /**
 336  * gst_buffer_unref:
 337  * @buf: (transfer full): a #GstBuffer.
 338  *
 339  * Decreases the refcount of the buffer. If the refcount reaches 0, the buffer
 340  * will be freed. If GST_BUFFER_MALLOCDATA() is non-NULL, this pointer will
 341  * also be freed at this time.
 342  */
 343 #ifdef _FOOL_GTK_DOC_
 344 G_INLINE_FUNC void gst_buffer_unref (GstBuffer * buf);
 345 #endif
 346
 347 static inline void
 348 gst_buffer_unref (GstBuffer * buf)
 349 {
 350   gst_mini_object_unref (GST_MINI_OBJECT_CAST (buf));
 351 }
 352
 353 /* copy buffer */
 354 /**
 355  * gst_buffer_copy:
 356  * @buf: a #GstBuffer.
 357  *
 358  * Create a copy of the given buffer. This will also make a newly allocated
 359  * copy of the data the source buffer contains.
 360  *
 361  * Returns: (transfer full): a new copy of @buf.
 362  */
 363 #ifdef _FOOL_GTK_DOC_
 364 G_INLINE_FUNC GstBuffer * gst_buffer_copy (const GstBuffer * buf);
 365 #endif
 366
 367 static inline GstBuffer *
 368 gst_buffer_copy (const GstBuffer * buf)
 369 {
 370   return GST_BUFFER (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (buf)));
 371 }
 372
 373
 374 /**
 375  * GstBufferCopyFlags:
 376  * @GST_BUFFER_COPY_NONE: copy nothing
 377  * @GST_BUFFER_COPY_FLAGS: flag indicating that buffer flags should be copied
 378  * @GST_BUFFER_COPY_TIMESTAMPS: flag indicating that buffer timestamp, duration,
 379  * offset and offset_end should be copied
 380  * @GST_BUFFER_COPY_MEMORY: flag indicating that buffer memory should be copied
 381  * and appended to already existing memory
 382  * @GST_BUFFER_COPY_MERGE: flag indicating that buffer memory should be
 383  * merged
 384  *
 385  * A set of flags that can be provided to the gst_buffer_copy_into()
 386  * function to specify which items should be copied.
 387  */
 388 typedef enum {
 389   GST_BUFFER_COPY_NONE           = 0,
 390   GST_BUFFER_COPY_FLAGS          = (1 << 0),
 391   GST_BUFFER_COPY_TIMESTAMPS     = (1 << 1),
 392   GST_BUFFER_COPY_MEMORY         = (1 << 2),
 393   GST_BUFFER_COPY_MERGE          = (1 << 3)
 394 } GstBufferCopyFlags;
 395
 396 /**
 397  * GST_BUFFER_COPY_METADATA:
 398  *
 399  * Combination of all possible metadata fields that can be copied with
 400  * gst_buffer_copy_into().
 401  */
 402 #define GST_BUFFER_COPY_METADATA       (GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS)
 403
 404 /**
 405  * GST_BUFFER_COPY_ALL:
 406  *
 407  * Combination of all possible fields that can be copied with
 408  * gst_buffer_copy_into().
 409  */
 410 #define GST_BUFFER_COPY_ALL  (GST_BUFFER_COPY_METADATA | GST_BUFFER_COPY_MEMORY)
 411
 412 /* copies memory or metadata into newly allocated buffer */
 413 void            gst_buffer_copy_into            (GstBuffer *dest, GstBuffer *src,
 414                                                  GstBufferCopyFlags flags,
 415                                                  gsize offset, gsize size);
 416
 417 /**
 418  * gst_buffer_is_writable:
 419  * @buf: a #GstBuffer
 420  *
 421  * Tests if you can safely write data into a buffer's data array or validly
 422  * modify the caps and timestamp metadata. Metadata in a GstBuffer is always
 423  * writable, but it is only safe to change it when there is only one owner
 424  * of the buffer - ie, the refcount is 1.
 425  */
 426 #define         gst_buffer_is_writable(buf)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (buf))
 427 /**
 428  * gst_buffer_make_writable:
 429  * @buf: (transfer full): a #GstBuffer
 430  *
 431  * Makes a writable buffer from the given buffer. If the source buffer is
 432  * already writable, this will simply return the same buffer. A copy will
 433  * otherwise be made using gst_buffer_copy().
 434  *
 435  * Returns: (transfer full): a writable buffer which may or may not be the
 436  *     same as @buf
 437  */
 438 #define         gst_buffer_make_writable(buf)   GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (buf)))
 439
 440 /**
 441  * gst_buffer_replace:
 442  * @obuf: (inout) (transfer full): pointer to a pointer to a #GstBuffer to be
 443  *     replaced.
 444  * @nbuf: (transfer none) (allow-none): pointer to a #GstBuffer that will
 445  *     replace the buffer pointed to by @obuf.
 446  *
 447  * Modifies a pointer to a #GstBuffer to point to a different #GstBuffer. The
 448  * modification is done atomically (so this is useful for ensuring thread safety
 449  * in some cases), and the reference counts are updated appropriately (the old
 450  * buffer is unreffed, the new is reffed).
 451  *
 452  * Either @nbuf or the #GstBuffer pointed to by @obuf may be NULL.
 453  */
 454 #define         gst_buffer_replace(obuf,nbuf) \
 455 G_STMT_START {                                                                \
 456   GstBuffer **___obufaddr = (GstBuffer **)(obuf);         \
 457   gst_mini_object_replace ((GstMiniObject **)___obufaddr, \
 458       GST_MINI_OBJECT_CAST (nbuf));                       \
 459 } G_STMT_END
 460
 461 /* creating a region */
 462 GstBuffer*      gst_buffer_copy_region          (GstBuffer *parent, GstBufferCopyFlags flags,
 463                                                  gsize offset, gsize size);
 464
 465 /* span, two buffers, intelligently */
 466 gboolean        gst_buffer_is_span_fast         (GstBuffer *buf1, GstBuffer *buf2);
 467 GstBuffer*      gst_buffer_span                 (GstBuffer *buf1, gsize offset, GstBuffer *buf2, gsize size);
 468
 469 /* metadata */
 470 #include <gst/gstmeta.h>
 471
 472 GstMeta *       gst_buffer_get_meta             (GstBuffer *buffer, const GstMetaInfo *info);
 473 GstMeta *       gst_buffer_add_meta             (GstBuffer *buffer, const GstMetaInfo *info,
 474                                                  gpointer params);
 475 gboolean        gst_buffer_remove_meta          (GstBuffer *buffer, GstMeta *meta);
 476
 477 GstMeta *       gst_buffer_iterate_meta         (GstBuffer *buffer, gpointer *state);
 478
 479 /**
 480  * gst_value_set_buffer:
 481  * @v: a #GValue to receive the data
 482  * @b: (transfer none): a #GstBuffer to assign to the GstValue
 483  *
 484  * Sets @b as the value of @v.  Caller retains reference to buffer.
 485  */
 486 #define         gst_value_set_buffer(v,b)       g_value_set_boxed((v),(b))
 487 /**
 488  * gst_value_take_buffer:
 489  * @v: a #GValue to receive the data
 490  * @b: (transfer full): a #GstBuffer to assign to the GstValue
 491  *
 492  * Sets @b as the value of @v.  Caller gives away reference to buffer.
 493  */
 494 #define         gst_value_take_buffer(v,b)      g_value_take_boxed(v,(b))
 495 /**
 496  * gst_value_get_buffer:
 497  * @v: a #GValue to query
 498  *
 499  * Receives a #GstBuffer as the value of @v. Does not return a reference to
 500  * the buffer, so the pointer is only valid for as long as the caller owns
 501  * a reference to @v.
 502  *
 503  * Returns: (transfer none): buffer
 504  */
 505 #define         gst_value_get_buffer(v)         GST_BUFFER_CAST (g_value_get_boxed(v))
 506
 507 G_END_DECLS
 508
 509 #endif /* __GST_BUFFER_H__ */