Difference between revisions of "Documentation:Modules/dummy"
Jump to navigation
Jump to search
(Framework for page, +GPL) |
(→Interface: Explain how a dummy interface might be useful) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | Dummy modules are the VLC equivalent of <code>/dev/null</code> on GNU/Linux: they represent doing nothing. | + | [[Dummy]] modules are the VLC equivalent of <code>/dev/null</code> on GNU/Linux: they represent doing nothing. |
| + | == List == | ||
<!-- Editors: category wikicode must be entered manually. --> | <!-- Editors: category wikicode must be entered manually. --> | ||
{| class="wikitable sortable cellpadding-3px" | {| class="wikitable sortable cellpadding-3px" | ||
|+ Overview of dummy modules | |+ Overview of dummy modules | ||
| − | ! scope="col" | Type !! scope="col" | Description | + | ! scope="col" | Type !! scope="col" | Description !! scope="col" | Shortcut(s) |
|- | |- | ||
| − | | Stream output [[Category:Stream output]] || dummy | + | | Access [[Category:Accesses]] || Dummy input || dummy, vlc |
| + | |- | ||
| + | | Access output [[Category:Access output]] || Dummy stream output || dummy | ||
| + | |- | ||
| + | | Audio output [[Category:Audio output]] || Dummy audio output || dummy | ||
| + | |- | ||
| + | | Decoder [[Category:Codecs]] || Dummy decoder || dummy, dump | ||
| + | |- | ||
| + | | Encoder || Dummy encoder || dummy | ||
| + | |- | ||
| + | | Control interface [[Category:Interfaces]] [[Category:Control VLC]] || Dummy interface || (none) | ||
| + | |- | ||
| + | | Muxer [[Category:Muxers]] || Dummy/[[Raw]] muxer || dummy, raw, es | ||
| + | |- | ||
| + | | Stream output [[Category:Stream output]] || Dummy stream output || dummy, drop | ||
| + | |- | ||
| + | | Text renderer || Dummy font renderer || (none) | ||
| + | |- | ||
| + | | Video output [[Category:Video output]] || Dummy video output || dummy, stats | ||
| + | |- | ||
| + | | Video output (legacy video plugins) [[Category:Video output]] || Dummy window || dummy | ||
|} | |} | ||
| − | == | + | == Descriptions == |
| + | === Interface === | ||
| + | A dummy interface works well with [[command-line]] usage. It consumes fewer computing resources, something that can be used to reduce a bottleneck effect during [[transcoding]], or simply when opening a window makes little sense. | ||
| + | |||
| + | This will play an [[Ogg]] file with no interface: | ||
| + | {{$}} vlc -I dummy audio.ogg vlc://quit | ||
| + | No window is launched, and control is returned to the calling application after the file plays. | ||
| + | |||
| + | This will play a [[Schroedinger]] file with a minimalist interface: | ||
| + | {{$}} vlc -I dummy video.drc vlc://quit | ||
| + | A window with no buttons or toolbars is launched (no [[skin]]), because [[video output]] requires a window. [[Hotkey]]s may be used to control playback by default, something that can be disabled if necessary with <code>--no-keyboard-events</code>. | ||
| + | |||
=== Stream output === | === Stream output === | ||
Doesn't do anything. Can be used to test other stream output chain modules without actually streaming anything. | Doesn't do anything. Can be used to test other stream output chain modules without actually streaming anything. | ||
| − | {{ | + | == Options == |
| + | === Dummy decoder === | ||
| + | {{Option | ||
| + | |name=dummy-save-es | ||
| + | |value=boolean | ||
| + | |default=disabled | ||
| + | |description=Save the raw [[codec]] data if you have selected/forced the dummy decoder in the main options. | ||
| + | }} | ||
| + | |||
| + | === Video output === | ||
| + | {{Option | ||
| + | |name=dummy-chroma | ||
| + | |value=string | ||
| + | |default=NULL | ||
| + | |description=Force the dummy video output to create images using a specific [[chroma]] format instead of trying to improve performances by using the most efficient one. | ||
| + | }} | ||
| + | |||
| + | == Source code == | ||
| + | * {{VLCSourceFile|modules/access/idummy.c|Access}} | ||
| + | * {{VLCSourceFile|modules/access_output/dummy.c|Access output}} | ||
| + | * {{VLCSourceFile|modules/audio_output/adummy.c|Audio output}} | ||
| + | * {{VLCSourceFile|modules/codec/ddummy.c|Decoder}} | ||
| + | * {{VLCSourceFile|modules/codec/edummy.c|Encoder}} | ||
| + | * {{VLCSourceFile|modules/control/dummy.c|Interface}} | ||
| + | * {{VLCSourceFile|modules/mux/dummy.c|Output muxer}} | ||
| + | * {{VLCSourceFile|modules/stream_out/dummy.c|Stream output}} | ||
| + | * {{VLCSourceFile|modules/text_renderer/tdummy.c|Text rendering}} | ||
| + | * {{VLCSourceFile|modules/video_output/vdummy.c|Video output}} | ||
| + | * {{VLCSourceFile|modules/video_output/wdummy.c|Video output for legacy video plugins}} | ||
{{Documentation}} | {{Documentation}} | ||
Latest revision as of 20:08, 29 May 2019
Dummy modules are the VLC equivalent of /dev/null on GNU/Linux: they represent doing nothing.
Contents
List
| Type | Description | Shortcut(s) |
|---|---|---|
| Access | Dummy input | dummy, vlc |
| Access output | Dummy stream output | dummy |
| Audio output | Dummy audio output | dummy |
| Decoder | Dummy decoder | dummy, dump |
| Encoder | Dummy encoder | dummy |
| Control interface | Dummy interface | (none) |
| Muxer | Dummy/Raw muxer | dummy, raw, es |
| Stream output | Dummy stream output | dummy, drop |
| Text renderer | Dummy font renderer | (none) |
| Video output | Dummy video output | dummy, stats |
| Video output (legacy video plugins) | Dummy window | dummy |
Descriptions
Interface
A dummy interface works well with command-line usage. It consumes fewer computing resources, something that can be used to reduce a bottleneck effect during transcoding, or simply when opening a window makes little sense.
This will play an Ogg file with no interface:
$ vlc -I dummy audio.ogg vlc://quit
No window is launched, and control is returned to the calling application after the file plays.
This will play a Schroedinger file with a minimalist interface:
$ vlc -I dummy video.drc vlc://quit
A window with no buttons or toolbars is launched (no skin), because video output requires a window. Hotkeys may be used to control playback by default, something that can be disabled if necessary with --no-keyboard-events.
Stream output
Doesn't do anything. Can be used to test other stream output chain modules without actually streaming anything.
Options
Dummy decoder
- dummy-save-es <boolean> : Save the raw codec data if you have selected/forced the dummy decoder in the main options. default value: disabled
Video output
- dummy-chroma <string> : Force the dummy video output to create images using a specific chroma format instead of trying to improve performances by using the most efficient one. default value: NULL
Source code
- modules/access/idummy.c (Access)
- modules/access_output/dummy.c (Access output)
- modules/audio_output/adummy.c (Audio output)
- modules/codec/ddummy.c (Decoder)
- modules/codec/edummy.c (Encoder)
- modules/control/dummy.c (Interface)
- modules/mux/dummy.c (Output muxer)
- modules/stream_out/dummy.c (Stream output)
- modules/text_renderer/tdummy.c (Text rendering)
- modules/video_output/vdummy.c (Video output)
- modules/video_output/wdummy.c (Video output for legacy video plugins)
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
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.
