Difference between revisions of "Documentation:Modules"

From VideoLAN Wiki
Jump to navigation Jump to search
m (abc)
m (nn)
Line 11: Line 11:
  
 
=== Graphical ===
 
=== Graphical ===
*[[Documentation:Modules/macos|macOS]]
+
* [[Documentation:Modules/macos|macOS]]
*[[Documentation:Modules/Qt4|Qt4]]
+
* [[Documentation:Modules/Qt4|Qt4]]
*[[Documentation:Modules/skins2|Skins2]]
+
* [[Documentation:Modules/skins2|Skins2]]
*[[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-->
 
<!--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]]
  
 
=== 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/osc|osc]]
*[[Documentation:Modules/wiimote|Wiimote]]
+
* [[Documentation:Modules/wiimote|Wiimote]]
  
 
== Outputs ==
 
== Outputs ==
 
=== Audio Output ===
 
=== Audio Output ===
*[[Documentation:Modules/auhal|AUHAL]]
+
* [[Documentation:Modules/auhal|AUHAL]]
*[[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/pulse|pulse]]
*[[Documentation:Modules/sdl_aout|SDL]] (up to 1.1.13)
+
* [[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/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]]
*[[Documentation:Modules/oss|OSS]]
+
* [[Documentation:Modules/oss|OSS]]
 
Windows specific:
 
Windows specific:
*[[Documentation:Modules/directx_aout|DirectX]]
+
* [[Documentation:Modules/directx_aout|DirectX]]
*[[Documentation:Modules/mmdevice|WASAPI]]
+
* [[Documentation:Modules/mmdevice|WASAPI]]
*[[Documentation:Modules/waveout|waveout]]
+
* [[Documentation:Modules/waveout|waveout]]
  
 
=== Video Output ===
 
=== Video Output ===
*[[Documentation:Modules/aa|ASCII Art]]
+
* [[Documentation:Modules/aa|ASCII Art]]
*[[Documentation:Modules/caca|Colored ASCII Art]]
+
* [[Documentation:Modules/caca|Colored ASCII Art]]
*[[Documentation:Modules/image|Image]] (up to 0.9.10)
+
* [[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)
 
Linux specific:
 
Linux specific:
*[[Documentation:Modules/directfb|Direct framebuffer]] (up to 2.2.8)
+
* [[Documentation:Modules/directfb|Direct framebuffer]] (up to 2.2.8)
*[[Documentation:Modules/fb|Framebuffer]]
+
* [[Documentation:Modules/fb|Framebuffer]]
*[[Documentation:Modules/glx|OpenGL (GLX)]]
+
* [[Documentation:Modules/glx|OpenGL (GLX)]]
*[[Documentation:Modules/x11|X11]]
+
* [[Documentation:Modules/x11|X11]]
*[[Documentation:Modules/xvideo|XVideo]]
+
* [[Documentation:Modules/xvideo|XVideo]]
 
Windows specific:
 
Windows specific:
*[[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/glwin32|OpenGL for windows]]
*[[Documentation:Modules/wingdi|Windows GDI]]
+
* [[Documentation:Modules/wingdi|Windows GDI]]
  
 
=== Stream Output ===
 
=== Stream Output ===
*[[Documentation:Modules/autodel|Autodel]]
+
* [[Documentation:Modules/autodel|Autodel]]
*[[Documentation:Modules/description|Description]]
+
* [[Documentation:Modules/description|Description]]
*[[Documentation:Modules/display|Display]]
+
* [[Documentation:Modules/display|Display]]
*[[Documentation:Modules/dummy_sout|Dummy]]
+
* [[Documentation:Modules/dummy_sout|Dummy]]
*[[Documentation:Modules/duplicate|Duplicate]]
+
* [[Documentation:Modules/duplicate|Duplicate]]
*[[Documentation:Modules/es|Elementary Stream (es)]]
+
* [[Documentation:Modules/es|Elementary Stream (es)]]
*[[Documentation:Modules/gather|Gather]]
+
* [[Documentation:Modules/gather|Gather]]
*[[Documentation:Modules/rtp|RTP]]
+
* [[Documentation:Modules/rtp|RTP]]
*[[Documentation:Modules/standard|Standard (std)]]
+
* [[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/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-in|Bridge In]]
*[[Documentation:Modules/bridge-out|Bridge Out]]
+
* [[Documentation:Modules/bridge-out|Bridge Out]]
*[[Documentation:Modules/mosaic-bridge|Mosaic Bridge]]
+
* [[Documentation:Modules/mosaic-bridge|Mosaic Bridge]]
  
 
== Filters ==
 
== Filters ==
 
=== Audio Filters ===
 
=== Audio Filters ===
 
=== Video Filters ===
 
=== Video Filters ===
*[[Documentation:Modules/adjust|Adjust]]
+
* [[Documentation:Modules/adjust|Adjust]]
*[[Documentation:Modules/anaglyph|Anaglyph 3D]]
+
* [[Documentation:Modules/anaglyph|Anaglyph 3D]]
*[[Documentation:Modules/atmo|AtmoLight]] (up to 3.0.0)
+
* [[Documentation:Modules/atmo|AtmoLight]] (up to 3.0.0)
*[[Documentation:Modules/colorthres|Color Threshold]]
+
* [[Documentation:Modules/colorthres|Color Threshold]]
*[[Documentation:Modules/erase|Logo Erase]]
+
* [[Documentation:Modules/erase|Logo Erase]]
*[[Documentation:Modules/extract|Extract]]
+
* [[Documentation:Modules/extract|Extract]]
*[[Documentation:Modules/freeze|Freeze]]
+
* [[Documentation:Modules/freeze|Freeze]]
*[[Documentation:Modules/gaussianblur|Gaussian Blur]]
+
* [[Documentation:Modules/gaussianblur|Gaussian Blur]]
*[[Documentation:Modules/gradfun|Gradfun]]
+
* [[Documentation:Modules/gradfun|Gradfun]]
*[[Documentation:Modules/gradient|Gradient]]
+
* [[Documentation:Modules/gradient|Gradient]]
*[[Documentation:Modules/invert|Invert]]
+
* [[Documentation:Modules/invert|Invert]]
*[[Documentation:Modules/motionblur|Motion Blur]]
+
* [[Documentation:Modules/motionblur|Motion Blur]]
*[[Documentation:Modules/noise|Noise]] (up to 1.1.13)
+
* [[Documentation:Modules/noise|Noise]] (up to 1.1.13)
*[[Documentation:Modules/oldmovie|Oldmovie]]
+
* [[Documentation:Modules/oldmovie|Oldmovie]]
*[[Documentation:Modules/posterize|Posterize]]
+
* [[Documentation:Modules/posterize|Posterize]]
*[[Documentation:Modules/psychedelic|Psychedelic]]
+
* [[Documentation:Modules/psychedelic|Psychedelic]]
*[[Documentation:Modules/ripple|Ripple]]
+
* [[Documentation:Modules/ripple|Ripple]]
*[[Documentation:Modules/rotate|Rotate]]
+
* [[Documentation:Modules/rotate|Rotate]]
*[[Documentation:Modules/scene|Scene]]
+
* [[Documentation:Modules/scene|Scene]]
*[[Documentation:Modules/sepia|Sepia]]
+
* [[Documentation:Modules/sepia|Sepia]]
*[[Documentation:Modules/sharpen|Sharpen]]
+
* [[Documentation:Modules/sharpen|Sharpen]]
*[[Documentation:Modules/VHS|VHS]]
+
* [[Documentation:Modules/VHS|VHS]]
*[[Documentation:Modules/wave|Wave]]
+
* [[Documentation:Modules/wave|Wave]]
  
 
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|Canvas]]
*[[Transcode#Canvas_and_Padding|Crop Padd]]
+
* [[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/alphamask|Alpha mask]]
+
* [[Documentation:Modules/alphamask|Alpha mask]]
*[[Documentation:Modules/bluescreen|Blue Screen]]
+
* [[Documentation:Modules/bluescreen|Blue Screen]]
  
 
=== Video Sub-Filters ===
 
=== Video Sub-Filters ===
*[[Documentation:Modules/logo|Logo]]
+
* [[Documentation:Modules/logo|Logo]]
*[[Documentation:Modules/marq|Marq]]
+
* [[Documentation:Modules/marq|Marq]]
*[[Documentation:Modules/mosaic|Mosaic]]
+
* [[Documentation:Modules/mosaic|Mosaic]]
*[[Documentation:Modules/rss|RSS]]
+
* [[Documentation:Modules/rss|RSS]]
*[[Documentation:Modules/subsdelay|Subsdelay]]
+
* [[Documentation:Modules/subsdelay|Subsdelay]]
*[[Documentation:Modules/time|Time]] (up to 0.8.6)
+
* [[Documentation:Modules/time|Time]] (up to 0.8.6)
  
 
=== Video Output Filters ===
 
=== Video Output Filters ===
*[[Documentation:Modules/clone|Clone]]
+
* [[Documentation:Modules/clone|Clone]]
*[[Documentation:Modules/crop|Crop]]
+
* [[Documentation:Modules/crop|Crop]]
*[[Documentation:Modules/deinterlace|Deinterlace]]
+
* [[Documentation:Modules/deinterlace|Deinterlace]]
*[[Documentation:Modules/distort|Distort]] (up to 0.8.6)
+
* [[Documentation:Modules/distort|Distort]] (up to 0.8.6)
*[[Documentation:Modules/logo|Logo]]
+
* [[Documentation:Modules/logo|Logo]]
*[[Documentation:Modules/magnify|Magnify]]
+
* [[Documentation:Modules/magnify|Magnify]]
*[[Documentation:Modules/panoramix|Panoramix]]
+
* [[Documentation:Modules/panoramix|Panoramix]]
*[[Documentation:Modules/puzzle|Puzzle]]
+
* [[Documentation:Modules/puzzle|Puzzle]]
*[[Documentation:Modules/transform|Transform]]
+
* [[Documentation:Modules/transform|Transform]]
*[[Documentation:Modules/wall|Wall]]
+
* [[Documentation:Modules/wall|Wall]]
  
 
=== Visualizations ===
 
=== Visualizations ===
Line 151: Line 151:
  
 
=== Access Filters ===
 
=== Access Filters ===
*[[Documentation:Modules/bandwidth|Bandwidth]]
+
* [[Documentation:Modules/bandwidth|Bandwidth]]
*[[Documentation:Modules/dump|Dump]]
+
* [[Documentation:Modules/dump|Dump]]
*[[Documentation:Modules/record|Record]]
+
* [[Documentation:Modules/record|Record]]
*[[Documentation:Modules/timeshift|Timeshift]]
+
* [[Documentation:Modules/timeshift|Timeshift]]
  
 
== Other ==
 
== Other ==
 
=== Accesses ===
 
=== Accesses ===
*[[Documentation:Modules/cdda|CD Input]]
+
* [[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/fake|Fake]] (up to 0.9.0) - presents a static image as a video stream
+
* [[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/file|File Input]] - for reading local files
*[[Documentation:Modules/ftp|FTP Input]]
+
* [[Documentation:Modules/ftp|FTP Input]]
*[[Documentation:Modules/h264|H.264 Video]]
+
* [[Documentation:Modules/h264|H.264 Video]]
*[[Documentation:Modules/http|HTTP Input]]
+
* [[Documentation:Modules/http|HTTP Input]]
*[[Documentation:Modules/mkv|Matroska stream]]
+
* [[Documentation:Modules/mkv|Matroska stream]]
*[[Documentation:Modules/mms|MMS]] - reading from the MicroSoft Media Server
+
* [[Documentation:Modules/mms|MMS]] - reading from the MicroSoft Media Server
*[[Documentation:Modules/pvr|IVTV MPEG Encoding Card Input]]
+
* [[Documentation:Modules/pvr|IVTV MPEG Encoding Card Input]]
*[[Documentation:Modules/rawvid|Raw Video]] - streams of bitmap images
+
* [[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/screen|Screen Input]] - grabbing the currently active screen
+
* [[Documentation:Modules/screen|Screen Input]] - grabbing the currently active screen
*[[Documentation:Modules/udp|UDP Input]]
+
* [[Documentation:Modules/udp|UDP Input]]
*[[Documentation:Modules/vcd|VCD]]
+
* [[Documentation:Modules/vcd|VCD]]
  
 
Linux specific:
 
Linux specific:
*[[Documentation:Modules/dc1394|DC1394]]
+
* [[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/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)]]
  
 
Windows specific:
 
Windows specific:
*[[Documentation:Modules/bda|BDA]]
+
* [[Documentation:Modules/bda|BDA]]
*[[Documentation:Modules/dshow|DirectShow]]
+
* [[Documentation:Modules/dshow|DirectShow]]
  
 
macOS specific:
 
macOS specific:
*[[Documentation:Modules/eyetv|EyeTV]] - reads DVB streams from the proprietary EyeTV.app; requires a plugin
+
* [[Documentation:Modules/eyetv|EyeTV]] - reads DVB streams from the proprietary EyeTV.app; requires a plugin
*[[Documentation:Modules/qtkit|QTKit]] - reads uncompressed video from internal iSights
+
* [[Documentation:Modules/qtkit|QTKit]] - reads uncompressed video from internal iSights
  
 
=== Access Outputs ===
 
=== Access Outputs ===
Line 202: Line 202:
  
 
=== Demuxers ===
 
=== Demuxers ===
*[[Documentation:Modules/avcodec|avcodec]] ("FFmpeg")
+
* [[Documentation:Modules/avcodec|avcodec]] ("FFmpeg")
  
 
==== Playlist ====
 
==== Playlist ====
*[[Documentation:Modules/asx-open|ASX]]
+
* [[Documentation:Modules/asx-open|ASX]]
*[[Documentation:Modules/b4s-open|b4s]]
+
* [[Documentation:Modules/b4s-open|b4s]]
*[[Documentation:Modules/dvb-open|dvb]]
+
* [[Documentation:Modules/dvb-open|dvb]]
*[[Documentation:Modules/qtl|QTL]]
+
* [[Documentation:Modules/qtl|QTL]]
*[[Documentation:Modules/gvi|gvi]]
+
* [[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/podcast|podcast]]
+
* [[Documentation:Modules/podcast|podcast]]
*[[Documentation:Modules/sgimb|sgimb]]
+
* [[Documentation:Modules/sgimb|sgimb]]
*[[Documentation:Modules/shout-winamp|Winamp Shoutcast]]
+
* [[Documentation:Modules/shout-winamp|Winamp Shoutcast]]
*[[Documentation:Modules/xspf-open|XSPF]]
+
* [[Documentation:Modules/xspf-open|XSPF]]
  
 
=== Muxers ===
 
=== Muxers ===
 
=== Service Discovery ===
 
=== Service Discovery ===
*[[Documentation:Modules/bonjour|Bonjour]]
+
* [[Documentation:Modules/bonjour|Bonjour]]
*[[Documentation:Modules/daap|DAAP]]
+
* [[Documentation:Modules/daap|DAAP]]
*[[Documentation:Modules/hal|HAL]] (up to 1.1.13)
+
* [[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/upnp_cc|UPnP (cyberlink)]]
+
* [[Documentation:Modules/upnp_cc|UPnP (cyberlink)]]
*[[Documentation:Modules/upnp_intel|UPnP (intel)]]
+
* [[Documentation:Modules/upnp_intel|UPnP (intel)]]
  
 
=== Misc ===
 
=== Misc ===
*[[Documentation:Modules/motion_control|Motion control]]
+
* [[Documentation:Modules/motion_control|Motion control]]
*[[Documentation:Modules/netsync|Netsync]]
+
* [[Documentation:Modules/netsync|Netsync]]
*[[VLC_Wikitube|Wikitube]]
+
* [[VLC_Wikitube|Wikitube]]
  
 
[[Category:Modules|*]]
 
[[Category:Modules|*]]
 
{{Documentation}}
 
{{Documentation}}

Revision as of 00:19, 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 GuideStreaming HowToHacker GuideModules)
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.