Remerge 0.16.x' into firmware21

5 files changed, 93 insertions, 48 deletions

diff --git a/quantum/audio/audio.c b/quantum/audio/audio.c
index 49bb309e80..c6523b908c 100644
--- a/quantum/audio/audio.c
+++ b/quantum/audio/audio.c
@@ -64,21 +64,21 @@
 #ifndef AUDIO_TONE_STACKSIZE
 #    define AUDIO_TONE_STACKSIZE 8
 #endif
-uint8_t        active_tones = 0;             // number of tones pushed onto the stack by audio_play_tone - might be more than the hardware is able to reproduce at any single time
-musical_tone_t tones[AUDIO_TONE_STACKSIZE];  // stack of currently active tones
+uint8_t        active_tones = 0;            // number of tones pushed onto the stack by audio_play_tone - might be more than the hardware is able to reproduce at any single time
+musical_tone_t tones[AUDIO_TONE_STACKSIZE]; // stack of currently active tones
 
-bool playing_melody = false;  // playing a SONG?
-bool playing_note   = false;  // or (possibly multiple simultaneous) tones
-bool state_changed  = false;  // global flag, which is set if anything changes with the active_tones
+bool playing_melody = false; // playing a SONG?
+bool playing_note   = false; // or (possibly multiple simultaneous) tones
+bool state_changed  = false; // global flag, which is set if anything changes with the active_tones
 
 // melody/SONG related state variables
-float (*notes_pointer)[][2];                            // SONG, an array of MUSICAL_NOTEs
-uint16_t notes_count;                                   // length of the notes_pointer array
-bool     notes_repeat;                                  // PLAY_SONG or PLAY_LOOP?
-uint16_t melody_current_note_duration = 0;              // duration of the currently playing note from the active melody, in ms
-uint8_t  note_tempo                   = TEMPO_DEFAULT;  // beats-per-minute
-uint16_t current_note                 = 0;              // index into the array at notes_pointer
-bool     note_resting                 = false;          // if a short pause was introduced between two notes with the same frequency while playing a melody
+float (*notes_pointer)[][2];                           // SONG, an array of MUSICAL_NOTEs
+uint16_t notes_count;                                  // length of the notes_pointer array
+bool     notes_repeat;                                 // PLAY_SONG or PLAY_LOOP?
+uint16_t melody_current_note_duration = 0;             // duration of the currently playing note from the active melody, in ms
+uint8_t  note_tempo                   = TEMPO_DEFAULT; // beats-per-minute
+uint16_t current_note                 = 0;             // index into the array at notes_pointer
+bool     note_resting                 = false;         // if a short pause was introduced between two notes with the same frequency while playing a melody
 uint16_t last_timestamp               = 0;
 
 #ifdef AUDIO_ENABLE_TONE_MULTIPLEXING
@@ -86,7 +86,7 @@ uint16_t last_timestamp               = 0;
 #        define AUDIO_MAX_SIMULTANEOUS_TONES 3
 #    endif
 uint16_t tone_multiplexing_rate        = AUDIO_TONE_MULTIPLEXING_RATE_DEFAULT;
-uint8_t  tone_multiplexing_index_shift = 0;  // offset used on active-tone array access
+uint8_t  tone_multiplexing_index_shift = 0; // offset used on active-tone array access
 #endif
 
 // provided and used by voices.c
@@ -123,12 +123,12 @@ void audio_init() {
         eeconfig_init();
     }
     audio_config.raw = eeconfig_read_audio();
-#else  // EEPROM settings
+#else // EEPROM settings
     audio_config.enable        = true;
 #    ifdef AUDIO_CLICKY_ON
     audio_config.clicky_enable = true;
 #    endif
-#endif  // EEPROM settings
+#endif // EEPROM settings
 
     for (uint8_t i = 0; i < AUDIO_TONE_STACKSIZE; i++) {
         tones[i] = (musical_tone_t){.time_started = 0, .pitch = -1.0f, .duration = 0};
@@ -160,6 +160,8 @@ void audio_toggle(void) {
     eeconfig_update_audio(audio_config.raw);
     if (audio_config.enable) {
         audio_on_user();
+    } else {
+        audio_off_user();
     }
 }
 
@@ -172,13 +174,16 @@ void audio_on(void) {
 
 void audio_off(void) {
     PLAY_SONG(audio_off_song);
+    audio_off_user();
     wait_ms(100);
     audio_stop_all();
     audio_config.enable = 0;
     eeconfig_update_audio(audio_config.raw);
 }
 
-bool audio_is_on(void) { return (audio_config.enable != 0); }
+bool audio_is_on(void) {
+    return (audio_config.enable != 0);
+}
 
 void audio_stop_all() {
     if (audio_driver_stopped) {
@@ -265,7 +270,7 @@ void audio_play_note(float pitch, uint16_t duration) {
                 tones[j]     = tones[j + 1];
                 tones[j + 1] = (musical_tone_t){.time_started = timer_read(), .pitch = pitch, .duration = duration};
             }
-            return;  // since this frequency played already, the hardware was already started
+            return; // since this frequency played already, the hardware was already started
         }
     }
 
@@ -283,7 +288,7 @@ void audio_play_note(float pitch, uint16_t duration) {
     tones[active_tones - 1] = (musical_tone_t){.time_started = timer_read(), .pitch = pitch, .duration = duration};
 
     // TODO: needs to be handled per note/tone -> use its timestamp instead?
-    voices_timer = timer_read();  // reset to zero, for the effects added by voices.c
+    voices_timer = timer_read(); // reset to zero, for the effects added by voices.c
 
     if (audio_driver_stopped) {
         audio_driver_start();
@@ -291,7 +296,9 @@ void audio_play_note(float pitch, uint16_t duration) {
     }
 }
 
-void audio_play_tone(float pitch) { audio_play_note(pitch, 0xffff); }
+void audio_play_tone(float pitch) {
+    audio_play_note(pitch, 0xffff);
+}
 
 void audio_play_melody(float (*np)[][2], uint16_t n_count, bool n_repeat) {
     if (!audio_config.enable) {
@@ -313,7 +320,7 @@ void audio_play_melody(float (*np)[][2], uint16_t n_count, bool n_repeat) {
     notes_count   = n_count;
     notes_repeat  = n_repeat;
 
-    current_note = 0;  // note in the melody-array/list at note_pointer
+    current_note = 0; // note in the melody-array/list at note_pointer
 
     // start first note manually, which also starts the audio_driver
     // all following/remaining notes are played by 'audio_update_state'
@@ -344,11 +351,17 @@ void  audio_play_click(uint16_t delay, float pitch, uint16_t duration) {
     }
 }
 
-bool audio_is_playing_note(void) { return playing_note; }
+bool audio_is_playing_note(void) {
+    return playing_note;
+}
 
-bool audio_is_playing_melody(void) { return playing_melody; }
+bool audio_is_playing_melody(void) {
+    return playing_melody;
+}
 
-uint8_t audio_get_number_of_active_tones(void) { return active_tones; }
+uint8_t audio_get_number_of_active_tones(void) {
+    return active_tones;
+}
 
 float audio_get_frequency(uint8_t tone_index) {
     if (tone_index >= active_tones) {
@@ -367,7 +380,7 @@ float audio_get_processed_frequency(uint8_t tone_index) {
 
 #ifdef AUDIO_ENABLE_TONE_MULTIPLEXING
     index = index - tone_multiplexing_index_shift;
-    if (index < 0)  // wrap around
+    if (index < 0) // wrap around
         index += active_tones;
 #endif
 
@@ -393,7 +406,7 @@ bool audio_update_state(void) {
             last_timestamp         = current_time;
             uint16_t previous_note = current_note;
             current_note++;
-            voices_timer = timer_read();  // reset to zero, for the effects added by voices.c
+            voices_timer = timer_read(); // reset to zero, for the effects added by voices.c
 
             if (current_note >= notes_count) {
                 if (notes_repeat) {
@@ -463,11 +476,11 @@ bool audio_update_state(void) {
 
         // housekeeping: stop notes that have no playtime left
         for (int i = 0; i < active_tones; i++) {
-            if ((tones[i].duration != 0xffff)  // indefinitely playing notes, started by 'audio_play_tone'
-                && (tones[i].duration != 0)    // 'uninitialized'
+            if ((tones[i].duration != 0xffff) // indefinitely playing notes, started by 'audio_play_tone'
+                && (tones[i].duration != 0)   // 'uninitialized'
             ) {
                 if (timer_elapsed(tones[i].time_started) >= tones[i].duration) {
-                    audio_stop_tone(tones[i].pitch);  // also sets 'state_changed=true'
+                    audio_stop_tone(tones[i].pitch); // also sets 'state_changed=true'
                 }
             }
         }
@@ -484,9 +497,15 @@ bool audio_update_state(void) {
 
 // Tone-multiplexing functions
 #ifdef AUDIO_ENABLE_TONE_MULTIPLEXING
-void audio_set_tone_multiplexing_rate(uint16_t rate) { tone_multiplexing_rate = rate; }
-void audio_enable_tone_multiplexing(void) { tone_multiplexing_rate = AUDIO_TONE_MULTIPLEXING_RATE_DEFAULT; }
-void audio_disable_tone_multiplexing(void) { tone_multiplexing_rate = 0; }
+void audio_set_tone_multiplexing_rate(uint16_t rate) {
+    tone_multiplexing_rate = rate;
+}
+void audio_enable_tone_multiplexing(void) {
+    tone_multiplexing_rate = AUDIO_TONE_MULTIPLEXING_RATE_DEFAULT;
+}
+void audio_disable_tone_multiplexing(void) {
+    tone_multiplexing_rate = 0;
+}
 void audio_increase_tone_multiplexing_rate(uint16_t change) {
     if ((0xffff - change) > tone_multiplexing_rate) {
         tone_multiplexing_rate += change;
diff --git a/quantum/audio/audio.h b/quantum/audio/audio.h
index 290d461f5a..fe23cf3ed1 100644
--- a/quantum/audio/audio.h
+++ b/quantum/audio/audio.h
@@ -54,9 +54,9 @@ typedef union {
  * "A musical tone is characterized by its duration, pitch, intensity (or loudness), and timbre (or quality)"
  */
 typedef struct {
-    uint16_t time_started;  // timestamp the tone/note was started, system time runs with 1ms resolution -> 16bit timer overflows every ~64 seconds, long enough under normal circumstances; but might be too soon for long-duration notes when the note_tempo is set to a very low value
-    float    pitch;         // aka frequency, in Hz
-    uint16_t duration;      // in ms, converted from the musical_notes.h unit which has 64parts to a beat, factoring in the current tempo in beats-per-minute
+    uint16_t time_started; // timestamp the tone/note was started, system time runs with 1ms resolution -> 16bit timer overflows every ~64 seconds, long enough under normal circumstances; but might be too soon for long-duration notes when the note_tempo is set to a very low value
+    float    pitch;        // aka frequency, in Hz
+    uint16_t duration;     // in ms, converted from the musical_notes.h unit which has 64parts to a beat, factoring in the current tempo in beats-per-minute
     // float intensity;    // aka volume [0,1] TODO: not used at the moment; pwm drivers can't handle it
     // uint8_t timbre;     // range: [0,100] TODO: this currently kept track of globally, should we do this per tone instead?
 } musical_tone_t;
diff --git a/quantum/audio/song_list.h b/quantum/audio/song_list.h
index 8e80a016aa..3e425abb47 100644
--- a/quantum/audio/song_list.h
+++ b/quantum/audio/song_list.h
@@ -22,7 +22,7 @@
 
 #if __has_include("user_song_list.h")
 #    include "user_song_list.h"
-#endif  // if file exists
+#endif // if file exists
 
 #define NO_SOUND
 
diff --git a/quantum/audio/voices.c b/quantum/audio/voices.c
index d43fb8d169..4b7d14171f 100644
--- a/quantum/audio/voices.c
+++ b/quantum/audio/voices.c
@@ -32,10 +32,22 @@ voice_type voice = AUDIO_VOICE_DEFAULT;
 voice_type voice = default_voice;
 #endif
 
-void set_voice(voice_type v) { voice = v; }
+void set_voice(voice_type v) {
+    voice = v;
+}
 
+<<<<<<< HEAD
 void voice_iterate() { voice = (voice + 1) % number_of_voices; }
 void voice_deiterate() { voice = (voice - 1 + number_of_voices) % number_of_voices; }
+=======
+void voice_iterate() {
+    voice = (voice + 1) % number_of_voices;
+}
+
+void voice_deiterate() {
+    voice = (voice - 1 + number_of_voices) % number_of_voices;
+}
+>>>>>>> qmk/master
 
 #ifdef AUDIO_VOICES
 float mod(float a, int b) {
@@ -66,8 +78,8 @@ float voice_envelope(float frequency) {
     // envelope_index ranges from 0 to 0xFFFF, which is preserved at 880.0 Hz
 //    __attribute__((unused)) uint16_t compensated_index = (uint16_t)((float)envelope_index * (880.0 / frequency));
 #ifdef AUDIO_VOICES
-    uint16_t envelope_index    = timer_elapsed(voices_timer);  // TODO: multiply in some factor?
-    uint16_t compensated_index = envelope_index / 100;         // TODO: correct factor would be?
+    uint16_t envelope_index    = timer_elapsed(voices_timer); // TODO: multiply in some factor?
+    uint16_t compensated_index = envelope_index / 100;        // TODO: correct factor would be?
 #endif
 
     switch (voice) {
@@ -302,7 +314,7 @@ float voice_envelope(float frequency) {
             //         note_timbre = TIMBRE_25;
             //     break;
 
-#endif  // AUDIO_VOICES
+#endif // AUDIO_VOICES
 
         default:
             break;
@@ -317,19 +329,31 @@ float voice_envelope(float frequency) {
         // TODO: where to keep track of the start-frequency?
         // frequency = voice_add_glissando(??, frequency);
     }
-#endif  // AUDIO_VOICES
+#endif // AUDIO_VOICES
 
     return frequency;
 }
 
 // Vibrato functions
 
-void voice_set_vibrato_rate(float rate) { vibrato_rate = rate; }
-void voice_increase_vibrato_rate(float change) { vibrato_rate *= change; }
-void voice_decrease_vibrato_rate(float change) { vibrato_rate /= change; }
-void voice_set_vibrato_strength(float strength) { vibrato_strength = strength; }
-void voice_increase_vibrato_strength(float change) { vibrato_strength *= change; }
-void voice_decrease_vibrato_strength(float change) { vibrato_strength /= change; }
+void voice_set_vibrato_rate(float rate) {
+    vibrato_rate = rate;
+}
+void voice_increase_vibrato_rate(float change) {
+    vibrato_rate *= change;
+}
+void voice_decrease_vibrato_rate(float change) {
+    vibrato_rate /= change;
+}
+void voice_set_vibrato_strength(float strength) {
+    vibrato_strength = strength;
+}
+void voice_increase_vibrato_strength(float change) {
+    vibrato_strength *= change;
+}
+void voice_decrease_vibrato_strength(float change) {
+    vibrato_strength /= change;
+}
 
 // Timbre functions
 
@@ -338,4 +362,6 @@ void voice_set_timbre(uint8_t timbre) {
         note_timbre = timbre;
     }
 }
-uint8_t voice_get_timbre(void) { return note_timbre; }
+uint8_t voice_get_timbre(void) {
+    return note_timbre;
+}
diff --git a/quantum/audio/voices.h b/quantum/audio/voices.h
index d3fd62dc3f..de3c6db21e 100644
--- a/quantum/audio/voices.h
+++ b/quantum/audio/voices.h
@@ -41,7 +41,7 @@ typedef enum {
 // duty_third_down,
 // duty_fifth_third_down,
 #endif
-    number_of_voices  // important that this is last
+    number_of_voices // important that this is last
 } voice_type;
 
 void set_voice(voice_type v);