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 #include <avr/io.h>
  22 #include <util/delay.h>
  23 #include "musical_notes.h"
  24 #include "song_list.h"
  25 #include "voices.h"
  26 #include "quantum.h"
  27
  28 // Largely untested PWM audio mode (doesn't sound as good)
  29 // #define PWM_AUDIO
  30
  31 // #define VIBRATO_ENABLE
  32
  33 // Enable vibrato strength/amplitude - slows down ISR too much
  34 // #define VIBRATO_STRENGTH_ENABLE
  35
  36 typedef union {
  37     uint8_t raw;
  38     struct {
  39         bool    enable :1;
  40         uint8_t level  :7;
  41     };
  42 } audio_config_t;
  43
  44 bool is_audio_on(void);
  45 void audio_toggle(void);
  46 void audio_on(void);
  47 void audio_off(void);
  48
  49 // Vibrato rate functions
  50
  51 #ifdef VIBRATO_ENABLE
  52
  53 void set_vibrato_rate(float rate);
  54 void increase_vibrato_rate(float change);
  55 void decrease_vibrato_rate(float change);
  56
  57 #ifdef VIBRATO_STRENGTH_ENABLE
  58
  59 void set_vibrato_strength(float strength);
  60 void increase_vibrato_strength(float change);
  61 void decrease_vibrato_strength(float change);
  62
  63 #endif
  64
  65 #endif
  66
  67 // Polyphony functions
  68
  69 void set_polyphony_rate(float rate);
  70 void enable_polyphony(void);
  71 void disable_polyphony(void);
  72 void increase_polyphony_rate(float change);
  73 void decrease_polyphony_rate(float change);
  74
  75 void set_timbre(float timbre);
  76 void set_tempo(uint8_t tempo);
  77
  78 void increase_tempo(uint8_t tempo_change);
  79 void decrease_tempo(uint8_t tempo_change);
  80
  81 void audio_init(void);
  82
  83 #ifdef PWM_AUDIO
  84 void play_sample(uint8_t * s, uint16_t l, bool r);
  85 #endif
  86 void play_note(float freq, int vol);
  87 void stop_note(float freq);
  88 void stop_all_notes(void);
  89 void play_notes(float (*np)[][2], uint16_t n_count, bool n_repeat);
  90
  91 #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), \
  92                            0 + (12*1), 2 + (12*1), 4 + (12*1), 5 + (12*1), 7 + (12*1), 9 + (12*1), 11 + (12*1), \
  93                            0 + (12*2), 2 + (12*2), 4 + (12*2), 5 + (12*2), 7 + (12*2), 9 + (12*2), 11 + (12*2), \
  94                            0 + (12*3), 2 + (12*3), 4 + (12*3), 5 + (12*3), 7 + (12*3), 9 + (12*3), 11 + (12*3), \
  95                            0 + (12*4), 2 + (12*4), 4 + (12*4), 5 + (12*4), 7 + (12*4), 9 + (12*4), 11 + (12*4), }
  96
  97 // These macros are used to allow play_notes to play an array of indeterminate
  98 // length. This works around the limitation of C's sizeof operation on pointers.
  99 // The global float array for the song must be used here.
 100 #define NOTE_ARRAY_SIZE(x) ((int16_t)(sizeof(x) / (sizeof(x[0]))))
 101 #define PLAY_NOTE_ARRAY(note_array, note_repeat, deprecated_arg) play_notes(&note_array, NOTE_ARRAY_SIZE((note_array)), (note_repeat)); \
 102         _Pragma ("message \"'PLAY_NOTE_ARRAY' macro is deprecated\"")
 103 #define PLAY_SONG(note_array) play_notes(&note_array, NOTE_ARRAY_SIZE((note_array)), false)
 104 #define PLAY_LOOP(note_array) play_notes(&note_array, NOTE_ARRAY_SIZE((note_array)), true)
 105
 106 bool is_playing_notes(void);
 107
 108 #endif