gst/gstmeta.c

   1 /* GStreamer
   2  * Copyright (C) 2011 Wim Taymans <wim.taymans@gmail.com>
   3  *
   4  * gstmeta.c: metadata operations
   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  * SECTION:gstmeta
  24  * @short_description: Buffer metadata
  25  *
  26  * The #GstMeta structure should be included as the first member of a #GstBuffer
  27  * metadata structure. The structure defines the API of the metadata and should
  28  * be accessible to all elements using the metadata.
  29  *
  30  * A metadata API is registered with gst_meta_api_type_register() which takes a
  31  * name for the metadata API and some tags associated with the metadata.
  32  * With gst_meta_api_type_has_tag() one can check if a certain metadata API
  33  * contains a given tag.
  34  *
  35  * Multiple implementations of a metadata API can be registered.
  36  * To implement a metadata API, gst_meta_register() should be used. This
  37  * function takes all parameters needed to create, free and transform metadata
  38  * along with the size of the metadata. The function returns a #GstMetaInfo
  39  * structure that contains the information for the implementation of the API.
  40  *
  41  * A specific implementation can be retrieved by name with gst_meta_get_info().
  42  *
  43  * See #GstBuffer for how the metadata can be added, retrieved and removed from
  44  * buffers.
  45  *
  46  * Last reviewed on 2012-03-28 (0.11.3)
  47  */
  48 #include "gst_private.h"
  49
  50 #include "gstbuffer.h"
  51 #include "gstmeta.h"
  52 #include "gstinfo.h"
  53 #include "gstutils.h"
  54
  55 static GHashTable *metainfo = NULL;
  56 static GRWLock lock;
  57
  58 GQuark _gst_meta_transform_copy;
  59 GQuark _gst_meta_tag_memory;
  60
  61 void
  62 _priv_gst_meta_initialize (void)
  63 {
  64   g_rw_lock_init (&lock);
  65   metainfo = g_hash_table_new (g_str_hash, g_str_equal);
  66
  67   _gst_meta_transform_copy = g_quark_from_static_string ("gst-copy");
  68   _gst_meta_tag_memory = g_quark_from_static_string ("memory");
  69 }
  70
  71 /**
  72  * gst_meta_api_type_register:
  73  * @api: an API to register
  74  * @tags: tags for @api
  75  *
  76  * Register and return a GType for the @api and associate it with
  77  * @tags.
  78  *
  79  * Returns: a unique GType for @api.
  80  */
  81 GType
  82 gst_meta_api_type_register (const gchar * api, const gchar ** tags)
  83 {
  84   GType type;
  85
  86   g_return_val_if_fail (api != NULL, 0);
  87   g_return_val_if_fail (tags != NULL, 0);
  88
  89   GST_CAT_DEBUG (GST_CAT_META, "register API \"%s\"", api);
  90   type = g_pointer_type_register_static (api);
  91
  92   if (type != 0) {
  93     gint i;
  94
  95     for (i = 0; tags[i]; i++) {
  96       GST_CAT_DEBUG (GST_CAT_META, "  adding tag \"%s\"", tags[i]);
  97       g_type_set_qdata (type, g_quark_from_string (tags[i]),
  98           GINT_TO_POINTER (TRUE));
  99     }
 100   }
 101
 102   g_type_set_qdata (type, g_quark_from_string ("tags"),
 103       g_strdupv ((gchar **) tags));
 104
 105   return type;
 106 }
 107
 108 /**
 109  * gst_meta_api_type_has_tag:
 110  * @api: an API
 111  * @tag: the tag to check
 112  *
 113  * Check if @api was registered with @tag.
 114  *
 115  * Returns: %TRUE if @api was registered with @tag.
 116  */
 117 gboolean
 118 gst_meta_api_type_has_tag (GType api, GQuark tag)
 119 {
 120   g_return_val_if_fail (api != 0, FALSE);
 121   g_return_val_if_fail (tag != 0, FALSE);
 122
 123   return g_type_get_qdata (api, tag) != NULL;
 124 }
 125
 126 /**
 127  * gst_meta_api_type_get_tags:
 128  * @api: an API
 129  *
 130  * Returns: (transfer none) (array zero-terminated=1) (element-type utf8): an array of tags as strings.
 131  *
 132  * Since: 1.2
 133  */
 134 const gchar *const *
 135 gst_meta_api_type_get_tags (GType api)
 136 {
 137   const gchar **tags;
 138   g_return_val_if_fail (api != 0, FALSE);
 139
 140   tags = g_type_get_qdata (api, g_quark_from_string ("tags"));
 141
 142   return (const gchar * const *) tags;
 143 }
 144
 145 /**
 146  * gst_meta_register:
 147  * @api: the type of the #GstMeta API
 148  * @impl: the name of the #GstMeta implementation
 149  * @size: the size of the #GstMeta structure
 150  * @init_func: (scope async) a #GstMetaInitFunction
 151  * @free_func: (scope async) a #GstMetaFreeFunction
 152  * @transform_func: (scope async) a #GstMetaTransformFunction
 153  *
 154  * Register a new #GstMeta implementation.
 155  *
 156  * The same @info can be retrieved later with gst_meta_get_info() by using
 157  * @impl as the key.
 158  *
 159  * Returns: (transfer none): a #GstMetaInfo that can be used to access metadata.
 160  */
 161
 162 const GstMetaInfo *
 163 gst_meta_register (GType api, const gchar * impl, gsize size,
 164     GstMetaInitFunction init_func, GstMetaFreeFunction free_func,
 165     GstMetaTransformFunction transform_func)
 166 {
 167   GstMetaInfo *info;
 168   GType type;
 169
 170   g_return_val_if_fail (api != 0, NULL);
 171   g_return_val_if_fail (impl != NULL, NULL);
 172   g_return_val_if_fail (size != 0, NULL);
 173
 174   /* first try to register the implementation name. It's possible
 175    * that this fails because it was already registered. Don't warn,
 176    * glib did this for us already. */
 177   type = g_pointer_type_register_static (impl);
 178   if (type == 0)
 179     return NULL;
 180
 181   info = g_slice_new (GstMetaInfo);
 182   info->api = api;
 183   info->type = type;
 184   info->size = size;
 185   info->init_func = init_func;
 186   info->free_func = free_func;
 187   info->transform_func = transform_func;
 188
 189   GST_CAT_DEBUG (GST_CAT_META,
 190       "register \"%s\" implementing \"%s\" of size %" G_GSIZE_FORMAT, impl,
 191       g_type_name (api), size);
 192
 193   g_rw_lock_writer_lock (&lock);
 194   g_hash_table_insert (metainfo, (gpointer) impl, (gpointer) info);
 195   g_rw_lock_writer_unlock (&lock);
 196
 197   return info;
 198 }
 199
 200 /**
 201  * gst_meta_get_info:
 202  * @impl: the name
 203  *
 204  * Lookup a previously registered meta info structure by its implementation name
 205  * @impl.
 206  *
 207  * Returns: (transfer none): a #GstMetaInfo with @impl, or #NULL when no such
 208  * metainfo exists.
 209  */
 210 const GstMetaInfo *
 211 gst_meta_get_info (const gchar * impl)
 212 {
 213   GstMetaInfo *info;
 214
 215   g_return_val_if_fail (impl != NULL, NULL);
 216
 217   g_rw_lock_reader_lock (&lock);
 218   info = g_hash_table_lookup (metainfo, impl);
 219   g_rw_lock_reader_unlock (&lock);
 220
 221   return info;
 222 }