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), mask_mode(HUE_MASK_LIMIT_TO_AREA)
{
    // 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;
}
 
bool Hue::UseCustomMaskBlend(int64_t frame_number) const {
    (void) frame_number;
    return mask_mode == HUE_MASK_VARY_STRENGTH;
}
 
void Hue::ApplyCustomMaskBlend(std::shared_ptr<QImage> original_image, std::shared_ptr<QImage> effected_image,
                               std::shared_ptr<QImage> mask_image, int64_t frame_number) const {
    (void) frame_number;
    if (!original_image || !effected_image || !mask_image)
        return;
    if (original_image->size() != effected_image->size() || effected_image->size() != mask_image->size())
        return;
 
    unsigned char* original_pixels = reinterpret_cast<unsigned char*>(original_image->bits());
    unsigned char* effected_pixels = reinterpret_cast<unsigned char*>(effected_image->bits());
    unsigned char* mask_pixels = reinterpret_cast<unsigned char*>(mask_image->bits());
    const int pixel_count = effected_image->width() * effected_image->height();
 
    #pragma omp parallel for schedule(static)
    for (int i = 0; i < pixel_count; ++i) {
        const int idx = i * 4;
        float factor = static_cast<float>(qGray(mask_pixels[idx], mask_pixels[idx + 1], mask_pixels[idx + 2])) / 255.0f;
        if (mask_invert)
            factor = 1.0f - factor;
        factor = factor * factor;
        const float inverse = 1.0f - factor;
 
        effected_pixels[idx] = static_cast<unsigned char>(
            (original_pixels[idx] * inverse) + (effected_pixels[idx] * factor));
        effected_pixels[idx + 1] = static_cast<unsigned char>(
            (original_pixels[idx + 1] * inverse) + (effected_pixels[idx + 1] * factor));
        effected_pixels[idx + 2] = static_cast<unsigned char>(
            (original_pixels[idx + 2] * inverse) + (effected_pixels[idx + 2] * factor));
        effected_pixels[idx + 3] = original_pixels[idx + 3];
    }
}
 
// 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();
    root["mask_mode"] = mask_mode;
 
    // 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"]);
    if (!root["mask_mode"].isNull())
        mask_mode = root["mask_mode"].asInt();
}
 
// 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);
    root["mask_mode"] = add_property_json("Mask Mode", mask_mode, "int", "", NULL, 0, 1, false, requested_frame);
    root["mask_mode"]["choices"].append(add_property_choice_json("Limit to Mask", HUE_MASK_LIMIT_TO_AREA, mask_mode));
    root["mask_mode"]["choices"].append(add_property_choice_json("Vary Strength", HUE_MASK_VARY_STRENGTH, mask_mode));
 
    // Return formatted string
    return root.toStyledString();
}