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