Hacker Guide/How To Write a Module - Revision history

Courmisch: /* Example stub module */

2020-04-21T17:15:59Z

Example stub module

@@ Line 41: / Line 41: @@
 #include <vlc_plugin.h>
 #include <vlc_interface.h>
 /* Internal state for an instance of the module */
@@ Line 105: / Line 91: @@
      free(sys->who);
      free(sys);
 }</syntaxhighlight>
 And now some explanations about the code...
@@ Line 209: / Line 206: @@
 The '''Close()''' function should deallocate private data.
 == In-tree module integration ==

DoesItReallyMatter: /* Loading your module */ -vvv no longer exists

2019-04-17T08:50:31Z

Loading your module: -vvv no longer exists

← Older revision		Revision as of 08:50, 17 April 2019
Line 253:		Line 253:
	Then use		Then use
	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
	./vlc -~~vvv~~ --color --list		./vlc -vv --color --list
	</syntaxhighlight>		</syntaxhighlight>
	to check that your plugin is seen by {{VLC}}.		to check that your plugin is seen by {{VLC}}.

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

2019-04-17T06:36:39Z

+{{Back to|Hacker Guide}}

← Older revision		Revision as of 06:36, 17 April 2019
Line 1:		Line 1:
			{{Back to\|Hacker Guide}}
	LibVLC is based on many independent modules, like most competing multimedia frameworks. Each module provides specific functionality.		LibVLC is based on many independent modules, like most competing multimedia frameworks. Each module provides specific functionality.

DoesItReallyMatter: /* Module types */ Fix broken link: Hacker Guide/Interface → Hacker Guide/Interfaces

2019-03-02T04:55:51Z

Module types: Fix broken link: Hacker Guide/Interface → Hacker Guide/Interfaces

← Older revision		Revision as of 04:55, 2 March 2019
Line 281:		Line 281:
	* [[{{#rel2abs:../Access_Demux}}\|Access_Demux]]		* [[{{#rel2abs:../Access_Demux}}\|Access_Demux]]
	* [[{{#rel2abs:../Decoder}}\|Decoder]]		* [[{{#rel2abs:../Decoder}}\|Decoder]]
	* [[{{#rel2abs:../~~Interface~~}}\|Interface]]		* [[{{#rel2abs:../Interfaces}}\|Interface]]
	* [[{{#rel2abs:../Video_Filters}}\|Video filter]]		* [[{{#rel2abs:../Video_Filters}}\|Video filter]]
	* [[{{#rel2abs:../Video_Output}}\|Video output]]		* [[{{#rel2abs:../Video_Output}}\|Video output]]

DoesItReallyMatter: rel2abs, +redlink

2019-02-15T21:14:29Z

rel2abs, +redlink

← Older revision		Revision as of 21:14, 15 February 2019
Line 1:		Line 1:
	LibVLC is based on many independent modules, like most competing multimedia frameworks. Each module provides specific functionality.		LibVLC is based on many independent modules, like most competing multimedia frameworks. Each module provides specific functionality.

	This article focuses on adding a new module (a.k.a. plug-in) to VLC (or any other LibVLC application). You '''will need to read''' [[~~Hacker Guide~~/Core#VLC_Pipeline_and_Modularity\|VLC Core and Modules ]] and [[Documentation:VLC_Modules_Loading\|How VLC loads modules]] first, otherwise you will not be able to flesh out the content of your new module.		This article focuses on adding a new module (a.k.a. plug-in) to VLC (or any other LibVLC application). You '''will need to read''' [[{{#rel2abs:../Core#VLC_Pipeline_and_Modularity}}\|VLC Core and Modules ]] and [[Documentation:VLC_Modules_Loading\|How VLC loads modules]] first, otherwise you will not be able to flesh out the content of your new module.

	== In-tree and out-of-tree modules ==		== In-tree and out-of-tree modules ==

	Most existing VLC modules are provided as source code in the directory [[~~Hacker Guide~~/Modules source tree\|modules]] within the main VLC source code repository (and also the source tarballs). They are compiled at the same time as the VLC core, and usually provided distributed together with VLC binary packages and installers. These modules are called in-tree modules.		Most existing VLC modules are provided as source code in the directory [[{{#rel2abs:../Modules source tree}}\|modules]] within the main VLC source code repository (and also the source tarballs). They are compiled at the same time as the VLC core, and usually provided distributed together with VLC binary packages and installers. These modules are called in-tree modules.

	However, it is also possible to write and compile VLC modules outside of VLC. That has some pros and cons over developing modules in-tree:		However, it is also possible to write and compile VLC modules outside of VLC. That has some pros and cons over developing modules in-tree:
Line 218:		Line 218:

	==== Modules.am ====		==== Modules.am ====
	First, find the right subdirectory under [[Modules_source_tree\| modules/]] to add your new code.		First, find the right subdirectory under [[{{#rel2abs:../Modules_source_tree}}\| modules/]] to add your new code.

	# If the module has only one source code file module, simply add it in the subdirectory (e.g. modules/control/hello.c).		# If the module has only one source code file module, simply add it in the subdirectory (e.g. modules/control/hello.c).
Line 277:		Line 277:

	We will detail those here:		We will detail those here:
	* [[~~Hacker_Guide~~/Access\|Access]]		* [[{{#rel2abs:../Access}}\|Access]]
	* [[~~Hacker_Guide~~/Demux\|Demux]]		* [[{{#rel2abs:../Demux}}\|Demux]]
	* [[~~Hacker_Guide~~/Access_Demux\|Access_Demux]]		* [[{{#rel2abs:../Access_Demux}}\|Access_Demux]]
	* [[~~Hacker_Guide~~/Decoder\|Decoder]]		* [[{{#rel2abs:../Decoder}}\|Decoder]]
	* Interface		* [[{{#rel2abs:../Interface}}\|Interface]]
	* [[~~Hacker_Guide~~/Video_Filters\|Video filter]]		* [[{{#rel2abs:../Video_Filters}}\|Video filter]]
	* [[~~Hacker_Guide~~/Video_Output\|Video output]]		* [[{{#rel2abs:../Video_Output}}\|Video output]]
	* [[~~Hacker_Guide~~/Audio_Filters\|Audio filter]]		* [[{{#rel2abs:../Audio_Filters}}\|Audio filter]]
	* [[~~Hacker_Guide~~/Audio_Output\|Audio output]]		* [[{{#rel2abs:../Audio_Output}}\|Audio output]]

	== Module load troubleshooting ==		== Module load troubleshooting ==

DoesItReallyMatter: /* Git */ For target Git: change missing page anchor from #Submitting_patches_to_the_vlc-devel_or_x264-devel to #Submitting_patches

2019-02-15T09:25:05Z

Git: For target Git: change missing page anchor from #Submitting_patches_to_the_vlc-devel_or_x264-devel to #Submitting_patches

← Older revision		Revision as of 09:25, 15 February 2019
Line 213:		Line 213:

	=== Git ===		=== Git ===
	If you plan to submit your work to VLC upstream, be sure to look at [[Git \|the git introduction]] and check the [[Git#~~Submitting_patches_to_the_vlc-devel_or_x264-devel~~\|send patches part]].		If you plan to submit your work to VLC upstream, be sure to look at [[Git \|the git introduction]] and check the [[Git#Submitting_patches\|send patches part]].

	=== Compiling your module ===		=== Compiling your module ===

DoesItReallyMatter: syntaxhighlight, drop name= in VLCSourceFile

2019-02-15T08:16:09Z

syntaxhighlight, drop name= in VLCSourceFile

Show changes

DoesItReallyMatter: Bypass old-name redirects, rewrite el as wl, target page anchors for Documentation:VLC Modules Loading fixing broken section links

2019-02-15T07:30:57Z

Bypass old-name redirects, rewrite el as wl, target page anchors for Documentation:VLC Modules Loading fixing broken section links

Wilawar: /* In-tree and out-of-tree modules */ Made the modules directory explicit up there

2017-07-06T17:28:07Z

In-tree and out-of-tree modules: Made the modules directory explicit up there

← Older revision		Revision as of 17:28, 6 July 2017
Line 5:		Line 5:
	== In-tree and out-of-tree modules ==		== In-tree and out-of-tree modules ==

	Most existing VLC modules are provided as source code within the main VLC source code repository (and also the source tarballs). They are compiled at the same time as the VLC core, and usually provided distributed together with VLC binary packages and installers. These modules are called in-tree modules.		Most existing VLC modules are provided as source code in the directory [https://wiki.videolan.org/Documentation:Modules_source_tree/ modules] within the main VLC source code repository (and also the source tarballs). They are compiled at the same time as the VLC core, and usually provided distributed together with VLC binary packages and installers. These modules are called in-tree modules.

	However, it is also possible to write and compile VLC modules outside of VLC. That has some pros and cons over developing modules in-tree:		However, it is also possible to write and compile VLC modules outside of VLC. That has some pros and cons over developing modules in-tree:

J-b: Fix code error

2017-02-28T15:14:26Z

Fix code error

← Older revision		Revision as of 15:14, 28 February 2017
Line 99:		Line 99:
	intf_sys_t *sys = intf->p_sys;		intf_sys_t *sys = intf->p_sys;

	msg_Info(intf, "Good bye %s!");		msg_Info(intf, "Good bye %s!", sys->who);

	/* Free internal state */		/* Free internal state */

← Older revision		Revision as of 04:55, 2 March 2019
Line 281:		Line 281:
	* [[{{#rel2abs:../Access_Demux}}\|Access_Demux]]		* [[{{#rel2abs:../Access_Demux}}\|Access_Demux]]
	* [[{{#rel2abs:../Decoder}}\|Decoder]]		* [[{{#rel2abs:../Decoder}}\|Decoder]]
	* [[{{#rel2abs:../~~Interface~~}}\|Interface]]		* [[{{#rel2abs:../Interfaces}}\|Interface]]
	* [[{{#rel2abs:../Video_Filters}}\|Video filter]]		* [[{{#rel2abs:../Video_Filters}}\|Video filter]]
	* [[{{#rel2abs:../Video_Output}}\|Video output]]		* [[{{#rel2abs:../Video_Output}}\|Video output]]

← Older revision		Revision as of 07:30, 15 February 2019
Line 1:		Line 1:
	LibVLC is based on many independent modules, like most competing multimedia frameworks. Each module provides specific functionality.		LibVLC is based on many independent modules, like most competing multimedia frameworks. Each module provides specific functionality.

	This article focuses on adding a new module (a.k.a. plug-in) to VLC (or any other LibVLC application). You '''will need to read''' [[~~Documentation:~~Hacker~~%27s_Guide~~/Core#VLC_Pipeline_and_Modularity\|VLC Core and Modules ]] and [[Documentation:VLC_Modules_Loading\|How VLC loads modules]] first, otherwise you will not be able to flesh out the content of your new module.		This article focuses on adding a new module (a.k.a. plug-in) to VLC (or any other LibVLC application). You '''will need to read''' [[Hacker Guide/Core#VLC_Pipeline_and_Modularity\|VLC Core and Modules ]] and [[Documentation:VLC_Modules_Loading\|How VLC loads modules]] first, otherwise you will not be able to flesh out the content of your new module.

	== In-tree and out-of-tree modules ==		== In-tree and out-of-tree modules ==

	Most existing VLC modules are provided as source code in the directory [~~https://wiki.videolan.org/Documentation:Modules_source_tree~~/ modules] within the main VLC source code repository (and also the source tarballs). They are compiled at the same time as the VLC core, and usually provided distributed together with VLC binary packages and installers. These modules are called in-tree modules.		Most existing VLC modules are provided as source code in the directory [[Hacker Guide/Modules source tree\|modules]] within the main VLC source code repository (and also the source tarballs). They are compiled at the same time as the VLC core, and usually provided distributed together with VLC binary packages and installers. These modules are called in-tree modules.

	However, it is also possible to write and compile VLC modules outside of VLC. That has some pros and cons over developing modules in-tree:		However, it is also possible to write and compile VLC modules outside of VLC. That has some pros and cons over developing modules in-tree:
Line 130:		Line 130:
	This defines a module of "interface" capability and a score of 0.		This defines a module of "interface" capability and a score of 0.

	The capability determines the type of module we are dealing with. It could be an access, a demux, a decoder, an interface, etc. Now is the time to '''re-read [[Documentation:VLC Modules Loading#~~How_does_the_loading_of_modules_happens~~\|how VLC loads modules]]'''.		The capability determines the type of module we are dealing with. It could be an access, a demux, a decoder, an interface, etc. Now is the time to '''re-read [[Documentation:VLC Modules Loading#How\|how VLC loads modules]]'''.

	*If VLC needs to load a specific name, it will load it by its name and VLC directly opens this module		*If VLC needs to load a specific name, it will load it by its name and VLC directly opens this module
	*If VLC needs a type of module ("I need a decoder"), VLC will load all modules matching this capability in a decreasing score order until one modules's Open() function (see later) returns VLC_SUCCESS.		*If VLC needs a type of module ("I need a decoder"), VLC will load all modules matching this capability in a decreasing score order until one modules's Open() function (see later) returns VLC_SUCCESS.

	See the major types of [[Documentation:VLC Modules Loading#~~Major_Capabilities_of_Modules~~\|capabilities of VLC]].		See the major types of [[Documentation:VLC Modules Loading#Capabilities\|capabilities of VLC]].

	'''Score''' should be an integer, and related to other scores in the same category. Score 0 is a [[Documentation:~~VLC_Modules_Loading~~#Score_of_0\|special case]].		'''Score''' should be an integer, and related to other scores in the same category. Score 0 is a [[Documentation:VLC Modules Loading#Score_of_0\|special case]].

	==== Configuration categories and sub-categories ====		==== Configuration categories and sub-categories ====