You've already forked libopenshot
mirror of
https://github.com/OpenShot/libopenshot.git
synced 2026-03-02 08:53:52 -08:00
59138ea3e4
* reuse-managed license/copyright headers reuse is a tool for compliance with the REUSE recommendations. See <https://reuse.software/> for more information, and <https://reuse.readthedocs.io/> for the online documentation. * Set jsoncpp license * Add MIT license for Decklink sources * Explicitly license examples/ - Add headers to source files - Change blanket licensing in .reuse/dep5 to only cover binary media - Import CC-BY-3.0 license and assign to sintel_trailer
99 lines
4.2 KiB
C++
99 lines
4.2 KiB
C++
/**
|
|
* @file
|
|
* @brief Header file for Color Shift effect class
|
|
* @author Jonathan Thomas <jonathan@openshot.org>
|
|
*
|
|
* @ref License
|
|
*/
|
|
|
|
// Copyright (c) 2008-2019 OpenShot Studios, LLC
|
|
//
|
|
// SPDX-License-Identifier: LGPL-3.0-or-later
|
|
|
|
#ifndef OPENSHOT_COLOR_SHIFT_EFFECT_H
|
|
#define OPENSHOT_COLOR_SHIFT_EFFECT_H
|
|
|
|
#include "../EffectBase.h"
|
|
|
|
#include <cmath>
|
|
#include <stdio.h>
|
|
#include <memory>
|
|
#include "../Json.h"
|
|
#include "../KeyFrame.h"
|
|
|
|
|
|
namespace openshot
|
|
{
|
|
|
|
/**
|
|
* @brief This class shifts the pixels of an image up, down, left, or right, and can be animated
|
|
* with openshot::Keyframe curves over time.
|
|
*
|
|
* Shifting pixels can be used in many interesting ways, especially when animating the movement of the pixels.
|
|
* The pixels wrap around the image (the pixels drop off one side and appear on the other side of the image).
|
|
*/
|
|
class ColorShift : public EffectBase
|
|
{
|
|
private:
|
|
/// Init effect settings
|
|
void init_effect_details();
|
|
|
|
public:
|
|
Keyframe red_x; ///< Shift the Red X coordinates (left or right)
|
|
Keyframe red_y; ///< Shift the Red Y coordinates (up or down)
|
|
Keyframe green_x; ///< Shift the Green X coordinates (left or right)
|
|
Keyframe green_y; ///< Shift the Green Y coordinates (up or down)
|
|
Keyframe blue_x; ///< Shift the Blue X coordinates (left or right)
|
|
Keyframe blue_y; ///< Shift the Blue Y coordinates (up or down)
|
|
Keyframe alpha_x; ///< Shift the Alpha X coordinates (left or right)
|
|
Keyframe alpha_y; ///< Shift the Alpha Y coordinates (up or down)
|
|
|
|
/// Blank constructor, useful when using Json to load the effect properties
|
|
ColorShift();
|
|
|
|
/// Default constructor, which takes 8 curves. The curves will shift the RGBA pixels up, down, left, or right
|
|
///
|
|
/// @param red_x The curve to adjust the Red x shift (between -1 and 1, percentage)
|
|
/// @param red_y The curve to adjust the Red y shift (between -1 and 1, percentage)
|
|
/// @param green_x The curve to adjust the Green x shift (between -1 and 1, percentage)
|
|
/// @param green_y The curve to adjust the Green y shift (between -1 and 1, percentage)
|
|
/// @param blue_x The curve to adjust the Blue x shift (between -1 and 1, percentage)
|
|
/// @param blue_y The curve to adjust the Blue y shift (between -1 and 1, percentage)
|
|
/// @param alpha_x The curve to adjust the Alpha x shift (between -1 and 1, percentage)
|
|
/// @param alpha_y The curve to adjust the Alpha y shift (between -1 and 1, percentage)
|
|
ColorShift(Keyframe red_x, Keyframe red_y, Keyframe green_x, Keyframe green_y, Keyframe blue_x, Keyframe blue_y, Keyframe alpha_x, Keyframe alpha_y);
|
|
|
|
/// @brief This method is required for all derived classes of ClipBase, and returns a
|
|
/// new openshot::Frame object. All Clip keyframes and effects are resolved into
|
|
/// pixels.
|
|
///
|
|
/// @returns A new openshot::Frame object
|
|
/// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline.
|
|
std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override { return GetFrame(std::make_shared<openshot::Frame>(), frame_number); }
|
|
|
|
/// @brief This method is required for all derived classes of ClipBase, and returns a
|
|
/// modified openshot::Frame object
|
|
///
|
|
/// The frame object is passed into this method and used as a starting point (pixels and audio).
|
|
/// All Clip keyframes and effects are resolved into pixels.
|
|
///
|
|
/// @returns The modified openshot::Frame object
|
|
/// @param frame The frame object that needs the clip or effect applied to it
|
|
/// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline.
|
|
std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
|
|
|
|
// Get and Set JSON methods
|
|
std::string Json() const override; ///< Generate JSON string of this object
|
|
void SetJson(const std::string value) override; ///< Load JSON string into this object
|
|
Json::Value JsonValue() const override; ///< Generate Json::Value for this object
|
|
void SetJsonValue(const Json::Value root) override; ///< Load Json::Value into this object
|
|
|
|
/// Get all properties for a specific frame (perfect for a UI to display the current state
|
|
/// of all properties at any time)
|
|
std::string PropertiesJSON(int64_t requested_frame) const override;
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|