1 /* 2 * Copyright (C) 2008 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 #ifndef ANDROID_TONEGENERATOR_H_ 18 #define ANDROID_TONEGENERATOR_H_ 19 20 #include <utils/RefBase.h> 21 #include <utils/KeyedVector.h> 22 #include <utils/threads.h> 23 #include <media/AudioSystem.h> 24 #include <media/AudioTrack.h> 25 26 namespace android { 27 28 class ToneGenerator { 29 public: 30 31 // List of all available tones 32 // This enum must be kept consistant with constants in ToneGenerator JAVA class 33 enum tone_type { 34 // DTMF tones ITU-T Recommendation Q.23 35 TONE_DTMF_0 = 0, // 0 key: 1336Hz, 941Hz 36 TONE_DTMF_1, // 1 key: 1209Hz, 697Hz 37 TONE_DTMF_2, // 2 key: 1336Hz, 697Hz 38 TONE_DTMF_3, // 3 key: 1477Hz, 697Hz 39 TONE_DTMF_4, // 4 key: 1209Hz, 770Hz 40 TONE_DTMF_5, // 5 key: 1336Hz, 770Hz 41 TONE_DTMF_6, // 6 key: 1477Hz, 770Hz 42 TONE_DTMF_7, // 7 key: 1209Hz, 852Hz 43 TONE_DTMF_8, // 8 key: 1336Hz, 852Hz 44 TONE_DTMF_9, // 9 key: 1477Hz, 852Hz 45 TONE_DTMF_S, // * key: 1209Hz, 941Hz 46 TONE_DTMF_P, // # key: 1477Hz, 941Hz 47 TONE_DTMF_A, // A key: 1633Hz, 697Hz 48 TONE_DTMF_B, // B key: 1633Hz, 770Hz 49 TONE_DTMF_C, // C key: 1633Hz, 852Hz 50 TONE_DTMF_D, // D key: 1633Hz, 941Hz 51 // Call supervisory tones: 3GPP TS 22.001 (CEPT) 52 TONE_SUP_DIAL, // Dial tone: CEPT: 425Hz, continuous 53 FIRST_SUP_TONE = TONE_SUP_DIAL, 54 TONE_SUP_BUSY, // Busy tone, CEPT: 425Hz, 500ms ON, 500ms OFF... 55 TONE_SUP_CONGESTION, // Congestion tone CEPT, JAPAN: 425Hz, 200ms ON, 200ms OFF... 56 TONE_SUP_RADIO_ACK, // Radio path acknowlegment, CEPT, ANSI: 425Hz, 200ms ON 57 TONE_SUP_RADIO_NOTAVAIL, // Radio path not available: 425Hz, 200ms ON, 200 OFF 3 bursts 58 TONE_SUP_ERROR, // Error/Special info: 950Hz+1400Hz+1800Hz, 330ms ON, 1s OFF... 59 TONE_SUP_CALL_WAITING, // Call Waiting CEPT,JAPAN: 425Hz, 200ms ON, 600ms OFF, 200ms ON, 3s OFF... 60 TONE_SUP_RINGTONE, // Ring Tone CEPT, JAPAN: 425Hz, 1s ON, 4s OFF... 61 LAST_SUP_TONE = TONE_SUP_RINGTONE, 62 // Proprietary tones: 3GPP TS 31.111 63 TONE_PROP_BEEP, // General beep: 400Hz+1200Hz, 35ms ON 64 TONE_PROP_ACK, // Positive Acknowlgement: 1200Hz, 100ms ON, 100ms OFF 2 bursts 65 TONE_PROP_NACK, // Negative Acknowlgement: 300Hz+400Hz+500Hz, 400ms ON 66 TONE_PROP_PROMPT, // Prompt tone: 400Hz+1200Hz, 200ms ON 67 TONE_PROP_BEEP2, // General double beep: 400Hz+1200Hz, 35ms ON, 200ms OFF, 35ms on 68 // Additional call supervisory tones: specified by IS-95 only 69 TONE_SUP_INTERCEPT, // Intercept tone: alternating 440 Hz and 620 Hz tones, each on for 250 ms. 70 TONE_SUP_INTERCEPT_ABBREV, // Abbreviated intercept: intercept tone limited to 4 seconds 71 TONE_SUP_CONGESTION_ABBREV, // Abbreviated congestion: congestion tone limited to 4 seconds 72 TONE_SUP_CONFIRM, // Confirm tone: a 350 Hz tone added to a 440 Hz tone repeated 3 times in a 100 ms on, 100 ms off cycle. 73 TONE_SUP_PIP, // Pip tone: four bursts of 480 Hz tone (0.1 s on, 0.1 s off). 74 75 // CDMA Tones 76 TONE_CDMA_DIAL_TONE_LITE, 77 TONE_CDMA_NETWORK_USA_RINGBACK, 78 TONE_CDMA_INTERCEPT, 79 TONE_CDMA_ABBR_INTERCEPT, 80 TONE_CDMA_REORDER, 81 TONE_CDMA_ABBR_REORDER, 82 TONE_CDMA_NETWORK_BUSY, 83 TONE_CDMA_CONFIRM, 84 TONE_CDMA_ANSWER, 85 TONE_CDMA_NETWORK_CALLWAITING, 86 TONE_CDMA_PIP, 87 88 // ISDN 89 TONE_CDMA_CALL_SIGNAL_ISDN_NORMAL, // ISDN Alert Normal 90 TONE_CDMA_CALL_SIGNAL_ISDN_INTERGROUP, // ISDN Intergroup 91 TONE_CDMA_CALL_SIGNAL_ISDN_SP_PRI, // ISDN SP PRI 92 TONE_CDMA_CALL_SIGNAL_ISDN_PAT3, // ISDN Alert PAT3 93 TONE_CDMA_CALL_SIGNAL_ISDN_PING_RING, // ISDN Alert PING RING 94 TONE_CDMA_CALL_SIGNAL_ISDN_PAT5, // ISDN Alert PAT5 95 TONE_CDMA_CALL_SIGNAL_ISDN_PAT6, // ISDN Alert PAT6 96 TONE_CDMA_CALL_SIGNAL_ISDN_PAT7, // ISDN Alert PAT7 97 // ISDN end 98 99 // IS54 100 TONE_CDMA_HIGH_L, // IS54 High Pitch Long 101 TONE_CDMA_MED_L, // IS54 Med Pitch Long 102 TONE_CDMA_LOW_L, // IS54 Low Pitch Long 103 TONE_CDMA_HIGH_SS, // IS54 High Pitch Short Short 104 TONE_CDMA_MED_SS, // IS54 Medium Pitch Short Short 105 TONE_CDMA_LOW_SS, // IS54 Low Pitch Short Short 106 TONE_CDMA_HIGH_SSL, // IS54 High Pitch Short Short Long 107 TONE_CDMA_MED_SSL, // IS54 Medium Pitch Short Short Long 108 TONE_CDMA_LOW_SSL, // IS54 Low Pitch Short Short Long 109 TONE_CDMA_HIGH_SS_2, // IS54 High Pitch Short Short 2 110 TONE_CDMA_MED_SS_2, // IS54 Med Pitch Short Short 2 111 TONE_CDMA_LOW_SS_2, // IS54 Low Pitch Short Short 2 112 TONE_CDMA_HIGH_SLS, // IS54 High Pitch Short Long Short 113 TONE_CDMA_MED_SLS, // IS54 Med Pitch Short Long Short 114 TONE_CDMA_LOW_SLS, // IS54 Low Pitch Short Long Short 115 TONE_CDMA_HIGH_S_X4, // IS54 High Pitch Short Short Short Short 116 TONE_CDMA_MED_S_X4, // IS54 Med Pitch Short Short Short Short 117 TONE_CDMA_LOW_S_X4, // IS54 Low Pitch Short Short Short Short 118 TONE_CDMA_HIGH_PBX_L, // PBX High Pitch Long 119 TONE_CDMA_MED_PBX_L, // PBX Med Pitch Long 120 TONE_CDMA_LOW_PBX_L, // PBX Low Pitch Long 121 TONE_CDMA_HIGH_PBX_SS, // PBX High Short Short 122 TONE_CDMA_MED_PBX_SS, // PBX Med Short Short 123 TONE_CDMA_LOW_PBX_SS, // PBX Low Short Short 124 TONE_CDMA_HIGH_PBX_SSL, // PBX High Short Short Long 125 TONE_CDMA_MED_PBX_SSL, // PBX Med Short Short Long 126 TONE_CDMA_LOW_PBX_SSL, // PBX Low Short Short Long 127 TONE_CDMA_HIGH_PBX_SLS, // PBX High SLS 128 TONE_CDMA_MED_PBX_SLS, // PBX Med SLS 129 TONE_CDMA_LOW_PBX_SLS, // PBX Low SLS 130 TONE_CDMA_HIGH_PBX_S_X4, // PBX High SSSS 131 TONE_CDMA_MED_PBX_S_X4, // PBX Med SSSS 132 TONE_CDMA_LOW_PBX_S_X4, // PBX LOW SSSS 133 //IS54 end 134 // proprietary 135 TONE_CDMA_ALERT_NETWORK_LITE, 136 TONE_CDMA_ALERT_AUTOREDIAL_LITE, 137 TONE_CDMA_ONE_MIN_BEEP, 138 TONE_CDMA_KEYPAD_VOLUME_KEY_LITE, 139 TONE_CDMA_PRESSHOLDKEY_LITE, 140 TONE_CDMA_ALERT_INCALL_LITE, 141 TONE_CDMA_EMERGENCY_RINGBACK, 142 TONE_CDMA_ALERT_CALL_GUARD, 143 TONE_CDMA_SOFT_ERROR_LITE, 144 TONE_CDMA_CALLDROP_LITE, 145 // proprietary end 146 TONE_CDMA_NETWORK_BUSY_ONE_SHOT, 147 TONE_CDMA_ABBR_ALERT, 148 TONE_CDMA_SIGNAL_OFF, 149 //CDMA end 150 NUM_TONES, 151 NUM_SUP_TONES = LAST_SUP_TONE-FIRST_SUP_TONE+1 152 }; 153 154 ToneGenerator(audio_stream_type_t streamType, float volume, bool threadCanCallJava = false); 155 ~ToneGenerator(); 156 157 bool startTone(tone_type toneType, int durationMs = -1); 158 void stopTone(); 159 160 bool isInited() { return (mState == TONE_IDLE)?false:true;} 161 162 // returns the audio session this ToneGenerator belongs to or 0 if an error occured. 163 int getSessionId() { return (mpAudioTrack == NULL) ? 0 : mpAudioTrack->getSessionId(); } 164 165 private: 166 167 enum tone_state { 168 TONE_IDLE, // ToneGenerator is being initialized or initialization failed 169 TONE_INIT, // ToneGenerator has been successfully initialized and is not playing 170 TONE_STARTING, // ToneGenerator is starting playing 171 TONE_PLAYING, // ToneGenerator is playing 172 TONE_STOPPING, // ToneGenerator is stoping 173 TONE_STOPPED, // ToneGenerator is stopped: the AudioTrack will be stopped 174 TONE_RESTARTING // A start request was received in active state (playing or stopping) 175 }; 176 177 178 // Region specific tones. 179 // These supervisory tones are different depending on the region (USA/CANADA, JAPAN, rest of the world). 180 // When a tone in the range [FIRST_SUP_TONE, LAST_SUP_TONE] is requested, the region is determined 181 // from system property gsm.operator.iso-country and the proper tone descriptor is selected with the 182 // help of sToneMappingTable[] 183 enum regional_tone_type { 184 // ANSI supervisory tones 185 TONE_ANSI_DIAL = NUM_TONES, // Dial tone: a continuous 350 Hz + 440 Hz tone. 186 TONE_ANSI_BUSY, // Busy tone on: a 480 Hz + 620 Hz tone repeated in a 500 ms on, 500 ms off cycle. 187 TONE_ANSI_CONGESTION, // Network congestion (reorder) tone on: a 480 Hz + 620 Hz tone repeated in a 250 ms on, 250 ms off cycle. 188 TONE_ANSI_CALL_WAITING, // Call waiting tone on: 440 Hz, on for 300 ms, 9,7 s off followed by 189 // (440 Hz, on for 100 ms off for 100 ms, on for 100 ms, 9,7s off and repeated as necessary). 190 TONE_ANSI_RINGTONE, // Ring Tone: a 440 Hz + 480 Hz tone repeated in a 2 s on, 4 s off pattern. 191 // JAPAN Supervisory tones 192 TONE_JAPAN_DIAL, // Dial tone: 400Hz, continuous 193 TONE_JAPAN_BUSY, // Busy tone: 400Hz, 500ms ON, 500ms OFF... 194 TONE_JAPAN_RADIO_ACK, // Radio path acknowlegment: 400Hz, 1s ON, 2s OFF... 195 NUM_ALTERNATE_TONES 196 }; 197 198 enum region { 199 ANSI, 200 JAPAN, 201 CEPT, 202 NUM_REGIONS 203 }; 204 205 static const unsigned char sToneMappingTable[NUM_REGIONS-1][NUM_SUP_TONES]; 206 207 static const unsigned int TONEGEN_MAX_WAVES = 3; // Maximun number of sine waves in a tone segment 208 static const unsigned int TONEGEN_MAX_SEGMENTS = 12; // Maximun number of segments in a tone descriptor 209 static const unsigned int TONEGEN_INF = 0xFFFFFFFF; // Represents infinite time duration 210 static const float TONEGEN_GAIN = 0.9; // Default gain passed to WaveGenerator(). 211 212 // ToneDescriptor class contains all parameters needed to generate a tone: 213 // - The array waveFreq[]: 214 // 1 for static tone descriptors: contains the frequencies of all individual waves making the multi-tone. 215 // 2 for active tone descritors: contains the indexes of the WaveGenerator objects in mWaveGens 216 // The number of sine waves varies from 1 to TONEGEN_MAX_WAVES. 217 // The first null value indicates that no more waves are needed. 218 // - The array segments[] is used to generate the tone pulses. A segment is a period of time 219 // during which the tone is ON or OFF. Segments with even index (starting from 0) 220 // correspond to tone ON state and segments with odd index to OFF state. 221 // The data stored in segments[] is the duration of the corresponding period in ms. 222 // The first segment encountered with a 0 duration indicates that no more segment follows. 223 // - loopCnt - Number of times to repeat a sequence of seqments after playing this 224 // - loopIndx - The segment index to go back and play is loopcnt > 0 225 // - repeatCnt indicates the number of times the sequence described by segments[] array must be repeated. 226 // When the tone generator encounters the first 0 duration segment, it will compare repeatCnt to mCurCount. 227 // If mCurCount > repeatCnt, the tone is stopped automatically. Otherwise, tone sequence will be 228 // restarted from segment repeatSegment. 229 // - repeatSegment number of the first repeated segment when repeatCnt is not null 230 231 class ToneSegment { 232 public: 233 unsigned int duration; 234 unsigned short waveFreq[TONEGEN_MAX_WAVES+1]; 235 unsigned short loopCnt; 236 unsigned short loopIndx; 237 }; 238 239 class ToneDescriptor { 240 public: 241 ToneSegment segments[TONEGEN_MAX_SEGMENTS+1]; 242 unsigned long repeatCnt; 243 unsigned long repeatSegment; 244 }; 245 246 static const ToneDescriptor sToneDescriptors[]; 247 248 bool mThreadCanCallJava; 249 unsigned int mTotalSmp; // Total number of audio samples played (gives current time) 250 unsigned int mNextSegSmp; // Position of next segment transition expressed in samples 251 // NOTE: because mTotalSmp, mNextSegSmp are stored on 32 bit, current design will operate properly 252 // only if tone duration is less than about 27 Hours(@44100Hz sampling rate). If this time is exceeded, 253 // no crash will occur but tone sequence will show a glitch. 254 unsigned int mMaxSmp; // Maximum number of audio samples played (maximun tone duration) 255 int mDurationMs; // Maximum tone duration in ms 256 257 unsigned short mCurSegment; // Current segment index in ToneDescriptor segments[] 258 unsigned short mCurCount; // Current sequence repeat count 259 volatile unsigned short mState; // ToneGenerator state (tone_state) 260 unsigned short mRegion; 261 const ToneDescriptor *mpToneDesc; // pointer to active tone descriptor 262 const ToneDescriptor *mpNewToneDesc; // pointer to next active tone descriptor 263 264 unsigned short mLoopCounter; // Current tone loopback count 265 266 uint32_t mSamplingRate; // AudioFlinger Sampling rate 267 AudioTrack *mpAudioTrack; // Pointer to audio track used for playback 268 Mutex mLock; // Mutex to control concurent access to ToneGenerator object from audio callback and application API 269 Mutex mCbkCondLock; // Mutex associated to mWaitCbkCond 270 Condition mWaitCbkCond; // condition enabling interface to wait for audio callback completion after a change is requested 271 float mVolume; // Volume applied to audio track 272 audio_stream_type_t mStreamType; // Audio stream used for output 273 unsigned int mProcessSize; // Size of audio blocks generated at a time by audioCallback() (in PCM frames). 274 struct timespec mStartTime; // tone start time: needed to guaranty actual tone duration 275 276 bool initAudioTrack(); 277 static void audioCallback(int event, void* user, void *info); 278 bool prepareWave(); 279 unsigned int numWaves(unsigned int segmentIdx); 280 void clearWaveGens(); 281 tone_type getToneForRegion(tone_type toneType); 282 283 // WaveGenerator generates a single sine wave 284 class WaveGenerator { 285 public: 286 enum gen_command { 287 WAVEGEN_START, // Start/restart wave from phase 0 288 WAVEGEN_CONT, // Continue wave from current phase 289 WAVEGEN_STOP // Stop wave on zero crossing 290 }; 291 292 WaveGenerator(unsigned short samplingRate, unsigned short frequency, 293 float volume); 294 ~WaveGenerator(); 295 296 void getSamples(short *outBuffer, unsigned int count, 297 unsigned int command); 298 299 private: 300 static const short GEN_AMP = 32000; // amplitude of generator 301 static const short S_Q14 = 14; // shift for Q14 302 static const short S_Q15 = 15; // shift for Q15 303 304 short mA1_Q14; // Q14 coefficient 305 // delay line of full amplitude generator 306 short mS1, mS2; // delay line S2 oldest 307 short mS2_0; // saved value for reinitialisation 308 short mAmplitude_Q15; // Q15 amplitude 309 }; 310 311 KeyedVector<unsigned short, WaveGenerator *> mWaveGens; // list of active wave generators. 312 }; 313 314 } 315 ; // namespace android 316 317 #endif /*ANDROID_TONEGENERATOR_H_*/ 318
