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