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/gstcaps.h>
30 #include <gst/gstmemory.h>
34 extern GType _gst_buffer_type;
36 typedef struct _GstBuffer GstBuffer;
37 typedef struct _GstBufferPool GstBufferPool;
40 * GST_BUFFER_TRACE_NAME:
42 * The name used for tracing memory allocations.
44 #define GST_BUFFER_TRACE_NAME "GstBuffer"
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))
55 * A flags word containing #GstBufferFlag flags set on this buffer.
57 #define GST_BUFFER_FLAGS(buf) GST_MINI_OBJECT_FLAGS(buf)
59 * GST_BUFFER_FLAG_IS_SET:
61 * @flag: the #GstBufferFlag to check.
63 * Gives the status of a specific flag on a buffer.
65 #define GST_BUFFER_FLAG_IS_SET(buf,flag) GST_MINI_OBJECT_FLAG_IS_SET (buf, flag)
67 * GST_BUFFER_FLAG_SET:
69 * @flag: the #GstBufferFlag to set.
71 * Sets a buffer flag on a buffer.
73 #define GST_BUFFER_FLAG_SET(buf,flag) GST_MINI_OBJECT_FLAG_SET (buf, flag)
75 * GST_BUFFER_FLAG_UNSET:
77 * @flag: the #GstBufferFlag to clear.
79 * Clears a buffer flag.
81 #define GST_BUFFER_FLAG_UNSET(buf,flag) GST_MINI_OBJECT_FLAG_UNSET (buf, flag)
84 * GST_BUFFER_TIMESTAMP:
85 * @buf: a #GstBuffer.:
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.
91 #define GST_BUFFER_TIMESTAMP(buf) (GST_BUFFER_CAST(buf)->timestamp)
93 * GST_BUFFER_DURATION:
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.
99 #define GST_BUFFER_DURATION(buf) (GST_BUFFER_CAST(buf)->duration)
102 * @buf: a #GstBuffer.
104 * The offset in the source file of the beginning of this buffer.
106 #define GST_BUFFER_OFFSET(buf) (GST_BUFFER_CAST(buf)->offset)
108 * GST_BUFFER_OFFSET_END:
109 * @buf: a #GstBuffer.
111 * The offset in the source file of the end of this buffer.
113 #define GST_BUFFER_OFFSET_END(buf) (GST_BUFFER_CAST(buf)->offset_end)
116 * GST_BUFFER_OFFSET_NONE:
118 * Constant for no-offset return results.
120 #define GST_BUFFER_OFFSET_NONE ((guint64)-1)
123 * GST_BUFFER_DURATION_IS_VALID:
124 * @buffer: a #GstBuffer
126 * Tests if the duration is known.
128 #define GST_BUFFER_DURATION_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DURATION (buffer)))
130 * GST_BUFFER_TIMESTAMP_IS_VALID:
131 * @buffer: a #GstBuffer
133 * Tests if the timestamp is known.
135 #define GST_BUFFER_TIMESTAMP_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_TIMESTAMP (buffer)))
137 * GST_BUFFER_OFFSET_IS_VALID:
138 * @buffer: a #GstBuffer
140 * Tests if the start offset is known.
142 #define GST_BUFFER_OFFSET_IS_VALID(buffer) (GST_BUFFER_OFFSET (buffer) != GST_BUFFER_OFFSET_NONE)
144 * GST_BUFFER_OFFSET_END_IS_VALID:
145 * @buffer: a #GstBuffer
147 * Tests if the end offset is known.
149 #define GST_BUFFER_OFFSET_END_IS_VALID(buffer) (GST_BUFFER_OFFSET_END (buffer) != GST_BUFFER_OFFSET_NONE)
151 * GST_BUFFER_IS_DISCONT:
152 * @buffer: a #GstBuffer
154 * Tests if the buffer marks a discontinuity in the stream.
158 #define GST_BUFFER_IS_DISCONT(buffer) (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DISCONT))
162 * @GST_BUFFER_FLAG_LIVE: the buffer is live data and should be discarded in
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
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.
179 * A set of buffer flags used to describe properties of a #GstBuffer.
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)
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
210 * The structure of a #GstBuffer. Use the associated macros to access the public
214 GstMiniObject mini_object;
216 /*< public >*/ /* with COW */
220 GstClockTime timestamp;
221 GstClockTime duration;
223 /* media specific offset */
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);
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);
241 * gst_buffer_remove_memory:
245 * Remove the memory block in @b at @i.
247 #define gst_buffer_remove_memory(b,i) gst_buffer_remove_memory_range ((b), (i), 1)
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);
258 gsize gst_buffer_get_sizes (GstBuffer *buffer, gsize *offset, gsize *maxsize);
259 void gst_buffer_resize (GstBuffer *buffer, gssize offset, gsize size);
262 * gst_buffer_get_size:
265 * Get the size of @b.
267 #define gst_buffer_get_size(b) gst_buffer_get_sizes ((b), NULL, NULL)
269 * gst_buffer_set_size:
273 * Set the size of @b to @s. This will remove or trim the memory blocks
276 #define gst_buffer_set_size(b,s) gst_buffer_resize ((b), 0, (s))
279 gpointer gst_buffer_map (GstBuffer *buffer, gsize *size, gsize *maxsize,
281 gboolean gst_buffer_unmap (GstBuffer *buffer, gpointer data, gsize size);
286 * @buf: a #GstBuffer.
288 * Increases the refcount of the given buffer by one.
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.
297 * Returns: (transfer full): @buf
299 #ifdef _FOOL_GTK_DOC_
300 G_INLINE_FUNC GstBuffer * gst_buffer_ref (GstBuffer * buf);
303 static inline GstBuffer *
304 gst_buffer_ref (GstBuffer * buf)
306 return (GstBuffer *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (buf));
311 * @buf: (transfer full): a #GstBuffer.
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.
317 #ifdef _FOOL_GTK_DOC_
318 G_INLINE_FUNC void gst_buffer_unref (GstBuffer * buf);
322 gst_buffer_unref (GstBuffer * buf)
324 gst_mini_object_unref (GST_MINI_OBJECT_CAST (buf));
330 * @buf: a #GstBuffer.
332 * Create a copy of the given buffer. This will also make a newly allocated
333 * copy of the data the source buffer contains.
335 * Returns: (transfer full): a new copy of @buf.
337 #ifdef _FOOL_GTK_DOC_
338 G_INLINE_FUNC GstBuffer * gst_buffer_copy (const GstBuffer * buf);
341 static inline GstBuffer *
342 gst_buffer_copy (const GstBuffer * buf)
344 return GST_BUFFER (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (buf)));
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
359 * A set of flags that can be provided to the gst_buffer_copy_into()
360 * function to specify which items should be copied.
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;
371 * GST_BUFFER_COPY_METADATA:
373 * Combination of all possible metadata fields that can be copied with
374 * gst_buffer_copy_into().
376 #define GST_BUFFER_COPY_METADATA (GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS)
379 * GST_BUFFER_COPY_ALL:
381 * Combination of all possible fields that can be copied with
382 * gst_buffer_copy_into().
384 #define GST_BUFFER_COPY_ALL ((GstBufferCopyFlags)(GST_BUFFER_COPY_METADATA | GST_BUFFER_COPY_MEMORY))
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);
392 * gst_buffer_is_writable:
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.
400 #define gst_buffer_is_writable(buf) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (buf))
402 * gst_buffer_make_writable:
403 * @buf: (transfer full): a #GstBuffer
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().
409 * Returns: (transfer full): a writable buffer which may or may not be the
412 #define gst_buffer_make_writable(buf) GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (buf)))
415 * gst_buffer_replace:
416 * @obuf: (inout) (transfer full): pointer to a pointer to a #GstBuffer to be
418 * @nbuf: (transfer none) (allow-none): pointer to a #GstBuffer that will
419 * replace the buffer pointed to by @obuf.
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).
426 * Either @nbuf or the #GstBuffer pointed to by @obuf may be NULL.
428 #define gst_buffer_replace(obuf,nbuf) \
430 GstBuffer **___obufaddr = (GstBuffer **)(obuf); \
431 gst_mini_object_replace ((GstMiniObject **)___obufaddr, \
432 GST_MINI_OBJECT_CAST (nbuf)); \
435 /* creating a region */
436 GstBuffer* gst_buffer_copy_region (GstBuffer *parent, GstBufferCopyFlags flags,
437 gsize offset, gsize size);
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);
444 #include <gst/gstmeta.h>
446 GstMeta * gst_buffer_get_meta (GstBuffer *buffer, const GstMetaInfo *info);
447 GstMeta * gst_buffer_add_meta (GstBuffer *buffer, const GstMetaInfo *info,
449 gboolean gst_buffer_remove_meta (GstBuffer *buffer, GstMeta *meta);
451 GstMeta * gst_buffer_iterate_meta (GstBuffer *buffer, gpointer *state);
454 * gst_value_set_buffer:
455 * @v: a #GValue to receive the data
456 * @b: (transfer none): a #GstBuffer to assign to the GstValue
458 * Sets @b as the value of @v. Caller retains reference to buffer.
460 #define gst_value_set_buffer(v,b) g_value_set_boxed((v),(b))
462 * gst_value_take_buffer:
463 * @v: a #GValue to receive the data
464 * @b: (transfer full): a #GstBuffer to assign to the GstValue
466 * Sets @b as the value of @v. Caller gives away reference to buffer.
468 #define gst_value_take_buffer(v,b) g_value_take_boxed(v,(b))
470 * gst_value_get_buffer:
471 * @v: a #GValue to query
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
477 * Returns: (transfer none): buffer
479 #define gst_value_get_buffer(v) GST_BUFFER_CAST (g_value_get_boxed(v))
483 #endif /* __GST_BUFFER_H__ */