OpenShot Library | libopenshot  0.1.9
Public Member Functions | Public Attributes | List of all members
openshot::Mask Class Reference

This class uses the ImageMagick++ 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>

Inheritance diagram for openshot::Mask:
openshot::EffectBase openshot::ClipBase

Public Member Functions

std::shared_ptr< FrameGetFrame (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...
 
string Json ()
 Get and Set JSON methods. More...
 
Json::Value JsonValue ()
 Generate Json::JsonValue 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)
 
string PropertiesJSON (int64_t requested_frame)
 
ReaderBaseReader ()
 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 (string value)
 Load JSON string into this object. More...
 
void SetJsonValue (Json::Value root)
 Load Json::JsonValue into this object. More...
 
- Public Member Functions inherited from openshot::EffectBase
void DisplayInfo ()
 Display effect information in the standard output stream (stdout) More...
 
void InitEffectInfo ()
 
Json::Value JsonInfo ()
 Generate JSON object of meta data / info. More...
 
int Order ()
 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...
 
- Public Member Functions inherited from openshot::ClipBase
 ClipBase ()
 Constructor for the base clip. More...
 
float Duration ()
 Get the length of this clip (in seconds) More...
 
float End ()
 Get end position (in seconds) of clip (trim end of video) More...
 
void End (float value)
 Set end position (in seconds) of clip (trim end of video) More...
 
string Id ()
 Get basic properties. More...
 
void Id (string value)
 Set basic properties. More...
 
int Layer ()
 Get layer of clip on timeline (lower number is covered by higher numbers) More...
 
void Layer (int value)
 Set layer of clip on timeline (lower number is covered by higher numbers) More...
 
bool operator< (ClipBase &a)
 
bool operator<= (ClipBase &a)
 
bool operator> (ClipBase &a)
 
bool operator>= (ClipBase &a)
 
float Position ()
 Get position on timeline (in seconds) More...
 
void Position (float value)
 

Set the Id of this clip object

More...
 
void SetMaxSize (int width, int height)
 Set Max Image Size (used for performance optimization) More...
 
float Start ()
 Get start position (in seconds) of clip (trim start of video) More...
 
void Start (float value)
 Set start position (in seconds) of clip (trim start of video) More...
 

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...
 
- Public Attributes inherited from openshot::EffectBase
EffectInfoStruct info
 Information about the current effect. More...
 

Additional Inherited Members

- Protected Member Functions inherited from openshot::ClipBase
Json::Value add_property_choice_json (string name, int value, int selected_value)
 Generate JSON choice for a property (dropdown properties) More...
 
Json::Value add_property_json (string name, float value, string type, string memo, Keyframe *keyframe, float min_value, float max_value, bool readonly, int64_t requested_frame)
 Generate JSON for a property. More...
 
- Protected Attributes inherited from openshot::ClipBase
float end
 The position in seconds to end playing (used to trim the ending of a clip) More...
 
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...
 
int max_height
 The maximium image height needed by this clip (used for optimizations) More...
 
int max_width
 The maximum image width needed by this clip (used for optimizations) More...
 
float position
 The position on the timeline where this clip should start playing. More...
 
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...
 

Detailed Description

This class uses the ImageMagick++ 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.

Definition at line 63 of file Mask.h.

Constructor & Destructor Documentation

◆ Mask() [1/2]

Mask::Mask ( )

Blank constructor, useful when using Json to load the effect properties.

Definition at line 33 of file Mask.cpp.

◆ Mask() [2/2]

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.

Parameters
mask_readerThe reader of a grayscale mask image or video, to be used by the wipe transition
mask_brightnessThe curve to adjust the brightness of the wipe's mask (between 100 and -100)
mask_contrastThe curve to adjust the contrast of the wipe's mask (3 is typical, 20 is a lot, 0 is invalid)

Definition at line 39 of file Mask.cpp.

Member Function Documentation

◆ GetFrame()

std::shared_ptr< Frame > Mask::GetFrame ( std::shared_ptr< Frame frame,
int64_t  frame_number 
)
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 it's keyframes (starting at 1).

Returns
The modified openshot::Frame object
Parameters
frameThe frame object that needs the effect applied to it
frame_numberThe frame number (starting at 1) of the effect on the timeline.

Implements openshot::EffectBase.

Definition at line 110 of file Mask.cpp.

◆ Json()

string Mask::Json ( )
virtual

Get and Set JSON methods.

Generate JSON string of this object

Implements openshot::EffectBase.

Definition at line 168 of file Mask.cpp.

◆ JsonValue()

Json::Value Mask::JsonValue ( )
virtual

Generate Json::JsonValue for this object.

Implements openshot::EffectBase.

Definition at line 175 of file Mask.cpp.

◆ PropertiesJSON()

string Mask::PropertiesJSON ( int64_t  requested_frame)
virtual

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.

Definition at line 279 of file Mask.cpp.

◆ Reader() [1/2]

ReaderBase* openshot::Mask::Reader ( )
inline

Get the reader object of the mask grayscale image.

Definition at line 117 of file Mask.h.

◆ Reader() [2/2]

void openshot::Mask::Reader ( ReaderBase new_reader)
inline

Set a new reader to be used by the mask effect (grayscale image)

Definition at line 120 of file Mask.h.

◆ SetJson()

void Mask::SetJson ( string  value)
virtual

Load JSON string into this object.

Implements openshot::EffectBase.

Definition at line 193 of file Mask.cpp.

◆ SetJsonValue()

void Mask::SetJsonValue ( Json::Value  root)
virtual

Load Json::JsonValue into this object.

Implements openshot::EffectBase.

Definition at line 216 of file Mask.cpp.

Member Data Documentation

◆ brightness

Keyframe openshot::Mask::brightness

Brightness keyframe to control the wipe / mask effect. A constant value here will prevent animation.

Definition at line 80 of file Mask.h.

◆ contrast

Keyframe openshot::Mask::contrast

Contrast keyframe to control the hardness of the wipe effect / mask.

Definition at line 81 of file Mask.h.

◆ replace_image

bool openshot::Mask::replace_image

Replace the frame image with a grayscale image representing the mask. Great for debugging a mask.

Definition at line 79 of file Mask.h.


The documentation for this class was generated from the following files: