kamalkarun2124/vlc

Purpose and entry points

VLC is a cross-platform native multimedia engine and player: it ingests files, discs, capture devices, and network streams; plays, converts, encodes, or redistributes them. The desktop executable starts in bin/vlc.c; platform launchers also exist in bin/winvlc.c and bin/darwinvlc.m. Embedders consume the C libVLC API declared in include/vlc/libvlc.h, implemented under lib/, and backed by the internal core.

Core runtime and plugin boundary

libvlccore owns application lifecycle, configuration, module discovery/loading, shared objects, threading, and platform abstraction. Key boundaries are src/libvlc.c, src/libvlc-module.c, and src/modules/modules.c. Feature implementations are selected as modules rather than hardwired dependencies; their common contracts are declared in headers such as include/vlc_modules.h, include/vlc_access.h, include/vlc_codec.h, and include/vlc_vout.h. This makes input formats, codecs, outputs, interfaces, and optional platform capabilities replaceable at runtime/build time.

Playback orchestration

The player and playlist layers turn user/API requests into input sessions, handle queue navigation, track selection, timers, metadata, and output lifecycle. Primary control paths are src/player/player.c, src/player/input.c, and src/playlist/playlist.c. GUI, CLI, DBus, HTTP/Lua, or libVLC clients should control this layer rather than directly composing decoding pipelines.

Media ingest and demux pipeline

Input opens an MRL through access/stream modules, applies stream filters or extractors, selects a demuxer, and emits elementary streams. The core coordination is in src/input/input.c, src/input/access.c, and src/input/demux.c; pluggable implementations live in modules/access/, modules/stream_filter/, modules/stream_extractor/, and modules/demux/. Examples include HTTP/2 access (modules/access/http/h2conn.c) and adaptive HTTP streaming, whose playlist, segment-tracking, and rate-selection layers are under modules/demux/adaptive/.

Decode, timing, and render pipeline

Demuxed elementary streams pass through packetizers and decoder modules, then synchronized audio/video/subpicture paths. Important stages are src/input/decoder.c, modules/packetizer/, and modules/codec/; FFmpeg integration is represented by modules/codec/avcodec/avcodec.c. Audio processing and device output are separated into core audio output (src/audio_output/output.c), filters/mixers (modules/audio_filter/, modules/audio_mixer/), and OS backends (modules/audio_output/). Video output similarly separates core vout control (src/video_output/video_output.c) from chroma/filter processing and display backends in modules/video_chroma/, modules/video_filter/, and modules/video_output/.

Output, streaming, and remote control

The same engine can construct stream-output chains for transcode, mux, file/network delivery, HLS, RTP/RTSP, Chromecast, or DLNA. The chain coordinator is src/stream_output/stream_output.c; implementations are under modules/stream_out/, modules/mux/, and modules/access_output/. Control surfaces are plugins: CLI (modules/control/cli/cli.c), DBus (modules/control/dbus/dbus.c), Qt (modules/gui/qt/qt.cpp), macOS UI (modules/gui/macosx/main/macosx.m), and Lua HTTP assets (share/lua/http/).

Dependencies, platforms, and builds

The principal runtime languages are C, C++, Objective-C, assembly, and Rust; Rust bindings/core crates reside under src/rust/. Autotools and Meson are both supported (configure.ac, meson.build). contrib/ builds pinned third-party dependencies for cross-platform or unavailable-system-library cases, including FFmpeg, Qt, GnuTLS, SQLite, Vulkan, and codec libraries. Platform-specific code spans Windows, Apple, Linux/BSD, Android, Emscripten, and OS/2 directories under src/ and modules/; packaging scripts are in extras/package/.