Include dependency graph for modules.c:

Functions
bool	module_provides (const module_t m, const char cap)
	Checks whether a module implements a capability. More...

const char *	module_get_object (const module_t *m)
	Gets the internal name of a module. More...

const char *	module_get_name (const module_t *m, bool long_name)
	Gets the human-friendly name of a module. More...

const char *	module_get_help (const module_t *m)
	Gets the help text for a module. More...

const char *	module_get_help_html (const module_t *m)
	Gets the help HTML for a module. More...

const char *	module_get_capability (const module_t *m)
	Gets the capability string of a module. More...

int	module_get_score (const module_t *m)
	Gets the precedence of a module. More...

const char *	module_gettext (const module_t m, const char str)
	Translates a string using the module's text domain. More...

static bool	module_match_name (const module_t m, const char name, size_t len)

ssize_t	vlc_module_match (const char capability, const char names, bool strict, module_t **restrict modules, size_t restrict strict_matches)
	Finds the candidate modules for given criteria. More...

void *	vlc_module_map (vlc_logger_t log, module_t module)
	Maps a module in memory. More...

module_t *()	vlc_module_load (struct vlc_logger log, const char capability, const char *name, bool strict, vlc_activate_t probe,...)
	Finds and instantiates the best module of a certain type. More...

static int	generic_start (void *func, bool forced, va_list ap)

module_t *	module_need (vlc_object_t obj, const char cap, const char *name, bool strict)

void	module_unneed (vlc_object_t obj, module_t module)

module_t *	module_find (const char *name)
	Get a pointer to a module_t given it's name. More...

module_config_t *	module_config_get (const module_t module, unsigned restrict psize)
	Gets the table of module configuration items. More...

void	module_config_free (module_config_t *config)
	Releases a configuration items table. More...

Function Documentation

◆ generic_start()

static int generic_start	(	void *	func,
		bool	forced,
		va_list	ap
	)

static

References vlc_object_t::force, vlc_objres_clear(), and VLC_SUCCESS.

Referenced by module_need().

◆ module_config_free()

void module_config_free ( module_config_t * tab )

Releases a configuration items table.

Parameters

tab	base address of a table returned by module_config_get()

References config.

◆ module_config_get()

module_config_t * module_config_get	(	const module_t *	module,
		unsigned *restrict	psize
	)

Gets the table of module configuration items.

Note: Use module_config_free() to release the allocated memory.

Parameters

module	the module
psize	the size of the configuration returned

Returns: the configuration as an array

References vlc_plugin_t::conf, config, vlc_param::i, vlc_param::internal, vlc_param::item, vlc_plugin_t::module, vlc_param::obsolete, vlc_plugin_t::params, module_t::plugin, vlc_plugin_t::size, and vlc_alloc().

◆ module_find()

module_t * module_find ( const char * name )

Get a pointer to a module_t given it's name.

Parameters

name	the name of the module

Returns: a pointer to the module or NULL in case of a failure

References count, module_t::i_shortcuts, list, module_list_free(), module_list_get(), name, module_t::pp_shortcuts, and unlikely.

Referenced by module_exists(), and module_get_main().

◆ module_get_capability()

const char * module_get_capability ( const module_t * m )

Gets the capability string of a module.

Parameters

m	the module

Returns: the capability, or "none" if unspecified

References module_t::psz_capability.

Referenced by module_provides(), module_unneed(), and vlc_module_store().

◆ module_get_help()

const char * module_get_help ( const module_t * m )

Gets the help text for a module.

Parameters

m	the module

Returns: the help

References module_t::psz_help.

◆ module_get_help_html()

const char * module_get_help_html ( const module_t * m )

Gets the help HTML for a module.

Parameters

m	the module

Returns: the help HTML

References module_t::psz_help_html.

◆ module_get_name()

const char * module_get_name	(	const module_t *	m,
		bool	longname
	)

Gets the human-friendly name of a module.

Parameters

m	the module
longname	TRUE to have the long name of the module

Returns: the short or long name of the module

References module_get_object(), module_t::psz_longname, and module_t::psz_shortname.

Referenced by vlc_rtp_pt_instantiate().

◆ module_get_object()

const char * module_get_object ( const module_t * m )

Gets the internal name of a module.

Parameters

m	the module

Returns: the module name

References module_t::i_shortcuts, module_t::pp_shortcuts, and unlikely.

Referenced by config_ListModules(), config_SaveConfigFile(), ListModules(), module_get_name(), module_is_main(), module_match(), module_need(), module_unneed(), Usage(), vlc_module_load(), and vout_display_New().

◆ module_get_score()

int module_get_score ( const module_t * m )

Gets the precedence of a module.

Parameters

m	the module return the score for the capability

References module_t::i_score.

Referenced by vlc_module_match().

◆ module_gettext()

const char * module_gettext	(	const module_t *	m,
		const char *	s
	)

Translates a string using the module's text domain.

Parameters

m	the module
s	the American English ASCII string to localize

Returns: the gettext-translated string

References module_t::plugin, vlc_plugin_t::textdomain, and unlikely.

Referenced by config_ListModules(), ListModules(), print_item(), print_section(), and Usage().

◆ module_match_name()

static bool module_match_name	(	const module_t *	m,
		const char *	name,
		size_t	len
	)

static

References module_t::i_shortcuts, name, and module_t::pp_shortcuts.

Referenced by vlc_module_match().

◆ module_need()

module_t * module_need	(	vlc_object_t *	obj,
		const char *	cap,
		const char *	name,
		bool	strict
	)

References vlc_object_t::force, generic_start(), vlc_object_t::logger, module_get_object(), name, var_Create(), var_SetString(), vlc_module_load(), and VLC_VAR_STRING.

◆ module_provides()

bool module_provides	(	const module_t *	m,
		const char *	cap
	)

Checks whether a module implements a capability.

Parameters

m	the module
cap	the capability to check

Return values

true	if the module has the capability
false	if the module has another capability

References module_get_capability().

◆ module_unneed()

void module_unneed	(	vlc_object_t *	obj,
		module_t *	module
	)

References module_t::deactivate, module_get_capability(), module_get_object(), msg_Dbg, var_Destroy(), and vlc_objres_clear().

◆ vlc_module_load()

module_t *() vlc_module_load	(	struct vlc_logger *	log,
		const char *	capability,
		const char *	name,
		bool	strict,
		vlc_activate_t	probe,
			...
	)

Finds and instantiates the best module of a certain type.

All candidates modules having the specified capability and name will be sorted in decreasing order of priority. Then the probe callback will be invoked for each module, until it succeeds (returns 0), or all candidate module failed to initialize.

The probe callback first parameter is the address of the module entry point. Further parameters are passed as an argument list; it corresponds to the variable arguments passed to this function. This scheme is meant to support arbitrary prototypes for the module entry point.

Parameters

log	logger (or NULL to ignore)
capability	capability, i.e. class of module
name	name of the module asked, if any
strict	if true, do not fallback to plugin with a different name but the same capability
probe	module probe callback

Returns: the module or NULL in case of a failure

References module_get_object(), name, unlikely, vlc_debug, VLC_EGENERIC, VLC_ETIMEOUT, vlc_module_map(), vlc_module_match(), and VLC_SUCCESS.

Referenced by module_need().

◆ vlc_module_map()

void * vlc_module_map	(	struct vlc_logger *	log,
		module_t *	mod
	)

Maps a module in memory.

This function attempts to map a given module in memory, if it is not already mapped. If it is already mapped, this function does nothing.

Parameters

log	message logger
mod	module to map

Returns: the module activation function on success, NULL on failure

References module_t::pf_activate, module_t::plugin, and vlc_plugin_Map().

Referenced by libvlc_AutoRun(), vlc_CPU_functions_init(), vlc_module_load(), vlc_rtp_pt_instantiate(), vlc_tls_ClientCreate(), vlc_tls_ServerCreate(), and vout_display_New().

◆ vlc_module_match()

ssize_t vlc_module_match	(	const char *	capability,
		const char *	names,
		bool	strict,
		module_t ***restrict	modules,
		size_t *restrict	strict_matches
	)

Finds the candidate modules for given criteria.

All candidates modules having the specified capability and name will be sorted in decreasing order of priority and returned in a heap-allocated table.

Parameters

capability	capability, i.e. class of module
names	string of comma-separated requested module shortcut names, or NULL for defaults
strict	whether to exclude modules with no unmatching shortcut names
modules	storage location for the base address of a sorted table of candidate modules (NULL on error) [OUT]
strict_matches	storage location for the count of strictly matched modules [OUT]

Returns: number of modules found or a strictly negative value on error

References module_get_score(), module_list_cap(), module_match_name(), modules, and unlikely.

Referenced by libvlc_AutoRun(), vlc_CPU_functions_init(), vlc_module_load(), vlc_rtp_pt_instantiate(), vlc_tls_ClientCreate(), vlc_tls_ServerCreate(), and vout_display_New().

Functions

Function Documentation

◆ generic_start()

◆ module_config_free()

◆ module_config_get()

◆ module_find()

◆ module_get_capability()

◆ module_get_help()

◆ module_get_help_html()

◆ module_get_name()

◆ module_get_object()

◆ module_get_score()

◆ module_gettext()

◆ module_match_name()

◆ module_need()

◆ module_provides()

◆ module_unneed()

◆ vlc_module_load()

◆ vlc_module_map()

◆ vlc_module_match()