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