View source for Hacker Guide/Core

{{Back to|Hacker Guide}}
== Introduction to libVLCcore  ==

The core of {{VLC}} is called '''[[libVLCcore]]'''.<br>
It manages the threads, the modules (codecs, demuxers, etc...), the modules' layers, the clocks, the playlist and all low-level control in VLC.<br>For example, it is responsible for the synchronization management between all the audio, video and subtitle tracks. 

On top of libVLCcore, there is '''[[libVLC]]''' that allow external application builders to access to all features of the core.<br> Modules are linked with libvlccore, to interact with the core. 

'''Modules are built against libvlccore. External applications are built against [[libVLC]].'''

== VLC Pipeline and Modularity ==

One of the main concepts in VLC is "'''''modularity'''''". 

VLC is, in fact, a complete [[wikipedia:multimedia framework|multimedia framework]] (like DirectShow or GStreamer) where you can load and plug-in many modules dynamically, depending on the necessity. 

The core framework is used to do the "wiring" and the media processing, from input (files, network streams) to output (audio or video, on a screen or a network). It uses modules to do most of the work at every stage (various muxers, demuxers, decoders, filters and outputs).<br> Even the interfaces are plugins for libVLC. 

=== The modules in VLC  ===

So, VLC uses '''modules''' to do most of the work, at every stage of the pipeline. Modules are loaded accordingly at runtime depending on the necessity. (See [[Documentation:VLC_Modules_Loading|VLC Modules loading mechanism]]).

Every module offers different features that will best suit a particular use-case or a particular environment.<br>
Besides, most portability of VLC results from writing [[{{#rel2abs:../Audio_Output}}|audio_output]]/[[{{#rel2abs:../Video Output}}|video_output]]/[[{{#rel2abs:../Interfaces}}|interface]] modules specific to the platform.

'''plugins''' modules are loaded and unloaded dynamically by functions in {{VLCSourceFile|src/modules/modules.c}} .<br>
Modules can also be built directly into the application which uses libVLC, for instance when VLC is on an operating system that does not have support for dynamically loadable code. They are then called '''builtins'''.

In the [[{{#rel2abs:../VLC source tree}}|source code]], modules are usually located inside the [[{{#rel2abs:../Modules source tree}}|modules/ subdirectory]].

== Thread management  ==

VLC is heavily multi-threaded.

The single-threaded approach would have introduced too much complexity because decoder preemptibility and scheduling would then be a mastermind (for instance decoders and outputs have to be separated, otherwise it cannot be warrantied that a frame will be played at the exact presentation time).<br>
Multi-process approach wasn't chosen either, because multi-process decoders usually imply more overhead (problems of shared memory) and communication between processes is harder.

VLC's threading structure is modeled after POSIX threads (''pthread''). However, for portability reasons, VLC does not use <code>pthread_*</code> functions directly, but a similar custom set of APIs.

=== Threads (vlc_thread_t) ===
; <code>vlc_clone()</code>
: Creates a thread.
; <code>vlc_join()</code>
: Waits for a thread to terminate and releases its resources

=== Mutual exclusion (vlc_mutex_t) ===
; <code>vlc_mutex_init()</code>
: Creates a non-recursive mutex.
; <code>vlc_mutex_init_recursive()</code>
: Creates a recursive mutex (discouraged).
; <code>vlc_mutex_lock()</code>
: Locks a mutex, waiting if required.
; <code>vlc_mutex_trylock()</code>
: Locks a mutex if it is not already locked, or returns an error otherwise.
; <code>vlc_mutex_unlock()</code>
: Unlocks a mutex.
; <code>vlc_mutex_destroy()</code>
: Destroys a mutex.

=== Condition variable (vlc_cond_t) ===
; <code>vlc_cond_init()</code>
: Creates a condition variable using the monotonic clock (<code>mdate()</code>) for timeouts.
; <code>vlc_cond_init_daytime()</code>
: Creates a condition variable using the realtime clock / wall clock for timeouts.
; <code>vlc_cond_signal()</code>
: Signals one thread waiting on a condition variable.
; <code>vlc_cond_broadcast()</code>
: Signals all threads waiting on a condition variable.
; <code>vlc_cond_wait()</code>
: Waits for a condition variable to be signaled (can also wake up spuriously).
; <code>vlc_cond_timedwait()</code>
: Waits for a condition variable to be signaled up to a certain timeout (can also wake up spuriously).
; <code>vlc_cond_destroy()</code>
: Destroys a condition variable.

=== Misc ===
VLC also has abstractions for slim read/write locks, spin locks, thread-specific variables, similar to POSIX threads.

=== Atomic variables ===
Atomic variables are small <code>(sizeof(void *))</code> values that can be manipulated from multiple threads without locking. See <code>include/vlc_atomic.h</code> for the list of supported operations.

== Synchronization  ==

Another key feature of VLC is that decoding and playing are asynchronous: decoding is done by a decoder thread, playing is done by audio_output or video_output thread. The design goal is to ensure that an audio or video frame is played exactly at the right time, without blocking any of the decoder threads. This leads to a complex communication structure between the interface, the input, the decoders and the outputs. 

Having several input and video_output threads reading multiple files at the same time is permitted, despite the fact that the current interface doesn't allow any way to do it (this is subject to change in the near future). Anyway the client has been written from the ground up with this in mind. This also implies that a non-reentrant library (including in particular liba52<sup>[[{{TALKPAGENAME}}|See talk page]]</sup>) cannot be used without using a global lock. 

Presentation Time Stamps located in the system layer of the stream are passed to the decoders, and all resulting samples are dated accordingly. The output layers are supposed to play them at the right time. Dates are converted to microseconds, an absolute date is the number of microseconds since Epoch (Jan 1st, 1970). The <code>mtime_t</code> type is a signed 64-bit integer. 

The current date can be retrieved with <code>mdate()</code>. The execution of a thread can be suspended until a certain date via <code>mwait ( mtime_t date )</code>. You can sleep for a fixed number of microseconds with <code>msleep ( mtime_t delay )</code>. 

=== Warning  ===

Please remember to wake up slightly before the presentation date, if some particular treatment needs to be done (e.g. a chroma transformation). For instance in <code>modules/codec/libmpeg2.c</code>, track of the average decoding times is kept to ensure pictures are not decoded too late.

== Core Source code details  ==

All the [[libVLCcore]] source files are located in the {{VLCSourceFolder|src}} directory and its subdirectories: 

; [[{{#rel2abs:../Audio Output}}|<code>audio_output/</code>]]
: Initializes the audio mixer, ie. finds the right playing frequency, and then resamples audio frames received from the decoder(s). 
; <code>config/</code>
: Load the configuration from command line and configuration file, provides functions for the modules to read and write to configuration 
; <code>control/</code>
: Functions to control the behaviour of [[libVLCcore]], like Play/Pause, volume management, fullscreen, log verbosity, etc. 
; <code>extras/</code>
: Mostly platform-specific code 
; [[{{#rel2abs:../Input}}|<code>input/</code>]]
: Opens an input module, reads packets, parses them and passes reconstituted elementary streams to the decoder(s).
; [[{{#rel2abs:../Interfaces}}|<code>interface/</code>]]
: Contains code for user interaction such as key presses and device ejection. 
; <code>misc/</code>
: Miscellaneous utilities used in other parts of libvlc, such as the thread system, the message queue, CPU detection, the object lookup system, or platform-specific code. 
; <code>modules/</code>
: Modules management 
; <code>network/</code>
: Network interface (socket management, network errors, etc.) 
; <code>osd/</code>
: On Screen Display manipulation 
; <code>playlist/</code>
: Manages playlist interaction such as stop, play, next, or random playback. 
; <code>stream_output/</code>
: Functions to stream audio and video to the network 
; <code>test/</code>
: libVLC needs to be tested, and not only by users :) 
; <code>text/</code>
: Charset stuff 
; [[{{#rel2abs:../Video Output}}|<code>video_output/</code>]]
: Initializes the video display, gets all pictures and subpictures (ie. subtitles) from the decoder(s), optionally converts them to another format (such as YUV to RGB), and displays them.

{{Hacker_Guide}}