CaptureResult.java revision 5743868e15c88d2886915163652a1571a218bf39
1/* 2 * Copyright (C) 2012 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package android.hardware.camera2; 18 19import android.hardware.camera2.impl.CameraMetadataNative; 20import android.hardware.camera2.utils.TypeReference; 21import android.util.Log; 22import android.util.Rational; 23 24import java.util.List; 25 26/** 27 * <p>The subset of the results of a single image capture from the image sensor.</p> 28 * 29 * <p>Contains a subset of the final configuration for the capture hardware (sensor, lens, 30 * flash), the processing pipeline, the control algorithms, and the output 31 * buffers.</p> 32 * 33 * <p>CaptureResults are produced by a {@link CameraDevice} after processing a 34 * {@link CaptureRequest}. All properties listed for capture requests can also 35 * be queried on the capture result, to determine the final values used for 36 * capture. The result also includes additional metadata about the state of the 37 * camera device during the capture.</p> 38 * 39 * <p>Not all properties returned by {@link CameraCharacteristics#getAvailableCaptureResultKeys()} 40 * are necessarily available. Some results are {@link CaptureResult partial} and will 41 * not have every key set. Only {@link TotalCaptureResult total} results are guaranteed to have 42 * every key available that was enabled by the request.</p> 43 * 44 * <p>{@link CaptureResult} objects are immutable.</p> 45 * 46 */ 47public class CaptureResult extends CameraMetadata<CaptureResult.Key<?>> { 48 49 private static final String TAG = "CaptureResult"; 50 private static final boolean VERBOSE = false; 51 52 /** 53 * A {@code Key} is used to do capture result field lookups with 54 * {@link CaptureResult#get}. 55 * 56 * <p>For example, to get the timestamp corresponding to the exposure of the first row: 57 * <code><pre> 58 * long timestamp = captureResult.get(CaptureResult.SENSOR_TIMESTAMP); 59 * </pre></code> 60 * </p> 61 * 62 * <p>To enumerate over all possible keys for {@link CaptureResult}, see 63 * {@link CameraCharacteristics#getAvailableCaptureResultKeys}.</p> 64 * 65 * @see CaptureResult#get 66 * @see CameraCharacteristics#getAvailableCaptureResultKeys 67 */ 68 public final static class Key<T> { 69 private final CameraMetadataNative.Key<T> mKey; 70 71 /** 72 * Visible for testing and vendor extensions only. 73 * 74 * @hide 75 */ 76 public Key(String name, Class<T> type) { 77 mKey = new CameraMetadataNative.Key<T>(name, type); 78 } 79 80 /** 81 * Visible for testing and vendor extensions only. 82 * 83 * @hide 84 */ 85 public Key(String name, TypeReference<T> typeReference) { 86 mKey = new CameraMetadataNative.Key<T>(name, typeReference); 87 } 88 89 /** 90 * Return a camelCase, period separated name formatted like: 91 * {@code "root.section[.subsections].name"}. 92 * 93 * <p>Built-in keys exposed by the Android SDK are always prefixed with {@code "android."}; 94 * keys that are device/platform-specific are prefixed with {@code "com."}.</p> 95 * 96 * <p>For example, {@code CameraCharacteristics.SCALER_STREAM_CONFIGURATION_MAP} would 97 * have a name of {@code "android.scaler.streamConfigurationMap"}; whereas a device 98 * specific key might look like {@code "com.google.nexus.data.private"}.</p> 99 * 100 * @return String representation of the key name 101 */ 102 public String getName() { 103 return mKey.getName(); 104 } 105 106 /** 107 * {@inheritDoc} 108 */ 109 @Override 110 public final int hashCode() { 111 return mKey.hashCode(); 112 } 113 114 /** 115 * {@inheritDoc} 116 */ 117 @SuppressWarnings("unchecked") 118 @Override 119 public final boolean equals(Object o) { 120 return o instanceof Key && ((Key<T>)o).mKey.equals(mKey); 121 } 122 123 /** 124 * Visible for CameraMetadataNative implementation only; do not use. 125 * 126 * TODO: Make this private or remove it altogether. 127 * 128 * @hide 129 */ 130 public CameraMetadataNative.Key<T> getNativeKey() { 131 return mKey; 132 } 133 134 @SuppressWarnings({ "unchecked" }) 135 /*package*/ Key(CameraMetadataNative.Key<?> nativeKey) { 136 mKey = (CameraMetadataNative.Key<T>) nativeKey; 137 } 138 } 139 140 private final CameraMetadataNative mResults; 141 private final CaptureRequest mRequest; 142 private final int mSequenceId; 143 144 /** 145 * Takes ownership of the passed-in properties object 146 * @hide 147 */ 148 public CaptureResult(CameraMetadataNative results, CaptureRequest parent, int sequenceId) { 149 if (results == null) { 150 throw new IllegalArgumentException("results was null"); 151 } 152 153 if (parent == null) { 154 throw new IllegalArgumentException("parent was null"); 155 } 156 157 mResults = CameraMetadataNative.move(results); 158 if (mResults.isEmpty()) { 159 throw new AssertionError("Results must not be empty"); 160 } 161 mRequest = parent; 162 mSequenceId = sequenceId; 163 } 164 165 /** 166 * Returns a copy of the underlying {@link CameraMetadataNative}. 167 * @hide 168 */ 169 public CameraMetadataNative getNativeCopy() { 170 return new CameraMetadataNative(mResults); 171 } 172 173 /** 174 * Creates a request-less result. 175 * 176 * <p><strong>For testing only.</strong></p> 177 * @hide 178 */ 179 public CaptureResult(CameraMetadataNative results, int sequenceId) { 180 if (results == null) { 181 throw new IllegalArgumentException("results was null"); 182 } 183 184 mResults = CameraMetadataNative.move(results); 185 if (mResults.isEmpty()) { 186 throw new AssertionError("Results must not be empty"); 187 } 188 189 mRequest = null; 190 mSequenceId = sequenceId; 191 } 192 193 /** 194 * Get a capture result field value. 195 * 196 * <p>The field definitions can be found in {@link CaptureResult}.</p> 197 * 198 * <p>Querying the value for the same key more than once will return a value 199 * which is equal to the previous queried value.</p> 200 * 201 * @throws IllegalArgumentException if the key was not valid 202 * 203 * @param key The result field to read. 204 * @return The value of that key, or {@code null} if the field is not set. 205 */ 206 public <T> T get(Key<T> key) { 207 T value = mResults.get(key); 208 if (VERBOSE) Log.v(TAG, "#get for Key = " + key.getName() + ", returned value = " + value); 209 return value; 210 } 211 212 /** 213 * {@inheritDoc} 214 * @hide 215 */ 216 @SuppressWarnings("unchecked") 217 @Override 218 protected <T> T getProtected(Key<?> key) { 219 return (T) mResults.get(key); 220 } 221 222 /** 223 * {@inheritDoc} 224 * @hide 225 */ 226 @SuppressWarnings("unchecked") 227 @Override 228 protected Class<Key<?>> getKeyClass() { 229 Object thisClass = Key.class; 230 return (Class<Key<?>>)thisClass; 231 } 232 233 /** 234 * Dumps the native metadata contents to logcat. 235 * 236 * <p>Visibility for testing/debugging only. The results will not 237 * include any synthesized keys, as they are invisible to the native layer.</p> 238 * 239 * @hide 240 */ 241 public void dumpToLog() { 242 mResults.dumpToLog(); 243 } 244 245 /** 246 * {@inheritDoc} 247 */ 248 @Override 249 public List<Key<?>> getKeys() { 250 // Force the javadoc for this function to show up on the CaptureResult page 251 return super.getKeys(); 252 } 253 254 /** 255 * Get the request associated with this result. 256 * 257 * <p>Whenever a request has been fully or partially captured, with 258 * {@link CameraDevice.CaptureListener#onCaptureCompleted} or 259 * {@link CameraDevice.CaptureListener#onCaptureProgressed}, the {@code result}'s 260 * {@code getRequest()} will return that {@code request}. 261 * </p> 262 * 263 * <p>For example, 264 * <code><pre>cameraDevice.capture(someRequest, new CaptureListener() { 265 * {@literal @}Override 266 * void onCaptureCompleted(CaptureRequest myRequest, CaptureResult myResult) { 267 * assert(myResult.getRequest.equals(myRequest) == true); 268 * } 269 * }, null); 270 * </code></pre> 271 * </p> 272 * 273 * @return The request associated with this result. Never {@code null}. 274 */ 275 public CaptureRequest getRequest() { 276 return mRequest; 277 } 278 279 /** 280 * Get the frame number associated with this result. 281 * 282 * <p>Whenever a request has been processed, regardless of failure or success, 283 * it gets a unique frame number assigned to its future result/failure.</p> 284 * 285 * <p>This value monotonically increments, starting with 0, 286 * for every new result or failure; and the scope is the lifetime of the 287 * {@link CameraDevice}.</p> 288 * 289 * @return int frame number 290 */ 291 public int getFrameNumber() { 292 // TODO: @hide REQUEST_FRAME_COUNT 293 return get(REQUEST_FRAME_COUNT); 294 } 295 296 /** 297 * The sequence ID for this failure that was returned by the 298 * {@link CameraDevice#capture} family of functions. 299 * 300 * <p>The sequence ID is a unique monotonically increasing value starting from 0, 301 * incremented every time a new group of requests is submitted to the CameraDevice.</p> 302 * 303 * @return int The ID for the sequence of requests that this capture result is a part of 304 * 305 * @see CameraDevice.CaptureListener#onCaptureSequenceCompleted 306 * @see CameraDevice.CaptureListener#onCaptureSequenceAborted 307 */ 308 public int getSequenceId() { 309 return mSequenceId; 310 } 311 312 /*@O~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ 313 * The key entries below this point are generated from metadata 314 * definitions in /system/media/camera/docs. Do not modify by hand or 315 * modify the comment blocks at the start or end. 316 *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/ 317 318 319 /** 320 * <p>The mode control selects how the image data is converted from the 321 * sensor's native color into linear sRGB color.</p> 322 * <p>When auto-white balance is enabled with {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, this 323 * control is overridden by the AWB routine. When AWB is disabled, the 324 * application controls how the color mapping is performed.</p> 325 * <p>We define the expected processing pipeline below. For consistency 326 * across devices, this is always the case with TRANSFORM_MATRIX.</p> 327 * <p>When either FULL or HIGH_QUALITY is used, the camera device may 328 * do additional processing but {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and 329 * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} will still be provided by the 330 * camera device (in the results) and be roughly correct.</p> 331 * <p>Switching to TRANSFORM_MATRIX and using the data provided from 332 * FAST or HIGH_QUALITY will yield a picture with the same white point 333 * as what was produced by the camera device in the earlier frame.</p> 334 * <p>The expected processing pipeline is as follows:</p> 335 * <p><img alt="White balance processing pipeline" src="../../../../images/camera2/metadata/android.colorCorrection.mode/processing_pipeline.png" /></p> 336 * <p>The white balance is encoded by two values, a 4-channel white-balance 337 * gain vector (applied in the Bayer domain), and a 3x3 color transform 338 * matrix (applied after demosaic).</p> 339 * <p>The 4-channel white-balance gains are defined as:</p> 340 * <pre><code>{@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} = [ R G_even G_odd B ] 341 * </code></pre> 342 * <p>where <code>G_even</code> is the gain for green pixels on even rows of the 343 * output, and <code>G_odd</code> is the gain for green pixels on the odd rows. 344 * These may be identical for a given camera device implementation; if 345 * the camera device does not support a separate gain for even/odd green 346 * channels, it will use the <code>G_even</code> value, and write <code>G_odd</code> equal to 347 * <code>G_even</code> in the output result metadata.</p> 348 * <p>The matrices for color transforms are defined as a 9-entry vector:</p> 349 * <pre><code>{@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} = [ I0 I1 I2 I3 I4 I5 I6 I7 I8 ] 350 * </code></pre> 351 * <p>which define a transform from input sensor colors, <code>P_in = [ r g b ]</code>, 352 * to output linear sRGB, <code>P_out = [ r' g' b' ]</code>,</p> 353 * <p>with colors as follows:</p> 354 * <pre><code>r' = I0r + I1g + I2b 355 * g' = I3r + I4g + I5b 356 * b' = I6r + I7g + I8b 357 * </code></pre> 358 * <p>Both the input and output value ranges must match. Overflow/underflow 359 * values are clipped to fit within the range.</p> 360 * 361 * @see CaptureRequest#COLOR_CORRECTION_GAINS 362 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM 363 * @see CaptureRequest#CONTROL_AWB_MODE 364 * @see #COLOR_CORRECTION_MODE_TRANSFORM_MATRIX 365 * @see #COLOR_CORRECTION_MODE_FAST 366 * @see #COLOR_CORRECTION_MODE_HIGH_QUALITY 367 */ 368 public static final Key<Integer> COLOR_CORRECTION_MODE = 369 new Key<Integer>("android.colorCorrection.mode", int.class); 370 371 /** 372 * <p>A color transform matrix to use to transform 373 * from sensor RGB color space to output linear sRGB color space</p> 374 * <p>This matrix is either set by the camera device when the request 375 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not TRANSFORM_MATRIX, or 376 * directly by the application in the request when the 377 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is TRANSFORM_MATRIX.</p> 378 * <p>In the latter case, the camera device may round the matrix to account 379 * for precision issues; the final rounded matrix should be reported back 380 * in this matrix result metadata. The transform should keep the magnitude 381 * of the output color values within <code>[0, 1.0]</code> (assuming input color 382 * values is within the normalized range <code>[0, 1.0]</code>), or clipping may occur.</p> 383 * 384 * @see CaptureRequest#COLOR_CORRECTION_MODE 385 */ 386 public static final Key<android.hardware.camera2.params.ColorSpaceTransform> COLOR_CORRECTION_TRANSFORM = 387 new Key<android.hardware.camera2.params.ColorSpaceTransform>("android.colorCorrection.transform", android.hardware.camera2.params.ColorSpaceTransform.class); 388 389 /** 390 * <p>Gains applying to Bayer raw color channels for 391 * white-balance.</p> 392 * <p>These per-channel gains are either set by the camera device 393 * when the request {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not 394 * TRANSFORM_MATRIX, or directly by the application in the 395 * request when the {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is 396 * TRANSFORM_MATRIX.</p> 397 * <p>The gains in the result metadata are the gains actually 398 * applied by the camera device to the current frame.</p> 399 * 400 * @see CaptureRequest#COLOR_CORRECTION_MODE 401 */ 402 public static final Key<android.hardware.camera2.params.RggbChannelVector> COLOR_CORRECTION_GAINS = 403 new Key<android.hardware.camera2.params.RggbChannelVector>("android.colorCorrection.gains", android.hardware.camera2.params.RggbChannelVector.class); 404 405 /** 406 * <p>The desired setting for the camera device's auto-exposure 407 * algorithm's antibanding compensation.</p> 408 * <p>Some kinds of lighting fixtures, such as some fluorescent 409 * lights, flicker at the rate of the power supply frequency 410 * (60Hz or 50Hz, depending on country). While this is 411 * typically not noticeable to a person, it can be visible to 412 * a camera device. If a camera sets its exposure time to the 413 * wrong value, the flicker may become visible in the 414 * viewfinder as flicker or in a final captured image, as a 415 * set of variable-brightness bands across the image.</p> 416 * <p>Therefore, the auto-exposure routines of camera devices 417 * include antibanding routines that ensure that the chosen 418 * exposure value will not cause such banding. The choice of 419 * exposure time depends on the rate of flicker, which the 420 * camera device can detect automatically, or the expected 421 * rate can be selected by the application using this 422 * control.</p> 423 * <p>A given camera device may not support all of the possible 424 * options for the antibanding mode. The 425 * {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES android.control.aeAvailableAntibandingModes} key contains 426 * the available modes for a given camera device.</p> 427 * <p>The default mode is AUTO, which must be supported by all 428 * camera devices.</p> 429 * <p>If manual exposure control is enabled (by setting 430 * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link CaptureRequest#CONTROL_MODE android.control.mode} to OFF), 431 * then this setting has no effect, and the application must 432 * ensure it selects exposure times that do not cause banding 433 * issues. The {@link CaptureResult#STATISTICS_SCENE_FLICKER android.statistics.sceneFlicker} key can assist 434 * the application in this.</p> 435 * 436 * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES 437 * @see CaptureRequest#CONTROL_AE_MODE 438 * @see CaptureRequest#CONTROL_MODE 439 * @see CaptureResult#STATISTICS_SCENE_FLICKER 440 * @see #CONTROL_AE_ANTIBANDING_MODE_OFF 441 * @see #CONTROL_AE_ANTIBANDING_MODE_50HZ 442 * @see #CONTROL_AE_ANTIBANDING_MODE_60HZ 443 * @see #CONTROL_AE_ANTIBANDING_MODE_AUTO 444 */ 445 public static final Key<Integer> CONTROL_AE_ANTIBANDING_MODE = 446 new Key<Integer>("android.control.aeAntibandingMode", int.class); 447 448 /** 449 * <p>Adjustment to AE target image 450 * brightness</p> 451 * <p>For example, if EV step is 0.333, '6' will mean an 452 * exposure compensation of +2 EV; -3 will mean an exposure 453 * compensation of -1 EV. Note that this control will only be effective 454 * if {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} <code>!=</code> OFF. This control will take effect even when 455 * {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} <code>== true</code>.</p> 456 * <p>In the event of exposure compensation value being changed, camera device 457 * may take several frames to reach the newly requested exposure target. 458 * During that time, {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} field will be in the SEARCHING 459 * state. Once the new exposure target is reached, {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} will 460 * change from SEARCHING to either CONVERGED, LOCKED (if AE lock is enabled), or 461 * FLASH_REQUIRED (if the scene is too dark for still capture).</p> 462 * 463 * @see CaptureRequest#CONTROL_AE_LOCK 464 * @see CaptureRequest#CONTROL_AE_MODE 465 * @see CaptureResult#CONTROL_AE_STATE 466 */ 467 public static final Key<Integer> CONTROL_AE_EXPOSURE_COMPENSATION = 468 new Key<Integer>("android.control.aeExposureCompensation", int.class); 469 470 /** 471 * <p>Whether AE is currently locked to its latest 472 * calculated values.</p> 473 * <p>Note that even when AE is locked, the flash may be 474 * fired if the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_AUTO_FLASH / ON_ALWAYS_FLASH / 475 * ON_AUTO_FLASH_REDEYE.</p> 476 * <p>When {@link CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION android.control.aeExposureCompensation} is changed, even if the AE lock 477 * is ON, the camera device will still adjust its exposure value.</p> 478 * <p>If AE precapture is triggered (see {@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}) 479 * when AE is already locked, the camera device will not change the exposure time 480 * ({@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}) and sensitivity ({@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}) 481 * parameters. The flash may be fired if the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} 482 * is ON_AUTO_FLASH/ON_AUTO_FLASH_REDEYE and the scene is too dark. If the 483 * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_ALWAYS_FLASH, the scene may become overexposed.</p> 484 * <p>See {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE lock related state transition details.</p> 485 * 486 * @see CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION 487 * @see CaptureRequest#CONTROL_AE_MODE 488 * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER 489 * @see CaptureResult#CONTROL_AE_STATE 490 * @see CaptureRequest#SENSOR_EXPOSURE_TIME 491 * @see CaptureRequest#SENSOR_SENSITIVITY 492 */ 493 public static final Key<Boolean> CONTROL_AE_LOCK = 494 new Key<Boolean>("android.control.aeLock", boolean.class); 495 496 /** 497 * <p>The desired mode for the camera device's 498 * auto-exposure routine.</p> 499 * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is 500 * AUTO.</p> 501 * <p>When set to any of the ON modes, the camera device's 502 * auto-exposure routine is enabled, overriding the 503 * application's selected exposure time, sensor sensitivity, 504 * and frame duration ({@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, 505 * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and 506 * {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}). If one of the FLASH modes 507 * is selected, the camera device's flash unit controls are 508 * also overridden.</p> 509 * <p>The FLASH modes are only available if the camera device 510 * has a flash unit ({@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} is <code>true</code>).</p> 511 * <p>If flash TORCH mode is desired, this field must be set to 512 * ON or OFF, and {@link CaptureRequest#FLASH_MODE android.flash.mode} set to TORCH.</p> 513 * <p>When set to any of the ON modes, the values chosen by the 514 * camera device auto-exposure routine for the overridden 515 * fields for a given capture will be available in its 516 * CaptureResult.</p> 517 * 518 * @see CaptureRequest#CONTROL_MODE 519 * @see CameraCharacteristics#FLASH_INFO_AVAILABLE 520 * @see CaptureRequest#FLASH_MODE 521 * @see CaptureRequest#SENSOR_EXPOSURE_TIME 522 * @see CaptureRequest#SENSOR_FRAME_DURATION 523 * @see CaptureRequest#SENSOR_SENSITIVITY 524 * @see #CONTROL_AE_MODE_OFF 525 * @see #CONTROL_AE_MODE_ON 526 * @see #CONTROL_AE_MODE_ON_AUTO_FLASH 527 * @see #CONTROL_AE_MODE_ON_ALWAYS_FLASH 528 * @see #CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE 529 */ 530 public static final Key<Integer> CONTROL_AE_MODE = 531 new Key<Integer>("android.control.aeMode", int.class); 532 533 /** 534 * <p>List of areas to use for 535 * metering.</p> 536 * <p>The coordinate system is based on the active pixel array, 537 * with (0,0) being the top-left pixel in the active pixel array, and 538 * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 539 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 540 * bottom-right pixel in the active pixel array. The weight 541 * should be nonnegative.</p> 542 * <p>If all regions have 0 weight, then no specific metering area 543 * needs to be used by the camera device. If the metering region is 544 * outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in capture result metadata, 545 * the camera device will ignore the sections outside the region and output the 546 * used sections in the result metadata.</p> 547 * 548 * @see CaptureRequest#SCALER_CROP_REGION 549 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 550 */ 551 public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AE_REGIONS = 552 new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.aeRegions", android.hardware.camera2.params.MeteringRectangle[].class); 553 554 /** 555 * <p>Range over which fps can be adjusted to 556 * maintain exposure</p> 557 * <p>Only constrains AE algorithm, not manual control 558 * of {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}</p> 559 * 560 * @see CaptureRequest#SENSOR_EXPOSURE_TIME 561 */ 562 public static final Key<android.util.Range<Integer>> CONTROL_AE_TARGET_FPS_RANGE = 563 new Key<android.util.Range<Integer>>("android.control.aeTargetFpsRange", new TypeReference<android.util.Range<Integer>>() {{ }}); 564 565 /** 566 * <p>Whether the camera device will trigger a precapture 567 * metering sequence when it processes this request.</p> 568 * <p>This entry is normally set to IDLE, or is not 569 * included at all in the request settings. When included and 570 * set to START, the camera device will trigger the autoexposure 571 * precapture metering sequence.</p> 572 * <p>The effect of AE precapture trigger depends on the current 573 * AE mode and state; see {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE precapture 574 * state transition details.</p> 575 * 576 * @see CaptureResult#CONTROL_AE_STATE 577 * @see #CONTROL_AE_PRECAPTURE_TRIGGER_IDLE 578 * @see #CONTROL_AE_PRECAPTURE_TRIGGER_START 579 */ 580 public static final Key<Integer> CONTROL_AE_PRECAPTURE_TRIGGER = 581 new Key<Integer>("android.control.aePrecaptureTrigger", int.class); 582 583 /** 584 * <p>Current state of AE algorithm</p> 585 * <p>Switching between or enabling AE modes ({@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode}) always 586 * resets the AE state to INACTIVE. Similarly, switching between {@link CaptureRequest#CONTROL_MODE android.control.mode}, 587 * or {@link CaptureRequest#CONTROL_SCENE_MODE android.control.sceneMode} if <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code> resets all 588 * the algorithm states to INACTIVE.</p> 589 * <p>The camera device can do several state transitions between two results, if it is 590 * allowed by the state transition table. For example: INACTIVE may never actually be 591 * seen in a result.</p> 592 * <p>The state in the result is the state for this image (in sync with this image): if 593 * AE state becomes CONVERGED, then the image data associated with this result should 594 * be good to use.</p> 595 * <p>Below are state transition tables for different AE modes.</p> 596 * <table> 597 * <thead> 598 * <tr> 599 * <th align="center">State</th> 600 * <th align="center">Transition Cause</th> 601 * <th align="center">New State</th> 602 * <th align="center">Notes</th> 603 * </tr> 604 * </thead> 605 * <tbody> 606 * <tr> 607 * <td align="center">INACTIVE</td> 608 * <td align="center"></td> 609 * <td align="center">INACTIVE</td> 610 * <td align="center">Camera device auto exposure algorithm is disabled</td> 611 * </tr> 612 * </tbody> 613 * </table> 614 * <p>When {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is AE_MODE_ON_*:</p> 615 * <table> 616 * <thead> 617 * <tr> 618 * <th align="center">State</th> 619 * <th align="center">Transition Cause</th> 620 * <th align="center">New State</th> 621 * <th align="center">Notes</th> 622 * </tr> 623 * </thead> 624 * <tbody> 625 * <tr> 626 * <td align="center">INACTIVE</td> 627 * <td align="center">Camera device initiates AE scan</td> 628 * <td align="center">SEARCHING</td> 629 * <td align="center">Values changing</td> 630 * </tr> 631 * <tr> 632 * <td align="center">INACTIVE</td> 633 * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON</td> 634 * <td align="center">LOCKED</td> 635 * <td align="center">Values locked</td> 636 * </tr> 637 * <tr> 638 * <td align="center">SEARCHING</td> 639 * <td align="center">Camera device finishes AE scan</td> 640 * <td align="center">CONVERGED</td> 641 * <td align="center">Good values, not changing</td> 642 * </tr> 643 * <tr> 644 * <td align="center">SEARCHING</td> 645 * <td align="center">Camera device finishes AE scan</td> 646 * <td align="center">FLASH_REQUIRED</td> 647 * <td align="center">Converged but too dark w/o flash</td> 648 * </tr> 649 * <tr> 650 * <td align="center">SEARCHING</td> 651 * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON</td> 652 * <td align="center">LOCKED</td> 653 * <td align="center">Values locked</td> 654 * </tr> 655 * <tr> 656 * <td align="center">CONVERGED</td> 657 * <td align="center">Camera device initiates AE scan</td> 658 * <td align="center">SEARCHING</td> 659 * <td align="center">Values changing</td> 660 * </tr> 661 * <tr> 662 * <td align="center">CONVERGED</td> 663 * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON</td> 664 * <td align="center">LOCKED</td> 665 * <td align="center">Values locked</td> 666 * </tr> 667 * <tr> 668 * <td align="center">FLASH_REQUIRED</td> 669 * <td align="center">Camera device initiates AE scan</td> 670 * <td align="center">SEARCHING</td> 671 * <td align="center">Values changing</td> 672 * </tr> 673 * <tr> 674 * <td align="center">FLASH_REQUIRED</td> 675 * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON</td> 676 * <td align="center">LOCKED</td> 677 * <td align="center">Values locked</td> 678 * </tr> 679 * <tr> 680 * <td align="center">LOCKED</td> 681 * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFF</td> 682 * <td align="center">SEARCHING</td> 683 * <td align="center">Values not good after unlock</td> 684 * </tr> 685 * <tr> 686 * <td align="center">LOCKED</td> 687 * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFF</td> 688 * <td align="center">CONVERGED</td> 689 * <td align="center">Values good after unlock</td> 690 * </tr> 691 * <tr> 692 * <td align="center">LOCKED</td> 693 * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFF</td> 694 * <td align="center">FLASH_REQUIRED</td> 695 * <td align="center">Exposure good, but too dark</td> 696 * </tr> 697 * <tr> 698 * <td align="center">PRECAPTURE</td> 699 * <td align="center">Sequence done. {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFF</td> 700 * <td align="center">CONVERGED</td> 701 * <td align="center">Ready for high-quality capture</td> 702 * </tr> 703 * <tr> 704 * <td align="center">PRECAPTURE</td> 705 * <td align="center">Sequence done. {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON</td> 706 * <td align="center">LOCKED</td> 707 * <td align="center">Ready for high-quality capture</td> 708 * </tr> 709 * <tr> 710 * <td align="center">Any state</td> 711 * <td align="center">{@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger} is START</td> 712 * <td align="center">PRECAPTURE</td> 713 * <td align="center">Start AE precapture metering sequence</td> 714 * </tr> 715 * </tbody> 716 * </table> 717 * <p>For the above table, the camera device may skip reporting any state changes that happen 718 * without application intervention (i.e. mode switch, trigger, locking). Any state that 719 * can be skipped in that manner is called a transient state.</p> 720 * <p>For example, for above AE modes (AE_MODE_ON_*), in addition to the state transitions 721 * listed in above table, it is also legal for the camera device to skip one or more 722 * transient states between two results. See below table for examples:</p> 723 * <table> 724 * <thead> 725 * <tr> 726 * <th align="center">State</th> 727 * <th align="center">Transition Cause</th> 728 * <th align="center">New State</th> 729 * <th align="center">Notes</th> 730 * </tr> 731 * </thead> 732 * <tbody> 733 * <tr> 734 * <td align="center">INACTIVE</td> 735 * <td align="center">Camera device finished AE scan</td> 736 * <td align="center">CONVERGED</td> 737 * <td align="center">Values are already good, transient states are skipped by camera device.</td> 738 * </tr> 739 * <tr> 740 * <td align="center">Any state</td> 741 * <td align="center">{@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger} is START, sequence done</td> 742 * <td align="center">FLASH_REQUIRED</td> 743 * <td align="center">Converged but too dark w/o flash after a precapture sequence, transient states are skipped by camera device.</td> 744 * </tr> 745 * <tr> 746 * <td align="center">Any state</td> 747 * <td align="center">{@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger} is START, sequence done</td> 748 * <td align="center">CONVERGED</td> 749 * <td align="center">Converged after a precapture sequence, transient states are skipped by camera device.</td> 750 * </tr> 751 * <tr> 752 * <td align="center">CONVERGED</td> 753 * <td align="center">Camera device finished AE scan</td> 754 * <td align="center">FLASH_REQUIRED</td> 755 * <td align="center">Converged but too dark w/o flash after a new scan, transient states are skipped by camera device.</td> 756 * </tr> 757 * <tr> 758 * <td align="center">FLASH_REQUIRED</td> 759 * <td align="center">Camera device finished AE scan</td> 760 * <td align="center">CONVERGED</td> 761 * <td align="center">Converged after a new scan, transient states are skipped by camera device.</td> 762 * </tr> 763 * </tbody> 764 * </table> 765 * 766 * @see CaptureRequest#CONTROL_AE_LOCK 767 * @see CaptureRequest#CONTROL_AE_MODE 768 * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER 769 * @see CaptureRequest#CONTROL_MODE 770 * @see CaptureRequest#CONTROL_SCENE_MODE 771 * @see #CONTROL_AE_STATE_INACTIVE 772 * @see #CONTROL_AE_STATE_SEARCHING 773 * @see #CONTROL_AE_STATE_CONVERGED 774 * @see #CONTROL_AE_STATE_LOCKED 775 * @see #CONTROL_AE_STATE_FLASH_REQUIRED 776 * @see #CONTROL_AE_STATE_PRECAPTURE 777 */ 778 public static final Key<Integer> CONTROL_AE_STATE = 779 new Key<Integer>("android.control.aeState", int.class); 780 781 /** 782 * <p>Whether AF is currently enabled, and what 783 * mode it is set to</p> 784 * <p>Only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} = AUTO and the lens is not fixed focus 785 * (i.e. <code>{@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} > 0</code>).</p> 786 * <p>If the lens is controlled by the camera device auto-focus algorithm, 787 * the camera device will report the current AF status in {@link CaptureResult#CONTROL_AF_STATE android.control.afState} 788 * in result metadata.</p> 789 * 790 * @see CaptureResult#CONTROL_AF_STATE 791 * @see CaptureRequest#CONTROL_MODE 792 * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE 793 * @see #CONTROL_AF_MODE_OFF 794 * @see #CONTROL_AF_MODE_AUTO 795 * @see #CONTROL_AF_MODE_MACRO 796 * @see #CONTROL_AF_MODE_CONTINUOUS_VIDEO 797 * @see #CONTROL_AF_MODE_CONTINUOUS_PICTURE 798 * @see #CONTROL_AF_MODE_EDOF 799 */ 800 public static final Key<Integer> CONTROL_AF_MODE = 801 new Key<Integer>("android.control.afMode", int.class); 802 803 /** 804 * <p>List of areas to use for focus 805 * estimation.</p> 806 * <p>The coordinate system is based on the active pixel array, 807 * with (0,0) being the top-left pixel in the active pixel array, and 808 * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 809 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 810 * bottom-right pixel in the active pixel array. The weight 811 * should be nonnegative.</p> 812 * <p>If all regions have 0 weight, then no specific metering area 813 * needs to be used by the camera device. If the metering region is 814 * outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in capture result metadata, 815 * the camera device will ignore the sections outside the region and output the 816 * used sections in the result metadata.</p> 817 * 818 * @see CaptureRequest#SCALER_CROP_REGION 819 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 820 */ 821 public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AF_REGIONS = 822 new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.afRegions", android.hardware.camera2.params.MeteringRectangle[].class); 823 824 /** 825 * <p>Whether the camera device will trigger autofocus for this request.</p> 826 * <p>This entry is normally set to IDLE, or is not 827 * included at all in the request settings.</p> 828 * <p>When included and set to START, the camera device will trigger the 829 * autofocus algorithm. If autofocus is disabled, this trigger has no effect.</p> 830 * <p>When set to CANCEL, the camera device will cancel any active trigger, 831 * and return to its initial AF state.</p> 832 * <p>See {@link CaptureResult#CONTROL_AF_STATE android.control.afState} for what that means for each AF mode.</p> 833 * 834 * @see CaptureResult#CONTROL_AF_STATE 835 * @see #CONTROL_AF_TRIGGER_IDLE 836 * @see #CONTROL_AF_TRIGGER_START 837 * @see #CONTROL_AF_TRIGGER_CANCEL 838 */ 839 public static final Key<Integer> CONTROL_AF_TRIGGER = 840 new Key<Integer>("android.control.afTrigger", int.class); 841 842 /** 843 * <p>Current state of AF algorithm.</p> 844 * <p>Switching between or enabling AF modes ({@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}) always 845 * resets the AF state to INACTIVE. Similarly, switching between {@link CaptureRequest#CONTROL_MODE android.control.mode}, 846 * or {@link CaptureRequest#CONTROL_SCENE_MODE android.control.sceneMode} if <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code> resets all 847 * the algorithm states to INACTIVE.</p> 848 * <p>The camera device can do several state transitions between two results, if it is 849 * allowed by the state transition table. For example: INACTIVE may never actually be 850 * seen in a result.</p> 851 * <p>The state in the result is the state for this image (in sync with this image): if 852 * AF state becomes FOCUSED, then the image data associated with this result should 853 * be sharp.</p> 854 * <p>Below are state transition tables for different AF modes.</p> 855 * <p>When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_OFF or AF_MODE_EDOF:</p> 856 * <table> 857 * <thead> 858 * <tr> 859 * <th align="center">State</th> 860 * <th align="center">Transition Cause</th> 861 * <th align="center">New State</th> 862 * <th align="center">Notes</th> 863 * </tr> 864 * </thead> 865 * <tbody> 866 * <tr> 867 * <td align="center">INACTIVE</td> 868 * <td align="center"></td> 869 * <td align="center">INACTIVE</td> 870 * <td align="center">Never changes</td> 871 * </tr> 872 * </tbody> 873 * </table> 874 * <p>When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_AUTO or AF_MODE_MACRO:</p> 875 * <table> 876 * <thead> 877 * <tr> 878 * <th align="center">State</th> 879 * <th align="center">Transition Cause</th> 880 * <th align="center">New State</th> 881 * <th align="center">Notes</th> 882 * </tr> 883 * </thead> 884 * <tbody> 885 * <tr> 886 * <td align="center">INACTIVE</td> 887 * <td align="center">AF_TRIGGER</td> 888 * <td align="center">ACTIVE_SCAN</td> 889 * <td align="center">Start AF sweep, Lens now moving</td> 890 * </tr> 891 * <tr> 892 * <td align="center">ACTIVE_SCAN</td> 893 * <td align="center">AF sweep done</td> 894 * <td align="center">FOCUSED_LOCKED</td> 895 * <td align="center">Focused, Lens now locked</td> 896 * </tr> 897 * <tr> 898 * <td align="center">ACTIVE_SCAN</td> 899 * <td align="center">AF sweep done</td> 900 * <td align="center">NOT_FOCUSED_LOCKED</td> 901 * <td align="center">Not focused, Lens now locked</td> 902 * </tr> 903 * <tr> 904 * <td align="center">ACTIVE_SCAN</td> 905 * <td align="center">AF_CANCEL</td> 906 * <td align="center">INACTIVE</td> 907 * <td align="center">Cancel/reset AF, Lens now locked</td> 908 * </tr> 909 * <tr> 910 * <td align="center">FOCUSED_LOCKED</td> 911 * <td align="center">AF_CANCEL</td> 912 * <td align="center">INACTIVE</td> 913 * <td align="center">Cancel/reset AF</td> 914 * </tr> 915 * <tr> 916 * <td align="center">FOCUSED_LOCKED</td> 917 * <td align="center">AF_TRIGGER</td> 918 * <td align="center">ACTIVE_SCAN</td> 919 * <td align="center">Start new sweep, Lens now moving</td> 920 * </tr> 921 * <tr> 922 * <td align="center">NOT_FOCUSED_LOCKED</td> 923 * <td align="center">AF_CANCEL</td> 924 * <td align="center">INACTIVE</td> 925 * <td align="center">Cancel/reset AF</td> 926 * </tr> 927 * <tr> 928 * <td align="center">NOT_FOCUSED_LOCKED</td> 929 * <td align="center">AF_TRIGGER</td> 930 * <td align="center">ACTIVE_SCAN</td> 931 * <td align="center">Start new sweep, Lens now moving</td> 932 * </tr> 933 * <tr> 934 * <td align="center">Any state</td> 935 * <td align="center">Mode change</td> 936 * <td align="center">INACTIVE</td> 937 * <td align="center"></td> 938 * </tr> 939 * </tbody> 940 * </table> 941 * <p>For the above table, the camera device may skip reporting any state changes that happen 942 * without application intervention (i.e. mode switch, trigger, locking). Any state that 943 * can be skipped in that manner is called a transient state.</p> 944 * <p>For example, for these AF modes (AF_MODE_AUTO and AF_MODE_MACRO), in addition to the 945 * state transitions listed in above table, it is also legal for the camera device to skip 946 * one or more transient states between two results. See below table for examples:</p> 947 * <table> 948 * <thead> 949 * <tr> 950 * <th align="center">State</th> 951 * <th align="center">Transition Cause</th> 952 * <th align="center">New State</th> 953 * <th align="center">Notes</th> 954 * </tr> 955 * </thead> 956 * <tbody> 957 * <tr> 958 * <td align="center">INACTIVE</td> 959 * <td align="center">AF_TRIGGER</td> 960 * <td align="center">FOCUSED_LOCKED</td> 961 * <td align="center">Focus is already good or good after a scan, lens is now locked.</td> 962 * </tr> 963 * <tr> 964 * <td align="center">INACTIVE</td> 965 * <td align="center">AF_TRIGGER</td> 966 * <td align="center">NOT_FOCUSED_LOCKED</td> 967 * <td align="center">Focus failed after a scan, lens is now locked.</td> 968 * </tr> 969 * <tr> 970 * <td align="center">FOCUSED_LOCKED</td> 971 * <td align="center">AF_TRIGGER</td> 972 * <td align="center">FOCUSED_LOCKED</td> 973 * <td align="center">Focus is already good or good after a scan, lens is now locked.</td> 974 * </tr> 975 * <tr> 976 * <td align="center">NOT_FOCUSED_LOCKED</td> 977 * <td align="center">AF_TRIGGER</td> 978 * <td align="center">FOCUSED_LOCKED</td> 979 * <td align="center">Focus is good after a scan, lens is not locked.</td> 980 * </tr> 981 * </tbody> 982 * </table> 983 * <p>When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_CONTINUOUS_VIDEO:</p> 984 * <table> 985 * <thead> 986 * <tr> 987 * <th align="center">State</th> 988 * <th align="center">Transition Cause</th> 989 * <th align="center">New State</th> 990 * <th align="center">Notes</th> 991 * </tr> 992 * </thead> 993 * <tbody> 994 * <tr> 995 * <td align="center">INACTIVE</td> 996 * <td align="center">Camera device initiates new scan</td> 997 * <td align="center">PASSIVE_SCAN</td> 998 * <td align="center">Start AF scan, Lens now moving</td> 999 * </tr> 1000 * <tr> 1001 * <td align="center">INACTIVE</td> 1002 * <td align="center">AF_TRIGGER</td> 1003 * <td align="center">NOT_FOCUSED_LOCKED</td> 1004 * <td align="center">AF state query, Lens now locked</td> 1005 * </tr> 1006 * <tr> 1007 * <td align="center">PASSIVE_SCAN</td> 1008 * <td align="center">Camera device completes current scan</td> 1009 * <td align="center">PASSIVE_FOCUSED</td> 1010 * <td align="center">End AF scan, Lens now locked</td> 1011 * </tr> 1012 * <tr> 1013 * <td align="center">PASSIVE_SCAN</td> 1014 * <td align="center">Camera device fails current scan</td> 1015 * <td align="center">PASSIVE_UNFOCUSED</td> 1016 * <td align="center">End AF scan, Lens now locked</td> 1017 * </tr> 1018 * <tr> 1019 * <td align="center">PASSIVE_SCAN</td> 1020 * <td align="center">AF_TRIGGER</td> 1021 * <td align="center">FOCUSED_LOCKED</td> 1022 * <td align="center">Immediate trans. If focus is good, Lens now locked</td> 1023 * </tr> 1024 * <tr> 1025 * <td align="center">PASSIVE_SCAN</td> 1026 * <td align="center">AF_TRIGGER</td> 1027 * <td align="center">NOT_FOCUSED_LOCKED</td> 1028 * <td align="center">Immediate trans. if focus is bad, Lens now locked</td> 1029 * </tr> 1030 * <tr> 1031 * <td align="center">PASSIVE_SCAN</td> 1032 * <td align="center">AF_CANCEL</td> 1033 * <td align="center">INACTIVE</td> 1034 * <td align="center">Reset lens position, Lens now locked</td> 1035 * </tr> 1036 * <tr> 1037 * <td align="center">PASSIVE_FOCUSED</td> 1038 * <td align="center">Camera device initiates new scan</td> 1039 * <td align="center">PASSIVE_SCAN</td> 1040 * <td align="center">Start AF scan, Lens now moving</td> 1041 * </tr> 1042 * <tr> 1043 * <td align="center">PASSIVE_UNFOCUSED</td> 1044 * <td align="center">Camera device initiates new scan</td> 1045 * <td align="center">PASSIVE_SCAN</td> 1046 * <td align="center">Start AF scan, Lens now moving</td> 1047 * </tr> 1048 * <tr> 1049 * <td align="center">PASSIVE_FOCUSED</td> 1050 * <td align="center">AF_TRIGGER</td> 1051 * <td align="center">FOCUSED_LOCKED</td> 1052 * <td align="center">Immediate trans. Lens now locked</td> 1053 * </tr> 1054 * <tr> 1055 * <td align="center">PASSIVE_UNFOCUSED</td> 1056 * <td align="center">AF_TRIGGER</td> 1057 * <td align="center">NOT_FOCUSED_LOCKED</td> 1058 * <td align="center">Immediate trans. Lens now locked</td> 1059 * </tr> 1060 * <tr> 1061 * <td align="center">FOCUSED_LOCKED</td> 1062 * <td align="center">AF_TRIGGER</td> 1063 * <td align="center">FOCUSED_LOCKED</td> 1064 * <td align="center">No effect</td> 1065 * </tr> 1066 * <tr> 1067 * <td align="center">FOCUSED_LOCKED</td> 1068 * <td align="center">AF_CANCEL</td> 1069 * <td align="center">INACTIVE</td> 1070 * <td align="center">Restart AF scan</td> 1071 * </tr> 1072 * <tr> 1073 * <td align="center">NOT_FOCUSED_LOCKED</td> 1074 * <td align="center">AF_TRIGGER</td> 1075 * <td align="center">NOT_FOCUSED_LOCKED</td> 1076 * <td align="center">No effect</td> 1077 * </tr> 1078 * <tr> 1079 * <td align="center">NOT_FOCUSED_LOCKED</td> 1080 * <td align="center">AF_CANCEL</td> 1081 * <td align="center">INACTIVE</td> 1082 * <td align="center">Restart AF scan</td> 1083 * </tr> 1084 * </tbody> 1085 * </table> 1086 * <p>When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_CONTINUOUS_PICTURE:</p> 1087 * <table> 1088 * <thead> 1089 * <tr> 1090 * <th align="center">State</th> 1091 * <th align="center">Transition Cause</th> 1092 * <th align="center">New State</th> 1093 * <th align="center">Notes</th> 1094 * </tr> 1095 * </thead> 1096 * <tbody> 1097 * <tr> 1098 * <td align="center">INACTIVE</td> 1099 * <td align="center">Camera device initiates new scan</td> 1100 * <td align="center">PASSIVE_SCAN</td> 1101 * <td align="center">Start AF scan, Lens now moving</td> 1102 * </tr> 1103 * <tr> 1104 * <td align="center">INACTIVE</td> 1105 * <td align="center">AF_TRIGGER</td> 1106 * <td align="center">NOT_FOCUSED_LOCKED</td> 1107 * <td align="center">AF state query, Lens now locked</td> 1108 * </tr> 1109 * <tr> 1110 * <td align="center">PASSIVE_SCAN</td> 1111 * <td align="center">Camera device completes current scan</td> 1112 * <td align="center">PASSIVE_FOCUSED</td> 1113 * <td align="center">End AF scan, Lens now locked</td> 1114 * </tr> 1115 * <tr> 1116 * <td align="center">PASSIVE_SCAN</td> 1117 * <td align="center">Camera device fails current scan</td> 1118 * <td align="center">PASSIVE_UNFOCUSED</td> 1119 * <td align="center">End AF scan, Lens now locked</td> 1120 * </tr> 1121 * <tr> 1122 * <td align="center">PASSIVE_SCAN</td> 1123 * <td align="center">AF_TRIGGER</td> 1124 * <td align="center">FOCUSED_LOCKED</td> 1125 * <td align="center">Eventual trans. once focus good, Lens now locked</td> 1126 * </tr> 1127 * <tr> 1128 * <td align="center">PASSIVE_SCAN</td> 1129 * <td align="center">AF_TRIGGER</td> 1130 * <td align="center">NOT_FOCUSED_LOCKED</td> 1131 * <td align="center">Eventual trans. if cannot focus, Lens now locked</td> 1132 * </tr> 1133 * <tr> 1134 * <td align="center">PASSIVE_SCAN</td> 1135 * <td align="center">AF_CANCEL</td> 1136 * <td align="center">INACTIVE</td> 1137 * <td align="center">Reset lens position, Lens now locked</td> 1138 * </tr> 1139 * <tr> 1140 * <td align="center">PASSIVE_FOCUSED</td> 1141 * <td align="center">Camera device initiates new scan</td> 1142 * <td align="center">PASSIVE_SCAN</td> 1143 * <td align="center">Start AF scan, Lens now moving</td> 1144 * </tr> 1145 * <tr> 1146 * <td align="center">PASSIVE_UNFOCUSED</td> 1147 * <td align="center">Camera device initiates new scan</td> 1148 * <td align="center">PASSIVE_SCAN</td> 1149 * <td align="center">Start AF scan, Lens now moving</td> 1150 * </tr> 1151 * <tr> 1152 * <td align="center">PASSIVE_FOCUSED</td> 1153 * <td align="center">AF_TRIGGER</td> 1154 * <td align="center">FOCUSED_LOCKED</td> 1155 * <td align="center">Immediate trans. Lens now locked</td> 1156 * </tr> 1157 * <tr> 1158 * <td align="center">PASSIVE_UNFOCUSED</td> 1159 * <td align="center">AF_TRIGGER</td> 1160 * <td align="center">NOT_FOCUSED_LOCKED</td> 1161 * <td align="center">Immediate trans. Lens now locked</td> 1162 * </tr> 1163 * <tr> 1164 * <td align="center">FOCUSED_LOCKED</td> 1165 * <td align="center">AF_TRIGGER</td> 1166 * <td align="center">FOCUSED_LOCKED</td> 1167 * <td align="center">No effect</td> 1168 * </tr> 1169 * <tr> 1170 * <td align="center">FOCUSED_LOCKED</td> 1171 * <td align="center">AF_CANCEL</td> 1172 * <td align="center">INACTIVE</td> 1173 * <td align="center">Restart AF scan</td> 1174 * </tr> 1175 * <tr> 1176 * <td align="center">NOT_FOCUSED_LOCKED</td> 1177 * <td align="center">AF_TRIGGER</td> 1178 * <td align="center">NOT_FOCUSED_LOCKED</td> 1179 * <td align="center">No effect</td> 1180 * </tr> 1181 * <tr> 1182 * <td align="center">NOT_FOCUSED_LOCKED</td> 1183 * <td align="center">AF_CANCEL</td> 1184 * <td align="center">INACTIVE</td> 1185 * <td align="center">Restart AF scan</td> 1186 * </tr> 1187 * </tbody> 1188 * </table> 1189 * <p>When switch between AF_MODE_CONTINUOUS_* (CAF modes) and AF_MODE_AUTO/AF_MODE_MACRO 1190 * (AUTO modes), the initial INACTIVE or PASSIVE_SCAN states may be skipped by the 1191 * camera device. When a trigger is included in a mode switch request, the trigger 1192 * will be evaluated in the context of the new mode in the request. 1193 * See below table for examples:</p> 1194 * <table> 1195 * <thead> 1196 * <tr> 1197 * <th align="center">State</th> 1198 * <th align="center">Transition Cause</th> 1199 * <th align="center">New State</th> 1200 * <th align="center">Notes</th> 1201 * </tr> 1202 * </thead> 1203 * <tbody> 1204 * <tr> 1205 * <td align="center">any state</td> 1206 * <td align="center">CAF-->AUTO mode switch</td> 1207 * <td align="center">INACTIVE</td> 1208 * <td align="center">Mode switch without trigger, initial state must be INACTIVE</td> 1209 * </tr> 1210 * <tr> 1211 * <td align="center">any state</td> 1212 * <td align="center">CAF-->AUTO mode switch with AF_TRIGGER</td> 1213 * <td align="center">trigger-reachable states from INACTIVE</td> 1214 * <td align="center">Mode switch with trigger, INACTIVE is skipped</td> 1215 * </tr> 1216 * <tr> 1217 * <td align="center">any state</td> 1218 * <td align="center">AUTO-->CAF mode switch</td> 1219 * <td align="center">passively reachable states from INACTIVE</td> 1220 * <td align="center">Mode switch without trigger, passive transient state is skipped</td> 1221 * </tr> 1222 * </tbody> 1223 * </table> 1224 * 1225 * @see CaptureRequest#CONTROL_AF_MODE 1226 * @see CaptureRequest#CONTROL_MODE 1227 * @see CaptureRequest#CONTROL_SCENE_MODE 1228 * @see #CONTROL_AF_STATE_INACTIVE 1229 * @see #CONTROL_AF_STATE_PASSIVE_SCAN 1230 * @see #CONTROL_AF_STATE_PASSIVE_FOCUSED 1231 * @see #CONTROL_AF_STATE_ACTIVE_SCAN 1232 * @see #CONTROL_AF_STATE_FOCUSED_LOCKED 1233 * @see #CONTROL_AF_STATE_NOT_FOCUSED_LOCKED 1234 * @see #CONTROL_AF_STATE_PASSIVE_UNFOCUSED 1235 */ 1236 public static final Key<Integer> CONTROL_AF_STATE = 1237 new Key<Integer>("android.control.afState", int.class); 1238 1239 /** 1240 * <p>Whether AWB is currently locked to its 1241 * latest calculated values.</p> 1242 * <p>Note that AWB lock is only meaningful for AUTO 1243 * mode; in other modes, AWB is already fixed to a specific 1244 * setting.</p> 1245 */ 1246 public static final Key<Boolean> CONTROL_AWB_LOCK = 1247 new Key<Boolean>("android.control.awbLock", boolean.class); 1248 1249 /** 1250 * <p>Whether AWB is currently setting the color 1251 * transform fields, and what its illumination target 1252 * is.</p> 1253 * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is AUTO.</p> 1254 * <p>When set to the ON mode, the camera device's auto white balance 1255 * routine is enabled, overriding the application's selected 1256 * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and 1257 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.</p> 1258 * <p>When set to the OFF mode, the camera device's auto white balance 1259 * routine is disabled. The application manually controls the white 1260 * balance by {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} 1261 * and {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.</p> 1262 * <p>When set to any other modes, the camera device's auto white balance 1263 * routine is disabled. The camera device uses each particular illumination 1264 * target for white balance adjustment.</p> 1265 * 1266 * @see CaptureRequest#COLOR_CORRECTION_GAINS 1267 * @see CaptureRequest#COLOR_CORRECTION_MODE 1268 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM 1269 * @see CaptureRequest#CONTROL_MODE 1270 * @see #CONTROL_AWB_MODE_OFF 1271 * @see #CONTROL_AWB_MODE_AUTO 1272 * @see #CONTROL_AWB_MODE_INCANDESCENT 1273 * @see #CONTROL_AWB_MODE_FLUORESCENT 1274 * @see #CONTROL_AWB_MODE_WARM_FLUORESCENT 1275 * @see #CONTROL_AWB_MODE_DAYLIGHT 1276 * @see #CONTROL_AWB_MODE_CLOUDY_DAYLIGHT 1277 * @see #CONTROL_AWB_MODE_TWILIGHT 1278 * @see #CONTROL_AWB_MODE_SHADE 1279 */ 1280 public static final Key<Integer> CONTROL_AWB_MODE = 1281 new Key<Integer>("android.control.awbMode", int.class); 1282 1283 /** 1284 * <p>List of areas to use for illuminant 1285 * estimation.</p> 1286 * <p>The coordinate system is based on the active pixel array, 1287 * with (0,0) being the top-left pixel in the active pixel array, and 1288 * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 1289 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 1290 * bottom-right pixel in the active pixel array. The weight 1291 * should be nonnegative.</p> 1292 * <p>If all regions have 0 weight, then no specific metering area 1293 * needs to be used by the camera device. If the metering region is 1294 * outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in capture result metadata, 1295 * the camera device will ignore the sections outside the region and output the 1296 * used sections in the result metadata.</p> 1297 * 1298 * @see CaptureRequest#SCALER_CROP_REGION 1299 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 1300 */ 1301 public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AWB_REGIONS = 1302 new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.awbRegions", android.hardware.camera2.params.MeteringRectangle[].class); 1303 1304 /** 1305 * <p>Information to the camera device 3A (auto-exposure, 1306 * auto-focus, auto-white balance) routines about the purpose 1307 * of this capture, to help the camera device to decide optimal 3A 1308 * strategy.</p> 1309 * <p>This control (except for MANUAL) is only effective if 1310 * <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} != OFF</code> and any 3A routine is active.</p> 1311 * <p>ZERO_SHUTTER_LAG must be supported if {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} 1312 * contains ZSL. MANUAL must be supported if {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} 1313 * contains MANUAL_SENSOR.</p> 1314 * 1315 * @see CaptureRequest#CONTROL_MODE 1316 * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES 1317 * @see #CONTROL_CAPTURE_INTENT_CUSTOM 1318 * @see #CONTROL_CAPTURE_INTENT_PREVIEW 1319 * @see #CONTROL_CAPTURE_INTENT_STILL_CAPTURE 1320 * @see #CONTROL_CAPTURE_INTENT_VIDEO_RECORD 1321 * @see #CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT 1322 * @see #CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG 1323 * @see #CONTROL_CAPTURE_INTENT_MANUAL 1324 */ 1325 public static final Key<Integer> CONTROL_CAPTURE_INTENT = 1326 new Key<Integer>("android.control.captureIntent", int.class); 1327 1328 /** 1329 * <p>Current state of AWB algorithm</p> 1330 * <p>Switching between or enabling AWB modes ({@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}) always 1331 * resets the AWB state to INACTIVE. Similarly, switching between {@link CaptureRequest#CONTROL_MODE android.control.mode}, 1332 * or {@link CaptureRequest#CONTROL_SCENE_MODE android.control.sceneMode} if <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code> resets all 1333 * the algorithm states to INACTIVE.</p> 1334 * <p>The camera device can do several state transitions between two results, if it is 1335 * allowed by the state transition table. So INACTIVE may never actually be seen in 1336 * a result.</p> 1337 * <p>The state in the result is the state for this image (in sync with this image): if 1338 * AWB state becomes CONVERGED, then the image data associated with this result should 1339 * be good to use.</p> 1340 * <p>Below are state transition tables for different AWB modes.</p> 1341 * <p>When <code>{@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} != AWB_MODE_AUTO</code>:</p> 1342 * <table> 1343 * <thead> 1344 * <tr> 1345 * <th align="center">State</th> 1346 * <th align="center">Transition Cause</th> 1347 * <th align="center">New State</th> 1348 * <th align="center">Notes</th> 1349 * </tr> 1350 * </thead> 1351 * <tbody> 1352 * <tr> 1353 * <td align="center">INACTIVE</td> 1354 * <td align="center"></td> 1355 * <td align="center">INACTIVE</td> 1356 * <td align="center">Camera device auto white balance algorithm is disabled</td> 1357 * </tr> 1358 * </tbody> 1359 * </table> 1360 * <p>When {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} is AWB_MODE_AUTO:</p> 1361 * <table> 1362 * <thead> 1363 * <tr> 1364 * <th align="center">State</th> 1365 * <th align="center">Transition Cause</th> 1366 * <th align="center">New State</th> 1367 * <th align="center">Notes</th> 1368 * </tr> 1369 * </thead> 1370 * <tbody> 1371 * <tr> 1372 * <td align="center">INACTIVE</td> 1373 * <td align="center">Camera device initiates AWB scan</td> 1374 * <td align="center">SEARCHING</td> 1375 * <td align="center">Values changing</td> 1376 * </tr> 1377 * <tr> 1378 * <td align="center">INACTIVE</td> 1379 * <td align="center">{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is ON</td> 1380 * <td align="center">LOCKED</td> 1381 * <td align="center">Values locked</td> 1382 * </tr> 1383 * <tr> 1384 * <td align="center">SEARCHING</td> 1385 * <td align="center">Camera device finishes AWB scan</td> 1386 * <td align="center">CONVERGED</td> 1387 * <td align="center">Good values, not changing</td> 1388 * </tr> 1389 * <tr> 1390 * <td align="center">SEARCHING</td> 1391 * <td align="center">{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is ON</td> 1392 * <td align="center">LOCKED</td> 1393 * <td align="center">Values locked</td> 1394 * </tr> 1395 * <tr> 1396 * <td align="center">CONVERGED</td> 1397 * <td align="center">Camera device initiates AWB scan</td> 1398 * <td align="center">SEARCHING</td> 1399 * <td align="center">Values changing</td> 1400 * </tr> 1401 * <tr> 1402 * <td align="center">CONVERGED</td> 1403 * <td align="center">{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is ON</td> 1404 * <td align="center">LOCKED</td> 1405 * <td align="center">Values locked</td> 1406 * </tr> 1407 * <tr> 1408 * <td align="center">LOCKED</td> 1409 * <td align="center">{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is OFF</td> 1410 * <td align="center">SEARCHING</td> 1411 * <td align="center">Values not good after unlock</td> 1412 * </tr> 1413 * </tbody> 1414 * </table> 1415 * <p>For the above table, the camera device may skip reporting any state changes that happen 1416 * without application intervention (i.e. mode switch, trigger, locking). Any state that 1417 * can be skipped in that manner is called a transient state.</p> 1418 * <p>For example, for this AWB mode (AWB_MODE_AUTO), in addition to the state transitions 1419 * listed in above table, it is also legal for the camera device to skip one or more 1420 * transient states between two results. See below table for examples:</p> 1421 * <table> 1422 * <thead> 1423 * <tr> 1424 * <th align="center">State</th> 1425 * <th align="center">Transition Cause</th> 1426 * <th align="center">New State</th> 1427 * <th align="center">Notes</th> 1428 * </tr> 1429 * </thead> 1430 * <tbody> 1431 * <tr> 1432 * <td align="center">INACTIVE</td> 1433 * <td align="center">Camera device finished AWB scan</td> 1434 * <td align="center">CONVERGED</td> 1435 * <td align="center">Values are already good, transient states are skipped by camera device.</td> 1436 * </tr> 1437 * <tr> 1438 * <td align="center">LOCKED</td> 1439 * <td align="center">{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is OFF</td> 1440 * <td align="center">CONVERGED</td> 1441 * <td align="center">Values good after unlock, transient states are skipped by camera device.</td> 1442 * </tr> 1443 * </tbody> 1444 * </table> 1445 * 1446 * @see CaptureRequest#CONTROL_AWB_LOCK 1447 * @see CaptureRequest#CONTROL_AWB_MODE 1448 * @see CaptureRequest#CONTROL_MODE 1449 * @see CaptureRequest#CONTROL_SCENE_MODE 1450 * @see #CONTROL_AWB_STATE_INACTIVE 1451 * @see #CONTROL_AWB_STATE_SEARCHING 1452 * @see #CONTROL_AWB_STATE_CONVERGED 1453 * @see #CONTROL_AWB_STATE_LOCKED 1454 */ 1455 public static final Key<Integer> CONTROL_AWB_STATE = 1456 new Key<Integer>("android.control.awbState", int.class); 1457 1458 /** 1459 * <p>A special color effect to apply.</p> 1460 * <p>When this mode is set, a color effect will be applied 1461 * to images produced by the camera device. The interpretation 1462 * and implementation of these color effects is left to the 1463 * implementor of the camera device, and should not be 1464 * depended on to be consistent (or present) across all 1465 * devices.</p> 1466 * <p>A color effect will only be applied if 1467 * {@link CaptureRequest#CONTROL_MODE android.control.mode} != OFF.</p> 1468 * 1469 * @see CaptureRequest#CONTROL_MODE 1470 * @see #CONTROL_EFFECT_MODE_OFF 1471 * @see #CONTROL_EFFECT_MODE_MONO 1472 * @see #CONTROL_EFFECT_MODE_NEGATIVE 1473 * @see #CONTROL_EFFECT_MODE_SOLARIZE 1474 * @see #CONTROL_EFFECT_MODE_SEPIA 1475 * @see #CONTROL_EFFECT_MODE_POSTERIZE 1476 * @see #CONTROL_EFFECT_MODE_WHITEBOARD 1477 * @see #CONTROL_EFFECT_MODE_BLACKBOARD 1478 * @see #CONTROL_EFFECT_MODE_AQUA 1479 */ 1480 public static final Key<Integer> CONTROL_EFFECT_MODE = 1481 new Key<Integer>("android.control.effectMode", int.class); 1482 1483 /** 1484 * <p>Overall mode of 3A control 1485 * routines.</p> 1486 * <p>High-level 3A control. When set to OFF, all 3A control 1487 * by the camera device is disabled. The application must set the fields for 1488 * capture parameters itself.</p> 1489 * <p>When set to AUTO, the individual algorithm controls in 1490 * android.control.* are in effect, such as {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}.</p> 1491 * <p>When set to USE_SCENE_MODE, the individual controls in 1492 * android.control.* are mostly disabled, and the camera device implements 1493 * one of the scene mode settings (such as ACTION, SUNSET, or PARTY) 1494 * as it wishes. The camera device scene mode 3A settings are provided by 1495 * android.control.sceneModeOverrides.</p> 1496 * <p>When set to OFF_KEEP_STATE, it is similar to OFF mode, the only difference 1497 * is that this frame will not be used by camera device background 3A statistics 1498 * update, as if this frame is never captured. This mode can be used in the scenario 1499 * where the application doesn't want a 3A manual control capture to affect 1500 * the subsequent auto 3A capture results.</p> 1501 * 1502 * @see CaptureRequest#CONTROL_AF_MODE 1503 * @see #CONTROL_MODE_OFF 1504 * @see #CONTROL_MODE_AUTO 1505 * @see #CONTROL_MODE_USE_SCENE_MODE 1506 * @see #CONTROL_MODE_OFF_KEEP_STATE 1507 */ 1508 public static final Key<Integer> CONTROL_MODE = 1509 new Key<Integer>("android.control.mode", int.class); 1510 1511 /** 1512 * <p>A camera mode optimized for conditions typical in a particular 1513 * capture setting.</p> 1514 * <p>This is the mode that that is active when 1515 * <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code>. Aside from FACE_PRIORITY, 1516 * these modes will disable {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode}, 1517 * {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, and {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} while in use.</p> 1518 * <p>The interpretation and implementation of these scene modes is left 1519 * to the implementor of the camera device. Their behavior will not be 1520 * consistent across all devices, and any given device may only implement 1521 * a subset of these modes.</p> 1522 * 1523 * @see CaptureRequest#CONTROL_AE_MODE 1524 * @see CaptureRequest#CONTROL_AF_MODE 1525 * @see CaptureRequest#CONTROL_AWB_MODE 1526 * @see CaptureRequest#CONTROL_MODE 1527 * @see #CONTROL_SCENE_MODE_DISABLED 1528 * @see #CONTROL_SCENE_MODE_FACE_PRIORITY 1529 * @see #CONTROL_SCENE_MODE_ACTION 1530 * @see #CONTROL_SCENE_MODE_PORTRAIT 1531 * @see #CONTROL_SCENE_MODE_LANDSCAPE 1532 * @see #CONTROL_SCENE_MODE_NIGHT 1533 * @see #CONTROL_SCENE_MODE_NIGHT_PORTRAIT 1534 * @see #CONTROL_SCENE_MODE_THEATRE 1535 * @see #CONTROL_SCENE_MODE_BEACH 1536 * @see #CONTROL_SCENE_MODE_SNOW 1537 * @see #CONTROL_SCENE_MODE_SUNSET 1538 * @see #CONTROL_SCENE_MODE_STEADYPHOTO 1539 * @see #CONTROL_SCENE_MODE_FIREWORKS 1540 * @see #CONTROL_SCENE_MODE_SPORTS 1541 * @see #CONTROL_SCENE_MODE_PARTY 1542 * @see #CONTROL_SCENE_MODE_CANDLELIGHT 1543 * @see #CONTROL_SCENE_MODE_BARCODE 1544 */ 1545 public static final Key<Integer> CONTROL_SCENE_MODE = 1546 new Key<Integer>("android.control.sceneMode", int.class); 1547 1548 /** 1549 * <p>Whether video stabilization is 1550 * active</p> 1551 * <p>If enabled, video stabilization can modify the 1552 * {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} to keep the video stream 1553 * stabilized</p> 1554 * 1555 * @see CaptureRequest#SCALER_CROP_REGION 1556 * @see #CONTROL_VIDEO_STABILIZATION_MODE_OFF 1557 * @see #CONTROL_VIDEO_STABILIZATION_MODE_ON 1558 */ 1559 public static final Key<Integer> CONTROL_VIDEO_STABILIZATION_MODE = 1560 new Key<Integer>("android.control.videoStabilizationMode", int.class); 1561 1562 /** 1563 * <p>Operation mode for edge 1564 * enhancement.</p> 1565 * <p>Edge/sharpness/detail enhancement. OFF means no 1566 * enhancement will be applied by the camera device.</p> 1567 * <p>This must be set to one of the modes listed in {@link CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES android.edge.availableEdgeModes}.</p> 1568 * <p>FAST/HIGH_QUALITY both mean camera device determined enhancement 1569 * will be applied. HIGH_QUALITY mode indicates that the 1570 * camera device will use the highest-quality enhancement algorithms, 1571 * even if it slows down capture rate. FAST means the camera device will 1572 * not slow down capture rate when applying edge enhancement.</p> 1573 * 1574 * @see CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES 1575 * @see #EDGE_MODE_OFF 1576 * @see #EDGE_MODE_FAST 1577 * @see #EDGE_MODE_HIGH_QUALITY 1578 */ 1579 public static final Key<Integer> EDGE_MODE = 1580 new Key<Integer>("android.edge.mode", int.class); 1581 1582 /** 1583 * <p>The desired mode for for the camera device's flash control.</p> 1584 * <p>This control is only effective when flash unit is available 1585 * (<code>{@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} == true</code>).</p> 1586 * <p>When this control is used, the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} must be set to ON or OFF. 1587 * Otherwise, the camera device auto-exposure related flash control (ON_AUTO_FLASH, 1588 * ON_ALWAYS_FLASH, or ON_AUTO_FLASH_REDEYE) will override this control.</p> 1589 * <p>When set to OFF, the camera device will not fire flash for this capture.</p> 1590 * <p>When set to SINGLE, the camera device will fire flash regardless of the camera 1591 * device's auto-exposure routine's result. When used in still capture case, this 1592 * control should be used along with AE precapture metering sequence 1593 * ({@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}), otherwise, the image may be incorrectly exposed.</p> 1594 * <p>When set to TORCH, the flash will be on continuously. This mode can be used 1595 * for use cases such as preview, auto-focus assist, still capture, or video recording.</p> 1596 * <p>The flash status will be reported by {@link CaptureResult#FLASH_STATE android.flash.state} in the capture result metadata.</p> 1597 * 1598 * @see CaptureRequest#CONTROL_AE_MODE 1599 * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER 1600 * @see CameraCharacteristics#FLASH_INFO_AVAILABLE 1601 * @see CaptureResult#FLASH_STATE 1602 * @see #FLASH_MODE_OFF 1603 * @see #FLASH_MODE_SINGLE 1604 * @see #FLASH_MODE_TORCH 1605 */ 1606 public static final Key<Integer> FLASH_MODE = 1607 new Key<Integer>("android.flash.mode", int.class); 1608 1609 /** 1610 * <p>Current state of the flash 1611 * unit.</p> 1612 * <p>When the camera device doesn't have flash unit 1613 * (i.e. <code>{@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} == false</code>), this state will always be UNAVAILABLE. 1614 * Other states indicate the current flash status.</p> 1615 * 1616 * @see CameraCharacteristics#FLASH_INFO_AVAILABLE 1617 * @see #FLASH_STATE_UNAVAILABLE 1618 * @see #FLASH_STATE_CHARGING 1619 * @see #FLASH_STATE_READY 1620 * @see #FLASH_STATE_FIRED 1621 * @see #FLASH_STATE_PARTIAL 1622 */ 1623 public static final Key<Integer> FLASH_STATE = 1624 new Key<Integer>("android.flash.state", int.class); 1625 1626 /** 1627 * <p>Set operational mode for hot pixel correction.</p> 1628 * <p>Valid modes for this camera device are listed in 1629 * {@link CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES android.hotPixel.availableHotPixelModes}.</p> 1630 * <p>Hotpixel correction interpolates out, or otherwise removes, pixels 1631 * that do not accurately encode the incoming light (i.e. pixels that 1632 * are stuck at an arbitrary value).</p> 1633 * 1634 * @see CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES 1635 * @see #HOT_PIXEL_MODE_OFF 1636 * @see #HOT_PIXEL_MODE_FAST 1637 * @see #HOT_PIXEL_MODE_HIGH_QUALITY 1638 */ 1639 public static final Key<Integer> HOT_PIXEL_MODE = 1640 new Key<Integer>("android.hotPixel.mode", int.class); 1641 1642 /** 1643 * <p>A location object to use when generating image GPS metadata.</p> 1644 */ 1645 public static final Key<android.location.Location> JPEG_GPS_LOCATION = 1646 new Key<android.location.Location>("android.jpeg.gpsLocation", android.location.Location.class); 1647 1648 /** 1649 * <p>GPS coordinates to include in output JPEG 1650 * EXIF</p> 1651 * @hide 1652 */ 1653 public static final Key<double[]> JPEG_GPS_COORDINATES = 1654 new Key<double[]>("android.jpeg.gpsCoordinates", double[].class); 1655 1656 /** 1657 * <p>32 characters describing GPS algorithm to 1658 * include in EXIF</p> 1659 * @hide 1660 */ 1661 public static final Key<String> JPEG_GPS_PROCESSING_METHOD = 1662 new Key<String>("android.jpeg.gpsProcessingMethod", String.class); 1663 1664 /** 1665 * <p>Time GPS fix was made to include in 1666 * EXIF</p> 1667 * @hide 1668 */ 1669 public static final Key<Long> JPEG_GPS_TIMESTAMP = 1670 new Key<Long>("android.jpeg.gpsTimestamp", long.class); 1671 1672 /** 1673 * <p>Orientation of JPEG image to 1674 * write</p> 1675 */ 1676 public static final Key<Integer> JPEG_ORIENTATION = 1677 new Key<Integer>("android.jpeg.orientation", int.class); 1678 1679 /** 1680 * <p>Compression quality of the final JPEG 1681 * image</p> 1682 * <p>85-95 is typical usage range</p> 1683 */ 1684 public static final Key<Byte> JPEG_QUALITY = 1685 new Key<Byte>("android.jpeg.quality", byte.class); 1686 1687 /** 1688 * <p>Compression quality of JPEG 1689 * thumbnail</p> 1690 */ 1691 public static final Key<Byte> JPEG_THUMBNAIL_QUALITY = 1692 new Key<Byte>("android.jpeg.thumbnailQuality", byte.class); 1693 1694 /** 1695 * <p>Resolution of embedded JPEG thumbnail</p> 1696 * <p>When set to (0, 0) value, the JPEG EXIF will not contain thumbnail, 1697 * but the captured JPEG will still be a valid image.</p> 1698 * <p>When a jpeg image capture is issued, the thumbnail size selected should have 1699 * the same aspect ratio as the jpeg image.</p> 1700 * <p>If the thumbnail image aspect ratio differs from the JPEG primary image aspect 1701 * ratio, the camera device creates the thumbnail by cropping it from the primary image. 1702 * For example, if the primary image has 4:3 aspect ratio, the thumbnail image has 1703 * 16:9 aspect ratio, the primary image will be cropped vertically (letterbox) to 1704 * generate the thumbnail image. The thumbnail image will always have a smaller Field 1705 * Of View (FOV) than the primary image when aspect ratios differ.</p> 1706 */ 1707 public static final Key<android.util.Size> JPEG_THUMBNAIL_SIZE = 1708 new Key<android.util.Size>("android.jpeg.thumbnailSize", android.util.Size.class); 1709 1710 /** 1711 * <p>The ratio of lens focal length to the effective 1712 * aperture diameter.</p> 1713 * <p>This will only be supported on the camera devices that 1714 * have variable aperture lens. The aperture value can only be 1715 * one of the values listed in {@link CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES android.lens.info.availableApertures}.</p> 1716 * <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is OFF, 1717 * this can be set along with {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, 1718 * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration} 1719 * to achieve manual exposure control.</p> 1720 * <p>The requested aperture value may take several frames to reach the 1721 * requested value; the camera device will report the current (intermediate) 1722 * aperture size in capture result metadata while the aperture is changing. 1723 * While the aperture is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> 1724 * <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is one of 1725 * the ON modes, this will be overridden by the camera device 1726 * auto-exposure algorithm, the overridden values are then provided 1727 * back to the user in the corresponding result.</p> 1728 * 1729 * @see CaptureRequest#CONTROL_AE_MODE 1730 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES 1731 * @see CaptureResult#LENS_STATE 1732 * @see CaptureRequest#SENSOR_EXPOSURE_TIME 1733 * @see CaptureRequest#SENSOR_FRAME_DURATION 1734 * @see CaptureRequest#SENSOR_SENSITIVITY 1735 */ 1736 public static final Key<Float> LENS_APERTURE = 1737 new Key<Float>("android.lens.aperture", float.class); 1738 1739 /** 1740 * <p>State of lens neutral density filter(s).</p> 1741 * <p>This will not be supported on most camera devices. On devices 1742 * where this is supported, this may only be set to one of the 1743 * values included in {@link CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES android.lens.info.availableFilterDensities}.</p> 1744 * <p>Lens filters are typically used to lower the amount of light the 1745 * sensor is exposed to (measured in steps of EV). As used here, an EV 1746 * step is the standard logarithmic representation, which are 1747 * non-negative, and inversely proportional to the amount of light 1748 * hitting the sensor. For example, setting this to 0 would result 1749 * in no reduction of the incoming light, and setting this to 2 would 1750 * mean that the filter is set to reduce incoming light by two stops 1751 * (allowing 1/4 of the prior amount of light to the sensor).</p> 1752 * <p>It may take several frames before the lens filter density changes 1753 * to the requested value. While the filter density is still changing, 1754 * {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> 1755 * 1756 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES 1757 * @see CaptureResult#LENS_STATE 1758 */ 1759 public static final Key<Float> LENS_FILTER_DENSITY = 1760 new Key<Float>("android.lens.filterDensity", float.class); 1761 1762 /** 1763 * <p>The current lens focal length; used for optical zoom.</p> 1764 * <p>This setting controls the physical focal length of the camera 1765 * device's lens. Changing the focal length changes the field of 1766 * view of the camera device, and is usually used for optical zoom.</p> 1767 * <p>Like {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance} and {@link CaptureRequest#LENS_APERTURE android.lens.aperture}, this 1768 * setting won't be applied instantaneously, and it may take several 1769 * frames before the lens can change to the requested focal length. 1770 * While the focal length is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will 1771 * be set to MOVING.</p> 1772 * <p>This is expected not to be supported on most devices.</p> 1773 * 1774 * @see CaptureRequest#LENS_APERTURE 1775 * @see CaptureRequest#LENS_FOCUS_DISTANCE 1776 * @see CaptureResult#LENS_STATE 1777 */ 1778 public static final Key<Float> LENS_FOCAL_LENGTH = 1779 new Key<Float>("android.lens.focalLength", float.class); 1780 1781 /** 1782 * <p>Distance to plane of sharpest focus, 1783 * measured from frontmost surface of the lens</p> 1784 * <p>Should be zero for fixed-focus cameras</p> 1785 */ 1786 public static final Key<Float> LENS_FOCUS_DISTANCE = 1787 new Key<Float>("android.lens.focusDistance", float.class); 1788 1789 /** 1790 * <p>The range of scene distances that are in 1791 * sharp focus (depth of field)</p> 1792 * <p>If variable focus not supported, can still report 1793 * fixed depth of field range</p> 1794 */ 1795 public static final Key<android.util.Pair<Float,Float>> LENS_FOCUS_RANGE = 1796 new Key<android.util.Pair<Float,Float>>("android.lens.focusRange", new TypeReference<android.util.Pair<Float,Float>>() {{ }}); 1797 1798 /** 1799 * <p>Sets whether the camera device uses optical image stabilization (OIS) 1800 * when capturing images.</p> 1801 * <p>OIS is used to compensate for motion blur due to small movements of 1802 * the camera during capture. Unlike digital image stabilization, OIS makes 1803 * use of mechanical elements to stabilize the camera sensor, and thus 1804 * allows for longer exposure times before camera shake becomes 1805 * apparent.</p> 1806 * <p>This is not expected to be supported on most devices.</p> 1807 * @see #LENS_OPTICAL_STABILIZATION_MODE_OFF 1808 * @see #LENS_OPTICAL_STABILIZATION_MODE_ON 1809 */ 1810 public static final Key<Integer> LENS_OPTICAL_STABILIZATION_MODE = 1811 new Key<Integer>("android.lens.opticalStabilizationMode", int.class); 1812 1813 /** 1814 * <p>Current lens status.</p> 1815 * <p>For lens parameters {@link CaptureRequest#LENS_FOCAL_LENGTH android.lens.focalLength}, {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance}, 1816 * {@link CaptureRequest#LENS_FILTER_DENSITY android.lens.filterDensity} and {@link CaptureRequest#LENS_APERTURE android.lens.aperture}, when changes are requested, 1817 * they may take several frames to reach the requested values. This state indicates 1818 * the current status of the lens parameters.</p> 1819 * <p>When the state is STATIONARY, the lens parameters are not changing. This could be 1820 * either because the parameters are all fixed, or because the lens has had enough 1821 * time to reach the most recently-requested values. 1822 * If all these lens parameters are not changable for a camera device, as listed below:</p> 1823 * <ul> 1824 * <li>Fixed focus (<code>{@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} == 0</code>), which means 1825 * {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance} parameter will always be 0.</li> 1826 * <li>Fixed focal length ({@link CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS android.lens.info.availableFocalLengths} contains single value), 1827 * which means the optical zoom is not supported.</li> 1828 * <li>No ND filter ({@link CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES android.lens.info.availableFilterDensities} contains only 0).</li> 1829 * <li>Fixed aperture ({@link CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES android.lens.info.availableApertures} contains single value).</li> 1830 * </ul> 1831 * <p>Then this state will always be STATIONARY.</p> 1832 * <p>When the state is MOVING, it indicates that at least one of the lens parameters 1833 * is changing.</p> 1834 * 1835 * @see CaptureRequest#LENS_APERTURE 1836 * @see CaptureRequest#LENS_FILTER_DENSITY 1837 * @see CaptureRequest#LENS_FOCAL_LENGTH 1838 * @see CaptureRequest#LENS_FOCUS_DISTANCE 1839 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES 1840 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES 1841 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS 1842 * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE 1843 * @see #LENS_STATE_STATIONARY 1844 * @see #LENS_STATE_MOVING 1845 */ 1846 public static final Key<Integer> LENS_STATE = 1847 new Key<Integer>("android.lens.state", int.class); 1848 1849 /** 1850 * <p>Mode of operation for the noise reduction 1851 * algorithm</p> 1852 * <p>Noise filtering control. OFF means no noise reduction 1853 * will be applied by the camera device.</p> 1854 * <p>This must be set to a valid mode in 1855 * {@link CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES android.noiseReduction.availableNoiseReductionModes}.</p> 1856 * <p>FAST/HIGH_QUALITY both mean camera device determined noise filtering 1857 * will be applied. HIGH_QUALITY mode indicates that the camera device 1858 * will use the highest-quality noise filtering algorithms, 1859 * even if it slows down capture rate. FAST means the camera device should not 1860 * slow down capture rate when applying noise filtering.</p> 1861 * 1862 * @see CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES 1863 * @see #NOISE_REDUCTION_MODE_OFF 1864 * @see #NOISE_REDUCTION_MODE_FAST 1865 * @see #NOISE_REDUCTION_MODE_HIGH_QUALITY 1866 */ 1867 public static final Key<Integer> NOISE_REDUCTION_MODE = 1868 new Key<Integer>("android.noiseReduction.mode", int.class); 1869 1870 /** 1871 * <p>Whether a result given to the framework is the 1872 * final one for the capture, or only a partial that contains a 1873 * subset of the full set of dynamic metadata 1874 * values.</p> 1875 * <p>The entries in the result metadata buffers for a 1876 * single capture may not overlap, except for this entry. The 1877 * FINAL buffers must retain FIFO ordering relative to the 1878 * requests that generate them, so the FINAL buffer for frame 3 must 1879 * always be sent to the framework after the FINAL buffer for frame 2, and 1880 * before the FINAL buffer for frame 4. PARTIAL buffers may be returned 1881 * in any order relative to other frames, but all PARTIAL buffers for a given 1882 * capture must arrive before the FINAL buffer for that capture. This entry may 1883 * only be used by the camera device if quirks.usePartialResult is set to 1.</p> 1884 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1885 * @deprecated 1886 * @hide 1887 */ 1888 @Deprecated 1889 public static final Key<Boolean> QUIRKS_PARTIAL_RESULT = 1890 new Key<Boolean>("android.quirks.partialResult", boolean.class); 1891 1892 /** 1893 * <p>A frame counter set by the framework. This value monotonically 1894 * increases with every new result (that is, each new result has a unique 1895 * frameCount value).</p> 1896 * <p>Reset on release()</p> 1897 */ 1898 public static final Key<Integer> REQUEST_FRAME_COUNT = 1899 new Key<Integer>("android.request.frameCount", int.class); 1900 1901 /** 1902 * <p>An application-specified ID for the current 1903 * request. Must be maintained unchanged in output 1904 * frame</p> 1905 * @hide 1906 */ 1907 public static final Key<Integer> REQUEST_ID = 1908 new Key<Integer>("android.request.id", int.class); 1909 1910 /** 1911 * <p>Specifies the number of pipeline stages the frame went 1912 * through from when it was exposed to when the final completed result 1913 * was available to the framework.</p> 1914 * <p>Depending on what settings are used in the request, and 1915 * what streams are configured, the data may undergo less processing, 1916 * and some pipeline stages skipped.</p> 1917 * <p>See {@link CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH android.request.pipelineMaxDepth} for more details.</p> 1918 * 1919 * @see CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH 1920 */ 1921 public static final Key<Byte> REQUEST_PIPELINE_DEPTH = 1922 new Key<Byte>("android.request.pipelineDepth", byte.class); 1923 1924 /** 1925 * <p>(x, y, width, height).</p> 1926 * <p>A rectangle with the top-level corner of (x,y) and size 1927 * (width, height). The region of the sensor that is used for 1928 * output. Each stream must use this rectangle to produce its 1929 * output, cropping to a smaller region if necessary to 1930 * maintain the stream's aspect ratio.</p> 1931 * <p>HAL2.x uses only (x, y, width)</p> 1932 * <p>The crop region is applied after the RAW to other color space (e.g. YUV) 1933 * conversion. Since raw streams (e.g. RAW16) don't have the conversion stage, 1934 * it is not croppable. The crop region will be ignored by raw streams.</p> 1935 * <p>For non-raw streams, any additional per-stream cropping will 1936 * be done to maximize the final pixel area of the stream.</p> 1937 * <p>For example, if the crop region is set to a 4:3 aspect 1938 * ratio, then 4:3 streams should use the exact crop 1939 * region. 16:9 streams should further crop vertically 1940 * (letterbox).</p> 1941 * <p>Conversely, if the crop region is set to a 16:9, then 4:3 1942 * outputs should crop horizontally (pillarbox), and 16:9 1943 * streams should match exactly. These additional crops must 1944 * be centered within the crop region.</p> 1945 * <p>The output streams must maintain square pixels at all 1946 * times, no matter what the relative aspect ratios of the 1947 * crop region and the stream are. Negative values for 1948 * corner are allowed for raw output if full pixel array is 1949 * larger than active pixel array. Width and height may be 1950 * rounded to nearest larger supportable width, especially 1951 * for raw output, where only a few fixed scales may be 1952 * possible. The width and height of the crop region cannot 1953 * be set to be smaller than floor( activeArraySize.width / 1954 * {@link CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom} ) and floor( 1955 * activeArraySize.height / 1956 * {@link CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom}), respectively.</p> 1957 * 1958 * @see CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM 1959 */ 1960 public static final Key<android.graphics.Rect> SCALER_CROP_REGION = 1961 new Key<android.graphics.Rect>("android.scaler.cropRegion", android.graphics.Rect.class); 1962 1963 /** 1964 * <p>Duration each pixel is exposed to 1965 * light.</p> 1966 * <p>If the sensor can't expose this exact duration, it should shorten the 1967 * duration exposed to the nearest possible value (rather than expose longer).</p> 1968 */ 1969 public static final Key<Long> SENSOR_EXPOSURE_TIME = 1970 new Key<Long>("android.sensor.exposureTime", long.class); 1971 1972 /** 1973 * <p>Duration from start of frame exposure to 1974 * start of next frame exposure.</p> 1975 * <p>The maximum frame rate that can be supported by a camera subsystem is 1976 * a function of many factors:</p> 1977 * <ul> 1978 * <li>Requested resolutions of output image streams</li> 1979 * <li>Availability of binning / skipping modes on the imager</li> 1980 * <li>The bandwidth of the imager interface</li> 1981 * <li>The bandwidth of the various ISP processing blocks</li> 1982 * </ul> 1983 * <p>Since these factors can vary greatly between different ISPs and 1984 * sensors, the camera abstraction tries to represent the bandwidth 1985 * restrictions with as simple a model as possible.</p> 1986 * <p>The model presented has the following characteristics:</p> 1987 * <ul> 1988 * <li>The image sensor is always configured to output the smallest 1989 * resolution possible given the application's requested output stream 1990 * sizes. The smallest resolution is defined as being at least as large 1991 * as the largest requested output stream size; the camera pipeline must 1992 * never digitally upsample sensor data when the crop region covers the 1993 * whole sensor. In general, this means that if only small output stream 1994 * resolutions are configured, the sensor can provide a higher frame 1995 * rate.</li> 1996 * <li>Since any request may use any or all the currently configured 1997 * output streams, the sensor and ISP must be configured to support 1998 * scaling a single capture to all the streams at the same time. This 1999 * means the camera pipeline must be ready to produce the largest 2000 * requested output size without any delay. Therefore, the overall 2001 * frame rate of a given configured stream set is governed only by the 2002 * largest requested stream resolution.</li> 2003 * <li>Using more than one output stream in a request does not affect the 2004 * frame duration.</li> 2005 * <li>Certain format-streams may need to do additional background processing 2006 * before data is consumed/produced by that stream. These processors 2007 * can run concurrently to the rest of the camera pipeline, but 2008 * cannot process more than 1 capture at a time.</li> 2009 * </ul> 2010 * <p>The necessary information for the application, given the model above, 2011 * is provided via the {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} field 2012 * using StreamConfigurationMap#getOutputMinFrameDuration(int, Size). 2013 * These are used to determine the maximum frame rate / minimum frame 2014 * duration that is possible for a given stream configuration.</p> 2015 * <p>Specifically, the application can use the following rules to 2016 * determine the minimum frame duration it can request from the camera 2017 * device:</p> 2018 * <ol> 2019 * <li>Let the set of currently configured input/output streams 2020 * be called <code>S</code>.</li> 2021 * <li>Find the minimum frame durations for each stream in <code>S</code>, by 2022 * looking it up in {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} using 2023 * StreamConfigurationMap#getOutputMinFrameDuration(int, Size) (with 2024 * its respective size/format). Let this set of frame durations be called 2025 * <code>F</code>.</li> 2026 * <li>For any given request <code>R</code>, the minimum frame duration allowed 2027 * for <code>R</code> is the maximum out of all values in <code>F</code>. Let the streams 2028 * used in <code>R</code> be called <code>S_r</code>.</li> 2029 * </ol> 2030 * <p>If none of the streams in <code>S_r</code> have a stall time (listed in 2031 * StreamConfigurationMap#getOutputStallDuration(int,Size) using its 2032 * respective size/format), then the frame duration in 2033 * <code>F</code> determines the steady state frame rate that the application will 2034 * get if it uses <code>R</code> as a repeating request. Let this special kind 2035 * of request be called <code>Rsimple</code>.</p> 2036 * <p>A repeating request <code>Rsimple</code> can be <em>occasionally</em> interleaved 2037 * by a single capture of a new request <code>Rstall</code> (which has at least 2038 * one in-use stream with a non-0 stall time) and if <code>Rstall</code> has the 2039 * same minimum frame duration this will not cause a frame rate loss 2040 * if all buffers from the previous <code>Rstall</code> have already been 2041 * delivered.</p> 2042 * <p>For more details about stalling, see 2043 * StreamConfigurationMap#getOutputStallDuration(int,Size).</p> 2044 * 2045 * @see CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP 2046 */ 2047 public static final Key<Long> SENSOR_FRAME_DURATION = 2048 new Key<Long>("android.sensor.frameDuration", long.class); 2049 2050 /** 2051 * <p>Gain applied to image data. Must be 2052 * implemented through analog gain only if set to values 2053 * below 'maximum analog sensitivity'.</p> 2054 * <p>If the sensor can't apply this exact gain, it should lessen the 2055 * gain to the nearest possible value (rather than gain more).</p> 2056 * <p>ISO 12232:2006 REI method</p> 2057 */ 2058 public static final Key<Integer> SENSOR_SENSITIVITY = 2059 new Key<Integer>("android.sensor.sensitivity", int.class); 2060 2061 /** 2062 * <p>Time at start of exposure of first 2063 * row</p> 2064 * <p>Monotonic, should be synced to other timestamps in 2065 * system</p> 2066 */ 2067 public static final Key<Long> SENSOR_TIMESTAMP = 2068 new Key<Long>("android.sensor.timestamp", long.class); 2069 2070 /** 2071 * <p>The estimated camera neutral color in the native sensor colorspace at 2072 * the time of capture.</p> 2073 * <p>This value gives the neutral color point encoded as an RGB value in the 2074 * native sensor color space. The neutral color point indicates the 2075 * currently estimated white point of the scene illumination. It can be 2076 * used to interpolate between the provided color transforms when 2077 * processing raw sensor data.</p> 2078 * <p>The order of the values is R, G, B; where R is in the lowest index.</p> 2079 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2080 */ 2081 public static final Key<Rational[]> SENSOR_NEUTRAL_COLOR_POINT = 2082 new Key<Rational[]>("android.sensor.neutralColorPoint", Rational[].class); 2083 2084 /** 2085 * <p>The worst-case divergence between Bayer green channels.</p> 2086 * <p>This value is an estimate of the worst case split between the 2087 * Bayer green channels in the red and blue rows in the sensor color 2088 * filter array.</p> 2089 * <p>The green split is calculated as follows:</p> 2090 * <ol> 2091 * <li>A 5x5 pixel (or larger) window W within the active sensor array is 2092 * chosen. The term 'pixel' here is taken to mean a group of 4 Bayer 2093 * mosaic channels (R, Gr, Gb, B). The location and size of the window 2094 * chosen is implementation defined, and should be chosen to provide a 2095 * green split estimate that is both representative of the entire image 2096 * for this camera sensor, and can be calculated quickly.</li> 2097 * <li>The arithmetic mean of the green channels from the red 2098 * rows (mean_Gr) within W is computed.</li> 2099 * <li>The arithmetic mean of the green channels from the blue 2100 * rows (mean_Gb) within W is computed.</li> 2101 * <li>The maximum ratio R of the two means is computed as follows: 2102 * <code>R = max((mean_Gr + 1)/(mean_Gb + 1), (mean_Gb + 1)/(mean_Gr + 1))</code></li> 2103 * </ol> 2104 * <p>The ratio R is the green split divergence reported for this property, 2105 * which represents how much the green channels differ in the mosaic 2106 * pattern. This value is typically used to determine the treatment of 2107 * the green mosaic channels when demosaicing.</p> 2108 * <p>The green split value can be roughly interpreted as follows:</p> 2109 * <ul> 2110 * <li>R < 1.03 is a negligible split (<3% divergence).</li> 2111 * <li>1.20 <= R >= 1.03 will require some software 2112 * correction to avoid demosaic errors (3-20% divergence).</li> 2113 * <li>R > 1.20 will require strong software correction to produce 2114 * a usuable image (>20% divergence).</li> 2115 * </ul> 2116 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2117 */ 2118 public static final Key<Float> SENSOR_GREEN_SPLIT = 2119 new Key<Float>("android.sensor.greenSplit", float.class); 2120 2121 /** 2122 * <p>A pixel <code>[R, G_even, G_odd, B]</code> that supplies the test pattern 2123 * when {@link CaptureRequest#SENSOR_TEST_PATTERN_MODE android.sensor.testPatternMode} is SOLID_COLOR.</p> 2124 * <p>Each color channel is treated as an unsigned 32-bit integer. 2125 * The camera device then uses the most significant X bits 2126 * that correspond to how many bits are in its Bayer raw sensor 2127 * output.</p> 2128 * <p>For example, a sensor with RAW10 Bayer output would use the 2129 * 10 most significant bits from each color channel.</p> 2130 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2131 * 2132 * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE 2133 */ 2134 public static final Key<int[]> SENSOR_TEST_PATTERN_DATA = 2135 new Key<int[]>("android.sensor.testPatternData", int[].class); 2136 2137 /** 2138 * <p>When enabled, the sensor sends a test pattern instead of 2139 * doing a real exposure from the camera.</p> 2140 * <p>When a test pattern is enabled, all manual sensor controls specified 2141 * by android.sensor.* should be ignored. All other controls should 2142 * work as normal.</p> 2143 * <p>For example, if manual flash is enabled, flash firing should still 2144 * occur (and that the test pattern remain unmodified, since the flash 2145 * would not actually affect it).</p> 2146 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2147 * @see #SENSOR_TEST_PATTERN_MODE_OFF 2148 * @see #SENSOR_TEST_PATTERN_MODE_SOLID_COLOR 2149 * @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS 2150 * @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY 2151 * @see #SENSOR_TEST_PATTERN_MODE_PN9 2152 * @see #SENSOR_TEST_PATTERN_MODE_CUSTOM1 2153 */ 2154 public static final Key<Integer> SENSOR_TEST_PATTERN_MODE = 2155 new Key<Integer>("android.sensor.testPatternMode", int.class); 2156 2157 /** 2158 * <p>Quality of lens shading correction applied 2159 * to the image data.</p> 2160 * <p>When set to OFF mode, no lens shading correction will be applied by the 2161 * camera device, and an identity lens shading map data will be provided 2162 * if <code>{@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} == ON</code>. For example, for lens 2163 * shading map with size specified as <code>android.lens.info.shadingMapSize = [ 4, 3 ]</code>, 2164 * the output android.statistics.lensShadingMap for this case will be an identity map 2165 * shown below:</p> 2166 * <pre><code>[ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2167 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2168 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2169 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2170 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2171 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] 2172 * </code></pre> 2173 * <p>When set to other modes, lens shading correction will be applied by the 2174 * camera device. Applications can request lens shading map data by setting 2175 * {@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} to ON, and then the camera device will provide 2176 * lens shading map data in android.statistics.lensShadingMap, with size specified 2177 * by android.lens.info.shadingMapSize; the returned shading map data will be the one 2178 * applied by the camera device for this capture request.</p> 2179 * <p>The shading map data may depend on the AE and AWB statistics, therefore the reliability 2180 * of the map data may be affected by the AE and AWB algorithms. When AE and AWB are in 2181 * AUTO modes({@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} <code>!=</code> OFF and {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} <code>!=</code> OFF), 2182 * to get best results, it is recommended that the applications wait for the AE and AWB to 2183 * be converged before using the returned shading map data.</p> 2184 * 2185 * @see CaptureRequest#CONTROL_AE_MODE 2186 * @see CaptureRequest#CONTROL_AWB_MODE 2187 * @see CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE 2188 * @see #SHADING_MODE_OFF 2189 * @see #SHADING_MODE_FAST 2190 * @see #SHADING_MODE_HIGH_QUALITY 2191 */ 2192 public static final Key<Integer> SHADING_MODE = 2193 new Key<Integer>("android.shading.mode", int.class); 2194 2195 /** 2196 * <p>State of the face detector 2197 * unit</p> 2198 * <p>Whether face detection is enabled, and whether it 2199 * should output just the basic fields or the full set of 2200 * fields. Value must be one of the 2201 * {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES android.statistics.info.availableFaceDetectModes}.</p> 2202 * 2203 * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES 2204 * @see #STATISTICS_FACE_DETECT_MODE_OFF 2205 * @see #STATISTICS_FACE_DETECT_MODE_SIMPLE 2206 * @see #STATISTICS_FACE_DETECT_MODE_FULL 2207 */ 2208 public static final Key<Integer> STATISTICS_FACE_DETECT_MODE = 2209 new Key<Integer>("android.statistics.faceDetectMode", int.class); 2210 2211 /** 2212 * <p>List of unique IDs for detected 2213 * faces</p> 2214 * <p>Only available if faceDetectMode == FULL</p> 2215 * @hide 2216 */ 2217 public static final Key<int[]> STATISTICS_FACE_IDS = 2218 new Key<int[]>("android.statistics.faceIds", int[].class); 2219 2220 /** 2221 * <p>List of landmarks for detected 2222 * faces</p> 2223 * <p>Only available if faceDetectMode == FULL</p> 2224 * @hide 2225 */ 2226 public static final Key<int[]> STATISTICS_FACE_LANDMARKS = 2227 new Key<int[]>("android.statistics.faceLandmarks", int[].class); 2228 2229 /** 2230 * <p>List of the bounding rectangles for detected 2231 * faces</p> 2232 * <p>Only available if faceDetectMode != OFF</p> 2233 * @hide 2234 */ 2235 public static final Key<android.graphics.Rect[]> STATISTICS_FACE_RECTANGLES = 2236 new Key<android.graphics.Rect[]>("android.statistics.faceRectangles", android.graphics.Rect[].class); 2237 2238 /** 2239 * <p>List of the face confidence scores for 2240 * detected faces</p> 2241 * <p>Only available if faceDetectMode != OFF. The value should be 2242 * meaningful (for example, setting 100 at all times is illegal).</p> 2243 * @hide 2244 */ 2245 public static final Key<byte[]> STATISTICS_FACE_SCORES = 2246 new Key<byte[]>("android.statistics.faceScores", byte[].class); 2247 2248 /** 2249 * <p>List of the faces detected through camera face detection 2250 * in this result.</p> 2251 * <p>Only available if {@link CaptureRequest#STATISTICS_FACE_DETECT_MODE android.statistics.faceDetectMode} <code>!=</code> OFF.</p> 2252 * 2253 * @see CaptureRequest#STATISTICS_FACE_DETECT_MODE 2254 */ 2255 public static final Key<android.hardware.camera2.params.Face[]> STATISTICS_FACES = 2256 new Key<android.hardware.camera2.params.Face[]>("android.statistics.faces", android.hardware.camera2.params.Face[].class); 2257 2258 /** 2259 * <p>The shading map is a low-resolution floating-point map 2260 * that lists the coefficients used to correct for vignetting, for each 2261 * Bayer color channel.</p> 2262 * <p>The least shaded section of the image should have a gain factor 2263 * of 1; all other sections should have gains above 1.</p> 2264 * <p>When {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} = TRANSFORM_MATRIX, the map 2265 * must take into account the colorCorrection settings.</p> 2266 * <p>The shading map is for the entire active pixel array, and is not 2267 * affected by the crop region specified in the request. Each shading map 2268 * entry is the value of the shading compensation map over a specific 2269 * pixel on the sensor. Specifically, with a (N x M) resolution shading 2270 * map, and an active pixel array size (W x H), shading map entry 2271 * (x,y) ϵ (0 ... N-1, 0 ... M-1) is the value of the shading map at 2272 * pixel ( ((W-1)/(N-1)) * x, ((H-1)/(M-1)) * y) for the four color channels. 2273 * The map is assumed to be bilinearly interpolated between the sample points.</p> 2274 * <p>The channel order is [R, Geven, Godd, B], where Geven is the green 2275 * channel for the even rows of a Bayer pattern, and Godd is the odd rows. 2276 * The shading map is stored in a fully interleaved format.</p> 2277 * <p>The shading map should have on the order of 30-40 rows and columns, 2278 * and must be smaller than 64x64.</p> 2279 * <p>As an example, given a very small map defined as:</p> 2280 * <pre><code>width,height = [ 4, 3 ] 2281 * values = 2282 * [ 1.3, 1.2, 1.15, 1.2, 1.2, 1.2, 1.15, 1.2, 2283 * 1.1, 1.2, 1.2, 1.2, 1.3, 1.2, 1.3, 1.3, 2284 * 1.2, 1.2, 1.25, 1.1, 1.1, 1.1, 1.1, 1.0, 2285 * 1.0, 1.0, 1.0, 1.0, 1.2, 1.3, 1.25, 1.2, 2286 * 1.3, 1.2, 1.2, 1.3, 1.2, 1.15, 1.1, 1.2, 2287 * 1.2, 1.1, 1.0, 1.2, 1.3, 1.15, 1.2, 1.3 ] 2288 * </code></pre> 2289 * <p>The low-resolution scaling map images for each channel are 2290 * (displayed using nearest-neighbor interpolation):</p> 2291 * <p><img alt="Red lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/red_shading.png" /> 2292 * <img alt="Green (even rows) lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/green_e_shading.png" /> 2293 * <img alt="Green (odd rows) lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/green_o_shading.png" /> 2294 * <img alt="Blue lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/blue_shading.png" /></p> 2295 * <p>As a visualization only, inverting the full-color map to recover an 2296 * image of a gray wall (using bicubic interpolation for visual quality) as captured by the sensor gives:</p> 2297 * <p><img alt="Image of a uniform white wall (inverse shading map)" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/inv_shading.png" /></p> 2298 * 2299 * @see CaptureRequest#COLOR_CORRECTION_MODE 2300 */ 2301 public static final Key<android.hardware.camera2.params.LensShadingMap> STATISTICS_LENS_SHADING_CORRECTION_MAP = 2302 new Key<android.hardware.camera2.params.LensShadingMap>("android.statistics.lensShadingCorrectionMap", android.hardware.camera2.params.LensShadingMap.class); 2303 2304 /** 2305 * <p>The shading map is a low-resolution floating-point map 2306 * that lists the coefficients used to correct for vignetting, for each 2307 * Bayer color channel.</p> 2308 * <p>The least shaded section of the image should have a gain factor 2309 * of 1; all other sections should have gains above 1.</p> 2310 * <p>When {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} = TRANSFORM_MATRIX, the map 2311 * must take into account the colorCorrection settings.</p> 2312 * <p>The shading map is for the entire active pixel array, and is not 2313 * affected by the crop region specified in the request. Each shading map 2314 * entry is the value of the shading compensation map over a specific 2315 * pixel on the sensor. Specifically, with a (N x M) resolution shading 2316 * map, and an active pixel array size (W x H), shading map entry 2317 * (x,y) ϵ (0 ... N-1, 0 ... M-1) is the value of the shading map at 2318 * pixel ( ((W-1)/(N-1)) * x, ((H-1)/(M-1)) * y) for the four color channels. 2319 * The map is assumed to be bilinearly interpolated between the sample points.</p> 2320 * <p>The channel order is [R, Geven, Godd, B], where Geven is the green 2321 * channel for the even rows of a Bayer pattern, and Godd is the odd rows. 2322 * The shading map is stored in a fully interleaved format, and its size 2323 * is provided in the camera static metadata by android.lens.info.shadingMapSize.</p> 2324 * <p>The shading map should have on the order of 30-40 rows and columns, 2325 * and must be smaller than 64x64.</p> 2326 * <p>As an example, given a very small map defined as:</p> 2327 * <pre><code>android.lens.info.shadingMapSize = [ 4, 3 ] 2328 * android.statistics.lensShadingMap = 2329 * [ 1.3, 1.2, 1.15, 1.2, 1.2, 1.2, 1.15, 1.2, 2330 * 1.1, 1.2, 1.2, 1.2, 1.3, 1.2, 1.3, 1.3, 2331 * 1.2, 1.2, 1.25, 1.1, 1.1, 1.1, 1.1, 1.0, 2332 * 1.0, 1.0, 1.0, 1.0, 1.2, 1.3, 1.25, 1.2, 2333 * 1.3, 1.2, 1.2, 1.3, 1.2, 1.15, 1.1, 1.2, 2334 * 1.2, 1.1, 1.0, 1.2, 1.3, 1.15, 1.2, 1.3 ] 2335 * </code></pre> 2336 * <p>The low-resolution scaling map images for each channel are 2337 * (displayed using nearest-neighbor interpolation):</p> 2338 * <p><img alt="Red lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/red_shading.png" /> 2339 * <img alt="Green (even rows) lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/green_e_shading.png" /> 2340 * <img alt="Green (odd rows) lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/green_o_shading.png" /> 2341 * <img alt="Blue lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/blue_shading.png" /></p> 2342 * <p>As a visualization only, inverting the full-color map to recover an 2343 * image of a gray wall (using bicubic interpolation for visual quality) as captured by the sensor gives:</p> 2344 * <p><img alt="Image of a uniform white wall (inverse shading map)" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/inv_shading.png" /></p> 2345 * 2346 * @see CaptureRequest#COLOR_CORRECTION_MODE 2347 * @hide 2348 */ 2349 public static final Key<float[]> STATISTICS_LENS_SHADING_MAP = 2350 new Key<float[]>("android.statistics.lensShadingMap", float[].class); 2351 2352 /** 2353 * <p>The best-fit color channel gains calculated 2354 * by the camera device's statistics units for the current output frame.</p> 2355 * <p>This may be different than the gains used for this frame, 2356 * since statistics processing on data from a new frame 2357 * typically completes after the transform has already been 2358 * applied to that frame.</p> 2359 * <p>The 4 channel gains are defined in Bayer domain, 2360 * see {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} for details.</p> 2361 * <p>This value should always be calculated by the AWB block, 2362 * regardless of the android.control.* current values.</p> 2363 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2364 * 2365 * @see CaptureRequest#COLOR_CORRECTION_GAINS 2366 * @deprecated 2367 * @hide 2368 */ 2369 @Deprecated 2370 public static final Key<float[]> STATISTICS_PREDICTED_COLOR_GAINS = 2371 new Key<float[]>("android.statistics.predictedColorGains", float[].class); 2372 2373 /** 2374 * <p>The best-fit color transform matrix estimate 2375 * calculated by the camera device's statistics units for the current 2376 * output frame.</p> 2377 * <p>The camera device will provide the estimate from its 2378 * statistics unit on the white balance transforms to use 2379 * for the next frame. These are the values the camera device believes 2380 * are the best fit for the current output frame. This may 2381 * be different than the transform used for this frame, since 2382 * statistics processing on data from a new frame typically 2383 * completes after the transform has already been applied to 2384 * that frame.</p> 2385 * <p>These estimates must be provided for all frames, even if 2386 * capture settings and color transforms are set by the application.</p> 2387 * <p>This value should always be calculated by the AWB block, 2388 * regardless of the android.control.* current values.</p> 2389 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2390 * @deprecated 2391 * @hide 2392 */ 2393 @Deprecated 2394 public static final Key<Rational[]> STATISTICS_PREDICTED_COLOR_TRANSFORM = 2395 new Key<Rational[]>("android.statistics.predictedColorTransform", Rational[].class); 2396 2397 /** 2398 * <p>The camera device estimated scene illumination lighting 2399 * frequency.</p> 2400 * <p>Many light sources, such as most fluorescent lights, flicker at a rate 2401 * that depends on the local utility power standards. This flicker must be 2402 * accounted for by auto-exposure routines to avoid artifacts in captured images. 2403 * The camera device uses this entry to tell the application what the scene 2404 * illuminant frequency is.</p> 2405 * <p>When manual exposure control is enabled 2406 * (<code>{@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} == OFF</code> or <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == OFF</code>), 2407 * the {@link CaptureRequest#CONTROL_AE_ANTIBANDING_MODE android.control.aeAntibandingMode} doesn't do the antibanding, and the 2408 * application can ensure it selects exposure times that do not cause banding 2409 * issues by looking into this metadata field. See {@link CaptureRequest#CONTROL_AE_ANTIBANDING_MODE android.control.aeAntibandingMode} 2410 * for more details.</p> 2411 * <p>Report NONE if there doesn't appear to be flickering illumination.</p> 2412 * 2413 * @see CaptureRequest#CONTROL_AE_ANTIBANDING_MODE 2414 * @see CaptureRequest#CONTROL_AE_MODE 2415 * @see CaptureRequest#CONTROL_MODE 2416 * @see #STATISTICS_SCENE_FLICKER_NONE 2417 * @see #STATISTICS_SCENE_FLICKER_50HZ 2418 * @see #STATISTICS_SCENE_FLICKER_60HZ 2419 */ 2420 public static final Key<Integer> STATISTICS_SCENE_FLICKER = 2421 new Key<Integer>("android.statistics.sceneFlicker", int.class); 2422 2423 /** 2424 * <p>Operating mode for hotpixel map generation.</p> 2425 * <p>If set to ON, a hotpixel map is returned in {@link CaptureResult#STATISTICS_HOT_PIXEL_MAP android.statistics.hotPixelMap}. 2426 * If set to OFF, no hotpixel map should be returned.</p> 2427 * <p>This must be set to a valid mode from {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES android.statistics.info.availableHotPixelMapModes}.</p> 2428 * 2429 * @see CaptureResult#STATISTICS_HOT_PIXEL_MAP 2430 * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES 2431 */ 2432 public static final Key<Boolean> STATISTICS_HOT_PIXEL_MAP_MODE = 2433 new Key<Boolean>("android.statistics.hotPixelMapMode", boolean.class); 2434 2435 /** 2436 * <p>List of <code>(x, y)</code> coordinates of hot/defective pixels on the sensor.</p> 2437 * <p>A coordinate <code>(x, y)</code> must lie between <code>(0, 0)</code>, and 2438 * <code>(width - 1, height - 1)</code> (inclusive), which are the top-left and 2439 * bottom-right of the pixel array, respectively. The width and 2440 * height dimensions are given in {@link CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE android.sensor.info.pixelArraySize}. 2441 * This may include hot pixels that lie outside of the active array 2442 * bounds given by {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.</p> 2443 * 2444 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 2445 * @see CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE 2446 */ 2447 public static final Key<android.graphics.Point[]> STATISTICS_HOT_PIXEL_MAP = 2448 new Key<android.graphics.Point[]>("android.statistics.hotPixelMap", android.graphics.Point[].class); 2449 2450 /** 2451 * <p>Whether the camera device will output the lens 2452 * shading map in output result metadata.</p> 2453 * <p>When set to ON, 2454 * android.statistics.lensShadingMap must be provided in 2455 * the output result metadata.</p> 2456 * @see #STATISTICS_LENS_SHADING_MAP_MODE_OFF 2457 * @see #STATISTICS_LENS_SHADING_MAP_MODE_ON 2458 */ 2459 public static final Key<Integer> STATISTICS_LENS_SHADING_MAP_MODE = 2460 new Key<Integer>("android.statistics.lensShadingMapMode", int.class); 2461 2462 /** 2463 * <p>Tonemapping / contrast / gamma curve for the blue 2464 * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 2465 * CONTRAST_CURVE.</p> 2466 * <p>See android.tonemap.curveRed for more details.</p> 2467 * 2468 * @see CaptureRequest#TONEMAP_MODE 2469 * @hide 2470 */ 2471 public static final Key<float[]> TONEMAP_CURVE_BLUE = 2472 new Key<float[]>("android.tonemap.curveBlue", float[].class); 2473 2474 /** 2475 * <p>Tonemapping / contrast / gamma curve for the green 2476 * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 2477 * CONTRAST_CURVE.</p> 2478 * <p>See android.tonemap.curveRed for more details.</p> 2479 * 2480 * @see CaptureRequest#TONEMAP_MODE 2481 * @hide 2482 */ 2483 public static final Key<float[]> TONEMAP_CURVE_GREEN = 2484 new Key<float[]>("android.tonemap.curveGreen", float[].class); 2485 2486 /** 2487 * <p>Tonemapping / contrast / gamma curve for the red 2488 * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 2489 * CONTRAST_CURVE.</p> 2490 * <p>Each channel's curve is defined by an array of control points:</p> 2491 * <pre><code>android.tonemap.curveRed = 2492 * [ P0in, P0out, P1in, P1out, P2in, P2out, P3in, P3out, ..., PNin, PNout ] 2493 * 2 <= N <= {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</code></pre> 2494 * <p>These are sorted in order of increasing <code>Pin</code>; it is always 2495 * guaranteed that input values 0.0 and 1.0 are included in the list to 2496 * define a complete mapping. For input values between control points, 2497 * the camera device must linearly interpolate between the control 2498 * points.</p> 2499 * <p>Each curve can have an independent number of points, and the number 2500 * of points can be less than max (that is, the request doesn't have to 2501 * always provide a curve with number of points equivalent to 2502 * {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}).</p> 2503 * <p>A few examples, and their corresponding graphical mappings; these 2504 * only specify the red channel and the precision is limited to 4 2505 * digits, for conciseness.</p> 2506 * <p>Linear mapping:</p> 2507 * <pre><code>android.tonemap.curveRed = [ 0, 0, 1.0, 1.0 ] 2508 * </code></pre> 2509 * <p><img alt="Linear mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png" /></p> 2510 * <p>Invert mapping:</p> 2511 * <pre><code>android.tonemap.curveRed = [ 0, 1.0, 1.0, 0 ] 2512 * </code></pre> 2513 * <p><img alt="Inverting mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png" /></p> 2514 * <p>Gamma 1/2.2 mapping, with 16 control points:</p> 2515 * <pre><code>android.tonemap.curveRed = [ 2516 * 0.0000, 0.0000, 0.0667, 0.2920, 0.1333, 0.4002, 0.2000, 0.4812, 2517 * 0.2667, 0.5484, 0.3333, 0.6069, 0.4000, 0.6594, 0.4667, 0.7072, 2518 * 0.5333, 0.7515, 0.6000, 0.7928, 0.6667, 0.8317, 0.7333, 0.8685, 2519 * 0.8000, 0.9035, 0.8667, 0.9370, 0.9333, 0.9691, 1.0000, 1.0000 ] 2520 * </code></pre> 2521 * <p><img alt="Gamma = 1/2.2 tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png" /></p> 2522 * <p>Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:</p> 2523 * <pre><code>android.tonemap.curveRed = [ 2524 * 0.0000, 0.0000, 0.0667, 0.2864, 0.1333, 0.4007, 0.2000, 0.4845, 2525 * 0.2667, 0.5532, 0.3333, 0.6125, 0.4000, 0.6652, 0.4667, 0.7130, 2526 * 0.5333, 0.7569, 0.6000, 0.7977, 0.6667, 0.8360, 0.7333, 0.8721, 2527 * 0.8000, 0.9063, 0.8667, 0.9389, 0.9333, 0.9701, 1.0000, 1.0000 ] 2528 * </code></pre> 2529 * <p><img alt="sRGB tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p> 2530 * 2531 * @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS 2532 * @see CaptureRequest#TONEMAP_MODE 2533 * @hide 2534 */ 2535 public static final Key<float[]> TONEMAP_CURVE_RED = 2536 new Key<float[]>("android.tonemap.curveRed", float[].class); 2537 2538 /** 2539 * <p>Tonemapping / contrast / gamma curve to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} 2540 * is CONTRAST_CURVE.</p> 2541 * <p>The tonemapCurve consist of three curves for each of red, green, and blue 2542 * channels respectively. The following example uses the red channel as an 2543 * example. The same logic applies to green and blue channel. 2544 * Each channel's curve is defined by an array of control points:</p> 2545 * <pre><code>curveRed = 2546 * [ P0(in, out), P1(in, out), P2(in, out), P3(in, out), ..., PN(in, out) ] 2547 * 2 <= N <= {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</code></pre> 2548 * <p>These are sorted in order of increasing <code>Pin</code>; it is always 2549 * guaranteed that input values 0.0 and 1.0 are included in the list to 2550 * define a complete mapping. For input values between control points, 2551 * the camera device must linearly interpolate between the control 2552 * points.</p> 2553 * <p>Each curve can have an independent number of points, and the number 2554 * of points can be less than max (that is, the request doesn't have to 2555 * always provide a curve with number of points equivalent to 2556 * {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}).</p> 2557 * <p>A few examples, and their corresponding graphical mappings; these 2558 * only specify the red channel and the precision is limited to 4 2559 * digits, for conciseness.</p> 2560 * <p>Linear mapping:</p> 2561 * <pre><code>curveRed = [ (0, 0), (1.0, 1.0) ] 2562 * </code></pre> 2563 * <p><img alt="Linear mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png" /></p> 2564 * <p>Invert mapping:</p> 2565 * <pre><code>curveRed = [ (0, 1.0), (1.0, 0) ] 2566 * </code></pre> 2567 * <p><img alt="Inverting mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png" /></p> 2568 * <p>Gamma 1/2.2 mapping, with 16 control points:</p> 2569 * <pre><code>curveRed = [ 2570 * (0.0000, 0.0000), (0.0667, 0.2920), (0.1333, 0.4002), (0.2000, 0.4812), 2571 * (0.2667, 0.5484), (0.3333, 0.6069), (0.4000, 0.6594), (0.4667, 0.7072), 2572 * (0.5333, 0.7515), (0.6000, 0.7928), (0.6667, 0.8317), (0.7333, 0.8685), 2573 * (0.8000, 0.9035), (0.8667, 0.9370), (0.9333, 0.9691), (1.0000, 1.0000) ] 2574 * </code></pre> 2575 * <p><img alt="Gamma = 1/2.2 tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png" /></p> 2576 * <p>Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:</p> 2577 * <pre><code>curveRed = [ 2578 * (0.0000, 0.0000), (0.0667, 0.2864), (0.1333, 0.4007), (0.2000, 0.4845), 2579 * (0.2667, 0.5532), (0.3333, 0.6125), (0.4000, 0.6652), (0.4667, 0.7130), 2580 * (0.5333, 0.7569), (0.6000, 0.7977), (0.6667, 0.8360), (0.7333, 0.8721), 2581 * (0.8000, 0.9063), (0.8667, 0.9389), (0.9333, 0.9701), (1.0000, 1.0000) ] 2582 * </code></pre> 2583 * <p><img alt="sRGB tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p> 2584 * 2585 * @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS 2586 * @see CaptureRequest#TONEMAP_MODE 2587 */ 2588 public static final Key<android.hardware.camera2.params.TonemapCurve> TONEMAP_CURVE = 2589 new Key<android.hardware.camera2.params.TonemapCurve>("android.tonemap.curve", android.hardware.camera2.params.TonemapCurve.class); 2590 2591 /** 2592 * <p>High-level global contrast/gamma/tonemapping control.</p> 2593 * <p>When switching to an application-defined contrast curve by setting 2594 * {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} to CONTRAST_CURVE, the curve is defined 2595 * per-channel with a set of <code>(in, out)</code> points that specify the 2596 * mapping from input high-bit-depth pixel value to the output 2597 * low-bit-depth value. Since the actual pixel ranges of both input 2598 * and output may change depending on the camera pipeline, the values 2599 * are specified by normalized floating-point numbers.</p> 2600 * <p>More-complex color mapping operations such as 3D color look-up 2601 * tables, selective chroma enhancement, or other non-linear color 2602 * transforms will be disabled when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 2603 * CONTRAST_CURVE.</p> 2604 * <p>This must be set to a valid mode in 2605 * {@link CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES android.tonemap.availableToneMapModes}.</p> 2606 * <p>When using either FAST or HIGH_QUALITY, the camera device will 2607 * emit its own tonemap curve in {@link CaptureRequest#TONEMAP_CURVE android.tonemap.curve}. 2608 * These values are always available, and as close as possible to the 2609 * actually used nonlinear/nonglobal transforms.</p> 2610 * <p>If a request is sent with CONTRAST_CURVE with the camera device's 2611 * provided curve in FAST or HIGH_QUALITY, the image's tonemap will be 2612 * roughly the same.</p> 2613 * 2614 * @see CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES 2615 * @see CaptureRequest#TONEMAP_CURVE 2616 * @see CaptureRequest#TONEMAP_MODE 2617 * @see #TONEMAP_MODE_CONTRAST_CURVE 2618 * @see #TONEMAP_MODE_FAST 2619 * @see #TONEMAP_MODE_HIGH_QUALITY 2620 */ 2621 public static final Key<Integer> TONEMAP_MODE = 2622 new Key<Integer>("android.tonemap.mode", int.class); 2623 2624 /** 2625 * <p>This LED is nominally used to indicate to the user 2626 * that the camera is powered on and may be streaming images back to the 2627 * Application Processor. In certain rare circumstances, the OS may 2628 * disable this when video is processed locally and not transmitted to 2629 * any untrusted applications.</p> 2630 * <p>In particular, the LED <em>must</em> always be on when the data could be 2631 * transmitted off the device. The LED <em>should</em> always be on whenever 2632 * data is stored locally on the device.</p> 2633 * <p>The LED <em>may</em> be off if a trusted application is using the data that 2634 * doesn't violate the above rules.</p> 2635 * @hide 2636 */ 2637 public static final Key<Boolean> LED_TRANSMIT = 2638 new Key<Boolean>("android.led.transmit", boolean.class); 2639 2640 /** 2641 * <p>Whether black-level compensation is locked 2642 * to its current values, or is free to vary.</p> 2643 * <p>Whether the black level offset was locked for this frame. Should be 2644 * ON if {@link CaptureRequest#BLACK_LEVEL_LOCK android.blackLevel.lock} was ON in the capture request, unless 2645 * a change in other capture settings forced the camera device to 2646 * perform a black level reset.</p> 2647 * 2648 * @see CaptureRequest#BLACK_LEVEL_LOCK 2649 */ 2650 public static final Key<Boolean> BLACK_LEVEL_LOCK = 2651 new Key<Boolean>("android.blackLevel.lock", boolean.class); 2652 2653 /** 2654 * <p>The frame number corresponding to the last request 2655 * with which the output result (metadata + buffers) has been fully 2656 * synchronized.</p> 2657 * <p>When a request is submitted to the camera device, there is usually a 2658 * delay of several frames before the controls get applied. A camera 2659 * device may either choose to account for this delay by implementing a 2660 * pipeline and carefully submit well-timed atomic control updates, or 2661 * it may start streaming control changes that span over several frame 2662 * boundaries.</p> 2663 * <p>In the latter case, whenever a request's settings change relative to 2664 * the previous submitted request, the full set of changes may take 2665 * multiple frame durations to fully take effect. Some settings may 2666 * take effect sooner (in less frame durations) than others.</p> 2667 * <p>While a set of control changes are being propagated, this value 2668 * will be CONVERGING.</p> 2669 * <p>Once it is fully known that a set of control changes have been 2670 * finished propagating, and the resulting updated control settings 2671 * have been read back by the camera device, this value will be set 2672 * to a non-negative frame number (corresponding to the request to 2673 * which the results have synchronized to).</p> 2674 * <p>Older camera device implementations may not have a way to detect 2675 * when all camera controls have been applied, and will always set this 2676 * value to UNKNOWN.</p> 2677 * <p>FULL capability devices will always have this value set to the 2678 * frame number of the request corresponding to this result.</p> 2679 * <p><em>Further details</em>:</p> 2680 * <ul> 2681 * <li>Whenever a request differs from the last request, any future 2682 * results not yet returned may have this value set to CONVERGING (this 2683 * could include any in-progress captures not yet returned by the camera 2684 * device, for more details see pipeline considerations below).</li> 2685 * <li>Submitting a series of multiple requests that differ from the 2686 * previous request (e.g. r1, r2, r3 s.t. r1 != r2 != r3) 2687 * moves the new synchronization frame to the last non-repeating 2688 * request (using the smallest frame number from the contiguous list of 2689 * repeating requests).</li> 2690 * <li>Submitting the same request repeatedly will not change this value 2691 * to CONVERGING, if it was already a non-negative value.</li> 2692 * <li>When this value changes to non-negative, that means that all of the 2693 * metadata controls from the request have been applied, all of the 2694 * metadata controls from the camera device have been read to the 2695 * updated values (into the result), and all of the graphics buffers 2696 * corresponding to this result are also synchronized to the request.</li> 2697 * </ul> 2698 * <p><em>Pipeline considerations</em>:</p> 2699 * <p>Submitting a request with updated controls relative to the previously 2700 * submitted requests may also invalidate the synchronization state 2701 * of all the results corresponding to currently in-flight requests.</p> 2702 * <p>In other words, results for this current request and up to 2703 * {@link CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH android.request.pipelineMaxDepth} prior requests may have their 2704 * android.sync.frameNumber change to CONVERGING.</p> 2705 * 2706 * @see CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH 2707 * @see #SYNC_FRAME_NUMBER_CONVERGING 2708 * @see #SYNC_FRAME_NUMBER_UNKNOWN 2709 * @hide 2710 */ 2711 public static final Key<Long> SYNC_FRAME_NUMBER = 2712 new Key<Long>("android.sync.frameNumber", long.class); 2713 2714 /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ 2715 * End generated code 2716 *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/ 2717} 2718
