View source for Documentation:Modules/image

== 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}}

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
|name=image-out-format
|value=string
|select={png,jpeg}
|default=png
|description=Format of the output images
}}
{{Option
|name=image-out-width
|value=integer
|default=0
|description=You can enforce the image width. By default VLC will adapt to the video characteristics
}}
{{Option
|name=image-out-height
|value=integer
|default=0
|description=You can enforce the image height. By default VLC will adapt to the video characteristics
}}
{{Option
|name=image-out-ratio
|value=integer
|default=3
|description=Ratio of images to record. ''3'' means that one image out of three is recorded
}}
{{Option
|name=image-out-prefix
|value=string
|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:Format String|format time and meta variables]]
}}
{{Option
|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
|description=Use real-time mode suitable for being used as a master input and real-time input slaves
}}

== Source code ==
* {{VLCSourceFile|p=vlc/vlc-0.9.git|modules/video_output/image.c}} (video output)
* {{VLCSourceFile|modules/demux/image.c}} (image demuxer)

{{Documentation footer}}