CaptureRequest.java revision 12a8385b7e403c6e1af6c824d3e77088242f89a7
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.annotation.NonNull; 20import android.annotation.Nullable; 21import android.hardware.camera2.impl.CameraMetadataNative; 22import android.hardware.camera2.impl.PublicKey; 23import android.hardware.camera2.impl.SyntheticKey; 24import android.hardware.camera2.utils.HashCodeHelpers; 25import android.hardware.camera2.utils.TypeReference; 26import android.os.Parcel; 27import android.os.Parcelable; 28import android.view.Surface; 29 30import java.util.Collection; 31import java.util.Collections; 32import java.util.HashSet; 33import java.util.List; 34import java.util.Objects; 35 36 37/** 38 * <p>An immutable package of settings and outputs needed to capture a single 39 * image from the camera device.</p> 40 * 41 * <p>Contains the configuration for the capture hardware (sensor, lens, flash), 42 * the processing pipeline, the control algorithms, and the output buffers. Also 43 * contains the list of target Surfaces to send image data to for this 44 * capture.</p> 45 * 46 * <p>CaptureRequests can be created by using a {@link Builder} instance, 47 * obtained by calling {@link CameraDevice#createCaptureRequest}</p> 48 * 49 * <p>CaptureRequests are given to {@link CameraCaptureSession#capture} or 50 * {@link CameraCaptureSession#setRepeatingRequest} to capture images from a camera.</p> 51 * 52 * <p>Each request can specify a different subset of target Surfaces for the 53 * camera to send the captured data to. All the surfaces used in a request must 54 * be part of the surface list given to the last call to 55 * {@link CameraDevice#createCaptureSession}, when the request is submitted to the 56 * session.</p> 57 * 58 * <p>For example, a request meant for repeating preview might only include the 59 * Surface for the preview SurfaceView or SurfaceTexture, while a 60 * high-resolution still capture would also include a Surface from a ImageReader 61 * configured for high-resolution JPEG images.</p> 62 * 63 * <p>A reprocess capture request allows a previously-captured image from the camera device to be 64 * sent back to the device for further processing. It can be created with 65 * {@link CameraDevice#createReprocessCaptureRequest}, and used with a reprocessable capture session 66 * created with {@link CameraDevice#createReprocessableCaptureSession}.</p> 67 * 68 * @see CameraCaptureSession#capture 69 * @see CameraCaptureSession#setRepeatingRequest 70 * @see CameraCaptureSession#captureBurst 71 * @see CameraCaptureSession#setRepeatingBurst 72 * @see CameraDevice#createCaptureRequest 73 * @see CameraDevice#createReprocessCaptureRequest 74 */ 75public final class CaptureRequest extends CameraMetadata<CaptureRequest.Key<?>> 76 implements Parcelable { 77 78 /** 79 * A {@code Key} is used to do capture request field lookups with 80 * {@link CaptureResult#get} or to set fields with 81 * {@link CaptureRequest.Builder#set(Key, Object)}. 82 * 83 * <p>For example, to set the crop rectangle for the next capture: 84 * <code><pre> 85 * Rect cropRectangle = new Rect(0, 0, 640, 480); 86 * captureRequestBuilder.set(SCALER_CROP_REGION, cropRectangle); 87 * </pre></code> 88 * </p> 89 * 90 * <p>To enumerate over all possible keys for {@link CaptureResult}, see 91 * {@link CameraCharacteristics#getAvailableCaptureResultKeys}.</p> 92 * 93 * @see CaptureResult#get 94 * @see CameraCharacteristics#getAvailableCaptureResultKeys 95 */ 96 public final static class Key<T> { 97 private final CameraMetadataNative.Key<T> mKey; 98 99 /** 100 * Visible for testing and vendor extensions only. 101 * 102 * @hide 103 */ 104 public Key(String name, Class<T> type) { 105 mKey = new CameraMetadataNative.Key<T>(name, type); 106 } 107 108 /** 109 * Visible for testing and vendor extensions only. 110 * 111 * @hide 112 */ 113 public Key(String name, TypeReference<T> typeReference) { 114 mKey = new CameraMetadataNative.Key<T>(name, typeReference); 115 } 116 117 /** 118 * Return a camelCase, period separated name formatted like: 119 * {@code "root.section[.subsections].name"}. 120 * 121 * <p>Built-in keys exposed by the Android SDK are always prefixed with {@code "android."}; 122 * keys that are device/platform-specific are prefixed with {@code "com."}.</p> 123 * 124 * <p>For example, {@code CameraCharacteristics.SCALER_STREAM_CONFIGURATION_MAP} would 125 * have a name of {@code "android.scaler.streamConfigurationMap"}; whereas a device 126 * specific key might look like {@code "com.google.nexus.data.private"}.</p> 127 * 128 * @return String representation of the key name 129 */ 130 @NonNull 131 public String getName() { 132 return mKey.getName(); 133 } 134 135 /** 136 * {@inheritDoc} 137 */ 138 @Override 139 public final int hashCode() { 140 return mKey.hashCode(); 141 } 142 143 /** 144 * {@inheritDoc} 145 */ 146 @SuppressWarnings("unchecked") 147 @Override 148 public final boolean equals(Object o) { 149 return o instanceof Key && ((Key<T>)o).mKey.equals(mKey); 150 } 151 152 /** 153 * Return this {@link Key} as a string representation. 154 * 155 * <p>{@code "CaptureRequest.Key(%s)"}, where {@code %s} represents 156 * the name of this key as returned by {@link #getName}.</p> 157 * 158 * @return string representation of {@link Key} 159 */ 160 @NonNull 161 @Override 162 public String toString() { 163 return String.format("CaptureRequest.Key(%s)", mKey.getName()); 164 } 165 166 /** 167 * Visible for CameraMetadataNative implementation only; do not use. 168 * 169 * TODO: Make this private or remove it altogether. 170 * 171 * @hide 172 */ 173 public CameraMetadataNative.Key<T> getNativeKey() { 174 return mKey; 175 } 176 177 @SuppressWarnings({ "unchecked" }) 178 /*package*/ Key(CameraMetadataNative.Key<?> nativeKey) { 179 mKey = (CameraMetadataNative.Key<T>) nativeKey; 180 } 181 } 182 183 private final HashSet<Surface> mSurfaceSet; 184 private final CameraMetadataNative mSettings; 185 private boolean mIsReprocess; 186 // If this request is part of constrained high speed request list that was created by 187 // {@link CameraDevice#createConstrainedHighSpeedRequestList}. 188 private boolean mIsPartOfCHSRequestList = false; 189 // Each reprocess request must be tied to a reprocessable session ID. 190 // Valid only for reprocess requests (mIsReprocess == true). 191 private int mReprocessableSessionId; 192 193 private Object mUserTag; 194 195 /** 196 * Construct empty request. 197 * 198 * Used by Binder to unparcel this object only. 199 */ 200 private CaptureRequest() { 201 mSettings = new CameraMetadataNative(); 202 mSurfaceSet = new HashSet<Surface>(); 203 mIsReprocess = false; 204 mReprocessableSessionId = CameraCaptureSession.SESSION_ID_NONE; 205 } 206 207 /** 208 * Clone from source capture request. 209 * 210 * Used by the Builder to create an immutable copy. 211 */ 212 @SuppressWarnings("unchecked") 213 private CaptureRequest(CaptureRequest source) { 214 mSettings = new CameraMetadataNative(source.mSettings); 215 mSurfaceSet = (HashSet<Surface>) source.mSurfaceSet.clone(); 216 mIsReprocess = source.mIsReprocess; 217 mIsPartOfCHSRequestList = source.mIsPartOfCHSRequestList; 218 mReprocessableSessionId = source.mReprocessableSessionId; 219 mUserTag = source.mUserTag; 220 } 221 222 /** 223 * Take ownership of passed-in settings. 224 * 225 * Used by the Builder to create a mutable CaptureRequest. 226 * 227 * @param settings Settings for this capture request. 228 * @param isReprocess Indicates whether to create a reprocess capture request. {@code true} 229 * to create a reprocess capture request. {@code false} to create a regular 230 * capture request. 231 * @param reprocessableSessionId The ID of the camera capture session this capture is created 232 * for. This is used to validate if the application submits a 233 * reprocess capture request to the same session where 234 * the {@link TotalCaptureResult}, used to create the reprocess 235 * capture, came from. 236 * 237 * @throws IllegalArgumentException If creating a reprocess capture request with an invalid 238 * reprocessableSessionId. 239 * 240 * @see CameraDevice#createReprocessCaptureRequest 241 */ 242 private CaptureRequest(CameraMetadataNative settings, boolean isReprocess, 243 int reprocessableSessionId) { 244 mSettings = CameraMetadataNative.move(settings); 245 mSurfaceSet = new HashSet<Surface>(); 246 mIsReprocess = isReprocess; 247 if (isReprocess) { 248 if (reprocessableSessionId == CameraCaptureSession.SESSION_ID_NONE) { 249 throw new IllegalArgumentException("Create a reprocess capture request with an " + 250 "invalid session ID: " + reprocessableSessionId); 251 } 252 mReprocessableSessionId = reprocessableSessionId; 253 } else { 254 mReprocessableSessionId = CameraCaptureSession.SESSION_ID_NONE; 255 } 256 } 257 258 /** 259 * Get a capture request field value. 260 * 261 * <p>The field definitions can be found in {@link CaptureRequest}.</p> 262 * 263 * <p>Querying the value for the same key more than once will return a value 264 * which is equal to the previous queried value.</p> 265 * 266 * @throws IllegalArgumentException if the key was not valid 267 * 268 * @param key The result field to read. 269 * @return The value of that key, or {@code null} if the field is not set. 270 */ 271 @Nullable 272 public <T> T get(Key<T> key) { 273 return mSettings.get(key); 274 } 275 276 /** 277 * {@inheritDoc} 278 * @hide 279 */ 280 @SuppressWarnings("unchecked") 281 @Override 282 protected <T> T getProtected(Key<?> key) { 283 return (T) mSettings.get(key); 284 } 285 286 /** 287 * {@inheritDoc} 288 * @hide 289 */ 290 @SuppressWarnings("unchecked") 291 @Override 292 protected Class<Key<?>> getKeyClass() { 293 Object thisClass = Key.class; 294 return (Class<Key<?>>)thisClass; 295 } 296 297 /** 298 * {@inheritDoc} 299 */ 300 @Override 301 @NonNull 302 public List<Key<?>> getKeys() { 303 // Force the javadoc for this function to show up on the CaptureRequest page 304 return super.getKeys(); 305 } 306 307 /** 308 * Retrieve the tag for this request, if any. 309 * 310 * <p>This tag is not used for anything by the camera device, but can be 311 * used by an application to easily identify a CaptureRequest when it is 312 * returned by 313 * {@link CameraCaptureSession.CaptureCallback#onCaptureCompleted CaptureCallback.onCaptureCompleted} 314 * </p> 315 * 316 * @return the last tag Object set on this request, or {@code null} if 317 * no tag has been set. 318 * @see Builder#setTag 319 */ 320 @Nullable 321 public Object getTag() { 322 return mUserTag; 323 } 324 325 /** 326 * Determine if this is a reprocess capture request. 327 * 328 * <p>A reprocess capture request produces output images from an input buffer from the 329 * {@link CameraCaptureSession}'s input {@link Surface}. A reprocess capture request can be 330 * created by {@link CameraDevice#createReprocessCaptureRequest}.</p> 331 * 332 * @return {@code true} if this is a reprocess capture request. {@code false} if this is not a 333 * reprocess capture request. 334 * 335 * @see CameraDevice#createReprocessCaptureRequest 336 */ 337 public boolean isReprocess() { 338 return mIsReprocess; 339 } 340 341 /** 342 * <p>Determine if this request is part of a constrained high speed request list that was 343 * created by {@link CameraDevice#createConstrainedHighSpeedRequestList}. A constrained high 344 * speed request list contains some constrained high speed capture requests with certain 345 * interleaved pattern that is suitable for high speed preview/video streaming. An active 346 * constrained high speed capture session only accepts constrained high speed request lists. 347 * This method can be used to do the sanity check when a constrained high speed capture session 348 * receives a request list via {@link CameraCaptureSession#setRepeatingBurst} or 349 * {@link CameraCaptureSession#captureBurst}. 350 * </p> 351 * 352 * 353 * @return {@code true} if this request is part of a constrained high speed request list, 354 * {@code false} otherwise. 355 * 356 * @hide 357 */ 358 public boolean isPartOfCRequestList() { 359 return mIsPartOfCHSRequestList; 360 } 361 362 /** 363 * Returns a copy of the underlying {@link CameraMetadataNative}. 364 * @hide 365 */ 366 public CameraMetadataNative getNativeCopy() { 367 return new CameraMetadataNative(mSettings); 368 } 369 370 /** 371 * Get the reprocessable session ID this reprocess capture request is associated with. 372 * 373 * @return the reprocessable session ID this reprocess capture request is associated with 374 * 375 * @throws IllegalStateException if this capture request is not a reprocess capture request. 376 * @hide 377 */ 378 public int getReprocessableSessionId() { 379 if (mIsReprocess == false || 380 mReprocessableSessionId == CameraCaptureSession.SESSION_ID_NONE) { 381 throw new IllegalStateException("Getting the reprocessable session ID for a "+ 382 "non-reprocess capture request is illegal."); 383 } 384 return mReprocessableSessionId; 385 } 386 387 /** 388 * Determine whether this CaptureRequest is equal to another CaptureRequest. 389 * 390 * <p>A request is considered equal to another is if it's set of key/values is equal, it's 391 * list of output surfaces is equal, the user tag is equal, and the return values of 392 * isReprocess() are equal.</p> 393 * 394 * @param other Another instance of CaptureRequest. 395 * 396 * @return True if the requests are the same, false otherwise. 397 */ 398 @Override 399 public boolean equals(Object other) { 400 return other instanceof CaptureRequest 401 && equals((CaptureRequest)other); 402 } 403 404 private boolean equals(CaptureRequest other) { 405 return other != null 406 && Objects.equals(mUserTag, other.mUserTag) 407 && mSurfaceSet.equals(other.mSurfaceSet) 408 && mSettings.equals(other.mSettings) 409 && mIsReprocess == other.mIsReprocess 410 && mReprocessableSessionId == other.mReprocessableSessionId; 411 } 412 413 @Override 414 public int hashCode() { 415 return HashCodeHelpers.hashCodeGeneric(mSettings, mSurfaceSet, mUserTag); 416 } 417 418 public static final Parcelable.Creator<CaptureRequest> CREATOR = 419 new Parcelable.Creator<CaptureRequest>() { 420 @Override 421 public CaptureRequest createFromParcel(Parcel in) { 422 CaptureRequest request = new CaptureRequest(); 423 request.readFromParcel(in); 424 425 return request; 426 } 427 428 @Override 429 public CaptureRequest[] newArray(int size) { 430 return new CaptureRequest[size]; 431 } 432 }; 433 434 /** 435 * Expand this object from a Parcel. 436 * Hidden since this breaks the immutability of CaptureRequest, but is 437 * needed to receive CaptureRequests with aidl. 438 * 439 * @param in The parcel from which the object should be read 440 * @hide 441 */ 442 private void readFromParcel(Parcel in) { 443 mSettings.readFromParcel(in); 444 445 mSurfaceSet.clear(); 446 447 Parcelable[] parcelableArray = in.readParcelableArray(Surface.class.getClassLoader()); 448 449 if (parcelableArray == null) { 450 return; 451 } 452 453 for (Parcelable p : parcelableArray) { 454 Surface s = (Surface) p; 455 mSurfaceSet.add(s); 456 } 457 458 mIsReprocess = (in.readInt() == 0) ? false : true; 459 mReprocessableSessionId = CameraCaptureSession.SESSION_ID_NONE; 460 } 461 462 @Override 463 public int describeContents() { 464 return 0; 465 } 466 467 @Override 468 public void writeToParcel(Parcel dest, int flags) { 469 mSettings.writeToParcel(dest, flags); 470 dest.writeParcelableArray(mSurfaceSet.toArray(new Surface[mSurfaceSet.size()]), flags); 471 dest.writeInt(mIsReprocess ? 1 : 0); 472 } 473 474 /** 475 * @hide 476 */ 477 public boolean containsTarget(Surface surface) { 478 return mSurfaceSet.contains(surface); 479 } 480 481 /** 482 * @hide 483 */ 484 public Collection<Surface> getTargets() { 485 return Collections.unmodifiableCollection(mSurfaceSet); 486 } 487 488 /** 489 * A builder for capture requests. 490 * 491 * <p>To obtain a builder instance, use the 492 * {@link CameraDevice#createCaptureRequest} method, which initializes the 493 * request fields to one of the templates defined in {@link CameraDevice}. 494 * 495 * @see CameraDevice#createCaptureRequest 496 * @see CameraDevice#TEMPLATE_PREVIEW 497 * @see CameraDevice#TEMPLATE_RECORD 498 * @see CameraDevice#TEMPLATE_STILL_CAPTURE 499 * @see CameraDevice#TEMPLATE_VIDEO_SNAPSHOT 500 * @see CameraDevice#TEMPLATE_MANUAL 501 */ 502 public final static class Builder { 503 504 private final CaptureRequest mRequest; 505 506 /** 507 * Initialize the builder using the template; the request takes 508 * ownership of the template. 509 * 510 * @param template Template settings for this capture request. 511 * @param reprocess Indicates whether to create a reprocess capture request. {@code true} 512 * to create a reprocess capture request. {@code false} to create a regular 513 * capture request. 514 * @param reprocessableSessionId The ID of the camera capture session this capture is 515 * created for. This is used to validate if the application 516 * submits a reprocess capture request to the same session 517 * where the {@link TotalCaptureResult}, used to create the 518 * reprocess capture, came from. 519 * 520 * @throws IllegalArgumentException If creating a reprocess capture request with an invalid 521 * reprocessableSessionId. 522 * @hide 523 */ 524 public Builder(CameraMetadataNative template, boolean reprocess, 525 int reprocessableSessionId) { 526 mRequest = new CaptureRequest(template, reprocess, reprocessableSessionId); 527 } 528 529 /** 530 * <p>Add a surface to the list of targets for this request</p> 531 * 532 * <p>The Surface added must be one of the surfaces included in the most 533 * recent call to {@link CameraDevice#createCaptureSession}, when the 534 * request is given to the camera device.</p> 535 * 536 * <p>Adding a target more than once has no effect.</p> 537 * 538 * @param outputTarget Surface to use as an output target for this request 539 */ 540 public void addTarget(@NonNull Surface outputTarget) { 541 mRequest.mSurfaceSet.add(outputTarget); 542 } 543 544 /** 545 * <p>Remove a surface from the list of targets for this request.</p> 546 * 547 * <p>Removing a target that is not currently added has no effect.</p> 548 * 549 * @param outputTarget Surface to use as an output target for this request 550 */ 551 public void removeTarget(@NonNull Surface outputTarget) { 552 mRequest.mSurfaceSet.remove(outputTarget); 553 } 554 555 /** 556 * Set a capture request field to a value. The field definitions can be 557 * found in {@link CaptureRequest}. 558 * 559 * @param key The metadata field to write. 560 * @param value The value to set the field to, which must be of a matching 561 * type to the key. 562 */ 563 public <T> void set(@NonNull Key<T> key, T value) { 564 mRequest.mSettings.set(key, value); 565 } 566 567 /** 568 * Get a capture request field value. The field definitions can be 569 * found in {@link CaptureRequest}. 570 * 571 * @throws IllegalArgumentException if the key was not valid 572 * 573 * @param key The metadata field to read. 574 * @return The value of that key, or {@code null} if the field is not set. 575 */ 576 @Nullable 577 public <T> T get(Key<T> key) { 578 return mRequest.mSettings.get(key); 579 } 580 581 /** 582 * Set a tag for this request. 583 * 584 * <p>This tag is not used for anything by the camera device, but can be 585 * used by an application to easily identify a CaptureRequest when it is 586 * returned by 587 * {@link CameraCaptureSession.CaptureCallback#onCaptureCompleted CaptureCallback.onCaptureCompleted} 588 * 589 * @param tag an arbitrary Object to store with this request 590 * @see CaptureRequest#getTag 591 */ 592 public void setTag(@Nullable Object tag) { 593 mRequest.mUserTag = tag; 594 } 595 596 /** 597 * <p>Mark this request as part of a constrained high speed request list created by 598 * {@link CameraDevice#createConstrainedHighSpeedRequestList}. A constrained high speed 599 * request list contains some constrained high speed capture requests with certain 600 * interleaved pattern that is suitable for high speed preview/video streaming.</p> 601 * 602 * @hide 603 */ 604 public void setPartOfCHSRequestList(boolean partOfCHSList) { 605 mRequest.mIsPartOfCHSRequestList = partOfCHSList; 606 } 607 608 /** 609 * Build a request using the current target Surfaces and settings. 610 * <p>Note that, although it is possible to create a {@code CaptureRequest} with no target 611 * {@link Surface}s, passing such a request into {@link CameraCaptureSession#capture}, 612 * {@link CameraCaptureSession#captureBurst}, 613 * {@link CameraCaptureSession#setRepeatingBurst}, or 614 * {@link CameraCaptureSession#setRepeatingRequest} will cause that method to throw an 615 * {@link IllegalArgumentException}.</p> 616 * 617 * @return A new capture request instance, ready for submission to the 618 * camera device. 619 */ 620 @NonNull 621 public CaptureRequest build() { 622 return new CaptureRequest(mRequest); 623 } 624 625 /** 626 * @hide 627 */ 628 public boolean isEmpty() { 629 return mRequest.mSettings.isEmpty(); 630 } 631 632 } 633 634 /*@O~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ 635 * The key entries below this point are generated from metadata 636 * definitions in /system/media/camera/docs. Do not modify by hand or 637 * modify the comment blocks at the start or end. 638 *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/ 639 640 /** 641 * <p>The mode control selects how the image data is converted from the 642 * sensor's native color into linear sRGB color.</p> 643 * <p>When auto-white balance (AWB) is enabled with {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, this 644 * control is overridden by the AWB routine. When AWB is disabled, the 645 * application controls how the color mapping is performed.</p> 646 * <p>We define the expected processing pipeline below. For consistency 647 * across devices, this is always the case with TRANSFORM_MATRIX.</p> 648 * <p>When either FULL or HIGH_QUALITY is used, the camera device may 649 * do additional processing but {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and 650 * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} will still be provided by the 651 * camera device (in the results) and be roughly correct.</p> 652 * <p>Switching to TRANSFORM_MATRIX and using the data provided from 653 * FAST or HIGH_QUALITY will yield a picture with the same white point 654 * as what was produced by the camera device in the earlier frame.</p> 655 * <p>The expected processing pipeline is as follows:</p> 656 * <p><img alt="White balance processing pipeline" src="../../../../images/camera2/metadata/android.colorCorrection.mode/processing_pipeline.png" /></p> 657 * <p>The white balance is encoded by two values, a 4-channel white-balance 658 * gain vector (applied in the Bayer domain), and a 3x3 color transform 659 * matrix (applied after demosaic).</p> 660 * <p>The 4-channel white-balance gains are defined as:</p> 661 * <pre><code>{@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} = [ R G_even G_odd B ] 662 * </code></pre> 663 * <p>where <code>G_even</code> is the gain for green pixels on even rows of the 664 * output, and <code>G_odd</code> is the gain for green pixels on the odd rows. 665 * These may be identical for a given camera device implementation; if 666 * the camera device does not support a separate gain for even/odd green 667 * channels, it will use the <code>G_even</code> value, and write <code>G_odd</code> equal to 668 * <code>G_even</code> in the output result metadata.</p> 669 * <p>The matrices for color transforms are defined as a 9-entry vector:</p> 670 * <pre><code>{@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} = [ I0 I1 I2 I3 I4 I5 I6 I7 I8 ] 671 * </code></pre> 672 * <p>which define a transform from input sensor colors, <code>P_in = [ r g b ]</code>, 673 * to output linear sRGB, <code>P_out = [ r' g' b' ]</code>,</p> 674 * <p>with colors as follows:</p> 675 * <pre><code>r' = I0r + I1g + I2b 676 * g' = I3r + I4g + I5b 677 * b' = I6r + I7g + I8b 678 * </code></pre> 679 * <p>Both the input and output value ranges must match. Overflow/underflow 680 * values are clipped to fit within the range.</p> 681 * <p><b>Possible values:</b> 682 * <ul> 683 * <li>{@link #COLOR_CORRECTION_MODE_TRANSFORM_MATRIX TRANSFORM_MATRIX}</li> 684 * <li>{@link #COLOR_CORRECTION_MODE_FAST FAST}</li> 685 * <li>{@link #COLOR_CORRECTION_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 686 * </ul></p> 687 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 688 * <p><b>Full capability</b> - 689 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 690 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 691 * 692 * @see CaptureRequest#COLOR_CORRECTION_GAINS 693 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM 694 * @see CaptureRequest#CONTROL_AWB_MODE 695 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 696 * @see #COLOR_CORRECTION_MODE_TRANSFORM_MATRIX 697 * @see #COLOR_CORRECTION_MODE_FAST 698 * @see #COLOR_CORRECTION_MODE_HIGH_QUALITY 699 */ 700 @PublicKey 701 public static final Key<Integer> COLOR_CORRECTION_MODE = 702 new Key<Integer>("android.colorCorrection.mode", int.class); 703 704 /** 705 * <p>A color transform matrix to use to transform 706 * from sensor RGB color space to output linear sRGB color space.</p> 707 * <p>This matrix is either set by the camera device when the request 708 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not TRANSFORM_MATRIX, or 709 * directly by the application in the request when the 710 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is TRANSFORM_MATRIX.</p> 711 * <p>In the latter case, the camera device may round the matrix to account 712 * for precision issues; the final rounded matrix should be reported back 713 * in this matrix result metadata. The transform should keep the magnitude 714 * of the output color values within <code>[0, 1.0]</code> (assuming input color 715 * values is within the normalized range <code>[0, 1.0]</code>), or clipping may occur.</p> 716 * <p>The valid range of each matrix element varies on different devices, but 717 * values within [-1.5, 3.0] are guaranteed not to be clipped.</p> 718 * <p><b>Units</b>: Unitless scale factors</p> 719 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 720 * <p><b>Full capability</b> - 721 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 722 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 723 * 724 * @see CaptureRequest#COLOR_CORRECTION_MODE 725 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 726 */ 727 @PublicKey 728 public static final Key<android.hardware.camera2.params.ColorSpaceTransform> COLOR_CORRECTION_TRANSFORM = 729 new Key<android.hardware.camera2.params.ColorSpaceTransform>("android.colorCorrection.transform", android.hardware.camera2.params.ColorSpaceTransform.class); 730 731 /** 732 * <p>Gains applying to Bayer raw color channels for 733 * white-balance.</p> 734 * <p>These per-channel gains are either set by the camera device 735 * when the request {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not 736 * TRANSFORM_MATRIX, or directly by the application in the 737 * request when the {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is 738 * TRANSFORM_MATRIX.</p> 739 * <p>The gains in the result metadata are the gains actually 740 * applied by the camera device to the current frame.</p> 741 * <p>The valid range of gains varies on different devices, but gains 742 * between [1.0, 3.0] are guaranteed not to be clipped. Even if a given 743 * device allows gains below 1.0, this is usually not recommended because 744 * this can create color artifacts.</p> 745 * <p><b>Units</b>: Unitless gain factors</p> 746 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 747 * <p><b>Full capability</b> - 748 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 749 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 750 * 751 * @see CaptureRequest#COLOR_CORRECTION_MODE 752 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 753 */ 754 @PublicKey 755 public static final Key<android.hardware.camera2.params.RggbChannelVector> COLOR_CORRECTION_GAINS = 756 new Key<android.hardware.camera2.params.RggbChannelVector>("android.colorCorrection.gains", android.hardware.camera2.params.RggbChannelVector.class); 757 758 /** 759 * <p>Mode of operation for the chromatic aberration correction algorithm.</p> 760 * <p>Chromatic (color) aberration is caused by the fact that different wavelengths of light 761 * can not focus on the same point after exiting from the lens. This metadata defines 762 * the high level control of chromatic aberration correction algorithm, which aims to 763 * minimize the chromatic artifacts that may occur along the object boundaries in an 764 * image.</p> 765 * <p>FAST/HIGH_QUALITY both mean that camera device determined aberration 766 * correction will be applied. HIGH_QUALITY mode indicates that the camera device will 767 * use the highest-quality aberration correction algorithms, even if it slows down 768 * capture rate. FAST means the camera device will not slow down capture rate when 769 * applying aberration correction.</p> 770 * <p>LEGACY devices will always be in FAST mode.</p> 771 * <p><b>Possible values:</b> 772 * <ul> 773 * <li>{@link #COLOR_CORRECTION_ABERRATION_MODE_OFF OFF}</li> 774 * <li>{@link #COLOR_CORRECTION_ABERRATION_MODE_FAST FAST}</li> 775 * <li>{@link #COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 776 * </ul></p> 777 * <p><b>Available values for this device:</b><br> 778 * {@link CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES android.colorCorrection.availableAberrationModes}</p> 779 * <p>This key is available on all devices.</p> 780 * 781 * @see CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES 782 * @see #COLOR_CORRECTION_ABERRATION_MODE_OFF 783 * @see #COLOR_CORRECTION_ABERRATION_MODE_FAST 784 * @see #COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY 785 */ 786 @PublicKey 787 public static final Key<Integer> COLOR_CORRECTION_ABERRATION_MODE = 788 new Key<Integer>("android.colorCorrection.aberrationMode", int.class); 789 790 /** 791 * <p>The desired setting for the camera device's auto-exposure 792 * algorithm's antibanding compensation.</p> 793 * <p>Some kinds of lighting fixtures, such as some fluorescent 794 * lights, flicker at the rate of the power supply frequency 795 * (60Hz or 50Hz, depending on country). While this is 796 * typically not noticeable to a person, it can be visible to 797 * a camera device. If a camera sets its exposure time to the 798 * wrong value, the flicker may become visible in the 799 * viewfinder as flicker or in a final captured image, as a 800 * set of variable-brightness bands across the image.</p> 801 * <p>Therefore, the auto-exposure routines of camera devices 802 * include antibanding routines that ensure that the chosen 803 * exposure value will not cause such banding. The choice of 804 * exposure time depends on the rate of flicker, which the 805 * camera device can detect automatically, or the expected 806 * rate can be selected by the application using this 807 * control.</p> 808 * <p>A given camera device may not support all of the possible 809 * options for the antibanding mode. The 810 * {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES android.control.aeAvailableAntibandingModes} key contains 811 * the available modes for a given camera device.</p> 812 * <p>AUTO mode is the default if it is available on given 813 * camera device. When AUTO mode is not available, the 814 * default will be either 50HZ or 60HZ, and both 50HZ 815 * and 60HZ will be available.</p> 816 * <p>If manual exposure control is enabled (by setting 817 * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link CaptureRequest#CONTROL_MODE android.control.mode} to OFF), 818 * then this setting has no effect, and the application must 819 * ensure it selects exposure times that do not cause banding 820 * issues. The {@link CaptureResult#STATISTICS_SCENE_FLICKER android.statistics.sceneFlicker} key can assist 821 * the application in this.</p> 822 * <p><b>Possible values:</b> 823 * <ul> 824 * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_OFF OFF}</li> 825 * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_50HZ 50HZ}</li> 826 * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_60HZ 60HZ}</li> 827 * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_AUTO AUTO}</li> 828 * </ul></p> 829 * <p><b>Available values for this device:</b><br></p> 830 * <p>{@link CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES android.control.aeAvailableAntibandingModes}</p> 831 * <p>This key is available on all devices.</p> 832 * 833 * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES 834 * @see CaptureRequest#CONTROL_AE_MODE 835 * @see CaptureRequest#CONTROL_MODE 836 * @see CaptureResult#STATISTICS_SCENE_FLICKER 837 * @see #CONTROL_AE_ANTIBANDING_MODE_OFF 838 * @see #CONTROL_AE_ANTIBANDING_MODE_50HZ 839 * @see #CONTROL_AE_ANTIBANDING_MODE_60HZ 840 * @see #CONTROL_AE_ANTIBANDING_MODE_AUTO 841 */ 842 @PublicKey 843 public static final Key<Integer> CONTROL_AE_ANTIBANDING_MODE = 844 new Key<Integer>("android.control.aeAntibandingMode", int.class); 845 846 /** 847 * <p>Adjustment to auto-exposure (AE) target image 848 * brightness.</p> 849 * <p>The adjustment is measured as a count of steps, with the 850 * step size defined by {@link CameraCharacteristics#CONTROL_AE_COMPENSATION_STEP android.control.aeCompensationStep} and the 851 * allowed range by {@link CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE android.control.aeCompensationRange}.</p> 852 * <p>For example, if the exposure value (EV) step is 0.333, '6' 853 * will mean an exposure compensation of +2 EV; -3 will mean an 854 * exposure compensation of -1 EV. One EV represents a doubling 855 * of image brightness. Note that this control will only be 856 * effective if {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} <code>!=</code> OFF. This control 857 * will take effect even when {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} <code>== true</code>.</p> 858 * <p>In the event of exposure compensation value being changed, camera device 859 * may take several frames to reach the newly requested exposure target. 860 * During that time, {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} field will be in the SEARCHING 861 * state. Once the new exposure target is reached, {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} will 862 * change from SEARCHING to either CONVERGED, LOCKED (if AE lock is enabled), or 863 * FLASH_REQUIRED (if the scene is too dark for still capture).</p> 864 * <p><b>Units</b>: Compensation steps</p> 865 * <p><b>Range of valid values:</b><br> 866 * {@link CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE android.control.aeCompensationRange}</p> 867 * <p>This key is available on all devices.</p> 868 * 869 * @see CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE 870 * @see CameraCharacteristics#CONTROL_AE_COMPENSATION_STEP 871 * @see CaptureRequest#CONTROL_AE_LOCK 872 * @see CaptureRequest#CONTROL_AE_MODE 873 * @see CaptureResult#CONTROL_AE_STATE 874 */ 875 @PublicKey 876 public static final Key<Integer> CONTROL_AE_EXPOSURE_COMPENSATION = 877 new Key<Integer>("android.control.aeExposureCompensation", int.class); 878 879 /** 880 * <p>Whether auto-exposure (AE) is currently locked to its latest 881 * calculated values.</p> 882 * <p>When set to <code>true</code> (ON), the AE algorithm is locked to its latest parameters, 883 * and will not change exposure settings until the lock is set to <code>false</code> (OFF).</p> 884 * <p>Note that even when AE is locked, the flash may be fired if 885 * the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_AUTO_FLASH / 886 * ON_ALWAYS_FLASH / ON_AUTO_FLASH_REDEYE.</p> 887 * <p>When {@link CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION android.control.aeExposureCompensation} is changed, even if the AE lock 888 * is ON, the camera device will still adjust its exposure value.</p> 889 * <p>If AE precapture is triggered (see {@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}) 890 * when AE is already locked, the camera device will not change the exposure time 891 * ({@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}) and sensitivity ({@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}) 892 * parameters. The flash may be fired if the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} 893 * is ON_AUTO_FLASH/ON_AUTO_FLASH_REDEYE and the scene is too dark. If the 894 * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_ALWAYS_FLASH, the scene may become overexposed. 895 * Similarly, AE precapture trigger CANCEL has no effect when AE is already locked.</p> 896 * <p>When an AE precapture sequence is triggered, AE unlock will not be able to unlock 897 * the AE if AE is locked by the camera device internally during precapture metering 898 * sequence In other words, submitting requests with AE unlock has no effect for an 899 * ongoing precapture metering sequence. Otherwise, the precapture metering sequence 900 * will never succeed in a sequence of preview requests where AE lock is always set 901 * to <code>false</code>.</p> 902 * <p>Since the camera device has a pipeline of in-flight requests, the settings that 903 * get locked do not necessarily correspond to the settings that were present in the 904 * latest capture result received from the camera device, since additional captures 905 * and AE updates may have occurred even before the result was sent out. If an 906 * application is switching between automatic and manual control and wishes to eliminate 907 * any flicker during the switch, the following procedure is recommended:</p> 908 * <ol> 909 * <li>Starting in auto-AE mode:</li> 910 * <li>Lock AE</li> 911 * <li>Wait for the first result to be output that has the AE locked</li> 912 * <li>Copy exposure settings from that result into a request, set the request to manual AE</li> 913 * <li>Submit the capture request, proceed to run manual AE as desired.</li> 914 * </ol> 915 * <p>See {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE lock related state transition details.</p> 916 * <p>This key is available on all devices.</p> 917 * 918 * @see CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION 919 * @see CaptureRequest#CONTROL_AE_MODE 920 * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER 921 * @see CaptureResult#CONTROL_AE_STATE 922 * @see CaptureRequest#SENSOR_EXPOSURE_TIME 923 * @see CaptureRequest#SENSOR_SENSITIVITY 924 */ 925 @PublicKey 926 public static final Key<Boolean> CONTROL_AE_LOCK = 927 new Key<Boolean>("android.control.aeLock", boolean.class); 928 929 /** 930 * <p>The desired mode for the camera device's 931 * auto-exposure routine.</p> 932 * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is 933 * AUTO.</p> 934 * <p>When set to any of the ON modes, the camera device's 935 * auto-exposure routine is enabled, overriding the 936 * application's selected exposure time, sensor sensitivity, 937 * and frame duration ({@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, 938 * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and 939 * {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}). If one of the FLASH modes 940 * is selected, the camera device's flash unit controls are 941 * also overridden.</p> 942 * <p>The FLASH modes are only available if the camera device 943 * has a flash unit ({@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} is <code>true</code>).</p> 944 * <p>If flash TORCH mode is desired, this field must be set to 945 * ON or OFF, and {@link CaptureRequest#FLASH_MODE android.flash.mode} set to TORCH.</p> 946 * <p>When set to any of the ON modes, the values chosen by the 947 * camera device auto-exposure routine for the overridden 948 * fields for a given capture will be available in its 949 * CaptureResult.</p> 950 * <p><b>Possible values:</b> 951 * <ul> 952 * <li>{@link #CONTROL_AE_MODE_OFF OFF}</li> 953 * <li>{@link #CONTROL_AE_MODE_ON ON}</li> 954 * <li>{@link #CONTROL_AE_MODE_ON_AUTO_FLASH ON_AUTO_FLASH}</li> 955 * <li>{@link #CONTROL_AE_MODE_ON_ALWAYS_FLASH ON_ALWAYS_FLASH}</li> 956 * <li>{@link #CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE ON_AUTO_FLASH_REDEYE}</li> 957 * </ul></p> 958 * <p><b>Available values for this device:</b><br> 959 * {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_MODES android.control.aeAvailableModes}</p> 960 * <p>This key is available on all devices.</p> 961 * 962 * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_MODES 963 * @see CaptureRequest#CONTROL_MODE 964 * @see CameraCharacteristics#FLASH_INFO_AVAILABLE 965 * @see CaptureRequest#FLASH_MODE 966 * @see CaptureRequest#SENSOR_EXPOSURE_TIME 967 * @see CaptureRequest#SENSOR_FRAME_DURATION 968 * @see CaptureRequest#SENSOR_SENSITIVITY 969 * @see #CONTROL_AE_MODE_OFF 970 * @see #CONTROL_AE_MODE_ON 971 * @see #CONTROL_AE_MODE_ON_AUTO_FLASH 972 * @see #CONTROL_AE_MODE_ON_ALWAYS_FLASH 973 * @see #CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE 974 */ 975 @PublicKey 976 public static final Key<Integer> CONTROL_AE_MODE = 977 new Key<Integer>("android.control.aeMode", int.class); 978 979 /** 980 * <p>List of metering areas to use for auto-exposure adjustment.</p> 981 * <p>Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AE android.control.maxRegionsAe} is 0. 982 * Otherwise will always be present.</p> 983 * <p>The maximum number of regions supported by the device is determined by the value 984 * of {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AE android.control.maxRegionsAe}.</p> 985 * <p>The coordinate system is based on the active pixel array, 986 * with (0,0) being the top-left pixel in the active pixel array, and 987 * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 988 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 989 * bottom-right pixel in the active pixel array.</p> 990 * <p>The weight must be within <code>[0, 1000]</code>, and represents a weight 991 * for every pixel in the area. This means that a large metering area 992 * with the same weight as a smaller area will have more effect in 993 * the metering result. Metering areas can partially overlap and the 994 * camera device will add the weights in the overlap region.</p> 995 * <p>The weights are relative to weights of other exposure metering regions, so if only one 996 * region is used, all non-zero weights will have the same effect. A region with 0 997 * weight is ignored.</p> 998 * <p>If all regions have 0 weight, then no specific metering area needs to be used by the 999 * camera device.</p> 1000 * <p>If the metering region is outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in 1001 * capture result metadata, the camera device will ignore the sections outside the crop 1002 * region and output only the intersection rectangle as the metering region in the result 1003 * metadata. If the region is entirely outside the crop region, it will be ignored and 1004 * not reported in the result metadata.</p> 1005 * <p><b>Units</b>: Pixel coordinates within {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 1006 * <p><b>Range of valid values:</b><br> 1007 * Coordinates must be between <code>[(0,0), (width, height))</code> of 1008 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 1009 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1010 * 1011 * @see CameraCharacteristics#CONTROL_MAX_REGIONS_AE 1012 * @see CaptureRequest#SCALER_CROP_REGION 1013 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 1014 */ 1015 @PublicKey 1016 public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AE_REGIONS = 1017 new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.aeRegions", android.hardware.camera2.params.MeteringRectangle[].class); 1018 1019 /** 1020 * <p>Range over which the auto-exposure routine can 1021 * adjust the capture frame rate to maintain good 1022 * exposure.</p> 1023 * <p>Only constrains auto-exposure (AE) algorithm, not 1024 * manual control of {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime} and 1025 * {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}.</p> 1026 * <p><b>Units</b>: Frames per second (FPS)</p> 1027 * <p><b>Range of valid values:</b><br> 1028 * Any of the entries in {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES android.control.aeAvailableTargetFpsRanges}</p> 1029 * <p>This key is available on all devices.</p> 1030 * 1031 * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES 1032 * @see CaptureRequest#SENSOR_EXPOSURE_TIME 1033 * @see CaptureRequest#SENSOR_FRAME_DURATION 1034 */ 1035 @PublicKey 1036 public static final Key<android.util.Range<Integer>> CONTROL_AE_TARGET_FPS_RANGE = 1037 new Key<android.util.Range<Integer>>("android.control.aeTargetFpsRange", new TypeReference<android.util.Range<Integer>>() {{ }}); 1038 1039 /** 1040 * <p>Whether the camera device will trigger a precapture 1041 * metering sequence when it processes this request.</p> 1042 * <p>This entry is normally set to IDLE, or is not 1043 * included at all in the request settings. When included and 1044 * set to START, the camera device will trigger the auto-exposure (AE) 1045 * precapture metering sequence.</p> 1046 * <p>When set to CANCEL, the camera device will cancel any active 1047 * precapture metering trigger, and return to its initial AE state. 1048 * If a precapture metering sequence is already completed, and the camera 1049 * device has implicitly locked the AE for subsequent still capture, the 1050 * CANCEL trigger will unlock the AE and return to its initial AE state.</p> 1051 * <p>The precapture sequence should be triggered before starting a 1052 * high-quality still capture for final metering decisions to 1053 * be made, and for firing pre-capture flash pulses to estimate 1054 * scene brightness and required final capture flash power, when 1055 * the flash is enabled.</p> 1056 * <p>Normally, this entry should be set to START for only a 1057 * single request, and the application should wait until the 1058 * sequence completes before starting a new one.</p> 1059 * <p>When a precapture metering sequence is finished, the camera device 1060 * may lock the auto-exposure routine internally to be able to accurately expose the 1061 * subsequent still capture image (<code>{@link CaptureRequest#CONTROL_CAPTURE_INTENT android.control.captureIntent} == STILL_CAPTURE</code>). 1062 * For this case, the AE may not resume normal scan if no subsequent still capture is 1063 * submitted. To ensure that the AE routine restarts normal scan, the application should 1064 * submit a request with <code>{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} == true</code>, followed by a request 1065 * with <code>{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} == false</code>, if the application decides not to submit a 1066 * still capture request after the precapture sequence completes. Alternatively, for 1067 * API level 23 or newer devices, the CANCEL can be used to unlock the camera device 1068 * internally locked AE if the application doesn't submit a still capture request after 1069 * the AE precapture trigger. Note that, the CANCEL was added in API level 23, and must not 1070 * be used in devices that have earlier API levels.</p> 1071 * <p>The exact effect of auto-exposure (AE) precapture trigger 1072 * depends on the current AE mode and state; see 1073 * {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE precapture state transition 1074 * details.</p> 1075 * <p>On LEGACY-level devices, the precapture trigger is not supported; 1076 * capturing a high-resolution JPEG image will automatically trigger a 1077 * precapture sequence before the high-resolution capture, including 1078 * potentially firing a pre-capture flash.</p> 1079 * <p>Using the precapture trigger and the auto-focus trigger {@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger} 1080 * simultaneously is allowed. However, since these triggers often require cooperation between 1081 * the auto-focus and auto-exposure routines (for example, the may need to be enabled for a 1082 * focus sweep), the camera device may delay acting on a later trigger until the previous 1083 * trigger has been fully handled. This may lead to longer intervals between the trigger and 1084 * changes to {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} indicating the start of the precapture sequence, for 1085 * example.</p> 1086 * <p>If both the precapture and the auto-focus trigger are activated on the same request, then 1087 * the camera device will complete them in the optimal order for that device.</p> 1088 * <p><b>Possible values:</b> 1089 * <ul> 1090 * <li>{@link #CONTROL_AE_PRECAPTURE_TRIGGER_IDLE IDLE}</li> 1091 * <li>{@link #CONTROL_AE_PRECAPTURE_TRIGGER_START START}</li> 1092 * <li>{@link #CONTROL_AE_PRECAPTURE_TRIGGER_CANCEL CANCEL}</li> 1093 * </ul></p> 1094 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1095 * <p><b>Limited capability</b> - 1096 * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the 1097 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 1098 * 1099 * @see CaptureRequest#CONTROL_AE_LOCK 1100 * @see CaptureResult#CONTROL_AE_STATE 1101 * @see CaptureRequest#CONTROL_AF_TRIGGER 1102 * @see CaptureRequest#CONTROL_CAPTURE_INTENT 1103 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 1104 * @see #CONTROL_AE_PRECAPTURE_TRIGGER_IDLE 1105 * @see #CONTROL_AE_PRECAPTURE_TRIGGER_START 1106 * @see #CONTROL_AE_PRECAPTURE_TRIGGER_CANCEL 1107 */ 1108 @PublicKey 1109 public static final Key<Integer> CONTROL_AE_PRECAPTURE_TRIGGER = 1110 new Key<Integer>("android.control.aePrecaptureTrigger", int.class); 1111 1112 /** 1113 * <p>Whether auto-focus (AF) is currently enabled, and what 1114 * mode it is set to.</p> 1115 * <p>Only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} = AUTO and the lens is not fixed focus 1116 * (i.e. <code>{@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} > 0</code>). Also note that 1117 * when {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is OFF, the behavior of AF is device 1118 * dependent. It is recommended to lock AF by using {@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger} before 1119 * setting {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} to OFF, or set AF mode to OFF when AE is OFF.</p> 1120 * <p>If the lens is controlled by the camera device auto-focus algorithm, 1121 * the camera device will report the current AF status in {@link CaptureResult#CONTROL_AF_STATE android.control.afState} 1122 * in result metadata.</p> 1123 * <p><b>Possible values:</b> 1124 * <ul> 1125 * <li>{@link #CONTROL_AF_MODE_OFF OFF}</li> 1126 * <li>{@link #CONTROL_AF_MODE_AUTO AUTO}</li> 1127 * <li>{@link #CONTROL_AF_MODE_MACRO MACRO}</li> 1128 * <li>{@link #CONTROL_AF_MODE_CONTINUOUS_VIDEO CONTINUOUS_VIDEO}</li> 1129 * <li>{@link #CONTROL_AF_MODE_CONTINUOUS_PICTURE CONTINUOUS_PICTURE}</li> 1130 * <li>{@link #CONTROL_AF_MODE_EDOF EDOF}</li> 1131 * </ul></p> 1132 * <p><b>Available values for this device:</b><br> 1133 * {@link CameraCharacteristics#CONTROL_AF_AVAILABLE_MODES android.control.afAvailableModes}</p> 1134 * <p>This key is available on all devices.</p> 1135 * 1136 * @see CaptureRequest#CONTROL_AE_MODE 1137 * @see CameraCharacteristics#CONTROL_AF_AVAILABLE_MODES 1138 * @see CaptureResult#CONTROL_AF_STATE 1139 * @see CaptureRequest#CONTROL_AF_TRIGGER 1140 * @see CaptureRequest#CONTROL_MODE 1141 * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE 1142 * @see #CONTROL_AF_MODE_OFF 1143 * @see #CONTROL_AF_MODE_AUTO 1144 * @see #CONTROL_AF_MODE_MACRO 1145 * @see #CONTROL_AF_MODE_CONTINUOUS_VIDEO 1146 * @see #CONTROL_AF_MODE_CONTINUOUS_PICTURE 1147 * @see #CONTROL_AF_MODE_EDOF 1148 */ 1149 @PublicKey 1150 public static final Key<Integer> CONTROL_AF_MODE = 1151 new Key<Integer>("android.control.afMode", int.class); 1152 1153 /** 1154 * <p>List of metering areas to use for auto-focus.</p> 1155 * <p>Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AF android.control.maxRegionsAf} is 0. 1156 * Otherwise will always be present.</p> 1157 * <p>The maximum number of focus areas supported by the device is determined by the value 1158 * of {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AF android.control.maxRegionsAf}.</p> 1159 * <p>The coordinate system is based on the active pixel array, 1160 * with (0,0) being the top-left pixel in the active pixel array, and 1161 * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 1162 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 1163 * bottom-right pixel in the active pixel array.</p> 1164 * <p>The weight must be within <code>[0, 1000]</code>, and represents a weight 1165 * for every pixel in the area. This means that a large metering area 1166 * with the same weight as a smaller area will have more effect in 1167 * the metering result. Metering areas can partially overlap and the 1168 * camera device will add the weights in the overlap region.</p> 1169 * <p>The weights are relative to weights of other metering regions, so if only one region 1170 * is used, all non-zero weights will have the same effect. A region with 0 weight is 1171 * ignored.</p> 1172 * <p>If all regions have 0 weight, then no specific metering area needs to be used by the 1173 * camera device.</p> 1174 * <p>If the metering region is outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in 1175 * capture result metadata, the camera device will ignore the sections outside the crop 1176 * region and output only the intersection rectangle as the metering region in the result 1177 * metadata. If the region is entirely outside the crop region, it will be ignored and 1178 * not reported in the result metadata.</p> 1179 * <p><b>Units</b>: Pixel coordinates within {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 1180 * <p><b>Range of valid values:</b><br> 1181 * Coordinates must be between <code>[(0,0), (width, height))</code> of 1182 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 1183 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1184 * 1185 * @see CameraCharacteristics#CONTROL_MAX_REGIONS_AF 1186 * @see CaptureRequest#SCALER_CROP_REGION 1187 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 1188 */ 1189 @PublicKey 1190 public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AF_REGIONS = 1191 new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.afRegions", android.hardware.camera2.params.MeteringRectangle[].class); 1192 1193 /** 1194 * <p>Whether the camera device will trigger autofocus for this request.</p> 1195 * <p>This entry is normally set to IDLE, or is not 1196 * included at all in the request settings.</p> 1197 * <p>When included and set to START, the camera device will trigger the 1198 * autofocus algorithm. If autofocus is disabled, this trigger has no effect.</p> 1199 * <p>When set to CANCEL, the camera device will cancel any active trigger, 1200 * and return to its initial AF state.</p> 1201 * <p>Generally, applications should set this entry to START or CANCEL for only a 1202 * single capture, and then return it to IDLE (or not set at all). Specifying 1203 * START for multiple captures in a row means restarting the AF operation over 1204 * and over again.</p> 1205 * <p>See {@link CaptureResult#CONTROL_AF_STATE android.control.afState} for what the trigger means for each AF mode.</p> 1206 * <p>Using the autofocus trigger and the precapture trigger {@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger} 1207 * simultaneously is allowed. However, since these triggers often require cooperation between 1208 * the auto-focus and auto-exposure routines (for example, the may need to be enabled for a 1209 * focus sweep), the camera device may delay acting on a later trigger until the previous 1210 * trigger has been fully handled. This may lead to longer intervals between the trigger and 1211 * changes to {@link CaptureResult#CONTROL_AF_STATE android.control.afState}, for example.</p> 1212 * <p><b>Possible values:</b> 1213 * <ul> 1214 * <li>{@link #CONTROL_AF_TRIGGER_IDLE IDLE}</li> 1215 * <li>{@link #CONTROL_AF_TRIGGER_START START}</li> 1216 * <li>{@link #CONTROL_AF_TRIGGER_CANCEL CANCEL}</li> 1217 * </ul></p> 1218 * <p>This key is available on all devices.</p> 1219 * 1220 * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER 1221 * @see CaptureResult#CONTROL_AF_STATE 1222 * @see #CONTROL_AF_TRIGGER_IDLE 1223 * @see #CONTROL_AF_TRIGGER_START 1224 * @see #CONTROL_AF_TRIGGER_CANCEL 1225 */ 1226 @PublicKey 1227 public static final Key<Integer> CONTROL_AF_TRIGGER = 1228 new Key<Integer>("android.control.afTrigger", int.class); 1229 1230 /** 1231 * <p>Whether auto-white balance (AWB) is currently locked to its 1232 * latest calculated values.</p> 1233 * <p>When set to <code>true</code> (ON), the AWB algorithm is locked to its latest parameters, 1234 * and will not change color balance settings until the lock is set to <code>false</code> (OFF).</p> 1235 * <p>Since the camera device has a pipeline of in-flight requests, the settings that 1236 * get locked do not necessarily correspond to the settings that were present in the 1237 * latest capture result received from the camera device, since additional captures 1238 * and AWB updates may have occurred even before the result was sent out. If an 1239 * application is switching between automatic and manual control and wishes to eliminate 1240 * any flicker during the switch, the following procedure is recommended:</p> 1241 * <ol> 1242 * <li>Starting in auto-AWB mode:</li> 1243 * <li>Lock AWB</li> 1244 * <li>Wait for the first result to be output that has the AWB locked</li> 1245 * <li>Copy AWB settings from that result into a request, set the request to manual AWB</li> 1246 * <li>Submit the capture request, proceed to run manual AWB as desired.</li> 1247 * </ol> 1248 * <p>Note that AWB lock is only meaningful when 1249 * {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} is in the AUTO mode; in other modes, 1250 * AWB is already fixed to a specific setting.</p> 1251 * <p>Some LEGACY devices may not support ON; the value is then overridden to OFF.</p> 1252 * <p>This key is available on all devices.</p> 1253 * 1254 * @see CaptureRequest#CONTROL_AWB_MODE 1255 */ 1256 @PublicKey 1257 public static final Key<Boolean> CONTROL_AWB_LOCK = 1258 new Key<Boolean>("android.control.awbLock", boolean.class); 1259 1260 /** 1261 * <p>Whether auto-white balance (AWB) is currently setting the color 1262 * transform fields, and what its illumination target 1263 * is.</p> 1264 * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is AUTO.</p> 1265 * <p>When set to the ON mode, the camera device's auto-white balance 1266 * routine is enabled, overriding the application's selected 1267 * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and 1268 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}. Note that when {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} 1269 * is OFF, the behavior of AWB is device dependent. It is recommened to 1270 * also set AWB mode to OFF or lock AWB by using {@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} before 1271 * setting AE mode to OFF.</p> 1272 * <p>When set to the OFF mode, the camera device's auto-white balance 1273 * routine is disabled. The application manually controls the white 1274 * balance by {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} 1275 * and {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.</p> 1276 * <p>When set to any other modes, the camera device's auto-white 1277 * balance routine is disabled. The camera device uses each 1278 * particular illumination target for white balance 1279 * adjustment. The application's values for 1280 * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, 1281 * {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and 1282 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} are ignored.</p> 1283 * <p><b>Possible values:</b> 1284 * <ul> 1285 * <li>{@link #CONTROL_AWB_MODE_OFF OFF}</li> 1286 * <li>{@link #CONTROL_AWB_MODE_AUTO AUTO}</li> 1287 * <li>{@link #CONTROL_AWB_MODE_INCANDESCENT INCANDESCENT}</li> 1288 * <li>{@link #CONTROL_AWB_MODE_FLUORESCENT FLUORESCENT}</li> 1289 * <li>{@link #CONTROL_AWB_MODE_WARM_FLUORESCENT WARM_FLUORESCENT}</li> 1290 * <li>{@link #CONTROL_AWB_MODE_DAYLIGHT DAYLIGHT}</li> 1291 * <li>{@link #CONTROL_AWB_MODE_CLOUDY_DAYLIGHT CLOUDY_DAYLIGHT}</li> 1292 * <li>{@link #CONTROL_AWB_MODE_TWILIGHT TWILIGHT}</li> 1293 * <li>{@link #CONTROL_AWB_MODE_SHADE SHADE}</li> 1294 * </ul></p> 1295 * <p><b>Available values for this device:</b><br> 1296 * {@link CameraCharacteristics#CONTROL_AWB_AVAILABLE_MODES android.control.awbAvailableModes}</p> 1297 * <p>This key is available on all devices.</p> 1298 * 1299 * @see CaptureRequest#COLOR_CORRECTION_GAINS 1300 * @see CaptureRequest#COLOR_CORRECTION_MODE 1301 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM 1302 * @see CaptureRequest#CONTROL_AE_MODE 1303 * @see CameraCharacteristics#CONTROL_AWB_AVAILABLE_MODES 1304 * @see CaptureRequest#CONTROL_AWB_LOCK 1305 * @see CaptureRequest#CONTROL_MODE 1306 * @see #CONTROL_AWB_MODE_OFF 1307 * @see #CONTROL_AWB_MODE_AUTO 1308 * @see #CONTROL_AWB_MODE_INCANDESCENT 1309 * @see #CONTROL_AWB_MODE_FLUORESCENT 1310 * @see #CONTROL_AWB_MODE_WARM_FLUORESCENT 1311 * @see #CONTROL_AWB_MODE_DAYLIGHT 1312 * @see #CONTROL_AWB_MODE_CLOUDY_DAYLIGHT 1313 * @see #CONTROL_AWB_MODE_TWILIGHT 1314 * @see #CONTROL_AWB_MODE_SHADE 1315 */ 1316 @PublicKey 1317 public static final Key<Integer> CONTROL_AWB_MODE = 1318 new Key<Integer>("android.control.awbMode", int.class); 1319 1320 /** 1321 * <p>List of metering areas to use for auto-white-balance illuminant 1322 * estimation.</p> 1323 * <p>Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AWB android.control.maxRegionsAwb} is 0. 1324 * Otherwise will always be present.</p> 1325 * <p>The maximum number of regions supported by the device is determined by the value 1326 * of {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AWB android.control.maxRegionsAwb}.</p> 1327 * <p>The coordinate system is based on the active pixel array, 1328 * with (0,0) being the top-left pixel in the active pixel array, and 1329 * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1, 1330 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the 1331 * bottom-right pixel in the active pixel array.</p> 1332 * <p>The weight must range from 0 to 1000, and represents a weight 1333 * for every pixel in the area. This means that a large metering area 1334 * with the same weight as a smaller area will have more effect in 1335 * the metering result. Metering areas can partially overlap and the 1336 * camera device will add the weights in the overlap region.</p> 1337 * <p>The weights are relative to weights of other white balance metering regions, so if 1338 * only one region is used, all non-zero weights will have the same effect. A region with 1339 * 0 weight is ignored.</p> 1340 * <p>If all regions have 0 weight, then no specific metering area needs to be used by the 1341 * camera device.</p> 1342 * <p>If the metering region is outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in 1343 * capture result metadata, the camera device will ignore the sections outside the crop 1344 * region and output only the intersection rectangle as the metering region in the result 1345 * metadata. If the region is entirely outside the crop region, it will be ignored and 1346 * not reported in the result metadata.</p> 1347 * <p><b>Units</b>: Pixel coordinates within {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 1348 * <p><b>Range of valid values:</b><br> 1349 * Coordinates must be between <code>[(0,0), (width, height))</code> of 1350 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 1351 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1352 * 1353 * @see CameraCharacteristics#CONTROL_MAX_REGIONS_AWB 1354 * @see CaptureRequest#SCALER_CROP_REGION 1355 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 1356 */ 1357 @PublicKey 1358 public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AWB_REGIONS = 1359 new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.awbRegions", android.hardware.camera2.params.MeteringRectangle[].class); 1360 1361 /** 1362 * <p>Information to the camera device 3A (auto-exposure, 1363 * auto-focus, auto-white balance) routines about the purpose 1364 * of this capture, to help the camera device to decide optimal 3A 1365 * strategy.</p> 1366 * <p>This control (except for MANUAL) is only effective if 1367 * <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} != OFF</code> and any 3A routine is active.</p> 1368 * <p>ZERO_SHUTTER_LAG will be supported if {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} 1369 * contains PRIVATE_REPROCESSING or YUV_REPROCESSING. MANUAL will be supported if 1370 * {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} contains MANUAL_SENSOR. Other intent values are 1371 * always supported.</p> 1372 * <p><b>Possible values:</b> 1373 * <ul> 1374 * <li>{@link #CONTROL_CAPTURE_INTENT_CUSTOM CUSTOM}</li> 1375 * <li>{@link #CONTROL_CAPTURE_INTENT_PREVIEW PREVIEW}</li> 1376 * <li>{@link #CONTROL_CAPTURE_INTENT_STILL_CAPTURE STILL_CAPTURE}</li> 1377 * <li>{@link #CONTROL_CAPTURE_INTENT_VIDEO_RECORD VIDEO_RECORD}</li> 1378 * <li>{@link #CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT VIDEO_SNAPSHOT}</li> 1379 * <li>{@link #CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG ZERO_SHUTTER_LAG}</li> 1380 * <li>{@link #CONTROL_CAPTURE_INTENT_MANUAL MANUAL}</li> 1381 * </ul></p> 1382 * <p>This key is available on all devices.</p> 1383 * 1384 * @see CaptureRequest#CONTROL_MODE 1385 * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES 1386 * @see #CONTROL_CAPTURE_INTENT_CUSTOM 1387 * @see #CONTROL_CAPTURE_INTENT_PREVIEW 1388 * @see #CONTROL_CAPTURE_INTENT_STILL_CAPTURE 1389 * @see #CONTROL_CAPTURE_INTENT_VIDEO_RECORD 1390 * @see #CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT 1391 * @see #CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG 1392 * @see #CONTROL_CAPTURE_INTENT_MANUAL 1393 */ 1394 @PublicKey 1395 public static final Key<Integer> CONTROL_CAPTURE_INTENT = 1396 new Key<Integer>("android.control.captureIntent", int.class); 1397 1398 /** 1399 * <p>A special color effect to apply.</p> 1400 * <p>When this mode is set, a color effect will be applied 1401 * to images produced by the camera device. The interpretation 1402 * and implementation of these color effects is left to the 1403 * implementor of the camera device, and should not be 1404 * depended on to be consistent (or present) across all 1405 * devices.</p> 1406 * <p><b>Possible values:</b> 1407 * <ul> 1408 * <li>{@link #CONTROL_EFFECT_MODE_OFF OFF}</li> 1409 * <li>{@link #CONTROL_EFFECT_MODE_MONO MONO}</li> 1410 * <li>{@link #CONTROL_EFFECT_MODE_NEGATIVE NEGATIVE}</li> 1411 * <li>{@link #CONTROL_EFFECT_MODE_SOLARIZE SOLARIZE}</li> 1412 * <li>{@link #CONTROL_EFFECT_MODE_SEPIA SEPIA}</li> 1413 * <li>{@link #CONTROL_EFFECT_MODE_POSTERIZE POSTERIZE}</li> 1414 * <li>{@link #CONTROL_EFFECT_MODE_WHITEBOARD WHITEBOARD}</li> 1415 * <li>{@link #CONTROL_EFFECT_MODE_BLACKBOARD BLACKBOARD}</li> 1416 * <li>{@link #CONTROL_EFFECT_MODE_AQUA AQUA}</li> 1417 * </ul></p> 1418 * <p><b>Available values for this device:</b><br> 1419 * {@link CameraCharacteristics#CONTROL_AVAILABLE_EFFECTS android.control.availableEffects}</p> 1420 * <p>This key is available on all devices.</p> 1421 * 1422 * @see CameraCharacteristics#CONTROL_AVAILABLE_EFFECTS 1423 * @see #CONTROL_EFFECT_MODE_OFF 1424 * @see #CONTROL_EFFECT_MODE_MONO 1425 * @see #CONTROL_EFFECT_MODE_NEGATIVE 1426 * @see #CONTROL_EFFECT_MODE_SOLARIZE 1427 * @see #CONTROL_EFFECT_MODE_SEPIA 1428 * @see #CONTROL_EFFECT_MODE_POSTERIZE 1429 * @see #CONTROL_EFFECT_MODE_WHITEBOARD 1430 * @see #CONTROL_EFFECT_MODE_BLACKBOARD 1431 * @see #CONTROL_EFFECT_MODE_AQUA 1432 */ 1433 @PublicKey 1434 public static final Key<Integer> CONTROL_EFFECT_MODE = 1435 new Key<Integer>("android.control.effectMode", int.class); 1436 1437 /** 1438 * <p>Overall mode of 3A (auto-exposure, auto-white-balance, auto-focus) control 1439 * routines.</p> 1440 * <p>This is a top-level 3A control switch. When set to OFF, all 3A control 1441 * by the camera device is disabled. The application must set the fields for 1442 * capture parameters itself.</p> 1443 * <p>When set to AUTO, the individual algorithm controls in 1444 * android.control.* are in effect, such as {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}.</p> 1445 * <p>When set to USE_SCENE_MODE, the individual controls in 1446 * android.control.* are mostly disabled, and the camera device implements 1447 * one of the scene mode settings (such as ACTION, SUNSET, or PARTY) 1448 * as it wishes. The camera device scene mode 3A settings are provided by 1449 * {@link android.hardware.camera2.CaptureResult capture results}.</p> 1450 * <p>When set to OFF_KEEP_STATE, it is similar to OFF mode, the only difference 1451 * is that this frame will not be used by camera device background 3A statistics 1452 * update, as if this frame is never captured. This mode can be used in the scenario 1453 * where the application doesn't want a 3A manual control capture to affect 1454 * the subsequent auto 3A capture results.</p> 1455 * <p><b>Possible values:</b> 1456 * <ul> 1457 * <li>{@link #CONTROL_MODE_OFF OFF}</li> 1458 * <li>{@link #CONTROL_MODE_AUTO AUTO}</li> 1459 * <li>{@link #CONTROL_MODE_USE_SCENE_MODE USE_SCENE_MODE}</li> 1460 * <li>{@link #CONTROL_MODE_OFF_KEEP_STATE OFF_KEEP_STATE}</li> 1461 * </ul></p> 1462 * <p><b>Available values for this device:</b><br> 1463 * {@link CameraCharacteristics#CONTROL_AVAILABLE_MODES android.control.availableModes}</p> 1464 * <p>This key is available on all devices.</p> 1465 * 1466 * @see CaptureRequest#CONTROL_AF_MODE 1467 * @see CameraCharacteristics#CONTROL_AVAILABLE_MODES 1468 * @see #CONTROL_MODE_OFF 1469 * @see #CONTROL_MODE_AUTO 1470 * @see #CONTROL_MODE_USE_SCENE_MODE 1471 * @see #CONTROL_MODE_OFF_KEEP_STATE 1472 */ 1473 @PublicKey 1474 public static final Key<Integer> CONTROL_MODE = 1475 new Key<Integer>("android.control.mode", int.class); 1476 1477 /** 1478 * <p>Control for which scene mode is currently active.</p> 1479 * <p>Scene modes are custom camera modes optimized for a certain set of conditions and 1480 * capture settings.</p> 1481 * <p>This is the mode that that is active when 1482 * <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code>. Aside from FACE_PRIORITY, these modes will 1483 * disable {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode}, {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, and {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} 1484 * while in use.</p> 1485 * <p>The interpretation and implementation of these scene modes is left 1486 * to the implementor of the camera device. Their behavior will not be 1487 * consistent across all devices, and any given device may only implement 1488 * a subset of these modes.</p> 1489 * <p><b>Possible values:</b> 1490 * <ul> 1491 * <li>{@link #CONTROL_SCENE_MODE_DISABLED DISABLED}</li> 1492 * <li>{@link #CONTROL_SCENE_MODE_FACE_PRIORITY FACE_PRIORITY}</li> 1493 * <li>{@link #CONTROL_SCENE_MODE_ACTION ACTION}</li> 1494 * <li>{@link #CONTROL_SCENE_MODE_PORTRAIT PORTRAIT}</li> 1495 * <li>{@link #CONTROL_SCENE_MODE_LANDSCAPE LANDSCAPE}</li> 1496 * <li>{@link #CONTROL_SCENE_MODE_NIGHT NIGHT}</li> 1497 * <li>{@link #CONTROL_SCENE_MODE_NIGHT_PORTRAIT NIGHT_PORTRAIT}</li> 1498 * <li>{@link #CONTROL_SCENE_MODE_THEATRE THEATRE}</li> 1499 * <li>{@link #CONTROL_SCENE_MODE_BEACH BEACH}</li> 1500 * <li>{@link #CONTROL_SCENE_MODE_SNOW SNOW}</li> 1501 * <li>{@link #CONTROL_SCENE_MODE_SUNSET SUNSET}</li> 1502 * <li>{@link #CONTROL_SCENE_MODE_STEADYPHOTO STEADYPHOTO}</li> 1503 * <li>{@link #CONTROL_SCENE_MODE_FIREWORKS FIREWORKS}</li> 1504 * <li>{@link #CONTROL_SCENE_MODE_SPORTS SPORTS}</li> 1505 * <li>{@link #CONTROL_SCENE_MODE_PARTY PARTY}</li> 1506 * <li>{@link #CONTROL_SCENE_MODE_CANDLELIGHT CANDLELIGHT}</li> 1507 * <li>{@link #CONTROL_SCENE_MODE_BARCODE BARCODE}</li> 1508 * <li>{@link #CONTROL_SCENE_MODE_HIGH_SPEED_VIDEO HIGH_SPEED_VIDEO}</li> 1509 * <li>{@link #CONTROL_SCENE_MODE_HDR HDR}</li> 1510 * </ul></p> 1511 * <p><b>Available values for this device:</b><br> 1512 * {@link CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES android.control.availableSceneModes}</p> 1513 * <p>This key is available on all devices.</p> 1514 * 1515 * @see CaptureRequest#CONTROL_AE_MODE 1516 * @see CaptureRequest#CONTROL_AF_MODE 1517 * @see CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES 1518 * @see CaptureRequest#CONTROL_AWB_MODE 1519 * @see CaptureRequest#CONTROL_MODE 1520 * @see #CONTROL_SCENE_MODE_DISABLED 1521 * @see #CONTROL_SCENE_MODE_FACE_PRIORITY 1522 * @see #CONTROL_SCENE_MODE_ACTION 1523 * @see #CONTROL_SCENE_MODE_PORTRAIT 1524 * @see #CONTROL_SCENE_MODE_LANDSCAPE 1525 * @see #CONTROL_SCENE_MODE_NIGHT 1526 * @see #CONTROL_SCENE_MODE_NIGHT_PORTRAIT 1527 * @see #CONTROL_SCENE_MODE_THEATRE 1528 * @see #CONTROL_SCENE_MODE_BEACH 1529 * @see #CONTROL_SCENE_MODE_SNOW 1530 * @see #CONTROL_SCENE_MODE_SUNSET 1531 * @see #CONTROL_SCENE_MODE_STEADYPHOTO 1532 * @see #CONTROL_SCENE_MODE_FIREWORKS 1533 * @see #CONTROL_SCENE_MODE_SPORTS 1534 * @see #CONTROL_SCENE_MODE_PARTY 1535 * @see #CONTROL_SCENE_MODE_CANDLELIGHT 1536 * @see #CONTROL_SCENE_MODE_BARCODE 1537 * @see #CONTROL_SCENE_MODE_HIGH_SPEED_VIDEO 1538 * @see #CONTROL_SCENE_MODE_HDR 1539 */ 1540 @PublicKey 1541 public static final Key<Integer> CONTROL_SCENE_MODE = 1542 new Key<Integer>("android.control.sceneMode", int.class); 1543 1544 /** 1545 * <p>Whether video stabilization is 1546 * active.</p> 1547 * <p>Video stabilization automatically translates and scales images from 1548 * the camera in order to stabilize motion between consecutive frames.</p> 1549 * <p>If enabled, video stabilization can modify the 1550 * {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} to keep the video stream stabilized.</p> 1551 * <p>Switching between different video stabilization modes may take several 1552 * frames to initialize, the camera device will report the current mode 1553 * in capture result metadata. For example, When "ON" mode is requested, 1554 * the video stabilization modes in the first several capture results may 1555 * still be "OFF", and it will become "ON" when the initialization is 1556 * done.</p> 1557 * <p>If a camera device supports both this mode and OIS 1558 * ({@link CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE android.lens.opticalStabilizationMode}), turning both modes on may 1559 * produce undesirable interaction, so it is recommended not to enable 1560 * both at the same time.</p> 1561 * <p><b>Possible values:</b> 1562 * <ul> 1563 * <li>{@link #CONTROL_VIDEO_STABILIZATION_MODE_OFF OFF}</li> 1564 * <li>{@link #CONTROL_VIDEO_STABILIZATION_MODE_ON ON}</li> 1565 * </ul></p> 1566 * <p>This key is available on all devices.</p> 1567 * 1568 * @see CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE 1569 * @see CaptureRequest#SCALER_CROP_REGION 1570 * @see #CONTROL_VIDEO_STABILIZATION_MODE_OFF 1571 * @see #CONTROL_VIDEO_STABILIZATION_MODE_ON 1572 */ 1573 @PublicKey 1574 public static final Key<Integer> CONTROL_VIDEO_STABILIZATION_MODE = 1575 new Key<Integer>("android.control.videoStabilizationMode", int.class); 1576 1577 /** 1578 * <p>Operation mode for edge 1579 * enhancement.</p> 1580 * <p>Edge enhancement improves sharpness and details in the captured image. OFF means 1581 * no enhancement will be applied by the camera device.</p> 1582 * <p>FAST/HIGH_QUALITY both mean camera device determined enhancement 1583 * will be applied. HIGH_QUALITY mode indicates that the 1584 * camera device will use the highest-quality enhancement algorithms, 1585 * even if it slows down capture rate. FAST means the camera device will 1586 * not slow down capture rate when applying edge enhancement.</p> 1587 * <p>For YUV_REPROCESSING, these FAST/HIGH_QUALITY modes both mean that the camera 1588 * device will apply FAST/HIGH_QUALITY YUV-domain edge enhancement, respectively. 1589 * The camera device may adjust its internal noise reduction parameters for best 1590 * image quality based on the {@link CaptureRequest#REPROCESS_EFFECTIVE_EXPOSURE_FACTOR android.reprocess.effectiveExposureFactor}, if it is set.</p> 1591 * <p><b>Possible values:</b> 1592 * <ul> 1593 * <li>{@link #EDGE_MODE_OFF OFF}</li> 1594 * <li>{@link #EDGE_MODE_FAST FAST}</li> 1595 * <li>{@link #EDGE_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 1596 * </ul></p> 1597 * <p><b>Available values for this device:</b><br> 1598 * {@link CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES android.edge.availableEdgeModes}</p> 1599 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1600 * <p><b>Full capability</b> - 1601 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 1602 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 1603 * 1604 * @see CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES 1605 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 1606 * @see CaptureRequest#REPROCESS_EFFECTIVE_EXPOSURE_FACTOR 1607 * @see #EDGE_MODE_OFF 1608 * @see #EDGE_MODE_FAST 1609 * @see #EDGE_MODE_HIGH_QUALITY 1610 */ 1611 @PublicKey 1612 public static final Key<Integer> EDGE_MODE = 1613 new Key<Integer>("android.edge.mode", int.class); 1614 1615 /** 1616 * <p>The desired mode for for the camera device's flash control.</p> 1617 * <p>This control is only effective when flash unit is available 1618 * (<code>{@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} == true</code>).</p> 1619 * <p>When this control is used, the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} must be set to ON or OFF. 1620 * Otherwise, the camera device auto-exposure related flash control (ON_AUTO_FLASH, 1621 * ON_ALWAYS_FLASH, or ON_AUTO_FLASH_REDEYE) will override this control.</p> 1622 * <p>When set to OFF, the camera device will not fire flash for this capture.</p> 1623 * <p>When set to SINGLE, the camera device will fire flash regardless of the camera 1624 * device's auto-exposure routine's result. When used in still capture case, this 1625 * control should be used along with auto-exposure (AE) precapture metering sequence 1626 * ({@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}), otherwise, the image may be incorrectly exposed.</p> 1627 * <p>When set to TORCH, the flash will be on continuously. This mode can be used 1628 * for use cases such as preview, auto-focus assist, still capture, or video recording.</p> 1629 * <p>The flash status will be reported by {@link CaptureResult#FLASH_STATE android.flash.state} in the capture result metadata.</p> 1630 * <p><b>Possible values:</b> 1631 * <ul> 1632 * <li>{@link #FLASH_MODE_OFF OFF}</li> 1633 * <li>{@link #FLASH_MODE_SINGLE SINGLE}</li> 1634 * <li>{@link #FLASH_MODE_TORCH TORCH}</li> 1635 * </ul></p> 1636 * <p>This key is available on all devices.</p> 1637 * 1638 * @see CaptureRequest#CONTROL_AE_MODE 1639 * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER 1640 * @see CameraCharacteristics#FLASH_INFO_AVAILABLE 1641 * @see CaptureResult#FLASH_STATE 1642 * @see #FLASH_MODE_OFF 1643 * @see #FLASH_MODE_SINGLE 1644 * @see #FLASH_MODE_TORCH 1645 */ 1646 @PublicKey 1647 public static final Key<Integer> FLASH_MODE = 1648 new Key<Integer>("android.flash.mode", int.class); 1649 1650 /** 1651 * <p>Operational mode for hot pixel correction.</p> 1652 * <p>Hotpixel correction interpolates out, or otherwise removes, pixels 1653 * that do not accurately measure the incoming light (i.e. pixels that 1654 * are stuck at an arbitrary value or are oversensitive).</p> 1655 * <p><b>Possible values:</b> 1656 * <ul> 1657 * <li>{@link #HOT_PIXEL_MODE_OFF OFF}</li> 1658 * <li>{@link #HOT_PIXEL_MODE_FAST FAST}</li> 1659 * <li>{@link #HOT_PIXEL_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 1660 * </ul></p> 1661 * <p><b>Available values for this device:</b><br> 1662 * {@link CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES android.hotPixel.availableHotPixelModes}</p> 1663 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1664 * 1665 * @see CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES 1666 * @see #HOT_PIXEL_MODE_OFF 1667 * @see #HOT_PIXEL_MODE_FAST 1668 * @see #HOT_PIXEL_MODE_HIGH_QUALITY 1669 */ 1670 @PublicKey 1671 public static final Key<Integer> HOT_PIXEL_MODE = 1672 new Key<Integer>("android.hotPixel.mode", int.class); 1673 1674 /** 1675 * <p>A location object to use when generating image GPS metadata.</p> 1676 * <p>Setting a location object in a request will include the GPS coordinates of the location 1677 * into any JPEG images captured based on the request. These coordinates can then be 1678 * viewed by anyone who receives the JPEG image.</p> 1679 * <p>This key is available on all devices.</p> 1680 */ 1681 @PublicKey 1682 @SyntheticKey 1683 public static final Key<android.location.Location> JPEG_GPS_LOCATION = 1684 new Key<android.location.Location>("android.jpeg.gpsLocation", android.location.Location.class); 1685 1686 /** 1687 * <p>GPS coordinates to include in output JPEG 1688 * EXIF.</p> 1689 * <p><b>Range of valid values:</b><br> 1690 * (-180 - 180], [-90,90], [-inf, inf]</p> 1691 * <p>This key is available on all devices.</p> 1692 * @hide 1693 */ 1694 public static final Key<double[]> JPEG_GPS_COORDINATES = 1695 new Key<double[]>("android.jpeg.gpsCoordinates", double[].class); 1696 1697 /** 1698 * <p>32 characters describing GPS algorithm to 1699 * include in EXIF.</p> 1700 * <p><b>Units</b>: UTF-8 null-terminated string</p> 1701 * <p>This key is available on all devices.</p> 1702 * @hide 1703 */ 1704 public static final Key<String> JPEG_GPS_PROCESSING_METHOD = 1705 new Key<String>("android.jpeg.gpsProcessingMethod", String.class); 1706 1707 /** 1708 * <p>Time GPS fix was made to include in 1709 * EXIF.</p> 1710 * <p><b>Units</b>: UTC in seconds since January 1, 1970</p> 1711 * <p>This key is available on all devices.</p> 1712 * @hide 1713 */ 1714 public static final Key<Long> JPEG_GPS_TIMESTAMP = 1715 new Key<Long>("android.jpeg.gpsTimestamp", long.class); 1716 1717 /** 1718 * <p>The orientation for a JPEG image.</p> 1719 * <p>The clockwise rotation angle in degrees, relative to the orientation 1720 * to the camera, that the JPEG picture needs to be rotated by, to be viewed 1721 * upright.</p> 1722 * <p>Camera devices may either encode this value into the JPEG EXIF header, or 1723 * rotate the image data to match this orientation. When the image data is rotated, 1724 * the thumbnail data will also be rotated.</p> 1725 * <p>Note that this orientation is relative to the orientation of the camera sensor, given 1726 * by {@link CameraCharacteristics#SENSOR_ORIENTATION android.sensor.orientation}.</p> 1727 * <p>To translate from the device orientation given by the Android sensor APIs, the following 1728 * sample code may be used:</p> 1729 * <pre><code>private int getJpegOrientation(CameraCharacteristics c, int deviceOrientation) { 1730 * if (deviceOrientation == android.view.OrientationEventListener.ORIENTATION_UNKNOWN) return 0; 1731 * int sensorOrientation = c.get(CameraCharacteristics.SENSOR_ORIENTATION); 1732 * 1733 * // Round device orientation to a multiple of 90 1734 * deviceOrientation = (deviceOrientation + 45) / 90 * 90; 1735 * 1736 * // Reverse device orientation for front-facing cameras 1737 * boolean facingFront = c.get(CameraCharacteristics.LENS_FACING) == CameraCharacteristics.LENS_FACING_FRONT; 1738 * if (facingFront) deviceOrientation = -deviceOrientation; 1739 * 1740 * // Calculate desired JPEG orientation relative to camera orientation to make 1741 * // the image upright relative to the device orientation 1742 * int jpegOrientation = (sensorOrientation + deviceOrientation + 360) % 360; 1743 * 1744 * return jpegOrientation; 1745 * } 1746 * </code></pre> 1747 * <p><b>Units</b>: Degrees in multiples of 90</p> 1748 * <p><b>Range of valid values:</b><br> 1749 * 0, 90, 180, 270</p> 1750 * <p>This key is available on all devices.</p> 1751 * 1752 * @see CameraCharacteristics#SENSOR_ORIENTATION 1753 */ 1754 @PublicKey 1755 public static final Key<Integer> JPEG_ORIENTATION = 1756 new Key<Integer>("android.jpeg.orientation", int.class); 1757 1758 /** 1759 * <p>Compression quality of the final JPEG 1760 * image.</p> 1761 * <p>85-95 is typical usage range.</p> 1762 * <p><b>Range of valid values:</b><br> 1763 * 1-100; larger is higher quality</p> 1764 * <p>This key is available on all devices.</p> 1765 */ 1766 @PublicKey 1767 public static final Key<Byte> JPEG_QUALITY = 1768 new Key<Byte>("android.jpeg.quality", byte.class); 1769 1770 /** 1771 * <p>Compression quality of JPEG 1772 * thumbnail.</p> 1773 * <p><b>Range of valid values:</b><br> 1774 * 1-100; larger is higher quality</p> 1775 * <p>This key is available on all devices.</p> 1776 */ 1777 @PublicKey 1778 public static final Key<Byte> JPEG_THUMBNAIL_QUALITY = 1779 new Key<Byte>("android.jpeg.thumbnailQuality", byte.class); 1780 1781 /** 1782 * <p>Resolution of embedded JPEG thumbnail.</p> 1783 * <p>When set to (0, 0) value, the JPEG EXIF will not contain thumbnail, 1784 * but the captured JPEG will still be a valid image.</p> 1785 * <p>For best results, when issuing a request for a JPEG image, the thumbnail size selected 1786 * should have the same aspect ratio as the main JPEG output.</p> 1787 * <p>If the thumbnail image aspect ratio differs from the JPEG primary image aspect 1788 * ratio, the camera device creates the thumbnail by cropping it from the primary image. 1789 * For example, if the primary image has 4:3 aspect ratio, the thumbnail image has 1790 * 16:9 aspect ratio, the primary image will be cropped vertically (letterbox) to 1791 * generate the thumbnail image. The thumbnail image will always have a smaller Field 1792 * Of View (FOV) than the primary image when aspect ratios differ.</p> 1793 * <p>When an {@link CaptureRequest#JPEG_ORIENTATION android.jpeg.orientation} of non-zero degree is requested, 1794 * the camera device will handle thumbnail rotation in one of the following ways:</p> 1795 * <ul> 1796 * <li>Set the {@link android.media.ExifInterface#TAG_ORIENTATION EXIF orientation flag} 1797 * and keep jpeg and thumbnail image data unrotated.</li> 1798 * <li>Rotate the jpeg and thumbnail image data and not set 1799 * {@link android.media.ExifInterface#TAG_ORIENTATION EXIF orientation flag}. In this 1800 * case, LIMITED or FULL hardware level devices will report rotated thumnail size in 1801 * capture result, so the width and height will be interchanged if 90 or 270 degree 1802 * orientation is requested. LEGACY device will always report unrotated thumbnail 1803 * size.</li> 1804 * </ul> 1805 * <p><b>Range of valid values:</b><br> 1806 * {@link CameraCharacteristics#JPEG_AVAILABLE_THUMBNAIL_SIZES android.jpeg.availableThumbnailSizes}</p> 1807 * <p>This key is available on all devices.</p> 1808 * 1809 * @see CameraCharacteristics#JPEG_AVAILABLE_THUMBNAIL_SIZES 1810 * @see CaptureRequest#JPEG_ORIENTATION 1811 */ 1812 @PublicKey 1813 public static final Key<android.util.Size> JPEG_THUMBNAIL_SIZE = 1814 new Key<android.util.Size>("android.jpeg.thumbnailSize", android.util.Size.class); 1815 1816 /** 1817 * <p>The desired lens aperture size, as a ratio of lens focal length to the 1818 * effective aperture diameter.</p> 1819 * <p>Setting this value is only supported on the camera devices that have a variable 1820 * aperture lens.</p> 1821 * <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is OFF, 1822 * this can be set along with {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, 1823 * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration} 1824 * to achieve manual exposure control.</p> 1825 * <p>The requested aperture value may take several frames to reach the 1826 * requested value; the camera device will report the current (intermediate) 1827 * aperture size in capture result metadata while the aperture is changing. 1828 * While the aperture is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> 1829 * <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is one of 1830 * the ON modes, this will be overridden by the camera device 1831 * auto-exposure algorithm, the overridden values are then provided 1832 * back to the user in the corresponding result.</p> 1833 * <p><b>Units</b>: The f-number (f/N)</p> 1834 * <p><b>Range of valid values:</b><br> 1835 * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES android.lens.info.availableApertures}</p> 1836 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1837 * <p><b>Full capability</b> - 1838 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 1839 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 1840 * 1841 * @see CaptureRequest#CONTROL_AE_MODE 1842 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 1843 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES 1844 * @see CaptureResult#LENS_STATE 1845 * @see CaptureRequest#SENSOR_EXPOSURE_TIME 1846 * @see CaptureRequest#SENSOR_FRAME_DURATION 1847 * @see CaptureRequest#SENSOR_SENSITIVITY 1848 */ 1849 @PublicKey 1850 public static final Key<Float> LENS_APERTURE = 1851 new Key<Float>("android.lens.aperture", float.class); 1852 1853 /** 1854 * <p>The desired setting for the lens neutral density filter(s).</p> 1855 * <p>This control will not be supported on most camera devices.</p> 1856 * <p>Lens filters are typically used to lower the amount of light the 1857 * sensor is exposed to (measured in steps of EV). As used here, an EV 1858 * step is the standard logarithmic representation, which are 1859 * non-negative, and inversely proportional to the amount of light 1860 * hitting the sensor. For example, setting this to 0 would result 1861 * in no reduction of the incoming light, and setting this to 2 would 1862 * mean that the filter is set to reduce incoming light by two stops 1863 * (allowing 1/4 of the prior amount of light to the sensor).</p> 1864 * <p>It may take several frames before the lens filter density changes 1865 * to the requested value. While the filter density is still changing, 1866 * {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> 1867 * <p><b>Units</b>: Exposure Value (EV)</p> 1868 * <p><b>Range of valid values:</b><br> 1869 * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES android.lens.info.availableFilterDensities}</p> 1870 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1871 * <p><b>Full capability</b> - 1872 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 1873 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 1874 * 1875 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 1876 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES 1877 * @see CaptureResult#LENS_STATE 1878 */ 1879 @PublicKey 1880 public static final Key<Float> LENS_FILTER_DENSITY = 1881 new Key<Float>("android.lens.filterDensity", float.class); 1882 1883 /** 1884 * <p>The desired lens focal length; used for optical zoom.</p> 1885 * <p>This setting controls the physical focal length of the camera 1886 * device's lens. Changing the focal length changes the field of 1887 * view of the camera device, and is usually used for optical zoom.</p> 1888 * <p>Like {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance} and {@link CaptureRequest#LENS_APERTURE android.lens.aperture}, this 1889 * setting won't be applied instantaneously, and it may take several 1890 * frames before the lens can change to the requested focal length. 1891 * While the focal length is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will 1892 * be set to MOVING.</p> 1893 * <p>Optical zoom will not be supported on most devices.</p> 1894 * <p><b>Units</b>: Millimeters</p> 1895 * <p><b>Range of valid values:</b><br> 1896 * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS android.lens.info.availableFocalLengths}</p> 1897 * <p>This key is available on all devices.</p> 1898 * 1899 * @see CaptureRequest#LENS_APERTURE 1900 * @see CaptureRequest#LENS_FOCUS_DISTANCE 1901 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS 1902 * @see CaptureResult#LENS_STATE 1903 */ 1904 @PublicKey 1905 public static final Key<Float> LENS_FOCAL_LENGTH = 1906 new Key<Float>("android.lens.focalLength", float.class); 1907 1908 /** 1909 * <p>Desired distance to plane of sharpest focus, 1910 * measured from frontmost surface of the lens.</p> 1911 * <p>This control can be used for setting manual focus, on devices that support 1912 * the MANUAL_SENSOR capability and have a variable-focus lens (see 1913 * {@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance}).</p> 1914 * <p>A value of <code>0.0f</code> means infinity focus. The value set will be clamped to 1915 * <code>[0.0f, {@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance}]</code>.</p> 1916 * <p>Like {@link CaptureRequest#LENS_FOCAL_LENGTH android.lens.focalLength}, this setting won't be applied 1917 * instantaneously, and it may take several frames before the lens 1918 * can move to the requested focus distance. While the lens is still moving, 1919 * {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p> 1920 * <p>LEGACY devices support at most setting this to <code>0.0f</code> 1921 * for infinity focus.</p> 1922 * <p><b>Units</b>: See {@link CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION android.lens.info.focusDistanceCalibration} for details</p> 1923 * <p><b>Range of valid values:</b><br> 1924 * >= 0</p> 1925 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1926 * <p><b>Full capability</b> - 1927 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 1928 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 1929 * 1930 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 1931 * @see CaptureRequest#LENS_FOCAL_LENGTH 1932 * @see CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION 1933 * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE 1934 * @see CaptureResult#LENS_STATE 1935 */ 1936 @PublicKey 1937 public static final Key<Float> LENS_FOCUS_DISTANCE = 1938 new Key<Float>("android.lens.focusDistance", float.class); 1939 1940 /** 1941 * <p>Sets whether the camera device uses optical image stabilization (OIS) 1942 * when capturing images.</p> 1943 * <p>OIS is used to compensate for motion blur due to small 1944 * movements of the camera during capture. Unlike digital image 1945 * stabilization ({@link CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE android.control.videoStabilizationMode}), OIS 1946 * makes use of mechanical elements to stabilize the camera 1947 * sensor, and thus allows for longer exposure times before 1948 * camera shake becomes apparent.</p> 1949 * <p>Switching between different optical stabilization modes may take several 1950 * frames to initialize, the camera device will report the current mode in 1951 * capture result metadata. For example, When "ON" mode is requested, the 1952 * optical stabilization modes in the first several capture results may still 1953 * be "OFF", and it will become "ON" when the initialization is done.</p> 1954 * <p>If a camera device supports both OIS and digital image stabilization 1955 * ({@link CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE android.control.videoStabilizationMode}), turning both modes on may produce undesirable 1956 * interaction, so it is recommended not to enable both at the same time.</p> 1957 * <p>Not all devices will support OIS; see 1958 * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION android.lens.info.availableOpticalStabilization} for 1959 * available controls.</p> 1960 * <p><b>Possible values:</b> 1961 * <ul> 1962 * <li>{@link #LENS_OPTICAL_STABILIZATION_MODE_OFF OFF}</li> 1963 * <li>{@link #LENS_OPTICAL_STABILIZATION_MODE_ON ON}</li> 1964 * </ul></p> 1965 * <p><b>Available values for this device:</b><br> 1966 * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION android.lens.info.availableOpticalStabilization}</p> 1967 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 1968 * <p><b>Limited capability</b> - 1969 * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the 1970 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 1971 * 1972 * @see CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE 1973 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 1974 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION 1975 * @see #LENS_OPTICAL_STABILIZATION_MODE_OFF 1976 * @see #LENS_OPTICAL_STABILIZATION_MODE_ON 1977 */ 1978 @PublicKey 1979 public static final Key<Integer> LENS_OPTICAL_STABILIZATION_MODE = 1980 new Key<Integer>("android.lens.opticalStabilizationMode", int.class); 1981 1982 /** 1983 * <p>Mode of operation for the noise reduction algorithm.</p> 1984 * <p>The noise reduction algorithm attempts to improve image quality by removing 1985 * excessive noise added by the capture process, especially in dark conditions.</p> 1986 * <p>OFF means no noise reduction will be applied by the camera device, for both raw and 1987 * YUV domain.</p> 1988 * <p>MINIMAL means that only sensor raw domain basic noise reduction is enabled ,to remove 1989 * demosaicing or other processing artifacts. For YUV_REPROCESSING, MINIMAL is same as OFF. 1990 * This mode is optional, may not be support by all devices. The application should check 1991 * {@link CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES android.noiseReduction.availableNoiseReductionModes} before using it.</p> 1992 * <p>FAST/HIGH_QUALITY both mean camera device determined noise filtering 1993 * will be applied. HIGH_QUALITY mode indicates that the camera device 1994 * will use the highest-quality noise filtering algorithms, 1995 * even if it slows down capture rate. FAST means the camera device will not 1996 * slow down capture rate when applying noise filtering.</p> 1997 * <p>For YUV_REPROCESSING, these FAST/HIGH_QUALITY modes both mean that the camera device 1998 * will apply FAST/HIGH_QUALITY YUV domain noise reduction, respectively. The camera device 1999 * may adjust the noise reduction parameters for best image quality based on the 2000 * {@link CaptureRequest#REPROCESS_EFFECTIVE_EXPOSURE_FACTOR android.reprocess.effectiveExposureFactor} if it is set.</p> 2001 * <p><b>Possible values:</b> 2002 * <ul> 2003 * <li>{@link #NOISE_REDUCTION_MODE_OFF OFF}</li> 2004 * <li>{@link #NOISE_REDUCTION_MODE_FAST FAST}</li> 2005 * <li>{@link #NOISE_REDUCTION_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 2006 * <li>{@link #NOISE_REDUCTION_MODE_MINIMAL MINIMAL}</li> 2007 * </ul></p> 2008 * <p><b>Available values for this device:</b><br> 2009 * {@link CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES android.noiseReduction.availableNoiseReductionModes}</p> 2010 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2011 * <p><b>Full capability</b> - 2012 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 2013 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2014 * 2015 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2016 * @see CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES 2017 * @see CaptureRequest#REPROCESS_EFFECTIVE_EXPOSURE_FACTOR 2018 * @see #NOISE_REDUCTION_MODE_OFF 2019 * @see #NOISE_REDUCTION_MODE_FAST 2020 * @see #NOISE_REDUCTION_MODE_HIGH_QUALITY 2021 * @see #NOISE_REDUCTION_MODE_MINIMAL 2022 */ 2023 @PublicKey 2024 public static final Key<Integer> NOISE_REDUCTION_MODE = 2025 new Key<Integer>("android.noiseReduction.mode", int.class); 2026 2027 /** 2028 * <p>An application-specified ID for the current 2029 * request. Must be maintained unchanged in output 2030 * frame</p> 2031 * <p><b>Units</b>: arbitrary integer assigned by application</p> 2032 * <p><b>Range of valid values:</b><br> 2033 * Any int</p> 2034 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2035 * @hide 2036 */ 2037 public static final Key<Integer> REQUEST_ID = 2038 new Key<Integer>("android.request.id", int.class); 2039 2040 /** 2041 * <p>The desired region of the sensor to read out for this capture.</p> 2042 * <p>This control can be used to implement digital zoom.</p> 2043 * <p>The crop region coordinate system is based off 2044 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}, with <code>(0, 0)</code> being the 2045 * top-left corner of the sensor active array.</p> 2046 * <p>Output streams use this rectangle to produce their output, 2047 * cropping to a smaller region if necessary to maintain the 2048 * stream's aspect ratio, then scaling the sensor input to 2049 * match the output's configured resolution.</p> 2050 * <p>The crop region is applied after the RAW to other color 2051 * space (e.g. YUV) conversion. Since raw streams 2052 * (e.g. RAW16) don't have the conversion stage, they are not 2053 * croppable. The crop region will be ignored by raw streams.</p> 2054 * <p>For non-raw streams, any additional per-stream cropping will 2055 * be done to maximize the final pixel area of the stream.</p> 2056 * <p>For example, if the crop region is set to a 4:3 aspect 2057 * ratio, then 4:3 streams will use the exact crop 2058 * region. 16:9 streams will further crop vertically 2059 * (letterbox).</p> 2060 * <p>Conversely, if the crop region is set to a 16:9, then 4:3 2061 * outputs will crop horizontally (pillarbox), and 16:9 2062 * streams will match exactly. These additional crops will 2063 * be centered within the crop region.</p> 2064 * <p>The width and height of the crop region cannot 2065 * be set to be smaller than 2066 * <code>floor( activeArraySize.width / {@link CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom} )</code> and 2067 * <code>floor( activeArraySize.height / {@link CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom} )</code>, respectively.</p> 2068 * <p>The camera device may adjust the crop region to account 2069 * for rounding and other hardware requirements; the final 2070 * crop region used will be included in the output capture 2071 * result.</p> 2072 * <p><b>Units</b>: Pixel coordinates relative to 2073 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p> 2074 * <p>This key is available on all devices.</p> 2075 * 2076 * @see CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM 2077 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE 2078 */ 2079 @PublicKey 2080 public static final Key<android.graphics.Rect> SCALER_CROP_REGION = 2081 new Key<android.graphics.Rect>("android.scaler.cropRegion", android.graphics.Rect.class); 2082 2083 /** 2084 * <p>Duration each pixel is exposed to 2085 * light.</p> 2086 * <p>If the sensor can't expose this exact duration, it will shorten the 2087 * duration exposed to the nearest possible value (rather than expose longer). 2088 * The final exposure time used will be available in the output capture result.</p> 2089 * <p>This control is only effective if {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link CaptureRequest#CONTROL_MODE android.control.mode} is set to 2090 * OFF; otherwise the auto-exposure algorithm will override this value.</p> 2091 * <p><b>Units</b>: Nanoseconds</p> 2092 * <p><b>Range of valid values:</b><br> 2093 * {@link CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE android.sensor.info.exposureTimeRange}</p> 2094 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2095 * <p><b>Full capability</b> - 2096 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 2097 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2098 * 2099 * @see CaptureRequest#CONTROL_AE_MODE 2100 * @see CaptureRequest#CONTROL_MODE 2101 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2102 * @see CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE 2103 */ 2104 @PublicKey 2105 public static final Key<Long> SENSOR_EXPOSURE_TIME = 2106 new Key<Long>("android.sensor.exposureTime", long.class); 2107 2108 /** 2109 * <p>Duration from start of frame exposure to 2110 * start of next frame exposure.</p> 2111 * <p>The maximum frame rate that can be supported by a camera subsystem is 2112 * a function of many factors:</p> 2113 * <ul> 2114 * <li>Requested resolutions of output image streams</li> 2115 * <li>Availability of binning / skipping modes on the imager</li> 2116 * <li>The bandwidth of the imager interface</li> 2117 * <li>The bandwidth of the various ISP processing blocks</li> 2118 * </ul> 2119 * <p>Since these factors can vary greatly between different ISPs and 2120 * sensors, the camera abstraction tries to represent the bandwidth 2121 * restrictions with as simple a model as possible.</p> 2122 * <p>The model presented has the following characteristics:</p> 2123 * <ul> 2124 * <li>The image sensor is always configured to output the smallest 2125 * resolution possible given the application's requested output stream 2126 * sizes. The smallest resolution is defined as being at least as large 2127 * as the largest requested output stream size; the camera pipeline must 2128 * never digitally upsample sensor data when the crop region covers the 2129 * whole sensor. In general, this means that if only small output stream 2130 * resolutions are configured, the sensor can provide a higher frame 2131 * rate.</li> 2132 * <li>Since any request may use any or all the currently configured 2133 * output streams, the sensor and ISP must be configured to support 2134 * scaling a single capture to all the streams at the same time. This 2135 * means the camera pipeline must be ready to produce the largest 2136 * requested output size without any delay. Therefore, the overall 2137 * frame rate of a given configured stream set is governed only by the 2138 * largest requested stream resolution.</li> 2139 * <li>Using more than one output stream in a request does not affect the 2140 * frame duration.</li> 2141 * <li>Certain format-streams may need to do additional background processing 2142 * before data is consumed/produced by that stream. These processors 2143 * can run concurrently to the rest of the camera pipeline, but 2144 * cannot process more than 1 capture at a time.</li> 2145 * </ul> 2146 * <p>The necessary information for the application, given the model above, 2147 * is provided via the {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} field using 2148 * {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputMinFrameDuration }. 2149 * These are used to determine the maximum frame rate / minimum frame 2150 * duration that is possible for a given stream configuration.</p> 2151 * <p>Specifically, the application can use the following rules to 2152 * determine the minimum frame duration it can request from the camera 2153 * device:</p> 2154 * <ol> 2155 * <li>Let the set of currently configured input/output streams 2156 * be called <code>S</code>.</li> 2157 * <li>Find the minimum frame durations for each stream in <code>S</code>, by looking 2158 * it up in {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} using {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputMinFrameDuration } 2159 * (with its respective size/format). Let this set of frame durations be 2160 * called <code>F</code>.</li> 2161 * <li>For any given request <code>R</code>, the minimum frame duration allowed 2162 * for <code>R</code> is the maximum out of all values in <code>F</code>. Let the streams 2163 * used in <code>R</code> be called <code>S_r</code>.</li> 2164 * </ol> 2165 * <p>If none of the streams in <code>S_r</code> have a stall time (listed in {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputStallDuration } 2166 * using its respective size/format), then the frame duration in <code>F</code> 2167 * determines the steady state frame rate that the application will get 2168 * if it uses <code>R</code> as a repeating request. Let this special kind of 2169 * request be called <code>Rsimple</code>.</p> 2170 * <p>A repeating request <code>Rsimple</code> can be <em>occasionally</em> interleaved 2171 * by a single capture of a new request <code>Rstall</code> (which has at least 2172 * one in-use stream with a non-0 stall time) and if <code>Rstall</code> has the 2173 * same minimum frame duration this will not cause a frame rate loss 2174 * if all buffers from the previous <code>Rstall</code> have already been 2175 * delivered.</p> 2176 * <p>For more details about stalling, see 2177 * {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputStallDuration }.</p> 2178 * <p>This control is only effective if {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link CaptureRequest#CONTROL_MODE android.control.mode} is set to 2179 * OFF; otherwise the auto-exposure algorithm will override this value.</p> 2180 * <p><b>Units</b>: Nanoseconds</p> 2181 * <p><b>Range of valid values:</b><br> 2182 * See {@link CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION android.sensor.info.maxFrameDuration}, 2183 * {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap}. The duration 2184 * is capped to <code>max(duration, exposureTime + overhead)</code>.</p> 2185 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2186 * <p><b>Full capability</b> - 2187 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 2188 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2189 * 2190 * @see CaptureRequest#CONTROL_AE_MODE 2191 * @see CaptureRequest#CONTROL_MODE 2192 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2193 * @see CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP 2194 * @see CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION 2195 */ 2196 @PublicKey 2197 public static final Key<Long> SENSOR_FRAME_DURATION = 2198 new Key<Long>("android.sensor.frameDuration", long.class); 2199 2200 /** 2201 * <p>The amount of gain applied to sensor data 2202 * before processing.</p> 2203 * <p>The sensitivity is the standard ISO sensitivity value, 2204 * as defined in ISO 12232:2006.</p> 2205 * <p>The sensitivity must be within {@link CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE android.sensor.info.sensitivityRange}, and 2206 * if if it less than {@link CameraCharacteristics#SENSOR_MAX_ANALOG_SENSITIVITY android.sensor.maxAnalogSensitivity}, the camera device 2207 * is guaranteed to use only analog amplification for applying the gain.</p> 2208 * <p>If the camera device cannot apply the exact sensitivity 2209 * requested, it will reduce the gain to the nearest supported 2210 * value. The final sensitivity used will be available in the 2211 * output capture result.</p> 2212 * <p><b>Units</b>: ISO arithmetic units</p> 2213 * <p><b>Range of valid values:</b><br> 2214 * {@link CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE android.sensor.info.sensitivityRange}</p> 2215 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2216 * <p><b>Full capability</b> - 2217 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 2218 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2219 * 2220 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2221 * @see CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE 2222 * @see CameraCharacteristics#SENSOR_MAX_ANALOG_SENSITIVITY 2223 */ 2224 @PublicKey 2225 public static final Key<Integer> SENSOR_SENSITIVITY = 2226 new Key<Integer>("android.sensor.sensitivity", int.class); 2227 2228 /** 2229 * <p>A pixel <code>[R, G_even, G_odd, B]</code> that supplies the test pattern 2230 * when {@link CaptureRequest#SENSOR_TEST_PATTERN_MODE android.sensor.testPatternMode} is SOLID_COLOR.</p> 2231 * <p>Each color channel is treated as an unsigned 32-bit integer. 2232 * The camera device then uses the most significant X bits 2233 * that correspond to how many bits are in its Bayer raw sensor 2234 * output.</p> 2235 * <p>For example, a sensor with RAW10 Bayer output would use the 2236 * 10 most significant bits from each color channel.</p> 2237 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2238 * 2239 * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE 2240 */ 2241 @PublicKey 2242 public static final Key<int[]> SENSOR_TEST_PATTERN_DATA = 2243 new Key<int[]>("android.sensor.testPatternData", int[].class); 2244 2245 /** 2246 * <p>When enabled, the sensor sends a test pattern instead of 2247 * doing a real exposure from the camera.</p> 2248 * <p>When a test pattern is enabled, all manual sensor controls specified 2249 * by android.sensor.* will be ignored. All other controls should 2250 * work as normal.</p> 2251 * <p>For example, if manual flash is enabled, flash firing should still 2252 * occur (and that the test pattern remain unmodified, since the flash 2253 * would not actually affect it).</p> 2254 * <p>Defaults to OFF.</p> 2255 * <p><b>Possible values:</b> 2256 * <ul> 2257 * <li>{@link #SENSOR_TEST_PATTERN_MODE_OFF OFF}</li> 2258 * <li>{@link #SENSOR_TEST_PATTERN_MODE_SOLID_COLOR SOLID_COLOR}</li> 2259 * <li>{@link #SENSOR_TEST_PATTERN_MODE_COLOR_BARS COLOR_BARS}</li> 2260 * <li>{@link #SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY COLOR_BARS_FADE_TO_GRAY}</li> 2261 * <li>{@link #SENSOR_TEST_PATTERN_MODE_PN9 PN9}</li> 2262 * <li>{@link #SENSOR_TEST_PATTERN_MODE_CUSTOM1 CUSTOM1}</li> 2263 * </ul></p> 2264 * <p><b>Available values for this device:</b><br> 2265 * {@link CameraCharacteristics#SENSOR_AVAILABLE_TEST_PATTERN_MODES android.sensor.availableTestPatternModes}</p> 2266 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2267 * 2268 * @see CameraCharacteristics#SENSOR_AVAILABLE_TEST_PATTERN_MODES 2269 * @see #SENSOR_TEST_PATTERN_MODE_OFF 2270 * @see #SENSOR_TEST_PATTERN_MODE_SOLID_COLOR 2271 * @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS 2272 * @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY 2273 * @see #SENSOR_TEST_PATTERN_MODE_PN9 2274 * @see #SENSOR_TEST_PATTERN_MODE_CUSTOM1 2275 */ 2276 @PublicKey 2277 public static final Key<Integer> SENSOR_TEST_PATTERN_MODE = 2278 new Key<Integer>("android.sensor.testPatternMode", int.class); 2279 2280 /** 2281 * <p>Quality of lens shading correction applied 2282 * to the image data.</p> 2283 * <p>When set to OFF mode, no lens shading correction will be applied by the 2284 * camera device, and an identity lens shading map data will be provided 2285 * if <code>{@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} == ON</code>. For example, for lens 2286 * shading map with size of <code>[ 4, 3 ]</code>, 2287 * the output {@link CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP android.statistics.lensShadingCorrectionMap} for this case will be an identity 2288 * map shown below:</p> 2289 * <pre><code>[ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2290 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2291 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2292 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2293 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2294 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] 2295 * </code></pre> 2296 * <p>When set to other modes, lens shading correction will be applied by the camera 2297 * device. Applications can request lens shading map data by setting 2298 * {@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} to ON, and then the camera device will provide lens 2299 * shading map data in {@link CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP android.statistics.lensShadingCorrectionMap}; the returned shading map 2300 * data will be the one applied by the camera device for this capture request.</p> 2301 * <p>The shading map data may depend on the auto-exposure (AE) and AWB statistics, therefore 2302 * the reliability of the map data may be affected by the AE and AWB algorithms. When AE and 2303 * AWB are in AUTO modes({@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} <code>!=</code> OFF and {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} <code>!=</code> 2304 * OFF), to get best results, it is recommended that the applications wait for the AE and AWB 2305 * to be converged before using the returned shading map data.</p> 2306 * <p><b>Possible values:</b> 2307 * <ul> 2308 * <li>{@link #SHADING_MODE_OFF OFF}</li> 2309 * <li>{@link #SHADING_MODE_FAST FAST}</li> 2310 * <li>{@link #SHADING_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 2311 * </ul></p> 2312 * <p><b>Available values for this device:</b><br> 2313 * {@link CameraCharacteristics#SHADING_AVAILABLE_MODES android.shading.availableModes}</p> 2314 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2315 * <p><b>Full capability</b> - 2316 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 2317 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2318 * 2319 * @see CaptureRequest#CONTROL_AE_MODE 2320 * @see CaptureRequest#CONTROL_AWB_MODE 2321 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2322 * @see CameraCharacteristics#SHADING_AVAILABLE_MODES 2323 * @see CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP 2324 * @see CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE 2325 * @see #SHADING_MODE_OFF 2326 * @see #SHADING_MODE_FAST 2327 * @see #SHADING_MODE_HIGH_QUALITY 2328 */ 2329 @PublicKey 2330 public static final Key<Integer> SHADING_MODE = 2331 new Key<Integer>("android.shading.mode", int.class); 2332 2333 /** 2334 * <p>Operating mode for the face detector 2335 * unit.</p> 2336 * <p>Whether face detection is enabled, and whether it 2337 * should output just the basic fields or the full set of 2338 * fields.</p> 2339 * <p><b>Possible values:</b> 2340 * <ul> 2341 * <li>{@link #STATISTICS_FACE_DETECT_MODE_OFF OFF}</li> 2342 * <li>{@link #STATISTICS_FACE_DETECT_MODE_SIMPLE SIMPLE}</li> 2343 * <li>{@link #STATISTICS_FACE_DETECT_MODE_FULL FULL}</li> 2344 * </ul></p> 2345 * <p><b>Available values for this device:</b><br> 2346 * {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES android.statistics.info.availableFaceDetectModes}</p> 2347 * <p>This key is available on all devices.</p> 2348 * 2349 * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES 2350 * @see #STATISTICS_FACE_DETECT_MODE_OFF 2351 * @see #STATISTICS_FACE_DETECT_MODE_SIMPLE 2352 * @see #STATISTICS_FACE_DETECT_MODE_FULL 2353 */ 2354 @PublicKey 2355 public static final Key<Integer> STATISTICS_FACE_DETECT_MODE = 2356 new Key<Integer>("android.statistics.faceDetectMode", int.class); 2357 2358 /** 2359 * <p>Operating mode for hot pixel map generation.</p> 2360 * <p>If set to <code>true</code>, a hot pixel map is returned in {@link CaptureResult#STATISTICS_HOT_PIXEL_MAP android.statistics.hotPixelMap}. 2361 * If set to <code>false</code>, no hot pixel map will be returned.</p> 2362 * <p><b>Range of valid values:</b><br> 2363 * {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES android.statistics.info.availableHotPixelMapModes}</p> 2364 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2365 * 2366 * @see CaptureResult#STATISTICS_HOT_PIXEL_MAP 2367 * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES 2368 */ 2369 @PublicKey 2370 public static final Key<Boolean> STATISTICS_HOT_PIXEL_MAP_MODE = 2371 new Key<Boolean>("android.statistics.hotPixelMapMode", boolean.class); 2372 2373 /** 2374 * <p>Whether the camera device will output the lens 2375 * shading map in output result metadata.</p> 2376 * <p>When set to ON, 2377 * android.statistics.lensShadingMap will be provided in 2378 * the output result metadata.</p> 2379 * <p>ON is always supported on devices with the RAW capability.</p> 2380 * <p><b>Possible values:</b> 2381 * <ul> 2382 * <li>{@link #STATISTICS_LENS_SHADING_MAP_MODE_OFF OFF}</li> 2383 * <li>{@link #STATISTICS_LENS_SHADING_MAP_MODE_ON ON}</li> 2384 * </ul></p> 2385 * <p><b>Available values for this device:</b><br> 2386 * {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_LENS_SHADING_MAP_MODES android.statistics.info.availableLensShadingMapModes}</p> 2387 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2388 * <p><b>Full capability</b> - 2389 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 2390 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2391 * 2392 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2393 * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_LENS_SHADING_MAP_MODES 2394 * @see #STATISTICS_LENS_SHADING_MAP_MODE_OFF 2395 * @see #STATISTICS_LENS_SHADING_MAP_MODE_ON 2396 */ 2397 @PublicKey 2398 public static final Key<Integer> STATISTICS_LENS_SHADING_MAP_MODE = 2399 new Key<Integer>("android.statistics.lensShadingMapMode", int.class); 2400 2401 /** 2402 * <p>Tonemapping / contrast / gamma curve for the blue 2403 * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 2404 * CONTRAST_CURVE.</p> 2405 * <p>See android.tonemap.curveRed for more details.</p> 2406 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2407 * <p><b>Full capability</b> - 2408 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 2409 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2410 * 2411 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2412 * @see CaptureRequest#TONEMAP_MODE 2413 * @hide 2414 */ 2415 public static final Key<float[]> TONEMAP_CURVE_BLUE = 2416 new Key<float[]>("android.tonemap.curveBlue", float[].class); 2417 2418 /** 2419 * <p>Tonemapping / contrast / gamma curve for the green 2420 * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 2421 * CONTRAST_CURVE.</p> 2422 * <p>See android.tonemap.curveRed for more details.</p> 2423 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2424 * <p><b>Full capability</b> - 2425 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 2426 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2427 * 2428 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2429 * @see CaptureRequest#TONEMAP_MODE 2430 * @hide 2431 */ 2432 public static final Key<float[]> TONEMAP_CURVE_GREEN = 2433 new Key<float[]>("android.tonemap.curveGreen", float[].class); 2434 2435 /** 2436 * <p>Tonemapping / contrast / gamma curve for the red 2437 * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 2438 * CONTRAST_CURVE.</p> 2439 * <p>Each channel's curve is defined by an array of control points:</p> 2440 * <pre><code>android.tonemap.curveRed = 2441 * [ P0in, P0out, P1in, P1out, P2in, P2out, P3in, P3out, ..., PNin, PNout ] 2442 * 2 <= N <= {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</code></pre> 2443 * <p>These are sorted in order of increasing <code>Pin</code>; it is 2444 * required that input values 0.0 and 1.0 are included in the list to 2445 * define a complete mapping. For input values between control points, 2446 * the camera device must linearly interpolate between the control 2447 * points.</p> 2448 * <p>Each curve can have an independent number of points, and the number 2449 * of points can be less than max (that is, the request doesn't have to 2450 * always provide a curve with number of points equivalent to 2451 * {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}).</p> 2452 * <p>A few examples, and their corresponding graphical mappings; these 2453 * only specify the red channel and the precision is limited to 4 2454 * digits, for conciseness.</p> 2455 * <p>Linear mapping:</p> 2456 * <pre><code>android.tonemap.curveRed = [ 0, 0, 1.0, 1.0 ] 2457 * </code></pre> 2458 * <p><img alt="Linear mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png" /></p> 2459 * <p>Invert mapping:</p> 2460 * <pre><code>android.tonemap.curveRed = [ 0, 1.0, 1.0, 0 ] 2461 * </code></pre> 2462 * <p><img alt="Inverting mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png" /></p> 2463 * <p>Gamma 1/2.2 mapping, with 16 control points:</p> 2464 * <pre><code>android.tonemap.curveRed = [ 2465 * 0.0000, 0.0000, 0.0667, 0.2920, 0.1333, 0.4002, 0.2000, 0.4812, 2466 * 0.2667, 0.5484, 0.3333, 0.6069, 0.4000, 0.6594, 0.4667, 0.7072, 2467 * 0.5333, 0.7515, 0.6000, 0.7928, 0.6667, 0.8317, 0.7333, 0.8685, 2468 * 0.8000, 0.9035, 0.8667, 0.9370, 0.9333, 0.9691, 1.0000, 1.0000 ] 2469 * </code></pre> 2470 * <p><img alt="Gamma = 1/2.2 tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png" /></p> 2471 * <p>Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:</p> 2472 * <pre><code>android.tonemap.curveRed = [ 2473 * 0.0000, 0.0000, 0.0667, 0.2864, 0.1333, 0.4007, 0.2000, 0.4845, 2474 * 0.2667, 0.5532, 0.3333, 0.6125, 0.4000, 0.6652, 0.4667, 0.7130, 2475 * 0.5333, 0.7569, 0.6000, 0.7977, 0.6667, 0.8360, 0.7333, 0.8721, 2476 * 0.8000, 0.9063, 0.8667, 0.9389, 0.9333, 0.9701, 1.0000, 1.0000 ] 2477 * </code></pre> 2478 * <p><img alt="sRGB tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p> 2479 * <p><b>Range of valid values:</b><br> 2480 * 0-1 on both input and output coordinates, normalized 2481 * as a floating-point value such that 0 == black and 1 == white.</p> 2482 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2483 * <p><b>Full capability</b> - 2484 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 2485 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2486 * 2487 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2488 * @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS 2489 * @see CaptureRequest#TONEMAP_MODE 2490 * @hide 2491 */ 2492 public static final Key<float[]> TONEMAP_CURVE_RED = 2493 new Key<float[]>("android.tonemap.curveRed", float[].class); 2494 2495 /** 2496 * <p>Tonemapping / contrast / gamma curve to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} 2497 * is CONTRAST_CURVE.</p> 2498 * <p>The tonemapCurve consist of three curves for each of red, green, and blue 2499 * channels respectively. The following example uses the red channel as an 2500 * example. The same logic applies to green and blue channel. 2501 * Each channel's curve is defined by an array of control points:</p> 2502 * <pre><code>curveRed = 2503 * [ P0(in, out), P1(in, out), P2(in, out), P3(in, out), ..., PN(in, out) ] 2504 * 2 <= N <= {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</code></pre> 2505 * <p>These are sorted in order of increasing <code>Pin</code>; it is always 2506 * guaranteed that input values 0.0 and 1.0 are included in the list to 2507 * define a complete mapping. For input values between control points, 2508 * the camera device must linearly interpolate between the control 2509 * points.</p> 2510 * <p>Each curve can have an independent number of points, and the number 2511 * of points can be less than max (that is, the request doesn't have to 2512 * always provide a curve with number of points equivalent to 2513 * {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}).</p> 2514 * <p>A few examples, and their corresponding graphical mappings; these 2515 * only specify the red channel and the precision is limited to 4 2516 * digits, for conciseness.</p> 2517 * <p>Linear mapping:</p> 2518 * <pre><code>curveRed = [ (0, 0), (1.0, 1.0) ] 2519 * </code></pre> 2520 * <p><img alt="Linear mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png" /></p> 2521 * <p>Invert mapping:</p> 2522 * <pre><code>curveRed = [ (0, 1.0), (1.0, 0) ] 2523 * </code></pre> 2524 * <p><img alt="Inverting mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png" /></p> 2525 * <p>Gamma 1/2.2 mapping, with 16 control points:</p> 2526 * <pre><code>curveRed = [ 2527 * (0.0000, 0.0000), (0.0667, 0.2920), (0.1333, 0.4002), (0.2000, 0.4812), 2528 * (0.2667, 0.5484), (0.3333, 0.6069), (0.4000, 0.6594), (0.4667, 0.7072), 2529 * (0.5333, 0.7515), (0.6000, 0.7928), (0.6667, 0.8317), (0.7333, 0.8685), 2530 * (0.8000, 0.9035), (0.8667, 0.9370), (0.9333, 0.9691), (1.0000, 1.0000) ] 2531 * </code></pre> 2532 * <p><img alt="Gamma = 1/2.2 tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png" /></p> 2533 * <p>Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:</p> 2534 * <pre><code>curveRed = [ 2535 * (0.0000, 0.0000), (0.0667, 0.2864), (0.1333, 0.4007), (0.2000, 0.4845), 2536 * (0.2667, 0.5532), (0.3333, 0.6125), (0.4000, 0.6652), (0.4667, 0.7130), 2537 * (0.5333, 0.7569), (0.6000, 0.7977), (0.6667, 0.8360), (0.7333, 0.8721), 2538 * (0.8000, 0.9063), (0.8667, 0.9389), (0.9333, 0.9701), (1.0000, 1.0000) ] 2539 * </code></pre> 2540 * <p><img alt="sRGB tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p> 2541 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2542 * <p><b>Full capability</b> - 2543 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 2544 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2545 * 2546 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2547 * @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS 2548 * @see CaptureRequest#TONEMAP_MODE 2549 */ 2550 @PublicKey 2551 @SyntheticKey 2552 public static final Key<android.hardware.camera2.params.TonemapCurve> TONEMAP_CURVE = 2553 new Key<android.hardware.camera2.params.TonemapCurve>("android.tonemap.curve", android.hardware.camera2.params.TonemapCurve.class); 2554 2555 /** 2556 * <p>High-level global contrast/gamma/tonemapping control.</p> 2557 * <p>When switching to an application-defined contrast curve by setting 2558 * {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} to CONTRAST_CURVE, the curve is defined 2559 * per-channel with a set of <code>(in, out)</code> points that specify the 2560 * mapping from input high-bit-depth pixel value to the output 2561 * low-bit-depth value. Since the actual pixel ranges of both input 2562 * and output may change depending on the camera pipeline, the values 2563 * are specified by normalized floating-point numbers.</p> 2564 * <p>More-complex color mapping operations such as 3D color look-up 2565 * tables, selective chroma enhancement, or other non-linear color 2566 * transforms will be disabled when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 2567 * CONTRAST_CURVE.</p> 2568 * <p>When using either FAST or HIGH_QUALITY, the camera device will 2569 * emit its own tonemap curve in {@link CaptureRequest#TONEMAP_CURVE android.tonemap.curve}. 2570 * These values are always available, and as close as possible to the 2571 * actually used nonlinear/nonglobal transforms.</p> 2572 * <p>If a request is sent with CONTRAST_CURVE with the camera device's 2573 * provided curve in FAST or HIGH_QUALITY, the image's tonemap will be 2574 * roughly the same.</p> 2575 * <p><b>Possible values:</b> 2576 * <ul> 2577 * <li>{@link #TONEMAP_MODE_CONTRAST_CURVE CONTRAST_CURVE}</li> 2578 * <li>{@link #TONEMAP_MODE_FAST FAST}</li> 2579 * <li>{@link #TONEMAP_MODE_HIGH_QUALITY HIGH_QUALITY}</li> 2580 * <li>{@link #TONEMAP_MODE_GAMMA_VALUE GAMMA_VALUE}</li> 2581 * <li>{@link #TONEMAP_MODE_PRESET_CURVE PRESET_CURVE}</li> 2582 * </ul></p> 2583 * <p><b>Available values for this device:</b><br> 2584 * {@link CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES android.tonemap.availableToneMapModes}</p> 2585 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2586 * <p><b>Full capability</b> - 2587 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 2588 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2589 * 2590 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2591 * @see CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES 2592 * @see CaptureRequest#TONEMAP_CURVE 2593 * @see CaptureRequest#TONEMAP_MODE 2594 * @see #TONEMAP_MODE_CONTRAST_CURVE 2595 * @see #TONEMAP_MODE_FAST 2596 * @see #TONEMAP_MODE_HIGH_QUALITY 2597 * @see #TONEMAP_MODE_GAMMA_VALUE 2598 * @see #TONEMAP_MODE_PRESET_CURVE 2599 */ 2600 @PublicKey 2601 public static final Key<Integer> TONEMAP_MODE = 2602 new Key<Integer>("android.tonemap.mode", int.class); 2603 2604 /** 2605 * <p>Tonemapping curve to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 2606 * GAMMA_VALUE</p> 2607 * <p>The tonemap curve will be defined the following formula: 2608 * * OUT = pow(IN, 1.0 / gamma) 2609 * where IN and OUT is the input pixel value scaled to range [0.0, 1.0], 2610 * pow is the power function and gamma is the gamma value specified by this 2611 * key.</p> 2612 * <p>The same curve will be applied to all color channels. The camera device 2613 * may clip the input gamma value to its supported range. The actual applied 2614 * value will be returned in capture result.</p> 2615 * <p>The valid range of gamma value varies on different devices, but values 2616 * within [1.0, 5.0] are guaranteed not to be clipped.</p> 2617 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2618 * 2619 * @see CaptureRequest#TONEMAP_MODE 2620 */ 2621 @PublicKey 2622 public static final Key<Float> TONEMAP_GAMMA = 2623 new Key<Float>("android.tonemap.gamma", float.class); 2624 2625 /** 2626 * <p>Tonemapping curve to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is 2627 * PRESET_CURVE</p> 2628 * <p>The tonemap curve will be defined by specified standard.</p> 2629 * <p>sRGB (approximated by 16 control points):</p> 2630 * <p><img alt="sRGB tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p> 2631 * <p>Rec. 709 (approximated by 16 control points):</p> 2632 * <p><img alt="Rec. 709 tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/rec709_tonemap.png" /></p> 2633 * <p>Note that above figures show a 16 control points approximation of preset 2634 * curves. Camera devices may apply a different approximation to the curve.</p> 2635 * <p><b>Possible values:</b> 2636 * <ul> 2637 * <li>{@link #TONEMAP_PRESET_CURVE_SRGB SRGB}</li> 2638 * <li>{@link #TONEMAP_PRESET_CURVE_REC709 REC709}</li> 2639 * </ul></p> 2640 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2641 * 2642 * @see CaptureRequest#TONEMAP_MODE 2643 * @see #TONEMAP_PRESET_CURVE_SRGB 2644 * @see #TONEMAP_PRESET_CURVE_REC709 2645 */ 2646 @PublicKey 2647 public static final Key<Integer> TONEMAP_PRESET_CURVE = 2648 new Key<Integer>("android.tonemap.presetCurve", int.class); 2649 2650 /** 2651 * <p>This LED is nominally used to indicate to the user 2652 * that the camera is powered on and may be streaming images back to the 2653 * Application Processor. In certain rare circumstances, the OS may 2654 * disable this when video is processed locally and not transmitted to 2655 * any untrusted applications.</p> 2656 * <p>In particular, the LED <em>must</em> always be on when the data could be 2657 * transmitted off the device. The LED <em>should</em> always be on whenever 2658 * data is stored locally on the device.</p> 2659 * <p>The LED <em>may</em> be off if a trusted application is using the data that 2660 * doesn't violate the above rules.</p> 2661 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2662 * @hide 2663 */ 2664 public static final Key<Boolean> LED_TRANSMIT = 2665 new Key<Boolean>("android.led.transmit", boolean.class); 2666 2667 /** 2668 * <p>Whether black-level compensation is locked 2669 * to its current values, or is free to vary.</p> 2670 * <p>When set to <code>true</code> (ON), the values used for black-level 2671 * compensation will not change until the lock is set to 2672 * <code>false</code> (OFF).</p> 2673 * <p>Since changes to certain capture parameters (such as 2674 * exposure time) may require resetting of black level 2675 * compensation, the camera device must report whether setting 2676 * the black level lock was successful in the output result 2677 * metadata.</p> 2678 * <p>For example, if a sequence of requests is as follows:</p> 2679 * <ul> 2680 * <li>Request 1: Exposure = 10ms, Black level lock = OFF</li> 2681 * <li>Request 2: Exposure = 10ms, Black level lock = ON</li> 2682 * <li>Request 3: Exposure = 10ms, Black level lock = ON</li> 2683 * <li>Request 4: Exposure = 20ms, Black level lock = ON</li> 2684 * <li>Request 5: Exposure = 20ms, Black level lock = ON</li> 2685 * <li>Request 6: Exposure = 20ms, Black level lock = ON</li> 2686 * </ul> 2687 * <p>And the exposure change in Request 4 requires the camera 2688 * device to reset the black level offsets, then the output 2689 * result metadata is expected to be:</p> 2690 * <ul> 2691 * <li>Result 1: Exposure = 10ms, Black level lock = OFF</li> 2692 * <li>Result 2: Exposure = 10ms, Black level lock = ON</li> 2693 * <li>Result 3: Exposure = 10ms, Black level lock = ON</li> 2694 * <li>Result 4: Exposure = 20ms, Black level lock = OFF</li> 2695 * <li>Result 5: Exposure = 20ms, Black level lock = ON</li> 2696 * <li>Result 6: Exposure = 20ms, Black level lock = ON</li> 2697 * </ul> 2698 * <p>This indicates to the application that on frame 4, black 2699 * levels were reset due to exposure value changes, and pixel 2700 * values may not be consistent across captures.</p> 2701 * <p>The camera device will maintain the lock to the extent 2702 * possible, only overriding the lock to OFF when changes to 2703 * other request parameters require a black level recalculation 2704 * or reset.</p> 2705 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2706 * <p><b>Full capability</b> - 2707 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 2708 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2709 * 2710 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2711 */ 2712 @PublicKey 2713 public static final Key<Boolean> BLACK_LEVEL_LOCK = 2714 new Key<Boolean>("android.blackLevel.lock", boolean.class); 2715 2716 /** 2717 * <p>The amount of exposure time increase factor applied to the original output 2718 * frame by the application processing before sending for reprocessing.</p> 2719 * <p>This is optional, and will be supported if the camera device supports YUV_REPROCESSING 2720 * capability ({@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} contains YUV_REPROCESSING).</p> 2721 * <p>For some YUV reprocessing use cases, the application may choose to filter the original 2722 * output frames to effectively reduce the noise to the same level as a frame that was 2723 * captured with longer exposure time. To be more specific, assuming the original captured 2724 * images were captured with a sensitivity of S and an exposure time of T, the model in 2725 * the camera device is that the amount of noise in the image would be approximately what 2726 * would be expected if the original capture parameters had been a sensitivity of 2727 * S/effectiveExposureFactor and an exposure time of T*effectiveExposureFactor, rather 2728 * than S and T respectively. If the captured images were processed by the application 2729 * before being sent for reprocessing, then the application may have used image processing 2730 * algorithms and/or multi-frame image fusion to reduce the noise in the 2731 * application-processed images (input images). By using the effectiveExposureFactor 2732 * control, the application can communicate to the camera device the actual noise level 2733 * improvement in the application-processed image. With this information, the camera 2734 * device can select appropriate noise reduction and edge enhancement parameters to avoid 2735 * excessive noise reduction ({@link CaptureRequest#NOISE_REDUCTION_MODE android.noiseReduction.mode}) and insufficient edge 2736 * enhancement ({@link CaptureRequest#EDGE_MODE android.edge.mode}) being applied to the reprocessed frames.</p> 2737 * <p>For example, for multi-frame image fusion use case, the application may fuse 2738 * multiple output frames together to a final frame for reprocessing. When N image are 2739 * fused into 1 image for reprocessing, the exposure time increase factor could be up to 2740 * square root of N (based on a simple photon shot noise model). The camera device will 2741 * adjust the reprocessing noise reduction and edge enhancement parameters accordingly to 2742 * produce the best quality images.</p> 2743 * <p>This is relative factor, 1.0 indicates the application hasn't processed the input 2744 * buffer in a way that affects its effective exposure time.</p> 2745 * <p>This control is only effective for YUV reprocessing capture request. For noise 2746 * reduction reprocessing, it is only effective when <code>{@link CaptureRequest#NOISE_REDUCTION_MODE android.noiseReduction.mode} != OFF</code>. 2747 * Similarly, for edge enhancement reprocessing, it is only effective when 2748 * <code>{@link CaptureRequest#EDGE_MODE android.edge.mode} != OFF</code>.</p> 2749 * <p><b>Units</b>: Relative exposure time increase factor.</p> 2750 * <p><b>Range of valid values:</b><br> 2751 * >= 1.0</p> 2752 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p> 2753 * <p><b>Limited capability</b> - 2754 * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the 2755 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 2756 * 2757 * @see CaptureRequest#EDGE_MODE 2758 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 2759 * @see CaptureRequest#NOISE_REDUCTION_MODE 2760 * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES 2761 */ 2762 @PublicKey 2763 public static final Key<Float> REPROCESS_EFFECTIVE_EXPOSURE_FACTOR = 2764 new Key<Float>("android.reprocess.effectiveExposureFactor", float.class); 2765 2766 /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ 2767 * End generated code 2768 *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/ 2769 2770 2771 2772} 2773