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  * SECTION:gstbuffer
  24  * @short_description: Data-passing buffer type, supporting sub-buffers.
  25  * @see_also: #GstPad, #GstMiniObject
  26  *
  27  * Buffers are the basic unit of data transfer in GStreamer.  The GstBuffer type
  28  * provides all the state necessary to define a region of memory as part of a
  29  * stream.  Sub-buffers are also supported, allowing a smaller region of a
  30  * buffer to become its own buffer, with mechanisms in place to ensure that
  31  * neither memory space goes away.
  32  *
  33  * Buffers are usually created with gst_buffer_new(). After a buffer has been
  34  * created one will typically allocate memory for it and set the size of the
  35  * buffer data.  The following example creates a buffer that can hold a given
  36  * video frame with a given width, height and bits per plane.
  37  * <example>
  38  * <title>Creating a buffer for a video frame</title>
  39  *   <programlisting>
  40  *   GstBuffer *buffer;
  41  *   gint size, width, height, bpp;
  42  *
  43  *   ...
  44  *
  45  *   size = width * height * bpp;
  46  *
  47  *   buffer = gst_buffer_new ();
  48  *   GST_BUFFER_SIZE (buffer) = size;
  49  *   GST_BUFFER_MALLOCDATA (buffer) = g_alloc (size);
  50  *   GST_BUFFER_DATA (buffer) = GST_BUFFER_MALLOCDATA (buffer);
  51  *   ...
  52  *   </programlisting>
  53  * </example>
  54  *
  55  * Alternatively, use gst_buffer_new_and_alloc()
  56  * to create a buffer with preallocated data of a given size.
  57  *
  58  * If an element knows what pad you will push the buffer out on, it should use
  59  * gst_pad_alloc_buffer() instead to create a buffer.  This allows downstream
  60  * elements to provide special buffers to write in, like hardware buffers.
  61  *
  62  * A buffer has a pointer to a #GstCaps describing the media type of the data
  63  * in the buffer. Attach caps to the buffer with gst_buffer_set_caps(); this
  64  * is typically done before pushing out a buffer using gst_pad_push() so that
  65  * the downstream element knows the type of the buffer.
  66  *
  67  * gst_buffer_ref() is used to increase the refcount of a buffer. This must be
  68  * done when you want to keep a handle to the buffer after pushing it to the
  69  * next element.
  70  *
  71  * To efficiently create a smaller buffer out of an existing one, you can
  72  * use gst_buffer_create_sub().
  73  *
  74  * If the plug-in wants to modify the buffer in-place, it should first obtain
  75  * a buffer that is safe to modify by using gst_buffer_make_writable().  This
  76  * function is optimized so that a copy will only be made when it is necessary.
  77  *
  78  * Several flags of the buffer can be set and unset with the GST_BUFFER_FLAG_SET()
  79  * and GST_BUFFER_FLAG_UNSET() macros. Use GST_BUFFER_FLAG_IS_SET() to test it
  80  * a certain #GstBufferFlag is set.
  81  *
  82  * Buffers can be efficiently merged into a larger buffer with gst_buffer_merge()
  83  * and gst_buffer_span() if the gst_buffer_is_span_fast() function returns TRUE.
  84  *
  85  * An element should either unref the buffer or push it out on a src pad
  86  * using gst_pad_push() (see #GstPad).
  87  *
  88  * Buffers usually are freed by unreffing them with gst_buffer_unref(). When
  89  * the refcount drops to 0, the buffer memory will be freed again.
  90  *
  91  * Last reviewed on September 24th, 2005 (0.9.0)
  92  */
  93 #include "gst_private.h"
  94
  95 #include "gstbuffer.h"
  96 #include "gstinfo.h"
  97 #include "gstutils.h"
  98 #include "gstminiobject.h"
  99
 100
 101 static void gst_buffer_init (GTypeInstance * instance, gpointer g_class);
 102 static void gst_buffer_class_init (gpointer g_class, gpointer class_data);
 103 static void gst_buffer_finalize (GstBuffer * buffer);
 104 static GstBuffer *_gst_buffer_copy (GstBuffer * buffer);
 105
 106
 107 void
 108 _gst_buffer_initialize (void)
 109 {
 110   gpointer ptr;
 111
 112   gst_buffer_get_type ();
 113
 114   /* the GstMiniObject types need to be class_ref'd once before it can be
 115    * done from multiple threads;
 116    * see http://bugzilla.gnome.org/show_bug.cgi?id=304551 */
 117   ptr = g_type_class_ref (GST_TYPE_BUFFER);
 118   g_type_class_unref (ptr);
 119 }
 120
 121 GType
 122 gst_buffer_get_type (void)
 123 {
 124   static GType _gst_buffer_type;
 125
 126   if (G_UNLIKELY (_gst_buffer_type == 0)) {
 127     static const GTypeInfo buffer_info = {
 128       sizeof (GstBufferClass),
 129       NULL,
 130       NULL,
 131       gst_buffer_class_init,
 132       NULL,
 133       NULL,
 134       sizeof (GstBuffer),
 135       0,
 136       gst_buffer_init,
 137       NULL
 138     };
 139
 140     _gst_buffer_type = g_type_register_static (GST_TYPE_MINI_OBJECT,
 141         "GstBuffer", &buffer_info, 0);
 142   }
 143   return _gst_buffer_type;
 144 }
 145
 146 static void
 147 gst_buffer_class_init (gpointer g_class, gpointer class_data)
 148 {
 149   GstBufferClass *buffer_class = GST_BUFFER_CLASS (g_class);
 150
 151   buffer_class->mini_object_class.copy =
 152       (GstMiniObjectCopyFunction) _gst_buffer_copy;
 153   buffer_class->mini_object_class.finalize =
 154       (GstMiniObjectFinalizeFunction) gst_buffer_finalize;
 155
 156 }
 157
 158 static void
 159 gst_buffer_finalize (GstBuffer * buffer)
 160 {
 161   g_return_if_fail (buffer != NULL);
 162
 163   /* free our data */
 164   if (buffer->malloc_data) {
 165     g_free (buffer->malloc_data);
 166   }
 167
 168   gst_caps_replace (&GST_BUFFER_CAPS (buffer), NULL);
 169 }
 170
 171 static GstBuffer *
 172 _gst_buffer_copy (GstBuffer * buffer)
 173 {
 174   GstBuffer *copy;
 175   guint mask;
 176
 177   g_return_val_if_fail (buffer != NULL, NULL);
 178
 179   /* create a fresh new buffer */
 180   copy = gst_buffer_new ();
 181
 182   GST_CAT_LOG (GST_CAT_BUFFER, "copy %p to %p", buffer, copy);
 183
 184   /* copy relevant flags */
 185   mask = GST_BUFFER_FLAG_PREROLL | GST_BUFFER_FLAG_IN_CAPS |
 186       GST_BUFFER_FLAG_DELTA_UNIT;
 187   GST_MINI_OBJECT (copy)->flags |= GST_MINI_OBJECT (buffer)->flags & mask;
 188
 189   /* we simply copy everything from our parent */
 190   copy->data = g_memdup (buffer->data, buffer->size);
 191   /* make sure it gets freed (even if the parent is subclassed, we return a
 192      normal buffer */
 193   copy->malloc_data = copy->data;
 194
 195   copy->size = buffer->size;
 196
 197   GST_BUFFER_TIMESTAMP (copy) = GST_BUFFER_TIMESTAMP (buffer);
 198   GST_BUFFER_DURATION (copy) = GST_BUFFER_DURATION (buffer);
 199   GST_BUFFER_OFFSET (copy) = GST_BUFFER_OFFSET (buffer);
 200   GST_BUFFER_OFFSET_END (copy) = GST_BUFFER_OFFSET_END (buffer);
 201
 202   if (GST_BUFFER_CAPS (buffer))
 203     GST_BUFFER_CAPS (copy) = gst_caps_ref (GST_BUFFER_CAPS (buffer));
 204   else
 205     GST_BUFFER_CAPS (copy) = NULL;
 206
 207   return copy;
 208 }
 209
 210 static void
 211 gst_buffer_init (GTypeInstance * instance, gpointer g_class)
 212 {
 213   GstBuffer *buffer;
 214
 215   buffer = (GstBuffer *) instance;
 216
 217   GST_CAT_LOG (GST_CAT_BUFFER, "init %p", buffer);
 218
 219   GST_BUFFER_TIMESTAMP (buffer) = GST_CLOCK_TIME_NONE;
 220   GST_BUFFER_DURATION (buffer) = GST_CLOCK_TIME_NONE;
 221   GST_BUFFER_OFFSET (buffer) = GST_BUFFER_OFFSET_NONE;
 222   GST_BUFFER_OFFSET_END (buffer) = GST_BUFFER_OFFSET_NONE;
 223 }
 224
 225 /**
 226  * gst_buffer_new:
 227  *
 228  * Creates a newly allocated buffer without any data.
 229  *
 230  * Returns: the new #GstBuffer.
 231  *
 232  * MT safe.
 233  */
 234 GstBuffer *
 235 gst_buffer_new (void)
 236 {
 237   GstBuffer *newbuf;
 238
 239   newbuf = (GstBuffer *) gst_mini_object_new (GST_TYPE_BUFFER);
 240
 241   GST_CAT_LOG (GST_CAT_BUFFER, "new %p", newbuf);
 242
 243   return newbuf;
 244 }
 245
 246 /**
 247  * gst_buffer_new_and_alloc:
 248  * @size: the size of the new buffer's data.
 249  *
 250  * Creates a newly allocated buffer with data of the given size.
 251  *
 252  * Returns: the new #GstBuffer.
 253  *
 254  * MT safe.
 255  */
 256 GstBuffer *
 257 gst_buffer_new_and_alloc (guint size)
 258 {
 259   GstBuffer *newbuf;
 260
 261   newbuf = gst_buffer_new ();
 262
 263   newbuf->malloc_data = g_malloc (size);
 264   GST_BUFFER_DATA (newbuf) = newbuf->malloc_data;
 265   GST_BUFFER_SIZE (newbuf) = size;
 266
 267   GST_CAT_LOG (GST_CAT_BUFFER, "new %p of size %d", newbuf, size);
 268
 269   return newbuf;
 270 }
 271
 272 /**
 273  * gst_buffer_get_caps:
 274  * @buffer: a #GstBuffer to get the caps of.
 275  *
 276  * Gets the media type of the buffer. This can be NULL if there
 277  * is not media type attached to this buffer or when the media
 278  * type is the same as the previous received buffer.
 279  *
 280  * Returns: a reference to the #GstCaps, or NULL if there were no caps on this
 281  * buffer.
 282  */
 283 /* FIXME can we make this threadsafe without a lock on the buffer?
 284  * We can use compare and swap and atomic reads. */
 285 GstCaps *
 286 gst_buffer_get_caps (GstBuffer * buffer)
 287 {
 288   GstCaps *ret;
 289
 290   g_return_val_if_fail (buffer != NULL, NULL);
 291
 292   ret = GST_BUFFER_CAPS (buffer);
 293
 294   if (ret)
 295     gst_caps_ref (ret);
 296
 297   return ret;
 298 }
 299
 300 /**
 301  * gst_buffer_set_caps:
 302  * @buffer: a #GstBuffer to set the caps of.
 303  * @caps: a #GstCaps to set.
 304  *
 305  * Sets the media type on the buffer. The caps' refcount will
 306  * be increased and any previous caps on the buffer will be
 307  * unreffed.
 308  */
 309 /* FIXME can we make this threadsafe without a lock on the buffer?
 310  * We can use compare and swap and atomic reads. Another idea is to
 311  * not attach the caps to the buffer but use an event to signal a caps
 312  * change. */
 313 void
 314 gst_buffer_set_caps (GstBuffer * buffer, GstCaps * caps)
 315 {
 316   g_return_if_fail (buffer != NULL);
 317
 318   gst_caps_replace (&GST_BUFFER_CAPS (buffer), caps);
 319 }
 320
 321
 322 typedef struct _GstSubBuffer GstSubBuffer;
 323 typedef struct _GstSubBufferClass GstSubBufferClass;
 324
 325 #define GST_TYPE_SUBBUFFER                         (gst_subbuffer_get_type())
 326
 327 #define GST_IS_SUBBUFFER(obj)  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_SUBBUFFER))
 328 #define GST_SUBBUFFER(obj)     (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_SUBBUFFER, GstSubBuffer))
 329
 330 struct _GstSubBuffer
 331 {
 332   GstBuffer buffer;
 333
 334   GstBuffer *parent;
 335 };
 336
 337 struct _GstSubBufferClass
 338 {
 339   GstBufferClass buffer_class;
 340 };
 341
 342 static GstBufferClass *sub_parent_class;
 343
 344 static void gst_subbuffer_init (GTypeInstance * instance, gpointer g_class);
 345 static void gst_subbuffer_class_init (gpointer g_class, gpointer class_data);
 346 static void gst_subbuffer_finalize (GstSubBuffer * buffer);
 347
 348 static GType
 349 gst_subbuffer_get_type (void)
 350 {
 351   static GType _gst_subbuffer_type = 0;
 352
 353   if (G_UNLIKELY (_gst_subbuffer_type == 0)) {
 354     static const GTypeInfo subbuffer_info = {
 355       sizeof (GstSubBufferClass),
 356       NULL,
 357       NULL,
 358       gst_subbuffer_class_init,
 359       NULL,
 360       NULL,
 361       sizeof (GstSubBuffer),
 362       0,
 363       gst_subbuffer_init,
 364       NULL
 365     };
 366
 367     _gst_subbuffer_type = g_type_register_static (GST_TYPE_BUFFER,
 368         "GstSubBuffer", &subbuffer_info, 0);
 369   }
 370   return _gst_subbuffer_type;
 371 }
 372
 373 static void
 374 gst_subbuffer_class_init (gpointer g_class, gpointer class_data)
 375 {
 376   GstBufferClass *buffer_class = GST_BUFFER_CLASS (g_class);
 377
 378   sub_parent_class = g_type_class_ref (GST_TYPE_BUFFER);
 379
 380   buffer_class->mini_object_class.finalize =
 381       (GstMiniObjectFinalizeFunction) gst_subbuffer_finalize;
 382 }
 383
 384 static void
 385 gst_subbuffer_finalize (GstSubBuffer * buffer)
 386 {
 387   gst_buffer_unref (buffer->parent);
 388
 389   GST_MINI_OBJECT_CLASS (sub_parent_class)->finalize (GST_MINI_OBJECT (buffer));
 390 }
 391
 392 static void
 393 gst_subbuffer_init (GTypeInstance * instance, gpointer g_class)
 394 {
 395   GST_BUFFER_FLAG_SET (GST_BUFFER_CAST (instance), GST_BUFFER_FLAG_READONLY);
 396 }
 397
 398 /**
 399  * gst_buffer_create_sub:
 400  * @parent: a parent #GstBuffer to create a subbuffer from.
 401  * @offset: the offset into parent #GstBuffer.
 402  * @size: the size of the new #GstBuffer sub-buffer (with size > 0).
 403  *
 404  * Creates a sub-buffer from the parent at a given offset.
 405  * This sub-buffer uses the actual memory space of the parent buffer.
 406  * This function will copy the offset and timestamp field when the
 407  * offset is 0, else they are set to _NONE.
 408  * The duration field of the new buffer are set to GST_CLOCK_TIME_NONE.
 409  *
 410  * Returns: the new #GstBuffer, or NULL if there was an error.
 411  *
 412  * MT safe.
 413  */
 414 GstBuffer *
 415 gst_buffer_create_sub (GstBuffer * buffer, guint offset, guint size)
 416 {
 417   GstSubBuffer *subbuffer;
 418   GstBuffer *parent;
 419
 420   g_return_val_if_fail (buffer != NULL, NULL);
 421   g_return_val_if_fail (buffer->mini_object.refcount > 0, NULL);
 422   g_return_val_if_fail (size > 0, NULL);
 423   g_return_val_if_fail (buffer->size >= offset + size, NULL);
 424
 425   /* find real parent */
 426   if (GST_IS_SUBBUFFER (buffer)) {
 427     parent = GST_SUBBUFFER (buffer)->parent;
 428   } else {
 429     parent = buffer;
 430   }
 431   gst_buffer_ref (parent);
 432
 433   /* create the new buffer */
 434   subbuffer = (GstSubBuffer *) gst_mini_object_new (GST_TYPE_SUBBUFFER);
 435   subbuffer->parent = parent;
 436
 437   GST_CAT_LOG (GST_CAT_BUFFER, "new subbuffer %p (parent %p)", subbuffer,
 438       parent);
 439
 440   /* set the right values in the child */
 441   GST_BUFFER_DATA (GST_BUFFER_CAST (subbuffer)) = buffer->data + offset;
 442   GST_BUFFER_SIZE (GST_BUFFER_CAST (subbuffer)) = size;
 443
 444   /* we can copy the timestamp and offset if the new buffer starts at
 445    * offset 0 */
 446   if (offset == 0) {
 447     GST_BUFFER_TIMESTAMP (subbuffer) = GST_BUFFER_TIMESTAMP (buffer);
 448     GST_BUFFER_OFFSET (subbuffer) = GST_BUFFER_OFFSET (buffer);
 449   } else {
 450     GST_BUFFER_TIMESTAMP (subbuffer) = GST_CLOCK_TIME_NONE;
 451     GST_BUFFER_OFFSET (subbuffer) = GST_BUFFER_OFFSET_NONE;
 452   }
 453
 454   GST_BUFFER_DURATION (subbuffer) = GST_CLOCK_TIME_NONE;
 455   GST_BUFFER_OFFSET_END (subbuffer) = GST_BUFFER_OFFSET_NONE;
 456
 457   GST_BUFFER_CAPS (subbuffer) = NULL;
 458
 459   return GST_BUFFER_CAST (subbuffer);
 460 }
 461
 462 /**
 463  * gst_buffer_is_span_fast:
 464  * @buf1: a first source #GstBuffer.
 465  * @buf2: the second source #GstBuffer.
 466  *
 467  * Determines whether a gst_buffer_span() can be done without copying
 468  * the contents, that is, whether the data areas are contiguous.
 469  *
 470  * Returns: TRUE if the buffers are contiguous,
 471  * FALSE if a copy would be required.
 472  *
 473  * MT safe.
 474  */
 475 gboolean
 476 gst_buffer_is_span_fast (GstBuffer * buf1, GstBuffer * buf2)
 477 {
 478   g_return_val_if_fail (buf1 != NULL && buf2 != NULL, FALSE);
 479   g_return_val_if_fail (buf1->mini_object.refcount > 0, FALSE);
 480   g_return_val_if_fail (buf2->mini_object.refcount > 0, FALSE);
 481
 482   /* it's only fast if we have subbuffers of the same parent */
 483   return (GST_IS_SUBBUFFER (buf1) &&
 484       GST_IS_SUBBUFFER (buf2) &&
 485       (GST_SUBBUFFER (buf1)->parent == GST_SUBBUFFER (buf2)->parent) &&
 486       ((buf1->data + buf1->size) == buf2->data));
 487 }
 488
 489 /**
 490  * gst_buffer_span:
 491  * @buf1: a first source #GstBuffer to merge.
 492  * @offset: the offset in the first buffer from where the new
 493  * buffer should start.
 494  * @buf2: the second source #GstBuffer to merge.
 495  * @len: the total length of the new buffer.
 496  *
 497  * Creates a new buffer that consists of part of buf1 and buf2.
 498  * Logically, buf1 and buf2 are concatenated into a single larger
 499  * buffer, and a new buffer is created at the given offset inside
 500  * this space, with a given length.
 501  *
 502  * If the two source buffers are children of the same larger buffer,
 503  * and are contiguous, the new buffer will be a child of the shared
 504  * parent, and thus no copying is necessary. you can use
 505  * gst_buffer_is_span_fast() to determine if a memcpy will be needed.
 506  *
 507  * Returns: the new #GstBuffer that spans the two source buffers.
 508  *
 509  * MT safe.
 510  */
 511 GstBuffer *
 512 gst_buffer_span (GstBuffer * buf1, guint32 offset, GstBuffer * buf2,
 513     guint32 len)
 514 {
 515   GstBuffer *newbuf;
 516
 517   g_return_val_if_fail (buf1 != NULL && buf2 != NULL, NULL);
 518   g_return_val_if_fail (buf1->mini_object.refcount > 0, FALSE);
 519   g_return_val_if_fail (buf2->mini_object.refcount > 0, FALSE);
 520   g_return_val_if_fail (len > 0, NULL);
 521   g_return_val_if_fail (len <= buf1->size + buf2->size - offset, NULL);
 522
 523   /* if the two buffers have the same parent and are adjacent */
 524   if (gst_buffer_is_span_fast (buf1, buf2)) {
 525     GstBuffer *parent = GST_SUBBUFFER (buf1)->parent;
 526
 527     /* we simply create a subbuffer of the common parent */
 528     newbuf = gst_buffer_create_sub (parent,
 529         buf1->data - parent->data + offset, len);
 530   } else {
 531     GST_CAT_DEBUG (GST_CAT_BUFFER,
 532         "slow path taken while spanning buffers %p and %p", buf1, buf2);
 533     /* otherwise we simply have to brute-force copy the buffers */
 534     newbuf = gst_buffer_new_and_alloc (len);
 535
 536     /* copy the first buffer's data across */
 537     memcpy (newbuf->data, buf1->data + offset, buf1->size - offset);
 538     /* copy the second buffer's data across */
 539     memcpy (newbuf->data + (buf1->size - offset), buf2->data,
 540         len - (buf1->size - offset));
 541     /* if the offset is 0, the new buffer has the same timestamp as buf1 */
 542     if (offset == 0) {
 543       GST_BUFFER_OFFSET (newbuf) = GST_BUFFER_OFFSET (buf1);
 544       GST_BUFFER_TIMESTAMP (newbuf) = GST_BUFFER_TIMESTAMP (buf1);
 545     }
 546   }
 547   /* if we completely merged the two buffers (appended), we can
 548    * calculate the duration too. Also make sure we's not messing with
 549    * invalid DURATIONS */
 550   if (offset == 0 && buf1->size + buf2->size == len) {
 551     if (GST_BUFFER_DURATION_IS_VALID (buf1) &&
 552         GST_BUFFER_DURATION_IS_VALID (buf2)) {
 553       /* add duration */
 554       GST_BUFFER_DURATION (newbuf) = GST_BUFFER_DURATION (buf1) +
 555           GST_BUFFER_DURATION (buf2);
 556     }
 557     if (GST_BUFFER_OFFSET_END_IS_VALID (buf2)) {
 558       /* add offset_end */
 559       GST_BUFFER_OFFSET_END (newbuf) = GST_BUFFER_OFFSET_END (buf2);
 560     }
 561   }
 562
 563   return newbuf;
 564 }