Difference between revisions of "Hacker Guide"

From VideoLAN Wiki
Jump to navigation Jump to search
Line 9: Line 9:
 
''NB: this guide is '''not''' about compiling VLC.''  
 
''NB: this guide is '''not''' about compiling VLC.''  
  
 +
<br>
  
 
== The layers of VLC and libVLC  ==
 
== The layers of VLC and libVLC  ==
Line 20: Line 21:
 
*[[Documentation:Hacker's Guide/Object Management|VLC Object Management]]  
 
*[[Documentation:Hacker's Guide/Object Management|VLC Object Management]]  
 
*[[Documentation:Hacker's Guide/VLM Internals|VLM Internals]]
 
*[[Documentation:Hacker's Guide/VLM Internals|VLM Internals]]
 +
*VLC variables '''TODO'''
  
 
=== Plugins / Modules  ===
 
=== Plugins / Modules  ===
Line 55: Line 57:
  
 
*[[VLC source tree]]  
 
*[[VLC source tree]]  
*[[Modules source tree]]
+
*[[Modules source tree]]  
 
*[[Documentation:Hacker's Guide/Preferences|VLC Preferences]]  
 
*[[Documentation:Hacker's Guide/Preferences|VLC Preferences]]  
 
*[[Documentation:Hacker's Guide/Playlist|VLC Playlist and Media Library]]  
 
*[[Documentation:Hacker's Guide/Playlist|VLC Playlist and Media Library]]  
*VLC variables
 
*[http://www.videolan.org/developers/vlc/doc/doxygen/html/ Doxygen Documentation]
 
  
 
== Coding for VLC  ==
 
== Coding for VLC  ==
Line 66: Line 66:
 
*[[Code Conventions]]  
 
*[[Code Conventions]]  
 
*[[Adding a module]]
 
*[[Adding a module]]
 
+
*[http://www.videolan.org/developers/vlc/doc/doxygen/html/ Doxygen Documentation]
  
 
=== Authors  ===
 
=== Authors  ===

Revision as of 14:19, 29 October 2010

Introduction

VLC media player is a large and complex piece of software. It also uses a large number of dependencies.

Being open source allows VLC development to benefit from a large community of developers worldwide.
However, entering a project such as VLC media player 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.


The layers of VLC and libVLC

VLC's Core /libvlccore

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

Plugins / Modules

Writing a VLC module


Modules types not documented (yet)

libVLC and bindings

VLC source code overview

Coding for VLC

Authors

  • Derk-Jan Hartman
  • Christophe Massiot
  • Samuel Hocevar
  • Geoffroy Couprie
  • Jean-Baptiste Kempf
This page is part of official VLC media player Documentation (User GuideStreaming HowToHacker GuideModules)
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.