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 #include "producer_surface_delegator.h" 30 31 struct NativeWindow; 32 namespace OHOS { 33 class ProducerSurface : public Surface { 34 public: 35 ProducerSurface(sptr<IBufferProducer>& producer); 36 virtual ~ProducerSurface(); 37 38 // thread unsafe 39 GSError Init(); 40 41 bool IsConsumer() const override; 42 sptr<IBufferProducer> GetProducer() const override; 43 GSError RequestBuffer(sptr<SurfaceBuffer>& buffer, 44 int32_t &fence, 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 GSError ReleaseBuffer(sptr<SurfaceBuffer>& buffer, int32_t fence) override; 54 55 GSError RequestBuffer(sptr<SurfaceBuffer>& buffer, 56 sptr<SyncFence>& fence, BufferRequestConfig &config) override; 57 GSError FlushBuffer(sptr<SurfaceBuffer>& buffer, 58 const sptr<SyncFence>& fence, BufferFlushConfig &config) override; 59 GSError GetLastFlushedBuffer(sptr<SurfaceBuffer>& buffer, 60 sptr<SyncFence>& fence, float matrix[16]) override; 61 GSError FlushBuffer(sptr<SurfaceBuffer>& buffer, const sptr<SyncFence>& fence, 62 BufferFlushConfigWithDamages &config) override; 63 GSError AcquireBuffer(sptr<SurfaceBuffer>& buffer, sptr<SyncFence>& fence, 64 int64_t ×tamp, Rect &damage) override; 65 GSError ReleaseBuffer(sptr<SurfaceBuffer>& buffer, const sptr<SyncFence>& fence) override; 66 67 GSError AttachBuffer(sptr<SurfaceBuffer>& buffer) override; 68 GSError AttachBuffer(sptr<SurfaceBuffer>& buffer, int32_t timeOut) override; 69 70 GSError DetachBuffer(sptr<SurfaceBuffer>& buffer) override; 71 72 bool QueryIfBufferAvailable() override; 73 74 uint32_t GetQueueSize() override; 75 GSError SetQueueSize(uint32_t queueSize) override; 76 77 const std::string& GetName() override; 78 uint64_t GetUniqueId() const override; 79 80 GSError SetDefaultWidthAndHeight(int32_t width, int32_t height) override; 81 int32_t GetDefaultWidth() override; 82 int32_t GetDefaultHeight() override; 83 GSError SetDefaultUsage(uint32_t usage) override; 84 uint32_t GetDefaultUsage() override; 85 86 GSError SetUserData(const std::string &key, const std::string &val) override; 87 std::string GetUserData(const std::string &key) override; 88 89 GSError RegisterConsumerListener(sptr<IBufferConsumerListener>& listener) override; 90 GSError RegisterConsumerListener(IBufferConsumerListenerClazz *listener) override; 91 GSError RegisterReleaseListener(OnReleaseFunc func) override; 92 GSError RegisterReleaseListener(OnReleaseFuncWithFence func) override; 93 GSError UnRegisterReleaseListener() override; 94 GSError RegisterDeleteBufferListener(OnDeleteBufferFunc func, bool isForUniRedraw = false) override; 95 GSError UnregisterConsumerListener() override; 96 Dump(std::string & result)97 void Dump(std::string &result) const override {}; 98 99 // Call carefully. This interface will empty all caches of the current process 100 GSError CleanCache() override; 101 GSError GoBackground() override; 102 103 GSError SetTransform(GraphicTransformType transform) override; 104 GraphicTransformType GetTransform() const override; 105 106 GSError IsSupportedAlloc(const std::vector<BufferVerifyAllocInfo> &infos, std::vector<bool> &supporteds) override; 107 GSError Disconnect() override; 108 GSError SetScalingMode(uint32_t sequence, ScalingMode scalingMode) override; 109 GSError GetScalingMode(uint32_t sequence, ScalingMode &scalingMode) override; 110 GSError SetMetaData(uint32_t sequence, const std::vector<GraphicHDRMetaData> &metaData) override; 111 GSError SetMetaDataSet(uint32_t sequence, GraphicHDRMetadataKey key, const std::vector<uint8_t> &metaData) override; 112 GSError QueryMetaDataType(uint32_t sequence, HDRMetaDataType &type) const override; 113 GSError GetMetaData(uint32_t sequence, std::vector<GraphicHDRMetaData> &metaData) const override; 114 GSError GetMetaDataSet(uint32_t sequence, GraphicHDRMetadataKey &key, 115 std::vector<uint8_t> &metaData) const override; 116 GSError SetTunnelHandle(const GraphicExtDataHandle *handle) override; 117 sptr<SurfaceTunnelHandle> GetTunnelHandle() const override; 118 GSError SetPresentTimestamp(uint32_t sequence, const GraphicPresentTimestamp ×tamp) override; 119 GSError GetPresentTimestamp(uint32_t sequence, GraphicPresentTimestampType type, int64_t &time) const override; 120 121 int32_t GetDefaultFormat() override; 122 GSError SetDefaultFormat(int32_t format) override; 123 int32_t GetDefaultColorGamut() override; 124 GSError SetDefaultColorGamut(int32_t colorGamut) override; 125 126 sptr<NativeSurface> GetNativeSurface() override; 127 GSError SetWptrNativeWindowToPSurface(void* nativeWindow) override; 128 virtual GSError RegisterSurfaceDelegator(sptr<IRemoteObject> client) override; 129 private: 130 bool IsRemote(); 131 void CleanAllLocked(); 132 133 mutable std::mutex mutex_; 134 std::atomic_bool inited_ = false; 135 std::map<int32_t, sptr<SurfaceBuffer>> bufferProducerCache_; 136 std::map<std::string, std::string> userData_; 137 sptr<IBufferProducer> producer_ = nullptr; 138 std::string name_ = "not init"; 139 uint64_t queueId_ = 0; 140 bool isDisconnected = true; 141 sptr<IProducerListener> listener_; 142 wptr<NativeWindow> wpNativeWindow_ = nullptr; 143 wptr<ProducerSurfaceDelegator> wpPSurfaceDelegator_ = nullptr; 144 }; 145 } // namespace OHOS 146 147 #endif // FRAMEWORKS_SURFACE_INCLUDE_PRODUCER_SURFACE_H 148