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 17 #ifndef ANDROID_SERVERS_CAMERA_CAMERA2PARAMETERS_H 18 #define ANDROID_SERVERS_CAMERA_CAMERA2PARAMETERS_H 19 20 #include <system/graphics.h> 21 22 #include <utils/Compat.h> 23 #include <utils/Errors.h> 24 #include <utils/KeyedVector.h> 25 #include <utils/Mutex.h> 26 #include <utils/String8.h> 27 #include <utils/Vector.h> 28 29 #include <camera/CameraParameters.h> 30 #include <camera/CameraParameters2.h> 31 #include <camera/CameraMetadata.h> 32 33 namespace android { 34 namespace camera2 { 35 36 /** 37 * Current camera state; this is the full state of the Camera under the old 38 * camera API (contents of the CameraParameters2 object in a more-efficient 39 * format, plus other state). The enum values are mostly based off the 40 * corresponding camera2 enums, not the camera1 strings. A few are defined here 41 * if they don't cleanly map to camera2 values. 42 */ 43 struct Parameters { 44 /** 45 * Parameters and other state 46 */ 47 int cameraId; 48 int cameraFacing; 49 50 int previewWidth, previewHeight; 51 int32_t previewFpsRange[2]; 52 int previewFormat; 53 54 int previewTransform; // set by CAMERA_CMD_SET_DISPLAY_ORIENTATION 55 56 int pictureWidth, pictureHeight; 57 // Store the picture size before they are overriden by video snapshot 58 int pictureWidthLastSet, pictureHeightLastSet; 59 bool pictureSizeOverriden; 60 61 int32_t jpegThumbSize[2]; 62 uint8_t jpegQuality, jpegThumbQuality; 63 int32_t jpegRotation; 64 65 bool gpsEnabled; 66 double gpsCoordinates[3]; 67 int64_t gpsTimestamp; 68 String8 gpsProcessingMethod; 69 70 uint8_t wbMode; 71 uint8_t effectMode; 72 uint8_t antibandingMode; 73 uint8_t sceneMode; 74 75 enum flashMode_t { 76 FLASH_MODE_OFF = 0, 77 FLASH_MODE_AUTO, 78 FLASH_MODE_ON, 79 FLASH_MODE_TORCH, 80 FLASH_MODE_RED_EYE = ANDROID_CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE, 81 FLASH_MODE_INVALID = -1 82 } flashMode; 83 84 enum focusMode_t { 85 FOCUS_MODE_AUTO = ANDROID_CONTROL_AF_MODE_AUTO, 86 FOCUS_MODE_MACRO = ANDROID_CONTROL_AF_MODE_MACRO, 87 FOCUS_MODE_CONTINUOUS_VIDEO = ANDROID_CONTROL_AF_MODE_CONTINUOUS_VIDEO, 88 FOCUS_MODE_CONTINUOUS_PICTURE = ANDROID_CONTROL_AF_MODE_CONTINUOUS_PICTURE, 89 FOCUS_MODE_EDOF = ANDROID_CONTROL_AF_MODE_EDOF, 90 FOCUS_MODE_INFINITY, 91 FOCUS_MODE_FIXED, 92 FOCUS_MODE_INVALID = -1 93 } focusMode; 94 95 uint8_t focusState; // Latest focus state from HAL 96 97 // For use with triggerAfWithAuto quirk 98 focusMode_t shadowFocusMode; 99 100 struct Area { 101 int left, top, right, bottom; 102 int weight; AreaParameters::Area103 Area() {} AreaParameters::Area104 Area(int left, int top, int right, int bottom, int weight): 105 left(left), top(top), right(right), bottom(bottom), 106 weight(weight) {} isEmptyParameters::Area107 bool isEmpty() const { 108 return (left == 0) && (top == 0) && (right == 0) && (bottom == 0); 109 } 110 }; 111 Vector<Area> focusingAreas; 112 113 struct Size { 114 int32_t width; 115 int32_t height; 116 }; 117 118 int32_t exposureCompensation; 119 bool autoExposureLock; 120 bool autoWhiteBalanceLock; 121 122 // 3A region types, for use with ANDROID_CONTROL_MAX_REGIONS 123 enum region_t { 124 REGION_AE = 0, 125 REGION_AWB, 126 REGION_AF, 127 NUM_REGION // Number of region types 128 } region; 129 130 Vector<Area> meteringAreas; 131 132 int zoom; 133 134 int videoWidth, videoHeight, videoFormat; 135 android_dataspace videoDataSpace; 136 137 bool recordingHint; 138 bool videoStabilization; 139 140 CameraParameters2 params; 141 String8 paramsFlattened; 142 143 // These parameters are also part of the camera API-visible state, but not 144 // directly listed in Camera.Parameters 145 // One of ICamera::VIDEO_BUFFER_MODE_* 146 int32_t videoBufferMode; 147 bool playShutterSound; 148 bool enableFaceDetect; 149 150 bool enableFocusMoveMessages; 151 int afTriggerCounter; 152 int afStateCounter; 153 int currentAfTriggerId; 154 bool afInMotion; 155 156 int precaptureTriggerCounter; 157 158 int takePictureCounter; 159 160 uint32_t previewCallbackFlags; 161 bool previewCallbackOneShot; 162 bool previewCallbackSurface; 163 164 bool allowZslMode; 165 // Whether the jpeg stream is slower than 30FPS and can slow down preview. 166 // When slowJpegMode is true, allowZslMode must be false to avoid slowing down preview. 167 bool slowJpegMode; 168 169 // Overall camera state 170 enum State { 171 DISCONNECTED, 172 STOPPED, 173 WAITING_FOR_PREVIEW_WINDOW, 174 PREVIEW, 175 RECORD, 176 STILL_CAPTURE, 177 VIDEO_SNAPSHOT 178 } state; 179 180 // Number of zoom steps to simulate 181 static const unsigned int NUM_ZOOM_STEPS = 100; 182 // Max preview size allowed 183 // This is set to a 1:1 value to allow for any aspect ratio that has 184 // a max long side of 1920 pixels 185 static const unsigned int MAX_PREVIEW_WIDTH = 1920; 186 static const unsigned int MAX_PREVIEW_HEIGHT = 1920; 187 // Initial max preview/recording size bound 188 static const int MAX_INITIAL_PREVIEW_WIDTH = 1920; 189 static const int MAX_INITIAL_PREVIEW_HEIGHT = 1080; 190 // Aspect ratio tolerance 191 static const CONSTEXPR float ASPECT_RATIO_TOLERANCE = 0.001; 192 // Threshold for slow jpeg mode 193 static const int64_t kSlowJpegModeThreshold = 33400000LL; // 33.4 ms 194 195 // Full static camera info, object owned by someone else, such as 196 // Camera2Device. 197 const CameraMetadata *info; 198 199 // Fast-access static device information; this is a subset of the 200 // information available through the staticInfo() method, used for 201 // frequently-accessed values or values that have to be calculated from the 202 // static information. 203 struct DeviceInfo { 204 int32_t arrayWidth; 205 int32_t arrayHeight; 206 int32_t bestStillCaptureFpsRange[2]; 207 uint8_t bestFaceDetectMode; 208 int32_t maxFaces; 209 struct OverrideModes { 210 flashMode_t flashMode; 211 uint8_t wbMode; 212 focusMode_t focusMode; OverrideModesParameters::DeviceInfo::OverrideModes213 OverrideModes(): 214 flashMode(FLASH_MODE_INVALID), 215 wbMode(ANDROID_CONTROL_AWB_MODE_OFF), 216 focusMode(FOCUS_MODE_INVALID) { 217 } 218 }; 219 DefaultKeyedVector<uint8_t, OverrideModes> sceneModeOverrides; 220 float minFocalLength; 221 bool useFlexibleYuv; 222 Size maxJpegSize; 223 } fastInfo; 224 225 // Quirks information; these are short-lived flags to enable workarounds for 226 // incomplete HAL implementations 227 struct Quirks { 228 bool triggerAfWithAuto; 229 bool useZslFormat; 230 bool meteringCropRegion; 231 bool partialResults; 232 } quirks; 233 234 /** 235 * Parameter manipulation and setup methods 236 */ 237 238 Parameters(int cameraId, int cameraFacing); 239 ~Parameters(); 240 241 // Sets up default parameters 242 status_t initialize(const CameraMetadata *info, int deviceVersion); 243 244 // Build fast-access device static info from static info 245 status_t buildFastInfo(); 246 // Query for quirks from static info 247 status_t buildQuirks(); 248 249 // Get entry from camera static characteristics information. min/maxCount 250 // are used for error checking the number of values in the entry. 0 for 251 // max/minCount means to do no bounds check in that direction. In case of 252 // error, the entry data pointer is null and the count is 0. 253 camera_metadata_ro_entry_t staticInfo(uint32_t tag, 254 size_t minCount=0, size_t maxCount=0, bool required=true) const; 255 256 // Validate and update camera parameters based on new settings 257 status_t set(const String8 ¶mString); 258 259 // Retrieve the current settings 260 String8 get() const; 261 262 // Update passed-in request for common parameters 263 status_t updateRequest(CameraMetadata *request) const; 264 265 // Add/update JPEG entries in metadata 266 status_t updateRequestJpeg(CameraMetadata *request) const; 267 268 /* Helper functions to override jpeg size for video snapshot */ 269 // Override jpeg size by video size. Called during startRecording. 270 status_t overrideJpegSizeByVideoSize(); 271 // Recover overridden jpeg size. Called during stopRecording. 272 status_t recoverOverriddenJpegSize(); 273 // if video snapshot size is currently overridden 274 bool isJpegSizeOverridden(); 275 // whether zero shutter lag should be used for non-recording operation 276 bool useZeroShutterLag() const; 277 278 // Calculate the crop region rectangle, either tightly about the preview 279 // resolution, or a region just based on the active array; both take 280 // into account the current zoom level. 281 struct CropRegion { 282 float left; 283 float top; 284 float width; 285 float height; 286 }; 287 CropRegion calculateCropRegion(bool previewOnly) const; 288 289 // Calculate the field of view of the high-resolution JPEG capture 290 status_t calculatePictureFovs(float *horizFov, float *vertFov) const; 291 292 // Static methods for debugging and converting between camera1 and camera2 293 // parameters 294 295 static const char *getStateName(State state); 296 297 static int formatStringToEnum(const char *format); 298 static const char *formatEnumToString(int format); 299 300 static int wbModeStringToEnum(const char *wbMode); 301 static const char* wbModeEnumToString(uint8_t wbMode); 302 static int effectModeStringToEnum(const char *effectMode); 303 static int abModeStringToEnum(const char *abMode); 304 static int sceneModeStringToEnum(const char *sceneMode); 305 static flashMode_t flashModeStringToEnum(const char *flashMode); 306 static const char* flashModeEnumToString(flashMode_t flashMode); 307 static focusMode_t focusModeStringToEnum(const char *focusMode); 308 static const char* focusModeEnumToString(focusMode_t focusMode); 309 310 static status_t parseAreas(const char *areasCStr, 311 Vector<Area> *areas); 312 313 enum AreaKind 314 { 315 AREA_KIND_FOCUS, 316 AREA_KIND_METERING 317 }; 318 status_t validateAreas(const Vector<Area> &areas, 319 size_t maxRegions, 320 AreaKind areaKind) const; 321 static bool boolFromString(const char *boolStr); 322 323 // Map from camera orientation + facing to gralloc transform enum 324 static int degToTransform(int degrees, bool mirror); 325 326 // API specifies FPS ranges are done in fixed point integer, with LSB = 0.001. 327 // Note that this doesn't apply to the (deprecated) single FPS value. 328 static const int kFpsToApiScale = 1000; 329 330 // Transform from (-1000,-1000)-(1000,1000) normalized coords from camera 331 // API to HAL3 (0,0)-(activePixelArray.width/height) coordinates 332 int normalizedXToArray(int x) const; 333 int normalizedYToArray(int y) const; 334 335 // Transform from HAL3 (0,0)-(activePixelArray.width/height) coordinates to 336 // (-1000,-1000)-(1000,1000) normalized coordinates given a scaler crop 337 // region. 338 int arrayXToNormalizedWithCrop(int x, const CropRegion &scalerCrop) const; 339 int arrayYToNormalizedWithCrop(int y, const CropRegion &scalerCrop) const; 340 341 struct Range { 342 int min; 343 int max; 344 }; 345 346 int32_t fpsFromRange(int32_t min, int32_t max) const; 347 348 private: 349 350 // Convert from viewfinder crop-region relative array coordinates 351 // to HAL3 sensor array coordinates 352 int cropXToArray(int x) const; 353 int cropYToArray(int y) const; 354 355 // Convert from camera API (-1000,1000)-(1000,1000) normalized coords 356 // to viewfinder crop-region relative array coordinates 357 int normalizedXToCrop(int x) const; 358 int normalizedYToCrop(int y) const; 359 360 // Given a scaler crop region, calculate preview crop region based on 361 // preview aspect ratio. 362 CropRegion calculatePreviewCrop(const CropRegion &scalerCrop) const; 363 364 Vector<Size> availablePreviewSizes; 365 Vector<Size> availableVideoSizes; 366 // Get size list (that are no larger than limit) from static metadata. 367 status_t getFilteredSizes(Size limit, Vector<Size> *sizes); 368 // Get max size (from the size array) that matches the given aspect ratio. 369 Size getMaxSizeForRatio(float ratio, const int32_t* sizeArray, size_t count); 370 371 // Helper function for overriding jpeg size for video snapshot 372 // Check if overridden jpeg size needs to be updated after Parameters::set. 373 // The behavior of this function is tailored to the implementation of Parameters::set. 374 // Do not use this function for other purpose. 375 status_t updateOverriddenJpegSize(); 376 377 struct StreamConfiguration { 378 int32_t format; 379 int32_t width; 380 int32_t height; 381 int32_t isInput; 382 }; 383 384 // Helper function extract available stream configuration 385 // Only valid since device HAL version 3.2 386 // returns an empty Vector if device HAL version does support it 387 Vector<StreamConfiguration> getStreamConfigurations(); 388 389 // Helper function to get minimum frame duration for a jpeg size 390 // return -1 if input jpeg size cannot be found in supported size list 391 int64_t getJpegStreamMinFrameDurationNs(Parameters::Size size); 392 393 // Helper function to get non-duplicated available output formats 394 SortedVector<int32_t> getAvailableOutputFormats(); 395 // Helper function to get available output jpeg sizes 396 Vector<Size> getAvailableJpegSizes(); 397 // Helper function to get maximum size in input Size vector. 398 // The maximum size is defined by comparing width first, when width ties comparing height. 399 Size getMaxSize(const Vector<Size>& sizes); 400 401 int mDeviceVersion; 402 }; 403 404 // This class encapsulates the Parameters class so that it can only be accessed 405 // by constructing a Lock object, which locks the SharedParameter's mutex. 406 class SharedParameters { 407 public: SharedParameters(int cameraId,int cameraFacing)408 SharedParameters(int cameraId, int cameraFacing): 409 mParameters(cameraId, cameraFacing) { 410 } 411 412 template<typename S, typename P> 413 class BaseLock { 414 public: BaseLock(S & p)415 BaseLock(S &p): 416 mParameters(p.mParameters), 417 mSharedParameters(p) { 418 mSharedParameters.mLock.lock(); 419 } 420 ~BaseLock()421 ~BaseLock() { 422 mSharedParameters.mLock.unlock(); 423 } 424 P &mParameters; 425 private: 426 // Disallow copying, default construction 427 BaseLock(); 428 BaseLock(const BaseLock &); 429 BaseLock &operator=(const BaseLock &); 430 S &mSharedParameters; 431 }; 432 typedef BaseLock<SharedParameters, Parameters> Lock; 433 typedef BaseLock<const SharedParameters, const Parameters> ReadLock; 434 435 // Access static info, read-only and immutable, so no lock needed 436 camera_metadata_ro_entry_t staticInfo(uint32_t tag, 437 size_t minCount=0, size_t maxCount=0) const { 438 return mParameters.staticInfo(tag, minCount, maxCount); 439 } 440 441 // Only use for dumping or other debugging unsafeAccess()442 const Parameters &unsafeAccess() { 443 return mParameters; 444 } 445 private: 446 Parameters mParameters; 447 mutable Mutex mLock; 448 }; 449 450 451 }; // namespace camera2 452 }; // namespace android 453 454 #endif 455