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
|
/*
* Copyright (C) 2016 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.internal;
import android.telecom.Log;
import android.telecom.VideoProfile;
import android.util.ArraySet;
import java.util.Collection;
import java.util.Set;
import java.util.StringJoiner;
import java.util.stream.Collectors;
/**
* Used by an {@link ImsVideoCallProviderWrapper} to track requests to pause video from various
* sources.
*
* Requests to pause the video stream using the {@link VideoProfile#STATE_PAUSED} bit can come
* from both the {@link android.telecom.InCallService}, as well as via the
* {@link ImsVideoCallProviderWrapper#pauseVideo(int, int)} and
* {@link ImsVideoCallProviderWrapper#resumeVideo(int, int)} methods. As a result, multiple sources
* can potentially pause or resume the video stream.
*
* This class is responsible for tracking any active requests to pause the video.
*/
public class VideoPauseTracker {
/** The pause or resume request originated from an InCallService. */
public static final int SOURCE_INCALL = 1;
/**
* The pause or resume request originated from a change to the data enabled state from the
* {@code ImsPhoneCallTracker#onDataEnabledChanged(boolean, int)} callback. This happens when
* the user reaches their data limit or enables and disables data.
*/
public static final int SOURCE_DATA_ENABLED = 2;
private static final String SOURCE_INCALL_STR = "INCALL";
private static final String SOURCE_DATA_ENABLED_STR = "DATA_ENABLED";
/**
* Tracks the current sources of pause requests.
*/
private Set<Integer> mPauseRequests = new ArraySet<Integer>(2);
/**
* Lock for the {@link #mPauseRequests} {@link ArraySet}.
*/
private Object mPauseRequestsLock = new Object();
/**
* Tracks a request to pause the video for a source (see {@link #SOURCE_DATA_ENABLED},
* {@link #SOURCE_INCALL}) and determines whether a pause request should be issued to the
* video provider.
*
* We want to issue a pause request to the provider when we receive the first request
* to pause via any source and we're not already paused.
*
* @param source The source of the pause request.
* @return {@code true} if a pause should be issued to the
* {@link com.android.ims.internal.ImsVideoCallProvider}, {@code false} otherwise.
*/
public boolean shouldPauseVideoFor(int source) {
synchronized (mPauseRequestsLock) {
boolean wasPaused = isPaused();
mPauseRequests.add(source);
if (!wasPaused) {
Log.i(this, "shouldPauseVideoFor: source=%s, pendingRequests=%s - should pause",
sourceToString(source), sourcesToString(mPauseRequests));
// There were previously no pause requests, but there is one now, so pause.
return true;
} else {
Log.i(this, "shouldPauseVideoFor: source=%s, pendingRequests=%s - already paused",
sourceToString(source), sourcesToString(mPauseRequests));
// There were already pause requests, so no need to re-pause.
return false;
}
}
}
/**
* Tracks a request to resume the video for a source (see {@link #SOURCE_DATA_ENABLED},
* {@link #SOURCE_INCALL}) and determines whether a resume request should be issued to the
* video provider.
*
* We want to issue a resume request to the provider when we have issued a corresponding
* resume for each previously issued pause.
*
* @param source The source of the resume request.
* @return {@code true} if a resume should be issued to the
* {@link com.android.ims.internal.ImsVideoCallProvider}, {@code false} otherwise.
*/
public boolean shouldResumeVideoFor(int source) {
synchronized (mPauseRequestsLock) {
boolean wasPaused = isPaused();
mPauseRequests.remove(source);
boolean isPaused = isPaused();
if (wasPaused && !isPaused) {
Log.i(this, "shouldResumeVideoFor: source=%s, pendingRequests=%s - should resume",
sourceToString(source), sourcesToString(mPauseRequests));
// This was the last pause request, so resume video.
return true;
} else if (wasPaused && isPaused) {
Log.i(this, "shouldResumeVideoFor: source=%s, pendingRequests=%s - stay paused",
sourceToString(source), sourcesToString(mPauseRequests));
// There are still pending pause requests, so don't resume.
return false;
} else {
Log.i(this, "shouldResumeVideoFor: source=%s, pendingRequests=%s - not paused",
sourceToString(source), sourcesToString(mPauseRequests));
// Although there are no pending pause requests, it is possible that we cleared the
// pause tracker because the video state reported we're un-paused. In this case it
// is benign to just allow the resume request to be sent since it'll have no effect.
// Re-writing it to squelch the resume would end up causing it to be a pause
// request, which is bad.
return true;
}
}
}
/**
* @return {@code true} if the video should be paused, {@code false} otherwise.
*/
public boolean isPaused() {
synchronized (mPauseRequestsLock) {
return !mPauseRequests.isEmpty();
}
}
/**
* @param source the source of the pause.
* @return {@code true} if the specified source initiated a pause request and the video is
* currently paused, {@code false} otherwise.
*/
public boolean wasVideoPausedFromSource(int source) {
synchronized (mPauseRequestsLock) {
return mPauseRequests.contains(source);
}
}
/**
* Clears pending pause requests for the tracker.
*/
public void clearPauseRequests() {
synchronized (mPauseRequestsLock) {
mPauseRequests.clear();
}
}
/**
* Returns a string equivalent of a {@code SOURCE_*} constant.
*
* @param source A {@code SOURCE_*} constant.
* @return String equivalent of the source.
*/
private String sourceToString(int source) {
switch (source) {
case SOURCE_DATA_ENABLED:
return SOURCE_DATA_ENABLED_STR;
case SOURCE_INCALL:
return SOURCE_INCALL_STR;
}
return "unknown";
}
/**
* Returns a comma separated list of sources.
*
* @param sources The sources.
* @return Comma separated list of sources.
*/
private String sourcesToString(Collection<Integer> sources) {
synchronized (mPauseRequestsLock) {
return sources.stream()
.map(source -> sourceToString(source))
.collect(Collectors.joining(", "));
}
}
}
|
