blob: 5287058dfb99266b70185d4f58ac13e411604a8b [file] [log] [blame]
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -08001/*
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
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -080017#ifndef ANDROID_SERVERS_CAMERA3DEVICE_H
18#define ANDROID_SERVERS_CAMERA3DEVICE_H
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -080019
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>
Eino-Ville Talvala7b82efe2013-07-25 17:12:35 -070025#include <utils/KeyedVector.h>
26#include <hardware/camera3.h>
Jianing Weicb0652e2014-03-12 18:29:36 -070027#include <camera/CaptureResult.h>
Jianing Wei2d6bb3f2014-04-11 10:00:31 -070028#include <camera/camera2/ICameraDeviceUser.h>
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -080029
Eino-Ville Talvala7b82efe2013-07-25 17:12:35 -070030#include "common/CameraDeviceBase.h"
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -070031#include "device3/StatusTracker.h"
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -080032
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
Eino-Ville Talvala7b82efe2013-07-25 17:12:35 -070049namespace camera3 {
50
51class Camera3Stream;
52class Camera3ZslStream;
53class Camera3OutputStreamInterface;
54class Camera3StreamInterface;
55
56}
57
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -080058/**
Zhijun He95dd5ba2014-03-26 18:18:00 -070059 * CameraDevice for HAL devices with version CAMERA_DEVICE_API_VERSION_3_0 or higher.
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -080060 */
61class Camera3Device :
62 public CameraDeviceBase,
63 private camera3_callback_ops {
64 public:
65 Camera3Device(int id);
66
67 virtual ~Camera3Device();
68
69 /**
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -080070 * CameraDeviceBase interface
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -080071 */
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -080072
Igor Murashkin71381052013-03-04 14:53:08 -080073 virtual int getId() const;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -080074
75 // Transitions to idle state on success.
Yin-Chia Yehe074a932015-01-30 10:29:02 -080076 virtual status_t initialize(CameraModule *module);
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -080077 virtual status_t disconnect();
78 virtual status_t dump(int fd, const Vector<String16> &args);
79 virtual const CameraMetadata& info() const;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -080080
81 // Capture and setStreamingRequest will configure streams if currently in
82 // idle state
Jianing Weicb0652e2014-03-12 18:29:36 -070083 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);
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -080091
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -080092 virtual status_t waitUntilRequestReceived(int32_t requestId, nsecs_t timeout);
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -080093
94 // Actual stream creation/deletion is delayed until first request is submitted
95 // If adding streams while actively capturing, will pause device before adding
Zhijun He28c9b6f2014-08-08 12:00:47 -070096 // stream, reconfiguring device, and unpausing.
Eino-Ville Talvala727d1722015-06-09 13:44:19 -070097 virtual status_t createStream(sp<Surface> consumer,
Eino-Ville Talvala3d82c0d2015-02-23 15:19:19 -080098 uint32_t width, uint32_t height, int format,
Yin-Chia Yehb97babb2015-03-12 13:42:44 -070099 android_dataspace dataSpace, camera3_stream_rotation_t rotation, int *id);
Igor Murashkin5a269fa2013-04-15 14:59:22 -0700100 virtual status_t createInputStream(
101 uint32_t width, uint32_t height, int format,
102 int *id);
Igor Murashkin2fba5842013-04-22 14:03:54 -0700103 virtual status_t createZslStream(
104 uint32_t width, uint32_t height,
105 int depth,
106 /*out*/
107 int *id,
108 sp<camera3::Camera3ZslStream>* zslStream);
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800109 virtual status_t createReprocessStreamFromStream(int outputId, int *id);
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800110
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800111 virtual status_t getStreamInfo(int id,
Eino-Ville Talvalad46a6b92015-05-14 17:26:24 -0700112 uint32_t *width, uint32_t *height,
113 uint32_t *format, android_dataspace *dataSpace);
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800114 virtual status_t setStreamTransform(int id, int transform);
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800115
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800116 virtual status_t deleteStream(int id);
117 virtual status_t deleteReprocessStream(int id);
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800118
Zhijun He1fa89992015-06-01 15:44:31 -0700119 virtual status_t configureStreams(bool isConstraiedHighSpeed = false);
Chien-Yu Chen618ff8a2015-03-13 11:27:17 -0700120 virtual status_t getInputBufferProducer(
121 sp<IGraphicBufferProducer> *producer);
Igor Murashkine2d167e2014-08-19 16:19:59 -0700122
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800123 virtual status_t createDefaultRequest(int templateId, CameraMetadata *request);
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800124
125 // Transitions to the idle state on success
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800126 virtual status_t waitUntilDrained();
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800127
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800128 virtual status_t setNotifyCallback(NotificationListener *listener);
Eino-Ville Talvala46910bd2013-07-18 19:15:17 -0700129 virtual bool willNotify3A();
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800130 virtual status_t waitForNextFrame(nsecs_t timeout);
Jianing Weicb0652e2014-03-12 18:29:36 -0700131 virtual status_t getNextResult(CaptureResult *frame);
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800132
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800133 virtual status_t triggerAutofocus(uint32_t id);
134 virtual status_t triggerCancelAutofocus(uint32_t id);
135 virtual status_t triggerPrecaptureMetering(uint32_t id);
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800136
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800137 virtual status_t pushReprocessBuffer(int reprocessStreamId,
138 buffer_handle_t *buffer, wp<BufferReleasedListener> listener);
139
Jianing Weicb0652e2014-03-12 18:29:36 -0700140 virtual status_t flush(int64_t *lastFrameNumber = NULL);
Eino-Ville Talvalaabaa51d2013-08-14 11:37:00 -0700141
Eino-Ville Talvala4d44cad2015-04-11 13:15:45 -0700142 virtual status_t prepare(int streamId);
143
Eino-Ville Talvalab25e3c82015-07-15 16:04:27 -0700144 virtual status_t tearDown(int streamId);
145
Zhijun He204e3292014-07-14 17:09:23 -0700146 virtual uint32_t getDeviceVersion();
147
Zhijun He28c9b6f2014-08-08 12:00:47 -0700148 virtual ssize_t getJpegBufferSize(uint32_t width, uint32_t height) const;
Eino-Ville Talvala95a1d0f2015-08-11 15:08:53 -0700149 ssize_t getPointCloudBufferSize() const;
Zhijun He28c9b6f2014-08-08 12:00:47 -0700150
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700151 // Methods called by subclasses
152 void notifyStatus(bool idle); // updates from StatusTracker
153
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800154 private:
Igor Murashkin1e479c02013-09-06 16:55:14 -0700155 static const size_t kDumpLockAttempts = 10;
156 static const size_t kDumpSleepDuration = 100000; // 0.10 sec
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700157 static const nsecs_t kShutdownTimeout = 5000000000; // 5 sec
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700158 static const nsecs_t kActiveTimeout = 500000000; // 500 ms
Chien-Yu Chenc96ac8d2015-08-12 16:46:24 -0700159 static const size_t kInFlightWarnLimit = 20;
160 static const size_t kInFlightWarnLimitHighSpeed = 256; // batch size 32 * pipe depth 8
161
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700162 struct RequestTrigger;
Zhijun Hef7da0962014-04-24 13:27:56 -0700163 // minimal jpeg buffer size: 256KB + blob header
164 static const ssize_t kMinJpegBufferSize = 256 * 1024 + sizeof(camera3_jpeg_blob);
Eino-Ville Talvala16a2ada2014-08-27 14:41:33 -0700165 // Constant to use for stream ID when one doesn't exist
166 static const int NO_STREAM = -1;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800167
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700168 // A lock to enforce serialization on the input/configure side
169 // of the public interface.
170 // Only locked by public methods inherited from CameraDeviceBase.
171 // Not locked by methods guarded by mOutputLock, since they may act
172 // concurrently to the input/configure side of the interface.
173 // Must be locked before mLock if both will be locked by a method
174 Mutex mInterfaceLock;
175
176 // The main lock on internal state
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800177 Mutex mLock;
178
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700179 // Camera device ID
180 const int mId;
181
Zhijun He1fa89992015-06-01 15:44:31 -0700182 // Flag indicating is the current active stream configuration is constrained high speed.
183 bool mIsConstrainedHighSpeedConfiguration;
184
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800185 /**** Scope for mLock ****/
186
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800187 camera3_device_t *mHal3Device;
188
189 CameraMetadata mDeviceInfo;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800190
Zhijun Hea1530f12014-09-14 12:44:20 -0700191 CameraMetadata mRequestTemplateCache[CAMERA3_TEMPLATE_COUNT];
192
Zhijun He204e3292014-07-14 17:09:23 -0700193 uint32_t mDeviceVersion;
Yin-Chia Yehcd8fce82014-06-18 10:51:34 -0700194
Chien-Yu Chen618ff8a2015-03-13 11:27:17 -0700195 struct Size {
196 uint32_t width;
197 uint32_t height;
198 Size(uint32_t w = 0, uint32_t h = 0) : width(w), height(h){}
199 };
200 // Map from format to size.
201 Vector<Size> mSupportedOpaqueInputSizes;
202
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700203 enum Status {
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800204 STATUS_ERROR,
205 STATUS_UNINITIALIZED,
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700206 STATUS_UNCONFIGURED,
207 STATUS_CONFIGURED,
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800208 STATUS_ACTIVE
209 } mStatus;
Ruben Brunk183f0562015-08-12 12:55:02 -0700210
211 // Only clear mRecentStatusUpdates, mStatusWaiters from waitUntilStateThenRelock
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700212 Vector<Status> mRecentStatusUpdates;
Ruben Brunk183f0562015-08-12 12:55:02 -0700213 int mStatusWaiters;
214
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700215 Condition mStatusChanged;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800216
Eino-Ville Talvalab2058d12013-04-09 13:49:56 -0700217 // Tracking cause of fatal errors when in STATUS_ERROR
218 String8 mErrorCause;
219
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800220 // Mapping of stream IDs to stream instances
Igor Murashkin2fba5842013-04-22 14:03:54 -0700221 typedef KeyedVector<int, sp<camera3::Camera3OutputStreamInterface> >
222 StreamSet;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800223
224 StreamSet mOutputStreams;
225 sp<camera3::Camera3Stream> mInputStream;
226 int mNextStreamId;
Eino-Ville Talvalaea26c772013-06-11 16:04:06 -0700227 bool mNeedConfig;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800228
Eino-Ville Talvala16a2ada2014-08-27 14:41:33 -0700229 int mDummyStreamId;
230
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700231 // Whether to send state updates upstream
232 // Pause when doing transparent reconfiguration
233 bool mPauseStateNotify;
234
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800235 // Need to hold on to stream references until configure completes.
Igor Murashkin2fba5842013-04-22 14:03:54 -0700236 Vector<sp<camera3::Camera3StreamInterface> > mDeletedStreams;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800237
Zhijun He204e3292014-07-14 17:09:23 -0700238 // Whether the HAL will send partial result
239 bool mUsePartialResult;
240
241 // Number of partial results that will be delivered by the HAL.
242 uint32_t mNumPartialResults;
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700243
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800244 /**** End scope for mLock ****/
245
Chien-Yu Chend196d612015-06-22 19:49:01 -0700246 typedef struct AeTriggerCancelOverride {
247 bool applyAeLock;
248 uint8_t aeLock;
249 bool applyAePrecaptureTrigger;
250 uint8_t aePrecaptureTrigger;
251 } AeTriggerCancelOverride_t;
252
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800253 class CaptureRequest : public LightRefBase<CaptureRequest> {
254 public:
255 CameraMetadata mSettings;
256 sp<camera3::Camera3Stream> mInputStream;
Chien-Yu Chenc2adf482015-05-27 14:27:49 -0700257 camera3_stream_buffer_t mInputBuffer;
Igor Murashkin2fba5842013-04-22 14:03:54 -0700258 Vector<sp<camera3::Camera3OutputStreamInterface> >
259 mOutputStreams;
Jianing Weicb0652e2014-03-12 18:29:36 -0700260 CaptureResultExtras mResultExtras;
Chien-Yu Chend196d612015-06-22 19:49:01 -0700261 // Used to cancel AE precapture trigger for devices doesn't support
262 // CONTROL_AE_PRECAPTURE_TRIGGER_CANCEL
263 AeTriggerCancelOverride_t mAeTriggerCancelOverride;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800264 };
265 typedef List<sp<CaptureRequest> > RequestList;
266
Jianing Wei90e59c92014-03-12 18:29:36 -0700267 status_t checkStatusOkToCaptureLocked();
268
269 status_t convertMetadataListToRequestListLocked(
270 const List<const CameraMetadata> &metadataList,
Jianing Wei2d6bb3f2014-04-11 10:00:31 -0700271 /*out*/
272 RequestList *requestList);
Jianing Wei90e59c92014-03-12 18:29:36 -0700273
Jianing Weicb0652e2014-03-12 18:29:36 -0700274 status_t submitRequestsHelper(const List<const CameraMetadata> &requests, bool repeating,
275 int64_t *lastFrameNumber = NULL);
Jianing Wei90e59c92014-03-12 18:29:36 -0700276
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800277 /**
Igor Murashkin1e479c02013-09-06 16:55:14 -0700278 * Get the last request submitted to the hal by the request thread.
279 *
280 * Takes mLock.
281 */
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700282 virtual CameraMetadata getLatestRequestLocked();
Igor Murashkin1e479c02013-09-06 16:55:14 -0700283
284 /**
Ruben Brunk183f0562015-08-12 12:55:02 -0700285 * Update the current device status and wake all waiting threads.
286 *
287 * Must be called with mLock held.
288 */
289 void internalUpdateStatusLocked(Status status);
290
291 /**
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700292 * Pause processing and flush everything, but don't tell the clients.
293 * This is for reconfiguring outputs transparently when according to the
294 * CameraDeviceBase interface we shouldn't need to.
295 * Must be called with mLock and mInterfaceLock both held.
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800296 */
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700297 status_t internalPauseAndWaitLocked();
298
299 /**
300 * Resume work after internalPauseAndWaitLocked()
301 * Must be called with mLock and mInterfaceLock both held.
302 */
303 status_t internalResumeLocked();
304
305 /**
306 * Wait until status tracker tells us we've transitioned to the target state
307 * set, which is either ACTIVE when active==true or IDLE (which is any
308 * non-ACTIVE state) when active==false.
309 *
310 * Needs to be called with mLock and mInterfaceLock held. This means there
311 * can ever only be one waiter at most.
312 *
313 * During the wait mLock is released.
314 *
315 */
316 status_t waitUntilStateThenRelock(bool active, nsecs_t timeout);
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800317
318 /**
Zhijun He69a37482014-03-23 18:44:49 -0700319 * Implementation of waitUntilDrained. On success, will transition to IDLE state.
320 *
321 * Need to be called with mLock and mInterfaceLock held.
322 */
323 status_t waitUntilDrainedLocked();
324
325 /**
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800326 * Do common work for setting up a streaming or single capture request.
327 * On success, will transition to ACTIVE if in IDLE.
328 */
329 sp<CaptureRequest> setUpRequestLocked(const CameraMetadata &request);
330
331 /**
332 * Build a CaptureRequest request from the CameraDeviceBase request
333 * settings.
334 */
335 sp<CaptureRequest> createCaptureRequest(const CameraMetadata &request);
336
337 /**
338 * Take the currently-defined set of streams and configure the HAL to use
339 * them. This is a long-running operation (may be several hundered ms).
340 */
341 status_t configureStreamsLocked();
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800342
Eino-Ville Talvalab2058d12013-04-09 13:49:56 -0700343 /**
Eino-Ville Talvala16a2ada2014-08-27 14:41:33 -0700344 * Add a dummy stream to the current stream set as a workaround for
345 * not allowing 0 streams in the camera HAL spec.
346 */
347 status_t addDummyStreamLocked();
348
349 /**
350 * Remove a dummy stream if the current config includes real streams.
351 */
352 status_t tryRemoveDummyStreamLocked();
353
354 /**
Eino-Ville Talvalab2058d12013-04-09 13:49:56 -0700355 * Set device into an error state due to some fatal failure, and set an
356 * error message to indicate why. Only the first call's message will be
357 * used. The message is also sent to the log.
358 */
359 void setErrorState(const char *fmt, ...);
360 void setErrorStateV(const char *fmt, va_list args);
361 void setErrorStateLocked(const char *fmt, ...);
362 void setErrorStateLockedV(const char *fmt, va_list args);
363
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700364 /**
365 * Debugging trylock/spin method
366 * Try to acquire a lock a few times with sleeps between before giving up.
367 */
368 bool tryLockSpinRightRound(Mutex& lock);
369
Chien-Yu Chen618ff8a2015-03-13 11:27:17 -0700370 /**
371 * Helper function to determine if an input size for implementation defined
372 * format is supported.
373 */
374 bool isOpaqueInputSizeSupported(uint32_t width, uint32_t height);
Yin-Chia Yehcd8fce82014-06-18 10:51:34 -0700375
376 /**
377 * Helper function to get the largest Jpeg resolution (in area)
378 * Return Size(0, 0) if static metatdata is invalid
379 */
380 Size getMaxJpegResolution() const;
381
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700382 struct RequestTrigger {
383 // Metadata tag number, e.g. android.control.aePrecaptureTrigger
384 uint32_t metadataTag;
385 // Metadata value, e.g. 'START' or the trigger ID
386 int32_t entryValue;
387
388 // The last part of the fully qualified path, e.g. afTrigger
389 const char *getTagName() const {
390 return get_camera_metadata_tag_name(metadataTag) ?: "NULL";
391 }
392
393 // e.g. TYPE_BYTE, TYPE_INT32, etc.
394 int getTagType() const {
395 return get_camera_metadata_tag_type(metadataTag);
396 }
397 };
398
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800399 /**
400 * Thread for managing capture request submission to HAL device.
401 */
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800402 class RequestThread : public Thread {
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800403
404 public:
405
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800406 RequestThread(wp<Camera3Device> parent,
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700407 sp<camera3::StatusTracker> statusTracker,
Chien-Yu Chenab5135b2015-06-30 11:20:58 -0700408 camera3_device_t *hal3Device,
409 bool aeLockAvailable);
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800410
Eino-Ville Talvala4d44cad2015-04-11 13:15:45 -0700411 void setNotificationListener(NotificationListener *listener);
Eino-Ville Talvala17543512014-08-06 14:32:02 -0700412
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800413 /**
414 * Call after stream (re)-configuration is completed.
415 */
416 void configurationComplete();
417
418 /**
419 * Set or clear the list of repeating requests. Does not block
420 * on either. Use waitUntilPaused to wait until request queue
421 * has emptied out.
422 */
Jianing Wei2d6bb3f2014-04-11 10:00:31 -0700423 status_t setRepeatingRequests(const RequestList& requests,
424 /*out*/
425 int64_t *lastFrameNumber = NULL);
426 status_t clearRepeatingRequests(/*out*/
427 int64_t *lastFrameNumber = NULL);
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800428
Jianing Wei2d6bb3f2014-04-11 10:00:31 -0700429 status_t queueRequestList(List<sp<CaptureRequest> > &requests,
430 /*out*/
431 int64_t *lastFrameNumber = NULL);
Jianing Wei90e59c92014-03-12 18:29:36 -0700432
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800433 /**
Eino-Ville Talvalaabaa51d2013-08-14 11:37:00 -0700434 * Remove all queued and repeating requests, and pending triggers
435 */
Eino-Ville Talvala17543512014-08-06 14:32:02 -0700436 status_t clear(NotificationListener *listener,
437 /*out*/
Jianing Wei2d6bb3f2014-04-11 10:00:31 -0700438 int64_t *lastFrameNumber = NULL);
Eino-Ville Talvalaabaa51d2013-08-14 11:37:00 -0700439
440 /**
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700441 * Queue a trigger to be dispatched with the next outgoing
442 * process_capture_request. The settings for that request only
443 * will be temporarily rewritten to add the trigger tag/value.
444 * Subsequent requests will not be rewritten (for this tag).
445 */
446 status_t queueTrigger(RequestTrigger trigger[], size_t count);
447
448 /**
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800449 * Pause/unpause the capture thread. Doesn't block, so use
450 * waitUntilPaused to wait until the thread is paused.
451 */
452 void setPaused(bool paused);
453
454 /**
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700455 * Wait until thread processes the capture request with settings'
456 * android.request.id == requestId.
457 *
458 * Returns TIMED_OUT in case the thread does not process the request
459 * within the timeout.
460 */
461 status_t waitUntilRequestProcessed(int32_t requestId, nsecs_t timeout);
462
Igor Murashkin1e479c02013-09-06 16:55:14 -0700463 /**
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700464 * Shut down the thread. Shutdown is asynchronous, so thread may
465 * still be running once this method returns.
466 */
467 virtual void requestExit();
468
469 /**
Igor Murashkin1e479c02013-09-06 16:55:14 -0700470 * Get the latest request that was sent to the HAL
471 * with process_capture_request.
472 */
473 CameraMetadata getLatestRequest() const;
474
Eino-Ville Talvala4d44cad2015-04-11 13:15:45 -0700475 /**
476 * Returns true if the stream is a target of any queued or repeating
477 * capture request
478 */
479 bool isStreamPending(sp<camera3::Camera3StreamInterface>& stream);
480
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800481 protected:
482
483 virtual bool threadLoop();
484
485 private:
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700486 static int getId(const wp<Camera3Device> &device);
487
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700488 status_t queueTriggerLocked(RequestTrigger trigger);
489 // Mix-in queued triggers into this request
490 int32_t insertTriggers(const sp<CaptureRequest> &request);
491 // Purge the queued triggers from this request,
492 // restoring the old field values for those tags.
493 status_t removeTriggers(const sp<CaptureRequest> &request);
494
Eino-Ville Talvala2f876f92013-09-13 11:39:24 -0700495 // HAL workaround: Make sure a trigger ID always exists if
496 // a trigger does
497 status_t addDummyTriggerIds(const sp<CaptureRequest> &request);
498
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800499 static const nsecs_t kRequestTimeout = 50e6; // 50 ms
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800500
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800501 // Waits for a request, or returns NULL if times out.
502 sp<CaptureRequest> waitForNextRequest();
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800503
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800504 // Return buffers, etc, for a request that couldn't be fully
505 // constructed. The buffers will be returned in the ERROR state
506 // to mark them as not having valid data.
507 // All arguments will be modified.
508 void cleanUpFailedRequest(camera3_capture_request_t &request,
509 sp<CaptureRequest> &nextRequest,
510 Vector<camera3_stream_buffer_t> &outputBuffers);
511
512 // Pause handling
513 bool waitIfPaused();
Eino-Ville Talvala26fe6c72013-08-29 12:46:18 -0700514 void unpauseForNewRequests();
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800515
Eino-Ville Talvalab2058d12013-04-09 13:49:56 -0700516 // Relay error to parent device object setErrorState
517 void setErrorState(const char *fmt, ...);
518
Yin-Chia Yeh8684b7f2014-06-13 14:53:05 -0700519 // If the input request is in mRepeatingRequests. Must be called with mRequestLock hold
520 bool isRepeatingRequestLocked(const sp<CaptureRequest>);
521
Chien-Yu Chend196d612015-06-22 19:49:01 -0700522 // Handle AE precapture trigger cancel for devices <= CAMERA_DEVICE_API_VERSION_3_2.
523 void handleAePrecaptureCancelRequest(sp<CaptureRequest> request);
524
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800525 wp<Camera3Device> mParent;
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700526 wp<camera3::StatusTracker> mStatusTracker;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800527 camera3_device_t *mHal3Device;
528
Eino-Ville Talvala17543512014-08-06 14:32:02 -0700529 NotificationListener *mListener;
530
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700531 const int mId; // The camera ID
532 int mStatusId; // The RequestThread's component ID for
533 // status tracking
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700534
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800535 Mutex mRequestLock;
536 Condition mRequestSignal;
537 RequestList mRequestQueue;
538 RequestList mRepeatingRequests;
Eino-Ville Talvalae74c2282015-05-27 14:46:23 -0700539 // The next request being prepped for submission to the HAL, no longer
540 // on the request queue. Read-only even with mRequestLock held, outside
541 // of threadLoop
542 sp<const CaptureRequest> mNextRequest;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800543
544 bool mReconfigured;
545
546 // Used by waitIfPaused, waitForNextRequest, and waitUntilPaused
547 Mutex mPauseLock;
548 bool mDoPause;
549 Condition mDoPauseSignal;
550 bool mPaused;
551 Condition mPausedSignal;
552
553 sp<CaptureRequest> mPrevRequest;
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700554 int32_t mPrevTriggers;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800555
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700556 uint32_t mFrameNumber;
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700557
Igor Murashkin1e479c02013-09-06 16:55:14 -0700558 mutable Mutex mLatestRequestMutex;
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700559 Condition mLatestRequestSignal;
560 // android.request.id for latest process_capture_request
561 int32_t mLatestRequestId;
Igor Murashkin1e479c02013-09-06 16:55:14 -0700562 CameraMetadata mLatestRequest;
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700563
564 typedef KeyedVector<uint32_t/*tag*/, RequestTrigger> TriggerMap;
565 Mutex mTriggerMutex;
566 TriggerMap mTriggerMap;
567 TriggerMap mTriggerRemovedMap;
568 TriggerMap mTriggerReplacedMap;
Yin-Chia Yehc00a25c2014-08-21 14:27:44 -0700569 uint32_t mCurrentAfTriggerId;
570 uint32_t mCurrentPreCaptureTriggerId;
Jianing Weicb0652e2014-03-12 18:29:36 -0700571
Jianing Wei2d6bb3f2014-04-11 10:00:31 -0700572 int64_t mRepeatingLastFrameNumber;
Chien-Yu Chend196d612015-06-22 19:49:01 -0700573
574 // Whether the device supports AE lock
575 bool mAeLockAvailable;
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800576 };
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800577 sp<RequestThread> mRequestThread;
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800578
579 /**
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700580 * In-flight queue for tracking completion of capture requests.
581 */
582
583 struct InFlightRequest {
584 // Set by notify() SHUTTER call.
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800585 nsecs_t shutterTimestamp;
586 // Set by process_capture_result().
587 nsecs_t sensorTimestamp;
Zhijun He1d1f8462013-10-02 16:29:51 -0700588 int requestStatus;
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700589 // Set by process_capture_result call with valid metadata
590 bool haveResultMetadata;
591 // Decremented by calls to process_capture_result with valid output
Zhijun Hef0d962a2014-06-30 10:24:11 -0700592 // and input buffers
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700593 int numBuffersLeft;
Jianing Weicb0652e2014-03-12 18:29:36 -0700594 CaptureResultExtras resultExtras;
Zhijun Hec98bd8d2014-07-07 12:44:10 -0700595 // If this request has any input buffer
596 bool hasInputBuffer;
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700597
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800598 // The last metadata that framework receives from HAL and
599 // not yet send out because the shutter event hasn't arrived.
600 // It's added by process_capture_result and sent when framework
601 // receives the shutter event.
602 CameraMetadata pendingMetadata;
603
604 // Buffers are added by process_capture_result when output buffers
605 // return from HAL but framework has not yet received the shutter
606 // event. They will be returned to the streams when framework receives
607 // the shutter event.
608 Vector<camera3_stream_buffer_t> pendingOutputBuffers;
609
Chien-Yu Chend196d612015-06-22 19:49:01 -0700610 // Used to cancel AE precapture trigger for devices doesn't support
611 // CONTROL_AE_PRECAPTURE_TRIGGER_CANCEL
612 AeTriggerCancelOverride_t aeTriggerCancelOverride;
613
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800614
Zhijun He204e3292014-07-14 17:09:23 -0700615 // Fields used by the partial result only
616 struct PartialResultInFlight {
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700617 // Set by process_capture_result once 3A has been sent to clients
618 bool haveSent3A;
619 // Result metadata collected so far, when partial results are in use
620 CameraMetadata collectedResult;
621
Zhijun He204e3292014-07-14 17:09:23 -0700622 PartialResultInFlight():
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700623 haveSent3A(false) {
624 }
Zhijun He204e3292014-07-14 17:09:23 -0700625 } partialResult;
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700626
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700627 // Default constructor needed by KeyedVector
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700628 InFlightRequest() :
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800629 shutterTimestamp(0),
630 sensorTimestamp(0),
Zhijun He1d1f8462013-10-02 16:29:51 -0700631 requestStatus(OK),
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700632 haveResultMetadata(false),
Zhijun Hec98bd8d2014-07-07 12:44:10 -0700633 numBuffersLeft(0),
Chien-Yu Chend196d612015-06-22 19:49:01 -0700634 hasInputBuffer(false),
635 aeTriggerCancelOverride({false, 0, false, 0}){
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700636 }
637
Chien-Yu Chend196d612015-06-22 19:49:01 -0700638 InFlightRequest(int numBuffers, CaptureResultExtras extras, bool hasInput,
639 AeTriggerCancelOverride aeTriggerCancelOverride) :
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800640 shutterTimestamp(0),
641 sensorTimestamp(0),
Jianing Weicb0652e2014-03-12 18:29:36 -0700642 requestStatus(OK),
643 haveResultMetadata(false),
644 numBuffersLeft(numBuffers),
Zhijun Hec98bd8d2014-07-07 12:44:10 -0700645 resultExtras(extras),
Chien-Yu Chend196d612015-06-22 19:49:01 -0700646 hasInputBuffer(hasInput),
647 aeTriggerCancelOverride(aeTriggerCancelOverride){
Zhijun Hec98bd8d2014-07-07 12:44:10 -0700648 }
Eino-Ville Talvala4d44cad2015-04-11 13:15:45 -0700649 };
650
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700651 // Map from frame number to the in-flight request state
652 typedef KeyedVector<uint32_t, InFlightRequest> InFlightMap;
653
654 Mutex mInFlightLock; // Protects mInFlightMap
655 InFlightMap mInFlightMap;
656
Jianing Weicb0652e2014-03-12 18:29:36 -0700657 status_t registerInFlight(uint32_t frameNumber,
Chien-Yu Chend196d612015-06-22 19:49:01 -0700658 int32_t numBuffers, CaptureResultExtras resultExtras, bool hasInput,
659 const AeTriggerCancelOverride_t &aeTriggerCancelOverride);
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700660
661 /**
Zhijun He204e3292014-07-14 17:09:23 -0700662 * For the partial result, check if all 3A state fields are available
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700663 * and if so, queue up 3A-only result to the client. Returns true if 3A
664 * is sent.
665 */
Zhijun He204e3292014-07-14 17:09:23 -0700666 bool processPartial3AResult(uint32_t frameNumber,
Jianing Weicb0652e2014-03-12 18:29:36 -0700667 const CameraMetadata& partial, const CaptureResultExtras& resultExtras);
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700668
669 // Helpers for reading and writing 3A metadata into to/from partial results
670 template<typename T>
671 bool get3AResult(const CameraMetadata& result, int32_t tag,
Jianing Weicb0652e2014-03-12 18:29:36 -0700672 T* value, uint32_t frameNumber);
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700673
674 template<typename T>
675 bool insert3AResult(CameraMetadata &result, int32_t tag, const T* value,
Jianing Weicb0652e2014-03-12 18:29:36 -0700676 uint32_t frameNumber);
Chien-Yu Chend196d612015-06-22 19:49:01 -0700677
678 /**
679 * Override result metadata for cancelling AE precapture trigger applied in
680 * handleAePrecaptureCancelRequest().
681 */
682 void overrideResultForPrecaptureCancel(CameraMetadata* result,
683 const AeTriggerCancelOverride_t &aeTriggerCancelOverride);
684
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700685 /**
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700686 * Tracking for idle detection
687 */
688 sp<camera3::StatusTracker> mStatusTracker;
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700689
690 /**
Eino-Ville Talvala4d44cad2015-04-11 13:15:45 -0700691 * Thread for preparing streams
692 */
693 class PreparerThread : private Thread, public virtual RefBase {
694 public:
695 PreparerThread();
696 ~PreparerThread();
697
698 void setNotificationListener(NotificationListener *listener);
699
700 /**
701 * Queue up a stream to be prepared. Streams are processed by
702 * a background thread in FIFO order
703 */
704 status_t prepare(sp<camera3::Camera3StreamInterface>& stream);
705
706 /**
707 * Cancel all current and pending stream preparation
708 */
709 status_t clear();
710
711 private:
712 Mutex mLock;
713
714 virtual bool threadLoop();
715
716 // Guarded by mLock
717
718 NotificationListener *mListener;
719 List<sp<camera3::Camera3StreamInterface> > mPendingStreams;
720 bool mActive;
721 bool mCancelNow;
722
723 // Only accessed by threadLoop and the destructor
724
725 sp<camera3::Camera3StreamInterface> mCurrentStream;
726 };
727 sp<PreparerThread> mPreparerThread;
728
729 /**
Eino-Ville Talvala7d346fa2013-03-11 14:13:50 -0700730 * Output result queue and current HAL device 3A state
731 */
732
733 // Lock for output side of device
734 Mutex mOutputLock;
735
736 /**** Scope for mOutputLock ****/
Chien-Yu Chen618ff8a2015-03-13 11:27:17 -0700737 // the minimal frame number of the next non-reprocess result
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700738 uint32_t mNextResultFrameNumber;
Chien-Yu Chen618ff8a2015-03-13 11:27:17 -0700739 // the minimal frame number of the next reprocess result
740 uint32_t mNextReprocessResultFrameNumber;
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700741 uint32_t mNextShutterFrameNumber;
Jianing Weicb0652e2014-03-12 18:29:36 -0700742 List<CaptureResult> mResultQueue;
Eino-Ville Talvala7d346fa2013-03-11 14:13:50 -0700743 Condition mResultSignal;
744 NotificationListener *mListener;
745
Eino-Ville Talvala7d346fa2013-03-11 14:13:50 -0700746 /**** End scope for mOutputLock ****/
747
748 /**
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800749 * Callback functions from HAL device
750 */
751 void processCaptureResult(const camera3_capture_result *result);
752
753 void notify(const camera3_notify_msg *msg);
754
Eino-Ville Talvala17543512014-08-06 14:32:02 -0700755 // Specific notify handlers
756 void notifyError(const camera3_error_msg_t &msg,
757 NotificationListener *listener);
758 void notifyShutter(const camera3_shutter_msg_t &msg,
759 NotificationListener *listener);
760
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800761 // helper function to return the output buffers to the streams.
762 void returnOutputBuffers(const camera3_stream_buffer_t *outputBuffers,
763 size_t numBuffers, nsecs_t timestamp);
764
765 // Insert the capture result given the pending metadata, result extras,
766 // partial results, and the frame number to the result queue.
767 void sendCaptureResult(CameraMetadata &pendingMetadata,
768 CaptureResultExtras &resultExtras,
Chien-Yu Chen618ff8a2015-03-13 11:27:17 -0700769 CameraMetadata &collectedPartialResult, uint32_t frameNumber,
Chien-Yu Chend196d612015-06-22 19:49:01 -0700770 bool reprocess, const AeTriggerCancelOverride_t &aeTriggerCancelOverride);
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800771
772 /**** Scope for mInFlightLock ****/
773
774 // Remove the in-flight request of the given index from mInFlightMap
775 // if it's no longer needed. It must only be called with mInFlightLock held.
776 void removeInFlightRequestIfReadyLocked(int idx);
777
778 /**** End scope for mInFlightLock ****/
779
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800780 /**
781 * Static callback forwarding methods from HAL to instance
782 */
783 static callbacks_process_capture_result_t sProcessCaptureResult;
784
785 static callbacks_notify_t sNotify;
786
787}; // class Camera3Device
788
789}; // namespace android
790
791#endif