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