OpenShot Library | libopenshot 0.2.7
Saturation.cpp
Go to the documentation of this file.
1/**
2 * @file
3 * @brief Source 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#include "Saturation.h"
32#include "Exceptions.h"
33
34using namespace openshot;
35
36/// Blank constructor, useful when using Json to load the effect properties
37Saturation::Saturation() : saturation(1.0), saturation_R(1.0), saturation_G(1.0), saturation_B(1.0) {
38 // Init effect properties
39 init_effect_details();
40}
41
42// Default constructor
43Saturation::Saturation(Keyframe saturation, Keyframe saturation_R, Keyframe saturation_G, Keyframe saturation_B) :
44 saturation(saturation), saturation_R(saturation_R), saturation_G(saturation_G), saturation_B(saturation_B)
45{
46 // Init effect properties
47 init_effect_details();
48}
49
50// Init effect settings
51void Saturation::init_effect_details()
52{
53 /// Initialize the values of the EffectInfo struct.
55
56 /// Set the effect info
57 info.class_name = "Saturation";
58 info.name = "Color Saturation";
59 info.description = "Adjust the color saturation.";
60 info.has_audio = false;
61 info.has_video = true;
62}
63
64// This method is required for all derived classes of EffectBase, and returns a
65// modified openshot::Frame object
66std::shared_ptr<openshot::Frame> Saturation::GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number)
67{
68 // Get the frame's image
69 std::shared_ptr<QImage> frame_image = frame->GetImage();
70
71 if (!frame_image)
72 return frame;
73
74 int pixel_count = frame_image->width() * frame_image->height();
75
76 // Get keyframe values for this frame
77 float saturation_value = saturation.GetValue(frame_number);
78 float saturation_value_R = saturation_R.GetValue(frame_number);
79 float saturation_value_G = saturation_G.GetValue(frame_number);
80 float saturation_value_B = saturation_B.GetValue(frame_number);
81
82 // Constants used for color saturation formula
83 const double pR = .299;
84 const double pG = .587;
85 const double pB = .114;
86
87 // Loop through pixels
88 unsigned char *pixels = (unsigned char *) frame_image->bits();
89
90 #pragma omp parallel for shared (pixels)
91 for (int pixel = 0; pixel < pixel_count; ++pixel)
92 {
93 // Get the RGB values from the pixel
94 int R = pixels[pixel * 4];
95 int G = pixels[pixel * 4 + 1];
96 int B = pixels[pixel * 4 + 2];
97
98 /*
99 * Common saturation adjustment
100 */
101
102 // Calculate the saturation multiplier
103 double p = sqrt( (R * R * pR) +
104 (G * G * pG) +
105 (B * B * pB) );
106
107 // Adjust the saturation
108 R = p + (R - p) * saturation_value;
109 G = p + (G - p) * saturation_value;
110 B = p + (B - p) * saturation_value;
111
112 // Constrain the value from 0 to 255
113 R = constrain(R);
114 G = constrain(G);
115 B = constrain(B);
116
117 /*
118 * Color-separated saturation adjustment
119 *
120 * Splitting each of the three subpixels (R, G and B) into three distincs sub-subpixels (R, G and B in turn)
121 * which in their optical sum reproduce the original subpixel's color OR produce white light in the brightness
122 * of the original subpixel (dependening on the color channel's slider value).
123 */
124
125 // Compute the brightness ("saturation multiplier") of the replaced subpixels
126 // Actually mathematical no-ops mostly, verbosity is kept just for clarification
127 const double p_r = sqrt(R * R * pR);
128 const double p_g = sqrt(G * G * pG);
129 const double p_b = sqrt(B * B * pB);
130
131 // Adjust the saturation
132 const int Rr = p_r + (R - p_r) * saturation_value_R;
133 const int Gr = p_r + (0 - p_r) * saturation_value_R;
134 const int Br = p_r + (0 - p_r) * saturation_value_R;
135
136 const int Rg = p_g + (0 - p_g) * saturation_value_G;
137 const int Gg = p_g + (G - p_g) * saturation_value_G;
138 const int Bg = p_g + (0 - p_g) * saturation_value_G;
139
140 const int Rb = p_b + (0 - p_b) * saturation_value_B;
141 const int Gb = p_b + (0 - p_b) * saturation_value_B;
142 const int Bb = p_b + (B - p_b) * saturation_value_B;
143
144 // Recombine brightness of sub-subpixels (Rx, Gx and Bx) into sub-pixels (R, G and B) again
145 R = Rr + Rg + Rb;
146 G = Gr + Gg + Gb;
147 B = Br + Bg + Bb;
148
149 // Constrain the value from 0 to 255
150 R = constrain(R);
151 G = constrain(G);
152 B = constrain(B);
153
154 // Set all pixels to new value
155 pixels[pixel * 4] = R;
156 pixels[pixel * 4 + 1] = G;
157 pixels[pixel * 4 + 2] = B;
158 }
159
160 // return the modified frame
161 return frame;
162}
163
164// Generate JSON string of this object
165std::string Saturation::Json() const {
166
167 // Return formatted string
168 return JsonValue().toStyledString();
169}
170
171// Generate Json::Value for this object
172Json::Value Saturation::JsonValue() const {
173
174 // Create root json object
175 Json::Value root = EffectBase::JsonValue(); // get parent properties
176 root["type"] = info.class_name;
177 root["saturation"] = saturation.JsonValue();
178 root["saturation_R"] = saturation_R.JsonValue();
179 root["saturation_G"] = saturation_G.JsonValue();
180 root["saturation_B"] = saturation_B.JsonValue();
181
182 // return JsonValue
183 return root;
184}
185
186// Load JSON string into this object
187void Saturation::SetJson(const std::string value) {
188
189 // Parse JSON string into JSON objects
190 try
191 {
192 const Json::Value root = openshot::stringToJson(value);
193 // Set all values that match
194 SetJsonValue(root);
195 }
196 catch (const std::exception& e)
197 {
198 // Error parsing JSON (or missing keys)
199 throw InvalidJSON("JSON is invalid (missing keys or invalid data types)");
200 }
201}
202
203// Load Json::Value into this object
204void Saturation::SetJsonValue(const Json::Value root) {
205
206 // Set parent data
208
209 // Set data from Json (if key is found)
210 if (!root["saturation"].isNull())
211 saturation.SetJsonValue(root["saturation"]);
212 if (!root["saturation_R"].isNull())
213 saturation_R.SetJsonValue(root["saturation_R"]);
214 if (!root["saturation_G"].isNull())
215 saturation_G.SetJsonValue(root["saturation_G"]);
216 if (!root["saturation_B"].isNull())
217 saturation_B.SetJsonValue(root["saturation_B"]);
218}
219
220// Get all properties for a specific frame
221std::string Saturation::PropertiesJSON(int64_t requested_frame) const {
222
223 // Generate JSON properties list
224 Json::Value root;
225 root["id"] = add_property_json("ID", 0.0, "string", Id(), NULL, -1, -1, true, requested_frame);
226 root["position"] = add_property_json("Position", Position(), "float", "", NULL, 0, 30 * 60 * 60 * 48, false, requested_frame);
227 root["layer"] = add_property_json("Track", Layer(), "int", "", NULL, 0, 20, false, requested_frame);
228 root["start"] = add_property_json("Start", Start(), "float", "", NULL, 0, 30 * 60 * 60 * 48, false, requested_frame);
229 root["end"] = add_property_json("End", End(), "float", "", NULL, 0, 30 * 60 * 60 * 48, false, requested_frame);
230 root["duration"] = add_property_json("Duration", Duration(), "float", "", NULL, 0, 30 * 60 * 60 * 48, true, requested_frame);
231
232 // Keyframes
233 root["saturation"] = add_property_json("Saturation", saturation.GetValue(requested_frame), "float", "", &saturation, 0.0, 4.0, false, requested_frame);
234 root["saturation_R"] = add_property_json("Saturation (Red)", saturation_R.GetValue(requested_frame), "float", "", &saturation_R, 0.0, 4.0, false, requested_frame);
235 root["saturation_G"] = add_property_json("Saturation (Green)", saturation_G.GetValue(requested_frame), "float", "", &saturation_G, 0.0, 4.0, false, requested_frame);
236 root["saturation_B"] = add_property_json("Saturation (Blue)", saturation_B.GetValue(requested_frame), "float", "", &saturation_B, 0.0, 4.0, false, requested_frame);
237
238 // Set the parent effect which properties this effect will inherit
239 root["parent_effect_id"] = add_property_json("Parent", 0.0, "string", info.parent_effect_id, NULL, -1, -1, false, requested_frame);
240
241 // Return formatted string
242 return root.toStyledString();
243}
Header file for all Exception classes.
Header file for Saturation class.
float End() const
Get end position (in seconds) of clip (trim end of video)
Definition: ClipBase.h:111
float Start() const
Get start position (in seconds) of clip (trim start of video)
Definition: ClipBase.h:110
float Duration() const
Get the length of this clip (in seconds)
Definition: ClipBase.h:112
std::string Id() const
Get the Id of this clip object.
Definition: ClipBase.h:107
int Layer() const
Get layer of clip on timeline (lower number is covered by higher numbers)
Definition: ClipBase.h:109
float Position() const
Get position on timeline (in seconds)
Definition: ClipBase.h:108
Json::Value add_property_json(std::string name, float value, std::string type, std::string memo, const Keyframe *keyframe, float min_value, float max_value, bool readonly, int64_t requested_frame) const
Generate JSON for a property.
Definition: ClipBase.cpp:68
virtual Json::Value JsonValue() const
Generate Json::Value for this object.
Definition: EffectBase.cpp:92
int constrain(int color_value)
Constrain a color value from 0 to 255.
Definition: EffectBase.cpp:73
virtual void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition: EffectBase.cpp:127
EffectInfoStruct info
Information about the current effect.
Definition: EffectBase.h:87
Exception for invalid JSON.
Definition: Exceptions.h:206
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
Definition: KeyFrame.h:72
void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition: KeyFrame.cpp:368
double GetValue(int64_t index) const
Get the value at a specific index.
Definition: KeyFrame.cpp:268
Json::Value JsonValue() const
Generate Json::Value for this object.
Definition: KeyFrame.cpp:335
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
const Json::Value stringToJson(const std::string value)
Definition: Json.cpp:34
bool has_video
Determines if this effect manipulates the image of a frame.
Definition: EffectBase.h:58
std::string parent_effect_id
Id of the parent effect (if there is one)
Definition: EffectBase.h:57
bool has_audio
Determines if this effect manipulates the audio of a frame.
Definition: EffectBase.h:59
std::string class_name
The class name of the effect.
Definition: EffectBase.h:54
std::string name
The name of the effect.
Definition: EffectBase.h:55
std::string description
The description of this effect and what it does.
Definition: EffectBase.h:56