Back to Aurora Vision Library Lite website

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

DecodeVideo


Header: ThirdPartySdk.h
Namespace: avl

Captures an image from video file with using FFmpeg library.

Syntax

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

Parameters

Name Type Default Description
Input will be modified ioState DecodeVideo_State& Object used to maintain state of the function.
Input value inFilename const File&
Input value inStartFrameId const Optional<int64> NIL
Output value outImage Image& Captured frame
Output value 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 Aurora Vision 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.