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