#include <gst/gstminiobject.h>
#include <gst/gstclock.h>
#include <gst/gstallocator.h>
+#include <gst/gstcaps.h>
G_BEGIN_DECLS
typedef struct _GstBuffer GstBuffer;
typedef struct _GstBufferPool GstBufferPool;
+#include <gst/gstmeta.h>
+
#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))
*
* Returns the buffer decoding timestamp (dts) if valid, else the buffer
* presentation time (pts)
+ *
+ * Since: 1.8
*/
#define GST_BUFFER_DTS_OR_PTS(buf) (GST_BUFFER_DTS_IS_VALID(buf) ? GST_BUFFER_DTS(buf) : GST_BUFFER_PTS (buf))
/**
guint64 offset_end;
};
+GST_EXPORT
GType gst_buffer_get_type (void);
+GST_EXPORT
guint gst_buffer_get_max_memory (void);
/* allocation */
+
+GST_EXPORT
GstBuffer * gst_buffer_new (void);
+
+GST_EXPORT
GstBuffer * gst_buffer_new_allocate (GstAllocator * allocator, gsize size,
GstAllocationParams * params);
+GST_EXPORT
GstBuffer * gst_buffer_new_wrapped_full (GstMemoryFlags flags, gpointer data, gsize maxsize,
gsize offset, gsize size, gpointer user_data,
GDestroyNotify notify);
+GST_EXPORT
GstBuffer * gst_buffer_new_wrapped (gpointer data, gsize size);
/* memory blocks */
+
+GST_EXPORT
guint gst_buffer_n_memory (GstBuffer *buffer);
+
+GST_EXPORT
void gst_buffer_insert_memory (GstBuffer *buffer, gint idx, GstMemory *mem);
+
+GST_EXPORT
void gst_buffer_replace_memory_range (GstBuffer *buffer, guint idx, gint length, GstMemory *mem);
+
+GST_EXPORT
GstMemory * gst_buffer_peek_memory (GstBuffer *buffer, guint idx);
+
+GST_EXPORT
GstMemory * gst_buffer_get_memory_range (GstBuffer *buffer, guint idx, gint length);
+
+GST_EXPORT
void gst_buffer_remove_memory_range (GstBuffer *buffer, guint idx, gint length);
+GST_EXPORT
void gst_buffer_prepend_memory (GstBuffer *buffer, GstMemory *mem);
+
+GST_EXPORT
void gst_buffer_append_memory (GstBuffer *buffer, GstMemory *mem);
+
+GST_EXPORT
void gst_buffer_replace_memory (GstBuffer *buffer, guint idx, GstMemory *mem);
+
+GST_EXPORT
void gst_buffer_replace_all_memory (GstBuffer *buffer, GstMemory *mem);
+
+GST_EXPORT
GstMemory * gst_buffer_get_memory (GstBuffer *buffer, guint idx);
+
+GST_EXPORT
GstMemory * gst_buffer_get_all_memory (GstBuffer *buffer);
+
+GST_EXPORT
void gst_buffer_remove_memory (GstBuffer *buffer, guint idx);
+
+GST_EXPORT
void gst_buffer_remove_all_memory (GstBuffer *buffer);
+GST_EXPORT
gboolean gst_buffer_find_memory (GstBuffer *buffer, gsize offset, gsize size,
guint *idx, guint *length, gsize *skip);
-
+GST_EXPORT
gboolean gst_buffer_is_memory_range_writable (GstBuffer *buffer, guint idx, gint length);
+
+GST_EXPORT
gboolean gst_buffer_is_all_memory_writable (GstBuffer *buffer);
+GST_EXPORT
gsize gst_buffer_fill (GstBuffer *buffer, gsize offset,
gconstpointer src, gsize size);
+GST_EXPORT
gsize gst_buffer_extract (GstBuffer *buffer, gsize offset,
gpointer dest, gsize size);
+GST_EXPORT
gint gst_buffer_memcmp (GstBuffer *buffer, gsize offset,
gconstpointer mem, gsize size);
+GST_EXPORT
gsize gst_buffer_memset (GstBuffer *buffer, gsize offset,
guint8 val, gsize size);
-
+GST_EXPORT
gsize gst_buffer_get_sizes_range (GstBuffer *buffer, guint idx, gint length,
gsize *offset, gsize *maxsize);
+GST_EXPORT
gboolean gst_buffer_resize_range (GstBuffer *buffer, guint idx, gint length,
gssize offset, gssize size);
-
+GST_EXPORT
gsize gst_buffer_get_sizes (GstBuffer *buffer, gsize *offset, gsize *maxsize);
+
+GST_EXPORT
gsize gst_buffer_get_size (GstBuffer *buffer);
+
+GST_EXPORT
void gst_buffer_resize (GstBuffer *buffer, gssize offset, gssize size);
+
+GST_EXPORT
void gst_buffer_set_size (GstBuffer *buffer, gssize size);
+GST_EXPORT
gboolean gst_buffer_map_range (GstBuffer *buffer, guint idx, gint length,
GstMapInfo *info, GstMapFlags flags);
+GST_EXPORT
gboolean gst_buffer_map (GstBuffer *buffer, GstMapInfo *info, GstMapFlags flags);
+GST_EXPORT
void gst_buffer_unmap (GstBuffer *buffer, GstMapInfo *info);
+
+GST_EXPORT
void gst_buffer_extract_dup (GstBuffer *buffer, gsize offset,
gsize size, gpointer *dest,
gsize *dest_size);
+GST_EXPORT
+GstBufferFlags gst_buffer_get_flags (GstBuffer * buffer);
+
+GST_EXPORT
+gboolean gst_buffer_has_flags (GstBuffer * buffer, GstBufferFlags flags);
+
+GST_EXPORT
+gboolean gst_buffer_set_flags (GstBuffer * buffer, GstBufferFlags flags);
+
+GST_EXPORT
+gboolean gst_buffer_unset_flags (GstBuffer * buffer, GstBufferFlags flags);
+
+
/* refcounting */
/**
*
* 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)
{
* Decreases the refcount of the buffer. If the refcount reaches 0, the buffer
* with the associated metadata and memory will be freed.
*/
-#ifdef _FOOL_GTK_DOC_
-G_INLINE_FUNC void gst_buffer_unref (GstBuffer * buf);
-#endif
-
static inline void
gst_buffer_unref (GstBuffer * buf)
{
*
* 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)));
}
+GST_EXPORT
GstBuffer * gst_buffer_copy_deep (const GstBuffer * buf);
/**
} GstBufferCopyFlags;
/**
- * GST_BUFFER_COPY_METADATA:
+ * GST_BUFFER_COPY_METADATA: (value 7) (type GstBufferCopyFlags)
*
* 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_META)
+#define GST_BUFFER_COPY_METADATA ((GstBufferCopyFlags) (GST_BUFFER_COPY_FLAGS |\
+ GST_BUFFER_COPY_TIMESTAMPS | GST_BUFFER_COPY_META))
/**
- * GST_BUFFER_COPY_ALL:
+ * GST_BUFFER_COPY_ALL: (value 15) (type GstBufferCopyFlags)
*
* Combination of all possible fields that can be copied with
* gst_buffer_copy_into().
#define GST_BUFFER_COPY_ALL ((GstBufferCopyFlags)(GST_BUFFER_COPY_METADATA | GST_BUFFER_COPY_MEMORY))
/* copies memory or metadata into newly allocated buffer */
+
+GST_EXPORT
gboolean gst_buffer_copy_into (GstBuffer *dest, GstBuffer *src,
GstBufferCopyFlags flags,
gsize offset, gsize size);
*
* Returns: %TRUE when @obuf was different from @nbuf.
*/
-#ifdef _FOOL_GTK_DOC_
-G_INLINE_FUNC gboolean gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf);
-#endif
-
static inline gboolean
gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf)
{
}
/* creating a region */
+
+GST_EXPORT
GstBuffer* gst_buffer_copy_region (GstBuffer *parent, GstBufferCopyFlags flags,
gsize offset, gsize size);
/* append two buffers */
+
+GST_EXPORT
GstBuffer* gst_buffer_append_region (GstBuffer *buf1, GstBuffer *buf2,
gssize offset, gssize size);
+GST_EXPORT
GstBuffer* gst_buffer_append (GstBuffer *buf1, GstBuffer *buf2);
/* metadata */
typedef gboolean (*GstBufferForeachMetaFunc) (GstBuffer *buffer, GstMeta **meta,
gpointer user_data);
+GST_EXPORT
GstMeta * gst_buffer_get_meta (GstBuffer *buffer, GType api);
+
+GST_EXPORT
GstMeta * gst_buffer_add_meta (GstBuffer *buffer, const GstMetaInfo *info,
gpointer params);
+GST_EXPORT
gboolean gst_buffer_remove_meta (GstBuffer *buffer, GstMeta *meta);
+GST_EXPORT
GstMeta * gst_buffer_iterate_meta (GstBuffer *buffer, gpointer *state);
+GST_EXPORT
+GstMeta * gst_buffer_iterate_meta_filtered (GstBuffer * buffer,
+ gpointer * state,
+ GType meta_api_type);
+GST_EXPORT
gboolean gst_buffer_foreach_meta (GstBuffer *buffer,
GstBufferForeachMetaFunc func,
gpointer user_data);
GstBuffer *buffer;
};
+GST_EXPORT
GType gst_parent_buffer_meta_api_get_type (void);
-#define GST_TYPE_PARENT_BUFFER_META_API_TYPE (gst_parent_buffer_meta_api_get_type())
+#ifndef GST_DISABLE_DEPRECATED
+#define GST_TYPE_PARENT_BUFFER_META_API_TYPE GST_PARENT_BUFFER_META_API_TYPE
+#endif
+#define GST_PARENT_BUFFER_META_API_TYPE (gst_parent_buffer_meta_api_get_type())
/**
* gst_buffer_get_parent_buffer_meta:
#define gst_buffer_get_parent_buffer_meta(b) \
((GstParentBufferMeta*)gst_buffer_get_meta((b),GST_PARENT_BUFFER_META_API_TYPE))
+GST_EXPORT
const GstMetaInfo *gst_parent_buffer_meta_get_info (void);
#define GST_PARENT_BUFFER_META_INFO (gst_parent_buffer_meta_get_info())
/* implementation */
+
+GST_EXPORT
GstParentBufferMeta *gst_buffer_add_parent_buffer_meta (GstBuffer *buffer,
GstBuffer *ref);
+typedef struct _GstReferenceTimestampMeta GstReferenceTimestampMeta;
+
+/**
+ * GstReferenceTimestampMeta:
+ * @parent: the parent #GstMeta structure
+ * @reference: identifier for the timestamp reference.
+ * @timestamp: timestamp
+ * @duration: duration, or %GST_CLOCK_TIME_NONE
+ *
+ * #GstReferenceTimestampMeta can be used to attach alternative timestamps and
+ * possibly durations to a #GstBuffer. These are generally not according to
+ * the pipeline clock and could be e.g. the NTP timestamp when the media was
+ * captured.
+ *
+ * The reference is stored as a #GstCaps in @reference. Examples of valid
+ * references would be "timestamp/x-drivername-stream" for timestamps that are locally
+ * generated by some driver named "drivername" when generating the stream,
+ * e.g. based on a frame counter, or "timestamp/x-ntp, host=pool.ntp.org,
+ * port=123" for timestamps based on a specific NTP server.
+ *
+ * Since: 1.14
+ */
+struct _GstReferenceTimestampMeta
+{
+ GstMeta parent;
+
+ /*< public >*/
+ GstCaps *reference;
+ GstClockTime timestamp, duration;
+};
+
+GST_EXPORT
+GType gst_reference_timestamp_meta_api_get_type (void);
+#define GST_REFERENCE_TIMESTAMP_META_API_TYPE (gst_reference_timestamp_meta_api_get_type())
+
+GST_EXPORT
+const GstMetaInfo *gst_reference_timestamp_meta_get_info (void);
+#define GST_REFERENCE_TIMESTAMP_META_INFO (gst_reference_timestamp_meta_get_info())
+
+/* implementation */
+
+GST_EXPORT
+GstReferenceTimestampMeta * gst_buffer_add_reference_timestamp_meta (GstBuffer * buffer,
+ GstCaps * reference,
+ GstClockTime timestamp,
+ GstClockTime duration);
+
+GST_EXPORT
+GstReferenceTimestampMeta * gst_buffer_get_reference_timestamp_meta (GstBuffer * buffer,
+ GstCaps * reference);
+
+#ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
+G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstBuffer, gst_buffer_unref)
+#endif
+
+#ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
+G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstBufferPool, gst_object_unref)
+#endif
+
G_END_DECLS
#endif /* __GST_BUFFER_H__ */
projects / platform / upstream / gstreamer.git / blobdiff