OpenShot Library | libopenshot  0.2.3
Public Member Functions | Public Attributes | Protected Attributes | List of all members
openshot::ReaderBase Class Referenceabstract

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

#include <ReaderBase.h>

Inheritance diagram for openshot::ReaderBase:
openshot::ChunkReader openshot::DecklinkReader openshot::DummyReader openshot::FFmpegReader openshot::FrameMapper openshot::ImageReader openshot::QtImageReader openshot::TextReader openshot::Timeline

Public Member Functions

virtual void Close ()=0
 Close the reader (and any resources it was consuming) More...
 
void DisplayInfo ()
 Display file information in the standard output stream (stdout) More...
 
virtual CacheBaseGetCache ()=0
 Get the cache object used by this reader (note: not all readers use cache) More...
 
ClipBaseGetClip ()
 Parent clip object of this reader (which can be unparented and NULL) More...
 
virtual std::shared_ptr< FrameGetFrame (int64_t number)=0
 
virtual bool IsOpen ()=0
 Determine if reader is open or closed. More...
 
virtual string Json ()=0
 Get and Set JSON methods. More...
 
virtual Json::Value JsonValue ()=0
 Generate Json::JsonValue for this object. More...
 
virtual 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...
 
 ReaderBase ()
 Constructor for the base reader, where many things are initialized. More...
 
void SetClip (ClipBase *clip)
 Set parent clip object of this reader. More...
 
virtual void SetJson (string value)=0
 Load JSON string into this object. More...
 
virtual void SetJsonValue (Json::Value root)=0
 Load Json::JsonValue into this object. More...
 

Public Attributes

ReaderInfo info
 Information about the current media file. More...
 

Protected Attributes

CriticalSection getFrameCriticalSection
 Section lock for multiple threads. More...
 
ClipBaseparent
 
CriticalSection processingCriticalSection
 

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 call the InitFileInfo() method.

Definition at line 97 of file ReaderBase.h.

Constructor & Destructor Documentation

ReaderBase::ReaderBase ( )

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

Definition at line 33 of file ReaderBase.cpp.

Member Function Documentation

virtual void openshot::ReaderBase::Close ( )
pure virtual
void ReaderBase::DisplayInfo ( )

Display file information in the standard output stream (stdout)

Definition at line 67 of file ReaderBase.cpp.

virtual CacheBase* openshot::ReaderBase::GetCache ( )
pure virtual
ClipBase * ReaderBase::GetClip ( )

Parent clip object of this reader (which can be unparented and NULL)

Definition at line 252 of file ReaderBase.cpp.

virtual std::shared_ptr<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.

Returns
The requested frame of video
Parameters
[in]numberThe frame number that is requested.

Implemented in openshot::FFmpegReader, openshot::Timeline, openshot::FrameMapper, openshot::ChunkReader, openshot::TextReader, openshot::DecklinkReader, openshot::ImageReader, openshot::QtImageReader, and openshot::DummyReader.

virtual bool openshot::ReaderBase::IsOpen ( )
pure virtual
virtual string openshot::ReaderBase::Json ( )
pure virtual
Json::Value ReaderBase::JsonValue ( )
pure virtual
virtual string openshot::ReaderBase::Name ( )
pure virtual
virtual void openshot::ReaderBase::Open ( )
pure virtual
void ReaderBase::SetClip ( ClipBase clip)

Set parent clip object of this reader.

Definition at line 257 of file ReaderBase.cpp.

virtual void openshot::ReaderBase::SetJson ( string  value)
pure virtual
void ReaderBase::SetJsonValue ( Json::Value  root)
pure virtual

Member Data Documentation

CriticalSection openshot::ReaderBase::getFrameCriticalSection
protected

Section lock for multiple threads.

Definition at line 101 of file ReaderBase.h.

ReaderInfo openshot::ReaderBase::info

Information about the current media file.

Definition at line 111 of file ReaderBase.h.

ClipBase* openshot::ReaderBase::parent
protected

Definition at line 103 of file ReaderBase.h.

CriticalSection openshot::ReaderBase::processingCriticalSection
protected

Definition at line 102 of file ReaderBase.h.


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