2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
5 * gstbuffer.h: Header for GstBuffer object
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.
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.
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.
24 #ifndef __GST_BUFFER_H__
25 #define __GST_BUFFER_H__
27 #include <gst/gstminiobject.h>
28 #include <gst/gstclock.h>
29 #include <gst/gstmemory.h>
33 GST_EXPORT GType _gst_buffer_type;
35 typedef struct _GstBuffer GstBuffer;
36 typedef struct _GstBufferPool GstBufferPool;
38 #define GST_TYPE_BUFFER (_gst_buffer_type)
39 #define GST_IS_BUFFER(obj) (GST_IS_MINI_OBJECT_TYPE(obj, GST_TYPE_BUFFER))
40 #define GST_BUFFER_CAST(obj) ((GstBuffer *)(obj))
41 #define GST_BUFFER(obj) (GST_BUFFER_CAST(obj))
47 * A flags word containing #GstBufferFlag flags set on this buffer.
49 #define GST_BUFFER_FLAGS(buf) GST_MINI_OBJECT_FLAGS(buf)
51 * GST_BUFFER_FLAG_IS_SET:
53 * @flag: the #GstBufferFlag to check.
55 * Gives the status of a specific flag on a buffer.
57 #define GST_BUFFER_FLAG_IS_SET(buf,flag) GST_MINI_OBJECT_FLAG_IS_SET (buf, flag)
59 * GST_BUFFER_FLAG_SET:
61 * @flag: the #GstBufferFlag to set.
63 * Sets a buffer flag on a buffer.
65 #define GST_BUFFER_FLAG_SET(buf,flag) GST_MINI_OBJECT_FLAG_SET (buf, flag)
67 * GST_BUFFER_FLAG_UNSET:
69 * @flag: the #GstBufferFlag to clear.
71 * Clears a buffer flag.
73 #define GST_BUFFER_FLAG_UNSET(buf,flag) GST_MINI_OBJECT_FLAG_UNSET (buf, flag)
78 * @buf: a #GstBuffer.:
80 * The presentation timestamp (pts) in nanoseconds (as a #GstClockTime)
81 * of the data in the buffer. This is the timestamp when the media should be
82 * presented to the user.
83 * Value will be %GST_CLOCK_TIME_NONE if the pts is unknown.
85 #define GST_BUFFER_PTS(buf) (GST_BUFFER_CAST(buf)->pts)
88 * @buf: a #GstBuffer.:
90 * The decoding timestamp (dts) in nanoseconds (as a #GstClockTime)
91 * of the data in the buffer. This is the timestamp when the media should be
92 * decoded or processed otherwise.
93 * Value will be %GST_CLOCK_TIME_NONE if the dts is unknown.
95 #define GST_BUFFER_DTS(buf) (GST_BUFFER_CAST(buf)->dts)
97 * GST_BUFFER_DURATION:
100 * The duration in nanoseconds (as a #GstClockTime) of the data in the buffer.
101 * Value will be %GST_CLOCK_TIME_NONE if the duration is unknown.
103 #define GST_BUFFER_DURATION(buf) (GST_BUFFER_CAST(buf)->duration)
106 * @buf: a #GstBuffer.
108 * The offset in the source file of the beginning of this buffer.
110 #define GST_BUFFER_OFFSET(buf) (GST_BUFFER_CAST(buf)->offset)
112 * GST_BUFFER_OFFSET_END:
113 * @buf: a #GstBuffer.
115 * The offset in the source file of the end of this buffer.
117 #define GST_BUFFER_OFFSET_END(buf) (GST_BUFFER_CAST(buf)->offset_end)
120 * GST_BUFFER_OFFSET_NONE:
122 * Constant for no-offset return results.
124 #define GST_BUFFER_OFFSET_NONE ((guint64)-1)
127 * GST_BUFFER_DURATION_IS_VALID:
128 * @buffer: a #GstBuffer
130 * Tests if the duration is known.
132 #define GST_BUFFER_DURATION_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DURATION (buffer)))
134 * GST_BUFFER_PTS_IS_VALID:
135 * @buffer: a #GstBuffer
137 * Tests if the pts is known.
139 #define GST_BUFFER_PTS_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_PTS (buffer)))
141 * GST_BUFFER_DTS_IS_VALID:
142 * @buffer: a #GstBuffer
144 * Tests if the dts is known.
146 #define GST_BUFFER_DTS_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DTS (buffer)))
148 * GST_BUFFER_OFFSET_IS_VALID:
149 * @buffer: a #GstBuffer
151 * Tests if the start offset is known.
153 #define GST_BUFFER_OFFSET_IS_VALID(buffer) (GST_BUFFER_OFFSET (buffer) != GST_BUFFER_OFFSET_NONE)
155 * GST_BUFFER_OFFSET_END_IS_VALID:
156 * @buffer: a #GstBuffer
158 * Tests if the end offset is known.
160 #define GST_BUFFER_OFFSET_END_IS_VALID(buffer) (GST_BUFFER_OFFSET_END (buffer) != GST_BUFFER_OFFSET_NONE)
162 * GST_BUFFER_IS_DISCONT:
163 * @buffer: a #GstBuffer
165 * Tests if the buffer marks a discontinuity in the stream.
169 #define GST_BUFFER_IS_DISCONT(buffer) (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DISCONT))
173 * @GST_BUFFER_FLAG_LIVE: the buffer is live data and should be discarded in
175 * @GST_BUFFER_FLAG_DECODE_ONLY: the buffer contains data that should be dropped
176 * because it will be clipped against the segment
177 * boundaries or because it does not contain data
178 * that should be shown to the user.
179 * @GST_BUFFER_FLAG_DISCONT: the buffer marks a data discontinuity in the stream.
180 * This typically occurs after a seek or a dropped buffer
181 * from a live or network source.
182 * @GST_BUFFER_FLAG_RESYNC: the buffer timestamps might have a discontinuity
183 * and this buffer is a good point to resynchronize.
184 * @GST_BUFFER_FLAG_CORRUPTED: the buffer data is corrupted.
185 * @GST_BUFFER_FLAG_MARKER: the buffer contains a media specific marker. for
186 * video this is typically the end of a frame boundary, for audio
187 * this is usually the end of a talkspurt.
188 * @GST_BUFFER_FLAG_HEADER: the buffer contains header information that is
189 * needed to decode the following data. The buffer
190 * is also part of the headers of the STREAM_CONFIG event.
191 * @GST_BUFFER_FLAG_GAP: the buffer has been created to fill a gap in the
192 * stream and contains media neutral data (elements can
193 * switch to optimized code path that ignores the buffer
195 * @GST_BUFFER_FLAG_DROPPABLE: the buffer can be dropped without breaking the
196 * stream, for example to reduce bandwidth.
197 * @GST_BUFFER_FLAG_DELTA_UNIT: this unit cannot be decoded independently.
198 * @GST_BUFFER_FLAG_LAST: additional media specific flags can be added starting from
201 * A set of buffer flags used to describe properties of a #GstBuffer.
204 GST_BUFFER_FLAG_LIVE = (GST_MINI_OBJECT_FLAG_LAST << 0),
205 GST_BUFFER_FLAG_DECODE_ONLY = (GST_MINI_OBJECT_FLAG_LAST << 1),
206 GST_BUFFER_FLAG_DISCONT = (GST_MINI_OBJECT_FLAG_LAST << 2),
207 GST_BUFFER_FLAG_RESYNC = (GST_MINI_OBJECT_FLAG_LAST << 3),
208 GST_BUFFER_FLAG_CORRUPTED = (GST_MINI_OBJECT_FLAG_LAST << 4),
209 GST_BUFFER_FLAG_MARKER = (GST_MINI_OBJECT_FLAG_LAST << 5),
210 GST_BUFFER_FLAG_HEADER = (GST_MINI_OBJECT_FLAG_LAST << 6),
211 GST_BUFFER_FLAG_GAP = (GST_MINI_OBJECT_FLAG_LAST << 7),
212 GST_BUFFER_FLAG_DROPPABLE = (GST_MINI_OBJECT_FLAG_LAST << 8),
213 GST_BUFFER_FLAG_DELTA_UNIT = (GST_MINI_OBJECT_FLAG_LAST << 9),
215 GST_BUFFER_FLAG_LAST = (GST_MINI_OBJECT_FLAG_LAST << 16)
220 * @mini_object: the parent structure
221 * @pool: pointer to the pool owner of the buffer
222 * @pts: presentation timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
223 * pts is not known or relevant. The pts contains the timestamp when the
224 * media should be presented to the user.
225 * @dts: decoding timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
226 * dts is not known or relevant. The dts contains the timestamp when the
227 * media should be processed.
228 * @duration: duration in time of the buffer data, can be #GST_CLOCK_TIME_NONE
229 * when the duration is not known or relevant.
230 * @offset: a media specific offset for the buffer data.
231 * For video frames, this is the frame number of this buffer.
232 * For audio samples, this is the offset of the first sample in this buffer.
233 * For file data or compressed data this is the byte offset of the first
234 * byte in this buffer.
235 * @offset_end: the last offset contained in this buffer. It has the same
238 * The structure of a #GstBuffer. Use the associated macros to access the public
242 GstMiniObject mini_object;
244 /*< public >*/ /* with COW */
250 GstClockTime duration;
252 /* media specific offset */
257 GType gst_buffer_get_type (void);
260 GstBuffer * gst_buffer_new (void);
261 GstBuffer * gst_buffer_new_allocate (GstAllocator * allocator, gsize size,
262 GstAllocationParams * params);
263 GstBuffer * gst_buffer_new_wrapped_full (GstMemoryFlags flags, gpointer data, gsize maxsize,
264 gsize offset, gsize size, gpointer user_data,
265 GDestroyNotify notify);
266 GstBuffer * gst_buffer_new_wrapped (gpointer data, gsize size);
269 guint gst_buffer_n_memory (GstBuffer *buffer);
270 void gst_buffer_take_memory (GstBuffer *buffer, gint idx, GstMemory *mem);
271 void gst_buffer_replace_memory (GstBuffer *buffer, gint idx, GstMemory *mem);
272 GstMemory * gst_buffer_get_memory (GstBuffer *buffer, gint idx);
273 void gst_buffer_remove_memory_range (GstBuffer *buffer, guint idx, gint length);
275 #define gst_buffer_append_memory(b,m) gst_buffer_take_memory ((b), -1, (m))
276 #define gst_buffer_replace_all_memory(b,m) gst_buffer_replace_memory ((b), -1, (m))
277 #define gst_buffer_get_merged_memory(b) gst_buffer_get_memory ((b), -1)
279 * gst_buffer_remove_memory:
283 * Remove the memory block in @b at @i.
285 #define gst_buffer_remove_memory(b,i) gst_buffer_remove_memory_range ((b), (i), 1)
286 #define gst_buffer_remove_all_memory(b) gst_buffer_remove_memory_range ((b), 0, -1)
288 gsize gst_buffer_fill (GstBuffer *buffer, gsize offset,
289 gconstpointer src, gsize size);
290 gsize gst_buffer_extract (GstBuffer *buffer, gsize offset,
291 gpointer dest, gsize size);
292 gint gst_buffer_memcmp (GstBuffer *buffer, gsize offset,
293 gconstpointer mem, gsize size);
294 gsize gst_buffer_memset (GstBuffer *buffer, gsize offset,
295 guint8 val, gsize size);
297 gsize gst_buffer_get_sizes (GstBuffer *buffer, gsize *offset, gsize *maxsize);
298 void gst_buffer_resize (GstBuffer *buffer, gssize offset, gssize size);
301 * gst_buffer_get_size:
304 * Get the size of @b.
306 #define gst_buffer_get_size(b) gst_buffer_get_sizes ((b), NULL, NULL)
308 * gst_buffer_set_size:
312 * Set the size of @b to @s. This will remove or trim the memory blocks
315 #define gst_buffer_set_size(b,s) gst_buffer_resize ((b), 0, (s))
317 gboolean gst_buffer_map (GstBuffer *buffer, GstMapInfo *info, GstMapFlags flags);
318 void gst_buffer_unmap (GstBuffer *buffer, GstMapInfo *info);
323 * @buf: a #GstBuffer.
325 * Increases the refcount of the given buffer by one.
327 * Note that the refcount affects the writeability
328 * of @buf and its metadata, see gst_buffer_is_writable() and
329 * gst_buffer_is_metadata_writable(). It is
330 * important to note that keeping additional references to
331 * GstBuffer instances can potentially increase the number
332 * of memcpy operations in a pipeline.
334 * Returns: (transfer full): @buf
336 #ifdef _FOOL_GTK_DOC_
337 G_INLINE_FUNC GstBuffer * gst_buffer_ref (GstBuffer * buf);
340 static inline GstBuffer *
341 gst_buffer_ref (GstBuffer * buf)
343 return (GstBuffer *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (buf));
348 * @buf: (transfer full): a #GstBuffer.
350 * Decreases the refcount of the buffer. If the refcount reaches 0, the buffer
351 * with the associated metadata and memory will be freed.
353 #ifdef _FOOL_GTK_DOC_
354 G_INLINE_FUNC void gst_buffer_unref (GstBuffer * buf);
358 gst_buffer_unref (GstBuffer * buf)
360 gst_mini_object_unref (GST_MINI_OBJECT_CAST (buf));
366 * @buf: a #GstBuffer.
368 * Create a copy of the given buffer. This will also make a newly allocated
369 * copy of the data the source buffer contains.
371 * Returns: (transfer full): a new copy of @buf.
373 #ifdef _FOOL_GTK_DOC_
374 G_INLINE_FUNC GstBuffer * gst_buffer_copy (const GstBuffer * buf);
377 static inline GstBuffer *
378 gst_buffer_copy (const GstBuffer * buf)
380 return GST_BUFFER (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (buf)));
385 * GstBufferCopyFlags:
386 * @GST_BUFFER_COPY_NONE: copy nothing
387 * @GST_BUFFER_COPY_FLAGS: flag indicating that buffer flags should be copied
388 * @GST_BUFFER_COPY_TIMESTAMPS: flag indicating that buffer pts, dts,
389 * duration, offset and offset_end should be copied
390 * @GST_BUFFER_COPY_MEMORY: flag indicating that buffer memory should be copied
391 * and appended to already existing memory
392 * @GST_BUFFER_COPY_MERGE: flag indicating that buffer memory should be
394 * @GST_BUFFER_COPY_META: flag indicating that buffer meta should be
397 * A set of flags that can be provided to the gst_buffer_copy_into()
398 * function to specify which items should be copied.
401 GST_BUFFER_COPY_NONE = 0,
402 GST_BUFFER_COPY_FLAGS = (1 << 0),
403 GST_BUFFER_COPY_TIMESTAMPS = (1 << 1),
404 GST_BUFFER_COPY_META = (1 << 2),
405 GST_BUFFER_COPY_MEMORY = (1 << 3),
406 GST_BUFFER_COPY_MERGE = (1 << 4)
407 } GstBufferCopyFlags;
410 * GST_BUFFER_COPY_METADATA:
412 * Combination of all possible metadata fields that can be copied with
413 * gst_buffer_copy_into().
415 #define GST_BUFFER_COPY_METADATA (GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS |\
416 GST_BUFFER_COPY_META)
419 * GST_BUFFER_COPY_ALL:
421 * Combination of all possible fields that can be copied with
422 * gst_buffer_copy_into().
424 #define GST_BUFFER_COPY_ALL ((GstBufferCopyFlags)(GST_BUFFER_COPY_METADATA | GST_BUFFER_COPY_MEMORY))
426 /* copies memory or metadata into newly allocated buffer */
427 void gst_buffer_copy_into (GstBuffer *dest, GstBuffer *src,
428 GstBufferCopyFlags flags,
429 gsize offset, gsize size);
432 * gst_buffer_is_writable:
435 * Tests if you can safely write data into a buffer's data array or validly
436 * modify the caps and timestamp metadata. Metadata in a GstBuffer is always
437 * writable, but it is only safe to change it when there is only one owner
438 * of the buffer - ie, the refcount is 1.
440 #define gst_buffer_is_writable(buf) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (buf))
442 * gst_buffer_make_writable:
443 * @buf: (transfer full): a #GstBuffer
445 * Makes a writable buffer from the given buffer. If the source buffer is
446 * already writable, this will simply return the same buffer. A copy will
447 * otherwise be made using gst_buffer_copy().
449 * Returns: (transfer full): a writable buffer which may or may not be the
452 #define gst_buffer_make_writable(buf) GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (buf)))
455 * gst_buffer_replace:
456 * @obuf: (inout) (transfer full): pointer to a pointer to a #GstBuffer to be
458 * @nbuf: (transfer none) (allow-none): pointer to a #GstBuffer that will
459 * replace the buffer pointed to by @obuf.
461 * Modifies a pointer to a #GstBuffer to point to a different #GstBuffer. The
462 * modification is done atomically (so this is useful for ensuring thread safety
463 * in some cases), and the reference counts are updated appropriately (the old
464 * buffer is unreffed, the new is reffed).
466 * Either @nbuf or the #GstBuffer pointed to by @obuf may be NULL.
468 * Returns: TRUE when @obuf was different from @nbuf.
470 #ifdef _FOOL_GTK_DOC_
471 G_INLINE_FUNC gboolean gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf);
474 static inline gboolean
475 gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf)
477 return gst_mini_object_replace ((GstMiniObject **) obuf, (GstMiniObject *) nbuf);
480 /* creating a region */
481 GstBuffer* gst_buffer_copy_region (GstBuffer *parent, GstBufferCopyFlags flags,
482 gsize offset, gsize size);
484 /* append two buffers */
485 GstBuffer* gst_buffer_append (GstBuffer *buf1, GstBuffer *buf2);
488 #include <gst/gstmeta.h>
492 * @buffer: a #GstBuffer
493 * @meta: a pointer to a #GstMeta
494 * @user_data: user data passed to gst_buffer_foreach_meta()
496 * A function that will be called from gst_buffer_foreach_meta(). The @meta
497 * field will point to a the reference of the meta.
499 * @buffer should not be modified from this callback.
501 * When this function returns %TRUE, the next meta will be
502 * returned. When %FALSE is returned, gst_buffer_foreach_meta() will return.
504 * When @meta is set to NULL, the item will be removed from the buffer.
506 * Returns: %FALSE when gst_buffer_foreach_meta() should stop
508 typedef gboolean (*GstBufferForeachMetaFunc) (GstBuffer *buffer, GstMeta **meta,
511 GstMeta * gst_buffer_get_meta (GstBuffer *buffer, GType api);
512 GstMeta * gst_buffer_add_meta (GstBuffer *buffer, const GstMetaInfo *info,
514 gboolean gst_buffer_remove_meta (GstBuffer *buffer, GstMeta *meta);
516 GstMeta * gst_buffer_iterate_meta (GstBuffer *buffer, gpointer *state);
518 void gst_buffer_foreach_meta (GstBuffer *buffer,
519 GstBufferForeachMetaFunc func,
523 * gst_value_set_buffer:
524 * @v: a #GValue to receive the data
525 * @b: (transfer none): a #GstBuffer to assign to the GstValue
527 * Sets @b as the value of @v. Caller retains reference to buffer.
529 #define gst_value_set_buffer(v,b) g_value_set_boxed((v),(b))
531 * gst_value_take_buffer:
532 * @v: a #GValue to receive the data
533 * @b: (transfer full): a #GstBuffer to assign to the GstValue
535 * Sets @b as the value of @v. Caller gives away reference to buffer.
537 #define gst_value_take_buffer(v,b) g_value_take_boxed(v,(b))
539 * gst_value_get_buffer:
540 * @v: a #GValue to query
542 * Receives a #GstBuffer as the value of @v. Does not return a reference to
543 * the buffer, so the pointer is only valid for as long as the caller owns
546 * Returns: (transfer none): buffer
548 #define gst_value_get_buffer(v) GST_BUFFER_CAST (g_value_get_boxed(v))
552 #endif /* __GST_BUFFER_H__ */