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/devel-api/adaptor-framework/text-clipboard.h>
32 #include <dali/integration-api/adaptor-framework/adaptor.h>
33 #include <dali/integration-api/adaptor-framework/scene-holder-impl.h>
34 #include <dali/integration-api/adaptor-framework/trigger-event-factory.h>
35 #include <dali/integration-api/scene.h>
36 #include <dali/internal/adaptor/common/adaptor-internal-services.h>
37 #include <dali/internal/graphics/common/graphics-interface.h>
38 #include <dali/internal/legacy/common/tizen-platform-abstraction.h>
39 #include <dali/internal/network/common/socket-factory.h>
40 #include <dali/internal/system/common/core-event-interface.h>
41 #include <dali/internal/system/common/environment-options.h>
42 #include <dali/internal/system/common/kernel-trace.h>
43 #include <dali/internal/system/common/system-trace.h>
44 #include <dali/internal/window-system/common/damage-observer.h>
45 #include <dali/internal/window-system/common/window-visibility-observer.h>
46 #include <dali/public-api/adaptor-framework/tts-player.h>
52 class RenderSurfaceInterface;
54 namespace Accessibility
65 } // namespace Integration
71 class DisplayConnection;
72 class GraphicsFactory;
73 class GlImplementation;
74 class GlSyncImplementation;
75 class ThreadController;
77 class CallbackManager;
78 class FeedbackPluginProxy;
79 class FeedbackController;
81 class PerformanceInterface;
82 class LifeCycleObserver;
85 class ConfigurationManager;
86 enum class ThreadMode;
89 * Implementation of the Adaptor class.
91 class Adaptor : public Integration::RenderController,
92 public AdaptorInternalServices,
93 public CoreEventInterface,
94 public DamageObserver,
95 public WindowVisibilityObserver
98 using AdaptorSignalType = Dali::Adaptor::AdaptorSignalType;
99 using WindowCreatedSignalType = Dali::Adaptor::WindowCreatedSignalType;
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();
177 static std::string GetApplicationPackageName();
179 public: // AdaptorInternalServices implementation
181 * @copydoc Dali::Adaptor::Start()
183 virtual void Start();
186 * @copydoc Dali::Adaptor::Pause()
188 virtual void Pause();
191 * @copydoc Dali::Adaptor::Resume()
193 virtual void Resume();
196 * @copydoc Dali::Adaptor::Stop()
201 * @copydoc Dali::Adaptor::ContextLost()
203 virtual void ContextLost();
206 * @copydoc Dali::Adaptor::ContextRegained()
208 virtual void ContextRegained();
211 * @copydoc Dali::EventFeeder::FeedTouchPoint()
213 virtual void FeedTouchPoint(TouchPoint& point, int timeStamp);
216 * @copydoc Dali::EventFeeder::FeedWheelEvent()
218 virtual void FeedWheelEvent(Dali::WheelEvent& wheelEvent);
221 * @copydoc Dali::EventFeeder::FeedKeyEvent()
223 virtual void FeedKeyEvent(Dali::KeyEvent& keyEvent);
226 * @copydoc Dali::Adaptor::ReplaceSurface()
228 virtual void ReplaceSurface(Dali::Integration::SceneHolder window, Dali::RenderSurfaceInterface& surface);
231 * @copydoc Dali::Adaptor::GetSurface()
233 virtual Dali::RenderSurfaceInterface& GetSurface() const;
236 * @copydoc Dali::Adaptor::ReleaseSurfaceLock()
238 virtual void ReleaseSurfaceLock();
241 * Retrieve the TtsPlayer.
242 * @param[in] mode The mode of TtsPlayer
243 * @return A handle to the TtsPlayer.
245 virtual Dali::TtsPlayer GetTtsPlayer(Dali::TtsPlayer::Mode mode);
248 * @copydoc Dali::Adaptor::AddIdle()
250 virtual bool AddIdle(CallbackBase* callback, bool hasReturnValue, bool forceAdd);
253 * Adds a new Window instance to the Adaptor
254 * @param[in] childWindow The child window instance
256 virtual bool AddWindow(Dali::Integration::SceneHolder childWindow);
259 * Removes an existing Window instance from the Adaptor
260 * @param[in] window The Window instance
262 virtual bool RemoveWindow(Dali::Integration::SceneHolder* childWindow);
265 * Removes an existing Window instance from the Adaptor
266 * @param[in] windowName The Window name
267 * @note If two Windows have the same name, the first one that matches will be removed
269 virtual bool RemoveWindow(std::string childWindowName);
272 * @copydoc Dali::Adaptor::RemoveIdle()
274 virtual void RemoveIdle(CallbackBase* callback);
277 * @copydoc Dali::Adaptor::ProcessIdle()
279 virtual void ProcessIdle();
282 * Sets a pre-render callback.
284 void SetPreRenderCallback(CallbackBase* callback);
287 * Removes an existing Window instance from the Adaptor
288 * @param[in] childWindow The Window instance
290 bool RemoveWindow(Dali::Internal::Adaptor::SceneHolder* childWindow);
293 * @brief Deletes the rendering surface
294 * @param[in] surface to delete
296 void DeleteSurface(Dali::RenderSurfaceInterface& surface);
299 * @brief Retrieve the window that the given actor is added to.
301 * @param[in] actor The actor
302 * @return The window the actor is added to or a null pointer if the actor is not added to any widnow.
304 Dali::Internal::Adaptor::SceneHolder* GetWindow(Dali::Actor& actor);
307 * @copydoc Dali::Adaptor::GetWindows()
309 Dali::WindowContainer GetWindows() const;
312 * @copydoc Dali::Adaptor::GetSceneHolders()
314 Dali::SceneHolderList GetSceneHolders() const;
317 * @copydoc Dali::Adaptor::GetObjectRegistry()
319 Dali::ObjectRegistry GetObjectRegistry() const;
323 * @return the Core instance
325 Dali::Integration::Core& GetCore() override;
328 * @copydoc Dali::Adaptor::SetRenderRefreshRate()
330 void SetRenderRefreshRate(unsigned int numberOfVSyncsPerRender);
333 * Return the PlatformAbstraction.
334 * @return The PlatformAbstraction.
336 Integration::PlatformAbstraction& GetPlatformAbstraction() const;
339 * Destroy the TtsPlayer of specific mode.
340 * @param[in] mode The mode of TtsPlayer to destroy
342 void DestroyTtsPlayer(Dali::TtsPlayer::Mode mode);
345 * Gets native window handle
347 * @return native window handle
349 Any GetNativeWindowHandle();
352 * @brief Retrieve native window handle that the given actor is added to.
354 * @param[in] actor The actor
355 * @return native window handle
357 Any GetNativeWindowHandle(Dali::Actor actor);
360 * Get the native display associated with the graphics backend
362 * @return A handle to the native display
364 Any GetGraphicsDisplay();
367 * Sets use remote surface for Surface output
368 * @param[in] useRemoteSurface True if the remote surface is used
370 void SetUseRemoteSurface(bool useRemoteSurface);
374 * Adds an adaptor observer so that we can observe the adaptor's lifetime events.
375 * @param[in] observer The observer.
376 * @note Observers should remove themselves when they are destroyed.
378 void AddObserver(LifeCycleObserver& observer);
381 * Removes the observer from the adaptor.
382 * @param[in] observer The observer to remove.
383 * @note Observers should remove themselves when they are destroyed.
385 void RemoveObserver(LifeCycleObserver& observer);
388 * Emits the Notification event to the Dali core.
390 void SendNotificationEvent();
393 * Request adaptor to update once
395 void RequestUpdateOnce();
398 * @copydoc Dali::Adaptor::NotifySceneCreated()
400 void NotifySceneCreated();
403 * @copydoc Dali::Adaptor::NotifyLanguageChanged()
405 void NotifyLanguageChanged();
408 * Gets AppId of current application
410 void GetAppId(std::string& appId);
413 * Gets path for resource storage.
414 * @param[out] path Path for resource storage
416 void GetResourceStoragePath(std::string& path);
419 * @copydoc Dali::Adaptor::SurfaceResizePrepare
421 void SurfaceResizePrepare(Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize);
424 * @copydoc Dali::Adaptor::SurfaceResizeComplete
426 void SurfaceResizeComplete(Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize);
429 * Sets layout direction of root by system language
430 * @param[in] locale System locale
432 void SetRootLayoutDirection(std::string locale);
435 * @copydoc Dali::Adaptor::RenderOnce
440 * @copydoc Dali::Adaptor::GetLogFactory
442 const LogFactoryInterface& GetLogFactory();
445 * @copydoc Dali::Adaptor::RegisterProcessor
447 void RegisterProcessor(Integration::Processor& processor, bool postProcessor);
450 * @coydoc Dali::Adaptor::UnregisterProcessor
452 void UnregisterProcessor(Integration::Processor& processor, bool postProcessor);
455 * Check MultipleWindow is supported
457 bool IsMultipleWindowSupported() const;
460 * @brief Gets the render thread id of DALi.
461 * @note If render thread id getter doesn't supported, it will return 0 as default.
462 * @return The render thread id.
464 int32_t GetRenderThreadId() const;
466 public: //AdaptorInternalServices
468 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPlatformAbstractionInterface()
470 Dali::Integration::PlatformAbstraction& GetPlatformAbstractionInterface() override;
473 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetDisplayConnectionInterface()
475 Dali::DisplayConnection& GetDisplayConnectionInterface() override;
478 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetGraphicsInterface()
480 GraphicsInterface& GetGraphicsInterface() override;
483 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventInterface()
485 TriggerEventInterface& GetProcessCoreEventsTrigger() override;
488 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSocketFactoryInterface()
490 SocketFactoryInterface& GetSocketFactoryInterface() override;
493 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetRenderSurfaceInterface()
495 Dali::RenderSurfaceInterface* GetRenderSurfaceInterface() override;
498 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPerformanceInterface()
500 PerformanceInterface* GetPerformanceInterface() override;
503 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetKernelTraceInterface()
505 TraceInterface& GetKernelTraceInterface() override;
508 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSystemTraceInterface()
510 TraceInterface& GetSystemTraceInterface() override;
513 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetWindowContainerInterface()
515 void GetWindowContainerInterface(WindowContainer& windows) override;
518 * @brief Get the configuration manager
519 * @return The configuration manager, or null if it hasn't been created yet
521 const ConfigurationManager* GetConfigurationManager() const
523 return mConfigurationManager.get();
528 * @copydoc Dali::Adaptor::SignalResized
530 AdaptorSignalType& ResizedSignal()
532 return mResizedSignal;
536 * @copydoc Dali::Adaptor::LanguageChangedSignal
538 AdaptorSignalType& LanguageChangedSignal()
540 return mLanguageChangedSignal;
544 * @copydoc Dali::Adaptor::WindowCreatedSignal
546 WindowCreatedSignalType& WindowCreatedSignal()
548 return mWindowCreatedSignal;
551 public: // From Dali::Internal::Adaptor::CoreEventInterface
553 * @copydoc Dali::Internal::Adaptor:CoreEventInterface:::ProcessCoreEvents()
555 void ProcessCoreEvents() override;
557 private: // From Dali::Internal::Adaptor::CoreEventInterface
559 * @copydoc Dali::Internal::Adaptor::CoreEventInterface::QueueCoreEvent()
561 void QueueCoreEvent(const Dali::Integration::Event& event) override;
563 private: // From Dali::Integration::RenderController
565 * @copydoc Dali::Integration::RenderController::RequestUpdate()
567 void RequestUpdate() override;
570 * @copydoc Dali::Integration::RenderController::RequestProcessEventsOnIdle()
572 void RequestProcessEventsOnIdle() override;
574 public: // From Dali::Internal::Adaptor::WindowVisibilityObserver
576 * Called when the window becomes fully or partially visible.
578 void OnWindowShown() override;
581 * Called when the window is fully hidden.
583 void OnWindowHidden() override;
585 private: // From Dali::Internal::Adaptor::DamageObserver
587 * @copydoc Dali::Internal::Adaptor::DamageObserver::OnDamaged()
589 void OnDamaged(const DamageArea& area) override;
593 Adaptor(const Adaptor&) = delete;
594 Adaptor& operator=(Adaptor&) = delete;
598 * Assigns the render surface to the adaptor
601 void SetSurface(Dali::RenderSurfaceInterface* surface);
604 * called after surface is created
606 void SurfaceInitialized();
609 * Sends an notification message from main loop idle handler
611 bool ProcessCoreEventsFromIdle();
614 * Gets path for data/resource storage.
615 * @param[out] path Path for data/resource storage
617 void GetDataStoragePath(std::string& path);
620 * Sets up system information if needs
622 void SetupSystemInformation();
625 * Adds a callback to be run when entering an idle state.
627 * A callback of the following type should be used:
631 * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
633 bool AddIdleEnterer(CallbackBase* callback, bool forceAdd);
636 * Removes a previously added the idle enterer callback.
638 void RemoveIdleEnterer(CallbackBase* callback);
641 * Trigger to log the memory pools from Core and Adaptor
643 bool MemoryPoolTimeout();
648 * @param[in] window window handle
649 * @param[in] adaptor The public adaptor
650 * @param[in] surface A render surface can be one of the following
651 * - Pixmap, adaptor will use existing Pixmap to draw on to
652 * - Window, adaptor will use existing Window to draw on to
653 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
654 * @param[in] threadMode The ThreadMode of the Adaptor
656 Adaptor(Dali::Integration::SceneHolder window, Dali::Adaptor& adaptor, Dali::RenderSurfaceInterface* surface, EnvironmentOptions* environmentOptions, ThreadMode threadMode);
661 READY, ///< Initial state before Adaptor::Start is called.
662 RUNNING, ///< Adaptor is running.
663 PAUSED, ///< Adaptor has been paused.
664 PAUSED_WHILE_HIDDEN, ///< Adaptor is paused while window is hidden (& cannot be resumed until window is shown).
665 PAUSED_WHILE_INITIALIZING, ///< Adaptor is paused while application is initializing.
666 STOPPED, ///< Adaptor has been stopped.
669 // There is no weak handle for BaseHandle in DALi, but we can't ref count the window here,
670 // so we have to store the raw pointer.
671 using WindowContainer = std::vector<Dali::Internal::Adaptor::SceneHolder*>;
672 using ObserverContainer = std::vector<LifeCycleObserver*>;
675 AdaptorSignalType mResizedSignal; ///< Resized signal.
676 AdaptorSignalType mLanguageChangedSignal; ///< Language changed signal.
677 WindowCreatedSignalType mWindowCreatedSignal; ///< Window created signal.
679 Dali::Adaptor& mAdaptor; ///< Reference to public adaptor instance.
680 State mState; ///< Current state of the adaptor
681 Dali::Integration::Core* mCore; ///< Dali Core
682 ThreadController* mThreadController; ///< Controls the threads
684 std::unique_ptr<GraphicsInterface> mGraphics; ///< Graphics interface
685 Dali::DisplayConnection* mDisplayConnection; ///< Display connection
686 WindowContainer mWindows; ///< A container of all the Windows that are currently created
688 std::unique_ptr<ConfigurationManager> mConfigurationManager; ///< Configuration manager
690 TizenPlatform::TizenPlatformAbstraction* mPlatformAbstraction; ///< Platform abstraction
692 std::unique_ptr<CallbackManager> mCallbackManager; ///< Used to install callbacks
693 bool mNotificationOnIdleInstalled; ///< whether the idle handler is installed to send an notification event
694 TriggerEventInterface* mNotificationTrigger; ///< Notification event trigger
695 FeedbackPluginProxy* mDaliFeedbackPlugin; ///< Used to access feedback support
696 FeedbackController* mFeedbackController; ///< Plays feedback effects for Dali-Toolkit UI Controls.
697 Dali::TtsPlayer mTtsPlayers[Dali::TtsPlayer::MODE_NUM]; ///< Provides TTS support
698 ObserverContainer mObservers; ///< A list of adaptor observer pointers
699 EnvironmentOptions* mEnvironmentOptions; ///< environment options
700 PerformanceInterface* mPerformanceInterface; ///< Performance interface
701 KernelTrace mKernelTracer; ///< Kernel tracer
702 SystemTrace mSystemTracer; ///< System tracer
703 ObjectProfiler* mObjectProfiler; ///< Tracks object lifetime for profiling
704 Dali::Timer mMemoryPoolTimer; ///< Logs memory pool capacity
705 SlotDelegate<Adaptor> mMemoryPoolTimerSlotDelegate;
706 SocketFactory mSocketFactory; ///< Socket factory
707 Mutex mMutex; ///< Mutex
708 ThreadMode mThreadMode; ///< The thread mode
709 const bool mEnvironmentOptionsOwned : 1; ///< Whether we own the EnvironmentOptions (and thus, need to delete it)
710 bool mUseRemoteSurface : 1; ///< whether the remoteSurface is used or not
711 Dali::LayoutDirection::Type mRootLayoutDirection; ///< LayoutDirection of window
713 std::unique_ptr<Integration::AddOnManager> mAddOnManager; ///< Pointer to the addon manager
715 class AccessibilityObserver : public ConnectionTracker
718 void OnAccessibleKeyEvent(const Dali::KeyEvent& event);
720 AccessibilityObserver mAccessibilityObserver;
723 inline static Adaptor& GetImplementation(Dali::Adaptor& adaptor)
725 return *adaptor.mImpl;
729 } // namespace Adaptor
731 } // namespace Internal
735 #endif // DALI_INTERNAL_ADAPTOR_IMPL_H