AudioHandler.h

#ifndef AUDIO_HANDLER_H

#include <HardwareSerial.h>
#include "RPU_Config.h"
#include "RPU.h"


#define AUDIO_PLAY_TYPE_CHIMES            1
#define AUDIO_PLAY_TYPE_ORIGINAL_SOUNDS   2
#define AUDIO_PLAY_TYPE_WAV_TRIGGER       4

#define NUMBER_OF_SONGS_REMEMBERED    10

#define VOICE_NOTIFICATION_STACK_SIZE   5
#define VOICE_NOTIFICATION_STACK_EMPTY  0xFFFF

#define BACKGROUND_TRACK_NONE           0xFFFF


struct AudioSoundtrack {
  unsigned short TrackIndex;
  unsigned short TrackLength;
};


#define SOUND_CARD_QUEUE_SIZE 100
#define SB300_SOUND_FUNCTION_SQUARE_WAVE  0
#define SB300_SOUND_FUNCTION_ANALOG       1
#define SOUND_EFFECT_QUEUE_SIZE 50

struct SoundCardCommandEntry {
  byte soundFunction;
  byte soundRegister;
  byte soundByte;
  unsigned long playTime;
};

#define SOUND_QUEUE_SIZE 30

struct SoundEntry {
  unsigned short soundIndex;
  byte audioType;
  byte overrideVolume;
  unsigned long playTime;  
};

// These SoundEFfectEntry & Queue functions parcel out FX to the
// built-in sound card because it can only handle one sound
// at a time.
struct SoundEffectEntry {
  unsigned short soundEffectNum;
  unsigned long requestedPlayTime;
  unsigned long playUntil;
  byte priority; // 0 is least important, 100 is most
  boolean inUse;
};



#define CMD_GET_VERSION          1
#define CMD_GET_SYS_INFO        2
#define CMD_TRACK_CONTROL       3
#define CMD_STOP_ALL          4
#define CMD_MASTER_VOLUME       5
#define CMD_TRACK_VOLUME        8
#define CMD_AMP_POWER         9
#define CMD_TRACK_FADE          10
#define CMD_RESUME_ALL_SYNC       11
#define CMD_SAMPLERATE_OFFSET     12
#define CMD_TRACK_CONTROL_EX      13
#define CMD_SET_REPORTING       14
#define CMD_SET_TRIGGER_BANK      15

#define TRK_PLAY_SOLO         0
#define TRK_PLAY_POLY         1
#define TRK_PAUSE           2
#define TRK_RESUME            3
#define TRK_STOP            4
#define TRK_LOOP_ON           5
#define TRK_LOOP_OFF          6
#define TRK_LOAD            7

#define RSP_VERSION_STRING        129
#define RSP_SYSTEM_INFO         130
#define RSP_STATUS            131
#define RSP_TRACK_REPORT        132

#define MAX_MESSAGE_LEN         32
#define MAX_NUM_VOICES          14
#define VERSION_STRING_LEN        21

#define SOM1  0xf0
#define SOM2  0xaa
#define EOM   0x55


#if defined(RPU_OS_USE_WAV_TRIGGER) || defined(RPU_OS_USE_WAV_TRIGGER_1p3)

#if (RPU_OS_HARDWARE_REV<=3)
#define WTSerial Serial
#else
#define WTSerial Serial1 
#endif

class wavTrigger
{
public:
  wavTrigger() {;}
  ~wavTrigger() {;}
  void start(void);
  void update(void);
  void flush(void);
  void setReporting(bool enable);
  void setAmpPwr(bool enable);
  bool getVersion(char *pDst, int len);
  int getNumTracks(void);
  bool isTrackPlaying(int trk);
  void masterGain(int gain);
  void stopAllTracks(void);
  void resumeAllInSync(void);
  void trackPlaySolo(int trk);
  void trackPlaySolo(int trk, bool lock);
  void trackPlayPoly(int trk);
  void trackPlayPoly(int trk, bool lock);
  void trackLoad(int trk);
  void trackLoad(int trk, bool lock);
  void trackStop(int trk);
  void trackPause(int trk);
  void trackResume(int trk);
  void trackLoop(int trk, bool enable);
  void trackGain(int trk, int gain);
  void trackFade(int trk, int gain, int time, bool stopFlag);
  void samplerateOffset(int offset);
  void setTriggerBank(int bank);

private:
  void trackControl(int trk, int code);
  void trackControl(int trk, int code, bool lock);

  uint16_t voiceTable[MAX_NUM_VOICES];
  uint8_t rxMessage[MAX_MESSAGE_LEN];
  char version[VERSION_STRING_LEN];
  uint16_t numTracks;
  uint8_t numVoices;
  uint8_t rxCount;
  uint8_t rxLen;
  bool rxMsgReady;
  bool versionRcvd;
  bool sysinfoRcvd;
};

#endif

#define INVALID_SOUND_INDEX   0xFFFF

class AudioHandler
{
  public:
    AudioHandler();
    ~AudioHandler();

    boolean InitDevices(byte audioType);

    void OutputTracksPlaying();

    void SetSoundFXVolume(byte s_volume);
    void SetNotificationsVolume(byte s_volume);
    void SetMusicVolume(byte s_volume);
    void SetMusicDuckingGain(byte s_ducking);

    boolean PlayBackgroundSoundtrack(AudioSoundtrack *soundtrackArray, unsigned short numSoundtrackEntries, unsigned long currentTime, boolean randomOrder=true);
    boolean PlayBackgroundSong(unsigned short trackIndex, boolean loopTrack=true);

    boolean PlaySound(unsigned short soundIndex, byte audioType, byte overrideVolume=0xFF);
    boolean FadeSound(unsigned short soundIndex, int fadeGain, int numMilliseconds, boolean stopTrack);
    boolean QueueSound(unsigned short soundIndex, byte audioType, unsigned long timeToPlay, byte overrideVolume=0xFF);
    boolean QueueSoundCardCommand(byte scFunction, byte scRegister, byte scData, unsigned long startTime);
    boolean PlaySoundCardWhenPossible(unsigned short soundEffectNum, unsigned long currentTime, unsigned long requestedPlayTime = 0, unsigned long playUntil = 50, byte priority = 10);
    
    boolean QueuePrioritizedNotification(unsigned short notificationIndex, unsigned short notificationLength, byte priority, unsigned long currentTime);
    
    boolean Update(unsigned long currentTime);

    boolean StopSound(unsigned short soundIndex);
    boolean StopCurrentNotification(byte priority = 10);
    boolean StopAllMusic();
    boolean StopAllNotifications(byte priority = 10);
    boolean StopAllSoundFX();
    boolean StopAllAudio();

  private:
    AudioSoundtrack *curSoundtrack;
    int volumeToGainConversion[11] = {-70, -18, -16, -14, -12, -10, -8, -6, -4, -2, 0};
    int soundFXGain;
    int notificationsGain;
    int musicGain;    
    int ducking;
    byte voiceNotificationStackFirst;
    byte voiceNotificationStackLast;
    byte voiceNotificationPriorityStack[VOICE_NOTIFICATION_STACK_SIZE];
    byte currentNotificationPriority;
    boolean soundtrackRandomOrder;
    unsigned int currentNotificationPlaying;
    unsigned int voiceNotificationNumStack[VOICE_NOTIFICATION_STACK_SIZE];
    unsigned int voiceNotificationDuration[VOICE_NOTIFICATION_STACK_SIZE];
    unsigned int lastSongsPlayed[NUMBER_OF_SONGS_REMEMBERED];
    unsigned long currentNotificationStartTime;
    unsigned long nextSoundtrackPlayTime;    
    unsigned short curSoundtrackEntries;
    unsigned short currentBackgroundTrack;

    SoundEntry soundQueue[SOUND_QUEUE_SIZE];

#if defined(RPU_OS_USE_WTYPE_1_SOUND) || defined(RPU_OS_USE_WTYPE_2_SOUND)
    SoundEffectEntry CurrentSoundPlaying;
    SoundEffectEntry SoundEffectQueue[SOUND_EFFECT_QUEUE_SIZE];
#endif

#ifdef RPU_OS_USE_SB300
    SoundCardCommandEntry soundCardQueue[SOUND_CARD_QUEUE_SIZE];
#endif

#if defined(RPU_OS_USE_WAV_TRIGGER) || defined(RPU_OS_USE_WAV_TRIGGER_1p3)
    wavTrigger wTrig;             // Our WAV Trigger object 
#endif

    int ConvertVolumeSettingToGain(byte volumeSetting);

    void InitSB300Registers();
    void PlaySB300StartupBeep();

    int SpaceLeftOnNotificationStack();
    void ClearSoundQueue();
    void ClearSoundCardQueue();
    void ClearNotificationStack(byte priority = 10);
    void InitSoundEffectQueue();
    void StartNextSoundtrackSong(unsigned long currentTime);
    void ManageBackgroundSong(unsigned long currentTime);
    boolean ServiceNotificationQueue(unsigned long currentTime);
    void PushToNotificationStack(unsigned int notification, unsigned int duration, byte priority);
    byte GetTopNotificationPriority();
    boolean ServiceSoundCardQueue(unsigned long currentTime);
    boolean ServiceSoundQueue(unsigned long currentTime);

    unsigned long nextVoiceNotificationPlayTime;
    unsigned long backgroundSongEndTime;
    
};



#define AUDIO_HANDLER_H
#endif