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