diff options
author | Zhijun He <zhijunhe@google.com> | 2014-02-24 15:11:23 -0800 |
---|---|---|
committer | Zhijun He <zhijunhe@google.com> | 2014-02-24 15:11:23 -0800 |
commit | cc28a41b48bc687002a9e1fc436d00ca6f0c3692 (patch) | |
tree | 430e7f39627c59e69fd2c7c431c982579da609e2 /core/java | |
parent | 3651cb7b4a0c3c731905301e868cca1c3af5aa21 (diff) | |
download | frameworks_base-cc28a41b48bc687002a9e1fc436d00ca6f0c3692.zip frameworks_base-cc28a41b48bc687002a9e1fc436d00ca6f0c3692.tar.gz frameworks_base-cc28a41b48bc687002a9e1fc436d00ca6f0c3692.tar.bz2 |
Camera2: Correct some minor errors in awb region spec
Also correct some other typos.
Change-Id: Ib7ac65cd82d06a20aa47cce10a9976a3ac405142
Diffstat (limited to 'core/java')
-rw-r--r-- | core/java/android/hardware/camera2/CameraMetadata.java | 2 | ||||
-rw-r--r-- | core/java/android/hardware/camera2/CaptureRequest.java | 46 | ||||
-rw-r--r-- | core/java/android/hardware/camera2/CaptureResult.java | 54 |
3 files changed, 53 insertions, 49 deletions
diff --git a/core/java/android/hardware/camera2/CameraMetadata.java b/core/java/android/hardware/camera2/CameraMetadata.java index c4b07cc..ff12d77 100644 --- a/core/java/android/hardware/camera2/CameraMetadata.java +++ b/core/java/android/hardware/camera2/CameraMetadata.java @@ -999,7 +999,7 @@ public abstract class CameraMetadata { /** * <p>Use specific scene mode. Enabling this disables * control.aeMode, control.awbMode and control.afMode - * controls; the HAL must ignore those settings while + * controls; the camera device will ignore those settings while * USE_SCENE_MODE is active (except for FACE_PRIORITY * scene mode). Other control entries are still active. * This setting can only be used if availableSceneModes != diff --git a/core/java/android/hardware/camera2/CaptureRequest.java b/core/java/android/hardware/camera2/CaptureRequest.java index dfde11b..c8668f5 100644 --- a/core/java/android/hardware/camera2/CaptureRequest.java +++ b/core/java/android/hardware/camera2/CaptureRequest.java @@ -390,7 +390,7 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable { /** * <p>Gains applying to Bayer raw color channels for - * white-balance</p> + * white-balance.</p> * <p>The 4-channel white-balance gains are defined in * the order of <code>[R G_even G_odd B]</code>, where <code>G_even</code> is the gain * for green pixels on even rows of the output, and <code>G_odd</code> @@ -398,11 +398,11 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable { * does not support a separate gain for even/odd green channels, * it should use the <code>G_even</code> value, and write <code>G_odd</code> equal to * <code>G_even</code> in the output result metadata.</p> - * <p>This array is either set by HAL when the request + * <p>This array is either set by the camera device when the request * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not TRANSFORM_MATRIX, or * directly by the application in the request when the * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is TRANSFORM_MATRIX.</p> - * <p>The output should be the gains actually applied by the HAL to + * <p>The output should be the gains actually applied by the camera device to * the current frame.</p> * * @see CaptureRequest#COLOR_CORRECTION_MODE @@ -536,9 +536,9 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable { * bottom-right pixel in the active pixel array. The weight * should be nonnegative.</p> * <p>If all regions have 0 weight, then no specific metering area - * needs to be used by the HAL. If the metering region is - * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the HAL - * should ignore the sections outside the region and output the + * needs to be used by the camera device. If the metering region is + * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the camera device + * will ignore the sections outside the region and output the * used sections in the frame metadata.</p> * * @see CaptureRequest#SCALER_CROP_REGION @@ -579,13 +579,15 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable { /** * <p>Whether AF is currently enabled, and what * mode it is set to</p> - * <p>Only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} = AUTO.</p> + * <p>Only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} = AUTO and the lens is not fixed focus + * (i.e. <code>{@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} > 0</code>).</p> * <p>If the lens is controlled by the camera device auto-focus algorithm, * the camera device will report the current AF status in {@link CaptureResult#CONTROL_AF_STATE android.control.afState} * in result metadata.</p> * * @see CaptureResult#CONTROL_AF_STATE * @see CaptureRequest#CONTROL_MODE + * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE * @see #CONTROL_AF_MODE_OFF * @see #CONTROL_AF_MODE_AUTO * @see #CONTROL_AF_MODE_MACRO @@ -609,9 +611,9 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable { * bottom-right pixel in the active pixel array. The weight * should be nonnegative.</p> * <p>If all regions have 0 weight, then no specific focus area - * needs to be used by the HAL. If the focusing region is - * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the HAL - * should ignore the sections outside the region and output the + * needs to be used by the camera device. If the focusing region is + * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the camera device + * will ignore the sections outside the region and output the * used sections in the frame metadata.</p> * * @see CaptureRequest#SCALER_CROP_REGION @@ -651,14 +653,14 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable { /** * <p>Whether AWB is currently setting the color * transform fields, and what its illumination target - * is</p> + * is.</p> * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is AUTO.</p> * <p>When set to the ON mode, the camera device's auto white balance * routine is enabled, overriding the application's selected * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.</p> * <p>When set to the OFF mode, the camera device's auto white balance - * routine is disabled. The applicantion manually controls the white + * routine is disabled. The application manually controls the white * balance by {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} * and {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.</p> * <p>When set to any other modes, the camera device's auto white balance @@ -695,10 +697,10 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable { * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the * bottom-right pixel in the active pixel array. The weight * should be nonnegative.</p> - * <p>If all regions have 0 weight, then no specific metering area - * needs to be used by the HAL. If the metering region is - * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the HAL - * should ignore the sections outside the region and output the + * <p>If all regions have 0 weight, then no specific auto-white balance (AWB) area + * needs to be used by the camera device. If the AWB region is + * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the camera device + * will ignore the sections outside the region and output the * used sections in the frame metadata.</p> * * @see CaptureRequest#SCALER_CROP_REGION @@ -753,7 +755,7 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable { /** * <p>Overall mode of 3A control - * routines</p> + * routines.</p> * <p>High-level 3A control. When set to OFF, all 3A control * by the camera device is disabled. The application must set the fields for * capture parameters itself.</p> @@ -830,9 +832,9 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable { /** * <p>Operation mode for edge - * enhancement</p> + * enhancement.</p> * <p>Edge/sharpness/detail enhancement. OFF means no - * enhancement will be applied by the HAL.</p> + * enhancement will be applied by the camera device.</p> * <p>FAST/HIGH_QUALITY both mean camera device determined enhancement * will be applied. HIGH_QUALITY mode indicates that the * camera device will use the highest-quality enhancement algorithms, @@ -1044,7 +1046,7 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable { * <p>Mode of operation for the noise reduction * algorithm</p> * <p>Noise filtering control. OFF means no noise reduction - * will be applied by the HAL.</p> + * will be applied by the camera device.</p> * <p>FAST/HIGH_QUALITY both mean camera device determined noise filtering * will be applied. HIGH_QUALITY mode indicates that the camera device * will use the highest-quality noise filtering algorithms, @@ -1285,8 +1287,8 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable { new Key<Integer>("android.statistics.faceDetectMode", int.class); /** - * <p>Whether the HAL needs to output the lens - * shading map in output result metadata</p> + * <p>Whether the camera device will output the lens + * shading map in output result metadata.</p> * <p>When set to ON, * {@link CaptureResult#STATISTICS_LENS_SHADING_MAP android.statistics.lensShadingMap} must be provided in * the output result metadata.</p> diff --git a/core/java/android/hardware/camera2/CaptureResult.java b/core/java/android/hardware/camera2/CaptureResult.java index 9981bf9..0749edd 100644 --- a/core/java/android/hardware/camera2/CaptureResult.java +++ b/core/java/android/hardware/camera2/CaptureResult.java @@ -143,7 +143,7 @@ public final class CaptureResult extends CameraMetadata { /** * <p>Gains applying to Bayer raw color channels for - * white-balance</p> + * white-balance.</p> * <p>The 4-channel white-balance gains are defined in * the order of <code>[R G_even G_odd B]</code>, where <code>G_even</code> is the gain * for green pixels on even rows of the output, and <code>G_odd</code> @@ -151,11 +151,11 @@ public final class CaptureResult extends CameraMetadata { * does not support a separate gain for even/odd green channels, * it should use the <code>G_even</code> value, and write <code>G_odd</code> equal to * <code>G_even</code> in the output result metadata.</p> - * <p>This array is either set by HAL when the request + * <p>This array is either set by the camera device when the request * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not TRANSFORM_MATRIX, or * directly by the application in the request when the * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is TRANSFORM_MATRIX.</p> - * <p>The output should be the gains actually applied by the HAL to + * <p>The output should be the gains actually applied by the camera device to * the current frame.</p> * * @see CaptureRequest#COLOR_CORRECTION_MODE @@ -225,9 +225,9 @@ public final class CaptureResult extends CameraMetadata { * bottom-right pixel in the active pixel array. The weight * should be nonnegative.</p> * <p>If all regions have 0 weight, then no specific metering area - * needs to be used by the HAL. If the metering region is - * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the HAL - * should ignore the sections outside the region and output the + * needs to be used by the camera device. If the metering region is + * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the camera device + * will ignore the sections outside the region and output the * used sections in the frame metadata.</p> * * @see CaptureRequest#SCALER_CROP_REGION @@ -437,13 +437,15 @@ public final class CaptureResult extends CameraMetadata { /** * <p>Whether AF is currently enabled, and what * mode it is set to</p> - * <p>Only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} = AUTO.</p> + * <p>Only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} = AUTO and the lens is not fixed focus + * (i.e. <code>{@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} > 0</code>).</p> * <p>If the lens is controlled by the camera device auto-focus algorithm, * the camera device will report the current AF status in {@link CaptureResult#CONTROL_AF_STATE android.control.afState} * in result metadata.</p> * * @see CaptureResult#CONTROL_AF_STATE * @see CaptureRequest#CONTROL_MODE + * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE * @see #CONTROL_AF_MODE_OFF * @see #CONTROL_AF_MODE_AUTO * @see #CONTROL_AF_MODE_MACRO @@ -467,9 +469,9 @@ public final class CaptureResult extends CameraMetadata { * bottom-right pixel in the active pixel array. The weight * should be nonnegative.</p> * <p>If all regions have 0 weight, then no specific focus area - * needs to be used by the HAL. If the focusing region is - * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the HAL - * should ignore the sections outside the region and output the + * needs to be used by the camera device. If the focusing region is + * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the camera device + * will ignore the sections outside the region and output the * used sections in the frame metadata.</p> * * @see CaptureRequest#SCALER_CROP_REGION @@ -889,14 +891,14 @@ public final class CaptureResult extends CameraMetadata { /** * <p>Whether AWB is currently setting the color * transform fields, and what its illumination target - * is</p> + * is.</p> * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is AUTO.</p> * <p>When set to the ON mode, the camera device's auto white balance * routine is enabled, overriding the application's selected * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.</p> * <p>When set to the OFF mode, the camera device's auto white balance - * routine is disabled. The applicantion manually controls the white + * routine is disabled. The application manually controls the white * balance by {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} * and {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.</p> * <p>When set to any other modes, the camera device's auto white balance @@ -933,10 +935,10 @@ public final class CaptureResult extends CameraMetadata { * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the * bottom-right pixel in the active pixel array. The weight * should be nonnegative.</p> - * <p>If all regions have 0 weight, then no specific metering area - * needs to be used by the HAL. If the metering region is - * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the HAL - * should ignore the sections outside the region and output the + * <p>If all regions have 0 weight, then no specific auto-white balance (AWB) area + * needs to be used by the camera device. If the AWB region is + * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the camera device + * will ignore the sections outside the region and output the * used sections in the frame metadata.</p> * * @see CaptureRequest#SCALER_CROP_REGION @@ -1077,7 +1079,7 @@ public final class CaptureResult extends CameraMetadata { /** * <p>Overall mode of 3A control - * routines</p> + * routines.</p> * <p>High-level 3A control. When set to OFF, all 3A control * by the camera device is disabled. The application must set the fields for * capture parameters itself.</p> @@ -1105,9 +1107,9 @@ public final class CaptureResult extends CameraMetadata { /** * <p>Operation mode for edge - * enhancement</p> + * enhancement.</p> * <p>Edge/sharpness/detail enhancement. OFF means no - * enhancement will be applied by the HAL.</p> + * enhancement will be applied by the camera device.</p> * <p>FAST/HIGH_QUALITY both mean camera device determined enhancement * will be applied. HIGH_QUALITY mode indicates that the * camera device will use the highest-quality enhancement algorithms, @@ -1385,7 +1387,7 @@ public final class CaptureResult extends CameraMetadata { * <p>Mode of operation for the noise reduction * algorithm</p> * <p>Noise filtering control. OFF means no noise reduction - * will be applied by the HAL.</p> + * will be applied by the camera device.</p> * <p>FAST/HIGH_QUALITY both mean camera device determined noise filtering * will be applied. HIGH_QUALITY mode indicates that the camera device * will use the highest-quality noise filtering algorithms, @@ -1411,7 +1413,7 @@ public final class CaptureResult extends CameraMetadata { * before the FINAL buffer for frame 4. PARTIAL buffers may be returned * in any order relative to other frames, but all PARTIAL buffers for a given * capture must arrive before the FINAL buffer for that capture. This entry may - * only be used by the HAL if quirks.usePartialResult is set to 1.</p> + * only be used by the camera device if quirks.usePartialResult is set to 1.</p> * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> * @hide */ @@ -1904,7 +1906,7 @@ public final class CaptureResult extends CameraMetadata { /** * <p>The best-fit color channel gains calculated - * by the HAL's statistics units for the current output frame</p> + * by the camera device's statistics units for the current output frame.</p> * <p>This may be different than the gains used for this frame, * since statistics processing on data from a new frame * typically completes after the transform has already been @@ -1923,11 +1925,11 @@ public final class CaptureResult extends CameraMetadata { /** * <p>The best-fit color transform matrix estimate - * calculated by the HAL's statistics units for the current - * output frame</p> - * <p>The HAL must provide the estimate from its + * calculated by the camera device's statistics units for the current + * output frame.</p> + * <p>The camera device will provide the estimate from its * statistics unit on the white balance transforms to use - * for the next frame. These are the values the HAL believes + * for the next frame. These are the values the camera device believes * are the best fit for the current output frame. This may * be different than the transform used for this frame, since * statistics processing on data from a new frame typically |