ColorGrade.h

Go to the documentation of this file.

 
// Copyright (c) 2008-2026 OpenShot Studios, LLC
//
// SPDX-License-Identifier: LGPL-3.0-or-later
 
#ifndef OPENSHOT_COLOR_GRADE_EFFECT_H
#define OPENSHOT_COLOR_GRADE_EFFECT_H
 
#include "../AnimatedCurve.h"
#include "../EffectBase.h"
#include "../Color.h"
#include "../Frame.h"
#include "../Json.h"
#include "../KeyFrame.h"
#include "ColorMap.h"
 
#include <QColor>
 
#include <array>
#include <string>
#include <utility>
#include <vector>
 
namespace openshot
{
    struct ColorGradeWheelEntry {
        Color color;
        Keyframe amount;
        Keyframe luma;
 
        ColorGradeWheelEntry();
        Json::Value JsonValue() const;
        void SetJsonValue(const Json::Value& root);
        QColor GetColor(int64_t frame_number) const;
        float GetAmount(int64_t frame_number) const;
        float GetLuma(int64_t frame_number) const;
    };
 
    struct ColorGradeWheelsData {
        Keyframe enabled;
        ColorGradeWheelEntry global;
        ColorGradeWheelEntry shadows;
        ColorGradeWheelEntry midtones;
        ColorGradeWheelEntry highlights;
 
        ColorGradeWheelsData();
        Json::Value JsonValue() const;
        void SetJsonValue(const Json::Value& root);
        std::string Summary(int64_t frame_number) const;
        bool IsEnabled(int64_t frame_number) const;
    };
 
    class ColorGrade : public EffectBase
    {
    private:
        ColorMap lut_effect;
        std::string lut_path;
        bool lut_dirty;
 
        void init_effect_details();
        void sync_lut_effect();
 
        static float Clamp01(float value);
 
    public:
        Keyframe temperature;
        Keyframe tint;
        Keyframe exposure;
        Keyframe contrast;
        Keyframe highlights;
        Keyframe shadows;
        Keyframe saturation;
        Keyframe vibrance;
        Keyframe mix;
        Keyframe lut_intensity;
 
        ColorGradeWheelsData wheels;
        AnimatedCurve curve_all;
        AnimatedCurve curve_red;
        AnimatedCurve curve_green;
        AnimatedCurve curve_blue;
 
        ColorGrade();
 
        std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override {
            return GetFrame(std::make_shared<openshot::Frame>(), frame_number);
        }
        std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
 
        std::string Json() const override;
        Json::Value JsonValue() const override;
        void SetJson(const std::string value) override;
        void SetJsonValue(const Json::Value root) override;
        std::string PropertiesJSON(int64_t requested_frame) const override;
    };
}
 
#endif