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_SURFACE_BUFFER_H 17 #define INTERFACES_INNERKITS_SURFACE_SURFACE_BUFFER_H 18 19 #include <functional> 20 21 #include <memory> 22 #include <refbase.h> 23 24 #include "buffer_handle_utils.h" 25 #include "surface_type.h" 26 #include "egl_data.h" 27 #include "buffer_extra_data.h" 28 #include "native_buffer.h" 29 30 struct BufferWrapper; 31 32 namespace OHOS { 33 class MessageParcel; 34 class SyncFence; 35 class SurfaceBuffer : public RefBase { 36 public: 37 virtual BufferHandle *GetBufferHandle() const = 0; 38 virtual int32_t GetWidth() const = 0; 39 virtual int32_t GetHeight() const = 0; 40 virtual int32_t GetStride() const = 0; 41 virtual int32_t GetFormat() const = 0; 42 virtual uint64_t GetUsage() const = 0; 43 virtual uint64_t GetPhyAddr() const = 0; 44 virtual void* GetVirAddr() = 0; 45 virtual int32_t GetFileDescriptor() const = 0; 46 virtual uint32_t GetSize() const = 0; 47 48 virtual GraphicColorGamut GetSurfaceBufferColorGamut() const = 0; 49 virtual GraphicTransformType GetSurfaceBufferTransform() const = 0; 50 virtual void SetSurfaceBufferColorGamut(const GraphicColorGamut& colorGamut) = 0; 51 virtual void SetSurfaceBufferTransform(const GraphicTransformType& transform) = 0; 52 53 virtual int32_t GetSurfaceBufferWidth() const = 0; 54 virtual int32_t GetSurfaceBufferHeight() const = 0; 55 virtual void SetSurfaceBufferWidth(int32_t width) = 0; 56 virtual void SetSurfaceBufferHeight(int32_t width) = 0; 57 58 virtual uint32_t GetSeqNum() const = 0; 59 60 // opt EglData 61 virtual sptr<EglData> GetEglData() const = 0; 62 virtual void SetEglData(const sptr<EglData>& data) = 0; 63 64 virtual void SetExtraData(sptr<BufferExtraData> bedata) = 0; 65 virtual sptr<BufferExtraData> GetExtraData() const = 0; 66 virtual GSError WriteToMessageParcel(MessageParcel &parcel) = 0; 67 virtual GSError ReadFromMessageParcel(MessageParcel &parcel) = 0; 68 virtual void SetBufferHandle(BufferHandle *handle) = 0; 69 70 virtual BufferWrapper GetBufferWrapper() = 0; 71 virtual void SetBufferWrapper(BufferWrapper wrapper) = 0; 72 73 // gralloc 74 virtual GSError Alloc(const BufferRequestConfig &config) = 0; 75 virtual GSError Map() = 0; 76 virtual GSError Unmap() = 0; 77 virtual GSError FlushCache() = 0; 78 virtual GSError InvalidateCache() = 0; 79 80 // metadata 81 /* 82 * @Description: SetMetadata 83 * @param key：Metadata key 84 * @param value：Metadata value 85 * @param enableCache：If true(default true), enable metaData cache optimization, 86 * when the same metaData is repeatedly set, the instruction count can be reduced. 87 * Prohibit setting different enableCache values for the same surfacebuffer object 88 * @return Returns GSERROR_OK if SetMetadata is successful; returns GErrorCode otherwise. 89 */ 90 virtual GSError SetMetadata(uint32_t key, const std::vector<uint8_t>& value, bool enableCache = true) = 0; 91 virtual GSError GetMetadata(uint32_t key, std::vector<uint8_t>& value) = 0; 92 virtual GSError ListMetadataKeys(std::vector<uint32_t>& keys) = 0; 93 virtual GSError EraseMetadataKey(uint32_t key) = 0; 94 NativeBufferToSurfaceBuffer(OH_NativeBuffer * buffer)95 static SurfaceBuffer* NativeBufferToSurfaceBuffer(OH_NativeBuffer* buffer) 96 { 97 return reinterpret_cast<SurfaceBuffer *>(buffer); 98 }; 99 NativeBufferToSurfaceBuffer(OH_NativeBuffer const * buffer)100 static const SurfaceBuffer* NativeBufferToSurfaceBuffer(OH_NativeBuffer const* buffer) 101 { 102 return reinterpret_cast<SurfaceBuffer const*>(buffer); 103 }; 104 105 virtual OH_NativeBuffer* SurfaceBufferToNativeBuffer() = 0; 106 107 static sptr<SurfaceBuffer> Create(); 108 WriteBufferRequestConfig(MessageParcel & parcel)109 virtual GSError WriteBufferRequestConfig(MessageParcel &parcel) 110 { 111 (void)parcel; 112 return GSERROR_OK; 113 }; ReadBufferRequestConfig(MessageParcel & parcel)114 virtual GSError ReadBufferRequestConfig(MessageParcel &parcel) 115 { 116 (void)parcel; 117 return GSERROR_OK; 118 }; GetBufferRequestConfig()119 virtual BufferRequestConfig GetBufferRequestConfig() const 120 { 121 return {}; 122 } SetBufferRequestConfig(const BufferRequestConfig & config)123 virtual void SetBufferRequestConfig(const BufferRequestConfig &config) 124 { 125 (void)config; 126 }; SetConsumerAttachBufferFlag(bool value)127 virtual void SetConsumerAttachBufferFlag(bool value) 128 { 129 (void)value; 130 }; GetConsumerAttachBufferFlag()131 virtual bool GetConsumerAttachBufferFlag() 132 { 133 return false; 134 }; GetPlanesInfo(void ** planesInfo)135 virtual GSError GetPlanesInfo(void **planesInfo) 136 { 137 (void)planesInfo; 138 return GSERROR_OK; 139 }; SetSurfaceBufferScalingMode(const ScalingMode & scalingMode)140 virtual void SetSurfaceBufferScalingMode(const ScalingMode &scalingMode) 141 { 142 (void) scalingMode; 143 } GetSurfaceBufferScalingMode()144 virtual ScalingMode GetSurfaceBufferScalingMode() const 145 { 146 return SCALING_MODE_SCALE_TO_WINDOW; 147 } 148 protected: SurfaceBuffer()149 SurfaceBuffer() {} 150 SurfaceBuffer(const SurfaceBuffer&) = delete; 151 SurfaceBuffer& operator=(const SurfaceBuffer&) = delete; ~SurfaceBuffer()152 virtual ~SurfaceBuffer() {} 153 }; 154 155 using OnReleaseFunc = std::function<GSError(sptr<SurfaceBuffer> &)>; 156 using OnDeleteBufferFunc = std::function<void(int32_t)>; 157 using OnReleaseFuncWithFence = std::function<GSError(const sptr<SurfaceBuffer>&, const sptr<SyncFence>&)>; 158 using OnUserDataChangeFunc = std::function<void(const std::string& key, const std::string& value)>; 159 } // namespace OHOS 160 161 #endif // INTERFACES_INNERKITS_SURFACE_SURFACE_BUFFER_H 162