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