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