vs1053_SdFat.h

Go to the documentation of this file.

#ifndef vs1053_h
#define vs1053_h

// include libraries:
#include "vs1053_SdFat_config.h"
#include "SPI.h"

//Not neccessary, but just in case.
#if ARDUINO > 22
#include "Arduino.h"
#else
#include "WProgram.h"
#endif

//Add the SdFat Libraries
#include <SdFat.h>
//#include <SdFatUtil.h>


enum state_m {
  uninitialized,
  initialized,
  deactivated,
  loading,
  ready,
  playback,
  playMIDIbeep,
  paused_playback,
  testing_memory,
  testing_sinewave,
  }; //enum state_m

enum flush_m {

  post,

  pre,

  both,

  none
  }; //enum flush_m

//------------------------------------------------------------------------------
extern SdFat sd;

//------------------------------------------------------------------------------
#define SCI_MODE              0x00

#define SCI_STATUS            0x01

#define SCI_BASS              0x02

#define SCI_CLOCKF            0x03

#define SCI_DECODE_TIME       0x04

#define SCI_AUDATA            0x05

#define SCI_WRAM              0x06

#define SCI_WRAMADDR          0x07

#define SCI_HDAT0             0x08

#define SCI_HDAT1             0x09

#define SCI_AIADDR            0x0A

#define SCI_VOL               0x0B

#define SCI_AICTRL0           0x0C

#define SCI_AICTRL1           0x0D

#define SCI_AICTRL2           0x0E

#define SCI_AICTRL3           0x0F

//------------------------------------------------------------------------------
#define SM_DIFF             0x0001

#define SM_LAYER12          0x0002

#define SM_RESET            0x0004

#define SM_CANCEL           0x0008

#define SM_EARSPEAKER_LO    0x0010

#define SM_TESTS            0x0020

#define SM_STREAM           0x0040

#define SM_EARSPEAKER_HI    0x0080

#define SM_DACT             0x0100

#define SM_SDIORD           0x0200

#define SM_SDISHARE         0x0400

#define SM_SDINEW           0x0800

#define SM_ADPCM            0x1000

#define SM_PAUSE            0x2000  // note: Only availble with patch. This only quickly pauses the VS's internal buffer, when canceling quickly. It won't unpause.

#define SM_LINE1            0x4000

#define SM_CLK_RANGE        0x8000

// configure Line1 as single ended, otherwise as differential 10x gain for microphones.
#define VS_LINE1_MODE



//------------------------------------------------------------------------------
#define SS_VU_ENABLE        0x0200

//------------------------------------------------------------------------------
#define para_chipID_0       0x1E00

#define para_chipID_1       0x1E01

#define para_version        0x1E02

#define para_config1        0x1E03

#define para_playSpeed      0x1E04

#define para_byteRate       0x1E05

#define para_endFillByte    0x1E06

#define para_MonoOutput    0x1E09

#define para_positionMsec_0 0x1E27

#define para_positionMsec_1 0x1E28

#define para_resync         0x1E29

#define TRUE                     1
#define FALSE                    0

//------------------------------------------------------------------------------
#define TRACK_TITLE              3

#define TRACK_ARTIST            33

#define TRACK_ALBUM             63

//------------------------------------------------------------------------------
class vs1053 {
  public:
    uint8_t begin();
    void end();
    uint8_t vs_init();
    void setVolume(uint8_t, uint8_t);
    void setVolume(uint16_t);
    void setVolume(uint8_t);
    uint16_t getTrebleFrequency();
    int8_t  getTrebleAmplitude();
    uint16_t getBassFrequency();
    int8_t getBassAmplitude();
    void setTrebleFrequency(uint16_t);
    void setTrebleAmplitude(int8_t);
    void setBassFrequency(uint16_t);
    void setBassAmplitude(uint8_t);
    void setPlaySpeed(uint16_t);
    uint16_t getPlaySpeed();
    uint16_t getVolume();
    uint8_t getEarSpeaker();
    state_m getState();
    void setEarSpeaker(uint16_t);
    uint16_t getMonoMode();
    void setMonoMode(uint16_t );
    void setDifferentialOutput(uint16_t);
    uint8_t getDifferentialOutput();
    uint8_t playTrack(uint8_t);
    uint8_t playMP3(char*, uint32_t timecode = 0);
    void trackTitle(char*);
    void trackArtist(char*);
    void trackAlbum(char*);
    void stopTrack();
    uint8_t isPlaying();
    uint8_t skip(int32_t);
    uint8_t skipTo(uint32_t);
    uint32_t currentPosition();
    void setBitRate(uint16_t);
    void pauseDataStream();
    void resumeDataStream();
    void pauseMusic();
    bool resumeMusic();
    uint8_t resumeMusic(uint32_t);
    static void available();
    void getAudioInfo();
    uint8_t enableTestSineWave(uint8_t);
    uint8_t disableTestSineWave();
    uint16_t memoryTest();
    uint8_t ADMixerLoad(char*);
    void ADMixerVol(int8_t);
    int8_t getVUmeter();
    int8_t setVUmeter(int8_t);
    int16_t getVUlevel();
    void SendSingleMIDInote();

  private:
    static SdFile track;
    static void refill();
    static void flush_cancel(flush_m);
    static void spiInit();
    static void cs_low();
    static void cs_high();
    static void dcs_low();
    static void dcs_high();
    static void Mp3WriteRegister(uint8_t, uint8_t, uint8_t);
    static void Mp3WriteRegister(uint8_t, uint16_t);
    static uint16_t Mp3ReadRegister (uint8_t);
    static uint16_t Mp3ReadWRAM(uint16_t);
    static void Mp3WriteWRAM(uint16_t, uint16_t);
    void getTrackInfo(uint8_t, char*);
    static void enableRefill();
    static void disableRefill();
    void getBitRateFromMP3File(char*);
    uint8_t VSLoadUserCode(char*);

    //Create the variables to be used by SdFat Library

    static state_m playing_state;

    static uint16_t spi_Read_Rate;
    static uint16_t spi_Write_Rate;

    static uint8_t mp3DataBuffer[32];

    uint8_t bitrate;

    uint32_t start_of_music;

    uint8_t VolL;

    uint8_t VolR;

union sci_bass_m {

    uint16_t word;

    struct {
      uint8_t  Bass_Freqlimt    : 4; // 0..3
      uint8_t  Bass_Amplitude   : 4; // 4..7
      uint8_t  Treble_Freqlimt  : 4; // 8..11
       int8_t  Treble_Amplitude : 4; // 12..15
    }nibble;
  } ;
};

//------------------------------------------------------------------------------
/*
 * Global Functions
 */
char* strip_nonalpha_inplace(char *s);
bool isFnMusic(char*);

//------------------------------------------------------------------------------
/*
 * Global Unions
 */

union twobyte {

  uint16_t word;

  uint8_t  byte[2];
} ;

#endif // vs1053_h