ImsCallProfile.java revision 3b0437eda3fd3a3abdfaae471cbd9481b42122cb
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 17package com.android.ims; 18 19import android.os.Bundle; 20import android.os.Parcel; 21import android.os.Parcelable; 22import android.telecom.VideoProfile; 23 24import 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 */ 33public 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 * ChildNum: Child number info. 178 * Codec: Codec info. 179 * DisplayText: Display text for the call. 180 * AdditionalCallInfo: Additional call info. 181 * CallRadioTech: The radio tech on which the call is placed. 182 */ 183 public static final String EXTRA_OI = "oi"; 184 public static final String EXTRA_CNA = "cna"; 185 public static final String EXTRA_USSD = "ussd"; 186 public static final String EXTRA_REMOTE_URI = "remote_uri"; 187 public static final String EXTRA_CHILD_NUMBER = "ChildNum"; 188 public static final String EXTRA_CODEC = "Codec"; 189 public static final String EXTRA_DISPLAY_TEXT = "DisplayText"; 190 public static final String EXTRA_ADDITIONAL_CALL_INFO = "AdditionalCallInfo"; 191 public static final String EXTRA_CALL_RAT_TYPE = "CallRadioTech"; 192 193 public int mServiceType; 194 public int mCallType; 195 public int mRestrictCause = CALL_RESTRICT_CAUSE_NONE; 196 public Bundle mCallExtras; 197 public ImsStreamMediaProfile mMediaProfile; 198 199 public ImsCallProfile(Parcel in) { 200 readFromParcel(in); 201 } 202 203 public ImsCallProfile() { 204 mServiceType = SERVICE_TYPE_NORMAL; 205 mCallType = CALL_TYPE_VOICE_N_VIDEO; 206 mCallExtras = new Bundle(); 207 mMediaProfile = new ImsStreamMediaProfile(); 208 } 209 210 public ImsCallProfile(int serviceType, int callType) { 211 mServiceType = serviceType; 212 mCallType = callType; 213 mCallExtras = new Bundle(); 214 mMediaProfile = new ImsStreamMediaProfile(); 215 } 216 217 public String getCallExtra(String name) { 218 return getCallExtra(name, ""); 219 } 220 221 public String getCallExtra(String name, String defaultValue) { 222 if (mCallExtras == null) { 223 return defaultValue; 224 } 225 226 return mCallExtras.getString(name, defaultValue); 227 } 228 229 public boolean getCallExtraBoolean(String name) { 230 return getCallExtraBoolean(name, false); 231 } 232 233 public boolean getCallExtraBoolean(String name, boolean defaultValue) { 234 if (mCallExtras == null) { 235 return defaultValue; 236 } 237 238 return mCallExtras.getBoolean(name, defaultValue); 239 } 240 241 public int getCallExtraInt(String name) { 242 return getCallExtraInt(name, -1); 243 } 244 245 public int getCallExtraInt(String name, int defaultValue) { 246 if (mCallExtras == null) { 247 return defaultValue; 248 } 249 250 return mCallExtras.getInt(name, defaultValue); 251 } 252 253 public void setCallExtra(String name, String value) { 254 if (mCallExtras != null) { 255 mCallExtras.putString(name, value); 256 } 257 } 258 259 public void setCallExtraBoolean(String name, boolean value) { 260 if (mCallExtras != null) { 261 mCallExtras.putBoolean(name, value); 262 } 263 } 264 265 public void setCallExtraInt(String name, int value) { 266 if (mCallExtras != null) { 267 mCallExtras.putInt(name, value); 268 } 269 } 270 271 public void updateCallType(ImsCallProfile profile) { 272 mCallType = profile.mCallType; 273 } 274 275 public void updateCallExtras(ImsCallProfile profile) { 276 mCallExtras.clear(); 277 mCallExtras = (Bundle) profile.mCallExtras.clone(); 278 } 279 280 @Override 281 public String toString() { 282 return "{ serviceType=" + mServiceType + 283 ", callType=" + mCallType + 284 ", restrictCause=" + mRestrictCause + 285 ", mediaProfile=" + mMediaProfile.toString() + " }"; 286 } 287 288 @Override 289 public int describeContents() { 290 return 0; 291 } 292 293 @Override 294 public void writeToParcel(Parcel out, int flags) { 295 out.writeInt(mServiceType); 296 out.writeInt(mCallType); 297 out.writeParcelable(mCallExtras, 0); 298 out.writeParcelable(mMediaProfile, 0); 299 } 300 301 private void readFromParcel(Parcel in) { 302 mServiceType = in.readInt(); 303 mCallType = in.readInt(); 304 mCallExtras = in.readParcelable(null); 305 mMediaProfile = in.readParcelable(null); 306 } 307 308 public static final Creator<ImsCallProfile> CREATOR = new Creator<ImsCallProfile>() { 309 @Override 310 public ImsCallProfile createFromParcel(Parcel in) { 311 return new ImsCallProfile(in); 312 } 313 314 @Override 315 public ImsCallProfile[] newArray(int size) { 316 return new ImsCallProfile[size]; 317 } 318 }; 319 320 /** 321 * Converts from the call types defined in {@link com.android.ims.ImsCallProfile} to the 322 * video state values defined in {@link VideoProfile}. 323 * 324 * @param callType The call type. 325 * @return The video state. 326 */ 327 public static int getVideoStateFromImsCallProfile(ImsCallProfile callProfile) { 328 int videostate = VideoProfile.STATE_AUDIO_ONLY; 329 switch (callProfile.mCallType) { 330 case CALL_TYPE_VT_TX: 331 videostate = VideoProfile.STATE_TX_ENABLED; 332 break; 333 case CALL_TYPE_VT_RX: 334 videostate = VideoProfile.STATE_RX_ENABLED; 335 break; 336 case CALL_TYPE_VT: 337 videostate = VideoProfile.STATE_BIDIRECTIONAL; 338 break; 339 case CALL_TYPE_VOICE: 340 videostate = VideoProfile.STATE_AUDIO_ONLY; 341 break; 342 default: 343 videostate = VideoProfile.STATE_AUDIO_ONLY; 344 break; 345 } 346 if (callProfile.isVideoPaused() && !VideoProfile.isAudioOnly(videostate)) { 347 videostate |= VideoProfile.STATE_PAUSED; 348 } else { 349 videostate &= ~VideoProfile.STATE_PAUSED; 350 } 351 return videostate; 352 } 353 354 /** 355 * Converts from the video state values defined in {@link VideoProfile} 356 * to the call types defined in {@link ImsCallProfile}. 357 * 358 * @param videoState The video state. 359 * @return The call type. 360 */ 361 public static int getCallTypeFromVideoState(int videoState) { 362 boolean videoTx = isVideoStateSet(videoState, VideoProfile.STATE_TX_ENABLED); 363 boolean videoRx = isVideoStateSet(videoState, VideoProfile.STATE_RX_ENABLED); 364 boolean isPaused = isVideoStateSet(videoState, VideoProfile.STATE_PAUSED); 365 if (isPaused) { 366 return ImsCallProfile.CALL_TYPE_VT_NODIR; 367 } else if (videoTx && !videoRx) { 368 return ImsCallProfile.CALL_TYPE_VT_TX; 369 } else if (!videoTx && videoRx) { 370 return ImsCallProfile.CALL_TYPE_VT_RX; 371 } else if (videoTx && videoRx) { 372 return ImsCallProfile.CALL_TYPE_VT; 373 } 374 return ImsCallProfile.CALL_TYPE_VOICE; 375 } 376 377 /** 378 * Translate presentation value to OIR value 379 * @param presentation 380 * @return OIR valuse 381 */ 382 public static int presentationToOIR(int presentation) { 383 switch (presentation) { 384 case PhoneConstants.PRESENTATION_RESTRICTED: 385 return ImsCallProfile.OIR_PRESENTATION_RESTRICTED; 386 case PhoneConstants.PRESENTATION_ALLOWED: 387 return ImsCallProfile.OIR_PRESENTATION_NOT_RESTRICTED; 388 case PhoneConstants.PRESENTATION_PAYPHONE: 389 return ImsCallProfile.OIR_PRESENTATION_PAYPHONE; 390 case PhoneConstants.PRESENTATION_UNKNOWN: 391 return ImsCallProfile.OIR_PRESENTATION_UNKNOWN; 392 default: 393 return ImsCallProfile.OIR_DEFAULT; 394 } 395 } 396 397 /** 398 * Translate OIR value to presentation value 399 * @param oir value 400 * @return presentation value 401 */ 402 public static int OIRToPresentation(int oir) { 403 switch(oir) { 404 case ImsCallProfile.OIR_PRESENTATION_RESTRICTED: 405 return PhoneConstants.PRESENTATION_RESTRICTED; 406 case ImsCallProfile.OIR_PRESENTATION_NOT_RESTRICTED: 407 return PhoneConstants.PRESENTATION_ALLOWED; 408 case ImsCallProfile.OIR_PRESENTATION_PAYPHONE: 409 return PhoneConstants.PRESENTATION_PAYPHONE; 410 case ImsCallProfile.OIR_PRESENTATION_UNKNOWN: 411 return PhoneConstants.PRESENTATION_UNKNOWN; 412 default: 413 return PhoneConstants.PRESENTATION_UNKNOWN; 414 } 415 } 416 417 /** 418 * Checks if video call is paused 419 * @return true if call is video paused 420 */ 421 public boolean isVideoPaused() { 422 return mMediaProfile.mVideoDirection == ImsStreamMediaProfile.DIRECTION_INACTIVE; 423 } 424 425 /** 426 * Determines if a video state is set in a video state bit-mask. 427 * 428 * @param videoState The video state bit mask. 429 * @param videoStateToCheck The particular video state to check. 430 * @return True if the video state is set in the bit-mask. 431 */ 432 private static boolean isVideoStateSet(int videoState, int videoStateToCheck) { 433 return (videoState & videoStateToCheck) == videoStateToCheck; 434 } 435} 436