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   mImpl->context.GlContextDestroyed();
 212
 213   // inform texture cache
 214   mImpl->textureCache.GlContextDestroyed();
 215
 216   // inform renderers
 217   RendererOwnerContainer::Iterator end = mImpl->rendererContainer.End();
 218   RendererOwnerContainer::Iterator iter = mImpl->rendererContainer.Begin();
 219   for( ; iter != end; ++iter )
 220   {
 221     GlResourceOwner* renderer = *iter;
 222     renderer->GlContextDestroyed();
 223   }
 224 }
 225
 226 void RenderManager::DispatchPostProcessRequest(ResourcePostProcessRequest& request)
 227 {
 228   mImpl->resourcePostProcessQueue[ mImpl->renderBufferIndex ].push_back( request );
 229 }
 230
 231 RenderInstructionContainer& RenderManager::GetRenderInstructionContainer()
 232 {
 233   return mImpl->instructions;
 234 }
 235
 236 void RenderManager::SetBackgroundColor( const Vector4& color )
 237 {
 238   mImpl->backgroundColor = color;
 239 }
 240
 241 void RenderManager::SetFrameDeltaTime( float deltaTime )
 242 {
 243   mImpl->frameTime = deltaTime;
 244 }
 245
 246 void RenderManager::SetDefaultSurfaceRect(const Rect<int>& rect)
 247 {
 248   mImpl->defaultSurfaceRect = rect;
 249 }
 250
 251 void RenderManager::AddRenderer( Renderer* renderer )
 252 {
 253   // Initialize the renderer as we are now in render thread
 254   renderer->Initialize( mImpl->context, mImpl->textureCache );
 255
 256   mImpl->rendererContainer.PushBack( renderer );
 257
 258   if( !mImpl->renderersAdded )
 259   {
 260     mImpl->renderersAdded = true;
 261   }
 262 }
 263
 264 void RenderManager::RemoveRenderer( Renderer* renderer )
 265 {
 266   DALI_ASSERT_DEBUG( NULL != renderer );
 267
 268   RendererOwnerContainer& renderers = mImpl->rendererContainer;
 269
 270   // Find the renderer
 271   for ( RendererOwnerIter iter = renderers.Begin(); iter != renderers.End(); ++iter )
 272   {
 273     if ( *iter == renderer )
 274     {
 275       renderers.Erase( iter ); // Renderer found; now destroy it
 276       break;
 277     }
 278   }
 279 }
 280
 281 void RenderManager::AddRenderMaterial( RenderMaterial* renderMaterial )
 282 {
 283   DALI_ASSERT_DEBUG( NULL != renderMaterial );
 284
 285   mImpl->materials.PushBack( renderMaterial );
 286   renderMaterial->Initialize( mImpl->textureCache );
 287 }
 288
 289 void RenderManager::RemoveRenderMaterial( RenderMaterial* renderMaterial )
 290 {
 291   DALI_ASSERT_DEBUG( NULL != renderMaterial );
 292
 293   RenderMaterialContainer& materials = mImpl->materials;
 294
 295   // Find the render material and destroy it
 296   for ( RenderMaterialIter iter = materials.Begin(); iter != materials.End(); ++iter )
 297   {
 298     RenderMaterial& current = **iter;
 299     if ( &current == renderMaterial )
 300     {
 301       materials.Erase( iter );
 302       break;
 303     }
 304   }
 305 }
 306
 307 void RenderManager::AddRenderTracker( RenderTracker* renderTracker )
 308 {
 309   mImpl->AddRenderTracker(renderTracker);
 310 }
 311
 312 void RenderManager::RemoveRenderTracker( RenderTracker* renderTracker )
 313 {
 314   mImpl->RemoveRenderTracker(renderTracker);
 315 }
 316
 317 bool RenderManager::Render( Integration::RenderStatus& status )
 318 {
 319   DALI_PRINT_RENDER_START( mImpl->renderBufferIndex );
 320
 321   // Core::Render documents that GL context must be current before calling Render
 322   DALI_ASSERT_DEBUG( mImpl->context.IsGlContextCreated() );
 323
 324   status.SetHasRendered( false );
 325
 326   // Increment the frame count at the beginning of each frame
 327   ++(mImpl->frameCount);
 328   mImpl->context.SetFrameCount(mImpl->frameCount);
 329   mImpl->context.ClearRendererCount();
 330   mImpl->context.ClearCulledCount();
 331
 332   PERF_MONITOR_START(PerformanceMonitor::DRAW_NODES);
 333
 334   SET_SNAPSHOT_FRAME_LOG_LEVEL;
 335
 336   // Process messages queued during previous update
 337   mImpl->renderQueue.ProcessMessages( mImpl->renderBufferIndex );
 338
 339   // No need to make any gl calls if we've done 1st glClear & don't have any renderers to render during startup.
 340   if( !mImpl->firstRenderCompleted || mImpl->renderersAdded )
 341   {
 342     // switch rendering to adaptor provided (default) buffer
 343     mImpl->context.BindFramebuffer( GL_FRAMEBUFFER, 0 );
 344
 345     mImpl->context.Viewport( mImpl->defaultSurfaceRect.x,
 346                              mImpl->defaultSurfaceRect.y,
 347                              mImpl->defaultSurfaceRect.width,
 348                              mImpl->defaultSurfaceRect.height );
 349
 350     mImpl->context.ClearColor( mImpl->backgroundColor.r,
 351                                mImpl->backgroundColor.g,
 352                                mImpl->backgroundColor.b,
 353                                mImpl->backgroundColor.a );
 354
 355     mImpl->context.ClearStencil( 0 );
 356
 357     // Clear the entire color, depth and stencil buffers for the default framebuffer.
 358     // It is important to clear all 3 buffers, for performance on deferred renderers like Mali
 359     // e.g. previously when the depth & stencil buffers were NOT cleared, it caused the DDK to exceed a "vertex count limit",
 360     // and then stall. That problem is only noticeable when rendering a large number of vertices per frame.
 361     mImpl->context.SetScissorTest( false );
 362     mImpl->context.ColorMask( true );
 363     mImpl->context.DepthMask( true );
 364     mImpl->context.StencilMask( 0xFF ); // 8 bit stencil mask, all 1's
 365     mImpl->context.Clear( GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT );
 366
 367     // reset the program matrices for all programs once per frame
 368     // this ensures we will set view and projection matrix once per program per camera
 369     // @todo move programs out of context onto a program controller and let that handle this
 370     mImpl->context.ResetProgramMatrices();
 371
 372     size_t count = mImpl->instructions.Count( mImpl->renderBufferIndex );
 373     for ( size_t i = 0; i < count; ++i )
 374     {
 375       RenderInstruction& instruction = mImpl->instructions.At( mImpl->renderBufferIndex, i );
 376
 377       DoRender( instruction, mImpl->lastFrameTime );
 378
 379       const RenderListContainer::SizeType countRenderList = instruction.RenderListCount();
 380       if ( countRenderList > 0 )
 381       {
 382         status.SetHasRendered( true );
 383       }
 384     }
 385
 386     GLenum attachments[] = { GL_DEPTH, GL_STENCIL };
 387     mImpl->context.InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
 388
 389     mImpl->UpdateTrackers();
 390
 391     mImpl->firstRenderCompleted = true;
 392   }
 393
 394   PERF_MONITOR_END(PerformanceMonitor::DRAW_NODES);
 395
 396   // Update the frame time
 397   mImpl->lastFrameTime = mImpl->frameTime;
 398
 399   // check if anything has been posted to the update thread
 400   bool updateRequired = !mImpl->resourcePostProcessQueue[ mImpl->renderBufferIndex ].empty();
 401
 402   /**
 403    * The rendering has finished; swap to the next buffer.
 404    * Ideally the update has just finished using this buffer; otherwise the render thread
 405    * should block until the update has finished.
 406    */
 407   mImpl->renderBufferIndex = (0 != mImpl->renderBufferIndex) ? 0 : 1;
 408
 409   DALI_PRINT_RENDER_END();
 410
 411   DALI_PRINT_RENDERER_COUNT(mImpl->frameCount, mImpl->context.GetRendererCount());
 412   DALI_PRINT_CULL_COUNT(mImpl->frameCount, mImpl->context.GetCulledCount());
 413
 414   return updateRequired;
 415 }
 416
 417 void RenderManager::DoRender( RenderInstruction& instruction, float elapsedTime )
 418 {
 419   Rect<int> viewportRect;
 420   Vector4   clearColor;
 421
 422   if ( instruction.mIsClearColorSet )
 423   {
 424     clearColor = instruction.mClearColor;
 425   }
 426   else
 427   {
 428     clearColor = Dali::RenderTask::DEFAULT_CLEAR_COLOR;
 429   }
 430
 431   FrameBufferTexture* offscreen = NULL;
 432
 433   if ( instruction.mOffscreenTextureId != 0 )
 434   {
 435     offscreen = mImpl->textureCache.GetFramebuffer( instruction.mOffscreenTextureId );
 436     DALI_ASSERT_DEBUG( NULL != offscreen );
 437
 438     if( NULL != offscreen &&
 439         offscreen->Prepare() )
 440     {
 441       // Check whether a viewport is specified, otherwise the full surface size is used
 442       if ( instruction.mIsViewportSet )
 443       {
 444         // For glViewport the lower-left corner is (0,0)
 445         const int y = ( offscreen->GetHeight() - instruction.mViewport.height ) - instruction.mViewport.y;
 446         viewportRect.Set( instruction.mViewport.x,  y, instruction.mViewport.width, instruction.mViewport.height );
 447       }
 448       else
 449       {
 450         viewportRect.Set( 0, 0, offscreen->GetWidth(), offscreen->GetHeight() );
 451       }
 452     }
 453     else
 454     {
 455       // Offscreen is NULL or could not be prepared.
 456       return;
 457     }
 458   }
 459   else // !(instruction.mOffscreenTexture)
 460   {
 461     // switch rendering to adaptor provided (default) buffer
 462     mImpl->context.BindFramebuffer( GL_FRAMEBUFFER, 0 );
 463
 464     // Check whether a viewport is specified, otherwise the full surface size is used
 465     if ( instruction.mIsViewportSet )
 466     {
 467       // For glViewport the lower-left corner is (0,0)
 468       const int y = ( mImpl->defaultSurfaceRect.height - instruction.mViewport.height ) - instruction.mViewport.y;
 469       viewportRect.Set( instruction.mViewport.x,  y, instruction.mViewport.width, instruction.mViewport.height );
 470     }
 471     else
 472     {
 473       viewportRect = mImpl->defaultSurfaceRect;
 474     }
 475   }
 476
 477   mImpl->context.Viewport(viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height);
 478
 479   if ( instruction.mIsClearColorSet )
 480   {
 481     mImpl->context.ClearColor( clearColor.r,
 482                                clearColor.g,
 483                                clearColor.b,
 484                                clearColor.a );
 485
 486     // Clear the viewport area only
 487     mImpl->context.SetScissorTest( true );
 488     mImpl->context.Scissor( viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height );
 489     mImpl->context.ColorMask( true );
 490     mImpl->context.Clear( GL_COLOR_BUFFER_BIT );
 491     mImpl->context.SetScissorTest( false );
 492   }
 493
 494   Render::ProcessRenderInstruction( instruction,
 495                                     mImpl->context,
 496                                     mImpl->renderBufferIndex,
 497                                     elapsedTime );
 498
 499   if(instruction.mOffscreenTextureId != 0)
 500   {
 501     GLenum attachments[] = { GL_DEPTH_ATTACHMENT, GL_STENCIL_ATTACHMENT };
 502     mImpl->context.InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
 503   }
 504
 505   if( instruction.mRenderTracker && offscreen != NULL )
 506   {
 507     instruction.mRenderTracker->CreateSyncObject();
 508     instruction.mRenderTracker = NULL; // Only create once.
 509   }
 510 }
 511
 512 } // namespace SceneGraph
 513
 514 } // namespace Internal
 515
 516 } // namespace Dali