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;
100 using SurfaceSize = Uint16Pair; ///< Surface size type
103 * Creates a New Adaptor
104 * @param[in] window The window handle
105 * @param[in] surface A render surface can be one of the following
106 * - Pixmap, adaptor will use existing Pixmap to draw on to
107 * - Window, adaptor will use existing Window to draw on to
108 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
109 * @param[in] threadMode The thread mode
111 static Dali::Adaptor* New(Dali::Integration::SceneHolder window,
112 Dali::RenderSurfaceInterface* surface,
113 EnvironmentOptions* environmentOptions,
114 ThreadMode threadMode);
117 * Creates a New Adaptor
118 * @param[in] window The window handle
119 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
121 static Dali::Adaptor* New(Dali::Integration::SceneHolder window,
122 EnvironmentOptions* environmentOptions);
125 * Creates a New Adaptor
126 * @param[in] graphicsFactory A factory that creates the graphics interface
127 * @param[in] window The window handle
128 * @param[in] surface A render surface can be one of the following
129 * - Pixmap, adaptor will use existing Pixmap to draw on to
130 * - Window, adaptor will use existing Window to draw on to
131 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
132 * @param[in] threadMode The thread mode
134 static Dali::Adaptor* New(GraphicsFactory& graphicsFactory,
135 Dali::Integration::SceneHolder window,
136 Dali::RenderSurfaceInterface* surface,
137 EnvironmentOptions* environmentOptions,
138 ThreadMode threadMode);
141 * Creates a New Adaptor
142 * @param[in] graphicsFactory A factory that creates the graphics interface
143 * @param[in] window The window handle
144 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
146 static Dali::Adaptor* New(GraphicsFactory& graphicsFactory,
147 Dali::Integration::SceneHolder window,
148 EnvironmentOptions* environmentOptions);
151 * 2-step initialisation, this should be called after creating an adaptor instance.
152 * @param[in] graphicsFactory A factory that creates the graphics interface
154 void Initialize(GraphicsFactory& graphicsFactory);
157 * Virtual destructor.
162 * @copydoc Dali::Adaptor::Get()
164 static Dali::Adaptor& Get();
167 * @copydoc Dali::Adaptor::IsAvailable()
169 static bool IsAvailable();
172 * @copydoc Dali::Core::SceneCreated();
177 * Get the application package name
179 static std::string GetApplicationPackageName();
181 public: // AdaptorInternalServices implementation
183 * @copydoc Dali::Adaptor::Start()
185 virtual void Start();
188 * @copydoc Dali::Adaptor::Pause()
190 virtual void Pause();
193 * @copydoc Dali::Adaptor::Resume()
195 virtual void Resume();
198 * @copydoc Dali::Adaptor::Stop()
203 * @copydoc Dali::Adaptor::ContextLost()
205 virtual void ContextLost();
208 * @copydoc Dali::Adaptor::ContextRegained()
210 virtual void ContextRegained();
213 * @copydoc Dali::EventFeeder::FeedTouchPoint()
215 virtual void FeedTouchPoint(TouchPoint& point, int timeStamp);
218 * @copydoc Dali::EventFeeder::FeedWheelEvent()
220 virtual void FeedWheelEvent(Dali::WheelEvent& wheelEvent);
223 * @copydoc Dali::EventFeeder::FeedKeyEvent()
225 virtual void FeedKeyEvent(Dali::KeyEvent& keyEvent);
228 * @copydoc Dali::Adaptor::ReplaceSurface()
230 virtual void ReplaceSurface(Dali::Integration::SceneHolder window, Dali::RenderSurfaceInterface& surface);
233 * @copydoc Dali::Adaptor::GetSurface()
235 virtual Dali::RenderSurfaceInterface& GetSurface() const;
238 * @copydoc Dali::Adaptor::ReleaseSurfaceLock()
240 virtual void ReleaseSurfaceLock();
243 * Retrieve the TtsPlayer.
244 * @param[in] mode The mode of TtsPlayer
245 * @return A handle to the TtsPlayer.
247 virtual Dali::TtsPlayer GetTtsPlayer(Dali::TtsPlayer::Mode mode);
250 * @copydoc Dali::Adaptor::AddIdle()
252 virtual bool AddIdle(CallbackBase* callback, bool hasReturnValue);
255 * Adds a new Window instance to the Adaptor
256 * @param[in] childWindow The child window instance
258 virtual bool AddWindow(Dali::Integration::SceneHolder childWindow);
261 * Removes an existing Window instance from the Adaptor
262 * @param[in] window The Window instance
264 virtual bool RemoveWindow(Dali::Integration::SceneHolder* childWindow);
267 * Removes an existing Window instance from the Adaptor
268 * @param[in] windowName The Window name
269 * @note If two Windows have the same name, the first one that matches will be removed
271 virtual bool RemoveWindow(std::string childWindowName);
274 * @copydoc Dali::Adaptor::RemoveIdle()
276 virtual void RemoveIdle(CallbackBase* callback);
279 * @copydoc Dali::Adaptor::ProcessIdle()
281 virtual void ProcessIdle();
284 * Sets a pre-render callback.
286 void SetPreRenderCallback(CallbackBase* callback);
289 * Removes an existing Window instance from the Adaptor
290 * @param[in] childWindow The Window instance
292 bool RemoveWindow(Dali::Internal::Adaptor::SceneHolder* childWindow);
295 * @brief Deletes the rendering surface
296 * @param[in] surface to delete
298 void DeleteSurface(Dali::RenderSurfaceInterface& surface);
301 * @brief Retrieve the window that the given actor is added to.
303 * @param[in] actor The actor
304 * @return The window the actor is added to or a null pointer if the actor is not added to any widnow.
306 Dali::Internal::Adaptor::SceneHolder* GetWindow(Dali::Actor& actor);
309 * @copydoc Dali::Adaptor::GetWindows()
311 Dali::WindowContainer GetWindows() const;
314 * @copydoc Dali::Adaptor::GetSceneHolders()
316 Dali::SceneHolderList GetSceneHolders() const;
319 * @copydoc Dali::Adaptor::GetObjectRegistry()
321 Dali::ObjectRegistry GetObjectRegistry() const;
325 * @return the Core instance
327 Dali::Integration::Core& GetCore() override;
330 * @copydoc Dali::Adaptor::SetRenderRefreshRate()
332 void SetRenderRefreshRate(unsigned int numberOfVSyncsPerRender);
335 * Return the PlatformAbstraction.
336 * @return The PlatformAbstraction.
338 Integration::PlatformAbstraction& GetPlatformAbstraction() const;
341 * Destroy the TtsPlayer of specific mode.
342 * @param[in] mode The mode of TtsPlayer to destroy
344 void DestroyTtsPlayer(Dali::TtsPlayer::Mode mode);
347 * Gets native window handle
349 * @return native window handle
351 Any GetNativeWindowHandle();
354 * @brief Retrieve native window handle that the given actor is added to.
356 * @param[in] actor The actor
357 * @return native window handle
359 Any GetNativeWindowHandle(Dali::Actor actor);
362 * Get the native display associated with the graphics backend
364 * @return A handle to the native display
366 Any GetGraphicsDisplay();
369 * Sets use remote surface for Surface output
370 * @param[in] useRemoteSurface True if the remote surface is used
372 void SetUseRemoteSurface(bool useRemoteSurface);
376 * Adds an adaptor observer so that we can observe the adaptor's lifetime events.
377 * @param[in] observer The observer.
378 * @note Observers should remove themselves when they are destroyed.
380 void AddObserver(LifeCycleObserver& observer);
383 * Removes the observer from the adaptor.
384 * @param[in] observer The observer to remove.
385 * @note Observers should remove themselves when they are destroyed.
387 void RemoveObserver(LifeCycleObserver& observer);
390 * Emits the Notification event to the Dali core.
392 void SendNotificationEvent();
395 * Request adaptor to update once
397 void RequestUpdateOnce();
400 * @copydoc Dali::Adaptor::NotifySceneCreated()
402 void NotifySceneCreated();
405 * @copydoc Dali::Adaptor::NotifyLanguageChanged()
407 void NotifyLanguageChanged();
410 * Gets AppId of current application
412 void GetAppId(std::string& appId);
415 * Gets path for resource storage.
416 * @param[out] path Path for resource storage
418 void GetResourceStoragePath(std::string& path);
421 * @copydoc Dali::Adaptor::SurfaceResizePrepare
423 void SurfaceResizePrepare(Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize);
426 * @copydoc Dali::Adaptor::SurfaceResizeComplete
428 void SurfaceResizeComplete(Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize);
431 * @brief Increase surface resize completed counter.
432 * This API will be ignored if thread controller is not exist.
434 void IncreaseSurfaceResizeCounter();
437 * Sets layout direction of root by system language
438 * @param[in] locale System locale
440 void SetRootLayoutDirection(std::string locale);
443 * @copydoc Dali::Adaptor::RenderOnce
448 * @copydoc Dali::Adaptor::GetLogFactory
450 const LogFactoryInterface& GetLogFactory();
453 * @copydoc Dali::Adaptor::GetTraceFactory
455 const TraceFactoryInterface& GetTraceFactory();
458 * @copydoc Dali::Adaptor::RegisterProcessor
460 void RegisterProcessor(Integration::Processor& processor, bool postProcessor);
463 * @coydoc Dali::Adaptor::UnregisterProcessor
465 void UnregisterProcessor(Integration::Processor& processor, bool postProcessor);
468 * Check MultipleWindow is supported
470 bool IsMultipleWindowSupported() const;
473 * @brief Gets the render thread id of DALi.
474 * @note If render thread id getter doesn't supported, it will return 0 as default.
475 * @return The render thread id.
477 int32_t GetRenderThreadId() const;
479 public: //AdaptorInternalServices
481 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPlatformAbstractionInterface()
483 Dali::Integration::PlatformAbstraction& GetPlatformAbstractionInterface() override;
486 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetDisplayConnectionInterface()
488 Dali::DisplayConnection& GetDisplayConnectionInterface() override;
491 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetGraphicsInterface()
493 GraphicsInterface& GetGraphicsInterface() override;
496 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventInterface()
498 TriggerEventInterface& GetProcessCoreEventsTrigger() override;
501 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSocketFactoryInterface()
503 SocketFactoryInterface& GetSocketFactoryInterface() override;
506 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetRenderSurfaceInterface()
508 Dali::RenderSurfaceInterface* GetRenderSurfaceInterface() override;
511 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPerformanceInterface()
513 PerformanceInterface* GetPerformanceInterface() override;
516 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetKernelTraceInterface()
518 TraceInterface& GetKernelTraceInterface() override;
521 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSystemTraceInterface()
523 TraceInterface& GetSystemTraceInterface() override;
526 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetWindowContainerInterface()
528 void GetWindowContainerInterface(WindowContainer& windows) override;
531 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTextureUploadManager()
533 Devel::TextureUploadManager& GetTextureUploadManager() override;
536 * @brief Get the configuration manager
537 * @return The configuration manager, or null if it hasn't been created yet
539 const ConfigurationManager* GetConfigurationManager() const
541 return mConfigurationManager.get();
546 * @copydoc Dali::Adaptor::SignalResized
548 AdaptorSignalType& ResizedSignal()
550 return mResizedSignal;
554 * @copydoc Dali::Adaptor::LanguageChangedSignal
556 AdaptorSignalType& LanguageChangedSignal()
558 return mLanguageChangedSignal;
562 * @copydoc Dali::Adaptor::WindowCreatedSignal
564 WindowCreatedSignalType& WindowCreatedSignal()
566 return mWindowCreatedSignal;
569 public: // From Dali::Internal::Adaptor::CoreEventInterface
571 * @copydoc Dali::Internal::Adaptor::CoreEventInterface:::FlushUpdateMessages()
573 void FlushUpdateMessages() override;
576 * @copydoc Dali::Internal::Adaptor::CoreEventInterface:::ProcessCoreEvents()
578 void ProcessCoreEvents() override;
580 private: // From Dali::Internal::Adaptor::CoreEventInterface
582 * @copydoc Dali::Internal::Adaptor::CoreEventInterface::QueueCoreEvent()
584 void QueueCoreEvent(const Dali::Integration::Event& event) override;
586 public: // From Dali::Integration::RenderController
588 * @copydoc Dali::Integration::RenderController::RequestUpdate()
590 void RequestUpdate() override;
593 * @copydoc Dali::Integration::RenderController::RequestProcessEventsOnIdle()
595 void RequestProcessEventsOnIdle() override;
597 public: // From Dali::Internal::Adaptor::WindowVisibilityObserver
599 * Called when the window becomes fully or partially visible.
601 void OnWindowShown() override;
604 * Called when the window is fully hidden.
606 void OnWindowHidden() override;
608 private: // From Dali::Internal::Adaptor::DamageObserver
610 * @copydoc Dali::Internal::Adaptor::DamageObserver::OnDamaged()
612 void OnDamaged(const DamageArea& area) override;
616 Adaptor(const Adaptor&) = delete;
617 Adaptor& operator=(Adaptor&) = delete;
621 * Assigns the render surface to the adaptor
624 void SetSurface(Dali::RenderSurfaceInterface* surface);
627 * called after surface is created
629 void SurfaceInitialized();
632 * Sends an notification message from main loop idle handler
634 bool ProcessCoreEventsFromIdle();
637 * Gets path for data/resource storage.
638 * @param[out] path Path for data/resource storage
640 void GetDataStoragePath(std::string& path);
643 * Sets up system information if needs
645 void SetupSystemInformation();
648 * Remove system information if needs
650 void RemoveSystemInformation();
653 * Adds a callback to be run when entering an idle state.
655 * A callback of the following type should be used:
659 * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
661 bool AddIdleEnterer(CallbackBase* callback);
664 * Removes a previously added the idle enterer callback.
666 void RemoveIdleEnterer(CallbackBase* callback);
669 * Trigger to log the memory pools from Core and Adaptor
671 bool MemoryPoolTimeout();
676 * @param[in] window window handle
677 * @param[in] adaptor The public adaptor
678 * @param[in] surface A render surface can be one of the following
679 * - Pixmap, adaptor will use existing Pixmap to draw on to
680 * - Window, adaptor will use existing Window to draw on to
681 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
682 * @param[in] threadMode The ThreadMode of the Adaptor
684 Adaptor(Dali::Integration::SceneHolder window, Dali::Adaptor& adaptor, Dali::RenderSurfaceInterface* surface, EnvironmentOptions* environmentOptions, ThreadMode threadMode);
689 READY, ///< Initial state before Adaptor::Start is called.
690 RUNNING, ///< Adaptor is running.
691 PAUSED, ///< Adaptor has been paused.
692 PAUSED_WHILE_HIDDEN, ///< Adaptor is paused while window is hidden (& cannot be resumed until window is shown).
693 PAUSED_WHILE_INITIALIZING, ///< Adaptor is paused while application is initializing.
694 STOPPED, ///< Adaptor has been stopped.
697 // There is no weak handle for BaseHandle in DALi, but we can't ref count the window here,
698 // so we have to store the raw pointer.
699 using WindowContainer = std::vector<Dali::Internal::Adaptor::SceneHolder*>;
700 using ObserverContainer = std::vector<LifeCycleObserver*>;
703 AdaptorSignalType mResizedSignal; ///< Resized signal.
704 AdaptorSignalType mLanguageChangedSignal; ///< Language changed signal.
705 WindowCreatedSignalType mWindowCreatedSignal; ///< Window created signal.
707 Dali::Adaptor& mAdaptor; ///< Reference to public adaptor instance.
708 State mState; ///< Current state of the adaptor
709 Dali::Integration::Core* mCore; ///< Dali Core
710 ThreadController* mThreadController; ///< Controls the threads
712 std::unique_ptr<GraphicsInterface> mGraphics; ///< Graphics interface
713 Dali::DisplayConnection* mDisplayConnection; ///< Display connection
714 WindowContainer mWindows; ///< A container of all the Windows that are currently created
716 std::unique_ptr<ConfigurationManager> mConfigurationManager; ///< Configuration manager
718 TizenPlatform::TizenPlatformAbstraction* mPlatformAbstraction; ///< Platform abstraction
720 std::unique_ptr<CallbackManager> mCallbackManager; ///< Used to install callbacks
721 bool mNotificationOnIdleInstalled; ///< whether the idle handler is installed to send an notification event
722 bool mRequiredIdleRepeat; ///< whether we need to repeat installed notification event in idle handler
723 TriggerEventInterface* mNotificationTrigger; ///< Notification event trigger
724 FeedbackPluginProxy* mDaliFeedbackPlugin; ///< Used to access feedback support
725 FeedbackController* mFeedbackController; ///< Plays feedback effects for Dali-Toolkit UI Controls.
726 Dali::TtsPlayer mTtsPlayers[Dali::TtsPlayer::MODE_NUM]; ///< Provides TTS support
727 ObserverContainer mObservers; ///< A list of adaptor observer pointers
728 EnvironmentOptions* mEnvironmentOptions; ///< environment options
729 PerformanceInterface* mPerformanceInterface; ///< Performance interface
730 KernelTrace mKernelTracer; ///< Kernel tracer
731 SystemTrace mSystemTracer; ///< System tracer
732 Devel::TextureUploadManager mTextureUploadManager; ///< TextureUploadManager
733 ObjectProfiler* mObjectProfiler; ///< Tracks object lifetime for profiling
734 Dali::Timer mMemoryPoolTimer; ///< Logs memory pool capacity
735 SlotDelegate<Adaptor> mMemoryPoolTimerSlotDelegate;
736 SocketFactory mSocketFactory; ///< Socket factory
737 Mutex mMutex; ///< Mutex
738 ThreadMode mThreadMode; ///< The thread mode
739 const bool mEnvironmentOptionsOwned : 1; ///< Whether we own the EnvironmentOptions (and thus, need to delete it)
740 bool mUseRemoteSurface : 1; ///< whether the remoteSurface is used or not
741 Dali::LayoutDirection::Type mRootLayoutDirection; ///< LayoutDirection of window
743 std::unique_ptr<Integration::AddOnManager> mAddOnManager; ///< Pointer to the addon manager
745 class AccessibilityObserver : public ConnectionTracker
748 void OnAccessibleKeyEvent(const Dali::KeyEvent& event);
750 AccessibilityObserver mAccessibilityObserver;
753 inline static Adaptor& GetImplementation(Dali::Adaptor& adaptor)
755 return *adaptor.mImpl;
759 } // namespace Adaptor
761 } // namespace Internal
765 #endif // DALI_INTERNAL_ADAPTOR_IMPL_H