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/common/dali-common.h>
  23 #include <dali/public-api/common/stage.h>
  24 #include <dali/public-api/render-tasks/render-task.h>
  25 #include <dali/integration-api/debug.h>
  26 #include <dali/integration-api/core.h>
  27 #include <dali/internal/common/owner-pointer.h>
  28 #include <dali/internal/render/queue/render-queue.h>
  29 #include <dali/internal/render/common/render-algorithms.h>
  30 #include <dali/internal/render/common/render-debug.h>
  31 #include <dali/internal/render/common/render-tracker.h>
  32 #include <dali/internal/render/common/render-instruction-container.h>
  33 #include <dali/internal/render/common/render-instruction.h>
  34 #include <dali/internal/render/gl-resources/context.h>
  35 #include <dali/internal/render/gl-resources/frame-buffer-texture.h>
  36 #include <dali/internal/render/gl-resources/native-frame-buffer-texture.h>
  37 #include <dali/internal/render/gl-resources/texture-cache.h>
  38 #include <dali/internal/render/renderers/scene-graph-renderer.h>
  39 #include <dali/internal/render/renderers/render-geometry.h>
  40 #include <dali/internal/render/shaders/program-controller.h>
  41
  42 // Uncomment the next line to enable frame snapshot logging
  43 //#define FRAME_SNAPSHOT_LOGGING
  44
  45 #ifdef FRAME_SNAPSHOT_LOGGING
  46
  47 using namespace Dali::Internal::Render;
  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< Renderer* >            RendererOwnerContainer;
  73 typedef RendererOwnerContainer::Iterator       RendererOwnerIter;
  74
  75 typedef OwnerContainer< RenderGeometry* >      RenderGeometryOwnerContainer;
  76 typedef RenderGeometryOwnerContainer::Iterator RenderGeometryOwnerIter;
  77
  78 typedef OwnerContainer< RenderTracker* >       RenderTrackerContainer;
  79 typedef RenderTrackerContainer::Iterator       RenderTrackerIter;
  80 typedef RenderTrackerContainer::ConstIterator  RenderTrackerConstIter;
  81
  82 /**
  83  * Structure to contain internal data
  84  */
  85 struct RenderManager::Impl
  86 {
  87   Impl( Dali::Integration::GlAbstraction& glAbstraction,
  88         ResourcePostProcessList& resourcePostProcessQ,
  89         PostProcessResourceDispatcher& postProcessDispatcher )
  90   : context( glAbstraction ),
  91     renderQueue(),
  92     textureCache( renderQueue, postProcessDispatcher, context ),
  93     resourcePostProcessQueue( resourcePostProcessQ ),
  94     instructions(),
  95     backgroundColor( Dali::Stage::DEFAULT_BACKGROUND_COLOR ),
  96     frameTime( 0.0f ),
  97     lastFrameTime( 0.0f ),
  98     frameCount( 0 ),
  99     renderBufferIndex( SceneGraphBuffers::INITIAL_UPDATE_BUFFER_INDEX ),
 100     defaultSurfaceRect(),
 101     rendererContainer(),
 102     renderersAdded( false ),
 103     firstRenderCompleted( false ),
 104     defaultShader( NULL ),
 105     programController( glAbstraction )
 106   {
 107   }
 108
 109   ~Impl()
 110   {
 111   }
 112
 113   void AddRenderTracker( RenderTracker* renderTracker )
 114   {
 115     DALI_ASSERT_DEBUG( renderTracker != NULL );
 116     mRenderTrackers.PushBack( renderTracker );
 117   }
 118
 119   void RemoveRenderTracker( RenderTracker* renderTracker )
 120   {
 121     DALI_ASSERT_DEBUG( renderTracker != NULL );
 122     for(RenderTrackerIter iter = mRenderTrackers.Begin(), end = mRenderTrackers.End(); iter != end; ++iter)
 123     {
 124       if( *iter == renderTracker )
 125       {
 126         mRenderTrackers.Erase( iter );
 127         break;
 128       }
 129     }
 130   }
 131
 132   void UpdateTrackers()
 133   {
 134     for(RenderTrackerIter iter = mRenderTrackers.Begin(), end = mRenderTrackers.End(); iter != end; ++iter)
 135     {
 136       (*iter)->PollSyncObject();
 137     }
 138   }
 139
 140   // the order is important for destruction,
 141   // programs are owned by context at the moment.
 142   Context                       context;                  ///< holds the GL state
 143   RenderQueue                   renderQueue;              ///< A message queue for receiving messages from the update-thread.
 144   TextureCache                  textureCache;             ///< Cache for all GL textures
 145   ResourcePostProcessList&      resourcePostProcessQueue; ///< A queue for requesting resource post processing in update thread
 146
 147   // Render instructions describe what should be rendered during RenderManager::Render()
 148   // Owned by RenderManager. Update manager updates instructions for the next frame while we render the current one
 149   RenderInstructionContainer    instructions;
 150
 151   Vector4                       backgroundColor;          ///< The glClear color used at the beginning of each frame.
 152
 153   volatile float                frameTime;                ///< The elapsed time since the previous frame
 154   float                         lastFrameTime;            ///< Last frame delta.
 155
 156   unsigned int                  frameCount;               ///< The current frame count
 157   BufferIndex                   renderBufferIndex;        ///< The index of the buffer to read from; this is opposite of the "update" buffer
 158
 159   Rect<int>                     defaultSurfaceRect;       ///< Rectangle for the default surface we are rendering to
 160
 161   RendererOwnerContainer        rendererContainer;        ///< List of owned renderers
 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::SetFrameDeltaTime( float deltaTime )
 251 {
 252   Dali::Mutex::ScopedLock lock( mMutex );
 253   mImpl->frameTime = deltaTime;
 254 }
 255
 256 void RenderManager::SetDefaultSurfaceRect(const Rect<int>& rect)
 257 {
 258   mImpl->defaultSurfaceRect = rect;
 259 }
 260
 261 void RenderManager::AddRenderer( Renderer* renderer )
 262 {
 263   // Initialize the renderer as we are now in render thread
 264   renderer->Initialize( mImpl->context, mImpl->textureCache );
 265
 266   mImpl->rendererContainer.PushBack( renderer );
 267
 268   if( !mImpl->renderersAdded )
 269   {
 270     mImpl->renderersAdded = true;
 271   }
 272 }
 273
 274 void RenderManager::RemoveRenderer( Renderer* renderer )
 275 {
 276   DALI_ASSERT_DEBUG( NULL != renderer );
 277
 278   RendererOwnerContainer& renderers = mImpl->rendererContainer;
 279
 280   // Find the renderer
 281   for ( RendererOwnerIter iter = renderers.Begin(); iter != renderers.End(); ++iter )
 282   {
 283     if ( *iter == renderer )
 284     {
 285       renderers.Erase( iter ); // Renderer found; now destroy it
 286       break;
 287     }
 288   }
 289 }
 290
 291 void RenderManager::AddGeometry( RenderGeometry* renderGeometry )
 292 {
 293   mImpl->renderGeometryContainer.PushBack( renderGeometry );
 294 }
 295
 296 void RenderManager::RemoveGeometry( RenderGeometry* renderGeometry )
 297 {
 298   DALI_ASSERT_DEBUG( NULL != renderGeometry );
 299
 300   RenderGeometryOwnerContainer& geometries = mImpl->renderGeometryContainer;
 301
 302   // Find the renderer
 303   for ( RenderGeometryOwnerIter iter = geometries.Begin(); iter != geometries.End(); ++iter )
 304   {
 305     if ( *iter == renderGeometry )
 306     {
 307       geometries.Erase( iter ); // Geometry found; now destroy it
 308       break;
 309     }
 310   }
 311 }
 312
 313 void RenderManager::AddPropertyBuffer( RenderGeometry* renderGeometry, PropertyBufferDataProvider* propertyBuffer, const GpuBuffer::Target& target, const GpuBuffer::Usage& usage )
 314 {
 315   DALI_ASSERT_DEBUG( NULL != renderGeometry );
 316
 317   RenderGeometryOwnerContainer& geometries = mImpl->renderGeometryContainer;
 318
 319   // Find the renderer
 320   for ( RenderGeometryOwnerIter iter = geometries.Begin(); iter != geometries.End(); ++iter )
 321   {
 322     if ( *iter == renderGeometry )
 323     {
 324       (*iter)->AddPropertyBuffer( propertyBuffer, target, usage );
 325       break;
 326     }
 327   }
 328 }
 329
 330 void RenderManager::RemovePropertyBuffer( RenderGeometry* renderGeometry, PropertyBufferDataProvider* propertyBuffer )
 331 {
 332   DALI_ASSERT_DEBUG( NULL != renderGeometry );
 333
 334   RenderGeometryOwnerContainer& geometries = mImpl->renderGeometryContainer;
 335
 336   // Find the renderer
 337   for ( RenderGeometryOwnerIter iter = geometries.Begin(); iter != geometries.End(); ++iter )
 338   {
 339     if ( *iter == renderGeometry )
 340     {
 341       (*iter)->RemovePropertyBuffer( propertyBuffer );
 342       break;
 343     }
 344   }
 345 }
 346
 347
 348 void RenderManager::AddRenderTracker( RenderTracker* renderTracker )
 349 {
 350   mImpl->AddRenderTracker(renderTracker);
 351 }
 352
 353 void RenderManager::RemoveRenderTracker( RenderTracker* renderTracker )
 354 {
 355   mImpl->RemoveRenderTracker(renderTracker);
 356 }
 357
 358 void RenderManager::SetDefaultShader( Shader* shader )
 359 {
 360   mImpl->defaultShader = shader;
 361 }
 362
 363 ProgramCache* RenderManager::GetProgramCache()
 364 {
 365   return &(mImpl->programController);
 366 }
 367
 368 bool RenderManager::Render( Integration::RenderStatus& status )
 369 {
 370   DALI_PRINT_RENDER_START( mImpl->renderBufferIndex );
 371
 372   // Core::Render documents that GL context must be current before calling Render
 373   DALI_ASSERT_DEBUG( mImpl->context.IsGlContextCreated() );
 374
 375   status.SetHasRendered( false );
 376
 377   // Increment the frame count at the beginning of each frame
 378   ++(mImpl->frameCount);
 379   mImpl->context.SetFrameCount(mImpl->frameCount);
 380   mImpl->context.ClearRendererCount();
 381   mImpl->context.ClearCulledCount();
 382
 383   PERF_MONITOR_START(PerformanceMonitor::DRAW_NODES);
 384
 385   SET_SNAPSHOT_FRAME_LOG_LEVEL;
 386
 387   // Process messages queued during previous update
 388   mImpl->renderQueue.ProcessMessages( mImpl->renderBufferIndex );
 389
 390   // No need to make any gl calls if we've done 1st glClear & don't have any renderers to render during startup.
 391   if( !mImpl->firstRenderCompleted || mImpl->renderersAdded )
 392   {
 393     // switch rendering to adaptor provided (default) buffer
 394     mImpl->context.BindFramebuffer( GL_FRAMEBUFFER, 0 );
 395
 396     mImpl->context.Viewport( mImpl->defaultSurfaceRect.x,
 397                              mImpl->defaultSurfaceRect.y,
 398                              mImpl->defaultSurfaceRect.width,
 399                              mImpl->defaultSurfaceRect.height );
 400
 401     mImpl->context.ClearColor( mImpl->backgroundColor.r,
 402                                mImpl->backgroundColor.g,
 403                                mImpl->backgroundColor.b,
 404                                mImpl->backgroundColor.a );
 405
 406     mImpl->context.ClearStencil( 0 );
 407
 408     // Clear the entire color, depth and stencil buffers for the default framebuffer.
 409     // It is important to clear all 3 buffers, for performance on deferred renderers like Mali
 410     // e.g. previously when the depth & stencil buffers were NOT cleared, it caused the DDK to exceed a "vertex count limit",
 411     // and then stall. That problem is only noticeable when rendering a large number of vertices per frame.
 412     mImpl->context.SetScissorTest( false );
 413     mImpl->context.ColorMask( true );
 414     mImpl->context.DepthMask( true );
 415     mImpl->context.StencilMask( 0xFF ); // 8 bit stencil mask, all 1's
 416     mImpl->context.Clear( GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT,  Context::FORCE_CLEAR );
 417
 418     // reset the program matrices for all programs once per frame
 419     // this ensures we will set view and projection matrix once per program per camera
 420     // @todo move programs out of context onto a program controller and let that handle this
 421     mImpl->programController.ResetProgramMatrices();
 422
 423     // if we don't have default shader, no point doing the render calls
 424     if( mImpl->defaultShader )
 425     {
 426       size_t count = mImpl->instructions.Count( mImpl->renderBufferIndex );
 427       for ( size_t i = 0; i < count; ++i )
 428       {
 429         RenderInstruction& instruction = mImpl->instructions.At( mImpl->renderBufferIndex, i );
 430
 431         DoRender( instruction, *mImpl->defaultShader, mImpl->lastFrameTime );
 432
 433         const RenderListContainer::SizeType countRenderList = instruction.RenderListCount();
 434         if ( countRenderList > 0 )
 435         {
 436           status.SetHasRendered( true );
 437         }
 438       }
 439       GLenum attachments[] = { GL_DEPTH, GL_STENCIL };
 440       mImpl->context.InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
 441
 442       mImpl->UpdateTrackers();
 443
 444       mImpl->firstRenderCompleted = true;
 445     }
 446   }
 447
 448   PERF_MONITOR_END(PerformanceMonitor::DRAW_NODES);
 449
 450   SetLastFrameTime();
 451
 452   // check if anything has been posted to the update thread
 453   bool updateRequired = !mImpl->resourcePostProcessQueue[ mImpl->renderBufferIndex ].empty();
 454
 455   //Notify RenderGeometries that rendering has finished
 456   for ( RenderGeometryOwnerIter iter = mImpl->renderGeometryContainer.Begin(); iter != mImpl->renderGeometryContainer.End(); ++iter )
 457   {
 458     (*iter)->OnRenderFinished();
 459   }
 460
 461   /**
 462    * The rendering has finished; swap to the next buffer.
 463    * Ideally the update has just finished using this buffer; otherwise the render thread
 464    * should block until the update has finished.
 465    */
 466   mImpl->renderBufferIndex = (0 != mImpl->renderBufferIndex) ? 0 : 1;
 467
 468   DALI_PRINT_RENDER_END();
 469
 470   DALI_PRINT_RENDERER_COUNT(mImpl->frameCount, mImpl->context.GetRendererCount());
 471   DALI_PRINT_CULL_COUNT(mImpl->frameCount, mImpl->context.GetCulledCount());
 472
 473   return updateRequired;
 474 }
 475
 476 void RenderManager::SetLastFrameTime()
 477 {
 478   Dali::Mutex::ScopedLock lock(mMutex);
 479   mImpl->lastFrameTime = mImpl->frameTime;
 480 }
 481
 482 void RenderManager::DoRender( RenderInstruction& instruction, Shader& defaultShader, float elapsedTime )
 483 {
 484   Rect<int> viewportRect;
 485   Vector4   clearColor;
 486
 487   if ( instruction.mIsClearColorSet )
 488   {
 489     clearColor = instruction.mClearColor;
 490   }
 491   else
 492   {
 493     clearColor = Dali::RenderTask::DEFAULT_CLEAR_COLOR;
 494   }
 495
 496   FrameBufferTexture* offscreen = NULL;
 497
 498   if ( instruction.mOffscreenTextureId != 0 )
 499   {
 500     offscreen = mImpl->textureCache.GetFramebuffer( instruction.mOffscreenTextureId );
 501     DALI_ASSERT_DEBUG( NULL != offscreen );
 502
 503     if( NULL != offscreen &&
 504         offscreen->Prepare() )
 505     {
 506       // Check whether a viewport is specified, otherwise the full surface size is used
 507       if ( instruction.mIsViewportSet )
 508       {
 509         // For glViewport the lower-left corner is (0,0)
 510         const int y = ( offscreen->GetHeight() - instruction.mViewport.height ) - instruction.mViewport.y;
 511         viewportRect.Set( instruction.mViewport.x,  y, instruction.mViewport.width, instruction.mViewport.height );
 512       }
 513       else
 514       {
 515         viewportRect.Set( 0, 0, offscreen->GetWidth(), offscreen->GetHeight() );
 516       }
 517     }
 518     else
 519     {
 520       // Offscreen is NULL or could not be prepared.
 521       return;
 522     }
 523   }
 524   else // !(instruction.mOffscreenTexture)
 525   {
 526     // switch rendering to adaptor provided (default) buffer
 527     mImpl->context.BindFramebuffer( GL_FRAMEBUFFER, 0 );
 528
 529     // Check whether a viewport is specified, otherwise the full surface size is used
 530     if ( instruction.mIsViewportSet )
 531     {
 532       // For glViewport the lower-left corner is (0,0)
 533       const int y = ( mImpl->defaultSurfaceRect.height - instruction.mViewport.height ) - instruction.mViewport.y;
 534       viewportRect.Set( instruction.mViewport.x,  y, instruction.mViewport.width, instruction.mViewport.height );
 535     }
 536     else
 537     {
 538       viewportRect = mImpl->defaultSurfaceRect;
 539     }
 540   }
 541
 542   mImpl->context.Viewport(viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height);
 543
 544   if ( instruction.mIsClearColorSet )
 545   {
 546     mImpl->context.ClearColor( clearColor.r,
 547                                clearColor.g,
 548                                clearColor.b,
 549                                clearColor.a );
 550
 551     // Clear the viewport area only
 552     mImpl->context.SetScissorTest( true );
 553     mImpl->context.Scissor( viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height );
 554     mImpl->context.ColorMask( true );
 555     mImpl->context.Clear( GL_COLOR_BUFFER_BIT , Context::CHECK_CACHED_VALUES );
 556     mImpl->context.SetScissorTest( false );
 557   }
 558
 559   Render::ProcessRenderInstruction( instruction,
 560                                     mImpl->context,
 561                                     mImpl->textureCache,
 562                                     defaultShader,
 563                                     mImpl->renderBufferIndex,
 564                                     elapsedTime );
 565
 566   if(instruction.mOffscreenTextureId != 0)
 567   {
 568     GLenum attachments[] = { GL_DEPTH_ATTACHMENT, GL_STENCIL_ATTACHMENT };
 569     mImpl->context.InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
 570   }
 571
 572   if( instruction.mRenderTracker && offscreen != NULL )
 573   {
 574     instruction.mRenderTracker->CreateSyncObject();
 575     instruction.mRenderTracker = NULL; // Only create once.
 576   }
 577 }
 578
 579 } // namespace SceneGraph
 580
 581 } // namespace Internal
 582
 583 } // namespace Dali