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/public-api/adaptor-framework/tts-player.h>
32 #include <dali/devel-api/adaptor-framework/clipboard.h>
34 #include <dali/internal/legacy/common/tizen-platform-abstraction.h>
35 #include <dali/internal/adaptor/common/adaptor-internal-services.h>
36 #include <dali/internal/system/common/environment-options.h>
37 #include <dali/internal/system/common/core-event-interface.h>
38 #include <dali/internal/input/common/drag-and-drop-detector-impl.h>
39 #include <dali/internal/window-system/common/damage-observer.h>
40 #include <dali/internal/window-system/common/window-visibility-observer.h>
41 #include <dali/internal/system/common/kernel-trace.h>
42 #include <dali/internal/system/common/system-trace.h>
43 #include <dali/integration-api/trigger-event-factory.h>
44 #include <dali/internal/network/common/socket-factory.h>
66 class GlImplementation;
67 class GlSyncImplementation;
68 class ThreadController;
70 class CallbackManager;
71 class FeedbackPluginProxy;
72 class FeedbackController;
73 class RotationObserver;
75 class PerformanceInterface;
76 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 typedef Dali::Adaptor::AdaptorSignalType AdaptorSignalType;
92 typedef Uint16Pair SurfaceSize; ///< Surface size type
95 * Creates a New Adaptor
96 * @param[in] nativeWindow Native window handle
97 * @param[in] surface A render surface can be one of the following
98 * - Pixmap, adaptor will use existing Pixmap to draw on to
99 * - Window, adaptor will use existing Window to draw on to
100 * @param[in] configuration The context loss configuration ( to choose resource discard policy )
101 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
103 static Dali::Adaptor* New( Any nativeWindow,
104 RenderSurface* surface,
105 Dali::Configuration::ContextLoss configuration,
106 EnvironmentOptions* environmentOptions );
109 * Creates a New Adaptor
110 * @param[in] nativeWindow native window handle
111 * @param[in] configuration The context loss configuration ( to choose resource discard policy )
112 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
114 static Dali::Adaptor* New( Dali::Window window, Dali::Configuration::ContextLoss configuration, EnvironmentOptions* environmentOptions );
117 * 2-step initialisation, this should be called after creating an adaptor instance.
119 void Initialize(Dali::Configuration::ContextLoss configuration);
122 * Virtual destructor.
127 * @copydoc Dali::Adaptor::Get()
129 static Dali::Adaptor& Get();
132 * @copydoc Dali::Adaptor::IsAvailable()
134 static bool IsAvailable();
137 * @copydoc Dali::Core::SceneCreated();
141 public: // AdaptorInternalServices implementation
143 * @copydoc Dali::Adaptor::Start()
145 virtual void Start();
148 * @copydoc Dali::Adaptor::Pause()
150 virtual void Pause();
153 * @copydoc Dali::Adaptor::Resume()
155 virtual void Resume();
158 * @copydoc Dali::Adaptor::Stop()
163 * @copydoc Dali::Adaptor::ContextLost()
165 virtual void ContextLost();
168 * @copydoc Dali::Adaptor::ContextRegained()
170 virtual void ContextRegained();
173 * @copydoc Dali::EventFeeder::FeedTouchPoint()
175 virtual void FeedTouchPoint( TouchPoint& point, int timeStamp );
178 * @copydoc Dali::EventFeeder::FeedWheelEvent()
180 virtual void FeedWheelEvent( WheelEvent& wheelEvent );
183 * @copydoc Dali::EventFeeder::FeedKeyEvent()
185 virtual void FeedKeyEvent( KeyEvent& keyEvent );
188 * @copydoc AdaptorInterface::ReplaceSurface()
190 virtual void ReplaceSurface( Any nativeWindow, RenderSurface& surface );
193 * @copydoc Dali::Adaptor::GetSurface()
195 virtual RenderSurface& GetSurface() const;
198 * @copydoc Dali::Adaptor::ReleaseSurfaceLock()
200 virtual void ReleaseSurfaceLock();
203 * Retrieve the TtsPlayer.
204 * @param[in] mode The mode of TtsPlayer
205 * @return A handle to the TtsPlayer.
207 virtual Dali::TtsPlayer GetTtsPlayer(Dali::TtsPlayer::Mode mode);
210 * @copydoc Dali::Adaptor::AddIdle()
212 virtual bool AddIdle( CallbackBase* callback, bool hasReturnValue, bool forceAdd );
215 * @copydoc Dali::Adaptor::RemoveIdle()
217 virtual void RemoveIdle( CallbackBase* callback );
220 * Sets a pre-render callback.
222 void SetPreRenderCallback( CallbackBase* callback );
227 * @return the Core instance
229 virtual Dali::Integration::Core& GetCore();
232 * @copydoc Dali::Adaptor::SetRenderRefreshRate()
234 void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
237 * @copydoc Dali::Adaptor::SetUseHardwareVSync()
239 void SetUseHardwareVSync(bool useHardware);
242 * @return reference to EglFactory class
244 EglFactory& GetEGLFactory() const;
247 * Return GlAbstraction.
248 * @return the GlAbstraction.
250 Integration::GlAbstraction& GetGlAbstraction() const;
253 * Return the PlatformAbstraction.
254 * @return The PlatformAbstraction.
256 Integration::PlatformAbstraction& GetPlatformAbstraction() const;
259 * Sets the Drag & Drop Listener.
260 * @param[in] detector The detector to send Drag & Drop events to.
262 void SetDragAndDropDetector( DragAndDropDetectorPtr detector );
265 * Sets a rotation observer, or set to NULL to remove.
266 * @pre Adaptor::Start() has been called ( to create EventHandler )
267 * @param[in] observer The observer to listen for window rotation events
269 void SetRotationObserver( RotationObserver* observer );
272 * Destroy the TtsPlayer of sepcific mode.
273 * @param[in] mode The mode of TtsPlayer to destroy
275 void DestroyTtsPlayer(Dali::TtsPlayer::Mode mode);
278 * @brief Sets minimum distance in pixels that the fingers must move towards/away from each other in order to
279 * trigger a pinch gesture
281 * @param[in] distance The minimum pinch distance in pixels
283 void SetMinimumPinchDistance(float distance);
286 * Gets native window handle
288 * @return native window handle
290 Any GetNativeWindowHandle();
293 * Get the native display associated with the graphics backend
295 * @return A handle to the native display
297 Any GetGraphicsDisplay();
300 * Sets use remote surface for eglSurface output
301 * @param[in] useRemoteSurface True if the remote surface is used
303 void SetUseRemoteSurface(bool useRemoteSurface);
308 * Adds an adaptor observer so that we can observe the adaptor's lifetime events.
309 * @param[in] observer The observer.
310 * @note Observers should remove themselves when they are destroyed.
312 void AddObserver( LifeCycleObserver& observer );
315 * Removes the observer from the adaptor.
316 * @param[in] observer The observer to remove.
317 * @note Observers should remove themselves when they are destroyed.
319 void RemoveObserver( LifeCycleObserver& observer );
322 * Emits the Notification event to the Dali core.
324 void SendNotificationEvent();
327 * Request adaptor to update once
329 void RequestUpdateOnce();
332 * Request adaptor to update indicator's height
334 void IndicatorSizeChanged(int height);
337 * @copydoc Dali::Adaptor::NotifySceneCreated()
339 void NotifySceneCreated();
342 * @copydoc Dali::Adaptor::NotifyLanguageChanged()
344 void NotifyLanguageChanged();
347 * Gets AppId of current application
349 void GetAppId( std::string& appId );
352 * Informs core the surface size has changed
354 void SurfaceResizePrepare( SurfaceSize surfaceSize );
357 * Informs ThreadController the surface size has changed
359 void SurfaceResizeComplete( SurfaceSize surfaceSize );
362 * Sets layout direction of root by system language
363 * @param[in] locale System locale
365 void SetRootLayoutDirection( std::string locale );
368 * @copydoc Dali::Adaptor::RenderOnce
373 * @copydoc Dali::Adaptor::GetLogFactory
375 const LogFactoryInterface& GetLogFactory();
377 public: //AdaptorInternalServices
380 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPlatformAbstractionInterface()
382 virtual Dali::Integration::PlatformAbstraction& GetPlatformAbstractionInterface();
385 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetGlesInterface()
387 virtual Dali::Integration::GlAbstraction& GetGlesInterface();
390 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetEGLFactoryInterface()
392 virtual EglFactoryInterface& GetEGLFactoryInterface() const;
395 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventInterface()
397 virtual TriggerEventInterface& GetProcessCoreEventsTrigger();
400 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventFactoryInterface()
402 virtual TriggerEventFactoryInterface& GetTriggerEventFactoryInterface();
405 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSocketFactoryInterface()
407 virtual SocketFactoryInterface& GetSocketFactoryInterface();
410 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetRenderSurfaceInterface()
412 virtual RenderSurface* GetRenderSurfaceInterface();
415 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetVSyncMonitorInterface()
417 virtual VSyncMonitorInterface* GetVSyncMonitorInterface();
420 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPerformanceInterface()
422 virtual PerformanceInterface* GetPerformanceInterface();
425 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetKernelTraceInterface()
427 virtual TraceInterface& GetKernelTraceInterface();
430 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSystemTraceInterface()
432 virtual TraceInterface& GetSystemTraceInterface();
434 public: // Stereoscopy
437 * @copydoc Dali::Integration::Core::SetViewMode()
439 void SetViewMode( ViewMode viewMode );
442 * @copydoc Dali::Integration::Core::GetViewMode()
444 ViewMode GetViewMode() const;
447 * @copydoc Dali::Integration::Core::SetStereoBase()
449 void SetStereoBase( float stereoBase );
452 * @copydoc Dali::Integration::Core::GetStereoBase()
454 float GetStereoBase() const;
459 * @copydoc Dali::Adaptor::SignalResized
461 AdaptorSignalType& ResizedSignal()
463 return mResizedSignal;
467 * @copydoc Dali::Adaptor::LanguageChangedSignal
469 AdaptorSignalType& LanguageChangedSignal()
471 return mLanguageChangedSignal;
474 private: // From Dali::Internal::Adaptor::CoreEventInterface
477 * @copydoc Dali::Internal::Adaptor::CoreEventInterface::QueueCoreEvent()
479 virtual void QueueCoreEvent(const Dali::Integration::Event& event);
482 * @copydoc Dali::Internal::Adaptor:CoreEventInterface:::ProcessCoreEvents()
484 virtual void ProcessCoreEvents();
486 private: // From Dali::Integration::RenderController
489 * @copydoc Dali::Integration::RenderController::RequestUpdate()
491 virtual void RequestUpdate( bool forceUpdate );
494 * @copydoc Dali::Integration::RenderController::RequestProcessEventsOnIdle()
496 virtual void RequestProcessEventsOnIdle( bool forceProcess );
498 private: // From Dali::Internal::Adaptor::WindowVisibilityObserver
501 * Called when the window becomes fully or partially visible.
503 virtual void OnWindowShown();
506 * Called when the window is fully hidden.
508 virtual void OnWindowHidden();
510 private: // From Dali::Internal::Adaptor::DamageObserver
513 * @copydoc Dali::Internal::Adaptor::DamageObserver::OnDamaged()
515 void OnDamaged( const DamageArea& area );
520 Adaptor(const Adaptor&);
521 Adaptor& operator=(Adaptor&);
526 * Assigns the render surface to the adaptor
529 void SetSurface(RenderSurface *surface);
532 * called after surface is created
534 void SurfaceInitialized();
537 * Sends an notification message from main loop idle handler
539 bool ProcessCoreEventsFromIdle();
542 * Gets path for data/resource storage.
543 * @param[out] path Path for data/resource storage
545 void GetDataStoragePath(std::string& path);
548 * Sets up system information if needs
550 void SetupSystemInformation();
553 * Adds a callback to be run when entering an idle state.
555 * A callback of the following type should be used:
559 * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
561 bool AddIdleEnterer( CallbackBase* callback, bool forceAdd );
564 * Removes a previously added the idle enterer callback.
566 void RemoveIdleEnterer( CallbackBase* callback );
572 * @param[in] nativeWindow native window handle
573 * @param[in] adaptor The public adaptor
574 * @param[in] surface A render surface can be one of the following
575 * - Pixmap, adaptor will use existing Pixmap to draw on to
576 * - Window, adaptor will use existing Window to draw on to
577 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
579 Adaptor( Any nativeWindow, Dali::Adaptor& adaptor, RenderSurface* surface, EnvironmentOptions* environmentOptions );
585 READY, ///< Initial state before Adaptor::Start is called.
586 RUNNING, ///< Adaptor is running.
587 PAUSED, ///< Adaptor has been paused.
588 PAUSED_WHILE_HIDDEN, ///< Adaptor is paused while window is hidden (& cannot be resumed until window is shown).
589 STOPPED, ///< Adaptor has been stopped.
592 typedef std::vector<LifeCycleObserver*> ObserverContainer;
596 AdaptorSignalType mResizedSignal; ///< Resized signal.
597 AdaptorSignalType mLanguageChangedSignal; ///< Language changed signal.
599 Dali::Adaptor& mAdaptor; ///< Reference to public adaptor instance.
600 State mState; ///< Current state of the adaptor
601 Dali::Integration::Core* mCore; ///< Dali Core
602 ThreadController* mThreadController; ///< Controls the threads
603 VSyncMonitor* mVSyncMonitor; ///< Monitors VSync events
604 GlImplementation* mGLES; ///< GL implementation
605 GlSyncImplementation* mGlSync; ///< GL Sync implementation
606 EglFactory* mEglFactory; ///< EGL Factory
608 Any mNativeWindow; ///< window identifier
609 RenderSurface* mSurface; ///< Current surface
610 TizenPlatform::TizenPlatformAbstraction* mPlatformAbstraction; ///< Platform abstraction
612 EventHandler* mEventHandler; ///< event handler
613 CallbackManager* mCallbackManager; ///< Used to install callbacks
614 bool mNotificationOnIdleInstalled; ///< whether the idle handler is installed to send an notification event
615 TriggerEventInterface* mNotificationTrigger; ///< Notification event trigger
616 GestureManager* mGestureManager; ///< Gesture manager
617 FeedbackPluginProxy* mDaliFeedbackPlugin; ///< Used to access feedback support
618 FeedbackController* mFeedbackController; ///< Plays feedback effects for Dali-Toolkit UI Controls.
619 Dali::TtsPlayer mTtsPlayers[Dali::TtsPlayer::MODE_NUM]; ///< Provides TTS support
620 ObserverContainer mObservers; ///< A list of adaptor observer pointers
621 DragAndDropDetectorPtr mDragAndDropDetector; ///< The Drag & Drop detector
622 RotationObserver* mDeferredRotationObserver; ///< deferred Rotation observer needs event handler
623 EnvironmentOptions* mEnvironmentOptions; ///< environment options
624 PerformanceInterface* mPerformanceInterface; ///< Performance interface
625 KernelTrace mKernelTracer; ///< Kernel tracer
626 SystemTrace mSystemTracer; ///< System tracer
627 TriggerEventFactory mTriggerEventFactory; ///< Trigger event factory
628 ObjectProfiler* mObjectProfiler; ///< Tracks object lifetime for profiling
629 SocketFactory mSocketFactory; ///< Socket factory
630 const bool mEnvironmentOptionsOwned:1; ///< Whether we own the EnvironmentOptions (and thus, need to delete it)
631 bool mUseRemoteSurface; ///< whether the remoteSurface is used or not
633 inline static Adaptor& GetImplementation(Dali::Adaptor& adaptor) {return *adaptor.mImpl;}
636 } // namespace Internal
638 } // namespace Adaptor
642 #endif // __DALI_INTERNAL_ADAPTOR_IMPL_H__