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_CLIENT_PRODUCER_H
17 #define FRAMEWORKS_SURFACE_INCLUDE_BUFFER_CLIENT_PRODUCER_H
18 
19 #include <map>
20 #include <vector>
21 #include <mutex>
22 
23 #include <iremote_proxy.h>
24 #include <iremote_object.h>
25 
26 #include <ibuffer_producer.h>
27 
28 #include "surface_buffer_impl.h"
29 
30 namespace OHOS {
31 class BufferClientProducer : public IRemoteProxy<IBufferProducer> {
32 public:
33     BufferClientProducer(const sptr<IRemoteObject>& impl);
34     virtual ~BufferClientProducer();
35 
36     GSError GetProducerInitInfo(ProducerInitInfo &info) override;
37 
38     GSError RequestBuffer(const BufferRequestConfig &config, sptr<BufferExtraData> &bedata,
39                           RequestBufferReturnValue &retval) override;
40     GSError RequestBuffers(const BufferRequestConfig &config, std::vector<sptr<BufferExtraData>> &bedata,
41         std::vector<RequestBufferReturnValue> &retvalues) override;
42 
43     GSError CancelBuffer(uint32_t sequence, sptr<BufferExtraData> bedata) override;
44 
45     GSError FlushBuffer(uint32_t sequence, sptr<BufferExtraData> bedata,
46                         sptr<SyncFence> fence, BufferFlushConfigWithDamages &config) override;
47 
48     GSError FlushBuffers(const std::vector<uint32_t> &sequences,
49         const std::vector<sptr<BufferExtraData>> &bedata,
50         const std::vector<sptr<SyncFence>> &fences,
51         const std::vector<BufferFlushConfigWithDamages> &configs) override;
52 
53     GSError GetLastFlushedBuffer(sptr<SurfaceBuffer>& buffer,
54         sptr<SyncFence>& fence, float matrix[16], bool isUseNewMatrix) override;
55     uint32_t GetQueueSize() override;
56     GSError SetQueueSize(uint32_t queueSize) override;
57 
58     GSError GetName(std::string &name) override;
59     uint64_t GetUniqueId() override;
60     GSError GetNameAndUniqueId(std::string& name, uint64_t& uniqueId) override;
61 
62     int32_t GetDefaultWidth() override;
63     int32_t GetDefaultHeight() override;
64     GSError SetDefaultUsage(uint64_t usage) override;
65     uint64_t GetDefaultUsage() override;
66     GSError SetTransform(GraphicTransformType transform) override;
67 
68     GSError AttachBuffer(sptr<SurfaceBuffer>& buffer) override;
69     GSError AttachBuffer(sptr<SurfaceBuffer>& buffer, int32_t timeOut) override;
70     GSError DetachBuffer(sptr<SurfaceBuffer>& buffer) override;
71     GSError RegisterReleaseListener(sptr<IProducerListener> listener) override;
72     GSError UnRegisterReleaseListener() override;
73 
74     GSError IsSupportedAlloc(const std::vector<BufferVerifyAllocInfo> &infos, std::vector<bool> &supporteds) override;
75 
76     // Call carefully. This interface will empty all caches of the current process
77     GSError CleanCache(bool cleanAll) override;
78     GSError Connect() override;
79     GSError Disconnect() override;
80     GSError GoBackground() override;
81 
82     GSError SetScalingMode(uint32_t sequence, ScalingMode scalingMode) override;
83     GSError SetBufferHold(bool hold) override;
84     GSError SetMetaData(uint32_t sequence, const std::vector<GraphicHDRMetaData> &metaData) override;
85     GSError SetMetaDataSet(uint32_t sequence, GraphicHDRMetadataKey key,
86                            const std::vector<uint8_t> &metaData) override;
87     GSError SetTunnelHandle(const GraphicExtDataHandle *handle) override;
88     GSError GetPresentTimestamp(uint32_t sequence, GraphicPresentTimestampType type, int64_t &time) override;
89 
90     sptr<NativeSurface> GetNativeSurface() override;
91 
92     GSError GetTransform(GraphicTransformType &transform) override;
93     GSError AttachBufferToQueue(sptr<SurfaceBuffer> buffer) override;
94     GSError DetachBufferFromQueue(sptr<SurfaceBuffer> buffer) override;
95 
96     GSError GetTransformHint(GraphicTransformType &transformHint) override;
97     GSError SetTransformHint(GraphicTransformType transformHint) override;
98     GSError SetScalingMode(ScalingMode scalingMode) override;
99 
100     GSError SetSurfaceSourceType(OHSurfaceSource sourceType) override;
101     GSError GetSurfaceSourceType(OHSurfaceSource &sourceType) override;
102 
103     GSError SetSurfaceAppFrameworkType(std::string appFrameworkType) override;
104     GSError GetSurfaceAppFrameworkType(std::string &appFrameworkType) override;
105 
106     GSError SetHdrWhitePointBrightness(float brightness) override;
107     GSError SetSdrWhitePointBrightness(float brightness) override;
108 
109     GSError AcquireLastFlushedBuffer(sptr<SurfaceBuffer> &buffer, sptr<SyncFence> &fence,
110         float matrix[16], uint32_t matrixSize, bool isUseNewMatrix) override;
111     GSError ReleaseLastFlushedBuffer(uint32_t sequence) override;
112     GSError RequestAndDetachBuffer(const BufferRequestConfig& config, sptr<BufferExtraData>& bedata,
113         RequestBufferReturnValue& retval) override;
114     GSError AttachAndFlushBuffer(sptr<SurfaceBuffer>& buffer, sptr<BufferExtraData>& bedata,
115         const sptr<SyncFence>& fence, BufferFlushConfigWithDamages& config, bool needMap) override;
116 private:
117     GSError MessageVariables(MessageParcel &arg);
118     GSError SendRequest(uint32_t command, MessageParcel &arg, MessageParcel &reply, MessageOption &opt);
119     GSError CheckRetval(MessageParcel &reply);
120     GSError GetLastFlushedBufferCommon(sptr<SurfaceBuffer>& buffer,
121         sptr<SyncFence>& fence, float matrix[16], uint32_t matrixSize, bool isUseNewMatrix, uint32_t command);
122     GSError RequestBufferCommon(const BufferRequestConfig &config, sptr<BufferExtraData> &bedata,
123         RequestBufferReturnValue &retval, uint32_t command);
124 
125     static inline BrokerDelegator<BufferClientProducer> delegator_;
126     std::string name_ = "not init";
127     uint64_t uniqueId_ = 0;
128     std::mutex mutex_;
129     sptr<IBufferProducerToken> token_;
130     GraphicTransformType lastSetTransformType_ = GraphicTransformType::GRAPHIC_ROTATE_BUTT;
131 };
132 }; // namespace OHOS
133 
134 #endif // FRAMEWORKS_SURFACE_INCLUDE_BUFFER_CLIENT_PRODUCER_H
135