CaptureRequest.java revision 8490ace76fd350e53de9554c11fca715c5a37aaf
1/* 2 * Copyright (C) 2013 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.CameraCharacteristics.Key; 20import android.hardware.camera2.impl.CameraMetadataNative; 21import android.hardware.camera2.utils.TypeReference; 22import android.os.Parcel; 23import android.os.Parcelable; 24import android.util.Rational; 25import android.view.Surface; 26 27import java.util.Collection; 28import java.util.Collections; 29import java.util.HashSet; 30import java.util.List; 31import java.util.Objects; 32 33 34/** 35 * <p>An immutable package of settings and outputs needed to capture a single 36 * image from the camera device.</p> 37 * 38 * <p>Contains the configuration for the capture hardware (sensor, lens, flash), 39 * the processing pipeline, the control algorithms, and the output buffers. Also 40 * contains the list of target Surfaces to send image data to for this 41 * capture.</p> 42 * 43 * <p>CaptureRequests can be created by using a {@link Builder} instance, 44 * obtained by calling {@link CameraDevice#createCaptureRequest}</p> 45 * 46 * <p>CaptureRequests are given to {@link CameraDevice#capture} or 47 * {@link CameraDevice#setRepeatingRequest} to capture images from a camera.</p> 48 * 49 * <p>Each request can specify a different subset of target Surfaces for the 50 * camera to send the captured data to. All the surfaces used in a request must 51 * be part of the surface list given to the last call to 52 * {@link CameraDevice#configureOutputs}, when the request is submitted to the 53 * camera device.</p> 54 * 55 * <p>For example, a request meant for repeating preview might only include the 56 * Surface for the preview SurfaceView or SurfaceTexture, while a 57 * high-resolution still capture would also include a Surface from a ImageReader 58 * configured for high-resolution JPEG images.</p> 59 * 60 * @see CameraDevice#capture 61 * @see CameraDevice#setRepeatingRequest 62 * @see CameraDevice#createCaptureRequest 63 */ 64public final class CaptureRequest extends CameraMetadata<CaptureRequest.Key<?>> 65 implements Parcelable { 66 67 /** 68 * A {@code Key} is used to do capture request field lookups with 69 * {@link CaptureResult#get} or to set fields with 70 * {@link CaptureRequest.Builder#set(Key, Object)}. 71 * 72 * <p>For example, to set the crop rectangle for the next capture: 73 * <code><pre> 74 * Rect cropRectangle = new Rect(0, 0, 640, 480); 75 * captureRequestBuilder.set(SCALER_CROP_REGION, cropRectangle); 76 * </pre></code> 77 * </p> 78 * 79 * <p>To enumerate over all possible keys for {@link CaptureResult}, see 80 * {@link CameraCharacteristics#getAvailableCaptureResultKeys}.</p> 81 * 82 * @see CaptureResult#get 83 * @see CameraCharacteristics#getAvailableCaptureResultKeys 84 */ 85 public final static class Key<T> { 86 private final CameraMetadataNative.Key<T> mKey; 87 88 /** 89 * Visible for testing and vendor extensions only. 90 * 91 * @hide 92 */ 93 public Key(String name, Class<T> type) { 94 mKey = new CameraMetadataNative.Key<T>(name, type); 95 } 96 97 /** 98 * Visible for testing and vendor extensions only. 99 * 100 * @hide 101 */ 102 public Key(String name, TypeReference<T> typeReference) { 103 mKey = new CameraMetadataNative.Key<T>(name, typeReference); 104 } 105 106 /** 107 * Return a camelCase, period separated name formatted like: 108 * {@code "root.section[.subsections].name"}. 109 * 110 * <p>Built-in keys exposed by the Android SDK are always prefixed with {@code "android."}; 111 * keys that are device/platform-specific are prefixed with {@code "com."}.</p> 112 * 113 * <p>For example, {@code CameraCharacteristics.SCALER_STREAM_CONFIGURATION_MAP} would 114 * have a name of {@code "android.scaler.streamConfigurationMap"}; whereas a device 115 * specific key might look like {@code "com.google.nexus.data.private"}.</p> 116 * 117 * @return String representation of the key name 118 */ 119 public String getName() { 120 return mKey.getName(); 121 } 122 123 /** 124 * {@inheritDoc} 125 */ 126 @Override 127 public final int hashCode() { 128 return mKey.hashCode(); 129 } 130 131 /** 132 * {@inheritDoc} 133 */ 134 @SuppressWarnings("unchecked") 135 @Override 136 public final boolean equals(Object o) { 137 return o instanceof Key && ((Key<T>)o).mKey.equals(mKey); 138 } 139 140 /** 141 * Visible for CameraMetadataNative implementation only; do not use. 142 * 143 * TODO: Make this private or remove it altogether. 144 * 145 * @hide 146 */ 147 public CameraMetadataNative.Key<T> getNativeKey() { 148 return mKey; 149 } 150 151 @SuppressWarnings({ "unchecked" }) 152 /*package*/ Key(CameraMetadataNative.Key<?> nativeKey) { 153 mKey = (CameraMetadataNative.Key<T>) nativeKey; 154 } 155 } 156 157 private final HashSet<Surface> mSurfaceSet; 158 private final CameraMetadataNative mSettings; 159 160 private Object mUserTag; 161 162 /** 163 * Construct empty request. 164 * 165 * Used by Binder to unparcel this object only. 166 */ 167 private CaptureRequest() { 168 mSettings = new CameraMetadataNative(); 169 mSurfaceSet = new HashSet<Surface>(); 170 } 171 172 /** 173 * Clone from source capture request. 174 * 175 * Used by the Builder to create an immutable copy. 176 */ 177 @SuppressWarnings("unchecked") 178 private CaptureRequest(CaptureRequest source) { 179 mSettings = new CameraMetadataNative(source.mSettings); 180 mSurfaceSet = (HashSet<Surface>) source.mSurfaceSet.clone(); 181 mUserTag = source.mUserTag; 182 } 183 184 /** 185 * Take ownership of passed-in settings. 186 * 187 * Used by the Builder to create a mutable CaptureRequest. 188 */ 189 private CaptureRequest(CameraMetadataNative settings) { 190 mSettings = CameraMetadataNative.move(settings); 191 mSurfaceSet = new HashSet<Surface>(); 192 } 193 194 /** 195 * Get a capture request field value. 196 * 197 * <p>The field definitions can be found in {@link CaptureRequest}.</p> 198 * 199 * <p>Querying the value for the same key more than once will return a value 200 * which is equal to the previous queried value.</p> 201 * 202 * @throws IllegalArgumentException if the key was not valid 203 * 204 * @param key The result field to read. 205 * @return The value of that key, or {@code null} if the field is not set. 206 */ 207 public <T> T get(Key<T> key) { 208 return mSettings.get(key); 209 } 210 211 /** 212 * {@inheritDoc} 213 * @hide 214 */ 215 @SuppressWarnings("unchecked") 216 @Override 217 protected <T> T getProtected(Key<?> key) { 218 return (T) mSettings.get(key); 219 } 220 221 /** 222 * {@inheritDoc} 223 * @hide 224 */ 225 @SuppressWarnings("unchecked") 226 @Override 227 protected Class<Key<?>> getKeyClass() { 228 Object thisClass = Key.class; 229 return (Class<Key<?>>)thisClass; 230 } 231 232 /** 233 * {@inheritDoc} 234 */ 235 @Override 236 public List<Key<?>> getKeys() { 237 // Force the javadoc for this function to show up on the CaptureRequest page 238 return super.getKeys(); 239 } 240 241 /** 242 * Retrieve the tag for this request, if any. 243 * 244 * <p>This tag is not used for anything by the camera device, but can be 245 * used by an application to easily identify a CaptureRequest when it is 246 * returned by 247 * {@link CameraDevice.CaptureListener#onCaptureCompleted CaptureListener.onCaptureCompleted} 248 * </p> 249 * 250 * @return the last tag Object set on this request, or {@code null} if 251 * no tag has been set. 252 * @see Builder#setTag 253 */ 254 public Object getTag() { 255 return mUserTag; 256 } 257 258 /** 259 * Determine whether this CaptureRequest is equal to another CaptureRequest. 260 * 261 * <p>A request is considered equal to another is if it's set of key/values is equal, it's 262 * list of output surfaces is equal, and the user tag is equal.</p> 263 * 264 * @param other Another instance of CaptureRequest. 265 * 266 * @return True if the requests are the same, false otherwise. 267 */ 268 @Override 269 public boolean equals(Object other) { 270 return other instanceof CaptureRequest 271 && equals((CaptureRequest)other); 272 } 273 274 private boolean equals(CaptureRequest other) { 275 return other != null 276 && Objects.equals(mUserTag, other.mUserTag) 277 && mSurfaceSet.equals(other.mSurfaceSet) 278 && mSettings.equals(other.mSettings); 279 } 280 281 @Override 282 public int hashCode() { 283 return mSettings.hashCode(); 284 } 285 286 public static final Parcelable.Creator<CaptureRequest> CREATOR = 287 new Parcelable.Creator<CaptureRequest>() { 288 @Override 289 public CaptureRequest createFromParcel(Parcel in) { 290 CaptureRequest request = new CaptureRequest(); 291 request.readFromParcel(in); 292 293 return request; 294 } 295 296 @Override 297 public CaptureRequest[] newArray(int size) { 298 return new CaptureRequest[size]; 299 } 300 }; 301 302 /** 303 * Expand this object from a Parcel. 304 * Hidden since this breaks the immutability of CaptureRequest, but is 305 * needed to receive CaptureRequests with aidl. 306 * 307 * @param in The parcel from which the object should be read 308 * @hide 309 */ 310 private void readFromParcel(Parcel in) { 311 mSettings.readFromParcel(in); 312 313 mSurfaceSet.clear(); 314 315 Parcelable[] parcelableArray = in.readParcelableArray(Surface.class.getClassLoader()); 316 317 if (parcelableArray == null) { 318 return; 319 } 320 321 for (Parcelable p : parcelableArray) { 322 Surface s = (Surface) p; 323 mSurfaceSet.add(s); 324 } 325 } 326 327 @Override 328 public int describeContents() { 329 return 0; 330 } 331 332 @Override 333 public void writeToParcel(Parcel dest, int flags) { 334 mSettings.writeToParcel(dest, flags); 335 dest.writeParcelableArray(mSurfaceSet.toArray(new Surface[mSurfaceSet.size()]), flags); 336 } 337 338 /** 339 * @hide 340 */ 341 public boolean containsTarget(Surface surface) { 342 return mSurfaceSet.contains(surface); 343 } 344 345 /** 346 * @hide 347 */ 348 public Collection<Surface> getTargets() { 349 return Collections.unmodifiableCollection(mSurfaceSet); 350 } 351 352 /** 353 * A builder for capture requests. 354 * 355 * <p>To obtain a builder instance, use the 356 * {@link CameraDevice#createCaptureRequest} method, which initializes the 357 * request fields to one of the templates defined in {@link CameraDevice}. 358 * 359 * @see CameraDevice#createCaptureRequest 360 * @see #TEMPLATE_PREVIEW 361 * @see #TEMPLATE_RECORD 362 * @see #TEMPLATE_STILL_CAPTURE 363 * @see #TEMPLATE_VIDEO_SNAPSHOT 364 * @see #TEMPLATE_MANUAL 365 */ 366 public final static class Builder { 367 368 private final CaptureRequest mRequest; 369 370 /** 371 * Initialize the builder using the template; the request takes 372 * ownership of the template. 373 * 374 * @hide 375 */ 376 public Builder(CameraMetadataNative template) { 377 mRequest = new CaptureRequest(template); 378 } 379 380 /** 381 * <p>Add a surface to the list of targets for this request</p> 382 * 383 * <p>The Surface added must be one of the surfaces included in the most 384 * recent call to {@link CameraDevice#configureOutputs}, when the 385 * request is given to the camera device.</p> 386 * 387 * <p>Adding a target more than once has no effect.</p> 388 * 389 * @param outputTarget Surface to use as an output target for this request 390 */ 391 public void addTarget(Surface outputTarget) { 392 mRequest.mSurfaceSet.add(outputTarget); 393 } 394 395 /** 396 * <p>Remove a surface from the list of targets for this request.</p> 397 * 398 * <p>Removing a target that is not currently added has no effect.</p> 399 * 400 * @param outputTarget Surface to use as an output target for this request 401 */ 402 public void removeTarget(Surface outputTarget) { 403 mRequest.mSurfaceSet.remove(outputTarget); 404 } 405 406 /** 407 * Set a capture request field to a value. The field definitions can be 408 * found in {@link CaptureRequest}. 409 * 410 * @param key The metadata field to write. 411 * @param value The value to set the field to, which must be of a matching 412 * type to the key. 413 */ 414 public <T> void set(Key<T> key, T value) { 415 mRequest.mSettings.set(key, value); 416 } 417 418 /** 419 * Get a capture request field value. The field definitions can be 420 * found in {@link CaptureRequest}. 421 * 422 * @throws IllegalArgumentException if the key was not valid 423 * 424 * @param key The metadata field to read. 425 * @return The value of that key, or {@code null} if the field is not set. 426 */ 427 public <T> T get(Key<T> key) { 428 return mRequest.mSettings.get(key); 429 } 430 431 /** 432 * Set a tag for this request. 433 * 434 * <p>This tag is not used for anything by the camera device, but can be 435 * used by an application to easily identify a CaptureRequest when it is 436 * returned by 437 * {@link CameraDevice.CaptureListener#onCaptureCompleted CaptureListener.onCaptureCompleted} 438 * 439 * @param tag an arbitrary Object to store with this request 440 * @see CaptureRequest#getTag 441 */ 442 public void setTag(Object tag) { 443 mRequest.mUserTag = tag; 444 } 445 446 /** 447 * Build a request using the current target Surfaces and settings. 448 * 449 * @return A new capture request instance, ready for submission to the 450 * camera device. 451 */ 452 public CaptureRequest build() { 453 return new CaptureRequest(mRequest); 454 } 455 456 457 /** 458 * @hide 459 */ 460 public boolean isEmpty() { 461 return mRequest.mSettings.isEmpty(); 462 } 463 464 } 465 466 /*@O~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ 467 * The key entries below this point are generated from metadata 468 * definitions in /system/media/camera/docs. Do not modify by hand or 469 * modify the comment blocks at the start or end. 470 *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/ 471 472 473 /** 474 * <p>The mode control selects how the image data is converted from the 475 * sensor's native color into linear sRGB color.</p> 476 * <p>When auto-white balance is enabled with {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, this 477 * control is overridden by the AWB routine. When AWB is disabled, the 478 * application controls how the color mapping is performed.</p> 479 * <p>We define the expected processing pipeline below. For consistency 480 * across devices, this is always the case with TRANSFORM_MATRIX.</p> 481 * <p>When either FULL or HIGH_QUALITY is used, the camera device may 482 * do additional processing but {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and 483 * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} will still be provided by the 484 * camera device (in the results) and be roughly correct.</p> 485 * <p>Switching to TRANSFORM_MATRIX and using the data provided from 486 * FAST or HIGH_QUALITY will yield a picture with the same white point 487 * as what was produced by the camera device in the earlier frame.</p> 488 * <p>The expected processing pipeline is as follows:</p> 489 * <p><img alt="White balance processing pipeline" src="../../../../images/camera2/metadata/android.colorCorrection.mode/processing_pipeline.png" /></p> 490 * <p>The white balance is encoded by two values, a 4-channel white-balance 491 * gain vector (applied in the Bayer domain), and a 3x3 color transform 492 * matrix (applied after demosaic).</p> 493 * <p>The 4-channel white-balance gains are defined as:</p> 494 * <pre><code>{@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} = [ R G_even G_odd B ] 495 * </code></pre> 496 * <p>where <code>G_even</code> is the gain for green pixels on even rows of the 497 * output, and <code>G_odd</code> is the gain for green pixels on the odd rows. 498 * These may be identical for a given camera device implementation; if 499 * the camera device does not support a separate gain for even/odd green 500 * channels, it will use the <code>G_even</code> value, and write <code>G_odd</code> equal to 501 * <code>G_even</code> in the output result metadata.</p> 502 * <p>The matrices for color transforms are defined as a 9-entry vector:</p> 503 * <pre><code>{@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} = [ I0 I1 I2 I3 I4 I5 I6 I7 I8 ] 504 * </code></pre> 505 * <p>which define a transform from input sensor colors, <code>P_in = [ r g b ]</code>, 506 * to output linear sRGB, <code>P_out = [ r' g' b' ]</code>,</p> 507 * <p>with colors as follows:</p> 508 * <pre><code>r' = I0r + I1g + I2b 509 * g' = I3r + I4g + I5b 510 * b' = I6r + I7g + I8b 511 * </code></pre> 512 * <p>Both the input and output value ranges must match. Overflow/underflow 513 * values are clipped to fit within the range.</p> 514 * 515 * @see CaptureRequest#COLOR_CORRECTION_GAINS 516 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM 517 * @see CaptureRequest#CONTROL_AWB_MODE 518 * @see #COLOR_CORRECTION_MODE_TRANSFORM_MATRIX 519 * @see #COLOR_CORRECTION_MODE_FAST 520 * @see #COLOR_CORRECTION_MODE_HIGH_QUALITY 521 */ 522 public static final Key<Integer> COLOR_CORRECTION_MODE = 523 new Key<Integer>("android.colorCorrection.mode", int.class); 524 525 /** 526 * <p>A color transform matrix to use to transform 527 * from sensor RGB color space to output linear sRGB color space</p> 528 * <p>This matrix is either set by the camera device when the request 529 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not TRANSFORM_MATRIX, or 530 * directly by the application in the request when the 531 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is TRANSFORM_MATRIX.</p> 532 * <p>In the latter case, the camera device may round the matrix to account 533 * for precision issues; the final rounded matrix should be reported back 534 * in this matrix result metadata. The transform should keep the magnitude 535 * of the output color values within <code>[0, 1.0]</code> (assuming input color 536 * values is within the normalized range <code>[0, 1.0]</code>), or clipping may occur.</p> 537 * 538 * @see CaptureRequest#COLOR_CORRECTION_MODE 539 */ 540 public static final Key<android.hardware.camera2.params.ColorSpaceTransform> COLOR_CORRECTION_TRANSFORM = 541 new Key<android.hardware.camera2.params.ColorSpaceTransform>("android.colorCorrection.transform", android.hardware.camera2.params.ColorSpaceTransform.class); 542 543 /** 544 * <p>Gains applying to Bayer raw color channels for 545 * white-balance.</p> 546 * <p>These per-channel gains are either set by the camera device 547 * when the request {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not 548 * TRANSFORM_MATRIX, or directly by the application in the 549 * request when the {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is 550 * TRANSFORM_MATRIX.</p> 551 * <p>The gains in the result metadata are the gains actually 552 * applied by the camera device to the current frame.</p> 553 * 554 * @see CaptureRequest#COLOR_CORRECTION_MODE 555 */ 556 public static final Key<android.hardware.camera2.params.RggbChannelVector> COLOR_CORRECTION_GAINS = 557 new Key<android.hardware.camera2.params.RggbChannelVector>("android.colorCorrection.gains", android.hardware.camera2.params.RggbChannelVector.class); 558 559 /** 560 * <p>The desired setting for the camera device's auto-exposure 561 * algorithm's antibanding compensation.</p> 562 * <p>Some kinds of lighting fixtures, such as some fluorescent 563 * lights, flicker at the rate of the power supply frequency 564 * (60Hz or 50Hz, depending on country). While this is 565 * typically not noticeable to a person, it can be visible to 566 * a camera device. If a camera sets its exposure time to the 567 * wrong value, the flicker may become visible in the 568 * viewfinder as flicker or in a final captured image, as a 569 * set of variable-brightness bands across the image.</p> 570 * <p>Therefore, the auto-exposure routines of camera devices 571 * include antibanding routines that ensure that the chosen 572 * exposure value will not cause such banding. The choice of 573 * exposure time depends on the rate of flicker, which the 574 * camera device can detect automatically, or the expected 575 * rate can be selected by the application using this 576 * control.</p> 577 * <p>A given camera device may not support all of the possible 578 * options for the antibanding mode. The 579 * {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES android.control.aeAvailableAntibandingModes} key contains 580 * the available modes for a given camera device.</p> 581 * <p>The default mode is AUTO, which must be supported by all 582 * camera devices.</p> 583 * <p>If manual exposure control is enabled (by setting 584 * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link CaptureRequest#CONTROL_MODE android.control.mode} to OFF), 585 * then this setting has no effect, and the application must 586 * ensure it selects exposure times that do not cause banding 587 * issues. The {@link CaptureResult#STATISTICS_SCENE_FLICKER android.statistics.sceneFlicker} key can assist 588 * the application in this.</p> 589 * 590 * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES 591 * @see CaptureRequest#CONTROL_AE_MODE 592 * @see CaptureRequest#CONTROL_MODE 593 * @see CaptureResult#STATISTICS_SCENE_FLICKER 594 * @see #CONTROL_AE_ANTIBANDING_MODE_OFF 595 * @see #CONTROL_AE_ANTIBANDING_MODE_50HZ 596 * @see #CONTROL_AE_ANTIBANDING_MODE_60HZ 597 * @see #CONTROL_AE_ANTIBANDING_MODE_AUTO 598 */ 599 public static final Key<Integer> CONTROL_AE_ANTIBANDING_MODE = 600 new Key<Integer>("android.control.aeAntibandingMode", int.class); 601 602 /** 603 * <p>Adjustment to AE target image 604 * brightness</p> 605 * <p>For example, if EV step is 0.333, '6' will mean an 606 * exposure compensation of +2 EV; -3 will mean an exposure 607 * compensation of -1 EV. Note that this control will only be effective 608 * if {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} <code>!=</code> OFF. This control will take effect even when 609 * {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} <code>== true</code>.</p> 610 * <p>In the event of exposure compensation value being changed, camera device 611 * may take several frames to reach the newly requested exposure target. 612 * During that time, {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} field will be in the SEARCHING 613 * state. Once the new exposure target is reached, {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} will 614 * change from SEARCHING to either CONVERGED, LOCKED (if AE lock is enabled), or 615 * FLASH_REQUIRED (if the scene is too dark for still capture).</p> 616 * 617 * @see CaptureRequest#CONTROL_AE_LOCK 618 * @see CaptureRequest#CONTROL_AE_MODE 619 * @see CaptureResult#CONTROL_AE_STATE 620 */ 621 public static final Key<Integer> CONTROL_AE_EXPOSURE_COMPENSATION = 622 new Key<Integer>("android.control.aeExposureCompensation", int.class); 623 624 /** 625 * <p>Whether AE is currently locked to its latest 626 * calculated values.</p> 627 * <p>Note that even when AE is locked, the flash may be 628 * fired if the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_AUTO_FLASH / ON_ALWAYS_FLASH / 629 * ON_AUTO_FLASH_REDEYE.</p> 630 * <p>When {@link CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION android.control.aeExposureCompensation} is changed, even if the AE lock 631 * is ON, the camera device will still adjust its exposure value.</p> 632 * <p>If AE precapture is triggered (see {@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}) 633 * when AE is already locked, the camera device will not change the exposure time 634 * ({@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}) and sensitivity ({@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}) 635 * parameters. The flash may be fired if the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} 636 * is ON_AUTO_FLASH/ON_AUTO_FLASH_REDEYE and the scene is too dark. If the 637 * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_ALWAYS_FLASH, the scene may become overexposed.</p> 638 * <p>See {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE lock related state transition details.</p> 639 * 640 * @see CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION 641 * @see CaptureRequest#CONTROL_AE_MODE 642 * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER 643 * @see CaptureResult#CONTROL_AE_STATE 644 * @see CaptureRequest#SENSOR_EXPOSURE_TIME 645 * @see CaptureRequest#SENSOR_SENSITIVITY 646 */ 647 public static final Key<Boolean> CONTROL_AE_LOCK = 648 new Key<Boolean>("android.control.aeLock", boolean.class); 649 650 /** 651 * <p>The desired mode for the camera device's 652 * auto-exposure routine.</p> 653 * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is 654 * AUTO.</p> 655 * <p>When set to any of the ON modes, the camera device's 656 * auto-exposure routine is enabled, overriding the 657 * application's selected exposure time, sensor sensitivity, 658 * and frame duration ({@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, 659 * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and 660 * {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}). If one of the FLASH modes 661 * is selected, the camera device's flash unit controls are 662 * also overridden.</p> 663 * <p>The FLASH modes are only available if the camera device 664 * has a flash unit ({@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} is <code>true</code>).</p> 665 * <p>If flash TORCH mode is desired, this field must be set to 666 * ON or OFF, and {@link CaptureRequest#FLASH_MODE android.flash.mode} set to TORCH.</p> 667 * <p>When set to any of the ON modes, the values chosen by the 668 * camera device auto-exposure routine for the overridden 669 * fields for a given capture will be available in its 670 * CaptureResult.</p> 671 * 672 * @see CaptureRequest#CONTROL_MODE 673 * @see CameraCharacteristics#FLASH_INFO_AVAILABLE 674 * @see CaptureRequest#FLASH_MODE 675 * @see CaptureRequest#SENSOR_EXPOSURE_TIME 676 * @see CaptureRequest#SENSOR_FRAME_DURATION 677 * @see CaptureRequest#SENSOR_SENSITIVITY 678 * @see #CONTROL_AE_MODE_OFF 679 * @see #CONTROL_AE_MODE_ON 680 * @see #CONTROL_AE_MODE_ON_AUTO_FLASH 681 * @see #CONTROL_AE_MODE_ON_ALWAYS_FLASH 682 * @see #CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE 683 */ 684 public static final Key<Integer> CONTROL_AE_MODE = 685 new Key<Integer>("android.control.aeMode", int.class); 686 687 /** 688 * <p>List of areas to use for 689 * metering.</p> 690 * <p>The coordinate system is based on the active pixel array, 691 * with (0,0) being the top-left pixel in the active pixel array, and 692 * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 693 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 694 * bottom-right pixel in the active pixel array. The weight 695 * should be nonnegative.</p> 696 * <p>If all regions have 0 weight, then no specific metering area 697 * needs to be used by the camera device. If the metering region is 698 * outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in capture result metadata, 699 * the camera device will ignore the sections outside the region and output the 700 * used sections in the result metadata.</p> 701 * 702 * @see CaptureRequest#SCALER_CROP_REGION 703 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 704 */ 705 public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AE_REGIONS = 706 new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.aeRegions", android.hardware.camera2.params.MeteringRectangle[].class); 707 708 /** 709 * <p>Range over which fps can be adjusted to 710 * maintain exposure</p> 711 * <p>Only constrains AE algorithm, not manual control 712 * of {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}</p> 713 * 714 * @see CaptureRequest#SENSOR_EXPOSURE_TIME 715 */ 716 public static final Key<android.util.Range<Integer>> CONTROL_AE_TARGET_FPS_RANGE = 717 new Key<android.util.Range<Integer>>("android.control.aeTargetFpsRange", new TypeReference<android.util.Range<Integer>>() {{ }}); 718 719 /** 720 * <p>Whether the camera device will trigger a precapture 721 * metering sequence when it processes this request.</p> 722 * <p>This entry is normally set to IDLE, or is not 723 * included at all in the request settings. When included and 724 * set to START, the camera device will trigger the autoexposure 725 * precapture metering sequence.</p> 726 * <p>The effect of AE precapture trigger depends on the current 727 * AE mode and state; see {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE precapture 728 * state transition details.</p> 729 * 730 * @see CaptureResult#CONTROL_AE_STATE 731 * @see #CONTROL_AE_PRECAPTURE_TRIGGER_IDLE 732 * @see #CONTROL_AE_PRECAPTURE_TRIGGER_START 733 */ 734 public static final Key<Integer> CONTROL_AE_PRECAPTURE_TRIGGER = 735 new Key<Integer>("android.control.aePrecaptureTrigger", int.class); 736 737 /** 738 * <p>Whether AF is currently enabled, and what 739 * mode it is set to</p> 740 * <p>Only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} = AUTO and the lens is not fixed focus 741 * (i.e. <code>{@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} > 0</code>).</p> 742 * <p>If the lens is controlled by the camera device auto-focus algorithm, 743 * the camera device will report the current AF status in {@link CaptureResult#CONTROL_AF_STATE android.control.afState} 744 * in result metadata.</p> 745 * 746 * @see CaptureResult#CONTROL_AF_STATE 747 * @see CaptureRequest#CONTROL_MODE 748 * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE 749 * @see #CONTROL_AF_MODE_OFF 750 * @see #CONTROL_AF_MODE_AUTO 751 * @see #CONTROL_AF_MODE_MACRO 752 * @see #CONTROL_AF_MODE_CONTINUOUS_VIDEO 753 * @see #CONTROL_AF_MODE_CONTINUOUS_PICTURE 754 * @see #CONTROL_AF_MODE_EDOF 755 */ 756 public static final Key<Integer> CONTROL_AF_MODE = 757 new Key<Integer>("android.control.afMode", int.class); 758 759 /** 760 * <p>List of areas to use for focus 761 * estimation.</p> 762 * <p>The coordinate system is based on the active pixel array, 763 * with (0,0) being the top-left pixel in the active pixel array, and 764 * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 765 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 766 * bottom-right pixel in the active pixel array. The weight 767 * should be nonnegative.</p> 768 * <p>If all regions have 0 weight, then no specific metering area 769 * needs to be used by the camera device. If the metering region is 770 * outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in capture result metadata, 771 * the camera device will ignore the sections outside the region and output the 772 * used sections in the result metadata.</p> 773 * 774 * @see CaptureRequest#SCALER_CROP_REGION 775 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 776 */ 777 public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AF_REGIONS = 778 new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.afRegions", android.hardware.camera2.params.MeteringRectangle[].class); 779 780 /** 781 * <p>Whether the camera device will trigger autofocus for this request.</p> 782 * <p>This entry is normally set to IDLE, or is not 783 * included at all in the request settings.</p> 784 * <p>When included and set to START, the camera device will trigger the 785 * autofocus algorithm. If autofocus is disabled, this trigger has no effect.</p> 786 * <p>When set to CANCEL, the camera device will cancel any active trigger, 787 * and return to its initial AF state.</p> 788 * <p>See {@link CaptureResult#CONTROL_AF_STATE android.control.afState} for what that means for each AF mode.</p> 789 * 790 * @see CaptureResult#CONTROL_AF_STATE 791 * @see #CONTROL_AF_TRIGGER_IDLE 792 * @see #CONTROL_AF_TRIGGER_START 793 * @see #CONTROL_AF_TRIGGER_CANCEL 794 */ 795 public static final Key<Integer> CONTROL_AF_TRIGGER = 796 new Key<Integer>("android.control.afTrigger", int.class); 797 798 /** 799 * <p>Whether AWB is currently locked to its 800 * latest calculated values.</p> 801 * <p>Note that AWB lock is only meaningful for AUTO 802 * mode; in other modes, AWB is already fixed to a specific 803 * setting.</p> 804 */ 805 public static final Key<Boolean> CONTROL_AWB_LOCK = 806 new Key<Boolean>("android.control.awbLock", boolean.class); 807 808 /** 809 * <p>Whether AWB is currently setting the color 810 * transform fields, and what its illumination target 811 * is.</p> 812 * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is AUTO.</p> 813 * <p>When set to the ON mode, the camera device's auto white balance 814 * routine is enabled, overriding the application's selected 815 * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and 816 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.</p> 817 * <p>When set to the OFF mode, the camera device's auto white balance 818 * routine is disabled. The application manually controls the white 819 * balance by {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} 820 * and {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.</p> 821 * <p>When set to any other modes, the camera device's auto white balance 822 * routine is disabled. The camera device uses each particular illumination 823 * target for white balance adjustment.</p> 824 * 825 * @see CaptureRequest#COLOR_CORRECTION_GAINS 826 * @see CaptureRequest#COLOR_CORRECTION_MODE 827 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM 828 * @see CaptureRequest#CONTROL_MODE 829 * @see #CONTROL_AWB_MODE_OFF 830 * @see #CONTROL_AWB_MODE_AUTO 831 * @see #CONTROL_AWB_MODE_INCANDESCENT 832 * @see #CONTROL_AWB_MODE_FLUORESCENT 833 * @see #CONTROL_AWB_MODE_WARM_FLUORESCENT 834 * @see #CONTROL_AWB_MODE_DAYLIGHT 835 * @see #CONTROL_AWB_MODE_CLOUDY_DAYLIGHT 836 * @see #CONTROL_AWB_MODE_TWILIGHT 837 * @see #CONTROL_AWB_MODE_SHADE 838 */ 839 public static final Key<Integer> CONTROL_AWB_MODE = 840 new Key<Integer>("android.control.awbMode", int.class); 841 842 /** 843 * <p>List of areas to use for illuminant 844 * estimation.</p> 845 * <p>The coordinate system is based on the active pixel array, 846 * with (0,0) being the top-left pixel in the active pixel array, and 847 * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 848 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 849 * bottom-right pixel in the active pixel array. The weight 850 * should be nonnegative.</p> 851 * <p>If all regions have 0 weight, then no specific metering area 852 * needs to be used by the camera device. If the metering region is 853 * outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in capture result metadata, 854 * the camera device will ignore the sections outside the region and output the 855 * used sections in the result metadata.</p> 856 * 857 * @see CaptureRequest#SCALER_CROP_REGION 858 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 859 */ 860 public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AWB_REGIONS = 861 new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.awbRegions", android.hardware.camera2.params.MeteringRectangle[].class); 862 863 /** 864 * <p>Information to the camera device 3A (auto-exposure, 865 * auto-focus, auto-white balance) routines about the purpose 866 * of this capture, to help the camera device to decide optimal 3A 867 * strategy.</p> 868 * <p>This control (except for MANUAL) is only effective if 869 * <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} != OFF</code> and any 3A routine is active.</p> 870 * <p>ZERO_SHUTTER_LAG must be supported if {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} 871 * contains ZSL. MANUAL must be supported if {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} 872 * contains MANUAL_SENSOR.</p> 873 * 874 * @see CaptureRequest#CONTROL_MODE 875 * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES 876 * @see #CONTROL_CAPTURE_INTENT_CUSTOM 877 * @see #CONTROL_CAPTURE_INTENT_PREVIEW 878 * @see #CONTROL_CAPTURE_INTENT_STILL_CAPTURE 879 * @see #CONTROL_CAPTURE_INTENT_VIDEO_RECORD 880 * @see #CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT 881 * @see #CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG 882 * @see #CONTROL_CAPTURE_INTENT_MANUAL 883 */ 884 public static final Key<Integer> CONTROL_CAPTURE_INTENT = 885 new Key<Integer>("android.control.captureIntent", int.class); 886 887 /** 888 * <p>A special color effect to apply.</p> 889 * <p>When this mode is set, a color effect will be applied 890 * to images produced by the camera device. The interpretation 891 * and implementation of these color effects is left to the 892 * implementor of the camera device, and should not be 893 * depended on to be consistent (or present) across all 894 * devices.</p> 895 * <p>A color effect will only be applied if 896 * {@link CaptureRequest#CONTROL_MODE android.control.mode} != OFF.</p> 897 * 898 * @see CaptureRequest#CONTROL_MODE 899 * @see #CONTROL_EFFECT_MODE_OFF 900 * @see #CONTROL_EFFECT_MODE_MONO 901 * @see #CONTROL_EFFECT_MODE_NEGATIVE 902 * @see #CONTROL_EFFECT_MODE_SOLARIZE 903 * @see #CONTROL_EFFECT_MODE_SEPIA 904 * @see #CONTROL_EFFECT_MODE_POSTERIZE 905 * @see #CONTROL_EFFECT_MODE_WHITEBOARD 906 * @see #CONTROL_EFFECT_MODE_BLACKBOARD 907 * @see #CONTROL_EFFECT_MODE_AQUA 908 */ 909 public static final Key<Integer> CONTROL_EFFECT_MODE = 910 new Key<Integer>("android.control.effectMode", int.class); 911 912 /** 913 * <p>Overall mode of 3A control 914 * routines.</p> 915 * <p>High-level 3A control. When set to OFF, all 3A control 916 * by the camera device is disabled. The application must set the fields for 917 * capture parameters itself.</p> 918 * <p>When set to AUTO, the individual algorithm controls in 919 * android.control.* are in effect, such as {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}.</p> 920 * <p>When set to USE_SCENE_MODE, the individual controls in 921 * android.control.* are mostly disabled, and the camera device implements 922 * one of the scene mode settings (such as ACTION, SUNSET, or PARTY) 923 * as it wishes. The camera device scene mode 3A settings are provided by 924 * android.control.sceneModeOverrides.</p> 925 * <p>When set to OFF_KEEP_STATE, it is similar to OFF mode, the only difference 926 * is that this frame will not be used by camera device background 3A statistics 927 * update, as if this frame is never captured. This mode can be used in the scenario 928 * where the application doesn't want a 3A manual control capture to affect 929 * the subsequent auto 3A capture results.</p> 930 * 931 * @see CaptureRequest#CONTROL_AF_MODE 932 * @see #CONTROL_MODE_OFF 933 * @see #CONTROL_MODE_AUTO 934 * @see #CONTROL_MODE_USE_SCENE_MODE 935 * @see #CONTROL_MODE_OFF_KEEP_STATE 936 */ 937 public static final Key<Integer> CONTROL_MODE = 938 new Key<Integer>("android.control.mode", int.class); 939 940 /** 941 * <p>A camera mode optimized for conditions typical in a particular 942 * capture setting.</p> 943 * <p>This is the mode that that is active when 944 * <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code>. Aside from FACE_PRIORITY, 945 * these modes will disable {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode}, 946 * {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, and {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} while in use.</p> 947 * <p>The interpretation and implementation of these scene modes is left 948 * to the implementor of the camera device. Their behavior will not be 949 * consistent across all devices, and any given device may only implement 950 * a subset of these modes.</p> 951 * 952 * @see CaptureRequest#CONTROL_AE_MODE 953 * @see CaptureRequest#CONTROL_AF_MODE 954 * @see CaptureRequest#CONTROL_AWB_MODE 955 * @see CaptureRequest#CONTROL_MODE 956 * @see #CONTROL_SCENE_MODE_DISABLED 957 * @see #CONTROL_SCENE_MODE_FACE_PRIORITY 958 * @see #CONTROL_SCENE_MODE_ACTION 959 * @see #CONTROL_SCENE_MODE_PORTRAIT 960 * @see #CONTROL_SCENE_MODE_LANDSCAPE 961 * @see #CONTROL_SCENE_MODE_NIGHT 962 * @see #CONTROL_SCENE_MODE_NIGHT_PORTRAIT 963 * @see #CONTROL_SCENE_MODE_THEATRE 964 * @see #CONTROL_SCENE_MODE_BEACH 965 * @see #CONTROL_SCENE_MODE_SNOW 966 * @see #CONTROL_SCENE_MODE_SUNSET 967 * @see #CONTROL_SCENE_MODE_STEADYPHOTO 968 * @see #CONTROL_SCENE_MODE_FIREWORKS 969 * @see #CONTROL_SCENE_MODE_SPORTS 970 * @see #CONTROL_SCENE_MODE_PARTY 971 * @see #CONTROL_SCENE_MODE_CANDLELIGHT 972 * @see #CONTROL_SCENE_MODE_BARCODE 973 */ 974 public static final Key<Integer> CONTROL_SCENE_MODE = 975 new Key<Integer>("android.control.sceneMode", int.class); 976 977 /** 978 * <p>Whether video stabilization is 979 * active</p> 980 * <p>If enabled, video stabilization can modify the 981 * {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} to keep the video stream 982 * stabilized</p> 983 * 984 * @see CaptureRequest#SCALER_CROP_REGION 985 * @see #CONTROL_VIDEO_STABILIZATION_MODE_OFF 986 * @see #CONTROL_VIDEO_STABILIZATION_MODE_ON 987 */ 988 public static final Key<Integer> CONTROL_VIDEO_STABILIZATION_MODE = 989 new Key<Integer>("android.control.videoStabilizationMode", int.class); 990 991 /** 992 * <p>Operation mode for edge 993 * enhancement.</p> 994 * <p>Edge/sharpness/detail enhancement. OFF means no 995 * enhancement will be applied by the camera device.</p> 996 * <p>This must be set to one of the modes listed in {@link CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES android.edge.availableEdgeModes}.</p> 997 * <p>FAST/HIGH_QUALITY both mean camera device determined enhancement 998 * will be applied. HIGH_QUALITY mode indicates that the 999 * camera device will use the highest-quality enhancement algorithms, 1000 * even if it slows down capture rate. FAST means the camera device will 1001 * not slow down capture rate when applying edge enhancement.</p> 1002 * 1003 * @see CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES 1004 * @see #EDGE_MODE_OFF 1005 * @see #EDGE_MODE_FAST 1006 * @see #EDGE_MODE_HIGH_QUALITY 1007 */ 1008 public static final Key<Integer> EDGE_MODE = 1009 new Key<Integer>("android.edge.mode", int.class); 1010 1011 /** 1012 * <p>The desired mode for for the camera device's flash control.</p> 1013 * <p>This control is only effective when flash unit is available 1014 * (<code>{@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} == true</code>).</p> 1015 * <p>When this control is used, the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} must be set to ON or OFF. 1016 * Otherwise, the camera device auto-exposure related flash control (ON_AUTO_FLASH, 1017 * ON_ALWAYS_FLASH, or ON_AUTO_FLASH_REDEYE) will override this control.</p> 1018 * <p>When set to OFF, the camera device will not fire flash for this capture.</p> 1019 * <p>When set to SINGLE, the camera device will fire flash regardless of the camera 1020 * device's auto-exposure routine's result. When used in still capture case, this 1021 * control should be used along with AE precapture metering sequence 1022 * ({@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}), otherwise, the image may be incorrectly exposed.</p> 1023 * <p>When set to TORCH, the flash will be on continuously. This mode can be used 1024 * for use cases such as preview, auto-focus assist, still capture, or video recording.</p> 1025 * <p>The flash status will be reported by {@link CaptureResult#FLASH_STATE android.flash.state} in the capture result metadata.</p> 1026 * 1027 * @see CaptureRequest#CONTROL_AE_MODE 1028 * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER 1029 * @see CameraCharacteristics#FLASH_INFO_AVAILABLE 1030 * @see CaptureResult#FLASH_STATE 1031 * @see #FLASH_MODE_OFF 1032 * @see #FLASH_MODE_SINGLE 1033 * @see #FLASH_MODE_TORCH 1034 */ 1035 public static final Key<Integer> FLASH_MODE = 1036 new Key<Integer>("android.flash.mode", int.class); 1037 1038 /** 1039 * <p>Set operational mode for hot pixel correction.</p> 1040 * <p>Valid modes for this camera device are listed in 1041 * {@link CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES android.hotPixel.availableHotPixelModes}.</p> 1042 * <p>Hotpixel correction interpolates out, or otherwise removes, pixels 1043 * that do not accurately encode the incoming light (i.e. pixels that 1044 * are stuck at an arbitrary value).</p> 1045 * 1046 * @see CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES 1047 * @see #HOT_PIXEL_MODE_OFF 1048 * @see #HOT_PIXEL_MODE_FAST 1049 * @see #HOT_PIXEL_MODE_HIGH_QUALITY 1050 */ 1051 public static final Key<Integer> HOT_PIXEL_MODE = 1052 new Key<Integer>("android.hotPixel.mode", int.class); 1053 1054 /** 1055 * <p>GPS coordinates to include in output JPEG 1056 * EXIF</p> 1057 */ 1058 public static final Key<double[]> JPEG_GPS_COORDINATES = 1059 new Key<double[]>("android.jpeg.gpsCoordinates", double[].class); 1060 1061 /** 1062 * <p>32 characters describing GPS algorithm to 1063 * include in EXIF</p> 1064 */ 1065 public static final Key<String> JPEG_GPS_PROCESSING_METHOD = 1066 new Key<String>("android.jpeg.gpsProcessingMethod", String.class); 1067 1068 /** 1069 * <p>Time GPS fix was made to include in 1070 * EXIF</p> 1071 */ 1072 public static final Key<Long> JPEG_GPS_TIMESTAMP = 1073 new Key<Long>("android.jpeg.gpsTimestamp", long.class); 1074 1075 /** 1076 * <p>Orientation of JPEG image to 1077 * write</p> 1078 */ 1079 public static final Key<Integer> JPEG_ORIENTATION = 1080 new Key<Integer>("android.jpeg.orientation", int.class); 1081 1082 /** 1083 * <p>Compression quality of the final JPEG 1084 * image</p> 1085 * <p>85-95 is typical usage range</p> 1086 */ 1087 public static final Key<Byte> JPEG_QUALITY = 1088 new Key<Byte>("android.jpeg.quality", byte.class); 1089 1090 /** 1091 * <p>Compression quality of JPEG 1092 * thumbnail</p> 1093 */ 1094 public static final Key<Byte> JPEG_THUMBNAIL_QUALITY = 1095 new Key<Byte>("android.jpeg.thumbnailQuality", byte.class); 1096 1097 /** 1098 * <p>Resolution of embedded JPEG thumbnail</p> 1099 * <p>When set to (0, 0) value, the JPEG EXIF will not contain thumbnail, 1100 * but the captured JPEG will still be a valid image.</p> 1101 * <p>When a jpeg image capture is issued, the thumbnail size selected should have 1102 * the same aspect ratio as the jpeg image.</p> 1103 */ 1104 public static final Key<android.util.Size> JPEG_THUMBNAIL_SIZE = 1105 new Key<android.util.Size>("android.jpeg.thumbnailSize", android.util.Size.class); 1106 1107 /** 1108 * <p>The ratio of lens focal length to the effective 1109 * aperture diameter.</p> 1110 * <p>This will only be supported on the camera devices that 1111 * have variable aperture lens. The aperture value can only be 1112 * one of the values listed in {@link CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES android.lens.info.availableApertures}.</p> 1113 * <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is OFF, 1114 * this can be set along with {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, 1115 * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration} 1116 * to achieve manual exposure control.</p> 1117 * <p>The requested aperture value may take several frames to reach the 1118 * requested value; the camera device will report the current (intermediate) 1119 * aperture size in capture result metadata while the aperture is changing. 1120 * While the aperture is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> 1121 * <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is one of 1122 * the ON modes, this will be overridden by the camera device 1123 * auto-exposure algorithm, the overridden values are then provided 1124 * back to the user in the corresponding result.</p> 1125 * 1126 * @see CaptureRequest#CONTROL_AE_MODE 1127 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES 1128 * @see CaptureResult#LENS_STATE 1129 * @see CaptureRequest#SENSOR_EXPOSURE_TIME 1130 * @see CaptureRequest#SENSOR_FRAME_DURATION 1131 * @see CaptureRequest#SENSOR_SENSITIVITY 1132 */ 1133 public static final Key<Float> LENS_APERTURE = 1134 new Key<Float>("android.lens.aperture", float.class); 1135 1136 /** 1137 * <p>State of lens neutral density filter(s).</p> 1138 * <p>This will not be supported on most camera devices. On devices 1139 * where this is supported, this may only be set to one of the 1140 * values included in {@link CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES android.lens.info.availableFilterDensities}.</p> 1141 * <p>Lens filters are typically used to lower the amount of light the 1142 * sensor is exposed to (measured in steps of EV). As used here, an EV 1143 * step is the standard logarithmic representation, which are 1144 * non-negative, and inversely proportional to the amount of light 1145 * hitting the sensor. For example, setting this to 0 would result 1146 * in no reduction of the incoming light, and setting this to 2 would 1147 * mean that the filter is set to reduce incoming light by two stops 1148 * (allowing 1/4 of the prior amount of light to the sensor).</p> 1149 * <p>It may take several frames before the lens filter density changes 1150 * to the requested value. While the filter density is still changing, 1151 * {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> 1152 * 1153 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES 1154 * @see CaptureResult#LENS_STATE 1155 */ 1156 public static final Key<Float> LENS_FILTER_DENSITY = 1157 new Key<Float>("android.lens.filterDensity", float.class); 1158 1159 /** 1160 * <p>The current lens focal length; used for optical zoom.</p> 1161 * <p>This setting controls the physical focal length of the camera 1162 * device's lens. Changing the focal length changes the field of 1163 * view of the camera device, and is usually used for optical zoom.</p> 1164 * <p>Like {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance} and {@link CaptureRequest#LENS_APERTURE android.lens.aperture}, this 1165 * setting won't be applied instantaneously, and it may take several 1166 * frames before the lens can change to the requested focal length. 1167 * While the focal length is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will 1168 * be set to MOVING.</p> 1169 * <p>This is expected not to be supported on most devices.</p> 1170 * 1171 * @see CaptureRequest#LENS_APERTURE 1172 * @see CaptureRequest#LENS_FOCUS_DISTANCE 1173 * @see CaptureResult#LENS_STATE 1174 */ 1175 public static final Key<Float> LENS_FOCAL_LENGTH = 1176 new Key<Float>("android.lens.focalLength", float.class); 1177 1178 /** 1179 * <p>Distance to plane of sharpest focus, 1180 * measured from frontmost surface of the lens</p> 1181 * <p>0 means infinity focus. Used value will be clamped 1182 * to [0, {@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance}].</p> 1183 * <p>Like {@link CaptureRequest#LENS_FOCAL_LENGTH android.lens.focalLength}, this setting won't be applied 1184 * instantaneously, and it may take several frames before the lens 1185 * can move to the requested focus distance. While the lens is still moving, 1186 * {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> 1187 * 1188 * @see CaptureRequest#LENS_FOCAL_LENGTH 1189 * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE 1190 * @see CaptureResult#LENS_STATE 1191 */ 1192 public static final Key<Float> LENS_FOCUS_DISTANCE = 1193 new Key<Float>("android.lens.focusDistance", float.class); 1194 1195 /** 1196 * <p>Sets whether the camera device uses optical image stabilization (OIS) 1197 * when capturing images.</p> 1198 * <p>OIS is used to compensate for motion blur due to small movements of 1199 * the camera during capture. Unlike digital image stabilization, OIS makes 1200 * use of mechanical elements to stabilize the camera sensor, and thus 1201 * allows for longer exposure times before camera shake becomes 1202 * apparent.</p> 1203 * <p>This is not expected to be supported on most devices.</p> 1204 * @see #LENS_OPTICAL_STABILIZATION_MODE_OFF 1205 * @see #LENS_OPTICAL_STABILIZATION_MODE_ON 1206 */ 1207 public static final Key<Integer> LENS_OPTICAL_STABILIZATION_MODE = 1208 new Key<Integer>("android.lens.opticalStabilizationMode", int.class); 1209 1210 /** 1211 * <p>Mode of operation for the noise reduction 1212 * algorithm</p> 1213 * <p>Noise filtering control. OFF means no noise reduction 1214 * will be applied by the camera device.</p> 1215 * <p>This must be set to a valid mode in 1216 * {@link CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES android.noiseReduction.availableNoiseReductionModes}.</p> 1217 * <p>FAST/HIGH_QUALITY both mean camera device determined noise filtering 1218 * will be applied. HIGH_QUALITY mode indicates that the camera device 1219 * will use the highest-quality noise filtering algorithms, 1220 * even if it slows down capture rate. FAST means the camera device should not 1221 * slow down capture rate when applying noise filtering.</p> 1222 * 1223 * @see CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES 1224 * @see #NOISE_REDUCTION_MODE_OFF 1225 * @see #NOISE_REDUCTION_MODE_FAST 1226 * @see #NOISE_REDUCTION_MODE_HIGH_QUALITY 1227 */ 1228 public static final Key<Integer> NOISE_REDUCTION_MODE = 1229 new Key<Integer>("android.noiseReduction.mode", int.class); 1230 1231 /** 1232 * <p>An application-specified ID for the current 1233 * request. Must be maintained unchanged in output 1234 * frame</p> 1235 * @hide 1236 */ 1237 public static final Key<Integer> REQUEST_ID = 1238 new Key<Integer>("android.request.id", int.class); 1239 1240 /** 1241 * <p>(x, y, width, height).</p> 1242 * <p>A rectangle with the top-level corner of (x,y) and size 1243 * (width, height). The region of the sensor that is used for 1244 * output. Each stream must use this rectangle to produce its 1245 * output, cropping to a smaller region if necessary to 1246 * maintain the stream's aspect ratio.</p> 1247 * <p>HAL2.x uses only (x, y, width)</p> 1248 * <p>The crop region is applied after the RAW to other color space (e.g. YUV) 1249 * conversion. Since raw streams (e.g. RAW16) don't have the conversion stage, 1250 * it is not croppable. The crop region will be ignored by raw streams.</p> 1251 * <p>For non-raw streams, any additional per-stream cropping will 1252 * be done to maximize the final pixel area of the stream.</p> 1253 * <p>For example, if the crop region is set to a 4:3 aspect 1254 * ratio, then 4:3 streams should use the exact crop 1255 * region. 16:9 streams should further crop vertically 1256 * (letterbox).</p> 1257 * <p>Conversely, if the crop region is set to a 16:9, then 4:3 1258 * outputs should crop horizontally (pillarbox), and 16:9 1259 * streams should match exactly. These additional crops must 1260 * be centered within the crop region.</p> 1261 * <p>The output streams must maintain square pixels at all 1262 * times, no matter what the relative aspect ratios of the 1263 * crop region and the stream are. Negative values for 1264 * corner are allowed for raw output if full pixel array is 1265 * larger than active pixel array. Width and height may be 1266 * rounded to nearest larger supportable width, especially 1267 * for raw output, where only a few fixed scales may be 1268 * possible. The width and height of the crop region cannot 1269 * be set to be smaller than floor( activeArraySize.width / 1270 * {@link CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom} ) and floor( 1271 * activeArraySize.height / 1272 * {@link CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom}), respectively.</p> 1273 * 1274 * @see CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM 1275 */ 1276 public static final Key<android.graphics.Rect> SCALER_CROP_REGION = 1277 new Key<android.graphics.Rect>("android.scaler.cropRegion", android.graphics.Rect.class); 1278 1279 /** 1280 * <p>Duration each pixel is exposed to 1281 * light.</p> 1282 * <p>If the sensor can't expose this exact duration, it should shorten the 1283 * duration exposed to the nearest possible value (rather than expose longer).</p> 1284 */ 1285 public static final Key<Long> SENSOR_EXPOSURE_TIME = 1286 new Key<Long>("android.sensor.exposureTime", long.class); 1287 1288 /** 1289 * <p>Duration from start of frame exposure to 1290 * start of next frame exposure.</p> 1291 * <p>The maximum frame rate that can be supported by a camera subsystem is 1292 * a function of many factors:</p> 1293 * <ul> 1294 * <li>Requested resolutions of output image streams</li> 1295 * <li>Availability of binning / skipping modes on the imager</li> 1296 * <li>The bandwidth of the imager interface</li> 1297 * <li>The bandwidth of the various ISP processing blocks</li> 1298 * </ul> 1299 * <p>Since these factors can vary greatly between different ISPs and 1300 * sensors, the camera abstraction tries to represent the bandwidth 1301 * restrictions with as simple a model as possible.</p> 1302 * <p>The model presented has the following characteristics:</p> 1303 * <ul> 1304 * <li>The image sensor is always configured to output the smallest 1305 * resolution possible given the application's requested output stream 1306 * sizes. The smallest resolution is defined as being at least as large 1307 * as the largest requested output stream size; the camera pipeline must 1308 * never digitally upsample sensor data when the crop region covers the 1309 * whole sensor. In general, this means that if only small output stream 1310 * resolutions are configured, the sensor can provide a higher frame 1311 * rate.</li> 1312 * <li>Since any request may use any or all the currently configured 1313 * output streams, the sensor and ISP must be configured to support 1314 * scaling a single capture to all the streams at the same time. This 1315 * means the camera pipeline must be ready to produce the largest 1316 * requested output size without any delay. Therefore, the overall 1317 * frame rate of a given configured stream set is governed only by the 1318 * largest requested stream resolution.</li> 1319 * <li>Using more than one output stream in a request does not affect the 1320 * frame duration.</li> 1321 * <li>Certain format-streams may need to do additional background processing 1322 * before data is consumed/produced by that stream. These processors 1323 * can run concurrently to the rest of the camera pipeline, but 1324 * cannot process more than 1 capture at a time.</li> 1325 * </ul> 1326 * <p>The necessary information for the application, given the model above, 1327 * is provided via the {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} field 1328 * using StreamConfigurationMap#getOutputMinFrameDuration(int, Size). 1329 * These are used to determine the maximum frame rate / minimum frame 1330 * duration that is possible for a given stream configuration.</p> 1331 * <p>Specifically, the application can use the following rules to 1332 * determine the minimum frame duration it can request from the camera 1333 * device:</p> 1334 * <ol> 1335 * <li>Let the set of currently configured input/output streams 1336 * be called <code>S</code>.</li> 1337 * <li>Find the minimum frame durations for each stream in <code>S</code>, by 1338 * looking it up in {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} using 1339 * StreamConfigurationMap#getOutputMinFrameDuration(int, Size) (with 1340 * its respective size/format). Let this set of frame durations be called 1341 * <code>F</code>.</li> 1342 * <li>For any given request <code>R</code>, the minimum frame duration allowed 1343 * for <code>R</code> is the maximum out of all values in <code>F</code>. Let the streams 1344 * used in <code>R</code> be called <code>S_r</code>.</li> 1345 * </ol> 1346 * <p>If none of the streams in <code>S_r</code> have a stall time (listed in 1347 * StreamConfigurationMap#getOutputStallDuration(int,Size) using its 1348 * respective size/format), then the frame duration in 1349 * <code>F</code> determines the steady state frame rate that the application will 1350 * get if it uses <code>R</code> as a repeating request. Let this special kind 1351 * of request be called <code>Rsimple</code>.</p> 1352 * <p>A repeating request <code>Rsimple</code> can be <em>occasionally</em> interleaved 1353 * by a single capture of a new request <code>Rstall</code> (which has at least 1354 * one in-use stream with a non-0 stall time) and if <code>Rstall</code> has the 1355 * same minimum frame duration this will not cause a frame rate loss 1356 * if all buffers from the previous <code>Rstall</code> have already been 1357 * delivered.</p> 1358 * <p>For more details about stalling, see 1359 * StreamConfigurationMap#getOutputStallDuration(int,Size).</p> 1360 * 1361 * @see CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP 1362 */ 1363 public static final Key<Long> SENSOR_FRAME_DURATION = 1364 new Key<Long>("android.sensor.frameDuration", long.class); 1365 1366 /** 1367 * <p>Gain applied to image data. Must be 1368 * implemented through analog gain only if set to values 1369 * below 'maximum analog sensitivity'.</p> 1370 * <p>If the sensor can't apply this exact gain, it should lessen the 1371 * gain to the nearest possible value (rather than gain more).</p> 1372 * <p>ISO 12232:2006 REI method</p> 1373 */ 1374 public static final Key<Integer> SENSOR_SENSITIVITY = 1375 new Key<Integer>("android.sensor.sensitivity", int.class); 1376 1377 /** 1378 * <p>A pixel <code>[R, G_even, G_odd, B]</code> that supplies the test pattern 1379 * when {@link CaptureRequest#SENSOR_TEST_PATTERN_MODE android.sensor.testPatternMode} is SOLID_COLOR.</p> 1380 * <p>Each color channel is treated as an unsigned 32-bit integer. 1381 * The camera device then uses the most significant X bits 1382 * that correspond to how many bits are in its Bayer raw sensor 1383 * output.</p> 1384 * <p>For example, a sensor with RAW10 Bayer output would use the 1385 * 10 most significant bits from each color channel.</p> 1386 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1387 * 1388 * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE 1389 */ 1390 public static final Key<int[]> SENSOR_TEST_PATTERN_DATA = 1391 new Key<int[]>("android.sensor.testPatternData", int[].class); 1392 1393 /** 1394 * <p>When enabled, the sensor sends a test pattern instead of 1395 * doing a real exposure from the camera.</p> 1396 * <p>When a test pattern is enabled, all manual sensor controls specified 1397 * by android.sensor.* should be ignored. All other controls should 1398 * work as normal.</p> 1399 * <p>For example, if manual flash is enabled, flash firing should still 1400 * occur (and that the test pattern remain unmodified, since the flash 1401 * would not actually affect it).</p> 1402 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1403 * @see #SENSOR_TEST_PATTERN_MODE_OFF 1404 * @see #SENSOR_TEST_PATTERN_MODE_SOLID_COLOR 1405 * @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS 1406 * @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY 1407 * @see #SENSOR_TEST_PATTERN_MODE_PN9 1408 * @see #SENSOR_TEST_PATTERN_MODE_CUSTOM1 1409 */ 1410 public static final Key<Integer> SENSOR_TEST_PATTERN_MODE = 1411 new Key<Integer>("android.sensor.testPatternMode", int.class); 1412 1413 /** 1414 * <p>Quality of lens shading correction applied 1415 * to the image data.</p> 1416 * <p>When set to OFF mode, no lens shading correction will be applied by the 1417 * camera device, and an identity lens shading map data will be provided 1418 * if <code>{@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} == ON</code>. For example, for lens 1419 * shading map with size specified as <code>{@link CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE android.lens.info.shadingMapSize} = [ 4, 3 ]</code>, 1420 * the output {@link CaptureResult#STATISTICS_LENS_SHADING_MAP android.statistics.lensShadingMap} for this case will be an identity map 1421 * shown below:</p> 1422 * <pre><code>[ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1423 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1424 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1425 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1426 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1427 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] 1428 * </code></pre> 1429 * <p>When set to other modes, lens shading correction will be applied by the 1430 * camera device. Applications can request lens shading map data by setting 1431 * {@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} to ON, and then the camera device will provide 1432 * lens shading map data in {@link CaptureResult#STATISTICS_LENS_SHADING_MAP android.statistics.lensShadingMap}, with size specified 1433 * by {@link CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE android.lens.info.shadingMapSize}; the returned shading map data will be the one 1434 * applied by the camera device for this capture request.</p> 1435 * <p>The shading map data may depend on the AE and AWB statistics, therefore the reliability 1436 * of the map data may be affected by the AE and AWB algorithms. When AE and AWB are in 1437 * AUTO modes({@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} <code>!=</code> OFF and {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} <code>!=</code> OFF), 1438 * to get best results, it is recommended that the applications wait for the AE and AWB to 1439 * be converged before using the returned shading map data.</p> 1440 * 1441 * @see CaptureRequest#CONTROL_AE_MODE 1442 * @see CaptureRequest#CONTROL_AWB_MODE 1443 * @see CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE 1444 * @see CaptureResult#STATISTICS_LENS_SHADING_MAP 1445 * @see CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE 1446 * @see #SHADING_MODE_OFF 1447 * @see #SHADING_MODE_FAST 1448 * @see #SHADING_MODE_HIGH_QUALITY 1449 */ 1450 public static final Key<Integer> SHADING_MODE = 1451 new Key<Integer>("android.shading.mode", int.class); 1452 1453 /** 1454 * <p>State of the face detector 1455 * unit</p> 1456 * <p>Whether face detection is enabled, and whether it 1457 * should output just the basic fields or the full set of 1458 * fields. Value must be one of the 1459 * {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES android.statistics.info.availableFaceDetectModes}.</p> 1460 * 1461 * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES 1462 * @see #STATISTICS_FACE_DETECT_MODE_OFF 1463 * @see #STATISTICS_FACE_DETECT_MODE_SIMPLE 1464 * @see #STATISTICS_FACE_DETECT_MODE_FULL 1465 */ 1466 public static final Key<Integer> STATISTICS_FACE_DETECT_MODE = 1467 new Key<Integer>("android.statistics.faceDetectMode", int.class); 1468 1469 /** 1470 * <p>Operating mode for hotpixel map generation.</p> 1471 * <p>If set to ON, a hotpixel map is returned in {@link CaptureResult#STATISTICS_HOT_PIXEL_MAP android.statistics.hotPixelMap}. 1472 * If set to OFF, no hotpixel map should be returned.</p> 1473 * <p>This must be set to a valid mode from {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES android.statistics.info.availableHotPixelMapModes}.</p> 1474 * 1475 * @see CaptureResult#STATISTICS_HOT_PIXEL_MAP 1476 * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES 1477 */ 1478 public static final Key<Boolean> STATISTICS_HOT_PIXEL_MAP_MODE = 1479 new Key<Boolean>("android.statistics.hotPixelMapMode", boolean.class); 1480 1481 /** 1482 * <p>Whether the camera device will output the lens 1483 * shading map in output result metadata.</p> 1484 * <p>When set to ON, 1485 * {@link CaptureResult#STATISTICS_LENS_SHADING_MAP android.statistics.lensShadingMap} must be provided in 1486 * the output result metadata.</p> 1487 * 1488 * @see CaptureResult#STATISTICS_LENS_SHADING_MAP 1489 * @see #STATISTICS_LENS_SHADING_MAP_MODE_OFF 1490 * @see #STATISTICS_LENS_SHADING_MAP_MODE_ON 1491 */ 1492 public static final Key<Integer> STATISTICS_LENS_SHADING_MAP_MODE = 1493 new Key<Integer>("android.statistics.lensShadingMapMode", int.class); 1494 1495 /** 1496 * <p>Tonemapping / contrast / gamma curve for the blue 1497 * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 1498 * CONTRAST_CURVE.</p> 1499 * <p>See android.tonemap.curveRed for more details.</p> 1500 * 1501 * @see CaptureRequest#TONEMAP_MODE 1502 * @hide 1503 */ 1504 public static final Key<float[]> TONEMAP_CURVE_BLUE = 1505 new Key<float[]>("android.tonemap.curveBlue", float[].class); 1506 1507 /** 1508 * <p>Tonemapping / contrast / gamma curve for the green 1509 * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 1510 * CONTRAST_CURVE.</p> 1511 * <p>See android.tonemap.curveRed for more details.</p> 1512 * 1513 * @see CaptureRequest#TONEMAP_MODE 1514 * @hide 1515 */ 1516 public static final Key<float[]> TONEMAP_CURVE_GREEN = 1517 new Key<float[]>("android.tonemap.curveGreen", float[].class); 1518 1519 /** 1520 * <p>Tonemapping / contrast / gamma curve for the red 1521 * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 1522 * CONTRAST_CURVE.</p> 1523 * <p>Each channel's curve is defined by an array of control points:</p> 1524 * <pre><code>android.tonemap.curveRed = 1525 * [ P0in, P0out, P1in, P1out, P2in, P2out, P3in, P3out, ..., PNin, PNout ] 1526 * 2 <= N <= {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</code></pre> 1527 * <p>These are sorted in order of increasing <code>Pin</code>; it is always 1528 * guaranteed that input values 0.0 and 1.0 are included in the list to 1529 * define a complete mapping. For input values between control points, 1530 * the camera device must linearly interpolate between the control 1531 * points.</p> 1532 * <p>Each curve can have an independent number of points, and the number 1533 * of points can be less than max (that is, the request doesn't have to 1534 * always provide a curve with number of points equivalent to 1535 * {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}).</p> 1536 * <p>A few examples, and their corresponding graphical mappings; these 1537 * only specify the red channel and the precision is limited to 4 1538 * digits, for conciseness.</p> 1539 * <p>Linear mapping:</p> 1540 * <pre><code>android.tonemap.curveRed = [ 0, 0, 1.0, 1.0 ] 1541 * </code></pre> 1542 * <p><img alt="Linear mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png" /></p> 1543 * <p>Invert mapping:</p> 1544 * <pre><code>android.tonemap.curveRed = [ 0, 1.0, 1.0, 0 ] 1545 * </code></pre> 1546 * <p><img alt="Inverting mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png" /></p> 1547 * <p>Gamma 1/2.2 mapping, with 16 control points:</p> 1548 * <pre><code>android.tonemap.curveRed = [ 1549 * 0.0000, 0.0000, 0.0667, 0.2920, 0.1333, 0.4002, 0.2000, 0.4812, 1550 * 0.2667, 0.5484, 0.3333, 0.6069, 0.4000, 0.6594, 0.4667, 0.7072, 1551 * 0.5333, 0.7515, 0.6000, 0.7928, 0.6667, 0.8317, 0.7333, 0.8685, 1552 * 0.8000, 0.9035, 0.8667, 0.9370, 0.9333, 0.9691, 1.0000, 1.0000 ] 1553 * </code></pre> 1554 * <p><img alt="Gamma = 1/2.2 tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png" /></p> 1555 * <p>Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:</p> 1556 * <pre><code>android.tonemap.curveRed = [ 1557 * 0.0000, 0.0000, 0.0667, 0.2864, 0.1333, 0.4007, 0.2000, 0.4845, 1558 * 0.2667, 0.5532, 0.3333, 0.6125, 0.4000, 0.6652, 0.4667, 0.7130, 1559 * 0.5333, 0.7569, 0.6000, 0.7977, 0.6667, 0.8360, 0.7333, 0.8721, 1560 * 0.8000, 0.9063, 0.8667, 0.9389, 0.9333, 0.9701, 1.0000, 1.0000 ] 1561 * </code></pre> 1562 * <p><img alt="sRGB tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p> 1563 * 1564 * @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS 1565 * @see CaptureRequest#TONEMAP_MODE 1566 * @hide 1567 */ 1568 public static final Key<float[]> TONEMAP_CURVE_RED = 1569 new Key<float[]>("android.tonemap.curveRed", float[].class); 1570 1571 /** 1572 * <p>Tonemapping / contrast / gamma curve to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} 1573 * is CONTRAST_CURVE.</p> 1574 * <p>The tonemapCurve consist of three curves for each of red, green, and blue 1575 * channels respectively. The following example uses the red channel as an 1576 * example. The same logic applies to green and blue channel. 1577 * Each channel's curve is defined by an array of control points:</p> 1578 * <pre><code>curveRed = 1579 * [ P0(in, out), P1(in, out), P2(in, out), P3(in, out), ..., PN(in, out) ] 1580 * 2 <= N <= {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</code></pre> 1581 * <p>These are sorted in order of increasing <code>Pin</code>; it is always 1582 * guaranteed that input values 0.0 and 1.0 are included in the list to 1583 * define a complete mapping. For input values between control points, 1584 * the camera device must linearly interpolate between the control 1585 * points.</p> 1586 * <p>Each curve can have an independent number of points, and the number 1587 * of points can be less than max (that is, the request doesn't have to 1588 * always provide a curve with number of points equivalent to 1589 * {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}).</p> 1590 * <p>A few examples, and their corresponding graphical mappings; these 1591 * only specify the red channel and the precision is limited to 4 1592 * digits, for conciseness.</p> 1593 * <p>Linear mapping:</p> 1594 * <pre><code>curveRed = [ (0, 0), (1.0, 1.0) ] 1595 * </code></pre> 1596 * <p><img alt="Linear mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png" /></p> 1597 * <p>Invert mapping:</p> 1598 * <pre><code>curveRed = [ (0, 1.0), (1.0, 0) ] 1599 * </code></pre> 1600 * <p><img alt="Inverting mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png" /></p> 1601 * <p>Gamma 1/2.2 mapping, with 16 control points:</p> 1602 * <pre><code>curveRed = [ 1603 * (0.0000, 0.0000), (0.0667, 0.2920), (0.1333, 0.4002), (0.2000, 0.4812), 1604 * (0.2667, 0.5484), (0.3333, 0.6069), (0.4000, 0.6594), (0.4667, 0.7072), 1605 * (0.5333, 0.7515), (0.6000, 0.7928), (0.6667, 0.8317), (0.7333, 0.8685), 1606 * (0.8000, 0.9035), (0.8667, 0.9370), (0.9333, 0.9691), (1.0000, 1.0000) ] 1607 * </code></pre> 1608 * <p><img alt="Gamma = 1/2.2 tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png" /></p> 1609 * <p>Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:</p> 1610 * <pre><code>curveRed = [ 1611 * (0.0000, 0.0000), (0.0667, 0.2864), (0.1333, 0.4007), (0.2000, 0.4845), 1612 * (0.2667, 0.5532), (0.3333, 0.6125), (0.4000, 0.6652), (0.4667, 0.7130), 1613 * (0.5333, 0.7569), (0.6000, 0.7977), (0.6667, 0.8360), (0.7333, 0.8721), 1614 * (0.8000, 0.9063), (0.8667, 0.9389), (0.9333, 0.9701), (1.0000, 1.0000) ] 1615 * </code></pre> 1616 * <p><img alt="sRGB tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p> 1617 * 1618 * @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS 1619 * @see CaptureRequest#TONEMAP_MODE 1620 */ 1621 public static final Key<android.hardware.camera2.params.TonemapCurve> TONEMAP_CURVE = 1622 new Key<android.hardware.camera2.params.TonemapCurve>("android.tonemap.curve", android.hardware.camera2.params.TonemapCurve.class); 1623 1624 /** 1625 * <p>High-level global contrast/gamma/tonemapping control.</p> 1626 * <p>When switching to an application-defined contrast curve by setting 1627 * {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} to CONTRAST_CURVE, the curve is defined 1628 * per-channel with a set of <code>(in, out)</code> points that specify the 1629 * mapping from input high-bit-depth pixel value to the output 1630 * low-bit-depth value. Since the actual pixel ranges of both input 1631 * and output may change depending on the camera pipeline, the values 1632 * are specified by normalized floating-point numbers.</p> 1633 * <p>More-complex color mapping operations such as 3D color look-up 1634 * tables, selective chroma enhancement, or other non-linear color 1635 * transforms will be disabled when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 1636 * CONTRAST_CURVE.</p> 1637 * <p>This must be set to a valid mode in 1638 * {@link CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES android.tonemap.availableToneMapModes}.</p> 1639 * <p>When using either FAST or HIGH_QUALITY, the camera device will 1640 * emit its own tonemap curve in {@link CaptureRequest#TONEMAP_CURVE android.tonemap.curve}. 1641 * These values are always available, and as close as possible to the 1642 * actually used nonlinear/nonglobal transforms.</p> 1643 * <p>If a request is sent with CONTRAST_CURVE with the camera device's 1644 * provided curve in FAST or HIGH_QUALITY, the image's tonemap will be 1645 * roughly the same.</p> 1646 * 1647 * @see CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES 1648 * @see CaptureRequest#TONEMAP_CURVE 1649 * @see CaptureRequest#TONEMAP_MODE 1650 * @see #TONEMAP_MODE_CONTRAST_CURVE 1651 * @see #TONEMAP_MODE_FAST 1652 * @see #TONEMAP_MODE_HIGH_QUALITY 1653 */ 1654 public static final Key<Integer> TONEMAP_MODE = 1655 new Key<Integer>("android.tonemap.mode", int.class); 1656 1657 /** 1658 * <p>This LED is nominally used to indicate to the user 1659 * that the camera is powered on and may be streaming images back to the 1660 * Application Processor. In certain rare circumstances, the OS may 1661 * disable this when video is processed locally and not transmitted to 1662 * any untrusted applications.</p> 1663 * <p>In particular, the LED <em>must</em> always be on when the data could be 1664 * transmitted off the device. The LED <em>should</em> always be on whenever 1665 * data is stored locally on the device.</p> 1666 * <p>The LED <em>may</em> be off if a trusted application is using the data that 1667 * doesn't violate the above rules.</p> 1668 * @hide 1669 */ 1670 public static final Key<Boolean> LED_TRANSMIT = 1671 new Key<Boolean>("android.led.transmit", boolean.class); 1672 1673 /** 1674 * <p>Whether black-level compensation is locked 1675 * to its current values, or is free to vary.</p> 1676 * <p>When set to ON, the values used for black-level 1677 * compensation will not change until the lock is set to 1678 * OFF.</p> 1679 * <p>Since changes to certain capture parameters (such as 1680 * exposure time) may require resetting of black level 1681 * compensation, the camera device must report whether setting 1682 * the black level lock was successful in the output result 1683 * metadata.</p> 1684 * <p>For example, if a sequence of requests is as follows:</p> 1685 * <ul> 1686 * <li>Request 1: Exposure = 10ms, Black level lock = OFF</li> 1687 * <li>Request 2: Exposure = 10ms, Black level lock = ON</li> 1688 * <li>Request 3: Exposure = 10ms, Black level lock = ON</li> 1689 * <li>Request 4: Exposure = 20ms, Black level lock = ON</li> 1690 * <li>Request 5: Exposure = 20ms, Black level lock = ON</li> 1691 * <li>Request 6: Exposure = 20ms, Black level lock = ON</li> 1692 * </ul> 1693 * <p>And the exposure change in Request 4 requires the camera 1694 * device to reset the black level offsets, then the output 1695 * result metadata is expected to be:</p> 1696 * <ul> 1697 * <li>Result 1: Exposure = 10ms, Black level lock = OFF</li> 1698 * <li>Result 2: Exposure = 10ms, Black level lock = ON</li> 1699 * <li>Result 3: Exposure = 10ms, Black level lock = ON</li> 1700 * <li>Result 4: Exposure = 20ms, Black level lock = OFF</li> 1701 * <li>Result 5: Exposure = 20ms, Black level lock = ON</li> 1702 * <li>Result 6: Exposure = 20ms, Black level lock = ON</li> 1703 * </ul> 1704 * <p>This indicates to the application that on frame 4, black 1705 * levels were reset due to exposure value changes, and pixel 1706 * values may not be consistent across captures.</p> 1707 * <p>The camera device will maintain the lock to the extent 1708 * possible, only overriding the lock to OFF when changes to 1709 * other request parameters require a black level recalculation 1710 * or reset.</p> 1711 */ 1712 public static final Key<Boolean> BLACK_LEVEL_LOCK = 1713 new Key<Boolean>("android.blackLevel.lock", boolean.class); 1714 1715 /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ 1716 * End generated code 1717 *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/ 1718} 1719