2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
5 * gstplugin.h: Header for plugin subsystem
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., 51 Franklin St, Fifth Floor,
20 * Boston, MA 02110-1301, USA.
24 #ifndef __GST_PLUGIN_H__
25 #define __GST_PLUGIN_H__
27 #include <gst/gstconfig.h>
29 #include <gst/gstobject.h>
30 #include <gst/gstmacros.h>
31 #include <gst/gststructure.h>
38 * The opaque plugin object
40 typedef struct _GstPlugin GstPlugin;
41 typedef struct _GstPluginClass GstPluginClass;
42 typedef struct _GstPluginDesc GstPluginDesc;
45 * gst_plugin_error_quark:
47 * Get the error quark.
49 * Returns: The error quark used in GError messages
53 GQuark gst_plugin_error_quark (void);
57 * The error message category quark
59 #define GST_PLUGIN_ERROR gst_plugin_error_quark ()
63 * @GST_PLUGIN_ERROR_MODULE: The plugin could not be loaded
64 * @GST_PLUGIN_ERROR_DEPENDENCIES: The plugin has unresolved dependencies
65 * @GST_PLUGIN_ERROR_NAME_MISMATCH: The plugin has already be loaded from a different file
67 * The plugin loading errors
71 GST_PLUGIN_ERROR_MODULE,
72 GST_PLUGIN_ERROR_DEPENDENCIES,
73 GST_PLUGIN_ERROR_NAME_MISMATCH
78 * @GST_PLUGIN_FLAG_CACHED: Temporarily loaded plugins
79 * @GST_PLUGIN_FLAG_BLACKLISTED: The plugin won't be scanned (again)
81 * The plugin loading state
85 GST_PLUGIN_FLAG_CACHED = (GST_OBJECT_FLAG_LAST << 0),
86 GST_PLUGIN_FLAG_BLACKLISTED = (GST_OBJECT_FLAG_LAST << 1)
90 * GstPluginDependencyFlags:
91 * @GST_PLUGIN_DEPENDENCY_FLAG_NONE : no special flags
92 * @GST_PLUGIN_DEPENDENCY_FLAG_RECURSE : recurse into subdirectories
93 * @GST_PLUGIN_DEPENDENCY_FLAG_PATHS_ARE_DEFAULT_ONLY : use paths
94 * argument only if none of the environment variables is set
95 * @GST_PLUGIN_DEPENDENCY_FLAG_FILE_NAME_IS_SUFFIX : interpret
96 * filename argument as filter suffix and check all matching files in
98 * @GST_PLUGIN_DEPENDENCY_FLAG_FILE_NAME_IS_PREFIX : interpret
99 * filename argument as filter prefix and check all matching files in
100 * the directory. Since 1.8.
102 * Flags used in connection with gst_plugin_add_dependency().
105 GST_PLUGIN_DEPENDENCY_FLAG_NONE = 0,
106 GST_PLUGIN_DEPENDENCY_FLAG_RECURSE = (1 << 0),
107 GST_PLUGIN_DEPENDENCY_FLAG_PATHS_ARE_DEFAULT_ONLY = (1 << 1),
108 GST_PLUGIN_DEPENDENCY_FLAG_FILE_NAME_IS_SUFFIX = (1 << 2),
109 GST_PLUGIN_DEPENDENCY_FLAG_FILE_NAME_IS_PREFIX = (1 << 3)
110 } GstPluginDependencyFlags;
114 * @plugin: The plugin object
116 * A plugin should provide a pointer to a function of this type in the
117 * plugin_desc struct.
118 * This function will be called by the loader at startup. One would then
119 * register each #GstPluginFeature.
121 * Returns: %TRUE if plugin initialised successfully
123 /* FIXME 0.11: Make return void */
124 typedef gboolean (*GstPluginInitFunc) (GstPlugin *plugin);
127 * GstPluginInitFullFunc:
128 * @plugin: The plugin object
129 * @user_data: extra data
131 * A plugin should provide a pointer to a function of either #GstPluginInitFunc
132 * or this type in the plugin_desc struct.
133 * The function will be called by the loader at startup. One would then
134 * register each #GstPluginFeature. This version allows
135 * user data to be passed to init function (useful for bindings).
137 * Returns: %TRUE if plugin initialised successfully
139 /* FIXME 0.11: Merge with GstPluginInitFunc */
140 typedef gboolean (*GstPluginInitFullFunc) (GstPlugin *plugin, gpointer user_data);
144 * @major_version: the major version number of core that plugin was compiled for
145 * @minor_version: the minor version number of core that plugin was compiled for
146 * @name: a unique name of the plugin
147 * @description: description of plugin
148 * @plugin_init: pointer to the init function of this plugin.
149 * @version: version of the plugin
150 * @license: effective license of plugin
151 * @source: source module plugin belongs to
152 * @package: shipped package plugin belongs to
153 * @origin: URL to provider of plugin
154 * @release_datetime: (allow-none): date time string in ISO 8601
155 * format (or rather, a subset thereof), or %NULL. Allowed are the
156 * following formats: "YYYY-MM-DD" and "YYY-MM-DDTHH:MMZ" (with
157 * 'T' a separator and 'Z' indicating UTC/Zulu time). This field
158 * should be set via the GST_PACKAGE_RELEASE_DATETIME
159 * preprocessor macro.
161 * A plugin should export a variable of this type called plugin_desc. The plugin
162 * loader will use the data provided there to initialize the plugin.
164 * The @licence parameter must be one of: LGPL, GPL, QPL, GPL/QPL, MPL,
165 * BSD, MIT/X11, Proprietary, unknown.
167 struct _GstPluginDesc {
171 const gchar *description;
172 GstPluginInitFunc plugin_init;
173 const gchar *version;
174 const gchar *license;
176 const gchar *package;
178 const gchar *release_datetime;
180 gpointer _gst_reserved[GST_PADDING];
184 #define GST_TYPE_PLUGIN (gst_plugin_get_type())
185 #define GST_IS_PLUGIN(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PLUGIN))
186 #define GST_IS_PLUGIN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PLUGIN))
187 #define GST_PLUGIN_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_PLUGIN, GstPluginClass))
188 #define GST_PLUGIN(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PLUGIN, GstPlugin))
189 #define GST_PLUGIN_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PLUGIN, GstPluginClass))
190 #define GST_PLUGIN_CAST(obj) ((GstPlugin*)(obj))
192 #ifdef GST_PACKAGE_RELEASE_DATETIME
193 #define __GST_PACKAGE_RELEASE_DATETIME GST_PACKAGE_RELEASE_DATETIME
195 #define __GST_PACKAGE_RELEASE_DATETIME NULL
199 * GST_PLUGIN_STATIC_DECLARE:
200 * @name: short, but unique name of the plugin
202 * This macro can be used to initialize statically linked plugins. It is
203 * necessary to call this macro before the plugin can be used.
204 * It has to be used in combination with GST_PLUGIN_STATIC_REGISTER
205 * and must be placed outside any block to declare the plugin initialization
210 #define GST_PLUGIN_STATIC_DECLARE(name) \
211 extern void G_PASTE(gst_plugin_, G_PASTE(name, _register)) (void)
214 * GST_PLUGIN_STATIC_REGISTER:
215 * @name: short, but unique name of the plugin
217 * This macro can be used to initialize statically linked plugins. It is
218 * necessary to call this macro before the plugin can be used.
219 * It has to be used in combination with GST_PLUGIN_STATIC_DECLARE and
220 * calls the plugin initialization function.
224 #define GST_PLUGIN_STATIC_REGISTER(name) G_PASTE(gst_plugin_, G_PASTE(name, _register)) ()
228 * @major: major version number of the gstreamer-core that plugin was compiled for
229 * @minor: minor version number of the gstreamer-core that plugin was compiled for
230 * @name: short, but unique name of the plugin
231 * @description: information about the purpose of the plugin
232 * @init: function pointer to the plugin_init method with the signature of <code>static gboolean plugin_init (GstPlugin * plugin)</code>.
233 * @version: full version string (e.g. VERSION from config.h)
234 * @license: under which licence the package has been released, e.g. GPL, LGPL.
235 * @package: the package-name (e.g. PACKAGE_NAME from config.h)
236 * @origin: a description from where the package comes from (e.g. the homepage URL)
238 * This macro needs to be used to define the entry point and meta data of a
239 * plugin. One would use this macro to export a plugin, so that it can be used
240 * by other applications.
242 * The macro uses a define named PACKAGE for the #GstPluginDesc,source field.
243 * When using autoconf, this is usually set automatically via the AC_INIT
244 * macro, and set in config.h. If you are not using autoconf, you will need to
245 * define PACKAGE yourself and set it to a short mnemonic string identifying
246 * your application/package, e.g. 'someapp' or 'my-plugins-foo.
248 * If defined, the GST_PACKAGE_RELEASE_DATETIME will also be used for the
249 * #GstPluginDesc,release_datetime field.
251 #define GST_PLUGIN_DEFINE(major,minor,name,description,init,version,license,package,origin) \
253 GST_PLUGIN_EXPORT const GstPluginDesc * G_PASTE(gst_plugin_, G_PASTE(name, _get_desc)) (void); \
254 GST_PLUGIN_EXPORT void G_PASTE(gst_plugin_, G_PASTE(name, _register)) (void); \
256 static const GstPluginDesc gst_plugin_desc = { \
260 (gchar *) description, \
267 __GST_PACKAGE_RELEASE_DATETIME, \
271 const GstPluginDesc * \
272 G_PASTE(gst_plugin_, G_PASTE(name, _get_desc)) (void) \
274 return &gst_plugin_desc; \
278 G_PASTE(gst_plugin_, G_PASTE(name, _register)) (void) \
280 gst_plugin_register_static (major, minor, G_STRINGIFY(name), \
281 description, init, version, license, \
282 PACKAGE, package, origin); \
287 * GST_LICENSE_UNKNOWN:
289 * To be used in GST_PLUGIN_DEFINE if unsure about the licence.
291 #define GST_LICENSE_UNKNOWN "unknown"
294 /* function for filters */
297 * @plugin: the plugin to check
298 * @user_data: the user_data that has been passed on e.g. gst_registry_plugin_filter()
300 * A function that can be used with e.g. gst_registry_plugin_filter()
301 * to get a list of plugins that match certain criteria.
303 * Returns: %TRUE for a positive match, %FALSE otherwise
305 typedef gboolean (*GstPluginFilter) (GstPlugin *plugin,
309 GType gst_plugin_get_type (void);
312 gboolean gst_plugin_register_static (gint major_version,
315 const gchar *description,
316 GstPluginInitFunc init_func,
317 const gchar *version,
318 const gchar *license,
320 const gchar *package,
321 const gchar *origin);
323 gboolean gst_plugin_register_static_full (gint major_version,
326 const gchar *description,
327 GstPluginInitFullFunc init_full_func,
328 const gchar *version,
329 const gchar *license,
331 const gchar *package,
335 const gchar* gst_plugin_get_name (GstPlugin *plugin);
338 const gchar* gst_plugin_get_description (GstPlugin *plugin);
341 const gchar* gst_plugin_get_filename (GstPlugin *plugin);
344 const gchar* gst_plugin_get_version (GstPlugin *plugin);
347 const gchar* gst_plugin_get_license (GstPlugin *plugin);
350 const gchar* gst_plugin_get_source (GstPlugin *plugin);
353 const gchar* gst_plugin_get_package (GstPlugin *plugin);
356 const gchar* gst_plugin_get_origin (GstPlugin *plugin);
359 const gchar* gst_plugin_get_release_date_string (GstPlugin *plugin);
362 const GstStructure* gst_plugin_get_cache_data (GstPlugin * plugin);
365 void gst_plugin_set_cache_data (GstPlugin * plugin, GstStructure *cache_data);
368 gboolean gst_plugin_is_loaded (GstPlugin *plugin);
371 GstPlugin * gst_plugin_load_file (const gchar *filename, GError** error);
374 GstPlugin * gst_plugin_load (GstPlugin *plugin);
377 GstPlugin * gst_plugin_load_by_name (const gchar *name);
380 void gst_plugin_add_dependency (GstPlugin * plugin,
381 const gchar ** env_vars,
382 const gchar ** paths,
383 const gchar ** names,
384 GstPluginDependencyFlags flags);
386 void gst_plugin_add_dependency_simple (GstPlugin * plugin,
387 const gchar * env_vars,
390 GstPluginDependencyFlags flags);
392 void gst_plugin_list_free (GList *list);
394 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
395 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstPlugin, gst_object_unref)
400 #endif /* __GST_PLUGIN_H__ */