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_IBUFFER_PRODUCER_H 17 #define INTERFACES_INNERKITS_SURFACE_IBUFFER_PRODUCER_H 18 19 #include <string> 20 #include <vector> 21 22 #include "iremote_broker.h" 23 24 #include "buffer_extra_data.h" 25 #include "ibuffer_producer_listener.h" 26 #include "native_surface.h" 27 #include "surface_buffer.h" 28 #include "surface_type.h" 29 30 namespace OHOS { 31 class SyncFence; 32 class IBufferProducerToken : public IRemoteBroker { 33 public: 34 DECLARE_INTERFACE_DESCRIPTOR(u"surf.IBufferProducerToken"); 35 36 IBufferProducerToken() = default; 37 virtual ~IBufferProducerToken() noexcept = default; 38 }; 39 class IBufferProducer : public IRemoteBroker { 40 public: 41 struct RequestBufferReturnValue { 42 uint32_t sequence; 43 sptr<SurfaceBuffer> buffer; 44 sptr<SyncFence> fence; 45 std::vector<int32_t> deletingBuffers; 46 }; 47 virtual GSError RequestBuffer(const BufferRequestConfig &config, sptr<BufferExtraData> &bedata, 48 RequestBufferReturnValue &retval) = 0; 49 50 virtual GSError CancelBuffer(uint32_t sequence, const sptr<BufferExtraData> &bedata) = 0; 51 52 virtual GSError FlushBuffer(uint32_t sequence, const sptr<BufferExtraData> &bedata, 53 const sptr<SyncFence>& fence, BufferFlushConfigWithDamages &config) = 0; 54 55 virtual GSError AttachBuffer(sptr<SurfaceBuffer>& buffer) = 0; 56 virtual GSError DetachBuffer(sptr<SurfaceBuffer>& buffer) = 0; 57 58 virtual uint32_t GetQueueSize() = 0; 59 virtual GSError SetQueueSize(uint32_t queueSize) = 0; 60 61 virtual GSError GetName(std::string &name) = 0; 62 virtual uint64_t GetUniqueId() = 0; 63 virtual GSError GetNameAndUniqueId(std::string& name, uint64_t& uniqueId) = 0; 64 65 virtual int32_t GetDefaultWidth() = 0; 66 virtual int32_t GetDefaultHeight() = 0; 67 virtual uint32_t GetDefaultUsage() = 0; 68 69 virtual GSError CleanCache() = 0; 70 virtual GSError GoBackground() = 0; 71 72 virtual GSError RegisterReleaseListener(sptr<IProducerListener> listener) = 0; 73 74 virtual GSError SetTransform(GraphicTransformType transform) = 0; 75 76 virtual GSError IsSupportedAlloc(const std::vector<BufferVerifyAllocInfo> &infos, 77 std::vector<bool> &supporteds) = 0; 78 79 virtual GSError Disconnect() = 0; 80 81 virtual GSError SetScalingMode(uint32_t sequence, ScalingMode scalingMode) = 0; 82 virtual GSError SetMetaData(uint32_t sequence, const std::vector<GraphicHDRMetaData> &metaData) = 0; 83 virtual GSError SetMetaDataSet(uint32_t sequence, GraphicHDRMetadataKey key, 84 const std::vector<uint8_t> &metaData) = 0; 85 virtual GSError SetTunnelHandle(const GraphicExtDataHandle *handle) = 0; 86 virtual GSError GetPresentTimestamp(uint32_t sequence, GraphicPresentTimestampType type, int64_t &time) = 0; 87 88 virtual sptr<NativeSurface> GetNativeSurface() = 0; 89 virtual GSError UnRegisterReleaseListener() = 0; 90 virtual GSError GetLastFlushedBuffer(sptr<SurfaceBuffer>& buffer, 91 sptr<SyncFence>& fence, float matrix[16]) = 0; 92 virtual GSError SendDeathRecipientObject() = 0; 93 virtual GSError AttachBuffer(sptr<SurfaceBuffer>& buffer, int32_t timeOut) = 0; 94 95 virtual GSError GetTransform(GraphicTransformType &transform) = 0; 96 97 DECLARE_INTERFACE_DESCRIPTOR(u"surf.IBufferProducer"); 98 99 protected: 100 enum { 101 BUFFER_PRODUCER_REQUEST_BUFFER = 0, 102 BUFFER_PRODUCER_CANCEL_BUFFER = 1, 103 BUFFER_PRODUCER_FLUSH_BUFFER = 2, 104 BUFFER_PRODUCER_GET_QUEUE_SIZE = 3, 105 BUFFER_PRODUCER_SET_QUEUE_SIZE = 4, 106 BUFFER_PRODUCER_GET_NAME = 5, 107 BUFFER_PRODUCER_GET_DEFAULT_WIDTH = 6, 108 BUFFER_PRODUCER_GET_DEFAULT_HEIGHT = 7, 109 BUFFER_PRODUCER_GET_DEFAULT_USAGE = 8, 110 BUFFER_PRODUCER_CLEAN_CACHE = 9, 111 BUFFER_PRODUCER_ATTACH_BUFFER = 10, 112 BUFFER_PRODUCER_DETACH_BUFFER = 11, 113 BUFFER_PRODUCER_REGISTER_RELEASE_LISTENER = 12, 114 BUFFER_PRODUCER_GET_UNIQUE_ID = 13, 115 BUFFER_PRODUCER_SET_TRANSFORM = 14, 116 BUFFER_PRODUCER_IS_SUPPORTED_ALLOC = 15, 117 BUFFER_PRODUCER_GET_NAMEANDUNIQUEDID = 16, 118 BUFFER_PRODUCER_DISCONNECT = 17, 119 BUFFER_PRODUCER_SET_SCALING_MODE = 18, 120 BUFFER_PRODUCER_SET_METADATA = 19, 121 BUFFER_PRODUCER_SET_METADATASET = 20, 122 BUFFER_PRODUCER_SET_TUNNEL_HANDLE = 21, 123 BUFFER_PRODUCER_GO_BACKGROUND = 22, 124 BUFFER_PRODUCER_GET_PRESENT_TIMESTAMP = 23, 125 BUFFER_PRODUCER_UNREGISTER_RELEASE_LISTENER = 24, 126 BUFFER_PRODUCER_GET_LAST_FLUSHED_BUFFER = 25, 127 BUFFER_PRODUCER_REGISTER_DEATH_RECIPIENT = 26, 128 BUFFER_PRODUCER_GET_TRANSFORM = 27, 129 }; 130 }; 131 } // namespace OHOS 132 133 #endif // INTERFACES_INNERKITS_SURFACE_IBUFFER_PRODUCER_H 134