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., 51 Franklin St, Fifth Floor,
20 * Boston, MA 02110-1301, USA.
24 #ifndef __GST_BUFFER_H__
25 #define __GST_BUFFER_H__
27 #include <gst/gstminiobject.h>
28 #include <gst/gstclock.h>
29 #include <gst/gstallocator.h>
33 GST_EXPORT GType _gst_buffer_type;
35 typedef struct _GstBuffer GstBuffer;
36 typedef struct _GstBufferPool GstBufferPool;
38 #include <gst/gstmeta.h>
40 #define GST_TYPE_BUFFER (_gst_buffer_type)
41 #define GST_IS_BUFFER(obj) (GST_IS_MINI_OBJECT_TYPE(obj, GST_TYPE_BUFFER))
42 #define GST_BUFFER_CAST(obj) ((GstBuffer *)(obj))
43 #define GST_BUFFER(obj) (GST_BUFFER_CAST(obj))
49 * A flags word containing #GstBufferFlags flags set on this buffer.
51 #define GST_BUFFER_FLAGS(buf) GST_MINI_OBJECT_FLAGS(buf)
53 * GST_BUFFER_FLAG_IS_SET:
55 * @flag: the #GstBufferFlags flag to check.
57 * Gives the status of a specific flag on a buffer.
59 #define GST_BUFFER_FLAG_IS_SET(buf,flag) GST_MINI_OBJECT_FLAG_IS_SET (buf, flag)
61 * GST_BUFFER_FLAG_SET:
63 * @flag: the #GstBufferFlags flag to set.
65 * Sets a buffer flag on a buffer.
67 #define GST_BUFFER_FLAG_SET(buf,flag) GST_MINI_OBJECT_FLAG_SET (buf, flag)
69 * GST_BUFFER_FLAG_UNSET:
71 * @flag: the #GstBufferFlags flag to clear.
73 * Clears a buffer flag.
75 #define GST_BUFFER_FLAG_UNSET(buf,flag) GST_MINI_OBJECT_FLAG_UNSET (buf, flag)
80 * @buf: a #GstBuffer.:
82 * The presentation timestamp (pts) in nanoseconds (as a #GstClockTime)
83 * of the data in the buffer. This is the timestamp when the media should be
84 * presented to the user.
85 * Value will be %GST_CLOCK_TIME_NONE if the pts is unknown.
87 #define GST_BUFFER_PTS(buf) (GST_BUFFER_CAST(buf)->pts)
90 * @buf: a #GstBuffer.:
92 * The decoding timestamp (dts) in nanoseconds (as a #GstClockTime)
93 * of the data in the buffer. This is the timestamp when the media should be
94 * decoded or processed otherwise.
95 * Value will be %GST_CLOCK_TIME_NONE if the dts is unknown.
97 #define GST_BUFFER_DTS(buf) (GST_BUFFER_CAST(buf)->dts)
99 * GST_BUFFER_DTS_OR_PTS:
100 * @buf: a #GstBuffer.:
102 * Returns the buffer decoding timestamp (dts) if valid, else the buffer
103 * presentation time (pts)
107 #define GST_BUFFER_DTS_OR_PTS(buf) (GST_BUFFER_DTS_IS_VALID(buf) ? GST_BUFFER_DTS(buf) : GST_BUFFER_PTS (buf))
109 * GST_BUFFER_DURATION:
110 * @buf: a #GstBuffer.
112 * The duration in nanoseconds (as a #GstClockTime) of the data in the buffer.
113 * Value will be %GST_CLOCK_TIME_NONE if the duration is unknown.
115 #define GST_BUFFER_DURATION(buf) (GST_BUFFER_CAST(buf)->duration)
118 * @buf: a #GstBuffer.
120 * The offset in the source file of the beginning of this buffer.
122 #define GST_BUFFER_OFFSET(buf) (GST_BUFFER_CAST(buf)->offset)
124 * GST_BUFFER_OFFSET_END:
125 * @buf: a #GstBuffer.
127 * The offset in the source file of the end of this buffer.
129 #define GST_BUFFER_OFFSET_END(buf) (GST_BUFFER_CAST(buf)->offset_end)
132 * GST_BUFFER_OFFSET_NONE:
134 * Constant for no-offset return results.
136 #define GST_BUFFER_OFFSET_NONE ((guint64)-1)
139 * GST_BUFFER_DURATION_IS_VALID:
140 * @buffer: a #GstBuffer
142 * Tests if the duration is known.
144 #define GST_BUFFER_DURATION_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DURATION (buffer)))
146 * GST_BUFFER_PTS_IS_VALID:
147 * @buffer: a #GstBuffer
149 * Tests if the pts is known.
151 #define GST_BUFFER_PTS_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_PTS (buffer)))
153 * GST_BUFFER_DTS_IS_VALID:
154 * @buffer: a #GstBuffer
156 * Tests if the dts is known.
158 #define GST_BUFFER_DTS_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DTS (buffer)))
160 * GST_BUFFER_OFFSET_IS_VALID:
161 * @buffer: a #GstBuffer
163 * Tests if the start offset is known.
165 #define GST_BUFFER_OFFSET_IS_VALID(buffer) (GST_BUFFER_OFFSET (buffer) != GST_BUFFER_OFFSET_NONE)
167 * GST_BUFFER_OFFSET_END_IS_VALID:
168 * @buffer: a #GstBuffer
170 * Tests if the end offset is known.
172 #define GST_BUFFER_OFFSET_END_IS_VALID(buffer) (GST_BUFFER_OFFSET_END (buffer) != GST_BUFFER_OFFSET_NONE)
174 * GST_BUFFER_IS_DISCONT:
175 * @buffer: a #GstBuffer
177 * Tests if the buffer marks a discontinuity in the stream.
179 #define GST_BUFFER_IS_DISCONT(buffer) (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DISCONT))
183 * @GST_BUFFER_FLAG_LIVE: the buffer is live data and should be discarded in
185 * @GST_BUFFER_FLAG_DECODE_ONLY: the buffer contains data that should be dropped
186 * because it will be clipped against the segment
187 * boundaries or because it does not contain data
188 * that should be shown to the user.
189 * @GST_BUFFER_FLAG_DISCONT: the buffer marks a data discontinuity in the stream.
190 * This typically occurs after a seek or a dropped buffer
191 * from a live or network source.
192 * @GST_BUFFER_FLAG_RESYNC: the buffer timestamps might have a discontinuity
193 * and this buffer is a good point to resynchronize.
194 * @GST_BUFFER_FLAG_CORRUPTED: the buffer data is corrupted.
195 * @GST_BUFFER_FLAG_MARKER: the buffer contains a media specific marker. for
196 * video this is typically the end of a frame boundary, for audio
197 * this is usually the start of a talkspurt.
198 * @GST_BUFFER_FLAG_HEADER: the buffer contains header information that is
199 * needed to decode the following data.
200 * @GST_BUFFER_FLAG_GAP: the buffer has been created to fill a gap in the
201 * stream and contains media neutral data (elements can
202 * switch to optimized code path that ignores the buffer
204 * @GST_BUFFER_FLAG_DROPPABLE: the buffer can be dropped without breaking the
205 * stream, for example to reduce bandwidth.
206 * @GST_BUFFER_FLAG_DELTA_UNIT: this unit cannot be decoded independently.
207 * @GST_BUFFER_FLAG_TAG_MEMORY: this flag is set when memory of the buffer
209 * @GST_BUFFER_FLAG_SYNC_AFTER: Elements which write to disk or permanent
210 * storage should ensure the data is synced after
211 * writing the contents of this buffer. (Since 1.6)
212 * @GST_BUFFER_FLAG_LAST: additional media specific flags can be added starting from
215 * A set of buffer flags used to describe properties of a #GstBuffer.
218 GST_BUFFER_FLAG_LIVE = (GST_MINI_OBJECT_FLAG_LAST << 0),
219 GST_BUFFER_FLAG_DECODE_ONLY = (GST_MINI_OBJECT_FLAG_LAST << 1),
220 GST_BUFFER_FLAG_DISCONT = (GST_MINI_OBJECT_FLAG_LAST << 2),
221 GST_BUFFER_FLAG_RESYNC = (GST_MINI_OBJECT_FLAG_LAST << 3),
222 GST_BUFFER_FLAG_CORRUPTED = (GST_MINI_OBJECT_FLAG_LAST << 4),
223 GST_BUFFER_FLAG_MARKER = (GST_MINI_OBJECT_FLAG_LAST << 5),
224 GST_BUFFER_FLAG_HEADER = (GST_MINI_OBJECT_FLAG_LAST << 6),
225 GST_BUFFER_FLAG_GAP = (GST_MINI_OBJECT_FLAG_LAST << 7),
226 GST_BUFFER_FLAG_DROPPABLE = (GST_MINI_OBJECT_FLAG_LAST << 8),
227 GST_BUFFER_FLAG_DELTA_UNIT = (GST_MINI_OBJECT_FLAG_LAST << 9),
228 GST_BUFFER_FLAG_TAG_MEMORY = (GST_MINI_OBJECT_FLAG_LAST << 10),
229 GST_BUFFER_FLAG_SYNC_AFTER = (GST_MINI_OBJECT_FLAG_LAST << 11),
231 GST_BUFFER_FLAG_LAST = (GST_MINI_OBJECT_FLAG_LAST << 16)
236 * @mini_object: the parent structure
237 * @pool: pointer to the pool owner of the buffer
238 * @pts: presentation timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
239 * pts is not known or relevant. The pts contains the timestamp when the
240 * media should be presented to the user.
241 * @dts: decoding timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
242 * dts is not known or relevant. The dts contains the timestamp when the
243 * media should be processed.
244 * @duration: duration in time of the buffer data, can be #GST_CLOCK_TIME_NONE
245 * when the duration is not known or relevant.
246 * @offset: a media specific offset for the buffer data.
247 * For video frames, this is the frame number of this buffer.
248 * For audio samples, this is the offset of the first sample in this buffer.
249 * For file data or compressed data this is the byte offset of the first
250 * byte in this buffer.
251 * @offset_end: the last offset contained in this buffer. It has the same
254 * The structure of a #GstBuffer. Use the associated macros to access the public
258 GstMiniObject mini_object;
260 /*< public >*/ /* with COW */
266 GstClockTime duration;
268 /* media specific offset */
273 GType gst_buffer_get_type (void);
275 guint gst_buffer_get_max_memory (void);
278 GstBuffer * gst_buffer_new (void);
279 GstBuffer * gst_buffer_new_allocate (GstAllocator * allocator, gsize size,
280 GstAllocationParams * params);
281 GstBuffer * gst_buffer_new_wrapped_full (GstMemoryFlags flags, gpointer data, gsize maxsize,
282 gsize offset, gsize size, gpointer user_data,
283 GDestroyNotify notify);
284 GstBuffer * gst_buffer_new_wrapped (gpointer data, gsize size);
287 guint gst_buffer_n_memory (GstBuffer *buffer);
288 void gst_buffer_insert_memory (GstBuffer *buffer, gint idx, GstMemory *mem);
289 void gst_buffer_replace_memory_range (GstBuffer *buffer, guint idx, gint length, GstMemory *mem);
290 GstMemory * gst_buffer_peek_memory (GstBuffer *buffer, guint idx);
291 GstMemory * gst_buffer_get_memory_range (GstBuffer *buffer, guint idx, gint length);
292 void gst_buffer_remove_memory_range (GstBuffer *buffer, guint idx, gint length);
294 void gst_buffer_prepend_memory (GstBuffer *buffer, GstMemory *mem);
295 void gst_buffer_append_memory (GstBuffer *buffer, GstMemory *mem);
296 void gst_buffer_replace_memory (GstBuffer *buffer, guint idx, GstMemory *mem);
297 void gst_buffer_replace_all_memory (GstBuffer *buffer, GstMemory *mem);
298 GstMemory * gst_buffer_get_memory (GstBuffer *buffer, guint idx);
299 GstMemory * gst_buffer_get_all_memory (GstBuffer *buffer);
300 void gst_buffer_remove_memory (GstBuffer *buffer, guint idx);
301 void gst_buffer_remove_all_memory (GstBuffer *buffer);
303 gboolean gst_buffer_find_memory (GstBuffer *buffer, gsize offset, gsize size,
304 guint *idx, guint *length, gsize *skip);
306 gboolean gst_buffer_is_memory_range_writable (GstBuffer *buffer, guint idx, gint length);
307 gboolean gst_buffer_is_all_memory_writable (GstBuffer *buffer);
309 gsize gst_buffer_fill (GstBuffer *buffer, gsize offset,
310 gconstpointer src, gsize size);
311 gsize gst_buffer_extract (GstBuffer *buffer, gsize offset,
312 gpointer dest, gsize size);
313 gint gst_buffer_memcmp (GstBuffer *buffer, gsize offset,
314 gconstpointer mem, gsize size);
315 gsize gst_buffer_memset (GstBuffer *buffer, gsize offset,
316 guint8 val, gsize size);
318 gsize gst_buffer_get_sizes_range (GstBuffer *buffer, guint idx, gint length,
319 gsize *offset, gsize *maxsize);
320 gboolean gst_buffer_resize_range (GstBuffer *buffer, guint idx, gint length,
321 gssize offset, gssize size);
323 gsize gst_buffer_get_sizes (GstBuffer *buffer, gsize *offset, gsize *maxsize);
324 gsize gst_buffer_get_size (GstBuffer *buffer);
325 void gst_buffer_resize (GstBuffer *buffer, gssize offset, gssize size);
326 void gst_buffer_set_size (GstBuffer *buffer, gssize size);
328 gboolean gst_buffer_map_range (GstBuffer *buffer, guint idx, gint length,
329 GstMapInfo *info, GstMapFlags flags);
330 gboolean gst_buffer_map (GstBuffer *buffer, GstMapInfo *info, GstMapFlags flags);
332 void gst_buffer_unmap (GstBuffer *buffer, GstMapInfo *info);
333 void gst_buffer_extract_dup (GstBuffer *buffer, gsize offset,
334 gsize size, gpointer *dest,
337 GstBufferFlags gst_buffer_get_flags (GstBuffer * buffer);
338 gboolean gst_buffer_has_flags (GstBuffer * buffer, GstBufferFlags flags);
339 gboolean gst_buffer_set_flags (GstBuffer * buffer, GstBufferFlags flags);
340 gboolean gst_buffer_unset_flags (GstBuffer * buffer, GstBufferFlags flags);
347 * @buf: a #GstBuffer.
349 * Increases the refcount of the given buffer by one.
351 * Note that the refcount affects the writability
352 * of @buf and its metadata, see gst_buffer_is_writable().
353 * It is important to note that keeping additional references to
354 * GstBuffer instances can potentially increase the number
355 * of memcpy operations in a pipeline.
357 * Returns: (transfer full): @buf
359 static inline GstBuffer *
360 gst_buffer_ref (GstBuffer * buf)
362 return (GstBuffer *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (buf));
367 * @buf: (transfer full): a #GstBuffer.
369 * Decreases the refcount of the buffer. If the refcount reaches 0, the buffer
370 * with the associated metadata and memory will be freed.
373 gst_buffer_unref (GstBuffer * buf)
375 gst_mini_object_unref (GST_MINI_OBJECT_CAST (buf));
381 * @buf: a #GstBuffer.
383 * Create a copy of the given buffer. This will only copy the buffer's
384 * data to a newly allocated memory if needed (if the type of memory
385 * requires it), otherwise the underlying data is just referenced.
386 * Check gst_buffer_copy_deep() if you want to force the data
387 * to be copied to newly allocated memory.
389 * Returns: (transfer full): a new copy of @buf.
391 static inline GstBuffer *
392 gst_buffer_copy (const GstBuffer * buf)
394 return GST_BUFFER (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (buf)));
397 GstBuffer * gst_buffer_copy_deep (const GstBuffer * buf);
400 * GstBufferCopyFlags:
401 * @GST_BUFFER_COPY_NONE: copy nothing
402 * @GST_BUFFER_COPY_FLAGS: flag indicating that buffer flags should be copied
403 * @GST_BUFFER_COPY_TIMESTAMPS: flag indicating that buffer pts, dts,
404 * duration, offset and offset_end should be copied
405 * @GST_BUFFER_COPY_MEMORY: flag indicating that buffer memory should be reffed
406 * and appended to already existing memory. Unless the memory is marked as
407 * NO_SHARE, no actual copy of the memory is made but it is simply reffed.
408 * Add @GST_BUFFER_COPY_DEEP to force a real copy.
409 * @GST_BUFFER_COPY_MERGE: flag indicating that buffer memory should be
411 * @GST_BUFFER_COPY_META: flag indicating that buffer meta should be
413 * @GST_BUFFER_COPY_DEEP: flag indicating that memory should always be
414 * copied instead of reffed (Since 1.2)
416 * A set of flags that can be provided to the gst_buffer_copy_into()
417 * function to specify which items should be copied.
420 GST_BUFFER_COPY_NONE = 0,
421 GST_BUFFER_COPY_FLAGS = (1 << 0),
422 GST_BUFFER_COPY_TIMESTAMPS = (1 << 1),
423 GST_BUFFER_COPY_META = (1 << 2),
424 GST_BUFFER_COPY_MEMORY = (1 << 3),
425 GST_BUFFER_COPY_MERGE = (1 << 4),
426 GST_BUFFER_COPY_DEEP = (1 << 5)
427 } GstBufferCopyFlags;
430 * GST_BUFFER_COPY_METADATA:
432 * Combination of all possible metadata fields that can be copied with
433 * gst_buffer_copy_into().
435 #define GST_BUFFER_COPY_METADATA (GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS |\
436 GST_BUFFER_COPY_META)
439 * GST_BUFFER_COPY_ALL:
441 * Combination of all possible fields that can be copied with
442 * gst_buffer_copy_into().
444 #define GST_BUFFER_COPY_ALL ((GstBufferCopyFlags)(GST_BUFFER_COPY_METADATA | GST_BUFFER_COPY_MEMORY))
446 /* copies memory or metadata into newly allocated buffer */
447 gboolean gst_buffer_copy_into (GstBuffer *dest, GstBuffer *src,
448 GstBufferCopyFlags flags,
449 gsize offset, gsize size);
452 * gst_buffer_is_writable:
455 * Tests if you can safely write to a buffer's metadata or its memory array.
456 * It is only safe to change buffer metadata when the current reference is
457 * writable, i.e. nobody can see the modifications you will make.
459 #define gst_buffer_is_writable(buf) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (buf))
461 * gst_buffer_make_writable:
462 * @buf: (transfer full): a #GstBuffer
464 * Returns a writable copy of @buf. If the source buffer is
465 * already writable, this will simply return the same buffer.
467 * Use this function to ensure that a buffer can be safely modified before
468 * making changes to it, including changing the metadata such as PTS/DTS.
470 * If the reference count of the source buffer @buf is exactly one, the caller
471 * is the sole owner and this function will return the buffer object unchanged.
473 * If there is more than one reference on the object, a copy will be made using
474 * gst_buffer_copy(). The passed-in @buf will be unreffed in that case, and the
475 * caller will now own a reference to the new returned buffer object. Note
476 * that this just copies the buffer structure itself, the underlying memory is
477 * not copied if it can be shared amongst multiple buffers.
479 * In short, this function unrefs the buf in the argument and refs the buffer
480 * that it returns. Don't access the argument after calling this function unless
481 * you have an additional reference to it.
483 * Returns: (transfer full): a writable buffer which may or may not be the
486 #define gst_buffer_make_writable(buf) GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (buf)))
489 * gst_buffer_replace:
490 * @obuf: (inout) (transfer full) (nullable): pointer to a pointer to
491 * a #GstBuffer to be replaced.
492 * @nbuf: (transfer none) (allow-none): pointer to a #GstBuffer that will
493 * replace the buffer pointed to by @obuf.
495 * Modifies a pointer to a #GstBuffer to point to a different #GstBuffer. The
496 * modification is done atomically (so this is useful for ensuring thread safety
497 * in some cases), and the reference counts are updated appropriately (the old
498 * buffer is unreffed, the new is reffed).
500 * Either @nbuf or the #GstBuffer pointed to by @obuf may be %NULL.
502 * Returns: %TRUE when @obuf was different from @nbuf.
504 static inline gboolean
505 gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf)
507 return gst_mini_object_replace ((GstMiniObject **) obuf, (GstMiniObject *) nbuf);
510 /* creating a region */
511 GstBuffer* gst_buffer_copy_region (GstBuffer *parent, GstBufferCopyFlags flags,
512 gsize offset, gsize size);
514 /* append two buffers */
515 GstBuffer* gst_buffer_append_region (GstBuffer *buf1, GstBuffer *buf2,
516 gssize offset, gssize size);
517 GstBuffer* gst_buffer_append (GstBuffer *buf1, GstBuffer *buf2);
520 #include <gst/gstmeta.h>
523 * GstBufferForeachMetaFunc:
524 * @buffer: a #GstBuffer
525 * @meta: (out) (nullable): a pointer to a #GstMeta
526 * @user_data: user data passed to gst_buffer_foreach_meta()
528 * A function that will be called from gst_buffer_foreach_meta(). The @meta
529 * field will point to a the reference of the meta.
531 * @buffer should not be modified from this callback.
533 * When this function returns %TRUE, the next meta will be
534 * returned. When %FALSE is returned, gst_buffer_foreach_meta() will return.
536 * When @meta is set to %NULL, the item will be removed from the buffer.
538 * Returns: %FALSE when gst_buffer_foreach_meta() should stop
540 typedef gboolean (*GstBufferForeachMetaFunc) (GstBuffer *buffer, GstMeta **meta,
543 GstMeta * gst_buffer_get_meta (GstBuffer *buffer, GType api);
544 GstMeta * gst_buffer_add_meta (GstBuffer *buffer, const GstMetaInfo *info,
546 gboolean gst_buffer_remove_meta (GstBuffer *buffer, GstMeta *meta);
548 GstMeta * gst_buffer_iterate_meta (GstBuffer *buffer, gpointer *state);
550 GstMeta * gst_buffer_iterate_meta_filtered (GstBuffer * buffer,
552 GType meta_api_type);
554 gboolean gst_buffer_foreach_meta (GstBuffer *buffer,
555 GstBufferForeachMetaFunc func,
559 * gst_value_set_buffer:
560 * @v: a #GValue to receive the data
561 * @b: (transfer none): a #GstBuffer to assign to the GstValue
563 * Sets @b as the value of @v. Caller retains reference to buffer.
565 #define gst_value_set_buffer(v,b) g_value_set_boxed((v),(b))
567 * gst_value_take_buffer:
568 * @v: a #GValue to receive the data
569 * @b: (transfer full): a #GstBuffer to assign to the GstValue
571 * Sets @b as the value of @v. Caller gives away reference to buffer.
573 #define gst_value_take_buffer(v,b) g_value_take_boxed(v,(b))
575 * gst_value_get_buffer:
576 * @v: a #GValue to query
578 * Receives a #GstBuffer as the value of @v. Does not return a reference to
579 * the buffer, so the pointer is only valid for as long as the caller owns
582 * Returns: (transfer none): buffer
584 #define gst_value_get_buffer(v) GST_BUFFER_CAST (g_value_get_boxed(v))
586 typedef struct _GstParentBufferMeta GstParentBufferMeta;
589 * GstParentBufferMeta:
590 * @parent: the parent #GstMeta structure
591 * @buffer: the #GstBuffer on which a reference is being held.
593 * The #GstParentBufferMeta is a #GstMeta which can be attached to a #GstBuffer
594 * to hold a reference to another buffer that is only released when the child
595 * #GstBuffer is released.
597 * Typically, #GstParentBufferMeta is used when the child buffer is directly
598 * using the #GstMemory of the parent buffer, and wants to prevent the parent
599 * buffer from being returned to a buffer pool until the #GstMemory is available
604 struct _GstParentBufferMeta
612 GType gst_parent_buffer_meta_api_get_type (void);
613 #ifndef GST_DISABLE_DEPRECATED
614 #define GST_TYPE_PARENT_BUFFER_META_API_TYPE GST_PARENT_BUFFER_META_API_TYPE
616 #define GST_PARENT_BUFFER_META_API_TYPE (gst_parent_buffer_meta_api_get_type())
619 * gst_buffer_get_parent_buffer_meta:
622 * Find and return a #GstParentBufferMeta if one exists on the
625 #define gst_buffer_get_parent_buffer_meta(b) \
626 ((GstParentBufferMeta*)gst_buffer_get_meta((b),GST_PARENT_BUFFER_META_API_TYPE))
628 const GstMetaInfo *gst_parent_buffer_meta_get_info (void);
629 #define GST_PARENT_BUFFER_META_INFO (gst_parent_buffer_meta_get_info())
632 GstParentBufferMeta *gst_buffer_add_parent_buffer_meta (GstBuffer *buffer,
635 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
636 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstBuffer, gst_buffer_unref)
639 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
640 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstBufferPool, gst_object_unref)
645 #endif /* __GST_BUFFER_H__ */