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