Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 2fffd22b authored by Jacky Kao's avatar Jacky Kao
Browse files

Changing the return type of takeScreenshot() (2/n) 

Implementing the new return type for A11y services to take
the screenshot of the specified display.
boolean takeScreenshot(int displayId,
@NonNull @CallbackExecutor Executor executor,
@NonNull Consumer<ScreenshotResult> callback)
The return type is a new class, ScreenshotResult, including
hardwareBuffer, colorSpace, and timestamp. A11y services could
use the method, Bitmap#wrapHardwareBuffer, to obtain the bitmap.

Bug: 10931661
Test: a11y CTS & unit tests
Change-Id: I03eae10f0970d0e11e02c9d3f4031c4096b7b5b4
parent dc50df39

api/current.txt

+7 −1
Original line number Diff line number Diff line
@@ -2873,7 +2873,7 @@ package android.accessibilityservice { 
    method public void onSystemActionsChanged();

    method public final boolean performGlobalAction(int);

    method public final void setServiceInfo(android.accessibilityservice.AccessibilityServiceInfo);

    method public boolean takeScreenshot(int, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.graphics.Bitmap>);

    method public boolean takeScreenshot(int, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.accessibilityservice.AccessibilityService.ScreenshotResult>);

    field public static final int GESTURE_2_FINGER_DOUBLE_TAP = 20; // 0x14

    field public static final int GESTURE_2_FINGER_SINGLE_TAP = 19; // 0x13

    field public static final int GESTURE_2_FINGER_SWIPE_DOWN = 26; // 0x1a
@@ -2945,6 +2945,12 @@ package android.accessibilityservice { 
    method public void onMagnificationChanged(@NonNull android.accessibilityservice.AccessibilityService.MagnificationController, @NonNull android.graphics.Region, float, float, float);

  }













  public static final class AccessibilityService.ScreenshotResult {













    method @Nullable public android.graphics.ColorSpace getColorSpace();













    method @NonNull public android.hardware.HardwareBuffer getHardwareBuffer();













    method public long getTimestamp();













  }



























  public static final class AccessibilityService.SoftKeyboardController {















    method public void addOnShowModeChangedListener(@NonNull android.accessibilityservice.AccessibilityService.SoftKeyboardController.OnShowModeChangedListener);















    method public void addOnShowModeChangedListener(@NonNull android.accessibilityservice.AccessibilityService.SoftKeyboardController.OnShowModeChangedListener, @Nullable android.os.Handler);

























core/java/android/accessibilityservice/AccessibilityService.java



+90
−11




























Original line number
Diff line number
Diff line








@@ -28,7 +28,9 @@ import android.content.Context;













import android.content.Intent;















import android.content.pm.ParceledListSlice;















import android.graphics.Bitmap;













import android.graphics.ColorSpace;















import android.graphics.Region;













import android.hardware.HardwareBuffer;















import android.os.Binder;















import android.os.Build;















import android.os.Handler;










@@ -564,7 +566,12 @@ public abstract class AccessibilityService extends Service {













    private FingerprintGestureController mFingerprintGestureController;































    /** @hide */













    public static final String KEY_ACCESSIBILITY_SCREENSHOT = "screenshot";













    public static final String KEY_ACCESSIBILITY_SCREENSHOT_HARDWAREBUFFER =













            "screenshot_hardwareBuffer";



























    /** @hide */













    public static final String KEY_ACCESSIBILITY_SCREENSHOT_COLORSPACE_ID =













            "screenshot_colorSpaceId";































    /**















     * Callback for {@link android.view.accessibility.AccessibilityEvent}s.










@@ -1867,8 +1874,9 @@ public abstract class AccessibilityService extends Service {













    }































    /**













     * Takes a screenshot of the specified display and returns it by {@link Bitmap.Config#HARDWARE}













     * format.













     * Takes a screenshot of the specified display and returns it via an













     * {@link AccessibilityService.ScreenshotResult}. You can use {@link Bitmap#wrapHardwareBuffer}













     * to construct the bitmap from the ScreenshotResult's payload.















     * <p>















     * <strong>Note:</strong> In order to take screenshot your service has















     * to declare the capability to take screenshot by setting the









@@ -1886,7 +1894,7 @@ public abstract class AccessibilityService extends Service {













     * @return {@code true} if the taking screenshot accepted, {@code false} if not.















     */















    public boolean takeScreenshot(int displayId, @NonNull @CallbackExecutor Executor executor,













            @NonNull Consumer<Bitmap> callback) {













            @NonNull Consumer<ScreenshotResult> callback) {















        Preconditions.checkNotNull(executor, "executor cannot be null");















        Preconditions.checkNotNull(callback, "callback cannot be null");















        final IAccessibilityServiceConnection connection =









@@ -1896,14 +1904,22 @@ public abstract class AccessibilityService extends Service {













            return false;















        }















        try {













            connection.takeScreenshotWithCallback(displayId, new RemoteCallback((result) -> {













                final Bitmap screenshot = result.getParcelable(KEY_ACCESSIBILITY_SCREENSHOT);













                final long identity = Binder.clearCallingIdentity();













                try {













                    executor.execute(() -> callback.accept(screenshot));













                } finally {













                    Binder.restoreCallingIdentity(identity);













            connection.takeScreenshot(displayId, new RemoteCallback((result) -> {













                if (result == null) {













                    sendScreenshotResult(executor, callback, null);













                    return;















                }













                final HardwareBuffer hardwareBuffer =













                        result.getParcelable(KEY_ACCESSIBILITY_SCREENSHOT_HARDWAREBUFFER);













                final int colorSpaceId =













                        result.getInt(KEY_ACCESSIBILITY_SCREENSHOT_COLORSPACE_ID);













                ColorSpace colorSpace = null;













                if (colorSpaceId >= 0 && colorSpaceId < ColorSpace.Named.values().length) {













                    colorSpace = ColorSpace.get(ColorSpace.Named.values()[colorSpaceId]);













                }













                ScreenshotResult screenshot = new ScreenshotResult(hardwareBuffer,













                        colorSpace, System.currentTimeMillis());













                sendScreenshotResult(executor, callback, screenshot);















            }));















        } catch (RemoteException re) {















            throw new RuntimeException(re);










@@ -2302,4 +2318,67 @@ public abstract class AccessibilityService extends Service {













            this.handler = handler;















        }















    }



























    private void sendScreenshotResult(Executor executor, Consumer<ScreenshotResult> callback,













            ScreenshotResult screenshot) {













        final ScreenshotResult result = screenshot;













        final long identity = Binder.clearCallingIdentity();













        try {













            executor.execute(() -> callback.accept(result));













        } finally {













            Binder.restoreCallingIdentity(identity);













        }













    }



























    /**













     * Class including hardwareBuffer, colorSpace, and timestamp to be the result for













     * {@link AccessibilityService#takeScreenshot} API.













     * <p>













     * <strong>Note:</strong> colorSpace would be null if the name of this colorSpace isn't at













     * {@link ColorSpace.Named}.













     * </p>













     */













    public static final class ScreenshotResult {













        private final @NonNull HardwareBuffer mHardwareBuffer;













        private final @Nullable ColorSpace mColorSpace;













        private final long mTimestamp;



























        private ScreenshotResult(@NonNull HardwareBuffer hardwareBuffer,













                @Nullable ColorSpace colorSpace, long timestamp) {













            Preconditions.checkNotNull(hardwareBuffer, "hardwareBuffer cannot be null");













            mHardwareBuffer = hardwareBuffer;













            mColorSpace = colorSpace;













            mTimestamp = timestamp;













        }



























        /**













         * Gets the colorSpace identifying a specific organization of colors of the screenshot.













         *













         * @return the colorSpace or {@code null} if the name of colorSpace isn't at













         * {@link ColorSpace.Named}













         */













        @Nullable













        public ColorSpace getColorSpace() {













            return mColorSpace;













        }



























        /**













         * Gets the hardwareBuffer representing a memory buffer of the screenshot.













         *













         * @return the hardwareBuffer













         */













        @NonNull













        public HardwareBuffer getHardwareBuffer() {













            return mHardwareBuffer;













        }



























        /**













         * Gets the timestamp of taking the screenshot.













         *













         * @return the timestamp from {@link System#currentTimeMillis()}













         */













        public long getTimestamp() {













            return mTimestamp;













        };













    }















}
























core/java/android/accessibilityservice/IAccessibilityServiceConnection.aidl



+1
−3




























Original line number
Diff line number
Diff line








@@ -110,7 +110,5 @@ interface IAccessibilityServiceConnection {





























    int getWindowIdForLeashToken(IBinder token);





























    Bitmap takeScreenshot(int displayId);



























    void takeScreenshotWithCallback(int displayId, in RemoteCallback callback);













    void takeScreenshot(int displayId, in RemoteCallback callback);















}
























core/tests/coretests/src/android/view/accessibility/AccessibilityServiceConnectionImpl.java



+1
−6




























Original line number
Diff line number
Diff line








@@ -19,7 +19,6 @@ package android.view.accessibility;













import android.accessibilityservice.AccessibilityServiceInfo;















import android.accessibilityservice.IAccessibilityServiceConnection;















import android.content.pm.ParceledListSlice;













import android.graphics.Bitmap;















import android.graphics.Region;















import android.os.Bundle;















import android.os.IBinder;










@@ -157,9 +156,5 @@ public class AccessibilityServiceConnectionImpl extends IAccessibilityServiceCon













        return -1;















    }





























    public Bitmap takeScreenshot(int displayId) {













        return null;













    }



























    public void takeScreenshotWithCallback(int displayId, RemoteCallback callback) {}













    public void takeScreenshot(int displayId, RemoteCallback callback) {}















}
























services/accessibility/java/com/android/server/accessibility/AbstractAccessibilityServiceConnection.java



+52
−24




























Original line number
Diff line number
Diff line








@@ -16,6 +16,8 @@





























package com.android.server.accessibility;





























import static android.accessibilityservice.AccessibilityService.KEY_ACCESSIBILITY_SCREENSHOT_COLORSPACE_ID;













import static android.accessibilityservice.AccessibilityService.KEY_ACCESSIBILITY_SCREENSHOT_HARDWAREBUFFER;















import static android.accessibilityservice.AccessibilityServiceInfo.DEFAULT;















import static android.view.WindowManager.LayoutParams.TYPE_ACCESSIBILITY_OVERLAY;















import static android.view.accessibility.AccessibilityNodeInfo.ACTION_ACCESSIBILITY_FOCUS;









@@ -36,10 +38,11 @@ import android.content.Intent;













import android.content.ServiceConnection;















import android.content.pm.PackageManager;















import android.content.pm.ParceledListSlice;













import android.graphics.Bitmap;













import android.graphics.GraphicBuffer;















import android.graphics.Point;















import android.graphics.Rect;















import android.graphics.Region;













import android.hardware.HardwareBuffer;















import android.hardware.display.DisplayManager;















import android.hardware.display.DisplayManagerGlobal;















import android.os.Binder;









@@ -50,6 +53,7 @@ import android.os.IBinder;













import android.os.Looper;















import android.os.Message;















import android.os.PowerManager;













import android.os.RemoteCallback;















import android.os.RemoteException;















import android.os.ServiceManager;















import android.os.SystemClock;









@@ -71,6 +75,7 @@ import com.android.internal.annotations.GuardedBy;













import com.android.internal.compat.IPlatformCompat;















import com.android.internal.os.SomeArgs;















import com.android.internal.util.DumpUtils;













import com.android.internal.util.function.pooled.PooledLambda;















import com.android.server.LocalServices;















import com.android.server.accessibility.AccessibilityWindowManager.RemoteAccessibilityConnection;















import com.android.server.wm.ActivityTaskManagerInternal;










@@ -106,6 +111,8 @@ abstract class AbstractAccessibilityServiceConnection extends IAccessibilityServ













    private final PowerManager mPowerManager;















    private final IPlatformCompat mIPlatformCompat;





























    private final Handler mMainHandler;





























    // Handler for scheduling method invocations on the main thread.















    public final InvocationHandler mInvocationHandler;


























@@ -238,6 +245,7 @@ abstract class AbstractAccessibilityServiceConnection extends IAccessibilityServ













        mSecurityPolicy = securityPolicy;















        mSystemActionPerformer = systemActionPerfomer;















        mSystemSupport = systemSupport;













        mMainHandler = mainHandler;















        mInvocationHandler = new InvocationHandler(mainHandler.getLooper());















        mA11yWindowManager = a11yWindowManager;















        mDisplayManager = (DisplayManager) context.getSystemService(Context.DISPLAY_SERVICE);










@@ -959,52 +967,72 @@ abstract class AbstractAccessibilityServiceConnection extends IAccessibilityServ













        mInvocationHandler.setSoftKeyboardCallbackEnabled(enabled);















    }





























    @Nullable















    @Override













    public Bitmap takeScreenshot(int displayId) {













    public void takeScreenshot(int displayId, RemoteCallback callback) {















        synchronized (mLock) {















            if (!hasRightsToCurrentUserLocked()) {













                return null;













                sendScreenshotResult(true, null, callback);













                return;















            }































            if (!mSecurityPolicy.canTakeScreenshotLocked(this)) {













                return null;













                sendScreenshotResult(true, null, callback);













                throw new SecurityException("Services don't have the capability of taking"













                        + " the screenshot.");















            }















        }































        if (!mSecurityPolicy.checkAccessibilityAccess(this)) {













            return null;













            sendScreenshotResult(true, null, callback);













            return;















        }































        final Display display = DisplayManagerGlobal.getInstance()















                .getRealDisplay(displayId);















        if (display == null) {













            return null;













            sendScreenshotResult(true, null, callback);













            return;















        }













        final Point displaySize = new Point();













        display.getRealSize(displaySize);





























        final int rotation = display.getRotation();













        Bitmap screenShot = null;













        sendScreenshotResult(false, display, callback);













    }





























    private void sendScreenshotResult(boolean noResult, Display display, RemoteCallback callback) {













        final boolean noScreenshot = noResult;















        final long identity = Binder.clearCallingIdentity();















        try {













            final Rect crop = new Rect(0, 0, displaySize.x, displaySize.y);













            mMainHandler.post(PooledLambda.obtainRunnable((nonArg) -> {













                if (noScreenshot) {













                    callback.sendResult(null);













                    return;













                }













                final Point displaySize = new Point();















                // TODO (b/145893483): calling new API with the display as a parameter















                // when surface control supported.













            screenShot = SurfaceControl.screenshot(crop, displaySize.x, displaySize.y,













                final IBinder token = SurfaceControl.getInternalDisplayToken();













                final Rect crop = new Rect(0, 0, displaySize.x, displaySize.y);













                final int rotation = display.getRotation();













                display.getRealSize(displaySize);



























                final SurfaceControl.ScreenshotGraphicBuffer screenshotBuffer =













                        SurfaceControl.screenshotToBufferWithSecureLayersUnsafe(token, crop,













                                displaySize.x, displaySize.y, false,















                                rotation);













            if (screenShot != null) {













                // Optimization for telling the bitmap that all of the pixels are known to be













                // opaque (false). This is meant as a drawing hint, as in some cases a bitmap













                // that is known to be opaque can take a faster drawing case than one that may













                // have non-opaque per-pixel alpha values.













                screenShot.setHasAlpha(false);













            }













                final GraphicBuffer graphicBuffer = screenshotBuffer.getGraphicBuffer();













                final HardwareBuffer hardwareBuffer =













                        HardwareBuffer.createFromGraphicBuffer(graphicBuffer);













                final int colorSpaceId = screenshotBuffer.getColorSpace().getId();



























                // Send back the result.













                final Bundle payload = new Bundle();













                payload.putParcelable(KEY_ACCESSIBILITY_SCREENSHOT_HARDWAREBUFFER,













                        hardwareBuffer);













                payload.putInt(KEY_ACCESSIBILITY_SCREENSHOT_COLORSPACE_ID, colorSpaceId);













                callback.sendResult(payload);













            }, null).recycleOnUse());















        } finally {















            Binder.restoreCallingIdentity(identity);















        }













        return screenShot;















    }































    @Override