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 #include "gst_private.h"
  24
  25 #include "gstatomic_impl.h"
  26 #include "gstdata_private.h"
  27 #include "gstbuffer.h"
  28 #include "gstmemchunk.h"
  29 #include "gstinfo.h"
  30
  31 GType _gst_buffer_type;
  32
  33 #ifndef GST_DISABLE_TRACE
  34 /* #define GST_WITH_ALLOC_TRACE  */
  35 #include "gsttrace.h"
  36
  37 static GstAllocTrace *_gst_buffer_trace;
  38 #endif
  39
  40 static GstMemChunk *chunk;
  41
  42 static GstBuffer *gst_buffer_alloc_chunk (void);
  43 static void gst_buffer_free_chunk (GstBuffer * buffer);
  44
  45 void
  46 _gst_buffer_initialize (void)
  47 {
  48   gst_buffer_get_type ();
  49
  50 #ifndef GST_DISABLE_TRACE
  51   _gst_buffer_trace = gst_alloc_trace_register (GST_BUFFER_TRACE_NAME);
  52 #endif
  53
  54   chunk = gst_mem_chunk_new ("GstBufferChunk", sizeof (GstBuffer),
  55       sizeof (GstBuffer) * 200, 0);
  56
  57   GST_CAT_LOG (GST_CAT_BUFFER, "Buffers are initialized now");
  58 }
  59
  60 GType
  61 gst_buffer_get_type (void)
  62 {
  63   if (_gst_buffer_type == 0) {
  64     _gst_buffer_type = g_boxed_type_register_static ("GstBuffer",
  65         (GBoxedCopyFunc) gst_data_copy, (GBoxedFreeFunc) gst_data_unref);
  66   }
  67   return _gst_buffer_type;
  68 }
  69
  70 static void
  71 _gst_buffer_sub_free (GstBuffer * buffer)
  72 {
  73   gst_data_unref (GST_DATA (buffer->buffer_private));
  74
  75   GST_BUFFER_DATA (buffer) = NULL;
  76   GST_BUFFER_SIZE (buffer) = 0;
  77
  78   _GST_DATA_DISPOSE (GST_DATA (buffer));
  79
  80   gst_buffer_free_chunk (buffer);
  81 }
  82
  83 /**
  84  * gst_buffer_default_free:
  85  * @buffer: a #GstBuffer to free.
  86  *
  87  * Frees the memory associated with the buffer including the buffer data,
  88  * unless the GST_BUFFER_DONTFREE flags was set or the buffer data is NULL.
  89  */
  90 void
  91 gst_buffer_default_free (GstBuffer * buffer)
  92 {
  93   g_return_if_fail (buffer != NULL);
  94
  95   /* free our data */
  96   if (GST_BUFFER_FREE_DATA_FUNC (buffer)) {
  97     GST_BUFFER_FREE_DATA_FUNC (buffer) (buffer);
  98   } else if (!GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_DONTFREE)) {
  99     g_free (GST_BUFFER_DATA (buffer));
 100   }
 101
 102   /* set to safe values */
 103   GST_BUFFER_DATA (buffer) = NULL;
 104   GST_BUFFER_SIZE (buffer) = 0;
 105
 106   _GST_DATA_DISPOSE (GST_DATA (buffer));
 107
 108   gst_buffer_free_chunk (buffer);
 109 }
 110
 111 /**
 112  * gst_buffer_stamp:
 113  * @dest: buffer to stamp
 114  * @src: buffer to stamp from
 115  *
 116  * Copies additional information (timestamps and offsets) from one buffer to
 117  * the other.
 118  */
 119 void
 120 gst_buffer_stamp (GstBuffer * dest, const GstBuffer * src)
 121 {
 122   g_return_if_fail (dest != NULL);
 123   g_return_if_fail (src != NULL);
 124
 125   GST_BUFFER_TIMESTAMP (dest) = GST_BUFFER_TIMESTAMP (src);
 126   GST_BUFFER_DURATION (dest) = GST_BUFFER_DURATION (src);
 127   GST_BUFFER_OFFSET (dest) = GST_BUFFER_OFFSET (src);
 128   GST_BUFFER_OFFSET_END (dest) = GST_BUFFER_OFFSET_END (src);
 129 }
 130
 131 /**
 132  * gst_buffer_default_copy:
 133  * @buffer: a #GstBuffer to make a copy of.
 134  *
 135  * Make a full newly allocated copy of the given buffer, data and all.
 136  *
 137  * Returns: the new #GstBuffer.
 138  */
 139 GstBuffer *
 140 gst_buffer_default_copy (GstBuffer * buffer)
 141 {
 142   GstBuffer *copy;
 143   guint16 flags;
 144
 145   g_return_val_if_fail (buffer != NULL, NULL);
 146
 147   /* create a fresh new buffer */
 148   copy = gst_buffer_alloc_chunk ();
 149
 150   /* copy relevant flags */
 151   flags = GST_DATA_FLAG_SHIFT (GST_BUFFER_KEY_UNIT) |
 152       GST_DATA_FLAG_SHIFT (GST_BUFFER_IN_CAPS);
 153
 154   _GST_DATA_INIT (GST_DATA (copy),
 155       _gst_buffer_type,
 156       flags,
 157       (GstDataFreeFunction) gst_buffer_default_free,
 158       (GstDataCopyFunction) gst_buffer_default_copy);
 159
 160   /* we simply copy everything from our parent */
 161   GST_BUFFER_DATA (copy) = g_memdup (GST_BUFFER_DATA (buffer),
 162       GST_BUFFER_SIZE (buffer));
 163   GST_BUFFER_SIZE (copy) = GST_BUFFER_SIZE (buffer);
 164   GST_BUFFER_MAXSIZE (copy) = GST_BUFFER_SIZE (buffer);
 165
 166   gst_buffer_stamp (copy, buffer);
 167   GST_BUFFER_FREE_DATA_FUNC (copy) = NULL;
 168   GST_BUFFER_PRIVATE (copy) = NULL;
 169
 170   return copy;
 171 }
 172
 173 static GstBuffer *
 174 gst_buffer_alloc_chunk (void)
 175 {
 176   GstBuffer *newbuf;
 177
 178   newbuf = gst_mem_chunk_alloc (chunk);
 179 #ifndef GST_DISABLE_TRACE
 180   gst_alloc_trace_new (_gst_buffer_trace, newbuf);
 181 #endif
 182
 183   return newbuf;
 184 }
 185
 186 static void
 187 gst_buffer_free_chunk (GstBuffer * buffer)
 188 {
 189   gst_mem_chunk_free (chunk, GST_DATA (buffer));
 190 #ifndef GST_DISABLE_TRACE
 191   gst_alloc_trace_free (_gst_buffer_trace, buffer);
 192 #endif
 193 }
 194
 195 /**
 196  * gst_buffer_new:
 197  *
 198  * Creates a newly allocated buffer without any data.
 199  *
 200  * Returns: the new #GstBuffer.
 201  */
 202 GstBuffer *
 203 gst_buffer_new (void)
 204 {
 205   GstBuffer *newbuf;
 206
 207   newbuf = gst_buffer_alloc_chunk ();
 208
 209   GST_CAT_LOG (GST_CAT_BUFFER, "new %p", newbuf);
 210
 211   _GST_DATA_INIT (GST_DATA (newbuf),
 212       _gst_buffer_type,
 213       0,
 214       (GstDataFreeFunction) gst_buffer_default_free,
 215       (GstDataCopyFunction) gst_buffer_default_copy);
 216
 217   GST_BUFFER_DATA (newbuf) = NULL;
 218   GST_BUFFER_SIZE (newbuf) = 0;
 219   GST_BUFFER_MAXSIZE (newbuf) = GST_BUFFER_MAXSIZE_NONE;
 220   GST_BUFFER_TIMESTAMP (newbuf) = GST_CLOCK_TIME_NONE;
 221   GST_BUFFER_DURATION (newbuf) = GST_CLOCK_TIME_NONE;
 222   GST_BUFFER_OFFSET (newbuf) = GST_BUFFER_OFFSET_NONE;
 223   GST_BUFFER_OFFSET_END (newbuf) = GST_BUFFER_OFFSET_NONE;
 224   GST_BUFFER_FREE_DATA_FUNC (newbuf) = NULL;
 225   GST_BUFFER_PRIVATE (newbuf) = NULL;
 226
 227   return newbuf;
 228 }
 229
 230 /**
 231  * gst_buffer_new_and_alloc:
 232  * @size: the size of the new buffer's data.
 233  *
 234  * Creates a newly allocated buffer with data of the given size.
 235  *
 236  * Returns: the new #GstBuffer.
 237  */
 238 GstBuffer *
 239 gst_buffer_new_and_alloc (guint size)
 240 {
 241   GstBuffer *newbuf;
 242
 243   newbuf = gst_buffer_new ();
 244
 245   GST_BUFFER_DATA (newbuf) = g_malloc (size);
 246   GST_BUFFER_SIZE (newbuf) = size;
 247   GST_BUFFER_MAXSIZE (newbuf) = size;
 248
 249   return newbuf;
 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  * This function will copy the offset and timestamp field when the
 261  * offset is 0, else they are set to _NONE.
 262  * The duration field of the new buffer are set to GST_CLOCK_TIME_NONE.
 263  *
 264  * Returns: the new #GstBuffer, or NULL if there was an error.
 265  */
 266 GstBuffer *
 267 gst_buffer_create_sub (GstBuffer * parent, guint offset, guint size)
 268 {
 269   GstBuffer *buffer;
 270   gpointer buffer_data;
 271
 272   g_return_val_if_fail (parent != NULL, NULL);
 273   g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (parent) > 0, NULL);
 274   g_return_val_if_fail (size > 0, NULL);
 275   g_return_val_if_fail (parent->size >= offset + size, NULL);
 276
 277   /* remember the data for the new buffer */
 278   buffer_data = parent->data + offset;
 279   /* make sure we're child not child from a child buffer */
 280   while (GST_BUFFER_FLAG_IS_SET (parent, GST_BUFFER_SUBBUFFER)) {
 281     parent = GST_BUFFER (parent->buffer_private);
 282   }
 283   /* ref the real parent */
 284   gst_data_ref (GST_DATA (parent));
 285
 286   /* create the new buffer */
 287   buffer = gst_buffer_alloc_chunk ();
 288
 289   GST_CAT_LOG (GST_CAT_BUFFER, "new subbuffer %p (parent %p)", buffer, parent);
 290
 291   /* make sure nobody overwrites data in the new buffer
 292    * by setting the READONLY flag */
 293   _GST_DATA_INIT (GST_DATA (buffer),
 294       _gst_buffer_type,
 295       GST_DATA_FLAG_SHIFT (GST_BUFFER_SUBBUFFER) |
 296       GST_DATA_FLAG_SHIFT (GST_DATA_READONLY),
 297       (GstDataFreeFunction) _gst_buffer_sub_free,
 298       (GstDataCopyFunction) gst_buffer_default_copy);
 299
 300   /* set the right values in the child */
 301   GST_BUFFER_DATA (buffer) = buffer_data;
 302   GST_BUFFER_SIZE (buffer) = size;
 303   GST_BUFFER_MAXSIZE (buffer) = size;
 304   GST_BUFFER_FREE_DATA_FUNC (buffer) = NULL;
 305   GST_BUFFER_PRIVATE (buffer) = parent;
 306   /* we can copy the timestamp and offset if the new buffer starts at
 307    * offset 0 */
 308   if (offset == 0) {
 309     GST_BUFFER_TIMESTAMP (buffer) = GST_BUFFER_TIMESTAMP (parent);
 310     GST_BUFFER_OFFSET (buffer) = GST_BUFFER_OFFSET (parent);
 311   } else {
 312     GST_BUFFER_TIMESTAMP (buffer) = GST_CLOCK_TIME_NONE;
 313     GST_BUFFER_OFFSET (buffer) = GST_BUFFER_OFFSET_NONE;
 314   }
 315
 316   GST_BUFFER_DURATION (buffer) = GST_CLOCK_TIME_NONE;
 317   GST_BUFFER_OFFSET_END (buffer) = GST_BUFFER_OFFSET_NONE;
 318
 319   if (GST_BUFFER_FLAG_IS_SET (parent, GST_BUFFER_DONTKEEP)) {
 320     GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_DONTKEEP);
 321   }
 322   if (GST_BUFFER_FLAG_IS_SET (parent, GST_BUFFER_READONLY)) {
 323     GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_READONLY);
 324   }
 325
 326   return buffer;
 327 }
 328
 329
 330 /**
 331  * gst_buffer_merge:
 332  * @buf1: a first source #GstBuffer to merge.
 333  * @buf2: the second source #GstBuffer to merge.
 334  *
 335  * Create a new buffer that is the concatenation of the two source
 336  * buffers.  The original source buffers will not be modified or
 337  * unref'd.
 338  *
 339  * WARNING: Incorrect use of this function can lead to memory leaks.
 340  * It is recommended to use gst_buffer_join() instead of this function.
 341  *
 342  * If the buffers point to contiguous areas of memory, the buffer
 343  * is created without copying the data.
 344  *
 345  * Returns: the new #GstBuffer that's the concatenation of the source buffers.
 346  */
 347 GstBuffer *
 348 gst_buffer_merge (GstBuffer * buf1, GstBuffer * buf2)
 349 {
 350   GstBuffer *result;
 351
 352   /* we're just a specific case of the more general gst_buffer_span() */
 353   result = gst_buffer_span (buf1, 0, buf2, buf1->size + buf2->size);
 354
 355   return result;
 356 }
 357
 358 /**
 359  * gst_buffer_join:
 360  * @buf1: a first source #GstBuffer to merge.
 361  * @buf2: the second source #GstBuffer to merge.
 362  *
 363  * Create a new buffer that is the concatenation of the two source
 364  * buffers.  The original buffers are unreferenced.
 365  *
 366  * If the buffers point to contiguous areas of memory, the buffer
 367  * is created without copying the data.
 368  *
 369  * Returns: the new #GstBuffer that's the concatenation of the source buffers.
 370  */
 371 GstBuffer *
 372 gst_buffer_join (GstBuffer * buf1, GstBuffer * buf2)
 373 {
 374   GstBuffer *result;
 375
 376   /* we're just a specific case of the more general gst_buffer_span() */
 377   result = gst_buffer_span (buf1, 0, buf2, buf1->size + buf2->size);
 378
 379   gst_buffer_unref (buf1);
 380   gst_buffer_unref (buf2);
 381
 382   return result;
 383 }
 384
 385 /**
 386  * gst_buffer_is_span_fast:
 387  * @buf1: a first source #GstBuffer.
 388  * @buf2: the second source #GstBuffer.
 389  *
 390  * Determines whether a gst_buffer_span() can be done without copying
 391  * the contents, that is, whether the data areas are contiguous.
 392  *
 393  * Returns: TRUE if the buffers are contiguous,
 394  * FALSE if a copy would be required.
 395  */
 396 gboolean
 397 gst_buffer_is_span_fast (GstBuffer * buf1, GstBuffer * buf2)
 398 {
 399   g_return_val_if_fail (buf1 != NULL && buf2 != NULL, FALSE);
 400   g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (buf1) > 0, FALSE);
 401   g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (buf2) > 0, FALSE);
 402
 403   /* it's only fast if we have subbuffers of the same parent */
 404   return ((GST_BUFFER_FLAG_IS_SET (buf1, GST_BUFFER_SUBBUFFER)) &&
 405       (GST_BUFFER_FLAG_IS_SET (buf2, GST_BUFFER_SUBBUFFER)) &&
 406       (buf1->buffer_private == buf2->buffer_private) &&
 407       ((buf1->data + buf1->size) == buf2->data));
 408 }
 409
 410 /**
 411  * gst_buffer_span:
 412  * @buf1: a first source #GstBuffer to merge.
 413  * @offset: the offset in the first buffer from where the new
 414  * buffer should start.
 415  * @buf2: the second source #GstBuffer to merge.
 416  * @len: the total length of the new buffer.
 417  *
 418  * Creates a new buffer that consists of part of buf1 and buf2.
 419  * Logically, buf1 and buf2 are concatenated into a single larger
 420  * buffer, and a new buffer is created at the given offset inside
 421  * this space, with a given length.
 422  *
 423  * If the two source buffers are children of the same larger buffer,
 424  * and are contiguous, the new buffer will be a child of the shared
 425  * parent, and thus no copying is necessary. you can use
 426  * gst_buffer_is_span_fast() to determine if a memcpy will be needed.
 427  *
 428  * Returns: the new #GstBuffer that spans the two source buffers.
 429  */
 430 GstBuffer *
 431 gst_buffer_span (GstBuffer * buf1, guint32 offset, GstBuffer * buf2,
 432     guint32 len)
 433 {
 434   GstBuffer *newbuf;
 435
 436   g_return_val_if_fail (buf1 != NULL && buf2 != NULL, FALSE);
 437   g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (buf1) > 0, NULL);
 438   g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (buf2) > 0, NULL);
 439   g_return_val_if_fail (len > 0, NULL);
 440   g_return_val_if_fail (len <= buf1->size + buf2->size - offset, NULL);
 441
 442   /* if the two buffers have the same parent and are adjacent */
 443   if (gst_buffer_is_span_fast (buf1, buf2)) {
 444     GstBuffer *parent = GST_BUFFER (buf1->buffer_private);
 445
 446     /* we simply create a subbuffer of the common parent */
 447     newbuf = gst_buffer_create_sub (parent,
 448         buf1->data - parent->data + offset, len);
 449   } else {
 450     GST_CAT_DEBUG (GST_CAT_BUFFER,
 451         "slow path taken while spanning buffers %p and %p", buf1, buf2);
 452     /* otherwise we simply have to brute-force copy the buffers */
 453     newbuf = gst_buffer_new_and_alloc (len);
 454
 455     /* copy the first buffer's data across */
 456     memcpy (newbuf->data, buf1->data + offset, buf1->size - offset);
 457     /* copy the second buffer's data across */
 458     memcpy (newbuf->data + (buf1->size - offset), buf2->data,
 459         len - (buf1->size - offset));
 460     /* if the offset is 0, the new buffer has the same timestamp as buf1 */
 461     if (offset == 0) {
 462       GST_BUFFER_OFFSET (newbuf) = GST_BUFFER_OFFSET (buf1);
 463       GST_BUFFER_TIMESTAMP (newbuf) = GST_BUFFER_TIMESTAMP (buf1);
 464     }
 465   }
 466   /* if we completely merged the two buffers (appended), we can
 467    * calculate the duration too. Also make sure we's not messing with
 468    * invalid DURATIONS */
 469   if (offset == 0 && buf1->size + buf2->size == len) {
 470     if (GST_BUFFER_DURATION_IS_VALID (buf1) &&
 471         GST_BUFFER_DURATION_IS_VALID (buf2)) {
 472       /* add duration */
 473       GST_BUFFER_DURATION (newbuf) = GST_BUFFER_DURATION (buf1) +
 474           GST_BUFFER_DURATION (buf2);
 475     }
 476     if (GST_BUFFER_OFFSET_END_IS_VALID (buf2)) {
 477       /* add offset_end */
 478       GST_BUFFER_OFFSET_END (newbuf) = GST_BUFFER_OFFSET_END (buf2);
 479     }
 480   }
 481
 482   return newbuf;
 483 }