Difference between revisions of "Documentation:Modules"

From VideoLAN Wiki
Jump to navigation Jump to search
(→‎Service Discovery: Remove redlink Documentation:Modules/shout-winamp. There is information about this sub-module at Documentation:Modules/shout#shout-winamp)
 
(124 intermediate revisions by 14 users not shown)
Line 1: Line 1:
−
__NOTOC__
+
<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. This is only an index.
+
To list all the available modules in your VLC build, use:
 +
{{%}} '''vlc --list'''
  
−
Please see other [[Documentation:Documentation|documentation]] for information concerning these module's use.
+
To list a module's configuration options, use:
 +
% '''vlc -p <modulename> --advanced --help-verbose'''
  
 
== Interfaces ==
 
== Interfaces ==
  
 
=== Graphical ===
 
=== Graphical ===
−
 
+
* [[Documentation:Modules/macos|macOS]]
−
*[[Documentation:Modules/wxWidgets|wxWidgets]]
+
* [[Documentation:Modules/Qt4|Qt4]]
−
*[[Documentation:Modules/skins2|Skins2]]
+
* [[Documentation:Modules/skins2|Skins2]]
−
*[[Documentation:Modules/Qt4|Qt4]]
+
* [[Documentation:Modules/wxWidgets|wxWidgets]] (up to 0.9)
−
*[[Documentation:Modules/macosx_gui|Mac OS X]]
 
−
*[[Documentation:Modules/beos_gui|BeOS]]
 
  
 
=== 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/rc|remote control (rc)]]
+
* [[Documentation:Modules/lua|lua]]
−
*[[Documentation:Modules/telnet|telnet]]
 
−
*[[Documentation:Modules/ncurses|ncurses]]
 
  
 
=== Other ===
 
=== Other ===
−
 
+
* [[Documentation:Modules/http_intf|HTTP]]
−
*[[Documentation:Modules/http_inft|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/directx_aout|DirectX]]
+
* [[Documentation:Modules/portaudio|portaudio]] (up to 2.0)
−
*[[Documentation:Modules/waveout|waveout]]
+
* [[Documentation:Modules/sdl_aout|SDL]] (up to 1.1.13)
−
*[[Documentation:Modules/portaudio|portaudio]]
+
Android specific:
−
*[[Documentation:Modules/sdl_aout|SDL]]
+
* [[Documentation:Modules/opensles|OpenSL ES]]
−
 
+
Linux specific:
−
 
+
* [[Documentation:Modules/alsa|Alsa]]
−
*[[Documentation:Modules/auhal|AUHAL]]
+
* [[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/alsa|Alsa]]
+
* [[Documentation:Modules/oss|OSS]]
−
*[[Documentation:Modules/oss|OSS]]
+
macOS specific:
−
*[[Documentation:Modules/arts|aRts]]
+
* {{docmod|audioqueue}} (up to 2.2.8)
−
*[[Documentation:Modules/esd|esound]]
+
* {{docmod|auhal}} (HAL AudioUnit)
−
 
+
Windows specific:
−
 
+
* [[Documentation:Modules/directx_aout|DirectX]]
−
*[[Documentation:Modules/file_aout|file]]
+
* [[Documentation:Modules/mmdevice|WASAPI]]
 +
* [[Documentation:Modules/waveout|waveout]]
  
 
=== Video Output ===
 
=== Video Output ===
−
*[[Documentation:Modules/direct3d|Direct3D]]
+
* [[Documentation:Modules/aa|ASCII Art]]
−
*[[Documentation:Modules/directx_vout|DirectX]]
+
* [[Documentation:Modules/caca|Colored ASCII Art]]
−
*[[Documentation:Modules/wingdi|Windows GDI]]
+
* [[Documentation:Modules/image|Image]] (up to 0.9.10)
−
*[[Documentation:Modules/glwin32|OpenGL for windows]]
+
* [[Documentation:Modules/opengl|OpenGL]]
−
 
+
* [[Documentation:Modules/sdl_vout|SDL]] (up to 2.2.8)
−
 
+
Linux specific:
−
*[[Documentation:Modules/opengl|OpenGL]]
+
* [[Documentation:Modules/directfb|Direct framebuffer]] (up to 2.2.8)
−
 
+
* [[Documentation:Modules/fb|Framebuffer]]
−
 
+
* [[Documentation:Modules/glx|OpenGL (GLX)]]
−
*[[Documentation:Modules/xvideo|XVideo]]
+
* [[Documentation:Modules/x11|X11]]
−
*[[Documentation:Modules/x11|X11]]
+
* [[Documentation:Modules/xvideo|XVideo]]
−
*[[Documentation:Modules/glx|OpenGL (GLX)]]
+
Windows specific:
−
*[[Documentation:Modules/fb|Framebuffer]]
+
* [[Documentation:Modules/direct3d|Direct3D]]
−
*[[Documentation:Modules/directfb|Direct framebuffer]]
+
* [[Documentation:Modules/directx_vout|DirectX]]
−
 
+
* [[Documentation:Modules/glwin32|OpenGL for windows]]
−
 
+
* [[Documentation:Modules/wingdi|Windows GDI]]
−
*[[Documentation:Modules/sdl_vout|SDL]]
 
−
*[[Documentation:Modules/caca|Colored ASCII Art]]
 
−
*[[Documentation:Modules/aa|ASCII Art]]
 
−
*[[Documentation:Modules/image|Image]]
 
  
 
=== 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>
  
−
*[[Documentation:Modules/standard|standard (std)]]
+
The following are for use in the mosaic framework only:
−
*[[Documentation:Modules/transcode|transcode]]
+
<div class="col3">
−
*[[Documentation:Modules/duplicate|duplicate]]
+
* [[Documentation:Modules/bridge-in|Bridge In]]
−
*[[Documentation:Modules/rtp|RTP]]
+
* [[Documentation:Modules/bridge-out|Bridge Out]]
−
*[[Documentation:Modules/es|elementary stream (es)]]
+
* [[Documentation:Modules/mosaic-bridge|Mosaic Bridge]]
−
*[[Documentation:Modules/display|display]]
+
</div>
−
*[[Documentation:Modules/dummy_sout|dummy]]
 
−
 
 
−
 
 
−
*[[Documentation:Modules/bridge_out|Bridge Out]]
 
−
*[[Documentation:Modules/bridge_in|Bridge In]]
 
−
*[[Documentation:Modules/mosaic_bridge|Mosaic Bridge]]
 
−
 
 
−
 
 
−
*[[Documentation:Modules/autodel|autodel]]
 
−
*[[Documentation:Modules/gather|gather]]
 
−
*[[Documentation:Modules/description|description]]
 
−
*[[Documentation:Modules/switcher|switcher]]
 
  
 
== Filters ==
 
== Filters ==
−
 
 
=== Audio Filters ===
 
=== Audio Filters ===
 +
=== Video Filters ===
 +
<div class="col3">
 +
* [[Documentation:Modules/adjust|Adjust]]
 +
* [[Documentation:Modules/anaglyph|Anaglyph 3D]]
 +
* [[Documentation:Modules/atmo|AtmoLight]] (up to 3.0.0)
 +
* [[Documentation:Modules/colorthres|Color Threshold]]
 +
* [[Documentation:Modules/distort|Distort]] (up to 0.8.6 - split into various)
 +
* [[Documentation:Modules/erase|Logo Erase]]
 +
* [[Documentation:Modules/extract|Extract]]
 +
* [[Documentation:Modules/freeze|Freeze]]
 +
* [[Documentation:Modules/gaussianblur|Gaussian Blur]]
 +
* [[Documentation:Modules/gradfun|Gradfun]]
 +
* [[Documentation:Modules/gradient|Gradient]]
 +
* [[Documentation:Modules/invert|Invert]]
 +
* [[Documentation:Modules/motionblur|Motion Blur]]
 +
* [[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>
  
−
=== Video Filters ===
+
The following video filters are for use in transcode only:
 +
* [[Transcode#Canvas_and_Padding|Canvas]]
 +
* [[Transcode#Canvas_and_Padding|Crop Padd]]
  
−
*[[Documentation:Modules/adjust|Adjust]]
+
The following video filters are for use in the mosaic framework only:
−
*[[Documentation:Modules/gradient|Gradient]]
+
* [[Documentation:Modules/alphamask|Alpha mask]]
−
*[[Documentation:Modules/invert|Invert]]
+
* [[Documentation:Modules/bluescreen|Blue Screen]]
−
*[[Documentation:Modules/wave|Wave]]
 
−
*[[Documentation:Modules/ripple|Ripple]]
 
−
*[[Documentation:Modules/blur|Blur]]
 
−
*[[Documentation:Modules/psychedelic|Psychedelic]]
 
−
*[[Documentation:Modules/noise|Noise]]
 
−
*[[Documentation:Modules/colorthres|Color Threshold]]
 
−
*[[Documentation:Modules/rotate|Rotate]]
 
  
 
=== 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 - 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]]
  
−
*[[Documentation:Modules/deinterlace|Deinterlace]]
+
==== Video Splitters ====
−
*[[Documentation:Modules/transform|Transform]]
+
* [[Documentation:Modules/clone|Clone]]
−
*[[Documentation:Modules/wall|Wall]]
+
* [[Documentation:Modules/panoramix|Panoramix]]
−
*[[Documentation:Modules/crop|Crop]]
+
* [[Documentation:Modules/wall|Wall]]
−
*[[Documentation:Modules/panoramix|Panoramix]]
 
−
*[[Documentation:Modules/clone|Clone]]
 
−
*[[Documentation:Modules/logo|Logo]]
 
−
*[[Documentation:Modules/magnify|Magnify]]
 
−
*[[Documentation:Modules/puzzle|Puzzle]]
 
−
*[[Documentation:Modules/distort|Distort]] (up to 0.8.6)
 
  
 
=== Visualizations ===
 
=== Visualizations ===
−
 
+
* [[Documentation:Modules/galaktos|Galaktos]] (up to 1.0.6)
−
*[[Documentation:Modules/visualizer|Visualizer]]
+
* [[Documentation:Modules/goom|Goom]]
−
*[[Documentation:Modules/goom|Goom]]
+
* [[Documentation:Modules/projectm|ProjectM]]
−
*[[Documentation:Modules/galaktos|Galaktos]]
+
* [[Documentation:Modules/visual|Visual]]
 +
* [[Documentation:Modules/vsxu|Vovoid VSXu]]
  
 
=== Access Filters ===
 
=== Access Filters ===
−
*[[Documentation:Modules/timeshift|timeshift]]
+
* [[Documentation:Modules/bandwidth|Bandwidth]]
−
*[[Documentation:Modules/record|record]]
+
* [[Documentation:Modules/dump|Dump]]
−
*[[Documentation:Modules/dump|dump]]
+
* [[Documentation:Modules/record|Record]]
 +
* [[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>
  
−
=== Accesses ===
+
Linux specific:
 +
* [[Documentation:Modules/dc1394|DC1394]]
 +
* [[Documentation:Modules/dvb|DVB Input]]
 +
* [[Documentation:Modules/pvr|PVR]] (IVTV MPEG Encoding Card Input) (up to 2.0.9)
 +
* [[Documentation:Modules/rawdv|DV]] (through libdv)
 +
* [[Documentation:Modules/v4l|Video4Linux (v4l)]] (up to 1.1.13)
 +
* [[Documentation:Modules/v4l2|Video4Linux2 (v4l2)]]
 +
 
 +
Windows specific:
 +
* [[Documentation:Modules/bda|BDA]]
 +
* [[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}}
  
−
==== Audio ====
 
 
==== 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 ====
−
*[[Documentation:Modules/m3u-open|m3u]]
+
* {{docmod|playlist}} (formats are read with sub-modules)
−
*[[Documentation:Modules/pls-open|pls]]
 
−
*[[Documentation:Modules/b4s-open|b4s]]
 
−
*[[Documentation:Modules/dvb-open|dvb]]
 
−
*[[Documentation:Modules/podcast|podcast]]
 
−
*[[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 ===
 +
* {{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/sap|SAP]]
+
* [[Documentation:Modules/daap|DAAP]]
−
*[[Documentation:Modules/shout|Shoutcast]]
+
* [[Documentation:Modules/hal|HAL]] (up to 1.1.13)
−
*[[Documentation:Modules/podcast_sd|Podcast]]
+
* [[Documentation:Modules/sap|SAP]]
−
*[[Documentation:Modules/hal|HAL]]
+
* [[Documentation:Modules/shout|Shoutcast]]
−
*[[Documentation:Modules/daap|DAAP]]
+
* [[Documentation:Modules/podcast|podcast]]
−
*[[Documentation:Modules/bonjour|Bonjour]]
+
* [[Documentation:Modules/upnp|UPnP]]
−
*[[Documentation:Modules/upnp_intel|UPnP (intel)]]
 
−
*[[Documentation:Modules/upnp_cc|UPnP (cyberlink)]]
 
  
 
=== Misc ===
 
=== Misc ===
−
*[[Documentation:Modules/netsync|netsync]]
+
* [[Documentation:Modules/motion_control|Motion control]]
−
*[[Documentation:Modules/motion_control|motion control]]
+
* [[Documentation:Modules/netsync|Netsync]]
  
 +
[[Category:Modules|*]]
 
{{Documentation}}
 
{{Documentation}}

Latest revision as of 08:36, 28 May 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:

macOS 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

Video Splitters

Visualizations

Access Filters

Other

Accesses

Linux specific:

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

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
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=61619"