1 /* GStreamer
2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
4 *
5 * gstpluginfeature.h: Header for base GstPluginFeature
6 *
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.
11 *
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.
16 *
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.
21 */
24 #ifndef __GST_PLUGIN_FEATURE_H__
25 #define __GST_PLUGIN_FEATURE_H__
27 #include <glib-object.h>
28 #include <gst/gstobject.h>
29 #include <gst/gstplugin.h>
31 G_BEGIN_DECLS
33 #define GST_TYPE_PLUGIN_FEATURE (gst_plugin_feature_get_type())
34 #define GST_PLUGIN_FEATURE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PLUGIN_FEATURE, GstPluginFeature))
35 #define GST_IS_PLUGIN_FEATURE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PLUGIN_FEATURE))
36 #define GST_PLUGIN_FEATURE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PLUGIN_FEATURE, GstPluginFeatureClass))
37 #define GST_IS_PLUGIN_FEATURE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PLUGIN_FEATURE))
38 #define GST_PLUGIN_FEATURE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_PLUGIN_FEATURE, GstPluginFeatureClass))
39 #define GST_PLUGIN_FEATURE_CAST(obj) ((GstPluginFeature*)(obj))
41 /**
42 * GST_PLUGIN_FEATURE_NAME:
43 * @feature: The feature to query
44 *
45 * Get the name of the feature
46 */
47 #define GST_PLUGIN_FEATURE_NAME(feature) (GST_PLUGIN_FEATURE (feature)->name)
49 typedef struct _GstPluginFeature GstPluginFeature;
50 typedef struct _GstPluginFeatureClass GstPluginFeatureClass;
52 /**
53 * GstRank:
54 * @GST_RANK_NONE: will be chosen last or not at all
55 * @GST_RANK_MARGINAL: unlikly to be chosen
56 * @GST_RANK_SECONDARY: likely to be chosen
57 * @GST_RANK_PRIMARY: will be chosen first
58 *
59 * Element priority ranks. Defines the order in which the autoplugger (or
60 * similar rank-picking mechanisms, such as e.g. gst_element_make_from_uri())
61 * will choose this element over an alternative one with the same function.
62 *
63 * These constants serve as a rough guidance for defining the rank of a
64 * #GstPluginFeature. Any value is valid, including values bigger than
65 * @GST_RANK_PRIMARY.
66 */
67 typedef enum {
68 GST_RANK_NONE = 0,
69 GST_RANK_MARGINAL = 64,
70 GST_RANK_SECONDARY = 128,
71 GST_RANK_PRIMARY = 256
72 } GstRank;
74 /**
75 * GstPluginFeature:
76 *
77 * Opaque #GstPluginFeature structure.
78 */
79 struct _GstPluginFeature {
80 GstObject object;
82 /*< private >*/
83 gboolean loaded;
84 gchar *name; /* FIXME-0.11: remove variable, we use GstObject:name */
85 guint rank;
87 const gchar *plugin_name;
88 GstPlugin *plugin; /* weak ref */
90 /*< private >*/
91 gpointer _gst_reserved[GST_PADDING - 1];
92 };
94 struct _GstPluginFeatureClass {
95 GstObjectClass parent_class;
97 /*< private >*/
98 gpointer _gst_reserved[GST_PADDING];
99 };
101 /**
102 * GstTypeNameData:
103 * @name: a name
104 * @type: a GType
105 *
106 * Structure used for filtering based on @name and @type.
107 */
108 typedef struct {
109 const gchar *name;
110 GType type;
111 } GstTypeNameData;
113 /**
114 * GstPluginFeatureFilter:
115 * @feature: the pluginfeature to check
116 * @user_data: the user_data that has been passed on e.g.
117 * gst_registry_feature_filter()
118 *
119 * A function that can be used with e.g. gst_registry_feature_filter()
120 * to get a list of pluginfeature that match certain criteria.
121 *
122 * Returns: %TRUE for a positive match, %FALSE otherwise
123 */
124 typedef gboolean (*GstPluginFeatureFilter) (GstPluginFeature *feature,
125 gpointer user_data);
127 /* normal GObject stuff */
128 GType gst_plugin_feature_get_type (void);
130 GstPluginFeature *
131 gst_plugin_feature_load (GstPluginFeature *feature);
133 gboolean gst_plugin_feature_type_name_filter (GstPluginFeature *feature,
134 GstTypeNameData *data);
136 void gst_plugin_feature_set_rank (GstPluginFeature *feature, guint rank);
137 void gst_plugin_feature_set_name (GstPluginFeature *feature, const gchar *name);
138 guint gst_plugin_feature_get_rank (GstPluginFeature *feature);
139 const gchar *gst_plugin_feature_get_name (GstPluginFeature *feature);
141 void gst_plugin_feature_list_free (GList *list);
142 GList *gst_plugin_feature_list_copy (GList *list);
143 void gst_plugin_feature_list_debug (GList *list);
145 /**
146 * GST_PLUGIN_FEATURE_LIST_DEBUG:
147 * @list: (transfer none) (element-type Gst.PluginFeature): a #GList of
148 * plugin features
149 *
150 * Debug the plugin feature names in @list.
151 *
152 * Since: 0.10.31
153 */
154 #ifndef GST_DISABLE_GST_DEBUG
155 #define GST_PLUGIN_FEATURE_LIST_DEBUG(list) gst_plugin_feature_list_debug(list)
156 #else
157 #define GST_PLUGIN_FEATURE_LIST_DEBUG(list)
158 #endif
160 gboolean gst_plugin_feature_check_version (GstPluginFeature *feature,
161 guint min_major,
162 guint min_minor,
163 guint min_micro);
164 gint gst_plugin_feature_rank_compare_func (gconstpointer p1,
165 gconstpointer p2);
167 G_END_DECLS
170 #endif /* __GST_PLUGIN_FEATURE_H__ */