/**
* SECTION:gstadapter
+ * @title: GstAdapter
* @short_description: adapts incoming data on a sink pad into chunks of N bytes
*
* This class is for elements that receive buffers in an undesired size.
*
* For example, a sink pad's chain function that needs to pass data to a library
* in 512-byte chunks could be implemented like this:
- * |[
+ * |[<!-- language="C" -->
* static GstFlowReturn
* sink_pad_chain (GstPad *pad, GstObject *parent, GstBuffer *buffer)
* {
* }
* ]|
*
- * For another example, a simple element inside GStreamer that uses GstAdapter
+ * For another example, a simple element inside GStreamer that uses #GstAdapter
* is the libvisual element.
*
- * An element using GstAdapter in its sink pad chain function should ensure that
+ * An element using #GstAdapter in its sink pad chain function should ensure that
* when the FLUSH_STOP event is received, that any queued data is cleared using
* gst_adapter_clear(). Data should also be cleared or processed on EOS and
- * when changing state from #GST_STATE_PAUSED to #GST_STATE_READY.
+ * when changing state from %GST_STATE_PAUSED to %GST_STATE_READY.
*
* Also check the GST_BUFFER_FLAG_DISCONT flag on the buffer. Some elements might
* need to clear the adapter after a discontinuity.
* The adapter will keep track of the timestamps of the buffers
* that were pushed. The last seen timestamp before the current position
* can be queried with gst_adapter_prev_pts(). This function can
- * optionally return the amount of bytes between the start of the buffer that
+ * optionally return the number of bytes between the start of the buffer that
* carried the timestamp and the current adapter position. The distance is
* useful when dealing with, for example, raw audio samples because it allows
* you to calculate the timestamp of the current adapter position by using the
- * last seen timestamp and the amount of bytes since.
- *
- * A last thing to note is that while GstAdapter is pretty optimized,
+ * last seen timestamp and the amount of bytes since. Additionally, the
+ * gst_adapter_prev_pts_at_offset() can be used to determine the last
+ * seen timestamp at a particular offset in the adapter.
+ *
+ * The adapter will also keep track of the offset of the buffers
+ * (#GST_BUFFER_OFFSET) that were pushed. The last seen offset before the
+ * current position can be queried with gst_adapter_prev_offset(). This function
+ * can optionally return the number of bytes between the start of the buffer
+ * that carried the offset and the current adapter position.
+ *
+ * Additionally the adapter also keeps track of the PTS, DTS and buffer offset
+ * at the last discontinuity, which can be retrieved with
+ * gst_adapter_pts_at_discont(), gst_adapter_dts_at_discont() and
+ * gst_adapter_offset_at_discont(). The number of bytes that were consumed
+ * since then can be queried with gst_adapter_distance_from_discont().
+ *
+ * A last thing to note is that while #GstAdapter is pretty optimized,
* merging buffers still might be an operation that requires a malloc() and
* memcpy() operation, and these operations are not the fastest. Because of
* this, some functions like gst_adapter_available_fast() are provided to help
* gst_adapter_copy() can be used to copy data into a (statically allocated)
* user provided buffer.
*
- * GstAdapter is not MT safe. All operations on an adapter must be serialized by
+ * #GstAdapter is not MT safe. All operations on an adapter must be serialized by
* the caller. This is not normally a problem, however, as the normal use case
- * of GstAdapter is inside one pad's chain function, in which case access is
+ * of #GstAdapter is inside one pad's chain function, in which case access is
* serialized via the pad's STREAM_LOCK.
*
* Note that gst_adapter_push() takes ownership of the buffer passed. Use
* gst_buffer_ref() before pushing it into the adapter if you still want to
* access the buffer later. The adapter will never modify the data in the
* buffer pushed in it.
- *
- * Last reviewed on 2009-05-13 (0.10.24).
*/
#include <gst/gst_private.h>
#include "gstadapter.h"
#include <string.h>
+#include <gst/base/gstqueuearray.h>
/* default size for the assembled data buffer */
#define DEFAULT_SIZE 4096
GObject object;
/*< private > */
- GSList *buflist;
- GSList *buflist_end;
+ GstQueueArray *bufqueue;
gsize size;
gsize skip;
+ guint count;
/* we keep state of assembled pieces */
gpointer assembled_data;
guint64 pts_distance;
GstClockTime dts;
guint64 dts_distance;
+ guint64 offset;
+ guint64 offset_distance;
gsize scan_offset;
- GSList *scan_entry;
+ /* G_MAXUINT when unset */
+ guint scan_entry_idx;
+
+ GstClockTime pts_at_discont;
+ GstClockTime dts_at_discont;
+ guint64 offset_at_discont;
+
+ guint64 distance_from_discont;
GstMapInfo info;
};
adapter->pts_distance = 0;
adapter->dts = GST_CLOCK_TIME_NONE;
adapter->dts_distance = 0;
+ adapter->offset = GST_BUFFER_OFFSET_NONE;
+ adapter->offset_distance = 0;
+ adapter->pts_at_discont = GST_CLOCK_TIME_NONE;
+ adapter->dts_at_discont = GST_CLOCK_TIME_NONE;
+ adapter->offset_at_discont = GST_BUFFER_OFFSET_NONE;
+ adapter->distance_from_discont = 0;
+ adapter->bufqueue = gst_queue_array_new (10);
}
static void
g_free (adapter->assembled_data);
+ gst_queue_array_free (adapter->bufqueue);
+
GST_CALL_PARENT (G_OBJECT_CLASS, finalize, (object));
}
GstAdapter *
gst_adapter_new (void)
{
- return g_object_newv (GST_TYPE_ADAPTER, 0, NULL);
+ return g_object_new (GST_TYPE_ADAPTER, NULL);
}
/**
void
gst_adapter_clear (GstAdapter * adapter)
{
+ GstMiniObject *obj;
g_return_if_fail (GST_IS_ADAPTER (adapter));
if (adapter->info.memory)
gst_adapter_unmap (adapter);
- g_slist_foreach (adapter->buflist, (GFunc) gst_mini_object_unref, NULL);
- g_slist_free (adapter->buflist);
- adapter->buflist = NULL;
- adapter->buflist_end = NULL;
+ while ((obj = gst_queue_array_pop_head (adapter->bufqueue)))
+ gst_mini_object_unref (obj);
+
+ adapter->count = 0;
adapter->size = 0;
adapter->skip = 0;
adapter->assembled_len = 0;
adapter->pts_distance = 0;
adapter->dts = GST_CLOCK_TIME_NONE;
adapter->dts_distance = 0;
+ adapter->offset = GST_BUFFER_OFFSET_NONE;
+ adapter->offset_distance = 0;
+ adapter->pts_at_discont = GST_CLOCK_TIME_NONE;
+ adapter->dts_at_discont = GST_CLOCK_TIME_NONE;
+ adapter->offset_at_discont = GST_BUFFER_OFFSET_NONE;
+ adapter->distance_from_discont = 0;
adapter->scan_offset = 0;
- adapter->scan_entry = NULL;
+ adapter->scan_entry_idx = G_MAXUINT;
}
static inline void
-update_timestamps (GstAdapter * adapter, GstBuffer * buf)
+update_timestamps_and_offset (GstAdapter * adapter, GstBuffer * buf)
{
GstClockTime pts, dts;
+ guint64 offset;
pts = GST_BUFFER_PTS (buf);
if (GST_CLOCK_TIME_IS_VALID (pts)) {
adapter->dts = dts;
adapter->dts_distance = 0;
}
+ offset = GST_BUFFER_OFFSET (buf);
+ if (offset != GST_BUFFER_OFFSET_NONE) {
+ GST_LOG_OBJECT (adapter, "new offset %" G_GUINT64_FORMAT, offset);
+ adapter->offset = offset;
+ adapter->offset_distance = 0;
+ }
+
+ if (GST_BUFFER_IS_DISCONT (buf)) {
+ /* Take values as-is (might be NONE) */
+ adapter->pts_at_discont = pts;
+ adapter->dts_at_discont = dts;
+ adapter->offset_at_discont = offset;
+ adapter->distance_from_discont = 0;
+ }
}
/* copy data into @dest, skipping @skip bytes from the head buffers */
copy_into_unchecked (GstAdapter * adapter, guint8 * dest, gsize skip,
gsize size)
{
- GSList *g;
GstBuffer *buf;
gsize bsize, csize;
+ guint idx = 0;
/* first step, do skipping */
/* we might well be copying where we were scanning */
- if (adapter->scan_entry && (adapter->scan_offset <= skip)) {
- g = adapter->scan_entry;
+ if (adapter->scan_entry_idx != G_MAXUINT && (adapter->scan_offset <= skip)) {
+ idx = adapter->scan_entry_idx;
skip -= adapter->scan_offset;
} else {
- g = adapter->buflist;
+ idx = 0;
}
- buf = g->data;
+ buf = gst_queue_array_peek_nth (adapter->bufqueue, idx++);
bsize = gst_buffer_get_size (buf);
while (G_UNLIKELY (skip >= bsize)) {
skip -= bsize;
- g = g_slist_next (g);
- buf = g->data;
+ buf = gst_queue_array_peek_nth (adapter->bufqueue, idx++);
bsize = gst_buffer_get_size (buf);
}
/* copy partial buffer */
/* second step, copy remainder */
while (size > 0) {
- g = g_slist_next (g);
- buf = g->data;
+ buf = gst_queue_array_peek_nth (adapter->bufqueue, idx++);
bsize = gst_buffer_get_size (buf);
if (G_LIKELY (bsize > 0)) {
csize = MIN (bsize, size);
adapter->size += size;
/* Note: merging buffers at this point is premature. */
- if (G_UNLIKELY (adapter->buflist == NULL)) {
+ if (gst_queue_array_is_empty (adapter->bufqueue)) {
GST_LOG_OBJECT (adapter, "pushing %p first %" G_GSIZE_FORMAT " bytes",
buf, size);
- adapter->buflist = adapter->buflist_end = g_slist_append (NULL, buf);
- update_timestamps (adapter, buf);
+ gst_queue_array_push_tail (adapter->bufqueue, buf);
+ update_timestamps_and_offset (adapter, buf);
} else {
/* Otherwise append to the end, and advance our end pointer */
GST_LOG_OBJECT (adapter, "pushing %p %" G_GSIZE_FORMAT " bytes at end, "
"size now %" G_GSIZE_FORMAT, buf, size, adapter->size);
- adapter->buflist_end = g_slist_append (adapter->buflist_end, buf);
- adapter->buflist_end = g_slist_next (adapter->buflist_end);
+ gst_queue_array_push_tail (adapter->bufqueue, buf);
}
+ ++adapter->count;
}
#if 0
/* Internal method only. Tries to merge buffers at the head of the queue
* to form a single larger buffer of size 'size'.
*
- * Returns TRUE if it managed to merge anything.
+ * Returns %TRUE if it managed to merge anything.
*/
static gboolean
gst_adapter_try_to_merge_up (GstAdapter * adapter, gsize size)
* as #GstBuffer memory or the potentially more performant
* gst_adapter_take_buffer().
*
- * Returns #NULL if @size bytes are not available.
+ * Returns %NULL if @size bytes are not available.
*
- * Returns: (transfer none) (array length=size) (element-type guint8):
- * a pointer to the first @size bytes of data, or NULL
+ * Returns: (transfer none) (array length=size) (element-type guint8) (nullable):
+ * a pointer to the first @size bytes of data, or %NULL
*/
gconstpointer
gst_adapter_map (GstAdapter * adapter, gsize size)
#if 0
do {
#endif
- cur = adapter->buflist->data;
+ cur = gst_queue_array_peek_head (adapter->bufqueue);
skip = adapter->skip;
csize = gst_buffer_get_size (cur);
g_return_if_fail (GST_IS_ADAPTER (adapter));
if (adapter->info.memory) {
- GstBuffer *cur = adapter->buflist->data;
+ GstBuffer *cur = gst_queue_array_peek_head (adapter->bufqueue);
GST_LOG_OBJECT (adapter, "unmap memory buffer %p", cur);
gst_buffer_unmap (cur, &adapter->info);
adapter->info.memory = NULL;
}
/**
- * gst_adapter_copy:
+ * gst_adapter_copy: (skip)
* @adapter: a #GstAdapter
* @dest: (out caller-allocates) (array length=size) (element-type guint8):
* the memory to copy into
* @size: the number of bytes to copy
*
* Copies @size bytes of data starting at @offset out of the buffers
- * contained in @GstAdapter into an array @dest provided by the caller.
+ * contained in #GstAdapter into an array @dest provided by the caller.
*
* The array @dest should be large enough to contain @size bytes.
* The user should check that the adapter has (@offset + @size) bytes
copy_into_unchecked (adapter, dest, offset + adapter->skip, size);
}
+/**
+ * gst_adapter_copy_bytes: (rename-to gst_adapter_copy)
+ * @adapter: a #GstAdapter
+ * @offset: the bytes offset in the adapter to start from
+ * @size: the number of bytes to copy
+ *
+ * Similar to gst_adapter_copy, but more suitable for language bindings. @size
+ * bytes of data starting at @offset will be copied out of the buffers contained
+ * in @adapter and into a new #GBytes structure which is returned. Depending on
+ * the value of the @size argument an empty #GBytes structure may be returned.
+ *
+ * Returns: (transfer full): A new #GBytes structure containing the copied data.
+ *
+ * Since: 1.4
+ */
+GBytes *
+gst_adapter_copy_bytes (GstAdapter * adapter, gsize offset, gsize size)
+{
+ gpointer data;
+ data = g_malloc (size);
+ gst_adapter_copy (adapter, data, offset, size);
+ return g_bytes_new_take (data, size);
+}
+
/*Flushes the first @flush bytes in the @adapter*/
static void
gst_adapter_flush_unchecked (GstAdapter * adapter, gsize flush)
{
GstBuffer *cur;
gsize size;
- GSList *g;
GST_LOG_OBJECT (adapter, "flushing %" G_GSIZE_FORMAT " bytes", flush);
/* distance is always at least the amount of skipped bytes */
adapter->pts_distance -= adapter->skip;
adapter->dts_distance -= adapter->skip;
+ adapter->offset_distance -= adapter->skip;
+ adapter->distance_from_discont -= adapter->skip;
- g = adapter->buflist;
- cur = g->data;
+ cur = gst_queue_array_peek_head (adapter->bufqueue);
size = gst_buffer_get_size (cur);
while (flush >= size) {
/* can skip whole buffer */
GST_LOG_OBJECT (adapter, "flushing out head buffer");
adapter->pts_distance += size;
adapter->dts_distance += size;
+ adapter->offset_distance += size;
+ adapter->distance_from_discont += size;
flush -= size;
- gst_buffer_unref (cur);
- g = g_slist_delete_link (g, g);
+ --adapter->count;
+
+ cur = NULL;
+ gst_buffer_unref (gst_queue_array_pop_head (adapter->bufqueue));
- if (G_UNLIKELY (g == NULL)) {
+ if (gst_queue_array_is_empty (adapter->bufqueue)) {
GST_LOG_OBJECT (adapter, "adapter empty now");
- adapter->buflist_end = NULL;
break;
}
/* there is a new head buffer, update the timestamps */
- cur = g->data;
- update_timestamps (adapter, cur);
+ cur = gst_queue_array_peek_head (adapter->bufqueue);
+ update_timestamps_and_offset (adapter, cur);
size = gst_buffer_get_size (cur);
}
- adapter->buflist = g;
/* account for the remaining bytes */
adapter->skip = flush;
adapter->pts_distance += flush;
adapter->dts_distance += flush;
+ adapter->offset_distance += flush;
+ adapter->distance_from_discont += flush;
/* invalidate scan position */
adapter->scan_offset = 0;
- adapter->scan_entry = NULL;
+ adapter->scan_entry_idx = G_MAXUINT;
}
/**
gst_adapter_flush_unchecked (adapter, flush);
}
-/* internal function, nbytes should be flushed after calling this function */
+/* internal function, nbytes should be flushed if needed after calling this function */
static guint8 *
-gst_adapter_take_internal (GstAdapter * adapter, gsize nbytes)
+gst_adapter_get_internal (GstAdapter * adapter, gsize nbytes)
{
guint8 *data;
gsize toreuse, tocopy;
*
* Free-function: g_free
*
- * Returns: (transfer full) (array length=nbytes) (element-type guint8):
- * oven-fresh hot data, or #NULL if @nbytes bytes are not available
+ * Returns: (transfer full) (array length=nbytes) (element-type guint8) (nullable):
+ * oven-fresh hot data, or %NULL if @nbytes bytes are not available
*/
gpointer
gst_adapter_take (GstAdapter * adapter, gsize nbytes)
if (G_UNLIKELY (nbytes > adapter->size))
return NULL;
- data = gst_adapter_take_internal (adapter, nbytes);
+ data = gst_adapter_get_internal (adapter, nbytes);
gst_adapter_flush_unchecked (adapter, nbytes);
}
/**
- * gst_adapter_take_buffer:
- * @adapter: a #GstAdapter
+ * gst_adapter_get_buffer_fast:
+ * @adapter: a #GstAdapter
+ * @nbytes: the number of bytes to get
+ *
+ * Returns a #GstBuffer containing the first @nbytes of the @adapter, but
+ * does not flush them from the adapter. See gst_adapter_take_buffer_fast()
+ * for details.
+ *
+ * Caller owns a reference to the returned buffer. gst_buffer_unref() after
+ * usage.
+ *
+ * Free-function: gst_buffer_unref
+ *
+ * Returns: (transfer full) (nullable): a #GstBuffer containing the first
+ * @nbytes of the adapter, or %NULL if @nbytes bytes are not available.
+ * gst_buffer_unref() when no longer needed.
+ *
+ * Since: 1.6
+ */
+GstBuffer *
+gst_adapter_get_buffer_fast (GstAdapter * adapter, gsize nbytes)
+{
+ GstBuffer *buffer = NULL;
+ GstBuffer *cur;
+ gsize skip;
+ gsize left = nbytes;
+ guint idx, len;
+
+ g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
+ g_return_val_if_fail (nbytes > 0, NULL);
+
+ GST_LOG_OBJECT (adapter, "getting buffer of %" G_GSIZE_FORMAT " bytes",
+ nbytes);
+
+ /* we don't have enough data, return NULL. This is unlikely
+ * as one usually does an _available() first instead of grabbing a
+ * random size. */
+ if (G_UNLIKELY (nbytes > adapter->size))
+ return NULL;
+
+ skip = adapter->skip;
+ cur = gst_queue_array_peek_head (adapter->bufqueue);
+
+ if (skip == 0 && gst_buffer_get_size (cur) == nbytes) {
+ GST_LOG_OBJECT (adapter, "providing buffer of %" G_GSIZE_FORMAT " bytes"
+ " as head buffer", nbytes);
+ buffer = gst_buffer_ref (cur);
+ goto done;
+ }
+
+ len = gst_queue_array_get_length (adapter->bufqueue);
+
+ for (idx = 0; idx < len && left > 0; idx++) {
+ gsize size, cur_size;
+
+ cur = gst_queue_array_peek_nth (adapter->bufqueue, idx);
+ cur_size = gst_buffer_get_size (cur);
+ size = MIN (cur_size - skip, left);
+
+ GST_LOG_OBJECT (adapter, "appending %" G_GSIZE_FORMAT " bytes"
+ " via region copy", size);
+ if (buffer)
+ gst_buffer_copy_into (buffer, cur,
+ GST_BUFFER_COPY_MEMORY | GST_BUFFER_COPY_META, skip, size);
+ else
+ buffer = gst_buffer_copy_region (cur, GST_BUFFER_COPY_ALL, skip, size);
+ skip = 0;
+ left -= size;
+ }
+
+done:
+
+ return buffer;
+}
+
+/**
+ * gst_adapter_take_buffer_fast:
+ * @adapter: a #GstAdapter
* @nbytes: the number of bytes to take
*
- * Returns a #GstBuffer containing the first @nbytes bytes of the
- * @adapter. The returned bytes will be flushed from the adapter.
- * This function is potentially more performant than gst_adapter_take()
- * since it can reuse the memory in pushed buffers by subbuffering
- * or merging.
+ * Returns a #GstBuffer containing the first @nbytes of the @adapter.
+ * The returned bytes will be flushed from the adapter. This function
+ * is potentially more performant than gst_adapter_take_buffer() since
+ * it can reuse the memory in pushed buffers by subbuffering or
+ * merging. Unlike gst_adapter_take_buffer(), the returned buffer may
+ * be composed of multiple non-contiguous #GstMemory objects, no
+ * copies are made.
+ *
+ * Note that no assumptions should be made as to whether certain buffer
+ * flags such as the DISCONT flag are set on the returned buffer, or not.
+ * The caller needs to explicitly set or unset flags that should be set or
+ * unset.
+ *
+ * This will also copy over all GstMeta of the input buffers except
+ * for meta with the %GST_META_FLAG_POOLED flag or with the "memory" tag.
*
- * Caller owns returned value. gst_buffer_unref() after usage.
+ * This function can return buffer up to the return value of
+ * gst_adapter_available() without making copies if possible.
+ *
+ * Caller owns a reference to the returned buffer. gst_buffer_unref() after
+ * usage.
*
* Free-function: gst_buffer_unref
*
- * Returns: (transfer full): a #GstBuffer containing the first @nbytes of
- * the adapter, or #NULL if @nbytes bytes are not available
+ * Returns: (transfer full) (nullable): a #GstBuffer containing the first
+ * @nbytes of the adapter, or %NULL if @nbytes bytes are not available.
+ * gst_buffer_unref() when no longer needed.
+ *
+ * Since: 1.2
*/
GstBuffer *
-gst_adapter_take_buffer (GstAdapter * adapter, gsize nbytes)
+gst_adapter_take_buffer_fast (GstAdapter * adapter, gsize nbytes)
+{
+ GstBuffer *buffer;
+
+ g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
+ g_return_val_if_fail (nbytes > 0, NULL);
+
+ buffer = gst_adapter_get_buffer_fast (adapter, nbytes);
+ if (buffer)
+ gst_adapter_flush_unchecked (adapter, nbytes);
+
+ return buffer;
+}
+
+static gboolean
+foreach_metadata (GstBuffer * inbuf, GstMeta ** meta, gpointer user_data)
+{
+ GstBuffer *outbuf = user_data;
+ const GstMetaInfo *info = (*meta)->info;
+ gboolean do_copy = FALSE;
+
+ if (gst_meta_api_type_has_tag (info->api, _gst_meta_tag_memory)) {
+ /* never call the transform_meta with memory specific metadata */
+ GST_DEBUG ("not copying memory specific metadata %s",
+ g_type_name (info->api));
+ do_copy = FALSE;
+ } else {
+ do_copy = TRUE;
+ GST_DEBUG ("copying metadata %s", g_type_name (info->api));
+ }
+
+ if (do_copy && info->transform_func) {
+ GstMetaTransformCopy copy_data = { FALSE, 0, -1 };
+ GST_DEBUG ("copy metadata %s", g_type_name (info->api));
+ /* simply copy then */
+ info->transform_func (outbuf, *meta, inbuf,
+ _gst_meta_transform_copy, ©_data);
+ }
+ return TRUE;
+}
+
+/**
+ * gst_adapter_get_buffer:
+ * @adapter: a #GstAdapter
+ * @nbytes: the number of bytes to get
+ *
+ * Returns a #GstBuffer containing the first @nbytes of the @adapter, but
+ * does not flush them from the adapter. See gst_adapter_take_buffer()
+ * for details.
+ *
+ * Caller owns a reference to the returned buffer. gst_buffer_unref() after
+ * usage.
+ *
+ * Free-function: gst_buffer_unref
+ *
+ * Returns: (transfer full) (nullable): a #GstBuffer containing the first
+ * @nbytes of the adapter, or %NULL if @nbytes bytes are not available.
+ * gst_buffer_unref() when no longer needed.
+ *
+ * Since: 1.6
+ */
+GstBuffer *
+gst_adapter_get_buffer (GstAdapter * adapter, gsize nbytes)
{
GstBuffer *buffer;
GstBuffer *cur;
g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
g_return_val_if_fail (nbytes > 0, NULL);
- GST_LOG_OBJECT (adapter, "taking buffer of %" G_GSIZE_FORMAT " bytes",
+ GST_LOG_OBJECT (adapter, "getting buffer of %" G_GSIZE_FORMAT " bytes",
nbytes);
/* we don't have enough data, return NULL. This is unlikely
if (G_UNLIKELY (nbytes > adapter->size))
return NULL;
- cur = adapter->buflist->data;
+ cur = gst_queue_array_peek_head (adapter->bufqueue);
skip = adapter->skip;
hsize = gst_buffer_get_size (cur);
}
#endif
- data = gst_adapter_take_internal (adapter, nbytes);
+ data = gst_adapter_get_internal (adapter, nbytes);
buffer = gst_buffer_new_wrapped (data, nbytes);
+ {
+ guint idx, len;
+ GstBuffer *cur;
+ gsize read_offset = 0;
+
+ idx = 0;
+ len = gst_queue_array_get_length (adapter->bufqueue);
+
+ while (idx < len && read_offset < nbytes + adapter->skip) {
+ cur = gst_queue_array_peek_nth (adapter->bufqueue, idx);
+
+ gst_buffer_foreach_meta (cur, foreach_metadata, buffer);
+ read_offset += gst_buffer_get_size (cur);
+
+ idx++;
+ }
+ }
+
done:
- gst_adapter_flush_unchecked (adapter, nbytes);
+
+ return buffer;
+}
+
+/**
+ * gst_adapter_take_buffer:
+ * @adapter: a #GstAdapter
+ * @nbytes: the number of bytes to take
+ *
+ * Returns a #GstBuffer containing the first @nbytes bytes of the
+ * @adapter. The returned bytes will be flushed from the adapter.
+ * This function is potentially more performant than
+ * gst_adapter_take() since it can reuse the memory in pushed buffers
+ * by subbuffering or merging. This function will always return a
+ * buffer with a single memory region.
+ *
+ * Note that no assumptions should be made as to whether certain buffer
+ * flags such as the DISCONT flag are set on the returned buffer, or not.
+ * The caller needs to explicitly set or unset flags that should be set or
+ * unset.
+ *
+ * Since 1.6 this will also copy over all GstMeta of the input buffers except
+ * for meta with the %GST_META_FLAG_POOLED flag or with the "memory" tag.
+ *
+ * Caller owns a reference to the returned buffer. gst_buffer_unref() after
+ * usage.
+ *
+ * Free-function: gst_buffer_unref
+ *
+ * Returns: (transfer full) (nullable): a #GstBuffer containing the first
+ * @nbytes of the adapter, or %NULL if @nbytes bytes are not available.
+ * gst_buffer_unref() when no longer needed.
+ */
+GstBuffer *
+gst_adapter_take_buffer (GstAdapter * adapter, gsize nbytes)
+{
+ GstBuffer *buffer;
+
+ g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
+ g_return_val_if_fail (nbytes > 0, NULL);
+
+ buffer = gst_adapter_get_buffer (adapter, nbytes);
+ if (buffer)
+ gst_adapter_flush_unchecked (adapter, nbytes);
return buffer;
}
* Caller owns returned list and contained buffers. gst_buffer_unref() each
* buffer in the list before freeing the list after usage.
*
- * Returns: (element-type Gst.Buffer) (transfer full): a #GList of buffers
- * containing the first @nbytes of the adapter, or #NULL if @nbytes bytes
- * are not available
+ * Returns: (element-type Gst.Buffer) (transfer full) (nullable): a #GList of
+ * buffers containing the first @nbytes of the adapter, or %NULL if @nbytes
+ * bytes are not available
*/
GList *
gst_adapter_take_list (GstAdapter * adapter, gsize nbytes)
{
GQueue queue = G_QUEUE_INIT;
GstBuffer *cur;
- gsize hsize, skip;
+ gsize hsize, skip, cur_size;
g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
g_return_val_if_fail (nbytes <= adapter->size, NULL);
GST_LOG_OBJECT (adapter, "taking %" G_GSIZE_FORMAT " bytes", nbytes);
while (nbytes > 0) {
- cur = adapter->buflist->data;
+ cur = gst_queue_array_peek_head (adapter->bufqueue);
skip = adapter->skip;
- hsize = MIN (nbytes, gst_buffer_get_size (cur) - skip);
+ cur_size = gst_buffer_get_size (cur);
+ hsize = MIN (nbytes, cur_size - skip);
cur = gst_adapter_take_buffer (adapter, hsize);
}
/**
+ * gst_adapter_get_list:
+ * @adapter: a #GstAdapter
+ * @nbytes: the number of bytes to get
+ *
+ * Returns a #GList of buffers containing the first @nbytes bytes of the
+ * @adapter, but does not flush them from the adapter. See
+ * gst_adapter_take_list() for details.
+ *
+ * Caller owns returned list and contained buffers. gst_buffer_unref() each
+ * buffer in the list before freeing the list after usage.
+ *
+ * Returns: (element-type Gst.Buffer) (transfer full) (nullable): a #GList of
+ * buffers containing the first @nbytes of the adapter, or %NULL if @nbytes
+ * bytes are not available
+ *
+ * Since: 1.6
+ */
+GList *
+gst_adapter_get_list (GstAdapter * adapter, gsize nbytes)
+{
+ GQueue queue = G_QUEUE_INIT;
+ GstBuffer *cur, *buffer;
+ gsize hsize, skip, cur_size;
+ guint idx;
+
+ g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
+ g_return_val_if_fail (nbytes <= adapter->size, NULL);
+
+ GST_LOG_OBJECT (adapter, "getting %" G_GSIZE_FORMAT " bytes", nbytes);
+
+ idx = 0;
+ skip = adapter->skip;
+
+ while (nbytes > 0) {
+ cur = gst_queue_array_peek_nth (adapter->bufqueue, idx++);
+ cur_size = gst_buffer_get_size (cur);
+ hsize = MIN (nbytes, cur_size - skip);
+
+ if (skip == 0 && cur_size == hsize) {
+ GST_LOG_OBJECT (adapter,
+ "inserting a buffer of %" G_GSIZE_FORMAT " bytes", hsize);
+ buffer = gst_buffer_ref (cur);
+ } else {
+ GST_LOG_OBJECT (adapter, "inserting a buffer of %" G_GSIZE_FORMAT " bytes"
+ " via region copy", hsize);
+ buffer = gst_buffer_copy_region (cur, GST_BUFFER_COPY_ALL, skip, hsize);
+ }
+
+ g_queue_push_tail (&queue, buffer);
+
+ nbytes -= hsize;
+ skip = 0;
+ }
+
+ return queue.head;
+}
+
+/**
+ * gst_adapter_take_buffer_list:
+ * @adapter: a #GstAdapter
+ * @nbytes: the number of bytes to take
+ *
+ * Returns a #GstBufferList of buffers containing the first @nbytes bytes of
+ * the @adapter. The returned bytes will be flushed from the adapter.
+ * When the caller can deal with individual buffers, this function is more
+ * performant because no memory should be copied.
+ *
+ * Caller owns the returned list. Call gst_buffer_list_unref() to free
+ * the list after usage.
+ *
+ * Returns: (transfer full) (nullable): a #GstBufferList of buffers containing
+ * the first @nbytes of the adapter, or %NULL if @nbytes bytes are not
+ * available
+ *
+ * Since: 1.6
+ */
+GstBufferList *
+gst_adapter_take_buffer_list (GstAdapter * adapter, gsize nbytes)
+{
+ GstBufferList *buffer_list;
+ GstBuffer *cur;
+ gsize hsize, skip, cur_size;
+ guint n_bufs;
+
+ g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
+
+ if (nbytes > adapter->size)
+ return NULL;
+
+ GST_LOG_OBJECT (adapter, "taking %" G_GSIZE_FORMAT " bytes", nbytes);
+
+ /* try to create buffer list with sufficient size, so no resize is done later */
+ if (adapter->count < 64)
+ n_bufs = adapter->count;
+ else
+ n_bufs = (adapter->count * nbytes * 1.2 / adapter->size) + 1;
+
+ buffer_list = gst_buffer_list_new_sized (n_bufs);
+
+ while (nbytes > 0) {
+ cur = gst_queue_array_peek_head (adapter->bufqueue);
+ skip = adapter->skip;
+ cur_size = gst_buffer_get_size (cur);
+ hsize = MIN (nbytes, cur_size - skip);
+
+ gst_buffer_list_add (buffer_list, gst_adapter_take_buffer (adapter, hsize));
+ nbytes -= hsize;
+ }
+ return buffer_list;
+}
+
+/**
+ * gst_adapter_get_buffer_list:
+ * @adapter: a #GstAdapter
+ * @nbytes: the number of bytes to get
+ *
+ * Returns a #GstBufferList of buffers containing the first @nbytes bytes of
+ * the @adapter but does not flush them from the adapter. See
+ * gst_adapter_take_buffer_list() for details.
+ *
+ * Caller owns the returned list. Call gst_buffer_list_unref() to free
+ * the list after usage.
+ *
+ * Returns: (transfer full) (nullable): a #GstBufferList of buffers containing
+ * the first @nbytes of the adapter, or %NULL if @nbytes bytes are not
+ * available
+ *
+ * Since: 1.6
+ */
+GstBufferList *
+gst_adapter_get_buffer_list (GstAdapter * adapter, gsize nbytes)
+{
+ GstBufferList *buffer_list;
+ GstBuffer *cur, *buffer;
+ gsize hsize, skip, cur_size;
+ guint n_bufs;
+ guint idx;
+
+ g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
+
+ if (nbytes > adapter->size)
+ return NULL;
+
+ GST_LOG_OBJECT (adapter, "getting %" G_GSIZE_FORMAT " bytes", nbytes);
+
+ /* try to create buffer list with sufficient size, so no resize is done later */
+ if (adapter->count < 64)
+ n_bufs = adapter->count;
+ else
+ n_bufs = (adapter->count * nbytes * 1.2 / adapter->size) + 1;
+
+ buffer_list = gst_buffer_list_new_sized (n_bufs);
+
+ idx = 0;
+ skip = adapter->skip;
+
+ while (nbytes > 0) {
+ cur = gst_queue_array_peek_nth (adapter->bufqueue, idx++);
+ cur_size = gst_buffer_get_size (cur);
+ hsize = MIN (nbytes, cur_size - skip);
+
+ if (skip == 0 && cur_size == hsize) {
+ GST_LOG_OBJECT (adapter,
+ "inserting a buffer of %" G_GSIZE_FORMAT " bytes", hsize);
+ buffer = gst_buffer_ref (cur);
+ } else {
+ GST_LOG_OBJECT (adapter, "inserting a buffer of %" G_GSIZE_FORMAT " bytes"
+ " via region copy", hsize);
+ buffer = gst_buffer_copy_region (cur, GST_BUFFER_COPY_ALL, skip, hsize);
+ }
+
+ gst_buffer_list_add (buffer_list, buffer);
+
+ nbytes -= hsize;
+ skip = 0;
+ }
+
+ return buffer_list;
+}
+
+/**
* gst_adapter_available:
* @adapter: a #GstAdapter
*
* Gets the maximum amount of bytes available, that is it returns the maximum
* value that can be supplied to gst_adapter_map() without that function
- * returning NULL.
+ * returning %NULL.
*
* Returns: number of bytes available in @adapter
*/
{
GstBuffer *cur;
gsize size;
- GSList *g;
+ guint idx;
g_return_val_if_fail (GST_IS_ADAPTER (adapter), 0);
return adapter->assembled_len;
/* take the first non-zero buffer */
- g = adapter->buflist;
+ idx = 0;
while (TRUE) {
- cur = g->data;
+ cur = gst_queue_array_peek_nth (adapter->bufqueue, idx++);
size = gst_buffer_get_size (cur);
if (size != 0)
break;
- g = g_slist_next (g);
}
/* we can quickly get the (remaining) data of the first buffer */
}
/**
+ * gst_adapter_get_distance_from_discont:
+ * @adapter: a #GstAdapter
+ *
+ * Get the distance in bytes since the last buffer with the
+ * %GST_BUFFER_FLAG_DISCONT flag.
+ *
+ * The distance will be reset to 0 for all buffers with
+ * %GST_BUFFER_FLAG_DISCONT on them, and then calculated for all other
+ * following buffers based on their size.
+ *
+ * Since: 1.10
+ *
+ * Returns: The offset. Can be %GST_BUFFER_OFFSET_NONE.
+ */
+guint64
+gst_adapter_distance_from_discont (GstAdapter * adapter)
+{
+ return adapter->distance_from_discont;
+}
+
+/**
+ * gst_adapter_offset_at_discont:
+ * @adapter: a #GstAdapter
+ *
+ * Get the offset that was on the last buffer with the GST_BUFFER_FLAG_DISCONT
+ * flag, or GST_BUFFER_OFFSET_NONE.
+ *
+ * Since: 1.10
+ *
+ * Returns: The offset at the last discont or GST_BUFFER_OFFSET_NONE.
+ */
+guint64
+gst_adapter_offset_at_discont (GstAdapter * adapter)
+{
+ g_return_val_if_fail (GST_IS_ADAPTER (adapter), GST_BUFFER_OFFSET_NONE);
+
+ return adapter->offset_at_discont;
+}
+
+/**
+ * gst_adapter_pts_at_discont:
+ * @adapter: a #GstAdapter
+ *
+ * Get the PTS that was on the last buffer with the GST_BUFFER_FLAG_DISCONT
+ * flag, or GST_CLOCK_TIME_NONE.
+ *
+ * Since: 1.10
+ *
+ * Returns: The PTS at the last discont or GST_CLOCK_TIME_NONE.
+ */
+GstClockTime
+gst_adapter_pts_at_discont (GstAdapter * adapter)
+{
+ g_return_val_if_fail (GST_IS_ADAPTER (adapter), GST_CLOCK_TIME_NONE);
+
+ return adapter->pts_at_discont;
+}
+
+/**
+ * gst_adapter_dts_at_discont:
+ * @adapter: a #GstAdapter
+ *
+ * Get the DTS that was on the last buffer with the GST_BUFFER_FLAG_DISCONT
+ * flag, or GST_CLOCK_TIME_NONE.
+ *
+ * Since: 1.10
+ *
+ * Returns: The DTS at the last discont or GST_CLOCK_TIME_NONE.
+ */
+GstClockTime
+gst_adapter_dts_at_discont (GstAdapter * adapter)
+{
+ g_return_val_if_fail (GST_IS_ADAPTER (adapter), GST_CLOCK_TIME_NONE);
+
+ return adapter->dts_at_discont;
+}
+
+/**
+ * gst_adapter_prev_offset:
+ * @adapter: a #GstAdapter
+ * @distance: (out) (allow-none): pointer to a location for distance, or %NULL
+ *
+ * Get the offset that was before the current byte in the adapter. When
+ * @distance is given, the amount of bytes between the offset and the current
+ * position is returned.
+ *
+ * The offset is reset to GST_BUFFER_OFFSET_NONE and the distance is set to 0
+ * when the adapter is first created or when it is cleared. This also means that
+ * before the first byte with an offset is removed from the adapter, the offset
+ * and distance returned are GST_BUFFER_OFFSET_NONE and 0 respectively.
+ *
+ * Since: 1.10
+ *
+ * Returns: The previous seen offset.
+ */
+guint64
+gst_adapter_prev_offset (GstAdapter * adapter, guint64 * distance)
+{
+ g_return_val_if_fail (GST_IS_ADAPTER (adapter), GST_BUFFER_OFFSET_NONE);
+
+ if (distance)
+ *distance = adapter->offset_distance;
+
+ return adapter->offset;
+}
+
+/**
* gst_adapter_prev_pts:
* @adapter: a #GstAdapter
- * @distance: (out) (allow-none): pointer to location for distance, or NULL
+ * @distance: (out) (allow-none): pointer to location for distance, or %NULL
*
* Get the pts that was before the current byte in the adapter. When
* @distance is given, the amount of bytes between the pts and the current
/**
* gst_adapter_prev_dts:
* @adapter: a #GstAdapter
- * @distance: (out) (allow-none): pointer to location for distance, or NULL
+ * @distance: (out) (allow-none): pointer to location for distance, or %NULL
*
* Get the dts that was before the current byte in the adapter. When
* @distance is given, the amount of bytes between the dts and the current
}
/**
+ * gst_adapter_prev_pts_at_offset:
+ * @adapter: a #GstAdapter
+ * @offset: the offset in the adapter at which to get timestamp
+ * @distance: (out) (allow-none): pointer to location for distance, or %NULL
+ *
+ * Get the pts that was before the byte at offset @offset in the adapter. When
+ * @distance is given, the amount of bytes between the pts and the current
+ * position is returned.
+ *
+ * The pts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
+ * the adapter is first created or when it is cleared. This also means that before
+ * the first byte with a pts is removed from the adapter, the pts
+ * and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.
+ *
+ * Since: 1.2
+ * Returns: The previously seen pts at given offset.
+ */
+GstClockTime
+gst_adapter_prev_pts_at_offset (GstAdapter * adapter, gsize offset,
+ guint64 * distance)
+{
+ GstBuffer *cur;
+ gsize read_offset = 0;
+ gsize pts_offset = 0;
+ GstClockTime pts = adapter->pts;
+ guint idx, len;
+
+ g_return_val_if_fail (GST_IS_ADAPTER (adapter), GST_CLOCK_TIME_NONE);
+
+ idx = 0;
+ len = gst_queue_array_get_length (adapter->bufqueue);
+
+ while (idx < len && read_offset < offset + adapter->skip) {
+ cur = gst_queue_array_peek_nth (adapter->bufqueue, idx++);
+
+ if (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_PTS (cur))) {
+ pts = GST_BUFFER_PTS (cur);
+ pts_offset = read_offset;
+ }
+
+ read_offset += gst_buffer_get_size (cur);
+ }
+
+ if (distance)
+ *distance = adapter->pts_distance + offset - pts_offset;
+
+ return pts;
+}
+
+/**
+ * gst_adapter_prev_dts_at_offset:
+ * @adapter: a #GstAdapter
+ * @offset: the offset in the adapter at which to get timestamp
+ * @distance: (out) (allow-none): pointer to location for distance, or %NULL
+ *
+ * Get the dts that was before the byte at offset @offset in the adapter. When
+ * @distance is given, the amount of bytes between the dts and the current
+ * position is returned.
+ *
+ * The dts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
+ * the adapter is first created or when it is cleared. This also means that before
+ * the first byte with a dts is removed from the adapter, the dts
+ * and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.
+ *
+ * Since: 1.2
+ * Returns: The previously seen dts at given offset.
+ */
+GstClockTime
+gst_adapter_prev_dts_at_offset (GstAdapter * adapter, gsize offset,
+ guint64 * distance)
+{
+ GstBuffer *cur;
+ gsize read_offset = 0;
+ gsize dts_offset = 0;
+ GstClockTime dts = adapter->dts;
+ guint idx, len;
+
+ g_return_val_if_fail (GST_IS_ADAPTER (adapter), GST_CLOCK_TIME_NONE);
+
+ idx = 0;
+ len = gst_queue_array_get_length (adapter->bufqueue);
+
+ while (idx < len && read_offset < offset + adapter->skip) {
+ cur = gst_queue_array_peek_nth (adapter->bufqueue, idx++);
+
+ if (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DTS (cur))) {
+ dts = GST_BUFFER_DTS (cur);
+ dts_offset = read_offset;
+ }
+
+ read_offset += gst_buffer_get_size (cur);
+ }
+
+ if (distance)
+ *distance = adapter->dts_distance + offset - dts_offset;
+
+ return dts;
+}
+
+/**
* gst_adapter_masked_scan_uint32_peek:
* @adapter: a #GstAdapter
* @mask: mask to apply to data before matching against @pattern
* @offset: offset into the adapter data from which to start scanning, returns
* the last scanned position.
* @size: number of bytes to scan from offset
- * @value: pointer to uint32 to return matching data
+ * @value: (out) (allow-none): pointer to uint32 to return matching data
*
* Scan for pattern @pattern with applied mask @mask in the adapter data,
* starting from offset @offset. If a match is found, the value that matched
gst_adapter_masked_scan_uint32_peek (GstAdapter * adapter, guint32 mask,
guint32 pattern, gsize offset, gsize size, guint32 * value)
{
- GSList *g;
gsize skip, bsize, i;
guint32 state;
GstMapInfo info;
guint8 *bdata;
GstBuffer *buf;
+ guint idx;
g_return_val_if_fail (size > 0, -1);
g_return_val_if_fail (offset + size <= adapter->size, -1);
/* first step, do skipping and position on the first buffer */
/* optimistically assume scanning continues sequentially */
- if (adapter->scan_entry && (adapter->scan_offset <= skip)) {
- g = adapter->scan_entry;
+ if (adapter->scan_entry_idx != G_MAXUINT && (adapter->scan_offset <= skip)) {
+ idx = adapter->scan_entry_idx;
skip -= adapter->scan_offset;
} else {
- g = adapter->buflist;
+ idx = 0;
adapter->scan_offset = 0;
- adapter->scan_entry = NULL;
+ adapter->scan_entry_idx = G_MAXUINT;
}
- buf = g->data;
+ buf = gst_queue_array_peek_nth (adapter->bufqueue, idx++);
bsize = gst_buffer_get_size (buf);
while (G_UNLIKELY (skip >= bsize)) {
skip -= bsize;
- g = g_slist_next (g);
adapter->scan_offset += bsize;
- adapter->scan_entry = g;
- buf = g->data;
+ adapter->scan_entry_idx = idx;
+ buf = gst_queue_array_peek_nth (adapter->bufqueue, idx++);
bsize = gst_buffer_get_size (buf);
}
/* get the data now */
/* nothing found yet, go to next buffer */
skip += bsize;
- g = g_slist_next (g);
adapter->scan_offset += info.size;
- adapter->scan_entry = g;
+ adapter->scan_entry_idx = idx;
gst_buffer_unmap (buf, &info);
- buf = g->data;
+ buf = gst_queue_array_peek_nth (adapter->bufqueue, idx++);
if (!gst_buffer_map (buf, &info, GST_MAP_READ))
return -1;
* It is an error to call this function without making sure that there is
* enough data (offset+size bytes) in the adapter.
*
- * This function calls gst_adapter_masked_scan_uint32_peek() passing NULL
+ * This function calls gst_adapter_masked_scan_uint32_peek() passing %NULL
* for value.
*
* Returns: offset of the first match, or -1 if no match was found.
*
* Example:
- * <programlisting>
+ * |[
* // Assume the adapter contains 0x00 0x01 0x02 ... 0xfe 0xff
*
* gst_adapter_masked_scan_uint32 (adapter, 0xffffffff, 0x00010203, 0, 256);
* // -> returns 2
* gst_adapter_masked_scan_uint32 (adapter, 0xffff0000, 0x02030000, 0, 4);
* // -> returns -1
- * </programlisting>
+ * ]|
*/
gssize
gst_adapter_masked_scan_uint32 (GstAdapter * adapter, guint32 mask,