Merge branch 'master' into 0.11
[platform/upstream/gstreamer.git] / gst / gstpluginfeature.c
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *
5  * gstpluginfeature.c: Abstract base class for all plugin features
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  */
22
23 /**
24  * SECTION:gstpluginfeature
25  * @short_description: Base class for contents of a GstPlugin
26  * @see_also: #GstPlugin
27  *
28  * This is a base class for anything that can be added to a #GstPlugin.
29  */
30
31 #include "gst_private.h"
32
33 #include "gstpluginfeature.h"
34 #include "gstplugin.h"
35 #include "gstregistry.h"
36 #include "gstinfo.h"
37
38 #include <stdio.h>
39 #include <string.h>
40
41 #define GST_CAT_DEFAULT GST_CAT_PLUGIN_LOADING
42
43 static void gst_plugin_feature_finalize (GObject * object);
44
45 /* static guint gst_plugin_feature_signals[LAST_SIGNAL] = { 0 }; */
46
47 G_DEFINE_ABSTRACT_TYPE (GstPluginFeature, gst_plugin_feature, GST_TYPE_OBJECT);
48
49 static void
50 gst_plugin_feature_class_init (GstPluginFeatureClass * klass)
51 {
52   G_OBJECT_CLASS (klass)->finalize = gst_plugin_feature_finalize;
53 }
54
55 static void
56 gst_plugin_feature_init (GstPluginFeature * feature)
57 {
58   /* do nothing, needed because of G_DEFINE_TYPE */
59 }
60
61 static void
62 gst_plugin_feature_finalize (GObject * object)
63 {
64   GstPluginFeature *feature = GST_PLUGIN_FEATURE_CAST (object);
65
66   GST_DEBUG ("finalizing feature %p: '%s'", feature, GST_OBJECT_NAME (feature));
67
68   if (feature->plugin != NULL) {
69     g_object_remove_weak_pointer ((GObject *) feature->plugin,
70         (gpointer *) & feature->plugin);
71   }
72
73   G_OBJECT_CLASS (gst_plugin_feature_parent_class)->finalize (object);
74 }
75
76 /**
77  * gst_plugin_feature_load:
78  * @feature: (transfer none): the plugin feature to check
79  *
80  * Loads the plugin containing @feature if it's not already loaded. @feature is
81  * unaffected; use the return value instead.
82  *
83  * Normally this function is used like this:
84  * |[
85  * GstPluginFeature *loaded_feature;
86  *
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;
91  * ]|
92  *
93  * Returns: (transfer full): a reference to the loaded feature, or NULL on error
94  */
95 GstPluginFeature *
96 gst_plugin_feature_load (GstPluginFeature * feature)
97 {
98   GstPlugin *plugin;
99   GstPluginFeature *real_feature;
100
101   g_return_val_if_fail (feature != NULL, FALSE);
102   g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), FALSE);
103
104   GST_DEBUG ("loading plugin for feature %p; '%s'", feature,
105       GST_OBJECT_NAME (feature));
106   if (feature->loaded)
107     return gst_object_ref (feature);
108
109   GST_DEBUG ("loading plugin %s", feature->plugin_name);
110   plugin = gst_plugin_load_by_name (feature->plugin_name);
111   if (!plugin)
112     goto load_failed;
113
114   GST_DEBUG ("loaded plugin %s", feature->plugin_name);
115   gst_object_unref (plugin);
116
117   real_feature = gst_registry_lookup_feature (gst_registry_get (),
118       GST_OBJECT_NAME (feature));
119
120   if (real_feature == NULL)
121     goto disappeared;
122   else if (!real_feature->loaded)
123     goto not_found;
124
125   return real_feature;
126
127   /* ERRORS */
128 load_failed:
129   {
130     GST_WARNING ("Failed to load plugin containing feature '%s'.",
131         GST_OBJECT_NAME (feature));
132     return NULL;
133   }
134 disappeared:
135   {
136     GST_INFO
137         ("Loaded plugin containing feature '%s', but feature disappeared.",
138         GST_OBJECT_NAME (feature));
139     return NULL;
140   }
141 not_found:
142   {
143     GST_INFO ("Tried to load plugin containing feature '%s', but feature was "
144         "not found.", GST_OBJECT_NAME (real_feature));
145     return NULL;
146   }
147 }
148
149 /**
150  * gst_plugin_feature_set_rank:
151  * @feature: feature to rank
152  * @rank: rank value - higher number means more priority rank
153  *
154  * Specifies a rank for a plugin feature, so that autoplugging uses
155  * the most appropriate feature.
156  */
157 void
158 gst_plugin_feature_set_rank (GstPluginFeature * feature, guint rank)
159 {
160   g_return_if_fail (feature != NULL);
161   g_return_if_fail (GST_IS_PLUGIN_FEATURE (feature));
162
163   feature->rank = rank;
164 }
165
166 /**
167  * gst_plugin_feature_get_rank:
168  * @feature: a feature
169  *
170  * Gets the rank of a plugin feature.
171  *
172  * Returns: The rank of the feature
173  */
174 guint
175 gst_plugin_feature_get_rank (GstPluginFeature * feature)
176 {
177   g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), GST_RANK_NONE);
178
179   return feature->rank;
180 }
181
182 /**
183  * gst_plugin_feature_list_free:
184  * @list: (transfer full) (element-type Gst.PluginFeature): list
185  *     of #GstPluginFeature
186  *
187  * Unrefs each member of @list, then frees the list.
188  */
189 void
190 gst_plugin_feature_list_free (GList * list)
191 {
192   GList *g;
193
194   for (g = list; g; g = g->next) {
195     GstPluginFeature *feature = GST_PLUGIN_FEATURE_CAST (g->data);
196
197     gst_object_unref (feature);
198   }
199   g_list_free (list);
200 }
201
202 /**
203  * gst_plugin_feature_list_copy:
204  * @list: (transfer none) (element-type Gst.PluginFeature): list
205  *     of #GstPluginFeature
206  *
207  * Copies the list of features. Caller should call @gst_plugin_feature_list_free
208  * when done with the list.
209  *
210  * Returns: (transfer full) (element-type Gst.PluginFeature): a copy of @list,
211  *     with each feature's reference count incremented.
212  *
213  * Since: 0.10.26
214  */
215 GList *
216 gst_plugin_feature_list_copy (GList * list)
217 {
218   GList *new_list = NULL;
219
220   if (G_LIKELY (list)) {
221     GList *last;
222
223     new_list = g_list_alloc ();
224     new_list->data = g_object_ref ((GObject *) list->data);
225     new_list->prev = NULL;
226     last = new_list;
227     list = list->next;
228     while (list) {
229       last->next = g_list_alloc ();
230       last->next->prev = last;
231       last = last->next;
232       last->data = g_object_ref ((GObject *) list->data);
233       list = list->next;
234     }
235     last->next = NULL;
236   }
237
238   return new_list;
239 }
240
241 /**
242  * gst_plugin_feature_list_debug:
243  * @list: (transfer none) (element-type Gst.PluginFeature): a #GList of
244  *     plugin features
245  *
246  * Debug the plugin feature names in @list.
247  *
248  * Since: 0.10.31
249  */
250 void
251 gst_plugin_feature_list_debug (GList * list)
252 {
253 #ifndef GST_DISABLE_GST_DEBUG
254   while (list) {
255     GST_DEBUG ("%s",
256         gst_plugin_feature_get_name ((GstPluginFeature *) list->data));
257     list = list->next;
258   }
259 #endif
260 }
261
262 /**
263  * gst_plugin_feature_check_version:
264  * @feature: a feature
265  * @min_major: minimum required major version
266  * @min_minor: minimum required minor version
267  * @min_micro: minimum required micro version
268  *
269  * Checks whether the given plugin feature is at least
270  *  the required version
271  *
272  * Returns: #TRUE if the plugin feature has at least
273  *  the required version, otherwise #FALSE.
274  */
275 gboolean
276 gst_plugin_feature_check_version (GstPluginFeature * feature,
277     guint min_major, guint min_minor, guint min_micro)
278 {
279   GstRegistry *registry;
280   GstPlugin *plugin;
281   gboolean ret = FALSE;
282
283   g_return_val_if_fail (feature != NULL, FALSE);
284   g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), FALSE);
285
286   GST_DEBUG ("Looking up plugin '%s' containing plugin feature '%s'",
287       feature->plugin_name, GST_OBJECT_NAME (feature));
288
289   registry = gst_registry_get ();
290   plugin = gst_registry_find_plugin (registry, feature->plugin_name);
291
292   if (plugin) {
293     const gchar *ver_str;
294     guint major, minor, micro, nano;
295     gint nscan;
296
297     ver_str = gst_plugin_get_version (plugin);
298     g_return_val_if_fail (ver_str != NULL, FALSE);
299
300     nscan = sscanf (ver_str, "%u.%u.%u.%u", &major, &minor, &micro, &nano);
301     GST_DEBUG ("version string '%s' parsed to %d values", ver_str, nscan);
302
303     if (nscan >= 3) {
304       if (major > min_major)
305         ret = TRUE;
306       else if (major < min_major)
307         ret = FALSE;
308       else if (minor > min_minor)
309         ret = TRUE;
310       else if (minor < min_minor)
311         ret = FALSE;
312       else if (micro > min_micro)
313         ret = TRUE;
314       /* micro is 1 smaller but we have a nano version, this is the upcoming
315        * release of the requested version and we're ok then */
316       else if (nscan == 4 && nano > 0 && (micro + 1 == min_micro))
317         ret = TRUE;
318       else
319         ret = (micro == min_micro);
320
321       GST_DEBUG ("Checking whether %u.%u.%u >= %u.%u.%u? %s", major, minor,
322           micro, min_major, min_minor, min_micro, (ret) ? "yes" : "no");
323     } else {
324       GST_WARNING ("Could not parse version string '%s' of plugin '%s'",
325           ver_str, feature->plugin_name);
326     }
327
328     gst_object_unref (plugin);
329   } else {
330     GST_DEBUG ("Could not find plugin '%s'", feature->plugin_name);
331   }
332
333   return ret;
334 }
335
336 /**
337  * gst_plugin_feature_rank_compare_func:
338  * @p1: a #GstPluginFeature
339  * @p2: a #GstPluginFeature
340  *
341  * Compares the two given #GstPluginFeature instances. This function can be
342  * used as a #GCompareFunc when sorting by rank and then by name.
343  *
344  * Returns: negative value if the rank of p1 > the rank of p2 or the ranks are
345  * equal but the name of p1 comes before the name of p2; zero if the rank
346  * and names are equal; positive value if the rank of p1 < the rank of p2 or the
347  * ranks are equal but the name of p2 comes after the name of p1
348  *
349  * Since: 0.10.31
350  */
351 gint
352 gst_plugin_feature_rank_compare_func (gconstpointer p1, gconstpointer p2)
353 {
354   GstPluginFeature *f1, *f2;
355   gint diff;
356
357   f1 = (GstPluginFeature *) p1;
358   f2 = (GstPluginFeature *) p2;
359
360   diff = f2->rank - f1->rank;
361   if (diff != 0)
362     return diff;
363
364   diff = strcmp (GST_OBJECT_NAME (f2), GST_OBJECT_NAME (f1));
365
366   return diff;
367 }