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