This abstract class is the base class, used by all readers in libopenshot. More...

#include <ReaderBase.h>

Inheritance diagram for openshot::ReaderBase:

Collaboration diagram for openshot::ReaderBase:

Public Member Functions
virtual void	Close ()=0
	Close the reader (and any resources it was consuming) More...

void	DisplayInfo (std::ostream *out=&std::cout)
	Display file information in the standard output stream (stdout) More...

virtual openshot::CacheBase *	GetCache ()=0
	Get the cache object used by this reader (note: not all readers use cache) More...

virtual std::shared_ptr< openshot::Frame >	GetFrame (int64_t number)=0

virtual bool	IsOpen ()=0
	Determine if reader is open or closed. More...

virtual std::string	Json () const =0
	Generate JSON string of this object. More...

virtual Json::Value	JsonValue () const =0
	Generate Json::Value for this object. More...

virtual std::string	Name ()=0
	Return the type name of the class. More...

virtual void	Open ()=0
	Open the reader (and start consuming resources, such as images or video files) More...

openshot::ClipBase *	ParentClip ()
	Parent clip object of this reader (which can be unparented and NULL) More...

void	ParentClip (openshot::ClipBase *new_clip)
	Set parent clip object of this reader. More...

	ReaderBase ()
	Constructor for the base reader, where many things are initialized. More...

virtual void	SetJson (const std::string value)=0
	Load JSON string into this object. More...

virtual void	SetJsonValue (const Json::Value root)=0
	Load Json::Value into this object. More...

virtual	~ReaderBase ()=default

Public Attributes
openshot::ReaderInfo	info
	Information about the current media file. More...

Protected Attributes
openshot::ClipBase *	clip
	Pointer to the parent clip instance (if any) More...

std::recursive_mutex	getFrameMutex
	Mutex for multiple threads. More...

Detailed Description

This abstract class is the base class, used by all readers in libopenshot.

Readers are types of classes that read video, audio, and image files, and return openshot::Frame objects. The only requirements for a 'reader', are to derive from this base class, implement the GetFrame method, and populate ReaderInfo.

Definition at line 75 of file ReaderBase.h.

Constructor & Destructor Documentation

◆ ReaderBase()

ReaderBase::ReaderBase ( )

Constructor for the base reader, where many things are initialized.

Definition at line 27 of file ReaderBase.cpp.

◆ ~ReaderBase()

virtual openshot::ReaderBase::~ReaderBase ( )

virtualdefault

Member Function Documentation

◆ Close()

virtual void openshot::ReaderBase::Close ( )

pure virtual

Close the reader (and any resources it was consuming)

Implemented in openshot::Timeline, openshot::FFmpegReader, openshot::FrameMapper, openshot::Clip, openshot::ChunkReader, openshot::DummyReader, openshot::QtImageReader, openshot::QtTextReader, openshot::TextReader, openshot::QtHtmlReader, and openshot::ImageReader.

Referenced by openshot::ChunkWriter::Close(), openshot::Clip::Close(), openshot::FrameMapper::Close(), openshot::ChunkReader::GetFrame(), openshot::Clip::Reader(), and openshot::Mask::SetJsonValue().

◆ DisplayInfo()

void ReaderBase::DisplayInfo ( std::ostream * out = &std::cout )

Display file information in the standard output stream (stdout)

Definition at line 61 of file ReaderBase.cpp.

Referenced by openshot::QtPlayer::SetSource(), and openshot::QtPlayer::SetTimelineSource().

◆ GetCache()

virtual openshot::CacheBase* openshot::ReaderBase::GetCache ( )

pure virtual

Get the cache object used by this reader (note: not all readers use cache)

Implemented in openshot::Timeline, openshot::FrameMapper, openshot::FFmpegReader, openshot::Clip, openshot::ChunkReader, openshot::DummyReader, openshot::QtImageReader, openshot::QtTextReader, openshot::TextReader, openshot::QtHtmlReader, and openshot::ImageReader.

Referenced by openshot::Timeline::ClearAllCache(), openshot::VideoCacheThread::run(), and openshot::VideoCacheThread::Seek().

◆ GetFrame()

virtual std::shared_ptr<openshot::Frame> openshot::ReaderBase::GetFrame ( int64_t number )

pure virtual

This method is required for all derived classes of ReaderBase, and returns the openshot::Frame object, which contains the image and audio information for that frame of video.