OpenShot Library | libopenshot  0.2.5
Public Member Functions | Public Attributes | List of all members
openshot::EffectBase Class Referenceabstract

This abstract class is the base class, used by all effects in libopenshot. More...

#include <EffectBase.h>

Inheritance diagram for openshot::EffectBase:
openshot::ClipBase openshot::Bars openshot::Blur openshot::Brightness openshot::ChromaKey openshot::ColorShift openshot::Crop openshot::Deinterlace openshot::Hue openshot::Mask openshot::Negate openshot::Pixelate openshot::Saturation openshot::Shift openshot::Wave

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::FrameGetFrame (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
 
- Public Member Functions inherited from openshot::ClipBase
 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 std::string PropertiesJSON (int64_t requested_frame) const =0
 
virtual ~ClipBase ()=default
 

Public Attributes

EffectInfoStruct info
 Information about the current effect. 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::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...
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ ~EffectBase()

virtual openshot::EffectBase::~EffectBase ( )
virtualdefault

Member Function Documentation

◆ constrain()

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().

◆ DisplayInfo()

void EffectBase::DisplayInfo ( )

Display effect information in the standard output stream (stdout)

Definition at line 52 of file EffectBase.cpp.

◆ GetFrame()

virtual std::shared_ptr<openshot::Frame> openshot::EffectBase::GetFrame ( std::shared_ptr< openshot::Frame frame,
int64_t  frame_number 
)
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).

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.

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.

◆ InitEffectInfo()

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().

◆ Json()

std::string EffectBase::Json ( ) const
pure virtual

◆ JsonInfo()

Json::Value EffectBase::JsonInfo ( ) const

Generate JSON object of meta data / info.

Definition at line 128 of file EffectBase.cpp.

◆ JsonValue()

Json::Value EffectBase::JsonValue ( ) const
pure virtual

◆ Order() [1/2]

int openshot::EffectBase::Order ( ) const
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().

◆ Order() [2/2]

void openshot::EffectBase::Order ( int  new_order)
inline

Set the order that this effect should be executed.

Definition at line 107 of file EffectBase.h.

◆ SetJson()

void EffectBase::SetJson ( const std::string  value)
pure virtual

◆ SetJsonValue()

void EffectBase::SetJsonValue ( const Json::Value  root)
pure virtual

Member Data Documentation

◆ info

EffectInfoStruct openshot::EffectBase::info

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