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