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 #include "gst_private.h"
  47
  48 #include "gstbuffer.h"
  49 #include "gstmeta.h"
  50 #include "gstinfo.h"
  51 #include "gstutils.h"
  52
  53 static GHashTable *metainfo = NULL;
  54 static GRWLock lock;
  55
  56 GQuark _gst_meta_transform_copy;
  57 GQuark _gst_meta_tag_memory;
  58
  59 void
  60 _priv_gst_meta_initialize (void)
  61 {
  62   g_rw_lock_init (&lock);
  63   metainfo = g_hash_table_new (g_str_hash, g_str_equal);
  64
  65   _gst_meta_transform_copy = g_quark_from_static_string ("gst-copy");
  66   _gst_meta_tag_memory = g_quark_from_static_string ("memory");
  67 }
  68
  69 /**
  70  * gst_meta_api_type_register:
  71  * @api: an API to register
  72  * @tags: tags for @api
  73  *
  74  * Register and return a GType for the @api and associate it with
  75  * @tags.
  76  *
  77  * Returns: a unique GType for @api.
  78  */
  79 GType
  80 gst_meta_api_type_register (const gchar * api, const gchar ** tags)
  81 {
  82   GType type;
  83
  84   g_return_val_if_fail (api != NULL, 0);
  85   g_return_val_if_fail (tags != NULL, 0);
  86
  87   GST_CAT_DEBUG (GST_CAT_META, "register API \"%s\"", api);
  88   type = g_pointer_type_register_static (api);
  89
  90   if (type != 0) {
  91     gint i;
  92
  93     for (i = 0; tags[i]; i++) {
  94       GST_CAT_DEBUG (GST_CAT_META, "  adding tag \"%s\"", tags[i]);
  95       g_type_set_qdata (type, g_quark_from_string (tags[i]),
  96           GINT_TO_POINTER (TRUE));
  97     }
  98   }
  99
 100   g_type_set_qdata (type, g_quark_from_string ("tags"),
 101       g_strdupv ((gchar **) tags));
 102
 103   return type;
 104 }
 105
 106 /**
 107  * gst_meta_api_type_has_tag:
 108  * @api: an API
 109  * @tag: the tag to check
 110  *
 111  * Check if @api was registered with @tag.
 112  *
 113  * Returns: %TRUE if @api was registered with @tag.
 114  */
 115 gboolean
 116 gst_meta_api_type_has_tag (GType api, GQuark tag)
 117 {
 118   g_return_val_if_fail (api != 0, FALSE);
 119   g_return_val_if_fail (tag != 0, FALSE);
 120
 121   return g_type_get_qdata (api, tag) != NULL;
 122 }
 123
 124 /**
 125  * gst_meta_api_type_get_tags:
 126  * @api: an API
 127  *
 128  * Returns: (transfer none) (array zero-terminated=1) (element-type utf8): an array of tags as strings.
 129  *
 130  * Since: 1.2
 131  */
 132 const gchar *const *
 133 gst_meta_api_type_get_tags (GType api)
 134 {
 135   const gchar **tags;
 136   g_return_val_if_fail (api != 0, FALSE);
 137
 138   tags = g_type_get_qdata (api, g_quark_from_string ("tags"));
 139
 140   if (!tags[0])
 141     return NULL;
 142
 143   return (const gchar * const *) tags;
 144 }
 145
 146 /**
 147  * gst_meta_register:
 148  * @api: the type of the #GstMeta API
 149  * @impl: the name of the #GstMeta implementation
 150  * @size: the size of the #GstMeta structure
 151  * @init_func: (scope async): a #GstMetaInitFunction
 152  * @free_func: (scope async): a #GstMetaFreeFunction
 153  * @transform_func: (scope async): a #GstMetaTransformFunction
 154  *
 155  * Register a new #GstMeta implementation.
 156  *
 157  * The same @info can be retrieved later with gst_meta_get_info() by using
 158  * @impl as the key.
 159  *
 160  * Returns: (transfer none): a #GstMetaInfo that can be used to access metadata.
 161  */
 162
 163 const GstMetaInfo *
 164 gst_meta_register (GType api, const gchar * impl, gsize size,
 165     GstMetaInitFunction init_func, GstMetaFreeFunction free_func,
 166     GstMetaTransformFunction transform_func)
 167 {
 168   GstMetaInfo *info;
 169   GType type;
 170
 171   g_return_val_if_fail (api != 0, NULL);
 172   g_return_val_if_fail (impl != NULL, NULL);
 173   g_return_val_if_fail (size != 0, NULL);
 174
 175   if (init_func == NULL)
 176     g_critical ("Registering meta implementation '%s' without init function",
 177         impl);
 178
 179   /* first try to register the implementation name. It's possible
 180    * that this fails because it was already registered. Don't warn,
 181    * glib did this for us already. */
 182   type = g_pointer_type_register_static (impl);
 183   if (type == 0)
 184     return NULL;
 185
 186   info = g_slice_new (GstMetaInfo);
 187   info->api = api;
 188   info->type = type;
 189   info->size = size;
 190   info->init_func = init_func;
 191   info->free_func = free_func;
 192   info->transform_func = transform_func;
 193
 194   GST_CAT_DEBUG (GST_CAT_META,
 195       "register \"%s\" implementing \"%s\" of size %" G_GSIZE_FORMAT, impl,
 196       g_type_name (api), size);
 197
 198   g_rw_lock_writer_lock (&lock);
 199   g_hash_table_insert (metainfo, (gpointer) impl, (gpointer) info);
 200   g_rw_lock_writer_unlock (&lock);
 201
 202   return info;
 203 }
 204
 205 /**
 206  * gst_meta_get_info:
 207  * @impl: the name
 208  *
 209  * Lookup a previously registered meta info structure by its implementation name
 210  * @impl.
 211  *
 212  * Returns: (transfer none) (nullable): a #GstMetaInfo with @impl, or
 213  * %NULL when no such metainfo exists.
 214  */
 215 const GstMetaInfo *
 216 gst_meta_get_info (const gchar * impl)
 217 {
 218   GstMetaInfo *info;
 219
 220   g_return_val_if_fail (impl != NULL, NULL);
 221
 222   g_rw_lock_reader_lock (&lock);
 223   info = g_hash_table_lookup (metainfo, impl);
 224   g_rw_lock_reader_unlock (&lock);
 225
 226   return info;
 227 }