Eino-Ville Talvala | b267554 | 2012-12-12 13:29:45 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2012 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 | |
Eino-Ville Talvala | 2f1a2e4 | 2013-07-25 17:12:05 -0700 | [diff] [blame] | 17 | package android.hardware.camera2; |
Eino-Ville Talvala | b267554 | 2012-12-12 13:29:45 -0800 | [diff] [blame] | 18 | |
| 19 | import android.graphics.Point; |
| 20 | import android.graphics.Rect; |
Eino-Ville Talvala | 70c2207 | 2013-08-27 12:09:04 -0700 | [diff] [blame] | 21 | import android.hardware.camera2.impl.CameraMetadataNative; |
Eino-Ville Talvala | b267554 | 2012-12-12 13:29:45 -0800 | [diff] [blame] | 22 | |
| 23 | /** |
| 24 | * <p>The results of a single image capture from the image sensor.</p> |
| 25 | * |
| 26 | * <p>Contains the final configuration for the capture hardware (sensor, lens, |
| 27 | * flash), the processing pipeline, the control algorithms, and the output |
| 28 | * buffers.</p> |
| 29 | * |
| 30 | * <p>CaptureResults are produced by a {@link CameraDevice} after processing a |
| 31 | * {@link CaptureRequest}. All properties listed for capture requests can also |
| 32 | * be queried on the capture result, to determine the final values used for |
| 33 | * capture. The result also includes additional metadata about the state of the |
| 34 | * camera device during the capture.</p> |
| 35 | * |
| 36 | */ |
| 37 | public final class CaptureResult extends CameraMetadata { |
Eino-Ville Talvala | 70c2207 | 2013-08-27 12:09:04 -0700 | [diff] [blame] | 38 | |
| 39 | private final CameraMetadataNative mResults; |
Igor Murashkin | 6bbf9dc | 2013-09-05 12:22:00 -0700 | [diff] [blame] | 40 | private final CaptureRequest mRequest; |
| 41 | private final int mSequenceId; |
Eino-Ville Talvala | 70c2207 | 2013-08-27 12:09:04 -0700 | [diff] [blame] | 42 | |
Igor Murashkin | 7072550 | 2013-06-25 20:27:06 +0000 | [diff] [blame] | 43 | /** |
Eino-Ville Talvala | 70c2207 | 2013-08-27 12:09:04 -0700 | [diff] [blame] | 44 | * Takes ownership of the passed-in properties object |
Igor Murashkin | 7072550 | 2013-06-25 20:27:06 +0000 | [diff] [blame] | 45 | * @hide |
| 46 | */ |
Igor Murashkin | 6bbf9dc | 2013-09-05 12:22:00 -0700 | [diff] [blame] | 47 | public CaptureResult(CameraMetadataNative results, CaptureRequest parent, int sequenceId) { |
| 48 | if (results == null) { |
| 49 | throw new IllegalArgumentException("results was null"); |
| 50 | } |
| 51 | |
| 52 | if (parent == null) { |
| 53 | throw new IllegalArgumentException("parent was null"); |
| 54 | } |
| 55 | |
Eino-Ville Talvala | 70c2207 | 2013-08-27 12:09:04 -0700 | [diff] [blame] | 56 | mResults = results; |
Igor Murashkin | 6bbf9dc | 2013-09-05 12:22:00 -0700 | [diff] [blame] | 57 | mRequest = parent; |
| 58 | mSequenceId = sequenceId; |
Eino-Ville Talvala | 70c2207 | 2013-08-27 12:09:04 -0700 | [diff] [blame] | 59 | } |
| 60 | |
| 61 | @Override |
| 62 | public <T> T get(Key<T> key) { |
| 63 | return mResults.get(key); |
Eino-Ville Talvala | b267554 | 2012-12-12 13:29:45 -0800 | [diff] [blame] | 64 | } |
| 65 | |
Igor Murashkin | 6bbf9dc | 2013-09-05 12:22:00 -0700 | [diff] [blame] | 66 | /** |
| 67 | * Get the request associated with this result. |
| 68 | * |
| 69 | * <p>Whenever a request is successfully captured, with |
| 70 | * {@link CameraDevice.CaptureListener#onCaptureCompleted}, |
| 71 | * the {@code result}'s {@code getRequest()} will return that {@code request}. |
| 72 | * </p> |
| 73 | * |
| 74 | * <p>In particular, |
| 75 | * <code><pre>cameraDevice.capture(someRequest, new CaptureListener() { |
| 76 | * {@literal @}Override |
| 77 | * void onCaptureCompleted(CaptureRequest myRequest, CaptureResult myResult) { |
| 78 | * assert(myResult.getRequest.equals(myRequest) == true); |
| 79 | * } |
| 80 | * }; |
| 81 | * </code></pre> |
| 82 | * </p> |
| 83 | * |
| 84 | * @return The request associated with this result. Never {@code null}. |
| 85 | */ |
| 86 | public CaptureRequest getRequest() { |
| 87 | return mRequest; |
| 88 | } |
| 89 | |
| 90 | /** |
| 91 | * Get the frame number associated with this result. |
| 92 | * |
| 93 | * <p>Whenever a request has been processed, regardless of failure or success, |
| 94 | * it gets a unique frame number assigned to its future result/failure.</p> |
| 95 | * |
| 96 | * <p>This value monotonically increments, starting with 0, |
| 97 | * for every new result or failure; and the scope is the lifetime of the |
| 98 | * {@link CameraDevice}.</p> |
| 99 | * |
| 100 | * @return int frame number |
| 101 | */ |
| 102 | public int getFrameNumber() { |
| 103 | return get(REQUEST_FRAME_COUNT); |
| 104 | } |
| 105 | |
| 106 | /** |
| 107 | * The sequence ID for this failure that was returned by the |
| 108 | * {@link CameraDevice#capture} family of functions. |
| 109 | * |
| 110 | * <p>The sequence ID is a unique monotonically increasing value starting from 0, |
| 111 | * incremented every time a new group of requests is submitted to the CameraDevice.</p> |
| 112 | * |
| 113 | * @return int The ID for the sequence of requests that this capture result is a part of |
| 114 | * |
| 115 | * @see CameraDevice.CaptureListener#onCaptureSequenceCompleted |
| 116 | */ |
| 117 | public int getSequenceId() { |
| 118 | return mSequenceId; |
| 119 | } |
| 120 | |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 121 | /*@O~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ |
| 122 | * The key entries below this point are generated from metadata |
| 123 | * definitions in /system/media/camera/docs. Do not modify by hand or |
| 124 | * modify the comment blocks at the start or end. |
| 125 | *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/ |
| 126 | |
| 127 | /** |
| 128 | * <p> |
| 129 | * A color transform matrix to use to transform |
| 130 | * from sensor RGB color space to output linear sRGB color space |
| 131 | * </p> |
| 132 | * <p> |
| 133 | * This matrix is either set by HAL when the request |
| 134 | * android.colorCorrection.mode is not TRANSFORM_MATRIX, or |
| 135 | * directly by the application in the request when the |
Igor Murashkin | d5ff06a | 2013-08-20 15:15:06 -0700 | [diff] [blame] | 136 | * android.colorCorrection.mode is TRANSFORM_MATRIX. |
| 137 | * </p><p> |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 138 | * In the latter case, the HAL may round the matrix to account |
| 139 | * for precision issues; the final rounded matrix should be |
| 140 | * reported back in this matrix result metadata. |
| 141 | * </p> |
| 142 | */ |
| 143 | public static final Key<Rational[]> COLOR_CORRECTION_TRANSFORM = |
| 144 | new Key<Rational[]>("android.colorCorrection.transform", Rational[].class); |
| 145 | |
| 146 | /** |
| 147 | * <p> |
| 148 | * Gains applying to Bayer color channels for |
| 149 | * white-balance |
| 150 | * </p> |
| 151 | * <p> |
| 152 | * The 4-channel white-balance gains are defined in |
| 153 | * the order of [R G_even G_odd B], where G_even is the gain |
| 154 | * for green pixels on even rows of the output, and G_odd |
| 155 | * is the gain for greenpixels on the odd rows. if a HAL |
| 156 | * does not support a separate gain for even/odd green channels, |
| 157 | * it should use the G_even value,and write G_odd equal to |
| 158 | * G_even in the output result metadata. |
| 159 | * </p><p> |
Igor Murashkin | d5ff06a | 2013-08-20 15:15:06 -0700 | [diff] [blame] | 160 | * This array is either set by HAL when the request |
| 161 | * android.colorCorrection.mode is not TRANSFORM_MATRIX, or |
| 162 | * directly by the application in the request when the |
| 163 | * android.colorCorrection.mode is TRANSFORM_MATRIX. |
| 164 | * </p><p> |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 165 | * The ouput should be the gains actually applied by the HAL to |
| 166 | * the current frame. |
| 167 | * </p> |
| 168 | */ |
| 169 | public static final Key<float[]> COLOR_CORRECTION_GAINS = |
| 170 | new Key<float[]>("android.colorCorrection.gains", float[].class); |
| 171 | |
| 172 | /** |
| 173 | * <p> |
| 174 | * The ID sent with the latest |
| 175 | * CAMERA2_TRIGGER_PRECAPTURE_METERING call |
| 176 | * </p> |
| 177 | * <p> |
| 178 | * Must be 0 if no |
| 179 | * CAMERA2_TRIGGER_PRECAPTURE_METERING trigger received yet |
| 180 | * by HAL. Always updated even if AE algorithm ignores the |
| 181 | * trigger |
| 182 | * </p> |
| 183 | * |
| 184 | * @hide |
| 185 | */ |
| 186 | public static final Key<Integer> CONTROL_AE_PRECAPTURE_ID = |
| 187 | new Key<Integer>("android.control.aePrecaptureId", int.class); |
| 188 | |
| 189 | /** |
| 190 | * <p> |
| 191 | * List of areas to use for |
| 192 | * metering |
| 193 | * </p> |
| 194 | * <p> |
| 195 | * Each area is a rectangle plus weight: xmin, ymin, |
Timothy Knight | 2629f27 | 2013-09-03 17:23:23 -0700 | [diff] [blame] | 196 | * xmax, ymax, weight. The rectangle is defined inclusive of the |
| 197 | * specified coordinates. |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 198 | * </p><p> |
| 199 | * The coordinate system is based on the active pixel array, |
Timothy Knight | 2629f27 | 2013-09-03 17:23:23 -0700 | [diff] [blame] | 200 | * with (0,0) being the top-left pixel in the active pixel array, and |
| 201 | * (android.sensor.info.activeArraySize.width - 1, |
| 202 | * android.sensor.info.activeArraySize.height - 1) being the |
| 203 | * bottom-right pixel in the active pixel array. The weight |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 204 | * should be nonnegative. |
| 205 | * </p><p> |
| 206 | * If all regions have 0 weight, then no specific metering area |
| 207 | * needs to be used by the HAL. If the metering region is |
| 208 | * outside the current android.scaler.cropRegion, the HAL |
| 209 | * should ignore the sections outside the region and output the |
| 210 | * used sections in the frame metadata |
| 211 | * </p> |
| 212 | */ |
| 213 | public static final Key<int[]> CONTROL_AE_REGIONS = |
| 214 | new Key<int[]>("android.control.aeRegions", int[].class); |
| 215 | |
| 216 | /** |
| 217 | * <p> |
| 218 | * Current state of AE algorithm |
| 219 | * </p> |
| 220 | * <p> |
| 221 | * Whenever the AE algorithm state changes, a |
| 222 | * MSG_AUTOEXPOSURE notification must be send if a |
| 223 | * notification callback is registered. |
| 224 | * </p> |
| 225 | * @see #CONTROL_AE_STATE_INACTIVE |
| 226 | * @see #CONTROL_AE_STATE_SEARCHING |
| 227 | * @see #CONTROL_AE_STATE_CONVERGED |
| 228 | * @see #CONTROL_AE_STATE_LOCKED |
| 229 | * @see #CONTROL_AE_STATE_FLASH_REQUIRED |
| 230 | * @see #CONTROL_AE_STATE_PRECAPTURE |
| 231 | */ |
| 232 | public static final Key<Integer> CONTROL_AE_STATE = |
| 233 | new Key<Integer>("android.control.aeState", int.class); |
| 234 | |
| 235 | /** |
| 236 | * <p> |
| 237 | * Whether AF is currently enabled, and what |
| 238 | * mode it is set to |
| 239 | * </p> |
| 240 | * @see #CONTROL_AF_MODE_OFF |
| 241 | * @see #CONTROL_AF_MODE_AUTO |
| 242 | * @see #CONTROL_AF_MODE_MACRO |
| 243 | * @see #CONTROL_AF_MODE_CONTINUOUS_VIDEO |
| 244 | * @see #CONTROL_AF_MODE_CONTINUOUS_PICTURE |
| 245 | * @see #CONTROL_AF_MODE_EDOF |
| 246 | */ |
| 247 | public static final Key<Integer> CONTROL_AF_MODE = |
| 248 | new Key<Integer>("android.control.afMode", int.class); |
| 249 | |
| 250 | /** |
| 251 | * <p> |
| 252 | * List of areas to use for focus |
| 253 | * estimation |
| 254 | * </p> |
| 255 | * <p> |
| 256 | * Each area is a rectangle plus weight: xmin, ymin, |
Timothy Knight | 2629f27 | 2013-09-03 17:23:23 -0700 | [diff] [blame] | 257 | * xmax, ymax, weight. The rectangle is defined inclusive of the |
| 258 | * specified coordinates. |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 259 | * </p><p> |
| 260 | * The coordinate system is based on the active pixel array, |
Timothy Knight | 2629f27 | 2013-09-03 17:23:23 -0700 | [diff] [blame] | 261 | * with (0,0) being the top-left pixel in the active pixel array, and |
| 262 | * (android.sensor.info.activeArraySize.width - 1, |
| 263 | * android.sensor.info.activeArraySize.height - 1) being the |
| 264 | * bottom-right pixel in the active pixel array. The weight |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 265 | * should be nonnegative. |
| 266 | * </p><p> |
| 267 | * If all regions have 0 weight, then no specific focus area |
| 268 | * needs to be used by the HAL. If the focusing region is |
| 269 | * outside the current android.scaler.cropRegion, the HAL |
| 270 | * should ignore the sections outside the region and output the |
| 271 | * used sections in the frame metadata |
| 272 | * </p> |
| 273 | */ |
| 274 | public static final Key<int[]> CONTROL_AF_REGIONS = |
| 275 | new Key<int[]>("android.control.afRegions", int[].class); |
| 276 | |
| 277 | /** |
| 278 | * <p> |
| 279 | * Current state of AF algorithm |
| 280 | * </p> |
| 281 | * <p> |
| 282 | * Whenever the AF algorithm state changes, a |
| 283 | * MSG_AUTOFOCUS notification must be send if a notification |
| 284 | * callback is registered. |
| 285 | * </p> |
| 286 | * @see #CONTROL_AF_STATE_INACTIVE |
| 287 | * @see #CONTROL_AF_STATE_PASSIVE_SCAN |
| 288 | * @see #CONTROL_AF_STATE_PASSIVE_FOCUSED |
| 289 | * @see #CONTROL_AF_STATE_ACTIVE_SCAN |
| 290 | * @see #CONTROL_AF_STATE_FOCUSED_LOCKED |
| 291 | * @see #CONTROL_AF_STATE_NOT_FOCUSED_LOCKED |
Eino-Ville Talvala | 9f880f7 | 2013-09-20 17:50:41 -0700 | [diff] [blame] | 292 | * @see #CONTROL_AF_STATE_PASSIVE_UNFOCUSED |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 293 | */ |
| 294 | public static final Key<Integer> CONTROL_AF_STATE = |
| 295 | new Key<Integer>("android.control.afState", int.class); |
| 296 | |
| 297 | /** |
| 298 | * <p> |
| 299 | * The ID sent with the latest |
| 300 | * CAMERA2_TRIGGER_AUTOFOCUS call |
| 301 | * </p> |
| 302 | * <p> |
| 303 | * Must be 0 if no CAMERA2_TRIGGER_AUTOFOCUS trigger |
| 304 | * received yet by HAL. Always updated even if AF algorithm |
| 305 | * ignores the trigger |
| 306 | * </p> |
| 307 | * |
| 308 | * @hide |
| 309 | */ |
| 310 | public static final Key<Integer> CONTROL_AF_TRIGGER_ID = |
| 311 | new Key<Integer>("android.control.afTriggerId", int.class); |
| 312 | |
| 313 | /** |
| 314 | * <p> |
| 315 | * Whether AWB is currently setting the color |
| 316 | * transform fields, and what its illumination target |
| 317 | * is |
| 318 | * </p> |
| 319 | * <p> |
| 320 | * [BC - AWB lock,AWB modes] |
| 321 | * </p> |
| 322 | * @see #CONTROL_AWB_MODE_OFF |
| 323 | * @see #CONTROL_AWB_MODE_AUTO |
| 324 | * @see #CONTROL_AWB_MODE_INCANDESCENT |
| 325 | * @see #CONTROL_AWB_MODE_FLUORESCENT |
| 326 | * @see #CONTROL_AWB_MODE_WARM_FLUORESCENT |
| 327 | * @see #CONTROL_AWB_MODE_DAYLIGHT |
| 328 | * @see #CONTROL_AWB_MODE_CLOUDY_DAYLIGHT |
| 329 | * @see #CONTROL_AWB_MODE_TWILIGHT |
| 330 | * @see #CONTROL_AWB_MODE_SHADE |
| 331 | */ |
| 332 | public static final Key<Integer> CONTROL_AWB_MODE = |
| 333 | new Key<Integer>("android.control.awbMode", int.class); |
| 334 | |
| 335 | /** |
| 336 | * <p> |
| 337 | * List of areas to use for illuminant |
| 338 | * estimation |
| 339 | * </p> |
| 340 | * <p> |
| 341 | * Only used in AUTO mode. |
| 342 | * </p><p> |
Timothy Knight | 2629f27 | 2013-09-03 17:23:23 -0700 | [diff] [blame] | 343 | * Each area is a rectangle plus weight: xmin, ymin, |
| 344 | * xmax, ymax, weight. The rectangle is defined inclusive of the |
| 345 | * specified coordinates. |
| 346 | * </p><p> |
| 347 | * The coordinate system is based on the active pixel array, |
| 348 | * with (0,0) being the top-left pixel in the active pixel array, and |
| 349 | * (android.sensor.info.activeArraySize.width - 1, |
| 350 | * android.sensor.info.activeArraySize.height - 1) being the |
| 351 | * bottom-right pixel in the active pixel array. The weight |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 352 | * should be nonnegative. |
| 353 | * </p><p> |
| 354 | * If all regions have 0 weight, then no specific metering area |
| 355 | * needs to be used by the HAL. If the metering region is |
| 356 | * outside the current android.scaler.cropRegion, the HAL |
| 357 | * should ignore the sections outside the region and output the |
| 358 | * used sections in the frame metadata |
| 359 | * </p> |
| 360 | */ |
| 361 | public static final Key<int[]> CONTROL_AWB_REGIONS = |
| 362 | new Key<int[]>("android.control.awbRegions", int[].class); |
| 363 | |
| 364 | /** |
| 365 | * <p> |
| 366 | * Current state of AWB algorithm |
| 367 | * </p> |
| 368 | * <p> |
| 369 | * Whenever the AWB algorithm state changes, a |
| 370 | * MSG_AUTOWHITEBALANCE notification must be send if a |
| 371 | * notification callback is registered. |
| 372 | * </p> |
| 373 | * @see #CONTROL_AWB_STATE_INACTIVE |
| 374 | * @see #CONTROL_AWB_STATE_SEARCHING |
| 375 | * @see #CONTROL_AWB_STATE_CONVERGED |
| 376 | * @see #CONTROL_AWB_STATE_LOCKED |
| 377 | */ |
| 378 | public static final Key<Integer> CONTROL_AWB_STATE = |
| 379 | new Key<Integer>("android.control.awbState", int.class); |
| 380 | |
| 381 | /** |
| 382 | * <p> |
| 383 | * Overall mode of 3A control |
| 384 | * routines |
| 385 | * </p> |
| 386 | * @see #CONTROL_MODE_OFF |
| 387 | * @see #CONTROL_MODE_AUTO |
| 388 | * @see #CONTROL_MODE_USE_SCENE_MODE |
| 389 | */ |
| 390 | public static final Key<Integer> CONTROL_MODE = |
| 391 | new Key<Integer>("android.control.mode", int.class); |
| 392 | |
| 393 | /** |
| 394 | * <p> |
| 395 | * Operation mode for edge |
| 396 | * enhancement |
| 397 | * </p> |
| 398 | * @see #EDGE_MODE_OFF |
| 399 | * @see #EDGE_MODE_FAST |
| 400 | * @see #EDGE_MODE_HIGH_QUALITY |
| 401 | */ |
| 402 | public static final Key<Integer> EDGE_MODE = |
| 403 | new Key<Integer>("android.edge.mode", int.class); |
| 404 | |
| 405 | /** |
| 406 | * <p> |
| 407 | * Select flash operation mode |
| 408 | * </p> |
| 409 | * @see #FLASH_MODE_OFF |
| 410 | * @see #FLASH_MODE_SINGLE |
| 411 | * @see #FLASH_MODE_TORCH |
| 412 | */ |
| 413 | public static final Key<Integer> FLASH_MODE = |
| 414 | new Key<Integer>("android.flash.mode", int.class); |
| 415 | |
| 416 | /** |
| 417 | * <p> |
| 418 | * Current state of the flash |
| 419 | * unit |
| 420 | * </p> |
| 421 | * @see #FLASH_STATE_UNAVAILABLE |
| 422 | * @see #FLASH_STATE_CHARGING |
| 423 | * @see #FLASH_STATE_READY |
| 424 | * @see #FLASH_STATE_FIRED |
| 425 | */ |
| 426 | public static final Key<Integer> FLASH_STATE = |
| 427 | new Key<Integer>("android.flash.state", int.class); |
| 428 | |
| 429 | /** |
| 430 | * <p> |
| 431 | * GPS coordinates to include in output JPEG |
| 432 | * EXIF |
| 433 | * </p> |
| 434 | */ |
| 435 | public static final Key<double[]> JPEG_GPS_COORDINATES = |
| 436 | new Key<double[]>("android.jpeg.gpsCoordinates", double[].class); |
| 437 | |
| 438 | /** |
| 439 | * <p> |
| 440 | * 32 characters describing GPS algorithm to |
| 441 | * include in EXIF |
| 442 | * </p> |
| 443 | */ |
| 444 | public static final Key<String> JPEG_GPS_PROCESSING_METHOD = |
| 445 | new Key<String>("android.jpeg.gpsProcessingMethod", String.class); |
| 446 | |
| 447 | /** |
| 448 | * <p> |
| 449 | * Time GPS fix was made to include in |
| 450 | * EXIF |
| 451 | * </p> |
| 452 | */ |
| 453 | public static final Key<Long> JPEG_GPS_TIMESTAMP = |
| 454 | new Key<Long>("android.jpeg.gpsTimestamp", long.class); |
| 455 | |
| 456 | /** |
| 457 | * <p> |
| 458 | * Orientation of JPEG image to |
| 459 | * write |
| 460 | * </p> |
| 461 | */ |
| 462 | public static final Key<Integer> JPEG_ORIENTATION = |
| 463 | new Key<Integer>("android.jpeg.orientation", int.class); |
| 464 | |
| 465 | /** |
| 466 | * <p> |
| 467 | * Compression quality of the final JPEG |
| 468 | * image |
| 469 | * </p> |
| 470 | * <p> |
| 471 | * 85-95 is typical usage range |
| 472 | * </p> |
| 473 | */ |
| 474 | public static final Key<Byte> JPEG_QUALITY = |
| 475 | new Key<Byte>("android.jpeg.quality", byte.class); |
| 476 | |
| 477 | /** |
| 478 | * <p> |
| 479 | * Compression quality of JPEG |
| 480 | * thumbnail |
| 481 | * </p> |
| 482 | */ |
| 483 | public static final Key<Byte> JPEG_THUMBNAIL_QUALITY = |
| 484 | new Key<Byte>("android.jpeg.thumbnailQuality", byte.class); |
| 485 | |
| 486 | /** |
| 487 | * <p> |
| 488 | * Resolution of embedded JPEG |
| 489 | * thumbnail |
| 490 | * </p> |
| 491 | */ |
| 492 | public static final Key<android.hardware.camera2.Size> JPEG_THUMBNAIL_SIZE = |
| 493 | new Key<android.hardware.camera2.Size>("android.jpeg.thumbnailSize", android.hardware.camera2.Size.class); |
| 494 | |
| 495 | /** |
| 496 | * <p> |
| 497 | * Size of the lens aperture |
| 498 | * </p> |
| 499 | * <p> |
| 500 | * Will not be supported on most devices. Can only |
| 501 | * pick from supported list |
| 502 | * </p> |
| 503 | */ |
| 504 | public static final Key<Float> LENS_APERTURE = |
| 505 | new Key<Float>("android.lens.aperture", float.class); |
| 506 | |
| 507 | /** |
| 508 | * <p> |
| 509 | * State of lens neutral density |
| 510 | * filter(s) |
| 511 | * </p> |
| 512 | * <p> |
| 513 | * Will not be supported on most devices. Can only |
| 514 | * pick from supported list |
| 515 | * </p> |
| 516 | */ |
| 517 | public static final Key<Float> LENS_FILTER_DENSITY = |
| 518 | new Key<Float>("android.lens.filterDensity", float.class); |
| 519 | |
| 520 | /** |
| 521 | * <p> |
| 522 | * Lens optical zoom setting |
| 523 | * </p> |
| 524 | * <p> |
| 525 | * Will not be supported on most devices. |
| 526 | * </p> |
| 527 | */ |
| 528 | public static final Key<Float> LENS_FOCAL_LENGTH = |
| 529 | new Key<Float>("android.lens.focalLength", float.class); |
| 530 | |
| 531 | /** |
| 532 | * <p> |
| 533 | * Distance to plane of sharpest focus, |
| 534 | * measured from frontmost surface of the lens |
| 535 | * </p> |
| 536 | * <p> |
| 537 | * Should be zero for fixed-focus cameras |
| 538 | * </p> |
| 539 | */ |
| 540 | public static final Key<Float> LENS_FOCUS_DISTANCE = |
| 541 | new Key<Float>("android.lens.focusDistance", float.class); |
| 542 | |
| 543 | /** |
| 544 | * <p> |
| 545 | * The range of scene distances that are in |
| 546 | * sharp focus (depth of field) |
| 547 | * </p> |
| 548 | * <p> |
| 549 | * If variable focus not supported, can still report |
| 550 | * fixed depth of field range |
| 551 | * </p> |
| 552 | */ |
Zhijun He | c59b078 | 2013-09-26 10:39:36 -0700 | [diff] [blame] | 553 | public static final Key<float[]> LENS_FOCUS_RANGE = |
| 554 | new Key<float[]>("android.lens.focusRange", float[].class); |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 555 | |
| 556 | /** |
| 557 | * <p> |
| 558 | * Whether optical image stabilization is |
| 559 | * enabled. |
| 560 | * </p> |
| 561 | * <p> |
| 562 | * Will not be supported on most devices. |
| 563 | * </p> |
| 564 | * @see #LENS_OPTICAL_STABILIZATION_MODE_OFF |
| 565 | * @see #LENS_OPTICAL_STABILIZATION_MODE_ON |
| 566 | */ |
| 567 | public static final Key<Integer> LENS_OPTICAL_STABILIZATION_MODE = |
| 568 | new Key<Integer>("android.lens.opticalStabilizationMode", int.class); |
| 569 | |
| 570 | /** |
| 571 | * <p> |
| 572 | * Current lens status |
| 573 | * </p> |
| 574 | * @see #LENS_STATE_STATIONARY |
Igor Murashkin | 9ea4ae6 | 2013-09-11 21:40:11 -0700 | [diff] [blame] | 575 | * @see #LENS_STATE_MOVING |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 576 | */ |
| 577 | public static final Key<Integer> LENS_STATE = |
| 578 | new Key<Integer>("android.lens.state", int.class); |
| 579 | |
| 580 | /** |
| 581 | * <p> |
| 582 | * Mode of operation for the noise reduction |
| 583 | * algorithm |
| 584 | * </p> |
| 585 | * @see #NOISE_REDUCTION_MODE_OFF |
| 586 | * @see #NOISE_REDUCTION_MODE_FAST |
| 587 | * @see #NOISE_REDUCTION_MODE_HIGH_QUALITY |
| 588 | */ |
| 589 | public static final Key<Integer> NOISE_REDUCTION_MODE = |
| 590 | new Key<Integer>("android.noiseReduction.mode", int.class); |
| 591 | |
| 592 | /** |
| 593 | * <p> |
Eino-Ville Talvala | 7a31310 | 2013-11-07 14:45:06 -0800 | [diff] [blame] | 594 | * Whether a result given to the framework is the |
| 595 | * final one for the capture, or only a partial that contains a |
| 596 | * subset of the full set of dynamic metadata |
| 597 | * values. |
| 598 | * </p> |
| 599 | * <p> |
| 600 | * The entries in the result metadata buffers for a |
| 601 | * single capture may not overlap, except for this entry. The |
| 602 | * FINAL buffers must retain FIFO ordering relative to the |
| 603 | * requests that generate them, so the FINAL buffer for frame 3 must |
| 604 | * always be sent to the framework after the FINAL buffer for frame 2, and |
| 605 | * before the FINAL buffer for frame 4. PARTIAL buffers may be returned |
| 606 | * in any order relative to other frames, but all PARTIAL buffers for a given |
| 607 | * capture must arrive before the FINAL buffer for that capture. This entry may |
| 608 | * only be used by the HAL if quirks.usePartialResult is set to 1. |
| 609 | * </p> |
| 610 | * |
| 611 | * <b>Optional</b> - This value may be null on some devices. |
| 612 | * |
| 613 | * @hide |
| 614 | */ |
| 615 | public static final Key<Boolean> QUIRKS_PARTIAL_RESULT = |
| 616 | new Key<Boolean>("android.quirks.partialResult", boolean.class); |
| 617 | |
| 618 | /** |
| 619 | * <p> |
Igor Murashkin | 6bbf9dc | 2013-09-05 12:22:00 -0700 | [diff] [blame] | 620 | * A frame counter set by the framework. This value monotonically |
| 621 | * increases with every new result (that is, each new result has a unique |
| 622 | * frameCount value). |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 623 | * </p> |
| 624 | * <p> |
| 625 | * Reset on release() |
| 626 | * </p> |
| 627 | */ |
| 628 | public static final Key<Integer> REQUEST_FRAME_COUNT = |
| 629 | new Key<Integer>("android.request.frameCount", int.class); |
| 630 | |
| 631 | /** |
| 632 | * <p> |
| 633 | * An application-specified ID for the current |
| 634 | * request. Must be maintained unchanged in output |
| 635 | * frame |
| 636 | * </p> |
| 637 | * |
| 638 | * @hide |
| 639 | */ |
| 640 | public static final Key<Integer> REQUEST_ID = |
| 641 | new Key<Integer>("android.request.id", int.class); |
| 642 | |
| 643 | /** |
| 644 | * <p> |
| 645 | * (x, y, width, height). |
| 646 | * </p><p> |
| 647 | * A rectangle with the top-level corner of (x,y) and size |
| 648 | * (width, height). The region of the sensor that is used for |
| 649 | * output. Each stream must use this rectangle to produce its |
| 650 | * output, cropping to a smaller region if necessary to |
| 651 | * maintain the stream's aspect ratio. |
| 652 | * </p><p> |
| 653 | * HAL2.x uses only (x, y, width) |
| 654 | * </p> |
| 655 | * <p> |
| 656 | * Any additional per-stream cropping must be done to |
| 657 | * maximize the final pixel area of the stream. |
| 658 | * </p><p> |
| 659 | * For example, if the crop region is set to a 4:3 aspect |
| 660 | * ratio, then 4:3 streams should use the exact crop |
| 661 | * region. 16:9 streams should further crop vertically |
| 662 | * (letterbox). |
| 663 | * </p><p> |
| 664 | * Conversely, if the crop region is set to a 16:9, then 4:3 |
| 665 | * outputs should crop horizontally (pillarbox), and 16:9 |
| 666 | * streams should match exactly. These additional crops must |
| 667 | * be centered within the crop region. |
| 668 | * </p><p> |
| 669 | * The output streams must maintain square pixels at all |
| 670 | * times, no matter what the relative aspect ratios of the |
| 671 | * crop region and the stream are. Negative values for |
| 672 | * corner are allowed for raw output if full pixel array is |
| 673 | * larger than active pixel array. Width and height may be |
| 674 | * rounded to nearest larger supportable width, especially |
| 675 | * for raw output, where only a few fixed scales may be |
| 676 | * possible. The width and height of the crop region cannot |
| 677 | * be set to be smaller than floor( activeArraySize.width / |
| 678 | * android.scaler.maxDigitalZoom ) and floor( |
| 679 | * activeArraySize.height / android.scaler.maxDigitalZoom), |
| 680 | * respectively. |
| 681 | * </p> |
| 682 | */ |
| 683 | public static final Key<android.graphics.Rect> SCALER_CROP_REGION = |
| 684 | new Key<android.graphics.Rect>("android.scaler.cropRegion", android.graphics.Rect.class); |
| 685 | |
| 686 | /** |
| 687 | * <p> |
| 688 | * Duration each pixel is exposed to |
Igor Murashkin | d5ff06a | 2013-08-20 15:15:06 -0700 | [diff] [blame] | 689 | * light. |
| 690 | * </p><p> |
| 691 | * If the sensor can't expose this exact duration, it should shorten the |
| 692 | * duration exposed to the nearest possible value (rather than expose longer). |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 693 | * </p> |
| 694 | * <p> |
| 695 | * 1/10000 - 30 sec range. No bulb mode |
| 696 | * </p> |
| 697 | */ |
| 698 | public static final Key<Long> SENSOR_EXPOSURE_TIME = |
| 699 | new Key<Long>("android.sensor.exposureTime", long.class); |
| 700 | |
| 701 | /** |
| 702 | * <p> |
| 703 | * Duration from start of frame exposure to |
| 704 | * start of next frame exposure |
| 705 | * </p> |
| 706 | * <p> |
| 707 | * Exposure time has priority, so duration is set to |
| 708 | * max(duration, exposure time + overhead) |
| 709 | * </p> |
| 710 | */ |
| 711 | public static final Key<Long> SENSOR_FRAME_DURATION = |
| 712 | new Key<Long>("android.sensor.frameDuration", long.class); |
| 713 | |
| 714 | /** |
| 715 | * <p> |
| 716 | * Gain applied to image data. Must be |
| 717 | * implemented through analog gain only if set to values |
| 718 | * below 'maximum analog sensitivity'. |
Igor Murashkin | d5ff06a | 2013-08-20 15:15:06 -0700 | [diff] [blame] | 719 | * </p><p> |
| 720 | * If the sensor can't apply this exact gain, it should lessen the |
| 721 | * gain to the nearest possible value (rather than gain more). |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 722 | * </p> |
| 723 | * <p> |
| 724 | * ISO 12232:2006 REI method |
| 725 | * </p> |
| 726 | */ |
| 727 | public static final Key<Integer> SENSOR_SENSITIVITY = |
| 728 | new Key<Integer>("android.sensor.sensitivity", int.class); |
| 729 | |
| 730 | /** |
| 731 | * <p> |
| 732 | * Time at start of exposure of first |
| 733 | * row |
| 734 | * </p> |
| 735 | * <p> |
| 736 | * Monotonic, should be synced to other timestamps in |
| 737 | * system |
| 738 | * </p> |
| 739 | */ |
| 740 | public static final Key<Long> SENSOR_TIMESTAMP = |
| 741 | new Key<Long>("android.sensor.timestamp", long.class); |
| 742 | |
| 743 | /** |
| 744 | * <p> |
Igor Murashkin | d5ff06a | 2013-08-20 15:15:06 -0700 | [diff] [blame] | 745 | * The temperature of the sensor, sampled at the time |
| 746 | * exposure began for this frame. |
| 747 | * </p><p> |
| 748 | * The thermal diode being queried should be inside the sensor PCB, or |
| 749 | * somewhere close to it. |
| 750 | * </p> |
Alex Ray | e83c4eb | 2013-10-02 17:14:36 -0700 | [diff] [blame] | 751 | * |
| 752 | * <b>Optional</b> - This value may be null on some devices. |
| 753 | * |
| 754 | * <b>{@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL}</b> - |
| 755 | * Present on all devices that report being FULL level hardware devices in the |
| 756 | * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL HARDWARE_LEVEL} key. |
Igor Murashkin | d5ff06a | 2013-08-20 15:15:06 -0700 | [diff] [blame] | 757 | */ |
| 758 | public static final Key<Float> SENSOR_TEMPERATURE = |
| 759 | new Key<Float>("android.sensor.temperature", float.class); |
| 760 | |
| 761 | /** |
| 762 | * <p> |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 763 | * State of the face detector |
| 764 | * unit |
| 765 | * </p> |
| 766 | * <p> |
| 767 | * Whether face detection is enabled, and whether it |
| 768 | * should output just the basic fields or the full set of |
| 769 | * fields. Value must be one of the |
| 770 | * android.statistics.info.availableFaceDetectModes. |
| 771 | * </p> |
| 772 | * @see #STATISTICS_FACE_DETECT_MODE_OFF |
| 773 | * @see #STATISTICS_FACE_DETECT_MODE_SIMPLE |
| 774 | * @see #STATISTICS_FACE_DETECT_MODE_FULL |
| 775 | */ |
| 776 | public static final Key<Integer> STATISTICS_FACE_DETECT_MODE = |
| 777 | new Key<Integer>("android.statistics.faceDetectMode", int.class); |
| 778 | |
| 779 | /** |
| 780 | * <p> |
| 781 | * List of unique IDs for detected |
| 782 | * faces |
| 783 | * </p> |
| 784 | * <p> |
| 785 | * Only available if faceDetectMode == FULL |
| 786 | * </p> |
| 787 | */ |
| 788 | public static final Key<int[]> STATISTICS_FACE_IDS = |
| 789 | new Key<int[]>("android.statistics.faceIds", int[].class); |
| 790 | |
| 791 | /** |
| 792 | * <p> |
| 793 | * List of landmarks for detected |
| 794 | * faces |
| 795 | * </p> |
| 796 | * <p> |
| 797 | * Only available if faceDetectMode == FULL |
| 798 | * </p> |
| 799 | */ |
| 800 | public static final Key<int[]> STATISTICS_FACE_LANDMARKS = |
| 801 | new Key<int[]>("android.statistics.faceLandmarks", int[].class); |
| 802 | |
| 803 | /** |
| 804 | * <p> |
| 805 | * List of the bounding rectangles for detected |
| 806 | * faces |
| 807 | * </p> |
| 808 | * <p> |
| 809 | * Only available if faceDetectMode != OFF |
| 810 | * </p> |
| 811 | */ |
| 812 | public static final Key<android.graphics.Rect[]> STATISTICS_FACE_RECTANGLES = |
| 813 | new Key<android.graphics.Rect[]>("android.statistics.faceRectangles", android.graphics.Rect[].class); |
| 814 | |
| 815 | /** |
| 816 | * <p> |
| 817 | * List of the face confidence scores for |
| 818 | * detected faces |
| 819 | * </p> |
| 820 | * <p> |
Igor Murashkin | d5ff06a | 2013-08-20 15:15:06 -0700 | [diff] [blame] | 821 | * Only available if faceDetectMode != OFF. The value should be |
| 822 | * meaningful (for example, setting 100 at all times is illegal). |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 823 | * </p> |
| 824 | */ |
| 825 | public static final Key<byte[]> STATISTICS_FACE_SCORES = |
| 826 | new Key<byte[]>("android.statistics.faceScores", byte[].class); |
| 827 | |
| 828 | /** |
| 829 | * <p> |
| 830 | * A low-resolution map of lens shading, per |
| 831 | * color channel |
| 832 | * </p> |
| 833 | * <p> |
| 834 | * Assume bilinear interpolation of map. The least |
| 835 | * shaded section of the image should have a gain factor |
| 836 | * of 1; all other sections should have gains above 1. |
| 837 | * the map should be on the order of 30-40 rows, and |
| 838 | * must be smaller than 64x64. |
Igor Murashkin | d5ff06a | 2013-08-20 15:15:06 -0700 | [diff] [blame] | 839 | * </p><p> |
| 840 | * When android.colorCorrection.mode = TRANSFORM_MATRIX, the map |
| 841 | * must take into account the colorCorrection settings. |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 842 | * </p> |
| 843 | */ |
| 844 | public static final Key<float[]> STATISTICS_LENS_SHADING_MAP = |
| 845 | new Key<float[]>("android.statistics.lensShadingMap", float[].class); |
| 846 | |
| 847 | /** |
| 848 | * <p> |
| 849 | * The best-fit color channel gains calculated |
| 850 | * by the HAL's statistics units for the current output frame |
| 851 | * </p> |
| 852 | * <p> |
| 853 | * This may be different than the gains used for this frame, |
| 854 | * since statistics processing on data from a new frame |
| 855 | * typically completes after the transform has already been |
| 856 | * applied to that frame. |
| 857 | * </p><p> |
| 858 | * The 4 channel gains are defined in Bayer domain, |
| 859 | * see android.colorCorrection.gains for details. |
Igor Murashkin | d5ff06a | 2013-08-20 15:15:06 -0700 | [diff] [blame] | 860 | * </p><p> |
| 861 | * This value should always be calculated by the AWB block, |
| 862 | * regardless of the android.control.* current values. |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 863 | * </p> |
| 864 | */ |
| 865 | public static final Key<float[]> STATISTICS_PREDICTED_COLOR_GAINS = |
| 866 | new Key<float[]>("android.statistics.predictedColorGains", float[].class); |
| 867 | |
| 868 | /** |
| 869 | * <p> |
| 870 | * The best-fit color transform matrix estimate |
| 871 | * calculated by the HAL's statistics units for the current |
| 872 | * output frame |
| 873 | * </p> |
| 874 | * <p> |
| 875 | * The HAL must provide the estimate from its |
| 876 | * statistics unit on the white balance transforms to use |
| 877 | * for the next frame. These are the values the HAL believes |
| 878 | * are the best fit for the current output frame. This may |
| 879 | * be different than the transform used for this frame, since |
| 880 | * statistics processing on data from a new frame typically |
| 881 | * completes after the transform has already been applied to |
| 882 | * that frame. |
| 883 | * </p><p> |
| 884 | * These estimates must be provided for all frames, even if |
| 885 | * capture settings and color transforms are set by the application. |
Igor Murashkin | d5ff06a | 2013-08-20 15:15:06 -0700 | [diff] [blame] | 886 | * </p><p> |
| 887 | * This value should always be calculated by the AWB block, |
| 888 | * regardless of the android.control.* current values. |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 889 | * </p> |
| 890 | */ |
| 891 | public static final Key<Rational[]> STATISTICS_PREDICTED_COLOR_TRANSFORM = |
| 892 | new Key<Rational[]>("android.statistics.predictedColorTransform", Rational[].class); |
| 893 | |
| 894 | /** |
| 895 | * <p> |
| 896 | * The HAL estimated scene illumination lighting |
| 897 | * frequency |
| 898 | * </p> |
| 899 | * <p> |
| 900 | * Report NONE if there doesn't appear to be flickering |
| 901 | * illumination |
| 902 | * </p> |
| 903 | * @see #STATISTICS_SCENE_FLICKER_NONE |
| 904 | * @see #STATISTICS_SCENE_FLICKER_50HZ |
| 905 | * @see #STATISTICS_SCENE_FLICKER_60HZ |
| 906 | */ |
| 907 | public static final Key<Integer> STATISTICS_SCENE_FLICKER = |
| 908 | new Key<Integer>("android.statistics.sceneFlicker", int.class); |
| 909 | |
| 910 | /** |
| 911 | * <p> |
| 912 | * Table mapping blue input values to output |
| 913 | * values |
| 914 | * </p> |
Zhijun He | 3ffd705 | 2013-08-19 15:45:08 -0700 | [diff] [blame] | 915 | * <p> |
| 916 | * Tonemapping / contrast / gamma curve for the blue |
| 917 | * channel, to use when android.tonemap.mode is CONTRAST_CURVE. |
| 918 | * </p><p> |
| 919 | * See android.tonemap.curveRed for more details. |
| 920 | * </p> |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 921 | */ |
Zhijun He | 3ffd705 | 2013-08-19 15:45:08 -0700 | [diff] [blame] | 922 | public static final Key<float[]> TONEMAP_CURVE_BLUE = |
| 923 | new Key<float[]>("android.tonemap.curveBlue", float[].class); |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 924 | |
| 925 | /** |
| 926 | * <p> |
| 927 | * Table mapping green input values to output |
| 928 | * values |
| 929 | * </p> |
Zhijun He | 3ffd705 | 2013-08-19 15:45:08 -0700 | [diff] [blame] | 930 | * <p> |
| 931 | * Tonemapping / contrast / gamma curve for the green |
| 932 | * channel, to use when android.tonemap.mode is CONTRAST_CURVE. |
| 933 | * </p><p> |
| 934 | * See android.tonemap.curveRed for more details. |
| 935 | * </p> |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 936 | */ |
Zhijun He | 3ffd705 | 2013-08-19 15:45:08 -0700 | [diff] [blame] | 937 | public static final Key<float[]> TONEMAP_CURVE_GREEN = |
| 938 | new Key<float[]>("android.tonemap.curveGreen", float[].class); |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 939 | |
| 940 | /** |
| 941 | * <p> |
| 942 | * Table mapping red input values to output |
| 943 | * values |
| 944 | * </p> |
| 945 | * <p> |
Zhijun He | 3ffd705 | 2013-08-19 15:45:08 -0700 | [diff] [blame] | 946 | * Tonemapping / contrast / gamma curve for the red |
| 947 | * channel, to use when android.tonemap.mode is CONTRAST_CURVE. |
| 948 | * </p><p> |
| 949 | * Since the input and output ranges may vary depending on |
| 950 | * the camera pipeline, the input and output pixel values |
| 951 | * are represented by normalized floating-point values |
| 952 | * between 0 and 1, with 0 == black and 1 == white. |
| 953 | * </p><p> |
| 954 | * The curve should be linearly interpolated between the |
| 955 | * defined points. The points will be listed in increasing |
| 956 | * order of P_IN. For example, if the array is: [0.0, 0.0, |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 957 | * 0.3, 0.5, 1.0, 1.0], then the input->output mapping |
| 958 | * for a few sample points would be: 0 -> 0, 0.15 -> |
| 959 | * 0.25, 0.3 -> 0.5, 0.5 -> 0.64 |
| 960 | * </p> |
| 961 | */ |
| 962 | public static final Key<float[]> TONEMAP_CURVE_RED = |
| 963 | new Key<float[]>("android.tonemap.curveRed", float[].class); |
| 964 | |
| 965 | /** |
| 966 | * @see #TONEMAP_MODE_CONTRAST_CURVE |
| 967 | * @see #TONEMAP_MODE_FAST |
| 968 | * @see #TONEMAP_MODE_HIGH_QUALITY |
| 969 | */ |
| 970 | public static final Key<Integer> TONEMAP_MODE = |
| 971 | new Key<Integer>("android.tonemap.mode", int.class); |
| 972 | |
| 973 | /** |
| 974 | * <p> |
| 975 | * This LED is nominally used to indicate to the user |
| 976 | * that the camera is powered on and may be streaming images back to the |
| 977 | * Application Processor. In certain rare circumstances, the OS may |
| 978 | * disable this when video is processed locally and not transmitted to |
| 979 | * any untrusted applications. |
| 980 | * </p><p> |
| 981 | * In particular, the LED *must* always be on when the data could be |
| 982 | * transmitted off the device. The LED *should* always be on whenever |
| 983 | * data is stored locally on the device. |
| 984 | * </p><p> |
| 985 | * The LED *may* be off if a trusted application is using the data that |
| 986 | * doesn't violate the above rules. |
| 987 | * </p> |
| 988 | * |
| 989 | * @hide |
| 990 | */ |
| 991 | public static final Key<Boolean> LED_TRANSMIT = |
| 992 | new Key<Boolean>("android.led.transmit", boolean.class); |
| 993 | |
| 994 | /** |
| 995 | * <p> |
| 996 | * Whether black-level compensation is locked |
| 997 | * to its current values, or is free to vary |
| 998 | * </p> |
| 999 | * <p> |
| 1000 | * When set to ON, the values used for black-level |
| 1001 | * compensation must not change until the lock is set to |
| 1002 | * OFF |
| 1003 | * </p><p> |
| 1004 | * Since changes to certain capture parameters (such as |
| 1005 | * exposure time) may require resetting of black level |
| 1006 | * compensation, the HAL must report whether setting the |
| 1007 | * black level lock was successful in the output result |
| 1008 | * metadata. |
Igor Murashkin | d5ff06a | 2013-08-20 15:15:06 -0700 | [diff] [blame] | 1009 | * </p><p> |
| 1010 | * The black level locking must happen at the sensor, and not at the ISP. |
| 1011 | * If for some reason black level locking is no longer legal (for example, |
| 1012 | * the analog gain has changed, which forces black levels to be |
| 1013 | * recalculated), then the HAL is free to override this request (and it |
| 1014 | * must report 'OFF' when this does happen) until the next time locking |
| 1015 | * is legal again. |
Eino-Ville Talvala | 5a32b20c | 2013-08-08 12:38:36 -0700 | [diff] [blame] | 1016 | * </p> |
| 1017 | */ |
| 1018 | public static final Key<Boolean> BLACK_LEVEL_LOCK = |
| 1019 | new Key<Boolean>("android.blackLevel.lock", boolean.class); |
| 1020 | |
| 1021 | /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~ |
| 1022 | * End generated code |
| 1023 | *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/ |
Igor Murashkin | b779ac1 | 2013-09-05 12:40:19 -0700 | [diff] [blame] | 1024 | |
| 1025 | /** |
| 1026 | * <p> |
| 1027 | * List of the {@link Face Faces} detected through camera face detection |
| 1028 | * in this result. |
| 1029 | * </p> |
| 1030 | * <p> |
| 1031 | * Only available if {@link #STATISTICS_FACE_DETECT_MODE} {@code !=} |
| 1032 | * {@link CameraMetadata#STATISTICS_FACE_DETECT_MODE_OFF OFF}. |
| 1033 | * </p> |
| 1034 | * |
| 1035 | * @see Face |
| 1036 | */ |
| 1037 | public static final Key<Face[]> STATISTICS_FACES = |
| 1038 | new Key<Face[]>("android.statistics.faces", Face[].class); |
Eino-Ville Talvala | b267554 | 2012-12-12 13:29:45 -0800 | [diff] [blame] | 1039 | } |