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 =
 118       gst_registry_lookup_feature (gst_registry_get_default (),
 119       GST_OBJECT_NAME (feature));
 120
 121   if (real_feature == NULL)
 122     goto disappeared;
 123   else if (!real_feature->loaded)
 124     goto not_found;
 125
 126   return real_feature;
 127
 128   /* ERRORS */
 129 load_failed:
 130   {
 131     GST_WARNING ("Failed to load plugin containing feature '%s'.",
 132         GST_OBJECT_NAME (feature));
 133     return NULL;
 134   }
 135 disappeared:
 136   {
 137     GST_INFO
 138         ("Loaded plugin containing feature '%s', but feature disappeared.",
 139         GST_OBJECT_NAME (feature));
 140     return NULL;
 141   }
 142 not_found:
 143   {
 144     GST_INFO ("Tried to load plugin containing feature '%s', but feature was "
 145         "not found.", GST_OBJECT_NAME (real_feature));
 146     return NULL;
 147   }
 148 }
 149
 150 /**
 151  * gst_plugin_feature_type_name_filter:
 152  * @feature: the #GstPluginFeature
 153  * @data: (in): the type and name to check against
 154  *
 155  * Compares type and name of plugin feature. Can be used with gst_filter_run().
 156  *
 157  * Returns: TRUE if equal.
 158  */
 159 gboolean
 160 gst_plugin_feature_type_name_filter (GstPluginFeature * feature,
 161     GstTypeNameData * data)
 162 {
 163   g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), FALSE);
 164
 165   return ((data->type == 0 || data->type == G_OBJECT_TYPE (feature)) &&
 166       (data->name == NULL || !strcmp (data->name, GST_OBJECT_NAME (feature))));
 167 }
 168
 169 /**
 170  * gst_plugin_feature_set_rank:
 171  * @feature: feature to rank
 172  * @rank: rank value - higher number means more priority rank
 173  *
 174  * Specifies a rank for a plugin feature, so that autoplugging uses
 175  * the most appropriate feature.
 176  */
 177 void
 178 gst_plugin_feature_set_rank (GstPluginFeature * feature, guint rank)
 179 {
 180   g_return_if_fail (feature != NULL);
 181   g_return_if_fail (GST_IS_PLUGIN_FEATURE (feature));
 182
 183   feature->rank = rank;
 184 }
 185
 186 /**
 187  * gst_plugin_feature_get_rank:
 188  * @feature: a feature
 189  *
 190  * Gets the rank of a plugin feature.
 191  *
 192  * Returns: The rank of the feature
 193  */
 194 guint
 195 gst_plugin_feature_get_rank (GstPluginFeature * feature)
 196 {
 197   g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), GST_RANK_NONE);
 198
 199   return feature->rank;
 200 }
 201
 202 /**
 203  * gst_plugin_feature_list_free:
 204  * @list: (transfer full) (element-type Gst.PluginFeature): list
 205  *     of #GstPluginFeature
 206  *
 207  * Unrefs each member of @list, then frees the list.
 208  */
 209 void
 210 gst_plugin_feature_list_free (GList * list)
 211 {
 212   GList *g;
 213
 214   for (g = list; g; g = g->next) {
 215     GstPluginFeature *feature = GST_PLUGIN_FEATURE_CAST (g->data);
 216
 217     gst_object_unref (feature);
 218   }
 219   g_list_free (list);
 220 }
 221
 222 /**
 223  * gst_plugin_feature_list_copy:
 224  * @list: (transfer none) (element-type Gst.PluginFeature): list
 225  *     of #GstPluginFeature
 226  *
 227  * Copies the list of features. Caller should call @gst_plugin_feature_list_free
 228  * when done with the list.
 229  *
 230  * Returns: (transfer full) (element-type Gst.PluginFeature): a copy of @list,
 231  *     with each feature's reference count incremented.
 232  *
 233  * Since: 0.10.26
 234  */
 235 GList *
 236 gst_plugin_feature_list_copy (GList * list)
 237 {
 238   GList *new_list = NULL;
 239
 240   if (G_LIKELY (list)) {
 241     GList *last;
 242
 243     new_list = g_list_alloc ();
 244     new_list->data = g_object_ref ((GObject *) list->data);
 245     new_list->prev = NULL;
 246     last = new_list;
 247     list = list->next;
 248     while (list) {
 249       last->next = g_list_alloc ();
 250       last->next->prev = last;
 251       last = last->next;
 252       last->data = g_object_ref ((GObject *) list->data);
 253       list = list->next;
 254     }
 255     last->next = NULL;
 256   }
 257
 258   return new_list;
 259 }
 260
 261 /**
 262  * gst_plugin_feature_list_debug:
 263  * @list: (transfer none) (element-type Gst.PluginFeature): a #GList of
 264  *     plugin features
 265  *
 266  * Debug the plugin feature names in @list.
 267  *
 268  * Since: 0.10.31
 269  */
 270 void
 271 gst_plugin_feature_list_debug (GList * list)
 272 {
 273 #ifndef GST_DISABLE_GST_DEBUG
 274   while (list) {
 275     GST_DEBUG ("%s",
 276         gst_plugin_feature_get_name ((GstPluginFeature *) list->data));
 277     list = list->next;
 278   }
 279 #endif
 280 }
 281
 282 /**
 283  * gst_plugin_feature_check_version:
 284  * @feature: a feature
 285  * @min_major: minimum required major version
 286  * @min_minor: minimum required minor version
 287  * @min_micro: minimum required micro version
 288  *
 289  * Checks whether the given plugin feature is at least
 290  *  the required version
 291  *
 292  * Returns: #TRUE if the plugin feature has at least
 293  *  the required version, otherwise #FALSE.
 294  */
 295 gboolean
 296 gst_plugin_feature_check_version (GstPluginFeature * feature,
 297     guint min_major, guint min_minor, guint min_micro)
 298 {
 299   GstRegistry *registry;
 300   GstPlugin *plugin;
 301   gboolean ret = FALSE;
 302
 303   g_return_val_if_fail (feature != NULL, FALSE);
 304   g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), FALSE);
 305
 306   GST_DEBUG ("Looking up plugin '%s' containing plugin feature '%s'",
 307       feature->plugin_name, GST_OBJECT_NAME (feature));
 308
 309   registry = gst_registry_get_default ();
 310   plugin = gst_registry_find_plugin (registry, feature->plugin_name);
 311
 312   if (plugin) {
 313     const gchar *ver_str;
 314     guint major, minor, micro, nano;
 315     gint nscan;
 316
 317     ver_str = gst_plugin_get_version (plugin);
 318     g_return_val_if_fail (ver_str != NULL, FALSE);
 319
 320     nscan = sscanf (ver_str, "%u.%u.%u.%u", &major, &minor, &micro, &nano);
 321     GST_DEBUG ("version string '%s' parsed to %d values", ver_str, nscan);
 322
 323     if (nscan >= 3) {
 324       if (major > min_major)
 325         ret = TRUE;
 326       else if (major < min_major)
 327         ret = FALSE;
 328       else if (minor > min_minor)
 329         ret = TRUE;
 330       else if (minor < min_minor)
 331         ret = FALSE;
 332       else if (micro > min_micro)
 333         ret = TRUE;
 334       /* micro is 1 smaller but we have a nano version, this is the upcoming
 335        * release of the requested version and we're ok then */
 336       else if (nscan == 4 && nano > 0 && (micro + 1 == min_micro))
 337         ret = TRUE;
 338       else
 339         ret = (micro == min_micro);
 340
 341       GST_DEBUG ("Checking whether %u.%u.%u >= %u.%u.%u? %s", major, minor,
 342           micro, min_major, min_minor, min_micro, (ret) ? "yes" : "no");
 343     } else {
 344       GST_WARNING ("Could not parse version string '%s' of plugin '%s'",
 345           ver_str, feature->plugin_name);
 346     }
 347
 348     gst_object_unref (plugin);
 349   } else {
 350     GST_DEBUG ("Could not find plugin '%s'", feature->plugin_name);
 351   }
 352
 353   return ret;
 354 }
 355
 356 /**
 357  * gst_plugin_feature_rank_compare_func:
 358  * @p1: a #GstPluginFeature
 359  * @p2: a #GstPluginFeature
 360  *
 361  * Compares the two given #GstPluginFeature instances. This function can be
 362  * used as a #GCompareFunc when sorting by rank and then by name.
 363  *
 364  * Returns: negative value if the rank of p1 > the rank of p2 or the ranks are
 365  * equal but the name of p1 comes before the name of p2; zero if the rank
 366  * and names are equal; positive value if the rank of p1 < the rank of p2 or the
 367  * ranks are equal but the name of p2 comes after the name of p1
 368  *
 369  * Since: 0.10.31
 370  */
 371 gint
 372 gst_plugin_feature_rank_compare_func (gconstpointer p1, gconstpointer p2)
 373 {
 374   GstPluginFeature *f1, *f2;
 375   gint diff;
 376
 377   f1 = (GstPluginFeature *) p1;
 378   f2 = (GstPluginFeature *) p2;
 379
 380   diff = f2->rank - f1->rank;
 381   if (diff != 0)
 382     return diff;
 383
 384   diff = strcmp (GST_OBJECT_NAME (f2), GST_OBJECT_NAME (f1));
 385
 386   return diff;
 387 }