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 INTERFACES_INNERKITS_SURFACE_ICONSUMER_SURFACE_H 17 #define INTERFACES_INNERKITS_SURFACE_ICONSUMER_SURFACE_H 18 19 #include <refbase.h> 20 21 #include "ibuffer_consumer_listener.h" 22 #include "ibuffer_producer.h" 23 #include "surface.h" 24 #include "surface_buffer.h" 25 #include "surface_type.h" 26 #include "surface_tunnel_handle.h" 27 28 namespace OHOS { 29 class IConsumerSurface : public Surface { 30 public: 31 static sptr<IConsumerSurface> Create(std::string name = "noname", bool isShared = false); 32 33 virtual ~IConsumerSurface() = default; 34 35 virtual bool IsConsumer() const = 0; 36 virtual sptr<IBufferProducer> GetProducer() const = 0; 37 38 virtual GSError RequestBuffer(sptr<SurfaceBuffer>& buffer, 39 int32_t &fence, BufferRequestConfig &config) = 0; 40 41 virtual GSError CancelBuffer(sptr<SurfaceBuffer>& buffer) = 0; 42 43 virtual GSError FlushBuffer(sptr<SurfaceBuffer>& buffer, 44 int32_t fence, BufferFlushConfig &config) = 0; 45 46 virtual GSError AcquireBuffer(sptr<SurfaceBuffer>& buffer, int32_t &fence, 47 int64_t ×tamp, Rect &damage) = 0; 48 virtual GSError ReleaseBuffer(sptr<SurfaceBuffer>& buffer, int32_t fence) = 0; 49 50 virtual GSError RequestBuffer(sptr<SurfaceBuffer>& buffer, 51 sptr<SyncFence>& fence, BufferRequestConfig &config) = 0; 52 virtual GSError FlushBuffer(sptr<SurfaceBuffer>& buffer, 53 const sptr<SyncFence>& fence, BufferFlushConfig &config) = 0; 54 virtual GSError AcquireBuffer(sptr<SurfaceBuffer>& buffer, sptr<SyncFence>& fence, 55 int64_t ×tamp, Rect &damage) = 0; 56 virtual GSError ReleaseBuffer(sptr<SurfaceBuffer>& buffer, const sptr<SyncFence>& fence) = 0; 57 58 virtual GSError AttachBuffer(sptr<SurfaceBuffer>& buffer) = 0; 59 60 virtual GSError DetachBuffer(sptr<SurfaceBuffer>& buffer) = 0; 61 62 virtual uint32_t GetQueueSize() = 0; 63 virtual GSError SetQueueSize(uint32_t queueSize) = 0; 64 65 virtual GSError SetDefaultWidthAndHeight(int32_t width, int32_t height) = 0; 66 virtual int32_t GetDefaultWidth() = 0; 67 virtual int32_t GetDefaultHeight() = 0; 68 69 virtual GSError SetDefaultUsage(uint32_t usage) = 0; 70 virtual uint32_t GetDefaultUsage() = 0; 71 72 virtual GSError SetUserData(const std::string &key, const std::string &val) = 0; 73 virtual std::string GetUserData(const std::string &key) = 0; 74 75 virtual const std::string& GetName() = 0; 76 virtual uint64_t GetUniqueId() const = 0; 77 78 virtual GSError RegisterConsumerListener(sptr<IBufferConsumerListener>& listener) = 0; 79 virtual GSError RegisterConsumerListener(IBufferConsumerListenerClazz *listener) = 0; 80 virtual GSError RegisterReleaseListener(OnReleaseFunc func) = 0; 81 virtual GSError RegisterDeleteBufferListener(OnDeleteBufferFunc func, bool isForUniRedraw = false) = 0; 82 virtual GSError UnregisterConsumerListener() = 0; 83 84 // Call carefully. This interface will empty all caches of the current process 85 virtual GSError CleanCache() = 0; 86 virtual GSError GoBackground() = 0; 87 88 virtual GSError SetTransform(GraphicTransformType transform) = 0; 89 virtual GraphicTransformType GetTransform() const = 0; 90 91 virtual GSError IsSupportedAlloc(const std::vector<BufferVerifyAllocInfo> &infos, 92 std::vector<bool> &supporteds) = 0; 93 virtual GSError Disconnect() = 0; 94 virtual GSError SetScalingMode(uint32_t sequence, ScalingMode scalingMode) = 0; 95 virtual GSError GetScalingMode(uint32_t sequence, ScalingMode &scalingMode) = 0; 96 virtual GSError SetMetaData(uint32_t sequence, const std::vector<GraphicHDRMetaData> &metaData) = 0; 97 virtual GSError SetMetaDataSet(uint32_t sequence, GraphicHDRMetadataKey key, 98 const std::vector<uint8_t> &metaData) = 0; 99 virtual GSError QueryMetaDataType(uint32_t sequence, HDRMetaDataType &type) const = 0; 100 virtual GSError GetMetaData(uint32_t sequence, std::vector<GraphicHDRMetaData> &metaData) const = 0; 101 virtual GSError GetMetaDataSet(uint32_t sequence, GraphicHDRMetadataKey &key, 102 std::vector<uint8_t> &metaData) const = 0; 103 virtual GSError SetTunnelHandle(const GraphicExtDataHandle *handle) = 0; 104 virtual sptr<SurfaceTunnelHandle> GetTunnelHandle() const = 0; 105 virtual GSError SetPresentTimestamp(uint32_t sequence, const GraphicPresentTimestamp ×tamp) = 0; 106 virtual GSError GetPresentTimestamp(uint32_t sequence, GraphicPresentTimestampType type, 107 int64_t &time) const = 0; 108 virtual void Dump(std::string &result) const = 0; 109 110 virtual int32_t GetDefaultFormat() = 0; 111 virtual GSError SetDefaultFormat(int32_t format) = 0; 112 virtual int32_t GetDefaultColorGamut() = 0; 113 virtual GSError SetDefaultColorGamut(int32_t colorGamut) = 0; 114 115 virtual sptr<NativeSurface> GetNativeSurface() = 0; 116 117 virtual bool QueryIfBufferAvailable() = 0; 118 119 virtual GSError AcquireBuffer(sptr<SurfaceBuffer>& buffer, sptr<SyncFence>& fence, 120 int64_t ×tamp, std::vector<Rect> &damages) = 0; 121 virtual GSError FlushBuffer(sptr<SurfaceBuffer>& buffer, const sptr<SyncFence>& fence, 122 BufferFlushConfigWithDamages &config) = 0; 123 virtual GSError SetWptrNativeWindowToPSurface(void* nativeWindow) = 0; 124 virtual GSError GetLastFlushedBuffer(sptr<SurfaceBuffer>& buffer, 125 sptr<SyncFence>& fence, float matrix[16]) = 0; 126 virtual GSError AttachBuffer(sptr<SurfaceBuffer>& buffer, int32_t timeOut) = 0; 127 virtual GSError RegisterSurfaceDelegator(sptr<IRemoteObject> client) = 0; 128 virtual GSError RegisterReleaseListener(OnReleaseFuncWithFence func) = 0; 129 protected: 130 IConsumerSurface() = default; 131 }; 132 } // namespace OHOS 133 134 #endif // INTERFACES_INNERKITS_SURFACE_SURFACE_H 135