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 <boost/bind.hpp>
23 #include <boost/function.hpp>
24 #include <boost/thread.hpp>
27 #include <dali/public-api/common/vector-wrapper.h>
28 #include <dali/public-api/common/view-mode.h>
29 #include <dali/public-api/math/rect.h>
30 #include <dali/integration-api/render-controller.h>
33 #include <render-surface.h>
34 #include <tts-player.h>
35 #include <imf-manager.h>
36 #include <device-layout.h>
37 #include <clipboard.h>
39 #include <slp-platform-abstraction.h>
40 #include <base/interfaces/adaptor-internal-services.h>
41 #include <base/environment-options.h>
42 #include <base/core-event-interface.h>
43 #include <drag-and-drop-detector-impl.h>
44 #include <damage-observer.h>
45 #include <window-visibility-observer.h>
46 #include <kernel-trace.h>
47 #include <trigger-event-factory.h>
66 class GlImplementation;
67 class GlSyncImplementation;
69 class UpdateRenderController;
71 class CallbackManager;
72 class FeedbackPluginProxy;
73 class FeedbackController;
74 class RotationObserver;
76 class PerformanceInterface;
77 class LifeCycleObserver;
81 * Implementation of the Adaptor class.
83 class Adaptor : public Integration::RenderController,
84 public AdaptorInternalServices,
85 public CoreEventInterface,
86 public DamageObserver,
87 public WindowVisibilityObserver
91 typedef Dali::Adaptor::AdaptorSignalType AdaptorSignalType;
94 * Creates a New Adaptor
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( RenderSurface* surface,
102 const DeviceLayout& baseLayout,
103 Dali::Configuration::ContextLoss configuration );
106 * 2-step initialisation, this should be called after creating an adaptor instance.
108 void Initialize(Dali::Configuration::ContextLoss configuration);
111 * Virtual destructor.
116 * @copydoc Dali::Adaptor::Get()
118 static Dali::Adaptor& Get();
121 * @copydoc Dali::Adaptor::IsAvailable()
123 static bool IsAvailable();
125 public: // AdaptorInternalServices implementation
127 * @copydoc Dali::Adaptor::Start()
129 virtual void Start();
132 * @copydoc Dali::Adaptor::Pause()
134 virtual void Pause();
137 * @copydoc Dali::Adaptor::Resume()
139 virtual void Resume();
142 * @copydoc Dali::Adaptor::Stop()
147 * @copydoc Dali::EventFeeder::FeedTouchPoint()
149 virtual void FeedTouchPoint( TouchPoint& point, int timeStamp );
152 * @copydoc Dali::EventFeeder::FeedWheelEvent()
154 virtual void FeedWheelEvent( MouseWheelEvent& wheelEvent );
157 * @copydoc Dali::EventFeeder::FeedKeyEvent()
159 virtual void FeedKeyEvent( KeyEvent& keyEvent );
162 * @copydoc AdaptorInterface::MoveResize()
164 virtual bool MoveResize( const PositionSize& positionSize );
167 * @copydoc AdaptorInterface::SurfaceResized()
169 virtual void SurfaceResized( const PositionSize& positionSize );
172 * @copydoc AdaptorInterface::ReplaceSurface()
174 virtual void ReplaceSurface( Dali::RenderSurface& surface );
177 * @copydoc Dali::Adaptor::GetSurface()
179 virtual Dali::RenderSurface& GetSurface() const;
182 * @copydoc Dali::Adaptor::ReleaseSurfaceLock()
184 virtual void ReleaseSurfaceLock();
187 * Retrieve the TtsPlayer.
188 * @param[in] mode The mode of TtsPlayer
189 * @return A handle to the TtsPlayer.
191 virtual Dali::TtsPlayer GetTtsPlayer(Dali::TtsPlayer::Mode mode);
194 * @copydoc Dali::Adaptor::AddIdle()
196 virtual bool AddIdle( boost::function<void(void)> callBack );
199 * @copydoc Internal::Framework::CallFromMainLoop()
201 virtual bool CallFromMainLoop(boost::function<void(void)> callBack);
206 * @return the Core instance
208 virtual Dali::Integration::Core& GetCore();
211 * @copydoc Dali::Adaptor::SetRenderRefreshRate()
213 void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
216 * @copydoc Dali::Adaptor::SetUseHardwareVSync()
218 void SetUseHardwareVSync(bool useHardware);
222 * Primarily for host/simulation testing
223 * @param[in] hDpi The Horizontal DPI
224 * @param[in] vDpi The Vertical DPI
226 void SetDpi(size_t hDpi, size_t vDpi);
229 * @return reference to EglFactory class
231 EglFactory& GetEGLFactory() const;
234 * Return GlAbstraction.
235 * @return the GlAbstraction.
237 Integration::GlAbstraction& GetGlAbstraction() const;
240 * Return the PlatformAbstraction.
241 * @return The PlatformAbstraction.
243 Integration::PlatformAbstraction& GetPlatformAbstraction() const;
246 * Sets the Drag & Drop Listener.
247 * @param[in] detector The detector to send Drag & Drop events to.
249 void SetDragAndDropDetector( DragAndDropDetectorPtr detector );
252 * Sets a rotation observer, or set to NULL to remove.
253 * @pre Adaptor::Start() has been called ( to create EventHandler )
254 * @param[in] observer The observer to listen for window rotation events
256 void SetRotationObserver( RotationObserver* observer );
259 * Destroy the TtsPlayer of sepcific mode.
260 * @param[in] mode The mode of TtsPlayer to destroy
262 void DestroyTtsPlayer(Dali::TtsPlayer::Mode mode);
265 * @brief Sets minimum distance in pixels that the fingers must move towards/away from each other in order to
266 * trigger a pinch gesture
268 * @param[in] distance The minimum pinch distance in pixels
270 void SetMinimumPinchDistance(float distance);
275 * Adds an adaptor observer so that we can observe the adaptor's lifetime events.
276 * @param[in] observer The observer.
277 * @note Observers should remove themselves when they are destroyed.
279 void AddObserver( LifeCycleObserver& observer );
282 * Removes the observer from the adaptor.
283 * @param[in] observer The observer to remove.
284 * @note Observers should remove themselves when they are destroyed.
286 void RemoveObserver( LifeCycleObserver& observer );
289 * Emits the Notification event to the Dali core.
291 void SendNotificationEvent();
294 * Request adaptor to update once
296 void RequestUpdateOnce();
299 * @copydoc Dali::Adaptor::NotifyLanguageChanged()
301 void NotifyLanguageChanged();
303 public: //AdaptorInternalServices
306 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPlatformAbstractionInterface()
308 virtual Dali::Integration::PlatformAbstraction& GetPlatformAbstractionInterface();
311 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetGlesInterface()
313 virtual Dali::Integration::GlAbstraction& GetGlesInterface();
316 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetEGLFactoryInterface()
318 virtual EglFactoryInterface& GetEGLFactoryInterface() const;
321 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventInterface()
323 virtual TriggerEventInterface& GetTriggerEventInterface();
326 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventFactoryInterface()
328 virtual TriggerEventFactoryInterface& GetTriggerEventFactoryInterface();
331 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetRenderSurfaceInterface()
333 virtual RenderSurface* GetRenderSurfaceInterface();
336 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetVSyncMonitorInterface()
338 virtual VSyncMonitorInterface* GetVSyncMonitorInterface();
341 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPerformanceInterface()
343 virtual PerformanceInterface* GetPerformanceInterface();
346 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetKernelTraceInterface()
348 virtual KernelTraceInterface& GetKernelTraceInterface();
350 public: // Stereoscopy
353 * @copydoc Dali::Integration::Core::SetViewMode()
355 void SetViewMode( ViewMode viewMode );
358 * @copydoc Dali::Integration::Core::GetViewMode()
360 ViewMode GetViewMode() const;
363 * @copydoc Dali::Integration::Core::SetStereoBase()
365 void SetStereoBase( float stereoBase );
368 * @copydoc Dali::Integration::Core::GetStereoBase()
370 float GetStereoBase() const;
375 * @copydoc Dali::Adaptor::SignalResized
377 AdaptorSignalType& ResizedSignal()
379 return mResizedSignal;
383 * @copydoc Dali::Adaptor::LanguageChangedSignal
385 AdaptorSignalType& LanguageChangedSignal()
387 return mLanguageChangedSignal;
390 private: // From Dali::Internal::Adaptor::CoreEventInterface
393 * @copydoc Dali::Internal::Adaptor::CoreEventInterface::QueueCoreEvent()
395 virtual void QueueCoreEvent(const Dali::Integration::Event& event);
398 * @copydoc Dali::Internal::Adaptor:CoreEventInterface:::ProcessCoreEvents()
400 virtual void ProcessCoreEvents();
402 private: // From Dali::Integration::RenderController
405 * Called by the Dali core when it requires another update
407 virtual void RequestUpdate();
410 * Called by Dali core when it requires an notification event being sent on idle.
411 * Multi-threading note: this method must be called from the main thread only.
413 virtual void RequestProcessEventsOnIdle();
415 private: // From Dali::Internal::Adaptor::WindowVisibilityObserver
418 * Called when the window becomes fully or partially visible.
420 virtual void OnWindowShown();
423 * Called when the window is fully hidden.
425 virtual void OnWindowHidden();
427 private: // From Dali::Internal::Adaptor::DamageObserver
430 * @copydoc Dali::Internal::Adaptor::DamageObserver::OnDamaged()
432 void OnDamaged( const DamageArea& area );
437 Adaptor(const Adaptor&);
438 Adaptor& operator=(Adaptor&);
443 * Helper to parse log options
445 void ParseEnvironmentOptions();
448 * Informs core the surface size has changed
450 void SurfaceSizeChanged(const PositionSize& positionSize);
453 * Assigns the render surface to the adaptor
456 void SetSurface(Dali::RenderSurface *surface);
459 * Sends an notification message from main loop idle handler
461 void ProcessCoreEventsFromIdle();
467 * @param[in] adaptor The public adaptor
468 * @param[in] surface A render surface can be one of the following
469 * - Pixmap, adaptor will use existing Pixmap to draw on to
470 * - Window, adaptor will use existing Window to draw on to
471 * @param[in] baseLayout The base layout that the application has been written for
473 Adaptor( Dali::Adaptor& adaptor, RenderSurface* surface, const DeviceLayout& baseLayout );
479 READY, ///< Initial state before Adaptor::Start is called.
480 RUNNING, ///< Adaptor is running.
481 PAUSED, ///< Adaptor has been paused.
482 PAUSED_WHILE_HIDDEN, ///< Adaptor is paused while window is hidden (& cannot be resumed until window is shown).
483 STOPPED, ///< Adaptor has been stopped.
486 typedef std::vector<LifeCycleObserver*> ObserverContainer;
490 AdaptorSignalType mResizedSignal; ///< Resized signal.
491 AdaptorSignalType mLanguageChangedSignal; ///< Language changed signal.
493 Dali::Adaptor& mAdaptor; ///< Reference to public adaptor instance.
494 State mState; ///< Current state of the adaptor
495 Dali::Integration::Core* mCore; ///< Dali Core
496 UpdateRenderController* mUpdateRenderController; ///< Controls update/render threads
497 VSyncMonitor* mVSyncMonitor; ///< Monitors VSync events
498 GlImplementation* mGLES; ///< GL implementation
499 GlSyncImplementation* mGlSync; ///< GL Sync implementation
500 EglFactory* mEglFactory; ///< EGL Factory
502 RenderSurface* mSurface; ///< Current surface
503 SlpPlatform::SlpPlatformAbstraction* mPlatformAbstraction; ///< Platform abstraction
505 EventHandler* mEventHandler; ///< event handler
506 CallbackManager* mCallbackManager; ///< Used to install callbacks
507 bool mNotificationOnIdleInstalled; ///< whether the idle handler is installed to send an notification event
508 TriggerEvent* mNotificationTrigger; ///< Notification event trigger
509 GestureManager* mGestureManager; ///< Gesture manager
510 size_t mHDpi; ///< Override horizontal DPI
511 size_t mVDpi; ///< Override vertical DPI
512 FeedbackPluginProxy* mDaliFeedbackPlugin; ///< Used to access feedback support
513 FeedbackController* mFeedbackController; ///< Plays feedback effects for Dali-Toolkit UI Controls.
514 Dali::TtsPlayer mTtsPlayers[Dali::TtsPlayer::MODE_NUM]; ///< Provides TTS support
515 ObserverContainer mObservers; ///< A list of adaptor observer pointers
516 DragAndDropDetectorPtr mDragAndDropDetector; ///< The Drag & Drop detector
517 RotationObserver* mDeferredRotationObserver; ///< deferred Rotation observer needs event handler
518 DeviceLayout mBaseLayout; ///< The base layout of the application
519 EnvironmentOptions mEnvironmentOptions; ///< environment options
520 PerformanceInterface* mPerformanceInterface; ///< Performance interface
521 KernelTrace mKernelTracer; ///< Kernel tracer
522 TriggerEventFactory mTriggerEventFactory; ///< Trigger event factory
523 ObjectProfiler* mObjectProfiler; ///< Tracks object lifetime for profiling
525 inline static Adaptor& GetImplementation(Dali::Adaptor& adaptor) {return *adaptor.mImpl;}
528 } // namespace Internal
530 } // namespace Adaptor
534 #endif // __DALI_INTERNAL_ADAPTOR_IMPL_H__