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 // Uncomment the next line to enable frame snapshot logging
  42 //#define FRAME_SNAPSHOT_LOGGING
  43
  44 #ifdef FRAME_SNAPSHOT_LOGGING
  45
  46 using namespace Dali::Internal::Render;
  47
  48 namespace // unnamed namespace
  49 {
  50 unsigned int SNAPSHOT_FRAME_FREQUENCY = 1200; // dump every 20-30 seconds
  51 } // unnamed namespace
  52
  53 #define SET_SNAPSHOT_FRAME_LOG_LEVEL \
  54   DALI_LOG_FILTER_SET_LEVEL(Context::gGlLogFilter, ((GetFrameCount() % SNAPSHOT_FRAME_FREQUENCY)==5 ? Debug::General : Debug::Concise));
  55
  56 #else // FRAME_SNAPSHOT_LOGGING
  57
  58 #define SET_SNAPSHOT_FRAME_LOG_LEVEL
  59
  60 #endif // FRAME_SNAPSHOT_LOGGING
  61
  62 namespace Dali
  63 {
  64
  65 namespace Internal
  66 {
  67
  68 namespace SceneGraph
  69 {
  70
  71 typedef OwnerContainer< Renderer* >       RendererOwnerContainer;
  72 typedef RendererOwnerContainer::Iterator  RendererOwnerIter;
  73
  74 typedef OwnerContainer< RenderMaterial* >      RenderMaterialContainer;
  75 typedef RenderMaterialContainer::Iterator      RenderMaterialIter;
  76 typedef RenderMaterialContainer::ConstIterator RenderMaterialConstIter;
  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     materials(),
 103     renderersAdded( false ),
 104     firstRenderCompleted( false ),
 105     defaultShader( NULL )
 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   unsigned int                        frameCount;          ///< The current frame count
 158   BufferIndex                         renderBufferIndex;   ///< The index of the buffer to read from; this is opposite of the "update" buffer
 159
 160   Rect<int>                           defaultSurfaceRect; ///< Rectangle for the default surface we are rendering to
 161
 162   RendererOwnerContainer              rendererContainer;  ///< List of owned renderers
 163   RenderMaterialContainer             materials;          ///< List of owned render materials
 164
 165   bool                                renderersAdded;
 166
 167   RenderTrackerContainer              mRenderTrackers;     ///< List of render trackers
 168
 169   bool                                firstRenderCompleted; ///< False until the first render is done
 170   Shader*                             defaultShader;        ///< Default shader to use
 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 Context& RenderManager::GetContext()
 201 {
 202   return mImpl->context;
 203 }
 204
 205 void RenderManager::ContextCreated()
 206 {
 207   mImpl->context.GlContextCreated();
 208
 209   // renderers, textures and gpu buffers cannot reinitialize themselves
 210   // so they rely on someone reloading the data for them
 211 }
 212
 213 void RenderManager::ContextDestroyed()
 214 {
 215   // @todo Set an atomic value to prevent render manager rendering again until
 216   // ContextCreated has been called.
 217
 218   mImpl->context.GlContextDestroyed();
 219
 220   // inform texture cache
 221   mImpl->textureCache.GlContextDestroyed(); // Clears gl texture ids
 222
 223   // inform renderers
 224   RendererOwnerContainer::Iterator end = mImpl->rendererContainer.End();
 225   RendererOwnerContainer::Iterator iter = mImpl->rendererContainer.Begin();
 226   for( ; iter != end; ++iter )
 227   {
 228     GlResourceOwner* renderer = *iter;
 229     renderer->GlContextDestroyed(); // Clear up vertex buffers
 230   }
 231 }
 232
 233 void RenderManager::DispatchPostProcessRequest(ResourcePostProcessRequest& request)
 234 {
 235   mImpl->resourcePostProcessQueue[ mImpl->renderBufferIndex ].push_back( request );
 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( 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( 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::AddRenderMaterial( RenderMaterial* renderMaterial )
 289 {
 290   DALI_ASSERT_DEBUG( NULL != renderMaterial );
 291
 292   mImpl->materials.PushBack( renderMaterial );
 293   renderMaterial->Initialize( mImpl->textureCache );
 294 }
 295
 296 void RenderManager::RemoveRenderMaterial( RenderMaterial* renderMaterial )
 297 {
 298   DALI_ASSERT_DEBUG( NULL != renderMaterial );
 299
 300   RenderMaterialContainer& materials = mImpl->materials;
 301
 302   // Find the render material and destroy it
 303   for ( RenderMaterialIter iter = materials.Begin(); iter != materials.End(); ++iter )
 304   {
 305     RenderMaterial& current = **iter;
 306     if ( &current == renderMaterial )
 307     {
 308       materials.Erase( iter );
 309       break;
 310     }
 311   }
 312 }
 313
 314 void RenderManager::AddRenderTracker( RenderTracker* renderTracker )
 315 {
 316   mImpl->AddRenderTracker(renderTracker);
 317 }
 318
 319 void RenderManager::RemoveRenderTracker( RenderTracker* renderTracker )
 320 {
 321   mImpl->RemoveRenderTracker(renderTracker);
 322 }
 323
 324 void RenderManager::SetDefaultShader( Shader* shader )
 325 {
 326   mImpl->defaultShader = shader;
 327 }
 328
 329 bool RenderManager::Render( Integration::RenderStatus& status )
 330 {
 331   DALI_PRINT_RENDER_START( mImpl->renderBufferIndex );
 332
 333   // Core::Render documents that GL context must be current before calling Render
 334   DALI_ASSERT_DEBUG( mImpl->context.IsGlContextCreated() );
 335
 336   status.SetHasRendered( false );
 337
 338   // Increment the frame count at the beginning of each frame
 339   ++(mImpl->frameCount);
 340   mImpl->context.SetFrameCount(mImpl->frameCount);
 341   mImpl->context.ClearRendererCount();
 342   mImpl->context.ClearCulledCount();
 343
 344   PERF_MONITOR_START(PerformanceMonitor::DRAW_NODES);
 345
 346   SET_SNAPSHOT_FRAME_LOG_LEVEL;
 347
 348   // Process messages queued during previous update
 349   mImpl->renderQueue.ProcessMessages( mImpl->renderBufferIndex );
 350
 351   // No need to make any gl calls if we've done 1st glClear & don't have any renderers to render during startup.
 352   if( !mImpl->firstRenderCompleted || mImpl->renderersAdded )
 353   {
 354     // switch rendering to adaptor provided (default) buffer
 355     mImpl->context.BindFramebuffer( GL_FRAMEBUFFER, 0 );
 356
 357     mImpl->context.Viewport( mImpl->defaultSurfaceRect.x,
 358                              mImpl->defaultSurfaceRect.y,
 359                              mImpl->defaultSurfaceRect.width,
 360                              mImpl->defaultSurfaceRect.height );
 361
 362     mImpl->context.ClearColor( mImpl->backgroundColor.r,
 363                                mImpl->backgroundColor.g,
 364                                mImpl->backgroundColor.b,
 365                                mImpl->backgroundColor.a );
 366
 367     mImpl->context.ClearStencil( 0 );
 368
 369     // Clear the entire color, depth and stencil buffers for the default framebuffer.
 370     // It is important to clear all 3 buffers, for performance on deferred renderers like Mali
 371     // e.g. previously when the depth & stencil buffers were NOT cleared, it caused the DDK to exceed a "vertex count limit",
 372     // and then stall. That problem is only noticeable when rendering a large number of vertices per frame.
 373     mImpl->context.SetScissorTest( false );
 374     mImpl->context.ColorMask( true );
 375     mImpl->context.DepthMask( true );
 376     mImpl->context.StencilMask( 0xFF ); // 8 bit stencil mask, all 1's
 377     mImpl->context.Clear( GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT );
 378
 379     // reset the program matrices for all programs once per frame
 380     // this ensures we will set view and projection matrix once per program per camera
 381     // @todo move programs out of context onto a program controller and let that handle this
 382     mImpl->context.ResetProgramMatrices();
 383
 384     // if we don't have default shader, no point doing the render calls
 385     if( mImpl->defaultShader )
 386     {
 387       size_t count = mImpl->instructions.Count( mImpl->renderBufferIndex );
 388       for ( size_t i = 0; i < count; ++i )
 389       {
 390         RenderInstruction& instruction = mImpl->instructions.At( mImpl->renderBufferIndex, i );
 391
 392         DoRender( instruction, *mImpl->defaultShader, mImpl->lastFrameTime );
 393
 394         const RenderListContainer::SizeType countRenderList = instruction.RenderListCount();
 395         if ( countRenderList > 0 )
 396         {
 397           status.SetHasRendered( true );
 398         }
 399       }
 400       GLenum attachments[] = { GL_DEPTH, GL_STENCIL };
 401       mImpl->context.InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
 402
 403       mImpl->UpdateTrackers();
 404
 405       mImpl->firstRenderCompleted = true;
 406     }
 407   }
 408
 409   PERF_MONITOR_END(PerformanceMonitor::DRAW_NODES);
 410
 411   // Update the frame time
 412   mImpl->lastFrameTime = mImpl->frameTime;
 413
 414   // check if anything has been posted to the update thread
 415   bool updateRequired = !mImpl->resourcePostProcessQueue[ mImpl->renderBufferIndex ].empty();
 416
 417   /**
 418    * The rendering has finished; swap to the next buffer.
 419    * Ideally the update has just finished using this buffer; otherwise the render thread
 420    * should block until the update has finished.
 421    */
 422   mImpl->renderBufferIndex = (0 != mImpl->renderBufferIndex) ? 0 : 1;
 423
 424   DALI_PRINT_RENDER_END();
 425
 426   DALI_PRINT_RENDERER_COUNT(mImpl->frameCount, mImpl->context.GetRendererCount());
 427   DALI_PRINT_CULL_COUNT(mImpl->frameCount, mImpl->context.GetCulledCount());
 428
 429   return updateRequired;
 430 }
 431
 432 void RenderManager::DoRender( RenderInstruction& instruction, Shader& defaultShader, float elapsedTime )
 433 {
 434   Rect<int> viewportRect;
 435   Vector4   clearColor;
 436
 437   if ( instruction.mIsClearColorSet )
 438   {
 439     clearColor = instruction.mClearColor;
 440   }
 441   else
 442   {
 443     clearColor = Dali::RenderTask::DEFAULT_CLEAR_COLOR;
 444   }
 445
 446   FrameBufferTexture* offscreen = NULL;
 447
 448   if ( instruction.mOffscreenTextureId != 0 )
 449   {
 450     offscreen = mImpl->textureCache.GetFramebuffer( instruction.mOffscreenTextureId );
 451     DALI_ASSERT_DEBUG( NULL != offscreen );
 452
 453     if( NULL != offscreen &&
 454         offscreen->Prepare() )
 455     {
 456       // Check whether a viewport is specified, otherwise the full surface size is used
 457       if ( instruction.mIsViewportSet )
 458       {
 459         // For glViewport the lower-left corner is (0,0)
 460         const int y = ( offscreen->GetHeight() - instruction.mViewport.height ) - instruction.mViewport.y;
 461         viewportRect.Set( instruction.mViewport.x,  y, instruction.mViewport.width, instruction.mViewport.height );
 462       }
 463       else
 464       {
 465         viewportRect.Set( 0, 0, offscreen->GetWidth(), offscreen->GetHeight() );
 466       }
 467     }
 468     else
 469     {
 470       // Offscreen is NULL or could not be prepared.
 471       return;
 472     }
 473   }
 474   else // !(instruction.mOffscreenTexture)
 475   {
 476     // switch rendering to adaptor provided (default) buffer
 477     mImpl->context.BindFramebuffer( GL_FRAMEBUFFER, 0 );
 478
 479     // Check whether a viewport is specified, otherwise the full surface size is used
 480     if ( instruction.mIsViewportSet )
 481     {
 482       // For glViewport the lower-left corner is (0,0)
 483       const int y = ( mImpl->defaultSurfaceRect.height - instruction.mViewport.height ) - instruction.mViewport.y;
 484       viewportRect.Set( instruction.mViewport.x,  y, instruction.mViewport.width, instruction.mViewport.height );
 485     }
 486     else
 487     {
 488       viewportRect = mImpl->defaultSurfaceRect;
 489     }
 490   }
 491
 492   mImpl->context.Viewport(viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height);
 493
 494   if ( instruction.mIsClearColorSet )
 495   {
 496     mImpl->context.ClearColor( clearColor.r,
 497                                clearColor.g,
 498                                clearColor.b,
 499                                clearColor.a );
 500
 501     // Clear the viewport area only
 502     mImpl->context.SetScissorTest( true );
 503     mImpl->context.Scissor( viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height );
 504     mImpl->context.ColorMask( true );
 505     mImpl->context.Clear( GL_COLOR_BUFFER_BIT );
 506     mImpl->context.SetScissorTest( false );
 507   }
 508
 509   Render::ProcessRenderInstruction( instruction,
 510                                     mImpl->context,
 511                                     defaultShader,
 512                                     mImpl->renderBufferIndex,
 513                                     elapsedTime );
 514
 515   if(instruction.mOffscreenTextureId != 0)
 516   {
 517     GLenum attachments[] = { GL_DEPTH_ATTACHMENT, GL_STENCIL_ATTACHMENT };
 518     mImpl->context.InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
 519   }
 520
 521   if( instruction.mRenderTracker && offscreen != NULL )
 522   {
 523     instruction.mRenderTracker->CreateSyncObject();
 524     instruction.mRenderTracker = NULL; // Only create once.
 525   }
 526 }
 527
 528 } // namespace SceneGraph
 529
 530 } // namespace Internal
 531
 532 } // namespace Dali