OpenShot Library | libopenshot  0.3.3
Public Member Functions | Public Attributes | List of all members
openshot::Compressor Class Reference

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

#include <audio_effects/Compressor.h>

Inheritance diagram for openshot::Compressor:
[legend]
Collaboration diagram for openshot::Compressor:
[legend]

Public Member Functions

float calculateAttackOrRelease (float value)
 
 Compressor ()
 Default constructor. More...
 
 Compressor (Keyframe threshold, Keyframe ratio, Keyframe attack, Keyframe release, Keyframe makeup_gain, Keyframe bypass)
 Constructor. More...
 
std::shared_ptr< openshot::FrameGetFrame (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::FrameGetFrame (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...
 
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::ClipBaseParentClip ()
 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 (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 ()=default
 
- 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 attack
 
Keyframe bypass
 
float control
 
float input_level
 
float inverse_sample_rate
 
float inverseE
 
Keyframe makeup_gain
 
juce::AudioBuffer< float > 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...
 
EffectBaseparentEffect
 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...
 

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::ClipBaseclip
 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::TimelineBasetimeline
 Pointer to the parent timeline instance (if any) More...
 

Detailed Description

This class adds a compressor into the audio.

Definition at line 35 of file Compressor.h.

Constructor & Destructor Documentation

◆ Compressor() [1/2]

Compressor::Compressor ( )

Default constructor.

Definition at line 19 of file Compressor.cpp.

◆ Compressor() [2/2]

Compressor::Compressor ( Keyframe  threshold,
Keyframe  ratio,
Keyframe  attack,
Keyframe  release,
Keyframe  makeup_gain,
Keyframe  bypass 
)

Constructor.

Definition at line 21 of file Compressor.cpp.

Member Function Documentation

◆ calculateAttackOrRelease()

float Compressor::calculateAttackOrRelease ( float  value)

Definition at line 107 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_numberThe frame number (starting at 1) of the clip or effect on the timeline.

Implements openshot::ClipBase.

Definition at line 72 of file Compressor.h.

◆ 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 / background (pixels). All Clip keyframes and effects are resolved into pixels.

Returns
The modified openshot::Frame object
Parameters
frameThis is ignored on Clip, due to caching optimizations. This frame instance is clobbered with the source frame.
frame_numberThe frame number (starting at 1) of the clip or effect on the timeline.

Implements openshot::ClipBase.

Definition at line 48 of file Compressor.cpp.

◆ Json()

std::string Compressor::Json ( ) const
overridevirtual

Generate JSON string of this object.

Reimplemented from openshot::EffectBase.

Definition at line 116 of file Compressor.cpp.

◆ JsonValue()

Json::Value Compressor::JsonValue ( ) const
overridevirtual

Generate Json::Value for this object.

Reimplemented from openshot::EffectBase.

Definition at line 123 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 183 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 140 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 157 of file Compressor.cpp.

Referenced by SetJson().

Member Data Documentation

◆ attack

Keyframe openshot::Compressor::attack

Definition at line 45 of file Compressor.h.

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

◆ bypass

Keyframe openshot::Compressor::bypass

Definition at line 48 of file Compressor.h.

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

◆ control

float openshot::Compressor::control

Definition at line 55 of file Compressor.h.

Referenced by GetFrame().

◆ input_level

float openshot::Compressor::input_level

Definition at line 57 of file Compressor.h.

Referenced by GetFrame().

◆ inverse_sample_rate

float openshot::Compressor::inverse_sample_rate

Definition at line 60 of file Compressor.h.

Referenced by calculateAttackOrRelease(), and GetFrame().

◆ inverseE

float openshot::Compressor::inverseE

Definition at line 61 of file Compressor.h.

Referenced by calculateAttackOrRelease(), and GetFrame().

◆ makeup_gain

Keyframe openshot::Compressor::makeup_gain

Definition at line 47 of file Compressor.h.

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

◆ mixed_down_input

juce::AudioBuffer<float> openshot::Compressor::mixed_down_input

Definition at line 50 of file Compressor.h.

Referenced by GetFrame().

◆ ratio

Keyframe openshot::Compressor::ratio

Definition at line 44 of file Compressor.h.

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

◆ release

Keyframe openshot::Compressor::release

Definition at line 46 of file Compressor.h.

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

◆ threshold

Keyframe openshot::Compressor::threshold

Definition at line 43 of file Compressor.h.

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

◆ xg

float openshot::Compressor::xg

Definition at line 53 of file Compressor.h.

Referenced by GetFrame().

◆ xl

float openshot::Compressor::xl

Definition at line 51 of file Compressor.h.

Referenced by GetFrame().

◆ yg

float openshot::Compressor::yg

Definition at line 54 of file Compressor.h.

Referenced by GetFrame().

◆ yl

float openshot::Compressor::yl

Definition at line 52 of file Compressor.h.

Referenced by GetFrame().

◆ yl_prev

float openshot::Compressor::yl_prev

Definition at line 58 of file Compressor.h.

Referenced by GetFrame().


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