Video recording tool based on FFmpeg framework. More...

#include <Image_VideoRecorder.hxx>

Inheritance diagram for Image_VideoRecorder:

Data Structures
struct	VideoRational
	AVRational alias. More...

Public Member Functions
	Image_VideoRecorder ()
	Empty constructor.

	~Image_VideoRecorder () override
	Destructor.

void	Close ()
	Close the stream - stop recorder.

bool	Open (const char *theFileName, const Image_VideoParams &theParams)
	Open output stream - initialize recorder.

Image_PixMap &	ChangeFrame ()
	Access RGBA frame, should NOT be re-initialized outside. Note that image is expected to have upper-left origin.

int64_t	FrameCount () const
	Return current frame index.

bool	PushFrame ()
	Push new frame, should be called after Open().

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()=default
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

bool	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

bool	IsKind (const char *const theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

int	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Member Functions
TCollection_AsciiString	formatAvError (const int theError) const
	Wrapper for av_strerror().

AVCodecContext *	getCodecContext () const
	Get codec context compatible with both old and new FFmpeg API.

bool	addVideoStream (const Image_VideoParams &theParams, const int theDefCodecId)
	Append video stream. theParams[in] video parameters theDefCodecId[in] identifier of codec managed by FFmpeg library (AVCodecID enum)

bool	openVideoCodec (const Image_VideoParams &theParams)
	Open video codec.

bool	writeVideoFrame (const bool theToFlush)
	Write new video frame.

Protected Attributes
AVFormatContext *	myAVContext
	video context

AVStream *	myVideoStream
	video stream

AVCodec *	myVideoCodec
	video codec

AVCodecContext *	myCodecCtx
	codec context (for FFmpeg 5.0+)

AVFrame *	myFrame
	frame to record

SwsContext *	myScaleCtx
	scale context for conversion from RGBA to YUV

Image_PixMap	myImgSrcRgba
	input RGBA image

VideoRational	myFrameRate
	video framerate

int64_t	myFrameCount
	current frame index

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Detailed Description

Video recording tool based on FFmpeg framework.

Constructor & Destructor Documentation

◆ Image_VideoRecorder()

Image_VideoRecorder::Image_VideoRecorder ( )

Empty constructor.

◆ ~Image_VideoRecorder()

Image_VideoRecorder::~Image_VideoRecorder ( )

override

Destructor.

Member Function Documentation

◆ addVideoStream()

bool Image_VideoRecorder::addVideoStream	(	const Image_VideoParams &	theParams,
		const int	theDefCodecId )

protected

Append video stream. theParams[in] video parameters theDefCodecId[in] identifier of codec managed by FFmpeg library (AVCodecID enum)

◆ ChangeFrame()

Image_PixMap & Image_VideoRecorder::ChangeFrame ( )

inline

Access RGBA frame, should NOT be re-initialized outside. Note that image is expected to have upper-left origin.

◆ Close()

void Image_VideoRecorder::Close ( )

Close the stream - stop recorder.

◆ formatAvError()

TCollection_AsciiString Image_VideoRecorder::formatAvError ( const int theError ) const

protected

Wrapper for av_strerror().

◆ FrameCount()

int64_t Image_VideoRecorder::FrameCount ( ) const

inline

Return current frame index.

◆ getCodecContext()

AVCodecContext * Image_VideoRecorder::getCodecContext ( ) const

protected

Get codec context compatible with both old and new FFmpeg API.

◆ Open()

bool Image_VideoRecorder::Open	(	const char *	theFileName,
		const Image_VideoParams &	theParams )

Open output stream - initialize recorder.

Parameters

[in]	theFileName	video filename
[in]	theParams	video parameters

◆ openVideoCodec()

bool Image_VideoRecorder::openVideoCodec ( const Image_VideoParams & theParams )

protected

Open video codec.

◆ PushFrame()

bool Image_VideoRecorder::PushFrame ( )

inline

Push new frame, should be called after Open().

◆ writeVideoFrame()

bool Image_VideoRecorder::writeVideoFrame ( const bool theToFlush )

protected

Write new video frame.

Field Documentation

◆ myAVContext

AVFormatContext* Image_VideoRecorder::myAVContext

protected

video context

◆ myCodecCtx

AVCodecContext* Image_VideoRecorder::myCodecCtx

protected

codec context (for FFmpeg 5.0+)

◆ myFrame

AVFrame* Image_VideoRecorder::myFrame

protected

frame to record

◆ myFrameCount

int64_t Image_VideoRecorder::myFrameCount

protected

current frame index

◆ myFrameRate

VideoRational Image_VideoRecorder::myFrameRate

protected

video framerate

◆ myImgSrcRgba

Image_PixMap Image_VideoRecorder::myImgSrcRgba

protected

input RGBA image

◆ myScaleCtx

SwsContext* Image_VideoRecorder::myScaleCtx

protected

scale context for conversion from RGBA to YUV

◆ myVideoCodec

AVCodec* Image_VideoRecorder::myVideoCodec

protected

video codec

◆ myVideoStream

AVStream* Image_VideoRecorder::myVideoStream

protected

video stream

The documentation for this class was generated from the following file:

Image_VideoRecorder.hxx

Data Structures

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Image_VideoRecorder()

◆ ~Image_VideoRecorder()

Member Function Documentation

◆ addVideoStream()

◆ ChangeFrame()

◆ Close()

◆ formatAvError()

◆ FrameCount()

◆ getCodecContext()

◆ Open()

◆ openVideoCodec()

◆ PushFrame()

◆ writeVideoFrame()

Field Documentation

◆ myAVContext

◆ myCodecCtx

◆ myFrame

◆ myFrameCount

◆ myFrameRate

◆ myImgSrcRgba

◆ myScaleCtx

◆ myVideoCodec

◆ myVideoStream