This class adjusts the blur of an image, and can be animated with openshot::Keyframe curves over time. More...

#include <effects/Blur.h>

Inheritance diagram for openshot::Blur:

Collaboration diagram for openshot::Blur:

Public Member Functions
	Blur ()
	Blank constructor, useful when using Json to load the effect properties. More...

	Blur (Keyframe new_horizontal_radius, Keyframe new_vertical_radius, Keyframe new_sigma, Keyframe new_iterations)

std::shared_ptr< openshot::Frame >	GetFrame (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::Frame >	GetFrame (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...

std::string	PropertiesJSON (int64_t requested_frame) const override

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

ReaderBase *	MaskReader ()
	Get the common mask reader. More...

const ReaderBase *	MaskReader () const

void	MaskReader (ReaderBase *new_reader)
	Set or replace the common mask reader. 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::ClipBase *	ParentClip ()
	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...

std::shared_ptr< openshot::Frame >	ProcessFrame (std::shared_ptr< openshot::Frame > frame, int64_t frame_number)
	Apply effect processing with common mask support (if enabled). 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 ()

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	horizontal_radius
	Horizontal blur radius keyframe. The size of the horizontal blur operation in pixels. More...

Keyframe	iterations
	Iterations keyframe. The # of blur iterations per pixel. 3 iterations = Gaussian. More...

int	mask_mode
	How to apply common masks to blur (post-blend or drive-amount). More...

Keyframe	sigma
	Sigma keyframe. The amount of spread in the blur operation. Should be larger than radius. More...

Keyframe	vertical_radius
	Vertical blur radius keyframe. The size of the vertical blur operation in pixels. More...

Public Attributes inherited from openshot::EffectBase
EffectInfoStruct	info
	Information about the current effect. More...

bool	mask_invert = false
	Invert grayscale mask values before blending. More...

int	mask_loop_mode = MASK_LOOP_PLAY_ONCE
	Behavior when mask range reaches the end. More...

int	mask_time_mode = MASK_TIME_SOURCE_FPS
	How effect frames map to mask source frames. More...

EffectBase *	parentEffect
	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...

Protected Member Functions
void	ApplyCustomMaskBlend (std::shared_ptr< QImage > original_image, std::shared_ptr< QImage > effected_image, std::shared_ptr< QImage > mask_image, int64_t frame_number) const override
	Optional override for effects with custom mask implementation. More...

bool	UseCustomMaskBlend (int64_t frame_number) const override
	Optional override for effects that need custom mask behavior. More...

Protected Member Functions inherited from openshot::EffectBase
ReaderBase *	CreateReaderFromJson (const Json::Value &reader_json) const
	Create a reader instance from reader JSON. More...

virtual bool	HandlesMaskInternally () const
	Optional override for effects that apply mask processing inside GetFrame(). More...

int64_t	MapMaskFrameNumber (int64_t frame_number)
	Convert an effect frame number to a mask source frame number. More...

double	ResolveMaskHostFps ()
	Determine host FPS used to convert timeline frames to mask source FPS. More...

std::shared_ptr< QImage >	ResolveMaskImage (std::shared_ptr< QImage > target_image, int64_t frame_number)
	Resolve a cached/scaled mask image for the target frame dimensions. More...

double	ResolveMaskSourceDuration () const
	Determine mask source duration in seconds. More...

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

Additional Inherited Members
Public Types inherited from openshot::EffectBase
enum	MaskLoopMode { MASK_LOOP_PLAY_ONCE = 0, MASK_LOOP_REPEAT = 1, MASK_LOOP_PING_PONG = 2 }

enum	MaskTimeMode { MASK_TIME_TIMELINE = 0, MASK_TIME_SOURCE_FPS = 1 }

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

Detailed Description

This class adjusts the blur of an image, and can be animated with openshot::Keyframe curves over time.

Adjusting the blur of an image over time can create many different powerful effects. To achieve a box blur effect, use identical horizontal and vertical blur values. To achieve a Gaussian blur, use 3 iterations, a sigma of 3.0, and a radius between 3 and X (depending on how much blur you want).

Definition at line 40 of file Blur.h.

Constructor & Destructor Documentation

◆ Blur() [1/2]

Blur::Blur ( )

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

Definition at line 19 of file Blur.cpp.

◆ Blur() [2/2]

Blur::Blur	(	Keyframe	new_horizontal_radius,
		Keyframe	new_vertical_radius,
		Keyframe	new_sigma,
		Keyframe	new_iterations
	)

Default constructor, which takes 1 curve. The curve adjusts the blur radius of a frame's image.

Parameters

new_horizontal_radius	The curve to adjust the horizontal blur radius (between 0 and 100, rounded to int)
new_vertical_radius	The curve to adjust the vertical blur radius (between 0 and 100, rounded to int)
new_sigma	The curve to adjust the sigma amount (the size of the blur brush (between 0 and 100), float values accepted)
new_iterations	The curve to adjust the # of iterations (between 1 and 100)

Definition at line 26 of file Blur.cpp.

Member Function Documentation

◆ ApplyCustomMaskBlend()

void Blur::ApplyCustomMaskBlend	(	std::shared_ptr< QImage >	original_image,
		std::shared_ptr< QImage >	effected_image,
		std::shared_ptr< QImage >	mask_image,
		int64_t	frame_number
	)		const

overrideprotectedvirtual

Optional override for effects with custom mask implementation.

Reimplemented from openshot::EffectBase.

Definition at line 100 of file Blur.cpp.

◆ GetFrame() [1/2]

std::shared_ptr<openshot::Frame> openshot::Blur::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_number The frame number (starting at 1) of the clip or effect on the timeline.

Implements openshot::ClipBase.

Definition at line 80 of file Blur.h.

Referenced by GetFrame().

◆ GetFrame() [2/2]

std::shared_ptr< openshot::Frame > Blur::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

frame	The frame object that needs the clip or effect applied to it
frame_number	The frame number (starting at 1) of the clip or effect on the timeline.

Implements openshot::ClipBase.

Definition at line 50 of file Blur.cpp.

◆ Json()

std::string Blur::Json ( ) const

overridevirtual

Generate JSON string of this object.

Reimplemented from openshot::EffectBase.

Definition at line 196 of file Blur.cpp.

◆ JsonValue()

Json::Value Blur::JsonValue ( ) const

overridevirtual

Generate Json::Value for this object.

Reimplemented from openshot::EffectBase.

Definition at line 203 of file Blur.cpp.

Referenced by Json().

◆ PropertiesJSON()

std::string Blur::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 Blur.cpp.

◆ SetJson()

void Blur::SetJson ( const std::string value )

overridevirtual

Load JSON string into this object.

Reimplemented from openshot::EffectBase.

Definition at line 219 of file Blur.cpp.

◆ SetJsonValue()

void Blur::SetJsonValue ( const Json::Value root )

overridevirtual

Load Json::Value into this object.

Reimplemented from openshot::EffectBase.

Definition at line 236 of file Blur.cpp.

Referenced by SetJson().

◆ UseCustomMaskBlend()

bool Blur::UseCustomMaskBlend ( int64_t frame_number ) const

overrideprotectedvirtual

Optional override for effects that need custom mask behavior.

Reimplemented from openshot::EffectBase.

Definition at line 95 of file Blur.cpp.

Member Data Documentation

◆ horizontal_radius

Keyframe openshot::Blur::horizontal_radius

Horizontal blur radius keyframe. The size of the horizontal blur operation in pixels.

Definition at line 56 of file Blur.h.

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

◆ iterations

Keyframe openshot::Blur::iterations

Iterations keyframe. The # of blur iterations per pixel. 3 iterations = Gaussian.

Definition at line 59 of file Blur.h.

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

◆ mask_mode

int openshot::Blur::mask_mode

How to apply common masks to blur (post-blend or drive-amount).

Definition at line 60 of file Blur.h.

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

◆ sigma

Keyframe openshot::Blur::sigma

Sigma keyframe. The amount of spread in the blur operation. Should be larger than radius.

Definition at line 58 of file Blur.h.

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

◆ vertical_radius

Keyframe openshot::Blur::vertical_radius

Vertical blur radius keyframe. The size of the vertical blur operation in pixels.

Definition at line 57 of file Blur.h.

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

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

effects/Blur.h
effects/Blur.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Blur() [1/2]

◆ Blur() [2/2]

Member Function Documentation

◆ ApplyCustomMaskBlend()

◆ GetFrame() [1/2]

◆ GetFrame() [2/2]

◆ Json()

◆ JsonValue()

◆ PropertiesJSON()

◆ SetJson()

◆ SetJsonValue()

◆ UseCustomMaskBlend()

Member Data Documentation

◆ horizontal_radius

◆ iterations

◆ mask_mode

◆ sigma

◆ vertical_radius