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 #include <vector> 23 24 #include <surface.h> 25 #include <ibuffer_producer.h> 26 27 #include "buffer_queue.h" 28 #include "buffer_queue_consumer.h" 29 #include "surface_buffer.h" 30 #include "producer_surface_delegator.h" 31 32 struct NativeWindow; 33 namespace OHOS { 34 class ProducerSurface : public Surface { 35 public: 36 ProducerSurface(sptr<IBufferProducer>& producer); 37 virtual ~ProducerSurface(); 38 39 // thread unsafe 40 GSError Init(); 41 42 bool IsConsumer() const override; 43 sptr<IBufferProducer> GetProducer() const override; 44 GSError RequestBuffer(sptr<SurfaceBuffer>& buffer, 45 int32_t &fence, BufferRequestConfig &config) override; 46 47 GSError RequestBuffers(std::vector<sptr<SurfaceBuffer>> &buffers, 48 std::vector<sptr<SyncFence>> &fences, BufferRequestConfig &config) override; 49 50 GSError CancelBuffer(sptr<SurfaceBuffer>& buffer) override; 51 52 GSError FlushBuffer(sptr<SurfaceBuffer>& buffer, 53 int32_t fence, BufferFlushConfig &config) override; 54 55 GSError FlushBuffers(const std::vector<sptr<SurfaceBuffer>> &buffers, 56 const std::vector<sptr<SyncFence>> &fences, const std::vector<BufferFlushConfigWithDamages> &config) override; 57 58 GSError AcquireBuffer(sptr<SurfaceBuffer>& buffer, int32_t &fence, 59 int64_t ×tamp, Rect &damage) override; 60 GSError ReleaseBuffer(sptr<SurfaceBuffer>& buffer, int32_t fence) override; 61 62 GSError RequestBuffer(sptr<SurfaceBuffer>& buffer, 63 sptr<SyncFence>& fence, BufferRequestConfig &config) override; 64 GSError FlushBuffer(sptr<SurfaceBuffer>& buffer, 65 const sptr<SyncFence>& fence, BufferFlushConfig &config) override; 66 GSError GetLastFlushedBuffer(sptr<SurfaceBuffer>& buffer, 67 sptr<SyncFence>& fence, float matrix[16], bool isUseNewMatrix = false) override; 68 GSError FlushBuffer(sptr<SurfaceBuffer>& buffer, const sptr<SyncFence>& fence, 69 BufferFlushConfigWithDamages &config) override; 70 GSError AcquireBuffer(sptr<SurfaceBuffer>& buffer, sptr<SyncFence>& fence, 71 int64_t ×tamp, Rect &damage) override; 72 GSError ReleaseBuffer(sptr<SurfaceBuffer>& buffer, const sptr<SyncFence>& fence) override; 73 74 GSError AttachBuffer(sptr<SurfaceBuffer>& buffer) override; 75 GSError AttachBuffer(sptr<SurfaceBuffer>& buffer, int32_t timeOut) override; 76 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 uint64_t GetUniqueId() const override; 86 87 GSError SetDefaultWidthAndHeight(int32_t width, int32_t height) override; 88 int32_t GetDefaultWidth() override; 89 int32_t GetDefaultHeight() override; 90 GSError SetDefaultUsage(uint64_t usage) override; 91 uint64_t GetDefaultUsage() override; 92 void SetBufferHold(bool hold) override; 93 94 GSError SetUserData(const std::string &key, const std::string &val) override; 95 std::string GetUserData(const std::string &key) override; 96 97 GSError RegisterConsumerListener(sptr<IBufferConsumerListener>& listener) override; 98 GSError RegisterConsumerListener(IBufferConsumerListenerClazz *listener) override; 99 GSError RegisterReleaseListener(OnReleaseFunc func) override; 100 GSError RegisterReleaseListener(OnReleaseFuncWithFence func) override; 101 GSError UnRegisterReleaseListener() override; 102 GSError RegisterDeleteBufferListener(OnDeleteBufferFunc func, bool isForUniRedraw = false) override; 103 GSError UnregisterConsumerListener() override; 104 Dump(std::string & result)105 void Dump(std::string &result) const override {}; 106 107 // Call carefully. This interface will empty all caches of the current process 108 GSError CleanCache(bool cleanAll = false) override; 109 GSError GoBackground() override; 110 111 GSError SetTransform(GraphicTransformType transform) override; 112 GraphicTransformType GetTransform() const override; 113 114 GSError IsSupportedAlloc(const std::vector<BufferVerifyAllocInfo> &infos, std::vector<bool> &supporteds) override; 115 GSError Connect() override; 116 GSError Disconnect() override; 117 GSError SetScalingMode(uint32_t sequence, ScalingMode scalingMode) override; 118 GSError GetScalingMode(uint32_t sequence, ScalingMode &scalingMode) override; 119 GSError SetMetaData(uint32_t sequence, const std::vector<GraphicHDRMetaData> &metaData) override; 120 GSError SetMetaDataSet(uint32_t sequence, GraphicHDRMetadataKey key, const std::vector<uint8_t> &metaData) override; 121 GSError QueryMetaDataType(uint32_t sequence, HDRMetaDataType &type) const override; 122 GSError GetMetaData(uint32_t sequence, std::vector<GraphicHDRMetaData> &metaData) const override; 123 GSError GetMetaDataSet(uint32_t sequence, GraphicHDRMetadataKey &key, 124 std::vector<uint8_t> &metaData) const override; 125 GSError SetTunnelHandle(const GraphicExtDataHandle *handle) override; 126 sptr<SurfaceTunnelHandle> GetTunnelHandle() const override; 127 GSError SetPresentTimestamp(uint32_t sequence, const GraphicPresentTimestamp ×tamp) override; 128 GSError GetPresentTimestamp(uint32_t sequence, GraphicPresentTimestampType type, int64_t &time) const override; 129 130 int32_t GetDefaultFormat() override; 131 GSError SetDefaultFormat(int32_t format) override; 132 int32_t GetDefaultColorGamut() override; 133 GSError SetDefaultColorGamut(int32_t colorGamut) override; 134 135 sptr<NativeSurface> GetNativeSurface() override; 136 GSError SetWptrNativeWindowToPSurface(void* nativeWindow) override; 137 virtual GSError RegisterSurfaceDelegator(sptr<IRemoteObject> client) override; 138 GSError RegisterUserDataChangeListener(const std::string &funcName, OnUserDataChangeFunc func) override; 139 GSError UnRegisterUserDataChangeListener(const std::string &funcName) override; 140 GSError ClearUserDataChangeListener() override; 141 GSError AttachBufferToQueue(sptr<SurfaceBuffer> buffer) override; 142 GSError DetachBufferFromQueue(sptr<SurfaceBuffer> buffer) override; 143 GraphicTransformType GetTransformHint() const override; 144 GSError SetTransformHint(GraphicTransformType transformHint) override; 145 146 GSError GetProducerInitInfo(ProducerInitInfo &info) override; 147 148 void SetRequestWidthAndHeight(int32_t width, int32_t height) override; 149 int32_t GetRequestWidth() override; 150 int32_t GetRequestHeight() override; 151 152 BufferRequestConfig* GetWindowConfig() override; 153 GSError SetScalingMode(ScalingMode scalingMode) override; 154 155 GSError SetSurfaceSourceType(OHSurfaceSource sourceType) override; 156 OHSurfaceSource GetSurfaceSourceType() const override; 157 GSError SetSurfaceAppFrameworkType(std::string appFrameworkType) override; 158 std::string GetSurfaceAppFrameworkType() const override; 159 GSError SetHdrWhitePointBrightness(float brightness) override; 160 GSError SetSdrWhitePointBrightness(float brightness) override; 161 GSError AcquireLastFlushedBuffer(sptr<SurfaceBuffer> &buffer, sptr<SyncFence> &fence, 162 float matrix[16], uint32_t matrixSize, bool isUseNewMatrix) override; 163 GSError ReleaseLastFlushedBuffer(sptr<SurfaceBuffer> buffer) override; 164 GSError RequestAndDetachBuffer(sptr<SurfaceBuffer>& buffer, sptr<SyncFence>& fence, 165 BufferRequestConfig& config) override; 166 GSError AttachAndFlushBuffer(sptr<SurfaceBuffer>& buffer, const sptr<SyncFence>& fence, 167 BufferFlushConfig& config, bool needMap) override; 168 private: 169 bool IsRemote(); 170 void CleanAllLocked(); 171 GSError AddCacheLocked(sptr<BufferExtraData> &bedataimpl, 172 IBufferProducer::RequestBufferReturnValue &retval, BufferRequestConfig &config); 173 GSError SetMetadataValue(sptr<SurfaceBuffer>& buffer); 174 GSError CleanCacheLocked(bool cleanAll); 175 void SetBufferConfigLocked(sptr<BufferExtraData>& bedataimpl, 176 IBufferProducer::RequestBufferReturnValue& retval, BufferRequestConfig& config); 177 void DeleteCacheBufferLocked(sptr<BufferExtraData>& bedataimpl, 178 IBufferProducer::RequestBufferReturnValue& retval, BufferRequestConfig& config); 179 GSError UpdateCacheLocked(sptr<BufferExtraData>& bedataimpl, 180 IBufferProducer::RequestBufferReturnValue& retval, BufferRequestConfig& config); 181 182 mutable std::mutex mutex_; 183 std::atomic_bool inited_ = false; 184 std::map<int32_t, sptr<SurfaceBuffer>> bufferProducerCache_; 185 std::map<std::string, std::string> userData_; 186 sptr<IBufferProducer> producer_ = nullptr; 187 std::string name_ = "not init"; 188 uint64_t queueId_ = 0; 189 bool isDisconnected_ = true; 190 sptr<IProducerListener> listener_; 191 std::mutex listenerMutex_; 192 wptr<NativeWindow> wpNativeWindow_ = nullptr; 193 wptr<ProducerSurfaceDelegator> wpPSurfaceDelegator_ = nullptr; 194 std::mutex delegatorMutex_; 195 std::map<std::string, OnUserDataChangeFunc> onUserDataChange_; 196 std::mutex lockMutex_; 197 int32_t requestWidth_ = 0; 198 int32_t requestHeight_ = 0; 199 GraphicTransformType lastSetTransformHint_ = GraphicTransformType::GRAPHIC_ROTATE_NONE; 200 BufferRequestConfig windowConfig_ = {0}; 201 ProducerInitInfo initInfo_ = {0}; 202 }; 203 } // namespace OHOS 204 205 #endif // FRAMEWORKS_SURFACE_INCLUDE_PRODUCER_SURFACE_H 206