Hacker Guide - Revision history

DoesItReallyMatter: /* Coding for VLC */ Add API doxygen link so doxygen can be browsed without JavaScript

2019-04-17T08:47:29Z

Coding for VLC: Add API doxygen link so doxygen can be browsed without JavaScript

← Older revision		Revision as of 08:47, 17 April 2019
Line 89:		Line 89:
	*[[{{#rel2abs:/How To Write a Module}}\|Adding a module]]		*[[{{#rel2abs:/How To Write a Module}}\|Adding a module]]
	*[[Documentation:Unicode]]		*[[Documentation:Unicode]]
	*[https://www.videolan.org/developers/vlc/doc/doxygen/html/index.html Doxygen Documentation] <span class="plainlinks">([https://www.videolan.org/developers/vlc/doc/doxygen/html/pages.html pages] • [https://www.videolan.org/developers/vlc/doc/doxygen/html/modules.html modules] • [https://www.videolan.org/developers/vlc/doc/doxygen/html/annotated.html data structures] • [https://www.videolan.org/developers/vlc/doc/doxygen/html/files.html files])</span>		*[https://www.videolan.org/developers/vlc/doc/doxygen/html/index.html Doxygen Documentation] <span class="plainlinks">([https://www.videolan.org/developers/vlc/doc/doxygen/html/pages.html pages] • [https://www.videolan.org/developers/vlc/doc/doxygen/html/modules.html modules] • [https://www.videolan.org/developers/vlc/doc/doxygen/html/annotated.html data structures] • [https://www.videolan.org/developers/vlc/doc/doxygen/html/files.html files] • [https://www.videolan.org/developers/vlc/doc/doxygen/html/group__vlc.html API])</span>
	*[[C Types]]		*[[C Types]]
	*[[Strings]]		*[[Strings]]

DoesItReallyMatter: Links

2019-04-17T08:45:13Z

Links

← Older revision		Revision as of 08:45, 17 April 2019
Line 4:		Line 4:
	It uses a large number of [[Contrib Status\|3rd party libraries]].		It uses a large number of [[Contrib Status\|3rd party libraries]].

	VLC development is open source, and then a large community of developers worldwide contribute to it.<br />		VLC development is [[open source]], and then a large community of developers worldwide contribute to it.<br />
	However, entering a project such as {{VLC}} can be long and complex for new developers.		However, entering a project such as VLC can be long and complex for new developers.

	This '''guide''' seeks to help understanding the VLC code base and VLC internals to quickly get up to speed.<br />		This '''guide''' seeks to help understanding the VLC code base and VLC internals to quickly get up to speed.<br />
	''NB: this guide is '''not''' about [[~~Compile\|~~compiling]] VLC.''		''NB: this guide is '''not''' about [[compiling]] VLC.''


Line 17:		Line 17:
	=== VLC's Core / libVLCcore ===		=== VLC's Core / libVLCcore ===

	The most important (and probably most complex) part of VLC is the core, located in src/ in the repository.		The most important (and probably most complex) part of VLC is the core, located under {{VLCSourceFolder\|src}} in the repository.

	*[[{{#rel2abs:/Core}}\|Introduction to the core]]		*[[{{#rel2abs:/Core}}\|Introduction to the core]]
Line 37:		Line 37:
	** An access module provides a byte stream from a location string [[MRL]], like support for files, HTTP streams, webcams...		** An access module provides a byte stream from a location string [[MRL]], like support for files, HTTP streams, webcams...
	*[[{{#rel2abs:/Demux}}\|Demuxer]]		*[[{{#rel2abs:/Demux}}\|Demuxer]]
	** A demux module parses a byte stream and splits it into [~~http://en.wikipedia.org/wiki/Elementary_stream~~ elementary ~~streams~~] (tracks).		** A demux module parses a byte stream and splits it into [[elementary stream]]s (tracks).
	*[[{{#rel2abs:/Access Demux}}\|Access-Demuxer]]		*[[{{#rel2abs:/Access Demux}}\|Access-Demuxer]]
	** An access_demux module combines the functionality of access and demux (and bypass any stream filters), splitting elementary streams directly from a location string. It's used where the bytestream abstraction is inadequate.		** An access_demux module combines the functionality of access and demux (and bypass any stream filters), splitting elementary streams directly from a location string. It's used where the bytestream abstraction is inadequate.
Line 84:		Line 84:
	== Coding for VLC ==		== Coding for VLC ==

	*[[Patch]]ing		*[[Patch]]ing ([[Sending Patches\|sending]])
	*[[Sending Patches]]
	*[[Code Conventions]]		*[[Code Conventions]]
	*[[Code Signing]]		*[[Code Signing]]
	*[[{{#rel2abs:/How To Write a Module}}\|Adding a module]]		*[[{{#rel2abs:/How To Write a Module}}\|Adding a module]]
	*[[Documentation:Unicode]]		*[[Documentation:Unicode]]
	*[~~http~~://www.videolan.org/developers/vlc/doc/doxygen/html/ Doxygen Documentation]		*[https://www.videolan.org/developers/vlc/doc/doxygen/html/index.html Doxygen Documentation] <span class="plainlinks">([https://www.videolan.org/developers/vlc/doc/doxygen/html/pages.html pages] • [https://www.videolan.org/developers/vlc/doc/doxygen/html/modules.html modules] • [https://www.videolan.org/developers/vlc/doc/doxygen/html/annotated.html data structures] • [https://www.videolan.org/developers/vlc/doc/doxygen/html/files.html files])</span>
	*[[C Types]]		*[[C Types]]
	*[[Strings]]		*[[Strings]]

DoesItReallyMatter: /* Coding for VLC */ Add Code Signing

2019-03-29T05:38:24Z

Coding for VLC: Add Code Signing

← Older revision		Revision as of 05:38, 29 March 2019
Line 86:		Line 86:
	*[[Patch]]ing		*[[Patch]]ing
	*[[Sending Patches]]		*[[Sending Patches]]
	*[[Code Conventions]]		*[[Code Conventions]]
			*[[Code Signing]]
	*[[{{#rel2abs:/How To Write a Module}}\|Adding a module]]		*[[{{#rel2abs:/How To Write a Module}}\|Adding a module]]
	*[[Documentation:Unicode]]		*[[Documentation:Unicode]]

DoesItReallyMatter: Demote headings

2019-03-29T05:35:09Z

Demote headings

← Older revision		Revision as of 05:35, 29 March 2019
Line 1:		Line 1:
	= Introduction =		== Introduction ==

	{{VLC}} is a very popular, but quite large and complex piece of software.<br />		{{VLC}} is a very popular, but quite large and complex piece of software.<br />
Line 13:		Line 13:
	A very good introduction to VLC can also be found on (an archived copy of the site) [//web.archive.org/web/20141204234622/http://www.enjoythearchitecture.com/vlc-architecture.html enjoythearchitecture].		A very good introduction to VLC can also be found on (an archived copy of the site) [//web.archive.org/web/20141204234622/http://www.enjoythearchitecture.com/vlc-architecture.html enjoythearchitecture].

	= The layers of VLC and libVLC =		== The layers of VLC and libVLC ==

	== VLC's Core / libVLCcore ==		=== VLC's Core / libVLCcore ===

	The most important (and probably most complex) part of VLC is the core, located in src/ in the repository.		The most important (and probably most complex) part of VLC is the core, located in src/ in the repository.
Line 29:		Line 29:
	*[[{{#rel2abs:/VLM Internals}}\|VLM Internals]]		*[[{{#rel2abs:/VLM Internals}}\|VLM Internals]]

	== Plugins / Modules ==		=== Plugins / Modules ===

	[[{{#rel2abs:/How To Write a Module}}\|How to write a VLC module]].		[[{{#rel2abs:/How To Write a Module}}\|How to write a VLC module]].

	=== Input ===		==== Input ====
	*[[{{#rel2abs:/Access}}\|Access]]		*[[{{#rel2abs:/Access}}\|Access]]
	** An access module provides a byte stream from a location string [[MRL]], like support for files, HTTP streams, webcams...		** An access module provides a byte stream from a location string [[MRL]], like support for files, HTTP streams, webcams...
Line 45:		Line 45:
	** A decoder takes an elementary stream and convert into raw video, audio or text data, reading for output.		** A decoder takes an elementary stream and convert into raw video, audio or text data, reading for output.

	=== Audio ===		==== Audio ====

	*[[{{#rel2abs:/Audio Filters}}\|Audio Filters]]		*[[{{#rel2abs:/Audio Filters}}\|Audio Filters]]
	*[[{{#rel2abs:/Audio Output}}\|Audio Output]]		*[[{{#rel2abs:/Audio Output}}\|Audio Output]]

	=== Video ===		==== Video ====

	*[[{{#rel2abs:/Video Filters}}\|Video Filters]]		*[[{{#rel2abs:/Video Filters}}\|Video Filters]]
Line 56:		Line 56:
	*[[{{#rel2abs:/Video Output}}\|Video Output]]		*[[{{#rel2abs:/Video Output}}\|Video Output]]

	=== Interfaces ===		==== Interfaces ====
	*[[{{#rel2abs:/Interfaces}}\|Interfaces]]		*[[{{#rel2abs:/Interfaces}}\|Interfaces]]

	=== Modules types not documented (yet) ===		==== Modules types not documented (yet) ====
	==== Misc ====		===== Misc =====
	*[[{{#rel2abs:/Visualization}}\|Visualization]]		*[[{{#rel2abs:/Visualization}}\|Visualization]]
	*[[{{#rel2abs:/Packetizers}}\|Packetizers]]		*[[{{#rel2abs:/Packetizers}}\|Packetizers]]

	==== Streaming output ====		===== Streaming output =====
	*[[{{#rel2abs:/Encoder}}\|Encoder]]		*[[{{#rel2abs:/Encoder}}\|Encoder]]
	*[[{{#rel2abs:/Mux}}\|Mux]]		*[[{{#rel2abs:/Mux}}\|Mux]]
Line 70:		Line 70:
	*[[{{#rel2abs:/Access Output}}\|Access Output]]		*[[{{#rel2abs:/Access Output}}\|Access Output]]

	== libVLC and bindings ==		=== libVLC and bindings ===

	*Using [[{{#rel2abs:/libvlc}}\|libvlc]]		*Using [[{{#rel2abs:/libvlc}}\|libvlc]]
	*bindings		*bindings

	= VLC source code overview =		== VLC source code overview ==

	*[[{{#rel2abs:/VLC source tree}}]]		*[[{{#rel2abs:/VLC source tree}}]]
Line 82:		Line 82:
	*[[{{#rel2abs:/Playlist}}\|VLC Playlist and Media Library]]		*[[{{#rel2abs:/Playlist}}\|VLC Playlist and Media Library]]

	= Coding for VLC =		== Coding for VLC ==

	*[[Patch]]ing		*[[Patch]]ing
Line 93:		Line 93:
	*[[Strings]]		*[[Strings]]

	= User Experience =		== User Experience ==

	*[[Playback States]]		*[[Playback States]]

	= Testing =		== Testing ==

	*[[Test Suite]]		*[[Test Suite]]

	= Mozilla plugins =		== Mozilla plugins ==

	* [[Plugins/Mozilla\|Plugins in Mozilla]]		* [[Plugins/Mozilla\|Plugins in Mozilla]]

	{{Hacker_Guide}}		{{Hacker_Guide}}

DoesItReallyMatter: Using a parser function called rel2abs to rewrite links as /subpage

2019-02-15T20:43:28Z

Using a parser function called rel2abs to rewrite links as /subpage

← Older revision		Revision as of 20:43, 15 February 2019
Line 19:		Line 19:
	The most important (and probably most complex) part of VLC is the core, located in src/ in the repository.		The most important (and probably most complex) part of VLC is the core, located in src/ in the repository.

	*[[~~Documentation~~:~~Hacker's Guide~~/Core\|Introduction to the core]]		*[[{{#rel2abs:/Core}}\|Introduction to the core]]
	** This is a '''MUST-READ''' for developers.		** This is a '''MUST-READ''' for developers.
	*[[Documentation:VLC Modules Loading\|VLC modules loading]]		*[[Documentation:VLC Modules Loading\|VLC modules loading]]
	** How the numerous VLC modules work and are loaded.		** How the numerous VLC modules work and are loaded.
	*[[~~Documentation~~:~~Hacker's Guide~~/Input\|Input]]		*[[{{#rel2abs:/Input}}\|Input]]
	** How the main input chain works (slightly outdated)		** How the main input chain works (slightly outdated)
	*[[~~Documentation~~:~~Hacker's Guide~~/Object Management\|VLC Object Management]]		*[[{{#rel2abs:/Object Management}}\|VLC Object Management]]
	*[[~~Hacker Guide~~/Variables\|VLC variables]]		*[[{{#rel2abs:/Variables}}\|VLC variables]]
	*[[~~Documentation~~:~~Hacker's Guide~~/VLM Internals\|VLM Internals]]		*[[{{#rel2abs:/VLM Internals}}\|VLM Internals]]

	== Plugins / Modules ==		== Plugins / Modules ==

	[[~~Documentation~~:~~Hacker's Guide~~/Module ~~Writers Guide~~\|How to write a VLC module]].		[[{{#rel2abs:/How To Write a Module}}\|How to write a VLC module]].

	=== Input ===		=== Input ===
	*[[~~Documentation~~:~~Hacker's Guide~~/Access\|Access]]		*[[{{#rel2abs:/Access}}\|Access]]
	** An access module provides a byte stream from a location string [[MRL]], like support for files, HTTP streams, webcams...		** An access module provides a byte stream from a location string [[MRL]], like support for files, HTTP streams, webcams...
	*[[~~Documentation~~:~~Hacker's Guide~~/Demux\|Demuxer]]		*[[{{#rel2abs:/Demux}}\|Demuxer]]
	** A demux module parses a byte stream and splits it into [http://en.wikipedia.org/wiki/Elementary_stream elementary streams] (tracks).		** A demux module parses a byte stream and splits it into [http://en.wikipedia.org/wiki/Elementary_stream elementary streams] (tracks).
	*[[~~Documentation~~:~~Hacker's Guide~~/Access Demux\|Access-Demuxer]]		*[[{{#rel2abs:/Access Demux}}\|Access-Demuxer]]
	** An access_demux module combines the functionality of access and demux (and bypass any stream filters), splitting elementary streams directly from a location string. It's used where the bytestream abstraction is inadequate.		** An access_demux module combines the functionality of access and demux (and bypass any stream filters), splitting elementary streams directly from a location string. It's used where the bytestream abstraction is inadequate.
	*[[~~Documentation~~:~~Hacker's Guide~~/Stream Filters\|Stream Filters]]		*[[{{#rel2abs:/Stream Filters}}\|Stream Filters]]
	** A stream filter module converts a byte stream into another byte stream. It could be used for file or byte stream decryption, as it is already used for decompression (gzip, Bzip2, XZ) and multi-part files.		** A stream filter module converts a byte stream into another byte stream. It could be used for file or byte stream decryption, as it is already used for decompression (gzip, Bzip2, XZ) and multi-part files.
	*[[~~Documentation~~:~~Hacker's Guide~~/Decoder\|Decoder]]		*[[{{#rel2abs:/Decoder}}\|Decoder]]
	** A decoder takes an elementary stream and convert into raw video, audio or text data, reading for output.		** A decoder takes an elementary stream and convert into raw video, audio or text data, reading for output.

	=== Audio ===		=== Audio ===

	*[[~~Documentation~~:~~Hacker's Guide~~/Audio Filters\|Audio Filters]]		*[[{{#rel2abs:/Audio Filters}}\|Audio Filters]]
	**[[Documentation:Hacker's Guide/Audio Mixers\|Audio Mixers]]		*[[{{#rel2abs:/Audio Output}}\|Audio Output]]
	*[[~~Documentation~~:~~Hacker's Guide~~/Audio Output\|Audio Output]]

	=== Video ===		=== Video ===

	*[[~~Documentation~~:~~Hacker's Guide~~/Video Filters\|Video Filters]]		*[[{{#rel2abs:/Video Filters}}\|Video Filters]]
	**[[~~Documentation~~:~~Hacker's Guide~~/Video Filters/Deinterlace\|Deinterlace]]		**[[{{#rel2abs:/Video Filters/Deinterlace}}\|Deinterlace]]
	*[[~~Documentation~~:~~Hacker's Guide~~/Video Output\|Video Output]]		*[[{{#rel2abs:/Video Output}}\|Video Output]]

	=== Interfaces ===		=== Interfaces ===
	*[[~~Documentation~~:~~Hacker's Guide~~/Interfaces\|Interfaces]]		*[[{{#rel2abs:/Interfaces}}\|Interfaces]]

	=== Modules types not documented (yet) ===		=== Modules types not documented (yet) ===
	==== Misc ====		==== Misc ====
	*[[~~Documentation~~:~~Hacker's Guide~~/Visualization\|Visualization]]		*[[{{#rel2abs:/Visualization}}\|Visualization]]
	*[[~~Documentation~~:~~Hacker's Guide~~/Packetizers\|Packetizers]]		*[[{{#rel2abs:/Packetizers}}\|Packetizers]]

	==== Streaming output ====		==== Streaming output ====
	*[[~~Documentation~~:~~Hacker's Guide~~/Encoder\|Encoder]]		*[[{{#rel2abs:/Encoder}}\|Encoder]]
	*[[~~Documentation~~:~~Hacker's Guide~~/Mux\|Mux]]		*[[{{#rel2abs:/Mux}}\|Mux]]
	*[[~~Documentation~~:~~Hacker's Guide~~/Stream Output\|Stream Output]]		*[[{{#rel2abs:/Stream Output}}\|Stream Output]]
	*[[~~Documentation~~:~~Hacker's Guide~~/Access Output\|Access Output]]		*[[{{#rel2abs:/Access Output}}\|Access Output]]

	== libVLC and bindings ==		== libVLC and bindings ==

	*Using [[~~Documentation~~:~~Hacker's Guide~~/libvlc\|libvlc]]		*Using [[{{#rel2abs:/libvlc}}\|libvlc]]
	*bindings		*bindings

	= VLC source code overview =		= VLC source code overview =

	*[[VLC source tree]]		*[[{{#rel2abs:/VLC source tree}}]]
	*[[Modules source tree]]		*[[{{#rel2abs:/Modules source tree}}]]
	*[[~~Documentation~~:~~Hacker's Guide~~/Preferences\|VLC Preferences]]		*[[{{#rel2abs:/Preferences}}\|VLC Preferences]]
	*[[~~Documentation~~:~~Hacker's Guide~~/Playlist\|VLC Playlist and Media Library]]		*[[{{#rel2abs:/Playlist}}\|VLC Playlist and Media Library]]

	= Coding for VLC =		= Coding for VLC =

	*[[~~Patches\|Patching~~]]		*[[Patch]]ing
	*[[Sending Patches]]		*[[Sending Patches]]
	*[[Code Conventions]]		*[[Code Conventions]]
	*[[~~Documentation~~:~~Hacker's Guide~~/Module ~~Writers Guide~~\|Adding a module]]		*[[{{#rel2abs:/How To Write a Module}}\|Adding a module]]
	*[[Documentation:Unicode]]		*[[Documentation:Unicode]]
	*[http://www.videolan.org/developers/vlc/doc/doxygen/html/ Doxygen Documentation]		*[http://www.videolan.org/developers/vlc/doc/doxygen/html/ Doxygen Documentation]

Caro at 14:24, 28 January 2019

2019-01-28T14:24:27Z

← Older revision		Revision as of 14:24, 28 January 2019
Line 94:		Line 94:
	*[[Strings]]		*[[Strings]]

			= User Experience =

			*[[Playback States]]

	= Testing =		= Testing =

DoesItReallyMatter: Undo last revision by Manas.marthi (talk). Feel free to revert me; I've configured the link to point to an archived copy.

2016-10-27T11:58:29Z

Undo last revision by Manas.marthi (talk). Feel free to revert me; I've configured the link to point to an archived copy.

← Older revision		Revision as of 11:58, 27 October 2016
Line 9:		Line 9:
	This '''guide''' seeks to help understanding the VLC code base and VLC internals to quickly get up to speed.<br />		This '''guide''' seeks to help understanding the VLC code base and VLC internals to quickly get up to speed.<br />
	''NB: this guide is '''not''' about [[Compile\|compiling]] VLC.''		''NB: this guide is '''not''' about [[Compile\|compiling]] VLC.''


			A very good introduction to VLC can also be found on (an archived copy of the site) [//web.archive.org/web/20141204234622/http://www.enjoythearchitecture.com/vlc-architecture.html enjoythearchitecture].

	= The layers of VLC and libVLC =		= The layers of VLC and libVLC =

Manas.marthi: removed deadlink

2016-09-25T06:57:48Z

removed deadlink

← Older revision		Revision as of 06:57, 25 September 2016
Line 9:		Line 9:
	This '''guide''' seeks to help understanding the VLC code base and VLC internals to quickly get up to speed.<br />		This '''guide''' seeks to help understanding the VLC code base and VLC internals to quickly get up to speed.<br />
	''NB: this guide is '''not''' about [[Compile\|compiling]] VLC.''		''NB: this guide is '''not''' about [[Compile\|compiling]] VLC.''


	~~A very good introduction to VLC can also be found on [http://www.enjoythearchitecture.com/vlc-architecture.html enjoythearchitecture].~~

	= The layers of VLC and libVLC =		= The layers of VLC and libVLC =

Qazwiz: /* VLC's Core / libVLCcore */ bypassed a redirected page

2014-04-03T21:52:09Z

VLC's Core / libVLCcore: bypassed a redirected page

← Older revision		Revision as of 21:52, 3 April 2014
Line 26:		Line 26:
	** How the main input chain works (slightly outdated)		** How the main input chain works (slightly outdated)
	*[[Documentation:Hacker's Guide/Object Management\|VLC Object Management]]		*[[Documentation:Hacker's Guide/Object Management\|VLC Object Management]]
	*[[~~Documentation:~~Hacker's Guide/Variables\|VLC variables]]		*[[Hacker Guide/Variables\|VLC variables]]
	*[[Documentation:Hacker's Guide/VLM Internals\|VLM Internals]]		*[[Documentation:Hacker's Guide/VLM Internals\|VLM Internals]]

Corbax: /* Mozilla plugins */

2013-11-14T17:22:36Z

Mozilla plugins

← Older revision		Revision as of 17:22, 14 November 2013
Line 103:		Line 103:
	* [[Plugins/Mozilla\|Plugins in Mozilla]]		* [[Plugins/Mozilla\|Plugins in Mozilla]]

	~~[[Category:Coding]]~~
	{{Hacker_Guide}}		{{Hacker_Guide}}
	~~{{Documentation footer}}~~