Loading...
Searching...
No Matches
ChromaKey.h
Go to the documentation of this file.
// Copyright (c) 2008-2019 OpenShot Studios, LLC
//
// SPDX-License-Identifier: LGPL-3.0-or-later
#ifndef OPENSHOT_CHROMAKEY_EFFECT_H
#define OPENSHOT_CHROMAKEY_EFFECT_H
#include "../EffectBase.h"
#include "../Color.h"
#include "../Frame.h"
#include "../Exceptions.h"
#include "../KeyFrame.h"
#include "../Enums.h"
#include <memory>
#include <string>
namespace openshot
{
class ChromaKey : public EffectBase
{
private:
Color color;
Keyframe fuzz;
Keyframe halo;
ChromaKeyMethod method;
void init_effect_details();
public:
ChromaKey();
ChromaKey(Color color, Keyframe fuzz, Keyframe halo = 0.0, ChromaKeyMethod method = CHROMAKEY_BASIC);
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;
// Get and Set JSON methods
std::string Json() const override;
void SetJson(const std::string value) override;
Json::Value JsonValue() const override;
void SetJsonValue(const Json::Value root) override;
// Get all properties for a specific frame
std::string PropertiesJSON(int64_t requested_frame) const override;
};
}
#endif
Color.h
Header file for Color class.
EffectBase.h
Header file for EffectBase class.
Enums.h
Header file for TextReader class.
Exceptions.h
Header file for all Exception classes.
Frame.h
Header file for Frame class.
KeyFrame.h
Header file for the Keyframe class.
openshot::ChromaKey::SetJson
void SetJson(const std::string value) override
Load JSON string into this object.
Definition ChromaKey.cpp:539
openshot::ChromaKey::ChromaKey
ChromaKey()
Blank constructor, useful when using Json to load the effect properties.
Definition ChromaKey.cpp:25
openshot::ChromaKey::Json
std::string Json() const override
Generate JSON string of this object.
Definition ChromaKey.cpp:517
openshot::ChromaKey::PropertiesJSON
std::string PropertiesJSON(int64_t requested_frame) const override
Definition ChromaKey.cpp:573
openshot::ChromaKey::JsonValue
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition ChromaKey.cpp:524
openshot::ChromaKey::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 ChromaKey.h:87
openshot::ChromaKey::SetJsonValue
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition ChromaKey.cpp:556
openshot::Color
This class represents a color (used on the timeline and clips).
Definition Color.h:27
openshot::EffectBase
This abstract class is the base class, used by all effects in libopenshot.
Definition EffectBase.h:54
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::ChromaKeyMethod
ChromaKeyMethod
This enumeration determines the algorithm used by the ChromaKey filter.
Definition Enums.h:159
openshot::CHROMAKEY_BASIC
@ CHROMAKEY_BASIC
Length of difference between RGB vectors.
Definition Enums.h:160