Merge remote-tracking branch 'origin/master' into 0.11
[platform/upstream/gstreamer.git] / 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_register:
51  * @api: the name of the #GstMeta API
52  * @impl: the name of the #GstMeta implementation
53  * @size: the size of the #GstMeta structure
54  * @init_func: a #GstMetaInitFunction
55  * @free_func: a #GstMetaFreeFunction
56  * @transform_func: a #GstMetaTransformFunction
57  *
58  * Register a new #GstMeta implementation.
59  *
60  * The same @info can be retrieved later with gst_meta_get_info() by using
61  * @impl as the key.
62  *
63  * Returns: (transfer none): a #GstMetaInfo that can be used to access metadata.
64  */
65
66 const GstMetaInfo *
67 gst_meta_register (const gchar * api, const gchar * impl, gsize size,
68     GstMetaInitFunction init_func, GstMetaFreeFunction free_func,
69     GstMetaTransformFunction transform_func)
70 {
71   GstMetaInfo *info;
72
73   g_return_val_if_fail (api != NULL, NULL);
74   g_return_val_if_fail (impl != NULL, NULL);
75   g_return_val_if_fail (size != 0, NULL);
76
77   info = g_slice_new (GstMetaInfo);
78   info->api = g_quark_from_string (api);
79   info->type = g_pointer_type_register_static (impl);
80   info->size = size;
81   info->init_func = init_func;
82   info->free_func = free_func;
83   info->transform_func = transform_func;
84
85   GST_DEBUG ("register \"%s\" implementing \"%s\" of size %" G_GSIZE_FORMAT,
86       api, impl, size);
87
88   g_rw_lock_writer_lock (&lock);
89   g_hash_table_insert (metainfo, (gpointer) impl, (gpointer) info);
90   g_rw_lock_writer_unlock (&lock);
91
92   return info;
93 }
94
95 /**
96  * gst_meta_get_info:
97  * @impl: the name
98  *
99  * Lookup a previously registered meta info structure by its implementation name
100  * @impl.
101  *
102  * Returns: (transfer none): a #GstMetaInfo with @impl, or #NULL when no such
103  * metainfo exists.
104  */
105 const GstMetaInfo *
106 gst_meta_get_info (const gchar * impl)
107 {
108   GstMetaInfo *info;
109
110   g_return_val_if_fail (impl != NULL, NULL);
111
112   g_rw_lock_reader_lock (&lock);
113   info = g_hash_table_lookup (metainfo, impl);
114   g_rw_lock_reader_unlock (&lock);
115
116   return info;
117 }