Files
libopenshot/include/DummyReader.h

88 lines
2.5 KiB
C++

/**
* @file
* @brief Header file for DummyReader class
* @author Jonathan Thomas <jonathan@openshot.org>
*
* @section LICENSE
*
* Copyright (c) 2008-2013 OpenShot Studios, LLC
* (http://www.openshotstudios.com). This file is part of
* OpenShot Library (http://www.openshot.org), an open-source project
* dedicated to delivering high quality video editing and animation solutions
* to the world.
*
* OpenShot Library is free software: you can redistribute it and/or modify
* it under the terms of the GNU 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 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef OPENSHOT_DUMMY_READER_H
#define OPENSHOT_DUMMY_READER_H
#include "ReaderBase.h"
#include <cmath>
#include <ctime>
#include <iostream>
#include <omp.h>
#include <stdio.h>
#include <tr1/memory>
#include "Magick++.h"
#include "Cache.h"
#include "Exceptions.h"
#include "FrameRate.h"
using namespace std;
namespace openshot
{
/**
* @brief This class is used as a simple, dummy reader, which always returns a blank frame.
*
* A dummy reader can be created with any framerate or samplerate. This is useful in unit
* tests that need to test different framerates or samplerates.
*/
class DummyReader : public ReaderBase
{
private:
tr1::shared_ptr<Frame> image_frame;
Framerate fps;
float duration;
int sample_rate;
int width;
int height;
int channels;
bool is_open;
public:
/// Constructor for DummyReader.
DummyReader(Framerate fps, int width, int height, int sample_rate, int channels, float duration);
/// Close File
void Close();
/// Get an openshot::Frame object for a specific frame number of this reader. All numbers
/// return the same Frame, since they all share the same image data.
///
/// @returns The requested frame (containing the image)
/// @param requested_frame The frame number that is requested.
tr1::shared_ptr<Frame> GetFrame(int requested_frame) throw(ReaderClosed);
/// Open File - which is called by the constructor automatically
void Open() throw(InvalidFile);
};
}
#endif