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 Parcel; 35 class SyncFence; 36 class SurfaceBuffer : public RefBase { 37 public: 38 virtual BufferHandle *GetBufferHandle() const = 0; 39 virtual int32_t GetWidth() const = 0; 40 virtual int32_t GetHeight() const = 0; 41 virtual int32_t GetStride() const = 0; 42 virtual int32_t GetFormat() const = 0; 43 virtual uint64_t GetUsage() const = 0; 44 virtual uint64_t GetPhyAddr() const = 0; 45 virtual void* GetVirAddr() = 0; 46 virtual int32_t GetFileDescriptor() const = 0; 47 virtual uint32_t GetSize() const = 0; 48 49 virtual GraphicColorGamut GetSurfaceBufferColorGamut() const = 0; 50 virtual GraphicTransformType GetSurfaceBufferTransform() const = 0; 51 virtual void SetSurfaceBufferColorGamut(const GraphicColorGamut& colorGamut) = 0; 52 virtual void SetSurfaceBufferTransform(const GraphicTransformType& transform) = 0; 53 54 virtual int32_t GetSurfaceBufferWidth() const = 0; 55 virtual int32_t GetSurfaceBufferHeight() const = 0; 56 virtual void SetSurfaceBufferWidth(int32_t width) = 0; 57 virtual void SetSurfaceBufferHeight(int32_t width) = 0; 58 59 virtual uint32_t GetSeqNum() const = 0; 60 61 virtual void SetExtraData(sptr<BufferExtraData> bedata) = 0; 62 virtual sptr<BufferExtraData> GetExtraData() const = 0; 63 virtual GSError WriteToMessageParcel(MessageParcel &parcel) = 0; 64 /* 65 * @Description: ReadFromMessageParcel 66 * @param parcel: A MessageParcel object 67 * @param readSafeFdFunc：Optional parameter, caller can use this callback function to implement 68 * their own way of obtaining Fd from parcel 69 * @return Returns GSERROR_OK if SetMetadata is successful; returns GErrorCode otherwise. 70 */ 71 virtual GSError ReadFromMessageParcel(MessageParcel &parcel, 72 std::function<int(MessageParcel &parcel, 73 std::function<int(Parcel &)>readFdDefaultFunc)>readSafeFdFunc = nullptr) = 0; 74 virtual void SetBufferHandle(BufferHandle *handle) = 0; 75 76 // gralloc 77 virtual GSError Alloc(const BufferRequestConfig &config) = 0; 78 virtual GSError Map() = 0; 79 virtual GSError Unmap() = 0; 80 virtual GSError FlushCache() = 0; 81 virtual GSError InvalidateCache() = 0; 82 83 // metadata 84 /* 85 * @Description: SetMetadata 86 * @param key：Metadata key 87 * @param value：Metadata value 88 * @param enableCache：If true(default true), enable metaData cache optimization, 89 * when the same metaData is repeatedly set, the instruction count can be reduced. 90 * Prohibit setting different enableCache values for the same surfacebuffer object 91 * @return Returns GSERROR_OK if SetMetadata is successful; returns GErrorCode otherwise. 92 */ 93 virtual GSError SetMetadata(uint32_t key, const std::vector<uint8_t>& value, bool enableCache = true) = 0; 94 virtual GSError GetMetadata(uint32_t key, std::vector<uint8_t>& value) = 0; 95 virtual GSError ListMetadataKeys(std::vector<uint32_t>& keys) = 0; 96 virtual GSError EraseMetadataKey(uint32_t key) = 0; 97 98 virtual void SetCropMetadata(const Rect& crop) = 0; 99 virtual bool GetCropMetadata(Rect& crop) = 0; 100 NativeBufferToSurfaceBuffer(OH_NativeBuffer * buffer)101 static SurfaceBuffer* NativeBufferToSurfaceBuffer(OH_NativeBuffer* buffer) 102 { 103 return reinterpret_cast<SurfaceBuffer *>(buffer); 104 }; 105 NativeBufferToSurfaceBuffer(OH_NativeBuffer const * buffer)106 static const SurfaceBuffer* NativeBufferToSurfaceBuffer(OH_NativeBuffer const* buffer) 107 { 108 return reinterpret_cast<SurfaceBuffer const*>(buffer); 109 }; 110 111 virtual OH_NativeBuffer* SurfaceBufferToNativeBuffer() = 0; 112 113 static sptr<SurfaceBuffer> Create(); 114 WriteBufferRequestConfig(MessageParcel & parcel)115 virtual GSError WriteBufferRequestConfig(MessageParcel &parcel) 116 { 117 (void)parcel; 118 return GSERROR_OK; 119 }; ReadBufferRequestConfig(MessageParcel & parcel)120 virtual GSError ReadBufferRequestConfig(MessageParcel &parcel) 121 { 122 (void)parcel; 123 return GSERROR_OK; 124 }; 125 virtual BufferRequestConfig GetBufferRequestConfig() const = 0; SetBufferRequestConfig(const BufferRequestConfig & config)126 virtual void SetBufferRequestConfig(const BufferRequestConfig &config) 127 { 128 (void)config; 129 }; SetConsumerAttachBufferFlag(bool value)130 virtual void SetConsumerAttachBufferFlag(bool value) 131 { 132 (void)value; 133 }; GetConsumerAttachBufferFlag()134 virtual bool GetConsumerAttachBufferFlag() 135 { 136 return false; 137 }; GetPlanesInfo(void ** planesInfo)138 virtual GSError GetPlanesInfo(void **planesInfo) 139 { 140 (void)planesInfo; 141 return GSERROR_OK; 142 }; SetSurfaceBufferScalingMode(const ScalingMode & scalingMode)143 virtual void SetSurfaceBufferScalingMode(const ScalingMode &scalingMode) 144 { 145 (void) scalingMode; 146 } GetSurfaceBufferScalingMode()147 virtual ScalingMode GetSurfaceBufferScalingMode() const 148 { 149 return SCALING_MODE_SCALE_TO_WINDOW; 150 } SetBufferDeleteFromCacheFlag(const bool & flag)151 virtual void SetBufferDeleteFromCacheFlag(const bool &flag) 152 { 153 (void) flag; 154 } GetBufferDeleteFromCacheFlag()155 virtual bool GetBufferDeleteFromCacheFlag() const 156 { 157 return false; 158 } 159 protected: SurfaceBuffer()160 SurfaceBuffer() {} 161 SurfaceBuffer(const SurfaceBuffer&) = delete; 162 SurfaceBuffer& operator=(const SurfaceBuffer&) = delete; ~SurfaceBuffer()163 virtual ~SurfaceBuffer() {} 164 }; 165 166 struct SurfaceProperty { 167 GraphicTransformType transformHint = GraphicTransformType::GRAPHIC_ROTATE_NONE; 168 }; 169 170 using OnReleaseFunc = std::function<GSError(sptr<SurfaceBuffer> &)>; 171 using OnDeleteBufferFunc = std::function<void(int32_t)>; 172 using OnReleaseFuncWithFence = std::function<GSError(const sptr<SurfaceBuffer>&, const sptr<SyncFence>&)>; 173 using OnUserDataChangeFunc = std::function<void(const std::string& key, const std::string& value)>; 174 using OnPropertyChangeFunc = std::function<GSError(const SurfaceProperty&)>; 175 } // namespace OHOS 176 177 #endif // INTERFACES_INNERKITS_SURFACE_SURFACE_BUFFER_H 178