OpenShot Library | libopenshot  0.2.4
Hue.cpp
Go to the documentation of this file.
1 /**
2  * @file
3  * @brief Source file for Hue effect 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 "../../include/effects/Hue.h"
32 
33 using namespace openshot;
34 
35 /// Blank constructor, useful when using Json to load the effect properties
36 Hue::Hue() : Hue(0.0) {
37  // Init effect properties
38  init_effect_details();
39 }
40 
41 // Default constructor
42 Hue::Hue(Keyframe hue): hue(hue)
43 {
44  // Init effect properties
45  init_effect_details();
46 }
47 
48 // Init effect settings
49 void Hue::init_effect_details()
50 {
51  /// Initialize the values of the EffectInfo struct.
53 
54  /// Set the effect info
55  info.class_name = "Hue";
56  info.name = "Hue";
57  info.description = "Adjust the hue / color of the frame's image.";
58  info.has_audio = false;
59  info.has_video = true;
60 }
61 
62 // This method is required for all derived classes of EffectBase, and returns a
63 // modified openshot::Frame object
64 std::shared_ptr<Frame> Hue::GetFrame(std::shared_ptr<Frame> frame, int64_t frame_number)
65 {
66  // Get the frame's image
67  std::shared_ptr<QImage> frame_image = frame->GetImage();
68 
69  // Get the current hue percentage shift amount, and convert to degrees
70  double degrees = 360.0 * hue.GetValue(frame_number);
71  float cosA = cos(degrees*3.14159265f/180);
72  float sinA = sin(degrees*3.14159265f/180);
73 
74  // Calculate a rotation matrix for the RGB colorspace (based on the current hue shift keyframe value)
75  float matrix[3][3] = {{cosA + (1.0f - cosA) / 3.0f, 1.0f/3.0f * (1.0f - cosA) - sqrtf(1.0f/3.0f) * sinA, 1.0f/3.0f * (1.0f - cosA) + sqrtf(1.0f/3.0f) * sinA},
76  {1.0f/3.0f * (1.0f - cosA) + sqrtf(1.0f/3.0f) * sinA, cosA + 1.0f/3.0f*(1.0f - cosA), 1.0f/3.0f * (1.0f - cosA) - sqrtf(1.0f/3.0f) * sinA},
77  {1.0f/3.0f * (1.0f - cosA) - sqrtf(1.0f/3.0f) * sinA, 1.0f/3.0f * (1.0f - cosA) + sqrtf(1.0f/3.0f) * sinA, cosA + 1.0f/3.0f * (1.0f - cosA)}};
78 
79  // Loop through pixels
80  unsigned char *pixels = (unsigned char *) frame_image->bits();
81  for (int pixel = 0, byte_index=0; pixel < frame_image->width() * frame_image->height(); pixel++, byte_index+=4)
82  {
83  // Get the RGB values from the pixel
84  int R = pixels[byte_index];
85  int G = pixels[byte_index + 1];
86  int B = pixels[byte_index + 2];
87  int A = pixels[byte_index + 3];
88 
89  // Multiply each color by the hue rotation matrix
90  float rx = constrain(R * matrix[0][0] + G * matrix[0][1] + B * matrix[0][2]);
91  float gx = constrain(R * matrix[1][0] + G * matrix[1][1] + B * matrix[1][2]);
92  float bx = constrain(R * matrix[2][0] + G * matrix[2][1] + B * matrix[2][2]);
93 
94  // Set all pixels to new value
95  pixels[byte_index] = rx;
96  pixels[byte_index + 1] = gx;
97  pixels[byte_index + 2] = bx;
98  pixels[byte_index + 3] = A; // leave the alpha value alone
99  }
100 
101  // return the modified frame
102  return frame;
103 }
104 
105 // Generate JSON string of this object
106 std::string Hue::Json() {
107 
108  // Return formatted string
109  return JsonValue().toStyledString();
110 }
111 
112 // Generate Json::JsonValue for this object
113 Json::Value Hue::JsonValue() {
114 
115  // Create root json object
116  Json::Value root = EffectBase::JsonValue(); // get parent properties
117  root["type"] = info.class_name;
118  root["hue"] = hue.JsonValue();
119 
120  // return JsonValue
121  return root;
122 }
123 
124 // Load JSON string into this object
125 void Hue::SetJson(std::string value) {
126 
127  // Parse JSON string into JSON objects
128  Json::Value root;
129  Json::CharReaderBuilder rbuilder;
130  Json::CharReader* reader(rbuilder.newCharReader());
131 
132  std::string errors;
133  bool success = reader->parse( value.c_str(),
134  value.c_str() + value.size(), &root, &errors );
135  delete reader;
136 
137  if (!success)
138  // Raise exception
139  throw InvalidJSON("JSON could not be parsed (or is invalid)");
140 
141  try
142  {
143  // Set all values that match
144  SetJsonValue(root);
145  }
146  catch (const std::exception& e)
147  {
148  // Error parsing JSON (or missing keys)
149  throw InvalidJSON("JSON is invalid (missing keys or invalid data types)");
150  }
151 }
152 
153 // Load Json::JsonValue into this object
154 void Hue::SetJsonValue(Json::Value root) {
155 
156  // Set parent data
158 
159  // Set data from Json (if key is found)
160  if (!root["hue"].isNull())
161  hue.SetJsonValue(root["hue"]);
162 }
163 
164 // Get all properties for a specific frame
165 std::string Hue::PropertiesJSON(int64_t requested_frame) {
166 
167  // Generate JSON properties list
168  Json::Value root;
169  root["id"] = add_property_json("ID", 0.0, "string", Id(), NULL, -1, -1, true, requested_frame);
170  root["position"] = add_property_json("Position", Position(), "float", "", NULL, 0, 1000 * 60 * 30, false, requested_frame);
171  root["layer"] = add_property_json("Track", Layer(), "int", "", NULL, 0, 20, false, requested_frame);
172  root["start"] = add_property_json("Start", Start(), "float", "", NULL, 0, 1000 * 60 * 30, false, requested_frame);
173  root["end"] = add_property_json("End", End(), "float", "", NULL, 0, 1000 * 60 * 30, false, requested_frame);
174  root["duration"] = add_property_json("Duration", Duration(), "float", "", NULL, 0, 1000 * 60 * 30, true, requested_frame);
175 
176  // Keyframes
177  root["hue"] = add_property_json("Hue", hue.GetValue(requested_frame), "float", "", &hue, 0.0, 1.0, false, requested_frame);
178 
179  // Return formatted string
180  return root.toStyledString();
181 }
Keyframe hue
Shift the hue coordinates (left or right)
Definition: Hue.h:60
Hue()
Blank constructor, useful when using Json to load the effect properties.
Definition: Hue.cpp:36
Json::Value JsonValue()
Generate Json::JsonValue for this object.
Definition: Hue.cpp:113
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: Hue.cpp:64
void SetJson(std::string value)
Load JSON string into this object.
Definition: Hue.cpp:125
float End()
Get end position (in seconds) of clip (trim end of video)
Definition: ClipBase.h:80
std::string PropertiesJSON(int64_t requested_frame)
Definition: Hue.cpp:165
int Layer()
Get layer of clip on timeline (lower number is covered by higher numbers)
Definition: ClipBase.h:78
virtual Json::Value JsonValue()=0
Generate Json::JsonValue for this object.
Definition: EffectBase.cpp:84
void SetJsonValue(Json::Value root)
Load Json::JsonValue into this object.
Definition: KeyFrame.cpp:374
bool has_audio
Determines if this effect manipulates the audio of a frame.
Definition: EffectBase.h:56
This class shifts the hue of an image, and can be animated with openshot::Keyframe curves over time...
Definition: Hue.h:52
std::string Id()
Get basic properties.
Definition: ClipBase.h:76
float Position()
Get position on timeline (in seconds)
Definition: ClipBase.h:77
virtual void SetJsonValue(Json::Value root)=0
Load Json::JsonValue into this object.
Definition: EffectBase.cpp:129
std::string class_name
The class name of the effect.
Definition: EffectBase.h:52
void SetJsonValue(Json::Value root)
Load Json::JsonValue into this object.
Definition: Hue.cpp:154
std::string name
The name of the effect.
Definition: EffectBase.h:53
std::string Json()
Get and Set JSON methods.
Definition: Hue.cpp:106
Json::Value add_property_json(std::string name, float value, std::string type, std::string memo, Keyframe *keyframe, float min_value, float max_value, bool readonly, int64_t requested_frame)
Generate JSON for a property.
Definition: ClipBase.cpp:68
This namespace is the default namespace for all code in the openshot library.
Json::Value JsonValue() const
Generate Json::JsonValue for this object.
Definition: KeyFrame.cpp:329
std::string description
The description of this effect and what it does.
Definition: EffectBase.h:54
bool has_video
Determines if this effect manipulates the image of a frame.
Definition: EffectBase.h:55
Exception for invalid JSON.
Definition: Exceptions.h:205
double GetValue(int64_t index) const
Get the value at a specific index.
Definition: KeyFrame.cpp:262
int constrain(int color_value)
Constrain a color value from 0 to 255.
Definition: EffectBase.cpp:65
A Keyframe is a collection of Point instances, which is used to vary a number or property over time...
Definition: KeyFrame.h:64
float Duration()
Get the length of this clip (in seconds)
Definition: ClipBase.h:81
float Start()
Get start position (in seconds) of clip (trim start of video)
Definition: ClipBase.h:79
EffectInfoStruct info
Information about the current effect.
Definition: EffectBase.h:73