ImsCallProfile.java revision 4aef69ab52d2cf209790aaf0b1a217d3caaf3ba4 
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
147    /**
148     * Values for EXTRA_DIALSTRING
149     */
150    // default (normal call)
151    public static final int DIALSTRING_NORMAL = 0;
152    // Call for SIP-based user configuration
153    public static final int DIALSTRING_SS_CONF = 1;
154    // Call for USSD message
155    public static final int DIALSTRING_USSD = 2;
156
157    /**
158     * Values for causes that restrict call types
159     */
160    // Default cause not restricted at peer and HD is supported
161    public static final int CALL_RESTRICT_CAUSE_NONE = 0;
162    // Service not supported by RAT at peer
163    public static final int CALL_RESTRICT_CAUSE_RAT = 1;
164    // Service Disabled at peer
165    public static final int CALL_RESTRICT_CAUSE_DISABLED = 2;
166    // HD is not supported
167    public static final int CALL_RESTRICT_CAUSE_HD = 3;
168
169    /**
170     * String extra properties
171     *  oi : Originating identity (number), MT only
172     *  cna : Calling name
173     *  ussd : For network-initiated USSD, MT only
174     *  remote_uri : Connected user identity (it can be used for the conference)
175     *  ChildNum: Child number info.
176     *  Codec: Codec info.
177     *  DisplayText: Display text for the call.
178     *  AdditionalCallInfo: Additional call info.
179     */
180    public static final String EXTRA_OI = "oi";
181    public static final String EXTRA_CNA = "cna";
182    public static final String EXTRA_USSD = "ussd";
183    public static final String EXTRA_REMOTE_URI = "remote_uri";
184    public static final String EXTRA_CHILD_NUMBER = "ChildNum";
185    public static final String EXTRA_CODEC = "Codec";
186    public static final String EXTRA_DISPLAY_TEXT = "DisplayText";
187    public static final String EXTRA_ADDITIONAL_CALL_INFO = "AdditionalCallInfo";
188
189    public int mServiceType;
190    public int mCallType;
191    public int mRestrictCause = CALL_RESTRICT_CAUSE_NONE;
192    public Bundle mCallExtras;
193    public ImsStreamMediaProfile mMediaProfile;
194
195    public ImsCallProfile(Parcel in) {
196        readFromParcel(in);
197    }
198
199    public ImsCallProfile() {
200        mServiceType = SERVICE_TYPE_NORMAL;
201        mCallType = CALL_TYPE_VOICE_N_VIDEO;
202        mCallExtras = new Bundle();
203        mMediaProfile = new ImsStreamMediaProfile();
204    }
205
206    public ImsCallProfile(int serviceType, int callType) {
207        mServiceType = serviceType;
208        mCallType = callType;
209        mCallExtras = new Bundle();
210        mMediaProfile = new ImsStreamMediaProfile();
211    }
212
213    public String getCallExtra(String name) {
214        return getCallExtra(name, "");
215    }
216
217    public String getCallExtra(String name, String defaultValue) {
218        if (mCallExtras == null) {
219            return defaultValue;
220        }
221
222        return mCallExtras.getString(name, defaultValue);
223    }
224
225    public boolean getCallExtraBoolean(String name) {
226        return getCallExtraBoolean(name, false);
227    }
228
229    public boolean getCallExtraBoolean(String name, boolean defaultValue) {
230        if (mCallExtras == null) {
231            return defaultValue;
232        }
233
234        return mCallExtras.getBoolean(name, defaultValue);
235    }
236
237    public int getCallExtraInt(String name) {
238        return getCallExtraInt(name, -1);
239    }
240
241    public int getCallExtraInt(String name, int defaultValue) {
242        if (mCallExtras == null) {
243            return defaultValue;
244        }
245
246        return mCallExtras.getInt(name, defaultValue);
247    }
248
249    public void setCallExtra(String name, String value) {
250        if (mCallExtras != null) {
251            mCallExtras.putString(name, value);
252        }
253    }
254
255    public void setCallExtraBoolean(String name, boolean value) {
256        if (mCallExtras != null) {
257            mCallExtras.putBoolean(name, value);
258        }
259    }
260
261    public void setCallExtraInt(String name, int value) {
262        if (mCallExtras != null) {
263            mCallExtras.putInt(name, value);
264        }
265    }
266
267    public void updateCallType(ImsCallProfile profile) {
268        mCallType = profile.mCallType;
269    }
270
271    public void updateCallExtras(ImsCallProfile profile) {
272        mCallExtras.clear();
273        mCallExtras = (Bundle) profile.mCallExtras.clone();
274    }
275
276    @Override
277    public String toString() {
278        return "{ serviceType=" + mServiceType +
279                ", callType=" + mCallType +
280                ", restrictCause=" + mRestrictCause +
281                ", mediaProfile=" + mMediaProfile.toString() + " }";
282    }
283
284    @Override
285    public int describeContents() {
286        return 0;
287    }
288
289    @Override
290    public void writeToParcel(Parcel out, int flags) {
291        out.writeInt(mServiceType);
292        out.writeInt(mCallType);
293        out.writeParcelable(mCallExtras, 0);
294        out.writeParcelable(mMediaProfile, 0);
295    }
296
297    private void readFromParcel(Parcel in) {
298        mServiceType = in.readInt();
299        mCallType = in.readInt();
300        mCallExtras = in.readParcelable(null);
301        mMediaProfile = in.readParcelable(null);
302    }
303
304    public static final Creator<ImsCallProfile> CREATOR = new Creator<ImsCallProfile>() {
305        @Override
306        public ImsCallProfile createFromParcel(Parcel in) {
307            return new ImsCallProfile(in);
308        }
309
310        @Override
311        public ImsCallProfile[] newArray(int size) {
312            return new ImsCallProfile[size];
313        }
314    };
315
316    /**
317     * Converts from the call types defined in {@link com.android.ims.ImsCallProfile} to the
318     * video state values defined in {@link VideoProfile}.
319     *
320     * @param callType The call type.
321     * @return The video state.
322     */
323    public static int getVideoStateFromImsCallProfile(ImsCallProfile callProfile) {
324        int videostate = VideoProfile.STATE_AUDIO_ONLY;
325        switch (callProfile.mCallType) {
326            case CALL_TYPE_VT_TX:
327                videostate = VideoProfile.STATE_TX_ENABLED;
328                break;
329            case CALL_TYPE_VT_RX:
330                videostate = VideoProfile.STATE_RX_ENABLED;
331                break;
332            case CALL_TYPE_VT:
333                videostate = VideoProfile.STATE_BIDIRECTIONAL;
334                break;
335            case CALL_TYPE_VOICE:
336                videostate = VideoProfile.STATE_AUDIO_ONLY;
337                break;
338            default:
339                videostate = VideoProfile.STATE_AUDIO_ONLY;
340                break;
341        }
342        if (callProfile.isVideoPaused() && videostate != VideoProfile.STATE_AUDIO_ONLY) {
343            videostate |= VideoProfile.STATE_PAUSED;
344        } else {
345            videostate &= ~VideoProfile.STATE_PAUSED;
346        }
347        return videostate;
348    }
349
350    /**
351     * Converts from the video state values defined in {@link VideoProfile}
352     * to the call types defined in {@link ImsCallProfile}.
353     *
354     * @param videoState The video state.
355     * @return The call type.
356     */
357    public static int getCallTypeFromVideoState(int videoState) {
358        boolean videoTx = isVideoStateSet(videoState, VideoProfile.STATE_TX_ENABLED);
359        boolean videoRx = isVideoStateSet(videoState, VideoProfile.STATE_RX_ENABLED);
360        boolean isPaused = isVideoStateSet(videoState, VideoProfile.STATE_PAUSED);
361        if (isPaused) {
362            return ImsCallProfile.CALL_TYPE_VT_NODIR;
363        } else if (videoTx && !videoRx) {
364            return ImsCallProfile.CALL_TYPE_VT_TX;
365        } else if (!videoTx && videoRx) {
366            return ImsCallProfile.CALL_TYPE_VT_RX;
367        } else if (videoTx && videoRx) {
368            return ImsCallProfile.CALL_TYPE_VT;
369        }
370        return ImsCallProfile.CALL_TYPE_VOICE;
371    }
372
373    /**
374     * Translate presentation value to OIR value
375     * @param presentation
376     * @return OIR valuse
377     */
378    public static int presentationToOIR(int presentation) {
379        switch (presentation) {
380            case PhoneConstants.PRESENTATION_RESTRICTED:
381                return ImsCallProfile.OIR_PRESENTATION_RESTRICTED;
382            case PhoneConstants.PRESENTATION_ALLOWED:
383                return ImsCallProfile.OIR_PRESENTATION_NOT_RESTRICTED;
384            default:
385                return ImsCallProfile.OIR_DEFAULT;
386        }
387    }
388
389    /**
390     * Translate OIR value to presentation value
391     * @param oir value
392     * @return presentation value
393     */
394    public static int OIRToPresentation(int oir) {
395        switch(oir) {
396            case ImsCallProfile.OIR_PRESENTATION_RESTRICTED:
397                return PhoneConstants.PRESENTATION_RESTRICTED;
398            case ImsCallProfile.OIR_PRESENTATION_NOT_RESTRICTED:
399                return PhoneConstants.PRESENTATION_ALLOWED;
400            default:
401                return PhoneConstants.PRESENTATION_UNKNOWN;
402        }
403    }
404
405    /**
406     * Checks if video call is paused
407     * @return true if call is video paused
408     */
409    public boolean isVideoPaused() {
410        return mMediaProfile.mVideoDirection == ImsStreamMediaProfile.DIRECTION_INACTIVE;
411    }
412
413    /**
414     * Determines if a video state is set in a video state bit-mask.
415     *
416     * @param videoState The video state bit mask.
417     * @param videoStateToCheck The particular video state to check.
418     * @return True if the video state is set in the bit-mask.
419     */
420    private static boolean isVideoStateSet(int videoState, int videoStateToCheck) {
421        return (videoState & videoStateToCheck) == videoStateToCheck;
422    }
423}
424