Documentation:VLC Modules Loading - Revision history

DoesItReallyMatter: +{{Back to|Hacker Guide}}

2019-04-17T03:47:11Z

+{{Back to|Hacker Guide}}

← Older revision		Revision as of 03:47, 17 April 2019
Line 1:		Line 1:
			{{Back to\|Hacker Guide}}
	'''VLC modules loading'''		'''VLC modules loading'''

DoesItReallyMatter: Link to page anchor #Capabilities from within page, correct spelling

2019-02-15T07:26:09Z

Link to page anchor #Capabilities from within page, correct spelling

← Older revision		Revision as of 07:26, 15 February 2019
Line 7:		Line 7:
	VLC has a core and a lot of modules (between 200 and 400 depending on the build).		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 functionalities we expect. See the "Major ~~Capabilites"~~ sections.		VLC cannot do much without modules, since modules are providing most of the functionalities we expect. See the [[#Capabilities\|Major Capabilities]] sections.

	A VLC module has 2 ''major'' ''properties'':		A VLC module has 2 ''major'' ''properties'':

DoesItReallyMatter: Set page anchor #Advanced for "Advanced info about modules loading", rename section "examples" → "Examples", set page anchor #Capabilities for "Major Capabilities of Modules"

2019-02-15T07:23:51Z

Set page anchor #Advanced for "Advanced info about modules loading", rename section "examples" → "Examples", set page anchor #Capabilities for "Major Capabilities of Modules"

← Older revision		Revision as of 07:23, 15 February 2019
Line 29:		Line 29:
	It opens them in decreasing score order (biggest score first, smaller ones at the end), and runs the Open() function of the modules. When one module returns OK, VLC uses this module.		It opens them in decreasing score order (biggest 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 info about modules loading ===		=== <span id="Advanced"></span> Advanced info about modules loading ===

	==== Score of 0 ====		==== Score of 0 ====
Line 43:		Line 43:
	*Any module can be requested by using its direct shortname. This is useful for 0-scored modules.		*Any module can be requested by using its direct shortname. This is useful for 0-scored modules.

	==== ~~examples~~ ====		==== Examples ====

	Modules requests can be chained, as the '''examples''' show:		Modules requests can be chained, as the '''examples''' show:
Line 66:		Line 66:
	Menu → Tools → Plugins and extensions		Menu → Tools → Plugins and extensions

	== Major Capabilities of Modules ==		== <span id="Capabilities"></span> Major Capabilities of Modules ==

	; <code>audio filter</code>		; <code>audio filter</code>

DoesItReallyMatter: Setting page anchors: #How for "How does VLC load modules?", #Introduction for "Introduction about Modules", #Process for "How does the loading of modules happen"

2019-02-15T07:17:39Z

Setting page anchors: #How for "How does VLC load modules?", #Introduction for "Introduction about Modules", #Process for "How does the loading of modules happen"

← Older revision		Revision as of 07:17, 15 February 2019
Line 1:		Line 1:
	'''VLC modules loading'''		'''VLC modules loading'''

	== How does VLC load modules? ==		== <span id="How"></span> How does VLC load modules? ==

	=== Introduction about Modules ===		=== <span id="Introduction"></span> Introduction about Modules ===

	VLC has a core and a lot of modules (between 200 and 400 depending on the build).		VLC has a core and a lot of modules (between 200 and 400 depending on the build).
Line 14:		Line 14:
	*the score, VLC_MODULE_SCORE, that holds the priority of the module		*the score, VLC_MODULE_SCORE, that holds the priority of the module

	=== How does the loading of modules happen ===		=== <span id="Process"></span> How does the loading of modules happen ===

	The first time you load VLC, it will scan the default '''plugins''' directories that should contain VLC modules and generate a cache (named the '''plugins cache''') so that the modules can be loaded quickly the next time VLC launches. Modules can be organized into directories (up to 5 layers deep) beneath the '''plugins''' directory.		The first time you load VLC, it will scan the default '''plugins''' directories that should contain VLC modules and generate a cache (named the '''plugins cache''') so that the modules can be loaded quickly the next time VLC launches. Modules can be organized into directories (up to 5 layers deep) beneath the '''plugins''' directory.

DoesItReallyMatter: Demote headings, replace deprecated tags, arrows

2019-02-15T07:10:43Z

Demote headings, replace deprecated tags, arrows

← Older revision		Revision as of 07:10, 15 February 2019
Line 1:		Line 1:
	'''VLC modules loading'''		'''VLC modules loading'''

	= How does VLC load modules? =		== How does VLC load modules? ==

	== Introduction about Modules ==		=== Introduction about Modules ===

	VLC has a core and a lot of modules (between 200 and 400 depending on the build).		VLC has a core and a lot of modules (between 200 and 400 depending on the build).
Line 14:		Line 14:
	*the score, VLC_MODULE_SCORE, that holds the priority of the module		*the score, VLC_MODULE_SCORE, that holds the priority of the module

	== How does the loading of modules happen ==		=== How does the loading of modules happen ===

	The first time you load VLC, it will scan the default '''plugins''' directories that should contain VLC modules and generate a cache (named the '''plugins cache''') so that the modules can be loaded quickly the next time VLC launches. Modules can be organized into directories (up to 5 layers deep) beneath the '''plugins''' directory.		The first time you load VLC, it will scan the default '''plugins''' directories that should contain VLC modules and generate a cache (named the '''plugins cache''') so that the modules can be loaded quickly the next time VLC launches. Modules can be organized into directories (up to 5 layers deep) beneath the '''plugins''' directory.
Line 29:		Line 29:
	It opens them in decreasing score order (biggest score first, smaller ones at the end), and runs the Open() function of the modules. When one module returns OK, VLC uses this module.		It opens them in decreasing score order (biggest 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 info about modules loading ==		=== Advanced info about modules loading ===

	=== Score of 0 ===		==== Score of 0 ====

	If a module has a score of 0, it needs to be explicitly requested by the user or vlc (like forcing --codec, --vout or <code>module_need("foo")</code>) to be loaded.<br>		If a module has a score of 0, it needs to be explicitly requested by the user or vlc (like forcing --codec, --vout or <code>module_need("foo")</code>) to be loaded.<br>

	=== all, none and other special tweaks ===		==== all, none and other special tweaks ====

	*The '''"all"''' mode means all modules will be tested in decreasing order of score.		*The '''"all"''' mode means all modules will be tested in decreasing order of score.
Line 43:		Line 43:
	*Any module can be requested by using its direct shortname. This is useful for 0-scored modules.		*Any module can be requested by using its direct shortname. This is useful for 0-scored modules.

	=== examples ===		==== examples ====

	Modules requests can be chained, as the '''examples''' show:		Modules requests can be chained, as the '''examples''' show:
Line 56:		Line 56:


	== How to list Modules ==		=== How to list Modules ===

	*Using Console		*Using Console
Line 64:		Line 64:
	*Using the Qt GUI		*Using the Qt GUI

	Menu ~~->~~ Tools ~~->~~ Plugins and extensions		Menu → Tools → Plugins and extensions

	= Major Capabilities of Modules =		== Major Capabilities of Modules ==

	; <tt>audio filter</tt>		; <code>audio filter</code>
	: An audio filter, like an equalizer		: An audio filter, like an equalizer
	; <tt>audio mixer</tt>		; <code>audio mixer</code>
	: An audio channel mixer, like a downmixer		: An audio channel mixer, like a downmixer
	; <tt>audio output</tt>		; <code>audio output</code>
	: An audio output, like Windows DirectX audio output		: An audio output, like Windows DirectX audio output
	; <tt>decoder</tt>		; <code>decoder</code>
	: A codec decoder, like theora		: A codec decoder, like theora
	; <tt>demux</tt>		; <code>demux</code>
	: A demuxer, to open a file format, like mkv		: A demuxer, to open a file format, like mkv
	; <tt>encoder</tt>		; <code>encoder</code>
	: A codec encoder, like x264		: A codec encoder, like x264
	; <tt>interface</tt>		; <code>interface</code>
	: An interface, like the Qt interface		: An interface, like the Qt interface
	; <tt>meta reader</tt>		; <code>meta reader</code>
	: A meta reader, to read metadata		: A meta reader, to read metadata
	; <tt>packetizer</tt>		; <code>packetizer</code>
	: A packetizer		: A packetizer
	; <tt>playlist export</tt>		; <code>playlist export</code>
	: A module to write playlist, like .m3u		: A module to write playlist, like .m3u
	; <tt>services_discovery</tt>		; <code>services_discovery</code>
	: A module to get extra content from your computer or the network, like Upnp, DLNA		: A module to get extra content from your computer or the network, like Upnp, DLNA
	; <tt>sout access</tt>		; <code>sout access</code>
	: An access for the streaming		: An access for the streaming
	; <tt>sout mux</tt>		; <code>sout mux</code>
	: A muxer when streaming and encoding		: A muxer when streaming and encoding
	; <tt>stream_filter</tt>		; <code>stream_filter</code>
	: A stream filter		: A stream filter
	; <tt>text renderer</tt>		; <code>text renderer</code>
	: A way to display subtitles and other text on top of the video		: A way to display subtitles and other text on top of the video
	; <tt>video filter</tt>		; <code>video filter</code>
	: A video filter, like contrast adjusting		: A video filter, like contrast adjusting
	; <tt>visualization2</tt>		; <code>visualization2</code>
	: A visualizer, to create videos from the music		: A visualizer, to create videos from the music
	; <tt>vout display</tt>		; <code>vout display</code>
	: A video output, to display videos like Direct3D or Xv		: A video output, to display videos like Direct3D or Xv


	{{Documentation}}		{{Documentation}}

Wilawar: /* How does the loading of modules happen */ Minor grammatical correction.

2017-07-06T17:12:33Z

How does the loading of modules happen: Minor grammatical correction.

← Older revision		Revision as of 17:12, 6 July 2017
Line 16:		Line 16:
	== How does the loading of modules happen ==		== How does the loading of modules happen ==

	The first time you load VLC, it will scan the default '''plugins''' directories that should contain VLC modules and ~~generates~~ a cache (named the '''plugins cache''') so that the modules can be loaded quickly the next time VLC launches. Modules can be organized into directories (up to 5 layers deep) beneath the '''plugins''' directory.		The first time you load VLC, it will scan the default '''plugins''' directories that should contain VLC modules and generate a cache (named the '''plugins cache''') so that the modules can be loaded quickly the next time VLC launches. Modules can be organized into directories (up to 5 layers deep) beneath the '''plugins''' directory.

	Recent versions of VLC require that the modules follow a specific naming convention or they will not be loaded. Modules must be named in the following format: '''lib''module_name''_plugin.''ext''''' where ''module_name'' should be the name of your module in lower case, and ''ext'' is the system's shared library extension. For example, the '''http''' access module is named '''libaccess_http_plugin.dll''' on a Windows machine.		Recent versions of VLC require that the modules follow a specific naming convention or they will not be loaded. Modules must be named in the following format: '''lib''module_name''_plugin.''ext''''' where ''module_name'' should be the name of your module in lower case, and ''ext'' is the system's shared library extension. For example, the '''http''' access module is named '''libaccess_http_plugin.dll''' on a Windows machine.

EPirat: /* Major Capabilities of Modules */

2017-01-23T19:12:20Z

Major Capabilities of Modules

← Older revision		Revision as of 19:12, 23 January 2017
Line 68:		Line 68:
	= Major Capabilities of Modules =		= Major Capabilities of Modules =

	*'''audio filter~~'''~~ : an audio filter, like an equalizer		; <tt>audio filter</tt>
	*'''audio mixer~~'''~~ : an audio channel mixer, like a downmixer		: An audio filter, like an equalizer
	*'''audio output~~'''~~ : an audio output, like Windows DirectX audio output		; <tt>audio mixer</tt>
	*'''decoder~~'''~~ : a codec decoder, like theora		: An audio channel mixer, like a downmixer
	*'''demux~~'''~~ : a demuxer, to open a file format, like mkv		; <tt>audio output</tt>
	*'''encoder~~'''~~ : a codec encoder, like x264		: An audio output, like Windows DirectX audio output
	*'''interface~~'''~~ : an interface, like the Qt interface		; <tt>decoder</tt>
	*'''meta reader~~'''~~ : a meta reader, to read metadata		: A codec decoder, like theora
	*'''packetizer~~'''~~ : a packetizer		; <tt>demux</tt>
	*'''playlist export~~'''~~ : a module to write playlist, like .m3u		: A demuxer, to open a file format, like mkv
	*'''services_discovery~~'''~~ : a module to get extra content from your computer or the network, like Upnp, DLNA		; <tt>encoder</tt>
	*'''sout access~~'''~~ : an access for the streaming		: A codec encoder, like x264
	*'''sout mux~~'''~~ : a muxer when streaming and encoding		; <tt>interface</tt>
	*'''stream_filter~~'''~~ : a stream filter		: An interface, like the Qt interface
	*'''text renderer~~'''~~ : a way to display subtitles and other text on top of the video		; <tt>meta reader</tt>
	*'''video filter~~'''~~ : a video filter, like contrast adjusting		: A meta reader, to read metadata
	*'''visualization2~~'''~~ : a visualizer, to create videos from the music		; <tt>packetizer</tt>
	*'''vout display~~'''~~ : a video output, to display videos like Direct3D or Xv		: A packetizer
			; <tt>playlist export</tt>
			: A module to write playlist, like .m3u
			; <tt>services_discovery</tt>
			: A module to get extra content from your computer or the network, like Upnp, DLNA
			; <tt>sout access</tt>
			: An access for the streaming
			; <tt>sout mux</tt>
			: A muxer when streaming and encoding
			; <tt>stream_filter</tt>
			: A stream filter
			; <tt>text renderer</tt>
			: A way to display subtitles and other text on top of the video
			; <tt>video filter</tt>
			: A video filter, like contrast adjusting
			; <tt>visualization2</tt>
			: A visualizer, to create videos from the music
			; <tt>vout display</tt>
			: A video output, to display videos like Direct3D or Xv


	{{Documentation}}		{{Documentation}}

EPirat: /* How to list Modules */

2017-01-23T19:05:31Z

How to list Modules

← Older revision		Revision as of 19:05, 23 January 2017
Line 62:		Line 62:
	vlc --list		vlc --list

	*Using GUI		*Using the Qt GUI

	Menu -> Tools -> Plugins and extensions		Menu -> Tools -> Plugins and extensions


	= Major Capabilities of Modules =		= Major Capabilities of Modules =

Wilawar: /* How does the loading of modules happen */ Some minor corrections of language

2016-12-31T23:57:27Z

How does the loading of modules happen: Some minor corrections of language

← Older revision		Revision as of 23:57, 31 December 2016
Line 16:		Line 16:
	== How does the loading of modules happen ==		== How does the loading of modules happen ==

	The first time you load VLC, it will scan ~~for~~ default '''plugins''' directories that should contain VLC modules and generates a cache (named the '''plugins cache''') so that the modules can be loaded quickly the next time VLC launches. Modules can be organized into directories (up to 5 layers deep) beneath the '''plugins''' directory.		The first time you load VLC, it will scan the default '''plugins''' directories that should contain VLC modules and generates a cache (named the '''plugins cache''') so that the modules can be loaded quickly the next time VLC launches. Modules can be organized into directories (up to 5 layers deep) beneath the '''plugins''' directory.

	Recent versions of VLC require that the modules follow a specific naming convention or they will not be loaded. Modules must be named in the following format: '''lib''module_name''_plugin.''ext''''' where ''module_name'' should be the name of your module in lower case, and ''ext'' is the system's shared library extension. For example, the '''http''' access module is named '''libaccess_http_plugin.dll''' on a Windows machine.		Recent versions of VLC require that the modules follow a specific naming convention or they will not be loaded. Modules must be named in the following format: '''lib''module_name''_plugin.''ext''''' where ''module_name'' should be the name of your module in lower case, and ''ext'' is the system's shared library extension. For example, the '''http''' access module is named '''libaccess_http_plugin.dll''' on a Windows machine.

	When VLC needs a module, it tries to open the ~~higher-~~score capability~~-matching module that accept~~ the request.		When VLC needs a module, it tries to open the module with the highest score that has the required capability and accepts the request.


Line 27:		Line 27:
	When VLC needs a "decoder" ("decoder" is one category/capability), it opens all "decoder" modules, until one matches.		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.		It opens them in decreasing score order (biggest 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 info about modules loading ==		== Advanced info about modules loading ==

MasterX244: /* How does the loading of modules happen */ Fixed a contradicting grammar construct

2015-01-14T22:05:46Z

How does the loading of modules happen: Fixed a contradicting grammar construct

← Older revision		Revision as of 22:05, 14 January 2015
Line 20:		Line 20:
	Recent versions of VLC require that the modules follow a specific naming convention or they will not be loaded. Modules must be named in the following format: '''lib''module_name''_plugin.''ext''''' where ''module_name'' should be the name of your module in lower case, and ''ext'' is the system's shared library extension. For example, the '''http''' access module is named '''libaccess_http_plugin.dll''' on a Windows machine.		Recent versions of VLC require that the modules follow a specific naming convention or they will not be loaded. Modules must be named in the following format: '''lib''module_name''_plugin.''ext''''' where ''module_name'' should be the name of your module in lower case, and ''ext'' is the system's shared library extension. For example, the '''http''' access module is named '''libaccess_http_plugin.dll''' on a Windows machine.

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