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 17 package com.android.ims; 18 19 import android.os.Bundle; 20 import android.os.Parcel; 21 import android.os.Parcelable; 22 import android.telecom.VideoProfile; 23 24 import com.android.internal.telephony.PhoneConstants; 25 26 /** 27 * Parcelable object to handle IMS call profile. 28 * It is created from GSMA IR.92/IR.94, 3GPP TS 24.229/TS 26.114/TS26.111. 29 * It provides the service and call type, the additional information related to the call. 30 * 31 * @hide 32 */ 33 public class ImsCallProfile implements Parcelable { 34 private static final String TAG = "ImsCallProfile"; 35 36 /** 37 * Service types 38 */ 39 /** 40 * It is for a special case. It helps that the application can make a call 41 * without IMS connection (not registered). 42 * In the moment of the call initiation, the device try to connect to the IMS network 43 * and initiates the call. 44 */ 45 public static final int SERVICE_TYPE_NONE = 0; 46 /** 47 * It is a default type and can be selected when the device is connected to the IMS network. 48 */ 49 public static final int SERVICE_TYPE_NORMAL = 1; 50 /** 51 * It is for an emergency call. 52 */ 53 public static final int SERVICE_TYPE_EMERGENCY = 2; 54 55 /** 56 * Call types 57 */ 58 /** 59 * IMSPhone to support IR.92 & IR.94 (voice + video upgrade/downgrade) 60 */ 61 public static final int CALL_TYPE_VOICE_N_VIDEO = 1; 62 /** 63 * IR.92 (Voice only) 64 */ 65 public static final int CALL_TYPE_VOICE = 2; 66 /** 67 * VT to support IR.92 & IR.94 (voice + video upgrade/downgrade) 68 */ 69 public static final int CALL_TYPE_VIDEO_N_VOICE = 3; 70 /** 71 * Video Telephony (audio / video two way) 72 */ 73 public static final int CALL_TYPE_VT = 4; 74 /** 75 * Video Telephony (audio two way / video TX one way) 76 */ 77 public static final int CALL_TYPE_VT_TX = 5; 78 /** 79 * Video Telephony (audio two way / video RX one way) 80 */ 81 public static final int CALL_TYPE_VT_RX = 6; 82 /** 83 * Video Telephony (audio two way / video inactive) 84 */ 85 public static final int CALL_TYPE_VT_NODIR = 7; 86 /** 87 * VideoShare (video two way) 88 */ 89 public static final int CALL_TYPE_VS = 8; 90 /** 91 * VideoShare (video TX one way) 92 */ 93 public static final int CALL_TYPE_VS_TX = 9; 94 /** 95 * VideoShare (video RX one way) 96 */ 97 public static final int CALL_TYPE_VS_RX = 10; 98 99 /** 100 * Extra properties for IMS call. 101 */ 102 /** 103 * Boolean extra properties - "true" / "false" 104 * conference : Indicates if the session is for the conference call or not. 105 * e_call : Indicates if the session is for the emergency call or not. 106 * vms : Indicates if the session is connected to the voice mail system or not. 107 * call_mode_changeable : Indicates if the session is able to upgrade/downgrade 108 * the video during voice call. 109 * conference_avail : Indicates if the session can be extended to the conference. 110 */ 111 public static final String EXTRA_CONFERENCE = "conference"; 112 public static final String EXTRA_E_CALL = "e_call"; 113 public static final String EXTRA_VMS = "vms"; 114 public static final String EXTRA_CALL_MODE_CHANGEABLE = "call_mode_changeable"; 115 public static final String EXTRA_CONFERENCE_AVAIL = "conference_avail"; 116 117 // Extra string for internal use only. OEMs should not use 118 // this for packing extras. 119 public static final String EXTRA_OEM_EXTRAS = "OemCallExtras"; 120 121 /** 122 * Integer extra properties 123 * oir : Rule for originating identity (number) presentation, MO/MT. 124 * {@link ImsCallProfile#OIR_DEFAULT} 125 * {@link ImsCallProfile#OIR_PRESENTATION_RESTRICTED} 126 * {@link ImsCallProfile#OIR_PRESENTATION_NOT_RESTRICTED} 127 * cnap : Rule for calling name presentation 128 * {@link ImsCallProfile#OIR_DEFAULT} 129 * {@link ImsCallProfile#OIR_PRESENTATION_RESTRICTED} 130 * {@link ImsCallProfile#OIR_PRESENTATION_NOT_RESTRICTED} 131 * dialstring : To identify the Ims call type, MO 132 * {@link ImsCallProfile#DIALSTRING_NORMAL_CALL} 133 * {@link ImsCallProfile#DIALSTRING_SS_CONF} 134 * {@link ImsCallProfile#DIALSTRING_USSD} 135 */ 136 public static final String EXTRA_OIR = "oir"; 137 public static final String EXTRA_CNAP = "cnap"; 138 public static final String EXTRA_DIALSTRING = "dialstring"; 139 140 /** 141 * Values for EXTRA_OIR / EXTRA_CNAP 142 */ 143 public static final int OIR_DEFAULT = 0; // "user subscription default value" 144 public static final int OIR_PRESENTATION_RESTRICTED = 1; 145 public static final int OIR_PRESENTATION_NOT_RESTRICTED = 2; 146 public static final int OIR_PRESENTATION_UNKNOWN = 3; 147 public static final int OIR_PRESENTATION_PAYPHONE = 4; 148 149 /** 150 * Values for EXTRA_DIALSTRING 151 */ 152 // default (normal call) 153 public static final int DIALSTRING_NORMAL = 0; 154 // Call for SIP-based user configuration 155 public static final int DIALSTRING_SS_CONF = 1; 156 // Call for USSD message 157 public static final int DIALSTRING_USSD = 2; 158 159 /** 160 * Values for causes that restrict call types 161 */ 162 // Default cause not restricted at peer and HD is supported 163 public static final int CALL_RESTRICT_CAUSE_NONE = 0; 164 // Service not supported by RAT at peer 165 public static final int CALL_RESTRICT_CAUSE_RAT = 1; 166 // Service Disabled at peer 167 public static final int CALL_RESTRICT_CAUSE_DISABLED = 2; 168 // HD is not supported 169 public static final int CALL_RESTRICT_CAUSE_HD = 3; 170 171 /** 172 * String extra properties 173 * oi : Originating identity (number), MT only 174 * cna : Calling name 175 * ussd : For network-initiated USSD, MT only 176 * remote_uri : Connected user identity (it can be used for the conference) 177 */ 178 public static final String EXTRA_OI = "oi"; 179 public static final String EXTRA_CNA = "cna"; 180 public static final String EXTRA_USSD = "ussd"; 181 public static final String EXTRA_REMOTE_URI = "remote_uri"; 182 183 public int mServiceType; 184 public int mCallType; 185 public int mRestrictCause = CALL_RESTRICT_CAUSE_NONE; 186 public Bundle mCallExtras; 187 public ImsStreamMediaProfile mMediaProfile; 188 ImsCallProfile(Parcel in)189 public ImsCallProfile(Parcel in) { 190 readFromParcel(in); 191 } 192 ImsCallProfile()193 public ImsCallProfile() { 194 mServiceType = SERVICE_TYPE_NORMAL; 195 mCallType = CALL_TYPE_VOICE_N_VIDEO; 196 mCallExtras = new Bundle(); 197 mMediaProfile = new ImsStreamMediaProfile(); 198 } 199 ImsCallProfile(int serviceType, int callType)200 public ImsCallProfile(int serviceType, int callType) { 201 mServiceType = serviceType; 202 mCallType = callType; 203 mCallExtras = new Bundle(); 204 mMediaProfile = new ImsStreamMediaProfile(); 205 } 206 getCallExtra(String name)207 public String getCallExtra(String name) { 208 return getCallExtra(name, ""); 209 } 210 getCallExtra(String name, String defaultValue)211 public String getCallExtra(String name, String defaultValue) { 212 if (mCallExtras == null) { 213 return defaultValue; 214 } 215 216 return mCallExtras.getString(name, defaultValue); 217 } 218 getCallExtraBoolean(String name)219 public boolean getCallExtraBoolean(String name) { 220 return getCallExtraBoolean(name, false); 221 } 222 getCallExtraBoolean(String name, boolean defaultValue)223 public boolean getCallExtraBoolean(String name, boolean defaultValue) { 224 if (mCallExtras == null) { 225 return defaultValue; 226 } 227 228 return mCallExtras.getBoolean(name, defaultValue); 229 } 230 getCallExtraInt(String name)231 public int getCallExtraInt(String name) { 232 return getCallExtraInt(name, -1); 233 } 234 getCallExtraInt(String name, int defaultValue)235 public int getCallExtraInt(String name, int defaultValue) { 236 if (mCallExtras == null) { 237 return defaultValue; 238 } 239 240 return mCallExtras.getInt(name, defaultValue); 241 } 242 setCallExtra(String name, String value)243 public void setCallExtra(String name, String value) { 244 if (mCallExtras != null) { 245 mCallExtras.putString(name, value); 246 } 247 } 248 setCallExtraBoolean(String name, boolean value)249 public void setCallExtraBoolean(String name, boolean value) { 250 if (mCallExtras != null) { 251 mCallExtras.putBoolean(name, value); 252 } 253 } 254 setCallExtraInt(String name, int value)255 public void setCallExtraInt(String name, int value) { 256 if (mCallExtras != null) { 257 mCallExtras.putInt(name, value); 258 } 259 } 260 updateCallType(ImsCallProfile profile)261 public void updateCallType(ImsCallProfile profile) { 262 mCallType = profile.mCallType; 263 } 264 updateCallExtras(ImsCallProfile profile)265 public void updateCallExtras(ImsCallProfile profile) { 266 mCallExtras.clear(); 267 mCallExtras = (Bundle) profile.mCallExtras.clone(); 268 } 269 270 @Override toString()271 public String toString() { 272 return "{ serviceType=" + mServiceType + 273 ", callType=" + mCallType + 274 ", restrictCause=" + mRestrictCause + 275 ", mediaProfile=" + mMediaProfile.toString() + " }"; 276 } 277 278 @Override describeContents()279 public int describeContents() { 280 return 0; 281 } 282 283 @Override writeToParcel(Parcel out, int flags)284 public void writeToParcel(Parcel out, int flags) { 285 out.writeInt(mServiceType); 286 out.writeInt(mCallType); 287 out.writeParcelable(mCallExtras, 0); 288 out.writeParcelable(mMediaProfile, 0); 289 } 290 readFromParcel(Parcel in)291 private void readFromParcel(Parcel in) { 292 mServiceType = in.readInt(); 293 mCallType = in.readInt(); 294 mCallExtras = in.readParcelable(null); 295 mMediaProfile = in.readParcelable(null); 296 } 297 298 public static final Creator<ImsCallProfile> CREATOR = new Creator<ImsCallProfile>() { 299 @Override 300 public ImsCallProfile createFromParcel(Parcel in) { 301 return new ImsCallProfile(in); 302 } 303 304 @Override 305 public ImsCallProfile[] newArray(int size) { 306 return new ImsCallProfile[size]; 307 } 308 }; 309 310 /** 311 * Converts from the call types defined in {@link com.android.ims.ImsCallProfile} to the 312 * video state values defined in {@link VideoProfile}. 313 * 314 * @param callType The call type. 315 * @return The video state. 316 */ getVideoStateFromImsCallProfile(ImsCallProfile callProfile)317 public static int getVideoStateFromImsCallProfile(ImsCallProfile callProfile) { 318 int videostate = VideoProfile.STATE_AUDIO_ONLY; 319 switch (callProfile.mCallType) { 320 case CALL_TYPE_VT_TX: 321 videostate = VideoProfile.STATE_TX_ENABLED; 322 break; 323 case CALL_TYPE_VT_RX: 324 videostate = VideoProfile.STATE_RX_ENABLED; 325 break; 326 case CALL_TYPE_VT: 327 videostate = VideoProfile.STATE_BIDIRECTIONAL; 328 break; 329 case CALL_TYPE_VOICE: 330 videostate = VideoProfile.STATE_AUDIO_ONLY; 331 break; 332 default: 333 videostate = VideoProfile.STATE_AUDIO_ONLY; 334 break; 335 } 336 if (callProfile.isVideoPaused() && !VideoProfile.isAudioOnly(videostate)) { 337 videostate |= VideoProfile.STATE_PAUSED; 338 } else { 339 videostate &= ~VideoProfile.STATE_PAUSED; 340 } 341 return videostate; 342 } 343 344 /** 345 * Converts from the video state values defined in {@link VideoProfile} 346 * to the call types defined in {@link ImsCallProfile}. 347 * 348 * @param videoState The video state. 349 * @return The call type. 350 */ getCallTypeFromVideoState(int videoState)351 public static int getCallTypeFromVideoState(int videoState) { 352 boolean videoTx = isVideoStateSet(videoState, VideoProfile.STATE_TX_ENABLED); 353 boolean videoRx = isVideoStateSet(videoState, VideoProfile.STATE_RX_ENABLED); 354 boolean isPaused = isVideoStateSet(videoState, VideoProfile.STATE_PAUSED); 355 if (isPaused) { 356 return ImsCallProfile.CALL_TYPE_VT_NODIR; 357 } else if (videoTx && !videoRx) { 358 return ImsCallProfile.CALL_TYPE_VT_TX; 359 } else if (!videoTx && videoRx) { 360 return ImsCallProfile.CALL_TYPE_VT_RX; 361 } else if (videoTx && videoRx) { 362 return ImsCallProfile.CALL_TYPE_VT; 363 } 364 return ImsCallProfile.CALL_TYPE_VOICE; 365 } 366 367 /** 368 * Translate presentation value to OIR value 369 * @param presentation 370 * @return OIR valuse 371 */ presentationToOIR(int presentation)372 public static int presentationToOIR(int presentation) { 373 switch (presentation) { 374 case PhoneConstants.PRESENTATION_RESTRICTED: 375 return ImsCallProfile.OIR_PRESENTATION_RESTRICTED; 376 case PhoneConstants.PRESENTATION_ALLOWED: 377 return ImsCallProfile.OIR_PRESENTATION_NOT_RESTRICTED; 378 case PhoneConstants.PRESENTATION_PAYPHONE: 379 return ImsCallProfile.OIR_PRESENTATION_PAYPHONE; 380 case PhoneConstants.PRESENTATION_UNKNOWN: 381 return ImsCallProfile.OIR_PRESENTATION_UNKNOWN; 382 default: 383 return ImsCallProfile.OIR_DEFAULT; 384 } 385 } 386 387 /** 388 * Translate OIR value to presentation value 389 * @param oir value 390 * @return presentation value 391 */ OIRToPresentation(int oir)392 public static int OIRToPresentation(int oir) { 393 switch(oir) { 394 case ImsCallProfile.OIR_PRESENTATION_RESTRICTED: 395 return PhoneConstants.PRESENTATION_RESTRICTED; 396 case ImsCallProfile.OIR_PRESENTATION_NOT_RESTRICTED: 397 return PhoneConstants.PRESENTATION_ALLOWED; 398 case ImsCallProfile.OIR_PRESENTATION_PAYPHONE: 399 return PhoneConstants.PRESENTATION_PAYPHONE; 400 case ImsCallProfile.OIR_PRESENTATION_UNKNOWN: 401 return PhoneConstants.PRESENTATION_UNKNOWN; 402 default: 403 return PhoneConstants.PRESENTATION_UNKNOWN; 404 } 405 } 406 407 /** 408 * Checks if video call is paused 409 * @return true if call is video paused 410 */ isVideoPaused()411 public boolean isVideoPaused() { 412 return mMediaProfile.mVideoDirection == ImsStreamMediaProfile.DIRECTION_INACTIVE; 413 } 414 415 /** 416 * Determines if a video state is set in a video state bit-mask. 417 * 418 * @param videoState The video state bit mask. 419 * @param videoStateToCheck The particular video state to check. 420 * @return True if the video state is set in the bit-mask. 421 */ isVideoStateSet(int videoState, int videoStateToCheck)422 private static boolean isVideoStateSet(int videoState, int videoStateToCheck) { 423 return (videoState & videoStateToCheck) == videoStateToCheck; 424 } 425 } 426