OpenShot Library | libopenshot  0.2.5
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  int pixel_count = frame_image->width() * frame_image->height();
70 
71  // Get the current hue percentage shift amount, and convert to degrees
72  double degrees = 360.0 * hue.GetValue(frame_number);
73  float cosA = cos(degrees*3.14159265f/180);
74  float sinA = sin(degrees*3.14159265f/180);
75 
76  // Calculate a rotation matrix for the RGB colorspace (based on the current hue shift keyframe value)
77  float matrix[3] = {
78  cosA + (1.0f - cosA) / 3.0f,
79  1.0f/3.0f * (1.0f - cosA) - sqrtf(1.0f/3.0f) * sinA,
80  1.0f/3.0f * (1.0f - cosA) + sqrtf(1.0f/3.0f) * sinA
81  };
82 
83  // Loop through pixels
84  unsigned char *pixels = (unsigned char *) frame_image->bits();
85 
86  #pragma omp parallel for shared (pixels)
87  for (int pixel = 0; pixel < pixel_count; ++pixel)
88  {
89  // Get the RGB values from the pixel (ignore the alpha channel)
90  int R = pixels[pixel * 4];
91  int G = pixels[pixel * 4 + 1];
92  int B = pixels[pixel * 4 + 2];
93 
94  // Multiply each color by the hue rotation matrix
95  pixels[pixel * 4] = constrain(R * matrix[0] + G * matrix[1] + B * matrix[2]);
96  pixels[pixel * 4 + 1] = constrain(R * matrix[2] + G * matrix[0] + B * matrix[1]);
97  pixels[pixel * 4 + 2] = constrain(R * matrix[1] + G * matrix[2] + B * matrix[0]);
98  }
99 
100  // return the modified frame
101  return frame;
102 }
103 
104 // Generate JSON string of this object
105 std::string Hue::Json() const {
106 
107  // Return formatted string
108  return JsonValue().toStyledString();
109 }
110 
111 // Generate Json::Value for this object
112 Json::Value Hue::JsonValue() const {
113 
114  // Create root json object
115  Json::Value root = EffectBase::JsonValue(); // get parent properties
116  root["type"] = info.class_name;
117  root["hue"] = hue.JsonValue();
118 
119  // return JsonValue
120  return root;
121 }
122 
123 // Load JSON string into this object
124 void Hue::SetJson(const std::string value) {
125 
126  // Parse JSON string into JSON objects
127  try
128  {
129  const Json::Value root = openshot::stringToJson(value);
130  // Set all values that match
131  SetJsonValue(root);
132  }
133  catch (const std::exception& e)
134  {
135  // Error parsing JSON (or missing keys)
136  throw InvalidJSON("JSON is invalid (missing keys or invalid data types)");
137  }
138 }
139 
140 // Load Json::Value into this object
141 void Hue::SetJsonValue(const Json::Value root) {
142 
143  // Set parent data
145 
146  // Set data from Json (if key is found)
147  if (!root["hue"].isNull())
148  hue.SetJsonValue(root["hue"]);
149 }
150 
151 // Get all properties for a specific frame
152 std::string Hue::PropertiesJSON(int64_t requested_frame) const {
153 
154  // Generate JSON properties list
155  Json::Value root;
156  root["id"] = add_property_json("ID", 0.0, "string", Id(), NULL, -1, -1, true, requested_frame);
157  root["position"] = add_property_json("Position", Position(), "float", "", NULL, 0, 1000 * 60 * 30, false, requested_frame);
158  root["layer"] = add_property_json("Track", Layer(), "int", "", NULL, 0, 20, false, requested_frame);
159  root["start"] = add_property_json("Start", Start(), "float", "", NULL, 0, 1000 * 60 * 30, false, requested_frame);
160  root["end"] = add_property_json("End", End(), "float", "", NULL, 0, 1000 * 60 * 30, false, requested_frame);
161  root["duration"] = add_property_json("Duration", Duration(), "float", "", NULL, 0, 1000 * 60 * 30, true, requested_frame);
162 
163  // Keyframes
164  root["hue"] = add_property_json("Hue", hue.GetValue(requested_frame), "float", "", &hue, 0.0, 1.0, false, requested_frame);
165 
166  // Return formatted string
167  return root.toStyledString();
168 }
float End() const
Get end position (in seconds) of clip (trim end of video)
Definition: ClipBase.h:80
float Start() const
Get start position (in seconds) of clip (trim start of video)
Definition: ClipBase.h:79
float Duration() const
Get the length of this clip (in seconds)
Definition: ClipBase.h:81
std::string Id() const
Get basic properties.
Definition: ClipBase.h:76
int Layer() const
Get layer of clip on timeline (lower number is covered by higher numbers)
Definition: ClipBase.h:78
float Position() const
Get position on timeline (in seconds)
Definition: ClipBase.h:77
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 void SetJsonValue(const Json::Value root)=0
Load Json::Value into this object.
Definition: EffectBase.cpp:117
int constrain(int color_value)
Constrain a color value from 0 to 255.
Definition: EffectBase.cpp:65
virtual Json::Value JsonValue() const =0
Generate Json::Value for this object.
Definition: EffectBase.cpp:84
EffectInfoStruct info
Information about the current effect.
Definition: EffectBase.h:73
This class shifts the hue of an image, and can be animated with openshot::Keyframe curves over time.
Definition: Hue.h:53
Keyframe hue
Shift the hue coordinates (left or right)
Definition: Hue.h:60
void SetJson(const std::string value)
Load JSON string into this object.
Definition: Hue.cpp:124
void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition: Hue.cpp:141
Hue()
Blank constructor, useful when using Json to load the effect properties.
Definition: Hue.cpp:36
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Hue.cpp:152
std::string Json() const override
Get and Set JSON methods.
Definition: Hue.cpp:105
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
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Hue.cpp:112
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:64
void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition: KeyFrame.cpp:362
double GetValue(int64_t index) const
Get the value at a specific index.
Definition: KeyFrame.cpp:262
Json::Value JsonValue() const
Generate Json::Value for this object.
Definition: KeyFrame.cpp:329
This namespace is the default namespace for all code in the openshot library.
const Json::Value stringToJson(const std::string value)
Definition: Json.cpp:33
bool has_video
Determines if this effect manipulates the image of a frame.
Definition: EffectBase.h:55
bool has_audio
Determines if this effect manipulates the audio of a frame.
Definition: EffectBase.h:56
std::string class_name
The class name of the effect.
Definition: EffectBase.h:52
std::string name
The name of the effect.
Definition: EffectBase.h:53
std::string description
The description of this effect and what it does.
Definition: EffectBase.h:54