mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-22 00:06:36 +00:00
abf6293639
Also return the offset in a GstMemory block with the get_sizes() method. This allows us to figure out how much prefix there is unused. Change the resize function so that a negative offset can be given. This would make it possible to resize the buffer so that the prefix becomes available. Add gst_buffer_get_sizes() to return the offset and maxsize as well as the size. Also change the buffer resize method so that we can specify a negative offset to remove prefix bytes.
482 lines
17 KiB
C
482 lines
17 KiB
C
/* GStreamer
|
|
* Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
|
|
* 2000 Wim Taymans <wtay@chello.be>
|
|
*
|
|
* gstbuffer.h: Header for GstBuffer object
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Library General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Library General Public License for more details.
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
|
|
#ifndef __GST_BUFFER_H__
|
|
#define __GST_BUFFER_H__
|
|
|
|
#include <gst/gstminiobject.h>
|
|
#include <gst/gstclock.h>
|
|
#include <gst/gstcaps.h>
|
|
#include <gst/gstmemory.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
extern GType _gst_buffer_type;
|
|
|
|
typedef struct _GstBuffer GstBuffer;
|
|
typedef struct _GstBufferPool GstBufferPool;
|
|
|
|
/**
|
|
* GST_BUFFER_TRACE_NAME:
|
|
*
|
|
* The name used for tracing memory allocations.
|
|
*/
|
|
#define GST_BUFFER_TRACE_NAME "GstBuffer"
|
|
|
|
#define GST_TYPE_BUFFER (_gst_buffer_type)
|
|
#define GST_IS_BUFFER(obj) (GST_IS_MINI_OBJECT_TYPE(obj, GST_TYPE_BUFFER))
|
|
#define GST_BUFFER_CAST(obj) ((GstBuffer *)(obj))
|
|
#define GST_BUFFER(obj) (GST_BUFFER_CAST(obj))
|
|
|
|
/**
|
|
* GST_BUFFER_FLAGS:
|
|
* @buf: a #GstBuffer.
|
|
*
|
|
* A flags word containing #GstBufferFlag flags set on this buffer.
|
|
*/
|
|
#define GST_BUFFER_FLAGS(buf) GST_MINI_OBJECT_FLAGS(buf)
|
|
/**
|
|
* GST_BUFFER_FLAG_IS_SET:
|
|
* @buf: a #GstBuffer.
|
|
* @flag: the #GstBufferFlag to check.
|
|
*
|
|
* Gives the status of a specific flag on a buffer.
|
|
*/
|
|
#define GST_BUFFER_FLAG_IS_SET(buf,flag) GST_MINI_OBJECT_FLAG_IS_SET (buf, flag)
|
|
/**
|
|
* GST_BUFFER_FLAG_SET:
|
|
* @buf: a #GstBuffer.
|
|
* @flag: the #GstBufferFlag to set.
|
|
*
|
|
* Sets a buffer flag on a buffer.
|
|
*/
|
|
#define GST_BUFFER_FLAG_SET(buf,flag) GST_MINI_OBJECT_FLAG_SET (buf, flag)
|
|
/**
|
|
* GST_BUFFER_FLAG_UNSET:
|
|
* @buf: a #GstBuffer.
|
|
* @flag: the #GstBufferFlag to clear.
|
|
*
|
|
* Clears a buffer flag.
|
|
*/
|
|
#define GST_BUFFER_FLAG_UNSET(buf,flag) GST_MINI_OBJECT_FLAG_UNSET (buf, flag)
|
|
|
|
/**
|
|
* GST_BUFFER_TIMESTAMP:
|
|
* @buf: a #GstBuffer.:
|
|
*
|
|
* The timestamp in nanoseconds (as a #GstClockTime) of the data in the buffer.
|
|
* Value will be %GST_CLOCK_TIME_NONE if the timestamp is unknown.
|
|
*
|
|
*/
|
|
#define GST_BUFFER_TIMESTAMP(buf) (GST_BUFFER_CAST(buf)->timestamp)
|
|
/**
|
|
* GST_BUFFER_DURATION:
|
|
* @buf: a #GstBuffer.
|
|
*
|
|
* The duration in nanoseconds (as a #GstClockTime) of the data in the buffer.
|
|
* Value will be %GST_CLOCK_TIME_NONE if the duration is unknown.
|
|
*/
|
|
#define GST_BUFFER_DURATION(buf) (GST_BUFFER_CAST(buf)->duration)
|
|
/**
|
|
* GST_BUFFER_OFFSET:
|
|
* @buf: a #GstBuffer.
|
|
*
|
|
* The offset in the source file of the beginning of this buffer.
|
|
*/
|
|
#define GST_BUFFER_OFFSET(buf) (GST_BUFFER_CAST(buf)->offset)
|
|
/**
|
|
* GST_BUFFER_OFFSET_END:
|
|
* @buf: a #GstBuffer.
|
|
*
|
|
* The offset in the source file of the end of this buffer.
|
|
*/
|
|
#define GST_BUFFER_OFFSET_END(buf) (GST_BUFFER_CAST(buf)->offset_end)
|
|
|
|
/**
|
|
* GST_BUFFER_OFFSET_NONE:
|
|
*
|
|
* Constant for no-offset return results.
|
|
*/
|
|
#define GST_BUFFER_OFFSET_NONE ((guint64)-1)
|
|
|
|
/**
|
|
* GST_BUFFER_DURATION_IS_VALID:
|
|
* @buffer: a #GstBuffer
|
|
*
|
|
* Tests if the duration is known.
|
|
*/
|
|
#define GST_BUFFER_DURATION_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DURATION (buffer)))
|
|
/**
|
|
* GST_BUFFER_TIMESTAMP_IS_VALID:
|
|
* @buffer: a #GstBuffer
|
|
*
|
|
* Tests if the timestamp is known.
|
|
*/
|
|
#define GST_BUFFER_TIMESTAMP_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_TIMESTAMP (buffer)))
|
|
/**
|
|
* GST_BUFFER_OFFSET_IS_VALID:
|
|
* @buffer: a #GstBuffer
|
|
*
|
|
* Tests if the start offset is known.
|
|
*/
|
|
#define GST_BUFFER_OFFSET_IS_VALID(buffer) (GST_BUFFER_OFFSET (buffer) != GST_BUFFER_OFFSET_NONE)
|
|
/**
|
|
* GST_BUFFER_OFFSET_END_IS_VALID:
|
|
* @buffer: a #GstBuffer
|
|
*
|
|
* Tests if the end offset is known.
|
|
*/
|
|
#define GST_BUFFER_OFFSET_END_IS_VALID(buffer) (GST_BUFFER_OFFSET_END (buffer) != GST_BUFFER_OFFSET_NONE)
|
|
/**
|
|
* GST_BUFFER_IS_DISCONT:
|
|
* @buffer: a #GstBuffer
|
|
*
|
|
* Tests if the buffer marks a discontinuity in the stream.
|
|
*
|
|
* Since: 0.10.9
|
|
*/
|
|
#define GST_BUFFER_IS_DISCONT(buffer) (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DISCONT))
|
|
|
|
/**
|
|
* GstBufferFlag:
|
|
* @GST_BUFFER_FLAG_PREROLL: the buffer is part of a preroll and should not be
|
|
* displayed.
|
|
* @GST_BUFFER_FLAG_DISCONT: the buffer marks a discontinuity in the stream.
|
|
* This typically occurs after a seek or a dropped buffer from a live or
|
|
* network source.
|
|
* @GST_BUFFER_FLAG_IN_CAPS: the buffer has been added as a field in a #GstCaps.
|
|
* @GST_BUFFER_FLAG_GAP: the buffer has been created to fill a gap in the
|
|
* stream and contains media neutral data (elements can switch to optimized code
|
|
* path that ignores the buffer content).
|
|
* @GST_BUFFER_FLAG_DELTA_UNIT: this unit cannot be decoded independently.
|
|
* @GST_BUFFER_FLAG_MEDIA1: a flag whose use is specific to the caps of the buffer. Since: 0.10.23.
|
|
* @GST_BUFFER_FLAG_MEDIA2: a flag whose use is specific to the caps of the buffer. Since: 0.10.23.
|
|
* @GST_BUFFER_FLAG_MEDIA3: a flag whose use is specific to the caps of the buffer. Since: 0.10.23.
|
|
* @GST_BUFFER_FLAG_MEDIA4: a flag whose use is specific to the caps of the buffer. Since: 0.10.33.
|
|
* @GST_BUFFER_FLAG_LAST: additional flags can be added starting from this flag.
|
|
*
|
|
* A set of buffer flags used to describe properties of a #GstBuffer.
|
|
*/
|
|
typedef enum {
|
|
GST_BUFFER_FLAG_PREROLL = (GST_MINI_OBJECT_FLAG_LAST << 0),
|
|
GST_BUFFER_FLAG_DISCONT = (GST_MINI_OBJECT_FLAG_LAST << 1),
|
|
GST_BUFFER_FLAG_IN_CAPS = (GST_MINI_OBJECT_FLAG_LAST << 2),
|
|
GST_BUFFER_FLAG_GAP = (GST_MINI_OBJECT_FLAG_LAST << 3),
|
|
GST_BUFFER_FLAG_DELTA_UNIT = (GST_MINI_OBJECT_FLAG_LAST << 4),
|
|
GST_BUFFER_FLAG_MEDIA1 = (GST_MINI_OBJECT_FLAG_LAST << 5),
|
|
GST_BUFFER_FLAG_MEDIA2 = (GST_MINI_OBJECT_FLAG_LAST << 6),
|
|
GST_BUFFER_FLAG_MEDIA3 = (GST_MINI_OBJECT_FLAG_LAST << 7),
|
|
GST_BUFFER_FLAG_MEDIA4 = (GST_MINI_OBJECT_FLAG_LAST << 8),
|
|
GST_BUFFER_FLAG_LAST = (GST_MINI_OBJECT_FLAG_LAST << 16)
|
|
} GstBufferFlag;
|
|
|
|
/**
|
|
* GstBuffer:
|
|
* @mini_object: the parent structure
|
|
* @pool: pointer to the pool owner of the buffer
|
|
* @timestamp: timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
|
|
* timestamp is not known or relevant.
|
|
* @duration: duration in time of the buffer data, can be #GST_CLOCK_TIME_NONE
|
|
* when the duration is not known or relevant.
|
|
* @offset: a media specific offset for the buffer data.
|
|
* For video frames, this is the frame number of this buffer.
|
|
* For audio samples, this is the offset of the first sample in this buffer.
|
|
* For file data or compressed data this is the byte offset of the first
|
|
* byte in this buffer.
|
|
* @offset_end: the last offset contained in this buffer. It has the same
|
|
* format as @offset.
|
|
*
|
|
* The structure of a #GstBuffer. Use the associated macros to access the public
|
|
* variables.
|
|
*/
|
|
struct _GstBuffer {
|
|
GstMiniObject mini_object;
|
|
|
|
/*< public >*/ /* with COW */
|
|
GstBufferPool *pool;
|
|
|
|
/* timestamp */
|
|
GstClockTime timestamp;
|
|
GstClockTime duration;
|
|
|
|
/* media specific offset */
|
|
guint64 offset;
|
|
guint64 offset_end;
|
|
};
|
|
|
|
/* allocation */
|
|
GstBuffer * gst_buffer_new (void);
|
|
GstBuffer * gst_buffer_new_allocate (const GstAllocator * allocator, gsize maxsize, gsize align);
|
|
GstBuffer * gst_buffer_new_wrapped_full (gpointer data, GFreeFunc free_func, gsize offset, gsize size);
|
|
GstBuffer * gst_buffer_new_wrapped (gpointer data, gsize size);
|
|
|
|
/* memory blocks */
|
|
guint gst_buffer_n_memory (GstBuffer *buffer);
|
|
void gst_buffer_take_memory (GstBuffer *buffer, gint idx, GstMemory *mem);
|
|
GstMemory * gst_buffer_peek_memory (GstBuffer *buffer, guint idx, GstMapFlags flags);
|
|
void gst_buffer_remove_memory_range (GstBuffer *buffer, guint idx, guint length);
|
|
|
|
/**
|
|
* gst_buffer_remove_memory:
|
|
* @b: a #GstBuffer.
|
|
* @i: an index
|
|
*
|
|
* Remove the memory block in @b at @i.
|
|
*/
|
|
#define gst_buffer_remove_memory(b,i) gst_buffer_remove_memory_range ((b), (i), 1)
|
|
|
|
void gst_buffer_fill (GstBuffer *buffer, gsize offset,
|
|
gconstpointer src, gsize size);
|
|
void gst_buffer_extract (GstBuffer *buffer, gsize offset,
|
|
gpointer dest, gsize size);
|
|
gint gst_buffer_memcmp (GstBuffer *buffer, gsize offset,
|
|
gconstpointer mem, gsize size);
|
|
void gst_buffer_memset (GstBuffer *buffer, gsize offset,
|
|
guint8 val, gsize size);
|
|
|
|
gsize gst_buffer_get_sizes (GstBuffer *buffer, gsize *offset, gsize *maxsize);
|
|
void gst_buffer_resize (GstBuffer *buffer, gssize offset, gsize size);
|
|
|
|
/**
|
|
* gst_buffer_get_size:
|
|
* @b: a #GstBuffer.
|
|
*
|
|
* Get the size of @b.
|
|
*/
|
|
#define gst_buffer_get_size(b) gst_buffer_get_sizes ((b), NULL, NULL)
|
|
/**
|
|
* gst_buffer_set_size:
|
|
* @b: a #GstBuffer.
|
|
* @s: a new size
|
|
*
|
|
* Set the size of @b to @s. This will remove or trim the memory blocks
|
|
* in the buffer.
|
|
*/
|
|
#define gst_buffer_set_size(b,s) gst_buffer_resize ((b), 0, (s))
|
|
|
|
/* getting memory */
|
|
gpointer gst_buffer_map (GstBuffer *buffer, gsize *size, gsize *maxsize,
|
|
GstMapFlags flags);
|
|
gboolean gst_buffer_unmap (GstBuffer *buffer, gpointer data, gsize size);
|
|
|
|
/* refcounting */
|
|
/**
|
|
* gst_buffer_ref:
|
|
* @buf: a #GstBuffer.
|
|
*
|
|
* Increases the refcount of the given buffer by one.
|
|
*
|
|
* Note that the refcount affects the writeability
|
|
* of @buf and its metadata, see gst_buffer_is_writable() and
|
|
* gst_buffer_is_metadata_writable(). It is
|
|
* important to note that keeping additional references to
|
|
* GstBuffer instances can potentially increase the number
|
|
* of memcpy operations in a pipeline.
|
|
*
|
|
* Returns: (transfer full): @buf
|
|
*/
|
|
#ifdef _FOOL_GTK_DOC_
|
|
G_INLINE_FUNC GstBuffer * gst_buffer_ref (GstBuffer * buf);
|
|
#endif
|
|
|
|
static inline GstBuffer *
|
|
gst_buffer_ref (GstBuffer * buf)
|
|
{
|
|
return (GstBuffer *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (buf));
|
|
}
|
|
|
|
/**
|
|
* gst_buffer_unref:
|
|
* @buf: (transfer full): a #GstBuffer.
|
|
*
|
|
* Decreases the refcount of the buffer. If the refcount reaches 0, the buffer
|
|
* will be freed. If GST_BUFFER_MALLOCDATA() is non-NULL, this pointer will
|
|
* also be freed at this time.
|
|
*/
|
|
#ifdef _FOOL_GTK_DOC_
|
|
G_INLINE_FUNC void gst_buffer_unref (GstBuffer * buf);
|
|
#endif
|
|
|
|
static inline void
|
|
gst_buffer_unref (GstBuffer * buf)
|
|
{
|
|
gst_mini_object_unref (GST_MINI_OBJECT_CAST (buf));
|
|
}
|
|
|
|
/* copy buffer */
|
|
/**
|
|
* gst_buffer_copy:
|
|
* @buf: a #GstBuffer.
|
|
*
|
|
* Create a copy of the given buffer. This will also make a newly allocated
|
|
* copy of the data the source buffer contains.
|
|
*
|
|
* Returns: (transfer full): a new copy of @buf.
|
|
*/
|
|
#ifdef _FOOL_GTK_DOC_
|
|
G_INLINE_FUNC GstBuffer * gst_buffer_copy (const GstBuffer * buf);
|
|
#endif
|
|
|
|
static inline GstBuffer *
|
|
gst_buffer_copy (const GstBuffer * buf)
|
|
{
|
|
return GST_BUFFER (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (buf)));
|
|
}
|
|
|
|
|
|
/**
|
|
* GstBufferCopyFlags:
|
|
* @GST_BUFFER_COPY_NONE: copy nothing
|
|
* @GST_BUFFER_COPY_FLAGS: flag indicating that buffer flags should be copied
|
|
* @GST_BUFFER_COPY_TIMESTAMPS: flag indicating that buffer timestamp, duration,
|
|
* offset and offset_end should be copied
|
|
* @GST_BUFFER_COPY_MEMORY: flag indicating that buffer memory should be copied
|
|
* and appended to already existing memory
|
|
* @GST_BUFFER_COPY_MERGE: flag indicating that buffer memory should be
|
|
* merged
|
|
*
|
|
* A set of flags that can be provided to the gst_buffer_copy_into()
|
|
* function to specify which items should be copied.
|
|
*/
|
|
typedef enum {
|
|
GST_BUFFER_COPY_NONE = 0,
|
|
GST_BUFFER_COPY_FLAGS = (1 << 0),
|
|
GST_BUFFER_COPY_TIMESTAMPS = (1 << 1),
|
|
GST_BUFFER_COPY_MEMORY = (1 << 2),
|
|
GST_BUFFER_COPY_MERGE = (1 << 3)
|
|
} GstBufferCopyFlags;
|
|
|
|
/**
|
|
* GST_BUFFER_COPY_METADATA:
|
|
*
|
|
* Combination of all possible metadata fields that can be copied with
|
|
* gst_buffer_copy_into().
|
|
*/
|
|
#define GST_BUFFER_COPY_METADATA (GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS)
|
|
|
|
/**
|
|
* GST_BUFFER_COPY_ALL:
|
|
*
|
|
* Combination of all possible fields that can be copied with
|
|
* gst_buffer_copy_into().
|
|
*/
|
|
#define GST_BUFFER_COPY_ALL (GST_BUFFER_COPY_METADATA | GST_BUFFER_COPY_MEMORY)
|
|
|
|
/* copies memory or metadata into newly allocated buffer */
|
|
void gst_buffer_copy_into (GstBuffer *dest, GstBuffer *src,
|
|
GstBufferCopyFlags flags,
|
|
gsize offset, gsize size);
|
|
|
|
/**
|
|
* gst_buffer_is_writable:
|
|
* @buf: a #GstBuffer
|
|
*
|
|
* Tests if you can safely write data into a buffer's data array or validly
|
|
* modify the caps and timestamp metadata. Metadata in a GstBuffer is always
|
|
* writable, but it is only safe to change it when there is only one owner
|
|
* of the buffer - ie, the refcount is 1.
|
|
*/
|
|
#define gst_buffer_is_writable(buf) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (buf))
|
|
/**
|
|
* gst_buffer_make_writable:
|
|
* @buf: (transfer full): a #GstBuffer
|
|
*
|
|
* Makes a writable buffer from the given buffer. If the source buffer is
|
|
* already writable, this will simply return the same buffer. A copy will
|
|
* otherwise be made using gst_buffer_copy().
|
|
*
|
|
* Returns: (transfer full): a writable buffer which may or may not be the
|
|
* same as @buf
|
|
*/
|
|
#define gst_buffer_make_writable(buf) GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (buf)))
|
|
|
|
/**
|
|
* gst_buffer_replace:
|
|
* @obuf: (inout) (transfer full): pointer to a pointer to a #GstBuffer to be
|
|
* replaced.
|
|
* @nbuf: (transfer none) (allow-none): pointer to a #GstBuffer that will
|
|
* replace the buffer pointed to by @obuf.
|
|
*
|
|
* Modifies a pointer to a #GstBuffer to point to a different #GstBuffer. The
|
|
* modification is done atomically (so this is useful for ensuring thread safety
|
|
* in some cases), and the reference counts are updated appropriately (the old
|
|
* buffer is unreffed, the new is reffed).
|
|
*
|
|
* Either @nbuf or the #GstBuffer pointed to by @obuf may be NULL.
|
|
*/
|
|
#define gst_buffer_replace(obuf,nbuf) \
|
|
G_STMT_START { \
|
|
GstBuffer **___obufaddr = (GstBuffer **)(obuf); \
|
|
gst_mini_object_replace ((GstMiniObject **)___obufaddr, \
|
|
GST_MINI_OBJECT_CAST (nbuf)); \
|
|
} G_STMT_END
|
|
|
|
/* creating a region */
|
|
GstBuffer* gst_buffer_copy_region (GstBuffer *parent, GstBufferCopyFlags flags,
|
|
gsize offset, gsize size);
|
|
|
|
/* span, two buffers, intelligently */
|
|
gboolean gst_buffer_is_span_fast (GstBuffer *buf1, GstBuffer *buf2);
|
|
GstBuffer* gst_buffer_span (GstBuffer *buf1, gsize offset, GstBuffer *buf2, gsize size);
|
|
|
|
/* metadata */
|
|
#include <gst/gstmeta.h>
|
|
|
|
GstMeta * gst_buffer_get_meta (GstBuffer *buffer, const GstMetaInfo *info);
|
|
GstMeta * gst_buffer_add_meta (GstBuffer *buffer, const GstMetaInfo *info,
|
|
gpointer params);
|
|
gboolean gst_buffer_remove_meta (GstBuffer *buffer, GstMeta *meta);
|
|
|
|
GstMeta * gst_buffer_iterate_meta (GstBuffer *buffer, gpointer *state);
|
|
|
|
/**
|
|
* gst_value_set_buffer:
|
|
* @v: a #GValue to receive the data
|
|
* @b: (transfer none): a #GstBuffer to assign to the GstValue
|
|
*
|
|
* Sets @b as the value of @v. Caller retains reference to buffer.
|
|
*/
|
|
#define gst_value_set_buffer(v,b) g_value_set_boxed((v),(b))
|
|
/**
|
|
* gst_value_take_buffer:
|
|
* @v: a #GValue to receive the data
|
|
* @b: (transfer full): a #GstBuffer to assign to the GstValue
|
|
*
|
|
* Sets @b as the value of @v. Caller gives away reference to buffer.
|
|
*/
|
|
#define gst_value_take_buffer(v,b) g_value_take_boxed(v,(b))
|
|
/**
|
|
* gst_value_get_buffer:
|
|
* @v: a #GValue to query
|
|
*
|
|
* Receives a #GstBuffer as the value of @v. Does not return a reference to
|
|
* the buffer, so the pointer is only valid for as long as the caller owns
|
|
* a reference to @v.
|
|
*
|
|
* Returns: (transfer none): buffer
|
|
*/
|
|
#define gst_value_get_buffer(v) GST_BUFFER_CAST (g_value_get_boxed(v))
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __GST_BUFFER_H__ */
|