gst/gstplugin.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gstplugin.c: Plugin subsystem for loading elements, types, and libs
   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 #include <sys/types.h>
  24 #include <sys/stat.h>
  25 #include <dirent.h>
  26 #include <unistd.h>
  27
  28 #include "gst_private.h"
  29 #include "gstplugin.h"
  30 #include "gstversion.h"
  31 #include "gstregistrypool.h"
  32 #include "gstlog.h"
  33 #include "config.h"
  34 #include "gstfilter.h"
  35
  36 static GModule *main_module = NULL;
  37 static GList *_gst_plugin_static = NULL;
  38
  39 static GstPlugin*       gst_plugin_register_func        (GstPluginDesc *desc, GstPlugin *plugin,
  40                                                          GModule *module);
  41 GQuark
  42 gst_plugin_error_quark (void)
  43 {
  44   static GQuark quark = 0;
  45   if (!quark)
  46     quark = g_quark_from_static_string ("gst_plugin_error");
  47   return quark;
  48 }
  49
  50 /* this function can be called in the GCC constructor extension, before
  51  * the _gst_plugin_initialize() was called. In that case, we store the
  52  * plugin description in a list to initialize it when we open the main
  53  * module later on.
  54  * When the main module is known, we can register the plugin right away.
  55  * */
  56 void
  57 _gst_plugin_register_static (GstPluginDesc *desc)
  58 {
  59   if (main_module == NULL) {
  60     _gst_plugin_static = g_list_prepend (_gst_plugin_static, desc);
  61   }
  62   else {
  63     GstPlugin *plugin;
  64
  65     plugin = g_new0 (GstPlugin, 1);
  66     plugin->filename = NULL;
  67     plugin->module = NULL;
  68     plugin = gst_plugin_register_func (desc, plugin, main_module);
  69
  70     if (plugin) {
  71       plugin->module = main_module;
  72       gst_registry_pool_add_plugin (plugin);
  73     }
  74   }
  75 }
  76
  77 void
  78 _gst_plugin_initialize (void)
  79 {
  80   main_module =  g_module_open (NULL, G_MODULE_BIND_LAZY);
  81
  82   /* now register all static plugins */
  83   g_list_foreach (_gst_plugin_static, (GFunc) _gst_plugin_register_static, NULL);
  84 }
  85
  86 static gboolean
  87 gst_plugin_check_version (gint major, gint minor)
  88 {
  89   /* return NULL if the major and minor version numbers are not compatible */
  90   /* with ours. */
  91   if (major != GST_VERSION_MAJOR || minor != GST_VERSION_MINOR)
  92     return FALSE;
  93
  94   return TRUE;
  95 }
  96
  97 static GstPlugin*
  98 gst_plugin_register_func (GstPluginDesc *desc, GstPlugin *plugin, GModule *module)
  99 {
 100   if (!gst_plugin_check_version (desc->major_version, desc->minor_version)) {
 101     GST_INFO (GST_CAT_PLUGIN_LOADING,"plugin \"%s\" has incompatible version, not loading",
 102        plugin->filename);
 103     return NULL;
 104   }
 105
 106   g_free (plugin->name);
 107   plugin->name = g_strdup(desc->name);
 108
 109   if (!((desc->plugin_init) (module, plugin))) {
 110     GST_INFO (GST_CAT_PLUGIN_LOADING,"plugin \"%s\" failed to initialise",
 111        plugin->filename);
 112     return NULL;
 113   }
 114   GST_INFO (GST_CAT_PLUGIN_LOADING,"plugin \"%s\" initialised", GST_STR_NULL (plugin->filename));
 115
 116   return plugin;
 117 }
 118
 119 /**
 120  * gst_plugin_new:
 121  * @filename: The filename of the plugin
 122  *
 123  * Creates a plugin from the given filename
 124  *
 125  * Returns: A new GstPlugin object
 126  */
 127 GstPlugin*
 128 gst_plugin_new (const gchar *filename)
 129 {
 130   GstPlugin *plugin = g_new0 (GstPlugin, 1);
 131   plugin->filename = g_strdup (filename);
 132
 133   return plugin;
 134 }
 135
 136 /**
 137  * gst_plugin_load_plugin:
 138  * @plugin: The plugin to load
 139  * @error: Pointer to a NULL-valued GError.
 140  *
 141  * Load the given plugin.
 142  *
 143  * Returns: whether or not the plugin loaded. Sets @error as appropriate.
 144  */
 145 gboolean
 146 gst_plugin_load_plugin (GstPlugin *plugin, GError **error)
 147 {
 148   GModule *module;
 149   GstPluginDesc *desc;
 150   struct stat file_status;
 151   gchar *filename;
 152
 153   g_return_val_if_fail (plugin != NULL, FALSE);
 154
 155   if (plugin->module)
 156     return TRUE;
 157
 158   filename = plugin->filename;
 159
 160   GST_DEBUG (GST_CAT_PLUGIN_LOADING, "attempt to load plugin \"%s\"", filename);
 161
 162   if (g_module_supported () == FALSE) {
 163     g_set_error (error,
 164                  GST_PLUGIN_ERROR,
 165                  GST_PLUGIN_ERROR_MODULE,
 166                  "Dynamic loading not supported");
 167     return FALSE;
 168   }
 169
 170   if (stat (filename, &file_status)) {
 171     g_set_error (error,
 172                  GST_PLUGIN_ERROR,
 173                  GST_PLUGIN_ERROR_MODULE,
 174                  "Problem opening file %s (plugin %s)\n",
 175                  filename, plugin->name);
 176     return FALSE;
 177   }
 178
 179   module = g_module_open (filename, G_MODULE_BIND_LAZY);
 180
 181   if (module != NULL) {
 182     if (g_module_symbol (module, "plugin_desc", (gpointer *)&desc)) {
 183       GST_DEBUG (GST_CAT_PLUGIN_LOADING, "plugin \"%s\" loaded, called entry function...", filename);
 184
 185       plugin->filename = g_strdup (filename);
 186       plugin = gst_plugin_register_func (desc, plugin, module);
 187
 188       if (plugin != NULL) {
 189         GST_INFO (GST_CAT_PLUGIN_LOADING, "plugin \"%s\" loaded", plugin->filename);
 190         plugin->module = module;
 191         return TRUE;
 192       }
 193       else {
 194         /* plugin == NULL */
 195         g_set_error (error,
 196                      GST_PLUGIN_ERROR,
 197                      GST_PLUGIN_ERROR_MODULE,
 198                      "gst_plugin_register_func failed for plugin \"%s\"",
 199                      filename);
 200         return FALSE;
 201       }
 202     }
 203     else {
 204       g_set_error (error,
 205                    GST_PLUGIN_ERROR,
 206                    GST_PLUGIN_ERROR_MODULE,
 207                    "Could not find plugin_desc in \"%s\"",
 208                    filename);
 209     }
 210     return FALSE;
 211   }
 212   else {
 213     g_set_error (error,
 214                  GST_PLUGIN_ERROR,
 215                  GST_PLUGIN_ERROR_MODULE,
 216                  "Error loading plugin %s, reason: %s\n",
 217                  filename, g_module_error());
 218     return FALSE;
 219   }
 220 }
 221
 222
 223 /**
 224  * gst_plugin_unload_plugin:
 225  * @plugin: The plugin to unload
 226  *
 227  * Unload the given plugin.
 228  *
 229  * Returns: whether or not the plugin unloaded
 230  */
 231 gboolean
 232 gst_plugin_unload_plugin (GstPlugin *plugin)
 233 {
 234   g_return_val_if_fail (plugin != NULL, FALSE);
 235
 236   if (!plugin->module)
 237     return TRUE;
 238
 239   if (g_module_close (plugin->module)) {
 240     plugin->module = NULL;
 241     GST_INFO (GST_CAT_PLUGIN_LOADING, "plugin \"%s\" unloaded", plugin->filename);
 242     return TRUE;
 243   }
 244   else {
 245     GST_INFO (GST_CAT_PLUGIN_LOADING, "failed to unload plugin \"%s\"", plugin->filename);
 246     return FALSE;
 247   }
 248 }
 249
 250 /**
 251  * gst_plugin_get_name:
 252  * @plugin: plugin to get the name of
 253  *
 254  * Get the short name of the plugin
 255  *
 256  * Returns: the name of the plugin
 257  */
 258 const gchar*
 259 gst_plugin_get_name (GstPlugin *plugin)
 260 {
 261   g_return_val_if_fail (plugin != NULL, NULL);
 262
 263   return plugin->name;
 264 }
 265
 266 /**
 267  * gst_plugin_set_name:
 268  * @plugin: plugin to set name of
 269  * @name: new name
 270  *
 271  * Sets the name (should be short) of the plugin.
 272  */
 273 void
 274 gst_plugin_set_name (GstPlugin *plugin, const gchar *name)
 275 {
 276   g_return_if_fail (plugin != NULL);
 277
 278   g_free (plugin->name);
 279
 280   plugin->name = g_strdup (name);
 281 }
 282
 283 /**
 284  * gst_plugin_set_longname:
 285  * @plugin: plugin to set long name of
 286  * @longname: new long name
 287  *
 288  * Sets the long name (should be descriptive) of the plugin.
 289  */
 290 void
 291 gst_plugin_set_longname (GstPlugin *plugin, const gchar *longname)
 292 {
 293   g_return_if_fail(plugin != NULL);
 294
 295   g_free(plugin->longname);
 296
 297   plugin->longname = g_strdup(longname);
 298 }
 299
 300 /**
 301  * gst_plugin_get_longname:
 302  * @plugin: plugin to get long name of
 303  *
 304  * Get the long descriptive name of the plugin
 305  *
 306  * Returns: the long name of the plugin
 307  */
 308 const gchar*
 309 gst_plugin_get_longname (GstPlugin *plugin)
 310 {
 311   g_return_val_if_fail (plugin != NULL, NULL);
 312
 313   return plugin->longname;
 314 }
 315
 316 /**
 317  * gst_plugin_get_filename:
 318  * @plugin: plugin to get the filename of
 319  *
 320  * get the filename of the plugin
 321  *
 322  * Returns: the filename of the plugin
 323  */
 324 const gchar*
 325 gst_plugin_get_filename (GstPlugin *plugin)
 326 {
 327   g_return_val_if_fail (plugin != NULL, NULL);
 328
 329   return plugin->filename;
 330 }
 331
 332 /**
 333  * gst_plugin_is_loaded:
 334  * @plugin: plugin to query
 335  *
 336  * queries if the plugin is loaded into memory
 337  *
 338  * Returns: TRUE is loaded, FALSE otherwise
 339  */
 340 gboolean
 341 gst_plugin_is_loaded (GstPlugin *plugin)
 342 {
 343   g_return_val_if_fail (plugin != NULL, FALSE);
 344
 345   return (plugin->module != NULL);
 346 }
 347
 348 /**
 349  * gst_plugin_feature_list:
 350  * @plugin: plugin to query
 351  * @filter: the filter to use
 352  * @first: only return first match
 353  * @user_data: user data passed to the filter function
 354  *
 355  * Runs a filter against all plugin features and returns a GList with
 356  * the results. If the first flag is set, only the first match is
 357  * returned (as a list with a single object).
 358  *
 359  * Returns: a GList of features, g_list_free after use.
 360  */
 361 GList*
 362 gst_plugin_feature_filter (GstPlugin *plugin,
 363                            GstPluginFeatureFilter filter,
 364                            gboolean first,
 365                            gpointer user_data)
 366 {
 367   return gst_filter_run (plugin->features, (GstFilterFunc) filter, first, user_data);
 368 }
 369
 370 typedef struct
 371 {
 372   GstPluginFeatureFilter filter;
 373   gboolean               first;
 374   gpointer               user_data;
 375   GList                 *result;
 376 } FeatureFilterData;
 377
 378 static gboolean
 379 _feature_filter (GstPlugin *plugin, gpointer user_data)
 380 {
 381   GList *result;
 382   FeatureFilterData *data = (FeatureFilterData *) user_data;
 383
 384   result = gst_plugin_feature_filter (plugin, data->filter, data->first, data->user_data);
 385   if (result) {
 386     data->result = g_list_concat (data->result, result);
 387     return TRUE;
 388   }
 389   return FALSE;
 390 }
 391
 392 /**
 393  * gst_plugin_list_feature_list:
 394  * @list: a list of plugins to query
 395  * @filter: the filter to use
 396  * @first: only return first match
 397  * @user_data: user data passed to the filter function
 398  *
 399  * Runs a filter against all plugin features of the plugins in the given
 400  * list and returns a GList with the results.
 401  * If the first flag is set, only the first match is
 402  * returned (as a list with a single object).
 403  *
 404  * Returns: a GList of features, g_list_free after use.
 405  */
 406 GList*
 407 gst_plugin_list_feature_filter  (GList *list,
 408                                  GstPluginFeatureFilter filter,
 409                                  gboolean first,
 410                                  gpointer user_data)
 411 {
 412   FeatureFilterData data;
 413   GList *result;
 414
 415   data.filter = filter;
 416   data.first = first;
 417   data.user_data = user_data;
 418   data.result = NULL;
 419
 420   result = gst_filter_run (list, (GstFilterFunc) _feature_filter, first, &data);
 421   g_list_free (result);
 422
 423   return data.result;
 424 }
 425
 426 /**
 427  * gst_plugin_name_filter:
 428  * @plugin: the plugin to check
 429  * @name: the name of the plugin
 430  *
 431  * A standard filterthat returns TRUE when the plugin is of the
 432  * given name.
 433  *
 434  * Returns: TRUE if the plugin is of the given name.
 435  */
 436 gboolean
 437 gst_plugin_name_filter (GstPlugin *plugin, const gchar *name)
 438 {
 439   return (plugin->name && !strcmp (plugin->name, name));
 440 }
 441
 442 /**
 443  * gst_plugin_find_feature:
 444  * @plugin: plugin to get the feature from
 445  * @name: The name of the feature to find
 446  * @type: The type of the feature to find
 447  *
 448  * Find a feature of the given name and type in the given plugin.
 449  *
 450  * Returns: a GstPluginFeature or NULL if the feature was not found.
 451  */
 452 GstPluginFeature*
 453 gst_plugin_find_feature (GstPlugin *plugin, const gchar *name, GType type)
 454 {
 455   GList *walk;
 456   GstPluginFeature *result = NULL;
 457   GstTypeNameData data;
 458
 459   g_return_val_if_fail (name != NULL, NULL);
 460
 461   data.type = type;
 462   data.name = name;
 463
 464   walk = gst_filter_run (plugin->features,
 465                          (GstFilterFunc) gst_plugin_feature_type_name_filter, TRUE,
 466                          &data);
 467
 468   if (walk)
 469     result = GST_PLUGIN_FEATURE (walk->data);
 470
 471   return result;
 472 }
 473
 474 /**
 475  * gst_plugin_add_feature:
 476  * @plugin: plugin to add feature to
 477  * @feature: feature to add
 478  *
 479  * Add feature to the list of those provided by the plugin.
 480  * There is a separate namespace for each plugin feature type.
 481  * See #gst_plugin_get_feature_list
 482  */
 483 void
 484 gst_plugin_add_feature (GstPlugin *plugin, GstPluginFeature *feature)
 485 {
 486   GstPluginFeature *oldfeature;
 487
 488   g_return_if_fail (plugin != NULL);
 489   g_return_if_fail (GST_IS_PLUGIN_FEATURE (feature));
 490   g_return_if_fail (feature != NULL);
 491
 492   oldfeature = gst_plugin_find_feature (plugin,
 493                   GST_PLUGIN_FEATURE_NAME (feature), G_OBJECT_TYPE (feature));
 494
 495   if (!oldfeature) {
 496     feature->manager = plugin;
 497     plugin->features = g_list_prepend (plugin->features, feature);
 498     plugin->numfeatures++;
 499   }
 500 }
 501
 502 /**
 503  * gst_plugin_get_feature_list:
 504  * @plugin: the plugin to get the features from
 505  *
 506  * get a list of all the features that this plugin provides
 507  *
 508  * Returns: a GList of features, use g_list_free to free the list.
 509  */
 510 GList*
 511 gst_plugin_get_feature_list (GstPlugin *plugin)
 512 {
 513   g_return_val_if_fail (plugin != NULL, NULL);
 514
 515   return g_list_copy (plugin->features);
 516 }
 517
 518 /**
 519  * gst_plugin_load:
 520  * @name: name of plugin to load
 521  *
 522  * Load the named plugin.
 523  *
 524  * Returns: whether the plugin was loaded or not
 525  */
 526 gboolean
 527 gst_plugin_load (const gchar *name)
 528 {
 529   GstPlugin *plugin;
 530   GError *error = NULL;
 531
 532   plugin = gst_registry_pool_find_plugin (name);
 533   if (plugin) {
 534     gboolean result = gst_plugin_load_plugin (plugin, &error);
 535     if (error) {
 536       GST_DEBUG (GST_CAT_PLUGIN_LOADING, "load_plugin error: %s\n",
 537                  error->message);
 538       g_error_free (error);
 539     }
 540     return result;
 541   }
 542
 543   GST_DEBUG (GST_CAT_PLUGIN_LOADING, "Could not find %s in registry pool",
 544              name);
 545
 546   return FALSE;
 547 }
 548
 549 /**
 550  * gst_library_load:
 551  * @name: name of library to load
 552  *
 553  * Load the named library.  Name should be given as
 554  * &quot;liblibrary.so&quot;.
 555  *
 556  * Returns: whether the library was loaded or not
 557  */
 558 gboolean
 559 gst_library_load (const gchar *name)
 560 {
 561   gboolean res;
 562
 563   /* for now this is the same */
 564   res = gst_plugin_load (name);
 565
 566   return res;
 567 }