Open CASCADE Technology  7.4.1.dev
Data Structures | Public Member Functions | Protected Member Functions | Protected Attributes
Image_VideoRecorder Class Reference

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

#include <Image_VideoRecorder.hxx>

Inheritance diagram for Image_VideoRecorder:
Inheritance graph
[legend]

Data Structures

struct  VideoRational
 AVRational alias. More...
 

Public Member Functions

 Image_VideoRecorder ()
 Empty constructor. More...
 
virtual ~Image_VideoRecorder ()
 Destructor. More...
 
void Close ()
 Close the stream - stop recorder. More...
 
Standard_Boolean Open (const char *theFileName, const Image_VideoParams &theParams)
 Open output stream - initialize recorder. More...
 
Image_PixMapChangeFrame ()
 Access RGBA frame, should NOT be re-initialized outside. Note that image is expected to have upper-left origin. More...
 
int64_t FrameCount () const
 Return current frame index. More...
 
Standard_Boolean PushFrame ()
 Push new frame, should be called after Open(). More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean 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. More...
 
Standard_Boolean IsKind (const Standard_CString 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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Protected Member Functions

TCollection_AsciiString formatAvError (const int theError) const
 Wrapper for av_strerror(). More...
 
Standard_Boolean addVideoStream (const Image_VideoParams &theParams, const Standard_Integer theDefCodecId)
 Append video stream. theParams [in] video parameters theDefCodecId [in] identifier of codec managed by FFmpeg library (AVCodecID enum) More...
 
Standard_Boolean openVideoCodec (const Image_VideoParams &theParams)
 Open video codec. More...
 
Standard_Boolean writeVideoFrame (const Standard_Boolean theToFlush)
 Write new video frame. More...
 

Protected Attributes

AVFormatContext * myAVContext
 video context More...
 
AVStream * myVideoStream
 video stream More...
 
AVCodec * myVideoCodec
 video codec More...
 
AVFrame * myFrame
 frame to record More...
 
SwsContext * myScaleCtx
 scale context for conversion from RGBA to YUV More...
 
Image_PixMap myImgSrcRgba
 input RGBA image More...
 
VideoRational myFrameRate
 video framerate More...
 
int64_t myFrameCount
 current frame index More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

Video recording tool based on FFmpeg framework.

Constructor & Destructor Documentation

◆ Image_VideoRecorder()

Image_VideoRecorder::Image_VideoRecorder ( )

Empty constructor.

◆ ~Image_VideoRecorder()

virtual Image_VideoRecorder::~Image_VideoRecorder ( )
virtual

Destructor.

Member Function Documentation

◆ addVideoStream()

Standard_Boolean Image_VideoRecorder::addVideoStream ( const Image_VideoParams theParams,
const Standard_Integer  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.

◆ Open()

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

Open output stream - initialize recorder.

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

◆ openVideoCodec()

Standard_Boolean Image_VideoRecorder::openVideoCodec ( const Image_VideoParams theParams)
protected

Open video codec.

◆ PushFrame()

Standard_Boolean Image_VideoRecorder::PushFrame ( )
inline

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

◆ writeVideoFrame()

Standard_Boolean Image_VideoRecorder::writeVideoFrame ( const Standard_Boolean  theToFlush)
protected

Write new video frame.

Field Documentation

◆ myAVContext

AVFormatContext* Image_VideoRecorder::myAVContext
protected

video context

◆ 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: