CaptureResult.java revision 7b2cae6ceca680f6034a9fe43df2446cbae2f090
1/* 2 * Copyright (C) 2012 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package android.hardware.camera2; 18 19import android.hardware.camera2.impl.CameraMetadataNative; 20import android.hardware.camera2.impl.CaptureResultExtras; 21import android.hardware.camera2.impl.PublicKey; 22import android.hardware.camera2.impl.SyntheticKey; 23import android.hardware.camera2.utils.TypeReference; 24import android.util.Log; 25import android.util.Rational; 26 27import java.util.List; 28 29/** 30 * <p>The subset of the results of a single image capture from the image sensor.</p> 31 * 32 * <p>Contains a subset of the final configuration for the capture hardware (sensor, lens, 33 * flash), the processing pipeline, the control algorithms, and the output 34 * buffers.</p> 35 * 36 * <p>CaptureResults are produced by a {@link CameraDevice} after processing a 37 * {@link CaptureRequest}. All properties listed for capture requests can also 38 * be queried on the capture result, to determine the final values used for 39 * capture. The result also includes additional metadata about the state of the 40 * camera device during the capture.</p> 41 * 42 * <p>Not all properties returned by {@link CameraCharacteristics#getAvailableCaptureResultKeys()} 43 * are necessarily available. Some results are {@link CaptureResult partial} and will 44 * not have every key set. Only {@link TotalCaptureResult total} results are guaranteed to have 45 * every key available that was enabled by the request.</p> 46 * 47 * <p>{@link CaptureResult} objects are immutable.</p> 48 * 49 */ 50public class CaptureResult extends CameraMetadata<CaptureResult.Key<?>> { 51 52 private static final String TAG = "CaptureResult"; 53 private static final boolean VERBOSE = false; 54 55 /** 56 * A {@code Key} is used to do capture result field lookups with 57 * {@link CaptureResult#get}. 58 * 59 * <p>For example, to get the timestamp corresponding to the exposure of the first row: 60 * <code><pre> 61 * long timestamp = captureResult.get(CaptureResult.SENSOR_TIMESTAMP); 62 * </pre></code> 63 * </p> 64 * 65 * <p>To enumerate over all possible keys for {@link CaptureResult}, see 66 * {@link CameraCharacteristics#getAvailableCaptureResultKeys}.</p> 67 * 68 * @see CaptureResult#get 69 * @see CameraCharacteristics#getAvailableCaptureResultKeys 70 */ 71 public final static class Key<T> { 72 private final CameraMetadataNative.Key<T> mKey; 73 74 /** 75 * Visible for testing and vendor extensions only. 76 * 77 * @hide 78 */ 79 public Key(String name, Class<T> type) { 80 mKey = new CameraMetadataNative.Key<T>(name, type); 81 } 82 83 /** 84 * Visible for testing and vendor extensions only. 85 * 86 * @hide 87 */ 88 public Key(String name, TypeReference<T> typeReference) { 89 mKey = new CameraMetadataNative.Key<T>(name, typeReference); 90 } 91 92 /** 93 * Return a camelCase, period separated name formatted like: 94 * {@code "root.section[.subsections].name"}. 95 * 96 * <p>Built-in keys exposed by the Android SDK are always prefixed with {@code "android."}; 97 * keys that are device/platform-specific are prefixed with {@code "com."}.</p> 98 * 99 * <p>For example, {@code CameraCharacteristics.SCALER_STREAM_CONFIGURATION_MAP} would 100 * have a name of {@code "android.scaler.streamConfigurationMap"}; whereas a device 101 * specific key might look like {@code "com.google.nexus.data.private"}.</p> 102 * 103 * @return String representation of the key name 104 */ 105 public String getName() { 106 return mKey.getName(); 107 } 108 109 /** 110 * {@inheritDoc} 111 */ 112 @Override 113 public final int hashCode() { 114 return mKey.hashCode(); 115 } 116 117 /** 118 * {@inheritDoc} 119 */ 120 @SuppressWarnings("unchecked") 121 @Override 122 public final boolean equals(Object o) { 123 return o instanceof Key && ((Key<T>)o).mKey.equals(mKey); 124 } 125 126 /** 127 * Visible for CameraMetadataNative implementation only; do not use. 128 * 129 * TODO: Make this private or remove it altogether. 130 * 131 * @hide 132 */ 133 public CameraMetadataNative.Key<T> getNativeKey() { 134 return mKey; 135 } 136 137 @SuppressWarnings({ "unchecked" }) 138 /*package*/ Key(CameraMetadataNative.Key<?> nativeKey) { 139 mKey = (CameraMetadataNative.Key<T>) nativeKey; 140 } 141 } 142 143 private final CameraMetadataNative mResults; 144 private final CaptureRequest mRequest; 145 private final int mSequenceId; 146 private final long mFrameNumber; 147 148 /** 149 * Takes ownership of the passed-in properties object 150 * 151 * <p>For internal use only</p> 152 * @hide 153 */ 154 public CaptureResult(CameraMetadataNative results, CaptureRequest parent, 155 CaptureResultExtras extras) { 156 if (results == null) { 157 throw new IllegalArgumentException("results was null"); 158 } 159 160 if (parent == null) { 161 throw new IllegalArgumentException("parent was null"); 162 } 163 164 if (extras == null) { 165 throw new IllegalArgumentException("extras was null"); 166 } 167 168 mResults = CameraMetadataNative.move(results); 169 if (mResults.isEmpty()) { 170 throw new AssertionError("Results must not be empty"); 171 } 172 mRequest = parent; 173 mSequenceId = extras.getRequestId(); 174 mFrameNumber = extras.getFrameNumber(); 175 } 176 177 /** 178 * Returns a copy of the underlying {@link CameraMetadataNative}. 179 * @hide 180 */ 181 public CameraMetadataNative getNativeCopy() { 182 return new CameraMetadataNative(mResults); 183 } 184 185 /** 186 * Creates a request-less result. 187 * 188 * <p><strong>For testing only.</strong></p> 189 * @hide 190 */ 191 public CaptureResult(CameraMetadataNative results, int sequenceId) { 192 if (results == null) { 193 throw new IllegalArgumentException("results was null"); 194 } 195 196 mResults = CameraMetadataNative.move(results); 197 if (mResults.isEmpty()) { 198 throw new AssertionError("Results must not be empty"); 199 } 200 201 mRequest = null; 202 mSequenceId = sequenceId; 203 mFrameNumber = -1; 204 } 205 206 /** 207 * Get a capture result field value. 208 * 209 * <p>The field definitions can be found in {@link CaptureResult}.</p> 210 * 211 * <p>Querying the value for the same key more than once will return a value 212 * which is equal to the previous queried value.</p> 213 * 214 * @throws IllegalArgumentException if the key was not valid 215 * 216 * @param key The result field to read. 217 * @return The value of that key, or {@code null} if the field is not set. 218 */ 219 public <T> T get(Key<T> key) { 220 T value = mResults.get(key); 221 if (VERBOSE) Log.v(TAG, "#get for Key = " + key.getName() + ", returned value = " + value); 222 return value; 223 } 224 225 /** 226 * {@inheritDoc} 227 * @hide 228 */ 229 @SuppressWarnings("unchecked") 230 @Override 231 protected <T> T getProtected(Key<?> key) { 232 return (T) mResults.get(key); 233 } 234 235 /** 236 * {@inheritDoc} 237 * @hide 238 */ 239 @SuppressWarnings("unchecked") 240 @Override 241 protected Class<Key<?>> getKeyClass() { 242 Object thisClass = Key.class; 243 return (Class<Key<?>>)thisClass; 244 } 245 246 /** 247 * Dumps the native metadata contents to logcat. 248 * 249 * <p>Visibility for testing/debugging only. The results will not 250 * include any synthesized keys, as they are invisible to the native layer.</p> 251 * 252 * @hide 253 */ 254 public void dumpToLog() { 255 mResults.dumpToLog(); 256 } 257 258 /** 259 * {@inheritDoc} 260 */ 261 @Override 262 public List<Key<?>> getKeys() { 263 // Force the javadoc for this function to show up on the CaptureResult page 264 return super.getKeys(); 265 } 266 267 /** 268 * Get the request associated with this result. 269 * 270 * <p>Whenever a request has been fully or partially captured, with 271 * {@link CameraCaptureSession.CaptureCallback#onCaptureCompleted} or 272 * {@link CameraCaptureSession.CaptureCallback#onCaptureProgressed}, the {@code result}'s 273 * {@code getRequest()} will return that {@code request}. 274 * </p> 275 * 276 * <p>For example, 277 * <code><pre>cameraDevice.capture(someRequest, new CaptureCallback() { 278 * {@literal @}Override 279 * void onCaptureCompleted(CaptureRequest myRequest, CaptureResult myResult) { 280 * assert(myResult.getRequest.equals(myRequest) == true); 281 * } 282 * }, null); 283 * </code></pre> 284 * </p> 285 * 286 * @return The request associated with this result. Never {@code null}. 287 */ 288 public CaptureRequest getRequest() { 289 return mRequest; 290 } 291 292 /** 293 * Get the frame number associated with this result. 294 * 295 * <p>Whenever a request has been processed, regardless of failure or success, 296 * it gets a unique frame number assigned to its future result/failure.</p> 297 * 298 * <p>This value monotonically increments, starting with 0, 299 * for every new result or failure; and the scope is the lifetime of the 300 * {@link CameraDevice}.</p> 301 * 302 * @return The frame number 303 */ 304 public long getFrameNumber() { 305 return mFrameNumber; 306 } 307 308 /** 309 * The sequence ID for this failure that was returned by the 310 * {@link CameraCaptureSession#capture} family of functions. 311 * 312 * <p>The sequence ID is a unique monotonically increasing value starting from 0, 313 * incremented every time a new group of requests is submitted to the CameraDevice.</p> 314 * 315 * @return int The ID for the sequence of requests that this capture result is a part of 316 * 317 * @see CameraDevice.CaptureCallback#onCaptureSequenceCompleted 318 * @see CameraDevice.CaptureCallback#onCaptureSequenceAborted 319 */ 320 public int getSequenceId() { 321 return mSequenceId; 322 } 323 324 /*@O~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ 325 * The key entries below this point are generated from metadata 326 * definitions in /system/media/camera/docs. Do not modify by hand or 327 * modify the comment blocks at the start or end. 328 *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/ 329 330 /** 331 * <p>The mode control selects how the image data is converted from the 332 * sensor's native color into linear sRGB color.</p> 333 * <p>When auto-white balance (AWB) is enabled with {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, this 334 * control is overridden by the AWB routine. When AWB is disabled, the 335 * application controls how the color mapping is performed.</p> 336 * <p>We define the expected processing pipeline below. For consistency 337 * across devices, this is always the case with TRANSFORM_MATRIX.</p> 338 * <p>When either FULL or HIGH_QUALITY is used, the camera device may 339 * do additional processing but {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and 340 * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} will still be provided by the 341 * camera device (in the results) and be roughly correct.</p> 342 * <p>Switching to TRANSFORM_MATRIX and using the data provided from 343 * FAST or HIGH_QUALITY will yield a picture with the same white point 344 * as what was produced by the camera device in the earlier frame.</p> 345 * <p>The expected processing pipeline is as follows:</p> 346 * <p><img alt="White balance processing pipeline" src="../../../../images/camera2/metadata/android.colorCorrection.mode/processing_pipeline.png" /></p> 347 * <p>The white balance is encoded by two values, a 4-channel white-balance 348 * gain vector (applied in the Bayer domain), and a 3x3 color transform 349 * matrix (applied after demosaic).</p> 350 * <p>The 4-channel white-balance gains are defined as:</p> 351 * <pre><code>{@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} = [ R G_even G_odd B ] 352 * </code></pre> 353 * <p>where <code>G_even</code> is the gain for green pixels on even rows of the 354 * output, and <code>G_odd</code> is the gain for green pixels on the odd rows. 355 * These may be identical for a given camera device implementation; if 356 * the camera device does not support a separate gain for even/odd green 357 * channels, it will use the <code>G_even</code> value, and write <code>G_odd</code> equal to 358 * <code>G_even</code> in the output result metadata.</p> 359 * <p>The matrices for color transforms are defined as a 9-entry vector:</p> 360 * <pre><code>{@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} = [ I0 I1 I2 I3 I4 I5 I6 I7 I8 ] 361 * </code></pre> 362 * <p>which define a transform from input sensor colors, <code>P_in = [ r g b ]</code>, 363 * to output linear sRGB, <code>P_out = [ r' g' b' ]</code>,</p> 364 * <p>with colors as follows:</p> 365 * <pre><code>r' = I0r + I1g + I2b 366 * g' = I3r + I4g + I5b 367 * b' = I6r + I7g + I8b 368 * </code></pre> 369 * <p>Both the input and output value ranges must match. Overflow/underflow 370 * values are clipped to fit within the range.</p> 371 * <p><b>Possible values:</b> 372 * <ul> 373 * <li>{@link #COLOR_CORRECTION_MODE_TRANSFORM_MATRIX TRANSFORM_MATRIX}</li> 374 * <li>{@link #COLOR_CORRECTION_MODE_FAST FAST}</li> 375 * <li>{@link #COLOR_CORRECTION_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 376 * </ul></p> 377 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 378 * <p><b>Full capability</b> - 379 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 380 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 381 * 382 * @see CaptureRequest#COLOR_CORRECTION_GAINS 383 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM 384 * @see CaptureRequest#CONTROL_AWB_MODE 385 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 386 * @see #COLOR_CORRECTION_MODE_TRANSFORM_MATRIX 387 * @see #COLOR_CORRECTION_MODE_FAST 388 * @see #COLOR_CORRECTION_MODE_HIGH_QUALITY 389 */ 390 @PublicKey 391 public static final Key<Integer> COLOR_CORRECTION_MODE = 392 new Key<Integer>("android.colorCorrection.mode", int.class); 393 394 /** 395 * <p>A color transform matrix to use to transform 396 * from sensor RGB color space to output linear sRGB color space.</p> 397 * <p>This matrix is either set by the camera device when the request 398 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not TRANSFORM_MATRIX, or 399 * directly by the application in the request when the 400 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is TRANSFORM_MATRIX.</p> 401 * <p>In the latter case, the camera device may round the matrix to account 402 * for precision issues; the final rounded matrix should be reported back 403 * in this matrix result metadata. The transform should keep the magnitude 404 * of the output color values within <code>[0, 1.0]</code> (assuming input color 405 * values is within the normalized range <code>[0, 1.0]</code>), or clipping may occur.</p> 406 * <p><b>Units</b>: Unitless scale factors</p> 407 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 408 * <p><b>Full capability</b> - 409 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 410 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 411 * 412 * @see CaptureRequest#COLOR_CORRECTION_MODE 413 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 414 */ 415 @PublicKey 416 public static final Key<android.hardware.camera2.params.ColorSpaceTransform> COLOR_CORRECTION_TRANSFORM = 417 new Key<android.hardware.camera2.params.ColorSpaceTransform>("android.colorCorrection.transform", android.hardware.camera2.params.ColorSpaceTransform.class); 418 419 /** 420 * <p>Gains applying to Bayer raw color channels for 421 * white-balance.</p> 422 * <p>These per-channel gains are either set by the camera device 423 * when the request {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not 424 * TRANSFORM_MATRIX, or directly by the application in the 425 * request when the {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is 426 * TRANSFORM_MATRIX.</p> 427 * <p>The gains in the result metadata are the gains actually 428 * applied by the camera device to the current frame.</p> 429 * <p><b>Units</b>: Unitless gain factors</p> 430 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 431 * <p><b>Full capability</b> - 432 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 433 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 434 * 435 * @see CaptureRequest#COLOR_CORRECTION_MODE 436 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 437 */ 438 @PublicKey 439 public static final Key<android.hardware.camera2.params.RggbChannelVector> COLOR_CORRECTION_GAINS = 440 new Key<android.hardware.camera2.params.RggbChannelVector>("android.colorCorrection.gains", android.hardware.camera2.params.RggbChannelVector.class); 441 442 /** 443 * <p>Mode of operation for the chromatic aberration correction algorithm.</p> 444 * <p>Chromatic (color) aberration is caused by the fact that different wavelengths of light 445 * can not focus on the same point after exiting from the lens. This metadata defines 446 * the high level control of chromatic aberration correction algorithm, which aims to 447 * minimize the chromatic artifacts that may occur along the object boundaries in an 448 * image.</p> 449 * <p>FAST/HIGH_QUALITY both mean that camera device determined aberration 450 * correction will be applied. HIGH_QUALITY mode indicates that the camera device will 451 * use the highest-quality aberration correction algorithms, even if it slows down 452 * capture rate. FAST means the camera device will not slow down capture rate when 453 * applying aberration correction.</p> 454 * <p>LEGACY devices will always be in FAST mode.</p> 455 * <p><b>Possible values:</b> 456 * <ul> 457 * <li>{@link #COLOR_CORRECTION_ABERRATION_MODE_OFF OFF}</li> 458 * <li>{@link #COLOR_CORRECTION_ABERRATION_MODE_FAST FAST}</li> 459 * <li>{@link #COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 460 * </ul></p> 461 * <p><b>Available values for this device:</b><br> 462 * {@link CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES android.colorCorrection.availableAberrationModes}</p> 463 * <p>This key is available on all devices.</p> 464 * 465 * @see CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES 466 * @see #COLOR_CORRECTION_ABERRATION_MODE_OFF 467 * @see #COLOR_CORRECTION_ABERRATION_MODE_FAST 468 * @see #COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY 469 */ 470 @PublicKey 471 public static final Key<Integer> COLOR_CORRECTION_ABERRATION_MODE = 472 new Key<Integer>("android.colorCorrection.aberrationMode", int.class); 473 474 /** 475 * <p>The desired setting for the camera device's auto-exposure 476 * algorithm's antibanding compensation.</p> 477 * <p>Some kinds of lighting fixtures, such as some fluorescent 478 * lights, flicker at the rate of the power supply frequency 479 * (60Hz or 50Hz, depending on country). While this is 480 * typically not noticeable to a person, it can be visible to 481 * a camera device. If a camera sets its exposure time to the 482 * wrong value, the flicker may become visible in the 483 * viewfinder as flicker or in a final captured image, as a 484 * set of variable-brightness bands across the image.</p> 485 * <p>Therefore, the auto-exposure routines of camera devices 486 * include antibanding routines that ensure that the chosen 487 * exposure value will not cause such banding. The choice of 488 * exposure time depends on the rate of flicker, which the 489 * camera device can detect automatically, or the expected 490 * rate can be selected by the application using this 491 * control.</p> 492 * <p>A given camera device may not support all of the possible 493 * options for the antibanding mode. The 494 * {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES android.control.aeAvailableAntibandingModes} key contains 495 * the available modes for a given camera device.</p> 496 * <p>AUTO mode is the default if it is available on given 497 * camera device. When AUTO mode is not available, the 498 * default will be either 50HZ or 60HZ, and both 50HZ 499 * and 60HZ will be available.</p> 500 * <p>If manual exposure control is enabled (by setting 501 * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link CaptureRequest#CONTROL_MODE android.control.mode} to OFF), 502 * then this setting has no effect, and the application must 503 * ensure it selects exposure times that do not cause banding 504 * issues. The {@link CaptureResult#STATISTICS_SCENE_FLICKER android.statistics.sceneFlicker} key can assist 505 * the application in this.</p> 506 * <p><b>Possible values:</b> 507 * <ul> 508 * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_OFF OFF}</li> 509 * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_50HZ 50HZ}</li> 510 * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_60HZ 60HZ}</li> 511 * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_AUTO AUTO}</li> 512 * </ul></p> 513 * <p><b>Available values for this device:</b><br></p> 514 * <p>{@link CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES android.control.aeAvailableAntibandingModes}</p> 515 * <p>This key is available on all devices.</p> 516 * 517 * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES 518 * @see CaptureRequest#CONTROL_AE_MODE 519 * @see CaptureRequest#CONTROL_MODE 520 * @see CaptureResult#STATISTICS_SCENE_FLICKER 521 * @see #CONTROL_AE_ANTIBANDING_MODE_OFF 522 * @see #CONTROL_AE_ANTIBANDING_MODE_50HZ 523 * @see #CONTROL_AE_ANTIBANDING_MODE_60HZ 524 * @see #CONTROL_AE_ANTIBANDING_MODE_AUTO 525 */ 526 @PublicKey 527 public static final Key<Integer> CONTROL_AE_ANTIBANDING_MODE = 528 new Key<Integer>("android.control.aeAntibandingMode", int.class); 529 530 /** 531 * <p>Adjustment to auto-exposure (AE) target image 532 * brightness.</p> 533 * <p>The adjustment is measured as a count of steps, with the 534 * step size defined by {@link CameraCharacteristics#CONTROL_AE_COMPENSATION_STEP android.control.aeCompensationStep} and the 535 * allowed range by {@link CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE android.control.aeCompensationRange}.</p> 536 * <p>For example, if the exposure value (EV) step is 0.333, '6' 537 * will mean an exposure compensation of +2 EV; -3 will mean an 538 * exposure compensation of -1 EV. One EV represents a doubling 539 * of image brightness. Note that this control will only be 540 * effective if {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} <code>!=</code> OFF. This control 541 * will take effect even when {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} <code>== true</code>.</p> 542 * <p>In the event of exposure compensation value being changed, camera device 543 * may take several frames to reach the newly requested exposure target. 544 * During that time, {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} field will be in the SEARCHING 545 * state. Once the new exposure target is reached, {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} will 546 * change from SEARCHING to either CONVERGED, LOCKED (if AE lock is enabled), or 547 * FLASH_REQUIRED (if the scene is too dark for still capture).</p> 548 * <p><b>Units</b>: Compensation steps</p> 549 * <p><b>Range of valid values:</b><br> 550 * {@link CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE android.control.aeCompensationRange}</p> 551 * <p>This key is available on all devices.</p> 552 * 553 * @see CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE 554 * @see CameraCharacteristics#CONTROL_AE_COMPENSATION_STEP 555 * @see CaptureRequest#CONTROL_AE_LOCK 556 * @see CaptureRequest#CONTROL_AE_MODE 557 * @see CaptureResult#CONTROL_AE_STATE 558 */ 559 @PublicKey 560 public static final Key<Integer> CONTROL_AE_EXPOSURE_COMPENSATION = 561 new Key<Integer>("android.control.aeExposureCompensation", int.class); 562 563 /** 564 * <p>Whether auto-exposure (AE) is currently locked to its latest 565 * calculated values.</p> 566 * <p>When set to <code>true</code> (ON), the AE algorithm is locked to its latest parameters, 567 * and will not change exposure settings until the lock is set to <code>false</code> (OFF).</p> 568 * <p>Note that even when AE is locked, the flash may be fired if 569 * the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_AUTO_FLASH / 570 * ON_ALWAYS_FLASH / ON_AUTO_FLASH_REDEYE.</p> 571 * <p>When {@link CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION android.control.aeExposureCompensation} is changed, even if the AE lock 572 * is ON, the camera device will still adjust its exposure value.</p> 573 * <p>If AE precapture is triggered (see {@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}) 574 * when AE is already locked, the camera device will not change the exposure time 575 * ({@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}) and sensitivity ({@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}) 576 * parameters. The flash may be fired if the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} 577 * is ON_AUTO_FLASH/ON_AUTO_FLASH_REDEYE and the scene is too dark. If the 578 * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_ALWAYS_FLASH, the scene may become overexposed.</p> 579 * <p>Since the camera device has a pipeline of in-flight requests, the settings that 580 * get locked do not necessarily correspond to the settings that were present in the 581 * latest capture result received from the camera device, since additional captures 582 * and AE updates may have occurred even before the result was sent out. If an 583 * application is switching between automatic and manual control and wishes to eliminate 584 * any flicker during the switch, the following procedure is recommended:</p> 585 * <ol> 586 * <li>Starting in auto-AE mode:</li> 587 * <li>Lock AE</li> 588 * <li>Wait for the first result to be output that has the AE locked</li> 589 * <li>Copy exposure settings from that result into a request, set the request to manual AE</li> 590 * <li>Submit the capture request, proceed to run manual AE as desired.</li> 591 * </ol> 592 * <p>See {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE lock related state transition details.</p> 593 * <p>This key is available on all devices.</p> 594 * 595 * @see CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION 596 * @see CaptureRequest#CONTROL_AE_MODE 597 * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER 598 * @see CaptureResult#CONTROL_AE_STATE 599 * @see CaptureRequest#SENSOR_EXPOSURE_TIME 600 * @see CaptureRequest#SENSOR_SENSITIVITY 601 */ 602 @PublicKey 603 public static final Key<Boolean> CONTROL_AE_LOCK = 604 new Key<Boolean>("android.control.aeLock", boolean.class); 605 606 /** 607 * <p>The desired mode for the camera device's 608 * auto-exposure routine.</p> 609 * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is 610 * AUTO.</p> 611 * <p>When set to any of the ON modes, the camera device's 612 * auto-exposure routine is enabled, overriding the 613 * application's selected exposure time, sensor sensitivity, 614 * and frame duration ({@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, 615 * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and 616 * {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}). If one of the FLASH modes 617 * is selected, the camera device's flash unit controls are 618 * also overridden.</p> 619 * <p>The FLASH modes are only available if the camera device 620 * has a flash unit ({@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} is <code>true</code>).</p> 621 * <p>If flash TORCH mode is desired, this field must be set to 622 * ON or OFF, and {@link CaptureRequest#FLASH_MODE android.flash.mode} set to TORCH.</p> 623 * <p>When set to any of the ON modes, the values chosen by the 624 * camera device auto-exposure routine for the overridden 625 * fields for a given capture will be available in its 626 * CaptureResult.</p> 627 * <p><b>Possible values:</b> 628 * <ul> 629 * <li>{@link #CONTROL_AE_MODE_OFF OFF}</li> 630 * <li>{@link #CONTROL_AE_MODE_ON ON}</li> 631 * <li>{@link #CONTROL_AE_MODE_ON_AUTO_FLASH ON_AUTO_FLASH}</li> 632 * <li>{@link #CONTROL_AE_MODE_ON_ALWAYS_FLASH ON_ALWAYS_FLASH}</li> 633 * <li>{@link #CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE ON_AUTO_FLASH_REDEYE}</li> 634 * </ul></p> 635 * <p><b>Available values for this device:</b><br> 636 * {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_MODES android.control.aeAvailableModes}</p> 637 * <p>This key is available on all devices.</p> 638 * 639 * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_MODES 640 * @see CaptureRequest#CONTROL_MODE 641 * @see CameraCharacteristics#FLASH_INFO_AVAILABLE 642 * @see CaptureRequest#FLASH_MODE 643 * @see CaptureRequest#SENSOR_EXPOSURE_TIME 644 * @see CaptureRequest#SENSOR_FRAME_DURATION 645 * @see CaptureRequest#SENSOR_SENSITIVITY 646 * @see #CONTROL_AE_MODE_OFF 647 * @see #CONTROL_AE_MODE_ON 648 * @see #CONTROL_AE_MODE_ON_AUTO_FLASH 649 * @see #CONTROL_AE_MODE_ON_ALWAYS_FLASH 650 * @see #CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE 651 */ 652 @PublicKey 653 public static final Key<Integer> CONTROL_AE_MODE = 654 new Key<Integer>("android.control.aeMode", int.class); 655 656 /** 657 * <p>List of metering areas to use for auto-exposure adjustment.</p> 658 * <p>Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AE android.control.maxRegionsAe} is 0. 659 * Otherwise will always be present.</p> 660 * <p>The maximum number of regions supported by the device is determined by the value 661 * of {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AE android.control.maxRegionsAe}.</p> 662 * <p>The coordinate system is based on the active pixel array, 663 * with (0,0) being the top-left pixel in the active pixel array, and 664 * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 665 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 666 * bottom-right pixel in the active pixel array.</p> 667 * <p>The weight must be within <code>[0, 1000]</code>, and represents a weight 668 * for every pixel in the area. This means that a large metering area 669 * with the same weight as a smaller area will have more effect in 670 * the metering result. Metering areas can partially overlap and the 671 * camera device will add the weights in the overlap region.</p> 672 * <p>The weights are relative to weights of other exposure metering regions, so if only one 673 * region is used, all non-zero weights will have the same effect. A region with 0 674 * weight is ignored.</p> 675 * <p>If all regions have 0 weight, then no specific metering area needs to be used by the 676 * camera device.</p> 677 * <p>If the metering region is outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in 678 * capture result metadata, the camera device will ignore the sections outside the crop 679 * region and output only the intersection rectangle as the metering region in the result 680 * metadata. If the region is entirely outside the crop region, it will be ignored and 681 * not reported in the result metadata.</p> 682 * <p><b>Units</b>: Pixel coordinates within {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 683 * <p><b>Range of valid values:</b><br> 684 * Coordinates must be between <code>[(0,0), (width, height))</code> of 685 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 686 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 687 * 688 * @see CameraCharacteristics#CONTROL_MAX_REGIONS_AE 689 * @see CaptureRequest#SCALER_CROP_REGION 690 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 691 */ 692 @PublicKey 693 public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AE_REGIONS = 694 new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.aeRegions", android.hardware.camera2.params.MeteringRectangle[].class); 695 696 /** 697 * <p>Range over which the auto-exposure routine can 698 * adjust the capture frame rate to maintain good 699 * exposure.</p> 700 * <p>Only constrains auto-exposure (AE) algorithm, not 701 * manual control of {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime} and 702 * {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}.</p> 703 * <p><b>Units</b>: Frames per second (FPS)</p> 704 * <p><b>Range of valid values:</b><br> 705 * Any of the entries in {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES android.control.aeAvailableTargetFpsRanges}</p> 706 * <p>This key is available on all devices.</p> 707 * 708 * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES 709 * @see CaptureRequest#SENSOR_EXPOSURE_TIME 710 * @see CaptureRequest#SENSOR_FRAME_DURATION 711 */ 712 @PublicKey 713 public static final Key<android.util.Range<Integer>> CONTROL_AE_TARGET_FPS_RANGE = 714 new Key<android.util.Range<Integer>>("android.control.aeTargetFpsRange", new TypeReference<android.util.Range<Integer>>() {{ }}); 715 716 /** 717 * <p>Whether the camera device will trigger a precapture 718 * metering sequence when it processes this request.</p> 719 * <p>This entry is normally set to IDLE, or is not 720 * included at all in the request settings. When included and 721 * set to START, the camera device will trigger the autoexposure 722 * precapture metering sequence.</p> 723 * <p>The precapture sequence should triggered before starting a 724 * high-quality still capture for final metering decisions to 725 * be made, and for firing pre-capture flash pulses to estimate 726 * scene brightness and required final capture flash power, when 727 * the flash is enabled.</p> 728 * <p>Normally, this entry should be set to START for only a 729 * single request, and the application should wait until the 730 * sequence completes before starting a new one.</p> 731 * <p>The exact effect of auto-exposure (AE) precapture trigger 732 * depends on the current AE mode and state; see 733 * {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE precapture state transition 734 * details.</p> 735 * <p>On LEGACY-level devices, the precapture trigger is not supported; 736 * capturing a high-resolution JPEG image will automatically trigger a 737 * precapture sequence before the high-resolution capture, including 738 * potentially firing a pre-capture flash.</p> 739 * <p><b>Possible values:</b> 740 * <ul> 741 * <li>{@link #CONTROL_AE_PRECAPTURE_TRIGGER_IDLE IDLE}</li> 742 * <li>{@link #CONTROL_AE_PRECAPTURE_TRIGGER_START START}</li> 743 * </ul></p> 744 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 745 * <p><b>Limited capability</b> - 746 * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the 747 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 748 * 749 * @see CaptureResult#CONTROL_AE_STATE 750 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 751 * @see #CONTROL_AE_PRECAPTURE_TRIGGER_IDLE 752 * @see #CONTROL_AE_PRECAPTURE_TRIGGER_START 753 */ 754 @PublicKey 755 public static final Key<Integer> CONTROL_AE_PRECAPTURE_TRIGGER = 756 new Key<Integer>("android.control.aePrecaptureTrigger", int.class); 757 758 /** 759 * <p>Current state of the auto-exposure (AE) algorithm.</p> 760 * <p>Switching between or enabling AE modes ({@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode}) always 761 * resets the AE state to INACTIVE. Similarly, switching between {@link CaptureRequest#CONTROL_MODE android.control.mode}, 762 * or {@link CaptureRequest#CONTROL_SCENE_MODE android.control.sceneMode} if <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code> resets all 763 * the algorithm states to INACTIVE.</p> 764 * <p>The camera device can do several state transitions between two results, if it is 765 * allowed by the state transition table. For example: INACTIVE may never actually be 766 * seen in a result.</p> 767 * <p>The state in the result is the state for this image (in sync with this image): if 768 * AE state becomes CONVERGED, then the image data associated with this result should 769 * be good to use.</p> 770 * <p>Below are state transition tables for different AE modes.</p> 771 * <table> 772 * <thead> 773 * <tr> 774 * <th align="center">State</th> 775 * <th align="center">Transition Cause</th> 776 * <th align="center">New State</th> 777 * <th align="center">Notes</th> 778 * </tr> 779 * </thead> 780 * <tbody> 781 * <tr> 782 * <td align="center">INACTIVE</td> 783 * <td align="center"></td> 784 * <td align="center">INACTIVE</td> 785 * <td align="center">Camera device auto exposure algorithm is disabled</td> 786 * </tr> 787 * </tbody> 788 * </table> 789 * <p>When {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is AE_MODE_ON_*:</p> 790 * <table> 791 * <thead> 792 * <tr> 793 * <th align="center">State</th> 794 * <th align="center">Transition Cause</th> 795 * <th align="center">New State</th> 796 * <th align="center">Notes</th> 797 * </tr> 798 * </thead> 799 * <tbody> 800 * <tr> 801 * <td align="center">INACTIVE</td> 802 * <td align="center">Camera device initiates AE scan</td> 803 * <td align="center">SEARCHING</td> 804 * <td align="center">Values changing</td> 805 * </tr> 806 * <tr> 807 * <td align="center">INACTIVE</td> 808 * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON</td> 809 * <td align="center">LOCKED</td> 810 * <td align="center">Values locked</td> 811 * </tr> 812 * <tr> 813 * <td align="center">SEARCHING</td> 814 * <td align="center">Camera device finishes AE scan</td> 815 * <td align="center">CONVERGED</td> 816 * <td align="center">Good values, not changing</td> 817 * </tr> 818 * <tr> 819 * <td align="center">SEARCHING</td> 820 * <td align="center">Camera device finishes AE scan</td> 821 * <td align="center">FLASH_REQUIRED</td> 822 * <td align="center">Converged but too dark w/o flash</td> 823 * </tr> 824 * <tr> 825 * <td align="center">SEARCHING</td> 826 * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON</td> 827 * <td align="center">LOCKED</td> 828 * <td align="center">Values locked</td> 829 * </tr> 830 * <tr> 831 * <td align="center">CONVERGED</td> 832 * <td align="center">Camera device initiates AE scan</td> 833 * <td align="center">SEARCHING</td> 834 * <td align="center">Values changing</td> 835 * </tr> 836 * <tr> 837 * <td align="center">CONVERGED</td> 838 * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON</td> 839 * <td align="center">LOCKED</td> 840 * <td align="center">Values locked</td> 841 * </tr> 842 * <tr> 843 * <td align="center">FLASH_REQUIRED</td> 844 * <td align="center">Camera device initiates AE scan</td> 845 * <td align="center">SEARCHING</td> 846 * <td align="center">Values changing</td> 847 * </tr> 848 * <tr> 849 * <td align="center">FLASH_REQUIRED</td> 850 * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON</td> 851 * <td align="center">LOCKED</td> 852 * <td align="center">Values locked</td> 853 * </tr> 854 * <tr> 855 * <td align="center">LOCKED</td> 856 * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFF</td> 857 * <td align="center">SEARCHING</td> 858 * <td align="center">Values not good after unlock</td> 859 * </tr> 860 * <tr> 861 * <td align="center">LOCKED</td> 862 * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFF</td> 863 * <td align="center">CONVERGED</td> 864 * <td align="center">Values good after unlock</td> 865 * </tr> 866 * <tr> 867 * <td align="center">LOCKED</td> 868 * <td align="center">{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFF</td> 869 * <td align="center">FLASH_REQUIRED</td> 870 * <td align="center">Exposure good, but too dark</td> 871 * </tr> 872 * <tr> 873 * <td align="center">PRECAPTURE</td> 874 * <td align="center">Sequence done. {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is OFF</td> 875 * <td align="center">CONVERGED</td> 876 * <td align="center">Ready for high-quality capture</td> 877 * </tr> 878 * <tr> 879 * <td align="center">PRECAPTURE</td> 880 * <td align="center">Sequence done. {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} is ON</td> 881 * <td align="center">LOCKED</td> 882 * <td align="center">Ready for high-quality capture</td> 883 * </tr> 884 * <tr> 885 * <td align="center">Any state</td> 886 * <td align="center">{@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger} is START</td> 887 * <td align="center">PRECAPTURE</td> 888 * <td align="center">Start AE precapture metering sequence</td> 889 * </tr> 890 * </tbody> 891 * </table> 892 * <p>For the above table, the camera device may skip reporting any state changes that happen 893 * without application intervention (i.e. mode switch, trigger, locking). Any state that 894 * can be skipped in that manner is called a transient state.</p> 895 * <p>For example, for above AE modes (AE_MODE_ON_*), in addition to the state transitions 896 * listed in above table, it is also legal for the camera device to skip one or more 897 * transient states between two results. See below table for examples:</p> 898 * <table> 899 * <thead> 900 * <tr> 901 * <th align="center">State</th> 902 * <th align="center">Transition Cause</th> 903 * <th align="center">New State</th> 904 * <th align="center">Notes</th> 905 * </tr> 906 * </thead> 907 * <tbody> 908 * <tr> 909 * <td align="center">INACTIVE</td> 910 * <td align="center">Camera device finished AE scan</td> 911 * <td align="center">CONVERGED</td> 912 * <td align="center">Values are already good, transient states are skipped by camera device.</td> 913 * </tr> 914 * <tr> 915 * <td align="center">Any state</td> 916 * <td align="center">{@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger} is START, sequence done</td> 917 * <td align="center">FLASH_REQUIRED</td> 918 * <td align="center">Converged but too dark w/o flash after a precapture sequence, transient states are skipped by camera device.</td> 919 * </tr> 920 * <tr> 921 * <td align="center">Any state</td> 922 * <td align="center">{@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger} is START, sequence done</td> 923 * <td align="center">CONVERGED</td> 924 * <td align="center">Converged after a precapture sequence, transient states are skipped by camera device.</td> 925 * </tr> 926 * <tr> 927 * <td align="center">CONVERGED</td> 928 * <td align="center">Camera device finished AE scan</td> 929 * <td align="center">FLASH_REQUIRED</td> 930 * <td align="center">Converged but too dark w/o flash after a new scan, transient states are skipped by camera device.</td> 931 * </tr> 932 * <tr> 933 * <td align="center">FLASH_REQUIRED</td> 934 * <td align="center">Camera device finished AE scan</td> 935 * <td align="center">CONVERGED</td> 936 * <td align="center">Converged after a new scan, transient states are skipped by camera device.</td> 937 * </tr> 938 * </tbody> 939 * </table> 940 * <p><b>Possible values:</b> 941 * <ul> 942 * <li>{@link #CONTROL_AE_STATE_INACTIVE INACTIVE}</li> 943 * <li>{@link #CONTROL_AE_STATE_SEARCHING SEARCHING}</li> 944 * <li>{@link #CONTROL_AE_STATE_CONVERGED CONVERGED}</li> 945 * <li>{@link #CONTROL_AE_STATE_LOCKED LOCKED}</li> 946 * <li>{@link #CONTROL_AE_STATE_FLASH_REQUIRED FLASH_REQUIRED}</li> 947 * <li>{@link #CONTROL_AE_STATE_PRECAPTURE PRECAPTURE}</li> 948 * </ul></p> 949 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 950 * <p><b>Limited capability</b> - 951 * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the 952 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 953 * 954 * @see CaptureRequest#CONTROL_AE_LOCK 955 * @see CaptureRequest#CONTROL_AE_MODE 956 * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER 957 * @see CaptureRequest#CONTROL_MODE 958 * @see CaptureRequest#CONTROL_SCENE_MODE 959 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 960 * @see #CONTROL_AE_STATE_INACTIVE 961 * @see #CONTROL_AE_STATE_SEARCHING 962 * @see #CONTROL_AE_STATE_CONVERGED 963 * @see #CONTROL_AE_STATE_LOCKED 964 * @see #CONTROL_AE_STATE_FLASH_REQUIRED 965 * @see #CONTROL_AE_STATE_PRECAPTURE 966 */ 967 @PublicKey 968 public static final Key<Integer> CONTROL_AE_STATE = 969 new Key<Integer>("android.control.aeState", int.class); 970 971 /** 972 * <p>Whether auto-focus (AF) is currently enabled, and what 973 * mode it is set to.</p> 974 * <p>Only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} = AUTO and the lens is not fixed focus 975 * (i.e. <code>{@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} > 0</code>). Also note that 976 * when {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is OFF, the behavior of AF is device 977 * dependent. It is recommended to lock AF by using {@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger} before 978 * setting {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} to OFF, or set AF mode to OFF when AE is OFF.</p> 979 * <p>If the lens is controlled by the camera device auto-focus algorithm, 980 * the camera device will report the current AF status in {@link CaptureResult#CONTROL_AF_STATE android.control.afState} 981 * in result metadata.</p> 982 * <p><b>Possible values:</b> 983 * <ul> 984 * <li>{@link #CONTROL_AF_MODE_OFF OFF}</li> 985 * <li>{@link #CONTROL_AF_MODE_AUTO AUTO}</li> 986 * <li>{@link #CONTROL_AF_MODE_MACRO MACRO}</li> 987 * <li>{@link #CONTROL_AF_MODE_CONTINUOUS_VIDEO CONTINUOUS_VIDEO}</li> 988 * <li>{@link #CONTROL_AF_MODE_CONTINUOUS_PICTURE CONTINUOUS_PICTURE}</li> 989 * <li>{@link #CONTROL_AF_MODE_EDOF EDOF}</li> 990 * </ul></p> 991 * <p><b>Available values for this device:</b><br> 992 * {@link CameraCharacteristics#CONTROL_AF_AVAILABLE_MODES android.control.afAvailableModes}</p> 993 * <p>This key is available on all devices.</p> 994 * 995 * @see CaptureRequest#CONTROL_AE_MODE 996 * @see CameraCharacteristics#CONTROL_AF_AVAILABLE_MODES 997 * @see CaptureResult#CONTROL_AF_STATE 998 * @see CaptureRequest#CONTROL_AF_TRIGGER 999 * @see CaptureRequest#CONTROL_MODE 1000 * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE 1001 * @see #CONTROL_AF_MODE_OFF 1002 * @see #CONTROL_AF_MODE_AUTO 1003 * @see #CONTROL_AF_MODE_MACRO 1004 * @see #CONTROL_AF_MODE_CONTINUOUS_VIDEO 1005 * @see #CONTROL_AF_MODE_CONTINUOUS_PICTURE 1006 * @see #CONTROL_AF_MODE_EDOF 1007 */ 1008 @PublicKey 1009 public static final Key<Integer> CONTROL_AF_MODE = 1010 new Key<Integer>("android.control.afMode", int.class); 1011 1012 /** 1013 * <p>List of metering areas to use for auto-focus.</p> 1014 * <p>Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AF android.control.maxRegionsAf} is 0. 1015 * Otherwise will always be present.</p> 1016 * <p>The maximum number of focus areas supported by the device is determined by the value 1017 * of {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AF android.control.maxRegionsAf}.</p> 1018 * <p>The coordinate system is based on the active pixel array, 1019 * with (0,0) being the top-left pixel in the active pixel array, and 1020 * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 1021 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 1022 * bottom-right pixel in the active pixel array.</p> 1023 * <p>The weight must be within <code>[0, 1000]</code>, and represents a weight 1024 * for every pixel in the area. This means that a large metering area 1025 * with the same weight as a smaller area will have more effect in 1026 * the metering result. Metering areas can partially overlap and the 1027 * camera device will add the weights in the overlap region.</p> 1028 * <p>The weights are relative to weights of other metering regions, so if only one region 1029 * is used, all non-zero weights will have the same effect. A region with 0 weight is 1030 * ignored.</p> 1031 * <p>If all regions have 0 weight, then no specific metering area needs to be used by the 1032 * camera device.</p> 1033 * <p>If the metering region is outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in 1034 * capture result metadata, the camera device will ignore the sections outside the crop 1035 * region and output only the intersection rectangle as the metering region in the result 1036 * metadata. If the region is entirely outside the crop region, it will be ignored and 1037 * not reported in the result metadata.</p> 1038 * <p><b>Units</b>: Pixel coordinates within {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 1039 * <p><b>Range of valid values:</b><br> 1040 * Coordinates must be between <code>[(0,0), (width, height))</code> of 1041 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 1042 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1043 * 1044 * @see CameraCharacteristics#CONTROL_MAX_REGIONS_AF 1045 * @see CaptureRequest#SCALER_CROP_REGION 1046 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 1047 */ 1048 @PublicKey 1049 public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AF_REGIONS = 1050 new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.afRegions", android.hardware.camera2.params.MeteringRectangle[].class); 1051 1052 /** 1053 * <p>Whether the camera device will trigger autofocus for this request.</p> 1054 * <p>This entry is normally set to IDLE, or is not 1055 * included at all in the request settings.</p> 1056 * <p>When included and set to START, the camera device will trigger the 1057 * autofocus algorithm. If autofocus is disabled, this trigger has no effect.</p> 1058 * <p>When set to CANCEL, the camera device will cancel any active trigger, 1059 * and return to its initial AF state.</p> 1060 * <p>Generally, applications should set this entry to START or CANCEL for only a 1061 * single capture, and then return it to IDLE (or not set at all). Specifying 1062 * START for multiple captures in a row means restarting the AF operation over 1063 * and over again.</p> 1064 * <p>See {@link CaptureResult#CONTROL_AF_STATE android.control.afState} for what the trigger means for each AF mode.</p> 1065 * <p><b>Possible values:</b> 1066 * <ul> 1067 * <li>{@link #CONTROL_AF_TRIGGER_IDLE IDLE}</li> 1068 * <li>{@link #CONTROL_AF_TRIGGER_START START}</li> 1069 * <li>{@link #CONTROL_AF_TRIGGER_CANCEL CANCEL}</li> 1070 * </ul></p> 1071 * <p>This key is available on all devices.</p> 1072 * 1073 * @see CaptureResult#CONTROL_AF_STATE 1074 * @see #CONTROL_AF_TRIGGER_IDLE 1075 * @see #CONTROL_AF_TRIGGER_START 1076 * @see #CONTROL_AF_TRIGGER_CANCEL 1077 */ 1078 @PublicKey 1079 public static final Key<Integer> CONTROL_AF_TRIGGER = 1080 new Key<Integer>("android.control.afTrigger", int.class); 1081 1082 /** 1083 * <p>Current state of auto-focus (AF) algorithm.</p> 1084 * <p>Switching between or enabling AF modes ({@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}) always 1085 * resets the AF state to INACTIVE. Similarly, switching between {@link CaptureRequest#CONTROL_MODE android.control.mode}, 1086 * or {@link CaptureRequest#CONTROL_SCENE_MODE android.control.sceneMode} if <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code> resets all 1087 * the algorithm states to INACTIVE.</p> 1088 * <p>The camera device can do several state transitions between two results, if it is 1089 * allowed by the state transition table. For example: INACTIVE may never actually be 1090 * seen in a result.</p> 1091 * <p>The state in the result is the state for this image (in sync with this image): if 1092 * AF state becomes FOCUSED, then the image data associated with this result should 1093 * be sharp.</p> 1094 * <p>Below are state transition tables for different AF modes.</p> 1095 * <p>When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_OFF or AF_MODE_EDOF:</p> 1096 * <table> 1097 * <thead> 1098 * <tr> 1099 * <th align="center">State</th> 1100 * <th align="center">Transition Cause</th> 1101 * <th align="center">New State</th> 1102 * <th align="center">Notes</th> 1103 * </tr> 1104 * </thead> 1105 * <tbody> 1106 * <tr> 1107 * <td align="center">INACTIVE</td> 1108 * <td align="center"></td> 1109 * <td align="center">INACTIVE</td> 1110 * <td align="center">Never changes</td> 1111 * </tr> 1112 * </tbody> 1113 * </table> 1114 * <p>When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_AUTO or AF_MODE_MACRO:</p> 1115 * <table> 1116 * <thead> 1117 * <tr> 1118 * <th align="center">State</th> 1119 * <th align="center">Transition Cause</th> 1120 * <th align="center">New State</th> 1121 * <th align="center">Notes</th> 1122 * </tr> 1123 * </thead> 1124 * <tbody> 1125 * <tr> 1126 * <td align="center">INACTIVE</td> 1127 * <td align="center">AF_TRIGGER</td> 1128 * <td align="center">ACTIVE_SCAN</td> 1129 * <td align="center">Start AF sweep, Lens now moving</td> 1130 * </tr> 1131 * <tr> 1132 * <td align="center">ACTIVE_SCAN</td> 1133 * <td align="center">AF sweep done</td> 1134 * <td align="center">FOCUSED_LOCKED</td> 1135 * <td align="center">Focused, Lens now locked</td> 1136 * </tr> 1137 * <tr> 1138 * <td align="center">ACTIVE_SCAN</td> 1139 * <td align="center">AF sweep done</td> 1140 * <td align="center">NOT_FOCUSED_LOCKED</td> 1141 * <td align="center">Not focused, Lens now locked</td> 1142 * </tr> 1143 * <tr> 1144 * <td align="center">ACTIVE_SCAN</td> 1145 * <td align="center">AF_CANCEL</td> 1146 * <td align="center">INACTIVE</td> 1147 * <td align="center">Cancel/reset AF, Lens now locked</td> 1148 * </tr> 1149 * <tr> 1150 * <td align="center">FOCUSED_LOCKED</td> 1151 * <td align="center">AF_CANCEL</td> 1152 * <td align="center">INACTIVE</td> 1153 * <td align="center">Cancel/reset AF</td> 1154 * </tr> 1155 * <tr> 1156 * <td align="center">FOCUSED_LOCKED</td> 1157 * <td align="center">AF_TRIGGER</td> 1158 * <td align="center">ACTIVE_SCAN</td> 1159 * <td align="center">Start new sweep, Lens now moving</td> 1160 * </tr> 1161 * <tr> 1162 * <td align="center">NOT_FOCUSED_LOCKED</td> 1163 * <td align="center">AF_CANCEL</td> 1164 * <td align="center">INACTIVE</td> 1165 * <td align="center">Cancel/reset AF</td> 1166 * </tr> 1167 * <tr> 1168 * <td align="center">NOT_FOCUSED_LOCKED</td> 1169 * <td align="center">AF_TRIGGER</td> 1170 * <td align="center">ACTIVE_SCAN</td> 1171 * <td align="center">Start new sweep, Lens now moving</td> 1172 * </tr> 1173 * <tr> 1174 * <td align="center">Any state</td> 1175 * <td align="center">Mode change</td> 1176 * <td align="center">INACTIVE</td> 1177 * <td align="center"></td> 1178 * </tr> 1179 * </tbody> 1180 * </table> 1181 * <p>For the above table, the camera device may skip reporting any state changes that happen 1182 * without application intervention (i.e. mode switch, trigger, locking). Any state that 1183 * can be skipped in that manner is called a transient state.</p> 1184 * <p>For example, for these AF modes (AF_MODE_AUTO and AF_MODE_MACRO), in addition to the 1185 * state transitions listed in above table, it is also legal for the camera device to skip 1186 * one or more transient states between two results. See below table for examples:</p> 1187 * <table> 1188 * <thead> 1189 * <tr> 1190 * <th align="center">State</th> 1191 * <th align="center">Transition Cause</th> 1192 * <th align="center">New State</th> 1193 * <th align="center">Notes</th> 1194 * </tr> 1195 * </thead> 1196 * <tbody> 1197 * <tr> 1198 * <td align="center">INACTIVE</td> 1199 * <td align="center">AF_TRIGGER</td> 1200 * <td align="center">FOCUSED_LOCKED</td> 1201 * <td align="center">Focus is already good or good after a scan, lens is now locked.</td> 1202 * </tr> 1203 * <tr> 1204 * <td align="center">INACTIVE</td> 1205 * <td align="center">AF_TRIGGER</td> 1206 * <td align="center">NOT_FOCUSED_LOCKED</td> 1207 * <td align="center">Focus failed after a scan, lens is now locked.</td> 1208 * </tr> 1209 * <tr> 1210 * <td align="center">FOCUSED_LOCKED</td> 1211 * <td align="center">AF_TRIGGER</td> 1212 * <td align="center">FOCUSED_LOCKED</td> 1213 * <td align="center">Focus is already good or good after a scan, lens is now locked.</td> 1214 * </tr> 1215 * <tr> 1216 * <td align="center">NOT_FOCUSED_LOCKED</td> 1217 * <td align="center">AF_TRIGGER</td> 1218 * <td align="center">FOCUSED_LOCKED</td> 1219 * <td align="center">Focus is good after a scan, lens is not locked.</td> 1220 * </tr> 1221 * </tbody> 1222 * </table> 1223 * <p>When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_CONTINUOUS_VIDEO:</p> 1224 * <table> 1225 * <thead> 1226 * <tr> 1227 * <th align="center">State</th> 1228 * <th align="center">Transition Cause</th> 1229 * <th align="center">New State</th> 1230 * <th align="center">Notes</th> 1231 * </tr> 1232 * </thead> 1233 * <tbody> 1234 * <tr> 1235 * <td align="center">INACTIVE</td> 1236 * <td align="center">Camera device initiates new scan</td> 1237 * <td align="center">PASSIVE_SCAN</td> 1238 * <td align="center">Start AF scan, Lens now moving</td> 1239 * </tr> 1240 * <tr> 1241 * <td align="center">INACTIVE</td> 1242 * <td align="center">AF_TRIGGER</td> 1243 * <td align="center">NOT_FOCUSED_LOCKED</td> 1244 * <td align="center">AF state query, Lens now locked</td> 1245 * </tr> 1246 * <tr> 1247 * <td align="center">PASSIVE_SCAN</td> 1248 * <td align="center">Camera device completes current scan</td> 1249 * <td align="center">PASSIVE_FOCUSED</td> 1250 * <td align="center">End AF scan, Lens now locked</td> 1251 * </tr> 1252 * <tr> 1253 * <td align="center">PASSIVE_SCAN</td> 1254 * <td align="center">Camera device fails current scan</td> 1255 * <td align="center">PASSIVE_UNFOCUSED</td> 1256 * <td align="center">End AF scan, Lens now locked</td> 1257 * </tr> 1258 * <tr> 1259 * <td align="center">PASSIVE_SCAN</td> 1260 * <td align="center">AF_TRIGGER</td> 1261 * <td align="center">FOCUSED_LOCKED</td> 1262 * <td align="center">Immediate transition, if focus is good. Lens now locked</td> 1263 * </tr> 1264 * <tr> 1265 * <td align="center">PASSIVE_SCAN</td> 1266 * <td align="center">AF_TRIGGER</td> 1267 * <td align="center">NOT_FOCUSED_LOCKED</td> 1268 * <td align="center">Immediate transition, if focus is bad. Lens now locked</td> 1269 * </tr> 1270 * <tr> 1271 * <td align="center">PASSIVE_SCAN</td> 1272 * <td align="center">AF_CANCEL</td> 1273 * <td align="center">INACTIVE</td> 1274 * <td align="center">Reset lens position, Lens now locked</td> 1275 * </tr> 1276 * <tr> 1277 * <td align="center">PASSIVE_FOCUSED</td> 1278 * <td align="center">Camera device initiates new scan</td> 1279 * <td align="center">PASSIVE_SCAN</td> 1280 * <td align="center">Start AF scan, Lens now moving</td> 1281 * </tr> 1282 * <tr> 1283 * <td align="center">PASSIVE_UNFOCUSED</td> 1284 * <td align="center">Camera device initiates new scan</td> 1285 * <td align="center">PASSIVE_SCAN</td> 1286 * <td align="center">Start AF scan, Lens now moving</td> 1287 * </tr> 1288 * <tr> 1289 * <td align="center">PASSIVE_FOCUSED</td> 1290 * <td align="center">AF_TRIGGER</td> 1291 * <td align="center">FOCUSED_LOCKED</td> 1292 * <td align="center">Immediate transition, lens now locked</td> 1293 * </tr> 1294 * <tr> 1295 * <td align="center">PASSIVE_UNFOCUSED</td> 1296 * <td align="center">AF_TRIGGER</td> 1297 * <td align="center">NOT_FOCUSED_LOCKED</td> 1298 * <td align="center">Immediate transition, lens now locked</td> 1299 * </tr> 1300 * <tr> 1301 * <td align="center">FOCUSED_LOCKED</td> 1302 * <td align="center">AF_TRIGGER</td> 1303 * <td align="center">FOCUSED_LOCKED</td> 1304 * <td align="center">No effect</td> 1305 * </tr> 1306 * <tr> 1307 * <td align="center">FOCUSED_LOCKED</td> 1308 * <td align="center">AF_CANCEL</td> 1309 * <td align="center">INACTIVE</td> 1310 * <td align="center">Restart AF scan</td> 1311 * </tr> 1312 * <tr> 1313 * <td align="center">NOT_FOCUSED_LOCKED</td> 1314 * <td align="center">AF_TRIGGER</td> 1315 * <td align="center">NOT_FOCUSED_LOCKED</td> 1316 * <td align="center">No effect</td> 1317 * </tr> 1318 * <tr> 1319 * <td align="center">NOT_FOCUSED_LOCKED</td> 1320 * <td align="center">AF_CANCEL</td> 1321 * <td align="center">INACTIVE</td> 1322 * <td align="center">Restart AF scan</td> 1323 * </tr> 1324 * </tbody> 1325 * </table> 1326 * <p>When {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} is AF_MODE_CONTINUOUS_PICTURE:</p> 1327 * <table> 1328 * <thead> 1329 * <tr> 1330 * <th align="center">State</th> 1331 * <th align="center">Transition Cause</th> 1332 * <th align="center">New State</th> 1333 * <th align="center">Notes</th> 1334 * </tr> 1335 * </thead> 1336 * <tbody> 1337 * <tr> 1338 * <td align="center">INACTIVE</td> 1339 * <td align="center">Camera device initiates new scan</td> 1340 * <td align="center">PASSIVE_SCAN</td> 1341 * <td align="center">Start AF scan, Lens now moving</td> 1342 * </tr> 1343 * <tr> 1344 * <td align="center">INACTIVE</td> 1345 * <td align="center">AF_TRIGGER</td> 1346 * <td align="center">NOT_FOCUSED_LOCKED</td> 1347 * <td align="center">AF state query, Lens now locked</td> 1348 * </tr> 1349 * <tr> 1350 * <td align="center">PASSIVE_SCAN</td> 1351 * <td align="center">Camera device completes current scan</td> 1352 * <td align="center">PASSIVE_FOCUSED</td> 1353 * <td align="center">End AF scan, Lens now locked</td> 1354 * </tr> 1355 * <tr> 1356 * <td align="center">PASSIVE_SCAN</td> 1357 * <td align="center">Camera device fails current scan</td> 1358 * <td align="center">PASSIVE_UNFOCUSED</td> 1359 * <td align="center">End AF scan, Lens now locked</td> 1360 * </tr> 1361 * <tr> 1362 * <td align="center">PASSIVE_SCAN</td> 1363 * <td align="center">AF_TRIGGER</td> 1364 * <td align="center">FOCUSED_LOCKED</td> 1365 * <td align="center">Eventual transition once the focus is good. Lens now locked</td> 1366 * </tr> 1367 * <tr> 1368 * <td align="center">PASSIVE_SCAN</td> 1369 * <td align="center">AF_TRIGGER</td> 1370 * <td align="center">NOT_FOCUSED_LOCKED</td> 1371 * <td align="center">Eventual transition if cannot find focus. Lens now locked</td> 1372 * </tr> 1373 * <tr> 1374 * <td align="center">PASSIVE_SCAN</td> 1375 * <td align="center">AF_CANCEL</td> 1376 * <td align="center">INACTIVE</td> 1377 * <td align="center">Reset lens position, Lens now locked</td> 1378 * </tr> 1379 * <tr> 1380 * <td align="center">PASSIVE_FOCUSED</td> 1381 * <td align="center">Camera device initiates new scan</td> 1382 * <td align="center">PASSIVE_SCAN</td> 1383 * <td align="center">Start AF scan, Lens now moving</td> 1384 * </tr> 1385 * <tr> 1386 * <td align="center">PASSIVE_UNFOCUSED</td> 1387 * <td align="center">Camera device initiates new scan</td> 1388 * <td align="center">PASSIVE_SCAN</td> 1389 * <td align="center">Start AF scan, Lens now moving</td> 1390 * </tr> 1391 * <tr> 1392 * <td align="center">PASSIVE_FOCUSED</td> 1393 * <td align="center">AF_TRIGGER</td> 1394 * <td align="center">FOCUSED_LOCKED</td> 1395 * <td align="center">Immediate trans. Lens now locked</td> 1396 * </tr> 1397 * <tr> 1398 * <td align="center">PASSIVE_UNFOCUSED</td> 1399 * <td align="center">AF_TRIGGER</td> 1400 * <td align="center">NOT_FOCUSED_LOCKED</td> 1401 * <td align="center">Immediate trans. Lens now locked</td> 1402 * </tr> 1403 * <tr> 1404 * <td align="center">FOCUSED_LOCKED</td> 1405 * <td align="center">AF_TRIGGER</td> 1406 * <td align="center">FOCUSED_LOCKED</td> 1407 * <td align="center">No effect</td> 1408 * </tr> 1409 * <tr> 1410 * <td align="center">FOCUSED_LOCKED</td> 1411 * <td align="center">AF_CANCEL</td> 1412 * <td align="center">INACTIVE</td> 1413 * <td align="center">Restart AF scan</td> 1414 * </tr> 1415 * <tr> 1416 * <td align="center">NOT_FOCUSED_LOCKED</td> 1417 * <td align="center">AF_TRIGGER</td> 1418 * <td align="center">NOT_FOCUSED_LOCKED</td> 1419 * <td align="center">No effect</td> 1420 * </tr> 1421 * <tr> 1422 * <td align="center">NOT_FOCUSED_LOCKED</td> 1423 * <td align="center">AF_CANCEL</td> 1424 * <td align="center">INACTIVE</td> 1425 * <td align="center">Restart AF scan</td> 1426 * </tr> 1427 * </tbody> 1428 * </table> 1429 * <p>When switch between AF_MODE_CONTINUOUS_* (CAF modes) and AF_MODE_AUTO/AF_MODE_MACRO 1430 * (AUTO modes), the initial INACTIVE or PASSIVE_SCAN states may be skipped by the 1431 * camera device. When a trigger is included in a mode switch request, the trigger 1432 * will be evaluated in the context of the new mode in the request. 1433 * See below table for examples:</p> 1434 * <table> 1435 * <thead> 1436 * <tr> 1437 * <th align="center">State</th> 1438 * <th align="center">Transition Cause</th> 1439 * <th align="center">New State</th> 1440 * <th align="center">Notes</th> 1441 * </tr> 1442 * </thead> 1443 * <tbody> 1444 * <tr> 1445 * <td align="center">any state</td> 1446 * <td align="center">CAF-->AUTO mode switch</td> 1447 * <td align="center">INACTIVE</td> 1448 * <td align="center">Mode switch without trigger, initial state must be INACTIVE</td> 1449 * </tr> 1450 * <tr> 1451 * <td align="center">any state</td> 1452 * <td align="center">CAF-->AUTO mode switch with AF_TRIGGER</td> 1453 * <td align="center">trigger-reachable states from INACTIVE</td> 1454 * <td align="center">Mode switch with trigger, INACTIVE is skipped</td> 1455 * </tr> 1456 * <tr> 1457 * <td align="center">any state</td> 1458 * <td align="center">AUTO-->CAF mode switch</td> 1459 * <td align="center">passively reachable states from INACTIVE</td> 1460 * <td align="center">Mode switch without trigger, passive transient state is skipped</td> 1461 * </tr> 1462 * </tbody> 1463 * </table> 1464 * <p><b>Possible values:</b> 1465 * <ul> 1466 * <li>{@link #CONTROL_AF_STATE_INACTIVE INACTIVE}</li> 1467 * <li>{@link #CONTROL_AF_STATE_PASSIVE_SCAN PASSIVE_SCAN}</li> 1468 * <li>{@link #CONTROL_AF_STATE_PASSIVE_FOCUSED PASSIVE_FOCUSED}</li> 1469 * <li>{@link #CONTROL_AF_STATE_ACTIVE_SCAN ACTIVE_SCAN}</li> 1470 * <li>{@link #CONTROL_AF_STATE_FOCUSED_LOCKED FOCUSED_LOCKED}</li> 1471 * <li>{@link #CONTROL_AF_STATE_NOT_FOCUSED_LOCKED NOT_FOCUSED_LOCKED}</li> 1472 * <li>{@link #CONTROL_AF_STATE_PASSIVE_UNFOCUSED PASSIVE_UNFOCUSED}</li> 1473 * </ul></p> 1474 * <p>This key is available on all devices.</p> 1475 * 1476 * @see CaptureRequest#CONTROL_AF_MODE 1477 * @see CaptureRequest#CONTROL_MODE 1478 * @see CaptureRequest#CONTROL_SCENE_MODE 1479 * @see #CONTROL_AF_STATE_INACTIVE 1480 * @see #CONTROL_AF_STATE_PASSIVE_SCAN 1481 * @see #CONTROL_AF_STATE_PASSIVE_FOCUSED 1482 * @see #CONTROL_AF_STATE_ACTIVE_SCAN 1483 * @see #CONTROL_AF_STATE_FOCUSED_LOCKED 1484 * @see #CONTROL_AF_STATE_NOT_FOCUSED_LOCKED 1485 * @see #CONTROL_AF_STATE_PASSIVE_UNFOCUSED 1486 */ 1487 @PublicKey 1488 public static final Key<Integer> CONTROL_AF_STATE = 1489 new Key<Integer>("android.control.afState", int.class); 1490 1491 /** 1492 * <p>Whether auto-white balance (AWB) is currently locked to its 1493 * latest calculated values.</p> 1494 * <p>When set to <code>true</code> (ON), the AWB algorithm is locked to its latest parameters, 1495 * and will not change color balance settings until the lock is set to <code>false</code> (OFF).</p> 1496 * <p>Since the camera device has a pipeline of in-flight requests, the settings that 1497 * get locked do not necessarily correspond to the settings that were present in the 1498 * latest capture result received from the camera device, since additional captures 1499 * and AWB updates may have occurred even before the result was sent out. If an 1500 * application is switching between automatic and manual control and wishes to eliminate 1501 * any flicker during the switch, the following procedure is recommended:</p> 1502 * <ol> 1503 * <li>Starting in auto-AWB mode:</li> 1504 * <li>Lock AWB</li> 1505 * <li>Wait for the first result to be output that has the AWB locked</li> 1506 * <li>Copy AWB settings from that result into a request, set the request to manual AWB</li> 1507 * <li>Submit the capture request, proceed to run manual AWB as desired.</li> 1508 * </ol> 1509 * <p>Note that AWB lock is only meaningful when 1510 * {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} is in the AUTO mode; in other modes, 1511 * AWB is already fixed to a specific setting.</p> 1512 * <p>Some LEGACY devices may not support ON; the value is then overridden to OFF.</p> 1513 * <p>This key is available on all devices.</p> 1514 * 1515 * @see CaptureRequest#CONTROL_AWB_MODE 1516 */ 1517 @PublicKey 1518 public static final Key<Boolean> CONTROL_AWB_LOCK = 1519 new Key<Boolean>("android.control.awbLock", boolean.class); 1520 1521 /** 1522 * <p>Whether auto-white balance (AWB) is currently setting the color 1523 * transform fields, and what its illumination target 1524 * is.</p> 1525 * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is AUTO.</p> 1526 * <p>When set to the ON mode, the camera device's auto-white balance 1527 * routine is enabled, overriding the application's selected 1528 * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and 1529 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}. Note that when {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} 1530 * is OFF, the behavior of AWB is device dependent. It is recommened to 1531 * also set AWB mode to OFF or lock AWB by using {@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} before 1532 * setting AE mode to OFF.</p> 1533 * <p>When set to the OFF mode, the camera device's auto-white balance 1534 * routine is disabled. The application manually controls the white 1535 * balance by {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} 1536 * and {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.</p> 1537 * <p>When set to any other modes, the camera device's auto-white 1538 * balance routine is disabled. The camera device uses each 1539 * particular illumination target for white balance 1540 * adjustment. The application's values for 1541 * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, 1542 * {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and 1543 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} are ignored.</p> 1544 * <p><b>Possible values:</b> 1545 * <ul> 1546 * <li>{@link #CONTROL_AWB_MODE_OFF OFF}</li> 1547 * <li>{@link #CONTROL_AWB_MODE_AUTO AUTO}</li> 1548 * <li>{@link #CONTROL_AWB_MODE_INCANDESCENT INCANDESCENT}</li> 1549 * <li>{@link #CONTROL_AWB_MODE_FLUORESCENT FLUORESCENT}</li> 1550 * <li>{@link #CONTROL_AWB_MODE_WARM_FLUORESCENT WARM_FLUORESCENT}</li> 1551 * <li>{@link #CONTROL_AWB_MODE_DAYLIGHT DAYLIGHT}</li> 1552 * <li>{@link #CONTROL_AWB_MODE_CLOUDY_DAYLIGHT CLOUDY_DAYLIGHT}</li> 1553 * <li>{@link #CONTROL_AWB_MODE_TWILIGHT TWILIGHT}</li> 1554 * <li>{@link #CONTROL_AWB_MODE_SHADE SHADE}</li> 1555 * </ul></p> 1556 * <p><b>Available values for this device:</b><br> 1557 * {@link CameraCharacteristics#CONTROL_AWB_AVAILABLE_MODES android.control.awbAvailableModes}</p> 1558 * <p>This key is available on all devices.</p> 1559 * 1560 * @see CaptureRequest#COLOR_CORRECTION_GAINS 1561 * @see CaptureRequest#COLOR_CORRECTION_MODE 1562 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM 1563 * @see CaptureRequest#CONTROL_AE_MODE 1564 * @see CameraCharacteristics#CONTROL_AWB_AVAILABLE_MODES 1565 * @see CaptureRequest#CONTROL_AWB_LOCK 1566 * @see CaptureRequest#CONTROL_MODE 1567 * @see #CONTROL_AWB_MODE_OFF 1568 * @see #CONTROL_AWB_MODE_AUTO 1569 * @see #CONTROL_AWB_MODE_INCANDESCENT 1570 * @see #CONTROL_AWB_MODE_FLUORESCENT 1571 * @see #CONTROL_AWB_MODE_WARM_FLUORESCENT 1572 * @see #CONTROL_AWB_MODE_DAYLIGHT 1573 * @see #CONTROL_AWB_MODE_CLOUDY_DAYLIGHT 1574 * @see #CONTROL_AWB_MODE_TWILIGHT 1575 * @see #CONTROL_AWB_MODE_SHADE 1576 */ 1577 @PublicKey 1578 public static final Key<Integer> CONTROL_AWB_MODE = 1579 new Key<Integer>("android.control.awbMode", int.class); 1580 1581 /** 1582 * <p>List of metering areas to use for auto-white-balance illuminant 1583 * estimation.</p> 1584 * <p>Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AWB android.control.maxRegionsAwb} is 0. 1585 * Otherwise will always be present.</p> 1586 * <p>The maximum number of regions supported by the device is determined by the value 1587 * of {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AWB android.control.maxRegionsAwb}.</p> 1588 * <p>The coordinate system is based on the active pixel array, 1589 * with (0,0) being the top-left pixel in the active pixel array, and 1590 * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 1591 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 1592 * bottom-right pixel in the active pixel array.</p> 1593 * <p>The weight must range from 0 to 1000, and represents a weight 1594 * for every pixel in the area. This means that a large metering area 1595 * with the same weight as a smaller area will have more effect in 1596 * the metering result. Metering areas can partially overlap and the 1597 * camera device will add the weights in the overlap region.</p> 1598 * <p>The weights are relative to weights of other white balance metering regions, so if 1599 * only one region is used, all non-zero weights will have the same effect. A region with 1600 * 0 weight is ignored.</p> 1601 * <p>If all regions have 0 weight, then no specific metering area needs to be used by the 1602 * camera device.</p> 1603 * <p>If the metering region is outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in 1604 * capture result metadata, the camera device will ignore the sections outside the crop 1605 * region and output only the intersection rectangle as the metering region in the result 1606 * metadata. If the region is entirely outside the crop region, it will be ignored and 1607 * not reported in the result metadata.</p> 1608 * <p><b>Units</b>: Pixel coordinates within {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 1609 * <p><b>Range of valid values:</b><br> 1610 * Coordinates must be between <code>[(0,0), (width, height))</code> of 1611 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 1612 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1613 * 1614 * @see CameraCharacteristics#CONTROL_MAX_REGIONS_AWB 1615 * @see CaptureRequest#SCALER_CROP_REGION 1616 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 1617 */ 1618 @PublicKey 1619 public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AWB_REGIONS = 1620 new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.awbRegions", android.hardware.camera2.params.MeteringRectangle[].class); 1621 1622 /** 1623 * <p>Information to the camera device 3A (auto-exposure, 1624 * auto-focus, auto-white balance) routines about the purpose 1625 * of this capture, to help the camera device to decide optimal 3A 1626 * strategy.</p> 1627 * <p>This control (except for MANUAL) is only effective if 1628 * <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} != OFF</code> and any 3A routine is active.</p> 1629 * <p>ZERO_SHUTTER_LAG will be supported if {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} 1630 * contains ZSL. MANUAL will be supported if {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} 1631 * contains MANUAL_SENSOR. Other intent values are always supported.</p> 1632 * <p><b>Possible values:</b> 1633 * <ul> 1634 * <li>{@link #CONTROL_CAPTURE_INTENT_CUSTOM CUSTOM}</li> 1635 * <li>{@link #CONTROL_CAPTURE_INTENT_PREVIEW PREVIEW}</li> 1636 * <li>{@link #CONTROL_CAPTURE_INTENT_STILL_CAPTURE STILL_CAPTURE}</li> 1637 * <li>{@link #CONTROL_CAPTURE_INTENT_VIDEO_RECORD VIDEO_RECORD}</li> 1638 * <li>{@link #CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT VIDEO_SNAPSHOT}</li> 1639 * <li>{@link #CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG ZERO_SHUTTER_LAG}</li> 1640 * <li>{@link #CONTROL_CAPTURE_INTENT_MANUAL MANUAL}</li> 1641 * </ul></p> 1642 * <p>This key is available on all devices.</p> 1643 * 1644 * @see CaptureRequest#CONTROL_MODE 1645 * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES 1646 * @see #CONTROL_CAPTURE_INTENT_CUSTOM 1647 * @see #CONTROL_CAPTURE_INTENT_PREVIEW 1648 * @see #CONTROL_CAPTURE_INTENT_STILL_CAPTURE 1649 * @see #CONTROL_CAPTURE_INTENT_VIDEO_RECORD 1650 * @see #CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT 1651 * @see #CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG 1652 * @see #CONTROL_CAPTURE_INTENT_MANUAL 1653 */ 1654 @PublicKey 1655 public static final Key<Integer> CONTROL_CAPTURE_INTENT = 1656 new Key<Integer>("android.control.captureIntent", int.class); 1657 1658 /** 1659 * <p>Current state of auto-white balance (AWB) algorithm.</p> 1660 * <p>Switching between or enabling AWB modes ({@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}) always 1661 * resets the AWB state to INACTIVE. Similarly, switching between {@link CaptureRequest#CONTROL_MODE android.control.mode}, 1662 * or {@link CaptureRequest#CONTROL_SCENE_MODE android.control.sceneMode} if <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code> resets all 1663 * the algorithm states to INACTIVE.</p> 1664 * <p>The camera device can do several state transitions between two results, if it is 1665 * allowed by the state transition table. So INACTIVE may never actually be seen in 1666 * a result.</p> 1667 * <p>The state in the result is the state for this image (in sync with this image): if 1668 * AWB state becomes CONVERGED, then the image data associated with this result should 1669 * be good to use.</p> 1670 * <p>Below are state transition tables for different AWB modes.</p> 1671 * <p>When <code>{@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} != AWB_MODE_AUTO</code>:</p> 1672 * <table> 1673 * <thead> 1674 * <tr> 1675 * <th align="center">State</th> 1676 * <th align="center">Transition Cause</th> 1677 * <th align="center">New State</th> 1678 * <th align="center">Notes</th> 1679 * </tr> 1680 * </thead> 1681 * <tbody> 1682 * <tr> 1683 * <td align="center">INACTIVE</td> 1684 * <td align="center"></td> 1685 * <td align="center">INACTIVE</td> 1686 * <td align="center">Camera device auto white balance algorithm is disabled</td> 1687 * </tr> 1688 * </tbody> 1689 * </table> 1690 * <p>When {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} is AWB_MODE_AUTO:</p> 1691 * <table> 1692 * <thead> 1693 * <tr> 1694 * <th align="center">State</th> 1695 * <th align="center">Transition Cause</th> 1696 * <th align="center">New State</th> 1697 * <th align="center">Notes</th> 1698 * </tr> 1699 * </thead> 1700 * <tbody> 1701 * <tr> 1702 * <td align="center">INACTIVE</td> 1703 * <td align="center">Camera device initiates AWB scan</td> 1704 * <td align="center">SEARCHING</td> 1705 * <td align="center">Values changing</td> 1706 * </tr> 1707 * <tr> 1708 * <td align="center">INACTIVE</td> 1709 * <td align="center">{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is ON</td> 1710 * <td align="center">LOCKED</td> 1711 * <td align="center">Values locked</td> 1712 * </tr> 1713 * <tr> 1714 * <td align="center">SEARCHING</td> 1715 * <td align="center">Camera device finishes AWB scan</td> 1716 * <td align="center">CONVERGED</td> 1717 * <td align="center">Good values, not changing</td> 1718 * </tr> 1719 * <tr> 1720 * <td align="center">SEARCHING</td> 1721 * <td align="center">{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is ON</td> 1722 * <td align="center">LOCKED</td> 1723 * <td align="center">Values locked</td> 1724 * </tr> 1725 * <tr> 1726 * <td align="center">CONVERGED</td> 1727 * <td align="center">Camera device initiates AWB scan</td> 1728 * <td align="center">SEARCHING</td> 1729 * <td align="center">Values changing</td> 1730 * </tr> 1731 * <tr> 1732 * <td align="center">CONVERGED</td> 1733 * <td align="center">{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is ON</td> 1734 * <td align="center">LOCKED</td> 1735 * <td align="center">Values locked</td> 1736 * </tr> 1737 * <tr> 1738 * <td align="center">LOCKED</td> 1739 * <td align="center">{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is OFF</td> 1740 * <td align="center">SEARCHING</td> 1741 * <td align="center">Values not good after unlock</td> 1742 * </tr> 1743 * </tbody> 1744 * </table> 1745 * <p>For the above table, the camera device may skip reporting any state changes that happen 1746 * without application intervention (i.e. mode switch, trigger, locking). Any state that 1747 * can be skipped in that manner is called a transient state.</p> 1748 * <p>For example, for this AWB mode (AWB_MODE_AUTO), in addition to the state transitions 1749 * listed in above table, it is also legal for the camera device to skip one or more 1750 * transient states between two results. See below table for examples:</p> 1751 * <table> 1752 * <thead> 1753 * <tr> 1754 * <th align="center">State</th> 1755 * <th align="center">Transition Cause</th> 1756 * <th align="center">New State</th> 1757 * <th align="center">Notes</th> 1758 * </tr> 1759 * </thead> 1760 * <tbody> 1761 * <tr> 1762 * <td align="center">INACTIVE</td> 1763 * <td align="center">Camera device finished AWB scan</td> 1764 * <td align="center">CONVERGED</td> 1765 * <td align="center">Values are already good, transient states are skipped by camera device.</td> 1766 * </tr> 1767 * <tr> 1768 * <td align="center">LOCKED</td> 1769 * <td align="center">{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} is OFF</td> 1770 * <td align="center">CONVERGED</td> 1771 * <td align="center">Values good after unlock, transient states are skipped by camera device.</td> 1772 * </tr> 1773 * </tbody> 1774 * </table> 1775 * <p><b>Possible values:</b> 1776 * <ul> 1777 * <li>{@link #CONTROL_AWB_STATE_INACTIVE INACTIVE}</li> 1778 * <li>{@link #CONTROL_AWB_STATE_SEARCHING SEARCHING}</li> 1779 * <li>{@link #CONTROL_AWB_STATE_CONVERGED CONVERGED}</li> 1780 * <li>{@link #CONTROL_AWB_STATE_LOCKED LOCKED}</li> 1781 * </ul></p> 1782 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1783 * <p><b>Limited capability</b> - 1784 * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the 1785 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 1786 * 1787 * @see CaptureRequest#CONTROL_AWB_LOCK 1788 * @see CaptureRequest#CONTROL_AWB_MODE 1789 * @see CaptureRequest#CONTROL_MODE 1790 * @see CaptureRequest#CONTROL_SCENE_MODE 1791 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 1792 * @see #CONTROL_AWB_STATE_INACTIVE 1793 * @see #CONTROL_AWB_STATE_SEARCHING 1794 * @see #CONTROL_AWB_STATE_CONVERGED 1795 * @see #CONTROL_AWB_STATE_LOCKED 1796 */ 1797 @PublicKey 1798 public static final Key<Integer> CONTROL_AWB_STATE = 1799 new Key<Integer>("android.control.awbState", int.class); 1800 1801 /** 1802 * <p>A special color effect to apply.</p> 1803 * <p>When this mode is set, a color effect will be applied 1804 * to images produced by the camera device. The interpretation 1805 * and implementation of these color effects is left to the 1806 * implementor of the camera device, and should not be 1807 * depended on to be consistent (or present) across all 1808 * devices.</p> 1809 * <p><b>Possible values:</b> 1810 * <ul> 1811 * <li>{@link #CONTROL_EFFECT_MODE_OFF OFF}</li> 1812 * <li>{@link #CONTROL_EFFECT_MODE_MONO MONO}</li> 1813 * <li>{@link #CONTROL_EFFECT_MODE_NEGATIVE NEGATIVE}</li> 1814 * <li>{@link #CONTROL_EFFECT_MODE_SOLARIZE SOLARIZE}</li> 1815 * <li>{@link #CONTROL_EFFECT_MODE_SEPIA SEPIA}</li> 1816 * <li>{@link #CONTROL_EFFECT_MODE_POSTERIZE POSTERIZE}</li> 1817 * <li>{@link #CONTROL_EFFECT_MODE_WHITEBOARD WHITEBOARD}</li> 1818 * <li>{@link #CONTROL_EFFECT_MODE_BLACKBOARD BLACKBOARD}</li> 1819 * <li>{@link #CONTROL_EFFECT_MODE_AQUA AQUA}</li> 1820 * </ul></p> 1821 * <p><b>Available values for this device:</b><br> 1822 * {@link CameraCharacteristics#CONTROL_AVAILABLE_EFFECTS android.control.availableEffects}</p> 1823 * <p>This key is available on all devices.</p> 1824 * 1825 * @see CameraCharacteristics#CONTROL_AVAILABLE_EFFECTS 1826 * @see #CONTROL_EFFECT_MODE_OFF 1827 * @see #CONTROL_EFFECT_MODE_MONO 1828 * @see #CONTROL_EFFECT_MODE_NEGATIVE 1829 * @see #CONTROL_EFFECT_MODE_SOLARIZE 1830 * @see #CONTROL_EFFECT_MODE_SEPIA 1831 * @see #CONTROL_EFFECT_MODE_POSTERIZE 1832 * @see #CONTROL_EFFECT_MODE_WHITEBOARD 1833 * @see #CONTROL_EFFECT_MODE_BLACKBOARD 1834 * @see #CONTROL_EFFECT_MODE_AQUA 1835 */ 1836 @PublicKey 1837 public static final Key<Integer> CONTROL_EFFECT_MODE = 1838 new Key<Integer>("android.control.effectMode", int.class); 1839 1840 /** 1841 * <p>Overall mode of 3A (auto-exposure, auto-white-balance, auto-focus) control 1842 * routines.</p> 1843 * <p>This is a top-level 3A control switch. When set to OFF, all 3A control 1844 * by the camera device is disabled. The application must set the fields for 1845 * capture parameters itself.</p> 1846 * <p>When set to AUTO, the individual algorithm controls in 1847 * android.control.* are in effect, such as {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}.</p> 1848 * <p>When set to USE_SCENE_MODE, the individual controls in 1849 * android.control.* are mostly disabled, and the camera device implements 1850 * one of the scene mode settings (such as ACTION, SUNSET, or PARTY) 1851 * as it wishes. The camera device scene mode 3A settings are provided by 1852 * android.control.sceneModeOverrides.</p> 1853 * <p>When set to OFF_KEEP_STATE, it is similar to OFF mode, the only difference 1854 * is that this frame will not be used by camera device background 3A statistics 1855 * update, as if this frame is never captured. This mode can be used in the scenario 1856 * where the application doesn't want a 3A manual control capture to affect 1857 * the subsequent auto 3A capture results.</p> 1858 * <p>LEGACY mode devices will only support AUTO and USE_SCENE_MODE modes. 1859 * LIMITED mode devices will only support OFF and OFF_KEEP_STATE if they 1860 * support the MANUAL_SENSOR and MANUAL_POST_PROCSESING capabilities. 1861 * FULL mode devices will always support OFF and OFF_KEEP_STATE.</p> 1862 * <p><b>Possible values:</b> 1863 * <ul> 1864 * <li>{@link #CONTROL_MODE_OFF OFF}</li> 1865 * <li>{@link #CONTROL_MODE_AUTO AUTO}</li> 1866 * <li>{@link #CONTROL_MODE_USE_SCENE_MODE USE_SCENE_MODE}</li> 1867 * <li>{@link #CONTROL_MODE_OFF_KEEP_STATE OFF_KEEP_STATE}</li> 1868 * </ul></p> 1869 * <p>This key is available on all devices.</p> 1870 * 1871 * @see CaptureRequest#CONTROL_AF_MODE 1872 * @see #CONTROL_MODE_OFF 1873 * @see #CONTROL_MODE_AUTO 1874 * @see #CONTROL_MODE_USE_SCENE_MODE 1875 * @see #CONTROL_MODE_OFF_KEEP_STATE 1876 */ 1877 @PublicKey 1878 public static final Key<Integer> CONTROL_MODE = 1879 new Key<Integer>("android.control.mode", int.class); 1880 1881 /** 1882 * <p>Control for which scene mode is currently active.</p> 1883 * <p>Scene modes are custom camera modes optimized for a certain set of conditions and 1884 * capture settings.</p> 1885 * <p>This is the mode that that is active when 1886 * <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code>. Aside from FACE_PRIORITY, 1887 * these modes will disable {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode}, 1888 * {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, and {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} while in use.</p> 1889 * <p>The interpretation and implementation of these scene modes is left 1890 * to the implementor of the camera device. Their behavior will not be 1891 * consistent across all devices, and any given device may only implement 1892 * a subset of these modes.</p> 1893 * <p><b>Possible values:</b> 1894 * <ul> 1895 * <li>{@link #CONTROL_SCENE_MODE_DISABLED DISABLED}</li> 1896 * <li>{@link #CONTROL_SCENE_MODE_FACE_PRIORITY FACE_PRIORITY}</li> 1897 * <li>{@link #CONTROL_SCENE_MODE_ACTION ACTION}</li> 1898 * <li>{@link #CONTROL_SCENE_MODE_PORTRAIT PORTRAIT}</li> 1899 * <li>{@link #CONTROL_SCENE_MODE_LANDSCAPE LANDSCAPE}</li> 1900 * <li>{@link #CONTROL_SCENE_MODE_NIGHT NIGHT}</li> 1901 * <li>{@link #CONTROL_SCENE_MODE_NIGHT_PORTRAIT NIGHT_PORTRAIT}</li> 1902 * <li>{@link #CONTROL_SCENE_MODE_THEATRE THEATRE}</li> 1903 * <li>{@link #CONTROL_SCENE_MODE_BEACH BEACH}</li> 1904 * <li>{@link #CONTROL_SCENE_MODE_SNOW SNOW}</li> 1905 * <li>{@link #CONTROL_SCENE_MODE_SUNSET SUNSET}</li> 1906 * <li>{@link #CONTROL_SCENE_MODE_STEADYPHOTO STEADYPHOTO}</li> 1907 * <li>{@link #CONTROL_SCENE_MODE_FIREWORKS FIREWORKS}</li> 1908 * <li>{@link #CONTROL_SCENE_MODE_SPORTS SPORTS}</li> 1909 * <li>{@link #CONTROL_SCENE_MODE_PARTY PARTY}</li> 1910 * <li>{@link #CONTROL_SCENE_MODE_CANDLELIGHT CANDLELIGHT}</li> 1911 * <li>{@link #CONTROL_SCENE_MODE_BARCODE BARCODE}</li> 1912 * <li>{@link #CONTROL_SCENE_MODE_HIGH_SPEED_VIDEO HIGH_SPEED_VIDEO}</li> 1913 * </ul></p> 1914 * <p><b>Available values for this device:</b><br> 1915 * {@link CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES android.control.availableSceneModes}</p> 1916 * <p>This key is available on all devices.</p> 1917 * 1918 * @see CaptureRequest#CONTROL_AE_MODE 1919 * @see CaptureRequest#CONTROL_AF_MODE 1920 * @see CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES 1921 * @see CaptureRequest#CONTROL_AWB_MODE 1922 * @see CaptureRequest#CONTROL_MODE 1923 * @see #CONTROL_SCENE_MODE_DISABLED 1924 * @see #CONTROL_SCENE_MODE_FACE_PRIORITY 1925 * @see #CONTROL_SCENE_MODE_ACTION 1926 * @see #CONTROL_SCENE_MODE_PORTRAIT 1927 * @see #CONTROL_SCENE_MODE_LANDSCAPE 1928 * @see #CONTROL_SCENE_MODE_NIGHT 1929 * @see #CONTROL_SCENE_MODE_NIGHT_PORTRAIT 1930 * @see #CONTROL_SCENE_MODE_THEATRE 1931 * @see #CONTROL_SCENE_MODE_BEACH 1932 * @see #CONTROL_SCENE_MODE_SNOW 1933 * @see #CONTROL_SCENE_MODE_SUNSET 1934 * @see #CONTROL_SCENE_MODE_STEADYPHOTO 1935 * @see #CONTROL_SCENE_MODE_FIREWORKS 1936 * @see #CONTROL_SCENE_MODE_SPORTS 1937 * @see #CONTROL_SCENE_MODE_PARTY 1938 * @see #CONTROL_SCENE_MODE_CANDLELIGHT 1939 * @see #CONTROL_SCENE_MODE_BARCODE 1940 * @see #CONTROL_SCENE_MODE_HIGH_SPEED_VIDEO 1941 */ 1942 @PublicKey 1943 public static final Key<Integer> CONTROL_SCENE_MODE = 1944 new Key<Integer>("android.control.sceneMode", int.class); 1945 1946 /** 1947 * <p>Whether video stabilization is 1948 * active.</p> 1949 * <p>Video stabilization automatically translates and scales images from 1950 * the camera in order to stabilize motion between consecutive frames.</p> 1951 * <p>If enabled, video stabilization can modify the 1952 * {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} to keep the video stream stabilized.</p> 1953 * <p>Switching between different video stabilization modes may take several 1954 * frames to initialize, the camera device will report the current mode 1955 * in capture result metadata. For example, When "ON" mode is requested, 1956 * the video stabilization modes in the first several capture results may 1957 * still be "OFF", and it will become "ON" when the initialization is 1958 * done.</p> 1959 * <p>If a camera device supports both this mode and OIS 1960 * ({@link CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE android.lens.opticalStabilizationMode}), turning both modes on may 1961 * produce undesirable interaction, so it is recommended not to enable 1962 * both at the same time.</p> 1963 * <p><b>Possible values:</b> 1964 * <ul> 1965 * <li>{@link #CONTROL_VIDEO_STABILIZATION_MODE_OFF OFF}</li> 1966 * <li>{@link #CONTROL_VIDEO_STABILIZATION_MODE_ON ON}</li> 1967 * </ul></p> 1968 * <p>This key is available on all devices.</p> 1969 * 1970 * @see CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE 1971 * @see CaptureRequest#SCALER_CROP_REGION 1972 * @see #CONTROL_VIDEO_STABILIZATION_MODE_OFF 1973 * @see #CONTROL_VIDEO_STABILIZATION_MODE_ON 1974 */ 1975 @PublicKey 1976 public static final Key<Integer> CONTROL_VIDEO_STABILIZATION_MODE = 1977 new Key<Integer>("android.control.videoStabilizationMode", int.class); 1978 1979 /** 1980 * <p>Operation mode for edge 1981 * enhancement.</p> 1982 * <p>Edge enhancement improves sharpness and details in the captured image. OFF means 1983 * no enhancement will be applied by the camera device.</p> 1984 * <p>FAST/HIGH_QUALITY both mean camera device determined enhancement 1985 * will be applied. HIGH_QUALITY mode indicates that the 1986 * camera device will use the highest-quality enhancement algorithms, 1987 * even if it slows down capture rate. FAST means the camera device will 1988 * not slow down capture rate when applying edge enhancement.</p> 1989 * <p><b>Possible values:</b> 1990 * <ul> 1991 * <li>{@link #EDGE_MODE_OFF OFF}</li> 1992 * <li>{@link #EDGE_MODE_FAST FAST}</li> 1993 * <li>{@link #EDGE_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 1994 * </ul></p> 1995 * <p><b>Available values for this device:</b><br> 1996 * {@link CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES android.edge.availableEdgeModes}</p> 1997 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1998 * <p><b>Full capability</b> - 1999 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 2000 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2001 * 2002 * @see CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES 2003 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2004 * @see #EDGE_MODE_OFF 2005 * @see #EDGE_MODE_FAST 2006 * @see #EDGE_MODE_HIGH_QUALITY 2007 */ 2008 @PublicKey 2009 public static final Key<Integer> EDGE_MODE = 2010 new Key<Integer>("android.edge.mode", int.class); 2011 2012 /** 2013 * <p>The desired mode for for the camera device's flash control.</p> 2014 * <p>This control is only effective when flash unit is available 2015 * (<code>{@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} == true</code>).</p> 2016 * <p>When this control is used, the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} must be set to ON or OFF. 2017 * Otherwise, the camera device auto-exposure related flash control (ON_AUTO_FLASH, 2018 * ON_ALWAYS_FLASH, or ON_AUTO_FLASH_REDEYE) will override this control.</p> 2019 * <p>When set to OFF, the camera device will not fire flash for this capture.</p> 2020 * <p>When set to SINGLE, the camera device will fire flash regardless of the camera 2021 * device's auto-exposure routine's result. When used in still capture case, this 2022 * control should be used along with auto-exposure (AE) precapture metering sequence 2023 * ({@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}), otherwise, the image may be incorrectly exposed.</p> 2024 * <p>When set to TORCH, the flash will be on continuously. This mode can be used 2025 * for use cases such as preview, auto-focus assist, still capture, or video recording.</p> 2026 * <p>The flash status will be reported by {@link CaptureResult#FLASH_STATE android.flash.state} in the capture result metadata.</p> 2027 * <p><b>Possible values:</b> 2028 * <ul> 2029 * <li>{@link #FLASH_MODE_OFF OFF}</li> 2030 * <li>{@link #FLASH_MODE_SINGLE SINGLE}</li> 2031 * <li>{@link #FLASH_MODE_TORCH TORCH}</li> 2032 * </ul></p> 2033 * <p>This key is available on all devices.</p> 2034 * 2035 * @see CaptureRequest#CONTROL_AE_MODE 2036 * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER 2037 * @see CameraCharacteristics#FLASH_INFO_AVAILABLE 2038 * @see CaptureResult#FLASH_STATE 2039 * @see #FLASH_MODE_OFF 2040 * @see #FLASH_MODE_SINGLE 2041 * @see #FLASH_MODE_TORCH 2042 */ 2043 @PublicKey 2044 public static final Key<Integer> FLASH_MODE = 2045 new Key<Integer>("android.flash.mode", int.class); 2046 2047 /** 2048 * <p>Current state of the flash 2049 * unit.</p> 2050 * <p>When the camera device doesn't have flash unit 2051 * (i.e. <code>{@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} == false</code>), this state will always be UNAVAILABLE. 2052 * Other states indicate the current flash status.</p> 2053 * <p>In certain conditions, this will be available on LEGACY devices:</p> 2054 * <ul> 2055 * <li>Flash-less cameras always return UNAVAILABLE.</li> 2056 * <li>Using {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} <code>==</code> ON_ALWAYS_FLASH 2057 * will always return FIRED.</li> 2058 * <li>Using {@link CaptureRequest#FLASH_MODE android.flash.mode} <code>==</code> TORCH 2059 * will always return FIRED.</li> 2060 * </ul> 2061 * <p>In all other conditions the state will not be available on 2062 * LEGACY devices (i.e. it will be <code>null</code>).</p> 2063 * <p><b>Possible values:</b> 2064 * <ul> 2065 * <li>{@link #FLASH_STATE_UNAVAILABLE UNAVAILABLE}</li> 2066 * <li>{@link #FLASH_STATE_CHARGING CHARGING}</li> 2067 * <li>{@link #FLASH_STATE_READY READY}</li> 2068 * <li>{@link #FLASH_STATE_FIRED FIRED}</li> 2069 * <li>{@link #FLASH_STATE_PARTIAL PARTIAL}</li> 2070 * </ul></p> 2071 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2072 * <p><b>Limited capability</b> - 2073 * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the 2074 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2075 * 2076 * @see CaptureRequest#CONTROL_AE_MODE 2077 * @see CameraCharacteristics#FLASH_INFO_AVAILABLE 2078 * @see CaptureRequest#FLASH_MODE 2079 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2080 * @see #FLASH_STATE_UNAVAILABLE 2081 * @see #FLASH_STATE_CHARGING 2082 * @see #FLASH_STATE_READY 2083 * @see #FLASH_STATE_FIRED 2084 * @see #FLASH_STATE_PARTIAL 2085 */ 2086 @PublicKey 2087 public static final Key<Integer> FLASH_STATE = 2088 new Key<Integer>("android.flash.state", int.class); 2089 2090 /** 2091 * <p>Operational mode for hot pixel correction.</p> 2092 * <p>Hotpixel correction interpolates out, or otherwise removes, pixels 2093 * that do not accurately measure the incoming light (i.e. pixels that 2094 * are stuck at an arbitrary value or are oversensitive).</p> 2095 * <p><b>Possible values:</b> 2096 * <ul> 2097 * <li>{@link #HOT_PIXEL_MODE_OFF OFF}</li> 2098 * <li>{@link #HOT_PIXEL_MODE_FAST FAST}</li> 2099 * <li>{@link #HOT_PIXEL_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 2100 * </ul></p> 2101 * <p><b>Available values for this device:</b><br> 2102 * {@link CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES android.hotPixel.availableHotPixelModes}</p> 2103 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2104 * 2105 * @see CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES 2106 * @see #HOT_PIXEL_MODE_OFF 2107 * @see #HOT_PIXEL_MODE_FAST 2108 * @see #HOT_PIXEL_MODE_HIGH_QUALITY 2109 */ 2110 @PublicKey 2111 public static final Key<Integer> HOT_PIXEL_MODE = 2112 new Key<Integer>("android.hotPixel.mode", int.class); 2113 2114 /** 2115 * <p>A location object to use when generating image GPS metadata.</p> 2116 * <p>Setting a location object in a request will include the GPS coordinates of the location 2117 * into any JPEG images captured based on the request. These coordinates can then be 2118 * viewed by anyone who receives the JPEG image.</p> 2119 * <p>This key is available on all devices.</p> 2120 */ 2121 @PublicKey 2122 @SyntheticKey 2123 public static final Key<android.location.Location> JPEG_GPS_LOCATION = 2124 new Key<android.location.Location>("android.jpeg.gpsLocation", android.location.Location.class); 2125 2126 /** 2127 * <p>GPS coordinates to include in output JPEG 2128 * EXIF.</p> 2129 * <p><b>Range of valid values:</b><br> 2130 * (-180 - 180], [-90,90], [-inf, inf]</p> 2131 * <p>This key is available on all devices.</p> 2132 * @hide 2133 */ 2134 public static final Key<double[]> JPEG_GPS_COORDINATES = 2135 new Key<double[]>("android.jpeg.gpsCoordinates", double[].class); 2136 2137 /** 2138 * <p>32 characters describing GPS algorithm to 2139 * include in EXIF.</p> 2140 * <p><b>Units</b>: UTF-8 null-terminated string</p> 2141 * <p>This key is available on all devices.</p> 2142 * @hide 2143 */ 2144 public static final Key<String> JPEG_GPS_PROCESSING_METHOD = 2145 new Key<String>("android.jpeg.gpsProcessingMethod", String.class); 2146 2147 /** 2148 * <p>Time GPS fix was made to include in 2149 * EXIF.</p> 2150 * <p><b>Units</b>: UTC in seconds since January 1, 1970</p> 2151 * <p>This key is available on all devices.</p> 2152 * @hide 2153 */ 2154 public static final Key<Long> JPEG_GPS_TIMESTAMP = 2155 new Key<Long>("android.jpeg.gpsTimestamp", long.class); 2156 2157 /** 2158 * <p>The orientation for a JPEG image.</p> 2159 * <p>The clockwise rotation angle in degrees, relative to the orientation 2160 * to the camera, that the JPEG picture needs to be rotated by, to be viewed 2161 * upright.</p> 2162 * <p>Camera devices may either encode this value into the JPEG EXIF header, or 2163 * rotate the image data to match this orientation.</p> 2164 * <p>Note that this orientation is relative to the orientation of the camera sensor, given 2165 * by {@link CameraCharacteristics#SENSOR_ORIENTATION android.sensor.orientation}.</p> 2166 * <p>To translate from the device orientation given by the Android sensor APIs, the following 2167 * sample code may be used:</p> 2168 * <pre><code>private int getJpegOrientation(CameraCharacteristics c, int deviceOrientation) { 2169 * if (deviceOrientation == android.view.OrientationEventListener.ORIENTATION_UNKNOWN) return 0; 2170 * int sensorOrientation = c.get(CameraCharacteristics.SENSOR_ORIENTATION); 2171 * 2172 * // Round device orientation to a multiple of 90 2173 * deviceOrientation = (deviceOrientation + 45) / 90 * 90; 2174 * 2175 * // Reverse device orientation for front-facing cameras 2176 * boolean facingFront = c.get(CameraCharacteristics.LENS_FACING) == CameraCharacteristics.LENS_FACING_FRONT; 2177 * if (facingFront) deviceOrientation = -deviceOrientation; 2178 * 2179 * // Calculate desired JPEG orientation relative to camera orientation to make 2180 * // the image upright relative to the device orientation 2181 * int jpegOrientation = (sensorOrientation + deviceOrientation + 360) % 360; 2182 * 2183 * return jpegOrientation; 2184 * } 2185 * </code></pre> 2186 * <p><b>Units</b>: Degrees in multiples of 90</p> 2187 * <p><b>Range of valid values:</b><br> 2188 * 0, 90, 180, 270</p> 2189 * <p>This key is available on all devices.</p> 2190 * 2191 * @see CameraCharacteristics#SENSOR_ORIENTATION 2192 */ 2193 @PublicKey 2194 public static final Key<Integer> JPEG_ORIENTATION = 2195 new Key<Integer>("android.jpeg.orientation", int.class); 2196 2197 /** 2198 * <p>Compression quality of the final JPEG 2199 * image.</p> 2200 * <p>85-95 is typical usage range.</p> 2201 * <p><b>Range of valid values:</b><br> 2202 * 1-100; larger is higher quality</p> 2203 * <p>This key is available on all devices.</p> 2204 */ 2205 @PublicKey 2206 public static final Key<Byte> JPEG_QUALITY = 2207 new Key<Byte>("android.jpeg.quality", byte.class); 2208 2209 /** 2210 * <p>Compression quality of JPEG 2211 * thumbnail.</p> 2212 * <p><b>Range of valid values:</b><br> 2213 * 1-100; larger is higher quality</p> 2214 * <p>This key is available on all devices.</p> 2215 */ 2216 @PublicKey 2217 public static final Key<Byte> JPEG_THUMBNAIL_QUALITY = 2218 new Key<Byte>("android.jpeg.thumbnailQuality", byte.class); 2219 2220 /** 2221 * <p>Resolution of embedded JPEG thumbnail.</p> 2222 * <p>When set to (0, 0) value, the JPEG EXIF will not contain thumbnail, 2223 * but the captured JPEG will still be a valid image.</p> 2224 * <p>For best results, when issuing a request for a JPEG image, the thumbnail size selected 2225 * should have the same aspect ratio as the main JPEG output.</p> 2226 * <p>If the thumbnail image aspect ratio differs from the JPEG primary image aspect 2227 * ratio, the camera device creates the thumbnail by cropping it from the primary image. 2228 * For example, if the primary image has 4:3 aspect ratio, the thumbnail image has 2229 * 16:9 aspect ratio, the primary image will be cropped vertically (letterbox) to 2230 * generate the thumbnail image. The thumbnail image will always have a smaller Field 2231 * Of View (FOV) than the primary image when aspect ratios differ.</p> 2232 * <p><b>Range of valid values:</b><br> 2233 * {@link CameraCharacteristics#JPEG_AVAILABLE_THUMBNAIL_SIZES android.jpeg.availableThumbnailSizes}</p> 2234 * <p>This key is available on all devices.</p> 2235 * 2236 * @see CameraCharacteristics#JPEG_AVAILABLE_THUMBNAIL_SIZES 2237 */ 2238 @PublicKey 2239 public static final Key<android.util.Size> JPEG_THUMBNAIL_SIZE = 2240 new Key<android.util.Size>("android.jpeg.thumbnailSize", android.util.Size.class); 2241 2242 /** 2243 * <p>The desired lens aperture size, as a ratio of lens focal length to the 2244 * effective aperture diameter.</p> 2245 * <p>Setting this value is only supported on the camera devices that have a variable 2246 * aperture lens.</p> 2247 * <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is OFF, 2248 * this can be set along with {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, 2249 * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration} 2250 * to achieve manual exposure control.</p> 2251 * <p>The requested aperture value may take several frames to reach the 2252 * requested value; the camera device will report the current (intermediate) 2253 * aperture size in capture result metadata while the aperture is changing. 2254 * While the aperture is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> 2255 * <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is one of 2256 * the ON modes, this will be overridden by the camera device 2257 * auto-exposure algorithm, the overridden values are then provided 2258 * back to the user in the corresponding result.</p> 2259 * <p><b>Units</b>: The f-number (f/N)</p> 2260 * <p><b>Range of valid values:</b><br> 2261 * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES android.lens.info.availableApertures}</p> 2262 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2263 * <p><b>Full capability</b> - 2264 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 2265 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2266 * 2267 * @see CaptureRequest#CONTROL_AE_MODE 2268 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2269 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES 2270 * @see CaptureResult#LENS_STATE 2271 * @see CaptureRequest#SENSOR_EXPOSURE_TIME 2272 * @see CaptureRequest#SENSOR_FRAME_DURATION 2273 * @see CaptureRequest#SENSOR_SENSITIVITY 2274 */ 2275 @PublicKey 2276 public static final Key<Float> LENS_APERTURE = 2277 new Key<Float>("android.lens.aperture", float.class); 2278 2279 /** 2280 * <p>The desired setting for the lens neutral density filter(s).</p> 2281 * <p>This control will not be supported on most camera devices.</p> 2282 * <p>Lens filters are typically used to lower the amount of light the 2283 * sensor is exposed to (measured in steps of EV). As used here, an EV 2284 * step is the standard logarithmic representation, which are 2285 * non-negative, and inversely proportional to the amount of light 2286 * hitting the sensor. For example, setting this to 0 would result 2287 * in no reduction of the incoming light, and setting this to 2 would 2288 * mean that the filter is set to reduce incoming light by two stops 2289 * (allowing 1/4 of the prior amount of light to the sensor).</p> 2290 * <p>It may take several frames before the lens filter density changes 2291 * to the requested value. While the filter density is still changing, 2292 * {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> 2293 * <p><b>Units</b>: Exposure Value (EV)</p> 2294 * <p><b>Range of valid values:</b><br> 2295 * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES android.lens.info.availableFilterDensities}</p> 2296 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2297 * <p><b>Full capability</b> - 2298 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 2299 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2300 * 2301 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2302 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES 2303 * @see CaptureResult#LENS_STATE 2304 */ 2305 @PublicKey 2306 public static final Key<Float> LENS_FILTER_DENSITY = 2307 new Key<Float>("android.lens.filterDensity", float.class); 2308 2309 /** 2310 * <p>The desired lens focal length; used for optical zoom.</p> 2311 * <p>This setting controls the physical focal length of the camera 2312 * device's lens. Changing the focal length changes the field of 2313 * view of the camera device, and is usually used for optical zoom.</p> 2314 * <p>Like {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance} and {@link CaptureRequest#LENS_APERTURE android.lens.aperture}, this 2315 * setting won't be applied instantaneously, and it may take several 2316 * frames before the lens can change to the requested focal length. 2317 * While the focal length is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will 2318 * be set to MOVING.</p> 2319 * <p>Optical zoom will not be supported on most devices.</p> 2320 * <p><b>Units</b>: Millimeters</p> 2321 * <p><b>Range of valid values:</b><br> 2322 * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS android.lens.info.availableFocalLengths}</p> 2323 * <p>This key is available on all devices.</p> 2324 * 2325 * @see CaptureRequest#LENS_APERTURE 2326 * @see CaptureRequest#LENS_FOCUS_DISTANCE 2327 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS 2328 * @see CaptureResult#LENS_STATE 2329 */ 2330 @PublicKey 2331 public static final Key<Float> LENS_FOCAL_LENGTH = 2332 new Key<Float>("android.lens.focalLength", float.class); 2333 2334 /** 2335 * <p>Desired distance to plane of sharpest focus, 2336 * measured from frontmost surface of the lens.</p> 2337 * <p>Should be zero for fixed-focus cameras</p> 2338 * <p><b>Units</b>: See {@link CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION android.lens.info.focusDistanceCalibration} for details</p> 2339 * <p><b>Range of valid values:</b><br> 2340 * >= 0</p> 2341 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2342 * <p><b>Full capability</b> - 2343 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 2344 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2345 * 2346 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2347 * @see CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION 2348 */ 2349 @PublicKey 2350 public static final Key<Float> LENS_FOCUS_DISTANCE = 2351 new Key<Float>("android.lens.focusDistance", float.class); 2352 2353 /** 2354 * <p>The range of scene distances that are in 2355 * sharp focus (depth of field).</p> 2356 * <p>If variable focus not supported, can still report 2357 * fixed depth of field range</p> 2358 * <p><b>Units</b>: A pair of focus distances in diopters: (near, 2359 * far); see {@link CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION android.lens.info.focusDistanceCalibration} for details.</p> 2360 * <p><b>Range of valid values:</b><br> 2361 * >=0</p> 2362 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2363 * <p><b>Limited capability</b> - 2364 * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the 2365 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2366 * 2367 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2368 * @see CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION 2369 */ 2370 @PublicKey 2371 public static final Key<android.util.Pair<Float,Float>> LENS_FOCUS_RANGE = 2372 new Key<android.util.Pair<Float,Float>>("android.lens.focusRange", new TypeReference<android.util.Pair<Float,Float>>() {{ }}); 2373 2374 /** 2375 * <p>Sets whether the camera device uses optical image stabilization (OIS) 2376 * when capturing images.</p> 2377 * <p>OIS is used to compensate for motion blur due to small 2378 * movements of the camera during capture. Unlike digital image 2379 * stabilization ({@link CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE android.control.videoStabilizationMode}), OIS 2380 * makes use of mechanical elements to stabilize the camera 2381 * sensor, and thus allows for longer exposure times before 2382 * camera shake becomes apparent.</p> 2383 * <p>Switching between different optical stabilization modes may take several 2384 * frames to initialize, the camera device will report the current mode in 2385 * capture result metadata. For example, When "ON" mode is requested, the 2386 * optical stabilization modes in the first several capture results may still 2387 * be "OFF", and it will become "ON" when the initialization is done.</p> 2388 * <p>If a camera device supports both OIS and digital image stabilization 2389 * ({@link CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE android.control.videoStabilizationMode}), turning both modes on may produce undesirable 2390 * interaction, so it is recommended not to enable both at the same time.</p> 2391 * <p>Not all devices will support OIS; see 2392 * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION android.lens.info.availableOpticalStabilization} for 2393 * available controls.</p> 2394 * <p><b>Possible values:</b> 2395 * <ul> 2396 * <li>{@link #LENS_OPTICAL_STABILIZATION_MODE_OFF OFF}</li> 2397 * <li>{@link #LENS_OPTICAL_STABILIZATION_MODE_ON ON}</li> 2398 * </ul></p> 2399 * <p><b>Available values for this device:</b><br> 2400 * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION android.lens.info.availableOpticalStabilization}</p> 2401 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2402 * <p><b>Limited capability</b> - 2403 * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the 2404 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2405 * 2406 * @see CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE 2407 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2408 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION 2409 * @see #LENS_OPTICAL_STABILIZATION_MODE_OFF 2410 * @see #LENS_OPTICAL_STABILIZATION_MODE_ON 2411 */ 2412 @PublicKey 2413 public static final Key<Integer> LENS_OPTICAL_STABILIZATION_MODE = 2414 new Key<Integer>("android.lens.opticalStabilizationMode", int.class); 2415 2416 /** 2417 * <p>Current lens status.</p> 2418 * <p>For lens parameters {@link CaptureRequest#LENS_FOCAL_LENGTH android.lens.focalLength}, {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance}, 2419 * {@link CaptureRequest#LENS_FILTER_DENSITY android.lens.filterDensity} and {@link CaptureRequest#LENS_APERTURE android.lens.aperture}, when changes are requested, 2420 * they may take several frames to reach the requested values. This state indicates 2421 * the current status of the lens parameters.</p> 2422 * <p>When the state is STATIONARY, the lens parameters are not changing. This could be 2423 * either because the parameters are all fixed, or because the lens has had enough 2424 * time to reach the most recently-requested values. 2425 * If all these lens parameters are not changable for a camera device, as listed below:</p> 2426 * <ul> 2427 * <li>Fixed focus (<code>{@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} == 0</code>), which means 2428 * {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance} parameter will always be 0.</li> 2429 * <li>Fixed focal length ({@link CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS android.lens.info.availableFocalLengths} contains single value), 2430 * which means the optical zoom is not supported.</li> 2431 * <li>No ND filter ({@link CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES android.lens.info.availableFilterDensities} contains only 0).</li> 2432 * <li>Fixed aperture ({@link CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES android.lens.info.availableApertures} contains single value).</li> 2433 * </ul> 2434 * <p>Then this state will always be STATIONARY.</p> 2435 * <p>When the state is MOVING, it indicates that at least one of the lens parameters 2436 * is changing.</p> 2437 * <p><b>Possible values:</b> 2438 * <ul> 2439 * <li>{@link #LENS_STATE_STATIONARY STATIONARY}</li> 2440 * <li>{@link #LENS_STATE_MOVING MOVING}</li> 2441 * </ul></p> 2442 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2443 * <p><b>Limited capability</b> - 2444 * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the 2445 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2446 * 2447 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2448 * @see CaptureRequest#LENS_APERTURE 2449 * @see CaptureRequest#LENS_FILTER_DENSITY 2450 * @see CaptureRequest#LENS_FOCAL_LENGTH 2451 * @see CaptureRequest#LENS_FOCUS_DISTANCE 2452 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES 2453 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES 2454 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS 2455 * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE 2456 * @see #LENS_STATE_STATIONARY 2457 * @see #LENS_STATE_MOVING 2458 */ 2459 @PublicKey 2460 public static final Key<Integer> LENS_STATE = 2461 new Key<Integer>("android.lens.state", int.class); 2462 2463 /** 2464 * <p>Mode of operation for the noise reduction algorithm.</p> 2465 * <p>The noise reduction algorithm attempts to improve image quality by removing 2466 * excessive noise added by the capture process, especially in dark conditions. 2467 * OFF means no noise reduction will be applied by the camera device.</p> 2468 * <p>FAST/HIGH_QUALITY both mean camera device determined noise filtering 2469 * will be applied. HIGH_QUALITY mode indicates that the camera device 2470 * will use the highest-quality noise filtering algorithms, 2471 * even if it slows down capture rate. FAST means the camera device will not 2472 * slow down capture rate when applying noise filtering.</p> 2473 * <p><b>Possible values:</b> 2474 * <ul> 2475 * <li>{@link #NOISE_REDUCTION_MODE_OFF OFF}</li> 2476 * <li>{@link #NOISE_REDUCTION_MODE_FAST FAST}</li> 2477 * <li>{@link #NOISE_REDUCTION_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 2478 * </ul></p> 2479 * <p><b>Available values for this device:</b><br> 2480 * {@link CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES android.noiseReduction.availableNoiseReductionModes}</p> 2481 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2482 * <p><b>Full capability</b> - 2483 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 2484 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2485 * 2486 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2487 * @see CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES 2488 * @see #NOISE_REDUCTION_MODE_OFF 2489 * @see #NOISE_REDUCTION_MODE_FAST 2490 * @see #NOISE_REDUCTION_MODE_HIGH_QUALITY 2491 */ 2492 @PublicKey 2493 public static final Key<Integer> NOISE_REDUCTION_MODE = 2494 new Key<Integer>("android.noiseReduction.mode", int.class); 2495 2496 /** 2497 * <p>Whether a result given to the framework is the 2498 * final one for the capture, or only a partial that contains a 2499 * subset of the full set of dynamic metadata 2500 * values.</p> 2501 * <p>The entries in the result metadata buffers for a 2502 * single capture may not overlap, except for this entry. The 2503 * FINAL buffers must retain FIFO ordering relative to the 2504 * requests that generate them, so the FINAL buffer for frame 3 must 2505 * always be sent to the framework after the FINAL buffer for frame 2, and 2506 * before the FINAL buffer for frame 4. PARTIAL buffers may be returned 2507 * in any order relative to other frames, but all PARTIAL buffers for a given 2508 * capture must arrive before the FINAL buffer for that capture. This entry may 2509 * only be used by the camera device if quirks.usePartialResult is set to 1.</p> 2510 * <p><b>Range of valid values:</b><br> 2511 * Optional. Default value is FINAL.</p> 2512 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2513 * @deprecated 2514 * @hide 2515 */ 2516 @Deprecated 2517 public static final Key<Boolean> QUIRKS_PARTIAL_RESULT = 2518 new Key<Boolean>("android.quirks.partialResult", boolean.class); 2519 2520 /** 2521 * <p>A frame counter set by the framework. This value monotonically 2522 * increases with every new result (that is, each new result has a unique 2523 * frameCount value).</p> 2524 * <p>Reset on release()</p> 2525 * <p><b>Units</b>: count of frames</p> 2526 * <p><b>Range of valid values:</b><br> 2527 * > 0</p> 2528 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2529 * @deprecated 2530 * @hide 2531 */ 2532 @Deprecated 2533 public static final Key<Integer> REQUEST_FRAME_COUNT = 2534 new Key<Integer>("android.request.frameCount", int.class); 2535 2536 /** 2537 * <p>An application-specified ID for the current 2538 * request. Must be maintained unchanged in output 2539 * frame</p> 2540 * <p><b>Units</b>: arbitrary integer assigned by application</p> 2541 * <p><b>Range of valid values:</b><br> 2542 * Any int</p> 2543 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2544 * @hide 2545 */ 2546 public static final Key<Integer> REQUEST_ID = 2547 new Key<Integer>("android.request.id", int.class); 2548 2549 /** 2550 * <p>Specifies the number of pipeline stages the frame went 2551 * through from when it was exposed to when the final completed result 2552 * was available to the framework.</p> 2553 * <p>Depending on what settings are used in the request, and 2554 * what streams are configured, the data may undergo less processing, 2555 * and some pipeline stages skipped.</p> 2556 * <p>See {@link CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH android.request.pipelineMaxDepth} for more details.</p> 2557 * <p><b>Range of valid values:</b><br> 2558 * <= {@link CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH android.request.pipelineMaxDepth}</p> 2559 * <p>This key is available on all devices.</p> 2560 * 2561 * @see CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH 2562 */ 2563 @PublicKey 2564 public static final Key<Byte> REQUEST_PIPELINE_DEPTH = 2565 new Key<Byte>("android.request.pipelineDepth", byte.class); 2566 2567 /** 2568 * <p>The desired region of the sensor to read out for this capture.</p> 2569 * <p>This control can be used to implement digital zoom.</p> 2570 * <p>The crop region coordinate system is based off 2571 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}, with <code>(0, 0)</code> being the 2572 * top-left corner of the sensor active array.</p> 2573 * <p>Output streams use this rectangle to produce their output, 2574 * cropping to a smaller region if necessary to maintain the 2575 * stream's aspect ratio, then scaling the sensor input to 2576 * match the output's configured resolution.</p> 2577 * <p>The crop region is applied after the RAW to other color 2578 * space (e.g. YUV) conversion. Since raw streams 2579 * (e.g. RAW16) don't have the conversion stage, they are not 2580 * croppable. The crop region will be ignored by raw streams.</p> 2581 * <p>For non-raw streams, any additional per-stream cropping will 2582 * be done to maximize the final pixel area of the stream.</p> 2583 * <p>For example, if the crop region is set to a 4:3 aspect 2584 * ratio, then 4:3 streams will use the exact crop 2585 * region. 16:9 streams will further crop vertically 2586 * (letterbox).</p> 2587 * <p>Conversely, if the crop region is set to a 16:9, then 4:3 2588 * outputs will crop horizontally (pillarbox), and 16:9 2589 * streams will match exactly. These additional crops will 2590 * be centered within the crop region.</p> 2591 * <p>The width and height of the crop region cannot 2592 * be set to be smaller than 2593 * <code>floor( activeArraySize.width / {@link CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom} )</code> and 2594 * <code>floor( activeArraySize.height / {@link CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom} )</code>, respectively.</p> 2595 * <p>The camera device may adjust the crop region to account 2596 * for rounding and other hardware requirements; the final 2597 * crop region used will be included in the output capture 2598 * result.</p> 2599 * <p><b>Units</b>: Pixel coordinates relative to 2600 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 2601 * <p>This key is available on all devices.</p> 2602 * 2603 * @see CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM 2604 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 2605 */ 2606 @PublicKey 2607 public static final Key<android.graphics.Rect> SCALER_CROP_REGION = 2608 new Key<android.graphics.Rect>("android.scaler.cropRegion", android.graphics.Rect.class); 2609 2610 /** 2611 * <p>Duration each pixel is exposed to 2612 * light.</p> 2613 * <p>If the sensor can't expose this exact duration, it will shorten the 2614 * duration exposed to the nearest possible value (rather than expose longer). 2615 * The final exposure time used will be available in the output capture result.</p> 2616 * <p>This control is only effective if {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link CaptureRequest#CONTROL_MODE android.control.mode} is set to 2617 * OFF; otherwise the auto-exposure algorithm will override this value.</p> 2618 * <p><b>Units</b>: Nanoseconds</p> 2619 * <p><b>Range of valid values:</b><br> 2620 * {@link CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE android.sensor.info.exposureTimeRange}</p> 2621 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2622 * <p><b>Full capability</b> - 2623 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 2624 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2625 * 2626 * @see CaptureRequest#CONTROL_AE_MODE 2627 * @see CaptureRequest#CONTROL_MODE 2628 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2629 * @see CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE 2630 */ 2631 @PublicKey 2632 public static final Key<Long> SENSOR_EXPOSURE_TIME = 2633 new Key<Long>("android.sensor.exposureTime", long.class); 2634 2635 /** 2636 * <p>Duration from start of frame exposure to 2637 * start of next frame exposure.</p> 2638 * <p>The maximum frame rate that can be supported by a camera subsystem is 2639 * a function of many factors:</p> 2640 * <ul> 2641 * <li>Requested resolutions of output image streams</li> 2642 * <li>Availability of binning / skipping modes on the imager</li> 2643 * <li>The bandwidth of the imager interface</li> 2644 * <li>The bandwidth of the various ISP processing blocks</li> 2645 * </ul> 2646 * <p>Since these factors can vary greatly between different ISPs and 2647 * sensors, the camera abstraction tries to represent the bandwidth 2648 * restrictions with as simple a model as possible.</p> 2649 * <p>The model presented has the following characteristics:</p> 2650 * <ul> 2651 * <li>The image sensor is always configured to output the smallest 2652 * resolution possible given the application's requested output stream 2653 * sizes. The smallest resolution is defined as being at least as large 2654 * as the largest requested output stream size; the camera pipeline must 2655 * never digitally upsample sensor data when the crop region covers the 2656 * whole sensor. In general, this means that if only small output stream 2657 * resolutions are configured, the sensor can provide a higher frame 2658 * rate.</li> 2659 * <li>Since any request may use any or all the currently configured 2660 * output streams, the sensor and ISP must be configured to support 2661 * scaling a single capture to all the streams at the same time. This 2662 * means the camera pipeline must be ready to produce the largest 2663 * requested output size without any delay. Therefore, the overall 2664 * frame rate of a given configured stream set is governed only by the 2665 * largest requested stream resolution.</li> 2666 * <li>Using more than one output stream in a request does not affect the 2667 * frame duration.</li> 2668 * <li>Certain format-streams may need to do additional background processing 2669 * before data is consumed/produced by that stream. These processors 2670 * can run concurrently to the rest of the camera pipeline, but 2671 * cannot process more than 1 capture at a time.</li> 2672 * </ul> 2673 * <p>The necessary information for the application, given the model above, 2674 * is provided via the {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} field 2675 * using StreamConfigurationMap#getOutputMinFrameDuration(int, Size). 2676 * These are used to determine the maximum frame rate / minimum frame 2677 * duration that is possible for a given stream configuration.</p> 2678 * <p>Specifically, the application can use the following rules to 2679 * determine the minimum frame duration it can request from the camera 2680 * device:</p> 2681 * <ol> 2682 * <li>Let the set of currently configured input/output streams 2683 * be called <code>S</code>.</li> 2684 * <li>Find the minimum frame durations for each stream in <code>S</code>, by 2685 * looking it up in {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} using 2686 * StreamConfigurationMap#getOutputMinFrameDuration(int, Size) (with 2687 * its respective size/format). Let this set of frame durations be called 2688 * <code>F</code>.</li> 2689 * <li>For any given request <code>R</code>, the minimum frame duration allowed 2690 * for <code>R</code> is the maximum out of all values in <code>F</code>. Let the streams 2691 * used in <code>R</code> be called <code>S_r</code>.</li> 2692 * </ol> 2693 * <p>If none of the streams in <code>S_r</code> have a stall time (listed in 2694 * StreamConfigurationMap#getOutputStallDuration(int,Size) using its 2695 * respective size/format), then the frame duration in 2696 * <code>F</code> determines the steady state frame rate that the application will 2697 * get if it uses <code>R</code> as a repeating request. Let this special kind 2698 * of request be called <code>Rsimple</code>.</p> 2699 * <p>A repeating request <code>Rsimple</code> can be <em>occasionally</em> interleaved 2700 * by a single capture of a new request <code>Rstall</code> (which has at least 2701 * one in-use stream with a non-0 stall time) and if <code>Rstall</code> has the 2702 * same minimum frame duration this will not cause a frame rate loss 2703 * if all buffers from the previous <code>Rstall</code> have already been 2704 * delivered.</p> 2705 * <p>For more details about stalling, see 2706 * StreamConfigurationMap#getOutputStallDuration(int,Size).</p> 2707 * <p>This control is only effective if {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link CaptureRequest#CONTROL_MODE android.control.mode} is set to 2708 * OFF; otherwise the auto-exposure algorithm will override this value.</p> 2709 * <p><b>Units</b>: Nanoseconds</p> 2710 * <p><b>Range of valid values:</b><br> 2711 * See {@link CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION android.sensor.info.maxFrameDuration}, 2712 * {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap}. The duration 2713 * is capped to <code>max(duration, exposureTime + overhead)</code>.</p> 2714 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2715 * <p><b>Full capability</b> - 2716 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 2717 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2718 * 2719 * @see CaptureRequest#CONTROL_AE_MODE 2720 * @see CaptureRequest#CONTROL_MODE 2721 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2722 * @see CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP 2723 * @see CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION 2724 */ 2725 @PublicKey 2726 public static final Key<Long> SENSOR_FRAME_DURATION = 2727 new Key<Long>("android.sensor.frameDuration", long.class); 2728 2729 /** 2730 * <p>The amount of gain applied to sensor data 2731 * before processing.</p> 2732 * <p>The sensitivity is the standard ISO sensitivity value, 2733 * as defined in ISO 12232:2006.</p> 2734 * <p>The sensitivity must be within {@link CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE android.sensor.info.sensitivityRange}, and 2735 * if if it less than {@link CameraCharacteristics#SENSOR_MAX_ANALOG_SENSITIVITY android.sensor.maxAnalogSensitivity}, the camera device 2736 * is guaranteed to use only analog amplification for applying the gain.</p> 2737 * <p>If the camera device cannot apply the exact sensitivity 2738 * requested, it will reduce the gain to the nearest supported 2739 * value. The final sensitivity used will be available in the 2740 * output capture result.</p> 2741 * <p><b>Units</b>: ISO arithmetic units</p> 2742 * <p><b>Range of valid values:</b><br> 2743 * {@link CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE android.sensor.info.sensitivityRange}</p> 2744 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2745 * <p><b>Full capability</b> - 2746 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 2747 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2748 * 2749 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2750 * @see CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE 2751 * @see CameraCharacteristics#SENSOR_MAX_ANALOG_SENSITIVITY 2752 */ 2753 @PublicKey 2754 public static final Key<Integer> SENSOR_SENSITIVITY = 2755 new Key<Integer>("android.sensor.sensitivity", int.class); 2756 2757 /** 2758 * <p>Time at start of exposure of first 2759 * row of the image sensor active array, in nanoseconds.</p> 2760 * <p>The timestamps are also included in all image 2761 * buffers produced for the same capture, and will be identical 2762 * on all the outputs.</p> 2763 * <p>When {@link CameraCharacteristics#SENSOR_INFO_TIMESTAMP_SOURCE android.sensor.info.timestampSource} <code>==</code> UNKNOWN, 2764 * the timestamps measure time since an unspecified starting point, 2765 * and are monotonically increasing. They can be compared with the 2766 * timestamps for other captures from the same camera device, but are 2767 * not guaranteed to be comparable to any other time source.</p> 2768 * <p>When {@link CameraCharacteristics#SENSOR_INFO_TIMESTAMP_SOURCE android.sensor.info.timestampSource} <code>==</code> REALTIME, 2769 * the timestamps measure time in the same timebase as 2770 * android.os.SystemClock#elapsedRealtimeNanos(), and they can be 2771 * compared to other timestamps from other subsystems that are using 2772 * that base.</p> 2773 * <p><b>Units</b>: Nanoseconds</p> 2774 * <p><b>Range of valid values:</b><br> 2775 * > 0</p> 2776 * <p>This key is available on all devices.</p> 2777 * 2778 * @see CameraCharacteristics#SENSOR_INFO_TIMESTAMP_SOURCE 2779 */ 2780 @PublicKey 2781 public static final Key<Long> SENSOR_TIMESTAMP = 2782 new Key<Long>("android.sensor.timestamp", long.class); 2783 2784 /** 2785 * <p>The estimated camera neutral color in the native sensor colorspace at 2786 * the time of capture.</p> 2787 * <p>This value gives the neutral color point encoded as an RGB value in the 2788 * native sensor color space. The neutral color point indicates the 2789 * currently estimated white point of the scene illumination. It can be 2790 * used to interpolate between the provided color transforms when 2791 * processing raw sensor data.</p> 2792 * <p>The order of the values is R, G, B; where R is in the lowest index.</p> 2793 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2794 */ 2795 @PublicKey 2796 public static final Key<Rational[]> SENSOR_NEUTRAL_COLOR_POINT = 2797 new Key<Rational[]>("android.sensor.neutralColorPoint", Rational[].class); 2798 2799 /** 2800 * <p>Noise model coefficients for each CFA mosaic channel.</p> 2801 * <p>This key contains two noise model coefficients for each CFA channel 2802 * corresponding to the sensor amplification (S) and sensor readout 2803 * noise (O). These are given as pairs of coefficients for each channel 2804 * in the same order as channels listed for the CFA layout key 2805 * (see {@link CameraCharacteristics#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT android.sensor.info.colorFilterArrangement}). This is 2806 * represented as an array of Pair<Double, Double>, where 2807 * the first member of the Pair at index n is the S coefficient and the 2808 * second member is the O coefficient for the nth color channel in the CFA.</p> 2809 * <p>These coefficients are used in a two parameter noise model to describe 2810 * the amount of noise present in the image for each CFA channel. The 2811 * noise model used here is:</p> 2812 * <p>N(x) = sqrt(Sx + O)</p> 2813 * <p>Where x represents the recorded signal of a CFA channel normalized to 2814 * the range [0, 1], and S and O are the noise model coeffiecients for 2815 * that channel.</p> 2816 * <p>A more detailed description of the noise model can be found in the 2817 * Adobe DNG specification for the NoiseProfile tag.</p> 2818 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2819 * 2820 * @see CameraCharacteristics#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT 2821 */ 2822 @PublicKey 2823 public static final Key<android.util.Pair<Double,Double>[]> SENSOR_NOISE_PROFILE = 2824 new Key<android.util.Pair<Double,Double>[]>("android.sensor.noiseProfile", new TypeReference<android.util.Pair<Double,Double>[]>() {{ }}); 2825 2826 /** 2827 * <p>The worst-case divergence between Bayer green channels.</p> 2828 * <p>This value is an estimate of the worst case split between the 2829 * Bayer green channels in the red and blue rows in the sensor color 2830 * filter array.</p> 2831 * <p>The green split is calculated as follows:</p> 2832 * <ol> 2833 * <li>A 5x5 pixel (or larger) window W within the active sensor array is 2834 * chosen. The term 'pixel' here is taken to mean a group of 4 Bayer 2835 * mosaic channels (R, Gr, Gb, B). The location and size of the window 2836 * chosen is implementation defined, and should be chosen to provide a 2837 * green split estimate that is both representative of the entire image 2838 * for this camera sensor, and can be calculated quickly.</li> 2839 * <li>The arithmetic mean of the green channels from the red 2840 * rows (mean_Gr) within W is computed.</li> 2841 * <li>The arithmetic mean of the green channels from the blue 2842 * rows (mean_Gb) within W is computed.</li> 2843 * <li>The maximum ratio R of the two means is computed as follows: 2844 * <code>R = max((mean_Gr + 1)/(mean_Gb + 1), (mean_Gb + 1)/(mean_Gr + 1))</code></li> 2845 * </ol> 2846 * <p>The ratio R is the green split divergence reported for this property, 2847 * which represents how much the green channels differ in the mosaic 2848 * pattern. This value is typically used to determine the treatment of 2849 * the green mosaic channels when demosaicing.</p> 2850 * <p>The green split value can be roughly interpreted as follows:</p> 2851 * <ul> 2852 * <li>R < 1.03 is a negligible split (<3% divergence).</li> 2853 * <li>1.20 <= R >= 1.03 will require some software 2854 * correction to avoid demosaic errors (3-20% divergence).</li> 2855 * <li>R > 1.20 will require strong software correction to produce 2856 * a usuable image (>20% divergence).</li> 2857 * </ul> 2858 * <p><b>Range of valid values:</b><br></p> 2859 * <p>>= 0</p> 2860 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2861 */ 2862 @PublicKey 2863 public static final Key<Float> SENSOR_GREEN_SPLIT = 2864 new Key<Float>("android.sensor.greenSplit", float.class); 2865 2866 /** 2867 * <p>A pixel <code>[R, G_even, G_odd, B]</code> that supplies the test pattern 2868 * when {@link CaptureRequest#SENSOR_TEST_PATTERN_MODE android.sensor.testPatternMode} is SOLID_COLOR.</p> 2869 * <p>Each color channel is treated as an unsigned 32-bit integer. 2870 * The camera device then uses the most significant X bits 2871 * that correspond to how many bits are in its Bayer raw sensor 2872 * output.</p> 2873 * <p>For example, a sensor with RAW10 Bayer output would use the 2874 * 10 most significant bits from each color channel.</p> 2875 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2876 * 2877 * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE 2878 */ 2879 @PublicKey 2880 public static final Key<int[]> SENSOR_TEST_PATTERN_DATA = 2881 new Key<int[]>("android.sensor.testPatternData", int[].class); 2882 2883 /** 2884 * <p>When enabled, the sensor sends a test pattern instead of 2885 * doing a real exposure from the camera.</p> 2886 * <p>When a test pattern is enabled, all manual sensor controls specified 2887 * by android.sensor.* will be ignored. All other controls should 2888 * work as normal.</p> 2889 * <p>For example, if manual flash is enabled, flash firing should still 2890 * occur (and that the test pattern remain unmodified, since the flash 2891 * would not actually affect it).</p> 2892 * <p>Defaults to OFF.</p> 2893 * <p><b>Possible values:</b> 2894 * <ul> 2895 * <li>{@link #SENSOR_TEST_PATTERN_MODE_OFF OFF}</li> 2896 * <li>{@link #SENSOR_TEST_PATTERN_MODE_SOLID_COLOR SOLID_COLOR}</li> 2897 * <li>{@link #SENSOR_TEST_PATTERN_MODE_COLOR_BARS COLOR_BARS}</li> 2898 * <li>{@link #SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY COLOR_BARS_FADE_TO_GRAY}</li> 2899 * <li>{@link #SENSOR_TEST_PATTERN_MODE_PN9 PN9}</li> 2900 * <li>{@link #SENSOR_TEST_PATTERN_MODE_CUSTOM1 CUSTOM1}</li> 2901 * </ul></p> 2902 * <p><b>Available values for this device:</b><br> 2903 * {@link CameraCharacteristics#SENSOR_AVAILABLE_TEST_PATTERN_MODES android.sensor.availableTestPatternModes}</p> 2904 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2905 * 2906 * @see CameraCharacteristics#SENSOR_AVAILABLE_TEST_PATTERN_MODES 2907 * @see #SENSOR_TEST_PATTERN_MODE_OFF 2908 * @see #SENSOR_TEST_PATTERN_MODE_SOLID_COLOR 2909 * @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS 2910 * @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY 2911 * @see #SENSOR_TEST_PATTERN_MODE_PN9 2912 * @see #SENSOR_TEST_PATTERN_MODE_CUSTOM1 2913 */ 2914 @PublicKey 2915 public static final Key<Integer> SENSOR_TEST_PATTERN_MODE = 2916 new Key<Integer>("android.sensor.testPatternMode", int.class); 2917 2918 /** 2919 * <p>Duration between the start of first row exposure 2920 * and the start of last row exposure.</p> 2921 * <p>This is the exposure time skew between the first and last 2922 * row exposure start times. The first row and the last row are 2923 * the first and last rows inside of the 2924 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.</p> 2925 * <p>For typical camera sensors that use rolling shutters, this is also equivalent 2926 * to the frame readout time.</p> 2927 * <p><b>Units</b>: Nanoseconds</p> 2928 * <p><b>Range of valid values:</b><br> 2929 * >= 0 and < 2930 * StreamConfigurationMap#getOutputMinFrameDuration(int, Size).</p> 2931 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2932 * <p><b>Limited capability</b> - 2933 * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the 2934 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2935 * 2936 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2937 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 2938 */ 2939 @PublicKey 2940 public static final Key<Long> SENSOR_ROLLING_SHUTTER_SKEW = 2941 new Key<Long>("android.sensor.rollingShutterSkew", long.class); 2942 2943 /** 2944 * <p>Quality of lens shading correction applied 2945 * to the image data.</p> 2946 * <p>When set to OFF mode, no lens shading correction will be applied by the 2947 * camera device, and an identity lens shading map data will be provided 2948 * if <code>{@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} == ON</code>. For example, for lens 2949 * shading map with size of <code>[ 4, 3 ]</code>, 2950 * the output {@link CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP android.statistics.lensShadingCorrectionMap} for this case will be an identity 2951 * map shown below:</p> 2952 * <pre><code>[ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2953 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2954 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2955 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2956 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2957 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] 2958 * </code></pre> 2959 * <p>When set to other modes, lens shading correction will be applied by the camera 2960 * device. Applications can request lens shading map data by setting 2961 * {@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} to ON, and then the camera device will provide lens 2962 * shading map data in {@link CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP android.statistics.lensShadingCorrectionMap}; the returned shading map 2963 * data will be the one applied by the camera device for this capture request.</p> 2964 * <p>The shading map data may depend on the auto-exposure (AE) and AWB statistics, therefore 2965 * the reliability of the map data may be affected by the AE and AWB algorithms. When AE and 2966 * AWB are in AUTO modes({@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} <code>!=</code> OFF and {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} <code>!=</code> 2967 * OFF), to get best results, it is recommended that the applications wait for the AE and AWB 2968 * to be converged before using the returned shading map data.</p> 2969 * <p><b>Possible values:</b> 2970 * <ul> 2971 * <li>{@link #SHADING_MODE_OFF OFF}</li> 2972 * <li>{@link #SHADING_MODE_FAST FAST}</li> 2973 * <li>{@link #SHADING_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 2974 * </ul></p> 2975 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2976 * <p><b>Full capability</b> - 2977 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 2978 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2979 * 2980 * @see CaptureRequest#CONTROL_AE_MODE 2981 * @see CaptureRequest#CONTROL_AWB_MODE 2982 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2983 * @see CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP 2984 * @see CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE 2985 * @see #SHADING_MODE_OFF 2986 * @see #SHADING_MODE_FAST 2987 * @see #SHADING_MODE_HIGH_QUALITY 2988 */ 2989 @PublicKey 2990 public static final Key<Integer> SHADING_MODE = 2991 new Key<Integer>("android.shading.mode", int.class); 2992 2993 /** 2994 * <p>Operating mode for the face detector 2995 * unit.</p> 2996 * <p>Whether face detection is enabled, and whether it 2997 * should output just the basic fields or the full set of 2998 * fields.</p> 2999 * <p><b>Possible values:</b> 3000 * <ul> 3001 * <li>{@link #STATISTICS_FACE_DETECT_MODE_OFF OFF}</li> 3002 * <li>{@link #STATISTICS_FACE_DETECT_MODE_SIMPLE SIMPLE}</li> 3003 * <li>{@link #STATISTICS_FACE_DETECT_MODE_FULL FULL}</li> 3004 * </ul></p> 3005 * <p><b>Available values for this device:</b><br> 3006 * {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES android.statistics.info.availableFaceDetectModes}</p> 3007 * <p>This key is available on all devices.</p> 3008 * 3009 * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES 3010 * @see #STATISTICS_FACE_DETECT_MODE_OFF 3011 * @see #STATISTICS_FACE_DETECT_MODE_SIMPLE 3012 * @see #STATISTICS_FACE_DETECT_MODE_FULL 3013 */ 3014 @PublicKey 3015 public static final Key<Integer> STATISTICS_FACE_DETECT_MODE = 3016 new Key<Integer>("android.statistics.faceDetectMode", int.class); 3017 3018 /** 3019 * <p>List of unique IDs for detected faces.</p> 3020 * <p>Each detected face is given a unique ID that is valid for as long as the face is visible 3021 * to the camera device. A face that leaves the field of view and later returns may be 3022 * assigned a new ID.</p> 3023 * <p>Only available if {@link CaptureRequest#STATISTICS_FACE_DETECT_MODE android.statistics.faceDetectMode} == FULL 3024 * This key is available on all devices.</p> 3025 * 3026 * @see CaptureRequest#STATISTICS_FACE_DETECT_MODE 3027 * @hide 3028 */ 3029 public static final Key<int[]> STATISTICS_FACE_IDS = 3030 new Key<int[]>("android.statistics.faceIds", int[].class); 3031 3032 /** 3033 * <p>List of landmarks for detected 3034 * faces.</p> 3035 * <p>The coordinate system is that of {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}, with 3036 * <code>(0, 0)</code> being the top-left pixel of the active array.</p> 3037 * <p>Only available if {@link CaptureRequest#STATISTICS_FACE_DETECT_MODE android.statistics.faceDetectMode} == FULL 3038 * This key is available on all devices.</p> 3039 * 3040 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 3041 * @see CaptureRequest#STATISTICS_FACE_DETECT_MODE 3042 * @hide 3043 */ 3044 public static final Key<int[]> STATISTICS_FACE_LANDMARKS = 3045 new Key<int[]>("android.statistics.faceLandmarks", int[].class); 3046 3047 /** 3048 * <p>List of the bounding rectangles for detected 3049 * faces.</p> 3050 * <p>The coordinate system is that of {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}, with 3051 * <code>(0, 0)</code> being the top-left pixel of the active array.</p> 3052 * <p>Only available if {@link CaptureRequest#STATISTICS_FACE_DETECT_MODE android.statistics.faceDetectMode} != OFF 3053 * This key is available on all devices.</p> 3054 * 3055 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 3056 * @see CaptureRequest#STATISTICS_FACE_DETECT_MODE 3057 * @hide 3058 */ 3059 public static final Key<android.graphics.Rect[]> STATISTICS_FACE_RECTANGLES = 3060 new Key<android.graphics.Rect[]>("android.statistics.faceRectangles", android.graphics.Rect[].class); 3061 3062 /** 3063 * <p>List of the face confidence scores for 3064 * detected faces</p> 3065 * <p>Only available if {@link CaptureRequest#STATISTICS_FACE_DETECT_MODE android.statistics.faceDetectMode} != OFF.</p> 3066 * <p><b>Range of valid values:</b><br> 3067 * 1-100</p> 3068 * <p>This key is available on all devices.</p> 3069 * 3070 * @see CaptureRequest#STATISTICS_FACE_DETECT_MODE 3071 * @hide 3072 */ 3073 public static final Key<byte[]> STATISTICS_FACE_SCORES = 3074 new Key<byte[]>("android.statistics.faceScores", byte[].class); 3075 3076 /** 3077 * <p>List of the faces detected through camera face detection 3078 * in this capture.</p> 3079 * <p>Only available if {@link CaptureRequest#STATISTICS_FACE_DETECT_MODE android.statistics.faceDetectMode} <code>!=</code> OFF.</p> 3080 * <p>This key is available on all devices.</p> 3081 * 3082 * @see CaptureRequest#STATISTICS_FACE_DETECT_MODE 3083 */ 3084 @PublicKey 3085 @SyntheticKey 3086 public static final Key<android.hardware.camera2.params.Face[]> STATISTICS_FACES = 3087 new Key<android.hardware.camera2.params.Face[]>("android.statistics.faces", android.hardware.camera2.params.Face[].class); 3088 3089 /** 3090 * <p>The shading map is a low-resolution floating-point map 3091 * that lists the coefficients used to correct for vignetting, for each 3092 * Bayer color channel.</p> 3093 * <p>The least shaded section of the image should have a gain factor 3094 * of 1; all other sections should have gains above 1.</p> 3095 * <p>When {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} = TRANSFORM_MATRIX, the map 3096 * must take into account the colorCorrection settings.</p> 3097 * <p>The shading map is for the entire active pixel array, and is not 3098 * affected by the crop region specified in the request. Each shading map 3099 * entry is the value of the shading compensation map over a specific 3100 * pixel on the sensor. Specifically, with a (N x M) resolution shading 3101 * map, and an active pixel array size (W x H), shading map entry 3102 * (x,y) ϵ (0 ... N-1, 0 ... M-1) is the value of the shading map at 3103 * pixel ( ((W-1)/(N-1)) * x, ((H-1)/(M-1)) * y) for the four color channels. 3104 * The map is assumed to be bilinearly interpolated between the sample points.</p> 3105 * <p>The channel order is [R, Geven, Godd, B], where Geven is the green 3106 * channel for the even rows of a Bayer pattern, and Godd is the odd rows. 3107 * The shading map is stored in a fully interleaved format.</p> 3108 * <p>The shading map should have on the order of 30-40 rows and columns, 3109 * and must be smaller than 64x64.</p> 3110 * <p>As an example, given a very small map defined as:</p> 3111 * <pre><code>width,height = [ 4, 3 ] 3112 * values = 3113 * [ 1.3, 1.2, 1.15, 1.2, 1.2, 1.2, 1.15, 1.2, 3114 * 1.1, 1.2, 1.2, 1.2, 1.3, 1.2, 1.3, 1.3, 3115 * 1.2, 1.2, 1.25, 1.1, 1.1, 1.1, 1.1, 1.0, 3116 * 1.0, 1.0, 1.0, 1.0, 1.2, 1.3, 1.25, 1.2, 3117 * 1.3, 1.2, 1.2, 1.3, 1.2, 1.15, 1.1, 1.2, 3118 * 1.2, 1.1, 1.0, 1.2, 1.3, 1.15, 1.2, 1.3 ] 3119 * </code></pre> 3120 * <p>The low-resolution scaling map images for each channel are 3121 * (displayed using nearest-neighbor interpolation):</p> 3122 * <p><img alt="Red lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/red_shading.png" /> 3123 * <img alt="Green (even rows) lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/green_e_shading.png" /> 3124 * <img alt="Green (odd rows) lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/green_o_shading.png" /> 3125 * <img alt="Blue lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/blue_shading.png" /></p> 3126 * <p>As a visualization only, inverting the full-color map to recover an 3127 * image of a gray wall (using bicubic interpolation for visual quality) as captured by the sensor gives:</p> 3128 * <p><img alt="Image of a uniform white wall (inverse shading map)" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/inv_shading.png" /></p> 3129 * <p><b>Range of valid values:</b><br> 3130 * Each gain factor is >= 1</p> 3131 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 3132 * <p><b>Full capability</b> - 3133 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 3134 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 3135 * 3136 * @see CaptureRequest#COLOR_CORRECTION_MODE 3137 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 3138 */ 3139 @PublicKey 3140 public static final Key<android.hardware.camera2.params.LensShadingMap> STATISTICS_LENS_SHADING_CORRECTION_MAP = 3141 new Key<android.hardware.camera2.params.LensShadingMap>("android.statistics.lensShadingCorrectionMap", android.hardware.camera2.params.LensShadingMap.class); 3142 3143 /** 3144 * <p>The shading map is a low-resolution floating-point map 3145 * that lists the coefficients used to correct for vignetting, for each 3146 * Bayer color channel.</p> 3147 * <p>The least shaded section of the image should have a gain factor 3148 * of 1; all other sections should have gains above 1.</p> 3149 * <p>When {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} = TRANSFORM_MATRIX, the map 3150 * must take into account the colorCorrection settings.</p> 3151 * <p>The shading map is for the entire active pixel array, and is not 3152 * affected by the crop region specified in the request. Each shading map 3153 * entry is the value of the shading compensation map over a specific 3154 * pixel on the sensor. Specifically, with a (N x M) resolution shading 3155 * map, and an active pixel array size (W x H), shading map entry 3156 * (x,y) ϵ (0 ... N-1, 0 ... M-1) is the value of the shading map at 3157 * pixel ( ((W-1)/(N-1)) * x, ((H-1)/(M-1)) * y) for the four color channels. 3158 * The map is assumed to be bilinearly interpolated between the sample points.</p> 3159 * <p>The channel order is [R, Geven, Godd, B], where Geven is the green 3160 * channel for the even rows of a Bayer pattern, and Godd is the odd rows. 3161 * The shading map is stored in a fully interleaved format, and its size 3162 * is provided in the camera static metadata by android.lens.info.shadingMapSize.</p> 3163 * <p>The shading map should have on the order of 30-40 rows and columns, 3164 * and must be smaller than 64x64.</p> 3165 * <p>As an example, given a very small map defined as:</p> 3166 * <pre><code>android.lens.info.shadingMapSize = [ 4, 3 ] 3167 * android.statistics.lensShadingMap = 3168 * [ 1.3, 1.2, 1.15, 1.2, 1.2, 1.2, 1.15, 1.2, 3169 * 1.1, 1.2, 1.2, 1.2, 1.3, 1.2, 1.3, 1.3, 3170 * 1.2, 1.2, 1.25, 1.1, 1.1, 1.1, 1.1, 1.0, 3171 * 1.0, 1.0, 1.0, 1.0, 1.2, 1.3, 1.25, 1.2, 3172 * 1.3, 1.2, 1.2, 1.3, 1.2, 1.15, 1.1, 1.2, 3173 * 1.2, 1.1, 1.0, 1.2, 1.3, 1.15, 1.2, 1.3 ] 3174 * </code></pre> 3175 * <p>The low-resolution scaling map images for each channel are 3176 * (displayed using nearest-neighbor interpolation):</p> 3177 * <p><img alt="Red lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/red_shading.png" /> 3178 * <img alt="Green (even rows) lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/green_e_shading.png" /> 3179 * <img alt="Green (odd rows) lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/green_o_shading.png" /> 3180 * <img alt="Blue lens shading map" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/blue_shading.png" /></p> 3181 * <p>As a visualization only, inverting the full-color map to recover an 3182 * image of a gray wall (using bicubic interpolation for visual quality) as captured by the sensor gives:</p> 3183 * <p><img alt="Image of a uniform white wall (inverse shading map)" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/inv_shading.png" /></p> 3184 * <p><b>Range of valid values:</b><br> 3185 * Each gain factor is >= 1</p> 3186 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 3187 * <p><b>Full capability</b> - 3188 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 3189 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 3190 * 3191 * @see CaptureRequest#COLOR_CORRECTION_MODE 3192 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 3193 * @hide 3194 */ 3195 public static final Key<float[]> STATISTICS_LENS_SHADING_MAP = 3196 new Key<float[]>("android.statistics.lensShadingMap", float[].class); 3197 3198 /** 3199 * <p>The best-fit color channel gains calculated 3200 * by the camera device's statistics units for the current output frame.</p> 3201 * <p>This may be different than the gains used for this frame, 3202 * since statistics processing on data from a new frame 3203 * typically completes after the transform has already been 3204 * applied to that frame.</p> 3205 * <p>The 4 channel gains are defined in Bayer domain, 3206 * see {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} for details.</p> 3207 * <p>This value should always be calculated by the auto-white balance (AWB) block, 3208 * regardless of the android.control.* current values.</p> 3209 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 3210 * 3211 * @see CaptureRequest#COLOR_CORRECTION_GAINS 3212 * @deprecated 3213 * @hide 3214 */ 3215 @Deprecated 3216 public static final Key<float[]> STATISTICS_PREDICTED_COLOR_GAINS = 3217 new Key<float[]>("android.statistics.predictedColorGains", float[].class); 3218 3219 /** 3220 * <p>The best-fit color transform matrix estimate 3221 * calculated by the camera device's statistics units for the current 3222 * output frame.</p> 3223 * <p>The camera device will provide the estimate from its 3224 * statistics unit on the white balance transforms to use 3225 * for the next frame. These are the values the camera device believes 3226 * are the best fit for the current output frame. This may 3227 * be different than the transform used for this frame, since 3228 * statistics processing on data from a new frame typically 3229 * completes after the transform has already been applied to 3230 * that frame.</p> 3231 * <p>These estimates must be provided for all frames, even if 3232 * capture settings and color transforms are set by the application.</p> 3233 * <p>This value should always be calculated by the auto-white balance (AWB) block, 3234 * regardless of the android.control.* current values.</p> 3235 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 3236 * @deprecated 3237 * @hide 3238 */ 3239 @Deprecated 3240 public static final Key<Rational[]> STATISTICS_PREDICTED_COLOR_TRANSFORM = 3241 new Key<Rational[]>("android.statistics.predictedColorTransform", Rational[].class); 3242 3243 /** 3244 * <p>The camera device estimated scene illumination lighting 3245 * frequency.</p> 3246 * <p>Many light sources, such as most fluorescent lights, flicker at a rate 3247 * that depends on the local utility power standards. This flicker must be 3248 * accounted for by auto-exposure routines to avoid artifacts in captured images. 3249 * The camera device uses this entry to tell the application what the scene 3250 * illuminant frequency is.</p> 3251 * <p>When manual exposure control is enabled 3252 * (<code>{@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} == OFF</code> or <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == 3253 * OFF</code>), the {@link CaptureRequest#CONTROL_AE_ANTIBANDING_MODE android.control.aeAntibandingMode} doesn't perform 3254 * antibanding, and the application can ensure it selects 3255 * exposure times that do not cause banding issues by looking 3256 * into this metadata field. See 3257 * {@link CaptureRequest#CONTROL_AE_ANTIBANDING_MODE android.control.aeAntibandingMode} for more details.</p> 3258 * <p>Reports NONE if there doesn't appear to be flickering illumination.</p> 3259 * <p><b>Possible values:</b> 3260 * <ul> 3261 * <li>{@link #STATISTICS_SCENE_FLICKER_NONE NONE}</li> 3262 * <li>{@link #STATISTICS_SCENE_FLICKER_50HZ 50HZ}</li> 3263 * <li>{@link #STATISTICS_SCENE_FLICKER_60HZ 60HZ}</li> 3264 * </ul></p> 3265 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 3266 * <p><b>Full capability</b> - 3267 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 3268 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 3269 * 3270 * @see CaptureRequest#CONTROL_AE_ANTIBANDING_MODE 3271 * @see CaptureRequest#CONTROL_AE_MODE 3272 * @see CaptureRequest#CONTROL_MODE 3273 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 3274 * @see #STATISTICS_SCENE_FLICKER_NONE 3275 * @see #STATISTICS_SCENE_FLICKER_50HZ 3276 * @see #STATISTICS_SCENE_FLICKER_60HZ 3277 */ 3278 @PublicKey 3279 public static final Key<Integer> STATISTICS_SCENE_FLICKER = 3280 new Key<Integer>("android.statistics.sceneFlicker", int.class); 3281 3282 /** 3283 * <p>Operating mode for hot pixel map generation.</p> 3284 * <p>If set to <code>true</code>, a hot pixel map is returned in {@link CaptureResult#STATISTICS_HOT_PIXEL_MAP android.statistics.hotPixelMap}. 3285 * If set to <code>false</code>, no hot pixel map will be returned.</p> 3286 * <p><b>Range of valid values:</b><br> 3287 * {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES android.statistics.info.availableHotPixelMapModes}</p> 3288 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 3289 * 3290 * @see CaptureResult#STATISTICS_HOT_PIXEL_MAP 3291 * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES 3292 */ 3293 @PublicKey 3294 public static final Key<Boolean> STATISTICS_HOT_PIXEL_MAP_MODE = 3295 new Key<Boolean>("android.statistics.hotPixelMapMode", boolean.class); 3296 3297 /** 3298 * <p>List of <code>(x, y)</code> coordinates of hot/defective pixels on the sensor.</p> 3299 * <p>A coordinate <code>(x, y)</code> must lie between <code>(0, 0)</code>, and 3300 * <code>(width - 1, height - 1)</code> (inclusive), which are the top-left and 3301 * bottom-right of the pixel array, respectively. The width and 3302 * height dimensions are given in {@link CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE android.sensor.info.pixelArraySize}. 3303 * This may include hot pixels that lie outside of the active array 3304 * bounds given by {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.</p> 3305 * <p><b>Range of valid values:</b><br></p> 3306 * <p>n <= number of pixels on the sensor. 3307 * The <code>(x, y)</code> coordinates must be bounded by 3308 * {@link CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE android.sensor.info.pixelArraySize}.</p> 3309 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 3310 * 3311 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 3312 * @see CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE 3313 */ 3314 @PublicKey 3315 public static final Key<android.graphics.Point[]> STATISTICS_HOT_PIXEL_MAP = 3316 new Key<android.graphics.Point[]>("android.statistics.hotPixelMap", android.graphics.Point[].class); 3317 3318 /** 3319 * <p>Whether the camera device will output the lens 3320 * shading map in output result metadata.</p> 3321 * <p>When set to ON, 3322 * android.statistics.lensShadingMap will be provided in 3323 * the output result metadata.</p> 3324 * <p>ON is always supported on devices with the RAW capability.</p> 3325 * <p><b>Possible values:</b> 3326 * <ul> 3327 * <li>{@link #STATISTICS_LENS_SHADING_MAP_MODE_OFF OFF}</li> 3328 * <li>{@link #STATISTICS_LENS_SHADING_MAP_MODE_ON ON}</li> 3329 * </ul></p> 3330 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 3331 * <p><b>Full capability</b> - 3332 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 3333 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 3334 * 3335 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 3336 * @see #STATISTICS_LENS_SHADING_MAP_MODE_OFF 3337 * @see #STATISTICS_LENS_SHADING_MAP_MODE_ON 3338 */ 3339 @PublicKey 3340 public static final Key<Integer> STATISTICS_LENS_SHADING_MAP_MODE = 3341 new Key<Integer>("android.statistics.lensShadingMapMode", int.class); 3342 3343 /** 3344 * <p>Tonemapping / contrast / gamma curve for the blue 3345 * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 3346 * CONTRAST_CURVE.</p> 3347 * <p>See android.tonemap.curveRed for more details.</p> 3348 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 3349 * <p><b>Full capability</b> - 3350 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 3351 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 3352 * 3353 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 3354 * @see CaptureRequest#TONEMAP_MODE 3355 * @hide 3356 */ 3357 public static final Key<float[]> TONEMAP_CURVE_BLUE = 3358 new Key<float[]>("android.tonemap.curveBlue", float[].class); 3359 3360 /** 3361 * <p>Tonemapping / contrast / gamma curve for the green 3362 * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 3363 * CONTRAST_CURVE.</p> 3364 * <p>See android.tonemap.curveRed for more details.</p> 3365 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 3366 * <p><b>Full capability</b> - 3367 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 3368 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 3369 * 3370 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 3371 * @see CaptureRequest#TONEMAP_MODE 3372 * @hide 3373 */ 3374 public static final Key<float[]> TONEMAP_CURVE_GREEN = 3375 new Key<float[]>("android.tonemap.curveGreen", float[].class); 3376 3377 /** 3378 * <p>Tonemapping / contrast / gamma curve for the red 3379 * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 3380 * CONTRAST_CURVE.</p> 3381 * <p>Each channel's curve is defined by an array of control points:</p> 3382 * <pre><code>android.tonemap.curveRed = 3383 * [ P0in, P0out, P1in, P1out, P2in, P2out, P3in, P3out, ..., PNin, PNout ] 3384 * 2 <= N <= {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</code></pre> 3385 * <p>These are sorted in order of increasing <code>Pin</code>; it is 3386 * required that input values 0.0 and 1.0 are included in the list to 3387 * define a complete mapping. For input values between control points, 3388 * the camera device must linearly interpolate between the control 3389 * points.</p> 3390 * <p>Each curve can have an independent number of points, and the number 3391 * of points can be less than max (that is, the request doesn't have to 3392 * always provide a curve with number of points equivalent to 3393 * {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}).</p> 3394 * <p>A few examples, and their corresponding graphical mappings; these 3395 * only specify the red channel and the precision is limited to 4 3396 * digits, for conciseness.</p> 3397 * <p>Linear mapping:</p> 3398 * <pre><code>android.tonemap.curveRed = [ 0, 0, 1.0, 1.0 ] 3399 * </code></pre> 3400 * <p><img alt="Linear mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png" /></p> 3401 * <p>Invert mapping:</p> 3402 * <pre><code>android.tonemap.curveRed = [ 0, 1.0, 1.0, 0 ] 3403 * </code></pre> 3404 * <p><img alt="Inverting mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png" /></p> 3405 * <p>Gamma 1/2.2 mapping, with 16 control points:</p> 3406 * <pre><code>android.tonemap.curveRed = [ 3407 * 0.0000, 0.0000, 0.0667, 0.2920, 0.1333, 0.4002, 0.2000, 0.4812, 3408 * 0.2667, 0.5484, 0.3333, 0.6069, 0.4000, 0.6594, 0.4667, 0.7072, 3409 * 0.5333, 0.7515, 0.6000, 0.7928, 0.6667, 0.8317, 0.7333, 0.8685, 3410 * 0.8000, 0.9035, 0.8667, 0.9370, 0.9333, 0.9691, 1.0000, 1.0000 ] 3411 * </code></pre> 3412 * <p><img alt="Gamma = 1/2.2 tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png" /></p> 3413 * <p>Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:</p> 3414 * <pre><code>android.tonemap.curveRed = [ 3415 * 0.0000, 0.0000, 0.0667, 0.2864, 0.1333, 0.4007, 0.2000, 0.4845, 3416 * 0.2667, 0.5532, 0.3333, 0.6125, 0.4000, 0.6652, 0.4667, 0.7130, 3417 * 0.5333, 0.7569, 0.6000, 0.7977, 0.6667, 0.8360, 0.7333, 0.8721, 3418 * 0.8000, 0.9063, 0.8667, 0.9389, 0.9333, 0.9701, 1.0000, 1.0000 ] 3419 * </code></pre> 3420 * <p><img alt="sRGB tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p> 3421 * <p><b>Range of valid values:</b><br> 3422 * 0-1 on both input and output coordinates, normalized 3423 * as a floating-point value such that 0 == black and 1 == white.</p> 3424 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 3425 * <p><b>Full capability</b> - 3426 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 3427 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 3428 * 3429 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 3430 * @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS 3431 * @see CaptureRequest#TONEMAP_MODE 3432 * @hide 3433 */ 3434 public static final Key<float[]> TONEMAP_CURVE_RED = 3435 new Key<float[]>("android.tonemap.curveRed", float[].class); 3436 3437 /** 3438 * <p>Tonemapping / contrast / gamma curve to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} 3439 * is CONTRAST_CURVE.</p> 3440 * <p>The tonemapCurve consist of three curves for each of red, green, and blue 3441 * channels respectively. The following example uses the red channel as an 3442 * example. The same logic applies to green and blue channel. 3443 * Each channel's curve is defined by an array of control points:</p> 3444 * <pre><code>curveRed = 3445 * [ P0(in, out), P1(in, out), P2(in, out), P3(in, out), ..., PN(in, out) ] 3446 * 2 <= N <= {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</code></pre> 3447 * <p>These are sorted in order of increasing <code>Pin</code>; it is always 3448 * guaranteed that input values 0.0 and 1.0 are included in the list to 3449 * define a complete mapping. For input values between control points, 3450 * the camera device must linearly interpolate between the control 3451 * points.</p> 3452 * <p>Each curve can have an independent number of points, and the number 3453 * of points can be less than max (that is, the request doesn't have to 3454 * always provide a curve with number of points equivalent to 3455 * {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}).</p> 3456 * <p>A few examples, and their corresponding graphical mappings; these 3457 * only specify the red channel and the precision is limited to 4 3458 * digits, for conciseness.</p> 3459 * <p>Linear mapping:</p> 3460 * <pre><code>curveRed = [ (0, 0), (1.0, 1.0) ] 3461 * </code></pre> 3462 * <p><img alt="Linear mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png" /></p> 3463 * <p>Invert mapping:</p> 3464 * <pre><code>curveRed = [ (0, 1.0), (1.0, 0) ] 3465 * </code></pre> 3466 * <p><img alt="Inverting mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png" /></p> 3467 * <p>Gamma 1/2.2 mapping, with 16 control points:</p> 3468 * <pre><code>curveRed = [ 3469 * (0.0000, 0.0000), (0.0667, 0.2920), (0.1333, 0.4002), (0.2000, 0.4812), 3470 * (0.2667, 0.5484), (0.3333, 0.6069), (0.4000, 0.6594), (0.4667, 0.7072), 3471 * (0.5333, 0.7515), (0.6000, 0.7928), (0.6667, 0.8317), (0.7333, 0.8685), 3472 * (0.8000, 0.9035), (0.8667, 0.9370), (0.9333, 0.9691), (1.0000, 1.0000) ] 3473 * </code></pre> 3474 * <p><img alt="Gamma = 1/2.2 tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png" /></p> 3475 * <p>Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:</p> 3476 * <pre><code>curveRed = [ 3477 * (0.0000, 0.0000), (0.0667, 0.2864), (0.1333, 0.4007), (0.2000, 0.4845), 3478 * (0.2667, 0.5532), (0.3333, 0.6125), (0.4000, 0.6652), (0.4667, 0.7130), 3479 * (0.5333, 0.7569), (0.6000, 0.7977), (0.6667, 0.8360), (0.7333, 0.8721), 3480 * (0.8000, 0.9063), (0.8667, 0.9389), (0.9333, 0.9701), (1.0000, 1.0000) ] 3481 * </code></pre> 3482 * <p><img alt="sRGB tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p> 3483 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 3484 * <p><b>Full capability</b> - 3485 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 3486 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 3487 * 3488 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 3489 * @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS 3490 * @see CaptureRequest#TONEMAP_MODE 3491 */ 3492 @PublicKey 3493 @SyntheticKey 3494 public static final Key<android.hardware.camera2.params.TonemapCurve> TONEMAP_CURVE = 3495 new Key<android.hardware.camera2.params.TonemapCurve>("android.tonemap.curve", android.hardware.camera2.params.TonemapCurve.class); 3496 3497 /** 3498 * <p>High-level global contrast/gamma/tonemapping control.</p> 3499 * <p>When switching to an application-defined contrast curve by setting 3500 * {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} to CONTRAST_CURVE, the curve is defined 3501 * per-channel with a set of <code>(in, out)</code> points that specify the 3502 * mapping from input high-bit-depth pixel value to the output 3503 * low-bit-depth value. Since the actual pixel ranges of both input 3504 * and output may change depending on the camera pipeline, the values 3505 * are specified by normalized floating-point numbers.</p> 3506 * <p>More-complex color mapping operations such as 3D color look-up 3507 * tables, selective chroma enhancement, or other non-linear color 3508 * transforms will be disabled when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 3509 * CONTRAST_CURVE.</p> 3510 * <p>When using either FAST or HIGH_QUALITY, the camera device will 3511 * emit its own tonemap curve in {@link CaptureRequest#TONEMAP_CURVE android.tonemap.curve}. 3512 * These values are always available, and as close as possible to the 3513 * actually used nonlinear/nonglobal transforms.</p> 3514 * <p>If a request is sent with CONTRAST_CURVE with the camera device's 3515 * provided curve in FAST or HIGH_QUALITY, the image's tonemap will be 3516 * roughly the same.</p> 3517 * <p><b>Possible values:</b> 3518 * <ul> 3519 * <li>{@link #TONEMAP_MODE_CONTRAST_CURVE CONTRAST_CURVE}</li> 3520 * <li>{@link #TONEMAP_MODE_FAST FAST}</li> 3521 * <li>{@link #TONEMAP_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 3522 * </ul></p> 3523 * <p><b>Available values for this device:</b><br> 3524 * {@link CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES android.tonemap.availableToneMapModes}</p> 3525 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 3526 * <p><b>Full capability</b> - 3527 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 3528 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 3529 * 3530 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 3531 * @see CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES 3532 * @see CaptureRequest#TONEMAP_CURVE 3533 * @see CaptureRequest#TONEMAP_MODE 3534 * @see #TONEMAP_MODE_CONTRAST_CURVE 3535 * @see #TONEMAP_MODE_FAST 3536 * @see #TONEMAP_MODE_HIGH_QUALITY 3537 */ 3538 @PublicKey 3539 public static final Key<Integer> TONEMAP_MODE = 3540 new Key<Integer>("android.tonemap.mode", int.class); 3541 3542 /** 3543 * <p>This LED is nominally used to indicate to the user 3544 * that the camera is powered on and may be streaming images back to the 3545 * Application Processor. In certain rare circumstances, the OS may 3546 * disable this when video is processed locally and not transmitted to 3547 * any untrusted applications.</p> 3548 * <p>In particular, the LED <em>must</em> always be on when the data could be 3549 * transmitted off the device. The LED <em>should</em> always be on whenever 3550 * data is stored locally on the device.</p> 3551 * <p>The LED <em>may</em> be off if a trusted application is using the data that 3552 * doesn't violate the above rules.</p> 3553 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 3554 * @hide 3555 */ 3556 public static final Key<Boolean> LED_TRANSMIT = 3557 new Key<Boolean>("android.led.transmit", boolean.class); 3558 3559 /** 3560 * <p>Whether black-level compensation is locked 3561 * to its current values, or is free to vary.</p> 3562 * <p>Whether the black level offset was locked for this frame. Should be 3563 * ON if {@link CaptureRequest#BLACK_LEVEL_LOCK android.blackLevel.lock} was ON in the capture request, unless 3564 * a change in other capture settings forced the camera device to 3565 * perform a black level reset.</p> 3566 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 3567 * <p><b>Full capability</b> - 3568 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 3569 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 3570 * 3571 * @see CaptureRequest#BLACK_LEVEL_LOCK 3572 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 3573 */ 3574 @PublicKey 3575 public static final Key<Boolean> BLACK_LEVEL_LOCK = 3576 new Key<Boolean>("android.blackLevel.lock", boolean.class); 3577 3578 /** 3579 * <p>The frame number corresponding to the last request 3580 * with which the output result (metadata + buffers) has been fully 3581 * synchronized.</p> 3582 * <p>When a request is submitted to the camera device, there is usually a 3583 * delay of several frames before the controls get applied. A camera 3584 * device may either choose to account for this delay by implementing a 3585 * pipeline and carefully submit well-timed atomic control updates, or 3586 * it may start streaming control changes that span over several frame 3587 * boundaries.</p> 3588 * <p>In the latter case, whenever a request's settings change relative to 3589 * the previous submitted request, the full set of changes may take 3590 * multiple frame durations to fully take effect. Some settings may 3591 * take effect sooner (in less frame durations) than others.</p> 3592 * <p>While a set of control changes are being propagated, this value 3593 * will be CONVERGING.</p> 3594 * <p>Once it is fully known that a set of control changes have been 3595 * finished propagating, and the resulting updated control settings 3596 * have been read back by the camera device, this value will be set 3597 * to a non-negative frame number (corresponding to the request to 3598 * which the results have synchronized to).</p> 3599 * <p>Older camera device implementations may not have a way to detect 3600 * when all camera controls have been applied, and will always set this 3601 * value to UNKNOWN.</p> 3602 * <p>FULL capability devices will always have this value set to the 3603 * frame number of the request corresponding to this result.</p> 3604 * <p><em>Further details</em>:</p> 3605 * <ul> 3606 * <li>Whenever a request differs from the last request, any future 3607 * results not yet returned may have this value set to CONVERGING (this 3608 * could include any in-progress captures not yet returned by the camera 3609 * device, for more details see pipeline considerations below).</li> 3610 * <li>Submitting a series of multiple requests that differ from the 3611 * previous request (e.g. r1, r2, r3 s.t. r1 != r2 != r3) 3612 * moves the new synchronization frame to the last non-repeating 3613 * request (using the smallest frame number from the contiguous list of 3614 * repeating requests).</li> 3615 * <li>Submitting the same request repeatedly will not change this value 3616 * to CONVERGING, if it was already a non-negative value.</li> 3617 * <li>When this value changes to non-negative, that means that all of the 3618 * metadata controls from the request have been applied, all of the 3619 * metadata controls from the camera device have been read to the 3620 * updated values (into the result), and all of the graphics buffers 3621 * corresponding to this result are also synchronized to the request.</li> 3622 * </ul> 3623 * <p><em>Pipeline considerations</em>:</p> 3624 * <p>Submitting a request with updated controls relative to the previously 3625 * submitted requests may also invalidate the synchronization state 3626 * of all the results corresponding to currently in-flight requests.</p> 3627 * <p>In other words, results for this current request and up to 3628 * {@link CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH android.request.pipelineMaxDepth} prior requests may have their 3629 * android.sync.frameNumber change to CONVERGING.</p> 3630 * <p><b>Possible values:</b> 3631 * <ul> 3632 * <li>{@link #SYNC_FRAME_NUMBER_CONVERGING CONVERGING}</li> 3633 * <li>{@link #SYNC_FRAME_NUMBER_UNKNOWN UNKNOWN}</li> 3634 * </ul></p> 3635 * <p><b>Available values for this device:</b><br> 3636 * Either a non-negative value corresponding to a 3637 * <code>frame_number</code>, or one of the two enums (CONVERGING / UNKNOWN).</p> 3638 * <p>This key is available on all devices.</p> 3639 * 3640 * @see CameraCharacteristics#REQUEST_PIPELINE_MAX_DEPTH 3641 * @see #SYNC_FRAME_NUMBER_CONVERGING 3642 * @see #SYNC_FRAME_NUMBER_UNKNOWN 3643 * @hide 3644 */ 3645 public static final Key<Long> SYNC_FRAME_NUMBER = 3646 new Key<Long>("android.sync.frameNumber", long.class); 3647 3648 /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ 3649 * End generated code 3650 *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/ 3651 3652 3653 3654} 3655
