*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
*/
/**
* SECTION:gstplugin
+ * @title: GstPlugin
* @short_description: Container for features loaded from a shared object module
* @see_also: #GstPluginFeature, #GstElementFactory
*
* Once you have a handle to a #GstPlugin (e.g. from the #GstRegistry), you
* can add any object that subclasses #GstPluginFeature.
*
- * Usually plugins are always automaticlly loaded so you don't need to call
+ * Usually plugins are always automatically loaded so you don't need to call
* gst_plugin_load() explicitly to bring it into memory. There are options to
* statically link plugins to an app or even use GStreamer without a plugin
* repository in which case gst_plugin_load() can be needed to bring the plugin
/* list of valid licenses.
* One of these must be specified or the plugin won't be loaded
- * Contact gstreamer-devel@lists.sourceforge.net if your license should be
- * added.
+ * Please file a bug to request any additional license be added.
*
* GPL: http://www.gnu.org/copyleft/gpl.html
* LGPL: http://www.gnu.org/copyleft/lesser.html
* MIT/X11: http://www.opensource.org/licenses/mit-license.php
* 3-clause BSD: http://www.opensource.org/licenses/bsd-license.php
*/
-static const gchar *const valid_licenses[] = {
- "LGPL", /* GNU Lesser General Public License */
- "GPL", /* GNU General Public License */
- "QPL", /* Trolltech Qt Public License */
- "GPL/QPL", /* Combi-license of GPL + QPL */
- "MPL", /* MPL 1.1 license */
- "BSD", /* 3-clause BSD license */
- "MIT/X11", /* MIT/X11 license */
- "Proprietary", /* Proprietary license */
- GST_LICENSE_UNKNOWN, /* some other license */
- NULL
-};
+static const gchar valid_licenses[] = "LGPL\000" /* GNU Lesser General Public License */
+ "GPL\000" /* GNU General Public License */
+ "QPL\000" /* Trolltech Qt Public License */
+ "GPL/QPL\000" /* Combi-license of GPL + QPL */
+ "MPL\000" /* MPL 1.1 license */
+ "BSD\000" /* 3-clause BSD license */
+ "MIT/X11\000" /* MIT/X11 license */
+ "Proprietary\000" /* Proprietary license */
+ GST_LICENSE_UNKNOWN; /* some other license */
+
+static const guint8 valid_licenses_idx[] = { 0, 5, 9, 13, 21, 25, 29, 37, 49 };
static GstPlugin *gst_plugin_register_func (GstPlugin * plugin,
const GstPluginDesc * desc, gpointer user_data);
* You must make sure that GStreamer has been initialised (with gst_init() or
* via gst_init_get_option_group()) before calling this function.
*
- * Returns: TRUE if the plugin was registered correctly, otherwise FALSE.
- *
- * Since: 0.10.16
+ * Returns: %TRUE if the plugin was registered correctly, otherwise %FALSE.
*/
gboolean
gst_plugin_register_static (gint major_version, gint minor_version,
* You must make sure that GStreamer has been initialised (with gst_init() or
* via gst_init_get_option_group()) before calling this function.
*
- * Returns: TRUE if the plugin was registered correctly, otherwise FALSE.
- *
- * Since: 0.10.24
- *
+ * Returns: %TRUE if the plugin was registered correctly, otherwise %FALSE.
*/
gboolean
gst_plugin_register_static_full (gint major_version, gint minor_version,
gchar **w;
for (w = _plugin_loading_whitelist; *w != NULL; ++w)
- hash = (hash << 1) ^ g_str_hash (*w);
+ hash ^= g_str_hash (*w);
}
return hash;
static gboolean
gst_plugin_check_license (const gchar * license)
{
- const gchar *const *check_license = valid_licenses;
-
- g_assert (check_license);
+ gint i;
- while (*check_license) {
- if (strcmp (license, *check_license) == 0)
+ for (i = 0; i < G_N_ELEMENTS (valid_licenses_idx); ++i) {
+ if (strcmp (license, valid_licenses + valid_licenses_idx[i]) == 0)
return TRUE;
- check_license++;
}
return FALSE;
}
{
/* return NULL if the major and minor version numbers are not compatible */
/* with ours. */
- if (major != GST_VERSION_MAJOR || minor != GST_VERSION_MINOR)
+ if (major != GST_VERSION_MAJOR || minor > GST_VERSION_MINOR)
return FALSE;
return TRUE;
{
if (!gst_plugin_check_version (desc->major_version, desc->minor_version)) {
if (GST_CAT_DEFAULT)
- GST_WARNING ("plugin \"%s\" has incompatible version, not loading",
- plugin->filename);
+ GST_WARNING ("plugin \"%s\" has incompatible version "
+ "(plugin: %d.%d, gst: %d,%d), not loading",
+ GST_STR_NULL (plugin->filename), desc->major_version,
+ desc->minor_version, GST_VERSION_MAJOR, GST_VERSION_MINOR);
return NULL;
}
if (!desc->license || !desc->description || !desc->source ||
!desc->package || !desc->origin) {
if (GST_CAT_DEFAULT)
- GST_WARNING ("plugin \"%s\" has incorrect GstPluginDesc, not loading",
- plugin->filename);
+ GST_WARNING ("plugin \"%s\" has missing detail in GstPluginDesc, not "
+ "loading", GST_STR_NULL (plugin->filename));
return NULL;
}
if (!gst_plugin_check_license (desc->license)) {
if (GST_CAT_DEFAULT)
GST_WARNING ("plugin \"%s\" has invalid license \"%s\", not loading",
- plugin->filename, desc->license);
+ GST_STR_NULL (plugin->filename), desc->license);
return NULL;
}
if (user_data) {
if (!(((GstPluginInitFullFunc) (desc->plugin_init)) (plugin, user_data))) {
if (GST_CAT_DEFAULT)
- GST_WARNING ("plugin \"%s\" failed to initialise", plugin->filename);
+ GST_WARNING ("plugin \"%s\" failed to initialise",
+ GST_STR_NULL (plugin->filename));
return NULL;
}
} else {
if (!((desc->plugin_init) (plugin))) {
if (GST_CAT_DEFAULT)
- GST_WARNING ("plugin \"%s\" failed to initialise", plugin->filename);
+ GST_WARNING ("plugin \"%s\" failed to initialise",
+ GST_STR_NULL (plugin->filename));
return NULL;
}
}
static GMutex gst_plugin_loading_mutex;
#define CHECK_PLUGIN_DESC_FIELD(desc,field,fn) \
- if (G_UNLIKELY ((desc)->field == NULL)) { \
- GST_ERROR ("GstPluginDesc for '%s' has no %s", fn, G_STRINGIFY (field)); \
+ if (G_UNLIKELY ((desc)->field == NULL || *(desc)->field == '\0')) { \
+ g_warning ("Plugin description for '%s' has no valid %s field", fn, G_STRINGIFY (field)); \
+ g_set_error (error, GST_PLUGIN_ERROR, GST_PLUGIN_ERROR_MODULE, \
+ "Plugin %s has invalid plugin description field '%s'", \
+ filename, G_STRINGIFY (field)); \
+ goto return_error; \
}
/**
* gst_plugin_load_file:
* @filename: the plugin filename to load
- * @error: pointer to a NULL-valued GError
+ * @error: pointer to a %NULL-valued GError
*
* Loads the given plugin and refs it. Caller needs to unref after use.
*
- * Returns: (transfer full): a reference to the existing loaded GstPlugin, a
- * reference to the newly-loaded GstPlugin, or NULL if an error occurred.
+ * Returns: (transfer full): a reference to the existing loaded GstPlugin, a
+ * reference to the newly-loaded GstPlugin, or %NULL if an error occurred.
*/
GstPlugin *
gst_plugin_load_file (const gchar * filename, GError ** error)
{
+ return _priv_gst_plugin_load_file_for_registry (filename, NULL, error);
+}
+
+GstPlugin *
+_priv_gst_plugin_load_file_for_registry (const gchar * filename,
+ GstRegistry * registry, GError ** error)
+{
GstPluginDesc *desc;
GstPlugin *plugin;
GModule *module;
gboolean ret;
gpointer ptr;
GStatBuf file_status;
- GstRegistry *registry;
gboolean new_plugin = TRUE;
GModuleFlags flags;
g_return_val_if_fail (filename != NULL, NULL);
- registry = gst_registry_get ();
+ if (registry == NULL)
+ registry = gst_registry_get ();
+
g_mutex_lock (&gst_plugin_loading_mutex);
plugin = gst_registry_lookup (registry, filename);
GST_CAT_DEBUG (GST_CAT_PLUGIN_LOADING, "attempt to load plugin \"%s\"",
filename);
- if (g_module_supported () == FALSE) {
+ if (!g_module_supported ()) {
GST_CAT_DEBUG (GST_CAT_PLUGIN_LOADING, "module loading not supported");
g_set_error (error,
GST_PLUGIN_ERROR,
plugin->orig_desc = desc;
if (new_plugin) {
- /* check plugin description: complain about bad values but accept them, to
- * maintain backwards compatibility (FIXME: 0.11) */
+ /* check plugin description: complain about bad values and fail */
CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, name, filename);
CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, description, filename);
CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, version, filename);
CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, package, filename);
CHECK_PLUGIN_DESC_FIELD (plugin->orig_desc, origin, filename);
+ if (plugin->orig_desc->name != NULL && plugin->orig_desc->name[0] == '"') {
+ g_warning ("Invalid plugin name '%s' - fix your GST_PLUGIN_DEFINE "
+ "(remove quotes around plugin name)", plugin->orig_desc->name);
+ }
+
if (plugin->orig_desc->release_datetime != NULL &&
!check_release_datetime (plugin->orig_desc->release_datetime)) {
GST_ERROR ("GstPluginDesc for '%s' has invalid datetime '%s'",
if (new_plugin) {
gst_object_ref (plugin);
- gst_registry_add_plugin (gst_registry_get (), plugin);
+ gst_registry_add_plugin (registry, plugin);
}
g_mutex_unlock (&gst_plugin_loading_mutex);
}
/**
- * gst_plugin_get_module:
- * @plugin: plugin to query
+ * gst_plugin_get_release_date_string:
+ * @plugin: plugin to get the release date of
*
- * Gets the #GModule of the plugin. If the plugin isn't loaded yet, NULL is
- * returned.
+ * Get the release date (and possibly time) in form of a string, if available.
*
- * Returns: (transfer none): module belonging to the plugin or NULL if the
- * plugin isn't loaded yet.
+ * For normal GStreamer plugin releases this will usually just be a date in
+ * the form of "YYYY-MM-DD", while pre-releases and builds from git may contain
+ * a time component after the date as well, in which case the string will be
+ * formatted like "YYYY-MM-DDTHH:MMZ" (e.g. "2012-04-30T09:30Z").
+ *
+ * There may be plugins that do not have a valid release date set on them.
+ *
+ * Returns: (nullable): the date string of the plugin, or %NULL if not
+ * available.
*/
-GModule *
-gst_plugin_get_module (GstPlugin * plugin)
+const gchar *
+gst_plugin_get_release_date_string (GstPlugin * plugin)
{
g_return_val_if_fail (plugin != NULL, NULL);
- return plugin->module;
+ return plugin->desc.release_datetime;
}
/**
*
* queries if the plugin is loaded into memory
*
- * Returns: TRUE is loaded, FALSE otherwise
+ * Returns: %TRUE is loaded, %FALSE otherwise
*/
gboolean
gst_plugin_is_loaded (GstPlugin * plugin)
* Gets the plugin specific data cache. If it is %NULL there is no cached data
* stored. This is the case when the registry is getting rebuilt.
*
- * Returns: (transfer none): The cached data as a #GstStructure or %NULL.
- *
- * Since: 0.10.24
+ * Returns: (transfer none) (nullable): The cached data as a
+ * #GstStructure or %NULL.
*/
const GstStructure *
gst_plugin_get_cache_data (GstPlugin * plugin)
* the @plugin.
*
* The cache is flushed every time the registry is rebuilt.
- *
- * Since: 0.10.24
*/
void
gst_plugin_set_cache_data (GstPlugin * plugin, GstStructure * cache_data)
return data.result;
}
-#endif
-
-/**
- * gst_plugin_name_filter:
- * @plugin: the plugin to check
- * @name: the name of the plugin
- *
- * A standard filter that returns TRUE when the plugin is of the
- * given name.
- *
- * Returns: TRUE if the plugin is of the given name.
- */
-gboolean
-gst_plugin_name_filter (GstPlugin * plugin, const gchar * name)
-{
- return (plugin->desc.name && !strcmp (plugin->desc.name, name));
-}
-#if 0
/**
* gst_plugin_find_feature:
* @plugin: plugin to get the feature from
*
* Find a feature of the given name and type in the given plugin.
*
- * Returns: a GstPluginFeature or NULL if the feature was not found.
+ * Returns: a GstPluginFeature or %NULL if the feature was not found.
*/
GstPluginFeature *
gst_plugin_find_feature (GstPlugin * plugin, const gchar * name, GType type)
*
* Find a feature of the given name in the given plugin.
*
- * Returns: a GstPluginFeature or NULL if the feature was not found.
+ * Returns: a GstPluginFeature or %NULL if the feature was not found.
*/
GstPluginFeature *
gst_plugin_find_feature_by_name (GstPlugin * plugin, const gchar * name)
*
* Load the named plugin. Refs the plugin.
*
- * Returns: (transfer full): a reference to a loaded plugin, or NULL on error.
+ * Returns: (transfer full): a reference to a loaded plugin, or %NULL on error.
*/
GstPlugin *
gst_plugin_load_by_name (const gchar * name)
* Loads @plugin. Note that the *return value* is the loaded plugin; @plugin is
* untouched. The normal use pattern of this function goes like this:
*
- * <programlisting>
+ * |[
* GstPlugin *loaded_plugin;
* loaded_plugin = gst_plugin_load (plugin);
* // presumably, we're no longer interested in the potentially-unloaded plugin
* gst_object_unref (plugin);
* plugin = loaded_plugin;
- * </programlisting>
+ * ]|
*
- * Returns: (transfer full): a reference to a loaded plugin, or NULL on error.
+ * Returns: (transfer full): a reference to a loaded plugin, or %NULL on error.
*/
GstPlugin *
gst_plugin_load (GstPlugin * plugin)
static guint
gst_plugin_ext_dep_get_hash_from_stat_entry (GStatBuf * s)
{
- if (!(s->st_mode & (S_IFDIR | S_IFREG)))
+#ifdef S_IFBLK
+ if (!(s->st_mode & (S_IFDIR | S_IFREG | S_IFBLK | S_IFCHR)))
+#else
+ /* MSVC does not have S_IFBLK */
+ if (!(s->st_mode & (S_IFDIR | S_IFREG | S_IFCHR)))
+#endif
return (guint) - 1;
/* completely random formula */
if (((flags & GST_PLUGIN_DEPENDENCY_FLAG_FILE_NAME_IS_SUFFIX)) &&
g_str_has_suffix (entry, *filenames)) {
return TRUE;
+ } else if (((flags & GST_PLUGIN_DEPENDENCY_FLAG_FILE_NAME_IS_PREFIX)) &&
+ g_str_has_prefix (entry, *filenames)) {
+ return TRUE;
/* else it's an exact match that's needed */
} else if (strcmp (entry, *filenames) == 0) {
return TRUE;
continue;
}
- hash = (hash + fhash) << 1;
+ hash = hash + fhash;
g_free (full_path);
}
GstPluginDependencyFlags flags)
{
const gchar *empty_filenames[] = { "", NULL };
- gboolean recurse_into_dirs, partial_names;
+ gboolean recurse_into_dirs, partial_names = FALSE;
guint i, hash = 0;
/* to avoid special-casing below (FIXME?) */
filenames = empty_filenames;
recurse_into_dirs = ! !(flags & GST_PLUGIN_DEPENDENCY_FLAG_RECURSE);
- partial_names = ! !(flags & GST_PLUGIN_DEPENDENCY_FLAG_FILE_NAME_IS_SUFFIX);
+
+ if ((flags & GST_PLUGIN_DEPENDENCY_FLAG_FILE_NAME_IS_SUFFIX) ||
+ (flags & GST_PLUGIN_DEPENDENCY_FLAG_FILE_NAME_IS_PREFIX))
+ partial_names = TRUE;
/* if we can construct the exact paths to check with the data we have, just
* stat them one by one; this is more efficient than opening the directory
fhash = gst_plugin_ext_dep_get_hash_from_stat_entry (&s);
GST_LOG_OBJECT (plugin, "stat: %s (result: %08x)", full_path, fhash);
}
- hash = (hash + fhash) << 1;
+ hash += fhash;
g_free (full_path);
}
} else {
while ((path = g_queue_pop_head (&scan_paths))) {
scan_hash += gst_plugin_ext_dep_scan_path_with_filenames (plugin, path,
(const gchar **) dep->names, dep->flags);
- scan_hash = scan_hash << 1;
g_free (path);
}
/**
* gst_plugin_add_dependency:
* @plugin: a #GstPlugin
- * @env_vars: NULL-terminated array of environment variables affecting the
+ * @env_vars: (allow-none): %NULL-terminated array of environment variables affecting the
* feature set of the plugin (e.g. an environment variable containing
* paths where to look for additional modules/plugins of a library),
- * or NULL. Environment variable names may be followed by a path component
+ * or %NULL. Environment variable names may be followed by a path component
* which will be added to the content of the environment variable, e.g.
* "HOME/.mystuff/plugins".
- * @paths: NULL-terminated array of directories/paths where dependent files
- * may be.
- * @names: NULL-terminated array of file names (or file name suffixes,
+ * @paths: (allow-none): %NULL-terminated array of directories/paths where dependent files
+ * may be, or %NULL.
+ * @names: (allow-none): %NULL-terminated array of file names (or file name suffixes,
* depending on @flags) to be used in combination with the paths from
* @paths and/or the paths extracted from the environment variables in
- * @env_vars, or NULL.
+ * @env_vars, or %NULL.
* @flags: optional flags, or #GST_PLUGIN_DEPENDENCY_FLAG_NONE
*
* Make GStreamer aware of external dependencies which affect the feature
* library and makes visualisations available as GStreamer elements, or a
* codec loader which exposes elements and/or caps dependent on what external
* codec libraries are currently installed.
- *
- * Since: 0.10.22
*/
void
gst_plugin_add_dependency (GstPlugin * plugin, const gchar ** env_vars,
/**
* gst_plugin_add_dependency_simple:
* @plugin: the #GstPlugin
- * @env_vars: one or more environment variables (separated by ':', ';' or ','),
- * or NULL. Environment variable names may be followed by a path component
+ * @env_vars: (allow-none): one or more environment variables (separated by ':', ';' or ','),
+ * or %NULL. Environment variable names may be followed by a path component
* which will be added to the content of the environment variable, e.g.
* "HOME/.mystuff/plugins:MYSTUFF_PLUGINS_PATH"
- * @paths: one ore more directory paths (separated by ':' or ';' or ','),
- * or NULL. Example: "/usr/lib/mystuff/plugins"
- * @names: one or more file names or file name suffixes (separated by commas),
- * or NULL
+ * @paths: (allow-none): one ore more directory paths (separated by ':' or ';' or ','),
+ * or %NULL. Example: "/usr/lib/mystuff/plugins"
+ * @names: (allow-none): one or more file names or file name suffixes (separated by commas),
+ * or %NULL
* @flags: optional flags, or #GST_PLUGIN_DEPENDENCY_FLAG_NONE
*
* Make GStreamer aware of external dependencies which affect the feature
* Convenience wrapper function for gst_plugin_add_dependency() which
* takes simple strings as arguments instead of string arrays, with multiple
* arguments separated by predefined delimiters (see above).
- *
- * Since: 0.10.22
*/
void
gst_plugin_add_dependency_simple (GstPlugin * plugin,
projects / platform / upstream / gstreamer.git / blobdiff