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