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 extern GType _gst_buffer_type;
35 typedef struct _GstBuffer GstBuffer;
36 typedef struct _GstBufferPool GstBufferPool;
39 * GST_BUFFER_TRACE_NAME:
41 * The name used for tracing memory allocations.
43 #define GST_BUFFER_TRACE_NAME "GstBuffer"
45 #define GST_TYPE_BUFFER (_gst_buffer_type)
46 #define GST_IS_BUFFER(obj) (GST_IS_MINI_OBJECT_TYPE(obj, GST_TYPE_BUFFER))
47 #define GST_BUFFER_CAST(obj) ((GstBuffer *)(obj))
48 #define GST_BUFFER(obj) (GST_BUFFER_CAST(obj))
54 * A flags word containing #GstBufferFlag flags set on this buffer.
56 #define GST_BUFFER_FLAGS(buf) GST_MINI_OBJECT_FLAGS(buf)
58 * GST_BUFFER_FLAG_IS_SET:
60 * @flag: the #GstBufferFlag to check.
62 * Gives the status of a specific flag on a buffer.
64 #define GST_BUFFER_FLAG_IS_SET(buf,flag) GST_MINI_OBJECT_FLAG_IS_SET (buf, flag)
66 * GST_BUFFER_FLAG_SET:
68 * @flag: the #GstBufferFlag to set.
70 * Sets a buffer flag on a buffer.
72 #define GST_BUFFER_FLAG_SET(buf,flag) GST_MINI_OBJECT_FLAG_SET (buf, flag)
74 * GST_BUFFER_FLAG_UNSET:
76 * @flag: the #GstBufferFlag to clear.
78 * Clears a buffer flag.
80 #define GST_BUFFER_FLAG_UNSET(buf,flag) GST_MINI_OBJECT_FLAG_UNSET (buf, flag)
85 * @buf: a #GstBuffer.:
87 * The presentation timestamp (pts) in nanoseconds (as a #GstClockTime)
88 * of the data in the buffer. This is the timestamp when the media should be
89 * presented to the user.
90 * Value will be %GST_CLOCK_TIME_NONE if the pts is unknown.
92 #define GST_BUFFER_PTS(buf) (GST_BUFFER_CAST(buf)->pts)
95 * @buf: a #GstBuffer.:
97 * The decoding timestamp (dts) in nanoseconds (as a #GstClockTime)
98 * of the data in the buffer. This is the timestamp when the media should be
99 * decoded or processed otherwise.
100 * Value will be %GST_CLOCK_TIME_NONE if the dts is unknown.
102 #define GST_BUFFER_DTS(buf) (GST_BUFFER_CAST(buf)->dts)
104 * GST_BUFFER_DURATION:
105 * @buf: a #GstBuffer.
107 * The duration in nanoseconds (as a #GstClockTime) of the data in the buffer.
108 * Value will be %GST_CLOCK_TIME_NONE if the duration is unknown.
110 #define GST_BUFFER_DURATION(buf) (GST_BUFFER_CAST(buf)->duration)
113 * @buf: a #GstBuffer.
115 * The offset in the source file of the beginning of this buffer.
117 #define GST_BUFFER_OFFSET(buf) (GST_BUFFER_CAST(buf)->offset)
119 * GST_BUFFER_OFFSET_END:
120 * @buf: a #GstBuffer.
122 * The offset in the source file of the end of this buffer.
124 #define GST_BUFFER_OFFSET_END(buf) (GST_BUFFER_CAST(buf)->offset_end)
127 * GST_BUFFER_OFFSET_NONE:
129 * Constant for no-offset return results.
131 #define GST_BUFFER_OFFSET_NONE ((guint64)-1)
134 * GST_BUFFER_DURATION_IS_VALID:
135 * @buffer: a #GstBuffer
137 * Tests if the duration is known.
139 #define GST_BUFFER_DURATION_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DURATION (buffer)))
141 * GST_BUFFER_PTS_IS_VALID:
142 * @buffer: a #GstBuffer
144 * Tests if the pts is known.
146 #define GST_BUFFER_PTS_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_PTS (buffer)))
148 * GST_BUFFER_DTS_IS_VALID:
149 * @buffer: a #GstBuffer
151 * Tests if the dts is known.
153 #define GST_BUFFER_DTS_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DTS (buffer)))
155 * GST_BUFFER_OFFSET_IS_VALID:
156 * @buffer: a #GstBuffer
158 * Tests if the start offset is known.
160 #define GST_BUFFER_OFFSET_IS_VALID(buffer) (GST_BUFFER_OFFSET (buffer) != GST_BUFFER_OFFSET_NONE)
162 * GST_BUFFER_OFFSET_END_IS_VALID:
163 * @buffer: a #GstBuffer
165 * Tests if the end offset is known.
167 #define GST_BUFFER_OFFSET_END_IS_VALID(buffer) (GST_BUFFER_OFFSET_END (buffer) != GST_BUFFER_OFFSET_NONE)
169 * GST_BUFFER_IS_DISCONT:
170 * @buffer: a #GstBuffer
172 * Tests if the buffer marks a discontinuity in the stream.
176 #define GST_BUFFER_IS_DISCONT(buffer) (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DISCONT))
180 * @GST_BUFFER_FLAG_LIVE: the buffer is live data and should be discarded in
182 * @GST_BUFFER_FLAG_DECODE_ONLY: the buffer contains data that should be dropped
183 * because it will be clipped against the segment
184 * boundaries or because it does not contain data
185 * that should be shown to the user.
186 * @GST_BUFFER_FLAG_DISCONT: the buffer marks a data discontinuity in the stream.
187 * This typically occurs after a seek or a dropped buffer
188 * from a live or network source.
189 * @GST_BUFFER_FLAG_RESYNC: the buffer timestamps might have a discontinuity
190 * and this buffer is a good point to resynchronize.
191 * @GST_BUFFER_FLAG_CORRUPTED: the buffer data is corrupted.
192 * @GST_BUFFER_FLAG_MARKER: the buffer contains a media specific marker. for
193 * video this is typically the end of a frame boundary, for audio
194 * this is usually the end of a talkspurt.
195 * @GST_BUFFER_FLAG_HEADER: the buffer contains header information that is
196 * needed to decode the following data
197 * @GST_BUFFER_FLAG_GAP: the buffer has been created to fill a gap in the
198 * stream and contains media neutral data (elements can
199 * switch to optimized code path that ignores the buffer
201 * @GST_BUFFER_FLAG_DROPPABLE: the buffer can be dropped without breaking the
202 * stream, for example to reduce bandwidth.
203 * @GST_BUFFER_FLAG_DELTA_UNIT: this unit cannot be decoded independently.
204 * @GST_BUFFER_FLAG_IN_CAPS: the buffer has been added as a field in a #GstCaps.
205 * @GST_BUFFER_FLAG_LAST: additional media specific flags can be added starting from
208 * A set of buffer flags used to describe properties of a #GstBuffer.
211 GST_BUFFER_FLAG_LIVE = (GST_MINI_OBJECT_FLAG_LAST << 0),
212 GST_BUFFER_FLAG_DECODE_ONLY = (GST_MINI_OBJECT_FLAG_LAST << 1),
213 GST_BUFFER_FLAG_DISCONT = (GST_MINI_OBJECT_FLAG_LAST << 2),
214 GST_BUFFER_FLAG_RESYNC = (GST_MINI_OBJECT_FLAG_LAST << 3),
215 GST_BUFFER_FLAG_CORRUPTED = (GST_MINI_OBJECT_FLAG_LAST << 4),
216 GST_BUFFER_FLAG_MARKER = (GST_MINI_OBJECT_FLAG_LAST << 5),
217 GST_BUFFER_FLAG_HEADER = (GST_MINI_OBJECT_FLAG_LAST << 6),
218 GST_BUFFER_FLAG_GAP = (GST_MINI_OBJECT_FLAG_LAST << 7),
219 GST_BUFFER_FLAG_DROPPABLE = (GST_MINI_OBJECT_FLAG_LAST << 8),
220 GST_BUFFER_FLAG_DELTA_UNIT = (GST_MINI_OBJECT_FLAG_LAST << 9),
221 GST_BUFFER_FLAG_IN_CAPS = (GST_MINI_OBJECT_FLAG_LAST << 10),
223 GST_BUFFER_FLAG_LAST = (GST_MINI_OBJECT_FLAG_LAST << 20)
228 * @mini_object: the parent structure
229 * @pool: pointer to the pool owner of the buffer
230 * @pts: presentation timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
231 * pts is not known or relevant. The pts contains the timestamp when the
232 * media should be presented to the user.
233 * @dts: decoding timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
234 * dts is not known or relevant. The dts contains the timestamp when the
235 * media should be processed.
236 * @duration: duration in time of the buffer data, can be #GST_CLOCK_TIME_NONE
237 * when the duration is not known or relevant.
238 * @offset: a media specific offset for the buffer data.
239 * For video frames, this is the frame number of this buffer.
240 * For audio samples, this is the offset of the first sample in this buffer.
241 * For file data or compressed data this is the byte offset of the first
242 * byte in this buffer.
243 * @offset_end: the last offset contained in this buffer. It has the same
246 * The structure of a #GstBuffer. Use the associated macros to access the public
250 GstMiniObject mini_object;
252 /*< public >*/ /* with COW */
258 GstClockTime duration;
260 /* media specific offset */
265 GType gst_buffer_get_type (void);
268 GstBuffer * gst_buffer_new (void);
269 GstBuffer * gst_buffer_new_allocate (const GstAllocator * allocator, gsize size, gsize align);
270 GstBuffer * gst_buffer_new_wrapped_full (gpointer data, GFreeFunc free_func, gsize offset, gsize size);
271 GstBuffer * gst_buffer_new_wrapped (gpointer data, gsize size);
274 guint gst_buffer_n_memory (GstBuffer *buffer);
275 void gst_buffer_take_memory (GstBuffer *buffer, gint idx, GstMemory *mem);
276 GstMemory * gst_buffer_peek_memory (GstBuffer *buffer, guint idx, GstMapFlags flags);
277 void gst_buffer_remove_memory_range (GstBuffer *buffer, guint idx, guint length);
280 * gst_buffer_remove_memory:
284 * Remove the memory block in @b at @i.
286 #define gst_buffer_remove_memory(b,i) gst_buffer_remove_memory_range ((b), (i), 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))
318 gpointer gst_buffer_map (GstBuffer *buffer, gsize *size, gsize *maxsize,
320 gboolean gst_buffer_unmap (GstBuffer *buffer, gpointer data, gssize size);
325 * @buf: a #GstBuffer.
327 * Increases the refcount of the given buffer by one.
329 * Note that the refcount affects the writeability
330 * of @buf and its metadata, see gst_buffer_is_writable() and
331 * gst_buffer_is_metadata_writable(). It is
332 * important to note that keeping additional references to
333 * GstBuffer instances can potentially increase the number
334 * of memcpy operations in a pipeline.
336 * Returns: (transfer full): @buf
338 #ifdef _FOOL_GTK_DOC_
339 G_INLINE_FUNC GstBuffer * gst_buffer_ref (GstBuffer * buf);
342 static inline GstBuffer *
343 gst_buffer_ref (GstBuffer * buf)
345 return (GstBuffer *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (buf));
350 * @buf: (transfer full): a #GstBuffer.
352 * Decreases the refcount of the buffer. If the refcount reaches 0, the buffer
353 * with the associated metadata and memory will be freed.
355 #ifdef _FOOL_GTK_DOC_
356 G_INLINE_FUNC void gst_buffer_unref (GstBuffer * buf);
360 gst_buffer_unref (GstBuffer * buf)
362 gst_mini_object_unref (GST_MINI_OBJECT_CAST (buf));
368 * @buf: a #GstBuffer.
370 * Create a copy of the given buffer. This will also make a newly allocated
371 * copy of the data the source buffer contains.
373 * Returns: (transfer full): a new copy of @buf.
375 #ifdef _FOOL_GTK_DOC_
376 G_INLINE_FUNC GstBuffer * gst_buffer_copy (const GstBuffer * buf);
379 static inline GstBuffer *
380 gst_buffer_copy (const GstBuffer * buf)
382 return GST_BUFFER (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (buf)));
387 * GstBufferCopyFlags:
388 * @GST_BUFFER_COPY_NONE: copy nothing
389 * @GST_BUFFER_COPY_FLAGS: flag indicating that buffer flags should be copied
390 * @GST_BUFFER_COPY_TIMESTAMPS: flag indicating that buffer pts, dts,
391 * duration, offset and offset_end should be copied
392 * @GST_BUFFER_COPY_MEMORY: flag indicating that buffer memory should be copied
393 * and appended to already existing memory
394 * @GST_BUFFER_COPY_MERGE: flag indicating that buffer memory should be
396 * @GST_BUFFER_COPY_META: flag indicating that buffer meta should be
399 * A set of flags that can be provided to the gst_buffer_copy_into()
400 * function to specify which items should be copied.
403 GST_BUFFER_COPY_NONE = 0,
404 GST_BUFFER_COPY_FLAGS = (1 << 0),
405 GST_BUFFER_COPY_TIMESTAMPS = (1 << 1),
406 GST_BUFFER_COPY_META = (1 << 2),
407 GST_BUFFER_COPY_MEMORY = (1 << 3),
408 GST_BUFFER_COPY_MERGE = (1 << 4)
409 } GstBufferCopyFlags;
412 * GST_BUFFER_COPY_METADATA:
414 * Combination of all possible metadata fields that can be copied with
415 * gst_buffer_copy_into().
417 #define GST_BUFFER_COPY_METADATA (GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS |\
418 GST_BUFFER_COPY_META)
421 * GST_BUFFER_COPY_ALL:
423 * Combination of all possible fields that can be copied with
424 * gst_buffer_copy_into().
426 #define GST_BUFFER_COPY_ALL ((GstBufferCopyFlags)(GST_BUFFER_COPY_METADATA | GST_BUFFER_COPY_MEMORY))
428 /* copies memory or metadata into newly allocated buffer */
429 void gst_buffer_copy_into (GstBuffer *dest, GstBuffer *src,
430 GstBufferCopyFlags flags,
431 gsize offset, gsize size);
434 * gst_buffer_is_writable:
437 * Tests if you can safely write data into a buffer's data array or validly
438 * modify the caps and timestamp metadata. Metadata in a GstBuffer is always
439 * writable, but it is only safe to change it when there is only one owner
440 * of the buffer - ie, the refcount is 1.
442 #define gst_buffer_is_writable(buf) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (buf))
444 * gst_buffer_make_writable:
445 * @buf: (transfer full): a #GstBuffer
447 * Makes a writable buffer from the given buffer. If the source buffer is
448 * already writable, this will simply return the same buffer. A copy will
449 * otherwise be made using gst_buffer_copy().
451 * Returns: (transfer full): a writable buffer which may or may not be the
454 #define gst_buffer_make_writable(buf) GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (buf)))
457 * gst_buffer_replace:
458 * @obuf: (inout) (transfer full): pointer to a pointer to a #GstBuffer to be
460 * @nbuf: (transfer none) (allow-none): pointer to a #GstBuffer that will
461 * replace the buffer pointed to by @obuf.
463 * Modifies a pointer to a #GstBuffer to point to a different #GstBuffer. The
464 * modification is done atomically (so this is useful for ensuring thread safety
465 * in some cases), and the reference counts are updated appropriately (the old
466 * buffer is unreffed, the new is reffed).
468 * Either @nbuf or the #GstBuffer pointed to by @obuf may be NULL.
470 * Returns: TRUE when @obuf was different from @nbuf.
472 #ifdef _FOOL_GTK_DOC_
473 G_INLINE_FUNC gboolean gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf);
476 static inline gboolean
477 gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf)
479 return gst_mini_object_replace ((GstMiniObject **) obuf, (GstMiniObject *) nbuf);
482 /* creating a region */
483 GstBuffer* gst_buffer_copy_region (GstBuffer *parent, GstBufferCopyFlags flags,
484 gsize offset, gsize size);
486 /* span, two buffers, intelligently */
487 gboolean gst_buffer_is_span_fast (GstBuffer *buf1, GstBuffer *buf2);
488 GstBuffer* gst_buffer_span (GstBuffer *buf1, gsize offset, GstBuffer *buf2, gsize size) G_GNUC_MALLOC;
491 #include <gst/gstmeta.h>
493 GstMeta * gst_buffer_get_meta (GstBuffer *buffer, const GstMetaInfo *info);
494 GstMeta * gst_buffer_add_meta (GstBuffer *buffer, const GstMetaInfo *info,
496 gboolean gst_buffer_remove_meta (GstBuffer *buffer, GstMeta *meta);
498 GstMeta * gst_buffer_iterate_meta (GstBuffer *buffer, gpointer *state);
501 * gst_value_set_buffer:
502 * @v: a #GValue to receive the data
503 * @b: (transfer none): a #GstBuffer to assign to the GstValue
505 * Sets @b as the value of @v. Caller retains reference to buffer.
507 #define gst_value_set_buffer(v,b) g_value_set_boxed((v),(b))
509 * gst_value_take_buffer:
510 * @v: a #GValue to receive the data
511 * @b: (transfer full): a #GstBuffer to assign to the GstValue
513 * Sets @b as the value of @v. Caller gives away reference to buffer.
515 #define gst_value_take_buffer(v,b) g_value_take_boxed(v,(b))
517 * gst_value_get_buffer:
518 * @v: a #GValue to query
520 * Receives a #GstBuffer as the value of @v. Does not return a reference to
521 * the buffer, so the pointer is only valid for as long as the caller owns
524 * Returns: (transfer none): buffer
526 #define gst_value_get_buffer(v) GST_BUFFER_CAST (g_value_get_boxed(v))
530 #endif /* __GST_BUFFER_H__ */