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