CameraCharacteristics.java revision 5a9ff379233025bc85ebc41ac5979def09d3ebfa
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 * <p>Which set of antibanding modes are 131 * supported</p> 132 */ 133 public static final Key<byte[]> CONTROL_AE_AVAILABLE_ANTIBANDING_MODES = 134 new Key<byte[]>("android.control.aeAvailableAntibandingModes", byte[].class); 135 136 /** 137 * <p>List of frame rate ranges supported by the 138 * AE algorithm/hardware</p> 139 */ 140 public static final Key<int[]> CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES = 141 new Key<int[]>("android.control.aeAvailableTargetFpsRanges", int[].class); 142 143 /** 144 * <p>Maximum and minimum exposure compensation 145 * setting, in counts of 146 * android.control.aeCompensationStepSize</p> 147 */ 148 public static final Key<int[]> CONTROL_AE_COMPENSATION_RANGE = 149 new Key<int[]>("android.control.aeCompensationRange", int[].class); 150 151 /** 152 * <p>Smallest step by which exposure compensation 153 * can be changed</p> 154 */ 155 public static final Key<Rational> CONTROL_AE_COMPENSATION_STEP = 156 new Key<Rational>("android.control.aeCompensationStep", Rational.class); 157 158 /** 159 * <p>List of AF modes that can be 160 * selected</p> 161 */ 162 public static final Key<byte[]> CONTROL_AF_AVAILABLE_MODES = 163 new Key<byte[]>("android.control.afAvailableModes", byte[].class); 164 165 /** 166 * <p>what subset of the full color effect enum 167 * list is supported</p> 168 */ 169 public static final Key<byte[]> CONTROL_AVAILABLE_EFFECTS = 170 new Key<byte[]>("android.control.availableEffects", byte[].class); 171 172 /** 173 * <p>what subset of the scene mode enum list is 174 * supported.</p> 175 */ 176 public static final Key<byte[]> CONTROL_AVAILABLE_SCENE_MODES = 177 new Key<byte[]>("android.control.availableSceneModes", byte[].class); 178 179 /** 180 * <p>List of video stabilization modes that can 181 * be supported</p> 182 */ 183 public static final Key<byte[]> CONTROL_AVAILABLE_VIDEO_STABILIZATION_MODES = 184 new Key<byte[]>("android.control.availableVideoStabilizationModes", byte[].class); 185 186 /** 187 */ 188 public static final Key<byte[]> CONTROL_AWB_AVAILABLE_MODES = 189 new Key<byte[]>("android.control.awbAvailableModes", byte[].class); 190 191 /** 192 * <p>For AE, AWB, and AF, how many individual 193 * regions can be listed for metering?</p> 194 */ 195 public static final Key<Integer> CONTROL_MAX_REGIONS = 196 new Key<Integer>("android.control.maxRegions", int.class); 197 198 /** 199 * <p>Whether this camera has a 200 * flash</p> 201 * <p>If no flash, none of the flash controls do 202 * anything. All other metadata should return 0</p> 203 */ 204 public static final Key<Byte> FLASH_INFO_AVAILABLE = 205 new Key<Byte>("android.flash.info.available", byte.class); 206 207 /** 208 * <p>Supported resolutions for the JPEG thumbnail</p> 209 * <p>Below condiditions must be satisfied for this size list:</p> 210 * <ul> 211 * <li>The sizes must be sorted by increasing pixel area (width x height). 212 * If several resolutions have the same area, they must be sorted by increasing width.</li> 213 * <li>The aspect ratio of the largest thumbnail size must be same as the 214 * aspect ratio of largest size in android.scaler.availableJpegSizes. 215 * The largest size is defined as the size that has the largest pixel area 216 * in a given size list.</li> 217 * <li>Each size in android.scaler.availableJpegSizes must have at least 218 * one corresponding size that has the same aspect ratio in availableThumbnailSizes, 219 * and vice versa.</li> 220 * <li>All non (0, 0) sizes must have non-zero widths and heights.</li> 221 * </ul> 222 */ 223 public static final Key<android.hardware.camera2.Size[]> JPEG_AVAILABLE_THUMBNAIL_SIZES = 224 new Key<android.hardware.camera2.Size[]>("android.jpeg.availableThumbnailSizes", android.hardware.camera2.Size[].class); 225 226 /** 227 * <p>List of supported aperture 228 * values</p> 229 * <p>If variable aperture not available, only setting 230 * should be for the fixed aperture</p> 231 */ 232 public static final Key<float[]> LENS_INFO_AVAILABLE_APERTURES = 233 new Key<float[]>("android.lens.info.availableApertures", float[].class); 234 235 /** 236 * <p>List of supported ND filter 237 * values</p> 238 * <p>If not available, only setting is 0. Otherwise, 239 * lists the available exposure index values for dimming 240 * (2 would mean the filter is set to reduce incoming 241 * light by two stops)</p> 242 */ 243 public static final Key<float[]> LENS_INFO_AVAILABLE_FILTER_DENSITIES = 244 new Key<float[]>("android.lens.info.availableFilterDensities", float[].class); 245 246 /** 247 * <p>If fitted with optical zoom, what focal 248 * lengths are available. If not, the static focal 249 * length</p> 250 * <p>If optical zoom not supported, only one value 251 * should be reported</p> 252 */ 253 public static final Key<float[]> LENS_INFO_AVAILABLE_FOCAL_LENGTHS = 254 new Key<float[]>("android.lens.info.availableFocalLengths", float[].class); 255 256 /** 257 * <p>List of supported optical image 258 * stabilization modes</p> 259 */ 260 public static final Key<byte[]> LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION = 261 new Key<byte[]>("android.lens.info.availableOpticalStabilization", byte[].class); 262 263 /** 264 * <p>Hyperfocal distance for this lens; set to 265 * 0 if fixed focus</p> 266 * <p>The hyperfocal distance is used for the old 267 * API's 'fixed' setting</p> 268 */ 269 public static final Key<Float> LENS_INFO_HYPERFOCAL_DISTANCE = 270 new Key<Float>("android.lens.info.hyperfocalDistance", float.class); 271 272 /** 273 * <p>Shortest distance from frontmost surface 274 * of the lens that can be focused correctly</p> 275 * <p>If the lens is fixed-focus, this should be 276 * 0</p> 277 */ 278 public static final Key<Float> LENS_INFO_MINIMUM_FOCUS_DISTANCE = 279 new Key<Float>("android.lens.info.minimumFocusDistance", float.class); 280 281 /** 282 * <p>Dimensions of lens shading map.</p> 283 * <p>The map should be on the order of 30-40 rows and columns, and 284 * must be smaller than 64x64.</p> 285 */ 286 public static final Key<android.hardware.camera2.Size> LENS_INFO_SHADING_MAP_SIZE = 287 new Key<android.hardware.camera2.Size>("android.lens.info.shadingMapSize", android.hardware.camera2.Size.class); 288 289 /** 290 * <p>Direction the camera faces relative to 291 * device screen</p> 292 * @see #LENS_FACING_FRONT 293 * @see #LENS_FACING_BACK 294 */ 295 public static final Key<Integer> LENS_FACING = 296 new Key<Integer>("android.lens.facing", int.class); 297 298 /** 299 * <p>If set to 1, the HAL will always split result 300 * metadata for a single capture into multiple buffers, 301 * returned using multiple process_capture_result calls.</p> 302 * <p>Does not need to be listed in static 303 * metadata. Support for partial results will be reworked in 304 * future versions of camera service. This quirk will stop 305 * working at that point; DO NOT USE without careful 306 * consideration of future support.</p> 307 * 308 * <b>Optional</b> - This value may be null on some devices. 309 * 310 * @hide 311 */ 312 public static final Key<Byte> QUIRKS_USE_PARTIAL_RESULT = 313 new Key<Byte>("android.quirks.usePartialResult", byte.class); 314 315 /** 316 * <p>How many output streams can be allocated at 317 * the same time for each type of stream</p> 318 * <p>Video snapshot with preview callbacks requires 3 319 * processed streams (preview, record, app callbacks) and 320 * one JPEG stream (snapshot)</p> 321 */ 322 public static final Key<int[]> REQUEST_MAX_NUM_OUTPUT_STREAMS = 323 new Key<int[]>("android.request.maxNumOutputStreams", int[].class); 324 325 /** 326 * <p>List of app-visible formats</p> 327 */ 328 public static final Key<int[]> SCALER_AVAILABLE_FORMATS = 329 new Key<int[]>("android.scaler.availableFormats", int[].class); 330 331 /** 332 * <p>The minimum frame duration that is supported 333 * for each resolution in availableJpegSizes. Should 334 * correspond to the frame duration when only that JPEG 335 * stream is active and captured in a burst, with all 336 * processing set to FAST</p> 337 * <p>When multiple streams are configured, the minimum 338 * frame duration will be >= max(individual stream min 339 * durations)</p> 340 */ 341 public static final Key<long[]> SCALER_AVAILABLE_JPEG_MIN_DURATIONS = 342 new Key<long[]>("android.scaler.availableJpegMinDurations", long[].class); 343 344 /** 345 * <p>The resolutions available for output from 346 * the JPEG block. Listed as width x height</p> 347 */ 348 public static final Key<android.hardware.camera2.Size[]> SCALER_AVAILABLE_JPEG_SIZES = 349 new Key<android.hardware.camera2.Size[]>("android.scaler.availableJpegSizes", android.hardware.camera2.Size[].class); 350 351 /** 352 * <p>The maximum ratio between active area width 353 * and crop region width, or between active area height and 354 * crop region height, if the crop region height is larger 355 * than width</p> 356 */ 357 public static final Key<Float> SCALER_AVAILABLE_MAX_DIGITAL_ZOOM = 358 new Key<Float>("android.scaler.availableMaxDigitalZoom", float.class); 359 360 /** 361 * <p>The minimum frame duration that is supported 362 * for each resolution in availableProcessedSizes. Should 363 * correspond to the frame duration when only that processed 364 * stream is active, with all processing set to 365 * FAST</p> 366 * <p>When multiple streams are configured, the minimum 367 * frame duration will be >= max(individual stream min 368 * durations)</p> 369 */ 370 public static final Key<long[]> SCALER_AVAILABLE_PROCESSED_MIN_DURATIONS = 371 new Key<long[]>("android.scaler.availableProcessedMinDurations", long[].class); 372 373 /** 374 * <p>The resolutions available for use with 375 * processed output streams, such as YV12, NV12, and 376 * platform opaque YUV/RGB streams to the GPU or video 377 * encoders. Listed as width, height</p> 378 * <p>The actual supported resolution list may be limited by 379 * consumer end points for different use cases. For example, for 380 * recording use case, the largest supported resolution may be 381 * limited by max supported size from encoder, for preview use 382 * case, the largest supported resolution may be limited by max 383 * resolution SurfaceTexture/SurfaceView can support.</p> 384 */ 385 public static final Key<android.hardware.camera2.Size[]> SCALER_AVAILABLE_PROCESSED_SIZES = 386 new Key<android.hardware.camera2.Size[]>("android.scaler.availableProcessedSizes", android.hardware.camera2.Size[].class); 387 388 /** 389 * <p>Area of raw data which corresponds to only 390 * active pixels; smaller or equal to 391 * pixelArraySize.</p> 392 */ 393 public static final Key<android.graphics.Rect> SENSOR_INFO_ACTIVE_ARRAY_SIZE = 394 new Key<android.graphics.Rect>("android.sensor.info.activeArraySize", android.graphics.Rect.class); 395 396 /** 397 * <p>Range of valid sensitivities</p> 398 */ 399 public static final Key<int[]> SENSOR_INFO_SENSITIVITY_RANGE = 400 new Key<int[]>("android.sensor.info.sensitivityRange", int[].class); 401 402 /** 403 * <p>Range of valid exposure 404 * times</p> 405 */ 406 public static final Key<long[]> SENSOR_INFO_EXPOSURE_TIME_RANGE = 407 new Key<long[]>("android.sensor.info.exposureTimeRange", long[].class); 408 409 /** 410 * <p>Maximum possible frame duration (minimum frame 411 * rate)</p> 412 * <p>Minimum duration is a function of resolution, 413 * processing settings. See 414 * android.scaler.availableProcessedMinDurations 415 * android.scaler.availableJpegMinDurations 416 * android.scaler.availableRawMinDurations</p> 417 */ 418 public static final Key<Long> SENSOR_INFO_MAX_FRAME_DURATION = 419 new Key<Long>("android.sensor.info.maxFrameDuration", long.class); 420 421 /** 422 * <p>The physical dimensions of the full pixel 423 * array</p> 424 * <p>Needed for FOV calculation for old API</p> 425 */ 426 public static final Key<float[]> SENSOR_INFO_PHYSICAL_SIZE = 427 new Key<float[]>("android.sensor.info.physicalSize", float[].class); 428 429 /** 430 * <p>Gain factor from electrons to raw units when 431 * ISO=100</p> 432 * 433 * <b>Optional</b> - This value may be null on some devices. 434 * 435 * <b>{@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL}</b> - 436 * Present on all devices that report being FULL level hardware devices in the 437 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL HARDWARE_LEVEL} key. 438 */ 439 public static final Key<Rational> SENSOR_BASE_GAIN_FACTOR = 440 new Key<Rational>("android.sensor.baseGainFactor", Rational.class); 441 442 /** 443 * <p>Maximum sensitivity that is implemented 444 * purely through analog gain</p> 445 * <p>For android.sensor.sensitivity values less than or 446 * equal to this, all applied gain must be analog. For 447 * values above this, it can be a mix of analog and 448 * digital</p> 449 * 450 * <b>Optional</b> - This value may be null on some devices. 451 * 452 * <b>{@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL}</b> - 453 * Present on all devices that report being FULL level hardware devices in the 454 * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL HARDWARE_LEVEL} key. 455 */ 456 public static final Key<Integer> SENSOR_MAX_ANALOG_SENSITIVITY = 457 new Key<Integer>("android.sensor.maxAnalogSensitivity", int.class); 458 459 /** 460 * <p>Clockwise angle through which the output 461 * image needs to be rotated to be upright on the device 462 * screen in its native orientation. Also defines the 463 * direction of rolling shutter readout, which is from top 464 * to bottom in the sensor's coordinate system</p> 465 */ 466 public static final Key<Integer> SENSOR_ORIENTATION = 467 new Key<Integer>("android.sensor.orientation", int.class); 468 469 /** 470 * <p>Which face detection modes are available, 471 * if any</p> 472 * <p>OFF means face detection is disabled, it must 473 * be included in the list.</p> 474 * <p>SIMPLE means the device supports the 475 * android.statistics.faceRectangles and 476 * android.statistics.faceScores outputs.</p> 477 * <p>FULL means the device additionally supports the 478 * android.statistics.faceIds and 479 * android.statistics.faceLandmarks outputs.</p> 480 */ 481 public static final Key<byte[]> STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES = 482 new Key<byte[]>("android.statistics.info.availableFaceDetectModes", byte[].class); 483 484 /** 485 * <p>Maximum number of simultaneously detectable 486 * faces</p> 487 */ 488 public static final Key<Integer> STATISTICS_INFO_MAX_FACE_COUNT = 489 new Key<Integer>("android.statistics.info.maxFaceCount", int.class); 490 491 /** 492 * <p>Maximum number of supported points in the 493 * tonemap curve</p> 494 */ 495 public static final Key<Integer> TONEMAP_MAX_CURVE_POINTS = 496 new Key<Integer>("android.tonemap.maxCurvePoints", int.class); 497 498 /** 499 * <p>A list of camera LEDs that are available on this system.</p> 500 * @see #LED_AVAILABLE_LEDS_TRANSMIT 501 * 502 * @hide 503 */ 504 public static final Key<int[]> LED_AVAILABLE_LEDS = 505 new Key<int[]>("android.led.availableLeds", int[].class); 506 507 /** 508 * <p>The camera 3 HAL device can implement one of two possible 509 * operational modes; limited and full. Full support is 510 * expected from new higher-end devices. Limited mode has 511 * hardware requirements roughly in line with those for a 512 * camera HAL device v1 implementation, and is expected from 513 * older or inexpensive devices. Full is a strict superset of 514 * limited, and they share the same essential operational flow.</p> 515 * <p>For full details refer to "S3. Operational Modes" in camera3.h</p> 516 * @see #INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED 517 * @see #INFO_SUPPORTED_HARDWARE_LEVEL_FULL 518 */ 519 public static final Key<Integer> INFO_SUPPORTED_HARDWARE_LEVEL = 520 new Key<Integer>("android.info.supportedHardwareLevel", int.class); 521 522 /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ 523 * End generated code 524 *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/ 525} 526