OpenShot Library | libopenshot  0.1.2
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 (string path) throw (InvalidFile, NoStreamsFound, InvalidCodec)
 
CacheGetCache ()
 Get the cache object used by this reader. More...
 
tr1::shared_ptr< FrameGetFrame (long int requested_frame) throw (OutOfBoundsFrame, ReaderClosed, TooManySeeks)
 
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 () throw (InvalidFile, NoStreamsFound, InvalidCodec)
 Open File - which is called by the constructor automatically. More...
 
void SetJson (string value) throw (InvalidJSON)
 Load JSON string into this object. More...
 
void SetJsonValue (Json::Value root) throw (InvalidFile)
 Load Json::JsonValue into this object. More...
 
 ~FFmpegReader ()
 Destructor. More...
 
- Public Member Functions inherited from openshot::ReaderBase
void DisplayInfo ()
 Display file information in the standard output stream (stdout) More...
 
void DrawFrameOnScene (string path, long _graphics_scene_address)
 Test method to draw a bitmap on a Qt QGraphicsScene. More...
 
 ReaderBase ()
 Constructor for the base reader, where many things are initialized. More...
 

Public Attributes

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

Additional Inherited Members

- Protected Attributes inherited from openshot::ReaderBase
CriticalSection getFrameCriticalSection
 Section lock for multiple threads. More...
 
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
tr1::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 92 of file FFmpegReader.h.

Constructor & Destructor Documentation

◆ FFmpegReader()

FFmpegReader::FFmpegReader ( string  path)
throw (InvalidFile,
NoStreamsFound,
InvalidCodec
)

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::~FFmpegReader ( )

Destructor.

Definition at line 57 of file FFmpegReader.cpp.

Member Function Documentation

◆ Close()

void FFmpegReader::Close ( )
virtual

Close File.

Implements openshot::ReaderBase.

Definition at line 225 of file FFmpegReader.cpp.

◆ GetCache()

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

Get the cache object used by this reader.

Implements openshot::ReaderBase.

Definition at line 250 of file FFmpegReader.h.

◆ GetFrame()

tr1::shared_ptr< Frame > FFmpegReader::GetFrame ( long int  requested_frame)
throw (OutOfBoundsFrame,
ReaderClosed,
TooManySeeks
)
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 419 of file FFmpegReader.cpp.

◆ IsOpen()

bool openshot::FFmpegReader::IsOpen ( )
inlinevirtual

Determine if reader is open or closed.

Implements openshot::ReaderBase.

Definition at line 259 of file FFmpegReader.h.

◆ Json()

string FFmpegReader::Json ( )
virtual

Get and Set JSON methods.

Generate JSON string of this object

Implements openshot::ReaderBase.

Definition at line 1975 of file FFmpegReader.cpp.

◆ JsonValue()

Json::Value FFmpegReader::JsonValue ( )
virtual

Generate Json::JsonValue for this object.

Implements openshot::ReaderBase.

Definition at line 1982 of file FFmpegReader.cpp.

◆ Name()

string openshot::FFmpegReader::Name ( )
inlinevirtual

Return the type name of the class.

Implements openshot::ReaderBase.

Definition at line 262 of file FFmpegReader.h.

◆ Open()

void FFmpegReader::Open ( )
throw (InvalidFile,
NoStreamsFound,
InvalidCodec
)
virtual

Open File - which is called by the constructor automatically.

Implements openshot::ReaderBase.

Definition at line 123 of file FFmpegReader.cpp.

◆ SetJson()

void FFmpegReader::SetJson ( string  value)
throw (InvalidJSON
)
virtual

Load JSON string into this object.

Implements openshot::ReaderBase.

Definition at line 1994 of file FFmpegReader.cpp.

◆ SetJsonValue()

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

Load Json::JsonValue into this object.

Implements openshot::ReaderBase.

Definition at line 2017 of file FFmpegReader.cpp.

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

◆ final_cache

Cache openshot::FFmpegReader::final_cache

Final cache object used to hold final frames.

Definition at line 233 of file FFmpegReader.h.


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