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