OpenShot Library | libopenshot 0.2.7
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
51namespace 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; ///< Overall color saturation: 0.0 = greyscale, 1.0 = normal, 2.0 = double saturation
68 Keyframe saturation_R; ///< Red color saturation
69 Keyframe saturation_G; ///< Green color saturation
70 Keyframe saturation_B; ///< Blue color saturation
71
72 /// Blank constructor, useful when using Json to load the effect properties
73 Saturation();
74
75 /// Default constructor, which takes four curves (one common curve and one curve per color), to adjust the color saturation over time.
76 ///
77 /// @param saturation The curve to adjust the saturation of the frame's image (0.0 = greyscale, 1.0 = normal, 2.0 = double saturation)
78 /// @param saturation_R The curve to adjust red saturation of the frame's image (0.0 = greyscale, 1.0 = normal, 2.0 = double saturation)
79 /// @param saturation_G The curve to adjust green saturation of the frame's image (0.0 = greyscale, 1.0 = normal, 2.0 = double saturation)
80 /// @param saturation_B The curve to adjust blue saturation of the frame's image (0.0 = greyscale, 1.0 = normal, 2.0 = double saturation)
82
83 /// @brief This method is required for all derived classes of ClipBase, and returns a
84 /// new openshot::Frame object. All Clip keyframes and effects are resolved into
85 /// pixels.
86 ///
87 /// @returns A new openshot::Frame object
88 /// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline.
89 std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override { return GetFrame(std::make_shared<openshot::Frame>(), frame_number); }
90
91 /// @brief This method is required for all derived classes of ClipBase, and returns a
92 /// modified openshot::Frame object
93 ///
94 /// The frame object is passed into this method and used as a starting point (pixels and audio).
95 /// All Clip keyframes and effects are resolved into pixels.
96 ///
97 /// @returns The modified openshot::Frame object
98 /// @param frame The frame object that needs the clip or effect applied to it
99 /// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline.
100 std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
101
102 // Get and Set JSON methods
103 std::string Json() const override; ///< Generate JSON string of this object
104 void SetJson(const std::string value) override; ///< Load JSON string into this object
105 Json::Value JsonValue() const override; ///< Generate Json::Value for this object
106 void SetJsonValue(const Json::Value root) override; ///< Load Json::Value into this object
107
108 /// Get all properties for a specific frame (perfect for a UI to display the current state
109 /// of all properties at any time)
110 std::string PropertiesJSON(int64_t requested_frame) const override;
111 };
112
113}
114
115#endif
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 class adjusts the saturation of color on a frame's image.
Definition: Saturation.h:61
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: Saturation.h:89
Keyframe saturation_G
Green color saturation.
Definition: Saturation.h:69
std::string Json() const override
Generate JSON string of this object.
Definition: Saturation.cpp:165
Keyframe saturation_B
Blue color saturation.
Definition: Saturation.h:70
Saturation()
Blank constructor, useful when using Json to load the effect properties.
Definition: Saturation.cpp:37
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Saturation.cpp:221
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Saturation.cpp:172
Keyframe saturation_R
Red color saturation.
Definition: Saturation.h:68
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition: Saturation.cpp:204
void SetJson(const std::string value) override
Load JSON string into this object.
Definition: Saturation.cpp:187
Keyframe saturation
Overall color saturation: 0.0 = greyscale, 1.0 = normal, 2.0 = double saturation.
Definition: Saturation.h:67
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:47