Mask.h
Go to the documentation of this file.
/**
* @file
* @brief Header file for Mask class
* @author Jonathan Thomas <jonathan@openshot.org>
*
* @section LICENSE
*
* Copyright (c) 2008-2014 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_WIPE_EFFECT_H
#define OPENSHOT_WIPE_EFFECT_H
#include "../EffectBase.h"
#include <cmath>
#include <ctime>
#include <iostream>
#include <omp.h>
#include <stdio.h>
#include <memory>
#include "../Color.h"
#include "../Exceptions.h"
#include "../Json.h"
#include "../KeyFrame.h"
#include "../ReaderBase.h"
#include "../FFmpegReader.h"
#include "../QtImageReader.h"
#include "../ChunkReader.h"
#ifdef USE_IMAGEMAGICK
#include "../ImageReader.h"
#endif
using namespace std;
namespace openshot
{
/**
* @brief This class uses the ImageMagick++ libraries, to apply alpha (or transparency) masks
* to any frame. It can also be animated, and used as a powerful Wipe transition.
*
* These masks / wipes can also be combined, such as a transparency mask on top of a clip, which
* is then wiped away with another animated version of this effect.
*/
class Mask : public EffectBase
{
private:
ReaderBase *reader;
std::shared_ptr<QImage> original_mask;
/// Constrain a color value from 0 to 255
int constrain(int color_value);
/// Get grayscale mask image
void set_grayscale_mask(std::shared_ptr<QImage> mask_frame_image, int width, int height, float brightness, float contrast);
/// Init effect settings
void init_effect_details();
public:
bool replace_image; ///< Replace the frame image with a grayscale image representing the mask. Great for debugging a mask.
Keyframe brightness; ///< Brightness keyframe to control the wipe / mask effect. A constant value here will prevent animation.
Keyframe contrast; ///< Contrast keyframe to control the hardness of the wipe effect / mask.
/// Blank constructor, useful when using Json to load the effect properties
Mask();
/// Default constructor, which takes 2 curves and a mask image path. The mask is used to
/// determine the alpha for each pixel (black is transparent, white is visible). The curves
/// adjust the brightness and contrast of this file, to animate the effect.
///
/// @param mask_reader The reader of a grayscale mask image or video, to be used by the wipe transition
/// @param mask_brightness The curve to adjust the brightness of the wipe's mask (between 100 and -100)
/// @param mask_contrast The curve to adjust the contrast of the wipe's mask (3 is typical, 20 is a lot, 0 is invalid)
Mask(ReaderBase *mask_reader, Keyframe mask_brightness, Keyframe mask_contrast);
/// @brief This method is required for all derived classes of EffectBase, and returns a
/// modified openshot::Frame object
///
/// The frame object is passed into this method, and a frame_number is passed in which
/// tells the effect which settings to use from it's keyframes (starting at 1).
///
/// @returns The modified openshot::Frame object
/// @param frame The frame object that needs the effect applied to it
/// @param frame_number The frame number (starting at 1) of the effect on the timeline.
std::shared_ptr<Frame> GetFrame(std::shared_ptr<Frame> frame, int64_t frame_number);
/// Get and Set JSON methods
string Json(); ///< Generate JSON string of this object
void SetJson(string value); ///< Load JSON string into this object
Json::Value JsonValue(); ///< Generate Json::JsonValue for this object
void SetJsonValue(Json::Value root); ///< Load Json::JsonValue into this object
/// Get all properties for a specific frame (perfect for a UI to display the current state
/// of all properties at any time)
string PropertiesJSON(int64_t requested_frame);
/// Get the reader object of the mask grayscale image
ReaderBase* Reader() { return reader; };
/// Set a new reader to be used by the mask effect (grayscale image)
void Reader(ReaderBase *new_reader) { reader = new_reader; };
};
}
#endif
openshot::EffectBase
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:66
openshot::Mask::replace_image
bool replace_image
Replace the frame image with a grayscale image representing the mask. Great for debugging a mask...
Definition: Mask.h:79
openshot::Mask::Reader
void Reader(ReaderBase *new_reader)
Set a new reader to be used by the mask effect (grayscale image)
Definition: Mask.h:120
OpenShot Wipe Tests.brightness
brightness
Definition: OpenShot Wipe Tests.py:20
std
openshot::ReaderBase
This abstract class is the base class, used by all readers in libopenshot.
Definition: ReaderBase.h:95
openshot::Mask::Reader
ReaderBase * Reader()
Get the reader object of the mask grayscale image.
Definition: Mask.h:117
openshot::Mask::contrast
Keyframe contrast
Contrast keyframe to control the hardness of the wipe effect / mask.
Definition: Mask.h:81
openshot::Mask
This class uses the ImageMagick++ libraries, to apply alpha (or transparency) masks to any frame...
Definition: Mask.h:63
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: AudioBufferSource.h:45
openshot::Mask::brightness
Keyframe brightness
Brightness keyframe to control the wipe / mask effect. A constant value here will prevent animation...
Definition: Mask.h:80
OpenShot Wipe Tests.contrast
contrast
Definition: OpenShot Wipe Tests.py:24
openshot::Keyframe
A Keyframe is a collection of Point instances, which is used to vary a number or property over time...
Definition: KeyFrame.h:64