]> git.donarmstrong.com Git - qmk_firmware.git/blob - quantum/audio/audio.h
Merge remote-tracking branch 'upstream/master'
[qmk_firmware.git] / quantum / audio / audio.h
1 #ifndef AUDIO_H
2 #define AUDIO_H
3
4 #include <stdint.h>
5 #include <stdbool.h>
6 #include <avr/io.h>
7 #include <util/delay.h>
8 #include "musical_notes.h"
9 #include "song_list.h"
10 #include "voices.h"
11 #include "quantum.h"
12
13 // Largely untested PWM audio mode (doesn't sound as good)
14 // #define PWM_AUDIO
15
16 // #define VIBRATO_ENABLE
17
18 // Enable vibrato strength/amplitude - slows down ISR too much
19 // #define VIBRATO_STRENGTH_ENABLE
20
21 typedef union {
22     uint8_t raw;
23     struct {
24         bool    enable :1;
25         uint8_t level  :7;
26     };
27 } audio_config_t;
28
29 bool is_audio_on(void);
30 void audio_toggle(void);
31 void audio_on(void);
32 void audio_off(void);
33
34 // Vibrato rate functions
35
36 #ifdef VIBRATO_ENABLE
37
38 void set_vibrato_rate(float rate);
39 void increase_vibrato_rate(float change);
40 void decrease_vibrato_rate(float change);
41
42 #ifdef VIBRATO_STRENGTH_ENABLE
43
44 void set_vibrato_strength(float strength);
45 void increase_vibrato_strength(float change);
46 void decrease_vibrato_strength(float change);
47
48 #endif
49
50 #endif
51
52 // Polyphony functions
53
54 void set_polyphony_rate(float rate);
55 void enable_polyphony(void);
56 void disable_polyphony(void);
57 void increase_polyphony_rate(float change);
58 void decrease_polyphony_rate(float change);
59
60 void set_timbre(float timbre);
61 void set_tempo(uint8_t tempo);
62
63 void increase_tempo(uint8_t tempo_change);
64 void decrease_tempo(uint8_t tempo_change);
65
66 void audio_init(void);
67
68 #ifdef PWM_AUDIO
69 void play_sample(uint8_t * s, uint16_t l, bool r);
70 #endif
71 void play_note(float freq, int vol);
72 void stop_note(float freq);
73 void stop_all_notes(void);
74 void play_notes(float (*np)[][2], uint16_t n_count, bool n_repeat, float n_rest);
75
76 #define SCALE (int8_t []){ 0 + (12*0), 2 + (12*0), 4 + (12*0), 5 + (12*0), 7 + (12*0), 9 + (12*0), 11 + (12*0), \
77                            0 + (12*1), 2 + (12*1), 4 + (12*1), 5 + (12*1), 7 + (12*1), 9 + (12*1), 11 + (12*1), \
78                            0 + (12*2), 2 + (12*2), 4 + (12*2), 5 + (12*2), 7 + (12*2), 9 + (12*2), 11 + (12*2), \
79                            0 + (12*3), 2 + (12*3), 4 + (12*3), 5 + (12*3), 7 + (12*3), 9 + (12*3), 11 + (12*3), \
80                            0 + (12*4), 2 + (12*4), 4 + (12*4), 5 + (12*4), 7 + (12*4), 9 + (12*4), 11 + (12*4), }
81
82 // These macros are used to allow play_notes to play an array of indeterminate
83 // length. This works around the limitation of C's sizeof operation on pointers.
84 // The global float array for the song must be used here.
85 #define NOTE_ARRAY_SIZE(x) ((int16_t)(sizeof(x) / (sizeof(x[0]))))
86 #define PLAY_NOTE_ARRAY(note_array, note_repeat, note_rest_style) play_notes(&note_array, NOTE_ARRAY_SIZE((note_array)), (note_repeat), (note_rest_style));
87
88
89 bool is_playing_notes(void);
90
91 #endif