auto import from //branches/cupcake/...@130745
[android/platform/packages/apps/Phone.git] / src / com / android / phone / CallNotifier.java
1 /*
2  * Copyright (C) 2006 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 package com.android.phone;
18
19 import com.android.internal.telephony.Call;
20 import com.android.internal.telephony.CallerInfo;
21 import com.android.internal.telephony.CallerInfoAsyncQuery;
22 import com.android.internal.telephony.Connection;
23 import com.android.internal.telephony.Phone;
24 import com.android.internal.telephony.gsm.GSMPhone;
25
26 import android.content.Context;
27 import android.media.AudioManager;
28 import android.media.ToneGenerator;
29 import android.os.AsyncResult;
30 import android.os.Handler;
31 import android.os.Message;
32 import android.os.SystemClock;
33 import android.os.SystemProperties;
34 import android.provider.CallLog;
35 import android.provider.CallLog.Calls;
36 import android.provider.Checkin;
37 import android.provider.Settings;
38 import android.telephony.PhoneStateListener;
39 import android.telephony.TelephonyManager;
40 import android.util.Log;
41
42
43 /**
44  * Stub which listens for phone state changes and decides whether it is worth
45  * telling the user what just happened.
46  */
47 public class CallNotifier extends Handler
48         implements CallerInfoAsyncQuery.OnQueryCompleteListener {
49     private static final String TAG = PhoneApp.LOG_TAG;
50
51     // this debug flag is now attached to the "userdebuggable" builds
52     // to keep useful logging available.
53     private static final boolean DBG =
54             (SystemProperties.getInt("ro.debuggable", 0) == 1);
55
56     // Strings used with Checkin.logEvent().
57     private static final String PHONE_UI_EVENT_RINGER_QUERY_ELAPSED =
58         "using default incoming call behavior";
59     private static final String PHONE_UI_EVENT_MULTIPLE_QUERY =
60         "multiple incoming call queries attempted";
61
62     // query timeout period, about 0.5 sec.
63     private static final int RINGTONE_QUERY_WAIT_TIME = 500;
64
65     // values used to track the query state
66     private static final int CALLERINFO_QUERY_READY = 0;
67     private static final int CALLERINFO_QUERYING = -1;
68
69     // the state of the CallerInfo Query.
70     private int mCallerInfoQueryState;
71
72     // object used to synchronize access to mCallerInfoQueryState
73     private Object mCallerInfoQueryStateGuard = new Object();
74
75     // Event used to indicate a query timeout.
76     private static final int RINGER_CUSTOM_RINGTONE_QUERY_COMPLETE = 100;
77
78     // Events from the Phone object:
79     private static final int PHONE_STATE_CHANGED = 1;
80     private static final int PHONE_NEW_RINGING_CONNECTION = 2;
81     private static final int PHONE_DISCONNECT = 3;
82     private static final int PHONE_UNKNOWN_CONNECTION_APPEARED = 4;
83     private static final int PHONE_INCOMING_RING = 5;
84     // Events generated internally:
85     private static final int PHONE_MWI_CHANGED = 6;
86     private static final int PHONE_BATTERY_LOW = 7;
87
88     private PhoneApp mApplication;
89     private Phone mPhone;
90     private InCallScreen mCallScreen;
91     private Ringer mRinger;
92     private BluetoothHandsfree mBluetoothHandsfree;
93     private boolean mSilentRingerRequested;
94
95     public CallNotifier(PhoneApp app, Phone phone, Ringer ringer,
96                         BluetoothHandsfree btMgr) {
97         mApplication = app;
98
99         mPhone = phone;
100         mPhone.registerForNewRingingConnection(this, PHONE_NEW_RINGING_CONNECTION, null);
101         mPhone.registerForPhoneStateChanged(this, PHONE_STATE_CHANGED, null);
102         mPhone.registerForDisconnect(this, PHONE_DISCONNECT, null);
103         mPhone.registerForUnknownConnection(this, PHONE_UNKNOWN_CONNECTION_APPEARED, null);
104         mPhone.registerForIncomingRing(this, PHONE_INCOMING_RING, null);
105         mRinger = ringer;
106         mBluetoothHandsfree = btMgr;
107
108         TelephonyManager telephonyManager = (TelephonyManager)app.getSystemService(
109                 Context.TELEPHONY_SERVICE);
110         telephonyManager.listen(mPhoneStateListener,
111                 PhoneStateListener.LISTEN_MESSAGE_WAITING_INDICATOR
112                 | PhoneStateListener.LISTEN_CALL_FORWARDING_INDICATOR);
113     }
114
115     @Override
116     public void handleMessage(Message msg) {
117         switch (msg.what) {
118             case PHONE_NEW_RINGING_CONNECTION:
119                 if (DBG) log("RINGING... (new)");
120                 onNewRingingConnection((AsyncResult) msg.obj);
121                 mSilentRingerRequested = false;
122                 break;
123
124             case PHONE_INCOMING_RING:
125                 // repeat the ring when requested by the RIL, and when the user has NOT
126                 // specifically requested silence.
127                 if (msg.obj != null && ((AsyncResult) msg.obj).result != null &&
128                         ((GSMPhone)((AsyncResult) msg.obj).result).getState() == Phone.State.RINGING
129                         && mSilentRingerRequested == false) {
130                     if (DBG) log("RINGING... ");
131                     mRinger.ring();
132                 } else {
133                     if (DBG) log("RING before NEW_RING, skipping");
134                 }
135                 break;
136
137             case PHONE_STATE_CHANGED:
138                 onPhoneStateChanged((AsyncResult) msg.obj);
139                 break;
140
141             case PHONE_DISCONNECT:
142                 if (DBG) log("DISCONNECT");
143                 onDisconnect((AsyncResult) msg.obj);
144                 break;
145
146             case PHONE_UNKNOWN_CONNECTION_APPEARED:
147                 onUnknownConnectionAppeared((AsyncResult) msg.obj);
148                 break;
149
150                 // timed out, go directly to playing the ringtone.
151             case RINGER_CUSTOM_RINGTONE_QUERY_COMPLETE:
152                 if (DBG) log("time out event detected for callerinfo query");
153                 onCustomRingQueryComplete();
154                 break;
155
156             case PHONE_MWI_CHANGED:
157                 onMwiChanged(mPhone.getMessageWaitingIndicator());
158                 break;
159
160             case PHONE_BATTERY_LOW:
161                 onBatteryLow();
162                 break;
163
164             default:
165                 // super.handleMessage(msg);
166         }
167     }
168
169     PhoneStateListener mPhoneStateListener = new PhoneStateListener() {
170         @Override
171         public void onMessageWaitingIndicatorChanged(boolean mwi) {
172             onMwiChanged(mwi);
173         }
174
175         @Override
176         public void onCallForwardingIndicatorChanged(boolean cfi) {
177             onCfiChanged(cfi);
178         }
179     };
180
181     private void onNewRingingConnection(AsyncResult r) {
182         Connection c = (Connection) r.result;
183         if (DBG) log("onNewRingingConnection()... connection: " + c);
184         PhoneApp app = PhoneApp.getInstance();
185
186         // Incoming calls are totally ignored if the device isn't provisioned yet
187         boolean provisioned = Settings.Secure.getInt(mPhone.getContext().getContentResolver(),
188             Settings.Secure.DEVICE_PROVISIONED, 0) != 0;
189         if (!provisioned) {
190             Log.i(TAG, "CallNotifier: rejecting incoming call because device isn't provisioned");
191             // Send the caller straight to voicemail, just like
192             // "rejecting" an incoming call.
193             PhoneUtils.hangupRingingCall(mPhone);
194             return;
195         }
196
197         if (c != null && c.isRinging()) {
198             Call.State state = c.getState();
199             // State will be either INCOMING or WAITING.
200             if (DBG) log("- connection is ringing!  state = " + state);
201             // if (DBG) PhoneUtils.dumpCallState(mPhone);
202
203             // No need to do any service state checks here (like for
204             // "emergency mode"), since in those states the SIM won't let
205             // us get incoming connections in the first place.
206
207             // TODO: Consider sending out a serialized broadcast Intent here
208             // (maybe "ACTION_NEW_INCOMING_CALL"), *before* starting the
209             // ringer and going to the in-call UI.  The intent should contain
210             // the caller-id info for the current connection, and say whether
211             // it would be a "call waiting" call or a regular ringing call.
212             // If anybody consumed the broadcast, we'd bail out without
213             // ringing or bringing up the in-call UI.
214             //
215             // This would give 3rd party apps a chance to listen for (and
216             // intercept) new ringing connections.  An app could reject the
217             // incoming call by consuming the broadcast and doing nothing, or
218             // it could "pick up" the call (without any action by the user!)
219             // by firing off an ACTION_ANSWER intent.
220             //
221             // We'd need to protect this with a new "intercept incoming calls"
222             // system permission.
223
224             // - don't ring for call waiting connections
225             // - do this before showing the incoming call panel
226             if (state == Call.State.INCOMING) {
227                 PhoneUtils.setAudioControlState(PhoneUtils.AUDIO_RINGING);
228                 startIncomingCallQuery(c);
229             } else {
230                 if (DBG) log("- starting call waiting tone...");
231                 new InCallTonePlayer(InCallTonePlayer.TONE_CALL_WAITING).start();
232                 // The InCallTonePlayer will automatically stop playing (and
233                 // clean itself up) after playing the tone.
234
235                 // TODO: alternatively, consider starting an
236                 // InCallTonePlayer with an "unlimited" tone length, and
237                 // manually stop it later when the ringing call either (a)
238                 // gets answered, or (b) gets disconnected.
239
240                 // in this case, just fall through like before, and call
241                 // PhoneUtils.showIncomingCallUi
242                 PhoneUtils.showIncomingCallUi();
243             }
244         }
245
246         // Obtain the wake lock. Since the keepScreenOn() call tracks the state
247         // of the wake lock, it is ok to make the call here as well as in
248         // InCallScreen.onPhoneStateChanged().
249         if (DBG) log("Holding wake lock on new incoming connection.");
250         mApplication.requestWakeState(PhoneApp.WakeState.PARTIAL);
251
252         if (DBG) log("- onNewRingingConnection() done.");
253     }
254
255     /**
256      * Helper method to manage the start of incoming call queries
257      */
258     private void startIncomingCallQuery(Connection c) {
259         // TODO: cache the custom ringer object so that subsequent
260         // calls will not need to do this query work.  We can keep
261         // the MRU ringtones in memory.  We'll still need to hit
262         // the database to get the callerinfo to act as a key,
263         // but at least we can save the time required for the
264         // Media player setup.  The only issue with this is that
265         // we may need to keep an eye on the resources the Media
266         // player uses to keep these ringtones around.
267
268         // make sure we're in a state where we can be ready to
269         // query a ringtone uri.
270         boolean shouldStartQuery = false;
271         synchronized (mCallerInfoQueryStateGuard) {
272             if (mCallerInfoQueryState == CALLERINFO_QUERY_READY) {
273                 mCallerInfoQueryState = CALLERINFO_QUERYING;
274                 shouldStartQuery = true;
275             }
276         }
277         if (shouldStartQuery) {
278             // create a custom ringer using the default ringer first
279             mRinger.setCustomRingtoneUri(Settings.System.DEFAULT_RINGTONE_URI);
280
281             // query the callerinfo to try to get the ringer.
282             PhoneUtils.CallerInfoToken cit = PhoneUtils.startGetCallerInfo(
283                     mPhone.getContext(), c, this, this);
284
285             // if this has already been queried then just ring, otherwise
286             // we wait for the alloted time before ringing.
287             if (cit.isFinal) {
288                 if (DBG) log("callerinfo already up to date, using available data");
289                 onQueryComplete(0, this, cit.currentInfo);
290             } else {
291                 if (DBG) log("starting query and setting timeout message.");
292                 sendEmptyMessageDelayed(RINGER_CUSTOM_RINGTONE_QUERY_COMPLETE,
293                         RINGTONE_QUERY_WAIT_TIME);
294             }
295             // calls to PhoneUtils.showIncomingCallUi will come after the
296             // queries are complete (or timeout).
297         } else {
298             // This should never happen; its the case where an incoming call
299             // arrives at the same time that the query is still being run,
300             // and before the timeout window has closed.
301             Checkin.logEvent(mPhone.getContext().getContentResolver(),
302                     Checkin.Events.Tag.PHONE_UI,
303                     PHONE_UI_EVENT_MULTIPLE_QUERY);
304
305             // In this case, just log the request and ring.
306             if (DBG) log("request to ring arrived while query is running.");
307             mRinger.ring();
308
309             // in this case, just fall through like before, and call
310             // PhoneUtils.showIncomingCallUi
311             PhoneUtils.showIncomingCallUi();
312         }
313     }
314
315     /**
316      * Continuation of the onNewRingingConnection method call,
317      * encompassing ringing and any successive actions.
318      */
319     private void onCustomRingQueryComplete() {
320         boolean isQueryExecutionTimeExpired = false;
321         synchronized (mCallerInfoQueryStateGuard) {
322             if (mCallerInfoQueryState == CALLERINFO_QUERYING) {
323                 mCallerInfoQueryState = CALLERINFO_QUERY_READY;
324                 isQueryExecutionTimeExpired = true;
325             }
326         }
327         if (isQueryExecutionTimeExpired) {
328             // There may be a problem with the query here, since the
329             // default ringtone is playing instead of the custom one.
330             Checkin.logEvent(mPhone.getContext().getContentResolver(),
331                     Checkin.Events.Tag.PHONE_UI,
332                     PHONE_UI_EVENT_RINGER_QUERY_ELAPSED);
333         }
334
335         // ring, either with the queried ringtone or default one.
336         mRinger.ring();
337
338         // now display the UI.
339         PhoneUtils.showIncomingCallUi();
340     }
341
342     private void onUnknownConnectionAppeared(AsyncResult r) {
343         Phone.State state = mPhone.getState();
344
345         if (state == Phone.State.OFFHOOK) {
346             // basically do onPhoneStateChanged + displayCallScreen
347             onPhoneStateChanged(r);
348             PhoneApp app = PhoneApp.getInstance();
349             app.displayCallScreen();
350         }
351     }
352
353     private void onPhoneStateChanged(AsyncResult r) {
354         Phone.State state = mPhone.getState();
355
356         // Turn status bar notifications on or off depending upon the state
357         // of the phone.  Notification Alerts (audible or vibrating) should
358         // be on if and only if the phone is IDLE.
359         NotificationMgr.getDefault().getStatusBarMgr()
360                 .enableNotificationAlerts(state == Phone.State.IDLE);
361
362         if (state == Phone.State.OFFHOOK) {
363             PhoneUtils.setAudioControlState(PhoneUtils.AUDIO_OFFHOOK);
364             if (DBG) log("onPhoneStateChanged: OFF HOOK");
365
366             // if the call screen is showing, let it handle the event,
367             // otherwise handle it here.
368             if (!mApplication.isShowingCallScreen()) {
369                 mApplication.setScreenTimeout(PhoneApp.ScreenTimeoutDuration.DEFAULT);
370                 mApplication.requestWakeState(PhoneApp.WakeState.SLEEP);
371             }
372
373             // Since we're now in-call, the Ringer should definitely *not*
374             // be ringing any more.  (This is just a sanity-check; we
375             // already stopped the ringer explicitly back in
376             // PhoneUtils.answerCall(), before the call to phone.acceptCall().)
377             // TODO: Confirm that this call really *is* unnecessary, and if so,
378             // remove it!
379             mRinger.stopRing();
380
381             // put a icon in the status bar
382             NotificationMgr.getDefault().updateInCallNotification();
383         }
384     }
385
386     /**
387      * Implemented for CallerInfoAsyncQuery.OnQueryCompleteListener interface.
388      * refreshes the CallCard data when it called.  If called with this
389      * class itself, it is assumed that we have been waiting for the ringtone
390      * and direct to voicemail settings to update.
391      */
392     public void onQueryComplete(int token, Object cookie, CallerInfo ci){
393         if (cookie instanceof Long) {
394             if (DBG) log("callerinfo query complete, posting missed call notification");
395
396             NotificationMgr.getDefault().notifyMissedCall(ci.name, ci.phoneNumber,
397                     ci.phoneLabel, ((Long) cookie).longValue());
398         } else if (cookie instanceof CallNotifier){
399             if (DBG) log("callerinfo query complete, updating data");
400
401             // get rid of the timeout messages
402             removeMessages(RINGER_CUSTOM_RINGTONE_QUERY_COMPLETE);
403
404             boolean isQueryExecutionTimeOK = false;
405             synchronized (mCallerInfoQueryStateGuard) {
406                 if (mCallerInfoQueryState == CALLERINFO_QUERYING) {
407                     mCallerInfoQueryState = CALLERINFO_QUERY_READY;
408                     isQueryExecutionTimeOK = true;
409                 }
410             }
411             //if we're in the right state
412             if (isQueryExecutionTimeOK) {
413
414                 // send directly to voicemail.
415                 if (ci.shouldSendToVoicemail) {
416                     if (DBG) log("send to voicemail flag detected. hanging up.");
417                     PhoneUtils.hangupRingingCall(mPhone);
418                     return;
419                 }
420
421                 // set the ringtone uri to prepare for the ring.
422                 if (ci.contactRingtoneUri != null) {
423                     if (DBG) log("custom ringtone found, setting up ringer.");
424                     Ringer r = ((CallNotifier) cookie).mRinger;
425                     r.setCustomRingtoneUri(ci.contactRingtoneUri);
426                 }
427                 // ring, and other post-ring actions.
428                 onCustomRingQueryComplete();
429             }
430         }
431     }
432
433     private void onDisconnect(AsyncResult r) {
434         if (DBG) log("onDisconnect()...  phone state: " + mPhone.getState());
435         if (mPhone.getState() == Phone.State.IDLE) {
436             PhoneUtils.setAudioControlState(PhoneUtils.AUDIO_IDLE);
437         }
438
439         Connection c = (Connection) r.result;
440         if (DBG && c != null) {
441             log("- cause = " + c.getDisconnectCause()
442                 + ", incoming = " + c.isIncoming()
443                 + ", date = " + c.getCreateTime());
444         }
445
446         // Stop the ringer if it was ringing (for an incoming call that
447         // either disconnected by itself, or was rejected by the user.)
448         //
449         // TODO: We technically *shouldn't* stop the ringer if the
450         // foreground or background call disconnects while an incoming call
451         // is still ringing, but that's a really rare corner case.
452         // It's safest to just unconditionally stop the ringer here.
453         mRinger.stopRing();
454
455         // Check for the various tones we might need to play (thru the
456         // earpiece) after a call disconnects.
457         int toneToPlay = InCallTonePlayer.TONE_NONE;
458
459         // The "Busy" or "Congestion" tone is the highest priority:
460         if (c != null) {
461             Connection.DisconnectCause cause = c.getDisconnectCause();
462             if (cause == Connection.DisconnectCause.BUSY) {
463                 if (DBG) log("- need to play BUSY tone!");
464                 toneToPlay = InCallTonePlayer.TONE_BUSY;
465             } else if (cause == Connection.DisconnectCause.CONGESTION) {
466                 if (DBG) log("- need to play CONGESTION tone!");
467                 toneToPlay = InCallTonePlayer.TONE_CONGESTION;
468             }
469         }
470
471         // If we don't need to play BUSY or CONGESTION, then play the
472         // "call ended" tone if this was a "regular disconnect" (i.e. a
473         // normal call where one end or the other hung up) *and* this
474         // disconnect event caused the phone to become idle.  (In other
475         // words, we *don't* play the sound if one call hangs up but
476         // there's still an active call on the other line.)
477         // TODO: We may eventually want to disable this via a preference.
478         if ((toneToPlay == InCallTonePlayer.TONE_NONE)
479             && (mPhone.getState() == Phone.State.IDLE)
480             && (c != null)) {
481             Connection.DisconnectCause cause = c.getDisconnectCause();
482             if ((cause == Connection.DisconnectCause.NORMAL)  // remote hangup
483                 || (cause == Connection.DisconnectCause.LOCAL)) {  // local hangup
484                 if (DBG) log("- need to play CALL_ENDED tone!");
485                 toneToPlay = InCallTonePlayer.TONE_CALL_ENDED;
486             }
487         }
488
489         if (mPhone.getState() == Phone.State.IDLE) {
490             // Don't reset the audio mode or bluetooth/speakerphone state
491             // if we still need to let the user hear a tone through the earpiece.
492             if (toneToPlay == InCallTonePlayer.TONE_NONE) {
493                 resetAudioStateAfterDisconnect();
494             }
495
496             NotificationMgr.getDefault().cancelCallInProgressNotification();
497
498             // if the call screen never called finish (it's still in activity
499             // history, call finish() on it so it can be removed from the
500             // activity history
501             if (mCallScreen != null) {
502                 if (DBG) log("onDisconnect: force mCallScreen.finish()");
503                 mCallScreen.finish();
504             }
505         }
506
507         if (c != null) {
508             String number = c.getAddress();
509             boolean isPrivateNumber = false; // TODO: need API for isPrivate()
510             long date = c.getCreateTime();
511             long duration = c.getDurationMillis();
512             Connection.DisconnectCause cause = c.getDisconnectCause();
513
514             // Set the "type" to be displayed in the call log (see constants in CallLog.Calls)
515             int callLogType;
516             if (c.isIncoming()) {
517                 callLogType = (cause == Connection.DisconnectCause.INCOMING_MISSED ?
518                                CallLog.Calls.MISSED_TYPE :
519                                CallLog.Calls.INCOMING_TYPE);
520             } else {
521                 callLogType = CallLog.Calls.OUTGOING_TYPE;
522             }
523             if (DBG) log("- callLogType: " + callLogType + ", UserData: " + c.getUserData());
524
525             // get the callerinfo object and then log the call with it.
526             {
527                 Object o = c.getUserData();
528                 CallerInfo ci;
529                 if ((o == null) || (o instanceof CallerInfo)){
530                     ci = (CallerInfo) o;
531                 } else {
532                     ci = ((PhoneUtils.CallerInfoToken) o).currentInfo;
533                 }
534                 Calls.addCall(ci, mApplication, number, isPrivateNumber,
535                         callLogType, date, (int) duration / 1000);
536             }
537
538             if (callLogType == CallLog.Calls.MISSED_TYPE) {
539                 // Show the "Missed call" notification.
540                 // (Note we *don't* do this if this was an incoming call that
541                 // the user deliberately rejected.)
542
543                 PhoneUtils.CallerInfoToken info =
544                     PhoneUtils.startGetCallerInfo(mApplication, c, this, new Long(date));
545                 if (info != null) {
546                     // at this point, we've requested to start a query, but it makes no
547                     // sense to log this missed call until the query comes back.
548                     if (DBG) log("onDisconnect: Querying for CallerInfo on missed call...");
549                     if (info.isFinal) {
550                         // it seems that the query we have actually is up to date.
551                         // send the notification then.
552                         CallerInfo ci = info.currentInfo;
553                         NotificationMgr.getDefault().notifyMissedCall(ci.name, ci.phoneNumber,
554                                 ci.phoneLabel, date);
555                     }
556                 } else {
557                     // getCallerInfo() can return null in rare cases, like if we weren't
558                     // able to get a valid phone number out of the specified Connection.
559                     Log.w(TAG, "onDisconnect: got null CallerInfo for Connection " + c);
560                 }
561             }
562
563             // Possibly play a "post-disconnect tone" thru the earpiece.
564             // We do this here, rather than from the InCallScreen
565             // activity, since we need to do this even if you're not in
566             // the Phone UI at the moment the connection ends.
567             if (toneToPlay != InCallTonePlayer.TONE_NONE) {
568                 if (DBG) log("- starting post-disconnect tone (" + toneToPlay + ")...");
569                 new InCallTonePlayer(toneToPlay).start();
570                 // The InCallTonePlayer will automatically stop playing (and
571                 // clean itself up) after a few seconds.
572
573                 // TODO: alternatively, we could start an InCallTonePlayer
574                 // here with an "unlimited" tone length,
575                 // and manually stop it later when this connection truly goes
576                 // away.  (The real connection over the network was closed as soon
577                 // as we got the BUSY message.  But our telephony layer keeps the
578                 // connection open for a few extra seconds so we can show the
579                 // "busy" indication to the user.  We could stop the busy tone
580                 // when *that* connection's "disconnect" event comes in.)
581             }
582
583             if (mPhone.getState() == Phone.State.IDLE) {
584                 // Release screen wake locks if the in-call screen is not
585                 // showing. Otherwise, let the in-call screen handle this because
586                 // it needs to show the call ended screen for a couple of
587                 // seconds.
588                 if (!mApplication.isShowingCallScreen()) {
589                     if (DBG) log("- NOT showing in-call screen; releasing wake locks!");
590                     mApplication.setScreenTimeout(PhoneApp.ScreenTimeoutDuration.DEFAULT);
591                     mApplication.requestWakeState(PhoneApp.WakeState.SLEEP);
592                 } else {
593                     if (DBG) log("- still showing in-call screen; not releasing wake locks.");
594                 }
595             } else {
596                 if (DBG) log("- phone still in use; not releasing wake locks.");
597             }
598         }
599     }
600
601     /**
602      * Resets the audio mode and speaker state when a call ends.
603      */
604     private void resetAudioStateAfterDisconnect() {
605         if (DBG) log("resetAudioStateAfterDisconnect()...");
606
607         if (mBluetoothHandsfree != null) {
608             mBluetoothHandsfree.audioOff();
609         }
610
611         if (PhoneUtils.isSpeakerOn(mPhone.getContext())) {
612             PhoneUtils.turnOnSpeaker(mPhone.getContext(), false);
613         }
614
615         PhoneUtils.setAudioMode(mPhone.getContext(), AudioManager.MODE_NORMAL);
616     }
617
618     private void onMwiChanged(boolean visible) {
619         if (DBG) log("onMwiChanged(): " + visible);
620         NotificationMgr.getDefault().updateMwi(visible);
621     }
622
623     /**
624      * Posts a delayed PHONE_MWI_CHANGED event, to schedule a "retry" for a
625      * failed NotificationMgr.updateMwi() call.
626      */
627     /* package */ void sendMwiChangedDelayed(long delayMillis) {
628         Message message = Message.obtain(this, PHONE_MWI_CHANGED);
629         sendMessageDelayed(message, delayMillis);
630     }
631
632     private void onCfiChanged(boolean visible) {
633         if (DBG) log("onCfiChanged(): " + visible);
634         NotificationMgr.getDefault().updateCfi(visible);
635     }
636
637     void setCallScreen(InCallScreen callScreen) {
638         if (DBG) log("setCallScreen: " + callScreen);
639         mCallScreen = callScreen;
640     }
641
642     /**
643      * Indicates whether or not this ringer is ringing.
644      */
645     boolean isRinging() {
646         return mRinger.isRinging();
647     }
648
649     /**
650      * Stops the current ring, and tells the notifier that future
651      * ring requests should be ignored.
652      */
653     void silenceRinger() {
654         mSilentRingerRequested = true;
655         mRinger.stopRing();
656     }
657
658     /**
659      * Posts a PHONE_BATTERY_LOW event, causing us to play a warning
660      * tone if the user is in-call.
661      */
662     /* package */ void sendBatteryLow() {
663         Message message = Message.obtain(this, PHONE_BATTERY_LOW);
664         sendMessage(message);
665     }
666
667     private void onBatteryLow() {
668         if (DBG) log("onBatteryLow()...");
669
670         // Play the "low battery" warning tone, only if the user is
671         // in-call.  (The test here is exactly the opposite of the test in
672         // StatusBarPolicy.updateBattery(), where we bring up the "low
673         // battery warning" dialog only if the user is NOT in-call.)
674         if (mPhone.getState() != Phone.State.IDLE) {
675             new InCallTonePlayer(InCallTonePlayer.TONE_BATTERY_LOW).start();
676         }
677     }
678
679
680     /**
681      * Helper class to play tones through the earpiece (or speaker / BT)
682      * during a call, using the ToneGenerator.
683      *
684      * To use, just instantiate a new InCallTonePlayer
685      * (passing in the TONE_* constant for the tone you want)
686      * and start() it.
687      *
688      * When we're done playing the tone, if the phone is idle at that
689      * point, we'll reset the audio routing and speaker state.
690      * (That means that for tones that get played *after* a call
691      * disconnects, like "busy" or "congestion" or "call ended", you
692      * should NOT call resetAudioStateAfterDisconnect() yourself.
693      * Instead, just start the InCallTonePlayer, which will automatically
694      * defer the resetAudioStateAfterDisconnect() call until the tone
695      * finishes playing.)
696      */
697     private class InCallTonePlayer extends Thread {
698         private int mToneId;
699
700         // The possible tones we can play.
701         public static final int TONE_NONE = 0;
702         public static final int TONE_CALL_WAITING = 1;
703         public static final int TONE_BUSY = 2;
704         public static final int TONE_CONGESTION = 3;
705         public static final int TONE_BATTERY_LOW = 4;
706         public static final int TONE_CALL_ENDED = 5;
707
708         // The tone volume relative to other sounds in the stream
709         private static final int TONE_RELATIVE_VOLUME_HIPRI = 80;
710         private static final int TONE_RELATIVE_VOLUME_LOPRI = 50;
711
712         InCallTonePlayer(int toneId) {
713             super();
714             mToneId = toneId;
715         }
716
717         @Override
718         public void run() {
719             if (DBG) log("InCallTonePlayer.run(toneId = " + mToneId + ")...");
720
721             int toneType;  // passed to ToneGenerator.startTone()
722             int toneVolume;  // passed to the ToneGenerator constructor
723             int toneLengthMillis;
724             switch (mToneId) {
725                 case TONE_CALL_WAITING:
726                     toneType = ToneGenerator.TONE_SUP_CALL_WAITING;
727                     toneVolume = TONE_RELATIVE_VOLUME_HIPRI;
728                     toneLengthMillis = 5000;
729                     break;
730                 case TONE_BUSY:
731                     toneType = ToneGenerator.TONE_SUP_BUSY;
732                     toneVolume = TONE_RELATIVE_VOLUME_HIPRI;
733                     toneLengthMillis = 4000;
734                     break;
735                 case TONE_CONGESTION:
736                     toneType = ToneGenerator.TONE_SUP_CONGESTION;
737                     toneVolume = TONE_RELATIVE_VOLUME_HIPRI;
738                     toneLengthMillis = 4000;
739                     break;
740                 case TONE_BATTERY_LOW:
741                     // For now, use ToneGenerator.TONE_PROP_ACK (two quick
742                     // beeps).  TODO: is there some other ToneGenerator
743                     // tone that would be more appropriate here?  Or
744                     // should we consider adding a new custom tone?
745                     toneType = ToneGenerator.TONE_PROP_ACK;
746                     toneVolume = TONE_RELATIVE_VOLUME_HIPRI;
747                     toneLengthMillis = 1000;
748                     break;
749                 case TONE_CALL_ENDED:
750                     toneType = ToneGenerator.TONE_PROP_PROMPT;
751                     toneVolume = TONE_RELATIVE_VOLUME_LOPRI;
752                     toneLengthMillis = 2000;
753                     break;
754                 default:
755                     throw new IllegalArgumentException("Bad toneId: " + mToneId);
756             }
757
758             // If the mToneGenerator creation fails, just continue without it.  It is
759             // a local audio signal, and is not as important.
760             ToneGenerator toneGenerator;
761             try {
762                 int stream;
763                 if (mBluetoothHandsfree != null) {
764                     stream = mBluetoothHandsfree.isAudioOn() ? AudioManager.STREAM_BLUETOOTH_SCO:
765                         AudioManager.STREAM_VOICE_CALL;
766                 } else {
767                     stream = AudioManager.STREAM_VOICE_CALL;
768                 }
769                 toneGenerator = new ToneGenerator(stream, toneVolume);
770                 // if (DBG) log("- created toneGenerator: " + toneGenerator);
771             } catch (RuntimeException e) {
772                 Log.w(TAG, "InCallTonePlayer: Exception caught while creating ToneGenerator: " + e);
773                 toneGenerator = null;
774             }
775
776             // Using the ToneGenerator (with the CALL_WAITING / BUSY /
777             // CONGESTION tones at least), the ToneGenerator itself knows
778             // the right pattern of tones to play; we do NOT need to
779             // manually start/stop each individual tone, or manually
780             // insert the correct delay between tones.  (We just start it
781             // and let it run for however long we want the tone pattern to
782             // continue.)
783             //
784             // TODO: When we stop the ToneGenerator in the middle of a
785             // "tone pattern", it sounds bad if we cut if off while the
786             // tone is actually playing.  Consider adding API to the
787             // ToneGenerator to say "stop at the next silent part of the
788             // pattern", or simply "play the pattern N times and then
789             // stop."
790
791             if (toneGenerator != null) {
792                 toneGenerator.startTone(toneType);
793                 SystemClock.sleep(toneLengthMillis);
794                 toneGenerator.stopTone();
795
796                 // if (DBG) log("- InCallTonePlayer: done playing.");
797                 toneGenerator.release();
798             }
799
800             // Finally, do the same cleanup we otherwise would have done
801             // in onDisconnect().
802             //
803             // (But watch out: do NOT do this if the phone is in use,
804             // since some of our tones get played *during* a call (like
805             // CALL_WAITING and BATTERY_LOW) and we definitely *don't*
806             // want to reset the audio mode / speaker / bluetooth after
807             // playing those!
808             // This call is really here for use with tones that get played
809             // *after* a call disconnects, like "busy" or "congestion" or
810             // "call ended", where the phone has already become idle but
811             // we need to defer the resetAudioStateAfterDisconnect() call
812             // till the tone finishes playing.)
813             if (mPhone.getState() == Phone.State.IDLE) {
814                 resetAudioStateAfterDisconnect();
815             }
816         }
817     }
818
819
820     private void log(String msg) {
821         Log.d(TAG, "[CallNotifier] " + msg);
822     }
823 }