Skip to content

Commit 33fdd1d

Browse files
drashnajackhumbert
drashna
authored and
jackhumbert
committed
Fix Audio Clicky sub-feature (qmk#2784)
* Fix Audio Clicky feature * Add to features
1 parent d1c3419 commit 33fdd1d

File tree

6 files changed

+87
-66
lines changed

6 files changed

+87
-66
lines changed

‎common_features.mk

+1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ ifeq ($(strip $(AUDIO_ENABLE)), yes)
3434
OPT_DEFS += -DAUDIO_ENABLE
3535
MUSIC_ENABLE := 1
3636
SRC += $(QUANTUM_DIR)/process_keycode/process_audio.c
37+
SRC += $(QUANTUM_DIR)/process_keycode/process_clicky.c
3738
ifeq ($(PLATFORM),AVR)
3839
SRC += $(QUANTUM_DIR)/audio/audio.c
3940
else

‎quantum/process_keycode/process_audio.c

-65
Original file line numberDiff line numberDiff line change
@@ -10,45 +10,7 @@ float voice_change_song[][2] = VOICE_CHANGE_SONG;
1010
#define PITCH_STANDARD_A 440.0f
1111
#endif
1212

13-
#ifdef AUDIO_CLICKY
14-
#ifdef AUDIO_CLICKY_ON
15-
bool clicky_enable = true;
16-
#else
17-
bool clicky_enable = false;
18-
#endif
19-
#ifndef AUDIO_CLICKY_FREQ_DEFAULT
20-
#define AUDIO_CLICKY_FREQ_DEFAULT 440.0f
21-
#endif
22-
#ifndef AUDIO_CLICKY_FREQ_MIN
23-
#define AUDIO_CLICKY_FREQ_MIN 65.0f
24-
#endif
25-
#ifndef AUDIO_CLICKY_FREQ_MAX
26-
#define AUDIO_CLICKY_FREQ_MAX 1500.0f
27-
#endif
28-
#ifndef AUDIO_CLICKY_FREQ_FACTOR
29-
#define AUDIO_CLICKY_FREQ_FACTOR 1.18921f
30-
#endif
31-
#ifndef AUDIO_CLICKY_FREQ_RANDOMNESS
32-
#define AUDIO_CLICKY_FREQ_RANDOMNESS 0.05f
33-
#endif
34-
35-
float clicky_freq = AUDIO_CLICKY_FREQ_DEFAULT;
36-
float clicky_song[][2] = {{AUDIO_CLICKY_FREQ_DEFAULT, 3}, {AUDIO_CLICKY_FREQ_DEFAULT, 1}}; // 3 and 1 --> durations
3713

38-
#ifndef NO_MUSIC_MODE
39-
extern bool music_activated;
40-
extern bool midi_activated;
41-
#endif
42-
43-
void clicky_play(void) {
44-
#ifndef NO_MUSIC_MODE
45-
if (music_activated || midi_activated) return;
46-
#endif
47-
clicky_song[0][0] = 2.0f * clicky_freq * (1.0f + AUDIO_CLICKY_FREQ_RANDOMNESS * ( ((float)rand()) / ((float)(RAND_MAX)) ) );
48-
clicky_song[1][0] = clicky_freq * (1.0f + AUDIO_CLICKY_FREQ_RANDOMNESS * ( ((float)rand()) / ((float)(RAND_MAX)) ) );
49-
PLAY_SONG(clicky_song);
50-
}
51-
#endif
5214

5315
static float compute_freq_for_midi_note(uint8_t note)
5416
{
@@ -89,33 +51,6 @@ bool process_audio(uint16_t keycode, keyrecord_t *record) {
8951
return false;
9052
}
9153

92-
#ifdef AUDIO_CLICKY
93-
if (keycode == CLICKY_TOGGLE && record->event.pressed) { clicky_enable = !clicky_enable; }
94-
95-
if (keycode == CLICKY_RESET && record->event.pressed) { clicky_freq = AUDIO_CLICKY_FREQ_DEFAULT; }
96-
97-
if (keycode == CLICKY_UP && record->event.pressed) {
98-
float new_freq = clicky_freq * AUDIO_CLICKY_FREQ_FACTOR;
99-
if (new_freq < AUDIO_CLICKY_FREQ_MAX) {
100-
clicky_freq = new_freq;
101-
}
102-
}
103-
if (keycode == CLICKY_TOGGLE && record->event.pressed) {
104-
float new_freq = clicky_freq / AUDIO_CLICKY_FREQ_FACTOR;
105-
if (new_freq > AUDIO_CLICKY_FREQ_MIN) {
106-
clicky_freq = new_freq;
107-
}
108-
}
109-
110-
111-
if ( clicky_enable ) {
112-
if (record->event.pressed) {
113-
stop_all_notes();
114-
clicky_play();;
115-
}
116-
}
117-
#endif // AUDIO_CLICKY
118-
11954
return true;
12055
}
12156

‎quantum/process_keycode/process_clicky.c

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
#include "audio.h"
2+
#include "process_clicky.h"
3+
4+
#ifdef AUDIO_CLICKY
5+
6+
#ifdef AUDIO_CLICKY_ON
7+
bool clicky_enable = true;
8+
#else // AUDIO_CLICKY_ON
9+
bool clicky_enable = false;
10+
#endif // AUDIO_CLICKY_ON
11+
#ifndef AUDIO_CLICKY_FREQ_DEFAULT
12+
#define AUDIO_CLICKY_FREQ_DEFAULT 440.0f
13+
#endif // !AUDIO_CLICKY_FREQ_DEFAULT
14+
#ifndef AUDIO_CLICKY_FREQ_MIN
15+
#define AUDIO_CLICKY_FREQ_MIN 65.0f
16+
#endif // !AUDIO_CLICKY_FREQ_MIN
17+
#ifndef AUDIO_CLICKY_FREQ_MAX
18+
#define AUDIO_CLICKY_FREQ_MAX 1500.0f
19+
#endif // !AUDIO_CLICKY_FREQ_MAX
20+
#ifndef AUDIO_CLICKY_FREQ_FACTOR
21+
#define AUDIO_CLICKY_FREQ_FACTOR 1.18921f
22+
#endif // !AUDIO_CLICKY_FREQ_FACTOR
23+
#ifndef AUDIO_CLICKY_FREQ_RANDOMNESS
24+
#define AUDIO_CLICKY_FREQ_RANDOMNESS 0.05f
25+
#endif // !AUDIO_CLICKY_FREQ_RANDOMNESS
26+
27+
float clicky_freq = AUDIO_CLICKY_FREQ_DEFAULT;
28+
float clicky_song[][2] = {{AUDIO_CLICKY_FREQ_DEFAULT, 3}, {AUDIO_CLICKY_FREQ_DEFAULT, 1}}; // 3 and 1 --> durations
29+
30+
#ifndef NO_MUSIC_MODE
31+
extern bool music_activated;
32+
extern bool midi_activated;
33+
#endif // !NO_MUSIC_MODE
34+
35+
void clicky_play(void) {
36+
#ifndef NO_MUSIC_MODE
37+
if (music_activated || midi_activated) return;
38+
#endif // !NO_MUSIC_MODE
39+
clicky_song[0][0] = 2.0f * clicky_freq * (1.0f + AUDIO_CLICKY_FREQ_RANDOMNESS * ( ((float)rand()) / ((float)(RAND_MAX)) ) );
40+
clicky_song[1][0] = clicky_freq * (1.0f + AUDIO_CLICKY_FREQ_RANDOMNESS * ( ((float)rand()) / ((float)(RAND_MAX)) ) );
41+
PLAY_SONG(clicky_song);
42+
}
43+
44+
bool process_clicky(uint16_t keycode, keyrecord_t *record) {
45+
if (keycode == CLICKY_TOGGLE && record->event.pressed) { clicky_enable = !clicky_enable; }
46+
47+
if (keycode == CLICKY_RESET && record->event.pressed) { clicky_freq = AUDIO_CLICKY_FREQ_DEFAULT; }
48+
49+
if (keycode == CLICKY_UP && record->event.pressed) {
50+
float new_freq = clicky_freq * AUDIO_CLICKY_FREQ_FACTOR;
51+
if (new_freq < AUDIO_CLICKY_FREQ_MAX) {
52+
clicky_freq = new_freq;
53+
}
54+
}
55+
if (keycode == CLICKY_TOGGLE && record->event.pressed) {
56+
float new_freq = clicky_freq / AUDIO_CLICKY_FREQ_FACTOR;
57+
if (new_freq > AUDIO_CLICKY_FREQ_MIN) {
58+
clicky_freq = new_freq;
59+
}
60+
}
61+
62+
63+
if ( clicky_enable ) {
64+
if (record->event.pressed) {
65+
stop_all_notes();
66+
clicky_play();;
67+
}
68+
}
69+
return true;
70+
}
71+
72+
#endif //AUDIO_CLICKY

‎quantum/process_keycode/process_clicky.h

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#ifndef PROCESS_CLICKY_H
2+
#define PROCESS_CLICKY_H
3+
4+
void clicky_play(void);
5+
bool process_clicky(uint16_t keycode, keyrecord_t *record);
6+
7+
#endif

‎quantum/quantum.c

+4-1
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,9 @@ bool process_record_quantum(keyrecord_t *record) {
226226
// Must run first to be able to mask key_up events.
227227
process_key_lock(&keycode, record) &&
228228
#endif
229+
#if defined(AUDIO_ENABLE) && defined(AUDIO_CLICKY)
230+
process_clicky(keycode, record) &&
231+
#endif //AUDIO_CLICKY
229232
process_record_kb(keycode, record) &&
230233
#if defined(MIDI_ENABLE) && defined(MIDI_ADVANCED)
231234
process_midi(keycode, record) &&
@@ -236,7 +239,7 @@ bool process_record_quantum(keyrecord_t *record) {
236239
#ifdef STENO_ENABLE
237240
process_steno(keycode, record) &&
238241
#endif
239-
#if ( defined(AUDIO_ENABLE) || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))) && !defined(NO_MUSIC_MODE)
242+
#if ( defined(AUDIO_ENABLE) || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))) && !defined(NO_MUSIC_MODE)
240243
process_music(keycode, record) &&
241244
#endif
242245
#ifdef TAP_DANCE_ENABLE

‎quantum/quantum.h

+3
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,9 @@ extern uint32_t default_layer_state;
5757
#ifdef AUDIO_ENABLE
5858
#include "audio.h"
5959
#include "process_audio.h"
60+
#ifdef AUDIO_CLICKY
61+
#include "process_clicky.h"
62+
#endif // AUDIO_CLICKY
6063
#endif
6164

6265
#ifdef STENO_ENABLE

0 commit comments

Comments
 (0)