/* * Copyright (C) 2012 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.graphics.Point; import android.graphics.Rect; import android.hardware.camera2.impl.CameraMetadataNative; /** *
The results of a single image capture from the image sensor.
* *Contains the final configuration for the capture hardware (sensor, lens, * flash), the processing pipeline, the control algorithms, and the output * buffers.
* *CaptureResults are produced by a {@link CameraDevice} after processing a * {@link CaptureRequest}. All properties listed for capture requests can also * be queried on the capture result, to determine the final values used for * capture. The result also includes additional metadata about the state of the * camera device during the capture.
* */ public final class CaptureResult extends CameraMetadata { private final CameraMetadataNative mResults; private final CaptureRequest mRequest; private final int mSequenceId; /** * Takes ownership of the passed-in properties object * @hide */ public CaptureResult(CameraMetadataNative results, CaptureRequest parent, int sequenceId) { if (results == null) { throw new IllegalArgumentException("results was null"); } if (parent == null) { throw new IllegalArgumentException("parent was null"); } mResults = results; mRequest = parent; mSequenceId = sequenceId; } @Override publicWhenever a request is successfully captured, with * {@link CameraDevice.CaptureListener#onCaptureCompleted}, * the {@code result}'s {@code getRequest()} will return that {@code request}. *
* *In particular,
*
* cameraDevice.capture(someRequest, new CaptureListener() {
* {@literal @}Override
* void onCaptureCompleted(CaptureRequest myRequest, CaptureResult myResult) {
* assert(myResult.getRequest.equals(myRequest) == true);
* }
* };
*
Whenever a request has been processed, regardless of failure or success, * it gets a unique frame number assigned to its future result/failure.
* *This value monotonically increments, starting with 0, * for every new result or failure; and the scope is the lifetime of the * {@link CameraDevice}.
* * @return int frame number */ public int getFrameNumber() { return get(REQUEST_FRAME_COUNT); } /** * The sequence ID for this failure that was returned by the * {@link CameraDevice#capture} family of functions. * *The sequence ID is a unique monotonically increasing value starting from 0, * incremented every time a new group of requests is submitted to the CameraDevice.
* * @return int The ID for the sequence of requests that this capture result is a part of * * @see CameraDevice.CaptureListener#onCaptureSequenceCompleted */ public int getSequenceId() { return mSequenceId; } /*@O~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ * The key entries below this point are generated from metadata * definitions in /system/media/camera/docs. Do not modify by hand or * modify the comment blocks at the start or end. *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/ /** ** A color transform matrix to use to transform * from sensor RGB color space to output linear sRGB color space *
** This matrix is either set by HAL when the request * android.colorCorrection.mode is not TRANSFORM_MATRIX, or * directly by the application in the request when the * android.colorCorrection.mode is TRANSFORM_MATRIX. *
* In the latter case, the HAL may round the matrix to account * for precision issues; the final rounded matrix should be * reported back in this matrix result metadata. *
*/ public static final Key* Gains applying to Bayer color channels for * white-balance *
** The 4-channel white-balance gains are defined in * the order of [R G_even G_odd B], where G_even is the gain * for green pixels on even rows of the output, and G_odd * is the gain for greenpixels on the odd rows. if a HAL * does not support a separate gain for even/odd green channels, * it should use the G_even value,and write G_odd equal to * G_even in the output result metadata. *
* This array is either set by HAL when the request * android.colorCorrection.mode is not TRANSFORM_MATRIX, or * directly by the application in the request when the * android.colorCorrection.mode is TRANSFORM_MATRIX. *
* The ouput should be the gains actually applied by the HAL to * the current frame. *
*/ public static final Key* The ID sent with the latest * CAMERA2_TRIGGER_PRECAPTURE_METERING call *
** Must be 0 if no * CAMERA2_TRIGGER_PRECAPTURE_METERING trigger received yet * by HAL. Always updated even if AE algorithm ignores the * trigger *
* * @hide */ public static final Key* List of areas to use for * metering *
** Each area is a rectangle plus weight: xmin, ymin, * xmax, ymax, weight. The rectangle is defined inclusive of the * specified coordinates. *
* The coordinate system is based on the active pixel array, * with (0,0) being the top-left pixel in the active pixel array, and * (android.sensor.info.activeArraySize.width - 1, * android.sensor.info.activeArraySize.height - 1) being the * bottom-right pixel in the active pixel array. The weight * should be nonnegative. *
* If all regions have 0 weight, then no specific metering area * needs to be used by the HAL. If the metering region is * outside the current android.scaler.cropRegion, the HAL * should ignore the sections outside the region and output the * used sections in the frame metadata *
*/ public static final Key* Current state of AE algorithm *
** Whenever the AE algorithm state changes, a * MSG_AUTOEXPOSURE notification must be send if a * notification callback is registered. *
* @see #CONTROL_AE_STATE_INACTIVE * @see #CONTROL_AE_STATE_SEARCHING * @see #CONTROL_AE_STATE_CONVERGED * @see #CONTROL_AE_STATE_LOCKED * @see #CONTROL_AE_STATE_FLASH_REQUIRED * @see #CONTROL_AE_STATE_PRECAPTURE */ public static final Key* Whether AF is currently enabled, and what * mode it is set to *
* @see #CONTROL_AF_MODE_OFF * @see #CONTROL_AF_MODE_AUTO * @see #CONTROL_AF_MODE_MACRO * @see #CONTROL_AF_MODE_CONTINUOUS_VIDEO * @see #CONTROL_AF_MODE_CONTINUOUS_PICTURE * @see #CONTROL_AF_MODE_EDOF */ public static final Key* List of areas to use for focus * estimation *
** Each area is a rectangle plus weight: xmin, ymin, * xmax, ymax, weight. The rectangle is defined inclusive of the * specified coordinates. *
* The coordinate system is based on the active pixel array, * with (0,0) being the top-left pixel in the active pixel array, and * (android.sensor.info.activeArraySize.width - 1, * android.sensor.info.activeArraySize.height - 1) being the * bottom-right pixel in the active pixel array. The weight * should be nonnegative. *
* If all regions have 0 weight, then no specific focus area * needs to be used by the HAL. If the focusing region is * outside the current android.scaler.cropRegion, the HAL * should ignore the sections outside the region and output the * used sections in the frame metadata *
*/ public static final Key* Current state of AF algorithm *
** Whenever the AF algorithm state changes, a * MSG_AUTOFOCUS notification must be send if a notification * callback is registered. *
* @see #CONTROL_AF_STATE_INACTIVE * @see #CONTROL_AF_STATE_PASSIVE_SCAN * @see #CONTROL_AF_STATE_PASSIVE_FOCUSED * @see #CONTROL_AF_STATE_ACTIVE_SCAN * @see #CONTROL_AF_STATE_FOCUSED_LOCKED * @see #CONTROL_AF_STATE_NOT_FOCUSED_LOCKED * @see #CONTROL_AF_STATE_PASSIVE_UNFOCUSED */ public static final Key* The ID sent with the latest * CAMERA2_TRIGGER_AUTOFOCUS call *
** Must be 0 if no CAMERA2_TRIGGER_AUTOFOCUS trigger * received yet by HAL. Always updated even if AF algorithm * ignores the trigger *
* * @hide */ public static final Key* Whether AWB is currently setting the color * transform fields, and what its illumination target * is *
** [BC - AWB lock,AWB modes] *
* @see #CONTROL_AWB_MODE_OFF * @see #CONTROL_AWB_MODE_AUTO * @see #CONTROL_AWB_MODE_INCANDESCENT * @see #CONTROL_AWB_MODE_FLUORESCENT * @see #CONTROL_AWB_MODE_WARM_FLUORESCENT * @see #CONTROL_AWB_MODE_DAYLIGHT * @see #CONTROL_AWB_MODE_CLOUDY_DAYLIGHT * @see #CONTROL_AWB_MODE_TWILIGHT * @see #CONTROL_AWB_MODE_SHADE */ public static final Key* List of areas to use for illuminant * estimation *
** Only used in AUTO mode. *
* Each area is a rectangle plus weight: xmin, ymin, * xmax, ymax, weight. The rectangle is defined inclusive of the * specified coordinates. *
* The coordinate system is based on the active pixel array, * with (0,0) being the top-left pixel in the active pixel array, and * (android.sensor.info.activeArraySize.width - 1, * android.sensor.info.activeArraySize.height - 1) being the * bottom-right pixel in the active pixel array. The weight * should be nonnegative. *
* If all regions have 0 weight, then no specific metering area * needs to be used by the HAL. If the metering region is * outside the current android.scaler.cropRegion, the HAL * should ignore the sections outside the region and output the * used sections in the frame metadata *
*/ public static final Key* Current state of AWB algorithm *
** Whenever the AWB algorithm state changes, a * MSG_AUTOWHITEBALANCE notification must be send if a * notification callback is registered. *
* @see #CONTROL_AWB_STATE_INACTIVE * @see #CONTROL_AWB_STATE_SEARCHING * @see #CONTROL_AWB_STATE_CONVERGED * @see #CONTROL_AWB_STATE_LOCKED */ public static final Key* Overall mode of 3A control * routines *
* @see #CONTROL_MODE_OFF * @see #CONTROL_MODE_AUTO * @see #CONTROL_MODE_USE_SCENE_MODE */ public static final Key* Operation mode for edge * enhancement *
* @see #EDGE_MODE_OFF * @see #EDGE_MODE_FAST * @see #EDGE_MODE_HIGH_QUALITY */ public static final Key* Select flash operation mode *
* @see #FLASH_MODE_OFF * @see #FLASH_MODE_SINGLE * @see #FLASH_MODE_TORCH */ public static final Key* Current state of the flash * unit *
* @see #FLASH_STATE_UNAVAILABLE * @see #FLASH_STATE_CHARGING * @see #FLASH_STATE_READY * @see #FLASH_STATE_FIRED */ public static final Key* GPS coordinates to include in output JPEG * EXIF *
*/ public static final Key* 32 characters describing GPS algorithm to * include in EXIF *
*/ public static final Key* Time GPS fix was made to include in * EXIF *
*/ public static final Key* Orientation of JPEG image to * write *
*/ public static final Key* Compression quality of the final JPEG * image *
** 85-95 is typical usage range *
*/ public static final Key* Compression quality of JPEG * thumbnail *
*/ public static final Key* Resolution of embedded JPEG * thumbnail *
*/ public static final Key* Size of the lens aperture *
** Will not be supported on most devices. Can only * pick from supported list *
*/ public static final Key* State of lens neutral density * filter(s) *
** Will not be supported on most devices. Can only * pick from supported list *
*/ public static final Key* Lens optical zoom setting *
** Will not be supported on most devices. *
*/ public static final Key* Distance to plane of sharpest focus, * measured from frontmost surface of the lens *
** Should be zero for fixed-focus cameras *
*/ public static final Key* The range of scene distances that are in * sharp focus (depth of field) *
** If variable focus not supported, can still report * fixed depth of field range *
*/ public static final Key* Whether optical image stabilization is * enabled. *
** Will not be supported on most devices. *
* @see #LENS_OPTICAL_STABILIZATION_MODE_OFF * @see #LENS_OPTICAL_STABILIZATION_MODE_ON */ public static final Key* Current lens status *
* @see #LENS_STATE_STATIONARY * @see #LENS_STATE_MOVING */ public static final Key* Mode of operation for the noise reduction * algorithm *
* @see #NOISE_REDUCTION_MODE_OFF * @see #NOISE_REDUCTION_MODE_FAST * @see #NOISE_REDUCTION_MODE_HIGH_QUALITY */ public static final Key* Whether a result given to the framework is the * final one for the capture, or only a partial that contains a * subset of the full set of dynamic metadata * values. *
** The entries in the result metadata buffers for a * single capture may not overlap, except for this entry. The * FINAL buffers must retain FIFO ordering relative to the * requests that generate them, so the FINAL buffer for frame 3 must * always be sent to the framework after the FINAL buffer for frame 2, and * before the FINAL buffer for frame 4. PARTIAL buffers may be returned * in any order relative to other frames, but all PARTIAL buffers for a given * capture must arrive before the FINAL buffer for that capture. This entry may * only be used by the HAL if quirks.usePartialResult is set to 1. *
* * Optional - This value may be null on some devices. * * @hide */ public static final Key* A frame counter set by the framework. This value monotonically * increases with every new result (that is, each new result has a unique * frameCount value). *
** Reset on release() *
*/ public static final Key* An application-specified ID for the current * request. Must be maintained unchanged in output * frame *
* * @hide */ public static final Key* (x, y, width, height). *
* A rectangle with the top-level corner of (x,y) and size * (width, height). The region of the sensor that is used for * output. Each stream must use this rectangle to produce its * output, cropping to a smaller region if necessary to * maintain the stream's aspect ratio. *
* HAL2.x uses only (x, y, width) *
** Any additional per-stream cropping must be done to * maximize the final pixel area of the stream. *
* For example, if the crop region is set to a 4:3 aspect * ratio, then 4:3 streams should use the exact crop * region. 16:9 streams should further crop vertically * (letterbox). *
* Conversely, if the crop region is set to a 16:9, then 4:3 * outputs should crop horizontally (pillarbox), and 16:9 * streams should match exactly. These additional crops must * be centered within the crop region. *
* The output streams must maintain square pixels at all * times, no matter what the relative aspect ratios of the * crop region and the stream are. Negative values for * corner are allowed for raw output if full pixel array is * larger than active pixel array. Width and height may be * rounded to nearest larger supportable width, especially * for raw output, where only a few fixed scales may be * possible. The width and height of the crop region cannot * be set to be smaller than floor( activeArraySize.width / * android.scaler.maxDigitalZoom ) and floor( * activeArraySize.height / android.scaler.maxDigitalZoom), * respectively. *
*/ public static final Key* Duration each pixel is exposed to * light. *
* If the sensor can't expose this exact duration, it should shorten the * duration exposed to the nearest possible value (rather than expose longer). *
** 1/10000 - 30 sec range. No bulb mode *
*/ public static final Key* Duration from start of frame exposure to * start of next frame exposure *
** Exposure time has priority, so duration is set to * max(duration, exposure time + overhead) *
*/ public static final Key* Gain applied to image data. Must be * implemented through analog gain only if set to values * below 'maximum analog sensitivity'. *
* If the sensor can't apply this exact gain, it should lessen the * gain to the nearest possible value (rather than gain more). *
** ISO 12232:2006 REI method *
*/ public static final Key* Time at start of exposure of first * row *
** Monotonic, should be synced to other timestamps in * system *
*/ public static final Key* The temperature of the sensor, sampled at the time * exposure began for this frame. *
* The thermal diode being queried should be inside the sensor PCB, or * somewhere close to it. *
* * Optional - This value may be null on some devices. * * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} - * Present on all devices that report being FULL level hardware devices in the * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL HARDWARE_LEVEL} key. */ public static final Key* State of the face detector * unit *
** Whether face detection is enabled, and whether it * should output just the basic fields or the full set of * fields. Value must be one of the * android.statistics.info.availableFaceDetectModes. *
* @see #STATISTICS_FACE_DETECT_MODE_OFF * @see #STATISTICS_FACE_DETECT_MODE_SIMPLE * @see #STATISTICS_FACE_DETECT_MODE_FULL */ public static final Key* List of unique IDs for detected * faces *
** Only available if faceDetectMode == FULL *
*/ public static final Key* List of landmarks for detected * faces *
** Only available if faceDetectMode == FULL *
*/ public static final Key* List of the bounding rectangles for detected * faces *
** Only available if faceDetectMode != OFF *
*/ public static final Key* List of the face confidence scores for * detected faces *
** Only available if faceDetectMode != OFF. The value should be * meaningful (for example, setting 100 at all times is illegal). *
*/ public static final Key* A low-resolution map of lens shading, per * color channel *
** Assume bilinear interpolation of map. The least * shaded section of the image should have a gain factor * of 1; all other sections should have gains above 1. * the map should be on the order of 30-40 rows, and * must be smaller than 64x64. *
* When android.colorCorrection.mode = TRANSFORM_MATRIX, the map * must take into account the colorCorrection settings. *
*/ public static final Key* The best-fit color channel gains calculated * by the HAL's statistics units for the current output frame *
** This may be different than the gains used for this frame, * since statistics processing on data from a new frame * typically completes after the transform has already been * applied to that frame. *
* The 4 channel gains are defined in Bayer domain, * see android.colorCorrection.gains for details. *
* This value should always be calculated by the AWB block, * regardless of the android.control.* current values. *
*/ public static final Key* The best-fit color transform matrix estimate * calculated by the HAL's statistics units for the current * output frame *
** The HAL must provide the estimate from its * statistics unit on the white balance transforms to use * for the next frame. These are the values the HAL believes * are the best fit for the current output frame. This may * be different than the transform used for this frame, since * statistics processing on data from a new frame typically * completes after the transform has already been applied to * that frame. *
* These estimates must be provided for all frames, even if * capture settings and color transforms are set by the application. *
* This value should always be calculated by the AWB block, * regardless of the android.control.* current values. *
*/ public static final Key* The HAL estimated scene illumination lighting * frequency *
** Report NONE if there doesn't appear to be flickering * illumination *
* @see #STATISTICS_SCENE_FLICKER_NONE * @see #STATISTICS_SCENE_FLICKER_50HZ * @see #STATISTICS_SCENE_FLICKER_60HZ */ public static final Key* Table mapping blue input values to output * values *
** Tonemapping / contrast / gamma curve for the blue * channel, to use when android.tonemap.mode is CONTRAST_CURVE. *
* See android.tonemap.curveRed for more details. *
*/ public static final Key* Table mapping green input values to output * values *
** Tonemapping / contrast / gamma curve for the green * channel, to use when android.tonemap.mode is CONTRAST_CURVE. *
* See android.tonemap.curveRed for more details. *
*/ public static final Key* Table mapping red input values to output * values *
** Tonemapping / contrast / gamma curve for the red * channel, to use when android.tonemap.mode is CONTRAST_CURVE. *
* Since the input and output ranges may vary depending on * the camera pipeline, the input and output pixel values * are represented by normalized floating-point values * between 0 and 1, with 0 == black and 1 == white. *
* The curve should be linearly interpolated between the * defined points. The points will be listed in increasing * order of P_IN. For example, if the array is: [0.0, 0.0, * 0.3, 0.5, 1.0, 1.0], then the input->output mapping * for a few sample points would be: 0 -> 0, 0.15 -> * 0.25, 0.3 -> 0.5, 0.5 -> 0.64 *
*/ public static final Key* This LED is nominally used to indicate to the user * that the camera is powered on and may be streaming images back to the * Application Processor. In certain rare circumstances, the OS may * disable this when video is processed locally and not transmitted to * any untrusted applications. *
* In particular, the LED *must* always be on when the data could be * transmitted off the device. The LED *should* always be on whenever * data is stored locally on the device. *
* The LED *may* be off if a trusted application is using the data that * doesn't violate the above rules. *
* * @hide */ public static final Key* Whether black-level compensation is locked * to its current values, or is free to vary *
** When set to ON, the values used for black-level * compensation must not change until the lock is set to * OFF *
* Since changes to certain capture parameters (such as * exposure time) may require resetting of black level * compensation, the HAL must report whether setting the * black level lock was successful in the output result * metadata. *
* The black level locking must happen at the sensor, and not at the ISP. * If for some reason black level locking is no longer legal (for example, * the analog gain has changed, which forces black levels to be * recalculated), then the HAL is free to override this request (and it * must report 'OFF' when this does happen) until the next time locking * is legal again. *
*/ public static final Key* List of the {@link Face Faces} detected through camera face detection * in this result. *
** Only available if {@link #STATISTICS_FACE_DETECT_MODE} {@code !=} * {@link CameraMetadata#STATISTICS_FACE_DETECT_MODE_OFF OFF}. *
* * @see Face */ public static final Key