OpenShot Library | libopenshot
0.2.5
|
This abstract class is the base class, used by all effects in libopenshot. More...
#include <EffectBase.h>
Public Member Functions | |
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 () |
virtual std::string | Json () const =0 |
Get and Set JSON methods. More... | |
Json::Value | JsonInfo () const |
Generate JSON object of meta data / info. More... | |
virtual Json::Value | JsonValue () const =0 |
Generate Json::Value for this object. 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 void | SetJson (const std::string value)=0 |
Load JSON string into this object. More... | |
virtual void | SetJsonValue (const Json::Value root)=0 |
Load Json::Value into this object. More... | |
virtual | ~EffectBase ()=default |
![]() | |
ClipBase () | |
Constructor for the base clip. More... | |
float | Duration () const |
Get the length of this clip (in seconds) More... | |
float | End () const |
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 () const |
Get basic properties. More... | |
void | Id (std::string value) |
Set basic properties. More... | |
int | Layer () const |
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 () const |
Get position on timeline (in seconds) More... | |
void | Position (float value) |
More... | |
virtual std::string | PropertiesJSON (int64_t requested_frame) const =0 |
float | Start () const |
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 | |
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 abstract class is the base class, used by all effects in libopenshot.
Effects are types of classes that manipulate the image or audio data of an openshot::Frame object. The only requirements for an 'effect', is to derive from this base class, implement the Apply() method, and call the InitEffectInfo() method.
Definition at line 66 of file EffectBase.h.
|
virtualdefault |
int EffectBase::constrain | ( | int | color_value | ) |
Constrain a color value from 0 to 255.
Definition at line 65 of file EffectBase.cpp.
Referenced by openshot::Hue::GetFrame(), openshot::Saturation::GetFrame(), openshot::Brightness::GetFrame(), and openshot::Mask::GetFrame().
void EffectBase::DisplayInfo | ( | ) |
Display effect information in the standard output stream (stdout)
Definition at line 52 of file EffectBase.cpp.
|
pure 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. |
Implemented in openshot::Blur, openshot::Mask, openshot::ColorShift, openshot::Bars, openshot::Brightness, openshot::Crop, openshot::Pixelate, openshot::Wave, openshot::ChromaKey, openshot::Saturation, openshot::Deinterlace, openshot::Shift, openshot::Hue, and openshot::Negate.
void EffectBase::InitEffectInfo | ( | ) |
Initialize the values of the EffectInfo struct. It is important for derived classes to call this method, or the EffectInfo struct values will not be initialized.
Definition at line 36 of file EffectBase.cpp.
Referenced by openshot::Negate::Negate().
|
pure virtual |
Get and Set JSON methods.
Generate JSON string of this object
Implements openshot::ClipBase.
Implemented in openshot::Blur, openshot::Mask, openshot::ColorShift, openshot::Bars, openshot::Brightness, openshot::Crop, openshot::Pixelate, openshot::Wave, openshot::ChromaKey, openshot::Saturation, openshot::Deinterlace, openshot::Shift, openshot::Hue, and openshot::Negate.
Definition at line 77 of file EffectBase.cpp.
Json::Value EffectBase::JsonInfo | ( | ) | const |
Generate JSON object of meta data / info.
Definition at line 128 of file EffectBase.cpp.
|
pure virtual |
Generate Json::Value for this object.
Implements openshot::ClipBase.
Implemented in openshot::Blur, openshot::Mask, openshot::ColorShift, openshot::Bars, openshot::Brightness, openshot::Crop, openshot::Pixelate, openshot::Wave, openshot::ChromaKey, openshot::Saturation, openshot::Deinterlace, openshot::Shift, openshot::Hue, and openshot::Negate.
Definition at line 84 of file EffectBase.cpp.
Referenced by Json(), openshot::Negate::JsonValue(), openshot::Hue::JsonValue(), openshot::Deinterlace::JsonValue(), openshot::Shift::JsonValue(), openshot::Saturation::JsonValue(), openshot::ChromaKey::JsonValue(), openshot::Pixelate::JsonValue(), openshot::Crop::JsonValue(), openshot::Wave::JsonValue(), openshot::Bars::JsonValue(), openshot::Brightness::JsonValue(), openshot::ColorShift::JsonValue(), openshot::Blur::JsonValue(), and openshot::Mask::JsonValue().
|
inline |
Get the order that this effect should be executed.
Definition at line 104 of file EffectBase.h.
Referenced by InitEffectInfo(), JsonValue(), openshot::CompareClipEffects::operator()(), openshot::CompareEffects::operator()(), and SetJsonValue().
|
inline |
Set the order that this effect should be executed.
Definition at line 107 of file EffectBase.h.
|
pure virtual |
Load JSON string into this object.
Implements openshot::ClipBase.
Implemented in openshot::Blur, openshot::Mask, openshot::ColorShift, openshot::Bars, openshot::Brightness, openshot::Crop, openshot::Pixelate, openshot::Wave, openshot::ChromaKey, openshot::Saturation, openshot::Deinterlace, openshot::Shift, openshot::Hue, and openshot::Negate.
Definition at line 100 of file EffectBase.cpp.
|
pure virtual |
Load Json::Value into this object.
Implements openshot::ClipBase.
Implemented in openshot::Blur, openshot::Mask, openshot::ColorShift, openshot::Bars, openshot::Brightness, openshot::Crop, openshot::Pixelate, openshot::Wave, openshot::ChromaKey, openshot::Saturation, openshot::Deinterlace, openshot::Shift, openshot::Hue, and openshot::Negate.
Definition at line 117 of file EffectBase.cpp.
Referenced by SetJson(), openshot::Negate::SetJsonValue(), openshot::Hue::SetJsonValue(), openshot::Deinterlace::SetJsonValue(), openshot::Shift::SetJsonValue(), openshot::ChromaKey::SetJsonValue(), openshot::Saturation::SetJsonValue(), openshot::Pixelate::SetJsonValue(), openshot::Wave::SetJsonValue(), openshot::Crop::SetJsonValue(), openshot::Bars::SetJsonValue(), openshot::Brightness::SetJsonValue(), openshot::ColorShift::SetJsonValue(), openshot::Mask::SetJsonValue(), openshot::Blur::SetJsonValue(), openshot::Clip::SetJsonValue(), and openshot::Timeline::SetJsonValue().
EffectInfoStruct openshot::EffectBase::info |
Information about the current effect.
Definition at line 73 of file EffectBase.h.
Referenced by DisplayInfo(), InitEffectInfo(), JsonInfo(), openshot::Negate::JsonValue(), openshot::Hue::JsonValue(), openshot::Deinterlace::JsonValue(), openshot::Shift::JsonValue(), openshot::Saturation::JsonValue(), openshot::ChromaKey::JsonValue(), openshot::Crop::JsonValue(), openshot::Wave::JsonValue(), openshot::Pixelate::JsonValue(), openshot::Bars::JsonValue(), openshot::Brightness::JsonValue(), openshot::ColorShift::JsonValue(), JsonValue(), openshot::Mask::JsonValue(), openshot::Blur::JsonValue(), and openshot::Negate::Negate().