*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
*/
/**
* created one will typically allocate memory for it and add it to the buffer.
* The following example creates a buffer that can hold a given video frame
* with a given width, height and bits per plane.
- * <example>
- * <title>Creating a buffer for a video frame</title>
- * <programlisting>
+ * |[
* GstBuffer *buffer;
* GstMemory *memory;
* gint size, width, height, bpp;
* memory = gst_allocator_alloc (NULL, size, NULL);
* gst_buffer_insert_memory (buffer, -1, memory);
* ...
- * </programlisting>
- * </example>
+ * ]|
*
- * Alternatively, use gst_buffer_new_allocate()
- * to create a buffer with preallocated data of a given size.
+ * Alternatively, use gst_buffer_new_allocate() to create a buffer with
+ * preallocated data of a given size.
*
* Buffers can contain a list of #GstMemory objects. You can retrieve how many
* memory objects with gst_buffer_n_memory() and you can get a pointer
* produced so far. For compressed data, it could be the byte offset in a
* source or destination file. Likewise, the end offset will be the offset of
* the end of the buffer. These can only be meaningfully interpreted if you
- * know the media type of the buffer (the preceeding CAPS event). Either or both
+ * know the media type of the buffer (the preceding CAPS event). Either or both
* can be set to #GST_BUFFER_OFFSET_NONE.
*
* gst_buffer_ref() is used to increase the refcount of a buffer. This must be
*
* Several flags of the buffer can be set and unset with the
* GST_BUFFER_FLAG_SET() and GST_BUFFER_FLAG_UNSET() macros. Use
- * GST_BUFFER_FLAG_IS_SET() to test if a certain #GstBufferFlag is set.
+ * GST_BUFFER_FLAG_IS_SET() to test if a certain #GstBufferFlags flag is set.
*
* Buffers can be efficiently merged into a larger buffer with
* gst_buffer_append(). Copying of memory will only be done when absolutely
* the refcount drops to 0, any memory and metadata pointed to by the buffer is
* unreffed as well. Buffers allocated from a #GstBufferPool will be returned to
* the pool when the refcount drops to 0.
- *
- * Last reviewed on 2012-03-28 (0.11.3)
*/
#include "gst_private.h"
#include "gstbufferpool.h"
#include "gstinfo.h"
#include "gstutils.h"
-#include "gstminiobject.h"
#include "gstversion.h"
GType _gst_buffer_type = 0;
#define GST_BUFFER_MEM_MAX 16
+#define GST_BUFFER_SLICE_SIZE(b) (((GstBufferImpl *)(b))->slice_size)
#define GST_BUFFER_MEM_LEN(b) (((GstBufferImpl *)(b))->len)
#define GST_BUFFER_MEM_ARRAY(b) (((GstBufferImpl *)(b))->mem)
#define GST_BUFFER_MEM_PTR(b,i) (((GstBufferImpl *)(b))->mem[i])
{
GstBuffer buffer;
+ gsize slice_size;
+
/* the memory blocks */
guint len;
GstMemory *mem[GST_BUFFER_MEM_MAX];
static GstMemory *
_get_merged_memory (GstBuffer * buffer, guint idx, guint length)
{
- GstMemory **mem, *result;
+ GstMemory **mem, *result = NULL;
+
+ GST_CAT_LOG (GST_CAT_BUFFER, "buffer %p, idx %u, length %u", buffer, idx,
+ length);
mem = GST_BUFFER_MEM_ARRAY (buffer);
GstMemory *parent = NULL;
gsize size, poffset = 0;
- size = gst_buffer_get_size (buffer);
+ size = gst_buffer_get_sizes_range (buffer, idx, length, NULL, NULL);
if (G_UNLIKELY (_is_span (mem + idx, length, &poffset, &parent))) {
-
- if (parent->flags & GST_MEMORY_FLAG_NO_SHARE) {
+ if (!GST_MEMORY_IS_NO_SHARE (parent))
+ result = gst_memory_share (parent, poffset, size);
+ if (!result) {
GST_CAT_DEBUG (GST_CAT_PERFORMANCE, "copy for merge %p", parent);
result = gst_memory_copy (parent, poffset, size);
- } else {
- result = gst_memory_share (parent, poffset, size);
}
} else {
gsize i, tocopy, left;
ptr = dinfo.data;
left = size;
- for (i = idx; i < length && left > 0; i++) {
+ for (i = idx; i < (idx + length) && left > 0; i++) {
gst_memory_map (mem[i], &sinfo, GST_MAP_READ);
tocopy = MIN (sinfo.size, left);
GST_CAT_DEBUG (GST_CAT_PERFORMANCE,
- "memcpy for merge %p from memory %p", result, mem[i]);
+ "memcpy %" G_GSIZE_FORMAT " bytes for merge %p from memory %p",
+ tocopy, result, mem[i]);
memcpy (ptr, (guint8 *) sinfo.data, tocopy);
left -= tocopy;
ptr += tocopy;
gsize end, i;
end = idx + length;
- GST_LOG ("buffer %p replace %u-%" G_GSIZE_FORMAT " with memory %p", buffer,
- idx, end, mem);
+
+ GST_CAT_LOG (GST_CAT_BUFFER,
+ "buffer %p replace %u-%" G_GSIZE_FORMAT " with memory %p", buffer, idx,
+ end, mem);
/* unref old memory */
- for (i = idx; i < end; i++)
- gst_memory_unref (GST_BUFFER_MEM_PTR (buffer, i));
+ for (i = idx; i < end; i++) {
+ GstMemory *old = GST_BUFFER_MEM_PTR (buffer, i);
+
+ gst_memory_unlock (old, GST_LOCK_FLAG_EXCLUSIVE);
+ gst_memory_unref (old);
+ }
if (mem != NULL) {
/* replace with single memory */
+ gst_memory_lock (mem, GST_LOCK_FLAG_EXCLUSIVE);
GST_BUFFER_MEM_PTR (buffer, idx) = mem;
idx++;
length--;
}
if (end < len) {
- g_memmove (&GST_BUFFER_MEM_PTR (buffer, idx),
+ memmove (&GST_BUFFER_MEM_PTR (buffer, idx),
&GST_BUFFER_MEM_PTR (buffer, end), (len - end) * sizeof (gpointer));
}
GST_BUFFER_MEM_LEN (buffer) = len - length;
+ GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY);
}
static inline void
-_memory_add (GstBuffer * buffer, guint idx, GstMemory * mem)
+_memory_add (GstBuffer * buffer, gint idx, GstMemory * mem, gboolean lock)
{
guint i, len = GST_BUFFER_MEM_LEN (buffer);
+ GST_CAT_LOG (GST_CAT_BUFFER, "buffer %p, idx %d, mem %p, lock %d", buffer,
+ idx, mem, lock);
+
if (G_UNLIKELY (len >= GST_BUFFER_MEM_MAX)) {
/* too many buffer, span them. */
/* FIXME, there is room for improvement here: We could only try to merge
GST_BUFFER_MEM_PTR (buffer, i) = GST_BUFFER_MEM_PTR (buffer, i - 1);
}
/* and insert the new buffer */
+ if (lock)
+ gst_memory_lock (mem, GST_LOCK_FLAG_EXCLUSIVE);
GST_BUFFER_MEM_PTR (buffer, idx) = mem;
GST_BUFFER_MEM_LEN (buffer) = len + 1;
+
+ GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY);
}
GST_DEFINE_MINI_OBJECT_TYPE (GstBuffer, gst_buffer);
}
/**
+ * gst_buffer_get_max_memory:
+ *
+ * Get the maximum amount of memory blocks that a buffer can hold. This is a
+ * compile time constant that can be queried with the function.
+ *
+ * When more memory blocks are added, existing memory blocks will be merged
+ * together to make room for the new block.
+ *
+ * Returns: the maximum amount of memory blocks that a buffer can hold.
+ *
+ * Since: 1.2
+ */
+guint
+gst_buffer_get_max_memory (void)
+{
+ return GST_BUFFER_MEM_MAX;
+}
+
+/**
* gst_buffer_copy_into:
* @dest: a destination #GstBuffer
* @src: a source #GstBuffer
* the memory from @src will be appended to @dest.
*
* @flags indicate which fields will be copied.
+ *
+ * Returns: %TRUE if the copying succeeded, %FALSE otherwise.
*/
-void
+gboolean
gst_buffer_copy_into (GstBuffer * dest, GstBuffer * src,
GstBufferCopyFlags flags, gsize offset, gsize size)
{
gsize bufsize;
gboolean region = FALSE;
- g_return_if_fail (dest != NULL);
- g_return_if_fail (src != NULL);
+ g_return_val_if_fail (dest != NULL, FALSE);
+ g_return_val_if_fail (src != NULL, FALSE);
/* nothing to copy if the buffers are the same */
if (G_UNLIKELY (dest == src))
- return;
+ return TRUE;
- g_return_if_fail (gst_buffer_is_writable (dest));
+ g_return_val_if_fail (gst_buffer_is_writable (dest), FALSE);
bufsize = gst_buffer_get_size (src);
- g_return_if_fail (bufsize >= offset);
+ g_return_val_if_fail (bufsize >= offset, FALSE);
if (offset > 0)
region = TRUE;
if (size == -1)
size = bufsize - offset;
if (size < bufsize)
region = TRUE;
- g_return_if_fail (bufsize >= offset + size);
+ g_return_val_if_fail (bufsize >= offset + size, FALSE);
GST_CAT_LOG (GST_CAT_BUFFER, "copy %p to %p, offset %" G_GSIZE_FORMAT
"-%" G_GSIZE_FORMAT "/%" G_GSIZE_FORMAT, src, dest, offset, size,
}
if (flags & GST_BUFFER_COPY_MEMORY) {
- GstMemory *mem;
- gsize skip, left, len, i, bsize;
+ gsize skip, left, len, dest_len, i, bsize;
+ gboolean deep;
+
+ deep = flags & GST_BUFFER_COPY_DEEP;
len = GST_BUFFER_MEM_LEN (src);
+ dest_len = GST_BUFFER_MEM_LEN (dest);
left = size;
skip = offset;
/* copy and make regions of the memory */
for (i = 0; i < len && left > 0; i++) {
- mem = GST_BUFFER_MEM_PTR (src, i);
+ GstMemory *mem = GST_BUFFER_MEM_PTR (src, i);
+
bsize = gst_memory_get_sizes (mem, NULL, NULL);
if (bsize <= skip) {
/* don't copy buffer */
skip -= bsize;
} else {
+ GstMemory *newmem = NULL;
gsize tocopy;
tocopy = MIN (bsize - skip, left);
- if (mem->flags & GST_MEMORY_FLAG_NO_SHARE) {
- /* no share, always copy then */
- mem = gst_memory_copy (mem, skip, tocopy);
- skip = 0;
- } else if (tocopy < bsize) {
+
+ if (tocopy < bsize && !deep && !GST_MEMORY_IS_NO_SHARE (mem)) {
/* we need to clip something */
- mem = gst_memory_share (mem, skip, tocopy);
+ newmem = gst_memory_share (mem, skip, tocopy);
+ if (newmem)
+ skip = 0;
+ }
+
+ if (deep || GST_MEMORY_IS_NO_SHARE (mem) || (!newmem && tocopy < bsize)) {
+ /* deep copy or we're not allowed to share this memory
+ * between buffers, always copy then */
+ newmem = gst_memory_copy (mem, skip, tocopy);
skip = 0;
- } else {
- mem = gst_memory_ref (mem);
+ } else if (!newmem) {
+ newmem = gst_memory_ref (mem);
}
- _memory_add (dest, -1, mem);
+
+ if (!newmem) {
+ gst_buffer_remove_memory_range (dest, dest_len, -1);
+ return FALSE;
+ }
+
+ _memory_add (dest, -1, newmem, TRUE);
left -= tocopy;
}
}
if (flags & GST_BUFFER_COPY_MERGE) {
+ GstMemory *mem;
+
len = GST_BUFFER_MEM_LEN (dest);
- _replace_memory (dest, len, 0, len, _get_merged_memory (dest, 0, len));
+ mem = _get_merged_memory (dest, 0, len);
+ if (!mem) {
+ gst_buffer_remove_memory_range (dest, dest_len, -1);
+ return FALSE;
+ }
+ _replace_memory (dest, len, 0, len, mem);
}
}
}
}
}
+
+ return TRUE;
}
static GstBuffer *
copy = gst_buffer_new ();
/* we simply copy everything from our parent */
- gst_buffer_copy_into (copy, buffer, GST_BUFFER_COPY_ALL, 0, -1);
+ if (!gst_buffer_copy_into (copy, buffer, GST_BUFFER_COPY_ALL, 0, -1))
+ gst_buffer_replace (©, NULL);
+
+ if (copy)
+ GST_BUFFER_FLAG_UNSET (copy, GST_BUFFER_FLAG_TAG_MEMORY);
return copy;
}
/* get the size, when unreffing the memory, we could also unref the buffer
* itself */
- msize = GST_MINI_OBJECT_SIZE (buffer);
+ msize = GST_BUFFER_SLICE_SIZE (buffer);
/* free our memory */
len = GST_BUFFER_MEM_LEN (buffer);
- for (i = 0; i < len; i++)
+ for (i = 0; i < len; i++) {
+ gst_memory_unlock (GST_BUFFER_MEM_PTR (buffer, i), GST_LOCK_FLAG_EXCLUSIVE);
gst_memory_unref (GST_BUFFER_MEM_PTR (buffer, i));
+ }
/* we set msize to 0 when the buffer is part of the memory block */
- if (msize)
+ if (msize) {
+#ifdef USE_POISONING
+ memset (buffer, 0xff, msize);
+#endif
g_slice_free1 (msize, buffer);
- else
+ } else {
gst_memory_unref (GST_BUFFER_BUFMEM (buffer));
+ }
}
static void
gst_buffer_init (GstBufferImpl * buffer, gsize size)
{
- gst_mini_object_init (GST_MINI_OBJECT_CAST (buffer), _gst_buffer_type, size);
+ gst_mini_object_init (GST_MINI_OBJECT_CAST (buffer), 0, _gst_buffer_type,
+ (GstMiniObjectCopyFunction) _gst_buffer_copy,
+ (GstMiniObjectDisposeFunction) _gst_buffer_dispose,
+ (GstMiniObjectFreeFunction) _gst_buffer_free);
- buffer->buffer.mini_object.copy =
- (GstMiniObjectCopyFunction) _gst_buffer_copy;
- buffer->buffer.mini_object.dispose =
- (GstMiniObjectDisposeFunction) _gst_buffer_dispose;
- buffer->buffer.mini_object.free =
- (GstMiniObjectFreeFunction) _gst_buffer_free;
+ GST_BUFFER_SLICE_SIZE (buffer) = size;
GST_BUFFER (buffer)->pool = NULL;
GST_BUFFER_PTS (buffer) = GST_CLOCK_TIME_NONE;
/**
* gst_buffer_new_allocate:
- * @allocator: (transfer none) (allow-none): the #GstAllocator to use, or NULL to use the
+ * @allocator: (transfer none) (allow-none): the #GstAllocator to use, or %NULL to use the
* default allocator
* @size: the size in bytes of the new buffer's data.
* @params: (transfer none) (allow-none): optional parameters
*
* Tries to create a newly allocated buffer with data of the given size and
* extra parameters from @allocator. If the requested amount of memory can't be
- * allocated, NULL will be returned. The allocated buffer memory is not cleared.
+ * allocated, %NULL will be returned. The allocated buffer memory is not cleared.
*
- * When @allocator is NULL, the default memory allocator will be used.
+ * When @allocator is %NULL, the default memory allocator will be used.
*
* Note that when @size == 0, the buffer will not have memory associated with it.
*
* MT safe.
*
- * Returns: (transfer full): a new #GstBuffer, or NULL if the memory couldn't
+ * Returns: (transfer full): a new #GstBuffer, or %NULL if the memory couldn't
* be allocated.
*/
GstBuffer *
newbuf = gst_buffer_new ();
if (mem != NULL)
- _memory_add (newbuf, -1, mem);
+ _memory_add (newbuf, -1, mem, TRUE);
GST_CAT_LOG (GST_CAT_BUFFER,
"new buffer %p of size %" G_GSIZE_FORMAT " from allocator %p", newbuf,
if (size > 0) {
mem = gst_memory_new_wrapped (0, data + sizeof (GstBufferImpl), NULL,
size, 0, size);
- _memory_add (newbuf, -1, mem);
+ _memory_add (newbuf, -1, mem, TRUE);
}
#endif
GST_BUFFER_BUFMEM (newbuf) = mem;
if (size > 0)
- _memory_add (newbuf, -1, gst_memory_ref (mem));
+ _memory_add (newbuf, -1, gst_memory_ref (mem), TRUE);
#endif
+ GST_BUFFER_FLAG_UNSET (newbuf, GST_BUFFER_FLAG_TAG_MEMORY);
return newbuf;
/**
* gst_buffer_new_wrapped_full:
* @flags: #GstMemoryFlags
- * @data: data to wrap
+ * @data: (array length=size) (element-type guint8) (transfer none): data to wrap
* @maxsize: allocated size of @data
* @offset: offset in @data
* @size: size of valid data
- * @user_data: user_data
- * @notify: called with @user_data when the memory is freed
+ * @user_data: (allow-none): user_data
+ * @notify: (allow-none) (scope async) (closure user_data): called with @user_data when the memory is freed
*
* Allocate a new buffer that wraps the given memory. @data must point to
* @maxsize of memory, the wrapped buffer will have the region from @offset and
gsize maxsize, gsize offset, gsize size, gpointer user_data,
GDestroyNotify notify)
{
+ GstMemory *mem;
GstBuffer *newbuf;
newbuf = gst_buffer_new ();
- gst_buffer_append_memory (newbuf,
- gst_memory_new_wrapped (flags, data, maxsize, offset, size,
- user_data, notify));
+ mem =
+ gst_memory_new_wrapped (flags, data, maxsize, offset, size, user_data,
+ notify);
+ _memory_add (newbuf, -1, mem, TRUE);
+ GST_BUFFER_FLAG_UNSET (newbuf, GST_BUFFER_FLAG_TAG_MEMORY);
return newbuf;
}
/**
* gst_buffer_new_wrapped:
- * @data: data to wrap
+ * @data: (array length=size) (element-type guint8) (transfer full): data to wrap
* @size: allocated size of @data
*
* Creates a new buffer that wraps the given @data. The memory will be freed
* gst_buffer_n_memory:
* @buffer: a #GstBuffer.
*
- * Get the amount of memory blocks that this buffer has.
+ * Get the amount of memory blocks that this buffer has. This amount is never
+ * larger than what gst_buffer_get_max_memory() returns.
*
* Returns: (transfer full): the amount of memory block in this buffer.
*/
}
/**
+ * gst_buffer_prepend_memory:
+ * @buffer: a #GstBuffer.
+ * @mem: (transfer full): a #GstMemory.
+ *
+ * Prepend the memory block @mem to @buffer. This function takes
+ * ownership of @mem and thus doesn't increase its refcount.
+ *
+ * This function is identical to gst_buffer_insert_memory() with an index of 0.
+ * See gst_buffer_insert_memory() for more details.
+ */
+void
+gst_buffer_prepend_memory (GstBuffer * buffer, GstMemory * mem)
+{
+ gst_buffer_insert_memory (buffer, 0, mem);
+}
+
+/**
+ * gst_buffer_append_memory:
+ * @buffer: a #GstBuffer.
+ * @mem: (transfer full): a #GstMemory.
+ *
+ * Append the memory block @mem to @buffer. This function takes
+ * ownership of @mem and thus doesn't increase its refcount.
+ *
+ * This function is identical to gst_buffer_insert_memory() with an index of -1.
+ * See gst_buffer_insert_memory() for more details.
+ */
+void
+gst_buffer_append_memory (GstBuffer * buffer, GstMemory * mem)
+{
+ gst_buffer_insert_memory (buffer, -1, mem);
+}
+
+/**
* gst_buffer_insert_memory:
* @buffer: a #GstBuffer.
* @idx: the index to add the memory at, or -1 to append it to the end
*
* Insert the memory block @mem to @buffer at @idx. This function takes ownership
* of @mem and thus doesn't increase its refcount.
+ *
+ * Only gst_buffer_get_max_memory() can be added to a buffer. If more memory is
+ * added, existing memory blocks will automatically be merged to make room for
+ * the new memory.
*/
void
gst_buffer_insert_memory (GstBuffer * buffer, gint idx, GstMemory * mem)
g_return_if_fail (idx == -1 ||
(idx >= 0 && idx <= GST_BUFFER_MEM_LEN (buffer)));
- _memory_add (buffer, idx, mem);
+ _memory_add (buffer, idx, mem, TRUE);
}
static GstMemory *
{
GstMemory *mem, *mapped;
- mem = GST_BUFFER_MEM_PTR (buffer, idx);
+ mem = gst_memory_ref (GST_BUFFER_MEM_PTR (buffer, idx));
mapped = gst_memory_make_mapped (mem, info, flags);
- if (!mapped)
- return NULL;
if (mapped != mem) {
+ /* memory changed, lock new memory */
+ gst_memory_lock (mapped, GST_LOCK_FLAG_EXCLUSIVE);
GST_BUFFER_MEM_PTR (buffer, idx) = mapped;
- gst_memory_unref (mem);
- mem = mapped;
+ /* unlock old memory */
+ gst_memory_unlock (mem, GST_LOCK_FLAG_EXCLUSIVE);
+ GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY);
}
- return mem;
+ gst_memory_unref (mem);
+
+ return mapped;
}
/**
* the memory block in @buffer is removed, replaced or merged, typically with
* any call that modifies the memory in @buffer.
*
- * Since this call does not influence the refcount of the memory,
- * gst_memory_is_exclusive() can be used to check if @buffer is the sole owner
- * of the returned memory.
- *
* Returns: (transfer none): the #GstMemory at @idx.
*/
GstMemory *
}
/**
+ * gst_buffer_get_memory:
+ * @buffer: a #GstBuffer.
+ * @idx: an index
+ *
+ * Get the memory block at index @idx in @buffer.
+ *
+ * Returns: (transfer full): a #GstMemory that contains the data of the
+ * memory block at @idx. Use gst_memory_unref () after usage.
+ */
+GstMemory *
+gst_buffer_get_memory (GstBuffer * buffer, guint idx)
+{
+ return gst_buffer_get_memory_range (buffer, idx, 1);
+}
+
+/**
+ * gst_buffer_get_all_memory:
+ * @buffer: a #GstBuffer.
+ *
+ * Get all the memory block in @buffer. The memory blocks will be merged
+ * into one large #GstMemory.
+ *
+ * Returns: (transfer full): a #GstMemory that contains the merged memory.
+ * Use gst_memory_unref () after usage.
+ */
+GstMemory *
+gst_buffer_get_all_memory (GstBuffer * buffer)
+{
+ return gst_buffer_get_memory_range (buffer, 0, -1);
+}
+
+/**
* gst_buffer_get_memory_range:
* @buffer: a #GstBuffer.
* @idx: an index
{
guint len;
- GST_DEBUG ("idx %u, length %d", idx, length);
+ GST_CAT_DEBUG (GST_CAT_BUFFER, "idx %u, length %d", idx, length);
g_return_val_if_fail (GST_IS_BUFFER (buffer), NULL);
len = GST_BUFFER_MEM_LEN (buffer);
- g_return_val_if_fail ((length == -1 && idx < len) ||
- (length > 0 && length + idx <= len), NULL);
+ g_return_val_if_fail ((len == 0 && idx == 0 && length == -1) ||
+ (length == -1 && idx < len) || (length > 0 && length + idx <= len), NULL);
if (length == -1)
length = len - idx;
}
/**
+ * gst_buffer_replace_memory:
+ * @buffer: a #GstBuffer.
+ * @idx: an index
+ * @mem: (transfer full): a #GstMemory
+ *
+ * Replaces the memory block at index @idx in @buffer with @mem.
+ */
+void
+gst_buffer_replace_memory (GstBuffer * buffer, guint idx, GstMemory * mem)
+{
+ gst_buffer_replace_memory_range (buffer, idx, 1, mem);
+}
+
+/**
+ * gst_buffer_replace_all_memory:
+ * @buffer: a #GstBuffer.
+ * @mem: (transfer full): a #GstMemory
+ *
+ * Replaces all memory in @buffer with @mem.
+ */
+void
+gst_buffer_replace_all_memory (GstBuffer * buffer, GstMemory * mem)
+{
+ gst_buffer_replace_memory_range (buffer, 0, -1, mem);
+}
+
+/**
* gst_buffer_replace_memory_range:
* @buffer: a #GstBuffer.
* @idx: an index
g_return_if_fail (GST_IS_BUFFER (buffer));
g_return_if_fail (gst_buffer_is_writable (buffer));
+
+ GST_CAT_DEBUG (GST_CAT_BUFFER, "idx %u, length %d, %p", idx, length, mem);
+
len = GST_BUFFER_MEM_LEN (buffer);
- g_return_if_fail ((length == -1 && idx < len) || (length > 0
- && length + idx <= len));
+ g_return_if_fail ((len == 0 && idx == 0 && length == -1) ||
+ (length == -1 && idx < len) || (length > 0 && length + idx <= len));
if (length == -1)
length = len - idx;
}
/**
+ * gst_buffer_remove_memory:
+ * @buffer: a #GstBuffer.
+ * @idx: an index
+ *
+ * Remove the memory block in @b at index @i.
+ */
+void
+gst_buffer_remove_memory (GstBuffer * buffer, guint idx)
+{
+ gst_buffer_remove_memory_range (buffer, idx, 1);
+}
+
+/**
+ * gst_buffer_remove_all_memory:
+ * @buffer: a #GstBuffer.
+ *
+ * Remove all the memory blocks in @buffer.
+ */
+void
+gst_buffer_remove_all_memory (GstBuffer * buffer)
+{
+ gst_buffer_remove_memory_range (buffer, 0, -1);
+}
+
+/**
* gst_buffer_remove_memory_range:
* @buffer: a #GstBuffer.
* @idx: an index
g_return_if_fail (GST_IS_BUFFER (buffer));
g_return_if_fail (gst_buffer_is_writable (buffer));
+ GST_CAT_DEBUG (GST_CAT_BUFFER, "idx %u, length %d", idx, length);
+
len = GST_BUFFER_MEM_LEN (buffer);
- g_return_if_fail ((length == -1 && idx < len) || length + idx <= len);
+ g_return_if_fail ((len == 0 && idx == 0 && length == -1) ||
+ (length == -1 && idx < len) || length + idx <= len);
if (length == -1)
length = len - idx;
}
/**
+ * gst_buffer_is_memory_range_writable:
+ * @buffer: a #GstBuffer.
+ * @idx: an index
+ * @length: a length should not be 0
+ *
+ * Check if @length memory blocks in @buffer starting from @idx are writable.
+ *
+ * @length can be -1 to check all the memory blocks after @idx.
+ *
+ * Note that this function does not check if @buffer is writable, use
+ * gst_buffer_is_writable() to check that if needed.
+ *
+ * Returns: %TRUE if the memory range is writable
+ *
+ * Since: 1.4
+ */
+gboolean
+gst_buffer_is_memory_range_writable (GstBuffer * buffer, guint idx, gint length)
+{
+ guint i, len;
+
+ g_return_val_if_fail (GST_IS_BUFFER (buffer), FALSE);
+
+ GST_CAT_DEBUG (GST_CAT_BUFFER, "idx %u, length %d", idx, length);
+
+ len = GST_BUFFER_MEM_LEN (buffer);
+ g_return_val_if_fail ((len == 0 && idx == 0 && length == -1) ||
+ (length == -1 && idx < len) || (length > 0 && length + idx <= len),
+ FALSE);
+
+ if (length == -1)
+ len -= idx;
+ else
+ len = length;
+
+ for (i = 0; i < len; i++) {
+ if (!gst_memory_is_writable (GST_BUFFER_MEM_PTR (buffer, i + idx)))
+ return FALSE;
+ }
+ return TRUE;
+}
+
+/**
+ * gst_buffer_is_all_memory_writable:
+ * @buffer: a #GstBuffer.
+ *
+ * Check if all memory blocks in @buffer are writable.
+ *
+ * Note that this function does not check if @buffer is writable, use
+ * gst_buffer_is_writable() to check that if needed.
+ *
+ * Returns: %TRUE if all memory blocks in @buffer are writable
+ *
+ * Since: 1.4
+ */
+gboolean
+gst_buffer_is_all_memory_writable (GstBuffer * buffer)
+{
+ return gst_buffer_is_memory_range_writable (buffer, 0, -1);
+}
+
+/**
+ * gst_buffer_get_sizes:
+ * @buffer: a #GstBuffer.
+ * @offset: (out): a pointer to the offset
+ * @maxsize: (out): a pointer to the maxsize
+ *
+ * Get the total size of the memory blocks in @b.
+ *
+ * When not %NULL, @offset will contain the offset of the data in the
+ * first memory block in @buffer and @maxsize will contain the sum of
+ * the size and @offset and the amount of extra padding on the last
+ * memory block. @offset and @maxsize can be used to resize the
+ * buffer memory blocks with gst_buffer_resize().
+ *
+ * Returns: total size of the memory blocks in @buffer.
+ */
+gsize
+gst_buffer_get_sizes (GstBuffer * buffer, gsize * offset, gsize * maxsize)
+{
+ return gst_buffer_get_sizes_range (buffer, 0, -1, offset, maxsize);
+}
+
+/**
+ * gst_buffer_get_size:
+ * @buffer: a #GstBuffer.
+ *
+ * Get the total size of the memory blocks in @buffer.
+ *
+ * Returns: total size of the memory blocks in @buffer.
+ */
+gsize
+gst_buffer_get_size (GstBuffer * buffer)
+{
+ return gst_buffer_get_sizes_range (buffer, 0, -1, NULL, NULL);
+}
+
+/**
* gst_buffer_get_sizes_range:
* @buffer: a #GstBuffer.
* @idx: an index
* @length: a length
- * @offset: a pointer to the offset
- * @maxsize: a pointer to the maxsize
+ * @offset: (out): a pointer to the offset
+ * @maxsize: (out): a pointer to the maxsize
*
* Get the total size of @length memory blocks stating from @idx in @buffer.
*
* @offset and @maxsize can be used to resize the buffer memory blocks with
* gst_buffer_resize_range().
*
- * Returns: total size @length memory blocks starting at @idx in @buffer.
+ * Returns: total size of @length memory blocks starting at @idx in @buffer.
*/
gsize
gst_buffer_get_sizes_range (GstBuffer * buffer, guint idx, gint length,
g_return_val_if_fail (GST_IS_BUFFER (buffer), 0);
len = GST_BUFFER_MEM_LEN (buffer);
- g_return_val_if_fail (len == 0 || (length == -1 && idx < len)
- || (length + idx <= len), 0);
+ g_return_val_if_fail ((len == 0 && idx == 0 && length == -1) ||
+ (length == -1 && idx < len) || (length + idx <= len), 0);
if (length == -1)
length = len - idx;
}
/**
+ * gst_buffer_resize:
+ * @buffer: a #GstBuffer.
+ * @offset: the offset adjustment
+ * @size: the new size or -1 to just adjust the offset
+ *
+ * Set the offset and total size of the memory blocks in @buffer.
+ */
+void
+gst_buffer_resize (GstBuffer * buffer, gssize offset, gssize size)
+{
+ gst_buffer_resize_range (buffer, 0, -1, offset, size);
+}
+
+/**
+ * gst_buffer_set_size:
+ * @buffer: a #GstBuffer.
+ * @size: the new size
+ *
+ * Set the total size of the memory blocks in @buffer.
+ */
+void
+gst_buffer_set_size (GstBuffer * buffer, gssize size)
+{
+ gst_buffer_resize_range (buffer, 0, -1, 0, size);
+}
+
+/**
* gst_buffer_resize_range:
* @buffer: a #GstBuffer.
* @idx: an index
* @length: a length
- * @offset: the offset adjustement
+ * @offset: the offset adjustment
* @size: the new size or -1 to just adjust the offset
*
* Set the total size of the @length memory blocks starting at @idx in
* @buffer
+ *
+ * Returns: %TRUE if resizing succeeded, %FALSE otherwise.
*/
-void
+gboolean
gst_buffer_resize_range (GstBuffer * buffer, guint idx, gint length,
gssize offset, gssize size)
{
guint i, len, end;
gsize bsize, bufsize, bufoffs, bufmax;
- GstMemory *mem;
- g_return_if_fail (gst_buffer_is_writable (buffer));
- g_return_if_fail (size >= -1);
+ g_return_val_if_fail (gst_buffer_is_writable (buffer), FALSE);
+ g_return_val_if_fail (size >= -1, FALSE);
+
len = GST_BUFFER_MEM_LEN (buffer);
- g_return_if_fail ((length == -1 && idx < len) || (length + idx <= len));
+ g_return_val_if_fail ((len == 0 && idx == 0 && length == -1) ||
+ (length == -1 && idx < len) || (length + idx <= len), FALSE);
if (length == -1)
length = len - idx;
/* we can't go back further than the current offset or past the end of the
* buffer */
- g_return_if_fail ((offset < 0 && bufoffs >= -offset) || (offset >= 0
- && bufoffs + offset <= bufmax));
+ g_return_val_if_fail ((offset < 0 && bufoffs >= -offset) || (offset >= 0
+ && bufoffs + offset <= bufmax), FALSE);
if (size == -1) {
- g_return_if_fail (bufsize >= offset);
+ g_return_val_if_fail (bufsize >= offset, FALSE);
size = bufsize - offset;
}
- g_return_if_fail (bufmax >= bufoffs + offset + size);
+ g_return_val_if_fail (bufmax >= bufoffs + offset + size, FALSE);
/* no change */
if (offset == 0 && size == bufsize)
- return;
+ return TRUE;
end = idx + length;
/* copy and trim */
for (i = idx; i < end; i++) {
+ GstMemory *mem;
gsize left, noffs;
mem = GST_BUFFER_MEM_PTR (buffer, i);
left = MIN (bsize - offset, size);
if (offset != 0 || left != bsize) {
- if (gst_memory_is_exclusive (mem)) {
+ if (gst_memory_is_writable (mem)) {
gst_memory_resize (mem, offset, left);
} else {
- GstMemory *tmp;
+ GstMemory *newmem = NULL;
+
+ if (!GST_MEMORY_IS_NO_SHARE (mem))
+ newmem = gst_memory_share (mem, offset, left);
- if (mem->flags & GST_MEMORY_FLAG_NO_SHARE)
- tmp = gst_memory_copy (mem, offset, left);
- else
- tmp = gst_memory_share (mem, offset, left);
+ if (!newmem)
+ newmem = gst_memory_copy (mem, offset, left);
+ if (newmem == NULL)
+ return FALSE;
+
+ gst_memory_lock (newmem, GST_LOCK_FLAG_EXCLUSIVE);
+ GST_BUFFER_MEM_PTR (buffer, i) = newmem;
+ gst_memory_unlock (mem, GST_LOCK_FLAG_EXCLUSIVE);
gst_memory_unref (mem);
- mem = tmp;
+
+ GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY);
}
}
+
offset = noffs;
size -= left;
-
- GST_BUFFER_MEM_PTR (buffer, i) = mem;
}
+
+ return TRUE;
+}
+
+/**
+ * gst_buffer_map:
+ * @buffer: a #GstBuffer.
+ * @info: (out): info about the mapping
+ * @flags: flags for the mapping
+ *
+ * This function fills @info with the #GstMapInfo of all merged memory
+ * blocks in @buffer.
+ *
+ * @flags describe the desired access of the memory. When @flags is
+ * #GST_MAP_WRITE, @buffer should be writable (as returned from
+ * gst_buffer_is_writable()).
+ *
+ * When @buffer is writable but the memory isn't, a writable copy will
+ * automatically be created and returned. The readonly copy of the
+ * buffer memory will then also be replaced with this writable copy.
+ *
+ * The memory in @info should be unmapped with gst_buffer_unmap() after
+ * usage.
+ *
+ * Returns: %TRUE if the map succeeded and @info contains valid data.
+ */
+gboolean
+gst_buffer_map (GstBuffer * buffer, GstMapInfo * info, GstMapFlags flags)
+{
+ return gst_buffer_map_range (buffer, 0, -1, info, flags);
}
/**
* This function fills @info with the #GstMapInfo of @length merged memory blocks
* starting at @idx in @buffer. When @length is -1, all memory blocks starting
* from @idx are merged and mapped.
+ *
* @flags describe the desired access of the memory. When @flags is
* #GST_MAP_WRITE, @buffer should be writable (as returned from
* gst_buffer_is_writable()).
*
* The memory in @info should be unmapped with gst_buffer_unmap() after usage.
*
- * Returns: (transfer full): %TRUE if the map succeeded and @info contains valid
+ * Returns: %TRUE if the map succeeded and @info contains valid
* data.
*/
gboolean
g_return_val_if_fail (GST_IS_BUFFER (buffer), FALSE);
g_return_val_if_fail (info != NULL, FALSE);
len = GST_BUFFER_MEM_LEN (buffer);
- if (len == 0)
- goto no_memory;
- g_return_val_if_fail ((length == -1 && idx < len) || (length > 0
+ g_return_val_if_fail ((len == 0 && idx == 0 && length == -1) ||
+ (length == -1 && idx < len) || (length > 0
&& length + idx <= len), FALSE);
+ GST_CAT_LOG (GST_CAT_BUFFER, "buffer %p, idx %u, length %d, flags %04x",
+ buffer, idx, length, flags);
+
write = (flags & GST_MAP_WRITE) != 0;
writable = gst_buffer_is_writable (buffer);
{
GST_WARNING_OBJECT (buffer, "write map requested on non-writable buffer");
g_critical ("write map requested on non-writable buffer");
+ memset (info, 0, sizeof (GstMapInfo));
return FALSE;
}
no_memory:
{
/* empty buffer, we need to return NULL */
GST_DEBUG_OBJECT (buffer, "can't get buffer memory");
- info->memory = NULL;
- info->data = NULL;
- info->size = 0;
- info->maxsize = 0;
+ memset (info, 0, sizeof (GstMapInfo));
return TRUE;
}
cannot_map:
{
GST_DEBUG_OBJECT (buffer, "cannot map memory");
+ memset (info, 0, sizeof (GstMapInfo));
return FALSE;
}
}
* gst_buffer_fill:
* @buffer: a #GstBuffer.
* @offset: the offset to fill
- * @src: the source address
+ * @src: (array length=size) (element-type guint8): the source address
* @size: the size to fill
*
* Copy @size bytes from @src to @buffer at @offset.
g_return_val_if_fail (GST_IS_BUFFER (buffer), 0);
g_return_val_if_fail (gst_buffer_is_writable (buffer), 0);
- g_return_val_if_fail (src != NULL, 0);
+ g_return_val_if_fail (src != NULL || size == 0, 0);
+
+ GST_CAT_LOG (GST_CAT_BUFFER,
+ "buffer %p, offset %" G_GSIZE_FORMAT ", size %" G_GSIZE_FORMAT, buffer,
+ offset, size);
len = GST_BUFFER_MEM_LEN (buffer);
left = size;
g_return_val_if_fail (GST_IS_BUFFER (buffer), 0);
g_return_val_if_fail (dest != NULL, 0);
+ GST_CAT_LOG (GST_CAT_BUFFER,
+ "buffer %p, offset %" G_GSIZE_FORMAT ", size %" G_GSIZE_FORMAT, buffer,
+ offset, size);
+
len = GST_BUFFER_MEM_LEN (buffer);
left = size;
* gst_buffer_memcmp:
* @buffer: a #GstBuffer.
* @offset: the offset in @buffer
- * @mem: the memory to compare
+ * @mem: (array length=size) (element-type guint8): the memory to compare
* @size: the size to compare
*
* Compare @size bytes starting from @offset in @buffer with the memory in @mem.
g_return_val_if_fail (GST_IS_BUFFER (buffer), 0);
g_return_val_if_fail (mem != NULL, 0);
+ GST_CAT_LOG (GST_CAT_BUFFER,
+ "buffer %p, offset %" G_GSIZE_FORMAT ", size %" G_GSIZE_FORMAT, buffer,
+ offset, size);
+
+ if (G_UNLIKELY (gst_buffer_get_size (buffer) < offset + size))
+ return -1;
+
len = GST_BUFFER_MEM_LEN (buffer);
for (i = 0; i < len && size > 0 && res == 0; i++) {
g_return_val_if_fail (GST_IS_BUFFER (buffer), 0);
g_return_val_if_fail (gst_buffer_is_writable (buffer), 0);
+ GST_CAT_LOG (GST_CAT_BUFFER,
+ "buffer %p, offset %" G_GSIZE_FORMAT ", val %02x, size %" G_GSIZE_FORMAT,
+ buffer, offset, val, size);
+
len = GST_BUFFER_MEM_LEN (buffer);
left = size;
*
* MT safe.
*
- * Returns: (transfer full): the new #GstBuffer or NULL if the arguments were
+ * Returns: (transfer full): the new #GstBuffer or %NULL if the arguments were
* invalid.
*/
GstBuffer *
GST_CAT_LOG (GST_CAT_BUFFER, "new region copy %p of %p %" G_GSIZE_FORMAT
"-%" G_GSIZE_FORMAT, copy, buffer, offset, size);
- gst_buffer_copy_into (copy, buffer, flags, offset, size);
+ if (!gst_buffer_copy_into (copy, buffer, flags, offset, size))
+ gst_buffer_replace (©, NULL);
return copy;
}
GstBuffer *
gst_buffer_append (GstBuffer * buf1, GstBuffer * buf2)
{
+ return gst_buffer_append_region (buf1, buf2, 0, -1);
+}
+
+/**
+ * gst_buffer_append_region:
+ * @buf1: (transfer full): the first source #GstBuffer to append.
+ * @buf2: (transfer full): the second source #GstBuffer to append.
+ * @offset: the offset in @buf2
+ * @size: the size or -1 of @buf2
+ *
+ * Append @size bytes at @offset from @buf2 to @buf1. The result buffer will
+ * contain a concatenation of the memory of @buf1 and the requested region of
+ * @buf2.
+ *
+ * Returns: (transfer full): the new #GstBuffer that contains the memory
+ * of the two source buffers.
+ */
+GstBuffer *
+gst_buffer_append_region (GstBuffer * buf1, GstBuffer * buf2, gssize offset,
+ gssize size)
+{
gsize i, len;
g_return_val_if_fail (GST_IS_BUFFER (buf1), NULL);
buf1 = gst_buffer_make_writable (buf1);
buf2 = gst_buffer_make_writable (buf2);
+ gst_buffer_resize (buf2, offset, size);
+
len = GST_BUFFER_MEM_LEN (buf2);
for (i = 0; i < len; i++) {
GstMemory *mem;
mem = GST_BUFFER_MEM_PTR (buf2, i);
GST_BUFFER_MEM_PTR (buf2, i) = NULL;
- _memory_add (buf1, -1, mem);
- }
-
- /* we can calculate the duration too. Also make sure we're not messing
- * with invalid DURATIONS */
- if (GST_BUFFER_DURATION_IS_VALID (buf1) &&
- GST_BUFFER_DURATION_IS_VALID (buf2)) {
- /* add duration */
- GST_BUFFER_DURATION (buf1) += GST_BUFFER_DURATION (buf2);
- }
- if (GST_BUFFER_OFFSET_END_IS_VALID (buf2)) {
- /* set offset_end */
- GST_BUFFER_OFFSET_END (buf1) = GST_BUFFER_OFFSET_END (buf2);
+ _memory_add (buf1, -1, mem, FALSE);
}
GST_BUFFER_MEM_LEN (buf2) = 0;
+ GST_BUFFER_FLAG_SET (buf2, GST_BUFFER_FLAG_TAG_MEMORY);
gst_buffer_unref (buf2);
return buf1;
* @api: the #GType of an API
*
* Get the metadata for @api on buffer. When there is no such
- * metadata, NULL is returned.
+ * metadata, %NULL is returned.
*
- * Returns: the metadata for @api on @buffer.
+ * Returns: (transfer none): the metadata for @api on @buffer.
*/
GstMeta *
gst_buffer_get_meta (GstBuffer * buffer, GType api)
g_return_val_if_fail (buffer != NULL, FALSE);
g_return_val_if_fail (meta != NULL, FALSE);
g_return_val_if_fail (gst_buffer_is_writable (buffer), FALSE);
+ g_return_val_if_fail (!GST_META_FLAG_IS_SET (meta, GST_META_FLAG_LOCKED),
+ FALSE);
/* find the metadata and delete */
prev = GST_BUFFER_META (buffer);
* Retrieve the next #GstMeta after @current. If @state points
* to %NULL, the first metadata is returned.
*
- * @state will be updated with an opage state pointer
+ * @state will be updated with an opaque state pointer
*
- * Returns: The next #GstMeta or %NULL when there are no more items.
+ * Returns: (transfer none): The next #GstMeta or %NULL when there are
+ * no more items.
*/
GstMeta *
gst_buffer_iterate_meta (GstBuffer * buffer, gpointer * state)
* @func can modify the passed meta pointer or its contents. The return value
* of @func define if this function returns or if the remaining metadata items
* in the buffer should be skipped.
+ *
+ * Returns: %FALSE when @func returned %FALSE for one of the metadata.
*/
-void
+gboolean
gst_buffer_foreach_meta (GstBuffer * buffer, GstBufferForeachMetaFunc func,
gpointer user_data)
{
GstMetaItem *walk, *prev, *next;
+ gboolean res = TRUE;
- g_return_if_fail (buffer != NULL);
- g_return_if_fail (func != NULL);
+ g_return_val_if_fail (buffer != NULL, FALSE);
+ g_return_val_if_fail (func != NULL, FALSE);
/* find the metadata and delete */
prev = GST_BUFFER_META (buffer);
for (walk = prev; walk; walk = next) {
GstMeta *m, *new;
- gboolean res;
m = new = &walk->meta;
next = walk->next;
GST_CAT_DEBUG (GST_CAT_BUFFER, "remove metadata %p (%s)", m,
g_type_name (info->type));
- g_return_if_fail (gst_buffer_is_writable (buffer));
+ g_return_val_if_fail (gst_buffer_is_writable (buffer), FALSE);
+ g_return_val_if_fail (!GST_META_FLAG_IS_SET (m, GST_META_FLAG_LOCKED),
+ FALSE);
/* remove from list */
if (GST_BUFFER_META (buffer) == walk)
if (!res)
break;
}
+ return res;
+}
+
+/**
+ * gst_buffer_extract_dup:
+ * @buffer: a #GstBuffer
+ * @offset: the offset to extract
+ * @size: the size to extract
+ * @dest: (array length=dest_size) (element-type guint8) (out): A pointer where
+ * the destination array will be written.
+ * @dest_size: (out): A location where the size of @dest can be written
+ *
+ * Extracts a copy of at most @size bytes the data at @offset into a #GBytes.
+ * @dest must be freed using g_free() when done.
+ *
+ * Since: 1.0.10
+ */
+
+void
+gst_buffer_extract_dup (GstBuffer * buffer, gsize offset, gsize size,
+ gpointer * dest, gsize * dest_size)
+{
+ gsize real_size;
+
+ real_size = gst_buffer_get_size (buffer);
+
+ *dest = g_malloc (MIN (real_size - offset, size));
+
+ *dest_size = gst_buffer_extract (buffer, offset, *dest, size);
}
projects / platform / upstream / gstreamer.git / blobdiff