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

   1 /*
   2  * Copyright (c) 2024 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 // CLASS HEADER
  19 #include <dali-scene3d/public-api/loader/environment-definition.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/devel-api/adaptor-framework/environment-variable.h>
  23 #include <dali/devel-api/adaptor-framework/image-loading.h>
  24 #include <dali/devel-api/threading/mutex.h>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-scene3d/internal/common/image-resource-loader.h>
  28 #include <dali-scene3d/public-api/loader/environment-map-loader.h>
  29 #include <dali-scene3d/public-api/loader/utils.h>
  30
  31 namespace
  32 {
  33 #define TOKEN_STRING(x) #x
  34 std::string GetDaliImagePath()
  35 {
  36   return (nullptr == DALI_IMAGE_DIR) ? Dali::EnvironmentVariable::GetEnvironmentVariable(TOKEN_STRING(DALI_IMAGE_DIR)) : DALI_IMAGE_DIR;
  37 }
  38
  39 static constexpr float DEFAULT_INTENSITY = 1.0f;
  40
  41 } // unnamed namespace
  42
  43 namespace Dali::Scene3D::Loader
  44 {
  45 namespace
  46 {
  47 const char* PRE_COMPUTED_BRDF_TEXTURE_FILE_NAME = "brdfLUT.png";
  48 }
  49 PixelData EnvironmentDefinition::mBrdfPixelData;
  50 Texture   EnvironmentDefinition::mBrdfTexture;
  51 bool      EnvironmentDefinition::mIsBrdfLoaded = false;
  52
  53 Dali::Texture EnvironmentDefinition::GetBrdfTexture()
  54 {
  55   if(!mBrdfTexture)
  56   {
  57     if(!mIsBrdfLoaded)
  58     {
  59       LoadBrdfTexture();
  60     }
  61     mBrdfTexture = Texture::New(TextureType::TEXTURE_2D, mBrdfPixelData.GetPixelFormat(), mBrdfPixelData.GetWidth(), mBrdfPixelData.GetHeight());
  62     mBrdfTexture.Upload(mBrdfPixelData);
  63   }
  64   return mBrdfTexture;
  65 }
  66
  67 EnvironmentDefinition::RawData
  68 EnvironmentDefinition::LoadRaw(const std::string& environmentsPath)
  69 {
  70   RawData raw;
  71   auto    loadFn = [&environmentsPath](const std::string& path, EnvironmentMapData& environmentMapData) {
  72     if(path.empty())
  73     {
  74       environmentMapData.mPixelData.resize(6);
  75       for(auto& face : environmentMapData.mPixelData)
  76       {
  77         face.push_back(Dali::Scene3D::Internal::ImageResourceLoader::GetEmptyPixelDataWhiteRGB());
  78       }
  79       environmentMapData.SetEnvironmentMapType(Dali::Scene3D::EnvironmentMapType::CUBEMAP);
  80     }
  81     else if(!LoadEnvironmentMap(environmentsPath + path, environmentMapData))
  82     {
  83       ExceptionFlinger(ASSERT_LOCATION) << "Failed to load cubemap texture from '" << path << "'.";
  84     }
  85   };
  86
  87   loadFn(mDiffuseMapPath, raw.mDiffuse);
  88   loadFn(mSpecularMapPath, raw.mSpecular);
  89
  90   if(mUseBrdfTexture)
  91   {
  92     LoadBrdfTexture();
  93   }
  94   return raw;
  95 }
  96
  97 EnvironmentDefinition::Textures EnvironmentDefinition::Load(RawData&& raw)
  98 {
  99   Textures textures;
 100
 101   // This texture should have 6 faces and only one mipmap
 102   if(!raw.mDiffuse.mPixelData.empty())
 103   {
 104     textures.mDiffuse = raw.mDiffuse.GetTexture();
 105   }
 106
 107   // This texture should have 6 faces and 6 mipmaps
 108   if(!raw.mSpecular.mPixelData.empty())
 109   {
 110     textures.mSpecular             = raw.mSpecular.GetTexture();
 111     textures.mSpecularMipmapLevels = raw.mSpecular.GetMipmapLevels();
 112   }
 113
 114   if(mUseBrdfTexture)
 115   {
 116     textures.mBrdf = GetBrdfTexture();
 117   }
 118   return textures;
 119 }
 120
 121 float EnvironmentDefinition::GetDefaultIntensity()
 122 {
 123   return DEFAULT_INTENSITY;
 124 }
 125
 126 void EnvironmentDefinition::LoadBrdfTexture()
 127 {
 128   static Dali::Mutex mutex;
 129   {
 130     Mutex::ScopedLock lock(mutex);
 131     if(!mIsBrdfLoaded)
 132     {
 133       Devel::PixelBuffer pixelBuffer = LoadImageFromFile(GetDaliImagePath() + PRE_COMPUTED_BRDF_TEXTURE_FILE_NAME);
 134       if(pixelBuffer)
 135       {
 136         mBrdfPixelData = Devel::PixelBuffer::Convert(pixelBuffer);
 137         mIsBrdfLoaded  = true;
 138       }
 139     }
 140   }
 141 }
 142
 143 } // namespace Dali::Scene3D::Loader