OpenShot Library | libopenshot  0.1.9
Public Member Functions | List of all members
openshot::DecklinkReader Class Reference

This class uses the Blackmagic Decklink libraries, to open video streams on Blackmagic devices. More...

#include <DecklinkReader.h>

Inheritance diagram for openshot::DecklinkReader:
openshot::ReaderBase

Public Member Functions

void Close ()
 Destructor. More...
 
 DecklinkReader (int device, int video_mode, int pixel_format, int channels, int sample_depth)
 
CacheMemoryGetCache ()
 Get the cache object used by this reader (always returns NULL for this reader) More...
 
unsigned long GetCurrentFrameNumber ()
 
std::shared_ptr< FrameGetFrame (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 device and video stream - 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...
 
 ~DecklinkReader ()
 
- Public Member Functions inherited from openshot::ReaderBase
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

- Public Attributes inherited from openshot::ReaderBase
ReaderInfo info
 Information about the current media file. More...
 
- Protected Attributes inherited from openshot::ReaderBase
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
 

Detailed Description

This class uses the Blackmagic Decklink libraries, to open video streams on Blackmagic devices.

This requires special hardware manufactured by Blackmagic Designs. Once the device is aquired and connected, this reader returns openshot::Frame objects containing the image and audio data.

Definition at line 61 of file DecklinkReader.h.

Constructor & Destructor Documentation

◆ DecklinkReader()

DecklinkReader::DecklinkReader ( int  device,
int  video_mode,
int  pixel_format,
int  channels,
int  sample_depth 
)

Constructor for DecklinkReader. This automatically opens the device and loads the first second of video, or it throws one of the following exceptions.

Definition at line 32 of file DecklinkReader.cpp.

◆ ~DecklinkReader()

DecklinkReader::~DecklinkReader ( )

Definition at line 144 of file DecklinkReader.cpp.

Member Function Documentation

◆ Close()

void DecklinkReader::Close ( )
virtual

Destructor.

Close the device and video stream

Implements openshot::ReaderBase.

Definition at line 212 of file DecklinkReader.cpp.

◆ GetCache()

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

Get the cache object used by this reader (always returns NULL for this reader)

Implements openshot::ReaderBase.

Definition at line 103 of file DecklinkReader.h.

◆ GetCurrentFrameNumber()

unsigned long DecklinkReader::GetCurrentFrameNumber ( )

Definition at line 228 of file DecklinkReader.cpp.

◆ GetFrame()

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

Get an openshot::Frame object for a specific frame number of this reader. Frame number is ignored, since it always gets the latest LIVE frame.

Returns
The requested frame (containing the image)
Parameters
requested_frameThe frame number that is requested.

Implements openshot::ReaderBase.

Definition at line 234 of file DecklinkReader.cpp.

◆ IsOpen()

bool openshot::DecklinkReader::IsOpen ( )
inlinevirtual

Determine if reader is open or closed.

Implements openshot::ReaderBase.

Definition at line 114 of file DecklinkReader.h.

◆ Json()

string DecklinkReader::Json ( )
virtual

Get and Set JSON methods.

Generate JSON string of this object

Implements openshot::ReaderBase.

Definition at line 246 of file DecklinkReader.cpp.

◆ JsonValue()

Json::Value DecklinkReader::JsonValue ( )
virtual

Generate Json::JsonValue for this object.

Implements openshot::ReaderBase.

Definition at line 253 of file DecklinkReader.cpp.

◆ Name()

string openshot::DecklinkReader::Name ( )
inlinevirtual

Return the type name of the class.

Implements openshot::ReaderBase.

Definition at line 117 of file DecklinkReader.h.

◆ Open()

void DecklinkReader::Open ( )
virtual

Open device and video stream - which is called by the constructor automatically.

Implements openshot::ReaderBase.

Definition at line 169 of file DecklinkReader.cpp.

◆ SetJson()

void DecklinkReader::SetJson ( string  value)
virtual

Load JSON string into this object.

Implements openshot::ReaderBase.

Definition at line 264 of file DecklinkReader.cpp.

◆ SetJsonValue()

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

Load Json::JsonValue into this object.

Implements openshot::ReaderBase.

Definition at line 287 of file DecklinkReader.cpp.


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