OpenShot Library | libopenshot
0.1.9
|
This class uses the FFmpeg libraries, to open video files and audio files, and return openshot::Frame objects for any frame in the file. More...
#include <FFmpegReader.h>
Public Member Functions | |
void | Close () |
Close File. More... | |
FFmpegReader (string path) | |
FFmpegReader (string path, bool inspect_reader) | |
CacheMemory * | GetCache () |
Get the cache object used by this reader. More... | |
std::shared_ptr< Frame > | GetFrame (int64_t requested_frame) |
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 File - which is called by the constructor automatically. More... | |
void | SetJson (string value) |
Load JSON string into this object. More... | |
void | SetJsonValue (Json::Value root) |
Load Json::JsonValue into this object. More... | |
~FFmpegReader () | |
Destructor. 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... | |
Public Attributes | |
bool | enable_seek |
CacheMemory | final_cache |
Final cache object used to hold final frames. More... | |
![]() | |
ReaderInfo | info |
Information about the current media file. More... | |
Additional Inherited Members | |
![]() | |
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 uses the FFmpeg libraries, to open video files and audio files, and return openshot::Frame objects for any frame in the file.
All seeking and caching is handled internally, and the primary public interface is the GetFrame() method. To use this reader, simply create an instance of this class, and call the GetFrame method to start retrieving frames. Use the info struct to obtain information on the file, such as the length (# of frames), height, width, bit rate, frames per second (fps), etc...
Definition at line 92 of file FFmpegReader.h.
FFmpegReader::FFmpegReader | ( | string | path | ) |
Constructor for FFmpegReader. This automatically opens the media file and loads frame 1, or it throws one of the following exceptions.
Definition at line 35 of file FFmpegReader.cpp.
FFmpegReader::FFmpegReader | ( | string | path, |
bool | inspect_reader | ||
) |
Constructor for FFmpegReader. This only opens the media file to inspect it's properties if inspect_reader=true. When not inspecting the media file, it's much faster, and useful when you are inflating the object using JSON after instantiating it.
Definition at line 56 of file FFmpegReader.cpp.
FFmpegReader::~FFmpegReader | ( | ) |
Destructor.
Definition at line 79 of file FFmpegReader.cpp.
|
virtual |
|
inlinevirtual |
Get the cache object used by this reader.
Implements openshot::ReaderBase.
Definition at line 244 of file FFmpegReader.h.
|
virtual |
Get a shared pointer to a openshot::Frame object for a specific frame number of this reader.
requested_frame | The frame number that is requested. |
Implements openshot::ReaderBase.
Definition at line 396 of file FFmpegReader.cpp.
|
inlinevirtual |
Determine if reader is open or closed.
Implements openshot::ReaderBase.
Definition at line 253 of file FFmpegReader.h.
|
virtual |
Get and Set JSON methods.
Generate JSON string of this object
Implements openshot::ReaderBase.
Definition at line 1914 of file FFmpegReader.cpp.
|
virtual |
Generate Json::JsonValue for this object.
Implements openshot::ReaderBase.
Definition at line 1921 of file FFmpegReader.cpp.
|
inlinevirtual |
Return the type name of the class.
Implements openshot::ReaderBase.
Definition at line 256 of file FFmpegReader.h.
|
virtual |
Open File - which is called by the constructor automatically.
Implements openshot::ReaderBase.
Definition at line 104 of file FFmpegReader.cpp.
|
virtual |
Load JSON string into this object.
Implements openshot::ReaderBase.
Definition at line 1933 of file FFmpegReader.cpp.
|
virtual |
Load Json::JsonValue into this object.
Implements openshot::ReaderBase.
Definition at line 1956 of file FFmpegReader.cpp.
bool openshot::FFmpegReader::enable_seek |
Enable or disable seeking. Seeking can more quickly locate the requested frame, but some codecs have trouble seeking, and can introduce artifacts or blank images into the video.
Definition at line 226 of file FFmpegReader.h.
CacheMemory openshot::FFmpegReader::final_cache |
Final cache object used to hold final frames.
Definition at line 222 of file FFmpegReader.h.