OpenShot Library | libopenshot  0.2.4
Public Member Functions | Public Attributes | List of all members
openshot::FFmpegReader Class Reference

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>

Inheritance diagram for openshot::FFmpegReader:
openshot::ReaderBase

Public Member Functions

void Close ()
 Close File. More...
 
 FFmpegReader (std::string path)
 
 FFmpegReader (std::string path, bool inspect_reader)
 
CacheMemoryGetCache ()
 Get the cache object used by this reader. More...
 
std::shared_ptr< openshot::FrameGetFrame (int64_t requested_frame)
 
bool IsOpen ()
 Determine if reader is open or closed. More...
 
std::string Json ()
 Get and Set JSON methods. More...
 
Json::Value JsonValue ()
 Generate Json::JsonValue for this object. More...
 
std::string Name ()
 Return the type name of the class. More...
 
void Open ()
 Open File - which is called by the constructor automatically. More...
 
void SetJson (std::string value)
 Load JSON string into this object. More...
 
void SetJsonValue (Json::Value root)
 Load Json::JsonValue into this object. More...
 
virtual ~FFmpegReader ()
 Destructor. More...
 
- Public Member Functions inherited from openshot::ReaderBase
void DisplayInfo ()
 Display file information in the standard output stream (stdout) More...
 
openshot::ClipBaseGetClip ()
 Parent clip object of this reader (which can be unparented and NULL) More...
 
 ReaderBase ()
 Constructor for the base reader, where many things are initialized. More...
 
void SetClip (openshot::ClipBase *clip)
 Set parent clip object of this reader. More...
 
virtual ~ReaderBase ()=default
 

Public Attributes

bool enable_seek
 
CacheMemory final_cache
 Final cache object used to hold final frames. More...
 
- Public Attributes inherited from openshot::ReaderBase
openshot::ReaderInfo info
 Information about the current media file. More...
 

Additional Inherited Members

- Protected Attributes inherited from openshot::ReaderBase
juce::CriticalSection getFrameCriticalSection
 Section lock for multiple threads. More...
 
openshot::ClipBaseparent
 
juce::CriticalSection processingCriticalSection
 

Detailed Description

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...

// Create a reader for a video
FFmpegReader r("MyAwesomeVideo.webm");
r.Open(); // Open the reader
// Get frame number 1 from the video
std::shared_ptr<Frame> f = r.GetFrame(1);
// Now that we have an openshot::Frame object, lets have some fun!
f->Display(); // Display the frame on the screen
f->DisplayWaveform(); // Display the audio waveform as an image
f->Play(); // Play the audio through your speaker
// Close the reader
r.Close();

Definition at line 94 of file FFmpegReader.h.

Constructor & Destructor Documentation

◆ FFmpegReader() [1/2]

FFmpegReader::FFmpegReader ( std::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 86 of file FFmpegReader.cpp.

◆ FFmpegReader() [2/2]

FFmpegReader::FFmpegReader ( std::string  path,
bool  inspect_reader 
)

Constructor for FFmpegReader. This only opens the media file to inspect its 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 108 of file FFmpegReader.cpp.

◆ ~FFmpegReader()

FFmpegReader::~FFmpegReader ( )
virtual

Destructor.

Definition at line 132 of file FFmpegReader.cpp.

Member Function Documentation

◆ Close()

void FFmpegReader::Close ( )
virtual

Close File.

Implements openshot::ReaderBase.

Definition at line 577 of file FFmpegReader.cpp.

Referenced by FFmpegReader(), GetFrame(), SetJsonValue(), and ~FFmpegReader().

◆ GetCache()

CacheMemory* openshot::FFmpegReader::GetCache ( )
inlinevirtual

Get the cache object used by this reader.

Implements openshot::ReaderBase.

Definition at line 253 of file FFmpegReader.h.

◆ GetFrame()

std::shared_ptr< Frame > FFmpegReader::GetFrame ( int64_t  requested_frame)
virtual

Get a shared pointer to a openshot::Frame object for a specific frame number of this reader.

Returns
The requested frame of video
Parameters
requested_frameThe frame number that is requested.

Implements openshot::ReaderBase.

Definition at line 810 of file FFmpegReader.cpp.

◆ IsOpen()

bool openshot::FFmpegReader::IsOpen ( )
inlinevirtual

Determine if reader is open or closed.

Implements openshot::ReaderBase.

Definition at line 262 of file FFmpegReader.h.

◆ Json()

std::string FFmpegReader::Json ( )
virtual

Get and Set JSON methods.

Generate JSON string of this object

Implements openshot::ReaderBase.

Definition at line 2430 of file FFmpegReader.cpp.

◆ JsonValue()

Json::Value FFmpegReader::JsonValue ( )
virtual

Generate Json::JsonValue for this object.

Implements openshot::ReaderBase.

Definition at line 2437 of file FFmpegReader.cpp.

Referenced by Json().

◆ Name()

std::string openshot::FFmpegReader::Name ( )
inlinevirtual

Return the type name of the class.

Implements openshot::ReaderBase.

Definition at line 265 of file FFmpegReader.h.

◆ Open()

void FFmpegReader::Open ( )
virtual

Open File - which is called by the constructor automatically.

Implements openshot::ReaderBase.

Definition at line 239 of file FFmpegReader.cpp.

Referenced by FFmpegReader(), GetFrame(), and SetJsonValue().

◆ SetJson()

void FFmpegReader::SetJson ( std::string  value)
virtual

Load JSON string into this object.

Implements openshot::ReaderBase.

Definition at line 2449 of file FFmpegReader.cpp.

◆ SetJsonValue()

void FFmpegReader::SetJsonValue ( Json::Value  root)
virtual

Load Json::JsonValue into this object.

Implements openshot::ReaderBase.

Definition at line 2476 of file FFmpegReader.cpp.

Referenced by SetJson().

Member Data Documentation

◆ enable_seek

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 235 of file FFmpegReader.h.

Referenced by GetFrame().

◆ final_cache

CacheMemory openshot::FFmpegReader::final_cache

Final cache object used to hold final frames.

Definition at line 231 of file FFmpegReader.h.

Referenced by FFmpegReader(), and GetFrame().


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