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/internal/common/owner-pointer.h>
  23 #include <dali/internal/render/queue/render-queue.h>
  24 #include <dali/internal/render/common/render-algorithms.h>
  25 #include <dali/internal/render/common/render-debug.h>
  26 #include <dali/internal/render/common/render-tracker.h>
  27 #include <dali/internal/render/common/render-instruction-container.h>
  28 #include <dali/internal/render/common/render-instruction.h>
  29 #include <dali/internal/render/gl-resources/context.h>
  30 #include <dali/internal/render/gl-resources/frame-buffer-texture.h>
  31 #include <dali/internal/render/gl-resources/native-frame-buffer-texture.h>
  32 #include <dali/internal/render/gl-resources/texture-cache.h>
  33 #include <dali/internal/render/renderers/render-material.h>
  34 #include <dali/internal/render/renderers/scene-graph-renderer.h>
  35 #include <dali/integration-api/debug.h>
  36 #include <dali/integration-api/core.h>
  37 #include <dali/public-api/common/dali-common.h>
  38 #include <dali/public-api/common/stage.h>
  39 #include <dali/public-api/render-tasks/render-task.h>
  40
  41 #ifdef DYNAMICS_SUPPORT
  42 #include <dali/internal/render/dynamics/scene-graph-dynamics-debug-renderer.h>
  43 #endif
  44
  45 // Uncomment the next line to enable frame snapshot logging
  46 //#define FRAME_SNAPSHOT_LOGGING
  47
  48 #ifdef FRAME_SNAPSHOT_LOGGING
  49
  50 using namespace Dali::Internal::Render;
  51
  52 namespace // unnamed namespace
  53 {
  54 unsigned int SNAPSHOT_FRAME_FREQUENCY = 1200; // dump every 20-30 seconds
  55 } // unnamed namespace
  56
  57 #define SET_SNAPSHOT_FRAME_LOG_LEVEL \
  58   DALI_LOG_FILTER_SET_LEVEL(Context::gGlLogFilter, ((GetFrameCount() % SNAPSHOT_FRAME_FREQUENCY)==5 ? Debug::General : Debug::Concise));
  59
  60 #else // FRAME_SNAPSHOT_LOGGING
  61
  62 #define SET_SNAPSHOT_FRAME_LOG_LEVEL
  63
  64 #endif // FRAME_SNAPSHOT_LOGGING
  65
  66 namespace Dali
  67 {
  68
  69 namespace Internal
  70 {
  71
  72 namespace SceneGraph
  73 {
  74
  75 typedef OwnerContainer< Renderer* >       RendererOwnerContainer;
  76 typedef RendererOwnerContainer::Iterator  RendererOwnerIter;
  77
  78 typedef OwnerContainer< RenderMaterial* >      RenderMaterialContainer;
  79 typedef RenderMaterialContainer::Iterator      RenderMaterialIter;
  80 typedef RenderMaterialContainer::ConstIterator RenderMaterialConstIter;
  81
  82 typedef OwnerContainer< RenderTracker* >       RenderTrackerContainer;
  83 typedef RenderTrackerContainer::Iterator       RenderTrackerIter;
  84 typedef RenderTrackerContainer::ConstIterator  RenderTrackerConstIter;
  85
  86 /**
  87  * Structure to contain internal data
  88  */
  89 struct RenderManager::Impl
  90 {
  91   Impl( Dali::Integration::GlAbstraction& glAbstraction,
  92         ResourcePostProcessList& resourcePostProcessQ,
  93         PostProcessResourceDispatcher& postProcessDispatcher )
  94   : context( glAbstraction ),
  95     renderQueue(),
  96     textureCache( renderQueue, postProcessDispatcher, context ),
  97     resourcePostProcessQueue( resourcePostProcessQ ),
  98     instructions(),
  99     backgroundColor( Dali::Stage::DEFAULT_BACKGROUND_COLOR ),
 100     frameCount( 0 ),
 101     renderBufferIndex( SceneGraphBuffers::INITIAL_UPDATE_BUFFER_INDEX ),
 102     defaultSurfaceRect(),
 103     rendererContainer(),
 104     materials(),
 105     renderersAdded( false )
 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
 149   // while we render the current one
 150   RenderInstructionContainer          instructions;
 151
 152   Vector4                             backgroundColor;     ///< The glClear color used at the beginning of each frame.
 153
 154   float                               frameTime;                     ///< The elapsed time since the previous frame
 155   float                               lastFrameTime;                 ///< Last frame delta.
 156
 157 #ifdef DYNAMICS_SUPPORT
 158   OwnerPointer<DynamicsDebugRenderer> dynamicsDebugRenderer;
 159 #endif
 160
 161   unsigned int                        frameCount;          ///< The current frame count
 162   BufferIndex                         renderBufferIndex;   ///< The index of the buffer to read from; this is opposite of the "update" buffer
 163
 164   Rect<int>                           defaultSurfaceRect; ///< Rectangle for the default surface we are rendering to
 165
 166   RendererOwnerContainer              rendererContainer;  ///< List of owned renderers
 167   RenderMaterialContainer             materials;          ///< List of owned render materials
 168
 169   bool                                renderersAdded;
 170
 171   RenderTrackerContainer              mRenderTrackers;     ///< List of render trackers
 172 };
 173
 174 RenderManager* RenderManager::New( Integration::GlAbstraction& glAbstraction, ResourcePostProcessList& resourcePostProcessQ )
 175 {
 176   RenderManager* manager = new RenderManager;
 177   manager->mImpl = new Impl( glAbstraction, resourcePostProcessQ, *manager );
 178   return manager;
 179 }
 180
 181 RenderManager::RenderManager()
 182 : mImpl(NULL)
 183 {
 184 }
 185
 186 RenderManager::~RenderManager()
 187 {
 188   delete mImpl;
 189 }
 190
 191 RenderQueue& RenderManager::GetRenderQueue()
 192 {
 193   return mImpl->renderQueue;
 194 }
 195
 196 TextureCache& RenderManager::GetTextureCache()
 197 {
 198   return mImpl->textureCache;
 199 }
 200
 201 Context& RenderManager::GetContext()
 202 {
 203   return mImpl->context;
 204 }
 205
 206 void RenderManager::ContextCreated()
 207 {
 208   mImpl->context.GlContextCreated();
 209
 210   // renderers, textures and gpu buffers cannot reinitialize themselves
 211   // so they rely on someone reloading the data for them
 212 }
 213
 214 void RenderManager::ContextDestroyed()
 215 {
 216   mImpl->context.GlContextDestroyed();
 217
 218   // inform texture cache
 219   mImpl->textureCache.GlContextDestroyed();
 220
 221   // inform renderers
 222   RendererOwnerContainer::Iterator end = mImpl->rendererContainer.End();
 223   RendererOwnerContainer::Iterator iter = mImpl->rendererContainer.Begin();
 224   for( ; iter != end; ++iter )
 225   {
 226     GlResourceOwner* renderer = *iter;
 227     renderer->GlContextDestroyed();
 228   }
 229 }
 230
 231 void RenderManager::DispatchPostProcessRequest(ResourcePostProcessRequest& request)
 232 {
 233   mImpl->resourcePostProcessQueue[ mImpl->renderBufferIndex ].push_back( request );
 234 }
 235
 236 RenderInstructionContainer& RenderManager::GetRenderInstructionContainer()
 237 {
 238   return mImpl->instructions;
 239 }
 240
 241 void RenderManager::SetBackgroundColor( const Vector4& color )
 242 {
 243   mImpl->backgroundColor = color;
 244 }
 245
 246 void RenderManager::SetFrameDeltaTime( float deltaTime )
 247 {
 248   mImpl->frameTime = deltaTime;
 249 }
 250
 251 #ifdef DYNAMICS_SUPPORT
 252 void RenderManager::InitializeDynamicsDebugRenderer(SceneGraph::DynamicsDebugRenderer* debugRenderer)
 253 {
 254   if( !mImpl->dynamicsDebugRenderer )
 255   {
 256     mImpl->dynamicsDebugRenderer = debugRenderer;
 257     debugRenderer->Initialize( mImpl->context );
 258   }
 259 }
 260 #endif
 261
 262 void RenderManager::SetDefaultSurfaceRect(const Rect<int>& rect)
 263 {
 264   mImpl->defaultSurfaceRect = rect;
 265 }
 266
 267 void RenderManager::AddRenderer( Renderer* renderer )
 268 {
 269   // Initialize the renderer as we are now in render thread
 270   renderer->Initialize( mImpl->context, mImpl->textureCache );
 271
 272   mImpl->rendererContainer.PushBack( renderer );
 273
 274   if( !mImpl->renderersAdded )
 275   {
 276     mImpl->renderersAdded = true;
 277   }
 278 }
 279
 280 void RenderManager::RemoveRenderer( Renderer* renderer )
 281 {
 282   DALI_ASSERT_DEBUG( NULL != renderer );
 283
 284   RendererOwnerContainer& renderers = mImpl->rendererContainer;
 285
 286   // Find the renderer
 287   for ( RendererOwnerIter iter = renderers.Begin(); iter != renderers.End(); ++iter )
 288   {
 289     if ( *iter == renderer )
 290     {
 291       renderers.Erase( iter ); // Renderer found; now destroy it
 292       break;
 293     }
 294   }
 295 }
 296
 297 void RenderManager::AddRenderMaterial( RenderMaterial* renderMaterial )
 298 {
 299   DALI_ASSERT_DEBUG( NULL != renderMaterial );
 300
 301   mImpl->materials.PushBack( renderMaterial );
 302   renderMaterial->Initialize( mImpl->textureCache );
 303 }
 304
 305 void RenderManager::RemoveRenderMaterial( RenderMaterial* renderMaterial )
 306 {
 307   DALI_ASSERT_DEBUG( NULL != renderMaterial );
 308
 309   RenderMaterialContainer& materials = mImpl->materials;
 310
 311   // Find the render material and destroy it
 312   for ( RenderMaterialIter iter = materials.Begin(); iter != materials.End(); ++iter )
 313   {
 314     RenderMaterial& current = **iter;
 315     if ( &current == renderMaterial )
 316     {
 317       materials.Erase( iter );
 318       break;
 319     }
 320   }
 321 }
 322
 323 void RenderManager::AddRenderTracker( RenderTracker* renderTracker )
 324 {
 325   mImpl->AddRenderTracker(renderTracker);
 326 }
 327
 328 void RenderManager::RemoveRenderTracker( RenderTracker* renderTracker )
 329 {
 330   mImpl->RemoveRenderTracker(renderTracker);
 331 }
 332
 333
 334 bool RenderManager::Render( Integration::RenderStatus& status )
 335 {
 336   DALI_PRINT_RENDER_START( mImpl->renderBufferIndex );
 337
 338   // Core::Render documents that GL context must be current before calling Render
 339   DALI_ASSERT_DEBUG( mImpl->context.IsGlContextCreated() );
 340
 341   status.SetHasRendered( false );
 342
 343   // Increment the frame count at the beginning of each frame
 344   ++(mImpl->frameCount);
 345
 346   PERF_MONITOR_START(PerformanceMonitor::DRAW_NODES);
 347
 348   SET_SNAPSHOT_FRAME_LOG_LEVEL;
 349
 350   // Process messages queued during previous update
 351   mImpl->renderQueue.ProcessMessages( mImpl->renderBufferIndex );
 352
 353   //No need to make any gl calls if we don't have any renderers to render during startup.
 354   if(mImpl->renderersAdded)
 355   {
 356     // switch rendering to adaptor provided (default) buffer
 357     mImpl->context.BindFramebuffer( GL_FRAMEBUFFER, 0 );
 358
 359     mImpl->context.Viewport( mImpl->defaultSurfaceRect.x,
 360                              mImpl->defaultSurfaceRect.y,
 361                              mImpl->defaultSurfaceRect.width,
 362                              mImpl->defaultSurfaceRect.height );
 363
 364     mImpl->context.ClearColor( mImpl->backgroundColor.r,
 365                                mImpl->backgroundColor.g,
 366                                mImpl->backgroundColor.b,
 367                                mImpl->backgroundColor.a );
 368
 369     mImpl->context.ClearStencil( 0 );
 370
 371     // Clear the entire color, depth and stencil buffers for the default framebuffer.
 372     // It is important to clear all 3 buffers, for performance on deferred renderers like Mali
 373     // e.g. previously when the depth & stencil buffers were NOT cleared, it caused the DDK to exceed a "vertex count limit",
 374     // and then stall. That problem is only noticeable when rendering a large number of vertices per frame.
 375     mImpl->context.SetScissorTest( false );
 376     mImpl->context.ColorMask( true );
 377     mImpl->context.DepthMask( true );
 378     mImpl->context.StencilMask( 0xFF ); // 8 bit stencil mask, all 1's
 379     mImpl->context.Clear( GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT );
 380
 381     size_t count = mImpl->instructions.Count( mImpl->renderBufferIndex );
 382     for ( size_t i = 0; i < count; ++i )
 383     {
 384       RenderInstruction& instruction = mImpl->instructions.At( mImpl->renderBufferIndex, i );
 385
 386       DoRender( instruction, mImpl->lastFrameTime );
 387
 388       const RenderListContainer::SizeType countRenderList = instruction.RenderListCount();
 389       if ( countRenderList > 0 )
 390       {
 391         status.SetHasRendered( true );
 392       }
 393     }
 394
 395 #ifdef DYNAMICS_SUPPORT
 396     if( mImpl->dynamicsDebugRenderer )
 397     {
 398       mImpl->dynamicsDebugRenderer->Render();
 399     }
 400 #endif
 401
 402     GLenum attachments[] = { GL_DEPTH, GL_STENCIL };
 403     mImpl->context.InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
 404
 405     mImpl->UpdateTrackers();
 406   }
 407
 408   PERF_MONITOR_END(PerformanceMonitor::DRAW_NODES);
 409
 410   // Update the frame time
 411   mImpl->lastFrameTime = mImpl->frameTime;
 412
 413   // check if anything has been posted to the update thread
 414   bool updateRequired = !mImpl->resourcePostProcessQueue[ mImpl->renderBufferIndex ].empty();
 415
 416   /**
 417    * The rendering has finished; swap to the next buffer.
 418    * Ideally the update has just finished using this buffer; otherwise the render thread
 419    * should block until the update has finished.
 420    */
 421   mImpl->renderBufferIndex = (0 != mImpl->renderBufferIndex) ? 0 : 1;
 422
 423   DALI_PRINT_RENDER_END();
 424
 425   return updateRequired;
 426 }
 427
 428 void RenderManager::DoRender( RenderInstruction& instruction, float elapsedTime )
 429 {
 430   Rect<int> viewportRect;
 431   Vector4   clearColor;
 432
 433   if ( instruction.mIsClearColorSet )
 434   {
 435     clearColor = instruction.mClearColor;
 436   }
 437   else
 438   {
 439     clearColor = Dali::RenderTask::DEFAULT_CLEAR_COLOR;
 440   }
 441
 442   FrameBufferTexture* offscreen = NULL;
 443
 444   if ( instruction.mOffscreenTextureId != 0 )
 445   {
 446     offscreen = mImpl->textureCache.GetFramebuffer( instruction.mOffscreenTextureId );
 447     DALI_ASSERT_DEBUG( NULL != offscreen );
 448
 449     if( NULL != offscreen &&
 450         offscreen->Prepare() )
 451     {
 452       // Check whether a viewport is specified, otherwise the full surface size is used
 453       if ( instruction.mIsViewportSet )
 454       {
 455         // For glViewport the lower-left corner is (0,0)
 456         const int y = ( offscreen->GetHeight() - instruction.mViewport.height ) - instruction.mViewport.y;
 457         viewportRect.Set( instruction.mViewport.x,  y, instruction.mViewport.width, instruction.mViewport.height );
 458       }
 459       else
 460       {
 461         viewportRect.Set( 0, 0, offscreen->GetWidth(), offscreen->GetHeight() );
 462       }
 463     }
 464     else
 465     {
 466       // Offscreen is NULL or could not be prepared.
 467       return;
 468     }
 469   }
 470   else // !(instruction.mOffscreenTexture)
 471   {
 472     // switch rendering to adaptor provided (default) buffer
 473     mImpl->context.BindFramebuffer( GL_FRAMEBUFFER, 0 );
 474
 475     // Check whether a viewport is specified, otherwise the full surface size is used
 476     if ( instruction.mIsViewportSet )
 477     {
 478       // For glViewport the lower-left corner is (0,0)
 479       const int y = ( mImpl->defaultSurfaceRect.height - instruction.mViewport.height ) - instruction.mViewport.y;
 480       viewportRect.Set( instruction.mViewport.x,  y, instruction.mViewport.width, instruction.mViewport.height );
 481     }
 482     else
 483     {
 484       viewportRect = mImpl->defaultSurfaceRect;
 485     }
 486   }
 487
 488   mImpl->context.Viewport(viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height);
 489
 490   if ( instruction.mIsClearColorSet )
 491   {
 492     mImpl->context.ClearColor( clearColor.r,
 493                                clearColor.g,
 494                                clearColor.b,
 495                                clearColor.a );
 496
 497     // Clear the viewport area only
 498     mImpl->context.SetScissorTest( true );
 499     mImpl->context.Scissor( viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height );
 500     mImpl->context.ColorMask( true );
 501     mImpl->context.Clear( GL_COLOR_BUFFER_BIT );
 502     mImpl->context.SetScissorTest( false );
 503   }
 504
 505   Render::ProcessRenderInstruction( instruction,
 506                                     mImpl->context,
 507                                     mImpl->renderBufferIndex,
 508                                     elapsedTime );
 509
 510   if(instruction.mOffscreenTextureId != 0)
 511   {
 512     GLenum attachments[] = { GL_DEPTH_ATTACHMENT, GL_STENCIL_ATTACHMENT };
 513     mImpl->context.InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
 514   }
 515
 516   if( instruction.mRenderTracker && offscreen != NULL )
 517   {
 518     instruction.mRenderTracker->CreateSyncObject();
 519     instruction.mRenderTracker = NULL; // Only create once.
 520   }
 521 }
 522
 523 } // namespace SceneGraph
 524
 525 } // namespace Internal
 526
 527 } // namespace Dali