2 * Copyright (C) 2013 The Android Open Source Project
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 package android.hardware.camera2;
19 import android.hardware.camera2.impl.CameraMetadataNative;
20 import android.hardware.camera2.impl.PublicKey;
21 import android.hardware.camera2.impl.SyntheticKey;
22 import android.hardware.camera2.utils.HashCodeHelpers;
23 import android.hardware.camera2.utils.TypeReference;
24 import android.os.Parcel;
25 import android.os.Parcelable;
26 import android.view.Surface;
28 import java.util.Collection;
29 import java.util.Collections;
30 import java.util.HashSet;
31 import java.util.List;
32 import java.util.Objects;
36 * <p>An immutable package of settings and outputs needed to capture a single
37 * image from the camera device.</p>
39 * <p>Contains the configuration for the capture hardware (sensor, lens, flash),
40 * the processing pipeline, the control algorithms, and the output buffers. Also
41 * contains the list of target Surfaces to send image data to for this
44 * <p>CaptureRequests can be created by using a {@link Builder} instance,
45 * obtained by calling {@link CameraDevice#createCaptureRequest}</p>
47 * <p>CaptureRequests are given to {@link CameraCaptureSession#capture} or
48 * {@link CameraCaptureSession#setRepeatingRequest} to capture images from a camera.</p>
50 * <p>Each request can specify a different subset of target Surfaces for the
51 * camera to send the captured data to. All the surfaces used in a request must
52 * be part of the surface list given to the last call to
53 * {@link CameraDevice#createCaptureSession}, when the request is submitted to the
56 * <p>For example, a request meant for repeating preview might only include the
57 * Surface for the preview SurfaceView or SurfaceTexture, while a
58 * high-resolution still capture would also include a Surface from a ImageReader
59 * configured for high-resolution JPEG images.</p>
61 * @see CameraDevice#capture
62 * @see CameraDevice#setRepeatingRequest
63 * @see CameraDevice#createCaptureRequest
65 public final class CaptureRequest extends CameraMetadata<CaptureRequest.Key<?>>
66 implements Parcelable {
69 * A {@code Key} is used to do capture request field lookups with
70 * {@link CaptureResult#get} or to set fields with
71 * {@link CaptureRequest.Builder#set(Key, Object)}.
73 * <p>For example, to set the crop rectangle for the next capture:
75 * Rect cropRectangle = new Rect(0, 0, 640, 480);
76 * captureRequestBuilder.set(SCALER_CROP_REGION, cropRectangle);
80 * <p>To enumerate over all possible keys for {@link CaptureResult}, see
81 * {@link CameraCharacteristics#getAvailableCaptureResultKeys}.</p>
83 * @see CaptureResult#get
84 * @see CameraCharacteristics#getAvailableCaptureResultKeys
86 public final static class Key<T> {
87 private final CameraMetadataNative.Key<T> mKey;
90 * Visible for testing and vendor extensions only.
94 public Key(String name, Class<T> type) {
95 mKey = new CameraMetadataNative.Key<T>(name, type);
99 * Visible for testing and vendor extensions only.
103 public Key(String name, TypeReference<T> typeReference) {
104 mKey = new CameraMetadataNative.Key<T>(name, typeReference);
108 * Return a camelCase, period separated name formatted like:
109 * {@code "root.section[.subsections].name"}.
111 * <p>Built-in keys exposed by the Android SDK are always prefixed with {@code "android."};
112 * keys that are device/platform-specific are prefixed with {@code "com."}.</p>
114 * <p>For example, {@code CameraCharacteristics.SCALER_STREAM_CONFIGURATION_MAP} would
115 * have a name of {@code "android.scaler.streamConfigurationMap"}; whereas a device
116 * specific key might look like {@code "com.google.nexus.data.private"}.</p>
118 * @return String representation of the key name
120 public String getName() {
121 return mKey.getName();
128 public final int hashCode() {
129 return mKey.hashCode();
135 @SuppressWarnings("unchecked")
137 public final boolean equals(Object o) {
138 return o instanceof Key && ((Key<T>)o).mKey.equals(mKey);
142 * Visible for CameraMetadataNative implementation only; do not use.
144 * TODO: Make this private or remove it altogether.
148 public CameraMetadataNative.Key<T> getNativeKey() {
152 @SuppressWarnings({ "unchecked" })
153 /*package*/ Key(CameraMetadataNative.Key<?> nativeKey) {
154 mKey = (CameraMetadataNative.Key<T>) nativeKey;
158 private final HashSet<Surface> mSurfaceSet;
159 private final CameraMetadataNative mSettings;
161 private Object mUserTag;
164 * Construct empty request.
166 * Used by Binder to unparcel this object only.
168 private CaptureRequest() {
169 mSettings = new CameraMetadataNative();
170 mSurfaceSet = new HashSet<Surface>();
174 * Clone from source capture request.
176 * Used by the Builder to create an immutable copy.
178 @SuppressWarnings("unchecked")
179 private CaptureRequest(CaptureRequest source) {
180 mSettings = new CameraMetadataNative(source.mSettings);
181 mSurfaceSet = (HashSet<Surface>) source.mSurfaceSet.clone();
182 mUserTag = source.mUserTag;
186 * Take ownership of passed-in settings.
188 * Used by the Builder to create a mutable CaptureRequest.
190 private CaptureRequest(CameraMetadataNative settings) {
191 mSettings = CameraMetadataNative.move(settings);
192 mSurfaceSet = new HashSet<Surface>();
196 * Get a capture request field value.
198 * <p>The field definitions can be found in {@link CaptureRequest}.</p>
200 * <p>Querying the value for the same key more than once will return a value
201 * which is equal to the previous queried value.</p>
203 * @throws IllegalArgumentException if the key was not valid
205 * @param key The result field to read.
206 * @return The value of that key, or {@code null} if the field is not set.
208 public <T> T get(Key<T> key) {
209 return mSettings.get(key);
216 @SuppressWarnings("unchecked")
218 protected <T> T getProtected(Key<?> key) {
219 return (T) mSettings.get(key);
226 @SuppressWarnings("unchecked")
228 protected Class<Key<?>> getKeyClass() {
229 Object thisClass = Key.class;
230 return (Class<Key<?>>)thisClass;
237 public List<Key<?>> getKeys() {
238 // Force the javadoc for this function to show up on the CaptureRequest page
239 return super.getKeys();
243 * Retrieve the tag for this request, if any.
245 * <p>This tag is not used for anything by the camera device, but can be
246 * used by an application to easily identify a CaptureRequest when it is
248 * {@link CameraCaptureSession.CaptureCallback#onCaptureCompleted CaptureCallback.onCaptureCompleted}
251 * @return the last tag Object set on this request, or {@code null} if
252 * no tag has been set.
253 * @see Builder#setTag
255 public Object getTag() {
260 * Determine whether this CaptureRequest is equal to another CaptureRequest.
262 * <p>A request is considered equal to another is if it's set of key/values is equal, it's
263 * list of output surfaces is equal, and the user tag is equal.</p>
265 * @param other Another instance of CaptureRequest.
267 * @return True if the requests are the same, false otherwise.
270 public boolean equals(Object other) {
271 return other instanceof CaptureRequest
272 && equals((CaptureRequest)other);
275 private boolean equals(CaptureRequest other) {
277 && Objects.equals(mUserTag, other.mUserTag)
278 && mSurfaceSet.equals(other.mSurfaceSet)
279 && mSettings.equals(other.mSettings);
283 public int hashCode() {
284 return HashCodeHelpers.hashCode(mSettings, mSurfaceSet, mUserTag);
287 public static final Parcelable.Creator<CaptureRequest> CREATOR =
288 new Parcelable.Creator<CaptureRequest>() {
290 public CaptureRequest createFromParcel(Parcel in) {
291 CaptureRequest request = new CaptureRequest();
292 request.readFromParcel(in);
298 public CaptureRequest[] newArray(int size) {
299 return new CaptureRequest[size];
304 * Expand this object from a Parcel.
305 * Hidden since this breaks the immutability of CaptureRequest, but is
306 * needed to receive CaptureRequests with aidl.
308 * @param in The parcel from which the object should be read
311 private void readFromParcel(Parcel in) {
312 mSettings.readFromParcel(in);
316 Parcelable[] parcelableArray = in.readParcelableArray(Surface.class.getClassLoader());
318 if (parcelableArray == null) {
322 for (Parcelable p : parcelableArray) {
323 Surface s = (Surface) p;
329 public int describeContents() {
334 public void writeToParcel(Parcel dest, int flags) {
335 mSettings.writeToParcel(dest, flags);
336 dest.writeParcelableArray(mSurfaceSet.toArray(new Surface[mSurfaceSet.size()]), flags);
342 public boolean containsTarget(Surface surface) {
343 return mSurfaceSet.contains(surface);
349 public Collection<Surface> getTargets() {
350 return Collections.unmodifiableCollection(mSurfaceSet);
354 * A builder for capture requests.
356 * <p>To obtain a builder instance, use the
357 * {@link CameraDevice#createCaptureRequest} method, which initializes the
358 * request fields to one of the templates defined in {@link CameraDevice}.
360 * @see CameraDevice#createCaptureRequest
361 * @see CameraDevice#TEMPLATE_PREVIEW
362 * @see CameraDevice#TEMPLATE_RECORD
363 * @see CameraDevice#TEMPLATE_STILL_CAPTURE
364 * @see CameraDevice#TEMPLATE_VIDEO_SNAPSHOT
365 * @see CameraDevice#TEMPLATE_MANUAL
367 public final static class Builder {
369 private final CaptureRequest mRequest;
372 * Initialize the builder using the template; the request takes
373 * ownership of the template.
377 public Builder(CameraMetadataNative template) {
378 mRequest = new CaptureRequest(template);
382 * <p>Add a surface to the list of targets for this request</p>
384 * <p>The Surface added must be one of the surfaces included in the most
385 * recent call to {@link CameraDevice#createCaptureSession}, when the
386 * request is given to the camera device.</p>
388 * <p>Adding a target more than once has no effect.</p>
390 * @param outputTarget Surface to use as an output target for this request
392 public void addTarget(Surface outputTarget) {
393 mRequest.mSurfaceSet.add(outputTarget);
397 * <p>Remove a surface from the list of targets for this request.</p>
399 * <p>Removing a target that is not currently added has no effect.</p>
401 * @param outputTarget Surface to use as an output target for this request
403 public void removeTarget(Surface outputTarget) {
404 mRequest.mSurfaceSet.remove(outputTarget);
408 * Set a capture request field to a value. The field definitions can be
409 * found in {@link CaptureRequest}.
411 * @param key The metadata field to write.
412 * @param value The value to set the field to, which must be of a matching
415 public <T> void set(Key<T> key, T value) {
416 mRequest.mSettings.set(key, value);
420 * Get a capture request field value. The field definitions can be
421 * found in {@link CaptureRequest}.
423 * @throws IllegalArgumentException if the key was not valid
425 * @param key The metadata field to read.
426 * @return The value of that key, or {@code null} if the field is not set.
428 public <T> T get(Key<T> key) {
429 return mRequest.mSettings.get(key);
433 * Set a tag for this request.
435 * <p>This tag is not used for anything by the camera device, but can be
436 * used by an application to easily identify a CaptureRequest when it is
438 * {@link CameraCaptureSession.CaptureCallback#onCaptureCompleted CaptureCallback.onCaptureCompleted}
440 * @param tag an arbitrary Object to store with this request
441 * @see CaptureRequest#getTag
443 public void setTag(Object tag) {
444 mRequest.mUserTag = tag;
448 * Build a request using the current target Surfaces and settings.
449 * <p>Note that, although it is possible to create a {@code CaptureRequest} with no target
450 * {@link Surface}s, passing such a request into {@link CameraCaptureSession#capture},
451 * {@link CameraCaptureSession#captureBurst},
452 * {@link CameraCaptureSession#setRepeatingBurst}, or
453 * {@link CameraCaptureSession#setRepeatingRequest} will cause that method to throw an
454 * {@link IllegalArgumentException}.</p>
456 * @return A new capture request instance, ready for submission to the
459 public CaptureRequest build() {
460 return new CaptureRequest(mRequest);
467 public boolean isEmpty() {
468 return mRequest.mSettings.isEmpty();
473 /*@O~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~
474 * The key entries below this point are generated from metadata
475 * definitions in /system/media/camera/docs. Do not modify by hand or
476 * modify the comment blocks at the start or end.
477 *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/
480 * <p>The mode control selects how the image data is converted from the
481 * sensor's native color into linear sRGB color.</p>
482 * <p>When auto-white balance (AWB) is enabled with {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, this
483 * control is overridden by the AWB routine. When AWB is disabled, the
484 * application controls how the color mapping is performed.</p>
485 * <p>We define the expected processing pipeline below. For consistency
486 * across devices, this is always the case with TRANSFORM_MATRIX.</p>
487 * <p>When either FULL or HIGH_QUALITY is used, the camera device may
488 * do additional processing but {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and
489 * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} will still be provided by the
490 * camera device (in the results) and be roughly correct.</p>
491 * <p>Switching to TRANSFORM_MATRIX and using the data provided from
492 * FAST or HIGH_QUALITY will yield a picture with the same white point
493 * as what was produced by the camera device in the earlier frame.</p>
494 * <p>The expected processing pipeline is as follows:</p>
495 * <p><img alt="White balance processing pipeline" src="../../../../images/camera2/metadata/android.colorCorrection.mode/processing_pipeline.png" /></p>
496 * <p>The white balance is encoded by two values, a 4-channel white-balance
497 * gain vector (applied in the Bayer domain), and a 3x3 color transform
498 * matrix (applied after demosaic).</p>
499 * <p>The 4-channel white-balance gains are defined as:</p>
500 * <pre><code>{@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} = [ R G_even G_odd B ]
502 * <p>where <code>G_even</code> is the gain for green pixels on even rows of the
503 * output, and <code>G_odd</code> is the gain for green pixels on the odd rows.
504 * These may be identical for a given camera device implementation; if
505 * the camera device does not support a separate gain for even/odd green
506 * channels, it will use the <code>G_even</code> value, and write <code>G_odd</code> equal to
507 * <code>G_even</code> in the output result metadata.</p>
508 * <p>The matrices for color transforms are defined as a 9-entry vector:</p>
509 * <pre><code>{@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} = [ I0 I1 I2 I3 I4 I5 I6 I7 I8 ]
511 * <p>which define a transform from input sensor colors, <code>P_in = [ r g b ]</code>,
512 * to output linear sRGB, <code>P_out = [ r' g' b' ]</code>,</p>
513 * <p>with colors as follows:</p>
514 * <pre><code>r' = I0r + I1g + I2b
515 * g' = I3r + I4g + I5b
516 * b' = I6r + I7g + I8b
518 * <p>Both the input and output value ranges must match. Overflow/underflow
519 * values are clipped to fit within the range.</p>
520 * <p><b>Possible values:</b>
522 * <li>{@link #COLOR_CORRECTION_MODE_TRANSFORM_MATRIX TRANSFORM_MATRIX}</li>
523 * <li>{@link #COLOR_CORRECTION_MODE_FAST FAST}</li>
524 * <li>{@link #COLOR_CORRECTION_MODE_HIGH_QUALITY HIGH_QUALITY}</li>
526 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
527 * <p><b>Full capability</b> -
528 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
529 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
531 * @see CaptureRequest#COLOR_CORRECTION_GAINS
532 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
533 * @see CaptureRequest#CONTROL_AWB_MODE
534 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
535 * @see #COLOR_CORRECTION_MODE_TRANSFORM_MATRIX
536 * @see #COLOR_CORRECTION_MODE_FAST
537 * @see #COLOR_CORRECTION_MODE_HIGH_QUALITY
540 public static final Key<Integer> COLOR_CORRECTION_MODE =
541 new Key<Integer>("android.colorCorrection.mode", int.class);
544 * <p>A color transform matrix to use to transform
545 * from sensor RGB color space to output linear sRGB color space.</p>
546 * <p>This matrix is either set by the camera device when the request
547 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not TRANSFORM_MATRIX, or
548 * directly by the application in the request when the
549 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is TRANSFORM_MATRIX.</p>
550 * <p>In the latter case, the camera device may round the matrix to account
551 * for precision issues; the final rounded matrix should be reported back
552 * in this matrix result metadata. The transform should keep the magnitude
553 * of the output color values within <code>[0, 1.0]</code> (assuming input color
554 * values is within the normalized range <code>[0, 1.0]</code>), or clipping may occur.</p>
555 * <p><b>Units</b>: Unitless scale factors</p>
556 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
557 * <p><b>Full capability</b> -
558 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
559 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
561 * @see CaptureRequest#COLOR_CORRECTION_MODE
562 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
565 public static final Key<android.hardware.camera2.params.ColorSpaceTransform> COLOR_CORRECTION_TRANSFORM =
566 new Key<android.hardware.camera2.params.ColorSpaceTransform>("android.colorCorrection.transform", android.hardware.camera2.params.ColorSpaceTransform.class);
569 * <p>Gains applying to Bayer raw color channels for
571 * <p>These per-channel gains are either set by the camera device
572 * when the request {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not
573 * TRANSFORM_MATRIX, or directly by the application in the
574 * request when the {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is
575 * TRANSFORM_MATRIX.</p>
576 * <p>The gains in the result metadata are the gains actually
577 * applied by the camera device to the current frame.</p>
578 * <p><b>Units</b>: Unitless gain factors</p>
579 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
580 * <p><b>Full capability</b> -
581 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
582 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
584 * @see CaptureRequest#COLOR_CORRECTION_MODE
585 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
588 public static final Key<android.hardware.camera2.params.RggbChannelVector> COLOR_CORRECTION_GAINS =
589 new Key<android.hardware.camera2.params.RggbChannelVector>("android.colorCorrection.gains", android.hardware.camera2.params.RggbChannelVector.class);
592 * <p>Mode of operation for the chromatic aberration correction algorithm.</p>
593 * <p>Chromatic (color) aberration is caused by the fact that different wavelengths of light
594 * can not focus on the same point after exiting from the lens. This metadata defines
595 * the high level control of chromatic aberration correction algorithm, which aims to
596 * minimize the chromatic artifacts that may occur along the object boundaries in an
598 * <p>FAST/HIGH_QUALITY both mean that camera device determined aberration
599 * correction will be applied. HIGH_QUALITY mode indicates that the camera device will
600 * use the highest-quality aberration correction algorithms, even if it slows down
601 * capture rate. FAST means the camera device will not slow down capture rate when
602 * applying aberration correction.</p>
603 * <p>LEGACY devices will always be in FAST mode.</p>
604 * <p><b>Possible values:</b>
606 * <li>{@link #COLOR_CORRECTION_ABERRATION_MODE_OFF OFF}</li>
607 * <li>{@link #COLOR_CORRECTION_ABERRATION_MODE_FAST FAST}</li>
608 * <li>{@link #COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY HIGH_QUALITY}</li>
610 * <p><b>Available values for this device:</b><br>
611 * {@link CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES android.colorCorrection.availableAberrationModes}</p>
612 * <p>This key is available on all devices.</p>
614 * @see CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES
615 * @see #COLOR_CORRECTION_ABERRATION_MODE_OFF
616 * @see #COLOR_CORRECTION_ABERRATION_MODE_FAST
617 * @see #COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY
620 public static final Key<Integer> COLOR_CORRECTION_ABERRATION_MODE =
621 new Key<Integer>("android.colorCorrection.aberrationMode", int.class);
624 * <p>The desired setting for the camera device's auto-exposure
625 * algorithm's antibanding compensation.</p>
626 * <p>Some kinds of lighting fixtures, such as some fluorescent
627 * lights, flicker at the rate of the power supply frequency
628 * (60Hz or 50Hz, depending on country). While this is
629 * typically not noticeable to a person, it can be visible to
630 * a camera device. If a camera sets its exposure time to the
631 * wrong value, the flicker may become visible in the
632 * viewfinder as flicker or in a final captured image, as a
633 * set of variable-brightness bands across the image.</p>
634 * <p>Therefore, the auto-exposure routines of camera devices
635 * include antibanding routines that ensure that the chosen
636 * exposure value will not cause such banding. The choice of
637 * exposure time depends on the rate of flicker, which the
638 * camera device can detect automatically, or the expected
639 * rate can be selected by the application using this
641 * <p>A given camera device may not support all of the possible
642 * options for the antibanding mode. The
643 * {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES android.control.aeAvailableAntibandingModes} key contains
644 * the available modes for a given camera device.</p>
645 * <p>AUTO mode is the default if it is available on given
646 * camera device. When AUTO mode is not available, the
647 * default will be either 50HZ or 60HZ, and both 50HZ
648 * and 60HZ will be available.</p>
649 * <p>If manual exposure control is enabled (by setting
650 * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link CaptureRequest#CONTROL_MODE android.control.mode} to OFF),
651 * then this setting has no effect, and the application must
652 * ensure it selects exposure times that do not cause banding
653 * issues. The {@link CaptureResult#STATISTICS_SCENE_FLICKER android.statistics.sceneFlicker} key can assist
654 * the application in this.</p>
655 * <p><b>Possible values:</b>
657 * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_OFF OFF}</li>
658 * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_50HZ 50HZ}</li>
659 * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_60HZ 60HZ}</li>
660 * <li>{@link #CONTROL_AE_ANTIBANDING_MODE_AUTO AUTO}</li>
662 * <p><b>Available values for this device:</b><br></p>
663 * <p>{@link CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES android.control.aeAvailableAntibandingModes}</p>
664 * <p>This key is available on all devices.</p>
666 * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES
667 * @see CaptureRequest#CONTROL_AE_MODE
668 * @see CaptureRequest#CONTROL_MODE
669 * @see CaptureResult#STATISTICS_SCENE_FLICKER
670 * @see #CONTROL_AE_ANTIBANDING_MODE_OFF
671 * @see #CONTROL_AE_ANTIBANDING_MODE_50HZ
672 * @see #CONTROL_AE_ANTIBANDING_MODE_60HZ
673 * @see #CONTROL_AE_ANTIBANDING_MODE_AUTO
676 public static final Key<Integer> CONTROL_AE_ANTIBANDING_MODE =
677 new Key<Integer>("android.control.aeAntibandingMode", int.class);
680 * <p>Adjustment to auto-exposure (AE) target image
682 * <p>The adjustment is measured as a count of steps, with the
683 * step size defined by {@link CameraCharacteristics#CONTROL_AE_COMPENSATION_STEP android.control.aeCompensationStep} and the
684 * allowed range by {@link CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE android.control.aeCompensationRange}.</p>
685 * <p>For example, if the exposure value (EV) step is 0.333, '6'
686 * will mean an exposure compensation of +2 EV; -3 will mean an
687 * exposure compensation of -1 EV. One EV represents a doubling
688 * of image brightness. Note that this control will only be
689 * effective if {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} <code>!=</code> OFF. This control
690 * will take effect even when {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} <code>== true</code>.</p>
691 * <p>In the event of exposure compensation value being changed, camera device
692 * may take several frames to reach the newly requested exposure target.
693 * During that time, {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} field will be in the SEARCHING
694 * state. Once the new exposure target is reached, {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} will
695 * change from SEARCHING to either CONVERGED, LOCKED (if AE lock is enabled), or
696 * FLASH_REQUIRED (if the scene is too dark for still capture).</p>
697 * <p><b>Units</b>: Compensation steps</p>
698 * <p><b>Range of valid values:</b><br>
699 * {@link CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE android.control.aeCompensationRange}</p>
700 * <p>This key is available on all devices.</p>
702 * @see CameraCharacteristics#CONTROL_AE_COMPENSATION_RANGE
703 * @see CameraCharacteristics#CONTROL_AE_COMPENSATION_STEP
704 * @see CaptureRequest#CONTROL_AE_LOCK
705 * @see CaptureRequest#CONTROL_AE_MODE
706 * @see CaptureResult#CONTROL_AE_STATE
709 public static final Key<Integer> CONTROL_AE_EXPOSURE_COMPENSATION =
710 new Key<Integer>("android.control.aeExposureCompensation", int.class);
713 * <p>Whether auto-exposure (AE) is currently locked to its latest
714 * calculated values.</p>
715 * <p>When set to <code>true</code> (ON), the AE algorithm is locked to its latest parameters,
716 * and will not change exposure settings until the lock is set to <code>false</code> (OFF).</p>
717 * <p>Note that even when AE is locked, the flash may be fired if
718 * the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_AUTO_FLASH /
719 * ON_ALWAYS_FLASH / ON_AUTO_FLASH_REDEYE.</p>
720 * <p>When {@link CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION android.control.aeExposureCompensation} is changed, even if the AE lock
721 * is ON, the camera device will still adjust its exposure value.</p>
722 * <p>If AE precapture is triggered (see {@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger})
723 * when AE is already locked, the camera device will not change the exposure time
724 * ({@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}) and sensitivity ({@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity})
725 * parameters. The flash may be fired if the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode}
726 * is ON_AUTO_FLASH/ON_AUTO_FLASH_REDEYE and the scene is too dark. If the
727 * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_ALWAYS_FLASH, the scene may become overexposed.</p>
728 * <p>Since the camera device has a pipeline of in-flight requests, the settings that
729 * get locked do not necessarily correspond to the settings that were present in the
730 * latest capture result received from the camera device, since additional captures
731 * and AE updates may have occurred even before the result was sent out. If an
732 * application is switching between automatic and manual control and wishes to eliminate
733 * any flicker during the switch, the following procedure is recommended:</p>
735 * <li>Starting in auto-AE mode:</li>
737 * <li>Wait for the first result to be output that has the AE locked</li>
738 * <li>Copy exposure settings from that result into a request, set the request to manual AE</li>
739 * <li>Submit the capture request, proceed to run manual AE as desired.</li>
741 * <p>See {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE lock related state transition details.</p>
742 * <p>This key is available on all devices.</p>
744 * @see CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION
745 * @see CaptureRequest#CONTROL_AE_MODE
746 * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
747 * @see CaptureResult#CONTROL_AE_STATE
748 * @see CaptureRequest#SENSOR_EXPOSURE_TIME
749 * @see CaptureRequest#SENSOR_SENSITIVITY
752 public static final Key<Boolean> CONTROL_AE_LOCK =
753 new Key<Boolean>("android.control.aeLock", boolean.class);
756 * <p>The desired mode for the camera device's
757 * auto-exposure routine.</p>
758 * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is
760 * <p>When set to any of the ON modes, the camera device's
761 * auto-exposure routine is enabled, overriding the
762 * application's selected exposure time, sensor sensitivity,
763 * and frame duration ({@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime},
764 * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and
765 * {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}). If one of the FLASH modes
766 * is selected, the camera device's flash unit controls are
767 * also overridden.</p>
768 * <p>The FLASH modes are only available if the camera device
769 * has a flash unit ({@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} is <code>true</code>).</p>
770 * <p>If flash TORCH mode is desired, this field must be set to
771 * ON or OFF, and {@link CaptureRequest#FLASH_MODE android.flash.mode} set to TORCH.</p>
772 * <p>When set to any of the ON modes, the values chosen by the
773 * camera device auto-exposure routine for the overridden
774 * fields for a given capture will be available in its
776 * <p><b>Possible values:</b>
778 * <li>{@link #CONTROL_AE_MODE_OFF OFF}</li>
779 * <li>{@link #CONTROL_AE_MODE_ON ON}</li>
780 * <li>{@link #CONTROL_AE_MODE_ON_AUTO_FLASH ON_AUTO_FLASH}</li>
781 * <li>{@link #CONTROL_AE_MODE_ON_ALWAYS_FLASH ON_ALWAYS_FLASH}</li>
782 * <li>{@link #CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE ON_AUTO_FLASH_REDEYE}</li>
784 * <p><b>Available values for this device:</b><br>
785 * {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_MODES android.control.aeAvailableModes}</p>
786 * <p>This key is available on all devices.</p>
788 * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_MODES
789 * @see CaptureRequest#CONTROL_MODE
790 * @see CameraCharacteristics#FLASH_INFO_AVAILABLE
791 * @see CaptureRequest#FLASH_MODE
792 * @see CaptureRequest#SENSOR_EXPOSURE_TIME
793 * @see CaptureRequest#SENSOR_FRAME_DURATION
794 * @see CaptureRequest#SENSOR_SENSITIVITY
795 * @see #CONTROL_AE_MODE_OFF
796 * @see #CONTROL_AE_MODE_ON
797 * @see #CONTROL_AE_MODE_ON_AUTO_FLASH
798 * @see #CONTROL_AE_MODE_ON_ALWAYS_FLASH
799 * @see #CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE
802 public static final Key<Integer> CONTROL_AE_MODE =
803 new Key<Integer>("android.control.aeMode", int.class);
806 * <p>List of metering areas to use for auto-exposure adjustment.</p>
807 * <p>Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AE android.control.maxRegionsAe} is 0.
808 * Otherwise will always be present.</p>
809 * <p>The maximum number of regions supported by the device is determined by the value
810 * of {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AE android.control.maxRegionsAe}.</p>
811 * <p>The coordinate system is based on the active pixel array,
812 * with (0,0) being the top-left pixel in the active pixel array, and
813 * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1,
814 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the
815 * bottom-right pixel in the active pixel array.</p>
816 * <p>The weight must be within <code>[0, 1000]</code>, and represents a weight
817 * for every pixel in the area. This means that a large metering area
818 * with the same weight as a smaller area will have more effect in
819 * the metering result. Metering areas can partially overlap and the
820 * camera device will add the weights in the overlap region.</p>
821 * <p>The weights are relative to weights of other exposure metering regions, so if only one
822 * region is used, all non-zero weights will have the same effect. A region with 0
823 * weight is ignored.</p>
824 * <p>If all regions have 0 weight, then no specific metering area needs to be used by the
826 * <p>If the metering region is outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in
827 * capture result metadata, the camera device will ignore the sections outside the crop
828 * region and output only the intersection rectangle as the metering region in the result
829 * metadata. If the region is entirely outside the crop region, it will be ignored and
830 * not reported in the result metadata.</p>
831 * <p><b>Units</b>: Pixel coordinates within {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p>
832 * <p><b>Range of valid values:</b><br>
833 * Coordinates must be between <code>[(0,0), (width, height))</code> of
834 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p>
835 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
837 * @see CameraCharacteristics#CONTROL_MAX_REGIONS_AE
838 * @see CaptureRequest#SCALER_CROP_REGION
839 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE
842 public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AE_REGIONS =
843 new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.aeRegions", android.hardware.camera2.params.MeteringRectangle[].class);
846 * <p>Range over which the auto-exposure routine can
847 * adjust the capture frame rate to maintain good
849 * <p>Only constrains auto-exposure (AE) algorithm, not
850 * manual control of {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime} and
851 * {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}.</p>
852 * <p><b>Units</b>: Frames per second (FPS)</p>
853 * <p><b>Range of valid values:</b><br>
854 * Any of the entries in {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES android.control.aeAvailableTargetFpsRanges}</p>
855 * <p>This key is available on all devices.</p>
857 * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES
858 * @see CaptureRequest#SENSOR_EXPOSURE_TIME
859 * @see CaptureRequest#SENSOR_FRAME_DURATION
862 public static final Key<android.util.Range<Integer>> CONTROL_AE_TARGET_FPS_RANGE =
863 new Key<android.util.Range<Integer>>("android.control.aeTargetFpsRange", new TypeReference<android.util.Range<Integer>>() {{ }});
866 * <p>Whether the camera device will trigger a precapture
867 * metering sequence when it processes this request.</p>
868 * <p>This entry is normally set to IDLE, or is not
869 * included at all in the request settings. When included and
870 * set to START, the camera device will trigger the autoexposure
871 * precapture metering sequence.</p>
872 * <p>The precapture sequence should triggered before starting a
873 * high-quality still capture for final metering decisions to
874 * be made, and for firing pre-capture flash pulses to estimate
875 * scene brightness and required final capture flash power, when
876 * the flash is enabled.</p>
877 * <p>Normally, this entry should be set to START for only a
878 * single request, and the application should wait until the
879 * sequence completes before starting a new one.</p>
880 * <p>The exact effect of auto-exposure (AE) precapture trigger
881 * depends on the current AE mode and state; see
882 * {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE precapture state transition
884 * <p>On LEGACY-level devices, the precapture trigger is not supported;
885 * capturing a high-resolution JPEG image will automatically trigger a
886 * precapture sequence before the high-resolution capture, including
887 * potentially firing a pre-capture flash.</p>
888 * <p><b>Possible values:</b>
890 * <li>{@link #CONTROL_AE_PRECAPTURE_TRIGGER_IDLE IDLE}</li>
891 * <li>{@link #CONTROL_AE_PRECAPTURE_TRIGGER_START START}</li>
893 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
894 * <p><b>Limited capability</b> -
895 * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the
896 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
898 * @see CaptureResult#CONTROL_AE_STATE
899 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
900 * @see #CONTROL_AE_PRECAPTURE_TRIGGER_IDLE
901 * @see #CONTROL_AE_PRECAPTURE_TRIGGER_START
904 public static final Key<Integer> CONTROL_AE_PRECAPTURE_TRIGGER =
905 new Key<Integer>("android.control.aePrecaptureTrigger", int.class);
908 * <p>Whether auto-focus (AF) is currently enabled, and what
909 * mode it is set to.</p>
910 * <p>Only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} = AUTO and the lens is not fixed focus
911 * (i.e. <code>{@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} > 0</code>). Also note that
912 * when {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is OFF, the behavior of AF is device
913 * dependent. It is recommended to lock AF by using {@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger} before
914 * setting {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} to OFF, or set AF mode to OFF when AE is OFF.</p>
915 * <p>If the lens is controlled by the camera device auto-focus algorithm,
916 * the camera device will report the current AF status in {@link CaptureResult#CONTROL_AF_STATE android.control.afState}
917 * in result metadata.</p>
918 * <p><b>Possible values:</b>
920 * <li>{@link #CONTROL_AF_MODE_OFF OFF}</li>
921 * <li>{@link #CONTROL_AF_MODE_AUTO AUTO}</li>
922 * <li>{@link #CONTROL_AF_MODE_MACRO MACRO}</li>
923 * <li>{@link #CONTROL_AF_MODE_CONTINUOUS_VIDEO CONTINUOUS_VIDEO}</li>
924 * <li>{@link #CONTROL_AF_MODE_CONTINUOUS_PICTURE CONTINUOUS_PICTURE}</li>
925 * <li>{@link #CONTROL_AF_MODE_EDOF EDOF}</li>
927 * <p><b>Available values for this device:</b><br>
928 * {@link CameraCharacteristics#CONTROL_AF_AVAILABLE_MODES android.control.afAvailableModes}</p>
929 * <p>This key is available on all devices.</p>
931 * @see CaptureRequest#CONTROL_AE_MODE
932 * @see CameraCharacteristics#CONTROL_AF_AVAILABLE_MODES
933 * @see CaptureResult#CONTROL_AF_STATE
934 * @see CaptureRequest#CONTROL_AF_TRIGGER
935 * @see CaptureRequest#CONTROL_MODE
936 * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE
937 * @see #CONTROL_AF_MODE_OFF
938 * @see #CONTROL_AF_MODE_AUTO
939 * @see #CONTROL_AF_MODE_MACRO
940 * @see #CONTROL_AF_MODE_CONTINUOUS_VIDEO
941 * @see #CONTROL_AF_MODE_CONTINUOUS_PICTURE
942 * @see #CONTROL_AF_MODE_EDOF
945 public static final Key<Integer> CONTROL_AF_MODE =
946 new Key<Integer>("android.control.afMode", int.class);
949 * <p>List of metering areas to use for auto-focus.</p>
950 * <p>Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AF android.control.maxRegionsAf} is 0.
951 * Otherwise will always be present.</p>
952 * <p>The maximum number of focus areas supported by the device is determined by the value
953 * of {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AF android.control.maxRegionsAf}.</p>
954 * <p>The coordinate system is based on the active pixel array,
955 * with (0,0) being the top-left pixel in the active pixel array, and
956 * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1,
957 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the
958 * bottom-right pixel in the active pixel array.</p>
959 * <p>The weight must be within <code>[0, 1000]</code>, and represents a weight
960 * for every pixel in the area. This means that a large metering area
961 * with the same weight as a smaller area will have more effect in
962 * the metering result. Metering areas can partially overlap and the
963 * camera device will add the weights in the overlap region.</p>
964 * <p>The weights are relative to weights of other metering regions, so if only one region
965 * is used, all non-zero weights will have the same effect. A region with 0 weight is
967 * <p>If all regions have 0 weight, then no specific metering area needs to be used by the
969 * <p>If the metering region is outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in
970 * capture result metadata, the camera device will ignore the sections outside the crop
971 * region and output only the intersection rectangle as the metering region in the result
972 * metadata. If the region is entirely outside the crop region, it will be ignored and
973 * not reported in the result metadata.</p>
974 * <p><b>Units</b>: Pixel coordinates within {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p>
975 * <p><b>Range of valid values:</b><br>
976 * Coordinates must be between <code>[(0,0), (width, height))</code> of
977 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p>
978 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
980 * @see CameraCharacteristics#CONTROL_MAX_REGIONS_AF
981 * @see CaptureRequest#SCALER_CROP_REGION
982 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE
985 public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AF_REGIONS =
986 new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.afRegions", android.hardware.camera2.params.MeteringRectangle[].class);
989 * <p>Whether the camera device will trigger autofocus for this request.</p>
990 * <p>This entry is normally set to IDLE, or is not
991 * included at all in the request settings.</p>
992 * <p>When included and set to START, the camera device will trigger the
993 * autofocus algorithm. If autofocus is disabled, this trigger has no effect.</p>
994 * <p>When set to CANCEL, the camera device will cancel any active trigger,
995 * and return to its initial AF state.</p>
996 * <p>Generally, applications should set this entry to START or CANCEL for only a
997 * single capture, and then return it to IDLE (or not set at all). Specifying
998 * START for multiple captures in a row means restarting the AF operation over
999 * and over again.</p>
1000 * <p>See {@link CaptureResult#CONTROL_AF_STATE android.control.afState} for what the trigger means for each AF mode.</p>
1001 * <p><b>Possible values:</b>
1003 * <li>{@link #CONTROL_AF_TRIGGER_IDLE IDLE}</li>
1004 * <li>{@link #CONTROL_AF_TRIGGER_START START}</li>
1005 * <li>{@link #CONTROL_AF_TRIGGER_CANCEL CANCEL}</li>
1007 * <p>This key is available on all devices.</p>
1009 * @see CaptureResult#CONTROL_AF_STATE
1010 * @see #CONTROL_AF_TRIGGER_IDLE
1011 * @see #CONTROL_AF_TRIGGER_START
1012 * @see #CONTROL_AF_TRIGGER_CANCEL
1015 public static final Key<Integer> CONTROL_AF_TRIGGER =
1016 new Key<Integer>("android.control.afTrigger", int.class);
1019 * <p>Whether auto-white balance (AWB) is currently locked to its
1020 * latest calculated values.</p>
1021 * <p>When set to <code>true</code> (ON), the AWB algorithm is locked to its latest parameters,
1022 * and will not change color balance settings until the lock is set to <code>false</code> (OFF).</p>
1023 * <p>Since the camera device has a pipeline of in-flight requests, the settings that
1024 * get locked do not necessarily correspond to the settings that were present in the
1025 * latest capture result received from the camera device, since additional captures
1026 * and AWB updates may have occurred even before the result was sent out. If an
1027 * application is switching between automatic and manual control and wishes to eliminate
1028 * any flicker during the switch, the following procedure is recommended:</p>
1030 * <li>Starting in auto-AWB mode:</li>
1032 * <li>Wait for the first result to be output that has the AWB locked</li>
1033 * <li>Copy AWB settings from that result into a request, set the request to manual AWB</li>
1034 * <li>Submit the capture request, proceed to run manual AWB as desired.</li>
1036 * <p>Note that AWB lock is only meaningful when
1037 * {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} is in the AUTO mode; in other modes,
1038 * AWB is already fixed to a specific setting.</p>
1039 * <p>Some LEGACY devices may not support ON; the value is then overridden to OFF.</p>
1040 * <p>This key is available on all devices.</p>
1042 * @see CaptureRequest#CONTROL_AWB_MODE
1045 public static final Key<Boolean> CONTROL_AWB_LOCK =
1046 new Key<Boolean>("android.control.awbLock", boolean.class);
1049 * <p>Whether auto-white balance (AWB) is currently setting the color
1050 * transform fields, and what its illumination target
1052 * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is AUTO.</p>
1053 * <p>When set to the ON mode, the camera device's auto-white balance
1054 * routine is enabled, overriding the application's selected
1055 * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and
1056 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}. Note that when {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode}
1057 * is OFF, the behavior of AWB is device dependent. It is recommened to
1058 * also set AWB mode to OFF or lock AWB by using {@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock} before
1059 * setting AE mode to OFF.</p>
1060 * <p>When set to the OFF mode, the camera device's auto-white balance
1061 * routine is disabled. The application manually controls the white
1062 * balance by {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains}
1063 * and {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.</p>
1064 * <p>When set to any other modes, the camera device's auto-white
1065 * balance routine is disabled. The camera device uses each
1066 * particular illumination target for white balance
1067 * adjustment. The application's values for
1068 * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform},
1069 * {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and
1070 * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} are ignored.</p>
1071 * <p><b>Possible values:</b>
1073 * <li>{@link #CONTROL_AWB_MODE_OFF OFF}</li>
1074 * <li>{@link #CONTROL_AWB_MODE_AUTO AUTO}</li>
1075 * <li>{@link #CONTROL_AWB_MODE_INCANDESCENT INCANDESCENT}</li>
1076 * <li>{@link #CONTROL_AWB_MODE_FLUORESCENT FLUORESCENT}</li>
1077 * <li>{@link #CONTROL_AWB_MODE_WARM_FLUORESCENT WARM_FLUORESCENT}</li>
1078 * <li>{@link #CONTROL_AWB_MODE_DAYLIGHT DAYLIGHT}</li>
1079 * <li>{@link #CONTROL_AWB_MODE_CLOUDY_DAYLIGHT CLOUDY_DAYLIGHT}</li>
1080 * <li>{@link #CONTROL_AWB_MODE_TWILIGHT TWILIGHT}</li>
1081 * <li>{@link #CONTROL_AWB_MODE_SHADE SHADE}</li>
1083 * <p><b>Available values for this device:</b><br>
1084 * {@link CameraCharacteristics#CONTROL_AWB_AVAILABLE_MODES android.control.awbAvailableModes}</p>
1085 * <p>This key is available on all devices.</p>
1087 * @see CaptureRequest#COLOR_CORRECTION_GAINS
1088 * @see CaptureRequest#COLOR_CORRECTION_MODE
1089 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
1090 * @see CaptureRequest#CONTROL_AE_MODE
1091 * @see CameraCharacteristics#CONTROL_AWB_AVAILABLE_MODES
1092 * @see CaptureRequest#CONTROL_AWB_LOCK
1093 * @see CaptureRequest#CONTROL_MODE
1094 * @see #CONTROL_AWB_MODE_OFF
1095 * @see #CONTROL_AWB_MODE_AUTO
1096 * @see #CONTROL_AWB_MODE_INCANDESCENT
1097 * @see #CONTROL_AWB_MODE_FLUORESCENT
1098 * @see #CONTROL_AWB_MODE_WARM_FLUORESCENT
1099 * @see #CONTROL_AWB_MODE_DAYLIGHT
1100 * @see #CONTROL_AWB_MODE_CLOUDY_DAYLIGHT
1101 * @see #CONTROL_AWB_MODE_TWILIGHT
1102 * @see #CONTROL_AWB_MODE_SHADE
1105 public static final Key<Integer> CONTROL_AWB_MODE =
1106 new Key<Integer>("android.control.awbMode", int.class);
1109 * <p>List of metering areas to use for auto-white-balance illuminant
1111 * <p>Not available if {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AWB android.control.maxRegionsAwb} is 0.
1112 * Otherwise will always be present.</p>
1113 * <p>The maximum number of regions supported by the device is determined by the value
1114 * of {@link CameraCharacteristics#CONTROL_MAX_REGIONS_AWB android.control.maxRegionsAwb}.</p>
1115 * <p>The coordinate system is based on the active pixel array,
1116 * with (0,0) being the top-left pixel in the active pixel array, and
1117 * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1,
1118 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the
1119 * bottom-right pixel in the active pixel array.</p>
1120 * <p>The weight must range from 0 to 1000, and represents a weight
1121 * for every pixel in the area. This means that a large metering area
1122 * with the same weight as a smaller area will have more effect in
1123 * the metering result. Metering areas can partially overlap and the
1124 * camera device will add the weights in the overlap region.</p>
1125 * <p>The weights are relative to weights of other white balance metering regions, so if
1126 * only one region is used, all non-zero weights will have the same effect. A region with
1127 * 0 weight is ignored.</p>
1128 * <p>If all regions have 0 weight, then no specific metering area needs to be used by the
1129 * camera device.</p>
1130 * <p>If the metering region is outside the used {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} returned in
1131 * capture result metadata, the camera device will ignore the sections outside the crop
1132 * region and output only the intersection rectangle as the metering region in the result
1133 * metadata. If the region is entirely outside the crop region, it will be ignored and
1134 * not reported in the result metadata.</p>
1135 * <p><b>Units</b>: Pixel coordinates within {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p>
1136 * <p><b>Range of valid values:</b><br>
1137 * Coordinates must be between <code>[(0,0), (width, height))</code> of
1138 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p>
1139 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1141 * @see CameraCharacteristics#CONTROL_MAX_REGIONS_AWB
1142 * @see CaptureRequest#SCALER_CROP_REGION
1143 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE
1146 public static final Key<android.hardware.camera2.params.MeteringRectangle[]> CONTROL_AWB_REGIONS =
1147 new Key<android.hardware.camera2.params.MeteringRectangle[]>("android.control.awbRegions", android.hardware.camera2.params.MeteringRectangle[].class);
1150 * <p>Information to the camera device 3A (auto-exposure,
1151 * auto-focus, auto-white balance) routines about the purpose
1152 * of this capture, to help the camera device to decide optimal 3A
1154 * <p>This control (except for MANUAL) is only effective if
1155 * <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} != OFF</code> and any 3A routine is active.</p>
1156 * <p>ZERO_SHUTTER_LAG will be supported if {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities}
1157 * contains ZSL. MANUAL will be supported if {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities}
1158 * contains MANUAL_SENSOR. Other intent values are always supported.</p>
1159 * <p><b>Possible values:</b>
1161 * <li>{@link #CONTROL_CAPTURE_INTENT_CUSTOM CUSTOM}</li>
1162 * <li>{@link #CONTROL_CAPTURE_INTENT_PREVIEW PREVIEW}</li>
1163 * <li>{@link #CONTROL_CAPTURE_INTENT_STILL_CAPTURE STILL_CAPTURE}</li>
1164 * <li>{@link #CONTROL_CAPTURE_INTENT_VIDEO_RECORD VIDEO_RECORD}</li>
1165 * <li>{@link #CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT VIDEO_SNAPSHOT}</li>
1166 * <li>{@link #CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG ZERO_SHUTTER_LAG}</li>
1167 * <li>{@link #CONTROL_CAPTURE_INTENT_MANUAL MANUAL}</li>
1169 * <p>This key is available on all devices.</p>
1171 * @see CaptureRequest#CONTROL_MODE
1172 * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
1173 * @see #CONTROL_CAPTURE_INTENT_CUSTOM
1174 * @see #CONTROL_CAPTURE_INTENT_PREVIEW
1175 * @see #CONTROL_CAPTURE_INTENT_STILL_CAPTURE
1176 * @see #CONTROL_CAPTURE_INTENT_VIDEO_RECORD
1177 * @see #CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT
1178 * @see #CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG
1179 * @see #CONTROL_CAPTURE_INTENT_MANUAL
1182 public static final Key<Integer> CONTROL_CAPTURE_INTENT =
1183 new Key<Integer>("android.control.captureIntent", int.class);
1186 * <p>A special color effect to apply.</p>
1187 * <p>When this mode is set, a color effect will be applied
1188 * to images produced by the camera device. The interpretation
1189 * and implementation of these color effects is left to the
1190 * implementor of the camera device, and should not be
1191 * depended on to be consistent (or present) across all
1193 * <p><b>Possible values:</b>
1195 * <li>{@link #CONTROL_EFFECT_MODE_OFF OFF}</li>
1196 * <li>{@link #CONTROL_EFFECT_MODE_MONO MONO}</li>
1197 * <li>{@link #CONTROL_EFFECT_MODE_NEGATIVE NEGATIVE}</li>
1198 * <li>{@link #CONTROL_EFFECT_MODE_SOLARIZE SOLARIZE}</li>
1199 * <li>{@link #CONTROL_EFFECT_MODE_SEPIA SEPIA}</li>
1200 * <li>{@link #CONTROL_EFFECT_MODE_POSTERIZE POSTERIZE}</li>
1201 * <li>{@link #CONTROL_EFFECT_MODE_WHITEBOARD WHITEBOARD}</li>
1202 * <li>{@link #CONTROL_EFFECT_MODE_BLACKBOARD BLACKBOARD}</li>
1203 * <li>{@link #CONTROL_EFFECT_MODE_AQUA AQUA}</li>
1205 * <p><b>Available values for this device:</b><br>
1206 * {@link CameraCharacteristics#CONTROL_AVAILABLE_EFFECTS android.control.availableEffects}</p>
1207 * <p>This key is available on all devices.</p>
1209 * @see CameraCharacteristics#CONTROL_AVAILABLE_EFFECTS
1210 * @see #CONTROL_EFFECT_MODE_OFF
1211 * @see #CONTROL_EFFECT_MODE_MONO
1212 * @see #CONTROL_EFFECT_MODE_NEGATIVE
1213 * @see #CONTROL_EFFECT_MODE_SOLARIZE
1214 * @see #CONTROL_EFFECT_MODE_SEPIA
1215 * @see #CONTROL_EFFECT_MODE_POSTERIZE
1216 * @see #CONTROL_EFFECT_MODE_WHITEBOARD
1217 * @see #CONTROL_EFFECT_MODE_BLACKBOARD
1218 * @see #CONTROL_EFFECT_MODE_AQUA
1221 public static final Key<Integer> CONTROL_EFFECT_MODE =
1222 new Key<Integer>("android.control.effectMode", int.class);
1225 * <p>Overall mode of 3A (auto-exposure, auto-white-balance, auto-focus) control
1227 * <p>This is a top-level 3A control switch. When set to OFF, all 3A control
1228 * by the camera device is disabled. The application must set the fields for
1229 * capture parameters itself.</p>
1230 * <p>When set to AUTO, the individual algorithm controls in
1231 * android.control.* are in effect, such as {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}.</p>
1232 * <p>When set to USE_SCENE_MODE, the individual controls in
1233 * android.control.* are mostly disabled, and the camera device implements
1234 * one of the scene mode settings (such as ACTION, SUNSET, or PARTY)
1235 * as it wishes. The camera device scene mode 3A settings are provided by
1236 * android.control.sceneModeOverrides.</p>
1237 * <p>When set to OFF_KEEP_STATE, it is similar to OFF mode, the only difference
1238 * is that this frame will not be used by camera device background 3A statistics
1239 * update, as if this frame is never captured. This mode can be used in the scenario
1240 * where the application doesn't want a 3A manual control capture to affect
1241 * the subsequent auto 3A capture results.</p>
1242 * <p>LEGACY mode devices will only support AUTO and USE_SCENE_MODE modes.
1243 * LIMITED mode devices will only support OFF and OFF_KEEP_STATE if they
1244 * support the MANUAL_SENSOR and MANUAL_POST_PROCSESING capabilities.
1245 * FULL mode devices will always support OFF and OFF_KEEP_STATE.</p>
1246 * <p><b>Possible values:</b>
1248 * <li>{@link #CONTROL_MODE_OFF OFF}</li>
1249 * <li>{@link #CONTROL_MODE_AUTO AUTO}</li>
1250 * <li>{@link #CONTROL_MODE_USE_SCENE_MODE USE_SCENE_MODE}</li>
1251 * <li>{@link #CONTROL_MODE_OFF_KEEP_STATE OFF_KEEP_STATE}</li>
1253 * <p>This key is available on all devices.</p>
1255 * @see CaptureRequest#CONTROL_AF_MODE
1256 * @see #CONTROL_MODE_OFF
1257 * @see #CONTROL_MODE_AUTO
1258 * @see #CONTROL_MODE_USE_SCENE_MODE
1259 * @see #CONTROL_MODE_OFF_KEEP_STATE
1262 public static final Key<Integer> CONTROL_MODE =
1263 new Key<Integer>("android.control.mode", int.class);
1266 * <p>Control for which scene mode is currently active.</p>
1267 * <p>Scene modes are custom camera modes optimized for a certain set of conditions and
1268 * capture settings.</p>
1269 * <p>This is the mode that that is active when
1270 * <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code>. Aside from FACE_PRIORITY,
1271 * these modes will disable {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode},
1272 * {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, and {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} while in use.</p>
1273 * <p>The interpretation and implementation of these scene modes is left
1274 * to the implementor of the camera device. Their behavior will not be
1275 * consistent across all devices, and any given device may only implement
1276 * a subset of these modes.</p>
1277 * <p><b>Possible values:</b>
1279 * <li>{@link #CONTROL_SCENE_MODE_DISABLED DISABLED}</li>
1280 * <li>{@link #CONTROL_SCENE_MODE_FACE_PRIORITY FACE_PRIORITY}</li>
1281 * <li>{@link #CONTROL_SCENE_MODE_ACTION ACTION}</li>
1282 * <li>{@link #CONTROL_SCENE_MODE_PORTRAIT PORTRAIT}</li>
1283 * <li>{@link #CONTROL_SCENE_MODE_LANDSCAPE LANDSCAPE}</li>
1284 * <li>{@link #CONTROL_SCENE_MODE_NIGHT NIGHT}</li>
1285 * <li>{@link #CONTROL_SCENE_MODE_NIGHT_PORTRAIT NIGHT_PORTRAIT}</li>
1286 * <li>{@link #CONTROL_SCENE_MODE_THEATRE THEATRE}</li>
1287 * <li>{@link #CONTROL_SCENE_MODE_BEACH BEACH}</li>
1288 * <li>{@link #CONTROL_SCENE_MODE_SNOW SNOW}</li>
1289 * <li>{@link #CONTROL_SCENE_MODE_SUNSET SUNSET}</li>
1290 * <li>{@link #CONTROL_SCENE_MODE_STEADYPHOTO STEADYPHOTO}</li>
1291 * <li>{@link #CONTROL_SCENE_MODE_FIREWORKS FIREWORKS}</li>
1292 * <li>{@link #CONTROL_SCENE_MODE_SPORTS SPORTS}</li>
1293 * <li>{@link #CONTROL_SCENE_MODE_PARTY PARTY}</li>
1294 * <li>{@link #CONTROL_SCENE_MODE_CANDLELIGHT CANDLELIGHT}</li>
1295 * <li>{@link #CONTROL_SCENE_MODE_BARCODE BARCODE}</li>
1296 * <li>{@link #CONTROL_SCENE_MODE_HIGH_SPEED_VIDEO HIGH_SPEED_VIDEO}</li>
1297 * <li>{@link #CONTROL_SCENE_MODE_HDR HDR}</li>
1299 * <p><b>Available values for this device:</b><br>
1300 * {@link CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES android.control.availableSceneModes}</p>
1301 * <p>This key is available on all devices.</p>
1303 * @see CaptureRequest#CONTROL_AE_MODE
1304 * @see CaptureRequest#CONTROL_AF_MODE
1305 * @see CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES
1306 * @see CaptureRequest#CONTROL_AWB_MODE
1307 * @see CaptureRequest#CONTROL_MODE
1308 * @see #CONTROL_SCENE_MODE_DISABLED
1309 * @see #CONTROL_SCENE_MODE_FACE_PRIORITY
1310 * @see #CONTROL_SCENE_MODE_ACTION
1311 * @see #CONTROL_SCENE_MODE_PORTRAIT
1312 * @see #CONTROL_SCENE_MODE_LANDSCAPE
1313 * @see #CONTROL_SCENE_MODE_NIGHT
1314 * @see #CONTROL_SCENE_MODE_NIGHT_PORTRAIT
1315 * @see #CONTROL_SCENE_MODE_THEATRE
1316 * @see #CONTROL_SCENE_MODE_BEACH
1317 * @see #CONTROL_SCENE_MODE_SNOW
1318 * @see #CONTROL_SCENE_MODE_SUNSET
1319 * @see #CONTROL_SCENE_MODE_STEADYPHOTO
1320 * @see #CONTROL_SCENE_MODE_FIREWORKS
1321 * @see #CONTROL_SCENE_MODE_SPORTS
1322 * @see #CONTROL_SCENE_MODE_PARTY
1323 * @see #CONTROL_SCENE_MODE_CANDLELIGHT
1324 * @see #CONTROL_SCENE_MODE_BARCODE
1325 * @see #CONTROL_SCENE_MODE_HIGH_SPEED_VIDEO
1326 * @see #CONTROL_SCENE_MODE_HDR
1329 public static final Key<Integer> CONTROL_SCENE_MODE =
1330 new Key<Integer>("android.control.sceneMode", int.class);
1333 * <p>Whether video stabilization is
1335 * <p>Video stabilization automatically translates and scales images from
1336 * the camera in order to stabilize motion between consecutive frames.</p>
1337 * <p>If enabled, video stabilization can modify the
1338 * {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} to keep the video stream stabilized.</p>
1339 * <p>Switching between different video stabilization modes may take several
1340 * frames to initialize, the camera device will report the current mode
1341 * in capture result metadata. For example, When "ON" mode is requested,
1342 * the video stabilization modes in the first several capture results may
1343 * still be "OFF", and it will become "ON" when the initialization is
1345 * <p>If a camera device supports both this mode and OIS
1346 * ({@link CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE android.lens.opticalStabilizationMode}), turning both modes on may
1347 * produce undesirable interaction, so it is recommended not to enable
1348 * both at the same time.</p>
1349 * <p><b>Possible values:</b>
1351 * <li>{@link #CONTROL_VIDEO_STABILIZATION_MODE_OFF OFF}</li>
1352 * <li>{@link #CONTROL_VIDEO_STABILIZATION_MODE_ON ON}</li>
1354 * <p>This key is available on all devices.</p>
1356 * @see CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE
1357 * @see CaptureRequest#SCALER_CROP_REGION
1358 * @see #CONTROL_VIDEO_STABILIZATION_MODE_OFF
1359 * @see #CONTROL_VIDEO_STABILIZATION_MODE_ON
1362 public static final Key<Integer> CONTROL_VIDEO_STABILIZATION_MODE =
1363 new Key<Integer>("android.control.videoStabilizationMode", int.class);
1366 * <p>Operation mode for edge
1368 * <p>Edge enhancement improves sharpness and details in the captured image. OFF means
1369 * no enhancement will be applied by the camera device.</p>
1370 * <p>FAST/HIGH_QUALITY both mean camera device determined enhancement
1371 * will be applied. HIGH_QUALITY mode indicates that the
1372 * camera device will use the highest-quality enhancement algorithms,
1373 * even if it slows down capture rate. FAST means the camera device will
1374 * not slow down capture rate when applying edge enhancement.</p>
1375 * <p><b>Possible values:</b>
1377 * <li>{@link #EDGE_MODE_OFF OFF}</li>
1378 * <li>{@link #EDGE_MODE_FAST FAST}</li>
1379 * <li>{@link #EDGE_MODE_HIGH_QUALITY HIGH_QUALITY}</li>
1381 * <p><b>Available values for this device:</b><br>
1382 * {@link CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES android.edge.availableEdgeModes}</p>
1383 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1384 * <p><b>Full capability</b> -
1385 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
1386 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
1388 * @see CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES
1389 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
1390 * @see #EDGE_MODE_OFF
1391 * @see #EDGE_MODE_FAST
1392 * @see #EDGE_MODE_HIGH_QUALITY
1395 public static final Key<Integer> EDGE_MODE =
1396 new Key<Integer>("android.edge.mode", int.class);
1399 * <p>The desired mode for for the camera device's flash control.</p>
1400 * <p>This control is only effective when flash unit is available
1401 * (<code>{@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} == true</code>).</p>
1402 * <p>When this control is used, the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} must be set to ON or OFF.
1403 * Otherwise, the camera device auto-exposure related flash control (ON_AUTO_FLASH,
1404 * ON_ALWAYS_FLASH, or ON_AUTO_FLASH_REDEYE) will override this control.</p>
1405 * <p>When set to OFF, the camera device will not fire flash for this capture.</p>
1406 * <p>When set to SINGLE, the camera device will fire flash regardless of the camera
1407 * device's auto-exposure routine's result. When used in still capture case, this
1408 * control should be used along with auto-exposure (AE) precapture metering sequence
1409 * ({@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}), otherwise, the image may be incorrectly exposed.</p>
1410 * <p>When set to TORCH, the flash will be on continuously. This mode can be used
1411 * for use cases such as preview, auto-focus assist, still capture, or video recording.</p>
1412 * <p>The flash status will be reported by {@link CaptureResult#FLASH_STATE android.flash.state} in the capture result metadata.</p>
1413 * <p><b>Possible values:</b>
1415 * <li>{@link #FLASH_MODE_OFF OFF}</li>
1416 * <li>{@link #FLASH_MODE_SINGLE SINGLE}</li>
1417 * <li>{@link #FLASH_MODE_TORCH TORCH}</li>
1419 * <p>This key is available on all devices.</p>
1421 * @see CaptureRequest#CONTROL_AE_MODE
1422 * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
1423 * @see CameraCharacteristics#FLASH_INFO_AVAILABLE
1424 * @see CaptureResult#FLASH_STATE
1425 * @see #FLASH_MODE_OFF
1426 * @see #FLASH_MODE_SINGLE
1427 * @see #FLASH_MODE_TORCH
1430 public static final Key<Integer> FLASH_MODE =
1431 new Key<Integer>("android.flash.mode", int.class);
1434 * <p>Operational mode for hot pixel correction.</p>
1435 * <p>Hotpixel correction interpolates out, or otherwise removes, pixels
1436 * that do not accurately measure the incoming light (i.e. pixels that
1437 * are stuck at an arbitrary value or are oversensitive).</p>
1438 * <p><b>Possible values:</b>
1440 * <li>{@link #HOT_PIXEL_MODE_OFF OFF}</li>
1441 * <li>{@link #HOT_PIXEL_MODE_FAST FAST}</li>
1442 * <li>{@link #HOT_PIXEL_MODE_HIGH_QUALITY HIGH_QUALITY}</li>
1444 * <p><b>Available values for this device:</b><br>
1445 * {@link CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES android.hotPixel.availableHotPixelModes}</p>
1446 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1448 * @see CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES
1449 * @see #HOT_PIXEL_MODE_OFF
1450 * @see #HOT_PIXEL_MODE_FAST
1451 * @see #HOT_PIXEL_MODE_HIGH_QUALITY
1454 public static final Key<Integer> HOT_PIXEL_MODE =
1455 new Key<Integer>("android.hotPixel.mode", int.class);
1458 * <p>A location object to use when generating image GPS metadata.</p>
1459 * <p>Setting a location object in a request will include the GPS coordinates of the location
1460 * into any JPEG images captured based on the request. These coordinates can then be
1461 * viewed by anyone who receives the JPEG image.</p>
1462 * <p>This key is available on all devices.</p>
1466 public static final Key<android.location.Location> JPEG_GPS_LOCATION =
1467 new Key<android.location.Location>("android.jpeg.gpsLocation", android.location.Location.class);
1470 * <p>GPS coordinates to include in output JPEG
1472 * <p><b>Range of valid values:</b><br>
1473 * (-180 - 180], [-90,90], [-inf, inf]</p>
1474 * <p>This key is available on all devices.</p>
1477 public static final Key<double[]> JPEG_GPS_COORDINATES =
1478 new Key<double[]>("android.jpeg.gpsCoordinates", double[].class);
1481 * <p>32 characters describing GPS algorithm to
1482 * include in EXIF.</p>
1483 * <p><b>Units</b>: UTF-8 null-terminated string</p>
1484 * <p>This key is available on all devices.</p>
1487 public static final Key<String> JPEG_GPS_PROCESSING_METHOD =
1488 new Key<String>("android.jpeg.gpsProcessingMethod", String.class);
1491 * <p>Time GPS fix was made to include in
1493 * <p><b>Units</b>: UTC in seconds since January 1, 1970</p>
1494 * <p>This key is available on all devices.</p>
1497 public static final Key<Long> JPEG_GPS_TIMESTAMP =
1498 new Key<Long>("android.jpeg.gpsTimestamp", long.class);
1501 * <p>The orientation for a JPEG image.</p>
1502 * <p>The clockwise rotation angle in degrees, relative to the orientation
1503 * to the camera, that the JPEG picture needs to be rotated by, to be viewed
1505 * <p>Camera devices may either encode this value into the JPEG EXIF header, or
1506 * rotate the image data to match this orientation.</p>
1507 * <p>Note that this orientation is relative to the orientation of the camera sensor, given
1508 * by {@link CameraCharacteristics#SENSOR_ORIENTATION android.sensor.orientation}.</p>
1509 * <p>To translate from the device orientation given by the Android sensor APIs, the following
1510 * sample code may be used:</p>
1511 * <pre><code>private int getJpegOrientation(CameraCharacteristics c, int deviceOrientation) {
1512 * if (deviceOrientation == android.view.OrientationEventListener.ORIENTATION_UNKNOWN) return 0;
1513 * int sensorOrientation = c.get(CameraCharacteristics.SENSOR_ORIENTATION);
1515 * // Round device orientation to a multiple of 90
1516 * deviceOrientation = (deviceOrientation + 45) / 90 * 90;
1518 * // Reverse device orientation for front-facing cameras
1519 * boolean facingFront = c.get(CameraCharacteristics.LENS_FACING) == CameraCharacteristics.LENS_FACING_FRONT;
1520 * if (facingFront) deviceOrientation = -deviceOrientation;
1522 * // Calculate desired JPEG orientation relative to camera orientation to make
1523 * // the image upright relative to the device orientation
1524 * int jpegOrientation = (sensorOrientation + deviceOrientation + 360) % 360;
1526 * return jpegOrientation;
1529 * <p><b>Units</b>: Degrees in multiples of 90</p>
1530 * <p><b>Range of valid values:</b><br>
1531 * 0, 90, 180, 270</p>
1532 * <p>This key is available on all devices.</p>
1534 * @see CameraCharacteristics#SENSOR_ORIENTATION
1537 public static final Key<Integer> JPEG_ORIENTATION =
1538 new Key<Integer>("android.jpeg.orientation", int.class);
1541 * <p>Compression quality of the final JPEG
1543 * <p>85-95 is typical usage range.</p>
1544 * <p><b>Range of valid values:</b><br>
1545 * 1-100; larger is higher quality</p>
1546 * <p>This key is available on all devices.</p>
1549 public static final Key<Byte> JPEG_QUALITY =
1550 new Key<Byte>("android.jpeg.quality", byte.class);
1553 * <p>Compression quality of JPEG
1555 * <p><b>Range of valid values:</b><br>
1556 * 1-100; larger is higher quality</p>
1557 * <p>This key is available on all devices.</p>
1560 public static final Key<Byte> JPEG_THUMBNAIL_QUALITY =
1561 new Key<Byte>("android.jpeg.thumbnailQuality", byte.class);
1564 * <p>Resolution of embedded JPEG thumbnail.</p>
1565 * <p>When set to (0, 0) value, the JPEG EXIF will not contain thumbnail,
1566 * but the captured JPEG will still be a valid image.</p>
1567 * <p>For best results, when issuing a request for a JPEG image, the thumbnail size selected
1568 * should have the same aspect ratio as the main JPEG output.</p>
1569 * <p>If the thumbnail image aspect ratio differs from the JPEG primary image aspect
1570 * ratio, the camera device creates the thumbnail by cropping it from the primary image.
1571 * For example, if the primary image has 4:3 aspect ratio, the thumbnail image has
1572 * 16:9 aspect ratio, the primary image will be cropped vertically (letterbox) to
1573 * generate the thumbnail image. The thumbnail image will always have a smaller Field
1574 * Of View (FOV) than the primary image when aspect ratios differ.</p>
1575 * <p><b>Range of valid values:</b><br>
1576 * {@link CameraCharacteristics#JPEG_AVAILABLE_THUMBNAIL_SIZES android.jpeg.availableThumbnailSizes}</p>
1577 * <p>This key is available on all devices.</p>
1579 * @see CameraCharacteristics#JPEG_AVAILABLE_THUMBNAIL_SIZES
1582 public static final Key<android.util.Size> JPEG_THUMBNAIL_SIZE =
1583 new Key<android.util.Size>("android.jpeg.thumbnailSize", android.util.Size.class);
1586 * <p>The desired lens aperture size, as a ratio of lens focal length to the
1587 * effective aperture diameter.</p>
1588 * <p>Setting this value is only supported on the camera devices that have a variable
1589 * aperture lens.</p>
1590 * <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is OFF,
1591 * this can be set along with {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime},
1592 * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}
1593 * to achieve manual exposure control.</p>
1594 * <p>The requested aperture value may take several frames to reach the
1595 * requested value; the camera device will report the current (intermediate)
1596 * aperture size in capture result metadata while the aperture is changing.
1597 * While the aperture is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p>
1598 * <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is one of
1599 * the ON modes, this will be overridden by the camera device
1600 * auto-exposure algorithm, the overridden values are then provided
1601 * back to the user in the corresponding result.</p>
1602 * <p><b>Units</b>: The f-number (f/N)</p>
1603 * <p><b>Range of valid values:</b><br>
1604 * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES android.lens.info.availableApertures}</p>
1605 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1606 * <p><b>Full capability</b> -
1607 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
1608 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
1610 * @see CaptureRequest#CONTROL_AE_MODE
1611 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
1612 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES
1613 * @see CaptureResult#LENS_STATE
1614 * @see CaptureRequest#SENSOR_EXPOSURE_TIME
1615 * @see CaptureRequest#SENSOR_FRAME_DURATION
1616 * @see CaptureRequest#SENSOR_SENSITIVITY
1619 public static final Key<Float> LENS_APERTURE =
1620 new Key<Float>("android.lens.aperture", float.class);
1623 * <p>The desired setting for the lens neutral density filter(s).</p>
1624 * <p>This control will not be supported on most camera devices.</p>
1625 * <p>Lens filters are typically used to lower the amount of light the
1626 * sensor is exposed to (measured in steps of EV). As used here, an EV
1627 * step is the standard logarithmic representation, which are
1628 * non-negative, and inversely proportional to the amount of light
1629 * hitting the sensor. For example, setting this to 0 would result
1630 * in no reduction of the incoming light, and setting this to 2 would
1631 * mean that the filter is set to reduce incoming light by two stops
1632 * (allowing 1/4 of the prior amount of light to the sensor).</p>
1633 * <p>It may take several frames before the lens filter density changes
1634 * to the requested value. While the filter density is still changing,
1635 * {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p>
1636 * <p><b>Units</b>: Exposure Value (EV)</p>
1637 * <p><b>Range of valid values:</b><br>
1638 * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES android.lens.info.availableFilterDensities}</p>
1639 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1640 * <p><b>Full capability</b> -
1641 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
1642 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
1644 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
1645 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES
1646 * @see CaptureResult#LENS_STATE
1649 public static final Key<Float> LENS_FILTER_DENSITY =
1650 new Key<Float>("android.lens.filterDensity", float.class);
1653 * <p>The desired lens focal length; used for optical zoom.</p>
1654 * <p>This setting controls the physical focal length of the camera
1655 * device's lens. Changing the focal length changes the field of
1656 * view of the camera device, and is usually used for optical zoom.</p>
1657 * <p>Like {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance} and {@link CaptureRequest#LENS_APERTURE android.lens.aperture}, this
1658 * setting won't be applied instantaneously, and it may take several
1659 * frames before the lens can change to the requested focal length.
1660 * While the focal length is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will
1661 * be set to MOVING.</p>
1662 * <p>Optical zoom will not be supported on most devices.</p>
1663 * <p><b>Units</b>: Millimeters</p>
1664 * <p><b>Range of valid values:</b><br>
1665 * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS android.lens.info.availableFocalLengths}</p>
1666 * <p>This key is available on all devices.</p>
1668 * @see CaptureRequest#LENS_APERTURE
1669 * @see CaptureRequest#LENS_FOCUS_DISTANCE
1670 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FOCAL_LENGTHS
1671 * @see CaptureResult#LENS_STATE
1674 public static final Key<Float> LENS_FOCAL_LENGTH =
1675 new Key<Float>("android.lens.focalLength", float.class);
1678 * <p>Desired distance to plane of sharpest focus,
1679 * measured from frontmost surface of the lens.</p>
1680 * <p>This control can be used for setting manual focus, on devices that support
1681 * the MANUAL_SENSOR capability and have a variable-focus lens (see
1682 * {@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance}).</p>
1683 * <p>A value of <code>0.0f</code> means infinity focus. The value set will be clamped to
1684 * <code>[0.0f, {@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance}]</code>.</p>
1685 * <p>Like {@link CaptureRequest#LENS_FOCAL_LENGTH android.lens.focalLength}, this setting won't be applied
1686 * instantaneously, and it may take several frames before the lens
1687 * can move to the requested focus distance. While the lens is still moving,
1688 * {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p>
1689 * <p>LEGACY devices support at most setting this to <code>0.0f</code>
1690 * for infinity focus.</p>
1691 * <p><b>Units</b>: See {@link CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION android.lens.info.focusDistanceCalibration} for details</p>
1692 * <p><b>Range of valid values:</b><br>
1694 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1695 * <p><b>Full capability</b> -
1696 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
1697 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
1699 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
1700 * @see CaptureRequest#LENS_FOCAL_LENGTH
1701 * @see CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION
1702 * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE
1703 * @see CaptureResult#LENS_STATE
1706 public static final Key<Float> LENS_FOCUS_DISTANCE =
1707 new Key<Float>("android.lens.focusDistance", float.class);
1710 * <p>Sets whether the camera device uses optical image stabilization (OIS)
1711 * when capturing images.</p>
1712 * <p>OIS is used to compensate for motion blur due to small
1713 * movements of the camera during capture. Unlike digital image
1714 * stabilization ({@link CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE android.control.videoStabilizationMode}), OIS
1715 * makes use of mechanical elements to stabilize the camera
1716 * sensor, and thus allows for longer exposure times before
1717 * camera shake becomes apparent.</p>
1718 * <p>Switching between different optical stabilization modes may take several
1719 * frames to initialize, the camera device will report the current mode in
1720 * capture result metadata. For example, When "ON" mode is requested, the
1721 * optical stabilization modes in the first several capture results may still
1722 * be "OFF", and it will become "ON" when the initialization is done.</p>
1723 * <p>If a camera device supports both OIS and digital image stabilization
1724 * ({@link CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE android.control.videoStabilizationMode}), turning both modes on may produce undesirable
1725 * interaction, so it is recommended not to enable both at the same time.</p>
1726 * <p>Not all devices will support OIS; see
1727 * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION android.lens.info.availableOpticalStabilization} for
1728 * available controls.</p>
1729 * <p><b>Possible values:</b>
1731 * <li>{@link #LENS_OPTICAL_STABILIZATION_MODE_OFF OFF}</li>
1732 * <li>{@link #LENS_OPTICAL_STABILIZATION_MODE_ON ON}</li>
1734 * <p><b>Available values for this device:</b><br>
1735 * {@link CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION android.lens.info.availableOpticalStabilization}</p>
1736 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1737 * <p><b>Limited capability</b> -
1738 * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the
1739 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
1741 * @see CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE
1742 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
1743 * @see CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION
1744 * @see #LENS_OPTICAL_STABILIZATION_MODE_OFF
1745 * @see #LENS_OPTICAL_STABILIZATION_MODE_ON
1748 public static final Key<Integer> LENS_OPTICAL_STABILIZATION_MODE =
1749 new Key<Integer>("android.lens.opticalStabilizationMode", int.class);
1752 * <p>Mode of operation for the noise reduction algorithm.</p>
1753 * <p>The noise reduction algorithm attempts to improve image quality by removing
1754 * excessive noise added by the capture process, especially in dark conditions.
1755 * OFF means no noise reduction will be applied by the camera device.</p>
1756 * <p>FAST/HIGH_QUALITY both mean camera device determined noise filtering
1757 * will be applied. HIGH_QUALITY mode indicates that the camera device
1758 * will use the highest-quality noise filtering algorithms,
1759 * even if it slows down capture rate. FAST means the camera device will not
1760 * slow down capture rate when applying noise filtering.</p>
1761 * <p><b>Possible values:</b>
1763 * <li>{@link #NOISE_REDUCTION_MODE_OFF OFF}</li>
1764 * <li>{@link #NOISE_REDUCTION_MODE_FAST FAST}</li>
1765 * <li>{@link #NOISE_REDUCTION_MODE_HIGH_QUALITY HIGH_QUALITY}</li>
1767 * <p><b>Available values for this device:</b><br>
1768 * {@link CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES android.noiseReduction.availableNoiseReductionModes}</p>
1769 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1770 * <p><b>Full capability</b> -
1771 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
1772 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
1774 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
1775 * @see CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES
1776 * @see #NOISE_REDUCTION_MODE_OFF
1777 * @see #NOISE_REDUCTION_MODE_FAST
1778 * @see #NOISE_REDUCTION_MODE_HIGH_QUALITY
1781 public static final Key<Integer> NOISE_REDUCTION_MODE =
1782 new Key<Integer>("android.noiseReduction.mode", int.class);
1785 * <p>An application-specified ID for the current
1786 * request. Must be maintained unchanged in output
1788 * <p><b>Units</b>: arbitrary integer assigned by application</p>
1789 * <p><b>Range of valid values:</b><br>
1791 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1794 public static final Key<Integer> REQUEST_ID =
1795 new Key<Integer>("android.request.id", int.class);
1798 * <p>The desired region of the sensor to read out for this capture.</p>
1799 * <p>This control can be used to implement digital zoom.</p>
1800 * <p>The crop region coordinate system is based off
1801 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}, with <code>(0, 0)</code> being the
1802 * top-left corner of the sensor active array.</p>
1803 * <p>Output streams use this rectangle to produce their output,
1804 * cropping to a smaller region if necessary to maintain the
1805 * stream's aspect ratio, then scaling the sensor input to
1806 * match the output's configured resolution.</p>
1807 * <p>The crop region is applied after the RAW to other color
1808 * space (e.g. YUV) conversion. Since raw streams
1809 * (e.g. RAW16) don't have the conversion stage, they are not
1810 * croppable. The crop region will be ignored by raw streams.</p>
1811 * <p>For non-raw streams, any additional per-stream cropping will
1812 * be done to maximize the final pixel area of the stream.</p>
1813 * <p>For example, if the crop region is set to a 4:3 aspect
1814 * ratio, then 4:3 streams will use the exact crop
1815 * region. 16:9 streams will further crop vertically
1817 * <p>Conversely, if the crop region is set to a 16:9, then 4:3
1818 * outputs will crop horizontally (pillarbox), and 16:9
1819 * streams will match exactly. These additional crops will
1820 * be centered within the crop region.</p>
1821 * <p>The width and height of the crop region cannot
1822 * be set to be smaller than
1823 * <code>floor( activeArraySize.width / {@link CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom} )</code> and
1824 * <code>floor( activeArraySize.height / {@link CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom} )</code>, respectively.</p>
1825 * <p>The camera device may adjust the crop region to account
1826 * for rounding and other hardware requirements; the final
1827 * crop region used will be included in the output capture
1829 * <p><b>Units</b>: Pixel coordinates relative to
1830 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</p>
1831 * <p>This key is available on all devices.</p>
1833 * @see CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM
1834 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE
1837 public static final Key<android.graphics.Rect> SCALER_CROP_REGION =
1838 new Key<android.graphics.Rect>("android.scaler.cropRegion", android.graphics.Rect.class);
1841 * <p>Duration each pixel is exposed to
1843 * <p>If the sensor can't expose this exact duration, it will shorten the
1844 * duration exposed to the nearest possible value (rather than expose longer).
1845 * The final exposure time used will be available in the output capture result.</p>
1846 * <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
1847 * OFF; otherwise the auto-exposure algorithm will override this value.</p>
1848 * <p><b>Units</b>: Nanoseconds</p>
1849 * <p><b>Range of valid values:</b><br>
1850 * {@link CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE android.sensor.info.exposureTimeRange}</p>
1851 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1852 * <p><b>Full capability</b> -
1853 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
1854 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
1856 * @see CaptureRequest#CONTROL_AE_MODE
1857 * @see CaptureRequest#CONTROL_MODE
1858 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
1859 * @see CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE
1862 public static final Key<Long> SENSOR_EXPOSURE_TIME =
1863 new Key<Long>("android.sensor.exposureTime", long.class);
1866 * <p>Duration from start of frame exposure to
1867 * start of next frame exposure.</p>
1868 * <p>The maximum frame rate that can be supported by a camera subsystem is
1869 * a function of many factors:</p>
1871 * <li>Requested resolutions of output image streams</li>
1872 * <li>Availability of binning / skipping modes on the imager</li>
1873 * <li>The bandwidth of the imager interface</li>
1874 * <li>The bandwidth of the various ISP processing blocks</li>
1876 * <p>Since these factors can vary greatly between different ISPs and
1877 * sensors, the camera abstraction tries to represent the bandwidth
1878 * restrictions with as simple a model as possible.</p>
1879 * <p>The model presented has the following characteristics:</p>
1881 * <li>The image sensor is always configured to output the smallest
1882 * resolution possible given the application's requested output stream
1883 * sizes. The smallest resolution is defined as being at least as large
1884 * as the largest requested output stream size; the camera pipeline must
1885 * never digitally upsample sensor data when the crop region covers the
1886 * whole sensor. In general, this means that if only small output stream
1887 * resolutions are configured, the sensor can provide a higher frame
1889 * <li>Since any request may use any or all the currently configured
1890 * output streams, the sensor and ISP must be configured to support
1891 * scaling a single capture to all the streams at the same time. This
1892 * means the camera pipeline must be ready to produce the largest
1893 * requested output size without any delay. Therefore, the overall
1894 * frame rate of a given configured stream set is governed only by the
1895 * largest requested stream resolution.</li>
1896 * <li>Using more than one output stream in a request does not affect the
1897 * frame duration.</li>
1898 * <li>Certain format-streams may need to do additional background processing
1899 * before data is consumed/produced by that stream. These processors
1900 * can run concurrently to the rest of the camera pipeline, but
1901 * cannot process more than 1 capture at a time.</li>
1903 * <p>The necessary information for the application, given the model above,
1904 * is provided via the {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} field
1905 * using StreamConfigurationMap#getOutputMinFrameDuration(int, Size).
1906 * These are used to determine the maximum frame rate / minimum frame
1907 * duration that is possible for a given stream configuration.</p>
1908 * <p>Specifically, the application can use the following rules to
1909 * determine the minimum frame duration it can request from the camera
1912 * <li>Let the set of currently configured input/output streams
1913 * be called <code>S</code>.</li>
1914 * <li>Find the minimum frame durations for each stream in <code>S</code>, by
1915 * looking it up in {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} using
1916 * StreamConfigurationMap#getOutputMinFrameDuration(int, Size) (with
1917 * its respective size/format). Let this set of frame durations be called
1918 * <code>F</code>.</li>
1919 * <li>For any given request <code>R</code>, the minimum frame duration allowed
1920 * for <code>R</code> is the maximum out of all values in <code>F</code>. Let the streams
1921 * used in <code>R</code> be called <code>S_r</code>.</li>
1923 * <p>If none of the streams in <code>S_r</code> have a stall time (listed in
1924 * StreamConfigurationMap#getOutputStallDuration(int,Size) using its
1925 * respective size/format), then the frame duration in
1926 * <code>F</code> determines the steady state frame rate that the application will
1927 * get if it uses <code>R</code> as a repeating request. Let this special kind
1928 * of request be called <code>Rsimple</code>.</p>
1929 * <p>A repeating request <code>Rsimple</code> can be <em>occasionally</em> interleaved
1930 * by a single capture of a new request <code>Rstall</code> (which has at least
1931 * one in-use stream with a non-0 stall time) and if <code>Rstall</code> has the
1932 * same minimum frame duration this will not cause a frame rate loss
1933 * if all buffers from the previous <code>Rstall</code> have already been
1935 * <p>For more details about stalling, see
1936 * StreamConfigurationMap#getOutputStallDuration(int,Size).</p>
1937 * <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
1938 * OFF; otherwise the auto-exposure algorithm will override this value.</p>
1939 * <p><b>Units</b>: Nanoseconds</p>
1940 * <p><b>Range of valid values:</b><br>
1941 * See {@link CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION android.sensor.info.maxFrameDuration},
1942 * {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap}. The duration
1943 * is capped to <code>max(duration, exposureTime + overhead)</code>.</p>
1944 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1945 * <p><b>Full capability</b> -
1946 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
1947 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
1949 * @see CaptureRequest#CONTROL_AE_MODE
1950 * @see CaptureRequest#CONTROL_MODE
1951 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
1952 * @see CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP
1953 * @see CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION
1956 public static final Key<Long> SENSOR_FRAME_DURATION =
1957 new Key<Long>("android.sensor.frameDuration", long.class);
1960 * <p>The amount of gain applied to sensor data
1961 * before processing.</p>
1962 * <p>The sensitivity is the standard ISO sensitivity value,
1963 * as defined in ISO 12232:2006.</p>
1964 * <p>The sensitivity must be within {@link CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE android.sensor.info.sensitivityRange}, and
1965 * if if it less than {@link CameraCharacteristics#SENSOR_MAX_ANALOG_SENSITIVITY android.sensor.maxAnalogSensitivity}, the camera device
1966 * is guaranteed to use only analog amplification for applying the gain.</p>
1967 * <p>If the camera device cannot apply the exact sensitivity
1968 * requested, it will reduce the gain to the nearest supported
1969 * value. The final sensitivity used will be available in the
1970 * output capture result.</p>
1971 * <p><b>Units</b>: ISO arithmetic units</p>
1972 * <p><b>Range of valid values:</b><br>
1973 * {@link CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE android.sensor.info.sensitivityRange}</p>
1974 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1975 * <p><b>Full capability</b> -
1976 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
1977 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
1979 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
1980 * @see CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE
1981 * @see CameraCharacteristics#SENSOR_MAX_ANALOG_SENSITIVITY
1984 public static final Key<Integer> SENSOR_SENSITIVITY =
1985 new Key<Integer>("android.sensor.sensitivity", int.class);
1988 * <p>A pixel <code>[R, G_even, G_odd, B]</code> that supplies the test pattern
1989 * when {@link CaptureRequest#SENSOR_TEST_PATTERN_MODE android.sensor.testPatternMode} is SOLID_COLOR.</p>
1990 * <p>Each color channel is treated as an unsigned 32-bit integer.
1991 * The camera device then uses the most significant X bits
1992 * that correspond to how many bits are in its Bayer raw sensor
1994 * <p>For example, a sensor with RAW10 Bayer output would use the
1995 * 10 most significant bits from each color channel.</p>
1996 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1998 * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE
2001 public static final Key<int[]> SENSOR_TEST_PATTERN_DATA =
2002 new Key<int[]>("android.sensor.testPatternData", int[].class);
2005 * <p>When enabled, the sensor sends a test pattern instead of
2006 * doing a real exposure from the camera.</p>
2007 * <p>When a test pattern is enabled, all manual sensor controls specified
2008 * by android.sensor.* will be ignored. All other controls should
2009 * work as normal.</p>
2010 * <p>For example, if manual flash is enabled, flash firing should still
2011 * occur (and that the test pattern remain unmodified, since the flash
2012 * would not actually affect it).</p>
2013 * <p>Defaults to OFF.</p>
2014 * <p><b>Possible values:</b>
2016 * <li>{@link #SENSOR_TEST_PATTERN_MODE_OFF OFF}</li>
2017 * <li>{@link #SENSOR_TEST_PATTERN_MODE_SOLID_COLOR SOLID_COLOR}</li>
2018 * <li>{@link #SENSOR_TEST_PATTERN_MODE_COLOR_BARS COLOR_BARS}</li>
2019 * <li>{@link #SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY COLOR_BARS_FADE_TO_GRAY}</li>
2020 * <li>{@link #SENSOR_TEST_PATTERN_MODE_PN9 PN9}</li>
2021 * <li>{@link #SENSOR_TEST_PATTERN_MODE_CUSTOM1 CUSTOM1}</li>
2023 * <p><b>Available values for this device:</b><br>
2024 * {@link CameraCharacteristics#SENSOR_AVAILABLE_TEST_PATTERN_MODES android.sensor.availableTestPatternModes}</p>
2025 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2027 * @see CameraCharacteristics#SENSOR_AVAILABLE_TEST_PATTERN_MODES
2028 * @see #SENSOR_TEST_PATTERN_MODE_OFF
2029 * @see #SENSOR_TEST_PATTERN_MODE_SOLID_COLOR
2030 * @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS
2031 * @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY
2032 * @see #SENSOR_TEST_PATTERN_MODE_PN9
2033 * @see #SENSOR_TEST_PATTERN_MODE_CUSTOM1
2036 public static final Key<Integer> SENSOR_TEST_PATTERN_MODE =
2037 new Key<Integer>("android.sensor.testPatternMode", int.class);
2040 * <p>Quality of lens shading correction applied
2041 * to the image data.</p>
2042 * <p>When set to OFF mode, no lens shading correction will be applied by the
2043 * camera device, and an identity lens shading map data will be provided
2044 * if <code>{@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} == ON</code>. For example, for lens
2045 * shading map with size of <code>[ 4, 3 ]</code>,
2046 * the output {@link CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP android.statistics.lensShadingCorrectionMap} for this case will be an identity
2047 * map shown below:</p>
2048 * <pre><code>[ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,
2049 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,
2050 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,
2051 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,
2052 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,
2053 * 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ]
2055 * <p>When set to other modes, lens shading correction will be applied by the camera
2056 * device. Applications can request lens shading map data by setting
2057 * {@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} to ON, and then the camera device will provide lens
2058 * shading map data in {@link CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP android.statistics.lensShadingCorrectionMap}; the returned shading map
2059 * data will be the one applied by the camera device for this capture request.</p>
2060 * <p>The shading map data may depend on the auto-exposure (AE) and AWB statistics, therefore
2061 * the reliability of the map data may be affected by the AE and AWB algorithms. When AE and
2062 * 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>
2063 * OFF), to get best results, it is recommended that the applications wait for the AE and AWB
2064 * to be converged before using the returned shading map data.</p>
2065 * <p><b>Possible values:</b>
2067 * <li>{@link #SHADING_MODE_OFF OFF}</li>
2068 * <li>{@link #SHADING_MODE_FAST FAST}</li>
2069 * <li>{@link #SHADING_MODE_HIGH_QUALITY HIGH_QUALITY}</li>
2071 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2072 * <p><b>Full capability</b> -
2073 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
2074 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
2076 * @see CaptureRequest#CONTROL_AE_MODE
2077 * @see CaptureRequest#CONTROL_AWB_MODE
2078 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
2079 * @see CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP
2080 * @see CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE
2081 * @see #SHADING_MODE_OFF
2082 * @see #SHADING_MODE_FAST
2083 * @see #SHADING_MODE_HIGH_QUALITY
2086 public static final Key<Integer> SHADING_MODE =
2087 new Key<Integer>("android.shading.mode", int.class);
2090 * <p>Operating mode for the face detector
2092 * <p>Whether face detection is enabled, and whether it
2093 * should output just the basic fields or the full set of
2095 * <p><b>Possible values:</b>
2097 * <li>{@link #STATISTICS_FACE_DETECT_MODE_OFF OFF}</li>
2098 * <li>{@link #STATISTICS_FACE_DETECT_MODE_SIMPLE SIMPLE}</li>
2099 * <li>{@link #STATISTICS_FACE_DETECT_MODE_FULL FULL}</li>
2101 * <p><b>Available values for this device:</b><br>
2102 * {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES android.statistics.info.availableFaceDetectModes}</p>
2103 * <p>This key is available on all devices.</p>
2105 * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES
2106 * @see #STATISTICS_FACE_DETECT_MODE_OFF
2107 * @see #STATISTICS_FACE_DETECT_MODE_SIMPLE
2108 * @see #STATISTICS_FACE_DETECT_MODE_FULL
2111 public static final Key<Integer> STATISTICS_FACE_DETECT_MODE =
2112 new Key<Integer>("android.statistics.faceDetectMode", int.class);
2115 * <p>Operating mode for hot pixel map generation.</p>
2116 * <p>If set to <code>true</code>, a hot pixel map is returned in {@link CaptureResult#STATISTICS_HOT_PIXEL_MAP android.statistics.hotPixelMap}.
2117 * If set to <code>false</code>, no hot pixel map will be returned.</p>
2118 * <p><b>Range of valid values:</b><br>
2119 * {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES android.statistics.info.availableHotPixelMapModes}</p>
2120 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2122 * @see CaptureResult#STATISTICS_HOT_PIXEL_MAP
2123 * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES
2126 public static final Key<Boolean> STATISTICS_HOT_PIXEL_MAP_MODE =
2127 new Key<Boolean>("android.statistics.hotPixelMapMode", boolean.class);
2130 * <p>Whether the camera device will output the lens
2131 * shading map in output result metadata.</p>
2132 * <p>When set to ON,
2133 * android.statistics.lensShadingMap will be provided in
2134 * the output result metadata.</p>
2135 * <p>ON is always supported on devices with the RAW capability.</p>
2136 * <p><b>Possible values:</b>
2138 * <li>{@link #STATISTICS_LENS_SHADING_MAP_MODE_OFF OFF}</li>
2139 * <li>{@link #STATISTICS_LENS_SHADING_MAP_MODE_ON ON}</li>
2141 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2142 * <p><b>Full capability</b> -
2143 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
2144 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
2146 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
2147 * @see #STATISTICS_LENS_SHADING_MAP_MODE_OFF
2148 * @see #STATISTICS_LENS_SHADING_MAP_MODE_ON
2151 public static final Key<Integer> STATISTICS_LENS_SHADING_MAP_MODE =
2152 new Key<Integer>("android.statistics.lensShadingMapMode", int.class);
2155 * <p>Tonemapping / contrast / gamma curve for the blue
2156 * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is
2157 * CONTRAST_CURVE.</p>
2158 * <p>See android.tonemap.curveRed for more details.</p>
2159 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2160 * <p><b>Full capability</b> -
2161 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
2162 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
2164 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
2165 * @see CaptureRequest#TONEMAP_MODE
2168 public static final Key<float[]> TONEMAP_CURVE_BLUE =
2169 new Key<float[]>("android.tonemap.curveBlue", float[].class);
2172 * <p>Tonemapping / contrast / gamma curve for the green
2173 * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is
2174 * CONTRAST_CURVE.</p>
2175 * <p>See android.tonemap.curveRed for more details.</p>
2176 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2177 * <p><b>Full capability</b> -
2178 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
2179 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
2181 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
2182 * @see CaptureRequest#TONEMAP_MODE
2185 public static final Key<float[]> TONEMAP_CURVE_GREEN =
2186 new Key<float[]>("android.tonemap.curveGreen", float[].class);
2189 * <p>Tonemapping / contrast / gamma curve for the red
2190 * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is
2191 * CONTRAST_CURVE.</p>
2192 * <p>Each channel's curve is defined by an array of control points:</p>
2193 * <pre><code>android.tonemap.curveRed =
2194 * [ P0in, P0out, P1in, P1out, P2in, P2out, P3in, P3out, ..., PNin, PNout ]
2195 * 2 <= N <= {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</code></pre>
2196 * <p>These are sorted in order of increasing <code>Pin</code>; it is
2197 * required that input values 0.0 and 1.0 are included in the list to
2198 * define a complete mapping. For input values between control points,
2199 * the camera device must linearly interpolate between the control
2201 * <p>Each curve can have an independent number of points, and the number
2202 * of points can be less than max (that is, the request doesn't have to
2203 * always provide a curve with number of points equivalent to
2204 * {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}).</p>
2205 * <p>A few examples, and their corresponding graphical mappings; these
2206 * only specify the red channel and the precision is limited to 4
2207 * digits, for conciseness.</p>
2208 * <p>Linear mapping:</p>
2209 * <pre><code>android.tonemap.curveRed = [ 0, 0, 1.0, 1.0 ]
2211 * <p><img alt="Linear mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png" /></p>
2212 * <p>Invert mapping:</p>
2213 * <pre><code>android.tonemap.curveRed = [ 0, 1.0, 1.0, 0 ]
2215 * <p><img alt="Inverting mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png" /></p>
2216 * <p>Gamma 1/2.2 mapping, with 16 control points:</p>
2217 * <pre><code>android.tonemap.curveRed = [
2218 * 0.0000, 0.0000, 0.0667, 0.2920, 0.1333, 0.4002, 0.2000, 0.4812,
2219 * 0.2667, 0.5484, 0.3333, 0.6069, 0.4000, 0.6594, 0.4667, 0.7072,
2220 * 0.5333, 0.7515, 0.6000, 0.7928, 0.6667, 0.8317, 0.7333, 0.8685,
2221 * 0.8000, 0.9035, 0.8667, 0.9370, 0.9333, 0.9691, 1.0000, 1.0000 ]
2223 * <p><img alt="Gamma = 1/2.2 tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png" /></p>
2224 * <p>Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:</p>
2225 * <pre><code>android.tonemap.curveRed = [
2226 * 0.0000, 0.0000, 0.0667, 0.2864, 0.1333, 0.4007, 0.2000, 0.4845,
2227 * 0.2667, 0.5532, 0.3333, 0.6125, 0.4000, 0.6652, 0.4667, 0.7130,
2228 * 0.5333, 0.7569, 0.6000, 0.7977, 0.6667, 0.8360, 0.7333, 0.8721,
2229 * 0.8000, 0.9063, 0.8667, 0.9389, 0.9333, 0.9701, 1.0000, 1.0000 ]
2231 * <p><img alt="sRGB tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p>
2232 * <p><b>Range of valid values:</b><br>
2233 * 0-1 on both input and output coordinates, normalized
2234 * as a floating-point value such that 0 == black and 1 == white.</p>
2235 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2236 * <p><b>Full capability</b> -
2237 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
2238 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
2240 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
2241 * @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS
2242 * @see CaptureRequest#TONEMAP_MODE
2245 public static final Key<float[]> TONEMAP_CURVE_RED =
2246 new Key<float[]>("android.tonemap.curveRed", float[].class);
2249 * <p>Tonemapping / contrast / gamma curve to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode}
2250 * is CONTRAST_CURVE.</p>
2251 * <p>The tonemapCurve consist of three curves for each of red, green, and blue
2252 * channels respectively. The following example uses the red channel as an
2253 * example. The same logic applies to green and blue channel.
2254 * Each channel's curve is defined by an array of control points:</p>
2255 * <pre><code>curveRed =
2256 * [ P0(in, out), P1(in, out), P2(in, out), P3(in, out), ..., PN(in, out) ]
2257 * 2 <= N <= {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</code></pre>
2258 * <p>These are sorted in order of increasing <code>Pin</code>; it is always
2259 * guaranteed that input values 0.0 and 1.0 are included in the list to
2260 * define a complete mapping. For input values between control points,
2261 * the camera device must linearly interpolate between the control
2263 * <p>Each curve can have an independent number of points, and the number
2264 * of points can be less than max (that is, the request doesn't have to
2265 * always provide a curve with number of points equivalent to
2266 * {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}).</p>
2267 * <p>A few examples, and their corresponding graphical mappings; these
2268 * only specify the red channel and the precision is limited to 4
2269 * digits, for conciseness.</p>
2270 * <p>Linear mapping:</p>
2271 * <pre><code>curveRed = [ (0, 0), (1.0, 1.0) ]
2273 * <p><img alt="Linear mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png" /></p>
2274 * <p>Invert mapping:</p>
2275 * <pre><code>curveRed = [ (0, 1.0), (1.0, 0) ]
2277 * <p><img alt="Inverting mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png" /></p>
2278 * <p>Gamma 1/2.2 mapping, with 16 control points:</p>
2279 * <pre><code>curveRed = [
2280 * (0.0000, 0.0000), (0.0667, 0.2920), (0.1333, 0.4002), (0.2000, 0.4812),
2281 * (0.2667, 0.5484), (0.3333, 0.6069), (0.4000, 0.6594), (0.4667, 0.7072),
2282 * (0.5333, 0.7515), (0.6000, 0.7928), (0.6667, 0.8317), (0.7333, 0.8685),
2283 * (0.8000, 0.9035), (0.8667, 0.9370), (0.9333, 0.9691), (1.0000, 1.0000) ]
2285 * <p><img alt="Gamma = 1/2.2 tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png" /></p>
2286 * <p>Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:</p>
2287 * <pre><code>curveRed = [
2288 * (0.0000, 0.0000), (0.0667, 0.2864), (0.1333, 0.4007), (0.2000, 0.4845),
2289 * (0.2667, 0.5532), (0.3333, 0.6125), (0.4000, 0.6652), (0.4667, 0.7130),
2290 * (0.5333, 0.7569), (0.6000, 0.7977), (0.6667, 0.8360), (0.7333, 0.8721),
2291 * (0.8000, 0.9063), (0.8667, 0.9389), (0.9333, 0.9701), (1.0000, 1.0000) ]
2293 * <p><img alt="sRGB tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p>
2294 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2295 * <p><b>Full capability</b> -
2296 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
2297 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
2299 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
2300 * @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS
2301 * @see CaptureRequest#TONEMAP_MODE
2305 public static final Key<android.hardware.camera2.params.TonemapCurve> TONEMAP_CURVE =
2306 new Key<android.hardware.camera2.params.TonemapCurve>("android.tonemap.curve", android.hardware.camera2.params.TonemapCurve.class);
2309 * <p>High-level global contrast/gamma/tonemapping control.</p>
2310 * <p>When switching to an application-defined contrast curve by setting
2311 * {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} to CONTRAST_CURVE, the curve is defined
2312 * per-channel with a set of <code>(in, out)</code> points that specify the
2313 * mapping from input high-bit-depth pixel value to the output
2314 * low-bit-depth value. Since the actual pixel ranges of both input
2315 * and output may change depending on the camera pipeline, the values
2316 * are specified by normalized floating-point numbers.</p>
2317 * <p>More-complex color mapping operations such as 3D color look-up
2318 * tables, selective chroma enhancement, or other non-linear color
2319 * transforms will be disabled when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is
2320 * CONTRAST_CURVE.</p>
2321 * <p>When using either FAST or HIGH_QUALITY, the camera device will
2322 * emit its own tonemap curve in {@link CaptureRequest#TONEMAP_CURVE android.tonemap.curve}.
2323 * These values are always available, and as close as possible to the
2324 * actually used nonlinear/nonglobal transforms.</p>
2325 * <p>If a request is sent with CONTRAST_CURVE with the camera device's
2326 * provided curve in FAST or HIGH_QUALITY, the image's tonemap will be
2327 * roughly the same.</p>
2328 * <p><b>Possible values:</b>
2330 * <li>{@link #TONEMAP_MODE_CONTRAST_CURVE CONTRAST_CURVE}</li>
2331 * <li>{@link #TONEMAP_MODE_FAST FAST}</li>
2332 * <li>{@link #TONEMAP_MODE_HIGH_QUALITY HIGH_QUALITY}</li>
2334 * <p><b>Available values for this device:</b><br>
2335 * {@link CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES android.tonemap.availableToneMapModes}</p>
2336 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2337 * <p><b>Full capability</b> -
2338 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
2339 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
2341 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
2342 * @see CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES
2343 * @see CaptureRequest#TONEMAP_CURVE
2344 * @see CaptureRequest#TONEMAP_MODE
2345 * @see #TONEMAP_MODE_CONTRAST_CURVE
2346 * @see #TONEMAP_MODE_FAST
2347 * @see #TONEMAP_MODE_HIGH_QUALITY
2350 public static final Key<Integer> TONEMAP_MODE =
2351 new Key<Integer>("android.tonemap.mode", int.class);
2354 * <p>This LED is nominally used to indicate to the user
2355 * that the camera is powered on and may be streaming images back to the
2356 * Application Processor. In certain rare circumstances, the OS may
2357 * disable this when video is processed locally and not transmitted to
2358 * any untrusted applications.</p>
2359 * <p>In particular, the LED <em>must</em> always be on when the data could be
2360 * transmitted off the device. The LED <em>should</em> always be on whenever
2361 * data is stored locally on the device.</p>
2362 * <p>The LED <em>may</em> be off if a trusted application is using the data that
2363 * doesn't violate the above rules.</p>
2364 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2367 public static final Key<Boolean> LED_TRANSMIT =
2368 new Key<Boolean>("android.led.transmit", boolean.class);
2371 * <p>Whether black-level compensation is locked
2372 * to its current values, or is free to vary.</p>
2373 * <p>When set to <code>true</code> (ON), the values used for black-level
2374 * compensation will not change until the lock is set to
2375 * <code>false</code> (OFF).</p>
2376 * <p>Since changes to certain capture parameters (such as
2377 * exposure time) may require resetting of black level
2378 * compensation, the camera device must report whether setting
2379 * the black level lock was successful in the output result
2381 * <p>For example, if a sequence of requests is as follows:</p>
2383 * <li>Request 1: Exposure = 10ms, Black level lock = OFF</li>
2384 * <li>Request 2: Exposure = 10ms, Black level lock = ON</li>
2385 * <li>Request 3: Exposure = 10ms, Black level lock = ON</li>
2386 * <li>Request 4: Exposure = 20ms, Black level lock = ON</li>
2387 * <li>Request 5: Exposure = 20ms, Black level lock = ON</li>
2388 * <li>Request 6: Exposure = 20ms, Black level lock = ON</li>
2390 * <p>And the exposure change in Request 4 requires the camera
2391 * device to reset the black level offsets, then the output
2392 * result metadata is expected to be:</p>
2394 * <li>Result 1: Exposure = 10ms, Black level lock = OFF</li>
2395 * <li>Result 2: Exposure = 10ms, Black level lock = ON</li>
2396 * <li>Result 3: Exposure = 10ms, Black level lock = ON</li>
2397 * <li>Result 4: Exposure = 20ms, Black level lock = OFF</li>
2398 * <li>Result 5: Exposure = 20ms, Black level lock = ON</li>
2399 * <li>Result 6: Exposure = 20ms, Black level lock = ON</li>
2401 * <p>This indicates to the application that on frame 4, black
2402 * levels were reset due to exposure value changes, and pixel
2403 * values may not be consistent across captures.</p>
2404 * <p>The camera device will maintain the lock to the extent
2405 * possible, only overriding the lock to OFF when changes to
2406 * other request parameters require a black level recalculation
2408 * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2409 * <p><b>Full capability</b> -
2410 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
2411 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
2413 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
2416 public static final Key<Boolean> BLACK_LEVEL_LOCK =
2417 new Key<Boolean>("android.blackLevel.lock", boolean.class);
2419 /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~
2420 * End generated code
2421 *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/