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"
41 #define GST_CAT_DEFAULT GST_CAT_PLUGIN_LOADING
43 static void gst_plugin_feature_finalize (GObject * object);
45 /* static guint gst_plugin_feature_signals[LAST_SIGNAL] = { 0 }; */
47 G_DEFINE_ABSTRACT_TYPE (GstPluginFeature, gst_plugin_feature, GST_TYPE_OBJECT);
48 static GstObjectClass *parent_class = NULL;
51 gst_plugin_feature_class_init (GstPluginFeatureClass * klass)
53 parent_class = g_type_class_peek_parent (klass);
55 G_OBJECT_CLASS (klass)->finalize = 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 g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), FALSE);
164 return ((data->type == 0 || data->type == G_OBJECT_TYPE (feature)) &&
166 || !strcmp (data->name, GST_PLUGIN_FEATURE_NAME (feature))));
170 * gst_plugin_feature_set_name:
171 * @feature: a feature
172 * @name: the name to set
174 * Sets the name of a plugin feature. The name uniquely identifies a feature
175 * within all features of the same type. Renaming a plugin feature is not
176 * allowed. A copy is made of the name so you should free the supplied @name
177 * after calling this function.
180 gst_plugin_feature_set_name (GstPluginFeature * feature, const gchar * name)
182 g_return_if_fail (GST_IS_PLUGIN_FEATURE (feature));
183 g_return_if_fail (name != NULL);
186 g_return_if_fail (strcmp (feature->name, name) == 0);
188 feature->name = g_strdup (name);
190 gst_object_set_name (GST_OBJECT_CAST (feature), feature->name);
194 * gst_plugin_feature_get_name:
195 * @feature: a feature
197 * Gets the name of a plugin feature.
201 G_CONST_RETURN gchar *
202 gst_plugin_feature_get_name (GstPluginFeature * feature)
204 g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), NULL);
206 return feature->name;
210 * gst_plugin_feature_set_rank:
211 * @feature: feature to rank
212 * @rank: rank value - higher number means more priority rank
214 * Specifies a rank for a plugin feature, so that autoplugging uses
215 * the most appropriate feature.
218 gst_plugin_feature_set_rank (GstPluginFeature * feature, guint rank)
220 g_return_if_fail (feature != NULL);
221 g_return_if_fail (GST_IS_PLUGIN_FEATURE (feature));
223 feature->rank = rank;
227 * gst_plugin_feature_get_rank:
228 * @feature: a feature
230 * Gets the rank of a plugin feature.
232 * Returns: The rank of the feature
235 gst_plugin_feature_get_rank (GstPluginFeature * feature)
237 g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), GST_RANK_NONE);
239 return feature->rank;
243 * gst_plugin_feature_list_free:
244 * @list: list of #GstPluginFeature
246 * Unrefs each member of @list, then frees the list.
249 gst_plugin_feature_list_free (GList * list)
253 for (g = list; g; g = g->next) {
254 GstPluginFeature *feature = GST_PLUGIN_FEATURE_CAST (g->data);
256 gst_object_unref (feature);
262 * gst_plugin_feature_list_copy:
263 * @list: list of #GstPluginFeature
265 * Copies the list of features. Caller should call @gst_plugin_feature_list_free
266 * when done with the list.
268 * Returns: a copy of @list, with each feature's reference count incremented.
273 gst_plugin_feature_list_copy (GList * list)
275 GList *new_list = NULL;
277 if (G_LIKELY (list)) {
280 new_list = g_list_alloc ();
281 new_list->data = g_object_ref ((GObject *) list->data);
282 new_list->prev = NULL;
286 last->next = g_list_alloc ();
287 last->next->prev = last;
289 last->data = g_object_ref ((GObject *) list->data);
299 * gst_plugin_feature_check_version:
300 * @feature: a feature
301 * @min_major: minimum required major version
302 * @min_minor: minimum required minor version
303 * @min_micro: minimum required micro version
305 * Checks whether the given plugin feature is at least
306 * the required version
308 * Returns: #TRUE if the plugin feature has at least
309 * the required version, otherwise #FALSE.
312 gst_plugin_feature_check_version (GstPluginFeature * feature,
313 guint min_major, guint min_minor, guint min_micro)
315 GstRegistry *registry;
317 gboolean ret = FALSE;
319 g_return_val_if_fail (feature != NULL, FALSE);
320 g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), FALSE);
322 GST_DEBUG ("Looking up plugin '%s' containing plugin feature '%s'",
323 feature->plugin_name, feature->name);
325 registry = gst_registry_get_default ();
326 plugin = gst_registry_find_plugin (registry, feature->plugin_name);
329 const gchar *ver_str;
330 guint major, minor, micro, nano;
333 ver_str = gst_plugin_get_version (plugin);
334 g_return_val_if_fail (ver_str != NULL, FALSE);
336 nscan = sscanf (ver_str, "%u.%u.%u.%u", &major, &minor, µ, &nano);
337 GST_DEBUG ("version string '%s' parsed to %d values", ver_str, nscan);
340 if (major > min_major)
342 else if (major < min_major)
344 else if (minor > min_minor)
346 else if (minor < min_minor)
348 else if (micro > min_micro)
350 /* micro is 1 smaller but we have a nano version, this is the upcomming
351 * release of the requested version and we're ok then */
352 else if (nscan == 4 && nano > 0 && (micro + 1 == min_micro))
355 ret = (micro == min_micro);
357 GST_DEBUG ("Checking whether %u.%u.%u >= %u.%u.%u? %s", major, minor,
358 micro, min_major, min_minor, min_micro, (ret) ? "yes" : "no");
360 GST_WARNING ("Could not parse version string '%s' of plugin '%s'",
361 ver_str, feature->plugin_name);
364 gst_object_unref (plugin);
366 GST_DEBUG ("Could not find plugin '%s'", feature->plugin_name);