1 #ifndef DALI_INTERNAL_ADAPTOR_IMPL_H
2 #define DALI_INTERNAL_ADAPTOR_IMPL_H
5 * Copyright (c) 2020 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/public-api/common/vector-wrapper.h>
23 #include <dali/public-api/math/rect.h>
24 #include <dali/public-api/signals/callback.h>
25 #include <dali/public-api/math/uint-16-pair.h>
26 #include <dali/integration-api/render-controller.h>
29 #include <dali/public-api/adaptor-framework/tts-player.h>
30 #include <dali/devel-api/adaptor-framework/clipboard.h>
31 #include <dali/integration-api/scene.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/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>
49 class RenderSurfaceInterface;
64 class DisplayConnection;
65 class GraphicsFactory;
66 class GlImplementation;
67 class GlSyncImplementation;
68 class ThreadController;
70 class CallbackManager;
71 class FeedbackPluginProxy;
72 class FeedbackController;
74 class PerformanceInterface;
75 class LifeCycleObserver;
78 class ConfigurationManager;
79 enum class ThreadMode;
82 * Implementation of the Adaptor class.
84 class Adaptor : public Integration::RenderController,
85 public AdaptorInternalServices,
86 public CoreEventInterface,
87 public DamageObserver,
88 public WindowVisibilityObserver
92 using AdaptorSignalType = Dali::Adaptor::AdaptorSignalType;
93 using WindowCreatedSignalType = Dali::Adaptor::WindowCreatedSignalType;
95 using SurfaceSize = Uint16Pair; ///< Surface size type
98 * Creates a New Adaptor
99 * @param[in] window The window handle
100 * @param[in] surface A render surface can be one of the following
101 * - Pixmap, adaptor will use existing Pixmap to draw on to
102 * - Window, adaptor will use existing Window to draw on to
103 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
104 * @param[in] threadMode The thread mode
106 static Dali::Adaptor* New( Dali::Integration::SceneHolder window,
107 Dali::RenderSurfaceInterface* surface,
108 EnvironmentOptions* environmentOptions,
109 ThreadMode threadMode );
112 * Creates a New Adaptor
113 * @param[in] window The window handle
114 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
116 static Dali::Adaptor* New( Dali::Integration::SceneHolder window,
117 EnvironmentOptions* environmentOptions );
120 * Creates a New Adaptor
121 * @param[in] graphicsFactory A factory that creates the graphics interface
122 * @param[in] window The window handle
123 * @param[in] surface A render surface can be one of the following
124 * - Pixmap, adaptor will use existing Pixmap to draw on to
125 * - Window, adaptor will use existing Window to draw on to
126 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
127 * @param[in] threadMode The thread mode
129 static Dali::Adaptor* New( GraphicsFactory& graphicsFactory,
130 Dali::Integration::SceneHolder window,
131 Dali::RenderSurfaceInterface* surface,
132 EnvironmentOptions* environmentOptions,
133 ThreadMode threadMode );
136 * Creates a New Adaptor
137 * @param[in] graphicsFactory A factory that creates the graphics interface
138 * @param[in] window The window handle
139 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
141 static Dali::Adaptor* New( GraphicsFactory& graphicsFactory,
142 Dali::Integration::SceneHolder window,
143 EnvironmentOptions* environmentOptions );
146 * 2-step initialisation, this should be called after creating an adaptor instance.
147 * @param[in] graphicsFactory A factory that creates the graphics interface
149 void Initialize( GraphicsFactory& graphicsFactory );
152 * Virtual destructor.
157 * @copydoc Dali::Adaptor::Get()
159 static Dali::Adaptor& Get();
162 * @copydoc Dali::Adaptor::IsAvailable()
164 static bool IsAvailable();
167 * @copydoc Dali::Core::SceneCreated();
171 public: // AdaptorInternalServices implementation
173 * @copydoc Dali::Adaptor::Start()
175 virtual void Start();
178 * @copydoc Dali::Adaptor::Pause()
180 virtual void Pause();
183 * @copydoc Dali::Adaptor::Resume()
185 virtual void Resume();
188 * @copydoc Dali::Adaptor::Stop()
193 * @copydoc Dali::Adaptor::ContextLost()
195 virtual void ContextLost();
198 * @copydoc Dali::Adaptor::ContextRegained()
200 virtual void ContextRegained();
203 * @copydoc Dali::EventFeeder::FeedTouchPoint()
205 virtual void FeedTouchPoint( TouchPoint& point, int timeStamp );
208 * @copydoc Dali::EventFeeder::FeedWheelEvent()
210 virtual void FeedWheelEvent( Dali::WheelEvent& wheelEvent );
213 * @copydoc Dali::EventFeeder::FeedKeyEvent()
215 virtual void FeedKeyEvent( Dali::KeyEvent& keyEvent );
218 * @copydoc Dali::Adaptor::ReplaceSurface()
220 virtual void ReplaceSurface( Dali::Integration::SceneHolder window, Dali::RenderSurfaceInterface& surface );
223 * @copydoc Dali::Adaptor::GetSurface()
225 virtual Dali::RenderSurfaceInterface& GetSurface() const;
228 * @copydoc Dali::Adaptor::ReleaseSurfaceLock()
230 virtual void ReleaseSurfaceLock();
233 * Retrieve the TtsPlayer.
234 * @param[in] mode The mode of TtsPlayer
235 * @return A handle to the TtsPlayer.
237 virtual Dali::TtsPlayer GetTtsPlayer(Dali::TtsPlayer::Mode mode);
240 * @copydoc Dali::Adaptor::AddIdle()
242 virtual bool AddIdle( CallbackBase* callback, bool hasReturnValue, bool forceAdd );
245 * Adds a new Window instance to the Adaptor
246 * @param[in] childWindow The child window instance
248 virtual bool AddWindow( Dali::Integration::SceneHolder childWindow );
251 * Removes an existing Window instance from the Adaptor
252 * @param[in] window The Window instance
254 virtual bool RemoveWindow( Dali::Integration::SceneHolder* childWindow );
257 * Removes an existing Window instance from the Adaptor
258 * @param[in] windowName The Window name
259 * @note If two Windows have the same name, the first one that matches will be removed
261 virtual bool RemoveWindow( std::string childWindowName );
264 * @copydoc Dali::Adaptor::RemoveIdle()
266 virtual void RemoveIdle( CallbackBase* callback );
269 * @copydoc Dali::Adaptor::ProcessIdle()
271 virtual void ProcessIdle();
274 * Sets a pre-render callback.
276 void SetPreRenderCallback( CallbackBase* callback );
279 * Removes an existing Window instance from the Adaptor
280 * @param[in] childWindow The Window instance
282 bool RemoveWindow( Dali::Internal::Adaptor::SceneHolder* childWindow );
285 * @brief Deletes the rendering surface
286 * @param[in] surface to delete
288 void DeleteSurface( Dali::RenderSurfaceInterface& surface );
291 * @brief Retrieve the window that the given actor is added to.
293 * @param[in] actor The actor
294 * @return The window the actor is added to or a null pointer if the actor is not added to any widnow.
296 Dali::Internal::Adaptor::SceneHolder* GetWindow( Dali::Actor& actor );
299 * @copydoc Dali::Adaptor::GetWindows()
301 Dali::WindowContainer GetWindows() const;
304 * @copydoc Dali::Adaptor::GetSceneHolders()
306 Dali::SceneHolderList GetSceneHolders() const;
309 * @copydoc Dali::Adaptor::GetObjectRegistry()
311 Dali::ObjectRegistry GetObjectRegistry() const;
316 * @return the Core instance
318 Dali::Integration::Core& GetCore() override;
321 * @copydoc Dali::Adaptor::SetRenderRefreshRate()
323 void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
326 * Return the PlatformAbstraction.
327 * @return The PlatformAbstraction.
329 Integration::PlatformAbstraction& GetPlatformAbstraction() const;
332 * Destroy the TtsPlayer of specific mode.
333 * @param[in] mode The mode of TtsPlayer to destroy
335 void DestroyTtsPlayer(Dali::TtsPlayer::Mode mode);
338 * Gets native window handle
340 * @return native window handle
342 Any GetNativeWindowHandle();
345 * @brief Retrieve native window handle that the given actor is added to.
347 * @param[in] actor The actor
348 * @return native window handle
350 Any GetNativeWindowHandle( Dali::Actor actor );
353 * Get the native display associated with the graphics backend
355 * @return A handle to the native display
357 Any GetGraphicsDisplay();
360 * Sets use remote surface for Surface output
361 * @param[in] useRemoteSurface True if the remote surface is used
363 void SetUseRemoteSurface(bool useRemoteSurface);
368 * Adds an adaptor observer so that we can observe the adaptor's lifetime events.
369 * @param[in] observer The observer.
370 * @note Observers should remove themselves when they are destroyed.
372 void AddObserver( LifeCycleObserver& observer );
375 * Removes the observer from the adaptor.
376 * @param[in] observer The observer to remove.
377 * @note Observers should remove themselves when they are destroyed.
379 void RemoveObserver( LifeCycleObserver& observer );
382 * Emits the Notification event to the Dali core.
384 void SendNotificationEvent();
387 * Request adaptor to update once
389 void RequestUpdateOnce();
392 * @copydoc Dali::Adaptor::NotifySceneCreated()
394 void NotifySceneCreated();
397 * @copydoc Dali::Adaptor::NotifyLanguageChanged()
399 void NotifyLanguageChanged();
402 * Gets AppId of current application
404 void GetAppId( std::string& appId );
407 * @copydoc Dali::Adaptor::SurfaceResizePrepare
409 void SurfaceResizePrepare( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
412 * @copydoc Dali::Adaptor::SurfaceResizeComplete
414 void SurfaceResizeComplete( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
417 * Sets layout direction of root by system language
418 * @param[in] locale System locale
420 void SetRootLayoutDirection( std::string locale );
423 * @copydoc Dali::Adaptor::RenderOnce
428 * @copydoc Dali::Adaptor::GetLogFactory
430 const LogFactoryInterface& GetLogFactory();
433 * @copydoc Dali::Adaptor::RegisterProcessor
435 void RegisterProcessor( Integration::Processor& processor );
438 * @coydoc Dali::Adaptor::UnregisterProcessor
440 void UnregisterProcessor( Integration::Processor& processor );
443 * Check MultipleWindow is supported
445 bool IsMultipleWindowSupported() const;
447 public: //AdaptorInternalServices
450 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPlatformAbstractionInterface()
452 Dali::Integration::PlatformAbstraction& GetPlatformAbstractionInterface() override;
455 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetDisplayConnectionInterface()
457 Dali::DisplayConnection& GetDisplayConnectionInterface() override;
460 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetGraphicsInterface()
462 GraphicsInterface& GetGraphicsInterface() override;
465 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventInterface()
467 TriggerEventInterface& GetProcessCoreEventsTrigger() override;
470 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSocketFactoryInterface()
472 SocketFactoryInterface& GetSocketFactoryInterface() override;
475 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetRenderSurfaceInterface()
477 Dali::RenderSurfaceInterface* GetRenderSurfaceInterface() override;
480 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPerformanceInterface()
482 PerformanceInterface* GetPerformanceInterface() override;
485 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetKernelTraceInterface()
487 TraceInterface& GetKernelTraceInterface() override;
490 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSystemTraceInterface()
492 TraceInterface& GetSystemTraceInterface() override;
495 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetWindowContainerInterface()
497 void GetWindowContainerInterface( WindowContainer& windows ) override;
502 * @copydoc Dali::Adaptor::SignalResized
504 AdaptorSignalType& ResizedSignal()
506 return mResizedSignal;
510 * @copydoc Dali::Adaptor::LanguageChangedSignal
512 AdaptorSignalType& LanguageChangedSignal()
514 return mLanguageChangedSignal;
518 * @copydoc Dali::Adaptor::WindowCreatedSignal
520 WindowCreatedSignalType& WindowCreatedSignal()
522 return mWindowCreatedSignal;
525 public: // From Dali::Internal::Adaptor::CoreEventInterface
528 * @copydoc Dali::Internal::Adaptor:CoreEventInterface:::ProcessCoreEvents()
530 void ProcessCoreEvents() override;
532 private: // From Dali::Internal::Adaptor::CoreEventInterface
535 * @copydoc Dali::Internal::Adaptor::CoreEventInterface::QueueCoreEvent()
537 void QueueCoreEvent(const Dali::Integration::Event& event) override;
539 private: // From Dali::Integration::RenderController
542 * @copydoc Dali::Integration::RenderController::RequestUpdate()
544 void RequestUpdate( bool forceUpdate ) override;
547 * @copydoc Dali::Integration::RenderController::RequestProcessEventsOnIdle()
549 void RequestProcessEventsOnIdle( bool forceProcess ) override;
551 public: // From Dali::Internal::Adaptor::WindowVisibilityObserver
554 * Called when the window becomes fully or partially visible.
556 void OnWindowShown() override;
559 * Called when the window is fully hidden.
561 void OnWindowHidden() override;
563 private: // From Dali::Internal::Adaptor::DamageObserver
566 * @copydoc Dali::Internal::Adaptor::DamageObserver::OnDamaged()
568 void OnDamaged( const DamageArea& area ) override;
573 Adaptor(const Adaptor&) = delete;
574 Adaptor& operator=(Adaptor&) = delete;
579 * Assigns the render surface to the adaptor
582 void SetSurface(Dali::RenderSurfaceInterface *surface);
585 * called after surface is created
587 void SurfaceInitialized();
590 * Sends an notification message from main loop idle handler
592 bool ProcessCoreEventsFromIdle();
595 * Gets path for data/resource storage.
596 * @param[out] path Path for data/resource storage
598 void GetDataStoragePath(std::string& path);
601 * Sets up system information if needs
603 void SetupSystemInformation();
606 * Adds a callback to be run when entering an idle state.
608 * A callback of the following type should be used:
612 * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
614 bool AddIdleEnterer( CallbackBase* callback, bool forceAdd );
617 * Removes a previously added the idle enterer callback.
619 void RemoveIdleEnterer( CallbackBase* callback );
625 * @param[in] window window handle
626 * @param[in] adaptor The public adaptor
627 * @param[in] surface A render surface can be one of the following
628 * - Pixmap, adaptor will use existing Pixmap to draw on to
629 * - Window, adaptor will use existing Window to draw on to
630 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
631 * @param[in] threadMode The ThreadMode of the Adaptor
633 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*>;
654 AdaptorSignalType mResizedSignal; ///< Resized signal.
655 AdaptorSignalType mLanguageChangedSignal; ///< Language changed signal.
656 WindowCreatedSignalType mWindowCreatedSignal; ///< Window created signal.
658 Dali::Adaptor& mAdaptor; ///< Reference to public adaptor instance.
659 State mState; ///< Current state of the adaptor
660 Dali::Integration::Core* mCore; ///< Dali Core
661 ThreadController* mThreadController; ///< Controls the threads
663 std::unique_ptr< GraphicsInterface > mGraphics; ///< Graphics interface
664 Dali::DisplayConnection* mDisplayConnection; ///< Display connection
665 WindowContainer mWindows; ///< A container of all the Windows that are currently created
667 std::unique_ptr<ConfigurationManager> mConfigurationManager; ///< Configuration manager
669 TizenPlatform::TizenPlatformAbstraction* mPlatformAbstraction; ///< Platform abstraction
671 CallbackManager* mCallbackManager; ///< Used to install callbacks
672 bool mNotificationOnIdleInstalled; ///< whether the idle handler is installed to send an notification event
673 TriggerEventInterface* mNotificationTrigger; ///< Notification event trigger
674 FeedbackPluginProxy* mDaliFeedbackPlugin; ///< Used to access feedback support
675 FeedbackController* mFeedbackController; ///< Plays feedback effects for Dali-Toolkit UI Controls.
676 Dali::TtsPlayer mTtsPlayers[Dali::TtsPlayer::MODE_NUM]; ///< Provides TTS support
677 ObserverContainer mObservers; ///< A list of adaptor observer pointers
678 EnvironmentOptions* mEnvironmentOptions; ///< environment options
679 PerformanceInterface* mPerformanceInterface; ///< Performance interface
680 KernelTrace mKernelTracer; ///< Kernel tracer
681 SystemTrace mSystemTracer; ///< System tracer
682 ObjectProfiler* mObjectProfiler; ///< Tracks object lifetime for profiling
683 SocketFactory mSocketFactory; ///< Socket factory
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
692 inline static Adaptor& GetImplementation(Dali::Adaptor& adaptor) { return *adaptor.mImpl; }
695 } // namespace Internal
697 } // namespace Adaptor
701 #endif // DALI_INTERNAL_ADAPTOR_IMPL_H