suu pen / Sound

このライブラリでは、単音とメロディの出力が可能です。 In this library, you can output a single tone and melody. mbedのpwmOutとDigitalOutを使ってスピーカや圧電ブザーを直接駆動します。 directly drive speaker or buzzer and DigitalOut pwmOut using the mbed. メロディデータは、mbedのローカルにtxtファイルとして保存するか、プログラム中に配列データとして保存してください。 Melody data is either stored in a txt file on the local mbed, save it as a data array in the program.

Dependents:   kitchenTimer_Clock SoundLibraryExample_Melody_ProgramData M3PI_SuiviLigne

Sound.h@9:5385907711e0, 2011-12-11 (annotated)

Committer:
suupen
Date:
Sun Dec 11 11:20:31 2011 +0000
Revision:
9:5385907711e0
Parent:
8:71488a68dc58
Child:
10:059d4df77110
V1.1 2011/12/11 muonji no bug fix

Who changed what in which revision?

UserRevisionLine numberNew contents of line
suupen 8:71488a68dc58 1 /* mbed Sound Library
suupen 8:71488a68dc58 2 * Copyright (c) 2011 suupen
suupen 8:71488a68dc58 3 *
suupen 8:71488a68dc58 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
suupen 8:71488a68dc58 5 * of this software and associated documentation files (the "Software"), to deal
suupen 8:71488a68dc58 6 * in the Software without restriction, including without limitation the rights
suupen 8:71488a68dc58 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
suupen 8:71488a68dc58 8 * copies of the Software, and to permit persons to whom the Software is
suupen 8:71488a68dc58 9 * furnished to do so, subject to the following conditions:
suupen 8:71488a68dc58 10 *
suupen 8:71488a68dc58 11 * The above copyright notice and this permission notice shall be included in
suupen 8:71488a68dc58 12 * all copies or substantial portions of the Software.
suupen 8:71488a68dc58 13 *
suupen 8:71488a68dc58 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
suupen 8:71488a68dc58 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
suupen 8:71488a68dc58 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
suupen 8:71488a68dc58 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
suupen 8:71488a68dc58 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
suupen 8:71488a68dc58 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
suupen 8:71488a68dc58 20 * THE SOFTWARE.
suupen 8:71488a68dc58 21 */
suupen 8:71488a68dc58 22
suupen 0:e3f005984c2a 23 /***********************************************************************/
suupen 0:e3f005984c2a 24 /* */
suupen 0:e3f005984c2a 25 /* Sound.h */
suupen 0:e3f005984c2a 26 /* */
suupen 0:e3f005984c2a 27 /* V0.1 : 2011/11/13 */
suupen 8:71488a68dc58 28 /* V0.2 : 2011/11/19 Added copyright notice */
suupen 9:5385907711e0 29 /* V1.1 : 2011/12/11 muon ji no syori bug fix */
suupen 0:e3f005984c2a 30 /***********************************************************************/
suupen 0:e3f005984c2a 31 #ifndef _SOUND_H
suupen 0:e3f005984c2a 32 #define _SOUND_H
suupen 0:e3f005984c2a 33
suupen 0:e3f005984c2a 34 #include <string>
suupen 0:e3f005984c2a 35 #include "types.h"
suupen 0:e3f005984c2a 36
suupen 0:e3f005984c2a 37
suupen 0:e3f005984c2a 38 /** Sound output control class, based on a PwmOut
suupen 0:e3f005984c2a 39 *
suupen 0:e3f005984c2a 40 * Example:
suupen 0:e3f005984c2a 41 * @code
suupen 7:758ad151b16f 42 * // Output tone and merody
suupen 0:e3f005984c2a 43 *
suupen 6:fb02f6d9bbaf 44 * #include "mbed.h"
suupen 7:758ad151b16f 45 * #include "Sound.h" // sound library header
suupen 0:e3f005984c2a 46 *
suupen 6:fb02f6d9bbaf 47 * Sound sound(p21, p10); // 1tu me no sound syuturyoku (pwmOut = p21, digitalOut = p10)
suupen 0:e3f005984c2a 48 *
suupen 4:dc8c3e896c80 49 *
suupen 4:dc8c3e896c80 50 * <scematic>
suupen 4:dc8c3e896c80 51 *
suupen 4:dc8c3e896c80 52 * -------- _/
suupen 4:dc8c3e896c80 53 * mbed(p21) -----|R:200ohm|----| | speaker
suupen 5:9d861f258467 54 * pwmOut -------- | |
suupen 4:dc8c3e896c80 55 * | |
suupen 4:dc8c3e896c80 56 * mbed(p10) -------------------|_|
suupen 4:dc8c3e896c80 57 * digitalOut \
suupen 4:dc8c3e896c80 58 *
suupen 0:e3f005984c2a 59 * //--------------------------------
suupen 0:e3f005984c2a 60 * // "westminster chime" merody data
suupen 0:e3f005984c2a 61 * //--------------------------------
suupen 0:e3f005984c2a 62 * const Sound::sound_t WESTMINSTER[] = {
suupen 0:e3f005984c2a 63 * // hanon siji 0:b(flat) 1:tujo 2:#(sharp)
suupen 0:e3f005984c2a 64 * // | C1 - B9 kan deno onkai(Gx ha 9x ni okikae te siji) 0xFF=end data
suupen 0:e3f005984c2a 65 * // | | time (1/1[ms]/count)
suupen 0:e3f005984c2a 66 * // | | | envelope(yoin) (1/1 [ms]/count)
suupen 0:e3f005984c2a 67 * // | | | |
suupen 0:e3f005984c2a 68 * {1,0xA4,1200,1000},
suupen 0:e3f005984c2a 69 * {1,0xF4,1200,1000},
suupen 0:e3f005984c2a 70 * {1,0x94,1200,1000},
suupen 0:e3f005984c2a 71 * {1,0xC4,2400,1000},
suupen 0:e3f005984c2a 72 *
suupen 0:e3f005984c2a 73 * {1,0xC4,1200,1000},
suupen 0:e3f005984c2a 74 * {1,0x94,1200,1000},
suupen 0:e3f005984c2a 75 * {1,0xA4,1200,1000},
suupen 0:e3f005984c2a 76 * {1,0xF4,2400,1000},
suupen 0:e3f005984c2a 77 *
suupen 0:e3f005984c2a 78 * {1,0xFF,1000,0}, // end
suupen 0:e3f005984c2a 79 * };
suupen 0:e3f005984c2a 80 *
suupen 0:e3f005984c2a 81 * /--------------------------------------
suupen 6:fb02f6d9bbaf 82 * * main
suupen 0:e3f005984c2a 83 * /---------------------------------------
suupen 6:fb02f6d9bbaf 84 * int main() {
suupen 0:e3f005984c2a 85 *
suupen 0:e3f005984c2a 86 * //---------------------
suupen 0:e3f005984c2a 87 * // enso data no settei
suupen 0:e3f005984c2a 88 * //---------------------
suupen 5:9d861f258467 89 * // sound.sound_enso("/local/enso.txt"); // mbed local file data "enso.txt" load (sita ni data no rei wo oite oku)
suupen 5:9d861f258467 90 * sound.sound_enso((Sound::sound_t*)WESTMINSTER);
suupen 0:e3f005984c2a 91 *
suupen 5:9d861f258467 92 * //---------------------------------------------------
suupen 5:9d861f258467 93 * // output tone
suupen 5:9d861f258467 94 * //---------------------------------------------------
suupen 5:9d861f258467 95 * // tone1
suupen 5:9d861f258467 96 * Sound::sound_t oto = {1,0x95,200,100};
suupen 5:9d861f258467 97 * sound.sound_sound(oto);
suupen 5:9d861f258467 98 * while(sound.sound_sound() == true){}
suupen 5:9d861f258467 99 *
suupen 5:9d861f258467 100 * // tone2
suupen 5:9d861f258467 101 * oto.hanon = 1; oto.onkai = 0xA5; oto.time = 2000; oto.envelope = 1000;
suupen 5:9d861f258467 102 * sound.sound_sound(oto);
suupen 5:9d861f258467 103 * while(sound.sound_sound() == true){}
suupen 0:e3f005984c2a 104 *
suupen 5:9d861f258467 105 * //---------------
suupen 5:9d861f258467 106 * // output merody
suupen 5:9d861f258467 107 * //--------------
suupen 5:9d861f258467 108 * sound.sound_enso(true);
suupen 0:e3f005984c2a 109 *
suupen 5:9d861f258467 110 * while(1) {
suupen 0:e3f005984c2a 111 * }
suupen 0:e3f005984c2a 112 *}
suupen 0:e3f005984c2a 113 *
suupen 0:e3f005984c2a 114 * @endcode
suupen 0:e3f005984c2a 115 */
suupen 0:e3f005984c2a 116
suupen 0:e3f005984c2a 117
suupen 0:e3f005984c2a 118
suupen 0:e3f005984c2a 119
suupen 0:e3f005984c2a 120
suupen 0:e3f005984c2a 121
suupen 0:e3f005984c2a 122
suupen 0:e3f005984c2a 123
suupen 0:e3f005984c2a 124
suupen 0:e3f005984c2a 125
suupen 0:e3f005984c2a 126
suupen 0:e3f005984c2a 127
suupen 0:e3f005984c2a 128
suupen 0:e3f005984c2a 129
suupen 0:e3f005984c2a 130 class Sound {
suupen 0:e3f005984c2a 131 public:
suupen 0:e3f005984c2a 132
suupen 1:358449cfdcd3 133 /** tone data struct
suupen 1:358449cfdcd3 134 *
suupen 1:358449cfdcd3 135 * @param uint8_t hanon : hanon siji 0:b(flat) 1:tujo 2:#(sharp)
suupen 1:358449cfdcd3 136 * @param uint16_t onkai : C1 - B9 kan deno onkai(Gx ha 9x ni okikae te siji) 0x00:hatuon teisi 0xFF:enso syuryo
suupen 1:358449cfdcd3 137 * @param uint16_t time : hatuon jikan (1/1 [ms]/count)
suupen 1:358449cfdcd3 138 * @param uint16_t envelope : yoin(envelope) jikan (1/1 [ms]/count)
suupen 1:358449cfdcd3 139 */
suupen 0:e3f005984c2a 140 typedef struct {
suupen 0:e3f005984c2a 141 uint8_t hanon; // hanon siji 0:b(flat) 1:tujo 2:#(sharp)
suupen 0:e3f005984c2a 142 uint16_t onkai; // C1 - B9 kan deno onkai(Gx ha 9x ni okikae te siji)
suupen 0:e3f005984c2a 143 // 0x00:hatuon teisi 0xFF:enso syuryo
suupen 0:e3f005984c2a 144 uint16_t time; // hatuon jikan (1/1 [ms]/count)
suupen 0:e3f005984c2a 145 uint16_t envelope; // yoin(envelope) jikan (1/1 [ms]/count)
suupen 0:e3f005984c2a 146 } sound_t;
suupen 0:e3f005984c2a 147
suupen 0:e3f005984c2a 148 /*
suupen 0:e3f005984c2a 149 // hanon no menber
suupen 0:e3f005984c2a 150 enum{
suupen 0:e3f005984c2a 151 Z_hanonF = 0, // b
suupen 0:e3f005984c2a 152 Z_hanonN , // tujo
suupen 0:e3f005984c2a 153 Z_hanonS, // #
suupen 0:e3f005984c2a 154 };
suupen 0:e3f005984c2a 155 */
suupen 0:e3f005984c2a 156
suupen 0:e3f005984c2a 157 /** Create a sound object connected to the specified PwmOut pin & DigitalOut pin
suupen 0:e3f005984c2a 158 *
suupen 0:e3f005984c2a 159 * @param pin PwmOut pin to connect to
suupen 0:e3f005984c2a 160 * @param pin DigitalOut pin to connect to
suupen 0:e3f005984c2a 161 */
suupen 0:e3f005984c2a 162 Sound(PinName pwm , PinName kijun);
suupen 0:e3f005984c2a 163
suupen 1:358449cfdcd3 164 /** Check tone
suupen 0:e3f005984c2a 165 *
suupen 2:ed8a182cefe2 166 * @param return A bool ture : output
suupen 3:2f5107cb0589 167 * \\false: none
suupen 0:e3f005984c2a 168 */
suupen 0:e3f005984c2a 169 bool sound_sound(void); // oto no syuturyoku jotai wo kakunin
suupen 0:e3f005984c2a 170 // true : oto ari false : oto nasi
suupen 1:358449cfdcd3 171 /** output tone
suupen 1:358449cfdcd3 172 *
suupen 1:358449cfdcd3 173 * @param sound_t data : tone data set
suupen 1:358449cfdcd3 174 */
suupen 0:e3f005984c2a 175 void sound_sound(sound_t data); // oto no syuturyoku
suupen 0:e3f005984c2a 176 // para : oto no data
suupen 0:e3f005984c2a 177
suupen 1:358449cfdcd3 178 /** merody data set (file data)
suupen 1:358449cfdcd3 179 *
suupen 1:358449cfdcd3 180 * @param merody data file path and name (example : "/local/merodyFileName.txt")
suupen 1:358449cfdcd3 181 */
suupen 0:e3f005984c2a 182 bool sound_enso(char *path); // enso data wo file kara yomikomi
suupen 0:e3f005984c2a 183 // true : data kakunou OK false: data kakunou NG
suupen 1:358449cfdcd3 184 /** merody data set (data table)
suupen 1:358449cfdcd3 185 *
suupen 1:358449cfdcd3 186 * @param merody data table name (example : "(Sound::sound_t*)WESTMINSTER")
suupen 1:358449cfdcd3 187 */
suupen 0:e3f005984c2a 188 void sound_enso(Sound::sound_t* onpudata); // enso data wo program no data table kara yomikomi
suupen 1:358449cfdcd3 189
suupen 1:358449cfdcd3 190 /** check merody
suupen 1:358449cfdcd3 191 *
suupen 1:358449cfdcd3 192 * @param raturn ture:merody output //false:merody stop
suupen 1:358449cfdcd3 193 */
suupen 0:e3f005984c2a 194 bool sound_enso(void); // enso jyotai check
suupen 0:e3f005984c2a 195 // true : enso chu false : enso shuryo
suupen 1:358449cfdcd3 196 /** request merody start or stop
suupen 1:358449cfdcd3 197 *
suupen 1:358449cfdcd3 198 * @param ture:start merody //false:stop merody
suupen 1:358449cfdcd3 199 */
suupen 0:e3f005984c2a 200 void sound_enso(bool siji); // enso start / stop
suupen 0:e3f005984c2a 201 // true : enso start false : enso stop
suupen 0:e3f005984c2a 202
suupen 0:e3f005984c2a 203 //protected:
suupen 0:e3f005984c2a 204 private:
suupen 0:e3f005984c2a 205 PwmOut _pwm;
suupen 0:e3f005984c2a 206 DigitalOut _kijun;
suupen 0:e3f005984c2a 207
suupen 0:e3f005984c2a 208 Ticker sound_timer;
suupen 0:e3f005984c2a 209 Timer hatuon_jikan;
suupen 0:e3f005984c2a 210
suupen 0:e3f005984c2a 211
suupen 0:e3f005984c2a 212 #define Z_pwmSyuuki (1) // PWM syuuki (1/1[us]/count) syokichi = 1
suupen 0:e3f005984c2a 213 #define Z_pulseCheckSyuuki (20) // puls check syuuki (1/1 [us]/count) syokichi = 20 (10us ika deha pwm settei ga ijo ni naru)
suupen 0:e3f005984c2a 214
suupen 0:e3f005984c2a 215
suupen 0:e3f005984c2a 216 typedef struct{
suupen 0:e3f005984c2a 217 uint32_t syuuki; // oto no syuuki no count suu wo kioku (1/1 [us]/count)
suupen 0:e3f005984c2a 218 uint32_t jikan; // oto no syuturyoku jikan wo kanri (1/1 [us]/count)
suupen 0:e3f005984c2a 219 uint32_t envelope; // envelope counter 0 - 1000000[us](1[s])
suupen 0:e3f005984c2a 220 uint32_t shokichienvelope; // shokichi envelope counter 0 - 1000000[us](1[s])
suupen 0:e3f005984c2a 221 } soundout_t;
suupen 0:e3f005984c2a 222
suupen 0:e3f005984c2a 223
suupen 0:e3f005984c2a 224 soundout_t O_sound; // oto no syuturyoku pwm data
suupen 0:e3f005984c2a 225
suupen 0:e3f005984c2a 226 sound_t enso[100]; // mbed drive no enso data kakuno yo
suupen 0:e3f005984c2a 227 sound_t *ensoDataTable; // enso data no sento address kioku
suupen 0:e3f005984c2a 228
suupen 0:e3f005984c2a 229 void sound_out(float siji, int8_t fugo);
suupen 0:e3f005984c2a 230 void pulseCheck(void);
suupen 0:e3f005984c2a 231 uint8_t F_pwmSet; // 0:zenhan hansyuuki 1:kohan hansyuuki wo request
suupen 0:e3f005984c2a 232 uint32_t C_syuukiKeika;
suupen 0:e3f005984c2a 233 uint8_t f_muonSet; // muon ji no sound_out() syori wo kurikaesu no wo fusegu
suupen 0:e3f005984c2a 234 uint32_t C_1msProcess; // 1ms syuuki syori counter (Z_pulseCheckSyuuki/1 [us]/count))
suupen 0:e3f005984c2a 235
suupen 0:e3f005984c2a 236
suupen 0:e3f005984c2a 237 void sound_ensoSyori(void);
suupen 0:e3f005984c2a 238 int keikajikan; // 1tu no oto no keikajikan
suupen 0:e3f005984c2a 239 sound_t* onpu; // onpu data no sento address
suupen 0:e3f005984c2a 240
suupen 0:e3f005984c2a 241
suupen 0:e3f005984c2a 242 };
suupen 0:e3f005984c2a 243
suupen 0:e3f005984c2a 244
suupen 0:e3f005984c2a 245 #undef _SOUND_C
suupen 0:e3f005984c2a 246 #endif // _SOUND_H