OpenShot Library | libopenshot
0.2.5
|
Go to the documentation of this file.
31 #ifndef OPENSHOT_MASK_EFFECT_H
32 #define OPENSHOT_MASK_EFFECT_H
34 #include "../EffectBase.h"
43 #include "../Exceptions.h"
45 #include "../KeyFrame.h"
46 #include "../ReaderBase.h"
47 #include "../FFmpegReader.h"
48 #include "../QtImageReader.h"
49 #include "../ChunkReader.h"
50 #ifdef USE_IMAGEMAGICK
51 #include "../MagickUtilities.h"
52 #include "../ImageReader.h"
69 std::shared_ptr<QImage> original_mask;
73 void init_effect_details();
101 std::shared_ptr<Frame>
GetFrame(std::shared_ptr<Frame> frame, int64_t frame_number);
104 std::string
Json()
const override;
105 void SetJson(
const std::string value);
111 std::string
PropertiesJSON(int64_t requested_frame)
const override;
void Reader(ReaderBase *new_reader)
Set a new reader to be used by the mask effect (grayscale image)
Json::Value JsonValue() const override
Generate Json::Value for this object.
This abstract class is the base class, used by all effects in libopenshot.
This class uses the image libraries to apply alpha (or transparency) masks to any frame....
void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
This namespace is the default namespace for all code in the openshot library.
Keyframe contrast
Contrast keyframe to control the hardness of the wipe effect / mask.
Mask()
Blank constructor, useful when using Json to load the effect properties.
std::string PropertiesJSON(int64_t requested_frame) const override
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
std::shared_ptr< Frame > GetFrame(std::shared_ptr< Frame > frame, int64_t frame_number)
This method is required for all derived classes of EffectBase, and returns a modified openshot::Frame...
bool replace_image
Replace the frame image with a grayscale image representing the mask. Great for debugging a mask.
void SetJson(const std::string value)
Load JSON string into this object.
std::string Json() const override
Get and Set JSON methods.
This abstract class is the base class, used by all readers in libopenshot.
ReaderBase * Reader()
Get the reader object of the mask grayscale image.
Keyframe brightness
Brightness keyframe to control the wipe / mask effect. A constant value here will prevent animation.