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   GstMapInfo info;
 141 };
 142
 143 #define _do_init \
 144   GST_DEBUG_CATEGORY_INIT (gst_adapter_debug, "adapter", 0, "object to splice and merge buffers to desired size")
 145 #define gst_adapter_parent_class parent_class
 146 G_DEFINE_TYPE_WITH_CODE (GstAdapter, gst_adapter, G_TYPE_OBJECT, _do_init);
 147
 148 static void gst_adapter_dispose (GObject * object);
 149 static void gst_adapter_finalize (GObject * object);
 150
 151 static void
 152 gst_adapter_class_init (GstAdapterClass * klass)
 153 {
 154   GObjectClass *object = G_OBJECT_CLASS (klass);
 155
 156   g_type_class_add_private (klass, sizeof (GstAdapterPrivate));
 157
 158   object->dispose = gst_adapter_dispose;
 159   object->finalize = gst_adapter_finalize;
 160 }
 161
 162 static void
 163 gst_adapter_init (GstAdapter * adapter)
 164 {
 165   adapter->priv = GST_ADAPTER_GET_PRIVATE (adapter);
 166   adapter->assembled_data = g_malloc (DEFAULT_SIZE);
 167   adapter->assembled_size = DEFAULT_SIZE;
 168   adapter->priv->pts = GST_CLOCK_TIME_NONE;
 169   adapter->priv->pts_distance = 0;
 170   adapter->priv->dts = GST_CLOCK_TIME_NONE;
 171   adapter->priv->dts_distance = 0;
 172 }
 173
 174 static void
 175 gst_adapter_dispose (GObject * object)
 176 {
 177   GstAdapter *adapter = GST_ADAPTER (object);
 178
 179   gst_adapter_clear (adapter);
 180
 181   GST_CALL_PARENT (G_OBJECT_CLASS, dispose, (object));
 182 }
 183
 184 static void
 185 gst_adapter_finalize (GObject * object)
 186 {
 187   GstAdapter *adapter = GST_ADAPTER (object);
 188
 189   g_free (adapter->assembled_data);
 190
 191   GST_CALL_PARENT (G_OBJECT_CLASS, finalize, (object));
 192 }
 193
 194 /**
 195  * gst_adapter_new:
 196  *
 197  * Creates a new #GstAdapter. Free with g_object_unref().
 198  *
 199  * Returns: (transfer full): a new #GstAdapter
 200  */
 201 GstAdapter *
 202 gst_adapter_new (void)
 203 {
 204   return g_object_newv (GST_TYPE_ADAPTER, 0, NULL);
 205 }
 206
 207 /**
 208  * gst_adapter_clear:
 209  * @adapter: a #GstAdapter
 210  *
 211  * Removes all buffers from @adapter.
 212  */
 213 void
 214 gst_adapter_clear (GstAdapter * adapter)
 215 {
 216   GstAdapterPrivate *priv;
 217
 218   g_return_if_fail (GST_IS_ADAPTER (adapter));
 219
 220   priv = adapter->priv;
 221
 222   if (priv->info.memory)
 223     gst_adapter_unmap (adapter);
 224
 225   g_slist_foreach (adapter->buflist, (GFunc) gst_mini_object_unref, NULL);
 226   g_slist_free (adapter->buflist);
 227   adapter->buflist = NULL;
 228   adapter->buflist_end = NULL;
 229   adapter->size = 0;
 230   adapter->skip = 0;
 231   adapter->assembled_len = 0;
 232   priv->pts = GST_CLOCK_TIME_NONE;
 233   priv->pts_distance = 0;
 234   priv->dts = GST_CLOCK_TIME_NONE;
 235   priv->dts_distance = 0;
 236   priv->scan_offset = 0;
 237   priv->scan_entry = NULL;
 238 }
 239
 240 static inline void
 241 update_timestamps (GstAdapter * adapter, GstBuffer * buf)
 242 {
 243   GstClockTime pts, dts;
 244
 245   pts = GST_BUFFER_PTS (buf);
 246   if (GST_CLOCK_TIME_IS_VALID (pts)) {
 247     GST_LOG_OBJECT (adapter, "new pts %" GST_TIME_FORMAT, GST_TIME_ARGS (pts));
 248     adapter->priv->pts = pts;
 249     adapter->priv->pts_distance = 0;
 250   }
 251   dts = GST_BUFFER_DTS (buf);
 252   if (GST_CLOCK_TIME_IS_VALID (dts)) {
 253     GST_LOG_OBJECT (adapter, "new dts %" GST_TIME_FORMAT, GST_TIME_ARGS (dts));
 254     adapter->priv->dts = dts;
 255     adapter->priv->dts_distance = 0;
 256   }
 257 }
 258
 259 /* copy data into @dest, skipping @skip bytes from the head buffers */
 260 static void
 261 copy_into_unchecked (GstAdapter * adapter, guint8 * dest, gsize skip,
 262     gsize size)
 263 {
 264   GSList *g;
 265   GstBuffer *buf;
 266   gsize bsize, csize;
 267
 268   /* first step, do skipping */
 269   /* we might well be copying where we were scanning */
 270   if (adapter->priv->scan_entry && (adapter->priv->scan_offset <= skip)) {
 271     g = adapter->priv->scan_entry;
 272     skip -= adapter->priv->scan_offset;
 273   } else {
 274     g = adapter->buflist;
 275   }
 276   buf = g->data;
 277   bsize = gst_buffer_get_size (buf);
 278   while (G_UNLIKELY (skip >= bsize)) {
 279     skip -= bsize;
 280     g = g_slist_next (g);
 281     buf = g->data;
 282     bsize = gst_buffer_get_size (buf);
 283   }
 284   /* copy partial buffer */
 285   csize = MIN (bsize - skip, size);
 286   GST_DEBUG ("bsize %" G_GSIZE_FORMAT ", skip %" G_GSIZE_FORMAT ", csize %"
 287       G_GSIZE_FORMAT, bsize, skip, csize);
 288   GST_CAT_LOG_OBJECT (GST_CAT_PERFORMANCE, adapter, "extract %" G_GSIZE_FORMAT
 289       " bytes", csize);
 290   gst_buffer_extract (buf, skip, dest, csize);
 291   size -= csize;
 292   dest += csize;
 293
 294   /* second step, copy remainder */
 295   while (size > 0) {
 296     g = g_slist_next (g);
 297     buf = g->data;
 298     bsize = gst_buffer_get_size (buf);
 299     if (G_LIKELY (bsize > 0)) {
 300       csize = MIN (bsize, size);
 301       GST_CAT_LOG_OBJECT (GST_CAT_PERFORMANCE, adapter,
 302           "extract %" G_GSIZE_FORMAT " bytes", csize);
 303       gst_buffer_extract (buf, 0, dest, csize);
 304       size -= csize;
 305       dest += csize;
 306     }
 307   }
 308 }
 309
 310 /**
 311  * gst_adapter_push:
 312  * @adapter: a #GstAdapter
 313  * @buf: (transfer full): a #GstBuffer to add to queue in the adapter
 314  *
 315  * Adds the data from @buf to the data stored inside @adapter and takes
 316  * ownership of the buffer.
 317  */
 318 void
 319 gst_adapter_push (GstAdapter * adapter, GstBuffer * buf)
 320 {
 321   gsize size;
 322
 323   g_return_if_fail (GST_IS_ADAPTER (adapter));
 324   g_return_if_fail (GST_IS_BUFFER (buf));
 325
 326   size = gst_buffer_get_size (buf);
 327   adapter->size += size;
 328
 329   /* Note: merging buffers at this point is premature. */
 330   if (G_UNLIKELY (adapter->buflist == NULL)) {
 331     GST_LOG_OBJECT (adapter, "pushing %p first %" G_GSIZE_FORMAT " bytes",
 332         buf, size);
 333     adapter->buflist = adapter->buflist_end = g_slist_append (NULL, buf);
 334     update_timestamps (adapter, buf);
 335   } else {
 336     /* Otherwise append to the end, and advance our end pointer */
 337     GST_LOG_OBJECT (adapter, "pushing %p %" G_GSIZE_FORMAT " bytes at end, "
 338         "size now %" G_GSIZE_FORMAT, buf, size, adapter->size);
 339     adapter->buflist_end = g_slist_append (adapter->buflist_end, buf);
 340     adapter->buflist_end = g_slist_next (adapter->buflist_end);
 341   }
 342 }
 343
 344 /* Internal method only. Tries to merge buffers at the head of the queue
 345  * to form a single larger buffer of size 'size'. Only merges buffers that
 346  * where 'gst_buffer_is_span_fast' returns TRUE.
 347  *
 348  * Returns TRUE if it managed to merge anything.
 349  */
 350 static gboolean
 351 gst_adapter_try_to_merge_up (GstAdapter * adapter, gsize size)
 352 {
 353   GstBuffer *cur, *head;
 354   GSList *g;
 355   gboolean ret = FALSE;
 356   gsize hsize;
 357
 358   g = adapter->buflist;
 359   if (g == NULL)
 360     return FALSE;
 361
 362   head = g->data;
 363   g = g_slist_next (g);
 364
 365   /* How large do we want our head buffer? The requested size, plus whatever's
 366    * been skipped already */
 367   size += adapter->skip;
 368   hsize = gst_buffer_get_size (head);
 369
 370   while (g != NULL && hsize < size) {
 371     cur = g->data;
 372     if (!gst_buffer_is_span_fast (head, cur))
 373       return ret;
 374
 375     /* Merge the head buffer and the next in line */
 376     GST_LOG_OBJECT (adapter, "Merging buffers of size %" G_GSIZE_FORMAT " & %"
 377         G_GSIZE_FORMAT " in search of target %" G_GSIZE_FORMAT,
 378         hsize, gst_buffer_get_size (cur), size);
 379
 380     head = gst_buffer_join (head, cur);
 381     hsize = gst_buffer_get_size (head);
 382     ret = TRUE;
 383
 384     /* Delete the front list item, and store our new buffer in the 2nd list
 385      * item */
 386     adapter->buflist = g_slist_delete_link (adapter->buflist, adapter->buflist);
 387     g->data = head;
 388
 389     /* invalidate scan position */
 390     adapter->priv->scan_offset = 0;
 391     adapter->priv->scan_entry = NULL;
 392
 393     g = g_slist_next (g);
 394   }
 395
 396   return ret;
 397 }
 398
 399 /**
 400  * gst_adapter_map:
 401  * @adapter: a #GstAdapter
 402  * @size: the number of bytes to map/peek
 403  *
 404  * Gets the first @size bytes stored in the @adapter. The returned pointer is
 405  * valid until the next function is called on the adapter.
 406  *
 407  * Note that setting the returned pointer as the data of a #GstBuffer is
 408  * incorrect for general-purpose plugins. The reason is that if a downstream
 409  * element stores the buffer so that it has access to it outside of the bounds
 410  * of its chain function, the buffer will have an invalid data pointer after
 411  * your element flushes the bytes. In that case you should use
 412  * gst_adapter_take(), which returns a freshly-allocated buffer that you can set
 413  * as #GstBuffer malloc_data or the potentially more performant
 414  * gst_adapter_take_buffer().
 415  *
 416  * Returns #NULL if @size bytes are not available.
 417  *
 418  * Returns: (transfer none) (array length=size): a pointer to the first
 419  *     @size bytes of data, or NULL
 420  */
 421 gconstpointer
 422 gst_adapter_map (GstAdapter * adapter, gsize size)
 423 {
 424   GstAdapterPrivate *priv;
 425   GstBuffer *cur;
 426   gsize skip, csize;
 427   gsize toreuse, tocopy;
 428   guint8 *data;
 429
 430   g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
 431   g_return_val_if_fail (size > 0, NULL);
 432
 433   priv = adapter->priv;
 434
 435   if (priv->info.memory)
 436     gst_adapter_unmap (adapter);
 437
 438   /* we don't have enough data, return NULL. This is unlikely
 439    * as one usually does an _available() first instead of peeking a
 440    * random size. */
 441   if (G_UNLIKELY (size > adapter->size))
 442     return NULL;
 443
 444   /* we have enough assembled data, return it */
 445   if (adapter->assembled_len >= size)
 446     return adapter->assembled_data;
 447
 448   do {
 449     cur = adapter->buflist->data;
 450     skip = adapter->skip;
 451
 452     csize = gst_buffer_get_size (cur);
 453     if (csize >= size + skip) {
 454       if (!gst_buffer_map (cur, &priv->info, GST_MAP_READ))
 455         return FALSE;
 456
 457       return (guint8 *) priv->info.data + skip;
 458     }
 459     /* We may be able to efficiently merge buffers in our pool to
 460      * gather a big enough chunk to return it from the head buffer directly */
 461   } while (gst_adapter_try_to_merge_up (adapter, size));
 462
 463   /* see how much data we can reuse from the assembled memory and how much
 464    * we need to copy */
 465   toreuse = adapter->assembled_len;
 466   tocopy = size - toreuse;
 467
 468   /* Gonna need to copy stuff out */
 469   if (G_UNLIKELY (adapter->assembled_size < size)) {
 470     adapter->assembled_size = (size / DEFAULT_SIZE + 1) * DEFAULT_SIZE;
 471     GST_DEBUG_OBJECT (adapter, "resizing internal buffer to %" G_GSIZE_FORMAT,
 472         adapter->assembled_size);
 473     if (toreuse == 0) {
 474       GST_CAT_DEBUG (GST_CAT_PERFORMANCE, "alloc new buffer");
 475       /* no g_realloc to avoid a memcpy that is not desired here since we are
 476        * not going to reuse any data here */
 477       g_free (adapter->assembled_data);
 478       adapter->assembled_data = g_malloc (adapter->assembled_size);
 479     } else {
 480       /* we are going to reuse all data, realloc then */
 481       GST_CAT_DEBUG (GST_CAT_PERFORMANCE, "reusing %" G_GSIZE_FORMAT " bytes",
 482           toreuse);
 483       adapter->assembled_data =
 484           g_realloc (adapter->assembled_data, adapter->assembled_size);
 485     }
 486   }
 487   GST_CAT_DEBUG (GST_CAT_PERFORMANCE, "copy remaining %" G_GSIZE_FORMAT
 488       " bytes from adapter", tocopy);
 489   data = adapter->assembled_data;
 490   copy_into_unchecked (adapter, data + toreuse, skip + toreuse, tocopy);
 491   adapter->assembled_len = size;
 492
 493   return adapter->assembled_data;
 494 }
 495
 496 /**
 497  * gst_adapter_unmap:
 498  * @adapter: a #GstAdapter
 499  *
 500  * Releases the memory obtained with the last gst_adapter_map().
 501  */
 502 void
 503 gst_adapter_unmap (GstAdapter * adapter)
 504 {
 505   GstAdapterPrivate *priv;
 506
 507   g_return_if_fail (GST_IS_ADAPTER (adapter));
 508
 509   priv = adapter->priv;
 510
 511   if (priv->info.memory) {
 512     GstBuffer *cur = adapter->buflist->data;
 513     GST_LOG_OBJECT (adapter, "unmap memory buffer %p", cur);
 514     gst_buffer_unmap (cur, &priv->info);
 515     priv->info.memory = NULL;
 516   }
 517 }
 518
 519 /**
 520  * gst_adapter_copy:
 521  * @adapter: a #GstAdapter
 522  * @dest: (out caller-allocates) (array length=size): the memory to copy into
 523  * @offset: the bytes offset in the adapter to start from
 524  * @size: the number of bytes to copy
 525  *
 526  * Copies @size bytes of data starting at @offset out of the buffers
 527  * contained in @GstAdapter into an array @dest provided by the caller.
 528  *
 529  * The array @dest should be large enough to contain @size bytes.
 530  * The user should check that the adapter has (@offset + @size) bytes
 531  * available before calling this function.
 532  *
 533  * Since: 0.10.12
 534  */
 535 void
 536 gst_adapter_copy (GstAdapter * adapter, gpointer dest, gsize offset, gsize size)
 537 {
 538   g_return_if_fail (GST_IS_ADAPTER (adapter));
 539   g_return_if_fail (size > 0);
 540   g_return_if_fail (offset + size <= adapter->size);
 541
 542   copy_into_unchecked (adapter, dest, offset + adapter->skip, size);
 543 }
 544
 545 /**
 546  * gst_adapter_flush:
 547  * @adapter: a #GstAdapter
 548  * @flush: the number of bytes to flush
 549  *
 550  * Flushes the first @flush bytes in the @adapter. The caller must ensure that
 551  * at least this many bytes are available.
 552  *
 553  * See also: gst_adapter_map(), gst_adapter_unmap()
 554  */
 555 static void
 556 gst_adapter_flush_unchecked (GstAdapter * adapter, gsize flush)
 557 {
 558   GstBuffer *cur;
 559   gsize size;
 560   GstAdapterPrivate *priv;
 561   GSList *g;
 562
 563   GST_LOG_OBJECT (adapter, "flushing %" G_GSIZE_FORMAT " bytes", flush);
 564
 565   priv = adapter->priv;
 566
 567   if (priv->info.memory)
 568     gst_adapter_unmap (adapter);
 569
 570   /* clear state */
 571   adapter->size -= flush;
 572   adapter->assembled_len = 0;
 573
 574   /* take skip into account */
 575   flush += adapter->skip;
 576   /* distance is always at least the amount of skipped bytes */
 577   priv->pts_distance -= adapter->skip;
 578   priv->dts_distance -= adapter->skip;
 579
 580   g = adapter->buflist;
 581   cur = g->data;
 582   size = gst_buffer_get_size (cur);
 583   while (flush >= size) {
 584     /* can skip whole buffer */
 585     GST_LOG_OBJECT (adapter, "flushing out head buffer");
 586     priv->pts_distance += size;
 587     priv->dts_distance += size;
 588     flush -= size;
 589
 590     gst_buffer_unref (cur);
 591     g = g_slist_delete_link (g, g);
 592
 593     if (G_UNLIKELY (g == NULL)) {
 594       GST_LOG_OBJECT (adapter, "adapter empty now");
 595       adapter->buflist_end = NULL;
 596       break;
 597     }
 598     /* there is a new head buffer, update the timestamps */
 599     cur = g->data;
 600     update_timestamps (adapter, cur);
 601     size = gst_buffer_get_size (cur);
 602   }
 603   adapter->buflist = g;
 604   /* account for the remaining bytes */
 605   adapter->skip = flush;
 606   adapter->priv->pts_distance += flush;
 607   adapter->priv->dts_distance += flush;
 608   /* invalidate scan position */
 609   priv->scan_offset = 0;
 610   priv->scan_entry = NULL;
 611 }
 612
 613 void
 614 gst_adapter_flush (GstAdapter * adapter, gsize flush)
 615 {
 616   g_return_if_fail (GST_IS_ADAPTER (adapter));
 617   g_return_if_fail (flush <= adapter->size);
 618
 619   /* flushing out 0 bytes will do nothing */
 620   if (G_UNLIKELY (flush == 0))
 621     return;
 622
 623   gst_adapter_flush_unchecked (adapter, flush);
 624 }
 625
 626 /* internal function, nbytes should be flushed after calling this function */
 627 static guint8 *
 628 gst_adapter_take_internal (GstAdapter * adapter, gsize nbytes)
 629 {
 630   guint8 *data;
 631   gsize toreuse, tocopy;
 632
 633   /* see how much data we can reuse from the assembled memory and how much
 634    * we need to copy */
 635   toreuse = MIN (nbytes, adapter->assembled_len);
 636   tocopy = nbytes - toreuse;
 637
 638   /* find memory to return */
 639   if (adapter->assembled_size >= nbytes && toreuse > 0) {
 640     /* we reuse already allocated memory but only when we're going to reuse
 641      * something from it because else we are worse than the malloc and copy
 642      * case below */
 643     GST_LOG_OBJECT (adapter, "reusing %" G_GSIZE_FORMAT " bytes of assembled"
 644         " data", toreuse);
 645     /* we have enough free space in the assembled array */
 646     data = adapter->assembled_data;
 647     /* flush after this function should set the assembled_size to 0 */
 648     adapter->assembled_data = g_malloc (adapter->assembled_size);
 649   } else {
 650     GST_LOG_OBJECT (adapter, "allocating %" G_GSIZE_FORMAT " bytes", nbytes);
 651     /* not enough bytes in the assembled array, just allocate new space */
 652     data = g_malloc (nbytes);
 653     /* reuse what we can from the already assembled data */
 654     if (toreuse) {
 655       GST_LOG_OBJECT (adapter, "reusing %" G_GSIZE_FORMAT " bytes", toreuse);
 656       GST_CAT_LOG_OBJECT (GST_CAT_PERFORMANCE, adapter,
 657           "memcpy %" G_GSIZE_FORMAT " bytes", toreuse);
 658       memcpy (data, adapter->assembled_data, toreuse);
 659     }
 660   }
 661   if (tocopy) {
 662     /* copy the remaining data */
 663     copy_into_unchecked (adapter, toreuse + data, toreuse + adapter->skip,
 664         tocopy);
 665   }
 666   return data;
 667 }
 668
 669 /**
 670  * gst_adapter_take:
 671  * @adapter: a #GstAdapter
 672  * @nbytes: the number of bytes to take
 673  *
 674  * Returns a freshly allocated buffer containing the first @nbytes bytes of the
 675  * @adapter. The returned bytes will be flushed from the adapter.
 676  *
 677  * Caller owns returned value. g_free after usage.
 678  *
 679  * Free-function: g_free
 680  *
 681  * Returns: (transfer full) (array length=nbytes): oven-fresh hot data, or
 682  *     #NULL if @nbytes bytes are not available
 683  */
 684 gpointer
 685 gst_adapter_take (GstAdapter * adapter, gsize nbytes)
 686 {
 687   gpointer data;
 688
 689   g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
 690   g_return_val_if_fail (nbytes > 0, NULL);
 691
 692   /* we don't have enough data, return NULL. This is unlikely
 693    * as one usually does an _available() first instead of peeking a
 694    * random size. */
 695   if (G_UNLIKELY (nbytes > adapter->size))
 696     return NULL;
 697
 698   data = gst_adapter_take_internal (adapter, nbytes);
 699
 700   gst_adapter_flush_unchecked (adapter, nbytes);
 701
 702   return data;
 703 }
 704
 705 /**
 706  * gst_adapter_take_buffer:
 707  * @adapter: a #GstAdapter
 708  * @nbytes: the number of bytes to take
 709  *
 710  * Returns a #GstBuffer containing the first @nbytes bytes of the
 711  * @adapter. The returned bytes will be flushed from the adapter.
 712  * This function is potentially more performant than gst_adapter_take()
 713  * since it can reuse the memory in pushed buffers by subbuffering
 714  * or merging.
 715  *
 716  * Caller owns returned value. gst_buffer_unref() after usage.
 717  *
 718  * Free-function: gst_buffer_unref
 719  *
 720  * Returns: (transfer full): a #GstBuffer containing the first @nbytes of
 721  *     the adapter, or #NULL if @nbytes bytes are not available
 722  *
 723  * Since: 0.10.6
 724  */
 725 GstBuffer *
 726 gst_adapter_take_buffer (GstAdapter * adapter, gsize nbytes)
 727 {
 728   GstBuffer *buffer;
 729   GstBuffer *cur;
 730   gsize hsize, skip;
 731   guint8 *data;
 732
 733   g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
 734   g_return_val_if_fail (nbytes > 0, NULL);
 735
 736   GST_LOG_OBJECT (adapter, "taking buffer of %" G_GSIZE_FORMAT " bytes",
 737       nbytes);
 738
 739   /* we don't have enough data, return NULL. This is unlikely
 740    * as one usually does an _available() first instead of grabbing a
 741    * random size. */
 742   if (G_UNLIKELY (nbytes > adapter->size))
 743     return NULL;
 744
 745   cur = adapter->buflist->data;
 746   skip = adapter->skip;
 747   hsize = gst_buffer_get_size (cur);
 748
 749   /* our head buffer has enough data left, return it */
 750   if (skip == 0 && hsize == nbytes) {
 751     GST_LOG_OBJECT (adapter, "providing buffer of %" G_GSIZE_FORMAT " bytes"
 752         " as head buffer", nbytes);
 753     buffer = gst_buffer_ref (cur);
 754     goto done;
 755   } else if (hsize >= nbytes + skip) {
 756     GST_LOG_OBJECT (adapter, "providing buffer of %" G_GSIZE_FORMAT " bytes"
 757         " via region copy", nbytes);
 758     buffer = gst_buffer_copy_region (cur, GST_BUFFER_COPY_ALL, skip, nbytes);
 759     goto done;
 760   }
 761
 762   if (gst_adapter_try_to_merge_up (adapter, nbytes)) {
 763     /* Merged something, let's try again for sub-buffering */
 764     cur = adapter->buflist->data;
 765     if (gst_buffer_get_size (cur) >= nbytes + skip) {
 766       GST_LOG_OBJECT (adapter, "providing buffer of %" G_GSIZE_FORMAT " bytes"
 767           " via sub-buffer", nbytes);
 768       buffer = gst_buffer_copy_region (cur, GST_BUFFER_COPY_ALL, skip, nbytes);
 769       goto done;
 770     }
 771   }
 772
 773   data = gst_adapter_take_internal (adapter, nbytes);
 774
 775   buffer = gst_buffer_new ();
 776   gst_buffer_take_memory (buffer, -1,
 777       gst_memory_new_wrapped (0, data, nbytes, 0, nbytes, data, g_free));
 778
 779 done:
 780   gst_adapter_flush_unchecked (adapter, nbytes);
 781
 782   return buffer;
 783 }
 784
 785 /**
 786  * gst_adapter_take_list:
 787  * @adapter: a #GstAdapter
 788  * @nbytes: the number of bytes to take
 789  *
 790  * Returns a #GList of buffers containing the first @nbytes bytes of the
 791  * @adapter. The returned bytes will be flushed from the adapter.
 792  * When the caller can deal with individual buffers, this function is more
 793  * performant because no memory should be copied.
 794  *
 795  * Caller owns returned list and contained buffers. gst_buffer_unref() each
 796  * buffer in the list before freeing the list after usage.
 797  *
 798  * Returns: (element-type Gst.Buffer) (transfer full): a #GList of buffers
 799  *     containing the first @nbytes of the adapter, or #NULL if @nbytes bytes
 800  *     are not available
 801  *
 802  * Since: 0.10.31
 803  */
 804 GList *
 805 gst_adapter_take_list (GstAdapter * adapter, gsize nbytes)
 806 {
 807   GQueue queue = G_QUEUE_INIT;
 808   GstBuffer *cur;
 809   gsize hsize, skip;
 810
 811   g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
 812   g_return_val_if_fail (nbytes <= adapter->size, NULL);
 813
 814   GST_LOG_OBJECT (adapter, "taking %" G_GSIZE_FORMAT " bytes", nbytes);
 815
 816   while (nbytes > 0) {
 817     cur = adapter->buflist->data;
 818     skip = adapter->skip;
 819     hsize = MIN (nbytes, gst_buffer_get_size (cur) - skip);
 820
 821     cur = gst_adapter_take_buffer (adapter, hsize);
 822
 823     g_queue_push_tail (&queue, cur);
 824
 825     nbytes -= hsize;
 826   }
 827   return queue.head;
 828 }
 829
 830 /**
 831  * gst_adapter_available:
 832  * @adapter: a #GstAdapter
 833  *
 834  * Gets the maximum amount of bytes available, that is it returns the maximum
 835  * value that can be supplied to gst_adapter_map() without that function
 836  * returning NULL.
 837  *
 838  * Returns: number of bytes available in @adapter
 839  */
 840 gsize
 841 gst_adapter_available (GstAdapter * adapter)
 842 {
 843   g_return_val_if_fail (GST_IS_ADAPTER (adapter), 0);
 844
 845   return adapter->size;
 846 }
 847
 848 /**
 849  * gst_adapter_available_fast:
 850  * @adapter: a #GstAdapter
 851  *
 852  * Gets the maximum number of bytes that are immediately available without
 853  * requiring any expensive operations (like copying the data into a
 854  * temporary buffer).
 855  *
 856  * Returns: number of bytes that are available in @adapter without expensive
 857  * operations
 858  */
 859 gsize
 860 gst_adapter_available_fast (GstAdapter * adapter)
 861 {
 862   GstBuffer *cur;
 863   gsize size;
 864   GSList *g;
 865
 866   g_return_val_if_fail (GST_IS_ADAPTER (adapter), 0);
 867
 868   /* no data */
 869   if (adapter->size == 0)
 870     return 0;
 871
 872   /* some stuff we already assembled */
 873   if (adapter->assembled_len)
 874     return adapter->assembled_len;
 875
 876   /* take the first non-zero buffer */
 877   g = adapter->buflist;
 878   while (TRUE) {
 879     cur = g->data;
 880     size = gst_buffer_get_size (cur);
 881     if (size != 0)
 882       break;
 883     g = g_slist_next (g);
 884   }
 885
 886   /* we can quickly get the (remaining) data of the first buffer */
 887   return size - adapter->skip;
 888 }
 889
 890 /**
 891  * gst_adapter_prev_pts:
 892  * @adapter: a #GstAdapter
 893  * @distance: (out) (allow-none): pointer to location for distance, or NULL
 894  *
 895  * Get the pts that was before the current byte in the adapter. When
 896  * @distance is given, the amount of bytes between the pts and the current
 897  * position is returned.
 898  *
 899  * The pts 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 pts is removed from the adapter, the pts
 902  * and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.
 903  *
 904  * Returns: The previously seen pts.
 905  */
 906 GstClockTime
 907 gst_adapter_prev_pts (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->pts_distance;
 913
 914   return adapter->priv->pts;
 915 }
 916
 917 /**
 918  * gst_adapter_prev_dts:
 919  * @adapter: a #GstAdapter
 920  * @distance: (out) (allow-none): pointer to location for distance, or NULL
 921  *
 922  * Get the dts that was before the current byte in the adapter. When
 923  * @distance is given, the amount of bytes between the dts and the current
 924  * position is returned.
 925  *
 926  * The dts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
 927  * the adapter is first created or when it is cleared. This also means that before
 928  * the first byte with a dts is removed from the adapter, the dts
 929  * and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.
 930  *
 931  * Returns: The previously seen dts.
 932  */
 933 GstClockTime
 934 gst_adapter_prev_dts (GstAdapter * adapter, guint64 * distance)
 935 {
 936   g_return_val_if_fail (GST_IS_ADAPTER (adapter), GST_CLOCK_TIME_NONE);
 937
 938   if (distance)
 939     *distance = adapter->priv->dts_distance;
 940
 941   return adapter->priv->dts;
 942 }
 943
 944 /**
 945  * gst_adapter_masked_scan_uint32_peek:
 946  * @adapter: a #GstAdapter
 947  * @mask: mask to apply to data before matching against @pattern
 948  * @pattern: pattern to match (after mask is applied)
 949  * @offset: offset into the adapter data from which to start scanning, returns
 950  *          the last scanned position.
 951  * @size: number of bytes to scan from offset
 952  * @value: pointer to uint32 to return matching data
 953  *
 954  * Scan for pattern @pattern with applied mask @mask in the adapter data,
 955  * starting from offset @offset.  If a match is found, the value that matched
 956  * is returned through @value, otherwise @value is left untouched.
 957  *
 958  * The bytes in @pattern and @mask are interpreted left-to-right, regardless
 959  * of endianness.  All four bytes of the pattern must be present in the
 960  * adapter for it to match, even if the first or last bytes are masked out.
 961  *
 962  * It is an error to call this function without making sure that there is
 963  * enough data (offset+size bytes) in the adapter.
 964  *
 965  * Returns: offset of the first match, or -1 if no match was found.
 966  *
 967  * Since: 0.10.30
 968  */
 969 gsize
 970 gst_adapter_masked_scan_uint32_peek (GstAdapter * adapter, guint32 mask,
 971     guint32 pattern, gsize offset, gsize size, guint32 * value)
 972 {
 973   GSList *g;
 974   gsize skip, bsize, i;
 975   guint32 state;
 976   GstMapInfo info;
 977   guint8 *bdata;
 978   GstBuffer *buf;
 979
 980   g_return_val_if_fail (size > 0, -1);
 981   g_return_val_if_fail (offset + size <= adapter->size, -1);
 982   g_return_val_if_fail (((~mask) & pattern) == 0, -1);
 983
 984   /* we can't find the pattern with less than 4 bytes */
 985   if (G_UNLIKELY (size < 4))
 986     return -1;
 987
 988   skip = offset + adapter->skip;
 989
 990   /* first step, do skipping and position on the first buffer */
 991   /* optimistically assume scanning continues sequentially */
 992   if (adapter->priv->scan_entry && (adapter->priv->scan_offset <= skip)) {
 993     g = adapter->priv->scan_entry;
 994     skip -= adapter->priv->scan_offset;
 995   } else {
 996     g = adapter->buflist;
 997     adapter->priv->scan_offset = 0;
 998     adapter->priv->scan_entry = NULL;
 999   }
1000   buf = g->data;
1001   bsize = gst_buffer_get_size (buf);
1002   while (G_UNLIKELY (skip >= bsize)) {
1003     skip -= bsize;
1004     g = g_slist_next (g);
1005     adapter->priv->scan_offset += bsize;
1006     adapter->priv->scan_entry = g;
1007     buf = g->data;
1008     bsize = gst_buffer_get_size (buf);
1009   }
1010   /* get the data now */
1011   if (!gst_buffer_map (buf, &info, GST_MAP_READ))
1012     return -1;
1013
1014   bdata = (guint8 *) info.data + skip;
1015   bsize = info.size - skip;
1016   skip = 0;
1017
1018   /* set the state to something that does not match */
1019   state = ~pattern;
1020
1021   /* now find data */
1022   do {
1023     bsize = MIN (bsize, size);
1024     for (i = 0; i < bsize; i++) {
1025       state = ((state << 8) | bdata[i]);
1026       if (G_UNLIKELY ((state & mask) == pattern)) {
1027         /* we have a match but we need to have skipped at
1028          * least 4 bytes to fill the state. */
1029         if (G_LIKELY (skip + i >= 3)) {
1030           if (G_LIKELY (value))
1031             *value = state;
1032           gst_buffer_unmap (buf, &info);
1033           return offset + skip + i - 3;
1034         }
1035       }
1036     }
1037     size -= bsize;
1038     if (size == 0)
1039       break;
1040
1041     /* nothing found yet, go to next buffer */
1042     skip += bsize;
1043     g = g_slist_next (g);
1044     adapter->priv->scan_offset += info.size;
1045     adapter->priv->scan_entry = g;
1046     gst_buffer_unmap (buf, &info);
1047     buf = g->data;
1048
1049     gst_buffer_map (buf, &info, GST_MAP_READ);
1050     bsize = info.size;
1051     bdata = info.data;
1052   } while (TRUE);
1053
1054   gst_buffer_unmap (buf, &info);
1055
1056   /* nothing found */
1057   return -1;
1058 }
1059
1060 /**
1061  * gst_adapter_masked_scan_uint32:
1062  * @adapter: a #GstAdapter
1063  * @mask: mask to apply to data before matching against @pattern
1064  * @pattern: pattern to match (after mask is applied)
1065  * @offset: offset into the adapter data from which to start scanning, returns
1066  *          the last scanned position.
1067  * @size: number of bytes to scan from offset
1068  *
1069  * Scan for pattern @pattern with applied mask @mask in the adapter data,
1070  * starting from offset @offset.
1071  *
1072  * The bytes in @pattern and @mask are interpreted left-to-right, regardless
1073  * of endianness.  All four bytes of the pattern must be present in the
1074  * adapter for it to match, even if the first or last bytes are masked out.
1075  *
1076  * It is an error to call this function without making sure that there is
1077  * enough data (offset+size bytes) in the adapter.
1078  *
1079  * This function calls gst_adapter_masked_scan_uint32_peek() passing NULL
1080  * for value.
1081  *
1082  * Returns: offset of the first match, or -1 if no match was found.
1083  *
1084  * Example:
1085  * <programlisting>
1086  * // Assume the adapter contains 0x00 0x01 0x02 ... 0xfe 0xff
1087  *
1088  * gst_adapter_masked_scan_uint32 (adapter, 0xffffffff, 0x00010203, 0, 256);
1089  * // -> returns 0
1090  * gst_adapter_masked_scan_uint32 (adapter, 0xffffffff, 0x00010203, 1, 255);
1091  * // -> returns -1
1092  * gst_adapter_masked_scan_uint32 (adapter, 0xffffffff, 0x01020304, 1, 255);
1093  * // -> returns 1
1094  * gst_adapter_masked_scan_uint32 (adapter, 0xffff, 0x0001, 0, 256);
1095  * // -> returns -1
1096  * gst_adapter_masked_scan_uint32 (adapter, 0xffff, 0x0203, 0, 256);
1097  * // -> returns 0
1098  * gst_adapter_masked_scan_uint32 (adapter, 0xffff0000, 0x02030000, 0, 256);
1099  * // -> returns 2
1100  * gst_adapter_masked_scan_uint32 (adapter, 0xffff0000, 0x02030000, 0, 4);
1101  * // -> returns -1
1102  * </programlisting>
1103  *
1104  * Since: 0.10.24
1105  */
1106 gsize
1107 gst_adapter_masked_scan_uint32 (GstAdapter * adapter, guint32 mask,
1108     guint32 pattern, gsize offset, gsize size)
1109 {
1110   return gst_adapter_masked_scan_uint32_peek (adapter, mask, pattern, offset,
1111       size, NULL);
1112 }