1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
|
/*
* Copyright (C) 2014 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.incallui;
import android.content.Context;
import android.content.res.Configuration;
import android.os.Handler;
import android.telecom.AudioState;
import android.telecom.CameraCapabilities;
import android.telecom.InCallService.VideoCall;
import android.view.Surface;
import com.android.contacts.common.CallUtil;
import com.android.incallui.InCallPresenter.InCallDetailsListener;
import com.android.incallui.InCallPresenter.InCallOrientationListener;
import com.android.incallui.InCallPresenter.InCallStateListener;
import com.android.incallui.InCallPresenter.IncomingCallListener;
import com.android.incallui.InCallVideoCallListenerNotifier.SurfaceChangeListener;
import com.android.incallui.InCallVideoCallListenerNotifier.VideoEventListener;
import com.google.common.base.Preconditions;
import java.util.Objects;
/**
* Logic related to the {@link VideoCallFragment} and for managing changes to the video calling
* surfaces based on other user interface events and incoming events from the
* {@class VideoCallListener}.
* <p>
* When a call's video state changes to bi-directional video, the
* {@link com.android.incallui.VideoCallPresenter} performs the following negotiation with the
* telephony layer:
* <ul>
* <li>{@code VideoCallPresenter} creates and informs telephony of the display surface.</li>
* <li>{@code VideoCallPresenter} creates the preview surface.</li>
* <li>{@code VideoCallPresenter} informs telephony of the currently selected camera.</li>
* <li>Telephony layer sends {@link CameraCapabilities}, including the
* dimensions of the video for the current camera.</li>
* <li>{@code VideoCallPresenter} adjusts size of the preview surface to match the aspect
* ratio of the camera.</li>
* <li>{@code VideoCallPresenter} informs telephony of the new preview surface.</li>
* </ul>
* <p>
* When downgrading to an audio-only video state, the {@code VideoCallPresenter} nulls both
* surfaces.
*/
public class VideoCallPresenter extends Presenter<VideoCallPresenter.VideoCallUi> implements
IncomingCallListener, InCallOrientationListener, InCallStateListener,
InCallDetailsListener, SurfaceChangeListener, VideoEventListener,
InCallVideoCallListenerNotifier.SessionModificationListener {
private static final String TAG = VideoCallPresenter.class.getSimpleName();
public static final boolean DEBUG = false;
/**
* Determines the device orientation (portrait/lanscape).
*/
public int getDeviceOrientation() {
return mDeviceOrientation;
}
/**
* Defines the state of the preview surface negotiation with the telephony layer.
*/
private class PreviewSurfaceState {
/**
* The camera has not yet been set on the {@link VideoCall}; negotiation has not yet
* started.
*/
private static final int NONE = 0;
/**
* The camera has been set on the {@link VideoCall}, but camera capabilities have not yet
* been received.
*/
private static final int CAMERA_SET = 1;
/**
* The camera capabilties have been received from telephony, but the surface has not yet
* been set on the {@link VideoCall}.
*/
private static final int CAPABILITIES_RECEIVED = 2;
/**
* The surface has been set on the {@link VideoCall}.
*/
private static final int SURFACE_SET = 3;
}
/**
* The minimum width or height of the preview surface. Used when re-sizing the preview surface
* to match the aspect ratio of the currently selected camera.
*/
private float mMinimumVideoDimension;
/**
* The current context.
*/
private Context mContext;
/**
* The call the video surfaces are currently related to
*/
private Call mPrimaryCall;
/**
* The {@link VideoCall} used to inform the video telephony layer of changes to the video
* surfaces.
*/
private VideoCall mVideoCall;
/**
* Determines if the current UI state represents a video call.
*/
private boolean mIsVideoCall;
/**
* Determines the device orientation (portrait/lanscape).
*/
private int mDeviceOrientation;
/**
* Tracks the state of the preview surface negotiation with the telephony layer.
*/
private int mPreviewSurfaceState = PreviewSurfaceState.NONE;
/**
* Determines whether the video surface is in full-screen mode.
*/
private boolean mIsFullScreen = false;
/**
* Saves the audio mode which was selected prior to going into a video call.
*/
private int mPreVideoAudioMode = AudioModeProvider.AUDIO_MODE_INVALID;
/** Handler which resets request state to NO_REQUEST after an interval. */
private Handler mSessionModificationResetHandler;
private static final long SESSION_MODIFICATION_RESET_DELAY_MS = 3000;
/**
* Initializes the presenter.
*
* @param context The current context.
*/
public void init(Context context) {
mContext = Preconditions.checkNotNull(context);
mMinimumVideoDimension = mContext.getResources().getDimension(
R.dimen.video_preview_small_dimension);
mSessionModificationResetHandler = new Handler();
}
/**
* Called when the user interface is ready to be used.
*
* @param ui The Ui implementation that is now ready to be used.
*/
@Override
public void onUiReady(VideoCallUi ui) {
super.onUiReady(ui);
// Register for call state changes last
InCallPresenter.getInstance().addListener(this);
InCallPresenter.getInstance().addIncomingCallListener(this);
InCallPresenter.getInstance().addOrientationListener(this);
// Register for surface and video events from {@link InCallVideoCallListener}s.
InCallVideoCallListenerNotifier.getInstance().addSurfaceChangeListener(this);
InCallVideoCallListenerNotifier.getInstance().addVideoEventListener(this);
InCallVideoCallListenerNotifier.getInstance().addSessionModificationListener(this);
mIsVideoCall = false;
}
/**
* Called when the user interface is no longer ready to be used.
*
* @param ui The Ui implementation that is no longer ready to be used.
*/
@Override
public void onUiUnready(VideoCallUi ui) {
super.onUiUnready(ui);
InCallPresenter.getInstance().removeListener(this);
InCallPresenter.getInstance().removeIncomingCallListener(this);
InCallPresenter.getInstance().removeOrientationListener(this);
InCallVideoCallListenerNotifier.getInstance().removeSurfaceChangeListener(this);
InCallVideoCallListenerNotifier.getInstance().removeVideoEventListener(this);
InCallVideoCallListenerNotifier.getInstance().removeSessionModificationListener(this);
}
/**
* @return The {@link VideoCall}.
*/
private VideoCall getVideoCall() {
return mVideoCall;
}
/**
* Handles the creation of a surface in the {@link VideoCallFragment}.
*
* @param surface The surface which was created.
*/
public void onSurfaceCreated(int surface) {
if (DEBUG) {
Log.i(TAG, "onSurfaceCreated: " + surface);
}
final VideoCallUi ui = getUi();
if (ui == null || mVideoCall == null) {
return;
}
// If the preview surface has just been created and we have already received camera
// capabilities, but not yet set the surface, we will set the surface now.
if (surface == VideoCallFragment.SURFACE_PREVIEW &&
mPreviewSurfaceState == PreviewSurfaceState.CAPABILITIES_RECEIVED) {
mPreviewSurfaceState = PreviewSurfaceState.SURFACE_SET;
mVideoCall.setPreviewSurface(ui.getPreviewVideoSurface());
} else if (surface == VideoCallFragment.SURFACE_DISPLAY) {
mVideoCall.setDisplaySurface(ui.getDisplayVideoSurface());
}
}
/**
* Handles structural changes (format or size) to a surface.
*
* @param surface The surface which changed.
* @param format The new PixelFormat of the surface.
* @param width The new width of the surface.
* @param height The new height of the surface.
*/
public void onSurfaceChanged(int surface, int format, int width, int height) {
//Do stuff
}
/**
* Handles the destruction of a surface in the {@link VideoCallFragment}.
*
* @param surface The surface which was destroyed.
*/
public void onSurfaceDestroyed(int surface) {
final VideoCallUi ui = getUi();
if (ui == null || mVideoCall == null) {
return;
}
if (surface == VideoCallFragment.SURFACE_DISPLAY) {
mVideoCall.setDisplaySurface(null);
} else if (surface == VideoCallFragment.SURFACE_PREVIEW) {
mVideoCall.setPreviewSurface(null);
// Also disable camera as preview is closed
mVideoCall.setCamera(null);
}
}
/**
* Handles clicks on the video surfaces by toggling full screen state.
* Informs the {@link InCallPresenter} of the change so that it can inform the
* {@link CallCardPresenter} of the change.
*
* @param surfaceId The video surface receiving the click.
*/
public void onSurfaceClick(int surfaceId) {
mIsFullScreen = !mIsFullScreen;
InCallPresenter.getInstance().setFullScreenVideoState(mIsFullScreen);
}
/**
* Handles incoming calls.
*
* @param state The in call state.
* @param call The call.
*/
@Override
public void onIncomingCall(InCallPresenter.InCallState oldState,
InCallPresenter.InCallState newState, Call call) {
// same logic should happen as with onStateChange()
onStateChange(oldState, newState, CallList.getInstance());
}
/**
* Handles state changes (including incoming calls)
*
* @param newState The in call state.
* @param callList The call list.
*/
@Override
public void onStateChange(InCallPresenter.InCallState oldState,
InCallPresenter.InCallState newState, CallList callList) {
// Bail if video calling is disabled for the device.
if (!CallUtil.isVideoEnabled(mContext)) {
return;
}
if (newState == InCallPresenter.InCallState.NO_CALLS) {
exitVideoMode();
}
// Determine the primary active call).
Call primary = null;
if (newState == InCallPresenter.InCallState.INCOMING) {
primary = callList.getIncomingCall();
} else if (newState == InCallPresenter.InCallState.OUTGOING) {
primary = callList.getOutgoingCall();
} else if (newState == InCallPresenter.InCallState.INCALL) {
primary = callList.getActiveCall();
}
final boolean primaryChanged = !Objects.equals(mPrimaryCall, primary);
if (primaryChanged) {
mPrimaryCall = primary;
if (primary != null) {
checkForVideoCallChange();
mIsVideoCall = mPrimaryCall.isVideoCall(mContext);
if (mIsVideoCall) {
enterVideoMode();
} else {
exitVideoMode();
}
} else if (primary == null) {
// If no primary call, ensure we exit video state and clean up the video surfaces.
exitVideoMode();
}
}
}
/**
* Handles changes to the details of the call. The {@link VideoCallPresenter} is interested in
* changes to the video state.
*
* @param call The call for which the details changed.
* @param details The new call details.
*/
@Override
public void onDetailsChanged(Call call, android.telecom.Call.Details details) {
// If the details change is not for the currently active call no update is required.
if (!call.equals(mPrimaryCall)) {
return;
}
checkForVideoStateChange();
}
/**
* Checks for a change to the video call and changes it if required.
*/
private void checkForVideoCallChange() {
VideoCall videoCall = mPrimaryCall.getTelecommCall().getVideoCall();
if (!Objects.equals(videoCall, mVideoCall)) {
changeVideoCall(videoCall);
}
}
/**
* Checks to see if the current video state has changed and updates the UI if required.
*/
private void checkForVideoStateChange() {
boolean newVideoState = mPrimaryCall.isVideoCall(mContext);
// Check if video state changed
if (mIsVideoCall != newVideoState) {
mIsVideoCall = newVideoState;
if (mIsVideoCall) {
enterVideoMode();
} else {
exitVideoMode();
}
}
}
/**
* Handles a change to the video call. Sets the surfaces on the previous call to null and sets
* the surfaces on the new video call accordingly.
*
* @param videoCall The new video call.
*/
private void changeVideoCall(VideoCall videoCall) {
// Null out the surfaces on the previous video call.
if (mVideoCall != null) {
mVideoCall.setDisplaySurface(null);
mVideoCall.setPreviewSurface(null);
}
mVideoCall = videoCall;
}
/**
* Enters video mode by showing the video surfaces and making other adjustments (eg. audio).
* TODO(vt): Need to adjust size and orientation of preview surface here.
*/
private void enterVideoMode() {
if (DEBUG) {
Log.i(TAG, "enterVideoMode");
}
VideoCallUi ui = getUi();
if (ui == null) {
return;
}
ui.showVideoUi(true);
InCallPresenter.getInstance().setInCallAllowsOrientationChange(true);
// Communicate the current camera to telephony and make a request for the camera
// capabilities.
if (mVideoCall != null) {
// Do not reset the surfaces if we just restarted the activity due to an orientation
// change.
if (ui.isActivityRestart()) {
return;
}
mPreviewSurfaceState = PreviewSurfaceState.CAMERA_SET;
InCallCameraManager cameraManager = InCallPresenter.getInstance().
getInCallCameraManager();
mVideoCall.setCamera(cameraManager.getActiveCameraId());
mVideoCall.requestCameraCapabilities();
if (DEBUG) {
Log.i(TAG, "isDisplayVideoSurfacedCreated: " + ui.isDisplayVideoSurfaceCreated());
}
if (ui.isDisplayVideoSurfaceCreated()) {
mVideoCall.setDisplaySurface(ui.getDisplayVideoSurface());
}
}
mPreVideoAudioMode = AudioModeProvider.getInstance().getAudioMode();
TelecomAdapter.getInstance().setAudioRoute(AudioState.ROUTE_SPEAKER);
}
/**
* Exits video mode by hiding the video surfaces and making other adjustments (eg. audio).
*/
private void exitVideoMode() {
VideoCallUi ui = getUi();
if (ui == null) {
return;
}
InCallPresenter.getInstance().setInCallAllowsOrientationChange(false);
ui.showVideoUi(false);
if (mPreVideoAudioMode != AudioModeProvider.AUDIO_MODE_INVALID) {
TelecomAdapter.getInstance().setAudioRoute(mPreVideoAudioMode);
mPreVideoAudioMode = AudioModeProvider.AUDIO_MODE_INVALID;
}
}
/**
* Handles peer video pause state changes.
*
* @param call The call which paused or un-pausedvideo transmission.
* @param paused {@code True} when the video transmission is paused, {@code false} when video
* transmission resumes.
*/
@Override
public void onPeerPauseStateChanged(Call call, boolean paused) {
if (!call.equals(mPrimaryCall)) {
return;
}
// TODO(vt): Show/hide the peer contact photo.
}
/**
* Handles peer video dimension changes.
*
* @param call The call which experienced a peer video dimension change.
* @param width The new peer video width .
* @param height The new peer video height.
*/
@Override
public void onUpdatePeerDimensions(Call call, int width, int height) {
if (!call.equals(mPrimaryCall)) {
return;
}
// TODO(vt): Change display surface aspect ratio.
}
/**
* Handles a change to the dimensions of the local camera. Receiving the camera capabilities
* triggers the creation of the video
*
* @param call The call which experienced the camera dimension change.
* @param width The new camera video width.
* @param height The new camera video height.
*/
@Override
public void onCameraDimensionsChange(Call call, int width, int height) {
VideoCallUi ui = getUi();
if (ui == null) {
return;
}
if (!call.equals(mPrimaryCall)) {
return;
}
mPreviewSurfaceState = PreviewSurfaceState.CAPABILITIES_RECEIVED;
// Configure the preview surface to the correct aspect ratio.
float aspectRatio = 1.0f;
if (width > 0 && height > 0) {
aspectRatio = (float) width / (float) height;
}
setPreviewSize(mDeviceOrientation, aspectRatio);
// Check if the preview surface is ready yet; if it is, set it on the {@code VideoCall}.
// If it not yet ready, it will be set when when creation completes.
if (ui.isPreviewVideoSurfaceCreated()) {
mPreviewSurfaceState = PreviewSurfaceState.SURFACE_SET;
mVideoCall.setPreviewSurface(ui.getPreviewVideoSurface());
}
}
/**
* Handles hanges to the device orientation.
* See: {@link Configuration.ORIENTATION_LANDSCAPE}, {@link Configuration.ORIENTATION_PORTRAIT}
* @param orientation The device orientation.
*/
@Override
public void onDeviceOrientationChanged(int orientation) {
mDeviceOrientation = orientation;
}
@Override
public void onUpgradeToVideoRequest(Call call) {
mPrimaryCall.setSessionModificationState(
Call.SessionModificationState.RECEIVED_UPGRADE_TO_VIDEO_REQUEST);
}
@Override
public void onUpgradeToVideoSuccess(Call call) {
if (mPrimaryCall == null || !Call.areSame(mPrimaryCall, call)) {
return;
}
mPrimaryCall.setSessionModificationState(Call.SessionModificationState.NO_REQUEST);
}
@Override
public void onUpgradeToVideoFail(Call call) {
if (mPrimaryCall == null || !Call.areSame(mPrimaryCall, call)) {
return;
}
call.setSessionModificationState(Call.SessionModificationState.REQUEST_FAILED);
// Start handler to change state from REQUEST_FAILED to NO_REQUEST after an interval.
mSessionModificationResetHandler.postDelayed(new Runnable() {
@Override
public void run() {
mPrimaryCall.setSessionModificationState(Call.SessionModificationState.NO_REQUEST);
}
}, SESSION_MODIFICATION_RESET_DELAY_MS);
}
@Override
public void onDowngradeToAudio(Call call) {
// Implementing to satisfy interface.
}
/**
* Sets the preview surface size based on the current device orientation.
* See: {@link Configuration.ORIENTATION_LANDSCAPE}, {@link Configuration.ORIENTATION_PORTRAIT}
*
* @param orientation The device orientation.
* @param aspectRatio The aspect ratio of the camera (width / height).
*/
private void setPreviewSize(int orientation, float aspectRatio) {
VideoCallUi ui = getUi();
if (ui == null) {
return;
}
int height;
int width;
if (orientation == Configuration.ORIENTATION_LANDSCAPE) {
width = (int) (mMinimumVideoDimension * aspectRatio);
height = (int) mMinimumVideoDimension;
} else {
width = (int) mMinimumVideoDimension;
height = (int) (mMinimumVideoDimension * aspectRatio);
}
ui.setPreviewSize(width, height);
}
/**
* Defines the VideoCallUI interactions.
*/
public interface VideoCallUi extends Ui {
void showVideoUi(boolean show);
boolean isDisplayVideoSurfaceCreated();
boolean isPreviewVideoSurfaceCreated();
Surface getDisplayVideoSurface();
Surface getPreviewVideoSurface();
void setPreviewSize(int width, int height);
void cleanupSurfaces();
boolean isActivityRestart();
}
}
|