CaptureResult.java revision 399f05d1e7182ef6c88d30d3b98a467b845ca7c4
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 color channels for 144 * white-balance</p> 145 * <p>The 4-channel white-balance gains are defined in 146 * the order of [R G_even G_odd B], where G_even is the gain 147 * for green pixels on even rows of the output, and G_odd 148 * is the gain for greenpixels on the odd rows. if a HAL 149 * does not support a separate gain for even/odd green channels, 150 * it should use the G_even value,and write G_odd equal to 151 * G_even 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 ouput 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#SENSOR_FRAME_DURATION 199 * @see CaptureRequest#SENSOR_SENSITIVITY 200 * @see CaptureRequest#FLASH_MODE 201 * @see CameraCharacteristics#FLASH_INFO_AVAILABLE 202 * @see CaptureRequest#CONTROL_MODE 203 * @see CaptureRequest#SENSOR_EXPOSURE_TIME 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 CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 232 * @see CaptureRequest#SCALER_CROP_REGION 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>Whenever the AE algorithm state changes, a 240 * MSG_AUTOEXPOSURE notification must be send if a 241 * notification callback is registered.</p> 242 * @see #CONTROL_AE_STATE_INACTIVE 243 * @see #CONTROL_AE_STATE_SEARCHING 244 * @see #CONTROL_AE_STATE_CONVERGED 245 * @see #CONTROL_AE_STATE_LOCKED 246 * @see #CONTROL_AE_STATE_FLASH_REQUIRED 247 * @see #CONTROL_AE_STATE_PRECAPTURE 248 */ 249 public static final Key<Integer> CONTROL_AE_STATE = 250 new Key<Integer>("android.control.aeState", int.class); 251 252 /** 253 * <p>Whether AF is currently enabled, and what 254 * mode it is set to</p> 255 * <p>Only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} = AUTO.</p> 256 * <p>If the lens is controlled by the camera device auto-focus algorithm, 257 * the camera device will report the current AF status in android.control.afState 258 * in result metadata.</p> 259 * 260 * @see CaptureRequest#CONTROL_MODE 261 * @see #CONTROL_AF_MODE_OFF 262 * @see #CONTROL_AF_MODE_AUTO 263 * @see #CONTROL_AF_MODE_MACRO 264 * @see #CONTROL_AF_MODE_CONTINUOUS_VIDEO 265 * @see #CONTROL_AF_MODE_CONTINUOUS_PICTURE 266 * @see #CONTROL_AF_MODE_EDOF 267 */ 268 public static final Key<Integer> CONTROL_AF_MODE = 269 new Key<Integer>("android.control.afMode", int.class); 270 271 /** 272 * <p>List of areas to use for focus 273 * estimation</p> 274 * <p>Each area is a rectangle plus weight: xmin, ymin, 275 * xmax, ymax, weight. The rectangle is defined inclusive of the 276 * specified coordinates.</p> 277 * <p>The coordinate system is based on the active pixel array, 278 * with (0,0) being the top-left pixel in the active pixel array, and 279 * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 280 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 281 * bottom-right pixel in the active pixel array. The weight 282 * should be nonnegative.</p> 283 * <p>If all regions have 0 weight, then no specific focus area 284 * needs to be used by the HAL. If the focusing region is 285 * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the HAL 286 * should ignore the sections outside the region and output the 287 * used sections in the frame metadata</p> 288 * 289 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 290 * @see CaptureRequest#SCALER_CROP_REGION 291 */ 292 public static final Key<int[]> CONTROL_AF_REGIONS = 293 new Key<int[]>("android.control.afRegions", int[].class); 294 295 /** 296 * <p>Current state of AF algorithm</p> 297 * <p>Whenever the AF algorithm state changes, a 298 * MSG_AUTOFOCUS notification must be send if a notification 299 * callback is registered.</p> 300 * @see #CONTROL_AF_STATE_INACTIVE 301 * @see #CONTROL_AF_STATE_PASSIVE_SCAN 302 * @see #CONTROL_AF_STATE_PASSIVE_FOCUSED 303 * @see #CONTROL_AF_STATE_ACTIVE_SCAN 304 * @see #CONTROL_AF_STATE_FOCUSED_LOCKED 305 * @see #CONTROL_AF_STATE_NOT_FOCUSED_LOCKED 306 * @see #CONTROL_AF_STATE_PASSIVE_UNFOCUSED 307 */ 308 public static final Key<Integer> CONTROL_AF_STATE = 309 new Key<Integer>("android.control.afState", int.class); 310 311 /** 312 * <p>The ID sent with the latest 313 * CAMERA2_TRIGGER_AUTOFOCUS call</p> 314 * <p>Must be 0 if no CAMERA2_TRIGGER_AUTOFOCUS trigger 315 * received yet by HAL. Always updated even if AF algorithm 316 * ignores the trigger</p> 317 * @hide 318 */ 319 public static final Key<Integer> CONTROL_AF_TRIGGER_ID = 320 new Key<Integer>("android.control.afTriggerId", int.class); 321 322 /** 323 * <p>Whether AWB is currently setting the color 324 * transform fields, and what its illumination target 325 * is</p> 326 * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is AUTO.</p> 327 * <p>When set to the ON mode, the camera device's auto white balance 328 * routine is enabled, overriding the application's selected 329 * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and 330 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.</p> 331 * <p>When set to the OFF mode, the camera device's auto white balance 332 * routine is disabled. The applicantion manually controls the white 333 * balance by {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, android.colorCorrection.gains 334 * and {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.</p> 335 * <p>When set to any other modes, the camera device's auto white balance 336 * routine is disabled. The camera device uses each particular illumination 337 * target for white balance adjustment.</p> 338 * 339 * @see CaptureRequest#CONTROL_MODE 340 * @see CaptureRequest#COLOR_CORRECTION_MODE 341 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM 342 * @see CaptureRequest#COLOR_CORRECTION_GAINS 343 * @see #CONTROL_AWB_MODE_OFF 344 * @see #CONTROL_AWB_MODE_AUTO 345 * @see #CONTROL_AWB_MODE_INCANDESCENT 346 * @see #CONTROL_AWB_MODE_FLUORESCENT 347 * @see #CONTROL_AWB_MODE_WARM_FLUORESCENT 348 * @see #CONTROL_AWB_MODE_DAYLIGHT 349 * @see #CONTROL_AWB_MODE_CLOUDY_DAYLIGHT 350 * @see #CONTROL_AWB_MODE_TWILIGHT 351 * @see #CONTROL_AWB_MODE_SHADE 352 */ 353 public static final Key<Integer> CONTROL_AWB_MODE = 354 new Key<Integer>("android.control.awbMode", int.class); 355 356 /** 357 * <p>List of areas to use for illuminant 358 * estimation</p> 359 * <p>Only used in AUTO mode.</p> 360 * <p>Each area is a rectangle plus weight: xmin, ymin, 361 * xmax, ymax, weight. The rectangle is defined inclusive of the 362 * specified coordinates.</p> 363 * <p>The coordinate system is based on the active pixel array, 364 * with (0,0) being the top-left pixel in the active pixel array, and 365 * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 366 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 367 * bottom-right pixel in the active pixel array. The weight 368 * should be nonnegative.</p> 369 * <p>If all regions have 0 weight, then no specific metering area 370 * needs to be used by the HAL. If the metering region is 371 * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the HAL 372 * should ignore the sections outside the region and output the 373 * used sections in the frame metadata</p> 374 * 375 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 376 * @see CaptureRequest#SCALER_CROP_REGION 377 */ 378 public static final Key<int[]> CONTROL_AWB_REGIONS = 379 new Key<int[]>("android.control.awbRegions", int[].class); 380 381 /** 382 * <p>Current state of AWB algorithm</p> 383 * <p>Whenever the AWB algorithm state changes, a 384 * MSG_AUTOWHITEBALANCE notification must be send if a 385 * notification callback is registered.</p> 386 * @see #CONTROL_AWB_STATE_INACTIVE 387 * @see #CONTROL_AWB_STATE_SEARCHING 388 * @see #CONTROL_AWB_STATE_CONVERGED 389 * @see #CONTROL_AWB_STATE_LOCKED 390 */ 391 public static final Key<Integer> CONTROL_AWB_STATE = 392 new Key<Integer>("android.control.awbState", int.class); 393 394 /** 395 * <p>Overall mode of 3A control 396 * routines</p> 397 * <p>High-level 3A control. When set to OFF, all 3A control 398 * by the HAL is disabled. The application must set the fields for 399 * capture parameters itself.</p> 400 * <p>When set to AUTO, the individual algorithm controls in 401 * android.control.* are in effect, such as {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}.</p> 402 * <p>When set to USE_SCENE_MODE, the individual controls in 403 * android.control.* are mostly disabled, and the HAL implements 404 * one of the scene mode settings (such as ACTION, SUNSET, or PARTY) 405 * as it wishes. The HAL scene mode 3A settings are provided by 406 * android.control.sceneModeOverrides.</p> 407 * 408 * @see CaptureRequest#CONTROL_AF_MODE 409 * @see #CONTROL_MODE_OFF 410 * @see #CONTROL_MODE_AUTO 411 * @see #CONTROL_MODE_USE_SCENE_MODE 412 */ 413 public static final Key<Integer> CONTROL_MODE = 414 new Key<Integer>("android.control.mode", int.class); 415 416 /** 417 * <p>Operation mode for edge 418 * enhancement</p> 419 * <p>Edge/sharpness/detail enhancement. OFF means no 420 * enhancement will be applied by the HAL.</p> 421 * <p>FAST/HIGH_QUALITY both mean HAL-determined enhancement 422 * will be applied. HIGH_QUALITY mode indicates that the 423 * HAL should use the highest-quality enhancement algorithms, 424 * even if it slows down capture rate. FAST means the HAL should 425 * not slow down capture rate when applying edge enhancement.</p> 426 * @see #EDGE_MODE_OFF 427 * @see #EDGE_MODE_FAST 428 * @see #EDGE_MODE_HIGH_QUALITY 429 */ 430 public static final Key<Integer> EDGE_MODE = 431 new Key<Integer>("android.edge.mode", int.class); 432 433 /** 434 * <p>Select flash operation mode</p> 435 * @see #FLASH_MODE_OFF 436 * @see #FLASH_MODE_SINGLE 437 * @see #FLASH_MODE_TORCH 438 */ 439 public static final Key<Integer> FLASH_MODE = 440 new Key<Integer>("android.flash.mode", int.class); 441 442 /** 443 * <p>Current state of the flash 444 * unit</p> 445 * @see #FLASH_STATE_UNAVAILABLE 446 * @see #FLASH_STATE_CHARGING 447 * @see #FLASH_STATE_READY 448 * @see #FLASH_STATE_FIRED 449 */ 450 public static final Key<Integer> FLASH_STATE = 451 new Key<Integer>("android.flash.state", int.class); 452 453 /** 454 * <p>GPS coordinates to include in output JPEG 455 * EXIF</p> 456 */ 457 public static final Key<double[]> JPEG_GPS_COORDINATES = 458 new Key<double[]>("android.jpeg.gpsCoordinates", double[].class); 459 460 /** 461 * <p>32 characters describing GPS algorithm to 462 * include in EXIF</p> 463 */ 464 public static final Key<String> JPEG_GPS_PROCESSING_METHOD = 465 new Key<String>("android.jpeg.gpsProcessingMethod", String.class); 466 467 /** 468 * <p>Time GPS fix was made to include in 469 * EXIF</p> 470 */ 471 public static final Key<Long> JPEG_GPS_TIMESTAMP = 472 new Key<Long>("android.jpeg.gpsTimestamp", long.class); 473 474 /** 475 * <p>Orientation of JPEG image to 476 * write</p> 477 */ 478 public static final Key<Integer> JPEG_ORIENTATION = 479 new Key<Integer>("android.jpeg.orientation", int.class); 480 481 /** 482 * <p>Compression quality of the final JPEG 483 * image</p> 484 * <p>85-95 is typical usage range</p> 485 */ 486 public static final Key<Byte> JPEG_QUALITY = 487 new Key<Byte>("android.jpeg.quality", byte.class); 488 489 /** 490 * <p>Compression quality of JPEG 491 * thumbnail</p> 492 */ 493 public static final Key<Byte> JPEG_THUMBNAIL_QUALITY = 494 new Key<Byte>("android.jpeg.thumbnailQuality", byte.class); 495 496 /** 497 * <p>Resolution of embedded JPEG thumbnail</p> 498 * <p>When set to (0, 0) value, the JPEG EXIF must not contain thumbnail, 499 * but the captured JPEG must still be a valid image.</p> 500 * <p>When a jpeg image capture is issued, the thumbnail size selected should have 501 * the same aspect ratio as the jpeg image.</p> 502 */ 503 public static final Key<android.hardware.camera2.Size> JPEG_THUMBNAIL_SIZE = 504 new Key<android.hardware.camera2.Size>("android.jpeg.thumbnailSize", android.hardware.camera2.Size.class); 505 506 /** 507 * <p>The ratio of lens focal length to the effective 508 * aperture diameter.</p> 509 * <p>This will only be supported on the camera devices that 510 * have variable aperture lens. The aperture value can only be 511 * one of the values listed in {@link CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES android.lens.info.availableApertures}.</p> 512 * <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is OFF, 513 * this can be set along with {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, 514 * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and android.sensor.frameDuration 515 * to achieve manual exposure control.</p> 516 * <p>The requested aperture value may take several frames to reach the 517 * requested value; the camera device will report the current (intermediate) 518 * aperture size in capture result metadata while the aperture is changing.</p> 519 * <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is one of 520 * the ON modes, this will be overridden by the camera device 521 * auto-exposure algorithm, the overridden values are then provided 522 * back to the user in the corresponding result.</p> 523 * 524 * @see CaptureRequest#SENSOR_EXPOSURE_TIME 525 * @see CaptureRequest#SENSOR_SENSITIVITY 526 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES 527 * @see CaptureRequest#CONTROL_AE_MODE 528 */ 529 public static final Key<Float> LENS_APERTURE = 530 new Key<Float>("android.lens.aperture", float.class); 531 532 /** 533 * <p>State of lens neutral density 534 * filter(s)</p> 535 * <p>Will not be supported on most devices. Can only 536 * pick from supported list</p> 537 */ 538 public static final Key<Float> LENS_FILTER_DENSITY = 539 new Key<Float>("android.lens.filterDensity", float.class); 540 541 /** 542 * <p>Lens optical zoom setting</p> 543 * <p>Will not be supported on most devices.</p> 544 */ 545 public static final Key<Float> LENS_FOCAL_LENGTH = 546 new Key<Float>("android.lens.focalLength", float.class); 547 548 /** 549 * <p>Distance to plane of sharpest focus, 550 * measured from frontmost surface of the lens</p> 551 * <p>Should be zero for fixed-focus cameras</p> 552 */ 553 public static final Key<Float> LENS_FOCUS_DISTANCE = 554 new Key<Float>("android.lens.focusDistance", float.class); 555 556 /** 557 * <p>The range of scene distances that are in 558 * sharp focus (depth of field)</p> 559 * <p>If variable focus not supported, can still report 560 * fixed depth of field range</p> 561 */ 562 public static final Key<float[]> LENS_FOCUS_RANGE = 563 new Key<float[]>("android.lens.focusRange", float[].class); 564 565 /** 566 * <p>Whether optical image stabilization is 567 * enabled.</p> 568 * <p>Will not be supported on most devices.</p> 569 * @see #LENS_OPTICAL_STABILIZATION_MODE_OFF 570 * @see #LENS_OPTICAL_STABILIZATION_MODE_ON 571 */ 572 public static final Key<Integer> LENS_OPTICAL_STABILIZATION_MODE = 573 new Key<Integer>("android.lens.opticalStabilizationMode", int.class); 574 575 /** 576 * <p>Current lens status</p> 577 * @see #LENS_STATE_STATIONARY 578 * @see #LENS_STATE_MOVING 579 */ 580 public static final Key<Integer> LENS_STATE = 581 new Key<Integer>("android.lens.state", int.class); 582 583 /** 584 * <p>Mode of operation for the noise reduction 585 * algorithm</p> 586 * <p>Noise filtering control. OFF means no noise reduction 587 * will be applied by the HAL.</p> 588 * <p>FAST/HIGH_QUALITY both mean HAL-determined noise filtering 589 * will be applied. HIGH_QUALITY mode indicates that the HAL 590 * should use the highest-quality noise filtering algorithms, 591 * even if it slows down capture rate. FAST means the HAL should not 592 * slow down capture rate when applying noise filtering.</p> 593 * @see #NOISE_REDUCTION_MODE_OFF 594 * @see #NOISE_REDUCTION_MODE_FAST 595 * @see #NOISE_REDUCTION_MODE_HIGH_QUALITY 596 */ 597 public static final Key<Integer> NOISE_REDUCTION_MODE = 598 new Key<Integer>("android.noiseReduction.mode", int.class); 599 600 /** 601 * <p>Whether a result given to the framework is the 602 * final one for the capture, or only a partial that contains a 603 * subset of the full set of dynamic metadata 604 * values.</p> 605 * <p>The entries in the result metadata buffers for a 606 * single capture may not overlap, except for this entry. The 607 * FINAL buffers must retain FIFO ordering relative to the 608 * requests that generate them, so the FINAL buffer for frame 3 must 609 * always be sent to the framework after the FINAL buffer for frame 2, and 610 * before the FINAL buffer for frame 4. PARTIAL buffers may be returned 611 * in any order relative to other frames, but all PARTIAL buffers for a given 612 * capture must arrive before the FINAL buffer for that capture. This entry may 613 * only be used by the HAL if quirks.usePartialResult is set to 1.</p> 614 * <p><b>Optional</b> - This value may be null on some devices.</p> 615 * @hide 616 */ 617 public static final Key<Boolean> QUIRKS_PARTIAL_RESULT = 618 new Key<Boolean>("android.quirks.partialResult", boolean.class); 619 620 /** 621 * <p>A frame counter set by the framework. This value monotonically 622 * increases with every new result (that is, each new result has a unique 623 * frameCount value).</p> 624 * <p>Reset on release()</p> 625 */ 626 public static final Key<Integer> REQUEST_FRAME_COUNT = 627 new Key<Integer>("android.request.frameCount", int.class); 628 629 /** 630 * <p>An application-specified ID for the current 631 * request. Must be maintained unchanged in output 632 * frame</p> 633 * @hide 634 */ 635 public static final Key<Integer> REQUEST_ID = 636 new Key<Integer>("android.request.id", int.class); 637 638 /** 639 * <p>(x, y, width, height).</p> 640 * <p>A rectangle with the top-level corner of (x,y) and size 641 * (width, height). The region of the sensor that is used for 642 * output. Each stream must use this rectangle to produce its 643 * output, cropping to a smaller region if necessary to 644 * maintain the stream's aspect ratio.</p> 645 * <p>HAL2.x uses only (x, y, width)</p> 646 * <p>Any additional per-stream cropping must be done to 647 * maximize the final pixel area of the stream.</p> 648 * <p>For example, if the crop region is set to a 4:3 aspect 649 * ratio, then 4:3 streams should use the exact crop 650 * region. 16:9 streams should further crop vertically 651 * (letterbox).</p> 652 * <p>Conversely, if the crop region is set to a 16:9, then 4:3 653 * outputs should crop horizontally (pillarbox), and 16:9 654 * streams should match exactly. These additional crops must 655 * be centered within the crop region.</p> 656 * <p>The output streams must maintain square pixels at all 657 * times, no matter what the relative aspect ratios of the 658 * crop region and the stream are. Negative values for 659 * corner are allowed for raw output if full pixel array is 660 * larger than active pixel array. Width and height may be 661 * rounded to nearest larger supportable width, especially 662 * for raw output, where only a few fixed scales may be 663 * possible. The width and height of the crop region cannot 664 * be set to be smaller than floor( activeArraySize.width / 665 * android.scaler.maxDigitalZoom ) and floor( 666 * activeArraySize.height / android.scaler.maxDigitalZoom), 667 * respectively.</p> 668 */ 669 public static final Key<android.graphics.Rect> SCALER_CROP_REGION = 670 new Key<android.graphics.Rect>("android.scaler.cropRegion", android.graphics.Rect.class); 671 672 /** 673 * <p>Duration each pixel is exposed to 674 * light.</p> 675 * <p>If the sensor can't expose this exact duration, it should shorten the 676 * duration exposed to the nearest possible value (rather than expose longer).</p> 677 * <p>1/10000 - 30 sec range. No bulb mode</p> 678 */ 679 public static final Key<Long> SENSOR_EXPOSURE_TIME = 680 new Key<Long>("android.sensor.exposureTime", long.class); 681 682 /** 683 * <p>Duration from start of frame exposure to 684 * start of next frame exposure</p> 685 * <p>Exposure time has priority, so duration is set to 686 * max(duration, exposure time + overhead)</p> 687 */ 688 public static final Key<Long> SENSOR_FRAME_DURATION = 689 new Key<Long>("android.sensor.frameDuration", long.class); 690 691 /** 692 * <p>Gain applied to image data. Must be 693 * implemented through analog gain only if set to values 694 * below 'maximum analog sensitivity'.</p> 695 * <p>If the sensor can't apply this exact gain, it should lessen the 696 * gain to the nearest possible value (rather than gain more).</p> 697 * <p>ISO 12232:2006 REI method</p> 698 */ 699 public static final Key<Integer> SENSOR_SENSITIVITY = 700 new Key<Integer>("android.sensor.sensitivity", int.class); 701 702 /** 703 * <p>Time at start of exposure of first 704 * row</p> 705 * <p>Monotonic, should be synced to other timestamps in 706 * system</p> 707 */ 708 public static final Key<Long> SENSOR_TIMESTAMP = 709 new Key<Long>("android.sensor.timestamp", long.class); 710 711 /** 712 * <p>The temperature of the sensor, sampled at the time 713 * exposure began for this frame.</p> 714 * <p>The thermal diode being queried should be inside the sensor PCB, or 715 * somewhere close to it.</p> 716 */ 717 public static final Key<Float> SENSOR_TEMPERATURE = 718 new Key<Float>("android.sensor.temperature", float.class); 719 720 /** 721 * <p>State of the face detector 722 * unit</p> 723 * <p>Whether face detection is enabled, and whether it 724 * should output just the basic fields or the full set of 725 * fields. Value must be one of the 726 * {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES android.statistics.info.availableFaceDetectModes}.</p> 727 * 728 * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES 729 * @see #STATISTICS_FACE_DETECT_MODE_OFF 730 * @see #STATISTICS_FACE_DETECT_MODE_SIMPLE 731 * @see #STATISTICS_FACE_DETECT_MODE_FULL 732 */ 733 public static final Key<Integer> STATISTICS_FACE_DETECT_MODE = 734 new Key<Integer>("android.statistics.faceDetectMode", int.class); 735 736 /** 737 * <p>List of unique IDs for detected 738 * faces</p> 739 * <p>Only available if faceDetectMode == FULL</p> 740 * @hide 741 */ 742 public static final Key<int[]> STATISTICS_FACE_IDS = 743 new Key<int[]>("android.statistics.faceIds", int[].class); 744 745 /** 746 * <p>List of landmarks for detected 747 * faces</p> 748 * <p>Only available if faceDetectMode == FULL</p> 749 * @hide 750 */ 751 public static final Key<int[]> STATISTICS_FACE_LANDMARKS = 752 new Key<int[]>("android.statistics.faceLandmarks", int[].class); 753 754 /** 755 * <p>List of the bounding rectangles for detected 756 * faces</p> 757 * <p>Only available if faceDetectMode != OFF</p> 758 * @hide 759 */ 760 public static final Key<android.graphics.Rect[]> STATISTICS_FACE_RECTANGLES = 761 new Key<android.graphics.Rect[]>("android.statistics.faceRectangles", android.graphics.Rect[].class); 762 763 /** 764 * <p>List of the face confidence scores for 765 * detected faces</p> 766 * <p>Only available if faceDetectMode != OFF. The value should be 767 * meaningful (for example, setting 100 at all times is illegal).</p> 768 * @hide 769 */ 770 public static final Key<byte[]> STATISTICS_FACE_SCORES = 771 new Key<byte[]>("android.statistics.faceScores", byte[].class); 772 773 /** 774 * <p>The shading map is a low-resolution floating-point map 775 * that lists the coefficients used to correct for vignetting, for each 776 * Bayer color channel.</p> 777 * <p>The least shaded section of the image should have a gain factor 778 * of 1; all other sections should have gains above 1.</p> 779 * <p>When {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} = TRANSFORM_MATRIX, the map 780 * must take into account the colorCorrection settings.</p> 781 * <p>The shading map is for the entire active pixel array, and is not 782 * affected by the crop region specified in the request. Each shading map 783 * entry is the value of the shading compensation map over a specific 784 * pixel on the sensor. Specifically, with a (N x M) resolution shading 785 * map, and an active pixel array size (W x H), shading map entry 786 * (x,y) ϵ (0 ... N-1, 0 ... M-1) is the value of the shading map at 787 * pixel ( ((W-1)/(N-1)) * x, ((H-1)/(M-1)) * y) for the four color channels. 788 * The map is assumed to be bilinearly interpolated between the sample points.</p> 789 * <p>The channel order is [R, Geven, Godd, B], where Geven is the green 790 * channel for the even rows of a Bayer pattern, and Godd is the odd rows. 791 * The shading map is stored in a fully interleaved format, and its size 792 * is provided in the camera static metadata by {@link CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE android.lens.info.shadingMapSize}.</p> 793 * <p>The shading map should have on the order of 30-40 rows and columns, 794 * and must be smaller than 64x64.</p> 795 * <p>As an example, given a very small map defined as:</p> 796 * <pre><code>{@link CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE android.lens.info.shadingMapSize} = [ 4, 3 ] 797 * {@link CaptureResult#STATISTICS_LENS_SHADING_MAP android.statistics.lensShadingMap} = 798 * [ 1.3, 1.2, 1.15, 1.2, 1.2, 1.2, 1.15, 1.2, 799 * 1.1, 1.2, 1.2, 1.2, 1.3, 1.2, 1.3, 1.3, 800 * 1.2, 1.2, 1.25, 1.1, 1.1, 1.1, 1.1, 1.0, 801 * 1.0, 1.0, 1.0, 1.0, 1.2, 1.3, 1.25, 1.2, 802 * 1.3, 1.2, 1.2, 1.3, 1.2, 1.15, 1.1, 1.2, 803 * 1.2, 1.1, 1.0, 1.2, 1.3, 1.15, 1.2, 1.3 ] 804 * </code></pre> 805 * <p>The low-resolution scaling map images for each channel are 806 * (displayed using nearest-neighbor interpolation):</p> 807 * <p><img alt="Red lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/red_shading.png" /> 808 * <img alt="Green (even rows) lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/green_e_shading.png" /> 809 * <img alt="Green (odd rows) lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/green_o_shading.png" /> 810 * <img alt="Blue lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/blue_shading.png" /></p> 811 * <p>As a visualization only, inverting the full-color map to recover an 812 * image of a gray wall (using bicubic interpolation for visual quality) as captured by the sensor gives:</p> 813 * <p><img alt="Image of a uniform white wall (inverse shading map)" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/inv_shading.png" /></p> 814 * 815 * @see CaptureResult#STATISTICS_LENS_SHADING_MAP 816 * @see CaptureRequest#COLOR_CORRECTION_MODE 817 * @see CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE 818 */ 819 public static final Key<float[]> STATISTICS_LENS_SHADING_MAP = 820 new Key<float[]>("android.statistics.lensShadingMap", float[].class); 821 822 /** 823 * <p>The best-fit color channel gains calculated 824 * by the HAL's statistics units for the current output frame</p> 825 * <p>This may be different than the gains used for this frame, 826 * since statistics processing on data from a new frame 827 * typically completes after the transform has already been 828 * applied to that frame.</p> 829 * <p>The 4 channel gains are defined in Bayer domain, 830 * see {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} for details.</p> 831 * <p>This value should always be calculated by the AWB block, 832 * regardless of the android.control.* current values.</p> 833 * 834 * @see CaptureRequest#COLOR_CORRECTION_GAINS 835 */ 836 public static final Key<float[]> STATISTICS_PREDICTED_COLOR_GAINS = 837 new Key<float[]>("android.statistics.predictedColorGains", float[].class); 838 839 /** 840 * <p>The best-fit color transform matrix estimate 841 * calculated by the HAL's statistics units for the current 842 * output frame</p> 843 * <p>The HAL must provide the estimate from its 844 * statistics unit on the white balance transforms to use 845 * for the next frame. These are the values the HAL believes 846 * are the best fit for the current output frame. This may 847 * be different than the transform used for this frame, since 848 * statistics processing on data from a new frame typically 849 * completes after the transform has already been applied to 850 * that frame.</p> 851 * <p>These estimates must be provided for all frames, even if 852 * capture settings and color transforms are set by the application.</p> 853 * <p>This value should always be calculated by the AWB block, 854 * regardless of the android.control.* current values.</p> 855 */ 856 public static final Key<Rational[]> STATISTICS_PREDICTED_COLOR_TRANSFORM = 857 new Key<Rational[]>("android.statistics.predictedColorTransform", Rational[].class); 858 859 /** 860 * <p>The HAL estimated scene illumination lighting 861 * frequency</p> 862 * <p>Report NONE if there doesn't appear to be flickering 863 * illumination</p> 864 * @see #STATISTICS_SCENE_FLICKER_NONE 865 * @see #STATISTICS_SCENE_FLICKER_50HZ 866 * @see #STATISTICS_SCENE_FLICKER_60HZ 867 */ 868 public static final Key<Integer> STATISTICS_SCENE_FLICKER = 869 new Key<Integer>("android.statistics.sceneFlicker", int.class); 870 871 /** 872 * <p>Table mapping blue input values to output 873 * values</p> 874 * <p>Tonemapping / contrast / gamma curve for the blue 875 * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is CONTRAST_CURVE.</p> 876 * <p>See {@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} for more details.</p> 877 * 878 * @see CaptureRequest#TONEMAP_CURVE_RED 879 * @see CaptureRequest#TONEMAP_MODE 880 */ 881 public static final Key<float[]> TONEMAP_CURVE_BLUE = 882 new Key<float[]>("android.tonemap.curveBlue", float[].class); 883 884 /** 885 * <p>Table mapping green input values to output 886 * values</p> 887 * <p>Tonemapping / contrast / gamma curve for the green 888 * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is CONTRAST_CURVE.</p> 889 * <p>See {@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} for more details.</p> 890 * 891 * @see CaptureRequest#TONEMAP_CURVE_RED 892 * @see CaptureRequest#TONEMAP_MODE 893 */ 894 public static final Key<float[]> TONEMAP_CURVE_GREEN = 895 new Key<float[]>("android.tonemap.curveGreen", float[].class); 896 897 /** 898 * <p>Table mapping red input values to output 899 * values</p> 900 * <p>Tonemapping / contrast / gamma curve for the red 901 * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is CONTRAST_CURVE.</p> 902 * <p>Since the input and output ranges may vary depending on 903 * the camera pipeline, the input and output pixel values 904 * are represented by normalized floating-point values 905 * between 0 and 1, with 0 == black and 1 == white.</p> 906 * <p>The curve should be linearly interpolated between the 907 * defined points. The points will be listed in increasing 908 * order of P_IN. For example, if the array is: [0.0, 0.0, 909 * 0.3, 0.5, 1.0, 1.0], then the input->output mapping 910 * for a few sample points would be: 0 -> 0, 0.15 -> 911 * 0.25, 0.3 -> 0.5, 0.5 -> 0.64</p> 912 * 913 * @see CaptureRequest#TONEMAP_MODE 914 */ 915 public static final Key<float[]> TONEMAP_CURVE_RED = 916 new Key<float[]>("android.tonemap.curveRed", float[].class); 917 918 /** 919 * @see #TONEMAP_MODE_CONTRAST_CURVE 920 * @see #TONEMAP_MODE_FAST 921 * @see #TONEMAP_MODE_HIGH_QUALITY 922 */ 923 public static final Key<Integer> TONEMAP_MODE = 924 new Key<Integer>("android.tonemap.mode", int.class); 925 926 /** 927 * <p>This LED is nominally used to indicate to the user 928 * that the camera is powered on and may be streaming images back to the 929 * Application Processor. In certain rare circumstances, the OS may 930 * disable this when video is processed locally and not transmitted to 931 * any untrusted applications.</p> 932 * <p>In particular, the LED <em>must</em> always be on when the data could be 933 * transmitted off the device. The LED <em>should</em> always be on whenever 934 * data is stored locally on the device.</p> 935 * <p>The LED <em>may</em> be off if a trusted application is using the data that 936 * doesn't violate the above rules.</p> 937 * @hide 938 */ 939 public static final Key<Boolean> LED_TRANSMIT = 940 new Key<Boolean>("android.led.transmit", boolean.class); 941 942 /** 943 * <p>Whether black-level compensation is locked 944 * to its current values, or is free to vary.</p> 945 * <p>Whether the black level offset was locked for this frame. Should be 946 * ON if {@link CaptureRequest#BLACK_LEVEL_LOCK android.blackLevel.lock} was ON in the capture request, unless 947 * a change in other capture settings forced the camera device to 948 * perform a black level reset.</p> 949 * 950 * @see CaptureRequest#BLACK_LEVEL_LOCK 951 */ 952 public static final Key<Boolean> BLACK_LEVEL_LOCK = 953 new Key<Boolean>("android.blackLevel.lock", boolean.class); 954 955 /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ 956 * End generated code 957 *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/ 958 959 /** 960 * <p> 961 * List of the {@link Face Faces} detected through camera face detection 962 * in this result. 963 * </p> 964 * <p> 965 * Only available if {@link #STATISTICS_FACE_DETECT_MODE} {@code !=} 966 * {@link CameraMetadata#STATISTICS_FACE_DETECT_MODE_OFF OFF}. 967 * </p> 968 * 969 * @see Face 970 */ 971 public static final Key<Face[]> STATISTICS_FACES = 972 new Key<Face[]>("android.statistics.faces", Face[].class); 973} 974