Camera3Device.h revision 90e59c98c343e941b1a75307ffa4b4b5f1eb50d6
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 17#ifndef ANDROID_SERVERS_CAMERA3DEVICE_H 18#define ANDROID_SERVERS_CAMERA3DEVICE_H 19 20#include <utils/Condition.h> 21#include <utils/Errors.h> 22#include <utils/List.h> 23#include <utils/Mutex.h> 24#include <utils/Thread.h> 25#include <utils/KeyedVector.h> 26#include <hardware/camera3.h> 27 28#include "common/CameraDeviceBase.h" 29#include "device3/StatusTracker.h" 30 31/** 32 * Function pointer types with C calling convention to 33 * use for HAL callback functions. 34 */ 35extern "C" { 36 typedef void (callbacks_process_capture_result_t)( 37 const struct camera3_callback_ops *, 38 const camera3_capture_result_t *); 39 40 typedef void (callbacks_notify_t)( 41 const struct camera3_callback_ops *, 42 const camera3_notify_msg_t *); 43} 44 45namespace android { 46 47namespace camera3 { 48 49class Camera3Stream; 50class Camera3ZslStream; 51class Camera3OutputStreamInterface; 52class Camera3StreamInterface; 53 54} 55 56/** 57 * CameraDevice for HAL devices with version CAMERA_DEVICE_API_VERSION_3_0 58 */ 59class Camera3Device : 60 public CameraDeviceBase, 61 private camera3_callback_ops { 62 public: 63 Camera3Device(int id); 64 65 virtual ~Camera3Device(); 66 67 /** 68 * CameraDeviceBase interface 69 */ 70 71 virtual int getId() const; 72 73 // Transitions to idle state on success. 74 virtual status_t initialize(camera_module_t *module); 75 virtual status_t disconnect(); 76 virtual status_t dump(int fd, const Vector<String16> &args); 77 virtual const CameraMetadata& info() const; 78 79 // Capture and setStreamingRequest will configure streams if currently in 80 // idle state 81 virtual status_t capture(CameraMetadata &request); 82 virtual status_t captureList(const List<const CameraMetadata> &requests); 83 virtual status_t setStreamingRequest(const CameraMetadata &request); 84 virtual status_t setStreamingRequestList(const List<const CameraMetadata> &requests); 85 virtual status_t clearStreamingRequest(); 86 87 virtual status_t waitUntilRequestReceived(int32_t requestId, nsecs_t timeout); 88 89 // Actual stream creation/deletion is delayed until first request is submitted 90 // If adding streams while actively capturing, will pause device before adding 91 // stream, reconfiguring device, and unpausing. 92 virtual status_t createStream(sp<ANativeWindow> consumer, 93 uint32_t width, uint32_t height, int format, size_t size, 94 int *id); 95 virtual status_t createInputStream( 96 uint32_t width, uint32_t height, int format, 97 int *id); 98 virtual status_t createZslStream( 99 uint32_t width, uint32_t height, 100 int depth, 101 /*out*/ 102 int *id, 103 sp<camera3::Camera3ZslStream>* zslStream); 104 virtual status_t createReprocessStreamFromStream(int outputId, int *id); 105 106 virtual status_t getStreamInfo(int id, 107 uint32_t *width, uint32_t *height, uint32_t *format); 108 virtual status_t setStreamTransform(int id, int transform); 109 110 virtual status_t deleteStream(int id); 111 virtual status_t deleteReprocessStream(int id); 112 113 virtual status_t createDefaultRequest(int templateId, CameraMetadata *request); 114 115 // Transitions to the idle state on success 116 virtual status_t waitUntilDrained(); 117 118 virtual status_t setNotifyCallback(NotificationListener *listener); 119 virtual bool willNotify3A(); 120 virtual status_t waitForNextFrame(nsecs_t timeout); 121 virtual status_t getNextFrame(CameraMetadata *frame); 122 123 virtual status_t triggerAutofocus(uint32_t id); 124 virtual status_t triggerCancelAutofocus(uint32_t id); 125 virtual status_t triggerPrecaptureMetering(uint32_t id); 126 127 virtual status_t pushReprocessBuffer(int reprocessStreamId, 128 buffer_handle_t *buffer, wp<BufferReleasedListener> listener); 129 130 virtual status_t flush(); 131 132 // Methods called by subclasses 133 void notifyStatus(bool idle); // updates from StatusTracker 134 135 private: 136 static const size_t kDumpLockAttempts = 10; 137 static const size_t kDumpSleepDuration = 100000; // 0.10 sec 138 static const size_t kInFlightWarnLimit = 20; 139 static const nsecs_t kShutdownTimeout = 5000000000; // 5 sec 140 static const nsecs_t kActiveTimeout = 500000000; // 500 ms 141 struct RequestTrigger; 142 143 // A lock to enforce serialization on the input/configure side 144 // of the public interface. 145 // Only locked by public methods inherited from CameraDeviceBase. 146 // Not locked by methods guarded by mOutputLock, since they may act 147 // concurrently to the input/configure side of the interface. 148 // Must be locked before mLock if both will be locked by a method 149 Mutex mInterfaceLock; 150 151 // The main lock on internal state 152 Mutex mLock; 153 154 // Camera device ID 155 const int mId; 156 157 /**** Scope for mLock ****/ 158 159 camera3_device_t *mHal3Device; 160 161 CameraMetadata mDeviceInfo; 162 vendor_tag_query_ops_t mVendorTagOps; 163 164 enum Status { 165 STATUS_ERROR, 166 STATUS_UNINITIALIZED, 167 STATUS_UNCONFIGURED, 168 STATUS_CONFIGURED, 169 STATUS_ACTIVE 170 } mStatus; 171 Vector<Status> mRecentStatusUpdates; 172 Condition mStatusChanged; 173 174 // Tracking cause of fatal errors when in STATUS_ERROR 175 String8 mErrorCause; 176 177 // Mapping of stream IDs to stream instances 178 typedef KeyedVector<int, sp<camera3::Camera3OutputStreamInterface> > 179 StreamSet; 180 181 StreamSet mOutputStreams; 182 sp<camera3::Camera3Stream> mInputStream; 183 int mNextStreamId; 184 bool mNeedConfig; 185 186 // Whether to send state updates upstream 187 // Pause when doing transparent reconfiguration 188 bool mPauseStateNotify; 189 190 // Need to hold on to stream references until configure completes. 191 Vector<sp<camera3::Camera3StreamInterface> > mDeletedStreams; 192 193 // Whether quirk ANDROID_QUIRKS_USE_PARTIAL_RESULT is enabled 194 bool mUsePartialResultQuirk; 195 196 /**** End scope for mLock ****/ 197 198 class CaptureRequest : public LightRefBase<CaptureRequest> { 199 public: 200 CameraMetadata mSettings; 201 sp<camera3::Camera3Stream> mInputStream; 202 Vector<sp<camera3::Camera3OutputStreamInterface> > 203 mOutputStreams; 204 }; 205 typedef List<sp<CaptureRequest> > RequestList; 206 207 status_t checkStatusOkToCaptureLocked(); 208 209 status_t convertMetadataListToRequestListLocked( 210 const List<const CameraMetadata> &metadataList, 211 /*out*/RequestList *requestList); 212 213 status_t submitRequestsHelper(const List<const CameraMetadata> &requests, bool repeating); 214 215 /** 216 * Get the last request submitted to the hal by the request thread. 217 * 218 * Takes mLock. 219 */ 220 virtual CameraMetadata getLatestRequestLocked(); 221 222 /** 223 * Pause processing and flush everything, but don't tell the clients. 224 * This is for reconfiguring outputs transparently when according to the 225 * CameraDeviceBase interface we shouldn't need to. 226 * Must be called with mLock and mInterfaceLock both held. 227 */ 228 status_t internalPauseAndWaitLocked(); 229 230 /** 231 * Resume work after internalPauseAndWaitLocked() 232 * Must be called with mLock and mInterfaceLock both held. 233 */ 234 status_t internalResumeLocked(); 235 236 /** 237 * Wait until status tracker tells us we've transitioned to the target state 238 * set, which is either ACTIVE when active==true or IDLE (which is any 239 * non-ACTIVE state) when active==false. 240 * 241 * Needs to be called with mLock and mInterfaceLock held. This means there 242 * can ever only be one waiter at most. 243 * 244 * During the wait mLock is released. 245 * 246 */ 247 status_t waitUntilStateThenRelock(bool active, nsecs_t timeout); 248 249 /** 250 * Do common work for setting up a streaming or single capture request. 251 * On success, will transition to ACTIVE if in IDLE. 252 */ 253 sp<CaptureRequest> setUpRequestLocked(const CameraMetadata &request); 254 255 /** 256 * Build a CaptureRequest request from the CameraDeviceBase request 257 * settings. 258 */ 259 sp<CaptureRequest> createCaptureRequest(const CameraMetadata &request); 260 261 /** 262 * Take the currently-defined set of streams and configure the HAL to use 263 * them. This is a long-running operation (may be several hundered ms). 264 */ 265 status_t configureStreamsLocked(); 266 267 /** 268 * Set device into an error state due to some fatal failure, and set an 269 * error message to indicate why. Only the first call's message will be 270 * used. The message is also sent to the log. 271 */ 272 void setErrorState(const char *fmt, ...); 273 void setErrorStateV(const char *fmt, va_list args); 274 void setErrorStateLocked(const char *fmt, ...); 275 void setErrorStateLockedV(const char *fmt, va_list args); 276 277 /** 278 * Debugging trylock/spin method 279 * Try to acquire a lock a few times with sleeps between before giving up. 280 */ 281 bool tryLockSpinRightRound(Mutex& lock); 282 283 struct RequestTrigger { 284 // Metadata tag number, e.g. android.control.aePrecaptureTrigger 285 uint32_t metadataTag; 286 // Metadata value, e.g. 'START' or the trigger ID 287 int32_t entryValue; 288 289 // The last part of the fully qualified path, e.g. afTrigger 290 const char *getTagName() const { 291 return get_camera_metadata_tag_name(metadataTag) ?: "NULL"; 292 } 293 294 // e.g. TYPE_BYTE, TYPE_INT32, etc. 295 int getTagType() const { 296 return get_camera_metadata_tag_type(metadataTag); 297 } 298 }; 299 300 /** 301 * Thread for managing capture request submission to HAL device. 302 */ 303 class RequestThread : public Thread { 304 305 public: 306 307 RequestThread(wp<Camera3Device> parent, 308 sp<camera3::StatusTracker> statusTracker, 309 camera3_device_t *hal3Device); 310 311 /** 312 * Call after stream (re)-configuration is completed. 313 */ 314 void configurationComplete(); 315 316 /** 317 * Set or clear the list of repeating requests. Does not block 318 * on either. Use waitUntilPaused to wait until request queue 319 * has emptied out. 320 */ 321 status_t setRepeatingRequests(const RequestList& requests); 322 status_t clearRepeatingRequests(); 323 324 status_t queueRequest(sp<CaptureRequest> request); 325 326 status_t queueRequestList(List<sp<CaptureRequest> > &requests); 327 328 /** 329 * Remove all queued and repeating requests, and pending triggers 330 */ 331 status_t clear(); 332 333 /** 334 * Queue a trigger to be dispatched with the next outgoing 335 * process_capture_request. The settings for that request only 336 * will be temporarily rewritten to add the trigger tag/value. 337 * Subsequent requests will not be rewritten (for this tag). 338 */ 339 status_t queueTrigger(RequestTrigger trigger[], size_t count); 340 341 /** 342 * Pause/unpause the capture thread. Doesn't block, so use 343 * waitUntilPaused to wait until the thread is paused. 344 */ 345 void setPaused(bool paused); 346 347 /** 348 * Wait until thread processes the capture request with settings' 349 * android.request.id == requestId. 350 * 351 * Returns TIMED_OUT in case the thread does not process the request 352 * within the timeout. 353 */ 354 status_t waitUntilRequestProcessed(int32_t requestId, nsecs_t timeout); 355 356 /** 357 * Shut down the thread. Shutdown is asynchronous, so thread may 358 * still be running once this method returns. 359 */ 360 virtual void requestExit(); 361 362 /** 363 * Get the latest request that was sent to the HAL 364 * with process_capture_request. 365 */ 366 CameraMetadata getLatestRequest() const; 367 368 protected: 369 370 virtual bool threadLoop(); 371 372 private: 373 static int getId(const wp<Camera3Device> &device); 374 375 status_t queueTriggerLocked(RequestTrigger trigger); 376 // Mix-in queued triggers into this request 377 int32_t insertTriggers(const sp<CaptureRequest> &request); 378 // Purge the queued triggers from this request, 379 // restoring the old field values for those tags. 380 status_t removeTriggers(const sp<CaptureRequest> &request); 381 382 // HAL workaround: Make sure a trigger ID always exists if 383 // a trigger does 384 status_t addDummyTriggerIds(const sp<CaptureRequest> &request); 385 386 static const nsecs_t kRequestTimeout = 50e6; // 50 ms 387 388 // Waits for a request, or returns NULL if times out. 389 sp<CaptureRequest> waitForNextRequest(); 390 391 // Return buffers, etc, for a request that couldn't be fully 392 // constructed. The buffers will be returned in the ERROR state 393 // to mark them as not having valid data. 394 // All arguments will be modified. 395 void cleanUpFailedRequest(camera3_capture_request_t &request, 396 sp<CaptureRequest> &nextRequest, 397 Vector<camera3_stream_buffer_t> &outputBuffers); 398 399 // Pause handling 400 bool waitIfPaused(); 401 void unpauseForNewRequests(); 402 403 // Relay error to parent device object setErrorState 404 void setErrorState(const char *fmt, ...); 405 406 wp<Camera3Device> mParent; 407 wp<camera3::StatusTracker> mStatusTracker; 408 camera3_device_t *mHal3Device; 409 410 const int mId; // The camera ID 411 int mStatusId; // The RequestThread's component ID for 412 // status tracking 413 414 Mutex mRequestLock; 415 Condition mRequestSignal; 416 RequestList mRequestQueue; 417 RequestList mRepeatingRequests; 418 419 bool mReconfigured; 420 421 // Used by waitIfPaused, waitForNextRequest, and waitUntilPaused 422 Mutex mPauseLock; 423 bool mDoPause; 424 Condition mDoPauseSignal; 425 bool mPaused; 426 Condition mPausedSignal; 427 428 sp<CaptureRequest> mPrevRequest; 429 int32_t mPrevTriggers; 430 431 uint32_t mFrameNumber; 432 433 mutable Mutex mLatestRequestMutex; 434 Condition mLatestRequestSignal; 435 // android.request.id for latest process_capture_request 436 int32_t mLatestRequestId; 437 CameraMetadata mLatestRequest; 438 439 typedef KeyedVector<uint32_t/*tag*/, RequestTrigger> TriggerMap; 440 Mutex mTriggerMutex; 441 TriggerMap mTriggerMap; 442 TriggerMap mTriggerRemovedMap; 443 TriggerMap mTriggerReplacedMap; 444 }; 445 sp<RequestThread> mRequestThread; 446 447 /** 448 * In-flight queue for tracking completion of capture requests. 449 */ 450 451 struct InFlightRequest { 452 // android.request.id for the request 453 int requestId; 454 // Set by notify() SHUTTER call. 455 nsecs_t captureTimestamp; 456 int requestStatus; 457 // Set by process_capture_result call with valid metadata 458 bool haveResultMetadata; 459 // Decremented by calls to process_capture_result with valid output 460 // buffers 461 int numBuffersLeft; 462 463 // Fields used by the partial result quirk only 464 struct PartialResultQuirkInFlight { 465 // Set by process_capture_result once 3A has been sent to clients 466 bool haveSent3A; 467 // Result metadata collected so far, when partial results are in use 468 CameraMetadata collectedResult; 469 470 PartialResultQuirkInFlight(): 471 haveSent3A(false) { 472 } 473 } partialResultQuirk; 474 475 // Default constructor needed by KeyedVector 476 InFlightRequest() : 477 requestId(0), 478 captureTimestamp(0), 479 requestStatus(OK), 480 haveResultMetadata(false), 481 numBuffersLeft(0) { 482 } 483 484 InFlightRequest(int id, int numBuffers) : 485 requestId(id), 486 captureTimestamp(0), 487 requestStatus(OK), 488 haveResultMetadata(false), 489 numBuffersLeft(numBuffers) { 490 } 491 }; 492 // Map from frame number to the in-flight request state 493 typedef KeyedVector<uint32_t, InFlightRequest> InFlightMap; 494 495 Mutex mInFlightLock; // Protects mInFlightMap 496 InFlightMap mInFlightMap; 497 498 status_t registerInFlight(int32_t frameNumber, int32_t requestId, 499 int32_t numBuffers); 500 501 /** 502 * For the partial result quirk, check if all 3A state fields are available 503 * and if so, queue up 3A-only result to the client. Returns true if 3A 504 * is sent. 505 */ 506 bool processPartial3AQuirk(int32_t frameNumber, int32_t requestId, 507 const CameraMetadata& partial); 508 509 // Helpers for reading and writing 3A metadata into to/from partial results 510 template<typename T> 511 bool get3AResult(const CameraMetadata& result, int32_t tag, 512 T* value, int32_t frameNumber); 513 514 template<typename T> 515 bool insert3AResult(CameraMetadata &result, int32_t tag, const T* value, 516 int32_t frameNumber); 517 /** 518 * Tracking for idle detection 519 */ 520 sp<camera3::StatusTracker> mStatusTracker; 521 522 /** 523 * Output result queue and current HAL device 3A state 524 */ 525 526 // Lock for output side of device 527 Mutex mOutputLock; 528 529 /**** Scope for mOutputLock ****/ 530 531 uint32_t mNextResultFrameNumber; 532 uint32_t mNextShutterFrameNumber; 533 List<CameraMetadata> mResultQueue; 534 Condition mResultSignal; 535 NotificationListener *mListener; 536 537 /**** End scope for mOutputLock ****/ 538 539 /** 540 * Callback functions from HAL device 541 */ 542 void processCaptureResult(const camera3_capture_result *result); 543 544 void notify(const camera3_notify_msg *msg); 545 546 /** 547 * Static callback forwarding methods from HAL to instance 548 */ 549 static callbacks_process_capture_result_t sProcessCaptureResult; 550 551 static callbacks_notify_t sNotify; 552 553}; // class Camera3Device 554 555}; // namespace android 556 557#endif 558