gstbuffer.h 18 KB
Newer Older
1 2 3 4 5
/* GStreamer
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
 *                    2000 Wim Taymans <wtay@chello.be>
 *
 * gstbuffer.h: Header for GstBuffer object
Erik Walthinsen's avatar
Erik Walthinsen committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */


#ifndef __GST_BUFFER_H__
#define __GST_BUFFER_H__

27
#include <gst/gstminiobject.h>
28
#include <gst/gstclock.h>
29
#include <gst/gstcaps.h>
30

31
G_BEGIN_DECLS
Erik Walthinsen's avatar
Erik Walthinsen committed
32

33
typedef struct _GstBuffer GstBuffer;
34
typedef struct _GstBufferClass GstBufferClass;
35
typedef struct _GstBufferPrivate GstBufferPrivate;
36

37 38 39 40 41
/**
 * GST_BUFFER_TRACE_NAME:
 *
 * The name used for tracing memory allocations.
 */
Wim Taymans's avatar
Wim Taymans committed
42
#define GST_BUFFER_TRACE_NAME           "GstBuffer"
43

Wim Taymans's avatar
Wim Taymans committed
44
#define GST_TYPE_BUFFER                         (gst_buffer_get_type())
45 46 47 48 49
#define GST_IS_BUFFER(obj)                      (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_BUFFER))
#define GST_IS_BUFFER_CLASS(klass)              (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_BUFFER))
#define GST_BUFFER_GET_CLASS(obj)               (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_BUFFER, GstBufferClass))
#define GST_BUFFER(obj)                         (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_BUFFER, GstBuffer))
#define GST_BUFFER_CLASS(klass)                 (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_BUFFER, GstBufferClass))
50
#define GST_BUFFER_CAST(obj)                    ((GstBuffer *)(obj))
51

52 53
/**
 * GST_BUFFER_FLAGS:
54
 * @buf: a #GstBuffer.
55
 *
56
 * A flags word containing #GstBufferFlag flags set on this buffer.
57
 */
58
#define GST_BUFFER_FLAGS(buf)                   GST_MINI_OBJECT_FLAGS(buf)
59 60
/**
 * GST_BUFFER_FLAG_IS_SET:
61
 * @buf: a #GstBuffer.
62 63
 * @flag: the #GstBufferFlag to check.
 *
64
 * Gives the status of a specific flag on a buffer.
65
 */
66
#define GST_BUFFER_FLAG_IS_SET(buf,flag)        GST_MINI_OBJECT_FLAG_IS_SET (buf, flag)
67 68
/**
 * GST_BUFFER_FLAG_SET:
69
 * @buf: a #GstBuffer.
70 71
 * @flag: the #GstBufferFlag to set.
 *
72
 * Sets a buffer flag on a buffer.
73
 */
74
#define GST_BUFFER_FLAG_SET(buf,flag)           GST_MINI_OBJECT_FLAG_SET (buf, flag)
75 76
/**
 * GST_BUFFER_FLAG_UNSET:
77
 * @buf: a #GstBuffer.
78 79 80 81
 * @flag: the #GstBufferFlag to clear.
 *
 * Clears a buffer flag.
 */
82
#define GST_BUFFER_FLAG_UNSET(buf,flag)         GST_MINI_OBJECT_FLAG_UNSET (buf, flag)
83

84 85
/**
 * GST_BUFFER_DATA:
86
 * @buf: a #GstBuffer.
87
 *
88
 * A pointer to the data element of this buffer.
89
 */
Wim Taymans's avatar
Wim Taymans committed
90
#define GST_BUFFER_DATA(buf)                    (GST_BUFFER_CAST(buf)->data)
91 92
/**
 * GST_BUFFER_SIZE:
93
 * @buf: a #GstBuffer.
94
 *
95
 * The size in bytes of the data in this buffer.
96
 */
Wim Taymans's avatar
Wim Taymans committed
97
#define GST_BUFFER_SIZE(buf)                    (GST_BUFFER_CAST(buf)->size)
98 99
/**
 * GST_BUFFER_TIMESTAMP:
100 101 102
 * @buf: a #GstBuffer.:
 *
 * The timestamp in nanoseconds (as a #GstClockTime) of the data in the buffer.
Wim Taymans's avatar
Wim Taymans committed
103
 * Value will be %GST_CLOCK_TIME_NONE if the timestamp is unknown.
104 105
 *
 */
Wim Taymans's avatar
Wim Taymans committed
106
#define GST_BUFFER_TIMESTAMP(buf)               (GST_BUFFER_CAST(buf)->timestamp)
107 108
/**
 * GST_BUFFER_DURATION:
109
 * @buf: a #GstBuffer.
110
 *
111
 * The duration in nanoseconds (as a #GstClockTime) of the data in the buffer.
112 113
 * Value will be %GST_CLOCK_TIME_NONE if the duration is unknown.
 */
Wim Taymans's avatar
Wim Taymans committed
114
#define GST_BUFFER_DURATION(buf)                (GST_BUFFER_CAST(buf)->duration)
115 116
/**
 * GST_BUFFER_CAPS:
117
 * @buf: a #GstBuffer.
118
 *
119
 * The caps for this buffer.
120
 */
Wim Taymans's avatar
Wim Taymans committed
121
#define GST_BUFFER_CAPS(buf)                    (GST_BUFFER_CAST(buf)->caps)
122 123
/**
 * GST_BUFFER_OFFSET:
124
 * @buf: a #GstBuffer.
125
 *
126
 * The offset in the source file of the beginning of this buffer.
127
 */
Wim Taymans's avatar
Wim Taymans committed
128
#define GST_BUFFER_OFFSET(buf)                  (GST_BUFFER_CAST(buf)->offset)
129 130
/**
 * GST_BUFFER_OFFSET_END:
131
 * @buf: a #GstBuffer.
132
 *
133
 * The offset in the source file of the end of this buffer.
134
 */
Wim Taymans's avatar
Wim Taymans committed
135
#define GST_BUFFER_OFFSET_END(buf)              (GST_BUFFER_CAST(buf)->offset_end)
136 137
/**
 * GST_BUFFER_MALLOCDATA:
138
 * @buf: a #GstBuffer.
139
 *
Wim Taymans's avatar
Wim Taymans committed
140 141
 * A pointer to any data allocated for this buffer using g_malloc(). If this is
 * non-NULL, this memory will be freed at the end of the buffer's lifecycle
142
 * (i.e. when its refcount becomes zero).
143
 */
Wim Taymans's avatar
Wim Taymans committed
144
#define GST_BUFFER_MALLOCDATA(buf)              (GST_BUFFER_CAST(buf)->malloc_data)
145 146 147 148 149
/**
 * GST_BUFFER_FREE_FUNC:
 * @buf: a #GstBuffer.
 *
 * A pointer to a function that will be called on the buffer's malloc_data when
150
 * this buffer is finalized. Defaults to g_free().
151 152
 *
 * Note that the free function only affects the buffer's malloc_data; if the
153
 * buffer's malloc_data is %NULL, the function will not be called.
154 155
 *
 * Since: 0.10.22
156
 */
Wim Taymans's avatar
Wim Taymans committed
157
#define GST_BUFFER_FREE_FUNC(buf)               (GST_BUFFER_CAST(buf)->free_func)
158

159 160
/**
 * GST_BUFFER_OFFSET_NONE:
161
 *
162 163
 * Constant for no-offset return results.
 */
Wim Taymans's avatar
Wim Taymans committed
164
#define GST_BUFFER_OFFSET_NONE  ((guint64)-1)
165

166 167
/**
 * GST_BUFFER_DURATION_IS_VALID:
168
 * @buffer: a #GstBuffer
169
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
170
 * Tests if the duration is known.
171
 */
Wim Taymans's avatar
Wim Taymans committed
172
#define GST_BUFFER_DURATION_IS_VALID(buffer)    (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DURATION (buffer)))
173 174
/**
 * GST_BUFFER_TIMESTAMP_IS_VALID:
175
 * @buffer: a #GstBuffer
176
 *
177 178
 * Tests if the timestamp is known.
 */
Wim Taymans's avatar
Wim Taymans committed
179
#define GST_BUFFER_TIMESTAMP_IS_VALID(buffer)   (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_TIMESTAMP (buffer)))
180 181
/**
 * GST_BUFFER_OFFSET_IS_VALID:
182
 * @buffer: a #GstBuffer
183
 *
184 185
 * Tests if the start offset is known.
 */
Wim Taymans's avatar
Wim Taymans committed
186
#define GST_BUFFER_OFFSET_IS_VALID(buffer)      (GST_BUFFER_OFFSET (buffer) != GST_BUFFER_OFFSET_NONE)
187 188
/**
 * GST_BUFFER_OFFSET_END_IS_VALID:
189
 * @buffer: a #GstBuffer
190
 *
191 192
 * Tests if the end offset is known.
 */
Wim Taymans's avatar
Wim Taymans committed
193
#define GST_BUFFER_OFFSET_END_IS_VALID(buffer)  (GST_BUFFER_OFFSET_END (buffer) != GST_BUFFER_OFFSET_NONE)
194 195 196 197 198 199 200 201
/**
 * GST_BUFFER_IS_DISCONT:
 * @buffer: a #GstBuffer
 *
 * Tests if the buffer marks a discontinuity in the stream.
 *
 * Since: 0.10.9
 */
Wim Taymans's avatar
Wim Taymans committed
202
#define GST_BUFFER_IS_DISCONT(buffer)   (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DISCONT))
203

204 205
/**
 * GstBufferFlag:
Wim Taymans's avatar
Wim Taymans committed
206 207
 * @GST_BUFFER_FLAG_READONLY: the buffer is read-only. This means the data of
 * the buffer should not be modified. The metadata might still be modified.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
208
 * @GST_BUFFER_FLAG_PREROLL: the buffer is part of a preroll and should not be
209
 * displayed.
210 211 212
 * @GST_BUFFER_FLAG_DISCONT: the buffer marks a discontinuity in the stream.
 * This typically occurs after a seek or a dropped buffer from a live or
 * network source.
213
 * @GST_BUFFER_FLAG_IN_CAPS: the buffer has been added as a field in a #GstCaps.
214
 * @GST_BUFFER_FLAG_GAP: the buffer has been created to fill a gap in the
215 216
 * stream and contains media neutral data (elements can switch to optimized code
 * path that ignores the buffer content).
217
 * @GST_BUFFER_FLAG_DELTA_UNIT: this unit cannot be decoded independently.
218 219 220
 * @GST_BUFFER_FLAG_MEDIA1: a flag whose use is specific to the caps of the buffer. Since: 0.10.23.
 * @GST_BUFFER_FLAG_MEDIA2: a flag whose use is specific to the caps of the buffer. Since: 0.10.23.
 * @GST_BUFFER_FLAG_MEDIA3: a flag whose use is specific to the caps of the buffer. Since: 0.10.23.
221
 * @GST_BUFFER_FLAG_MEDIA4: a flag whose use is specific to the caps of the buffer. Since: 0.10.33.
222 223 224 225
 * @GST_BUFFER_FLAG_LAST: additional flags can be added starting from this flag.
 *
 * A set of buffer flags used to describe properties of a #GstBuffer.
 */
226
typedef enum {
227
  GST_BUFFER_FLAG_READONLY   = GST_MINI_OBJECT_FLAG_READONLY,
228
  GST_BUFFER_FLAG_MEDIA4     = GST_MINI_OBJECT_FLAG_RESERVED1,
229 230 231 232 233
  GST_BUFFER_FLAG_PREROLL    = (GST_MINI_OBJECT_FLAG_LAST << 0),
  GST_BUFFER_FLAG_DISCONT    = (GST_MINI_OBJECT_FLAG_LAST << 1),
  GST_BUFFER_FLAG_IN_CAPS    = (GST_MINI_OBJECT_FLAG_LAST << 2),
  GST_BUFFER_FLAG_GAP        = (GST_MINI_OBJECT_FLAG_LAST << 3),
  GST_BUFFER_FLAG_DELTA_UNIT = (GST_MINI_OBJECT_FLAG_LAST << 4),
234 235 236
  GST_BUFFER_FLAG_MEDIA1     = (GST_MINI_OBJECT_FLAG_LAST << 5),
  GST_BUFFER_FLAG_MEDIA2     = (GST_MINI_OBJECT_FLAG_LAST << 6),
  GST_BUFFER_FLAG_MEDIA3     = (GST_MINI_OBJECT_FLAG_LAST << 7),
237
  GST_BUFFER_FLAG_LAST       = (GST_MINI_OBJECT_FLAG_LAST << 8)
238
} GstBufferFlag;
Erik Walthinsen's avatar
Erik Walthinsen committed
239

240 241 242 243 244
/**
 * GstBuffer:
 * @mini_object: the parent structure
 * @data: pointer to the buffer data
 * @size: size of buffer data
245
 * @timestamp: timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
246
 *     timestamp is not known or relevant.
247
 * @duration: duration in time of the buffer data, can be #GST_CLOCK_TIME_NONE
248 249
 *     when the duration is not known or relevant.
 * @caps: the #GstCaps describing the data format in this buffer
Wim Taymans's avatar
Wim Taymans committed
250
 * @offset: a media specific offset for the buffer data.
251 252 253 254
 *     For video frames, this is the frame number of this buffer.
 *     For audio samples, this is the offset of the first sample in this buffer.
 *     For file data or compressed data this is the byte offset of the first
 *       byte in this buffer.
Wim Taymans's avatar
Wim Taymans committed
255
 * @offset_end: the last offset contained in this buffer. It has the same
256 257
 *     format as @offset.
 * @malloc_data: a pointer to the allocated memory associated with this buffer.
258 259 260
 *     When the buffer is freed, this data will freed with @free_func.
 * @free_func: a custom function that will be called with @malloc_data, defaults
 *     to g_free(). Since 0.10.22.
261
 * @parent: the parent buffer if this is a subbuffer. Since 0.10.26.
262 263 264 265
 *
 * The structure of a #GstBuffer. Use the associated macros to access the public
 * variables.
 */
266
struct _GstBuffer {
Wim Taymans's avatar
Wim Taymans committed
267
  GstMiniObject          mini_object;
268

269
  /*< public >*/ /* with COW */
270
  /* pointer to data and its size */
Wim Taymans's avatar
Wim Taymans committed
271 272
  guint8                *data;
  guint                  size;
273

Wim Taymans's avatar
Wim Taymans committed
274
  /* timestamp */
Wim Taymans's avatar
Wim Taymans committed
275 276
  GstClockTime           timestamp;
  GstClockTime           duration;
277

278
  /* the media type of this buffer */
Wim Taymans's avatar
Wim Taymans committed
279
  GstCaps               *caps;
280

281
  /* media specific offset */
Wim Taymans's avatar
Wim Taymans committed
282 283
  guint64                offset;
  guint64                offset_end;
284

285 286
  guint8                *malloc_data;

287
  /* ABI Added */
288
  GFreeFunc              free_func;
289
  GstBuffer             *parent;
290

291
  /*< private >*/
292 293
  GstBufferPrivate      *priv;
  gpointer _gst_reserved[GST_PADDING - 3];
294
};
295

296 297 298 299
struct _GstBufferClass {
  GstMiniObjectClass    mini_object_class;
};

300 301
GType       gst_buffer_get_type (void);

302
/* allocation */
303 304 305
GstBuffer * gst_buffer_new               (void) G_GNUC_MALLOC;
GstBuffer * gst_buffer_new_and_alloc     (guint size) G_GNUC_MALLOC;
GstBuffer * gst_buffer_try_new_and_alloc (guint size) G_GNUC_MALLOC;
306

307 308
/**
 * gst_buffer_set_data:
309 310 311
 * @buf: a #GstBuffer
 * @data: The data (a #guint8 *) to set on the buffer.
 * @size: The size (in bytes, as a #guint) of the data being set.
312 313
 *
 * A convenience function to set the data and size on a buffer.
314 315 316 317 318
 * This will replace any existing data pointer set on this buffer, but will
 * not change GST_BUFFER_MALLOCDATA(), if any. Callers should ensure that
 * GST_BUFFER_MALLOCDATA() is non-NULL, or should free that and set it to NULL.
 *
 * No checks are done on the data or size arguments passed.
319
 */
Wim Taymans's avatar
Wim Taymans committed
320 321 322 323
#define         gst_buffer_set_data(buf, data, size)    \
G_STMT_START {                                          \
  GST_BUFFER_DATA (buf) = data;                         \
  GST_BUFFER_SIZE (buf) = size;                         \
324 325
} G_STMT_END

Erik Walthinsen's avatar
Erik Walthinsen committed
326
/* refcounting */
327 328
/**
 * gst_buffer_ref:
329
 * @buf: a #GstBuffer.
330 331
 *
 * Increases the refcount of the given buffer by one.
332 333
 *
 * Note that the refcount affects the writeability
334 335
 * of @buf and its metadata, see gst_buffer_is_writable() and
 * gst_buffer_is_metadata_writable(). It is
336 337 338 339
 * important to note that keeping additional references to
 * GstBuffer instances can potentially increase the number
 * of memcpy operations in a pipeline.
 *
340
 * Returns: (transfer full): @buf
341
 */
342 343 344 345
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC GstBuffer * gst_buffer_ref (GstBuffer * buf);
#endif

346 347 348
static inline GstBuffer *
gst_buffer_ref (GstBuffer * buf)
{
349
  return (GstBuffer *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (buf));
350 351
}

352 353
/**
 * gst_buffer_unref:
354
 * @buf: (transfer full): a #GstBuffer.
355 356
 *
 * Decreases the refcount of the buffer. If the refcount reaches 0, the buffer
357 358
 * will be freed. If GST_BUFFER_MALLOCDATA() is non-NULL, this pointer will
 * also be freed at this time.
359
 */
360 361 362 363 364 365 366 367 368
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC void gst_buffer_unref (GstBuffer * buf);
#endif

static inline void
gst_buffer_unref (GstBuffer * buf)
{
  gst_mini_object_unref (GST_MINI_OBJECT_CAST (buf));
}
369

370
/* copy buffer */
371 372
/**
 * gst_buffer_copy:
373
 * @buf: a #GstBuffer.
374
 *
375 376
 * Create a copy of the given buffer. This will also make a newly allocated
 * copy of the data the source buffer contains.
Wim Taymans's avatar
Wim Taymans committed
377
 *
378
 * Returns: (transfer full): a new copy of @buf.
379
 */
380 381 382 383 384 385 386
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC GstBuffer * gst_buffer_copy (const GstBuffer * buf);
#endif

static inline GstBuffer *
gst_buffer_copy (const GstBuffer * buf)
{
387
  return GST_BUFFER (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (buf)));
388 389
}

390 391 392 393 394 395 396

/**
 * GstBufferCopyFlags:
 * @GST_BUFFER_COPY_FLAGS: flag indicating that buffer flags should be copied
 * @GST_BUFFER_COPY_TIMESTAMPS: flag indicating that buffer timestamp, duration,
 * offset and offset_end should be copied
 * @GST_BUFFER_COPY_CAPS: flag indicating that buffer caps should be copied
397 398
 * @GST_BUFFER_COPY_QDATA: flag indicating that buffer qdata should be copied
 *    (Since 0.10.36)
399 400 401 402 403 404 405 406 407
 *
 * A set of flags that can be provided to the gst_buffer_copy_metadata()
 * function to specify which metadata fields should be copied.
 *
 * Since: 0.10.13
 */
typedef enum {
  GST_BUFFER_COPY_FLAGS      = (1 << 0),
  GST_BUFFER_COPY_TIMESTAMPS = (1 << 1),
408 409
  GST_BUFFER_COPY_CAPS       = (1 << 2),
  GST_BUFFER_COPY_QDATA      = (1 << 3)
410 411 412 413 414 415 416 417 418 419
} GstBufferCopyFlags;

/**
 * GST_BUFFER_COPY_ALL:
 *
 * Combination of all possible fields that can be copied with
 * gst_buffer_copy_metadata().
 *
 * Since: 0.10.13
 */
420
#define GST_BUFFER_COPY_ALL ((GstBufferCopyFlags) (GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS | GST_BUFFER_COPY_CAPS | GST_BUFFER_COPY_QDATA))
421 422 423 424 425

/* copies metadata into newly allocated buffer */
void            gst_buffer_copy_metadata        (GstBuffer *dest, const GstBuffer *src,
                                                 GstBufferCopyFlags flags);

426 427
/**
 * gst_buffer_is_writable:
428
 * @buf: a #GstBuffer
429
 *
430 431 432
 * Tests if you can safely write data into a buffer's data array or validly
 * modify the caps and timestamp metadata. Metadata in a GstBuffer is always
 * writable, but it is only safe to change it when there is only one owner
Wim Taymans's avatar
Wim Taymans committed
433
 * of the buffer - ie, the refcount is 1.
434
 */
Wim Taymans's avatar
Wim Taymans committed
435
#define         gst_buffer_is_writable(buf)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (buf))
436 437
/**
 * gst_buffer_make_writable:
438
 * @buf: (transfer full): a #GstBuffer
439
 *
440
 * Makes a writable buffer from the given buffer. If the source buffer is
Wim Taymans's avatar
Wim Taymans committed
441
 * already writable, this will simply return the same buffer. A copy will
442
 * otherwise be made using gst_buffer_copy().
443 444 445
 *
 * Returns: (transfer full): a writable buffer which may or may not be the
 *     same as @buf
446
 */
Wim Taymans's avatar
Wim Taymans committed
447
#define         gst_buffer_make_writable(buf)   GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (buf)))
Erik Walthinsen's avatar
Erik Walthinsen committed
448

449 450 451 452 453
/* Ensure that the metadata of the buffer is writable, even if the buffer data
 * isn't */
gboolean        gst_buffer_is_metadata_writable (GstBuffer *buf);
GstBuffer*      gst_buffer_make_metadata_writable (GstBuffer *buf);

454 455 456 457 458 459 460 461 462 463 464
/* per-buffer user data */

void                  gst_buffer_set_qdata (GstBuffer     * buffer,
                                            GQuark          quark,
                                            GstStructure  * data);

const GstStructure *  gst_buffer_get_qdata (GstBuffer     * buffer,
                                            GQuark          quark);



465 466
/**
 * gst_buffer_replace:
467 468 469 470
 * @obuf: (inout) (transfer full): pointer to a pointer to a #GstBuffer to be
 *     replaced.
 * @nbuf: (transfer none) (allow-none): pointer to a #GstBuffer that will
 *     replace the buffer pointed to by @obuf.
471
 *
Stefan Kost's avatar
Stefan Kost committed
472
 * Modifies a pointer to a #GstBuffer to point to a different #GstBuffer. The
473
 * modification is done atomically (so this is useful for ensuring thread safety
Wim Taymans's avatar
Wim Taymans committed
474
 * in some cases), and the reference counts are updated appropriately (the old
475
 * buffer is unreffed, the new is reffed).
476
 *
477
 * Either @nbuf or the #GstBuffer pointed to by @obuf may be NULL.
478
 */
479 480 481 482 483 484 485 486 487
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC void gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf);
#endif

static inline void
gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf)
{
  gst_mini_object_replace ((GstMiniObject **) obuf, (GstMiniObject *) nbuf);
}
Wim Taymans's avatar
Wim Taymans committed
488

Wim Taymans's avatar
Wim Taymans committed
489 490
GstCaps*        gst_buffer_get_caps             (GstBuffer *buffer);
void            gst_buffer_set_caps             (GstBuffer *buffer, GstCaps *caps);
491

492
/* creating a subbuffer */
493
GstBuffer*      gst_buffer_create_sub           (GstBuffer *parent, guint offset, guint size) G_GNUC_MALLOC;
494

495
/* span, two buffers, intelligently */
Wim Taymans's avatar
Wim Taymans committed
496
gboolean        gst_buffer_is_span_fast         (GstBuffer *buf1, GstBuffer *buf2);
497
GstBuffer*      gst_buffer_span                 (GstBuffer *buf1, guint32 offset, GstBuffer *buf2, guint32 len) G_GNUC_MALLOC;
498

Wim Taymans's avatar
Wim Taymans committed
499 500
/**
 * gst_value_set_buffer:
Stefan Kost's avatar
Stefan Kost committed
501
 * @v: a #GValue to receive the data
502
 * @b: (transfer none): a #GstBuffer to assign to the GstValue
Wim Taymans's avatar
Wim Taymans committed
503
 *
504
 * Sets @b as the value of @v.  Caller retains reference to buffer.
Wim Taymans's avatar
Wim Taymans committed
505
 */
Wim Taymans's avatar
Wim Taymans committed
506
#define         gst_value_set_buffer(v,b)       gst_value_set_mini_object(v, GST_MINI_OBJECT_CAST(b))
Wim Taymans's avatar
Wim Taymans committed
507 508
/**
 * gst_value_take_buffer:
Stefan Kost's avatar
Stefan Kost committed
509
 * @v: a #GValue to receive the data
510
 * @b: (transfer full): a #GstBuffer to assign to the GstValue
Wim Taymans's avatar
Wim Taymans committed
511
 *
512
 * Sets @b as the value of @v.  Caller gives away reference to buffer.
Wim Taymans's avatar
Wim Taymans committed
513
 */
Wim Taymans's avatar
Wim Taymans committed
514
#define         gst_value_take_buffer(v,b)      gst_value_take_mini_object(v, GST_MINI_OBJECT_CAST(b))
Wim Taymans's avatar
Wim Taymans committed
515 516
/**
 * gst_value_get_buffer:
Stefan Kost's avatar
Stefan Kost committed
517
 * @v: a #GValue to query
Wim Taymans's avatar
Wim Taymans committed
518
 *
519 520 521
 * Receives a #GstBuffer as the value of @v. Does not return a reference to
 * the buffer, so the pointer is only valid for as long as the caller owns
 * a reference to @v.
522 523
 *
 * Returns: (transfer none): buffer
Wim Taymans's avatar
Wim Taymans committed
524
 */
Wim Taymans's avatar
Wim Taymans committed
525
#define         gst_value_get_buffer(v)         GST_BUFFER_CAST (gst_value_get_mini_object(v))
526

527
G_END_DECLS
528

Erik Walthinsen's avatar
Erik Walthinsen committed
529
#endif /* __GST_BUFFER_H__ */