OpenShot Library | libopenshot
0.2.4
|
This class pixelates an image, and can be animated with openshot::Keyframe curves over time. More...
#include <Pixelate.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 () |
Get and Set JSON methods. More... | |
Json::Value | JsonValue () |
Generate Json::JsonValue for this object. More... | |
Pixelate () | |
Blank constructor, useful when using Json to load the effect properties. More... | |
Pixelate (Keyframe pixelization, Keyframe left, Keyframe top, Keyframe right, Keyframe bottom) | |
std::string | PropertiesJSON (int64_t requested_frame) |
void | SetJson (std::string value) |
Load JSON string into this object. More... | |
void | SetJsonValue (Json::Value root) |
Load Json::JsonValue 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... | |
virtual std::shared_ptr< openshot::Frame > | GetFrame (std::shared_ptr< openshot::Frame > frame, int64_t frame_number)=0 |
This method is required for all derived classes of EffectBase, and returns a modified openshot::Frame object. 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... | |
virtual | ~EffectBase ()=default |
![]() | |
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... | |
std::string | Id () |
Get basic properties. More... | |
void | Id (std::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) |
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... | |
virtual | ~ClipBase ()=default |
Public Attributes | |
Keyframe | bottom |
Size of bottom margin. More... | |
Keyframe | left |
Size of left margin. More... | |
Keyframe | pixelization |
Amount of pixelization. More... | |
Keyframe | right |
Size of right margin. More... | |
Keyframe | top |
Size of top margin. 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) |
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, Keyframe *keyframe, float min_value, float max_value, bool readonly, int64_t requested_frame) |
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 pixelates an image, and can be animated with openshot::Keyframe curves over time.
Pixelating the image is the process of increasing the size of visible pixels, thus loosing visual clarity of the image. The area to pixelate can be set and animated with keyframes also.
Definition at line 53 of file Pixelate.h.
Pixelate::Pixelate | ( | ) |
Blank constructor, useful when using Json to load the effect properties.
Definition at line 36 of file Pixelate.cpp.
Pixelate::Pixelate | ( | Keyframe | pixelization, |
Keyframe | left, | ||
Keyframe | top, | ||
Keyframe | right, | ||
Keyframe | bottom | ||
) |
Default constructor, which takes 5 curves. These curves animate the pixelization effect over time.
pixelization | The curve to adjust the amount of pixelization (0 to 1) |
left | The curve to adjust the left margin size (between 0 and 1) |
top | The curve to adjust the top margin size (between 0 and 1) |
right | The curve to adjust the right margin size (between 0 and 1) |
bottom | The curve to adjust the bottom margin size (between 0 and 1) |
Definition at line 42 of file Pixelate.cpp.
std::shared_ptr< Frame > Pixelate::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.
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. |
Definition at line 65 of file Pixelate.cpp.
|
virtual |
Get and Set JSON methods.
Generate JSON string of this object
Implements openshot::EffectBase.
Definition at line 113 of file Pixelate.cpp.
|
virtual |
Generate Json::JsonValue for this object.
Implements openshot::EffectBase.
Definition at line 120 of file Pixelate.cpp.
Referenced by Json().
|
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 184 of file Pixelate.cpp.
|
virtual |
Load JSON string into this object.
Implements openshot::EffectBase.
Definition at line 136 of file Pixelate.cpp.
|
virtual |
Load Json::JsonValue into this object.
Implements openshot::EffectBase.
Definition at line 165 of file Pixelate.cpp.
Referenced by SetJson().
Keyframe openshot::Pixelate::bottom |
Size of bottom margin.
Definition at line 65 of file Pixelate.h.
Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().
Keyframe openshot::Pixelate::left |
Size of left margin.
Definition at line 62 of file Pixelate.h.
Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().
Keyframe openshot::Pixelate::pixelization |
Amount of pixelization.
Definition at line 61 of file Pixelate.h.
Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().
Keyframe openshot::Pixelate::right |
Size of right margin.
Definition at line 64 of file Pixelate.h.
Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().
Keyframe openshot::Pixelate::top |
Size of top margin.
Definition at line 63 of file Pixelate.h.
Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().