Camera3Device.cpp revision 5b19084a5089e3f6527a82440a1c8227c3a366fa
1/*
2 * Copyright (C) 2013 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#define LOG_TAG "Camera3-Device"
18#define ATRACE_TAG ATRACE_TAG_CAMERA
19//#define LOG_NDEBUG 0
20//#define LOG_NNDEBUG 0  // Per-frame verbose logging
21
22#ifdef LOG_NNDEBUG
23#define ALOGVV(...) ALOGV(__VA_ARGS__)
24#else
25#define ALOGVV(...) ((void)0)
26#endif
27
28// Convenience macro for transient errors
29#define CLOGE(fmt, ...) ALOGE("Camera %d: %s: " fmt, mId, __FUNCTION__, \
30            ##__VA_ARGS__)
31
32// Convenience macros for transitioning to the error state
33#define SET_ERR(fmt, ...) setErrorState(   \
34    "%s: " fmt, __FUNCTION__,              \
35    ##__VA_ARGS__)
36#define SET_ERR_L(fmt, ...) setErrorStateLocked( \
37    "%s: " fmt, __FUNCTION__,                    \
38    ##__VA_ARGS__)
39
40#include <utils/Log.h>
41#include <utils/Trace.h>
42#include <utils/Timers.h>
43
44#include "utils/CameraTraces.h"
45#include "device3/Camera3Device.h"
46#include "device3/Camera3OutputStream.h"
47#include "device3/Camera3InputStream.h"
48#include "device3/Camera3ZslStream.h"
49
50using namespace android::camera3;
51
52namespace android {
53
54Camera3Device::Camera3Device(int id):
55        mId(id),
56        mHal3Device(NULL),
57        mStatus(STATUS_UNINITIALIZED),
58        mUsePartialResultQuirk(false),
59        mNextResultFrameNumber(0),
60        mNextShutterFrameNumber(0),
61        mListener(NULL)
62{
63    ATRACE_CALL();
64    camera3_callback_ops::notify = &sNotify;
65    camera3_callback_ops::process_capture_result = &sProcessCaptureResult;
66    ALOGV("%s: Created device for camera %d", __FUNCTION__, id);
67}
68
69Camera3Device::~Camera3Device()
70{
71    ATRACE_CALL();
72    ALOGV("%s: Tearing down for camera id %d", __FUNCTION__, mId);
73    disconnect();
74}
75
76int Camera3Device::getId() const {
77    return mId;
78}
79
80/**
81 * CameraDeviceBase interface
82 */
83
84status_t Camera3Device::initialize(camera_module_t *module)
85{
86    ATRACE_CALL();
87    Mutex::Autolock il(mInterfaceLock);
88    Mutex::Autolock l(mLock);
89
90    ALOGV("%s: Initializing device for camera %d", __FUNCTION__, mId);
91    if (mStatus != STATUS_UNINITIALIZED) {
92        CLOGE("Already initialized!");
93        return INVALID_OPERATION;
94    }
95
96    /** Open HAL device */
97
98    status_t res;
99    String8 deviceName = String8::format("%d", mId);
100
101    camera3_device_t *device;
102
103    ATRACE_BEGIN("camera3->open");
104    res = module->common.methods->open(&module->common, deviceName.string(),
105            reinterpret_cast<hw_device_t**>(&device));
106    ATRACE_END();
107
108    if (res != OK) {
109        SET_ERR_L("Could not open camera: %s (%d)", strerror(-res), res);
110        return res;
111    }
112
113    /** Cross-check device version */
114
115    if (device->common.version != CAMERA_DEVICE_API_VERSION_3_0) {
116        SET_ERR_L("Could not open camera: "
117                "Camera device is not version %x, reports %x instead",
118                CAMERA_DEVICE_API_VERSION_3_0,
119                device->common.version);
120        device->common.close(&device->common);
121        return BAD_VALUE;
122    }
123
124    camera_info info;
125    res = module->get_camera_info(mId, &info);
126    if (res != OK) return res;
127
128    if (info.device_version != device->common.version) {
129        SET_ERR_L("HAL reporting mismatched camera_info version (%x)"
130                " and device version (%x).",
131                device->common.version, info.device_version);
132        device->common.close(&device->common);
133        return BAD_VALUE;
134    }
135
136    /** Initialize device with callback functions */
137
138    ATRACE_BEGIN("camera3->initialize");
139    res = device->ops->initialize(device, this);
140    ATRACE_END();
141
142    if (res != OK) {
143        SET_ERR_L("Unable to initialize HAL device: %s (%d)",
144                strerror(-res), res);
145        device->common.close(&device->common);
146        return BAD_VALUE;
147    }
148
149    /** Get vendor metadata tags */
150
151    mVendorTagOps.get_camera_vendor_section_name = NULL;
152
153    ATRACE_BEGIN("camera3->get_metadata_vendor_tag_ops");
154    device->ops->get_metadata_vendor_tag_ops(device, &mVendorTagOps);
155    ATRACE_END();
156
157    if (mVendorTagOps.get_camera_vendor_section_name != NULL) {
158        res = set_camera_metadata_vendor_tag_ops(&mVendorTagOps);
159        if (res != OK) {
160            SET_ERR_L("Unable to set tag ops: %s (%d)",
161                    strerror(-res), res);
162            device->common.close(&device->common);
163            return res;
164        }
165    }
166
167    /** Start up status tracker thread */
168    mStatusTracker = new StatusTracker(this);
169    res = mStatusTracker->run(String8::format("C3Dev-%d-Status", mId).string());
170    if (res != OK) {
171        SET_ERR_L("Unable to start status tracking thread: %s (%d)",
172                strerror(-res), res);
173        device->common.close(&device->common);
174        mStatusTracker.clear();
175        return res;
176    }
177
178    /** Start up request queue thread */
179
180    mRequestThread = new RequestThread(this, mStatusTracker, device);
181    res = mRequestThread->run(String8::format("C3Dev-%d-ReqQueue", mId).string());
182    if (res != OK) {
183        SET_ERR_L("Unable to start request queue thread: %s (%d)",
184                strerror(-res), res);
185        device->common.close(&device->common);
186        mRequestThread.clear();
187        return res;
188    }
189
190    /** Everything is good to go */
191
192    mDeviceInfo = info.static_camera_characteristics;
193    mHal3Device = device;
194    mStatus = STATUS_UNCONFIGURED;
195    mNextStreamId = 0;
196    mNeedConfig = true;
197    mPauseStateNotify = false;
198
199    /** Check for quirks */
200
201    // Will the HAL be sending in early partial result metadata?
202    camera_metadata_entry partialResultsQuirk =
203            mDeviceInfo.find(ANDROID_QUIRKS_USE_PARTIAL_RESULT);
204    if (partialResultsQuirk.count > 0 && partialResultsQuirk.data.u8[0] == 1) {
205        mUsePartialResultQuirk = true;
206    }
207
208    return OK;
209}
210
211status_t Camera3Device::disconnect() {
212    ATRACE_CALL();
213    Mutex::Autolock il(mInterfaceLock);
214
215    ALOGV("%s: E", __FUNCTION__);
216
217    status_t res = OK;
218
219    {
220        Mutex::Autolock l(mLock);
221        if (mStatus == STATUS_UNINITIALIZED) return res;
222
223        if (mStatus == STATUS_ACTIVE ||
224                (mStatus == STATUS_ERROR && mRequestThread != NULL)) {
225            res = mRequestThread->clearRepeatingRequests();
226            if (res != OK) {
227                SET_ERR_L("Can't stop streaming");
228                // Continue to close device even in case of error
229            } else {
230                res = waitUntilStateThenRelock(/*active*/ false, kShutdownTimeout);
231                if (res != OK) {
232                    SET_ERR_L("Timeout waiting for HAL to drain");
233                    // Continue to close device even in case of error
234                }
235            }
236        }
237
238        if (mStatus == STATUS_ERROR) {
239            CLOGE("Shutting down in an error state");
240        }
241
242        if (mStatusTracker != NULL) {
243            mStatusTracker->requestExit();
244        }
245
246        if (mRequestThread != NULL) {
247            mRequestThread->requestExit();
248        }
249
250        mOutputStreams.clear();
251        mInputStream.clear();
252    }
253
254    // Joining done without holding mLock, otherwise deadlocks may ensue
255    // as the threads try to access parent state
256    if (mRequestThread != NULL && mStatus != STATUS_ERROR) {
257        // HAL may be in a bad state, so waiting for request thread
258        // (which may be stuck in the HAL processCaptureRequest call)
259        // could be dangerous.
260        mRequestThread->join();
261    }
262
263    if (mStatusTracker != NULL) {
264        mStatusTracker->join();
265    }
266
267    {
268        Mutex::Autolock l(mLock);
269
270        mRequestThread.clear();
271        mStatusTracker.clear();
272
273        if (mHal3Device != NULL) {
274            ATRACE_BEGIN("camera3->close");
275            mHal3Device->common.close(&mHal3Device->common);
276            ATRACE_END();
277            mHal3Device = NULL;
278        }
279
280        mStatus = STATUS_UNINITIALIZED;
281    }
282
283    ALOGV("%s: X", __FUNCTION__);
284    return res;
285}
286
287// For dumping/debugging only -
288// try to acquire a lock a few times, eventually give up to proceed with
289// debug/dump operations
290bool Camera3Device::tryLockSpinRightRound(Mutex& lock) {
291    bool gotLock = false;
292    for (size_t i = 0; i < kDumpLockAttempts; ++i) {
293        if (lock.tryLock() == NO_ERROR) {
294            gotLock = true;
295            break;
296        } else {
297            usleep(kDumpSleepDuration);
298        }
299    }
300    return gotLock;
301}
302
303status_t Camera3Device::dump(int fd, const Vector<String16> &args) {
304    ATRACE_CALL();
305    (void)args;
306
307    // Try to lock, but continue in case of failure (to avoid blocking in
308    // deadlocks)
309    bool gotInterfaceLock = tryLockSpinRightRound(mInterfaceLock);
310    bool gotLock = tryLockSpinRightRound(mLock);
311
312    ALOGW_IF(!gotInterfaceLock,
313            "Camera %d: %s: Unable to lock interface lock, proceeding anyway",
314            mId, __FUNCTION__);
315    ALOGW_IF(!gotLock,
316            "Camera %d: %s: Unable to lock main lock, proceeding anyway",
317            mId, __FUNCTION__);
318
319    String8 lines;
320
321    const char *status =
322            mStatus == STATUS_ERROR         ? "ERROR" :
323            mStatus == STATUS_UNINITIALIZED ? "UNINITIALIZED" :
324            mStatus == STATUS_UNCONFIGURED  ? "UNCONFIGURED" :
325            mStatus == STATUS_CONFIGURED    ? "CONFIGURED" :
326            mStatus == STATUS_ACTIVE        ? "ACTIVE" :
327            "Unknown";
328
329    lines.appendFormat("    Device status: %s\n", status);
330    if (mStatus == STATUS_ERROR) {
331        lines.appendFormat("    Error cause: %s\n", mErrorCause.string());
332    }
333    lines.appendFormat("    Stream configuration:\n");
334
335    if (mInputStream != NULL) {
336        write(fd, lines.string(), lines.size());
337        mInputStream->dump(fd, args);
338    } else {
339        lines.appendFormat("      No input stream.\n");
340        write(fd, lines.string(), lines.size());
341    }
342    for (size_t i = 0; i < mOutputStreams.size(); i++) {
343        mOutputStreams[i]->dump(fd,args);
344    }
345
346    lines = String8("    In-flight requests:\n");
347    if (mInFlightMap.size() == 0) {
348        lines.append("      None\n");
349    } else {
350        for (size_t i = 0; i < mInFlightMap.size(); i++) {
351            InFlightRequest r = mInFlightMap.valueAt(i);
352            lines.appendFormat("      Frame %d |  Timestamp: %lld, metadata"
353                    " arrived: %s, buffers left: %d\n", mInFlightMap.keyAt(i),
354                    r.captureTimestamp, r.haveResultMetadata ? "true" : "false",
355                    r.numBuffersLeft);
356        }
357    }
358    write(fd, lines.string(), lines.size());
359
360    {
361        lines = String8("    Last request sent:\n");
362        write(fd, lines.string(), lines.size());
363
364        CameraMetadata lastRequest = getLatestRequestLocked();
365        lastRequest.dump(fd, /*verbosity*/2, /*indentation*/6);
366    }
367
368    if (mHal3Device != NULL) {
369        lines = String8("    HAL device dump:\n");
370        write(fd, lines.string(), lines.size());
371        mHal3Device->ops->dump(mHal3Device, fd);
372    }
373
374    if (gotLock) mLock.unlock();
375    if (gotInterfaceLock) mInterfaceLock.unlock();
376
377    return OK;
378}
379
380const CameraMetadata& Camera3Device::info() const {
381    ALOGVV("%s: E", __FUNCTION__);
382    if (CC_UNLIKELY(mStatus == STATUS_UNINITIALIZED ||
383                    mStatus == STATUS_ERROR)) {
384        ALOGW("%s: Access to static info %s!", __FUNCTION__,
385                mStatus == STATUS_ERROR ?
386                "when in error state" : "before init");
387    }
388    return mDeviceInfo;
389}
390
391status_t Camera3Device::capture(CameraMetadata &request) {
392    ATRACE_CALL();
393    status_t res;
394    Mutex::Autolock il(mInterfaceLock);
395    Mutex::Autolock l(mLock);
396
397    // TODO: take ownership of the request
398
399    switch (mStatus) {
400        case STATUS_ERROR:
401            CLOGE("Device has encountered a serious error");
402            return INVALID_OPERATION;
403        case STATUS_UNINITIALIZED:
404            CLOGE("Device not initialized");
405            return INVALID_OPERATION;
406        case STATUS_UNCONFIGURED:
407            // May be lazily configuring streams, will check during setup
408        case STATUS_CONFIGURED:
409        case STATUS_ACTIVE:
410            // OK
411            break;
412        default:
413            SET_ERR_L("Unexpected status: %d", mStatus);
414            return INVALID_OPERATION;
415    }
416
417    sp<CaptureRequest> newRequest = setUpRequestLocked(request);
418    if (newRequest == NULL) {
419        CLOGE("Can't create capture request");
420        return BAD_VALUE;
421    }
422
423    res = mRequestThread->queueRequest(newRequest);
424    if (res == OK) {
425        waitUntilStateThenRelock(/*active*/ true, kActiveTimeout);
426        if (res != OK) {
427            SET_ERR_L("Can't transition to active in %f seconds!",
428                    kActiveTimeout/1e9);
429        }
430        ALOGV("Camera %d: Capture request enqueued", mId);
431    }
432    return res;
433}
434
435
436status_t Camera3Device::setStreamingRequest(const CameraMetadata &request) {
437    ATRACE_CALL();
438    status_t res;
439    Mutex::Autolock il(mInterfaceLock);
440    Mutex::Autolock l(mLock);
441
442    switch (mStatus) {
443        case STATUS_ERROR:
444            CLOGE("Device has encountered a serious error");
445            return INVALID_OPERATION;
446        case STATUS_UNINITIALIZED:
447            CLOGE("Device not initialized");
448            return INVALID_OPERATION;
449        case STATUS_UNCONFIGURED:
450            // May be lazily configuring streams, will check during setup
451        case STATUS_CONFIGURED:
452        case STATUS_ACTIVE:
453            // OK
454            break;
455        default:
456            SET_ERR_L("Unexpected status: %d", mStatus);
457            return INVALID_OPERATION;
458    }
459
460    sp<CaptureRequest> newRepeatingRequest = setUpRequestLocked(request);
461    if (newRepeatingRequest == NULL) {
462        CLOGE("Can't create repeating request");
463        return BAD_VALUE;
464    }
465
466    RequestList newRepeatingRequests;
467    newRepeatingRequests.push_back(newRepeatingRequest);
468
469    res = mRequestThread->setRepeatingRequests(newRepeatingRequests);
470    if (res == OK) {
471        waitUntilStateThenRelock(/*active*/ true, kActiveTimeout);
472        if (res != OK) {
473            SET_ERR_L("Can't transition to active in %f seconds!",
474                    kActiveTimeout/1e9);
475        }
476        ALOGV("Camera %d: Repeating request set", mId);
477    }
478    return res;
479}
480
481
482sp<Camera3Device::CaptureRequest> Camera3Device::setUpRequestLocked(
483        const CameraMetadata &request) {
484    status_t res;
485
486    if (mStatus == STATUS_UNCONFIGURED || mNeedConfig) {
487        res = configureStreamsLocked();
488        if (res != OK) {
489            SET_ERR_L("Can't set up streams: %s (%d)", strerror(-res), res);
490            return NULL;
491        }
492        if (mStatus == STATUS_UNCONFIGURED) {
493            CLOGE("No streams configured");
494            return NULL;
495        }
496    }
497
498    sp<CaptureRequest> newRequest = createCaptureRequest(request);
499    return newRequest;
500}
501
502status_t Camera3Device::clearStreamingRequest() {
503    ATRACE_CALL();
504    Mutex::Autolock il(mInterfaceLock);
505    Mutex::Autolock l(mLock);
506
507    switch (mStatus) {
508        case STATUS_ERROR:
509            CLOGE("Device has encountered a serious error");
510            return INVALID_OPERATION;
511        case STATUS_UNINITIALIZED:
512            CLOGE("Device not initialized");
513            return INVALID_OPERATION;
514        case STATUS_UNCONFIGURED:
515        case STATUS_CONFIGURED:
516        case STATUS_ACTIVE:
517            // OK
518            break;
519        default:
520            SET_ERR_L("Unexpected status: %d", mStatus);
521            return INVALID_OPERATION;
522    }
523    ALOGV("Camera %d: Clearing repeating request", mId);
524    return mRequestThread->clearRepeatingRequests();
525}
526
527status_t Camera3Device::waitUntilRequestReceived(int32_t requestId, nsecs_t timeout) {
528    ATRACE_CALL();
529    Mutex::Autolock il(mInterfaceLock);
530
531    return mRequestThread->waitUntilRequestProcessed(requestId, timeout);
532}
533
534status_t Camera3Device::createInputStream(
535        uint32_t width, uint32_t height, int format, int *id) {
536    ATRACE_CALL();
537    Mutex::Autolock il(mInterfaceLock);
538    Mutex::Autolock l(mLock);
539    ALOGV("Camera %d: Creating new input stream %d: %d x %d, format %d",
540            mId, mNextStreamId, width, height, format);
541
542    status_t res;
543    bool wasActive = false;
544
545    switch (mStatus) {
546        case STATUS_ERROR:
547            ALOGE("%s: Device has encountered a serious error", __FUNCTION__);
548            return INVALID_OPERATION;
549        case STATUS_UNINITIALIZED:
550            ALOGE("%s: Device not initialized", __FUNCTION__);
551            return INVALID_OPERATION;
552        case STATUS_UNCONFIGURED:
553        case STATUS_CONFIGURED:
554            // OK
555            break;
556        case STATUS_ACTIVE:
557            ALOGV("%s: Stopping activity to reconfigure streams", __FUNCTION__);
558            res = internalPauseAndWaitLocked();
559            if (res != OK) {
560                SET_ERR_L("Can't pause captures to reconfigure streams!");
561                return res;
562            }
563            wasActive = true;
564            break;
565        default:
566            SET_ERR_L("%s: Unexpected status: %d", mStatus);
567            return INVALID_OPERATION;
568    }
569    assert(mStatus != STATUS_ACTIVE);
570
571    if (mInputStream != 0) {
572        ALOGE("%s: Cannot create more than 1 input stream", __FUNCTION__);
573        return INVALID_OPERATION;
574    }
575
576    sp<Camera3InputStream> newStream = new Camera3InputStream(mNextStreamId,
577                width, height, format);
578    newStream->setStatusTracker(mStatusTracker);
579
580    mInputStream = newStream;
581
582    *id = mNextStreamId++;
583
584    // Continue captures if active at start
585    if (wasActive) {
586        ALOGV("%s: Restarting activity to reconfigure streams", __FUNCTION__);
587        res = configureStreamsLocked();
588        if (res != OK) {
589            ALOGE("%s: Can't reconfigure device for new stream %d: %s (%d)",
590                    __FUNCTION__, mNextStreamId, strerror(-res), res);
591            return res;
592        }
593        internalResumeLocked();
594    }
595
596    ALOGV("Camera %d: Created input stream", mId);
597    return OK;
598}
599
600
601status_t Camera3Device::createZslStream(
602            uint32_t width, uint32_t height,
603            int depth,
604            /*out*/
605            int *id,
606            sp<Camera3ZslStream>* zslStream) {
607    ATRACE_CALL();
608    Mutex::Autolock il(mInterfaceLock);
609    Mutex::Autolock l(mLock);
610    ALOGV("Camera %d: Creating ZSL stream %d: %d x %d, depth %d",
611            mId, mNextStreamId, width, height, depth);
612
613    status_t res;
614    bool wasActive = false;
615
616    switch (mStatus) {
617        case STATUS_ERROR:
618            ALOGE("%s: Device has encountered a serious error", __FUNCTION__);
619            return INVALID_OPERATION;
620        case STATUS_UNINITIALIZED:
621            ALOGE("%s: Device not initialized", __FUNCTION__);
622            return INVALID_OPERATION;
623        case STATUS_UNCONFIGURED:
624        case STATUS_CONFIGURED:
625            // OK
626            break;
627        case STATUS_ACTIVE:
628            ALOGV("%s: Stopping activity to reconfigure streams", __FUNCTION__);
629            res = internalPauseAndWaitLocked();
630            if (res != OK) {
631                SET_ERR_L("Can't pause captures to reconfigure streams!");
632                return res;
633            }
634            wasActive = true;
635            break;
636        default:
637            SET_ERR_L("Unexpected status: %d", mStatus);
638            return INVALID_OPERATION;
639    }
640    assert(mStatus != STATUS_ACTIVE);
641
642    if (mInputStream != 0) {
643        ALOGE("%s: Cannot create more than 1 input stream", __FUNCTION__);
644        return INVALID_OPERATION;
645    }
646
647    sp<Camera3ZslStream> newStream = new Camera3ZslStream(mNextStreamId,
648                width, height, depth);
649    newStream->setStatusTracker(mStatusTracker);
650
651    res = mOutputStreams.add(mNextStreamId, newStream);
652    if (res < 0) {
653        ALOGE("%s: Can't add new stream to set: %s (%d)",
654                __FUNCTION__, strerror(-res), res);
655        return res;
656    }
657    mInputStream = newStream;
658
659    *id = mNextStreamId++;
660    *zslStream = newStream;
661
662    // Continue captures if active at start
663    if (wasActive) {
664        ALOGV("%s: Restarting activity to reconfigure streams", __FUNCTION__);
665        res = configureStreamsLocked();
666        if (res != OK) {
667            ALOGE("%s: Can't reconfigure device for new stream %d: %s (%d)",
668                    __FUNCTION__, mNextStreamId, strerror(-res), res);
669            return res;
670        }
671        internalResumeLocked();
672    }
673
674    ALOGV("Camera %d: Created ZSL stream", mId);
675    return OK;
676}
677
678status_t Camera3Device::createStream(sp<ANativeWindow> consumer,
679        uint32_t width, uint32_t height, int format, size_t size, int *id) {
680    ATRACE_CALL();
681    Mutex::Autolock il(mInterfaceLock);
682    Mutex::Autolock l(mLock);
683    ALOGV("Camera %d: Creating new stream %d: %d x %d, format %d, size %d",
684            mId, mNextStreamId, width, height, format, size);
685
686    status_t res;
687    bool wasActive = false;
688
689    switch (mStatus) {
690        case STATUS_ERROR:
691            CLOGE("Device has encountered a serious error");
692            return INVALID_OPERATION;
693        case STATUS_UNINITIALIZED:
694            CLOGE("Device not initialized");
695            return INVALID_OPERATION;
696        case STATUS_UNCONFIGURED:
697        case STATUS_CONFIGURED:
698            // OK
699            break;
700        case STATUS_ACTIVE:
701            ALOGV("%s: Stopping activity to reconfigure streams", __FUNCTION__);
702            res = internalPauseAndWaitLocked();
703            if (res != OK) {
704                SET_ERR_L("Can't pause captures to reconfigure streams!");
705                return res;
706            }
707            wasActive = true;
708            break;
709        default:
710            SET_ERR_L("Unexpected status: %d", mStatus);
711            return INVALID_OPERATION;
712    }
713    assert(mStatus != STATUS_ACTIVE);
714
715    sp<Camera3OutputStream> newStream;
716    if (format == HAL_PIXEL_FORMAT_BLOB) {
717        newStream = new Camera3OutputStream(mNextStreamId, consumer,
718                width, height, size, format);
719    } else {
720        newStream = new Camera3OutputStream(mNextStreamId, consumer,
721                width, height, format);
722    }
723    newStream->setStatusTracker(mStatusTracker);
724
725    res = mOutputStreams.add(mNextStreamId, newStream);
726    if (res < 0) {
727        SET_ERR_L("Can't add new stream to set: %s (%d)", strerror(-res), res);
728        return res;
729    }
730
731    *id = mNextStreamId++;
732    mNeedConfig = true;
733
734    // Continue captures if active at start
735    if (wasActive) {
736        ALOGV("%s: Restarting activity to reconfigure streams", __FUNCTION__);
737        res = configureStreamsLocked();
738        if (res != OK) {
739            CLOGE("Can't reconfigure device for new stream %d: %s (%d)",
740                    mNextStreamId, strerror(-res), res);
741            return res;
742        }
743        internalResumeLocked();
744    }
745    ALOGV("Camera %d: Created new stream", mId);
746    return OK;
747}
748
749status_t Camera3Device::createReprocessStreamFromStream(int outputId, int *id) {
750    ATRACE_CALL();
751    (void)outputId; (void)id;
752
753    CLOGE("Unimplemented");
754    return INVALID_OPERATION;
755}
756
757
758status_t Camera3Device::getStreamInfo(int id,
759        uint32_t *width, uint32_t *height, uint32_t *format) {
760    ATRACE_CALL();
761    Mutex::Autolock il(mInterfaceLock);
762    Mutex::Autolock l(mLock);
763
764    switch (mStatus) {
765        case STATUS_ERROR:
766            CLOGE("Device has encountered a serious error");
767            return INVALID_OPERATION;
768        case STATUS_UNINITIALIZED:
769            CLOGE("Device not initialized!");
770            return INVALID_OPERATION;
771        case STATUS_UNCONFIGURED:
772        case STATUS_CONFIGURED:
773        case STATUS_ACTIVE:
774            // OK
775            break;
776        default:
777            SET_ERR_L("Unexpected status: %d", mStatus);
778            return INVALID_OPERATION;
779    }
780
781    ssize_t idx = mOutputStreams.indexOfKey(id);
782    if (idx == NAME_NOT_FOUND) {
783        CLOGE("Stream %d is unknown", id);
784        return idx;
785    }
786
787    if (width) *width  = mOutputStreams[idx]->getWidth();
788    if (height) *height = mOutputStreams[idx]->getHeight();
789    if (format) *format = mOutputStreams[idx]->getFormat();
790
791    return OK;
792}
793
794status_t Camera3Device::setStreamTransform(int id,
795        int transform) {
796    ATRACE_CALL();
797    Mutex::Autolock il(mInterfaceLock);
798    Mutex::Autolock l(mLock);
799
800    switch (mStatus) {
801        case STATUS_ERROR:
802            CLOGE("Device has encountered a serious error");
803            return INVALID_OPERATION;
804        case STATUS_UNINITIALIZED:
805            CLOGE("Device not initialized");
806            return INVALID_OPERATION;
807        case STATUS_UNCONFIGURED:
808        case STATUS_CONFIGURED:
809        case STATUS_ACTIVE:
810            // OK
811            break;
812        default:
813            SET_ERR_L("Unexpected status: %d", mStatus);
814            return INVALID_OPERATION;
815    }
816
817    ssize_t idx = mOutputStreams.indexOfKey(id);
818    if (idx == NAME_NOT_FOUND) {
819        CLOGE("Stream %d does not exist",
820                id);
821        return BAD_VALUE;
822    }
823
824    return mOutputStreams.editValueAt(idx)->setTransform(transform);
825}
826
827status_t Camera3Device::deleteStream(int id) {
828    ATRACE_CALL();
829    Mutex::Autolock il(mInterfaceLock);
830    Mutex::Autolock l(mLock);
831    status_t res;
832
833    ALOGV("%s: Camera %d: Deleting stream %d", __FUNCTION__, mId, id);
834
835    // CameraDevice semantics require device to already be idle before
836    // deleteStream is called, unlike for createStream.
837    if (mStatus == STATUS_ACTIVE) {
838        ALOGV("%s: Camera %d: Device not idle", __FUNCTION__, mId);
839        return -EBUSY;
840    }
841
842    sp<Camera3StreamInterface> deletedStream;
843    if (mInputStream != NULL && id == mInputStream->getId()) {
844        deletedStream = mInputStream;
845        mInputStream.clear();
846    } else {
847        ssize_t idx = mOutputStreams.indexOfKey(id);
848        if (idx == NAME_NOT_FOUND) {
849            CLOGE("Stream %d does not exist", id);
850            return BAD_VALUE;
851        }
852        deletedStream = mOutputStreams.editValueAt(idx);
853        mOutputStreams.removeItem(id);
854    }
855
856    // Free up the stream endpoint so that it can be used by some other stream
857    res = deletedStream->disconnect();
858    if (res != OK) {
859        SET_ERR_L("Can't disconnect deleted stream %d", id);
860        // fall through since we want to still list the stream as deleted.
861    }
862    mDeletedStreams.add(deletedStream);
863    mNeedConfig = true;
864
865    return res;
866}
867
868status_t Camera3Device::deleteReprocessStream(int id) {
869    ATRACE_CALL();
870    (void)id;
871
872    CLOGE("Unimplemented");
873    return INVALID_OPERATION;
874}
875
876
877status_t Camera3Device::createDefaultRequest(int templateId,
878        CameraMetadata *request) {
879    ATRACE_CALL();
880    ALOGV("%s: for template %d", __FUNCTION__, templateId);
881    Mutex::Autolock il(mInterfaceLock);
882    Mutex::Autolock l(mLock);
883
884    switch (mStatus) {
885        case STATUS_ERROR:
886            CLOGE("Device has encountered a serious error");
887            return INVALID_OPERATION;
888        case STATUS_UNINITIALIZED:
889            CLOGE("Device is not initialized!");
890            return INVALID_OPERATION;
891        case STATUS_UNCONFIGURED:
892        case STATUS_CONFIGURED:
893        case STATUS_ACTIVE:
894            // OK
895            break;
896        default:
897            SET_ERR_L("Unexpected status: %d", mStatus);
898            return INVALID_OPERATION;
899    }
900
901    const camera_metadata_t *rawRequest;
902    ATRACE_BEGIN("camera3->construct_default_request_settings");
903    rawRequest = mHal3Device->ops->construct_default_request_settings(
904        mHal3Device, templateId);
905    ATRACE_END();
906    if (rawRequest == NULL) {
907        SET_ERR_L("HAL is unable to construct default settings for template %d",
908                templateId);
909        return DEAD_OBJECT;
910    }
911    *request = rawRequest;
912
913    return OK;
914}
915
916status_t Camera3Device::waitUntilDrained() {
917    ATRACE_CALL();
918    Mutex::Autolock il(mInterfaceLock);
919    Mutex::Autolock l(mLock);
920
921    switch (mStatus) {
922        case STATUS_UNINITIALIZED:
923        case STATUS_UNCONFIGURED:
924            ALOGV("%s: Already idle", __FUNCTION__);
925            return OK;
926        case STATUS_CONFIGURED:
927            // To avoid race conditions, check with tracker to be sure
928        case STATUS_ERROR:
929        case STATUS_ACTIVE:
930            // Need to verify shut down
931            break;
932        default:
933            SET_ERR_L("Unexpected status: %d",mStatus);
934            return INVALID_OPERATION;
935    }
936
937    ALOGV("%s: Camera %d: Waiting until idle", __FUNCTION__, mId);
938    status_t res = waitUntilStateThenRelock(/*active*/ false, kShutdownTimeout);
939    return res;
940}
941
942// Pause to reconfigure
943status_t Camera3Device::internalPauseAndWaitLocked() {
944    mRequestThread->setPaused(true);
945    mPauseStateNotify = true;
946
947    ALOGV("%s: Camera %d: Internal wait until idle", __FUNCTION__, mId);
948    status_t res = waitUntilStateThenRelock(/*active*/ false, kShutdownTimeout);
949    if (res != OK) {
950        SET_ERR_L("Can't idle device in %f seconds!",
951                kShutdownTimeout/1e9);
952    }
953
954    return res;
955}
956
957// Resume after internalPauseAndWaitLocked
958status_t Camera3Device::internalResumeLocked() {
959    status_t res;
960
961    mRequestThread->setPaused(false);
962
963    res = waitUntilStateThenRelock(/*active*/ true, kActiveTimeout);
964    if (res != OK) {
965        SET_ERR_L("Can't transition to active in %f seconds!",
966                kActiveTimeout/1e9);
967    }
968    mPauseStateNotify = false;
969    return OK;
970}
971
972status_t Camera3Device::waitUntilStateThenRelock(bool active,
973        nsecs_t timeout) {
974    status_t res = OK;
975    if (active == (mStatus == STATUS_ACTIVE)) {
976        // Desired state already reached
977        return res;
978    }
979
980    bool stateSeen = false;
981    do {
982        mRecentStatusUpdates.clear();
983
984        res = mStatusChanged.waitRelative(mLock, timeout);
985        if (res != OK) break;
986
987        // Check state change history during wait
988        for (size_t i = 0; i < mRecentStatusUpdates.size(); i++) {
989            if (active == (mRecentStatusUpdates[i] == STATUS_ACTIVE) ) {
990                stateSeen = true;
991                break;
992            }
993        }
994    } while (!stateSeen);
995
996    return res;
997}
998
999
1000status_t Camera3Device::setNotifyCallback(NotificationListener *listener) {
1001    ATRACE_CALL();
1002    Mutex::Autolock l(mOutputLock);
1003
1004    if (listener != NULL && mListener != NULL) {
1005        ALOGW("%s: Replacing old callback listener", __FUNCTION__);
1006    }
1007    mListener = listener;
1008
1009    return OK;
1010}
1011
1012bool Camera3Device::willNotify3A() {
1013    return false;
1014}
1015
1016status_t Camera3Device::waitForNextFrame(nsecs_t timeout) {
1017    status_t res;
1018    Mutex::Autolock l(mOutputLock);
1019
1020    while (mResultQueue.empty()) {
1021        res = mResultSignal.waitRelative(mOutputLock, timeout);
1022        if (res == TIMED_OUT) {
1023            return res;
1024        } else if (res != OK) {
1025            ALOGW("%s: Camera %d: No frame in %lld ns: %s (%d)",
1026                    __FUNCTION__, mId, timeout, strerror(-res), res);
1027            return res;
1028        }
1029    }
1030    return OK;
1031}
1032
1033status_t Camera3Device::getNextFrame(CameraMetadata *frame) {
1034    ATRACE_CALL();
1035    Mutex::Autolock l(mOutputLock);
1036
1037    if (mResultQueue.empty()) {
1038        return NOT_ENOUGH_DATA;
1039    }
1040
1041    CameraMetadata &result = *(mResultQueue.begin());
1042    frame->acquire(result);
1043    mResultQueue.erase(mResultQueue.begin());
1044
1045    return OK;
1046}
1047
1048status_t Camera3Device::triggerAutofocus(uint32_t id) {
1049    ATRACE_CALL();
1050    Mutex::Autolock il(mInterfaceLock);
1051
1052    ALOGV("%s: Triggering autofocus, id %d", __FUNCTION__, id);
1053    // Mix-in this trigger into the next request and only the next request.
1054    RequestTrigger trigger[] = {
1055        {
1056            ANDROID_CONTROL_AF_TRIGGER,
1057            ANDROID_CONTROL_AF_TRIGGER_START
1058        },
1059        {
1060            ANDROID_CONTROL_AF_TRIGGER_ID,
1061            static_cast<int32_t>(id)
1062        },
1063    };
1064
1065    return mRequestThread->queueTrigger(trigger,
1066                                        sizeof(trigger)/sizeof(trigger[0]));
1067}
1068
1069status_t Camera3Device::triggerCancelAutofocus(uint32_t id) {
1070    ATRACE_CALL();
1071    Mutex::Autolock il(mInterfaceLock);
1072
1073    ALOGV("%s: Triggering cancel autofocus, id %d", __FUNCTION__, id);
1074    // Mix-in this trigger into the next request and only the next request.
1075    RequestTrigger trigger[] = {
1076        {
1077            ANDROID_CONTROL_AF_TRIGGER,
1078            ANDROID_CONTROL_AF_TRIGGER_CANCEL
1079        },
1080        {
1081            ANDROID_CONTROL_AF_TRIGGER_ID,
1082            static_cast<int32_t>(id)
1083        },
1084    };
1085
1086    return mRequestThread->queueTrigger(trigger,
1087                                        sizeof(trigger)/sizeof(trigger[0]));
1088}
1089
1090status_t Camera3Device::triggerPrecaptureMetering(uint32_t id) {
1091    ATRACE_CALL();
1092    Mutex::Autolock il(mInterfaceLock);
1093
1094    ALOGV("%s: Triggering precapture metering, id %d", __FUNCTION__, id);
1095    // Mix-in this trigger into the next request and only the next request.
1096    RequestTrigger trigger[] = {
1097        {
1098            ANDROID_CONTROL_AE_PRECAPTURE_TRIGGER,
1099            ANDROID_CONTROL_AE_PRECAPTURE_TRIGGER_START
1100        },
1101        {
1102            ANDROID_CONTROL_AE_PRECAPTURE_ID,
1103            static_cast<int32_t>(id)
1104        },
1105    };
1106
1107    return mRequestThread->queueTrigger(trigger,
1108                                        sizeof(trigger)/sizeof(trigger[0]));
1109}
1110
1111status_t Camera3Device::pushReprocessBuffer(int reprocessStreamId,
1112        buffer_handle_t *buffer, wp<BufferReleasedListener> listener) {
1113    ATRACE_CALL();
1114    (void)reprocessStreamId; (void)buffer; (void)listener;
1115
1116    CLOGE("Unimplemented");
1117    return INVALID_OPERATION;
1118}
1119
1120status_t Camera3Device::flush() {
1121    ATRACE_CALL();
1122    ALOGV("%s: Camera %d: Flushing all requests", __FUNCTION__, mId);
1123    Mutex::Autolock il(mInterfaceLock);
1124    Mutex::Autolock l(mLock);
1125
1126    mRequestThread->clear();
1127    return mHal3Device->ops->flush(mHal3Device);
1128}
1129
1130/**
1131 * Methods called by subclasses
1132 */
1133
1134void Camera3Device::notifyStatus(bool idle) {
1135    {
1136        // Need mLock to safely update state and synchronize to current
1137        // state of methods in flight.
1138        Mutex::Autolock l(mLock);
1139        // We can get various system-idle notices from the status tracker
1140        // while starting up. Only care about them if we've actually sent
1141        // in some requests recently.
1142        if (mStatus != STATUS_ACTIVE && mStatus != STATUS_CONFIGURED) {
1143            return;
1144        }
1145        ALOGV("%s: Camera %d: Now %s", __FUNCTION__, mId,
1146                idle ? "idle" : "active");
1147        mStatus = idle ? STATUS_CONFIGURED : STATUS_ACTIVE;
1148        mRecentStatusUpdates.add(mStatus);
1149        mStatusChanged.signal();
1150
1151        // Skip notifying listener if we're doing some user-transparent
1152        // state changes
1153        if (mPauseStateNotify) return;
1154    }
1155    NotificationListener *listener;
1156    {
1157        Mutex::Autolock l(mOutputLock);
1158        listener = mListener;
1159    }
1160    if (idle && listener != NULL) {
1161        listener->notifyIdle();
1162    }
1163}
1164
1165/**
1166 * Camera3Device private methods
1167 */
1168
1169sp<Camera3Device::CaptureRequest> Camera3Device::createCaptureRequest(
1170        const CameraMetadata &request) {
1171    ATRACE_CALL();
1172    status_t res;
1173
1174    sp<CaptureRequest> newRequest = new CaptureRequest;
1175    newRequest->mSettings = request;
1176
1177    camera_metadata_entry_t inputStreams =
1178            newRequest->mSettings.find(ANDROID_REQUEST_INPUT_STREAMS);
1179    if (inputStreams.count > 0) {
1180        if (mInputStream == NULL ||
1181                mInputStream->getId() != inputStreams.data.i32[0]) {
1182            CLOGE("Request references unknown input stream %d",
1183                    inputStreams.data.u8[0]);
1184            return NULL;
1185        }
1186        // Lazy completion of stream configuration (allocation/registration)
1187        // on first use
1188        if (mInputStream->isConfiguring()) {
1189            res = mInputStream->finishConfiguration(mHal3Device);
1190            if (res != OK) {
1191                SET_ERR_L("Unable to finish configuring input stream %d:"
1192                        " %s (%d)",
1193                        mInputStream->getId(), strerror(-res), res);
1194                return NULL;
1195            }
1196        }
1197
1198        newRequest->mInputStream = mInputStream;
1199        newRequest->mSettings.erase(ANDROID_REQUEST_INPUT_STREAMS);
1200    }
1201
1202    camera_metadata_entry_t streams =
1203            newRequest->mSettings.find(ANDROID_REQUEST_OUTPUT_STREAMS);
1204    if (streams.count == 0) {
1205        CLOGE("Zero output streams specified!");
1206        return NULL;
1207    }
1208
1209    for (size_t i = 0; i < streams.count; i++) {
1210        int idx = mOutputStreams.indexOfKey(streams.data.i32[i]);
1211        if (idx == NAME_NOT_FOUND) {
1212            CLOGE("Request references unknown stream %d",
1213                    streams.data.u8[i]);
1214            return NULL;
1215        }
1216        sp<Camera3OutputStreamInterface> stream =
1217                mOutputStreams.editValueAt(idx);
1218
1219        // Lazy completion of stream configuration (allocation/registration)
1220        // on first use
1221        if (stream->isConfiguring()) {
1222            res = stream->finishConfiguration(mHal3Device);
1223            if (res != OK) {
1224                SET_ERR_L("Unable to finish configuring stream %d: %s (%d)",
1225                        stream->getId(), strerror(-res), res);
1226                return NULL;
1227            }
1228        }
1229
1230        newRequest->mOutputStreams.push(stream);
1231    }
1232    newRequest->mSettings.erase(ANDROID_REQUEST_OUTPUT_STREAMS);
1233
1234    return newRequest;
1235}
1236
1237status_t Camera3Device::configureStreamsLocked() {
1238    ATRACE_CALL();
1239    status_t res;
1240
1241    if (mStatus != STATUS_UNCONFIGURED && mStatus != STATUS_CONFIGURED) {
1242        CLOGE("Not idle");
1243        return INVALID_OPERATION;
1244    }
1245
1246    if (!mNeedConfig) {
1247        ALOGV("%s: Skipping config, no stream changes", __FUNCTION__);
1248        return OK;
1249    }
1250
1251    // Start configuring the streams
1252    ALOGV("%s: Camera %d: Starting stream configuration", __FUNCTION__, mId);
1253
1254    camera3_stream_configuration config;
1255
1256    config.num_streams = (mInputStream != NULL) + mOutputStreams.size();
1257
1258    Vector<camera3_stream_t*> streams;
1259    streams.setCapacity(config.num_streams);
1260
1261    if (mInputStream != NULL) {
1262        camera3_stream_t *inputStream;
1263        inputStream = mInputStream->startConfiguration();
1264        if (inputStream == NULL) {
1265            SET_ERR_L("Can't start input stream configuration");
1266            return INVALID_OPERATION;
1267        }
1268        streams.add(inputStream);
1269    }
1270
1271    for (size_t i = 0; i < mOutputStreams.size(); i++) {
1272
1273        // Don't configure bidi streams twice, nor add them twice to the list
1274        if (mOutputStreams[i].get() ==
1275            static_cast<Camera3StreamInterface*>(mInputStream.get())) {
1276
1277            config.num_streams--;
1278            continue;
1279        }
1280
1281        camera3_stream_t *outputStream;
1282        outputStream = mOutputStreams.editValueAt(i)->startConfiguration();
1283        if (outputStream == NULL) {
1284            SET_ERR_L("Can't start output stream configuration");
1285            return INVALID_OPERATION;
1286        }
1287        streams.add(outputStream);
1288    }
1289
1290    config.streams = streams.editArray();
1291
1292    // Do the HAL configuration; will potentially touch stream
1293    // max_buffers, usage, priv fields.
1294    ATRACE_BEGIN("camera3->configure_streams");
1295    res = mHal3Device->ops->configure_streams(mHal3Device, &config);
1296    ATRACE_END();
1297
1298    if (res != OK) {
1299        SET_ERR_L("Unable to configure streams with HAL: %s (%d)",
1300                strerror(-res), res);
1301        return res;
1302    }
1303
1304    // Finish all stream configuration immediately.
1305    // TODO: Try to relax this later back to lazy completion, which should be
1306    // faster
1307
1308    if (mInputStream != NULL && mInputStream->isConfiguring()) {
1309        res = mInputStream->finishConfiguration(mHal3Device);
1310        if (res != OK) {
1311            SET_ERR_L("Can't finish configuring input stream %d: %s (%d)",
1312                    mInputStream->getId(), strerror(-res), res);
1313            return res;
1314        }
1315    }
1316
1317    for (size_t i = 0; i < mOutputStreams.size(); i++) {
1318        sp<Camera3OutputStreamInterface> outputStream =
1319            mOutputStreams.editValueAt(i);
1320        if (outputStream->isConfiguring()) {
1321            res = outputStream->finishConfiguration(mHal3Device);
1322            if (res != OK) {
1323                SET_ERR_L("Can't finish configuring output stream %d: %s (%d)",
1324                        outputStream->getId(), strerror(-res), res);
1325                return res;
1326            }
1327        }
1328    }
1329
1330    // Request thread needs to know to avoid using repeat-last-settings protocol
1331    // across configure_streams() calls
1332    mRequestThread->configurationComplete();
1333
1334    // Update device state
1335
1336    mNeedConfig = false;
1337
1338    if (config.num_streams > 0) {
1339        mStatus = STATUS_CONFIGURED;
1340    } else {
1341        mStatus = STATUS_UNCONFIGURED;
1342    }
1343
1344    ALOGV("%s: Camera %d: Stream configuration complete", __FUNCTION__, mId);
1345
1346    return OK;
1347}
1348
1349void Camera3Device::setErrorState(const char *fmt, ...) {
1350    Mutex::Autolock l(mLock);
1351    va_list args;
1352    va_start(args, fmt);
1353
1354    setErrorStateLockedV(fmt, args);
1355
1356    va_end(args);
1357}
1358
1359void Camera3Device::setErrorStateV(const char *fmt, va_list args) {
1360    Mutex::Autolock l(mLock);
1361    setErrorStateLockedV(fmt, args);
1362}
1363
1364void Camera3Device::setErrorStateLocked(const char *fmt, ...) {
1365    va_list args;
1366    va_start(args, fmt);
1367
1368    setErrorStateLockedV(fmt, args);
1369
1370    va_end(args);
1371}
1372
1373void Camera3Device::setErrorStateLockedV(const char *fmt, va_list args) {
1374    // Print out all error messages to log
1375    String8 errorCause = String8::formatV(fmt, args);
1376    ALOGE("Camera %d: %s", mId, errorCause.string());
1377
1378    // But only do error state transition steps for the first error
1379    if (mStatus == STATUS_ERROR || mStatus == STATUS_UNINITIALIZED) return;
1380
1381    // Save stack trace. View by dumping it later.
1382    CameraTraces::saveTrace();
1383    // TODO: consider adding errorCause and client pid/procname
1384
1385    mErrorCause = errorCause;
1386
1387    mRequestThread->setPaused(true);
1388    mStatus = STATUS_ERROR;
1389}
1390
1391/**
1392 * In-flight request management
1393 */
1394
1395status_t Camera3Device::registerInFlight(int32_t frameNumber,
1396        int32_t requestId, int32_t numBuffers) {
1397    ATRACE_CALL();
1398    Mutex::Autolock l(mInFlightLock);
1399
1400    ssize_t res;
1401    res = mInFlightMap.add(frameNumber, InFlightRequest(requestId, numBuffers));
1402    if (res < 0) return res;
1403
1404    return OK;
1405}
1406
1407/**
1408 * QUIRK(partial results)
1409 * Check if all 3A fields are ready, and send off a partial 3A-only result
1410 * to the output frame queue
1411 */
1412bool Camera3Device::processPartial3AQuirk(
1413        int32_t frameNumber, int32_t requestId,
1414        const CameraMetadata& partial) {
1415
1416    // Check if all 3A states are present
1417    // The full list of fields is
1418    //   android.control.afMode
1419    //   android.control.awbMode
1420    //   android.control.aeState
1421    //   android.control.awbState
1422    //   android.control.afState
1423    //   android.control.afTriggerID
1424    //   android.control.aePrecaptureID
1425    // TODO: Add android.control.aeMode
1426
1427    bool gotAllStates = true;
1428
1429    uint8_t afMode;
1430    uint8_t awbMode;
1431    uint8_t aeState;
1432    uint8_t afState;
1433    uint8_t awbState;
1434    int32_t afTriggerId;
1435    int32_t aeTriggerId;
1436
1437    gotAllStates &= get3AResult(partial, ANDROID_CONTROL_AF_MODE,
1438        &afMode, frameNumber);
1439
1440    gotAllStates &= get3AResult(partial, ANDROID_CONTROL_AWB_MODE,
1441        &awbMode, frameNumber);
1442
1443    gotAllStates &= get3AResult(partial, ANDROID_CONTROL_AE_STATE,
1444        &aeState, frameNumber);
1445
1446    gotAllStates &= get3AResult(partial, ANDROID_CONTROL_AF_STATE,
1447        &afState, frameNumber);
1448
1449    gotAllStates &= get3AResult(partial, ANDROID_CONTROL_AWB_STATE,
1450        &awbState, frameNumber);
1451
1452    gotAllStates &= get3AResult(partial, ANDROID_CONTROL_AF_TRIGGER_ID,
1453        &afTriggerId, frameNumber);
1454
1455    gotAllStates &= get3AResult(partial, ANDROID_CONTROL_AE_PRECAPTURE_ID,
1456        &aeTriggerId, frameNumber);
1457
1458    if (!gotAllStates) return false;
1459
1460    ALOGVV("%s: Camera %d: Frame %d, Request ID %d: AF mode %d, AWB mode %d, "
1461        "AF state %d, AE state %d, AWB state %d, "
1462        "AF trigger %d, AE precapture trigger %d",
1463        __FUNCTION__, mId, frameNumber, requestId,
1464        afMode, awbMode,
1465        afState, aeState, awbState,
1466        afTriggerId, aeTriggerId);
1467
1468    // Got all states, so construct a minimal result to send
1469    // In addition to the above fields, this means adding in
1470    //   android.request.frameCount
1471    //   android.request.requestId
1472    //   android.quirks.partialResult
1473
1474    const size_t kMinimal3AResultEntries = 10;
1475
1476    Mutex::Autolock l(mOutputLock);
1477
1478    CameraMetadata& min3AResult =
1479            *mResultQueue.insert(
1480                mResultQueue.end(),
1481                CameraMetadata(kMinimal3AResultEntries, /*dataCapacity*/ 0));
1482
1483    if (!insert3AResult(min3AResult, ANDROID_REQUEST_FRAME_COUNT,
1484            &frameNumber, frameNumber)) {
1485        return false;
1486    }
1487
1488    if (!insert3AResult(min3AResult, ANDROID_REQUEST_ID,
1489            &requestId, frameNumber)) {
1490        return false;
1491    }
1492
1493    static const uint8_t partialResult = ANDROID_QUIRKS_PARTIAL_RESULT_PARTIAL;
1494    if (!insert3AResult(min3AResult, ANDROID_QUIRKS_PARTIAL_RESULT,
1495            &partialResult, frameNumber)) {
1496        return false;
1497    }
1498
1499    if (!insert3AResult(min3AResult, ANDROID_CONTROL_AF_MODE,
1500            &afMode, frameNumber)) {
1501        return false;
1502    }
1503
1504    if (!insert3AResult(min3AResult, ANDROID_CONTROL_AWB_MODE,
1505            &awbMode, frameNumber)) {
1506        return false;
1507    }
1508
1509    if (!insert3AResult(min3AResult, ANDROID_CONTROL_AE_STATE,
1510            &aeState, frameNumber)) {
1511        return false;
1512    }
1513
1514    if (!insert3AResult(min3AResult, ANDROID_CONTROL_AF_STATE,
1515            &afState, frameNumber)) {
1516        return false;
1517    }
1518
1519    if (!insert3AResult(min3AResult, ANDROID_CONTROL_AWB_STATE,
1520            &awbState, frameNumber)) {
1521        return false;
1522    }
1523
1524    if (!insert3AResult(min3AResult, ANDROID_CONTROL_AF_TRIGGER_ID,
1525            &afTriggerId, frameNumber)) {
1526        return false;
1527    }
1528
1529    if (!insert3AResult(min3AResult, ANDROID_CONTROL_AE_PRECAPTURE_ID,
1530            &aeTriggerId, frameNumber)) {
1531        return false;
1532    }
1533
1534    mResultSignal.signal();
1535
1536    return true;
1537}
1538
1539template<typename T>
1540bool Camera3Device::get3AResult(const CameraMetadata& result, int32_t tag,
1541        T* value, int32_t frameNumber) {
1542    (void) frameNumber;
1543
1544    camera_metadata_ro_entry_t entry;
1545
1546    entry = result.find(tag);
1547    if (entry.count == 0) {
1548        ALOGVV("%s: Camera %d: Frame %d: No %s provided by HAL!", __FUNCTION__,
1549            mId, frameNumber, get_camera_metadata_tag_name(tag));
1550        return false;
1551    }
1552
1553    if (sizeof(T) == sizeof(uint8_t)) {
1554        *value = entry.data.u8[0];
1555    } else if (sizeof(T) == sizeof(int32_t)) {
1556        *value = entry.data.i32[0];
1557    } else {
1558        ALOGE("%s: Unexpected type", __FUNCTION__);
1559        return false;
1560    }
1561    return true;
1562}
1563
1564template<typename T>
1565bool Camera3Device::insert3AResult(CameraMetadata& result, int32_t tag,
1566        const T* value, int32_t frameNumber) {
1567    if (result.update(tag, value, 1) != NO_ERROR) {
1568        mResultQueue.erase(--mResultQueue.end(), mResultQueue.end());
1569        SET_ERR("Frame %d: Failed to set %s in partial metadata",
1570                frameNumber, get_camera_metadata_tag_name(tag));
1571        return false;
1572    }
1573    return true;
1574}
1575
1576/**
1577 * Camera HAL device callback methods
1578 */
1579
1580void Camera3Device::processCaptureResult(const camera3_capture_result *result) {
1581    ATRACE_CALL();
1582
1583    status_t res;
1584
1585    uint32_t frameNumber = result->frame_number;
1586    if (result->result == NULL && result->num_output_buffers == 0) {
1587        SET_ERR("No result data provided by HAL for frame %d",
1588                frameNumber);
1589        return;
1590    }
1591    bool partialResultQuirk = false;
1592    CameraMetadata collectedQuirkResult;
1593
1594    // Get capture timestamp from list of in-flight requests, where it was added
1595    // by the shutter notification for this frame. Then update the in-flight
1596    // status and remove the in-flight entry if all result data has been
1597    // received.
1598    nsecs_t timestamp = 0;
1599    {
1600        Mutex::Autolock l(mInFlightLock);
1601        ssize_t idx = mInFlightMap.indexOfKey(frameNumber);
1602        if (idx == NAME_NOT_FOUND) {
1603            SET_ERR("Unknown frame number for capture result: %d",
1604                    frameNumber);
1605            return;
1606        }
1607        InFlightRequest &request = mInFlightMap.editValueAt(idx);
1608
1609        // Check if this result carries only partial metadata
1610        if (mUsePartialResultQuirk && result->result != NULL) {
1611            camera_metadata_ro_entry_t partialResultEntry;
1612            res = find_camera_metadata_ro_entry(result->result,
1613                    ANDROID_QUIRKS_PARTIAL_RESULT, &partialResultEntry);
1614            if (res != NAME_NOT_FOUND &&
1615                    partialResultEntry.count > 0 &&
1616                    partialResultEntry.data.u8[0] ==
1617                    ANDROID_QUIRKS_PARTIAL_RESULT_PARTIAL) {
1618                // A partial result. Flag this as such, and collect this
1619                // set of metadata into the in-flight entry.
1620                partialResultQuirk = true;
1621                request.partialResultQuirk.collectedResult.append(
1622                    result->result);
1623                request.partialResultQuirk.collectedResult.erase(
1624                    ANDROID_QUIRKS_PARTIAL_RESULT);
1625                // Fire off a 3A-only result if possible
1626                if (!request.partialResultQuirk.haveSent3A) {
1627                    request.partialResultQuirk.haveSent3A =
1628                            processPartial3AQuirk(frameNumber,
1629                                    request.requestId,
1630                                    request.partialResultQuirk.collectedResult);
1631                }
1632            }
1633        }
1634
1635        timestamp = request.captureTimestamp;
1636        /**
1637         * One of the following must happen before it's legal to call process_capture_result,
1638         * unless partial metadata is being provided:
1639         * - CAMERA3_MSG_SHUTTER (expected during normal operation)
1640         * - CAMERA3_MSG_ERROR (expected during flush)
1641         */
1642        if (request.requestStatus == OK && timestamp == 0 && !partialResultQuirk) {
1643            SET_ERR("Called before shutter notify for frame %d",
1644                    frameNumber);
1645            return;
1646        }
1647
1648        // Did we get the (final) result metadata for this capture?
1649        if (result->result != NULL && !partialResultQuirk) {
1650            if (request.haveResultMetadata) {
1651                SET_ERR("Called multiple times with metadata for frame %d",
1652                        frameNumber);
1653                return;
1654            }
1655            if (mUsePartialResultQuirk &&
1656                    !request.partialResultQuirk.collectedResult.isEmpty()) {
1657                collectedQuirkResult.acquire(
1658                    request.partialResultQuirk.collectedResult);
1659            }
1660            request.haveResultMetadata = true;
1661        }
1662
1663        request.numBuffersLeft -= result->num_output_buffers;
1664
1665        if (request.numBuffersLeft < 0) {
1666            SET_ERR("Too many buffers returned for frame %d",
1667                    frameNumber);
1668            return;
1669        }
1670
1671        // Check if everything has arrived for this result (buffers and metadata), remove it from
1672        // InFlightMap if both arrived or HAL reports error for this request (i.e. during flush).
1673        if ((request.requestStatus != OK) ||
1674                (request.haveResultMetadata && request.numBuffersLeft == 0)) {
1675            ATRACE_ASYNC_END("frame capture", frameNumber);
1676            mInFlightMap.removeItemsAt(idx, 1);
1677        }
1678
1679        // Sanity check - if we have too many in-flight frames, something has
1680        // likely gone wrong
1681        if (mInFlightMap.size() > kInFlightWarnLimit) {
1682            CLOGE("In-flight list too large: %d", mInFlightMap.size());
1683        }
1684
1685    }
1686
1687    // Process the result metadata, if provided
1688    bool gotResult = false;
1689    if (result->result != NULL && !partialResultQuirk) {
1690        Mutex::Autolock l(mOutputLock);
1691
1692        gotResult = true;
1693
1694        if (frameNumber != mNextResultFrameNumber) {
1695            SET_ERR("Out-of-order capture result metadata submitted! "
1696                    "(got frame number %d, expecting %d)",
1697                    frameNumber, mNextResultFrameNumber);
1698            return;
1699        }
1700        mNextResultFrameNumber++;
1701
1702        CameraMetadata captureResult;
1703        captureResult = result->result;
1704
1705        if (captureResult.update(ANDROID_REQUEST_FRAME_COUNT,
1706                        (int32_t*)&frameNumber, 1) != OK) {
1707            SET_ERR("Failed to set frame# in metadata (%d)",
1708                    frameNumber);
1709            gotResult = false;
1710        } else {
1711            ALOGVV("%s: Camera %d: Set frame# in metadata (%d)",
1712                    __FUNCTION__, mId, frameNumber);
1713        }
1714
1715        // Append any previous partials to form a complete result
1716        if (mUsePartialResultQuirk && !collectedQuirkResult.isEmpty()) {
1717            captureResult.append(collectedQuirkResult);
1718        }
1719
1720        captureResult.sort();
1721
1722        // Check that there's a timestamp in the result metadata
1723
1724        camera_metadata_entry entry =
1725                captureResult.find(ANDROID_SENSOR_TIMESTAMP);
1726        if (entry.count == 0) {
1727            SET_ERR("No timestamp provided by HAL for frame %d!",
1728                    frameNumber);
1729            gotResult = false;
1730        } else if (timestamp != entry.data.i64[0]) {
1731            SET_ERR("Timestamp mismatch between shutter notify and result"
1732                    " metadata for frame %d (%lld vs %lld respectively)",
1733                    frameNumber, timestamp, entry.data.i64[0]);
1734            gotResult = false;
1735        }
1736
1737        if (gotResult) {
1738            // Valid result, insert into queue
1739            CameraMetadata& queuedResult =
1740                *mResultQueue.insert(mResultQueue.end(), CameraMetadata());
1741            queuedResult.swap(captureResult);
1742        }
1743    } // scope for mOutputLock
1744
1745    // Return completed buffers to their streams with the timestamp
1746
1747    for (size_t i = 0; i < result->num_output_buffers; i++) {
1748        Camera3Stream *stream =
1749                Camera3Stream::cast(result->output_buffers[i].stream);
1750        res = stream->returnBuffer(result->output_buffers[i], timestamp);
1751        // Note: stream may be deallocated at this point, if this buffer was the
1752        // last reference to it.
1753        if (res != OK) {
1754            ALOGE("Can't return buffer %d for frame %d to its stream: "
1755                    " %s (%d)", i, frameNumber, strerror(-res), res);
1756        }
1757    }
1758
1759    // Finally, signal any waiters for new frames
1760
1761    if (gotResult) {
1762        mResultSignal.signal();
1763    }
1764
1765}
1766
1767
1768
1769void Camera3Device::notify(const camera3_notify_msg *msg) {
1770    ATRACE_CALL();
1771    NotificationListener *listener;
1772    {
1773        Mutex::Autolock l(mOutputLock);
1774        listener = mListener;
1775    }
1776
1777    if (msg == NULL) {
1778        SET_ERR("HAL sent NULL notify message!");
1779        return;
1780    }
1781
1782    switch (msg->type) {
1783        case CAMERA3_MSG_ERROR: {
1784            int streamId = 0;
1785            if (msg->message.error.error_stream != NULL) {
1786                Camera3Stream *stream =
1787                        Camera3Stream::cast(
1788                                  msg->message.error.error_stream);
1789                streamId = stream->getId();
1790            }
1791            ALOGV("Camera %d: %s: HAL error, frame %d, stream %d: %d",
1792                    mId, __FUNCTION__, msg->message.error.frame_number,
1793                    streamId, msg->message.error.error_code);
1794
1795            // Set request error status for the request in the in-flight tracking
1796            {
1797                Mutex::Autolock l(mInFlightLock);
1798                ssize_t idx = mInFlightMap.indexOfKey(msg->message.error.frame_number);
1799                if (idx >= 0) {
1800                    mInFlightMap.editValueAt(idx).requestStatus = msg->message.error.error_code;
1801                }
1802            }
1803
1804            if (listener != NULL) {
1805                listener->notifyError(msg->message.error.error_code,
1806                        msg->message.error.frame_number, streamId);
1807            }
1808            break;
1809        }
1810        case CAMERA3_MSG_SHUTTER: {
1811            ssize_t idx;
1812            uint32_t frameNumber = msg->message.shutter.frame_number;
1813            nsecs_t timestamp = msg->message.shutter.timestamp;
1814            // Verify ordering of shutter notifications
1815            {
1816                Mutex::Autolock l(mOutputLock);
1817                if (frameNumber != mNextShutterFrameNumber) {
1818                    SET_ERR("Shutter notification out-of-order. Expected "
1819                            "notification for frame %d, got frame %d",
1820                            mNextShutterFrameNumber, frameNumber);
1821                    break;
1822                }
1823                mNextShutterFrameNumber++;
1824            }
1825
1826            int32_t requestId = -1;
1827
1828            // Set timestamp for the request in the in-flight tracking
1829            // and get the request ID to send upstream
1830            {
1831                Mutex::Autolock l(mInFlightLock);
1832                idx = mInFlightMap.indexOfKey(frameNumber);
1833                if (idx >= 0) {
1834                    InFlightRequest &r = mInFlightMap.editValueAt(idx);
1835                    r.captureTimestamp = timestamp;
1836                    requestId = r.requestId;
1837                }
1838            }
1839            if (idx < 0) {
1840                SET_ERR("Shutter notification for non-existent frame number %d",
1841                        frameNumber);
1842                break;
1843            }
1844            ALOGVV("Camera %d: %s: Shutter fired for frame %d (id %d) at %lld",
1845                    mId, __FUNCTION__, frameNumber, requestId, timestamp);
1846            // Call listener, if any
1847            if (listener != NULL) {
1848                listener->notifyShutter(requestId, timestamp);
1849            }
1850            break;
1851        }
1852        default:
1853            SET_ERR("Unknown notify message from HAL: %d",
1854                    msg->type);
1855    }
1856}
1857
1858CameraMetadata Camera3Device::getLatestRequestLocked() {
1859    ALOGV("%s", __FUNCTION__);
1860
1861    CameraMetadata retVal;
1862
1863    if (mRequestThread != NULL) {
1864        retVal = mRequestThread->getLatestRequest();
1865    }
1866
1867    return retVal;
1868}
1869
1870/**
1871 * RequestThread inner class methods
1872 */
1873
1874Camera3Device::RequestThread::RequestThread(wp<Camera3Device> parent,
1875        sp<StatusTracker> statusTracker,
1876        camera3_device_t *hal3Device) :
1877        Thread(false),
1878        mParent(parent),
1879        mStatusTracker(statusTracker),
1880        mHal3Device(hal3Device),
1881        mId(getId(parent)),
1882        mReconfigured(false),
1883        mDoPause(false),
1884        mPaused(true),
1885        mFrameNumber(0),
1886        mLatestRequestId(NAME_NOT_FOUND) {
1887    mStatusId = statusTracker->addComponent();
1888}
1889
1890void Camera3Device::RequestThread::configurationComplete() {
1891    Mutex::Autolock l(mRequestLock);
1892    mReconfigured = true;
1893}
1894
1895status_t Camera3Device::RequestThread::queueRequest(
1896         sp<CaptureRequest> request) {
1897    Mutex::Autolock l(mRequestLock);
1898    mRequestQueue.push_back(request);
1899
1900    unpauseForNewRequests();
1901
1902    return OK;
1903}
1904
1905
1906status_t Camera3Device::RequestThread::queueTrigger(
1907        RequestTrigger trigger[],
1908        size_t count) {
1909
1910    Mutex::Autolock l(mTriggerMutex);
1911    status_t ret;
1912
1913    for (size_t i = 0; i < count; ++i) {
1914        ret = queueTriggerLocked(trigger[i]);
1915
1916        if (ret != OK) {
1917            return ret;
1918        }
1919    }
1920
1921    return OK;
1922}
1923
1924int Camera3Device::RequestThread::getId(const wp<Camera3Device> &device) {
1925    sp<Camera3Device> d = device.promote();
1926    if (d != NULL) return d->mId;
1927    return 0;
1928}
1929
1930status_t Camera3Device::RequestThread::queueTriggerLocked(
1931        RequestTrigger trigger) {
1932
1933    uint32_t tag = trigger.metadataTag;
1934    ssize_t index = mTriggerMap.indexOfKey(tag);
1935
1936    switch (trigger.getTagType()) {
1937        case TYPE_BYTE:
1938        // fall-through
1939        case TYPE_INT32:
1940            break;
1941        default:
1942            ALOGE("%s: Type not supported: 0x%x", __FUNCTION__,
1943                    trigger.getTagType());
1944            return INVALID_OPERATION;
1945    }
1946
1947    /**
1948     * Collect only the latest trigger, since we only have 1 field
1949     * in the request settings per trigger tag, and can't send more than 1
1950     * trigger per request.
1951     */
1952    if (index != NAME_NOT_FOUND) {
1953        mTriggerMap.editValueAt(index) = trigger;
1954    } else {
1955        mTriggerMap.add(tag, trigger);
1956    }
1957
1958    return OK;
1959}
1960
1961status_t Camera3Device::RequestThread::setRepeatingRequests(
1962        const RequestList &requests) {
1963    Mutex::Autolock l(mRequestLock);
1964    mRepeatingRequests.clear();
1965    mRepeatingRequests.insert(mRepeatingRequests.begin(),
1966            requests.begin(), requests.end());
1967
1968    unpauseForNewRequests();
1969
1970    return OK;
1971}
1972
1973status_t Camera3Device::RequestThread::clearRepeatingRequests() {
1974    Mutex::Autolock l(mRequestLock);
1975    mRepeatingRequests.clear();
1976    return OK;
1977}
1978
1979status_t Camera3Device::RequestThread::clear() {
1980    Mutex::Autolock l(mRequestLock);
1981    mRepeatingRequests.clear();
1982    mRequestQueue.clear();
1983    mTriggerMap.clear();
1984    return OK;
1985}
1986
1987void Camera3Device::RequestThread::setPaused(bool paused) {
1988    Mutex::Autolock l(mPauseLock);
1989    mDoPause = paused;
1990    mDoPauseSignal.signal();
1991}
1992
1993status_t Camera3Device::RequestThread::waitUntilRequestProcessed(
1994        int32_t requestId, nsecs_t timeout) {
1995    Mutex::Autolock l(mLatestRequestMutex);
1996    status_t res;
1997    while (mLatestRequestId != requestId) {
1998        nsecs_t startTime = systemTime();
1999
2000        res = mLatestRequestSignal.waitRelative(mLatestRequestMutex, timeout);
2001        if (res != OK) return res;
2002
2003        timeout -= (systemTime() - startTime);
2004    }
2005
2006    return OK;
2007}
2008
2009void Camera3Device::RequestThread::requestExit() {
2010    // Call parent to set up shutdown
2011    Thread::requestExit();
2012    // The exit from any possible waits
2013    mDoPauseSignal.signal();
2014    mRequestSignal.signal();
2015}
2016
2017bool Camera3Device::RequestThread::threadLoop() {
2018
2019    status_t res;
2020
2021    // Handle paused state.
2022    if (waitIfPaused()) {
2023        return true;
2024    }
2025
2026    // Get work to do
2027
2028    sp<CaptureRequest> nextRequest = waitForNextRequest();
2029    if (nextRequest == NULL) {
2030        return true;
2031    }
2032
2033    // Create request to HAL
2034    camera3_capture_request_t request = camera3_capture_request_t();
2035    Vector<camera3_stream_buffer_t> outputBuffers;
2036
2037    // Get the request ID, if any
2038    int requestId;
2039    camera_metadata_entry_t requestIdEntry =
2040            nextRequest->mSettings.find(ANDROID_REQUEST_ID);
2041    if (requestIdEntry.count > 0) {
2042        requestId = requestIdEntry.data.i32[0];
2043    } else {
2044        ALOGW("%s: Did not have android.request.id set in the request",
2045                __FUNCTION__);
2046        requestId = NAME_NOT_FOUND;
2047    }
2048
2049    // Insert any queued triggers (before metadata is locked)
2050    int32_t triggerCount;
2051    res = insertTriggers(nextRequest);
2052    if (res < 0) {
2053        SET_ERR("RequestThread: Unable to insert triggers "
2054                "(capture request %d, HAL device: %s (%d)",
2055                (mFrameNumber+1), strerror(-res), res);
2056        cleanUpFailedRequest(request, nextRequest, outputBuffers);
2057        return false;
2058    }
2059    triggerCount = res;
2060
2061    bool triggersMixedIn = (triggerCount > 0 || mPrevTriggers > 0);
2062
2063    // If the request is the same as last, or we had triggers last time
2064    if (mPrevRequest != nextRequest || triggersMixedIn) {
2065        /**
2066         * HAL workaround:
2067         * Insert a dummy trigger ID if a trigger is set but no trigger ID is
2068         */
2069        res = addDummyTriggerIds(nextRequest);
2070        if (res != OK) {
2071            SET_ERR("RequestThread: Unable to insert dummy trigger IDs "
2072                    "(capture request %d, HAL device: %s (%d)",
2073                    (mFrameNumber+1), strerror(-res), res);
2074            cleanUpFailedRequest(request, nextRequest, outputBuffers);
2075            return false;
2076        }
2077
2078        /**
2079         * The request should be presorted so accesses in HAL
2080         *   are O(logn). Sidenote, sorting a sorted metadata is nop.
2081         */
2082        nextRequest->mSettings.sort();
2083        request.settings = nextRequest->mSettings.getAndLock();
2084        mPrevRequest = nextRequest;
2085        ALOGVV("%s: Request settings are NEW", __FUNCTION__);
2086
2087        IF_ALOGV() {
2088            camera_metadata_ro_entry_t e = camera_metadata_ro_entry_t();
2089            find_camera_metadata_ro_entry(
2090                    request.settings,
2091                    ANDROID_CONTROL_AF_TRIGGER,
2092                    &e
2093            );
2094            if (e.count > 0) {
2095                ALOGV("%s: Request (frame num %d) had AF trigger 0x%x",
2096                      __FUNCTION__,
2097                      mFrameNumber+1,
2098                      e.data.u8[0]);
2099            }
2100        }
2101    } else {
2102        // leave request.settings NULL to indicate 'reuse latest given'
2103        ALOGVV("%s: Request settings are REUSED",
2104               __FUNCTION__);
2105    }
2106
2107    camera3_stream_buffer_t inputBuffer;
2108
2109    // Fill in buffers
2110
2111    if (nextRequest->mInputStream != NULL) {
2112        request.input_buffer = &inputBuffer;
2113        res = nextRequest->mInputStream->getInputBuffer(&inputBuffer);
2114        if (res != OK) {
2115            ALOGE("RequestThread: Can't get input buffer, skipping request:"
2116                    " %s (%d)", strerror(-res), res);
2117            cleanUpFailedRequest(request, nextRequest, outputBuffers);
2118            return true;
2119        }
2120    } else {
2121        request.input_buffer = NULL;
2122    }
2123
2124    outputBuffers.insertAt(camera3_stream_buffer_t(), 0,
2125            nextRequest->mOutputStreams.size());
2126    request.output_buffers = outputBuffers.array();
2127    for (size_t i = 0; i < nextRequest->mOutputStreams.size(); i++) {
2128        res = nextRequest->mOutputStreams.editItemAt(i)->
2129                getBuffer(&outputBuffers.editItemAt(i));
2130        if (res != OK) {
2131            ALOGE("RequestThread: Can't get output buffer, skipping request:"
2132                    " %s (%d)", strerror(-res), res);
2133            cleanUpFailedRequest(request, nextRequest, outputBuffers);
2134            return true;
2135        }
2136        request.num_output_buffers++;
2137    }
2138
2139    request.frame_number = mFrameNumber++;
2140
2141    // Log request in the in-flight queue
2142    sp<Camera3Device> parent = mParent.promote();
2143    if (parent == NULL) {
2144        CLOGE("RequestThread: Parent is gone");
2145        cleanUpFailedRequest(request, nextRequest, outputBuffers);
2146        return false;
2147    }
2148
2149    res = parent->registerInFlight(request.frame_number, requestId,
2150            request.num_output_buffers);
2151    if (res != OK) {
2152        SET_ERR("RequestThread: Unable to register new in-flight request:"
2153                " %s (%d)", strerror(-res), res);
2154        cleanUpFailedRequest(request, nextRequest, outputBuffers);
2155        return false;
2156    }
2157
2158    // Inform waitUntilRequestProcessed thread of a new request ID
2159    {
2160        Mutex::Autolock al(mLatestRequestMutex);
2161
2162        mLatestRequestId = requestId;
2163        mLatestRequestSignal.signal();
2164    }
2165
2166    // Submit request and block until ready for next one
2167    ATRACE_ASYNC_BEGIN("frame capture", request.frame_number);
2168    ATRACE_BEGIN("camera3->process_capture_request");
2169    res = mHal3Device->ops->process_capture_request(mHal3Device, &request);
2170    ATRACE_END();
2171
2172    if (res != OK) {
2173        SET_ERR("RequestThread: Unable to submit capture request %d to HAL"
2174                " device: %s (%d)", request.frame_number, strerror(-res), res);
2175        cleanUpFailedRequest(request, nextRequest, outputBuffers);
2176        return false;
2177    }
2178
2179    // Update the latest request sent to HAL
2180    if (request.settings != NULL) { // Don't update them if they were unchanged
2181        Mutex::Autolock al(mLatestRequestMutex);
2182
2183        camera_metadata_t* cloned = clone_camera_metadata(request.settings);
2184        mLatestRequest.acquire(cloned);
2185    }
2186
2187    if (request.settings != NULL) {
2188        nextRequest->mSettings.unlock(request.settings);
2189    }
2190
2191    // Remove any previously queued triggers (after unlock)
2192    res = removeTriggers(mPrevRequest);
2193    if (res != OK) {
2194        SET_ERR("RequestThread: Unable to remove triggers "
2195              "(capture request %d, HAL device: %s (%d)",
2196              request.frame_number, strerror(-res), res);
2197        return false;
2198    }
2199    mPrevTriggers = triggerCount;
2200
2201    // Return input buffer back to framework
2202    if (request.input_buffer != NULL) {
2203        Camera3Stream *stream =
2204            Camera3Stream::cast(request.input_buffer->stream);
2205        res = stream->returnInputBuffer(*(request.input_buffer));
2206        // Note: stream may be deallocated at this point, if this buffer was the
2207        // last reference to it.
2208        if (res != OK) {
2209            ALOGE("%s: RequestThread: Can't return input buffer for frame %d to"
2210                    "  its stream:%s (%d)",  __FUNCTION__,
2211                    request.frame_number, strerror(-res), res);
2212            // TODO: Report error upstream
2213        }
2214    }
2215
2216    return true;
2217}
2218
2219CameraMetadata Camera3Device::RequestThread::getLatestRequest() const {
2220    Mutex::Autolock al(mLatestRequestMutex);
2221
2222    ALOGV("RequestThread::%s", __FUNCTION__);
2223
2224    return mLatestRequest;
2225}
2226
2227void Camera3Device::RequestThread::cleanUpFailedRequest(
2228        camera3_capture_request_t &request,
2229        sp<CaptureRequest> &nextRequest,
2230        Vector<camera3_stream_buffer_t> &outputBuffers) {
2231
2232    if (request.settings != NULL) {
2233        nextRequest->mSettings.unlock(request.settings);
2234    }
2235    if (request.input_buffer != NULL) {
2236        request.input_buffer->status = CAMERA3_BUFFER_STATUS_ERROR;
2237        nextRequest->mInputStream->returnInputBuffer(*(request.input_buffer));
2238    }
2239    for (size_t i = 0; i < request.num_output_buffers; i++) {
2240        outputBuffers.editItemAt(i).status = CAMERA3_BUFFER_STATUS_ERROR;
2241        nextRequest->mOutputStreams.editItemAt(i)->returnBuffer(
2242            outputBuffers[i], 0);
2243    }
2244}
2245
2246sp<Camera3Device::CaptureRequest>
2247        Camera3Device::RequestThread::waitForNextRequest() {
2248    status_t res;
2249    sp<CaptureRequest> nextRequest;
2250
2251    // Optimized a bit for the simple steady-state case (single repeating
2252    // request), to avoid putting that request in the queue temporarily.
2253    Mutex::Autolock l(mRequestLock);
2254
2255    while (mRequestQueue.empty()) {
2256        if (!mRepeatingRequests.empty()) {
2257            // Always atomically enqueue all requests in a repeating request
2258            // list. Guarantees a complete in-sequence set of captures to
2259            // application.
2260            const RequestList &requests = mRepeatingRequests;
2261            RequestList::const_iterator firstRequest =
2262                    requests.begin();
2263            nextRequest = *firstRequest;
2264            mRequestQueue.insert(mRequestQueue.end(),
2265                    ++firstRequest,
2266                    requests.end());
2267            // No need to wait any longer
2268            break;
2269        }
2270
2271        res = mRequestSignal.waitRelative(mRequestLock, kRequestTimeout);
2272
2273        if ((mRequestQueue.empty() && mRepeatingRequests.empty()) ||
2274                exitPending()) {
2275            Mutex::Autolock pl(mPauseLock);
2276            if (mPaused == false) {
2277                ALOGV("%s: RequestThread: Going idle", __FUNCTION__);
2278                mPaused = true;
2279                // Let the tracker know
2280                sp<StatusTracker> statusTracker = mStatusTracker.promote();
2281                if (statusTracker != 0) {
2282                    statusTracker->markComponentIdle(mStatusId, Fence::NO_FENCE);
2283                }
2284            }
2285            // Stop waiting for now and let thread management happen
2286            return NULL;
2287        }
2288    }
2289
2290    if (nextRequest == NULL) {
2291        // Don't have a repeating request already in hand, so queue
2292        // must have an entry now.
2293        RequestList::iterator firstRequest =
2294                mRequestQueue.begin();
2295        nextRequest = *firstRequest;
2296        mRequestQueue.erase(firstRequest);
2297    }
2298
2299    // In case we've been unpaused by setPaused clearing mDoPause, need to
2300    // update internal pause state (capture/setRepeatingRequest unpause
2301    // directly).
2302    Mutex::Autolock pl(mPauseLock);
2303    if (mPaused) {
2304        ALOGV("%s: RequestThread: Unpaused", __FUNCTION__);
2305        sp<StatusTracker> statusTracker = mStatusTracker.promote();
2306        if (statusTracker != 0) {
2307            statusTracker->markComponentActive(mStatusId);
2308        }
2309    }
2310    mPaused = false;
2311
2312    // Check if we've reconfigured since last time, and reset the preview
2313    // request if so. Can't use 'NULL request == repeat' across configure calls.
2314    if (mReconfigured) {
2315        mPrevRequest.clear();
2316        mReconfigured = false;
2317    }
2318
2319    return nextRequest;
2320}
2321
2322bool Camera3Device::RequestThread::waitIfPaused() {
2323    status_t res;
2324    Mutex::Autolock l(mPauseLock);
2325    while (mDoPause) {
2326        if (mPaused == false) {
2327            mPaused = true;
2328            ALOGV("%s: RequestThread: Paused", __FUNCTION__);
2329            // Let the tracker know
2330            sp<StatusTracker> statusTracker = mStatusTracker.promote();
2331            if (statusTracker != 0) {
2332                statusTracker->markComponentIdle(mStatusId, Fence::NO_FENCE);
2333            }
2334        }
2335
2336        res = mDoPauseSignal.waitRelative(mPauseLock, kRequestTimeout);
2337        if (res == TIMED_OUT || exitPending()) {
2338            return true;
2339        }
2340    }
2341    // We don't set mPaused to false here, because waitForNextRequest needs
2342    // to further manage the paused state in case of starvation.
2343    return false;
2344}
2345
2346void Camera3Device::RequestThread::unpauseForNewRequests() {
2347    // With work to do, mark thread as unpaused.
2348    // If paused by request (setPaused), don't resume, to avoid
2349    // extra signaling/waiting overhead to waitUntilPaused
2350    mRequestSignal.signal();
2351    Mutex::Autolock p(mPauseLock);
2352    if (!mDoPause) {
2353        ALOGV("%s: RequestThread: Going active", __FUNCTION__);
2354        if (mPaused) {
2355            sp<StatusTracker> statusTracker = mStatusTracker.promote();
2356            if (statusTracker != 0) {
2357                statusTracker->markComponentActive(mStatusId);
2358            }
2359        }
2360        mPaused = false;
2361    }
2362}
2363
2364void Camera3Device::RequestThread::setErrorState(const char *fmt, ...) {
2365    sp<Camera3Device> parent = mParent.promote();
2366    if (parent != NULL) {
2367        va_list args;
2368        va_start(args, fmt);
2369
2370        parent->setErrorStateV(fmt, args);
2371
2372        va_end(args);
2373    }
2374}
2375
2376status_t Camera3Device::RequestThread::insertTriggers(
2377        const sp<CaptureRequest> &request) {
2378
2379    Mutex::Autolock al(mTriggerMutex);
2380
2381    CameraMetadata &metadata = request->mSettings;
2382    size_t count = mTriggerMap.size();
2383
2384    for (size_t i = 0; i < count; ++i) {
2385        RequestTrigger trigger = mTriggerMap.valueAt(i);
2386
2387        uint32_t tag = trigger.metadataTag;
2388        camera_metadata_entry entry = metadata.find(tag);
2389
2390        if (entry.count > 0) {
2391            /**
2392             * Already has an entry for this trigger in the request.
2393             * Rewrite it with our requested trigger value.
2394             */
2395            RequestTrigger oldTrigger = trigger;
2396
2397            oldTrigger.entryValue = entry.data.u8[0];
2398
2399            mTriggerReplacedMap.add(tag, oldTrigger);
2400        } else {
2401            /**
2402             * More typical, no trigger entry, so we just add it
2403             */
2404            mTriggerRemovedMap.add(tag, trigger);
2405        }
2406
2407        status_t res;
2408
2409        switch (trigger.getTagType()) {
2410            case TYPE_BYTE: {
2411                uint8_t entryValue = static_cast<uint8_t>(trigger.entryValue);
2412                res = metadata.update(tag,
2413                                      &entryValue,
2414                                      /*count*/1);
2415                break;
2416            }
2417            case TYPE_INT32:
2418                res = metadata.update(tag,
2419                                      &trigger.entryValue,
2420                                      /*count*/1);
2421                break;
2422            default:
2423                ALOGE("%s: Type not supported: 0x%x",
2424                      __FUNCTION__,
2425                      trigger.getTagType());
2426                return INVALID_OPERATION;
2427        }
2428
2429        if (res != OK) {
2430            ALOGE("%s: Failed to update request metadata with trigger tag %s"
2431                  ", value %d", __FUNCTION__, trigger.getTagName(),
2432                  trigger.entryValue);
2433            return res;
2434        }
2435
2436        ALOGV("%s: Mixed in trigger %s, value %d", __FUNCTION__,
2437              trigger.getTagName(),
2438              trigger.entryValue);
2439    }
2440
2441    mTriggerMap.clear();
2442
2443    return count;
2444}
2445
2446status_t Camera3Device::RequestThread::removeTriggers(
2447        const sp<CaptureRequest> &request) {
2448    Mutex::Autolock al(mTriggerMutex);
2449
2450    CameraMetadata &metadata = request->mSettings;
2451
2452    /**
2453     * Replace all old entries with their old values.
2454     */
2455    for (size_t i = 0; i < mTriggerReplacedMap.size(); ++i) {
2456        RequestTrigger trigger = mTriggerReplacedMap.valueAt(i);
2457
2458        status_t res;
2459
2460        uint32_t tag = trigger.metadataTag;
2461        switch (trigger.getTagType()) {
2462            case TYPE_BYTE: {
2463                uint8_t entryValue = static_cast<uint8_t>(trigger.entryValue);
2464                res = metadata.update(tag,
2465                                      &entryValue,
2466                                      /*count*/1);
2467                break;
2468            }
2469            case TYPE_INT32:
2470                res = metadata.update(tag,
2471                                      &trigger.entryValue,
2472                                      /*count*/1);
2473                break;
2474            default:
2475                ALOGE("%s: Type not supported: 0x%x",
2476                      __FUNCTION__,
2477                      trigger.getTagType());
2478                return INVALID_OPERATION;
2479        }
2480
2481        if (res != OK) {
2482            ALOGE("%s: Failed to restore request metadata with trigger tag %s"
2483                  ", trigger value %d", __FUNCTION__,
2484                  trigger.getTagName(), trigger.entryValue);
2485            return res;
2486        }
2487    }
2488    mTriggerReplacedMap.clear();
2489
2490    /**
2491     * Remove all new entries.
2492     */
2493    for (size_t i = 0; i < mTriggerRemovedMap.size(); ++i) {
2494        RequestTrigger trigger = mTriggerRemovedMap.valueAt(i);
2495        status_t res = metadata.erase(trigger.metadataTag);
2496
2497        if (res != OK) {
2498            ALOGE("%s: Failed to erase metadata with trigger tag %s"
2499                  ", trigger value %d", __FUNCTION__,
2500                  trigger.getTagName(), trigger.entryValue);
2501            return res;
2502        }
2503    }
2504    mTriggerRemovedMap.clear();
2505
2506    return OK;
2507}
2508
2509status_t Camera3Device::RequestThread::addDummyTriggerIds(
2510        const sp<CaptureRequest> &request) {
2511    // Trigger ID 0 has special meaning in the HAL2 spec, so avoid it here
2512    static const int32_t dummyTriggerId = 1;
2513    status_t res;
2514
2515    CameraMetadata &metadata = request->mSettings;
2516
2517    // If AF trigger is active, insert a dummy AF trigger ID if none already
2518    // exists
2519    camera_metadata_entry afTrigger = metadata.find(ANDROID_CONTROL_AF_TRIGGER);
2520    camera_metadata_entry afId = metadata.find(ANDROID_CONTROL_AF_TRIGGER_ID);
2521    if (afTrigger.count > 0 &&
2522            afTrigger.data.u8[0] != ANDROID_CONTROL_AF_TRIGGER_IDLE &&
2523            afId.count == 0) {
2524        res = metadata.update(ANDROID_CONTROL_AF_TRIGGER_ID, &dummyTriggerId, 1);
2525        if (res != OK) return res;
2526    }
2527
2528    // If AE precapture trigger is active, insert a dummy precapture trigger ID
2529    // if none already exists
2530    camera_metadata_entry pcTrigger =
2531            metadata.find(ANDROID_CONTROL_AE_PRECAPTURE_TRIGGER);
2532    camera_metadata_entry pcId = metadata.find(ANDROID_CONTROL_AE_PRECAPTURE_ID);
2533    if (pcTrigger.count > 0 &&
2534            pcTrigger.data.u8[0] != ANDROID_CONTROL_AE_PRECAPTURE_TRIGGER_IDLE &&
2535            pcId.count == 0) {
2536        res = metadata.update(ANDROID_CONTROL_AE_PRECAPTURE_ID,
2537                &dummyTriggerId, 1);
2538        if (res != OK) return res;
2539    }
2540
2541    return OK;
2542}
2543
2544
2545/**
2546 * Static callback forwarding methods from HAL to instance
2547 */
2548
2549void Camera3Device::sProcessCaptureResult(const camera3_callback_ops *cb,
2550        const camera3_capture_result *result) {
2551    Camera3Device *d =
2552            const_cast<Camera3Device*>(static_cast<const Camera3Device*>(cb));
2553    d->processCaptureResult(result);
2554}
2555
2556void Camera3Device::sNotify(const camera3_callback_ops *cb,
2557        const camera3_notify_msg *msg) {
2558    Camera3Device *d =
2559            const_cast<Camera3Device*>(static_cast<const Camera3Device*>(cb));
2560    d->notify(msg);
2561}
2562
2563}; // namespace android
2564