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 #include "gstbuffer.h"
 119 #include "gstinfo.h"
 120 #include "gstutils.h"
 121 #include "gstminiobject.h"
 122 #include "gstversion.h"
 123
 124 static void gst_buffer_finalize (GstBuffer * buffer);
 125 static GstBuffer *_gst_buffer_copy (GstBuffer * buffer);
 126
 127 static GType _gst_buffer_type = 0;
 128
 129 void
 130 _gst_buffer_initialize (void)
 131 {
 132   /* the GstMiniObject types need to be class_ref'd once before it can be
 133    * done from multiple threads;
 134    * see http://bugzilla.gnome.org/show_bug.cgi?id=304551 */
 135   g_type_class_ref (gst_buffer_get_type ());
 136 }
 137
 138 #define _do_init \
 139 { \
 140   _gst_buffer_type = g_define_type_id; \
 141 }
 142
 143 G_DEFINE_TYPE_WITH_CODE (GstBuffer, gst_buffer, GST_TYPE_MINI_OBJECT, _do_init);
 144
 145 static void
 146 gst_buffer_class_init (GstBufferClass * klass)
 147 {
 148   klass->mini_object_class.copy = (GstMiniObjectCopyFunction) _gst_buffer_copy;
 149   klass->mini_object_class.finalize =
 150       (GstMiniObjectFinalizeFunction) gst_buffer_finalize;
 151 }
 152
 153 static void
 154 gst_buffer_finalize (GstBuffer * buffer)
 155 {
 156   g_return_if_fail (buffer != NULL);
 157
 158   GST_CAT_LOG (GST_CAT_BUFFER, "finalize %p", buffer);
 159
 160   /* free our data */
 161   if (G_LIKELY (buffer->malloc_data))
 162     buffer->free_func (buffer->malloc_data);
 163
 164   gst_caps_replace (&GST_BUFFER_CAPS (buffer), NULL);
 165
 166   if (buffer->parent)
 167     gst_buffer_unref (buffer->parent);
 168
 169 /*   ((GstMiniObjectClass *) */
 170 /*       gst_buffer_parent_class)->finalize (GST_MINI_OBJECT_CAST (buffer)); */
 171 }
 172
 173 /**
 174  * gst_buffer_copy_metadata:
 175  * @dest: a destination #GstBuffer
 176  * @src: a source #GstBuffer
 177  * @flags: flags indicating what metadata fields should be copied.
 178  *
 179  * Copies the metadata from @src into @dest. The data, size and mallocdata
 180  * fields are not copied.
 181  *
 182  * @flags indicate which fields will be copied. Use #GST_BUFFER_COPY_ALL to copy
 183  * all the metadata fields.
 184  *
 185  * This function is typically called from a custom buffer copy function after
 186  * creating @dest and setting the data, size, mallocdata.
 187  *
 188  * Since: 0.10.13
 189  */
 190 void
 191 gst_buffer_copy_metadata (GstBuffer * dest, const GstBuffer * src,
 192     GstBufferCopyFlags flags)
 193 {
 194   g_return_if_fail (dest != NULL);
 195   g_return_if_fail (src != NULL);
 196
 197   /* nothing to copy if the buffers are the same */
 198   if (G_UNLIKELY (dest == src))
 199     return;
 200
 201 #if GST_VERSION_NANO == 1
 202   /* we enable this extra debugging in git versions only for now */
 203   g_return_if_fail (gst_buffer_is_metadata_writable (dest));
 204 #endif
 205
 206   GST_CAT_LOG (GST_CAT_BUFFER, "copy %p to %p", src, dest);
 207
 208   if (flags & GST_BUFFER_COPY_FLAGS) {
 209     guint mask;
 210
 211     /* copy relevant flags */
 212     mask = GST_BUFFER_FLAG_PREROLL | GST_BUFFER_FLAG_IN_CAPS |
 213         GST_BUFFER_FLAG_DELTA_UNIT | GST_BUFFER_FLAG_DISCONT |
 214         GST_BUFFER_FLAG_GAP | GST_BUFFER_FLAG_MEDIA1 |
 215         GST_BUFFER_FLAG_MEDIA2 | GST_BUFFER_FLAG_MEDIA3;
 216     GST_MINI_OBJECT_FLAGS (dest) |= GST_MINI_OBJECT_FLAGS (src) & mask;
 217   }
 218
 219   if (flags & GST_BUFFER_COPY_TIMESTAMPS) {
 220     GST_BUFFER_TIMESTAMP (dest) = GST_BUFFER_TIMESTAMP (src);
 221     GST_BUFFER_DURATION (dest) = GST_BUFFER_DURATION (src);
 222     GST_BUFFER_OFFSET (dest) = GST_BUFFER_OFFSET (src);
 223     GST_BUFFER_OFFSET_END (dest) = GST_BUFFER_OFFSET_END (src);
 224   }
 225
 226   if (flags & GST_BUFFER_COPY_CAPS) {
 227     gst_caps_replace (&GST_BUFFER_CAPS (dest), GST_BUFFER_CAPS (src));
 228   }
 229 }
 230
 231 static GstBuffer *
 232 _gst_buffer_copy (GstBuffer * buffer)
 233 {
 234   GstBuffer *copy;
 235
 236   g_return_val_if_fail (buffer != NULL, NULL);
 237
 238   /* create a fresh new buffer */
 239   copy = gst_buffer_new ();
 240
 241   /* we simply copy everything from our parent */
 242   copy->data = g_memdup (buffer->data, buffer->size);
 243   /* make sure it gets freed (even if the parent is subclassed, we return a
 244      normal buffer) */
 245   copy->malloc_data = copy->data;
 246   copy->size = buffer->size;
 247
 248   gst_buffer_copy_metadata (copy, buffer, GST_BUFFER_COPY_ALL);
 249
 250   return copy;
 251 }
 252
 253 static void
 254 gst_buffer_init (GstBuffer * buffer)
 255 {
 256   GST_CAT_LOG (GST_CAT_BUFFER, "init %p", buffer);
 257
 258   GST_BUFFER_TIMESTAMP (buffer) = GST_CLOCK_TIME_NONE;
 259   GST_BUFFER_DURATION (buffer) = GST_CLOCK_TIME_NONE;
 260   GST_BUFFER_OFFSET (buffer) = GST_BUFFER_OFFSET_NONE;
 261   GST_BUFFER_OFFSET_END (buffer) = GST_BUFFER_OFFSET_NONE;
 262   GST_BUFFER_FREE_FUNC (buffer) = g_free;
 263 }
 264
 265 /**
 266  * gst_buffer_new:
 267  *
 268  * Creates a newly allocated buffer without any data.
 269  *
 270  * MT safe.
 271  * Returns: the new #GstBuffer.
 272  */
 273 GstBuffer *
 274 gst_buffer_new (void)
 275 {
 276   GstBuffer *newbuf;
 277
 278   newbuf = (GstBuffer *) gst_mini_object_new (_gst_buffer_type);
 279
 280   GST_CAT_LOG (GST_CAT_BUFFER, "new %p", newbuf);
 281
 282   return newbuf;
 283 }
 284
 285 /**
 286  * gst_buffer_new_and_alloc:
 287  * @size: the size of the new buffer's data.
 288  *
 289  * Creates a newly allocated buffer with data of the given size.
 290  * The buffer memory is not cleared. If the requested amount of
 291  * memory can't be allocated, the program will abort. Use
 292  * gst_buffer_try_new_and_alloc() if you want to handle this case
 293  * gracefully or have gotten the size to allocate from an untrusted
 294  * source such as a media stream.
 295  *
 296  *
 297  * Note that when @size == 0, the buffer data pointer will be NULL.
 298  *
 299  * MT safe.
 300  * Returns: the new #GstBuffer.
 301  */
 302 GstBuffer *
 303 gst_buffer_new_and_alloc (guint size)
 304 {
 305   GstBuffer *newbuf;
 306
 307   newbuf = gst_buffer_new ();
 308
 309   newbuf->malloc_data = g_malloc (size);
 310   GST_BUFFER_DATA (newbuf) = newbuf->malloc_data;
 311   GST_BUFFER_SIZE (newbuf) = size;
 312
 313   GST_CAT_LOG (GST_CAT_BUFFER, "new %p of size %d", newbuf, size);
 314
 315   return newbuf;
 316 }
 317
 318 /**
 319  * gst_buffer_try_new_and_alloc:
 320  * @size: the size of the new buffer's data.
 321  *
 322  * Tries to create a newly allocated buffer with data of the given size. If
 323  * the requested amount of memory can't be allocated, NULL will be returned.
 324  * The buffer memory is not cleared.
 325  *
 326  * Note that when @size == 0, the buffer data pointer will be NULL.
 327  *
 328  * MT safe.
 329  *
 330  * Returns: a new #GstBuffer, or NULL if the memory couldn't be allocated.
 331  *
 332  * Since: 0.10.13
 333  */
 334 GstBuffer *
 335 gst_buffer_try_new_and_alloc (guint size)
 336 {
 337   GstBuffer *newbuf;
 338   guint8 *malloc_data;
 339
 340   malloc_data = g_try_malloc (size);
 341
 342   if (G_UNLIKELY (malloc_data == NULL && size != 0)) {
 343     GST_CAT_WARNING (GST_CAT_BUFFER, "failed to allocate %d bytes", size);
 344     return NULL;
 345   }
 346
 347   /* FIXME: there's no g_type_try_create_instance() in GObject yet, so this
 348    * will still abort if a new GstBuffer structure can't be allocated */
 349   newbuf = gst_buffer_new ();
 350
 351   GST_BUFFER_MALLOCDATA (newbuf) = malloc_data;
 352   GST_BUFFER_DATA (newbuf) = malloc_data;
 353   GST_BUFFER_SIZE (newbuf) = size;
 354
 355   GST_CAT_LOG (GST_CAT_BUFFER, "new %p of size %d", newbuf, size);
 356
 357   return newbuf;
 358 }
 359
 360 /**
 361  * gst_buffer_get_caps:
 362  * @buffer: a #GstBuffer.
 363  *
 364  * Gets the media type of the buffer. This can be NULL if there
 365  * is no media type attached to this buffer.
 366  *
 367  * Returns: a reference to the #GstCaps. unref after usage.
 368  * Returns NULL if there were no caps on this buffer.
 369  */
 370 /* this is not made atomic because if the buffer were reffed from multiple
 371  * threads, it would have a refcount > 2 and thus be immutable.
 372  */
 373 GstCaps *
 374 gst_buffer_get_caps (GstBuffer * buffer)
 375 {
 376   GstCaps *ret;
 377
 378   g_return_val_if_fail (buffer != NULL, NULL);
 379
 380   ret = GST_BUFFER_CAPS (buffer);
 381
 382   if (ret)
 383     gst_caps_ref (ret);
 384
 385   return ret;
 386 }
 387
 388 /**
 389  * gst_buffer_set_caps:
 390  * @buffer: a #GstBuffer.
 391  * @caps: a #GstCaps.
 392  *
 393  * Sets the media type on the buffer. The refcount of the caps will
 394  * be increased and any previous caps on the buffer will be
 395  * unreffed.
 396  */
 397 /* this is not made atomic because if the buffer were reffed from multiple
 398  * threads, it would have a refcount > 2 and thus be immutable.
 399  */
 400 void
 401 gst_buffer_set_caps (GstBuffer * buffer, GstCaps * caps)
 402 {
 403   g_return_if_fail (buffer != NULL);
 404 #if GST_VERSION_NANO == 1
 405   /* we enable this extra debugging in git versions only for now */
 406   g_return_if_fail (gst_buffer_is_metadata_writable (buffer));
 407 #endif
 408
 409   gst_caps_replace (&GST_BUFFER_CAPS (buffer), caps);
 410 }
 411
 412 /**
 413  * gst_buffer_is_metadata_writable:
 414  * @buf: a #GstBuffer
 415  *
 416  * Similar to gst_buffer_is_writable, but this only ensures that the
 417  * refcount of the buffer is 1, indicating that the caller is the sole
 418  * owner and can change the buffer metadata, such as caps and timestamps.
 419  *
 420  * Returns: TRUE if the metadata is writable.
 421  */
 422 gboolean
 423 gst_buffer_is_metadata_writable (GstBuffer * buf)
 424 {
 425   return (GST_MINI_OBJECT_REFCOUNT_VALUE (GST_MINI_OBJECT_CAST (buf)) == 1);
 426 }
 427
 428 /**
 429  * gst_buffer_make_metadata_writable:
 430  * @buf: a #GstBuffer
 431  *
 432  * Similar to gst_buffer_make_writable, but does not ensure that the buffer
 433  * data array is writable. Instead, this just ensures that the returned buffer
 434  * is solely owned by the caller, by creating a subbuffer of the original
 435  * buffer if necessary.
 436  *
 437  * After calling this function, @buf should not be referenced anymore. The
 438  * result of this function has guaranteed writable metadata.
 439  *
 440  * Returns: A new #GstBuffer with writable metadata.
 441  */
 442 GstBuffer *
 443 gst_buffer_make_metadata_writable (GstBuffer * buf)
 444 {
 445   GstBuffer *ret;
 446
 447   if (gst_buffer_is_metadata_writable (buf)) {
 448     ret = buf;
 449   } else {
 450     ret = gst_buffer_create_sub (buf, 0, GST_BUFFER_SIZE (buf));
 451
 452     gst_buffer_unref (buf);
 453   }
 454
 455   return ret;
 456 }
 457
 458 #define GST_IS_SUBBUFFER(obj)   (GST_BUFFER_CAST(obj)->parent != NULL)
 459
 460 /**
 461  * gst_buffer_create_sub:
 462  * @parent: a #GstBuffer.
 463  * @offset: the offset into parent #GstBuffer at which the new sub-buffer
 464  *          begins.
 465  * @size: the size of the new #GstBuffer sub-buffer, in bytes.
 466  *
 467  * Creates a sub-buffer from @parent at @offset and @size.
 468  * This sub-buffer uses the actual memory space of the parent buffer.
 469  * This function will copy the offset and timestamp fields when the
 470  * offset is 0. If not, they will be set to #GST_CLOCK_TIME_NONE and
 471  * #GST_BUFFER_OFFSET_NONE.
 472  * If @offset equals 0 and @size equals the total size of @buffer, the
 473  * duration and offset end fields are also copied. If not they will be set
 474  * to #GST_CLOCK_TIME_NONE and #GST_BUFFER_OFFSET_NONE.
 475  *
 476  * MT safe.
 477  * Returns: the new #GstBuffer.
 478  * Returns NULL if the arguments were invalid.
 479  */
 480 GstBuffer *
 481 gst_buffer_create_sub (GstBuffer * buffer, guint offset, guint size)
 482 {
 483   GstBuffer *subbuffer;
 484   GstBuffer *parent;
 485   gboolean complete;
 486
 487   g_return_val_if_fail (buffer != NULL, NULL);
 488   g_return_val_if_fail (buffer->mini_object.refcount > 0, NULL);
 489   g_return_val_if_fail (buffer->size >= offset + size, NULL);
 490
 491   /* find real parent */
 492   if (GST_IS_SUBBUFFER (buffer)) {
 493     parent = buffer->parent;
 494   } else {
 495     parent = buffer;
 496   }
 497   gst_buffer_ref (parent);
 498
 499   /* create the new buffer */
 500   subbuffer = gst_buffer_new ();
 501   subbuffer->parent = parent;
 502   GST_BUFFER_FLAG_SET (subbuffer, GST_BUFFER_FLAG_READONLY);
 503
 504   GST_CAT_LOG (GST_CAT_BUFFER, "new subbuffer %p (parent %p)", subbuffer,
 505       parent);
 506
 507   /* set the right values in the child */
 508   GST_BUFFER_DATA (subbuffer) = buffer->data + offset;
 509   GST_BUFFER_SIZE (subbuffer) = size;
 510
 511   if ((offset == 0) && (size == GST_BUFFER_SIZE (buffer))) {
 512     /* copy all the flags except IN_CAPS */
 513     GST_BUFFER_FLAG_SET (subbuffer, GST_BUFFER_FLAGS (buffer));
 514     GST_BUFFER_FLAG_UNSET (subbuffer, GST_BUFFER_FLAG_IN_CAPS);
 515   } else {
 516     /* copy only PREROLL & GAP flags */
 517     GST_BUFFER_FLAG_SET (subbuffer, (GST_BUFFER_FLAGS (buffer) &
 518             (GST_BUFFER_FLAG_PREROLL | GST_BUFFER_FLAG_GAP)));
 519   }
 520
 521   /* we can copy the timestamp and offset if the new buffer starts at
 522    * offset 0 */
 523   if (offset == 0) {
 524     GST_BUFFER_TIMESTAMP (subbuffer) = GST_BUFFER_TIMESTAMP (buffer);
 525     GST_BUFFER_OFFSET (subbuffer) = GST_BUFFER_OFFSET (buffer);
 526     complete = (buffer->size == size);
 527   } else {
 528     GST_BUFFER_TIMESTAMP (subbuffer) = GST_CLOCK_TIME_NONE;
 529     GST_BUFFER_OFFSET (subbuffer) = GST_BUFFER_OFFSET_NONE;
 530     complete = FALSE;
 531   }
 532
 533   if (complete) {
 534     GstCaps *caps;
 535
 536     /* if we copied the complete buffer we can copy the duration,
 537      * offset_end and caps as well */
 538     GST_BUFFER_DURATION (subbuffer) = GST_BUFFER_DURATION (buffer);
 539     GST_BUFFER_OFFSET_END (subbuffer) = GST_BUFFER_OFFSET_END (buffer);
 540     if ((caps = GST_BUFFER_CAPS (buffer)))
 541       gst_caps_ref (caps);
 542     GST_BUFFER_CAPS (subbuffer) = caps;
 543   } else {
 544     GST_BUFFER_DURATION (subbuffer) = GST_CLOCK_TIME_NONE;
 545     GST_BUFFER_OFFSET_END (subbuffer) = GST_BUFFER_OFFSET_NONE;
 546     GST_BUFFER_CAPS (subbuffer) = NULL;
 547   }
 548   return subbuffer;
 549 }
 550
 551 /**
 552  * gst_buffer_is_span_fast:
 553  * @buf1: the first #GstBuffer.
 554  * @buf2: the second #GstBuffer.
 555  *
 556  * Determines whether a gst_buffer_span() can be done without copying
 557  * the contents, that is, whether the data areas are contiguous sub-buffers of
 558  * the same buffer.
 559  *
 560  * MT safe.
 561  * Returns: TRUE if the buffers are contiguous,
 562  * FALSE if a copy would be required.
 563  */
 564 gboolean
 565 gst_buffer_is_span_fast (GstBuffer * buf1, GstBuffer * buf2)
 566 {
 567   g_return_val_if_fail (buf1 != NULL && buf2 != NULL, FALSE);
 568   g_return_val_if_fail (buf1->mini_object.refcount > 0, FALSE);
 569   g_return_val_if_fail (buf2->mini_object.refcount > 0, FALSE);
 570
 571   /* it's only fast if we have subbuffers of the same parent */
 572   return (GST_IS_SUBBUFFER (buf1) &&
 573       GST_IS_SUBBUFFER (buf2) && (buf1->parent == buf2->parent)
 574       && ((buf1->data + buf1->size) == buf2->data));
 575 }
 576
 577 /**
 578  * gst_buffer_span:
 579  * @buf1: the first source #GstBuffer to merge.
 580  * @offset: the offset in the first buffer from where the new
 581  * buffer should start.
 582  * @buf2: the second source #GstBuffer to merge.
 583  * @len: the total length of the new buffer.
 584  *
 585  * Creates a new buffer that consists of part of buf1 and buf2.
 586  * Logically, buf1 and buf2 are concatenated into a single larger
 587  * buffer, and a new buffer is created at the given offset inside
 588  * this space, with a given length.
 589  *
 590  * If the two source buffers are children of the same larger buffer,
 591  * and are contiguous, the new buffer will be a child of the shared
 592  * parent, and thus no copying is necessary. you can use
 593  * gst_buffer_is_span_fast() to determine if a memcpy will be needed.
 594  *
 595  * MT safe.
 596  * Returns: the new #GstBuffer that spans the two source buffers.
 597  * Returns NULL if the arguments are invalid.
 598  */
 599 GstBuffer *
 600 gst_buffer_span (GstBuffer * buf1, guint32 offset, GstBuffer * buf2,
 601     guint32 len)
 602 {
 603   GstBuffer *newbuf;
 604
 605   g_return_val_if_fail (buf1 != NULL && buf2 != NULL, NULL);
 606   g_return_val_if_fail (buf1->mini_object.refcount > 0, NULL);
 607   g_return_val_if_fail (buf2->mini_object.refcount > 0, NULL);
 608   g_return_val_if_fail (len > 0, NULL);
 609   g_return_val_if_fail (len <= buf1->size + buf2->size - offset, NULL);
 610
 611   /* if the two buffers have the same parent and are adjacent */
 612   if (gst_buffer_is_span_fast (buf1, buf2)) {
 613     GstBuffer *parent = buf1->parent;
 614
 615     /* we simply create a subbuffer of the common parent */
 616     newbuf = gst_buffer_create_sub (parent,
 617         buf1->data - parent->data + offset, len);
 618   } else {
 619     GST_CAT_DEBUG (GST_CAT_BUFFER,
 620         "slow path taken while spanning buffers %p and %p", buf1, buf2);
 621     /* otherwise we simply have to brute-force copy the buffers */
 622     newbuf = gst_buffer_new_and_alloc (len);
 623
 624     /* copy the first buffer's data across */
 625     memcpy (newbuf->data, buf1->data + offset, buf1->size - offset);
 626     /* copy the second buffer's data across */
 627     memcpy (newbuf->data + (buf1->size - offset), buf2->data,
 628         len - (buf1->size - offset));
 629   }
 630   /* if the offset is 0, the new buffer has the same timestamp as buf1 */
 631   if (offset == 0) {
 632     GST_BUFFER_OFFSET (newbuf) = GST_BUFFER_OFFSET (buf1);
 633     GST_BUFFER_TIMESTAMP (newbuf) = GST_BUFFER_TIMESTAMP (buf1);
 634
 635     /* if we completely merged the two buffers (appended), we can
 636      * calculate the duration too. Also make sure we's not messing with
 637      * invalid DURATIONS */
 638     if (buf1->size + buf2->size == len) {
 639       if (GST_BUFFER_DURATION_IS_VALID (buf1) &&
 640           GST_BUFFER_DURATION_IS_VALID (buf2)) {
 641         /* add duration */
 642         GST_BUFFER_DURATION (newbuf) = GST_BUFFER_DURATION (buf1) +
 643             GST_BUFFER_DURATION (buf2);
 644       }
 645       if (GST_BUFFER_OFFSET_END_IS_VALID (buf2)) {
 646         /* add offset_end */
 647         GST_BUFFER_OFFSET_END (newbuf) = GST_BUFFER_OFFSET_END (buf2);
 648       }
 649     }
 650   }
 651
 652   return newbuf;
 653 }