DecklinkReader.h
Go to the documentation of this file.
/**
* @file
* @brief Header file for DecklinkReader class
* @author Jonathan Thomas <jonathan@openshot.org>
*
* @ref License
*/
/* LICENSE
*
* Copyright (c) 2008-2019 OpenShot Studios, LLC
* <http://www.openshotstudios.com/>. This file is part of
* OpenShot Library (libopenshot), an open-source project dedicated to
* delivering high quality video editing and animation solutions to the
* world. For more information visit <http://www.openshot.org/>.
*
* OpenShot Library (libopenshot) is free software: you can redistribute it
* and/or modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* OpenShot Library (libopenshot) is distributed in the hope that it will be
* useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef OPENSHOT_DECKLINK_READER_H
#define OPENSHOT_DECKLINK_READER_H
#include "ReaderBase.h"
#include <cmath>
#include <ctime>
#include <fcntl.h>
#include <iostream>
#include <omp.h>
#include <pthread.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <memory>
#include <unistd.h>
#include "CacheMemory.h"
#include "Exceptions.h"
#include "Frame.h"
#include "DecklinkInput.h"
namespace openshot
{
/**
* @brief This class uses the Blackmagic Decklink libraries, to open video streams on Blackmagic devices.
*
* This requires special hardware manufactured by <a href="http://www.blackmagicdesign.com/products">Blackmagic Designs</a>.
* Once the device is acquired and connected, this reader returns openshot::Frame objects containing the image and audio data.
*/
class DecklinkReader : public ReaderBase
{
private:
bool is_open;
IDeckLink *deckLink;
IDeckLinkInput *deckLinkInput;
IDeckLinkDisplayModeIterator *displayModeIterator;
IDeckLinkOutput *m_deckLinkOutput;
IDeckLinkVideoConversion *m_deckLinkConverter;
pthread_mutex_t sleepMutex;
pthread_cond_t sleepCond;
IDeckLinkIterator *deckLinkIterator;
DeckLinkInputDelegate *delegate;
IDeckLinkDisplayMode *displayMode;
BMDVideoInputFlags inputFlags;
BMDDisplayMode selectedDisplayMode;
BMDPixelFormat pixelFormat;
int displayModeCount;
int exitStatus;
int ch;
bool foundDisplayMode;
HRESULT result;
int g_videoModeIndex;
int g_audioChannels;
int g_audioSampleDepth;
int g_maxFrames;
int device;
BMDTimeValue frameRateDuration, frameRateScale;
const char *displayModeName;
public:
/// Constructor for DecklinkReader. This automatically opens the device and loads
/// the first second of video, or it throws one of the following exceptions.
DecklinkReader(int device, int video_mode, int pixel_format, int channels, int sample_depth);
~DecklinkReader(); /// Destructor
/// Close the device and video stream
void Close();
/// Get the cache object used by this reader (always returns NULL for this reader)
CacheMemory* GetCache() { return NULL; };
/// 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)
/// @param requested_frame The frame number that is requested.
std::shared_ptr<Frame> GetFrame(int64_t requested_frame);
unsigned long GetCurrentFrameNumber();
/// Determine if reader is open or closed
bool IsOpen() { return is_open; };
/// Return the type name of the class
std::string Name() { return "DecklinkReader"; };
/// Get and Set JSON methods
std::string Json() const override; ///< Generate JSON string of this object
void SetJson(const std::string value); ///< Load JSON string into this object
Json::Value JsonValue() const; ///< Generate Json::Value for this object
void SetJsonValue(const Json::Value root); ///< Load Json::Value into this object
/// Open device and video stream - which is called by the constructor automatically
void Open();
};
}
#endif
CacheMemory.h
Header file for CacheMemory class.
DecklinkInput.h
Header file for DecklinkInput class.
Exceptions.h
Header file for all Exception classes.
Frame.h
Header file for Frame class.
ReaderBase.h
Header file for ReaderBase class.
DeckLinkInputDelegate
Implementation of the Blackmagic Decklink API (used by the DecklinkReader)
Definition: DecklinkInput.h:74
openshot::CacheMemory
This class is a memory-based cache manager for Frame objects.
Definition: CacheMemory.h:51
openshot::DecklinkReader
This class uses the Blackmagic Decklink libraries, to open video streams on Blackmagic devices.
Definition: DecklinkReader.h:63
openshot::DecklinkReader::GetFrame
std::shared_ptr< Frame > GetFrame(int64_t requested_frame)
Definition: DecklinkReader.cpp:237
openshot::DecklinkReader::Close
void Close()
Destructor.
Definition: DecklinkReader.cpp:215
openshot::DecklinkReader::JsonValue
Json::Value JsonValue() const
Generate Json::Value for this object.
Definition: DecklinkReader.cpp:256
openshot::DecklinkReader::Name
std::string Name()
Return the type name of the class.
Definition: DecklinkReader.h:118
openshot::DecklinkReader::SetJson
void SetJson(const std::string value)
Load JSON string into this object.
Definition: DecklinkReader.cpp:267
openshot::DecklinkReader::GetCurrentFrameNumber
unsigned long GetCurrentFrameNumber()
Definition: DecklinkReader.cpp:231
openshot::DecklinkReader::Open
void Open()
Open device and video stream - which is called by the constructor automatically.
Definition: DecklinkReader.cpp:172
openshot::DecklinkReader::~DecklinkReader
~DecklinkReader()
Definition: DecklinkReader.cpp:147
openshot::DecklinkReader::GetCache
CacheMemory * GetCache()
Get the cache object used by this reader (always returns NULL for this reader)
Definition: DecklinkReader.h:104
openshot::DecklinkReader::Json
std::string Json() const override
Get and Set JSON methods.
Definition: DecklinkReader.cpp:249
openshot::DecklinkReader::SetJsonValue
void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition: DecklinkReader.cpp:284
openshot::DecklinkReader::DecklinkReader
DecklinkReader(int device, int video_mode, int pixel_format, int channels, int sample_depth)
Definition: DecklinkReader.cpp:35
openshot::DecklinkReader::IsOpen
bool IsOpen()
Determine if reader is open or closed.
Definition: DecklinkReader.h:115
openshot::ReaderBase
This abstract class is the base class, used by all readers in libopenshot.
Definition: ReaderBase.h:98
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: AudioBufferSource.h:39