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