blob: 140da98c2545ae857e532418f465e83090d03eb0 [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;
149
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700150 // Methods called by subclasses
151 void notifyStatus(bool idle); // updates from StatusTracker
152
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800153 private:
Igor Murashkin1e479c02013-09-06 16:55:14 -0700154 static const size_t kDumpLockAttempts = 10;
155 static const size_t kDumpSleepDuration = 100000; // 0.10 sec
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700156 static const size_t kInFlightWarnLimit = 20;
157 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
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700159 struct RequestTrigger;
Zhijun Hef7da0962014-04-24 13:27:56 -0700160 // minimal jpeg buffer size: 256KB + blob header
161 static const ssize_t kMinJpegBufferSize = 256 * 1024 + sizeof(camera3_jpeg_blob);
Eino-Ville Talvala16a2ada2014-08-27 14:41:33 -0700162 // Constant to use for stream ID when one doesn't exist
163 static const int NO_STREAM = -1;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800164
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700165 // A lock to enforce serialization on the input/configure side
166 // of the public interface.
167 // Only locked by public methods inherited from CameraDeviceBase.
168 // Not locked by methods guarded by mOutputLock, since they may act
169 // concurrently to the input/configure side of the interface.
170 // Must be locked before mLock if both will be locked by a method
171 Mutex mInterfaceLock;
172
173 // The main lock on internal state
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800174 Mutex mLock;
175
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700176 // Camera device ID
177 const int mId;
178
Zhijun He1fa89992015-06-01 15:44:31 -0700179 // Flag indicating is the current active stream configuration is constrained high speed.
180 bool mIsConstrainedHighSpeedConfiguration;
181
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800182 /**** Scope for mLock ****/
183
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800184 camera3_device_t *mHal3Device;
185
186 CameraMetadata mDeviceInfo;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800187
Zhijun Hea1530f12014-09-14 12:44:20 -0700188 CameraMetadata mRequestTemplateCache[CAMERA3_TEMPLATE_COUNT];
189
Zhijun He204e3292014-07-14 17:09:23 -0700190 uint32_t mDeviceVersion;
Yin-Chia Yehcd8fce82014-06-18 10:51:34 -0700191
Chien-Yu Chen618ff8a2015-03-13 11:27:17 -0700192 struct Size {
193 uint32_t width;
194 uint32_t height;
195 Size(uint32_t w = 0, uint32_t h = 0) : width(w), height(h){}
196 };
197 // Map from format to size.
198 Vector<Size> mSupportedOpaqueInputSizes;
199
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700200 enum Status {
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800201 STATUS_ERROR,
202 STATUS_UNINITIALIZED,
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700203 STATUS_UNCONFIGURED,
204 STATUS_CONFIGURED,
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800205 STATUS_ACTIVE
206 } mStatus;
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700207 Vector<Status> mRecentStatusUpdates;
208 Condition mStatusChanged;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800209
Eino-Ville Talvalab2058d12013-04-09 13:49:56 -0700210 // Tracking cause of fatal errors when in STATUS_ERROR
211 String8 mErrorCause;
212
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800213 // Mapping of stream IDs to stream instances
Igor Murashkin2fba5842013-04-22 14:03:54 -0700214 typedef KeyedVector<int, sp<camera3::Camera3OutputStreamInterface> >
215 StreamSet;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800216
217 StreamSet mOutputStreams;
218 sp<camera3::Camera3Stream> mInputStream;
219 int mNextStreamId;
Eino-Ville Talvalaea26c772013-06-11 16:04:06 -0700220 bool mNeedConfig;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800221
Eino-Ville Talvala16a2ada2014-08-27 14:41:33 -0700222 int mDummyStreamId;
223
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700224 // Whether to send state updates upstream
225 // Pause when doing transparent reconfiguration
226 bool mPauseStateNotify;
227
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800228 // Need to hold on to stream references until configure completes.
Igor Murashkin2fba5842013-04-22 14:03:54 -0700229 Vector<sp<camera3::Camera3StreamInterface> > mDeletedStreams;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800230
Zhijun He204e3292014-07-14 17:09:23 -0700231 // Whether the HAL will send partial result
232 bool mUsePartialResult;
233
234 // Number of partial results that will be delivered by the HAL.
235 uint32_t mNumPartialResults;
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700236
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800237 /**** End scope for mLock ****/
238
Chien-Yu Chend196d612015-06-22 19:49:01 -0700239 typedef struct AeTriggerCancelOverride {
240 bool applyAeLock;
241 uint8_t aeLock;
242 bool applyAePrecaptureTrigger;
243 uint8_t aePrecaptureTrigger;
244 } AeTriggerCancelOverride_t;
245
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800246 class CaptureRequest : public LightRefBase<CaptureRequest> {
247 public:
248 CameraMetadata mSettings;
249 sp<camera3::Camera3Stream> mInputStream;
Chien-Yu Chenc2adf482015-05-27 14:27:49 -0700250 camera3_stream_buffer_t mInputBuffer;
Igor Murashkin2fba5842013-04-22 14:03:54 -0700251 Vector<sp<camera3::Camera3OutputStreamInterface> >
252 mOutputStreams;
Jianing Weicb0652e2014-03-12 18:29:36 -0700253 CaptureResultExtras mResultExtras;
Chien-Yu Chend196d612015-06-22 19:49:01 -0700254 // Used to cancel AE precapture trigger for devices doesn't support
255 // CONTROL_AE_PRECAPTURE_TRIGGER_CANCEL
256 AeTriggerCancelOverride_t mAeTriggerCancelOverride;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800257 };
258 typedef List<sp<CaptureRequest> > RequestList;
259
Jianing Wei90e59c92014-03-12 18:29:36 -0700260 status_t checkStatusOkToCaptureLocked();
261
262 status_t convertMetadataListToRequestListLocked(
263 const List<const CameraMetadata> &metadataList,
Jianing Wei2d6bb3f2014-04-11 10:00:31 -0700264 /*out*/
265 RequestList *requestList);
Jianing Wei90e59c92014-03-12 18:29:36 -0700266
Jianing Weicb0652e2014-03-12 18:29:36 -0700267 status_t submitRequestsHelper(const List<const CameraMetadata> &requests, bool repeating,
268 int64_t *lastFrameNumber = NULL);
Jianing Wei90e59c92014-03-12 18:29:36 -0700269
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800270 /**
Igor Murashkin1e479c02013-09-06 16:55:14 -0700271 * Get the last request submitted to the hal by the request thread.
272 *
273 * Takes mLock.
274 */
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700275 virtual CameraMetadata getLatestRequestLocked();
Igor Murashkin1e479c02013-09-06 16:55:14 -0700276
277 /**
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700278 * Pause processing and flush everything, but don't tell the clients.
279 * This is for reconfiguring outputs transparently when according to the
280 * CameraDeviceBase interface we shouldn't need to.
281 * Must be called with mLock and mInterfaceLock both held.
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800282 */
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700283 status_t internalPauseAndWaitLocked();
284
285 /**
286 * Resume work after internalPauseAndWaitLocked()
287 * Must be called with mLock and mInterfaceLock both held.
288 */
289 status_t internalResumeLocked();
290
291 /**
292 * Wait until status tracker tells us we've transitioned to the target state
293 * set, which is either ACTIVE when active==true or IDLE (which is any
294 * non-ACTIVE state) when active==false.
295 *
296 * Needs to be called with mLock and mInterfaceLock held. This means there
297 * can ever only be one waiter at most.
298 *
299 * During the wait mLock is released.
300 *
301 */
302 status_t waitUntilStateThenRelock(bool active, nsecs_t timeout);
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800303
304 /**
Zhijun He69a37482014-03-23 18:44:49 -0700305 * Implementation of waitUntilDrained. On success, will transition to IDLE state.
306 *
307 * Need to be called with mLock and mInterfaceLock held.
308 */
309 status_t waitUntilDrainedLocked();
310
311 /**
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800312 * Do common work for setting up a streaming or single capture request.
313 * On success, will transition to ACTIVE if in IDLE.
314 */
315 sp<CaptureRequest> setUpRequestLocked(const CameraMetadata &request);
316
317 /**
318 * Build a CaptureRequest request from the CameraDeviceBase request
319 * settings.
320 */
321 sp<CaptureRequest> createCaptureRequest(const CameraMetadata &request);
322
323 /**
324 * Take the currently-defined set of streams and configure the HAL to use
325 * them. This is a long-running operation (may be several hundered ms).
326 */
327 status_t configureStreamsLocked();
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800328
Eino-Ville Talvalab2058d12013-04-09 13:49:56 -0700329 /**
Eino-Ville Talvala16a2ada2014-08-27 14:41:33 -0700330 * Add a dummy stream to the current stream set as a workaround for
331 * not allowing 0 streams in the camera HAL spec.
332 */
333 status_t addDummyStreamLocked();
334
335 /**
336 * Remove a dummy stream if the current config includes real streams.
337 */
338 status_t tryRemoveDummyStreamLocked();
339
340 /**
Eino-Ville Talvalab2058d12013-04-09 13:49:56 -0700341 * Set device into an error state due to some fatal failure, and set an
342 * error message to indicate why. Only the first call's message will be
343 * used. The message is also sent to the log.
344 */
345 void setErrorState(const char *fmt, ...);
346 void setErrorStateV(const char *fmt, va_list args);
347 void setErrorStateLocked(const char *fmt, ...);
348 void setErrorStateLockedV(const char *fmt, va_list args);
349
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700350 /**
351 * Debugging trylock/spin method
352 * Try to acquire a lock a few times with sleeps between before giving up.
353 */
354 bool tryLockSpinRightRound(Mutex& lock);
355
Chien-Yu Chen618ff8a2015-03-13 11:27:17 -0700356 /**
357 * Helper function to determine if an input size for implementation defined
358 * format is supported.
359 */
360 bool isOpaqueInputSizeSupported(uint32_t width, uint32_t height);
Yin-Chia Yehcd8fce82014-06-18 10:51:34 -0700361
362 /**
363 * Helper function to get the largest Jpeg resolution (in area)
364 * Return Size(0, 0) if static metatdata is invalid
365 */
366 Size getMaxJpegResolution() const;
367
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700368 struct RequestTrigger {
369 // Metadata tag number, e.g. android.control.aePrecaptureTrigger
370 uint32_t metadataTag;
371 // Metadata value, e.g. 'START' or the trigger ID
372 int32_t entryValue;
373
374 // The last part of the fully qualified path, e.g. afTrigger
375 const char *getTagName() const {
376 return get_camera_metadata_tag_name(metadataTag) ?: "NULL";
377 }
378
379 // e.g. TYPE_BYTE, TYPE_INT32, etc.
380 int getTagType() const {
381 return get_camera_metadata_tag_type(metadataTag);
382 }
383 };
384
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800385 /**
386 * Thread for managing capture request submission to HAL device.
387 */
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800388 class RequestThread : public Thread {
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800389
390 public:
391
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800392 RequestThread(wp<Camera3Device> parent,
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700393 sp<camera3::StatusTracker> statusTracker,
Chien-Yu Chenab5135b2015-06-30 11:20:58 -0700394 camera3_device_t *hal3Device,
395 bool aeLockAvailable);
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800396
Eino-Ville Talvala4d44cad2015-04-11 13:15:45 -0700397 void setNotificationListener(NotificationListener *listener);
Eino-Ville Talvala17543512014-08-06 14:32:02 -0700398
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800399 /**
400 * Call after stream (re)-configuration is completed.
401 */
402 void configurationComplete();
403
404 /**
405 * Set or clear the list of repeating requests. Does not block
406 * on either. Use waitUntilPaused to wait until request queue
407 * has emptied out.
408 */
Jianing Wei2d6bb3f2014-04-11 10:00:31 -0700409 status_t setRepeatingRequests(const RequestList& requests,
410 /*out*/
411 int64_t *lastFrameNumber = NULL);
412 status_t clearRepeatingRequests(/*out*/
413 int64_t *lastFrameNumber = NULL);
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800414
Jianing Wei2d6bb3f2014-04-11 10:00:31 -0700415 status_t queueRequestList(List<sp<CaptureRequest> > &requests,
416 /*out*/
417 int64_t *lastFrameNumber = NULL);
Jianing Wei90e59c92014-03-12 18:29:36 -0700418
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800419 /**
Eino-Ville Talvalaabaa51d2013-08-14 11:37:00 -0700420 * Remove all queued and repeating requests, and pending triggers
421 */
Eino-Ville Talvala17543512014-08-06 14:32:02 -0700422 status_t clear(NotificationListener *listener,
423 /*out*/
Jianing Wei2d6bb3f2014-04-11 10:00:31 -0700424 int64_t *lastFrameNumber = NULL);
Eino-Ville Talvalaabaa51d2013-08-14 11:37:00 -0700425
426 /**
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700427 * Queue a trigger to be dispatched with the next outgoing
428 * process_capture_request. The settings for that request only
429 * will be temporarily rewritten to add the trigger tag/value.
430 * Subsequent requests will not be rewritten (for this tag).
431 */
432 status_t queueTrigger(RequestTrigger trigger[], size_t count);
433
434 /**
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800435 * Pause/unpause the capture thread. Doesn't block, so use
436 * waitUntilPaused to wait until the thread is paused.
437 */
438 void setPaused(bool paused);
439
440 /**
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700441 * Wait until thread processes the capture request with settings'
442 * android.request.id == requestId.
443 *
444 * Returns TIMED_OUT in case the thread does not process the request
445 * within the timeout.
446 */
447 status_t waitUntilRequestProcessed(int32_t requestId, nsecs_t timeout);
448
Igor Murashkin1e479c02013-09-06 16:55:14 -0700449 /**
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700450 * Shut down the thread. Shutdown is asynchronous, so thread may
451 * still be running once this method returns.
452 */
453 virtual void requestExit();
454
455 /**
Igor Murashkin1e479c02013-09-06 16:55:14 -0700456 * Get the latest request that was sent to the HAL
457 * with process_capture_request.
458 */
459 CameraMetadata getLatestRequest() const;
460
Eino-Ville Talvala4d44cad2015-04-11 13:15:45 -0700461 /**
462 * Returns true if the stream is a target of any queued or repeating
463 * capture request
464 */
465 bool isStreamPending(sp<camera3::Camera3StreamInterface>& stream);
466
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800467 protected:
468
469 virtual bool threadLoop();
470
471 private:
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700472 static int getId(const wp<Camera3Device> &device);
473
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700474 status_t queueTriggerLocked(RequestTrigger trigger);
475 // Mix-in queued triggers into this request
476 int32_t insertTriggers(const sp<CaptureRequest> &request);
477 // Purge the queued triggers from this request,
478 // restoring the old field values for those tags.
479 status_t removeTriggers(const sp<CaptureRequest> &request);
480
Eino-Ville Talvala2f876f92013-09-13 11:39:24 -0700481 // HAL workaround: Make sure a trigger ID always exists if
482 // a trigger does
483 status_t addDummyTriggerIds(const sp<CaptureRequest> &request);
484
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800485 static const nsecs_t kRequestTimeout = 50e6; // 50 ms
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800486
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800487 // Waits for a request, or returns NULL if times out.
488 sp<CaptureRequest> waitForNextRequest();
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800489
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800490 // Return buffers, etc, for a request that couldn't be fully
491 // constructed. The buffers will be returned in the ERROR state
492 // to mark them as not having valid data.
493 // All arguments will be modified.
494 void cleanUpFailedRequest(camera3_capture_request_t &request,
495 sp<CaptureRequest> &nextRequest,
496 Vector<camera3_stream_buffer_t> &outputBuffers);
497
498 // Pause handling
499 bool waitIfPaused();
Eino-Ville Talvala26fe6c72013-08-29 12:46:18 -0700500 void unpauseForNewRequests();
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800501
Eino-Ville Talvalab2058d12013-04-09 13:49:56 -0700502 // Relay error to parent device object setErrorState
503 void setErrorState(const char *fmt, ...);
504
Yin-Chia Yeh8684b7f2014-06-13 14:53:05 -0700505 // If the input request is in mRepeatingRequests. Must be called with mRequestLock hold
506 bool isRepeatingRequestLocked(const sp<CaptureRequest>);
507
Chien-Yu Chend196d612015-06-22 19:49:01 -0700508 // Handle AE precapture trigger cancel for devices <= CAMERA_DEVICE_API_VERSION_3_2.
509 void handleAePrecaptureCancelRequest(sp<CaptureRequest> request);
510
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800511 wp<Camera3Device> mParent;
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700512 wp<camera3::StatusTracker> mStatusTracker;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800513 camera3_device_t *mHal3Device;
514
Eino-Ville Talvala17543512014-08-06 14:32:02 -0700515 NotificationListener *mListener;
516
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700517 const int mId; // The camera ID
518 int mStatusId; // The RequestThread's component ID for
519 // status tracking
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700520
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800521 Mutex mRequestLock;
522 Condition mRequestSignal;
523 RequestList mRequestQueue;
524 RequestList mRepeatingRequests;
Eino-Ville Talvalae74c2282015-05-27 14:46:23 -0700525 // The next request being prepped for submission to the HAL, no longer
526 // on the request queue. Read-only even with mRequestLock held, outside
527 // of threadLoop
528 sp<const CaptureRequest> mNextRequest;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800529
530 bool mReconfigured;
531
532 // Used by waitIfPaused, waitForNextRequest, and waitUntilPaused
533 Mutex mPauseLock;
534 bool mDoPause;
535 Condition mDoPauseSignal;
536 bool mPaused;
537 Condition mPausedSignal;
538
539 sp<CaptureRequest> mPrevRequest;
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700540 int32_t mPrevTriggers;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800541
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700542 uint32_t mFrameNumber;
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700543
Igor Murashkin1e479c02013-09-06 16:55:14 -0700544 mutable Mutex mLatestRequestMutex;
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700545 Condition mLatestRequestSignal;
546 // android.request.id for latest process_capture_request
547 int32_t mLatestRequestId;
Igor Murashkin1e479c02013-09-06 16:55:14 -0700548 CameraMetadata mLatestRequest;
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700549
550 typedef KeyedVector<uint32_t/*tag*/, RequestTrigger> TriggerMap;
551 Mutex mTriggerMutex;
552 TriggerMap mTriggerMap;
553 TriggerMap mTriggerRemovedMap;
554 TriggerMap mTriggerReplacedMap;
Yin-Chia Yehc00a25c2014-08-21 14:27:44 -0700555 uint32_t mCurrentAfTriggerId;
556 uint32_t mCurrentPreCaptureTriggerId;
Jianing Weicb0652e2014-03-12 18:29:36 -0700557
Jianing Wei2d6bb3f2014-04-11 10:00:31 -0700558 int64_t mRepeatingLastFrameNumber;
Chien-Yu Chend196d612015-06-22 19:49:01 -0700559
560 // Whether the device supports AE lock
561 bool mAeLockAvailable;
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800562 };
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800563 sp<RequestThread> mRequestThread;
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800564
565 /**
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700566 * In-flight queue for tracking completion of capture requests.
567 */
568
569 struct InFlightRequest {
570 // Set by notify() SHUTTER call.
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800571 nsecs_t shutterTimestamp;
572 // Set by process_capture_result().
573 nsecs_t sensorTimestamp;
Zhijun He1d1f8462013-10-02 16:29:51 -0700574 int requestStatus;
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700575 // Set by process_capture_result call with valid metadata
576 bool haveResultMetadata;
577 // Decremented by calls to process_capture_result with valid output
Zhijun Hef0d962a2014-06-30 10:24:11 -0700578 // and input buffers
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700579 int numBuffersLeft;
Jianing Weicb0652e2014-03-12 18:29:36 -0700580 CaptureResultExtras resultExtras;
Zhijun Hec98bd8d2014-07-07 12:44:10 -0700581 // If this request has any input buffer
582 bool hasInputBuffer;
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700583
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800584 // The last metadata that framework receives from HAL and
585 // not yet send out because the shutter event hasn't arrived.
586 // It's added by process_capture_result and sent when framework
587 // receives the shutter event.
588 CameraMetadata pendingMetadata;
589
590 // Buffers are added by process_capture_result when output buffers
591 // return from HAL but framework has not yet received the shutter
592 // event. They will be returned to the streams when framework receives
593 // the shutter event.
594 Vector<camera3_stream_buffer_t> pendingOutputBuffers;
595
Chien-Yu Chend196d612015-06-22 19:49:01 -0700596 // Used to cancel AE precapture trigger for devices doesn't support
597 // CONTROL_AE_PRECAPTURE_TRIGGER_CANCEL
598 AeTriggerCancelOverride_t aeTriggerCancelOverride;
599
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800600
Zhijun He204e3292014-07-14 17:09:23 -0700601 // Fields used by the partial result only
602 struct PartialResultInFlight {
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700603 // Set by process_capture_result once 3A has been sent to clients
604 bool haveSent3A;
605 // Result metadata collected so far, when partial results are in use
606 CameraMetadata collectedResult;
607
Zhijun He204e3292014-07-14 17:09:23 -0700608 PartialResultInFlight():
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700609 haveSent3A(false) {
610 }
Zhijun He204e3292014-07-14 17:09:23 -0700611 } partialResult;
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700612
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700613 // Default constructor needed by KeyedVector
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700614 InFlightRequest() :
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800615 shutterTimestamp(0),
616 sensorTimestamp(0),
Zhijun He1d1f8462013-10-02 16:29:51 -0700617 requestStatus(OK),
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700618 haveResultMetadata(false),
Zhijun Hec98bd8d2014-07-07 12:44:10 -0700619 numBuffersLeft(0),
Chien-Yu Chend196d612015-06-22 19:49:01 -0700620 hasInputBuffer(false),
621 aeTriggerCancelOverride({false, 0, false, 0}){
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700622 }
623
Chien-Yu Chend196d612015-06-22 19:49:01 -0700624 InFlightRequest(int numBuffers, CaptureResultExtras extras, bool hasInput,
625 AeTriggerCancelOverride aeTriggerCancelOverride) :
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800626 shutterTimestamp(0),
627 sensorTimestamp(0),
Jianing Weicb0652e2014-03-12 18:29:36 -0700628 requestStatus(OK),
629 haveResultMetadata(false),
630 numBuffersLeft(numBuffers),
Zhijun Hec98bd8d2014-07-07 12:44:10 -0700631 resultExtras(extras),
Chien-Yu Chend196d612015-06-22 19:49:01 -0700632 hasInputBuffer(hasInput),
633 aeTriggerCancelOverride(aeTriggerCancelOverride){
Zhijun Hec98bd8d2014-07-07 12:44:10 -0700634 }
Eino-Ville Talvala4d44cad2015-04-11 13:15:45 -0700635 };
636
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700637 // Map from frame number to the in-flight request state
638 typedef KeyedVector<uint32_t, InFlightRequest> InFlightMap;
639
640 Mutex mInFlightLock; // Protects mInFlightMap
641 InFlightMap mInFlightMap;
642
Jianing Weicb0652e2014-03-12 18:29:36 -0700643 status_t registerInFlight(uint32_t frameNumber,
Chien-Yu Chend196d612015-06-22 19:49:01 -0700644 int32_t numBuffers, CaptureResultExtras resultExtras, bool hasInput,
645 const AeTriggerCancelOverride_t &aeTriggerCancelOverride);
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700646
647 /**
Zhijun He204e3292014-07-14 17:09:23 -0700648 * For the partial result, check if all 3A state fields are available
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700649 * and if so, queue up 3A-only result to the client. Returns true if 3A
650 * is sent.
651 */
Zhijun He204e3292014-07-14 17:09:23 -0700652 bool processPartial3AResult(uint32_t frameNumber,
Jianing Weicb0652e2014-03-12 18:29:36 -0700653 const CameraMetadata& partial, const CaptureResultExtras& resultExtras);
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700654
655 // Helpers for reading and writing 3A metadata into to/from partial results
656 template<typename T>
657 bool get3AResult(const CameraMetadata& result, int32_t tag,
Jianing Weicb0652e2014-03-12 18:29:36 -0700658 T* value, uint32_t frameNumber);
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700659
660 template<typename T>
661 bool insert3AResult(CameraMetadata &result, int32_t tag, const T* value,
Jianing Weicb0652e2014-03-12 18:29:36 -0700662 uint32_t frameNumber);
Chien-Yu Chend196d612015-06-22 19:49:01 -0700663
664 /**
665 * Override result metadata for cancelling AE precapture trigger applied in
666 * handleAePrecaptureCancelRequest().
667 */
668 void overrideResultForPrecaptureCancel(CameraMetadata* result,
669 const AeTriggerCancelOverride_t &aeTriggerCancelOverride);
670
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700671 /**
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700672 * Tracking for idle detection
673 */
674 sp<camera3::StatusTracker> mStatusTracker;
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700675
676 /**
Eino-Ville Talvala4d44cad2015-04-11 13:15:45 -0700677 * Thread for preparing streams
678 */
679 class PreparerThread : private Thread, public virtual RefBase {
680 public:
681 PreparerThread();
682 ~PreparerThread();
683
684 void setNotificationListener(NotificationListener *listener);
685
686 /**
687 * Queue up a stream to be prepared. Streams are processed by
688 * a background thread in FIFO order
689 */
690 status_t prepare(sp<camera3::Camera3StreamInterface>& stream);
691
692 /**
693 * Cancel all current and pending stream preparation
694 */
695 status_t clear();
696
697 private:
698 Mutex mLock;
699
700 virtual bool threadLoop();
701
702 // Guarded by mLock
703
704 NotificationListener *mListener;
705 List<sp<camera3::Camera3StreamInterface> > mPendingStreams;
706 bool mActive;
707 bool mCancelNow;
708
709 // Only accessed by threadLoop and the destructor
710
711 sp<camera3::Camera3StreamInterface> mCurrentStream;
712 };
713 sp<PreparerThread> mPreparerThread;
714
715 /**
Eino-Ville Talvala7d346fa2013-03-11 14:13:50 -0700716 * Output result queue and current HAL device 3A state
717 */
718
719 // Lock for output side of device
720 Mutex mOutputLock;
721
722 /**** Scope for mOutputLock ****/
Chien-Yu Chen618ff8a2015-03-13 11:27:17 -0700723 // the minimal frame number of the next non-reprocess result
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700724 uint32_t mNextResultFrameNumber;
Chien-Yu Chen618ff8a2015-03-13 11:27:17 -0700725 // the minimal frame number of the next reprocess result
726 uint32_t mNextReprocessResultFrameNumber;
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700727 uint32_t mNextShutterFrameNumber;
Jianing Weicb0652e2014-03-12 18:29:36 -0700728 List<CaptureResult> mResultQueue;
Eino-Ville Talvala7d346fa2013-03-11 14:13:50 -0700729 Condition mResultSignal;
730 NotificationListener *mListener;
731
Eino-Ville Talvala7d346fa2013-03-11 14:13:50 -0700732 /**** End scope for mOutputLock ****/
733
734 /**
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800735 * Callback functions from HAL device
736 */
737 void processCaptureResult(const camera3_capture_result *result);
738
739 void notify(const camera3_notify_msg *msg);
740
Eino-Ville Talvala17543512014-08-06 14:32:02 -0700741 // Specific notify handlers
742 void notifyError(const camera3_error_msg_t &msg,
743 NotificationListener *listener);
744 void notifyShutter(const camera3_shutter_msg_t &msg,
745 NotificationListener *listener);
746
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800747 // helper function to return the output buffers to the streams.
748 void returnOutputBuffers(const camera3_stream_buffer_t *outputBuffers,
749 size_t numBuffers, nsecs_t timestamp);
750
751 // Insert the capture result given the pending metadata, result extras,
752 // partial results, and the frame number to the result queue.
753 void sendCaptureResult(CameraMetadata &pendingMetadata,
754 CaptureResultExtras &resultExtras,
Chien-Yu Chen618ff8a2015-03-13 11:27:17 -0700755 CameraMetadata &collectedPartialResult, uint32_t frameNumber,
Chien-Yu Chend196d612015-06-22 19:49:01 -0700756 bool reprocess, const AeTriggerCancelOverride_t &aeTriggerCancelOverride);
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800757
758 /**** Scope for mInFlightLock ****/
759
760 // Remove the in-flight request of the given index from mInFlightMap
761 // if it's no longer needed. It must only be called with mInFlightLock held.
762 void removeInFlightRequestIfReadyLocked(int idx);
763
764 /**** End scope for mInFlightLock ****/
765
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800766 /**
767 * Static callback forwarding methods from HAL to instance
768 */
769 static callbacks_process_capture_result_t sProcessCaptureResult;
770
771 static callbacks_notify_t sNotify;
772
773}; // class Camera3Device
774
775}; // namespace android
776
777#endif