Loading...
Searching...
No Matches
Brightness.cpp
Go to the documentation of this file.
// Copyright (c) 2008-2019 OpenShot Studios, LLC
//
// SPDX-License-Identifier: LGPL-3.0-or-later
#include "Brightness.h"
#include "Exceptions.h"
using namespace openshot;
Brightness::Brightness() : brightness(0.0), contrast(3.0) {
// Init effect properties
init_effect_details();
}
// Default constructor
Brightness::Brightness(Keyframe new_brightness, Keyframe new_contrast) : brightness(new_brightness), contrast(new_contrast)
{
// Init effect properties
init_effect_details();
}
// Init effect settings
void Brightness::init_effect_details()
{
InitEffectInfo();
info.class_name = "Brightness";
info.name = "Brightness & Contrast";
info.description = "Adjust the brightness and contrast 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> Brightness::GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number)
{
// Get the frame's image
std::shared_ptr<QImage> frame_image = frame->GetImage();
// Get keyframe values for this frame
float brightness_value = brightness.GetValue(frame_number);
float contrast_value = contrast.GetValue(frame_number);
// Loop through pixels
unsigned char *pixels = (unsigned char *) frame_image->bits();
int pixel_count = frame_image->width() * frame_image->height();
#pragma omp parallel for
for (int pixel = 0; pixel < pixel_count; ++pixel)
{
// Compute contrast adjustment factor
float factor = (259 * (contrast_value + 255)) / (255 * (259 - contrast_value));
// 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
unsigned char R = pixels[pixel * 4 + 0] / alpha_percent;
unsigned char G = pixels[pixel * 4 + 1] / alpha_percent;
unsigned char B = pixels[pixel * 4 + 2] / alpha_percent;
// Apply constrained contrast adjustment
R = constrain((factor * (R - 128)) + 128);
G = constrain((factor * (G - 128)) + 128);
B = constrain((factor * (B - 128)) + 128);
// Adjust brightness and write constrained values back to image
pixels[pixel * 4 + 0] = constrain(R + (255 * brightness_value));
pixels[pixel * 4 + 1] = constrain(G + (255 * brightness_value));
pixels[pixel * 4 + 2] = constrain(B + (255 * brightness_value));
// 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 Brightness::Json() const {
// Return formatted string
return JsonValue().toStyledString();
}
// Generate Json::Value for this object
Json::Value Brightness::JsonValue() const {
// Create root json object
Json::Value root = EffectBase::JsonValue(); // get parent properties
root["type"] = info.class_name;
root["brightness"] = brightness.JsonValue();
root["contrast"] = contrast.JsonValue();
// return JsonValue
return root;
}
// Load JSON string into this object
void Brightness::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 Brightness::SetJsonValue(const Json::Value root) {
// Set parent data
EffectBase::SetJsonValue(root);
// Set data from Json (if key is found)
if (!root["brightness"].isNull())
brightness.SetJsonValue(root["brightness"]);
if (!root["contrast"].isNull())
contrast.SetJsonValue(root["contrast"]);
}
// Get all properties for a specific frame
std::string Brightness::PropertiesJSON(int64_t requested_frame) const {
// Generate JSON properties list
Json::Value root;
root["id"] = add_property_json("ID", 0.0, "string", Id(), NULL, -1, -1, true, requested_frame);
root["position"] = add_property_json("Position", Position(), "float", "", NULL, 0, 30 * 60 * 60 * 48, false, requested_frame);
root["layer"] = add_property_json("Track", Layer(), "int", "", NULL, 0, 20, false, requested_frame);
root["start"] = add_property_json("Start", Start(), "float", "", NULL, 0, 30 * 60 * 60 * 48, false, requested_frame);
root["end"] = add_property_json("End", End(), "float", "", NULL, 0, 30 * 60 * 60 * 48, false, requested_frame);
root["duration"] = add_property_json("Duration", Duration(), "float", "", NULL, 0, 30 * 60 * 60 * 48, true, requested_frame);
// Keyframes
root["brightness"] = add_property_json("Brightness", brightness.GetValue(requested_frame), "float", "", &brightness, -1.0, 1.0, false, requested_frame);
root["contrast"] = add_property_json("Contrast", contrast.GetValue(requested_frame), "float", "", &contrast, -128, 128.0, false, requested_frame);
// Set the parent effect which properties this effect will inherit
root["parent_effect_id"] = add_property_json("Parent", 0.0, "string", info.parent_effect_id, NULL, -1, -1, false, requested_frame);
// Return formatted string
return root.toStyledString();
}
Brightness.h
Header file for Brightness class.
Exceptions.h
Header file for all Exception classes.
openshot::Brightness::brightness
Keyframe brightness
Brightness keyframe. A constant value here will prevent animation.
Definition Brightness.h:41
openshot::Brightness::Json
std::string Json() const override
Generate JSON string of this object.
Definition Brightness.cpp:96
openshot::Brightness::contrast
Keyframe contrast
Contrast keyframe.
Definition Brightness.h:42
openshot::Brightness::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 Brightness.h:60
openshot::Brightness::SetJsonValue
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition Brightness.cpp:133
openshot::Brightness::JsonValue
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition Brightness.cpp:103
openshot::Brightness::PropertiesJSON
std::string PropertiesJSON(int64_t requested_frame) const override
Definition Brightness.cpp:146
openshot::Brightness::Brightness
Brightness()
Blank constructor, useful when using Json to load the effect properties.
Definition Brightness.cpp:19
openshot::Brightness::SetJson
void SetJson(const std::string value) override
Load JSON string into this object.
Definition Brightness.cpp:116
openshot::ClipBase::Start
float Start() const
Get start position (in seconds) of clip (trim start of video)
Definition ClipBase.h:88
openshot::ClipBase::Duration
float Duration() const
Get the length of this clip (in seconds)
Definition ClipBase.h:90
openshot::ClipBase::End
virtual float End() const
Get end position (in seconds) of clip (trim end of video)
Definition ClipBase.h:89
openshot::ClipBase::Id
std::string Id() const
Get the Id of this clip object.
Definition ClipBase.h:85
openshot::ClipBase::Layer
int Layer() const
Get layer of clip on timeline (lower number is covered by higher numbers)
Definition ClipBase.h:87
openshot::ClipBase::Position
float Position() const
Get position on timeline (in seconds)
Definition ClipBase.h:86
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:77
openshot::EffectBase::constrain
int constrain(int color_value)
Constrain a color value from 0 to 255.
Definition EffectBase.cpp:58
openshot::EffectBase::InitEffectInfo
void InitEffectInfo()
Definition EffectBase.cpp:24
openshot::EffectBase::SetJsonValue
virtual void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition EffectBase.cpp:112
openshot::EffectBase::info
EffectInfoStruct info
Information about the current effect.
Definition EffectBase.h:69
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::Keyframe::SetJsonValue
void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition KeyFrame.cpp:372
openshot::Keyframe::GetValue
double GetValue(int64_t index) const
Get the value at a specific index.
Definition KeyFrame.cpp:258
openshot::Keyframe::JsonValue
Json::Value JsonValue() const
Generate Json::Value for this object.
Definition KeyFrame.cpp:339
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::parent_effect_id
std::string parent_effect_id
Id of the parent effect (if there is one)
Definition EffectBase.h:39
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