Difference between revisions of "Documentation:Modules"
Jump to navigation
Jump to search
(add croppadd and canvas) |
(→Service Discovery: Remove redlink Documentation:Modules/shout-winamp. There is information about this sub-module at Documentation:Modules/shout#shout-winamp) |
||
| (107 intermediate revisions by 12 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <div style="float: right; margin-left: 1em;">__TOC__</div> | |
| − | + | This page lists most of the {{VLCSourceFolder|modules}} present in the official [[VLC source code]]. Understanding these pages might require that you know about VLC and its command line usage. It is recommended that you read the other [[Documentation:Documentation|documentation]] first. | |
| − | This page lists most of the modules present in the official VLC source code. Understanding these pages might require that you know about VLC and its command line usage. It is recommended that you read the other [[Documentation:Documentation|documentation]] first. | ||
To list all the available modules in your VLC build, use: | To list all the available modules in your VLC build, use: | ||
| − | % '''vlc --list''' | + | {{%}} '''vlc --list''' |
To list a module's configuration options, use: | To list a module's configuration options, use: | ||
| Line 12: | Line 11: | ||
=== Graphical === | === Graphical === | ||
| − | + | * [[Documentation:Modules/macos|macOS]] | |
| − | + | * [[Documentation:Modules/Qt4|Qt4]] | |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/skins2|Skins2]] |
| − | *[[Documentation:Modules/Qt4|Qt4]] | + | * [[Documentation:Modules/wxWidgets|wxWidgets]] (up to 0.9) |
| − | *[[Documentation:Modules/ | ||
| − | *[[Documentation:Modules/ | ||
| − | |||
=== Text === | === Text === | ||
| + | <!--The next three tend to be listed in this order--> | ||
| + | * [[Documentation:Modules/rc|remote control (rc)]] | ||
| + | * [[Documentation:Modules/telnet|telnet]] (until 2.0.0) | ||
| + | * [[Documentation:Modules/ncurses|ncurses]] | ||
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/lua|lua]] |
| − | |||
| − | |||
=== Other === | === Other === | ||
| − | + | * [[Documentation:Modules/http_intf|HTTP]] | |
| − | *[[Documentation:Modules/http_intf|HTTP]] | + | * [[Documentation:Modules/hotkeys|Hotkeys]] |
| − | *[[Documentation:Modules/hotkeys|Hotkeys]] | + | * [[Documentation:Modules/lirc|lirc]] |
| − | *[[Documentation:Modules/lirc|lirc]] | + | * [[Documentation:Modules/osc|osc]] |
| + | * [[Documentation:Modules/wiimote|Wiimote]] | ||
== Outputs == | == Outputs == | ||
| − | |||
=== Audio Output === | === Audio Output === | ||
| − | + | * [[Documentation:Modules/file_aout|file]] | |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/portaudio|portaudio]] (up to 2.0) |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/sdl_aout|SDL]] (up to 1.1.13) |
| − | *[[Documentation:Modules/ | + | Android specific: |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/opensles|OpenSL ES]] |
| − | + | Linux specific: | |
| − | + | * [[Documentation:Modules/alsa|Alsa]] | |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/arts|aRts]] (up to 0.9.10) |
| − | *[[Documentation:Modules/jack|jack]] | + | * [[Documentation:Modules/esd|esound]] (up to 0.9.10) |
| − | + | * [[Documentation:Modules/jack|jack]] | |
| − | + | * [[Documentation:Modules/pulse|pulse]] | |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/oss|OSS]] |
| − | *[[Documentation:Modules/oss|OSS]] | + | macOS specific: |
| − | *[[Documentation:Modules/ | + | * {{docmod|audioqueue}} (up to 2.2.8) |
| − | *[[Documentation:Modules/ | + | * {{docmod|auhal}} (HAL AudioUnit) |
| − | + | Windows specific: | |
| − | + | * [[Documentation:Modules/directx_aout|DirectX]] | |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/mmdevice|WASAPI]] |
| + | * [[Documentation:Modules/waveout|waveout]] | ||
=== Video Output === | === Video Output === | ||
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/aa|ASCII Art]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/caca|Colored ASCII Art]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/image|Image]] (up to 0.9.10) |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/opengl|OpenGL]] |
| − | + | * [[Documentation:Modules/sdl_vout|SDL]] (up to 2.2.8) | |
| − | + | Linux specific: | |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/directfb|Direct framebuffer]] (up to 2.2.8) |
| − | + | * [[Documentation:Modules/fb|Framebuffer]] | |
| − | + | * [[Documentation:Modules/glx|OpenGL (GLX)]] | |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/x11|X11]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/xvideo|XVideo]] |
| − | *[[Documentation:Modules/glx|OpenGL (GLX)]] | + | Windows specific: |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/direct3d|Direct3D]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/directx_vout|DirectX]] |
| − | + | * [[Documentation:Modules/glwin32|OpenGL for windows]] | |
| − | + | * [[Documentation:Modules/wingdi|Windows GDI]] | |
| − | *[[Documentation:Modules/ | ||
| − | *[[Documentation:Modules/ | ||
| − | *[[Documentation:Modules/ | ||
| − | *[[Documentation:Modules/ | ||
=== Stream Output === | === Stream Output === | ||
| + | <div class="col3"> | ||
| + | * [[Documentation:Modules/autodel|Autodel]] | ||
| + | * [[Documentation:Modules/delay|Delay]] | ||
| + | * [[Documentation:Modules/description|Description]] | ||
| + | * [[Documentation:Modules/display|Display]] | ||
| + | * [[Documentation:Modules/dummy_sout|Dummy]] | ||
| + | * [[Documentation:Modules/duplicate|Duplicate]] | ||
| + | * [[Documentation:Modules/es|Elementary Stream (es)]] | ||
| + | * [[Documentation:Modules/gather|Gather]] | ||
| + | * [[Documentation:Modules/rtp|RTP]] | ||
| + | * [[Documentation:Modules/standard|Standard (std)]] | ||
| + | * [[Documentation:Modules/switcher|Switcher]] (up to 2.0.9) | ||
| + | * [[Documentation:Modules/transcode|Transcode]] | ||
| + | * [[Documentation:Modules/transrate|Transrate]] (up to 1.0.2) | ||
| + | </div> | ||
| − | + | The following are for use in the mosaic framework only: | |
| − | + | <div class="col3"> | |
| − | + | * [[Documentation:Modules/bridge-in|Bridge In]] | |
| − | + | * [[Documentation:Modules/bridge-out|Bridge Out]] | |
| − | + | * [[Documentation:Modules/mosaic-bridge|Mosaic Bridge]] | |
| − | + | </div> | |
| − | |||
| − | |||
| − | |||
| − | *[[Documentation:Modules/bridge- | ||
| − | *[[Documentation:Modules/bridge- | ||
| − | *[[Documentation:Modules/mosaic-bridge|Mosaic Bridge]] | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== Filters == | == Filters == | ||
| − | |||
=== Audio Filters === | === Audio Filters === | ||
| − | |||
=== Video Filters === | === Video Filters === | ||
| − | + | <div class="col3"> | |
| − | *[[Documentation:Modules/adjust|Adjust]] | + | * [[Documentation:Modules/adjust|Adjust]] |
| − | *[[Documentation:Modules/gradient|Gradient]] | + | * [[Documentation:Modules/anaglyph|Anaglyph 3D]] |
| − | *[[Documentation:Modules/invert|Invert]] | + | * [[Documentation:Modules/atmo|AtmoLight]] (up to 3.0.0) |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/colorthres|Color Threshold]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/distort|Distort]] (up to 0.8.6 - split into various) |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/erase|Logo Erase]] |
| − | *[[Documentation:Modules/psychedelic|Psychedelic]] | + | * [[Documentation:Modules/extract|Extract]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/freeze|Freeze]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/gaussianblur|Gaussian Blur]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/gradfun|Gradfun]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/gradient|Gradient]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/invert|Invert]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/motionblur|Motion Blur]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/noise|Noise]] (up to 1.1.13) |
| + | * [[Documentation:Modules/oldmovie|Oldmovie]] | ||
| + | * [[Documentation:Modules/posterize|Posterize]] | ||
| + | * [[Documentation:Modules/psychedelic|Psychedelic]] | ||
| + | * [[Documentation:Modules/ripple|Ripple]] | ||
| + | * [[Documentation:Modules/rotate|Rotate]] | ||
| + | * [[Documentation:Modules/scene|Scene]] | ||
| + | * [[Documentation:Modules/sepia|Sepia]] | ||
| + | * [[Documentation:Modules/sharpen|Sharpen]] | ||
| + | * [[Documentation:Modules/VHS|VHS]] | ||
| + | * [[Documentation:Modules/wave|Wave]] | ||
| + | </div> | ||
The following video filters are for use in transcode only: | The following video filters are for use in transcode only: | ||
| − | *[[ | + | * [[Transcode#Canvas_and_Padding|Canvas]] |
| − | *[[ | + | * [[Transcode#Canvas_and_Padding|Crop Padd]] |
The following video filters are for use in the mosaic framework only: | The following video filters are for use in the mosaic framework only: | ||
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/alphamask|Alpha mask]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/bluescreen|Blue Screen]] |
=== Video Sub-Filters === | === Video Sub-Filters === | ||
| − | + | * [[Documentation:Modules/logo|Logo]] | |
| − | + | * [[Documentation:Modules/marq|Marq]] | |
| − | *[[Documentation:Modules/marq|Marq]] | + | * [[Documentation:Modules/mosaic|Mosaic]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/rss|RSS]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/subsdelay|Subsdelay]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/time|Time]] (up to 0.8.6 - merged with marq) |
| − | *[[Documentation:Modules/time|Time]] (up to 0.8.6) | ||
=== Video Output Filters === | === Video Output Filters === | ||
| + | * [[Documentation:Modules/crop|Crop]] | ||
| + | * [[Documentation:Modules/deinterlace|Deinterlace]] | ||
| + | * [[Documentation:Modules/logo|Logo]] | ||
| + | * [[Documentation:Modules/magnify|Magnify]] | ||
| + | * [[Documentation:Modules/puzzle|Puzzle]] | ||
| + | * [[Documentation:Modules/transform|Transform]] | ||
| − | + | ==== Video Splitters ==== | |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/clone|Clone]] |
| − | + | * [[Documentation:Modules/panoramix|Panoramix]] | |
| − | + | * [[Documentation:Modules/wall|Wall]] | |
| − | *[[Documentation:Modules/panoramix|Panoramix]] | ||
| − | *[[Documentation:Modules/ | ||
| − | |||
| − | |||
| − | |||
| − | |||
=== Visualizations === | === Visualizations === | ||
| − | + | * [[Documentation:Modules/galaktos|Galaktos]] (up to 1.0.6) | |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/goom|Goom]] |
| − | *[[Documentation:Modules/goom|Goom]] | + | * [[Documentation:Modules/projectm|ProjectM]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/visual|Visual]] |
| + | * [[Documentation:Modules/vsxu|Vovoid VSXu]] | ||
=== Access Filters === | === Access Filters === | ||
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/bandwidth|Bandwidth]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/dump|Dump]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/record|Record]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/timeshift|Timeshift]] (up to 0.9.9 - moved to core) |
== Other == | == Other == | ||
| + | === Accesses === | ||
| + | <div class="col3"> | ||
| + | * [[Documentation:Modules/cdda|CD Input]] | ||
| + | * [[Documentation:Modules/directory|Directory]] | ||
| + | * [[Documentation:Modules/dvdnav|DVDnav Input]] - DVD with menus | ||
| + | * [[Documentation:Modules/dvdread|DVDRead Input]] - DVD without menus | ||
| + | * [[Documentation:Modules/fake|Fake]] (up to 0.9.0) - presents a static image as a video stream | ||
| + | * [[Documentation:Modules/file|File Input]] - for reading local files | ||
| + | * [[Documentation:Modules/ftp|FTP Input]] | ||
| + | * [[Documentation:Modules/h26x|H.264 Video]] | ||
| + | * [[Documentation:Modules/http|HTTP Input]] | ||
| + | * {{docmod|jpeg}} | ||
| + | * {{docmod|mjpeg}} | ||
| + | * [[Documentation:Modules/mkv|Matroska stream]] | ||
| + | * [[Documentation:Modules/mms|MMS]] - for reading from the MicroSoft Media Server | ||
| + | * [[Documentation:Modules/rawvid|Raw Video]] - streams of bitmap images | ||
| + | * [[Documentation:Modules/rtp|RTP Input]] | ||
| + | * [[Documentation:Modules/rtsp|RTSP]] | ||
| + | * {{docmod|sdp}} | ||
| + | * [[Documentation:Modules/screen|Screen Input]] - screen feed | ||
| + | * [[Documentation:Modules/udp|UDP Input]] | ||
| + | * [[Documentation:Modules/vcd|VCD]] | ||
| + | </div> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Linux specific: | Linux specific: | ||
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/dc1394|DC1394]] |
| − | *[[Documentation:Modules/dvb|DVB]] | + | * [[Documentation:Modules/dvb|DVB Input]] |
| − | *[[Documentation:Modules/pvr|PVR]] | + | * [[Documentation:Modules/pvr|PVR]] (IVTV MPEG Encoding Card Input) (up to 2.0.9) |
| − | *[[Documentation:Modules/v4l|Video4Linux (v4l)]] | + | * [[Documentation:Modules/rawdv|DV]] (through libdv) |
| − | *[[Documentation:Modules/v4l2|Video4Linux2 (v4l2)]] | + | * [[Documentation:Modules/v4l|Video4Linux (v4l)]] (up to 1.1.13) |
| − | + | * [[Documentation:Modules/v4l2|Video4Linux2 (v4l2)]] | |
| + | |||
Windows specific: | Windows specific: | ||
| − | *[[Documentation:Modules/bda|BDA]] | + | * [[Documentation:Modules/bda|BDA]] |
| − | *[[Documentation:Modules/dshow|DirectShow]] | + | * [[Documentation:Modules/dshow|DirectShow]] |
| + | |||
| + | macOS specific: | ||
| + | * [[Documentation:Modules/eyetv|EyeTV]] (up to 2.2.8) - reads DVB streams from the proprietary EyeTV.app; requires a plugin | ||
| + | * [[Documentation:Modules/qtcapture|qtcapture]] (up to 2.2.8) - reads uncompressed video from internal iSights | ||
| + | * {{docmod|qtsound}} | ||
| + | * {{docmod|avcapture}} | ||
=== Access Outputs === | === Access Outputs === | ||
| + | * {{docmod|shout}} (shoutcast/icecast) | ||
=== Codecs === | === Codecs === | ||
| + | ==== Audio ==== | ||
| + | * {{docmod|a52}} | ||
| + | * {{docmod|flac}} | ||
| + | * {{docmod|mpc}} - [[Musepack]] | ||
| + | * {{docmod|ogg}} | ||
| + | * {{docmod|vorbis}} | ||
| + | * {{docmod|wav}} | ||
| − | |||
==== Video ==== | ==== Video ==== | ||
| + | * {{docmod|h26x}} | ||
| + | * {{docmod|nsv}} | ||
| + | * {{docmod|schroedinger}} | ||
| + | * {{docmod|vpx}} | ||
| + | |||
==== Subtitles ==== | ==== Subtitles ==== | ||
| + | * [[Documentation:Modules/kate|kate]] | ||
| + | * [[Documentation:Modules/subtitle|subtitle]] | ||
| + | * {{docmod|telx}} | ||
=== Demuxers === | === Demuxers === | ||
| + | * [[Documentation:Modules/avcodec|avcodec]] ("FFmpeg") | ||
| + | |||
==== Playlist ==== | ==== Playlist ==== | ||
| − | * | + | * {{docmod|playlist}} (formats are read with sub-modules) |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== Muxers === | === Muxers === | ||
| + | * {{docmod|asf}} | ||
| + | * {{docmod|avformat}} | ||
| + | * {{docmod|avi}} | ||
| + | * {{docmod|daala}} | ||
| + | * {{docmod|mp4}} | ||
| + | * {{docmod|mpjpeg}} | ||
| + | * {{docmod|ogg}} | ||
| + | * {{docmod|schroedinger}} | ||
| + | * {{docmod|vpx}} | ||
| + | * {{docmod|wav}} | ||
=== Service Discovery === | === Service Discovery === | ||
| − | + | * [[Documentation:Modules/bonjour|Bonjour]] | |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/daap|DAAP]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/hal|HAL]] (up to 1.1.13) |
| − | + | * [[Documentation:Modules/sap|SAP]] | |
| − | *[[Documentation:Modules/hal|HAL]] | + | * [[Documentation:Modules/shout|Shoutcast]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/podcast|podcast]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/upnp|UPnP]] |
| − | *[[Documentation:Modules/ | ||
| − | *[[Documentation:Modules/ | ||
=== Misc === | === Misc === | ||
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/motion_control|Motion control]] |
| − | *[[Documentation:Modules/ | + | * [[Documentation:Modules/netsync|Netsync]] |
| + | [[Category:Modules|*]] | ||
{{Documentation}} | {{Documentation}} | ||
Latest revision as of 08:36, 28 May 2019
Contents
This page lists most of the present in the official VLC source code. Understanding these pages might require that you know about VLC and its command line usage. It is recommended that you read the other documentation first.
To list all the available modules in your VLC build, use:
% vlc --list
To list a module's configuration options, use:
% vlc -p <modulename> --advanced --help-verbose
Interfaces
Graphical
Text
- remote control (rc)
- telnet (until 2.0.0)
- ncurses
Other
Outputs
Audio Output
Android specific:
Linux specific:
macOS specific:
- audioqueue (up to 2.2.8)
- auhal (HAL AudioUnit)
Windows specific:
Video Output
- ASCII Art
- Colored ASCII Art
- Image (up to 0.9.10)
- OpenGL
- SDL (up to 2.2.8)
Linux specific:
- Direct framebuffer (up to 2.2.8)
- Framebuffer
- OpenGL (GLX)
- X11
- XVideo
Windows specific:
Stream Output
- Autodel
- Delay
- Description
- Display
- Dummy
- Duplicate
- Elementary Stream (es)
- Gather
- RTP
- Standard (std)
- Switcher (up to 2.0.9)
- Transcode
- Transrate (up to 1.0.2)
The following are for use in the mosaic framework only:
Filters
Audio Filters
Video Filters
- Adjust
- Anaglyph 3D
- AtmoLight (up to 3.0.0)
- Color Threshold
- Distort (up to 0.8.6 - split into various)
- Logo Erase
- Extract
- Freeze
- Gaussian Blur
- Gradfun
- Gradient
- Invert
- Motion Blur
- Noise (up to 1.1.13)
- Oldmovie
- Posterize
- Psychedelic
- Ripple
- Rotate
- Scene
- Sepia
- Sharpen
- VHS
- Wave
The following video filters are for use in transcode only:
The following video filters are for use in the mosaic framework only:
Video Sub-Filters
Video Output Filters
Video Splitters
Visualizations
- Galaktos (up to 1.0.6)
- Goom
- ProjectM
- Visual
- Vovoid VSXu
Access Filters
Other
Accesses
- CD Input
- Directory
- DVDnav Input - DVD with menus
- DVDRead Input - DVD without menus
- Fake (up to 0.9.0) - presents a static image as a video stream
- File Input - for reading local files
- FTP Input
- H.264 Video
- HTTP Input
- jpeg
- mjpeg
- Matroska stream
- MMS - for reading from the MicroSoft Media Server
- Raw Video - streams of bitmap images
- RTP Input
- RTSP
- sdp
- Screen Input - screen feed
- UDP Input
- VCD
Linux specific:
- DC1394
- DVB Input
- PVR (IVTV MPEG Encoding Card Input) (up to 2.0.9)
- DV (through libdv)
- Video4Linux (v4l) (up to 1.1.13)
- Video4Linux2 (v4l2)
Windows specific:
macOS specific:
- EyeTV (up to 2.2.8) - reads DVB streams from the proprietary EyeTV.app; requires a plugin
- qtcapture (up to 2.2.8) - reads uncompressed video from internal iSights
- qtsound
- avcapture
Access Outputs
- shout (shoutcast/icecast)
Codecs
Audio
Video
Subtitles
Demuxers
- avcodec ("FFmpeg")
Playlist
- playlist (formats are read with sub-modules)
Muxers
Service Discovery
Misc
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.
