quantum/audio/audio.h

   1 /* Copyright 2016 Jack Humbert
   2  *
   3  * This program is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  */
  16 #ifndef AUDIO_H
  17 #define AUDIO_H
  18
  19 #include <stdint.h>
  20 #include <stdbool.h>
  21 #if defined(__AVR__)
  22   #include <avr/io.h>
  23 #endif
  24 #include "wait.h"
  25 #include "musical_notes.h"
  26 #include "song_list.h"
  27 #include "voices.h"
  28 #include "quantum.h"
  29 #include <math.h>
  30
  31 // Largely untested PWM audio mode (doesn't sound as good)
  32 // #define PWM_AUDIO
  33
  34 // #define VIBRATO_ENABLE
  35
  36 // Enable vibrato strength/amplitude - slows down ISR too much
  37 // #define VIBRATO_STRENGTH_ENABLE
  38
  39 typedef union {
  40     uint8_t raw;
  41     struct {
  42         bool    enable :1;
  43         bool    clicky_enable :1;
  44         uint8_t level  :6;
  45     };
  46 } audio_config_t;
  47
  48 bool is_audio_on(void);
  49 void audio_toggle(void);
  50 void audio_on(void);
  51 void audio_off(void);
  52
  53 // Vibrato rate functions
  54
  55 #ifdef VIBRATO_ENABLE
  56
  57 void set_vibrato_rate(float rate);
  58 void increase_vibrato_rate(float change);
  59 void decrease_vibrato_rate(float change);
  60
  61 #ifdef VIBRATO_STRENGTH_ENABLE
  62
  63 void set_vibrato_strength(float strength);
  64 void increase_vibrato_strength(float change);
  65 void decrease_vibrato_strength(float change);
  66
  67 #endif
  68
  69 #endif
  70
  71 // Polyphony functions
  72
  73 void set_polyphony_rate(float rate);
  74 void enable_polyphony(void);
  75 void disable_polyphony(void);
  76 void increase_polyphony_rate(float change);
  77 void decrease_polyphony_rate(float change);
  78
  79 void set_timbre(float timbre);
  80 void set_tempo(uint8_t tempo);
  81
  82 void increase_tempo(uint8_t tempo_change);
  83 void decrease_tempo(uint8_t tempo_change);
  84
  85 void audio_init(void);
  86
  87 #ifdef PWM_AUDIO
  88 void play_sample(uint8_t * s, uint16_t l, bool r);
  89 #endif
  90 void play_note(float freq, int vol);
  91 void stop_note(float freq);
  92 void stop_all_notes(void);
  93 void play_notes(float (*np)[][2], uint16_t n_count, bool n_repeat);
  94
  95 #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), \
  96                            0 + (12*1), 2 + (12*1), 4 + (12*1), 5 + (12*1), 7 + (12*1), 9 + (12*1), 11 + (12*1), \
  97                            0 + (12*2), 2 + (12*2), 4 + (12*2), 5 + (12*2), 7 + (12*2), 9 + (12*2), 11 + (12*2), \
  98                            0 + (12*3), 2 + (12*3), 4 + (12*3), 5 + (12*3), 7 + (12*3), 9 + (12*3), 11 + (12*3), \
  99                            0 + (12*4), 2 + (12*4), 4 + (12*4), 5 + (12*4), 7 + (12*4), 9 + (12*4), 11 + (12*4), }
 100
 101 // These macros are used to allow play_notes to play an array of indeterminate
 102 // length. This works around the limitation of C's sizeof operation on pointers.
 103 // The global float array for the song must be used here.
 104 #define NOTE_ARRAY_SIZE(x) ((int16_t)(sizeof(x) / (sizeof(x[0]))))
 105 #define PLAY_NOTE_ARRAY(note_array, note_repeat, deprecated_arg) play_notes(&note_array, NOTE_ARRAY_SIZE((note_array)), (note_repeat)); \
 106         _Pragma ("message \"'PLAY_NOTE_ARRAY' macro is deprecated\"")
 107 #define PLAY_SONG(note_array) play_notes(&note_array, NOTE_ARRAY_SIZE((note_array)), false)
 108 #define PLAY_LOOP(note_array) play_notes(&note_array, NOTE_ARRAY_SIZE((note_array)), true)
 109
 110 bool is_playing_notes(void);
 111
 112 #endif