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