OpenShot Library | libopenshot  0.2.4
Mask.h
Go to the documentation of this file.
1 /**
2  * @file
3  * @brief Header file for Mask class
4  * @author Jonathan Thomas <jonathan@openshot.org>
5  *
6  * @ref License
7  */
8 
9 /* LICENSE
10  *
11  * Copyright (c) 2008-2019 OpenShot Studios, LLC
12  * <http://www.openshotstudios.com/>. This file is part of
13  * OpenShot Library (libopenshot), an open-source project dedicated to
14  * delivering high quality video editing and animation solutions to the
15  * world. For more information visit <http://www.openshot.org/>.
16  *
17  * OpenShot Library (libopenshot) is free software: you can redistribute it
18  * and/or modify it under the terms of the GNU Lesser General Public License
19  * as published by the Free Software Foundation, either version 3 of the
20  * License, or (at your option) any later version.
21  *
22  * OpenShot Library (libopenshot) is distributed in the hope that it will be
23  * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25  * GNU Lesser General Public License for more details.
26  *
27  * You should have received a copy of the GNU Lesser General Public License
28  * along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
29  */
30 
31 #ifndef OPENSHOT_MASK_EFFECT_H
32 #define OPENSHOT_MASK_EFFECT_H
33 
34 #include "../EffectBase.h"
35 
36 #include <cmath>
37 #include <ctime>
38 #include <iostream>
39 #include <omp.h>
40 #include <stdio.h>
41 #include <memory>
42 #include "../Color.h"
43 #include "../Exceptions.h"
44 #include "../Json.h"
45 #include "../KeyFrame.h"
46 #include "../ReaderBase.h"
47 #include "../FFmpegReader.h"
48 #include "../QtImageReader.h"
49 #include "../ChunkReader.h"
50 #ifdef USE_IMAGEMAGICK
51  #include "../MagickUtilities.h"
52  #include "../ImageReader.h"
53 #endif
54 
55 namespace openshot
56 {
57 
58  /**
59  * @brief This class uses the image libraries to apply alpha (or transparency) masks
60  * to any frame. It can also be animated, and used as a powerful Wipe transition.
61  *
62  * These masks / wipes can also be combined, such as a transparency mask on top of a clip, which
63  * is then wiped away with another animated version of this effect.
64  */
65  class Mask : public EffectBase
66  {
67  private:
68  ReaderBase *reader;
69  std::shared_ptr<QImage> original_mask;
70  bool needs_refresh;
71 
72  /// Init effect settings
73  void init_effect_details();
74 
75  public:
76  bool replace_image; ///< Replace the frame image with a grayscale image representing the mask. Great for debugging a mask.
77  Keyframe brightness; ///< Brightness keyframe to control the wipe / mask effect. A constant value here will prevent animation.
78  Keyframe contrast; ///< Contrast keyframe to control the hardness of the wipe effect / mask.
79 
80  /// Blank constructor, useful when using Json to load the effect properties
81  Mask();
82 
83  /// Default constructor, which takes 2 curves and a mask image path. The mask is used to
84  /// determine the alpha for each pixel (black is transparent, white is visible). The curves
85  /// adjust the brightness and contrast of this file, to animate the effect.
86  ///
87  /// @param mask_reader The reader of a grayscale mask image or video, to be used by the wipe transition
88  /// @param mask_brightness The curve to adjust the brightness of the wipe's mask (between 100 and -100)
89  /// @param mask_contrast The curve to adjust the contrast of the wipe's mask (3 is typical, 20 is a lot, 0 is invalid)
90  Mask(ReaderBase *mask_reader, Keyframe mask_brightness, Keyframe mask_contrast);
91 
92  /// @brief This method is required for all derived classes of EffectBase, and returns a
93  /// modified openshot::Frame object
94  ///
95  /// The frame object is passed into this method, and a frame_number is passed in which
96  /// tells the effect which settings to use from its keyframes (starting at 1).
97  ///
98  /// @returns The modified openshot::Frame object
99  /// @param frame The frame object that needs the effect applied to it
100  /// @param frame_number The frame number (starting at 1) of the effect on the timeline.
101  std::shared_ptr<Frame> GetFrame(std::shared_ptr<Frame> frame, int64_t frame_number);
102 
103  /// Get and Set JSON methods
104  std::string Json(); ///< Generate JSON string of this object
105  void SetJson(std::string value); ///< Load JSON string into this object
106  Json::Value JsonValue(); ///< Generate Json::JsonValue for this object
107  void SetJsonValue(Json::Value root); ///< Load Json::JsonValue into this object
108 
109  /// Get all properties for a specific frame (perfect for a UI to display the current state
110  /// of all properties at any time)
111  std::string PropertiesJSON(int64_t requested_frame);
112 
113  /// Get the reader object of the mask grayscale image
114  ReaderBase* Reader() { return reader; };
115 
116  /// Set a new reader to be used by the mask effect (grayscale image)
117  void Reader(ReaderBase *new_reader) { reader = new_reader; };
118  };
119 
120 }
121 
122 #endif
void SetJson(std::string value)
Load JSON string into this object.
Definition: Mask.cpp:178
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:66
Json::Value JsonValue()
Generate Json::JsonValue for this object.
Definition: Mask.cpp:160
bool replace_image
Replace the frame image with a grayscale image representing the mask. Great for debugging a mask...
Definition: Mask.h:76
void Reader(ReaderBase *new_reader)
Set a new reader to be used by the mask effect (grayscale image)
Definition: Mask.h:117
std::shared_ptr< Frame > GetFrame(std::shared_ptr< Frame > frame, int64_t frame_number)
This method is required for all derived classes of EffectBase, and returns a modified openshot::Frame...
Definition: Mask.cpp:65
This abstract class is the base class, used by all readers in libopenshot.
Definition: ReaderBase.h:97
ReaderBase * Reader()
Get the reader object of the mask grayscale image.
Definition: Mask.h:114
Keyframe contrast
Contrast keyframe to control the hardness of the wipe effect / mask.
Definition: Mask.h:78
Mask()
Blank constructor, useful when using Json to load the effect properties.
Definition: Mask.cpp:36
This class uses the image libraries to apply alpha (or transparency) masks to any frame...
Definition: Mask.h:65
std::string Json()
Get and Set JSON methods.
Definition: Mask.cpp:153
This namespace is the default namespace for all code in the openshot library.
void SetJsonValue(Json::Value root)
Load Json::JsonValue into this object.
Definition: Mask.cpp:207
Keyframe brightness
Brightness keyframe to control the wipe / mask effect. A constant value here will prevent animation...
Definition: Mask.h:77
A Keyframe is a collection of Point instances, which is used to vary a number or property over time...
Definition: KeyFrame.h:64
std::string PropertiesJSON(int64_t requested_frame)
Definition: Mask.cpp:274