OpenShot Library | libopenshot  0.3.0
Hue.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 "Hue.h"
14 #include "Exceptions.h"
15 
16 using namespace openshot;
17 
19 Hue::Hue() : Hue(0.0) {
20  // Init effect properties
21  init_effect_details();
22 }
23 
24 // Default constructor
25 Hue::Hue(Keyframe hue): hue(hue)
26 {
27  // Init effect properties
28  init_effect_details();
29 }
30 
31 // Init effect settings
32 void Hue::init_effect_details()
33 {
36 
38  info.class_name = "Hue";
39  info.name = "Hue";
40  info.description = "Adjust the hue / color of the frame's image.";
41  info.has_audio = false;
42  info.has_video = true;
43 }
44 
45 // This method is required for all derived classes of EffectBase, and returns a
46 // modified openshot::Frame object
47 std::shared_ptr<openshot::Frame> Hue::GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number)
48 {
49  // Get the frame's image
50  std::shared_ptr<QImage> frame_image = frame->GetImage();
51 
52  int pixel_count = frame_image->width() * frame_image->height();
53 
54  // Get the current hue percentage shift amount, and convert to degrees
55  double degrees = 360.0 * hue.GetValue(frame_number);
56  float cosA = cos(degrees*3.14159265f/180);
57  float sinA = sin(degrees*3.14159265f/180);
58 
59  // Calculate a rotation matrix for the RGB colorspace (based on the current hue shift keyframe value)
60  float matrix[3] = {
61  cosA + (1.0f - cosA) / 3.0f,
62  1.0f/3.0f * (1.0f - cosA) - sqrtf(1.0f/3.0f) * sinA,
63  1.0f/3.0f * (1.0f - cosA) + sqrtf(1.0f/3.0f) * sinA
64  };
65 
66  // Loop through pixels
67  unsigned char *pixels = (unsigned char *) frame_image->bits();
68 
69  #pragma omp parallel for shared (pixels)
70  for (int pixel = 0; pixel < pixel_count; ++pixel)
71  {
72  // Get the RGB values from the pixel (ignore the alpha channel)
73  int R = pixels[pixel * 4];
74  int G = pixels[pixel * 4 + 1];
75  int B = pixels[pixel * 4 + 2];
76 
77  // Multiply each color by the hue rotation matrix
78  pixels[pixel * 4] = constrain(R * matrix[0] + G * matrix[1] + B * matrix[2]);
79  pixels[pixel * 4 + 1] = constrain(R * matrix[2] + G * matrix[0] + B * matrix[1]);
80  pixels[pixel * 4 + 2] = constrain(R * matrix[1] + G * matrix[2] + B * matrix[0]);
81  }
82 
83  // return the modified frame
84  return frame;
85 }
86 
87 // Generate JSON string of this object
88 std::string Hue::Json() const {
89 
90  // Return formatted string
91  return JsonValue().toStyledString();
92 }
93 
94 // Generate Json::Value for this object
95 Json::Value Hue::JsonValue() const {
96 
97  // Create root json object
98  Json::Value root = EffectBase::JsonValue(); // get parent properties
99  root["type"] = info.class_name;
100  root["hue"] = hue.JsonValue();
101 
102  // return JsonValue
103  return root;
104 }
105 
106 // Load JSON string into this object
107 void Hue::SetJson(const std::string value) {
108 
109  // Parse JSON string into JSON objects
110  try
111  {
112  const Json::Value root = openshot::stringToJson(value);
113  // Set all values that match
114  SetJsonValue(root);
115  }
116  catch (const std::exception& e)
117  {
118  // Error parsing JSON (or missing keys)
119  throw InvalidJSON("JSON is invalid (missing keys or invalid data types)");
120  }
121 }
122 
123 // Load Json::Value into this object
124 void Hue::SetJsonValue(const Json::Value root) {
125 
126  // Set parent data
128 
129  // Set data from Json (if key is found)
130  if (!root["hue"].isNull())
131  hue.SetJsonValue(root["hue"]);
132 }
133 
134 // Get all properties for a specific frame
135 std::string Hue::PropertiesJSON(int64_t requested_frame) const {
136 
137  // Generate JSON properties list
138  Json::Value root;
139  root["id"] = add_property_json("ID", 0.0, "string", Id(), NULL, -1, -1, true, requested_frame);
140  root["position"] = add_property_json("Position", Position(), "float", "", NULL, 0, 1000 * 60 * 30, false, requested_frame);
141  root["layer"] = add_property_json("Track", Layer(), "int", "", NULL, 0, 20, false, requested_frame);
142  root["start"] = add_property_json("Start", Start(), "float", "", NULL, 0, 1000 * 60 * 30, false, requested_frame);
143  root["end"] = add_property_json("End", End(), "float", "", NULL, 0, 1000 * 60 * 30, false, requested_frame);
144  root["duration"] = add_property_json("Duration", Duration(), "float", "", NULL, 0, 1000 * 60 * 30, true, requested_frame);
145 
146  // Keyframes
147  root["hue"] = add_property_json("Hue", hue.GetValue(requested_frame), "float", "", &hue, 0.0, 1.0, false, requested_frame);
148 
149  // Set the parent effect which properties this effect will inherit
150  root["parent_effect_id"] = add_property_json("Parent", 0.0, "string", info.parent_effect_id, NULL, -1, -1, false, requested_frame);
151 
152  // Return formatted string
153  return root.toStyledString();
154 }
Keyframe hue
Shift the hue coordinates (left or right)
Definition: Hue.h:43
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Hue.cpp:135
void SetJson(const std::string value) override
Load JSON string into this object.
Definition: Hue.cpp:107
std::string Id() const
Get the Id of this clip object.
Definition: ClipBase.h:85
Hue()
Default constructor, useful when using Json to load the effect properties.
Definition: Hue.cpp:19
float Start() const
Get start position (in seconds) of clip (trim start of video)
Definition: ClipBase.h:88
virtual void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition: EffectBase.cpp:112
virtual float End() const
Get end position (in seconds) of clip (trim end of video)
Definition: ClipBase.h:89
const Json::Value stringToJson(const std::string value)
Definition: Json.cpp:16
virtual Json::Value JsonValue() const
Generate Json::Value for this object.
Definition: EffectBase.cpp:77
bool has_audio
Determines if this effect manipulates the audio of a frame.
Definition: EffectBase.h:41
Header file for all Exception classes.
This class shifts the hue of an image, and can be animated with openshot::Keyframe curves over time...
Definition: Hue.h:35
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Hue.cpp:95
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 Json() const override
Generate JSON string of this object.
Definition: Hue.cpp:88
Header file for Hue effect class.
float Duration() const
Get the length of this clip (in seconds)
Definition: ClipBase.h:90
void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition: KeyFrame.cpp:358
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:28
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: Hue.h:59
Json::Value JsonValue() const
Generate Json::Value for this object.
Definition: KeyFrame.cpp:325
std::string description
The description of this effect and what it does.
Definition: EffectBase.h:38
bool has_video
Determines if this effect manipulates the image of a frame.
Definition: EffectBase.h:40
Exception for invalid JSON.
Definition: Exceptions.h:217
double GetValue(int64_t index) const
Get the value at a specific index.
Definition: KeyFrame.cpp:258
int constrain(int color_value)
Constrain a color value from 0 to 255.
Definition: EffectBase.cpp:58
std::string parent_effect_id
Id of the parent effect (if there is one)
Definition: EffectBase.h:39
float Position() const
Get position on timeline (in seconds)
Definition: ClipBase.h:86
A Keyframe is a collection of Point instances, which is used to vary a number or property over time...
Definition: KeyFrame.h:54
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
int Layer() const
Get layer of clip on timeline (lower number is covered by higher numbers)
Definition: ClipBase.h:87
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition: Hue.cpp:124
EffectInfoStruct info
Information about the current effect.
Definition: EffectBase.h:69