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