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