gstreamer_core/gst/gstcaps.h
changeset 2 5505e8908944
parent 0 0e761a78d257
child 7 567bb019e3e3
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/gstreamer_core/gst/gstcaps.h	Fri Jan 22 09:59:59 2010 +0200
@@ -0,0 +1,406 @@
+/* GStreamer
+ * Copyright (C) 2003 David A. Schleef <ds@schleef.org>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+#ifndef __GST_CAPS_H__
+#define __GST_CAPS_H__
+
+#include <gst/gstconfig.h>
+#include <gst/gststructure.h>
+#include <gst/glib-compat.h>
+
+G_BEGIN_DECLS
+
+#define GST_TYPE_CAPS             (gst_caps_get_type())
+#define GST_CAPS(object)          ((GstCaps*)object)
+#define GST_IS_CAPS(object)       ((object) && (GST_CAPS(object)->type == GST_TYPE_CAPS))
+
+#define GST_TYPE_STATIC_CAPS      (gst_static_caps_get_type())
+
+/**
+ * GstCapsFlags:
+ * @GST_CAPS_FLAGS_ANY: Caps has no specific content, but can contain
+ *    anything.
+ *
+ * Extra flags for a caps.
+ */
+typedef enum {
+  GST_CAPS_FLAGS_ANY	= (1 << 0)
+} GstCapsFlags;
+
+/**
+ * GST_CAPS_ANY:
+ *
+ * Means that the element/pad can output 'anything'. Useful for elements
+ * that output unknown media, such as filesrc.
+ */
+#define GST_CAPS_ANY              gst_caps_new_any()
+/**
+ * GST_CAPS_NONE:
+ *
+ * The opposite of %GST_CAPS_ANY: it means that the pad/element outputs an
+ * undefined media type that can not be detected.
+ */
+#define GST_CAPS_NONE             gst_caps_new_empty()
+
+/**
+ * GST_STATIC_CAPS_ANY:
+ *
+ * Creates a new #GstCaps static caps that matches anything.
+ * This can be used in pad templates.
+ */
+#define GST_STATIC_CAPS_ANY       GST_STATIC_CAPS("ANY")
+/**
+ * GST_STATIC_CAPS_NONE:
+ *
+ * Creates a new #GstCaps static caps that matches nothing.
+ * This can be used in pad templates.
+ */
+#define GST_STATIC_CAPS_NONE      GST_STATIC_CAPS("NONE")
+
+/**
+ * GST_CAPS_IS_SIMPLE:
+ * @caps: the #GstCaps instance to check
+ *
+ * Convenience macro that checks if the number of structures in the given caps
+ * is exactly one.
+ */
+#define GST_CAPS_IS_SIMPLE(caps) (gst_caps_get_size(caps) == 1)
+
+#ifndef GST_DISABLE_DEPRECATED
+/**
+ * GST_DEBUG_CAPS:
+ * @string: a string that should be prepended to the caps data.
+ * @caps: the #GstCaps instance to print
+ *
+ * Convenience macro for printing out the contents of caps with GST_DEBUG().
+ *
+ * Deprecated: do not use anymore
+ */
+#define GST_DEBUG_CAPS(string, caps) \
+  GST_DEBUG ( string "%s: " GST_PTR_FORMAT, caps)
+
+#endif /* GST_DISABLE_DEPRECATED */
+
+/**
+ * GST_STATIC_CAPS:
+ * @string: the string describing the caps
+ *
+ * Creates a new #GstCaps static caps from an input string.
+ * This can be used in pad templates.
+ */
+#define GST_STATIC_CAPS(string) \
+{ \
+  /* caps */ { 0, 0, (GstCapsFlags) 0, NULL, GST_PADDING_INIT }, \
+  /* string */ string, \
+  GST_PADDING_INIT \
+}
+
+typedef struct _GstCaps GstCaps;
+typedef struct _GstStaticCaps GstStaticCaps;
+
+/* refcount */
+/**
+ * GST_CAPS_REFCOUNT:
+ * @caps: a #GstCaps
+ *
+ * Get access to the reference count field of the caps
+ */
+#define GST_CAPS_REFCOUNT(caps)                 ((GST_CAPS(caps))->refcount)
+/**
+ * GST_CAPS_REFCOUNT_VALUE:
+ * @caps: a #GstCaps
+ *
+ * Get the reference count value of the caps.
+ */
+#define GST_CAPS_REFCOUNT_VALUE(caps)           (g_atomic_int_get (&(GST_CAPS(caps))->refcount))
+
+/**
+ * GstCaps:
+ * @type: GType of the caps
+ * @refcount: the atomic refcount value
+ * @flags: extra flags for the caps, read only.
+ *
+ * Object describing media types.
+ */
+struct _GstCaps {
+  GType type;
+
+  /*< public >*/ /* with COW */
+  /* refcounting */
+  gint           refcount;
+
+  /*< public >*/ /* read only */
+  GstCapsFlags flags;
+
+  /*< private >*/
+  GPtrArray *structs;
+
+  /*< private >*/
+  gpointer _gst_reserved[GST_PADDING];
+};
+
+/**
+ * GstStaticCaps:
+ * @caps: the cached #GstCaps
+ * @string: a string describing a caps
+ *
+ * Datastructure to initialize #GstCaps from a string description usually
+ * used in conjunction with GST_STATIC_CAPS() and gst_static_caps_get() to
+ * instantiate a #GstCaps.
+ */
+struct _GstStaticCaps {
+  /*< public >*/
+  GstCaps caps;
+  const char *string;
+
+  /*< private >*/
+  gpointer _gst_reserved[GST_PADDING];
+};
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+
+GType             gst_caps_get_type                (void);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+GstCaps *         gst_caps_new_empty               (void);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+GstCaps *         gst_caps_new_any                 (void);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+GstCaps *         gst_caps_new_simple              (const char    *media_type,
+                                                    const char    *fieldname,
+                                                    ...);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+GstCaps *         gst_caps_new_full                (GstStructure  *struct1, ...);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+GstCaps *         gst_caps_new_full_valist         (GstStructure  *structure,
+                                                    va_list        var_args);
+
+/* reference counting */
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+GstCaps *         gst_caps_ref                     (GstCaps       *caps);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+GstCaps *         gst_caps_copy                    (const GstCaps *caps);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+GstCaps *         gst_caps_make_writable           (GstCaps       *caps);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+void              gst_caps_unref                   (GstCaps       *caps);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+
+GType             gst_static_caps_get_type         (void);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+GstCaps *         gst_static_caps_get              (GstStaticCaps *static_caps);
+
+/* manipulation */
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+void              gst_caps_append                  (GstCaps       *caps1,
+                                                    GstCaps       *caps2);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+void              gst_caps_merge                   (GstCaps       *caps1,
+                                                    GstCaps       *caps2);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+void              gst_caps_append_structure        (GstCaps       *caps,
+                                                    GstStructure  *structure);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+void              gst_caps_remove_structure        (GstCaps       *caps, guint idx);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+void              gst_caps_merge_structure         (GstCaps       *caps,
+                                                    GstStructure  *structure);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+guint             gst_caps_get_size                (const GstCaps *caps);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+GstStructure *    gst_caps_get_structure           (const GstCaps *caps,
+                                                    guint          index);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+GstCaps *         gst_caps_copy_nth                (const GstCaps *caps, guint nth);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+void              gst_caps_truncate                (GstCaps       *caps);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+void              gst_caps_set_simple              (GstCaps       *caps,
+                                                    char          *field, ...) G_GNUC_NULL_TERMINATED;
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+void              gst_caps_set_simple_valist       (GstCaps       *caps,
+                                                    char          *field,
+                                                    va_list        varargs);
+
+/* tests */
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+gboolean          gst_caps_is_any                  (const GstCaps *caps);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+gboolean          gst_caps_is_empty                (const GstCaps *caps);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+gboolean          gst_caps_is_fixed                (const GstCaps *caps);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+gboolean          gst_caps_is_always_compatible    (const GstCaps *caps1,
+                                                    const GstCaps *caps2);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+gboolean          gst_caps_is_subset		   (const GstCaps *subset,
+						    const GstCaps *superset);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+gboolean          gst_caps_is_equal		   (const GstCaps *caps1,
+						    const GstCaps *caps2);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+gboolean          gst_caps_is_equal_fixed          (const GstCaps *caps1,
+						    const GstCaps *caps2);
+
+
+/* operations */
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+GstCaps *         gst_caps_intersect               (const GstCaps *caps1,
+						    const GstCaps *caps2);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+GstCaps *         gst_caps_subtract		   (const GstCaps *minuend,
+						    const GstCaps *subtrahend);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+GstCaps *         gst_caps_union                   (const GstCaps *caps1,
+						    const GstCaps *caps2);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+GstCaps *         gst_caps_normalize               (const GstCaps *caps);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+gboolean          gst_caps_do_simplify             (GstCaps       *caps);
+
+#ifndef GST_DISABLE_LOADSAVE
+xmlNodePtr        gst_caps_save_thyself            (const GstCaps *caps,
+                                                    xmlNodePtr     parent);
+GstCaps *         gst_caps_load_thyself            (xmlNodePtr     parent);
+#endif
+
+/* utility */
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+void              gst_caps_replace                 (GstCaps      **caps,
+                                                    GstCaps       *newcaps);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+gchar *           gst_caps_to_string               (const GstCaps *caps);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+GstCaps *         gst_caps_from_string             (const gchar   *string);
+
+G_END_DECLS
+
+#endif /* __GST_CAPS_H__ */