1 #ifndef DALI_INTERNAL_ADAPTOR_IMPL_H
2 #define DALI_INTERNAL_ADAPTOR_IMPL_H
5 * Copyright (c) 2023 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/devel-api/threading/mutex.h>
23 #include <dali/integration-api/render-controller.h>
24 #include <dali/public-api/adaptor-framework/timer.h>
25 #include <dali/public-api/common/vector-wrapper.h>
26 #include <dali/public-api/math/rect.h>
27 #include <dali/public-api/math/uint-16-pair.h>
28 #include <dali/public-api/signals/callback.h>
31 #include <dali/integration-api/adaptor-framework/adaptor.h>
32 #include <dali/integration-api/adaptor-framework/scene-holder-impl.h>
33 #include <dali/integration-api/adaptor-framework/trigger-event-factory.h>
34 #include <dali/integration-api/scene.h>
35 #include <dali/internal/adaptor/common/adaptor-internal-services.h>
36 #include <dali/internal/graphics/common/graphics-interface.h>
37 #include <dali/internal/legacy/common/tizen-platform-abstraction.h>
38 #include <dali/internal/network/common/socket-factory.h>
39 #include <dali/internal/system/common/core-event-interface.h>
40 #include <dali/internal/system/common/environment-options.h>
41 #include <dali/internal/system/common/kernel-trace.h>
42 #include <dali/internal/system/common/system-trace.h>
43 #include <dali/internal/window-system/common/damage-observer.h>
44 #include <dali/internal/window-system/common/window-visibility-observer.h>
45 #include <dali/public-api/adaptor-framework/tts-player.h>
51 class RenderSurfaceInterface;
53 namespace Accessibility
64 } // namespace Integration
70 class DisplayConnection;
71 class GraphicsFactory;
72 class GlImplementation;
73 class GlSyncImplementation;
74 class ThreadController;
76 class CallbackManager;
77 class FeedbackPluginProxy;
78 class FeedbackController;
80 class PerformanceInterface;
81 class LifeCycleObserver;
84 class ConfigurationManager;
85 enum class ThreadMode;
88 * Implementation of the Adaptor class.
90 class Adaptor : public Integration::RenderController,
91 public AdaptorInternalServices,
92 public CoreEventInterface,
93 public DamageObserver,
94 public WindowVisibilityObserver
97 using AdaptorSignalType = Dali::Adaptor::AdaptorSignalType;
98 using WindowCreatedSignalType = Dali::Adaptor::WindowCreatedSignalType;
99 using LocaleChangedSignalType = Dali::Adaptor::LocaleChangedSignalType;
101 using SurfaceSize = Uint16Pair; ///< Surface size type
104 * Creates a New Adaptor
105 * @param[in] window The window handle
106 * @param[in] surface A render surface can be one of the following
107 * - Pixmap, adaptor will use existing Pixmap to draw on to
108 * - Window, adaptor will use existing Window to draw on to
109 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
110 * @param[in] threadMode The thread mode
112 static Dali::Adaptor* New(Dali::Integration::SceneHolder window,
113 Dali::RenderSurfaceInterface* surface,
114 EnvironmentOptions* environmentOptions,
115 ThreadMode threadMode);
118 * Creates a New Adaptor
119 * @param[in] window The window handle
120 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
122 static Dali::Adaptor* New(Dali::Integration::SceneHolder window,
123 EnvironmentOptions* environmentOptions);
126 * Creates a New Adaptor
127 * @param[in] graphicsFactory A factory that creates the graphics interface
128 * @param[in] window The window handle
129 * @param[in] surface A render surface can be one of the following
130 * - Pixmap, adaptor will use existing Pixmap to draw on to
131 * - Window, adaptor will use existing Window to draw on to
132 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
133 * @param[in] threadMode The thread mode
135 static Dali::Adaptor* New(GraphicsFactory& graphicsFactory,
136 Dali::Integration::SceneHolder window,
137 Dali::RenderSurfaceInterface* surface,
138 EnvironmentOptions* environmentOptions,
139 ThreadMode threadMode);
142 * Creates a New Adaptor
143 * @param[in] graphicsFactory A factory that creates the graphics interface
144 * @param[in] window The window handle
145 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
147 static Dali::Adaptor* New(GraphicsFactory& graphicsFactory,
148 Dali::Integration::SceneHolder window,
149 EnvironmentOptions* environmentOptions);
152 * 2-step initialisation, this should be called after creating an adaptor instance.
153 * @param[in] graphicsFactory A factory that creates the graphics interface
155 void Initialize(GraphicsFactory& graphicsFactory);
158 * Virtual destructor.
163 * @copydoc Dali::Adaptor::Get()
165 static Dali::Adaptor& Get();
168 * @copydoc Dali::Adaptor::IsAvailable()
170 static bool IsAvailable();
173 * @copydoc Dali::Core::SceneCreated();
178 * Get the application package name
180 static std::string GetApplicationPackageName();
182 public: // AdaptorInternalServices implementation
184 * @copydoc Dali::Adaptor::Start()
186 virtual void Start();
189 * @copydoc Dali::Adaptor::Pause()
191 virtual void Pause();
194 * @copydoc Dali::Adaptor::Resume()
196 virtual void Resume();
199 * @copydoc Dali::Adaptor::Stop()
204 * @copydoc Dali::Adaptor::ContextLost()
206 virtual void ContextLost();
209 * @copydoc Dali::Adaptor::ContextRegained()
211 virtual void ContextRegained();
214 * @copydoc Dali::EventFeeder::FeedTouchPoint()
216 virtual void FeedTouchPoint(TouchPoint& point, int timeStamp);
219 * @copydoc Dali::EventFeeder::FeedWheelEvent()
221 virtual void FeedWheelEvent(Dali::WheelEvent& wheelEvent);
224 * @copydoc Dali::EventFeeder::FeedKeyEvent()
226 virtual void FeedKeyEvent(Dali::KeyEvent& keyEvent);
229 * @copydoc Dali::Adaptor::ReplaceSurface()
231 virtual void ReplaceSurface(Dali::Integration::SceneHolder window, Dali::RenderSurfaceInterface& surface);
234 * @copydoc Dali::Adaptor::GetSurface()
236 virtual Dali::RenderSurfaceInterface& GetSurface() const;
239 * @copydoc Dali::Adaptor::ReleaseSurfaceLock()
241 virtual void ReleaseSurfaceLock();
244 * Retrieve the TtsPlayer.
245 * @param[in] mode The mode of TtsPlayer
246 * @return A handle to the TtsPlayer.
248 virtual Dali::TtsPlayer GetTtsPlayer(Dali::TtsPlayer::Mode mode);
251 * @copydoc Dali::Adaptor::AddIdle()
253 virtual bool AddIdle(CallbackBase* callback, bool hasReturnValue);
256 * Adds a new Window instance to the Adaptor
257 * @param[in] childWindow The child window instance
259 virtual bool AddWindow(Dali::Integration::SceneHolder childWindow);
262 * Removes an existing Window instance from the Adaptor
263 * @param[in] window The Window instance
265 virtual bool RemoveWindow(Dali::Integration::SceneHolder* childWindow);
268 * Removes an existing Window instance from the Adaptor
269 * @param[in] windowName The Window name
270 * @note If two Windows have the same name, the first one that matches will be removed
272 virtual bool RemoveWindow(std::string childWindowName);
275 * @copydoc Dali::Adaptor::RemoveIdle()
277 virtual void RemoveIdle(CallbackBase* callback);
280 * @copydoc Dali::Adaptor::ProcessIdle()
282 virtual void ProcessIdle();
285 * Sets a pre-render callback.
287 void SetPreRenderCallback(CallbackBase* callback);
290 * Removes an existing Window instance from the Adaptor
291 * @param[in] childWindow The Window instance
293 bool RemoveWindow(Dali::Internal::Adaptor::SceneHolder* childWindow);
296 * @brief Deletes the rendering surface
297 * @param[in] surface to delete
299 void DeleteSurface(Dali::RenderSurfaceInterface& surface);
302 * @brief Retrieve the window that the given actor is added to.
304 * @param[in] actor The actor
305 * @return The window the actor is added to or a null pointer if the actor is not added to any widnow.
307 Dali::Internal::Adaptor::SceneHolder* GetWindow(Dali::Actor& actor);
310 * @copydoc Dali::Adaptor::GetWindows()
312 Dali::WindowContainer GetWindows() const;
315 * @copydoc Dali::Adaptor::GetSceneHolders()
317 Dali::SceneHolderList GetSceneHolders() const;
320 * @copydoc Dali::Adaptor::GetObjectRegistry()
322 Dali::ObjectRegistry GetObjectRegistry() const;
326 * @return the Core instance
328 Dali::Integration::Core& GetCore() override;
331 * @copydoc Dali::Adaptor::SetRenderRefreshRate()
333 void SetRenderRefreshRate(unsigned int numberOfVSyncsPerRender);
336 * Return the PlatformAbstraction.
337 * @return The PlatformAbstraction.
339 Integration::PlatformAbstraction& GetPlatformAbstraction() const;
342 * Destroy the TtsPlayer of specific mode.
343 * @param[in] mode The mode of TtsPlayer to destroy
345 void DestroyTtsPlayer(Dali::TtsPlayer::Mode mode);
348 * Gets native window handle
350 * @return native window handle
352 Any GetNativeWindowHandle();
355 * @brief Retrieve native window handle that the given actor is added to.
357 * @param[in] actor The actor
358 * @return native window handle
360 Any GetNativeWindowHandle(Dali::Actor actor);
363 * Get the native display associated with the graphics backend
365 * @return A handle to the native display
367 Any GetGraphicsDisplay();
370 * Sets use remote surface for Surface output
371 * @param[in] useRemoteSurface True if the remote surface is used
373 void SetUseRemoteSurface(bool useRemoteSurface);
377 * Adds an adaptor observer so that we can observe the adaptor's lifetime events.
378 * @param[in] observer The observer.
379 * @note Observers should remove themselves when they are destroyed.
381 void AddObserver(LifeCycleObserver& observer);
384 * Removes the observer from the adaptor.
385 * @param[in] observer The observer to remove.
386 * @note Observers should remove themselves when they are destroyed.
388 void RemoveObserver(LifeCycleObserver& observer);
391 * Emits the Notification event to the Dali core.
393 void SendNotificationEvent();
396 * Request adaptor to update once
398 void RequestUpdateOnce();
401 * @copydoc Dali::Adaptor::NotifySceneCreated()
403 void NotifySceneCreated();
406 * @copydoc Dali::Adaptor::NotifyLanguageChanged()
408 void NotifyLanguageChanged();
411 * Gets AppId of current application
413 void GetAppId(std::string& appId);
416 * Gets path for resource storage.
417 * @param[out] path Path for resource storage
419 void GetResourceStoragePath(std::string& path);
422 * @copydoc Dali::Adaptor::SurfaceResizePrepare
424 void SurfaceResizePrepare(Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize);
427 * @copydoc Dali::Adaptor::SurfaceResizeComplete
429 void SurfaceResizeComplete(Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize);
432 * @brief Increase surface resize completed counter.
433 * This API will be ignored if thread controller is not exist.
435 void IncreaseSurfaceResizeCounter();
438 * Sets layout direction of root by system language
439 * @param[in] locale System locale
441 void SetRootLayoutDirection(std::string locale);
444 * @copydoc Dali::Adaptor::RenderOnce
449 * @copydoc Dali::Adaptor::GetLogFactory
451 const LogFactoryInterface& GetLogFactory();
454 * @copydoc Dali::Adaptor::GetTraceFactory
456 const TraceFactoryInterface& GetTraceFactory();
459 * @copydoc Dali::Adaptor::RegisterProcessor
461 void RegisterProcessor(Integration::Processor& processor, bool postProcessor);
464 * @coydoc Dali::Adaptor::UnregisterProcessor
466 void UnregisterProcessor(Integration::Processor& processor, bool postProcessor);
469 * Check MultipleWindow is supported
471 bool IsMultipleWindowSupported() const;
474 * @brief Gets the render thread id of DALi.
475 * @note If render thread id getter doesn't supported, it will return 0 as default.
476 * @return The render thread id.
478 int32_t GetRenderThreadId() const;
480 public: //AdaptorInternalServices
482 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPlatformAbstractionInterface()
484 Dali::Integration::PlatformAbstraction& GetPlatformAbstractionInterface() override;
487 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetDisplayConnectionInterface()
489 Dali::DisplayConnection& GetDisplayConnectionInterface() override;
492 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetGraphicsInterface()
494 GraphicsInterface& GetGraphicsInterface() override;
497 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventInterface()
499 TriggerEventInterface& GetProcessCoreEventsTrigger() override;
502 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSocketFactoryInterface()
504 SocketFactoryInterface& GetSocketFactoryInterface() override;
507 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetRenderSurfaceInterface()
509 Dali::RenderSurfaceInterface* GetRenderSurfaceInterface() override;
512 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPerformanceInterface()
514 PerformanceInterface* GetPerformanceInterface() override;
517 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetKernelTraceInterface()
519 TraceInterface& GetKernelTraceInterface() override;
522 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSystemTraceInterface()
524 TraceInterface& GetSystemTraceInterface() override;
527 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetWindowContainerInterface()
529 void GetWindowContainerInterface(WindowContainer& windows) override;
532 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTextureUploadManager()
534 Devel::TextureUploadManager& GetTextureUploadManager() override;
537 * @brief Get the configuration manager
538 * @return The configuration manager, or null if it hasn't been created yet
540 const ConfigurationManager* GetConfigurationManager() const
542 return mConfigurationManager.get();
547 * @copydoc Dali::Adaptor::SignalResized
549 AdaptorSignalType& ResizedSignal()
551 return mResizedSignal;
555 * @copydoc Dali::Adaptor::LanguageChangedSignal
557 AdaptorSignalType& LanguageChangedSignal()
559 return mLanguageChangedSignal;
563 * @copydoc Dali::Adaptor::WindowCreatedSignal
565 WindowCreatedSignalType& WindowCreatedSignal()
567 return mWindowCreatedSignal;
571 * @copydoc Dali::Adaptor::LocaleChangedSignal
573 LocaleChangedSignalType& LocaleChangedSignal()
575 return mLocaleChangedSignal;
578 public: // From Dali::Internal::Adaptor::CoreEventInterface
580 * @copydoc Dali::Internal::Adaptor::CoreEventInterface:::FlushUpdateMessages()
582 void FlushUpdateMessages() override;
585 * @copydoc Dali::Internal::Adaptor::CoreEventInterface:::ProcessCoreEvents()
587 void ProcessCoreEvents() override;
589 private: // From Dali::Internal::Adaptor::CoreEventInterface
591 * @copydoc Dali::Internal::Adaptor::CoreEventInterface::QueueCoreEvent()
593 void QueueCoreEvent(const Dali::Integration::Event& event) override;
595 public: // From Dali::Integration::RenderController
597 * @copydoc Dali::Integration::RenderController::RequestUpdate()
599 void RequestUpdate() override;
602 * @copydoc Dali::Integration::RenderController::RequestProcessEventsOnIdle()
604 void RequestProcessEventsOnIdle() override;
606 public: // From Dali::Internal::Adaptor::WindowVisibilityObserver
608 * Called when the window becomes fully or partially visible.
610 void OnWindowShown() override;
613 * Called when the window is fully hidden.
615 void OnWindowHidden() override;
617 private: // From Dali::Internal::Adaptor::DamageObserver
619 * @copydoc Dali::Internal::Adaptor::DamageObserver::OnDamaged()
621 void OnDamaged(const DamageArea& area) override;
625 Adaptor(const Adaptor&) = delete;
626 Adaptor& operator=(Adaptor&) = delete;
630 * Assigns the render surface to the adaptor
633 void SetSurface(Dali::RenderSurfaceInterface* surface);
636 * called after surface is created
638 void SurfaceInitialized();
641 * Sends an notification message from main loop idle handler
643 bool ProcessCoreEventsFromIdle();
646 * Gets path for data/resource storage.
647 * @param[out] path Path for data/resource storage
649 void GetDataStoragePath(std::string& path);
652 * Sets up system information if needs
654 void SetupSystemInformation();
657 * Remove system information if needs
659 void RemoveSystemInformation();
662 * Adds a callback to be run when entering an idle state.
664 * A callback of the following type should be used:
668 * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
670 bool AddIdleEnterer(CallbackBase* callback);
673 * Removes a previously added the idle enterer callback.
675 void RemoveIdleEnterer(CallbackBase* callback);
678 * Trigger to log the memory pools from Core and Adaptor
680 bool MemoryPoolTimeout();
685 * @param[in] window window handle
686 * @param[in] adaptor The public adaptor
687 * @param[in] surface A render surface can be one of the following
688 * - Pixmap, adaptor will use existing Pixmap to draw on to
689 * - Window, adaptor will use existing Window to draw on to
690 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
691 * @param[in] threadMode The ThreadMode of the Adaptor
693 Adaptor(Dali::Integration::SceneHolder window, Dali::Adaptor& adaptor, Dali::RenderSurfaceInterface* surface, EnvironmentOptions* environmentOptions, ThreadMode threadMode);
698 READY, ///< Initial state before Adaptor::Start is called.
699 RUNNING, ///< Adaptor is running.
700 PAUSED, ///< Adaptor has been paused.
701 PAUSED_WHILE_HIDDEN, ///< Adaptor is paused while window is hidden (& cannot be resumed until window is shown).
702 PAUSED_WHILE_INITIALIZING, ///< Adaptor is paused while application is initializing.
703 STOPPED, ///< Adaptor has been stopped.
706 // There is no weak handle for BaseHandle in DALi, but we can't ref count the window here,
707 // so we have to store the raw pointer.
708 using WindowContainer = std::vector<Dali::Internal::Adaptor::SceneHolder*>;
709 using ObserverContainer = std::vector<LifeCycleObserver*>;
712 AdaptorSignalType mResizedSignal; ///< Resized signal.
713 AdaptorSignalType mLanguageChangedSignal; ///< Language changed signal.
714 WindowCreatedSignalType mWindowCreatedSignal; ///< Window created signal.
715 LocaleChangedSignalType mLocaleChangedSignal; ///< Locale changed signal.
717 Dali::Adaptor& mAdaptor; ///< Reference to public adaptor instance.
718 State mState; ///< Current state of the adaptor
719 Dali::Integration::Core* mCore; ///< Dali Core
720 ThreadController* mThreadController; ///< Controls the threads
722 std::unique_ptr<GraphicsInterface> mGraphics; ///< Graphics interface
723 Dali::DisplayConnection* mDisplayConnection; ///< Display connection
724 WindowContainer mWindows; ///< A container of all the Windows that are currently created
726 std::unique_ptr<ConfigurationManager> mConfigurationManager; ///< Configuration manager
728 TizenPlatform::TizenPlatformAbstraction* mPlatformAbstraction; ///< Platform abstraction
730 std::unique_ptr<CallbackManager> mCallbackManager; ///< Used to install callbacks
731 bool mNotificationOnIdleInstalled; ///< whether the idle handler is installed to send an notification event
732 bool mRequiredIdleRepeat; ///< whether we need to repeat installed notification event in idle handler
733 TriggerEventInterface* mNotificationTrigger; ///< Notification event trigger
734 FeedbackPluginProxy* mDaliFeedbackPlugin; ///< Used to access feedback support
735 FeedbackController* mFeedbackController; ///< Plays feedback effects for Dali-Toolkit UI Controls.
736 Dali::TtsPlayer mTtsPlayers[Dali::TtsPlayer::MODE_NUM]; ///< Provides TTS support
737 ObserverContainer mObservers; ///< A list of adaptor observer pointers
738 EnvironmentOptions* mEnvironmentOptions; ///< environment options
739 PerformanceInterface* mPerformanceInterface; ///< Performance interface
740 KernelTrace mKernelTracer; ///< Kernel tracer
741 SystemTrace mSystemTracer; ///< System tracer
742 Devel::TextureUploadManager mTextureUploadManager; ///< TextureUploadManager
743 ObjectProfiler* mObjectProfiler; ///< Tracks object lifetime for profiling
744 Dali::Timer mMemoryPoolTimer; ///< Logs memory pool capacity
745 SlotDelegate<Adaptor> mMemoryPoolTimerSlotDelegate;
746 SocketFactory mSocketFactory; ///< Socket factory
747 Mutex mMutex; ///< Mutex
748 ThreadMode mThreadMode; ///< The thread mode
749 const bool mEnvironmentOptionsOwned : 1; ///< Whether we own the EnvironmentOptions (and thus, need to delete it)
750 bool mUseRemoteSurface : 1; ///< whether the remoteSurface is used or not
751 Dali::LayoutDirection::Type mRootLayoutDirection; ///< LayoutDirection of window
753 std::unique_ptr<Integration::AddOnManager> mAddOnManager; ///< Pointer to the addon manager
755 class AccessibilityObserver : public ConnectionTracker
758 void OnAccessibleKeyEvent(const Dali::KeyEvent& event);
760 AccessibilityObserver mAccessibilityObserver;
763 inline static Adaptor& GetImplementation(Dali::Adaptor& adaptor)
765 return *adaptor.mImpl;
769 } // namespace Adaptor
771 } // namespace Internal
775 #endif // DALI_INTERNAL_ADAPTOR_IMPL_H