gst/gstmeta.h

   1 /* GStreamer
   2  * Copyright (C) 2009 Wim Taymans <wim.taymans@gmail.be>
   3  *
   4  * gstmeta.h: Header for Metadata structures
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  19  * Boston, MA 02110-1301, USA.
  20  */
  21
  22
  23 #ifndef __GST_META_H__
  24 #define __GST_META_H__
  25
  26 G_BEGIN_DECLS
  27
  28 typedef struct _GstMeta GstMeta;
  29 typedef struct _GstMetaInfo GstMetaInfo;
  30
  31 #define GST_META_CAST(meta)   ((GstMeta *)(meta))
  32
  33 /**
  34  * GstMetaFlags:
  35  * @GST_META_FLAG_NONE: no flags
  36  * @GST_META_FLAG_READONLY: metadata should not be modified
  37  * @GST_META_FLAG_POOLED: metadata is managed by a bufferpool
  38  * @GST_META_FLAG_LOCKED: metadata should not be removed
  39  * @GST_META_FLAG_LAST: additional flags can be added starting from this flag.
  40  *
  41  * Extra metadata flags.
  42  */
  43 typedef enum {
  44   GST_META_FLAG_NONE        = 0,
  45   GST_META_FLAG_READONLY    = (1 << 0),
  46   GST_META_FLAG_POOLED      = (1 << 1),
  47   GST_META_FLAG_LOCKED      = (1 << 2),
  48
  49   GST_META_FLAG_LAST        = (1 << 16)
  50 } GstMetaFlags;
  51
  52 /**
  53  * GST_META_FLAGS:
  54  * @meta: a #GstMeta.
  55  *
  56  * A flags word containing #GstMetaFlags flags set on @meta
  57  */
  58 #define GST_META_FLAGS(meta)  (GST_META_CAST (meta)->flags)
  59 /**
  60  * GST_META_FLAG_IS_SET:
  61  * @meta: a #GstMeta.
  62  * @flag: the #GstMetaFlags to check.
  63  *
  64  * Gives the status of a specific flag on a metadata.
  65  */
  66 #define GST_META_FLAG_IS_SET(meta,flag)        !!(GST_META_FLAGS (meta) & (flag))
  67 /**
  68  * GST_META_FLAG_SET:
  69  * @meta: a #GstMeta.
  70  * @flag: the #GstMetaFlags to set.
  71  *
  72  * Sets a metadata flag on a metadata.
  73  */
  74 #define GST_META_FLAG_SET(meta,flag)           (GST_META_FLAGS (meta) |= (flag))
  75 /**
  76  * GST_META_FLAG_UNSET:
  77  * @meta: a #GstMeta.
  78  * @flag: the #GstMetaFlags to clear.
  79  *
  80  * Clears a metadata flag.
  81  */
  82 #define GST_META_FLAG_UNSET(meta,flag)         (GST_META_FLAGS (meta) &= ~(flag))
  83
  84 /**
  85  * GST_META_TAG_MEMORY_STR:
  86  * This metadata stays relevant as long as memory layout is unchanged.
  87  *
  88  * Since: 1.2
  89  */
  90 #define GST_META_TAG_MEMORY_STR "memory"
  91
  92 /**
  93  * GstMeta:
  94  * @flags: extra flags for the metadata
  95  * @info: pointer to the #GstMetaInfo
  96  *
  97  * Base structure for metadata. Custom metadata will put this structure
  98  * as the first member of their structure.
  99  */
 100 struct _GstMeta {
 101   GstMetaFlags       flags;
 102   const GstMetaInfo *info;
 103 };
 104
 105 /**
 106  * GstMetaInitFunction:
 107  * @meta: a #GstMeta
 108  * @params: parameters passed to the init function
 109  * @buffer: a #GstBuffer
 110  *
 111  * Function called when @meta is initialized in @buffer.
 112  */
 113 typedef gboolean (*GstMetaInitFunction) (GstMeta *meta, gpointer params, GstBuffer *buffer);
 114
 115 /**
 116  * GstMetaFreeFunction:
 117  * @meta: a #GstMeta
 118  * @buffer: a #GstBuffer
 119  *
 120  * Function called when @meta is freed in @buffer.
 121  */
 122 typedef void (*GstMetaFreeFunction)     (GstMeta *meta, GstBuffer *buffer);
 123
 124 /**
 125  * gst_meta_transform_copy:
 126  *
 127  * GQuark for the "gst-copy" transform.
 128  */
 129 GST_EXPORT GQuark _gst_meta_transform_copy;
 130
 131 /**
 132  * GST_META_TRANSFORM_IS_COPY:
 133  * @type: a transform type
 134  *
 135  * Check if the transform type is a copy transform
 136  */
 137 #define GST_META_TRANSFORM_IS_COPY(type) ((type) == _gst_meta_transform_copy)
 138
 139 /**
 140  * GstMetaTransformCopy:
 141  * @region: %TRUE if only region is copied
 142  * @offset: the offset to copy, 0 if @region is %FALSE, otherwise > 0
 143  * @size: the size to copy, -1 or the buffer size when @region is %FALSE
 144  *
 145  * Extra data passed to a "gst-copy" transform #GstMetaTransformFunction.
 146  */
 147 typedef struct {
 148   gboolean region;
 149   gsize offset;
 150   gsize size;
 151 } GstMetaTransformCopy;
 152
 153 /**
 154  * GstMetaTransformFunction:
 155  * @transbuf: a #GstBuffer
 156  * @meta: a #GstMeta
 157  * @buffer: a #GstBuffer
 158  * @type: the transform type
 159  * @data: transform specific data.
 160  *
 161  * Function called for each @meta in @buffer as a result of performing a
 162  * transformation on @transbuf. Additional @type specific transform data
 163  * is passed to the function as @data.
 164  *
 165  * Implementations should check the @type of the transform and parse
 166  * additional type specific fields in @data that should be used to update
 167  * the metadata on @transbuf.
 168  *
 169  * Returns: %TRUE if the transform could be performed
 170  */
 171 typedef gboolean (*GstMetaTransformFunction) (GstBuffer *transbuf,
 172                                               GstMeta *meta, GstBuffer *buffer,
 173                                               GQuark type, gpointer data);
 174
 175 /**
 176  * GstMetaInfo:
 177  * @api: tag indentifying the metadata structure and api
 178  * @type: type indentifying the implementor of the api
 179  * @size: size of the metadata
 180  * @init_func: function for initializing the metadata
 181  * @free_func: function for freeing the metadata
 182  * @transform_func: function for transforming the metadata
 183  *
 184  * The #GstMetaInfo provides information about a specific metadata
 185  * structure.
 186  */
 187 struct _GstMetaInfo {
 188   GType                      api;
 189   GType                      type;
 190   gsize                      size;
 191
 192   GstMetaInitFunction        init_func;
 193   GstMetaFreeFunction        free_func;
 194   GstMetaTransformFunction   transform_func;
 195
 196   /*< private >*/
 197   gpointer _gst_reserved[GST_PADDING];
 198 };
 199
 200 GType                gst_meta_api_type_register (const gchar *api,
 201                                                  const gchar **tags);
 202 gboolean             gst_meta_api_type_has_tag  (GType api, GQuark tag);
 203
 204 const GstMetaInfo *  gst_meta_register          (GType api, const gchar *impl,
 205                                                  gsize size,
 206                                                  GstMetaInitFunction      init_func,
 207                                                  GstMetaFreeFunction      free_func,
 208                                                  GstMetaTransformFunction transform_func);
 209 const GstMetaInfo *  gst_meta_get_info          (const gchar * impl);
 210 const gchar* const*  gst_meta_api_type_get_tags (GType api);
 211
 212 /* some default tags */
 213 GST_EXPORT GQuark _gst_meta_tag_memory;
 214
 215 /**
 216  * GST_META_TAG_MEMORY:
 217  *
 218  * Metadata tagged with this tag depends on the particular memory
 219  * or buffer that it is on.
 220  *
 221  * Deprecated: The GQuarks are not exported by any public API, use
 222  *   GST_META_TAG_MEMORY_STR instead.
 223  */
 224 #define GST_META_TAG_MEMORY (_gst_meta_tag_memory)
 225
 226 G_END_DECLS
 227
 228 #endif /* __GST_META_H__ */