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

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 <effects/Mask.h>

Inheritance diagram for openshot::Mask:
[legend]
Collaboration diagram for openshot::Mask:
[legend]

Public Member Functions

std::shared_ptr< openshot::FrameGetFrame (int64_t frame_number) override
 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. More...
 
std::shared_ptr< openshot::FrameGetFrame (std::shared_ptr< openshot::Frame > frame, int64_t frame_number) override
 This method is required for all derived classes of ClipBase, and returns a modified openshot::Frame object. More...
 
std::string Json () const override
 Generate JSON string of this object. 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
 
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 (const std::string value) override
 Load JSON string into this object. More...
 
void SetJsonValue (const Json::Value root) override
 Load Json::Value into this object. More...
 
- Public Member Functions inherited from openshot::EffectBase
Json::Value BasePropertiesJSON (int64_t requested_frame) const
 Generate JSON object of base properties (recommended to be used by all effects) More...
 
int constrain (int color_value)
 Constrain a color value from 0 to 255. More...
 
void DisplayInfo (std::ostream *out=&std::cout)
 Display effect information in the standard output stream (stdout) More...
 
virtual std::string GetVisibleObjects (int64_t frame_number) const
 Get the indexes and IDs of all visible objects in the given frame. More...
 
void InitEffectInfo ()
 
virtual std::string Json (int64_t requested_frame) const
 
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...
 
openshot::ClipBaseParentClip ()
 Parent clip object of this effect (which can be unparented and NULL) More...
 
void ParentClip (openshot::ClipBase *new_clip)
 Set parent clip object of this effect. More...
 
std::string ParentClipId () const
 Return the ID of this effect's parent clip. More...
 
virtual void SetJson (int64_t requested_frame, const std::string value)
 
void SetParentEffect (std::string parentEffect_id)
 Set the parent effect from which this properties will be set to. More...
 
virtual ~EffectBase ()=default
 
- Public Member Functions inherited from openshot::ClipBase
 ClipBase ()
 Constructor for the base clip. More...
 
virtual void End (float value)
 Set end position (in seconds) of clip (trim end of video) More...
 
void Id (std::string value)
 
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)
 
void Position (float value)
 

Set the Id of this clip object

More...
 
void Start (float value)
 Set start position (in seconds) of clip (trim start of video) More...
 
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...
 
- Public Attributes inherited from openshot::EffectBase
EffectInfoStruct info
 Information about the current effect. More...
 
EffectBaseparentEffect
 Parent effect (which properties will set this effect properties) More...
 
std::map< int, std::shared_ptr< openshot::TrackedObjectBase > > trackedObjects
 Map of Tracked Object's by their indices (used by Effects that track objects on clips) More...
 

Additional Inherited Members

- Protected Member Functions inherited from openshot::ClipBase
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...
 
- Protected Attributes inherited from openshot::EffectBase
openshot::ClipBaseclip
 Pointer to the parent clip instance (if any) 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...
 
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...
 
openshot::TimelineBasetimeline
 Pointer to the parent timeline instance (if any) More...
 

Detailed Description

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.

Definition at line 36 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 29 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 35 of file Mask.cpp.

Member Function Documentation

◆ GetFrame() [1/2]

std::shared_ptr<openshot::Frame> openshot::Mask::GetFrame ( int64_t  frame_number)
inlineoverridevirtual

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
Parameters
frame_numberThe frame number (starting at 1) of the clip or effect on the timeline.

Implements openshot::ClipBase.

Definition at line 69 of file Mask.h.

Referenced by GetFrame().

◆ GetFrame() [2/2]

std::shared_ptr< openshot::Frame > Mask::GetFrame ( std::shared_ptr< openshot::Frame frame,
int64_t  frame_number 
)
overridevirtual

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
Parameters
frameThe frame object that needs the clip or effect applied to it
frame_numberThe frame number (starting at 1) of the clip or effect on the timeline.

Implements openshot::ClipBase.

Definition at line 58 of file Mask.cpp.

◆ Json()

std::string Mask::Json ( ) const
overridevirtual

Generate JSON string of this object.

Reimplemented from openshot::EffectBase.

Definition at line 146 of file Mask.cpp.

◆ JsonValue()

Json::Value Mask::JsonValue ( ) const
overridevirtual

Generate Json::Value for this object.

Reimplemented from openshot::EffectBase.

Definition at line 153 of file Mask.cpp.

Referenced by Json().

◆ PropertiesJSON()

std::string Mask::PropertiesJSON ( int64_t  requested_frame) const
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.

Definition at line 255 of file Mask.cpp.

◆ Reader() [1/2]

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

Get the reader object of the mask grayscale image.

Definition at line 93 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 96 of file Mask.h.

◆ SetJson()

void Mask::SetJson ( const std::string  value)
overridevirtual

Load JSON string into this object.

Reimplemented from openshot::EffectBase.

Definition at line 171 of file Mask.cpp.

◆ SetJsonValue()

void Mask::SetJsonValue ( const Json::Value  root)
overridevirtual

Load Json::Value into this object.

Reimplemented from openshot::EffectBase.

Definition at line 188 of file Mask.cpp.

Referenced by SetJson().

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 48 of file Mask.h.

Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().

◆ contrast

Keyframe openshot::Mask::contrast

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

Definition at line 49 of file Mask.h.

Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().

◆ 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 47 of file Mask.h.

Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().


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