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