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