Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2013 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 | |
Tyler Gunn | ef9f6f9 | 2014-09-12 22:16:17 -0700 | [diff] [blame] | 17 | package android.telecom; |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 18 | |
Gabriel Peal | b95f169 | 2014-08-19 14:24:18 -0700 | [diff] [blame] | 19 | import android.annotation.SystemApi; |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 20 | import android.util.ArrayMap; |
| 21 | |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 22 | import java.util.Collections; |
| 23 | import java.util.List; |
| 24 | import java.util.Map; |
| 25 | import java.util.Objects; |
Jay Shrauner | 229e382 | 2014-08-15 09:23:07 -0700 | [diff] [blame] | 26 | import java.util.concurrent.CopyOnWriteArrayList; |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 27 | |
| 28 | /** |
| 29 | * A unified virtual device providing a means of voice (and other) communication on a device. |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 30 | * |
| 31 | * {@hide} |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 32 | */ |
Gabriel Peal | b95f169 | 2014-08-19 14:24:18 -0700 | [diff] [blame] | 33 | @SystemApi |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 34 | public final class Phone { |
| 35 | |
| 36 | public abstract static class Listener { |
| 37 | /** |
| 38 | * Called when the audio state changes. |
| 39 | * |
| 40 | * @param phone The {@code Phone} calling this method. |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 41 | * @param audioState The new {@link AudioState}. |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 42 | */ |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 43 | public void onAudioStateChanged(Phone phone, AudioState audioState) { } |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 44 | |
| 45 | /** |
| 46 | * Called to bring the in-call screen to the foreground. The in-call experience should |
| 47 | * respond immediately by coming to the foreground to inform the user of the state of |
| 48 | * ongoing {@code Call}s. |
| 49 | * |
| 50 | * @param phone The {@code Phone} calling this method. |
| 51 | * @param showDialpad If true, put up the dialpad when the screen is shown. |
| 52 | */ |
| 53 | public void onBringToForeground(Phone phone, boolean showDialpad) { } |
| 54 | |
| 55 | /** |
| 56 | * Called when a {@code Call} has been added to this in-call session. The in-call user |
| 57 | * experience should add necessary state listeners to the specified {@code Call} and |
| 58 | * immediately start to show the user information about the existence |
| 59 | * and nature of this {@code Call}. Subsequent invocations of {@link #getCalls()} will |
| 60 | * include this {@code Call}. |
| 61 | * |
| 62 | * @param phone The {@code Phone} calling this method. |
| 63 | * @param call A newly added {@code Call}. |
| 64 | */ |
| 65 | public void onCallAdded(Phone phone, Call call) { } |
| 66 | |
| 67 | /** |
| 68 | * Called when a {@code Call} has been removed from this in-call session. The in-call user |
| 69 | * experience should remove any state listeners from the specified {@code Call} and |
| 70 | * immediately stop displaying any information about this {@code Call}. |
| 71 | * Subsequent invocations of {@link #getCalls()} will no longer include this {@code Call}. |
| 72 | * |
| 73 | * @param phone The {@code Phone} calling this method. |
| 74 | * @param call A newly removed {@code Call}. |
| 75 | */ |
| 76 | public void onCallRemoved(Phone phone, Call call) { } |
Santos Cordon | 6c912b7 | 2014-11-07 16:05:09 -0800 | [diff] [blame] | 77 | |
| 78 | /** |
| 79 | * Called when the {@code Phone} ability to add more calls changes. If the phone cannot |
| 80 | * support more calls then {@code canAddCall} is set to {@code false}. If it can, then it |
| 81 | * is set to {@code true}. |
| 82 | * |
| 83 | * @param phone The {@code Phone} calling this method. |
| 84 | * @param canAddCall Indicates whether an additional call can be added. |
| 85 | */ |
| 86 | public void onCanAddCallChanged(Phone phone, boolean canAddCall) { } |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 87 | } |
| 88 | |
Tyler Gunn | ef9f6f9 | 2014-09-12 22:16:17 -0700 | [diff] [blame] | 89 | // A Map allows us to track each Call by its Telecom-specified call ID |
| 90 | private final Map<String, Call> mCallByTelecomCallId = new ArrayMap<>(); |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 91 | |
| 92 | // A List allows us to keep the Calls in a stable iteration order so that casually developed |
| 93 | // user interface components do not incur any spurious jank |
Santos Cordon | f30d7e9 | 2014-08-26 09:54:33 -0700 | [diff] [blame] | 94 | private final List<Call> mCalls = new CopyOnWriteArrayList<>(); |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 95 | |
| 96 | // An unmodifiable view of the above List can be safely shared with subclass implementations |
| 97 | private final List<Call> mUnmodifiableCalls = Collections.unmodifiableList(mCalls); |
| 98 | |
| 99 | private final InCallAdapter mInCallAdapter; |
| 100 | |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 101 | private AudioState mAudioState; |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 102 | |
Jay Shrauner | 229e382 | 2014-08-15 09:23:07 -0700 | [diff] [blame] | 103 | private final List<Listener> mListeners = new CopyOnWriteArrayList<>(); |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 104 | |
Santos Cordon | 6c912b7 | 2014-11-07 16:05:09 -0800 | [diff] [blame] | 105 | private boolean mCanAddCall = true; |
| 106 | |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 107 | /** {@hide} */ |
| 108 | Phone(InCallAdapter adapter) { |
| 109 | mInCallAdapter = adapter; |
| 110 | } |
| 111 | |
| 112 | /** {@hide} */ |
Santos Cordon | 88b771d | 2014-07-19 13:10:40 -0700 | [diff] [blame] | 113 | final void internalAddCall(ParcelableCall parcelableCall) { |
| 114 | Call call = new Call(this, parcelableCall.getId(), mInCallAdapter); |
Tyler Gunn | ef9f6f9 | 2014-09-12 22:16:17 -0700 | [diff] [blame] | 115 | mCallByTelecomCallId.put(parcelableCall.getId(), call); |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 116 | mCalls.add(call); |
Santos Cordon | 88b771d | 2014-07-19 13:10:40 -0700 | [diff] [blame] | 117 | checkCallTree(parcelableCall); |
Tyler Gunn | ef9f6f9 | 2014-09-12 22:16:17 -0700 | [diff] [blame] | 118 | call.internalUpdate(parcelableCall, mCallByTelecomCallId); |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 119 | fireCallAdded(call); |
| 120 | } |
| 121 | |
| 122 | /** {@hide} */ |
| 123 | final void internalRemoveCall(Call call) { |
Tyler Gunn | ef9f6f9 | 2014-09-12 22:16:17 -0700 | [diff] [blame] | 124 | mCallByTelecomCallId.remove(call.internalGetCallId()); |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 125 | mCalls.remove(call); |
| 126 | fireCallRemoved(call); |
| 127 | } |
| 128 | |
| 129 | /** {@hide} */ |
Santos Cordon | 88b771d | 2014-07-19 13:10:40 -0700 | [diff] [blame] | 130 | final void internalUpdateCall(ParcelableCall parcelableCall) { |
Tyler Gunn | ef9f6f9 | 2014-09-12 22:16:17 -0700 | [diff] [blame] | 131 | Call call = mCallByTelecomCallId.get(parcelableCall.getId()); |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 132 | if (call != null) { |
Santos Cordon | 88b771d | 2014-07-19 13:10:40 -0700 | [diff] [blame] | 133 | checkCallTree(parcelableCall); |
Tyler Gunn | ef9f6f9 | 2014-09-12 22:16:17 -0700 | [diff] [blame] | 134 | call.internalUpdate(parcelableCall, mCallByTelecomCallId); |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 135 | } |
| 136 | } |
| 137 | |
| 138 | /** {@hide} */ |
Tyler Gunn | ef9f6f9 | 2014-09-12 22:16:17 -0700 | [diff] [blame] | 139 | final void internalSetPostDialWait(String telecomId, String remaining) { |
| 140 | Call call = mCallByTelecomCallId.get(telecomId); |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 141 | if (call != null) { |
| 142 | call.internalSetPostDialWait(remaining); |
| 143 | } |
| 144 | } |
| 145 | |
| 146 | /** {@hide} */ |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 147 | final void internalAudioStateChanged(AudioState audioState) { |
| 148 | if (!Objects.equals(mAudioState, audioState)) { |
| 149 | mAudioState = audioState; |
| 150 | fireAudioStateChanged(audioState); |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 151 | } |
| 152 | } |
| 153 | |
| 154 | /** {@hide} */ |
Tyler Gunn | ef9f6f9 | 2014-09-12 22:16:17 -0700 | [diff] [blame] | 155 | final Call internalGetCallByTelecomId(String telecomId) { |
| 156 | return mCallByTelecomCallId.get(telecomId); |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 157 | } |
| 158 | |
| 159 | /** {@hide} */ |
| 160 | final void internalBringToForeground(boolean showDialpad) { |
| 161 | fireBringToForeground(showDialpad); |
| 162 | } |
| 163 | |
Santos Cordon | 6c912b7 | 2014-11-07 16:05:09 -0800 | [diff] [blame] | 164 | /** {@hide} */ |
| 165 | final void internalSetCanAddCall(boolean canAddCall) { |
| 166 | if (mCanAddCall != canAddCall) { |
| 167 | mCanAddCall = canAddCall; |
| 168 | fireCanAddCallChanged(canAddCall); |
| 169 | } |
| 170 | } |
| 171 | |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 172 | /** |
Santos Cordon | f30d7e9 | 2014-08-26 09:54:33 -0700 | [diff] [blame] | 173 | * Called to destroy the phone and cleanup any lingering calls. |
| 174 | * @hide |
| 175 | */ |
| 176 | final void destroy() { |
| 177 | for (Call call : mCalls) { |
| 178 | if (call.getState() != Call.STATE_DISCONNECTED) { |
| 179 | call.internalSetDisconnected(); |
| 180 | } |
| 181 | } |
| 182 | } |
| 183 | |
| 184 | /** |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 185 | * Adds a listener to this {@code Phone}. |
| 186 | * |
| 187 | * @param listener A {@code Listener} object. |
| 188 | */ |
| 189 | public final void addListener(Listener listener) { |
| 190 | mListeners.add(listener); |
| 191 | } |
| 192 | |
| 193 | /** |
| 194 | * Removes a listener from this {@code Phone}. |
| 195 | * |
| 196 | * @param listener A {@code Listener} object. |
| 197 | */ |
| 198 | public final void removeListener(Listener listener) { |
Jay Shrauner | 229e382 | 2014-08-15 09:23:07 -0700 | [diff] [blame] | 199 | if (listener != null) { |
| 200 | mListeners.remove(listener); |
| 201 | } |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 202 | } |
| 203 | |
| 204 | /** |
| 205 | * Obtains the current list of {@code Call}s to be displayed by this in-call experience. |
| 206 | * |
| 207 | * @return A list of the relevant {@code Call}s. |
| 208 | */ |
| 209 | public final List<Call> getCalls() { |
| 210 | return mUnmodifiableCalls; |
| 211 | } |
| 212 | |
| 213 | /** |
Santos Cordon | 6c912b7 | 2014-11-07 16:05:09 -0800 | [diff] [blame] | 214 | * Returns if the {@code Phone} can support additional calls. |
| 215 | * |
| 216 | * @return Whether the phone supports adding more calls. |
| 217 | */ |
| 218 | public final boolean canAddCall() { |
| 219 | return mCanAddCall; |
| 220 | } |
| 221 | |
| 222 | /** |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 223 | * Sets the microphone mute state. When this request is honored, there will be change to |
| 224 | * the {@link #getAudioState()}. |
| 225 | * |
| 226 | * @param state {@code true} if the microphone should be muted; {@code false} otherwise. |
| 227 | */ |
| 228 | public final void setMuted(boolean state) { |
| 229 | mInCallAdapter.mute(state); |
| 230 | } |
| 231 | |
| 232 | /** |
| 233 | * Sets the audio route (speaker, bluetooth, etc...). When this request is honored, there will |
| 234 | * be change to the {@link #getAudioState()}. |
| 235 | * |
| 236 | * @param route The audio route to use. |
| 237 | */ |
| 238 | public final void setAudioRoute(int route) { |
| 239 | mInCallAdapter.setAudioRoute(route); |
| 240 | } |
| 241 | |
| 242 | /** |
Yorke Lee | 0d6ea71 | 2014-07-28 14:39:23 -0700 | [diff] [blame] | 243 | * Turns the proximity sensor on. When this request is made, the proximity sensor will |
| 244 | * become active, and the touch screen and display will be turned off when the user's face |
| 245 | * is detected to be in close proximity to the screen. This operation is a no-op on devices |
| 246 | * that do not have a proximity sensor. |
Yorke Lee | 22244d0 | 2015-04-14 12:34:28 -0700 | [diff] [blame^] | 247 | * |
| 248 | * @hide |
Yorke Lee | 0d6ea71 | 2014-07-28 14:39:23 -0700 | [diff] [blame] | 249 | */ |
| 250 | public final void setProximitySensorOn() { |
| 251 | mInCallAdapter.turnProximitySensorOn(); |
| 252 | } |
| 253 | |
| 254 | /** |
| 255 | * Turns the proximity sensor off. When this request is made, the proximity sensor will |
| 256 | * become inactive, and no longer affect the touch screen and display. This operation is a |
| 257 | * no-op on devices that do not have a proximity sensor. |
| 258 | * |
| 259 | * @param screenOnImmediately If true, the screen will be turned on immediately if it was |
| 260 | * previously off. Otherwise, the screen will only be turned on after the proximity sensor |
| 261 | * is no longer triggered. |
Yorke Lee | 22244d0 | 2015-04-14 12:34:28 -0700 | [diff] [blame^] | 262 | * |
| 263 | * @hide |
Yorke Lee | 0d6ea71 | 2014-07-28 14:39:23 -0700 | [diff] [blame] | 264 | */ |
| 265 | public final void setProximitySensorOff(boolean screenOnImmediately) { |
| 266 | mInCallAdapter.turnProximitySensorOff(screenOnImmediately); |
| 267 | } |
| 268 | |
| 269 | /** |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 270 | * Obtains the current phone call audio state of the {@code Phone}. |
| 271 | * |
| 272 | * @return An object encapsulating the audio state. |
| 273 | */ |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 274 | public final AudioState getAudioState() { |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 275 | return mAudioState; |
| 276 | } |
| 277 | |
| 278 | private void fireCallAdded(Call call) { |
Jay Shrauner | 229e382 | 2014-08-15 09:23:07 -0700 | [diff] [blame] | 279 | for (Listener listener : mListeners) { |
| 280 | listener.onCallAdded(this, call); |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 281 | } |
| 282 | } |
| 283 | |
| 284 | private void fireCallRemoved(Call call) { |
Jay Shrauner | 229e382 | 2014-08-15 09:23:07 -0700 | [diff] [blame] | 285 | for (Listener listener : mListeners) { |
| 286 | listener.onCallRemoved(this, call); |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 287 | } |
| 288 | } |
| 289 | |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 290 | private void fireAudioStateChanged(AudioState audioState) { |
Jay Shrauner | 229e382 | 2014-08-15 09:23:07 -0700 | [diff] [blame] | 291 | for (Listener listener : mListeners) { |
| 292 | listener.onAudioStateChanged(this, audioState); |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 293 | } |
| 294 | } |
| 295 | |
| 296 | private void fireBringToForeground(boolean showDialpad) { |
Jay Shrauner | 229e382 | 2014-08-15 09:23:07 -0700 | [diff] [blame] | 297 | for (Listener listener : mListeners) { |
| 298 | listener.onBringToForeground(this, showDialpad); |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 299 | } |
| 300 | } |
| 301 | |
Santos Cordon | 6c912b7 | 2014-11-07 16:05:09 -0800 | [diff] [blame] | 302 | private void fireCanAddCallChanged(boolean canAddCall) { |
| 303 | for (Listener listener : mListeners) { |
| 304 | listener.onCanAddCallChanged(this, canAddCall); |
| 305 | } |
| 306 | } |
| 307 | |
Santos Cordon | 88b771d | 2014-07-19 13:10:40 -0700 | [diff] [blame] | 308 | private void checkCallTree(ParcelableCall parcelableCall) { |
| 309 | if (parcelableCall.getParentCallId() != null && |
Tyler Gunn | ef9f6f9 | 2014-09-12 22:16:17 -0700 | [diff] [blame] | 310 | !mCallByTelecomCallId.containsKey(parcelableCall.getParentCallId())) { |
Santos Cordon | 88b771d | 2014-07-19 13:10:40 -0700 | [diff] [blame] | 311 | Log.wtf(this, "ParcelableCall %s has nonexistent parent %s", |
| 312 | parcelableCall.getId(), parcelableCall.getParentCallId()); |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 313 | } |
Santos Cordon | 88b771d | 2014-07-19 13:10:40 -0700 | [diff] [blame] | 314 | if (parcelableCall.getChildCallIds() != null) { |
| 315 | for (int i = 0; i < parcelableCall.getChildCallIds().size(); i++) { |
Tyler Gunn | ef9f6f9 | 2014-09-12 22:16:17 -0700 | [diff] [blame] | 316 | if (!mCallByTelecomCallId.containsKey(parcelableCall.getChildCallIds().get(i))) { |
Santos Cordon | 88b771d | 2014-07-19 13:10:40 -0700 | [diff] [blame] | 317 | Log.wtf(this, "ParcelableCall %s has nonexistent child %s", |
| 318 | parcelableCall.getId(), parcelableCall.getChildCallIds().get(i)); |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 319 | } |
| 320 | } |
| 321 | } |
| 322 | } |
| 323 | } |