dali/internal/render/renderers/pipeline-cache.cpp

   1 /*
   2  * Copyright (c) 2021 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 // CLASS HEADER
  18 #include <dali/internal/render/renderers/pipeline-cache.h>
  19
  20 // INTERNAL INCLUDES
  21 #include <dali/graphics-api/graphics-types.h>
  22 #include <dali/integration-api/debug.h>
  23 #include <dali/internal/render/common/render-instruction.h>
  24 #include <dali/internal/render/renderers/render-renderer.h>
  25 #include <dali/internal/render/renderers/render-vertex-buffer.h>
  26 #include <dali/internal/render/shaders/program.h>
  27
  28 namespace Dali::Internal::Render
  29 {
  30 namespace
  31 {
  32 // Helper to get the vertex input format
  33 Dali::Graphics::VertexInputFormat GetPropertyVertexFormat(Property::Type propertyType)
  34 {
  35   Dali::Graphics::VertexInputFormat type{};
  36
  37   switch(propertyType)
  38   {
  39     case Property::BOOLEAN:
  40     {
  41       type = Dali::Graphics::VertexInputFormat::UNDEFINED; // type = GL_BYTE; @todo new type for this?
  42       break;
  43     }
  44     case Property::INTEGER:
  45     {
  46       type = Dali::Graphics::VertexInputFormat::INTEGER; // (short)
  47       break;
  48     }
  49     case Property::FLOAT:
  50     {
  51       type = Dali::Graphics::VertexInputFormat::FLOAT;
  52       break;
  53     }
  54     case Property::VECTOR2:
  55     {
  56       type = Dali::Graphics::VertexInputFormat::FVECTOR2;
  57       break;
  58     }
  59     case Property::VECTOR3:
  60     {
  61       type = Dali::Graphics::VertexInputFormat::FVECTOR3;
  62       break;
  63     }
  64     case Property::VECTOR4:
  65     {
  66       type = Dali::Graphics::VertexInputFormat::FVECTOR4;
  67       break;
  68     }
  69     default:
  70     {
  71       type = Dali::Graphics::VertexInputFormat::UNDEFINED;
  72     }
  73   }
  74
  75   return type;
  76 }
  77
  78 constexpr Graphics::CullMode ConvertCullFace(Dali::FaceCullingMode::Type mode)
  79 {
  80   switch(mode)
  81   {
  82     case Dali::FaceCullingMode::NONE:
  83     {
  84       return Graphics::CullMode::NONE;
  85     }
  86     case Dali::FaceCullingMode::FRONT:
  87     {
  88       return Graphics::CullMode::FRONT;
  89     }
  90     case Dali::FaceCullingMode::BACK:
  91     {
  92       return Graphics::CullMode::BACK;
  93     }
  94     case Dali::FaceCullingMode::FRONT_AND_BACK:
  95     {
  96       return Graphics::CullMode::FRONT_AND_BACK;
  97     }
  98     default:
  99     {
 100       return Graphics::CullMode::NONE;
 101     }
 102   }
 103 }
 104
 105 constexpr Graphics::BlendFactor ConvertBlendFactor(BlendFactor::Type blendFactor)
 106 {
 107   switch(blendFactor)
 108   {
 109     case BlendFactor::ZERO:
 110       return Graphics::BlendFactor::ZERO;
 111     case BlendFactor::ONE:
 112       return Graphics::BlendFactor::ONE;
 113     case BlendFactor::SRC_COLOR:
 114       return Graphics::BlendFactor::SRC_COLOR;
 115     case BlendFactor::ONE_MINUS_SRC_COLOR:
 116       return Graphics::BlendFactor::ONE_MINUS_SRC_COLOR;
 117     case BlendFactor::SRC_ALPHA:
 118       return Graphics::BlendFactor::SRC_ALPHA;
 119     case BlendFactor::ONE_MINUS_SRC_ALPHA:
 120       return Graphics::BlendFactor::ONE_MINUS_SRC_ALPHA;
 121     case BlendFactor::DST_ALPHA:
 122       return Graphics::BlendFactor::DST_ALPHA;
 123     case BlendFactor::ONE_MINUS_DST_ALPHA:
 124       return Graphics::BlendFactor::ONE_MINUS_DST_ALPHA;
 125     case BlendFactor::DST_COLOR:
 126       return Graphics::BlendFactor::DST_COLOR;
 127     case BlendFactor::ONE_MINUS_DST_COLOR:
 128       return Graphics::BlendFactor::ONE_MINUS_DST_COLOR;
 129     case BlendFactor::SRC_ALPHA_SATURATE:
 130       return Graphics::BlendFactor::SRC_ALPHA_SATURATE;
 131     case BlendFactor::CONSTANT_COLOR:
 132       return Graphics::BlendFactor::CONSTANT_COLOR;
 133     case BlendFactor::ONE_MINUS_CONSTANT_COLOR:
 134       return Graphics::BlendFactor::ONE_MINUS_CONSTANT_COLOR;
 135     case BlendFactor::CONSTANT_ALPHA:
 136       return Graphics::BlendFactor::CONSTANT_ALPHA;
 137     case BlendFactor::ONE_MINUS_CONSTANT_ALPHA:
 138       return Graphics::BlendFactor::ONE_MINUS_CONSTANT_ALPHA;
 139     default:
 140       return Graphics::BlendFactor();
 141   }
 142 }
 143
 144 constexpr Graphics::BlendOp ConvertBlendEquation(DevelBlendEquation::Type blendEquation)
 145 {
 146   switch(blendEquation)
 147   {
 148     case DevelBlendEquation::ADD:
 149       return Graphics::BlendOp::ADD;
 150     case DevelBlendEquation::SUBTRACT:
 151       return Graphics::BlendOp::SUBTRACT;
 152     case DevelBlendEquation::REVERSE_SUBTRACT:
 153       return Graphics::BlendOp::REVERSE_SUBTRACT;
 154     case DevelBlendEquation::COLOR:
 155       return Graphics::BlendOp::COLOR;
 156     case DevelBlendEquation::COLOR_BURN:
 157       return Graphics::BlendOp::COLOR_BURN;
 158     case DevelBlendEquation::COLOR_DODGE:
 159       return Graphics::BlendOp::COLOR_DODGE;
 160     case DevelBlendEquation::DARKEN:
 161       return Graphics::BlendOp::DARKEN;
 162     case DevelBlendEquation::DIFFERENCE:
 163       return Graphics::BlendOp::DIFFERENCE;
 164     case DevelBlendEquation::EXCLUSION:
 165       return Graphics::BlendOp::EXCLUSION;
 166     case DevelBlendEquation::HARD_LIGHT:
 167       return Graphics::BlendOp::HARD_LIGHT;
 168     case DevelBlendEquation::HUE:
 169       return Graphics::BlendOp::HUE;
 170     case DevelBlendEquation::LIGHTEN:
 171       return Graphics::BlendOp::LIGHTEN;
 172     case DevelBlendEquation::LUMINOSITY:
 173       return Graphics::BlendOp::LUMINOSITY;
 174     case DevelBlendEquation::MAX:
 175       return Graphics::BlendOp::MAX;
 176     case DevelBlendEquation::MIN:
 177       return Graphics::BlendOp::MIN;
 178     case DevelBlendEquation::MULTIPLY:
 179       return Graphics::BlendOp::MULTIPLY;
 180     case DevelBlendEquation::OVERLAY:
 181       return Graphics::BlendOp::OVERLAY;
 182     case DevelBlendEquation::SATURATION:
 183       return Graphics::BlendOp::SATURATION;
 184     case DevelBlendEquation::SCREEN:
 185       return Graphics::BlendOp::SCREEN;
 186     case DevelBlendEquation::SOFT_LIGHT:
 187       return Graphics::BlendOp::SOFT_LIGHT;
 188   }
 189   return Graphics::BlendOp{};
 190 }
 191 } // namespace
 192
 193 PipelineCacheL0* PipelineCache::GetPipelineCacheL0(Program* program, Render::Geometry* geometry)
 194 {
 195   auto it = std::find_if(level0nodes.begin(), level0nodes.end(), [program, geometry](PipelineCacheL0& item) {
 196     return ((item.program == program && item.geometry == geometry));
 197   });
 198
 199   // Add new node to cache
 200   if(it == level0nodes.end())
 201   {
 202     uint32_t bindingIndex{0u};
 203     auto&    reflection = graphicsController->GetProgramReflection(program->GetGraphicsProgram());
 204
 205     Graphics::VertexInputState vertexInputState{};
 206     uint32_t                   base = 0;
 207
 208     for(auto&& vertexBuffer : geometry->GetVertexBuffers())
 209     {
 210       const VertexBuffer::Format& vertexFormat = *vertexBuffer->GetFormat();
 211
 212       vertexInputState.bufferBindings.emplace_back(vertexFormat.size, // stride
 213                                                    Graphics::VertexInputRate::PER_VERTEX);
 214
 215       const uint32_t attributeCount          = vertexBuffer->GetAttributeCount();
 216       uint32_t       lastBoundAttributeIndex = 0;
 217       for(uint32_t i = 0; i < attributeCount; ++i)
 218       {
 219         auto    attributeName = vertexBuffer->GetAttributeName(i);
 220         int32_t pLocation     = reflection.GetVertexAttributeLocation(std::string(attributeName.GetStringView()));
 221         if(-1 != pLocation)
 222         {
 223           auto location = static_cast<uint32_t>(pLocation);
 224           vertexInputState.attributes.emplace_back(location,
 225                                                    bindingIndex,
 226                                                    vertexFormat.components[i].offset,
 227                                                    GetPropertyVertexFormat(vertexFormat.components[i].type));
 228           ++lastBoundAttributeIndex;
 229         }
 230         else
 231         {
 232           DALI_LOG_WARNING("Attribute not found in the shader: %s\n", attributeName.GetCString());
 233           // Don't bind unused attributes.
 234         }
 235       }
 236       base += lastBoundAttributeIndex;
 237       ++bindingIndex;
 238     }
 239     PipelineCacheL0 level0;
 240     level0.program    = program;
 241     level0.geometry   = geometry;
 242     level0.inputState = vertexInputState;
 243     level0nodes.emplace_back(std::move(level0));
 244     it = level0nodes.end() - 1;
 245   }
 246
 247   return &*it;
 248 }
 249
 250 PipelineCacheL1* PipelineCacheL0::GetPipelineCacheL1(Render::Renderer* renderer, bool usingReflection)
 251 {
 252   // hash must be collision free
 253   uint32_t hash = 0;
 254   auto     topo = (uint32_t(geometry->GetTopology()) & 0xffu);
 255   auto     cull = (uint32_t(renderer->GetFaceCullMode()) & 0xffu);
 256
 257   static const Graphics::PolygonMode polyTable[] = {
 258     Graphics::PolygonMode::POINT,
 259     Graphics::PolygonMode::LINE,
 260     Graphics::PolygonMode::LINE,
 261     Graphics::PolygonMode::LINE,
 262     Graphics::PolygonMode::FILL,
 263     Graphics::PolygonMode::FILL,
 264     Graphics::PolygonMode::FILL};
 265
 266   auto poly = polyTable[topo];
 267
 268   static const FaceCullingMode::Type adjFaceCullingMode[4] =
 269     {
 270       FaceCullingMode::NONE,
 271       FaceCullingMode::BACK,
 272       FaceCullingMode::FRONT,
 273       FaceCullingMode::FRONT_AND_BACK,
 274     };
 275
 276   static const FaceCullingMode::Type normalFaceCullingMode[4] =
 277     {
 278       FaceCullingMode::NONE,
 279       FaceCullingMode::FRONT,
 280       FaceCullingMode::BACK,
 281       FaceCullingMode::FRONT_AND_BACK,
 282     };
 283
 284   static const FaceCullingMode::Type* cullModeTable[2] = {
 285     normalFaceCullingMode,
 286     adjFaceCullingMode};
 287
 288   // Retrieve cull mode
 289   auto cullModeTableIndex = uint32_t(usingReflection) & 1u;
 290   cull                    = cullModeTable[cullModeTableIndex][renderer->GetFaceCullMode()];
 291
 292   hash = (topo & 0xffu) | ((cull << 8u) & 0xff00u) | ((uint32_t(poly) << 16u) & 0xff0000u);
 293
 294   // If L1 not found by hash, create rasterization state describing pipeline and store it
 295   auto it = std::find_if(level1nodes.begin(), level1nodes.end(), [hash](PipelineCacheL1& item) {
 296     return item.hashCode == hash;
 297   });
 298
 299   PipelineCacheL1* retval = nullptr;
 300   if(it == level1nodes.end())
 301   {
 302     PipelineCacheL1 item;
 303     item.hashCode       = hash;
 304     item.rs.cullMode    = ConvertCullFace(FaceCullingMode::Type(cull));
 305     item.rs.frontFace   = Graphics::FrontFace::COUNTER_CLOCKWISE;
 306     item.rs.polygonMode = poly; // not in use
 307     item.ia.topology    = geometry->GetTopology();
 308     level1nodes.emplace_back(std::move(item));
 309     retval = &level1nodes.back();
 310   }
 311   else
 312   {
 313     retval = &*it;
 314   }
 315   return retval;
 316 }
 317
 318 PipelineCacheL2* PipelineCacheL1::GetPipelineCacheL2(bool blend, bool premul, BlendingOptions& blendingOptions)
 319 {
 320   // early out
 321   if(!blend)
 322   {
 323     if(noBlend.pipeline == nullptr)
 324     {
 325       // reset all before returning if pipeline has never been created for that case
 326       noBlend.hash = 0;
 327       memset(&noBlend.colorBlendState, 0, sizeof(Graphics::ColorBlendState));
 328     }
 329     return &noBlend;
 330   }
 331
 332   auto bitmask = uint32_t(blendingOptions.GetBitmask());
 333
 334   // Find by bitmask (L2 entries must be sorted by bitmask)
 335   auto it = std::find_if(level2nodes.begin(), level2nodes.end(), [bitmask](PipelineCacheL2& item) {
 336     return item.hash == bitmask;
 337   });
 338
 339   // TODO: find better way of blend constants lookup
 340   PipelineCacheL2* retval = nullptr;
 341   if(it != level2nodes.end())
 342   {
 343     bool hasBlendColor = blendingOptions.GetBlendColor();
 344     while(hasBlendColor && it != level2nodes.end() && (*it).hash == bitmask)
 345     {
 346       Vector4 v(it->colorBlendState.blendConstants);
 347       if(v == *blendingOptions.GetBlendColor())
 348       {
 349         retval = &*it;
 350       }
 351       ++it;
 352     }
 353     if(!hasBlendColor)
 354     {
 355       retval = &*it;
 356     }
 357   }
 358
 359   if(!retval)
 360   {
 361     // create new entry and return it with null pipeline
 362     PipelineCacheL2 l2;
 363     l2.pipeline           = nullptr;
 364     auto& colorBlendState = l2.colorBlendState;
 365     colorBlendState.SetBlendEnable(true);
 366     Graphics::BlendOp rgbOp   = ConvertBlendEquation(blendingOptions.GetBlendEquationRgb());
 367     Graphics::BlendOp alphaOp = ConvertBlendEquation(blendingOptions.GetBlendEquationRgb());
 368     if(blendingOptions.IsAdvancedBlendEquationApplied() && premul)
 369     {
 370       if(rgbOp != alphaOp)
 371       {
 372         DALI_LOG_ERROR("Advanced Blend Equation MUST be applied by using BlendEquation.\n");
 373         alphaOp = rgbOp;
 374       }
 375     }
 376
 377     colorBlendState
 378       .SetSrcColorBlendFactor(ConvertBlendFactor(blendingOptions.GetBlendSrcFactorRgb()))
 379       .SetSrcAlphaBlendFactor(ConvertBlendFactor(blendingOptions.GetBlendSrcFactorAlpha()))
 380       .SetDstColorBlendFactor(ConvertBlendFactor(blendingOptions.GetBlendDestFactorRgb()))
 381       .SetDstAlphaBlendFactor(ConvertBlendFactor(blendingOptions.GetBlendDestFactorAlpha()))
 382       .SetColorBlendOp(rgbOp)
 383       .SetAlphaBlendOp(alphaOp);
 384
 385     // Blend color is optional and rarely used
 386     auto* blendColor = const_cast<Vector4*>(blendingOptions.GetBlendColor());
 387     if(blendColor)
 388     {
 389       colorBlendState.SetBlendConstants(blendColor->AsFloat());
 390     }
 391
 392     l2.hash = blendingOptions.GetBitmask();
 393     level2nodes.emplace_back(std::move(l2));
 394
 395     std::sort(level2nodes.begin(), level2nodes.end(), [](PipelineCacheL2& lhs, PipelineCacheL2& rhs) {
 396       return lhs.hash < rhs.hash;
 397     });
 398
 399     // run same function to retrieve retval
 400     retval = GetPipelineCacheL2(blend, premul, blendingOptions);
 401   }
 402
 403   return retval;
 404 }
 405
 406 PipelineCache::PipelineCache(Graphics::Controller& controller)
 407 : graphicsController(&controller)
 408 {
 409 }
 410
 411 PipelineResult PipelineCache::GetPipeline(const PipelineCacheQueryInfo& queryInfo, bool createNewIfNotFound)
 412 {
 413   auto* level0 = GetPipelineCacheL0(queryInfo.program, queryInfo.geometry);
 414   auto* level1 = level0->GetPipelineCacheL1(queryInfo.renderer, queryInfo.cameraUsingReflection);
 415   auto* level2 = level1->GetPipelineCacheL2(queryInfo.blendingEnabled, queryInfo.alphaPremultiplied, *queryInfo.blendingOptions);
 416
 417   // Create new pipeline at level2 if requested
 418   if(level2->pipeline == nullptr && createNewIfNotFound)
 419   {
 420     Graphics::ProgramState programState{};
 421     programState.program = &queryInfo.program->GetGraphicsProgram();
 422     // Create the pipeline
 423     Graphics::PipelineCreateInfo createInfo;
 424     createInfo
 425       .SetInputAssemblyState(&level1->ia)
 426       .SetVertexInputState(&level0->inputState)
 427       .SetRasterizationState(&level1->rs)
 428       .SetColorBlendState(&level2->colorBlendState)
 429       .SetProgramState(&programState);
 430
 431     // Store a pipeline per renderer per render (renderer can be owned by multiple nodes,
 432     // and re-drawn in multiple instructions).
 433     level2->pipeline = graphicsController->CreatePipeline(createInfo, nullptr);
 434   }
 435
 436   PipelineResult result{};
 437
 438   result.pipeline = level2->pipeline.get();
 439   result.level0   = level0;
 440   result.level1   = level1;
 441   result.level2   = level2;
 442
 443   return result;
 444 }
 445
 446 } // namespace Dali::Internal::Render