1 /*
2  * Copyright (c) 2021 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef FRAMEWORKS_SURFACE_INCLUDE_BUFFER_QUEUE_CONSUMER_H
17 #define FRAMEWORKS_SURFACE_INCLUDE_BUFFER_QUEUE_CONSUMER_H
18 
19 #include <refbase.h>
20 
21 #include "surface_type.h"
22 #include "surface_buffer.h"
23 #include "buffer_queue.h"
24 
25 namespace OHOS {
26 class BufferQueueConsumer : public RefBase {
27 public:
28     BufferQueueConsumer(sptr<BufferQueue>& bufferQueue);
29     virtual ~BufferQueueConsumer();
30 
31     GSError AcquireBuffer(sptr<SurfaceBuffer> &buffer, sptr<SyncFence> &fence,
32                                int64_t &timestamp, std::vector<Rect> &damages);
33     GSError AcquireBuffer(IConsumerSurface::AcquireBufferReturnValue &returnValue, int64_t expectPresentTimestamp,
34                           bool isUsingAutoTimestamp);
35     GSError ReleaseBuffer(sptr<SurfaceBuffer>& buffer, const sptr<SyncFence>& fence);
36 
37     GSError AttachBuffer(sptr<SurfaceBuffer>& buffer);
38     GSError AttachBuffer(sptr<SurfaceBuffer>& buffer, int32_t timeOut);
39 
40     GSError DetachBuffer(sptr<SurfaceBuffer>& buffer);
41     GSError RegisterSurfaceDelegator(sptr<IRemoteObject> client, sptr<Surface> cSurface);
42 
43     bool QueryIfBufferAvailable();
44 
45     GSError RegisterConsumerListener(sptr<IBufferConsumerListener>& listener);
46     GSError RegisterConsumerListener(IBufferConsumerListenerClazz *listener);
47     GSError RegisterReleaseListener(OnReleaseFunc func);
48     GSError RegisterDeleteBufferListener(OnDeleteBufferFunc func, bool isForUniRedraw = false);
49     GSError UnregisterConsumerListener();
50 
51     GSError SetDefaultWidthAndHeight(int32_t width, int32_t height);
52     GSError SetDefaultUsage(uint64_t usage);
53     void Dump(std::string &result) const;
54     GraphicTransformType GetTransform() const;
55     GSError GetScalingMode(uint32_t sequence, ScalingMode &scalingMode) const;
56     GSError QueryMetaDataType(uint32_t sequence, HDRMetaDataType &type) const;
57     GSError GetMetaData(uint32_t sequence, std::vector<GraphicHDRMetaData> &metaData) const;
58     GSError GetMetaDataSet(uint32_t sequence, GraphicHDRMetadataKey &key, std::vector<uint8_t> &metaData) const;
59     sptr<SurfaceTunnelHandle> GetTunnelHandle() const;
60     GSError SetPresentTimestamp(uint32_t sequence, const GraphicPresentTimestamp &timestamp);
61 
62     bool GetStatus() const;
63     void SetStatus(bool status);
64     GSError OnConsumerDied();
65     GSError GoBackground();
ConsumerRequestCpuAccess(bool on)66     void ConsumerRequestCpuAccess(bool on)
67     {
68         bufferQueue_->ConsumerRequestCpuAccess(on);
69     }
70 
71     GSError AttachBufferToQueue(sptr<SurfaceBuffer> buffer);
72     GSError DetachBufferFromQueue(sptr<SurfaceBuffer> buffer);
73     void SetBufferHold(bool hold);
IsBufferHold()74     inline bool IsBufferHold()
75     {
76         if (bufferQueue_ == nullptr) {
77             return false;
78         }
79         return bufferQueue_->IsBufferHold();
80     }
81     float GetHdrWhitePointBrightness() const;
82     float GetSdrWhitePointBrightness() const;
83     GSError IsSurfaceBufferInCache(uint32_t seqNum, bool &isInCache);
84     uint32_t GetAvailableBufferCount() const;
85 private:
86     sptr<BufferQueue> bufferQueue_ = nullptr;
87     std::string name_ = "not init";
88 };
89 } // namespace OHOS
90 
91 #endif // FRAMEWORKS_SURFACE_INCLUDE_BUFFER_QUEUE_CONSUMER_H
92