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/public-api/adaptor-framework/tts-player.h>
31 #include <dali/devel-api/adaptor-framework/clipboard.h>
32 #include <dali/integration-api/scene.h>
33 #include <dali/integration-api/adaptor-framework/adaptor.h>
34 #include <dali/integration-api/adaptor-framework/scene-holder-impl.h>
35 #include <dali/integration-api/adaptor-framework/trigger-event-factory.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>
50 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;
80 * Implementation of the Adaptor class.
82 class Adaptor : public Integration::RenderController,
83 public AdaptorInternalServices,
84 public CoreEventInterface,
85 public DamageObserver,
86 public WindowVisibilityObserver
90 using AdaptorSignalType = Dali::Adaptor::AdaptorSignalType;
91 using WindowCreatedSignalType = Dali::Adaptor::WindowCreatedSignalType;
93 using SurfaceSize = Uint16Pair; ///< Surface size type
96 * Creates a New Adaptor
97 * @param[in] window The window handle
98 * @param[in] surface A render surface can be one of the following
99 * - Pixmap, adaptor will use existing Pixmap to draw on to
100 * - Window, adaptor will use existing Window to draw on to
101 * @param[in] configuration The context loss configuration ( to choose resource discard policy )
102 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
104 static Dali::Adaptor* New( Dali::Integration::SceneHolder window,
105 Dali::RenderSurfaceInterface* surface,
106 Dali::Configuration::ContextLoss configuration,
107 EnvironmentOptions* environmentOptions );
110 * Creates a New Adaptor
111 * @param[in] window The window handle
112 * @param[in] configuration The context loss configuration ( to choose resource discard policy )
113 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
115 static Dali::Adaptor* New( Dali::Integration::SceneHolder window,
116 Dali::Configuration::ContextLoss configuration,
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] configuration The context loss configuration ( to choose resource discard policy )
127 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
129 static Dali::Adaptor* New( GraphicsFactory& graphicsFactory,
130 Dali::Integration::SceneHolder window,
131 Dali::RenderSurfaceInterface* surface,
132 Dali::Configuration::ContextLoss configuration,
133 EnvironmentOptions* environmentOptions );
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] configuration The context loss configuration ( to choose resource discard policy )
140 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
142 static Dali::Adaptor* New( GraphicsFactory& graphicsFactory,
143 Dali::Integration::SceneHolder window,
144 Dali::Configuration::ContextLoss configuration,
145 EnvironmentOptions* environmentOptions );
148 * 2-step initialisation, this should be called after creating an adaptor instance.
149 * @param[in] graphicsFactory A factory that creates the graphics interface
150 * @param[in] configuration The context loss configuration ( to choose resource discard policy )
152 void Initialize( GraphicsFactory& graphicsFactory, Dali::Configuration::ContextLoss configuration );
155 * Virtual destructor.
160 * @copydoc Dali::Adaptor::Get()
162 static Dali::Adaptor& Get();
165 * @copydoc Dali::Adaptor::IsAvailable()
167 static bool IsAvailable();
170 * @copydoc Dali::Core::SceneCreated();
174 public: // AdaptorInternalServices implementation
176 * @copydoc Dali::Adaptor::Start()
178 virtual void Start();
181 * @copydoc Dali::Adaptor::Pause()
183 virtual void Pause();
186 * @copydoc Dali::Adaptor::Resume()
188 virtual void Resume();
191 * @copydoc Dali::Adaptor::Stop()
196 * @copydoc Dali::Adaptor::ContextLost()
198 virtual void ContextLost();
201 * @copydoc Dali::Adaptor::ContextRegained()
203 virtual void ContextRegained();
206 * @copydoc Dali::EventFeeder::FeedTouchPoint()
208 virtual void FeedTouchPoint( TouchPoint& point, int timeStamp );
211 * @copydoc Dali::EventFeeder::FeedWheelEvent()
213 virtual void FeedWheelEvent( WheelEvent& wheelEvent );
216 * @copydoc Dali::EventFeeder::FeedKeyEvent()
218 virtual void FeedKeyEvent( KeyEvent& keyEvent );
221 * @copydoc Dali::Adaptor::ReplaceSurface()
223 virtual void ReplaceSurface( Dali::Integration::SceneHolder window, Dali::RenderSurfaceInterface& surface );
226 * @copydoc Dali::Adaptor::GetSurface()
228 virtual Dali::RenderSurfaceInterface& GetSurface() const;
231 * @copydoc Dali::Adaptor::ReleaseSurfaceLock()
233 virtual void ReleaseSurfaceLock();
236 * Retrieve the TtsPlayer.
237 * @param[in] mode The mode of TtsPlayer
238 * @return A handle to the TtsPlayer.
240 virtual Dali::TtsPlayer GetTtsPlayer(Dali::TtsPlayer::Mode mode);
243 * @copydoc Dali::Adaptor::AddIdle()
245 virtual bool AddIdle( CallbackBase* callback, bool hasReturnValue, bool forceAdd );
248 * Adds a new Window instance to the Adaptor
249 * @param[in] childWindow The child window instance
250 * @param[in] childWindowName The child window title/name
251 * @param[in] childWindowClassName The class name that the child window belongs to
252 * @param[in] childWindowMode The mode of the child window
254 virtual bool AddWindow( Dali::Integration::SceneHolder childWindow,
255 const std::string& childWindowName,
256 const std::string& childWindowClassName,
257 bool childWindowMode );
260 * Removes an existing Window instance from the Adaptor
261 * @param[in] window The Window instance
263 virtual bool RemoveWindow( Dali::Integration::SceneHolder* childWindow );
266 * Removes an existing Window instance from the Adaptor
267 * @param[in] windowName The Window name
268 * @note If two Windows have the same name, the first one that matches will be removed
270 virtual bool RemoveWindow( std::string childWindowName );
273 * @copydoc Dali::Adaptor::RemoveIdle()
275 virtual void RemoveIdle( CallbackBase* callback );
278 * Sets a pre-render callback.
280 void SetPreRenderCallback( CallbackBase* callback );
283 * Removes an existing Window instance from the Adaptor
284 * @param[in] childWindow The Window instance
286 bool RemoveWindow( Dali::Internal::Adaptor::SceneHolder* childWindow );
289 * @brief Deletes the rendering surface
290 * @param[in] surface to delete
292 void DeleteSurface( Dali::RenderSurfaceInterface& surface );
295 * @brief Retrieve the window that the given actor is added to.
297 * @param[in] actor The actor
298 * @return The window the actor is added to or a null pointer if the actor is not added to any widnow.
300 Dali::Internal::Adaptor::SceneHolder* GetWindow( Dali::Actor& actor );
303 * @copydoc Dali::Adaptor::GetWindows()
305 Dali::WindowContainer GetWindows() const;
308 * @copydoc Dali::Adaptor::GetSceneHolders()
310 Dali::SceneHolderList GetSceneHolders() const;
315 * @return the Core instance
317 virtual Dali::Integration::Core& GetCore();
320 * @copydoc Dali::Adaptor::SetRenderRefreshRate()
322 void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
325 * Return the PlatformAbstraction.
326 * @return The PlatformAbstraction.
328 Integration::PlatformAbstraction& GetPlatformAbstraction() const;
331 * Destroy the TtsPlayer of specific mode.
332 * @param[in] mode The mode of TtsPlayer to destroy
334 void DestroyTtsPlayer(Dali::TtsPlayer::Mode mode);
337 * Gets native window handle
339 * @return native window handle
341 Any GetNativeWindowHandle();
344 * @brief Retrieve native window handle that the given actor is added to.
346 * @param[in] actor The actor
347 * @return native window handle
349 Any GetNativeWindowHandle( Dali::Actor actor );
352 * Get the native display associated with the graphics backend
354 * @return A handle to the native display
356 Any GetGraphicsDisplay();
359 * Sets use remote surface for Surface output
360 * @param[in] useRemoteSurface True if the remote surface is used
362 void SetUseRemoteSurface(bool useRemoteSurface);
367 * Adds an adaptor observer so that we can observe the adaptor's lifetime events.
368 * @param[in] observer The observer.
369 * @note Observers should remove themselves when they are destroyed.
371 void AddObserver( LifeCycleObserver& observer );
374 * Removes the observer from the adaptor.
375 * @param[in] observer The observer to remove.
376 * @note Observers should remove themselves when they are destroyed.
378 void RemoveObserver( LifeCycleObserver& observer );
381 * Emits the Notification event to the Dali core.
383 void SendNotificationEvent();
386 * Request adaptor to update once
388 void RequestUpdateOnce();
391 * @copydoc Dali::Adaptor::NotifySceneCreated()
393 void NotifySceneCreated();
396 * @copydoc Dali::Adaptor::NotifyLanguageChanged()
398 void NotifyLanguageChanged();
401 * Gets AppId of current application
403 void GetAppId( std::string& appId );
406 * @copydoc Dali::Adaptor::SurfaceResizePrepare
408 void SurfaceResizePrepare( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
411 * @copydoc Dali::Adaptor::SurfaceResizeComplete
413 void SurfaceResizeComplete( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
416 * Sets layout direction of root by system language
417 * @param[in] locale System locale
419 void SetRootLayoutDirection( std::string locale );
422 * @copydoc Dali::Adaptor::RenderOnce
427 * @copydoc Dali::Adaptor::GetLogFactory
429 const LogFactoryInterface& GetLogFactory();
432 * @copydoc Dali::Adaptor::RegisterProcessor
434 void RegisterProcessor( Integration::Processor& processor );
437 * @coydoc Dali::Adaptor::UnregisterProcessor
439 void UnregisterProcessor( Integration::Processor& processor );
441 public: //AdaptorInternalServices
444 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPlatformAbstractionInterface()
446 virtual Dali::Integration::PlatformAbstraction& GetPlatformAbstractionInterface();
449 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetDisplayConnectionInterface()
451 virtual Dali::DisplayConnection& GetDisplayConnectionInterface();
454 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetGraphicsInterface()
456 virtual GraphicsInterface& GetGraphicsInterface();
459 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventInterface()
461 virtual TriggerEventInterface& GetProcessCoreEventsTrigger();
464 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventFactoryInterface()
466 virtual TriggerEventFactoryInterface& GetTriggerEventFactoryInterface();
469 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSocketFactoryInterface()
471 virtual SocketFactoryInterface& GetSocketFactoryInterface();
474 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetRenderSurfaceInterface()
476 virtual Dali::RenderSurfaceInterface* GetRenderSurfaceInterface();
479 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPerformanceInterface()
481 virtual PerformanceInterface* GetPerformanceInterface();
484 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetKernelTraceInterface()
486 virtual TraceInterface& GetKernelTraceInterface();
489 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSystemTraceInterface()
491 virtual TraceInterface& GetSystemTraceInterface();
496 * @copydoc Dali::Adaptor::SignalResized
498 AdaptorSignalType& ResizedSignal()
500 return mResizedSignal;
504 * @copydoc Dali::Adaptor::LanguageChangedSignal
506 AdaptorSignalType& LanguageChangedSignal()
508 return mLanguageChangedSignal;
512 * @copydoc Dali::Adaptor::WindowCreatedSignal
514 WindowCreatedSignalType& WindowCreatedSignal()
516 return mWindowCreatedSignal;
519 public: // From Dali::Internal::Adaptor::CoreEventInterface
522 * @copydoc Dali::Internal::Adaptor:CoreEventInterface:::ProcessCoreEvents()
524 virtual void ProcessCoreEvents();
526 private: // From Dali::Internal::Adaptor::CoreEventInterface
529 * @copydoc Dali::Internal::Adaptor::CoreEventInterface::QueueCoreEvent()
531 virtual void QueueCoreEvent(const Dali::Integration::Event& event);
533 private: // From Dali::Integration::RenderController
536 * @copydoc Dali::Integration::RenderController::RequestUpdate()
538 virtual void RequestUpdate( bool forceUpdate );
541 * @copydoc Dali::Integration::RenderController::RequestProcessEventsOnIdle()
543 virtual void RequestProcessEventsOnIdle( bool forceProcess );
545 public: // From Dali::Internal::Adaptor::WindowVisibilityObserver
548 * Called when the window becomes fully or partially visible.
550 virtual void OnWindowShown();
553 * Called when the window is fully hidden.
555 virtual void OnWindowHidden();
557 private: // From Dali::Internal::Adaptor::DamageObserver
560 * @copydoc Dali::Internal::Adaptor::DamageObserver::OnDamaged()
562 void OnDamaged( const DamageArea& area );
567 Adaptor(const Adaptor&) = delete;
568 Adaptor& operator=(Adaptor&) = delete;
573 * Assigns the render surface to the adaptor
576 void SetSurface(Dali::RenderSurfaceInterface *surface);
579 * called after surface is created
581 void SurfaceInitialized();
584 * Sends an notification message from main loop idle handler
586 bool ProcessCoreEventsFromIdle();
589 * Gets path for data/resource storage.
590 * @param[out] path Path for data/resource storage
592 void GetDataStoragePath(std::string& path);
595 * Sets up system information if needs
597 void SetupSystemInformation();
600 * Adds a callback to be run when entering an idle state.
602 * A callback of the following type should be used:
606 * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
608 bool AddIdleEnterer( CallbackBase* callback, bool forceAdd );
611 * Removes a previously added the idle enterer callback.
613 void RemoveIdleEnterer( CallbackBase* callback );
619 * @param[in] window window handle
620 * @param[in] adaptor The public adaptor
621 * @param[in] surface A render surface can be one of the following
622 * - Pixmap, adaptor will use existing Pixmap to draw on to
623 * - Window, adaptor will use existing Window to draw on to
624 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
626 Adaptor( Dali::Integration::SceneHolder window, Dali::Adaptor& adaptor, Dali::RenderSurfaceInterface* surface, EnvironmentOptions* environmentOptions );
632 READY, ///< Initial state before Adaptor::Start is called.
633 RUNNING, ///< Adaptor is running.
634 PAUSED, ///< Adaptor has been paused.
635 PAUSED_WHILE_HIDDEN, ///< Adaptor is paused while window is hidden (& cannot be resumed until window is shown).
636 PAUSED_WHILE_INITIALIZING, ///< Adaptor is paused while application is initializing.
637 STOPPED, ///< Adaptor has been stopped.
640 // There is no weak handle for BaseHandle in DALi, but we can't ref count the window here,
641 // so we have to store the raw pointer.
642 using WindowContainer = std::vector<Dali::Internal::Adaptor::SceneHolder*>;
643 using ObserverContainer = std::vector<LifeCycleObserver*>;
647 AdaptorSignalType mResizedSignal; ///< Resized signal.
648 AdaptorSignalType mLanguageChangedSignal; ///< Language changed signal.
649 WindowCreatedSignalType mWindowCreatedSignal; ///< Window created signal.
651 Dali::Adaptor& mAdaptor; ///< Reference to public adaptor instance.
652 State mState; ///< Current state of the adaptor
653 Dali::Integration::Core* mCore; ///< Dali Core
654 ThreadController* mThreadController; ///< Controls the threads
656 GraphicsInterface* mGraphics; ///< Graphics interface
657 Dali::DisplayConnection* mDisplayConnection; ///< Display connection
658 WindowContainer mWindows; ///< A container of all the Windows that are currently created
660 TizenPlatform::TizenPlatformAbstraction* mPlatformAbstraction; ///< Platform abstraction
662 CallbackManager* mCallbackManager; ///< Used to install callbacks
663 bool mNotificationOnIdleInstalled; ///< whether the idle handler is installed to send an notification event
664 TriggerEventInterface* mNotificationTrigger; ///< Notification event trigger
665 FeedbackPluginProxy* mDaliFeedbackPlugin; ///< Used to access feedback support
666 FeedbackController* mFeedbackController; ///< Plays feedback effects for Dali-Toolkit UI Controls.
667 Dali::TtsPlayer mTtsPlayers[Dali::TtsPlayer::MODE_NUM]; ///< Provides TTS support
668 ObserverContainer mObservers; ///< A list of adaptor observer pointers
669 EnvironmentOptions* mEnvironmentOptions; ///< environment options
670 PerformanceInterface* mPerformanceInterface; ///< Performance interface
671 KernelTrace mKernelTracer; ///< Kernel tracer
672 SystemTrace mSystemTracer; ///< System tracer
673 TriggerEventFactory mTriggerEventFactory; ///< Trigger event factory
674 ObjectProfiler* mObjectProfiler; ///< Tracks object lifetime for profiling
675 SocketFactory mSocketFactory; ///< Socket factory
676 const bool mEnvironmentOptionsOwned:1; ///< Whether we own the EnvironmentOptions (and thus, need to delete it)
677 bool mUseRemoteSurface; ///< whether the remoteSurface is used or not
680 inline static Adaptor& GetImplementation(Dali::Adaptor& adaptor) { return *adaptor.mImpl; }
683 } // namespace Internal
685 } // namespace Adaptor
689 #endif // DALI_INTERNAL_ADAPTOR_IMPL_H