Documentation:Modules

2011-06-03T17:59:11Z

YuvalT: /* Video Sub-Filters */

__NOTOC__

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:
% '''vlc --list'''

To list a module's configuration options, use:
% '''vlc -p <modulename> --advanced --help-verbose'''

== Interfaces ==

=== Graphical ===

*[[Documentation:Modules/wxWidgets|wxWidgets]]
*[[Documentation:Modules/skins2|Skins2]]
*[[Documentation:Modules/Qt4|Qt4]]
*[[Documentation:Modules/macosx_gui|Mac OS X]]

=== Text ===

*[[Documentation:Modules/rc|remote control (rc)]]
*[[Documentation:Modules/telnet|telnet]]
*[[Documentation:Modules/ncurses|ncurses]]

=== Other ===

*[[Documentation:Modules/http_intf|HTTP]]
*[[Documentation:Modules/hotkeys|Hotkeys]]
*[[Documentation:Modules/lirc|lirc]]
*[[Documentation:Modules/osc|osc]]
*[[Documentation:Modules/wiimote|Wiimote]]

== Outputs ==

=== Audio Output ===

*[[Documentation:Modules/directx_aout|DirectX]]
*[[Documentation:Modules/waveout|waveout]]
*[[Documentation:Modules/portaudio|portaudio]]
*[[Documentation:Modules/sdl_aout|SDL]]

*[[Documentation:Modules/auhal|AUHAL]]
*[[Documentation:Modules/jack|jack]]

*[[Documentation:Modules/alsa|Alsa]]
*[[Documentation:Modules/oss|OSS]]
*[[Documentation:Modules/arts|aRts]]
*[[Documentation:Modules/esd|esound]]

*[[Documentation:Modules/file_aout|file]]

=== Video Output ===
*[[Documentation:Modules/direct3d|Direct3D]]
*[[Documentation:Modules/directx_vout|DirectX]]
*[[Documentation:Modules/wingdi|Windows GDI]]
*[[Documentation:Modules/glwin32|OpenGL for windows]]

*[[Documentation:Modules/opengl|OpenGL]]

*[[Documentation:Modules/xvideo|XVideo]]
*[[Documentation:Modules/x11|X11]]
*[[Documentation:Modules/glx|OpenGL (GLX)]]
*[[Documentation:Modules/fb|Framebuffer]]
*[[Documentation:Modules/directfb|Direct framebuffer]]

*[[Documentation:Modules/sdl_vout|SDL]]
*[[Documentation:Modules/caca|Colored ASCII Art]]
*[[Documentation:Modules/aa|ASCII Art]]
*[[Documentation:Modules/image|Image]]

=== Stream Output ===

*[[Documentation:Modules/standard|Standard (std)]]
*[[Documentation:Modules/transcode|Transcode]]
*[[Documentation:Modules/duplicate|Duplicate]]
*[[Documentation:Modules/rtp|RTP]]
*[[Documentation:Modules/es|Elementary Stream (es)]]
*[[Documentation:Modules/display|Display]]
*[[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]]
*[[Documentation:Modules/transrate|Transrate]]

== Filters ==

=== Audio Filters ===

=== Video Filters ===

*[[Documentation:Modules/adjust|Adjust]]
*[[Documentation:Modules/gradient|Gradient]]
*[[Documentation:Modules/invert|Invert]]
*[[Documentation:Modules/wave|Wave]]
*[[Documentation:Modules/ripple|Ripple]]
*[[Documentation:Modules/motionblur|Motion Blur]]
*[[Documentation:Modules/psychedelic|Psychedelic]]
*[[Documentation:Modules/noise|Noise]]
*[[Documentation:Modules/colorthres|Color Threshold]]
*[[Documentation:Modules/rotate|Rotate]]
*[[Documentation:Modules/extract|Extract]]
*[[Documentation:Modules/erase|Logo Erase]]
*[[Documentation:Modules/gaussianblur|Gaussian Blur]]
*[[Documentation:Modules/sharpen|Sharpen]]
*[[Documentation:Modules/atmo|AtmoLight]]

The following video filters are for use in transcode only:
*[[Transcode#Canvas_and_Padding|Crop Padd]]
*[[Transcode#Canvas_and_Padding|Canvas]]

The following video filters are for use in the mosaic framework only:
*[[Documentation:Modules/bluescreen|Blue Screen]]
*[[Documentation:Modules/alphamask|Alpha mask]]

=== Video Sub-Filters ===

*[[Documentation:Modules/marq|Marq]]
*[[Documentation:Modules/rss|RSS]]
*[[Documentation:Modules/logo|Logo]]
*[[Documentation:Modules/mosaic|Mosaic]]
*[[Documentation:Modules/time|Time]] (up to 0.8.6)
*[[Documentation:Modules/subsdelay|Subsdelay]]

=== Video Output Filters ===

*[[Documentation:Modules/deinterlace|Deinterlace]]
*[[Documentation:Modules/transform|Transform]]
*[[Documentation:Modules/wall|Wall]]
*[[Documentation:Modules/crop|Crop]]
*[[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 ===

*[[Documentation:Modules/visualizer|Visualizer]]
*[[Documentation:Modules/goom|Goom]]
*[[Documentation:Modules/galaktos|Galaktos]]

=== Access Filters ===
*[[Documentation:Modules/timeshift|Timeshift]]
*[[Documentation:Modules/record|Record]]
*[[Documentation:Modules/dump|Dump]]
*[[Documentation:Modules/bandwidth|Bandwidth]]

== Other ==

=== Accesses ===
*[[Documentation:Modules/file|File Input]] - for reading local files
*[[Documentation:Modules/directory|Directory]]
*[[Documentation:Modules/dvdnav|DVDnav Input]]
*[[Documentation:Modules/dvdread|DVDRead Input]] - DVD without menu support
*[[Documentation:Modules/vcd|VCD]]
*[[Documentation:Modules/http|HTTP Input]]
*[[Documentation:Modules/ftp|FTP Input]]
*[[Documentation:Modules/udp|UDP/RTP Input]]
*[[Documentation:Modules/rtsp|RTSP]] -
*[[Documentation:Modules/rtmp|RTMP]] - Real Time Media Player
*[[Documentation:Modules/mms|MMS]] - reading from the MicroSoft Media Server
*[[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/rawvid|Raw Video]] - streams of bitmap images
*[[Documentation:Modules/mkv|Matroska stream]]
*[[Documentation:Modules/h264|H.264 Video]]
*[[Documentation:Modules/pvr|IVTV MPEG Encoding Card Input]]

Linux specific:
*[[Documentation:Modules/dv|DV]]
*[[Documentation:Modules/dvb|DVB Input]]
*[[Documentation:Modules/pvr|PVR]]
*[[Documentation:Modules/v4l|Video4Linux (v4l)]]
*[[Documentation:Modules/v4l2|Video4Linux2 (v4l2)]]
*[[Dc1394|Dc 1394]] FIXME: shouldn't link outside of Documentation:Modules/
Windows specific:
*[[Documentation:Modules/bda|BDA]]
*[[Documentation:Modules/dshow|DirectShow]]
Mac OS X specific:
*[[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

=== Access Outputs ===

=== Codecs ===

==== Audio ====
==== Video ====
==== Subtitles ====

=== Demuxers ===
==== Playlist ====
*[[Documentation:Modules/m3u-open|m3u]]
*[[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 ===

=== Service Discovery ===

*[[Documentation:Modules/sap|SAP]]
*[[Documentation:Modules/shout|Shoutcast]]
*[[Documentation:Modules/podcast_sd|Podcast]]
*[[Documentation:Modules/hal|HAL]]
*[[Documentation:Modules/daap|DAAP]]
*[[Documentation:Modules/bonjour|Bonjour]]
*[[Documentation:Modules/upnp_intel|UPnP (intel)]]
*[[Documentation:Modules/upnp_cc|UPnP (cyberlink)]]

=== Misc ===
*[[Documentation:Modules/netsync|Netsync]]
*[[Documentation:Modules/motion_control|Motion control]]
*[[VLC_Wikitube|Wikitube]]

{{Documentation}}

Documentation:Modules/subsdelay

2011-06-03T17:56:53Z

YuvalT: initial version

{{Module
|name=subsdelay
|type=Video subfilter
|first_version=1.2.0
|description=Change subtitles delay}}

The subsdelay filter can help slow readers to keep up with the subtitles.
It extends the subtitles duration without changing their original appearance time, so the subtitles are piled up on the video. To help keep track of the appearance order, existing subtitles gets more transparent as new subtitles arrive.

The subtitles duration factor is configurable through the synchronization dialog. Other options can be set through the preferences (under Video > Subtitles/OSD > Subsdelay).

== Options ==
Calculation parameters:
{{Option
|name=mode
|value=0,1,2
|default=1
|description=Delay calculation mode
}}

{{Option
|name=mode 0
|description=Absolute delay - add an absolute delay to each subtitle. 
:new_delay = original_delay + factor 
:In this mode the factor represents seconds
}}

{{Option
|name=mode 1
|description=Relative to source delay - multiply subtitles delay. 
:new_delay = original_delay * factor
}}

{{Option
|name=mode 2
|description=Relative to source content - determine subtitles delay from its content. 
:The delay calculation is based on the number and length of the words in the subtitle. 
:new_delay = f(original_text, factor) 
:This mode could only work for plain subtitles sources (like SubRip, MicroDVD, etc), for other formats the "relative to source delay" mode is used instead
}}

{{Option
|name=factor
|value=0.0-20.0
|default=2.0
|description=The delay calculation parameter
}}

Display parameters:
{{Option
|name=overlap
|value=1-4
|default=3
|description=Maximum number of subtitles allowed at the same time
}}

{{Option
|name=min-alpha
|value=0-255
|default=125
|description=Alpha value of the earliest subtitle, where 0 is fully transparent and 255 is fully opaque. Subtitles alpha is somewhere between fully opaque and this value according to the appearance order and the maximum overlapping allowed
}}

Overlap fix: 
These rules help fixing some "flickering" effects caused by the overlapping. They are applied after the initial delay is calculated in the following order:

{{Option
|name=min-stops
|value=integer
|default=1000
|description=Minimum time (in milliseconds) that a subtitle should stay after its predecessor has disappeared (subtitle delay will be extended to meet this requirement)
}}

{{Option
|name=min-stop-start
|value=integer
|default=1000
|description=Minimum time (in milliseconds) between subtitle disappearance and a newer subtitle appearance (earlier subtitle delay will be extended to fill the gap)
}}

{{Option
|name=min-start-stop
|value=integer
|default=1000
|description=Minimum time (in milliseconds) that a subtitle should stay after a newer subtitle has appeared (earlier subtitle delay will be shortened to avoid the overlap)
}}

== Examples ==

Example command line use '''(VLC 1.2.0 and above)''':

% '''vlc --sub-filter subsdelay --subsdelay-mode 1 --subsdelay-factor 2 --subsdelay-overlap 3'''
:Multiply subtitles duration by 2, up to 3 subtitles could be overlapped at a given time.

% '''vlc --sub-filter subsdelay --subsdelay-mode 0 --subsdelay-factor 0 --subsdelay-overlap 1 --subsdelay-min-stop-start 0'''
:Don't change subtitles duration but fix overlaps if exist.

VideoLAN Wiki - User contributions [en]

Documentation:Modules

Documentation:Modules/subsdelay