Remove Geometry scene object
[platform/core/uifw/dali-core.git] / dali / internal / render / common / render-manager.cpp
1 /*
2  * Copyright (c) 2015 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/actors/sampling.h>
23 #include <dali/public-api/common/dali-common.h>
24 #include <dali/public-api/common/stage.h>
25 #include <dali/public-api/render-tasks/render-task.h>
26 #include <dali/integration-api/debug.h>
27 #include <dali/integration-api/core.h>
28 #include <dali/internal/common/owner-pointer.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/data-providers/uniform-name-cache.h>
35 #include <dali/internal/render/gl-resources/context.h>
36 #include <dali/internal/render/gl-resources/frame-buffer-texture.h>
37 #include <dali/internal/render/gl-resources/texture-cache.h>
38 #include <dali/internal/render/queue/render-queue.h>
39 #include <dali/internal/render/renderers/render-geometry.h>
40 #include <dali/internal/render/renderers/render-renderer.h>
41 #include <dali/internal/render/renderers/render-sampler.h>
42 #include <dali/internal/render/shaders/program-controller.h>
43
44 namespace Dali
45 {
46
47 namespace Internal
48 {
49
50 namespace SceneGraph
51 {
52
53 typedef OwnerContainer< Render::Renderer* >    RendererOwnerContainer;
54 typedef RendererOwnerContainer::Iterator       RendererOwnerIter;
55
56 typedef OwnerContainer< Render::Geometry* >    GeometryOwnerContainer;
57 typedef GeometryOwnerContainer::Iterator       GeometryOwnerIter;
58
59 typedef OwnerContainer< Render::Sampler* >    SamplerOwnerContainer;
60 typedef SamplerOwnerContainer::Iterator       SamplerOwnerIter;
61
62 typedef OwnerContainer< Render::PropertyBuffer* > PropertyBufferOwnerContainer;
63 typedef PropertyBufferOwnerContainer::Iterator    PropertyBufferOwnerIter;
64
65 typedef OwnerContainer< Render::RenderTracker* > RenderTrackerContainer;
66 typedef RenderTrackerContainer::Iterator         RenderTrackerIter;
67 typedef RenderTrackerContainer::ConstIterator    RenderTrackerConstIter;
68
69 /**
70  * Structure to contain internal data
71  */
72 struct RenderManager::Impl
73 {
74   Impl( Integration::GlAbstraction& glAbstraction,
75         Integration::GlSyncAbstraction& glSyncAbstraction,
76         LockedResourceQueue& textureUploadedQ,
77         TextureUploadedDispatcher& postProcessDispatcher )
78   : context( glAbstraction ),
79     glSyncAbstraction( glSyncAbstraction ),
80     renderQueue(),
81     textureCache( renderQueue, postProcessDispatcher, context ),
82     textureUploadedQueue( textureUploadedQ ),
83     instructions(),
84     backgroundColor( Dali::Stage::DEFAULT_BACKGROUND_COLOR ),
85     frameCount( 0 ),
86     renderBufferIndex( SceneGraphBuffers::INITIAL_UPDATE_BUFFER_INDEX ),
87     defaultSurfaceRect(),
88     rendererContainer(),
89     samplerContainer(),
90     renderersAdded( false ),
91     firstRenderCompleted( false ),
92     defaultShader( NULL ),
93     programController( glAbstraction )
94   {
95   }
96
97   ~Impl()
98   {
99   }
100
101   void AddRenderTracker( Render::RenderTracker* renderTracker )
102   {
103     DALI_ASSERT_DEBUG( renderTracker != NULL );
104     mRenderTrackers.PushBack( renderTracker );
105   }
106
107   void RemoveRenderTracker( Render::RenderTracker* renderTracker )
108   {
109     DALI_ASSERT_DEBUG( renderTracker != NULL );
110     for(RenderTrackerIter iter = mRenderTrackers.Begin(), end = mRenderTrackers.End(); iter != end; ++iter)
111     {
112       if( *iter == renderTracker )
113       {
114         mRenderTrackers.Erase( iter );
115         break;
116       }
117     }
118   }
119
120   void UpdateTrackers()
121   {
122     for(RenderTrackerIter iter = mRenderTrackers.Begin(), end = mRenderTrackers.End(); iter != end; ++iter)
123     {
124       (*iter)->PollSyncObject();
125     }
126   }
127
128   // the order is important for destruction,
129   // programs are owned by context at the moment.
130   Context                       context;                  ///< holds the GL state
131   Integration::GlSyncAbstraction& glSyncAbstraction;      ///< GL sync abstraction
132   RenderQueue                   renderQueue;              ///< A message queue for receiving messages from the update-thread.
133   TextureCache                  textureCache;             ///< Cache for all GL textures
134   Render::UniformNameCache      uniformNameCache;         ///< Cache to provide unique indices for uniforms
135   LockedResourceQueue&          textureUploadedQueue;     ///< A queue for requesting resource post processing in update thread
136
137   // Render instructions describe what should be rendered during RenderManager::Render()
138   // Owned by RenderManager. Update manager updates instructions for the next frame while we render the current one
139   RenderInstructionContainer    instructions;
140
141   Vector4                       backgroundColor;          ///< The glClear color used at the beginning of each frame.
142
143   unsigned int                  frameCount;               ///< The current frame count
144   BufferIndex                   renderBufferIndex;        ///< The index of the buffer to read from; this is opposite of the "update" buffer
145
146   Rect<int>                     defaultSurfaceRect;       ///< Rectangle for the default surface we are rendering to
147
148   RendererOwnerContainer        rendererContainer;        ///< List of owned renderers
149   SamplerOwnerContainer         samplerContainer;         ///< List of owned samplers
150   PropertyBufferOwnerContainer  propertyBufferContainer;  ///< List of owned property buffers
151   GeometryOwnerContainer        geometryContainer;        ///< List of owned Geometries
152
153   bool                          renderersAdded;
154
155   RenderTrackerContainer        mRenderTrackers;          ///< List of render trackers
156
157   bool                          firstRenderCompleted;     ///< False until the first render is done
158   Shader*                       defaultShader;            ///< Default shader to use
159   ProgramController             programController;        ///< Owner of the GL programs
160 };
161
162 RenderManager* RenderManager::New( Integration::GlAbstraction& glAbstraction,
163                                    Integration::GlSyncAbstraction& glSyncAbstraction,
164                                    LockedResourceQueue& textureUploadedQ )
165 {
166   RenderManager* manager = new RenderManager;
167   manager->mImpl = new Impl( glAbstraction, glSyncAbstraction, textureUploadedQ, *manager );
168   return manager;
169 }
170
171 RenderManager::RenderManager()
172 : mImpl(NULL)
173 {
174 }
175
176 RenderManager::~RenderManager()
177 {
178   delete mImpl;
179 }
180
181 RenderQueue& RenderManager::GetRenderQueue()
182 {
183   return mImpl->renderQueue;
184 }
185
186 TextureCache& RenderManager::GetTextureCache()
187 {
188   return mImpl->textureCache;
189 }
190
191 void RenderManager::ContextCreated()
192 {
193   mImpl->context.GlContextCreated();
194   mImpl->programController.GlContextCreated();
195
196   // renderers, textures and gpu buffers cannot reinitialize themselves
197   // so they rely on someone reloading the data for them
198 }
199
200 void RenderManager::ContextDestroyed()
201 {
202   mImpl->context.GlContextDestroyed();
203   mImpl->programController.GlContextDestroyed();
204
205   // inform texture cache
206   mImpl->textureCache.GlContextDestroyed(); // Clears gl texture ids
207
208   // inform renderers
209   RendererOwnerContainer::Iterator end = mImpl->rendererContainer.End();
210   RendererOwnerContainer::Iterator iter = mImpl->rendererContainer.Begin();
211   for( ; iter != end; ++iter )
212   {
213     GlResourceOwner* renderer = *iter;
214     renderer->GlContextDestroyed(); // Clear up vertex buffers
215   }
216 }
217
218 void RenderManager::DispatchTextureUploaded(ResourceId request)
219 {
220   mImpl->textureUploadedQueue.PushBack( request );
221 }
222
223 void RenderManager::SetShaderSaver( ShaderSaver& upstream )
224 {
225   mImpl->programController.SetShaderSaver( upstream );
226 }
227
228 RenderInstructionContainer& RenderManager::GetRenderInstructionContainer()
229 {
230   return mImpl->instructions;
231 }
232
233 void RenderManager::SetBackgroundColor( const Vector4& color )
234 {
235   mImpl->backgroundColor = color;
236 }
237
238 void RenderManager::SetDefaultSurfaceRect(const Rect<int>& rect)
239 {
240   mImpl->defaultSurfaceRect = rect;
241 }
242
243 void RenderManager::AddRenderer( Render::Renderer* renderer )
244 {
245   // Initialize the renderer as we are now in render thread
246   renderer->Initialize( mImpl->context, mImpl->textureCache, mImpl->uniformNameCache );
247
248   mImpl->rendererContainer.PushBack( renderer );
249
250   if( !mImpl->renderersAdded )
251   {
252     mImpl->renderersAdded = true;
253   }
254 }
255
256 void RenderManager::RemoveRenderer( Render::Renderer* renderer )
257 {
258   DALI_ASSERT_DEBUG( NULL != renderer );
259
260   RendererOwnerContainer& renderers = mImpl->rendererContainer;
261
262   // Find the renderer
263   for ( RendererOwnerIter iter = renderers.Begin(); iter != renderers.End(); ++iter )
264   {
265     if ( *iter == renderer )
266     {
267       renderers.Erase( iter ); // Renderer found; now destroy it
268       break;
269     }
270   }
271 }
272
273 void RenderManager::AddSampler( Render::Sampler* sampler )
274 {
275   mImpl->samplerContainer.PushBack( sampler );
276 }
277
278 void RenderManager::RemoveSampler( Render::Sampler* sampler )
279 {
280   DALI_ASSERT_DEBUG( NULL != sampler );
281
282   SamplerOwnerContainer& samplers = mImpl->samplerContainer;
283
284   // Find the sampler
285   for ( SamplerOwnerIter iter = samplers.Begin(); iter != samplers.End(); ++iter )
286   {
287     if ( *iter == sampler )
288     {
289       samplers.Erase( iter ); // Sampler found; now destroy it
290       break;
291     }
292   }
293 }
294
295 void RenderManager::SetFilterMode( Render::Sampler* sampler, unsigned int minFilterMode, unsigned int magFilterMode )
296 {
297   sampler->SetFilterMode( (Dali::FilterMode::Type)minFilterMode, (Dali::FilterMode::Type)magFilterMode );
298 }
299
300 void RenderManager::SetWrapMode( Render::Sampler* sampler, unsigned int uWrapMode, unsigned int vWrapMode )
301 {
302   sampler->SetWrapMode( (Dali::WrapMode::Type)uWrapMode, (Dali::WrapMode::Type)vWrapMode );
303 }
304
305 void RenderManager::AddPropertyBuffer( Render::PropertyBuffer* propertyBuffer )
306 {
307   mImpl->propertyBufferContainer.PushBack( propertyBuffer );
308 }
309
310 void RenderManager::RemovePropertyBuffer( Render::PropertyBuffer* propertyBuffer )
311 {
312   DALI_ASSERT_DEBUG( NULL != propertyBuffer );
313
314   PropertyBufferOwnerContainer& propertyBuffers = mImpl->propertyBufferContainer;
315
316   // Find the sampler
317   for ( PropertyBufferOwnerIter iter = propertyBuffers.Begin(); iter != propertyBuffers.End(); ++iter )
318   {
319     if ( *iter == propertyBuffer )
320     {
321       propertyBuffers.Erase( iter ); // Property buffer found; now destroy it
322       break;
323     }
324   }
325 }
326
327 void RenderManager::SetPropertyBufferFormat(Render::PropertyBuffer* propertyBuffer, Render::PropertyBuffer::Format* format )
328 {
329   propertyBuffer->SetFormat( format );
330 }
331
332 void RenderManager::SetPropertyBufferData( Render::PropertyBuffer* propertyBuffer, Dali::Vector<char>* data, size_t size )
333 {
334   propertyBuffer->SetData( data, size );
335 }
336
337 void RenderManager::SetIndexBuffer( Render::Geometry* geometry, Dali::Vector<unsigned short>& indices )
338 {
339   geometry->SetIndexBuffer( indices );
340 }
341
342 void RenderManager::AddGeometry( Render::Geometry* geometry )
343 {
344   mImpl->geometryContainer.PushBack( geometry );
345 }
346
347 void RenderManager::RemoveGeometry( Render::Geometry* geometry )
348 {
349   DALI_ASSERT_DEBUG( NULL != geometry );
350
351   GeometryOwnerContainer& geometries = mImpl->geometryContainer;
352
353   // Find the geometry
354   for ( GeometryOwnerIter iter = geometries.Begin(); iter != geometries.End(); ++iter )
355   {
356     if ( *iter == geometry )
357     {
358       geometries.Erase( iter ); // Geometry found; now destroy it
359       break;
360     }
361   }
362 }
363
364 void RenderManager::AddVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer )
365 {
366   DALI_ASSERT_DEBUG( NULL != geometry );
367
368   GeometryOwnerContainer& geometries = mImpl->geometryContainer;
369
370   // Find the renderer
371   for ( GeometryOwnerIter iter = geometries.Begin(); iter != geometries.End(); ++iter )
372   {
373     if ( *iter == geometry )
374     {
375       (*iter)->AddPropertyBuffer( propertyBuffer );
376       break;
377     }
378   }
379 }
380
381 void RenderManager::RemoveVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer )
382 {
383   DALI_ASSERT_DEBUG( NULL != geometry );
384
385   GeometryOwnerContainer& geometries = mImpl->geometryContainer;
386
387   // Find the renderer
388   for ( GeometryOwnerIter iter = geometries.Begin(); iter != geometries.End(); ++iter )
389   {
390     if ( *iter == geometry )
391     {
392       (*iter)->RemovePropertyBuffer( propertyBuffer );
393       break;
394     }
395   }
396 }
397
398 void RenderManager::SetGeometryType( Render::Geometry* geometry, unsigned int geometryType )
399 {
400   geometry->SetGeometryType( Render::Geometry::GeometryType(geometryType) );
401 }
402
403 void RenderManager::SetGeometryRequiresDepthTest( Render::Geometry* geometry, bool requiresDepthTest )
404 {
405   geometry->SetRequiresDepthTest( requiresDepthTest );
406 }
407
408 void RenderManager::AddRenderTracker( Render::RenderTracker* renderTracker )
409 {
410   mImpl->AddRenderTracker(renderTracker);
411 }
412
413 void RenderManager::RemoveRenderTracker( Render::RenderTracker* renderTracker )
414 {
415   mImpl->RemoveRenderTracker(renderTracker);
416 }
417
418 void RenderManager::SetDefaultShader( Shader* shader )
419 {
420   mImpl->defaultShader = shader;
421 }
422
423 ProgramCache* RenderManager::GetProgramCache()
424 {
425   return &(mImpl->programController);
426 }
427
428 bool RenderManager::Render( Integration::RenderStatus& status )
429 {
430   DALI_PRINT_RENDER_START( mImpl->renderBufferIndex );
431
432   // Core::Render documents that GL context must be current before calling Render
433   DALI_ASSERT_DEBUG( mImpl->context.IsGlContextCreated() );
434
435   status.SetHasRendered( false );
436
437   // Increment the frame count at the beginning of each frame
438   ++(mImpl->frameCount);
439
440   // Process messages queued during previous update
441   mImpl->renderQueue.ProcessMessages( mImpl->renderBufferIndex );
442
443   // No need to make any gl calls if we've done 1st glClear & don't have any renderers to render during startup.
444   if( !mImpl->firstRenderCompleted || mImpl->renderersAdded )
445   {
446     // switch rendering to adaptor provided (default) buffer
447     mImpl->context.BindFramebuffer( GL_FRAMEBUFFER, 0 );
448
449     mImpl->context.Viewport( mImpl->defaultSurfaceRect.x,
450                              mImpl->defaultSurfaceRect.y,
451                              mImpl->defaultSurfaceRect.width,
452                              mImpl->defaultSurfaceRect.height );
453
454     mImpl->context.ClearColor( mImpl->backgroundColor.r,
455                                mImpl->backgroundColor.g,
456                                mImpl->backgroundColor.b,
457                                mImpl->backgroundColor.a );
458
459     mImpl->context.ClearStencil( 0 );
460
461     // Clear the entire color, depth and stencil buffers for the default framebuffer.
462     // It is important to clear all 3 buffers, for performance on deferred renderers like Mali
463     // e.g. previously when the depth & stencil buffers were NOT cleared, it caused the DDK to exceed a "vertex count limit",
464     // and then stall. That problem is only noticeable when rendering a large number of vertices per frame.
465     mImpl->context.SetScissorTest( false );
466     mImpl->context.ColorMask( true );
467     mImpl->context.DepthMask( true );
468     mImpl->context.StencilMask( 0xFF ); // 8 bit stencil mask, all 1's
469     mImpl->context.Clear( GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT,  Context::FORCE_CLEAR );
470
471     // reset the program matrices for all programs once per frame
472     // this ensures we will set view and projection matrix once per program per camera
473     mImpl->programController.ResetProgramMatrices();
474
475     // if we don't have default shader, no point doing the render calls
476     if( mImpl->defaultShader )
477     {
478       size_t count = mImpl->instructions.Count( mImpl->renderBufferIndex );
479       for ( size_t i = 0; i < count; ++i )
480       {
481         RenderInstruction& instruction = mImpl->instructions.At( mImpl->renderBufferIndex, i );
482
483         DoRender( instruction, *mImpl->defaultShader );
484
485         const RenderListContainer::SizeType countRenderList = instruction.RenderListCount();
486         if ( countRenderList > 0 )
487         {
488           status.SetHasRendered( true );
489         }
490       }
491       GLenum attachments[] = { GL_DEPTH, GL_STENCIL };
492       mImpl->context.InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
493
494       mImpl->UpdateTrackers();
495
496       mImpl->firstRenderCompleted = true;
497     }
498   }
499
500   //Notify RenderGeometries that rendering has finished
501   for ( GeometryOwnerIter iter = mImpl->geometryContainer.Begin(); iter != mImpl->geometryContainer.End(); ++iter )
502   {
503     (*iter)->OnRenderFinished();
504   }
505
506   /**
507    * The rendering has finished; swap to the next buffer.
508    * Ideally the update has just finished using this buffer; otherwise the render thread
509    * should block until the update has finished.
510    */
511   mImpl->renderBufferIndex = (0 != mImpl->renderBufferIndex) ? 0 : 1;
512
513   DALI_PRINT_RENDER_END();
514
515   // check if anything has been posted to the update thread, if IsEmpty then no update required.
516   return !mImpl->textureUploadedQueue.IsEmpty();
517 }
518
519 void RenderManager::DoRender( RenderInstruction& instruction, Shader& defaultShader )
520 {
521   Rect<int> viewportRect;
522   Vector4   clearColor;
523
524   if ( instruction.mIsClearColorSet )
525   {
526     clearColor = instruction.mClearColor;
527   }
528   else
529   {
530     clearColor = Dali::RenderTask::DEFAULT_CLEAR_COLOR;
531   }
532
533   FrameBufferTexture* offscreen = NULL;
534
535   if ( instruction.mOffscreenTextureId != 0 )
536   {
537     offscreen = mImpl->textureCache.GetFramebuffer( instruction.mOffscreenTextureId );
538     DALI_ASSERT_DEBUG( NULL != offscreen );
539
540     if( NULL != offscreen &&
541         offscreen->Prepare() )
542     {
543       // Check whether a viewport is specified, otherwise the full surface size is used
544       if ( instruction.mIsViewportSet )
545       {
546         // For glViewport the lower-left corner is (0,0)
547         const int y = ( offscreen->GetHeight() - instruction.mViewport.height ) - instruction.mViewport.y;
548         viewportRect.Set( instruction.mViewport.x,  y, instruction.mViewport.width, instruction.mViewport.height );
549       }
550       else
551       {
552         viewportRect.Set( 0, 0, offscreen->GetWidth(), offscreen->GetHeight() );
553       }
554     }
555     else
556     {
557       // Offscreen is NULL or could not be prepared.
558       return;
559     }
560   }
561   else // !(instruction.mOffscreenTexture)
562   {
563     // switch rendering to adaptor provided (default) buffer
564     mImpl->context.BindFramebuffer( GL_FRAMEBUFFER, 0 );
565
566     // Check whether a viewport is specified, otherwise the full surface size is used
567     if ( instruction.mIsViewportSet )
568     {
569       // For glViewport the lower-left corner is (0,0)
570       const int y = ( mImpl->defaultSurfaceRect.height - instruction.mViewport.height ) - instruction.mViewport.y;
571       viewportRect.Set( instruction.mViewport.x,  y, instruction.mViewport.width, instruction.mViewport.height );
572     }
573     else
574     {
575       viewportRect = mImpl->defaultSurfaceRect;
576     }
577   }
578
579   mImpl->context.Viewport(viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height);
580
581   if ( instruction.mIsClearColorSet )
582   {
583     mImpl->context.ClearColor( clearColor.r,
584                                clearColor.g,
585                                clearColor.b,
586                                clearColor.a );
587
588     // Clear the viewport area only
589     mImpl->context.SetScissorTest( true );
590     mImpl->context.Scissor( viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height );
591     mImpl->context.ColorMask( true );
592     mImpl->context.Clear( GL_COLOR_BUFFER_BIT , Context::CHECK_CACHED_VALUES );
593     mImpl->context.SetScissorTest( false );
594   }
595
596   Render::ProcessRenderInstruction( instruction,
597                                     mImpl->context,
598                                     mImpl->textureCache,
599                                     defaultShader,
600                                     mImpl->renderBufferIndex );
601
602   if(instruction.mOffscreenTextureId != 0)
603   {
604     GLenum attachments[] = { GL_DEPTH_ATTACHMENT, GL_STENCIL_ATTACHMENT };
605     mImpl->context.InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
606   }
607
608   if( instruction.mRenderTracker && offscreen != NULL )
609   {
610     // This will create a sync object every frame this render tracker
611     // is alive (though it should be now be created only for
612     // render-once render tasks)
613     instruction.mRenderTracker->CreateSyncObject( mImpl->glSyncAbstraction );
614     instruction.mRenderTracker = NULL; // Only create once.
615   }
616 }
617
618 } // namespace SceneGraph
619
620 } // namespace Internal
621
622 } // namespace Dali