038743f38300972ea29047877fbbc6074a1604ae
[platform/core/uifw/dali-core.git] / dali / internal / common / core-impl.cpp
1 /*
2  * Copyright (c) 2016 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/common/core-impl.h>
20
21 // INTERNAL INCLUDES
22 #include <dali/integration-api/system-overlay.h>
23 #include <dali/integration-api/core.h>
24 #include <dali/integration-api/debug.h>
25 #include <dali/integration-api/events/event.h>
26 #include <dali/integration-api/gl-sync-abstraction.h>
27 #include <dali/integration-api/platform-abstraction.h>
28 #include <dali/integration-api/render-controller.h>
29
30 #include <dali/internal/event/actors/actor-impl.h>
31 #include <dali/internal/event/animation/animation-playlist.h>
32 #include <dali/internal/event/common/notification-manager.h>
33 #include <dali/internal/event/common/property-notification-manager.h>
34 #include <dali/internal/event/common/stage-impl.h>
35 #include <dali/internal/event/common/thread-local-storage.h>
36 #include <dali/internal/event/common/type-registry-impl.h>
37 #include <dali/internal/event/effects/shader-factory.h>
38 #include <dali/internal/event/events/event-processor.h>
39 #include <dali/internal/event/events/gesture-event-processor.h>
40 #include <dali/internal/event/render-tasks/render-task-list-impl.h>
41 #include <dali/internal/event/size-negotiation/relayout-controller-impl.h>
42
43 #include <dali/internal/update/common/discard-queue.h>
44 #include <dali/internal/update/common/texture-cache-dispatcher.h>
45 #include <dali/internal/update/manager/update-manager.h>
46 #include <dali/internal/update/manager/render-task-processor.h>
47 #include <dali/internal/update/resources/resource-manager.h>
48
49 #include <dali/internal/render/common/performance-monitor.h>
50 #include <dali/internal/render/common/render-manager.h>
51 #include <dali/internal/render/gl-resources/texture-cache.h>
52 #include <dali/internal/render/gl-resources/context.h>
53
54 using Dali::Internal::SceneGraph::UpdateManager;
55 using Dali::Internal::SceneGraph::RenderManager;
56 using Dali::Internal::SceneGraph::DiscardQueue;
57 using Dali::Internal::SceneGraph::RenderQueue;
58 using Dali::Internal::SceneGraph::TextureCache;
59 using Dali::Internal::SceneGraph::TextureCacheDispatcher;
60
61 namespace
62 {
63 // The Update for frame N+1 may be processed whilst frame N is being rendered.
64 const unsigned int MAXIMUM_UPDATE_COUNT = 2u;
65
66 #if defined(DEBUG_ENABLED)
67 Debug::Filter* gCoreFilter = Debug::Filter::New(Debug::Concise, false, "LOG_CORE");
68 #endif
69 }
70
71 namespace Dali
72 {
73
74 namespace Internal
75 {
76
77 using Integration::RenderController;
78 using Integration::PlatformAbstraction;
79 using Integration::GlSyncAbstraction;
80 using Integration::GestureManager;
81 using Integration::GlAbstraction;
82 using Integration::Event;
83 using Integration::UpdateStatus;
84 using Integration::RenderStatus;
85
86 Core::Core( RenderController& renderController, PlatformAbstraction& platform,
87             GlAbstraction& glAbstraction, GlSyncAbstraction& glSyncAbstraction,
88             GestureManager& gestureManager, ResourcePolicy::DataRetention dataRetentionPolicy)
89 : mRenderController( renderController ),
90   mPlatform(platform),
91   mGestureEventProcessor(NULL),
92   mEventProcessor(NULL),
93   mUpdateManager(NULL),
94   mRenderManager(NULL),
95   mDiscardQueue(NULL),
96   mTextureUploadedQueue(),
97   mNotificationManager(NULL),
98   mShaderFactory(NULL),
99   mIsActive(true),
100   mProcessingEvent(false)
101 {
102   // Create the thread local storage
103   CreateThreadLocalStorage();
104
105   // This does nothing until Core is built with --enable-performance-monitor
106   PERFORMANCE_MONITOR_INIT( platform );
107
108   mNotificationManager = new NotificationManager();
109
110   mAnimationPlaylist = AnimationPlaylist::New();
111
112   mPropertyNotificationManager = PropertyNotificationManager::New();
113
114   mTextureUploadedQueue = new LockedResourceQueue;
115
116   mRenderTaskProcessor = new SceneGraph::RenderTaskProcessor();
117
118   mRenderManager = RenderManager::New( glAbstraction, glSyncAbstraction, *mTextureUploadedQueue );
119
120   RenderQueue& renderQueue = mRenderManager->GetRenderQueue();
121   TextureCache& textureCache = mRenderManager->GetTextureCache();
122
123   ResourcePolicy::Discardable discardPolicy = ResourcePolicy::OWNED_DISCARD;
124   if( dataRetentionPolicy == ResourcePolicy::DALI_RETAINS_ALL_DATA )
125   {
126     discardPolicy = ResourcePolicy::OWNED_RETAIN;
127   }
128   textureCache.SetDiscardBitmapsPolicy(discardPolicy);
129
130   mTextureCacheDispatcher = new SceneGraph::TextureCacheDispatcher( renderQueue, textureCache );
131
132   mDiscardQueue = new DiscardQueue( renderQueue );
133
134   mResourceManager = new ResourceManager(  mPlatform,
135                                           *mNotificationManager,
136                                           *mTextureCacheDispatcher,
137                                           *mTextureUploadedQueue,
138                                           *mDiscardQueue,
139                                            renderQueue );
140
141   mUpdateManager = new UpdateManager( *mNotificationManager,
142                                       *mAnimationPlaylist,
143                                       *mPropertyNotificationManager,
144                                       *mResourceManager,
145                                       *mDiscardQueue,
146                                        renderController,
147                                       *mRenderManager,
148                                        renderQueue,
149                                       *mTextureCacheDispatcher,
150                                       *mRenderTaskProcessor );
151
152   mRenderManager->SetShaderSaver( *mUpdateManager );
153
154   mStage = IntrusivePtr<Stage>( Stage::New( *mAnimationPlaylist, *mPropertyNotificationManager, *mUpdateManager, *mNotificationManager ) );
155
156   // This must be called after stage is created but before stage initialization
157   mRelayoutController = IntrusivePtr< RelayoutController >( new RelayoutController( mRenderController ) );
158
159   mStage->Initialize();
160
161   mGestureEventProcessor = new GestureEventProcessor(*mStage, gestureManager, mRenderController);
162   mEventProcessor = new EventProcessor(*mStage, *mNotificationManager, *mGestureEventProcessor);
163
164   mShaderFactory = new ShaderFactory();
165   mUpdateManager->SetShaderSaver( *mShaderFactory );
166
167   GetImplementation(Dali::TypeRegistry::Get()).CallInitFunctions();
168 }
169
170 Core::~Core()
171 {
172   /**
173    * TODO this should be done by Adaptor, Core does not know about threading
174    * First stop the resource loading thread(s)
175    */
176   mPlatform.JoinLoaderThreads();
177
178   /*
179    * The order of destructing these singletons is important!!!
180    */
181
182   // clear the thread local storage first
183   // allows core to be created / deleted many times in the same thread (how TET cases work).
184   // Do this before mStage.Reset() so Stage::IsInstalled() returns false
185   ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
186   if( tls )
187   {
188     tls->Remove();
189     delete tls;
190   }
191
192   // Stop relayout requests being raised on stage destruction
193   mRelayoutController.Reset();
194
195   // Clean-up stage - remove default camera and root layer
196   mStage->Uninitialize();
197
198   // remove (last?) reference to stage
199   mStage.Reset();
200
201   delete mEventProcessor;
202   delete mGestureEventProcessor;
203   delete mNotificationManager;
204   delete mShaderFactory;
205   delete mResourceManager;
206   delete mDiscardQueue;
207   delete mTextureCacheDispatcher;
208   delete mUpdateManager;
209   delete mRenderManager;
210   delete mRenderTaskProcessor;
211   delete mTextureUploadedQueue;
212 }
213
214 Integration::ContextNotifierInterface* Core::GetContextNotifier()
215 {
216   return mStage.Get();
217 }
218
219 void Core::RecoverFromContextLoss()
220 {
221   DALI_LOG_INFO(gCoreFilter, Debug::Verbose, "Core::RecoverFromContextLoss()\n");
222
223   mStage->GetRenderTaskList().RecoverFromContextLoss(); // Re-trigger render-tasks
224 }
225
226 void Core::ContextCreated()
227 {
228   mRenderManager->ContextCreated();
229 }
230
231 void Core::ContextDestroyed()
232 {
233   mRenderManager->ContextDestroyed();
234 }
235
236 void Core::SurfaceResized( unsigned int width, unsigned int height )
237 {
238   mStage->SurfaceResized( width, height );
239
240   // The stage-size may be less than surface-size (reduced by top-margin)
241   Vector2 size = mStage->GetSize();
242   mRelayoutController->SetStageSize( size.width, size.height );
243 }
244
245 void Core::SetTopMargin( unsigned int margin )
246 {
247   mStage->SetTopMargin( margin );
248
249   // The stage-size may be less than surface-size (reduced by top-margin)
250   Vector2 size = mStage->GetSize();
251   mRelayoutController->SetStageSize( size.width, size.height );
252 }
253
254 void Core::SetDpi( unsigned int dpiHorizontal, unsigned int dpiVertical )
255 {
256   mStage->SetDpi( Vector2( dpiHorizontal , dpiVertical) );
257 }
258
259 void Core::Update( float elapsedSeconds, unsigned int lastVSyncTimeMilliseconds, unsigned int nextVSyncTimeMilliseconds, Integration::UpdateStatus& status )
260 {
261   // set the time delta so adaptor can easily print FPS with a release build with 0 as
262   // it is cached by frametime
263   status.secondsFromLastFrame = elapsedSeconds;
264
265   // Render returns true when there are updates on the stage or one or more animations are completed.
266   // Use the estimated time diff till we render as the elapsed time.
267   status.keepUpdating = mUpdateManager->Update( elapsedSeconds,
268                                                 lastVSyncTimeMilliseconds,
269                                                 nextVSyncTimeMilliseconds );
270
271   // Check the Notification Manager message queue to set needsNotification
272   status.needsNotification = mNotificationManager->MessagesToProcess();
273
274   // No need to keep update running if there are notifications to process.
275   // Any message to update will wake it up anyways
276
277   if ( mResourceManager->ResourcesToProcess() )
278   {
279     // If we are still processing resources, then we have to continue the update
280     status.keepUpdating |= Integration::KeepUpdating::LOADING_RESOURCES;
281   }
282 }
283
284 void Core::Render( RenderStatus& status )
285 {
286   bool updateRequired = mRenderManager->Render( status );
287
288   status.SetNeedsUpdate( updateRequired );
289 }
290
291 void Core::Suspend()
292 {
293   mPlatform.Suspend();
294
295   mIsActive = false;
296 }
297
298 void Core::Resume()
299 {
300   mPlatform.Resume();
301
302   mIsActive = true;
303
304   // trigger processing of events queued up while paused
305   ProcessEvents();
306 }
307
308 void Core::SceneCreated()
309 {
310   mStage->EmitSceneCreatedSignal();
311
312   mRelayoutController->OnApplicationSceneCreated();
313 }
314
315 void Core::QueueEvent( const Integration::Event& event )
316 {
317   mEventProcessor->QueueEvent( event );
318 }
319
320 void Core::ProcessEvents()
321 {
322   // Guard against calls to ProcessEvents() during ProcessEvents()
323   if( mProcessingEvent )
324   {
325     DALI_LOG_ERROR( "ProcessEvents should not be called from within ProcessEvents!\n" );
326     mRenderController.RequestProcessEventsOnIdle();
327     return;
328   }
329
330   mProcessingEvent = true;
331   mRelayoutController->SetProcessingCoreEvents( true );
332
333   // Signal that any messages received will be flushed soon
334   mUpdateManager->EventProcessingStarted();
335
336   mEventProcessor->ProcessEvents();
337
338   mNotificationManager->ProcessMessages();
339
340   // Avoid allocating MessageBuffers, triggering size-negotiation or sending any other spam whilst paused
341   if( mIsActive )
342   {
343     // Emit signal here to inform listeners that event processing has finished.
344     mStage->EmitEventProcessingFinishedSignal();
345
346     // Run the size negotiation after event processing finished signal
347     mRelayoutController->Relayout();
348
349     // Flush any queued messages for the update-thread
350     const bool messagesToProcess = mUpdateManager->FlushQueue();
351
352     // Check if the touch or gestures require updates.
353     const bool gestureNeedsUpdate = mGestureEventProcessor->NeedsUpdate();
354
355     if( messagesToProcess || gestureNeedsUpdate )
356     {
357       // tell the render controller to keep update thread running
358       mRenderController.RequestUpdate();
359     }
360   }
361
362   mRelayoutController->SetProcessingCoreEvents( false );
363
364   // ProcessEvents() may now be called again
365   mProcessingEvent = false;
366 }
367
368 unsigned int Core::GetMaximumUpdateCount() const
369 {
370   return MAXIMUM_UPDATE_COUNT;
371 }
372
373 Integration::SystemOverlay& Core::GetSystemOverlay()
374 {
375   return mStage->GetSystemOverlay();
376 }
377
378 void Core::SetViewMode( ViewMode viewMode )
379 {
380   mStage->SetViewMode( viewMode );
381 }
382
383 ViewMode Core::GetViewMode() const
384 {
385   return mStage->GetViewMode();
386 }
387
388 void Core::SetStereoBase( float stereoBase )
389 {
390   mStage->SetStereoBase( stereoBase );
391 }
392
393 float Core::GetStereoBase() const
394 {
395   return mStage->GetStereoBase();
396 }
397
398 StagePtr Core::GetCurrentStage()
399 {
400   return mStage.Get();
401 }
402
403 PlatformAbstraction& Core::GetPlatform()
404 {
405   return mPlatform;
406 }
407
408 UpdateManager& Core::GetUpdateManager()
409 {
410   return *(mUpdateManager);
411 }
412
413 RenderManager& Core::GetRenderManager()
414 {
415   return *(mRenderManager);
416 }
417
418 NotificationManager& Core::GetNotificationManager()
419 {
420   return *(mNotificationManager);
421 }
422
423 ResourceManager& Core::GetResourceManager()
424 {
425   return *(mResourceManager);
426 }
427
428 ShaderFactory& Core::GetShaderFactory()
429 {
430   return *(mShaderFactory);
431 }
432
433 GestureEventProcessor& Core::GetGestureEventProcessor()
434 {
435   return *(mGestureEventProcessor);
436 }
437
438 RelayoutController& Core::GetRelayoutController()
439 {
440   return *(mRelayoutController.Get());
441 }
442
443 void Core::CreateThreadLocalStorage()
444 {
445   // a pointer to the ThreadLocalStorage object will be stored in TLS
446   // The ThreadLocalStorage object should be deleted by the Core destructor
447   new ThreadLocalStorage(this);
448 }
449
450 } // namespace Internal
451
452 } // namespace Dali