Documentation:VLC Modules Loading

VLC modules loading

How does VLC load modules?

Introduction about Modules

VLC has a core and a lot of modules (between 200 and 400 depending on the build).

VLC cannot do much without modules, since modules are providing most of the functionnalities we expect. See the "Major Capabilites" sections.

A VLC module has 2 major properties:

• the capability, VLC_MODULE_CAPABILITY, that describes the category of the module
• the score, VLC_MODULE_SCORE, that holds the priority of the module

How does the loading of modules happens

VLC keeps a list of detected VLC modules (named the plugins cache).

When VLC needs a module, it tries to open a the higher-score capability-matching module that accept the request.

Let's do an example.

When VLC needs a "decoder" ("decoder" is one category/capability), it opens all "decoder" modules, until one matches.

It opens them in decreasing score order (bigger score first, smaller ones at the end), and runs the Open() function of the modules. When one module returns OK, VLC uses this module.

Advanced infos about modules loading

Score of 0

If a module has a score of 0, it needs to be explicitly requested by the user (like forcing --codec or --vout) to be loaded.

all, none and other special tweaks

• The "all" mode means all modules will be tested in decreasing order of score.

• The "none" mode means no modules will be tested.

• Any module can be requested by using its direct shortname. This is useful for 0-scored modules.

examples

Modules requests can be chained, as the examples show:

--codec avcodec,all
try the avcodec module than all modules as a "decoder"

--demux avformat,none
 try the avformat module and no other module

By default, modules requests are in the "all" mode, and "all" can be omitted.

How to list Modules

• Using Console

vlc --list

• Using GUI

Menu -> Tools -> Plugins and extensions

Major Capabilities

• audio filter : an audio filter, like an equalizer
• audio mixer : an audio channel mixer, like a downmixer
• audio output : an audio output, like Windows DirectX audio output
• decoder : a codec decoder, like theora
• demux : a demuxer, to open a file format, like mkv
• encoder : a codec encoder, like x264
• interface : an interface, like the Qt interface
• meta reader : a meta reader, to read metadata
• packetizer : a packetizer
• playlist export : a module to write playlist, like .m3u
• services_discovery : a module to get extra content from your computer or the network, like Upnp, DLNA
• sout access : a
• sout mux : a
• sout stream : a
• stream_filter : a
• text renderer : a
• video filter : a
• visualization2 : a
• vout display : a