gst/gstformat.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wim.taymans@chello.be>
   4  *                    2005 Wim Taymans <wim@fluendo.com>
   5  *
   6  * gstformat.c: GstFormat registration
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 /**
  25  * SECTION:gstformat
  26  * @short_description: Dynamically register new data formats
  27  * @see_also: #GstPad, #GstElement
  28  *
  29  * GstFormats functions are used to register a new format to the gstreamer
  30  * core.  Formats can be used to perform seeking or conversions/query
  31  * operations.
  32  */
  33
  34 #include <string.h>
  35
  36 #include "gst_private.h"
  37 #include "gstformat.h"
  38
  39 static GStaticMutex mutex = G_STATIC_MUTEX_INIT;
  40 static GList *_gst_formats = NULL;
  41 static GHashTable *_nick_to_format = NULL;
  42 static GHashTable *_format_to_nick = NULL;
  43 static guint32 _n_values = 1;   /* we start from 1 because 0 reserved for UNDEFINED */
  44
  45 static GstFormatDefinition standard_definitions[] = {
  46   {GST_FORMAT_DEFAULT, "default", "Default format for the media type", 0},
  47   {GST_FORMAT_BYTES, "bytes", "Bytes", 0},
  48   {GST_FORMAT_TIME, "time", "Time", 0},
  49   {GST_FORMAT_BUFFERS, "buffers", "Buffers", 0},
  50   {GST_FORMAT_PERCENT, "percent", "Percent", 0},
  51   {0, NULL, NULL, 0}
  52 };
  53
  54 void
  55 _gst_format_initialize (void)
  56 {
  57   GstFormatDefinition *standards = standard_definitions;
  58
  59   g_static_mutex_lock (&mutex);
  60   if (_nick_to_format == NULL) {
  61     _nick_to_format = g_hash_table_new (g_str_hash, g_str_equal);
  62     _format_to_nick = g_hash_table_new (NULL, NULL);
  63   }
  64
  65   while (standards->nick) {
  66     standards->quark = g_quark_from_static_string (standards->nick);
  67     g_hash_table_insert (_nick_to_format, standards->nick, standards);
  68     g_hash_table_insert (_format_to_nick, GINT_TO_POINTER (standards->value),
  69         standards);
  70
  71     _gst_formats = g_list_append (_gst_formats, standards);
  72     standards++;
  73     _n_values++;
  74   }
  75   g_static_mutex_unlock (&mutex);
  76 }
  77
  78 /**
  79  * gst_format_get_name:
  80  * @format: a #GstFormat
  81  *
  82  * Get a printable name for the given format. Do not modify or free.
  83  *
  84  * Returns: a reference to the static name of the format.
  85  */
  86 const gchar *
  87 gst_format_get_name (GstFormat format)
  88 {
  89   const GstFormatDefinition *def;
  90
  91   def = gst_format_get_details (format);
  92
  93   return def->nick;
  94 }
  95
  96 /**
  97  * gst_format_to_quark:
  98  * @format: a #GstFormat
  99  *
 100  * Get the unique quark for the given format.
 101  *
 102  * Returns: the quark associated with the format
 103  */
 104 GQuark
 105 gst_format_to_quark (GstFormat format)
 106 {
 107   const GstFormatDefinition *def;
 108
 109   def = gst_format_get_details (format);
 110
 111   return def->quark;
 112 }
 113
 114 /**
 115  * gst_format_register:
 116  * @nick: The nick of the new format
 117  * @description: The description of the new format
 118  *
 119  * Create a new GstFormat based on the nick or return an
 120  * already registered format with that nick.
 121  *
 122  * Returns: A new GstFormat or an already registered format
 123  * with the same nick.
 124  *
 125  * MT safe.
 126  */
 127 GstFormat
 128 gst_format_register (const gchar * nick, const gchar * description)
 129 {
 130   GstFormatDefinition *format;
 131   GstFormat query;
 132
 133   g_return_val_if_fail (nick != NULL, 0);
 134   g_return_val_if_fail (description != NULL, 0);
 135
 136   query = gst_format_get_by_nick (nick);
 137   if (query != GST_FORMAT_UNDEFINED)
 138     return query;
 139
 140   format = g_new0 (GstFormatDefinition, 1);
 141   format->value = _n_values;
 142   format->nick = g_strdup (nick);
 143   format->description = g_strdup (description);
 144   format->quark = g_quark_from_static_string (format->nick);
 145
 146   g_static_mutex_lock (&mutex);
 147   g_hash_table_insert (_nick_to_format, format->nick, format);
 148   g_hash_table_insert (_format_to_nick, GINT_TO_POINTER (format->value),
 149       format);
 150   _gst_formats = g_list_append (_gst_formats, format);
 151   _n_values++;
 152   g_static_mutex_unlock (&mutex);
 153
 154   return format->value;
 155 }
 156
 157 /**
 158  * gst_format_get_by_nick:
 159  * @nick: The nick of the format
 160  *
 161  * Return the format registered with the given nick.
 162  *
 163  * Returns: The format with @nick or GST_FORMAT_UNDEFINED
 164  * if the format was not registered.
 165  */
 166 GstFormat
 167 gst_format_get_by_nick (const gchar * nick)
 168 {
 169   GstFormatDefinition *format;
 170
 171   g_return_val_if_fail (nick != NULL, 0);
 172
 173   g_static_mutex_lock (&mutex);
 174   format = g_hash_table_lookup (_nick_to_format, nick);
 175   g_static_mutex_unlock (&mutex);
 176
 177   if (format != NULL)
 178     return format->value;
 179   else
 180     return GST_FORMAT_UNDEFINED;
 181 }
 182
 183 /**
 184  * gst_formats_contains:
 185  * @formats: The format array to search
 186  * @format: the format to find
 187  *
 188  * See if the given format is inside the format array.
 189  *
 190  * Returns: TRUE if the format is found inside the array
 191  */
 192 gboolean
 193 gst_formats_contains (const GstFormat * formats, GstFormat format)
 194 {
 195   if (!formats)
 196     return FALSE;
 197
 198   while (*formats) {
 199     if (*formats == format)
 200       return TRUE;
 201
 202     formats++;
 203   }
 204   return FALSE;
 205 }
 206
 207
 208 /**
 209  * gst_format_get_details:
 210  * @format: The format to get details of
 211  *
 212  * Get details about the given format.
 213  *
 214  * Returns: The #GstFormatDefinition for @format or NULL on failure.
 215  *
 216  * MT safe.
 217  */
 218 const GstFormatDefinition *
 219 gst_format_get_details (GstFormat format)
 220 {
 221   const GstFormatDefinition *result;
 222
 223   g_static_mutex_lock (&mutex);
 224   result = g_hash_table_lookup (_format_to_nick, GINT_TO_POINTER (format));
 225   g_static_mutex_unlock (&mutex);
 226
 227   return result;
 228 }
 229
 230 /**
 231  * gst_format_iterate_definitions:
 232  *
 233  * Iterate all the registered formats. The format definition is read
 234  * only.
 235  *
 236  * Returns: A GstIterator of #GstFormatDefinition.
 237  */
 238 GstIterator *
 239 gst_format_iterate_definitions (void)
 240 {
 241   GstIterator *result;
 242
 243   g_static_mutex_lock (&mutex);
 244   /* FIXME: register a boxed type for GstFormatDefinition */
 245   result = gst_iterator_new_list (G_TYPE_POINTER,
 246       g_static_mutex_get_mutex (&mutex), &_n_values, &_gst_formats,
 247       NULL, NULL, NULL);
 248   g_static_mutex_unlock (&mutex);
 249
 250   return result;
 251 }