Skip to content

Commit

Permalink
Add support of screen streaming
Browse files Browse the repository at this point in the history
  • Loading branch information
@mykola-mokhnach
mykola-mokhnach committed Sep 8, 2024
1 parent d58e856 commit 342e1d4
Show file tree
Hide file tree
Showing 13 changed files with 946 additions and 121 deletions.
1 change: 1 addition & 0 deletions app/build.gradle
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ android {
dependencies {
implementation 'com.google.android.gms:play-services-location:21.3.0'
implementation 'org.apache.commons:commons-lang3:3.17.0'
implementation 'org.java-websocket:Java-WebSocket:1.5.7'
}

static def renameAPK(variant) {
Expand Down
7 changes: 7 additions & 0 deletions app/src/main/AndroidManifest.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,13 @@
android:permission="android.permission.RECORD_AUDIO">
</service>

<service
android:foregroundServiceType="mediaProjection"
android:name=".streaming.StreamingService"
android:exported="true"
android:permission="android.permission.RECORD_AUDIO">
</service>

<service
android:name=".AppiumIME"
android:label="Appium IME"
Expand Down
219 changes: 136 additions & 83 deletions app/src/main/java/io/appium/settings/Settings.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,23 +46,32 @@
import io.appium.settings.receivers.UnpairBluetoothDevicesReceiver;
import io.appium.settings.receivers.WiFiConnectionSettingReceiver;
import io.appium.settings.recorder.RecorderService;
import io.appium.settings.recorder.RecorderUtil;

import static io.appium.settings.recorder.RecorderConstant.ACTION_RECORDING_BASE;
import static io.appium.settings.recorder.RecorderConstant.ACTION_RECORDING_FILENAME;
import static io.appium.settings.recorder.RecorderConstant.ACTION_RECORDING_MAX_DURATION;
import static io.appium.settings.recorder.RecorderConstant.ACTION_RECORDING_PRIORITY;
import static io.appium.settings.recorder.RecorderConstant.ACTION_RECORDING_RESOLUTION;
import static io.appium.settings.recorder.RecorderConstant.ACTION_RECORDING_RESULT_CODE;
import static io.appium.settings.recorder.RecorderConstant.ACTION_RECORDING_ROTATION;
import static io.appium.settings.recorder.RecorderConstant.ACTION_RECORDING_START;
import static io.appium.settings.recorder.RecorderConstant.ACTION_RECORDING_STOP;
import static io.appium.settings.recorder.RecorderConstant.NO_PATH_SET;
import static io.appium.settings.recorder.RecorderConstant.NO_RESOLUTION_MODE_SET;
import static io.appium.settings.recorder.RecorderConstant.RECORDING_MAX_DURATION_DEFAULT_MS;
import static io.appium.settings.recorder.RecorderConstant.RECORDING_PRIORITY_DEFAULT;
import static io.appium.settings.recorder.RecorderConstant.RECORDING_ROTATION_DEFAULT_DEGREE;
import static io.appium.settings.recorder.RecorderConstant.REQUEST_CODE_SCREEN_CAPTURE;
import io.appium.settings.helpers.RecorderUtil;
import io.appium.settings.streaming.StreamingService;

import static io.appium.settings.helpers.RecorderConstant.ACTION_RECORDING_BASE;
import static io.appium.settings.helpers.RecorderConstant.ACTION_RECORDING_FILENAME;
import static io.appium.settings.helpers.RecorderConstant.ACTION_RECORDING_MAX_DURATION;
import static io.appium.settings.helpers.RecorderConstant.ACTION_STREAMING_PORT;
import static io.appium.settings.helpers.RecorderConstant.ACTION_RECORDING_PRIORITY;
import static io.appium.settings.helpers.RecorderConstant.ACTION_RECORDING_RESOLUTION;
import static io.appium.settings.helpers.RecorderConstant.ACTION_RECORDING_RESULT_CODE;
import static io.appium.settings.helpers.RecorderConstant.ACTION_RECORDING_ROTATION;
import static io.appium.settings.helpers.RecorderConstant.ACTION_RECORDING_START;
import static io.appium.settings.helpers.RecorderConstant.ACTION_RECORDING_STOP;
import static io.appium.settings.helpers.RecorderConstant.ACTION_STREAMING_BASE;
import static io.appium.settings.helpers.RecorderConstant.ACTION_STREAMING_START;
import static io.appium.settings.helpers.RecorderConstant.ACTION_STREAMING_STOP;
import static io.appium.settings.helpers.RecorderConstant.NO_PATH_SET;
import static io.appium.settings.helpers.RecorderConstant.NO_RESOLUTION_MODE_SET;
import static io.appium.settings.helpers.RecorderConstant.RECORDING_MAX_DURATION_DEFAULT_MS;
import static io.appium.settings.helpers.RecorderConstant.RECORDING_PRIORITY_DEFAULT;
import static io.appium.settings.helpers.RecorderConstant.RECORDING_ROTATION_DEFAULT_DEGREE;
import static io.appium.settings.helpers.RecorderConstant.REQUEST_CODE_SCREEN_CAPTURE;
import static io.appium.settings.helpers.RecorderConstant.REQUEST_CODE_SCREEN_STREAM;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;

public class Settings extends Activity {
private static final String TAG = "APPIUM SETTINGS";
Expand All @@ -71,6 +80,7 @@ public class Settings extends Activity {
private int recordingRotation = RECORDING_ROTATION_DEFAULT_DEGREE;
private int recordingPriority = RECORDING_PRIORITY_DEFAULT;
private int recordingMaxDuration = RECORDING_MAX_DURATION_DEFAULT_MS;
private int streamingPort = 0;
private String recordingResolutionMode = NO_RESOLUTION_MODE_SET;

@Override
Expand Down Expand Up @@ -101,49 +111,23 @@ public void onCreate(Bundle savedInstanceState) {
LocationTracker.getInstance().start(this);
}

handleRecording(getIntent());
}

private void handleRecording(Intent intent) {
if (intent == null) {
Log.e(TAG, "handleRecording: Unable to retrieve intent instance");
if (!handleScreenRecordingIfRequested(getIntent())
&& !handleScreenStreamingIfRequested(getIntent())) {
finishActivity();
return;
}
}

String recordingAction = intent.getAction();
private boolean handleScreenRecordingIfRequested(Intent intent) {
String recordingAction = checkIntent(intent, ACTION_RECORDING_BASE);
if (recordingAction == null) {
Log.e(TAG, "handleRecording: Unable to retrieve intent.action instance");
finishActivity();
return;
}

if (!recordingAction.startsWith(ACTION_RECORDING_BASE)) {
Log.i(TAG, "handleRecording: Received different intent with action: "
+ recordingAction);
finishActivity();
return;
}

if (RecorderUtil.isLowerThanQ()) {
Log.e(TAG, "handleRecording: Current Android OS Version is lower than Q");
finishActivity();
return;
return false;
}

if (!RecorderUtil.areRecordingPermissionsGranted(getApplicationContext())) {
Log.e(TAG, "handleRecording: Required permissions are not granted");
finishActivity();
return;
}

if (recordingAction.equals(ACTION_RECORDING_START)) {
String recordingFilename = intent.getStringExtra(ACTION_RECORDING_FILENAME);
if (!RecorderUtil.isValidFileName(recordingFilename)) {
Log.e(TAG, "handleRecording: Invalid filename passed by user: "
+ recordingFilename);
finishActivity();
return;
return false;
}

/*
Expand All @@ -159,50 +143,79 @@ so we need to call getExternalFilesDir() method twice
// if path is still null despite calling method twice, early exit
if (externalStorageFile == null) {
Log.e(TAG, "handleRecording: Unable to retrieve external storage file path");
finishActivity();
return;
return false;
}
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
recordingOutputPath = Paths
.get(externalStorageFile.getAbsolutePath(), recordingFilename)
.toAbsolutePath()
.toString();
}

recordingOutputPath = Paths
.get(externalStorageFile.getAbsolutePath(), recordingFilename)
.toAbsolutePath()
.toString();

recordingRotation = RecorderUtil.getDeviceRotationInDegree(getApplicationContext());

recordingPriority = RecorderUtil.getRecordingPriority(intent);

recordingMaxDuration = RecorderUtil.getRecordingMaxDuration(intent);

recordingResolutionMode = RecorderUtil.getRecordingResolutionMode(intent);

// start record
final MediaProjectionManager manager
= (MediaProjectionManager) getSystemService(
Context.MEDIA_PROJECTION_SERVICE);

final MediaProjectionManager manager = (MediaProjectionManager) getSystemService(
Context.MEDIA_PROJECTION_SERVICE
);
if (manager == null) {
Log.e(TAG, "handleRecording: " +
"Unable to retrieve MediaProjectionManager instance");
finishActivity();
return;
return false;
}

final Intent permissionIntent = manager.createScreenCaptureIntent();

startActivityForResult(permissionIntent, REQUEST_CODE_SCREEN_CAPTURE);
return true;
} else if (recordingAction.equals(ACTION_RECORDING_STOP)) {
// stop record
final Intent recorderIntent = new Intent(this, RecorderService.class);
recorderIntent.setAction(ACTION_RECORDING_STOP);
startService(recorderIntent);

finishActivity();
} else {
Log.e(TAG, "handleRecording: Unknown recording intent with action:"
+ recordingAction);
finishActivity();
}
return false;
}

private boolean handleScreenStreamingIfRequested(Intent intent) {
String streamingAction = checkIntent(intent, ACTION_STREAMING_BASE);
if (streamingAction == null) {
return false;
}
if (streamingAction.equals(ACTION_STREAMING_START)) {
streamingPort = intent.getIntExtra(ACTION_STREAMING_PORT, 0);
if (streamingPort <= 0) {
Log.e(TAG, "handleStreaming: Invalid port provided by user: " + streamingPort);
return false;
}
recordingMaxDuration = RecorderUtil.getRecordingMaxDuration(intent);
recordingResolutionMode = RecorderUtil.getRecordingResolutionMode(intent);

// start record
final MediaProjectionManager manager = (MediaProjectionManager) getSystemService(
Context.MEDIA_PROJECTION_SERVICE
);
if (manager == null) {
Log.e(TAG, "handleStreaming: " +
"Unable to retrieve MediaProjectionManager instance");
return false;
}
final Intent permissionIntent = manager.createScreenCaptureIntent();
startActivityForResult(permissionIntent, REQUEST_CODE_SCREEN_STREAM);
return true;
} else if (streamingAction.equals(ACTION_STREAMING_STOP)) {
// stop record
final Intent streamingIntent = new Intent(this, StreamingService.class);
streamingIntent.setAction(ACTION_STREAMING_STOP);
startService(streamingIntent);
} else {
Log.e(TAG, "handleStreaming: Unknown recording intent with action:"
+ streamingAction);
}
return false;
}

private void finishActivity() {
Expand All @@ -211,25 +224,61 @@ private void finishActivity() {
handler.postDelayed(Settings.this::finish, 0);
}

private @Nullable String checkIntent(Intent intent, String action) {
if (intent == null) {
Log.e(TAG, "Unable to retrieve intent instance");
return null;
}
String result = intent.getAction();
if (result == null) {
Log.e(TAG, "Unable to retrieve intent.action instance");
return null;
}
if (!result.startsWith(action)) {
Log.i(TAG, "Received different intent with action: "
+ result);
return null;
}
if (RecorderUtil.isLowerThanQ()) {
Log.e(TAG, "Current Android OS Version is lower than Q");
return null;
}
if (!RecorderUtil.areRecordingPermissionsGranted(getApplicationContext())) {
Log.e(TAG, "Required permissions are not granted");
return null;
}
return result;
}

@Override
protected void onActivityResult(final int requestCode, final int resultCode, final Intent data)
{
super.onActivityResult(requestCode, resultCode, data);
if (REQUEST_CODE_SCREEN_CAPTURE != requestCode) {
Log.e(TAG, "handleRecording: onActivityResult: " +
"Received unknown request with code: " + requestCode);

if (REQUEST_CODE_SCREEN_CAPTURE != requestCode && REQUEST_CODE_SCREEN_STREAM != requestCode) {
Log.e(TAG, "onActivityResult: Received unknown request with code: " + requestCode);
finishActivity();
return;
}

if (resultCode != Activity.RESULT_OK) {
Log.e(TAG, "handleRecording: onActivityResult: " +
Log.e(TAG, "onActivityResult: " +
"MediaProjection permission is not granted, " +
"Did you apply appops adb command?");
finishActivity();
return;
}

Intent intent = REQUEST_CODE_SCREEN_CAPTURE == requestCode
? createScreenRecordingIntent(resultCode)
: createScreenStreamingIntent(resultCode);
intent.putExtras(data);
startService(intent);

finishActivity();
}

private @NonNull Intent createScreenRecordingIntent(int resultCode) {
final Intent intent = new Intent(this, RecorderService.class);
intent.setAction(ACTION_RECORDING_START);
intent.putExtra(ACTION_RECORDING_RESULT_CODE, resultCode);
Expand All @@ -238,11 +287,17 @@ protected void onActivityResult(final int requestCode, final int resultCode, fin
intent.putExtra(ACTION_RECORDING_PRIORITY, recordingPriority);
intent.putExtra(ACTION_RECORDING_MAX_DURATION, recordingMaxDuration);
intent.putExtra(ACTION_RECORDING_RESOLUTION, recordingResolutionMode);
intent.putExtras(data);

startService(intent);
return intent;
}

finishActivity();
private @NonNull Intent createScreenStreamingIntent(int resultCode) {
final Intent intent = new Intent(this, StreamingService.class);
intent.setAction(ACTION_STREAMING_START);
intent.putExtra(ACTION_RECORDING_RESULT_CODE, resultCode);
intent.putExtra(ACTION_STREAMING_PORT, streamingPort);
intent.putExtra(ACTION_RECORDING_MAX_DURATION, recordingMaxDuration);
intent.putExtra(ACTION_RECORDING_RESOLUTION, recordingResolutionMode);
return intent;
}

private void registerSettingsReceivers(List<Class<? extends BroadcastReceiver>> receiverClasses)
Expand All @@ -252,9 +307,7 @@ private void registerSettingsReceivers(List<Class<? extends BroadcastReceiver>>
final BroadcastReceiver receiver = receiverClass.newInstance();
IntentFilter filter = new IntentFilter(((HasAction) receiver).getAction());
getApplicationContext().registerReceiver(receiver, filter);
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (InstantiationException e) {
} catch (IllegalAccessException | InstantiationException e) {
e.printStackTrace();
}
}
Expand Down
7 changes: 6 additions & 1 deletion ...m/settings/recorder/RecorderConstant.java → ...um/settings/helpers/RecorderConstant.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
limitations under the License.
*/

package io.appium.settings.recorder;
package io.appium.settings.helpers;

import android.media.MediaFormat;
import android.util.Size;
Expand All @@ -26,12 +26,17 @@

public class RecorderConstant {
public static final int REQUEST_CODE_SCREEN_CAPTURE = 123;
public static final int REQUEST_CODE_SCREEN_STREAM = 124;
public static final String ACTION_RECORDING_BASE = BuildConfig.APPLICATION_ID + ".recording";
public static final String ACTION_STREAMING_BASE = BuildConfig.APPLICATION_ID + ".streaming";
public static final String ACTION_RECORDING_START = ACTION_RECORDING_BASE + ".ACTION_START";
public static final String ACTION_RECORDING_STOP = ACTION_RECORDING_BASE + ".ACTION_STOP";
public static final String ACTION_STREAMING_START = ACTION_STREAMING_BASE + ".ACTION_START";
public static final String ACTION_STREAMING_STOP = ACTION_STREAMING_BASE + ".ACTION_STOP";
public static final String ACTION_RECORDING_RESULT_CODE = "result_code";
public static final String ACTION_RECORDING_ROTATION = "recording_rotation";
public static final String ACTION_RECORDING_FILENAME = "filename";
public static final String ACTION_STREAMING_PORT = "port";
public static final String ACTION_RECORDING_PRIORITY = "priority";
public static final String ACTION_RECORDING_MAX_DURATION = "max_duration_sec";
public static final String ACTION_RECORDING_RESOLUTION = "resolution";
Expand Down
Loading

0 comments on commit 342e1d4

Please sign in to comment.