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., 51 Franklin St, Fifth Floor,
  18  * Boston, MA 02110-1301, 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, GstObject *parent, GstBuffer *buffer)
  49  * {
  50  *   MyElement *this;
  51  *   GstAdapter *adapter;
  52  *   GstFlowReturn ret = GST_FLOW_OK;
  53  *
  54  *   this = MY_ELEMENT (parent);
  55  *
  56  *   adapter = this->adapter;
  57  *
  58  *   // put buffer into adapter
  59  *   gst_adapter_push (adapter, buffer);
  60  *
  61  *   // while we can read out 512 bytes, process them
  62  *   while (gst_adapter_available (adapter) >= 512 && ret == GST_FLOW_OK) {
  63  *     const guint8 *data = gst_adapter_map (adapter, 512);
  64  *     // use flowreturn as an error value
  65  *     ret = my_library_foo (data);
  66  *     gst_adapter_unmap (adapter);
  67  *     gst_adapter_flush (adapter, 512);
  68  *   }
  69  *   return ret;
  70  * }
  71  * ]|
  72  *
  73  * For another example, a simple element inside GStreamer that uses GstAdapter
  74  * is the libvisual element.
  75  *
  76  * An element using GstAdapter in its sink pad chain function should ensure that
  77  * when the FLUSH_STOP event is received, that any queued data is cleared using
  78  * gst_adapter_clear(). Data should also be cleared or processed on EOS and
  79  * when changing state from #GST_STATE_PAUSED to #GST_STATE_READY.
  80  *
  81  * Also check the GST_BUFFER_FLAG_DISCONT flag on the buffer. Some elements might
  82  * need to clear the adapter after a discontinuity.
  83  *
  84  * The adapter will keep track of the timestamps of the buffers
  85  * that were pushed. The last seen timestamp before the current position
  86  * can be queried with gst_adapter_prev_pts(). This function can
  87  * optionally return the amount of bytes between the start of the buffer that
  88  * carried the timestamp and the current adapter position. The distance is
  89  * useful when dealing with, for example, raw audio samples because it allows
  90  * you to calculate the timestamp of the current adapter position by using the
  91  * last seen timestamp and the amount of bytes since.
  92  *
  93  * A last thing to note is that while GstAdapter is pretty optimized,
  94  * merging buffers still might be an operation that requires a malloc() and
  95  * memcpy() operation, and these operations are not the fastest. Because of
  96  * this, some functions like gst_adapter_available_fast() are provided to help
  97  * speed up such cases should you want to. To avoid repeated memory allocations,
  98  * gst_adapter_copy() can be used to copy data into a (statically allocated)
  99  * user provided buffer.
 100  *
 101  * GstAdapter is not MT safe. All operations on an adapter must be serialized by
 102  * the caller. This is not normally a problem, however, as the normal use case
 103  * of GstAdapter is inside one pad's chain function, in which case access is
 104  * serialized via the pad's STREAM_LOCK.
 105  *
 106  * Note that gst_adapter_push() takes ownership of the buffer passed. Use
 107  * gst_buffer_ref() before pushing it into the adapter if you still want to
 108  * access the buffer later. The adapter will never modify the data in the
 109  * buffer pushed in it.
 110  *
 111  * Last reviewed on 2009-05-13 (0.10.24).
 112  */
 113
 114 #include <gst/gst_private.h>
 115 #include "gstadapter.h"
 116 #include <string.h>
 117
 118 /* default size for the assembled data buffer */
 119 #define DEFAULT_SIZE 4096
 120
 121 static void gst_adapter_flush_unchecked (GstAdapter * adapter, gsize flush);
 122
 123 GST_DEBUG_CATEGORY_STATIC (gst_adapter_debug);
 124 #define GST_CAT_DEFAULT gst_adapter_debug
 125
 126 struct _GstAdapter
 127 {
 128   GObject object;
 129
 130   /*< private > */
 131   GSList *buflist;
 132   GSList *buflist_end;
 133   gsize size;
 134   gsize skip;
 135
 136   /* we keep state of assembled pieces */
 137   gpointer assembled_data;
 138   gsize assembled_size;
 139   gsize assembled_len;
 140
 141   GstClockTime pts;
 142   guint64 pts_distance;
 143   GstClockTime dts;
 144   guint64 dts_distance;
 145
 146   gsize scan_offset;
 147   GSList *scan_entry;
 148
 149   GstMapInfo info;
 150 };
 151
 152 struct _GstAdapterClass
 153 {
 154   GObjectClass parent_class;
 155 };
 156
 157 #define _do_init \
 158   GST_DEBUG_CATEGORY_INIT (gst_adapter_debug, "adapter", 0, "object to splice and merge buffers to desired size")
 159 #define gst_adapter_parent_class parent_class
 160 G_DEFINE_TYPE_WITH_CODE (GstAdapter, gst_adapter, G_TYPE_OBJECT, _do_init);
 161
 162 static void gst_adapter_dispose (GObject * object);
 163 static void gst_adapter_finalize (GObject * object);
 164
 165 static void
 166 gst_adapter_class_init (GstAdapterClass * klass)
 167 {
 168   GObjectClass *object = G_OBJECT_CLASS (klass);
 169
 170   object->dispose = gst_adapter_dispose;
 171   object->finalize = gst_adapter_finalize;
 172 }
 173
 174 static void
 175 gst_adapter_init (GstAdapter * adapter)
 176 {
 177   adapter->assembled_data = g_malloc (DEFAULT_SIZE);
 178   adapter->assembled_size = DEFAULT_SIZE;
 179   adapter->pts = GST_CLOCK_TIME_NONE;
 180   adapter->pts_distance = 0;
 181   adapter->dts = GST_CLOCK_TIME_NONE;
 182   adapter->dts_distance = 0;
 183 }
 184
 185 static void
 186 gst_adapter_dispose (GObject * object)
 187 {
 188   GstAdapter *adapter = GST_ADAPTER (object);
 189
 190   gst_adapter_clear (adapter);
 191
 192   GST_CALL_PARENT (G_OBJECT_CLASS, dispose, (object));
 193 }
 194
 195 static void
 196 gst_adapter_finalize (GObject * object)
 197 {
 198   GstAdapter *adapter = GST_ADAPTER (object);
 199
 200   g_free (adapter->assembled_data);
 201
 202   GST_CALL_PARENT (G_OBJECT_CLASS, finalize, (object));
 203 }
 204
 205 /**
 206  * gst_adapter_new:
 207  *
 208  * Creates a new #GstAdapter. Free with g_object_unref().
 209  *
 210  * Returns: (transfer full): a new #GstAdapter
 211  */
 212 GstAdapter *
 213 gst_adapter_new (void)
 214 {
 215   return g_object_newv (GST_TYPE_ADAPTER, 0, NULL);
 216 }
 217
 218 /**
 219  * gst_adapter_clear:
 220  * @adapter: a #GstAdapter
 221  *
 222  * Removes all buffers from @adapter.
 223  */
 224 void
 225 gst_adapter_clear (GstAdapter * adapter)
 226 {
 227   g_return_if_fail (GST_IS_ADAPTER (adapter));
 228
 229   if (adapter->info.memory)
 230     gst_adapter_unmap (adapter);
 231
 232   g_slist_foreach (adapter->buflist, (GFunc) gst_mini_object_unref, NULL);
 233   g_slist_free (adapter->buflist);
 234   adapter->buflist = NULL;
 235   adapter->buflist_end = NULL;
 236   adapter->size = 0;
 237   adapter->skip = 0;
 238   adapter->assembled_len = 0;
 239   adapter->pts = GST_CLOCK_TIME_NONE;
 240   adapter->pts_distance = 0;
 241   adapter->dts = GST_CLOCK_TIME_NONE;
 242   adapter->dts_distance = 0;
 243   adapter->scan_offset = 0;
 244   adapter->scan_entry = NULL;
 245 }
 246
 247 static inline void
 248 update_timestamps (GstAdapter * adapter, GstBuffer * buf)
 249 {
 250   GstClockTime pts, dts;
 251
 252   pts = GST_BUFFER_PTS (buf);
 253   if (GST_CLOCK_TIME_IS_VALID (pts)) {
 254     GST_LOG_OBJECT (adapter, "new pts %" GST_TIME_FORMAT, GST_TIME_ARGS (pts));
 255     adapter->pts = pts;
 256     adapter->pts_distance = 0;
 257   }
 258   dts = GST_BUFFER_DTS (buf);
 259   if (GST_CLOCK_TIME_IS_VALID (dts)) {
 260     GST_LOG_OBJECT (adapter, "new dts %" GST_TIME_FORMAT, GST_TIME_ARGS (dts));
 261     adapter->dts = dts;
 262     adapter->dts_distance = 0;
 263   }
 264 }
 265
 266 /* copy data into @dest, skipping @skip bytes from the head buffers */
 267 static void
 268 copy_into_unchecked (GstAdapter * adapter, guint8 * dest, gsize skip,
 269     gsize size)
 270 {
 271   GSList *g;
 272   GstBuffer *buf;
 273   gsize bsize, csize;
 274
 275   /* first step, do skipping */
 276   /* we might well be copying where we were scanning */
 277   if (adapter->scan_entry && (adapter->scan_offset <= skip)) {
 278     g = adapter->scan_entry;
 279     skip -= adapter->scan_offset;
 280   } else {
 281     g = adapter->buflist;
 282   }
 283   buf = g->data;
 284   bsize = gst_buffer_get_size (buf);
 285   while (G_UNLIKELY (skip >= bsize)) {
 286     skip -= bsize;
 287     g = g_slist_next (g);
 288     buf = g->data;
 289     bsize = gst_buffer_get_size (buf);
 290   }
 291   /* copy partial buffer */
 292   csize = MIN (bsize - skip, size);
 293   GST_DEBUG ("bsize %" G_GSIZE_FORMAT ", skip %" G_GSIZE_FORMAT ", csize %"
 294       G_GSIZE_FORMAT, bsize, skip, csize);
 295   GST_CAT_LOG_OBJECT (GST_CAT_PERFORMANCE, adapter, "extract %" G_GSIZE_FORMAT
 296       " bytes", csize);
 297   gst_buffer_extract (buf, skip, dest, csize);
 298   size -= csize;
 299   dest += csize;
 300
 301   /* second step, copy remainder */
 302   while (size > 0) {
 303     g = g_slist_next (g);
 304     buf = g->data;
 305     bsize = gst_buffer_get_size (buf);
 306     if (G_LIKELY (bsize > 0)) {
 307       csize = MIN (bsize, size);
 308       GST_CAT_LOG_OBJECT (GST_CAT_PERFORMANCE, adapter,
 309           "extract %" G_GSIZE_FORMAT " bytes", csize);
 310       gst_buffer_extract (buf, 0, dest, csize);
 311       size -= csize;
 312       dest += csize;
 313     }
 314   }
 315 }
 316
 317 /**
 318  * gst_adapter_push:
 319  * @adapter: a #GstAdapter
 320  * @buf: (transfer full): a #GstBuffer to add to queue in the adapter
 321  *
 322  * Adds the data from @buf to the data stored inside @adapter and takes
 323  * ownership of the buffer.
 324  */
 325 void
 326 gst_adapter_push (GstAdapter * adapter, GstBuffer * buf)
 327 {
 328   gsize size;
 329
 330   g_return_if_fail (GST_IS_ADAPTER (adapter));
 331   g_return_if_fail (GST_IS_BUFFER (buf));
 332
 333   size = gst_buffer_get_size (buf);
 334   adapter->size += size;
 335
 336   /* Note: merging buffers at this point is premature. */
 337   if (G_UNLIKELY (adapter->buflist == NULL)) {
 338     GST_LOG_OBJECT (adapter, "pushing %p first %" G_GSIZE_FORMAT " bytes",
 339         buf, size);
 340     adapter->buflist = adapter->buflist_end = g_slist_append (NULL, buf);
 341     update_timestamps (adapter, buf);
 342   } else {
 343     /* Otherwise append to the end, and advance our end pointer */
 344     GST_LOG_OBJECT (adapter, "pushing %p %" G_GSIZE_FORMAT " bytes at end, "
 345         "size now %" G_GSIZE_FORMAT, buf, size, adapter->size);
 346     adapter->buflist_end = g_slist_append (adapter->buflist_end, buf);
 347     adapter->buflist_end = g_slist_next (adapter->buflist_end);
 348   }
 349 }
 350
 351 #if 0
 352 /* Internal method only. Tries to merge buffers at the head of the queue
 353  * to form a single larger buffer of size 'size'.
 354  *
 355  * Returns TRUE if it managed to merge anything.
 356  */
 357 static gboolean
 358 gst_adapter_try_to_merge_up (GstAdapter * adapter, gsize size)
 359 {
 360   GstBuffer *cur, *head;
 361   GSList *g;
 362   gboolean ret = FALSE;
 363   gsize hsize;
 364
 365   g = adapter->buflist;
 366   if (g == NULL)
 367     return FALSE;
 368
 369   head = g->data;
 370
 371   hsize = gst_buffer_get_size (head);
 372
 373   /* Remove skipped part from the buffer (otherwise the buffer might grow indefinitely) */
 374   head = gst_buffer_make_writable (head);
 375   gst_buffer_resize (head, adapter->skip, hsize - adapter->skip);
 376   hsize -= adapter->skip;
 377   adapter->skip = 0;
 378   g->data = head;
 379
 380   g = g_slist_next (g);
 381
 382   while (g != NULL && hsize < size) {
 383     cur = g->data;
 384     /* Merge the head buffer and the next in line */
 385     GST_LOG_OBJECT (adapter, "Merging buffers of size %" G_GSIZE_FORMAT " & %"
 386         G_GSIZE_FORMAT " in search of target %" G_GSIZE_FORMAT,
 387         hsize, gst_buffer_get_size (cur), size);
 388
 389     head = gst_buffer_append (head, cur);
 390     hsize = gst_buffer_get_size (head);
 391     ret = TRUE;
 392
 393     /* Delete the front list item, and store our new buffer in the 2nd list
 394      * item */
 395     adapter->buflist = g_slist_delete_link (adapter->buflist, adapter->buflist);
 396     g->data = head;
 397
 398     /* invalidate scan position */
 399     adapter->scan_offset = 0;
 400     adapter->scan_entry = NULL;
 401
 402     g = g_slist_next (g);
 403   }
 404
 405   return ret;
 406 }
 407 #endif
 408
 409 /**
 410  * gst_adapter_map:
 411  * @adapter: a #GstAdapter
 412  * @size: the number of bytes to map/peek
 413  *
 414  * Gets the first @size bytes stored in the @adapter. The returned pointer is
 415  * valid until the next function is called on the adapter.
 416  *
 417  * Note that setting the returned pointer as the data of a #GstBuffer is
 418  * incorrect for general-purpose plugins. The reason is that if a downstream
 419  * element stores the buffer so that it has access to it outside of the bounds
 420  * of its chain function, the buffer will have an invalid data pointer after
 421  * your element flushes the bytes. In that case you should use
 422  * gst_adapter_take(), which returns a freshly-allocated buffer that you can set
 423  * as #GstBuffer memory or the potentially more performant
 424  * gst_adapter_take_buffer().
 425  *
 426  * Returns #NULL if @size bytes are not available.
 427  *
 428  * Returns: (transfer none) (array length=size) (element-type guint8):
 429  *     a pointer to the first @size bytes of data, or NULL
 430  */
 431 gconstpointer
 432 gst_adapter_map (GstAdapter * adapter, gsize size)
 433 {
 434   GstBuffer *cur;
 435   gsize skip, csize;
 436   gsize toreuse, tocopy;
 437   guint8 *data;
 438
 439   g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
 440   g_return_val_if_fail (size > 0, NULL);
 441
 442   if (adapter->info.memory)
 443     gst_adapter_unmap (adapter);
 444
 445   /* we don't have enough data, return NULL. This is unlikely
 446    * as one usually does an _available() first instead of peeking a
 447    * random size. */
 448   if (G_UNLIKELY (size > adapter->size))
 449     return NULL;
 450
 451   /* we have enough assembled data, return it */
 452   if (adapter->assembled_len >= size)
 453     return adapter->assembled_data;
 454
 455 #if 0
 456   do {
 457 #endif
 458     cur = adapter->buflist->data;
 459     skip = adapter->skip;
 460
 461     csize = gst_buffer_get_size (cur);
 462     if (csize >= size + skip) {
 463       if (!gst_buffer_map (cur, &adapter->info, GST_MAP_READ))
 464         return FALSE;
 465
 466       return (guint8 *) adapter->info.data + skip;
 467     }
 468     /* We may be able to efficiently merge buffers in our pool to
 469      * gather a big enough chunk to return it from the head buffer directly */
 470 #if 0
 471   } while (gst_adapter_try_to_merge_up (adapter, size));
 472 #endif
 473
 474   /* see how much data we can reuse from the assembled memory and how much
 475    * we need to copy */
 476   toreuse = adapter->assembled_len;
 477   tocopy = size - toreuse;
 478
 479   /* Gonna need to copy stuff out */
 480   if (G_UNLIKELY (adapter->assembled_size < size)) {
 481     adapter->assembled_size = (size / DEFAULT_SIZE + 1) * DEFAULT_SIZE;
 482     GST_DEBUG_OBJECT (adapter, "resizing internal buffer to %" G_GSIZE_FORMAT,
 483         adapter->assembled_size);
 484     if (toreuse == 0) {
 485       GST_CAT_DEBUG (GST_CAT_PERFORMANCE, "alloc new buffer");
 486       /* no g_realloc to avoid a memcpy that is not desired here since we are
 487        * not going to reuse any data here */
 488       g_free (adapter->assembled_data);
 489       adapter->assembled_data = g_malloc (adapter->assembled_size);
 490     } else {
 491       /* we are going to reuse all data, realloc then */
 492       GST_CAT_DEBUG (GST_CAT_PERFORMANCE, "reusing %" G_GSIZE_FORMAT " bytes",
 493           toreuse);
 494       adapter->assembled_data =
 495           g_realloc (adapter->assembled_data, adapter->assembled_size);
 496     }
 497   }
 498   GST_CAT_DEBUG (GST_CAT_PERFORMANCE, "copy remaining %" G_GSIZE_FORMAT
 499       " bytes from adapter", tocopy);
 500   data = adapter->assembled_data;
 501   copy_into_unchecked (adapter, data + toreuse, skip + toreuse, tocopy);
 502   adapter->assembled_len = size;
 503
 504   return adapter->assembled_data;
 505 }
 506
 507 /**
 508  * gst_adapter_unmap:
 509  * @adapter: a #GstAdapter
 510  *
 511  * Releases the memory obtained with the last gst_adapter_map().
 512  */
 513 void
 514 gst_adapter_unmap (GstAdapter * adapter)
 515 {
 516   g_return_if_fail (GST_IS_ADAPTER (adapter));
 517
 518   if (adapter->info.memory) {
 519     GstBuffer *cur = adapter->buflist->data;
 520     GST_LOG_OBJECT (adapter, "unmap memory buffer %p", cur);
 521     gst_buffer_unmap (cur, &adapter->info);
 522     adapter->info.memory = NULL;
 523   }
 524 }
 525
 526 /**
 527  * gst_adapter_copy:
 528  * @adapter: a #GstAdapter
 529  * @dest: (out caller-allocates) (array length=size) (element-type guint8):
 530  *     the memory to copy into
 531  * @offset: the bytes offset in the adapter to start from
 532  * @size: the number of bytes to copy
 533  *
 534  * Copies @size bytes of data starting at @offset out of the buffers
 535  * contained in @GstAdapter into an array @dest provided by the caller.
 536  *
 537  * The array @dest should be large enough to contain @size bytes.
 538  * The user should check that the adapter has (@offset + @size) bytes
 539  * available before calling this function.
 540  */
 541 void
 542 gst_adapter_copy (GstAdapter * adapter, gpointer dest, gsize offset, gsize size)
 543 {
 544   g_return_if_fail (GST_IS_ADAPTER (adapter));
 545   g_return_if_fail (size > 0);
 546   g_return_if_fail (offset + size <= adapter->size);
 547
 548   copy_into_unchecked (adapter, dest, offset + adapter->skip, size);
 549 }
 550
 551 /*Flushes the first @flush bytes in the @adapter*/
 552 static void
 553 gst_adapter_flush_unchecked (GstAdapter * adapter, gsize flush)
 554 {
 555   GstBuffer *cur;
 556   gsize size;
 557   GSList *g;
 558
 559   GST_LOG_OBJECT (adapter, "flushing %" G_GSIZE_FORMAT " bytes", flush);
 560
 561   if (adapter->info.memory)
 562     gst_adapter_unmap (adapter);
 563
 564   /* clear state */
 565   adapter->size -= flush;
 566   adapter->assembled_len = 0;
 567
 568   /* take skip into account */
 569   flush += adapter->skip;
 570   /* distance is always at least the amount of skipped bytes */
 571   adapter->pts_distance -= adapter->skip;
 572   adapter->dts_distance -= adapter->skip;
 573
 574   g = adapter->buflist;
 575   cur = g->data;
 576   size = gst_buffer_get_size (cur);
 577   while (flush >= size) {
 578     /* can skip whole buffer */
 579     GST_LOG_OBJECT (adapter, "flushing out head buffer");
 580     adapter->pts_distance += size;
 581     adapter->dts_distance += size;
 582     flush -= size;
 583
 584     gst_buffer_unref (cur);
 585     g = g_slist_delete_link (g, g);
 586
 587     if (G_UNLIKELY (g == NULL)) {
 588       GST_LOG_OBJECT (adapter, "adapter empty now");
 589       adapter->buflist_end = NULL;
 590       break;
 591     }
 592     /* there is a new head buffer, update the timestamps */
 593     cur = g->data;
 594     update_timestamps (adapter, cur);
 595     size = gst_buffer_get_size (cur);
 596   }
 597   adapter->buflist = g;
 598   /* account for the remaining bytes */
 599   adapter->skip = flush;
 600   adapter->pts_distance += flush;
 601   adapter->dts_distance += flush;
 602   /* invalidate scan position */
 603   adapter->scan_offset = 0;
 604   adapter->scan_entry = NULL;
 605 }
 606
 607 /**
 608  * gst_adapter_flush:
 609  * @adapter: a #GstAdapter
 610  * @flush: the number of bytes to flush
 611  *
 612  * Flushes the first @flush bytes in the @adapter. The caller must ensure that
 613  * at least this many bytes are available.
 614  *
 615  * See also: gst_adapter_map(), gst_adapter_unmap()
 616  */
 617 void
 618 gst_adapter_flush (GstAdapter * adapter, gsize flush)
 619 {
 620   g_return_if_fail (GST_IS_ADAPTER (adapter));
 621   g_return_if_fail (flush <= adapter->size);
 622
 623   /* flushing out 0 bytes will do nothing */
 624   if (G_UNLIKELY (flush == 0))
 625     return;
 626
 627   gst_adapter_flush_unchecked (adapter, flush);
 628 }
 629
 630 /* internal function, nbytes should be flushed after calling this function */
 631 static guint8 *
 632 gst_adapter_take_internal (GstAdapter * adapter, gsize nbytes)
 633 {
 634   guint8 *data;
 635   gsize toreuse, tocopy;
 636
 637   /* see how much data we can reuse from the assembled memory and how much
 638    * we need to copy */
 639   toreuse = MIN (nbytes, adapter->assembled_len);
 640   tocopy = nbytes - toreuse;
 641
 642   /* find memory to return */
 643   if (adapter->assembled_size >= nbytes && toreuse > 0) {
 644     /* we reuse already allocated memory but only when we're going to reuse
 645      * something from it because else we are worse than the malloc and copy
 646      * case below */
 647     GST_LOG_OBJECT (adapter, "reusing %" G_GSIZE_FORMAT " bytes of assembled"
 648         " data", toreuse);
 649     /* we have enough free space in the assembled array */
 650     data = adapter->assembled_data;
 651     /* flush after this function should set the assembled_size to 0 */
 652     adapter->assembled_data = g_malloc (adapter->assembled_size);
 653   } else {
 654     GST_LOG_OBJECT (adapter, "allocating %" G_GSIZE_FORMAT " bytes", nbytes);
 655     /* not enough bytes in the assembled array, just allocate new space */
 656     data = g_malloc (nbytes);
 657     /* reuse what we can from the already assembled data */
 658     if (toreuse) {
 659       GST_LOG_OBJECT (adapter, "reusing %" G_GSIZE_FORMAT " bytes", toreuse);
 660       GST_CAT_LOG_OBJECT (GST_CAT_PERFORMANCE, adapter,
 661           "memcpy %" G_GSIZE_FORMAT " bytes", toreuse);
 662       memcpy (data, adapter->assembled_data, toreuse);
 663     }
 664   }
 665   if (tocopy) {
 666     /* copy the remaining data */
 667     copy_into_unchecked (adapter, toreuse + data, toreuse + adapter->skip,
 668         tocopy);
 669   }
 670   return data;
 671 }
 672
 673 /**
 674  * gst_adapter_take:
 675  * @adapter: a #GstAdapter
 676  * @nbytes: the number of bytes to take
 677  *
 678  * Returns a freshly allocated buffer containing the first @nbytes bytes of the
 679  * @adapter. The returned bytes will be flushed from the adapter.
 680  *
 681  * Caller owns returned value. g_free after usage.
 682  *
 683  * Free-function: g_free
 684  *
 685  * Returns: (transfer full) (array length=nbytes) (element-type guint8):
 686  *     oven-fresh hot data, or #NULL if @nbytes bytes are not available
 687  */
 688 gpointer
 689 gst_adapter_take (GstAdapter * adapter, gsize nbytes)
 690 {
 691   gpointer data;
 692
 693   g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
 694   g_return_val_if_fail (nbytes > 0, NULL);
 695
 696   /* we don't have enough data, return NULL. This is unlikely
 697    * as one usually does an _available() first instead of peeking a
 698    * random size. */
 699   if (G_UNLIKELY (nbytes > adapter->size))
 700     return NULL;
 701
 702   data = gst_adapter_take_internal (adapter, nbytes);
 703
 704   gst_adapter_flush_unchecked (adapter, nbytes);
 705
 706   return data;
 707 }
 708
 709 /**
 710  * gst_adapter_take_buffer:
 711  * @adapter: a #GstAdapter
 712  * @nbytes: the number of bytes to take
 713  *
 714  * Returns a #GstBuffer containing the first @nbytes bytes of the
 715  * @adapter. The returned bytes will be flushed from the adapter.
 716  * This function is potentially more performant than gst_adapter_take()
 717  * since it can reuse the memory in pushed buffers by subbuffering
 718  * or merging.
 719  *
 720  * Caller owns returned value. gst_buffer_unref() after usage.
 721  *
 722  * Free-function: gst_buffer_unref
 723  *
 724  * Returns: (transfer full): a #GstBuffer containing the first @nbytes of
 725  *     the adapter, or #NULL if @nbytes bytes are not available
 726  */
 727 GstBuffer *
 728 gst_adapter_take_buffer (GstAdapter * adapter, gsize nbytes)
 729 {
 730   GstBuffer *buffer;
 731   GstBuffer *cur;
 732   gsize hsize, skip;
 733   guint8 *data;
 734
 735   g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
 736   g_return_val_if_fail (nbytes > 0, NULL);
 737
 738   GST_LOG_OBJECT (adapter, "taking buffer of %" G_GSIZE_FORMAT " bytes",
 739       nbytes);
 740
 741   /* we don't have enough data, return NULL. This is unlikely
 742    * as one usually does an _available() first instead of grabbing a
 743    * random size. */
 744   if (G_UNLIKELY (nbytes > adapter->size))
 745     return NULL;
 746
 747   cur = adapter->buflist->data;
 748   skip = adapter->skip;
 749   hsize = gst_buffer_get_size (cur);
 750
 751   /* our head buffer has enough data left, return it */
 752   if (skip == 0 && hsize == nbytes) {
 753     GST_LOG_OBJECT (adapter, "providing buffer of %" G_GSIZE_FORMAT " bytes"
 754         " as head buffer", nbytes);
 755     buffer = gst_buffer_ref (cur);
 756     goto done;
 757   } else if (hsize >= nbytes + skip) {
 758     GST_LOG_OBJECT (adapter, "providing buffer of %" G_GSIZE_FORMAT " bytes"
 759         " via region copy", nbytes);
 760     buffer = gst_buffer_copy_region (cur, GST_BUFFER_COPY_ALL, skip, nbytes);
 761     goto done;
 762   }
 763 #if 0
 764   if (gst_adapter_try_to_merge_up (adapter, nbytes)) {
 765     /* Merged something, let's try again for sub-buffering */
 766     cur = adapter->buflist->data;
 767     skip = adapter->skip;
 768     if (gst_buffer_get_size (cur) >= nbytes + skip) {
 769       GST_LOG_OBJECT (adapter, "providing buffer of %" G_GSIZE_FORMAT " bytes"
 770           " via sub-buffer", nbytes);
 771       buffer = gst_buffer_copy_region (cur, GST_BUFFER_COPY_ALL, skip, nbytes);
 772       goto done;
 773     }
 774   }
 775 #endif
 776
 777   data = gst_adapter_take_internal (adapter, nbytes);
 778
 779   buffer = gst_buffer_new_wrapped (data, nbytes);
 780
 781 done:
 782   gst_adapter_flush_unchecked (adapter, nbytes);
 783
 784   return buffer;
 785 }
 786
 787 /**
 788  * gst_adapter_take_list:
 789  * @adapter: a #GstAdapter
 790  * @nbytes: the number of bytes to take
 791  *
 792  * Returns a #GList of buffers containing the first @nbytes bytes of the
 793  * @adapter. The returned bytes will be flushed from the adapter.
 794  * When the caller can deal with individual buffers, this function is more
 795  * performant because no memory should be copied.
 796  *
 797  * Caller owns returned list and contained buffers. gst_buffer_unref() each
 798  * buffer in the list before freeing the list after usage.
 799  *
 800  * Returns: (element-type Gst.Buffer) (transfer full): a #GList of buffers
 801  *     containing the first @nbytes of the adapter, or #NULL if @nbytes bytes
 802  *     are not available
 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->pts_distance;
 913
 914   return adapter->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->dts_distance;
 940
 941   return adapter->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 gssize
 968 gst_adapter_masked_scan_uint32_peek (GstAdapter * adapter, guint32 mask,
 969     guint32 pattern, gsize offset, gsize size, guint32 * value)
 970 {
 971   GSList *g;
 972   gsize skip, bsize, i;
 973   guint32 state;
 974   GstMapInfo info;
 975   guint8 *bdata;
 976   GstBuffer *buf;
 977
 978   g_return_val_if_fail (size > 0, -1);
 979   g_return_val_if_fail (offset + size <= adapter->size, -1);
 980   g_return_val_if_fail (((~mask) & pattern) == 0, -1);
 981
 982   /* we can't find the pattern with less than 4 bytes */
 983   if (G_UNLIKELY (size < 4))
 984     return -1;
 985
 986   skip = offset + adapter->skip;
 987
 988   /* first step, do skipping and position on the first buffer */
 989   /* optimistically assume scanning continues sequentially */
 990   if (adapter->scan_entry && (adapter->scan_offset <= skip)) {
 991     g = adapter->scan_entry;
 992     skip -= adapter->scan_offset;
 993   } else {
 994     g = adapter->buflist;
 995     adapter->scan_offset = 0;
 996     adapter->scan_entry = NULL;
 997   }
 998   buf = g->data;
 999   bsize = gst_buffer_get_size (buf);
1000   while (G_UNLIKELY (skip >= bsize)) {
1001     skip -= bsize;
1002     g = g_slist_next (g);
1003     adapter->scan_offset += bsize;
1004     adapter->scan_entry = g;
1005     buf = g->data;
1006     bsize = gst_buffer_get_size (buf);
1007   }
1008   /* get the data now */
1009   if (!gst_buffer_map (buf, &info, GST_MAP_READ))
1010     return -1;
1011
1012   bdata = (guint8 *) info.data + skip;
1013   bsize = info.size - skip;
1014   skip = 0;
1015
1016   /* set the state to something that does not match */
1017   state = ~pattern;
1018
1019   /* now find data */
1020   do {
1021     bsize = MIN (bsize, size);
1022     for (i = 0; i < bsize; i++) {
1023       state = ((state << 8) | bdata[i]);
1024       if (G_UNLIKELY ((state & mask) == pattern)) {
1025         /* we have a match but we need to have skipped at
1026          * least 4 bytes to fill the state. */
1027         if (G_LIKELY (skip + i >= 3)) {
1028           if (G_LIKELY (value))
1029             *value = state;
1030           gst_buffer_unmap (buf, &info);
1031           return offset + skip + i - 3;
1032         }
1033       }
1034     }
1035     size -= bsize;
1036     if (size == 0)
1037       break;
1038
1039     /* nothing found yet, go to next buffer */
1040     skip += bsize;
1041     g = g_slist_next (g);
1042     adapter->scan_offset += info.size;
1043     adapter->scan_entry = g;
1044     gst_buffer_unmap (buf, &info);
1045     buf = g->data;
1046
1047     if (!gst_buffer_map (buf, &info, GST_MAP_READ))
1048       return -1;
1049
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 gssize
1105 gst_adapter_masked_scan_uint32 (GstAdapter * adapter, guint32 mask,
1106     guint32 pattern, gsize offset, gsize size)
1107 {
1108   return gst_adapter_masked_scan_uint32_peek (adapter, mask, pattern, offset,
1109       size, NULL);
1110 }