blob: 2026d7ab5e51f6739f79572d4fcdd1da92d80ed0 [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 nsecs_t kShutdownTimeout = 5000000000; // 5 sec
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700157 static const nsecs_t kActiveTimeout = 500000000; // 500 ms
Chien-Yu Chenc96ac8d2015-08-12 16:46:24 -0700158 static const size_t kInFlightWarnLimit = 20;
159 static const size_t kInFlightWarnLimitHighSpeed = 256; // batch size 32 * pipe depth 8
160
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700161 struct RequestTrigger;
Zhijun Hef7da0962014-04-24 13:27:56 -0700162 // minimal jpeg buffer size: 256KB + blob header
163 static const ssize_t kMinJpegBufferSize = 256 * 1024 + sizeof(camera3_jpeg_blob);
Eino-Ville Talvala16a2ada2014-08-27 14:41:33 -0700164 // Constant to use for stream ID when one doesn't exist
165 static const int NO_STREAM = -1;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800166
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700167 // A lock to enforce serialization on the input/configure side
168 // of the public interface.
169 // Only locked by public methods inherited from CameraDeviceBase.
170 // Not locked by methods guarded by mOutputLock, since they may act
171 // concurrently to the input/configure side of the interface.
172 // Must be locked before mLock if both will be locked by a method
173 Mutex mInterfaceLock;
174
175 // The main lock on internal state
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800176 Mutex mLock;
177
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700178 // Camera device ID
179 const int mId;
180
Zhijun He1fa89992015-06-01 15:44:31 -0700181 // Flag indicating is the current active stream configuration is constrained high speed.
182 bool mIsConstrainedHighSpeedConfiguration;
183
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800184 /**** Scope for mLock ****/
185
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800186 camera3_device_t *mHal3Device;
187
188 CameraMetadata mDeviceInfo;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800189
Zhijun Hea1530f12014-09-14 12:44:20 -0700190 CameraMetadata mRequestTemplateCache[CAMERA3_TEMPLATE_COUNT];
191
Zhijun He204e3292014-07-14 17:09:23 -0700192 uint32_t mDeviceVersion;
Yin-Chia Yehcd8fce82014-06-18 10:51:34 -0700193
Chien-Yu Chen618ff8a2015-03-13 11:27:17 -0700194 struct Size {
195 uint32_t width;
196 uint32_t height;
197 Size(uint32_t w = 0, uint32_t h = 0) : width(w), height(h){}
198 };
199 // Map from format to size.
200 Vector<Size> mSupportedOpaqueInputSizes;
201
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700202 enum Status {
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800203 STATUS_ERROR,
204 STATUS_UNINITIALIZED,
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700205 STATUS_UNCONFIGURED,
206 STATUS_CONFIGURED,
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800207 STATUS_ACTIVE
208 } mStatus;
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700209 Vector<Status> mRecentStatusUpdates;
210 Condition mStatusChanged;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800211
Eino-Ville Talvalab2058d12013-04-09 13:49:56 -0700212 // Tracking cause of fatal errors when in STATUS_ERROR
213 String8 mErrorCause;
214
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800215 // Mapping of stream IDs to stream instances
Igor Murashkin2fba5842013-04-22 14:03:54 -0700216 typedef KeyedVector<int, sp<camera3::Camera3OutputStreamInterface> >
217 StreamSet;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800218
219 StreamSet mOutputStreams;
220 sp<camera3::Camera3Stream> mInputStream;
221 int mNextStreamId;
Eino-Ville Talvalaea26c772013-06-11 16:04:06 -0700222 bool mNeedConfig;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800223
Eino-Ville Talvala16a2ada2014-08-27 14:41:33 -0700224 int mDummyStreamId;
225
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700226 // Whether to send state updates upstream
227 // Pause when doing transparent reconfiguration
228 bool mPauseStateNotify;
229
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800230 // Need to hold on to stream references until configure completes.
Igor Murashkin2fba5842013-04-22 14:03:54 -0700231 Vector<sp<camera3::Camera3StreamInterface> > mDeletedStreams;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800232
Zhijun He204e3292014-07-14 17:09:23 -0700233 // Whether the HAL will send partial result
234 bool mUsePartialResult;
235
236 // Number of partial results that will be delivered by the HAL.
237 uint32_t mNumPartialResults;
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700238
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800239 /**** End scope for mLock ****/
240
Chien-Yu Chend196d612015-06-22 19:49:01 -0700241 typedef struct AeTriggerCancelOverride {
242 bool applyAeLock;
243 uint8_t aeLock;
244 bool applyAePrecaptureTrigger;
245 uint8_t aePrecaptureTrigger;
246 } AeTriggerCancelOverride_t;
247
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800248 class CaptureRequest : public LightRefBase<CaptureRequest> {
249 public:
250 CameraMetadata mSettings;
251 sp<camera3::Camera3Stream> mInputStream;
Chien-Yu Chenc2adf482015-05-27 14:27:49 -0700252 camera3_stream_buffer_t mInputBuffer;
Igor Murashkin2fba5842013-04-22 14:03:54 -0700253 Vector<sp<camera3::Camera3OutputStreamInterface> >
254 mOutputStreams;
Jianing Weicb0652e2014-03-12 18:29:36 -0700255 CaptureResultExtras mResultExtras;
Chien-Yu Chend196d612015-06-22 19:49:01 -0700256 // Used to cancel AE precapture trigger for devices doesn't support
257 // CONTROL_AE_PRECAPTURE_TRIGGER_CANCEL
258 AeTriggerCancelOverride_t mAeTriggerCancelOverride;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800259 };
260 typedef List<sp<CaptureRequest> > RequestList;
261
Jianing Wei90e59c92014-03-12 18:29:36 -0700262 status_t checkStatusOkToCaptureLocked();
263
264 status_t convertMetadataListToRequestListLocked(
265 const List<const CameraMetadata> &metadataList,
Jianing Wei2d6bb3f2014-04-11 10:00:31 -0700266 /*out*/
267 RequestList *requestList);
Jianing Wei90e59c92014-03-12 18:29:36 -0700268
Jianing Weicb0652e2014-03-12 18:29:36 -0700269 status_t submitRequestsHelper(const List<const CameraMetadata> &requests, bool repeating,
270 int64_t *lastFrameNumber = NULL);
Jianing Wei90e59c92014-03-12 18:29:36 -0700271
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800272 /**
Igor Murashkin1e479c02013-09-06 16:55:14 -0700273 * Get the last request submitted to the hal by the request thread.
274 *
275 * Takes mLock.
276 */
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700277 virtual CameraMetadata getLatestRequestLocked();
Igor Murashkin1e479c02013-09-06 16:55:14 -0700278
279 /**
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700280 * Pause processing and flush everything, but don't tell the clients.
281 * This is for reconfiguring outputs transparently when according to the
282 * CameraDeviceBase interface we shouldn't need to.
283 * Must be called with mLock and mInterfaceLock both held.
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800284 */
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700285 status_t internalPauseAndWaitLocked();
286
287 /**
288 * Resume work after internalPauseAndWaitLocked()
289 * Must be called with mLock and mInterfaceLock both held.
290 */
291 status_t internalResumeLocked();
292
293 /**
294 * Wait until status tracker tells us we've transitioned to the target state
295 * set, which is either ACTIVE when active==true or IDLE (which is any
296 * non-ACTIVE state) when active==false.
297 *
298 * Needs to be called with mLock and mInterfaceLock held. This means there
299 * can ever only be one waiter at most.
300 *
301 * During the wait mLock is released.
302 *
303 */
304 status_t waitUntilStateThenRelock(bool active, nsecs_t timeout);
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800305
306 /**
Zhijun He69a37482014-03-23 18:44:49 -0700307 * Implementation of waitUntilDrained. On success, will transition to IDLE state.
308 *
309 * Need to be called with mLock and mInterfaceLock held.
310 */
311 status_t waitUntilDrainedLocked();
312
313 /**
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800314 * Do common work for setting up a streaming or single capture request.
315 * On success, will transition to ACTIVE if in IDLE.
316 */
317 sp<CaptureRequest> setUpRequestLocked(const CameraMetadata &request);
318
319 /**
320 * Build a CaptureRequest request from the CameraDeviceBase request
321 * settings.
322 */
323 sp<CaptureRequest> createCaptureRequest(const CameraMetadata &request);
324
325 /**
326 * Take the currently-defined set of streams and configure the HAL to use
327 * them. This is a long-running operation (may be several hundered ms).
328 */
329 status_t configureStreamsLocked();
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800330
Eino-Ville Talvalab2058d12013-04-09 13:49:56 -0700331 /**
Eino-Ville Talvala16a2ada2014-08-27 14:41:33 -0700332 * Add a dummy stream to the current stream set as a workaround for
333 * not allowing 0 streams in the camera HAL spec.
334 */
335 status_t addDummyStreamLocked();
336
337 /**
338 * Remove a dummy stream if the current config includes real streams.
339 */
340 status_t tryRemoveDummyStreamLocked();
341
342 /**
Eino-Ville Talvalab2058d12013-04-09 13:49:56 -0700343 * Set device into an error state due to some fatal failure, and set an
344 * error message to indicate why. Only the first call's message will be
345 * used. The message is also sent to the log.
346 */
347 void setErrorState(const char *fmt, ...);
348 void setErrorStateV(const char *fmt, va_list args);
349 void setErrorStateLocked(const char *fmt, ...);
350 void setErrorStateLockedV(const char *fmt, va_list args);
351
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700352 /**
353 * Debugging trylock/spin method
354 * Try to acquire a lock a few times with sleeps between before giving up.
355 */
356 bool tryLockSpinRightRound(Mutex& lock);
357
Chien-Yu Chen618ff8a2015-03-13 11:27:17 -0700358 /**
359 * Helper function to determine if an input size for implementation defined
360 * format is supported.
361 */
362 bool isOpaqueInputSizeSupported(uint32_t width, uint32_t height);
Yin-Chia Yehcd8fce82014-06-18 10:51:34 -0700363
364 /**
365 * Helper function to get the largest Jpeg resolution (in area)
366 * Return Size(0, 0) if static metatdata is invalid
367 */
368 Size getMaxJpegResolution() const;
369
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700370 struct RequestTrigger {
371 // Metadata tag number, e.g. android.control.aePrecaptureTrigger
372 uint32_t metadataTag;
373 // Metadata value, e.g. 'START' or the trigger ID
374 int32_t entryValue;
375
376 // The last part of the fully qualified path, e.g. afTrigger
377 const char *getTagName() const {
378 return get_camera_metadata_tag_name(metadataTag) ?: "NULL";
379 }
380
381 // e.g. TYPE_BYTE, TYPE_INT32, etc.
382 int getTagType() const {
383 return get_camera_metadata_tag_type(metadataTag);
384 }
385 };
386
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800387 /**
388 * Thread for managing capture request submission to HAL device.
389 */
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800390 class RequestThread : public Thread {
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800391
392 public:
393
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800394 RequestThread(wp<Camera3Device> parent,
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700395 sp<camera3::StatusTracker> statusTracker,
Chien-Yu Chenab5135b2015-06-30 11:20:58 -0700396 camera3_device_t *hal3Device,
397 bool aeLockAvailable);
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800398
Eino-Ville Talvala4d44cad2015-04-11 13:15:45 -0700399 void setNotificationListener(NotificationListener *listener);
Eino-Ville Talvala17543512014-08-06 14:32:02 -0700400
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800401 /**
402 * Call after stream (re)-configuration is completed.
403 */
404 void configurationComplete();
405
406 /**
407 * Set or clear the list of repeating requests. Does not block
408 * on either. Use waitUntilPaused to wait until request queue
409 * has emptied out.
410 */
Jianing Wei2d6bb3f2014-04-11 10:00:31 -0700411 status_t setRepeatingRequests(const RequestList& requests,
412 /*out*/
413 int64_t *lastFrameNumber = NULL);
414 status_t clearRepeatingRequests(/*out*/
415 int64_t *lastFrameNumber = NULL);
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800416
Jianing Wei2d6bb3f2014-04-11 10:00:31 -0700417 status_t queueRequestList(List<sp<CaptureRequest> > &requests,
418 /*out*/
419 int64_t *lastFrameNumber = NULL);
Jianing Wei90e59c92014-03-12 18:29:36 -0700420
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800421 /**
Eino-Ville Talvalaabaa51d2013-08-14 11:37:00 -0700422 * Remove all queued and repeating requests, and pending triggers
423 */
Eino-Ville Talvala17543512014-08-06 14:32:02 -0700424 status_t clear(NotificationListener *listener,
425 /*out*/
Jianing Wei2d6bb3f2014-04-11 10:00:31 -0700426 int64_t *lastFrameNumber = NULL);
Eino-Ville Talvalaabaa51d2013-08-14 11:37:00 -0700427
428 /**
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700429 * Queue a trigger to be dispatched with the next outgoing
430 * process_capture_request. The settings for that request only
431 * will be temporarily rewritten to add the trigger tag/value.
432 * Subsequent requests will not be rewritten (for this tag).
433 */
434 status_t queueTrigger(RequestTrigger trigger[], size_t count);
435
436 /**
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800437 * Pause/unpause the capture thread. Doesn't block, so use
438 * waitUntilPaused to wait until the thread is paused.
439 */
440 void setPaused(bool paused);
441
442 /**
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700443 * Wait until thread processes the capture request with settings'
444 * android.request.id == requestId.
445 *
446 * Returns TIMED_OUT in case the thread does not process the request
447 * within the timeout.
448 */
449 status_t waitUntilRequestProcessed(int32_t requestId, nsecs_t timeout);
450
Igor Murashkin1e479c02013-09-06 16:55:14 -0700451 /**
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700452 * Shut down the thread. Shutdown is asynchronous, so thread may
453 * still be running once this method returns.
454 */
455 virtual void requestExit();
456
457 /**
Igor Murashkin1e479c02013-09-06 16:55:14 -0700458 * Get the latest request that was sent to the HAL
459 * with process_capture_request.
460 */
461 CameraMetadata getLatestRequest() const;
462
Eino-Ville Talvala4d44cad2015-04-11 13:15:45 -0700463 /**
464 * Returns true if the stream is a target of any queued or repeating
465 * capture request
466 */
467 bool isStreamPending(sp<camera3::Camera3StreamInterface>& stream);
468
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800469 protected:
470
471 virtual bool threadLoop();
472
473 private:
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700474 static int getId(const wp<Camera3Device> &device);
475
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700476 status_t queueTriggerLocked(RequestTrigger trigger);
477 // Mix-in queued triggers into this request
478 int32_t insertTriggers(const sp<CaptureRequest> &request);
479 // Purge the queued triggers from this request,
480 // restoring the old field values for those tags.
481 status_t removeTriggers(const sp<CaptureRequest> &request);
482
Eino-Ville Talvala2f876f92013-09-13 11:39:24 -0700483 // HAL workaround: Make sure a trigger ID always exists if
484 // a trigger does
485 status_t addDummyTriggerIds(const sp<CaptureRequest> &request);
486
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800487 static const nsecs_t kRequestTimeout = 50e6; // 50 ms
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800488
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800489 // Waits for a request, or returns NULL if times out.
490 sp<CaptureRequest> waitForNextRequest();
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800491
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800492 // Return buffers, etc, for a request that couldn't be fully
493 // constructed. The buffers will be returned in the ERROR state
494 // to mark them as not having valid data.
495 // All arguments will be modified.
496 void cleanUpFailedRequest(camera3_capture_request_t &request,
497 sp<CaptureRequest> &nextRequest,
498 Vector<camera3_stream_buffer_t> &outputBuffers);
499
500 // Pause handling
501 bool waitIfPaused();
Eino-Ville Talvala26fe6c72013-08-29 12:46:18 -0700502 void unpauseForNewRequests();
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800503
Eino-Ville Talvalab2058d12013-04-09 13:49:56 -0700504 // Relay error to parent device object setErrorState
505 void setErrorState(const char *fmt, ...);
506
Yin-Chia Yeh8684b7f2014-06-13 14:53:05 -0700507 // If the input request is in mRepeatingRequests. Must be called with mRequestLock hold
508 bool isRepeatingRequestLocked(const sp<CaptureRequest>);
509
Chien-Yu Chend196d612015-06-22 19:49:01 -0700510 // Handle AE precapture trigger cancel for devices <= CAMERA_DEVICE_API_VERSION_3_2.
511 void handleAePrecaptureCancelRequest(sp<CaptureRequest> request);
512
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800513 wp<Camera3Device> mParent;
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700514 wp<camera3::StatusTracker> mStatusTracker;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800515 camera3_device_t *mHal3Device;
516
Eino-Ville Talvala17543512014-08-06 14:32:02 -0700517 NotificationListener *mListener;
518
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700519 const int mId; // The camera ID
520 int mStatusId; // The RequestThread's component ID for
521 // status tracking
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700522
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800523 Mutex mRequestLock;
524 Condition mRequestSignal;
525 RequestList mRequestQueue;
526 RequestList mRepeatingRequests;
Eino-Ville Talvalae74c2282015-05-27 14:46:23 -0700527 // The next request being prepped for submission to the HAL, no longer
528 // on the request queue. Read-only even with mRequestLock held, outside
529 // of threadLoop
530 sp<const CaptureRequest> mNextRequest;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800531
532 bool mReconfigured;
533
534 // Used by waitIfPaused, waitForNextRequest, and waitUntilPaused
535 Mutex mPauseLock;
536 bool mDoPause;
537 Condition mDoPauseSignal;
538 bool mPaused;
539 Condition mPausedSignal;
540
541 sp<CaptureRequest> mPrevRequest;
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700542 int32_t mPrevTriggers;
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800543
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700544 uint32_t mFrameNumber;
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700545
Igor Murashkin1e479c02013-09-06 16:55:14 -0700546 mutable Mutex mLatestRequestMutex;
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700547 Condition mLatestRequestSignal;
548 // android.request.id for latest process_capture_request
549 int32_t mLatestRequestId;
Igor Murashkin1e479c02013-09-06 16:55:14 -0700550 CameraMetadata mLatestRequest;
Igor Murashkin4d2f2e82013-04-01 17:29:07 -0700551
552 typedef KeyedVector<uint32_t/*tag*/, RequestTrigger> TriggerMap;
553 Mutex mTriggerMutex;
554 TriggerMap mTriggerMap;
555 TriggerMap mTriggerRemovedMap;
556 TriggerMap mTriggerReplacedMap;
Yin-Chia Yehc00a25c2014-08-21 14:27:44 -0700557 uint32_t mCurrentAfTriggerId;
558 uint32_t mCurrentPreCaptureTriggerId;
Jianing Weicb0652e2014-03-12 18:29:36 -0700559
Jianing Wei2d6bb3f2014-04-11 10:00:31 -0700560 int64_t mRepeatingLastFrameNumber;
Chien-Yu Chend196d612015-06-22 19:49:01 -0700561
562 // Whether the device supports AE lock
563 bool mAeLockAvailable;
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800564 };
Eino-Ville Talvalaf76e0272013-02-27 18:02:26 -0800565 sp<RequestThread> mRequestThread;
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800566
567 /**
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700568 * In-flight queue for tracking completion of capture requests.
569 */
570
571 struct InFlightRequest {
572 // Set by notify() SHUTTER call.
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800573 nsecs_t shutterTimestamp;
574 // Set by process_capture_result().
575 nsecs_t sensorTimestamp;
Zhijun He1d1f8462013-10-02 16:29:51 -0700576 int requestStatus;
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700577 // Set by process_capture_result call with valid metadata
578 bool haveResultMetadata;
579 // Decremented by calls to process_capture_result with valid output
Zhijun Hef0d962a2014-06-30 10:24:11 -0700580 // and input buffers
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700581 int numBuffersLeft;
Jianing Weicb0652e2014-03-12 18:29:36 -0700582 CaptureResultExtras resultExtras;
Zhijun Hec98bd8d2014-07-07 12:44:10 -0700583 // If this request has any input buffer
584 bool hasInputBuffer;
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700585
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800586 // The last metadata that framework receives from HAL and
587 // not yet send out because the shutter event hasn't arrived.
588 // It's added by process_capture_result and sent when framework
589 // receives the shutter event.
590 CameraMetadata pendingMetadata;
591
592 // Buffers are added by process_capture_result when output buffers
593 // return from HAL but framework has not yet received the shutter
594 // event. They will be returned to the streams when framework receives
595 // the shutter event.
596 Vector<camera3_stream_buffer_t> pendingOutputBuffers;
597
Chien-Yu Chend196d612015-06-22 19:49:01 -0700598 // Used to cancel AE precapture trigger for devices doesn't support
599 // CONTROL_AE_PRECAPTURE_TRIGGER_CANCEL
600 AeTriggerCancelOverride_t aeTriggerCancelOverride;
601
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800602
Zhijun He204e3292014-07-14 17:09:23 -0700603 // Fields used by the partial result only
604 struct PartialResultInFlight {
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700605 // Set by process_capture_result once 3A has been sent to clients
606 bool haveSent3A;
607 // Result metadata collected so far, when partial results are in use
608 CameraMetadata collectedResult;
609
Zhijun He204e3292014-07-14 17:09:23 -0700610 PartialResultInFlight():
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700611 haveSent3A(false) {
612 }
Zhijun He204e3292014-07-14 17:09:23 -0700613 } partialResult;
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700614
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700615 // Default constructor needed by KeyedVector
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700616 InFlightRequest() :
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800617 shutterTimestamp(0),
618 sensorTimestamp(0),
Zhijun He1d1f8462013-10-02 16:29:51 -0700619 requestStatus(OK),
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700620 haveResultMetadata(false),
Zhijun Hec98bd8d2014-07-07 12:44:10 -0700621 numBuffersLeft(0),
Chien-Yu Chend196d612015-06-22 19:49:01 -0700622 hasInputBuffer(false),
623 aeTriggerCancelOverride({false, 0, false, 0}){
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700624 }
625
Chien-Yu Chend196d612015-06-22 19:49:01 -0700626 InFlightRequest(int numBuffers, CaptureResultExtras extras, bool hasInput,
627 AeTriggerCancelOverride aeTriggerCancelOverride) :
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800628 shutterTimestamp(0),
629 sensorTimestamp(0),
Jianing Weicb0652e2014-03-12 18:29:36 -0700630 requestStatus(OK),
631 haveResultMetadata(false),
632 numBuffersLeft(numBuffers),
Zhijun Hec98bd8d2014-07-07 12:44:10 -0700633 resultExtras(extras),
Chien-Yu Chend196d612015-06-22 19:49:01 -0700634 hasInputBuffer(hasInput),
635 aeTriggerCancelOverride(aeTriggerCancelOverride){
Zhijun Hec98bd8d2014-07-07 12:44:10 -0700636 }
Eino-Ville Talvala4d44cad2015-04-11 13:15:45 -0700637 };
638
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700639 // Map from frame number to the in-flight request state
640 typedef KeyedVector<uint32_t, InFlightRequest> InFlightMap;
641
642 Mutex mInFlightLock; // Protects mInFlightMap
643 InFlightMap mInFlightMap;
644
Jianing Weicb0652e2014-03-12 18:29:36 -0700645 status_t registerInFlight(uint32_t frameNumber,
Chien-Yu Chend196d612015-06-22 19:49:01 -0700646 int32_t numBuffers, CaptureResultExtras resultExtras, bool hasInput,
647 const AeTriggerCancelOverride_t &aeTriggerCancelOverride);
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700648
649 /**
Zhijun He204e3292014-07-14 17:09:23 -0700650 * For the partial result, check if all 3A state fields are available
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700651 * and if so, queue up 3A-only result to the client. Returns true if 3A
652 * is sent.
653 */
Zhijun He204e3292014-07-14 17:09:23 -0700654 bool processPartial3AResult(uint32_t frameNumber,
Jianing Weicb0652e2014-03-12 18:29:36 -0700655 const CameraMetadata& partial, const CaptureResultExtras& resultExtras);
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700656
657 // Helpers for reading and writing 3A metadata into to/from partial results
658 template<typename T>
659 bool get3AResult(const CameraMetadata& result, int32_t tag,
Jianing Weicb0652e2014-03-12 18:29:36 -0700660 T* value, uint32_t frameNumber);
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700661
662 template<typename T>
663 bool insert3AResult(CameraMetadata &result, int32_t tag, const T* value,
Jianing Weicb0652e2014-03-12 18:29:36 -0700664 uint32_t frameNumber);
Chien-Yu Chend196d612015-06-22 19:49:01 -0700665
666 /**
667 * Override result metadata for cancelling AE precapture trigger applied in
668 * handleAePrecaptureCancelRequest().
669 */
670 void overrideResultForPrecaptureCancel(CameraMetadata* result,
671 const AeTriggerCancelOverride_t &aeTriggerCancelOverride);
672
Eino-Ville Talvalafd6ecdd2013-10-11 09:51:09 -0700673 /**
Eino-Ville Talvalaf1e98d82013-09-06 09:32:43 -0700674 * Tracking for idle detection
675 */
676 sp<camera3::StatusTracker> mStatusTracker;
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700677
678 /**
Eino-Ville Talvala4d44cad2015-04-11 13:15:45 -0700679 * Thread for preparing streams
680 */
681 class PreparerThread : private Thread, public virtual RefBase {
682 public:
683 PreparerThread();
684 ~PreparerThread();
685
686 void setNotificationListener(NotificationListener *listener);
687
688 /**
689 * Queue up a stream to be prepared. Streams are processed by
690 * a background thread in FIFO order
691 */
692 status_t prepare(sp<camera3::Camera3StreamInterface>& stream);
693
694 /**
695 * Cancel all current and pending stream preparation
696 */
697 status_t clear();
698
699 private:
700 Mutex mLock;
701
702 virtual bool threadLoop();
703
704 // Guarded by mLock
705
706 NotificationListener *mListener;
707 List<sp<camera3::Camera3StreamInterface> > mPendingStreams;
708 bool mActive;
709 bool mCancelNow;
710
711 // Only accessed by threadLoop and the destructor
712
713 sp<camera3::Camera3StreamInterface> mCurrentStream;
714 };
715 sp<PreparerThread> mPreparerThread;
716
717 /**
Eino-Ville Talvala7d346fa2013-03-11 14:13:50 -0700718 * Output result queue and current HAL device 3A state
719 */
720
721 // Lock for output side of device
722 Mutex mOutputLock;
723
724 /**** Scope for mOutputLock ****/
Chien-Yu Chen618ff8a2015-03-13 11:27:17 -0700725 // the minimal frame number of the next non-reprocess result
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700726 uint32_t mNextResultFrameNumber;
Chien-Yu Chen618ff8a2015-03-13 11:27:17 -0700727 // the minimal frame number of the next reprocess result
728 uint32_t mNextReprocessResultFrameNumber;
Eino-Ville Talvala42368d92013-04-09 14:13:50 -0700729 uint32_t mNextShutterFrameNumber;
Jianing Weicb0652e2014-03-12 18:29:36 -0700730 List<CaptureResult> mResultQueue;
Eino-Ville Talvala7d346fa2013-03-11 14:13:50 -0700731 Condition mResultSignal;
732 NotificationListener *mListener;
733
Eino-Ville Talvala7d346fa2013-03-11 14:13:50 -0700734 /**** End scope for mOutputLock ****/
735
736 /**
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800737 * Callback functions from HAL device
738 */
739 void processCaptureResult(const camera3_capture_result *result);
740
741 void notify(const camera3_notify_msg *msg);
742
Eino-Ville Talvala17543512014-08-06 14:32:02 -0700743 // Specific notify handlers
744 void notifyError(const camera3_error_msg_t &msg,
745 NotificationListener *listener);
746 void notifyShutter(const camera3_shutter_msg_t &msg,
747 NotificationListener *listener);
748
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800749 // helper function to return the output buffers to the streams.
750 void returnOutputBuffers(const camera3_stream_buffer_t *outputBuffers,
751 size_t numBuffers, nsecs_t timestamp);
752
753 // Insert the capture result given the pending metadata, result extras,
754 // partial results, and the frame number to the result queue.
755 void sendCaptureResult(CameraMetadata &pendingMetadata,
756 CaptureResultExtras &resultExtras,
Chien-Yu Chen618ff8a2015-03-13 11:27:17 -0700757 CameraMetadata &collectedPartialResult, uint32_t frameNumber,
Chien-Yu Chend196d612015-06-22 19:49:01 -0700758 bool reprocess, const AeTriggerCancelOverride_t &aeTriggerCancelOverride);
Chien-Yu Chen43e69a62014-11-25 16:38:33 -0800759
760 /**** Scope for mInFlightLock ****/
761
762 // Remove the in-flight request of the given index from mInFlightMap
763 // if it's no longer needed. It must only be called with mInFlightLock held.
764 void removeInFlightRequestIfReadyLocked(int idx);
765
766 /**** End scope for mInFlightLock ****/
767
Eino-Ville Talvala7fa43f32013-02-06 17:20:07 -0800768 /**
769 * Static callback forwarding methods from HAL to instance
770 */
771 static callbacks_process_capture_result_t sProcessCaptureResult;
772
773 static callbacks_notify_t sNotify;
774
775}; // class Camera3Device
776
777}; // namespace android
778
779#endif