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., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22 /**
  23  * SECTION:gstmeta
  24  * @short_description: Buffer metadata
  25  *
  26  * Last reviewed on December 17th, 2009 (0.10.26)
  27  */
  28 #include "gst_private.h"
  29
  30 #include "gstbuffer.h"
  31 #include "gstmeta.h"
  32 #include "gstinfo.h"
  33 #include "gstutils.h"
  34
  35 static GHashTable *metainfo = NULL;
  36 static GRWLock lock;
  37
  38 GQuark _gst_meta_transform_copy;
  39
  40 void
  41 _priv_gst_meta_initialize (void)
  42 {
  43   g_rw_lock_init (&lock);
  44   metainfo = g_hash_table_new (g_str_hash, g_str_equal);
  45
  46   _gst_meta_transform_copy = g_quark_from_static_string ("copy");
  47 }
  48
  49 /**
  50  * gst_meta_api_type_register:
  51  * @api: an API to register
  52  * @tags: tags for @api
  53  *
  54  * Register and return a GType for the @api and associate it with
  55  * @tags.
  56  *
  57  * Returns: a unique GType for @api.
  58  */
  59 GType
  60 gst_meta_api_type_register (const gchar * api, const gchar ** tags)
  61 {
  62   GType type;
  63
  64   g_return_val_if_fail (api != NULL, 0);
  65   g_return_val_if_fail (tags != NULL, 0);
  66
  67   type = g_pointer_type_register_static (api);
  68
  69   if (type != 0) {
  70     gint i;
  71
  72     for (i = 0; tags[i]; i++)
  73       g_type_set_qdata (type, g_quark_from_string (tags[i]),
  74           GINT_TO_POINTER (TRUE));
  75   }
  76   return type;
  77 }
  78
  79 /**
  80  * gst_meta_api_type_has_tag:
  81  * @api: an API
  82  * @tag: the tag to check
  83  *
  84  * Check if @api was registered with @tag.
  85  *
  86  * Returns: %TRUE if @api was registered with @tag.
  87  */
  88 gboolean
  89 gst_meta_api_type_has_tag (GType api, GQuark tag)
  90 {
  91   g_return_val_if_fail (api != 0, FALSE);
  92   g_return_val_if_fail (tag != 0, FALSE);
  93
  94   return g_type_get_qdata (api, tag) != NULL;
  95 }
  96
  97 /**
  98  * gst_meta_register:
  99  * @api: the type of the #GstMeta API
 100  * @impl: the name of the #GstMeta implementation
 101  * @size: the size of the #GstMeta structure
 102  * @init_func: a #GstMetaInitFunction
 103  * @free_func: a #GstMetaFreeFunction
 104  * @transform_func: a #GstMetaTransformFunction
 105  * @tags: a NULL terminated array of strings describing what the metadata
 106  *        contains info about.
 107  *
 108  * Register a new #GstMeta implementation.
 109  *
 110  * The same @info can be retrieved later with gst_meta_get_info() by using
 111  * @impl as the key.
 112  *
 113  * Returns: (transfer none): a #GstMetaInfo that can be used to access metadata.
 114  */
 115
 116 const GstMetaInfo *
 117 gst_meta_register (GType api, const gchar * impl, gsize size,
 118     GstMetaInitFunction init_func, GstMetaFreeFunction free_func,
 119     GstMetaTransformFunction transform_func)
 120 {
 121   GstMetaInfo *info;
 122
 123   g_return_val_if_fail (api != 0, NULL);
 124   g_return_val_if_fail (impl != NULL, NULL);
 125   g_return_val_if_fail (size != 0, NULL);
 126
 127   info = g_slice_new (GstMetaInfo);
 128   info->api = api;
 129   info->type = g_pointer_type_register_static (impl);
 130   info->size = size;
 131   info->init_func = init_func;
 132   info->free_func = free_func;
 133   info->transform_func = transform_func;
 134
 135   GST_DEBUG ("register \"%s\" implementing \"%s\" of size %" G_GSIZE_FORMAT,
 136       api, impl, size);
 137
 138   g_rw_lock_writer_lock (&lock);
 139   g_hash_table_insert (metainfo, (gpointer) impl, (gpointer) info);
 140   g_rw_lock_writer_unlock (&lock);
 141
 142   return info;
 143 }
 144
 145 /**
 146  * gst_meta_get_info:
 147  * @impl: the name
 148  *
 149  * Lookup a previously registered meta info structure by its implementation name
 150  * @impl.
 151  *
 152  * Returns: (transfer none): a #GstMetaInfo with @impl, or #NULL when no such
 153  * metainfo exists.
 154  */
 155 const GstMetaInfo *
 156 gst_meta_get_info (const gchar * impl)
 157 {
 158   GstMetaInfo *info;
 159
 160   g_return_val_if_fail (impl != NULL, NULL);
 161
 162   g_rw_lock_reader_lock (&lock);
 163   info = g_hash_table_lookup (metainfo, impl);
 164   g_rw_lock_reader_unlock (&lock);
 165
 166   return info;
 167 }