1 #ifndef DALI_INTERNAL_ADAPTOR_IMPL_H
2 #define DALI_INTERNAL_ADAPTOR_IMPL_H
5 * Copyright (c) 2021 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/common/vector-wrapper.h>
25 #include <dali/public-api/math/rect.h>
26 #include <dali/public-api/math/uint-16-pair.h>
27 #include <dali/public-api/signals/callback.h>
30 #include <dali/devel-api/adaptor-framework/clipboard.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();
176 static std::string GetApplicationPackageName();
178 public: // AdaptorInternalServices implementation
180 * @copydoc Dali::Adaptor::Start()
182 virtual void Start();
185 * @copydoc Dali::Adaptor::Pause()
187 virtual void Pause();
190 * @copydoc Dali::Adaptor::Resume()
192 virtual void Resume();
195 * @copydoc Dali::Adaptor::Stop()
200 * @copydoc Dali::Adaptor::ContextLost()
202 virtual void ContextLost();
205 * @copydoc Dali::Adaptor::ContextRegained()
207 virtual void ContextRegained();
210 * @copydoc Dali::EventFeeder::FeedTouchPoint()
212 virtual void FeedTouchPoint(TouchPoint& point, int timeStamp);
215 * @copydoc Dali::EventFeeder::FeedWheelEvent()
217 virtual void FeedWheelEvent(Dali::WheelEvent& wheelEvent);
220 * @copydoc Dali::EventFeeder::FeedKeyEvent()
222 virtual void FeedKeyEvent(Dali::KeyEvent& keyEvent);
225 * @copydoc Dali::Adaptor::ReplaceSurface()
227 virtual void ReplaceSurface(Dali::Integration::SceneHolder window, Dali::RenderSurfaceInterface& surface);
230 * @copydoc Dali::Adaptor::GetSurface()
232 virtual Dali::RenderSurfaceInterface& GetSurface() const;
235 * @copydoc Dali::Adaptor::ReleaseSurfaceLock()
237 virtual void ReleaseSurfaceLock();
240 * Retrieve the TtsPlayer.
241 * @param[in] mode The mode of TtsPlayer
242 * @return A handle to the TtsPlayer.
244 virtual Dali::TtsPlayer GetTtsPlayer(Dali::TtsPlayer::Mode mode);
247 * @copydoc Dali::Adaptor::AddIdle()
249 virtual bool AddIdle(CallbackBase* callback, bool hasReturnValue, bool forceAdd);
252 * Adds a new Window instance to the Adaptor
253 * @param[in] childWindow The child window instance
255 virtual bool AddWindow(Dali::Integration::SceneHolder childWindow);
258 * Removes an existing Window instance from the Adaptor
259 * @param[in] window The Window instance
261 virtual bool RemoveWindow(Dali::Integration::SceneHolder* childWindow);
264 * Removes an existing Window instance from the Adaptor
265 * @param[in] windowName The Window name
266 * @note If two Windows have the same name, the first one that matches will be removed
268 virtual bool RemoveWindow(std::string childWindowName);
271 * @copydoc Dali::Adaptor::RemoveIdle()
273 virtual void RemoveIdle(CallbackBase* callback);
276 * @copydoc Dali::Adaptor::ProcessIdle()
278 virtual void ProcessIdle();
281 * Sets a pre-render callback.
283 void SetPreRenderCallback(CallbackBase* callback);
286 * Removes an existing Window instance from the Adaptor
287 * @param[in] childWindow The Window instance
289 bool RemoveWindow(Dali::Internal::Adaptor::SceneHolder* childWindow);
292 * @brief Deletes the rendering surface
293 * @param[in] surface to delete
295 void DeleteSurface(Dali::RenderSurfaceInterface& surface);
298 * @brief Retrieve the window that the given actor is added to.
300 * @param[in] actor The actor
301 * @return The window the actor is added to or a null pointer if the actor is not added to any widnow.
303 Dali::Internal::Adaptor::SceneHolder* GetWindow(Dali::Actor& actor);
306 * @copydoc Dali::Adaptor::GetWindows()
308 Dali::WindowContainer GetWindows() const;
311 * @copydoc Dali::Adaptor::GetSceneHolders()
313 Dali::SceneHolderList GetSceneHolders() const;
316 * @copydoc Dali::Adaptor::GetObjectRegistry()
318 Dali::ObjectRegistry GetObjectRegistry() const;
322 * @return the Core instance
324 Dali::Integration::Core& GetCore() override;
327 * @copydoc Dali::Adaptor::SetRenderRefreshRate()
329 void SetRenderRefreshRate(unsigned int numberOfVSyncsPerRender);
332 * Return the PlatformAbstraction.
333 * @return The PlatformAbstraction.
335 Integration::PlatformAbstraction& GetPlatformAbstraction() const;
338 * Destroy the TtsPlayer of specific mode.
339 * @param[in] mode The mode of TtsPlayer to destroy
341 void DestroyTtsPlayer(Dali::TtsPlayer::Mode mode);
344 * Gets native window handle
346 * @return native window handle
348 Any GetNativeWindowHandle();
351 * @brief Retrieve native window handle that the given actor is added to.
353 * @param[in] actor The actor
354 * @return native window handle
356 Any GetNativeWindowHandle(Dali::Actor actor);
359 * Get the native display associated with the graphics backend
361 * @return A handle to the native display
363 Any GetGraphicsDisplay();
366 * Sets use remote surface for Surface output
367 * @param[in] useRemoteSurface True if the remote surface is used
369 void SetUseRemoteSurface(bool useRemoteSurface);
373 * Adds an adaptor observer so that we can observe the adaptor's lifetime events.
374 * @param[in] observer The observer.
375 * @note Observers should remove themselves when they are destroyed.
377 void AddObserver(LifeCycleObserver& observer);
380 * Removes the observer from the adaptor.
381 * @param[in] observer The observer to remove.
382 * @note Observers should remove themselves when they are destroyed.
384 void RemoveObserver(LifeCycleObserver& observer);
387 * Emits the Notification event to the Dali core.
389 void SendNotificationEvent();
392 * Request adaptor to update once
394 void RequestUpdateOnce();
397 * @copydoc Dali::Adaptor::NotifySceneCreated()
399 void NotifySceneCreated();
402 * @copydoc Dali::Adaptor::NotifyLanguageChanged()
404 void NotifyLanguageChanged();
407 * Gets AppId of current application
409 void GetAppId(std::string& appId);
412 * Gets path for resource storage.
413 * @param[out] path Path for resource storage
415 void GetResourceStoragePath(std::string& path);
418 * @copydoc Dali::Adaptor::SurfaceResizePrepare
420 void SurfaceResizePrepare(Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize);
423 * @copydoc Dali::Adaptor::SurfaceResizeComplete
425 void SurfaceResizeComplete(Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize);
428 * Sets layout direction of root by system language
429 * @param[in] locale System locale
431 void SetRootLayoutDirection(std::string locale);
434 * @copydoc Dali::Adaptor::RenderOnce
439 * @copydoc Dali::Adaptor::GetLogFactory
441 const LogFactoryInterface& GetLogFactory();
444 * @copydoc Dali::Adaptor::RegisterProcessor
446 void RegisterProcessor(Integration::Processor& processor, bool postProcessor);
449 * @coydoc Dali::Adaptor::UnregisterProcessor
451 void UnregisterProcessor(Integration::Processor& processor, bool postProcessor);
454 * Check MultipleWindow is supported
456 bool IsMultipleWindowSupported() const;
458 public: //AdaptorInternalServices
460 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPlatformAbstractionInterface()
462 Dali::Integration::PlatformAbstraction& GetPlatformAbstractionInterface() override;
465 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetDisplayConnectionInterface()
467 Dali::DisplayConnection& GetDisplayConnectionInterface() override;
470 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetGraphicsInterface()
472 GraphicsInterface& GetGraphicsInterface() override;
475 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventInterface()
477 TriggerEventInterface& GetProcessCoreEventsTrigger() override;
480 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSocketFactoryInterface()
482 SocketFactoryInterface& GetSocketFactoryInterface() override;
485 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetRenderSurfaceInterface()
487 Dali::RenderSurfaceInterface* GetRenderSurfaceInterface() override;
490 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPerformanceInterface()
492 PerformanceInterface* GetPerformanceInterface() override;
495 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetKernelTraceInterface()
497 TraceInterface& GetKernelTraceInterface() override;
500 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSystemTraceInterface()
502 TraceInterface& GetSystemTraceInterface() override;
505 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetWindowContainerInterface()
507 void GetWindowContainerInterface(WindowContainer& windows) override;
511 * @copydoc Dali::Adaptor::SignalResized
513 AdaptorSignalType& ResizedSignal()
515 return mResizedSignal;
519 * @copydoc Dali::Adaptor::LanguageChangedSignal
521 AdaptorSignalType& LanguageChangedSignal()
523 return mLanguageChangedSignal;
527 * @copydoc Dali::Adaptor::WindowCreatedSignal
529 WindowCreatedSignalType& WindowCreatedSignal()
531 return mWindowCreatedSignal;
534 public: // From Dali::Internal::Adaptor::CoreEventInterface
536 * @copydoc Dali::Internal::Adaptor:CoreEventInterface:::ProcessCoreEvents()
538 void ProcessCoreEvents() override;
540 private: // From Dali::Internal::Adaptor::CoreEventInterface
542 * @copydoc Dali::Internal::Adaptor::CoreEventInterface::QueueCoreEvent()
544 void QueueCoreEvent(const Dali::Integration::Event& event) override;
546 private: // From Dali::Integration::RenderController
548 * @copydoc Dali::Integration::RenderController::RequestUpdate()
550 void RequestUpdate(bool forceUpdate) override;
553 * @copydoc Dali::Integration::RenderController::RequestProcessEventsOnIdle()
555 void RequestProcessEventsOnIdle(bool forceProcess) override;
557 public: // From Dali::Internal::Adaptor::WindowVisibilityObserver
559 * Called when the window becomes fully or partially visible.
561 void OnWindowShown() override;
564 * Called when the window is fully hidden.
566 void OnWindowHidden() override;
568 private: // From Dali::Internal::Adaptor::DamageObserver
570 * @copydoc Dali::Internal::Adaptor::DamageObserver::OnDamaged()
572 void OnDamaged(const DamageArea& area) override;
576 Adaptor(const Adaptor&) = delete;
577 Adaptor& operator=(Adaptor&) = delete;
581 * Assigns the render surface to the adaptor
584 void SetSurface(Dali::RenderSurfaceInterface* surface);
587 * called after surface is created
589 void SurfaceInitialized();
592 * Sends an notification message from main loop idle handler
594 bool ProcessCoreEventsFromIdle();
597 * Gets path for data/resource storage.
598 * @param[out] path Path for data/resource storage
600 void GetDataStoragePath(std::string& path);
603 * Sets up system information if needs
605 void SetupSystemInformation();
608 * Adds a callback to be run when entering an idle state.
610 * A callback of the following type should be used:
614 * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
616 bool AddIdleEnterer(CallbackBase* callback, bool forceAdd);
619 * Removes a previously added the idle enterer callback.
621 void RemoveIdleEnterer(CallbackBase* callback);
626 * @param[in] window window handle
627 * @param[in] adaptor The public adaptor
628 * @param[in] surface A render surface can be one of the following
629 * - Pixmap, adaptor will use existing Pixmap to draw on to
630 * - Window, adaptor will use existing Window to draw on to
631 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
632 * @param[in] threadMode The ThreadMode of the Adaptor
634 Adaptor(Dali::Integration::SceneHolder window, Dali::Adaptor& adaptor, Dali::RenderSurfaceInterface* surface, EnvironmentOptions* environmentOptions, ThreadMode threadMode);
639 READY, ///< Initial state before Adaptor::Start is called.
640 RUNNING, ///< Adaptor is running.
641 PAUSED, ///< Adaptor has been paused.
642 PAUSED_WHILE_HIDDEN, ///< Adaptor is paused while window is hidden (& cannot be resumed until window is shown).
643 PAUSED_WHILE_INITIALIZING, ///< Adaptor is paused while application is initializing.
644 STOPPED, ///< Adaptor has been stopped.
647 // There is no weak handle for BaseHandle in DALi, but we can't ref count the window here,
648 // so we have to store the raw pointer.
649 using WindowContainer = std::vector<Dali::Internal::Adaptor::SceneHolder*>;
650 using ObserverContainer = std::vector<LifeCycleObserver*>;
653 AdaptorSignalType mResizedSignal; ///< Resized signal.
654 AdaptorSignalType mLanguageChangedSignal; ///< Language changed signal.
655 WindowCreatedSignalType mWindowCreatedSignal; ///< Window created signal.
657 Dali::Adaptor& mAdaptor; ///< Reference to public adaptor instance.
658 State mState; ///< Current state of the adaptor
659 Dali::Integration::Core* mCore; ///< Dali Core
660 ThreadController* mThreadController; ///< Controls the threads
662 std::unique_ptr<GraphicsInterface> mGraphics; ///< Graphics interface
663 Dali::DisplayConnection* mDisplayConnection; ///< Display connection
664 WindowContainer mWindows; ///< A container of all the Windows that are currently created
666 std::unique_ptr<ConfigurationManager> mConfigurationManager; ///< Configuration manager
668 TizenPlatform::TizenPlatformAbstraction* mPlatformAbstraction; ///< Platform abstraction
670 CallbackManager* mCallbackManager; ///< Used to install callbacks
671 bool mNotificationOnIdleInstalled; ///< whether the idle handler is installed to send an notification event
672 TriggerEventInterface* mNotificationTrigger; ///< Notification event trigger
673 FeedbackPluginProxy* mDaliFeedbackPlugin; ///< Used to access feedback support
674 FeedbackController* mFeedbackController; ///< Plays feedback effects for Dali-Toolkit UI Controls.
675 Dali::TtsPlayer mTtsPlayers[Dali::TtsPlayer::MODE_NUM]; ///< Provides TTS support
676 ObserverContainer mObservers; ///< A list of adaptor observer pointers
677 EnvironmentOptions* mEnvironmentOptions; ///< environment options
678 PerformanceInterface* mPerformanceInterface; ///< Performance interface
679 KernelTrace mKernelTracer; ///< Kernel tracer
680 SystemTrace mSystemTracer; ///< System tracer
681 ObjectProfiler* mObjectProfiler; ///< Tracks object lifetime for profiling
682 SocketFactory mSocketFactory; ///< Socket factory
683 Mutex mMutex; ///< Mutex
684 ThreadMode mThreadMode; ///< The thread mode
685 const bool mEnvironmentOptionsOwned : 1; ///< Whether we own the EnvironmentOptions (and thus, need to delete it)
686 bool mUseRemoteSurface : 1; ///< whether the remoteSurface is used or not
687 Dali::LayoutDirection::Type mRootLayoutDirection; ///< LayoutDirection of window
689 std::unique_ptr<Integration::AddOnManager> mAddOnManager; ///< Pointer to the addon manager
691 class AccessibilityObserver : public ConnectionTracker
694 void OnAccessibleKeyEvent(const Dali::KeyEvent& event);
696 AccessibilityObserver mAccessibilityObserver;
699 inline static Adaptor& GetImplementation(Dali::Adaptor& adaptor)
701 return *adaptor.mImpl;
705 } // namespace Adaptor
707 } // namespace Internal
711 #endif // DALI_INTERNAL_ADAPTOR_IMPL_H