2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
5 * gstpluginfeature.h: Header for base GstPluginFeature
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_PLUGIN_FEATURE_H__
25 #define __GST_PLUGIN_FEATURE_H__
27 #include <glib-object.h>
28 #include <gst/gstobject.h>
29 #include <gst/gstplugin.h>
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 typedef struct _GstPluginFeature GstPluginFeature;
42 typedef struct _GstPluginFeatureClass GstPluginFeatureClass;
46 * @GST_RANK_NONE: will be chosen last or not at all
47 * @GST_RANK_MARGINAL: unlikly to be chosen
48 * @GST_RANK_SECONDARY: likely to be chosen
49 * @GST_RANK_PRIMARY: will be chosen first
51 * Element priority ranks. Defines the order in which the autoplugger (or
52 * similar rank-picking mechanisms, such as e.g. gst_element_make_from_uri())
53 * will choose this element over an alternative one with the same function.
55 * These constants serve as a rough guidance for defining the rank of a
56 * #GstPluginFeature. Any value is valid, including values bigger than
61 GST_RANK_MARGINAL = 64,
62 GST_RANK_SECONDARY = 128,
63 GST_RANK_PRIMARY = 256
67 * gst_plugin_feature_get_name:
68 * @feature: a #GstPluginFeature to get the name of @feature.
70 * Returns a copy of the name of @feature.
71 * Caller should g_free() the return value after usage.
72 * For a nameless plugin feature, this returns NULL, which you can safely g_free()
75 * Returns: (transfer full): the name of @feature. g_free() after usage. MT safe.
78 #define gst_plugin_feature_get_name(feature) gst_object_get_name(GST_OBJECT_CAST(feature))
81 * gst_plugin_feature_set_name:
82 * @feature: a #GstPluginFeature to set the name of.
85 * Sets the name of the plugin feature, getting rid of the old name if there was one.
87 #define gst_plugin_feature_set_name(feature,name) gst_object_set_name(GST_OBJECT_CAST(feature),name)
92 * Opaque #GstPluginFeature structure.
94 struct _GstPluginFeature {
101 const gchar *plugin_name;
102 GstPlugin *plugin; /* weak ref */
105 gpointer _gst_reserved[GST_PADDING - 1];
108 struct _GstPluginFeatureClass {
109 GstObjectClass parent_class;
112 gpointer _gst_reserved[GST_PADDING];
120 * Structure used for filtering based on @name and @type.
128 * GstPluginFeatureFilter:
129 * @feature: the pluginfeature to check
130 * @user_data: the user_data that has been passed on e.g.
131 * gst_registry_feature_filter()
133 * A function that can be used with e.g. gst_registry_feature_filter()
134 * to get a list of pluginfeature that match certain criteria.
136 * Returns: %TRUE for a positive match, %FALSE otherwise
138 typedef gboolean (*GstPluginFeatureFilter) (GstPluginFeature *feature,
141 /* normal GObject stuff */
142 GType gst_plugin_feature_get_type (void);
145 gst_plugin_feature_load (GstPluginFeature *feature);
147 gboolean gst_plugin_feature_type_name_filter (GstPluginFeature *feature,
148 GstTypeNameData *data);
150 void gst_plugin_feature_set_rank (GstPluginFeature *feature, guint rank);
151 guint gst_plugin_feature_get_rank (GstPluginFeature *feature);
153 void gst_plugin_feature_list_free (GList *list);
154 GList *gst_plugin_feature_list_copy (GList *list);
155 void gst_plugin_feature_list_debug (GList *list);
158 * GST_PLUGIN_FEATURE_LIST_DEBUG:
159 * @list: (transfer none) (element-type Gst.PluginFeature): a #GList of
162 * Debug the plugin feature names in @list.
166 #ifndef GST_DISABLE_GST_DEBUG
167 #define GST_PLUGIN_FEATURE_LIST_DEBUG(list) gst_plugin_feature_list_debug(list)
169 #define GST_PLUGIN_FEATURE_LIST_DEBUG(list)
172 gboolean gst_plugin_feature_check_version (GstPluginFeature *feature,
176 gint gst_plugin_feature_rank_compare_func (gconstpointer p1,
182 #endif /* __GST_PLUGIN_FEATURE_H__ */