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

Commit dc921d86 authored Nov 30, 2020 by Shuzhen Wang

Camera: Document behavior when cropRegion and zoomRation conflict

In case cropRegion == windowboxing and zoomRatio != 1.0f, specify the
camera framework behavior of overriding cropRegion.

Test: Build
Bug: 172873869
Change-Id: Ic7713260cdd5f51e422be330534dd1e5648ba2fc

parent 62fd1c3a

core/java/android/hardware/camera2/CameraCharacteristics.java

+3 −1

Original line number	Diff line number	Diff line
		@@ -2771,7 +2771,9 @@ public final class CameraCharacteristics extends CameraMetadata<CameraCharacteri
		* </ol>
		* </li>
		* <li>Setting {@link CaptureRequest#CONTROL_ZOOM_RATIO android.control.zoomRatio} to values different than 1.0 and
		* {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} to be windowboxing at the same time is undefined behavior.</li>
		* {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} to be windowboxing at the same time are not supported. In this
		* case, the camera framework will override the {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} to be the active
		* array.</li>
		* </ul>
		* <p>LEGACY capability devices will only support CENTER_ONLY cropping.</p>
		* <p><b>Possible values:</b>

core/java/android/hardware/camera2/CaptureRequest.java

+4 −1

Original line number	Diff line number	Diff line
		@@ -2242,7 +2242,10 @@ public final class CaptureRequest extends CameraMetadata<CaptureRequest.Key<?>>
		* explicitly set {@link CaptureRequest#CONTROL_ZOOM_RATIO android.control.zoomRatio}, its value defaults to 1.0.</p>
		* <p>One limitation of controlling zoom using zoomRatio is that the {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}
		* must only be used for letterboxing or pillarboxing of the sensor active array, and no
		* FREEFORM cropping can be used with {@link CaptureRequest#CONTROL_ZOOM_RATIO android.control.zoomRatio} other than 1.0.</p>
		* FREEFORM cropping can be used with {@link CaptureRequest#CONTROL_ZOOM_RATIO android.control.zoomRatio} other than 1.0. If
		* {@link CaptureRequest#CONTROL_ZOOM_RATIO android.control.zoomRatio} is not 1.0, and {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} is set to be
		* windowboxing, the camera framework will override the {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} to be
		* the active array.</p>
		* <p><b>Range of valid values:</b><br>
		* {@link CameraCharacteristics#CONTROL_ZOOM_RATIO_RANGE android.control.zoomRatioRange}</p>
		* <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p>

core/java/android/hardware/camera2/CaptureResult.java

+4 −1

Original line number	Diff line number	Diff line
		@@ -2472,7 +2472,10 @@ public class CaptureResult extends CameraMetadata<CaptureResult.Key<?>> {
		* explicitly set {@link CaptureRequest#CONTROL_ZOOM_RATIO android.control.zoomRatio}, its value defaults to 1.0.</p>
		* <p>One limitation of controlling zoom using zoomRatio is that the {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}
		* must only be used for letterboxing or pillarboxing of the sensor active array, and no
		* FREEFORM cropping can be used with {@link CaptureRequest#CONTROL_ZOOM_RATIO android.control.zoomRatio} other than 1.0.</p>
		* FREEFORM cropping can be used with {@link CaptureRequest#CONTROL_ZOOM_RATIO android.control.zoomRatio} other than 1.0. If
		* {@link CaptureRequest#CONTROL_ZOOM_RATIO android.control.zoomRatio} is not 1.0, and {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} is set to be
		* windowboxing, the camera framework will override the {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} to be
		* the active array.</p>
		* <p><b>Range of valid values:</b><br>
		* {@link CameraCharacteristics#CONTROL_ZOOM_RATIO_RANGE android.control.zoomRatioRange}</p>
		* <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p>