dali/internal/event/effects/shader-factory.cpp

   1 /*
   2  * Copyright (c) 2018 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/internal/event/effects/shader-factory.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <sstream>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/public-api/dali-core-version.h>
  26 #include <dali/public-api/common/dali-common.h>
  27 #include <dali/devel-api/common/hash.h>
  28 #include <dali/integration-api/debug.h>
  29 #include <dali/integration-api/platform-abstraction.h>
  30 #include <dali/internal/event/common/thread-local-storage.h>
  31
  32 namespace
  33 {
  34 const char* VERSION_SEPARATOR = "-";
  35 const char* SHADER_SUFFIX = ".dali-bin";
  36 }
  37
  38 namespace Dali
  39 {
  40
  41 namespace Internal
  42 {
  43
  44 namespace
  45 {
  46
  47 /**
  48  * @brief Generates a filename for a shader binary based on the hash value passed in.
  49  * @param[in] shaderHash A hash over shader sources.
  50  * @param[out] filename A string to overwrite with the filename.
  51  */
  52 void shaderBinaryFilename( size_t shaderHash, std::string& filename )
  53 {
  54   std::stringstream binaryShaderFilenameBuilder( std::ios_base::out );
  55   binaryShaderFilenameBuilder << CORE_MAJOR_VERSION << VERSION_SEPARATOR << CORE_MINOR_VERSION << VERSION_SEPARATOR << CORE_MICRO_VERSION << VERSION_SEPARATOR
  56                               << shaderHash
  57                               << SHADER_SUFFIX;
  58   filename = binaryShaderFilenameBuilder.str();
  59 }
  60
  61 }
  62
  63 ShaderFactory::ShaderFactory()
  64 {
  65 }
  66
  67 ShaderFactory::~ShaderFactory()
  68 {
  69   // Let all the cached objects destroy themselves:
  70   for( std::size_t i = 0, cacheSize = mShaderBinaryCache.Size(); i < cacheSize; ++i )
  71   {
  72     if( mShaderBinaryCache[i] )
  73     {
  74       mShaderBinaryCache[i]->Unreference();
  75     }
  76   }
  77 }
  78
  79 ShaderDataPtr ShaderFactory::Load( const std::string& vertexSource, const std::string& fragmentSource, const Dali::Shader::Hint::Value hints, size_t& shaderHash )
  80 {
  81   // Work out the filename for the binary that the glsl source will be compiled and linked to:
  82   shaderHash = CalculateHash( vertexSource.c_str(), fragmentSource.c_str() );
  83   std::string binaryShaderFilename;
  84   shaderBinaryFilename( shaderHash, binaryShaderFilename );
  85
  86   ShaderDataPtr shaderData;
  87
  88   /// Check a cache of previously loaded shaders:
  89   for( std::size_t i = 0, cacheSize = mShaderBinaryCache.Size(); i < cacheSize; ++i )
  90   {
  91     if( mShaderBinaryCache[i]->GetHashValue() == shaderHash )
  92     {
  93       shaderData = mShaderBinaryCache[i];
  94
  95       DALI_LOG_INFO( Debug::Filter::gShader, Debug::General, "Mem cache hit on path: \"%s\"\n", binaryShaderFilename.c_str() );
  96       break;
  97     }
  98   }
  99
 100   // If memory cache failed check the file system for a binary or return a source-only ShaderData:
 101   if( shaderData.Get() == nullptr )
 102   {
 103     // Allocate the structure that returns the loaded shader:
 104     shaderData = new ShaderData( vertexSource, fragmentSource, hints );
 105     shaderData->SetHashValue( shaderHash );
 106     shaderData->GetBuffer().Clear();
 107
 108     // Try to load the binary (this will fail if the shader source has never been compiled before):
 109     ThreadLocalStorage& tls = ThreadLocalStorage::Get();
 110     Integration::PlatformAbstraction& platformAbstraction = tls.GetPlatformAbstraction();
 111     const bool loaded = platformAbstraction.LoadShaderBinaryFile( binaryShaderFilename, shaderData->GetBuffer() );
 112
 113     if( loaded )
 114     {
 115       MemoryCacheInsert( *shaderData );
 116     }
 117
 118     DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, loaded ?
 119         "loaded on path: \"%s\"\n" :
 120         "failed to load on path: \"%s\"\n",
 121         binaryShaderFilename.c_str());
 122   }
 123
 124   return shaderData;
 125 }
 126
 127 void ShaderFactory::SaveBinary( Internal::ShaderDataPtr shaderData )
 128 {
 129   // Save the binary to the file system:
 130   std::string binaryShaderFilename;
 131   shaderBinaryFilename( shaderData->GetHashValue(), binaryShaderFilename );
 132
 133   ThreadLocalStorage& tls = ThreadLocalStorage::Get();
 134   Integration::PlatformAbstraction& platformAbstraction = tls.GetPlatformAbstraction();
 135   const bool saved = platformAbstraction.SaveShaderBinaryFile( binaryShaderFilename, &shaderData->GetBuffer()[0], static_cast<unsigned int>( shaderData->GetBufferSize() ) ); // don't expect buffer larger than unsigned int
 136
 137   // Save the binary into to memory cache:
 138   MemoryCacheInsert( *shaderData );
 139
 140   DALI_LOG_INFO( Debug::Filter::gShader, Debug::General, saved ? "Saved to file: %s\n" : "Save to file failed: %s\n", binaryShaderFilename.c_str() );
 141   if( saved ) {} // Avoid unused variable warning in release builds
 142 }
 143
 144 void ShaderFactory::MemoryCacheInsert( ShaderData& shaderData )
 145 {
 146   DALI_ASSERT_DEBUG( shaderData.GetBufferSize() > 0 );
 147
 148   // Save the binary into to memory cache:
 149   if( shaderData.GetBufferSize() > 0 )
 150   {
 151     mShaderBinaryCache.Reserve( mShaderBinaryCache.Size() + 1 ); // Make sure the push won't throw after we inc the ref count.
 152     shaderData.Reference();
 153     mShaderBinaryCache.PushBack( &shaderData );
 154     DALI_LOG_INFO( Debug::Filter::gShader, Debug::General, "CACHED BINARY FOR HASH: %u\n", shaderData.GetHashValue() );
 155   }
 156 }
 157
 158 } // namespace Internal
 159
 160 } // namespace Dali