From b383662b5eb095fd3a07afcddba1d6af9a7f3246 Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Sun, 22 Oct 2023 22:06:29 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20doxygen=20from=20@=20pschatzma?= =?UTF-8?q?nn/arduino-audio-tools@7733b0f83165ae4aeef26316e9b7c2941de297b7?= =?UTF-8?q?=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _audio_effect_8h_source.html | 28 +- classaudio__tools_1_1_compressor-members.html | 37 +- classaudio__tools_1_1_compressor.html | 35 ++ functions_c.html | 3 + functions_func_c.html | 3 + functions_func_p.html | 1 + functions_func_s.html | 27 +- functions_p.html | 1 + functions_s.html | 17 +- search/all_10.js | 2 +- search/all_13.js | 506 +++++++++--------- search/all_14.js | 124 ++--- search/all_15.js | 28 +- search/all_16.js | 136 ++--- search/all_17.js | 70 +-- search/all_18.js | 2 +- search/all_19.js | 4 +- search/all_1a.js | 50 +- search/all_3.js | 10 +- search/classes_0.js | 202 +++---- search/classes_1.js | 32 +- search/classes_10.js | 8 +- search/classes_11.js | 52 +- search/classes_12.js | 130 ++--- search/classes_13.js | 58 +- search/classes_14.js | 14 +- search/classes_15.js | 108 ++-- search/classes_16.js | 26 +- search/classes_2.js | 72 +-- search/classes_3.js | 48 +- search/classes_4.js | 30 +- search/classes_5.js | 82 +-- search/classes_6.js | 48 +- search/classes_7.js | 26 +- search/classes_8.js | 56 +- search/classes_9.js | 6 +- search/classes_a.js | 2 +- search/classes_b.js | 34 +- search/classes_c.js | 62 +-- search/classes_d.js | 30 +- search/classes_e.js | 30 +- search/classes_f.js | 48 +- search/enums_0.js | 2 +- search/enums_1.js | 2 +- search/enums_2.js | 2 +- search/enums_3.js | 6 +- search/enums_4.js | 6 +- search/enums_5.js | 2 +- search/enums_6.js | 2 +- search/enums_7.js | 2 +- search/files_0.js | 12 +- search/files_1.js | 16 +- search/files_2.js | 2 +- search/files_3.js | 2 +- search/functions_0.js | 2 +- search/functions_1.js | 132 ++--- search/functions_10.js | 2 +- search/functions_11.js | 90 ++-- search/functions_12.js | 428 +++++++-------- search/functions_13.js | 50 +- search/functions_14.js | 6 +- search/functions_15.js | 16 +- search/functions_16.js | 46 +- search/functions_17.js | 50 +- search/functions_2.js | 18 +- search/functions_3.js | 75 +-- search/functions_4.js | 64 +-- search/functions_5.js | 30 +- search/functions_6.js | 50 +- search/functions_7.js | 64 +-- search/functions_8.js | 18 +- search/functions_9.js | 110 ++-- search/functions_a.js | 4 +- search/functions_b.js | 32 +- search/functions_c.js | 72 +-- search/functions_d.js | 18 +- search/functions_e.js | 34 +- search/functions_f.js | 102 ++-- search/groups_0.js | 2 +- search/groups_1.js | 4 +- search/groups_2.js | 12 +- search/groups_3.js | 4 +- search/groups_4.js | 10 +- search/groups_5.js | 4 +- search/groups_6.js | 2 +- search/groups_7.js | 2 +- search/groups_8.js | 6 +- search/groups_9.js | 2 +- search/groups_a.js | 4 +- search/groups_b.js | 4 +- search/groups_c.js | 4 +- search/groups_d.js | 2 +- search/groups_e.js | 6 +- search/groups_f.js | 4 +- search/namespaces_0.js | 2 +- search/pages_0.js | 2 +- search/related_0.js | 2 +- search/typedefs_0.js | 4 +- search/typedefs_1.js | 2 +- search/typedefs_2.js | 2 +- search/variables_0.js | 8 +- search/variables_1.js | 8 +- search/variables_10.js | 2 +- search/variables_11.js | 4 +- search/variables_2.js | 12 +- search/variables_3.js | 12 +- search/variables_4.js | 4 +- search/variables_5.js | 18 +- search/variables_6.js | 26 +- search/variables_7.js | 2 +- search/variables_8.js | 16 +- search/variables_9.js | 8 +- search/variables_a.js | 12 +- search/variables_b.js | 14 +- search/variables_c.js | 10 +- search/variables_d.js | 8 +- search/variables_e.js | 10 +- search/variables_f.js | 6 +- 118 files changed, 2109 insertions(+), 2014 deletions(-) diff --git a/_audio_effect_8h_source.html b/_audio_effect_8h_source.html index a220fe6c07..60d1ca1796 100644 --- a/_audio_effect_8h_source.html +++ b/_audio_effect_8h_source.html @@ -448,10 +448,10 @@
457 
458 
466 class Compressor : public AudioEffect {
-
467 
-
469  Compressor(const Compressor &copy) = default;
+
467 public:
+
469  Compressor(const Compressor &copy) = default;
470 
-
472  Compressor(uint32_t sampleRate = 44100, int32_t attackMs=30, int32_t releaseMs=20, int32_t holdMs=10, uint8_t thresholdPercent=10, float compressionRatio=0.5){
+
472  Compressor(uint32_t sampleRate = 44100, int32_t attackMs=30, int32_t releaseMs=20, int32_t holdMs=10, uint8_t thresholdPercent=10, float compressionRatio=0.5){
473  //assuming 1 sample = 1/96kHz = ~10us
474  //Attack -> 30 ms -> 3000
475  //Release -> 20 ms -> 2000
@@ -470,33 +470,33 @@
488  recalculate();
489  }
490 
-
492  void setAttack(int32_t attackMs){
+
492  void setAttack(int32_t attackMs){
493  attack_count = sample_rate * attackMs / 1000;
494  recalculate();
495  }
496 
-
498  void setRelease(int32_t releaseMs){
+
498  void setRelease(int32_t releaseMs){
499  release_count = sample_rate * releaseMs / 1000;
500  recalculate();
501  }
502 
-
504  void setHold(int32_t holdMs){
+
504  void setHold(int32_t holdMs){
505  hold_count = sample_rate * holdMs / 1000;
506  recalculate();
507  }
508 
-
510  void setThresholdPercent(uint8_t thresholdPercent){
+
510  void setThresholdPercent(uint8_t thresholdPercent){
511  threshold = 0.01f * thresholdPercent * NumberConverter::maxValueT<effect_t>();
512  }
513 
-
515  void setCompressionRatio(float compressionRatio){
+
515  void setCompressionRatio(float compressionRatio){
516  if (compressionRatio<1.0){
517  gainreduce = compressionRatio;
518  }
519  recalculate();
520  }
521 
-
523  effect_t process(effect_t inSample) {
+
523  effect_t process(effect_t inSample) {
524  float inSampleF = (float)inSample;
525 
526  if (fabs(inSampleF) > threshold) {
@@ -568,7 +568,7 @@
592  return (int) outSampleF;
593  }
594 
-
595  Compressor *clone() { return new Compressor(*this); }
+
595  Compressor *clone() { return new Compressor(*this); }
596 
597 protected:
598  enum CompStates {S_NoOperation, S_Attack, S_GainReduction, S_Release };
@@ -601,6 +601,14 @@
effect_t process(effect_t input)
calculates the effect output from the input
Definition: AudioEffect.h:85
Boost(float volume=1.0)
Definition: AudioEffect.h:77
Compressor inspired by https://github.com/YetAnotherElectronicsChannel/STM32_DSP_COMPRESSOR/blob/mast...
Definition: AudioEffect.h:466
+
void setRelease(int32_t releaseMs)
Defines the release duration in ms.
Definition: AudioEffect.h:498
+
Compressor(uint32_t sampleRate=44100, int32_t attackMs=30, int32_t releaseMs=20, int32_t holdMs=10, uint8_t thresholdPercent=10, float compressionRatio=0.5)
Default Constructor.
Definition: AudioEffect.h:472
+
Compressor(const Compressor &copy)=default
Copy Constructor.
+
void setCompressionRatio(float compressionRatio)
Defines the compression ratio from 0 to 1.
Definition: AudioEffect.h:515
+
void setHold(int32_t holdMs)
Defines the hold duration in ms.
Definition: AudioEffect.h:504
+
effect_t process(effect_t inSample)
Processes the sample.
Definition: AudioEffect.h:523
+
void setThresholdPercent(uint8_t thresholdPercent)
Defines the threshod in %.
Definition: AudioEffect.h:510
+
void setAttack(int32_t attackMs)
Defines the attack duration in ms.
Definition: AudioEffect.h:492
Delay/Echo AudioEffect. See https://wiki.analog.com/resources/tools-software/sharc-audio-module/barem...
Definition: AudioEffect.h:253
Delay(uint16_t duration_ms=1000, float depth=0.5, float feedbackAmount=1.0, uint32_t sampleRate=44100, bool zeroIfBufferEmpty=false)
e.g. depth=0.5, ms=1000, sampleRate=44100
Definition: AudioEffect.h:256
effect_t process(effect_t input)
calculates the effect output from the input
Definition: AudioEffect.h:306
diff --git a/classaudio__tools_1_1_compressor-members.html b/classaudio__tools_1_1_compressor-members.html index 8313b819a1..00ce5dbc75 100644 --- a/classaudio__tools_1_1_compressor-members.html +++ b/classaudio__tools_1_1_compressor-members.html @@ -77,15 +77,19 @@ attack_count (defined in Compressor)Compressorprotected AudioEffect()=default (defined in AudioEffect)AudioEffect clip(int32_t in, int16_t clipLimit=32767, int16_t resultLimit=32767)AudioEffectinlineprotected - CompStates enum name (defined in Compressor)Compressorprotected - copyParent(AudioEffect *copy) (defined in AudioEffect)AudioEffectinlineprotected - gain (defined in Compressor)Compressorprotected - gain_step_attack (defined in Compressor)Compressorprotected - gain_step_release (defined in Compressor)Compressorprotected - gainreduce (defined in Compressor)Compressorprotected - hold_count (defined in Compressor)Compressorprotected - id()AudioEffectinline - id_value (defined in AudioEffect)AudioEffectprotected + clone() (defined in Compressor)Compressorinlinevirtual + Compressor(const Compressor &copy)=defaultCompressor + Compressor(uint32_t sampleRate=44100, int32_t attackMs=30, int32_t releaseMs=20, int32_t holdMs=10, uint8_t thresholdPercent=10, float compressionRatio=0.5)Compressorinline + CompStates enum name (defined in Compressor)Compressorprotected + copyParent(AudioEffect *copy) (defined in AudioEffect)AudioEffectinlineprotected + gain (defined in Compressor)Compressorprotected + gain_step_attack (defined in Compressor)Compressorprotected + gain_step_release (defined in Compressor)Compressorprotected + gainreduce (defined in Compressor)Compressorprotected + hold_count (defined in Compressor)Compressorprotected + id()AudioEffectinline + id_value (defined in AudioEffect)AudioEffectprotected + process(effect_t inSample)Compressorinlinevirtual recalculate() (defined in Compressor)Compressorinlineprotected release_count (defined in Compressor)Compressorprotected S_Attack enum value (defined in Compressor)Compressorprotected @@ -94,11 +98,16 @@ S_Release enum value (defined in Compressor)Compressorprotected sample_rate (defined in Compressor)Compressorprotected setActive(bool value)AudioEffectinlinevirtual - setId(int id)AudioEffectinline - State (defined in Compressor)Compressorprotected - threshold (defined in Compressor)Compressorprotected - timeout (defined in Compressor)Compressorprotected - ~AudioEffect()=default (defined in AudioEffect)AudioEffectvirtual + setAttack(int32_t attackMs)Compressorinline + setCompressionRatio(float compressionRatio)Compressorinline + setHold(int32_t holdMs)Compressorinline + setId(int id)AudioEffectinline + setRelease(int32_t releaseMs)Compressorinline + setThresholdPercent(uint8_t thresholdPercent)Compressorinline + State (defined in Compressor)Compressorprotected + threshold (defined in Compressor)Compressorprotected + timeout (defined in Compressor)Compressorprotected + ~AudioEffect()=default (defined in AudioEffect)AudioEffectvirtual