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