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