- Added value transform functions for caps and props boxed types
[platform/upstream/gstreamer.git] / gst / gstcaps.c
index 4e6b8f3..f7ed767 100644 (file)
  * Boston, MA 02111-1307, USA.
  */
 
-//#define GST_DEBUG_ENABLED
+/* #define GST_DEBUG_ENABLED */
 #include "gst_private.h"
 
 #include "gstcaps.h"
 #include "gsttype.h"
+#include "gstlog.h"
 
-#include "gstpropsprivate.h"
+static GMemChunk *_gst_caps_chunk;
+static GMutex *_gst_caps_chunk_lock;
 
+GType _gst_caps_type;
+
+static void
+transform_func (const GValue *src_value,
+               GValue *dest_value)
+{
+  GstCaps *caps = g_value_peek_pointer (src_value);
+  GString *result = g_string_new (""); 
+
+  g_string_append_printf (result, "(GstCaps *) ");
+                 
+  while (caps) {
+    gchar *props;
+    GValue value = { 0, }; /* the important thing is that value.type = 0 */
+    
+    g_string_append_printf (result,
+                 "{ %s; ", gst_caps_get_mime (caps));
+
+    g_value_init (&value, GST_TYPE_PROPS);
+    g_value_set_boxed  (&value, caps->properties);
+    props = g_strdup_value_contents (&value);
+
+    g_string_append (result, props);
+    g_free (props);
+
+    caps = caps->next;
+    g_string_append_printf (result, " }%s", caps?", ":"");
+  }
+  dest_value->data[0].v_pointer = result->str;
+}
 
 void
 _gst_caps_initialize (void)
 {
+  _gst_caps_chunk = g_mem_chunk_new ("GstCaps",
+                  sizeof (GstCaps), sizeof (GstCaps) * 256,
+                  G_ALLOC_AND_FREE);
+  _gst_caps_chunk_lock = g_mutex_new ();
+
+  _gst_caps_type = g_boxed_type_register_static ("GstCaps",
+                                       (GBoxedCopyFunc) gst_caps_ref,
+                                       (GBoxedFreeFunc) gst_caps_unref);
+
+  g_value_register_transform_func (_gst_caps_type,
+                                  G_TYPE_STRING,
+                                  transform_func);
 }
 
 static guint16
@@ -41,13 +85,17 @@ get_type_for_mime (const gchar *mime)
 
   typeid = gst_type_find_by_mime (mime);
   if (typeid == 0) {
-     GstTypeFactory factory; // = g_new0 (GstTypeFactory, 1);
+     GstTypeDefinition definition;
+     GstTypeFactory *factory;
+
+     definition.name = "capstype";
+     definition.mime = g_strdup (mime);
+     definition.exts = NULL;
+     definition.typefindfunc = NULL;
 
-     factory.mime = g_strdup (mime);
-     factory.exts = NULL;
-     factory.typefindfunc = NULL;
+     factory = gst_type_factory_new (&definition);
 
-     typeid = gst_type_register (&factory);
+     typeid = gst_type_register (factory);
   }
   return typeid;
 }
@@ -56,104 +104,237 @@ get_type_for_mime (const gchar *mime)
  * gst_caps_new:
  * @name: the name of this capability
  * @mime: the mime type to attach to the capability
+ * @props: the properties to add to this capability
+ *
+ * Create a new capability with the given mime typei and properties.
+ *
+ * Returns: a new capability
+ */
+GstCaps*
+gst_caps_new (const gchar *name, const gchar *mime, GstProps *props)
+{
+  g_return_val_if_fail (mime != NULL, NULL);
+
+  return gst_caps_new_id (name, get_type_for_mime (mime), props);
+}
+
+/**
+ * gst_caps_new_id:
+ * @name: the name of this capability
+ * @id: the id of the mime type 
+ * @props: the properties to add to this capability
  *
- * Create a new capability with the given mime type.
+ * Create a new capability with the given mime typeid and properties.
  *
  * Returns: a new capability
  */
 GstCaps*
-gst_caps_new (const gchar *name, const gchar *mime)
+gst_caps_new_id (const gchar *name, const guint16 id, GstProps *props)
 {
   GstCaps *caps;
 
-  g_return_val_if_fail (mime != NULL, NULL);
+  g_mutex_lock (_gst_caps_chunk_lock);
+  caps = g_mem_chunk_alloc (_gst_caps_chunk);
+  g_mutex_unlock (_gst_caps_chunk_lock);
 
-  caps = g_new0 (GstCaps, 1);
   caps->name = g_strdup (name);
-  caps->id = get_type_for_mime (mime);
-  caps->properties = NULL;
+  caps->id = id;
+  caps->properties = props;
   caps->next = NULL;
+  caps->refcount = 1;
+  if (props)
+    caps->fixed = props->fixed;
+  else
+    caps->fixed = TRUE;
 
   return caps;
 }
 
 /**
- * gst_caps_new_with_props:
- * @name: the name of this capability
- * @mime: the mime type to attach to the capability
- * @props: the properties for this capability
+ * gst_caps_destroy:
+ * @caps: the caps to destroy
  *
- * Create a new capability with the given mime type and the given properties.
+ * Frees the memory used by this caps structure and all
+ * the chained caps and properties.
+ */
+void
+gst_caps_destroy (GstCaps *caps)
+{
+  GstCaps *next;
+
+  if (caps == NULL)
+    return;
+
+  next = caps->next;
+
+  gst_props_unref (caps->properties);
+  g_free (caps->name);
+  g_mutex_lock (_gst_caps_chunk_lock);
+  g_mem_chunk_free (_gst_caps_chunk, caps);
+  g_mutex_unlock (_gst_caps_chunk_lock);
+
+  if (next) 
+    gst_caps_unref (next);
+}
+
+/**
+ * gst_caps_debug:
+ * @caps: the caps to print out
+ * @label: a label to put on the printout, or NULL
  *
- * Returns: a new capability
+ * Print out the contents of the caps structure. Useful for debugging.
+ */
+void
+gst_caps_debug (GstCaps *caps, const gchar *label)
+{
+  GST_DEBUG_ENTER ("caps debug: %s", label);
+  while (caps) {
+    GST_DEBUG (GST_CAT_CAPS, "caps: %p %s %s (%sfixed)", caps, caps->name, gst_caps_get_mime (caps), 
+               caps->fixed ? "" : "NOT ");
+
+    if (caps->properties) {
+      gst_props_debug (caps->properties);
+    }
+    else {
+      GST_DEBUG (GST_CAT_CAPS, "no properties");
+    }
+
+    caps = caps->next;
+  }
+  GST_DEBUG_LEAVE ("caps debug");
+}
+
+/**
+ * gst_caps_unref:
+ * @caps: the caps to unref
+ *
+ * Decrease the refcount of this caps structure, 
+ * destroying it when the refcount is 0
+ *
+ * Returns: caps or NULL if the refcount reached 0
  */
 GstCaps*
-gst_caps_new_with_props (const gchar *name, const gchar *mime, GstProps *props)
+gst_caps_unref (GstCaps *caps)
 {
-  GstCaps *caps;
+  gboolean zero;
+  GstCaps **next;
 
-  caps = gst_caps_new (name, mime);
-  caps->properties = props;
+  if (caps == NULL)
+    return NULL;
+
+  g_return_val_if_fail (caps->refcount > 0, NULL);
+
+  caps->refcount--;
+  zero = (caps->refcount == 0);
+  next = &caps->next;
+
+  if (*next)
+    *next = gst_caps_unref (*next);
 
+  if (zero) {
+    gst_caps_destroy (caps);
+    caps = NULL;
+  }
   return caps;
 }
 
 /**
- * gst_caps_register:
- * @factory: the factory to register
+ * gst_caps_ref:
+ * @caps: the caps to ref
  *
- * Register the factory.
+ * Increase the refcount of this caps structure
  *
- * Returns: the registered capability
+ * Returns: the caps with the refcount incremented
  */
 GstCaps*
-gst_caps_register (GstCapsFactory *factory)
+gst_caps_ref (GstCaps *caps)
 {
-  guint dummy;
+  g_return_val_if_fail (caps != NULL, NULL);
+
+  caps->refcount++;
 
-  return gst_caps_register_count (factory, &dummy);
+  return caps;
 }
 
 /**
- * gst_caps_register_count:
- * @factory: the factory to register
- * @counter: count how many entries were consumed
+ * gst_caps_copy_1:
+ * @caps: the caps to copy
  *
- * Register the factory.
+ * Copies the caps, not copying any chained caps.
  *
- * Returns: the registered capability
+ * Returns: a copy of the GstCaps structure.
  */
 GstCaps*
-gst_caps_register_count (GstCapsFactory *factory, guint *counter)
+gst_caps_copy_1 (GstCaps *caps)
 {
-  GstCapsFactoryEntry tag;
-  gint i = 0;
-  guint16 typeid;
-  gchar *name;
-  GstCaps *caps;
+  GstCaps *newcaps;
+  
+  if (!caps)
+    return NULL;
+
+  newcaps = gst_caps_new_id (
+                 caps->name,
+                 caps->id,
+                 gst_props_copy (caps->properties));
 
-  g_return_val_if_fail (factory != NULL, NULL);
+  return newcaps;
+}
 
-  tag = (*factory)[i++];
-  g_return_val_if_fail (tag != NULL, NULL);
+/**
+ * gst_caps_copy:
+ * @caps: the caps to copy
+ *
+ * Copies the caps.
+ *
+ * Returns: a copy of the GstCaps structure.
+ */
+GstCaps*
+gst_caps_copy (GstCaps *caps)
+{
+  GstCaps *new = NULL, *walk = NULL;
 
-  name = tag;
+  while (caps) {
+    GstCaps *newcaps;
 
-  tag = (*factory)[i++];
-  g_return_val_if_fail (tag != NULL, NULL);
+    newcaps = gst_caps_copy_1 (caps);
 
-  typeid = get_type_for_mime ((gchar *)tag);
+    if (new == NULL) {
+      new = walk = newcaps;
+    }
+    else {
+      walk = walk->next = newcaps;
+    }
+    caps = caps->next;
+  }
+
+  return new;
+}
+
+/**
+ * gst_caps_copy_on_write:
+ * @caps: the caps to copy
+ *
+ * Copies the caps if the refcount is greater than 1
+ *
+ * Returns: a pointer to a GstCaps strcuture that can
+ * be safely written to
+ */
+GstCaps*
+gst_caps_copy_on_write (GstCaps *caps)
+{
+  GstCaps *new = caps;
+  gboolean needcopy;
 
-  caps = g_new0 (GstCaps, 1);
   g_return_val_if_fail (caps != NULL, NULL);
 
-  caps->name = g_strdup (name);
-  caps->id = typeid;
-  caps->properties = gst_props_register_count (&(*factory)[i], counter);
+  needcopy = (caps->refcount > 1);
 
-  *counter += 2;
+  if (needcopy) {
+    new = gst_caps_copy (caps);
+    gst_caps_unref (caps);
+  }
 
-  return caps;
+  return new;
 }
 
 /**
@@ -248,7 +429,7 @@ gst_caps_get_type_id (GstCaps *caps)
 /**
  * gst_caps_set_type_id:
  * @caps: the caps to set the type id to
- * @typeid: the type id to set
+ * @type_id: the type id to set
  *
  * Set the type id of the caps.
  */
@@ -298,6 +479,36 @@ gst_caps_get_props (GstCaps *caps)
 }
 
 /**
+ * gst_caps_chain:
+ * @caps: a capabilty
+ * @...: more capabilities
+ *
+ * chains the given capabilities
+ *
+ * Returns: the new capability
+ */
+GstCaps*
+gst_caps_chain (GstCaps *caps, ...)
+{
+  GstCaps *orig = caps;
+  va_list var_args;
+
+  va_start (var_args, caps);
+
+  while (caps) {
+    GstCaps *toadd;
+    
+    toadd = va_arg (var_args, GstCaps*);
+    gst_caps_append (caps, toadd);
+    
+    caps = toadd;
+  }
+  va_end (var_args);
+  
+  return orig;
+}
+
+/**
  * gst_caps_append:
  * @caps: a capabilty
  * @capstoadd: the capability to append
@@ -310,8 +521,8 @@ GstCaps*
 gst_caps_append (GstCaps *caps, GstCaps *capstoadd)
 {
   GstCaps *orig = caps;
-
-  if (caps == NULL)
+  
+  if (caps == NULL || caps == capstoadd)
     return capstoadd;
   
   while (caps->next) {
@@ -339,6 +550,8 @@ gst_caps_prepend (GstCaps *caps, GstCaps *capstoadd)
   if (capstoadd == NULL)
     return caps;
 
+  g_return_val_if_fail (caps != capstoadd, caps);
+
   while (capstoadd->next) {
     capstoadd = capstoadd->next;
   }
@@ -347,6 +560,17 @@ gst_caps_prepend (GstCaps *caps, GstCaps *capstoadd)
   return orig;
 }
 
+/**
+ * gst_caps_get_by_name:
+ * @caps: a capabilty
+ * @name: the name of the capability to get
+ *
+ * Get the capability with the given name from this
+ * chain of capabilities.
+ *
+ * Returns: the first capability in the chain with the 
+ * given name
+ */
 GstCaps*
 gst_caps_get_by_name (GstCaps *caps, const gchar *name)
 {
@@ -366,8 +590,9 @@ static gboolean
 gst_caps_check_compatibility_func (GstCaps *fromcaps, GstCaps *tocaps)
 {
   if (fromcaps->id != tocaps->id) {
-    GST_DEBUG (0,"gstcaps: mime types differ (%d to %d)\n",
-              fromcaps->id, tocaps->id);
+    GST_DEBUG (GST_CAT_CAPS,"mime types differ (%s to %s)",
+              gst_type_find_by_id (fromcaps->id)->mime, 
+              gst_type_find_by_id (tocaps->id)->mime);
     return FALSE;
   }
 
@@ -376,23 +601,23 @@ gst_caps_check_compatibility_func (GstCaps *fromcaps, GstCaps *tocaps)
       return gst_props_check_compatibility (fromcaps->properties, tocaps->properties);
     }
     else {
-      GST_DEBUG (0,"gstcaps: no source caps\n");
+      GST_DEBUG (GST_CAT_CAPS,"no source caps");
       return FALSE;
     }
   }
   else {
-    // assume it accepts everything
-    GST_DEBUG (0,"gstcaps: no caps\n");
+    /* assume it accepts everything */
+    GST_DEBUG (GST_CAT_CAPS,"no caps");
     return TRUE;
   }
 }
 
 /**
- * gst_caps_list_check_compatibility:
+ * gst_caps_check_compatibility:
  * @fromcaps: a capabilty
  * @tocaps: a capabilty
  *
- * Checks whether two capability lists are compatible.
+ * Checks whether two capabilities are compatible.
  *
  * Returns: TRUE if compatible, FALSE otherwise
  */
@@ -401,17 +626,17 @@ gst_caps_check_compatibility (GstCaps *fromcaps, GstCaps *tocaps)
 {
   if (fromcaps == NULL) {
     if (tocaps == NULL) {
-      GST_DEBUG (0,"gstcaps: no caps\n");
+      GST_DEBUG (GST_CAT_CAPS,"no caps");
       return TRUE;
     }
     else {
-      GST_DEBUG (0,"gstcaps: no src but destination caps\n");
+      GST_DEBUG (GST_CAT_CAPS,"no source but destination caps");
       return FALSE;
     }
   }
   else {
     if (tocaps == NULL) {
-      GST_DEBUG (0,"gstcaps: src caps and no dest caps\n");
+      GST_DEBUG (GST_CAT_CAPS,"source caps and no destination caps");
       return TRUE;
     }
   }
@@ -430,6 +655,132 @@ gst_caps_check_compatibility (GstCaps *fromcaps, GstCaps *tocaps)
   return FALSE;
 }
 
+static GstCaps*
+gst_caps_intersect_func (GstCaps *caps1, GstCaps *caps2)
+{
+  GstCaps *result = NULL;
+  GstProps *props;
+
+  if (caps1->id != caps2->id) {
+    GST_DEBUG (GST_CAT_CAPS,"mime types differ (%s to %s)",
+              gst_type_find_by_id (caps1->id)->mime, 
+              gst_type_find_by_id (caps2->id)->mime);
+    return NULL;
+  }
+
+  if (caps1->properties == NULL) {
+    return gst_caps_ref (caps2);
+  }
+  if (caps2->properties == NULL) {
+    return gst_caps_ref (caps1);
+  }
+  
+  props = gst_props_intersect (caps1->properties, caps2->properties);
+  if (props) {
+    result = gst_caps_new_id ("intersect", caps1->id, props);
+  }
+
+  return result;
+}
+
+/**
+ * gst_caps_intersect:
+ * @caps1: a capabilty
+ * @caps2: a capabilty
+ *
+ * Make the intersection between two caps.
+ *
+ * Returns: The intersection of the two caps or NULL if the intersection
+ * is empty.
+ */
+GstCaps*
+gst_caps_intersect (GstCaps *caps1, GstCaps *caps2)
+{
+  GstCaps *result = NULL, *walk = NULL;
+
+  if (caps1 == NULL) {
+    GST_DEBUG (GST_CAT_CAPS, "first caps is NULL, return other caps");
+    return gst_caps_copy (caps2);
+  }
+  if (caps2 == NULL) {
+    GST_DEBUG (GST_CAT_CAPS, "second caps is NULL, return other caps");
+    return gst_caps_copy (caps1);
+  }
+
+  while (caps1) {
+    GstCaps *othercaps = caps2;
+
+    while (othercaps) {
+      GstCaps *intersection;
+      
+      intersection = gst_caps_intersect_func (caps1, othercaps);
+
+      if (intersection) {
+        if (!result) {
+         walk = result = intersection;
+        }
+        else {
+         walk = walk->next = intersection;
+        }
+      }
+      othercaps = othercaps->next;
+    }
+    caps1 =  caps1->next;
+  }
+
+  return result;
+}
+
+/**
+ * gst_caps_normalize:
+ * @caps: a capabilty
+ *
+ * Make the normalisation of the caps. This will return a new caps
+ * that is equivalent to the input caps with the exception that all
+ * lists are unrolled. This function is useful when you want to iterate
+ * the caps.
+ *
+ * Returns: The normalisation of the caps.
+ */
+GstCaps*
+gst_caps_normalize (GstCaps *caps)
+{
+  GstCaps *result = NULL, *walk = caps;
+
+  if (caps == NULL)
+    return caps;
+
+  while (caps) {
+    GList *proplist;
+
+    proplist = gst_props_normalize (caps->properties);
+    if (proplist && g_list_next (proplist) == NULL) {
+      if (result == NULL)
+       walk = result = caps;
+      else {
+       walk = walk->next = caps;
+      }
+      goto next;
+    }
+
+    while (proplist) {
+      GstProps *props = (GstProps *) proplist->data;
+      GstCaps *newcaps = gst_caps_new_id (caps->name, caps->id, props);
+
+      if (result == NULL)
+       walk = result = newcaps;
+      else {
+       walk = walk->next = newcaps;
+      }
+      proplist = g_list_next (proplist);  
+    }
+next:
+    caps = caps->next;
+  }
+  return result;
+}
+
+#ifndef GST_DISABLE_LOADSAVE_REGISTRY
 /**
  * gst_caps_save_thyself:
  * @caps: a capabilty to save
@@ -479,8 +830,16 @@ gst_caps_load_thyself (xmlNodePtr parent)
   while (field) {
     if (!strcmp (field->name, "capscomp")) {
       xmlNodePtr subfield = field->xmlChildrenNode;
-      GstCaps *caps = g_new0 (GstCaps, 1);
+      GstCaps *caps;
       gchar *content;
+
+      g_mutex_lock (_gst_caps_chunk_lock);
+      caps = g_mem_chunk_alloc0 (_gst_caps_chunk);
+      g_mutex_unlock (_gst_caps_chunk_lock);
+
+      caps->refcount = 1;
+      caps->next = NULL;
+      caps->fixed = TRUE;
        
       while (subfield) {
         if (!strcmp (subfield->name, "name")) {
@@ -505,5 +864,4 @@ gst_caps_load_thyself (xmlNodePtr parent)
   return result;
 }
 
-
-
+#endif /* GST_DISABLE_LOADSAVE_REGISTRY */