* Copyright (C) 2021-2026 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef FRAMEWORKS_INNERKITSIMPL_UTILS_INCLUDE_IMAGE_UTILS_H
#define FRAMEWORKS_INNERKITSIMPL_UTILS_INCLUDE_IMAGE_UTILS_H
#include <cmath>
#include <cstdlib>
#include <cstdio>
#include <string>
#include "image_type.h"
#include "iosfwd"
#if !defined(CROSS_PLATFORM)
#include <refbase.h>
#endif
namespace OHOS { namespace MultimediaPlugin { class PluginServer; } }
namespace OHOS { namespace ImagePlugin { struct DecodeContext; } }
namespace OHOS { namespace ColorManager {enum ColorSpaceName: uint32_t; } }
namespace OHOS { namespace HDI { namespace Display { namespace Graphic { namespace Common {
namespace V1_0 { enum CM_ColorSpaceType: int32_t; } } } } } }
namespace OHOS { class SurfaceBuffer; }
namespace OHOS {
namespace Media {
const std::string IMAGE_ENCODE_FORMAT = "encodeFormat";
constexpr uint32_t MALLOC_MAX_LENTH = 0x40000000;
constexpr uint32_t MAX_TLV_HEAP_SIZE = 128 * 1021 * 1024;
constexpr int32_t APIVERSION_13 = 13;
constexpr int32_t APIVERSION_20 = 20;
static constexpr uint8_t TLV_VARINT_BITS = 7;
static constexpr uint8_t TLV_VARINT_MASK = 0x7F;
static constexpr uint8_t TLV_VARINT_MORE = 0x80;
static constexpr uint8_t TLV_END = 0x00;
static constexpr uint8_t TLV_IMAGE_WIDTH = 0x01;
static constexpr uint8_t TLV_IMAGE_HEIGHT = 0x02;
static constexpr uint8_t TLV_IMAGE_PIXELFORMAT = 0x03;
static constexpr uint8_t TLV_IMAGE_COLORSPACE = 0x04;
static constexpr uint8_t TLV_IMAGE_ALPHATYPE = 0x05;
static constexpr uint8_t TLV_IMAGE_BASEDENSITY = 0x06;
static constexpr uint8_t TLV_IMAGE_ALLOCATORTYPE = 0x07;
static constexpr uint8_t TLV_IMAGE_DATA = 0x08;
static constexpr uint8_t TLV_IMAGE_HDR = 0x09;
static constexpr uint8_t TLV_IMAGE_COLORTYPE = 0x0A;
static constexpr uint8_t TLV_IMAGE_METADATATYPE = 0x0B;
static constexpr uint8_t TLV_IMAGE_STATICMETADATA = 0x11;
static constexpr uint8_t TLV_IMAGE_DYNAMICMETADATA = 0x12;
static constexpr uint8_t TLV_IMAGE_CSM = 0x1F;
class PixelMap;
class AbsMemory;
struct RWPixelsOptions;
struct InitializationOptions;
template<typename T>
class ScopeRestorer {
public:
explicit ScopeRestorer(T& ref)
: ref_(ref), old_value_(ref), new_value_set_(false)
{}
explicit ScopeRestorer(T& ref, T new_value)
: ref_(ref), old_value_(ref), new_value_set_(true)
{
ref_ = new_value;
}
void SetValue(const T& value)
{
ref_ = value;
new_value_set_ = true;
}
void Keep()
{
new_value_set_ = false;
}
void Restore()
{
if (new_value_set_) {
ref_ = old_value_;
new_value_set_ = false;
}
}
~ScopeRestorer()
{
if (new_value_set_) {
ref_ = old_value_;
}
}
ScopeRestorer(const ScopeRestorer&) = delete;
ScopeRestorer& operator=(const ScopeRestorer&) = delete;
ScopeRestorer(ScopeRestorer&&) = delete;
ScopeRestorer& operator=(ScopeRestorer&&) = delete;
private:
T& ref_;
T old_value_;
bool new_value_set_;
};
class ImageUtils {
public:
static bool GetFileSize(const std::string &pathName, size_t &size);
static bool GetFileSize(const int fd, size_t &size);
static bool GetInputStreamSize(std::istream &inputStream, size_t &size);
static int32_t GetPixelBytes(const PixelFormat &pixelFormat);
static int32_t GetRowDataSizeByPixelFormat(const int32_t &width, const PixelFormat &format);
static bool PathToRealPath(const std::string &path, std::string &realPath);
static bool FloatCompareZero(float src);
static AlphaType GetValidAlphaTypeByFormat(const AlphaType &dstType, const PixelFormat &format);
static AllocatorType GetPixelMapAllocatorType(const Size &size, const PixelFormat &format, bool preferDma,
uint64_t &usage);
static AllocatorType GetPixelMapAllocatorType(const Size &size, const PixelFormat &format, bool preferDma,
uint64_t &usage, bool &isUseDefaultDmaNopadding);
static bool IsValidImageInfo(const ImageInfo &info);
static bool IsValidAuxiliaryInfo(const std::shared_ptr<PixelMap> &pixelMap, const AuxiliaryPictureInfo &info);
static bool IsAstc(PixelFormat format);
static bool IsWidthAligned(const int32_t &width);
static bool IsSizeSupportDma(const Size &size, bool isUseDefaultDmaNopadding = false);
static bool IsFormatSupportDma(const PixelFormat &format);
static bool IsSupportDefaultDmaNopadding(const Size &size, const PixelFormat &format);
static bool Is10Bit(const PixelFormat &format);
static MultimediaPlugin::PluginServer& GetPluginServer();
static bool CheckMulOverflow(int32_t width, int32_t bytesPerPixel);
static bool CheckMulOverflow(int32_t width, int32_t height, int32_t bytesPerPixel);
static bool CheckFloatMulOverflow(float num1, float num2);
static bool CheckFloatToInt32Overflow(float value);
static void BGRAToARGB(uint8_t* srcPixels, uint8_t* dstPixels, uint32_t byteCount);
static void ARGBToBGRA(uint8_t* srcPixels, uint8_t* dstPixels, uint32_t byteCount);
static int32_t SurfaceBuffer_Reference(void* buffer);
static int32_t SurfaceBuffer_Unreference(void* buffer);
static void DumpPixelMap(PixelMap* pixelMap, std::string customFileName, uint64_t imageId = 0);
static void DumpPixelMapIfDumpEnabled(std::unique_ptr<PixelMap>& pixelMap, uint64_t imageId = 0);
static void DumpPixelMapIfDumpEnabled(PixelMap& pixelMap, std::string func);
static void DumpPixelMapBeforeEncode(PixelMap& pixelMap);
static void DumpData(const char* data, const size_t& totalSize, const std::string& fileSuffix = "dat",
uint64_t imageId = 0);
static void DumpDataIfDumpEnabled(const char* data, const size_t& totalSize, const std::string& fileSuffix = "dat",
uint64_t imageId = 0);
#if !defined(CROSS_PLATFORM)
static bool SurfaceBuffer2PixelMap(sptr<SurfaceBuffer> &surfaceBuffer, std::unique_ptr<PixelMap>& Pixelmap);
static bool ConvertRGBAF16ToRGBA1010102(
const std::shared_ptr<PixelMap>& srcPixelMap, std::unique_ptr<PixelMap>& dstPixelMap);
static void DumpHdrBufferEnabled(sptr<SurfaceBuffer>& buffer, const std::string& fileName);
static void DumpHdrExtendMetadataEnabled(sptr<SurfaceBuffer>& buffer, const std::string& fileName);
static void DumpSurfaceBufferAllKeysEnabled(sptr<SurfaceBuffer>& buffer, const std::string& fileName);
static ColorManager::ColorSpaceName SbCMColorSpaceType2ColorSpaceName(
HDI::Display::Graphic::Common::V1_0::CM_ColorSpaceType type);
static void SetYuvDataInfo(std::unique_ptr<PixelMap> &pixelMap, sptr<OHOS::SurfaceBuffer> &sBuffer);
static bool CopyYuvPixelMapToSurfaceBuffer(PixelMap* pixelmap, sptr<SurfaceBuffer> surfaceBuffer);
static bool GetYuvInfoFromSurfaceBuffer(YUVDataInfo &yuvInfo, sptr<SurfaceBuffer> surfaceBuffer);
#endif
static PixelFormat SbFormat2PixelFormat(int32_t sbFormat);
static int32_t PixelFormat2GraphicFormat(PixelFormat pixelFormat);
static uint64_t GetNowTimeMilliSeconds();
static uint64_t GetNowTimeMicroSeconds();
static std::string GetCurrentProcessName();
static bool SetInitializationOptionAutoMem(InitializationOptions &option);
static bool SetInitializationOptionDmaMem(InitializationOptions &option);
static bool SetInitializationOptionAllocatorType(InitializationOptions &option, int32_t allocatorType);
static uint8_t BytesToUint8(uint8_t* bytes, uint32_t& offset, uint32_t size);
static uint8_t BytesToUint8(const uint8_t* bytes, uint32_t& offset, uint32_t size);
static uint16_t BytesToUint16(uint8_t* bytes, uint32_t& offset, uint32_t size, bool isBigEndian = true);
static uint32_t BytesToUint32(uint8_t* bytes, uint32_t& offset, uint32_t size, bool isBigEndian = true);
static int32_t BytesToInt32(uint8_t* bytes, uint32_t& offset, uint32_t size, bool isBigEndian = true);
static float BytesToFloat(uint8_t* bytes, uint32_t& offset, uint32_t size, bool isBigEndian = true);
static void Uint16ToBytes(uint16_t data, std::vector<uint8_t>& bytes, uint32_t& offset, bool isBigEndian = true);
static void Uint32ToBytes(uint32_t data, std::vector<uint8_t>& bytes, uint32_t& offset, bool isBigEndian = true);
static void FloatToBytes(float data, std::vector<uint8_t>& bytes, uint32_t& offset, bool isBigEndian = true);
static void Int32ToBytes(int32_t data, std::vector<uint8_t>& bytes, uint32_t& offset, bool isBigEndian = true);
static void ArrayToBytes(const uint8_t* data, uint32_t length, std::vector<uint8_t>& bytes, uint32_t& offset);
static void FlushSurfaceBuffer(PixelMap* pixelMap);
static void FlushContextSurfaceBuffer(ImagePlugin::DecodeContext& context);
static void InvalidateContextSurfaceBuffer(ImagePlugin::DecodeContext& context);
static bool IsAuxiliaryPictureTypeSupported(AuxiliaryPictureType auxiliaryPictureType);
static bool IsAuxiliaryPictureEncoded(AuxiliaryPictureType type);
static bool IsMetadataTypeSupported(MetadataType metadataType);
static bool isBlobMetadataType(MetadataType metadataType);
static const std::set<AuxiliaryPictureType> &GetAllAuxiliaryPictureType();
static const std::set<MetadataType> &GetAllMetadataType();
static uint32_t GetThumbnailScaleTargetSize(const Size &sourceSize, const int32_t &maxPixelSize, Size &dstSize,
float &scale);
static uint32_t ScaleThumbnailWithAspectRatio(std::unique_ptr<PixelMap> &pixelMap, const int32_t &maxPixelSize);
static size_t GetAstcBytesCount(const ImageInfo& imageInfo);
static bool StrToUint32(const std::string& str, uint32_t& value);
static bool IsInRange(uint32_t value, uint32_t minValue, uint32_t maxValue);
static bool IsInRange(int32_t value, int32_t minValue, int32_t maxValue);
static bool IsEven(int32_t value);
static bool HasOverflowed(uint32_t num1, uint32_t num2);
static bool HasOverflowed64(uint64_t num1, uint64_t num2);
static int32_t GetAPIVersion();
static std::string GetEncodedHeifFormat();
static std::string GetEncodedHeifsFormat();
static void UpdateSdrYuvStrides(const ImageInfo &imageInfo, YUVStrideInfo &dstStrides,
void *context, AllocatorType dstType);
static bool CanReusePixelMap(ImagePlugin::DecodeContext& context, int width,
int height, const std::shared_ptr<PixelMap> &reusePixelmap);
static bool CanReusePixelMapHdr(ImagePlugin::DecodeContext& context, int width,
int height, const std::shared_ptr<PixelMap> &reusePixelmap);
static bool CanReusePixelMapSdr(ImagePlugin::DecodeContext& context, int width,
int height, const std::shared_ptr<PixelMap> &reusePixelmap);
static bool IsHdrPixelMapReuseSuccess(ImagePlugin::DecodeContext& context, int width,
int height, const std::shared_ptr<PixelMap> &reusePixelmap);
static void SetContextHdr(ImagePlugin::DecodeContext& context, uint32_t format);
static void SetReuseContextBuffer(ImagePlugin::DecodeContext& context,
AllocatorType type, uint8_t* ptr, uint64_t count, void* fd);
static bool IsSdrPixelMapReuseSuccess(ImagePlugin::DecodeContext& context, int width,
int height, const std::shared_ptr<PixelMap> &reusePixelmap);
static bool IsYuvFormat(PixelFormat format);
static bool IsRGBX(PixelFormat format);
static bool IsAlpha8(PixelFormat format);
static bool PixelMapCreateCheckFormat(PixelFormat format);
static bool CheckTlvSupportedFormat(PixelFormat format);
static uint16_t GetReusePixelRefCount(const std::shared_ptr<PixelMap> &reusePixelmap);
static bool CheckRowDataSizeIsVaild(int32_t &rowDataSize, ImageInfo &imgInfo);
static bool CheckBufferSizeIsValid(int32_t &bufferSize, uint64_t &expectedBufferSize,
AllocatorType &allocatorType);
static bool CheckYuvDataInfoValid(PixelMap* pixelMap, YUVDataInfo& yDataInfo);
static bool GetAlignedNumber(int32_t& number, int32_t align);
static int32_t GetByteCount(ImageInfo imageInfo);
static int32_t GetYUVByteCount(const ImageInfo& info);
static PixelFormat ConvertTo10BitPixelFormat(PixelFormat pixelFormat);
static bool CalcRGBStride(PixelFormat format, uint32_t width, int &stride);
template<typename T>
static bool CheckMulOverflow(const T& num1, const T& num2)
{
if (num1 == 0 || num2 == 0) {
return true;
}
T mulNum = num1 * num2;
if ((mulNum / num1) != num2) {
return true;
}
return false;
}
template<typename T>
static bool CheckMulOverflow(const T& num1, const T& num2, const T& num3)
{
if (num1 == 0 || num2 == 0 || num3 == 0) {
return true;
}
T mulNum1 = num1 * num2;
if ((mulNum1 / num1) != num2) {
return true;
}
T mulNum2 = mulNum1 * num3;
if ((mulNum2 / num3) != mulNum1) {
return true;
}
return false;
}
static uint16_t GetRGBA1010102ColorR(uint32_t color);
static uint16_t GetRGBA1010102ColorG(uint32_t color);
static uint16_t GetRGBA1010102ColorB(uint32_t color);
static uint16_t GetRGBA1010102ColorA(uint32_t color);
static bool CheckPixelsInput(PixelMap* pixelMap, const RWPixelsOptions &opts);
static bool FloatEqual(float a, float b);
static int32_t ReadVarint(std::vector<uint8_t> &buff, int32_t &cursor);
static std::unique_ptr<AbsMemory> ReadData(std::vector<uint8_t> &buff, int32_t size, int32_t &cursor,
AllocatorType allocType, ImageInfo imageInfo);
static int32_t AllocPixelMapMemory(std::unique_ptr<AbsMemory> &dstMemory, int32_t &dstRowStride,
const ImageInfo &dstImageInfo, const InitializationOptions &opts);
static void TlvWriteSurfaceInfo(const PixelMap* pixelMap, std::vector<uint8_t>& buff);
static uint8_t GetVarintLen(int32_t value);
static void WriteVarint(std::vector<uint8_t> &buff, int32_t value);
static void WriteUint8(std::vector<uint8_t> &buff, uint8_t value);
static bool IsSystemApp();
#if !defined(CROSS_PLATFORM)
static void FlushSurfaceBuffer(sptr<SurfaceBuffer>& surfaceBuffer);
static void GetYuvInfoFromNonDmaBuffer(int32_t width, int32_t height, PixelFormat format, YUVDataInfo &yuvInfo);
static bool GetYuvInfoFromDmaBuffer(sptr<SurfaceBuffer> surfaceBuffer, YUVDataInfo &yuvInfo);
static void UpdateYUVDataInfo(PixelMap &pixelMap);
static void UpdateYUVDataInfo(std::unique_ptr<PixelMap> &pixelMap);
#endif
template<typename T>
static std::string ArrayToString(const std::vector<T>& array)
{
std::ostringstream oss;
for (size_t i = 0; i < array.size(); ++i) {
if (i > 0) oss << ", ";
oss << array[i];
}
return oss.str();
}
#if !defined(CROSS_PLATFORM)
static void GetYUVStrideInfo(SurfaceBuffer* surfaceBuffer, YUVStrideInfo &dstStrides);
#endif
private:
static uint32_t RegisterPluginServer();
static uint32_t SaveDataToFile(const std::string& fileName, const char* data, const size_t& totalSize);
static std::string GetLocalTime();
static std::string GetPixelMapName(PixelMap* pixelMap);
static int32_t GetAPIVersionInner();
static bool CheckSizeValid(const ImageInfo &imgInfo, const YUVDataInfo& yDataInfo);
static bool CheckStrideValid(const YUVDataInfo& yDataInfo);
static bool CheckOffsetValid(const YUVDataInfo& yDataInfo);
};
}
}
#endif