libs/gst/base/gstadapter.c

   1 /* GStreamer
   2  * Copyright (C) 2004 Benjamin Otte <otte@gnome.org>
   3  *               2005 Wim Taymans <wim@fluendo.com>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 /**
  22  * SECTION:gstadapter
  23  * @short_description: adapts incoming data on a sink pad into chunks of N bytes
  24  *
  25  * This class is for elements that receive buffers in an undesired size.
  26  * While for example raw video contains one image per buffer, the same is not
  27  * true for a lot of other formats, especially those that come directly from
  28  * a file. So if you have undefined buffer sizes and require a specific size,
  29  * this object is for you.
  30  *
  31  * An adapter is created with gst_adapter_new(). It can be freed again with
  32  * g_object_unref().
  33  *
  34  * The theory of operation is like this: All buffers received are put
  35  * into the adapter using gst_adapter_push() and the data is then read back
  36  * in chunks of the desired size using gst_adapter_map()/gst_adapter_unmap()
  37  * and/or gst_adapter_copy(). After the data has been processed, it is freed
  38  * using gst_adapter_unmap().
  39  *
  40  * Other methods such as gst_adapter_take() and gst_adapter_take_buffer()
  41  * combine gst_adapter_map() and gst_adapter_unmap() in one method and are
  42  * potentially more convenient for some use cases.
  43  *
  44  * For example, a sink pad's chain function that needs to pass data to a library
  45  * in 512-byte chunks could be implemented like this:
  46  * |[
  47  * static GstFlowReturn
  48  * sink_pad_chain (GstPad *pad, GstBuffer *buffer)
  49  * {
  50  *   MyElement *this;
  51  *   GstAdapter *adapter;
  52  *   GstFlowReturn ret = GST_FLOW_OK;
  53  *
  54  *   // will give the element an extra ref; remember to drop it
  55  *   this = MY_ELEMENT (gst_pad_get_parent (pad));
  56  *   adapter = this->adapter;
  57  *
  58  *   // put buffer into adapter
  59  *   gst_adapter_push (adapter, buffer);
  60  *   // while we can read out 512 bytes, process them
  61  *   while (gst_adapter_available (adapter) >= 512 && ret == GST_FLOW_OK) {
  62  *     const guint8 *data = gst_adapter_map (adapter, 512);
  63  *     // use flowreturn as an error value
  64  *     ret = my_library_foo (data);
  65  *     gst_adapter_unmap (adapter);
  66  *     gst_adapter_flush (adapter, 512);
  67  *   }
  68  *
  69  *   gst_object_unref (this);
  70  *   return ret;
  71  * }
  72  * ]|
  73  *
  74  * For another example, a simple element inside GStreamer that uses GstAdapter
  75  * is the libvisual element.
  76  *
  77  * An element using GstAdapter in its sink pad chain function should ensure that
  78  * when the FLUSH_STOP event is received, that any queued data is cleared using
  79  * gst_adapter_clear(). Data should also be cleared or processed on EOS and
  80  * when changing state from #GST_STATE_PAUSED to #GST_STATE_READY.
  81  *
  82  * Also check the GST_BUFFER_FLAG_DISCONT flag on the buffer. Some elements might
  83  * need to clear the adapter after a discontinuity.
  84  *
  85  * Since 0.10.24, the adapter will keep track of the timestamps of the buffers
  86  * that were pushed. The last seen timestamp before the current position
  87  * can be queried with gst_adapter_prev_timestamp(). This function can
  88  * optionally return the amount of bytes between the start of the buffer that
  89  * carried the timestamp and the current adapter position. The distance is
  90  * useful when dealing with, for example, raw audio samples because it allows
  91  * you to calculate the timestamp of the current adapter position by using the
  92  * last seen timestamp and the amount of bytes since.
  93  *
  94  * A last thing to note is that while GstAdapter is pretty optimized,
  95  * merging buffers still might be an operation that requires a malloc() and
  96  * memcpy() operation, and these operations are not the fastest. Because of
  97  * this, some functions like gst_adapter_available_fast() are provided to help
  98  * speed up such cases should you want to. To avoid repeated memory allocations,
  99  * gst_adapter_copy() can be used to copy data into a (statically allocated)
 100  * user provided buffer.
 101  *
 102  * GstAdapter is not MT safe. All operations on an adapter must be serialized by
 103  * the caller. This is not normally a problem, however, as the normal use case
 104  * of GstAdapter is inside one pad's chain function, in which case access is
 105  * serialized via the pad's STREAM_LOCK.
 106  *
 107  * Note that gst_adapter_push() takes ownership of the buffer passed. Use
 108  * gst_buffer_ref() before pushing it into the adapter if you still want to
 109  * access the buffer later. The adapter will never modify the data in the
 110  * buffer pushed in it.
 111  *
 112  * Last reviewed on 2009-05-13 (0.10.24).
 113  */
 114
 115 #include <gst/gst_private.h>
 116 #include "gstadapter.h"
 117 #include <string.h>
 118
 119 /* default size for the assembled data buffer */
 120 #define DEFAULT_SIZE 4096
 121
 122 static void gst_adapter_flush_unchecked (GstAdapter * adapter, gsize flush);
 123
 124 GST_DEBUG_CATEGORY_STATIC (gst_adapter_debug);
 125 #define GST_CAT_DEFAULT gst_adapter_debug
 126
 127 #define GST_ADAPTER_GET_PRIVATE(obj)  \
 128    (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_ADAPTER, GstAdapterPrivate))
 129
 130 struct _GstAdapterPrivate
 131 {
 132   GstClockTime pts;
 133   guint64 pts_distance;
 134   GstClockTime dts;
 135   guint64 dts_distance;
 136
 137   gsize scan_offset;
 138   GSList *scan_entry;
 139
 140   gpointer cdata;
 141   gsize csize;
 142 };
 143
 144 #define _do_init \
 145   GST_DEBUG_CATEGORY_INIT (gst_adapter_debug, "adapter", 0, "object to splice and merge buffers to desired size")
 146 #define gst_adapter_parent_class parent_class
 147 G_DEFINE_TYPE_WITH_CODE (GstAdapter, gst_adapter, G_TYPE_OBJECT, _do_init);
 148
 149 static void gst_adapter_dispose (GObject * object);
 150 static void gst_adapter_finalize (GObject * object);
 151
 152 static void
 153 gst_adapter_class_init (GstAdapterClass * klass)
 154 {
 155   GObjectClass *object = G_OBJECT_CLASS (klass);
 156
 157   g_type_class_add_private (klass, sizeof (GstAdapterPrivate));
 158
 159   object->dispose = gst_adapter_dispose;
 160   object->finalize = gst_adapter_finalize;
 161 }
 162
 163 static void
 164 gst_adapter_init (GstAdapter * adapter)
 165 {
 166   adapter->priv = GST_ADAPTER_GET_PRIVATE (adapter);
 167   adapter->assembled_data = g_malloc (DEFAULT_SIZE);
 168   adapter->assembled_size = DEFAULT_SIZE;
 169   adapter->priv->pts = GST_CLOCK_TIME_NONE;
 170   adapter->priv->pts_distance = 0;
 171   adapter->priv->dts = GST_CLOCK_TIME_NONE;
 172   adapter->priv->dts_distance = 0;
 173 }
 174
 175 static void
 176 gst_adapter_dispose (GObject * object)
 177 {
 178   GstAdapter *adapter = GST_ADAPTER (object);
 179
 180   gst_adapter_clear (adapter);
 181
 182   GST_CALL_PARENT (G_OBJECT_CLASS, dispose, (object));
 183 }
 184
 185 static void
 186 gst_adapter_finalize (GObject * object)
 187 {
 188   GstAdapter *adapter = GST_ADAPTER (object);
 189
 190   g_free (adapter->assembled_data);
 191
 192   GST_CALL_PARENT (G_OBJECT_CLASS, finalize, (object));
 193 }
 194
 195 /**
 196  * gst_adapter_new:
 197  *
 198  * Creates a new #GstAdapter. Free with g_object_unref().
 199  *
 200  * Returns: (transfer full): a new #GstAdapter
 201  */
 202 GstAdapter *
 203 gst_adapter_new (void)
 204 {
 205   return g_object_newv (GST_TYPE_ADAPTER, 0, NULL);
 206 }
 207
 208 /**
 209  * gst_adapter_clear:
 210  * @adapter: a #GstAdapter
 211  *
 212  * Removes all buffers from @adapter.
 213  */
 214 void
 215 gst_adapter_clear (GstAdapter * adapter)
 216 {
 217   g_return_if_fail (GST_IS_ADAPTER (adapter));
 218
 219   g_slist_foreach (adapter->buflist, (GFunc) gst_mini_object_unref, NULL);
 220   g_slist_free (adapter->buflist);
 221   adapter->buflist = NULL;
 222   adapter->buflist_end = NULL;
 223   adapter->size = 0;
 224   adapter->skip = 0;
 225   adapter->assembled_len = 0;
 226   adapter->priv->pts = GST_CLOCK_TIME_NONE;
 227   adapter->priv->pts_distance = 0;
 228   adapter->priv->dts = GST_CLOCK_TIME_NONE;
 229   adapter->priv->dts_distance = 0;
 230   adapter->priv->scan_offset = 0;
 231   adapter->priv->scan_entry = NULL;
 232 }
 233
 234 static inline void
 235 update_timestamps (GstAdapter * adapter, GstBuffer * buf)
 236 {
 237   GstClockTime pts, dts;
 238
 239   pts = GST_BUFFER_PTS (buf);
 240   if (GST_CLOCK_TIME_IS_VALID (pts)) {
 241     GST_LOG_OBJECT (adapter, "new pts %" GST_TIME_FORMAT, GST_TIME_ARGS (pts));
 242     adapter->priv->pts = pts;
 243     adapter->priv->pts_distance = 0;
 244   }
 245   dts = GST_BUFFER_DTS (buf);
 246   if (GST_CLOCK_TIME_IS_VALID (dts)) {
 247     GST_LOG_OBJECT (adapter, "new dts %" GST_TIME_FORMAT, GST_TIME_ARGS (dts));
 248     adapter->priv->dts = dts;
 249     adapter->priv->dts_distance = 0;
 250   }
 251 }
 252
 253 /* copy data into @dest, skipping @skip bytes from the head buffers */
 254 static void
 255 copy_into_unchecked (GstAdapter * adapter, guint8 * dest, gsize skip,
 256     gsize size)
 257 {
 258   GSList *g;
 259   GstBuffer *buf;
 260   gsize bsize, csize;
 261
 262   /* first step, do skipping */
 263   /* we might well be copying where we were scanning */
 264   if (adapter->priv->scan_entry && (adapter->priv->scan_offset <= skip)) {
 265     g = adapter->priv->scan_entry;
 266     skip -= adapter->priv->scan_offset;
 267   } else {
 268     g = adapter->buflist;
 269   }
 270   buf = g->data;
 271   bsize = gst_buffer_get_size (buf);
 272   while (G_UNLIKELY (skip >= bsize)) {
 273     skip -= bsize;
 274     g = g_slist_next (g);
 275     buf = g->data;
 276     bsize = gst_buffer_get_size (buf);
 277   }
 278   /* copy partial buffer */
 279   csize = MIN (bsize - skip, size);
 280   GST_DEBUG ("bsize %" G_GSIZE_FORMAT ", skip %" G_GSIZE_FORMAT ", csize %"
 281       G_GSIZE_FORMAT, bsize, skip, csize);
 282   gst_buffer_extract (buf, skip, dest, csize);
 283   size -= csize;
 284   dest += csize;
 285
 286   /* second step, copy remainder */
 287   while (size > 0) {
 288     g = g_slist_next (g);
 289     buf = g->data;
 290     bsize = gst_buffer_get_size (buf);
 291     if (G_LIKELY (bsize > 0)) {
 292       csize = MIN (bsize, size);
 293       gst_buffer_extract (buf, 0, dest, csize);
 294       size -= csize;
 295       dest += csize;
 296     }
 297   }
 298 }
 299
 300 /**
 301  * gst_adapter_push:
 302  * @adapter: a #GstAdapter
 303  * @buf: (transfer full): a #GstBuffer to add to queue in the adapter
 304  *
 305  * Adds the data from @buf to the data stored inside @adapter and takes
 306  * ownership of the buffer.
 307  */
 308 void
 309 gst_adapter_push (GstAdapter * adapter, GstBuffer * buf)
 310 {
 311   gsize size;
 312
 313   g_return_if_fail (GST_IS_ADAPTER (adapter));
 314   g_return_if_fail (GST_IS_BUFFER (buf));
 315
 316   size = gst_buffer_get_size (buf);
 317   adapter->size += size;
 318
 319   /* Note: merging buffers at this point is premature. */
 320   if (G_UNLIKELY (adapter->buflist == NULL)) {
 321     GST_LOG_OBJECT (adapter, "pushing first %" G_GSIZE_FORMAT " bytes", size);
 322     adapter->buflist = adapter->buflist_end = g_slist_append (NULL, buf);
 323     update_timestamps (adapter, buf);
 324   } else {
 325     /* Otherwise append to the end, and advance our end pointer */
 326     GST_LOG_OBJECT (adapter, "pushing %" G_GSIZE_FORMAT " bytes at end, "
 327         "size now %" G_GSIZE_FORMAT, size, adapter->size);
 328     adapter->buflist_end = g_slist_append (adapter->buflist_end, buf);
 329     adapter->buflist_end = g_slist_next (adapter->buflist_end);
 330   }
 331 }
 332
 333 /* Internal method only. Tries to merge buffers at the head of the queue
 334  * to form a single larger buffer of size 'size'. Only merges buffers that
 335  * where 'gst_buffer_is_span_fast' returns TRUE.
 336  *
 337  * Returns TRUE if it managed to merge anything.
 338  */
 339 static gboolean
 340 gst_adapter_try_to_merge_up (GstAdapter * adapter, gsize size)
 341 {
 342   GstBuffer *cur, *head;
 343   GSList *g;
 344   gboolean ret = FALSE;
 345   gsize hsize;
 346
 347   g = adapter->buflist;
 348   if (g == NULL)
 349     return FALSE;
 350
 351   head = g->data;
 352   g = g_slist_next (g);
 353
 354   /* How large do we want our head buffer? The requested size, plus whatever's
 355    * been skipped already */
 356   size += adapter->skip;
 357   hsize = gst_buffer_get_size (head);
 358
 359   while (g != NULL && hsize < size) {
 360     cur = g->data;
 361     if (!gst_buffer_is_span_fast (head, cur))
 362       return ret;
 363
 364     /* Merge the head buffer and the next in line */
 365     GST_LOG_OBJECT (adapter, "Merging buffers of size %" G_GSIZE_FORMAT " & %"
 366         G_GSIZE_FORMAT " in search of target %" G_GSIZE_FORMAT,
 367         hsize, gst_buffer_get_size (cur), size);
 368
 369     head = gst_buffer_join (head, cur);
 370     hsize = gst_buffer_get_size (head);
 371     ret = TRUE;
 372
 373     /* Delete the front list item, and store our new buffer in the 2nd list
 374      * item */
 375     adapter->buflist = g_slist_delete_link (adapter->buflist, adapter->buflist);
 376     g->data = head;
 377
 378     /* invalidate scan position */
 379     adapter->priv->scan_offset = 0;
 380     adapter->priv->scan_entry = NULL;
 381
 382     g = g_slist_next (g);
 383   }
 384
 385   return ret;
 386 }
 387
 388 /**
 389  * gst_adapter_map:
 390  * @adapter: a #GstAdapter
 391  * @size: the number of bytes to map/peek
 392  *
 393  * Gets the first @size bytes stored in the @adapter. The returned pointer is
 394  * valid until the next function is called on the adapter.
 395  *
 396  * Note that setting the returned pointer as the data of a #GstBuffer is
 397  * incorrect for general-purpose plugins. The reason is that if a downstream
 398  * element stores the buffer so that it has access to it outside of the bounds
 399  * of its chain function, the buffer will have an invalid data pointer after
 400  * your element flushes the bytes. In that case you should use
 401  * gst_adapter_take(), which returns a freshly-allocated buffer that you can set
 402  * as #GstBuffer malloc_data or the potentially more performant
 403  * gst_adapter_take_buffer().
 404  *
 405  * Returns #NULL if @size bytes are not available.
 406  *
 407  * Returns: (transfer none) (array length=size): a pointer to the first
 408  *     @size bytes of data, or NULL
 409  */
 410 gconstpointer
 411 gst_adapter_map (GstAdapter * adapter, gsize size)
 412 {
 413   GstBuffer *cur;
 414   gsize skip, csize;
 415   gsize toreuse, tocopy;
 416   guint8 *data;
 417
 418   g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
 419   g_return_val_if_fail (size > 0, NULL);
 420
 421   /* we don't have enough data, return NULL. This is unlikely
 422    * as one usually does an _available() first instead of peeking a
 423    * random size. */
 424   if (G_UNLIKELY (size > adapter->size))
 425     return NULL;
 426
 427   /* we have enough assembled data, return it */
 428   if (adapter->assembled_len >= size)
 429     return adapter->assembled_data;
 430
 431   do {
 432     cur = adapter->buflist->data;
 433     skip = adapter->skip;
 434
 435     csize = gst_buffer_get_size (cur);
 436     if (csize >= size + skip) {
 437       data = gst_buffer_map (cur, &csize, NULL, GST_MAP_READ);
 438       adapter->priv->cdata = data;
 439       adapter->priv->csize = csize;
 440       return data + skip;
 441     }
 442     /* We may be able to efficiently merge buffers in our pool to
 443      * gather a big enough chunk to return it from the head buffer directly */
 444   } while (gst_adapter_try_to_merge_up (adapter, size));
 445
 446   /* see how much data we can reuse from the assembled memory and how much
 447    * we need to copy */
 448   toreuse = adapter->assembled_len;
 449   tocopy = size - toreuse;
 450
 451   /* Gonna need to copy stuff out */
 452   if (G_UNLIKELY (adapter->assembled_size < size)) {
 453     adapter->assembled_size = (size / DEFAULT_SIZE + 1) * DEFAULT_SIZE;
 454     GST_DEBUG_OBJECT (adapter, "resizing internal buffer to %" G_GSIZE_FORMAT,
 455         adapter->assembled_size);
 456     if (toreuse == 0) {
 457       GST_CAT_DEBUG (GST_CAT_PERFORMANCE, "alloc new buffer");
 458       /* no g_realloc to avoid a memcpy that is not desired here since we are
 459        * not going to reuse any data here */
 460       g_free (adapter->assembled_data);
 461       adapter->assembled_data = g_malloc (adapter->assembled_size);
 462     } else {
 463       /* we are going to reuse all data, realloc then */
 464       GST_CAT_DEBUG (GST_CAT_PERFORMANCE, "reusing %" G_GSIZE_FORMAT " bytes",
 465           toreuse);
 466       adapter->assembled_data =
 467           g_realloc (adapter->assembled_data, adapter->assembled_size);
 468     }
 469   }
 470   GST_CAT_DEBUG (GST_CAT_PERFORMANCE, "copy remaining %" G_GSIZE_FORMAT
 471       " bytes from adapter", tocopy);
 472   data = adapter->assembled_data;
 473   copy_into_unchecked (adapter, data + toreuse, skip + toreuse, tocopy);
 474   adapter->assembled_len = size;
 475
 476   return adapter->assembled_data;
 477 }
 478
 479 /**
 480  * gst_adapter_unmap:
 481  * @adapter: a #GstAdapter
 482  *
 483  * Releases the memory obtained with the last gst_adapter_map().
 484  */
 485 void
 486 gst_adapter_unmap (GstAdapter * adapter)
 487 {
 488   g_return_if_fail (GST_IS_ADAPTER (adapter));
 489
 490   if (adapter->priv->cdata) {
 491     GstBuffer *cur = adapter->buflist->data;
 492     gst_buffer_unmap (cur, adapter->priv->cdata, adapter->priv->csize);
 493     adapter->priv->cdata = NULL;
 494   }
 495 }
 496
 497 /**
 498  * gst_adapter_copy:
 499  * @adapter: a #GstAdapter
 500  * @dest: (out caller-allocates) (array length=size): the memory to copy into
 501  * @offset: the bytes offset in the adapter to start from
 502  * @size: the number of bytes to copy
 503  *
 504  * Copies @size bytes of data starting at @offset out of the buffers
 505  * contained in @GstAdapter into an array @dest provided by the caller.
 506  *
 507  * The array @dest should be large enough to contain @size bytes.
 508  * The user should check that the adapter has (@offset + @size) bytes
 509  * available before calling this function.
 510  *
 511  * Since: 0.10.12
 512  */
 513 void
 514 gst_adapter_copy (GstAdapter * adapter, gpointer dest, gsize offset, gsize size)
 515 {
 516   g_return_if_fail (GST_IS_ADAPTER (adapter));
 517   g_return_if_fail (size > 0);
 518   g_return_if_fail (offset + size <= adapter->size);
 519
 520   copy_into_unchecked (adapter, dest, offset + adapter->skip, size);
 521 }
 522
 523 /**
 524  * gst_adapter_flush:
 525  * @adapter: a #GstAdapter
 526  * @flush: the number of bytes to flush
 527  *
 528  * Flushes the first @flush bytes in the @adapter. The caller must ensure that
 529  * at least this many bytes are available.
 530  *
 531  * See also: gst_adapter_map(), gst_adapter_unmap()
 532  */
 533 static void
 534 gst_adapter_flush_unchecked (GstAdapter * adapter, gsize flush)
 535 {
 536   GstBuffer *cur;
 537   gsize size;
 538   GstAdapterPrivate *priv;
 539   GSList *g;
 540
 541   GST_LOG_OBJECT (adapter, "flushing %" G_GSIZE_FORMAT " bytes", flush);
 542
 543   priv = adapter->priv;
 544
 545   /* clear state */
 546   adapter->size -= flush;
 547   adapter->assembled_len = 0;
 548
 549   /* take skip into account */
 550   flush += adapter->skip;
 551   /* distance is always at least the amount of skipped bytes */
 552   priv->pts_distance -= adapter->skip;
 553   priv->dts_distance -= adapter->skip;
 554
 555   g = adapter->buflist;
 556   cur = g->data;
 557   size = gst_buffer_get_size (cur);
 558   while (flush >= size) {
 559     /* can skip whole buffer */
 560     GST_LOG_OBJECT (adapter, "flushing out head buffer");
 561     priv->pts_distance += size;
 562     priv->dts_distance += size;
 563     flush -= size;
 564
 565     gst_buffer_unref (cur);
 566     g = g_slist_delete_link (g, g);
 567
 568     if (G_UNLIKELY (g == NULL)) {
 569       GST_LOG_OBJECT (adapter, "adapter empty now");
 570       adapter->buflist_end = NULL;
 571       break;
 572     }
 573     /* there is a new head buffer, update the timestamps */
 574     cur = g->data;
 575     update_timestamps (adapter, cur);
 576     size = gst_buffer_get_size (cur);
 577   }
 578   adapter->buflist = g;
 579   /* account for the remaining bytes */
 580   adapter->skip = flush;
 581   adapter->priv->pts_distance += flush;
 582   adapter->priv->dts_distance += flush;
 583   /* invalidate scan position */
 584   priv->scan_offset = 0;
 585   priv->scan_entry = NULL;
 586 }
 587
 588 void
 589 gst_adapter_flush (GstAdapter * adapter, gsize flush)
 590 {
 591   g_return_if_fail (GST_IS_ADAPTER (adapter));
 592   g_return_if_fail (flush <= adapter->size);
 593
 594   /* flushing out 0 bytes will do nothing */
 595   if (G_UNLIKELY (flush == 0))
 596     return;
 597
 598   gst_adapter_flush_unchecked (adapter, flush);
 599 }
 600
 601 /* internal function, nbytes should be flushed after calling this function */
 602 static guint8 *
 603 gst_adapter_take_internal (GstAdapter * adapter, gsize nbytes)
 604 {
 605   guint8 *data;
 606   gsize toreuse, tocopy;
 607
 608   /* see how much data we can reuse from the assembled memory and how much
 609    * we need to copy */
 610   toreuse = MIN (nbytes, adapter->assembled_len);
 611   tocopy = nbytes - toreuse;
 612
 613   /* find memory to return */
 614   if (adapter->assembled_size >= nbytes && toreuse > 0) {
 615     /* we reuse already allocated memory but only when we're going to reuse
 616      * something from it because else we are worse than the malloc and copy
 617      * case below */
 618     GST_LOG_OBJECT (adapter, "reusing %" G_GSIZE_FORMAT " bytes of assembled"
 619         " data", toreuse);
 620     /* we have enough free space in the assembled array */
 621     data = adapter->assembled_data;
 622     /* flush after this function should set the assembled_size to 0 */
 623     adapter->assembled_data = g_malloc (adapter->assembled_size);
 624   } else {
 625     GST_LOG_OBJECT (adapter, "allocating %" G_GSIZE_FORMAT " bytes", nbytes);
 626     /* not enough bytes in the assembled array, just allocate new space */
 627     data = g_malloc (nbytes);
 628     /* reuse what we can from the already assembled data */
 629     if (toreuse) {
 630       GST_LOG_OBJECT (adapter, "reusing %" G_GSIZE_FORMAT " bytes", toreuse);
 631       memcpy (data, adapter->assembled_data, toreuse);
 632     }
 633   }
 634   if (tocopy) {
 635     /* copy the remaining data */
 636     copy_into_unchecked (adapter, toreuse + data, toreuse + adapter->skip,
 637         tocopy);
 638   }
 639   return data;
 640 }
 641
 642 /**
 643  * gst_adapter_take:
 644  * @adapter: a #GstAdapter
 645  * @nbytes: the number of bytes to take
 646  *
 647  * Returns a freshly allocated buffer containing the first @nbytes bytes of the
 648  * @adapter. The returned bytes will be flushed from the adapter.
 649  *
 650  * Caller owns returned value. g_free after usage.
 651  *
 652  * Free-function: g_free
 653  *
 654  * Returns: (transfer full) (array length=nbytes): oven-fresh hot data, or
 655  *     #NULL if @nbytes bytes are not available
 656  */
 657 gpointer
 658 gst_adapter_take (GstAdapter * adapter, gsize nbytes)
 659 {
 660   gpointer data;
 661
 662   g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
 663   g_return_val_if_fail (nbytes > 0, NULL);
 664
 665   /* we don't have enough data, return NULL. This is unlikely
 666    * as one usually does an _available() first instead of peeking a
 667    * random size. */
 668   if (G_UNLIKELY (nbytes > adapter->size))
 669     return NULL;
 670
 671   data = gst_adapter_take_internal (adapter, nbytes);
 672
 673   gst_adapter_flush_unchecked (adapter, nbytes);
 674
 675   return data;
 676 }
 677
 678 /**
 679  * gst_adapter_take_buffer:
 680  * @adapter: a #GstAdapter
 681  * @nbytes: the number of bytes to take
 682  *
 683  * Returns a #GstBuffer containing the first @nbytes bytes of the
 684  * @adapter. The returned bytes will be flushed from the adapter.
 685  * This function is potentially more performant than gst_adapter_take()
 686  * since it can reuse the memory in pushed buffers by subbuffering
 687  * or merging.
 688  *
 689  * Caller owns returned value. gst_buffer_unref() after usage.
 690  *
 691  * Free-function: gst_buffer_unref
 692  *
 693  * Returns: (transfer full): a #GstBuffer containing the first @nbytes of
 694  *     the adapter, or #NULL if @nbytes bytes are not available
 695  *
 696  * Since: 0.10.6
 697  */
 698 GstBuffer *
 699 gst_adapter_take_buffer (GstAdapter * adapter, gsize nbytes)
 700 {
 701   GstBuffer *buffer;
 702   GstBuffer *cur;
 703   gsize hsize, skip;
 704   guint8 *data;
 705
 706   g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
 707   g_return_val_if_fail (nbytes > 0, NULL);
 708
 709   GST_LOG_OBJECT (adapter, "taking buffer of %" G_GSIZE_FORMAT " bytes",
 710       nbytes);
 711
 712   /* we don't have enough data, return NULL. This is unlikely
 713    * as one usually does an _available() first instead of grabbing a
 714    * random size. */
 715   if (G_UNLIKELY (nbytes > adapter->size))
 716     return NULL;
 717
 718   cur = adapter->buflist->data;
 719   skip = adapter->skip;
 720   hsize = gst_buffer_get_size (cur);
 721
 722   /* our head buffer has enough data left, return it */
 723   if (skip == 0 && hsize == nbytes) {
 724     GST_LOG_OBJECT (adapter, "providing buffer of %" G_GSIZE_FORMAT " bytes"
 725         " as head buffer", nbytes);
 726     buffer = gst_buffer_ref (cur);
 727     goto done;
 728   } else if (hsize >= nbytes + skip) {
 729     GST_LOG_OBJECT (adapter, "providing buffer of %" G_GSIZE_FORMAT " bytes"
 730         " via region copy", nbytes);
 731     buffer = gst_buffer_copy_region (cur, GST_BUFFER_COPY_ALL, skip, nbytes);
 732     goto done;
 733   }
 734
 735   if (gst_adapter_try_to_merge_up (adapter, nbytes)) {
 736     /* Merged something, let's try again for sub-buffering */
 737     cur = adapter->buflist->data;
 738     if (gst_buffer_get_size (cur) >= nbytes + skip) {
 739       GST_LOG_OBJECT (adapter, "providing buffer of %" G_GSIZE_FORMAT " bytes"
 740           " via sub-buffer", nbytes);
 741       buffer = gst_buffer_copy_region (cur, GST_BUFFER_COPY_ALL, skip, nbytes);
 742       goto done;
 743     }
 744   }
 745
 746   data = gst_adapter_take_internal (adapter, nbytes);
 747
 748   buffer = gst_buffer_new ();
 749   gst_buffer_take_memory (buffer, -1,
 750       gst_memory_new_wrapped (0, data, g_free, nbytes, 0, nbytes));
 751
 752 done:
 753   gst_adapter_flush_unchecked (adapter, nbytes);
 754
 755   return buffer;
 756 }
 757
 758 /**
 759  * gst_adapter_take_list:
 760  * @adapter: a #GstAdapter
 761  * @nbytes: the number of bytes to take
 762  *
 763  * Returns a #GList of buffers containing the first @nbytes bytes of the
 764  * @adapter. The returned bytes will be flushed from the adapter.
 765  * When the caller can deal with individual buffers, this function is more
 766  * performant because no memory should be copied.
 767  *
 768  * Caller owns returned list and contained buffers. gst_buffer_unref() each
 769  * buffer in the list before freeing the list after usage.
 770  *
 771  * Returns: (element-type Gst.Buffer) (transfer full): a #GList of buffers
 772  *     containing the first @nbytes of the adapter, or #NULL if @nbytes bytes
 773  *     are not available
 774  *
 775  * Since: 0.10.31
 776  */
 777 GList *
 778 gst_adapter_take_list (GstAdapter * adapter, gsize nbytes)
 779 {
 780   GQueue queue = G_QUEUE_INIT;
 781   GstBuffer *cur;
 782   gsize hsize, skip;
 783
 784   g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
 785   g_return_val_if_fail (nbytes <= adapter->size, NULL);
 786
 787   GST_LOG_OBJECT (adapter, "taking %" G_GSIZE_FORMAT " bytes", nbytes);
 788
 789   while (nbytes > 0) {
 790     cur = adapter->buflist->data;
 791     skip = adapter->skip;
 792     hsize = MIN (nbytes, gst_buffer_get_size (cur) - skip);
 793
 794     cur = gst_adapter_take_buffer (adapter, hsize);
 795
 796     g_queue_push_tail (&queue, cur);
 797
 798     nbytes -= hsize;
 799   }
 800   return queue.head;
 801 }
 802
 803 /**
 804  * gst_adapter_available:
 805  * @adapter: a #GstAdapter
 806  *
 807  * Gets the maximum amount of bytes available, that is it returns the maximum
 808  * value that can be supplied to gst_adapter_map() without that function
 809  * returning NULL.
 810  *
 811  * Returns: number of bytes available in @adapter
 812  */
 813 gsize
 814 gst_adapter_available (GstAdapter * adapter)
 815 {
 816   g_return_val_if_fail (GST_IS_ADAPTER (adapter), 0);
 817
 818   return adapter->size;
 819 }
 820
 821 /**
 822  * gst_adapter_available_fast:
 823  * @adapter: a #GstAdapter
 824  *
 825  * Gets the maximum number of bytes that are immediately available without
 826  * requiring any expensive operations (like copying the data into a
 827  * temporary buffer).
 828  *
 829  * Returns: number of bytes that are available in @adapter without expensive
 830  * operations
 831  */
 832 gsize
 833 gst_adapter_available_fast (GstAdapter * adapter)
 834 {
 835   GstBuffer *cur;
 836   gsize size;
 837   GSList *g;
 838
 839   g_return_val_if_fail (GST_IS_ADAPTER (adapter), 0);
 840
 841   /* no data */
 842   if (adapter->size == 0)
 843     return 0;
 844
 845   /* some stuff we already assembled */
 846   if (adapter->assembled_len)
 847     return adapter->assembled_len;
 848
 849   /* take the first non-zero buffer */
 850   g = adapter->buflist;
 851   while (TRUE) {
 852     cur = g->data;
 853     size = gst_buffer_get_size (cur);
 854     if (size != 0)
 855       break;
 856     g = g_slist_next (g);
 857   }
 858
 859   /* we can quickly get the (remaining) data of the first buffer */
 860   return size - adapter->skip;
 861 }
 862
 863 /**
 864  * gst_adapter_prev_pts:
 865  * @adapter: a #GstAdapter
 866  * @distance: (out) (allow-none): pointer to location for distance, or NULL
 867  *
 868  * Get the pts that was before the current byte in the adapter. When
 869  * @distance is given, the amount of bytes between the pts and the current
 870  * position is returned.
 871  *
 872  * The pts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
 873  * the adapter is first created or when it is cleared. This also means that before
 874  * the first byte with a pts is removed from the adapter, the pts
 875  * and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.
 876  *
 877  * Returns: The previously seen pts.
 878  */
 879 GstClockTime
 880 gst_adapter_prev_pts (GstAdapter * adapter, guint64 * distance)
 881 {
 882   g_return_val_if_fail (GST_IS_ADAPTER (adapter), GST_CLOCK_TIME_NONE);
 883
 884   if (distance)
 885     *distance = adapter->priv->pts_distance;
 886
 887   return adapter->priv->pts;
 888 }
 889
 890 /**
 891  * gst_adapter_prev_dts:
 892  * @adapter: a #GstAdapter
 893  * @distance: (out) (allow-none): pointer to location for distance, or NULL
 894  *
 895  * Get the dts that was before the current byte in the adapter. When
 896  * @distance is given, the amount of bytes between the dts and the current
 897  * position is returned.
 898  *
 899  * The dts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
 900  * the adapter is first created or when it is cleared. This also means that before
 901  * the first byte with a dts is removed from the adapter, the dts
 902  * and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.
 903  *
 904  * Returns: The previously seen dts.
 905  */
 906 GstClockTime
 907 gst_adapter_prev_dts (GstAdapter * adapter, guint64 * distance)
 908 {
 909   g_return_val_if_fail (GST_IS_ADAPTER (adapter), GST_CLOCK_TIME_NONE);
 910
 911   if (distance)
 912     *distance = adapter->priv->dts_distance;
 913
 914   return adapter->priv->dts;
 915 }
 916
 917 /**
 918  * gst_adapter_masked_scan_uint32_peek:
 919  * @adapter: a #GstAdapter
 920  * @mask: mask to apply to data before matching against @pattern
 921  * @pattern: pattern to match (after mask is applied)
 922  * @offset: offset into the adapter data from which to start scanning, returns
 923  *          the last scanned position.
 924  * @size: number of bytes to scan from offset
 925  * @value: pointer to uint32 to return matching data
 926  *
 927  * Scan for pattern @pattern with applied mask @mask in the adapter data,
 928  * starting from offset @offset.  If a match is found, the value that matched
 929  * is returned through @value, otherwise @value is left untouched.
 930  *
 931  * The bytes in @pattern and @mask are interpreted left-to-right, regardless
 932  * of endianness.  All four bytes of the pattern must be present in the
 933  * adapter for it to match, even if the first or last bytes are masked out.
 934  *
 935  * It is an error to call this function without making sure that there is
 936  * enough data (offset+size bytes) in the adapter.
 937  *
 938  * Returns: offset of the first match, or -1 if no match was found.
 939  *
 940  * Since: 0.10.30
 941  */
 942 gsize
 943 gst_adapter_masked_scan_uint32_peek (GstAdapter * adapter, guint32 mask,
 944     guint32 pattern, gsize offset, gsize size, guint32 * value)
 945 {
 946   GSList *g;
 947   gsize skip, bsize, osize, i;
 948   guint32 state;
 949   guint8 *bdata, *odata;
 950   GstBuffer *buf;
 951
 952   g_return_val_if_fail (size > 0, -1);
 953   g_return_val_if_fail (offset + size <= adapter->size, -1);
 954   g_return_val_if_fail (((~mask) & pattern) == 0, -1);
 955
 956   /* we can't find the pattern with less than 4 bytes */
 957   if (G_UNLIKELY (size < 4))
 958     return -1;
 959
 960   skip = offset + adapter->skip;
 961
 962   /* first step, do skipping and position on the first buffer */
 963   /* optimistically assume scanning continues sequentially */
 964   if (adapter->priv->scan_entry && (adapter->priv->scan_offset <= skip)) {
 965     g = adapter->priv->scan_entry;
 966     skip -= adapter->priv->scan_offset;
 967   } else {
 968     g = adapter->buflist;
 969     adapter->priv->scan_offset = 0;
 970     adapter->priv->scan_entry = NULL;
 971   }
 972   buf = g->data;
 973   bsize = gst_buffer_get_size (buf);
 974   while (G_UNLIKELY (skip >= bsize)) {
 975     skip -= bsize;
 976     g = g_slist_next (g);
 977     adapter->priv->scan_offset += bsize;
 978     adapter->priv->scan_entry = g;
 979     buf = g->data;
 980     bsize = gst_buffer_get_size (buf);
 981   }
 982   /* get the data now */
 983   odata = gst_buffer_map (buf, &osize, NULL, GST_MAP_READ);
 984
 985   bdata = odata + skip;
 986   bsize = osize - skip;
 987   skip = 0;
 988
 989   /* set the state to something that does not match */
 990   state = ~pattern;
 991
 992   /* now find data */
 993   do {
 994     bsize = MIN (bsize, size);
 995     for (i = 0; i < bsize; i++) {
 996       state = ((state << 8) | bdata[i]);
 997       if (G_UNLIKELY ((state & mask) == pattern)) {
 998         /* we have a match but we need to have skipped at
 999          * least 4 bytes to fill the state. */
1000         if (G_LIKELY (skip + i >= 3)) {
1001           if (G_LIKELY (value))
1002             *value = state;
1003           gst_buffer_unmap (buf, odata, osize);
1004           return offset + skip + i - 3;
1005         }
1006       }
1007     }
1008     size -= bsize;
1009     if (size == 0)
1010       break;
1011
1012     /* nothing found yet, go to next buffer */
1013     skip += bsize;
1014     g = g_slist_next (g);
1015     adapter->priv->scan_offset += osize;
1016     adapter->priv->scan_entry = g;
1017     gst_buffer_unmap (buf, odata, osize);
1018     buf = g->data;
1019
1020     odata = gst_buffer_map (buf, &osize, NULL, GST_MAP_READ);
1021     bsize = osize;
1022     bdata = odata;
1023   } while (TRUE);
1024
1025   gst_buffer_unmap (buf, odata, osize);
1026
1027   /* nothing found */
1028   return -1;
1029 }
1030
1031 /**
1032  * gst_adapter_masked_scan_uint32:
1033  * @adapter: a #GstAdapter
1034  * @mask: mask to apply to data before matching against @pattern
1035  * @pattern: pattern to match (after mask is applied)
1036  * @offset: offset into the adapter data from which to start scanning, returns
1037  *          the last scanned position.
1038  * @size: number of bytes to scan from offset
1039  *
1040  * Scan for pattern @pattern with applied mask @mask in the adapter data,
1041  * starting from offset @offset.
1042  *
1043  * The bytes in @pattern and @mask are interpreted left-to-right, regardless
1044  * of endianness.  All four bytes of the pattern must be present in the
1045  * adapter for it to match, even if the first or last bytes are masked out.
1046  *
1047  * It is an error to call this function without making sure that there is
1048  * enough data (offset+size bytes) in the adapter.
1049  *
1050  * This function calls gst_adapter_masked_scan_uint32_peek() passing NULL
1051  * for value.
1052  *
1053  * Returns: offset of the first match, or -1 if no match was found.
1054  *
1055  * Example:
1056  * <programlisting>
1057  * // Assume the adapter contains 0x00 0x01 0x02 ... 0xfe 0xff
1058  *
1059  * gst_adapter_masked_scan_uint32 (adapter, 0xffffffff, 0x00010203, 0, 256);
1060  * // -> returns 0
1061  * gst_adapter_masked_scan_uint32 (adapter, 0xffffffff, 0x00010203, 1, 255);
1062  * // -> returns -1
1063  * gst_adapter_masked_scan_uint32 (adapter, 0xffffffff, 0x01020304, 1, 255);
1064  * // -> returns 1
1065  * gst_adapter_masked_scan_uint32 (adapter, 0xffff, 0x0001, 0, 256);
1066  * // -> returns -1
1067  * gst_adapter_masked_scan_uint32 (adapter, 0xffff, 0x0203, 0, 256);
1068  * // -> returns 0
1069  * gst_adapter_masked_scan_uint32 (adapter, 0xffff0000, 0x02030000, 0, 256);
1070  * // -> returns 2
1071  * gst_adapter_masked_scan_uint32 (adapter, 0xffff0000, 0x02030000, 0, 4);
1072  * // -> returns -1
1073  * </programlisting>
1074  *
1075  * Since: 0.10.24
1076  */
1077 gsize
1078 gst_adapter_masked_scan_uint32 (GstAdapter * adapter, guint32 mask,
1079     guint32 pattern, gsize offset, gsize size)
1080 {
1081   return gst_adapter_masked_scan_uint32_peek (adapter, mask, pattern, offset,
1082       size, NULL);
1083 }