Christian Schmiljun
Library for VLSI VS1053b - Ogg Vorbis / MP3 / AAC / WMA / FLAC / MIDI Audio Codec Chip for a complete sample see Lib_VS1053b
Dependents: Lab3_1 RTOS-VS1053b-mp3_semaphore RTOS-VS1053b-mp3_v01
VS1053.h@9:0d76f559a151, 2011-01-16 (annotated)
- Committer:
- christi_s
- Date:
- Sun Jan 16 16:53:16 2011 +0000
- Revision:
- 9:0d76f559a151
- Parent:
- 8:5e4a21202223
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| christi_s | 1:ced2c297cc1b | 1 | /* mbed VLSI VS1053b library |
| christi_s | 1:ced2c297cc1b | 2 | * Copyright (c) 2010 Christian Schmiljun |
| christi_s | 1:ced2c297cc1b | 3 | * |
| christi_s | 1:ced2c297cc1b | 4 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| christi_s | 1:ced2c297cc1b | 5 | * of this software and associated documentation files (the "Software"), to deal |
| christi_s | 1:ced2c297cc1b | 6 | * in the Software without restriction, including without limitation the rights |
| christi_s | 1:ced2c297cc1b | 7 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| christi_s | 1:ced2c297cc1b | 8 | * copies of the Software, and to permit persons to whom the Software is |
| christi_s | 1:ced2c297cc1b | 9 | * furnished to do so, subject to the following conditions: |
| christi_s | 1:ced2c297cc1b | 10 | * |
| christi_s | 1:ced2c297cc1b | 11 | * The above copyright notice and this permission notice shall be included in |
| christi_s | 1:ced2c297cc1b | 12 | * all copies or substantial portions of the Software. |
| christi_s | 1:ced2c297cc1b | 13 | * |
| christi_s | 1:ced2c297cc1b | 14 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| christi_s | 1:ced2c297cc1b | 15 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| christi_s | 1:ced2c297cc1b | 16 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| christi_s | 1:ced2c297cc1b | 17 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| christi_s | 1:ced2c297cc1b | 18 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| christi_s | 1:ced2c297cc1b | 19 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| christi_s | 1:ced2c297cc1b | 20 | * THE SOFTWARE. |
| christi_s | 1:ced2c297cc1b | 21 | */ |
| christi_s | 1:ced2c297cc1b | 22 | |
| christi_s | 1:ced2c297cc1b | 23 | /* This code based on: |
| christi_s | 1:ced2c297cc1b | 24 | * mbeduino_MP3_Shield_MP3Player |
| christi_s | 1:ced2c297cc1b | 25 | * http://mbed.org/users/xshige/programs/mbeduino_MP3_Shield_MP3Player/lgcx63 |
| christi_s | 1:ced2c297cc1b | 26 | * 2010-10-16 |
| christi_s | 1:ced2c297cc1b | 27 | */ |
| christi_s | 1:ced2c297cc1b | 28 | |
| christi_s | 2:5bab956cb59e | 29 | #ifndef _VS1053_H |
| christi_s | 2:5bab956cb59e | 30 | #define _VS1053_H |
| christi_s | 1:ced2c297cc1b | 31 | |
| christi_s | 0:7728d9c6c487 | 32 | // ---------------------------------------------------------------------------- |
| christi_s | 0:7728d9c6c487 | 33 | // Extended settings |
| christi_s | 0:7728d9c6c487 | 34 | // ---------------------------------------------------------------------------- |
| christi_s | 1:ced2c297cc1b | 35 | // Enable debug output (Output -> printf ...) |
| christi_s | 1:ced2c297cc1b | 36 | // -------------------------------------------------------------------------- |
| christi_s | 2:5bab956cb59e | 37 | // #define DEBUG |
| christi_s | 2:5bab956cb59e | 38 | // #define DEBUGOUT (x,y...) printf(x, ##y); |
| christi_s | 0:7728d9c6c487 | 39 | // Patches, Addons |
| christi_s | 0:7728d9c6c487 | 40 | // -------------------------------------------------------------------------- |
| christi_s | 2:5bab956cb59e | 41 | // #define VS1053_PATCH_1_4_FLAC |
| christi_s | 2:5bab956cb59e | 42 | // #define VS1053_PATCH_1_5 |
| christi_s | 2:5bab956cb59e | 43 | // #define VS1053_PATCH_1_5_FLAC |
| christi_s | 2:5bab956cb59e | 44 | // #define VS1053_SPECANA |
| christi_s | 2:5bab956cb59e | 45 | // #define VS1053B_PCM_RECORDER_0_9 |
| christi_s | 0:7728d9c6c487 | 46 | // ---------------------------------------------------------------------------- |
| christi_s | 0:7728d9c6c487 | 47 | |
| christi_s | 2:5bab956cb59e | 48 | #include "defines.h" |
| christi_s | 2:5bab956cb59e | 49 | #include "mbed.h" |
| christi_s | 2:5bab956cb59e | 50 | |
| christi_s | 1:ced2c297cc1b | 51 | #if defined(VS1053_PATCH_1_4_FLAC) && defined(VS1053_PATCH_1_5) && defined(VS1053_PATCH_1_5_FLAC) && defined(VS1053_SPECANA) && defined(VS1053B_PCM_RECORDER_0_9) |
| christi_s | 1:ced2c297cc1b | 52 | #error "VS1053: Exclusive use of patch and app versions." |
| christi_s | 1:ced2c297cc1b | 53 | #endif |
| christi_s | 1:ced2c297cc1b | 54 | #if defined(VS1053_PATCH_1_4_FLAC) || defined(VS1053_PATCH_1_5) || defined(VS1053_PATCH_1_5_FLAC) || defined(VS1053_SPECANA) || defined(VS1053B_PCM_RECORDER_0_9) |
| christi_s | 1:ced2c297cc1b | 55 | #define VS_PATCH |
| christi_s | 0:7728d9c6c487 | 56 | #endif |
| christi_s | 0:7728d9c6c487 | 57 | |
| christi_s | 2:5bab956cb59e | 58 | #ifndef DEBUGOUT |
| christi_s | 2:5bab956cb59e | 59 | #define DEBUGOUT(x,y...) |
| christi_s | 2:5bab956cb59e | 60 | #endif |
| christi_s | 2:5bab956cb59e | 61 | |
| christi_s | 0:7728d9c6c487 | 62 | |
| christi_s | 2:5bab956cb59e | 63 | #define DEFAULT_BALANCE_DIFERENCE_LEFT_RIGHT 0.0f |
| christi_s | 2:5bab956cb59e | 64 | #define DEFAULT_VOLUME -40.0f |
| christi_s | 2:5bab956cb59e | 65 | #define DEFAULT_BASS_AMPLITUDE 5 // 0 - 15 dB |
| christi_s | 2:5bab956cb59e | 66 | #define DEFAULT_BASS_FREQUENCY 100 // 20 - 150 Hz |
| christi_s | 2:5bab956cb59e | 67 | #define DEFAULT_TREBLE_AMPLITUDE 0 // -8 - 7 dB |
| christi_s | 2:5bab956cb59e | 68 | #define DEFAULT_TREBLE_FREQUENCY 15000 //1000 - 15000 Hz |
| christi_s | 0:7728d9c6c487 | 69 | |
| christi_s | 8:5e4a21202223 | 70 | |
| christi_s | 4:cacb5e663fa9 | 71 | |
| christi_s | 0:7728d9c6c487 | 72 | // SCI register address assignment |
| christi_s | 3:88a645490529 | 73 | #define SCI_MODE 0x00 |
| christi_s | 3:88a645490529 | 74 | #define SCI_STATUS 0x01 |
| christi_s | 3:88a645490529 | 75 | #define SCI_BASS 0x02 |
| christi_s | 3:88a645490529 | 76 | #define SCI_CLOCKF 0x03 |
| christi_s | 6:eed008905159 | 77 | #define SCI_DECODE_TIME 0x04 |
| christi_s | 3:88a645490529 | 78 | #define SCI_AUDATA 0x05 |
| christi_s | 3:88a645490529 | 79 | #define SCI_WRAM 0x06 |
| christi_s | 3:88a645490529 | 80 | #define SCI_WRAMADDR 0x07 |
| christi_s | 3:88a645490529 | 81 | #define SCI_HDAT0 0x08 |
| christi_s | 3:88a645490529 | 82 | #define SCI_HDAT1 0x09 |
| christi_s | 3:88a645490529 | 83 | #define SCI_AIADDR 0x0A |
| christi_s | 3:88a645490529 | 84 | #define SCI_VOL 0x0B |
| christi_s | 3:88a645490529 | 85 | #define SCI_AICTRL0 0x0C |
| christi_s | 3:88a645490529 | 86 | #define SCI_AICTRL1 0x0D |
| christi_s | 3:88a645490529 | 87 | #define SCI_AICTRL2 0x0E |
| christi_s | 3:88a645490529 | 88 | #define SCI_AICTRL3 0x0F |
| christi_s | 0:7728d9c6c487 | 89 | |
| christi_s | 0:7728d9c6c487 | 90 | |
| christi_s | 0:7728d9c6c487 | 91 | //SCI_MODE register bits as of p.38 of the datasheet |
| christi_s | 3:88a645490529 | 92 | #define SM_DIFF 0x0001 |
| christi_s | 3:88a645490529 | 93 | #define SM_LAYER12 0x0002 |
| christi_s | 3:88a645490529 | 94 | #define SM_RESET 0x0004 |
| christi_s | 3:88a645490529 | 95 | #define SM_CANCEL 0x0008 |
| christi_s | 3:88a645490529 | 96 | #define SM_EARSPEAKER_LO 0x0010 |
| christi_s | 3:88a645490529 | 97 | #define SM_TESTS 0x0020 |
| christi_s | 3:88a645490529 | 98 | #define SM_STREAM 0x0040 |
| christi_s | 3:88a645490529 | 99 | #define SM_EARSPEAKER_HI 0x0080 |
| christi_s | 3:88a645490529 | 100 | #define SM_DACT 0x0100 |
| christi_s | 3:88a645490529 | 101 | #define SM_SDIORD 0x0200 |
| christi_s | 3:88a645490529 | 102 | #define SM_SDISHARE 0x0400 |
| christi_s | 3:88a645490529 | 103 | #define SM_SDINEW 0x0800 |
| christi_s | 3:88a645490529 | 104 | #define SM_ADPCM 0x1000 |
| christi_s | 3:88a645490529 | 105 | #define SM_B13 0x2000 |
| christi_s | 3:88a645490529 | 106 | #define SM_LINE1 0x4000 |
| christi_s | 3:88a645490529 | 107 | #define SM_CLK_RANGE 0x8000 |
| christi_s | 0:7728d9c6c487 | 108 | |
| christi_s | 0:7728d9c6c487 | 109 | //SCI_CLOCKF register bits as of p.42 of the datasheet |
| christi_s | 3:88a645490529 | 110 | #define SC_ADD_NOMOD 0x0000 |
| christi_s | 3:88a645490529 | 111 | #define SC_ADD_10x 0x0800 |
| christi_s | 3:88a645490529 | 112 | #define SC_ADD_15x 0x1000 |
| christi_s | 3:88a645490529 | 113 | #define SC_ADD_20x 0x1800 |
| christi_s | 3:88a645490529 | 114 | #define SC_MULT_XTALI 0x0000 |
| christi_s | 3:88a645490529 | 115 | #define SC_MULT_XTALIx20 0x2000 |
| christi_s | 3:88a645490529 | 116 | #define SC_MULT_XTALIx25 0x4000 |
| christi_s | 3:88a645490529 | 117 | #define SC_MULT_XTALIx30 0x6000 |
| christi_s | 3:88a645490529 | 118 | #define SC_MULT_XTALIx35 0x8000 |
| christi_s | 3:88a645490529 | 119 | #define SC_MULT_XTALIx40 0xA000 |
| christi_s | 3:88a645490529 | 120 | #define SC_MULT_XTALIx45 0xC000 |
| christi_s | 3:88a645490529 | 121 | #define SC_MULT_XTALIx50 0xE000 |
| christi_s | 0:7728d9c6c487 | 122 | |
| christi_s | 0:7728d9c6c487 | 123 | // Extra Parameter in X memory (refer to p.58 of the datasheet) |
| christi_s | 3:88a645490529 | 124 | #define para_chipID_0 0x1E00 |
| christi_s | 3:88a645490529 | 125 | #define para_chipID_1 0x1E01 |
| christi_s | 3:88a645490529 | 126 | #define para_version 0x1E02 |
| christi_s | 3:88a645490529 | 127 | #define para_config1 0x1E03 |
| christi_s | 3:88a645490529 | 128 | #define para_playSpeed 0x1E04 |
| christi_s | 3:88a645490529 | 129 | #define para_byteRate 0x1E05 |
| christi_s | 3:88a645490529 | 130 | #define para_endFillByte 0x1E06 |
| christi_s | 0:7728d9c6c487 | 131 | // |
| christi_s | 3:88a645490529 | 132 | #define para_positionMsec_0 0x1E27 |
| christi_s | 3:88a645490529 | 133 | #define para_positionMsec_1 0x1E28 |
| christi_s | 3:88a645490529 | 134 | #define para_resync 0x1E29 |
| christi_s | 4:cacb5e663fa9 | 135 | |
| christi_s | 4:cacb5e663fa9 | 136 | #define INTERRUPT_HANDLER_ENABLE _DREQ_INTERUPT_IN.rise(this, &VS1053::dataRequestHandler); timer.attach_us(this, &VS1053::dataRequestHandler, 1000) |
| christi_s | 4:cacb5e663fa9 | 137 | #define INTERRUPT_HANDLER_DISABLE _DREQ_INTERUPT_IN.rise(NULL); timer.detach() |
| christi_s | 0:7728d9c6c487 | 138 | |
| christi_s | 6:eed008905159 | 139 | |
| christi_s | 7:b6853a2c88c2 | 140 | /** Types of audio streams |
| christi_s | 7:b6853a2c88c2 | 141 | * |
| christi_s | 7:b6853a2c88c2 | 142 | */ |
| christi_s | 9:0d76f559a151 | 143 | enum AudioType |
| christi_s | 6:eed008905159 | 144 | { |
| christi_s | 7:b6853a2c88c2 | 145 | WAV, /*!< WAVE audio stream */ |
| christi_s | 7:b6853a2c88c2 | 146 | AAC, /*!< AAC audio stream (ADTS (.aac), MPEG2 ADIF (.aac) and MPEG4 AUDIO (.mp4 / .m4a / .3gp / .3g2)) */ |
| christi_s | 7:b6853a2c88c2 | 147 | WMA, /*!< Windows Media Audio (WMA) stream */ |
| christi_s | 7:b6853a2c88c2 | 148 | MIDI, /*!< Midi audio stream */ |
| christi_s | 7:b6853a2c88c2 | 149 | OGG_VORBIS, /*!< Ogg Vorbis audio stream */ |
| christi_s | 7:b6853a2c88c2 | 150 | MP3, /*!< MPEG Audio Layer */ |
| christi_s | 7:b6853a2c88c2 | 151 | UNKNOWN /*!< Unknown */ |
| christi_s | 9:0d76f559a151 | 152 | }; |
| christi_s | 9:0d76f559a151 | 153 | |
| christi_s | 9:0d76f559a151 | 154 | typedef enum AudioType AudioType; |
| christi_s | 6:eed008905159 | 155 | |
| christi_s | 7:b6853a2c88c2 | 156 | /** Types of MPEG Audio Layer stream IDs. |
| christi_s | 7:b6853a2c88c2 | 157 | * |
| christi_s | 7:b6853a2c88c2 | 158 | */ |
| christi_s | 9:0d76f559a151 | 159 | enum MP3_ID |
| christi_s | 6:eed008905159 | 160 | { |
| christi_s | 7:b6853a2c88c2 | 161 | MPG2_5a = 0, /*!< MPG 2.5, nonstandard, proprietary */ |
| christi_s | 7:b6853a2c88c2 | 162 | MPG2_5b = 1, /*!< MPG 2.5, nonstandard, proprietary */ |
| christi_s | 7:b6853a2c88c2 | 163 | MPG2_0 = 2, /*!< ISO 13818-3 MPG 2.0 */ |
| christi_s | 7:b6853a2c88c2 | 164 | MPG1_0 = 3 /*!< ISO 11172-3 MPG 1.0 */ |
| christi_s | 9:0d76f559a151 | 165 | }; |
| christi_s | 9:0d76f559a151 | 166 | |
| christi_s | 9:0d76f559a151 | 167 | typedef enum MP3_ID MP3_ID; |
| christi_s | 6:eed008905159 | 168 | |
| christi_s | 7:b6853a2c88c2 | 169 | /** Types of MPEG Audio Layer channel modes. |
| christi_s | 7:b6853a2c88c2 | 170 | * |
| christi_s | 7:b6853a2c88c2 | 171 | */ |
| christi_s | 9:0d76f559a151 | 172 | enum MP3_MODE |
| christi_s | 6:eed008905159 | 173 | { |
| christi_s | 7:b6853a2c88c2 | 174 | STEREO = 0, /*!< Stereo */ |
| christi_s | 7:b6853a2c88c2 | 175 | JOINT_STEREO = 1, /*!< Joint Stereo */ |
| christi_s | 7:b6853a2c88c2 | 176 | DUAL_CHANNEL = 2, /*!< Dual Channel */ |
| christi_s | 7:b6853a2c88c2 | 177 | MONO = 3 /*!< Mono */ |
| christi_s | 9:0d76f559a151 | 178 | }; |
| christi_s | 6:eed008905159 | 179 | |
| christi_s | 9:0d76f559a151 | 180 | typedef enum MP3_MODE MP3_MODE; |
| christi_s | 6:eed008905159 | 181 | /** Struct for informations about audio streams. |
| christi_s | 6:eed008905159 | 182 | * |
| christi_s | 6:eed008905159 | 183 | */ |
| christi_s | 6:eed008905159 | 184 | typedef struct AudioInfo |
| christi_s | 6:eed008905159 | 185 | { |
| christi_s | 7:b6853a2c88c2 | 186 | AudioType type : 4; /*!< Type of the audio stream - important for the interpretation of the lower union */ |
| christi_s | 7:b6853a2c88c2 | 187 | unsigned short kBitRate; /*!< Average bitrate of the audio stream - in kBit/s */ |
| christi_s | 7:b6853a2c88c2 | 188 | unsigned short decodeTime; /*!< Decode time */ |
| christi_s | 6:eed008905159 | 189 | union { |
| christi_s | 6:eed008905159 | 190 | struct { |
| christi_s | 7:b6853a2c88c2 | 191 | MP3_ID id : 2; /*!< ID */ |
| christi_s | 7:b6853a2c88c2 | 192 | char layer : 2; /*!< Layer */ |
| christi_s | 7:b6853a2c88c2 | 193 | char protrectBit : 1; /*!< Protect bit, see p.44 of the datasheet */ |
| christi_s | 7:b6853a2c88c2 | 194 | char padBit : 1; /*!< Pad bit, see p.44 of the datasheet */ |
| christi_s | 7:b6853a2c88c2 | 195 | MP3_MODE mode : 2; /*!< Channel mode */ |
| christi_s | 7:b6853a2c88c2 | 196 | char extension : 2; /*!< Extension, see p.44 of the datasheet */ |
| christi_s | 7:b6853a2c88c2 | 197 | char copyright : 1; /*!< Copyright, see p.44 of the datasheet */ |
| christi_s | 7:b6853a2c88c2 | 198 | char original : 1; /*!< Original, see p.44 of the datasheet */ |
| christi_s | 7:b6853a2c88c2 | 199 | char emphasis : 2; /*!< Emphasis, see p.44 of the datasheet */ |
| christi_s | 7:b6853a2c88c2 | 200 | char kSampleRate : 6; /*!< Samplerate - in kHz (rounded) */ |
| christi_s | 7:b6853a2c88c2 | 201 | } mp3; /*!< MPEG Audio Layer */ |
| christi_s | 6:eed008905159 | 202 | struct { |
| christi_s | 6:eed008905159 | 203 | |
| christi_s | 7:b6853a2c88c2 | 204 | } wma; /*!< Windows Media Audio (WMA) stream */ |
| christi_s | 6:eed008905159 | 205 | struct { |
| christi_s | 6:eed008905159 | 206 | |
| christi_s | 7:b6853a2c88c2 | 207 | } aac; /*!< AAC audio stream */ |
| christi_s | 6:eed008905159 | 208 | struct { |
| christi_s | 6:eed008905159 | 209 | |
| christi_s | 7:b6853a2c88c2 | 210 | } other; /*!< Other */ |
| christi_s | 6:eed008905159 | 211 | } ext; |
| christi_s | 6:eed008905159 | 212 | |
| christi_s | 6:eed008905159 | 213 | } AudioInfo; |
| christi_s | 6:eed008905159 | 214 | |
| christi_s | 2:5bab956cb59e | 215 | /** Class for VS1053 - Ogg Vorbis / MP3 / AAC / WMA / FLAC / MIDI Audio Codec Chip. |
| christi_s | 7:b6853a2c88c2 | 216 | * Datasheet, see http://www.vlsi.fi/fileadmin/datasheets/vlsi/vs1053.pdf |
| christi_s | 2:5bab956cb59e | 217 | * |
| christi_s | 2:5bab956cb59e | 218 | * This code based on: |
| christi_s | 2:5bab956cb59e | 219 | * mbeduino_MP3_Shield_MP3Player |
| christi_s | 2:5bab956cb59e | 220 | * http://mbed.org/users/xshige/programs/mbeduino_MP3_Shield_MP3Player/lgcx63 |
| christi_s | 2:5bab956cb59e | 221 | * 2010-10-16 |
| christi_s | 2:5bab956cb59e | 222 | * |
| christi_s | 2:5bab956cb59e | 223 | * For the use of this class, a file "defines.h" must be created. |
| christi_s | 2:5bab956cb59e | 224 | * It controls debug output and vs1053 patches. |
| christi_s | 1:ced2c297cc1b | 225 | * |
| christi_s | 2:5bab956cb59e | 226 | * defines.h: |
| christi_s | 2:5bab956cb59e | 227 | *@code |
| christi_s | 2:5bab956cb59e | 228 | * #ifndef _DEFINES_H |
| christi_s | 2:5bab956cb59e | 229 | * #define _DEFINES_H |
| christi_s | 2:5bab956cb59e | 230 | * // ---------------------------------------------------------------------------- |
| christi_s | 2:5bab956cb59e | 231 | * // debug output |
| christi_s | 2:5bab956cb59e | 232 | * // ---------------------------------------------------------------------------- |
| christi_s | 2:5bab956cb59e | 233 | * // optional |
| christi_s | 2:5bab956cb59e | 234 | * #define DEBUG |
| christi_s | 2:5bab956cb59e | 235 | * #ifdef DEBUG |
| christi_s | 2:5bab956cb59e | 236 | * # define DEBUGOUT(x,y...) printf(x, ##y); |
| christi_s | 2:5bab956cb59e | 237 | * #else |
| christi_s | 2:5bab956cb59e | 238 | * # define DEBUGOUT(x,y...) |
| christi_s | 2:5bab956cb59e | 239 | * #endif |
| christi_s | 2:5bab956cb59e | 240 | * // ---------------------------------------------------------------------------- |
| christi_s | 2:5bab956cb59e | 241 | * // VLSI VS1053b library, patch, apps |
| christi_s | 2:5bab956cb59e | 242 | * // ---------------------------------------------------------------------------- |
| christi_s | 2:5bab956cb59e | 243 | * // optional, ONLY ONE |
| christi_s | 2:5bab956cb59e | 244 | * //#define VS1053_PATCH_1_4_FLAC |
| christi_s | 2:5bab956cb59e | 245 | * //#define VS1053_PATCH_1_5 |
| christi_s | 2:5bab956cb59e | 246 | * #define VS1053_PATCH_1_5_FLAC |
| christi_s | 2:5bab956cb59e | 247 | * //#define VS1053_SPECANA |
| christi_s | 2:5bab956cb59e | 248 | * //#define VS1053B_PCM_RECORDER_0_9 |
| christi_s | 2:5bab956cb59e | 249 | * |
| christi_s | 7:b6853a2c88c2 | 250 | * #endif //_DEFINES_H |
| christi_s | 7:b6853a2c88c2 | 251 | *@endcode |
| christi_s | 1:ced2c297cc1b | 252 | * |
| christi_s | 7:b6853a2c88c2 | 253 | * For a complete sample, see http://mbed.org/users/christi_s/programs/Lib_VS1053b |
| christi_s | 7:b6853a2c88c2 | 254 | * |
| christi_s | 1:ced2c297cc1b | 255 | */ |
| christi_s | 0:7728d9c6c487 | 256 | class VS1053 { |
| christi_s | 0:7728d9c6c487 | 257 | |
| christi_s | 0:7728d9c6c487 | 258 | public: |
| christi_s | 1:ced2c297cc1b | 259 | /** Create a vs1053b object. |
| christi_s | 1:ced2c297cc1b | 260 | * |
| christi_s | 2:5bab956cb59e | 261 | * @param mosi |
| christi_s | 2:5bab956cb59e | 262 | * SPI Master Out, Slave In pin to vs1053b. |
| christi_s | 2:5bab956cb59e | 263 | * @param miso |
| christi_s | 2:5bab956cb59e | 264 | * SPI Master In, Slave Out pin to vs1053b. |
| christi_s | 2:5bab956cb59e | 265 | * @param sck |
| christi_s | 2:5bab956cb59e | 266 | * SPI Clock pin to vs1053b. |
| christi_s | 2:5bab956cb59e | 267 | * @param cs |
| christi_s | 2:5bab956cb59e | 268 | * Pin to vs1053b control chip select. |
| christi_s | 2:5bab956cb59e | 269 | * @param rst |
| christi_s | 2:5bab956cb59e | 270 | * Pin to vs1053b reset. |
| christi_s | 2:5bab956cb59e | 271 | * @param dreq |
| christi_s | 2:5bab956cb59e | 272 | * Pin to vs1053b data request. |
| christi_s | 2:5bab956cb59e | 273 | * @param dcs |
| christi_s | 2:5bab956cb59e | 274 | * Pin to vs1053b data chip select. |
| christi_s | 8:5e4a21202223 | 275 | * @param buffer |
| christi_s | 8:5e4a21202223 | 276 | * Array to cache audio data. |
| christi_s | 8:5e4a21202223 | 277 | * @param buffer_size |
| christi_s | 8:5e4a21202223 | 278 | * Length of the array. |
| christi_s | 1:ced2c297cc1b | 279 | */ |
| christi_s | 0:7728d9c6c487 | 280 | VS1053( |
| christi_s | 1:ced2c297cc1b | 281 | PinName mosi, |
| christi_s | 1:ced2c297cc1b | 282 | PinName miso, |
| christi_s | 1:ced2c297cc1b | 283 | PinName sck, |
| christi_s | 1:ced2c297cc1b | 284 | PinName cs, |
| christi_s | 1:ced2c297cc1b | 285 | PinName rst, |
| christi_s | 1:ced2c297cc1b | 286 | PinName dreq, |
| christi_s | 8:5e4a21202223 | 287 | PinName dcs, |
| christi_s | 8:5e4a21202223 | 288 | char* buffer, |
| christi_s | 8:5e4a21202223 | 289 | int buffer_size |
| christi_s | 8:5e4a21202223 | 290 | ); |
| christi_s | 0:7728d9c6c487 | 291 | |
| christi_s | 1:ced2c297cc1b | 292 | /** Reset the vs1053b. (hardware reset) |
| christi_s | 1:ced2c297cc1b | 293 | * |
| christi_s | 1:ced2c297cc1b | 294 | */ |
| christi_s | 2:5bab956cb59e | 295 | void reset(void); |
| christi_s | 5:ead95c0f7800 | 296 | |
| christi_s | 5:ead95c0f7800 | 297 | /** Stop the playback if the song is completed. |
| christi_s | 5:ead95c0f7800 | 298 | * You must call this function for default playback. |
| christi_s | 5:ead95c0f7800 | 299 | * |
| christi_s | 5:ead95c0f7800 | 300 | */ |
| christi_s | 1:ced2c297cc1b | 301 | void terminateStream(void); |
| christi_s | 1:ced2c297cc1b | 302 | |
| christi_s | 2:5bab956cb59e | 303 | /** Initialize the vs1053b device. |
| christi_s | 1:ced2c297cc1b | 304 | * |
| christi_s | 2:5bab956cb59e | 305 | * @return |
| christi_s | 2:5bab956cb59e | 306 | * TRUE on success, FALSE on failure. |
| christi_s | 1:ced2c297cc1b | 307 | */ |
| christi_s | 2:5bab956cb59e | 308 | bool initialize(void); |
| christi_s | 1:ced2c297cc1b | 309 | |
| christi_s | 2:5bab956cb59e | 310 | /** Set the volume. |
| christi_s | 2:5bab956cb59e | 311 | * |
| christi_s | 2:5bab956cb59e | 312 | * @param volume |
| christi_s | 2:5bab956cb59e | 313 | * Volume -0.5dB, -1.0dB, .. -64.0dB. |
| christi_s | 2:5bab956cb59e | 314 | */ |
| christi_s | 2:5bab956cb59e | 315 | void setVolume(float volume = DEFAULT_VOLUME); |
| christi_s | 2:5bab956cb59e | 316 | |
| christi_s | 2:5bab956cb59e | 317 | /** Get the volume. |
| christi_s | 2:5bab956cb59e | 318 | * |
| christi_s | 2:5bab956cb59e | 319 | * @return |
| christi_s | 2:5bab956cb59e | 320 | * Return the volume in dB. |
| christi_s | 2:5bab956cb59e | 321 | */ |
| christi_s | 1:ced2c297cc1b | 322 | float getVolume(); |
| christi_s | 1:ced2c297cc1b | 323 | |
| christi_s | 2:5bab956cb59e | 324 | /** Set the balance - volume difference between left-right. |
| christi_s | 2:5bab956cb59e | 325 | * |
| christi_s | 2:5bab956cb59e | 326 | * @param balance |
| christi_s | 2:5bab956cb59e | 327 | * Difference in dB. |
| christi_s | 2:5bab956cb59e | 328 | */ |
| christi_s | 2:5bab956cb59e | 329 | void setBalance(float balance = DEFAULT_BALANCE_DIFERENCE_LEFT_RIGHT); |
| christi_s | 2:5bab956cb59e | 330 | |
| christi_s | 2:5bab956cb59e | 331 | /** Get the balance - volume difference between left-right. |
| christi_s | 2:5bab956cb59e | 332 | * |
| christi_s | 2:5bab956cb59e | 333 | * @return |
| christi_s | 2:5bab956cb59e | 334 | * Difference in dB. |
| christi_s | 2:5bab956cb59e | 335 | */ |
| christi_s | 1:ced2c297cc1b | 336 | float getBalance(); |
| christi_s | 2:5bab956cb59e | 337 | |
| christi_s | 2:5bab956cb59e | 338 | /** Get the treble frequency limit. |
| christi_s | 2:5bab956cb59e | 339 | * |
| christi_s | 2:5bab956cb59e | 340 | * @return |
| christi_s | 2:5bab956cb59e | 341 | * Frequenzy 1000, 2000 .. 15000Hz. |
| christi_s | 2:5bab956cb59e | 342 | */ |
| christi_s | 2:5bab956cb59e | 343 | int getTrebleFrequency(void); |
| christi_s | 2:5bab956cb59e | 344 | /** Set the treble frequency limit. |
| christi_s | 2:5bab956cb59e | 345 | * |
| christi_s | 2:5bab956cb59e | 346 | * @param frequency |
| christi_s | 2:5bab956cb59e | 347 | * Frequenzy 1000, 2000, .. 15000Hz. |
| christi_s | 2:5bab956cb59e | 348 | */ |
| christi_s | 2:5bab956cb59e | 349 | void setTrebleFrequency(int frequency = DEFAULT_TREBLE_FREQUENCY); |
| christi_s | 1:ced2c297cc1b | 350 | |
| christi_s | 2:5bab956cb59e | 351 | /** Get the treble amplitude. |
| christi_s | 2:5bab956cb59e | 352 | * |
| christi_s | 2:5bab956cb59e | 353 | * @return |
| christi_s | 2:5bab956cb59e | 354 | * Amplitude -8 .. 7dB (in 1.5dB steps); 0 = off. |
| christi_s | 2:5bab956cb59e | 355 | */ |
| christi_s | 2:5bab956cb59e | 356 | int getTrebleAmplitude(void); |
| christi_s | 2:5bab956cb59e | 357 | /** Set the treble amplitude. |
| christi_s | 2:5bab956cb59e | 358 | * |
| christi_s | 2:5bab956cb59e | 359 | * @param amplitude |
| christi_s | 2:5bab956cb59e | 360 | * Amplitude -8 .. 7dB (in 1.5dB steps); 0 = off. |
| christi_s | 2:5bab956cb59e | 361 | */ |
| christi_s | 2:5bab956cb59e | 362 | void setTrebleAmplitude(int amplitude = DEFAULT_TREBLE_AMPLITUDE); |
| christi_s | 1:ced2c297cc1b | 363 | |
| christi_s | 2:5bab956cb59e | 364 | /** Get the bass frequency limit. |
| christi_s | 2:5bab956cb59e | 365 | * |
| christi_s | 2:5bab956cb59e | 366 | * @return |
| christi_s | 2:5bab956cb59e | 367 | * Frequenzy 20, 30, .. 150Hz. |
| christi_s | 2:5bab956cb59e | 368 | */ |
| christi_s | 2:5bab956cb59e | 369 | int getBassFrequency(void); |
| christi_s | 2:5bab956cb59e | 370 | /** Set the bass frequency limit. |
| christi_s | 2:5bab956cb59e | 371 | * |
| christi_s | 2:5bab956cb59e | 372 | * @param frequency |
| christi_s | 2:5bab956cb59e | 373 | * Frequenzy 20, 30, .. 150Hz. |
| christi_s | 2:5bab956cb59e | 374 | */ |
| christi_s | 2:5bab956cb59e | 375 | void setBassFrequency(int frequency= DEFAULT_BASS_FREQUENCY); |
| christi_s | 2:5bab956cb59e | 376 | |
| christi_s | 2:5bab956cb59e | 377 | /** Get the bass amplitude. |
| christi_s | 2:5bab956cb59e | 378 | * |
| christi_s | 2:5bab956cb59e | 379 | * @return |
| christi_s | 2:5bab956cb59e | 380 | * Amplitude 0 .. 15dB (in 1dB steps); 0 = off. |
| christi_s | 2:5bab956cb59e | 381 | */ |
| christi_s | 2:5bab956cb59e | 382 | int getBassAmplitude(void); |
| christi_s | 2:5bab956cb59e | 383 | /** Set the bass amplitude. |
| christi_s | 2:5bab956cb59e | 384 | * |
| christi_s | 2:5bab956cb59e | 385 | * @param amplitude |
| christi_s | 2:5bab956cb59e | 386 | * Amplitude 0 .. 15dB (in 1dB steps); 0 = off. |
| christi_s | 2:5bab956cb59e | 387 | */ |
| christi_s | 2:5bab956cb59e | 388 | void setBassAmplitude(int amplitude = DEFAULT_BASS_AMPLITUDE); |
| christi_s | 2:5bab956cb59e | 389 | |
| christi_s | 2:5bab956cb59e | 390 | /** Set the speed of a playback. |
| christi_s | 2:5bab956cb59e | 391 | * |
| christi_s | 2:5bab956cb59e | 392 | * @param speed |
| christi_s | 5:ead95c0f7800 | 393 | * Speed 0, 1, .. (0, 1 normal speed). |
| christi_s | 5:ead95c0f7800 | 394 | * Speeds greater 2 are not recommended, buffer must be filled quickly enough. |
| christi_s | 2:5bab956cb59e | 395 | */ |
| christi_s | 4:cacb5e663fa9 | 396 | void setPlaySpeed(unsigned short speed); |
| christi_s | 4:cacb5e663fa9 | 397 | |
| christi_s | 5:ead95c0f7800 | 398 | /** Copy a byte into the audio data buffer. |
| christi_s | 5:ead95c0f7800 | 399 | * |
| christi_s | 5:ead95c0f7800 | 400 | * @param c |
| christi_s | 5:ead95c0f7800 | 401 | * Data for the buffer. |
| christi_s | 5:ead95c0f7800 | 402 | * |
| christi_s | 5:ead95c0f7800 | 403 | * @return |
| christi_s | 5:ead95c0f7800 | 404 | * TRUE on success; FALSE on failure, c isn't copied in the buffer. |
| christi_s | 5:ead95c0f7800 | 405 | */ |
| christi_s | 8:5e4a21202223 | 406 | bool bufferSetByte(char c); |
| christi_s | 5:ead95c0f7800 | 407 | |
| christi_s | 5:ead95c0f7800 | 408 | /** Copy a array of bytes into the audio data buffer. |
| christi_s | 5:ead95c0f7800 | 409 | * |
| christi_s | 5:ead95c0f7800 | 410 | * @param s |
| christi_s | 5:ead95c0f7800 | 411 | * Data for the buffer. |
| christi_s | 5:ead95c0f7800 | 412 | * |
| christi_s | 5:ead95c0f7800 | 413 | * @param length |
| christi_s | 5:ead95c0f7800 | 414 | * Size of data array. |
| christi_s | 5:ead95c0f7800 | 415 | * |
| christi_s | 5:ead95c0f7800 | 416 | * @return |
| christi_s | 5:ead95c0f7800 | 417 | * TRUE on success; FALSE on failure, s isn't copied in the buffer. |
| christi_s | 5:ead95c0f7800 | 418 | */ |
| christi_s | 8:5e4a21202223 | 419 | bool bufferPutStream(const char *s, unsigned int length); |
| christi_s | 5:ead95c0f7800 | 420 | |
| christi_s | 5:ead95c0f7800 | 421 | /** Get the free space of the audio data buffer. |
| christi_s | 5:ead95c0f7800 | 422 | * |
| christi_s | 5:ead95c0f7800 | 423 | * @return |
| christi_s | 5:ead95c0f7800 | 424 | * Space 0 .. BUFFER_SIZE - 1. |
| christi_s | 5:ead95c0f7800 | 425 | */ |
| christi_s | 4:cacb5e663fa9 | 426 | unsigned int bufferFree(void); |
| christi_s | 5:ead95c0f7800 | 427 | |
| christi_s | 5:ead95c0f7800 | 428 | /** Get the busy space of the audio data buffer. |
| christi_s | 5:ead95c0f7800 | 429 | * |
| christi_s | 5:ead95c0f7800 | 430 | * @return |
| christi_s | 5:ead95c0f7800 | 431 | * Space 0 .. BUFFER_SIZE - 1. |
| christi_s | 5:ead95c0f7800 | 432 | */ |
| christi_s | 8:5e4a21202223 | 433 | unsigned int bufferCount(void); |
| christi_s | 8:5e4a21202223 | 434 | |
| christi_s | 8:5e4a21202223 | 435 | /** Complete length of the audio buffer. |
| christi_s | 8:5e4a21202223 | 436 | * |
| christi_s | 8:5e4a21202223 | 437 | * @return |
| christi_s | 8:5e4a21202223 | 438 | * Buffer length. |
| christi_s | 8:5e4a21202223 | 439 | */ |
| christi_s | 8:5e4a21202223 | 440 | unsigned int bufferLength(void); |
| christi_s | 4:cacb5e663fa9 | 441 | |
| christi_s | 5:ead95c0f7800 | 442 | /** Start playing audio from buffer. |
| christi_s | 5:ead95c0f7800 | 443 | * |
| christi_s | 5:ead95c0f7800 | 444 | */ |
| christi_s | 4:cacb5e663fa9 | 445 | void play(void); |
| christi_s | 5:ead95c0f7800 | 446 | |
| christi_s | 5:ead95c0f7800 | 447 | /** Interrupt the playback. |
| christi_s | 5:ead95c0f7800 | 448 | * |
| christi_s | 5:ead95c0f7800 | 449 | */ |
| christi_s | 4:cacb5e663fa9 | 450 | void pause(void); |
| christi_s | 5:ead95c0f7800 | 451 | |
| christi_s | 5:ead95c0f7800 | 452 | /** Stop the playback in the middle of a song. |
| christi_s | 5:ead95c0f7800 | 453 | * After this call, you can now send the next audio file to buffer. |
| christi_s | 5:ead95c0f7800 | 454 | * |
| christi_s | 5:ead95c0f7800 | 455 | */ |
| christi_s | 4:cacb5e663fa9 | 456 | void stop(void); |
| christi_s | 6:eed008905159 | 457 | |
| christi_s | 6:eed008905159 | 458 | /** Get information about played audio stream. |
| christi_s | 6:eed008905159 | 459 | * |
| christi_s | 6:eed008905159 | 460 | * @param aInfo |
| christi_s | 6:eed008905159 | 461 | * Return value for the informations. |
| christi_s | 6:eed008905159 | 462 | * |
| christi_s | 6:eed008905159 | 463 | */ |
| christi_s | 6:eed008905159 | 464 | void getAudioInfo(AudioInfo* aInfo); |
| christi_s | 1:ced2c297cc1b | 465 | |
| christi_s | 1:ced2c297cc1b | 466 | protected: |
| christi_s | 1:ced2c297cc1b | 467 | unsigned short int wram_read(unsigned short int); |
| christi_s | 1:ced2c297cc1b | 468 | void wram_write(unsigned short int, unsigned short int); |
| christi_s | 1:ced2c297cc1b | 469 | void write_plugin(const unsigned short* , unsigned int); |
| christi_s | 0:7728d9c6c487 | 470 | void cs_low(void); |
| christi_s | 0:7728d9c6c487 | 471 | void cs_high(void); |
| christi_s | 0:7728d9c6c487 | 472 | void dcs_low(void); |
| christi_s | 0:7728d9c6c487 | 473 | void dcs_high(void); |
| christi_s | 0:7728d9c6c487 | 474 | void sci_en(void); |
| christi_s | 0:7728d9c6c487 | 475 | void sci_dis(void); |
| christi_s | 0:7728d9c6c487 | 476 | void sdi_en(void); |
| christi_s | 0:7728d9c6c487 | 477 | void sdi_dis(void); |
| christi_s | 0:7728d9c6c487 | 478 | |
| christi_s | 1:ced2c297cc1b | 479 | void spi_initialise(void); |
| christi_s | 1:ced2c297cc1b | 480 | |
| christi_s | 0:7728d9c6c487 | 481 | void sdi_initialise(void); |
| christi_s | 0:7728d9c6c487 | 482 | |
| christi_s | 0:7728d9c6c487 | 483 | void sci_write(unsigned char, unsigned short int); |
| christi_s | 0:7728d9c6c487 | 484 | void sdi_write(unsigned char); |
| christi_s | 0:7728d9c6c487 | 485 | unsigned short int sci_read(unsigned short int); |
| christi_s | 0:7728d9c6c487 | 486 | void sine_test_activate(unsigned char); |
| christi_s | 0:7728d9c6c487 | 487 | |
| christi_s | 0:7728d9c6c487 | 488 | void sine_test_deactivate(void); |
| christi_s | 0:7728d9c6c487 | 489 | |
| christi_s | 1:ced2c297cc1b | 490 | void changeVolume(void); |
| christi_s | 4:cacb5e663fa9 | 491 | |
| christi_s | 1:ced2c297cc1b | 492 | |
| christi_s | 2:5bab956cb59e | 493 | // TODO |
| christi_s | 2:5bab956cb59e | 494 | void power_down(void); |
| christi_s | 4:cacb5e663fa9 | 495 | |
| christi_s | 2:5bab956cb59e | 496 | void changeBass(void); |
| christi_s | 1:ced2c297cc1b | 497 | |
| christi_s | 4:cacb5e663fa9 | 498 | unsigned char bufferGetByte(void); |
| christi_s | 4:cacb5e663fa9 | 499 | void bufferReset(void); |
| christi_s | 4:cacb5e663fa9 | 500 | void dataRequestHandler(void); |
| christi_s | 2:5bab956cb59e | 501 | |
| christi_s | 4:cacb5e663fa9 | 502 | SPI _spi; |
| christi_s | 4:cacb5e663fa9 | 503 | DigitalOut _CS; |
| christi_s | 4:cacb5e663fa9 | 504 | DigitalOut _RST; |
| christi_s | 4:cacb5e663fa9 | 505 | DigitalOut _DCS; |
| christi_s | 4:cacb5e663fa9 | 506 | DigitalIn _DREQ; |
| christi_s | 4:cacb5e663fa9 | 507 | InterruptIn _DREQ_INTERUPT_IN; |
| christi_s | 4:cacb5e663fa9 | 508 | |
| christi_s | 8:5e4a21202223 | 509 | char* _buffer; |
| christi_s | 8:5e4a21202223 | 510 | char* _bufferReadPointer; |
| christi_s | 8:5e4a21202223 | 511 | char* _bufferWritePointer; |
| christi_s | 8:5e4a21202223 | 512 | int BUFFER_SIZE; |
| christi_s | 4:cacb5e663fa9 | 513 | |
| christi_s | 4:cacb5e663fa9 | 514 | bool _isIdle; |
| christi_s | 4:cacb5e663fa9 | 515 | |
| christi_s | 2:5bab956cb59e | 516 | // variables to save |
| christi_s | 2:5bab956cb59e | 517 | // volume, values in db |
| christi_s | 4:cacb5e663fa9 | 518 | float _balance; |
| christi_s | 4:cacb5e663fa9 | 519 | float _volume; |
| christi_s | 2:5bab956cb59e | 520 | // bass enhancer settings |
| christi_s | 4:cacb5e663fa9 | 521 | int _sb_amplitude; |
| christi_s | 4:cacb5e663fa9 | 522 | int _sb_freqlimit; |
| christi_s | 4:cacb5e663fa9 | 523 | int _st_amplitude; |
| christi_s | 8:5e4a21202223 | 524 | int _st_freqlimit; |
| christi_s | 8:5e4a21202223 | 525 | |
| christi_s | 4:cacb5e663fa9 | 526 | |
| christi_s | 4:cacb5e663fa9 | 527 | Ticker timer; |
| christi_s | 4:cacb5e663fa9 | 528 | |
| christi_s | 6:eed008905159 | 529 | static const char _sampleRateTable[4][4]; // _sampleRateTable[id][srate] |
| christi_s | 6:eed008905159 | 530 | |
| christi_s | 0:7728d9c6c487 | 531 | }; |
| christi_s | 4:cacb5e663fa9 | 532 | |
| christi_s | 0:7728d9c6c487 | 533 | #endif |