• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_PRODUCER_SURFACE_H
17 #define FRAMEWORKS_SURFACE_INCLUDE_PRODUCER_SURFACE_H
18 
19 #include <atomic>
20 #include <map>
21 #include <string>
22 
23 #include <surface.h>
24 #include <ibuffer_producer.h>
25 
26 #include "buffer_queue.h"
27 #include "buffer_queue_consumer.h"
28 #include "surface_buffer.h"
29 
30 namespace OHOS {
31 class ProducerSurface : public Surface {
32 public:
33     ProducerSurface(sptr<IBufferProducer>& producer);
34     virtual ~ProducerSurface();
35 
36     // thread unsafe
37     GSError Init();
38 
39     bool IsConsumer() const override;
40     sptr<IBufferProducer> GetProducer() const override;
41     GSError RequestBuffer(sptr<SurfaceBuffer>& buffer,
42                           int32_t &fence, BufferRequestConfig &config) override;
43 
44     GSError CancelBuffer(sptr<SurfaceBuffer>& buffer) override;
45 
46     GSError FlushBuffer(sptr<SurfaceBuffer>& buffer,
47                         int32_t fence, BufferFlushConfig &config) override;
48 
49     GSError AcquireBuffer(sptr<SurfaceBuffer>& buffer, int32_t &fence,
50                           int64_t &timestamp, Rect &damage) override;
51     GSError ReleaseBuffer(sptr<SurfaceBuffer>& buffer, int32_t fence) override;
52 
53     GSError RequestBuffer(sptr<SurfaceBuffer>& buffer,
54                           sptr<SyncFence>& fence, BufferRequestConfig &config) override;
55     GSError FlushBuffer(sptr<SurfaceBuffer>& buffer,
56                         const sptr<SyncFence>& fence, BufferFlushConfig &config) override;
57     GSError AcquireBuffer(sptr<SurfaceBuffer>& buffer, sptr<SyncFence>& fence,
58                           int64_t &timestamp, Rect &damage) override;
59     GSError ReleaseBuffer(sptr<SurfaceBuffer>& buffer, const sptr<SyncFence>& fence) override;
60 
61     GSError AttachBuffer(sptr<SurfaceBuffer>& buffer) override;
62 
63     GSError DetachBuffer(sptr<SurfaceBuffer>& buffer) override;
64 
65     uint32_t GetQueueSize() override;
66     GSError SetQueueSize(uint32_t queueSize) override;
67 
68     const std::string& GetName() override;
69     uint64_t GetUniqueId() const override;
70 
71     GSError SetDefaultWidthAndHeight(int32_t width, int32_t height) override;
72     int32_t GetDefaultWidth() override;
73     int32_t GetDefaultHeight() override;
74     GSError SetDefaultUsage(uint32_t usage) override;
75     uint32_t GetDefaultUsage() override;
76 
77     GSError SetUserData(const std::string &key, const std::string &val) override;
78     std::string GetUserData(const std::string &key) override;
79 
80     GSError RegisterConsumerListener(sptr<IBufferConsumerListener>& listener) override;
81     GSError RegisterConsumerListener(IBufferConsumerListenerClazz *listener) override;
82     GSError RegisterReleaseListener(OnReleaseFunc func) override;
83     GSError RegisterDeleteBufferListener(OnDeleteBufferFunc func) override;
84     GSError UnregisterConsumerListener() override;
85 
Dump(std::string & result)86     void Dump(std::string &result) const override {};
87 
88     // Call carefully. This interface will empty all caches of the current process
89     GSError CleanCache() override;
90     GSError GoBackground() override;
91 
92     GSError SetTransform(GraphicTransformType transform) override;
93     GraphicTransformType GetTransform() const override;
94 
95     GSError IsSupportedAlloc(const std::vector<BufferVerifyAllocInfo> &infos, std::vector<bool> &supporteds) override;
96     GSError Disconnect() override;
97     GSError SetScalingMode(uint32_t sequence, ScalingMode scalingMode) override;
98     GSError GetScalingMode(uint32_t sequence, ScalingMode &scalingMode) override;
99     GSError SetMetaData(uint32_t sequence, const std::vector<GraphicHDRMetaData> &metaData) override;
100     GSError SetMetaDataSet(uint32_t sequence, GraphicHDRMetadataKey key, const std::vector<uint8_t> &metaData) override;
101     GSError QueryMetaDataType(uint32_t sequence, HDRMetaDataType &type) const override;
102     GSError GetMetaData(uint32_t sequence, std::vector<GraphicHDRMetaData> &metaData) const override;
103     GSError GetMetaDataSet(uint32_t sequence, GraphicHDRMetadataKey &key,
104                            std::vector<uint8_t> &metaData) const override;
105     GSError SetTunnelHandle(const GraphicExtDataHandle *handle) override;
106     sptr<SurfaceTunnelHandle> GetTunnelHandle() const override;
107     GSError SetPresentTimestamp(uint32_t sequence, const GraphicPresentTimestamp &timestamp) override;
108     GSError GetPresentTimestamp(uint32_t sequence, GraphicPresentTimestampType type, int64_t &time) const override;
109 
110     int32_t GetDefaultFormat() override;
111     GSError SetDefaultFormat(int32_t format) override;
112     int32_t GetDefaultColorGamut() override;
113     GSError SetDefaultColorGamut(int32_t colorGamut) override;
114 
115     sptr<NativeSurface> GetNativeSurface() override;
116 
117 private:
118     bool IsRemote();
119 
120     std::mutex mutex_;
121     std::atomic_bool inited_ = false;
122     std::map<int32_t, sptr<SurfaceBuffer>> bufferProducerCache_;
123     std::map<std::string, std::string> userData_;
124     sptr<IBufferProducer> producer_ = nullptr;
125     std::string name_ = "not init";
126     uint64_t queueId_ = 0;
127     bool isDisconnected = true;
128 };
129 } // namespace OHOS
130 
131 #endif // FRAMEWORKS_SURFACE_INCLUDE_PRODUCER_SURFACE_H
132