1 /*
2  * Copyright (C) 2013-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_CAMERA3_OUTPUT_STREAM_H
18 #define ANDROID_SERVERS_CAMERA3_OUTPUT_STREAM_H
19 
20 #include <utils/RefBase.h>
21 #include <gui/IProducerListener.h>
22 #include <gui/Surface.h>
23 
24 #include "utils/LatencyHistogram.h"
25 #include "Camera3Stream.h"
26 #include "Camera3IOStreamBase.h"
27 #include "Camera3OutputStreamInterface.h"
28 #include "Camera3BufferManager.h"
29 
30 namespace android {
31 
32 namespace camera3 {
33 
34 class Camera3BufferManager;
35 
36 /**
37  * Stream info structure that holds the necessary stream info for buffer manager to use for
38  * buffer allocation and management.
39  */
40 struct StreamInfo {
41     int streamId;
42     int streamSetId;
43     uint32_t width;
44     uint32_t height;
45     uint32_t format;
46     android_dataspace dataSpace;
47     uint64_t combinedUsage;
48     size_t totalBufferCount;
49     bool isConfigured;
50     explicit StreamInfo(int id = CAMERA3_STREAM_ID_INVALID,
51             int setId = CAMERA3_STREAM_SET_ID_INVALID,
52             uint32_t w = 0,
53             uint32_t h = 0,
54             uint32_t fmt = 0,
55             android_dataspace ds = HAL_DATASPACE_UNKNOWN,
56             uint64_t usage = 0,
57             size_t bufferCount = 0,
58             bool configured = false) :
streamIdStreamInfo59                 streamId(id),
60                 streamSetId(setId),
61                 width(w),
62                 height(h),
63                 format(fmt),
64                 dataSpace(ds),
65                 combinedUsage(usage),
66                 totalBufferCount(bufferCount),
67                 isConfigured(configured){}
68 };
69 
70 /**
71  * A class for managing a single stream of output data from the camera device.
72  */
73 class Camera3OutputStream :
74         public Camera3IOStreamBase,
75         public Camera3OutputStreamInterface {
76   public:
77     /**
78      * Set up a stream for formats that have 2 dimensions, such as RAW and YUV.
79      * A valid stream set id needs to be set to support buffer sharing between multiple
80      * streams.
81      */
82     Camera3OutputStream(int id, sp<Surface> consumer,
83             uint32_t width, uint32_t height, int format,
84             android_dataspace dataSpace, camera3_stream_rotation_t rotation,
85             nsecs_t timestampOffset, const String8& physicalCameraId,
86             int setId = CAMERA3_STREAM_SET_ID_INVALID);
87 
88     /**
89      * Set up a stream for formats that have a variable buffer size for the same
90      * dimensions, such as compressed JPEG.
91      * A valid stream set id needs to be set to support buffer sharing between multiple
92      * streams.
93      */
94     Camera3OutputStream(int id, sp<Surface> consumer,
95             uint32_t width, uint32_t height, size_t maxSize, int format,
96             android_dataspace dataSpace, camera3_stream_rotation_t rotation,
97             nsecs_t timestampOffset, const String8& physicalCameraId,
98             int setId = CAMERA3_STREAM_SET_ID_INVALID);
99 
100     /**
101      * Set up a stream with deferred consumer for formats that have 2 dimensions, such as
102      * RAW and YUV. The consumer must be set before using this stream for output. A valid
103      * stream set id needs to be set to support buffer sharing between multiple streams.
104      */
105     Camera3OutputStream(int id, uint32_t width, uint32_t height, int format,
106             uint64_t consumerUsage, android_dataspace dataSpace,
107             camera3_stream_rotation_t rotation, nsecs_t timestampOffset,
108             const String8& physicalCameraId,
109             int setId = CAMERA3_STREAM_SET_ID_INVALID);
110 
111     virtual ~Camera3OutputStream();
112 
113     /**
114      * Camera3Stream interface
115      */
116 
117     virtual void     dump(int fd, const Vector<String16> &args) const;
118 
119     /**
120      * Set the transform on the output stream; one of the
121      * HAL_TRANSFORM_* / NATIVE_WINDOW_TRANSFORM_* constants.
122      */
123     status_t         setTransform(int transform);
124 
125     /**
126      * Return if this output stream is for video encoding.
127      */
128     bool isVideoStream() const;
129     /**
130      * Return if this output stream is consumed by hardware composer.
131      */
132     bool isConsumedByHWComposer() const;
133 
134     /**
135      * Return if this output stream is consumed by hardware texture.
136      */
137     bool isConsumedByHWTexture() const;
138 
139     /**
140      * Return if the consumer configuration of this stream is deferred.
141      */
142     virtual bool isConsumerConfigurationDeferred(size_t surface_id) const;
143 
144     /**
145      * Set the consumer surfaces to the output stream.
146      */
147     virtual status_t setConsumers(const std::vector<sp<Surface>>& consumers);
148 
149     class BufferReleasedListener : public BnProducerListener {
150         public:
BufferReleasedListener(wp<Camera3OutputStream> parent)151           BufferReleasedListener(wp<Camera3OutputStream> parent) : mParent(parent) {}
152 
153           /**
154           * Implementation of IProducerListener, used to notify this stream that the consumer
155           * has returned a buffer and it is ready to return to Camera3BufferManager for reuse.
156           */
157           virtual void onBufferReleased();
158 
159         private:
160           wp<Camera3OutputStream> mParent;
161     };
162 
163     virtual status_t detachBuffer(sp<GraphicBuffer>* buffer, int* fenceFd);
164 
165     /**
166      * Notify that the buffer is being released to the buffer queue instead of
167      * being queued to the consumer.
168      */
169     virtual status_t notifyBufferReleased(ANativeWindowBuffer *anwBuffer);
170 
171     /**
172      * Drop buffers if dropping is true. If dropping is false, do not drop buffers.
173      */
174     virtual status_t dropBuffers(bool dropping) override;
175 
176     /**
177      * Query the physical camera id for the output stream.
178      */
179     virtual const String8& getPhysicalCameraId() const override;
180 
181     /**
182      * Set the graphic buffer manager to get/return the stream buffers.
183      *
184      * It is only legal to call this method when stream is in STATE_CONSTRUCTED state.
185      */
186     status_t setBufferManager(sp<Camera3BufferManager> bufferManager);
187 
188     /**
189      * Query the ouput surface id.
190      */
getSurfaceId(const sp<Surface> &)191     virtual ssize_t getSurfaceId(const sp<Surface> &/*surface*/) { return 0; }
192 
193     /**
194      * Update the stream output surfaces.
195      */
196     virtual status_t updateStream(const std::vector<sp<Surface>> &outputSurfaces,
197             const std::vector<OutputStreamInfo> &outputInfo,
198             const std::vector<size_t> &removedSurfaceIds,
199             KeyedVector<sp<Surface>, size_t> *outputMap/*out*/);
200 
201   protected:
202     Camera3OutputStream(int id, camera3_stream_type_t type,
203             uint32_t width, uint32_t height, int format,
204             android_dataspace dataSpace, camera3_stream_rotation_t rotation,
205             const String8& physicalCameraId,
206             uint64_t consumerUsage = 0, nsecs_t timestampOffset = 0,
207             int setId = CAMERA3_STREAM_SET_ID_INVALID);
208 
209     /**
210      * Note that we release the lock briefly in this function
211      */
212     virtual status_t returnBufferCheckedLocked(
213             const camera3_stream_buffer &buffer,
214             nsecs_t timestamp,
215             bool output,
216             /*out*/
217             sp<Fence> *releaseFenceOut);
218 
219     virtual status_t disconnectLocked();
220 
221     status_t getEndpointUsageForSurface(uint64_t *usage,
222             const sp<Surface>& surface) const;
223     status_t configureConsumerQueueLocked();
224 
225     // Consumer as the output of camera HAL
226     sp<Surface> mConsumer;
227 
getPresetConsumerUsage()228     uint64_t getPresetConsumerUsage() const { return mConsumerUsage; }
229 
230     static const nsecs_t       kDequeueBufferTimeout   = 1000000000; // 1 sec
231 
232     status_t getBufferLockedCommon(ANativeWindowBuffer** anb, int* fenceFd);
233 
234 
235   private:
236 
237     int               mTransform;
238 
239     virtual status_t  setTransformLocked(int transform);
240 
241     bool mTraceFirstBuffer;
242 
243     // Name of Surface consumer
244     String8           mConsumerName;
245 
246     // Whether consumer assumes MONOTONIC timestamp
247     bool mUseMonoTimestamp;
248 
249     /**
250      * GraphicBuffer manager this stream is registered to. Used to replace the buffer
251      * allocation/deallocation role of BufferQueue.
252      */
253     sp<Camera3BufferManager> mBufferManager;
254 
255     /**
256      * Buffer released listener, used to notify the buffer manager that a buffer is released
257      * from consumer side.
258      */
259     sp<BufferReleasedListener> mBufferReleasedListener;
260 
261     /**
262      * Flag indicating if the buffer manager is used to allocate the stream buffers
263      */
264     bool mUseBufferManager;
265 
266     /**
267      * Timestamp offset for video and hardware composer consumed streams
268      */
269     nsecs_t mTimestampOffset;
270 
271     /**
272      * Consumer end point usage flag set by the constructor for the deferred
273      * consumer case.
274      */
275     uint64_t    mConsumerUsage;
276 
277     // Whether to drop valid buffers.
278     bool mDropBuffers;
279 
280     /**
281      * Internal Camera3Stream interface
282      */
283     virtual status_t getBufferLocked(camera3_stream_buffer *buffer,
284             const std::vector<size_t>& surface_ids);
285 
286     virtual status_t returnBufferLocked(
287             const camera3_stream_buffer &buffer,
288             nsecs_t timestamp);
289 
290     virtual status_t queueBufferToConsumer(sp<ANativeWindow>& consumer,
291             ANativeWindowBuffer* buffer, int anwReleaseFence);
292 
293     virtual status_t configureQueueLocked();
294 
295     virtual status_t getEndpointUsage(uint64_t *usage) const;
296 
297     /**
298      * Private methods
299      */
300     void onBuffersRemovedLocked(const std::vector<sp<GraphicBuffer>>&);
301     status_t detachBufferLocked(sp<GraphicBuffer>* buffer, int* fenceFd);
302 
303     static const int32_t kDequeueLatencyBinSize = 5; // in ms
304     CameraLatencyHistogram mDequeueBufferLatency;
305 
306 }; // class Camera3OutputStream
307 
308 } // namespace camera3
309 
310 } // namespace android
311 
312 #endif
313