2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
5 * gstpluginfeature.c: Abstract base class for all plugin features
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 * SECTION:gstpluginfeature
25 * @short_description: Base class for contents of a GstPlugin
26 * @see_also: #GstPlugin
28 * This is a base class for anything that can be added to a #GstPlugin.
31 #include "gst_private.h"
33 #include "gstpluginfeature.h"
34 #include "gstplugin.h"
35 #include "gstregistry.h"
40 #define GST_CAT_DEFAULT GST_CAT_PLUGIN_LOADING
42 static void gst_plugin_feature_finalize (GObject * object);
44 /* static guint gst_plugin_feature_signals[LAST_SIGNAL] = { 0 }; */
46 G_DEFINE_ABSTRACT_TYPE (GstPluginFeature, gst_plugin_feature, GST_TYPE_OBJECT);
47 static GstObjectClass *parent_class = NULL;
50 gst_plugin_feature_class_init (GstPluginFeatureClass * klass)
52 parent_class = g_type_class_peek_parent (klass);
54 G_OBJECT_CLASS (klass)->finalize =
55 GST_DEBUG_FUNCPTR (gst_plugin_feature_finalize);
59 gst_plugin_feature_init (GstPluginFeature * feature)
61 /* do nothing, needed because of G_DEFINE_TYPE */
65 gst_plugin_feature_finalize (GObject * object)
67 GstPluginFeature *feature = GST_PLUGIN_FEATURE_CAST (object);
69 GST_DEBUG ("finalizing feature %p: '%s'", feature,
70 GST_PLUGIN_FEATURE_NAME (feature));
71 g_free (feature->name);
73 G_OBJECT_CLASS (parent_class)->finalize (object);
77 * gst_plugin_feature_load:
78 * @feature: the plugin feature to check
80 * Loads the plugin containing @feature if it's not already loaded. @feature is
81 * unaffected; use the return value instead.
83 * Normally this function is used like this:
85 * GstPluginFeature *loaded_feature;
87 * loaded_feature = gst_plugin_feature_load (feature);
88 * // presumably, we're no longer interested in the potentially-unloaded feature
89 * gst_object_unref (feature);
90 * feature = loaded_feature;
93 * Returns: A reference to the loaded feature, or NULL on error.
96 gst_plugin_feature_load (GstPluginFeature * feature)
99 GstPluginFeature *real_feature;
101 g_return_val_if_fail (feature != NULL, FALSE);
102 g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), FALSE);
104 GST_DEBUG ("loading plugin for feature %p; '%s'", feature,
105 GST_PLUGIN_FEATURE_NAME (feature));
107 return gst_object_ref (feature);
109 GST_DEBUG ("loading plugin %s", feature->plugin_name);
110 plugin = gst_plugin_load_by_name (feature->plugin_name);
114 GST_DEBUG ("loaded plugin %s", feature->plugin_name);
115 gst_object_unref (plugin);
118 gst_registry_lookup_feature (gst_registry_get_default (), feature->name);
120 if (real_feature == NULL)
122 else if (!real_feature->loaded)
130 GST_WARNING ("Failed to load plugin containing feature '%s'.",
131 GST_PLUGIN_FEATURE_NAME (feature));
137 ("Loaded plugin containing feature '%s', but feature disappeared.",
143 GST_INFO ("Tried to load plugin containing feature '%s', but feature was "
144 "not found.", real_feature->name);
150 * gst_plugin_feature_type_name_filter:
151 * @feature: the #GstPluginFeature
152 * @data: the type and name to check against
154 * Compares type and name of plugin feature. Can be used with gst_filter_run().
156 * Returns: TRUE if equal.
159 gst_plugin_feature_type_name_filter (GstPluginFeature * feature,
160 GstTypeNameData * data)
162 return ((data->type == 0 || data->type == G_OBJECT_TYPE (feature)) &&
164 || !strcmp (data->name, GST_PLUGIN_FEATURE_NAME (feature))));
168 * gst_plugin_feature_set_name:
169 * @feature: a feature
170 * @name: the name to set
172 * Sets the name of a plugin feature. The name uniquely identifies a feature
173 * within all features of the same type. Renaming a plugin feature is not
174 * allowed. A copy is made of the name so you should free the supplied @name
175 * after calling this function.
178 gst_plugin_feature_set_name (GstPluginFeature * feature, const gchar * name)
180 g_return_if_fail (GST_IS_PLUGIN_FEATURE (feature));
181 g_return_if_fail (name != NULL);
184 g_return_if_fail (strcmp (feature->name, name) == 0);
186 feature->name = g_strdup (name);
188 gst_object_set_name (GST_OBJECT_CAST (feature), feature->name);
192 * gst_plugin_feature_get_name:
193 * @feature: a feature
195 * Gets the name of a plugin feature.
199 G_CONST_RETURN gchar *
200 gst_plugin_feature_get_name (GstPluginFeature * feature)
202 g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), NULL);
204 return feature->name;
208 * gst_plugin_feature_set_rank:
209 * @feature: feature to rank
210 * @rank: rank value - higher number means more priority rank
212 * Specifies a rank for a plugin feature, so that autoplugging uses
213 * the most appropriate feature.
216 gst_plugin_feature_set_rank (GstPluginFeature * feature, guint rank)
218 g_return_if_fail (feature != NULL);
219 g_return_if_fail (GST_IS_PLUGIN_FEATURE (feature));
221 feature->rank = rank;
225 * gst_plugin_feature_get_rank:
226 * @feature: a feature
228 * Gets the rank of a plugin feature.
230 * Returns: The rank of the feature
233 gst_plugin_feature_get_rank (GstPluginFeature * feature)
235 g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), GST_RANK_NONE);
237 return feature->rank;
241 * gst_plugin_feature_list_free:
242 * @list: list of #GstPluginFeature
244 * Unrefs each member of @list, then frees the list.
247 gst_plugin_feature_list_free (GList * list)
251 for (g = list; g; g = g->next) {
252 GstPluginFeature *feature = GST_PLUGIN_FEATURE_CAST (g->data);
254 gst_object_unref (feature);
260 * gst_plugin_feature_check_version:
261 * @feature: a feature
262 * @min_major: minimum required major version
263 * @min_minor: minimum required minor version
264 * @min_micro: minimum required micro version
266 * Checks whether the given plugin feature is at least
267 * the required version
269 * Returns: #TRUE if the plugin feature has at least
270 * the required version, otherwise #FALSE.
273 gst_plugin_feature_check_version (GstPluginFeature * feature,
274 guint min_major, guint min_minor, guint min_micro)
276 GstRegistry *registry;
278 gboolean ret = FALSE;
280 g_return_val_if_fail (feature != NULL, FALSE);
281 g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), FALSE);
283 GST_DEBUG ("Looking up plugin '%s' containing plugin feature '%s'",
284 feature->plugin_name, feature->name);
286 registry = gst_registry_get_default ();
287 plugin = gst_registry_find_plugin (registry, feature->plugin_name);
290 const gchar *ver_str;
291 guint major, minor, micro;
293 ver_str = gst_plugin_get_version (plugin);
294 g_return_val_if_fail (ver_str != NULL, FALSE);
296 if (sscanf (ver_str, "%u.%u.%u", &major, &minor, µ) == 3) {
297 if (major > min_major)
299 else if (major < min_major)
301 else if (minor > min_minor)
303 else if (minor < min_minor)
305 else if (micro > min_micro)
308 ret = (micro == min_micro);
310 GST_DEBUG ("Checking whether %u.%u.%u >= %u.%u.%u? %s", major, minor,
311 micro, min_major, min_minor, min_micro, (ret) ? "yes" : "no");
313 GST_WARNING ("Could not parse version string '%s' of plugin '%s'",
314 ver_str, feature->plugin_name);
317 gst_object_unref (plugin);
319 GST_DEBUG ("Could not find plugin '%s'", feature->plugin_name);