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       g_assert (gst_buffer_map (cur, &priv->info, GST_MAP_READ));
 450       return (guint8 *) priv->info.data + skip;
 451     }
 452     /* We may be able to efficiently merge buffers in our pool to
 453      * gather a big enough chunk to return it from the head buffer directly */
 454   } while (gst_adapter_try_to_merge_up (adapter, size));
 455
 456   /* see how much data we can reuse from the assembled memory and how much
 457    * we need to copy */
 458   toreuse = adapter->assembled_len;
 459   tocopy = size - toreuse;
 460
 461   /* Gonna need to copy stuff out */
 462   if (G_UNLIKELY (adapter->assembled_size < size)) {
 463     adapter->assembled_size = (size / DEFAULT_SIZE + 1) * DEFAULT_SIZE;
 464     GST_DEBUG_OBJECT (adapter, "resizing internal buffer to %" G_GSIZE_FORMAT,
 465         adapter->assembled_size);
 466     if (toreuse == 0) {
 467       GST_CAT_DEBUG (GST_CAT_PERFORMANCE, "alloc new buffer");
 468       /* no g_realloc to avoid a memcpy that is not desired here since we are
 469        * not going to reuse any data here */
 470       g_free (adapter->assembled_data);
 471       adapter->assembled_data = g_malloc (adapter->assembled_size);
 472     } else {
 473       /* we are going to reuse all data, realloc then */
 474       GST_CAT_DEBUG (GST_CAT_PERFORMANCE, "reusing %" G_GSIZE_FORMAT " bytes",
 475           toreuse);
 476       adapter->assembled_data =
 477           g_realloc (adapter->assembled_data, adapter->assembled_size);
 478     }
 479   }
 480   GST_CAT_DEBUG (GST_CAT_PERFORMANCE, "copy remaining %" G_GSIZE_FORMAT
 481       " bytes from adapter", tocopy);
 482   data = adapter->assembled_data;
 483   copy_into_unchecked (adapter, data + toreuse, skip + toreuse, tocopy);
 484   adapter->assembled_len = size;
 485
 486   return adapter->assembled_data;
 487 }
 488
 489 /**
 490  * gst_adapter_unmap:
 491  * @adapter: a #GstAdapter
 492  *
 493  * Releases the memory obtained with the last gst_adapter_map().
 494  */
 495 void
 496 gst_adapter_unmap (GstAdapter * adapter)
 497 {
 498   GstAdapterPrivate *priv;
 499
 500   g_return_if_fail (GST_IS_ADAPTER (adapter));
 501
 502   priv = adapter->priv;
 503
 504   if (priv->info.memory) {
 505     GstBuffer *cur = adapter->buflist->data;
 506     gst_buffer_unmap (cur, &priv->info);
 507     priv->info.memory = NULL;
 508   }
 509 }
 510
 511 /**
 512  * gst_adapter_copy:
 513  * @adapter: a #GstAdapter
 514  * @dest: (out caller-allocates) (array length=size): the memory to copy into
 515  * @offset: the bytes offset in the adapter to start from
 516  * @size: the number of bytes to copy
 517  *
 518  * Copies @size bytes of data starting at @offset out of the buffers
 519  * contained in @GstAdapter into an array @dest provided by the caller.
 520  *
 521  * The array @dest should be large enough to contain @size bytes.
 522  * The user should check that the adapter has (@offset + @size) bytes
 523  * available before calling this function.
 524  *
 525  * Since: 0.10.12
 526  */
 527 void
 528 gst_adapter_copy (GstAdapter * adapter, gpointer dest, gsize offset, gsize size)
 529 {
 530   g_return_if_fail (GST_IS_ADAPTER (adapter));
 531   g_return_if_fail (size > 0);
 532   g_return_if_fail (offset + size <= adapter->size);
 533
 534   copy_into_unchecked (adapter, dest, offset + adapter->skip, size);
 535 }
 536
 537 /**
 538  * gst_adapter_flush:
 539  * @adapter: a #GstAdapter
 540  * @flush: the number of bytes to flush
 541  *
 542  * Flushes the first @flush bytes in the @adapter. The caller must ensure that
 543  * at least this many bytes are available.
 544  *
 545  * See also: gst_adapter_map(), gst_adapter_unmap()
 546  */
 547 static void
 548 gst_adapter_flush_unchecked (GstAdapter * adapter, gsize flush)
 549 {
 550   GstBuffer *cur;
 551   gsize size;
 552   GstAdapterPrivate *priv;
 553   GSList *g;
 554
 555   GST_LOG_OBJECT (adapter, "flushing %" G_GSIZE_FORMAT " bytes", flush);
 556
 557   priv = adapter->priv;
 558
 559   if (priv->info.memory)
 560     gst_adapter_unmap (adapter);
 561
 562   /* clear state */
 563   adapter->size -= flush;
 564   adapter->assembled_len = 0;
 565
 566   /* take skip into account */
 567   flush += adapter->skip;
 568   /* distance is always at least the amount of skipped bytes */
 569   priv->pts_distance -= adapter->skip;
 570   priv->dts_distance -= adapter->skip;
 571
 572   g = adapter->buflist;
 573   cur = g->data;
 574   size = gst_buffer_get_size (cur);
 575   while (flush >= size) {
 576     /* can skip whole buffer */
 577     GST_LOG_OBJECT (adapter, "flushing out head buffer");
 578     priv->pts_distance += size;
 579     priv->dts_distance += size;
 580     flush -= size;
 581
 582     gst_buffer_unref (cur);
 583     g = g_slist_delete_link (g, g);
 584
 585     if (G_UNLIKELY (g == NULL)) {
 586       GST_LOG_OBJECT (adapter, "adapter empty now");
 587       adapter->buflist_end = NULL;
 588       break;
 589     }
 590     /* there is a new head buffer, update the timestamps */
 591     cur = g->data;
 592     update_timestamps (adapter, cur);
 593     size = gst_buffer_get_size (cur);
 594   }
 595   adapter->buflist = g;
 596   /* account for the remaining bytes */
 597   adapter->skip = flush;
 598   adapter->priv->pts_distance += flush;
 599   adapter->priv->dts_distance += flush;
 600   /* invalidate scan position */
 601   priv->scan_offset = 0;
 602   priv->scan_entry = NULL;
 603 }
 604
 605 void
 606 gst_adapter_flush (GstAdapter * adapter, gsize flush)
 607 {
 608   g_return_if_fail (GST_IS_ADAPTER (adapter));
 609   g_return_if_fail (flush <= adapter->size);
 610
 611   /* flushing out 0 bytes will do nothing */
 612   if (G_UNLIKELY (flush == 0))
 613     return;
 614
 615   gst_adapter_flush_unchecked (adapter, flush);
 616 }
 617
 618 /* internal function, nbytes should be flushed after calling this function */
 619 static guint8 *
 620 gst_adapter_take_internal (GstAdapter * adapter, gsize nbytes)
 621 {
 622   guint8 *data;
 623   gsize toreuse, tocopy;
 624
 625   /* see how much data we can reuse from the assembled memory and how much
 626    * we need to copy */
 627   toreuse = MIN (nbytes, adapter->assembled_len);
 628   tocopy = nbytes - toreuse;
 629
 630   /* find memory to return */
 631   if (adapter->assembled_size >= nbytes && toreuse > 0) {
 632     /* we reuse already allocated memory but only when we're going to reuse
 633      * something from it because else we are worse than the malloc and copy
 634      * case below */
 635     GST_LOG_OBJECT (adapter, "reusing %" G_GSIZE_FORMAT " bytes of assembled"
 636         " data", toreuse);
 637     /* we have enough free space in the assembled array */
 638     data = adapter->assembled_data;
 639     /* flush after this function should set the assembled_size to 0 */
 640     adapter->assembled_data = g_malloc (adapter->assembled_size);
 641   } else {
 642     GST_LOG_OBJECT (adapter, "allocating %" G_GSIZE_FORMAT " bytes", nbytes);
 643     /* not enough bytes in the assembled array, just allocate new space */
 644     data = g_malloc (nbytes);
 645     /* reuse what we can from the already assembled data */
 646     if (toreuse) {
 647       GST_LOG_OBJECT (adapter, "reusing %" G_GSIZE_FORMAT " bytes", toreuse);
 648       memcpy (data, adapter->assembled_data, toreuse);
 649     }
 650   }
 651   if (tocopy) {
 652     /* copy the remaining data */
 653     copy_into_unchecked (adapter, toreuse + data, toreuse + adapter->skip,
 654         tocopy);
 655   }
 656   return data;
 657 }
 658
 659 /**
 660  * gst_adapter_take:
 661  * @adapter: a #GstAdapter
 662  * @nbytes: the number of bytes to take
 663  *
 664  * Returns a freshly allocated buffer containing the first @nbytes bytes of the
 665  * @adapter. The returned bytes will be flushed from the adapter.
 666  *
 667  * Caller owns returned value. g_free after usage.
 668  *
 669  * Free-function: g_free
 670  *
 671  * Returns: (transfer full) (array length=nbytes): oven-fresh hot data, or
 672  *     #NULL if @nbytes bytes are not available
 673  */
 674 gpointer
 675 gst_adapter_take (GstAdapter * adapter, gsize nbytes)
 676 {
 677   gpointer data;
 678
 679   g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
 680   g_return_val_if_fail (nbytes > 0, NULL);
 681
 682   /* we don't have enough data, return NULL. This is unlikely
 683    * as one usually does an _available() first instead of peeking a
 684    * random size. */
 685   if (G_UNLIKELY (nbytes > adapter->size))
 686     return NULL;
 687
 688   data = gst_adapter_take_internal (adapter, nbytes);
 689
 690   gst_adapter_flush_unchecked (adapter, nbytes);
 691
 692   return data;
 693 }
 694
 695 /**
 696  * gst_adapter_take_buffer:
 697  * @adapter: a #GstAdapter
 698  * @nbytes: the number of bytes to take
 699  *
 700  * Returns a #GstBuffer containing the first @nbytes bytes of the
 701  * @adapter. The returned bytes will be flushed from the adapter.
 702  * This function is potentially more performant than gst_adapter_take()
 703  * since it can reuse the memory in pushed buffers by subbuffering
 704  * or merging.
 705  *
 706  * Caller owns returned value. gst_buffer_unref() after usage.
 707  *
 708  * Free-function: gst_buffer_unref
 709  *
 710  * Returns: (transfer full): a #GstBuffer containing the first @nbytes of
 711  *     the adapter, or #NULL if @nbytes bytes are not available
 712  *
 713  * Since: 0.10.6
 714  */
 715 GstBuffer *
 716 gst_adapter_take_buffer (GstAdapter * adapter, gsize nbytes)
 717 {
 718   GstBuffer *buffer;
 719   GstBuffer *cur;
 720   gsize hsize, skip;
 721   guint8 *data;
 722
 723   g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
 724   g_return_val_if_fail (nbytes > 0, NULL);
 725
 726   GST_LOG_OBJECT (adapter, "taking buffer of %" G_GSIZE_FORMAT " bytes",
 727       nbytes);
 728
 729   /* we don't have enough data, return NULL. This is unlikely
 730    * as one usually does an _available() first instead of grabbing a
 731    * random size. */
 732   if (G_UNLIKELY (nbytes > adapter->size))
 733     return NULL;
 734
 735   cur = adapter->buflist->data;
 736   skip = adapter->skip;
 737   hsize = gst_buffer_get_size (cur);
 738
 739   /* our head buffer has enough data left, return it */
 740   if (skip == 0 && hsize == nbytes) {
 741     GST_LOG_OBJECT (adapter, "providing buffer of %" G_GSIZE_FORMAT " bytes"
 742         " as head buffer", nbytes);
 743     buffer = gst_buffer_ref (cur);
 744     goto done;
 745   } else if (hsize >= nbytes + skip) {
 746     GST_LOG_OBJECT (adapter, "providing buffer of %" G_GSIZE_FORMAT " bytes"
 747         " via region copy", nbytes);
 748     buffer = gst_buffer_copy_region (cur, GST_BUFFER_COPY_ALL, skip, nbytes);
 749     goto done;
 750   }
 751
 752   if (gst_adapter_try_to_merge_up (adapter, nbytes)) {
 753     /* Merged something, let's try again for sub-buffering */
 754     cur = adapter->buflist->data;
 755     if (gst_buffer_get_size (cur) >= nbytes + skip) {
 756       GST_LOG_OBJECT (adapter, "providing buffer of %" G_GSIZE_FORMAT " bytes"
 757           " via sub-buffer", nbytes);
 758       buffer = gst_buffer_copy_region (cur, GST_BUFFER_COPY_ALL, skip, nbytes);
 759       goto done;
 760     }
 761   }
 762
 763   data = gst_adapter_take_internal (adapter, nbytes);
 764
 765   buffer = gst_buffer_new ();
 766   gst_buffer_take_memory (buffer, -1,
 767       gst_memory_new_wrapped (0, data, g_free, nbytes, 0, nbytes));
 768
 769 done:
 770   gst_adapter_flush_unchecked (adapter, nbytes);
 771
 772   return buffer;
 773 }
 774
 775 /**
 776  * gst_adapter_take_list:
 777  * @adapter: a #GstAdapter
 778  * @nbytes: the number of bytes to take
 779  *
 780  * Returns a #GList of buffers containing the first @nbytes bytes of the
 781  * @adapter. The returned bytes will be flushed from the adapter.
 782  * When the caller can deal with individual buffers, this function is more
 783  * performant because no memory should be copied.
 784  *
 785  * Caller owns returned list and contained buffers. gst_buffer_unref() each
 786  * buffer in the list before freeing the list after usage.
 787  *
 788  * Returns: (element-type Gst.Buffer) (transfer full): a #GList of buffers
 789  *     containing the first @nbytes of the adapter, or #NULL if @nbytes bytes
 790  *     are not available
 791  *
 792  * Since: 0.10.31
 793  */
 794 GList *
 795 gst_adapter_take_list (GstAdapter * adapter, gsize nbytes)
 796 {
 797   GQueue queue = G_QUEUE_INIT;
 798   GstBuffer *cur;
 799   gsize hsize, skip;
 800
 801   g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
 802   g_return_val_if_fail (nbytes <= adapter->size, NULL);
 803
 804   GST_LOG_OBJECT (adapter, "taking %" G_GSIZE_FORMAT " bytes", nbytes);
 805
 806   while (nbytes > 0) {
 807     cur = adapter->buflist->data;
 808     skip = adapter->skip;
 809     hsize = MIN (nbytes, gst_buffer_get_size (cur) - skip);
 810
 811     cur = gst_adapter_take_buffer (adapter, hsize);
 812
 813     g_queue_push_tail (&queue, cur);
 814
 815     nbytes -= hsize;
 816   }
 817   return queue.head;
 818 }
 819
 820 /**
 821  * gst_adapter_available:
 822  * @adapter: a #GstAdapter
 823  *
 824  * Gets the maximum amount of bytes available, that is it returns the maximum
 825  * value that can be supplied to gst_adapter_map() without that function
 826  * returning NULL.
 827  *
 828  * Returns: number of bytes available in @adapter
 829  */
 830 gsize
 831 gst_adapter_available (GstAdapter * adapter)
 832 {
 833   g_return_val_if_fail (GST_IS_ADAPTER (adapter), 0);
 834
 835   return adapter->size;
 836 }
 837
 838 /**
 839  * gst_adapter_available_fast:
 840  * @adapter: a #GstAdapter
 841  *
 842  * Gets the maximum number of bytes that are immediately available without
 843  * requiring any expensive operations (like copying the data into a
 844  * temporary buffer).
 845  *
 846  * Returns: number of bytes that are available in @adapter without expensive
 847  * operations
 848  */
 849 gsize
 850 gst_adapter_available_fast (GstAdapter * adapter)
 851 {
 852   GstBuffer *cur;
 853   gsize size;
 854   GSList *g;
 855
 856   g_return_val_if_fail (GST_IS_ADAPTER (adapter), 0);
 857
 858   /* no data */
 859   if (adapter->size == 0)
 860     return 0;
 861
 862   /* some stuff we already assembled */
 863   if (adapter->assembled_len)
 864     return adapter->assembled_len;
 865
 866   /* take the first non-zero buffer */
 867   g = adapter->buflist;
 868   while (TRUE) {
 869     cur = g->data;
 870     size = gst_buffer_get_size (cur);
 871     if (size != 0)
 872       break;
 873     g = g_slist_next (g);
 874   }
 875
 876   /* we can quickly get the (remaining) data of the first buffer */
 877   return size - adapter->skip;
 878 }
 879
 880 /**
 881  * gst_adapter_prev_pts:
 882  * @adapter: a #GstAdapter
 883  * @distance: (out) (allow-none): pointer to location for distance, or NULL
 884  *
 885  * Get the pts that was before the current byte in the adapter. When
 886  * @distance is given, the amount of bytes between the pts and the current
 887  * position is returned.
 888  *
 889  * The pts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
 890  * the adapter is first created or when it is cleared. This also means that before
 891  * the first byte with a pts is removed from the adapter, the pts
 892  * and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.
 893  *
 894  * Returns: The previously seen pts.
 895  */
 896 GstClockTime
 897 gst_adapter_prev_pts (GstAdapter * adapter, guint64 * distance)
 898 {
 899   g_return_val_if_fail (GST_IS_ADAPTER (adapter), GST_CLOCK_TIME_NONE);
 900
 901   if (distance)
 902     *distance = adapter->priv->pts_distance;
 903
 904   return adapter->priv->pts;
 905 }
 906
 907 /**
 908  * gst_adapter_prev_dts:
 909  * @adapter: a #GstAdapter
 910  * @distance: (out) (allow-none): pointer to location for distance, or NULL
 911  *
 912  * Get the dts that was before the current byte in the adapter. When
 913  * @distance is given, the amount of bytes between the dts and the current
 914  * position is returned.
 915  *
 916  * The dts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
 917  * the adapter is first created or when it is cleared. This also means that before
 918  * the first byte with a dts is removed from the adapter, the dts
 919  * and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.
 920  *
 921  * Returns: The previously seen dts.
 922  */
 923 GstClockTime
 924 gst_adapter_prev_dts (GstAdapter * adapter, guint64 * distance)
 925 {
 926   g_return_val_if_fail (GST_IS_ADAPTER (adapter), GST_CLOCK_TIME_NONE);
 927
 928   if (distance)
 929     *distance = adapter->priv->dts_distance;
 930
 931   return adapter->priv->dts;
 932 }
 933
 934 /**
 935  * gst_adapter_masked_scan_uint32_peek:
 936  * @adapter: a #GstAdapter
 937  * @mask: mask to apply to data before matching against @pattern
 938  * @pattern: pattern to match (after mask is applied)
 939  * @offset: offset into the adapter data from which to start scanning, returns
 940  *          the last scanned position.
 941  * @size: number of bytes to scan from offset
 942  * @value: pointer to uint32 to return matching data
 943  *
 944  * Scan for pattern @pattern with applied mask @mask in the adapter data,
 945  * starting from offset @offset.  If a match is found, the value that matched
 946  * is returned through @value, otherwise @value is left untouched.
 947  *
 948  * The bytes in @pattern and @mask are interpreted left-to-right, regardless
 949  * of endianness.  All four bytes of the pattern must be present in the
 950  * adapter for it to match, even if the first or last bytes are masked out.
 951  *
 952  * It is an error to call this function without making sure that there is
 953  * enough data (offset+size bytes) in the adapter.
 954  *
 955  * Returns: offset of the first match, or -1 if no match was found.
 956  *
 957  * Since: 0.10.30
 958  */
 959 gsize
 960 gst_adapter_masked_scan_uint32_peek (GstAdapter * adapter, guint32 mask,
 961     guint32 pattern, gsize offset, gsize size, guint32 * value)
 962 {
 963   GSList *g;
 964   gsize skip, bsize, i;
 965   guint32 state;
 966   GstMapInfo info;
 967   guint8 *bdata;
 968   GstBuffer *buf;
 969
 970   g_return_val_if_fail (size > 0, -1);
 971   g_return_val_if_fail (offset + size <= adapter->size, -1);
 972   g_return_val_if_fail (((~mask) & pattern) == 0, -1);
 973
 974   /* we can't find the pattern with less than 4 bytes */
 975   if (G_UNLIKELY (size < 4))
 976     return -1;
 977
 978   skip = offset + adapter->skip;
 979
 980   /* first step, do skipping and position on the first buffer */
 981   /* optimistically assume scanning continues sequentially */
 982   if (adapter->priv->scan_entry && (adapter->priv->scan_offset <= skip)) {
 983     g = adapter->priv->scan_entry;
 984     skip -= adapter->priv->scan_offset;
 985   } else {
 986     g = adapter->buflist;
 987     adapter->priv->scan_offset = 0;
 988     adapter->priv->scan_entry = NULL;
 989   }
 990   buf = g->data;
 991   bsize = gst_buffer_get_size (buf);
 992   while (G_UNLIKELY (skip >= bsize)) {
 993     skip -= bsize;
 994     g = g_slist_next (g);
 995     adapter->priv->scan_offset += bsize;
 996     adapter->priv->scan_entry = g;
 997     buf = g->data;
 998     bsize = gst_buffer_get_size (buf);
 999   }
1000   /* get the data now */
1001   g_assert (gst_buffer_map (buf, &info, GST_MAP_READ));
1002
1003   bdata = (guint8 *) info.data + skip;
1004   bsize = info.size - skip;
1005   skip = 0;
1006
1007   /* set the state to something that does not match */
1008   state = ~pattern;
1009
1010   /* now find data */
1011   do {
1012     bsize = MIN (bsize, size);
1013     for (i = 0; i < bsize; i++) {
1014       state = ((state << 8) | bdata[i]);
1015       if (G_UNLIKELY ((state & mask) == pattern)) {
1016         /* we have a match but we need to have skipped at
1017          * least 4 bytes to fill the state. */
1018         if (G_LIKELY (skip + i >= 3)) {
1019           if (G_LIKELY (value))
1020             *value = state;
1021           gst_buffer_unmap (buf, &info);
1022           return offset + skip + i - 3;
1023         }
1024       }
1025     }
1026     size -= bsize;
1027     if (size == 0)
1028       break;
1029
1030     /* nothing found yet, go to next buffer */
1031     skip += bsize;
1032     g = g_slist_next (g);
1033     adapter->priv->scan_offset += info.size;
1034     adapter->priv->scan_entry = g;
1035     gst_buffer_unmap (buf, &info);
1036     buf = g->data;
1037
1038     gst_buffer_map (buf, &info, GST_MAP_READ);
1039     bsize = info.size;
1040     bdata = info.data;
1041   } while (TRUE);
1042
1043   gst_buffer_unmap (buf, &info);
1044
1045   /* nothing found */
1046   return -1;
1047 }
1048
1049 /**
1050  * gst_adapter_masked_scan_uint32:
1051  * @adapter: a #GstAdapter
1052  * @mask: mask to apply to data before matching against @pattern
1053  * @pattern: pattern to match (after mask is applied)
1054  * @offset: offset into the adapter data from which to start scanning, returns
1055  *          the last scanned position.
1056  * @size: number of bytes to scan from offset
1057  *
1058  * Scan for pattern @pattern with applied mask @mask in the adapter data,
1059  * starting from offset @offset.
1060  *
1061  * The bytes in @pattern and @mask are interpreted left-to-right, regardless
1062  * of endianness.  All four bytes of the pattern must be present in the
1063  * adapter for it to match, even if the first or last bytes are masked out.
1064  *
1065  * It is an error to call this function without making sure that there is
1066  * enough data (offset+size bytes) in the adapter.
1067  *
1068  * This function calls gst_adapter_masked_scan_uint32_peek() passing NULL
1069  * for value.
1070  *
1071  * Returns: offset of the first match, or -1 if no match was found.
1072  *
1073  * Example:
1074  * <programlisting>
1075  * // Assume the adapter contains 0x00 0x01 0x02 ... 0xfe 0xff
1076  *
1077  * gst_adapter_masked_scan_uint32 (adapter, 0xffffffff, 0x00010203, 0, 256);
1078  * // -> returns 0
1079  * gst_adapter_masked_scan_uint32 (adapter, 0xffffffff, 0x00010203, 1, 255);
1080  * // -> returns -1
1081  * gst_adapter_masked_scan_uint32 (adapter, 0xffffffff, 0x01020304, 1, 255);
1082  * // -> returns 1
1083  * gst_adapter_masked_scan_uint32 (adapter, 0xffff, 0x0001, 0, 256);
1084  * // -> returns -1
1085  * gst_adapter_masked_scan_uint32 (adapter, 0xffff, 0x0203, 0, 256);
1086  * // -> returns 0
1087  * gst_adapter_masked_scan_uint32 (adapter, 0xffff0000, 0x02030000, 0, 256);
1088  * // -> returns 2
1089  * gst_adapter_masked_scan_uint32 (adapter, 0xffff0000, 0x02030000, 0, 4);
1090  * // -> returns -1
1091  * </programlisting>
1092  *
1093  * Since: 0.10.24
1094  */
1095 gsize
1096 gst_adapter_masked_scan_uint32 (GstAdapter * adapter, guint32 mask,
1097     guint32 pattern, gsize offset, gsize size)
1098 {
1099   return gst_adapter_masked_scan_uint32_peek (adapter, mask, pattern, offset,
1100       size, NULL);
1101 }