Loading...
Searching...
No Matches
Hue.cpp
Go to the documentation of this file.
// Copyright (c) 2008-2019 OpenShot Studios, LLC
//
// SPDX-License-Identifier: LGPL-3.0-or-later
#include "Hue.h"
#include "Exceptions.h"
using namespace openshot;
Hue::Hue() : Hue(0.0) {
// Init effect properties
init_effect_details();
}
// Default constructor
Hue::Hue(Keyframe hue): hue(hue)
{
// Init effect properties
init_effect_details();
}
// Init effect settings
void Hue::init_effect_details()
{
InitEffectInfo();
info.class_name = "Hue";
info.name = "Hue";
info.description = "Adjust the hue / color of the frame's image.";
info.has_audio = false;
info.has_video = true;
}
// This method is required for all derived classes of EffectBase, and returns a
// modified openshot::Frame object
std::shared_ptr<openshot::Frame> Hue::GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number)
{
// Get the frame's image
std::shared_ptr<QImage> frame_image = frame->GetImage();
int pixel_count = frame_image->width() * frame_image->height();
// Get the current hue percentage shift amount, and convert to degrees
double degrees = 360.0 * hue.GetValue(frame_number);
float cosA = cos(degrees*3.14159265f/180);
float sinA = sin(degrees*3.14159265f/180);
// Calculate a rotation matrix for the RGB colorspace (based on the current hue shift keyframe value)
float matrix[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
};
// Loop through pixels
unsigned char *pixels = (unsigned char *) frame_image->bits();
#pragma omp parallel for shared (pixels)
for (int pixel = 0; pixel < pixel_count; ++pixel)
{
// Calculate alpha % (to be used for removing pre-multiplied alpha value)
int A = pixels[pixel * 4 + 3];
float alpha_percent = A / 255.0;
// Get RGB values, and remove pre-multiplied alpha
int R = pixels[pixel * 4 + 0] / alpha_percent;
int G = pixels[pixel * 4 + 1] / alpha_percent;
int B = pixels[pixel * 4 + 2] / alpha_percent;
// Multiply each color by the hue rotation matrix
pixels[pixel * 4] = constrain(R * matrix[0] + G * matrix[1] + B * matrix[2]);
pixels[pixel * 4 + 1] = constrain(R * matrix[2] + G * matrix[0] + B * matrix[1]);
pixels[pixel * 4 + 2] = constrain(R * matrix[1] + G * matrix[2] + B * matrix[0]);
// Pre-multiply the alpha back into the color channels
pixels[pixel * 4 + 0] *= alpha_percent;
pixels[pixel * 4 + 1] *= alpha_percent;
pixels[pixel * 4 + 2] *= alpha_percent;
}
// return the modified frame
return frame;
}
// Generate JSON string of this object
std::string Hue::Json() const {
// Return formatted string
return JsonValue().toStyledString();
}
// Generate Json::Value for this object
Json::Value Hue::JsonValue() const {
// Create root json object
Json::Value root = EffectBase::JsonValue(); // get parent properties
root["type"] = info.class_name;
root["hue"] = hue.JsonValue();
// return JsonValue
return root;
}
// Load JSON string into this object
void Hue::SetJson(const std::string value) {
// Parse JSON string into JSON objects
try
{
const Json::Value root = openshot::stringToJson(value);
// Set all values that match
SetJsonValue(root);
}
catch (const std::exception& e)
{
// Error parsing JSON (or missing keys)
throw InvalidJSON("JSON is invalid (missing keys or invalid data types)");
}
}
// Load Json::Value into this object
void Hue::SetJsonValue(const Json::Value root) {
// Set parent data
EffectBase::SetJsonValue(root);
// Set data from Json (if key is found)
if (!root["hue"].isNull())
hue.SetJsonValue(root["hue"]);
}
// Get all properties for a specific frame
std::string Hue::PropertiesJSON(int64_t requested_frame) const {
// Generate JSON properties list
Json::Value root = BasePropertiesJSON(requested_frame);
// Keyframes
root["hue"] = add_property_json("Hue", hue.GetValue(requested_frame), "float", "", &hue, 0.0, 1.0, false, requested_frame);
// Return formatted string
return root.toStyledString();
}
Exceptions.h
Header file for all Exception classes.
Hue.h
Header file for Hue effect class.
openshot::ClipBase::add_property_json
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
openshot::EffectBase::JsonValue
virtual Json::Value JsonValue() const
Generate Json::Value for this object.
Definition EffectBase.cpp:79
openshot::EffectBase::constrain
int constrain(int color_value)
Constrain a color value from 0 to 255.
Definition EffectBase.cpp:60
openshot::EffectBase::InitEffectInfo
void InitEffectInfo()
Definition EffectBase.cpp:24
openshot::EffectBase::BasePropertiesJSON
Json::Value BasePropertiesJSON(int64_t requested_frame) const
Generate JSON object of base properties (recommended to be used by all effects).
Definition EffectBase.cpp:179
openshot::EffectBase::SetJsonValue
virtual void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition EffectBase.cpp:115
openshot::EffectBase::info
EffectInfoStruct info
Information about the current effect.
Definition EffectBase.h:69
openshot::Hue::hue
Keyframe hue
Shift the hue coordinates (left or right).
Definition Hue.h:43
openshot::Hue::SetJsonValue
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition Hue.cpp:133
openshot::Hue::Hue
Hue()
Default constructor, useful when using Json to load the effect properties.
Definition Hue.cpp:19
openshot::Hue::SetJson
void SetJson(const std::string value) override
Load JSON string into this object.
Definition Hue.cpp:116
openshot::Hue::PropertiesJSON
std::string PropertiesJSON(int64_t requested_frame) const override
Definition Hue.cpp:144
openshot::Hue::GetFrame
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
openshot::Hue::Json
std::string Json() const override
Generate JSON string of this object.
Definition Hue.cpp:97
openshot::Hue::JsonValue
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition Hue.cpp:104
openshot::InvalidJSON
Exception for invalid JSON.
Definition Exceptions.h:218
openshot::Keyframe
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
Definition KeyFrame.h:53
openshot
This namespace is the default namespace for all code in the openshot library.
Definition Compressor.h:29
openshot::stringToJson
const Json::Value stringToJson(const std::string value)
Definition Json.cpp:16
openshot::EffectInfoStruct::has_video
bool has_video
Determines if this effect manipulates the image of a frame.
Definition EffectBase.h:40
openshot::EffectInfoStruct::has_audio
bool has_audio
Determines if this effect manipulates the audio of a frame.
Definition EffectBase.h:41
openshot::EffectInfoStruct::class_name
std::string class_name
The class name of the effect.
Definition EffectBase.h:36
openshot::EffectInfoStruct::name
std::string name
The name of the effect.
Definition EffectBase.h:37
openshot::EffectInfoStruct::description
std::string description
The description of this effect and what it does.
Definition EffectBase.h:38