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_mem_chunk_alloc (chunk);
 154 #ifndef GST_DISABLE_TRACE
 155   gst_alloc_trace_new (_gst_buffer_trace, copy);
 156 #endif
 157
 158   _GST_DATA_INIT (GST_DATA (copy),
 159                   _gst_buffer_type,
 160                   0,
 161                   (GstDataFreeFunction) gst_buffer_default_free,
 162                   (GstDataCopyFunction) gst_buffer_default_copy);
 163
 164   /* we simply copy everything from our parent */
 165   GST_BUFFER_DATA (copy)         = g_memdup (GST_BUFFER_DATA (buffer),
 166                                              GST_BUFFER_SIZE (buffer));
 167   GST_BUFFER_SIZE (copy)         = GST_BUFFER_SIZE (buffer);
 168   GST_BUFFER_MAXSIZE (copy)      = GST_BUFFER_MAXSIZE (buffer);
 169   GST_BUFFER_TIMESTAMP (copy)    = GST_BUFFER_TIMESTAMP (buffer);
 170   GST_BUFFER_OFFSET (copy)       = GST_BUFFER_OFFSET (buffer);
 171   GST_BUFFER_BUFFERPOOL (copy)   = NULL;
 172   GST_BUFFER_POOL_PRIVATE (copy) = NULL;
 173
 174   return copy;
 175 }
 176
 177 /**
 178  * gst_buffer_new:
 179  *
 180  * Creates a newly allocated buffer without any data.
 181  *
 182  * Returns: the new #GstBuffer.
 183  */
 184 GstBuffer*
 185 gst_buffer_new (void)
 186 {
 187   GstBuffer *buf;
 188
 189   buf = gst_mem_chunk_alloc (chunk);
 190 #ifndef GST_DISABLE_TRACE
 191   gst_alloc_trace_new (_gst_buffer_trace, buf);
 192 #endif
 193
 194   GST_DEBUG (GST_CAT_BUFFER, "new %p", buf);
 195
 196   _GST_DATA_INIT (GST_DATA (buf),
 197                   _gst_buffer_type,
 198                   0,
 199                   (GstDataFreeFunction) gst_buffer_default_free,
 200                   (GstDataCopyFunction) gst_buffer_default_copy);
 201
 202   GST_BUFFER_DATA (buf)         = NULL;
 203   GST_BUFFER_SIZE (buf)         = 0;
 204   GST_BUFFER_MAXSIZE (buf)      = 0;
 205   GST_BUFFER_TIMESTAMP (buf)    = GST_CLOCK_TIME_NONE;
 206   GST_BUFFER_OFFSET (buf)       = 0;
 207   GST_BUFFER_BUFFERPOOL (buf)   = NULL;
 208   GST_BUFFER_POOL_PRIVATE (buf) = NULL;
 209
 210   return buf;
 211 }
 212
 213 /**
 214  * gst_buffer_new_and_alloc:
 215  * @size: the size of the new buffer's data.
 216  *
 217  * Creates a newly allocated buffer with data of the given size.
 218  *
 219  * Returns: the new #GstBuffer.
 220  */
 221 GstBuffer*
 222 gst_buffer_new_and_alloc (guint size)
 223 {
 224   GstBuffer *new;
 225
 226   new = gst_buffer_new ();
 227
 228   GST_BUFFER_DATA (new) = g_malloc (size);
 229   GST_BUFFER_SIZE (new) = size;
 230
 231   return new;
 232 }
 233
 234 /**
 235  * gst_buffer_new_from_pool:
 236  * @pool: a #GstBufferPool to use.
 237  * @offset: the offset of the new buffer.
 238  * @size: the size of the new buffer.
 239  *
 240  * Creates a newly allocated buffer using the specified buffer pool,
 241  * offset and size.
 242  *
 243  * Returns: the new #GstBuffer, or NULL if there was an error.
 244  */
 245 GstBuffer*
 246 gst_buffer_new_from_pool (GstBufferPool *pool,
 247                           guint64 offset, guint size)
 248 {
 249   GstBuffer *buffer;
 250
 251   g_return_val_if_fail (pool != NULL, NULL);
 252
 253   gst_data_ref (GST_DATA (pool));
 254
 255   buffer = pool->buffer_new (pool, offset, size, pool->user_data);
 256   if (!buffer)
 257     return NULL;
 258
 259   GST_BUFFER_BUFFERPOOL (buffer) = pool;
 260
 261   /* override the buffer refcount functions with those from the pool (if any) */
 262   if (pool->buffer_free)
 263     GST_DATA (buffer)->free = (GstDataFreeFunction)_gst_buffer_free_to_pool;
 264   if (pool->buffer_copy)
 265     GST_DATA (buffer)->copy = (GstDataCopyFunction)_gst_buffer_copy_from_pool;
 266
 267   return buffer;
 268 }
 269
 270 /**
 271  * gst_buffer_create_sub:
 272  * @parent: a parent #GstBuffer to create a subbuffer from.
 273  * @offset: the offset into parent #GstBuffer.
 274  * @size: the size of the new #GstBuffer sub-buffer (with size > 0).
 275  *
 276  * Creates a sub-buffer from the parent at a given offset.
 277  * This sub-buffer uses the actual memory space of the parent buffer.
 278  *
 279  * Returns: the new #GstBuffer, or NULL if there was an error.
 280  */
 281 GstBuffer*
 282 gst_buffer_create_sub (GstBuffer *parent, guint offset, guint size)
 283 {
 284   GstBuffer *buffer;
 285   gpointer buffer_data;
 286   guint64 parent_offset;
 287
 288   g_return_val_if_fail (parent != NULL, NULL);
 289   g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (parent) > 0, NULL);
 290   g_return_val_if_fail (size > 0, NULL);
 291   g_return_val_if_fail (parent->size >= offset + size, NULL);
 292
 293   /* remember the data for the new buffer */
 294   buffer_data = parent->data + offset;
 295   parent_offset = GST_BUFFER_OFFSET (parent);
 296   /* make sure we're child not child from a child buffer */
 297   while (GST_BUFFER_FLAG_IS_SET (parent, GST_BUFFER_SUBBUFFER)) {
 298     parent = GST_BUFFER (parent->pool_private);
 299   }
 300   /* ref the real parent */
 301   gst_data_ref (GST_DATA (parent));
 302   /* make sure nobody overwrites data in the parent */
 303   GST_DATA_FLAG_SET (parent, GST_DATA_READONLY);
 304
 305   /* create the new buffer */
 306   buffer = gst_mem_chunk_alloc (chunk);
 307 #ifndef GST_DISABLE_TRACE
 308   gst_alloc_trace_new (_gst_buffer_trace, buffer);
 309 #endif
 310
 311   GST_DEBUG (GST_CAT_BUFFER, "new %p", buf);
 312
 313   /* make sure nobody overwrites data in the new buffer
 314    * by setting the READONLY flag */
 315   _GST_DATA_INIT (GST_DATA (buffer),
 316                   _gst_buffer_type,
 317                   GST_DATA_FLAG_SHIFT (GST_BUFFER_SUBBUFFER) |
 318                   GST_DATA_FLAG_SHIFT (GST_DATA_READONLY),
 319                   (GstDataFreeFunction) _gst_buffer_sub_free,
 320                   (GstDataCopyFunction) gst_buffer_default_copy);
 321
 322   /* set the right values in the child */
 323   GST_BUFFER_DATA (buffer)         = buffer_data;
 324   GST_BUFFER_SIZE (buffer)         = size;
 325   GST_BUFFER_MAXSIZE (buffer)      = size;
 326   GST_BUFFER_TIMESTAMP (buffer)    = GST_CLOCK_TIME_NONE;
 327   GST_BUFFER_OFFSET (buffer)       = parent_offset + offset;
 328   GST_BUFFER_BUFFERPOOL (buffer)   = NULL;
 329   GST_BUFFER_POOL_PRIVATE (buffer) = parent;
 330
 331   return buffer;
 332 }
 333
 334
 335 /**
 336  * gst_buffer_merge:
 337  * @buf1: a first source #GstBuffer to merge.
 338  * @buf2: the second source #GstBuffer to merge.
 339  *
 340  * Create a new buffer that is the concatenation of the two source
 341  * buffers.  The original source buffers will not be modified or
 342  * unref'd.
 343  *
 344  * Internally is nothing more than a specialized gst_buffer_span(),
 345  * so the same optimizations can occur.
 346  *
 347  * Returns: the new #GstBuffer that's the concatenation of the source buffers.
 348  */
 349 GstBuffer*
 350 gst_buffer_merge (GstBuffer *buf1, GstBuffer *buf2)
 351 {
 352   GstBuffer *result;
 353
 354   /* we're just a specific case of the more general gst_buffer_span() */
 355   result = gst_buffer_span (buf1, 0, buf2, buf1->size + buf2->size);
 356
 357   return result;
 358 }
 359
 360 /**
 361  * gst_buffer_is_span_fast:
 362  * @buf1: a first source #GstBuffer.
 363  * @buf2: the second source #GstBuffer.
 364  *
 365  * Determines whether a gst_buffer_span() is free (as in free beer),
 366  * or requires a memcpy.
 367  *
 368  * Returns: TRUE if the buffers are contiguous,
 369  * FALSE if a copy would be required.
 370  */
 371 gboolean
 372 gst_buffer_is_span_fast (GstBuffer *buf1, GstBuffer *buf2)
 373 {
 374   g_return_val_if_fail (buf1 != NULL && buf2 != NULL, FALSE);
 375   g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (buf1) > 0, FALSE);
 376   g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (buf2) > 0, FALSE);
 377
 378   /* it's only fast if we have subbuffers of the same parent */
 379   return ((GST_BUFFER_FLAG_IS_SET (buf1, GST_BUFFER_SUBBUFFER)) &&
 380           (GST_BUFFER_FLAG_IS_SET (buf2, GST_BUFFER_SUBBUFFER)) &&
 381           (buf1->pool_private == buf2->pool_private) &&
 382           ((buf1->data + buf1->size) == buf2->data));
 383 }
 384
 385 /**
 386  * gst_buffer_span:
 387  * @buf1: a first source #GstBuffer to merge.
 388  * @offset: the offset in the first buffer from where the new
 389  * buffer should start.
 390  * @buf2: the second source #GstBuffer to merge.
 391  * @len: the total length of the new buffer.
 392  *
 393  * Creates a new buffer that consists of part of buf1 and buf2.
 394  * Logically, buf1 and buf2 are concatenated into a single larger
 395  * buffer, and a new buffer is created at the given offset inside
 396  * this space, with a given length.
 397  *
 398  * If the two source buffers are children of the same larger buffer,
 399  * and are contiguous, the new buffer will be a child of the shared
 400  * parent, and thus no copying is necessary. you can use
 401  * gst_buffer_is_span_fast() to determine if a memcpy will be needed.
 402  *
 403  * Returns: the new #GstBuffer that spans the two source buffers.
 404  */
 405 GstBuffer*
 406 gst_buffer_span (GstBuffer *buf1, guint32 offset, GstBuffer *buf2, guint32 len)
 407 {
 408   GstBuffer *newbuf;
 409
 410   g_return_val_if_fail (buf1 != NULL && buf2 != NULL, FALSE);
 411   g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (buf1) > 0, NULL);
 412   g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (buf2) > 0, NULL);
 413   g_return_val_if_fail (len > 0, NULL);
 414
 415   /* if the two buffers have the same parent and are adjacent */
 416   if (gst_buffer_is_span_fast (buf1, buf2)) {
 417     GstBuffer *parent = GST_BUFFER (buf1->pool_private);
 418     /* we simply create a subbuffer of the common parent */
 419     newbuf = gst_buffer_create_sub (parent,
 420                                     buf1->data - parent->data + offset, len);
 421   }
 422   else {
 423     GST_DEBUG (GST_CAT_BUFFER, "slow path taken while spanning buffers %p and %p",
 424                buf1, buf2);
 425     /* otherwise we simply have to brute-force copy the buffers */
 426     newbuf = gst_buffer_new_and_alloc (len);
 427
 428     /* copy relevant stuff from data struct of buffer1 */
 429     GST_BUFFER_OFFSET (newbuf) = GST_BUFFER_OFFSET (buf1) + offset;
 430
 431     /* copy the first buffer's data across */
 432     memcpy (newbuf->data, buf1->data + offset, buf1->size - offset);
 433     /* copy the second buffer's data across */
 434     memcpy (newbuf->data + (buf1->size - offset), buf2->data,
 435             len - (buf1->size - offset));
 436   }
 437   /* if the offset is 0, the new buffer has the same timestamp as buf1 */
 438   if (offset == 0)
 439     GST_BUFFER_TIMESTAMP (newbuf) = GST_BUFFER_TIMESTAMP (buf1);
 440
 441   return newbuf;
 442 }
 443
 444 GType
 445 gst_buffer_pool_get_type (void)
 446 {
 447   return _gst_buffer_pool_type;
 448 }
 449
 450 /**
 451  * gst_buffer_pool_default_free:
 452  * @pool: a #GstBufferPool to free.
 453  *
 454  * Frees the memory associated with the bufferpool.
 455  */
 456 void
 457 gst_buffer_pool_default_free (GstBufferPool *pool)
 458 {
 459   g_return_if_fail (pool != NULL);
 460
 461   _GST_DATA_DISPOSE (GST_DATA (pool));
 462   g_free (pool);
 463 #ifndef GST_DISABLE_TRACE
 464   gst_alloc_trace_free (_gst_buffer_pool_trace, pool);
 465 #endif
 466 }
 467
 468 /**
 469  * gst_buffer_pool_new:
 470  * @free: the #GstDataFreeFunction to free the buffer pool.
 471  * @copy: the #GstDataCopyFunction to copy the buffer pool.
 472  * @buffer_new: the #GstBufferPoolBufferNewFunction to create a new buffer
 473  *              from this pool
 474  * @buffer_copy: the #GstBufferPoolBufferCopyFunction to copy a buffer
 475  *               from this pool
 476  * @buffer_free: the #GstBufferPoolBufferFreeFunction to free a buffer
 477  *               in this pool
 478  * @user_data: the user data gpointer passed to buffer_* functions.
 479  *
 480  * Creates a new buffer pool with the given functions.
 481  *
 482  * Returns: a new #GstBufferPool, or NULL on error.
 483  */
 484 GstBufferPool*
 485 gst_buffer_pool_new (GstDataFreeFunction free,
 486                      GstDataCopyFunction copy,
 487                      GstBufferPoolBufferNewFunction buffer_new,
 488                      GstBufferPoolBufferCopyFunction buffer_copy,
 489                      GstBufferPoolBufferFreeFunction buffer_free,
 490                      gpointer user_data)
 491 {
 492   GstBufferPool *pool;
 493
 494   /* we need at least a buffer_new function */
 495   g_return_val_if_fail (buffer_new != NULL, NULL);
 496
 497   pool = g_new0 (GstBufferPool, 1);
 498 #ifndef GST_DISABLE_TRACE
 499   gst_alloc_trace_new (_gst_buffer_pool_trace, pool);
 500 #endif
 501
 502   GST_DEBUG (GST_CAT_BUFFER, "allocating new buffer pool %p\n", pool);
 503
 504   /* init data struct */
 505   _GST_DATA_INIT (GST_DATA (pool),
 506                   _gst_buffer_pool_type,
 507                   0,
 508                   (free ? free : (GstDataFreeFunction) gst_buffer_pool_default_free),
 509                   copy);
 510
 511   /* set functions */
 512   pool->buffer_new = buffer_new;
 513   pool->buffer_copy = buffer_copy;
 514   pool->buffer_free = buffer_free;
 515   pool->user_data = user_data;
 516
 517   return pool;
 518 }
 519
 520 /**
 521  * gst_buffer_pool_is_active:
 522  * @pool: the #GstBufferPool to query.
 523  *
 524  * Queries if the given buffer pool is active.
 525  *
 526  * Returns: TRUE if the pool is active.
 527  */
 528 gboolean
 529 gst_buffer_pool_is_active (GstBufferPool *pool)
 530 {
 531   g_return_val_if_fail (pool != NULL, FALSE);
 532
 533   return pool->active;
 534 }
 535
 536 /**
 537  * gst_buffer_pool_set_active:
 538  * @pool: a #GstBufferPool to set the activity status on.
 539  * @active: the new status of the pool.
 540  *
 541  * Sets the given pool to the active or inactive state depending on the
 542  * active parameter.
 543  */
 544 void
 545 gst_buffer_pool_set_active (GstBufferPool *pool, gboolean active)
 546 {
 547   g_return_if_fail (pool != NULL);
 548
 549   pool->active = active;
 550 }
 551
 552 /**
 553  * gst_buffer_pool_set_user_data:
 554  * @pool: the #GstBufferPool to set the user data for.
 555  * @user_data: the user_data to set on the buffer pool.
 556  *
 557  * Sets the given user data on the buffer pool.
 558  */
 559 void
 560 gst_buffer_pool_set_user_data (GstBufferPool *pool, gpointer user_data)
 561 {
 562   g_return_if_fail (pool != NULL);
 563
 564   pool->user_data = user_data;
 565 }
 566
 567 /**
 568  * gst_buffer_pool_get_user_data:
 569  * @pool: the #GstBufferPool to get the user data for.
 570  *
 571  * Gets the user data of the buffer pool.
 572  *
 573  * Returns: the user data associated with this buffer pool.
 574  */
 575 gpointer
 576 gst_buffer_pool_get_user_data (GstBufferPool *pool)
 577 {
 578   g_return_val_if_fail (pool != NULL, NULL);
 579
 580   return pool->user_data;
 581 }