CaptureRequest.java revision 72f9f0a96e4476ef231d5001cb30521ad4ce5b1e
1b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala/*
2b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * Copyright (C) 2013 The Android Open Source Project
3b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala *
4b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * Licensed under the Apache License, Version 2.0 (the "License");
5b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * you may not use this file except in compliance with the License.
6b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * You may obtain a copy of the License at
7b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala *
8b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala *      http://www.apache.org/licenses/LICENSE-2.0
9b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala *
10b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * Unless required by applicable law or agreed to in writing, software
11b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * distributed under the License is distributed on an "AS IS" BASIS,
12b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * See the License for the specific language governing permissions and
14b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * limitations under the License.
15b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala */
16b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala
172f1a2e423e0fbb64467d6fcfa4e82c6384f31210Eino-Ville Talvalapackage android.hardware.camera2;
18b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala
1970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvalaimport android.hardware.camera2.impl.CameraMetadataNative;
2070725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkinimport android.os.Parcel;
2170725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkinimport android.os.Parcelable;
2272f9f0a96e4476ef231d5001cb30521ad4ce5b1eIgor Murashkinimport android.util.Rational;
23b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvalaimport android.view.Surface;
24b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala
2570725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkinimport java.util.HashSet;
266bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkinimport java.util.Objects;
27b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala
28b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala
29b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala/**
3070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * <p>An immutable package of settings and outputs needed to capture a single
3170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * image from the camera device.</p>
32b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala *
33b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * <p>Contains the configuration for the capture hardware (sensor, lens, flash),
3470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * the processing pipeline, the control algorithms, and the output buffers. Also
3570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * contains the list of target Surfaces to send image data to for this
3670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * capture.</p>
37b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala *
3870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * <p>CaptureRequests can be created by using a {@link Builder} instance,
3970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * obtained by calling {@link CameraDevice#createCaptureRequest}</p>
40b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala *
41b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * <p>CaptureRequests are given to {@link CameraDevice#capture} or
42b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * {@link CameraDevice#setRepeatingRequest} to capture images from a camera.</p>
43b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala *
44b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * <p>Each request can specify a different subset of target Surfaces for the
45b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * camera to send the captured data to. All the surfaces used in a request must
46b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * be part of the surface list given to the last call to
4770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * {@link CameraDevice#configureOutputs}, when the request is submitted to the
4870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * camera device.</p>
49b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala *
50b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * <p>For example, a request meant for repeating preview might only include the
51b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * Surface for the preview SurfaceView or SurfaceTexture, while a
52b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * high-resolution still capture would also include a Surface from a ImageReader
53b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * configured for high-resolution JPEG images.</p>
54b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala *
55b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * @see CameraDevice#capture
56b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala * @see CameraDevice#setRepeatingRequest
5770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala * @see CameraDevice#createCaptureRequest
58b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala */
5970725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkinpublic final class CaptureRequest extends CameraMetadata implements Parcelable {
6070725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin
6170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala    private final HashSet<Surface> mSurfaceSet;
6270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala    private final CameraMetadataNative mSettings;
6370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala
644068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala    private Object mUserTag;
65b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala
66b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala    /**
676bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin     * Construct empty request.
686bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin     *
696bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin     * Used by Binder to unparcel this object only.
7070725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin     */
716bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin    private CaptureRequest() {
7270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        mSettings = new CameraMetadataNative();
7370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        mSurfaceSet = new HashSet<Surface>();
74b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala    }
75b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala
76b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala    /**
776bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin     * Clone from source capture request.
786bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin     *
796bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin     * Used by the Builder to create an immutable copy.
80b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala     */
816bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin    @SuppressWarnings("unchecked")
8270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala    private CaptureRequest(CaptureRequest source) {
8370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        mSettings = new CameraMetadataNative(source.mSettings);
8470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        mSurfaceSet = (HashSet<Surface>) source.mSurfaceSet.clone();
857b01c5c4d27ebbd739d9e5e0de7eaafbffd8e084Eino-Ville Talvala        mUserTag = source.mUserTag;
86b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala    }
87b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala
88b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala    /**
896bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin     * Take ownership of passed-in settings.
906bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin     *
916bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin     * Used by the Builder to create a mutable CaptureRequest.
92b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala     */
9370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala    private CaptureRequest(CameraMetadataNative settings) {
9470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        mSettings = settings;
9570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        mSurfaceSet = new HashSet<Surface>();
9670725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin    }
9770725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin
986bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin    @SuppressWarnings("unchecked")
9970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala    @Override
10070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala    public <T> T get(Key<T> key) {
10170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        return mSettings.get(key);
1024068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala    }
1034068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala
1044068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala    /**
1054068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala     * Retrieve the tag for this request, if any.
1064068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala     *
1074068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala     * <p>This tag is not used for anything by the camera device, but can be
1084068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala     * used by an application to easily identify a CaptureRequest when it is
1094068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala     * returned by
1104af73c2153747d0624ccc75dfa001cb91982957fEino-Ville Talvala     * {@link CameraDevice.CaptureListener#onCaptureCompleted CaptureListener.onCaptureCompleted}
1114068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala     * </p>
1124068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala     *
1134068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala     * @return the last tag Object set on this request, or {@code null} if
1144068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala     *     no tag has been set.
11570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala     * @see Builder#setTag
1164068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala     */
1174068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala    public Object getTag() {
11870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        return mUserTag;
1194068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala    }
1204068388beea728bbf9f321b0b5b5c52ce4ab3d06Eino-Ville Talvala
1216bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin    /**
1226bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin     * Determine whether this CaptureRequest is equal to another CaptureRequest.
1236bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin     *
1246bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin     * <p>A request is considered equal to another is if it's set of key/values is equal, it's
1256bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin     * list of output surfaces is equal, and the user tag is equal.</p>
1266bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin     *
1276bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin     * @param other Another instance of CaptureRequest.
1286bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin     *
1296bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin     * @return True if the requests are the same, false otherwise.
1306bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin     */
1316bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin    @Override
1326bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin    public boolean equals(Object other) {
1336bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin        return other instanceof CaptureRequest
1346bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin                && equals((CaptureRequest)other);
1356bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin    }
1366bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin
1376bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin    private boolean equals(CaptureRequest other) {
1386bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin        return other != null
1396bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin                && Objects.equals(mUserTag, other.mUserTag)
1406bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin                && mSurfaceSet.equals(other.mSurfaceSet)
1416bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin                && mSettings.equals(other.mSettings);
1426bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin    }
1436bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin
1446bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin    @Override
1456bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin    public int hashCode() {
1466bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin        return mSettings.hashCode();
1476bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin    }
1486bbf9dc5ae7ebc85991dcfe3e18e837b12d3f333Igor Murashkin
14970725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin    public static final Parcelable.Creator<CaptureRequest> CREATOR =
15070725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin            new Parcelable.Creator<CaptureRequest>() {
15170725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin        @Override
15270725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin        public CaptureRequest createFromParcel(Parcel in) {
15370725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin            CaptureRequest request = new CaptureRequest();
15470725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin            request.readFromParcel(in);
15570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala
15670725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin            return request;
15770725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin        }
15870725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin
15970725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin        @Override
16070725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin        public CaptureRequest[] newArray(int size) {
16170725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin            return new CaptureRequest[size];
16270725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin        }
16370725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin    };
16470725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin
16570725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin    /**
16670725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin     * Expand this object from a Parcel.
16770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala     * Hidden since this breaks the immutability of CaptureRequest, but is
16870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala     * needed to receive CaptureRequests with aidl.
16970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala     *
17070725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin     * @param in The parcel from which the object should be read
17170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala     * @hide
17270725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin     */
17372f9f0a96e4476ef231d5001cb30521ad4ce5b1eIgor Murashkin    private void readFromParcel(Parcel in) {
17470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        mSettings.readFromParcel(in);
17570725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin
17670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        mSurfaceSet.clear();
17770725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin
17870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        Parcelable[] parcelableArray = in.readParcelableArray(Surface.class.getClassLoader());
17970725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin
18070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        if (parcelableArray == null) {
18170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala            return;
18270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        }
18370725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin
18470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        for (Parcelable p : parcelableArray) {
18570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala            Surface s = (Surface) p;
18670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala            mSurfaceSet.add(s);
18770725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin        }
18870725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin    }
18970725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin
19070725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin    @Override
19170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala    public int describeContents() {
19270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        return 0;
19370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala    }
19470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala
19570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala    @Override
19670725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin    public void writeToParcel(Parcel dest, int flags) {
19770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        mSettings.writeToParcel(dest, flags);
19870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        dest.writeParcelableArray(mSurfaceSet.toArray(new Surface[mSurfaceSet.size()]), flags);
19970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala    }
20070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala
20170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala    /**
20270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala     * A builder for capture requests.
20370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala     *
20470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala     * <p>To obtain a builder instance, use the
20570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala     * {@link CameraDevice#createCaptureRequest} method, which initializes the
20670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala     * request fields to one of the templates defined in {@link CameraDevice}.
20770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala     *
20870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala     * @see CameraDevice#createCaptureRequest
20970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala     * @see #TEMPLATE_PREVIEW
21070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala     * @see #TEMPLATE_RECORD
21170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala     * @see #TEMPLATE_STILL_CAPTURE
21270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala     * @see #TEMPLATE_VIDEO_SNAPSHOT
21370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala     * @see #TEMPLATE_MANUAL
21470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala     */
21570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala    public final static class Builder {
21670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala
2177a36a0fbb0a5f14047a3680668da954beca05dcbIgor Murashkin        private final CaptureRequest mRequest;
21870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala
21970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        /**
22070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * Initialize the builder using the template; the request takes
22170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * ownership of the template.
22270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         *
22370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * @hide
22470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         */
22570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        public Builder(CameraMetadataNative template) {
22670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala            mRequest = new CaptureRequest(template);
22770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        }
22870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala
22970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        /**
23070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * <p>Add a surface to the list of targets for this request</p>
23170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         *
23270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * <p>The Surface added must be one of the surfaces included in the most
23370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * recent call to {@link CameraDevice#configureOutputs}, when the
23470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * request is given to the camera device.</p>
23570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         *
23670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * <p>Adding a target more than once has no effect.</p>
23770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         *
23870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * @param outputTarget Surface to use as an output target for this request
23970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         */
24070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        public void addTarget(Surface outputTarget) {
24170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala            mRequest.mSurfaceSet.add(outputTarget);
24270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        }
24370725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin
24470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        /**
24570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * <p>Remove a surface from the list of targets for this request.</p>
24670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         *
24770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * <p>Removing a target that is not currently added has no effect.</p>
24870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         *
24970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * @param outputTarget Surface to use as an output target for this request
25070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         */
25170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        public void removeTarget(Surface outputTarget) {
25270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala            mRequest.mSurfaceSet.remove(outputTarget);
25370725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin        }
25470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala
25570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        /**
25670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * Set a capture request field to a value. The field definitions can be
25770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * found in {@link CaptureRequest}.
25870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         *
25970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * @param key The metadata field to write.
26070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * @param value The value to set the field to, which must be of a matching
26170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * type to the key.
26270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         */
26370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        public <T> void set(Key<T> key, T value) {
26470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala            mRequest.mSettings.set(key, value);
26570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        }
26670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala
26770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        /**
26870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * Get a capture request field value. The field definitions can be
26970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * found in {@link CaptureRequest}.
27070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         *
27170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * @throws IllegalArgumentException if the key was not valid
27270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         *
27370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * @param key The metadata field to read.
27470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * @return The value of that key, or {@code null} if the field is not set.
27570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         */
27670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        public <T> T get(Key<T> key) {
27770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala            return mRequest.mSettings.get(key);
27870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        }
27970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala
28070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        /**
28170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * Set a tag for this request.
28270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         *
28370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * <p>This tag is not used for anything by the camera device, but can be
28470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * used by an application to easily identify a CaptureRequest when it is
28570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * returned by
28670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * {@link CameraDevice.CaptureListener#onCaptureCompleted CaptureListener.onCaptureCompleted}
28770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         *
28870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * @param tag an arbitrary Object to store with this request
28970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * @see CaptureRequest#getTag
29070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         */
29170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        public void setTag(Object tag) {
29270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala            mRequest.mUserTag = tag;
29370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        }
29470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala
29570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        /**
29670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * Build a request using the current target Surfaces and settings.
29770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         *
29870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * @return A new capture request instance, ready for submission to the
29970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * camera device.
30070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         */
30170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        public CaptureRequest build() {
30270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala            return new CaptureRequest(mRequest);
30370c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        }
30470c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala
30570c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala
30670c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        /**
30770c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         * @hide
30870c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala         */
30970c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        public boolean isEmpty() {
31070c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala            return mRequest.mSettings.isEmpty();
31170c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala        }
31270c2207c34cf0e6b3b383b1b1500ff5385aa51a6Eino-Ville Talvala
313b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala    }
314b2675542c2f414154125b534767ae0903fba581eEino-Ville Talvala
3155a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /*@O~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~
3165a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * The key entries below this point are generated from metadata
3175a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * definitions in /system/media/camera/docs. Do not modify by hand or
3185a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * modify the comment blocks at the start or end.
3195a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/
3205a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
3210da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala
3225a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
3237d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * <p>The mode control selects how the image data is converted from the
3247d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * sensor's native color into linear sRGB color.</p>
3257d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * <p>When auto-white balance is enabled with {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, this
3267d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * control is overridden by the AWB routine. When AWB is disabled, the
3277d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * application controls how the color mapping is performed.</p>
3287d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * <p>We define the expected processing pipeline below. For consistency
3297d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * across devices, this is always the case with TRANSFORM_MATRIX.</p>
3307d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * <p>When either FULL or HIGH_QUALITY is used, the camera device may
3317d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * do additional processing but {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and
3327d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} will still be provided by the
3337d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * camera device (in the results) and be roughly correct.</p>
3347d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * <p>Switching to TRANSFORM_MATRIX and using the data provided from
3357d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * FAST or HIGH_QUALITY will yield a picture with the same white point
3367d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * as what was produced by the camera device in the earlier frame.</p>
3377d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * <p>The expected processing pipeline is as follows:</p>
3387d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * <p><img alt="White balance processing pipeline" src="../../../../images/camera2/metadata/android.colorCorrection.mode/processing_pipeline.png" /></p>
3397d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * <p>The white balance is encoded by two values, a 4-channel white-balance
3407d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * gain vector (applied in the Bayer domain), and a 3x3 color transform
3417d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * matrix (applied after demosaic).</p>
3427d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * <p>The 4-channel white-balance gains are defined as:</p>
3437d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * <pre><code>{@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} = [ R G_even G_odd B ]
3447d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * </code></pre>
3457d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * <p>where <code>G_even</code> is the gain for green pixels on even rows of the
3467d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * output, and <code>G_odd</code> is the gain for green pixels on the odd rows.
3477d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * These may be identical for a given camera device implementation; if
3487d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * the camera device does not support a separate gain for even/odd green
3497d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * channels, it will use the <code>G_even</code> value, and write <code>G_odd</code> equal to
3507d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * <code>G_even</code> in the output result metadata.</p>
3517d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * <p>The matrices for color transforms are defined as a 9-entry vector:</p>
3527d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * <pre><code>{@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} = [ I0 I1 I2 I3 I4 I5 I6 I7 I8 ]
3537d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * </code></pre>
3547d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * <p>which define a transform from input sensor colors, <code>P_in = [ r g b ]</code>,
3557d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * to output linear sRGB, <code>P_out = [ r' g' b' ]</code>,</p>
3567d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * <p>with colors as follows:</p>
3577d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * <pre><code>r' = I0r + I1g + I2b
3587d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * g' = I3r + I4g + I5b
3597d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * b' = I6r + I7g + I8b
3607d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * </code></pre>
3617d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * <p>Both the input and output value ranges must match. Overflow/underflow
3627d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * values are clipped to fit within the range.</p>
3630da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     *
3647d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * @see CaptureRequest#COLOR_CORRECTION_GAINS
3657d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
3660da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * @see CaptureRequest#CONTROL_AWB_MODE
3675a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #COLOR_CORRECTION_MODE_TRANSFORM_MATRIX
3685a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #COLOR_CORRECTION_MODE_FAST
3695a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #COLOR_CORRECTION_MODE_HIGH_QUALITY
3705a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
3715a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Integer> COLOR_CORRECTION_MODE =
3725a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Integer>("android.colorCorrection.mode", int.class);
3735a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
3745a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
375ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>A color transform matrix to use to transform
376ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * from sensor RGB color space to output linear sRGB color space</p>
37749a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He     * <p>This matrix is either set by the camera device when the request
3780da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not TRANSFORM_MATRIX, or
3795a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * directly by the application in the request when the
3800da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is TRANSFORM_MATRIX.</p>
38149a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He     * <p>In the latter case, the camera device may round the matrix to account
38249a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He     * for precision issues; the final rounded matrix should be reported back
38349a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He     * in this matrix result metadata. The transform should keep the magnitude
38449a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He     * of the output color values within <code>[0, 1.0]</code> (assuming input color
38549a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He     * values is within the normalized range <code>[0, 1.0]</code>), or clipping may occur.</p>
3860da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     *
3870da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * @see CaptureRequest#COLOR_CORRECTION_MODE
3885a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
3895a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Rational[]> COLOR_CORRECTION_TRANSFORM =
3905a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Rational[]>("android.colorCorrection.transform", Rational[].class);
3915a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
3925a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
3937d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * <p>Gains applying to Bayer raw color channels for
394cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * white-balance.</p>
395ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>The 4-channel white-balance gains are defined in
3967d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * the order of <code>[R G_even G_odd B]</code>, where <code>G_even</code> is the gain
3977d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * for green pixels on even rows of the output, and <code>G_odd</code>
3987d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * is the gain for green pixels on the odd rows. if a HAL
3995a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * does not support a separate gain for even/odd green channels,
4007d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * it should use the <code>G_even</code> value, and write <code>G_odd</code> equal to
4017d2a5c5e7350658d0da4eaf75f9380593083e969Igor Murashkin     * <code>G_even</code> in the output result metadata.</p>
402cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * <p>This array is either set by the camera device when the request
4030da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is not TRANSFORM_MATRIX, or
404d5ff06a2ce4a65615ce5e8b8df93f2c3da2a8bbdIgor Murashkin     * directly by the application in the request when the
4050da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} is TRANSFORM_MATRIX.</p>
406cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * <p>The output should be the gains actually applied by the camera device to
407ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * the current frame.</p>
4080da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     *
4090da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * @see CaptureRequest#COLOR_CORRECTION_MODE
4105a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
4115a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<float[]> COLOR_CORRECTION_GAINS =
4125a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<float[]>("android.colorCorrection.gains", float[].class);
4135a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
4145a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
4150da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * <p>The desired setting for the camera device's auto-exposure
4160da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * algorithm's antibanding compensation.</p>
4170da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * <p>Some kinds of lighting fixtures, such as some fluorescent
4180da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * lights, flicker at the rate of the power supply frequency
4190da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * (60Hz or 50Hz, depending on country). While this is
4200da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * typically not noticeable to a person, it can be visible to
4210da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * a camera device. If a camera sets its exposure time to the
4220da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * wrong value, the flicker may become visible in the
4230da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * viewfinder as flicker or in a final captured image, as a
4240da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * set of variable-brightness bands across the image.</p>
4250da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * <p>Therefore, the auto-exposure routines of camera devices
4260da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * include antibanding routines that ensure that the chosen
4270da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * exposure value will not cause such banding. The choice of
4280da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * exposure time depends on the rate of flicker, which the
4290da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * camera device can detect automatically, or the expected
4300da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * rate can be selected by the application using this
4310da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * control.</p>
4320da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * <p>A given camera device may not support all of the possible
4330da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * options for the antibanding mode. The
4340da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES android.control.aeAvailableAntibandingModes} key contains
4350da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * the available modes for a given camera device.</p>
4360da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * <p>The default mode is AUTO, which must be supported by all
4370da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * camera devices.</p>
4380da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * <p>If manual exposure control is enabled (by setting
4390da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link CaptureRequest#CONTROL_MODE android.control.mode} to OFF),
4400da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * then this setting has no effect, and the application must
4410da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * ensure it selects exposure times that do not cause banding
4420da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * issues. The {@link CaptureResult#STATISTICS_SCENE_FLICKER android.statistics.sceneFlicker} key can assist
4430da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * the application in this.</p>
4440da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     *
4455f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He     * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES
446399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He     * @see CaptureRequest#CONTROL_AE_MODE
447265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala     * @see CaptureRequest#CONTROL_MODE
448265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala     * @see CaptureResult#STATISTICS_SCENE_FLICKER
4495a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AE_ANTIBANDING_MODE_OFF
4505a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AE_ANTIBANDING_MODE_50HZ
4515a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AE_ANTIBANDING_MODE_60HZ
4525a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AE_ANTIBANDING_MODE_AUTO
4535a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
4545a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Integer> CONTROL_AE_ANTIBANDING_MODE =
4555a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Integer>("android.control.aeAntibandingMode", int.class);
4565a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
4575a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
458ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Adjustment to AE target image
459ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * brightness</p>
460ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>For example, if EV step is 0.333, '6' will mean an
4615a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * exposure compensation of +2 EV; -3 will mean an exposure
462a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh     * compensation of -1 EV. Note that this control will only be effective
463a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh     * if {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} <code>!=</code> OFF. This control will take effect even when
464a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh     * {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock} <code>== true</code>.</p>
465a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh     * <p>In the event of exposure compensation value being changed, camera device
466a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh     * may take several frames to reach the newly requested exposure target.
467a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh     * During that time, {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} field will be in the SEARCHING
468a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh     * state. Once the new exposure target is reached, {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} will
469a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh     * change from SEARCHING to either CONVERGED, LOCKED (if AE lock is enabled), or
470a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh     * FLASH_REQUIRED (if the scene is too dark for still capture).</p>
471a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh     *
472a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh     * @see CaptureRequest#CONTROL_AE_LOCK
473a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh     * @see CaptureRequest#CONTROL_AE_MODE
474a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh     * @see CaptureResult#CONTROL_AE_STATE
4755a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
4765a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Integer> CONTROL_AE_EXPOSURE_COMPENSATION =
4775a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Integer>("android.control.aeExposureCompensation", int.class);
4785a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
4795a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
480ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Whether AE is currently locked to its latest
48149a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He     * calculated values.</p>
482ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Note that even when AE is locked, the flash may be
48349a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He     * fired if the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_AUTO_FLASH / ON_ALWAYS_FLASH /
484ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * ON_AUTO_FLASH_REDEYE.</p>
485a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh     * <p>When {@link CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION android.control.aeExposureCompensation} is changed, even if the AE lock
486a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh     * is ON, the camera device will still adjust its exposure value.</p>
48749a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He     * <p>If AE precapture is triggered (see {@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger})
48849a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He     * when AE is already locked, the camera device will not change the exposure time
48949a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He     * ({@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}) and sensitivity ({@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity})
490d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala     * parameters. The flash may be fired if the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode}
49149a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He     * is ON_AUTO_FLASH/ON_AUTO_FLASH_REDEYE and the scene is too dark. If the
49249a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He     * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is ON_ALWAYS_FLASH, the scene may become overexposed.</p>
49349a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He     * <p>See {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE lock related state transition details.</p>
49449a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He     *
495a4227dfe48dcfb49709e05f7db413e0d883997f0Yin-Chia Yeh     * @see CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION
49649a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He     * @see CaptureRequest#CONTROL_AE_MODE
49749a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He     * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
49849a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He     * @see CaptureResult#CONTROL_AE_STATE
49949a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He     * @see CaptureRequest#SENSOR_EXPOSURE_TIME
50049a3ca9330d213fe35280c0af78a4d21acb98234Zhijun He     * @see CaptureRequest#SENSOR_SENSITIVITY
5015a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
5025a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Boolean> CONTROL_AE_LOCK =
5035a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Boolean>("android.control.aeLock", boolean.class);
5045a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
5055a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
5060da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * <p>The desired mode for the camera device's
5070da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * auto-exposure routine.</p>
5080da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is
5090da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * AUTO.</p>
5100da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * <p>When set to any of the ON modes, the camera device's
5110da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * auto-exposure routine is enabled, overriding the
5120da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * application's selected exposure time, sensor sensitivity,
5130da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * and frame duration ({@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime},
5140da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and
5150da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}). If one of the FLASH modes
5160da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * is selected, the camera device's flash unit controls are
5170da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * also overridden.</p>
5180da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * <p>The FLASH modes are only available if the camera device
5190da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * has a flash unit ({@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} is <code>true</code>).</p>
5200da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * <p>If flash TORCH mode is desired, this field must be set to
5210da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * ON or OFF, and {@link CaptureRequest#FLASH_MODE android.flash.mode} set to TORCH.</p>
5220da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * <p>When set to any of the ON modes, the values chosen by the
5230da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * camera device auto-exposure routine for the overridden
5240da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * fields for a given capture will be available in its
5250da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * CaptureResult.</p>
5260da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     *
5275f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He     * @see CaptureRequest#CONTROL_MODE
528265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala     * @see CameraCharacteristics#FLASH_INFO_AVAILABLE
529265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala     * @see CaptureRequest#FLASH_MODE
530aef3b7ed9f2a27aed9aecef030432d1100a60406Igor Murashkin     * @see CaptureRequest#SENSOR_EXPOSURE_TIME
531aef3b7ed9f2a27aed9aecef030432d1100a60406Igor Murashkin     * @see CaptureRequest#SENSOR_FRAME_DURATION
532399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He     * @see CaptureRequest#SENSOR_SENSITIVITY
5335a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AE_MODE_OFF
5345a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AE_MODE_ON
5355a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AE_MODE_ON_AUTO_FLASH
5365a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AE_MODE_ON_ALWAYS_FLASH
5375a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE
5385a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
5395a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Integer> CONTROL_AE_MODE =
5405a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Integer>("android.control.aeMode", int.class);
5415a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
5425a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
543ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>List of areas to use for
544f59521d3b182de217b12e6d4ea31bd32e2418564Ruben Brunk     * metering.</p>
545ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Each area is a rectangle plus weight: xmin, ymin,
546f59521d3b182de217b12e6d4ea31bd32e2418564Ruben Brunk     * xmax, ymax, weight. The rectangle is defined to be inclusive of the
547ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * specified coordinates.</p>
548ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>The coordinate system is based on the active pixel array,
5492629f27362f1a35521501f3a28279ab05b9beb32Timothy Knight     * with (0,0) being the top-left pixel in the active pixel array, and
5500da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1,
5510da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the
5522629f27362f1a35521501f3a28279ab05b9beb32Timothy Knight     * bottom-right pixel in the active pixel array. The weight
553ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * should be nonnegative.</p>
554ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>If all regions have 0 weight, then no specific metering area
555cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * needs to be used by the camera device. If the metering region is
556cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the camera device
557cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * will ignore the sections outside the region and output the
558f59521d3b182de217b12e6d4ea31bd32e2418564Ruben Brunk     * used sections in the frame metadata.</p>
5590da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     *
5600da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * @see CaptureRequest#SCALER_CROP_REGION
561265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala     * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE
5625a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
5635a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<int[]> CONTROL_AE_REGIONS =
5645a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<int[]>("android.control.aeRegions", int[].class);
5655a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
5665a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
567ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Range over which fps can be adjusted to
568ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * maintain exposure</p>
569ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Only constrains AE algorithm, not manual control
5700da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * of {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}</p>
5710da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     *
5720da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * @see CaptureRequest#SENSOR_EXPOSURE_TIME
5735a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
5745a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<int[]> CONTROL_AE_TARGET_FPS_RANGE =
5755a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<int[]>("android.control.aeTargetFpsRange", int[].class);
5765a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
5775a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
578228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He     * <p>Whether the camera device will trigger a precapture
579228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He     * metering sequence when it processes this request.</p>
580ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>This entry is normally set to IDLE, or is not
5815a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * included at all in the request settings. When included and
582228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He     * set to START, the camera device will trigger the autoexposure
583ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * precapture metering sequence.</p>
584ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>The effect of AE precapture trigger depends on the current
585228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He     * AE mode and state; see {@link CaptureResult#CONTROL_AE_STATE android.control.aeState} for AE precapture
586228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He     * state transition details.</p>
587228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He     *
588228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He     * @see CaptureResult#CONTROL_AE_STATE
5895a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AE_PRECAPTURE_TRIGGER_IDLE
5905a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AE_PRECAPTURE_TRIGGER_START
5915a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
5925a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Integer> CONTROL_AE_PRECAPTURE_TRIGGER =
5935a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Integer>("android.control.aePrecaptureTrigger", int.class);
5945a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
5955a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
596ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Whether AF is currently enabled, and what
597ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * mode it is set to</p>
598cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * <p>Only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} = AUTO and the lens is not fixed focus
599cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * (i.e. <code>{@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} &gt; 0</code>).</p>
60078146ecb24871302a4c4dc0a7341044a06d29ee8Zhijun He     * <p>If the lens is controlled by the camera device auto-focus algorithm,
601d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala     * the camera device will report the current AF status in {@link CaptureResult#CONTROL_AF_STATE android.control.afState}
60278146ecb24871302a4c4dc0a7341044a06d29ee8Zhijun He     * in result metadata.</p>
6030da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     *
604d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala     * @see CaptureResult#CONTROL_AF_STATE
6050da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * @see CaptureRequest#CONTROL_MODE
606cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE
6075a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AF_MODE_OFF
6085a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AF_MODE_AUTO
6095a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AF_MODE_MACRO
6105a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AF_MODE_CONTINUOUS_VIDEO
6115a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AF_MODE_CONTINUOUS_PICTURE
6125a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AF_MODE_EDOF
6135a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
6145a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Integer> CONTROL_AF_MODE =
6155a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Integer>("android.control.afMode", int.class);
6165a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
6175a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
618ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>List of areas to use for focus
619f59521d3b182de217b12e6d4ea31bd32e2418564Ruben Brunk     * estimation.</p>
620ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Each area is a rectangle plus weight: xmin, ymin,
621f59521d3b182de217b12e6d4ea31bd32e2418564Ruben Brunk     * xmax, ymax, weight. The rectangle is defined to be inclusive of the
622ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * specified coordinates.</p>
623ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>The coordinate system is based on the active pixel array,
6242629f27362f1a35521501f3a28279ab05b9beb32Timothy Knight     * with (0,0) being the top-left pixel in the active pixel array, and
6250da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1,
6260da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the
6272629f27362f1a35521501f3a28279ab05b9beb32Timothy Knight     * bottom-right pixel in the active pixel array. The weight
628ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * should be nonnegative.</p>
629ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>If all regions have 0 weight, then no specific focus area
630cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * needs to be used by the camera device. If the focusing region is
631cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the camera device
632cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * will ignore the sections outside the region and output the
633f59521d3b182de217b12e6d4ea31bd32e2418564Ruben Brunk     * used sections in the frame metadata.</p>
6340da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     *
6350da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * @see CaptureRequest#SCALER_CROP_REGION
636265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala     * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE
6375a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
6385a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<int[]> CONTROL_AF_REGIONS =
6395a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<int[]>("android.control.afRegions", int[].class);
6405a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
6415a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
642228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He     * <p>Whether the camera device will trigger autofocus for this request.</p>
643ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>This entry is normally set to IDLE, or is not
644ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * included at all in the request settings.</p>
645228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He     * <p>When included and set to START, the camera device will trigger the
646228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He     * autofocus algorithm. If autofocus is disabled, this trigger has no effect.</p>
647228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He     * <p>When set to CANCEL, the camera device will cancel any active trigger,
648228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He     * and return to its initial AF state.</p>
649228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He     * <p>See {@link CaptureResult#CONTROL_AF_STATE android.control.afState} for what that means for each AF mode.</p>
650228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He     *
651228f4f92e70d9326d473e02bcdcc8faf9e706a4dZhijun He     * @see CaptureResult#CONTROL_AF_STATE
6525a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AF_TRIGGER_IDLE
6535a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AF_TRIGGER_START
6545a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AF_TRIGGER_CANCEL
6555a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
6565a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Integer> CONTROL_AF_TRIGGER =
6575a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Integer>("android.control.afTrigger", int.class);
6585a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
6595a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
660ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Whether AWB is currently locked to its
6612d5e89778e955b4ff209a93e738761356349d48cZhijun He     * latest calculated values.</p>
662ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Note that AWB lock is only meaningful for AUTO
6635a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * mode; in other modes, AWB is already fixed to a specific
6642d5e89778e955b4ff209a93e738761356349d48cZhijun He     * setting.</p>
6655a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
6665a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Boolean> CONTROL_AWB_LOCK =
6675a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Boolean>("android.control.awbLock", boolean.class);
6685a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
6695a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
670ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Whether AWB is currently setting the color
6715a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * transform fields, and what its illumination target
672cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * is.</p>
673399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He     * <p>This control is only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} is AUTO.</p>
674399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He     * <p>When set to the ON mode, the camera device's auto white balance
675399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He     * routine is enabled, overriding the application's selected
676399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He     * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} and
677399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He     * {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.</p>
678399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He     * <p>When set to the OFF mode, the camera device's auto white balance
679cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * routine is disabled. The application manually controls the white
680d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala     * balance by {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}, {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains}
681399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He     * and {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode}.</p>
682399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He     * <p>When set to any other modes, the camera device's auto white balance
683399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He     * routine is disabled. The camera device uses each particular illumination
684399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He     * target for white balance adjustment.</p>
6850da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     *
686265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala     * @see CaptureRequest#COLOR_CORRECTION_GAINS
6875f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He     * @see CaptureRequest#COLOR_CORRECTION_MODE
6885f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He     * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
689265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala     * @see CaptureRequest#CONTROL_MODE
6905a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AWB_MODE_OFF
6915a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AWB_MODE_AUTO
6925a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AWB_MODE_INCANDESCENT
6935a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AWB_MODE_FLUORESCENT
6945a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AWB_MODE_WARM_FLUORESCENT
6955a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AWB_MODE_DAYLIGHT
6965a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AWB_MODE_CLOUDY_DAYLIGHT
6975a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AWB_MODE_TWILIGHT
6985a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_AWB_MODE_SHADE
6995a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
7005a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Integer> CONTROL_AWB_MODE =
7015a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Integer>("android.control.awbMode", int.class);
7025a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
7035a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
704ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>List of areas to use for illuminant
705f59521d3b182de217b12e6d4ea31bd32e2418564Ruben Brunk     * estimation.</p>
706ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Only used in AUTO mode.</p>
707ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Each area is a rectangle plus weight: xmin, ymin,
708f59521d3b182de217b12e6d4ea31bd32e2418564Ruben Brunk     * xmax, ymax, weight. The rectangle is defined to be inclusive of the
709ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * specified coordinates.</p>
710ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>The coordinate system is based on the active pixel array,
7112629f27362f1a35521501f3a28279ab05b9beb32Timothy Knight     * with (0,0) being the top-left pixel in the active pixel array, and
7120da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.width - 1,
7130da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.height - 1) being the
7142629f27362f1a35521501f3a28279ab05b9beb32Timothy Knight     * bottom-right pixel in the active pixel array. The weight
715ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * should be nonnegative.</p>
716cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * <p>If all regions have 0 weight, then no specific auto-white balance (AWB) area
717cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * needs to be used by the camera device. If the AWB region is
718cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * outside the current {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}, the camera device
719cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * will ignore the sections outside the region and output the
720f59521d3b182de217b12e6d4ea31bd32e2418564Ruben Brunk     * used sections in the frame metadata.</p>
7210da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     *
7220da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * @see CaptureRequest#SCALER_CROP_REGION
723265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala     * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE
7245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
7255a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<int[]> CONTROL_AWB_REGIONS =
7265a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<int[]>("android.control.awbRegions", int[].class);
7275a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
7285a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
72966d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He     * <p>Information to the camera device 3A (auto-exposure,
73066d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He     * auto-focus, auto-white balance) routines about the purpose
73166d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He     * of this capture, to help the camera device to decide optimal 3A
73266d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He     * strategy.</p>
733e30adb762ad17fc49fd3f7c1aa9ba6bd24bc43a0Zhijun He     * <p>This control (except for MANUAL) is only effective if
734e30adb762ad17fc49fd3f7c1aa9ba6bd24bc43a0Zhijun He     * <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} != OFF</code> and any 3A routine is active.</p>
735e30adb762ad17fc49fd3f7c1aa9ba6bd24bc43a0Zhijun He     * <p>ZERO_SHUTTER_LAG must be supported if {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities}
736e30adb762ad17fc49fd3f7c1aa9ba6bd24bc43a0Zhijun He     * contains ZSL. MANUAL must be supported if {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities}
737e30adb762ad17fc49fd3f7c1aa9ba6bd24bc43a0Zhijun He     * contains MANUAL_SENSOR.</p>
7380da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     *
7390da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * @see CaptureRequest#CONTROL_MODE
740e30adb762ad17fc49fd3f7c1aa9ba6bd24bc43a0Zhijun He     * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
7415a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_CAPTURE_INTENT_CUSTOM
7425a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_CAPTURE_INTENT_PREVIEW
7435a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_CAPTURE_INTENT_STILL_CAPTURE
7445a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_CAPTURE_INTENT_VIDEO_RECORD
7455a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT
7465a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG
747e30adb762ad17fc49fd3f7c1aa9ba6bd24bc43a0Zhijun He     * @see #CONTROL_CAPTURE_INTENT_MANUAL
7485a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
7495a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Integer> CONTROL_CAPTURE_INTENT =
7505a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Integer>("android.control.captureIntent", int.class);
7515a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
7525a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
7535f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk     * <p>A special color effect to apply.</p>
7545f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk     * <p>When this mode is set, a color effect will be applied
7555f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk     * to images produced by the camera device. The interpretation
7565f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk     * and implementation of these color effects is left to the
7575f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk     * implementor of the camera device, and should not be
7585f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk     * depended on to be consistent (or present) across all
7595f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk     * devices.</p>
7605f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk     * <p>A color effect will only be applied if
7615f1dcfe49dfe7b9a4a40482152638af6ca925a6dRuben Brunk     * {@link CaptureRequest#CONTROL_MODE android.control.mode} != OFF.</p>
7620da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     *
7630da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * @see CaptureRequest#CONTROL_MODE
7645a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_EFFECT_MODE_OFF
7655a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_EFFECT_MODE_MONO
7665a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_EFFECT_MODE_NEGATIVE
7675a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_EFFECT_MODE_SOLARIZE
7685a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_EFFECT_MODE_SEPIA
7695a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_EFFECT_MODE_POSTERIZE
7705a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_EFFECT_MODE_WHITEBOARD
7715a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_EFFECT_MODE_BLACKBOARD
7725a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_EFFECT_MODE_AQUA
7735a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
7745a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Integer> CONTROL_EFFECT_MODE =
7755a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Integer>("android.control.effectMode", int.class);
7765a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
7775a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
778ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Overall mode of 3A control
779cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * routines.</p>
780f353742124af698098884b4172644af0851b30caZhijun He     * <p>High-level 3A control. When set to OFF, all 3A control
7815f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He     * by the camera device is disabled. The application must set the fields for
782f353742124af698098884b4172644af0851b30caZhijun He     * capture parameters itself.</p>
783f353742124af698098884b4172644af0851b30caZhijun He     * <p>When set to AUTO, the individual algorithm controls in
7840da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * android.control.* are in effect, such as {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}.</p>
785f353742124af698098884b4172644af0851b30caZhijun He     * <p>When set to USE_SCENE_MODE, the individual controls in
7865f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He     * android.control.* are mostly disabled, and the camera device implements
787f353742124af698098884b4172644af0851b30caZhijun He     * one of the scene mode settings (such as ACTION, SUNSET, or PARTY)
7885f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He     * as it wishes. The camera device scene mode 3A settings are provided by
789f353742124af698098884b4172644af0851b30caZhijun He     * android.control.sceneModeOverrides.</p>
7902d5e89778e955b4ff209a93e738761356349d48cZhijun He     * <p>When set to OFF_KEEP_STATE, it is similar to OFF mode, the only difference
7912d5e89778e955b4ff209a93e738761356349d48cZhijun He     * is that this frame will not be used by camera device background 3A statistics
7922d5e89778e955b4ff209a93e738761356349d48cZhijun He     * update, as if this frame is never captured. This mode can be used in the scenario
7932d5e89778e955b4ff209a93e738761356349d48cZhijun He     * where the application doesn't want a 3A manual control capture to affect
7942d5e89778e955b4ff209a93e738761356349d48cZhijun He     * the subsequent auto 3A capture results.</p>
7950da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     *
7960da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * @see CaptureRequest#CONTROL_AF_MODE
7975a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_MODE_OFF
7985a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_MODE_AUTO
7995a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_MODE_USE_SCENE_MODE
8002d5e89778e955b4ff209a93e738761356349d48cZhijun He     * @see #CONTROL_MODE_OFF_KEEP_STATE
8015a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
8025a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Integer> CONTROL_MODE =
8035a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Integer>("android.control.mode", int.class);
8045a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
8055a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
806e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk     * <p>A camera mode optimized for conditions typical in a particular
807e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk     * capture setting.</p>
808e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk     * <p>This is the mode that that is active when
809e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk     * <code>{@link CaptureRequest#CONTROL_MODE android.control.mode} == USE_SCENE_MODE</code>. Aside from FACE_PRIORITY,
810e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk     * these modes will disable {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode},
811e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk     * {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, and {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} while in use.</p>
812e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk     * <p>The interpretation and implementation of these scene modes is left
813e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk     * to the implementor of the camera device. Their behavior will not be
814e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk     * consistent across all devices, and any given device may only implement
815e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk     * a subset of these modes.</p>
8160da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     *
817e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk     * @see CaptureRequest#CONTROL_AE_MODE
818e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk     * @see CaptureRequest#CONTROL_AF_MODE
819e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk     * @see CaptureRequest#CONTROL_AWB_MODE
8200da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * @see CaptureRequest#CONTROL_MODE
821e6679366938fd3ed197ba1ff1b2ad0bf2ff4246bRuben Brunk     * @see #CONTROL_SCENE_MODE_DISABLED
8225a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_SCENE_MODE_FACE_PRIORITY
8235a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_SCENE_MODE_ACTION
8245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_SCENE_MODE_PORTRAIT
8255a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_SCENE_MODE_LANDSCAPE
8265a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_SCENE_MODE_NIGHT
8275a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_SCENE_MODE_NIGHT_PORTRAIT
8285a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_SCENE_MODE_THEATRE
8295a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_SCENE_MODE_BEACH
8305a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_SCENE_MODE_SNOW
8315a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_SCENE_MODE_SUNSET
8325a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_SCENE_MODE_STEADYPHOTO
8335a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_SCENE_MODE_FIREWORKS
8345a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_SCENE_MODE_SPORTS
8355a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_SCENE_MODE_PARTY
8365a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_SCENE_MODE_CANDLELIGHT
8375a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #CONTROL_SCENE_MODE_BARCODE
8385a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
8395a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Integer> CONTROL_SCENE_MODE =
8405a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Integer>("android.control.sceneMode", int.class);
8415a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
8425a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
843ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Whether video stabilization is
844ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * active</p>
845ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>If enabled, video stabilization can modify the
8460da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion} to keep the video stream
847ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * stabilized</p>
8480da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     *
8490da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * @see CaptureRequest#SCALER_CROP_REGION
8504793af5e3577c51858719a8977d300c3aafdf881Zhijun He     * @see #CONTROL_VIDEO_STABILIZATION_MODE_OFF
8514793af5e3577c51858719a8977d300c3aafdf881Zhijun He     * @see #CONTROL_VIDEO_STABILIZATION_MODE_ON
8525a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
8534793af5e3577c51858719a8977d300c3aafdf881Zhijun He    public static final Key<Integer> CONTROL_VIDEO_STABILIZATION_MODE =
8544793af5e3577c51858719a8977d300c3aafdf881Zhijun He            new Key<Integer>("android.control.videoStabilizationMode", int.class);
8555a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
8565a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
857ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Operation mode for edge
858cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * enhancement.</p>
8592807936f5dfdeff25e9ace3482100511a69dcf13Zhijun He     * <p>Edge/sharpness/detail enhancement. OFF means no
860cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * enhancement will be applied by the camera device.</p>
8616dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk     * <p>This must be set to one of the modes listed in {@link CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES android.edge.availableEdgeModes}.</p>
8625f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He     * <p>FAST/HIGH_QUALITY both mean camera device determined enhancement
8632807936f5dfdeff25e9ace3482100511a69dcf13Zhijun He     * will be applied. HIGH_QUALITY mode indicates that the
8645f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He     * camera device will use the highest-quality enhancement algorithms,
8655f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He     * even if it slows down capture rate. FAST means the camera device will
8662807936f5dfdeff25e9ace3482100511a69dcf13Zhijun He     * not slow down capture rate when applying edge enhancement.</p>
8676dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk     *
8686dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk     * @see CameraCharacteristics#EDGE_AVAILABLE_EDGE_MODES
8695a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #EDGE_MODE_OFF
8705a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #EDGE_MODE_FAST
8715a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #EDGE_MODE_HIGH_QUALITY
8725a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
8735a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Integer> EDGE_MODE =
8745a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Integer>("android.edge.mode", int.class);
8755a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
8765a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
87766d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He     * <p>The desired mode for for the camera device's flash control.</p>
87866d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He     * <p>This control is only effective when flash unit is available
879153ac102d36df66853b523ab01763dc457972517Zhijun He     * (<code>{@link CameraCharacteristics#FLASH_INFO_AVAILABLE android.flash.info.available} == true</code>).</p>
88066d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He     * <p>When this control is used, the {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} must be set to ON or OFF.
88166d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He     * Otherwise, the camera device auto-exposure related flash control (ON_AUTO_FLASH,
88266d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He     * ON_ALWAYS_FLASH, or ON_AUTO_FLASH_REDEYE) will override this control.</p>
88366d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He     * <p>When set to OFF, the camera device will not fire flash for this capture.</p>
88466d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He     * <p>When set to SINGLE, the camera device will fire flash regardless of the camera
88566d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He     * device's auto-exposure routine's result. When used in still capture case, this
88666d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He     * control should be used along with AE precapture metering sequence
88766d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He     * ({@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}), otherwise, the image may be incorrectly exposed.</p>
88866d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He     * <p>When set to TORCH, the flash will be on continuously. This mode can be used
88966d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He     * for use cases such as preview, auto-focus assist, still capture, or video recording.</p>
890ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He     * <p>The flash status will be reported by {@link CaptureResult#FLASH_STATE android.flash.state} in the capture result metadata.</p>
89166d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He     *
89266d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He     * @see CaptureRequest#CONTROL_AE_MODE
89366d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He     * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
89466d065a6d48cafe390c697c77b44ba5196ee0870Zhijun He     * @see CameraCharacteristics#FLASH_INFO_AVAILABLE
895ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He     * @see CaptureResult#FLASH_STATE
8965a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #FLASH_MODE_OFF
8975a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #FLASH_MODE_SINGLE
8985a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #FLASH_MODE_TORCH
8995a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
9005a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Integer> FLASH_MODE =
9015a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Integer>("android.flash.mode", int.class);
9025a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
9035a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
904eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk     * <p>Set operational mode for hot pixel correction.</p>
9059d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk     * <p>Valid modes for this camera device are listed in
9069d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk     * {@link CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES android.hotPixel.availableHotPixelModes}.</p>
907eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk     * <p>Hotpixel correction interpolates out, or otherwise removes, pixels
908eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk     * that do not accurately encode the incoming light (i.e. pixels that
909eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk     * are stuck at an arbitrary value).</p>
9109d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk     *
9119d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk     * @see CameraCharacteristics#HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES
912eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk     * @see #HOT_PIXEL_MODE_OFF
913eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk     * @see #HOT_PIXEL_MODE_FAST
914eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk     * @see #HOT_PIXEL_MODE_HIGH_QUALITY
915eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk     */
916eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk    public static final Key<Integer> HOT_PIXEL_MODE =
917eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk            new Key<Integer>("android.hotPixel.mode", int.class);
918eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk
919eba1b3a843278a92611edf153faa41a01d793b25Ruben Brunk    /**
920ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>GPS coordinates to include in output JPEG
921ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * EXIF</p>
9225a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
9235a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<double[]> JPEG_GPS_COORDINATES =
9245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<double[]>("android.jpeg.gpsCoordinates", double[].class);
9255a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
9265a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
927ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>32 characters describing GPS algorithm to
928ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * include in EXIF</p>
9295a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
9305a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<String> JPEG_GPS_PROCESSING_METHOD =
9315a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<String>("android.jpeg.gpsProcessingMethod", String.class);
9325a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
9335a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
934ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Time GPS fix was made to include in
935ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * EXIF</p>
9365a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
9375a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Long> JPEG_GPS_TIMESTAMP =
9385a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Long>("android.jpeg.gpsTimestamp", long.class);
9395a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
9405a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
941ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Orientation of JPEG image to
942ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * write</p>
9435a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
9445a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Integer> JPEG_ORIENTATION =
9455a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Integer>("android.jpeg.orientation", int.class);
9465a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
9475a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
948ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Compression quality of the final JPEG
949ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * image</p>
950ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>85-95 is typical usage range</p>
9515a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
9525a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Byte> JPEG_QUALITY =
9535a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Byte>("android.jpeg.quality", byte.class);
9545a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
9555a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
956ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Compression quality of JPEG
957ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * thumbnail</p>
9585a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
9595a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Byte> JPEG_THUMBNAIL_QUALITY =
9605a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Byte>("android.jpeg.thumbnailQuality", byte.class);
9615a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
9625a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
9635a9ff379233025bc85ebc41ac5979def09d3ebfaZhijun He     * <p>Resolution of embedded JPEG thumbnail</p>
9645f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He     * <p>When set to (0, 0) value, the JPEG EXIF will not contain thumbnail,
9655f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He     * but the captured JPEG will still be a valid image.</p>
9665a9ff379233025bc85ebc41ac5979def09d3ebfaZhijun He     * <p>When a jpeg image capture is issued, the thumbnail size selected should have
9675a9ff379233025bc85ebc41ac5979def09d3ebfaZhijun He     * the same aspect ratio as the jpeg image.</p>
9685a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
96972f9f0a96e4476ef231d5001cb30521ad4ce5b1eIgor Murashkin    public static final Key<android.util.Size> JPEG_THUMBNAIL_SIZE =
97072f9f0a96e4476ef231d5001cb30521ad4ce5b1eIgor Murashkin            new Key<android.util.Size>("android.jpeg.thumbnailSize", android.util.Size.class);
9715a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
9725a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
973fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He     * <p>The ratio of lens focal length to the effective
974fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He     * aperture diameter.</p>
975fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He     * <p>This will only be supported on the camera devices that
976fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He     * have variable aperture lens. The aperture value can only be
977fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He     * one of the values listed in {@link CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES android.lens.info.availableApertures}.</p>
978fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He     * <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is OFF,
979fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He     * this can be set along with {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime},
980d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala     * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}
981fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He     * to achieve manual exposure control.</p>
982fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He     * <p>The requested aperture value may take several frames to reach the
983fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He     * requested value; the camera device will report the current (intermediate)
984ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He     * aperture size in capture result metadata while the aperture is changing.
985ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He     * While the aperture is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p>
986fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He     * <p>When this is supported and {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is one of
987fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He     * the ON modes, this will be overridden by the camera device
988fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He     * auto-exposure algorithm, the overridden values are then provided
989fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He     * back to the user in the corresponding result.</p>
990fb46c644ceffdd476268c35c7992c4e445bde0a5Zhijun He     *
991399f05d1e7182ef6c88d30d3b98a467b845ca7c4Zhijun He     * @see CaptureRequest#CONTROL_AE_MODE
992265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala     * @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES
993ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He     * @see CaptureResult#LENS_STATE
994265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala     * @see CaptureRequest#SENSOR_EXPOSURE_TIME
995d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala     * @see CaptureRequest#SENSOR_FRAME_DURATION
996265b34ce331cbe296f82ca357645312718c8d4c7Eino-Ville Talvala     * @see CaptureRequest#SENSOR_SENSITIVITY
9975a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
9985a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Float> LENS_APERTURE =
9995a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Float>("android.lens.aperture", float.class);
10005a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
10015a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
1002855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk     * <p>State of lens neutral density filter(s).</p>
1003855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk     * <p>This will not be supported on most camera devices. On devices
1004855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk     * where this is supported, this may only be set to one of the
1005855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk     * values included in {@link CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES android.lens.info.availableFilterDensities}.</p>
1006855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk     * <p>Lens filters are typically used to lower the amount of light the
1007855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk     * sensor is exposed to (measured in steps of EV). As used here, an EV
1008855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk     * step is the standard logarithmic representation, which are
1009855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk     * non-negative, and inversely proportional to the amount of light
1010855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk     * hitting the sensor.  For example, setting this to 0 would result
1011855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk     * in no reduction of the incoming light, and setting this to 2 would
1012855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk     * mean that the filter is set to reduce incoming light by two stops
1013855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk     * (allowing 1/4 of the prior amount of light to the sensor).</p>
1014ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He     * <p>It may take several frames before the lens filter density changes
1015ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He     * to the requested value. While the filter density is still changing,
1016ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He     * {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p>
1017855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk     *
1018855bae407d61b5cc6629248e7692927b4dacd92fRuben Brunk     * @see CameraCharacteristics#LENS_INFO_AVAILABLE_FILTER_DENSITIES
1019ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He     * @see CaptureResult#LENS_STATE
10205a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
10215a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Float> LENS_FILTER_DENSITY =
10225a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Float>("android.lens.filterDensity", float.class);
10235a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
10245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
1025a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk     * <p>The current lens focal length; used for optical zoom.</p>
1026a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk     * <p>This setting controls the physical focal length of the camera
1027a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk     * device's lens. Changing the focal length changes the field of
1028a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk     * view of the camera device, and is usually used for optical zoom.</p>
1029a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk     * <p>Like {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance} and {@link CaptureRequest#LENS_APERTURE android.lens.aperture}, this
1030a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk     * setting won't be applied instantaneously, and it may take several
1031ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He     * frames before the lens can change to the requested focal length.
1032a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk     * While the focal length is still changing, {@link CaptureResult#LENS_STATE android.lens.state} will
1033a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk     * be set to MOVING.</p>
1034a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk     * <p>This is expected not to be supported on most devices.</p>
1035a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk     *
1036a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk     * @see CaptureRequest#LENS_APERTURE
1037a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk     * @see CaptureRequest#LENS_FOCUS_DISTANCE
1038a20f4c2648d7c597e3178978d17eb5894ef2b2b9Ruben Brunk     * @see CaptureResult#LENS_STATE
10395a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
10405a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Float> LENS_FOCAL_LENGTH =
10415a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Float>("android.lens.focalLength", float.class);
10425a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
10435a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
1044ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Distance to plane of sharpest focus,
1045ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * measured from frontmost surface of the lens</p>
1046ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He     * <p>0 means infinity focus. Used value will be clamped
1047ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He     * to [0, {@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance}].</p>
1048ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He     * <p>Like {@link CaptureRequest#LENS_FOCAL_LENGTH android.lens.focalLength}, this setting won't be applied
1049ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He     * instantaneously, and it may take several frames before the lens
1050ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He     * can move to the requested focus distance. While the lens is still moving,
1051ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He     * {@link CaptureResult#LENS_STATE android.lens.state} will be set to MOVING.</p>
1052ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He     *
1053ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He     * @see CaptureRequest#LENS_FOCAL_LENGTH
1054ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He     * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE
1055ca1b73a5f4e8ae4a7cef2cb2127024d0ddb9e0e0Zhijun He     * @see CaptureResult#LENS_STATE
10565a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
10575a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Float> LENS_FOCUS_DISTANCE =
10585a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Float>("android.lens.focusDistance", float.class);
10595a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
10605a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
106100849b3a430ce164af2db94eeacfd46131de4be8Ruben Brunk     * <p>Sets whether the camera device uses optical image stabilization (OIS)
106200849b3a430ce164af2db94eeacfd46131de4be8Ruben Brunk     * when capturing images.</p>
106300849b3a430ce164af2db94eeacfd46131de4be8Ruben Brunk     * <p>OIS is used to compensate for motion blur due to small movements of
106400849b3a430ce164af2db94eeacfd46131de4be8Ruben Brunk     * the camera during capture. Unlike digital image stabilization, OIS makes
106500849b3a430ce164af2db94eeacfd46131de4be8Ruben Brunk     * use of mechanical elements to stabilize the camera sensor, and thus
106600849b3a430ce164af2db94eeacfd46131de4be8Ruben Brunk     * allows for longer exposure times before camera shake becomes
106700849b3a430ce164af2db94eeacfd46131de4be8Ruben Brunk     * apparent.</p>
106800849b3a430ce164af2db94eeacfd46131de4be8Ruben Brunk     * <p>This is not expected to be supported on most devices.</p>
10695a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #LENS_OPTICAL_STABILIZATION_MODE_OFF
10705a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #LENS_OPTICAL_STABILIZATION_MODE_ON
10715a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
10725a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Integer> LENS_OPTICAL_STABILIZATION_MODE =
10735a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Integer>("android.lens.opticalStabilizationMode", int.class);
10745a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
10755a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
1076ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Mode of operation for the noise reduction
1077ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * algorithm</p>
10782807936f5dfdeff25e9ace3482100511a69dcf13Zhijun He     * <p>Noise filtering control. OFF means no noise reduction
1079cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * will be applied by the camera device.</p>
10806dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk     * <p>This must be set to a valid mode in
10816dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk     * {@link CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES android.noiseReduction.availableNoiseReductionModes}.</p>
10825f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He     * <p>FAST/HIGH_QUALITY both mean camera device determined noise filtering
10835f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He     * will be applied. HIGH_QUALITY mode indicates that the camera device
10845f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He     * will use the highest-quality noise filtering algorithms,
10855f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He     * even if it slows down capture rate. FAST means the camera device should not
10862807936f5dfdeff25e9ace3482100511a69dcf13Zhijun He     * slow down capture rate when applying noise filtering.</p>
10876dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk     *
10886dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk     * @see CameraCharacteristics#NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES
10895a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #NOISE_REDUCTION_MODE_OFF
10905a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #NOISE_REDUCTION_MODE_FAST
10915a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #NOISE_REDUCTION_MODE_HIGH_QUALITY
10925a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
10935a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Integer> NOISE_REDUCTION_MODE =
10945a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Integer>("android.noiseReduction.mode", int.class);
10955a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
10965a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
1097ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>An application-specified ID for the current
10985a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * request. Must be maintained unchanged in output
1099ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * frame</p>
11005a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @hide
11015a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
11025a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Integer> REQUEST_ID =
11035a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Integer>("android.request.id", int.class);
11045a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
11055a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
1106ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>(x, y, width, height).</p>
1107ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>A rectangle with the top-level corner of (x,y) and size
11085a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * (width, height). The region of the sensor that is used for
11095a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * output. Each stream must use this rectangle to produce its
11105a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * output, cropping to a smaller region if necessary to
1111ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * maintain the stream's aspect ratio.</p>
1112ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>HAL2.x uses only (x, y, width)</p>
1113ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Any additional per-stream cropping must be done to
1114ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * maximize the final pixel area of the stream.</p>
1115ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>For example, if the crop region is set to a 4:3 aspect
11165a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * ratio, then 4:3 streams should use the exact crop
11175a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * region. 16:9 streams should further crop vertically
1118ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * (letterbox).</p>
1119ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Conversely, if the crop region is set to a 16:9, then 4:3
11205a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * outputs should crop horizontally (pillarbox), and 16:9
11215a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * streams should match exactly. These additional crops must
1122ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * be centered within the crop region.</p>
1123ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>The output streams must maintain square pixels at all
11245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * times, no matter what the relative aspect ratios of the
11255a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * crop region and the stream are.  Negative values for
11265a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * corner are allowed for raw output if full pixel array is
11275a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * larger than active pixel array. Width and height may be
11285a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * rounded to nearest larger supportable width, especially
11295a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * for raw output, where only a few fixed scales may be
11305a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * possible. The width and height of the crop region cannot
11315a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * be set to be smaller than floor( activeArraySize.width /
1132d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala     * {@link CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom} ) and floor(
1133d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala     * activeArraySize.height /
1134d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala     * {@link CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM android.scaler.availableMaxDigitalZoom}), respectively.</p>
1135d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala     *
1136d8fd67931e17c66e530de5482b63863e6c4301aaEino-Ville Talvala     * @see CameraCharacteristics#SCALER_AVAILABLE_MAX_DIGITAL_ZOOM
11375a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
11385a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<android.graphics.Rect> SCALER_CROP_REGION =
11395a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<android.graphics.Rect>("android.scaler.cropRegion", android.graphics.Rect.class);
11405a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
11415a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
1142ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Duration each pixel is exposed to
1143ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * light.</p>
1144ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>If the sensor can't expose this exact duration, it should shorten the
1145ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * duration exposed to the nearest possible value (rather than expose longer).</p>
11465a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
11475a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Long> SENSOR_EXPOSURE_TIME =
11485a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Long>("android.sensor.exposureTime", long.class);
11495a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
11505a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
1151ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Duration from start of frame exposure to
1152143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * start of next frame exposure.</p>
1153143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * <p>The maximum frame rate that can be supported by a camera subsystem is
1154143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * a function of many factors:</p>
1155143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * <ul>
1156143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * <li>Requested resolutions of output image streams</li>
1157143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * <li>Availability of binning / skipping modes on the imager</li>
1158143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * <li>The bandwidth of the imager interface</li>
1159143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * <li>The bandwidth of the various ISP processing blocks</li>
1160143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * </ul>
1161143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * <p>Since these factors can vary greatly between different ISPs and
1162143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * sensors, the camera abstraction tries to represent the bandwidth
1163143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * restrictions with as simple a model as possible.</p>
1164143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * <p>The model presented has the following characteristics:</p>
1165143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * <ul>
1166143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * <li>The image sensor is always configured to output the smallest
1167143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * resolution possible given the application's requested output stream
1168143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * sizes.  The smallest resolution is defined as being at least as large
1169143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * as the largest requested output stream size; the camera pipeline must
1170143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * never digitally upsample sensor data when the crop region covers the
1171143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * whole sensor. In general, this means that if only small output stream
1172143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * resolutions are configured, the sensor can provide a higher frame
1173143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * rate.</li>
1174143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * <li>Since any request may use any or all the currently configured
1175143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * output streams, the sensor and ISP must be configured to support
1176143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * scaling a single capture to all the streams at the same time.  This
1177143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * means the camera pipeline must be ready to produce the largest
1178143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * requested output size without any delay.  Therefore, the overall
1179143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * frame rate of a given configured stream set is governed only by the
1180143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * largest requested stream resolution.</li>
1181143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * <li>Using more than one output stream in a request does not affect the
1182143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * frame duration.</li>
1183a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * <li>Certain format-streams may need to do additional background processing
1184a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * before data is consumed/produced by that stream. These processors
1185a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * can run concurrently to the rest of the camera pipeline, but
1186a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * cannot process more than 1 capture at a time.</li>
1187143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * </ul>
1188143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * <p>The necessary information for the application, given the model above,
11899c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin     * is provided via the {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} field
11909c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin     * using StreamConfigurationMap#getOutputMinFrameDuration(int, Size).
1191143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * These are used to determine the maximum frame rate / minimum frame
1192143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * duration that is possible for a given stream configuration.</p>
1193143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * <p>Specifically, the application can use the following rules to
1194a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * determine the minimum frame duration it can request from the camera
1195143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * device:</p>
1196143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * <ol>
1197a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * <li>Let the set of currently configured input/output streams
1198a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * be called <code>S</code>.</li>
1199a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * <li>Find the minimum frame durations for each stream in <code>S</code>, by
12009c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin     * looking it up in {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} using
12019c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin     * StreamConfigurationMap#getOutputMinFrameDuration(int, Size) (with
1202a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * its respective size/format). Let this set of frame durations be called
1203a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * <code>F</code>.</li>
1204a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * <li>For any given request <code>R</code>, the minimum frame duration allowed
1205a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * for <code>R</code> is the maximum out of all values in <code>F</code>. Let the streams
1206a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * used in <code>R</code> be called <code>S_r</code>.</li>
1207143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     * </ol>
1208a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * <p>If none of the streams in <code>S_r</code> have a stall time (listed in
12099c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin     * StreamConfigurationMap#getOutputStallDuration(int,Size) using its
12109c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin     * respective size/format), then the frame duration in
1211a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * <code>F</code> determines the steady state frame rate that the application will
1212a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * get if it uses <code>R</code> as a repeating request. Let this special kind
1213a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * of request be called <code>Rsimple</code>.</p>
1214a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * <p>A repeating request <code>Rsimple</code> can be <em>occasionally</em> interleaved
1215a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * by a single capture of a new request <code>Rstall</code> (which has at least
1216a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * one in-use stream with a non-0 stall time) and if <code>Rstall</code> has the
1217a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * same minimum frame duration this will not cause a frame rate loss
1218a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * if all buffers from the previous <code>Rstall</code> have already been
1219a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * delivered.</p>
1220a23ffb5f50d5bf72bde9b8fdbcbd0cea037135b3Igor Murashkin     * <p>For more details about stalling, see
12219c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin     * StreamConfigurationMap#getOutputStallDuration(int,Size).</p>
1222143aa0b891b2f8bf8ffabf8c53966c3cf97e9eb0Igor Murashkin     *
12239c595174ccaaf3d36315c4a100e47ee4369073f6Igor Murashkin     * @see CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP
12245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
12255a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Long> SENSOR_FRAME_DURATION =
12265a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Long>("android.sensor.frameDuration", long.class);
12275a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
12285a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
1229ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Gain applied to image data. Must be
12305a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * implemented through analog gain only if set to values
1231ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * below 'maximum analog sensitivity'.</p>
1232ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>If the sensor can't apply this exact gain, it should lessen the
1233ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * gain to the nearest possible value (rather than gain more).</p>
1234ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>ISO 12232:2006 REI method</p>
12355a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
12365a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Integer> SENSOR_SENSITIVITY =
12375a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Integer>("android.sensor.sensitivity", int.class);
12385a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
12395a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
1240c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * <p>A pixel <code>[R, G_even, G_odd, B]</code> that supplies the test pattern
1241c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * when {@link CaptureRequest#SENSOR_TEST_PATTERN_MODE android.sensor.testPatternMode} is SOLID_COLOR.</p>
1242c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * <p>Each color channel is treated as an unsigned 32-bit integer.
1243c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * The camera device then uses the most significant X bits
1244c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * that correspond to how many bits are in its Bayer raw sensor
1245c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * output.</p>
1246c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * <p>For example, a sensor with RAW10 Bayer output would use the
1247c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * 10 most significant bits from each color channel.</p>
1248c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1249c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     *
1250c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE
1251c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     */
1252c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin    public static final Key<int[]> SENSOR_TEST_PATTERN_DATA =
1253c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin            new Key<int[]>("android.sensor.testPatternData", int[].class);
1254c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin
1255c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin    /**
1256c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * <p>When enabled, the sensor sends a test pattern instead of
1257c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * doing a real exposure from the camera.</p>
1258c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * <p>When a test pattern is enabled, all manual sensor controls specified
1259c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * by android.sensor.* should be ignored. All other controls should
1260c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * work as normal.</p>
1261c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * <p>For example, if manual flash is enabled, flash firing should still
1262c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * occur (and that the test pattern remain unmodified, since the flash
1263c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * would not actually affect it).</p>
1264c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1265c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * @see #SENSOR_TEST_PATTERN_MODE_OFF
1266c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * @see #SENSOR_TEST_PATTERN_MODE_SOLID_COLOR
1267c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS
1268c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * @see #SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY
1269c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * @see #SENSOR_TEST_PATTERN_MODE_PN9
1270c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     * @see #SENSOR_TEST_PATTERN_MODE_CUSTOM1
1271c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin     */
1272c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin    public static final Key<Integer> SENSOR_TEST_PATTERN_MODE =
1273c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin            new Key<Integer>("android.sensor.testPatternMode", int.class);
1274c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin
1275c127f05292919ef1646b08b16dca1fe7c324afd4Igor Murashkin    /**
1276ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * <p>Quality of lens shading correction applied
1277ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * to the image data.</p>
1278ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * <p>When set to OFF mode, no lens shading correction will be applied by the
1279ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * camera device, and an identity lens shading map data will be provided
1280ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * if <code>{@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} == ON</code>. For example, for lens
1281ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * shading map with size specified as <code>{@link CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE android.lens.info.shadingMapSize} = [ 4, 3 ]</code>,
1282ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * the output {@link CaptureResult#STATISTICS_LENS_SHADING_MAP android.statistics.lensShadingMap} for this case will be an identity map
1283ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * shown below:</p>
1284ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * <pre><code>[ 1.0, 1.0, 1.0, 1.0,  1.0, 1.0, 1.0, 1.0,
1285ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * 1.0, 1.0, 1.0, 1.0,  1.0, 1.0, 1.0, 1.0,
1286ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * 1.0, 1.0, 1.0, 1.0,  1.0, 1.0, 1.0, 1.0,
1287ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * 1.0, 1.0, 1.0, 1.0,  1.0, 1.0, 1.0, 1.0,
1288ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * 1.0, 1.0, 1.0, 1.0,   1.0, 1.0, 1.0, 1.0,
1289ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * 1.0, 1.0, 1.0, 1.0,  1.0, 1.0, 1.0, 1.0 ]
1290ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * </code></pre>
1291ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * <p>When set to other modes, lens shading correction will be applied by the
1292ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * camera device. Applications can request lens shading map data by setting
1293ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * {@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} to ON, and then the camera device will provide
1294ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * lens shading map data in {@link CaptureResult#STATISTICS_LENS_SHADING_MAP android.statistics.lensShadingMap}, with size specified
1295ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * by {@link CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE android.lens.info.shadingMapSize}.</p>
1296ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     *
1297ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * @see CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE
1298ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * @see CaptureResult#STATISTICS_LENS_SHADING_MAP
1299ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * @see CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE
1300ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * @see #SHADING_MODE_OFF
1301ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * @see #SHADING_MODE_FAST
1302ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     * @see #SHADING_MODE_HIGH_QUALITY
1303ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He     */
1304ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He    public static final Key<Integer> SHADING_MODE =
1305ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He            new Key<Integer>("android.shading.mode", int.class);
1306ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He
1307ba93fe6468ef14865ec341bc14fc4a1dc7e88704Zhijun He    /**
1308ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>State of the face detector
1309ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * unit</p>
1310ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Whether face detection is enabled, and whether it
13115a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * should output just the basic fields or the full set of
13125a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * fields. Value must be one of the
13130da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES android.statistics.info.availableFaceDetectModes}.</p>
13140da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     *
13150da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES
13165a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #STATISTICS_FACE_DETECT_MODE_OFF
13175a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #STATISTICS_FACE_DETECT_MODE_SIMPLE
13185a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #STATISTICS_FACE_DETECT_MODE_FULL
13195a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
13205a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Integer> STATISTICS_FACE_DETECT_MODE =
13215a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Integer>("android.statistics.faceDetectMode", int.class);
13225a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
13235a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
13249d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk     * <p>Operating mode for hotpixel map generation.</p>
13259d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk     * <p>If set to ON, a hotpixel map is returned in {@link CaptureResult#STATISTICS_HOT_PIXEL_MAP android.statistics.hotPixelMap}.
13269d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk     * If set to OFF, no hotpixel map should be returned.</p>
13279d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk     * <p>This must be set to a valid mode from {@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES android.statistics.info.availableHotPixelMapModes}.</p>
13289d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk     *
13299d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk     * @see CaptureResult#STATISTICS_HOT_PIXEL_MAP
13309d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk     * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES
13319d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk     */
13329d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk    public static final Key<Boolean> STATISTICS_HOT_PIXEL_MAP_MODE =
13339d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk            new Key<Boolean>("android.statistics.hotPixelMapMode", boolean.class);
13349d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk
13359d454fd6096dad310a476d50b5e7175e38cdc4eaRuben Brunk    /**
1336cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * <p>Whether the camera device will output the lens
1337cc28a41b48bc687002a9e1fc436d00ca6f0c3692Zhijun He     * shading map in output result metadata.</p>
1338ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>When set to ON,
13390da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * {@link CaptureResult#STATISTICS_LENS_SHADING_MAP android.statistics.lensShadingMap} must be provided in
13407a9b30e9e3e45d387d2fc0cb2bd2eb79da7dd268Igor Murashkin     * the output result metadata.</p>
13410da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     *
13420da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * @see CaptureResult#STATISTICS_LENS_SHADING_MAP
1343d96748b02a468e484f864f4e3e4b7819f7dcdbd0Eino-Ville Talvala     * @see #STATISTICS_LENS_SHADING_MAP_MODE_OFF
1344d96748b02a468e484f864f4e3e4b7819f7dcdbd0Eino-Ville Talvala     * @see #STATISTICS_LENS_SHADING_MAP_MODE_ON
1345d96748b02a468e484f864f4e3e4b7819f7dcdbd0Eino-Ville Talvala     */
1346d96748b02a468e484f864f4e3e4b7819f7dcdbd0Eino-Ville Talvala    public static final Key<Integer> STATISTICS_LENS_SHADING_MAP_MODE =
1347d96748b02a468e484f864f4e3e4b7819f7dcdbd0Eino-Ville Talvala            new Key<Integer>("android.statistics.lensShadingMapMode", int.class);
1348d96748b02a468e484f864f4e3e4b7819f7dcdbd0Eino-Ville Talvala
1349d96748b02a468e484f864f4e3e4b7819f7dcdbd0Eino-Ville Talvala    /**
1350ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Tonemapping / contrast / gamma curve for the blue
1351e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is
1352e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * CONTRAST_CURVE.</p>
13530da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * <p>See {@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} for more details.</p>
13540da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     *
13553242f4fb19b77bcd2435cbe710188d012d08b005Igor Murashkin     * @see CaptureRequest#TONEMAP_CURVE_RED
13565f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He     * @see CaptureRequest#TONEMAP_MODE
13575a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
13583ffd70554f85bd1ee54354f2d5c44e1bc0878227Zhijun He    public static final Key<float[]> TONEMAP_CURVE_BLUE =
13593ffd70554f85bd1ee54354f2d5c44e1bc0878227Zhijun He            new Key<float[]>("android.tonemap.curveBlue", float[].class);
13605a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
13615a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
1362ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Tonemapping / contrast / gamma curve for the green
1363e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is
1364e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * CONTRAST_CURVE.</p>
13650da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * <p>See {@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} for more details.</p>
13660da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     *
13673242f4fb19b77bcd2435cbe710188d012d08b005Igor Murashkin     * @see CaptureRequest#TONEMAP_CURVE_RED
13685f2a47f3dedfc7859457067d8cdcdbfc28ee08acZhijun He     * @see CaptureRequest#TONEMAP_MODE
13695a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
13703ffd70554f85bd1ee54354f2d5c44e1bc0878227Zhijun He    public static final Key<float[]> TONEMAP_CURVE_GREEN =
13713ffd70554f85bd1ee54354f2d5c44e1bc0878227Zhijun He            new Key<float[]>("android.tonemap.curveGreen", float[].class);
13725a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
13735a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
1374ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Tonemapping / contrast / gamma curve for the red
1375e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is
1376e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * CONTRAST_CURVE.</p>
1377e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * <p>Each channel's curve is defined by an array of control points:</p>
1378e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * <pre><code>{@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} =
1379e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * [ P0in, P0out, P1in, P1out, P2in, P2out, P3in, P3out, ..., PNin, PNout ]
1380870922be2399766078d0a4e42a0158ecb9eb1f86Zhijun He     * 2 &lt;= N &lt;= {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</code></pre>
1381e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * <p>These are sorted in order of increasing <code>Pin</code>; it is always
1382e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * guaranteed that input values 0.0 and 1.0 are included in the list to
1383e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * define a complete mapping. For input values between control points,
1384e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * the camera device must linearly interpolate between the control
1385e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * points.</p>
1386e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * <p>Each curve can have an independent number of points, and the number
1387e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * of points can be less than max (that is, the request doesn't have to
1388e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * always provide a curve with number of points equivalent to
1389e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * {@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}).</p>
1390e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * <p>A few examples, and their corresponding graphical mappings; these
1391e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * only specify the red channel and the precision is limited to 4
1392e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * digits, for conciseness.</p>
1393e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * <p>Linear mapping:</p>
1394e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * <pre><code>{@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} = [ 0, 0, 1.0, 1.0 ]
1395e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * </code></pre>
1396e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * <p><img alt="Linear mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png" /></p>
1397e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * <p>Invert mapping:</p>
1398e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * <pre><code>{@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} = [ 0, 1.0, 1.0, 0 ]
1399e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * </code></pre>
1400e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * <p><img alt="Inverting mapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png" /></p>
1401e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * <p>Gamma 1/2.2 mapping, with 16 control points:</p>
1402e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * <pre><code>{@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} = [
1403e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * 0.0000, 0.0000, 0.0667, 0.2920, 0.1333, 0.4002, 0.2000, 0.4812,
1404e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * 0.2667, 0.5484, 0.3333, 0.6069, 0.4000, 0.6594, 0.4667, 0.7072,
1405e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * 0.5333, 0.7515, 0.6000, 0.7928, 0.6667, 0.8317, 0.7333, 0.8685,
1406e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * 0.8000, 0.9035, 0.8667, 0.9370, 0.9333, 0.9691, 1.0000, 1.0000 ]
1407e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * </code></pre>
1408e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * <p><img alt="Gamma = 1/2.2 tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png" /></p>
1409e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * <p>Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:</p>
1410e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * <pre><code>{@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} = [
1411e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * 0.0000, 0.0000, 0.0667, 0.2864, 0.1333, 0.4007, 0.2000, 0.4845,
1412e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * 0.2667, 0.5532, 0.3333, 0.6125, 0.4000, 0.6652, 0.4667, 0.7130,
1413e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * 0.5333, 0.7569, 0.6000, 0.7977, 0.6667, 0.8360, 0.7333, 0.8721,
1414e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * 0.8000, 0.9063, 0.8667, 0.9389, 0.9333, 0.9701, 1.0000, 1.0000 ]
1415e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * </code></pre>
1416e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * <p><img alt="sRGB tonemapping curve" src="../../../../images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png" /></p>
14170da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     *
1418e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * @see CaptureRequest#TONEMAP_CURVE_RED
1419e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS
14200da8bf5dbc8912cf70df14bfa655189a04c75476Eino-Ville Talvala     * @see CaptureRequest#TONEMAP_MODE
14215a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
14225a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<float[]> TONEMAP_CURVE_RED =
14235a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<float[]>("android.tonemap.curveRed", float[].class);
14245a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
14255a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
1426e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * <p>High-level global contrast/gamma/tonemapping control.</p>
1427e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * <p>When switching to an application-defined contrast curve by setting
1428e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} to CONTRAST_CURVE, the curve is defined
1429e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * per-channel with a set of <code>(in, out)</code> points that specify the
1430e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * mapping from input high-bit-depth pixel value to the output
1431e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * low-bit-depth value.  Since the actual pixel ranges of both input
1432e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * and output may change depending on the camera pipeline, the values
1433e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * are specified by normalized floating-point numbers.</p>
1434e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * <p>More-complex color mapping operations such as 3D color look-up
1435e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * tables, selective chroma enhancement, or other non-linear color
1436e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * transforms will be disabled when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is
1437e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * CONTRAST_CURVE.</p>
14386dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk     * <p>This must be set to a valid mode in
14396dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk     * {@link CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES android.tonemap.availableToneMapModes}.</p>
1440e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * <p>When using either FAST or HIGH_QUALITY, the camera device will
1441e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * emit its own tonemap curve in {@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed},
1442e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * {@link CaptureRequest#TONEMAP_CURVE_GREEN android.tonemap.curveGreen}, and {@link CaptureRequest#TONEMAP_CURVE_BLUE android.tonemap.curveBlue}.
1443e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * These values are always available, and as close as possible to the
1444e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * actually used nonlinear/nonglobal transforms.</p>
1445e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * <p>If a request is sent with TRANSFORM_MATRIX with the camera device's
1446e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * provided curve in FAST or HIGH_QUALITY, the image's tonemap will be
1447e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * roughly the same.</p>
14483242f4fb19b77bcd2435cbe710188d012d08b005Igor Murashkin     *
14496dc379c7bd34d9707ee2ef819a5a07afc2aa9314Ruben Brunk     * @see CameraCharacteristics#TONEMAP_AVAILABLE_TONE_MAP_MODES
1450e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * @see CaptureRequest#TONEMAP_CURVE_BLUE
1451e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * @see CaptureRequest#TONEMAP_CURVE_GREEN
1452e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * @see CaptureRequest#TONEMAP_CURVE_RED
1453e0060930cbff1af0486466e03605e6e8ee525302Igor Murashkin     * @see CaptureRequest#TONEMAP_MODE
14545a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #TONEMAP_MODE_CONTRAST_CURVE
14555a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #TONEMAP_MODE_FAST
14565a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @see #TONEMAP_MODE_HIGH_QUALITY
14575a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
14585a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Integer> TONEMAP_MODE =
14595a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Integer>("android.tonemap.mode", int.class);
14605a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
14615a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
1462ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>This LED is nominally used to indicate to the user
14635a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * that the camera is powered on and may be streaming images back to the
14645a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * Application Processor. In certain rare circumstances, the OS may
14655a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * disable this when video is processed locally and not transmitted to
1466ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * any untrusted applications.</p>
1467ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>In particular, the LED <em>must</em> always be on when the data could be
1468ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * transmitted off the device. The LED <em>should</em> always be on whenever
1469ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * data is stored locally on the device.</p>
1470ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>The LED <em>may</em> be off if a trusted application is using the data that
1471ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * doesn't violate the above rules.</p>
14725a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * @hide
14735a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
14745a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Boolean> LED_TRANSMIT =
14755a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Boolean>("android.led.transmit", boolean.class);
14765a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
14775a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /**
1478ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Whether black-level compensation is locked
14790956af56a294397325f2695604229ab7550364caEino-Ville Talvala     * to its current values, or is free to vary.</p>
1480ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>When set to ON, the values used for black-level
14810956af56a294397325f2695604229ab7550364caEino-Ville Talvala     * compensation will not change until the lock is set to
14820956af56a294397325f2695604229ab7550364caEino-Ville Talvala     * OFF.</p>
1483ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>Since changes to certain capture parameters (such as
14845a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * exposure time) may require resetting of black level
14850956af56a294397325f2695604229ab7550364caEino-Ville Talvala     * compensation, the camera device must report whether setting
14860956af56a294397325f2695604229ab7550364caEino-Ville Talvala     * the black level lock was successful in the output result
1487ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * metadata.</p>
1488ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <p>For example, if a sequence of requests is as follows:</p>
1489ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <ul>
1490ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <li>Request 1: Exposure = 10ms, Black level lock = OFF</li>
1491ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <li>Request 2: Exposure = 10ms, Black level lock = ON</li>
1492ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <li>Request 3: Exposure = 10ms, Black level lock = ON</li>
1493ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <li>Request 4: Exposure = 20ms, Black level lock = ON</li>
1494ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <li>Request 5: Exposure = 20ms, Black level lock = ON</li>
1495ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <li>Request 6: Exposure = 20ms, Black level lock = ON</li>
1496ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * </ul>
14970956af56a294397325f2695604229ab7550364caEino-Ville Talvala     * <p>And the exposure change in Request 4 requires the camera
14980956af56a294397325f2695604229ab7550364caEino-Ville Talvala     * device to reset the black level offsets, then the output
14990956af56a294397325f2695604229ab7550364caEino-Ville Talvala     * result metadata is expected to be:</p>
1500ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <ul>
1501ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <li>Result 1: Exposure = 10ms, Black level lock = OFF</li>
1502ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <li>Result 2: Exposure = 10ms, Black level lock = ON</li>
1503ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <li>Result 3: Exposure = 10ms, Black level lock = ON</li>
1504ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <li>Result 4: Exposure = 20ms, Black level lock = OFF</li>
1505ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <li>Result 5: Exposure = 20ms, Black level lock = ON</li>
1506ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * <li>Result 6: Exposure = 20ms, Black level lock = ON</li>
1507ace5bf04126f7dd49d75fca9218031f0db02e5ddIgor Murashkin     * </ul>
15080956af56a294397325f2695604229ab7550364caEino-Ville Talvala     * <p>This indicates to the application that on frame 4, black
15090956af56a294397325f2695604229ab7550364caEino-Ville Talvala     * levels were reset due to exposure value changes, and pixel
15100956af56a294397325f2695604229ab7550364caEino-Ville Talvala     * values may not be consistent across captures.</p>
15110956af56a294397325f2695604229ab7550364caEino-Ville Talvala     * <p>The camera device will maintain the lock to the extent
15120956af56a294397325f2695604229ab7550364caEino-Ville Talvala     * possible, only overriding the lock to OFF when changes to
15130956af56a294397325f2695604229ab7550364caEino-Ville Talvala     * other request parameters require a black level recalculation
15140956af56a294397325f2695604229ab7550364caEino-Ville Talvala     * or reset.</p>
15155a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     */
15165a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    public static final Key<Boolean> BLACK_LEVEL_LOCK =
15175a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala            new Key<Boolean>("android.blackLevel.lock", boolean.class);
15185a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala
15195a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala    /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~
15205a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     * End generated code
15215a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala     *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/
15225a32b20ccc34fd7d4f048de05c427a7a96786531Eino-Ville Talvala}
1523