OpenShot Library | libopenshot  0.2.5
Saturation.h
Go to the documentation of this file.
1 /**
2  * @file
3  * @brief Header file for Saturation 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_SATURATION_EFFECT_H
32 #define OPENSHOT_SATURATION_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 
51 namespace openshot
52 {
53 
54  /**
55  * @brief This class adjusts the saturation of color on a frame's image.
56  *
57  * This can be animated by passing in a Keyframe. Animating the color saturation can create
58  * some very cool effects.
59  */
60  class Saturation : public EffectBase
61  {
62  private:
63  /// Init effect settings
64  void init_effect_details();
65 
66  public:
67  Keyframe saturation; ///< The color saturation: 0.0 = black and white, 1.0 = normal, 2.0 = double saturation
68 
69  /// Blank constructor, useful when using Json to load the effect properties
70  Saturation();
71 
72  /// Default constructor, which takes 1 curve, to adjust the color saturation over time.
73  ///
74  /// @param new_saturation The curve to adjust the saturation of the frame's image (0.0 = black and white, 1.0 = normal, 2.0 = double saturation)
75  Saturation(Keyframe new_saturation);
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() const override; ///< Generate JSON string of this object
90  void SetJson(const std::string value); ///< Load JSON string into this object
91  Json::Value JsonValue() const override; ///< Generate Json::Value for this object
92  void SetJsonValue(const Json::Value root); ///< Load Json::Value into this object
93 
94  /// Get all properties for a specific frame (perfect for a UI to display the current state
95  /// of all properties at any time)
96  std::string PropertiesJSON(int64_t requested_frame) const override;
97  };
98 
99 }
100 
101 #endif
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:66
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Saturation.cpp:116
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Saturation.cpp:156
Saturation()
Blank constructor, useful when using Json to load the effect properties.
Definition: Saturation.cpp:36
std::string Json() const override
Get and Set JSON methods.
Definition: Saturation.cpp:109
void SetJson(const std::string value)
Load JSON string into this object.
Definition: Saturation.cpp:128
void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition: Saturation.cpp:145
This class adjusts the saturation of color on a frame&#39;s image.
Definition: Saturation.h:60
This namespace is the default namespace for all code in the openshot library.
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: Saturation.cpp:64
A Keyframe is a collection of Point instances, which is used to vary a number or property over time...
Definition: KeyFrame.h:64
Keyframe saturation
The color saturation: 0.0 = black and white, 1.0 = normal, 2.0 = double saturation.
Definition: Saturation.h:67