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