1 #ifndef DALI_INTERNAL_ADAPTOR_IMPL_H
2 #define DALI_INTERNAL_ADAPTOR_IMPL_H
5 * Copyright (c) 2018 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>
32 #include <dali/public-api/adaptor-framework/tts-player.h>
33 #include <dali/devel-api/adaptor-framework/clipboard.h>
35 #include <dali/internal/graphics/common/graphics-interface.h>
37 #include <dali/internal/legacy/common/tizen-platform-abstraction.h>
38 #include <dali/internal/adaptor/common/adaptor-internal-services.h>
39 #include <dali/internal/system/common/environment-options.h>
40 #include <dali/internal/system/common/core-event-interface.h>
41 #include <dali/internal/input/common/drag-and-drop-detector-impl.h>
42 #include <dali/internal/window-system/common/damage-observer.h>
43 #include <dali/internal/window-system/common/window-impl.h>
44 #include <dali/internal/window-system/common/window-visibility-observer.h>
45 #include <dali/internal/system/common/kernel-trace.h>
46 #include <dali/internal/system/common/system-trace.h>
47 #include <dali/integration-api/trigger-event-factory.h>
48 #include <dali/internal/network/common/socket-factory.h>
54 class RenderSurfaceInterface;
69 class DisplayConnection;
70 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;
85 * Implementation of the Adaptor class.
87 class Adaptor : public Integration::RenderController,
88 public AdaptorInternalServices,
89 public CoreEventInterface,
90 public DamageObserver,
91 public WindowVisibilityObserver
95 typedef Dali::Adaptor::AdaptorSignalType AdaptorSignalType;
97 typedef Uint16Pair SurfaceSize; ///< Surface size type
100 * Creates a New Adaptor
101 * @param[in] window The window handle
102 * @param[in] surface A render surface can be one of the following
103 * - Pixmap, adaptor will use existing Pixmap to draw on to
104 * - Window, adaptor will use existing Window to draw on to
105 * @param[in] configuration The context loss configuration ( to choose resource discard policy )
106 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
108 static Dali::Adaptor* New( Dali::Window window,
109 Dali::RenderSurfaceInterface* surface,
110 Dali::Configuration::ContextLoss configuration,
111 EnvironmentOptions* environmentOptions );
114 * Creates a New Adaptor
115 * @param[in] window The window handle
116 * @param[in] configuration The context loss configuration ( to choose resource discard policy )
117 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
119 static Dali::Adaptor* New( Dali::Window window,
120 Dali::Configuration::ContextLoss configuration,
121 EnvironmentOptions* environmentOptions );
124 * Creates a New Adaptor
125 * @param[in] graphicsFactory A factory that creates the graphics interface
126 * @param[in] window The window handle
127 * @param[in] surface A render surface can be one of the following
128 * - Pixmap, adaptor will use existing Pixmap to draw on to
129 * - Window, adaptor will use existing Window to draw on to
130 * @param[in] configuration The context loss configuration ( to choose resource discard policy )
131 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
133 static Dali::Adaptor* New( GraphicsFactory& graphicsFactory,
135 Dali::RenderSurfaceInterface* surface,
136 Dali::Configuration::ContextLoss configuration,
137 EnvironmentOptions* environmentOptions );
140 * Creates a New Adaptor
141 * @param[in] graphicsFactory A factory that creates the graphics interface
142 * @param[in] window The window handle
143 * @param[in] configuration The context loss configuration ( to choose resource discard policy )
144 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
146 static Dali::Adaptor* New( GraphicsFactory& graphicsFactory,
148 Dali::Configuration::ContextLoss configuration,
149 EnvironmentOptions* environmentOptions );
152 * 2-step initialisation, this should be called after creating an adaptor instance.
153 * @param[in] graphicsFactory A factory that creates the graphics interface
154 * @param[in] configuration The context loss configuration ( to choose resource discard policy )
156 void Initialize( GraphicsFactory& graphicsFactory, Dali::Configuration::ContextLoss configuration );
159 * Virtual destructor.
164 * @copydoc Dali::Adaptor::Get()
166 static Dali::Adaptor& Get();
169 * @copydoc Dali::Adaptor::IsAvailable()
171 static bool IsAvailable();
174 * @copydoc Dali::Core::SceneCreated();
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( WheelEvent& wheelEvent );
220 * @copydoc Dali::EventFeeder::FeedKeyEvent()
222 virtual void FeedKeyEvent( KeyEvent& keyEvent );
225 * @copydoc AdaptorInterface::ReplaceSurface()
227 virtual void ReplaceSurface( Dali::Window 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
254 * @param[in] childWindowName The child window title/name
255 * @param[in] childWindowClassName The class name that the child window belongs to
256 * @param[in] childWindowMode The mode of the child window
258 virtual bool AddWindow( Dali::Window* childWindow,
259 const std::string& childWindowName,
260 const std::string& childWindowClassName,
261 const bool& childWindowMode );
264 * Removes an existing Window instance from the Adaptor
265 * @param[in] window The Window instance
267 virtual bool RemoveWindow( Dali::Window* childWindow );
270 * Removes an existing Window instance from the Adaptor
271 * @param[in] windowName The Window name
272 * @note If two Windows have the same name, the first one that matches will be removed
274 virtual bool RemoveWindow( std::string childWindowName );
277 * @copydoc Dali::Adaptor::RemoveIdle()
279 virtual void RemoveIdle( CallbackBase* callback );
282 * Sets a pre-render callback.
284 void SetPreRenderCallback( CallbackBase* callback );
287 * Removes an existing Window instance from the Adaptor
288 * @param[in] childWindow The Window instance
290 bool RemoveWindow( Dali::Internal::Adaptor::Window* childWindow );
295 * @return the Core instance
297 virtual Dali::Integration::Core& GetCore();
300 * @copydoc Dali::Adaptor::SetRenderRefreshRate()
302 void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
305 * @copydoc Dali::Adaptor::SetUseHardwareVSync()
307 void SetUseHardwareVSync(bool useHardware);
310 * Return the PlatformAbstraction.
311 * @return The PlatformAbstraction.
313 Integration::PlatformAbstraction& GetPlatformAbstraction() const;
316 * Sets the Drag & Drop Listener.
317 * @param[in] detector The detector to send Drag & Drop events to.
319 void SetDragAndDropDetector( DragAndDropDetectorPtr detector );
322 * Destroy the TtsPlayer of specific mode.
323 * @param[in] mode The mode of TtsPlayer to destroy
325 void DestroyTtsPlayer(Dali::TtsPlayer::Mode mode);
328 * @brief Sets minimum distance in pixels that the fingers must move towards/away from each other in order to
329 * trigger a pinch gesture
331 * @param[in] distance The minimum pinch distance in pixels
333 void SetMinimumPinchDistance(float distance);
336 * Gets native window handle
338 * @return native window handle
340 Any GetNativeWindowHandle();
343 * Get the native display associated with the graphics backend
345 * @return A handle to the native display
347 Any GetGraphicsDisplay();
350 * Sets use remote surface for Surface output
351 * @param[in] useRemoteSurface True if the remote surface is used
353 void SetUseRemoteSurface(bool useRemoteSurface);
358 * Adds an adaptor observer so that we can observe the adaptor's lifetime events.
359 * @param[in] observer The observer.
360 * @note Observers should remove themselves when they are destroyed.
362 void AddObserver( LifeCycleObserver& observer );
365 * Removes the observer from the adaptor.
366 * @param[in] observer The observer to remove.
367 * @note Observers should remove themselves when they are destroyed.
369 void RemoveObserver( LifeCycleObserver& observer );
372 * Emits the Notification event to the Dali core.
374 void SendNotificationEvent();
377 * Request adaptor to update once
379 void RequestUpdateOnce();
382 * @copydoc Dali::Adaptor::NotifySceneCreated()
384 void NotifySceneCreated();
387 * @copydoc Dali::Adaptor::NotifyLanguageChanged()
389 void NotifyLanguageChanged();
392 * Gets AppId of current application
394 void GetAppId( std::string& appId );
397 * Informs core the surface size has changed
399 void SurfaceResizePrepare( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
402 * Informs ThreadController the surface size has changed
404 void SurfaceResizeComplete( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
407 * Sets layout direction of root by system language
408 * @param[in] locale System locale
410 void SetRootLayoutDirection( std::string locale );
413 * @copydoc Dali::Adaptor::RenderOnce
418 * @copydoc Dali::Adaptor::GetLogFactory
420 const LogFactoryInterface& GetLogFactory();
423 * @copydoc Dali::Adaptor::RegisterProcessor
425 void RegisterProcessor( Integration::Processor& processor );
428 * @coydoc Dali::Adaptor::UnregisterProcessor
430 void UnregisterProcessor( Integration::Processor& processor );
432 public: //AdaptorInternalServices
435 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPlatformAbstractionInterface()
437 virtual Dali::Integration::PlatformAbstraction& GetPlatformAbstractionInterface();
440 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetDisplayConnectionInterface()
442 virtual Dali::DisplayConnection& GetDisplayConnectionInterface();
445 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetGraphicsInterface()
447 virtual GraphicsInterface& GetGraphicsInterface();
450 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventInterface()
452 virtual TriggerEventInterface& GetProcessCoreEventsTrigger();
455 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventFactoryInterface()
457 virtual TriggerEventFactoryInterface& GetTriggerEventFactoryInterface();
460 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSocketFactoryInterface()
462 virtual SocketFactoryInterface& GetSocketFactoryInterface();
465 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetRenderSurfaceInterface()
467 virtual Dali::RenderSurfaceInterface* GetRenderSurfaceInterface();
470 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetVSyncMonitorInterface()
472 virtual VSyncMonitorInterface* GetVSyncMonitorInterface();
475 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPerformanceInterface()
477 virtual PerformanceInterface* GetPerformanceInterface();
480 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetKernelTraceInterface()
482 virtual TraceInterface& GetKernelTraceInterface();
485 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSystemTraceInterface()
487 virtual TraceInterface& GetSystemTraceInterface();
492 * @copydoc Dali::Adaptor::SignalResized
494 AdaptorSignalType& ResizedSignal()
496 return mResizedSignal;
500 * @copydoc Dali::Adaptor::LanguageChangedSignal
502 AdaptorSignalType& LanguageChangedSignal()
504 return mLanguageChangedSignal;
508 * Gets the gesture manager.
509 * @return The GestureManager
511 GestureManager* GetGestureManager() const
513 return mGestureManager;
516 private: // From Dali::Internal::Adaptor::CoreEventInterface
519 * @copydoc Dali::Internal::Adaptor::CoreEventInterface::QueueCoreEvent()
521 virtual void QueueCoreEvent(const Dali::Integration::Event& event);
524 * @copydoc Dali::Internal::Adaptor:CoreEventInterface:::ProcessCoreEvents()
526 virtual void ProcessCoreEvents();
528 private: // From Dali::Integration::RenderController
531 * @copydoc Dali::Integration::RenderController::RequestUpdate()
533 virtual void RequestUpdate( bool forceUpdate );
536 * @copydoc Dali::Integration::RenderController::RequestProcessEventsOnIdle()
538 virtual void RequestProcessEventsOnIdle( bool forceProcess );
540 private: // From Dali::Internal::Adaptor::WindowVisibilityObserver
543 * Called when the window becomes fully or partially visible.
545 virtual void OnWindowShown();
548 * Called when the window is fully hidden.
550 virtual void OnWindowHidden();
552 private: // From Dali::Internal::Adaptor::DamageObserver
555 * @copydoc Dali::Internal::Adaptor::DamageObserver::OnDamaged()
557 void OnDamaged( const DamageArea& area );
562 Adaptor(const Adaptor&) = delete;
563 Adaptor& operator=(Adaptor&) = delete;
568 * Assigns the render surface to the adaptor
571 void SetSurface(Dali::RenderSurfaceInterface *surface);
574 * called after surface is created
576 void SurfaceInitialized();
579 * Sends an notification message from main loop idle handler
581 bool ProcessCoreEventsFromIdle();
584 * Gets path for data/resource storage.
585 * @param[out] path Path for data/resource storage
587 void GetDataStoragePath(std::string& path);
590 * Sets up system information if needs
592 void SetupSystemInformation();
595 * Adds a callback to be run when entering an idle state.
597 * A callback of the following type should be used:
601 * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
603 bool AddIdleEnterer( CallbackBase* callback, bool forceAdd );
606 * Removes a previously added the idle enterer callback.
608 void RemoveIdleEnterer( CallbackBase* callback );
614 * @param[in] window window handle
615 * @param[in] adaptor The public adaptor
616 * @param[in] surface A render surface can be one of the following
617 * - Pixmap, adaptor will use existing Pixmap to draw on to
618 * - Window, adaptor will use existing Window to draw on to
619 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
621 Adaptor( Dali::Window window, Dali::Adaptor& adaptor, Dali::RenderSurfaceInterface* surface, EnvironmentOptions* environmentOptions );
627 READY, ///< Initial state before Adaptor::Start is called.
628 RUNNING, ///< Adaptor is running.
629 PAUSED, ///< Adaptor has been paused.
630 PAUSED_WHILE_HIDDEN, ///< Adaptor is paused while window is hidden (& cannot be resumed until window is shown).
631 STOPPED, ///< Adaptor has been stopped.
634 using WindowPtr = IntrusivePtr< Window >;
635 using WindowContainer = std::vector<WindowPtr>;
636 using ObserverContainer = std::vector<LifeCycleObserver*>;
640 AdaptorSignalType mResizedSignal; ///< Resized signal.
641 AdaptorSignalType mLanguageChangedSignal; ///< Language changed signal.
643 Dali::Adaptor& mAdaptor; ///< Reference to public adaptor instance.
644 State mState; ///< Current state of the adaptor
645 Dali::Integration::Core* mCore; ///< Dali Core
646 ThreadController* mThreadController; ///< Controls the threads
647 VSyncMonitor* mVSyncMonitor; ///< Monitors VSync events
649 GraphicsInterface* mGraphics; ///< Graphics interface
650 Dali::DisplayConnection* mDisplayConnection; ///< Display connection
651 WindowContainer mWindows; ///< A container of all the Windows that are currently created
653 TizenPlatform::TizenPlatformAbstraction* mPlatformAbstraction; ///< Platform abstraction
655 CallbackManager* mCallbackManager; ///< Used to install callbacks
656 bool mNotificationOnIdleInstalled; ///< whether the idle handler is installed to send an notification event
657 TriggerEventInterface* mNotificationTrigger; ///< Notification event trigger
658 GestureManager* mGestureManager; ///< Gesture manager
659 FeedbackPluginProxy* mDaliFeedbackPlugin; ///< Used to access feedback support
660 FeedbackController* mFeedbackController; ///< Plays feedback effects for Dali-Toolkit UI Controls.
661 Dali::TtsPlayer mTtsPlayers[Dali::TtsPlayer::MODE_NUM]; ///< Provides TTS support
662 ObserverContainer mObservers; ///< A list of adaptor observer pointers
663 DragAndDropDetectorPtr mDragAndDropDetector; ///< The Drag & Drop detector
664 EnvironmentOptions* mEnvironmentOptions; ///< environment options
665 PerformanceInterface* mPerformanceInterface; ///< Performance interface
666 KernelTrace mKernelTracer; ///< Kernel tracer
667 SystemTrace mSystemTracer; ///< System tracer
668 TriggerEventFactory mTriggerEventFactory; ///< Trigger event factory
669 ObjectProfiler* mObjectProfiler; ///< Tracks object lifetime for profiling
670 SocketFactory mSocketFactory; ///< Socket factory
671 const bool mEnvironmentOptionsOwned:1; ///< Whether we own the EnvironmentOptions (and thus, need to delete it)
672 bool mUseRemoteSurface; ///< whether the remoteSurface is used or not
675 inline static Adaptor& GetImplementation(Dali::Adaptor& adaptor) { return *adaptor.mImpl; }
678 } // namespace Internal
680 } // namespace Adaptor
684 #endif // DALI_INTERNAL_ADAPTOR_IMPL_H