gstfunnel: avoid access of freed pad
[platform/upstream/gstreamer.git] / gst / gstmeta.h
index 7f786b6..e6d4f00 100644 (file)
@@ -34,8 +34,8 @@ typedef struct _GstMetaInfo GstMetaInfo;
  * GstMetaFlags:
  * @GST_META_FLAG_NONE: no flags
  * @GST_META_FLAG_READONLY: metadata should not be modified
- * @GST_META_FLAG_POOLED: metadata is managed by a bufferpool and should not
- *    be removed
+ * @GST_META_FLAG_POOLED: metadata is managed by a bufferpool
+ * @GST_META_FLAG_LOCKED: metadata should not be removed
  * @GST_META_FLAG_LAST: additional flags can be added starting from this flag.
  *
  * Extra metadata flags.
@@ -44,6 +44,7 @@ typedef enum {
   GST_META_FLAG_NONE        = 0,
   GST_META_FLAG_READONLY    = (1 << 0),
   GST_META_FLAG_POOLED      = (1 << 1),
+  GST_META_FLAG_LOCKED      = (1 << 2),
 
   GST_META_FLAG_LAST        = (1 << 16)
 } GstMetaFlags;
@@ -52,13 +53,13 @@ typedef enum {
  * GST_META_FLAGS:
  * @meta: a #GstMeta.
  *
- * A flags word containing #GstMetaFlag flags set on @meta
+ * A flags word containing #GstMetaFlags flags set on @meta
  */
 #define GST_META_FLAGS(meta)  (GST_META_CAST (meta)->flags)
 /**
  * GST_META_FLAG_IS_SET:
  * @meta: a #GstMeta.
- * @flag: the #GstMetaFlag to check.
+ * @flag: the #GstMetaFlags to check.
  *
  * Gives the status of a specific flag on a metadata.
  */
@@ -66,7 +67,7 @@ typedef enum {
 /**
  * GST_META_FLAG_SET:
  * @meta: a #GstMeta.
- * @flag: the #GstMetaFlag to set.
+ * @flag: the #GstMetaFlags to set.
  *
  * Sets a metadata flag on a metadata.
  */
@@ -74,7 +75,7 @@ typedef enum {
 /**
  * GST_META_FLAG_UNSET:
  * @meta: a #GstMeta.
- * @flag: the #GstMetaFlag to clear.
+ * @flag: the #GstMetaFlags to clear.
  *
  * Clears a metadata flag.
  */
@@ -94,13 +95,6 @@ struct _GstMeta {
 };
 
 /**
- * GST_META_TRACE_NAME:
- *
- * The name used for tracing memory allocations.
- */
-#define GST_META_TRACE_NAME           "GstMeta"
-
-/**
  * GstMetaInitFunction:
  * @meta: a #GstMeta
  * @params: parameters passed to the init function
@@ -120,34 +114,55 @@ typedef gboolean (*GstMetaInitFunction) (GstMeta *meta, gpointer params, GstBuff
 typedef void (*GstMetaFreeFunction)     (GstMeta *meta, GstBuffer *buffer);
 
 /**
- * GstMetaCopyFunction:
- * @dest: a destination #GstBuffer
- * @meta: a #GstMeta
- * @buffer: a #GstBuffer
- * @offset: an offset
- * @size: a size
+ * gst_meta_transform_copy:
+ *
+ * GQuark for the "gst-copy" transform.
+ */
+GST_EXPORT GQuark _gst_meta_transform_copy;
+
+/**
+ * GST_META_TRANSFORM_IS_COPY:
+ * @type: a transform type
+ *
+ * Check if the transform type is a copy transform
+ */
+#define GST_META_TRANSFORM_IS_COPY(type) ((type) == _gst_meta_transform_copy)
+
+/**
+ * GstMetaTransformCopy:
+ * @region: %TRUE if only region is copied
+ * @offset: the offset to copy, 0 if @region is %FALSE, otherwise > 0
+ * @size: the size to copy, -1 or the buffer size when @region is %FALSE
  *
- * Function called when the region at @offset and @size in @buffer is copied
- * into @dest. The function should update the metadata on @dest using @meta.
+ * Extra data passed to a "gst-copy" transform #GstMetaTransformFunction.
  */
-typedef void (*GstMetaCopyFunction)     (GstBuffer *dest, GstMeta *meta,
-                                         GstBuffer *buffer, gsize offset, gsize size);
+typedef struct {
+  gboolean region;
+  gsize offset;
+  gsize size;
+} GstMetaTransformCopy;
+
 /**
  * GstMetaTransformFunction:
  * @transbuf: a #GstBuffer
  * @meta: a #GstMeta
  * @buffer: a #GstBuffer
+ * @type: the transform type
  * @data: transform specific data.
  *
  * Function called for each @meta in @buffer as a result of performing a
- * transformation on @transbuf. Additional type specific transform data
- * is passed to the function.
+ * transformation on @transbuf. Additional @type specific transform data
+ * is passed to the function as @data.
+ *
+ * Implementations should check the @type of the transform and parse
+ * additional type specific fields in @data that should be used to update
+ * the metadata on @transbuf.
  *
- * Implementations should check the type of the transform @data and parse
- * additional type specific field that should be used to perform the transform.
+ * Returns: %TRUE if the transform could be performed
  */
-typedef void (*GstMetaTransformFunction) (GstBuffer *transbuf, GstMeta *meta,
-                                          GstBuffer *buffer, gpointer data);
+typedef gboolean (*GstMetaTransformFunction) (GstBuffer *transbuf,
+                                              GstMeta *meta, GstBuffer *buffer,
+                                              GQuark type, gpointer data);
 
 /**
  * GstMetaInfo:
@@ -156,33 +171,45 @@ typedef void (*GstMetaTransformFunction) (GstBuffer *transbuf, GstMeta *meta,
  * @size: size of the metadata
  * @init_func: function for initializing the metadata
  * @free_func: function for freeing the metadata
- * @copy_func: function for copying the metadata
  * @transform_func: function for transforming the metadata
  *
  * The #GstMetaInfo provides information about a specific metadata
  * structure.
  */
 struct _GstMetaInfo {
-  GQuark                     api;
+  GType                      api;
   GType                      type;
   gsize                      size;
 
   GstMetaInitFunction        init_func;
   GstMetaFreeFunction        free_func;
-  GstMetaCopyFunction        copy_func;
   GstMetaTransformFunction   transform_func;
 
   /*< private >*/
   gpointer _gst_reserved[GST_PADDING];
 };
 
-const GstMetaInfo *  gst_meta_register        (const gchar *api, const gchar *impl,
-                                               gsize size,
-                                               GstMetaInitFunction        init_func,
-                                               GstMetaFreeFunction        free_func,
-                                               GstMetaCopyFunction        copy_func,
-                                               GstMetaTransformFunction   transform_func);
-const GstMetaInfo *  gst_meta_get_info        (const gchar * impl);
+GType                gst_meta_api_type_register (const gchar *api,
+                                                 const gchar **tags);
+gboolean             gst_meta_api_type_has_tag  (GType api, GQuark tag);
+
+const GstMetaInfo *  gst_meta_register          (GType api, const gchar *impl,
+                                                 gsize size,
+                                                 GstMetaInitFunction      init_func,
+                                                 GstMetaFreeFunction      free_func,
+                                                 GstMetaTransformFunction transform_func);
+const GstMetaInfo *  gst_meta_get_info          (const gchar * impl);
+
+/* some default tags */
+GST_EXPORT GQuark _gst_meta_tag_memory;
+
+/**
+ * GST_META_TAG_MEMORY:
+ *
+ * Metadata tagged with this tag depends on the particular memory
+ * or buffer that it is on.
+ */
+#define GST_META_TAG_MEMORY (_gst_meta_tag_memory)
 
 G_END_DECLS