blob: 31b6132fcf82accd7ce040b3afb43ff320ea2a76 [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
Zhijun He204e3292014-07-14 17:09:23 -0700144 virtual uint32_t getDeviceVersion();
145
Zhijun He28c9b6f2014-08-08 12:00:47 -0700146 virtual ssize_t getJpegBufferSize(uint32_t width, uint32_t height) const;
147
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700148 // Methods called by subclasses
149 void notifyStatus(bool idle); // updates from StatusTracker
150
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800151 private:
Igor Murashkin1e479c02013-09-06 16:55:14 -0700152 static const size_t kDumpLockAttempts = 10;
153 static const size_t kDumpSleepDuration = 100000; // 0.10 sec
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700154 static const size_t kInFlightWarnLimit = 20;
155 static const nsecs_t kShutdownTimeout = 5000000000; // 5 sec
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700156 static const nsecs_t kActiveTimeout = 500000000; // 500 ms
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700157 struct RequestTrigger;
Zhijun Hef7da0962014-04-24 13:27:56 -0700158 // minimal jpeg buffer size: 256KB + blob header
159 static const ssize_t kMinJpegBufferSize = 256 * 1024 + sizeof(camera3_jpeg_blob);
Eino-Ville Talvala16a2ada2014-08-27 14:41:33 -0700160 // Constant to use for stream ID when one doesn't exist
161 static const int NO_STREAM = -1;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800162
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700163 // A lock to enforce serialization on the input/configure side
164 // of the public interface.
165 // Only locked by public methods inherited from CameraDeviceBase.
166 // Not locked by methods guarded by mOutputLock, since they may act
167 // concurrently to the input/configure side of the interface.
168 // Must be locked before mLock if both will be locked by a method
169 Mutex mInterfaceLock;
170
171 // The main lock on internal state
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800172 Mutex mLock;
173
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700174 // Camera device ID
175 const int mId;
176
Zhijun He1fa89992015-06-01 15:44:31 -0700177 // Flag indicating is the current active stream configuration is constrained high speed.
178 bool mIsConstrainedHighSpeedConfiguration;
179
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800180 /**** Scope for mLock ****/
181
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800182 camera3_device_t *mHal3Device;
183
184 CameraMetadata mDeviceInfo;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800185
Zhijun Hea1530f12014-09-14 12:44:20 -0700186 CameraMetadata mRequestTemplateCache[CAMERA3_TEMPLATE_COUNT];
187
Zhijun He204e3292014-07-14 17:09:23 -0700188 uint32_t mDeviceVersion;
Yin-Chia Yehcd8fce82014-06-18 10:51:34 -0700189
Chien-Yu Chen618ff8a2015-03-13 11:27:17 -0700190 struct Size {
191 uint32_t width;
192 uint32_t height;
193 Size(uint32_t w = 0, uint32_t h = 0) : width(w), height(h){}
194 };
195 // Map from format to size.
196 Vector<Size> mSupportedOpaqueInputSizes;
197
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700198 enum Status {
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800199 STATUS_ERROR,
200 STATUS_UNINITIALIZED,
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700201 STATUS_UNCONFIGURED,
202 STATUS_CONFIGURED,
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800203 STATUS_ACTIVE
204 } mStatus;
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700205 Vector<Status> mRecentStatusUpdates;
206 Condition mStatusChanged;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800207
Eino-Ville Talvalab2058d12013-04-09 13:49:56 -0700208 // Tracking cause of fatal errors when in STATUS_ERROR
209 String8 mErrorCause;
210
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800211 // Mapping of stream IDs to stream instances
Igor Murashkin2fba5842013-04-22 14:03:54 -0700212 typedef KeyedVector<int, sp<camera3::Camera3OutputStreamInterface> >
213 StreamSet;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800214
215 StreamSet mOutputStreams;
216 sp<camera3::Camera3Stream> mInputStream;
217 int mNextStreamId;
Eino-Ville Talvalaea26c772013-06-11 16:04:06 -0700218 bool mNeedConfig;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800219
Eino-Ville Talvala16a2ada2014-08-27 14:41:33 -0700220 int mDummyStreamId;
221
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700222 // Whether to send state updates upstream
223 // Pause when doing transparent reconfiguration
224 bool mPauseStateNotify;
225
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800226 // Need to hold on to stream references until configure completes.
Igor Murashkin2fba5842013-04-22 14:03:54 -0700227 Vector<sp<camera3::Camera3StreamInterface> > mDeletedStreams;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800228
Zhijun He204e3292014-07-14 17:09:23 -0700229 // Whether the HAL will send partial result
230 bool mUsePartialResult;
231
232 // Number of partial results that will be delivered by the HAL.
233 uint32_t mNumPartialResults;
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700234
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800235 /**** End scope for mLock ****/
236
Chien-Yu Chend196d612015-06-22 19:49:01 -0700237 typedef struct AeTriggerCancelOverride {
238 bool applyAeLock;
239 uint8_t aeLock;
240 bool applyAePrecaptureTrigger;
241 uint8_t aePrecaptureTrigger;
242 } AeTriggerCancelOverride_t;
243
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800244 class CaptureRequest : public LightRefBase<CaptureRequest> {
245 public:
246 CameraMetadata mSettings;
247 sp<camera3::Camera3Stream> mInputStream;
Chien-Yu Chenc2adf482015-05-27 14:27:49 -0700248 camera3_stream_buffer_t mInputBuffer;
Igor Murashkin2fba5842013-04-22 14:03:54 -0700249 Vector<sp<camera3::Camera3OutputStreamInterface> >
250 mOutputStreams;
Jianing Weicb0652e2014-03-12 18:29:36 -0700251 CaptureResultExtras mResultExtras;
Chien-Yu Chend196d612015-06-22 19:49:01 -0700252 // Used to cancel AE precapture trigger for devices doesn't support
253 // CONTROL_AE_PRECAPTURE_TRIGGER_CANCEL
254 AeTriggerCancelOverride_t mAeTriggerCancelOverride;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800255 };
256 typedef List<sp<CaptureRequest> > RequestList;
257
Jianing Wei90e59c92014-03-12 18:29:36 -0700258 status_t checkStatusOkToCaptureLocked();
259
260 status_t convertMetadataListToRequestListLocked(
261 const List<const CameraMetadata> &metadataList,
Jianing Wei2d6bb3f2014-04-11 10:00:31 -0700262 /*out*/
263 RequestList *requestList);
Jianing Wei90e59c92014-03-12 18:29:36 -0700264
Jianing Weicb0652e2014-03-12 18:29:36 -0700265 status_t submitRequestsHelper(const List<const CameraMetadata> &requests, bool repeating,
266 int64_t *lastFrameNumber = NULL);
Jianing Wei90e59c92014-03-12 18:29:36 -0700267
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800268 /**
Igor Murashkin1e479c02013-09-06 16:55:14 -0700269 * Get the last request submitted to the hal by the request thread.
270 *
271 * Takes mLock.
272 */
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700273 virtual CameraMetadata getLatestRequestLocked();
Igor Murashkin1e479c02013-09-06 16:55:14 -0700274
275 /**
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700276 * Pause processing and flush everything, but don't tell the clients.
277 * This is for reconfiguring outputs transparently when according to the
278 * CameraDeviceBase interface we shouldn't need to.
279 * Must be called with mLock and mInterfaceLock both held.
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800280 */
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700281 status_t internalPauseAndWaitLocked();
282
283 /**
284 * Resume work after internalPauseAndWaitLocked()
285 * Must be called with mLock and mInterfaceLock both held.
286 */
287 status_t internalResumeLocked();
288
289 /**
290 * Wait until status tracker tells us we've transitioned to the target state
291 * set, which is either ACTIVE when active==true or IDLE (which is any
292 * non-ACTIVE state) when active==false.
293 *
294 * Needs to be called with mLock and mInterfaceLock held. This means there
295 * can ever only be one waiter at most.
296 *
297 * During the wait mLock is released.
298 *
299 */
300 status_t waitUntilStateThenRelock(bool active, nsecs_t timeout);
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800301
302 /**
Zhijun He69a37482014-03-23 18:44:49 -0700303 * Implementation of waitUntilDrained. On success, will transition to IDLE state.
304 *
305 * Need to be called with mLock and mInterfaceLock held.
306 */
307 status_t waitUntilDrainedLocked();
308
309 /**
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800310 * Do common work for setting up a streaming or single capture request.
311 * On success, will transition to ACTIVE if in IDLE.
312 */
313 sp<CaptureRequest> setUpRequestLocked(const CameraMetadata &request);
314
315 /**
316 * Build a CaptureRequest request from the CameraDeviceBase request
317 * settings.
318 */
319 sp<CaptureRequest> createCaptureRequest(const CameraMetadata &request);
320
321 /**
322 * Take the currently-defined set of streams and configure the HAL to use
323 * them. This is a long-running operation (may be several hundered ms).
324 */
325 status_t configureStreamsLocked();
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800326
Eino-Ville Talvalab2058d12013-04-09 13:49:56 -0700327 /**
Eino-Ville Talvala16a2ada2014-08-27 14:41:33 -0700328 * Add a dummy stream to the current stream set as a workaround for
329 * not allowing 0 streams in the camera HAL spec.
330 */
331 status_t addDummyStreamLocked();
332
333 /**
334 * Remove a dummy stream if the current config includes real streams.
335 */
336 status_t tryRemoveDummyStreamLocked();
337
338 /**
Eino-Ville Talvalab2058d12013-04-09 13:49:56 -0700339 * Set device into an error state due to some fatal failure, and set an
340 * error message to indicate why. Only the first call's message will be
341 * used. The message is also sent to the log.
342 */
343 void setErrorState(const char *fmt, ...);
344 void setErrorStateV(const char *fmt, va_list args);
345 void setErrorStateLocked(const char *fmt, ...);
346 void setErrorStateLockedV(const char *fmt, va_list args);
347
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700348 /**
349 * Debugging trylock/spin method
350 * Try to acquire a lock a few times with sleeps between before giving up.
351 */
352 bool tryLockSpinRightRound(Mutex& lock);
353
Chien-Yu Chen618ff8a2015-03-13 11:27:17 -0700354 /**
355 * Helper function to determine if an input size for implementation defined
356 * format is supported.
357 */
358 bool isOpaqueInputSizeSupported(uint32_t width, uint32_t height);
Yin-Chia Yehcd8fce82014-06-18 10:51:34 -0700359
360 /**
361 * Helper function to get the largest Jpeg resolution (in area)
362 * Return Size(0, 0) if static metatdata is invalid
363 */
364 Size getMaxJpegResolution() const;
365
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700366 struct RequestTrigger {
367 // Metadata tag number, e.g. android.control.aePrecaptureTrigger
368 uint32_t metadataTag;
369 // Metadata value, e.g. 'START' or the trigger ID
370 int32_t entryValue;
371
372 // The last part of the fully qualified path, e.g. afTrigger
373 const char *getTagName() const {
374 return get_camera_metadata_tag_name(metadataTag) ?: "NULL";
375 }
376
377 // e.g. TYPE_BYTE, TYPE_INT32, etc.
378 int getTagType() const {
379 return get_camera_metadata_tag_type(metadataTag);
380 }
381 };
382
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800383 /**
384 * Thread for managing capture request submission to HAL device.
385 */
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800386 class RequestThread : public Thread {
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800387
388 public:
389
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800390 RequestThread(wp<Camera3Device> parent,
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700391 sp<camera3::StatusTracker> statusTracker,
Chien-Yu Chenab5135b2015-06-30 11:20:58 -0700392 camera3_device_t *hal3Device,
393 bool aeLockAvailable);
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800394
Eino-Ville Talvala4d44cad2015-04-11 13:15:45 -0700395 void setNotificationListener(NotificationListener *listener);
Eino-Ville Talvala17543512014-08-06 14:32:02 -0700396
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800397 /**
398 * Call after stream (re)-configuration is completed.
399 */
400 void configurationComplete();
401
402 /**
403 * Set or clear the list of repeating requests. Does not block
404 * on either. Use waitUntilPaused to wait until request queue
405 * has emptied out.
406 */
Jianing Wei2d6bb3f2014-04-11 10:00:31 -0700407 status_t setRepeatingRequests(const RequestList& requests,
408 /*out*/
409 int64_t *lastFrameNumber = NULL);
410 status_t clearRepeatingRequests(/*out*/
411 int64_t *lastFrameNumber = NULL);
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800412
Jianing Wei2d6bb3f2014-04-11 10:00:31 -0700413 status_t queueRequestList(List<sp<CaptureRequest> > &requests,
414 /*out*/
415 int64_t *lastFrameNumber = NULL);
Jianing Wei90e59c92014-03-12 18:29:36 -0700416
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800417 /**
Eino-Ville Talvalaabaa51d2013-08-14 11:37:00 -0700418 * Remove all queued and repeating requests, and pending triggers
419 */
Eino-Ville Talvala17543512014-08-06 14:32:02 -0700420 status_t clear(NotificationListener *listener,
421 /*out*/
Jianing Wei2d6bb3f2014-04-11 10:00:31 -0700422 int64_t *lastFrameNumber = NULL);
Eino-Ville Talvalaabaa51d2013-08-14 11:37:00 -0700423
424 /**
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700425 * Queue a trigger to be dispatched with the next outgoing
426 * process_capture_request. The settings for that request only
427 * will be temporarily rewritten to add the trigger tag/value.
428 * Subsequent requests will not be rewritten (for this tag).
429 */
430 status_t queueTrigger(RequestTrigger trigger[], size_t count);
431
432 /**
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800433 * Pause/unpause the capture thread. Doesn't block, so use
434 * waitUntilPaused to wait until the thread is paused.
435 */
436 void setPaused(bool paused);
437
438 /**
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700439 * Wait until thread processes the capture request with settings'
440 * android.request.id == requestId.
441 *
442 * Returns TIMED_OUT in case the thread does not process the request
443 * within the timeout.
444 */
445 status_t waitUntilRequestProcessed(int32_t requestId, nsecs_t timeout);
446
Igor Murashkin1e479c02013-09-06 16:55:14 -0700447 /**
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700448 * Shut down the thread. Shutdown is asynchronous, so thread may
449 * still be running once this method returns.
450 */
451 virtual void requestExit();
452
453 /**
Igor Murashkin1e479c02013-09-06 16:55:14 -0700454 * Get the latest request that was sent to the HAL
455 * with process_capture_request.
456 */
457 CameraMetadata getLatestRequest() const;
458
Eino-Ville Talvala4d44cad2015-04-11 13:15:45 -0700459 /**
460 * Returns true if the stream is a target of any queued or repeating
461 * capture request
462 */
463 bool isStreamPending(sp<camera3::Camera3StreamInterface>& stream);
464
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800465 protected:
466
467 virtual bool threadLoop();
468
469 private:
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700470 static int getId(const wp<Camera3Device> &device);
471
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700472 status_t queueTriggerLocked(RequestTrigger trigger);
473 // Mix-in queued triggers into this request
474 int32_t insertTriggers(const sp<CaptureRequest> &request);
475 // Purge the queued triggers from this request,
476 // restoring the old field values for those tags.
477 status_t removeTriggers(const sp<CaptureRequest> &request);
478
Eino-Ville Talvala2f876f92013-09-13 11:39:24 -0700479 // HAL workaround: Make sure a trigger ID always exists if
480 // a trigger does
481 status_t addDummyTriggerIds(const sp<CaptureRequest> &request);
482
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800483 static const nsecs_t kRequestTimeout = 50e6; // 50 ms
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800484
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800485 // Waits for a request, or returns NULL if times out.
486 sp<CaptureRequest> waitForNextRequest();
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800487
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800488 // Return buffers, etc, for a request that couldn't be fully
489 // constructed. The buffers will be returned in the ERROR state
490 // to mark them as not having valid data.
491 // All arguments will be modified.
492 void cleanUpFailedRequest(camera3_capture_request_t &request,
493 sp<CaptureRequest> &nextRequest,
494 Vector<camera3_stream_buffer_t> &outputBuffers);
495
496 // Pause handling
497 bool waitIfPaused();
Eino-Ville Talvala26fe6c72013-08-29 12:46:18 -0700498 void unpauseForNewRequests();
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800499
Eino-Ville Talvalab2058d12013-04-09 13:49:56 -0700500 // Relay error to parent device object setErrorState
501 void setErrorState(const char *fmt, ...);
502
Yin-Chia Yeh8684b7f2014-06-13 14:53:05 -0700503 // If the input request is in mRepeatingRequests. Must be called with mRequestLock hold
504 bool isRepeatingRequestLocked(const sp<CaptureRequest>);
505
Chien-Yu Chend196d612015-06-22 19:49:01 -0700506 // Handle AE precapture trigger cancel for devices <= CAMERA_DEVICE_API_VERSION_3_2.
507 void handleAePrecaptureCancelRequest(sp<CaptureRequest> request);
508
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800509 wp<Camera3Device> mParent;
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700510 wp<camera3::StatusTracker> mStatusTracker;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800511 camera3_device_t *mHal3Device;
512
Eino-Ville Talvala17543512014-08-06 14:32:02 -0700513 NotificationListener *mListener;
514
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700515 const int mId; // The camera ID
516 int mStatusId; // The RequestThread's component ID for
517 // status tracking
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700518
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800519 Mutex mRequestLock;
520 Condition mRequestSignal;
521 RequestList mRequestQueue;
522 RequestList mRepeatingRequests;
Eino-Ville Talvalae74c2282015-05-27 14:46:23 -0700523 // The next request being prepped for submission to the HAL, no longer
524 // on the request queue. Read-only even with mRequestLock held, outside
525 // of threadLoop
526 sp<const CaptureRequest> mNextRequest;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800527
528 bool mReconfigured;
529
530 // Used by waitIfPaused, waitForNextRequest, and waitUntilPaused
531 Mutex mPauseLock;
532 bool mDoPause;
533 Condition mDoPauseSignal;
534 bool mPaused;
535 Condition mPausedSignal;
536
537 sp<CaptureRequest> mPrevRequest;
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700538 int32_t mPrevTriggers;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800539
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700540 uint32_t mFrameNumber;
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700541
Igor Murashkin1e479c02013-09-06 16:55:14 -0700542 mutable Mutex mLatestRequestMutex;
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700543 Condition mLatestRequestSignal;
544 // android.request.id for latest process_capture_request
545 int32_t mLatestRequestId;
Igor Murashkin1e479c02013-09-06 16:55:14 -0700546 CameraMetadata mLatestRequest;
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700547
548 typedef KeyedVector<uint32_t/*tag*/, RequestTrigger> TriggerMap;
549 Mutex mTriggerMutex;
550 TriggerMap mTriggerMap;
551 TriggerMap mTriggerRemovedMap;
552 TriggerMap mTriggerReplacedMap;
Yin-Chia Yehc00a25c2014-08-21 14:27:44 -0700553 uint32_t mCurrentAfTriggerId;
554 uint32_t mCurrentPreCaptureTriggerId;
Jianing Weicb0652e2014-03-12 18:29:36 -0700555
Jianing Wei2d6bb3f2014-04-11 10:00:31 -0700556 int64_t mRepeatingLastFrameNumber;
Chien-Yu Chend196d612015-06-22 19:49:01 -0700557
558 // Whether the device supports AE lock
559 bool mAeLockAvailable;
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800560 };
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800561 sp<RequestThread> mRequestThread;
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800562
563 /**
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700564 * In-flight queue for tracking completion of capture requests.
565 */
566
567 struct InFlightRequest {
568 // Set by notify() SHUTTER call.
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800569 nsecs_t shutterTimestamp;
570 // Set by process_capture_result().
571 nsecs_t sensorTimestamp;
Zhijun He1d1f8462013-10-02 16:29:51 -0700572 int requestStatus;
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700573 // Set by process_capture_result call with valid metadata
574 bool haveResultMetadata;
575 // Decremented by calls to process_capture_result with valid output
Zhijun Hef0d962a2014-06-30 10:24:11 -0700576 // and input buffers
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700577 int numBuffersLeft;
Jianing Weicb0652e2014-03-12 18:29:36 -0700578 CaptureResultExtras resultExtras;
Zhijun Hec98bd8d2014-07-07 12:44:10 -0700579 // If this request has any input buffer
580 bool hasInputBuffer;
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700581
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800582 // The last metadata that framework receives from HAL and
583 // not yet send out because the shutter event hasn't arrived.
584 // It's added by process_capture_result and sent when framework
585 // receives the shutter event.
586 CameraMetadata pendingMetadata;
587
588 // Buffers are added by process_capture_result when output buffers
589 // return from HAL but framework has not yet received the shutter
590 // event. They will be returned to the streams when framework receives
591 // the shutter event.
592 Vector<camera3_stream_buffer_t> pendingOutputBuffers;
593
Chien-Yu Chend196d612015-06-22 19:49:01 -0700594 // Used to cancel AE precapture trigger for devices doesn't support
595 // CONTROL_AE_PRECAPTURE_TRIGGER_CANCEL
596 AeTriggerCancelOverride_t aeTriggerCancelOverride;
597
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800598
Zhijun He204e3292014-07-14 17:09:23 -0700599 // Fields used by the partial result only
600 struct PartialResultInFlight {
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700601 // Set by process_capture_result once 3A has been sent to clients
602 bool haveSent3A;
603 // Result metadata collected so far, when partial results are in use
604 CameraMetadata collectedResult;
605
Zhijun He204e3292014-07-14 17:09:23 -0700606 PartialResultInFlight():
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700607 haveSent3A(false) {
608 }
Zhijun He204e3292014-07-14 17:09:23 -0700609 } partialResult;
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700610
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700611 // Default constructor needed by KeyedVector
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700612 InFlightRequest() :
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800613 shutterTimestamp(0),
614 sensorTimestamp(0),
Zhijun He1d1f8462013-10-02 16:29:51 -0700615 requestStatus(OK),
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700616 haveResultMetadata(false),
Zhijun Hec98bd8d2014-07-07 12:44:10 -0700617 numBuffersLeft(0),
Chien-Yu Chend196d612015-06-22 19:49:01 -0700618 hasInputBuffer(false),
619 aeTriggerCancelOverride({false, 0, false, 0}){
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700620 }
621
Chien-Yu Chend196d612015-06-22 19:49:01 -0700622 InFlightRequest(int numBuffers, CaptureResultExtras extras, bool hasInput,
623 AeTriggerCancelOverride aeTriggerCancelOverride) :
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800624 shutterTimestamp(0),
625 sensorTimestamp(0),
Jianing Weicb0652e2014-03-12 18:29:36 -0700626 requestStatus(OK),
627 haveResultMetadata(false),
628 numBuffersLeft(numBuffers),
Zhijun Hec98bd8d2014-07-07 12:44:10 -0700629 resultExtras(extras),
Chien-Yu Chend196d612015-06-22 19:49:01 -0700630 hasInputBuffer(hasInput),
631 aeTriggerCancelOverride(aeTriggerCancelOverride){
Zhijun Hec98bd8d2014-07-07 12:44:10 -0700632 }
Eino-Ville Talvala4d44cad2015-04-11 13:15:45 -0700633 };
634
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700635 // Map from frame number to the in-flight request state
636 typedef KeyedVector<uint32_t, InFlightRequest> InFlightMap;
637
638 Mutex mInFlightLock; // Protects mInFlightMap
639 InFlightMap mInFlightMap;
640
Jianing Weicb0652e2014-03-12 18:29:36 -0700641 status_t registerInFlight(uint32_t frameNumber,
Chien-Yu Chend196d612015-06-22 19:49:01 -0700642 int32_t numBuffers, CaptureResultExtras resultExtras, bool hasInput,
643 const AeTriggerCancelOverride_t &aeTriggerCancelOverride);
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700644
645 /**
Zhijun He204e3292014-07-14 17:09:23 -0700646 * For the partial result, check if all 3A state fields are available
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700647 * and if so, queue up 3A-only result to the client. Returns true if 3A
648 * is sent.
649 */
Zhijun He204e3292014-07-14 17:09:23 -0700650 bool processPartial3AResult(uint32_t frameNumber,
Jianing Weicb0652e2014-03-12 18:29:36 -0700651 const CameraMetadata& partial, const CaptureResultExtras& resultExtras);
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700652
653 // Helpers for reading and writing 3A metadata into to/from partial results
654 template<typename T>
655 bool get3AResult(const CameraMetadata& result, int32_t tag,
Jianing Weicb0652e2014-03-12 18:29:36 -0700656 T* value, uint32_t frameNumber);
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700657
658 template<typename T>
659 bool insert3AResult(CameraMetadata &result, int32_t tag, const T* value,
Jianing Weicb0652e2014-03-12 18:29:36 -0700660 uint32_t frameNumber);
Chien-Yu Chend196d612015-06-22 19:49:01 -0700661
662 /**
663 * Override result metadata for cancelling AE precapture trigger applied in
664 * handleAePrecaptureCancelRequest().
665 */
666 void overrideResultForPrecaptureCancel(CameraMetadata* result,
667 const AeTriggerCancelOverride_t &aeTriggerCancelOverride);
668
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700669 /**
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700670 * Tracking for idle detection
671 */
672 sp<camera3::StatusTracker> mStatusTracker;
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700673
674 /**
Eino-Ville Talvala4d44cad2015-04-11 13:15:45 -0700675 * Thread for preparing streams
676 */
677 class PreparerThread : private Thread, public virtual RefBase {
678 public:
679 PreparerThread();
680 ~PreparerThread();
681
682 void setNotificationListener(NotificationListener *listener);
683
684 /**
685 * Queue up a stream to be prepared. Streams are processed by
686 * a background thread in FIFO order
687 */
688 status_t prepare(sp<camera3::Camera3StreamInterface>& stream);
689
690 /**
691 * Cancel all current and pending stream preparation
692 */
693 status_t clear();
694
695 private:
696 Mutex mLock;
697
698 virtual bool threadLoop();
699
700 // Guarded by mLock
701
702 NotificationListener *mListener;
703 List<sp<camera3::Camera3StreamInterface> > mPendingStreams;
704 bool mActive;
705 bool mCancelNow;
706
707 // Only accessed by threadLoop and the destructor
708
709 sp<camera3::Camera3StreamInterface> mCurrentStream;
710 };
711 sp<PreparerThread> mPreparerThread;
712
713 /**
Eino-Ville Talvala7d346fa2013-03-11 14:13:50 -0700714 * Output result queue and current HAL device 3A state
715 */
716
717 // Lock for output side of device
718 Mutex mOutputLock;
719
720 /**** Scope for mOutputLock ****/
Chien-Yu Chen618ff8a2015-03-13 11:27:17 -0700721 // the minimal frame number of the next non-reprocess result
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700722 uint32_t mNextResultFrameNumber;
Chien-Yu Chen618ff8a2015-03-13 11:27:17 -0700723 // the minimal frame number of the next reprocess result
724 uint32_t mNextReprocessResultFrameNumber;
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700725 uint32_t mNextShutterFrameNumber;
Jianing Weicb0652e2014-03-12 18:29:36 -0700726 List<CaptureResult> mResultQueue;
Eino-Ville Talvala7d346fa2013-03-11 14:13:50 -0700727 Condition mResultSignal;
728 NotificationListener *mListener;
729
Eino-Ville Talvala7d346fa2013-03-11 14:13:50 -0700730 /**** End scope for mOutputLock ****/
731
732 /**
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800733 * Callback functions from HAL device
734 */
735 void processCaptureResult(const camera3_capture_result *result);
736
737 void notify(const camera3_notify_msg *msg);
738
Eino-Ville Talvala17543512014-08-06 14:32:02 -0700739 // Specific notify handlers
740 void notifyError(const camera3_error_msg_t &msg,
741 NotificationListener *listener);
742 void notifyShutter(const camera3_shutter_msg_t &msg,
743 NotificationListener *listener);
744
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800745 // helper function to return the output buffers to the streams.
746 void returnOutputBuffers(const camera3_stream_buffer_t *outputBuffers,
747 size_t numBuffers, nsecs_t timestamp);
748
749 // Insert the capture result given the pending metadata, result extras,
750 // partial results, and the frame number to the result queue.
751 void sendCaptureResult(CameraMetadata &pendingMetadata,
752 CaptureResultExtras &resultExtras,
Chien-Yu Chen618ff8a2015-03-13 11:27:17 -0700753 CameraMetadata &collectedPartialResult, uint32_t frameNumber,
Chien-Yu Chend196d612015-06-22 19:49:01 -0700754 bool reprocess, const AeTriggerCancelOverride_t &aeTriggerCancelOverride);
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800755
756 /**** Scope for mInFlightLock ****/
757
758 // Remove the in-flight request of the given index from mInFlightMap
759 // if it's no longer needed. It must only be called with mInFlightLock held.
760 void removeInFlightRequestIfReadyLocked(int idx);
761
762 /**** End scope for mInFlightLock ****/
763
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800764 /**
765 * Static callback forwarding methods from HAL to instance
766 */
767 static callbacks_process_capture_result_t sProcessCaptureResult;
768
769 static callbacks_notify_t sNotify;
770
771}; // class Camera3Device
772
773}; // namespace android
774
775#endif