Difference between revisions of "Hacker Guide/VLC source tree"

From VideoLAN Wiki
Jump to navigation Jump to search
m (overview is not only for beginners. beginners are new - no need to repeat)
Line 7: Line 7:
 
! Directory Name         
 
! Directory Name         
 
! Directory Explanation
 
! Directory Explanation
|-
 
|activex              
 
|activex bindings
 
 
|-
 
|-
 
|bindings                 
 
|bindings                 
|Java and Python bindings
+
|Java, CIL and Python bindings
 
|-
 
|-
 
|doc                
 
|doc                
 
|Documentation (not up-to-date)
 
|Documentation (not up-to-date)
|-
 
|evc              
 
| Deprecated, embedded Visual Studio files.
 
 
|-
 
|-
 
|extras -
 
|extras -
Line 26: Line 20:
 
|include                
 
|include                
 
|Header files for vlc
 
|Header files for vlc
|-
 
|ipkg              
 
|A package distribution system used by some Linux disrtibutions. This probably contains definition files for the packages.
 
 
|-
 
|-
 
|libs                
 
|libs                
Line 34: Line 25:
 
|-
 
|-
 
|lxdialog                
 
|lxdialog                
|FIX ME! I guess this is not important, last modified 1 year ago!
+
| Make menuconfig files
 
|-
 
|-
 
|m4                
 
|m4                
Line 41: Line 32:
 
|modules
 
|modules
 
|The most important directory with src/. See [[Modules source tree]].
 
|The most important directory with src/. See [[Modules source tree]].
|-
 
|mozilla              
 
|Mozilla plugin
 
|-
 
|msvc
 
|Deprecated, Microsoft Visual C files I guess
 
 
|-
 
|-
 
|po
 
|po
 
|i18n files
 
|i18n files
 
|-
 
|-
|python
+
|projects
|Probably related to the Python bindings
+
| Projects based on libvlc, Mozilla plugin, ActiveX plugin and MacOS FrameWork
 
|-
 
|-
 
|share
 
|share
Line 64: Line 49:
  
 
|}
 
|}
 +
 +
|ipkg              
 +
|A package distribution system used by some Linux disrtibutions. This probably contains definition files for the packages.
 +
|-
 +
  
 
[[Category:Building]]
 
[[Category:Building]]

Revision as of 03:39, 4 February 2008

This page lists the directories in the source tree of VLC to give an overview of the code. Because VLC has evolved with not so much accumulation in mind, when a new coder looks at the code, s/he is terrified by the abundance of directories. This page was prepared to remedy that situation.

The directories are listed in alphabetical order, with an overview of their contents on the right.

Directory Name Directory Explanation
bindings Java, CIL and Python bindings
doc Documentation (not up-to-date)
extras - contrib (subdirectory of extras) - for required libraries (contains Makefiles to automatically download and compile (or cross-compile) and patch those. Please first attempt to get the development headers precompiled for your distribution.

extras also contains the emacs.init file (useful for coding in Videolan style)

include Header files for vlc
libs Containts the loader (win32 dmo codec loading on Linux) and a SRTP library
lxdialog Make menuconfig files
m4 Macro files needed for automake and autoconf
modules The most important directory with src/. See Modules source tree.
po i18n files
projects Projects based on libvlc, Mozilla plugin, ActiveX plugin and MacOS FrameWork
share icons, scripts to make VLC the default player etc.
src The most important directory with modules/. See src source tree
test scripts to see if everything is OK

|ipkg |A package distribution system used by some Linux disrtibutions. This probably contains definition files for the packages. |-