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_CONSUMER_SURFACE_H 17 #define FRAMEWORKS_SURFACE_INCLUDE_CONSUMER_SURFACE_H 18 19 #include <map> 20 #include <string> 21 22 #include <iconsumer_surface.h> 23 24 #include "buffer_queue.h" 25 #include "buffer_queue_producer.h" 26 #include "buffer_queue_consumer.h" 27 28 namespace OHOS { 29 class ConsumerSurface : public IConsumerSurface { 30 public: 31 ConsumerSurface(const std::string &name, bool isShared = false); 32 virtual ~ConsumerSurface(); 33 GSError Init(); 34 35 bool IsConsumer() const override; 36 sptr<IBufferProducer> GetProducer() const override; 37 38 GSError GetProducerInitInfo(ProducerInitInfo &info) override; 39 40 GSError RequestBuffer(sptr<SurfaceBuffer>& buffer, 41 int32_t &fence, BufferRequestConfig &config) override; 42 43 GSError RequestBuffers(std::vector<sptr<SurfaceBuffer>> &buffers, 44 std::vector<sptr<SyncFence>> &fences, BufferRequestConfig &config) override; 45 46 GSError CancelBuffer(sptr<SurfaceBuffer>& buffer) override; 47 48 GSError FlushBuffer(sptr<SurfaceBuffer>& buffer, 49 int32_t fence, BufferFlushConfig &config) override; 50 51 GSError AcquireBuffer(sptr<SurfaceBuffer>& buffer, int32_t &fence, 52 int64_t ×tamp, Rect &damage) override; 53 54 GSError ReleaseBuffer(sptr<SurfaceBuffer>& buffer, int32_t fence) override; 55 56 GSError RequestBuffer(sptr<SurfaceBuffer>& buffer, 57 sptr<SyncFence>& fence, BufferRequestConfig &config) override; 58 GSError FlushBuffer(sptr<SurfaceBuffer>& buffer, 59 const sptr<SyncFence>& fence, BufferFlushConfig &config) override; 60 GSError FlushBuffer(sptr<SurfaceBuffer>& buffer, const sptr<SyncFence>& fence, 61 BufferFlushConfigWithDamages &config) override; 62 63 GSError FlushBuffers(const std::vector<sptr<SurfaceBuffer>> &buffers, 64 const std::vector<sptr<SyncFence>> &fences, const std::vector<BufferFlushConfigWithDamages> &config) override; 65 66 GSError GetLastFlushedBuffer(sptr<SurfaceBuffer>& buffer, 67 sptr<SyncFence>& fence, float matrix[16], bool isUseNewMatrix = false) override; 68 GSError AcquireBuffer(sptr<SurfaceBuffer>& buffer, sptr<SyncFence>& fence, 69 int64_t ×tamp, Rect &damage) override; 70 GSError AcquireBuffer(sptr<SurfaceBuffer>& buffer, sptr<SyncFence>& fence, 71 int64_t ×tamp, std::vector<Rect> &damages) override; 72 GSError AcquireBuffer(AcquireBufferReturnValue &returnValue, int64_t expectPresentTimestamp, 73 bool isUsingAutoTimestamp) override; 74 GSError ReleaseBuffer(sptr<SurfaceBuffer>& buffer, const sptr<SyncFence>& fence) override; 75 76 GSError AttachBuffer(sptr<SurfaceBuffer>& buffer) override; 77 GSError DetachBuffer(sptr<SurfaceBuffer>& buffer) override; 78 79 bool QueryIfBufferAvailable() override; 80 81 uint32_t GetQueueSize() override; 82 GSError SetQueueSize(uint32_t queueSize) override; 83 84 const std::string& GetName() override; 85 86 GSError SetDefaultWidthAndHeight(int32_t width, int32_t height) override; 87 int32_t GetDefaultWidth() override; 88 int32_t GetDefaultHeight() override; 89 GSError SetDefaultUsage(uint64_t usage) override; 90 uint64_t GetDefaultUsage() override; 91 92 GSError SetUserData(const std::string &key, const std::string &val) override; 93 std::string GetUserData(const std::string &key) override; 94 95 GSError RegisterConsumerListener(sptr<IBufferConsumerListener>& listener) override; 96 GSError RegisterConsumerListener(IBufferConsumerListenerClazz *listener) override; 97 GSError RegisterReleaseListener(OnReleaseFunc func) override; 98 GSError UnRegisterReleaseListener() override; 99 GSError RegisterDeleteBufferListener(OnDeleteBufferFunc func, bool isForUniRedraw = false) override; 100 GSError UnregisterConsumerListener() override; 101 102 uint64_t GetUniqueId() const override; 103 104 void Dump(std::string &result) const override; 105 106 GSError CleanCache(bool cleanAll = false) override; 107 GSError GoBackground() override; 108 109 GSError SetTransform(GraphicTransformType transform) override; 110 GraphicTransformType GetTransform() const override; 111 112 GSError IsSupportedAlloc(const std::vector<BufferVerifyAllocInfo> &infos, std::vector<bool> &supporteds) override; 113 GSError Connect() override; 114 GSError Disconnect() override; 115 GSError SetScalingMode(uint32_t sequence, ScalingMode scalingMode) override; 116 GSError GetScalingMode(uint32_t sequence, ScalingMode &scalingMode) override; 117 GSError SetMetaData(uint32_t sequence, const std::vector<GraphicHDRMetaData> &metaData) override; 118 GSError SetMetaDataSet(uint32_t sequence, GraphicHDRMetadataKey key, const std::vector<uint8_t> &metaData) override; 119 GSError QueryMetaDataType(uint32_t sequence, HDRMetaDataType &type) const override; 120 GSError GetMetaData(uint32_t sequence, std::vector<GraphicHDRMetaData> &metaData) const override; 121 GSError GetMetaDataSet(uint32_t sequence, GraphicHDRMetadataKey &key, 122 std::vector<uint8_t> &metaData) const override; 123 GSError SetTunnelHandle(const GraphicExtDataHandle *handle) override; 124 sptr<SurfaceTunnelHandle> GetTunnelHandle() const override; 125 GSError SetPresentTimestamp(uint32_t sequence, const GraphicPresentTimestamp ×tamp) override; 126 GSError GetPresentTimestamp(uint32_t sequence, GraphicPresentTimestampType type, int64_t &time) const override; 127 128 int32_t GetDefaultFormat() override; 129 GSError SetDefaultFormat(int32_t format) override; 130 int32_t GetDefaultColorGamut() override; 131 GSError SetDefaultColorGamut(int32_t colorGamut) override; 132 133 sptr<NativeSurface> GetNativeSurface() override; 134 GSError SetWptrNativeWindowToPSurface(void* nativeWindow) override; 135 GSError AttachBuffer(sptr<SurfaceBuffer>& buffer, int32_t timeOut) override; 136 GSError RegisterSurfaceDelegator(sptr<IRemoteObject> client) override; 137 GSError RegisterReleaseListener(OnReleaseFuncWithFence func) override; 138 GSError RegisterUserDataChangeListener(const std::string &funcName, OnUserDataChangeFunc func) override; 139 GSError UnRegisterUserDataChangeListener(const std::string &funcName) override; 140 GSError ClearUserDataChangeListener() override; 141 void ConsumerRequestCpuAccess(bool on) override; 142 GSError AttachBufferToQueue(sptr<SurfaceBuffer> buffer) override; 143 GSError DetachBufferFromQueue(sptr<SurfaceBuffer> buffer) override; 144 GraphicTransformType GetTransformHint() const override; 145 GSError SetTransformHint(GraphicTransformType transformHint) override; IsBufferHold()146 inline bool IsBufferHold() override 147 { 148 if (consumer_ == nullptr) { 149 return false; 150 } 151 return consumer_->IsBufferHold(); 152 } 153 void SetBufferHold(bool hold) override; 154 155 void SetRequestWidthAndHeight(int32_t width, int32_t height) override; 156 int32_t GetRequestWidth() override; 157 int32_t GetRequestHeight() override; 158 159 BufferRequestConfig* GetWindowConfig() override; 160 GSError SetScalingMode(ScalingMode scalingMode) override; 161 162 GSError SetSurfaceSourceType(OHSurfaceSource sourceType) override; 163 OHSurfaceSource GetSurfaceSourceType() const override; 164 GSError SetSurfaceAppFrameworkType(std::string appFrameworkType) override; 165 std::string GetSurfaceAppFrameworkType() const override; 166 167 GSError SetHdrWhitePointBrightness(float brightness) override; 168 GSError SetSdrWhitePointBrightness(float brightness) override; 169 float GetHdrWhitePointBrightness() const override; 170 float GetSdrWhitePointBrightness() const override; 171 172 GSError GetSurfaceBufferTransformType(sptr<SurfaceBuffer> buffer, GraphicTransformType *transformType) override; 173 GSError IsSurfaceBufferInCache(uint32_t seqNum, bool &isInCache) override; 174 GSError AcquireLastFlushedBuffer(sptr<SurfaceBuffer> &buffer, sptr<SyncFence> &fence, 175 float matrix[16], uint32_t matrixSize, bool isUseNewMatrix) override; 176 GSError ReleaseLastFlushedBuffer(sptr<SurfaceBuffer> buffer) override; 177 uint32_t GetAvailableBufferCount() const override; 178 private: 179 std::map<std::string, std::string> userData_; 180 sptr<BufferQueueProducer> producer_ = nullptr; 181 sptr<BufferQueueConsumer> consumer_ = nullptr; 182 std::string name_ = "not init"; 183 bool isShared_ = false; 184 std::map<std::string, OnUserDataChangeFunc> onUserDataChange_; 185 std::mutex lockMutex_; 186 uint64_t uniqueId_ = 0; 187 std::atomic<bool> hasRegistercallBackForRT_ = false; 188 std::atomic<bool> hasRegistercallBackForRedraw_ = false; 189 }; 190 } // namespace OHOS 191 192 #endif // FRAMEWORKS_SURFACE_INCLUDE_CONSUMER_SURFACE_H 193