CaptureResult.java revision 2d5e89778e955b4ff209a93e738761356349d48c
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; 20 21/** 22 * <p>The results of a single image capture from the image sensor.</p> 23 * 24 * <p>Contains the final configuration for the capture hardware (sensor, lens, 25 * flash), the processing pipeline, the control algorithms, and the output 26 * buffers.</p> 27 * 28 * <p>CaptureResults are produced by a {@link CameraDevice} after processing a 29 * {@link CaptureRequest}. All properties listed for capture requests can also 30 * be queried on the capture result, to determine the final values used for 31 * capture. The result also includes additional metadata about the state of the 32 * camera device during the capture.</p> 33 * 34 */ 35public final class CaptureResult extends CameraMetadata { 36 37 private final CameraMetadataNative mResults; 38 private final CaptureRequest mRequest; 39 private final int mSequenceId; 40 41 /** 42 * Takes ownership of the passed-in properties object 43 * @hide 44 */ 45 public CaptureResult(CameraMetadataNative results, CaptureRequest parent, int sequenceId) { 46 if (results == null) { 47 throw new IllegalArgumentException("results was null"); 48 } 49 50 if (parent == null) { 51 throw new IllegalArgumentException("parent was null"); 52 } 53 54 mResults = results; 55 mRequest = parent; 56 mSequenceId = sequenceId; 57 } 58 59 @Override 60 public <T> T get(Key<T> key) { 61 return mResults.get(key); 62 } 63 64 /** 65 * Get the request associated with this result. 66 * 67 * <p>Whenever a request is successfully captured, with 68 * {@link CameraDevice.CaptureListener#onCaptureCompleted}, 69 * the {@code result}'s {@code getRequest()} will return that {@code request}. 70 * </p> 71 * 72 * <p>In particular, 73 * <code><pre>cameraDevice.capture(someRequest, new CaptureListener() { 74 * {@literal @}Override 75 * void onCaptureCompleted(CaptureRequest myRequest, CaptureResult myResult) { 76 * assert(myResult.getRequest.equals(myRequest) == true); 77 * } 78 * }; 79 * </code></pre> 80 * </p> 81 * 82 * @return The request associated with this result. Never {@code null}. 83 */ 84 public CaptureRequest getRequest() { 85 return mRequest; 86 } 87 88 /** 89 * Get the frame number associated with this result. 90 * 91 * <p>Whenever a request has been processed, regardless of failure or success, 92 * it gets a unique frame number assigned to its future result/failure.</p> 93 * 94 * <p>This value monotonically increments, starting with 0, 95 * for every new result or failure; and the scope is the lifetime of the 96 * {@link CameraDevice}.</p> 97 * 98 * @return int frame number 99 */ 100 public int getFrameNumber() { 101 return get(REQUEST_FRAME_COUNT); 102 } 103 104 /** 105 * The sequence ID for this failure that was returned by the 106 * {@link CameraDevice#capture} family of functions. 107 * 108 * <p>The sequence ID is a unique monotonically increasing value starting from 0, 109 * incremented every time a new group of requests is submitted to the CameraDevice.</p> 110 * 111 * @return int The ID for the sequence of requests that this capture result is a part of 112 * 113 * @see CameraDevice.CaptureListener#onCaptureSequenceCompleted 114 */ 115 public int getSequenceId() { 116 return mSequenceId; 117 } 118 119 /*@O~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ 120 * The key entries below this point are generated from metadata 121 * definitions in /system/media/camera/docs. Do not modify by hand or 122 * modify the comment blocks at the start or end. 123 *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/ 124 125 126 /** 127 * <p>A color transform matrix to use to transform 128 * from sensor RGB color space to output linear sRGB color space</p> 129 * <p>This matrix is either set by the camera device when the request 130 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not TRANSFORM_MATRIX, or 131 * directly by the application in the request when the 132 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is TRANSFORM_MATRIX.</p> 133 * <p>In the latter case, the camera device may round the matrix to account 134 * for precision issues; the final rounded matrix should be reported back 135 * in this matrix result metadata. The transform should keep the magnitude 136 * of the output color values within <code>[0, 1.0]</code> (assuming input color 137 * values is within the normalized range <code>[0, 1.0]</code>), or clipping may occur.</p> 138 * 139 * @see CaptureRequest#COLOR_CORRECTION_MODE 140 */ 141 public static final Key<Rational[]> COLOR_CORRECTION_TRANSFORM = 142 new Key<Rational[]>("android.colorCorrection.transform", Rational[].class); 143 144 /** 145 * <p>Gains applying to Bayer raw color channels for 146 * white-balance</p> 147 * <p>The 4-channel white-balance gains are defined in 148 * the order of <code>[R G_even G_odd B]</code>, where <code>G_even</code> is the gain 149 * for green pixels on even rows of the output, and <code>G_odd</code> 150 * is the gain for green pixels on the odd rows. if a HAL 151 * does not support a separate gain for even/odd green channels, 152 * it should use the <code>G_even</code> value, and write <code>G_odd</code> equal to 153 * <code>G_even</code> in the output result metadata.</p> 154 * <p>This array is either set by HAL when the request 155 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not TRANSFORM_MATRIX, or 156 * directly by the application in the request when the 157 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is TRANSFORM_MATRIX.</p> 158 * <p>The output should be the gains actually applied by the HAL to 159 * the current frame.</p> 160 * 161 * @see CaptureRequest#COLOR_CORRECTION_MODE 162 */ 163 public static final Key<float[]> COLOR_CORRECTION_GAINS = 164 new Key<float[]>("android.colorCorrection.gains", float[].class); 165 166 /** 167 * <p>The ID sent with the latest 168 * CAMERA2_TRIGGER_PRECAPTURE_METERING call</p> 169 * <p>Must be 0 if no 170 * CAMERA2_TRIGGER_PRECAPTURE_METERING trigger received yet 171 * by HAL. Always updated even if AE algorithm ignores the 172 * trigger</p> 173 * @hide 174 */ 175 public static final Key<Integer> CONTROL_AE_PRECAPTURE_ID = 176 new Key<Integer>("android.control.aePrecaptureId", int.class); 177 178 /** 179 * <p>The desired mode for the camera device's 180 * auto-exposure routine.</p> 181 * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is 182 * AUTO.</p> 183 * <p>When set to any of the ON modes, the camera device's 184 * auto-exposure routine is enabled, overriding the 185 * application's selected exposure time, sensor sensitivity, 186 * and frame duration ({@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, 187 * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and 188 * {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}). If one of the FLASH modes 189 * is selected, the camera device's flash unit controls are 190 * also overridden.</p> 191 * <p>The FLASH modes are only available if the camera device 192 * has a flash unit ({@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} is <code>true</code>).</p> 193 * <p>If flash TORCH mode is desired, this field must be set to 194 * ON or OFF, and {@link CaptureRequest#FLASH_MODE android.flash.mode} set to TORCH.</p> 195 * <p>When set to any of the ON modes, the values chosen by the 196 * camera device auto-exposure routine for the overridden 197 * fields for a given capture will be available in its 198 * CaptureResult.</p> 199 * 200 * @see CaptureRequest#CONTROL_MODE 201 * @see CameraCharacteristics#FLASH_INFO_AVAILABLE 202 * @see CaptureRequest#FLASH_MODE 203 * @see CaptureRequest#SENSOR_EXPOSURE_TIME 204 * @see CaptureRequest#SENSOR_FRAME_DURATION 205 * @see CaptureRequest#SENSOR_SENSITIVITY 206 * @see #CONTROL_AE_MODE_OFF 207 * @see #CONTROL_AE_MODE_ON 208 * @see #CONTROL_AE_MODE_ON_AUTO_FLASH 209 * @see #CONTROL_AE_MODE_ON_ALWAYS_FLASH 210 * @see #CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE 211 */ 212 public static final Key<Integer> CONTROL_AE_MODE = 213 new Key<Integer>("android.control.aeMode", int.class); 214 215 /** 216 * <p>List of areas to use for 217 * metering.</p> 218 * <p>Each area is a rectangle plus weight: xmin, ymin, 219 * xmax, ymax, weight. The rectangle is defined to be inclusive of the 220 * specified coordinates.</p> 221 * <p>The coordinate system is based on the active pixel array, 222 * with (0,0) being the top-left pixel in the active pixel array, and 223 * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 224 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 225 * bottom-right pixel in the active pixel array. The weight 226 * should be nonnegative.</p> 227 * <p>If all regions have 0 weight, then no specific metering area 228 * needs to be used by the HAL. If the metering region is 229 * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the HAL 230 * should ignore the sections outside the region and output the 231 * used sections in the frame metadata.</p> 232 * 233 * @see CaptureRequest#SCALER_CROP_REGION 234 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 235 */ 236 public static final Key<int[]> CONTROL_AE_REGIONS = 237 new Key<int[]>("android.control.aeRegions", int[].class); 238 239 /** 240 * <p>Current state of AE algorithm</p> 241 * <p>Switching between or enabling AE modes ({@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode}) always 242 * resets the AE state to INACTIVE. Similarly, switching between {@link CaptureRequest#CONTROL_MODE android.control.mode}, 243 * or {@link CaptureRequest#CONTROL_SCENE_MODE android.control.sceneMode} if <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code> resets all 244 * the algorithm states to INACTIVE.</p> 245 * <p>The camera device can do several state transitions between two results, if it is 246 * allowed by the state transition table. For example: INACTIVE may never actually be 247 * seen in a result.</p> 248 * <p>The state in the result is the state for this image (in sync with this image): if 249 * AE state becomes CONVERGED, then the image data associated with this result should 250 * be good to use.</p> 251 * <p>Below are state transition tables for different AE modes.</p> 252 * <table> 253 * <thead> 254 * <tr> 255 * <th align="center">State</th> 256 * <th align="center">Transition Cause</th> 257 * <th align="center">New State</th> 258 * <th align="center">Notes</th> 259 * </tr> 260 * </thead> 261 * <tbody> 262 * <tr> 263 * <td align="center">INACTIVE</td> 264 * <td align="center"></td> 265 * <td align="center">INACTIVE</td> 266 * <td align="center">Camera device auto exposure algorithm is disabled</td> 267 * </tr> 268 * </tbody> 269 * </table> 270 * <p>When {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is AE_MODE_ON_*:</p> 271 * <table> 272 * <thead> 273 * <tr> 274 * <th align="center">State</th> 275 * <th align="center">Transition Cause</th> 276 * <th align="center">New State</th> 277 * <th align="center">Notes</th> 278 * </tr> 279 * </thead> 280 * <tbody> 281 * <tr> 282 * <td align="center">INACTIVE</td> 283 * <td align="center">Camera device initiates AE scan</td> 284 * <td align="center">SEARCHING</td> 285 * <td align="center">Values changing</td> 286 * </tr> 287 * <tr> 288 * <td align="center">INACTIVE</td> 289 * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON</td> 290 * <td align="center">LOCKED</td> 291 * <td align="center">Values locked</td> 292 * </tr> 293 * <tr> 294 * <td align="center">SEARCHING</td> 295 * <td align="center">Camera device finishes AE scan</td> 296 * <td align="center">CONVERGED</td> 297 * <td align="center">Good values, not changing</td> 298 * </tr> 299 * <tr> 300 * <td align="center">SEARCHING</td> 301 * <td align="center">Camera device finishes AE scan</td> 302 * <td align="center">FLASH_REQUIRED</td> 303 * <td align="center">Converged but too dark w/o flash</td> 304 * </tr> 305 * <tr> 306 * <td align="center">SEARCHING</td> 307 * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON</td> 308 * <td align="center">LOCKED</td> 309 * <td align="center">Values locked</td> 310 * </tr> 311 * <tr> 312 * <td align="center">CONVERGED</td> 313 * <td align="center">Camera device initiates AE scan</td> 314 * <td align="center">SEARCHING</td> 315 * <td align="center">Values changing</td> 316 * </tr> 317 * <tr> 318 * <td align="center">CONVERGED</td> 319 * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON</td> 320 * <td align="center">LOCKED</td> 321 * <td align="center">Values locked</td> 322 * </tr> 323 * <tr> 324 * <td align="center">FLASH_REQUIRED</td> 325 * <td align="center">Camera device initiates AE scan</td> 326 * <td align="center">SEARCHING</td> 327 * <td align="center">Values changing</td> 328 * </tr> 329 * <tr> 330 * <td align="center">FLASH_REQUIRED</td> 331 * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON</td> 332 * <td align="center">LOCKED</td> 333 * <td align="center">Values locked</td> 334 * </tr> 335 * <tr> 336 * <td align="center">LOCKED</td> 337 * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFF</td> 338 * <td align="center">SEARCHING</td> 339 * <td align="center">Values not good after unlock</td> 340 * </tr> 341 * <tr> 342 * <td align="center">LOCKED</td> 343 * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFF</td> 344 * <td align="center">CONVERGED</td> 345 * <td align="center">Values good after unlock</td> 346 * </tr> 347 * <tr> 348 * <td align="center">LOCKED</td> 349 * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFF</td> 350 * <td align="center">FLASH_REQUIRED</td> 351 * <td align="center">Exposure good, but too dark</td> 352 * </tr> 353 * <tr> 354 * <td align="center">PRECAPTURE</td> 355 * <td align="center">Sequence done. {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFF</td> 356 * <td align="center">CONVERGED</td> 357 * <td align="center">Ready for high-quality capture</td> 358 * </tr> 359 * <tr> 360 * <td align="center">PRECAPTURE</td> 361 * <td align="center">Sequence done. {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON</td> 362 * <td align="center">LOCKED</td> 363 * <td align="center">Ready for high-quality capture</td> 364 * </tr> 365 * <tr> 366 * <td align="center">Any state</td> 367 * <td align="center">{@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger} is START</td> 368 * <td align="center">PRECAPTURE</td> 369 * <td align="center">Start AE precapture metering sequence</td> 370 * </tr> 371 * </tbody> 372 * </table> 373 * 374 * @see CaptureRequest#CONTROL_AE_LOCK 375 * @see CaptureRequest#CONTROL_AE_MODE 376 * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER 377 * @see CaptureRequest#CONTROL_MODE 378 * @see CaptureRequest#CONTROL_SCENE_MODE 379 * @see #CONTROL_AE_STATE_INACTIVE 380 * @see #CONTROL_AE_STATE_SEARCHING 381 * @see #CONTROL_AE_STATE_CONVERGED 382 * @see #CONTROL_AE_STATE_LOCKED 383 * @see #CONTROL_AE_STATE_FLASH_REQUIRED 384 * @see #CONTROL_AE_STATE_PRECAPTURE 385 */ 386 public static final Key<Integer> CONTROL_AE_STATE = 387 new Key<Integer>("android.control.aeState", int.class); 388 389 /** 390 * <p>Whether AF is currently enabled, and what 391 * mode it is set to</p> 392 * <p>Only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} = AUTO.</p> 393 * <p>If the lens is controlled by the camera device auto-focus algorithm, 394 * the camera device will report the current AF status in android.control.afState 395 * in result metadata.</p> 396 * 397 * @see CaptureRequest#CONTROL_MODE 398 * @see #CONTROL_AF_MODE_OFF 399 * @see #CONTROL_AF_MODE_AUTO 400 * @see #CONTROL_AF_MODE_MACRO 401 * @see #CONTROL_AF_MODE_CONTINUOUS_VIDEO 402 * @see #CONTROL_AF_MODE_CONTINUOUS_PICTURE 403 * @see #CONTROL_AF_MODE_EDOF 404 */ 405 public static final Key<Integer> CONTROL_AF_MODE = 406 new Key<Integer>("android.control.afMode", int.class); 407 408 /** 409 * <p>List of areas to use for focus 410 * estimation.</p> 411 * <p>Each area is a rectangle plus weight: xmin, ymin, 412 * xmax, ymax, weight. The rectangle is defined to be inclusive of the 413 * specified coordinates.</p> 414 * <p>The coordinate system is based on the active pixel array, 415 * with (0,0) being the top-left pixel in the active pixel array, and 416 * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 417 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 418 * bottom-right pixel in the active pixel array. The weight 419 * should be nonnegative.</p> 420 * <p>If all regions have 0 weight, then no specific focus area 421 * needs to be used by the HAL. If the focusing region is 422 * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the HAL 423 * should ignore the sections outside the region and output the 424 * used sections in the frame metadata.</p> 425 * 426 * @see CaptureRequest#SCALER_CROP_REGION 427 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 428 */ 429 public static final Key<int[]> CONTROL_AF_REGIONS = 430 new Key<int[]>("android.control.afRegions", int[].class); 431 432 /** 433 * <p>Current state of AF algorithm</p> 434 * <p>Switching between or enabling AF modes ({@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}) always 435 * resets the AF state to INACTIVE. Similarly, switching between {@link CaptureRequest#CONTROL_MODE android.control.mode}, 436 * or {@link CaptureRequest#CONTROL_SCENE_MODE android.control.sceneMode} if <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code> resets all 437 * the algorithm states to INACTIVE.</p> 438 * <p>The camera device can do several state transitions between two results, if it is 439 * allowed by the state transition table. For example: INACTIVE may never actually be 440 * seen in a result.</p> 441 * <p>The state in the result is the state for this image (in sync with this image): if 442 * AF state becomes FOCUSED, then the image data associated with this result should 443 * be sharp.</p> 444 * <p>Below are state transition tables for different AF modes.</p> 445 * <p>When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_OFF or AF_MODE_EDOF:</p> 446 * <table> 447 * <thead> 448 * <tr> 449 * <th align="center">State</th> 450 * <th align="center">Transition Cause</th> 451 * <th align="center">New State</th> 452 * <th align="center">Notes</th> 453 * </tr> 454 * </thead> 455 * <tbody> 456 * <tr> 457 * <td align="center">INACTIVE</td> 458 * <td align="center"></td> 459 * <td align="center">INACTIVE</td> 460 * <td align="center">Never changes</td> 461 * </tr> 462 * </tbody> 463 * </table> 464 * <p>When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_AUTO or AF_MODE_MACRO:</p> 465 * <table> 466 * <thead> 467 * <tr> 468 * <th align="center">State</th> 469 * <th align="center">Transition Cause</th> 470 * <th align="center">New State</th> 471 * <th align="center">Notes</th> 472 * </tr> 473 * </thead> 474 * <tbody> 475 * <tr> 476 * <td align="center">INACTIVE</td> 477 * <td align="center">AF_TRIGGER</td> 478 * <td align="center">ACTIVE_SCAN</td> 479 * <td align="center">Start AF sweep, Lens now moving</td> 480 * </tr> 481 * <tr> 482 * <td align="center">ACTIVE_SCAN</td> 483 * <td align="center">AF sweep done</td> 484 * <td align="center">FOCUSED_LOCKED</td> 485 * <td align="center">Focused, Lens now locked</td> 486 * </tr> 487 * <tr> 488 * <td align="center">ACTIVE_SCAN</td> 489 * <td align="center">AF sweep done</td> 490 * <td align="center">NOT_FOCUSED_LOCKED</td> 491 * <td align="center">Not focused, Lens now locked</td> 492 * </tr> 493 * <tr> 494 * <td align="center">ACTIVE_SCAN</td> 495 * <td align="center">AF_CANCEL</td> 496 * <td align="center">INACTIVE</td> 497 * <td align="center">Cancel/reset AF, Lens now locked</td> 498 * </tr> 499 * <tr> 500 * <td align="center">FOCUSED_LOCKED</td> 501 * <td align="center">AF_CANCEL</td> 502 * <td align="center">INACTIVE</td> 503 * <td align="center">Cancel/reset AF</td> 504 * </tr> 505 * <tr> 506 * <td align="center">FOCUSED_LOCKED</td> 507 * <td align="center">AF_TRIGGER</td> 508 * <td align="center">ACTIVE_SCAN</td> 509 * <td align="center">Start new sweep, Lens now moving</td> 510 * </tr> 511 * <tr> 512 * <td align="center">NOT_FOCUSED_LOCKED</td> 513 * <td align="center">AF_CANCEL</td> 514 * <td align="center">INACTIVE</td> 515 * <td align="center">Cancel/reset AF</td> 516 * </tr> 517 * <tr> 518 * <td align="center">NOT_FOCUSED_LOCKED</td> 519 * <td align="center">AF_TRIGGER</td> 520 * <td align="center">ACTIVE_SCAN</td> 521 * <td align="center">Start new sweep, Lens now moving</td> 522 * </tr> 523 * <tr> 524 * <td align="center">Any state</td> 525 * <td align="center">Mode change</td> 526 * <td align="center">INACTIVE</td> 527 * <td align="center"></td> 528 * </tr> 529 * </tbody> 530 * </table> 531 * <p>When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_CONTINUOUS_VIDEO:</p> 532 * <table> 533 * <thead> 534 * <tr> 535 * <th align="center">State</th> 536 * <th align="center">Transition Cause</th> 537 * <th align="center">New State</th> 538 * <th align="center">Notes</th> 539 * </tr> 540 * </thead> 541 * <tbody> 542 * <tr> 543 * <td align="center">INACTIVE</td> 544 * <td align="center">Camera device initiates new scan</td> 545 * <td align="center">PASSIVE_SCAN</td> 546 * <td align="center">Start AF scan, Lens now moving</td> 547 * </tr> 548 * <tr> 549 * <td align="center">INACTIVE</td> 550 * <td align="center">AF_TRIGGER</td> 551 * <td align="center">NOT_FOCUSED_LOCKED</td> 552 * <td align="center">AF state query, Lens now locked</td> 553 * </tr> 554 * <tr> 555 * <td align="center">PASSIVE_SCAN</td> 556 * <td align="center">Camera device completes current scan</td> 557 * <td align="center">PASSIVE_FOCUSED</td> 558 * <td align="center">End AF scan, Lens now locked</td> 559 * </tr> 560 * <tr> 561 * <td align="center">PASSIVE_SCAN</td> 562 * <td align="center">Camera device fails current scan</td> 563 * <td align="center">PASSIVE_UNFOCUSED</td> 564 * <td align="center">End AF scan, Lens now locked</td> 565 * </tr> 566 * <tr> 567 * <td align="center">PASSIVE_SCAN</td> 568 * <td align="center">AF_TRIGGER</td> 569 * <td align="center">FOCUSED_LOCKED</td> 570 * <td align="center">Immediate trans. If focus is good, Lens now locked</td> 571 * </tr> 572 * <tr> 573 * <td align="center">PASSIVE_SCAN</td> 574 * <td align="center">AF_TRIGGER</td> 575 * <td align="center">NOT_FOCUSED_LOCKED</td> 576 * <td align="center">Immediate trans. if focus is bad, Lens now locked</td> 577 * </tr> 578 * <tr> 579 * <td align="center">PASSIVE_SCAN</td> 580 * <td align="center">AF_CANCEL</td> 581 * <td align="center">INACTIVE</td> 582 * <td align="center">Reset lens position, Lens now locked</td> 583 * </tr> 584 * <tr> 585 * <td align="center">PASSIVE_FOCUSED</td> 586 * <td align="center">Camera device initiates new scan</td> 587 * <td align="center">PASSIVE_SCAN</td> 588 * <td align="center">Start AF scan, Lens now moving</td> 589 * </tr> 590 * <tr> 591 * <td align="center">PASSIVE_UNFOCUSED</td> 592 * <td align="center">Camera device initiates new scan</td> 593 * <td align="center">PASSIVE_SCAN</td> 594 * <td align="center">Start AF scan, Lens now moving</td> 595 * </tr> 596 * <tr> 597 * <td align="center">PASSIVE_FOCUSED</td> 598 * <td align="center">AF_TRIGGER</td> 599 * <td align="center">FOCUSED_LOCKED</td> 600 * <td align="center">Immediate trans. Lens now locked</td> 601 * </tr> 602 * <tr> 603 * <td align="center">PASSIVE_UNFOCUSED</td> 604 * <td align="center">AF_TRIGGER</td> 605 * <td align="center">NOT_FOCUSED_LOCKED</td> 606 * <td align="center">Immediate trans. Lens now locked</td> 607 * </tr> 608 * <tr> 609 * <td align="center">FOCUSED_LOCKED</td> 610 * <td align="center">AF_TRIGGER</td> 611 * <td align="center">FOCUSED_LOCKED</td> 612 * <td align="center">No effect</td> 613 * </tr> 614 * <tr> 615 * <td align="center">FOCUSED_LOCKED</td> 616 * <td align="center">AF_CANCEL</td> 617 * <td align="center">INACTIVE</td> 618 * <td align="center">Restart AF scan</td> 619 * </tr> 620 * <tr> 621 * <td align="center">NOT_FOCUSED_LOCKED</td> 622 * <td align="center">AF_TRIGGER</td> 623 * <td align="center">NOT_FOCUSED_LOCKED</td> 624 * <td align="center">No effect</td> 625 * </tr> 626 * <tr> 627 * <td align="center">NOT_FOCUSED_LOCKED</td> 628 * <td align="center">AF_CANCEL</td> 629 * <td align="center">INACTIVE</td> 630 * <td align="center">Restart AF scan</td> 631 * </tr> 632 * </tbody> 633 * </table> 634 * <p>When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_CONTINUOUS_PICTURE:</p> 635 * <table> 636 * <thead> 637 * <tr> 638 * <th align="center">State</th> 639 * <th align="center">Transition Cause</th> 640 * <th align="center">New State</th> 641 * <th align="center">Notes</th> 642 * </tr> 643 * </thead> 644 * <tbody> 645 * <tr> 646 * <td align="center">INACTIVE</td> 647 * <td align="center">Camera device initiates new scan</td> 648 * <td align="center">PASSIVE_SCAN</td> 649 * <td align="center">Start AF scan, Lens now moving</td> 650 * </tr> 651 * <tr> 652 * <td align="center">INACTIVE</td> 653 * <td align="center">AF_TRIGGER</td> 654 * <td align="center">NOT_FOCUSED_LOCKED</td> 655 * <td align="center">AF state query, Lens now locked</td> 656 * </tr> 657 * <tr> 658 * <td align="center">PASSIVE_SCAN</td> 659 * <td align="center">Camera device completes current scan</td> 660 * <td align="center">PASSIVE_FOCUSED</td> 661 * <td align="center">End AF scan, Lens now locked</td> 662 * </tr> 663 * <tr> 664 * <td align="center">PASSIVE_SCAN</td> 665 * <td align="center">Camera device fails current scan</td> 666 * <td align="center">PASSIVE_UNFOCUSED</td> 667 * <td align="center">End AF scan, Lens now locked</td> 668 * </tr> 669 * <tr> 670 * <td align="center">PASSIVE_SCAN</td> 671 * <td align="center">AF_TRIGGER</td> 672 * <td align="center">FOCUSED_LOCKED</td> 673 * <td align="center">Eventual trans. once focus good, Lens now locked</td> 674 * </tr> 675 * <tr> 676 * <td align="center">PASSIVE_SCAN</td> 677 * <td align="center">AF_TRIGGER</td> 678 * <td align="center">NOT_FOCUSED_LOCKED</td> 679 * <td align="center">Eventual trans. if cannot focus, Lens now locked</td> 680 * </tr> 681 * <tr> 682 * <td align="center">PASSIVE_SCAN</td> 683 * <td align="center">AF_CANCEL</td> 684 * <td align="center">INACTIVE</td> 685 * <td align="center">Reset lens position, Lens now locked</td> 686 * </tr> 687 * <tr> 688 * <td align="center">PASSIVE_FOCUSED</td> 689 * <td align="center">Camera device initiates new scan</td> 690 * <td align="center">PASSIVE_SCAN</td> 691 * <td align="center">Start AF scan, Lens now moving</td> 692 * </tr> 693 * <tr> 694 * <td align="center">PASSIVE_UNFOCUSED</td> 695 * <td align="center">Camera device initiates new scan</td> 696 * <td align="center">PASSIVE_SCAN</td> 697 * <td align="center">Start AF scan, Lens now moving</td> 698 * </tr> 699 * <tr> 700 * <td align="center">PASSIVE_FOCUSED</td> 701 * <td align="center">AF_TRIGGER</td> 702 * <td align="center">FOCUSED_LOCKED</td> 703 * <td align="center">Immediate trans. Lens now locked</td> 704 * </tr> 705 * <tr> 706 * <td align="center">PASSIVE_UNFOCUSED</td> 707 * <td align="center">AF_TRIGGER</td> 708 * <td align="center">NOT_FOCUSED_LOCKED</td> 709 * <td align="center">Immediate trans. Lens now locked</td> 710 * </tr> 711 * <tr> 712 * <td align="center">FOCUSED_LOCKED</td> 713 * <td align="center">AF_TRIGGER</td> 714 * <td align="center">FOCUSED_LOCKED</td> 715 * <td align="center">No effect</td> 716 * </tr> 717 * <tr> 718 * <td align="center">FOCUSED_LOCKED</td> 719 * <td align="center">AF_CANCEL</td> 720 * <td align="center">INACTIVE</td> 721 * <td align="center">Restart AF scan</td> 722 * </tr> 723 * <tr> 724 * <td align="center">NOT_FOCUSED_LOCKED</td> 725 * <td align="center">AF_TRIGGER</td> 726 * <td align="center">NOT_FOCUSED_LOCKED</td> 727 * <td align="center">No effect</td> 728 * </tr> 729 * <tr> 730 * <td align="center">NOT_FOCUSED_LOCKED</td> 731 * <td align="center">AF_CANCEL</td> 732 * <td align="center">INACTIVE</td> 733 * <td align="center">Restart AF scan</td> 734 * </tr> 735 * </tbody> 736 * </table> 737 * 738 * @see CaptureRequest#CONTROL_AF_MODE 739 * @see CaptureRequest#CONTROL_MODE 740 * @see CaptureRequest#CONTROL_SCENE_MODE 741 * @see #CONTROL_AF_STATE_INACTIVE 742 * @see #CONTROL_AF_STATE_PASSIVE_SCAN 743 * @see #CONTROL_AF_STATE_PASSIVE_FOCUSED 744 * @see #CONTROL_AF_STATE_ACTIVE_SCAN 745 * @see #CONTROL_AF_STATE_FOCUSED_LOCKED 746 * @see #CONTROL_AF_STATE_NOT_FOCUSED_LOCKED 747 * @see #CONTROL_AF_STATE_PASSIVE_UNFOCUSED 748 */ 749 public static final Key<Integer> CONTROL_AF_STATE = 750 new Key<Integer>("android.control.afState", int.class); 751 752 /** 753 * <p>The ID sent with the latest 754 * CAMERA2_TRIGGER_AUTOFOCUS call</p> 755 * <p>Must be 0 if no CAMERA2_TRIGGER_AUTOFOCUS trigger 756 * received yet by HAL. Always updated even if AF algorithm 757 * ignores the trigger</p> 758 * @hide 759 */ 760 public static final Key<Integer> CONTROL_AF_TRIGGER_ID = 761 new Key<Integer>("android.control.afTriggerId", int.class); 762 763 /** 764 * <p>Whether AWB is currently setting the color 765 * transform fields, and what its illumination target 766 * is</p> 767 * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is AUTO.</p> 768 * <p>When set to the ON mode, the camera device's auto white balance 769 * routine is enabled, overriding the application's selected 770 * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and 771 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.</p> 772 * <p>When set to the OFF mode, the camera device's auto white balance 773 * routine is disabled. The applicantion manually controls the white 774 * balance by {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, android.colorCorrection.gains 775 * and {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.</p> 776 * <p>When set to any other modes, the camera device's auto white balance 777 * routine is disabled. The camera device uses each particular illumination 778 * target for white balance adjustment.</p> 779 * 780 * @see CaptureRequest#COLOR_CORRECTION_GAINS 781 * @see CaptureRequest#COLOR_CORRECTION_MODE 782 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM 783 * @see CaptureRequest#CONTROL_MODE 784 * @see #CONTROL_AWB_MODE_OFF 785 * @see #CONTROL_AWB_MODE_AUTO 786 * @see #CONTROL_AWB_MODE_INCANDESCENT 787 * @see #CONTROL_AWB_MODE_FLUORESCENT 788 * @see #CONTROL_AWB_MODE_WARM_FLUORESCENT 789 * @see #CONTROL_AWB_MODE_DAYLIGHT 790 * @see #CONTROL_AWB_MODE_CLOUDY_DAYLIGHT 791 * @see #CONTROL_AWB_MODE_TWILIGHT 792 * @see #CONTROL_AWB_MODE_SHADE 793 */ 794 public static final Key<Integer> CONTROL_AWB_MODE = 795 new Key<Integer>("android.control.awbMode", int.class); 796 797 /** 798 * <p>List of areas to use for illuminant 799 * estimation.</p> 800 * <p>Only used in AUTO mode.</p> 801 * <p>Each area is a rectangle plus weight: xmin, ymin, 802 * xmax, ymax, weight. The rectangle is defined to be inclusive of the 803 * specified coordinates.</p> 804 * <p>The coordinate system is based on the active pixel array, 805 * with (0,0) being the top-left pixel in the active pixel array, and 806 * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 807 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 808 * bottom-right pixel in the active pixel array. The weight 809 * should be nonnegative.</p> 810 * <p>If all regions have 0 weight, then no specific metering area 811 * needs to be used by the HAL. If the metering region is 812 * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the HAL 813 * should ignore the sections outside the region and output the 814 * used sections in the frame metadata.</p> 815 * 816 * @see CaptureRequest#SCALER_CROP_REGION 817 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 818 */ 819 public static final Key<int[]> CONTROL_AWB_REGIONS = 820 new Key<int[]>("android.control.awbRegions", int[].class); 821 822 /** 823 * <p>Current state of AWB algorithm</p> 824 * <p>Switching between or enabling AWB modes ({@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}) always 825 * resets the AWB state to INACTIVE. Similarly, switching between {@link CaptureRequest#CONTROL_MODE android.control.mode}, 826 * or {@link CaptureRequest#CONTROL_SCENE_MODE android.control.sceneMode} if <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code> resets all 827 * the algorithm states to INACTIVE.</p> 828 * <p>The camera device can do several state transitions between two results, if it is 829 * allowed by the state transition table. So INACTIVE may never actually be seen in 830 * a result.</p> 831 * <p>The state in the result is the state for this image (in sync with this image): if 832 * AWB state becomes CONVERGED, then the image data associated with this result should 833 * be good to use.</p> 834 * <p>Below are state transition tables for different AWB modes.</p> 835 * <p>When <code>{@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} != AWB_MODE_AUTO</code>:</p> 836 * <table> 837 * <thead> 838 * <tr> 839 * <th align="center">State</th> 840 * <th align="center">Transition Cause</th> 841 * <th align="center">New State</th> 842 * <th align="center">Notes</th> 843 * </tr> 844 * </thead> 845 * <tbody> 846 * <tr> 847 * <td align="center">INACTIVE</td> 848 * <td align="center"></td> 849 * <td align="center">INACTIVE</td> 850 * <td align="center">Camera device auto white balance algorithm is disabled</td> 851 * </tr> 852 * </tbody> 853 * </table> 854 * <p>When {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} is AWB_MODE_AUTO:</p> 855 * <table> 856 * <thead> 857 * <tr> 858 * <th align="center">State</th> 859 * <th align="center">Transition Cause</th> 860 * <th align="center">New State</th> 861 * <th align="center">Notes</th> 862 * </tr> 863 * </thead> 864 * <tbody> 865 * <tr> 866 * <td align="center">INACTIVE</td> 867 * <td align="center">Camera device initiates AWB scan</td> 868 * <td align="center">SEARCHING</td> 869 * <td align="center">Values changing</td> 870 * </tr> 871 * <tr> 872 * <td align="center">INACTIVE</td> 873 * <td align="center">{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is ON</td> 874 * <td align="center">LOCKED</td> 875 * <td align="center">Values locked</td> 876 * </tr> 877 * <tr> 878 * <td align="center">SEARCHING</td> 879 * <td align="center">Camera device finishes AWB scan</td> 880 * <td align="center">CONVERGED</td> 881 * <td align="center">Good values, not changing</td> 882 * </tr> 883 * <tr> 884 * <td align="center">SEARCHING</td> 885 * <td align="center">{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is ON</td> 886 * <td align="center">LOCKED</td> 887 * <td align="center">Values locked</td> 888 * </tr> 889 * <tr> 890 * <td align="center">CONVERGED</td> 891 * <td align="center">Camera device initiates AWB scan</td> 892 * <td align="center">SEARCHING</td> 893 * <td align="center">Values changing</td> 894 * </tr> 895 * <tr> 896 * <td align="center">CONVERGED</td> 897 * <td align="center">{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is ON</td> 898 * <td align="center">LOCKED</td> 899 * <td align="center">Values locked</td> 900 * </tr> 901 * <tr> 902 * <td align="center">LOCKED</td> 903 * <td align="center">{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is OFF</td> 904 * <td align="center">SEARCHING</td> 905 * <td align="center">Values not good after unlock</td> 906 * </tr> 907 * <tr> 908 * <td align="center">LOCKED</td> 909 * <td align="center">{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is OFF</td> 910 * <td align="center">CONVERGED</td> 911 * <td align="center">Values good after unlock</td> 912 * </tr> 913 * </tbody> 914 * </table> 915 * 916 * @see CaptureRequest#CONTROL_AWB_LOCK 917 * @see CaptureRequest#CONTROL_AWB_MODE 918 * @see CaptureRequest#CONTROL_MODE 919 * @see CaptureRequest#CONTROL_SCENE_MODE 920 * @see #CONTROL_AWB_STATE_INACTIVE 921 * @see #CONTROL_AWB_STATE_SEARCHING 922 * @see #CONTROL_AWB_STATE_CONVERGED 923 * @see #CONTROL_AWB_STATE_LOCKED 924 */ 925 public static final Key<Integer> CONTROL_AWB_STATE = 926 new Key<Integer>("android.control.awbState", int.class); 927 928 /** 929 * <p>Overall mode of 3A control 930 * routines</p> 931 * <p>High-level 3A control. When set to OFF, all 3A control 932 * by the camera device is disabled. The application must set the fields for 933 * capture parameters itself.</p> 934 * <p>When set to AUTO, the individual algorithm controls in 935 * android.control.* are in effect, such as {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}.</p> 936 * <p>When set to USE_SCENE_MODE, the individual controls in 937 * android.control.* are mostly disabled, and the camera device implements 938 * one of the scene mode settings (such as ACTION, SUNSET, or PARTY) 939 * as it wishes. The camera device scene mode 3A settings are provided by 940 * android.control.sceneModeOverrides.</p> 941 * <p>When set to OFF_KEEP_STATE, it is similar to OFF mode, the only difference 942 * is that this frame will not be used by camera device background 3A statistics 943 * update, as if this frame is never captured. This mode can be used in the scenario 944 * where the application doesn't want a 3A manual control capture to affect 945 * the subsequent auto 3A capture results.</p> 946 * 947 * @see CaptureRequest#CONTROL_AF_MODE 948 * @see #CONTROL_MODE_OFF 949 * @see #CONTROL_MODE_AUTO 950 * @see #CONTROL_MODE_USE_SCENE_MODE 951 * @see #CONTROL_MODE_OFF_KEEP_STATE 952 */ 953 public static final Key<Integer> CONTROL_MODE = 954 new Key<Integer>("android.control.mode", int.class); 955 956 /** 957 * <p>Operation mode for edge 958 * enhancement</p> 959 * <p>Edge/sharpness/detail enhancement. OFF means no 960 * enhancement will be applied by the HAL.</p> 961 * <p>FAST/HIGH_QUALITY both mean camera device determined enhancement 962 * will be applied. HIGH_QUALITY mode indicates that the 963 * camera device will use the highest-quality enhancement algorithms, 964 * even if it slows down capture rate. FAST means the camera device will 965 * not slow down capture rate when applying edge enhancement.</p> 966 * @see #EDGE_MODE_OFF 967 * @see #EDGE_MODE_FAST 968 * @see #EDGE_MODE_HIGH_QUALITY 969 */ 970 public static final Key<Integer> EDGE_MODE = 971 new Key<Integer>("android.edge.mode", int.class); 972 973 /** 974 * <p>The desired mode for for the camera device's flash control.</p> 975 * <p>This control is only effective when flash unit is available 976 * (<code>{@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} == true</code>).</p> 977 * <p>When this control is used, the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} must be set to ON or OFF. 978 * Otherwise, the camera device auto-exposure related flash control (ON_AUTO_FLASH, 979 * ON_ALWAYS_FLASH, or ON_AUTO_FLASH_REDEYE) will override this control.</p> 980 * <p>When set to OFF, the camera device will not fire flash for this capture.</p> 981 * <p>When set to SINGLE, the camera device will fire flash regardless of the camera 982 * device's auto-exposure routine's result. When used in still capture case, this 983 * control should be used along with AE precapture metering sequence 984 * ({@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}), otherwise, the image may be incorrectly exposed.</p> 985 * <p>When set to TORCH, the flash will be on continuously. This mode can be used 986 * for use cases such as preview, auto-focus assist, still capture, or video recording.</p> 987 * <p>The flash status will be reported by {@link CaptureResult#FLASH_STATE android.flash.state} in the capture result metadata.</p> 988 * 989 * @see CaptureRequest#CONTROL_AE_MODE 990 * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER 991 * @see CameraCharacteristics#FLASH_INFO_AVAILABLE 992 * @see CaptureResult#FLASH_STATE 993 * @see #FLASH_MODE_OFF 994 * @see #FLASH_MODE_SINGLE 995 * @see #FLASH_MODE_TORCH 996 */ 997 public static final Key<Integer> FLASH_MODE = 998 new Key<Integer>("android.flash.mode", int.class); 999 1000 /** 1001 * <p>Current state of the flash 1002 * unit.</p> 1003 * <p>When the camera device doesn't have flash unit 1004 * (i.e. <code>{@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} == false</code>), this state will always be UNAVAILABLE. 1005 * Other states indicate the current flash status.</p> 1006 * 1007 * @see CameraCharacteristics#FLASH_INFO_AVAILABLE 1008 * @see #FLASH_STATE_UNAVAILABLE 1009 * @see #FLASH_STATE_CHARGING 1010 * @see #FLASH_STATE_READY 1011 * @see #FLASH_STATE_FIRED 1012 */ 1013 public static final Key<Integer> FLASH_STATE = 1014 new Key<Integer>("android.flash.state", int.class); 1015 1016 /** 1017 * <p>GPS coordinates to include in output JPEG 1018 * EXIF</p> 1019 */ 1020 public static final Key<double[]> JPEG_GPS_COORDINATES = 1021 new Key<double[]>("android.jpeg.gpsCoordinates", double[].class); 1022 1023 /** 1024 * <p>32 characters describing GPS algorithm to 1025 * include in EXIF</p> 1026 */ 1027 public static final Key<String> JPEG_GPS_PROCESSING_METHOD = 1028 new Key<String>("android.jpeg.gpsProcessingMethod", String.class); 1029 1030 /** 1031 * <p>Time GPS fix was made to include in 1032 * EXIF</p> 1033 */ 1034 public static final Key<Long> JPEG_GPS_TIMESTAMP = 1035 new Key<Long>("android.jpeg.gpsTimestamp", long.class); 1036 1037 /** 1038 * <p>Orientation of JPEG image to 1039 * write</p> 1040 */ 1041 public static final Key<Integer> JPEG_ORIENTATION = 1042 new Key<Integer>("android.jpeg.orientation", int.class); 1043 1044 /** 1045 * <p>Compression quality of the final JPEG 1046 * image</p> 1047 * <p>85-95 is typical usage range</p> 1048 */ 1049 public static final Key<Byte> JPEG_QUALITY = 1050 new Key<Byte>("android.jpeg.quality", byte.class); 1051 1052 /** 1053 * <p>Compression quality of JPEG 1054 * thumbnail</p> 1055 */ 1056 public static final Key<Byte> JPEG_THUMBNAIL_QUALITY = 1057 new Key<Byte>("android.jpeg.thumbnailQuality", byte.class); 1058 1059 /** 1060 * <p>Resolution of embedded JPEG thumbnail</p> 1061 * <p>When set to (0, 0) value, the JPEG EXIF will not contain thumbnail, 1062 * but the captured JPEG will still be a valid image.</p> 1063 * <p>When a jpeg image capture is issued, the thumbnail size selected should have 1064 * the same aspect ratio as the jpeg image.</p> 1065 */ 1066 public static final Key<android.hardware.camera2.Size> JPEG_THUMBNAIL_SIZE = 1067 new Key<android.hardware.camera2.Size>("android.jpeg.thumbnailSize", android.hardware.camera2.Size.class); 1068 1069 /** 1070 * <p>The ratio of lens focal length to the effective 1071 * aperture diameter.</p> 1072 * <p>This will only be supported on the camera devices that 1073 * have variable aperture lens. The aperture value can only be 1074 * one of the values listed in {@link CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES android.lens.info.availableApertures}.</p> 1075 * <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is OFF, 1076 * this can be set along with {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, 1077 * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and android.sensor.frameDuration 1078 * to achieve manual exposure control.</p> 1079 * <p>The requested aperture value may take several frames to reach the 1080 * requested value; the camera device will report the current (intermediate) 1081 * aperture size in capture result metadata while the aperture is changing. 1082 * While the aperture is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> 1083 * <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is one of 1084 * the ON modes, this will be overridden by the camera device 1085 * auto-exposure algorithm, the overridden values are then provided 1086 * back to the user in the corresponding result.</p> 1087 * 1088 * @see CaptureRequest#CONTROL_AE_MODE 1089 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES 1090 * @see CaptureResult#LENS_STATE 1091 * @see CaptureRequest#SENSOR_EXPOSURE_TIME 1092 * @see CaptureRequest#SENSOR_SENSITIVITY 1093 */ 1094 public static final Key<Float> LENS_APERTURE = 1095 new Key<Float>("android.lens.aperture", float.class); 1096 1097 /** 1098 * <p>State of lens neutral density filter(s).</p> 1099 * <p>This will not be supported on most camera devices. On devices 1100 * where this is supported, this may only be set to one of the 1101 * values included in {@link CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES android.lens.info.availableFilterDensities}.</p> 1102 * <p>Lens filters are typically used to lower the amount of light the 1103 * sensor is exposed to (measured in steps of EV). As used here, an EV 1104 * step is the standard logarithmic representation, which are 1105 * non-negative, and inversely proportional to the amount of light 1106 * hitting the sensor. For example, setting this to 0 would result 1107 * in no reduction of the incoming light, and setting this to 2 would 1108 * mean that the filter is set to reduce incoming light by two stops 1109 * (allowing 1/4 of the prior amount of light to the sensor).</p> 1110 * <p>It may take several frames before the lens filter density changes 1111 * to the requested value. While the filter density is still changing, 1112 * {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> 1113 * 1114 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES 1115 * @see CaptureResult#LENS_STATE 1116 */ 1117 public static final Key<Float> LENS_FILTER_DENSITY = 1118 new Key<Float>("android.lens.filterDensity", float.class); 1119 1120 /** 1121 * <p>The current lens focal length; used for optical zoom.</p> 1122 * <p>This setting controls the physical focal length of the camera 1123 * device's lens. Changing the focal length changes the field of 1124 * view of the camera device, and is usually used for optical zoom.</p> 1125 * <p>Like {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance} and {@link CaptureRequest#LENS_APERTURE android.lens.aperture}, this 1126 * setting won't be applied instantaneously, and it may take several 1127 * frames before the lens can change to the requested focal length. 1128 * While the focal length is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will 1129 * be set to MOVING.</p> 1130 * <p>This is expected not to be supported on most devices.</p> 1131 * 1132 * @see CaptureRequest#LENS_APERTURE 1133 * @see CaptureRequest#LENS_FOCUS_DISTANCE 1134 * @see CaptureResult#LENS_STATE 1135 */ 1136 public static final Key<Float> LENS_FOCAL_LENGTH = 1137 new Key<Float>("android.lens.focalLength", float.class); 1138 1139 /** 1140 * <p>Distance to plane of sharpest focus, 1141 * measured from frontmost surface of the lens</p> 1142 * <p>Should be zero for fixed-focus cameras</p> 1143 */ 1144 public static final Key<Float> LENS_FOCUS_DISTANCE = 1145 new Key<Float>("android.lens.focusDistance", float.class); 1146 1147 /** 1148 * <p>The range of scene distances that are in 1149 * sharp focus (depth of field)</p> 1150 * <p>If variable focus not supported, can still report 1151 * fixed depth of field range</p> 1152 */ 1153 public static final Key<float[]> LENS_FOCUS_RANGE = 1154 new Key<float[]>("android.lens.focusRange", float[].class); 1155 1156 /** 1157 * <p>Sets whether the camera device uses optical image stabilization (OIS) 1158 * when capturing images.</p> 1159 * <p>OIS is used to compensate for motion blur due to small movements of 1160 * the camera during capture. Unlike digital image stabilization, OIS makes 1161 * use of mechanical elements to stabilize the camera sensor, and thus 1162 * allows for longer exposure times before camera shake becomes 1163 * apparent.</p> 1164 * <p>This is not expected to be supported on most devices.</p> 1165 * @see #LENS_OPTICAL_STABILIZATION_MODE_OFF 1166 * @see #LENS_OPTICAL_STABILIZATION_MODE_ON 1167 */ 1168 public static final Key<Integer> LENS_OPTICAL_STABILIZATION_MODE = 1169 new Key<Integer>("android.lens.opticalStabilizationMode", int.class); 1170 1171 /** 1172 * <p>Current lens status.</p> 1173 * <p>For lens parameters {@link CaptureRequest#LENS_FOCAL_LENGTH android.lens.focalLength}, {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance}, 1174 * {@link CaptureRequest#LENS_FILTER_DENSITY android.lens.filterDensity} and {@link CaptureRequest#LENS_APERTURE android.lens.aperture}, when changes are requested, 1175 * they may take several frames to reach the requested values. This state indicates 1176 * the current status of the lens parameters.</p> 1177 * <p>When the state is STATIONARY, the lens parameters are not changing. This could be 1178 * either because the parameters are all fixed, or because the lens has had enough 1179 * time to reach the most recently-requested values. 1180 * If all these lens parameters are not changable for a camera device, as listed below:</p> 1181 * <ul> 1182 * <li>Fixed focus (<code>{@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} == 0</code>), which means 1183 * {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance} parameter will always be 0.</li> 1184 * <li>Fixed focal length ({@link CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS android.lens.info.availableFocalLengths} contains single value), 1185 * which means the optical zoom is not supported.</li> 1186 * <li>No ND filter ({@link CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES android.lens.info.availableFilterDensities} contains only 0).</li> 1187 * <li>Fixed aperture ({@link CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES android.lens.info.availableApertures} contains single value).</li> 1188 * </ul> 1189 * <p>Then this state will always be STATIONARY.</p> 1190 * <p>When the state is MOVING, it indicates that at least one of the lens parameters 1191 * is changing.</p> 1192 * 1193 * @see CaptureRequest#LENS_APERTURE 1194 * @see CaptureRequest#LENS_FILTER_DENSITY 1195 * @see CaptureRequest#LENS_FOCAL_LENGTH 1196 * @see CaptureRequest#LENS_FOCUS_DISTANCE 1197 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES 1198 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES 1199 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS 1200 * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE 1201 * @see #LENS_STATE_STATIONARY 1202 * @see #LENS_STATE_MOVING 1203 */ 1204 public static final Key<Integer> LENS_STATE = 1205 new Key<Integer>("android.lens.state", int.class); 1206 1207 /** 1208 * <p>Mode of operation for the noise reduction 1209 * algorithm</p> 1210 * <p>Noise filtering control. OFF means no noise reduction 1211 * will be applied by the HAL.</p> 1212 * <p>FAST/HIGH_QUALITY both mean camera device determined noise filtering 1213 * will be applied. HIGH_QUALITY mode indicates that the camera device 1214 * will use the highest-quality noise filtering algorithms, 1215 * even if it slows down capture rate. FAST means the camera device should not 1216 * slow down capture rate when applying noise filtering.</p> 1217 * @see #NOISE_REDUCTION_MODE_OFF 1218 * @see #NOISE_REDUCTION_MODE_FAST 1219 * @see #NOISE_REDUCTION_MODE_HIGH_QUALITY 1220 */ 1221 public static final Key<Integer> NOISE_REDUCTION_MODE = 1222 new Key<Integer>("android.noiseReduction.mode", int.class); 1223 1224 /** 1225 * <p>Whether a result given to the framework is the 1226 * final one for the capture, or only a partial that contains a 1227 * subset of the full set of dynamic metadata 1228 * values.</p> 1229 * <p>The entries in the result metadata buffers for a 1230 * single capture may not overlap, except for this entry. The 1231 * FINAL buffers must retain FIFO ordering relative to the 1232 * requests that generate them, so the FINAL buffer for frame 3 must 1233 * always be sent to the framework after the FINAL buffer for frame 2, and 1234 * before the FINAL buffer for frame 4. PARTIAL buffers may be returned 1235 * in any order relative to other frames, but all PARTIAL buffers for a given 1236 * capture must arrive before the FINAL buffer for that capture. This entry may 1237 * only be used by the HAL if quirks.usePartialResult is set to 1.</p> 1238 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1239 * @hide 1240 */ 1241 public static final Key<Boolean> QUIRKS_PARTIAL_RESULT = 1242 new Key<Boolean>("android.quirks.partialResult", boolean.class); 1243 1244 /** 1245 * <p>A frame counter set by the framework. This value monotonically 1246 * increases with every new result (that is, each new result has a unique 1247 * frameCount value).</p> 1248 * <p>Reset on release()</p> 1249 */ 1250 public static final Key<Integer> REQUEST_FRAME_COUNT = 1251 new Key<Integer>("android.request.frameCount", int.class); 1252 1253 /** 1254 * <p>An application-specified ID for the current 1255 * request. Must be maintained unchanged in output 1256 * frame</p> 1257 * @hide 1258 */ 1259 public static final Key<Integer> REQUEST_ID = 1260 new Key<Integer>("android.request.id", int.class); 1261 1262 /** 1263 * <p>Specifies the number of pipeline stages the frame went 1264 * through from when it was exposed to when the final completed result 1265 * was available to the framework.</p> 1266 * <p>Depending on what settings are used in the request, and 1267 * what streams are configured, the data may undergo less processing, 1268 * and some pipeline stages skipped.</p> 1269 * <p>See {@link CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH android.request.pipelineMaxDepth} for more details.</p> 1270 * 1271 * @see CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH 1272 */ 1273 public static final Key<Byte> REQUEST_PIPELINE_DEPTH = 1274 new Key<Byte>("android.request.pipelineDepth", byte.class); 1275 1276 /** 1277 * <p>(x, y, width, height).</p> 1278 * <p>A rectangle with the top-level corner of (x,y) and size 1279 * (width, height). The region of the sensor that is used for 1280 * output. Each stream must use this rectangle to produce its 1281 * output, cropping to a smaller region if necessary to 1282 * maintain the stream's aspect ratio.</p> 1283 * <p>HAL2.x uses only (x, y, width)</p> 1284 * <p>Any additional per-stream cropping must be done to 1285 * maximize the final pixel area of the stream.</p> 1286 * <p>For example, if the crop region is set to a 4:3 aspect 1287 * ratio, then 4:3 streams should use the exact crop 1288 * region. 16:9 streams should further crop vertically 1289 * (letterbox).</p> 1290 * <p>Conversely, if the crop region is set to a 16:9, then 4:3 1291 * outputs should crop horizontally (pillarbox), and 16:9 1292 * streams should match exactly. These additional crops must 1293 * be centered within the crop region.</p> 1294 * <p>The output streams must maintain square pixels at all 1295 * times, no matter what the relative aspect ratios of the 1296 * crop region and the stream are. Negative values for 1297 * corner are allowed for raw output if full pixel array is 1298 * larger than active pixel array. Width and height may be 1299 * rounded to nearest larger supportable width, especially 1300 * for raw output, where only a few fixed scales may be 1301 * possible. The width and height of the crop region cannot 1302 * be set to be smaller than floor( activeArraySize.width / 1303 * android.scaler.maxDigitalZoom ) and floor( 1304 * activeArraySize.height / android.scaler.maxDigitalZoom), 1305 * respectively.</p> 1306 */ 1307 public static final Key<android.graphics.Rect> SCALER_CROP_REGION = 1308 new Key<android.graphics.Rect>("android.scaler.cropRegion", android.graphics.Rect.class); 1309 1310 /** 1311 * <p>Duration each pixel is exposed to 1312 * light.</p> 1313 * <p>If the sensor can't expose this exact duration, it should shorten the 1314 * duration exposed to the nearest possible value (rather than expose longer).</p> 1315 * <p>1/10000 - 30 sec range. No bulb mode</p> 1316 */ 1317 public static final Key<Long> SENSOR_EXPOSURE_TIME = 1318 new Key<Long>("android.sensor.exposureTime", long.class); 1319 1320 /** 1321 * <p>Duration from start of frame exposure to 1322 * start of next frame exposure.</p> 1323 * <p>The maximum frame rate that can be supported by a camera subsystem is 1324 * a function of many factors:</p> 1325 * <ul> 1326 * <li>Requested resolutions of output image streams</li> 1327 * <li>Availability of binning / skipping modes on the imager</li> 1328 * <li>The bandwidth of the imager interface</li> 1329 * <li>The bandwidth of the various ISP processing blocks</li> 1330 * </ul> 1331 * <p>Since these factors can vary greatly between different ISPs and 1332 * sensors, the camera abstraction tries to represent the bandwidth 1333 * restrictions with as simple a model as possible.</p> 1334 * <p>The model presented has the following characteristics:</p> 1335 * <ul> 1336 * <li>The image sensor is always configured to output the smallest 1337 * resolution possible given the application's requested output stream 1338 * sizes. The smallest resolution is defined as being at least as large 1339 * as the largest requested output stream size; the camera pipeline must 1340 * never digitally upsample sensor data when the crop region covers the 1341 * whole sensor. In general, this means that if only small output stream 1342 * resolutions are configured, the sensor can provide a higher frame 1343 * rate.</li> 1344 * <li>Since any request may use any or all the currently configured 1345 * output streams, the sensor and ISP must be configured to support 1346 * scaling a single capture to all the streams at the same time. This 1347 * means the camera pipeline must be ready to produce the largest 1348 * requested output size without any delay. Therefore, the overall 1349 * frame rate of a given configured stream set is governed only by the 1350 * largest requested stream resolution.</li> 1351 * <li>Using more than one output stream in a request does not affect the 1352 * frame duration.</li> 1353 * <li>JPEG streams act like processed YUV streams in requests for which 1354 * they are not included; in requests in which they are directly 1355 * referenced, they act as JPEG streams. This is because supporting a 1356 * JPEG stream requires the underlying YUV data to always be ready for 1357 * use by a JPEG encoder, but the encoder will only be used (and impact 1358 * frame duration) on requests that actually reference a JPEG stream.</li> 1359 * <li>The JPEG processor can run concurrently to the rest of the camera 1360 * pipeline, but cannot process more than 1 capture at a time.</li> 1361 * </ul> 1362 * <p>The necessary information for the application, given the model above, 1363 * is provided via the android.scaler.available*MinDurations fields. 1364 * These are used to determine the maximum frame rate / minimum frame 1365 * duration that is possible for a given stream configuration.</p> 1366 * <p>Specifically, the application can use the following rules to 1367 * determine the minimum frame duration it can request from the HAL 1368 * device:</p> 1369 * <ol> 1370 * <li>Given the application's currently configured set of output 1371 * streams, <code>S</code>, divide them into three sets: streams in a JPEG format 1372 * <code>SJ</code>, streams in a raw sensor format <code>SR</code>, and the rest ('processed') 1373 * <code>SP</code>.</li> 1374 * <li>For each subset of streams, find the largest resolution (by pixel 1375 * count) in the subset. This gives (at most) three resolutions <code>RJ</code>, 1376 * <code>RR</code>, and <code>RP</code>.</li> 1377 * <li>If <code>RJ</code> is greater than <code>RP</code>, set <code>RP</code> equal to <code>RJ</code>. If there is 1378 * no exact match for <code>RP == RJ</code> (in particular there isn't an available 1379 * processed resolution at the same size as <code>RJ</code>), then set <code>RP</code> equal 1380 * to the smallest processed resolution that is larger than <code>RJ</code>. If 1381 * there are no processed resolutions larger than <code>RJ</code>, then set <code>RJ</code> to 1382 * the processed resolution closest to <code>RJ</code>.</li> 1383 * <li>If <code>RP</code> is greater than <code>RR</code>, set <code>RR</code> equal to <code>RP</code>. If there is 1384 * no exact match for <code>RR == RP</code> (in particular there isn't an available 1385 * raw resolution at the same size as <code>RP</code>), then set <code>RR</code> equal to 1386 * or to the smallest raw resolution that is larger than <code>RP</code>. If 1387 * there are no raw resolutions larger than <code>RP</code>, then set <code>RR</code> to 1388 * the raw resolution closest to <code>RP</code>.</li> 1389 * <li>Look up the matching minimum frame durations in the property lists 1390 * {@link CameraCharacteristics#SCALER_AVAILABLE_JPEG_MIN_DURATIONS android.scaler.availableJpegMinDurations}, 1391 * android.scaler.availableRawMinDurations, and 1392 * {@link CameraCharacteristics#SCALER_AVAILABLE_PROCESSED_MIN_DURATIONS android.scaler.availableProcessedMinDurations}. This gives three 1393 * minimum frame durations <code>FJ</code>, <code>FR</code>, and <code>FP</code>.</li> 1394 * <li>If a stream of requests do not use a JPEG stream, then the minimum 1395 * supported frame duration for each request is <code>max(FR, FP)</code>.</li> 1396 * <li>If a stream of requests all use the JPEG stream, then the minimum 1397 * supported frame duration for each request is <code>max(FR, FP, FJ)</code>.</li> 1398 * <li>If a mix of JPEG-using and non-JPEG-using requests is submitted by 1399 * the application, then the HAL will have to delay JPEG-using requests 1400 * whenever the JPEG encoder is still busy processing an older capture. 1401 * This will happen whenever a JPEG-using request starts capture less 1402 * than <code>FJ</code> <em>ns</em> after a previous JPEG-using request. The minimum 1403 * supported frame duration will vary between the values calculated in 1404 * #6 and #7.</li> 1405 * </ol> 1406 * 1407 * @see CameraCharacteristics#SCALER_AVAILABLE_JPEG_MIN_DURATIONS 1408 * @see CameraCharacteristics#SCALER_AVAILABLE_PROCESSED_MIN_DURATIONS 1409 */ 1410 public static final Key<Long> SENSOR_FRAME_DURATION = 1411 new Key<Long>("android.sensor.frameDuration", long.class); 1412 1413 /** 1414 * <p>Gain applied to image data. Must be 1415 * implemented through analog gain only if set to values 1416 * below 'maximum analog sensitivity'.</p> 1417 * <p>If the sensor can't apply this exact gain, it should lessen the 1418 * gain to the nearest possible value (rather than gain more).</p> 1419 * <p>ISO 12232:2006 REI method</p> 1420 */ 1421 public static final Key<Integer> SENSOR_SENSITIVITY = 1422 new Key<Integer>("android.sensor.sensitivity", int.class); 1423 1424 /** 1425 * <p>Time at start of exposure of first 1426 * row</p> 1427 * <p>Monotonic, should be synced to other timestamps in 1428 * system</p> 1429 */ 1430 public static final Key<Long> SENSOR_TIMESTAMP = 1431 new Key<Long>("android.sensor.timestamp", long.class); 1432 1433 /** 1434 * <p>The temperature of the sensor, sampled at the time 1435 * exposure began for this frame.</p> 1436 * <p>The thermal diode being queried should be inside the sensor PCB, or 1437 * somewhere close to it.</p> 1438 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1439 * <p><b>Full capability</b> - 1440 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 1441 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 1442 * 1443 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 1444 */ 1445 public static final Key<Float> SENSOR_TEMPERATURE = 1446 new Key<Float>("android.sensor.temperature", float.class); 1447 1448 /** 1449 * <p>The estimated white balance at the time of capture.</p> 1450 * <p>The estimated white balance encoded as the RGB values of the 1451 * perfectly neutral color point in the linear native sensor color space. 1452 * The order of the values is R, G, B; where R is in the lowest index.</p> 1453 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1454 */ 1455 public static final Key<Rational[]> SENSOR_NEUTRAL_COLOR_POINT = 1456 new Key<Rational[]>("android.sensor.neutralColorPoint", Rational[].class); 1457 1458 /** 1459 * <p>When enabled, the sensor sends a test pattern instead of 1460 * doing a real exposure from the camera.</p> 1461 * <p>When a test pattern is enabled, all manual sensor controls specified 1462 * by android.sensor.* should be ignored. All other controls should 1463 * work as normal.</p> 1464 * <p>For example, if manual flash is enabled, flash firing should still 1465 * occur (and that the test pattern remain unmodified, since the flash 1466 * would not actually affect it).</p> 1467 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1468 * @see #SENSOR_TEST_PATTERN_MODE_OFF 1469 * @see #SENSOR_TEST_PATTERN_MODE_SOLID_COLOR 1470 * @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS 1471 * @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY 1472 * @see #SENSOR_TEST_PATTERN_MODE_PN9 1473 * @see #SENSOR_TEST_PATTERN_MODE_CUSTOM1 1474 */ 1475 public static final Key<Integer> SENSOR_TEST_PATTERN_MODE = 1476 new Key<Integer>("android.sensor.testPatternMode", int.class); 1477 1478 /** 1479 * <p>Quality of lens shading correction applied 1480 * to the image data.</p> 1481 * <p>When set to OFF mode, no lens shading correction will be applied by the 1482 * camera device, and an identity lens shading map data will be provided 1483 * if <code>{@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} == ON</code>. For example, for lens 1484 * shading map with size specified as <code>{@link CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE android.lens.info.shadingMapSize} = [ 4, 3 ]</code>, 1485 * the output {@link CaptureResult#STATISTICS_LENS_SHADING_MAP android.statistics.lensShadingMap} for this case will be an identity map 1486 * shown below:</p> 1487 * <pre><code>[ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1488 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1489 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1490 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1491 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1492 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] 1493 * </code></pre> 1494 * <p>When set to other modes, lens shading correction will be applied by the 1495 * camera device. Applications can request lens shading map data by setting 1496 * {@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} to ON, and then the camera device will provide 1497 * lens shading map data in {@link CaptureResult#STATISTICS_LENS_SHADING_MAP android.statistics.lensShadingMap}, with size specified 1498 * by {@link CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE android.lens.info.shadingMapSize}.</p> 1499 * 1500 * @see CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE 1501 * @see CaptureResult#STATISTICS_LENS_SHADING_MAP 1502 * @see CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE 1503 * @see #SHADING_MODE_OFF 1504 * @see #SHADING_MODE_FAST 1505 * @see #SHADING_MODE_HIGH_QUALITY 1506 * @hide 1507 */ 1508 public static final Key<Integer> SHADING_MODE = 1509 new Key<Integer>("android.shading.mode", int.class); 1510 1511 /** 1512 * <p>State of the face detector 1513 * unit</p> 1514 * <p>Whether face detection is enabled, and whether it 1515 * should output just the basic fields or the full set of 1516 * fields. Value must be one of the 1517 * {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES android.statistics.info.availableFaceDetectModes}.</p> 1518 * 1519 * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES 1520 * @see #STATISTICS_FACE_DETECT_MODE_OFF 1521 * @see #STATISTICS_FACE_DETECT_MODE_SIMPLE 1522 * @see #STATISTICS_FACE_DETECT_MODE_FULL 1523 */ 1524 public static final Key<Integer> STATISTICS_FACE_DETECT_MODE = 1525 new Key<Integer>("android.statistics.faceDetectMode", int.class); 1526 1527 /** 1528 * <p>List of unique IDs for detected 1529 * faces</p> 1530 * <p>Only available if faceDetectMode == FULL</p> 1531 * @hide 1532 */ 1533 public static final Key<int[]> STATISTICS_FACE_IDS = 1534 new Key<int[]>("android.statistics.faceIds", int[].class); 1535 1536 /** 1537 * <p>List of landmarks for detected 1538 * faces</p> 1539 * <p>Only available if faceDetectMode == FULL</p> 1540 * @hide 1541 */ 1542 public static final Key<int[]> STATISTICS_FACE_LANDMARKS = 1543 new Key<int[]>("android.statistics.faceLandmarks", int[].class); 1544 1545 /** 1546 * <p>List of the bounding rectangles for detected 1547 * faces</p> 1548 * <p>Only available if faceDetectMode != OFF</p> 1549 * @hide 1550 */ 1551 public static final Key<android.graphics.Rect[]> STATISTICS_FACE_RECTANGLES = 1552 new Key<android.graphics.Rect[]>("android.statistics.faceRectangles", android.graphics.Rect[].class); 1553 1554 /** 1555 * <p>List of the face confidence scores for 1556 * detected faces</p> 1557 * <p>Only available if faceDetectMode != OFF. The value should be 1558 * meaningful (for example, setting 100 at all times is illegal).</p> 1559 * @hide 1560 */ 1561 public static final Key<byte[]> STATISTICS_FACE_SCORES = 1562 new Key<byte[]>("android.statistics.faceScores", byte[].class); 1563 1564 /** 1565 * <p>The shading map is a low-resolution floating-point map 1566 * that lists the coefficients used to correct for vignetting, for each 1567 * Bayer color channel.</p> 1568 * <p>The least shaded section of the image should have a gain factor 1569 * of 1; all other sections should have gains above 1.</p> 1570 * <p>When {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} = TRANSFORM_MATRIX, the map 1571 * must take into account the colorCorrection settings.</p> 1572 * <p>The shading map is for the entire active pixel array, and is not 1573 * affected by the crop region specified in the request. Each shading map 1574 * entry is the value of the shading compensation map over a specific 1575 * pixel on the sensor. Specifically, with a (N x M) resolution shading 1576 * map, and an active pixel array size (W x H), shading map entry 1577 * (x,y) ϵ (0 ... N-1, 0 ... M-1) is the value of the shading map at 1578 * pixel ( ((W-1)/(N-1)) * x, ((H-1)/(M-1)) * y) for the four color channels. 1579 * The map is assumed to be bilinearly interpolated between the sample points.</p> 1580 * <p>The channel order is [R, Geven, Godd, B], where Geven is the green 1581 * channel for the even rows of a Bayer pattern, and Godd is the odd rows. 1582 * The shading map is stored in a fully interleaved format, and its size 1583 * is provided in the camera static metadata by {@link CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE android.lens.info.shadingMapSize}.</p> 1584 * <p>The shading map should have on the order of 30-40 rows and columns, 1585 * and must be smaller than 64x64.</p> 1586 * <p>As an example, given a very small map defined as:</p> 1587 * <pre><code>{@link CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE android.lens.info.shadingMapSize} = [ 4, 3 ] 1588 * {@link CaptureResult#STATISTICS_LENS_SHADING_MAP android.statistics.lensShadingMap} = 1589 * [ 1.3, 1.2, 1.15, 1.2, 1.2, 1.2, 1.15, 1.2, 1590 * 1.1, 1.2, 1.2, 1.2, 1.3, 1.2, 1.3, 1.3, 1591 * 1.2, 1.2, 1.25, 1.1, 1.1, 1.1, 1.1, 1.0, 1592 * 1.0, 1.0, 1.0, 1.0, 1.2, 1.3, 1.25, 1.2, 1593 * 1.3, 1.2, 1.2, 1.3, 1.2, 1.15, 1.1, 1.2, 1594 * 1.2, 1.1, 1.0, 1.2, 1.3, 1.15, 1.2, 1.3 ] 1595 * </code></pre> 1596 * <p>The low-resolution scaling map images for each channel are 1597 * (displayed using nearest-neighbor interpolation):</p> 1598 * <p><img alt="Red lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/red_shading.png" /> 1599 * <img alt="Green (even rows) lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/green_e_shading.png" /> 1600 * <img alt="Green (odd rows) lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/green_o_shading.png" /> 1601 * <img alt="Blue lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/blue_shading.png" /></p> 1602 * <p>As a visualization only, inverting the full-color map to recover an 1603 * image of a gray wall (using bicubic interpolation for visual quality) as captured by the sensor gives:</p> 1604 * <p><img alt="Image of a uniform white wall (inverse shading map)" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/inv_shading.png" /></p> 1605 * 1606 * @see CaptureRequest#COLOR_CORRECTION_MODE 1607 * @see CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE 1608 * @see CaptureResult#STATISTICS_LENS_SHADING_MAP 1609 */ 1610 public static final Key<float[]> STATISTICS_LENS_SHADING_MAP = 1611 new Key<float[]>("android.statistics.lensShadingMap", float[].class); 1612 1613 /** 1614 * <p>The best-fit color channel gains calculated 1615 * by the HAL's statistics units for the current output frame</p> 1616 * <p>This may be different than the gains used for this frame, 1617 * since statistics processing on data from a new frame 1618 * typically completes after the transform has already been 1619 * applied to that frame.</p> 1620 * <p>The 4 channel gains are defined in Bayer domain, 1621 * see {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} for details.</p> 1622 * <p>This value should always be calculated by the AWB block, 1623 * regardless of the android.control.* current values.</p> 1624 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1625 * 1626 * @see CaptureRequest#COLOR_CORRECTION_GAINS 1627 * @hide 1628 */ 1629 public static final Key<float[]> STATISTICS_PREDICTED_COLOR_GAINS = 1630 new Key<float[]>("android.statistics.predictedColorGains", float[].class); 1631 1632 /** 1633 * <p>The best-fit color transform matrix estimate 1634 * calculated by the HAL's statistics units for the current 1635 * output frame</p> 1636 * <p>The HAL must provide the estimate from its 1637 * statistics unit on the white balance transforms to use 1638 * for the next frame. These are the values the HAL believes 1639 * are the best fit for the current output frame. This may 1640 * be different than the transform used for this frame, since 1641 * statistics processing on data from a new frame typically 1642 * completes after the transform has already been applied to 1643 * that frame.</p> 1644 * <p>These estimates must be provided for all frames, even if 1645 * capture settings and color transforms are set by the application.</p> 1646 * <p>This value should always be calculated by the AWB block, 1647 * regardless of the android.control.* current values.</p> 1648 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1649 * @hide 1650 */ 1651 public static final Key<Rational[]> STATISTICS_PREDICTED_COLOR_TRANSFORM = 1652 new Key<Rational[]>("android.statistics.predictedColorTransform", Rational[].class); 1653 1654 /** 1655 * <p>The camera device estimated scene illumination lighting 1656 * frequency.</p> 1657 * <p>Many light sources, such as most fluorescent lights, flicker at a rate 1658 * that depends on the local utility power standards. This flicker must be 1659 * accounted for by auto-exposure routines to avoid artifacts in captured images. 1660 * The camera device uses this entry to tell the application what the scene 1661 * illuminant frequency is.</p> 1662 * <p>When manual exposure control is enabled 1663 * (<code>{@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} == OFF</code> or <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == OFF</code>), 1664 * the {@link CaptureRequest#CONTROL_AE_ANTIBANDING_MODE android.control.aeAntibandingMode} doesn't do the antibanding, and the 1665 * application can ensure it selects exposure times that do not cause banding 1666 * issues by looking into this metadata field. See android.control.aeAntibandingMode 1667 * for more details.</p> 1668 * <p>Report NONE if there doesn't appear to be flickering illumination.</p> 1669 * 1670 * @see CaptureRequest#CONTROL_AE_ANTIBANDING_MODE 1671 * @see CaptureRequest#CONTROL_AE_MODE 1672 * @see CaptureRequest#CONTROL_MODE 1673 * @see #STATISTICS_SCENE_FLICKER_NONE 1674 * @see #STATISTICS_SCENE_FLICKER_50HZ 1675 * @see #STATISTICS_SCENE_FLICKER_60HZ 1676 */ 1677 public static final Key<Integer> STATISTICS_SCENE_FLICKER = 1678 new Key<Integer>("android.statistics.sceneFlicker", int.class); 1679 1680 /** 1681 * <p>Tonemapping / contrast / gamma curve for the blue 1682 * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 1683 * CONTRAST_CURVE.</p> 1684 * <p>See {@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} for more details.</p> 1685 * 1686 * @see CaptureRequest#TONEMAP_CURVE_RED 1687 * @see CaptureRequest#TONEMAP_MODE 1688 */ 1689 public static final Key<float[]> TONEMAP_CURVE_BLUE = 1690 new Key<float[]>("android.tonemap.curveBlue", float[].class); 1691 1692 /** 1693 * <p>Tonemapping / contrast / gamma curve for the green 1694 * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 1695 * CONTRAST_CURVE.</p> 1696 * <p>See {@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} for more details.</p> 1697 * 1698 * @see CaptureRequest#TONEMAP_CURVE_RED 1699 * @see CaptureRequest#TONEMAP_MODE 1700 */ 1701 public static final Key<float[]> TONEMAP_CURVE_GREEN = 1702 new Key<float[]>("android.tonemap.curveGreen", float[].class); 1703 1704 /** 1705 * <p>Tonemapping / contrast / gamma curve for the red 1706 * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 1707 * CONTRAST_CURVE.</p> 1708 * <p>Each channel's curve is defined by an array of control points:</p> 1709 * <pre><code>{@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} = 1710 * [ P0in, P0out, P1in, P1out, P2in, P2out, P3in, P3out, ..., PNin, PNout ] 1711 * 2 &lt;= N &lt;= {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</code></pre> 1712 * <p>These are sorted in order of increasing <code>Pin</code>; it is always 1713 * guaranteed that input values 0.0 and 1.0 are included in the list to 1714 * define a complete mapping. For input values between control points, 1715 * the camera device must linearly interpolate between the control 1716 * points.</p> 1717 * <p>Each curve can have an independent number of points, and the number 1718 * of points can be less than max (that is, the request doesn't have to 1719 * always provide a curve with number of points equivalent to 1720 * {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}).</p> 1721 * <p>A few examples, and their corresponding graphical mappings; these 1722 * only specify the red channel and the precision is limited to 4 1723 * digits, for conciseness.</p> 1724 * <p>Linear mapping:</p> 1725 * <pre><code>{@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} = [ 0, 0, 1.0, 1.0 ] 1726 * </code></pre> 1727 * <p><img alt="Linear mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png" /></p> 1728 * <p>Invert mapping:</p> 1729 * <pre><code>{@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} = [ 0, 1.0, 1.0, 0 ] 1730 * </code></pre> 1731 * <p><img alt="Inverting mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png" /></p> 1732 * <p>Gamma 1/2.2 mapping, with 16 control points:</p> 1733 * <pre><code>{@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} = [ 1734 * 0.0000, 0.0000, 0.0667, 0.2920, 0.1333, 0.4002, 0.2000, 0.4812, 1735 * 0.2667, 0.5484, 0.3333, 0.6069, 0.4000, 0.6594, 0.4667, 0.7072, 1736 * 0.5333, 0.7515, 0.6000, 0.7928, 0.6667, 0.8317, 0.7333, 0.8685, 1737 * 0.8000, 0.9035, 0.8667, 0.9370, 0.9333, 0.9691, 1.0000, 1.0000 ] 1738 * </code></pre> 1739 * <p><img alt="Gamma = 1/2.2 tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png" /></p> 1740 * <p>Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:</p> 1741 * <pre><code>{@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} = [ 1742 * 0.0000, 0.0000, 0.0667, 0.2864, 0.1333, 0.4007, 0.2000, 0.4845, 1743 * 0.2667, 0.5532, 0.3333, 0.6125, 0.4000, 0.6652, 0.4667, 0.7130, 1744 * 0.5333, 0.7569, 0.6000, 0.7977, 0.6667, 0.8360, 0.7333, 0.8721, 1745 * 0.8000, 0.9063, 0.8667, 0.9389, 0.9333, 0.9701, 1.0000, 1.0000 ] 1746 * </code></pre> 1747 * <p><img alt="sRGB tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p> 1748 * 1749 * @see CaptureRequest#TONEMAP_CURVE_RED 1750 * @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS 1751 * @see CaptureRequest#TONEMAP_MODE 1752 */ 1753 public static final Key<float[]> TONEMAP_CURVE_RED = 1754 new Key<float[]>("android.tonemap.curveRed", float[].class); 1755 1756 /** 1757 * <p>High-level global contrast/gamma/tonemapping control.</p> 1758 * <p>When switching to an application-defined contrast curve by setting 1759 * {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} to CONTRAST_CURVE, the curve is defined 1760 * per-channel with a set of <code>(in, out)</code> points that specify the 1761 * mapping from input high-bit-depth pixel value to the output 1762 * low-bit-depth value. Since the actual pixel ranges of both input 1763 * and output may change depending on the camera pipeline, the values 1764 * are specified by normalized floating-point numbers.</p> 1765 * <p>More-complex color mapping operations such as 3D color look-up 1766 * tables, selective chroma enhancement, or other non-linear color 1767 * transforms will be disabled when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 1768 * CONTRAST_CURVE.</p> 1769 * <p>When using either FAST or HIGH_QUALITY, the camera device will 1770 * emit its own tonemap curve in {@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed}, 1771 * {@link CaptureRequest#TONEMAP_CURVE_GREEN android.tonemap.curveGreen}, and {@link CaptureRequest#TONEMAP_CURVE_BLUE android.tonemap.curveBlue}. 1772 * These values are always available, and as close as possible to the 1773 * actually used nonlinear/nonglobal transforms.</p> 1774 * <p>If a request is sent with TRANSFORM_MATRIX with the camera device's 1775 * provided curve in FAST or HIGH_QUALITY, the image's tonemap will be 1776 * roughly the same.</p> 1777 * 1778 * @see CaptureRequest#TONEMAP_CURVE_BLUE 1779 * @see CaptureRequest#TONEMAP_CURVE_GREEN 1780 * @see CaptureRequest#TONEMAP_CURVE_RED 1781 * @see CaptureRequest#TONEMAP_MODE 1782 * @see #TONEMAP_MODE_CONTRAST_CURVE 1783 * @see #TONEMAP_MODE_FAST 1784 * @see #TONEMAP_MODE_HIGH_QUALITY 1785 */ 1786 public static final Key<Integer> TONEMAP_MODE = 1787 new Key<Integer>("android.tonemap.mode", int.class); 1788 1789 /** 1790 * <p>This LED is nominally used to indicate to the user 1791 * that the camera is powered on and may be streaming images back to the 1792 * Application Processor. In certain rare circumstances, the OS may 1793 * disable this when video is processed locally and not transmitted to 1794 * any untrusted applications.</p> 1795 * <p>In particular, the LED <em>must</em> always be on when the data could be 1796 * transmitted off the device. The LED <em>should</em> always be on whenever 1797 * data is stored locally on the device.</p> 1798 * <p>The LED <em>may</em> be off if a trusted application is using the data that 1799 * doesn't violate the above rules.</p> 1800 * @hide 1801 */ 1802 public static final Key<Boolean> LED_TRANSMIT = 1803 new Key<Boolean>("android.led.transmit", boolean.class); 1804 1805 /** 1806 * <p>Whether black-level compensation is locked 1807 * to its current values, or is free to vary.</p> 1808 * <p>Whether the black level offset was locked for this frame. Should be 1809 * ON if {@link CaptureRequest#BLACK_LEVEL_LOCK android.blackLevel.lock} was ON in the capture request, unless 1810 * a change in other capture settings forced the camera device to 1811 * perform a black level reset.</p> 1812 * 1813 * @see CaptureRequest#BLACK_LEVEL_LOCK 1814 */ 1815 public static final Key<Boolean> BLACK_LEVEL_LOCK = 1816 new Key<Boolean>("android.blackLevel.lock", boolean.class); 1817 1818 /** 1819 * <p>The frame number corresponding to the last request 1820 * with which the output result (metadata + buffers) has been fully 1821 * synchronized.</p> 1822 * <p>When a request is submitted to the camera device, there is usually a 1823 * delay of several frames before the controls get applied. A camera 1824 * device may either choose to account for this delay by implementing a 1825 * pipeline and carefully submit well-timed atomic control updates, or 1826 * it may start streaming control changes that span over several frame 1827 * boundaries.</p> 1828 * <p>In the latter case, whenever a request's settings change relative to 1829 * the previous submitted request, the full set of changes may take 1830 * multiple frame durations to fully take effect. Some settings may 1831 * take effect sooner (in less frame durations) than others.</p> 1832 * <p>While a set of control changes are being propagated, this value 1833 * will be CONVERGING.</p> 1834 * <p>Once it is fully known that a set of control changes have been 1835 * finished propagating, and the resulting updated control settings 1836 * have been read back by the camera device, this value will be set 1837 * to a non-negative frame number (corresponding to the request to 1838 * which the results have synchronized to).</p> 1839 * <p>Older camera device implementations may not have a way to detect 1840 * when all camera controls have been applied, and will always set this 1841 * value to UNKNOWN.</p> 1842 * <p>FULL capability devices will always have this value set to the 1843 * frame number of the request corresponding to this result.</p> 1844 * <p><em>Further details</em>:</p> 1845 * <ul> 1846 * <li>Whenever a request differs from the last request, any future 1847 * results not yet returned may have this value set to CONVERGING (this 1848 * could include any in-progress captures not yet returned by the camera 1849 * device, for more details see pipeline considerations below).</li> 1850 * <li>Submitting a series of multiple requests that differ from the 1851 * previous request (e.g. r1, r2, r3 s.t. r1 != r2 != r3) 1852 * moves the new synchronization frame to the last non-repeating 1853 * request (using the smallest frame number from the contiguous list of 1854 * repeating requests).</li> 1855 * <li>Submitting the same request repeatedly will not change this value 1856 * to CONVERGING, if it was already a non-negative value.</li> 1857 * <li>When this value changes to non-negative, that means that all of the 1858 * metadata controls from the request have been applied, all of the 1859 * metadata controls from the camera device have been read to the 1860 * updated values (into the result), and all of the graphics buffers 1861 * corresponding to this result are also synchronized to the request.</li> 1862 * </ul> 1863 * <p><em>Pipeline considerations</em>:</p> 1864 * <p>Submitting a request with updated controls relative to the previously 1865 * submitted requests may also invalidate the synchronization state 1866 * of all the results corresponding to currently in-flight requests.</p> 1867 * <p>In other words, results for this current request and up to 1868 * {@link CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH android.request.pipelineMaxDepth} prior requests may have their 1869 * android.sync.frameNumber change to CONVERGING.</p> 1870 * 1871 * @see CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH 1872 * @see #SYNC_FRAME_NUMBER_CONVERGING 1873 * @see #SYNC_FRAME_NUMBER_UNKNOWN 1874 * @hide 1875 */ 1876 public static final Key<Integer> SYNC_FRAME_NUMBER = 1877 new Key<Integer>("android.sync.frameNumber", int.class); 1878 1879 /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ 1880 * End generated code 1881 *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/ 1882 1883 /** 1884 * <p> 1885 * List of the {@link Face Faces} detected through camera face detection 1886 * in this result. 1887 * </p> 1888 * <p> 1889 * Only available if {@link #STATISTICS_FACE_DETECT_MODE} {@code !=} 1890 * {@link CameraMetadata#STATISTICS_FACE_DETECT_MODE_OFF OFF}. 1891 * </p> 1892 * 1893 * @see Face 1894 */ 1895 public static final Key<Face[]> STATISTICS_FACES = 1896 new Key<Face[]>("android.statistics.faces", Face[].class); 1897} 1898
