CameraMetadata

Color correction processing must not slow down capture rate relative to sensor raw output.

Advanced white balance adjustments above and beyond the specified white balance pipeline may be applied.

If AWB is enabled with android.control.awbMode != OFF, then the camera device uses the last frame's AWB values (or defaults if AWB has never been run).

Color correction processing operates at improved quality but reduced capture rate (relative to sensor raw output).

Advanced white balance adjustments above and beyond the specified white balance pipeline may be applied.

If AWB is enabled with android.control.awbMode != OFF, then the camera device uses the last frame's AWB values (or defaults if AWB has never been run).

Use the android.colorCorrection.transform matrix and android.colorCorrection.gains to do color conversion.

All advanced white balance adjustments (not specified by our white balance pipeline) must be disabled.

If AWB is enabled with android.control.awbMode != OFF, then TRANSFORM_MATRIX is ignored. The camera device will override this value to either FAST or HIGH_QUALITY.

The camera device will adjust exposure duration to avoid banding problems with 50Hz illumination sources.

The camera device will adjust exposure duration to avoid banding problems with 60Hz illumination sources.

The camera device will automatically adapt its antibanding routine to the current illumination conditions. This is the default.

The camera device will not adjust exposure duration to avoid banding problems.

The camera device's autoexposure routine is disabled.

The application-selected android.sensor.exposureTime, android.sensor.sensitivity and android.sensor.frameDuration are used by the camera device, along with android.flash.* fields, if there's a flash unit for this camera device.

The camera device's autoexposure routine is active, with no flash control.

The application's values for android.sensor.exposureTime, android.sensor.sensitivity, and android.sensor.frameDuration are ignored. The application has control over the various android.flash.* fields.

Like ON, except that the camera device also controls the camera's flash unit, always firing it for still captures.

The flash may be fired during a precapture sequence (triggered by android.control.aePrecaptureTrigger) and will always be fired for captures for which the android.control.captureIntent field is set to STILL_CAPTURE

Like ON, except that the camera device also controls the camera's flash unit, firing it in low-light conditions.

The flash may be fired during a precapture sequence (triggered by android.control.aePrecaptureTrigger) and may be fired for captures for which the android.control.captureIntent field is set to STILL_CAPTURE

Like ON_AUTO_FLASH, but with automatic red eye reduction.

If deemed necessary by the camera device, a red eye reduction flash will fire during the precapture sequence.

The trigger is idle.

The precapture metering sequence will be started by the camera device.

The exact effect of the precapture trigger depends on the current AE mode and state.

AE has a good set of control values for the current scene.

AE has a good set of control values, but flash needs to be fired for good quality still capture.

AE is off or recently reset.

When a camera device is opened, it starts in this state. This is a transient state, the camera device may skip reporting this state in capture result.

AE has been locked.

AE has been asked to do a precapture sequence and is currently executing it.

Precapture can be triggered through setting android.control.aePrecaptureTrigger to START.

Once PRECAPTURE completes, AE will transition to CONVERGED or FLASH_REQUIRED as appropriate. This is a transient state, the camera device may skip reporting this state in capture result.

AE doesn't yet have a good set of control values for the current scene.

This is a transient state, the camera device may skip reporting this state in capture result.

Basic automatic focus mode.

In this mode, the lens does not move unless the autofocus trigger action is called. When that trigger is activated, AF will transition to ACTIVE_SCAN, then to the outcome of the scan (FOCUSED or NOT_FOCUSED).

Always supported if lens is not fixed focus.

Use android.lens.info.minimumFocusDistance to determine if lens is fixed-focus.

Triggering AF_CANCEL resets the lens position to default, and sets the AF state to INACTIVE.

In this mode, the AF algorithm modifies the lens position continually to attempt to provide a constantly-in-focus image stream.

The focusing behavior should be suitable for still image capture; typically this means focusing as fast as possible. When the AF trigger is not involved, the AF algorithm should start in INACTIVE state, and then transition into PASSIVE_SCAN and PASSIVE_FOCUSED states as appropriate as it attempts to maintain focus. When the AF trigger is activated, the algorithm should finish its PASSIVE_SCAN if active, and then transition into AF_FOCUSED or AF_NOT_FOCUSED as appropriate, and lock the lens position until a cancel AF trigger is received.

When the AF cancel trigger is activated, the algorithm should transition back to INACTIVE and then act as if it has just been started.

In this mode, the AF algorithm modifies the lens position continually to attempt to provide a constantly-in-focus image stream.

The focusing behavior should be suitable for good quality video recording; typically this means slower focus movement and no overshoots. When the AF trigger is not involved, the AF algorithm should start in INACTIVE state, and then transition into PASSIVE_SCAN and PASSIVE_FOCUSED states as appropriate. When the AF trigger is activated, the algorithm should immediately transition into AF_FOCUSED or AF_NOT_FOCUSED as appropriate, and lock the lens position until a cancel AF trigger is received.

Once cancel is received, the algorithm should transition back to INACTIVE and resume passive scan. Note that this behavior is not identical to CONTINUOUS_PICTURE, since an ongoing PASSIVE_SCAN must immediately be canceled.

Extended depth of field (digital focus) mode.

The camera device will produce images with an extended depth of field automatically; no special focusing operations need to be done before taking a picture.

AF triggers are ignored, and the AF state will always be INACTIVE.

Close-up focusing mode.

In this mode, the lens does not move unless the autofocus trigger action is called. When that trigger is activated, AF will transition to ACTIVE_SCAN, then to the outcome of the scan (FOCUSED or NOT_FOCUSED). This mode is optimized for focusing on objects very close to the camera.

When that trigger is activated, AF will transition to ACTIVE_SCAN, then to the outcome of the scan (FOCUSED or NOT_FOCUSED). Triggering cancel AF resets the lens position to default, and sets the AF state to INACTIVE.

The auto-focus routine does not control the lens; android.lens.focusDistance is controlled by the application.

AF is performing an AF scan because it was triggered by AF trigger.

Only used by AUTO or MACRO AF modes. This is a transient state, the camera device may skip reporting this state in capture result.

AF believes it is focused correctly and has locked focus.

This state is reached only after an explicit START AF trigger has been sent (android.control.afTrigger), when good focus has been obtained.

The lens will remain stationary until the AF mode (android.control.afMode) is changed or a new AF trigger is sent to the camera device (android.control.afTrigger).

AF is off or has not yet tried to scan/been asked to scan.

When a camera device is opened, it starts in this state. This is a transient state, the camera device may skip reporting this state in capture result.

AF has failed to focus successfully and has locked focus.

This state is reached only after an explicit START AF trigger has been sent (android.control.afTrigger), when good focus cannot be obtained.

The lens will remain stationary until the AF mode (android.control.afMode) is changed or a new AF trigger is sent to the camera device (android.control.afTrigger).

AF currently believes it is in focus, but may restart scanning at any time.

Only used by CONTINUOUS_* AF modes. This is a transient state, the camera device may skip reporting this state in capture result.

AF is currently performing an AF scan initiated the camera device in a continuous autofocus mode.

Only used by CONTINUOUS_* AF modes. This is a transient state, the camera device may skip reporting this state in capture result.

AF finished a passive scan without finding focus, and may restart scanning at any time.

Only used by CONTINUOUS_* AF modes. This is a transient state, the camera device may skip reporting this state in capture result.

Autofocus will return to its initial state, and cancel any currently active trigger.

The trigger is idle.

Autofocus will trigger now.

The camera device's auto-white balance routine is active.

The application's values for android.colorCorrection.transform and android.colorCorrection.gains are ignored. For devices that support the MANUAL_POST_PROCESSING capability, the values used by the camera device for the transform and gains will be available in the capture result for this request.

The camera device's auto-white balance routine is disabled; the camera device uses cloudy daylight light as the assumed scene illumination for white balance.

The application's values for android.colorCorrection.transform and android.colorCorrection.gains are ignored. For devices that support the MANUAL_POST_PROCESSING capability, the values used by the camera device for the transform and gains will be available in the capture result for this request.

The camera device's auto-white balance routine is disabled; the camera device uses daylight light as the assumed scene illumination for white balance.

While the exact white balance transforms are up to the camera device, they will approximately match the CIE standard illuminant D65.

The application's values for android.colorCorrection.transform and android.colorCorrection.gains are ignored. For devices that support the MANUAL_POST_PROCESSING capability, the values used by the camera device for the transform and gains will be available in the capture result for this request.

The camera device's auto-white balance routine is disabled; the camera device uses fluorescent light as the assumed scene illumination for white balance.

While the exact white balance transforms are up to the camera device, they will approximately match the CIE standard illuminant F2.

The application's values for android.colorCorrection.transform and android.colorCorrection.gains are ignored. For devices that support the MANUAL_POST_PROCESSING capability, the values used by the camera device for the transform and gains will be available in the capture result for this request.

The camera device's auto-white balance routine is disabled; the camera device uses incandescent light as the assumed scene illumination for white balance.

While the exact white balance transforms are up to the camera device, they will approximately match the CIE standard illuminant A.

The application's values for android.colorCorrection.transform and android.colorCorrection.gains are ignored. For devices that support the MANUAL_POST_PROCESSING capability, the values used by the camera device for the transform and gains will be available in the capture result for this request.

The camera device's auto-white balance routine is disabled.

The application-selected color transform matrix (android.colorCorrection.transform) and gains (android.colorCorrection.gains) are used by the camera device for manual white balance control.

The camera device's auto-white balance routine is disabled; the camera device uses shade light as the assumed scene illumination for white balance.

The application's values for android.colorCorrection.transform and android.colorCorrection.gains are ignored. For devices that support the MANUAL_POST_PROCESSING capability, the values used by the camera device for the transform and gains will be available in the capture result for this request.

The camera device's auto-white balance routine is disabled; the camera device uses twilight light as the assumed scene illumination for white balance.

The application's values for android.colorCorrection.transform and android.colorCorrection.gains are ignored. For devices that support the MANUAL_POST_PROCESSING capability, the values used by the camera device for the transform and gains will be available in the capture result for this request.

The camera device's auto-white balance routine is disabled; the camera device uses warm fluorescent light as the assumed scene illumination for white balance.

While the exact white balance transforms are up to the camera device, they will approximately match the CIE standard illuminant F4.

The application's values for android.colorCorrection.transform and android.colorCorrection.gains are ignored. For devices that support the MANUAL_POST_PROCESSING capability, the values used by the camera device for the transform and gains will be available in the capture result for this request.

AWB has a good set of control values for the current scene.

AWB is not in auto mode, or has not yet started metering.

When a camera device is opened, it starts in this state. This is a transient state, the camera device may skip reporting this state in capture result.

AWB has been locked.

AWB doesn't yet have a good set of control values for the current scene.

This is a transient state, the camera device may skip reporting this state in capture result.

The goal of this request doesn't fall into the other categories. The camera device will default to preview-like behavior.

This request is for manual capture use case where the applications want to directly control the capture parameters.

For example, the application may wish to manually control android.sensor.exposureTime, android.sensor.sensitivity, etc.

This request is for a preview-like use case.

The precapture trigger may be used to start off a metering w/flash sequence.

This request is for a still capture-type use case.

If the flash unit is under automatic control, it may fire as needed.

This request is for a video recording use case.

This request is for a video snapshot (still image while recording video) use case.

The camera device should take the highest-quality image possible (given the other settings) without disrupting the frame rate of video recording.

This request is for a ZSL usecase; the application will stream full-resolution images and reprocess one or several later for a final capture.

An "aqua" effect where a blue hue is added to the image.

A "blackboard" effect where the image is typically displayed as regions of black, with white or grey details.

A "monocolor" effect where the image is mapped into a single color.

This will typically be grayscale.

A "photo-negative" effect where the image's colors are inverted.

No color effect will be applied.

A "posterization" effect where the image uses discrete regions of tone rather than a continuous gradient of tones.

A "sepia" effect where the image is mapped into warm gray, red, and brown tones.

A "solarisation" effect (Sabattier effect) where the image is wholly or partially reversed in tone.

A "whiteboard" effect where the image is typically displayed as regions of white, with black or grey details.

Use settings for each individual 3A routine.

Manual control of capture parameters is disabled. All controls in android.control.* besides sceneMode take effect.

Full application control of pipeline.

All control by the device's metering and focusing (3A) routines is disabled, and no other settings in android.control.* have any effect, except that android.control.captureIntent may be used by the camera device to select post-processing values for processing blocks that do not allow for manual control, or are not exposed by the camera API.

However, the camera device's 3A routines may continue to collect statistics and update their internal state so that when control is switched to AUTO mode, good control values can be immediately applied.

Same as OFF mode, except that this capture will not be used by camera device background auto-exposure, auto-white balance and auto-focus algorithms (3A) to update their statistics.

Specifically, the 3A routines are locked to the last values set from a request with AUTO, OFF, or USE_SCENE_MODE, and any statistics or state updates collected from manual captures with OFF_KEEP_STATE will be discarded by the camera device.

Use a specific scene mode.

Enabling this disables control.aeMode, control.awbMode and control.afMode controls; the camera device will ignore those settings while USE_SCENE_MODE is active (except for FACE_PRIORITY scene mode). Other control entries are still active. This setting can only be used if scene mode is supported (i.e. android.control.availableSceneModes contain some modes other than DISABLED).

Optimized for photos of quickly moving objects.

Similar to SPORTS.

Optimized for accurately capturing a photo of barcode for use by camera applications that wish to read the barcode value.

Optimized for bright, outdoor beach settings.

Optimized for dim settings where the main light source is a flame.

Indicates that no scene modes are set for a given capture request.

If face detection support exists, use face detection data for auto-focus, auto-white balance, and auto-exposure routines.

If face detection statistics are disabled (i.e. android.statistics.faceDetectMode is set to OFF), this should still operate correctly (but will not return face detection statistics to the framework).

Unlike the other scene modes, android.control.aeMode, android.control.awbMode, and android.control.afMode remain active when FACE_PRIORITY is set.

Optimized for nighttime photos of fireworks.

Optimized for photos of distant macroscopic objects.

Optimized for low-light settings.

Optimized for still photos of people in low-light settings.

Optimized for dim, indoor settings with multiple moving people.

Optimized for still photos of people.

Optimized for bright, outdoor settings containing snow.

Optimized for photos of quickly moving people.

Similar to ACTION.

Optimized to avoid blurry photos due to small amounts of device motion (for example: due to hand shake).

Optimized for scenes of the setting sun.

Optimized for dim, indoor settings where flash must remain off.

Video stabilization is disabled.

Video stabilization is enabled.

Apply edge enhancement at a quality level that does not slow down frame rate relative to sensor output

Apply high-quality edge enhancement, at a cost of reducing output frame rate.

No edge enhancement is applied.

Do not fire the flash for this capture.

If the flash is available and charged, fire flash for this capture.

Transition flash to continuously on.

Flash is charging and cannot be fired.

Flash fired for this capture.

Flash partially illuminated this frame.

This is usually due to the next or previous frame having the flash fire, and the flash spilling into this capture due to hardware limitations.

Flash is ready to fire.

No flash on camera.

Hot pixel correction is applied, without reducing frame rate relative to sensor raw output.

The hotpixel map may be returned in android.statistics.hotPixelMap.

High-quality hot pixel correction is applied, at a cost of reducing frame rate relative to sensor raw output.

The hotpixel map may be returned in android.statistics.hotPixelMap.

No hot pixel correction is applied.

The frame rate must not be reduced relative to sensor raw output for this option.

The hotpixel map may be returned in android.statistics.hotPixelMap.

This camera device is capable of supporting advanced imaging applications.

This camera device has only limited capabilities.

The camera device faces the opposite direction as the device's screen.

The camera device faces the same direction as the device's screen.

The lens focus distance is measured in diopters.

However, setting the lens to the same focus distance on separate occasions may result in a different real focus distance, depending on factors such as the orientation of the device, the age of the focusing mechanism, and the device temperature.

The lens focus distance is measured in diopters, and is calibrated.

The lens mechanism is calibrated so that setting the same focus distance is repeatable on multiple occasions with good accuracy, and the focus distance corresponds to the real physical distance to the plane of best focus.

The lens focus distance is not accurate, and the units used for android.lens.focusDistance do not correspond to any physical units.

Setting the lens to the same focus distance on separate occasions may result in a different real focus distance, depending on factors such as the orientation of the device, the age of the focusing mechanism, and the device temperature. The focus distance value will still be in the range of [0, android.lens.info.minimumFocusDistance], where 0 represents the farthest focus.

Optical stabilization is unavailable.

Optical stabilization is enabled.

One or several of the lens parameters (android.lens.focalLength, android.lens.focusDistance, android.lens.filterDensity or android.lens.aperture) is currently changing.

The lens parameters (android.lens.focalLength, android.lens.focusDistance, android.lens.filterDensity and android.lens.aperture) are not changing.

Noise reduction is applied without reducing frame rate relative to sensor output.

High-quality noise reduction is applied, at the cost of reducing frame rate relative to sensor output.

No noise reduction is applied.

The camera device supports outputting RAW buffers that can be saved offline into a DNG format. It can reprocess DNG files (produced from the same camera device) back into YUV.

• At least one input stream can be used.
• RAW16 is supported as output/input format.
• RAW16 is reprocessable into both YUV_420_888 and JPEG formats.
• The maximum available resolution for RAW16 streams (both input/output) will match either the value in android.sensor.info.pixelArraySize or android.sensor.info.activeArraySize.
• All DNG-related optional metadata entries are provided by the camera device.

The camera device post-processing stages can be manually controlled. The camera device supports basic manual control of the image post-processing stages. This means the following controls are guaranteed to be supported:

• Manual tonemap control
  • android.tonemap.curve
  • android.tonemap.mode
  • android.tonemap.maxCurvePoints
• Manual white balance control
  • android.colorCorrection.transform
  • android.colorCorrection.gains
• Lens shading map information
  • android.statistics.lensShadingMap
  • android.lens.info.shadingMapSize

If auto white balance is enabled, then the camera device will accurately report the values applied by AWB in the result.

A given camera device may also support additional post-processing controls, but this capability only covers the above list of controls.

The camera device can be manually controlled (3A algorithms such as auto-exposure, and auto-focus can be bypassed). The camera device supports basic manual control of the sensor image acquisition related stages. This means the following controls are guaranteed to be supported:

• Manual frame duration control
  • android.sensor.frameDuration
  • android.sensor.info.maxFrameDuration
  • android.scaler.streamConfigurationMap
• Manual exposure control
  • android.sensor.exposureTime
  • android.sensor.info.exposureTimeRange
• Manual sensitivity control
  • android.sensor.sensitivity
  • android.sensor.info.sensitivityRange
• Manual lens control (if the lens is adjustable)
  • android.lens.*
• Manual flash control (if a flash unit is present)
  • android.flash.*
• Manual black level locking
  • android.blackLevel.lock

If any of the above 3A algorithms are enabled, then the camera device will accurately report the values applied by 3A in the result.

A given camera device may also support additional manual sensor controls, but this capability only covers the above list of controls.

The camera device only supports centered crop regions.

The camera device supports arbitrarily chosen crop regions.

Sensor is not Bayer; output has 3 16-bit values for each pixel, instead of just 1 16-bit value per pixel.

W 3900 - 4500K

D 5700 - 7100K

N 4600 - 5400K

Incandescent light

WW 3200 - 3700K

All pixel data is replaced with an 8-bar color pattern.

The vertical bars (left-to-right) are as follows:

• 100% white
• yellow
• cyan
• green
• magenta
• red
• blue
• black

In general the image would look like the following:

W Y C G M R B K
 W Y C G M R B K
 W Y C G M R B K
 W Y C G M R B K
 W Y C G M R B K
 . . . . . . . .
 . . . . . . . .
 . . . . . . . .

 (B = Blue, K = Black)
 

Each bar should take up 1/8 of the sensor pixel array width. When this is not possible, the bar size should be rounded down to the nearest integer and the pattern can repeat on the right side.

Each bar's height must always take up the full sensor pixel array height.

Each pixel in this test pattern must be set to either 0% intensity or 100% intensity.

The test pattern is similar to COLOR_BARS, except that each bar should start at its specified color at the top, and fade to gray at the bottom.

Furthermore each bar is further subdivided into a left and right half. The left half should have a smooth gradient, and the right half should have a quantized gradient.

In particular, the right half's should consist of blocks of the same color for 1/16th active sensor pixel array width.

The least significant bits in the quantized gradient should be copied from the most significant bits of the smooth gradient.

The height of each bar should always be a multiple of 128. When this is not the case, the pattern should repeat at the bottom of the image.

The first custom test pattern. All custom patterns that are available only on this camera device are at least this numeric value.

All of the custom test patterns will be static (that is the raw image must not vary from frame to frame).

No test pattern mode is used, and the camera device returns captures from the image sensor.

This is the default if the key is not set.

All pixel data is replaced by a pseudo-random sequence generated from a PN9 512-bit sequence (typically implemented in hardware with a linear feedback shift register).

The generator should be reset at the beginning of each frame, and thus each subsequent raw frame with this test pattern should be exactly the same as the last.

Each pixel in [R, G_even, G_odd, B] is replaced by its respective color channel provided in android.sensor.testPatternData.

For example:

android.testPatternData = [0, 0xFFFFFFFF, 0xFFFFFFFF, 0]
 

All green pixels are 100% green. All red/blue pixels are black.

android.testPatternData = [0xFFFFFFFF, 0, 0xFFFFFFFF, 0]
 

All red pixels are 100% red. Only the odd green pixels are 100% green. All blue pixels are 100% black.

Apply lens shading corrections, without slowing frame rate relative to sensor raw output

Apply high-quality lens shading correction, at the cost of reduced frame rate.

No lens shading correction is applied.

Return all face metadata.

In this mode, android.statistics.faceRectangles, android.statistics.faceScores, android.statistics.faceIds, and android.statistics.faceLandmarks outputs are valid.

Do not include face detection statistics in capture results.

Return face rectangle and confidence values only.

In this mode, only android.statistics.faceRectangles and android.statistics.faceScores outputs are valid.

Do not include a lens shading map in the capture result.

Include a lens shading map in the capture result.

The camera device detects illumination flickering at 50Hz in the current scene.

The camera device detects illumination flickering at 60Hz in the current scene.

The camera device does not detect any flickering illumination in the current scene.

Every frame has the requests immediately applied.

Furthermore for all results, android.sync.frameNumber == android.request.frameCount

Changing controls over multiple requests one after another will produce results that have those controls applied atomically each frame.

All FULL capability devices will have this as their maxLatency.

Each new frame has some subset (potentially the entire set) of the past requests applied to the camera settings.

By submitting a series of identical requests, the camera device will eventually have the camera settings applied, but it is unknown when that exact point will be.

Use the tone mapping curve specified in the android.tonemap.curve* entries.

All color enhancement and tonemapping must be disabled, except for applying the tonemapping curve specified by android.tonemap.curve.

Must not slow down frame rate relative to raw sensor output.

Advanced gamma mapping and color enhancement may be applied, without reducing frame rate compared to raw sensor output.

High-quality gamma mapping and color enhancement will be applied, at the cost of reduced frame rate compared to raw sensor output.

Returns a list of the keys contained in this map.

The list returned is not modifiable, so any attempts to modify it will throw a UnsupportedOperationException.

All values retrieved by a key from this list with #get are guaranteed to be non-null. Each key is only listed once in the list. The order of the keys is undefined.