dali/internal/render/common/render-manager.cpp

   1 /*
   2  * Copyright (c) 2014 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/render/common/render-manager.h>
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/actors/sampling.h>
  23 #include <dali/public-api/common/dali-common.h>
  24 #include <dali/public-api/common/stage.h>
  25 #include <dali/public-api/render-tasks/render-task.h>
  26 #include <dali/integration-api/debug.h>
  27 #include <dali/integration-api/core.h>
  28 #include <dali/internal/common/owner-pointer.h>
  29 #include <dali/internal/render/queue/render-queue.h>
  30 #include <dali/internal/render/common/render-algorithms.h>
  31 #include <dali/internal/render/common/render-debug.h>
  32 #include <dali/internal/render/common/render-tracker.h>
  33 #include <dali/internal/render/common/render-instruction-container.h>
  34 #include <dali/internal/render/common/render-instruction.h>
  35 #include <dali/internal/render/gl-resources/context.h>
  36 #include <dali/internal/render/gl-resources/frame-buffer-texture.h>
  37 #include <dali/internal/render/gl-resources/texture-cache.h>
  38 #include <dali/internal/render/renderers/render-renderer.h>
  39 #include <dali/internal/render/renderers/render-geometry.h>
  40 #include <dali/internal/render/renderers/render-sampler.h>
  41 #include <dali/internal/render/shaders/program-controller.h>
  42
  43 // Uncomment the next line to enable frame snapshot logging
  44 //#define FRAME_SNAPSHOT_LOGGING
  45
  46 #ifdef FRAME_SNAPSHOT_LOGGING
  47
  48
  49 namespace // unnamed namespace
  50 {
  51 unsigned int SNAPSHOT_FRAME_FREQUENCY = 1200; // dump every 20-30 seconds
  52 } // unnamed namespace
  53
  54 #define SET_SNAPSHOT_FRAME_LOG_LEVEL \
  55   DALI_LOG_FILTER_SET_LEVEL(Context::gGlLogFilter, ((GetFrameCount() % SNAPSHOT_FRAME_FREQUENCY)==5 ? Debug::General : Debug::Concise));
  56
  57 #else // FRAME_SNAPSHOT_LOGGING
  58
  59 #define SET_SNAPSHOT_FRAME_LOG_LEVEL
  60
  61 #endif // FRAME_SNAPSHOT_LOGGING
  62
  63 namespace Dali
  64 {
  65
  66 namespace Internal
  67 {
  68
  69 namespace SceneGraph
  70 {
  71
  72 typedef OwnerContainer< Render::Renderer* >    RendererOwnerContainer;
  73 typedef RendererOwnerContainer::Iterator       RendererOwnerIter;
  74
  75 typedef OwnerContainer< RenderGeometry* >      RenderGeometryOwnerContainer;
  76 typedef RenderGeometryOwnerContainer::Iterator RenderGeometryOwnerIter;
  77
  78 typedef OwnerContainer< Render::Sampler* >    SamplerOwnerContainer;
  79 typedef SamplerOwnerContainer::Iterator       SamplerOwnerIter;
  80
  81 typedef OwnerContainer< RenderTracker* >       RenderTrackerContainer;
  82 typedef RenderTrackerContainer::Iterator       RenderTrackerIter;
  83 typedef RenderTrackerContainer::ConstIterator  RenderTrackerConstIter;
  84
  85 /**
  86  * Structure to contain internal data
  87  */
  88 struct RenderManager::Impl
  89 {
  90   Impl( Dali::Integration::GlAbstraction& glAbstraction,
  91         ResourcePostProcessList& resourcePostProcessQ,
  92         PostProcessResourceDispatcher& postProcessDispatcher )
  93   : context( glAbstraction ),
  94     renderQueue(),
  95     textureCache( renderQueue, postProcessDispatcher, context ),
  96     resourcePostProcessQueue( resourcePostProcessQ ),
  97     instructions(),
  98     backgroundColor( Dali::Stage::DEFAULT_BACKGROUND_COLOR ),
  99     frameCount( 0 ),
 100     renderBufferIndex( SceneGraphBuffers::INITIAL_UPDATE_BUFFER_INDEX ),
 101     defaultSurfaceRect(),
 102     rendererContainer(),
 103     samplerContainer(),
 104     renderersAdded( false ),
 105     firstRenderCompleted( false ),
 106     defaultShader( NULL ),
 107     programController( glAbstraction )
 108   {
 109   }
 110
 111   ~Impl()
 112   {
 113   }
 114
 115   void AddRenderTracker( RenderTracker* renderTracker )
 116   {
 117     DALI_ASSERT_DEBUG( renderTracker != NULL );
 118     mRenderTrackers.PushBack( renderTracker );
 119   }
 120
 121   void RemoveRenderTracker( RenderTracker* renderTracker )
 122   {
 123     DALI_ASSERT_DEBUG( renderTracker != NULL );
 124     for(RenderTrackerIter iter = mRenderTrackers.Begin(), end = mRenderTrackers.End(); iter != end; ++iter)
 125     {
 126       if( *iter == renderTracker )
 127       {
 128         mRenderTrackers.Erase( iter );
 129         break;
 130       }
 131     }
 132   }
 133
 134   void UpdateTrackers()
 135   {
 136     for(RenderTrackerIter iter = mRenderTrackers.Begin(), end = mRenderTrackers.End(); iter != end; ++iter)
 137     {
 138       (*iter)->PollSyncObject();
 139     }
 140   }
 141
 142   // the order is important for destruction,
 143   // programs are owned by context at the moment.
 144   Context                       context;                  ///< holds the GL state
 145   RenderQueue                   renderQueue;              ///< A message queue for receiving messages from the update-thread.
 146   TextureCache                  textureCache;             ///< Cache for all GL textures
 147   ResourcePostProcessList&      resourcePostProcessQueue; ///< A queue for requesting resource post processing in update thread
 148
 149   // Render instructions describe what should be rendered during RenderManager::Render()
 150   // Owned by RenderManager. Update manager updates instructions for the next frame while we render the current one
 151   RenderInstructionContainer    instructions;
 152
 153   Vector4                       backgroundColor;          ///< The glClear color used at the beginning of each frame.
 154
 155   unsigned int                  frameCount;               ///< The current frame count
 156   BufferIndex                   renderBufferIndex;        ///< The index of the buffer to read from; this is opposite of the "update" buffer
 157
 158   Rect<int>                     defaultSurfaceRect;       ///< Rectangle for the default surface we are rendering to
 159
 160   RendererOwnerContainer        rendererContainer;        ///< List of owned renderers
 161   SamplerOwnerContainer         samplerContainer;         ///< List of owned samplers
 162   RenderGeometryOwnerContainer  renderGeometryContainer;  ///< List of owned RenderGeometries
 163
 164   bool                          renderersAdded;
 165
 166   RenderTrackerContainer        mRenderTrackers;          ///< List of render trackers
 167
 168   bool                          firstRenderCompleted;     ///< False until the first render is done
 169   Shader*                       defaultShader;            ///< Default shader to use
 170   ProgramController             programController;        ///< Owner of the GL programs
 171 };
 172
 173 RenderManager* RenderManager::New( Integration::GlAbstraction& glAbstraction, ResourcePostProcessList& resourcePostProcessQ )
 174 {
 175   RenderManager* manager = new RenderManager;
 176   manager->mImpl = new Impl( glAbstraction, resourcePostProcessQ, *manager );
 177   return manager;
 178 }
 179
 180 RenderManager::RenderManager()
 181 : mImpl(NULL)
 182 {
 183 }
 184
 185 RenderManager::~RenderManager()
 186 {
 187   delete mImpl;
 188 }
 189
 190 RenderQueue& RenderManager::GetRenderQueue()
 191 {
 192   return mImpl->renderQueue;
 193 }
 194
 195 TextureCache& RenderManager::GetTextureCache()
 196 {
 197   return mImpl->textureCache;
 198 }
 199
 200 void RenderManager::ContextCreated()
 201 {
 202   mImpl->context.GlContextCreated();
 203   mImpl->programController.GlContextCreated();
 204
 205   // renderers, textures and gpu buffers cannot reinitialize themselves
 206   // so they rely on someone reloading the data for them
 207 }
 208
 209 void RenderManager::ContextDestroyed()
 210 {
 211   // @todo Set an atomic value to prevent render manager rendering again until
 212   // ContextCreated has been called.
 213
 214   mImpl->context.GlContextDestroyed();
 215   mImpl->programController.GlContextDestroyed();
 216
 217   // inform texture cache
 218   mImpl->textureCache.GlContextDestroyed(); // Clears gl texture ids
 219
 220   // inform renderers
 221   RendererOwnerContainer::Iterator end = mImpl->rendererContainer.End();
 222   RendererOwnerContainer::Iterator iter = mImpl->rendererContainer.Begin();
 223   for( ; iter != end; ++iter )
 224   {
 225     GlResourceOwner* renderer = *iter;
 226     renderer->GlContextDestroyed(); // Clear up vertex buffers
 227   }
 228 }
 229
 230 void RenderManager::DispatchPostProcessRequest(ResourcePostProcessRequest& request)
 231 {
 232   mImpl->resourcePostProcessQueue[ mImpl->renderBufferIndex ].push_back( request );
 233 }
 234
 235 void RenderManager::SetShaderSaver( ShaderSaver& upstream )
 236 {
 237   mImpl->programController.SetShaderSaver( upstream );
 238 }
 239
 240 RenderInstructionContainer& RenderManager::GetRenderInstructionContainer()
 241 {
 242   return mImpl->instructions;
 243 }
 244
 245 void RenderManager::SetBackgroundColor( const Vector4& color )
 246 {
 247   mImpl->backgroundColor = color;
 248 }
 249
 250 void RenderManager::SetDefaultSurfaceRect(const Rect<int>& rect)
 251 {
 252   mImpl->defaultSurfaceRect = rect;
 253 }
 254
 255 void RenderManager::AddRenderer( Render::Renderer* renderer )
 256 {
 257   // Initialize the renderer as we are now in render thread
 258   renderer->Initialize( mImpl->context, mImpl->textureCache );
 259
 260   mImpl->rendererContainer.PushBack( renderer );
 261
 262   if( !mImpl->renderersAdded )
 263   {
 264     mImpl->renderersAdded = true;
 265   }
 266 }
 267
 268 void RenderManager::RemoveRenderer( Render::Renderer* renderer )
 269 {
 270   DALI_ASSERT_DEBUG( NULL != renderer );
 271
 272   RendererOwnerContainer& renderers = mImpl->rendererContainer;
 273
 274   // Find the renderer
 275   for ( RendererOwnerIter iter = renderers.Begin(); iter != renderers.End(); ++iter )
 276   {
 277     if ( *iter == renderer )
 278     {
 279       renderers.Erase( iter ); // Renderer found; now destroy it
 280       break;
 281     }
 282   }
 283 }
 284
 285 void RenderManager::AddSampler( Render::Sampler* sampler )
 286 {
 287   mImpl->samplerContainer.PushBack( sampler );
 288 }
 289
 290 void RenderManager::RemoveSampler( Render::Sampler* sampler )
 291 {
 292   DALI_ASSERT_DEBUG( NULL != sampler );
 293
 294   SamplerOwnerContainer& samplers = mImpl->samplerContainer;
 295
 296   // Find the sampler
 297   for ( SamplerOwnerIter iter = samplers.Begin(); iter != samplers.End(); ++iter )
 298   {
 299     if ( *iter == sampler )
 300     {
 301       samplers.Erase( iter ); // Sampler found; now destroy it
 302       break;
 303     }
 304   }
 305 }
 306
 307 void RenderManager::SetFilterMode( Render::Sampler* sampler, unsigned int minFilterMode, unsigned int magFilterMode )
 308 {
 309   sampler->SetFilterMode( (Dali::FilterMode::Type)minFilterMode, (Dali::FilterMode::Type)magFilterMode );
 310 }
 311
 312 void RenderManager::SetWrapMode( Render::Sampler* sampler, unsigned int uWrapMode, unsigned int vWrapMode )
 313 {
 314   sampler->SetWrapMode( (Dali::WrapMode::Type)uWrapMode, (Dali::WrapMode::Type)vWrapMode );
 315 }
 316
 317 void RenderManager::AddGeometry( RenderGeometry* renderGeometry )
 318 {
 319   mImpl->renderGeometryContainer.PushBack( renderGeometry );
 320 }
 321
 322 void RenderManager::RemoveGeometry( RenderGeometry* renderGeometry )
 323 {
 324   DALI_ASSERT_DEBUG( NULL != renderGeometry );
 325
 326   RenderGeometryOwnerContainer& geometries = mImpl->renderGeometryContainer;
 327
 328   // Find the geometry
 329   for ( RenderGeometryOwnerIter iter = geometries.Begin(); iter != geometries.End(); ++iter )
 330   {
 331     if ( *iter == renderGeometry )
 332     {
 333       geometries.Erase( iter ); // Geometry found; now destroy it
 334       break;
 335     }
 336   }
 337 }
 338
 339 void RenderManager::AddPropertyBuffer( RenderGeometry* renderGeometry, PropertyBufferDataProvider* propertyBuffer, const GpuBuffer::Target& target, const GpuBuffer::Usage& usage )
 340 {
 341   DALI_ASSERT_DEBUG( NULL != renderGeometry );
 342
 343   RenderGeometryOwnerContainer& geometries = mImpl->renderGeometryContainer;
 344
 345   // Find the renderer
 346   for ( RenderGeometryOwnerIter iter = geometries.Begin(); iter != geometries.End(); ++iter )
 347   {
 348     if ( *iter == renderGeometry )
 349     {
 350       (*iter)->AddPropertyBuffer( propertyBuffer, target, usage );
 351       break;
 352     }
 353   }
 354 }
 355
 356 void RenderManager::RemovePropertyBuffer( RenderGeometry* renderGeometry, PropertyBufferDataProvider* propertyBuffer )
 357 {
 358   DALI_ASSERT_DEBUG( NULL != renderGeometry );
 359
 360   RenderGeometryOwnerContainer& geometries = mImpl->renderGeometryContainer;
 361
 362   // Find the renderer
 363   for ( RenderGeometryOwnerIter iter = geometries.Begin(); iter != geometries.End(); ++iter )
 364   {
 365     if ( *iter == renderGeometry )
 366     {
 367       (*iter)->RemovePropertyBuffer( propertyBuffer );
 368       break;
 369     }
 370   }
 371 }
 372
 373
 374 void RenderManager::AddRenderTracker( RenderTracker* renderTracker )
 375 {
 376   mImpl->AddRenderTracker(renderTracker);
 377 }
 378
 379 void RenderManager::RemoveRenderTracker( RenderTracker* renderTracker )
 380 {
 381   mImpl->RemoveRenderTracker(renderTracker);
 382 }
 383
 384 void RenderManager::SetDefaultShader( Shader* shader )
 385 {
 386   mImpl->defaultShader = shader;
 387 }
 388
 389 ProgramCache* RenderManager::GetProgramCache()
 390 {
 391   return &(mImpl->programController);
 392 }
 393
 394 bool RenderManager::Render( Integration::RenderStatus& status )
 395 {
 396   DALI_PRINT_RENDER_START( mImpl->renderBufferIndex );
 397
 398   // Core::Render documents that GL context must be current before calling Render
 399   DALI_ASSERT_DEBUG( mImpl->context.IsGlContextCreated() );
 400
 401   status.SetHasRendered( false );
 402
 403   // Increment the frame count at the beginning of each frame
 404   ++(mImpl->frameCount);
 405   mImpl->context.SetFrameCount(mImpl->frameCount);
 406   mImpl->context.ClearRendererCount();
 407   mImpl->context.ClearCulledCount();
 408
 409   PERF_MONITOR_START(PerformanceMonitor::DRAW_NODES);
 410
 411   SET_SNAPSHOT_FRAME_LOG_LEVEL;
 412
 413   // Process messages queued during previous update
 414   mImpl->renderQueue.ProcessMessages( mImpl->renderBufferIndex );
 415
 416   // No need to make any gl calls if we've done 1st glClear & don't have any renderers to render during startup.
 417   if( !mImpl->firstRenderCompleted || mImpl->renderersAdded )
 418   {
 419     // switch rendering to adaptor provided (default) buffer
 420     mImpl->context.BindFramebuffer( GL_FRAMEBUFFER, 0 );
 421
 422     mImpl->context.Viewport( mImpl->defaultSurfaceRect.x,
 423                              mImpl->defaultSurfaceRect.y,
 424                              mImpl->defaultSurfaceRect.width,
 425                              mImpl->defaultSurfaceRect.height );
 426
 427     mImpl->context.ClearColor( mImpl->backgroundColor.r,
 428                                mImpl->backgroundColor.g,
 429                                mImpl->backgroundColor.b,
 430                                mImpl->backgroundColor.a );
 431
 432     mImpl->context.ClearStencil( 0 );
 433
 434     // Clear the entire color, depth and stencil buffers for the default framebuffer.
 435     // It is important to clear all 3 buffers, for performance on deferred renderers like Mali
 436     // e.g. previously when the depth & stencil buffers were NOT cleared, it caused the DDK to exceed a "vertex count limit",
 437     // and then stall. That problem is only noticeable when rendering a large number of vertices per frame.
 438     mImpl->context.SetScissorTest( false );
 439     mImpl->context.ColorMask( true );
 440     mImpl->context.DepthMask( true );
 441     mImpl->context.StencilMask( 0xFF ); // 8 bit stencil mask, all 1's
 442     mImpl->context.Clear( GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT,  Context::FORCE_CLEAR );
 443
 444     // reset the program matrices for all programs once per frame
 445     // this ensures we will set view and projection matrix once per program per camera
 446     mImpl->programController.ResetProgramMatrices();
 447
 448     // if we don't have default shader, no point doing the render calls
 449     if( mImpl->defaultShader )
 450     {
 451       size_t count = mImpl->instructions.Count( mImpl->renderBufferIndex );
 452       for ( size_t i = 0; i < count; ++i )
 453       {
 454         RenderInstruction& instruction = mImpl->instructions.At( mImpl->renderBufferIndex, i );
 455
 456         DoRender( instruction, *mImpl->defaultShader );
 457
 458         const RenderListContainer::SizeType countRenderList = instruction.RenderListCount();
 459         if ( countRenderList > 0 )
 460         {
 461           status.SetHasRendered( true );
 462         }
 463       }
 464       GLenum attachments[] = { GL_DEPTH, GL_STENCIL };
 465       mImpl->context.InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
 466
 467       mImpl->UpdateTrackers();
 468
 469       mImpl->firstRenderCompleted = true;
 470     }
 471   }
 472
 473   PERF_MONITOR_END(PerformanceMonitor::DRAW_NODES);
 474
 475   // check if anything has been posted to the update thread
 476   bool updateRequired = !mImpl->resourcePostProcessQueue[ mImpl->renderBufferIndex ].empty();
 477
 478   //Notify RenderGeometries that rendering has finished
 479   for ( RenderGeometryOwnerIter iter = mImpl->renderGeometryContainer.Begin(); iter != mImpl->renderGeometryContainer.End(); ++iter )
 480   {
 481     (*iter)->OnRenderFinished();
 482   }
 483
 484   /**
 485    * The rendering has finished; swap to the next buffer.
 486    * Ideally the update has just finished using this buffer; otherwise the render thread
 487    * should block until the update has finished.
 488    */
 489   mImpl->renderBufferIndex = (0 != mImpl->renderBufferIndex) ? 0 : 1;
 490
 491   DALI_PRINT_RENDER_END();
 492
 493   DALI_PRINT_RENDERER_COUNT(mImpl->frameCount, mImpl->context.GetRendererCount());
 494   DALI_PRINT_CULL_COUNT(mImpl->frameCount, mImpl->context.GetCulledCount());
 495
 496   return updateRequired;
 497 }
 498
 499 void RenderManager::DoRender( RenderInstruction& instruction, Shader& defaultShader )
 500 {
 501   Rect<int> viewportRect;
 502   Vector4   clearColor;
 503
 504   if ( instruction.mIsClearColorSet )
 505   {
 506     clearColor = instruction.mClearColor;
 507   }
 508   else
 509   {
 510     clearColor = Dali::RenderTask::DEFAULT_CLEAR_COLOR;
 511   }
 512
 513   FrameBufferTexture* offscreen = NULL;
 514
 515   if ( instruction.mOffscreenTextureId != 0 )
 516   {
 517     offscreen = mImpl->textureCache.GetFramebuffer( instruction.mOffscreenTextureId );
 518     DALI_ASSERT_DEBUG( NULL != offscreen );
 519
 520     if( NULL != offscreen &&
 521         offscreen->Prepare() )
 522     {
 523       // Check whether a viewport is specified, otherwise the full surface size is used
 524       if ( instruction.mIsViewportSet )
 525       {
 526         // For glViewport the lower-left corner is (0,0)
 527         const int y = ( offscreen->GetHeight() - instruction.mViewport.height ) - instruction.mViewport.y;
 528         viewportRect.Set( instruction.mViewport.x,  y, instruction.mViewport.width, instruction.mViewport.height );
 529       }
 530       else
 531       {
 532         viewportRect.Set( 0, 0, offscreen->GetWidth(), offscreen->GetHeight() );
 533       }
 534     }
 535     else
 536     {
 537       // Offscreen is NULL or could not be prepared.
 538       return;
 539     }
 540   }
 541   else // !(instruction.mOffscreenTexture)
 542   {
 543     // switch rendering to adaptor provided (default) buffer
 544     mImpl->context.BindFramebuffer( GL_FRAMEBUFFER, 0 );
 545
 546     // Check whether a viewport is specified, otherwise the full surface size is used
 547     if ( instruction.mIsViewportSet )
 548     {
 549       // For glViewport the lower-left corner is (0,0)
 550       const int y = ( mImpl->defaultSurfaceRect.height - instruction.mViewport.height ) - instruction.mViewport.y;
 551       viewportRect.Set( instruction.mViewport.x,  y, instruction.mViewport.width, instruction.mViewport.height );
 552     }
 553     else
 554     {
 555       viewportRect = mImpl->defaultSurfaceRect;
 556     }
 557   }
 558
 559   mImpl->context.Viewport(viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height);
 560
 561   if ( instruction.mIsClearColorSet )
 562   {
 563     mImpl->context.ClearColor( clearColor.r,
 564                                clearColor.g,
 565                                clearColor.b,
 566                                clearColor.a );
 567
 568     // Clear the viewport area only
 569     mImpl->context.SetScissorTest( true );
 570     mImpl->context.Scissor( viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height );
 571     mImpl->context.ColorMask( true );
 572     mImpl->context.Clear( GL_COLOR_BUFFER_BIT , Context::CHECK_CACHED_VALUES );
 573     mImpl->context.SetScissorTest( false );
 574   }
 575
 576   Render::ProcessRenderInstruction( instruction,
 577                                     mImpl->context,
 578                                     mImpl->textureCache,
 579                                     defaultShader,
 580                                     mImpl->renderBufferIndex );
 581
 582   if(instruction.mOffscreenTextureId != 0)
 583   {
 584     GLenum attachments[] = { GL_DEPTH_ATTACHMENT, GL_STENCIL_ATTACHMENT };
 585     mImpl->context.InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
 586   }
 587
 588   if( instruction.mRenderTracker && offscreen != NULL )
 589   {
 590     instruction.mRenderTracker->CreateSyncObject();
 591     instruction.mRenderTracker = NULL; // Only create once.
 592   }
 593 }
 594
 595 } // namespace SceneGraph
 596
 597 } // namespace Internal
 598
 599 } // namespace Dali