You are here: Start » Function Reference » Image » Image IO » DecodeVideo

DecodeVideo

Header:	ThirdPartySdk.h
Namespace:	fil
Module:	ThirdParty

Captures an image from video file with using FFmpeg library.

Syntax

bool fil::DecodeVideo
(
	DecodeVideo_State& ioState,
	const ftl::File& inFilename,
	const ftl::Optional<ftl::int64> inStartFrameId,
	fil::Image& outImage,
	ftl::int64& outFrameId
)

Parameters

Name	Type	Default	Description
ioState	DecodeVideo_State&		Object used to maintain state of the function.
inFilename	const File&
inStartFrameId	const Optional<int64>	NIL
outImage	Image&		Captured frame
outFrameId	int64&

Remarks

Video decoder software

This filter is intended to convert video file to series of images using FFmpeg library. It is required to install FFmpeg software.

FFmpeg can be downloaded from the following website: https://ffmpeg.org/download.html. Please to download "shared" version of FFmpeg.

Recommended FFmpeg version for FabImage Studio usage is 4.1.3.

Add DLL path to system environment variable may be required.

This filter is not able to decode all video formats supported by FFmpeg.

Multithreaded environment

This function is not guaranteed to be thread-safe. When used in multithreaded environment, it has to be manually synchronized.