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   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   mImpl->frameTime = deltaTime;
 251 }
 252
 253 void RenderManager::SetDefaultSurfaceRect(const Rect<int>& rect)
 254 {
 255   mImpl->defaultSurfaceRect = rect;
 256 }
 257
 258 void RenderManager::AddRenderer( Render::Renderer* renderer )
 259 {
 260   // Initialize the renderer as we are now in render thread
 261   renderer->Initialize( mImpl->context, mImpl->textureCache );
 262
 263   mImpl->rendererContainer.PushBack( renderer );
 264
 265   if( !mImpl->renderersAdded )
 266   {
 267     mImpl->renderersAdded = true;
 268   }
 269 }
 270
 271 void RenderManager::RemoveRenderer( Render::Renderer* renderer )
 272 {
 273   DALI_ASSERT_DEBUG( NULL != renderer );
 274
 275   RendererOwnerContainer& renderers = mImpl->rendererContainer;
 276
 277   // Find the renderer
 278   for ( RendererOwnerIter iter = renderers.Begin(); iter != renderers.End(); ++iter )
 279   {
 280     if ( *iter == renderer )
 281     {
 282       renderers.Erase( iter ); // Renderer found; now destroy it
 283       break;
 284     }
 285   }
 286 }
 287
 288 void RenderManager::AddGeometry( RenderGeometry* renderGeometry )
 289 {
 290   mImpl->renderGeometryContainer.PushBack( renderGeometry );
 291 }
 292
 293 void RenderManager::RemoveGeometry( RenderGeometry* renderGeometry )
 294 {
 295   DALI_ASSERT_DEBUG( NULL != renderGeometry );
 296
 297   RenderGeometryOwnerContainer& geometries = mImpl->renderGeometryContainer;
 298
 299   // Find the renderer
 300   for ( RenderGeometryOwnerIter iter = geometries.Begin(); iter != geometries.End(); ++iter )
 301   {
 302     if ( *iter == renderGeometry )
 303     {
 304       geometries.Erase( iter ); // Geometry found; now destroy it
 305       break;
 306     }
 307   }
 308 }
 309
 310 void RenderManager::AddPropertyBuffer( RenderGeometry* renderGeometry, PropertyBufferDataProvider* propertyBuffer, const GpuBuffer::Target& target, const GpuBuffer::Usage& usage )
 311 {
 312   DALI_ASSERT_DEBUG( NULL != renderGeometry );
 313
 314   RenderGeometryOwnerContainer& geometries = mImpl->renderGeometryContainer;
 315
 316   // Find the renderer
 317   for ( RenderGeometryOwnerIter iter = geometries.Begin(); iter != geometries.End(); ++iter )
 318   {
 319     if ( *iter == renderGeometry )
 320     {
 321       (*iter)->AddPropertyBuffer( propertyBuffer, target, usage );
 322       break;
 323     }
 324   }
 325 }
 326
 327 void RenderManager::RemovePropertyBuffer( RenderGeometry* renderGeometry, PropertyBufferDataProvider* propertyBuffer )
 328 {
 329   DALI_ASSERT_DEBUG( NULL != renderGeometry );
 330
 331   RenderGeometryOwnerContainer& geometries = mImpl->renderGeometryContainer;
 332
 333   // Find the renderer
 334   for ( RenderGeometryOwnerIter iter = geometries.Begin(); iter != geometries.End(); ++iter )
 335   {
 336     if ( *iter == renderGeometry )
 337     {
 338       (*iter)->RemovePropertyBuffer( propertyBuffer );
 339       break;
 340     }
 341   }
 342 }
 343
 344
 345 void RenderManager::AddRenderTracker( RenderTracker* renderTracker )
 346 {
 347   mImpl->AddRenderTracker(renderTracker);
 348 }
 349
 350 void RenderManager::RemoveRenderTracker( RenderTracker* renderTracker )
 351 {
 352   mImpl->RemoveRenderTracker(renderTracker);
 353 }
 354
 355 void RenderManager::SetDefaultShader( Shader* shader )
 356 {
 357   mImpl->defaultShader = shader;
 358 }
 359
 360 ProgramCache* RenderManager::GetProgramCache()
 361 {
 362   return &(mImpl->programController);
 363 }
 364
 365 bool RenderManager::Render( Integration::RenderStatus& status )
 366 {
 367   DALI_PRINT_RENDER_START( mImpl->renderBufferIndex );
 368
 369   // Core::Render documents that GL context must be current before calling Render
 370   DALI_ASSERT_DEBUG( mImpl->context.IsGlContextCreated() );
 371
 372   status.SetHasRendered( false );
 373
 374   // Increment the frame count at the beginning of each frame
 375   ++(mImpl->frameCount);
 376   mImpl->context.SetFrameCount(mImpl->frameCount);
 377   mImpl->context.ClearRendererCount();
 378   mImpl->context.ClearCulledCount();
 379
 380   PERF_MONITOR_START(PerformanceMonitor::DRAW_NODES);
 381
 382   SET_SNAPSHOT_FRAME_LOG_LEVEL;
 383
 384   // Process messages queued during previous update
 385   mImpl->renderQueue.ProcessMessages( mImpl->renderBufferIndex );
 386
 387   // No need to make any gl calls if we've done 1st glClear & don't have any renderers to render during startup.
 388   if( !mImpl->firstRenderCompleted || mImpl->renderersAdded )
 389   {
 390     // switch rendering to adaptor provided (default) buffer
 391     mImpl->context.BindFramebuffer( GL_FRAMEBUFFER, 0 );
 392
 393     mImpl->context.Viewport( mImpl->defaultSurfaceRect.x,
 394                              mImpl->defaultSurfaceRect.y,
 395                              mImpl->defaultSurfaceRect.width,
 396                              mImpl->defaultSurfaceRect.height );
 397
 398     mImpl->context.ClearColor( mImpl->backgroundColor.r,
 399                                mImpl->backgroundColor.g,
 400                                mImpl->backgroundColor.b,
 401                                mImpl->backgroundColor.a );
 402
 403     mImpl->context.ClearStencil( 0 );
 404
 405     // Clear the entire color, depth and stencil buffers for the default framebuffer.
 406     // It is important to clear all 3 buffers, for performance on deferred renderers like Mali
 407     // e.g. previously when the depth & stencil buffers were NOT cleared, it caused the DDK to exceed a "vertex count limit",
 408     // and then stall. That problem is only noticeable when rendering a large number of vertices per frame.
 409     mImpl->context.SetScissorTest( false );
 410     mImpl->context.ColorMask( true );
 411     mImpl->context.DepthMask( true );
 412     mImpl->context.StencilMask( 0xFF ); // 8 bit stencil mask, all 1's
 413     mImpl->context.Clear( GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT,  Context::FORCE_CLEAR );
 414
 415     // reset the program matrices for all programs once per frame
 416     // this ensures we will set view and projection matrix once per program per camera
 417     // @todo move programs out of context onto a program controller and let that handle this
 418     mImpl->programController.ResetProgramMatrices();
 419
 420     // if we don't have default shader, no point doing the render calls
 421     if( mImpl->defaultShader )
 422     {
 423       size_t count = mImpl->instructions.Count( mImpl->renderBufferIndex );
 424       for ( size_t i = 0; i < count; ++i )
 425       {
 426         RenderInstruction& instruction = mImpl->instructions.At( mImpl->renderBufferIndex, i );
 427
 428         DoRender( instruction, *mImpl->defaultShader, mImpl->lastFrameTime );
 429
 430         const RenderListContainer::SizeType countRenderList = instruction.RenderListCount();
 431         if ( countRenderList > 0 )
 432         {
 433           status.SetHasRendered( true );
 434         }
 435       }
 436       GLenum attachments[] = { GL_DEPTH, GL_STENCIL };
 437       mImpl->context.InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
 438
 439       mImpl->UpdateTrackers();
 440
 441       mImpl->firstRenderCompleted = true;
 442     }
 443   }
 444
 445   PERF_MONITOR_END(PerformanceMonitor::DRAW_NODES);
 446
 447   // Update the frame time
 448   mImpl->lastFrameTime = mImpl->frameTime;
 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::DoRender( RenderInstruction& instruction, Shader& defaultShader, float elapsedTime )
 475 {
 476   Rect<int> viewportRect;
 477   Vector4   clearColor;
 478
 479   if ( instruction.mIsClearColorSet )
 480   {
 481     clearColor = instruction.mClearColor;
 482   }
 483   else
 484   {
 485     clearColor = Dali::RenderTask::DEFAULT_CLEAR_COLOR;
 486   }
 487
 488   FrameBufferTexture* offscreen = NULL;
 489
 490   if ( instruction.mOffscreenTextureId != 0 )
 491   {
 492     offscreen = mImpl->textureCache.GetFramebuffer( instruction.mOffscreenTextureId );
 493     DALI_ASSERT_DEBUG( NULL != offscreen );
 494
 495     if( NULL != offscreen &&
 496         offscreen->Prepare() )
 497     {
 498       // Check whether a viewport is specified, otherwise the full surface size is used
 499       if ( instruction.mIsViewportSet )
 500       {
 501         // For glViewport the lower-left corner is (0,0)
 502         const int y = ( offscreen->GetHeight() - instruction.mViewport.height ) - instruction.mViewport.y;
 503         viewportRect.Set( instruction.mViewport.x,  y, instruction.mViewport.width, instruction.mViewport.height );
 504       }
 505       else
 506       {
 507         viewportRect.Set( 0, 0, offscreen->GetWidth(), offscreen->GetHeight() );
 508       }
 509     }
 510     else
 511     {
 512       // Offscreen is NULL or could not be prepared.
 513       return;
 514     }
 515   }
 516   else // !(instruction.mOffscreenTexture)
 517   {
 518     // switch rendering to adaptor provided (default) buffer
 519     mImpl->context.BindFramebuffer( GL_FRAMEBUFFER, 0 );
 520
 521     // Check whether a viewport is specified, otherwise the full surface size is used
 522     if ( instruction.mIsViewportSet )
 523     {
 524       // For glViewport the lower-left corner is (0,0)
 525       const int y = ( mImpl->defaultSurfaceRect.height - instruction.mViewport.height ) - instruction.mViewport.y;
 526       viewportRect.Set( instruction.mViewport.x,  y, instruction.mViewport.width, instruction.mViewport.height );
 527     }
 528     else
 529     {
 530       viewportRect = mImpl->defaultSurfaceRect;
 531     }
 532   }
 533
 534   mImpl->context.Viewport(viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height);
 535
 536   if ( instruction.mIsClearColorSet )
 537   {
 538     mImpl->context.ClearColor( clearColor.r,
 539                                clearColor.g,
 540                                clearColor.b,
 541                                clearColor.a );
 542
 543     // Clear the viewport area only
 544     mImpl->context.SetScissorTest( true );
 545     mImpl->context.Scissor( viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height );
 546     mImpl->context.ColorMask( true );
 547     mImpl->context.Clear( GL_COLOR_BUFFER_BIT , Context::CHECK_CACHED_VALUES );
 548     mImpl->context.SetScissorTest( false );
 549   }
 550
 551   Render::ProcessRenderInstruction( instruction,
 552                                     mImpl->context,
 553                                     mImpl->textureCache,
 554                                     defaultShader,
 555                                     mImpl->renderBufferIndex,
 556                                     elapsedTime );
 557
 558   if(instruction.mOffscreenTextureId != 0)
 559   {
 560     GLenum attachments[] = { GL_DEPTH_ATTACHMENT, GL_STENCIL_ATTACHMENT };
 561     mImpl->context.InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
 562   }
 563
 564   if( instruction.mRenderTracker && offscreen != NULL )
 565   {
 566     instruction.mRenderTracker->CreateSyncObject();
 567     instruction.mRenderTracker = NULL; // Only create once.
 568   }
 569 }
 570
 571 } // namespace SceneGraph
 572
 573 } // namespace Internal
 574
 575 } // namespace Dali