Include dependency graph for modules.h:

Data Structures
struct	vlc_plugin_t
	VLC plugin. More...

struct	module_t
	Internal module descriptor. More...

Macros
#define	MODULE_SHORTCUT_MAX 20

Typedefs
typedef struct vlc_plugin_t	vlc_plugin_t
	VLC plugin.

typedef void(*	vlc_deactivate_cb) (vlc_object_t *)
	Plugin deactivation callback.

Functions
vlc_plugin_t *	vlc_plugin_create (void)

void	vlc_plugin_destroy (vlc_plugin_t *)
	Destroys a plug-in.

module_t *	vlc_module_create (vlc_plugin_t *)

void	vlc_module_destroy (module_t *)
	Destroys a module.

vlc_plugin_t *	vlc_plugin_describe (vlc_plugin_cb)
	Runs a plug-in descriptor.

int	vlc_plugin_resolve (vlc_plugin_t *, vlc_plugin_cb)

void	module_InitBank (void)
	Init bank.

void	module_LoadPlugins (libvlc_int_t *)
	Loads module descriptions for all available plugins.

void	module_EndBank (bool)
	Unloads all unused plugin modules and empties the module bank in case of success.

int	vlc_plugin_Map (struct vlc_logger , vlc_plugin_t )

void *	vlc_plugin_Symbol (struct vlc_logger , vlc_plugin_t , const char *name)

size_t	module_list_cap (module_t const tab, const char name)
	Lists of all VLC modules with a given capability.

int	vlc_bindtextdomain (const char *)

void *	vlc_dlopen (const char *path, bool)
	Loads a dynamically linked library.

int	vlc_dlclose (void *)
	Unloads a dynamic library.

void *	vlc_dlsym (void handle, const char name)
	Looks up a symbol from a dynamically loaded library.

char *	vlc_dlerror (void)
	Formats an error message for vlc_dlopen() or vlc_dlsym().

vlc_plugin_t *	vlc_cache_load (libvlc_int_t , const char , block_t **)

vlc_plugin_t *	vlc_cache_lookup (vlc_plugin_t *, const char relpath)

void	CacheSave (libvlc_int_t , const char , vlc_plugin_t const , size_t)

Variables
struct vlc_plugin_t *	vlc_plugins
	List of all plug-ins.

Macro Definition Documentation

◆ MODULE_SHORTCUT_MAX

#define MODULE_SHORTCUT_MAX 20

Typedef Documentation

◆ vlc_deactivate_cb

typedef void(* vlc_deactivate_cb) (vlc_object_t *)

Plugin deactivation callback.

◆ vlc_plugin_t

typedef struct vlc_plugin_t vlc_plugin_t

VLC plugin.

Function Documentation

◆ CacheSave()

void CacheSave	(	libvlc_int_t *	,
		const char *	,
		vlc_plugin_t const	,
		size_t
	)

◆ module_EndBank()

void module_EndBank ( bool b_plugins )

Unloads all unused plugin modules and empties the module bank in case of success.

References block_ChainRelease, caches, caps_tree, config_UnsortConfig(), vlc_plugin_t::count, modules, vlc_plugin_t::next, tdestroy(), vlc_modcap_free(), vlc_mutex_assert, vlc_mutex_lock(), vlc_mutex_unlock(), vlc_plugin_destroy(), vlc_plugin_Unmap(), and vlc_plugins.

Referenced by libvlc_InternalCleanup().

◆ module_InitBank()

void module_InitBank ( void )

Init bank.

Creates a module bank structure which will be filled later on with all the modules found.

References config_SortConfig(), likely, module_InitStatic(), modules, VLC_MODULE_ENTRY, vlc_mutex_lock(), and vlc_plugin_store().

Referenced by libvlc_InternalInit().

◆ module_list_cap()

size_t module_list_cap	(	module_t const *	tab,
		const char *	name
	)

Lists of all VLC modules with a given capability.

This functions returns a table of all VLC modules whose capability matches the supplied capability name. Entries are sorted by decreasing module score.

Note: This function cannot fail. It returns zero if, and only if, no modules match the requested capability inside the module bank.

Parameters

tab	pointer to the table of modules [OUT]
name	capability nul-terminated string (cannot be NULL)

Returns: the number of entries in the table

◆ module_LoadPlugins()

void module_LoadPlugins ( libvlc_int_t * obj )

Loads module descriptions for all available plugins.

Fills the module bank structure with the plugin modules.

Parameters

obj	vlc object structure

References config_SortConfig(), config_UnsortConfig(), module_InitStaticModules(), modules, msg_Dbg, twalk(), vlc_modcap_sort(), and vlc_mutex_unlock().

Referenced by libvlc_InternalInit().

◆ vlc_bindtextdomain()

int vlc_bindtextdomain ( const char * domain )

References config_GetSysPath(), LocaleFree, ToLocale, unlikely, and VLC_LOCALE_DIR.

Referenced by libvlc_InternalInit().

◆ vlc_cache_load()

vlc_plugin_t * vlc_cache_load	(	libvlc_int_t *	,
		const char *	,
		block_t **
	)

◆ vlc_cache_lookup()

vlc_plugin_t * vlc_cache_lookup	(	vlc_plugin_t **	,
		const char *	relpath
	)

◆ vlc_dlclose()

int vlc_dlclose ( void * handle )

Unloads a dynamic library.

This function unloads a previously opened dynamically linked library using a system dependent method.

Parameters

handle handle of the library

Return values

0	on success
-1	on error (none are defined though)

◆ vlc_dlerror()

char * vlc_dlerror ( void )

Formats an error message for vlc_dlopen() or vlc_dlsym().

Returns: a heap-allocated nul-terminated error string, or NULL.

References FromLocaleDup, and strdup().

◆ vlc_dlopen()

void * vlc_dlopen	(	const char *	path,
		bool	lazy
	)

Loads a dynamically linked library.

Parameters

path	library file path
lazy	whether to resolve the symbols lazily

Returns: a module handle on success, or NULL on error.

References ToLocaleDup, unlikely, and VLC_UNUSED.

◆ vlc_dlsym()

void * vlc_dlsym	(	void *	handle,
		const char *	name
	)

Looks up a symbol from a dynamically loaded library.

This function looks for a named symbol within a loaded library.

Parameters

handle	handle to the library
name	function name

Returns: the address of the symbol on success, or NULL on error

Note: If the symbol address is NULL, errors cannot be detected. However, normal symbols such as function or global variables cannot have NULL as their address.

References name.