Difference between revisions of "Documentation:Modules"

From VideoLAN Wiki
Jump to navigation Jump to search
(Dummy edit: I mean to say, modules that are so simple that dedicated pages would not be necessary -- not that the modules (or writers) are less important)
(→‎Service Discovery: Remove redlink Documentation:Modules/shout-winamp. There is information about this sub-module at Documentation:Modules/shout#shout-winamp)
 
(23 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
<!-- Dummy edit -->
 
 
<div style="float: right; margin-left: 1em;">__TOC__</div>
 
<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 {{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.
Line 73: Line 72:
  
 
=== Stream Output ===
 
=== Stream Output ===
 +
<div class="col3">
 
* [[Documentation:Modules/autodel|Autodel]]
 
* [[Documentation:Modules/autodel|Autodel]]
 
* [[Documentation:Modules/delay|Delay]]
 
* [[Documentation:Modules/delay|Delay]]
Line 86: Line 86:
 
* [[Documentation:Modules/transcode|Transcode]]
 
* [[Documentation:Modules/transcode|Transcode]]
 
* [[Documentation:Modules/transrate|Transrate]] (up to 1.0.2)
 
* [[Documentation:Modules/transrate|Transrate]] (up to 1.0.2)
 +
</div>
  
 
The following are for use in the mosaic framework only:
 
The following are for use in the mosaic framework only:
 +
<div class="col3">
 
* [[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]]
 +
</div>
  
 
== Filters ==
 
== Filters ==
 
=== Audio Filters ===
 
=== Audio Filters ===
 
=== Video Filters ===
 
=== Video Filters ===
 +
<div class="col3">
 
* [[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/distort|Distort]] (up to 0.8.6 - split into various)
 
* [[Documentation:Modules/erase|Logo Erase]]
 
* [[Documentation:Modules/erase|Logo Erase]]
 
* [[Documentation:Modules/extract|Extract]]
 
* [[Documentation:Modules/extract|Extract]]
Line 118: Line 123:
 
* [[Documentation:Modules/VHS|VHS]]
 
* [[Documentation:Modules/VHS|VHS]]
 
* [[Documentation:Modules/wave|Wave]]
 
* [[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:
Line 133: Line 139:
 
* [[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 - merged with marq)
  
 
=== Video Output Filters ===
 
=== Video Output Filters ===
 
* [[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/logo|Logo]]
 
* [[Documentation:Modules/logo|Logo]]
 
* [[Documentation:Modules/magnify|Magnify]]
 
* [[Documentation:Modules/magnify|Magnify]]
Line 160: Line 165:
 
* [[Documentation:Modules/dump|Dump]]
 
* [[Documentation:Modules/dump|Dump]]
 
* [[Documentation:Modules/record|Record]]
 
* [[Documentation:Modules/record|Record]]
−
* [[Documentation:Modules/timeshift|Timeshift]]
+
* [[Documentation:Modules/timeshift|Timeshift]] (up to 0.9.9 - moved to core)
  
 
== Other ==
 
== Other ==
 
=== Accesses ===
 
=== Accesses ===
 +
<div class="col3">
 
* [[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]] - DVD with menus
−
* [[Documentation:Modules/dvdread|DVDRead Input]] - DVD without menu support
+
* [[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/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/h26x|H.264 Video]]
 
* [[Documentation:Modules/http|HTTP Input]]
 
* [[Documentation:Modules/http|HTTP Input]]
 
* {{docmod|jpeg}}
 
* {{docmod|jpeg}}
 
* {{docmod|mjpeg}}
 
* {{docmod|mjpeg}}
 
* [[Documentation:Modules/mkv|Matroska stream]]
 
* [[Documentation:Modules/mkv|Matroska stream]]
−
* [[Documentation:Modules/mms|MMS]] - reading from the MicroSoft Media Server
+
* [[Documentation:Modules/mms|MMS]] - for reading from the MicroSoft Media Server
 
* [[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
+
* {{docmod|sdp}}
 +
* [[Documentation:Modules/screen|Screen Input]] - screen feed
 
* [[Documentation:Modules/udp|UDP Input]]
 
* [[Documentation:Modules/udp|UDP Input]]
 
* [[Documentation:Modules/vcd|VCD]]
 
* [[Documentation:Modules/vcd|VCD]]
 +
</div>
  
 
Linux specific:
 
Linux specific:
Line 198: Line 206:
 
macOS specific:
 
macOS specific:
 
* [[Documentation:Modules/eyetv|EyeTV]] (up to 2.2.8) - reads DVB streams from the proprietary EyeTV.app; requires a plugin
 
* [[Documentation:Modules/eyetv|EyeTV]] (up to 2.2.8) - reads DVB streams from the proprietary EyeTV.app; requires a plugin
−
* [[Documentation:Modules/qtkit|QTKit]] - reads uncompressed video from internal iSights
+
* [[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 ====
 
==== 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/kate|kate]]
Line 213: Line 237:
  
 
==== Playlist ====
 
==== Playlist ====
−
* {{docmod|playlist}}
+
* {{docmod|playlist}} (formats are read with sub-modules)
−
* [[Documentation:Modules/qtl|QTL]]
 
−
* [[Documentation:Modules/gvi|gvi]]
 
−
* [[Documentation:Modules/podcast|podcast]]
 
−
* [[Documentation:Modules/sgimb|sgimb]]
 
−
* [[Documentation:Modules/shout-winamp|Winamp Shoutcast]]
 
  
 
=== 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/bonjour|Bonjour]]
Line 227: Line 257:
 
* [[Documentation:Modules/sap|SAP]]
 
* [[Documentation:Modules/sap|SAP]]
 
* [[Documentation:Modules/shout|Shoutcast]]
 
* [[Documentation:Modules/shout|Shoutcast]]
−
* [[Documentation:Modules/podcast_sd|Podcast]]
+
* [[Documentation:Modules/podcast|podcast]]
−
* [[Documentation:Modules/upnp_cc|UPnP (cyberlink)]]
+
* [[Documentation:Modules/upnp|UPnP]]
−
* [[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]]
 
  
 
[[Category:Modules|*]]
 
[[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"