doc: Fix Since: marks
[platform/upstream/gstreamer.git] / gst / gstbuffer.c
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *
5  * gstbuffer.c: Buffer operations
6  *
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.
11  *
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.
16  *
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.
21  */
22
23 /**
24  * SECTION:gstbuffer
25  * @short_description: Data-passing buffer type
26  * @see_also: #GstPad, #GstMiniObject, #GstMemory, #GstMeta, #GstBufferPool
27  *
28  * Buffers are the basic unit of data transfer in GStreamer. They contain the
29  * timing and offset along with other arbitrary metadata that is associated
30  * with the #GstMemory blocks that the buffer contains.
31  *
32  * Buffers are usually created with gst_buffer_new(). After a buffer has been
33  * created one will typically allocate memory for it and add it to the buffer.
34  * The following example creates a buffer that can hold a given video frame
35  * with a given width, height and bits per plane.
36  * |[
37  *   GstBuffer *buffer;
38  *   GstMemory *memory;
39  *   gint size, width, height, bpp;
40  *   ...
41  *   size = width * height * bpp;
42  *   buffer = gst_buffer_new ();
43  *   memory = gst_allocator_alloc (NULL, size, NULL);
44  *   gst_buffer_insert_memory (buffer, -1, memory);
45  *   ...
46  * ]|
47  *
48  * Alternatively, use gst_buffer_new_allocate() to create a buffer with
49  * preallocated data of a given size.
50  *
51  * Buffers can contain a list of #GstMemory objects. You can retrieve how many
52  * memory objects with gst_buffer_n_memory() and you can get a pointer
53  * to memory with gst_buffer_peek_memory()
54  *
55  * A buffer will usually have timestamps, and a duration, but neither of these
56  * are guaranteed (they may be set to #GST_CLOCK_TIME_NONE). Whenever a
57  * meaningful value can be given for these, they should be set. The timestamps
58  * and duration are measured in nanoseconds (they are #GstClockTime values).
59  *
60  * The buffer DTS refers to the timestamp when the buffer should be decoded and
61  * is usually monotonically increasing. The buffer PTS refers to the timestamp when
62  * the buffer content should be presented to the user and is not always
63  * monotonically increasing.
64  *
65  * A buffer can also have one or both of a start and an end offset. These are
66  * media-type specific. For video buffers, the start offset will generally be
67  * the frame number. For audio buffers, it will be the number of samples
68  * produced so far. For compressed data, it could be the byte offset in a
69  * source or destination file. Likewise, the end offset will be the offset of
70  * the end of the buffer. These can only be meaningfully interpreted if you
71  * know the media type of the buffer (the preceding CAPS event). Either or both
72  * can be set to #GST_BUFFER_OFFSET_NONE.
73  *
74  * gst_buffer_ref() is used to increase the refcount of a buffer. This must be
75  * done when you want to keep a handle to the buffer after pushing it to the
76  * next element. The buffer refcount determines the writability of the buffer, a
77  * buffer is only writable when the refcount is exactly 1, i.e. when the caller
78  * has the only reference to the buffer.
79  *
80  * To efficiently create a smaller buffer out of an existing one, you can
81  * use gst_buffer_copy_region(). This method tries to share the memory objects
82  * between the two buffers.
83  *
84  * If a plug-in wants to modify the buffer data or metadata in-place, it should
85  * first obtain a buffer that is safe to modify by using
86  * gst_buffer_make_writable().  This function is optimized so that a copy will
87  * only be made when it is necessary.
88  *
89  * Several flags of the buffer can be set and unset with the
90  * GST_BUFFER_FLAG_SET() and GST_BUFFER_FLAG_UNSET() macros. Use
91  * GST_BUFFER_FLAG_IS_SET() to test if a certain #GstBufferFlags flag is set.
92  *
93  * Buffers can be efficiently merged into a larger buffer with
94  * gst_buffer_append(). Copying of memory will only be done when absolutely
95  * needed.
96  *
97  * Arbitrary extra metadata can be set on a buffer with gst_buffer_add_meta().
98  * Metadata can be retrieved with gst_buffer_get_meta(). See also #GstMeta
99  *
100  * An element should either unref the buffer or push it out on a src pad
101  * using gst_pad_push() (see #GstPad).
102  *
103  * Buffers are usually freed by unreffing them with gst_buffer_unref(). When
104  * the refcount drops to 0, any memory and metadata pointed to by the buffer is
105  * unreffed as well. Buffers allocated from a #GstBufferPool will be returned to
106  * the pool when the refcount drops to 0.
107  */
108 #include "gst_private.h"
109
110 #ifdef HAVE_UNISTD_H
111 #include <unistd.h>
112 #endif
113 #ifdef HAVE_STDLIB_H
114 #include <stdlib.h>
115 #endif
116
117 #include "gstbuffer.h"
118 #include "gstbufferpool.h"
119 #include "gstinfo.h"
120 #include "gstutils.h"
121 #include "gstversion.h"
122
123 GType _gst_buffer_type = 0;
124
125 typedef struct _GstMetaItem GstMetaItem;
126
127 struct _GstMetaItem
128 {
129   GstMetaItem *next;
130   GstMeta meta;
131 };
132 #define ITEM_SIZE(info) ((info)->size + sizeof (GstMetaItem))
133
134 #define GST_BUFFER_MEM_MAX         16
135
136 #define GST_BUFFER_SLICE_SIZE(b)   (((GstBufferImpl *)(b))->slice_size)
137 #define GST_BUFFER_MEM_LEN(b)      (((GstBufferImpl *)(b))->len)
138 #define GST_BUFFER_MEM_ARRAY(b)    (((GstBufferImpl *)(b))->mem)
139 #define GST_BUFFER_MEM_PTR(b,i)    (((GstBufferImpl *)(b))->mem[i])
140 #define GST_BUFFER_BUFMEM(b)       (((GstBufferImpl *)(b))->bufmem)
141 #define GST_BUFFER_META(b)         (((GstBufferImpl *)(b))->item)
142
143 typedef struct
144 {
145   GstBuffer buffer;
146
147   gsize slice_size;
148
149   /* the memory blocks */
150   guint len;
151   GstMemory *mem[GST_BUFFER_MEM_MAX];
152
153   /* memory of the buffer when allocated from 1 chunk */
154   GstMemory *bufmem;
155
156   /* FIXME, make metadata allocation more efficient by using part of the
157    * GstBufferImpl */
158   GstMetaItem *item;
159 } GstBufferImpl;
160
161
162 static gboolean
163 _is_span (GstMemory ** mem, gsize len, gsize * poffset, GstMemory ** parent)
164 {
165   GstMemory *mcur, *mprv;
166   gboolean have_offset = FALSE;
167   gsize i;
168
169   mcur = mprv = NULL;
170
171   for (i = 0; i < len; i++) {
172     if (mcur)
173       mprv = mcur;
174     mcur = mem[i];
175
176     if (mprv && mcur) {
177       gsize poffs;
178
179       /* check if memory is contiguous */
180       if (!gst_memory_is_span (mprv, mcur, &poffs))
181         return FALSE;
182
183       if (!have_offset) {
184         if (poffset)
185           *poffset = poffs;
186         if (parent)
187           *parent = mprv->parent;
188
189         have_offset = TRUE;
190       }
191     }
192   }
193   return have_offset;
194 }
195
196 static GstMemory *
197 _get_merged_memory (GstBuffer * buffer, guint idx, guint length)
198 {
199   GstMemory **mem, *result = NULL;
200
201   GST_CAT_LOG (GST_CAT_BUFFER, "buffer %p, idx %u, length %u", buffer, idx,
202       length);
203
204   mem = GST_BUFFER_MEM_ARRAY (buffer);
205
206   if (G_UNLIKELY (length == 0)) {
207     result = NULL;
208   } else if (G_LIKELY (length == 1)) {
209     result = gst_memory_ref (mem[idx]);
210   } else {
211     GstMemory *parent = NULL;
212     gsize size, poffset = 0;
213
214     size = gst_buffer_get_sizes_range (buffer, idx, length, NULL, NULL);
215
216     if (G_UNLIKELY (_is_span (mem + idx, length, &poffset, &parent))) {
217       if (!GST_MEMORY_IS_NO_SHARE (parent))
218         result = gst_memory_share (parent, poffset, size);
219       if (!result) {
220         GST_CAT_DEBUG (GST_CAT_PERFORMANCE, "copy for merge %p", parent);
221         result = gst_memory_copy (parent, poffset, size);
222       }
223     } else {
224       gsize i, tocopy, left;
225       GstMapInfo sinfo, dinfo;
226       guint8 *ptr;
227
228       result = gst_allocator_alloc (NULL, size, NULL);
229       gst_memory_map (result, &dinfo, GST_MAP_WRITE);
230
231       ptr = dinfo.data;
232       left = size;
233
234       for (i = idx; i < (idx + length) && left > 0; i++) {
235         gst_memory_map (mem[i], &sinfo, GST_MAP_READ);
236         tocopy = MIN (sinfo.size, left);
237         GST_CAT_DEBUG (GST_CAT_PERFORMANCE,
238             "memcpy %" G_GSIZE_FORMAT " bytes for merge %p from memory %p",
239             tocopy, result, mem[i]);
240         memcpy (ptr, (guint8 *) sinfo.data, tocopy);
241         left -= tocopy;
242         ptr += tocopy;
243         gst_memory_unmap (mem[i], &sinfo);
244       }
245       gst_memory_unmap (result, &dinfo);
246     }
247   }
248   return result;
249 }
250
251 static void
252 _replace_memory (GstBuffer * buffer, guint len, guint idx, guint length,
253     GstMemory * mem)
254 {
255   gsize end, i;
256
257   end = idx + length;
258
259   GST_CAT_LOG (GST_CAT_BUFFER,
260       "buffer %p replace %u-%" G_GSIZE_FORMAT " with memory %p", buffer, idx,
261       end, mem);
262
263   /* unref old memory */
264   for (i = idx; i < end; i++) {
265     GstMemory *old = GST_BUFFER_MEM_PTR (buffer, i);
266
267     gst_memory_unlock (old, GST_LOCK_FLAG_EXCLUSIVE);
268     gst_memory_unref (old);
269   }
270
271   if (mem != NULL) {
272     /* replace with single memory */
273     gst_memory_lock (mem, GST_LOCK_FLAG_EXCLUSIVE);
274     GST_BUFFER_MEM_PTR (buffer, idx) = mem;
275     idx++;
276     length--;
277   }
278
279   if (end < len) {
280     memmove (&GST_BUFFER_MEM_PTR (buffer, idx),
281         &GST_BUFFER_MEM_PTR (buffer, end), (len - end) * sizeof (gpointer));
282   }
283   GST_BUFFER_MEM_LEN (buffer) = len - length;
284   GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY);
285 }
286
287 /* transfer full for return and transfer none for @mem */
288 static inline GstMemory *
289 _memory_get_exclusive_reference (GstMemory * mem)
290 {
291   GstMemory *ret = NULL;
292
293   if (gst_memory_lock (mem, GST_LOCK_FLAG_EXCLUSIVE)) {
294     ret = gst_memory_ref (mem);
295   } else {
296     /* we cannot take another exclusive lock as the memory is already
297      * locked WRITE + EXCLUSIVE according to part-miniobject.txt */
298     ret = gst_memory_copy (mem, 0, -1);
299
300     if (ret) {
301       if (!gst_memory_lock (ret, GST_LOCK_FLAG_EXCLUSIVE)) {
302         gst_memory_unref (ret);
303         ret = NULL;
304       }
305     }
306   }
307
308   if (!ret)
309     GST_CAT_WARNING (GST_CAT_BUFFER, "Failed to acquire an exclusive lock for "
310         "memory %p", mem);
311
312   return ret;
313 }
314
315 static inline void
316 _memory_add (GstBuffer * buffer, gint idx, GstMemory * mem)
317 {
318   guint i, len = GST_BUFFER_MEM_LEN (buffer);
319
320   GST_CAT_LOG (GST_CAT_BUFFER, "buffer %p, idx %d, mem %p", buffer, idx, mem);
321
322   if (G_UNLIKELY (len >= GST_BUFFER_MEM_MAX)) {
323     /* too many buffer, span them. */
324     /* FIXME, there is room for improvement here: We could only try to merge
325      * 2 buffers to make some room. If we can't efficiently merge 2 buffers we
326      * could try to only merge the two smallest buffers to avoid memcpy, etc. */
327     GST_CAT_DEBUG (GST_CAT_PERFORMANCE, "memory array overflow in buffer %p",
328         buffer);
329     _replace_memory (buffer, len, 0, len, _get_merged_memory (buffer, 0, len));
330     /* we now have 1 single spanned buffer */
331     len = 1;
332   }
333
334   if (idx == -1)
335     idx = len;
336
337   for (i = len; i > idx; i--) {
338     /* move buffers to insert, FIXME, we need to insert first and then merge */
339     GST_BUFFER_MEM_PTR (buffer, i) = GST_BUFFER_MEM_PTR (buffer, i - 1);
340   }
341   /* and insert the new buffer */
342   GST_BUFFER_MEM_PTR (buffer, idx) = mem;
343   GST_BUFFER_MEM_LEN (buffer) = len + 1;
344
345   GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY);
346 }
347
348 GST_DEFINE_MINI_OBJECT_TYPE (GstBuffer, gst_buffer);
349
350 void
351 _priv_gst_buffer_initialize (void)
352 {
353   _gst_buffer_type = gst_buffer_get_type ();
354 }
355
356 /**
357  * gst_buffer_get_max_memory:
358  *
359  * Get the maximum amount of memory blocks that a buffer can hold. This is a
360  * compile time constant that can be queried with the function.
361  *
362  * When more memory blocks are added, existing memory blocks will be merged
363  * together to make room for the new block.
364  *
365  * Returns: the maximum amount of memory blocks that a buffer can hold.
366  *
367  * Since: 1.2
368  */
369 guint
370 gst_buffer_get_max_memory (void)
371 {
372   return GST_BUFFER_MEM_MAX;
373 }
374
375 /**
376  * gst_buffer_copy_into:
377  * @dest: a destination #GstBuffer
378  * @src: a source #GstBuffer
379  * @flags: flags indicating what metadata fields should be copied.
380  * @offset: offset to copy from
381  * @size: total size to copy. If -1, all data is copied.
382  *
383  * Copies the information from @src into @dest.
384  *
385  * If @dest already contains memory and @flags contains GST_BUFFER_COPY_MEMORY,
386  * the memory from @src will be appended to @dest.
387  *
388  * @flags indicate which fields will be copied.
389  *
390  * Returns: %TRUE if the copying succeeded, %FALSE otherwise.
391  */
392 gboolean
393 gst_buffer_copy_into (GstBuffer * dest, GstBuffer * src,
394     GstBufferCopyFlags flags, gsize offset, gsize size)
395 {
396   GstMetaItem *walk;
397   gsize bufsize;
398   gboolean region = FALSE;
399
400   g_return_val_if_fail (dest != NULL, FALSE);
401   g_return_val_if_fail (src != NULL, FALSE);
402
403   /* nothing to copy if the buffers are the same */
404   if (G_UNLIKELY (dest == src))
405     return TRUE;
406
407   g_return_val_if_fail (gst_buffer_is_writable (dest), FALSE);
408
409   bufsize = gst_buffer_get_size (src);
410   g_return_val_if_fail (bufsize >= offset, FALSE);
411   if (offset > 0)
412     region = TRUE;
413   if (size == -1)
414     size = bufsize - offset;
415   if (size < bufsize)
416     region = TRUE;
417   g_return_val_if_fail (bufsize >= offset + size, FALSE);
418
419   GST_CAT_LOG (GST_CAT_BUFFER, "copy %p to %p, offset %" G_GSIZE_FORMAT
420       "-%" G_GSIZE_FORMAT "/%" G_GSIZE_FORMAT, src, dest, offset, size,
421       bufsize);
422
423   if (flags & GST_BUFFER_COPY_FLAGS) {
424     /* copy flags */
425     guint flags_mask = ~GST_BUFFER_FLAG_TAG_MEMORY;
426
427     GST_MINI_OBJECT_FLAGS (dest) =
428         (GST_MINI_OBJECT_FLAGS (src) & flags_mask) |
429         (GST_MINI_OBJECT_FLAGS (dest) & ~flags_mask);
430   }
431
432   if (flags & GST_BUFFER_COPY_TIMESTAMPS) {
433     if (offset == 0) {
434       GST_BUFFER_PTS (dest) = GST_BUFFER_PTS (src);
435       GST_BUFFER_DTS (dest) = GST_BUFFER_DTS (src);
436       GST_BUFFER_OFFSET (dest) = GST_BUFFER_OFFSET (src);
437       if (size == bufsize) {
438         GST_BUFFER_DURATION (dest) = GST_BUFFER_DURATION (src);
439         GST_BUFFER_OFFSET_END (dest) = GST_BUFFER_OFFSET_END (src);
440       }
441     } else {
442       GST_BUFFER_PTS (dest) = GST_CLOCK_TIME_NONE;
443       GST_BUFFER_DTS (dest) = GST_CLOCK_TIME_NONE;
444       GST_BUFFER_DURATION (dest) = GST_CLOCK_TIME_NONE;
445       GST_BUFFER_OFFSET (dest) = GST_BUFFER_OFFSET_NONE;
446       GST_BUFFER_OFFSET_END (dest) = GST_BUFFER_OFFSET_NONE;
447     }
448   }
449
450   if (flags & GST_BUFFER_COPY_MEMORY) {
451     gsize skip, left, len, dest_len, i, bsize;
452     gboolean deep;
453
454     deep = flags & GST_BUFFER_COPY_DEEP;
455
456     len = GST_BUFFER_MEM_LEN (src);
457     dest_len = GST_BUFFER_MEM_LEN (dest);
458     left = size;
459     skip = offset;
460
461     /* copy and make regions of the memory */
462     for (i = 0; i < len && left > 0; i++) {
463       GstMemory *mem = GST_BUFFER_MEM_PTR (src, i);
464
465       bsize = gst_memory_get_sizes (mem, NULL, NULL);
466
467       if (bsize <= skip) {
468         /* don't copy buffer */
469         skip -= bsize;
470       } else {
471         GstMemory *newmem = NULL;
472         gsize tocopy;
473
474         tocopy = MIN (bsize - skip, left);
475
476         if (tocopy < bsize && !deep && !GST_MEMORY_IS_NO_SHARE (mem)) {
477           /* we need to clip something */
478           newmem = gst_memory_share (mem, skip, tocopy);
479           if (newmem) {
480             gst_memory_lock (newmem, GST_LOCK_FLAG_EXCLUSIVE);
481             skip = 0;
482           }
483         }
484
485         if (deep || GST_MEMORY_IS_NO_SHARE (mem) || (!newmem && tocopy < bsize)) {
486           /* deep copy or we're not allowed to share this memory
487            * between buffers, always copy then */
488           newmem = gst_memory_copy (mem, skip, tocopy);
489           if (newmem) {
490             gst_memory_lock (newmem, GST_LOCK_FLAG_EXCLUSIVE);
491             skip = 0;
492           }
493         } else if (!newmem) {
494           newmem = _memory_get_exclusive_reference (mem);
495         }
496
497         if (!newmem) {
498           gst_buffer_remove_memory_range (dest, dest_len, -1);
499           return FALSE;
500         }
501
502         _memory_add (dest, -1, newmem);
503         left -= tocopy;
504       }
505     }
506     if (flags & GST_BUFFER_COPY_MERGE) {
507       GstMemory *mem;
508
509       len = GST_BUFFER_MEM_LEN (dest);
510       mem = _get_merged_memory (dest, 0, len);
511       if (!mem) {
512         gst_buffer_remove_memory_range (dest, dest_len, -1);
513         return FALSE;
514       }
515       _replace_memory (dest, len, 0, len, mem);
516     }
517   }
518
519   if (flags & GST_BUFFER_COPY_META) {
520     /* NOTE: GstGLSyncMeta copying relies on the meta
521      *       being copied now, after the buffer data,
522      *       so this has to happen last */
523     for (walk = GST_BUFFER_META (src); walk; walk = walk->next) {
524       GstMeta *meta = &walk->meta;
525       const GstMetaInfo *info = meta->info;
526
527       if (info->transform_func) {
528         GstMetaTransformCopy copy_data;
529
530         copy_data.region = region;
531         copy_data.offset = offset;
532         copy_data.size = size;
533
534         if (!info->transform_func (dest, meta, src,
535                 _gst_meta_transform_copy, &copy_data)) {
536           GST_CAT_ERROR (GST_CAT_BUFFER,
537               "failed to copy meta %p of API type %s", meta,
538               g_type_name (info->api));
539         }
540       }
541     }
542   }
543
544   return TRUE;
545 }
546
547 static GstBuffer *
548 gst_buffer_copy_with_flags (const GstBuffer * buffer, GstBufferCopyFlags flags)
549 {
550   GstBuffer *copy;
551
552   g_return_val_if_fail (buffer != NULL, NULL);
553
554   /* create a fresh new buffer */
555   copy = gst_buffer_new ();
556
557   /* copy what the 'flags' want from our parent */
558   /* FIXME why we can't pass const to gst_buffer_copy_into() ? */
559   if (!gst_buffer_copy_into (copy, (GstBuffer *) buffer, flags, 0, -1))
560     gst_buffer_replace (&copy, NULL);
561
562   if (copy)
563     GST_BUFFER_FLAG_UNSET (copy, GST_BUFFER_FLAG_TAG_MEMORY);
564
565   return copy;
566 }
567
568 static GstBuffer *
569 _gst_buffer_copy (const GstBuffer * buffer)
570 {
571   return gst_buffer_copy_with_flags (buffer, GST_BUFFER_COPY_ALL);
572 }
573
574 /**
575  * gst_buffer_copy_deep:
576  * @buf: a #GstBuffer.
577  *
578  * Create a copy of the given buffer. This will make a newly allocated
579  * copy of the data the source buffer contains.
580  *
581  * Returns: (transfer full): a new copy of @buf.
582  *
583  * Since: 1.6
584  */
585 GstBuffer *
586 gst_buffer_copy_deep (const GstBuffer * buffer)
587 {
588   return gst_buffer_copy_with_flags (buffer,
589       GST_BUFFER_COPY_ALL | GST_BUFFER_COPY_DEEP);
590 }
591
592 /* the default dispose function revives the buffer and returns it to the
593  * pool when there is a pool */
594 static gboolean
595 _gst_buffer_dispose (GstBuffer * buffer)
596 {
597   GstBufferPool *pool;
598
599   /* no pool, do free */
600   if ((pool = buffer->pool) == NULL)
601     return TRUE;
602
603   /* keep the buffer alive */
604   gst_buffer_ref (buffer);
605   /* return the buffer to the pool */
606   GST_CAT_LOG (GST_CAT_BUFFER, "release %p to pool %p", buffer, pool);
607   gst_buffer_pool_release_buffer (pool, buffer);
608
609   return FALSE;
610 }
611
612 static void
613 _gst_buffer_free (GstBuffer * buffer)
614 {
615   GstMetaItem *walk, *next;
616   guint i, len;
617   gsize msize;
618
619   g_return_if_fail (buffer != NULL);
620
621   GST_CAT_LOG (GST_CAT_BUFFER, "finalize %p", buffer);
622
623   /* free metadata */
624   for (walk = GST_BUFFER_META (buffer); walk; walk = next) {
625     GstMeta *meta = &walk->meta;
626     const GstMetaInfo *info = meta->info;
627
628     /* call free_func if any */
629     if (info->free_func)
630       info->free_func (meta, buffer);
631
632     next = walk->next;
633     /* and free the slice */
634     g_slice_free1 (ITEM_SIZE (info), walk);
635   }
636
637   /* get the size, when unreffing the memory, we could also unref the buffer
638    * itself */
639   msize = GST_BUFFER_SLICE_SIZE (buffer);
640
641   /* free our memory */
642   len = GST_BUFFER_MEM_LEN (buffer);
643   for (i = 0; i < len; i++) {
644     gst_memory_unlock (GST_BUFFER_MEM_PTR (buffer, i), GST_LOCK_FLAG_EXCLUSIVE);
645     gst_memory_unref (GST_BUFFER_MEM_PTR (buffer, i));
646   }
647
648   /* we set msize to 0 when the buffer is part of the memory block */
649   if (msize) {
650 #ifdef USE_POISONING
651     memset (buffer, 0xff, msize);
652 #endif
653     g_slice_free1 (msize, buffer);
654   } else {
655     gst_memory_unref (GST_BUFFER_BUFMEM (buffer));
656   }
657 }
658
659 static void
660 gst_buffer_init (GstBufferImpl * buffer, gsize size)
661 {
662   gst_mini_object_init (GST_MINI_OBJECT_CAST (buffer), 0, _gst_buffer_type,
663       (GstMiniObjectCopyFunction) _gst_buffer_copy,
664       (GstMiniObjectDisposeFunction) _gst_buffer_dispose,
665       (GstMiniObjectFreeFunction) _gst_buffer_free);
666
667   GST_BUFFER_SLICE_SIZE (buffer) = size;
668
669   GST_BUFFER (buffer)->pool = NULL;
670   GST_BUFFER_PTS (buffer) = GST_CLOCK_TIME_NONE;
671   GST_BUFFER_DTS (buffer) = GST_CLOCK_TIME_NONE;
672   GST_BUFFER_DURATION (buffer) = GST_CLOCK_TIME_NONE;
673   GST_BUFFER_OFFSET (buffer) = GST_BUFFER_OFFSET_NONE;
674   GST_BUFFER_OFFSET_END (buffer) = GST_BUFFER_OFFSET_NONE;
675
676   GST_BUFFER_MEM_LEN (buffer) = 0;
677   GST_BUFFER_META (buffer) = NULL;
678 }
679
680 /**
681  * gst_buffer_new:
682  *
683  * Creates a newly allocated buffer without any data.
684  *
685  * MT safe.
686  *
687  * Returns: (transfer full): the new #GstBuffer.
688  */
689 GstBuffer *
690 gst_buffer_new (void)
691 {
692   GstBufferImpl *newbuf;
693
694   newbuf = g_slice_new (GstBufferImpl);
695   GST_CAT_LOG (GST_CAT_BUFFER, "new %p", newbuf);
696
697   gst_buffer_init (newbuf, sizeof (GstBufferImpl));
698
699   return GST_BUFFER_CAST (newbuf);
700 }
701
702 /**
703  * gst_buffer_new_allocate:
704  * @allocator: (transfer none) (allow-none): the #GstAllocator to use, or %NULL to use the
705  *     default allocator
706  * @size: the size in bytes of the new buffer's data.
707  * @params: (transfer none) (allow-none): optional parameters
708  *
709  * Tries to create a newly allocated buffer with data of the given size and
710  * extra parameters from @allocator. If the requested amount of memory can't be
711  * allocated, %NULL will be returned. The allocated buffer memory is not cleared.
712  *
713  * When @allocator is %NULL, the default memory allocator will be used.
714  *
715  * Note that when @size == 0, the buffer will not have memory associated with it.
716  *
717  * MT safe.
718  *
719  * Returns: (transfer full) (nullable): a new #GstBuffer, or %NULL if
720  *     the memory couldn't be allocated.
721  */
722 GstBuffer *
723 gst_buffer_new_allocate (GstAllocator * allocator, gsize size,
724     GstAllocationParams * params)
725 {
726   GstBuffer *newbuf;
727   GstMemory *mem;
728 #if 0
729   guint8 *data;
730   gsize asize;
731 #endif
732
733 #if 1
734   if (size > 0) {
735     mem = gst_allocator_alloc (allocator, size, params);
736     if (G_UNLIKELY (mem == NULL))
737       goto no_memory;
738   } else {
739     mem = NULL;
740   }
741
742   newbuf = gst_buffer_new ();
743
744   if (mem != NULL) {
745     gst_memory_lock (mem, GST_LOCK_FLAG_EXCLUSIVE);
746     _memory_add (newbuf, -1, mem);
747   }
748
749   GST_CAT_LOG (GST_CAT_BUFFER,
750       "new buffer %p of size %" G_GSIZE_FORMAT " from allocator %p", newbuf,
751       size, allocator);
752 #endif
753
754 #if 0
755   asize = sizeof (GstBufferImpl) + size;
756   data = g_slice_alloc (asize);
757   if (G_UNLIKELY (data == NULL))
758     goto no_memory;
759
760   newbuf = GST_BUFFER_CAST (data);
761
762   gst_buffer_init ((GstBufferImpl *) data, asize);
763   if (size > 0) {
764     mem = gst_memory_new_wrapped (0, data + sizeof (GstBufferImpl), NULL,
765         size, 0, size);
766     _memory_add (newbuf, -1, mem, TRUE);
767   }
768 #endif
769
770 #if 0
771   /* allocate memory and buffer, it might be interesting to do this but there
772    * are many complications. We need to keep the memory mapped to access the
773    * buffer fields and the memory for the buffer might be just very slow. We
774    * also need to do some more magic to get the alignment right. */
775   asize = sizeof (GstBufferImpl) + size;
776   mem = gst_allocator_alloc (allocator, asize, align);
777   if (G_UNLIKELY (mem == NULL))
778     goto no_memory;
779
780   /* map the data part and init the buffer in it, set the buffer size to 0 so
781    * that a finalize won't free the buffer */
782   data = gst_memory_map (mem, &asize, NULL, GST_MAP_WRITE);
783   gst_buffer_init ((GstBufferImpl *) data, 0);
784   gst_memory_unmap (mem);
785
786   /* strip off the buffer */
787   gst_memory_resize (mem, sizeof (GstBufferImpl), size);
788
789   newbuf = GST_BUFFER_CAST (data);
790   GST_BUFFER_BUFMEM (newbuf) = mem;
791
792   if (size > 0)
793     _memory_add (newbuf, -1, gst_memory_ref (mem), TRUE);
794 #endif
795   GST_BUFFER_FLAG_UNSET (newbuf, GST_BUFFER_FLAG_TAG_MEMORY);
796
797   return newbuf;
798
799   /* ERRORS */
800 no_memory:
801   {
802     GST_CAT_WARNING (GST_CAT_BUFFER,
803         "failed to allocate %" G_GSIZE_FORMAT " bytes", size);
804     return NULL;
805   }
806 }
807
808 /**
809  * gst_buffer_new_wrapped_full:
810  * @flags: #GstMemoryFlags
811  * @data: (array length=size) (element-type guint8) (transfer none): data to wrap
812  * @maxsize: allocated size of @data
813  * @offset: offset in @data
814  * @size: size of valid data
815  * @user_data: (allow-none): user_data
816  * @notify: (allow-none) (scope async) (closure user_data): called with @user_data when the memory is freed
817  *
818  * Allocate a new buffer that wraps the given memory. @data must point to
819  * @maxsize of memory, the wrapped buffer will have the region from @offset and
820  * @size visible.
821  *
822  * When the buffer is destroyed, @notify will be called with @user_data.
823  *
824  * The prefix/padding must be filled with 0 if @flags contains
825  * #GST_MEMORY_FLAG_ZERO_PREFIXED and #GST_MEMORY_FLAG_ZERO_PADDED respectively.
826  *
827  * Returns: (transfer full): a new #GstBuffer
828  */
829 GstBuffer *
830 gst_buffer_new_wrapped_full (GstMemoryFlags flags, gpointer data,
831     gsize maxsize, gsize offset, gsize size, gpointer user_data,
832     GDestroyNotify notify)
833 {
834   GstMemory *mem;
835   GstBuffer *newbuf;
836
837   newbuf = gst_buffer_new ();
838   mem =
839       gst_memory_new_wrapped (flags, data, maxsize, offset, size, user_data,
840       notify);
841   gst_memory_lock (mem, GST_LOCK_FLAG_EXCLUSIVE);
842   _memory_add (newbuf, -1, mem);
843   GST_BUFFER_FLAG_UNSET (newbuf, GST_BUFFER_FLAG_TAG_MEMORY);
844
845   return newbuf;
846 }
847
848 /**
849  * gst_buffer_new_wrapped:
850  * @data: (array length=size) (element-type guint8) (transfer full): data to wrap
851  * @size: allocated size of @data
852  *
853  * Creates a new buffer that wraps the given @data. The memory will be freed
854  * with g_free and will be marked writable.
855  *
856  * MT safe.
857  *
858  * Returns: (transfer full): a new #GstBuffer
859  */
860 GstBuffer *
861 gst_buffer_new_wrapped (gpointer data, gsize size)
862 {
863   return gst_buffer_new_wrapped_full (0, data, size, 0, size, data, g_free);
864 }
865
866 /**
867  * gst_buffer_n_memory:
868  * @buffer: a #GstBuffer.
869  *
870  * Get the amount of memory blocks that this buffer has. This amount is never
871  * larger than what gst_buffer_get_max_memory() returns.
872  *
873  * Returns: (transfer full): the amount of memory block in this buffer.
874  */
875 guint
876 gst_buffer_n_memory (GstBuffer * buffer)
877 {
878   g_return_val_if_fail (GST_IS_BUFFER (buffer), 0);
879
880   return GST_BUFFER_MEM_LEN (buffer);
881 }
882
883 /**
884  * gst_buffer_prepend_memory:
885  * @buffer: a #GstBuffer.
886  * @mem: (transfer full): a #GstMemory.
887  *
888  * Prepend the memory block @mem to @buffer. This function takes
889  * ownership of @mem and thus doesn't increase its refcount.
890  *
891  * This function is identical to gst_buffer_insert_memory() with an index of 0.
892  * See gst_buffer_insert_memory() for more details.
893  */
894 void
895 gst_buffer_prepend_memory (GstBuffer * buffer, GstMemory * mem)
896 {
897   gst_buffer_insert_memory (buffer, 0, mem);
898 }
899
900 /**
901  * gst_buffer_append_memory:
902  * @buffer: a #GstBuffer.
903  * @mem: (transfer full): a #GstMemory.
904  *
905  * Append the memory block @mem to @buffer. This function takes
906  * ownership of @mem and thus doesn't increase its refcount.
907  *
908  * This function is identical to gst_buffer_insert_memory() with an index of -1.
909  * See gst_buffer_insert_memory() for more details.
910  */
911 void
912 gst_buffer_append_memory (GstBuffer * buffer, GstMemory * mem)
913 {
914   gst_buffer_insert_memory (buffer, -1, mem);
915 }
916
917 /**
918  * gst_buffer_insert_memory:
919  * @buffer: a #GstBuffer.
920  * @idx: the index to add the memory at, or -1 to append it to the end
921  * @mem: (transfer full): a #GstMemory.
922  *
923  * Insert the memory block @mem to @buffer at @idx. This function takes ownership
924  * of @mem and thus doesn't increase its refcount.
925  *
926  * Only gst_buffer_get_max_memory() can be added to a buffer. If more memory is
927  * added, existing memory blocks will automatically be merged to make room for
928  * the new memory.
929  */
930 void
931 gst_buffer_insert_memory (GstBuffer * buffer, gint idx, GstMemory * mem)
932 {
933   GstMemory *tmp;
934
935   g_return_if_fail (GST_IS_BUFFER (buffer));
936   g_return_if_fail (gst_buffer_is_writable (buffer));
937   g_return_if_fail (mem != NULL);
938   g_return_if_fail (idx == -1 ||
939       (idx >= 0 && idx <= GST_BUFFER_MEM_LEN (buffer)));
940
941   tmp = _memory_get_exclusive_reference (mem);
942   g_return_if_fail (tmp != NULL);
943   gst_memory_unref (mem);
944   _memory_add (buffer, idx, tmp);
945 }
946
947 static GstMemory *
948 _get_mapped (GstBuffer * buffer, guint idx, GstMapInfo * info,
949     GstMapFlags flags)
950 {
951   GstMemory *mem, *mapped;
952
953   mem = gst_memory_ref (GST_BUFFER_MEM_PTR (buffer, idx));
954
955   mapped = gst_memory_make_mapped (mem, info, flags);
956
957   if (mapped != mem) {
958     /* memory changed, lock new memory */
959     gst_memory_lock (mapped, GST_LOCK_FLAG_EXCLUSIVE);
960     GST_BUFFER_MEM_PTR (buffer, idx) = mapped;
961     /* unlock old memory */
962     gst_memory_unlock (mem, GST_LOCK_FLAG_EXCLUSIVE);
963     GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY);
964   }
965   gst_memory_unref (mem);
966
967   return mapped;
968 }
969
970 /**
971  * gst_buffer_peek_memory:
972  * @buffer: a #GstBuffer.
973  * @idx: an index
974  *
975  * Get the memory block at @idx in @buffer. The memory block stays valid until
976  * the memory block in @buffer is removed, replaced or merged, typically with
977  * any call that modifies the memory in @buffer.
978  *
979  * Returns: (transfer none): the #GstMemory at @idx.
980  */
981 GstMemory *
982 gst_buffer_peek_memory (GstBuffer * buffer, guint idx)
983 {
984   guint len;
985
986   g_return_val_if_fail (GST_IS_BUFFER (buffer), NULL);
987   len = GST_BUFFER_MEM_LEN (buffer);
988   g_return_val_if_fail (idx < len, NULL);
989
990   return GST_BUFFER_MEM_PTR (buffer, idx);
991 }
992
993 /**
994  * gst_buffer_get_memory:
995  * @buffer: a #GstBuffer.
996  * @idx: an index
997  *
998  * Get the memory block at index @idx in @buffer.
999  *
1000  * Returns: (transfer full): a #GstMemory that contains the data of the
1001  * memory block at @idx. Use gst_memory_unref () after usage.
1002  */
1003 GstMemory *
1004 gst_buffer_get_memory (GstBuffer * buffer, guint idx)
1005 {
1006   return gst_buffer_get_memory_range (buffer, idx, 1);
1007 }
1008
1009 /**
1010  * gst_buffer_get_all_memory:
1011  * @buffer: a #GstBuffer.
1012  *
1013  * Get all the memory block in @buffer. The memory blocks will be merged
1014  * into one large #GstMemory.
1015  *
1016  * Returns: (transfer full): a #GstMemory that contains the merged memory.
1017  * Use gst_memory_unref () after usage.
1018  */
1019 GstMemory *
1020 gst_buffer_get_all_memory (GstBuffer * buffer)
1021 {
1022   return gst_buffer_get_memory_range (buffer, 0, -1);
1023 }
1024
1025 /**
1026  * gst_buffer_get_memory_range:
1027  * @buffer: a #GstBuffer.
1028  * @idx: an index
1029  * @length: a length
1030  *
1031  * Get @length memory blocks in @buffer starting at @idx. The memory blocks will
1032  * be merged into one large #GstMemory.
1033  *
1034  * If @length is -1, all memory starting from @idx is merged.
1035  *
1036  * Returns: (transfer full): a #GstMemory that contains the merged data of @length
1037  *    blocks starting at @idx. Use gst_memory_unref () after usage.
1038  */
1039 GstMemory *
1040 gst_buffer_get_memory_range (GstBuffer * buffer, guint idx, gint length)
1041 {
1042   guint len;
1043
1044   GST_CAT_DEBUG (GST_CAT_BUFFER, "idx %u, length %d", idx, length);
1045
1046   g_return_val_if_fail (GST_IS_BUFFER (buffer), NULL);
1047   len = GST_BUFFER_MEM_LEN (buffer);
1048   g_return_val_if_fail ((len == 0 && idx == 0 && length == -1) ||
1049       (length == -1 && idx < len) || (length > 0 && length + idx <= len), NULL);
1050
1051   if (length == -1)
1052     length = len - idx;
1053
1054   return _get_merged_memory (buffer, idx, length);
1055 }
1056
1057 /**
1058  * gst_buffer_replace_memory:
1059  * @buffer: a #GstBuffer.
1060  * @idx: an index
1061  * @mem: (transfer full): a #GstMemory
1062  *
1063  * Replaces the memory block at index @idx in @buffer with @mem.
1064  */
1065 void
1066 gst_buffer_replace_memory (GstBuffer * buffer, guint idx, GstMemory * mem)
1067 {
1068   gst_buffer_replace_memory_range (buffer, idx, 1, mem);
1069 }
1070
1071 /**
1072  * gst_buffer_replace_all_memory:
1073  * @buffer: a #GstBuffer.
1074  * @mem: (transfer full): a #GstMemory
1075  *
1076  * Replaces all memory in @buffer with @mem.
1077  */
1078 void
1079 gst_buffer_replace_all_memory (GstBuffer * buffer, GstMemory * mem)
1080 {
1081   gst_buffer_replace_memory_range (buffer, 0, -1, mem);
1082 }
1083
1084 /**
1085  * gst_buffer_replace_memory_range:
1086  * @buffer: a #GstBuffer.
1087  * @idx: an index
1088  * @length: a length should not be 0
1089  * @mem: (transfer full): a #GstMemory
1090  *
1091  * Replaces @length memory blocks in @buffer starting at @idx with @mem.
1092  *
1093  * If @length is -1, all memory starting from @idx will be removed and
1094  * replaced with @mem.
1095  *
1096  * @buffer should be writable.
1097  */
1098 void
1099 gst_buffer_replace_memory_range (GstBuffer * buffer, guint idx, gint length,
1100     GstMemory * mem)
1101 {
1102   guint len;
1103
1104   g_return_if_fail (GST_IS_BUFFER (buffer));
1105   g_return_if_fail (gst_buffer_is_writable (buffer));
1106
1107   GST_CAT_DEBUG (GST_CAT_BUFFER, "idx %u, length %d, %p", idx, length, mem);
1108
1109   len = GST_BUFFER_MEM_LEN (buffer);
1110   g_return_if_fail ((len == 0 && idx == 0 && length == -1) ||
1111       (length == -1 && idx < len) || (length > 0 && length + idx <= len));
1112
1113   if (length == -1)
1114     length = len - idx;
1115
1116   _replace_memory (buffer, len, idx, length, mem);
1117 }
1118
1119 /**
1120  * gst_buffer_remove_memory:
1121  * @buffer: a #GstBuffer.
1122  * @idx: an index
1123  *
1124  * Remove the memory block in @b at index @i.
1125  */
1126 void
1127 gst_buffer_remove_memory (GstBuffer * buffer, guint idx)
1128 {
1129   gst_buffer_remove_memory_range (buffer, idx, 1);
1130 }
1131
1132 /**
1133  * gst_buffer_remove_all_memory:
1134  * @buffer: a #GstBuffer.
1135  *
1136  * Remove all the memory blocks in @buffer.
1137  */
1138 void
1139 gst_buffer_remove_all_memory (GstBuffer * buffer)
1140 {
1141   gst_buffer_remove_memory_range (buffer, 0, -1);
1142 }
1143
1144 /**
1145  * gst_buffer_remove_memory_range:
1146  * @buffer: a #GstBuffer.
1147  * @idx: an index
1148  * @length: a length
1149  *
1150  * Remove @length memory blocks in @buffer starting from @idx.
1151  *
1152  * @length can be -1, in which case all memory starting from @idx is removed.
1153  */
1154 void
1155 gst_buffer_remove_memory_range (GstBuffer * buffer, guint idx, gint length)
1156 {
1157   guint len;
1158
1159   g_return_if_fail (GST_IS_BUFFER (buffer));
1160   g_return_if_fail (gst_buffer_is_writable (buffer));
1161
1162   GST_CAT_DEBUG (GST_CAT_BUFFER, "idx %u, length %d", idx, length);
1163
1164   len = GST_BUFFER_MEM_LEN (buffer);
1165   g_return_if_fail ((len == 0 && idx == 0 && length == -1) ||
1166       (length == -1 && idx < len) || length + idx <= len);
1167
1168   if (length == -1)
1169     length = len - idx;
1170
1171   _replace_memory (buffer, len, idx, length, NULL);
1172 }
1173
1174 /**
1175  * gst_buffer_find_memory:
1176  * @buffer: a #GstBuffer.
1177  * @offset: an offset
1178  * @size: a size
1179  * @idx: (out): pointer to index
1180  * @length: (out): pointer to length
1181  * @skip: (out): pointer to skip
1182  *
1183  * Find the memory blocks that span @size bytes starting from @offset
1184  * in @buffer.
1185  *
1186  * When this function returns %TRUE, @idx will contain the index of the first
1187  * memory block where the byte for @offset can be found and @length contains the
1188  * number of memory blocks containing the @size remaining bytes. @skip contains
1189  * the number of bytes to skip in the memory block at @idx to get to the byte
1190  * for @offset.
1191  *
1192  * @size can be -1 to get all the memory blocks after @idx.
1193  *
1194  * Returns: %TRUE when @size bytes starting from @offset could be found in
1195  * @buffer and @idx, @length and @skip will be filled.
1196  */
1197 gboolean
1198 gst_buffer_find_memory (GstBuffer * buffer, gsize offset, gsize size,
1199     guint * idx, guint * length, gsize * skip)
1200 {
1201   guint i, len, found;
1202
1203   g_return_val_if_fail (GST_IS_BUFFER (buffer), FALSE);
1204   g_return_val_if_fail (idx != NULL, FALSE);
1205   g_return_val_if_fail (length != NULL, FALSE);
1206   g_return_val_if_fail (skip != NULL, FALSE);
1207
1208   len = GST_BUFFER_MEM_LEN (buffer);
1209
1210   found = 0;
1211   for (i = 0; i < len; i++) {
1212     GstMemory *mem;
1213     gsize s;
1214
1215     mem = GST_BUFFER_MEM_PTR (buffer, i);
1216     s = gst_memory_get_sizes (mem, NULL, NULL);
1217
1218     if (s <= offset) {
1219       /* block before offset, or empty block, skip */
1220       offset -= s;
1221     } else {
1222       /* block after offset */
1223       if (found == 0) {
1224         /* first block, remember index and offset */
1225         *idx = i;
1226         *skip = offset;
1227         if (size == -1) {
1228           /* return remaining blocks */
1229           *length = len - i;
1230           return TRUE;
1231         }
1232         s -= offset;
1233         offset = 0;
1234       }
1235       /* count the amount of found bytes */
1236       found += s;
1237       if (found >= size) {
1238         /* we have enough bytes */
1239         *length = i - *idx + 1;
1240         return TRUE;
1241       }
1242     }
1243   }
1244   return FALSE;
1245 }
1246
1247 /**
1248  * gst_buffer_is_memory_range_writable:
1249  * @buffer: a #GstBuffer.
1250  * @idx: an index
1251  * @length: a length should not be 0
1252  *
1253  * Check if @length memory blocks in @buffer starting from @idx are writable.
1254  *
1255  * @length can be -1 to check all the memory blocks after @idx.
1256  *
1257  * Note that this function does not check if @buffer is writable, use
1258  * gst_buffer_is_writable() to check that if needed.
1259  *
1260  * Returns: %TRUE if the memory range is writable
1261  *
1262  * Since: 1.4
1263  */
1264 gboolean
1265 gst_buffer_is_memory_range_writable (GstBuffer * buffer, guint idx, gint length)
1266 {
1267   guint i, len;
1268
1269   g_return_val_if_fail (GST_IS_BUFFER (buffer), FALSE);
1270
1271   GST_CAT_DEBUG (GST_CAT_BUFFER, "idx %u, length %d", idx, length);
1272
1273   len = GST_BUFFER_MEM_LEN (buffer);
1274   g_return_val_if_fail ((len == 0 && idx == 0 && length == -1) ||
1275       (length == -1 && idx < len) || (length > 0 && length + idx <= len),
1276       FALSE);
1277
1278   if (length == -1)
1279     len -= idx;
1280   else
1281     len = length;
1282
1283   for (i = 0; i < len; i++) {
1284     if (!gst_memory_is_writable (GST_BUFFER_MEM_PTR (buffer, i + idx)))
1285       return FALSE;
1286   }
1287   return TRUE;
1288 }
1289
1290 /**
1291  * gst_buffer_is_all_memory_writable:
1292  * @buffer: a #GstBuffer.
1293  *
1294  * Check if all memory blocks in @buffer are writable.
1295  *
1296  * Note that this function does not check if @buffer is writable, use
1297  * gst_buffer_is_writable() to check that if needed.
1298  *
1299  * Returns: %TRUE if all memory blocks in @buffer are writable
1300  *
1301  * Since: 1.4
1302  */
1303 gboolean
1304 gst_buffer_is_all_memory_writable (GstBuffer * buffer)
1305 {
1306   return gst_buffer_is_memory_range_writable (buffer, 0, -1);
1307 }
1308
1309 /**
1310  * gst_buffer_get_sizes:
1311  * @buffer: a #GstBuffer.
1312  * @offset: (out) (allow-none): a pointer to the offset
1313  * @maxsize: (out) (allow-none): a pointer to the maxsize
1314  *
1315  * Get the total size of the memory blocks in @b.
1316  *
1317  * When not %NULL, @offset will contain the offset of the data in the
1318  * first memory block in @buffer and @maxsize will contain the sum of
1319  * the size and @offset and the amount of extra padding on the last
1320  * memory block.  @offset and @maxsize can be used to resize the
1321  * buffer memory blocks with gst_buffer_resize().
1322  *
1323  * Returns: total size of the memory blocks in @buffer.
1324  */
1325 gsize
1326 gst_buffer_get_sizes (GstBuffer * buffer, gsize * offset, gsize * maxsize)
1327 {
1328   return gst_buffer_get_sizes_range (buffer, 0, -1, offset, maxsize);
1329 }
1330
1331 /**
1332  * gst_buffer_get_size:
1333  * @buffer: a #GstBuffer.
1334  *
1335  * Get the total size of the memory blocks in @buffer.
1336  *
1337  * Returns: total size of the memory blocks in @buffer.
1338  */
1339 gsize
1340 gst_buffer_get_size (GstBuffer * buffer)
1341 {
1342   return gst_buffer_get_sizes_range (buffer, 0, -1, NULL, NULL);
1343 }
1344
1345 /**
1346  * gst_buffer_get_sizes_range:
1347  * @buffer: a #GstBuffer.
1348  * @idx: an index
1349  * @length: a length
1350  * @offset: (out) (allow-none): a pointer to the offset
1351  * @maxsize: (out) (allow-none): a pointer to the maxsize
1352  *
1353  * Get the total size of @length memory blocks stating from @idx in @buffer.
1354  *
1355  * When not %NULL, @offset will contain the offset of the data in the
1356  * memory block in @buffer at @idx and @maxsize will contain the sum of the size
1357  * and @offset and the amount of extra padding on the memory block at @idx +
1358  * @length -1.
1359  * @offset and @maxsize can be used to resize the buffer memory blocks with
1360  * gst_buffer_resize_range().
1361  *
1362  * Returns: total size of @length memory blocks starting at @idx in @buffer.
1363  */
1364 gsize
1365 gst_buffer_get_sizes_range (GstBuffer * buffer, guint idx, gint length,
1366     gsize * offset, gsize * maxsize)
1367 {
1368   guint len;
1369   gsize size;
1370   GstMemory *mem;
1371
1372   g_return_val_if_fail (GST_IS_BUFFER (buffer), 0);
1373   len = GST_BUFFER_MEM_LEN (buffer);
1374   g_return_val_if_fail ((len == 0 && idx == 0 && length == -1) ||
1375       (length == -1 && idx < len) || (length + idx <= len), 0);
1376
1377   if (length == -1)
1378     length = len - idx;
1379
1380   if (G_LIKELY (length == 1)) {
1381     /* common case */
1382     mem = GST_BUFFER_MEM_PTR (buffer, idx);
1383     size = gst_memory_get_sizes (mem, offset, maxsize);
1384   } else {
1385     guint i, end;
1386     gsize extra, offs;
1387
1388     end = idx + length;
1389     size = offs = extra = 0;
1390     for (i = idx; i < end; i++) {
1391       gsize s, o, ms;
1392
1393       mem = GST_BUFFER_MEM_PTR (buffer, i);
1394       s = gst_memory_get_sizes (mem, &o, &ms);
1395
1396       if (s) {
1397         if (size == 0)
1398           /* first size, take accumulated data before as the offset */
1399           offs = extra + o;
1400         /* add sizes */
1401         size += s;
1402         /* save the amount of data after this block */
1403         extra = ms - (o + s);
1404       } else {
1405         /* empty block, add as extra */
1406         extra += ms;
1407       }
1408     }
1409     if (offset)
1410       *offset = offs;
1411     if (maxsize)
1412       *maxsize = offs + size + extra;
1413   }
1414   return size;
1415 }
1416
1417 /**
1418  * gst_buffer_resize:
1419  * @buffer: a #GstBuffer.
1420  * @offset: the offset adjustment
1421  * @size: the new size or -1 to just adjust the offset
1422  *
1423  * Set the offset and total size of the memory blocks in @buffer.
1424  */
1425 void
1426 gst_buffer_resize (GstBuffer * buffer, gssize offset, gssize size)
1427 {
1428   gst_buffer_resize_range (buffer, 0, -1, offset, size);
1429 }
1430
1431 /**
1432  * gst_buffer_set_size:
1433  * @buffer: a #GstBuffer.
1434  * @size: the new size
1435  *
1436  * Set the total size of the memory blocks in @buffer.
1437  */
1438 void
1439 gst_buffer_set_size (GstBuffer * buffer, gssize size)
1440 {
1441   gst_buffer_resize_range (buffer, 0, -1, 0, size);
1442 }
1443
1444 /**
1445  * gst_buffer_resize_range:
1446  * @buffer: a #GstBuffer.
1447  * @idx: an index
1448  * @length: a length
1449  * @offset: the offset adjustment
1450  * @size: the new size or -1 to just adjust the offset
1451  *
1452  * Set the total size of the @length memory blocks starting at @idx in
1453  * @buffer
1454  *
1455  * Returns: %TRUE if resizing succeeded, %FALSE otherwise.
1456  */
1457 gboolean
1458 gst_buffer_resize_range (GstBuffer * buffer, guint idx, gint length,
1459     gssize offset, gssize size)
1460 {
1461   guint i, len, end;
1462   gsize bsize, bufsize, bufoffs, bufmax;
1463
1464   g_return_val_if_fail (gst_buffer_is_writable (buffer), FALSE);
1465   g_return_val_if_fail (size >= -1, FALSE);
1466
1467   len = GST_BUFFER_MEM_LEN (buffer);
1468   g_return_val_if_fail ((len == 0 && idx == 0 && length == -1) ||
1469       (length == -1 && idx < len) || (length + idx <= len), FALSE);
1470
1471   if (length == -1)
1472     length = len - idx;
1473
1474   bufsize = gst_buffer_get_sizes_range (buffer, idx, length, &bufoffs, &bufmax);
1475
1476   GST_CAT_LOG (GST_CAT_BUFFER, "trim %p %" G_GSSIZE_FORMAT "-%" G_GSSIZE_FORMAT
1477       " size:%" G_GSIZE_FORMAT " offs:%" G_GSIZE_FORMAT " max:%"
1478       G_GSIZE_FORMAT, buffer, offset, size, bufsize, bufoffs, bufmax);
1479
1480   /* we can't go back further than the current offset or past the end of the
1481    * buffer */
1482   g_return_val_if_fail ((offset < 0 && bufoffs >= -offset) || (offset >= 0
1483           && bufoffs + offset <= bufmax), FALSE);
1484   if (size == -1) {
1485     g_return_val_if_fail (bufsize >= offset, FALSE);
1486     size = bufsize - offset;
1487   }
1488   g_return_val_if_fail (bufmax >= bufoffs + offset + size, FALSE);
1489
1490   /* no change */
1491   if (offset == 0 && size == bufsize)
1492     return TRUE;
1493
1494   end = idx + length;
1495   /* copy and trim */
1496   for (i = idx; i < end; i++) {
1497     GstMemory *mem;
1498     gsize left, noffs;
1499
1500     mem = GST_BUFFER_MEM_PTR (buffer, i);
1501     bsize = gst_memory_get_sizes (mem, NULL, NULL);
1502
1503     noffs = 0;
1504     /* last buffer always gets resized to the remaining size */
1505     if (i + 1 == end)
1506       left = size;
1507     /* shrink buffers before the offset */
1508     else if ((gssize) bsize <= offset) {
1509       left = 0;
1510       noffs = offset - bsize;
1511       offset = 0;
1512     }
1513     /* clip other buffers */
1514     else
1515       left = MIN (bsize - offset, size);
1516
1517     if (offset != 0 || left != bsize) {
1518       if (gst_memory_is_writable (mem)) {
1519         gst_memory_resize (mem, offset, left);
1520       } else {
1521         GstMemory *newmem = NULL;
1522
1523         if (!GST_MEMORY_IS_NO_SHARE (mem))
1524           newmem = gst_memory_share (mem, offset, left);
1525
1526         if (!newmem)
1527           newmem = gst_memory_copy (mem, offset, left);
1528
1529         if (newmem == NULL)
1530           return FALSE;
1531
1532         gst_memory_lock (newmem, GST_LOCK_FLAG_EXCLUSIVE);
1533         GST_BUFFER_MEM_PTR (buffer, i) = newmem;
1534         gst_memory_unlock (mem, GST_LOCK_FLAG_EXCLUSIVE);
1535         gst_memory_unref (mem);
1536
1537         GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY);
1538       }
1539     }
1540
1541     offset = noffs;
1542     size -= left;
1543   }
1544
1545   return TRUE;
1546 }
1547
1548 /**
1549  * gst_buffer_map:
1550  * @buffer: a #GstBuffer.
1551  * @info: (out): info about the mapping
1552  * @flags: flags for the mapping
1553  *
1554  * This function fills @info with the #GstMapInfo of all merged memory
1555  * blocks in @buffer.
1556  *
1557  * @flags describe the desired access of the memory. When @flags is
1558  * #GST_MAP_WRITE, @buffer should be writable (as returned from
1559  * gst_buffer_is_writable()).
1560  *
1561  * When @buffer is writable but the memory isn't, a writable copy will
1562  * automatically be created and returned. The readonly copy of the
1563  * buffer memory will then also be replaced with this writable copy.
1564  *
1565  * The memory in @info should be unmapped with gst_buffer_unmap() after
1566  * usage.
1567  *
1568  * Returns: %TRUE if the map succeeded and @info contains valid data.
1569  */
1570 gboolean
1571 gst_buffer_map (GstBuffer * buffer, GstMapInfo * info, GstMapFlags flags)
1572 {
1573   return gst_buffer_map_range (buffer, 0, -1, info, flags);
1574 }
1575
1576 /**
1577  * gst_buffer_map_range:
1578  * @buffer: a #GstBuffer.
1579  * @idx: an index
1580  * @length: a length
1581  * @info: (out): info about the mapping
1582  * @flags: flags for the mapping
1583  *
1584  * This function fills @info with the #GstMapInfo of @length merged memory blocks
1585  * starting at @idx in @buffer. When @length is -1, all memory blocks starting
1586  * from @idx are merged and mapped.
1587  *
1588  * @flags describe the desired access of the memory. When @flags is
1589  * #GST_MAP_WRITE, @buffer should be writable (as returned from
1590  * gst_buffer_is_writable()).
1591  *
1592  * When @buffer is writable but the memory isn't, a writable copy will
1593  * automatically be created and returned. The readonly copy of the buffer memory
1594  * will then also be replaced with this writable copy.
1595  *
1596  * The memory in @info should be unmapped with gst_buffer_unmap() after usage.
1597  *
1598  * Returns: %TRUE if the map succeeded and @info contains valid
1599  * data.
1600  */
1601 gboolean
1602 gst_buffer_map_range (GstBuffer * buffer, guint idx, gint length,
1603     GstMapInfo * info, GstMapFlags flags)
1604 {
1605   GstMemory *mem, *nmem;
1606   gboolean write, writable;
1607   gsize len;
1608
1609   g_return_val_if_fail (GST_IS_BUFFER (buffer), FALSE);
1610   g_return_val_if_fail (info != NULL, FALSE);
1611   len = GST_BUFFER_MEM_LEN (buffer);
1612   g_return_val_if_fail ((len == 0 && idx == 0 && length == -1) ||
1613       (length == -1 && idx < len) || (length > 0
1614           && length + idx <= len), FALSE);
1615
1616   GST_CAT_LOG (GST_CAT_BUFFER, "buffer %p, idx %u, length %d, flags %04x",
1617       buffer, idx, length, flags);
1618
1619   write = (flags & GST_MAP_WRITE) != 0;
1620   writable = gst_buffer_is_writable (buffer);
1621
1622   /* check if we can write when asked for write access */
1623   if (G_UNLIKELY (write && !writable))
1624     goto not_writable;
1625
1626   if (length == -1)
1627     length = len - idx;
1628
1629   mem = _get_merged_memory (buffer, idx, length);
1630   if (G_UNLIKELY (mem == NULL))
1631     goto no_memory;
1632
1633   /* now try to map */
1634   nmem = gst_memory_make_mapped (mem, info, flags);
1635   if (G_UNLIKELY (nmem == NULL))
1636     goto cannot_map;
1637
1638   /* if we merged or when the map returned a different memory, we try to replace
1639    * the memory in the buffer */
1640   if (G_UNLIKELY (length > 1 || nmem != mem)) {
1641     /* if the buffer is writable, replace the memory */
1642     if (writable) {
1643       _replace_memory (buffer, len, idx, length, gst_memory_ref (nmem));
1644     } else {
1645       if (len > 1) {
1646         GST_CAT_DEBUG (GST_CAT_PERFORMANCE,
1647             "temporary mapping for memory %p in buffer %p", nmem, buffer);
1648       }
1649     }
1650   }
1651   return TRUE;
1652
1653   /* ERROR */
1654 not_writable:
1655   {
1656     GST_WARNING_OBJECT (buffer, "write map requested on non-writable buffer");
1657     g_critical ("write map requested on non-writable buffer");
1658     memset (info, 0, sizeof (GstMapInfo));
1659     return FALSE;
1660   }
1661 no_memory:
1662   {
1663     /* empty buffer, we need to return NULL */
1664     GST_DEBUG_OBJECT (buffer, "can't get buffer memory");
1665     memset (info, 0, sizeof (GstMapInfo));
1666     return TRUE;
1667   }
1668 cannot_map:
1669   {
1670     GST_DEBUG_OBJECT (buffer, "cannot map memory");
1671     memset (info, 0, sizeof (GstMapInfo));
1672     return FALSE;
1673   }
1674 }
1675
1676 /**
1677  * gst_buffer_unmap:
1678  * @buffer: a #GstBuffer.
1679  * @info: a #GstMapInfo
1680  *
1681  * Release the memory previously mapped with gst_buffer_map().
1682  */
1683 void
1684 gst_buffer_unmap (GstBuffer * buffer, GstMapInfo * info)
1685 {
1686   g_return_if_fail (GST_IS_BUFFER (buffer));
1687   g_return_if_fail (info != NULL);
1688
1689   /* we need to check for NULL, it is possible that we tried to map a buffer
1690    * without memory and we should be able to unmap that fine */
1691   if (G_LIKELY (info->memory)) {
1692     gst_memory_unmap (info->memory, info);
1693     gst_memory_unref (info->memory);
1694   }
1695 }
1696
1697 /**
1698  * gst_buffer_fill:
1699  * @buffer: a #GstBuffer.
1700  * @offset: the offset to fill
1701  * @src: (array length=size) (element-type guint8): the source address
1702  * @size: the size to fill
1703  *
1704  * Copy @size bytes from @src to @buffer at @offset.
1705  *
1706  * Returns: The amount of bytes copied. This value can be lower than @size
1707  *    when @buffer did not contain enough data.
1708  */
1709 gsize
1710 gst_buffer_fill (GstBuffer * buffer, gsize offset, gconstpointer src,
1711     gsize size)
1712 {
1713   gsize i, len, left;
1714   const guint8 *ptr = src;
1715
1716   g_return_val_if_fail (GST_IS_BUFFER (buffer), 0);
1717   g_return_val_if_fail (gst_buffer_is_writable (buffer), 0);
1718   g_return_val_if_fail (src != NULL || size == 0, 0);
1719
1720   GST_CAT_LOG (GST_CAT_BUFFER,
1721       "buffer %p, offset %" G_GSIZE_FORMAT ", size %" G_GSIZE_FORMAT, buffer,
1722       offset, size);
1723
1724   len = GST_BUFFER_MEM_LEN (buffer);
1725   left = size;
1726
1727   for (i = 0; i < len && left > 0; i++) {
1728     GstMapInfo info;
1729     gsize tocopy;
1730     GstMemory *mem;
1731
1732     mem = _get_mapped (buffer, i, &info, GST_MAP_WRITE);
1733     if (info.size > offset) {
1734       /* we have enough */
1735       tocopy = MIN (info.size - offset, left);
1736       memcpy ((guint8 *) info.data + offset, ptr, tocopy);
1737       left -= tocopy;
1738       ptr += tocopy;
1739       offset = 0;
1740     } else {
1741       /* offset past buffer, skip */
1742       offset -= info.size;
1743     }
1744     gst_memory_unmap (mem, &info);
1745   }
1746   return size - left;
1747 }
1748
1749 /**
1750  * gst_buffer_extract:
1751  * @buffer: a #GstBuffer.
1752  * @offset: the offset to extract
1753  * @dest: the destination address
1754  * @size: the size to extract
1755  *
1756  * Copy @size bytes starting from @offset in @buffer to @dest.
1757  *
1758  * Returns: The amount of bytes extracted. This value can be lower than @size
1759  *    when @buffer did not contain enough data.
1760  */
1761 gsize
1762 gst_buffer_extract (GstBuffer * buffer, gsize offset, gpointer dest, gsize size)
1763 {
1764   gsize i, len, left;
1765   guint8 *ptr = dest;
1766
1767   g_return_val_if_fail (GST_IS_BUFFER (buffer), 0);
1768   g_return_val_if_fail (dest != NULL, 0);
1769
1770   GST_CAT_LOG (GST_CAT_BUFFER,
1771       "buffer %p, offset %" G_GSIZE_FORMAT ", size %" G_GSIZE_FORMAT, buffer,
1772       offset, size);
1773
1774   len = GST_BUFFER_MEM_LEN (buffer);
1775   left = size;
1776
1777   for (i = 0; i < len && left > 0; i++) {
1778     GstMapInfo info;
1779     gsize tocopy;
1780     GstMemory *mem;
1781
1782     mem = _get_mapped (buffer, i, &info, GST_MAP_READ);
1783     if (info.size > offset) {
1784       /* we have enough */
1785       tocopy = MIN (info.size - offset, left);
1786       memcpy (ptr, (guint8 *) info.data + offset, tocopy);
1787       left -= tocopy;
1788       ptr += tocopy;
1789       offset = 0;
1790     } else {
1791       /* offset past buffer, skip */
1792       offset -= info.size;
1793     }
1794     gst_memory_unmap (mem, &info);
1795   }
1796   return size - left;
1797 }
1798
1799 /**
1800  * gst_buffer_memcmp:
1801  * @buffer: a #GstBuffer.
1802  * @offset: the offset in @buffer
1803  * @mem: (array length=size) (element-type guint8): the memory to compare
1804  * @size: the size to compare
1805  *
1806  * Compare @size bytes starting from @offset in @buffer with the memory in @mem.
1807  *
1808  * Returns: 0 if the memory is equal.
1809  */
1810 gint
1811 gst_buffer_memcmp (GstBuffer * buffer, gsize offset, gconstpointer mem,
1812     gsize size)
1813 {
1814   gsize i, len;
1815   const guint8 *ptr = mem;
1816   gint res = 0;
1817
1818   g_return_val_if_fail (GST_IS_BUFFER (buffer), 0);
1819   g_return_val_if_fail (mem != NULL, 0);
1820
1821   GST_CAT_LOG (GST_CAT_BUFFER,
1822       "buffer %p, offset %" G_GSIZE_FORMAT ", size %" G_GSIZE_FORMAT, buffer,
1823       offset, size);
1824
1825   if (G_UNLIKELY (gst_buffer_get_size (buffer) < offset + size))
1826     return -1;
1827
1828   len = GST_BUFFER_MEM_LEN (buffer);
1829
1830   for (i = 0; i < len && size > 0 && res == 0; i++) {
1831     GstMapInfo info;
1832     gsize tocmp;
1833     GstMemory *mem;
1834
1835     mem = _get_mapped (buffer, i, &info, GST_MAP_READ);
1836     if (info.size > offset) {
1837       /* we have enough */
1838       tocmp = MIN (info.size - offset, size);
1839       res = memcmp (ptr, (guint8 *) info.data + offset, tocmp);
1840       size -= tocmp;
1841       ptr += tocmp;
1842       offset = 0;
1843     } else {
1844       /* offset past buffer, skip */
1845       offset -= info.size;
1846     }
1847     gst_memory_unmap (mem, &info);
1848   }
1849   return res;
1850 }
1851
1852 /**
1853  * gst_buffer_memset:
1854  * @buffer: a #GstBuffer.
1855  * @offset: the offset in @buffer
1856  * @val: the value to set
1857  * @size: the size to set
1858  *
1859  * Fill @buf with @size bytes with @val starting from @offset.
1860  *
1861  * Returns: The amount of bytes filled. This value can be lower than @size
1862  *    when @buffer did not contain enough data.
1863  */
1864 gsize
1865 gst_buffer_memset (GstBuffer * buffer, gsize offset, guint8 val, gsize size)
1866 {
1867   gsize i, len, left;
1868
1869   g_return_val_if_fail (GST_IS_BUFFER (buffer), 0);
1870   g_return_val_if_fail (gst_buffer_is_writable (buffer), 0);
1871
1872   GST_CAT_LOG (GST_CAT_BUFFER,
1873       "buffer %p, offset %" G_GSIZE_FORMAT ", val %02x, size %" G_GSIZE_FORMAT,
1874       buffer, offset, val, size);
1875
1876   len = GST_BUFFER_MEM_LEN (buffer);
1877   left = size;
1878
1879   for (i = 0; i < len && left > 0; i++) {
1880     GstMapInfo info;
1881     gsize toset;
1882     GstMemory *mem;
1883
1884     mem = _get_mapped (buffer, i, &info, GST_MAP_WRITE);
1885     if (info.size > offset) {
1886       /* we have enough */
1887       toset = MIN (info.size - offset, left);
1888       memset ((guint8 *) info.data + offset, val, toset);
1889       left -= toset;
1890       offset = 0;
1891     } else {
1892       /* offset past buffer, skip */
1893       offset -= info.size;
1894     }
1895     gst_memory_unmap (mem, &info);
1896   }
1897   return size - left;
1898 }
1899
1900 /**
1901  * gst_buffer_copy_region:
1902  * @parent: a #GstBuffer.
1903  * @flags: the #GstBufferCopyFlags
1904  * @offset: the offset into parent #GstBuffer at which the new sub-buffer 
1905  *          begins.
1906  * @size: the size of the new #GstBuffer sub-buffer, in bytes. If -1, all
1907  *        data is copied.
1908  *
1909  * Creates a sub-buffer from @parent at @offset and @size.
1910  * This sub-buffer uses the actual memory space of the parent buffer.
1911  * This function will copy the offset and timestamp fields when the
1912  * offset is 0. If not, they will be set to #GST_CLOCK_TIME_NONE and 
1913  * #GST_BUFFER_OFFSET_NONE.
1914  * If @offset equals 0 and @size equals the total size of @buffer, the
1915  * duration and offset end fields are also copied. If not they will be set
1916  * to #GST_CLOCK_TIME_NONE and #GST_BUFFER_OFFSET_NONE.
1917  *
1918  * MT safe.
1919  *
1920  * Returns: (transfer full): the new #GstBuffer or %NULL if the arguments were
1921  *     invalid.
1922  */
1923 GstBuffer *
1924 gst_buffer_copy_region (GstBuffer * buffer, GstBufferCopyFlags flags,
1925     gsize offset, gsize size)
1926 {
1927   GstBuffer *copy;
1928
1929   g_return_val_if_fail (buffer != NULL, NULL);
1930
1931   /* create the new buffer */
1932   copy = gst_buffer_new ();
1933
1934   GST_CAT_LOG (GST_CAT_BUFFER, "new region copy %p of %p %" G_GSIZE_FORMAT
1935       "-%" G_GSIZE_FORMAT, copy, buffer, offset, size);
1936
1937   if (!gst_buffer_copy_into (copy, buffer, flags, offset, size))
1938     gst_buffer_replace (&copy, NULL);
1939
1940   return copy;
1941 }
1942
1943 /**
1944  * gst_buffer_append:
1945  * @buf1: (transfer full): the first source #GstBuffer to append.
1946  * @buf2: (transfer full): the second source #GstBuffer to append.
1947  *
1948  * Append all the memory from @buf2 to @buf1. The result buffer will contain a
1949  * concatenation of the memory of @buf1 and @buf2.
1950  *
1951  * Returns: (transfer full): the new #GstBuffer that contains the memory
1952  *     of the two source buffers.
1953  */
1954 GstBuffer *
1955 gst_buffer_append (GstBuffer * buf1, GstBuffer * buf2)
1956 {
1957   return gst_buffer_append_region (buf1, buf2, 0, -1);
1958 }
1959
1960 /**
1961  * gst_buffer_append_region:
1962  * @buf1: (transfer full): the first source #GstBuffer to append.
1963  * @buf2: (transfer full): the second source #GstBuffer to append.
1964  * @offset: the offset in @buf2
1965  * @size: the size or -1 of @buf2
1966  *
1967  * Append @size bytes at @offset from @buf2 to @buf1. The result buffer will
1968  * contain a concatenation of the memory of @buf1 and the requested region of
1969  * @buf2.
1970  *
1971  * Returns: (transfer full): the new #GstBuffer that contains the memory
1972  *     of the two source buffers.
1973  */
1974 GstBuffer *
1975 gst_buffer_append_region (GstBuffer * buf1, GstBuffer * buf2, gssize offset,
1976     gssize size)
1977 {
1978   gsize i, len;
1979
1980   g_return_val_if_fail (GST_IS_BUFFER (buf1), NULL);
1981   g_return_val_if_fail (GST_IS_BUFFER (buf2), NULL);
1982
1983   buf1 = gst_buffer_make_writable (buf1);
1984   buf2 = gst_buffer_make_writable (buf2);
1985
1986   gst_buffer_resize (buf2, offset, size);
1987
1988   len = GST_BUFFER_MEM_LEN (buf2);
1989   for (i = 0; i < len; i++) {
1990     GstMemory *mem;
1991
1992     mem = GST_BUFFER_MEM_PTR (buf2, i);
1993     GST_BUFFER_MEM_PTR (buf2, i) = NULL;
1994     _memory_add (buf1, -1, mem);
1995   }
1996
1997   GST_BUFFER_MEM_LEN (buf2) = 0;
1998   GST_BUFFER_FLAG_SET (buf2, GST_BUFFER_FLAG_TAG_MEMORY);
1999   gst_buffer_unref (buf2);
2000
2001   return buf1;
2002 }
2003
2004 /**
2005  * gst_buffer_get_meta:
2006  * @buffer: a #GstBuffer
2007  * @api: the #GType of an API
2008  *
2009  * Get the metadata for @api on buffer. When there is no such metadata, %NULL is
2010  * returned. If multiple metadata with the given @api are attached to this
2011  * buffer only the first one is returned.  To handle multiple metadata with a
2012  * given API use gst_buffer_iterate_meta() or gst_buffer_foreach_meta() instead
2013  * and check the meta->info.api member for the API type.
2014  *
2015  * Returns: (transfer none) (nullable): the metadata for @api on
2016  * @buffer.
2017  */
2018 GstMeta *
2019 gst_buffer_get_meta (GstBuffer * buffer, GType api)
2020 {
2021   GstMetaItem *item;
2022   GstMeta *result = NULL;
2023
2024   g_return_val_if_fail (buffer != NULL, NULL);
2025   g_return_val_if_fail (api != 0, NULL);
2026
2027   /* find GstMeta of the requested API */
2028   for (item = GST_BUFFER_META (buffer); item; item = item->next) {
2029     GstMeta *meta = &item->meta;
2030     if (meta->info->api == api) {
2031       result = meta;
2032       break;
2033     }
2034   }
2035   return result;
2036 }
2037
2038 /**
2039  * gst_buffer_add_meta:
2040  * @buffer: a #GstBuffer
2041  * @info: a #GstMetaInfo
2042  * @params: params for @info
2043  *
2044  * Add metadata for @info to @buffer using the parameters in @params.
2045  *
2046  * Returns: (transfer none): the metadata for the api in @info on @buffer.
2047  */
2048 GstMeta *
2049 gst_buffer_add_meta (GstBuffer * buffer, const GstMetaInfo * info,
2050     gpointer params)
2051 {
2052   GstMetaItem *item;
2053   GstMeta *result = NULL;
2054   gsize size;
2055
2056   g_return_val_if_fail (buffer != NULL, NULL);
2057   g_return_val_if_fail (info != NULL, NULL);
2058   g_return_val_if_fail (gst_buffer_is_writable (buffer), NULL);
2059
2060   /* create a new slice */
2061   size = ITEM_SIZE (info);
2062   item = g_slice_alloc (size);
2063   result = &item->meta;
2064   result->info = info;
2065   result->flags = GST_META_FLAG_NONE;
2066
2067   GST_CAT_DEBUG (GST_CAT_BUFFER,
2068       "alloc metadata %p (%s) of size %" G_GSIZE_FORMAT, result,
2069       g_type_name (info->type), info->size);
2070
2071   /* call the init_func when needed */
2072   if (info->init_func)
2073     if (!info->init_func (result, params, buffer))
2074       goto init_failed;
2075
2076   /* and add to the list of metadata */
2077   item->next = GST_BUFFER_META (buffer);
2078   GST_BUFFER_META (buffer) = item;
2079
2080   return result;
2081
2082 init_failed:
2083   {
2084     g_slice_free1 (size, item);
2085     return NULL;
2086   }
2087 }
2088
2089 /**
2090  * gst_buffer_remove_meta:
2091  * @buffer: a #GstBuffer
2092  * @meta: a #GstMeta
2093  *
2094  * Remove the metadata for @meta on @buffer.
2095  *
2096  * Returns: %TRUE if the metadata existed and was removed, %FALSE if no such
2097  * metadata was on @buffer.
2098  */
2099 gboolean
2100 gst_buffer_remove_meta (GstBuffer * buffer, GstMeta * meta)
2101 {
2102   GstMetaItem *walk, *prev;
2103
2104   g_return_val_if_fail (buffer != NULL, FALSE);
2105   g_return_val_if_fail (meta != NULL, FALSE);
2106   g_return_val_if_fail (gst_buffer_is_writable (buffer), FALSE);
2107   g_return_val_if_fail (!GST_META_FLAG_IS_SET (meta, GST_META_FLAG_LOCKED),
2108       FALSE);
2109
2110   /* find the metadata and delete */
2111   prev = GST_BUFFER_META (buffer);
2112   for (walk = prev; walk; walk = walk->next) {
2113     GstMeta *m = &walk->meta;
2114     if (m == meta) {
2115       const GstMetaInfo *info = meta->info;
2116
2117       /* remove from list */
2118       if (GST_BUFFER_META (buffer) == walk)
2119         GST_BUFFER_META (buffer) = walk->next;
2120       else
2121         prev->next = walk->next;
2122       /* call free_func if any */
2123       if (info->free_func)
2124         info->free_func (m, buffer);
2125
2126       /* and free the slice */
2127       g_slice_free1 (ITEM_SIZE (info), walk);
2128       break;
2129     }
2130     prev = walk;
2131   }
2132   return walk != NULL;
2133 }
2134
2135 /**
2136  * gst_buffer_iterate_meta:
2137  * @buffer: a #GstBuffer
2138  * @state: an opaque state pointer
2139  *
2140  * Retrieve the next #GstMeta after @current. If @state points
2141  * to %NULL, the first metadata is returned.
2142  *
2143  * @state will be updated with an opaque state pointer
2144  *
2145  * Returns: (transfer none) (nullable): The next #GstMeta or %NULL
2146  * when there are no more items.
2147  */
2148 GstMeta *
2149 gst_buffer_iterate_meta (GstBuffer * buffer, gpointer * state)
2150 {
2151   GstMetaItem **meta;
2152
2153   g_return_val_if_fail (buffer != NULL, NULL);
2154   g_return_val_if_fail (state != NULL, NULL);
2155
2156   meta = (GstMetaItem **) state;
2157   if (*meta == NULL)
2158     /* state NULL, move to first item */
2159     *meta = GST_BUFFER_META (buffer);
2160   else
2161     /* state !NULL, move to next item in list */
2162     *meta = (*meta)->next;
2163
2164   if (*meta)
2165     return &(*meta)->meta;
2166   else
2167     return NULL;
2168 }
2169
2170 /**
2171  * gst_buffer_foreach_meta:
2172  * @buffer: a #GstBuffer
2173  * @func: (scope call): a #GstBufferForeachMetaFunc to call
2174  * @user_data: (closure): user data passed to @func
2175  *
2176  * Call @func with @user_data for each meta in @buffer.
2177  *
2178  * @func can modify the passed meta pointer or its contents. The return value
2179  * of @func define if this function returns or if the remaining metadata items
2180  * in the buffer should be skipped.
2181  *
2182  * Returns: %FALSE when @func returned %FALSE for one of the metadata.
2183  */
2184 gboolean
2185 gst_buffer_foreach_meta (GstBuffer * buffer, GstBufferForeachMetaFunc func,
2186     gpointer user_data)
2187 {
2188   GstMetaItem *walk, *prev, *next;
2189   gboolean res = TRUE;
2190
2191   g_return_val_if_fail (buffer != NULL, FALSE);
2192   g_return_val_if_fail (func != NULL, FALSE);
2193
2194   /* find the metadata and delete */
2195   prev = GST_BUFFER_META (buffer);
2196   for (walk = prev; walk; walk = next) {
2197     GstMeta *m, *new;
2198
2199     m = new = &walk->meta;
2200     next = walk->next;
2201
2202     res = func (buffer, &new, user_data);
2203
2204     if (new == NULL) {
2205       const GstMetaInfo *info = m->info;
2206
2207       GST_CAT_DEBUG (GST_CAT_BUFFER, "remove metadata %p (%s)", m,
2208           g_type_name (info->type));
2209
2210       g_return_val_if_fail (gst_buffer_is_writable (buffer), FALSE);
2211       g_return_val_if_fail (!GST_META_FLAG_IS_SET (m, GST_META_FLAG_LOCKED),
2212           FALSE);
2213
2214       /* remove from list */
2215       if (GST_BUFFER_META (buffer) == walk)
2216         GST_BUFFER_META (buffer) = next;
2217       else
2218         prev->next = next;
2219
2220       /* call free_func if any */
2221       if (info->free_func)
2222         info->free_func (m, buffer);
2223
2224       /* and free the slice */
2225       g_slice_free1 (ITEM_SIZE (info), walk);
2226     }
2227     if (!res)
2228       break;
2229   }
2230   return res;
2231 }
2232
2233 /**
2234  * gst_buffer_extract_dup:
2235  * @buffer: a #GstBuffer
2236  * @offset: the offset to extract
2237  * @size: the size to extract
2238  * @dest: (array length=dest_size) (element-type guint8) (out): A pointer where
2239  *  the destination array will be written.
2240  * @dest_size: (out): A location where the size of @dest can be written
2241  *
2242  * Extracts a copy of at most @size bytes the data at @offset into a #GBytes.
2243  * @dest must be freed using g_free() when done.
2244  *
2245  * Since: 1.0.10
2246  */
2247
2248 void
2249 gst_buffer_extract_dup (GstBuffer * buffer, gsize offset, gsize size,
2250     gpointer * dest, gsize * dest_size)
2251 {
2252   gsize real_size;
2253
2254   real_size = gst_buffer_get_size (buffer);
2255
2256   *dest = g_malloc (MIN (real_size - offset, size));
2257
2258   *dest_size = gst_buffer_extract (buffer, offset, *dest, size);
2259 }