hydrogen 1.2.3
Effects Class Reference

#include <Effects.h>

Inheritance diagram for Effects:
Object< Effects > Base

Public Member Functions

 ~Effects ()
 
LadspaFXgetLadspaFX (int nFX) const
 
LadspaFXGroupgetLadspaFXGroup ()
 
std::vector< LadspaFXInfo * > getPluginList ()
 Loads only usable plugins.
 
void setLadspaFX (LadspaFX *pFX, int nFX)
 
- Public Member Functions inherited from Object< Effects >
 Object ()
 
 Object (const Object< Effects > &other)
 
- Public Member Functions inherited from Base
 Base ()
 
 Base (const Base &other)
 
virtual const char * class_name () const
 
void Print (bool bShort=true) const
 Prints content of toQString() via DEBUGLOG.
 
virtual QString toQString (const QString &sPrefix="", bool bShort=true) const
 Formatted string version for debugging purposes.
 

Static Public Member Functions

static void create_instance ()
 If __instance equals 0, a new Effects singleton will be created and stored in it.
 
static Effectsget_instance ()
 Returns a pointer to the current Effects singleton stored in __instance.
 
- Static Public Member Functions inherited from Base
static const char * _class_name ()
 return the class name
 
static QString base_clock (const QString &sMsg)
 Measures the current time and stores it in __last_clock.
 
static QString base_clock_in (const QString &sMsg)
 
static int bootstrap (Logger *logger, bool count=false)
 must be called before any Object instantiation !
 
static bool count_active ()
 
static int getAliveObjectCount ()
 
static object_map_t getObjectMap ()
 
static Loggerlogger ()
 return the logger instance
 
static int objects_count ()
 
static void printObjectMapDiff (object_map_t map)
 Creates the difference between a snapshot of the object map and its current state and prints it to std::cout.
 
static void set_count (bool flag)
 enable/disable class instances counting
 
static void write_objects_map_to (std::ostream &out, object_map_t *map=nullptr)
 output the full objects map to a given ostream
 
static void write_objects_map_to_cerr ()
 output objects map to stderr
 

Private Member Functions

 Effects ()
 
void getRDF (LadspaFXGroup *pGroup, std::vector< LadspaFXInfo * > pluginList)
 
void RDFDescend (const QString &sBase, LadspaFXGroup *pGroup, std::vector< LadspaFXInfo * > pluginList)
 
void updateRecentGroup ()
 

Private Attributes

LadspaFXm_FXList [MAX_FX]
 
std::vector< LadspaFXInfo * > m_pluginList
 
LadspaFXGroupm_pRecentGroup
 
LadspaFXGroupm_pRootGroup
 

Static Private Attributes

static Effects__instance = nullptr
 Object holding the current Effects singleton.
 

Additional Inherited Members

- Static Public Attributes inherited from Base
static QString sPrintIndention = " "
 String used to format the debugging string output of some core classes.
 
- Protected Member Functions inherited from Object< Effects >
 ~Object ()
 
- Protected Member Functions inherited from Base
 ~Base ()
 
- Static Protected Member Functions inherited from Base
static void registerClass (const char *name, const atomic_obj_cpt_t *counters)
 
- Static Protected Attributes inherited from Base
static bool __count = false
 should we count class instances
 
static timeval __last_clock = { 0, 0 }
 
static Logger__logger = nullptr
 

Detailed Description

Definition at line 39 of file Effects.h.

Constructor & Destructor Documentation

◆ ~Effects()

~Effects ( )

Definition at line 73 of file Effects.cpp.

◆ Effects()

Effects ( )
private

Definition at line 48 of file Effects.cpp.

Member Function Documentation

◆ create_instance()

void create_instance ( )
static

If __instance equals 0, a new Effects singleton will be created and stored in it.

It is called in Hydrogen::audioEngine_init().

Definition at line 63 of file Effects.cpp.

◆ get_instance()

static Effects * get_instance ( )
inlinestatic

Returns a pointer to the current Effects singleton stored in __instance.

Definition at line 54 of file Effects.h.

◆ getLadspaFX()

LadspaFX * getLadspaFX ( int nFX) const

Definition at line 91 of file Effects.cpp.

◆ getLadspaFXGroup()

LadspaFXGroup * getLadspaFXGroup ( )

Definition at line 227 of file Effects.cpp.

◆ getPluginList()

std::vector< LadspaFXInfo * > getPluginList ( )

Loads only usable plugins.

Definition at line 131 of file Effects.cpp.

◆ getRDF()

void getRDF ( LadspaFXGroup * pGroup,
std::vector< LadspaFXInfo * > pluginList )
private

◆ RDFDescend()

void RDFDescend ( const QString & sBase,
LadspaFXGroup * pGroup,
std::vector< LadspaFXInfo * > pluginList )
private

◆ setLadspaFX()

void setLadspaFX ( LadspaFX * pFX,
int nFX )

Definition at line 99 of file Effects.cpp.

◆ updateRecentGroup()

void updateRecentGroup ( )
private

Definition at line 272 of file Effects.cpp.

Field Documentation

◆ __instance

Effects * __instance = nullptr
staticprivate

Object holding the current Effects singleton.

It is initialized with NULL, set with create_instance(), and accessed with get_instance().

Definition at line 70 of file Effects.h.

◆ m_FXList

LadspaFX* m_FXList[MAX_FX]
private

Definition at line 77 of file Effects.h.

◆ m_pluginList

std::vector<LadspaFXInfo*> m_pluginList
private

Definition at line 71 of file Effects.h.

◆ m_pRecentGroup

LadspaFXGroup* m_pRecentGroup
private

Definition at line 73 of file Effects.h.

◆ m_pRootGroup

LadspaFXGroup* m_pRootGroup
private

Definition at line 72 of file Effects.h.