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., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 /**
  24  * SECTION:gstbuffer
  25  * @short_description: Data-passing buffer type, supporting sub-buffers.
  26  * @see_also: #GstPad, #GstMiniObject
  27  *
  28  * Buffers are the basic unit of data transfer in GStreamer.  The #GstBuffer
  29  * type provides all the state necessary to define a region of memory as part
  30  * of a stream.  Sub-buffers are also supported, allowing a smaller region of a
  31  * buffer to become its own buffer, with mechanisms in place to ensure that
  32  * neither memory space goes away prematurely.
  33  *
  34  * Buffers are usually created with gst_buffer_new(). After a buffer has been
  35  * created one will typically allocate memory for it and set the size of the
  36  * buffer data.  The following example creates a buffer that can hold a given
  37  * video frame with a given width, height and bits per plane.
  38  * <example>
  39  * <title>Creating a buffer for a video frame</title>
  40  *   <programlisting>
  41  *   GstBuffer *buffer;
  42  *   gint size, width, height, bpp;
  43  *   ...
  44  *   size = width * height * bpp;
  45  *   buffer = gst_buffer_new ();
  46  *   GST_BUFFER_SIZE (buffer) = size;
  47  *   GST_BUFFER_MALLOCDATA (buffer) = g_malloc (size);
  48  *   GST_BUFFER_DATA (buffer) = GST_BUFFER_MALLOCDATA (buffer);
  49  *   ...
  50  *   </programlisting>
  51  * </example>
  52  *
  53  * Alternatively, use gst_buffer_new_and_alloc()
  54  * to create a buffer with preallocated data of a given size.
  55  *
  56  * The data pointed to by the buffer can be retrieved with the GST_BUFFER_DATA()
  57  * macro. The size of the data can be found with GST_BUFFER_SIZE(). For buffers
  58  * of size 0, the data pointer is undefined (usually NULL) and should never be used.
  59  *
  60  * If an element knows what pad you will push the buffer out on, it should use
  61  * gst_pad_alloc_buffer() instead to create a buffer.  This allows downstream
  62  * elements to provide special buffers to write in, like hardware buffers.
  63  *
  64  * A buffer has a pointer to a #GstCaps describing the media type of the data
  65  * in the buffer. Attach caps to the buffer with gst_buffer_set_caps(); this
  66  * is typically done before pushing out a buffer using gst_pad_push() so that
  67  * the downstream element knows the type of the buffer.
  68  *
  69  * A buffer will usually have a timestamp, and a duration, but neither of these
  70  * are guaranteed (they may be set to #GST_CLOCK_TIME_NONE). Whenever a
  71  * meaningful value can be given for these, they should be set. The timestamp
  72  * and duration are measured in nanoseconds (they are #GstClockTime values).
  73  *
  74  * A buffer can also have one or both of a start and an end offset. These are
  75  * media-type specific. For video buffers, the start offset will generally be
  76  * the frame number. For audio buffers, it will be the number of samples
  77  * produced so far. For compressed data, it could be the byte offset in a
  78  * source or destination file. Likewise, the end offset will be the offset of
  79  * the end of the buffer. These can only be meaningfully interpreted if you
  80  * know the media type of the buffer (the #GstCaps set on it). Either or both
  81  * can be set to #GST_BUFFER_OFFSET_NONE.
  82  *
  83  * gst_buffer_ref() is used to increase the refcount of a buffer. This must be
  84  * done when you want to keep a handle to the buffer after pushing it to the
  85  * next element.
  86  *
  87  * To efficiently create a smaller buffer out of an existing one, you can
  88  * use gst_buffer_create_sub().
  89  *
  90  * If a plug-in wants to modify the buffer data in-place, it should first obtain
  91  * a buffer that is safe to modify by using gst_buffer_make_writable().  This
  92  * function is optimized so that a copy will only be made when it is necessary.
  93  *
  94  * A plugin that only wishes to modify the metadata of a buffer, such as the
  95  * offset, timestamp or caps, should use gst_buffer_make_metadata_writable(),
  96  * which will create a subbuffer of the original buffer to ensure the caller
  97  * has sole ownership, and not copy the buffer data.
  98  *
  99  * Several flags of the buffer can be set and unset with the
 100  * GST_BUFFER_FLAG_SET() and GST_BUFFER_FLAG_UNSET() macros. Use
 101  * GST_BUFFER_FLAG_IS_SET() to test if a certain #GstBufferFlag is set.
 102  *
 103  * Buffers can be efficiently merged into a larger buffer with
 104  * gst_buffer_merge() and gst_buffer_span() if the gst_buffer_is_span_fast()
 105  * function returns TRUE.
 106  *
 107  * An element should either unref the buffer or push it out on a src pad
 108  * using gst_pad_push() (see #GstPad).
 109  *
 110  * Buffers are usually freed by unreffing them with gst_buffer_unref(). When
 111  * the refcount drops to 0, any data pointed to by GST_BUFFER_MALLOCDATA() will
 112  * also be freed.
 113  *
 114  * Last reviewed on August 11th, 2006 (0.10.10)
 115  */
 116 #include "gst_private.h"
 117
 118 #ifdef HAVE_UNISTD_H
 119 #include <unistd.h>
 120 #endif
 121 #ifdef HAVE_STDLIB_H
 122 #include <stdlib.h>
 123 #endif
 124
 125 #include "gstbuffer.h"
 126 #include "gstinfo.h"
 127 #include "gstutils.h"
 128 #include "gstminiobject.h"
 129 #include "gstversion.h"
 130
 131 static void gst_buffer_finalize (GstBuffer * buffer);
 132 static GstBuffer *_gst_buffer_copy (GstBuffer * buffer);
 133
 134 static GType _gst_buffer_type = 0;
 135
 136 /* buffer alignment in bytes
 137  * an alignment of 8 would be the same as malloc() guarantees
 138  */
 139 #ifdef HAVE_POSIX_MEMALIGN
 140 #if defined(BUFFER_ALIGNMENT_MALLOC)
 141 static size_t _gst_buffer_data_alignment = 8;
 142 #elif defined(BUFFER_ALIGNMENT_PAGESIZE)
 143 static size_t _gst_buffer_data_alignment = 0;
 144 #elif defined(BUFFER_ALIGNMENT)
 145 static size_t _gst_buffer_data_alignment = BUFFER_ALIGNMENT;
 146 #else
 147 #error "No buffer alignment configured"
 148 #endif
 149
 150 static inline gboolean
 151 aligned_malloc (gpointer * memptr, guint size)
 152 {
 153   gint res;
 154
 155   res = posix_memalign (memptr, _gst_buffer_data_alignment, size);
 156   return (res == 0);
 157 }
 158
 159 #endif /* HAVE_POSIX_MEMALIGN */
 160
 161 void
 162 _gst_buffer_initialize (void)
 163 {
 164   /* the GstMiniObject types need to be class_ref'd once before it can be
 165    * done from multiple threads;
 166    * see http://bugzilla.gnome.org/show_bug.cgi?id=304551 */
 167   g_type_class_ref (gst_buffer_get_type ());
 168 #ifdef HAVE_GETPAGESIZE
 169 #ifdef BUFFER_ALIGNMENT_PAGESIZE
 170   _gst_buffer_data_alignment = getpagesize ();
 171 #endif
 172 #endif
 173 }
 174
 175 #define _do_init \
 176 { \
 177   _gst_buffer_type = g_define_type_id; \
 178 }
 179
 180 G_DEFINE_TYPE_WITH_CODE (GstBuffer, gst_buffer, GST_TYPE_MINI_OBJECT, _do_init);
 181
 182 static void
 183 gst_buffer_class_init (GstBufferClass * klass)
 184 {
 185   klass->mini_object_class.copy = (GstMiniObjectCopyFunction) _gst_buffer_copy;
 186   klass->mini_object_class.finalize =
 187       (GstMiniObjectFinalizeFunction) gst_buffer_finalize;
 188 }
 189
 190 static void
 191 gst_buffer_finalize (GstBuffer * buffer)
 192 {
 193   g_return_if_fail (buffer != NULL);
 194
 195   GST_CAT_LOG (GST_CAT_BUFFER, "finalize %p", buffer);
 196
 197   /* free our data */
 198   if (G_LIKELY (buffer->malloc_data))
 199     buffer->free_func (buffer->malloc_data);
 200
 201   gst_caps_replace (&GST_BUFFER_CAPS (buffer), NULL);
 202
 203   if (buffer->parent)
 204     gst_buffer_unref (buffer->parent);
 205
 206 /*   ((GstMiniObjectClass *) */
 207 /*       gst_buffer_parent_class)->finalize (GST_MINI_OBJECT_CAST (buffer)); */
 208 }
 209
 210 /**
 211  * gst_buffer_copy_metadata:
 212  * @dest: a destination #GstBuffer
 213  * @src: a source #GstBuffer
 214  * @flags: flags indicating what metadata fields should be copied.
 215  *
 216  * Copies the metadata from @src into @dest. The data, size and mallocdata
 217  * fields are not copied.
 218  *
 219  * @flags indicate which fields will be copied. Use #GST_BUFFER_COPY_ALL to copy
 220  * all the metadata fields.
 221  *
 222  * This function is typically called from a custom buffer copy function after
 223  * creating @dest and setting the data, size, mallocdata.
 224  *
 225  * Since: 0.10.13
 226  */
 227 void
 228 gst_buffer_copy_metadata (GstBuffer * dest, const GstBuffer * src,
 229     GstBufferCopyFlags flags)
 230 {
 231   g_return_if_fail (dest != NULL);
 232   g_return_if_fail (src != NULL);
 233
 234   /* nothing to copy if the buffers are the same */
 235   if (G_UNLIKELY (dest == src))
 236     return;
 237
 238 #if GST_VERSION_NANO == 1
 239   /* we enable this extra debugging in git versions only for now */
 240   g_warn_if_fail (gst_buffer_is_metadata_writable (dest));
 241 #endif
 242
 243   GST_CAT_LOG (GST_CAT_BUFFER, "copy %p to %p", src, dest);
 244
 245   if (flags & GST_BUFFER_COPY_FLAGS) {
 246     guint mask;
 247
 248     /* copy relevant flags */
 249     mask = GST_BUFFER_FLAG_PREROLL | GST_BUFFER_FLAG_IN_CAPS |
 250         GST_BUFFER_FLAG_DELTA_UNIT | GST_BUFFER_FLAG_DISCONT |
 251         GST_BUFFER_FLAG_GAP | GST_BUFFER_FLAG_MEDIA1 |
 252         GST_BUFFER_FLAG_MEDIA2 | GST_BUFFER_FLAG_MEDIA3;
 253     GST_MINI_OBJECT_FLAGS (dest) |= GST_MINI_OBJECT_FLAGS (src) & mask;
 254   }
 255
 256   if (flags & GST_BUFFER_COPY_TIMESTAMPS) {
 257     GST_BUFFER_TIMESTAMP (dest) = GST_BUFFER_TIMESTAMP (src);
 258     GST_BUFFER_DURATION (dest) = GST_BUFFER_DURATION (src);
 259     GST_BUFFER_OFFSET (dest) = GST_BUFFER_OFFSET (src);
 260     GST_BUFFER_OFFSET_END (dest) = GST_BUFFER_OFFSET_END (src);
 261   }
 262
 263   if (flags & GST_BUFFER_COPY_CAPS) {
 264     gst_caps_replace (&GST_BUFFER_CAPS (dest), GST_BUFFER_CAPS (src));
 265   }
 266 }
 267
 268 static GstBuffer *
 269 _gst_buffer_copy (GstBuffer * buffer)
 270 {
 271   GstBuffer *copy;
 272
 273   g_return_val_if_fail (buffer != NULL, NULL);
 274
 275   /* create a fresh new buffer */
 276   copy = gst_buffer_new ();
 277
 278   /* we simply copy everything from our parent */
 279 #ifdef HAVE_POSIX_MEMALIGN
 280   {
 281     gpointer memptr = NULL;
 282
 283     if (G_LIKELY (buffer->size)) {
 284       if (G_UNLIKELY (!aligned_malloc (&memptr, buffer->size))) {
 285         /* terminate on error like g_memdup() would */
 286         g_error ("%s: failed to allocate %u bytes", G_STRLOC, buffer->size);
 287       } else {
 288         memcpy (memptr, buffer->data, buffer->size);
 289       }
 290     }
 291     copy->data = (guint8 *) memptr;
 292     GST_BUFFER_FREE_FUNC (copy) = free;
 293   }
 294 #else
 295   copy->data = g_memdup (buffer->data, buffer->size);
 296 #endif
 297
 298   /* make sure it gets freed (even if the parent is subclassed, we return a
 299      normal buffer) */
 300   copy->malloc_data = copy->data;
 301   copy->size = buffer->size;
 302
 303   gst_buffer_copy_metadata (copy, buffer, GST_BUFFER_COPY_ALL);
 304
 305   return copy;
 306 }
 307
 308 static void
 309 gst_buffer_init (GstBuffer * buffer)
 310 {
 311   GST_CAT_LOG (GST_CAT_BUFFER, "init %p", buffer);
 312
 313   GST_BUFFER_TIMESTAMP (buffer) = GST_CLOCK_TIME_NONE;
 314   GST_BUFFER_DURATION (buffer) = GST_CLOCK_TIME_NONE;
 315   GST_BUFFER_OFFSET (buffer) = GST_BUFFER_OFFSET_NONE;
 316   GST_BUFFER_OFFSET_END (buffer) = GST_BUFFER_OFFSET_NONE;
 317   GST_BUFFER_FREE_FUNC (buffer) = g_free;
 318 }
 319
 320 /**
 321  * gst_buffer_new:
 322  *
 323  * Creates a newly allocated buffer without any data.
 324  *
 325  * MT safe.
 326  * Returns: the new #GstBuffer.
 327  */
 328 GstBuffer *
 329 gst_buffer_new (void)
 330 {
 331   GstBuffer *newbuf;
 332
 333   newbuf = (GstBuffer *) gst_mini_object_new (_gst_buffer_type);
 334
 335   GST_CAT_LOG (GST_CAT_BUFFER, "new %p", newbuf);
 336
 337   return newbuf;
 338 }
 339
 340 /**
 341  * gst_buffer_new_and_alloc:
 342  * @size: the size of the new buffer's data.
 343  *
 344  * Creates a newly allocated buffer with data of the given size.
 345  * The buffer memory is not cleared. If the requested amount of
 346  * memory can't be allocated, the program will abort. Use
 347  * gst_buffer_try_new_and_alloc() if you want to handle this case
 348  * gracefully or have gotten the size to allocate from an untrusted
 349  * source such as a media stream.
 350  *
 351  *
 352  * Note that when @size == 0, the buffer data pointer will be NULL.
 353  *
 354  * MT safe.
 355  * Returns: the new #GstBuffer.
 356  */
 357 GstBuffer *
 358 gst_buffer_new_and_alloc (guint size)
 359 {
 360   GstBuffer *newbuf;
 361
 362   newbuf = gst_buffer_new ();
 363
 364 #ifdef HAVE_POSIX_MEMALIGN
 365   {
 366     gpointer memptr = NULL;
 367
 368     if (G_LIKELY (size)) {
 369       if (G_UNLIKELY (!aligned_malloc (&memptr, size))) {
 370         /* terminate on error like g_memdup() would */
 371         g_error ("%s: failed to allocate %u bytes", G_STRLOC, size);
 372       }
 373     }
 374     newbuf->malloc_data = (guint8 *) memptr;
 375     GST_BUFFER_FREE_FUNC (newbuf) = free;
 376   }
 377 #else
 378   newbuf->malloc_data = g_malloc (size);
 379 #endif
 380   GST_BUFFER_DATA (newbuf) = newbuf->malloc_data;
 381   GST_BUFFER_SIZE (newbuf) = size;
 382
 383   GST_CAT_LOG (GST_CAT_BUFFER, "new %p of size %d", newbuf, size);
 384
 385   return newbuf;
 386 }
 387
 388 /**
 389  * gst_buffer_try_new_and_alloc:
 390  * @size: the size of the new buffer's data.
 391  *
 392  * Tries to create a newly allocated buffer with data of the given size. If
 393  * the requested amount of memory can't be allocated, NULL will be returned.
 394  * The buffer memory is not cleared.
 395  *
 396  * Note that when @size == 0, the buffer data pointer will be NULL.
 397  *
 398  * MT safe.
 399  *
 400  * Returns: a new #GstBuffer, or NULL if the memory couldn't be allocated.
 401  *
 402  * Since: 0.10.13
 403  */
 404 GstBuffer *
 405 gst_buffer_try_new_and_alloc (guint size)
 406 {
 407   GstBuffer *newbuf;
 408   guint8 *malloc_data;
 409 #ifdef HAVE_POSIX_MEMALIGN
 410   gpointer memptr = NULL;
 411
 412   if (G_LIKELY (size)) {
 413     if (G_UNLIKELY (!aligned_malloc (&memptr, size))) {
 414       GST_CAT_WARNING (GST_CAT_BUFFER, "failed to allocate %d bytes", size);
 415       return NULL;
 416     }
 417   }
 418   malloc_data = (guint8 *) memptr;
 419 #else
 420   malloc_data = g_try_malloc (size);
 421
 422   if (G_UNLIKELY (malloc_data == NULL && size != 0)) {
 423     GST_CAT_WARNING (GST_CAT_BUFFER, "failed to allocate %d bytes", size);
 424     return NULL;
 425   }
 426 #endif
 427
 428   /* FIXME: there's no g_type_try_create_instance() in GObject yet, so this
 429    * will still abort if a new GstBuffer structure can't be allocated */
 430   newbuf = gst_buffer_new ();
 431
 432   GST_BUFFER_MALLOCDATA (newbuf) = malloc_data;
 433   GST_BUFFER_DATA (newbuf) = malloc_data;
 434   GST_BUFFER_SIZE (newbuf) = size;
 435 #ifdef HAVE_POSIX_MEMALIGN
 436   GST_BUFFER_FREE_FUNC (newbuf) = free;
 437 #endif
 438
 439   GST_CAT_LOG (GST_CAT_BUFFER, "new %p of size %d", newbuf, size);
 440
 441   return newbuf;
 442 }
 443
 444 /**
 445  * gst_buffer_get_caps:
 446  * @buffer: a #GstBuffer.
 447  *
 448  * Gets the media type of the buffer. This can be NULL if there
 449  * is no media type attached to this buffer.
 450  *
 451  * Returns: a reference to the #GstCaps. unref after usage.
 452  * Returns NULL if there were no caps on this buffer.
 453  */
 454 /* this is not made atomic because if the buffer were reffed from multiple
 455  * threads, it would have a refcount > 2 and thus be immutable.
 456  */
 457 GstCaps *
 458 gst_buffer_get_caps (GstBuffer * buffer)
 459 {
 460   GstCaps *ret;
 461
 462   g_return_val_if_fail (buffer != NULL, NULL);
 463
 464   ret = GST_BUFFER_CAPS (buffer);
 465
 466   if (ret)
 467     gst_caps_ref (ret);
 468
 469   return ret;
 470 }
 471
 472 /**
 473  * gst_buffer_set_caps:
 474  * @buffer: a #GstBuffer.
 475  * @caps: a #GstCaps.
 476  *
 477  * Sets the media type on the buffer. The refcount of the caps will
 478  * be increased and any previous caps on the buffer will be
 479  * unreffed.
 480  */
 481 /* this is not made atomic because if the buffer were reffed from multiple
 482  * threads, it would have a refcount > 2 and thus be immutable.
 483  */
 484 void
 485 gst_buffer_set_caps (GstBuffer * buffer, GstCaps * caps)
 486 {
 487   g_return_if_fail (buffer != NULL);
 488   g_return_if_fail (caps == NULL || GST_CAPS_IS_SIMPLE (caps));
 489
 490 #if GST_VERSION_NANO == 1
 491   /* we enable this extra debugging in git versions only for now */
 492   g_warn_if_fail (gst_buffer_is_metadata_writable (buffer));
 493   /* FIXME: would be nice to also check if caps are fixed here, but expensive */
 494 #endif
 495
 496   gst_caps_replace (&GST_BUFFER_CAPS (buffer), caps);
 497 }
 498
 499 /**
 500  * gst_buffer_is_metadata_writable:
 501  * @buf: a #GstBuffer
 502  *
 503  * Similar to gst_buffer_is_writable, but this only ensures that the
 504  * refcount of the buffer is 1, indicating that the caller is the sole
 505  * owner and can change the buffer metadata, such as caps and timestamps.
 506  *
 507  * Returns: TRUE if the metadata is writable.
 508  */
 509 gboolean
 510 gst_buffer_is_metadata_writable (GstBuffer * buf)
 511 {
 512   return (GST_MINI_OBJECT_REFCOUNT_VALUE (GST_MINI_OBJECT_CAST (buf)) == 1);
 513 }
 514
 515 /**
 516  * gst_buffer_make_metadata_writable:
 517  * @buf: a #GstBuffer
 518  *
 519  * Similar to gst_buffer_make_writable, but does not ensure that the buffer
 520  * data array is writable. Instead, this just ensures that the returned buffer
 521  * is solely owned by the caller, by creating a subbuffer of the original
 522  * buffer if necessary.
 523  *
 524  * After calling this function, @buf should not be referenced anymore. The
 525  * result of this function has guaranteed writable metadata.
 526  *
 527  * Returns: A new #GstBuffer with writable metadata.
 528  */
 529 GstBuffer *
 530 gst_buffer_make_metadata_writable (GstBuffer * buf)
 531 {
 532   GstBuffer *ret;
 533
 534   if (gst_buffer_is_metadata_writable (buf)) {
 535     ret = buf;
 536   } else {
 537     ret = gst_buffer_create_sub (buf, 0, GST_BUFFER_SIZE (buf));
 538
 539     gst_buffer_unref (buf);
 540   }
 541
 542   return ret;
 543 }
 544
 545 #define GST_IS_SUBBUFFER(obj)   (GST_BUFFER_CAST(obj)->parent != NULL)
 546
 547 /**
 548  * gst_buffer_create_sub:
 549  * @parent: a #GstBuffer.
 550  * @offset: the offset into parent #GstBuffer at which the new sub-buffer
 551  *          begins.
 552  * @size: the size of the new #GstBuffer sub-buffer, in bytes.
 553  *
 554  * Creates a sub-buffer from @parent at @offset and @size.
 555  * This sub-buffer uses the actual memory space of the parent buffer.
 556  * This function will copy the offset and timestamp fields when the
 557  * offset is 0. If not, they will be set to #GST_CLOCK_TIME_NONE and
 558  * #GST_BUFFER_OFFSET_NONE.
 559  * If @offset equals 0 and @size equals the total size of @buffer, the
 560  * duration and offset end fields are also copied. If not they will be set
 561  * to #GST_CLOCK_TIME_NONE and #GST_BUFFER_OFFSET_NONE.
 562  *
 563  * MT safe.
 564  * Returns: the new #GstBuffer.
 565  * Returns NULL if the arguments were invalid.
 566  */
 567 GstBuffer *
 568 gst_buffer_create_sub (GstBuffer * buffer, guint offset, guint size)
 569 {
 570   GstBuffer *subbuffer;
 571   GstBuffer *parent;
 572   gboolean complete;
 573
 574   g_return_val_if_fail (buffer != NULL, NULL);
 575   g_return_val_if_fail (buffer->mini_object.refcount, NULL);
 576   g_return_val_if_fail (buffer->size >= offset + size, NULL);
 577
 578   /* find real parent */
 579   if (GST_IS_SUBBUFFER (buffer)) {
 580     parent = buffer->parent;
 581   } else {
 582     parent = buffer;
 583   }
 584   gst_buffer_ref (parent);
 585
 586   /* create the new buffer */
 587   subbuffer = gst_buffer_new ();
 588   subbuffer->parent = parent;
 589   GST_BUFFER_FLAG_SET (subbuffer, GST_BUFFER_FLAG_READONLY);
 590
 591   GST_CAT_LOG (GST_CAT_BUFFER, "new subbuffer %p (parent %p)", subbuffer,
 592       parent);
 593
 594   /* set the right values in the child */
 595   GST_BUFFER_DATA (subbuffer) = buffer->data + offset;
 596   GST_BUFFER_SIZE (subbuffer) = size;
 597
 598   if ((offset == 0) && (size == GST_BUFFER_SIZE (buffer))) {
 599     /* copy all the flags except IN_CAPS */
 600     GST_BUFFER_FLAG_SET (subbuffer, GST_BUFFER_FLAGS (buffer));
 601     GST_BUFFER_FLAG_UNSET (subbuffer, GST_BUFFER_FLAG_IN_CAPS);
 602   } else {
 603     /* copy only PREROLL & GAP flags */
 604     GST_BUFFER_FLAG_SET (subbuffer, (GST_BUFFER_FLAGS (buffer) &
 605             (GST_BUFFER_FLAG_PREROLL | GST_BUFFER_FLAG_GAP)));
 606   }
 607
 608   /* we can copy the timestamp and offset if the new buffer starts at
 609    * offset 0 */
 610   if (offset == 0) {
 611     GST_BUFFER_TIMESTAMP (subbuffer) = GST_BUFFER_TIMESTAMP (buffer);
 612     GST_BUFFER_OFFSET (subbuffer) = GST_BUFFER_OFFSET (buffer);
 613     complete = (buffer->size == size);
 614   } else {
 615     GST_BUFFER_TIMESTAMP (subbuffer) = GST_CLOCK_TIME_NONE;
 616     GST_BUFFER_OFFSET (subbuffer) = GST_BUFFER_OFFSET_NONE;
 617     complete = FALSE;
 618   }
 619
 620   if (complete) {
 621     GstCaps *caps;
 622
 623     /* if we copied the complete buffer we can copy the duration,
 624      * offset_end and caps as well */
 625     GST_BUFFER_DURATION (subbuffer) = GST_BUFFER_DURATION (buffer);
 626     GST_BUFFER_OFFSET_END (subbuffer) = GST_BUFFER_OFFSET_END (buffer);
 627     if ((caps = GST_BUFFER_CAPS (buffer)))
 628       gst_caps_ref (caps);
 629     GST_BUFFER_CAPS (subbuffer) = caps;
 630   } else {
 631     GST_BUFFER_DURATION (subbuffer) = GST_CLOCK_TIME_NONE;
 632     GST_BUFFER_OFFSET_END (subbuffer) = GST_BUFFER_OFFSET_NONE;
 633     GST_BUFFER_CAPS (subbuffer) = NULL;
 634   }
 635   return subbuffer;
 636 }
 637
 638 /**
 639  * gst_buffer_is_span_fast:
 640  * @buf1: the first #GstBuffer.
 641  * @buf2: the second #GstBuffer.
 642  *
 643  * Determines whether a gst_buffer_span() can be done without copying
 644  * the contents, that is, whether the data areas are contiguous sub-buffers of
 645  * the same buffer.
 646  *
 647  * MT safe.
 648  * Returns: TRUE if the buffers are contiguous,
 649  * FALSE if a copy would be required.
 650  */
 651 gboolean
 652 gst_buffer_is_span_fast (GstBuffer * buf1, GstBuffer * buf2)
 653 {
 654   g_return_val_if_fail (buf1 != NULL && buf2 != NULL, FALSE);
 655   g_return_val_if_fail (buf1->mini_object.refcount, FALSE);
 656   g_return_val_if_fail (buf2->mini_object.refcount, FALSE);
 657
 658   /* it's only fast if we have subbuffers of the same parent */
 659   return (GST_IS_SUBBUFFER (buf1) &&
 660       GST_IS_SUBBUFFER (buf2) && (buf1->parent == buf2->parent)
 661       && ((buf1->data + buf1->size) == buf2->data));
 662 }
 663
 664 /**
 665  * gst_buffer_span:
 666  * @buf1: the first source #GstBuffer to merge.
 667  * @offset: the offset in the first buffer from where the new
 668  * buffer should start.
 669  * @buf2: the second source #GstBuffer to merge.
 670  * @len: the total length of the new buffer.
 671  *
 672  * Creates a new buffer that consists of part of buf1 and buf2.
 673  * Logically, buf1 and buf2 are concatenated into a single larger
 674  * buffer, and a new buffer is created at the given offset inside
 675  * this space, with a given length.
 676  *
 677  * If the two source buffers are children of the same larger buffer,
 678  * and are contiguous, the new buffer will be a child of the shared
 679  * parent, and thus no copying is necessary. you can use
 680  * gst_buffer_is_span_fast() to determine if a memcpy will be needed.
 681  *
 682  * MT safe.
 683  * Returns: the new #GstBuffer that spans the two source buffers.
 684  * Returns NULL if the arguments are invalid.
 685  */
 686 GstBuffer *
 687 gst_buffer_span (GstBuffer * buf1, guint32 offset, GstBuffer * buf2,
 688     guint32 len)
 689 {
 690   GstBuffer *newbuf;
 691
 692   g_return_val_if_fail (buf1 != NULL && buf2 != NULL, NULL);
 693   g_return_val_if_fail (buf1->mini_object.refcount, NULL);
 694   g_return_val_if_fail (buf2->mini_object.refcount, NULL);
 695   g_return_val_if_fail (len, NULL);
 696   g_return_val_if_fail (len <= buf1->size + buf2->size - offset, NULL);
 697
 698   /* if the two buffers have the same parent and are adjacent */
 699   if (gst_buffer_is_span_fast (buf1, buf2)) {
 700     GstBuffer *parent = buf1->parent;
 701
 702     /* we simply create a subbuffer of the common parent */
 703     newbuf = gst_buffer_create_sub (parent,
 704         buf1->data - parent->data + offset, len);
 705   } else {
 706     GST_CAT_DEBUG (GST_CAT_BUFFER,
 707         "slow path taken while spanning buffers %p and %p", buf1, buf2);
 708     /* otherwise we simply have to brute-force copy the buffers */
 709     newbuf = gst_buffer_new_and_alloc (len);
 710
 711     /* copy the first buffer's data across */
 712     memcpy (newbuf->data, buf1->data + offset, buf1->size - offset);
 713     /* copy the second buffer's data across */
 714     memcpy (newbuf->data + (buf1->size - offset), buf2->data,
 715         len - (buf1->size - offset));
 716   }
 717   /* if the offset is 0, the new buffer has the same timestamp as buf1 */
 718   if (offset == 0) {
 719     GST_BUFFER_OFFSET (newbuf) = GST_BUFFER_OFFSET (buf1);
 720     GST_BUFFER_TIMESTAMP (newbuf) = GST_BUFFER_TIMESTAMP (buf1);
 721
 722     /* if we completely merged the two buffers (appended), we can
 723      * calculate the duration too. Also make sure we's not messing with
 724      * invalid DURATIONS */
 725     if (buf1->size + buf2->size == len) {
 726       if (GST_BUFFER_DURATION_IS_VALID (buf1) &&
 727           GST_BUFFER_DURATION_IS_VALID (buf2)) {
 728         /* add duration */
 729         GST_BUFFER_DURATION (newbuf) = GST_BUFFER_DURATION (buf1) +
 730             GST_BUFFER_DURATION (buf2);
 731       }
 732       if (GST_BUFFER_OFFSET_END_IS_VALID (buf2)) {
 733         /* add offset_end */
 734         GST_BUFFER_OFFSET_END (newbuf) = GST_BUFFER_OFFSET_END (buf2);
 735       }
 736     }
 737   }
 738
 739   return newbuf;
 740 }