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