utils: Add a function to get a string representation of GstStateChange
[platform/upstream/gstreamer.git] / gst / gstmeta.h
index 08411e3..03fca63 100644 (file)
@@ -23,6 +23,8 @@
 #ifndef __GST_META_H__
 #define __GST_META_H__
 
+#include <glib.h>
+
 G_BEGIN_DECLS
 
 typedef struct _GstMeta GstMeta;
@@ -82,6 +84,15 @@ typedef enum {
 #define GST_META_FLAG_UNSET(meta,flag)         (GST_META_FLAGS (meta) &= ~(flag))
 
 /**
+ * GST_META_TAG_MEMORY_STR:
+ *
+ * This metadata stays relevant as long as memory layout is unchanged.
+ *
+ * Since: 1.2
+ */
+#define GST_META_TAG_MEMORY_STR "memory"
+
+/**
  * GstMeta:
  * @flags: extra flags for the metadata
  * @info: pointer to the #GstMetaInfo
@@ -94,6 +105,8 @@ struct _GstMeta {
   const GstMetaInfo *info;
 };
 
+#include <gst/gstbuffer.h>
+
 /**
  * GstMetaInitFunction:
  * @meta: a #GstMeta
@@ -118,6 +131,7 @@ typedef void (*GstMetaFreeFunction)     (GstMeta *meta, GstBuffer *buffer);
  *
  * GQuark for the "gst-copy" transform.
  */
+
 GST_EXPORT GQuark _gst_meta_transform_copy;
 
 /**
@@ -166,8 +180,8 @@ typedef gboolean (*GstMetaTransformFunction) (GstBuffer *transbuf,
 
 /**
  * GstMetaInfo:
- * @api: tag indentifying the metadata structure and api
- * @type: type indentifying the implementor of the api
+ * @api: tag identifying the metadata structure and api
+ * @type: type identifying the implementor of the api
  * @size: size of the metadata
  * @init_func: function for initializing the metadata
  * @free_func: function for freeing the metadata
@@ -185,22 +199,31 @@ struct _GstMetaInfo {
   GstMetaFreeFunction        free_func;
   GstMetaTransformFunction   transform_func;
 
-  /*< private >*/
-  gpointer _gst_reserved[GST_PADDING];
+  /* No padding needed, GstMetaInfo is always allocated by GStreamer and is
+   * not subclassable or stack-allocatable, so we can extend it as we please
+   * just like interfaces */
 };
 
+GST_EXPORT
 GType                gst_meta_api_type_register (const gchar *api,
                                                  const gchar **tags);
+GST_EXPORT
 gboolean             gst_meta_api_type_has_tag  (GType api, GQuark tag);
 
+GST_EXPORT
 const GstMetaInfo *  gst_meta_register          (GType api, const gchar *impl,
                                                  gsize size,
                                                  GstMetaInitFunction      init_func,
                                                  GstMetaFreeFunction      free_func,
                                                  GstMetaTransformFunction transform_func);
+GST_EXPORT
 const GstMetaInfo *  gst_meta_get_info          (const gchar * impl);
 
+GST_EXPORT
+const gchar* const*  gst_meta_api_type_get_tags (GType api);
+
 /* some default tags */
+
 GST_EXPORT GQuark _gst_meta_tag_memory;
 
 /**
@@ -208,8 +231,13 @@ GST_EXPORT GQuark _gst_meta_tag_memory;
  *
  * Metadata tagged with this tag depends on the particular memory
  * or buffer that it is on.
+ *
+ * Deprecated: The GQuarks are not exported by any public API, use
+ *   GST_META_TAG_MEMORY_STR instead.
  */
+#ifndef GST_DISABLE_DEPRECATED
 #define GST_META_TAG_MEMORY (_gst_meta_tag_memory)
+#endif
 
 G_END_DECLS