Difference between revisions of "Hacker Guide"

From VideoLAN Wiki
Jump to navigation Jump to search
m (→‎Coding for VLC: Add API doxygen link so doxygen can be browsed without JavaScript)
 
(78 intermediate revisions by 9 users not shown)
Line 1: Line 1:
 
== Introduction ==
 
== Introduction ==
  
−
*[[Documentation:Hacker's Guide/Introduction|What is this?]]  
+
{{VLC}} is a very popular, but quite large and complex piece of software.<br />
−
* What you need to know about VLC
+
It uses a large number of [[Contrib Status|3rd party libraries]].
  
−
== The many layers of VLC ==
+
VLC development is [[open source]], and then a large community of developers worldwide contribute to it.<br />
−
=== Core ===  
+
However, entering a project such as VLC can be long and complex for new developers.
−
*[[Documentation:Hacker's Guide/Core|Core]]  
+
 
−
*[[Documentation:Hacker's Guide/VLM Internals|VLM Internals]]
+
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 [[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 ==
 +
 
 +
=== VLC's Core / libVLCcore ===
 +
 
 +
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]]
 +
** This is a '''MUST-READ''' for developers.
 +
*[[Documentation:VLC Modules Loading|VLC modules loading]]
 +
** How the numerous VLC modules work and are loaded.
 +
*[[{{#rel2abs:/Input}}|Input]]
 +
** How the main input chain works (slightly outdated)
 +
*[[{{#rel2abs:/Object Management}}|VLC Object Management]]
 +
*[[{{#rel2abs:/Variables}}|VLC variables]]
 +
*[[{{#rel2abs:/VLM Internals}}|VLM Internals]]
  
 
=== Plugins / Modules ===
 
=== Plugins / Modules ===
  
−
*[[Documentation:Hacker's Guide/Interfaces|Interfaces]]  
+
[[{{#rel2abs:/How To Write a Module}}|How to write a VLC module]].
−
*[[Documentation:Hacker's Guide/Access|Access]]  
+
 
−
*[[Documentation:Hacker's Guide/Access Filters|Access Filters]]  
+
==== Input ====
−
*[[Documentation:Hacker's Guide/Input|Input]]  
+
*[[{{#rel2abs:/Access}}|Access]]  
−
*[[Documentation:Hacker's Guide/Demux|Demux]]  
+
** An access module provides a byte stream from a location string [[MRL]], like support for files, HTTP streams, webcams...
−
*[[Documentation:Hacker's Guide/Decoder|Decoder]]  
+
*[[{{#rel2abs:/Demux}}|Demuxer]]
−
*[[Documentation:Hacker's Guide/Audio Filters|Audio Filters]]  
+
** A demux module parses a byte stream and splits it into [[elementary stream]]s (tracks).
−
*[[Documentation:Hacker's Guide/Video Filters|Video Filters]]  
+
*[[{{#rel2abs:/Access Demux}}|Access-Demuxer]]
−
*[[Documentation:Hacker's Guide/Audio Mixers|Audio Mixers]]  
+
** 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/Audio Output|Audio Output]]  
+
*[[{{#rel2abs:/Stream Filters}}|Stream Filters]]
−
*[[Documentation:Hacker's Guide/Video Output|Video Output]]  
+
** 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/Visualization|Visualization]]  
+
*[[{{#rel2abs:/Decoder}}|Decoder]]
−
*[[Documentation:Hacker's Guide/Encoder|Encoder]]  
+
** A decoder takes an elementary stream and convert into raw video, audio or text data, reading for output.
−
*[[Documentation:Hacker's Guide/Mux|Mux]]  
+
 
−
*[[Documentation:Hacker's Guide/Packetizers|Packetizers]]  
+
==== Audio ====
−
*[[Documentation:Hacker's Guide/Stream Output|Stream Output]]  
+
 
−
*[[Documentation:Hacker's Guide/Access Output|Access Output]]
+
*[[{{#rel2abs:/Audio Filters}}|Audio Filters]]  
 +
*[[{{#rel2abs:/Audio Output}}|Audio Output]]
 +
 
 +
==== Video ====
 +
 
 +
*[[{{#rel2abs:/Video Filters}}|Video Filters]]  
 +
**[[{{#rel2abs:/Video Filters/Deinterlace}}|Deinterlace]]
 +
*[[{{#rel2abs:/Video Output}}|Video Output]]
 +
 
 +
==== Interfaces ====
 +
*[[{{#rel2abs:/Interfaces}}|Interfaces]]
 +
 
 +
==== Modules types not documented (yet) ====
 +
===== Misc =====
 +
*[[{{#rel2abs:/Visualization}}|Visualization]]  
 +
*[[{{#rel2abs:/Packetizers}}|Packetizers]]
 +
 
 +
===== Streaming output =====
 +
*[[{{#rel2abs:/Encoder}}|Encoder]]  
 +
*[[{{#rel2abs:/Mux}}|Mux]]  
 +
*[[{{#rel2abs:/Stream Output}}|Stream Output]]  
 +
*[[{{#rel2abs:/Access Output}}|Access Output]]
  
 
=== libVLC and bindings ===
 
=== libVLC and bindings ===
−
* Using [[Documentation:Hacker's Guide/libvlc|libvlc]]
+
 
−
* bindings
+
*Using [[{{#rel2abs:/libvlc}}|libvlc]]  
 +
*bindings
  
 
== VLC source code overview ==
 
== VLC source code overview ==
  
−
*[[VLC source tree]]  
+
*[[{{#rel2abs:/VLC source tree}}]]  
−
*[[Documentation:Hacker's Guide/Module Writers Guide|VLC modules]] (also see [[Modules source tree]] )
+
*[[{{#rel2abs:/Modules source tree}}]]  
−
*[[Documentation:Hacker's Guide/Object Management|VLC Object Management]]
+
*[[{{#rel2abs:/Preferences}}|VLC Preferences]]  
−
*[[Documentation:Hacker's Guide/Preferences|VLC Preferences]]  
+
*[[{{#rel2abs:/Playlist}}|VLC Playlist and Media Library]]
−
*[[Documentation:Hacker's Guide/Playlist|VLC Playlist and Media Library]]
 
−
*VLC variables
 
−
*[[Doxygen Documentation]]
 
  
 
== Coding for VLC ==
 
== Coding for VLC ==
  
−
*[[Sending Patches]]  
+
*[[Patch]]ing ([[Sending Patches|sending]])
−
*[[Code Conventions]]  
+
*[[Code Conventions]]
−
*[[Adding a module]]
+
*[[Code Signing]]
 +
*[[{{#rel2abs:/How To Write a Module}}|Adding a module]]
 +
*[[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] &bull; [https://www.videolan.org/developers/vlc/doc/doxygen/html/modules.html modules] &bull; [https://www.videolan.org/developers/vlc/doc/doxygen/html/annotated.html data structures] &bull; [https://www.videolan.org/developers/vlc/doc/doxygen/html/files.html files] &bull; [https://www.videolan.org/developers/vlc/doc/doxygen/html/group__vlc.html API])</span>
 +
*[[C Types]]
 +
*[[Strings]]
 +
 
 +
== User Experience ==
 +
 
 +
*[[Playback States]]
 +
 
 +
== Testing ==
 +
 
 +
*[[Test Suite]]
  
 +
== Mozilla plugins ==
  
−
=== Authors ===
+
* [[Plugins/Mozilla|Plugins in Mozilla]]
−
*Derk-Jan Hartman
 
−
*Christophe Massiot
 
−
*Samuel Hocevar
 
−
*Geoffroy Couprie
 
−
*JB
 
  
−
{{Documentation}}
+
{{Hacker_Guide}}

Latest revision as of 08:47, 17 April 2019

Introduction

VLC media player is a very popular, but quite large and complex piece of software.
It uses a large number of 3rd party libraries.

VLC development is open source, and then a large community of developers worldwide contribute to it.
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.
NB: this guide is not about compiling VLC.


A very good introduction to VLC can also be found on (an archived copy of the site) enjoythearchitecture.

The layers of VLC and libVLC

VLC's Core / libVLCcore

The most important (and probably most complex) part of VLC is the core, located under src in the repository.

Plugins / Modules

How to write a VLC module.

Input

  • Access
    • An access module provides a byte stream from a location string MRL, like support for files, HTTP streams, webcams...
  • Demuxer
  • 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.
  • 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.
  • Decoder
    • A decoder takes an elementary stream and convert into raw video, audio or text data, reading for output.

Audio

Video

Interfaces

Modules types not documented (yet)

Misc
Streaming output

libVLC and bindings

VLC source code overview

Coding for VLC

User Experience

Testing

Mozilla plugins

This page is part of official VLC media player Documentation (User Guide • Streaming HowTo • Hacker Guide • Modules)
Please read the Documentation Editing Guidelines before you edit the documentation
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
Retrieved from "https://wiki.videolan.org/index.php?title=Hacker_Guide&oldid=60922"