Aegisub/aegisub/src/video_provider_dummy.h
Thomas Goyne bc74dfc33b Update the video matrix tagging scheme
Write the color range and color space used to convert video to RGB to
the YCbCr Matrix field, or None if no non-RGB video was opened. See
http://code.google.com/p/xy-vsfilter/issues/detail?id=91 for related
discussion.

Originally committed to SVN as r6762.
2012-05-11 14:38:44 +00:00

97 lines
4.4 KiB
C++

// Copyright (c) 2007, Niels Martin Hansen
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
// * Neither the name of the Aegisub Group nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
// Aegisub Project http://www.aegisub.org/
//
// $Id$
/// @file video_provider_dummy.h
/// @see video_provider_dummy.cpp
/// @ingroup video_input
///
#include "include/aegisub/video_provider.h"
#include "video_frame.h"
class wxColour;
/// @class DummyVideoProvider
/// @brief A dummy video provider for when opening a file is just too much effort
///
/// This simply returns a single constant frame, which can either be a flat
/// color or a checkerboard pattern
class DummyVideoProvider : public VideoProvider {
int framecount; ///< Length of the dummy video in frames
agi::vfr::Framerate fps; ///< Frame rate to use
int width; ///< Width in pixels
int height; ///< Height in pixels
/// The single image which is returned for all frames
AegiVideoFrame frame;
/// Create the dummy frame from the given parameters
/// @param fps Frame rate of the dummy video
/// @param frames Length in frames of the dummy video
/// @param width Width in pixels of the dummy video
/// @param height Height in pixels of the dummy video
/// @param red Red component of the primary colour of the dummy video
/// @param green Green component of the primary colour of the dummy video
/// @param blue Blue component of the primary colour of the dummy video
/// @param pattern Use a checkerboard pattern rather than a solid colour
void Create(double fps, int frames, int width, int height, unsigned char red, unsigned char green, unsigned char blue, bool pattern);
public:
/// Create a dummy video from a string returned from MakeFilename
DummyVideoProvider(wxString const& filename);
/// Create a dummy video from separate parameters
/// @param fps Frame rate of the dummy video
/// @param frames Length in frames of the dummy video
/// @param width Width in pixels of the dummy video
/// @param height Height in pixels of the dummy video
/// @param colour Primary colour of the dummy video
/// @param pattern Use a checkerboard pattern rather than a solid colour
DummyVideoProvider(double fps, int frames, int width, int height, wxColour const& colour, bool pattern);
/// Destructor
~DummyVideoProvider();
/// Make a fake filename which when passed to the constructor taking a
/// string will result in a video with the given parameters
static wxString MakeFilename(double fps, int frames, int width, int height, wxColour const& colour, bool pattern);
const AegiVideoFrame GetFrame(int n) { return frame; }
int GetFrameCount() const { return framecount; }
int GetWidth() const { return width; }
int GetHeight() const { return height; }
double GetDAR() const { return 0; }
agi::vfr::Framerate GetFPS() const { return fps; }
std::vector<int> GetKeyFrames() const { return std::vector<int>(); }
wxString GetColorSpace() const { return "None"; }
wxString GetDecoderName() const { return "Dummy Video Provider"; }
};