dali/internal/common/core-impl.cpp

   1 /*
   2  * Copyright (c) 2019 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/core.h>
  23 #include <dali/integration-api/debug.h>
  24 #include <dali/integration-api/events/event.h>
  25 #include <dali/integration-api/gl-sync-abstraction.h>
  26 #include <dali/integration-api/platform-abstraction.h>
  27 #include <dali/integration-api/processor-interface.h>
  28 #include <dali/integration-api/render-controller.h>
  29 #include <dali/integration-api/render-surface.h>
  30
  31 #include <dali/internal/event/actors/actor-impl.h>
  32 #include <dali/internal/event/animation/animation-playlist.h>
  33 #include <dali/internal/event/common/notification-manager.h>
  34 #include <dali/internal/event/common/property-notification-manager.h>
  35 #include <dali/internal/event/common/stage-impl.h>
  36 #include <dali/internal/event/common/thread-local-storage.h>
  37 #include <dali/internal/event/common/event-thread-services.h>
  38 #include <dali/internal/event/common/type-registry-impl.h>
  39 #include <dali/internal/event/effects/shader-factory.h>
  40 #include <dali/internal/event/events/event-processor.h>
  41 #include <dali/internal/event/events/gesture-event-processor.h>
  42 #include <dali/internal/event/render-tasks/render-task-list-impl.h>
  43 #include <dali/internal/event/size-negotiation/relayout-controller-impl.h>
  44
  45 #include <dali/internal/update/common/discard-queue.h>
  46 #include <dali/internal/update/manager/update-manager.h>
  47 #include <dali/internal/update/manager/render-task-processor.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/context.h>
  52
  53 using Dali::Internal::SceneGraph::UpdateManager;
  54 using Dali::Internal::SceneGraph::RenderManager;
  55 using Dali::Internal::SceneGraph::DiscardQueue;
  56 using Dali::Internal::SceneGraph::RenderQueue;
  57
  58 namespace
  59 {
  60 // The Update for frame N+1 may be processed whilst frame N is being rendered.
  61 const uint32_t MAXIMUM_UPDATE_COUNT = 2u;
  62
  63 #if defined(DEBUG_ENABLED)
  64 Debug::Filter* gCoreFilter = Debug::Filter::New(Debug::Concise, false, "LOG_CORE");
  65 #endif
  66 }
  67
  68 namespace Dali
  69 {
  70
  71 namespace Internal
  72 {
  73
  74 using Integration::RenderController;
  75 using Integration::PlatformAbstraction;
  76 using Integration::GlSyncAbstraction;
  77 using Integration::GlAbstraction;
  78 using Integration::Event;
  79 using Integration::UpdateStatus;
  80 using Integration::RenderStatus;
  81
  82 Core::Core( RenderController& renderController,
  83             PlatformAbstraction& platform,
  84             GlAbstraction& glAbstraction,
  85             GlSyncAbstraction& glSyncAbstraction,
  86             ResourcePolicy::DataRetention dataRetentionPolicy,
  87             Integration::RenderToFrameBuffer renderToFboEnabled,
  88             Integration::DepthBufferAvailable depthBufferAvailable,
  89             Integration::StencilBufferAvailable stencilBufferAvailable )
  90 : mRenderController( renderController ),
  91   mPlatform(platform),
  92   mProcessingEvent(false),
  93   mForceNextUpdate( false )
  94 {
  95   // Create the thread local storage
  96   CreateThreadLocalStorage();
  97
  98   // This does nothing until Core is built with --enable-performance-monitor
  99   PERFORMANCE_MONITOR_INIT( platform );
 100
 101   mNotificationManager = new NotificationManager();
 102
 103   mAnimationPlaylist = AnimationPlaylist::New();
 104
 105   mPropertyNotificationManager = PropertyNotificationManager::New();
 106
 107   mRenderTaskProcessor = new SceneGraph::RenderTaskProcessor();
 108
 109   mRenderManager = RenderManager::New( glAbstraction, glSyncAbstraction, depthBufferAvailable, stencilBufferAvailable );
 110
 111   RenderQueue& renderQueue = mRenderManager->GetRenderQueue();
 112
 113   mDiscardQueue = new DiscardQueue( renderQueue );
 114
 115   mUpdateManager = new UpdateManager( *mNotificationManager,
 116                                       *mAnimationPlaylist,
 117                                       *mPropertyNotificationManager,
 118                                       *mDiscardQueue,
 119                                        renderController,
 120                                       *mRenderManager,
 121                                        renderQueue,
 122                                       *mRenderTaskProcessor );
 123
 124   mRenderManager->SetShaderSaver( *mUpdateManager );
 125
 126   mObjectRegistry = ObjectRegistry::New();
 127
 128   mStage = IntrusivePtr<Stage>( Stage::New( *mUpdateManager ) );
 129
 130   // This must be called after stage is created but before stage initialization
 131   mRelayoutController = IntrusivePtr< RelayoutController >( new RelayoutController( mRenderController ) );
 132
 133   mGestureEventProcessor = new GestureEventProcessor( *mUpdateManager, mRenderController );
 134
 135   mShaderFactory = new ShaderFactory();
 136   mUpdateManager->SetShaderSaver( *mShaderFactory );
 137
 138   GetImplementation(Dali::TypeRegistry::Get()).CallInitFunctions();
 139 }
 140
 141 Core::~Core()
 142 {
 143   /*
 144    * The order of destructing these singletons is important!!!
 145    */
 146
 147   // clear the thread local storage first
 148   // allows core to be created / deleted many times in the same thread (how TET cases work).
 149   // Do this before mStage.Reset() so Stage::IsInstalled() returns false
 150   ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
 151   if( tls )
 152   {
 153     tls->Remove();
 154     delete tls;
 155   }
 156
 157   mObjectRegistry.Reset();
 158
 159   // Stop relayout requests being raised on stage destruction
 160   mRelayoutController.Reset();
 161
 162   // remove (last?) reference to stage
 163   mStage.Reset();
 164
 165 }
 166
 167 void Core::Initialize()
 168 {
 169   mStage->Initialize( *mScenes[0] );
 170 }
 171
 172 Integration::ContextNotifierInterface* Core::GetContextNotifier()
 173 {
 174   return mStage.Get();
 175 }
 176
 177 void Core::RecoverFromContextLoss()
 178 {
 179   DALI_LOG_INFO(gCoreFilter, Debug::Verbose, "Core::RecoverFromContextLoss()\n");
 180
 181   mStage->GetRenderTaskList().RecoverFromContextLoss(); // Re-trigger render-tasks
 182 }
 183
 184 void Core::ContextCreated()
 185 {
 186   mRenderManager->ContextCreated();
 187 }
 188
 189 void Core::ContextDestroyed()
 190 {
 191   mRenderManager->ContextDestroyed();
 192 }
 193
 194 void Core::SurfaceResized( Integration::RenderSurface* surface )
 195 {
 196   for( auto iter = mScenes.begin(); iter != mScenes.end(); ++iter )
 197   {
 198     if( (*iter)->GetSurface() == surface )
 199     {
 200       (*iter)->SetSurface( *surface );
 201     }
 202   }
 203 }
 204
 205 void Core::Update( float elapsedSeconds, uint32_t lastVSyncTimeMilliseconds, uint32_t nextVSyncTimeMilliseconds, Integration::UpdateStatus& status, bool renderToFboEnabled, bool isRenderingToFbo )
 206 {
 207   // set the time delta so adaptor can easily print FPS with a release build with 0 as
 208   // it is cached by frametime
 209   status.secondsFromLastFrame = elapsedSeconds;
 210
 211   // Render returns true when there are updates on the stage or one or more animations are completed.
 212   // Use the estimated time diff till we render as the elapsed time.
 213   status.keepUpdating = mUpdateManager->Update( elapsedSeconds,
 214                                                 lastVSyncTimeMilliseconds,
 215                                                 nextVSyncTimeMilliseconds,
 216                                                 renderToFboEnabled,
 217                                                 isRenderingToFbo );
 218
 219   // Check the Notification Manager message queue to set needsNotification
 220   status.needsNotification = mNotificationManager->MessagesToProcess();
 221
 222   // Check if the default surface is changed
 223   status.surfaceRectChanged = mUpdateManager->IsDefaultSurfaceRectChanged();
 224
 225   // No need to keep update running if there are notifications to process.
 226   // Any message to update will wake it up anyways
 227 }
 228
 229 void Core::Render( RenderStatus& status, bool forceClear )
 230 {
 231   mRenderManager->Render( status, forceClear );
 232 }
 233
 234 void Core::SceneCreated()
 235 {
 236   mStage->EmitSceneCreatedSignal();
 237
 238   mRelayoutController->OnApplicationSceneCreated();
 239
 240   for( auto iter = mScenes.begin(); iter != mScenes.end(); ++iter )
 241   {
 242     Dali::Actor sceneRootLayer = (*iter)->GetRootLayer();
 243     mRelayoutController->RequestRelayoutTree( sceneRootLayer );
 244   }
 245 }
 246
 247 void Core::QueueEvent( const Integration::Event& event )
 248 {
 249   if (mScenes.size() != 0)
 250   {
 251     mScenes.front()->QueueEvent( event );
 252   }
 253 }
 254
 255 void Core::ProcessEvents()
 256 {
 257   // Guard against calls to ProcessEvents() during ProcessEvents()
 258   if( mProcessingEvent )
 259   {
 260     DALI_LOG_ERROR( "ProcessEvents should not be called from within ProcessEvents!\n" );
 261     mRenderController.RequestProcessEventsOnIdle( false );
 262     return;
 263   }
 264
 265   mProcessingEvent = true;
 266   mRelayoutController->SetProcessingCoreEvents( true );
 267
 268   // Signal that any messages received will be flushed soon
 269   mUpdateManager->EventProcessingStarted();
 270
 271   // process events in all scenes
 272   for( auto iter = mScenes.begin(); iter != mScenes.end(); ++iter )
 273   {
 274     (*iter)->ProcessEvents();
 275   }
 276
 277   mNotificationManager->ProcessMessages();
 278
 279   // Emit signal here to inform listeners that event processing has finished.
 280   for( auto iter = mScenes.begin(); iter != mScenes.end(); ++iter )
 281   {
 282     (*iter)->EmitEventProcessingFinishedSignal();
 283   }
 284
 285   // Run any registered processors
 286   RunProcessors();
 287
 288   // Run the size negotiation after event processing finished signal
 289   mRelayoutController->Relayout();
 290
 291   // Rebuild depth tree after event processing has finished
 292   for( auto iter = mScenes.begin(); iter != mScenes.end(); ++iter )
 293   {
 294     (*iter)->RebuildDepthTree();
 295   }
 296
 297   // Flush any queued messages for the update-thread
 298   const bool messagesToProcess = mUpdateManager->FlushQueue();
 299
 300   // Check if the touch or gestures require updates.
 301   const bool gestureNeedsUpdate = mGestureEventProcessor->NeedsUpdate();
 302   // Check if the next update is forced.
 303   const bool forceUpdate = IsNextUpdateForced();
 304
 305   if( messagesToProcess || gestureNeedsUpdate || forceUpdate )
 306   {
 307     // tell the render controller to keep update thread running
 308     mRenderController.RequestUpdate( forceUpdate );
 309   }
 310
 311   mRelayoutController->SetProcessingCoreEvents( false );
 312
 313   // ProcessEvents() may now be called again
 314   mProcessingEvent = false;
 315 }
 316
 317 uint32_t Core::GetMaximumUpdateCount() const
 318 {
 319   return MAXIMUM_UPDATE_COUNT;
 320 }
 321
 322 void Core::RegisterProcessor( Integration::Processor& processor )
 323 {
 324   mProcessors.PushBack(&processor);
 325 }
 326
 327 void Core::UnregisterProcessor( Integration::Processor& processor )
 328 {
 329   auto iter = std::find( mProcessors.Begin(), mProcessors.End(), &processor );
 330   if( iter != mProcessors.End() )
 331   {
 332     mProcessors.Erase( iter );
 333   }
 334 }
 335
 336 void Core::RunProcessors()
 337 {
 338   // Copy processor pointers to prevent changes to vector affecting loop iterator.
 339   Dali::Vector<Integration::Processor*> processors( mProcessors );
 340
 341   for( auto processor : processors )
 342   {
 343     if( processor )
 344     {
 345       processor->Process();
 346     }
 347   }
 348 }
 349
 350 StagePtr Core::GetCurrentStage()
 351 {
 352   return mStage.Get();
 353 }
 354
 355 PlatformAbstraction& Core::GetPlatform()
 356 {
 357   return mPlatform;
 358 }
 359
 360 UpdateManager& Core::GetUpdateManager()
 361 {
 362   return *(mUpdateManager);
 363 }
 364
 365 RenderManager& Core::GetRenderManager()
 366 {
 367   return *(mRenderManager);
 368 }
 369
 370 NotificationManager& Core::GetNotificationManager()
 371 {
 372   return *(mNotificationManager);
 373 }
 374
 375 ShaderFactory& Core::GetShaderFactory()
 376 {
 377   return *(mShaderFactory);
 378 }
 379
 380 GestureEventProcessor& Core::GetGestureEventProcessor()
 381 {
 382   return *(mGestureEventProcessor);
 383 }
 384
 385 RelayoutController& Core::GetRelayoutController()
 386 {
 387   return *(mRelayoutController.Get());
 388 }
 389
 390 ObjectRegistry& Core::GetObjectRegistry() const
 391 {
 392   return *(mObjectRegistry.Get());
 393 }
 394
 395 EventThreadServices& Core::GetEventThreadServices()
 396 {
 397   return *this;
 398 }
 399
 400 PropertyNotificationManager& Core::GetPropertyNotificationManager() const
 401 {
 402   return *(mPropertyNotificationManager);
 403 }
 404
 405 AnimationPlaylist& Core::GetAnimationPlaylist() const
 406 {
 407   return *(mAnimationPlaylist);
 408 }
 409
 410 void Core::AddScene( Scene* scene )
 411 {
 412   mScenes.push_back( scene );
 413 }
 414
 415 void Core::RemoveScene( Scene* scene )
 416 {
 417   auto iter = std::find( mScenes.begin(), mScenes.end(), scene );
 418   if( iter != mScenes.end() )
 419   {
 420     mScenes.erase( iter );
 421   }
 422 }
 423
 424 void Core::CreateThreadLocalStorage()
 425 {
 426   // a pointer to the ThreadLocalStorage object will be stored in TLS
 427   // The ThreadLocalStorage object should be deleted by the Core destructor
 428   new ThreadLocalStorage(this);
 429 }
 430
 431 void Core::RegisterObject( Dali::BaseObject* object )
 432 {
 433   mObjectRegistry = &ThreadLocalStorage::Get().GetObjectRegistry();
 434   mObjectRegistry->RegisterObject( object );
 435 }
 436
 437 void Core::UnregisterObject( Dali::BaseObject* object )
 438 {
 439   mObjectRegistry = &ThreadLocalStorage::Get().GetObjectRegistry();
 440   mObjectRegistry->UnregisterObject( object );
 441 }
 442
 443 Integration::RenderController& Core::GetRenderController()
 444 {
 445   return mRenderController;
 446 }
 447
 448 uint32_t* Core::ReserveMessageSlot( uint32_t size, bool updateScene )
 449 {
 450   return mUpdateManager->ReserveMessageSlot( size, updateScene );
 451 }
 452
 453 BufferIndex Core::GetEventBufferIndex() const
 454 {
 455   return mUpdateManager->GetEventBufferIndex();
 456 }
 457
 458 void Core::ForceNextUpdate()
 459 {
 460   mForceNextUpdate = true;
 461 }
 462
 463 bool Core::IsNextUpdateForced()
 464 {
 465   bool nextUpdateForced = mForceNextUpdate;
 466   mForceNextUpdate = false;
 467   return nextUpdateForced;
 468 }
 469
 470 } // namespace Internal
 471
 472 } // namespace Dali