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