Tizen 2.4.0 rev3 SDK Public Release
[framework/graphics/dali.git] / 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/scene-graph-image-renderer.h>
39 #include <dali/internal/render/renderers/scene-graph-renderer.h>
40 #include <dali/internal/render/renderers/render-geometry.h>
41 #include <dali/internal/render/shaders/program-controller.h>
42
43 // Uncomment the next line to enable frame snapshot logging
44 //#define FRAME_SNAPSHOT_LOGGING
45
46 #ifdef FRAME_SNAPSHOT_LOGGING
47
48 using namespace Dali::Internal::Render;
49
50 namespace // unnamed namespace
51 {
52 unsigned int SNAPSHOT_FRAME_FREQUENCY = 1200; // dump every 20-30 seconds
53 } // unnamed namespace
54
55 #define SET_SNAPSHOT_FRAME_LOG_LEVEL \
56   DALI_LOG_FILTER_SET_LEVEL(Context::gGlLogFilter, ((GetFrameCount() % SNAPSHOT_FRAME_FREQUENCY)==5 ? Debug::General : Debug::Concise));
57
58 #else // FRAME_SNAPSHOT_LOGGING
59
60 #define SET_SNAPSHOT_FRAME_LOG_LEVEL
61
62 #endif // FRAME_SNAPSHOT_LOGGING
63
64 namespace Dali
65 {
66
67 namespace Internal
68 {
69
70 namespace SceneGraph
71 {
72
73 typedef OwnerContainer< Renderer* >            RendererOwnerContainer;
74 typedef RendererOwnerContainer::Iterator       RendererOwnerIter;
75
76 typedef OwnerContainer< RenderGeometry* >      RenderGeometryOwnerContainer;
77 typedef RenderGeometryOwnerContainer::Iterator RenderGeometryOwnerIter;
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     renderersAdded( false ),
104     firstRenderCompleted( false ),
105     defaultShader( NULL ),
106     programController( glAbstraction )
107   {
108   }
109
110   ~Impl()
111   {
112   }
113
114   void AddRenderTracker( RenderTracker* renderTracker )
115   {
116     DALI_ASSERT_DEBUG( renderTracker != NULL );
117     mRenderTrackers.PushBack( renderTracker );
118   }
119
120   void RemoveRenderTracker( RenderTracker* renderTracker )
121   {
122     DALI_ASSERT_DEBUG( renderTracker != NULL );
123     for(RenderTrackerIter iter = mRenderTrackers.Begin(), end = mRenderTrackers.End(); iter != end; ++iter)
124     {
125       if( *iter == renderTracker )
126       {
127         mRenderTrackers.Erase( iter );
128         break;
129       }
130     }
131   }
132
133   void UpdateTrackers()
134   {
135     for(RenderTrackerIter iter = mRenderTrackers.Begin(), end = mRenderTrackers.End(); iter != end; ++iter)
136     {
137       (*iter)->PollSyncObject();
138     }
139   }
140
141   // the order is important for destruction,
142   // programs are owned by context at the moment.
143   Context                       context;                  ///< holds the GL state
144   RenderQueue                   renderQueue;              ///< A message queue for receiving messages from the update-thread.
145   TextureCache                  textureCache;             ///< Cache for all GL textures
146   ResourcePostProcessList&      resourcePostProcessQueue; ///< A queue for requesting resource post processing in update thread
147
148   // Render instructions describe what should be rendered during RenderManager::Render()
149   // Owned by RenderManager. Update manager updates instructions for the next frame 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   volatile 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   RenderGeometryOwnerContainer  renderGeometryContainer;  ///< List of owned RenderGeometries
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   ProgramController             programController;        ///< Owner of the GL programs
172 };
173
174 RenderManager* RenderManager::New( Integration::GlAbstraction& glAbstraction, ResourcePostProcessList& resourcePostProcessQ )
175 {
176   RenderManager* manager = new RenderManager;
177   manager->mImpl = new Impl( glAbstraction, resourcePostProcessQ, *manager );
178   return manager;
179 }
180
181 RenderManager::RenderManager()
182 : mImpl(NULL)
183 {
184 }
185
186 RenderManager::~RenderManager()
187 {
188   delete mImpl;
189 }
190
191 RenderQueue& RenderManager::GetRenderQueue()
192 {
193   return mImpl->renderQueue;
194 }
195
196 TextureCache& RenderManager::GetTextureCache()
197 {
198   return mImpl->textureCache;
199 }
200
201 void RenderManager::ContextCreated()
202 {
203   mImpl->context.GlContextCreated();
204   mImpl->programController.GlContextCreated();
205
206   // renderers, textures and gpu buffers cannot reinitialize themselves
207   // so they rely on someone reloading the data for them
208 }
209
210 void RenderManager::ContextDestroyed()
211 {
212   // @todo Set an atomic value to prevent render manager rendering again until
213   // ContextCreated has been called.
214
215   mImpl->context.GlContextDestroyed();
216   mImpl->programController.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 void RenderManager::SetShaderSaver( ShaderSaver& upstream )
237 {
238   mImpl->programController.SetShaderSaver( upstream );
239 }
240
241 RenderInstructionContainer& RenderManager::GetRenderInstructionContainer()
242 {
243   return mImpl->instructions;
244 }
245
246 void RenderManager::SetBackgroundColor( const Vector4& color )
247 {
248   mImpl->backgroundColor = color;
249 }
250
251 void RenderManager::SetFrameDeltaTime( float deltaTime )
252 {
253   Dali::Mutex::ScopedLock lock( mMutex );
254   mImpl->frameTime = deltaTime;
255 }
256
257 void RenderManager::SetDefaultSurfaceRect(const Rect<int>& rect)
258 {
259   mImpl->defaultSurfaceRect = rect;
260 }
261
262 void RenderManager::AddRenderer( Renderer* renderer )
263 {
264   // Initialize the renderer as we are now in render thread
265   renderer->Initialize( mImpl->context, mImpl->textureCache );
266
267   mImpl->rendererContainer.PushBack( renderer );
268
269   if( !mImpl->renderersAdded )
270   {
271     mImpl->renderersAdded = true;
272   }
273 }
274
275 void RenderManager::RemoveRenderer( Renderer* renderer )
276 {
277   DALI_ASSERT_DEBUG( NULL != renderer );
278
279   RendererOwnerContainer& renderers = mImpl->rendererContainer;
280
281   // Find the renderer
282   for ( RendererOwnerIter iter = renderers.Begin(); iter != renderers.End(); ++iter )
283   {
284     if ( *iter == renderer )
285     {
286       renderers.Erase( iter ); // Renderer found; now destroy it
287       break;
288     }
289   }
290 }
291
292 void RenderManager::AddImageRenderer( ImageRenderer* renderer, NodeDataProvider* dataProvider )
293 {
294   // Initialize the renderer as we are now in render thread
295   renderer->Initialize( mImpl->context, mImpl->textureCache );
296   renderer->SetDataProvider( dataProvider );
297
298   if( !mImpl->renderersAdded )
299   {
300     mImpl->renderersAdded = true;
301   }
302
303   // Note - ImageRenderers are not owned by RenderManager
304 }
305
306 void RenderManager::RemoveImageRenderer( ImageRenderer* renderer )
307 {
308   DALI_ASSERT_DEBUG( NULL != renderer );
309
310   // GL cleanup
311   renderer->OnRemove();
312
313   // Note - ImageRenderers are not owned by RenderManager
314 }
315
316 void RenderManager::AddGeometry( RenderGeometry* renderGeometry )
317 {
318   mImpl->renderGeometryContainer.PushBack( renderGeometry );
319 }
320
321 void RenderManager::RemoveGeometry( RenderGeometry* renderGeometry )
322 {
323   DALI_ASSERT_DEBUG( NULL != renderGeometry );
324
325   RenderGeometryOwnerContainer& geometries = mImpl->renderGeometryContainer;
326
327   // Find the renderer
328   for ( RenderGeometryOwnerIter iter = geometries.Begin(); iter != geometries.End(); ++iter )
329   {
330     if ( *iter == renderGeometry )
331     {
332       geometries.Erase( iter ); // Geometry found; now destroy it
333       break;
334     }
335   }
336 }
337
338 void RenderManager::AddPropertyBuffer( RenderGeometry* renderGeometry, PropertyBufferDataProvider* propertyBuffer, const GpuBuffer::Target& target, const GpuBuffer::Usage& usage )
339 {
340   DALI_ASSERT_DEBUG( NULL != renderGeometry );
341
342   RenderGeometryOwnerContainer& geometries = mImpl->renderGeometryContainer;
343
344   // Find the renderer
345   for ( RenderGeometryOwnerIter iter = geometries.Begin(); iter != geometries.End(); ++iter )
346   {
347     if ( *iter == renderGeometry )
348     {
349       (*iter)->AddPropertyBuffer( propertyBuffer, target, usage );
350       break;
351     }
352   }
353 }
354
355 void RenderManager::RemovePropertyBuffer( RenderGeometry* renderGeometry, PropertyBufferDataProvider* propertyBuffer )
356 {
357   DALI_ASSERT_DEBUG( NULL != renderGeometry );
358
359   RenderGeometryOwnerContainer& geometries = mImpl->renderGeometryContainer;
360
361   // Find the renderer
362   for ( RenderGeometryOwnerIter iter = geometries.Begin(); iter != geometries.End(); ++iter )
363   {
364     if ( *iter == renderGeometry )
365     {
366       (*iter)->RemovePropertyBuffer( propertyBuffer );
367       break;
368     }
369   }
370 }
371
372
373 void RenderManager::AddRenderTracker( RenderTracker* renderTracker )
374 {
375   mImpl->AddRenderTracker(renderTracker);
376 }
377
378 void RenderManager::RemoveRenderTracker( RenderTracker* renderTracker )
379 {
380   mImpl->RemoveRenderTracker(renderTracker);
381 }
382
383 void RenderManager::SetDefaultShader( Shader* shader )
384 {
385   mImpl->defaultShader = shader;
386 }
387
388 ProgramCache* RenderManager::GetProgramCache()
389 {
390   return &(mImpl->programController);
391 }
392
393 bool RenderManager::Render( Integration::RenderStatus& status )
394 {
395   DALI_PRINT_RENDER_START( mImpl->renderBufferIndex );
396
397   // Core::Render documents that GL context must be current before calling Render
398   DALI_ASSERT_DEBUG( mImpl->context.IsGlContextCreated() );
399
400   status.SetHasRendered( false );
401
402   // Increment the frame count at the beginning of each frame
403   ++(mImpl->frameCount);
404   mImpl->context.SetFrameCount(mImpl->frameCount);
405   mImpl->context.ClearRendererCount();
406   mImpl->context.ClearCulledCount();
407
408   PERF_MONITOR_START(PerformanceMonitor::DRAW_NODES);
409
410   SET_SNAPSHOT_FRAME_LOG_LEVEL;
411
412   // Process messages queued during previous update
413   mImpl->renderQueue.ProcessMessages( mImpl->renderBufferIndex );
414
415   // No need to make any gl calls if we've done 1st glClear & don't have any renderers to render during startup.
416   if( !mImpl->firstRenderCompleted || mImpl->renderersAdded )
417   {
418     // switch rendering to adaptor provided (default) buffer
419     mImpl->context.BindFramebuffer( GL_FRAMEBUFFER, 0 );
420
421     mImpl->context.Viewport( mImpl->defaultSurfaceRect.x,
422                              mImpl->defaultSurfaceRect.y,
423                              mImpl->defaultSurfaceRect.width,
424                              mImpl->defaultSurfaceRect.height );
425
426     mImpl->context.ClearColor( mImpl->backgroundColor.r,
427                                mImpl->backgroundColor.g,
428                                mImpl->backgroundColor.b,
429                                mImpl->backgroundColor.a );
430
431     mImpl->context.ClearStencil( 0 );
432
433     // Clear the entire color, depth and stencil buffers for the default framebuffer.
434     // It is important to clear all 3 buffers, for performance on deferred renderers like Mali
435     // e.g. previously when the depth & stencil buffers were NOT cleared, it caused the DDK to exceed a "vertex count limit",
436     // and then stall. That problem is only noticeable when rendering a large number of vertices per frame.
437     mImpl->context.SetScissorTest( false );
438     mImpl->context.ColorMask( true );
439     mImpl->context.DepthMask( true );
440     mImpl->context.StencilMask( 0xFF ); // 8 bit stencil mask, all 1's
441     mImpl->context.Clear( GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT,  Context::FORCE_CLEAR );
442
443     // reset the program matrices for all programs once per frame
444     // this ensures we will set view and projection matrix once per program per camera
445     // @todo move programs out of context onto a program controller and let that handle this
446     mImpl->programController.ResetProgramMatrices();
447
448     // if we don't have default shader, no point doing the render calls
449     if( mImpl->defaultShader )
450     {
451       size_t count = mImpl->instructions.Count( mImpl->renderBufferIndex );
452       for ( size_t i = 0; i < count; ++i )
453       {
454         RenderInstruction& instruction = mImpl->instructions.At( mImpl->renderBufferIndex, i );
455
456         DoRender( instruction, *mImpl->defaultShader, mImpl->lastFrameTime );
457
458         const RenderListContainer::SizeType countRenderList = instruction.RenderListCount();
459         if ( countRenderList > 0 )
460         {
461           status.SetHasRendered( true );
462         }
463       }
464       GLenum attachments[] = { GL_DEPTH, GL_STENCIL };
465       mImpl->context.InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
466
467       mImpl->UpdateTrackers();
468
469       mImpl->firstRenderCompleted = true;
470     }
471   }
472
473   PERF_MONITOR_END(PerformanceMonitor::DRAW_NODES);
474
475   SetLastFrameTime();
476
477   // check if anything has been posted to the update thread
478   bool updateRequired = !mImpl->resourcePostProcessQueue[ mImpl->renderBufferIndex ].empty();
479
480   //Notify RenderGeometries that rendering has finished
481   for ( RenderGeometryOwnerIter iter = mImpl->renderGeometryContainer.Begin(); iter != mImpl->renderGeometryContainer.End(); ++iter )
482   {
483     (*iter)->OnRenderFinished();
484   }
485
486   /**
487    * The rendering has finished; swap to the next buffer.
488    * Ideally the update has just finished using this buffer; otherwise the render thread
489    * should block until the update has finished.
490    */
491   mImpl->renderBufferIndex = (0 != mImpl->renderBufferIndex) ? 0 : 1;
492
493   DALI_PRINT_RENDER_END();
494
495   DALI_PRINT_RENDERER_COUNT(mImpl->frameCount, mImpl->context.GetRendererCount());
496   DALI_PRINT_CULL_COUNT(mImpl->frameCount, mImpl->context.GetCulledCount());
497
498   return updateRequired;
499 }
500
501 void RenderManager::SetLastFrameTime()
502 {
503   Dali::Mutex::ScopedLock lock(mMutex);
504   mImpl->lastFrameTime = mImpl->frameTime;
505 }
506
507 void RenderManager::DoRender( RenderInstruction& instruction, Shader& defaultShader, float elapsedTime )
508 {
509   Rect<int> viewportRect;
510   Vector4   clearColor;
511
512   if ( instruction.mIsClearColorSet )
513   {
514     clearColor = instruction.mClearColor;
515   }
516   else
517   {
518     clearColor = Dali::RenderTask::DEFAULT_CLEAR_COLOR;
519   }
520
521   FrameBufferTexture* offscreen = NULL;
522
523   if ( instruction.mOffscreenTextureId != 0 )
524   {
525     offscreen = mImpl->textureCache.GetFramebuffer( instruction.mOffscreenTextureId );
526     DALI_ASSERT_DEBUG( NULL != offscreen );
527
528     if( NULL != offscreen &&
529         offscreen->Prepare() )
530     {
531       // Check whether a viewport is specified, otherwise the full surface size is used
532       if ( instruction.mIsViewportSet )
533       {
534         // For glViewport the lower-left corner is (0,0)
535         const int y = ( offscreen->GetHeight() - instruction.mViewport.height ) - instruction.mViewport.y;
536         viewportRect.Set( instruction.mViewport.x,  y, instruction.mViewport.width, instruction.mViewport.height );
537       }
538       else
539       {
540         viewportRect.Set( 0, 0, offscreen->GetWidth(), offscreen->GetHeight() );
541       }
542     }
543     else
544     {
545       // Offscreen is NULL or could not be prepared.
546       return;
547     }
548   }
549   else // !(instruction.mOffscreenTexture)
550   {
551     // switch rendering to adaptor provided (default) buffer
552     mImpl->context.BindFramebuffer( GL_FRAMEBUFFER, 0 );
553
554     // Check whether a viewport is specified, otherwise the full surface size is used
555     if ( instruction.mIsViewportSet )
556     {
557       // For glViewport the lower-left corner is (0,0)
558       const int y = ( mImpl->defaultSurfaceRect.height - instruction.mViewport.height ) - instruction.mViewport.y;
559       viewportRect.Set( instruction.mViewport.x,  y, instruction.mViewport.width, instruction.mViewport.height );
560     }
561     else
562     {
563       viewportRect = mImpl->defaultSurfaceRect;
564     }
565   }
566
567   mImpl->context.Viewport(viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height);
568
569   if ( instruction.mIsClearColorSet )
570   {
571     mImpl->context.ClearColor( clearColor.r,
572                                clearColor.g,
573                                clearColor.b,
574                                clearColor.a );
575
576     // Clear the viewport area only
577     mImpl->context.SetScissorTest( true );
578     mImpl->context.Scissor( viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height );
579     mImpl->context.ColorMask( true );
580     mImpl->context.Clear( GL_COLOR_BUFFER_BIT , Context::CHECK_CACHED_VALUES );
581     mImpl->context.SetScissorTest( false );
582   }
583
584   Render::ProcessRenderInstruction( instruction,
585                                     mImpl->context,
586                                     mImpl->textureCache,
587                                     defaultShader,
588                                     mImpl->renderBufferIndex,
589                                     elapsedTime );
590
591   if(instruction.mOffscreenTextureId != 0)
592   {
593     GLenum attachments[] = { GL_DEPTH_ATTACHMENT, GL_STENCIL_ATTACHMENT };
594     mImpl->context.InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
595   }
596
597   if( instruction.mRenderTracker && offscreen != NULL )
598   {
599     instruction.mRenderTracker->CreateSyncObject();
600     instruction.mRenderTracker = NULL; // Only create once.
601   }
602 }
603
604 void RenderManager::SetPixmapYInverted( bool yInverted )
605 {
606   mImpl->context.SetPixmapYInverted( yInverted );
607 }
608
609 } // namespace SceneGraph
610
611 } // namespace Internal
612
613 } // namespace Dali