2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
5 * gstcaps.h: Header for caps subsystem
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.
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.
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.
24 #ifndef __GST_CAPS_H__
25 #define __GST_CAPS_H__
27 #include <gst/gstprops.h>
31 typedef struct _GstCaps GstCaps;
33 extern GType _gst_caps_type;
35 #define GST_TYPE_CAPS (_get_caps_type)
38 #define GST_CAPS(caps) \
41 #define GST_CAPS_IS_FIXED(caps) ((caps)->fixed)
42 #define GST_CAPS_IS_CHAINED(caps) ((caps)->next)
44 /* CR1: id is an int corresponding to the quark for the mime type because
45 * it's really fast when doing a first-pass check for caps compatibility */
47 gchar *name; /* the name of this caps */
48 guint16 id; /* type id (major type) representing
52 gboolean fixed; /* this caps doesn't contain variable properties */
54 GstProps *properties; /* properties for this capability */
56 GstCaps *next; /* not with a GList for efficiency */
59 /* factory macros which make it easier for plugins to instantiate */
61 #define GST_CAPS_NEW(name, type, a...) \
69 #define GST_CAPS_FACTORY(factoryname, a...) \
73 static GstCaps *caps = NULL; \
75 caps = gst_caps_chain (a, NULL); \
80 #define GST_CAPS_GET(fact) (fact)()
83 /* initialize the subsystem */
84 void _gst_caps_initialize (void);
86 GstCaps* gst_caps_new (const gchar *name, const gchar *mime, GstProps *props);
87 GstCaps* gst_caps_new_id (const gchar *name, const guint16 id, GstProps *props);
89 GstCaps* gst_caps_unref (GstCaps *caps);
90 GstCaps* gst_caps_ref (GstCaps *caps);
91 void gst_caps_destroy (GstCaps *caps);
93 void gst_caps_debug (GstCaps *caps, const gchar *label);
95 GstCaps* gst_caps_copy (GstCaps *caps);
96 GstCaps* gst_caps_copy_1 (GstCaps *caps);
97 GstCaps* gst_caps_copy_on_write (GstCaps *caps);
99 const gchar* gst_caps_get_name (GstCaps *caps);
100 void gst_caps_set_name (GstCaps *caps, const gchar *name);
102 const gchar* gst_caps_get_mime (GstCaps *caps);
103 void gst_caps_set_mime (GstCaps *caps, const gchar *mime);
105 guint16 gst_caps_get_type_id (GstCaps *caps);
106 void gst_caps_set_type_id (GstCaps *caps, guint16 type_id);
108 GstCaps* gst_caps_set_props (GstCaps *caps, GstProps *props);
109 GstProps* gst_caps_get_props (GstCaps *caps);
111 #define gst_caps_set(caps, name, args...) gst_props_set ((caps)->properties, name, ##args)
112 #define gst_caps_get(caps, name, args...) gst_props_get ((caps)->properties, name, ##args)
114 #define gst_caps_get_int(caps,name,res) gst_props_entry_get_int(gst_props_get_entry((caps)->properties,name),res)
115 #define gst_caps_get_float(caps,name,res) gst_props_entry_get_float(gst_props_get_entry((caps)->properties,name),res)
116 #define gst_caps_get_fourcc_int(caps,name,res) gst_props_entry_get_fourcc_int(gst_props_get_entry((caps)->properties,name),res)
117 #define gst_caps_get_boolean(caps,name,res) gst_props_entry_get_boolean(gst_props_get_entry((caps)->properties,name),res)
118 #define gst_caps_get_string(caps,name,res) gst_props_entry_get_string(gst_props_get_entry((caps)->properties,name),res)
120 #define gst_caps_has_property(caps, name) gst_props_has_property ((caps)->properties, name)
121 #define gst_caps_has_property_typed(caps, name, type) gst_props_has_property_typed ((caps)->properties, name, type)
122 #define gst_caps_has_fixed_property(caps, name) gst_props_has_fixed_property ((caps)->properties, name)
124 GstCaps* gst_caps_get_by_name (GstCaps *caps, const gchar *name);
126 GstCaps* gst_caps_chain (GstCaps *caps, ...);
127 GstCaps* gst_caps_append (GstCaps *caps, GstCaps *capstoadd);
128 GstCaps* gst_caps_prepend (GstCaps *caps, GstCaps *capstoadd);
130 gboolean gst_caps_check_compatibility (GstCaps *fromcaps, GstCaps *tocaps);
131 GstCaps* gst_caps_intersect (GstCaps *caps1, GstCaps *caps2);
132 GstCaps* gst_caps_normalize (GstCaps *caps);
134 #ifndef GST_DISABLE_LOADSAVE
135 xmlNodePtr gst_caps_save_thyself (GstCaps *caps, xmlNodePtr parent);
136 GstCaps* gst_caps_load_thyself (xmlNodePtr parent);
141 #endif /* __GST_CAPS_H__ */