caps: Add new data type for handling caps features to the caps
[platform/upstream/gstreamer.git] / gst / gstcapsfeatures.h
1 /* GStreamer
2  * Copyright (C) 2013 Collabora Ltd.
3  *   Author: Sebastian Dröge <sebastian.droege@collabora.co.uk>
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public
16  * License along with this library; if not, write to the
17  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  */
20
21 #ifndef __GST_CAPS_FEATURES_H__
22 #define __GST_CAPS_FEATURES_H__
23
24 #include <gst/gstconfig.h>
25 #include <gst/glib-compat.h>
26
27 G_BEGIN_DECLS
28
29 typedef struct _GstCapsFeatures GstCapsFeatures;
30
31 #define GST_TYPE_CAPS_FEATURES (gst_caps_features_get_type ())
32 #define GST_IS_CAPS_FEATURES(object)       (gst_is_caps_features(object))
33 #define GST_CAPS_FEATURES_CAST(object)     ((GstCapsFeatures *)(object))
34 #define GST_CAPS_FEATURES(object)          (GST_CAPS_FEATURES_CAST(object))
35
36 #define GST_CAPS_FEATURE_MEMORY_SYSTEM_MEMORY "memory:SystemMemory"
37
38 GST_EXPORT GstCapsFeatures *_gst_caps_features_memory_system_memory;
39 #define GST_CAPS_FEATURES_MEMORY_SYSTEM_MEMORY (_gst_caps_features_memory_system_memory)
40
41 GType             gst_caps_features_get_type (void);
42 gboolean          gst_is_caps_features (gconstpointer obj);
43
44 GstCapsFeatures * gst_caps_features_new_empty (void);
45 GstCapsFeatures * gst_caps_features_new (const gchar *feature1, ...);
46 GstCapsFeatures * gst_caps_features_new_valist (const gchar *feature1, va_list varargs);
47 GstCapsFeatures * gst_caps_features_new_id (GQuark feature1, ...);
48 GstCapsFeatures * gst_caps_features_new_id_valist (GQuark feature1, va_list varargs);
49
50 gboolean          gst_caps_features_set_parent_refcount  (GstCapsFeatures *features, gint * refcount);
51
52 GstCapsFeatures * gst_caps_features_copy (const GstCapsFeatures * features);
53 void              gst_caps_features_free (GstCapsFeatures * features);
54
55 gchar *           gst_caps_features_to_string (const GstCapsFeatures * features);
56 GstCapsFeatures * gst_caps_features_from_string (const gchar * features);
57
58 guint             gst_caps_features_get_size (const GstCapsFeatures * features);
59 const gchar *     gst_caps_features_get_nth (const GstCapsFeatures * features, guint i);
60 GQuark            gst_caps_features_get_nth_id (const GstCapsFeatures * features, guint i);
61
62 gboolean          gst_caps_features_contains (const GstCapsFeatures * features, const gchar * feature);
63 gboolean          gst_caps_features_contains_id (const GstCapsFeatures * features, GQuark feature);
64 gboolean          gst_caps_features_is_equal (const GstCapsFeatures * features1, const GstCapsFeatures * features2);
65
66 void              gst_caps_features_add (GstCapsFeatures * features, const gchar * feature);
67 void              gst_caps_features_add_id ( GstCapsFeatures * features, GQuark feature);
68
69 void              gst_caps_features_remove (GstCapsFeatures * features, const gchar * feature);
70 void              gst_caps_features_remove_id (GstCapsFeatures * features, GQuark feature);
71
72 G_END_DECLS
73
74 #endif /* __GST_CAPS_FEATURES_H__ */