Difference between revisions of "Documentation:Modules"

From VideoLAN Wiki
Jump to navigation Jump to search
m (→‎Video Output: Divide into sections by OS)
m (abc)
Line 11: Line 11:
  
 
=== Graphical ===
 
=== Graphical ===
 +
*[[Documentation:Modules/macos|macOS]]
 
*[[Documentation:Modules/Qt4|Qt4]]
 
*[[Documentation:Modules/Qt4|Qt4]]
 
*[[Documentation:Modules/skins2|Skins2]]
 
*[[Documentation:Modules/skins2|Skins2]]
−
*[[Documentation:Modules/macos|macOS]]
 
 
*[[Documentation:Modules/wxWidgets|wxWidgets]] (up to 0.9)
 
*[[Documentation:Modules/wxWidgets|wxWidgets]] (up to 0.9)
  
 
=== Text ===
 
=== Text ===
 +
<!--The next three tend to be listed in this order-->
 
*[[Documentation:Modules/rc|remote control (rc)]]
 
*[[Documentation:Modules/rc|remote control (rc)]]
 
*[[Documentation:Modules/telnet|telnet]] (until 2.0.0)
 
*[[Documentation:Modules/telnet|telnet]] (until 2.0.0)
 
*[[Documentation:Modules/ncurses|ncurses]]
 
*[[Documentation:Modules/ncurses|ncurses]]
 +
 
*[[Documentation:Modules/lua|lua]]
 
*[[Documentation:Modules/lua|lua]]
  
Line 31: Line 33:
 
== Outputs ==
 
== Outputs ==
 
=== Audio Output ===
 
=== Audio Output ===
−
*[[Documentation:Modules/sdl_aout|SDL]] (up to 1.1.13)
 
 
*[[Documentation:Modules/auhal|AUHAL]]
 
*[[Documentation:Modules/auhal|AUHAL]]
−
*[[Documentation:Modules/pulse|pulse]]
 
 
*[[Documentation:Modules/file_aout|file]]
 
*[[Documentation:Modules/file_aout|file]]
 
*[[Documentation:Modules/portaudio|portaudio]] (up to 2.0)
 
*[[Documentation:Modules/portaudio|portaudio]] (up to 2.0)
 +
*[[Documentation:Modules/pulse|pulse]]
 +
*[[Documentation:Modules/sdl_aout|SDL]] (up to 1.1.13)
 
Android specific:
 
Android specific:
 
*[[Documentation:Modules/opensles|OpenSL ES]]
 
*[[Documentation:Modules/opensles|OpenSL ES]]
 
Linux specific:
 
Linux specific:
 
*[[Documentation:Modules/alsa|Alsa]]
 
*[[Documentation:Modules/alsa|Alsa]]
−
*[[Documentation:Modules/oss|OSS]]
 
 
*[[Documentation:Modules/arts|aRts]] (up to 0.9.10)
 
*[[Documentation:Modules/arts|aRts]] (up to 0.9.10)
 
*[[Documentation:Modules/esd|esound]] (up to 0.9.10)
 
*[[Documentation:Modules/esd|esound]] (up to 0.9.10)
 
*[[Documentation:Modules/jack|jack]]
 
*[[Documentation:Modules/jack|jack]]
−
macOS specific:
+
*[[Documentation:Modules/oss|OSS]]
−
 
 
 
Windows specific:
 
Windows specific:
 
*[[Documentation:Modules/directx_aout|DirectX]]
 
*[[Documentation:Modules/directx_aout|DirectX]]
 +
*[[Documentation:Modules/mmdevice|WASAPI]]
 
*[[Documentation:Modules/waveout|waveout]]
 
*[[Documentation:Modules/waveout|waveout]]
−
*[[Documentation:Modules/mmdevice|WASAPI]]
 
  
 
=== Video Output ===
 
=== Video Output ===
 +
*[[Documentation:Modules/aa|ASCII Art]]
 +
*[[Documentation:Modules/caca|Colored ASCII Art]]
 +
*[[Documentation:Modules/image|Image]] (up to 0.9.10)
 
*[[Documentation:Modules/opengl|OpenGL]]
 
*[[Documentation:Modules/opengl|OpenGL]]
 
*[[Documentation:Modules/sdl_vout|SDL]] (up to 2.2.8)
 
*[[Documentation:Modules/sdl_vout|SDL]] (up to 2.2.8)
−
*[[Documentation:Modules/caca|Colored ASCII Art]]
 
−
*[[Documentation:Modules/aa|ASCII Art]]
 
−
*[[Documentation:Modules/image|Image]] (up to 0.9.10)
 
 
Linux specific:
 
Linux specific:
 +
*[[Documentation:Modules/directfb|Direct framebuffer]] (up to 2.2.8)
 +
*[[Documentation:Modules/fb|Framebuffer]]
 
*[[Documentation:Modules/glx|OpenGL (GLX)]]
 
*[[Documentation:Modules/glx|OpenGL (GLX)]]
−
*[[Documentation:Modules/fb|Framebuffer]]
 
−
*[[Documentation:Modules/directfb|Direct framebuffer]] (up to 2.2.8)
 
 
*[[Documentation:Modules/x11|X11]]
 
*[[Documentation:Modules/x11|X11]]
 
*[[Documentation:Modules/xvideo|XVideo]]
 
*[[Documentation:Modules/xvideo|XVideo]]
Line 66: Line 66:
 
*[[Documentation:Modules/direct3d|Direct3D]]
 
*[[Documentation:Modules/direct3d|Direct3D]]
 
*[[Documentation:Modules/directx_vout|DirectX]]
 
*[[Documentation:Modules/directx_vout|DirectX]]
 +
*[[Documentation:Modules/glwin32|OpenGL for windows]]
 
*[[Documentation:Modules/wingdi|Windows GDI]]
 
*[[Documentation:Modules/wingdi|Windows GDI]]
−
*[[Documentation:Modules/glwin32|OpenGL for windows]]
 
  
 
=== Stream Output ===
 
=== Stream Output ===
−
*[[Documentation:Modules/standard|Standard (std)]]
+
*[[Documentation:Modules/autodel|Autodel]]
−
*[[Documentation:Modules/transcode|Transcode]]
+
*[[Documentation:Modules/description|Description]]
 +
*[[Documentation:Modules/display|Display]]
 +
*[[Documentation:Modules/dummy_sout|Dummy]]
 
*[[Documentation:Modules/duplicate|Duplicate]]
 
*[[Documentation:Modules/duplicate|Duplicate]]
−
*[[Documentation:Modules/rtp|RTP]]
 
 
*[[Documentation:Modules/es|Elementary Stream (es)]]
 
*[[Documentation:Modules/es|Elementary Stream (es)]]
−
*[[Documentation:Modules/display|Display]]
 
−
*[[Documentation:Modules/dummy_sout|Dummy]]
 
−
*[[Documentation:Modules/autodel|Autodel]]
 
 
*[[Documentation:Modules/gather|Gather]]
 
*[[Documentation:Modules/gather|Gather]]
−
*[[Documentation:Modules/description|Description]]
+
*[[Documentation:Modules/rtp|RTP]]
 +
*[[Documentation:Modules/standard|Standard (std)]]
 
*[[Documentation:Modules/switcher|Switcher]] (up to 2.0.9)
 
*[[Documentation:Modules/switcher|Switcher]] (up to 2.0.9)
 +
*[[Documentation:Modules/transcode|Transcode]]
 
*[[Documentation:Modules/transrate|Transrate]] (up to 1.1.0)
 
*[[Documentation:Modules/transrate|Transrate]] (up to 1.1.0)
  
 
The following are for use in the mosaic framework only:
 
The following are for use in the mosaic framework only:
 +
*[[Documentation:Modules/bridge-in|Bridge In]]
 
*[[Documentation:Modules/bridge-out|Bridge Out]]
 
*[[Documentation:Modules/bridge-out|Bridge Out]]
−
*[[Documentation:Modules/bridge-in|Bridge In]]
 
 
*[[Documentation:Modules/mosaic-bridge|Mosaic Bridge]]
 
*[[Documentation:Modules/mosaic-bridge|Mosaic Bridge]]
  
Line 116: Line 116:
  
 
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]]
 
*[[Transcode#Canvas_and_Padding|Crop Padd]]
−
*[[Transcode#Canvas_and_Padding|Canvas]]
 
  
 
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/alphamask|Alpha mask]]
 
*[[Documentation:Modules/bluescreen|Blue Screen]]
 
*[[Documentation:Modules/bluescreen|Blue Screen]]
−
*[[Documentation:Modules/alphamask|Alpha mask]]
 
  
 
=== Video Sub-Filters ===
 
=== Video Sub-Filters ===
 +
*[[Documentation:Modules/logo|Logo]]
 
*[[Documentation:Modules/marq|Marq]]
 
*[[Documentation:Modules/marq|Marq]]
 +
*[[Documentation:Modules/mosaic|Mosaic]]
 
*[[Documentation:Modules/rss|RSS]]
 
*[[Documentation:Modules/rss|RSS]]
−
*[[Documentation:Modules/logo|Logo]]
+
*[[Documentation:Modules/subsdelay|Subsdelay]]
−
*[[Documentation:Modules/mosaic|Mosaic]]
 
 
*[[Documentation:Modules/time|Time]] (up to 0.8.6)
 
*[[Documentation:Modules/time|Time]] (up to 0.8.6)
−
*[[Documentation:Modules/subsdelay|Subsdelay]]
 
  
 
=== Video Output Filters ===
 
=== Video Output Filters ===
 +
*[[Documentation:Modules/clone|Clone]]
 +
*[[Documentation:Modules/crop|Crop]]
 
*[[Documentation:Modules/deinterlace|Deinterlace]]
 
*[[Documentation:Modules/deinterlace|Deinterlace]]
−
*[[Documentation:Modules/transform|Transform]]
+
*[[Documentation:Modules/distort|Distort]] (up to 0.8.6)
−
*[[Documentation:Modules/wall|Wall]]
 
−
*[[Documentation:Modules/crop|Crop]]
 
−
*[[Documentation:Modules/panoramix|Panoramix]]
 
−
*[[Documentation:Modules/clone|Clone]]
 
 
*[[Documentation:Modules/logo|Logo]]
 
*[[Documentation:Modules/logo|Logo]]
 
*[[Documentation:Modules/magnify|Magnify]]
 
*[[Documentation:Modules/magnify|Magnify]]
 +
*[[Documentation:Modules/panoramix|Panoramix]]
 
*[[Documentation:Modules/puzzle|Puzzle]]
 
*[[Documentation:Modules/puzzle|Puzzle]]
−
*[[Documentation:Modules/distort|Distort]] (up to 0.8.6)
+
*[[Documentation:Modules/transform|Transform]]
 +
*[[Documentation:Modules/wall|Wall]]
  
 
=== Visualizations ===
 
=== Visualizations ===
−
* [[Documentation:Modules/visual|Visual]]
+
* [[Documentation:Modules/galaktos|Galaktos]] (up to 1.0.6)
 
* [[Documentation:Modules/goom|Goom]]
 
* [[Documentation:Modules/goom|Goom]]
 
* [[Documentation:Modules/projectm|ProjectM]]
 
* [[Documentation:Modules/projectm|ProjectM]]
 +
* [[Documentation:Modules/visual|Visual]]
 
* [[Documentation:Modules/vsxu|Vovoid VSXu]]
 
* [[Documentation:Modules/vsxu|Vovoid VSXu]]
−
* [[Documentation:Modules/galaktos|Galaktos]] (up to 1.0.6)
 
  
 
=== Access Filters ===
 
=== Access Filters ===
 +
*[[Documentation:Modules/bandwidth|Bandwidth]]
 +
*[[Documentation:Modules/dump|Dump]]
 +
*[[Documentation:Modules/record|Record]]
 
*[[Documentation:Modules/timeshift|Timeshift]]
 
*[[Documentation:Modules/timeshift|Timeshift]]
−
*[[Documentation:Modules/record|Record]]
 
−
*[[Documentation:Modules/dump|Dump]]
 
−
*[[Documentation:Modules/bandwidth|Bandwidth]]
 
  
 
== Other ==
 
== Other ==
 
=== Accesses ===
 
=== Accesses ===
−
*[[Documentation:Modules/file|File Input]] - for reading local files
+
*[[Documentation:Modules/cdda|CD Input]]
 
*[[Documentation:Modules/directory|Directory]]
 
*[[Documentation:Modules/directory|Directory]]
 
*[[Documentation:Modules/dvdnav|DVDnav Input]]
 
*[[Documentation:Modules/dvdnav|DVDnav Input]]
 
*[[Documentation:Modules/dvdread|DVDRead Input]] - DVD without menu support
 
*[[Documentation:Modules/dvdread|DVDRead Input]] - DVD without menu support
−
*[[Documentation:Modules/cdda|CD Input]]
+
*[[Documentation:Modules/fake|Fake]] (up to 0.9.0) - presents a static image as a video stream
−
*[[Documentation:Modules/vcd|VCD]]
+
*[[Documentation:Modules/file|File Input]] - for reading local files
 +
*[[Documentation:Modules/ftp|FTP Input]]
 +
*[[Documentation:Modules/h264|H.264 Video]]
 
*[[Documentation:Modules/http|HTTP Input]]
 
*[[Documentation:Modules/http|HTTP Input]]
−
*[[Documentation:Modules/ftp|FTP Input]]
+
*[[Documentation:Modules/mkv|Matroska stream]]
−
*[[Documentation:Modules/udp|UDP Input]]
+
*[[Documentation:Modules/mms|MMS]] - reading from the MicroSoft Media Server
 +
*[[Documentation:Modules/pvr|IVTV MPEG Encoding Card Input]]
 +
*[[Documentation:Modules/rawvid|Raw Video]] - streams of bitmap images
 
*[[Documentation:Modules/rtp|RTP Input]]
 
*[[Documentation:Modules/rtp|RTP Input]]
 
*[[Documentation:Modules/rtsp|RTSP]] -  
 
*[[Documentation:Modules/rtsp|RTSP]] -  
−
*[[Documentation:Modules/mms|MMS]] - reading from the MicroSoft Media Server
 
 
*[[Documentation:Modules/screen|Screen Input]] - grabbing the currently active screen
 
*[[Documentation:Modules/screen|Screen Input]] - grabbing the currently active screen
−
*[[Documentation:Modules/fake|Fake]] (up to 0.9.0) - presents a static image as a video stream
+
*[[Documentation:Modules/udp|UDP Input]]
−
*[[Documentation:Modules/rawvid|Raw Video]] - streams of bitmap images
+
*[[Documentation:Modules/vcd|VCD]]
−
*[[Documentation:Modules/mkv|Matroska stream]]
 
−
*[[Documentation:Modules/h264|H.264 Video]]
 
−
*[[Documentation:Modules/pvr|IVTV MPEG Encoding Card Input]]
 
  
 
Linux specific:
 
Linux specific:
−
*[[Documentation:Modules/rawdv|DV]] (through libdv)
+
*[[Documentation:Modules/dc1394|DC1394]]
 
*[[Documentation:Modules/dvb|DVB Input]]
 
*[[Documentation:Modules/dvb|DVB Input]]
 
*[[Documentation:Modules/pvr|PVR]] (up to 2.0.9)
 
*[[Documentation:Modules/pvr|PVR]] (up to 2.0.9)
 +
*[[Documentation:Modules/rawdv|DV]] (through libdv)
 
*[[Documentation:Modules/v4l|Video4Linux (v4l)]] (up to 1.1.13)
 
*[[Documentation:Modules/v4l|Video4Linux (v4l)]] (up to 1.1.13)
 
*[[Documentation:Modules/v4l2|Video4Linux2 (v4l2)]]
 
*[[Documentation:Modules/v4l2|Video4Linux2 (v4l2)]]
−
*[[Documentation:Modules/dc1394|DC1394]]
 
  
 
Windows specific:
 
Windows specific:
Line 198: Line 198:
 
==== Video ====
 
==== Video ====
 
==== Subtitles ====
 
==== Subtitles ====
 +
* [[Documentation:Modules/kate|kate]]
 
* [[Documentation:Modules/subtitle|subtitle]]
 
* [[Documentation:Modules/subtitle|subtitle]]
−
* [[Documentation:Modules/kate|kate]]
 
  
 
=== Demuxers ===
 
=== Demuxers ===
Line 205: Line 205:
  
 
==== Playlist ====
 
==== Playlist ====
 +
*[[Documentation:Modules/asx-open|ASX]]
 +
*[[Documentation:Modules/b4s-open|b4s]]
 +
*[[Documentation:Modules/dvb-open|dvb]]
 +
*[[Documentation:Modules/qtl|QTL]]
 +
*[[Documentation:Modules/gvi|gvi]]
 
*[[Documentation:Modules/m3u-open|m3u]]
 
*[[Documentation:Modules/m3u-open|m3u]]
 
*[[Documentation:Modules/pls-open|pls]]
 
*[[Documentation:Modules/pls-open|pls]]
−
*[[Documentation:Modules/b4s-open|b4s]]
 
−
*[[Documentation:Modules/dvb-open|dvb]]
 
 
*[[Documentation:Modules/podcast|podcast]]
 
*[[Documentation:Modules/podcast|podcast]]
 +
*[[Documentation:Modules/sgimb|sgimb]]
 +
*[[Documentation:Modules/shout-winamp|Winamp Shoutcast]]
 
*[[Documentation:Modules/xspf-open|XSPF]]
 
*[[Documentation:Modules/xspf-open|XSPF]]
−
*[[Documentation:Modules/shout-winamp|Winamp Shoutcast]]
 
−
*[[Documentation:Modules/asx-open|ASX]]
 
−
*[[Documentation:Modules/sgimb|sgimb]]
 
−
*[[Documentation:Modules/qtl|QTL]]
 
−
*[[Documentation:Modules/gvi|gvi]]
 
  
 
=== Muxers ===
 
=== Muxers ===
 
=== Service Discovery ===
 
=== Service Discovery ===
 +
*[[Documentation:Modules/bonjour|Bonjour]]
 +
*[[Documentation:Modules/daap|DAAP]]
 +
*[[Documentation:Modules/hal|HAL]] (up to 1.1.13)
 
*[[Documentation:Modules/sap|SAP]]
 
*[[Documentation:Modules/sap|SAP]]
 
*[[Documentation:Modules/shout|Shoutcast]]
 
*[[Documentation:Modules/shout|Shoutcast]]
 
*[[Documentation:Modules/podcast_sd|Podcast]]
 
*[[Documentation:Modules/podcast_sd|Podcast]]
−
*[[Documentation:Modules/hal|HAL]] (up to 1.1.13)
+
*[[Documentation:Modules/upnp_cc|UPnP (cyberlink)]]
−
*[[Documentation:Modules/daap|DAAP]]
 
−
*[[Documentation:Modules/bonjour|Bonjour]]
 
 
*[[Documentation:Modules/upnp_intel|UPnP (intel)]]
 
*[[Documentation:Modules/upnp_intel|UPnP (intel)]]
−
*[[Documentation:Modules/upnp_cc|UPnP (cyberlink)]]
 
  
 
=== Misc ===
 
=== Misc ===
 +
*[[Documentation:Modules/motion_control|Motion control]]
 
*[[Documentation:Modules/netsync|Netsync]]
 
*[[Documentation:Modules/netsync|Netsync]]
−
*[[Documentation:Modules/motion_control|Motion control]]
 
 
*[[VLC_Wikitube|Wikitube]]
 
*[[VLC_Wikitube|Wikitube]]
  
 
[[Category:Modules|*]]
 
[[Category:Modules|*]]
 
{{Documentation}}
 
{{Documentation}}

Revision as of 00:16, 4 March 2019

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 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

Other

Outputs

Audio Output

Android specific:

Linux specific:

Windows specific:

Video Output

Linux specific:

Windows specific:

Stream Output

The following are for use in the mosaic framework only:

Filters

Audio Filters

Video Filters

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

Visualizations

Access Filters

Other

Accesses

Linux specific:

Windows specific:

macOS specific:

  • EyeTV - reads DVB streams from the proprietary EyeTV.app; requires a plugin
  • QTKit - reads uncompressed video from internal iSights

Access Outputs

Codecs

Audio

Video

Subtitles

Demuxers

Playlist

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
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.
Retrieved from "https://wiki.videolan.org/index.php?title=Documentation:Modules&oldid=58898"