Shriram Ganesh 482e6da972 IMS: Peer capabilities support
Add support for querying peer capabilities

IMS: Add support for HD icon display related information

Added support to pass the restrict cause associated with the peer
in order to enable display of the HD icon when necessary.Added
support to pass local audio codec information and defined values
for new codecs not defined.

Change-Id: If05d46bdb3907a0ec7efdde48337a7932a7a5c21
2014-11-11 16:36:15 +00:00

399 lines
13 KiB
Java

/*
* Copyright (c) 2013 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.ims;
import android.os.Bundle;
import android.os.Parcel;
import android.os.Parcelable;
import android.telecom.VideoProfile;
import com.android.internal.telephony.PhoneConstants;
/**
* Parcelable object to handle IMS call profile.
* It is created from GSMA IR.92/IR.94, 3GPP TS 24.229/TS 26.114/TS26.111.
* It provides the service and call type, the additional information related to the call.
*
* @hide
*/
public class ImsCallProfile implements Parcelable {
private static final String TAG = "ImsCallProfile";
/**
* Service types
*/
/**
* It is for a special case. It helps that the application can make a call
* without IMS connection (not registered).
* In the moment of the call initiation, the device try to connect to the IMS network
* and initiates the call.
*/
public static final int SERVICE_TYPE_NONE = 0;
/**
* It is a default type and can be selected when the device is connected to the IMS network.
*/
public static final int SERVICE_TYPE_NORMAL = 1;
/**
* It is for an emergency call.
*/
public static final int SERVICE_TYPE_EMERGENCY = 2;
/**
* Call types
*/
/**
* IMSPhone to support IR.92 & IR.94 (voice + video upgrade/downgrade)
*/
public static final int CALL_TYPE_VOICE_N_VIDEO = 1;
/**
* IR.92 (Voice only)
*/
public static final int CALL_TYPE_VOICE = 2;
/**
* VT to support IR.92 & IR.94 (voice + video upgrade/downgrade)
*/
public static final int CALL_TYPE_VIDEO_N_VOICE = 3;
/**
* Video Telephony (audio / video two way)
*/
public static final int CALL_TYPE_VT = 4;
/**
* Video Telephony (audio two way / video TX one way)
*/
public static final int CALL_TYPE_VT_TX = 5;
/**
* Video Telephony (audio two way / video RX one way)
*/
public static final int CALL_TYPE_VT_RX = 6;
/**
* Video Telephony (audio two way / video inactive)
*/
public static final int CALL_TYPE_VT_NODIR = 7;
/**
* VideoShare (video two way)
*/
public static final int CALL_TYPE_VS = 8;
/**
* VideoShare (video TX one way)
*/
public static final int CALL_TYPE_VS_TX = 9;
/**
* VideoShare (video RX one way)
*/
public static final int CALL_TYPE_VS_RX = 10;
/**
* Extra properties for IMS call.
*/
/**
* Boolean extra properties - "true" / "false"
* conference : Indicates if the session is for the conference call or not.
* e_call : Indicates if the session is for the emergency call or not.
* vms : Indicates if the session is connected to the voice mail system or not.
* call_mode_changeable : Indicates if the session is able to upgrade/downgrade
* the video during voice call.
* conference_avail : Indicates if the session can be extended to the conference.
*/
public static final String EXTRA_CONFERENCE = "conference";
public static final String EXTRA_E_CALL = "e_call";
public static final String EXTRA_VMS = "vms";
public static final String EXTRA_CALL_MODE_CHANGEABLE = "call_mode_changeable";
public static final String EXTRA_CONFERENCE_AVAIL = "conference_avail";
// Extra string for internal use only. OEMs should not use
// this for packing extras.
public static final String EXTRA_OEM_EXTRAS = "OemCallExtras";
/**
* Integer extra properties
* oir : Rule for originating identity (number) presentation, MO/MT.
* {@link ImsCallProfile#OIR_DEFAULT}
* {@link ImsCallProfile#OIR_PRESENTATION_RESTRICTED}
* {@link ImsCallProfile#OIR_PRESENTATION_NOT_RESTRICTED}
* cnap : Rule for calling name presentation
* {@link ImsCallProfile#OIR_DEFAULT}
* {@link ImsCallProfile#OIR_PRESENTATION_RESTRICTED}
* {@link ImsCallProfile#OIR_PRESENTATION_NOT_RESTRICTED}
* dialstring : To identify the Ims call type, MO
* {@link ImsCallProfile#DIALSTRING_NORMAL_CALL}
* {@link ImsCallProfile#DIALSTRING_SS_CONF}
* {@link ImsCallProfile#DIALSTRING_USSD}
*/
public static final String EXTRA_OIR = "oir";
public static final String EXTRA_CNAP = "cnap";
public static final String EXTRA_DIALSTRING = "dialstring";
/**
* Values for EXTRA_OIR / EXTRA_CNAP
*/
public static final int OIR_DEFAULT = 0; // "user subscription default value"
public static final int OIR_PRESENTATION_RESTRICTED = 1;
public static final int OIR_PRESENTATION_NOT_RESTRICTED = 2;
/**
* Values for EXTRA_DIALSTRING
*/
// default (normal call)
public static final int DIALSTRING_NORMAL = 0;
// Call for SIP-based user configuration
public static final int DIALSTRING_SS_CONF = 1;
// Call for USSD message
public static final int DIALSTRING_USSD = 2;
/**
* Values for causes that restrict call types
*/
// Default cause not restricted at peer and HD is supported
public static final int CALL_RESTRICT_CAUSE_NONE = 0;
// Service not supported by RAT at peer
public static final int CALL_RESTRICT_CAUSE_RAT = 1;
// Service Disabled at peer
public static final int CALL_RESTRICT_CAUSE_DISABLED = 2;
// HD is not supported
public static final int CALL_RESTRICT_CAUSE_HD = 3;
/**
* String extra properties
* oi : Originating identity (number), MT only
* cna : Calling name
* ussd : For network-initiated USSD, MT only
* remote_uri : Connected user identity (it can be used for the conference)
*/
public static final String EXTRA_OI = "oi";
public static final String EXTRA_CNA = "cna";
public static final String EXTRA_USSD = "ussd";
public static final String EXTRA_REMOTE_URI = "remote_uri";
public int mServiceType;
public int mCallType;
public int mRestrictCause = CALL_RESTRICT_CAUSE_NONE;
public Bundle mCallExtras;
public ImsStreamMediaProfile mMediaProfile;
public ImsCallProfile(Parcel in) {
readFromParcel(in);
}
public ImsCallProfile() {
mServiceType = SERVICE_TYPE_NORMAL;
mCallType = CALL_TYPE_VOICE_N_VIDEO;
mCallExtras = new Bundle();
mMediaProfile = new ImsStreamMediaProfile();
}
public ImsCallProfile(int serviceType, int callType) {
mServiceType = serviceType;
mCallType = callType;
mCallExtras = new Bundle();
mMediaProfile = new ImsStreamMediaProfile();
}
public String getCallExtra(String name) {
return getCallExtra(name, "");
}
public String getCallExtra(String name, String defaultValue) {
if (mCallExtras == null) {
return defaultValue;
}
return mCallExtras.getString(name, defaultValue);
}
public boolean getCallExtraBoolean(String name) {
return getCallExtraBoolean(name, false);
}
public boolean getCallExtraBoolean(String name, boolean defaultValue) {
if (mCallExtras == null) {
return defaultValue;
}
return mCallExtras.getBoolean(name, defaultValue);
}
public int getCallExtraInt(String name) {
return getCallExtraInt(name, -1);
}
public int getCallExtraInt(String name, int defaultValue) {
if (mCallExtras == null) {
return defaultValue;
}
return mCallExtras.getInt(name, defaultValue);
}
public void setCallExtra(String name, String value) {
if (mCallExtras != null) {
mCallExtras.putString(name, value);
}
}
public void setCallExtraBoolean(String name, boolean value) {
if (mCallExtras != null) {
mCallExtras.putBoolean(name, value);
}
}
public void setCallExtraInt(String name, int value) {
if (mCallExtras != null) {
mCallExtras.putInt(name, value);
}
}
public void updateCallType(ImsCallProfile profile) {
mCallType = profile.mCallType;
}
public void updateCallExtras(ImsCallProfile profile) {
mCallExtras.clear();
mCallExtras = (Bundle) profile.mCallExtras.clone();
}
@Override
public String toString() {
return "{ serviceType=" + mServiceType +
", callType=" + mCallType +
", callExtras=" + mCallExtras.toString() +
", mediaProfile=" + mMediaProfile.toString() + " }";
}
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(Parcel out, int flags) {
out.writeInt(mServiceType);
out.writeInt(mCallType);
out.writeParcelable(mCallExtras, 0);
out.writeParcelable(mMediaProfile, 0);
}
private void readFromParcel(Parcel in) {
mServiceType = in.readInt();
mCallType = in.readInt();
mCallExtras = in.readParcelable(null);
mMediaProfile = in.readParcelable(null);
}
public static final Creator<ImsCallProfile> CREATOR = new Creator<ImsCallProfile>() {
@Override
public ImsCallProfile createFromParcel(Parcel in) {
return new ImsCallProfile(in);
}
@Override
public ImsCallProfile[] newArray(int size) {
return new ImsCallProfile[size];
}
};
/**
* Converts from the call types defined in {@link com.android.ims.ImsCallProfile} to the
* video state values defined in {@link VideoProfile}.
*
* @param callType The call type.
* @return The video state.
*/
public static int getVideoStateFromCallType(int callType) {
switch (callType) {
case CALL_TYPE_VT_NODIR:
return VideoProfile.VideoState.PAUSED |
VideoProfile.VideoState.BIDIRECTIONAL;
case CALL_TYPE_VT_TX:
return VideoProfile.VideoState.TX_ENABLED;
case CALL_TYPE_VT_RX:
return VideoProfile.VideoState.RX_ENABLED;
case CALL_TYPE_VT:
return VideoProfile.VideoState.BIDIRECTIONAL;
case CALL_TYPE_VOICE:
return VideoProfile.VideoState.AUDIO_ONLY;
default:
return VideoProfile.VideoState.AUDIO_ONLY;
}
}
/**
* Converts from the video state values defined in {@link VideoProfile}
* to the call types defined in {@link ImsCallProfile}.
*
* @param videoState The video state.
* @return The call type.
*/
public static int getCallTypeFromVideoState(int videoState) {
boolean videoTx = isVideoStateSet(videoState, VideoProfile.VideoState.TX_ENABLED);
boolean videoRx = isVideoStateSet(videoState, VideoProfile.VideoState.RX_ENABLED);
boolean isPaused = isVideoStateSet(videoState, VideoProfile.VideoState.PAUSED);
if (isPaused) {
return ImsCallProfile.CALL_TYPE_VT_NODIR;
} else if (videoTx && !videoRx) {
return ImsCallProfile.CALL_TYPE_VT_TX;
} else if (!videoTx && videoRx) {
return ImsCallProfile.CALL_TYPE_VT_RX;
} else if (videoTx && videoRx) {
return ImsCallProfile.CALL_TYPE_VT;
}
return ImsCallProfile.CALL_TYPE_VOICE;
}
/**
* Translate presentation value to OIR value
* @param presentation
* @return OIR valuse
*/
public static int presentationToOIR(int presentation) {
switch (presentation) {
case PhoneConstants.PRESENTATION_RESTRICTED:
return ImsCallProfile.OIR_PRESENTATION_RESTRICTED;
case PhoneConstants.PRESENTATION_ALLOWED:
return ImsCallProfile.OIR_PRESENTATION_NOT_RESTRICTED;
default:
return ImsCallProfile.OIR_DEFAULT;
}
}
/**
* Translate OIR value to presentation value
* @param oir value
* @return presentation value
*/
public static int OIRToPresentation(int oir) {
switch(oir) {
case ImsCallProfile.OIR_PRESENTATION_RESTRICTED:
return PhoneConstants.PRESENTATION_RESTRICTED;
case ImsCallProfile.OIR_PRESENTATION_NOT_RESTRICTED:
return PhoneConstants.PRESENTATION_ALLOWED;
default:
return PhoneConstants.PRESENTATION_UNKNOWN;
}
}
/**
* Determines if a video state is set in a video state bit-mask.
*
* @param videoState The video state bit mask.
* @param videoStateToCheck The particular video state to check.
* @return True if the video state is set in the bit-mask.
*/
private static boolean isVideoStateSet(int videoState, int videoStateToCheck) {
return (videoState & videoStateToCheck) == videoStateToCheck;
}
}