Merge remote-tracking branch 'origin/master' into 0.11
[platform/upstream/gstreamer.git] / gst / gstformat.c
index 2ffb77b..24c3d0f 100644 (file)
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+
 /**
  * SECTION:gstformat
  * @short_description: Dynamically register new data formats
  * @see_also: #GstPad, #GstElement
  *
- * GstFormats functions are used to register a new format to the gstreamer core.
- * Formats can be used to perform seeking or conversions/query operations.
+ * GstFormats functions are used to register a new format to the gstreamer
+ * core.  Formats can be used to perform seeking or conversions/query
+ * operations.
  */
 
-#include <string.h>
 
 #include "gst_private.h"
+#include <string.h>
 #include "gstformat.h"
+#include "gstenumtypes.h"
 
 static GStaticMutex mutex = G_STATIC_MUTEX_INIT;
 static GList *_gst_formats = NULL;
@@ -41,16 +44,16 @@ static GHashTable *_format_to_nick = NULL;
 static guint32 _n_values = 1;   /* we start from 1 because 0 reserved for UNDEFINED */
 
 static GstFormatDefinition standard_definitions[] = {
-  {GST_FORMAT_DEFAULT, "default", "Default format for the media type"},
-  {GST_FORMAT_BYTES, "bytes", "Bytes"},
-  {GST_FORMAT_TIME, "time", "Time"},
-  {GST_FORMAT_BUFFERS, "buffers", "Buffers"},
-  {GST_FORMAT_PERCENT, "percent", "Percent"},
-  {0, NULL, NULL}
+  {GST_FORMAT_DEFAULT, "default", "Default format for the media type", 0},
+  {GST_FORMAT_BYTES, "bytes", "Bytes", 0},
+  {GST_FORMAT_TIME, "time", "Time", 0},
+  {GST_FORMAT_BUFFERS, "buffers", "Buffers", 0},
+  {GST_FORMAT_PERCENT, "percent", "Percent", 0},
+  {GST_FORMAT_UNDEFINED, NULL, NULL, 0}
 };
 
 void
-_gst_format_initialize (void)
+_priv_gst_format_initialize (void)
 {
   GstFormatDefinition *standards = standard_definitions;
 
@@ -61,7 +64,9 @@ _gst_format_initialize (void)
   }
 
   while (standards->nick) {
-    g_hash_table_insert (_nick_to_format, standards->nick, standards);
+    standards->quark = g_quark_from_static_string (standards->nick);
+    g_hash_table_insert (_nick_to_format, (gpointer) standards->nick,
+        standards);
     g_hash_table_insert (_format_to_nick, GINT_TO_POINTER (standards->value),
         standards);
 
@@ -69,10 +74,58 @@ _gst_format_initialize (void)
     standards++;
     _n_values++;
   }
+  /* getting the type registers the enum */
+  g_type_class_ref (gst_format_get_type ());
   g_static_mutex_unlock (&mutex);
 }
 
 /**
+ * gst_format_get_name:
+ * @format: a #GstFormat
+ *
+ * Get a printable name for the given format. Do not modify or free.
+ *
+ * Returns: a reference to the static name of the format or NULL if
+ * the format is unknown.
+ */
+const gchar *
+gst_format_get_name (GstFormat format)
+{
+  const GstFormatDefinition *def;
+  const gchar *result;
+
+  if ((def = gst_format_get_details (format)) != NULL)
+    result = def->nick;
+  else
+    result = NULL;
+
+  return result;
+}
+
+/**
+ * gst_format_to_quark:
+ * @format: a #GstFormat
+ *
+ * Get the unique quark for the given format.
+ *
+ * Returns: the quark associated with the format or 0 if the format
+ * is unknown.
+ */
+GQuark
+gst_format_to_quark (GstFormat format)
+{
+  const GstFormatDefinition *def;
+  GQuark result;
+
+  if ((def = gst_format_get_details (format)) != NULL)
+    result = def->quark;
+  else
+    result = 0;
+
+  return result;
+}
+
+/**
  * gst_format_register:
  * @nick: The nick of the new format
  * @description: The description of the new format
@@ -91,20 +144,21 @@ gst_format_register (const gchar * nick, const gchar * description)
   GstFormatDefinition *format;
   GstFormat query;
 
-  g_return_val_if_fail (nick != NULL, 0);
-  g_return_val_if_fail (description != NULL, 0);
+  g_return_val_if_fail (nick != NULL, GST_FORMAT_UNDEFINED);
+  g_return_val_if_fail (description != NULL, GST_FORMAT_UNDEFINED);
 
   query = gst_format_get_by_nick (nick);
   if (query != GST_FORMAT_UNDEFINED)
     return query;
 
-  format = g_new0 (GstFormatDefinition, 1);
-  format->value = _n_values;
+  g_static_mutex_lock (&mutex);
+  format = g_slice_new (GstFormatDefinition);
+  format->value = (GstFormat) _n_values;
   format->nick = g_strdup (nick);
   format->description = g_strdup (description);
+  format->quark = g_quark_from_static_string (format->nick);
 
-  g_static_mutex_lock (&mutex);
-  g_hash_table_insert (_nick_to_format, format->nick, format);
+  g_hash_table_insert (_nick_to_format, (gpointer) format->nick, format);
   g_hash_table_insert (_format_to_nick, GINT_TO_POINTER (format->value),
       format);
   _gst_formats = g_list_append (_gst_formats, format);
@@ -118,7 +172,7 @@ gst_format_register (const gchar * nick, const gchar * description)
  * gst_format_get_by_nick:
  * @nick: The nick of the format
  *
- * Return the format registered with the given nick. 
+ * Return the format registered with the given nick.
  *
  * Returns: The format with @nick or GST_FORMAT_UNDEFINED
  * if the format was not registered.
@@ -128,7 +182,7 @@ gst_format_get_by_nick (const gchar * nick)
 {
   GstFormatDefinition *format;
 
-  g_return_val_if_fail (nick != NULL, 0);
+  g_return_val_if_fail (nick != NULL, GST_FORMAT_UNDEFINED);
 
   g_static_mutex_lock (&mutex);
   format = g_hash_table_lookup (_nick_to_format, nick);
@@ -190,10 +244,10 @@ gst_format_get_details (GstFormat format)
 /**
  * gst_format_iterate_definitions:
  *
- * Iterate all the registered formats. The format definition is read 
+ * Iterate all the registered formats. The format definition is read
  * only.
  *
- * Returns: A GstIterator of #GstFormatDefinition.
+ * Returns: (transfer full): a GstIterator of #GstFormatDefinition.
  */
 GstIterator *
 gst_format_iterate_definitions (void)
@@ -201,8 +255,9 @@ gst_format_iterate_definitions (void)
   GstIterator *result;
 
   g_static_mutex_lock (&mutex);
-  result = gst_iterator_new_list (g_static_mutex_get_mutex (&mutex),
-      &_n_values, &_gst_formats, NULL, NULL, NULL);
+  /* FIXME: register a boxed type for GstFormatDefinition */
+  result = gst_iterator_new_list (G_TYPE_POINTER,
+      g_static_mutex_get_mutex (&mutex), &_n_values, &_gst_formats, NULL, NULL);
   g_static_mutex_unlock (&mutex);
 
   return result;