1 #ifndef __DALI_INTERNAL_ADAPTOR_IMPL_H__
2 #define __DALI_INTERNAL_ADAPTOR_IMPL_H__
5 * Copyright (c) 2014 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/integration-api/render-controller.h>
30 #include <render-surface.h>
31 #include <tts-player.h>
32 #include <imf-manager.h>
33 #include <device-layout.h>
34 #include <clipboard.h>
36 #include <tizen-platform-abstraction.h>
37 #include <base/interfaces/adaptor-internal-services.h>
38 #include <base/environment-options.h>
39 #include <base/core-event-interface.h>
40 #include <drag-and-drop-detector-impl.h>
41 #include <damage-observer.h>
42 #include <window-visibility-observer.h>
43 #include <kernel-trace.h>
44 #include <trigger-event-factory.h>
45 #include <networking/socket-factory.h>
66 class GlImplementation;
67 class GlSyncImplementation;
68 class UpdateRenderController;
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;
93 * Creates a New Adaptor
94 * @param[in] nativeWindow native window handle
95 * @param[in] surface A render surface can be one of the following
96 * - Pixmap, adaptor will use existing Pixmap to draw on to
97 * - Window, adaptor will use existing Window to draw on to
98 * @param[in] baseLayout The base layout that the application has been written for
99 * @param[in] configuration The context loss configuration ( to choose resource discard policy )
101 static Dali::Adaptor* New( Any nativeWindow,
102 RenderSurface* surface,
103 const DeviceLayout& baseLayout,
104 Dali::Configuration::ContextLoss configuration );
107 * 2-step initialisation, this should be called after creating an adaptor instance.
109 void Initialize(Dali::Configuration::ContextLoss configuration);
112 * Virtual destructor.
117 * @copydoc Dali::Adaptor::Get()
119 static Dali::Adaptor& Get();
122 * @copydoc Dali::Adaptor::IsAvailable()
124 static bool IsAvailable();
126 public: // AdaptorInternalServices implementation
128 * @copydoc Dali::Adaptor::Start()
130 virtual void Start();
133 * @copydoc Dali::Adaptor::Pause()
135 virtual void Pause();
138 * @copydoc Dali::Adaptor::Resume()
140 virtual void Resume();
143 * @copydoc Dali::Adaptor::Stop()
148 * @copydoc Dali::EventFeeder::FeedTouchPoint()
150 virtual void FeedTouchPoint( TouchPoint& point, int timeStamp );
153 * @copydoc Dali::EventFeeder::FeedWheelEvent()
155 virtual void FeedWheelEvent( MouseWheelEvent& wheelEvent );
158 * @copydoc Dali::EventFeeder::FeedKeyEvent()
160 virtual void FeedKeyEvent( KeyEvent& keyEvent );
163 * @copydoc AdaptorInterface::MoveResize()
165 virtual bool MoveResize( const PositionSize& positionSize );
168 * @copydoc AdaptorInterface::SurfaceResized()
170 virtual void SurfaceResized( const PositionSize& positionSize );
173 * @copydoc AdaptorInterface::ReplaceSurface()
175 virtual void ReplaceSurface( Any nativeWindow, RenderSurface& surface );
178 * @copydoc Dali::Adaptor::GetSurface()
180 virtual RenderSurface& GetSurface() const;
183 * @copydoc Dali::Adaptor::ReleaseSurfaceLock()
185 virtual void ReleaseSurfaceLock();
188 * Retrieve the TtsPlayer.
189 * @param[in] mode The mode of TtsPlayer
190 * @return A handle to the TtsPlayer.
192 virtual Dali::TtsPlayer GetTtsPlayer(Dali::TtsPlayer::Mode mode);
195 * @copydoc Dali::Adaptor::AddIdle()
197 virtual bool AddIdle( CallbackBase* callback );
200 * @copydoc Internal::Framework::CallFromMainLoop()
202 virtual bool CallFromMainLoop( CallbackBase* callback );
207 * @return the Core instance
209 virtual Dali::Integration::Core& GetCore();
212 * @copydoc Dali::Adaptor::SetRenderRefreshRate()
214 void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
217 * @copydoc Dali::Adaptor::SetUseHardwareVSync()
219 void SetUseHardwareVSync(bool useHardware);
223 * Primarily for host/simulation testing
224 * @param[in] hDpi The Horizontal DPI
225 * @param[in] vDpi The Vertical DPI
227 void SetDpi(size_t hDpi, size_t vDpi);
230 * @return reference to EglFactory class
232 EglFactory& GetEGLFactory() const;
235 * Return GlAbstraction.
236 * @return the GlAbstraction.
238 Integration::GlAbstraction& GetGlAbstraction() const;
241 * Return the PlatformAbstraction.
242 * @return The PlatformAbstraction.
244 Integration::PlatformAbstraction& GetPlatformAbstraction() const;
247 * Sets the Drag & Drop Listener.
248 * @param[in] detector The detector to send Drag & Drop events to.
250 void SetDragAndDropDetector( DragAndDropDetectorPtr detector );
253 * Sets a rotation observer, or set to NULL to remove.
254 * @pre Adaptor::Start() has been called ( to create EventHandler )
255 * @param[in] observer The observer to listen for window rotation events
257 void SetRotationObserver( RotationObserver* observer );
260 * Destroy the TtsPlayer of sepcific mode.
261 * @param[in] mode The mode of TtsPlayer to destroy
263 void DestroyTtsPlayer(Dali::TtsPlayer::Mode mode);
266 * @brief Sets minimum distance in pixels that the fingers must move towards/away from each other in order to
267 * trigger a pinch gesture
269 * @param[in] distance The minimum pinch distance in pixels
271 void SetMinimumPinchDistance(float distance);
274 * Gets native window handle
276 * @return native window handle
278 Any GetNativeWindowHandle();
283 * Adds an adaptor observer so that we can observe the adaptor's lifetime events.
284 * @param[in] observer The observer.
285 * @note Observers should remove themselves when they are destroyed.
287 void AddObserver( LifeCycleObserver& observer );
290 * Removes the observer from the adaptor.
291 * @param[in] observer The observer to remove.
292 * @note Observers should remove themselves when they are destroyed.
294 void RemoveObserver( LifeCycleObserver& observer );
297 * Emits the Notification event to the Dali core.
299 void SendNotificationEvent();
302 * Request adaptor to update once
304 void RequestUpdateOnce();
307 * @copydoc Dali::Adaptor::NotifyLanguageChanged()
309 void NotifyLanguageChanged();
311 public: //AdaptorInternalServices
314 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPlatformAbstractionInterface()
316 virtual Dali::Integration::PlatformAbstraction& GetPlatformAbstractionInterface();
319 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetGlesInterface()
321 virtual Dali::Integration::GlAbstraction& GetGlesInterface();
324 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetEGLFactoryInterface()
326 virtual EglFactoryInterface& GetEGLFactoryInterface() const;
329 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventInterface()
331 virtual TriggerEventInterface& GetTriggerEventInterface();
334 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventFactoryInterface()
336 virtual TriggerEventFactoryInterface& GetTriggerEventFactoryInterface();
339 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSocketFactoryInterface()
341 virtual SocketFactoryInterface& GetSocketFactoryInterface();
344 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetRenderSurfaceInterface()
346 virtual RenderSurface* GetRenderSurfaceInterface();
349 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetVSyncMonitorInterface()
351 virtual VSyncMonitorInterface* GetVSyncMonitorInterface();
354 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPerformanceInterface()
356 virtual PerformanceInterface* GetPerformanceInterface();
359 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetKernelTraceInterface()
361 virtual KernelTraceInterface& GetKernelTraceInterface();
363 public: // Stereoscopy
366 * @copydoc Dali::Integration::Core::SetViewMode()
368 void SetViewMode( ViewMode viewMode );
371 * @copydoc Dali::Integration::Core::GetViewMode()
373 ViewMode GetViewMode() const;
376 * @copydoc Dali::Integration::Core::SetStereoBase()
378 void SetStereoBase( float stereoBase );
381 * @copydoc Dali::Integration::Core::GetStereoBase()
383 float GetStereoBase() const;
388 * @copydoc Dali::Adaptor::SignalResized
390 AdaptorSignalType& ResizedSignal()
392 return mResizedSignal;
396 * @copydoc Dali::Adaptor::LanguageChangedSignal
398 AdaptorSignalType& LanguageChangedSignal()
400 return mLanguageChangedSignal;
403 private: // From Dali::Internal::Adaptor::CoreEventInterface
406 * @copydoc Dali::Internal::Adaptor::CoreEventInterface::QueueCoreEvent()
408 virtual void QueueCoreEvent(const Dali::Integration::Event& event);
411 * @copydoc Dali::Internal::Adaptor:CoreEventInterface:::ProcessCoreEvents()
413 virtual void ProcessCoreEvents();
415 private: // From Dali::Integration::RenderController
418 * Called by the Dali core when it requires another update
420 virtual void RequestUpdate();
423 * Called by Dali core when it requires an notification event being sent on idle.
424 * Multi-threading note: this method must be called from the main thread only.
426 virtual void RequestProcessEventsOnIdle();
428 private: // From Dali::Internal::Adaptor::WindowVisibilityObserver
431 * Called when the window becomes fully or partially visible.
433 virtual void OnWindowShown();
436 * Called when the window is fully hidden.
438 virtual void OnWindowHidden();
440 private: // From Dali::Internal::Adaptor::DamageObserver
443 * @copydoc Dali::Internal::Adaptor::DamageObserver::OnDamaged()
445 void OnDamaged( const DamageArea& area );
450 Adaptor(const Adaptor&);
451 Adaptor& operator=(Adaptor&);
456 * Helper to parse log options
458 void ParseEnvironmentOptions();
461 * Informs core the surface size has changed
463 void SurfaceSizeChanged(const PositionSize& positionSize);
466 * Assigns the render surface to the adaptor
469 void SetSurface(RenderSurface *surface);
472 * Sends an notification message from main loop idle handler
474 void ProcessCoreEventsFromIdle();
477 * Gets path for data/resource storage.
478 * @param[out] path Path for data/resource storage
480 void GetDataStoragePath(std::string& path);
486 * @param[in] nativeWindow native window handle
487 * @param[in] adaptor The public adaptor
488 * @param[in] surface A render surface can be one of the following
489 * - Pixmap, adaptor will use existing Pixmap to draw on to
490 * - Window, adaptor will use existing Window to draw on to
491 * @param[in] baseLayout The base layout that the application has been written for
493 Adaptor( Any nativeWindow, Dali::Adaptor& adaptor, RenderSurface* surface, const DeviceLayout& baseLayout );
499 READY, ///< Initial state before Adaptor::Start is called.
500 RUNNING, ///< Adaptor is running.
501 PAUSED, ///< Adaptor has been paused.
502 PAUSED_WHILE_HIDDEN, ///< Adaptor is paused while window is hidden (& cannot be resumed until window is shown).
503 STOPPED, ///< Adaptor has been stopped.
506 typedef std::vector<LifeCycleObserver*> ObserverContainer;
510 AdaptorSignalType mResizedSignal; ///< Resized signal.
511 AdaptorSignalType mLanguageChangedSignal; ///< Language changed signal.
513 Dali::Adaptor& mAdaptor; ///< Reference to public adaptor instance.
514 State mState; ///< Current state of the adaptor
515 Dali::Integration::Core* mCore; ///< Dali Core
516 UpdateRenderController* mUpdateRenderController; ///< Controls update/render threads
517 VSyncMonitor* mVSyncMonitor; ///< Monitors VSync events
518 GlImplementation* mGLES; ///< GL implementation
519 GlSyncImplementation* mGlSync; ///< GL Sync implementation
520 EglFactory* mEglFactory; ///< EGL Factory
522 Any mNativeWindow; ///< window identifier
523 RenderSurface* mSurface; ///< Current surface
524 TizenPlatform::TizenPlatformAbstraction* mPlatformAbstraction; ///< Platform abstraction
526 EventHandler* mEventHandler; ///< event handler
527 CallbackManager* mCallbackManager; ///< Used to install callbacks
528 bool mNotificationOnIdleInstalled; ///< whether the idle handler is installed to send an notification event
529 TriggerEvent* mNotificationTrigger; ///< Notification event trigger
530 GestureManager* mGestureManager; ///< Gesture manager
531 size_t mHDpi; ///< Override horizontal DPI
532 size_t mVDpi; ///< Override vertical DPI
533 FeedbackPluginProxy* mDaliFeedbackPlugin; ///< Used to access feedback support
534 FeedbackController* mFeedbackController; ///< Plays feedback effects for Dali-Toolkit UI Controls.
535 Dali::TtsPlayer mTtsPlayers[Dali::TtsPlayer::MODE_NUM]; ///< Provides TTS support
536 ObserverContainer mObservers; ///< A list of adaptor observer pointers
537 DragAndDropDetectorPtr mDragAndDropDetector; ///< The Drag & Drop detector
538 RotationObserver* mDeferredRotationObserver; ///< deferred Rotation observer needs event handler
539 DeviceLayout mBaseLayout; ///< The base layout of the application
540 EnvironmentOptions mEnvironmentOptions; ///< environment options
541 PerformanceInterface* mPerformanceInterface; ///< Performance interface
542 KernelTrace mKernelTracer; ///< Kernel tracer
543 TriggerEventFactory mTriggerEventFactory; ///< Trigger event factory
544 ObjectProfiler* mObjectProfiler; ///< Tracks object lifetime for profiling
545 SocketFactory mSocketFactory; ///< Socket factory
547 inline static Adaptor& GetImplementation(Dali::Adaptor& adaptor) {return *adaptor.mImpl;}
550 } // namespace Internal
552 } // namespace Adaptor
556 #endif // __DALI_INTERNAL_ADAPTOR_IMPL_H__