1 #ifndef __DALI_INTERNAL_ADAPTOR_IMPL_H__
2 #define __DALI_INTERNAL_ADAPTOR_IMPL_H__
5 * Copyright (c) 2015 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 <clipboard.h>
35 #include <tizen-platform-abstraction.h>
36 #include <base/interfaces/adaptor-internal-services.h>
37 #include <base/environment-options.h>
38 #include <base/core-event-interface.h>
39 #include <drag-and-drop-detector-impl.h>
40 #include <damage-observer.h>
41 #include <window-visibility-observer.h>
42 #include <kernel-trace.h>
43 #include <system-trace.h>
44 #include <trigger-event-factory.h>
45 #include <networking/socket-factory.h>
67 class GlImplementation;
68 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] nativeWindow Native window handle
96 * @param[in] surface A render surface can be one of the following
97 * - Pixmap, adaptor will use existing Pixmap to draw on to
98 * - Window, adaptor will use existing Window to draw on to
99 * @param[in] configuration The context loss configuration ( to choose resource discard policy )
100 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
102 static Dali::Adaptor* New( Any nativeWindow,
103 RenderSurface* surface,
104 Dali::Configuration::ContextLoss configuration,
105 EnvironmentOptions* environmentOptions );
108 * Creates a New Adaptor
109 * @param[in] nativeWindow native window handle
110 * @param[in] configuration The context loss configuration ( to choose resource discard policy )
111 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
113 static Dali::Adaptor* New( Dali::Window window, Dali::Configuration::ContextLoss configuration, EnvironmentOptions* environmentOptions );
116 * 2-step initialisation, this should be called after creating an adaptor instance.
118 void Initialize(Dali::Configuration::ContextLoss configuration);
121 * Virtual destructor.
126 * @copydoc Dali::Adaptor::Get()
128 static Dali::Adaptor& Get();
131 * @copydoc Dali::Adaptor::IsAvailable()
133 static bool IsAvailable();
136 * @copydoc Dali::Core::SceneCreated();
140 public: // AdaptorInternalServices implementation
142 * @copydoc Dali::Adaptor::Start()
144 virtual void Start();
147 * @copydoc Dali::Adaptor::Pause()
149 virtual void Pause();
152 * @copydoc Dali::Adaptor::Resume()
154 virtual void Resume();
157 * @copydoc Dali::Adaptor::Stop()
162 * @copydoc Dali::EventFeeder::FeedTouchPoint()
164 virtual void FeedTouchPoint( TouchPoint& point, int timeStamp );
167 * @copydoc Dali::EventFeeder::FeedWheelEvent()
169 virtual void FeedWheelEvent( WheelEvent& wheelEvent );
172 * @copydoc Dali::EventFeeder::FeedKeyEvent()
174 virtual void FeedKeyEvent( KeyEvent& keyEvent );
177 * @copydoc AdaptorInterface::MoveResize()
179 virtual bool MoveResize( const PositionSize& positionSize );
182 * @copydoc AdaptorInterface::SurfaceResized()
184 virtual void SurfaceResized( const PositionSize& positionSize );
187 * @copydoc AdaptorInterface::ReplaceSurface()
189 virtual void ReplaceSurface( Any nativeWindow, RenderSurface& surface );
192 * @copydoc Dali::Adaptor::GetSurface()
194 virtual RenderSurface& GetSurface() const;
197 * @copydoc Dali::Adaptor::ReleaseSurfaceLock()
199 virtual void ReleaseSurfaceLock();
202 * Retrieve the TtsPlayer.
203 * @param[in] mode The mode of TtsPlayer
204 * @return A handle to the TtsPlayer.
206 virtual Dali::TtsPlayer GetTtsPlayer(Dali::TtsPlayer::Mode mode);
209 * @copydoc Dali::Adaptor::AddIdle()
211 virtual bool AddIdle( CallbackBase* callback );
216 * @return the Core instance
218 virtual Dali::Integration::Core& GetCore();
221 * @copydoc Dali::Adaptor::SetRenderRefreshRate()
223 void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
226 * @copydoc Dali::Adaptor::SetUseHardwareVSync()
228 void SetUseHardwareVSync(bool useHardware);
231 * @return reference to EglFactory class
233 EglFactory& GetEGLFactory() const;
236 * Return GlAbstraction.
237 * @return the GlAbstraction.
239 Integration::GlAbstraction& GetGlAbstraction() const;
242 * Return the PlatformAbstraction.
243 * @return The PlatformAbstraction.
245 Integration::PlatformAbstraction& GetPlatformAbstraction() const;
248 * Sets the Drag & Drop Listener.
249 * @param[in] detector The detector to send Drag & Drop events to.
251 void SetDragAndDropDetector( DragAndDropDetectorPtr detector );
254 * Sets a rotation observer, or set to NULL to remove.
255 * @pre Adaptor::Start() has been called ( to create EventHandler )
256 * @param[in] observer The observer to listen for window rotation events
258 void SetRotationObserver( RotationObserver* observer );
261 * Destroy the TtsPlayer of sepcific mode.
262 * @param[in] mode The mode of TtsPlayer to destroy
264 void DestroyTtsPlayer(Dali::TtsPlayer::Mode mode);
267 * @brief Sets minimum distance in pixels that the fingers must move towards/away from each other in order to
268 * trigger a pinch gesture
270 * @param[in] distance The minimum pinch distance in pixels
272 void SetMinimumPinchDistance(float distance);
275 * Gets native window handle
277 * @return native window handle
279 Any GetNativeWindowHandle();
284 * Adds an adaptor observer so that we can observe the adaptor's lifetime events.
285 * @param[in] observer The observer.
286 * @note Observers should remove themselves when they are destroyed.
288 void AddObserver( LifeCycleObserver& observer );
291 * Removes the observer from the adaptor.
292 * @param[in] observer The observer to remove.
293 * @note Observers should remove themselves when they are destroyed.
295 void RemoveObserver( LifeCycleObserver& observer );
298 * Emits the Notification event to the Dali core.
300 void SendNotificationEvent();
303 * Request adaptor to update once
305 void RequestUpdateOnce();
308 * @copydoc Dali::Adaptor::NotifySceneCreated()
310 void NotifySceneCreated();
313 * @copydoc Dali::Adaptor::NotifyLanguageChanged()
315 void NotifyLanguageChanged();
317 public: //AdaptorInternalServices
320 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPlatformAbstractionInterface()
322 virtual Dali::Integration::PlatformAbstraction& GetPlatformAbstractionInterface();
325 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetGlesInterface()
327 virtual Dali::Integration::GlAbstraction& GetGlesInterface();
330 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetEGLFactoryInterface()
332 virtual EglFactoryInterface& GetEGLFactoryInterface() const;
335 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventInterface()
337 virtual TriggerEventInterface& GetProcessCoreEventsTrigger();
340 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventFactoryInterface()
342 virtual TriggerEventFactoryInterface& GetTriggerEventFactoryInterface();
345 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSocketFactoryInterface()
347 virtual SocketFactoryInterface& GetSocketFactoryInterface();
350 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetRenderSurfaceInterface()
352 virtual RenderSurface* GetRenderSurfaceInterface();
355 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetVSyncMonitorInterface()
357 virtual VSyncMonitorInterface* GetVSyncMonitorInterface();
360 * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPerformanceInterface()
362 virtual PerformanceInterface* GetPerformanceInterface();
365 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetKernelTraceInterface()
367 virtual TraceInterface& GetKernelTraceInterface();
370 * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSystemTraceInterface()
372 virtual TraceInterface& GetSystemTraceInterface();
374 public: // Stereoscopy
377 * @copydoc Dali::Integration::Core::SetViewMode()
379 void SetViewMode( ViewMode viewMode );
382 * @copydoc Dali::Integration::Core::GetViewMode()
384 ViewMode GetViewMode() const;
387 * @copydoc Dali::Integration::Core::SetStereoBase()
389 void SetStereoBase( float stereoBase );
392 * @copydoc Dali::Integration::Core::GetStereoBase()
394 float GetStereoBase() const;
399 * @copydoc Dali::Adaptor::SignalResized
401 AdaptorSignalType& ResizedSignal()
403 return mResizedSignal;
407 * @copydoc Dali::Adaptor::LanguageChangedSignal
409 AdaptorSignalType& LanguageChangedSignal()
411 return mLanguageChangedSignal;
414 private: // From Dali::Internal::Adaptor::CoreEventInterface
417 * @copydoc Dali::Internal::Adaptor::CoreEventInterface::QueueCoreEvent()
419 virtual void QueueCoreEvent(const Dali::Integration::Event& event);
422 * @copydoc Dali::Internal::Adaptor:CoreEventInterface:::ProcessCoreEvents()
424 virtual void ProcessCoreEvents();
426 private: // From Dali::Integration::RenderController
429 * Called by the Dali core when it requires another update
431 virtual void RequestUpdate();
434 * Called by Dali core when it requires an notification event being sent on idle.
435 * Multi-threading note: this method must be called from the main thread only.
437 virtual void RequestProcessEventsOnIdle();
439 private: // From Dali::Internal::Adaptor::WindowVisibilityObserver
442 * Called when the window becomes fully or partially visible.
444 virtual void OnWindowShown();
447 * Called when the window is fully hidden.
449 virtual void OnWindowHidden();
451 private: // From Dali::Internal::Adaptor::DamageObserver
454 * @copydoc Dali::Internal::Adaptor::DamageObserver::OnDamaged()
456 void OnDamaged( const DamageArea& area );
461 Adaptor(const Adaptor&);
462 Adaptor& operator=(Adaptor&);
467 * Informs core the surface size has changed
469 void SurfaceSizeChanged(const PositionSize& positionSize);
472 * Assigns the render surface to the adaptor
475 void SetSurface(RenderSurface *surface);
478 * Sends an notification message from main loop idle handler
480 void ProcessCoreEventsFromIdle();
483 * Gets path for data/resource storage.
484 * @param[out] path Path for data/resource storage
486 void GetDataStoragePath(std::string& path);
492 * @param[in] nativeWindow native window handle
493 * @param[in] adaptor The public adaptor
494 * @param[in] surface A render surface can be one of the following
495 * - Pixmap, adaptor will use existing Pixmap to draw on to
496 * - Window, adaptor will use existing Window to draw on to
497 * @param[in] environmentOptions A pointer to the environment options. If NULL then one is created.
499 Adaptor( Any nativeWindow, Dali::Adaptor& adaptor, RenderSurface* surface, EnvironmentOptions* environmentOptions );
505 READY, ///< Initial state before Adaptor::Start is called.
506 RUNNING, ///< Adaptor is running.
507 PAUSED, ///< Adaptor has been paused.
508 PAUSED_WHILE_HIDDEN, ///< Adaptor is paused while window is hidden (& cannot be resumed until window is shown).
509 STOPPED, ///< Adaptor has been stopped.
512 typedef std::vector<LifeCycleObserver*> ObserverContainer;
516 AdaptorSignalType mResizedSignal; ///< Resized signal.
517 AdaptorSignalType mLanguageChangedSignal; ///< Language changed signal.
519 Dali::Adaptor& mAdaptor; ///< Reference to public adaptor instance.
520 State mState; ///< Current state of the adaptor
521 Dali::Integration::Core* mCore; ///< Dali Core
522 UpdateRenderController* mUpdateRenderController; ///< Controls update/render threads
523 VSyncMonitor* mVSyncMonitor; ///< Monitors VSync events
524 GlImplementation* mGLES; ///< GL implementation
525 GlSyncImplementation* mGlSync; ///< GL Sync implementation
526 EglFactory* mEglFactory; ///< EGL Factory
528 Any mNativeWindow; ///< window identifier
529 RenderSurface* mSurface; ///< Current surface
530 TizenPlatform::TizenPlatformAbstraction* mPlatformAbstraction; ///< Platform abstraction
532 EventHandler* mEventHandler; ///< event handler
533 CallbackManager* mCallbackManager; ///< Used to install callbacks
534 bool mNotificationOnIdleInstalled; ///< whether the idle handler is installed to send an notification event
535 TriggerEventInterface* mNotificationTrigger; ///< Notification event trigger
536 GestureManager* mGestureManager; ///< Gesture manager
537 FeedbackPluginProxy* mDaliFeedbackPlugin; ///< Used to access feedback support
538 FeedbackController* mFeedbackController; ///< Plays feedback effects for Dali-Toolkit UI Controls.
539 Dali::TtsPlayer mTtsPlayers[Dali::TtsPlayer::MODE_NUM]; ///< Provides TTS support
540 ObserverContainer mObservers; ///< A list of adaptor observer pointers
541 DragAndDropDetectorPtr mDragAndDropDetector; ///< The Drag & Drop detector
542 RotationObserver* mDeferredRotationObserver; ///< deferred Rotation observer needs event handler
543 EnvironmentOptions* mEnvironmentOptions; ///< environment options
544 PerformanceInterface* mPerformanceInterface; ///< Performance interface
545 KernelTrace mKernelTracer; ///< Kernel tracer
546 SystemTrace mSystemTracer; ///< System tracer
547 TriggerEventFactory mTriggerEventFactory; ///< Trigger event factory
548 ObjectProfiler* mObjectProfiler; ///< Tracks object lifetime for profiling
549 SocketFactory mSocketFactory; ///< Socket factory
550 const bool mEnvironmentOptionsOwned:1; ///< Whether we own the EnvironmentOptions (and thus, need to delete it)
552 inline static Adaptor& GetImplementation(Dali::Adaptor& adaptor) {return *adaptor.mImpl;}
555 } // namespace Internal
557 } // namespace Adaptor
561 #endif // __DALI_INTERNAL_ADAPTOR_IMPL_H__