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>
60 class RenderSurfaceInterface;
61 namespace Accessibility
78 class DisplayConnection;
79 class GraphicsFactory;
80 class GlImplementation;
81 class GlSyncImplementation;
82 class ThreadController;
84 class CallbackManager;
85 class FeedbackPluginProxy;
86 class FeedbackController;
88 class PerformanceInterface;
89 class LifeCycleObserver;
94 * Implementation of the Adaptor class.
96 class Adaptor : public Integration::RenderController,
97 public AdaptorInternalServices,
98 public CoreEventInterface,
99 public DamageObserver,
100 public WindowVisibilityObserver
104 using AdaptorSignalType = Dali::Adaptor::AdaptorSignalType;
105 using WindowCreatedSignalType = Dali::Adaptor::WindowCreatedSignalType;
107 using SurfaceSize = Uint16Pair; ///< Surface size type
110 * Creates a New Adaptor
111 * @param[in] window The window handle
112 * @param[in] surface A render surface can be one of the following
113 * - Pixmap, adaptor will use existing Pixmap to draw on to
114 * - Window, adaptor will use existing Window to draw on to
115 * @param[in] configuration The context loss configuration ( to choose resource discard policy )
116 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
118 static Dali::Adaptor* New( Dali::Integration::SceneHolder window,
119 Dali::RenderSurfaceInterface* surface,
120 Dali::Configuration::ContextLoss configuration,
121 EnvironmentOptions* environmentOptions );
124 * Creates a New Adaptor
125 * @param[in] window The window handle
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( Dali::Integration::SceneHolder window,
130 Dali::Configuration::ContextLoss configuration,
131 EnvironmentOptions* environmentOptions );
134 * Creates a New Adaptor
135 * @param[in] graphicsFactory A factory that creates the graphics interface
136 * @param[in] window The window handle
137 * @param[in] surface A render surface can be one of the following
138 * - Pixmap, adaptor will use existing Pixmap to draw on to
139 * - Window, adaptor will use existing Window to draw on to
140 * @param[in] configuration The context loss configuration ( to choose resource discard policy )
141 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
143 static Dali::Adaptor* New( GraphicsFactory& graphicsFactory,
144 Dali::Integration::SceneHolder window,
145 Dali::RenderSurfaceInterface* surface,
146 Dali::Configuration::ContextLoss configuration,
147 EnvironmentOptions* environmentOptions );
150 * Creates a New Adaptor
151 * @param[in] graphicsFactory A factory that creates the graphics interface
152 * @param[in] window The window handle
153 * @param[in] configuration The context loss configuration ( to choose resource discard policy )
154 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
156 static Dali::Adaptor* New( GraphicsFactory& graphicsFactory,
157 Dali::Integration::SceneHolder window,
158 Dali::Configuration::ContextLoss configuration,
159 EnvironmentOptions* environmentOptions );
162 * 2-step initialisation, this should be called after creating an adaptor instance.
163 * @param[in] graphicsFactory A factory that creates the graphics interface
164 * @param[in] configuration The context loss configuration ( to choose resource discard policy )
166 void Initialize( GraphicsFactory& graphicsFactory, Dali::Configuration::ContextLoss configuration );
169 * Virtual destructor.
174 * @copydoc Dali::Adaptor::Get()
176 static Dali::Adaptor& Get();
179 * @copydoc Dali::Adaptor::IsAvailable()
181 static bool IsAvailable();
184 * @copydoc Dali::Core::SceneCreated();
188 static std::string GetApplicationPackageName();
190 public: // AdaptorInternalServices implementation
192 * @copydoc Dali::Adaptor::Start()
194 virtual void Start();
197 * @copydoc Dali::Adaptor::Pause()
199 virtual void Pause();
202 * @copydoc Dali::Adaptor::Resume()
204 virtual void Resume();
207 * @copydoc Dali::Adaptor::Stop()
212 * @copydoc Dali::Adaptor::ContextLost()
214 virtual void ContextLost();
217 * @copydoc Dali::Adaptor::ContextRegained()
219 virtual void ContextRegained();
222 * @copydoc Dali::EventFeeder::FeedTouchPoint()
224 virtual void FeedTouchPoint( TouchPoint& point, int timeStamp );
227 * @copydoc Dali::EventFeeder::FeedWheelEvent()
229 virtual void FeedWheelEvent( WheelEvent& wheelEvent );
232 * @copydoc Dali::EventFeeder::FeedKeyEvent()
234 virtual void FeedKeyEvent( KeyEvent& keyEvent );
237 * @copydoc Dali::Adaptor::ReplaceSurface()
239 virtual void ReplaceSurface( Dali::Integration::SceneHolder window, Dali::RenderSurfaceInterface& surface );
242 * @copydoc Dali::Adaptor::GetSurface()
244 virtual Dali::RenderSurfaceInterface& GetSurface() const;
247 * @copydoc Dali::Adaptor::ReleaseSurfaceLock()
249 virtual void ReleaseSurfaceLock();
252 * Retrieve the TtsPlayer.
253 * @param[in] mode The mode of TtsPlayer
254 * @return A handle to the TtsPlayer.
256 virtual Dali::TtsPlayer GetTtsPlayer(Dali::TtsPlayer::Mode mode);
259 * @copydoc Dali::Adaptor::AddIdle()
261 virtual bool AddIdle( CallbackBase* callback, bool hasReturnValue, bool forceAdd );
264 * Adds a new Window instance to the Adaptor
265 * @param[in] childWindow The child window instance
266 * @param[in] childWindowName The child window title/name
267 * @param[in] childWindowClassName The class name that the child window belongs to
268 * @param[in] childWindowMode The mode of the child window
270 virtual bool AddWindow( Dali::Integration::SceneHolder childWindow,
271 const std::string& childWindowName,
272 const std::string& childWindowClassName,
273 bool childWindowMode );
276 * Removes an existing Window instance from the Adaptor
277 * @param[in] window The Window instance
279 virtual bool RemoveWindow( Dali::Integration::SceneHolder* childWindow );
282 * Removes an existing Window instance from the Adaptor
283 * @param[in] windowName The Window name
284 * @note If two Windows have the same name, the first one that matches will be removed
286 virtual bool RemoveWindow( std::string childWindowName );
289 * @copydoc Dali::Adaptor::RemoveIdle()
291 virtual void RemoveIdle( CallbackBase* callback );
294 * Sets a pre-render callback.
296 void SetPreRenderCallback( CallbackBase* callback );
299 * Removes an existing Window instance from the Adaptor
300 * @param[in] childWindow The Window instance
302 bool RemoveWindow( Dali::Internal::Adaptor::SceneHolder* childWindow );
305 * @brief Deletes the rendering surface
306 * @param[in] surface to delete
308 void DeleteSurface( Dali::RenderSurfaceInterface& surface );
311 * @brief Retrieve the window that the given actor is added to.
313 * @param[in] actor The actor
314 * @return The window the actor is added to or a null pointer if the actor is not added to any widnow.
316 Dali::Internal::Adaptor::SceneHolder* GetWindow( Dali::Actor& actor );
319 * @copydoc Dali::Adaptor::GetWindows()
321 Dali::WindowContainer GetWindows() const;
326 * @return the Core instance
328 virtual Dali::Integration::Core& GetCore();
331 * @copydoc Dali::Adaptor::SetRenderRefreshRate()
333 void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
336 * Return the PlatformAbstraction.
337 * @return The PlatformAbstraction.
339 Integration::PlatformAbstraction& GetPlatformAbstraction() const;
342 * Destroy the TtsPlayer of specific mode.
343 * @param[in] mode The mode of TtsPlayer to destroy
345 void DestroyTtsPlayer(Dali::TtsPlayer::Mode mode);
348 * Gets native window handle
350 * @return native window handle
352 Any GetNativeWindowHandle();
355 * @brief Retrieve native window handle that the given actor is added to.
357 * @param[in] actor The actor
358 * @return native window handle
360 Any GetNativeWindowHandle( Dali::Actor actor );
363 * Get the native display associated with the graphics backend
365 * @return A handle to the native display
367 Any GetGraphicsDisplay();
370 * Sets use remote surface for Surface output
371 * @param[in] useRemoteSurface True if the remote surface is used
373 void SetUseRemoteSurface(bool useRemoteSurface);
378 * Adds an adaptor observer so that we can observe the adaptor's lifetime events.
379 * @param[in] observer The observer.
380 * @note Observers should remove themselves when they are destroyed.
382 void AddObserver( LifeCycleObserver& observer );
385 * Removes the observer from the adaptor.
386 * @param[in] observer The observer to remove.
387 * @note Observers should remove themselves when they are destroyed.
389 void RemoveObserver( LifeCycleObserver& observer );
392 * Emits the Notification event to the Dali core.
394 void SendNotificationEvent();
397 * Request adaptor to update once
399 void RequestUpdateOnce();
402 * @copydoc Dali::Adaptor::NotifySceneCreated()
404 void NotifySceneCreated();
407 * @copydoc Dali::Adaptor::NotifyLanguageChanged()
409 void NotifyLanguageChanged();
412 * Gets AppId of current application
414 void GetAppId( std::string& appId );
417 * @copydoc Dali::Adaptor::SurfaceResizePrepare
419 void SurfaceResizePrepare( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
422 * @copydoc Dali::Adaptor::SurfaceResizeComplete
424 void SurfaceResizeComplete( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
427 * Sets layout direction of root by system language
428 * @param[in] locale System locale
430 void SetRootLayoutDirection( std::string locale );
433 * @copydoc Dali::Adaptor::RenderOnce
438 * @copydoc Dali::Adaptor::GetLogFactory
440 const LogFactoryInterface& GetLogFactory();
443 * @copydoc Dali::Adaptor::RegisterProcessor
445 void RegisterProcessor( Integration::Processor& processor );
448 * @coydoc Dali::Adaptor::UnregisterProcessor
450 void UnregisterProcessor( Integration::Processor& processor );
452 public: //AdaptorInternalServices
455 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPlatformAbstractionInterface()
457 virtual Dali::Integration::PlatformAbstraction& GetPlatformAbstractionInterface();
460 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetDisplayConnectionInterface()
462 virtual Dali::DisplayConnection& GetDisplayConnectionInterface();
465 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetGraphicsInterface()
467 virtual GraphicsInterface& GetGraphicsInterface();
470 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventInterface()
472 virtual TriggerEventInterface& GetProcessCoreEventsTrigger();
475 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventFactoryInterface()
477 virtual TriggerEventFactoryInterface& GetTriggerEventFactoryInterface();
480 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSocketFactoryInterface()
482 virtual SocketFactoryInterface& GetSocketFactoryInterface();
485 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetRenderSurfaceInterface()
487 virtual Dali::RenderSurfaceInterface* GetRenderSurfaceInterface();
490 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPerformanceInterface()
492 virtual PerformanceInterface* GetPerformanceInterface();
495 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetKernelTraceInterface()
497 virtual TraceInterface& GetKernelTraceInterface();
500 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSystemTraceInterface()
502 virtual TraceInterface& GetSystemTraceInterface();
507 * @copydoc Dali::Adaptor::SignalResized
509 AdaptorSignalType& ResizedSignal()
511 return mResizedSignal;
515 * @copydoc Dali::Adaptor::LanguageChangedSignal
517 AdaptorSignalType& LanguageChangedSignal()
519 return mLanguageChangedSignal;
523 * @copydoc Dali::Adaptor::WindowCreatedSignal
525 WindowCreatedSignalType& WindowCreatedSignal()
527 return mWindowCreatedSignal;
530 public: // From Dali::Internal::Adaptor::CoreEventInterface
533 * @copydoc Dali::Internal::Adaptor:CoreEventInterface:::ProcessCoreEvents()
535 virtual void ProcessCoreEvents();
537 private: // From Dali::Internal::Adaptor::CoreEventInterface
540 * @copydoc Dali::Internal::Adaptor::CoreEventInterface::QueueCoreEvent()
542 virtual void QueueCoreEvent(const Dali::Integration::Event& event);
544 private: // From Dali::Integration::RenderController
547 * @copydoc Dali::Integration::RenderController::RequestUpdate()
549 virtual void RequestUpdate( bool forceUpdate );
552 * @copydoc Dali::Integration::RenderController::RequestProcessEventsOnIdle()
554 virtual void RequestProcessEventsOnIdle( bool forceProcess );
556 public: // From Dali::Internal::Adaptor::WindowVisibilityObserver
559 * Called when the window becomes fully or partially visible.
561 virtual void OnWindowShown();
564 * Called when the window is fully hidden.
566 virtual void OnWindowHidden();
568 private: // From Dali::Internal::Adaptor::DamageObserver
571 * @copydoc Dali::Internal::Adaptor::DamageObserver::OnDamaged()
573 void OnDamaged( const DamageArea& area );
578 Adaptor(const Adaptor&) = delete;
579 Adaptor& operator=(Adaptor&) = delete;
584 * Assigns the render surface to the adaptor
587 void SetSurface(Dali::RenderSurfaceInterface *surface);
590 * called after surface is created
592 void SurfaceInitialized();
595 * Sends an notification message from main loop idle handler
597 bool ProcessCoreEventsFromIdle();
600 * Gets path for data/resource storage.
601 * @param[out] path Path for data/resource storage
603 void GetDataStoragePath(std::string& path);
606 * Sets up system information if needs
608 void SetupSystemInformation();
611 * Adds a callback to be run when entering an idle state.
613 * A callback of the following type should be used:
617 * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
619 bool AddIdleEnterer( CallbackBase* callback, bool forceAdd );
622 * Removes a previously added the idle enterer callback.
624 void RemoveIdleEnterer( CallbackBase* callback );
630 * @param[in] window window handle
631 * @param[in] adaptor The public adaptor
632 * @param[in] surface A render surface can be one of the following
633 * - Pixmap, adaptor will use existing Pixmap to draw on to
634 * - Window, adaptor will use existing Window to draw on to
635 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
637 Adaptor( Dali::Integration::SceneHolder window, Dali::Adaptor& adaptor, Dali::RenderSurfaceInterface* surface, EnvironmentOptions* environmentOptions );
643 READY, ///< Initial state before Adaptor::Start is called.
644 RUNNING, ///< Adaptor is running.
645 PAUSED, ///< Adaptor has been paused.
646 PAUSED_WHILE_HIDDEN, ///< Adaptor is paused while window is hidden (& cannot be resumed until window is shown).
647 PAUSED_WHILE_INITIALIZING, ///< Adaptor is paused while application is initializing.
648 STOPPED, ///< Adaptor has been stopped.
651 // There is no weak handle for BaseHandle in DALi, but we can't ref count the window here,
652 // so we have to store the raw pointer.
653 using WindowContainer = std::vector<Dali::Internal::Adaptor::SceneHolder*>;
654 using ObserverContainer = std::vector<LifeCycleObserver*>;
658 AdaptorSignalType mResizedSignal; ///< Resized signal.
659 AdaptorSignalType mLanguageChangedSignal; ///< Language changed signal.
660 WindowCreatedSignalType mWindowCreatedSignal; ///< Window created signal.
662 Dali::Adaptor& mAdaptor; ///< Reference to public adaptor instance.
663 State mState; ///< Current state of the adaptor
664 Dali::Integration::Core* mCore; ///< Dali Core
665 ThreadController* mThreadController; ///< Controls the threads
667 GraphicsInterface* mGraphics; ///< Graphics interface
668 Dali::DisplayConnection* mDisplayConnection; ///< Display connection
669 WindowContainer mWindows; ///< A container of all the Windows that are currently created
671 TizenPlatform::TizenPlatformAbstraction* mPlatformAbstraction; ///< Platform abstraction
673 CallbackManager* mCallbackManager; ///< Used to install callbacks
674 bool mNotificationOnIdleInstalled; ///< whether the idle handler is installed to send an notification event
675 TriggerEventInterface* mNotificationTrigger; ///< Notification event trigger
676 FeedbackPluginProxy* mDaliFeedbackPlugin; ///< Used to access feedback support
677 FeedbackController* mFeedbackController; ///< Plays feedback effects for Dali-Toolkit UI Controls.
678 Dali::TtsPlayer mTtsPlayers[Dali::TtsPlayer::MODE_NUM]; ///< Provides TTS support
679 ObserverContainer mObservers; ///< A list of adaptor observer pointers
680 EnvironmentOptions* mEnvironmentOptions; ///< environment options
681 PerformanceInterface* mPerformanceInterface; ///< Performance interface
682 KernelTrace mKernelTracer; ///< Kernel tracer
683 SystemTrace mSystemTracer; ///< System tracer
684 TriggerEventFactory mTriggerEventFactory; ///< Trigger event factory
685 ObjectProfiler* mObjectProfiler; ///< Tracks object lifetime for profiling
686 SocketFactory mSocketFactory; ///< Socket factory
687 const bool mEnvironmentOptionsOwned:1; ///< Whether we own the EnvironmentOptions (and thus, need to delete it)
688 bool mUseRemoteSurface; ///< whether the remoteSurface is used or not
690 class AccessibilityObserver : public ConnectionTracker
693 void OnAccessibleKeyEvent( const KeyEvent& event );
695 AccessibilityObserver accessibilityObserver;
698 inline static Adaptor& GetImplementation(Dali::Adaptor& adaptor) { return *adaptor.mImpl; }
701 } // namespace Internal
703 } // namespace Adaptor
707 #endif // DALI_INTERNAL_ADAPTOR_IMPL_H