OpenShot Library | libopenshot
0.2.5
|
This class uses the image libraries to apply alpha (or transparency) masks to any frame. It can also be animated, and used as a powerful Wipe transition. More...
#include <Mask.h>
Public Member Functions | |
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 object. More... | |
std::string | Json () const override |
Get and Set JSON methods. More... | |
Json::Value | JsonValue () const override |
Generate Json::Value for this object. More... | |
Mask () | |
Blank constructor, useful when using Json to load the effect properties. More... | |
Mask (ReaderBase *mask_reader, Keyframe mask_brightness, Keyframe mask_contrast) | |
std::string | PropertiesJSON (int64_t requested_frame) const override |
ReaderBase * | Reader () |
Get the reader object of the mask grayscale image. More... | |
void | Reader (ReaderBase *new_reader) |
Set a new reader to be used by the mask effect (grayscale image) More... | |
void | SetJson (const std::string value) |
Load JSON string into this object. More... | |
void | SetJsonValue (const Json::Value root) |
Load Json::Value into this object. More... | |
![]() | |
int | constrain (int color_value) |
Constrain a color value from 0 to 255. More... | |
void | DisplayInfo () |
Display effect information in the standard output stream (stdout) More... | |
void | InitEffectInfo () |
Json::Value | JsonInfo () const |
Generate JSON object of meta data / info. More... | |
int | Order () const |
Get the order that this effect should be executed. More... | |
void | Order (int new_order) |
Set the order that this effect should be executed. More... | |
virtual | ~EffectBase ()=default |
![]() | |
ClipBase () | |
Constructor for the base clip. More... | |
void | Id (std::string value) |
Set basic properties. More... | |
bool | operator< (ClipBase &a) |
bool | operator<= (ClipBase &a) |
bool | operator> (ClipBase &a) |
bool | operator>= (ClipBase &a) |
virtual | ~ClipBase ()=default |
Public Attributes | |
Keyframe | brightness |
Brightness keyframe to control the wipe / mask effect. A constant value here will prevent animation. More... | |
Keyframe | contrast |
Contrast keyframe to control the hardness of the wipe effect / mask. More... | |
bool | replace_image |
Replace the frame image with a grayscale image representing the mask. Great for debugging a mask. More... | |
![]() | |
EffectInfoStruct | info |
Information about the current effect. More... | |
Additional Inherited Members | |
![]() | |
Json::Value | add_property_choice_json (std::string name, int value, int selected_value) const |
Generate JSON choice for a property (dropdown properties) More... | |
Json::Value | add_property_json (std::string name, float value, std::string type, std::string memo, const Keyframe *keyframe, float min_value, float max_value, bool readonly, int64_t requested_frame) const |
Generate JSON for a property. More... | |
![]() | |
float | end |
The position in seconds to end playing (used to trim the ending of a clip) More... | |
std::string | id |
ID Property for all derived Clip and Effect classes. More... | |
int | layer |
The layer this clip is on. Lower clips are covered up by higher clips. More... | |
float | position |
The position on the timeline where this clip should start playing. More... | |
std::string | previous_properties |
This string contains the previous JSON properties. More... | |
float | start |
The position in seconds to start playing (used to trim the beginning of a clip) More... | |
This class uses the image libraries to apply alpha (or transparency) masks to any frame. It can also be animated, and used as a powerful Wipe transition.
These masks / wipes can also be combined, such as a transparency mask on top of a clip, which is then wiped away with another animated version of this effect.
Mask::Mask | ( | ) |
Mask::Mask | ( | ReaderBase * | mask_reader, |
Keyframe | mask_brightness, | ||
Keyframe | mask_contrast | ||
) |
Default constructor, which takes 2 curves and a mask image path. The mask is used to determine the alpha for each pixel (black is transparent, white is visible). The curves adjust the brightness and contrast of this file, to animate the effect.
mask_reader | The reader of a grayscale mask image or video, to be used by the wipe transition |
mask_brightness | The curve to adjust the brightness of the wipe's mask (between 100 and -100) |
mask_contrast | The curve to adjust the contrast of the wipe's mask (3 is typical, 20 is a lot, 0 is invalid) |
|
virtual |
This method is required for all derived classes of EffectBase, and returns a modified openshot::Frame object.
The frame object is passed into this method, and a frame_number is passed in which tells the effect which settings to use from its keyframes (starting at 1).
frame | The frame object that needs the effect applied to it |
frame_number | The frame number (starting at 1) of the effect on the timeline. |
Implements openshot::EffectBase.
|
overridevirtual |
|
overridevirtual |
Generate Json::Value for this object.
Implements openshot::EffectBase.
Definition at line 160 of file Mask.cpp.
Referenced by Json().
|
overridevirtual |
Get all properties for a specific frame (perfect for a UI to display the current state of all properties at any time)
Implements openshot::ClipBase.
|
inline |
|
inline |
|
virtual |
Load JSON string into this object.
Implements openshot::EffectBase.
|
virtual |
Load Json::Value into this object.
Implements openshot::EffectBase.
Definition at line 195 of file Mask.cpp.
Referenced by SetJson().
Keyframe openshot::Mask::brightness |
Brightness keyframe to control the wipe / mask effect. A constant value here will prevent animation.
Definition at line 77 of file Mask.h.
Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().
Keyframe openshot::Mask::contrast |
Contrast keyframe to control the hardness of the wipe effect / mask.
Definition at line 78 of file Mask.h.
Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().
bool openshot::Mask::replace_image |
Replace the frame image with a grayscale image representing the mask. Great for debugging a mask.
Definition at line 76 of file Mask.h.
Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().