vlc_modules.h File Reference

This file defines functions for modules in vlc. More...

Include dependency graph for vlc_modules.h:

Go to the source code of this file.

Macros
#define	vlc_module_load(o, c, n, s,...)   vlc_module_load(VLC_OBJECT(o),c,n,s,__VA_ARGS__)
#define	module_need(a, b, c, d)   module_need(VLC_OBJECT(a),b,c,d)
#define	module_unneed(a, b)   module_unneed(VLC_OBJECT(a),b)
#define	module_start(o, m)   module_start(VLC_OBJECT(o),m)
#define	module_stop(o, m)   module_stop(VLC_OBJECT(o),m)
#define	module_GetLongName(m)   module_get_name( m, true )
#define	module_get_main(a)   module_get_main()

Typedefs
typedef int(*	vlc_activate_t )(void *func, va_list args)
typedef void(*	vlc_deactivate_t )(void *func, va_list args)

Functions
module_t *	vlc_module_load (vlc_object_t *obj, const char *cap, const char *name, bool strict, vlc_activate_t probe,...)
void	vlc_module_unload (module_t *, vlc_deactivate_t deinit,...)
	Deinstantiates a module.
module_t *	module_need (vlc_object_t *, const char *, const char *, bool)
void	module_unneed (vlc_object_t *, module_t *)
bool	module_exists (const char *)
	Tell if a module exists.
module_t *	module_find (const char *)
	Get a pointer to a module_t given it's name.
int	module_start (vlc_object_t *, const module_t *)
void	module_stop (vlc_object_t *, const module_t *)
module_config_t *	module_config_get (const module_t *, unsigned *)
void	module_config_free (module_config_t *)
	Release the configuration.
void	module_list_free (module_t **)
	Frees the flat list of VLC modules.
module_t **	module_list_get (size_t *n)
	Gets the flat list of VLC modules.
bool	module_provides (const module_t *m, const char *cap)
	Checks whether a module implements a capability.
const char *	module_get_object (const module_t *m)
	Get the internal name of a module.
const char *	module_get_name (const module_t *m, bool long_name)
	Get the human-friendly name of a module.
const char *	module_get_help (const module_t *m)
	Get the help for a module.
const char *	module_get_capability (const module_t *m)
	Gets the capability of a module.
int	module_get_score (const module_t *m)
	Get the score for a module.
const char *	module_gettext (const module_t *, const char *)
	Translate a string using the module's text domain.
static module_t *	module_get_main (void)
static bool	module_is_main (const module_t *p_module)

Detailed Description

This file defines functions for modules in vlc.

Macro Definition Documentation

#define module_get_main

(

a

)

module_get_main()

#define module_GetLongName

(

m

)

module_get_name( m, true )

#define module_need	(		a,
			b,
			c,
			d
	)		module_need(VLC_OBJECT(a),b,c,d)

Referenced by access_New(), aout_New(), aout_volume_SetFormat(), CreateDecoder(), CreateEncoder(), CreateFilter(), demux_New(), demux_PacketizerNew(), FetchMeta(), filter_chain_AppendFilterInternal(), filter_ConfigureBlend(), FindArt(), FindFilter(), input_item_WriteMeta(), InputSourceMeta(), intf_Create(), playlist_Export(), sout_AccessOutNew(), sout_MuxNew(), sout_StreamNew(), SpuRenderCreateAndLoadScale(), SpuRenderCreateAndLoadText(), sql_Create(), stream_FilterNew(), video_splitter_New(), vlc_gl_Create(), vlc_inhibit_Create(), vlc_probe(), vlc_sd_Start(), vlm_ControlMediaAdd(), vout_display_New(), xml_Create(), and xml_ReaderCreate().

#define module_start	(		o,
			m
	)		module_start(VLC_OBJECT(o),m)

Referenced by xml_ReaderReset().

#define module_stop	(		o,
			m
	)		module_stop(VLC_OBJECT(o),m)

Referenced by xml_ReaderDelete(), and xml_ReaderReset().

#define module_unneed	(		a,
			b
	)		module_unneed(VLC_OBJECT(a),b)

Referenced by access_Delete(), aout_Destroy(), aout_FiltersNew(), aout_FiltersPipelineDestroy(), aout_volume_Delete(), aout_volume_SetFormat(), decoder_New(), DeleteDecoder(), DeleteEncoder(), DeleteFilter(), demux_Delete(), demux_PacketizerDestroy(), FetchMeta(), filter_chain_AppendFilterInternal(), filter_chain_DeleteFilterInternal(), filter_ConfigureBlend(), filter_DeleteBlend(), FilterRelease(), FindArt(), input_DecoderDelete(), input_DecoderSetCcState(), input_item_WriteMeta(), InputSourceMeta(), intf_Create(), intf_DestroyAll(), playlist_Export(), sout_AccessOutDelete(), sout_MuxDelete(), sout_StreamDelete(), sql_Destroy(), StreamDelete(), video_splitter_Delete(), vlc_gl_Destroy(), vlc_inhibit_Destroy(), vlc_probe(), vlc_sd_Stop(), vlm_Delete(), vout_display_Delete(), and xml_Delete().

#define vlc_module_load	(		o,
			c,
			n,
			s,
			...
	)		vlc_module_load(VLC_OBJECT(o),c,n,s,__VA_ARGS__)

Referenced by module_need(), vlc_tls_ClientCreate(), vlc_tls_ServerCreate(), and vout_window_New().

Typedef Documentation

typedef int(* vlc_activate_t)(void *func, va_list args)

typedef void(* vlc_deactivate_t)(void *func, va_list args)

Function Documentation

void module_config_free

(

module_config_t *

config

)

Release the configuration.

Parameters

the	configuration

Returns

nothing

module_config_t* module_config_get	(	const module_t *	,
		unsigned *
	)

bool module_exists

(

const char *

psz_name

)

Tell if a module exists.

Parameters

psz_name

th name of the module

Returns

TRUE if the module exists

References module_find().

Referenced by aout_New().

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(), module_t::pp_shortcuts, and unlikely.

Referenced by module_exists(), module_get_main(), and vout_EnableFilter().

const char* module_get_capability

(

const module_t *

m

)

Gets the capability of a module.

Parameters

m	the module

Returns

the capability, or "none" if unspecified

References module_t::psz_capability.

Referenced by module_provides().

const char* module_get_help

(

const module_t *

m

)

Get the help for a module.

Parameters

m	the module

Returns

the help

References module_t::psz_help.

static module_t* module_get_main ( void  )

inlinestatic

References module_find().

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

Get the human-friendly name of a module.

Parameters

m	the module
long_name	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 config_ListModules(), filter_chain_AppendFilterInternal(), and services_discovery_GetLocalizedName().

const char* module_get_object

(

const module_t *

m

)

Get 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_unneed(), Usage(), and vlc_module_load().

int module_get_score

(

const module_t *

m

)

Get the score for a module.

Parameters

m	the module return the score for the capability

References module_t::i_score.

Referenced by vlc_module_load().

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

Translate a string using the module's text domain.

Parameters

m	the module
str	the American English ASCII string to localize

Returns

the gettext-translated string

References module_t::domain, module_t::parent, and unlikely.

Referenced by config_ListModules(), ListModules(), print_help_section(), and Usage().

static bool module_is_main ( const module_t *  p_module )

inlinestatic

References module_get_object().

void module_list_free

(

module_t **

list

)

Frees the flat list of VLC modules.

Parameters

list	list obtained by module_list_get()
length	number of items on the list

Returns

nothing.

Referenced by config_LoadCmdLine(), config_ResetAll(), config_SaveConfigFile(), config_SortConfig(), ListModules(), module_find(), module_find_by_shortcut(), module_LoadPlugins(), Usage(), and vlc_module_load().

module_t** module_list_get

(

size_t *

n

)

Gets the flat list of VLC modules.

Parameters

n	[OUT] pointer to the number of modules

Returns

table of module pointers (release with module_list_free()), or NULL in case of error (in that case, *n is zeroed).

References modules, module_t::next, module_t::submodule, and unlikely.

Referenced by config_LoadCmdLine(), config_ResetAll(), config_SaveConfigFile(), config_SortConfig(), ListModules(), module_find(), module_find_by_shortcut(), module_LoadPlugins(), and Usage().

module_t* module_need	(	vlc_object_t *	,
		const char *	,
		const char *	,
		bool
	)

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

Returns

true if the module has the capability

References module_get_capability().

Referenced by module_list_cap(), and vout_EnableFilter().

int module_start	(	vlc_object_t *	,
		const module_t *
	)

void module_stop	(	vlc_object_t *	,
		const module_t *
	)

void module_unneed	(	vlc_object_t *	,
		module_t *
	)

module_t* vlc_module_load	(	vlc_object_t *	obj,
		const char *	cap,
		const char *	name,
		bool	strict,
		vlc_activate_t	probe,
			...
	)

void vlc_module_unload	(	module_t *	module,
		vlc_deactivate_t	deinit,
			...
	)

Deinstantiates a module.

Parameters

module	the module pointer as returned by vlc_module_load()
deinit	deactivation callback

References module_t::pf_deactivate.

Referenced by module_unneed(), vlc_tls_Delete(), and vout_window_Delete().