Move AudioEffectsSuite to AudioEffects

pschatzmann · Jan 25, 2024 · 6d2e70a · 6d2e70a
1 parent 82c14c2
commit 6d2e70a
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/src/AudioLibs/AudioEffectsSuite.h → src/AudioEffects/AudioEffectsSuite.h b/src/AudioLibs/AudioEffectsSuite.h → src/AudioEffects/AudioEffectsSuite.h
@@ -34,7 +34,7 @@ static effectsuite_t **interpolationTable = nullptr;
 
 /**
  * @brief Base Class for Effects
- * 
+ * @ingroup effects
  */
 
 class EffectSuiteBase  : public AudioEffect {
@@ -63,6 +63,7 @@ class EffectSuiteBase  : public AudioEffect {
  * to modulate The parameters of another effect. Class initialised with sample
  * rate.
  * @author Matthew Hamilton
+ * @ingroup effects
  * @copyright MIT License
  */
 class ModulationBaseClass {
@@ -360,7 +361,7 @@ class ModulationBaseClass {
 /**
  * @brief SoundGenerator using the ModulationBaseClass
  * to generate the samples.
- * 
+ * @ingroup effects
  * @tparam T 
  */
  template <class T>
@@ -391,6 +392,7 @@ class ModulationBaseClass {
  * @version 0.1
  * @see DelayEffectBase
  * @author Matthew Hamilton
+ * @ingroup effects
  * @copyright MIT License
  */
 class DelayEffectBase  {
@@ -625,6 +627,7 @@ class DelayEffectBase  {
  * high, low and band pass filtering
  * @see FilterEffectBase
  * @author Matthew Hamilton
+ * @ingroup effects
  * @copyright MIT License
  */
 class FilterEffectBase : public EffectSuiteBase  {
@@ -994,6 +997,7 @@ class FilterEffectBase : public EffectSuiteBase  {
 /**
  * @brief SimpleLPF
  * @author Matthew Hamilton
+ * @ingroup effects
  * @copyright MIT License
  */
 class SimpleLPF : public FilterEffectBase {
@@ -1551,6 +1555,7 @@ class SimpleFlanger : public DelayEffectBase, public EffectSuiteBase {
 /**
  * @brief EnvelopeFilter
  * @author Matthew Hamilton
+ * @ingroup effects
  * @copyright MIT License
  */
 class EnvelopeFilter : public FilterEffectBase {

diff --git a/src/AudioTools.h b/src/AudioTools.h
@@ -86,6 +86,7 @@
 #include "AudioCodecs/AudioCodecs.h"
 #include "AudioEffects/SoundGenerator.h"
 #include "AudioEffects/AudioEffects.h"
+#include "AudioEffects/AudioEffectsSuite.h"
 #include "AudioEffects/PitchShift.h"
 #include "AudioMetaData/MetaData.h"
 #include "AudioHttp/AudioHttp.h"