New getBitmapCrops API, move some @hide to SystemAPIs (17bcaa18) · Commits · e / os / android_frameworks_base

core/api/system-current.txt

+8 −0

Original line number	Diff line number	Diff line
		@@ -1268,13 +1268,21 @@ package android.app {

		public class WallpaperManager {
		method @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS_FULL) public void clearWallpaper(int, int);
		method @FlaggedApi("android.app.customization_packs_apis") @NonNull @RequiresPermission(android.Manifest.permission.READ_WALLPAPER_INTERNAL) public android.util.SparseArray<android.graphics.Rect> getBitmapCrops(int);
		method @FlaggedApi("android.app.customization_packs_apis") public static int getOrientation(@NonNull android.graphics.Point);
		method @FloatRange(from=0.0f, to=1.0f) @RequiresPermission(android.Manifest.permission.SET_WALLPAPER_DIM_AMOUNT) public float getWallpaperDimAmount();
		method @FlaggedApi("android.app.customization_packs_apis") @Nullable public android.os.ParcelFileDescriptor getWallpaperFile(int, boolean);
		method @FlaggedApi("android.app.live_wallpaper_content_handling") @Nullable @RequiresPermission(android.Manifest.permission.READ_WALLPAPER_INTERNAL) public android.app.wallpaper.WallpaperInstance getWallpaperInstance(int);
		method public void setDisplayOffset(android.os.IBinder, int, int);
		method @FlaggedApi("com.android.window.flags.multi_crop") @RequiresPermission(android.Manifest.permission.SET_WALLPAPER) public int setStreamWithCrops(@NonNull java.io.InputStream, @NonNull android.util.SparseArray<android.graphics.Rect>, boolean, int) throws java.io.IOException;
		method @RequiresPermission(android.Manifest.permission.SET_WALLPAPER_COMPONENT) public boolean setWallpaperComponent(android.content.ComponentName);
		method @FlaggedApi("android.app.live_wallpaper_content_handling") @RequiresPermission(allOf={android.Manifest.permission.SET_WALLPAPER_COMPONENT, android.Manifest.permission.INTERACT_ACROSS_USERS_FULL}, conditional=true) public boolean setWallpaperComponentWithDescription(@NonNull android.app.wallpaper.WallpaperDescription, int);
		method @RequiresPermission(android.Manifest.permission.SET_WALLPAPER_COMPONENT) public boolean setWallpaperComponentWithFlags(@NonNull android.content.ComponentName, int);
		method @RequiresPermission(android.Manifest.permission.SET_WALLPAPER_DIM_AMOUNT) public void setWallpaperDimAmount(@FloatRange(from=0.0f, to=1.0f) float);
		field @FlaggedApi("android.app.customization_packs_apis") public static final int ORIENTATION_LANDSCAPE = 1; // 0x1
		field @FlaggedApi("android.app.customization_packs_apis") public static final int ORIENTATION_PORTRAIT = 0; // 0x0
		field @FlaggedApi("android.app.customization_packs_apis") public static final int ORIENTATION_SQUARE_LANDSCAPE = 3; // 0x3
		field @FlaggedApi("android.app.customization_packs_apis") public static final int ORIENTATION_SQUARE_PORTRAIT = 2; // 0x2
		}

		}

core/java/android/app/DisabledWallpaperManager.java

+10 −2

Original line number	Diff line number	Diff line
		@@ -176,6 +176,13 @@ final class DisabledWallpaperManager extends WallpaperManager {
		return unsupported();
		}

		@Override
		@NonNull
		public SparseArray<Rect> getBitmapCrops(int which) {
		unsupported();
		return new SparseArray<>();
		}

		@Override
		public List<Rect> getBitmapCrops(@NonNull Point bitmapSize, @NonNull List<Point> displaySizes,
		@Nullable Map<Point, Rect> cropHints) {
		@@ -358,8 +365,9 @@ final class DisabledWallpaperManager extends WallpaperManager {


		@Override
		public int setStreamWithCrops(InputStream bitmapData, @NonNull SparseArray<Rect> cropHints,
		boolean allowBackup, @SetWallpaperFlags int which) throws IOException {
		public int setStreamWithCrops(@NonNull InputStream bitmapData,
		@NonNull SparseArray<Rect> cropHints, boolean allowBackup, @SetWallpaperFlags int which
		) throws IOException {
		return unsupportedInt();
		}

core/java/android/app/IWallpaperManager.aidl

+10 −0

Original line number	Diff line number	Diff line
		@@ -96,6 +96,16 @@ interface IWallpaperManager {
		@SuppressWarnings(value={"untyped-collection"})
		List getBitmapCrops(in List<Point> displaySizes, int which, boolean originalBitmap, int userId);

		/**
		* For a given user, if the wallpaper of the specified which is an ImageWallpaper, return
		* a bundle which is a Map<Integer, Rect> containing the custom cropHints that were sent to
		* setBitmapWithCrops or setStreamWithCrops. These crops are relative to the original bitmap.
		* If the wallpaper isn't an ImageWallpaper, return null.
		*/
		@JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.READ_WALLPAPER_INTERNAL)")
		@SuppressWarnings(value={"untyped-collection"})
		Bundle getCurrentBitmapCrops(int which, int userId);

		/**
		* Return how a bitmap of a given size would be cropped for a given list of display sizes when
		* set with the given suggested crops.

core/java/android/app/WallpaperManager.java

+71 −3

Original line number	Diff line number	Diff line
		@@ -19,9 +19,10 @@ package android.app;
		import static android.Manifest.permission.MANAGE_EXTERNAL_STORAGE;
		import static android.Manifest.permission.READ_WALLPAPER_INTERNAL;
		import static android.Manifest.permission.SET_WALLPAPER_DIM_AMOUNT;
		import static android.app.Flags.FLAG_CUSTOMIZATION_PACKS_APIS;
		import static android.app.Flags.FLAG_LIVE_WALLPAPER_CONTENT_HANDLING;
		import static android.content.pm.PackageManager.PERMISSION_GRANTED;
		import static android.os.ParcelFileDescriptor.MODE_READ_ONLY;
		import static android.app.Flags.FLAG_LIVE_WALLPAPER_CONTENT_HANDLING;

		import static com.android.window.flags.Flags.FLAG_MULTI_CROP;
		import static com.android.window.flags.Flags.multiCrop;
		@@ -342,24 +343,32 @@ public class WallpaperManager {
		* Portrait orientation of most screens
		* @hide
		*/
		@FlaggedApi(FLAG_CUSTOMIZATION_PACKS_APIS)
		@SystemApi
		public static final int ORIENTATION_PORTRAIT = 0;

		/**
		* Landscape orientation of most screens
		* @hide
		*/
		@FlaggedApi(FLAG_CUSTOMIZATION_PACKS_APIS)
		@SystemApi
		public static final int ORIENTATION_LANDSCAPE = 1;

		/**
		* Portrait orientation with similar width and height (e.g. the inner screen of a foldable)
		* @hide
		*/
		@FlaggedApi(FLAG_CUSTOMIZATION_PACKS_APIS)
		@SystemApi
		public static final int ORIENTATION_SQUARE_PORTRAIT = 2;

		/**
		* Landscape orientation with similar width and height (e.g. the inner screen of a foldable)
		* @hide
		*/
		@FlaggedApi(FLAG_CUSTOMIZATION_PACKS_APIS)
		@SystemApi
		public static final int ORIENTATION_SQUARE_LANDSCAPE = 3;

		/**
		@@ -368,7 +377,9 @@ public class WallpaperManager {
		* @return the corresponding {@link ScreenOrientation}.
		* @hide
		*/
		public static @ScreenOrientation int getOrientation(Point screenSize) {
		@FlaggedApi(FLAG_CUSTOMIZATION_PACKS_APIS)
		@SystemApi
		public static @ScreenOrientation int getOrientation(@NonNull Point screenSize) {
		float ratio = ((float) screenSize.x) / screenSize.y;
		// ratios between 3/4 and 4/3 are considered square
		return ratio >= 4 / 3f ? ORIENTATION_LANDSCAPE
		@@ -1653,6 +1664,52 @@ public class WallpaperManager {
		}
		}

		/**
		* For the current user, if the wallpaper of the specified destination is an ImageWallpaper,
		* return the custom crops of the wallpaper, that have been provided for example via
		* {@link #setStreamWithCrops}. These crops are relative to the original bitmap.
		* <p>
		* This method helps apps that change wallpapers provide an undo option. Calling
		* {@link #setStreamWithCrops(InputStream, SparseArray, boolean, int)} with this SparseArray and
		* the current original bitmap file, that can be obtained with {@link #getWallpaperFile(int,
		* boolean)} with {@code getCropped=false}, will exactly lead to the current wallpaper state.
		*
		* @param which wallpaper type. Must be either {@link #FLAG_SYSTEM} or {@link #FLAG_LOCK}.
		* @return A map from {{@link #ORIENTATION_PORTRAIT}, {@link #ORIENTATION_LANDSCAPE},
		* {@link #ORIENTATION_SQUARE_PORTRAIT}, {{@link #ORIENTATION_SQUARE_LANDSCAPE}}} to
		* Rect, representing the custom cropHints. The map can be empty and will only contains
		* entries for screen orientations for which a custom crop was provided. If no custom
		* crop is provided for an orientation, the system will infer the crop based on the
		* custom crops of the other orientations; or center-align the full image if no custom
		* crops are provided at all.
		* <p>
		* Return an empty map if the wallpaper is not an ImageWallpaper. Also return
		* an empty map when called with which={@link #FLAG_LOCK} if there is a shared
		* home + lock wallpaper.
		*
		* @hide
		*/
		@FlaggedApi(FLAG_CUSTOMIZATION_PACKS_APIS)
		@SystemApi
		@RequiresPermission(READ_WALLPAPER_INTERNAL)
		@NonNull
		public SparseArray<Rect> getBitmapCrops(@SetWallpaperFlags int which) {
		checkExactlyOneWallpaperFlagSet(which);
		try {
		Bundle bundle = sGlobals.mService.getCurrentBitmapCrops(which, mContext.getUserId());
		SparseArray<Rect> result = new SparseArray<>();
		if (bundle == null) return result;
		for (String key : bundle.keySet()) {
		int intKey = Integer.parseInt(key);
		Rect rect = bundle.getParcelable(key, Rect.class);
		result.put(intKey, rect);
		}
		return result;
		} catch (RemoteException e) {
		throw e.rethrowFromSystemServer();
		}
		}

		/**
		* For preview purposes.
		* Return how a bitmap of a given size would be cropped for a given list of display sizes, if
		@@ -1892,9 +1949,14 @@ public class WallpaperManager {
		* defined kind of wallpaper, either {@link #FLAG_SYSTEM} or {@link #FLAG_LOCK}.
		* @param getCropped If true the cropped file will be retrieved, if false the original will
		* be retrieved.
		*
		* @return A ParcelFileDescriptor for the wallpaper bitmap of the given destination, if it's an
		* ImageWallpaper wallpaper. Return {@code null} if the wallpaper is not an
		* ImageWallpaper. Also return {@code null} when called with
		* which={@link #FLAG_LOCK} if there is a shared home + lock wallpaper.
		* @hide
		*/
		@FlaggedApi(FLAG_CUSTOMIZATION_PACKS_APIS)
		@SystemApi
		@Nullable
		public ParcelFileDescriptor getWallpaperFile(@SetWallpaperFlags int which, boolean getCropped) {
		return getWallpaperFile(which, mContext.getUserId(), getCropped);
		@@ -2586,11 +2648,17 @@ public class WallpaperManager {
		* Similar to {@link #setStreamWithCrops(InputStream, Map, boolean, int)}, but using
		* {@link ScreenOrientation} as keys of the cropHints map. Used for backup & restore, since
		* WallpaperBackupAgent stores orientations rather than the exact display size.
		* @param bitmapData A stream containing the raw data to install as a wallpaper. This
		* data can be in any format handled by {@link BitmapRegionDecoder}.
		* @param cropHints map from {@link ScreenOrientation} to a sub-region of the image to display
		* for that screen orientation.
		* @param allowBackup {@code true} if the OS is permitted to back up this wallpaper
		* image for restore to a future device; {@code false} otherwise.
		* @param which Flags indicating which wallpaper(s) to configure with the new imagery.
		* @hide
		*/
		@FlaggedApi(FLAG_MULTI_CROP)
		@SystemApi
		@RequiresPermission(android.Manifest.permission.SET_WALLPAPER)
		public int setStreamWithCrops(@NonNull InputStream bitmapData,
		@NonNull SparseArray<Rect> cropHints, boolean allowBackup, @SetWallpaperFlags int which)

core/java/android/app/wallpaper.aconfig

+8 −0

Original line number	Diff line number	Diff line
		@@ -22,3 +22,11 @@ flag {
		bug: "347235611"
		is_exported: true
		}

		flag {
		name: "customization_packs_apis"
		is_exported: true
		namespace: "systemui"
		description: "Move APIs related to bitmap and crops to @SystemApi."
		bug: "372344184"
		}