OpenShot Library | libopenshot
0.1.9
|
This class reads a special chunk-formatted file, which can be easily shared in a distributed environment. More...
#include <ChunkReader.h>
Public Member Functions | |
ChunkReader (string path, ChunkVersion chunk_version) | |
Constructor for ChunkReader. This automatically opens the chunk file or folder and loads frame 1, or it throws one of the following exceptions. More... | |
void | Close () |
Close the reader. More... | |
CacheMemory * | GetCache () |
Get the cache object used by this reader (always return NULL for this reader) More... | |
int64_t | GetChunkSize () |
Get the chunk size (number of frames to write in each chunk) More... | |
std::shared_ptr< Frame > | GetFrame (int64_t requested_frame) |
Get an openshot::Frame object for a specific frame number of this reader. More... | |
bool | IsOpen () |
Determine if reader is open or closed. More... | |
string | Json () |
Get and Set JSON methods. More... | |
Json::Value | JsonValue () |
Generate Json::JsonValue for this object. More... | |
string | Name () |
Return the type name of the class. More... | |
void | Open () |
Open the reader. This is required before you can access frames or data from the reader. More... | |
void | SetChunkSize (int64_t new_size) |
Set the chunk size (number of frames to write in each chunk) More... | |
void | SetJson (string value) |
Load JSON string into this object. More... | |
void | SetJsonValue (Json::Value root) |
Load Json::JsonValue into this object. More... | |
![]() | |
void | DisplayInfo () |
Display file information in the standard output stream (stdout) More... | |
ReaderBase () | |
Constructor for the base reader, where many things are initialized. More... | |
void | SetMaxSize (int width, int height) |
Set Max Image Size (used for performance optimization) More... | |
Additional Inherited Members | |
![]() | |
ReaderInfo | info |
Information about the current media file. More... | |
![]() | |
CriticalSection | getFrameCriticalSection |
Section lock for multiple threads. More... | |
int | max_height |
The maximium image height needed by this clip (used for optimizations) More... | |
int | max_width |
The maximum image width needed by this clip (used for optimizations) More... | |
CriticalSection | processingCriticalSection |
This class reads a special chunk-formatted file, which can be easily shared in a distributed environment.
It stores the video in small "chunks", which are really just short video clips, a few seconds each. A ChunkReader only needs the part of the chunk that contains the frames it is looking for. For example, if you only need the end of a video, only the last few chunks might be needed to successfully access those openshot::Frame objects.
Definition at line 104 of file ChunkReader.h.
ChunkReader::ChunkReader | ( | string | path, |
ChunkVersion | chunk_version | ||
) |
Constructor for ChunkReader. This automatically opens the chunk file or folder and loads frame 1, or it throws one of the following exceptions.
path | The folder path / location of a chunk (chunks are stored as folders) |
chunk_version | Choose the video version / quality (THUMBNAIL, PREVIEW, or FINAL) |
Definition at line 32 of file ChunkReader.cpp.
|
virtual |
|
inlinevirtual |
Get the cache object used by this reader (always return NULL for this reader)
Implements openshot::ReaderBase.
Definition at line 147 of file ChunkReader.h.
|
inline |
Get the chunk size (number of frames to write in each chunk)
Definition at line 140 of file ChunkReader.h.
|
virtual |
Get an openshot::Frame object for a specific frame number of this reader.
requested_frame | The frame number you want to retrieve |
Implements openshot::ReaderBase.
Definition at line 190 of file ChunkReader.cpp.
|
inlinevirtual |
Determine if reader is open or closed.
Implements openshot::ReaderBase.
Definition at line 155 of file ChunkReader.h.
|
virtual |
Get and Set JSON methods.
Generate JSON string of this object
Implements openshot::ReaderBase.
Definition at line 254 of file ChunkReader.cpp.
|
virtual |
Generate Json::JsonValue for this object.
Implements openshot::ReaderBase.
Definition at line 261 of file ChunkReader.cpp.
|
inlinevirtual |
Return the type name of the class.
Implements openshot::ReaderBase.
Definition at line 158 of file ChunkReader.h.
|
virtual |
Open the reader. This is required before you can access frames or data from the reader.
Implements openshot::ReaderBase.
Definition at line 142 of file ChunkReader.cpp.
|
inline |
Set the chunk size (number of frames to write in each chunk)
new_size | The number of frames per chunk |
Definition at line 144 of file ChunkReader.h.
|
virtual |
Load JSON string into this object.
Implements openshot::ReaderBase.
Definition at line 277 of file ChunkReader.cpp.
|
virtual |
Load Json::JsonValue into this object.
Implements openshot::ReaderBase.
Definition at line 300 of file ChunkReader.cpp.