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   flags = GST_BUFFER_FLAGS (buffer) & flags;
 154
 155   _GST_DATA_INIT (GST_DATA (copy),
 156       _gst_buffer_type,
 157       flags,
 158       (GstDataFreeFunction) gst_buffer_default_free,
 159       (GstDataCopyFunction) gst_buffer_default_copy);
 160
 161   /* we simply copy everything from our parent */
 162   GST_BUFFER_DATA (copy) = g_memdup (GST_BUFFER_DATA (buffer),
 163       GST_BUFFER_SIZE (buffer));
 164   GST_BUFFER_SIZE (copy) = GST_BUFFER_SIZE (buffer);
 165   GST_BUFFER_MAXSIZE (copy) = GST_BUFFER_SIZE (buffer);
 166
 167   gst_buffer_stamp (copy, buffer);
 168   GST_BUFFER_FREE_DATA_FUNC (copy) = NULL;
 169   GST_BUFFER_PRIVATE (copy) = NULL;
 170
 171   return copy;
 172 }
 173
 174 static GstBuffer *
 175 gst_buffer_alloc_chunk (void)
 176 {
 177   GstBuffer *newbuf;
 178
 179   newbuf = gst_mem_chunk_alloc (chunk);
 180 #ifndef GST_DISABLE_TRACE
 181   gst_alloc_trace_new (_gst_buffer_trace, newbuf);
 182 #endif
 183
 184   return newbuf;
 185 }
 186
 187 static void
 188 gst_buffer_free_chunk (GstBuffer * buffer)
 189 {
 190   gst_mem_chunk_free (chunk, GST_DATA (buffer));
 191 #ifndef GST_DISABLE_TRACE
 192   gst_alloc_trace_free (_gst_buffer_trace, buffer);
 193 #endif
 194 }
 195
 196 /**
 197  * gst_buffer_new:
 198  *
 199  * Creates a newly allocated buffer without any data.
 200  *
 201  * Returns: the new #GstBuffer.
 202  */
 203 GstBuffer *
 204 gst_buffer_new (void)
 205 {
 206   GstBuffer *newbuf;
 207
 208   newbuf = gst_buffer_alloc_chunk ();
 209
 210   GST_CAT_LOG (GST_CAT_BUFFER, "new %p", newbuf);
 211
 212   _GST_DATA_INIT (GST_DATA (newbuf),
 213       _gst_buffer_type,
 214       0,
 215       (GstDataFreeFunction) gst_buffer_default_free,
 216       (GstDataCopyFunction) gst_buffer_default_copy);
 217
 218   GST_BUFFER_DATA (newbuf) = NULL;
 219   GST_BUFFER_SIZE (newbuf) = 0;
 220   GST_BUFFER_MAXSIZE (newbuf) = GST_BUFFER_MAXSIZE_NONE;
 221   GST_BUFFER_TIMESTAMP (newbuf) = GST_CLOCK_TIME_NONE;
 222   GST_BUFFER_DURATION (newbuf) = GST_CLOCK_TIME_NONE;
 223   GST_BUFFER_OFFSET (newbuf) = GST_BUFFER_OFFSET_NONE;
 224   GST_BUFFER_OFFSET_END (newbuf) = GST_BUFFER_OFFSET_NONE;
 225   GST_BUFFER_FREE_DATA_FUNC (newbuf) = NULL;
 226   GST_BUFFER_PRIVATE (newbuf) = NULL;
 227
 228   return newbuf;
 229 }
 230
 231 /**
 232  * gst_buffer_new_and_alloc:
 233  * @size: the size of the new buffer's data.
 234  *
 235  * Creates a newly allocated buffer with data of the given size.
 236  *
 237  * Returns: the new #GstBuffer.
 238  */
 239 GstBuffer *
 240 gst_buffer_new_and_alloc (guint size)
 241 {
 242   GstBuffer *newbuf;
 243
 244   newbuf = gst_buffer_new ();
 245
 246   GST_BUFFER_DATA (newbuf) = g_malloc (size);
 247   GST_BUFFER_SIZE (newbuf) = size;
 248   GST_BUFFER_MAXSIZE (newbuf) = size;
 249
 250   return newbuf;
 251 }
 252
 253 /**
 254  * gst_buffer_create_sub:
 255  * @parent: a parent #GstBuffer to create a subbuffer from.
 256  * @offset: the offset into parent #GstBuffer.
 257  * @size: the size of the new #GstBuffer sub-buffer (with size > 0).
 258  *
 259  * Creates a sub-buffer from the parent at a given offset.
 260  * This sub-buffer uses the actual memory space of the parent buffer.
 261  * This function will copy the offset and timestamp field when the
 262  * offset is 0, else they are set to _NONE.
 263  * The duration field of the new buffer are set to GST_CLOCK_TIME_NONE.
 264  *
 265  * Returns: the new #GstBuffer, or NULL if there was an error.
 266  */
 267 GstBuffer *
 268 gst_buffer_create_sub (GstBuffer * parent, guint offset, guint size)
 269 {
 270   GstBuffer *buffer;
 271   gpointer buffer_data;
 272
 273   g_return_val_if_fail (parent != NULL, NULL);
 274   g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (parent) > 0, NULL);
 275   g_return_val_if_fail (size > 0, NULL);
 276   g_return_val_if_fail (parent->size >= offset + size, NULL);
 277
 278   /* remember the data for the new buffer */
 279   buffer_data = parent->data + offset;
 280   /* make sure we're child not child from a child buffer */
 281   while (GST_BUFFER_FLAG_IS_SET (parent, GST_BUFFER_SUBBUFFER)) {
 282     parent = GST_BUFFER (parent->buffer_private);
 283   }
 284   /* ref the real parent */
 285   gst_data_ref (GST_DATA (parent));
 286
 287   /* create the new buffer */
 288   buffer = gst_buffer_alloc_chunk ();
 289
 290   GST_CAT_LOG (GST_CAT_BUFFER, "new subbuffer %p (parent %p)", buffer, parent);
 291
 292   /* make sure nobody overwrites data in the new buffer
 293    * by setting the READONLY flag */
 294   _GST_DATA_INIT (GST_DATA (buffer),
 295       _gst_buffer_type,
 296       GST_DATA_FLAG_SHIFT (GST_BUFFER_SUBBUFFER) |
 297       GST_DATA_FLAG_SHIFT (GST_DATA_READONLY),
 298       (GstDataFreeFunction) _gst_buffer_sub_free,
 299       (GstDataCopyFunction) gst_buffer_default_copy);
 300
 301   /* set the right values in the child */
 302   GST_BUFFER_DATA (buffer) = buffer_data;
 303   GST_BUFFER_SIZE (buffer) = size;
 304   GST_BUFFER_MAXSIZE (buffer) = size;
 305   GST_BUFFER_FREE_DATA_FUNC (buffer) = NULL;
 306   GST_BUFFER_PRIVATE (buffer) = parent;
 307   /* we can copy the timestamp and offset if the new buffer starts at
 308    * offset 0 */
 309   if (offset == 0) {
 310     GST_BUFFER_TIMESTAMP (buffer) = GST_BUFFER_TIMESTAMP (parent);
 311     GST_BUFFER_OFFSET (buffer) = GST_BUFFER_OFFSET (parent);
 312   } else {
 313     GST_BUFFER_TIMESTAMP (buffer) = GST_CLOCK_TIME_NONE;
 314     GST_BUFFER_OFFSET (buffer) = GST_BUFFER_OFFSET_NONE;
 315   }
 316
 317   GST_BUFFER_DURATION (buffer) = GST_CLOCK_TIME_NONE;
 318   GST_BUFFER_OFFSET_END (buffer) = GST_BUFFER_OFFSET_NONE;
 319
 320   if (GST_BUFFER_FLAG_IS_SET (parent, GST_BUFFER_DONTKEEP)) {
 321     GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_DONTKEEP);
 322   }
 323   if (GST_BUFFER_FLAG_IS_SET (parent, GST_BUFFER_READONLY)) {
 324     GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_READONLY);
 325   }
 326
 327   return buffer;
 328 }
 329
 330
 331 /**
 332  * gst_buffer_merge:
 333  * @buf1: a first source #GstBuffer to merge.
 334  * @buf2: the second source #GstBuffer to merge.
 335  *
 336  * Create a new buffer that is the concatenation of the two source
 337  * buffers.  The original source buffers will not be modified or
 338  * unref'd.
 339  *
 340  * WARNING: Incorrect use of this function can lead to memory leaks.
 341  * It is recommended to use gst_buffer_join() instead of this function.
 342  *
 343  * If the buffers point to contiguous areas of memory, the buffer
 344  * is created without copying the data.
 345  *
 346  * Returns: the new #GstBuffer that's the concatenation of the source buffers.
 347  */
 348 GstBuffer *
 349 gst_buffer_merge (GstBuffer * buf1, GstBuffer * buf2)
 350 {
 351   GstBuffer *result;
 352
 353   /* we're just a specific case of the more general gst_buffer_span() */
 354   result = gst_buffer_span (buf1, 0, buf2, buf1->size + buf2->size);
 355
 356   return result;
 357 }
 358
 359 /**
 360  * gst_buffer_join:
 361  * @buf1: a first source #GstBuffer to merge.
 362  * @buf2: the second source #GstBuffer to merge.
 363  *
 364  * Create a new buffer that is the concatenation of the two source
 365  * buffers.  The original buffers are unreferenced.
 366  *
 367  * If the buffers point to contiguous areas of memory, the buffer
 368  * is created without copying the data.
 369  *
 370  * Returns: the new #GstBuffer that's the concatenation of the source buffers.
 371  */
 372 GstBuffer *
 373 gst_buffer_join (GstBuffer * buf1, GstBuffer * buf2)
 374 {
 375   GstBuffer *result;
 376
 377   /* we're just a specific case of the more general gst_buffer_span() */
 378   result = gst_buffer_span (buf1, 0, buf2, buf1->size + buf2->size);
 379
 380   gst_buffer_unref (buf1);
 381   gst_buffer_unref (buf2);
 382
 383   return result;
 384 }
 385
 386 /**
 387  * gst_buffer_is_span_fast:
 388  * @buf1: a first source #GstBuffer.
 389  * @buf2: the second source #GstBuffer.
 390  *
 391  * Determines whether a gst_buffer_span() can be done without copying
 392  * the contents, that is, whether the data areas are contiguous.
 393  *
 394  * Returns: TRUE if the buffers are contiguous,
 395  * FALSE if a copy would be required.
 396  */
 397 gboolean
 398 gst_buffer_is_span_fast (GstBuffer * buf1, GstBuffer * buf2)
 399 {
 400   g_return_val_if_fail (buf1 != NULL && buf2 != NULL, FALSE);
 401   g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (buf1) > 0, FALSE);
 402   g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (buf2) > 0, FALSE);
 403
 404   /* it's only fast if we have subbuffers of the same parent */
 405   return ((GST_BUFFER_FLAG_IS_SET (buf1, GST_BUFFER_SUBBUFFER)) &&
 406       (GST_BUFFER_FLAG_IS_SET (buf2, GST_BUFFER_SUBBUFFER)) &&
 407       (buf1->buffer_private == buf2->buffer_private) &&
 408       ((buf1->data + buf1->size) == buf2->data));
 409 }
 410
 411 /**
 412  * gst_buffer_span:
 413  * @buf1: a first source #GstBuffer to merge.
 414  * @offset: the offset in the first buffer from where the new
 415  * buffer should start.
 416  * @buf2: the second source #GstBuffer to merge.
 417  * @len: the total length of the new buffer.
 418  *
 419  * Creates a new buffer that consists of part of buf1 and buf2.
 420  * Logically, buf1 and buf2 are concatenated into a single larger
 421  * buffer, and a new buffer is created at the given offset inside
 422  * this space, with a given length.
 423  *
 424  * If the two source buffers are children of the same larger buffer,
 425  * and are contiguous, the new buffer will be a child of the shared
 426  * parent, and thus no copying is necessary. you can use
 427  * gst_buffer_is_span_fast() to determine if a memcpy will be needed.
 428  *
 429  * Returns: the new #GstBuffer that spans the two source buffers.
 430  */
 431 GstBuffer *
 432 gst_buffer_span (GstBuffer * buf1, guint32 offset, GstBuffer * buf2,
 433     guint32 len)
 434 {
 435   GstBuffer *newbuf;
 436
 437   g_return_val_if_fail (buf1 != NULL && buf2 != NULL, FALSE);
 438   g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (buf1) > 0, NULL);
 439   g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (buf2) > 0, NULL);
 440   g_return_val_if_fail (len > 0, NULL);
 441   g_return_val_if_fail (len <= buf1->size + buf2->size - offset, NULL);
 442
 443   /* if the two buffers have the same parent and are adjacent */
 444   if (gst_buffer_is_span_fast (buf1, buf2)) {
 445     GstBuffer *parent = GST_BUFFER (buf1->buffer_private);
 446
 447     /* we simply create a subbuffer of the common parent */
 448     newbuf = gst_buffer_create_sub (parent,
 449         buf1->data - parent->data + offset, len);
 450   } else {
 451     GST_CAT_DEBUG (GST_CAT_BUFFER,
 452         "slow path taken while spanning buffers %p and %p", buf1, buf2);
 453     /* otherwise we simply have to brute-force copy the buffers */
 454     newbuf = gst_buffer_new_and_alloc (len);
 455
 456     /* copy the first buffer's data across */
 457     memcpy (newbuf->data, buf1->data + offset, buf1->size - offset);
 458     /* copy the second buffer's data across */
 459     memcpy (newbuf->data + (buf1->size - offset), buf2->data,
 460         len - (buf1->size - offset));
 461     /* if the offset is 0, the new buffer has the same timestamp as buf1 */
 462     if (offset == 0) {
 463       GST_BUFFER_OFFSET (newbuf) = GST_BUFFER_OFFSET (buf1);
 464       GST_BUFFER_TIMESTAMP (newbuf) = GST_BUFFER_TIMESTAMP (buf1);
 465     }
 466   }
 467   /* if we completely merged the two buffers (appended), we can
 468    * calculate the duration too. Also make sure we's not messing with
 469    * invalid DURATIONS */
 470   if (offset == 0 && buf1->size + buf2->size == len) {
 471     if (GST_BUFFER_DURATION_IS_VALID (buf1) &&
 472         GST_BUFFER_DURATION_IS_VALID (buf2)) {
 473       /* add duration */
 474       GST_BUFFER_DURATION (newbuf) = GST_BUFFER_DURATION (buf1) +
 475           GST_BUFFER_DURATION (buf2);
 476     }
 477     if (GST_BUFFER_OFFSET_END_IS_VALID (buf2)) {
 478       /* add offset_end */
 479       GST_BUFFER_OFFSET_END (newbuf) = GST_BUFFER_OFFSET_END (buf2);
 480     }
 481   }
 482
 483   return newbuf;
 484 }