1 /*
2  * Copyright (C) 2018 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 #ifndef ANDROID_SERVERS_CAMERA_CAMERA3_COMPOSITE_STREAM_H
18 #define ANDROID_SERVERS_CAMERA_CAMERA3_COMPOSITE_STREAM_H
19 
20 #include <set>
21 #include <unordered_map>
22 
23 #include <android/hardware/camera2/ICameraDeviceCallbacks.h>
24 #include <camera/CameraMetadata.h>
25 #include <camera/camera2/OutputConfiguration.h>
26 #include <gui/IProducerListener.h>
27 #include "common/CameraDeviceBase.h"
28 #include "device3/Camera3StreamInterface.h"
29 
30 namespace android {
31 
32 class CameraDeviceClient;
33 class CameraMetadata;
34 class Surface;
35 
36 namespace camera3 {
37 
38 class CompositeStream : public camera3::Camera3StreamBufferListener {
39 
40 public:
41     CompositeStream(sp<CameraDeviceBase> device, wp<hardware::camera2::ICameraDeviceCallbacks> cb);
~CompositeStream()42     virtual ~CompositeStream() {}
43 
44     status_t createStream(const std::vector<sp<Surface>>& consumers,
45             bool hasDeferredConsumer, uint32_t width, uint32_t height, int format,
46             camera3_stream_rotation_t rotation, int *id, const String8& physicalCameraId,
47             std::vector<int> *surfaceIds, int streamSetId, bool isShared);
48 
49     status_t deleteStream();
50 
51     // Switch to offline mode and release any online resources.
52     void switchToOffline();
53 
54     // Create and register all internal camera streams.
55     virtual status_t createInternalStreams(const std::vector<sp<Surface>>& consumers,
56             bool hasDeferredConsumer, uint32_t width, uint32_t height, int format,
57             camera3_stream_rotation_t rotation, int *id, const String8& physicalCameraId,
58             std::vector<int> *surfaceIds, int streamSetId, bool isShared) = 0;
59 
60     // Release all internal streams and corresponding resources.
61     virtual status_t deleteInternalStreams() = 0;
62 
63     // Stream configuration completed.
64     virtual status_t configureStream() = 0;
65 
66     // Insert the internal composite stream id in the user capture request.
67     virtual status_t insertGbp(SurfaceMap* /*out*/outSurfaceMap,
68             Vector<int32_t>* /*out*/outputStreamIds, int32_t* /*out*/currentStreamId) = 0;
69 
70     // Attach the internal composite stream ids.
71     virtual status_t insertCompositeStreamIds(
72             std::vector<int32_t>* compositeStreamIds /*out*/) = 0;
73 
74     // Return composite stream id.
75     virtual int getStreamId() = 0;
76 
77     // Notify when shutter notify is triggered
onShutter(const CaptureResultExtras &,nsecs_t)78     virtual void onShutter(const CaptureResultExtras& /*resultExtras*/, nsecs_t /*timestamp*/) {}
79 
80     void onResultAvailable(const CaptureResult& result);
81     bool onError(int32_t errorCode, const CaptureResultExtras& resultExtras);
82 
83     // Camera3StreamBufferListener implementation
onBufferAcquired(const BufferInfo &)84     void onBufferAcquired(const BufferInfo& /*bufferInfo*/) override { /*Empty for now */ }
85     void onBufferReleased(const BufferInfo& bufferInfo) override;
86     void onBufferRequestForFrameNumber(uint64_t frameNumber, int streamId,
87             const CameraMetadata& settings) override;
88 
89 protected:
90     struct ProducerListener : public BnProducerListener {
91         // ProducerListener impementation
onBufferReleasedProducerListener92         void onBufferReleased() override { /*No impl. for now*/ };
93     };
94 
95     status_t registerCompositeStreamListener(int32_t streamId);
96     void eraseResult(int64_t frameNumber);
97     void flagAnErrorFrameNumber(int64_t frameNumber);
98     void notifyError(int64_t frameNumber, int32_t requestId);
99 
100     // Subclasses should check for buffer errors from internal streams and return 'true' in
101     // case the error notification should remain within camera service.
102     virtual bool onStreamBufferError(const CaptureResultExtras& resultExtras) = 0;
103 
104     // Subclasses can decide how to handle result errors depending on whether or not the
105     // internal processing needs result data.
106     virtual void onResultError(const CaptureResultExtras& resultExtras) = 0;
107 
108     // Subclasses can decide how to handle request errors depending on whether
109     // or not the internal processing needs clean up.
onRequestError(const CaptureResultExtras &)110     virtual void onRequestError(const CaptureResultExtras& /*resultExtras*/) {}
111 
112     // Device and/or service is in unrecoverable error state.
113     // Composite streams should behave accordingly.
114     void enableErrorState();
115 
116     wp<CameraDeviceBase>   mDevice;
117     wp<camera3::StatusTracker> mStatusTracker;
118     wp<hardware::camera2::ICameraDeviceCallbacks> mRemoteCallback;
119 
120     mutable Mutex          mMutex;
121     Condition              mInputReadyCondition;
122     int32_t                mNumPartialResults;
123     bool                   mErrorState;
124 
125     // Frame number to capture result map of partial pending request results.
126     std::unordered_map<uint64_t, CameraMetadata> mPendingCaptureResults;
127 
128     // Timestamp to capture (frame number, result) map of completed pending request results.
129     std::unordered_map<int64_t, std::tuple<int64_t, CameraMetadata>> mCaptureResults;
130 
131     // Frame number to timestamp map
132     std::unordered_map<int64_t, int64_t> mFrameNumberMap;
133 
134     // Keeps a set buffer/result frame numbers for any errors detected during processing.
135     std::set<int64_t> mErrorFrameNumbers;
136 
137 };
138 
139 }; //namespace camera3
140 }; //namespace android
141 
142 #endif
143