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