OpenShot Library | libopenshot
0.2.3
|
This abstract class is the base class, used by all readers in libopenshot. More...
#include <ReaderBase.h>
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 CacheBase * | GetCache ()=0 |
Get the cache object used by this reader (note: not all readers use cache) More... | |
ClipBase * | GetClip () |
Parent clip object of this reader (which can be unparented and NULL) More... | |
virtual std::shared_ptr< Frame > | GetFrame (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... | |
ClipBase * | parent |
CriticalSection | processingCriticalSection |
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.
ReaderBase::ReaderBase | ( | ) |
Constructor for the base reader, where many things are initialized.
Definition at line 33 of file ReaderBase.cpp.
|
pure virtual |
Close the reader (and any resources it was consuming)
Implemented in openshot::FFmpegReader, openshot::Timeline, openshot::FrameMapper, openshot::ChunkReader, openshot::TextReader, openshot::DecklinkReader, openshot::ImageReader, openshot::QtImageReader, and openshot::DummyReader.
void ReaderBase::DisplayInfo | ( | ) |
Display file information in the standard output stream (stdout)
Definition at line 67 of file ReaderBase.cpp.
|
pure virtual |
Get the cache object used by this reader (note: not all readers use cache)
Implemented in openshot::FFmpegReader, openshot::Timeline, openshot::FrameMapper, openshot::ChunkReader, openshot::TextReader, openshot::DecklinkReader, openshot::ImageReader, openshot::QtImageReader, and openshot::DummyReader.
ClipBase * ReaderBase::GetClip | ( | ) |
Parent clip object of this reader (which can be unparented and NULL)
Definition at line 252 of file ReaderBase.cpp.
|
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.
[in] | number | The 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.
|
pure virtual |
Determine if reader is open or closed.
Implemented in openshot::Timeline, openshot::FFmpegReader, openshot::FrameMapper, openshot::ChunkReader, openshot::TextReader, openshot::DecklinkReader, openshot::ImageReader, openshot::QtImageReader, and openshot::DummyReader.
|
pure virtual |
Get and Set JSON methods.
Generate JSON string of this object
Implemented in openshot::Timeline, openshot::FFmpegReader, openshot::FrameMapper, openshot::ChunkReader, openshot::TextReader, openshot::DecklinkReader, openshot::ImageReader, openshot::QtImageReader, and openshot::DummyReader.
|
pure virtual |
Generate Json::JsonValue for this object.
Implemented in openshot::Timeline, openshot::FFmpegReader, openshot::FrameMapper, openshot::ChunkReader, openshot::TextReader, openshot::DecklinkReader, openshot::ImageReader, openshot::QtImageReader, and openshot::DummyReader.
Definition at line 114 of file ReaderBase.cpp.
|
pure virtual |
Return the type name of the class.
Implemented in openshot::Timeline, openshot::FFmpegReader, openshot::FrameMapper, openshot::ChunkReader, openshot::TextReader, openshot::DecklinkReader, openshot::ImageReader, openshot::QtImageReader, and openshot::DummyReader.
|
pure virtual |
Open the reader (and start consuming resources, such as images or video files)
Implemented in openshot::Timeline, openshot::FFmpegReader, openshot::FrameMapper, openshot::ChunkReader, openshot::TextReader, openshot::DecklinkReader, openshot::ImageReader, openshot::QtImageReader, and openshot::DummyReader.
void ReaderBase::SetClip | ( | ClipBase * | clip | ) |
Set parent clip object of this reader.
Definition at line 257 of file ReaderBase.cpp.
|
pure virtual |
Load JSON string into this object.
Implemented in openshot::Timeline, openshot::FFmpegReader, openshot::FrameMapper, openshot::ChunkReader, openshot::TextReader, openshot::DecklinkReader, openshot::ImageReader, openshot::QtImageReader, and openshot::DummyReader.
|
pure virtual |
Load Json::JsonValue into this object.
Implemented in openshot::Timeline, openshot::FFmpegReader, openshot::FrameMapper, openshot::ChunkReader, openshot::TextReader, openshot::DecklinkReader, openshot::ImageReader, openshot::QtImageReader, and openshot::DummyReader.
Definition at line 169 of file ReaderBase.cpp.
|
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.
|
protected |
Definition at line 103 of file ReaderBase.h.
|
protected |
Definition at line 102 of file ReaderBase.h.