2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
5 * gstbuffer.c: Buffer operations
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.
26 * @short_description: Data-passing buffer type
27 * @see_also: #GstPad, #GstMiniObject, #GstMemory, #GstMeta, #GstBufferPool
29 * Buffers are the basic unit of data transfer in GStreamer. They contain the
30 * timing and offset along with other arbitrary metadata that is associated
31 * with the #GstMemory blocks that the buffer contains.
33 * Buffers are usually created with gst_buffer_new(). After a buffer has been
34 * created one will typically allocate memory for it and add it to the buffer.
35 * The following example creates a buffer that can hold a given video frame
36 * with a given width, height and bits per plane.
37 * |[<!-- language="C" -->
40 * gint size, width, height, bpp;
42 * size = width * height * bpp;
43 * buffer = gst_buffer_new ();
44 * memory = gst_allocator_alloc (NULL, size, NULL);
45 * gst_buffer_insert_memory (buffer, -1, memory);
49 * Alternatively, use gst_buffer_new_allocate() to create a buffer with
50 * preallocated data of a given size.
52 * Buffers can contain a list of #GstMemory objects. You can retrieve how many
53 * memory objects with gst_buffer_n_memory() and you can get a pointer
54 * to memory with gst_buffer_peek_memory()
56 * A buffer will usually have timestamps, and a duration, but neither of these
57 * are guaranteed (they may be set to #GST_CLOCK_TIME_NONE). Whenever a
58 * meaningful value can be given for these, they should be set. The timestamps
59 * and duration are measured in nanoseconds (they are #GstClockTime values).
61 * The buffer DTS refers to the timestamp when the buffer should be decoded and
62 * is usually monotonically increasing. The buffer PTS refers to the timestamp when
63 * the buffer content should be presented to the user and is not always
64 * monotonically increasing.
66 * A buffer can also have one or both of a start and an end offset. These are
67 * media-type specific. For video buffers, the start offset will generally be
68 * the frame number. For audio buffers, it will be the number of samples
69 * produced so far. For compressed data, it could be the byte offset in a
70 * source or destination file. Likewise, the end offset will be the offset of
71 * the end of the buffer. These can only be meaningfully interpreted if you
72 * know the media type of the buffer (the preceding CAPS event). Either or both
73 * can be set to #GST_BUFFER_OFFSET_NONE.
75 * gst_buffer_ref() is used to increase the refcount of a buffer. This must be
76 * done when you want to keep a handle to the buffer after pushing it to the
77 * next element. The buffer refcount determines the writability of the buffer, a
78 * buffer is only writable when the refcount is exactly 1, i.e. when the caller
79 * has the only reference to the buffer.
81 * To efficiently create a smaller buffer out of an existing one, you can
82 * use gst_buffer_copy_region(). This method tries to share the memory objects
83 * between the two buffers.
85 * If a plug-in wants to modify the buffer data or metadata in-place, it should
86 * first obtain a buffer that is safe to modify by using
87 * gst_buffer_make_writable(). This function is optimized so that a copy will
88 * only be made when it is necessary.
90 * Several flags of the buffer can be set and unset with the
91 * GST_BUFFER_FLAG_SET() and GST_BUFFER_FLAG_UNSET() macros. Use
92 * GST_BUFFER_FLAG_IS_SET() to test if a certain #GstBufferFlags flag is set.
94 * Buffers can be efficiently merged into a larger buffer with
95 * gst_buffer_append(). Copying of memory will only be done when absolutely
98 * Arbitrary extra metadata can be set on a buffer with gst_buffer_add_meta().
99 * Metadata can be retrieved with gst_buffer_get_meta(). See also #GstMeta
101 * An element should either unref the buffer or push it out on a src pad
102 * using gst_pad_push() (see #GstPad).
104 * Buffers are usually freed by unreffing them with gst_buffer_unref(). When
105 * the refcount drops to 0, any memory and metadata pointed to by the buffer is
106 * unreffed as well. Buffers allocated from a #GstBufferPool will be returned to
107 * the pool when the refcount drops to 0.
109 * The #GstParentBufferMeta is a meta which can be attached to a #GstBuffer
110 * to hold a reference to another buffer that is only released when the child
111 * #GstBuffer is released.
113 * Typically, #GstParentBufferMeta is used when the child buffer is directly
114 * using the #GstMemory of the parent buffer, and wants to prevent the parent
115 * buffer from being returned to a buffer pool until the #GstMemory is available
116 * for re-use. (Since 1.6)
119 #include "gst_private.h"
128 #include "gstbuffer.h"
129 #include "gstbufferpool.h"
131 #include "gstutils.h"
132 #include "gstversion.h"
134 GType _gst_buffer_type = 0;
136 typedef struct _GstMetaItem GstMetaItem;
143 #define ITEM_SIZE(info) ((info)->size + sizeof (GstMetaItem))
145 #define GST_BUFFER_MEM_MAX 16
147 #define GST_BUFFER_SLICE_SIZE(b) (((GstBufferImpl *)(b))->slice_size)
148 #define GST_BUFFER_MEM_LEN(b) (((GstBufferImpl *)(b))->len)
149 #define GST_BUFFER_MEM_ARRAY(b) (((GstBufferImpl *)(b))->mem)
150 #define GST_BUFFER_MEM_PTR(b,i) (((GstBufferImpl *)(b))->mem[i])
151 #define GST_BUFFER_BUFMEM(b) (((GstBufferImpl *)(b))->bufmem)
152 #define GST_BUFFER_META(b) (((GstBufferImpl *)(b))->item)
160 /* the memory blocks */
162 GstMemory *mem[GST_BUFFER_MEM_MAX];
164 /* memory of the buffer when allocated from 1 chunk */
167 /* FIXME, make metadata allocation more efficient by using part of the
174 _is_span (GstMemory ** mem, gsize len, gsize * poffset, GstMemory ** parent)
176 GstMemory *mcur, *mprv;
177 gboolean have_offset = FALSE;
182 for (i = 0; i < len; i++) {
190 /* check if memory is contiguous */
191 if (!gst_memory_is_span (mprv, mcur, &poffs))
198 *parent = mprv->parent;
208 _get_merged_memory (GstBuffer * buffer, guint idx, guint length)
210 GstMemory **mem, *result = NULL;
212 GST_CAT_LOG (GST_CAT_BUFFER, "buffer %p, idx %u, length %u", buffer, idx,
215 mem = GST_BUFFER_MEM_ARRAY (buffer);
217 if (G_UNLIKELY (length == 0)) {
219 } else if (G_LIKELY (length == 1)) {
220 result = gst_memory_ref (mem[idx]);
222 GstMemory *parent = NULL;
223 gsize size, poffset = 0;
225 size = gst_buffer_get_sizes_range (buffer, idx, length, NULL, NULL);
227 if (G_UNLIKELY (_is_span (mem + idx, length, &poffset, &parent))) {
228 if (!GST_MEMORY_IS_NO_SHARE (parent))
229 result = gst_memory_share (parent, poffset, size);
231 GST_CAT_DEBUG (GST_CAT_PERFORMANCE, "copy for merge %p", parent);
232 result = gst_memory_copy (parent, poffset, size);
235 gsize i, tocopy, left;
236 GstMapInfo sinfo, dinfo;
239 result = gst_allocator_alloc (NULL, size, NULL);
240 if (result == NULL || !gst_memory_map (result, &dinfo, GST_MAP_WRITE)) {
241 GST_CAT_ERROR (GST_CAT_BUFFER, "Failed to map memory writable");
243 gst_memory_unref (result);
250 for (i = idx; i < (idx + length) && left > 0; i++) {
251 if (!gst_memory_map (mem[i], &sinfo, GST_MAP_READ)) {
252 GST_CAT_ERROR (GST_CAT_BUFFER,
253 "buffer %p, idx %u, length %u failed to map readable", buffer,
255 gst_memory_unmap (result, &dinfo);
256 gst_memory_unref (result);
259 tocopy = MIN (sinfo.size, left);
260 GST_CAT_DEBUG (GST_CAT_PERFORMANCE,
261 "memcpy %" G_GSIZE_FORMAT " bytes for merge %p from memory %p",
262 tocopy, result, mem[i]);
263 memcpy (ptr, (guint8 *) sinfo.data, tocopy);
266 gst_memory_unmap (mem[i], &sinfo);
268 gst_memory_unmap (result, &dinfo);
275 _replace_memory (GstBuffer * buffer, guint len, guint idx, guint length,
282 GST_CAT_LOG (GST_CAT_BUFFER,
283 "buffer %p replace %u-%" G_GSIZE_FORMAT " with memory %p", buffer, idx,
286 /* unref old memory */
287 for (i = idx; i < end; i++) {
288 GstMemory *old = GST_BUFFER_MEM_PTR (buffer, i);
290 gst_memory_unlock (old, GST_LOCK_FLAG_EXCLUSIVE);
291 gst_memory_unref (old);
295 /* replace with single memory */
296 gst_memory_lock (mem, GST_LOCK_FLAG_EXCLUSIVE);
297 GST_BUFFER_MEM_PTR (buffer, idx) = mem;
303 memmove (&GST_BUFFER_MEM_PTR (buffer, idx),
304 &GST_BUFFER_MEM_PTR (buffer, end), (len - end) * sizeof (gpointer));
306 GST_BUFFER_MEM_LEN (buffer) = len - length;
307 GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY);
311 * gst_buffer_get_flags:
312 * @buffer: a #GstBuffer
314 * Get the #GstBufferFlags flags set on this buffer.
316 * Returns: the flags set on this buffer.
321 gst_buffer_get_flags (GstBuffer * buffer)
323 return (GstBufferFlags) GST_BUFFER_FLAGS (buffer);
327 * gst_buffer_flag_is_set:
328 * @buffer: a #GstBuffer
329 * @flags: the #GstBufferFlags flag to check.
331 * Gives the status of a specific flag on a buffer.
333 * Returns: %TRUE if all flags in @flags are found on @buffer.
338 gst_buffer_has_flags (GstBuffer * buffer, GstBufferFlags flags)
340 return GST_BUFFER_FLAG_IS_SET (buffer, flags);
344 * gst_buffer_set_flags:
345 * @buffer: a #GstBuffer
346 * @flags: the #GstBufferFlags to set.
348 * Sets one or more buffer flags on a buffer.
350 * Returns: %TRUE if @flags were successfully set on buffer.
355 gst_buffer_set_flags (GstBuffer * buffer, GstBufferFlags flags)
357 GST_BUFFER_FLAG_SET (buffer, flags);
362 * gst_buffer_unset_flags:
363 * @buffer: a #GstBuffer
364 * @flags: the #GstBufferFlags to clear
366 * Clears one or more buffer flags.
368 * Returns: true if @flags is successfully cleared from buffer.
373 gst_buffer_unset_flags (GstBuffer * buffer, GstBufferFlags flags)
375 GST_BUFFER_FLAG_UNSET (buffer, flags);
381 /* transfer full for return and transfer none for @mem */
382 static inline GstMemory *
383 _memory_get_exclusive_reference (GstMemory * mem)
385 GstMemory *ret = NULL;
387 if (gst_memory_lock (mem, GST_LOCK_FLAG_EXCLUSIVE)) {
388 ret = gst_memory_ref (mem);
390 /* we cannot take another exclusive lock as the memory is already
391 * locked WRITE + EXCLUSIVE according to part-miniobject.txt */
392 ret = gst_memory_copy (mem, 0, -1);
395 if (!gst_memory_lock (ret, GST_LOCK_FLAG_EXCLUSIVE)) {
396 gst_memory_unref (ret);
403 GST_CAT_WARNING (GST_CAT_BUFFER, "Failed to acquire an exclusive lock for "
410 _memory_add (GstBuffer * buffer, gint idx, GstMemory * mem)
412 guint i, len = GST_BUFFER_MEM_LEN (buffer);
414 GST_CAT_LOG (GST_CAT_BUFFER, "buffer %p, idx %d, mem %p", buffer, idx, mem);
416 if (G_UNLIKELY (len >= GST_BUFFER_MEM_MAX)) {
417 /* too many buffer, span them. */
418 /* FIXME, there is room for improvement here: We could only try to merge
419 * 2 buffers to make some room. If we can't efficiently merge 2 buffers we
420 * could try to only merge the two smallest buffers to avoid memcpy, etc. */
421 GST_CAT_DEBUG (GST_CAT_PERFORMANCE, "memory array overflow in buffer %p",
423 _replace_memory (buffer, len, 0, len, _get_merged_memory (buffer, 0, len));
424 /* we now have 1 single spanned buffer */
431 for (i = len; i > idx; i--) {
432 /* move buffers to insert, FIXME, we need to insert first and then merge */
433 GST_BUFFER_MEM_PTR (buffer, i) = GST_BUFFER_MEM_PTR (buffer, i - 1);
435 /* and insert the new buffer */
436 GST_BUFFER_MEM_PTR (buffer, idx) = mem;
437 GST_BUFFER_MEM_LEN (buffer) = len + 1;
439 GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY);
442 GST_DEFINE_MINI_OBJECT_TYPE (GstBuffer, gst_buffer);
445 _priv_gst_buffer_initialize (void)
447 _gst_buffer_type = gst_buffer_get_type ();
451 * gst_buffer_get_max_memory:
453 * Get the maximum amount of memory blocks that a buffer can hold. This is a
454 * compile time constant that can be queried with the function.
456 * When more memory blocks are added, existing memory blocks will be merged
457 * together to make room for the new block.
459 * Returns: the maximum amount of memory blocks that a buffer can hold.
464 gst_buffer_get_max_memory (void)
466 return GST_BUFFER_MEM_MAX;
470 * gst_buffer_copy_into:
471 * @dest: a destination #GstBuffer
472 * @src: a source #GstBuffer
473 * @flags: flags indicating what metadata fields should be copied.
474 * @offset: offset to copy from
475 * @size: total size to copy. If -1, all data is copied.
477 * Copies the information from @src into @dest.
479 * If @dest already contains memory and @flags contains GST_BUFFER_COPY_MEMORY,
480 * the memory from @src will be appended to @dest.
482 * @flags indicate which fields will be copied.
484 * Returns: %TRUE if the copying succeeded, %FALSE otherwise.
487 gst_buffer_copy_into (GstBuffer * dest, GstBuffer * src,
488 GstBufferCopyFlags flags, gsize offset, gsize size)
492 gboolean region = FALSE;
494 g_return_val_if_fail (dest != NULL, FALSE);
495 g_return_val_if_fail (src != NULL, FALSE);
497 /* nothing to copy if the buffers are the same */
498 if (G_UNLIKELY (dest == src))
501 g_return_val_if_fail (gst_buffer_is_writable (dest), FALSE);
503 bufsize = gst_buffer_get_size (src);
504 g_return_val_if_fail (bufsize >= offset, FALSE);
508 size = bufsize - offset;
511 g_return_val_if_fail (bufsize >= offset + size, FALSE);
513 GST_CAT_LOG (GST_CAT_BUFFER, "copy %p to %p, offset %" G_GSIZE_FORMAT
514 "-%" G_GSIZE_FORMAT "/%" G_GSIZE_FORMAT, src, dest, offset, size,
517 if (flags & GST_BUFFER_COPY_FLAGS) {
519 guint flags_mask = ~GST_BUFFER_FLAG_TAG_MEMORY;
521 GST_MINI_OBJECT_FLAGS (dest) =
522 (GST_MINI_OBJECT_FLAGS (src) & flags_mask) |
523 (GST_MINI_OBJECT_FLAGS (dest) & ~flags_mask);
526 if (flags & GST_BUFFER_COPY_TIMESTAMPS) {
528 GST_BUFFER_PTS (dest) = GST_BUFFER_PTS (src);
529 GST_BUFFER_DTS (dest) = GST_BUFFER_DTS (src);
530 GST_BUFFER_OFFSET (dest) = GST_BUFFER_OFFSET (src);
531 if (size == bufsize) {
532 GST_BUFFER_DURATION (dest) = GST_BUFFER_DURATION (src);
533 GST_BUFFER_OFFSET_END (dest) = GST_BUFFER_OFFSET_END (src);
536 GST_BUFFER_PTS (dest) = GST_CLOCK_TIME_NONE;
537 GST_BUFFER_DTS (dest) = GST_CLOCK_TIME_NONE;
538 GST_BUFFER_DURATION (dest) = GST_CLOCK_TIME_NONE;
539 GST_BUFFER_OFFSET (dest) = GST_BUFFER_OFFSET_NONE;
540 GST_BUFFER_OFFSET_END (dest) = GST_BUFFER_OFFSET_NONE;
544 if (flags & GST_BUFFER_COPY_MEMORY) {
545 gsize skip, left, len, dest_len, i, bsize;
548 deep = flags & GST_BUFFER_COPY_DEEP;
550 len = GST_BUFFER_MEM_LEN (src);
551 dest_len = GST_BUFFER_MEM_LEN (dest);
555 /* copy and make regions of the memory */
556 for (i = 0; i < len && left > 0; i++) {
557 GstMemory *mem = GST_BUFFER_MEM_PTR (src, i);
559 bsize = gst_memory_get_sizes (mem, NULL, NULL);
562 /* don't copy buffer */
565 GstMemory *newmem = NULL;
568 tocopy = MIN (bsize - skip, left);
570 if (tocopy < bsize && !deep && !GST_MEMORY_IS_NO_SHARE (mem)) {
571 /* we need to clip something */
572 newmem = gst_memory_share (mem, skip, tocopy);
574 gst_memory_lock (newmem, GST_LOCK_FLAG_EXCLUSIVE);
579 if (deep || GST_MEMORY_IS_NO_SHARE (mem) || (!newmem && tocopy < bsize)) {
580 /* deep copy or we're not allowed to share this memory
581 * between buffers, always copy then */
582 newmem = gst_memory_copy (mem, skip, tocopy);
584 gst_memory_lock (newmem, GST_LOCK_FLAG_EXCLUSIVE);
587 } else if (!newmem) {
588 newmem = _memory_get_exclusive_reference (mem);
592 gst_buffer_remove_memory_range (dest, dest_len, -1);
596 _memory_add (dest, -1, newmem);
600 if (flags & GST_BUFFER_COPY_MERGE) {
603 len = GST_BUFFER_MEM_LEN (dest);
604 mem = _get_merged_memory (dest, 0, len);
606 gst_buffer_remove_memory_range (dest, dest_len, -1);
609 _replace_memory (dest, len, 0, len, mem);
613 if (flags & GST_BUFFER_COPY_META) {
614 /* NOTE: GstGLSyncMeta copying relies on the meta
615 * being copied now, after the buffer data,
616 * so this has to happen last */
617 for (walk = GST_BUFFER_META (src); walk; walk = walk->next) {
618 GstMeta *meta = &walk->meta;
619 const GstMetaInfo *info = meta->info;
621 /* Don't copy memory metas if we only copied part of the buffer, didn't
622 * copy memories or merged memories. In all these cases the memory
623 * structure has changed and the memory meta becomes meaningless.
625 if ((region || !(flags & GST_BUFFER_COPY_MEMORY)
626 || (flags & GST_BUFFER_COPY_MERGE))
627 && gst_meta_api_type_has_tag (info->api, _gst_meta_tag_memory)) {
628 GST_CAT_DEBUG (GST_CAT_BUFFER,
629 "don't copy memory meta %p of API type %s", meta,
630 g_type_name (info->api));
631 } else if (info->transform_func) {
632 GstMetaTransformCopy copy_data;
634 copy_data.region = region;
635 copy_data.offset = offset;
636 copy_data.size = size;
638 if (!info->transform_func (dest, meta, src,
639 _gst_meta_transform_copy, ©_data)) {
640 GST_CAT_ERROR (GST_CAT_BUFFER,
641 "failed to copy meta %p of API type %s", meta,
642 g_type_name (info->api));
652 gst_buffer_copy_with_flags (const GstBuffer * buffer, GstBufferCopyFlags flags)
656 g_return_val_if_fail (buffer != NULL, NULL);
658 /* create a fresh new buffer */
659 copy = gst_buffer_new ();
661 /* copy what the 'flags' want from our parent */
662 /* FIXME why we can't pass const to gst_buffer_copy_into() ? */
663 if (!gst_buffer_copy_into (copy, (GstBuffer *) buffer, flags, 0, -1))
664 gst_buffer_replace (©, NULL);
667 GST_BUFFER_FLAG_UNSET (copy, GST_BUFFER_FLAG_TAG_MEMORY);
673 _gst_buffer_copy (const GstBuffer * buffer)
675 return gst_buffer_copy_with_flags (buffer, GST_BUFFER_COPY_ALL);
679 * gst_buffer_copy_deep:
680 * @buf: a #GstBuffer.
682 * Create a copy of the given buffer. This will make a newly allocated
683 * copy of the data the source buffer contains.
685 * Returns: (transfer full): a new copy of @buf.
690 gst_buffer_copy_deep (const GstBuffer * buffer)
692 return gst_buffer_copy_with_flags (buffer,
693 GST_BUFFER_COPY_ALL | GST_BUFFER_COPY_DEEP);
696 /* the default dispose function revives the buffer and returns it to the
697 * pool when there is a pool */
699 _gst_buffer_dispose (GstBuffer * buffer)
703 /* no pool, do free */
704 if ((pool = buffer->pool) == NULL)
707 /* keep the buffer alive */
708 gst_buffer_ref (buffer);
709 /* return the buffer to the pool */
710 GST_CAT_LOG (GST_CAT_BUFFER, "release %p to pool %p", buffer, pool);
711 gst_buffer_pool_release_buffer (pool, buffer);
717 _gst_buffer_free (GstBuffer * buffer)
719 GstMetaItem *walk, *next;
723 g_return_if_fail (buffer != NULL);
725 GST_CAT_LOG (GST_CAT_BUFFER, "finalize %p", buffer);
728 for (walk = GST_BUFFER_META (buffer); walk; walk = next) {
729 GstMeta *meta = &walk->meta;
730 const GstMetaInfo *info = meta->info;
732 /* call free_func if any */
734 info->free_func (meta, buffer);
737 /* and free the slice */
738 g_slice_free1 (ITEM_SIZE (info), walk);
741 /* get the size, when unreffing the memory, we could also unref the buffer
743 msize = GST_BUFFER_SLICE_SIZE (buffer);
745 /* free our memory */
746 len = GST_BUFFER_MEM_LEN (buffer);
747 for (i = 0; i < len; i++) {
748 gst_memory_unlock (GST_BUFFER_MEM_PTR (buffer, i), GST_LOCK_FLAG_EXCLUSIVE);
749 gst_memory_unref (GST_BUFFER_MEM_PTR (buffer, i));
752 /* we set msize to 0 when the buffer is part of the memory block */
755 memset (buffer, 0xff, msize);
757 g_slice_free1 (msize, buffer);
759 gst_memory_unref (GST_BUFFER_BUFMEM (buffer));
764 gst_buffer_init (GstBufferImpl * buffer, gsize size)
766 gst_mini_object_init (GST_MINI_OBJECT_CAST (buffer), 0, _gst_buffer_type,
767 (GstMiniObjectCopyFunction) _gst_buffer_copy,
768 (GstMiniObjectDisposeFunction) _gst_buffer_dispose,
769 (GstMiniObjectFreeFunction) _gst_buffer_free);
771 GST_BUFFER_SLICE_SIZE (buffer) = size;
773 GST_BUFFER (buffer)->pool = NULL;
774 GST_BUFFER_PTS (buffer) = GST_CLOCK_TIME_NONE;
775 GST_BUFFER_DTS (buffer) = GST_CLOCK_TIME_NONE;
776 GST_BUFFER_DURATION (buffer) = GST_CLOCK_TIME_NONE;
777 GST_BUFFER_OFFSET (buffer) = GST_BUFFER_OFFSET_NONE;
778 GST_BUFFER_OFFSET_END (buffer) = GST_BUFFER_OFFSET_NONE;
780 GST_BUFFER_MEM_LEN (buffer) = 0;
781 GST_BUFFER_META (buffer) = NULL;
787 * Creates a newly allocated buffer without any data.
791 * Returns: (transfer full): the new #GstBuffer.
794 gst_buffer_new (void)
796 GstBufferImpl *newbuf;
798 newbuf = g_slice_new (GstBufferImpl);
799 GST_CAT_LOG (GST_CAT_BUFFER, "new %p", newbuf);
801 gst_buffer_init (newbuf, sizeof (GstBufferImpl));
803 return GST_BUFFER_CAST (newbuf);
807 * gst_buffer_new_allocate:
808 * @allocator: (transfer none) (allow-none): the #GstAllocator to use, or %NULL to use the
810 * @size: the size in bytes of the new buffer's data.
811 * @params: (transfer none) (allow-none): optional parameters
813 * Tries to create a newly allocated buffer with data of the given size and
814 * extra parameters from @allocator. If the requested amount of memory can't be
815 * allocated, %NULL will be returned. The allocated buffer memory is not cleared.
817 * When @allocator is %NULL, the default memory allocator will be used.
819 * Note that when @size == 0, the buffer will not have memory associated with it.
823 * Returns: (transfer full) (nullable): a new #GstBuffer, or %NULL if
824 * the memory couldn't be allocated.
827 gst_buffer_new_allocate (GstAllocator * allocator, gsize size,
828 GstAllocationParams * params)
839 mem = gst_allocator_alloc (allocator, size, params);
840 if (G_UNLIKELY (mem == NULL))
846 newbuf = gst_buffer_new ();
849 gst_memory_lock (mem, GST_LOCK_FLAG_EXCLUSIVE);
850 _memory_add (newbuf, -1, mem);
853 GST_CAT_LOG (GST_CAT_BUFFER,
854 "new buffer %p of size %" G_GSIZE_FORMAT " from allocator %p", newbuf,
859 asize = sizeof (GstBufferImpl) + size;
860 data = g_slice_alloc (asize);
861 if (G_UNLIKELY (data == NULL))
864 newbuf = GST_BUFFER_CAST (data);
866 gst_buffer_init ((GstBufferImpl *) data, asize);
868 mem = gst_memory_new_wrapped (0, data + sizeof (GstBufferImpl), NULL,
870 _memory_add (newbuf, -1, mem, TRUE);
875 /* allocate memory and buffer, it might be interesting to do this but there
876 * are many complications. We need to keep the memory mapped to access the
877 * buffer fields and the memory for the buffer might be just very slow. We
878 * also need to do some more magic to get the alignment right. */
879 asize = sizeof (GstBufferImpl) + size;
880 mem = gst_allocator_alloc (allocator, asize, align);
881 if (G_UNLIKELY (mem == NULL))
884 /* map the data part and init the buffer in it, set the buffer size to 0 so
885 * that a finalize won't free the buffer */
886 data = gst_memory_map (mem, &asize, NULL, GST_MAP_WRITE);
887 gst_buffer_init ((GstBufferImpl *) data, 0);
888 gst_memory_unmap (mem);
890 /* strip off the buffer */
891 gst_memory_resize (mem, sizeof (GstBufferImpl), size);
893 newbuf = GST_BUFFER_CAST (data);
894 GST_BUFFER_BUFMEM (newbuf) = mem;
897 _memory_add (newbuf, -1, gst_memory_ref (mem), TRUE);
899 GST_BUFFER_FLAG_UNSET (newbuf, GST_BUFFER_FLAG_TAG_MEMORY);
906 GST_CAT_WARNING (GST_CAT_BUFFER,
907 "failed to allocate %" G_GSIZE_FORMAT " bytes", size);
913 * gst_buffer_new_wrapped_full:
914 * @flags: #GstMemoryFlags
915 * @data: (array length=size) (element-type guint8) (transfer none): data to wrap
916 * @maxsize: allocated size of @data
917 * @offset: offset in @data
918 * @size: size of valid data
919 * @user_data: (allow-none): user_data
920 * @notify: (allow-none) (scope async) (closure user_data): called with @user_data when the memory is freed
922 * Allocate a new buffer that wraps the given memory. @data must point to
923 * @maxsize of memory, the wrapped buffer will have the region from @offset and
926 * When the buffer is destroyed, @notify will be called with @user_data.
928 * The prefix/padding must be filled with 0 if @flags contains
929 * #GST_MEMORY_FLAG_ZERO_PREFIXED and #GST_MEMORY_FLAG_ZERO_PADDED respectively.
931 * Returns: (transfer full): a new #GstBuffer
934 gst_buffer_new_wrapped_full (GstMemoryFlags flags, gpointer data,
935 gsize maxsize, gsize offset, gsize size, gpointer user_data,
936 GDestroyNotify notify)
941 newbuf = gst_buffer_new ();
943 gst_memory_new_wrapped (flags, data, maxsize, offset, size, user_data,
945 gst_memory_lock (mem, GST_LOCK_FLAG_EXCLUSIVE);
946 _memory_add (newbuf, -1, mem);
947 GST_BUFFER_FLAG_UNSET (newbuf, GST_BUFFER_FLAG_TAG_MEMORY);
953 * gst_buffer_new_wrapped:
954 * @data: (array length=size) (element-type guint8) (transfer full): data to wrap
955 * @size: allocated size of @data
957 * Creates a new buffer that wraps the given @data. The memory will be freed
958 * with g_free and will be marked writable.
962 * Returns: (transfer full): a new #GstBuffer
965 gst_buffer_new_wrapped (gpointer data, gsize size)
967 return gst_buffer_new_wrapped_full (0, data, size, 0, size, data, g_free);
971 * gst_buffer_n_memory:
972 * @buffer: a #GstBuffer.
974 * Get the amount of memory blocks that this buffer has. This amount is never
975 * larger than what gst_buffer_get_max_memory() returns.
977 * Returns: the number of memory blocks this buffer is made of.
980 gst_buffer_n_memory (GstBuffer * buffer)
982 g_return_val_if_fail (GST_IS_BUFFER (buffer), 0);
984 return GST_BUFFER_MEM_LEN (buffer);
988 * gst_buffer_prepend_memory:
989 * @buffer: a #GstBuffer.
990 * @mem: (transfer full): a #GstMemory.
992 * Prepend the memory block @mem to @buffer. This function takes
993 * ownership of @mem and thus doesn't increase its refcount.
995 * This function is identical to gst_buffer_insert_memory() with an index of 0.
996 * See gst_buffer_insert_memory() for more details.
999 gst_buffer_prepend_memory (GstBuffer * buffer, GstMemory * mem)
1001 gst_buffer_insert_memory (buffer, 0, mem);
1005 * gst_buffer_append_memory:
1006 * @buffer: a #GstBuffer.
1007 * @mem: (transfer full): a #GstMemory.
1009 * Append the memory block @mem to @buffer. This function takes
1010 * ownership of @mem and thus doesn't increase its refcount.
1012 * This function is identical to gst_buffer_insert_memory() with an index of -1.
1013 * See gst_buffer_insert_memory() for more details.
1016 gst_buffer_append_memory (GstBuffer * buffer, GstMemory * mem)
1018 gst_buffer_insert_memory (buffer, -1, mem);
1022 * gst_buffer_insert_memory:
1023 * @buffer: a #GstBuffer.
1024 * @idx: the index to add the memory at, or -1 to append it to the end
1025 * @mem: (transfer full): a #GstMemory.
1027 * Insert the memory block @mem to @buffer at @idx. This function takes ownership
1028 * of @mem and thus doesn't increase its refcount.
1030 * Only gst_buffer_get_max_memory() can be added to a buffer. If more memory is
1031 * added, existing memory blocks will automatically be merged to make room for
1035 gst_buffer_insert_memory (GstBuffer * buffer, gint idx, GstMemory * mem)
1039 g_return_if_fail (GST_IS_BUFFER (buffer));
1040 g_return_if_fail (gst_buffer_is_writable (buffer));
1041 g_return_if_fail (mem != NULL);
1042 g_return_if_fail (idx == -1 ||
1043 (idx >= 0 && idx <= GST_BUFFER_MEM_LEN (buffer)));
1045 tmp = _memory_get_exclusive_reference (mem);
1046 g_return_if_fail (tmp != NULL);
1047 gst_memory_unref (mem);
1048 _memory_add (buffer, idx, tmp);
1052 _get_mapped (GstBuffer * buffer, guint idx, GstMapInfo * info,
1055 GstMemory *mem, *mapped;
1057 mem = gst_memory_ref (GST_BUFFER_MEM_PTR (buffer, idx));
1059 mapped = gst_memory_make_mapped (mem, info, flags);
1061 if (mapped != mem) {
1062 /* memory changed, lock new memory */
1063 gst_memory_lock (mapped, GST_LOCK_FLAG_EXCLUSIVE);
1064 GST_BUFFER_MEM_PTR (buffer, idx) = mapped;
1065 /* unlock old memory */
1066 gst_memory_unlock (mem, GST_LOCK_FLAG_EXCLUSIVE);
1067 GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY);
1069 gst_memory_unref (mem);
1075 * gst_buffer_peek_memory:
1076 * @buffer: a #GstBuffer.
1079 * Get the memory block at @idx in @buffer. The memory block stays valid until
1080 * the memory block in @buffer is removed, replaced or merged, typically with
1081 * any call that modifies the memory in @buffer.
1083 * Returns: (transfer none) (nullable): the #GstMemory at @idx.
1086 gst_buffer_peek_memory (GstBuffer * buffer, guint idx)
1090 g_return_val_if_fail (GST_IS_BUFFER (buffer), NULL);
1091 len = GST_BUFFER_MEM_LEN (buffer);
1092 g_return_val_if_fail (idx < len, NULL);
1094 return GST_BUFFER_MEM_PTR (buffer, idx);
1098 * gst_buffer_get_memory:
1099 * @buffer: a #GstBuffer.
1102 * Get the memory block at index @idx in @buffer.
1104 * Returns: (transfer full) (nullable): a #GstMemory that contains the data of the
1105 * memory block at @idx. Use gst_memory_unref () after usage.
1108 gst_buffer_get_memory (GstBuffer * buffer, guint idx)
1110 return gst_buffer_get_memory_range (buffer, idx, 1);
1114 * gst_buffer_get_all_memory:
1115 * @buffer: a #GstBuffer.
1117 * Get all the memory block in @buffer. The memory blocks will be merged
1118 * into one large #GstMemory.
1120 * Returns: (transfer full) (nullable): a #GstMemory that contains the merged memory.
1121 * Use gst_memory_unref () after usage.
1124 gst_buffer_get_all_memory (GstBuffer * buffer)
1126 return gst_buffer_get_memory_range (buffer, 0, -1);
1130 * gst_buffer_get_memory_range:
1131 * @buffer: a #GstBuffer.
1135 * Get @length memory blocks in @buffer starting at @idx. The memory blocks will
1136 * be merged into one large #GstMemory.
1138 * If @length is -1, all memory starting from @idx is merged.
1140 * Returns: (transfer full) (nullable): a #GstMemory that contains the merged data of @length
1141 * blocks starting at @idx. Use gst_memory_unref () after usage.
1144 gst_buffer_get_memory_range (GstBuffer * buffer, guint idx, gint length)
1148 GST_CAT_DEBUG (GST_CAT_BUFFER, "idx %u, length %d", idx, length);
1150 g_return_val_if_fail (GST_IS_BUFFER (buffer), NULL);
1151 len = GST_BUFFER_MEM_LEN (buffer);
1152 g_return_val_if_fail ((len == 0 && idx == 0 && length == -1) ||
1153 (length == -1 && idx < len) || (length > 0 && length + idx <= len), NULL);
1158 return _get_merged_memory (buffer, idx, length);
1162 * gst_buffer_replace_memory:
1163 * @buffer: a #GstBuffer.
1165 * @mem: (transfer full): a #GstMemory
1167 * Replaces the memory block at index @idx in @buffer with @mem.
1170 gst_buffer_replace_memory (GstBuffer * buffer, guint idx, GstMemory * mem)
1172 gst_buffer_replace_memory_range (buffer, idx, 1, mem);
1176 * gst_buffer_replace_all_memory:
1177 * @buffer: a #GstBuffer.
1178 * @mem: (transfer full): a #GstMemory
1180 * Replaces all memory in @buffer with @mem.
1183 gst_buffer_replace_all_memory (GstBuffer * buffer, GstMemory * mem)
1185 gst_buffer_replace_memory_range (buffer, 0, -1, mem);
1189 * gst_buffer_replace_memory_range:
1190 * @buffer: a #GstBuffer.
1192 * @length: a length should not be 0
1193 * @mem: (transfer full): a #GstMemory
1195 * Replaces @length memory blocks in @buffer starting at @idx with @mem.
1197 * If @length is -1, all memory starting from @idx will be removed and
1198 * replaced with @mem.
1200 * @buffer should be writable.
1203 gst_buffer_replace_memory_range (GstBuffer * buffer, guint idx, gint length,
1208 g_return_if_fail (GST_IS_BUFFER (buffer));
1209 g_return_if_fail (gst_buffer_is_writable (buffer));
1211 GST_CAT_DEBUG (GST_CAT_BUFFER, "idx %u, length %d, %p", idx, length, mem);
1213 len = GST_BUFFER_MEM_LEN (buffer);
1214 g_return_if_fail ((len == 0 && idx == 0 && length == -1) ||
1215 (length == -1 && idx < len) || (length > 0 && length + idx <= len));
1220 _replace_memory (buffer, len, idx, length, mem);
1224 * gst_buffer_remove_memory:
1225 * @buffer: a #GstBuffer.
1228 * Remove the memory block in @b at index @i.
1231 gst_buffer_remove_memory (GstBuffer * buffer, guint idx)
1233 gst_buffer_remove_memory_range (buffer, idx, 1);
1237 * gst_buffer_remove_all_memory:
1238 * @buffer: a #GstBuffer.
1240 * Remove all the memory blocks in @buffer.
1243 gst_buffer_remove_all_memory (GstBuffer * buffer)
1245 gst_buffer_remove_memory_range (buffer, 0, -1);
1249 * gst_buffer_remove_memory_range:
1250 * @buffer: a #GstBuffer.
1254 * Remove @length memory blocks in @buffer starting from @idx.
1256 * @length can be -1, in which case all memory starting from @idx is removed.
1259 gst_buffer_remove_memory_range (GstBuffer * buffer, guint idx, gint length)
1263 g_return_if_fail (GST_IS_BUFFER (buffer));
1264 g_return_if_fail (gst_buffer_is_writable (buffer));
1266 GST_CAT_DEBUG (GST_CAT_BUFFER, "idx %u, length %d", idx, length);
1268 len = GST_BUFFER_MEM_LEN (buffer);
1269 g_return_if_fail ((len == 0 && idx == 0 && length == -1) ||
1270 (length == -1 && idx < len) || length + idx <= len);
1275 _replace_memory (buffer, len, idx, length, NULL);
1279 * gst_buffer_find_memory:
1280 * @buffer: a #GstBuffer.
1281 * @offset: an offset
1283 * @idx: (out): pointer to index
1284 * @length: (out): pointer to length
1285 * @skip: (out): pointer to skip
1287 * Find the memory blocks that span @size bytes starting from @offset
1290 * When this function returns %TRUE, @idx will contain the index of the first
1291 * memory block where the byte for @offset can be found and @length contains the
1292 * number of memory blocks containing the @size remaining bytes. @skip contains
1293 * the number of bytes to skip in the memory block at @idx to get to the byte
1296 * @size can be -1 to get all the memory blocks after @idx.
1298 * Returns: %TRUE when @size bytes starting from @offset could be found in
1299 * @buffer and @idx, @length and @skip will be filled.
1302 gst_buffer_find_memory (GstBuffer * buffer, gsize offset, gsize size,
1303 guint * idx, guint * length, gsize * skip)
1305 guint i, len, found;
1307 g_return_val_if_fail (GST_IS_BUFFER (buffer), FALSE);
1308 g_return_val_if_fail (idx != NULL, FALSE);
1309 g_return_val_if_fail (length != NULL, FALSE);
1310 g_return_val_if_fail (skip != NULL, FALSE);
1312 len = GST_BUFFER_MEM_LEN (buffer);
1315 for (i = 0; i < len; i++) {
1319 mem = GST_BUFFER_MEM_PTR (buffer, i);
1320 s = gst_memory_get_sizes (mem, NULL, NULL);
1323 /* block before offset, or empty block, skip */
1326 /* block after offset */
1328 /* first block, remember index and offset */
1332 /* return remaining blocks */
1339 /* count the amount of found bytes */
1341 if (found >= size) {
1342 /* we have enough bytes */
1343 *length = i - *idx + 1;
1352 * gst_buffer_is_memory_range_writable:
1353 * @buffer: a #GstBuffer.
1355 * @length: a length should not be 0
1357 * Check if @length memory blocks in @buffer starting from @idx are writable.
1359 * @length can be -1 to check all the memory blocks after @idx.
1361 * Note that this function does not check if @buffer is writable, use
1362 * gst_buffer_is_writable() to check that if needed.
1364 * Returns: %TRUE if the memory range is writable
1369 gst_buffer_is_memory_range_writable (GstBuffer * buffer, guint idx, gint length)
1373 g_return_val_if_fail (GST_IS_BUFFER (buffer), FALSE);
1375 GST_CAT_DEBUG (GST_CAT_BUFFER, "idx %u, length %d", idx, length);
1377 len = GST_BUFFER_MEM_LEN (buffer);
1378 g_return_val_if_fail ((len == 0 && idx == 0 && length == -1) ||
1379 (length == -1 && idx < len) || (length > 0 && length + idx <= len),
1387 for (i = 0; i < len; i++) {
1388 if (!gst_memory_is_writable (GST_BUFFER_MEM_PTR (buffer, i + idx)))
1395 * gst_buffer_is_all_memory_writable:
1396 * @buffer: a #GstBuffer.
1398 * Check if all memory blocks in @buffer are writable.
1400 * Note that this function does not check if @buffer is writable, use
1401 * gst_buffer_is_writable() to check that if needed.
1403 * Returns: %TRUE if all memory blocks in @buffer are writable
1408 gst_buffer_is_all_memory_writable (GstBuffer * buffer)
1410 return gst_buffer_is_memory_range_writable (buffer, 0, -1);
1414 * gst_buffer_get_sizes:
1415 * @buffer: a #GstBuffer.
1416 * @offset: (out) (allow-none): a pointer to the offset
1417 * @maxsize: (out) (allow-none): a pointer to the maxsize
1419 * Get the total size of the memory blocks in @b.
1421 * When not %NULL, @offset will contain the offset of the data in the
1422 * first memory block in @buffer and @maxsize will contain the sum of
1423 * the size and @offset and the amount of extra padding on the last
1424 * memory block. @offset and @maxsize can be used to resize the
1425 * buffer memory blocks with gst_buffer_resize().
1427 * Returns: total size of the memory blocks in @buffer.
1430 gst_buffer_get_sizes (GstBuffer * buffer, gsize * offset, gsize * maxsize)
1432 return gst_buffer_get_sizes_range (buffer, 0, -1, offset, maxsize);
1436 * gst_buffer_get_size:
1437 * @buffer: a #GstBuffer.
1439 * Get the total size of the memory blocks in @buffer.
1441 * Returns: total size of the memory blocks in @buffer.
1444 gst_buffer_get_size (GstBuffer * buffer)
1446 return gst_buffer_get_sizes_range (buffer, 0, -1, NULL, NULL);
1450 * gst_buffer_get_sizes_range:
1451 * @buffer: a #GstBuffer.
1454 * @offset: (out) (allow-none): a pointer to the offset
1455 * @maxsize: (out) (allow-none): a pointer to the maxsize
1457 * Get the total size of @length memory blocks stating from @idx in @buffer.
1459 * When not %NULL, @offset will contain the offset of the data in the
1460 * memory block in @buffer at @idx and @maxsize will contain the sum of the size
1461 * and @offset and the amount of extra padding on the memory block at @idx +
1463 * @offset and @maxsize can be used to resize the buffer memory blocks with
1464 * gst_buffer_resize_range().
1466 * Returns: total size of @length memory blocks starting at @idx in @buffer.
1469 gst_buffer_get_sizes_range (GstBuffer * buffer, guint idx, gint length,
1470 gsize * offset, gsize * maxsize)
1476 g_return_val_if_fail (GST_IS_BUFFER (buffer), 0);
1477 len = GST_BUFFER_MEM_LEN (buffer);
1478 g_return_val_if_fail ((len == 0 && idx == 0 && length == -1) ||
1479 (length == -1 && idx < len) || (length + idx <= len), 0);
1484 if (G_LIKELY (length == 1)) {
1486 mem = GST_BUFFER_MEM_PTR (buffer, idx);
1487 size = gst_memory_get_sizes (mem, offset, maxsize);
1493 size = offs = extra = 0;
1494 for (i = idx; i < end; i++) {
1497 mem = GST_BUFFER_MEM_PTR (buffer, i);
1498 s = gst_memory_get_sizes (mem, &o, &ms);
1502 /* first size, take accumulated data before as the offset */
1506 /* save the amount of data after this block */
1507 extra = ms - (o + s);
1509 /* empty block, add as extra */
1516 *maxsize = offs + size + extra;
1522 * gst_buffer_resize:
1523 * @buffer: a #GstBuffer.
1524 * @offset: the offset adjustment
1525 * @size: the new size or -1 to just adjust the offset
1527 * Set the offset and total size of the memory blocks in @buffer.
1530 gst_buffer_resize (GstBuffer * buffer, gssize offset, gssize size)
1532 gst_buffer_resize_range (buffer, 0, -1, offset, size);
1536 * gst_buffer_set_size:
1537 * @buffer: a #GstBuffer.
1538 * @size: the new size
1540 * Set the total size of the memory blocks in @buffer.
1543 gst_buffer_set_size (GstBuffer * buffer, gssize size)
1545 gst_buffer_resize_range (buffer, 0, -1, 0, size);
1549 * gst_buffer_resize_range:
1550 * @buffer: a #GstBuffer.
1553 * @offset: the offset adjustment
1554 * @size: the new size or -1 to just adjust the offset
1556 * Set the total size of the @length memory blocks starting at @idx in
1559 * Returns: %TRUE if resizing succeeded, %FALSE otherwise.
1562 gst_buffer_resize_range (GstBuffer * buffer, guint idx, gint length,
1563 gssize offset, gssize size)
1566 gsize bsize, bufsize, bufoffs, bufmax;
1568 g_return_val_if_fail (gst_buffer_is_writable (buffer), FALSE);
1569 g_return_val_if_fail (size >= -1, FALSE);
1571 len = GST_BUFFER_MEM_LEN (buffer);
1572 g_return_val_if_fail ((len == 0 && idx == 0 && length == -1) ||
1573 (length == -1 && idx < len) || (length + idx <= len), FALSE);
1578 bufsize = gst_buffer_get_sizes_range (buffer, idx, length, &bufoffs, &bufmax);
1580 GST_CAT_LOG (GST_CAT_BUFFER, "trim %p %" G_GSSIZE_FORMAT "-%" G_GSSIZE_FORMAT
1581 " size:%" G_GSIZE_FORMAT " offs:%" G_GSIZE_FORMAT " max:%"
1582 G_GSIZE_FORMAT, buffer, offset, size, bufsize, bufoffs, bufmax);
1584 /* we can't go back further than the current offset or past the end of the
1586 g_return_val_if_fail ((offset < 0 && bufoffs >= -offset) || (offset >= 0
1587 && bufoffs + offset <= bufmax), FALSE);
1589 g_return_val_if_fail (bufsize >= offset, FALSE);
1590 size = bufsize - offset;
1592 g_return_val_if_fail (bufmax >= bufoffs + offset + size, FALSE);
1595 if (offset == 0 && size == bufsize)
1600 for (i = idx; i < end; i++) {
1604 mem = GST_BUFFER_MEM_PTR (buffer, i);
1605 bsize = gst_memory_get_sizes (mem, NULL, NULL);
1608 /* last buffer always gets resized to the remaining size */
1611 /* shrink buffers before the offset */
1612 else if ((gssize) bsize <= offset) {
1614 noffs = offset - bsize;
1617 /* clip other buffers */
1619 left = MIN (bsize - offset, size);
1621 if (offset != 0 || left != bsize) {
1622 if (gst_memory_is_writable (mem)) {
1623 gst_memory_resize (mem, offset, left);
1625 GstMemory *newmem = NULL;
1627 if (!GST_MEMORY_IS_NO_SHARE (mem))
1628 newmem = gst_memory_share (mem, offset, left);
1631 newmem = gst_memory_copy (mem, offset, left);
1636 gst_memory_lock (newmem, GST_LOCK_FLAG_EXCLUSIVE);
1637 GST_BUFFER_MEM_PTR (buffer, i) = newmem;
1638 gst_memory_unlock (mem, GST_LOCK_FLAG_EXCLUSIVE);
1639 gst_memory_unref (mem);
1641 GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY);
1654 * @buffer: a #GstBuffer.
1655 * @info: (out): info about the mapping
1656 * @flags: flags for the mapping
1658 * This function fills @info with the #GstMapInfo of all merged memory
1659 * blocks in @buffer.
1661 * @flags describe the desired access of the memory. When @flags is
1662 * #GST_MAP_WRITE, @buffer should be writable (as returned from
1663 * gst_buffer_is_writable()).
1665 * When @buffer is writable but the memory isn't, a writable copy will
1666 * automatically be created and returned. The readonly copy of the
1667 * buffer memory will then also be replaced with this writable copy.
1669 * The memory in @info should be unmapped with gst_buffer_unmap() after
1672 * Returns: %TRUE if the map succeeded and @info contains valid data.
1675 gst_buffer_map (GstBuffer * buffer, GstMapInfo * info, GstMapFlags flags)
1677 return gst_buffer_map_range (buffer, 0, -1, info, flags);
1681 * gst_buffer_map_range:
1682 * @buffer: a #GstBuffer.
1685 * @info: (out): info about the mapping
1686 * @flags: flags for the mapping
1688 * This function fills @info with the #GstMapInfo of @length merged memory blocks
1689 * starting at @idx in @buffer. When @length is -1, all memory blocks starting
1690 * from @idx are merged and mapped.
1692 * @flags describe the desired access of the memory. When @flags is
1693 * #GST_MAP_WRITE, @buffer should be writable (as returned from
1694 * gst_buffer_is_writable()).
1696 * When @buffer is writable but the memory isn't, a writable copy will
1697 * automatically be created and returned. The readonly copy of the buffer memory
1698 * will then also be replaced with this writable copy.
1700 * The memory in @info should be unmapped with gst_buffer_unmap() after usage.
1702 * Returns: %TRUE if the map succeeded and @info contains valid
1706 gst_buffer_map_range (GstBuffer * buffer, guint idx, gint length,
1707 GstMapInfo * info, GstMapFlags flags)
1709 GstMemory *mem, *nmem;
1710 gboolean write, writable;
1713 g_return_val_if_fail (GST_IS_BUFFER (buffer), FALSE);
1714 g_return_val_if_fail (info != NULL, FALSE);
1715 len = GST_BUFFER_MEM_LEN (buffer);
1716 g_return_val_if_fail ((len == 0 && idx == 0 && length == -1) ||
1717 (length == -1 && idx < len) || (length > 0
1718 && length + idx <= len), FALSE);
1720 GST_CAT_LOG (GST_CAT_BUFFER, "buffer %p, idx %u, length %d, flags %04x",
1721 buffer, idx, length, flags);
1723 write = (flags & GST_MAP_WRITE) != 0;
1724 writable = gst_buffer_is_writable (buffer);
1726 /* check if we can write when asked for write access */
1727 if (G_UNLIKELY (write && !writable))
1733 mem = _get_merged_memory (buffer, idx, length);
1734 if (G_UNLIKELY (mem == NULL))
1737 /* now try to map */
1738 nmem = gst_memory_make_mapped (mem, info, flags);
1739 if (G_UNLIKELY (nmem == NULL))
1742 /* if we merged or when the map returned a different memory, we try to replace
1743 * the memory in the buffer */
1744 if (G_UNLIKELY (length > 1 || nmem != mem)) {
1745 /* if the buffer is writable, replace the memory */
1747 _replace_memory (buffer, len, idx, length, gst_memory_ref (nmem));
1750 GST_CAT_DEBUG (GST_CAT_PERFORMANCE,
1751 "temporary mapping for memory %p in buffer %p", nmem, buffer);
1760 GST_WARNING_OBJECT (buffer, "write map requested on non-writable buffer");
1761 g_critical ("write map requested on non-writable buffer");
1762 memset (info, 0, sizeof (GstMapInfo));
1767 /* empty buffer, we need to return NULL */
1768 GST_DEBUG_OBJECT (buffer, "can't get buffer memory");
1769 memset (info, 0, sizeof (GstMapInfo));
1774 GST_DEBUG_OBJECT (buffer, "cannot map memory");
1775 memset (info, 0, sizeof (GstMapInfo));
1782 * @buffer: a #GstBuffer.
1783 * @info: a #GstMapInfo
1785 * Release the memory previously mapped with gst_buffer_map().
1788 gst_buffer_unmap (GstBuffer * buffer, GstMapInfo * info)
1790 g_return_if_fail (GST_IS_BUFFER (buffer));
1791 g_return_if_fail (info != NULL);
1793 /* we need to check for NULL, it is possible that we tried to map a buffer
1794 * without memory and we should be able to unmap that fine */
1795 if (G_LIKELY (info->memory)) {
1796 gst_memory_unmap (info->memory, info);
1797 gst_memory_unref (info->memory);
1803 * @buffer: a #GstBuffer.
1804 * @offset: the offset to fill
1805 * @src: (array length=size) (element-type guint8): the source address
1806 * @size: the size to fill
1808 * Copy @size bytes from @src to @buffer at @offset.
1810 * Returns: The amount of bytes copied. This value can be lower than @size
1811 * when @buffer did not contain enough data.
1814 gst_buffer_fill (GstBuffer * buffer, gsize offset, gconstpointer src,
1818 const guint8 *ptr = src;
1820 g_return_val_if_fail (GST_IS_BUFFER (buffer), 0);
1821 g_return_val_if_fail (gst_buffer_is_writable (buffer), 0);
1822 g_return_val_if_fail (src != NULL || size == 0, 0);
1824 GST_CAT_LOG (GST_CAT_BUFFER,
1825 "buffer %p, offset %" G_GSIZE_FORMAT ", size %" G_GSIZE_FORMAT, buffer,
1828 len = GST_BUFFER_MEM_LEN (buffer);
1831 for (i = 0; i < len && left > 0; i++) {
1836 mem = _get_mapped (buffer, i, &info, GST_MAP_WRITE);
1837 if (info.size > offset) {
1838 /* we have enough */
1839 tocopy = MIN (info.size - offset, left);
1840 memcpy ((guint8 *) info.data + offset, ptr, tocopy);
1845 /* offset past buffer, skip */
1846 offset -= info.size;
1848 gst_memory_unmap (mem, &info);
1854 * gst_buffer_extract:
1855 * @buffer: a #GstBuffer.
1856 * @offset: the offset to extract
1857 * @dest: (out caller-allocates) (array length=size) (element-type guint8):
1858 * the destination address
1859 * @size: the size to extract
1861 * Copy @size bytes starting from @offset in @buffer to @dest.
1863 * Returns: The amount of bytes extracted. This value can be lower than @size
1864 * when @buffer did not contain enough data.
1867 gst_buffer_extract (GstBuffer * buffer, gsize offset, gpointer dest, gsize size)
1872 g_return_val_if_fail (GST_IS_BUFFER (buffer), 0);
1873 g_return_val_if_fail (dest != NULL, 0);
1875 GST_CAT_LOG (GST_CAT_BUFFER,
1876 "buffer %p, offset %" G_GSIZE_FORMAT ", size %" G_GSIZE_FORMAT, buffer,
1879 len = GST_BUFFER_MEM_LEN (buffer);
1882 for (i = 0; i < len && left > 0; i++) {
1887 mem = _get_mapped (buffer, i, &info, GST_MAP_READ);
1888 if (info.size > offset) {
1889 /* we have enough */
1890 tocopy = MIN (info.size - offset, left);
1891 memcpy (ptr, (guint8 *) info.data + offset, tocopy);
1896 /* offset past buffer, skip */
1897 offset -= info.size;
1899 gst_memory_unmap (mem, &info);
1905 * gst_buffer_memcmp:
1906 * @buffer: a #GstBuffer.
1907 * @offset: the offset in @buffer
1908 * @mem: (array length=size) (element-type guint8): the memory to compare
1909 * @size: the size to compare
1911 * Compare @size bytes starting from @offset in @buffer with the memory in @mem.
1913 * Returns: 0 if the memory is equal.
1916 gst_buffer_memcmp (GstBuffer * buffer, gsize offset, gconstpointer mem,
1920 const guint8 *ptr = mem;
1923 g_return_val_if_fail (GST_IS_BUFFER (buffer), 0);
1924 g_return_val_if_fail (mem != NULL, 0);
1926 GST_CAT_LOG (GST_CAT_BUFFER,
1927 "buffer %p, offset %" G_GSIZE_FORMAT ", size %" G_GSIZE_FORMAT, buffer,
1930 if (G_UNLIKELY (gst_buffer_get_size (buffer) < offset + size))
1933 len = GST_BUFFER_MEM_LEN (buffer);
1935 for (i = 0; i < len && size > 0 && res == 0; i++) {
1940 mem = _get_mapped (buffer, i, &info, GST_MAP_READ);
1941 if (info.size > offset) {
1942 /* we have enough */
1943 tocmp = MIN (info.size - offset, size);
1944 res = memcmp (ptr, (guint8 *) info.data + offset, tocmp);
1949 /* offset past buffer, skip */
1950 offset -= info.size;
1952 gst_memory_unmap (mem, &info);
1958 * gst_buffer_memset:
1959 * @buffer: a #GstBuffer.
1960 * @offset: the offset in @buffer
1961 * @val: the value to set
1962 * @size: the size to set
1964 * Fill @buf with @size bytes with @val starting from @offset.
1966 * Returns: The amount of bytes filled. This value can be lower than @size
1967 * when @buffer did not contain enough data.
1970 gst_buffer_memset (GstBuffer * buffer, gsize offset, guint8 val, gsize size)
1974 g_return_val_if_fail (GST_IS_BUFFER (buffer), 0);
1975 g_return_val_if_fail (gst_buffer_is_writable (buffer), 0);
1977 GST_CAT_LOG (GST_CAT_BUFFER,
1978 "buffer %p, offset %" G_GSIZE_FORMAT ", val %02x, size %" G_GSIZE_FORMAT,
1979 buffer, offset, val, size);
1981 len = GST_BUFFER_MEM_LEN (buffer);
1984 for (i = 0; i < len && left > 0; i++) {
1989 mem = _get_mapped (buffer, i, &info, GST_MAP_WRITE);
1990 if (info.size > offset) {
1991 /* we have enough */
1992 toset = MIN (info.size - offset, left);
1993 memset ((guint8 *) info.data + offset, val, toset);
1997 /* offset past buffer, skip */
1998 offset -= info.size;
2000 gst_memory_unmap (mem, &info);
2006 * gst_buffer_copy_region:
2007 * @parent: a #GstBuffer.
2008 * @flags: the #GstBufferCopyFlags
2009 * @offset: the offset into parent #GstBuffer at which the new sub-buffer
2011 * @size: the size of the new #GstBuffer sub-buffer, in bytes. If -1, all
2014 * Creates a sub-buffer from @parent at @offset and @size.
2015 * This sub-buffer uses the actual memory space of the parent buffer.
2016 * This function will copy the offset and timestamp fields when the
2017 * offset is 0. If not, they will be set to #GST_CLOCK_TIME_NONE and
2018 * #GST_BUFFER_OFFSET_NONE.
2019 * If @offset equals 0 and @size equals the total size of @buffer, the
2020 * duration and offset end fields are also copied. If not they will be set
2021 * to #GST_CLOCK_TIME_NONE and #GST_BUFFER_OFFSET_NONE.
2025 * Returns: (transfer full): the new #GstBuffer or %NULL if the arguments were
2029 gst_buffer_copy_region (GstBuffer * buffer, GstBufferCopyFlags flags,
2030 gsize offset, gsize size)
2034 g_return_val_if_fail (buffer != NULL, NULL);
2036 /* create the new buffer */
2037 copy = gst_buffer_new ();
2039 GST_CAT_LOG (GST_CAT_BUFFER, "new region copy %p of %p %" G_GSIZE_FORMAT
2040 "-%" G_GSIZE_FORMAT, copy, buffer, offset, size);
2042 if (!gst_buffer_copy_into (copy, buffer, flags, offset, size))
2043 gst_buffer_replace (©, NULL);
2049 * gst_buffer_append:
2050 * @buf1: (transfer full): the first source #GstBuffer to append.
2051 * @buf2: (transfer full): the second source #GstBuffer to append.
2053 * Append all the memory from @buf2 to @buf1. The result buffer will contain a
2054 * concatenation of the memory of @buf1 and @buf2.
2056 * Returns: (transfer full): the new #GstBuffer that contains the memory
2057 * of the two source buffers.
2060 gst_buffer_append (GstBuffer * buf1, GstBuffer * buf2)
2062 return gst_buffer_append_region (buf1, buf2, 0, -1);
2066 * gst_buffer_append_region:
2067 * @buf1: (transfer full): the first source #GstBuffer to append.
2068 * @buf2: (transfer full): the second source #GstBuffer to append.
2069 * @offset: the offset in @buf2
2070 * @size: the size or -1 of @buf2
2072 * Append @size bytes at @offset from @buf2 to @buf1. The result buffer will
2073 * contain a concatenation of the memory of @buf1 and the requested region of
2076 * Returns: (transfer full): the new #GstBuffer that contains the memory
2077 * of the two source buffers.
2080 gst_buffer_append_region (GstBuffer * buf1, GstBuffer * buf2, gssize offset,
2085 g_return_val_if_fail (GST_IS_BUFFER (buf1), NULL);
2086 g_return_val_if_fail (GST_IS_BUFFER (buf2), NULL);
2088 buf1 = gst_buffer_make_writable (buf1);
2089 buf2 = gst_buffer_make_writable (buf2);
2091 gst_buffer_resize (buf2, offset, size);
2093 len = GST_BUFFER_MEM_LEN (buf2);
2094 for (i = 0; i < len; i++) {
2097 mem = GST_BUFFER_MEM_PTR (buf2, i);
2098 GST_BUFFER_MEM_PTR (buf2, i) = NULL;
2099 _memory_add (buf1, -1, mem);
2102 GST_BUFFER_MEM_LEN (buf2) = 0;
2103 GST_BUFFER_FLAG_SET (buf2, GST_BUFFER_FLAG_TAG_MEMORY);
2104 gst_buffer_unref (buf2);
2110 * gst_buffer_get_meta:
2111 * @buffer: a #GstBuffer
2112 * @api: the #GType of an API
2114 * Get the metadata for @api on buffer. When there is no such metadata, %NULL is
2115 * returned. If multiple metadata with the given @api are attached to this
2116 * buffer only the first one is returned. To handle multiple metadata with a
2117 * given API use gst_buffer_iterate_meta() or gst_buffer_foreach_meta() instead
2118 * and check the meta->info.api member for the API type.
2120 * Returns: (transfer none) (nullable): the metadata for @api on
2124 gst_buffer_get_meta (GstBuffer * buffer, GType api)
2127 GstMeta *result = NULL;
2129 g_return_val_if_fail (buffer != NULL, NULL);
2130 g_return_val_if_fail (api != 0, NULL);
2132 /* find GstMeta of the requested API */
2133 for (item = GST_BUFFER_META (buffer); item; item = item->next) {
2134 GstMeta *meta = &item->meta;
2135 if (meta->info->api == api) {
2144 * gst_buffer_get_n_meta:
2145 * @buffer: a #GstBuffer
2146 * @api_type: the #GType of an API
2148 * Returns: number of metas of type @api_type on @buffer.
2153 gst_buffer_get_n_meta (GstBuffer * buffer, GType api_type)
2155 gpointer state = NULL;
2159 while ((meta = gst_buffer_iterate_meta_filtered (buffer, &state, api_type)))
2166 * gst_buffer_add_meta:
2167 * @buffer: a #GstBuffer
2168 * @info: a #GstMetaInfo
2169 * @params: params for @info
2171 * Add metadata for @info to @buffer using the parameters in @params.
2173 * Returns: (transfer none) (nullable): the metadata for the api in @info on @buffer.
2176 gst_buffer_add_meta (GstBuffer * buffer, const GstMetaInfo * info,
2180 GstMeta *result = NULL;
2183 g_return_val_if_fail (buffer != NULL, NULL);
2184 g_return_val_if_fail (info != NULL, NULL);
2185 g_return_val_if_fail (gst_buffer_is_writable (buffer), NULL);
2187 /* create a new slice */
2188 size = ITEM_SIZE (info);
2189 /* We warn in gst_meta_register() about metas without
2190 * init function but let's play safe here and prevent
2191 * uninitialized memory
2193 if (!info->init_func)
2194 item = g_slice_alloc0 (size);
2196 item = g_slice_alloc (size);
2197 result = &item->meta;
2198 result->info = info;
2199 result->flags = GST_META_FLAG_NONE;
2200 GST_CAT_DEBUG (GST_CAT_BUFFER,
2201 "alloc metadata %p (%s) of size %" G_GSIZE_FORMAT, result,
2202 g_type_name (info->type), info->size);
2204 /* call the init_func when needed */
2205 if (info->init_func)
2206 if (!info->init_func (result, params, buffer))
2209 /* and add to the list of metadata */
2210 item->next = GST_BUFFER_META (buffer);
2211 GST_BUFFER_META (buffer) = item;
2217 g_slice_free1 (size, item);
2223 * gst_buffer_remove_meta:
2224 * @buffer: a #GstBuffer
2227 * Remove the metadata for @meta on @buffer.
2229 * Returns: %TRUE if the metadata existed and was removed, %FALSE if no such
2230 * metadata was on @buffer.
2233 gst_buffer_remove_meta (GstBuffer * buffer, GstMeta * meta)
2235 GstMetaItem *walk, *prev;
2237 g_return_val_if_fail (buffer != NULL, FALSE);
2238 g_return_val_if_fail (meta != NULL, FALSE);
2239 g_return_val_if_fail (gst_buffer_is_writable (buffer), FALSE);
2240 g_return_val_if_fail (!GST_META_FLAG_IS_SET (meta, GST_META_FLAG_LOCKED),
2243 /* find the metadata and delete */
2244 prev = GST_BUFFER_META (buffer);
2245 for (walk = prev; walk; walk = walk->next) {
2246 GstMeta *m = &walk->meta;
2248 const GstMetaInfo *info = meta->info;
2250 /* remove from list */
2251 if (GST_BUFFER_META (buffer) == walk)
2252 GST_BUFFER_META (buffer) = walk->next;
2254 prev->next = walk->next;
2255 /* call free_func if any */
2256 if (info->free_func)
2257 info->free_func (m, buffer);
2259 /* and free the slice */
2260 g_slice_free1 (ITEM_SIZE (info), walk);
2265 return walk != NULL;
2269 * gst_buffer_iterate_meta: (skip)
2270 * @buffer: a #GstBuffer
2271 * @state: (out caller-allocates): an opaque state pointer
2273 * Retrieve the next #GstMeta after @current. If @state points
2274 * to %NULL, the first metadata is returned.
2276 * @state will be updated with an opaque state pointer
2278 * Returns: (transfer none) (nullable): The next #GstMeta or %NULL
2279 * when there are no more items.
2282 gst_buffer_iterate_meta (GstBuffer * buffer, gpointer * state)
2286 g_return_val_if_fail (buffer != NULL, NULL);
2287 g_return_val_if_fail (state != NULL, NULL);
2289 meta = (GstMetaItem **) state;
2291 /* state NULL, move to first item */
2292 *meta = GST_BUFFER_META (buffer);
2294 /* state !NULL, move to next item in list */
2295 *meta = (*meta)->next;
2298 return &(*meta)->meta;
2304 * gst_buffer_iterate_meta_filtered: (skip)
2305 * @buffer: a #GstBuffer
2306 * @state: (out caller-allocates): an opaque state pointer
2307 * @meta_api_type: only return #GstMeta of this type
2309 * Retrieve the next #GstMeta of type @meta_api_type after the current one
2310 * according to @state. If @state points to %NULL, the first metadata of
2311 * type @meta_api_type is returned.
2313 * @state will be updated with an opaque state pointer
2315 * Returns: (transfer none) (nullable): The next #GstMeta of type
2316 * @meta_api_type or %NULL when there are no more items.
2321 gst_buffer_iterate_meta_filtered (GstBuffer * buffer, gpointer * state,
2322 GType meta_api_type)
2326 g_return_val_if_fail (buffer != NULL, NULL);
2327 g_return_val_if_fail (state != NULL, NULL);
2329 meta = (GstMetaItem **) state;
2331 /* state NULL, move to first item */
2332 *meta = GST_BUFFER_META (buffer);
2334 /* state !NULL, move to next item in list */
2335 *meta = (*meta)->next;
2337 while (*meta != NULL && (*meta)->meta.info->api != meta_api_type)
2338 *meta = (*meta)->next;
2341 return &(*meta)->meta;
2347 * gst_buffer_foreach_meta:
2348 * @buffer: a #GstBuffer
2349 * @func: (scope call): a #GstBufferForeachMetaFunc to call
2350 * @user_data: (closure): user data passed to @func
2352 * Call @func with @user_data for each meta in @buffer.
2354 * @func can modify the passed meta pointer or its contents. The return value
2355 * of @func define if this function returns or if the remaining metadata items
2356 * in the buffer should be skipped.
2358 * Returns: %FALSE when @func returned %FALSE for one of the metadata.
2361 gst_buffer_foreach_meta (GstBuffer * buffer, GstBufferForeachMetaFunc func,
2364 GstMetaItem *walk, *prev, *next;
2365 gboolean res = TRUE;
2367 g_return_val_if_fail (buffer != NULL, FALSE);
2368 g_return_val_if_fail (func != NULL, FALSE);
2370 /* find the metadata and delete */
2371 prev = GST_BUFFER_META (buffer);
2372 for (walk = prev; walk; walk = next) {
2375 m = new = &walk->meta;
2378 res = func (buffer, &new, user_data);
2381 const GstMetaInfo *info = m->info;
2383 GST_CAT_DEBUG (GST_CAT_BUFFER, "remove metadata %p (%s)", m,
2384 g_type_name (info->type));
2386 g_return_val_if_fail (gst_buffer_is_writable (buffer), FALSE);
2387 g_return_val_if_fail (!GST_META_FLAG_IS_SET (m, GST_META_FLAG_LOCKED),
2390 /* remove from list */
2391 if (GST_BUFFER_META (buffer) == walk)
2392 GST_BUFFER_META (buffer) = next;
2398 /* call free_func if any */
2399 if (info->free_func)
2400 info->free_func (m, buffer);
2402 /* and free the slice */
2403 g_slice_free1 (ITEM_SIZE (info), walk);
2414 * gst_buffer_extract_dup:
2415 * @buffer: a #GstBuffer
2416 * @offset: the offset to extract
2417 * @size: the size to extract
2418 * @dest: (array length=dest_size) (element-type guint8) (out): A pointer where
2419 * the destination array will be written. Might be %NULL if the size is 0.
2420 * @dest_size: (out): A location where the size of @dest can be written
2422 * Extracts a copy of at most @size bytes the data at @offset into
2423 * newly-allocated memory. @dest must be freed using g_free() when done.
2429 gst_buffer_extract_dup (GstBuffer * buffer, gsize offset, gsize size,
2430 gpointer * dest, gsize * dest_size)
2432 gsize real_size, alloc_size;
2434 real_size = gst_buffer_get_size (buffer);
2436 alloc_size = MIN (real_size - offset, size);
2437 if (alloc_size == 0) {
2441 *dest = g_malloc (alloc_size);
2442 *dest_size = gst_buffer_extract (buffer, offset, *dest, size);
2446 GST_DEBUG_CATEGORY_STATIC (gst_parent_buffer_meta_debug);
2449 * gst_buffer_add_parent_buffer_meta:
2450 * @buffer: (transfer none): a #GstBuffer
2451 * @ref: (transfer none): a #GstBuffer to ref
2453 * Add a #GstParentBufferMeta to @buffer that holds a reference on
2454 * @ref until the buffer is freed.
2456 * Returns: (transfer none) (nullable): The #GstParentBufferMeta that was added to the buffer
2460 GstParentBufferMeta *
2461 gst_buffer_add_parent_buffer_meta (GstBuffer * buffer, GstBuffer * ref)
2463 GstParentBufferMeta *meta;
2465 g_return_val_if_fail (GST_IS_BUFFER (ref), NULL);
2468 (GstParentBufferMeta *) gst_buffer_add_meta (buffer,
2469 GST_PARENT_BUFFER_META_INFO, NULL);
2474 meta->buffer = gst_buffer_ref (ref);
2480 _gst_parent_buffer_meta_transform (GstBuffer * dest, GstMeta * meta,
2481 GstBuffer * buffer, GQuark type, gpointer data)
2483 GstParentBufferMeta *dmeta, *smeta;
2485 smeta = (GstParentBufferMeta *) meta;
2487 if (GST_META_TRANSFORM_IS_COPY (type)) {
2488 /* copy over the reference to the parent buffer.
2489 * Usually, this meta means we need to keep the parent buffer
2490 * alive because one of the child memories is in use, which
2491 * might not be the case if memory is deep copied or sub-regioned,
2492 * but we can't tell, so keep the meta */
2493 dmeta = gst_buffer_add_parent_buffer_meta (dest, smeta->buffer);
2497 GST_CAT_DEBUG (gst_parent_buffer_meta_debug,
2498 "copy buffer reference metadata");
2500 /* return FALSE, if transform type is not supported */
2507 _gst_parent_buffer_meta_free (GstParentBufferMeta * parent_meta,
2510 GST_CAT_DEBUG (gst_parent_buffer_meta_debug,
2511 "Dropping reference on buffer %p", parent_meta->buffer);
2512 gst_buffer_unref (parent_meta->buffer);
2516 _gst_parent_buffer_meta_init (GstParentBufferMeta * parent_meta,
2517 gpointer params, GstBuffer * buffer)
2519 static volatile gsize _init;
2521 if (g_once_init_enter (&_init)) {
2522 GST_DEBUG_CATEGORY_INIT (gst_parent_buffer_meta_debug, "parentbuffermeta",
2523 0, "parentbuffermeta");
2524 g_once_init_leave (&_init, 1);
2527 parent_meta->buffer = NULL;
2533 gst_parent_buffer_meta_api_get_type (void)
2535 static volatile GType type = 0;
2536 static const gchar *tags[] = { NULL };
2538 if (g_once_init_enter (&type)) {
2539 GType _type = gst_meta_api_type_register ("GstParentBufferMetaAPI", tags);
2540 g_once_init_leave (&type, _type);
2547 * gst_parent_buffer_meta_get_info:
2549 * Get the global #GstMetaInfo describing the #GstParentBufferMeta meta.
2551 * Returns: (transfer none): The #GstMetaInfo
2556 gst_parent_buffer_meta_get_info (void)
2558 static const GstMetaInfo *meta_info = NULL;
2560 if (g_once_init_enter ((GstMetaInfo **) & meta_info)) {
2561 const GstMetaInfo *meta =
2562 gst_meta_register (gst_parent_buffer_meta_api_get_type (),
2563 "GstParentBufferMeta",
2564 sizeof (GstParentBufferMeta),
2565 (GstMetaInitFunction) _gst_parent_buffer_meta_init,
2566 (GstMetaFreeFunction) _gst_parent_buffer_meta_free,
2567 _gst_parent_buffer_meta_transform);
2568 g_once_init_leave ((GstMetaInfo **) & meta_info, (GstMetaInfo *) meta);
2574 GST_DEBUG_CATEGORY_STATIC (gst_reference_timestamp_meta_debug);
2577 * gst_buffer_add_reference_timestamp_meta:
2578 * @buffer: (transfer none): a #GstBuffer
2579 * @reference: (transfer none): identifier for the timestamp reference.
2580 * @timestamp: timestamp
2581 * @duration: duration, or %GST_CLOCK_TIME_NONE
2583 * Add a #GstReferenceTimestampMeta to @buffer that holds a @timestamp and
2584 * optionally @duration based on a specific timestamp @reference. See the
2585 * documentation of #GstReferenceTimestampMeta for details.
2587 * Returns: (transfer none) (nullable): The #GstReferenceTimestampMeta that was added to the buffer
2591 GstReferenceTimestampMeta *
2592 gst_buffer_add_reference_timestamp_meta (GstBuffer * buffer,
2593 GstCaps * reference, GstClockTime timestamp, GstClockTime duration)
2595 GstReferenceTimestampMeta *meta;
2597 g_return_val_if_fail (GST_IS_CAPS (reference), NULL);
2598 g_return_val_if_fail (timestamp != GST_CLOCK_TIME_NONE, NULL);
2601 (GstReferenceTimestampMeta *) gst_buffer_add_meta (buffer,
2602 GST_REFERENCE_TIMESTAMP_META_INFO, NULL);
2607 meta->reference = gst_caps_ref (reference);
2608 meta->timestamp = timestamp;
2609 meta->duration = duration;
2615 * gst_buffer_get_reference_timestamp_meta:
2616 * @buffer: a #GstBuffer
2617 * @reference: (allow-none): a reference #GstCaps
2619 * Find the first #GstReferenceTimestampMeta on @buffer that conforms to
2620 * @reference. Conformance is tested by checking if the meta's reference is a
2621 * subset of @reference.
2623 * Buffers can contain multiple #GstReferenceTimestampMeta metadata items.
2625 * Returns: (transfer none) (nullable): the #GstReferenceTimestampMeta or %NULL when there
2626 * is no such metadata on @buffer.
2630 GstReferenceTimestampMeta *
2631 gst_buffer_get_reference_timestamp_meta (GstBuffer * buffer,
2632 GstCaps * reference)
2634 gpointer state = NULL;
2636 const GstMetaInfo *info = GST_REFERENCE_TIMESTAMP_META_INFO;
2638 while ((meta = gst_buffer_iterate_meta (buffer, &state))) {
2639 if (meta->info->api == info->api) {
2640 GstReferenceTimestampMeta *rmeta = (GstReferenceTimestampMeta *) meta;
2644 if (gst_caps_is_subset (rmeta->reference, reference))
2652 _gst_reference_timestamp_meta_transform (GstBuffer * dest, GstMeta * meta,
2653 GstBuffer * buffer, GQuark type, gpointer data)
2655 GstReferenceTimestampMeta *dmeta, *smeta;
2657 /* we copy over the reference timestamp meta, independent of transformation
2658 * that happens. If it applied to the original buffer, it still applies to
2659 * the new buffer as it refers to the time when the media was captured */
2660 smeta = (GstReferenceTimestampMeta *) meta;
2662 gst_buffer_add_reference_timestamp_meta (dest, smeta->reference,
2663 smeta->timestamp, smeta->duration);
2667 GST_CAT_DEBUG (gst_reference_timestamp_meta_debug,
2668 "copy reference timestamp metadata from buffer %p to %p", buffer, dest);
2674 _gst_reference_timestamp_meta_free (GstReferenceTimestampMeta * meta,
2677 if (meta->reference)
2678 gst_caps_unref (meta->reference);
2682 _gst_reference_timestamp_meta_init (GstReferenceTimestampMeta * meta,
2683 gpointer params, GstBuffer * buffer)
2685 static volatile gsize _init;
2687 if (g_once_init_enter (&_init)) {
2688 GST_DEBUG_CATEGORY_INIT (gst_reference_timestamp_meta_debug,
2689 "referencetimestampmeta", 0, "referencetimestampmeta");
2690 g_once_init_leave (&_init, 1);
2693 meta->reference = NULL;
2694 meta->timestamp = GST_CLOCK_TIME_NONE;
2695 meta->duration = GST_CLOCK_TIME_NONE;
2701 gst_reference_timestamp_meta_api_get_type (void)
2703 static volatile GType type = 0;
2704 static const gchar *tags[] = { NULL };
2706 if (g_once_init_enter (&type)) {
2708 gst_meta_api_type_register ("GstReferenceTimestampMetaAPI", tags);
2709 g_once_init_leave (&type, _type);
2716 * gst_reference_timestamp_meta_get_info:
2718 * Get the global #GstMetaInfo describing the #GstReferenceTimestampMeta meta.
2720 * Returns: (transfer none): The #GstMetaInfo
2725 gst_reference_timestamp_meta_get_info (void)
2727 static const GstMetaInfo *meta_info = NULL;
2729 if (g_once_init_enter ((GstMetaInfo **) & meta_info)) {
2730 const GstMetaInfo *meta =
2731 gst_meta_register (gst_reference_timestamp_meta_api_get_type (),
2732 "GstReferenceTimestampMeta",
2733 sizeof (GstReferenceTimestampMeta),
2734 (GstMetaInitFunction) _gst_reference_timestamp_meta_init,
2735 (GstMetaFreeFunction) _gst_reference_timestamp_meta_free,
2736 _gst_reference_timestamp_meta_transform);
2737 g_once_init_leave ((GstMetaInfo **) & meta_info, (GstMetaInfo *) meta);