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