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 const gchar *
  79 gst_format_get_name (GstFormat format)
  80 {
  81   const GstFormatDefinition *def;
  82
  83   def = gst_format_get_details (format);
  84
  85   return def->nick;
  86 }
  87
  88 GQuark
  89 gst_format_to_quark (GstFormat format)
  90 {
  91   const GstFormatDefinition *def;
  92
  93   def = gst_format_get_details (format);
  94
  95   return def->quark;
  96 }
  97
  98 /**
  99  * gst_format_register:
 100  * @nick: The nick of the new format
 101  * @description: The description of the new format
 102  *
 103  * Create a new GstFormat based on the nick or return an
 104  * already registered format with that nick.
 105  *
 106  * Returns: A new GstFormat or an already registered format
 107  * with the same nick.
 108  *
 109  * MT safe.
 110  */
 111 GstFormat
 112 gst_format_register (const gchar * nick, const gchar * description)
 113 {
 114   GstFormatDefinition *format;
 115   GstFormat query;
 116
 117   g_return_val_if_fail (nick != NULL, 0);
 118   g_return_val_if_fail (description != NULL, 0);
 119
 120   query = gst_format_get_by_nick (nick);
 121   if (query != GST_FORMAT_UNDEFINED)
 122     return query;
 123
 124   format = g_new0 (GstFormatDefinition, 1);
 125   format->value = _n_values;
 126   format->nick = g_strdup (nick);
 127   format->description = g_strdup (description);
 128   format->quark = g_quark_from_static_string (format->nick);
 129
 130   g_static_mutex_lock (&mutex);
 131   g_hash_table_insert (_nick_to_format, format->nick, format);
 132   g_hash_table_insert (_format_to_nick, GINT_TO_POINTER (format->value),
 133       format);
 134   _gst_formats = g_list_append (_gst_formats, format);
 135   _n_values++;
 136   g_static_mutex_unlock (&mutex);
 137
 138   return format->value;
 139 }
 140
 141 /**
 142  * gst_format_get_by_nick:
 143  * @nick: The nick of the format
 144  *
 145  * Return the format registered with the given nick.
 146  *
 147  * Returns: The format with @nick or GST_FORMAT_UNDEFINED
 148  * if the format was not registered.
 149  */
 150 GstFormat
 151 gst_format_get_by_nick (const gchar * nick)
 152 {
 153   GstFormatDefinition *format;
 154
 155   g_return_val_if_fail (nick != NULL, 0);
 156
 157   g_static_mutex_lock (&mutex);
 158   format = g_hash_table_lookup (_nick_to_format, nick);
 159   g_static_mutex_unlock (&mutex);
 160
 161   if (format != NULL)
 162     return format->value;
 163   else
 164     return GST_FORMAT_UNDEFINED;
 165 }
 166
 167 /**
 168  * gst_formats_contains:
 169  * @formats: The format array to search
 170  * @format: the format to find
 171  *
 172  * See if the given format is inside the format array.
 173  *
 174  * Returns: TRUE if the format is found inside the array
 175  */
 176 gboolean
 177 gst_formats_contains (const GstFormat * formats, GstFormat format)
 178 {
 179   if (!formats)
 180     return FALSE;
 181
 182   while (*formats) {
 183     if (*formats == format)
 184       return TRUE;
 185
 186     formats++;
 187   }
 188   return FALSE;
 189 }
 190
 191
 192 /**
 193  * gst_format_get_details:
 194  * @format: The format to get details of
 195  *
 196  * Get details about the given format.
 197  *
 198  * Returns: The #GstFormatDefinition for @format or NULL on failure.
 199  *
 200  * MT safe.
 201  */
 202 const GstFormatDefinition *
 203 gst_format_get_details (GstFormat format)
 204 {
 205   const GstFormatDefinition *result;
 206
 207   g_static_mutex_lock (&mutex);
 208   result = g_hash_table_lookup (_format_to_nick, GINT_TO_POINTER (format));
 209   g_static_mutex_unlock (&mutex);
 210
 211   return result;
 212 }
 213
 214 /**
 215  * gst_format_iterate_definitions:
 216  *
 217  * Iterate all the registered formats. The format definition is read
 218  * only.
 219  *
 220  * Returns: A GstIterator of #GstFormatDefinition.
 221  */
 222 GstIterator *
 223 gst_format_iterate_definitions (void)
 224 {
 225   GstIterator *result;
 226
 227   g_static_mutex_lock (&mutex);
 228   /* FIXME: register a boxed type for GstFormatDefinition */
 229   result = gst_iterator_new_list (G_TYPE_POINTER,
 230       g_static_mutex_get_mutex (&mutex), &_n_values, &_gst_formats,
 231       NULL, NULL, NULL);
 232   g_static_mutex_unlock (&mutex);
 233
 234   return result;
 235 }