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  *
   5  * gstformat.c: GstFormat registration
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 #include "gstlog.h"
  24
  25 #include "gstformat.h"
  26
  27 static GList *_gst_formats = NULL;
  28 static gint  _n_values = 1; /* we start from 1 because 0 reserved for UNDEFINED */
  29
  30 typedef struct _GstFormatDefinition GstFormatDefinition;
  31
  32 struct _GstFormatDefinition
  33 {
  34   GstFormat  value;
  35   gchar     *nick;
  36   gchar     *description;
  37 };
  38
  39 static GstFormatDefinition standard_definitions[] = {
  40   { GST_FORMAT_DEFAULT, "default", "Default" },
  41   { GST_FORMAT_BYTES,   "bytes",   "Bytes" },
  42   { GST_FORMAT_TIME,    "time",    "Time" },
  43   { GST_FORMAT_BUFFERS, "buffers", "Buffers" },
  44   { GST_FORMAT_PERCENT, "percent", "Percent" },
  45   { GST_FORMAT_UNITS,   "units",   "Units as defined by the media type" },
  46   { 0, NULL, NULL }
  47 };
  48
  49 void
  50 _gst_format_initialize (void)
  51 {
  52   GstFormatDefinition *standards = standard_definitions;
  53
  54   while (standards->nick) {
  55     _gst_formats = g_list_prepend (_gst_formats, standards);
  56     standards++;
  57   }
  58 }
  59
  60 /**
  61  * gst_format_register:
  62  * @nick: The nick of the new format
  63  * @description: The description of the new format
  64  *
  65  * Create a new GstFormat based on the nick or return an
  66  * allrady registered format with that nick
  67  *
  68  * Returns: A new GstFormat or an already registered format
  69  * with the same nick.
  70  */
  71 GstFormat
  72 gst_format_register (const gchar *nick, const gchar *description)
  73 {
  74   GstFormatDefinition *format;
  75   GstFormat query;
  76
  77   g_return_val_if_fail (nick != NULL, 0);
  78   g_return_val_if_fail (description != NULL, 0);
  79
  80   query = gst_format_get_by_nick (nick);
  81   if (query != GST_FORMAT_UNDEFINED)
  82     return query;
  83
  84   format = g_new0 (GstFormatDefinition, 1);
  85   format->value = _n_values;
  86   format->nick = g_strdup (nick);
  87   format->description = g_strdup (description);
  88
  89   _gst_formats = g_list_prepend (_gst_formats, format);
  90
  91   _n_values++;
  92
  93   return format->value;
  94 }
  95
  96 /**
  97  * gst_format_get_by_nick:
  98  * @nick: The nick of the format
  99  *
 100  * Return the format registered with the given nick.
 101  *
 102  * Returns: The format with @nick or GST_FORMAT_UNDEFINED
 103  * if the format was not registered.
 104  */
 105 GstFormat
 106 gst_format_get_by_nick (const gchar *nick)
 107 {
 108   GList *walk;
 109   GstFormatDefinition *format;
 110
 111   g_return_val_if_fail (nick != NULL, 0);
 112
 113   walk = _gst_formats;
 114
 115   while (walk) {
 116     format = (GstFormatDefinition *) walk->data;
 117
 118     if (!strcmp (format->nick, nick))
 119       return format->value;
 120
 121     walk = g_list_next (walk);
 122   }
 123
 124   return GST_FORMAT_UNDEFINED;
 125 }
 126
 127 /**
 128  * gst_format_get_details:
 129  * @format: The format to get details of
 130  * @nick: The nick of the format
 131  * @description: The description of the format
 132  *
 133  * Get details about the given format.
 134  *
 135  * Returns: TRUE if the format was registered, FALSE otherwise
 136  */
 137 gboolean
 138 gst_format_get_details (GstFormat format, const gchar **nick, const gchar **description)
 139 {
 140   GList *walk;
 141   GstFormatDefinition *walk_format;
 142
 143   g_return_val_if_fail (nick != NULL, FALSE);
 144   g_return_val_if_fail (description != NULL, FALSE);
 145
 146   walk = _gst_formats;
 147
 148   while (walk) {
 149     walk_format = (GstFormatDefinition *) walk->data;
 150
 151     if (walk_format->value == format) {
 152       *nick = walk_format->nick;
 153       *description = walk_format->description;
 154
 155       return TRUE;
 156     }
 157
 158     walk = g_list_next (walk);
 159   }
 160   return FALSE;
 161 }