OpenShot Library | libopenshot 0.3.1
|
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 () override |
Close File. More... | |
FFmpegReader (const std::string &path, bool inspect_reader=true) | |
Constructor for FFmpegReader. More... | |
CacheMemory * | GetCache () override |
Get the cache object used by this reader. More... | |
std::shared_ptr< openshot::Frame > | GetFrame (int64_t requested_frame) override |
bool | GetIsDurationKnown () |
Return true if frame can be read with GetFrame() More... | |
bool | IsOpen () override |
Determine if reader is open or closed. More... | |
std::string | Json () const override |
Generate JSON string of this object. More... | |
Json::Value | JsonValue () const override |
Generate Json::Value for this object. More... | |
std::string | Name () override |
Return the type name of the class. More... | |
void | Open () override |
Open File - which is called by the constructor automatically. More... | |
void | SetJson (const std::string value) override |
Load JSON string into this object. More... | |
void | SetJsonValue (const Json::Value root) override |
Load Json::Value into this object. More... | |
virtual | ~FFmpegReader () |
Destructor. More... | |
![]() | |
virtual void | Close ()=0 |
Close the reader (and any resources it was consuming) More... | |
void | DisplayInfo (std::ostream *out=&std::cout) |
Display file information in the standard output stream (stdout) More... | |
virtual openshot::CacheBase * | GetCache ()=0 |
Get the cache object used by this reader (note: not all readers use cache) More... | |
virtual std::shared_ptr< openshot::Frame > | GetFrame (int64_t number)=0 |
virtual bool | IsOpen ()=0 |
Determine if reader is open or closed. More... | |
virtual std::string | Json () const =0 |
Generate JSON string of this object. More... | |
virtual Json::Value | JsonValue () const =0 |
Generate Json::Value for this object. More... | |
virtual std::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... | |
openshot::ClipBase * | ParentClip () |
Parent clip object of this reader (which can be unparented and NULL) More... | |
void | ParentClip (openshot::ClipBase *new_clip) |
Set parent clip object of this reader. More... | |
ReaderBase () | |
Constructor for the base reader, where many things are initialized. More... | |
virtual void | SetJson (const std::string value)=0 |
Load JSON string into this object. More... | |
virtual void | SetJsonValue (const Json::Value root)=0 |
Load Json::Value into this object. More... | |
virtual | ~ReaderBase ()=default |
Public Attributes | |
bool | enable_seek |
CacheMemory | final_cache |
Final cache object used to hold final frames. More... | |
![]() | |
openshot::ReaderInfo | info |
Information about the current media file. More... | |
Additional Inherited Members | |
![]() | |
openshot::ClipBase * | clip |
Pointer to the parent clip instance (if any) More... | |
std::recursive_mutex | getFrameMutex |
Mutex for multiple threads. More... | |
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 101 of file FFmpegReader.h.
FFmpegReader::FFmpegReader | ( | const std::string & | path, |
bool | inspect_reader = true |
||
) |
Constructor for FFmpegReader.
Sets (and possibly opens) the media file path, or throws an exception.
path | The filesystem location to load |
inspect_reader | if true (the default), automatically open the media file and loads frame 1. |
Definition at line 71 of file FFmpegReader.cpp.
|
virtual |
Destructor.
Definition at line 100 of file FFmpegReader.cpp.
|
overridevirtual |
Close File.
Implements openshot::ReaderBase.
Definition at line 586 of file FFmpegReader.cpp.
Referenced by FFmpegReader(), SetJsonValue(), and ~FFmpegReader().
|
inlineoverridevirtual |
Get the cache object used by this reader.
Implements openshot::ReaderBase.
Definition at line 249 of file FFmpegReader.h.
|
overridevirtual |
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 895 of file FFmpegReader.cpp.
bool FFmpegReader::GetIsDurationKnown | ( | ) |
Return true if frame can be read with GetFrame()
Definition at line 891 of file FFmpegReader.cpp.
|
inlineoverridevirtual |
Determine if reader is open or closed.
Implements openshot::ReaderBase.
Definition at line 258 of file FFmpegReader.h.
|
overridevirtual |
Generate JSON string of this object.
Implements openshot::ReaderBase.
Definition at line 2410 of file FFmpegReader.cpp.
|
overridevirtual |
Generate Json::Value for this object.
Implements openshot::ReaderBase.
Definition at line 2417 of file FFmpegReader.cpp.
Referenced by Json().
|
inlineoverridevirtual |
Return the type name of the class.
Implements openshot::ReaderBase.
Definition at line 261 of file FFmpegReader.h.
|
overridevirtual |
Open File - which is called by the constructor automatically.
Implements openshot::ReaderBase.
Definition at line 207 of file FFmpegReader.cpp.
Referenced by FFmpegReader(), and SetJsonValue().
|
overridevirtual |
Load JSON string into this object.
Implements openshot::ReaderBase.
Definition at line 2429 of file FFmpegReader.cpp.
|
overridevirtual |
Load Json::Value into this object.
Implements openshot::ReaderBase.
Definition at line 2444 of file FFmpegReader.cpp.
Referenced by SetJson().
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 232 of file FFmpegReader.h.
Referenced by GetFrame().
CacheMemory openshot::FFmpegReader::final_cache |
Final cache object used to hold final frames.
Definition at line 228 of file FFmpegReader.h.
Referenced by FFmpegReader(), GetCache(), and GetFrame().