vlc/doc/developer2/synopsys.txt

89 lines
1.2 KiB
Plaintext

Structure for the new vlc developer documentation
* Coding rules
- Hungarian notation
- Code indentation
* LibVLC, VLC, and Mozilla plugin
- Libvlc structure
* Build system
- Modules.am
- bootstrap sequence
- vlc-config
- config.h
- toolbox
* i18n
- Gettext
* Modules
- Calling a module
- Writing a module descriptor (do not forget E_ & N_ )
- The module bank
* Objects
- vlc_object_t
- Creating, deleting objects
- parents and children
- Refcounts
* CPU stuff
* Misc stuff
- VLC_EXPORT
- MODULE_NAME_is
- more ?
* Variables, callbacks, and configuration
- Variable management
- adding configuration to modules
* Thread management
- thread
- mutexes
- condition variables
* Playlist management
- The playlist object
- Items / Options
- Playlist infos
* Message queue
* Interface modules
* Input layer
- Access / stream
- Demuxers / ES
- PCR / PTS / DTS
- Input, access and demux control
* Packetizers
* Decoders
* Vout
- Subpictures
- Text rendering
- Filters
* Aout
- Mixers
- Filters (converters, resamplers, downmixers)
- Output
* Sout
- stream chain
- packetizer
- encoder
- muxer
- access output
* Porting
- port specific stuff
* Debugging
- Compile flags
- Valgrind / eFence / ...