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