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 /* this file makes too much noise for most debugging sessions */
  24 #define GST_DEBUG_FORCE_DISABLE
  25 #include "gst_private.h"
  26
  27 #include "gstatomic_impl.h"
  28 #include "gstdata_private.h"
  29 #include "gstbuffer.h"
  30 #include "gstmemchunk.h"
  31 #include "gstlog.h"
  32 #include "gstbufferpool-default.h"
  33
  34 GType _gst_buffer_type;
  35 GType _gst_buffer_pool_type;
  36
  37 #ifndef GST_DISABLE_TRACE
  38 /* #define GST_WITH_ALLOC_TRACE  */
  39 #include "gsttrace.h"
  40
  41 static GstAllocTrace *_gst_buffer_trace;
  42 static GstAllocTrace *_gst_buffer_pool_trace;
  43 #endif
  44
  45 static GstMemChunk *chunk;
  46
  47 void
  48 _gst_buffer_initialize (void)
  49 {
  50   _gst_buffer_type = g_boxed_type_register_static ("GstBuffer",
  51                        (GBoxedCopyFunc) gst_data_ref,
  52                        (GBoxedFreeFunc) gst_data_unref);
  53
  54   _gst_buffer_pool_type = g_boxed_type_register_static ("GstBufferPool",
  55                             (GBoxedCopyFunc) gst_data_ref,
  56                             (GBoxedFreeFunc) gst_data_unref);
  57
  58 #ifndef GST_DISABLE_TRACE
  59   _gst_buffer_trace = gst_alloc_trace_register (GST_BUFFER_TRACE_NAME);
  60   _gst_buffer_pool_trace = gst_alloc_trace_register (GST_BUFFER_POOL_TRACE_NAME);
  61 #endif
  62
  63   chunk = gst_mem_chunk_new ("GstBufferChunk", sizeof (GstBuffer),
  64                              sizeof (GstBuffer) * 200, 0);
  65
  66   GST_INFO (GST_CAT_BUFFER, "Buffers are initialized now");
  67 }
  68
  69 GType
  70 gst_buffer_get_type (void)
  71 {
  72   return _gst_buffer_type;
  73 }
  74
  75 static void
  76 _gst_buffer_free_to_pool (GstBuffer *buffer)
  77 {
  78   GstBufferPool *pool = buffer->pool;
  79
  80   pool->buffer_free (pool, buffer, pool->user_data);
  81
  82   gst_data_unref (GST_DATA (pool));
  83 }
  84
  85 static void
  86 _gst_buffer_sub_free (GstBuffer *buffer)
  87 {
  88   gst_data_unref (GST_DATA (buffer->pool_private));
  89
  90   GST_BUFFER_DATA (buffer) = NULL;
  91   GST_BUFFER_SIZE (buffer) = 0;
  92
  93   _GST_DATA_DISPOSE (GST_DATA (buffer));
  94
  95   gst_mem_chunk_free (chunk, GST_DATA (buffer));
  96 #ifndef GST_DISABLE_TRACE
  97   gst_alloc_trace_free (_gst_buffer_trace, buffer);
  98 #endif
  99 }
 100
 101 /**
 102  * gst_buffer_default_free:
 103  * @buffer: a #GstBuffer to free.
 104  *
 105  * Frees the memory associated with the buffer including the buffer data,
 106  * unless the GST_BUFFER_DONTFREE flags was set or the buffer data is NULL.
 107  * This function is used by buffer pools.
 108  */
 109 void
 110 gst_buffer_default_free (GstBuffer *buffer)
 111 {
 112   g_return_if_fail (buffer != NULL);
 113
 114   /* free our data */
 115   if (!GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_DONTFREE) && GST_BUFFER_DATA (buffer))
 116     g_free (GST_BUFFER_DATA (buffer));
 117
 118   /* set to safe values */
 119   GST_BUFFER_DATA (buffer) = NULL;
 120   GST_BUFFER_SIZE (buffer) = 0;
 121
 122   _GST_DATA_DISPOSE (GST_DATA (buffer));
 123
 124   gst_mem_chunk_free (chunk, GST_DATA (buffer));
 125 #ifndef GST_DISABLE_TRACE
 126   gst_alloc_trace_free (_gst_buffer_trace, buffer);
 127 #endif
 128 }
 129
 130 static GstBuffer*
 131 _gst_buffer_copy_from_pool (GstBuffer *buffer)
 132 {
 133   return buffer->pool->buffer_copy (buffer->pool, buffer, buffer->pool->user_data);
 134 }
 135
 136 /**
 137  * gst_buffer_default_copy:
 138  * @buffer: a #GstBuffer to make a copy of.
 139  *
 140  * Make a full newly allocated copy of the given buffer, data and all.
 141  * This function is used by buffer pools.
 142  *
 143  * Returns: the new #GstBuffer.
 144  */
 145 GstBuffer*
 146 gst_buffer_default_copy (GstBuffer *buffer)
 147 {
 148   GstBuffer *copy;
 149
 150   g_return_val_if_fail (buffer != NULL, NULL);
 151
 152   /* create a fresh new buffer */
 153   copy = gst_buffer_new ();
 154
 155   /* we simply copy everything from our parent */
 156   GST_BUFFER_DATA (copy)        = g_memdup (GST_BUFFER_DATA (buffer),
 157                                             GST_BUFFER_SIZE (buffer));
 158   GST_BUFFER_SIZE (copy)        = GST_BUFFER_SIZE (buffer);
 159   GST_BUFFER_MAXSIZE (copy)     = GST_BUFFER_MAXSIZE (buffer);
 160   GST_BUFFER_TIMESTAMP (copy)   = GST_BUFFER_TIMESTAMP (buffer);
 161   GST_BUFFER_OFFSET (copy)      = GST_BUFFER_OFFSET (buffer);
 162
 163   return copy;
 164 }
 165
 166 /**
 167  * gst_buffer_new:
 168  *
 169  * Creates a newly allocated buffer without any data.
 170  *
 171  * Returns: the new #GstBuffer.
 172  */
 173 GstBuffer*
 174 gst_buffer_new (void)
 175 {
 176   GstBuffer *buf;
 177
 178   buf = gst_mem_chunk_alloc0 (chunk);
 179 #ifndef GST_DISABLE_TRACE
 180   gst_alloc_trace_new (_gst_buffer_trace, buf);
 181 #endif
 182
 183   GST_DEBUG (GST_CAT_BUFFER, "new %p", buf);
 184
 185   _GST_DATA_INIT (GST_DATA (buf),
 186                   _gst_buffer_type,
 187                   0,
 188                   (GstDataFreeFunction) gst_buffer_default_free,
 189                   (GstDataCopyFunction) gst_buffer_default_copy);
 190
 191   GST_BUFFER_TIMESTAMP (buf) = GST_CLOCK_TIME_NONE;
 192
 193   return buf;
 194 }
 195
 196 /**
 197  * gst_buffer_new_and_alloc:
 198  * @size: the size of the new buffer's data.
 199  *
 200  * Creates a newly allocated buffer with data of the given size.
 201  *
 202  * Returns: the new #GstBuffer.
 203  */
 204 GstBuffer*
 205 gst_buffer_new_and_alloc (guint size)
 206 {
 207   GstBuffer *new;
 208
 209   new = gst_buffer_new ();
 210
 211   GST_BUFFER_DATA (new) = g_malloc (size);
 212   GST_BUFFER_SIZE (new) = size;
 213
 214   return new;
 215 }
 216
 217 /**
 218  * gst_buffer_new_from_pool:
 219  * @pool: a #GstBufferPool to use.
 220  * @offset: the offset of the new buffer.
 221  * @size: the size of the new buffer.
 222  *
 223  * Creates a newly allocated buffer using the specified buffer pool,
 224  * offset and size.
 225  *
 226  * Returns: the new #GstBuffer, or NULL if there was an error.
 227  */
 228 GstBuffer*
 229 gst_buffer_new_from_pool (GstBufferPool *pool,
 230                           guint64 offset, guint size)
 231 {
 232   GstBuffer *buffer;
 233
 234   g_return_val_if_fail (pool != NULL, NULL);
 235
 236   buffer = pool->buffer_new (pool, offset, size, pool->user_data);
 237   if (!buffer)
 238     return NULL;
 239
 240   GST_BUFFER_BUFFERPOOL (buffer) = pool;
 241   gst_data_ref (GST_DATA (pool));
 242
 243   /* override the buffer refcount functions with those from the pool (if any) */
 244   if (pool->buffer_free)
 245     GST_DATA (buffer)->free = (GstDataFreeFunction)_gst_buffer_free_to_pool;
 246   if (pool->buffer_copy)
 247     GST_DATA (buffer)->copy = (GstDataCopyFunction)_gst_buffer_copy_from_pool;
 248
 249   return buffer;
 250 }
 251
 252 /**
 253  * gst_buffer_create_sub:
 254  * @parent: a parent #GstBuffer to create a subbuffer from.
 255  * @offset: the offset into parent #GstBuffer.
 256  * @size: the size of the new #GstBuffer sub-buffer (with size > 0).
 257  *
 258  * Creates a sub-buffer from the parent at a given offset.
 259  * This sub-buffer uses the actual memory space of the parent buffer.
 260  *
 261  * Returns: the new #GstBuffer, or NULL if there was an error.
 262  */
 263 GstBuffer*
 264 gst_buffer_create_sub (GstBuffer *parent, guint offset, guint size)
 265 {
 266   GstBuffer *buffer;
 267   gpointer buffer_data;
 268   guint64 parent_offset;
 269
 270   g_return_val_if_fail (parent != NULL, NULL);
 271   g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (parent) > 0, NULL);
 272   g_return_val_if_fail (size > 0, NULL);
 273   g_return_val_if_fail (parent->size >= offset + size, NULL);
 274
 275   /* remember the data for the new buffer */
 276   buffer_data = parent->data + offset;
 277   parent_offset = GST_BUFFER_OFFSET (parent);
 278   /* make sure we're child not child from a child buffer */
 279   while (GST_BUFFER_FLAG_IS_SET (parent, GST_BUFFER_SUBBUFFER)) {
 280     parent = GST_BUFFER (parent->pool_private);
 281   }
 282   /* ref the real parent */
 283   gst_data_ref (GST_DATA (parent));
 284   /* make sure nobody overwrites data in the parent */
 285   GST_DATA_FLAG_SET (parent, GST_DATA_READONLY);
 286
 287   /* create the new buffer */
 288   buffer = gst_mem_chunk_alloc0 (chunk);
 289 #ifndef GST_DISABLE_TRACE
 290   gst_alloc_trace_new (_gst_buffer_trace, buffer);
 291 #endif
 292
 293   GST_DEBUG (GST_CAT_BUFFER, "new %p", buf);
 294
 295   /* make sure nobody overwrites data in the new buffer
 296    * by setting the READONLY flag */
 297   _GST_DATA_INIT (GST_DATA (buffer),
 298                   _gst_buffer_type,
 299                   GST_DATA_FLAG_SHIFT (GST_BUFFER_SUBBUFFER) |
 300                   GST_DATA_FLAG_SHIFT (GST_DATA_READONLY),
 301                   (GstDataFreeFunction) _gst_buffer_sub_free,
 302                   (GstDataCopyFunction) gst_buffer_default_copy);
 303
 304   GST_BUFFER_OFFSET (buffer) = parent_offset + offset;
 305   GST_BUFFER_TIMESTAMP (buffer) = -1;
 306   GST_BUFFER_BUFFERPOOL (buffer) = NULL;
 307   GST_BUFFER_POOL_PRIVATE (buffer) = parent;
 308
 309   /* set the right values in the child */
 310   buffer->data = buffer_data;
 311   buffer->size = size;
 312
 313   return buffer;
 314 }
 315
 316
 317 /**
 318  * gst_buffer_merge:
 319  * @buf1: a first source #GstBuffer to merge.
 320  * @buf2: the second source #GstBuffer to merge.
 321  *
 322  * Create a new buffer that is the concatenation of the two source
 323  * buffers.  The original source buffers will not be modified or
 324  * unref'd.
 325  *
 326  * Internally is nothing more than a specialized gst_buffer_span(),
 327  * so the same optimizations can occur.
 328  *
 329  * Returns: the new #GstBuffer that's the concatenation of the source buffers.
 330  */
 331 GstBuffer*
 332 gst_buffer_merge (GstBuffer *buf1, GstBuffer *buf2)
 333 {
 334   GstBuffer *result;
 335
 336   /* we're just a specific case of the more general gst_buffer_span() */
 337   result = gst_buffer_span (buf1, 0, buf2, buf1->size + buf2->size);
 338
 339   return result;
 340 }
 341
 342 /**
 343  * gst_buffer_is_span_fast:
 344  * @buf1: a first source #GstBuffer.
 345  * @buf2: the second source #GstBuffer.
 346  *
 347  * Determines whether a gst_buffer_span() is free (as in free beer),
 348  * or requires a memcpy.
 349  *
 350  * Returns: TRUE if the buffers are contiguous,
 351  * FALSE if a copy would be required.
 352  */
 353 gboolean
 354 gst_buffer_is_span_fast (GstBuffer *buf1, GstBuffer *buf2)
 355 {
 356   g_return_val_if_fail (buf1 != NULL && buf2 != NULL, FALSE);
 357   g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (buf1) > 0, FALSE);
 358   g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (buf2) > 0, FALSE);
 359
 360   /* it's only fast if we have subbuffers of the same parent */
 361   return ((GST_BUFFER_FLAG_IS_SET (buf1, GST_BUFFER_SUBBUFFER)) &&
 362           (GST_BUFFER_FLAG_IS_SET (buf2, GST_BUFFER_SUBBUFFER)) &&
 363           (buf1->pool_private == buf2->pool_private) &&
 364           ((buf1->data + buf1->size) == buf2->data));
 365 }
 366
 367 /**
 368  * gst_buffer_span:
 369  * @buf1: a first source #GstBuffer to merge.
 370  * @offset: the offset in the first buffer from where the new
 371  * buffer should start.
 372  * @buf2: the second source #GstBuffer to merge.
 373  * @len: the total length of the new buffer.
 374  *
 375  * Creates a new buffer that consists of part of buf1 and buf2.
 376  * Logically, buf1 and buf2 are concatenated into a single larger
 377  * buffer, and a new buffer is created at the given offset inside
 378  * this space, with a given length.
 379  *
 380  * If the two source buffers are children of the same larger buffer,
 381  * and are contiguous, the new buffer will be a child of the shared
 382  * parent, and thus no copying is necessary. you can use
 383  * gst_buffer_is_span_fast() to determine if a memcpy will be needed.
 384  *
 385  * Returns: the new #GstBuffer that spans the two source buffers.
 386  */
 387 GstBuffer*
 388 gst_buffer_span (GstBuffer *buf1, guint32 offset, GstBuffer *buf2, guint32 len)
 389 {
 390   GstBuffer *newbuf;
 391
 392   g_return_val_if_fail (buf1 != NULL && buf2 != NULL, FALSE);
 393   g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (buf1) > 0, NULL);
 394   g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (buf2) > 0, NULL);
 395   g_return_val_if_fail (len > 0, NULL);
 396
 397   /* if the two buffers have the same parent and are adjacent */
 398   if (gst_buffer_is_span_fast (buf1, buf2)) {
 399     GstBuffer *parent = GST_BUFFER (buf1->pool_private);
 400     /* we simply create a subbuffer of the common parent */
 401     newbuf = gst_buffer_create_sub (parent,
 402                                     buf1->data - parent->data + offset, len);
 403   }
 404   else {
 405     GST_DEBUG (GST_CAT_BUFFER, "slow path taken while spanning buffers %p and %p",
 406                buf1, buf2);
 407     /* otherwise we simply have to brute-force copy the buffers */
 408     newbuf = gst_buffer_new_and_alloc (len);
 409
 410     /* copy relevant stuff from data struct of buffer1 */
 411     GST_BUFFER_OFFSET (newbuf) = GST_BUFFER_OFFSET (buf1) + offset;
 412
 413     /* copy the first buffer's data across */
 414     memcpy (newbuf->data, buf1->data + offset, buf1->size - offset);
 415     /* copy the second buffer's data across */
 416     memcpy (newbuf->data + (buf1->size - offset), buf2->data,
 417             len - (buf1->size - offset));
 418   }
 419   /* if the offset is 0, the new buffer has the same timestamp as buf1 */
 420   if (offset == 0)
 421     GST_BUFFER_TIMESTAMP (newbuf) = GST_BUFFER_TIMESTAMP (buf1);
 422
 423   return newbuf;
 424 }
 425
 426 GType
 427 gst_buffer_pool_get_type (void)
 428 {
 429   return _gst_buffer_pool_type;
 430 }
 431
 432 /**
 433  * gst_buffer_pool_default_free:
 434  * @pool: a #GstBufferPool to free.
 435  *
 436  * Frees the memory associated with the bufferpool.
 437  */
 438 void
 439 gst_buffer_pool_default_free (GstBufferPool *pool)
 440 {
 441   g_return_if_fail (pool != NULL);
 442
 443   _GST_DATA_DISPOSE (GST_DATA (pool));
 444   g_free (pool);
 445 #ifndef GST_DISABLE_TRACE
 446   gst_alloc_trace_free (_gst_buffer_pool_trace, pool);
 447 #endif
 448 }
 449
 450 /**
 451  * gst_buffer_pool_new:
 452  * @free: the #GstDataFreeFunction to free the buffer pool.
 453  * @copy: the #GstDataCopyFunction to copy the buffer pool.
 454  * @buffer_new: the #GstBufferPoolBufferNewFunction to create a new buffer
 455  *              from this pool
 456  * @buffer_copy: the #GstBufferPoolBufferCopyFunction to copy a buffer
 457  *               from this pool
 458  * @buffer_free: the #GstBufferPoolBufferFreeFunction to free a buffer
 459  *               in this pool
 460  * @user_data: the user data gpointer passed to buffer_* functions.
 461  *
 462  * Creates a new buffer pool with the given functions.
 463  *
 464  * Returns: a new #GstBufferPool, or NULL on error.
 465  */
 466 GstBufferPool*
 467 gst_buffer_pool_new (GstDataFreeFunction free,
 468                      GstDataCopyFunction copy,
 469                      GstBufferPoolBufferNewFunction buffer_new,
 470                      GstBufferPoolBufferCopyFunction buffer_copy,
 471                      GstBufferPoolBufferFreeFunction buffer_free,
 472                      gpointer user_data)
 473 {
 474   GstBufferPool *pool;
 475
 476   /* we need at least a buffer_new function */
 477   g_return_val_if_fail (buffer_new != NULL, NULL);
 478
 479   pool = g_new0 (GstBufferPool, 1);
 480 #ifndef GST_DISABLE_TRACE
 481   gst_alloc_trace_new (_gst_buffer_pool_trace, pool);
 482 #endif
 483
 484   GST_DEBUG (GST_CAT_BUFFER, "allocating new buffer pool %p\n", pool);
 485
 486   /* init data struct */
 487   _GST_DATA_INIT (GST_DATA (pool),
 488                   _gst_buffer_pool_type,
 489                   0,
 490                   (free ? free : (GstDataFreeFunction) gst_buffer_pool_default_free),
 491                   copy);
 492
 493   /* set functions */
 494   pool->buffer_new = buffer_new;
 495   pool->buffer_copy = buffer_copy;
 496   pool->buffer_free = buffer_free;
 497   pool->user_data = user_data;
 498
 499   return pool;
 500 }
 501
 502 /**
 503  * gst_buffer_pool_is_active:
 504  * @pool: the #GstBufferPool to query.
 505  *
 506  * Queries if the given buffer pool is active.
 507  *
 508  * Returns: TRUE if the pool is active.
 509  */
 510 gboolean
 511 gst_buffer_pool_is_active (GstBufferPool *pool)
 512 {
 513   g_return_val_if_fail (pool != NULL, FALSE);
 514
 515   return pool->active;
 516 }
 517
 518 /**
 519  * gst_buffer_pool_set_active:
 520  * @pool: a #GstBufferPool to set the activity status on.
 521  * @active: the new status of the pool.
 522  *
 523  * Sets the given pool to the active or inactive state depending on the
 524  * active parameter.
 525  */
 526 void
 527 gst_buffer_pool_set_active (GstBufferPool *pool, gboolean active)
 528 {
 529   g_return_if_fail (pool != NULL);
 530
 531   pool->active = active;
 532 }
 533
 534 /**
 535  * gst_buffer_pool_set_user_data:
 536  * @pool: the #GstBufferPool to set the user data for.
 537  * @user_data: the user_data to set on the buffer pool.
 538  *
 539  * Sets the given user data on the buffer pool.
 540  */
 541 void
 542 gst_buffer_pool_set_user_data (GstBufferPool *pool, gpointer user_data)
 543 {
 544   g_return_if_fail (pool != NULL);
 545
 546   pool->user_data = user_data;
 547 }
 548
 549 /**
 550  * gst_buffer_pool_get_user_data:
 551  * @pool: the #GstBufferPool to get the user data for.
 552  *
 553  * Gets the user data of the buffer pool.
 554  *
 555  * Returns: the user data associated with this buffer pool.
 556  */
 557 gpointer
 558 gst_buffer_pool_get_user_data (GstBufferPool *pool)
 559 {
 560   g_return_val_if_fail (pool != NULL, NULL);
 561
 562   return pool->user_data;
 563 }