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 <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 Surface { 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 GSError RequestBuffer(sptr<SurfaceBuffer>& buffer, 38 int32_t &fence, BufferRequestConfig &config) override; 39 40 GSError CancelBuffer(sptr<SurfaceBuffer>& buffer) override; 41 42 GSError FlushBuffer(sptr<SurfaceBuffer>& buffer, 43 int32_t fence, BufferFlushConfig &config) override; 44 45 GSError AcquireBuffer(sptr<SurfaceBuffer>& buffer, int32_t &fence, 46 int64_t ×tamp, Rect &damage) override; 47 GSError ReleaseBuffer(sptr<SurfaceBuffer>& buffer, int32_t fence) override; 48 49 GSError RequestBuffer(sptr<SurfaceBuffer>& buffer, 50 sptr<SyncFence>& fence, BufferRequestConfig &config) override; 51 GSError FlushBuffer(sptr<SurfaceBuffer>& buffer, 52 const sptr<SyncFence>& fence, BufferFlushConfig &config) override; 53 GSError AcquireBuffer(sptr<SurfaceBuffer>& buffer, sptr<SyncFence>& fence, 54 int64_t ×tamp, Rect &damage) override; 55 GSError ReleaseBuffer(sptr<SurfaceBuffer>& buffer, const sptr<SyncFence>& fence) override; 56 57 GSError AttachBuffer(sptr<SurfaceBuffer>& buffer) override; 58 GSError DetachBuffer(sptr<SurfaceBuffer>& buffer) override; 59 60 uint32_t GetQueueSize() override; 61 GSError SetQueueSize(uint32_t queueSize) override; 62 63 const std::string& GetName() override; 64 65 GSError SetDefaultWidthAndHeight(int32_t width, int32_t height) override; 66 int32_t GetDefaultWidth() override; 67 int32_t GetDefaultHeight() override; 68 GSError SetDefaultUsage(uint32_t usage) override; 69 uint32_t GetDefaultUsage() override; 70 71 GSError SetUserData(const std::string &key, const std::string &val) override; 72 std::string GetUserData(const std::string &key) override; 73 74 GSError RegisterConsumerListener(sptr<IBufferConsumerListener>& listener) override; 75 GSError RegisterConsumerListener(IBufferConsumerListenerClazz *listener) override; 76 GSError RegisterReleaseListener(OnReleaseFunc func) override; 77 GSError RegisterDeleteBufferListener(OnDeleteBufferFunc func) override; 78 GSError UnregisterConsumerListener() override; 79 80 uint64_t GetUniqueId() const override; 81 82 void Dump(std::string &result) const override; 83 84 GSError CleanCache() override; 85 GSError GoBackground() override; 86 87 GSError SetTransform(GraphicTransformType transform) override; 88 GraphicTransformType GetTransform() const override; 89 90 GSError IsSupportedAlloc(const std::vector<BufferVerifyAllocInfo> &infos, std::vector<bool> &supporteds) override; 91 GSError Disconnect() override; 92 GSError SetScalingMode(uint32_t sequence, ScalingMode scalingMode) override; 93 GSError GetScalingMode(uint32_t sequence, ScalingMode &scalingMode) override; 94 GSError SetMetaData(uint32_t sequence, const std::vector<GraphicHDRMetaData> &metaData) override; 95 GSError SetMetaDataSet(uint32_t sequence, GraphicHDRMetadataKey key, const std::vector<uint8_t> &metaData) override; 96 GSError QueryMetaDataType(uint32_t sequence, HDRMetaDataType &type) const override; 97 GSError GetMetaData(uint32_t sequence, std::vector<GraphicHDRMetaData> &metaData) const override; 98 GSError GetMetaDataSet(uint32_t sequence, GraphicHDRMetadataKey &key, 99 std::vector<uint8_t> &metaData) const override; 100 GSError SetTunnelHandle(const GraphicExtDataHandle *handle) override; 101 sptr<SurfaceTunnelHandle> GetTunnelHandle() const override; 102 GSError SetPresentTimestamp(uint32_t sequence, const GraphicPresentTimestamp ×tamp) override; 103 GSError GetPresentTimestamp(uint32_t sequence, GraphicPresentTimestampType type, int64_t &time) const override; 104 105 int32_t GetDefaultFormat() override; 106 GSError SetDefaultFormat(int32_t format) override; 107 int32_t GetDefaultColorGamut() override; 108 GSError SetDefaultColorGamut(int32_t colorGamut) override; 109 110 sptr<NativeSurface> GetNativeSurface() override; 111 112 private: 113 std::map<std::string, std::string> userData_; 114 sptr<BufferQueueProducer> producer_ = nullptr; 115 sptr<BufferQueueConsumer> consumer_ = nullptr; 116 std::string name_ = "not init"; 117 bool isShared_ = false; 118 }; 119 } // namespace OHOS 120 121 #endif // FRAMEWORKS_SURFACE_INCLUDE_CONSUMER_SURFACE_H 122