This class adds a compressor into the audio. More...

#include <audio_effects/Compressor.h>

Inheritance diagram for openshot::Compressor:

Public Member Functions
float	calculateAttackOrRelease (float value)

	Compressor ()
	Blank constructor, useful when using Json to load the effect properties. More...

	Compressor (Keyframe new_threshold, Keyframe new_ratio, Keyframe new_attack, Keyframe new_release, Keyframe new_makeup_gain, Keyframe new_bypass)

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
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::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 () const
	Generate JSON string of this object. More...

virtual std::string	Json (int64_t requested_frame) const

Json::Value	JsonInfo () const
	Generate JSON object of meta data / info. More...

virtual Json::Value	JsonValue () const
	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...

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

virtual void	SetJson (const std::string value)
	Load JSON string into this object. More...

virtual void	SetJson (int64_t requested_frame, const std::string value)

virtual void	SetJsonValue (const Json::Value root)
	Load Json::Value into this object. More...

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

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

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

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 ClipBase, and returns a modified openshot::Frame object. More...

std::string	Id () const
	Get the Id of this clip object. More...

void	Id (std::string value)

virtual std::string	Json () const =0
	Generate JSON string of this object. More...

virtual Json::Value	JsonValue () const =0
	Generate Json::Value for this object. 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)

openshot::TimelineBase *	ParentTimeline ()
	Get the associated Timeline pointer (if any) More...

void	ParentTimeline (openshot::TimelineBase *new_timeline)
	Set associated Timeline pointer. More...

float	Position () const
	Get position on timeline (in seconds) More...

void	Position (float value)
	‍Set the Id of this clip object More...

virtual std::string	PropertiesJSON (int64_t requested_frame) const =0

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

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
Keyframe	attack

Keyframe	bypass

float	control

float	input_level

float	inverse_sample_rate

float	inverseE

Keyframe	makeup_gain

juce::AudioSampleBuffer	mixed_down_input

Keyframe	ratio

Keyframe	release

Keyframe	threshold

float	xg

float	xl

float	yg

float	yl

float	yl_prev

Public Attributes inherited from openshot::EffectBase
EffectInfoStruct	info
	Information about the current effect. 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...

Public Attributes inherited from openshot::ClipBase
CacheMemory	cache

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::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 adds a compressor into the audio.

Definition at line 53 of file Compressor.h.

Constructor & Destructor Documentation

◆ Compressor() [1/2]

Compressor::Compressor ( )

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

Definition at line 37 of file Compressor.cpp.

◆ Compressor() [2/2]

Compressor::Compressor	(	Keyframe	new_threshold,
		Keyframe	new_ratio,
		Keyframe	new_attack,
		Keyframe	new_release,
		Keyframe	new_makeup_gain,
		Keyframe	new_bypass
	)

Default constructor

Parameters

new_level The audio default Compressor level (between 1 and 100)

Definition at line 43 of file Compressor.cpp.

Member Function Documentation

◆ calculateAttackOrRelease()

float Compressor::calculateAttackOrRelease ( float value )

Definition at line 128 of file Compressor.cpp.

Referenced by GetFrame().

◆ GetFrame() [1/2]

std::shared_ptr< openshot::Frame > openshot::Compressor::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 97 of file Compressor.h.

Referenced by GetFrame().

◆ GetFrame() [2/2]

std::shared_ptr< openshot::Frame > Compressor::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 69 of file Compressor.cpp.

◆ Json()

std::string Compressor::Json ( ) const

overridevirtual

Generate JSON string of this object.

Reimplemented from openshot::EffectBase.

Definition at line 137 of file Compressor.cpp.

◆ JsonValue()

Json::Value Compressor::JsonValue ( ) const

overridevirtual

Generate Json::Value for this object.

Reimplemented from openshot::EffectBase.

Definition at line 144 of file Compressor.cpp.

Referenced by Json().

◆ PropertiesJSON()

std::string Compressor::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 204 of file Compressor.cpp.

◆ SetJson()

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

overridevirtual

Load JSON string into this object.

Reimplemented from openshot::EffectBase.

Definition at line 161 of file Compressor.cpp.

◆ SetJsonValue()

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

overridevirtual

Load Json::Value into this object.

Reimplemented from openshot::EffectBase.

Definition at line 178 of file Compressor.cpp.

Referenced by SetJson().

Member Data Documentation

◆ attack

Keyframe openshot::Compressor::attack

Definition at line 63 of file Compressor.h.

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

◆ bypass

Keyframe openshot::Compressor::bypass

Definition at line 66 of file Compressor.h.

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

◆ control

float openshot::Compressor::control

Definition at line 73 of file Compressor.h.

Referenced by GetFrame().

◆ input_level

float openshot::Compressor::input_level

Definition at line 75 of file Compressor.h.

Referenced by GetFrame().

◆ inverse_sample_rate

float openshot::Compressor::inverse_sample_rate

Definition at line 78 of file Compressor.h.

Referenced by calculateAttackOrRelease(), and GetFrame().

◆ inverseE

float openshot::Compressor::inverseE

Definition at line 79 of file Compressor.h.

Referenced by calculateAttackOrRelease(), and GetFrame().

◆ makeup_gain

Keyframe openshot::Compressor::makeup_gain

Definition at line 65 of file Compressor.h.

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

◆ mixed_down_input

juce::AudioSampleBuffer openshot::Compressor::mixed_down_input

Definition at line 68 of file Compressor.h.

Referenced by GetFrame().

◆ ratio

Keyframe openshot::Compressor::ratio

Definition at line 62 of file Compressor.h.

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

◆ release

Keyframe openshot::Compressor::release

Definition at line 64 of file Compressor.h.

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

◆ threshold

Keyframe openshot::Compressor::threshold

Definition at line 61 of file Compressor.h.

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

◆ xg

float openshot::Compressor::xg

Definition at line 71 of file Compressor.h.

Referenced by GetFrame().

◆ xl

float openshot::Compressor::xl

Definition at line 69 of file Compressor.h.

Referenced by GetFrame().

◆ yg

float openshot::Compressor::yg

Definition at line 72 of file Compressor.h.

Referenced by GetFrame().

◆ yl

float openshot::Compressor::yl

Definition at line 70 of file Compressor.h.

Referenced by GetFrame().

◆ yl_prev

float openshot::Compressor::yl_prev

Definition at line 76 of file Compressor.h.

Referenced by GetFrame().

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

audio_effects/Compressor.h
audio_effects/Compressor.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Compressor() [1/2]

◆ Compressor() [2/2]

Member Function Documentation

◆ calculateAttackOrRelease()

◆ GetFrame() [1/2]

◆ GetFrame() [2/2]

◆ Json()

◆ JsonValue()

◆ PropertiesJSON()

◆ SetJson()

◆ SetJsonValue()

Member Data Documentation

◆ attack

◆ bypass

◆ control

◆ input_level

◆ inverse_sample_rate

◆ inverseE

◆ makeup_gain

◆ mixed_down_input

◆ ratio

◆ release

◆ threshold

◆ xg

◆ xl

◆ yg

◆ yl

◆ yl_prev