tmk_core/protocol/lufa/LUFA-git/Projects/MIDIToneGenerator/MIDIToneGenerator.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2014.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2014  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaims all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Header file for AudioOutput.c.
  34  */
  35
  36 #ifndef _AUDIO_OUTPUT_H_
  37 #define _AUDIO_OUTPUT_H_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41                 #include <avr/wdt.h>
  42                 #include <avr/power.h>
  43                 #include <avr/pgmspace.h>
  44                 #include <avr/interrupt.h>
  45                 #include <stdbool.h>
  46
  47                 #include "Descriptors.h"
  48                 #include "Config/AppConfig.h"
  49
  50                 #include <LUFA/Drivers/Board/LEDs.h>
  51                 #include <LUFA/Drivers/USB/USB.h>
  52                 #include <LUFA/Platform/Platform.h>
  53
  54         /* Macros: */
  55                 /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
  56                 #define LEDMASK_USB_NOTREADY      LEDS_LED1
  57
  58                 /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
  59                 #define LEDMASK_USB_ENUMERATING  (LEDS_LED2 | LEDS_LED3)
  60
  61                 /** LED mask for the library LED driver, to indicate that the USB interface is ready. */
  62                 #define LEDMASK_USB_READY        (LEDS_LED2 | LEDS_LED4)
  63
  64                 /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
  65                 #define LEDMASK_USB_ERROR        (LEDS_LED1 | LEDS_LED3)
  66
  67                 /** Scale factor used to convert the floating point frequencies and ratios into a fixed point number */
  68                 #define SCALE_FACTOR               65536
  69
  70                 /** Base (lowest) allowable MIDI note frequency */
  71                 #define BASE_FREQUENCY             27.5
  72
  73                 /** Ratio between each note in an octave */
  74                 #define NOTE_OCTIVE_RATIO          1.05946
  75
  76                 /** Lowest valid MIDI pitch index */
  77                 #define BASE_PITCH_INDEX           21
  78
  79                 /** Number of samples in the virtual sample table (can be expanded to lower maximum frequency, but allow for
  80                  *  more simultaneous notes due to the reduced amount of processing time needed when the samples are spaced out)
  81                  */
  82                 #define VIRTUAL_SAMPLE_TABLE_SIZE  512
  83
  84                 /** Sample table increments per period for the base MIDI note frequency */
  85                 #define BASE_INCREMENT             (((F_CPU / VIRTUAL_SAMPLE_TABLE_SIZE / 2) / BASE_FREQUENCY))
  86
  87         /* Type Defines: */
  88                 typedef struct
  89                 {
  90                         uint8_t  LRUAge;
  91                         uint8_t  Pitch;
  92                         uint32_t TableIncrement;
  93                         uint32_t TablePosition;
  94                 } DDSNoteData;
  95
  96         /* Function Prototypes: */
  97                 void SetupHardware(void);
  98
  99                 void EVENT_USB_Device_Connect(void);
 100                 void EVENT_USB_Device_Disconnect(void);
 101                 void EVENT_USB_Device_ConfigurationChanged(void);
 102                 void EVENT_USB_Device_UnhandledControlRequest(void);
 103
 104 #endif
 105