OpenShot Library | libopenshot  0.1.2
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...
 
void DrawFrameOnScene (string path, long _graphics_scene_address)
 Test method to draw a bitmap on a Qt QGraphicsScene. More...
 
virtual CacheGetCache ()=0
 Get the cache object used by this reader (note: not all readers use cache) More...
 
virtual tr1::shared_ptr< FrameGetFrame (long int number)=0
 
virtual bool IsOpen ()=0
 A thread safe version of GetFrame. 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...
 
virtual void SetJson (string value)=0 throw (InvalidJSON)
 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...
 
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 95 of file ReaderBase.h.

Constructor & Destructor Documentation

◆ ReaderBase()

ReaderBase::ReaderBase ( )

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

Definition at line 33 of file ReaderBase.cpp.

Member Function Documentation

◆ Close()

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

◆ DisplayInfo()

void ReaderBase::DisplayInfo ( )

Display file information in the standard output stream (stdout)

Definition at line 64 of file ReaderBase.cpp.

◆ DrawFrameOnScene()

void ReaderBase::DrawFrameOnScene ( string  path,
long  _graphics_scene_address 
)

Test method to draw a bitmap on a Qt QGraphicsScene.

Definition at line 230 of file ReaderBase.cpp.

◆ GetCache()

virtual Cache* openshot::ReaderBase::GetCache ( )
pure virtual

◆ GetFrame()

virtual tr1::shared_ptr<Frame> openshot::ReaderBase::GetFrame ( long int  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::QtImageReader, openshot::ImageReader, and openshot::DummyReader.

◆ IsOpen()

virtual bool openshot::ReaderBase::IsOpen ( )
pure virtual

◆ Json()

virtual string openshot::ReaderBase::Json ( )
pure virtual

◆ JsonValue()

Json::Value ReaderBase::JsonValue ( )
pure virtual

◆ Name()

virtual string openshot::ReaderBase::Name ( )
pure virtual

◆ Open()

virtual void openshot::ReaderBase::Open ( )
pure virtual

◆ SetJson()

virtual void openshot::ReaderBase::SetJson ( string  value)
throw (InvalidJSON
)
pure virtual

◆ SetJsonValue()

void ReaderBase::SetJsonValue ( Json::Value  root)
pure virtual

Member Data Documentation

◆ getFrameCriticalSection

CriticalSection openshot::ReaderBase::getFrameCriticalSection
protected

Section lock for multiple threads.

Definition at line 99 of file ReaderBase.h.

◆ info

ReaderInfo openshot::ReaderBase::info

Information about the current media file.

Definition at line 108 of file ReaderBase.h.

◆ processingCriticalSection

CriticalSection openshot::ReaderBase::processingCriticalSection
protected

Definition at line 100 of file ReaderBase.h.


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