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.

Defines

#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_GetLongName(m)   module_get_name( m, true )

#define module_get_main(a)   module_get_main()

Functions

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

module Need

void __module_unneed (vlc_object_t *, module_t *)

Module unneed.

bool module_exists (const char *)

Tell if a module exists and release it in thic case.

module_t * module_find (const char *)

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

module_config_t * module_config_get (const module_t *, unsigned *)

void module_config_free (module_config_t *)

Release the configuration.

module_t * module_hold (module_t *module)

void module_release (module_t *module)

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)

Get the capability for a module.

int module_get_score (const module_t *m)

Get the score for a module.

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.

Define Documentation

#define module_get_main ( a ) module_get_main()

Referenced by AdvPrefsPanel::AdvPrefsPanel(), PrefsTree::PrefsTree(), and PrefsTreeCtrl::PrefsTreeCtrl().

#define module_GetLongName ( m ) module_get_name( m, true )

Referenced by AdvPrefsPanel::AdvPrefsPanel(), ModuleConfigControl::ModuleConfigControl, and PrefsPanel::PrefsPanel().

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

Referenced by __access_New(), __demux_New(), __xml_Create(), Add(), aout_InputNew(), aout_MixerNew(), aout_OutputNew(), ChromaCreate(), CreateAndLoadScale(), CreateDecoder(), CreateEncoder(), CreateFilter(), CreateVout(), demux_PacketizerNew(), Filter(), filter_chain_AppendFilterInternal(), filter_ConfigureBlend(), FindArt(), FindFilter(), Init(), input_item_WriteMeta(), InputSourceMeta(), intf_Create(), libvlc_InternalInit(), OpenTextRenderer(), osd_ParserLoad(), playlist_Export(), RenderCursor(), RunThread(), sout_AccessOutNew(), sout_MuxNew(), sout_StreamNew(), SpuRenderCreateAndLoadText(), sql_Create(), stream_FilterNew(), tls_ClientCreate(), tls_ServerCreate(), transcode_audio_new(), transcode_video_encoder_open(), video_splitter_New(), vlc_inhibit_Create(), vlc_sd_Start(), vlm_ControlMediaAdd(), vout_display_New(), and vout_window_New().

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

Referenced by access_Delete(), Add(), aout_FiltersDestroyPipeline(), aout_InputNew(), aout_MixerDelete(), aout_OutputDelete(), aout_OutputNew(), ChromaDestroy(), CloseTextRenderer(), Del(), DeleteDecoder(), DeleteEncoder(), DeleteFilter(), demux_Delete(), demux_PacketizerDestroy(), End(), Filter(), filter_chain_AppendFilterInternal(), filter_chain_DeleteFilterInternal(), filter_ConfigureBlend(), filter_DeleteBlend(), FilterRelease(), FindArt(), input_DecoderDelete(), input_DecoderNew(), input_DecoderSetCcState(), input_item_WriteMeta(), InputSourceMeta(), intf_Create(), intf_DestroyAll(), libvlc_InternalCleanup(), libvlc_InternalInit(), osd_ParserUnload(), playlist_Export(), ReleaseFilter(), RunThread(), sout_AccessOutDelete(), sout_MuxDelete(), sout_StreamDelete(), sql_Destroy(), StreamDelete(), tls_ClientCreate(), tls_ClientDelete(), tls_ServerDelete(), transcode_audio_new(), transcode_osd_close(), transcode_video_close(), video_splitter_Delete(), vlc_inhibit_Destroy(), vlc_sd_Stop(), vlm_ControlMediaDel(), vout_display_Delete(), vout_window_Delete(), and xml_Delete().

Function Documentation

module_t* __module_need	(	vlc_object_t *	p_this,
		const char *	psz_capability,
		const char *	psz_name,
		bool	b_strict
	)

module Need

Return the best module function, given a capability list.

Parameters:

	p_this	the vlc object
	psz_capability	list of capabilities needed
	psz_name	name of the module asked
	b_strict	TRUE yto use the strict mode

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

References module_t::b_builtin, module_list_t::b_force, vlc_object_t::b_force, module_t::b_loaded, module_t::b_submodule, c, CacheMerge(), DeleteModule(), i, module_t::i_cpu, module_list_t::i_score, module_t::i_score, module_hold(), module_list_free(), module_list_get(), module_provides(), module_release(), modulecmp(), msg_Dbg, msg_Err, msg_StackSet(), msg_Warn, name, module_list_t::p_module, module_t::parent, module_t::pf_activate, module_t::pp_shortcuts, module_t::psz_filename, module_t::psz_object_name, STATS_TIMER_MODULE_NEED, stats_TimerClean, stats_TimerDump, stats_TimerStart, stats_TimerStop, strcasecmp(), strdup(), strncasecmp(), var_CreateGetString, vlc_CPU(), VLC_EGENERIC, VLC_ETIMEOUT, vlc_object_set_name, and VLC_SUCCESS.

void __module_unneed	(	vlc_object_t *	p_this,
		module_t *	p_module
	)

Module unneed.

This function must be called by the thread that called module_need, to decrease the reference count and allow for hiding of modules.

Parameters:

	p_this	vlc object structure
	p_module	the module structure

Returns:: nothing

References module_release(), msg_Dbg, module_t::pf_deactivate, and module_t::psz_object_name.

void module_config_free ( module_config_t * config )

Release the configuration.

Parameters:

the

configuration

Returns:: nothing

Referenced by ModuleListConfigControl::initWithItem:withView:, PrefsTree::PrefsTree(), and PrefsTreeCtrl::PrefsTreeCtrl().

module_config_t* module_config_get	(	const module_t *	,
		unsigned *
	)

bool module_exists ( const char * psz_name )

Tell if a module exists and release it in thic case.

Parameters:

psz_name

th name of the module

Returns:: TRUE if the module exists

References module_find(), and module_release().

Referenced by aout_InputNew(), SPrefsPanel::apply(), CaptureOpenPanel::initialize(), libvlc_audio_output_set(), OpenDecoder(), ParseImageAttachments(), VLCSimplePrefs::resetControls, VLCSimplePrefs::saveChangedSettings, VLCSimplePrefs::showFontPicker:, and SPrefsPanel::SPrefsPanel().

module_t* module_find ( const char * psz_name )

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

Parameters:

psz_name

the name of the module

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

References i, module_hold(), module_list_free(), module_list_get(), and module_t::psz_object_name.

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

const char* module_get_capability ( const module_t * m )

Get the capability for a module.

Parameters:

m

the module return the capability

References module_t::psz_capability.

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.

Referenced by AdvPrefsPanel::AdvPrefsPanel().

static module_t* module_get_main ( void ) [inline, static]

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_t::psz_longname, module_t::psz_object_name, and module_t::psz_shortname.

Referenced by filter_chain_AppendFilterInternal(), libvlc_audio_output_list_get(), module_GetModulesNamesForCapability(), mvar_ObjectSetNew(), playlist_ServicesDiscoveryAdd(), PrefsTree::PrefsTree(), PrefsTreeCtrl::PrefsTreeCtrl(), 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::psz_object_name.

Referenced by ModuleListConfigControl::initWithItem:withView:, libvlc_audio_output_list_get(), module_is_main(), ModuleConfigControl::ModuleConfigControl, mvar_ObjectSetNew(), PrefsPanel::PrefsPanel(), PrefsTree::PrefsTree(), and PrefsTreeCtrl::PrefsTreeCtrl().

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.

module_t* module_hold ( module_t * module )

References module_t::vlc_gc_data, and vlc_hold().

Referenced by __module_need(), module_find(), module_find_by_shortcut(), and module_list_get().

static bool module_is_main ( const module_t * p_module ) [inline, static]

References module_get_object().

Referenced by ModuleListConfigControl::initWithItem:withView:, PrefsTree::PrefsTree(), and PrefsTreeCtrl::PrefsTreeCtrl().

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.

References i, and module_release().

Referenced by __config_LoadCmdLine(), __config_LoadConfigFile(), __config_ResetAll(), __module_need(), config_AutoSaveConfigFile(), config_FindConfig(), ModuleListConfigControl::initWithItem:withView:, libvlc_audio_output_list_get(), libvlc_InternalInit(), ListModules(), module_find(), module_find_by_shortcut(), module_GetModulesNamesForCapability(), module_list_get(), ModuleConfigControl::ModuleConfigControl, mvar_ObjectSetNew(), PrefsTree::PrefsTree(), PrefsTreeCtrl::PrefsTreeCtrl(), SaveConfigFile(), and Usage().

module_t** module_list_get ( size_t * n )

Gets the flat list of VLC modules.

Parameters:

n

[OUT] pointer to the number of modules or NULL

Returns:: NULL-terminated table of module pointers (release with module_list_free()), or NULL in case of error.

References module_bank_t::head, i, module_hold(), module_list_free(), and module_t::next.

Referenced by __config_LoadCmdLine(), __config_LoadConfigFile(), __config_ResetAll(), __module_need(), config_AutoSaveConfigFile(), config_FindConfig(), ModuleListConfigControl::initWithItem:withView:, libvlc_audio_output_list_get(), libvlc_InternalInit(), ListModules(), module_find(), module_find_by_shortcut(), module_GetModulesNamesForCapability(), ModuleConfigControl::ModuleConfigControl, mvar_ObjectSetNew(), PrefsPanel::PrefsPanel(), PrefsTree::PrefsTree(), PrefsTreeCtrl::PrefsTreeCtrl(), SaveConfigFile(), and Usage().

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 have the capability

References module_t::psz_capability.

Referenced by __module_need(), libvlc_audio_output_list_get(), ModuleConfigControl::ModuleConfigControl, mvar_ObjectSetNew(), and vout_EnableFilter().

void module_release ( module_t * module )

References module_t::vlc_gc_data, and vlc_release().

Referenced by __module_need(), __module_unneed(), AdvPrefsPanel::AdvPrefsPanel(), AllocateBuiltinModule(), DeleteModule(), module_exists(), module_list_free(), playlist_ServicesDiscoveryAdd(), PrefsTree::PrefsTree(), and vout_EnableFilter().


Defines
#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_GetLongName(m) module_get_name( m, true )
#define	module_get_main(a) module_get_main()
Functions
module_t *	__module_need (vlc_object_t , const char , const char *, bool)
	module Need
void	__module_unneed (vlc_object_t , module_t )
	Module unneed.
bool	module_exists (const char *)
	Tell if a module exists and release it in thic case.
module_t *	module_find (const char *)
	Get a pointer to a module_t given it's name.
module_config_t *	module_config_get (const module_t , unsigned )
void	module_config_free (module_config_t *)
	Release the configuration.
module_t *	module_hold (module_t *module)
void	module_release (module_t *module)
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)
	Get the capability for a module.
int	module_get_score (const module_t *m)
	Get the score for a module.
static module_t *	module_get_main (void)
static bool	module_is_main (const module_t *p_module)