dali/internal/common/core-impl.cpp

   1 /*
   2  * Copyright (c) 2021 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/graphics-api/graphics-controller.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-context-helper-abstraction.h>
  27 #include <dali/integration-api/gl-sync-abstraction.h>
  28 #include <dali/integration-api/platform-abstraction.h>
  29 #include <dali/integration-api/processor-interface.h>
  30 #include <dali/integration-api/render-controller.h>
  31
  32 #include <dali/internal/event/actors/actor-impl.h>
  33 #include <dali/internal/event/animation/animation-playlist.h>
  34 #include <dali/internal/event/common/event-thread-services.h>
  35 #include <dali/internal/event/common/notification-manager.h>
  36 #include <dali/internal/event/common/property-notification-manager.h>
  37 #include <dali/internal/event/common/stage-impl.h>
  38 #include <dali/internal/event/common/thread-local-storage.h>
  39 #include <dali/internal/event/common/type-registry-impl.h>
  40 #include <dali/internal/event/effects/shader-factory.h>
  41 #include <dali/internal/event/events/event-processor.h>
  42 #include <dali/internal/event/events/gesture-event-processor.h>
  43 #include <dali/internal/event/render-tasks/render-task-list-impl.h>
  44 #include <dali/internal/event/size-negotiation/relayout-controller-impl.h>
  45
  46 #include <dali/internal/update/common/discard-queue.h>
  47 #include <dali/internal/update/manager/render-task-processor.h>
  48 #include <dali/internal/update/manager/update-manager.h>
  49
  50 #include <dali/internal/render/common/performance-monitor.h>
  51 #include <dali/internal/render/common/render-manager.h>
  52 #include <dali/internal/render/gl-resources/context.h>
  53
  54 using Dali::Internal::SceneGraph::DiscardQueue;
  55 using Dali::Internal::SceneGraph::RenderManager;
  56 using Dali::Internal::SceneGraph::RenderQueue;
  57 using Dali::Internal::SceneGraph::UpdateManager;
  58
  59 namespace
  60 {
  61 // The Update for frame N+1 may be processed whilst frame N is being rendered.
  62 const uint32_t MAXIMUM_UPDATE_COUNT = 2u;
  63
  64 #if defined(DEBUG_ENABLED)
  65 Debug::Filter* gCoreFilter = Debug::Filter::New(Debug::Concise, false, "LOG_CORE");
  66 #endif
  67 } // namespace
  68
  69 namespace Dali
  70 {
  71 namespace Internal
  72 {
  73 using Integration::Event;
  74 using Integration::GlAbstraction;
  75 using Integration::GlContextHelperAbstraction;
  76 using Integration::GlSyncAbstraction;
  77 using Integration::PlatformAbstraction;
  78 using Integration::RenderController;
  79 using Integration::RenderStatus;
  80 using Integration::UpdateStatus;
  81
  82 Core::Core(RenderController&                   renderController,
  83            PlatformAbstraction&                platform,
  84            Graphics::Controller&               graphicsController,
  85            Integration::RenderToFrameBuffer    renderToFboEnabled,
  86            Integration::DepthBufferAvailable   depthBufferAvailable,
  87            Integration::StencilBufferAvailable stencilBufferAvailable,
  88            Integration::PartialUpdateAvailable partialUpdateAvailable)
  89 : mRenderController(renderController),
  90   mPlatform(platform),
  91   mGraphicsController(graphicsController),
  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(graphicsController, depthBufferAvailable, stencilBufferAvailable, partialUpdateAvailable);
 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     tls->Unreference();
 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 void Core::Initialize()
 167 {
 168   mStage->Initialize(*mScenes[0]);
 169 }
 170
 171 Integration::ContextNotifierInterface* Core::GetContextNotifier()
 172 {
 173   return mStage.Get();
 174 }
 175
 176 void Core::RecoverFromContextLoss()
 177 {
 178   DALI_LOG_INFO(gCoreFilter, Debug::Verbose, "Core::RecoverFromContextLoss()\n");
 179
 180   mStage->GetRenderTaskList().RecoverFromContextLoss(); // Re-trigger render-tasks
 181 }
 182
 183 void Core::ContextCreated()
 184 {
 185   mRenderManager->ContextCreated();
 186 }
 187
 188 void Core::ContextDestroyed()
 189 {
 190   mRenderManager->ContextDestroyed();
 191 }
 192
 193 void Core::Update(float elapsedSeconds, uint32_t lastVSyncTimeMilliseconds, uint32_t nextVSyncTimeMilliseconds, Integration::UpdateStatus& status, bool renderToFboEnabled, bool isRenderingToFbo)
 194 {
 195   // set the time delta so adaptor can easily print FPS with a release build with 0 as
 196   // it is cached by frametime
 197   status.secondsFromLastFrame = elapsedSeconds;
 198
 199   // Render returns true when there are updates on the stage or one or more animations are completed.
 200   // Use the estimated time diff till we render as the elapsed time.
 201   status.keepUpdating = mUpdateManager->Update(elapsedSeconds,
 202                                                lastVSyncTimeMilliseconds,
 203                                                nextVSyncTimeMilliseconds,
 204                                                renderToFboEnabled,
 205                                                isRenderingToFbo);
 206
 207   // Check the Notification Manager message queue to set needsNotification
 208   status.needsNotification = mNotificationManager->MessagesToProcess();
 209
 210   // No need to keep update running if there are notifications to process.
 211   // Any message to update will wake it up anyways
 212 }
 213
 214 void Core::PreRender(RenderStatus& status, bool forceClear, bool uploadOnly)
 215 {
 216   mRenderManager->PreRender(status, forceClear, uploadOnly);
 217 }
 218
 219 void Core::PreRender(Integration::Scene& scene, std::vector<Rect<int>>& damagedRects)
 220 {
 221   mRenderManager->PreRender(scene, damagedRects);
 222 }
 223
 224 void Core::RenderScene(RenderStatus& status, Integration::Scene& scene, bool renderToFbo)
 225 {
 226   mRenderManager->RenderScene(status, scene, renderToFbo);
 227 }
 228
 229 void Core::RenderScene(RenderStatus& status, Integration::Scene& scene, bool renderToFbo, Rect<int>& clippingRect)
 230 {
 231   mRenderManager->RenderScene(status, scene, renderToFbo, clippingRect);
 232 }
 233
 234 void Core::PostRender(bool uploadOnly)
 235 {
 236   mRenderManager->PostRender(uploadOnly);
 237 }
 238
 239 void Core::SceneCreated()
 240 {
 241   mStage->EmitSceneCreatedSignal();
 242
 243   mRelayoutController->OnApplicationSceneCreated();
 244
 245   for(const auto& scene : mScenes)
 246   {
 247     Dali::Actor sceneRootLayer = scene->GetRootLayer();
 248     mRelayoutController->RequestRelayoutTree(sceneRootLayer);
 249   }
 250 }
 251
 252 void Core::QueueEvent(const Integration::Event& event)
 253 {
 254   if(mScenes.size() != 0)
 255   {
 256     mScenes.front()->QueueEvent(event);
 257   }
 258 }
 259
 260 void Core::ProcessEvents()
 261 {
 262   // Guard against calls to ProcessEvents() during ProcessEvents()
 263   if(mProcessingEvent)
 264   {
 265     DALI_LOG_ERROR("ProcessEvents should not be called from within ProcessEvents!\n");
 266     mRenderController.RequestProcessEventsOnIdle(false);
 267     return;
 268   }
 269
 270   mProcessingEvent = true;
 271   mRelayoutController->SetProcessingCoreEvents(true);
 272
 273   // Signal that any messages received will be flushed soon
 274   mUpdateManager->EventProcessingStarted();
 275
 276   // Scene could be added or removed while processing the events
 277   // Copy the Scene container locally to avoid possibly invalid iterator
 278   SceneContainer scenes = mScenes;
 279
 280   // process events in all scenes
 281   for(auto scene : scenes)
 282   {
 283     scene->ProcessEvents();
 284   }
 285
 286   mNotificationManager->ProcessMessages();
 287
 288   // Emit signal here to inform listeners that event processing has finished.
 289   for(auto scene : scenes)
 290   {
 291     scene->EmitEventProcessingFinishedSignal();
 292   }
 293
 294   // Run any registered processors
 295   RunProcessors();
 296
 297   // Run the size negotiation after event processing finished signal
 298   mRelayoutController->Relayout();
 299
 300   // Rebuild depth tree after event processing has finished
 301   for(auto scene : scenes)
 302   {
 303     scene->RebuildDepthTree();
 304   }
 305
 306   // Flush any queued messages for the update-thread
 307   const bool messagesToProcess = mUpdateManager->FlushQueue();
 308
 309   // Check if the touch or gestures require updates.
 310   const bool gestureNeedsUpdate = mGestureEventProcessor->NeedsUpdate();
 311   // Check if the next update is forced.
 312   const bool forceUpdate = IsNextUpdateForced();
 313
 314   if(messagesToProcess || gestureNeedsUpdate || forceUpdate)
 315   {
 316     // tell the render controller to keep update thread running
 317     mRenderController.RequestUpdate(forceUpdate);
 318   }
 319
 320   mRelayoutController->SetProcessingCoreEvents(false);
 321
 322   // ProcessEvents() may now be called again
 323   mProcessingEvent = false;
 324 }
 325
 326 uint32_t Core::GetMaximumUpdateCount() const
 327 {
 328   return MAXIMUM_UPDATE_COUNT;
 329 }
 330
 331 void Core::RegisterProcessor(Integration::Processor& processor)
 332 {
 333   mProcessors.PushBack(&processor);
 334 }
 335
 336 void Core::UnregisterProcessor(Integration::Processor& processor)
 337 {
 338   auto iter = std::find(mProcessors.Begin(), mProcessors.End(), &processor);
 339   if(iter != mProcessors.End())
 340   {
 341     mProcessors.Erase(iter);
 342   }
 343 }
 344
 345 void Core::RunProcessors()
 346 {
 347   // Copy processor pointers to prevent changes to vector affecting loop iterator.
 348   Dali::Vector<Integration::Processor*> processors(mProcessors);
 349
 350   for(auto processor : processors)
 351   {
 352     if(processor)
 353     {
 354       processor->Process();
 355     }
 356   }
 357 }
 358
 359 StagePtr Core::GetCurrentStage()
 360 {
 361   return mStage.Get();
 362 }
 363
 364 PlatformAbstraction& Core::GetPlatform()
 365 {
 366   return mPlatform;
 367 }
 368
 369 UpdateManager& Core::GetUpdateManager()
 370 {
 371   return *(mUpdateManager);
 372 }
 373
 374 RenderManager& Core::GetRenderManager()
 375 {
 376   return *(mRenderManager);
 377 }
 378
 379 NotificationManager& Core::GetNotificationManager()
 380 {
 381   return *(mNotificationManager);
 382 }
 383
 384 ShaderFactory& Core::GetShaderFactory()
 385 {
 386   return *(mShaderFactory);
 387 }
 388
 389 GestureEventProcessor& Core::GetGestureEventProcessor()
 390 {
 391   return *(mGestureEventProcessor);
 392 }
 393
 394 RelayoutController& Core::GetRelayoutController()
 395 {
 396   return *(mRelayoutController.Get());
 397 }
 398
 399 ObjectRegistry& Core::GetObjectRegistry() const
 400 {
 401   return *(mObjectRegistry.Get());
 402 }
 403
 404 EventThreadServices& Core::GetEventThreadServices()
 405 {
 406   return *this;
 407 }
 408
 409 PropertyNotificationManager& Core::GetPropertyNotificationManager() const
 410 {
 411   return *(mPropertyNotificationManager);
 412 }
 413
 414 AnimationPlaylist& Core::GetAnimationPlaylist() const
 415 {
 416   return *(mAnimationPlaylist);
 417 }
 418
 419 Integration::GlAbstraction& Core::GetGlAbstraction() const
 420 {
 421   return mGraphicsController.GetGlAbstraction();
 422 }
 423
 424 void Core::AddScene(Scene* scene)
 425 {
 426   mScenes.push_back(scene);
 427 }
 428
 429 void Core::RemoveScene(Scene* scene)
 430 {
 431   auto iter = std::find(mScenes.begin(), mScenes.end(), scene);
 432   if(iter != mScenes.end())
 433   {
 434     mScenes.erase(iter);
 435   }
 436 }
 437
 438 void Core::CreateThreadLocalStorage()
 439 {
 440   // a pointer to the ThreadLocalStorage object will be stored in TLS
 441   // The ThreadLocalStorage object should be deleted by the Core destructor
 442   ThreadLocalStorage* tls = new ThreadLocalStorage(this);
 443   tls->Reference();
 444 }
 445
 446 void Core::RegisterObject(Dali::BaseObject* object)
 447 {
 448   mObjectRegistry = &ThreadLocalStorage::Get().GetObjectRegistry();
 449   mObjectRegistry->RegisterObject(object);
 450 }
 451
 452 void Core::UnregisterObject(Dali::BaseObject* object)
 453 {
 454   mObjectRegistry = &ThreadLocalStorage::Get().GetObjectRegistry();
 455   mObjectRegistry->UnregisterObject(object);
 456 }
 457
 458 Integration::RenderController& Core::GetRenderController()
 459 {
 460   return mRenderController;
 461 }
 462
 463 uint32_t* Core::ReserveMessageSlot(uint32_t size, bool updateScene)
 464 {
 465   return mUpdateManager->ReserveMessageSlot(size, updateScene);
 466 }
 467
 468 BufferIndex Core::GetEventBufferIndex() const
 469 {
 470   return mUpdateManager->GetEventBufferIndex();
 471 }
 472
 473 void Core::ForceNextUpdate()
 474 {
 475   mForceNextUpdate = true;
 476 }
 477
 478 bool Core::IsNextUpdateForced()
 479 {
 480   bool nextUpdateForced = mForceNextUpdate;
 481   mForceNextUpdate      = false;
 482   return nextUpdateForced;
 483 }
 484
 485 } // namespace Internal
 486
 487 } // namespace Dali