1 #ifndef DALI_INTERNAL_ADAPTOR_IMPL_H
2 #define DALI_INTERNAL_ADAPTOR_IMPL_H
5 * Copyright (c) 2019 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/common/view-mode.h>
24 #include <dali/public-api/math/rect.h>
25 #include <dali/public-api/signals/callback.h>
26 #include <dali/public-api/math/uint-16-pair.h>
27 #include <dali/integration-api/render-controller.h>
30 #include <dali/integration-api/adaptor.h>
31 #include <dali/integration-api/scene.h>
33 #ifdef DALI_ADAPTOR_COMPILATION
34 #include <dali/integration-api/scene-holder-impl.h>
36 #include <dali/integration-api/adaptors/scene-holder-impl.h>
39 #include <dali/public-api/adaptor-framework/tts-player.h>
40 #include <dali/devel-api/adaptor-framework/clipboard.h>
42 #include <dali/internal/graphics/common/graphics-interface.h>
44 #include <dali/internal/legacy/common/tizen-platform-abstraction.h>
45 #include <dali/internal/adaptor/common/adaptor-internal-services.h>
46 #include <dali/internal/system/common/environment-options.h>
47 #include <dali/internal/system/common/core-event-interface.h>
48 #include <dali/internal/window-system/common/damage-observer.h>
49 #include <dali/internal/window-system/common/window-visibility-observer.h>
50 #include <dali/internal/system/common/kernel-trace.h>
51 #include <dali/internal/system/common/system-trace.h>
52 #include <dali/integration-api/trigger-event-factory.h>
53 #include <dali/internal/network/common/socket-factory.h>
59 class RenderSurfaceInterface;
73 class DisplayConnection;
74 class GraphicsFactory;
76 class GlImplementation;
77 class GlSyncImplementation;
78 class ThreadController;
80 class CallbackManager;
81 class FeedbackPluginProxy;
82 class FeedbackController;
84 class PerformanceInterface;
85 class LifeCycleObserver;
90 * Implementation of the Adaptor class.
92 class Adaptor : public Integration::RenderController,
93 public AdaptorInternalServices,
94 public CoreEventInterface,
95 public DamageObserver,
96 public WindowVisibilityObserver
100 typedef Dali::Adaptor::AdaptorSignalType AdaptorSignalType;
102 typedef Uint16Pair SurfaceSize; ///< Surface size type
105 * Creates a New Adaptor
106 * @param[in] window The window handle
107 * @param[in] surface A render surface can be one of the following
108 * - Pixmap, adaptor will use existing Pixmap to draw on to
109 * - Window, adaptor will use existing Window to draw on to
110 * @param[in] configuration The context loss configuration ( to choose resource discard policy )
111 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
113 static Dali::Adaptor* New( Dali::Integration::SceneHolder window,
114 Dali::RenderSurfaceInterface* surface,
115 Dali::Configuration::ContextLoss configuration,
116 EnvironmentOptions* environmentOptions );
119 * Creates a New Adaptor
120 * @param[in] window The window handle
121 * @param[in] configuration The context loss configuration ( to choose resource discard policy )
122 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
124 static Dali::Adaptor* New( Dali::Integration::SceneHolder window,
125 Dali::Configuration::ContextLoss configuration,
126 EnvironmentOptions* environmentOptions );
129 * Creates a New Adaptor
130 * @param[in] graphicsFactory A factory that creates the graphics interface
131 * @param[in] window The window handle
132 * @param[in] surface A render surface can be one of the following
133 * - Pixmap, adaptor will use existing Pixmap to draw on to
134 * - Window, adaptor will use existing Window to draw on to
135 * @param[in] configuration The context loss configuration ( to choose resource discard policy )
136 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
138 static Dali::Adaptor* New( GraphicsFactory& graphicsFactory,
139 Dali::Integration::SceneHolder window,
140 Dali::RenderSurfaceInterface* surface,
141 Dali::Configuration::ContextLoss configuration,
142 EnvironmentOptions* environmentOptions );
145 * Creates a New Adaptor
146 * @param[in] graphicsFactory A factory that creates the graphics interface
147 * @param[in] window The window handle
148 * @param[in] configuration The context loss configuration ( to choose resource discard policy )
149 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
151 static Dali::Adaptor* New( GraphicsFactory& graphicsFactory,
152 Dali::Integration::SceneHolder window,
153 Dali::Configuration::ContextLoss configuration,
154 EnvironmentOptions* environmentOptions );
157 * 2-step initialisation, this should be called after creating an adaptor instance.
158 * @param[in] graphicsFactory A factory that creates the graphics interface
159 * @param[in] configuration The context loss configuration ( to choose resource discard policy )
161 void Initialize( GraphicsFactory& graphicsFactory, Dali::Configuration::ContextLoss configuration );
164 * Virtual destructor.
169 * @copydoc Dali::Adaptor::Get()
171 static Dali::Adaptor& Get();
174 * @copydoc Dali::Adaptor::IsAvailable()
176 static bool IsAvailable();
179 * @copydoc Dali::Core::SceneCreated();
183 public: // AdaptorInternalServices implementation
185 * @copydoc Dali::Adaptor::Start()
187 virtual void Start();
190 * @copydoc Dali::Adaptor::Pause()
192 virtual void Pause();
195 * @copydoc Dali::Adaptor::Resume()
197 virtual void Resume();
200 * @copydoc Dali::Adaptor::Stop()
205 * @copydoc Dali::Adaptor::ContextLost()
207 virtual void ContextLost();
210 * @copydoc Dali::Adaptor::ContextRegained()
212 virtual void ContextRegained();
215 * @copydoc Dali::EventFeeder::FeedTouchPoint()
217 virtual void FeedTouchPoint( TouchPoint& point, int timeStamp );
220 * @copydoc Dali::EventFeeder::FeedWheelEvent()
222 virtual void FeedWheelEvent( WheelEvent& wheelEvent );
225 * @copydoc Dali::EventFeeder::FeedKeyEvent()
227 virtual void FeedKeyEvent( KeyEvent& keyEvent );
230 * @copydoc Dali::Adaptor::ReplaceSurface()
232 virtual void ReplaceSurface( Dali::Integration::SceneHolder window, Dali::RenderSurfaceInterface& surface );
235 * @copydoc Dali::Adaptor::GetSurface()
237 virtual Dali::RenderSurfaceInterface& GetSurface() const;
240 * @copydoc Dali::Adaptor::ReleaseSurfaceLock()
242 virtual void ReleaseSurfaceLock();
245 * Retrieve the TtsPlayer.
246 * @param[in] mode The mode of TtsPlayer
247 * @return A handle to the TtsPlayer.
249 virtual Dali::TtsPlayer GetTtsPlayer(Dali::TtsPlayer::Mode mode);
252 * @copydoc Dali::Adaptor::AddIdle()
254 virtual bool AddIdle( CallbackBase* callback, bool hasReturnValue, bool forceAdd );
257 * Adds a new Window instance to the Adaptor
258 * @param[in] childWindow The child window instance
259 * @param[in] childWindowName The child window title/name
260 * @param[in] childWindowClassName The class name that the child window belongs to
261 * @param[in] childWindowMode The mode of the child window
263 virtual bool AddWindow( Dali::Integration::SceneHolder* childWindow,
264 const std::string& childWindowName,
265 const std::string& childWindowClassName,
266 const bool& childWindowMode );
269 * Removes an existing Window instance from the Adaptor
270 * @param[in] window The Window instance
272 virtual bool RemoveWindow( Dali::Integration::SceneHolder* childWindow );
275 * Removes an existing Window instance from the Adaptor
276 * @param[in] windowName The Window name
277 * @note If two Windows have the same name, the first one that matches will be removed
279 virtual bool RemoveWindow( std::string childWindowName );
282 * @copydoc Dali::Adaptor::RemoveIdle()
284 virtual void RemoveIdle( CallbackBase* callback );
287 * Sets a pre-render callback.
289 void SetPreRenderCallback( CallbackBase* callback );
292 * Removes an existing Window instance from the Adaptor
293 * @param[in] childWindow The Window instance
295 bool RemoveWindow( Dali::Internal::Adaptor::SceneHolder* childWindow );
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 );
308 * @return the Core instance
310 virtual Dali::Integration::Core& GetCore();
313 * @copydoc Dali::Adaptor::SetRenderRefreshRate()
315 void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
318 * @copydoc Dali::Adaptor::SetUseHardwareVSync()
320 void SetUseHardwareVSync(bool useHardware);
323 * Return the PlatformAbstraction.
324 * @return The PlatformAbstraction.
326 Integration::PlatformAbstraction& GetPlatformAbstraction() const;
329 * Destroy the TtsPlayer of specific mode.
330 * @param[in] mode The mode of TtsPlayer to destroy
332 void DestroyTtsPlayer(Dali::TtsPlayer::Mode mode);
335 * Gets native window handle
337 * @return native window handle
339 Any GetNativeWindowHandle();
342 * Get the native display associated with the graphics backend
344 * @return A handle to the native display
346 Any GetGraphicsDisplay();
349 * Sets use remote surface for Surface output
350 * @param[in] useRemoteSurface True if the remote surface is used
352 void SetUseRemoteSurface(bool useRemoteSurface);
357 * Adds an adaptor observer so that we can observe the adaptor's lifetime events.
358 * @param[in] observer The observer.
359 * @note Observers should remove themselves when they are destroyed.
361 void AddObserver( LifeCycleObserver& observer );
364 * Removes the observer from the adaptor.
365 * @param[in] observer The observer to remove.
366 * @note Observers should remove themselves when they are destroyed.
368 void RemoveObserver( LifeCycleObserver& observer );
371 * Emits the Notification event to the Dali core.
373 void SendNotificationEvent();
376 * Request adaptor to update once
378 void RequestUpdateOnce();
381 * @copydoc Dali::Adaptor::NotifySceneCreated()
383 void NotifySceneCreated();
386 * @copydoc Dali::Adaptor::NotifyLanguageChanged()
388 void NotifyLanguageChanged();
391 * Gets AppId of current application
393 void GetAppId( std::string& appId );
396 * Informs core the surface size has changed
398 void SurfaceResizePrepare( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
401 * Informs ThreadController the surface size has changed
403 void SurfaceResizeComplete( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
406 * Sets layout direction of root by system language
407 * @param[in] locale System locale
409 void SetRootLayoutDirection( std::string locale );
412 * @copydoc Dali::Adaptor::RenderOnce
417 * @copydoc Dali::Adaptor::GetLogFactory
419 const LogFactoryInterface& GetLogFactory();
422 * @copydoc Dali::Adaptor::RegisterProcessor
424 void RegisterProcessor( Integration::Processor& processor );
427 * @coydoc Dali::Adaptor::UnregisterProcessor
429 void UnregisterProcessor( Integration::Processor& processor );
431 public: //AdaptorInternalServices
434 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPlatformAbstractionInterface()
436 virtual Dali::Integration::PlatformAbstraction& GetPlatformAbstractionInterface();
439 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetDisplayConnectionInterface()
441 virtual Dali::DisplayConnection& GetDisplayConnectionInterface();
444 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetGraphicsInterface()
446 virtual GraphicsInterface& GetGraphicsInterface();
449 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventInterface()
451 virtual TriggerEventInterface& GetProcessCoreEventsTrigger();
454 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventFactoryInterface()
456 virtual TriggerEventFactoryInterface& GetTriggerEventFactoryInterface();
459 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSocketFactoryInterface()
461 virtual SocketFactoryInterface& GetSocketFactoryInterface();
464 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetRenderSurfaceInterface()
466 virtual Dali::RenderSurfaceInterface* GetRenderSurfaceInterface();
469 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetVSyncMonitorInterface()
471 virtual VSyncMonitorInterface* GetVSyncMonitorInterface();
474 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPerformanceInterface()
476 virtual PerformanceInterface* GetPerformanceInterface();
479 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetKernelTraceInterface()
481 virtual TraceInterface& GetKernelTraceInterface();
484 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSystemTraceInterface()
486 virtual TraceInterface& GetSystemTraceInterface();
491 * @copydoc Dali::Adaptor::SignalResized
493 AdaptorSignalType& ResizedSignal()
495 return mResizedSignal;
499 * @copydoc Dali::Adaptor::LanguageChangedSignal
501 AdaptorSignalType& LanguageChangedSignal()
503 return mLanguageChangedSignal;
506 public: // From Dali::Internal::Adaptor::CoreEventInterface
509 * @copydoc Dali::Internal::Adaptor:CoreEventInterface:::ProcessCoreEvents()
511 virtual void ProcessCoreEvents();
513 private: // From Dali::Internal::Adaptor::CoreEventInterface
516 * @copydoc Dali::Internal::Adaptor::CoreEventInterface::QueueCoreEvent()
518 virtual void QueueCoreEvent(const Dali::Integration::Event& event);
520 private: // From Dali::Integration::RenderController
523 * @copydoc Dali::Integration::RenderController::RequestUpdate()
525 virtual void RequestUpdate( bool forceUpdate );
528 * @copydoc Dali::Integration::RenderController::RequestProcessEventsOnIdle()
530 virtual void RequestProcessEventsOnIdle( bool forceProcess );
532 private: // From Dali::Internal::Adaptor::WindowVisibilityObserver
535 * Called when the window becomes fully or partially visible.
537 virtual void OnWindowShown();
540 * Called when the window is fully hidden.
542 virtual void OnWindowHidden();
544 private: // From Dali::Internal::Adaptor::DamageObserver
547 * @copydoc Dali::Internal::Adaptor::DamageObserver::OnDamaged()
549 void OnDamaged( const DamageArea& area );
554 Adaptor(const Adaptor&) = delete;
555 Adaptor& operator=(Adaptor&) = delete;
560 * Assigns the render surface to the adaptor
563 void SetSurface(Dali::RenderSurfaceInterface *surface);
566 * called after surface is created
568 void SurfaceInitialized();
571 * Sends an notification message from main loop idle handler
573 bool ProcessCoreEventsFromIdle();
576 * Gets path for data/resource storage.
577 * @param[out] path Path for data/resource storage
579 void GetDataStoragePath(std::string& path);
582 * Sets up system information if needs
584 void SetupSystemInformation();
587 * Adds a callback to be run when entering an idle state.
589 * A callback of the following type should be used:
593 * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
595 bool AddIdleEnterer( CallbackBase* callback, bool forceAdd );
598 * Removes a previously added the idle enterer callback.
600 void RemoveIdleEnterer( CallbackBase* callback );
606 * @param[in] window window handle
607 * @param[in] adaptor The public adaptor
608 * @param[in] surface A render surface can be one of the following
609 * - Pixmap, adaptor will use existing Pixmap to draw on to
610 * - Window, adaptor will use existing Window to draw on to
611 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
613 Adaptor( Dali::Integration::SceneHolder window, Dali::Adaptor& adaptor, Dali::RenderSurfaceInterface* surface, EnvironmentOptions* environmentOptions );
619 READY, ///< Initial state before Adaptor::Start is called.
620 RUNNING, ///< Adaptor is running.
621 PAUSED, ///< Adaptor has been paused.
622 PAUSED_WHILE_HIDDEN, ///< Adaptor is paused while window is hidden (& cannot be resumed until window is shown).
623 PAUSED_WHILE_INITIALIZING, ///< Adaptor is paused while application is initializing.
624 STOPPED, ///< Adaptor has been stopped.
627 using SceneHolderPtr = IntrusivePtr< Dali::Internal::Adaptor::SceneHolder >;
628 using WindowContainer = std::vector<SceneHolderPtr>;
629 using ObserverContainer = std::vector<LifeCycleObserver*>;
633 AdaptorSignalType mResizedSignal; ///< Resized signal.
634 AdaptorSignalType mLanguageChangedSignal; ///< Language changed signal.
636 Dali::Adaptor& mAdaptor; ///< Reference to public adaptor instance.
637 State mState; ///< Current state of the adaptor
638 Dali::Integration::Core* mCore; ///< Dali Core
639 ThreadController* mThreadController; ///< Controls the threads
640 VSyncMonitor* mVSyncMonitor; ///< Monitors VSync events
642 GraphicsInterface* mGraphics; ///< Graphics interface
643 Dali::DisplayConnection* mDisplayConnection; ///< Display connection
644 WindowContainer mWindows; ///< A container of all the Windows that are currently created
646 TizenPlatform::TizenPlatformAbstraction* mPlatformAbstraction; ///< Platform abstraction
648 CallbackManager* mCallbackManager; ///< Used to install callbacks
649 bool mNotificationOnIdleInstalled; ///< whether the idle handler is installed to send an notification event
650 TriggerEventInterface* mNotificationTrigger; ///< Notification event trigger
651 FeedbackPluginProxy* mDaliFeedbackPlugin; ///< Used to access feedback support
652 FeedbackController* mFeedbackController; ///< Plays feedback effects for Dali-Toolkit UI Controls.
653 Dali::TtsPlayer mTtsPlayers[Dali::TtsPlayer::MODE_NUM]; ///< Provides TTS support
654 ObserverContainer mObservers; ///< A list of adaptor observer pointers
655 EnvironmentOptions* mEnvironmentOptions; ///< environment options
656 PerformanceInterface* mPerformanceInterface; ///< Performance interface
657 KernelTrace mKernelTracer; ///< Kernel tracer
658 SystemTrace mSystemTracer; ///< System tracer
659 TriggerEventFactory mTriggerEventFactory; ///< Trigger event factory
660 ObjectProfiler* mObjectProfiler; ///< Tracks object lifetime for profiling
661 SocketFactory mSocketFactory; ///< Socket factory
662 const bool mEnvironmentOptionsOwned:1; ///< Whether we own the EnvironmentOptions (and thus, need to delete it)
663 bool mUseRemoteSurface; ///< whether the remoteSurface is used or not
666 inline static Adaptor& GetImplementation(Dali::Adaptor& adaptor) { return *adaptor.mImpl; }
669 } // namespace Internal
671 } // namespace Adaptor
675 #endif // DALI_INTERNAL_ADAPTOR_IMPL_H