Difference between revisions of "Hacker Guide/VLC source tree"
Jump to navigation
Jump to search
m (+{{Back to|Hacker Guide}}) |
|||
| (18 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
| − | 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. | + | {{Back to|Hacker Guide}} |
| + | This page lists the directories in the [https://git.videolan.org/?p=vlc.git;a=tree 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. | The directories are listed in alphabetical order, with an overview of their contents on the right. | ||
| Line 11: | Line 12: | ||
|Java, CIL and Python bindings | |Java, CIL and Python bindings | ||
|- | |- | ||
| − | |doc | + | | {{VLCSourceFolder|contrib}} |
| + | | 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. | ||
| + | |- | ||
| + | |{{VLCSourceFolder|doc}} | ||
|Documentation (not up-to-date) | |Documentation (not up-to-date) | ||
|- | |- | ||
| − | |extras | + | |{{VLCSourceFolder|extras}} |
| − | | | + | | ''[[#Contents_of_extras|See below]]'' |
| − | '' | ||
|- | |- | ||
| − | |include | + | |{{VLCSourceFolder|include}} |
| − | |Header files for | + | |Header files for VLC |
|- | |- | ||
| − | | | + | |{{VLCSourceFolder|lib}} |
| − | | | + | |Contains all [[LibVLC]] control code |
|- | |- | ||
| − | | | + | |{{VLCSourceFolder|m4}} |
| − | |||
| − | |||
| − | |m4 | ||
|Macro files needed for automake and autoconf | |Macro files needed for automake and autoconf | ||
|- | |- | ||
| − | |modules | + | |{{VLCSourceFolder|modules}} |
| − | |The most important directory | + | |The most important directory besides src/. ''See [[{{#rel2abs:../Modules source tree}}]].'' |
|- | |- | ||
| − | |po | + | |{{VLCSourceFolder|po}} |
| − | |i18n files | + | |i18n (language translation) files |
|- | |- | ||
|projects | |projects | ||
| − | | Projects based on libvlc, Mozilla plugin, ActiveX plugin and | + | | Projects based on libvlc, Mozilla plugin, ActiveX plugin and [[Mac OS X Framework]] |
|- | |- | ||
| − | |share | + | |{{VLCSourceFolder|share}} |
|icons, scripts to make VLC the default player etc. | |icons, scripts to make VLC the default player etc. | ||
|- | |- | ||
| − | |src | + | |{{VLCSourceFolder|src}} |
| − | |The most important directory | + | |The most important directory besides modules/. ''See [[{{#rel2abs:/src}}|src source tree]].'' |
|- | |- | ||
| − | |test | + | |{{VLCSourceFolder|test}} |
|scripts to see if everything is OK | |scripts to see if everything is OK | ||
|} | |} | ||
| − | | | + | == Contents of extras == |
| − | | | + | {| class="wikitable" |
| + | | {{VLCSourceFolder|extras/analyser}} | ||
| + | | contains some code style editor (vim, emacs) macro and some valgrind suppressions | ||
|- | |- | ||
| + | | {{VLCSourceFolder|extras/buildsystem}} | ||
| + | | contains alternative buildsystems | ||
| + | |- | ||
| + | | extras/deprecated | ||
| + | | contains deprecated files | ||
| + | |- | ||
| + | | {{VLCSourceFolder|extras/misc}} | ||
| + | | contains files that don't fit into any other category | ||
| + | |- | ||
| + | | {{VLCSourceFolder|extras/package}} | ||
| + | | contains distribution specific files such as ipkg, different rpm spec files, win32 and Mac OS X installation files. | ||
| + | |- | ||
| + | |} | ||
| − | + | {{Hacker Guide}} | |
[[Category:Building]] | [[Category:Building]] | ||
Latest revision as of 06:40, 17 April 2019
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 |
| 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. | |
| Documentation (not up-to-date) | |
| See below | |
| Header files for VLC | |
| Contains all LibVLC control code | |
| Macro files needed for automake and autoconf | |
| The most important directory besides src/. See Hacker Guide/Modules source tree. | |
| i18n (language translation) files | |
| projects | Projects based on libvlc, Mozilla plugin, ActiveX plugin and Mac OS X Framework |
| icons, scripts to make VLC the default player etc. | |
| The most important directory besides modules/. See src source tree. | |
| scripts to see if everything is OK |
Contents of extras
| contains some code style editor (vim, emacs) macro and some valgrind suppressions | |
| contains alternative buildsystems | |
| extras/deprecated | contains deprecated files |
| contains files that don't fit into any other category | |
| contains distribution specific files such as ipkg, different rpm spec files, win32 and Mac OS X installation files. |
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
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.
