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