OpenShot Library | libopenshot  0.2.4
ChromaKey.h
Go to the documentation of this file.
1 /**
2  * @file
3  * @brief Header file for ChromaKey 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_CHROMAKEY_EFFECT_H
32 #define OPENSHOT_CHROMAKEY_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 "../KeyFrame.h"
45 
46 namespace openshot
47 {
48 
49  /**
50  * @brief This class uses the ImageMagick++ libraries, to remove (i.e. key out) a color (i.e. greenscreen)
51  *
52  * The greenscreen / bluescreen effect replaces matching colors in the video image with
53  * transparent pixels, revealing lower layers in the timeline.
54  */
55  class ChromaKey : public EffectBase
56  {
57  private:
58  Color color;
59  Keyframe fuzz;
60 
61  /// Init effect settings
62  void init_effect_details();
63 
64  public:
65 
66  /// Blank constructor, useful when using Json to load the effect properties
67  ChromaKey();
68 
69  /// Default constructor, which takes an openshot::Color object and a 'fuzz' factor, which
70  /// is used to determine how similar colored pixels are matched. The higher the fuzz, the
71  /// more colors are matched.
72  ///
73  /// @param color The color to match
74  /// @param fuzz The fuzz factor (or threshold)
75  ChromaKey(Color color, Keyframe fuzz);
76 
77  /// @brief This method is required for all derived classes of EffectBase, and returns a
78  /// modified openshot::Frame object
79  ///
80  /// The frame object is passed into this method, and a frame_number is passed in which
81  /// tells the effect which settings to use from its keyframes (starting at 1).
82  ///
83  /// @returns The modified openshot::Frame object
84  /// @param frame The frame object that needs the effect applied to it
85  /// @param frame_number The frame number (starting at 1) of the effect on the timeline.
86  std::shared_ptr<Frame> GetFrame(std::shared_ptr<Frame> frame, int64_t frame_number);
87 
88  /// Get and Set JSON methods
89  std::string Json(); ///< Generate JSON string of this object
90  void SetJson(std::string value); ///< Load JSON string into this object
91  Json::Value JsonValue(); ///< Generate Json::JsonValue for this object
92  void SetJsonValue(Json::Value root); ///< Load Json::JsonValue into this object
93 
94  // Get all properties for a specific frame
95  std::string PropertiesJSON(int64_t requested_frame);
96  };
97 
98 }
99 
100 #endif
Json::Value JsonValue()
Generate Json::JsonValue for this object.
Definition: ChromaKey.cpp:111
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:66
This class uses the ImageMagick++ libraries, to remove (i.e. key out) a color (i.e. greenscreen)
Definition: ChromaKey.h:55
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: ChromaKey.cpp:69
void SetJsonValue(Json::Value root)
Load Json::JsonValue into this object.
Definition: ChromaKey.cpp:153
ChromaKey()
Blank constructor, useful when using Json to load the effect properties.
Definition: ChromaKey.cpp:36
void SetJson(std::string value)
Load JSON string into this object.
Definition: ChromaKey.cpp:124
This class represents a color (used on the timeline and clips)
Definition: Color.h:45
std::string Json()
Get and Set JSON methods.
Definition: ChromaKey.cpp:104
This namespace is the default namespace for all code in the openshot library.
std::string PropertiesJSON(int64_t requested_frame)
Definition: ChromaKey.cpp:166
A Keyframe is a collection of Point instances, which is used to vary a number or property over time...
Definition: KeyFrame.h:64