dali-scene3d/public-api/loader/environment-map-loader.cpp

   1 /*
   2  * Copyright (c) 2023 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 // FILE HEADER
  19 #include <dali-scene3d/public-api/loader/environment-map-loader.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/devel-api/adaptor-framework/image-loading.h>
  23 #include <string.h>
  24 #include <filesystem>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-scene3d/public-api/loader/ktx-loader.h>
  28
  29 namespace Dali
  30 {
  31 namespace
  32 {
  33 const std::string_view KTX_EXTENSION = ".ktx";
  34
  35 static constexpr uint32_t NUMBER_OF_ENVIRONMENT_MAP_TYPE = 5;
  36 static constexpr uint32_t NUMBER_OF_CUBE_MAP_TYPE        = 4;
  37
  38 /**
  39  * @brief cube map face index
  40  * Cube map layer order is as fallows:
  41  * POSITIVE_X, NEGATIVE_X, POSITIVE_Y, NEGATIVE_Y, POSITIVE_Z, NEGATIVE_Z. @see CubeMapLayer
  42  * The indices are for 4 kind of environment cube map. Cross_horizontal, Array_horizontal, Cross_vertical, and Array_vertical.
  43  */
  44 static constexpr uint32_t CUBEMAP_INDEX_X[NUMBER_OF_CUBE_MAP_TYPE][6] = {{2, 0, 1, 1, 1, 3}, {0, 1, 2, 3, 4, 5}, {1, 1, 1, 1, 0, 2}, {0, 0, 0, 0, 0, 0}};
  45 static constexpr uint32_t CUBEMAP_INDEX_Y[NUMBER_OF_CUBE_MAP_TYPE][6] = {{1, 1, 0, 2, 1, 1}, {0, 0, 0, 0, 0, 0}, {1, 3, 0, 2, 1, 1}, {0, 1, 2, 3, 4, 5}};
  46
  47 static constexpr Vector2 NUMBER_OF_CUBE_FACE[NUMBER_OF_CUBE_MAP_TYPE] =
  48   {
  49     Vector2(4, 3),
  50     Vector2(6, 1),
  51     Vector2(3, 4),
  52     Vector2(1, 6)};
  53
  54 static constexpr float expectedAspectRatios[NUMBER_OF_ENVIRONMENT_MAP_TYPE] =
  55   {
  56     4.0f / 3.0f,
  57     6.0f / 1.0f,
  58     3.0f / 4.0f,
  59     1.0f / 6.0f,
  60     2.0f / 1.0f};
  61
  62 enum CubeType
  63 {
  64   CROSS_HORIZONTAL = 0, // Cross horizontal style cube map
  65   ARRAY_HORIZONTAL,     // array horizontal style cube map
  66   CROSS_VERTICAL,       // Cross vertical style cube map
  67   ARRAY_VERTICAL,       // array vertical style cube map
  68   NONE
  69 };
  70
  71 uint8_t* GetCroppedBuffer(uint8_t* sourceBuffer, uint32_t bytesPerPixel, uint32_t width, uint32_t height, uint32_t xOffset, uint32_t yOffset, uint32_t xFaceSize, uint32_t yFaceSize)
  72 {
  73   uint32_t byteSize   = bytesPerPixel * xFaceSize * yFaceSize;
  74   uint8_t* destBuffer = reinterpret_cast<uint8_t*>(malloc(byteSize + 4u));
  75
  76   int32_t srcStride  = width * bytesPerPixel;
  77   int32_t destStride = xFaceSize * bytesPerPixel;
  78   int32_t srcOffset  = xOffset * bytesPerPixel + yOffset * srcStride;
  79   int32_t destOffset = 0;
  80   for(uint16_t row = yOffset; row < yOffset + yFaceSize; ++row)
  81   {
  82     memcpy(destBuffer + destOffset, sourceBuffer + srcOffset, destStride);
  83     srcOffset += srcStride;
  84     destOffset += destStride;
  85   }
  86
  87   return destBuffer;
  88 }
  89
  90 PixelData GetCubeFace(Devel::PixelBuffer pixelBuffer, uint32_t faceIndex, CubeType cubeType, float faceWidth, float faceHeight)
  91 {
  92   PixelData pixelData;
  93   if(cubeType != NONE)
  94   {
  95     uint8_t* imageBuffer   = pixelBuffer.GetBuffer();
  96     uint32_t bytesPerPixel = Pixel::GetBytesPerPixel(pixelBuffer.GetPixelFormat());
  97     uint32_t imageWidth    = pixelBuffer.GetWidth();
  98     uint32_t imageHeight   = pixelBuffer.GetHeight();
  99
 100     uint32_t xOffset = CUBEMAP_INDEX_X[cubeType][faceIndex] * static_cast<uint32_t>(faceWidth);
 101     uint32_t yOffset = CUBEMAP_INDEX_Y[cubeType][faceIndex] * static_cast<uint32_t>(faceHeight);
 102
 103     uint32_t finalFaceWidth  = (xOffset + static_cast<uint32_t>(faceWidth) < imageWidth) ? static_cast<uint32_t>(faceWidth) : imageWidth - xOffset;
 104     uint32_t finalFaceHeight = (yOffset + static_cast<uint32_t>(faceHeight) < imageHeight) ? static_cast<uint32_t>(faceHeight) : imageHeight - yOffset;
 105     uint8_t* tempImageBuffer = GetCroppedBuffer(imageBuffer, bytesPerPixel, imageWidth, imageHeight, xOffset, yOffset, finalFaceWidth, finalFaceHeight);
 106     pixelData                = PixelData::New(tempImageBuffer, finalFaceWidth * finalFaceHeight * bytesPerPixel, finalFaceWidth, finalFaceHeight, pixelBuffer.GetPixelFormat(), PixelData::FREE);
 107   }
 108   return pixelData;
 109 }
 110
 111 /**
 112  * @brief Loads environment map data texture from an image url.
 113  *
 114  * @param[in] environmentMapUrl The environment map file url.
 115  * @param[out] environmentMapData The data structure with all pixel data objects.
 116  * @return bool True if the loading is succeded.
 117  */
 118 bool LoadEnvironmentMapData(const std::string& environmentMapUrl, Scene3D::Loader::EnvironmentMapData& environmentMapData)
 119 {
 120   // Diffuse Environment Map
 121   if(environmentMapUrl.empty())
 122   {
 123     return false;
 124   }
 125
 126   Devel::PixelBuffer pixelBuffer = LoadImageFromFile(environmentMapUrl);
 127   if(pixelBuffer)
 128   {
 129     CubeType cubeType    = NONE;
 130     uint32_t imageWidth  = pixelBuffer.GetWidth();
 131     uint32_t imageHeight = pixelBuffer.GetHeight();
 132     /**
 133      * If the environment map type is not EQUIRECTANGULAR,
 134      * The type should be defined internally.
 135      * DALi checkes aspect ratio of input image and find the closest type.
 136      * If the environment map type is CUBEMAP, DALi determines which of the following styles is closest:
 137      * cross horizontal, cross vertical, array horizontal, and array vertical.
 138      * When the environment map type is AUTO, it finds the closest type, including the Equirectangular type.
 139      */
 140     if(environmentMapData.GetEnvironmentMapType() != Scene3D::EnvironmentMapType::EQUIRECTANGULAR)
 141     {
 142       float aspectRatio = (float)imageWidth / (float)imageHeight;
 143
 144       float    minDistance = FLT_MAX;
 145       uint32_t typeCount   = (environmentMapData.GetEnvironmentMapType() == Scene3D::EnvironmentMapType::CUBEMAP) ? NUMBER_OF_CUBE_MAP_TYPE : NUMBER_OF_ENVIRONMENT_MAP_TYPE;
 146       for(uint32_t i = 0; i < typeCount; ++i)
 147       {
 148         float distance = fabs(aspectRatio - expectedAspectRatios[i]);
 149         if(distance < minDistance)
 150         {
 151           minDistance = distance;
 152           cubeType    = static_cast<CubeType>(i);
 153         }
 154       }
 155     }
 156
 157     if(cubeType != NONE)
 158     {
 159       float faceWidth = imageWidth, faceHeight = imageHeight;
 160       faceWidth /= NUMBER_OF_CUBE_FACE[static_cast<uint32_t>(cubeType)].x;
 161       faceHeight /= NUMBER_OF_CUBE_FACE[static_cast<uint32_t>(cubeType)].y;
 162       environmentMapData.mPixelData.resize(6);
 163       for(uint32_t i = 0; i < 6; ++i)
 164       {
 165         environmentMapData.mPixelData[i].resize(1);
 166       }
 167       for(uint32_t i = 0; i < 6; ++i)
 168       {
 169         environmentMapData.mPixelData[i][0] = GetCubeFace(pixelBuffer, i, cubeType, faceWidth, faceHeight);
 170       }
 171       environmentMapData.SetEnvironmentMapType(Scene3D::EnvironmentMapType::CUBEMAP);
 172     }
 173     else
 174     {
 175       environmentMapData.mPixelData.resize(1);
 176       environmentMapData.mPixelData[0].resize(1);
 177       environmentMapData.mPixelData[0][0] = Devel::PixelBuffer::Convert(pixelBuffer);
 178       environmentMapData.SetEnvironmentMapType(Scene3D::EnvironmentMapType::EQUIRECTANGULAR);
 179     }
 180     return true;
 181   }
 182   return false;
 183 }
 184 } // namespace
 185
 186 namespace Scene3D
 187 {
 188 namespace Loader
 189 {
 190 bool LoadEnvironmentMap(const std::string& environmentMapUrl, EnvironmentMapData& environmentMapData)
 191 {
 192   std::filesystem::path modelPath(environmentMapUrl);
 193   std::string           extension = modelPath.extension();
 194   std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
 195
 196   return (extension == KTX_EXTENSION) ? Dali::Scene3D::Loader::LoadKtxData(environmentMapUrl, environmentMapData) : LoadEnvironmentMapData(environmentMapUrl, environmentMapData);
 197 }
 198
 199 } // namespace Loader
 200 } // namespace Scene3D
 201 } // namespace Dali