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