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);
50 gst_plugin_feature_class_init (GstPluginFeatureClass * klass)
52 G_OBJECT_CLASS (klass)->finalize = gst_plugin_feature_finalize;
56 gst_plugin_feature_init (GstPluginFeature * feature)
58 /* do nothing, needed because of G_DEFINE_TYPE */
62 gst_plugin_feature_finalize (GObject * object)
64 GstPluginFeature *feature = GST_PLUGIN_FEATURE_CAST (object);
66 GST_DEBUG ("finalizing feature %p: '%s'", feature,
67 GST_PLUGIN_FEATURE_NAME (feature));
69 if (feature->plugin != NULL) {
70 g_object_remove_weak_pointer ((GObject *) feature->plugin,
71 (gpointer *) & feature->plugin);
74 G_OBJECT_CLASS (gst_plugin_feature_parent_class)->finalize (object);
78 * gst_plugin_feature_load:
79 * @feature: (transfer none): the plugin feature to check
81 * Loads the plugin containing @feature if it's not already loaded. @feature is
82 * unaffected; use the return value instead.
84 * Normally this function is used like this:
86 * GstPluginFeature *loaded_feature;
88 * loaded_feature = gst_plugin_feature_load (feature);
89 * // presumably, we're no longer interested in the potentially-unloaded feature
90 * gst_object_unref (feature);
91 * feature = loaded_feature;
94 * Returns: (transfer full): a reference to the loaded feature, or NULL on error
97 gst_plugin_feature_load (GstPluginFeature * feature)
100 GstPluginFeature *real_feature;
102 g_return_val_if_fail (feature != NULL, FALSE);
103 g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), FALSE);
105 GST_DEBUG ("loading plugin for feature %p; '%s'", feature,
106 GST_PLUGIN_FEATURE_NAME (feature));
108 return gst_object_ref (feature);
110 GST_DEBUG ("loading plugin %s", feature->plugin_name);
111 plugin = gst_plugin_load_by_name (feature->plugin_name);
115 GST_DEBUG ("loaded plugin %s", feature->plugin_name);
116 gst_object_unref (plugin);
119 gst_registry_lookup_feature (gst_registry_get_default (), feature->name);
121 if (real_feature == NULL)
123 else if (!real_feature->loaded)
131 GST_WARNING ("Failed to load plugin containing feature '%s'.",
132 GST_PLUGIN_FEATURE_NAME (feature));
138 ("Loaded plugin containing feature '%s', but feature disappeared.",
144 GST_INFO ("Tried to load plugin containing feature '%s', but feature was "
145 "not found.", real_feature->name);
151 * gst_plugin_feature_type_name_filter:
152 * @feature: the #GstPluginFeature
153 * @data: (in): the type and name to check against
155 * Compares type and name of plugin feature. Can be used with gst_filter_run().
157 * Returns: TRUE if equal.
160 gst_plugin_feature_type_name_filter (GstPluginFeature * feature,
161 GstTypeNameData * data)
163 g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), FALSE);
165 return ((data->type == 0 || data->type == G_OBJECT_TYPE (feature)) &&
167 || !strcmp (data->name, GST_PLUGIN_FEATURE_NAME (feature))));
171 * gst_plugin_feature_set_name:
172 * @feature: a feature
173 * @name: the name to set
175 * Sets the name of a plugin feature. The name uniquely identifies a feature
176 * within all features of the same type. Renaming a plugin feature is not
177 * allowed. A copy is made of the name so you should free the supplied @name
178 * after calling this function.
181 gst_plugin_feature_set_name (GstPluginFeature * feature, const gchar * name)
183 g_return_if_fail (GST_IS_PLUGIN_FEATURE (feature));
184 g_return_if_fail (name != NULL);
186 if (G_UNLIKELY (feature->name)) {
187 g_return_if_fail (strcmp (feature->name, name) == 0);
189 gst_object_set_name (GST_OBJECT (feature), name);
190 feature->name = GST_OBJECT_NAME (GST_OBJECT (feature));
195 * gst_plugin_feature_get_name:
196 * @feature: a feature
198 * Gets the name of a plugin feature.
203 gst_plugin_feature_get_name (GstPluginFeature * feature)
205 g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), NULL);
207 return feature->name;
211 * gst_plugin_feature_set_rank:
212 * @feature: feature to rank
213 * @rank: rank value - higher number means more priority rank
215 * Specifies a rank for a plugin feature, so that autoplugging uses
216 * the most appropriate feature.
219 gst_plugin_feature_set_rank (GstPluginFeature * feature, guint rank)
221 g_return_if_fail (feature != NULL);
222 g_return_if_fail (GST_IS_PLUGIN_FEATURE (feature));
224 feature->rank = rank;
228 * gst_plugin_feature_get_rank:
229 * @feature: a feature
231 * Gets the rank of a plugin feature.
233 * Returns: The rank of the feature
236 gst_plugin_feature_get_rank (GstPluginFeature * feature)
238 g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), GST_RANK_NONE);
240 return feature->rank;
244 * gst_plugin_feature_list_free:
245 * @list: (transfer full) (element-type Gst.PluginFeature): list
246 * of #GstPluginFeature
248 * Unrefs each member of @list, then frees the list.
251 gst_plugin_feature_list_free (GList * list)
255 for (g = list; g; g = g->next) {
256 GstPluginFeature *feature = GST_PLUGIN_FEATURE_CAST (g->data);
258 gst_object_unref (feature);
264 * gst_plugin_feature_list_copy:
265 * @list: (transfer none) (element-type Gst.PluginFeature): list
266 * of #GstPluginFeature
268 * Copies the list of features. Caller should call @gst_plugin_feature_list_free
269 * when done with the list.
271 * Returns: (transfer full) (element-type Gst.PluginFeature): a copy of @list,
272 * with each feature's reference count incremented.
277 gst_plugin_feature_list_copy (GList * list)
279 GList *new_list = NULL;
281 if (G_LIKELY (list)) {
284 new_list = g_list_alloc ();
285 new_list->data = g_object_ref ((GObject *) list->data);
286 new_list->prev = NULL;
290 last->next = g_list_alloc ();
291 last->next->prev = last;
293 last->data = g_object_ref ((GObject *) list->data);
303 * gst_plugin_feature_list_debug:
304 * @list: (transfer none) (element-type Gst.PluginFeature): a #GList of
307 * Debug the plugin feature names in @list.
312 gst_plugin_feature_list_debug (GList * list)
314 #ifndef GST_DISABLE_GST_DEBUG
317 gst_plugin_feature_get_name ((GstPluginFeature *) list->data));
324 * gst_plugin_feature_check_version:
325 * @feature: a feature
326 * @min_major: minimum required major version
327 * @min_minor: minimum required minor version
328 * @min_micro: minimum required micro version
330 * Checks whether the given plugin feature is at least
331 * the required version
333 * Returns: #TRUE if the plugin feature has at least
334 * the required version, otherwise #FALSE.
337 gst_plugin_feature_check_version (GstPluginFeature * feature,
338 guint min_major, guint min_minor, guint min_micro)
340 GstRegistry *registry;
342 gboolean ret = FALSE;
344 g_return_val_if_fail (feature != NULL, FALSE);
345 g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), FALSE);
347 GST_DEBUG ("Looking up plugin '%s' containing plugin feature '%s'",
348 feature->plugin_name, feature->name);
350 registry = gst_registry_get_default ();
351 plugin = gst_registry_find_plugin (registry, feature->plugin_name);
354 const gchar *ver_str;
355 guint major, minor, micro, nano;
358 ver_str = gst_plugin_get_version (plugin);
359 g_return_val_if_fail (ver_str != NULL, FALSE);
361 nscan = sscanf (ver_str, "%u.%u.%u.%u", &major, &minor, µ, &nano);
362 GST_DEBUG ("version string '%s' parsed to %d values", ver_str, nscan);
365 if (major > min_major)
367 else if (major < min_major)
369 else if (minor > min_minor)
371 else if (minor < min_minor)
373 else if (micro > min_micro)
375 /* micro is 1 smaller but we have a nano version, this is the upcomming
376 * release of the requested version and we're ok then */
377 else if (nscan == 4 && nano > 0 && (micro + 1 == min_micro))
380 ret = (micro == min_micro);
382 GST_DEBUG ("Checking whether %u.%u.%u >= %u.%u.%u? %s", major, minor,
383 micro, min_major, min_minor, min_micro, (ret) ? "yes" : "no");
385 GST_WARNING ("Could not parse version string '%s' of plugin '%s'",
386 ver_str, feature->plugin_name);
389 gst_object_unref (plugin);
391 GST_DEBUG ("Could not find plugin '%s'", feature->plugin_name);
398 * gst_plugin_feature_rank_compare_func:
399 * @p1: a #GstPluginFeature
400 * @p2: a #GstPluginFeature
402 * Compares the two given #GstPluginFeature instances. This function can be
403 * used as a #GCompareFunc when sorting by rank and then by name.
405 * Returns: negative value if the rank of p1 > the rank of p2 or the ranks are
406 * equal but the name of p1 comes before the name of p2; zero if the rank
407 * and names are equal; positive value if the rank of p1 < the rank of p2 or the
408 * ranks are equal but the name of p2 comes after the name of p1
413 gst_plugin_feature_rank_compare_func (gconstpointer p1, gconstpointer p2)
415 GstPluginFeature *f1, *f2;
418 f1 = (GstPluginFeature *) p1;
419 f2 = (GstPluginFeature *) p2;
421 diff = f2->rank - f1->rank;
425 diff = strcmp (f2->name, f1->name);