CameraCharacteristics.java revision fb46c644ceffdd476268c35c7992c4e445bde0a5
1/* 2 * Copyright (C) 2013 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package android.hardware.camera2; 18 19import android.hardware.camera2.impl.CameraMetadataNative; 20 21import java.util.Collections; 22import java.util.List; 23 24/** 25 * <p>The properties describing a 26 * {@link CameraDevice CameraDevice}.</p> 27 * 28 * <p>These properties are fixed for a given CameraDevice, and can be queried 29 * through the {@link CameraManager CameraManager} 30 * interface in addition to through the CameraDevice interface.</p> 31 * 32 * @see CameraDevice 33 * @see CameraManager 34 */ 35public final class CameraCharacteristics extends CameraMetadata { 36 37 private final CameraMetadataNative mProperties; 38 private List<Key<?>> mAvailableRequestKeys; 39 private List<Key<?>> mAvailableResultKeys; 40 41 /** 42 * Takes ownership of the passed-in properties object 43 * @hide 44 */ 45 public CameraCharacteristics(CameraMetadataNative properties) { 46 mProperties = properties; 47 } 48 49 @Override 50 public <T> T get(Key<T> key) { 51 return mProperties.get(key); 52 } 53 54 /** 55 * Returns the list of keys supported by this {@link CameraDevice} for querying 56 * with a {@link CaptureRequest}. 57 * 58 * <p>The list returned is not modifiable, so any attempts to modify it will throw 59 * a {@code UnsupportedOperationException}.</p> 60 * 61 * <p>Each key is only listed once in the list. The order of the keys is undefined.</p> 62 * 63 * <p>Note that there is no {@code getAvailableCameraCharacteristicsKeys()} -- use 64 * {@link #getKeys()} instead.</p> 65 * 66 * @return List of keys supported by this CameraDevice for CaptureRequests. 67 */ 68 public List<Key<?>> getAvailableCaptureRequestKeys() { 69 if (mAvailableRequestKeys == null) { 70 mAvailableRequestKeys = getAvailableKeyList(CaptureRequest.class); 71 } 72 return mAvailableRequestKeys; 73 } 74 75 /** 76 * Returns the list of keys supported by this {@link CameraDevice} for querying 77 * with a {@link CaptureResult}. 78 * 79 * <p>The list returned is not modifiable, so any attempts to modify it will throw 80 * a {@code UnsupportedOperationException}.</p> 81 * 82 * <p>Each key is only listed once in the list. The order of the keys is undefined.</p> 83 * 84 * <p>Note that there is no {@code getAvailableCameraCharacteristicsKeys()} -- use 85 * {@link #getKeys()} instead.</p> 86 * 87 * @return List of keys supported by this CameraDevice for CaptureResults. 88 */ 89 public List<Key<?>> getAvailableCaptureResultKeys() { 90 if (mAvailableResultKeys == null) { 91 mAvailableResultKeys = getAvailableKeyList(CaptureResult.class); 92 } 93 return mAvailableResultKeys; 94 } 95 96 /** 97 * Returns the list of keys supported by this {@link CameraDevice} by metadataClass. 98 * 99 * <p>The list returned is not modifiable, so any attempts to modify it will throw 100 * a {@code UnsupportedOperationException}.</p> 101 * 102 * <p>Each key is only listed once in the list. The order of the keys is undefined.</p> 103 * 104 * @param metadataClass The subclass of CameraMetadata that you want to get the keys for. 105 * 106 * @return List of keys supported by this CameraDevice for metadataClass. 107 * 108 * @throws IllegalArgumentException if metadataClass is not a subclass of CameraMetadata 109 */ 110 private <T extends CameraMetadata> List<Key<?>> getAvailableKeyList(Class<T> metadataClass) { 111 112 if (metadataClass.equals(CameraMetadata.class)) { 113 throw new AssertionError( 114 "metadataClass must be a strict subclass of CameraMetadata"); 115 } else if (!CameraMetadata.class.isAssignableFrom(metadataClass)) { 116 throw new AssertionError( 117 "metadataClass must be a subclass of CameraMetadata"); 118 } 119 120 return Collections.unmodifiableList(getKeysStatic(metadataClass, /*instance*/null)); 121 } 122 123 /*@O~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ 124 * The key entries below this point are generated from metadata 125 * definitions in /system/media/camera/docs. Do not modify by hand or 126 * modify the comment blocks at the start or end. 127 *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/ 128 129 130 /** 131 * <p>The set of auto-exposure antibanding modes that are 132 * supported by this camera device.</p> 133 * <p>Not all of the auto-exposure anti-banding modes may be 134 * supported by a given camera device. This field lists the 135 * valid anti-banding modes that the application may request 136 * for this camera device; they must include AUTO.</p> 137 */ 138 public static final Key<byte[]> CONTROL_AE_AVAILABLE_ANTIBANDING_MODES = 139 new Key<byte[]>("android.control.aeAvailableAntibandingModes", byte[].class); 140 141 /** 142 * <p>The set of auto-exposure modes that are supported by this 143 * camera device.</p> 144 * <p>Not all the auto-exposure modes may be supported by a 145 * given camera device, especially if no flash unit is 146 * available. This entry lists the valid modes for 147 * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} for this camera device.</p> 148 * <p>All camera devices support ON, and all camera devices with 149 * flash units support ON_AUTO_FLASH and 150 * ON_ALWAYS_FLASH.</p> 151 * <p>Full-capability camera devices always support OFF mode, 152 * which enables application control of camera exposure time, 153 * sensitivity, and frame duration.</p> 154 * 155 * @see CaptureRequest#CONTROL_AE_MODE 156 */ 157 public static final Key<byte[]> CONTROL_AE_AVAILABLE_MODES = 158 new Key<byte[]>("android.control.aeAvailableModes", byte[].class); 159 160 /** 161 * <p>List of frame rate ranges supported by the 162 * AE algorithm/hardware</p> 163 */ 164 public static final Key<int[]> CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES = 165 new Key<int[]>("android.control.aeAvailableTargetFpsRanges", int[].class); 166 167 /** 168 * <p>Maximum and minimum exposure compensation 169 * setting, in counts of 170 * android.control.aeCompensationStepSize</p> 171 */ 172 public static final Key<int[]> CONTROL_AE_COMPENSATION_RANGE = 173 new Key<int[]>("android.control.aeCompensationRange", int[].class); 174 175 /** 176 * <p>Smallest step by which exposure compensation 177 * can be changed</p> 178 */ 179 public static final Key<Rational> CONTROL_AE_COMPENSATION_STEP = 180 new Key<Rational>("android.control.aeCompensationStep", Rational.class); 181 182 /** 183 * <p>List of AF modes that can be 184 * selected</p> 185 */ 186 public static final Key<byte[]> CONTROL_AF_AVAILABLE_MODES = 187 new Key<byte[]>("android.control.afAvailableModes", byte[].class); 188 189 /** 190 * <p>what subset of the full color effect enum 191 * list is supported</p> 192 */ 193 public static final Key<byte[]> CONTROL_AVAILABLE_EFFECTS = 194 new Key<byte[]>("android.control.availableEffects", byte[].class); 195 196 /** 197 * <p>what subset of the scene mode enum list is 198 * supported.</p> 199 */ 200 public static final Key<byte[]> CONTROL_AVAILABLE_SCENE_MODES = 201 new Key<byte[]>("android.control.availableSceneModes", byte[].class); 202 203 /** 204 * <p>List of video stabilization modes that can 205 * be supported</p> 206 */ 207 public static final Key<byte[]> CONTROL_AVAILABLE_VIDEO_STABILIZATION_MODES = 208 new Key<byte[]>("android.control.availableVideoStabilizationModes", byte[].class); 209 210 /** 211 */ 212 public static final Key<byte[]> CONTROL_AWB_AVAILABLE_MODES = 213 new Key<byte[]>("android.control.awbAvailableModes", byte[].class); 214 215 /** 216 * <p>For AE, AWB, and AF, how many individual 217 * regions can be listed for metering?</p> 218 */ 219 public static final Key<Integer> CONTROL_MAX_REGIONS = 220 new Key<Integer>("android.control.maxRegions", int.class); 221 222 /** 223 * <p>Whether this camera has a 224 * flash</p> 225 * <p>If no flash, none of the flash controls do 226 * anything. All other metadata should return 0</p> 227 */ 228 public static final Key<Byte> FLASH_INFO_AVAILABLE = 229 new Key<Byte>("android.flash.info.available", byte.class); 230 231 /** 232 * <p>Supported resolutions for the JPEG thumbnail</p> 233 * <p>Below condiditions must be satisfied for this size list:</p> 234 * <ul> 235 * <li>The sizes must be sorted by increasing pixel area (width x height). 236 * If several resolutions have the same area, they must be sorted by increasing width.</li> 237 * <li>The aspect ratio of the largest thumbnail size must be same as the 238 * aspect ratio of largest size in {@link CameraCharacteristics#SCALER_AVAILABLE_JPEG_SIZES android.scaler.availableJpegSizes}. 239 * The largest size is defined as the size that has the largest pixel area 240 * in a given size list.</li> 241 * <li>Each size in {@link CameraCharacteristics#SCALER_AVAILABLE_JPEG_SIZES android.scaler.availableJpegSizes} must have at least 242 * one corresponding size that has the same aspect ratio in availableThumbnailSizes, 243 * and vice versa.</li> 244 * <li>All non (0, 0) sizes must have non-zero widths and heights.</li> 245 * </ul> 246 * 247 * @see CameraCharacteristics#SCALER_AVAILABLE_JPEG_SIZES 248 */ 249 public static final Key<android.hardware.camera2.Size[]> JPEG_AVAILABLE_THUMBNAIL_SIZES = 250 new Key<android.hardware.camera2.Size[]>("android.jpeg.availableThumbnailSizes", android.hardware.camera2.Size[].class); 251 252 /** 253 * <p>List of supported aperture 254 * values.</p> 255 * <p>If the camera device doesn't support variable apertures, 256 * listed value will be the fixed aperture.</p> 257 * <p>If the camera device supports variable apertures, the aperture value 258 * in this list will be sorted in ascending order.</p> 259 */ 260 public static final Key<float[]> LENS_INFO_AVAILABLE_APERTURES = 261 new Key<float[]>("android.lens.info.availableApertures", float[].class); 262 263 /** 264 * <p>List of supported ND filter 265 * values</p> 266 * <p>If not available, only setting is 0. Otherwise, 267 * lists the available exposure index values for dimming 268 * (2 would mean the filter is set to reduce incoming 269 * light by two stops)</p> 270 */ 271 public static final Key<float[]> LENS_INFO_AVAILABLE_FILTER_DENSITIES = 272 new Key<float[]>("android.lens.info.availableFilterDensities", float[].class); 273 274 /** 275 * <p>If fitted with optical zoom, what focal 276 * lengths are available. If not, the static focal 277 * length</p> 278 * <p>If optical zoom not supported, only one value 279 * should be reported</p> 280 */ 281 public static final Key<float[]> LENS_INFO_AVAILABLE_FOCAL_LENGTHS = 282 new Key<float[]>("android.lens.info.availableFocalLengths", float[].class); 283 284 /** 285 * <p>List of supported optical image 286 * stabilization modes</p> 287 */ 288 public static final Key<byte[]> LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION = 289 new Key<byte[]>("android.lens.info.availableOpticalStabilization", byte[].class); 290 291 /** 292 * <p>Hyperfocal distance for this lens; set to 293 * 0 if fixed focus</p> 294 * <p>The hyperfocal distance is used for the old 295 * API's 'fixed' setting</p> 296 */ 297 public static final Key<Float> LENS_INFO_HYPERFOCAL_DISTANCE = 298 new Key<Float>("android.lens.info.hyperfocalDistance", float.class); 299 300 /** 301 * <p>Shortest distance from frontmost surface 302 * of the lens that can be focused correctly</p> 303 * <p>If the lens is fixed-focus, this should be 304 * 0</p> 305 */ 306 public static final Key<Float> LENS_INFO_MINIMUM_FOCUS_DISTANCE = 307 new Key<Float>("android.lens.info.minimumFocusDistance", float.class); 308 309 /** 310 * <p>Dimensions of lens shading map.</p> 311 * <p>The map should be on the order of 30-40 rows and columns, and 312 * must be smaller than 64x64.</p> 313 */ 314 public static final Key<android.hardware.camera2.Size> LENS_INFO_SHADING_MAP_SIZE = 315 new Key<android.hardware.camera2.Size>("android.lens.info.shadingMapSize", android.hardware.camera2.Size.class); 316 317 /** 318 * <p>Direction the camera faces relative to 319 * device screen</p> 320 * @see #LENS_FACING_FRONT 321 * @see #LENS_FACING_BACK 322 */ 323 public static final Key<Integer> LENS_FACING = 324 new Key<Integer>("android.lens.facing", int.class); 325 326 /** 327 * <p>If set to 1, the HAL will always split result 328 * metadata for a single capture into multiple buffers, 329 * returned using multiple process_capture_result calls.</p> 330 * <p>Does not need to be listed in static 331 * metadata. Support for partial results will be reworked in 332 * future versions of camera service. This quirk will stop 333 * working at that point; DO NOT USE without careful 334 * consideration of future support.</p> 335 * <p><b>Optional</b> - This value may be null on some devices.</p> 336 * @hide 337 */ 338 public static final Key<Byte> QUIRKS_USE_PARTIAL_RESULT = 339 new Key<Byte>("android.quirks.usePartialResult", byte.class); 340 341 /** 342 * <p>How many output streams can be allocated at 343 * the same time for each type of stream</p> 344 * <p>Video snapshot with preview callbacks requires 3 345 * processed streams (preview, record, app callbacks) and 346 * one JPEG stream (snapshot)</p> 347 */ 348 public static final Key<int[]> REQUEST_MAX_NUM_OUTPUT_STREAMS = 349 new Key<int[]>("android.request.maxNumOutputStreams", int[].class); 350 351 /** 352 * <p>List of app-visible formats</p> 353 */ 354 public static final Key<int[]> SCALER_AVAILABLE_FORMATS = 355 new Key<int[]>("android.scaler.availableFormats", int[].class); 356 357 /** 358 * <p>The minimum frame duration that is supported 359 * for each resolution in availableJpegSizes. Should 360 * correspond to the frame duration when only that JPEG 361 * stream is active and captured in a burst, with all 362 * processing set to FAST</p> 363 * <p>When multiple streams are configured, the minimum 364 * frame duration will be >= max(individual stream min 365 * durations)</p> 366 */ 367 public static final Key<long[]> SCALER_AVAILABLE_JPEG_MIN_DURATIONS = 368 new Key<long[]>("android.scaler.availableJpegMinDurations", long[].class); 369 370 /** 371 * <p>The resolutions available for output from 372 * the JPEG block. Listed as width x height</p> 373 */ 374 public static final Key<android.hardware.camera2.Size[]> SCALER_AVAILABLE_JPEG_SIZES = 375 new Key<android.hardware.camera2.Size[]>("android.scaler.availableJpegSizes", android.hardware.camera2.Size[].class); 376 377 /** 378 * <p>The maximum ratio between active area width 379 * and crop region width, or between active area height and 380 * crop region height, if the crop region height is larger 381 * than width</p> 382 */ 383 public static final Key<Float> SCALER_AVAILABLE_MAX_DIGITAL_ZOOM = 384 new Key<Float>("android.scaler.availableMaxDigitalZoom", float.class); 385 386 /** 387 * <p>The minimum frame duration that is supported 388 * for each resolution in availableProcessedSizes. Should 389 * correspond to the frame duration when only that processed 390 * stream is active, with all processing set to 391 * FAST</p> 392 * <p>When multiple streams are configured, the minimum 393 * frame duration will be >= max(individual stream min 394 * durations)</p> 395 */ 396 public static final Key<long[]> SCALER_AVAILABLE_PROCESSED_MIN_DURATIONS = 397 new Key<long[]>("android.scaler.availableProcessedMinDurations", long[].class); 398 399 /** 400 * <p>The resolutions available for use with 401 * processed output streams, such as YV12, NV12, and 402 * platform opaque YUV/RGB streams to the GPU or video 403 * encoders. Listed as width, height</p> 404 * <p>The actual supported resolution list may be limited by 405 * consumer end points for different use cases. For example, for 406 * recording use case, the largest supported resolution may be 407 * limited by max supported size from encoder, for preview use 408 * case, the largest supported resolution may be limited by max 409 * resolution SurfaceTexture/SurfaceView can support.</p> 410 */ 411 public static final Key<android.hardware.camera2.Size[]> SCALER_AVAILABLE_PROCESSED_SIZES = 412 new Key<android.hardware.camera2.Size[]>("android.scaler.availableProcessedSizes", android.hardware.camera2.Size[].class); 413 414 /** 415 * <p>Area of raw data which corresponds to only 416 * active pixels; smaller or equal to 417 * pixelArraySize.</p> 418 */ 419 public static final Key<android.graphics.Rect> SENSOR_INFO_ACTIVE_ARRAY_SIZE = 420 new Key<android.graphics.Rect>("android.sensor.info.activeArraySize", android.graphics.Rect.class); 421 422 /** 423 * <p>Range of valid sensitivities</p> 424 */ 425 public static final Key<int[]> SENSOR_INFO_SENSITIVITY_RANGE = 426 new Key<int[]>("android.sensor.info.sensitivityRange", int[].class); 427 428 /** 429 * <p>Range of valid exposure 430 * times</p> 431 */ 432 public static final Key<long[]> SENSOR_INFO_EXPOSURE_TIME_RANGE = 433 new Key<long[]>("android.sensor.info.exposureTimeRange", long[].class); 434 435 /** 436 * <p>Maximum possible frame duration (minimum frame 437 * rate)</p> 438 * <p>Minimum duration is a function of resolution, 439 * processing settings. See 440 * android.scaler.availableProcessedMinDurations 441 * android.scaler.availableJpegMinDurations 442 * android.scaler.availableRawMinDurations</p> 443 */ 444 public static final Key<Long> SENSOR_INFO_MAX_FRAME_DURATION = 445 new Key<Long>("android.sensor.info.maxFrameDuration", long.class); 446 447 /** 448 * <p>The physical dimensions of the full pixel 449 * array</p> 450 * <p>Needed for FOV calculation for old API</p> 451 */ 452 public static final Key<float[]> SENSOR_INFO_PHYSICAL_SIZE = 453 new Key<float[]>("android.sensor.info.physicalSize", float[].class); 454 455 /** 456 * <p>Gain factor from electrons to raw units when 457 * ISO=100</p> 458 */ 459 public static final Key<Rational> SENSOR_BASE_GAIN_FACTOR = 460 new Key<Rational>("android.sensor.baseGainFactor", Rational.class); 461 462 /** 463 * <p>Maximum sensitivity that is implemented 464 * purely through analog gain</p> 465 * <p>For {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity} values less than or 466 * equal to this, all applied gain must be analog. For 467 * values above this, it can be a mix of analog and 468 * digital</p> 469 * <p><b>Optional</b> - This value may be null on some devices.</p> 470 * <p><b>Full capability</b> - 471 * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the 472 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p> 473 * 474 * @see CaptureRequest#SENSOR_SENSITIVITY 475 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL 476 */ 477 public static final Key<Integer> SENSOR_MAX_ANALOG_SENSITIVITY = 478 new Key<Integer>("android.sensor.maxAnalogSensitivity", int.class); 479 480 /** 481 * <p>Clockwise angle through which the output 482 * image needs to be rotated to be upright on the device 483 * screen in its native orientation. Also defines the 484 * direction of rolling shutter readout, which is from top 485 * to bottom in the sensor's coordinate system</p> 486 */ 487 public static final Key<Integer> SENSOR_ORIENTATION = 488 new Key<Integer>("android.sensor.orientation", int.class); 489 490 /** 491 * <p>Which face detection modes are available, 492 * if any</p> 493 * <p>OFF means face detection is disabled, it must 494 * be included in the list.</p> 495 * <p>SIMPLE means the device supports the 496 * android.statistics.faceRectangles and 497 * android.statistics.faceScores outputs.</p> 498 * <p>FULL means the device additionally supports the 499 * android.statistics.faceIds and 500 * android.statistics.faceLandmarks outputs.</p> 501 */ 502 public static final Key<byte[]> STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES = 503 new Key<byte[]>("android.statistics.info.availableFaceDetectModes", byte[].class); 504 505 /** 506 * <p>Maximum number of simultaneously detectable 507 * faces</p> 508 */ 509 public static final Key<Integer> STATISTICS_INFO_MAX_FACE_COUNT = 510 new Key<Integer>("android.statistics.info.maxFaceCount", int.class); 511 512 /** 513 * <p>Maximum number of supported points in the 514 * tonemap curve</p> 515 */ 516 public static final Key<Integer> TONEMAP_MAX_CURVE_POINTS = 517 new Key<Integer>("android.tonemap.maxCurvePoints", int.class); 518 519 /** 520 * <p>A list of camera LEDs that are available on this system.</p> 521 * @see #LED_AVAILABLE_LEDS_TRANSMIT 522 * @hide 523 */ 524 public static final Key<int[]> LED_AVAILABLE_LEDS = 525 new Key<int[]>("android.led.availableLeds", int[].class); 526 527 /** 528 * <p>The camera 3 HAL device can implement one of two possible 529 * operational modes; limited and full. Full support is 530 * expected from new higher-end devices. Limited mode has 531 * hardware requirements roughly in line with those for a 532 * camera HAL device v1 implementation, and is expected from 533 * older or inexpensive devices. Full is a strict superset of 534 * limited, and they share the same essential operational flow.</p> 535 * <p>For full details refer to "S3. Operational Modes" in camera3.h</p> 536 * @see #INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED 537 * @see #INFO_SUPPORTED_HARDWARE_LEVEL_FULL 538 */ 539 public static final Key<Integer> INFO_SUPPORTED_HARDWARE_LEVEL = 540 new Key<Integer>("android.info.supportedHardwareLevel", int.class); 541 542 /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ 543 * End generated code 544 *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/ 545} 546