Difference between revisions of "Documentation:Modules/image"

From VideoLAN Wiki
Jump to navigation Jump to search
m (→‎Source code: New section)
(Expand with →‎Demux: , sections)
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
== Video output ==
 
{{Module|name=image|type=Video output|first_version=0.8.2|last_version=0.9.10|description=Outputs the video images to files}}
 
{{Module|name=image|type=Video output|first_version=0.8.2|last_version=0.9.10|description=Outputs the video images to files}}
  
 
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: [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.
 +
 +
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.
 +
 +
=== Options ===
 
{{Option
 
{{Option
 
|name=image-out-format
 
|name=image-out-format
−
|value=png, jpeg
+
|value=string
 +
|select={png,jpeg}
 
|default=png
 
|default=png
−
|description=Format of the output images}}
+
|description=Format of the output images
 +
}}
 
{{Option
 
{{Option
 
|name=image-out-width
 
|name=image-out-width
 
|value=integer
 
|value=integer
−
|default=-1
+
|default=0
−
|description=You can enforce the image width. By default ''-1'' VLC will adapt to the video characteristics}}
+
|description=You can enforce the image width. By default VLC will adapt to the video characteristics
 +
}}
 
{{Option
 
{{Option
 
|name=image-out-height
 
|name=image-out-height
 
|value=integer
 
|value=integer
−
|default=-1
+
|default=0
−
|description=You can enforce the image height. By default ''-1'' VLC will adapt to the video characteristics}}
+
|description=You can enforce the image height. By default VLC will adapt to the video characteristics
 +
}}
 
{{Option
 
{{Option
 
|name=image-out-ratio
 
|name=image-out-ratio
 
|value=integer
 
|value=integer
 
|default=3
 
|default=3
−
|description=Ratio of images to record. ''3'' means that one image out of three is recorded}}
+
|description=Ratio of images to record. ''3'' means that one image out of three is recorded
 +
}}
 
{{Option
 
{{Option
 
|name=image-out-prefix
 
|name=image-out-prefix
 
|value=string
 
|value=string
 
|default=img
 
|default=img
−
|description=Prefix of the output images filenames. Output filenames will have the "prefixNUMBER.format" form. Starting with VLC 0.9.0 you can also use [[Documentation:Play HowTo/Format String|format time and meta variables]]}}
+
|description=Prefix of the output images filenames. Output filenames will have the "prefixNUMBER.format" form. Starting with VLC 0.9.0 you can also use [[Documentation:Format String|format time and meta variables]]
 +
}}
 
{{Option
 
{{Option
 
|name=image-out-replace
 
|name=image-out-replace
 +
|value=boolean
 +
|default=disabled
 +
|description=Always write to the same file instead of creating one file per image. In this case, the number is not appended to the filename
 +
}}
 +
 +
== Demux ==
 +
{{Clear}}
 +
{{Module|name=image|type=Access demux|description=Image demuxer}}
 +
 +
=== Options ===
 +
{{Option
 +
|name=image-id
 +
|value=integer
 +
|default=-1
 +
|description=Set the ID of the [[elementary stream]]
 +
}}
 +
{{Option
 +
|name=image-group
 +
|value=integer
 +
|default=0
 +
|description=Set the group of the elementary stream
 +
}}
 +
{{Option
 +
|name=image-decode
 +
|value=boolean
 +
|default=enabled
 +
|description=Decode at the [[demux]]er stage
 +
}}
 +
{{Option
 +
|name=image-chroma
 +
|value=string
 +
|default=""
 +
|description=If non empty and <var>image-decode</var> is true, the image will be converted to the specified [[chroma]]
 +
}}
 +
{{Option
 +
|name=image-duration
 +
|value=float
 +
|default=10
 +
|description=Duration in seconds before simulating an end of file. A negative value means an unlimited play time
 +
}}
 +
{{Option
 +
|name=image-fps
 +
|value=string
 +
|default=10/1
 +
|description=[[Frame rate]] of the elementary stream produced
 +
}}
 +
{{Option
 +
|name=image-realtime
 +
|value=boolean
 
|default=disabled
 
|default=disabled
−
|description=Always write to the same file}}
+
|description=Use real-time mode suitable for being used as a master input and real-time input slaves
 +
}}
  
 
== Source code ==
 
== Source code ==
−
* {{VLCSourceFile|modules/demux/image.c}}
+
* {{VLCSourceFile|p=vlc/vlc-0.9.git|modules/video_output/image.c}} (video output)
 +
* {{VLCSourceFile|modules/demux/image.c}} (image demuxer)
  
 
{{Documentation footer}}
 
{{Documentation footer}}

Latest revision as of 04:39, 5 April 2019

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.

Options

  • 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 VLC will adapt to the video characteristics default value: 0
  • image-out-height <integer> : You can enforce the image height. By default VLC will adapt to the video characteristics default value: 0
  • 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

Demux

Module: image
Type Access demux
First VLC version -
Last VLC version -
Operating system(s) all
Description Image demuxer
Shortcut(s) -

Options

  • image-id <integer> : Set the ID of the elementary stream default value: -1
  • image-group <integer> : Set the group of the elementary stream default value: 0
  • image-decode <boolean> : Decode at the demuxer stage default value: enabled
  • image-chroma <string> : If non empty and image-decode is true, the image will be converted to the specified chroma default value: ""
  • image-duration <float> : Duration in seconds before simulating an end of file. A negative value means an unlimited play time default value: 10
  • image-fps <string> : Frame rate of the elementary stream produced default value: 10/1
  • image-realtime <boolean> : Use real-time mode suitable for being used as a master input and real-time input slaves 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.
Retrieved from "https://wiki.videolan.org/index.php?title=Documentation:Modules/image&oldid=60598"