Documentation:Modules/image: Difference between revisions

From VideoLAN Wiki
Jump to navigation Jump to search
Accuracy fixes, expand, format
Confirmation of my observation: https://git.videolan.org/?p=vlc.git;a=commitdiff;h=5183b07c7c04e302af409fca4804e66777a6a040
Line 5: Line 5:
In VLC 1.0.0 the image video output was rewritten into a video-filter named [[Documentation:Modules/scene|scene]], and the old image video output was removed.
In VLC 1.0.0 the image video output was rewritten into a video-filter named [[Documentation:Modules/scene|scene]], and the old image video output was removed.


Trivia bit: [https://git.videolan.org/?p=vlc/vlc-0.9.git;a=blob;f=modules/video_output/image.c#l56 the help text] was inaccurate, claiming width and height options were <samp>&hellip; [b]y default (-1) &hellip;</samp>. The variables that inherited the command-line options, <var>p_vout->p_sys->i_width</var> and <var>p_vout->p_sys->i_height</var>, were unsigned integers and the value <code>0</code> was passed as the second argument in [https://git.videolan.org/?p=vlc/vlc-0.9.git;a=blob;f=modules/video_output/image.c#l95 the call] to <code>[https://git.videolan.org/?p=vlc/vlc-0.9.git;a=blob;f=include/vlc_plugin.h;h=364e53c089d709d4a6eebc2756a973145d387d33;hb=HEAD#l354 add_integer]</code>.<br />
Trivia: [https://git.videolan.org/?p=vlc/vlc-0.9.git;a=blob;f=modules/video_output/image.c#l56 the help text] was never changed after {{Commitdiff|5183b07c7c04e302af409fca4804e66777a6a040|l=this commitdiff}} changed the default values of unsigned integers <code>--image-out-width</code> and <code>--image-out-height</code> from <code>-1</code> to <code>0</code>&mdash;there was little point in fixing the help text for a deprecated module in software not yet publicly released! The coding error is absent from the current module, scene.
Thus, <code>--image-out-width</code> and <code>--image-out-height</code> had defaults of <code>0</code>, not <code>-1</code>.<br />
The help-text probably wasn't updated, since this error was prior to the first public release. It has since been fixed.


Option aliases <code>--image-width</code> for <code>--image-out-width</code> and <code>--image-height</code> for <code>--image-out-height</code> were deprecated in 0.9.0.
Option aliases <code>--image-width</code> for <code>--image-out-width</code> and <code>--image-height</code> for <code>--image-out-height</code> were deprecated in 0.9.0.

Revision as of 04:26, 5 April 2019

Options

Video output

Module: image
Type Video output
First VLC version 0.8.2
Last VLC version 0.9.10
Operating system(s) all
Description Outputs the video images to files
Shortcut(s) -

In VLC 1.0.0 the image video output was rewritten into a video-filter named scene, and the old image video output was removed.

Trivia: the help text was never changed after this commitdiff changed the default values of unsigned integers --image-out-width and --image-out-height from -1 to 0—there was little point in fixing the help text for a deprecated module in software not yet publicly released! The coding error is absent from the current module, scene.

Option aliases --image-width for --image-out-width and --image-height for --image-out-height were deprecated in 0.9.0.

  • image-out-format <string> {png,jpeg} : Format of the output images default value: png
  • image-out-width <integer> : You can enforce the image width. By default -1 VLC will adapt to the video characteristics default value: -1
  • image-out-height <integer> : You can enforce the image height. By default -1 VLC will adapt to the video characteristics default value: -1
  • image-out-ratio <integer> : Ratio of images to record. 3 means that one image out of three is recorded default value: 3
  • image-out-prefix <string> : Prefix of the output images filenames. Output filenames will have the "prefixNUMBER.format" form. Starting with VLC 0.9.0 you can also use format time and meta variables default value: img
  • image-out-replace <boolean> : Always write to the same file instead of creating one file per image. In this case, the number is not appended to the filename default value: disabled

Source code

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.