/* * Copyright (C) 2013 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package android.hardware.camera2; import android.annotation.NonNull; import android.annotation.Nullable; import android.annotation.IntDef; import android.annotation.SystemApi; import android.annotation.TestApi; import static android.hardware.camera2.ICameraDeviceUser.NORMAL_MODE; import static android.hardware.camera2.ICameraDeviceUser.CONSTRAINED_HIGH_SPEED_MODE; import android.hardware.camera2.params.InputConfiguration; import android.hardware.camera2.params.StreamConfigurationMap; import android.hardware.camera2.params.OutputConfiguration; import android.os.Handler; import android.view.Surface; import java.util.List; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; /** *
The CameraDevice class is a representation of a single camera connected to an * Android device, allowing for fine-grain control of image capture and * post-processing at high frame rates.
* *Your application must declare the * {@link android.Manifest.permission#CAMERA Camera} permission in its manifest * in order to access camera devices.
* *A given camera device may provide support at one of two levels: limited or * full. If a device only supports the limited level, then Camera2 exposes a * feature set that is roughly equivalent to the older * {@link android.hardware.Camera Camera} API, although with a cleaner and more * efficient interface. Devices that implement the full level of support * provide substantially improved capabilities over the older camera * API. Applications that target the limited level devices will run unchanged on * the full-level devices; if your application requires a full-level device for * proper operation, declare the "android.hardware.camera.level.full" feature in your * manifest.
* * @see CameraManager#openCamera * @see android.Manifest.permission#CAMERA */ public abstract class CameraDevice implements AutoCloseable { /** * Create a request suitable for a camera preview window. Specifically, this * means that high frame rate is given priority over the highest-quality * post-processing. These requests would normally be used with the * {@link CameraCaptureSession#setRepeatingRequest} method. * This template is guaranteed to be supported on all camera devices. * * @see #createCaptureRequest */ public static final int TEMPLATE_PREVIEW = 1; /** * Create a request suitable for still image capture. Specifically, this * means prioritizing image quality over frame rate. These requests would * commonly be used with the {@link CameraCaptureSession#capture} method. * This template is guaranteed to be supported on all camera devices except * {@link CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_DEPTH_OUTPUT DEPTH_OUTPUT} devices * that are not {@link CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_BACKWARD_COMPATIBLE * BACKWARD_COMPATIBLE}. * @see #createCaptureRequest */ public static final int TEMPLATE_STILL_CAPTURE = 2; /** * Create a request suitable for video recording. Specifically, this means * that a stable frame rate is used, and post-processing is set for * recording quality. These requests would commonly be used with the * {@link CameraCaptureSession#setRepeatingRequest} method. * This template is guaranteed to be supported on all camera devices except * {@link CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_DEPTH_OUTPUT DEPTH_OUTPUT} devices * that are not {@link CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_BACKWARD_COMPATIBLE * BACKWARD_COMPATIBLE}. * * @see #createCaptureRequest */ public static final int TEMPLATE_RECORD = 3; /** * Create a request suitable for still image capture while recording * video. Specifically, this means maximizing image quality without * disrupting the ongoing recording. These requests would commonly be used * with the {@link CameraCaptureSession#capture} method while a request based on * {@link #TEMPLATE_RECORD} is is in use with {@link CameraCaptureSession#setRepeatingRequest}. * This template is guaranteed to be supported on all camera devices except * legacy devices ({@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL} * {@code == }{@link CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY LEGACY}) and * {@link CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_DEPTH_OUTPUT DEPTH_OUTPUT} devices * that are not {@link CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_BACKWARD_COMPATIBLE * BACKWARD_COMPATIBLE}. * * @see #createCaptureRequest */ public static final int TEMPLATE_VIDEO_SNAPSHOT = 4; /** * Create a request suitable for zero shutter lag still capture. This means * means maximizing image quality without compromising preview frame rate. * AE/AWB/AF should be on auto mode. This is intended for application-operated ZSL. For * device-operated ZSL, use {@link CaptureRequest#CONTROL_ENABLE_ZSL} if available. * This template is guaranteed to be supported on camera devices that support the * {@link CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_PRIVATE_REPROCESSING PRIVATE_REPROCESSING} * capability or the * {@link CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_YUV_REPROCESSING YUV_REPROCESSING} * capability. * * @see #createCaptureRequest * @see CaptureRequest#CONTROL_ENABLE_ZSL */ public static final int TEMPLATE_ZERO_SHUTTER_LAG = 5; /** * A basic template for direct application control of capture * parameters. All automatic control is disabled (auto-exposure, auto-white * balance, auto-focus), and post-processing parameters are set to preview * quality. The manual capture parameters (exposure, sensitivity, and so on) * are set to reasonable defaults, but should be overriden by the * application depending on the intended use case. * This template is guaranteed to be supported on camera devices that support the * {@link CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_MANUAL_SENSOR MANUAL_SENSOR} * capability. * * @see #createCaptureRequest */ public static final int TEMPLATE_MANUAL = 6; /** @hide */ @Retention(RetentionPolicy.SOURCE) @IntDef(prefix = {"TEMPLATE_"}, value = {TEMPLATE_PREVIEW, TEMPLATE_STILL_CAPTURE, TEMPLATE_RECORD, TEMPLATE_VIDEO_SNAPSHOT, TEMPLATE_ZERO_SHUTTER_LAG, TEMPLATE_MANUAL }) public @interface RequestTemplate {}; /** * Get the ID of this camera device. * *This matches the ID given to {@link CameraManager#openCamera} to instantiate this * this camera device.
* *This ID can be used to query the camera device's {@link * CameraCharacteristics fixed properties} with {@link * CameraManager#getCameraCharacteristics}.
* *This method can be called even if the device has been closed or has encountered * a serious error.
* * @return the ID for this camera device * * @see CameraManager#getCameraCharacteristics * @see CameraManager#getCameraIdList */ @NonNull public abstract String getId(); /** *Create a new camera capture session by providing the target output set of Surfaces to the * camera device.
* *The active capture session determines the set of potential output Surfaces for * the camera device for each capture request. A given request may use all * or only some of the outputs. Once the CameraCaptureSession is created, requests can be * submitted with {@link CameraCaptureSession#capture capture}, * {@link CameraCaptureSession#captureBurst captureBurst}, * {@link CameraCaptureSession#setRepeatingRequest setRepeatingRequest}, or * {@link CameraCaptureSession#setRepeatingBurst setRepeatingBurst}.
* *Surfaces suitable for inclusion as a camera output can be created for * various use cases and targets:
* *The camera device will query each Surface's size and formats upon this * call, so they must be set to a valid setting at this time.
* *It can take several hundred milliseconds for the session's configuration to complete, * since camera hardware may need to be powered on or reconfigured. Once the configuration is * complete and the session is ready to actually capture data, the provided * {@link CameraCaptureSession.StateCallback}'s * {@link CameraCaptureSession.StateCallback#onConfigured} callback will be called.
* *If a prior CameraCaptureSession already exists when this method is called, the previous * session will no longer be able to accept new capture requests and will be closed. Any * in-progress capture requests made on the prior session will be completed before it's closed. * {@link CameraCaptureSession.StateCallback#onConfigured} for the new session may be invoked * before {@link CameraCaptureSession.StateCallback#onClosed} is invoked for the prior * session. Once the new session is {@link CameraCaptureSession.StateCallback#onConfigured * configured}, it is able to start capturing its own requests. To minimize the transition time, * the {@link CameraCaptureSession#abortCaptures} call can be used to discard the remaining * requests for the prior capture session before a new one is created. Note that once the new * session is created, the old one can no longer have its captures aborted.
* *Using larger resolution outputs, or more outputs, can result in slower * output rate from the device.
* *Configuring a session with an empty or null list will close the current session, if * any. This can be used to release the current session's target surfaces for another use.
* *While any of the sizes from {@link StreamConfigurationMap#getOutputSizes} can be used when * a single output stream is configured, a given camera device may not be able to support all * combination of sizes, formats, and targets when multiple outputs are configured at once. The * tables below list the maximum guaranteed resolutions for combinations of streams and targets, * given the capabilities of the camera device.
* *If an application tries to create a session using a set of targets that exceed the limits * described in the below tables, one of three possibilities may occur. First, the session may * be successfully created and work normally. Second, the session may be successfully created, * but the camera device won't meet the frame rate guarantees as described in * {@link StreamConfigurationMap#getOutputMinFrameDuration}. Or third, if the output set * cannot be used at all, session creation will fail entirely, with * {@link CameraCaptureSession.StateCallback#onConfigureFailed} being invoked.
* *For the type column, {@code PRIV} refers to any target whose available sizes are found * using {@link StreamConfigurationMap#getOutputSizes(Class)} with no direct application-visible * format, {@code YUV} refers to a target Surface using the * {@link android.graphics.ImageFormat#YUV_420_888} format, {@code JPEG} refers to the * {@link android.graphics.ImageFormat#JPEG} format, and {@code RAW} refers to the * {@link android.graphics.ImageFormat#RAW_SENSOR} format.
* *For the maximum size column, {@code PREVIEW} refers to the best size match to the * device's screen resolution, or to 1080p ({@code 1920x1080}), whichever is * smaller. {@code RECORD} refers to the camera device's maximum supported recording resolution, * as determined by {@link android.media.CamcorderProfile}. And {@code MAXIMUM} refers to the * camera device's maximum output resolution for that format or target from * {@link StreamConfigurationMap#getOutputSizes}.
* *To use these tables, determine the number and the formats/targets of outputs needed, and * find the row(s) of the table with those targets. The sizes indicate the maximum set of sizes * that can be used; it is guaranteed that for those targets, the listed sizes and anything * smaller from the list given by {@link StreamConfigurationMap#getOutputSizes} can be * successfully used to create a session. For example, if a row indicates that a 8 megapixel * (MP) YUV_420_888 output can be used together with a 2 MP {@code PRIV} output, then a session * can be created with targets {@code [8 MP YUV, 2 MP PRIV]} or targets {@code [2 MP YUV, 2 MP * PRIV]}; but a session with targets {@code [8 MP YUV, 4 MP PRIV]}, targets {@code [4 MP YUV, 4 * MP PRIV]}, or targets {@code [8 MP PRIV, 2 MP YUV]} would not be guaranteed to work, unless * some other row of the table lists such a combination.
* * *Legacy devices ({@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL} * {@code == }{@link CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY LEGACY}) support at * least the following stream combinations: * *
LEGACY-level guaranteed configurations | ||||||
---|---|---|---|---|---|---|
Target 1 | Target 2 | Target 3 | Sample use case(s) | |||
Type | Max size | Type | Max size | Type | Max size | |
{@code PRIV} | {@code MAXIMUM} | Simple preview, GPU video processing, or no-preview video recording. | ||||
{@code JPEG} | {@code MAXIMUM} | No-viewfinder still image capture. | ||||
{@code YUV } | {@code MAXIMUM} | In-application video/image processing. | ||||
{@code PRIV} | {@code PREVIEW} | {@code JPEG} | {@code MAXIMUM} | Standard still imaging. | ||
{@code YUV } | {@code PREVIEW} | {@code JPEG} | {@code MAXIMUM} | In-app processing plus still capture. | ||
{@code PRIV} | {@code PREVIEW} | {@code PRIV} | {@code PREVIEW} | Standard recording. | ||
{@code PRIV} | {@code PREVIEW} | {@code YUV } | {@code PREVIEW} | Preview plus in-app processing. | ||
{@code PRIV} | {@code PREVIEW} | {@code YUV } | {@code PREVIEW} | {@code JPEG} | {@code MAXIMUM} | Still capture plus in-app processing. |
Limited-level ({@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL} * {@code == }{@link CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED LIMITED}) devices * support at least the following stream combinations in addition to those for * {@link CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY LEGACY} devices: * *
LIMITED-level additional guaranteed configurations | ||||||
---|---|---|---|---|---|---|
Target 1 | Target 2 | Target 3 | Sample use case(s) | |||
Type | Max size | Type | Max size | Type | Max size | |
{@code PRIV} | {@code PREVIEW} | {@code PRIV} | {@code RECORD } | High-resolution video recording with preview. | ||
{@code PRIV} | {@code PREVIEW} | {@code YUV } | {@code RECORD } | High-resolution in-app video processing with preview. | ||
{@code YUV } | {@code PREVIEW} | {@code YUV } | {@code RECORD } | Two-input in-app video processing. | ||
{@code PRIV} | {@code PREVIEW} | {@code PRIV} | {@code RECORD } | {@code JPEG} | {@code RECORD } | High-resolution recording with video snapshot. |
{@code PRIV} | {@code PREVIEW} | {@code YUV } | {@code RECORD } | {@code JPEG} | {@code RECORD } | High-resolution in-app processing with video snapshot. |
{@code YUV } | {@code PREVIEW} | {@code YUV } | {@code PREVIEW} | {@code JPEG} | {@code MAXIMUM} | Two-input in-app processing with still capture. |
FULL-level ({@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL} * {@code == }{@link CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL FULL}) devices * support at least the following stream combinations in addition to those for * {@link CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED LIMITED} devices: * *
FULL-level additional guaranteed configurations | ||||||
---|---|---|---|---|---|---|
Target 1 | Target 2 | Target 3 | Sample use case(s) | |||
Type | Max size | Type | Max size | Type | Max size | |
{@code PRIV} | {@code PREVIEW} | {@code PRIV} | {@code MAXIMUM} | Maximum-resolution GPU processing with preview. | ||
{@code PRIV} | {@code PREVIEW} | {@code YUV } | {@code MAXIMUM} | Maximum-resolution in-app processing with preview. | ||
{@code YUV } | {@code PREVIEW} | {@code YUV } | {@code MAXIMUM} | Maximum-resolution two-input in-app processsing. | ||
{@code PRIV} | {@code PREVIEW} | {@code PRIV} | {@code PREVIEW} | {@code JPEG} | {@code MAXIMUM} | Video recording with maximum-size video snapshot |
{@code YUV } | {@code 640x480} | {@code PRIV} | {@code PREVIEW} | {@code YUV } | {@code MAXIMUM} | Standard video recording plus maximum-resolution in-app processing. |
{@code YUV } | {@code 640x480} | {@code YUV } | {@code PREVIEW} | {@code YUV } | {@code MAXIMUM} | Preview plus two-input maximum-resolution in-app processing. |
RAW-capability ({@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES} includes * {@link CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_RAW RAW}) devices additionally support * at least the following stream combinations on both * {@link CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL FULL} and * {@link CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED LIMITED} devices: * *
RAW-capability additional guaranteed configurations | ||||||
---|---|---|---|---|---|---|
Target 1 | Target 2 | Target 3 | Sample use case(s) | |||
Type | Max size | Type | Max size | Type | Max size | |
{@code RAW } | {@code MAXIMUM} | No-preview DNG capture. | ||||
{@code PRIV} | {@code PREVIEW} | {@code RAW } | {@code MAXIMUM} | Standard DNG capture. | ||
{@code YUV } | {@code PREVIEW} | {@code RAW } | {@code MAXIMUM} | In-app processing plus DNG capture. | ||
{@code PRIV} | {@code PREVIEW} | {@code PRIV} | {@code PREVIEW} | {@code RAW } | {@code MAXIMUM} | Video recording with DNG capture. |
{@code PRIV} | {@code PREVIEW} | {@code YUV } | {@code PREVIEW} | {@code RAW } | {@code MAXIMUM} | Preview with in-app processing and DNG capture. |
{@code YUV } | {@code PREVIEW} | {@code YUV } | {@code PREVIEW} | {@code RAW } | {@code MAXIMUM} | Two-input in-app processing plus DNG capture. |
{@code PRIV} | {@code PREVIEW} | {@code JPEG} | {@code MAXIMUM} | {@code RAW } | {@code MAXIMUM} | Still capture with simultaneous JPEG and DNG. |
{@code YUV } | {@code PREVIEW} | {@code JPEG} | {@code MAXIMUM} | {@code RAW } | {@code MAXIMUM} | In-app processing with simultaneous JPEG and DNG. |
BURST-capability ({@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES} includes * {@link CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_BURST_CAPTURE BURST_CAPTURE}) devices * support at least the below stream combinations in addition to those for * {@link CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED LIMITED} devices. Note that all * FULL-level devices support the BURST capability, and the below list is a strict subset of the * list for FULL-level devices, so this table is only relevant for LIMITED-level devices that * support the BURST_CAPTURE capability. * *
BURST-capability additional guaranteed configurations | ||||
---|---|---|---|---|
Target 1 | Target 2 | Sample use case(s) | ||
Type | Max size | Type | Max size | |
{@code PRIV} | {@code PREVIEW} | {@code PRIV} | {@code MAXIMUM} | Maximum-resolution GPU processing with preview. |
{@code PRIV} | {@code PREVIEW} | {@code YUV } | {@code MAXIMUM} | Maximum-resolution in-app processing with preview. |
{@code YUV } | {@code PREVIEW} | {@code YUV } | {@code MAXIMUM} | Maximum-resolution two-input in-app processsing. |
LEVEL-3 ({@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL} * {@code == }{@link CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_3 LEVEL_3}) * support at least the following stream combinations in addition to the combinations for * {@link CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL FULL} and for * RAW capability ({@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES} includes * {@link CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_RAW RAW}): * *
LEVEL-3 additional guaranteed configurations | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Target 1 | Target 2 | Target 3 | Target 4 | Sample use case(s) | ||||||
Type | Max size | Type | Max size | Type | Max size | Type | Max size | |||
{@code PRIV} | {@code PREVIEW} | {@code PRIV} | {@code 640x480} | {@code YUV} | {@code MAXIMUM} | {@code RAW} | {@code MAXIMUM} | In-app viewfinder analysis with dynamic selection of output format. | ||
{@code PRIV} | {@code PREVIEW} | {@code PRIV} | {@code 640x480} | {@code JPEG} | {@code MAXIMUM} | {@code RAW} | {@code MAXIMUM} | In-app viewfinder analysis with dynamic selection of output format. |
Since the capabilities of camera devices vary greatly, a given camera device may support * target combinations with sizes outside of these guarantees, but this can only be tested for * by attempting to create a session with such targets.
* * @param outputs The new set of Surfaces that should be made available as * targets for captured image data. * @param callback The callback to notify about the status of the new capture session. * @param handler The handler on which the callback should be invoked, or {@code null} to use * the current thread's {@link android.os.Looper looper}. * * @throws IllegalArgumentException if the set of output Surfaces do not meet the requirements, * the callback is null, or the handler is null but the current * thread has no looper. * @throws CameraAccessException if the camera device is no longer connected or has * encountered a fatal error * @throws IllegalStateException if the camera device has been closed * * @see CameraCaptureSession * @see StreamConfigurationMap#getOutputFormats() * @see StreamConfigurationMap#getOutputSizes(int) * @see StreamConfigurationMap#getOutputSizes(Class) */ public abstract void createCaptureSession(@NonNull ListCreate a new camera capture session by providing the target output set of Surfaces and * its corresponding surface configuration to the camera device.
* * @see #createCaptureSession * @see OutputConfiguration */ public abstract void createCaptureSessionByOutputConfigurations( ListIf a camera device supports YUV reprocessing * ({@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_YUV_REPROCESSING}) or PRIVATE * reprocessing * ({@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_PRIVATE_REPROCESSING}), besides * the capture session created via {@link #createCaptureSession createCaptureSession}, the * application can also create a reprocessable capture session to submit reprocess capture * requests in addition to regular capture requests. A reprocess capture request takes the next * available buffer from the session's input Surface, and sends it through the camera device's * processing pipeline again, to produce buffers for the request's target output Surfaces. No * new image data is captured for a reprocess request. However the input buffer provided by * the application must be captured previously by the same camera device in the same session * directly (e.g. for Zero-Shutter-Lag use case) or indirectly (e.g. combining multiple output * images).
* *The active reprocessable capture session determines an input {@link Surface} and the set * of potential output Surfaces for the camera devices for each capture request. The application * can use {@link #createCaptureRequest createCaptureRequest} to create regular capture requests * to capture new images from the camera device, and use {@link #createReprocessCaptureRequest * createReprocessCaptureRequest} to create reprocess capture requests to process buffers from * the input {@link Surface}. Some combinations of output Surfaces in a session may not be used * in a request simultaneously. The guaranteed combinations of output Surfaces that can be used * in a request simultaneously are listed in the tables under {@link #createCaptureSession * createCaptureSession}. All the output Surfaces in one capture request will come from the * same source, either from a new capture by the camera device, or from the input Surface * depending on if the request is a reprocess capture request.
* *Input formats and sizes supported by the camera device can be queried via * {@link StreamConfigurationMap#getInputFormats} and * {@link StreamConfigurationMap#getInputSizes}. For each supported input format, the camera * device supports a set of output formats and sizes for reprocessing that can be queried via * {@link StreamConfigurationMap#getValidOutputFormatsForInput} and * {@link StreamConfigurationMap#getOutputSizes}. While output Surfaces with formats that * aren't valid reprocess output targets for the input configuration can be part of a session, * they cannot be used as targets for a reprocessing request.
* *Since the application cannot access {@link android.graphics.ImageFormat#PRIVATE} images * directly, an output Surface created by {@link android.media.ImageReader#newInstance} with * {@link android.graphics.ImageFormat#PRIVATE} as the format will be considered as intended to * be used for reprocessing input and thus the {@link android.media.ImageReader} size must * match one of the supported input sizes for {@link android.graphics.ImageFormat#PRIVATE} * format. Otherwise, creating a reprocessable capture session will fail.
* *The guaranteed stream configurations listed in * {@link #createCaptureSession createCaptureSession} are also guaranteed to work for * {@link #createReprocessableCaptureSession createReprocessableCaptureSession}. In addition, * the configurations in the tables below are also guaranteed for creating a reprocessable * capture session if the camera device supports YUV reprocessing or PRIVATE reprocessing. * However, not all output targets used to create a reprocessable session may be used in a * {@link CaptureRequest} simultaneously. For devices that support only 1 output target in a * reprocess {@link CaptureRequest}, submitting a reprocess {@link CaptureRequest} with multiple * output targets will result in a {@link CaptureFailure}. For devices that support multiple * output targets in a reprocess {@link CaptureRequest}, the guaranteed output targets that can * be included in a {@link CaptureRequest} simultaneously are listed in the tables under * {@link #createCaptureSession createCaptureSession}. For example, with a FULL-capability * ({@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL} {@code == } * {@link CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL FULL}) device that supports PRIVATE * reprocessing, an application can create a reprocessable capture session with 1 input, * ({@code PRIV}, {@code MAXIMUM}), and 3 outputs, ({@code PRIV}, {@code MAXIMUM}), * ({@code PRIV}, {@code PREVIEW}), and ({@code YUV}, {@code MAXIMUM}). However, it's not * guaranteed that an application can submit a regular or reprocess capture with ({@code PRIV}, * {@code MAXIMUM}) and ({@code YUV}, {@code MAXIMUM}) outputs based on the table listed under * {@link #createCaptureSession createCaptureSession}. In other words, use the tables below to * determine the guaranteed stream configurations for creating a reprocessable capture session, * and use the tables under {@link #createCaptureSession createCaptureSession} to determine the * guaranteed output targets that can be submitted in a regular or reprocess * {@link CaptureRequest} simultaneously.
* * * *LIMITED-level ({@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL} * {@code == }{@link CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED LIMITED}) devices * support at least the following stream combinations for creating a reprocessable capture * session in addition to those listed in {@link #createCaptureSession createCaptureSession} for * {@link CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED LIMITED} devices: * *
LIMITED-level additional guaranteed configurations for creating a reprocessable capture session ({@code PRIV} input is guaranteed only if PRIVATE reprocessing is supported. {@code YUV} input is guaranteed only if YUV reprocessing is supported) | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Input | Target 1 | Target 2 | Target 3 | Target 4 | Sample use case(s) | |||||
Type | Max size | Type | Max size | Type | Max size | Type | Max size | Type | Max size | |
{@code PRIV}/{@code YUV} | {@code MAXIMUM} | Same as input | {@code MAXIMUM} | {@code JPEG} | {@code MAXIMUM} | No-viewfinder still image reprocessing. | ||||
{@code PRIV}/{@code YUV} | {@code MAXIMUM} | Same as input | {@code MAXIMUM} | {@code PRIV} | {@code PREVIEW} | {@code JPEG} | {@code MAXIMUM} | ZSL(Zero-Shutter-Lag) still imaging. | ||
{@code PRIV}/{@code YUV} | {@code MAXIMUM} | Same as input | {@code MAXIMUM} | {@code YUV} | {@code PREVIEW} | {@code JPEG} | {@code MAXIMUM} | ZSL still and in-app processing imaging. | ||
{@code PRIV}/{@code YUV} | {@code MAXIMUM} | Same as input | {@code MAXIMUM} | {@code YUV} | {@code PREVIEW} | {@code YUV} | {@code PREVIEW} | {@code JPEG} | {@code MAXIMUM} | ZSL in-app processing with still capture. |
FULL-level ({@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL} * {@code == }{@link CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL FULL}) devices * support at least the following stream combinations for creating a reprocessable capture * session in addition to those for * {@link CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED LIMITED} devices: * *
FULL-level additional guaranteed configurations for creating a reprocessable capture session ({@code PRIV} input is guaranteed only if PRIVATE reprocessing is supported. {@code YUV} input is guaranteed only if YUV reprocessing is supported) | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Input | Target 1 | Target 2 | Target 3 | Target 4 | Sample use case(s) | |||||
Type | Max size | Type | Max size | Type | Max size | Type | Max size | Type | Max size | |
{@code YUV} | {@code MAXIMUM} | {@code YUV} | {@code MAXIMUM} | {@code PRIV} | {@code PREVIEW} | Maximum-resolution multi-frame image fusion in-app processing with regular preview. | ||||
{@code YUV} | {@code MAXIMUM} | {@code YUV} | {@code MAXIMUM} | {@code YUV} | {@code PREVIEW} | Maximum-resolution multi-frame image fusion two-input in-app processing. | ||||
{@code PRIV}/{@code YUV} | {@code MAXIMUM} | Same as input | {@code MAXIMUM} | {@code PRIV} | {@code PREVIEW} | {@code YUV} | {@code RECORD} | High-resolution ZSL in-app video processing with regular preview. | ||
{@code PRIV} | {@code MAXIMUM} | {@code PRIV} | {@code MAXIMUM} | {@code PRIV} | {@code PREVIEW} | {@code YUV} | {@code MAXIMUM} | Maximum-resolution ZSL in-app processing with regular preview. | ||
{@code PRIV} | {@code MAXIMUM} | {@code PRIV} | {@code MAXIMUM} | {@code YUV} | {@code PREVIEW} | {@code YUV} | {@code MAXIMUM} | Maximum-resolution two-input ZSL in-app processing. | ||
{@code PRIV}/{@code YUV} | {@code MAXIMUM} | Same as input | {@code MAXIMUM} | {@code PRIV} | {@code PREVIEW} | {@code YUV} | {@code PREVIEW} | {@code JPEG} | {@code MAXIMUM} | ZSL still capture and in-app processing. |
RAW-capability ({@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES} includes * {@link CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_RAW RAW}) devices additionally support * at least the following stream combinations for creating a reprocessable capture session * on both {@link CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL FULL} and * {@link CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED LIMITED} devices * *
RAW-capability additional guaranteed configurations for creating a reprocessable capture session ({@code PRIV} input is guaranteed only if PRIVATE reprocessing is supported. {@code YUV} input is guaranteed only if YUV reprocessing is supported) | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Input | Target 1 | Target 2 | Target 3 | Target 4 | Sample use case(s) | |||||
Type | Max size | Type | Max size | Type | Max size | Type | Max size | Type | Max size | |
{@code PRIV}/{@code YUV} | {@code MAXIMUM} | Same as input | {@code MAXIMUM} | {@code YUV} | {@code PREVIEW} | {@code RAW} | {@code MAXIMUM} | Mutually exclusive ZSL in-app processing and DNG capture. | ||
{@code PRIV}/{@code YUV} | {@code MAXIMUM} | Same as input | {@code MAXIMUM} | {@code PRIV} | {@code PREVIEW} | {@code YUV} | {@code PREVIEW} | {@code RAW} | {@code MAXIMUM} | Mutually exclusive ZSL in-app processing and preview with DNG capture. |
{@code PRIV}/{@code YUV} | {@code MAXIMUM} | Same as input | {@code MAXIMUM} | {@code YUV} | {@code PREVIEW} | {@code YUV} | {@code PREVIEW} | {@code RAW} | {@code MAXIMUM} | Mutually exclusive ZSL two-input in-app processing and DNG capture. |
{@code PRIV}/{@code YUV} | {@code MAXIMUM} | Same as input | {@code MAXIMUM} | {@code PRIV} | {@code PREVIEW} | {@code JPEG} | {@code MAXIMUM} | {@code RAW} | {@code MAXIMUM} | Mutually exclusive ZSL still capture and preview with DNG capture. |
{@code PRIV}/{@code YUV} | {@code MAXIMUM} | Same as input | {@code MAXIMUM} | {@code YUV} | {@code PREVIEW} | {@code JPEG} | {@code MAXIMUM} | {@code RAW} | {@code MAXIMUM} | Mutually exclusive ZSL in-app processing with still capture and DNG capture. |
LEVEL-3 ({@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL} * {@code == }{@link CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_3 LEVEL_3}) devices * support at least the following stream combinations for creating a reprocessable capture * session in addition to those for * {@link CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_FULL FULL} devices. Note that while * the second configuration allows for configuring {@code MAXIMUM} {@code YUV} and {@code JPEG} * outputs at the same time, that configuration is not listed for regular capture sessions, and * therefore simultaneous output to both targets is not allowed. * *
LEVEL-3 additional guaranteed configurations for creating a reprocessable capture session ({@code PRIV} input is guaranteed only if PRIVATE reprocessing is supported. {@code YUV} input is always guaranteed. | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Input | Target 1 | Target 2 | Target 3 | Target 4 | Target 5 | Sample use case(s) | ||||||
Type | Max size | Type | Max size | Type | Max size | Type | Max size | Type | Max size | Type | Max size | |
{@code YUV} | {@code MAXIMUM} | {@code YUV} | {@code MAXIMUM} | {@code PRIV} | {@code PREVIEW} | {@code PRIV} | {@code 640x480} | {@code RAW} | {@code MAXIMUM} | In-app viewfinder analysis with ZSL and RAW. | ||
{@code PRIV}/{@code YUV} | {@code MAXIMUM} | Same as input | {@code MAXIMUM} | {@code PRIV} | {@code PREVIEW} | {@code PRIV} | {@code 640x480} | {@code RAW} | {@code MAXIMUM} | {@code JPEG} | {@code MAXIMUM} | In-app viewfinder analysis with ZSL, RAW, and JPEG reprocessing output. |
Create a new constrained high speed capture session.
* *The application can use normal capture session (created via {@link #createCaptureSession}) * for high speed capture if the desired high speed FPS ranges are advertised by * {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES}, in which case all API * semantics associated with normal capture sessions applies.
* *The method creates a specialized capture session that is only targeted at high speed * video recording (>=120fps) use case if the camera device supports high speed video * capability (i.e., {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES} contains * {@link CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_CONSTRAINED_HIGH_SPEED_VIDEO}). * Therefore, it has special characteristics compared with a normal capture session:
* *Create a {@link CaptureRequest.Builder} for new capture requests, * initialized with template for a target use case. The settings are chosen * to be the best options for the specific camera device, so it is not * recommended to reuse the same request for a different camera device; * create a builder specific for that device and template and override the * settings as desired, instead.
* * @param templateType An enumeration selecting the use case for this request. Not all template * types are supported on every device. See the documentation for each template type for * details. * @return a builder for a capture request, initialized with default * settings for that template, and no output streams * * @throws IllegalArgumentException if the templateType is not supported by * this device. * @throws CameraAccessException if the camera device is no longer connected or has * encountered a fatal error * @throws IllegalStateException if the camera device has been closed * * @see #TEMPLATE_PREVIEW * @see #TEMPLATE_RECORD * @see #TEMPLATE_STILL_CAPTURE * @see #TEMPLATE_VIDEO_SNAPSHOT * @see #TEMPLATE_MANUAL */ @NonNull public abstract CaptureRequest.Builder createCaptureRequest(@RequestTemplate int templateType) throws CameraAccessException; /** *Create a {@link CaptureRequest.Builder} for a new reprocess {@link CaptureRequest} from a * {@link TotalCaptureResult}. * *
Each reprocess {@link CaptureRequest} processes one buffer from * {@link CameraCaptureSession}'s input {@link Surface} to all output {@link Surface Surfaces} * included in the reprocess capture request. The reprocess input images must be generated from * one or multiple output images captured from the same camera device. The application can * provide input images to camera device via {@link android.media.ImageWriter#queueInputImage}. * The application must use the capture result of one of those output images to create a * reprocess capture request so that the camera device can use the information to achieve * optimal reprocess image quality. For camera devices that support only 1 output * {@link Surface}, submitting a reprocess {@link CaptureRequest} with multiple * output targets will result in a {@link CaptureFailure}. * * @param inputResult The capture result of the output image or one of the output images used * to generate the reprocess input image for this capture request. * * @throws IllegalArgumentException if inputResult is null. * @throws CameraAccessException if the camera device is no longer connected or has * encountered a fatal error * @throws IllegalStateException if the camera device has been closed * * @see CaptureRequest.Builder * @see TotalCaptureResult * @see CameraDevice#createReprocessableCaptureSession * @see android.media.ImageWriter */ @NonNull public abstract CaptureRequest.Builder createReprocessCaptureRequest( @NonNull TotalCaptureResult inputResult) throws CameraAccessException; /** * Close the connection to this camera device as quickly as possible. * *
Immediately after this call, all calls to the camera device or active session interface * will throw a {@link IllegalStateException}, except for calls to close(). Once the device has * fully shut down, the {@link StateCallback#onClosed} callback will be called, and the camera * is free to be re-opened.
* *Immediately after this call, besides the final {@link StateCallback#onClosed} calls, no * further callbacks from the device or the active session will occur, and any remaining * submitted capture requests will be discarded, as if * {@link CameraCaptureSession#abortCaptures} had been called, except that no success or failure * callbacks will be invoked.
* */ @Override public abstract void close(); /** * A callback objects for receiving updates about the state of a camera device. * *A callback instance must be provided to the {@link CameraManager#openCamera} method to * open a camera device.
* *These state updates include notifications about the device completing startup ( * allowing for {@link #createCaptureSession} to be called), about device * disconnection or closure, and about unexpected device errors.
* *Events about the progress of specific {@link CaptureRequest CaptureRequests} are provided * through a {@link CameraCaptureSession.CaptureCallback} given to the * {@link CameraCaptureSession#capture}, {@link CameraCaptureSession#captureBurst}, * {@link CameraCaptureSession#setRepeatingRequest}, or * {@link CameraCaptureSession#setRepeatingBurst} methods. * * @see CameraManager#openCamera */ public static abstract class StateCallback { /** * An error code that can be reported by {@link #onError} * indicating that the camera device is in use already. * *
* This error can be produced when opening the camera fails due to the camera * being used by a higher-priority camera API client. *
* * @see #onError */ public static final int ERROR_CAMERA_IN_USE = 1; /** * An error code that can be reported by {@link #onError} * indicating that the camera device could not be opened * because there are too many other open camera devices. * ** The system-wide limit for number of open cameras has been reached, * and more camera devices cannot be opened until previous instances are * closed. *
* ** This error can be produced when opening the camera fails. *
* * @see #onError */ public static final int ERROR_MAX_CAMERAS_IN_USE = 2; /** * An error code that can be reported by {@link #onError} * indicating that the camera device could not be opened due to a device * policy. * * @see android.app.admin.DevicePolicyManager#setCameraDisabled(android.content.ComponentName, boolean) * @see #onError */ public static final int ERROR_CAMERA_DISABLED = 3; /** * An error code that can be reported by {@link #onError} * indicating that the camera device has encountered a fatal error. * *The camera device needs to be re-opened to be used again.
* * @see #onError */ public static final int ERROR_CAMERA_DEVICE = 4; /** * An error code that can be reported by {@link #onError} * indicating that the camera service has encountered a fatal error. * *The Android device may need to be shut down and restarted to restore * camera function, or there may be a persistent hardware problem.
* *An attempt at recovery may be possible by closing the * CameraDevice and the CameraManager, and trying to acquire all resources * again from scratch.
* * @see #onError */ public static final int ERROR_CAMERA_SERVICE = 5; /** @hide */ @Retention(RetentionPolicy.SOURCE) @IntDef(prefix = {"ERROR_"}, value = {ERROR_CAMERA_IN_USE, ERROR_MAX_CAMERAS_IN_USE, ERROR_CAMERA_DISABLED, ERROR_CAMERA_DEVICE, ERROR_CAMERA_SERVICE }) public @interface ErrorCode {}; /** * The method called when a camera device has finished opening. * *At this point, the camera device is ready to use, and * {@link CameraDevice#createCaptureSession} can be called to set up the first capture * session.
* * @param camera the camera device that has become opened */ public abstract void onOpened(@NonNull CameraDevice camera); // Must implement /** * The method called when a camera device has been closed with * {@link CameraDevice#close}. * *Any attempt to call methods on this CameraDevice in the * future will throw a {@link IllegalStateException}.
* *The default implementation of this method does nothing.
* * @param camera the camera device that has become closed */ public void onClosed(@NonNull CameraDevice camera) { // Default empty implementation } /** * The method called when a camera device is no longer available for * use. * *This callback may be called instead of {@link #onOpened} * if opening the camera fails.
* *Any attempt to call methods on this CameraDevice will throw a * {@link CameraAccessException}. The disconnection could be due to a * change in security policy or permissions; the physical disconnection * of a removable camera device; or the camera being needed for a * higher-priority camera API client.
* *There may still be capture callbacks that are invoked * after this method is called, or new image buffers that are delivered * to active outputs.
* *The default implementation logs a notice to the system log * about the disconnection.
* *You should clean up the camera with {@link CameraDevice#close} after * this happens, as it is not recoverable until the camera can be opened * again. For most use cases, this will be when the camera again becomes * {@link CameraManager.AvailabilityCallback#onCameraAvailable available}. *
* * @param camera the device that has been disconnected */ public abstract void onDisconnected(@NonNull CameraDevice camera); // Must implement /** * The method called when a camera device has encountered a serious error. * *This callback may be called instead of {@link #onOpened} * if opening the camera fails.
* *This indicates a failure of the camera device or camera service in * some way. Any attempt to call methods on this CameraDevice in the * future will throw a {@link CameraAccessException} with the * {@link CameraAccessException#CAMERA_ERROR CAMERA_ERROR} reason. *
* *There may still be capture completion or camera stream callbacks * that will be called after this error is received.
* *You should clean up the camera with {@link CameraDevice#close} after * this happens. Further attempts at recovery are error-code specific.
* * @param camera The device reporting the error * @param error The error code. * * @see #ERROR_CAMERA_IN_USE * @see #ERROR_MAX_CAMERAS_IN_USE * @see #ERROR_CAMERA_DISABLED * @see #ERROR_CAMERA_DEVICE * @see #ERROR_CAMERA_SERVICE */ public abstract void onError(@NonNull CameraDevice camera, @ErrorCode int error); // Must implement } /** * To be inherited by android.hardware.camera2.* code only. * @hide */ public CameraDevice() {} }