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