adaptors/common/adaptor-impl.h

   1 #ifndef __DALI_INTERNAL_ADAPTOR_IMPL_H__
   2 #define __DALI_INTERNAL_ADAPTOR_IMPL_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <boost/bind.hpp>
  23 #include <boost/function.hpp>
  24 #include <boost/thread.hpp>
  25
  26 #include <dali/public-api/common/vector-wrapper.h>
  27 #include <dali/public-api/common/view-mode.h>
  28 #include <dali/public-api/math/rect.h>
  29 #include <dali/integration-api/render-controller.h>
  30
  31 // INTERNAL INCLUDES
  32 #include <adaptor.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>
  38
  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>
  48
  49 namespace Dali
  50 {
  51
  52 namespace Integration
  53 {
  54 class Core;
  55 class GlAbstraction;
  56 }
  57
  58 namespace Internal
  59 {
  60
  61 namespace Adaptor
  62 {
  63 class EventHandler;
  64 class EglFactory;
  65 class GestureManager;
  66 class GlImplementation;
  67 class GlSyncImplementation;
  68 class RenderSurface;
  69 class UpdateRenderController;
  70 class TriggerEvent;
  71 class CallbackManager;
  72 class FeedbackPluginProxy;
  73 class FeedbackController;
  74 class RotationObserver;
  75 class VSyncMonitor;
  76 class PerformanceInterface;
  77 class LifeCycleObserver;
  78 class ObjectProfiler;
  79
  80 /**
  81  * Implementation of the Adaptor class.
  82  */
  83 class Adaptor : public Integration::RenderController,
  84                 public AdaptorInternalServices,
  85                 public CoreEventInterface,
  86                 public DamageObserver,
  87                 public WindowVisibilityObserver
  88 {
  89 public:
  90
  91   typedef Dali::Adaptor::AdaptorSignalType AdaptorSignalType;
  92
  93   /**
  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 )
 100    */
 101   static Dali::Adaptor* New( RenderSurface* surface,
 102                              const DeviceLayout& baseLayout,
 103                              Dali::Configuration::ContextLoss configuration );
 104
 105   /**
 106    * 2-step initialisation, this should be called after creating an adaptor instance.
 107    */
 108   void Initialize(Dali::Configuration::ContextLoss configuration);
 109
 110   /**
 111    * Virtual destructor.
 112    */
 113   virtual ~Adaptor();
 114
 115   /**
 116    * @copydoc Dali::Adaptor::Get()
 117    */
 118   static Dali::Adaptor& Get();
 119
 120   /**
 121    * @copydoc Dali::Adaptor::IsAvailable()
 122    */
 123   static bool IsAvailable();
 124
 125 public: // AdaptorInternalServices implementation
 126   /**
 127    * @copydoc Dali::Adaptor::Start()
 128    */
 129   virtual void Start();
 130
 131   /**
 132    * @copydoc Dali::Adaptor::Pause()
 133    */
 134   virtual void Pause();
 135
 136   /**
 137    * @copydoc Dali::Adaptor::Resume()
 138    */
 139   virtual void Resume();
 140
 141   /**
 142    * @copydoc Dali::Adaptor::Stop()
 143    */
 144   virtual void Stop();
 145
 146   /**
 147    * @copydoc Dali::EventFeeder::FeedTouchPoint()
 148    */
 149   virtual void FeedTouchPoint( TouchPoint& point, int timeStamp );
 150
 151   /**
 152    * @copydoc Dali::EventFeeder::FeedWheelEvent()
 153    */
 154   virtual void FeedWheelEvent( MouseWheelEvent& wheelEvent );
 155
 156   /**
 157    * @copydoc Dali::EventFeeder::FeedKeyEvent()
 158    */
 159   virtual void FeedKeyEvent( KeyEvent& keyEvent );
 160
 161   /**
 162    * @copydoc AdaptorInterface::MoveResize()
 163    */
 164   virtual bool MoveResize( const PositionSize& positionSize );
 165
 166   /**
 167    * @copydoc AdaptorInterface::SurfaceResized()
 168    */
 169   virtual void SurfaceResized( const PositionSize& positionSize );
 170
 171   /**
 172    * @copydoc AdaptorInterface::ReplaceSurface()
 173    */
 174   virtual void ReplaceSurface( Dali::RenderSurface& surface );
 175
 176   /**
 177    * @copydoc Dali::Adaptor::GetSurface()
 178    */
 179   virtual Dali::RenderSurface& GetSurface() const;
 180
 181   /**
 182    * @copydoc Dali::Adaptor::ReleaseSurfaceLock()
 183    */
 184   virtual void ReleaseSurfaceLock();
 185
 186   /**
 187    * Retrieve the TtsPlayer.
 188    * @param[in] mode The mode of TtsPlayer
 189    * @return A handle to the TtsPlayer.
 190    */
 191   virtual Dali::TtsPlayer GetTtsPlayer(Dali::TtsPlayer::Mode mode);
 192
 193   /**
 194    * @copydoc Dali::Adaptor::AddIdle()
 195    */
 196   virtual bool AddIdle( boost::function<void(void)> callBack );
 197
 198   /**
 199    * @copydoc Internal::Framework::CallFromMainLoop()
 200    */
 201   virtual bool CallFromMainLoop(boost::function<void(void)> callBack);
 202
 203 public:
 204
 205   /**
 206    * @return the Core instance
 207    */
 208   virtual Dali::Integration::Core& GetCore();
 209
 210   /**
 211    * @copydoc Dali::Adaptor::SetRenderRefreshRate()
 212    */
 213   void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
 214
 215   /**
 216    * @copydoc Dali::Adaptor::SetUseHardwareVSync()
 217    */
 218   void SetUseHardwareVSync(bool useHardware);
 219
 220   /**
 221    * @return reference to EglFactory class
 222    */
 223   EglFactory& GetEGLFactory() const;
 224
 225   /**
 226    * Return GlAbstraction.
 227    * @return the GlAbstraction.
 228    */
 229   Integration::GlAbstraction& GetGlAbstraction() const;
 230
 231   /**
 232    * Return the PlatformAbstraction.
 233    * @return The PlatformAbstraction.
 234    */
 235   Integration::PlatformAbstraction& GetPlatformAbstraction() const;
 236
 237   /**
 238    * Sets the Drag & Drop Listener.
 239    * @param[in] detector The detector to send Drag & Drop events to.
 240    */
 241   void SetDragAndDropDetector( DragAndDropDetectorPtr detector );
 242
 243   /**
 244    * Sets a rotation observer, or set to NULL to remove.
 245    * @pre Adaptor::Start() has been called ( to create EventHandler )
 246    * @param[in] observer The observer to listen for window rotation events
 247    */
 248   void SetRotationObserver( RotationObserver* observer );
 249
 250   /**
 251    * Destroy the TtsPlayer of sepcific mode.
 252    * @param[in] mode The mode of TtsPlayer to destroy
 253    */
 254   void DestroyTtsPlayer(Dali::TtsPlayer::Mode mode);
 255
 256   /**
 257    * @brief Sets minimum distance in pixels that the fingers must move towards/away from each other in order to
 258    * trigger a pinch gesture
 259    *
 260    * @param[in] distance The minimum pinch distance in pixels
 261    */
 262   void SetMinimumPinchDistance(float distance);
 263
 264 public:
 265
 266   /**
 267    * Adds an adaptor observer so that we can observe the adaptor's lifetime events.
 268    * @param[in]  observer  The observer.
 269    * @note Observers should remove themselves when they are destroyed.
 270    */
 271   void AddObserver( LifeCycleObserver& observer );
 272
 273   /**
 274    * Removes the observer from the adaptor.
 275    * @param[in]  observer  The observer to remove.
 276    * @note Observers should remove themselves when they are destroyed.
 277    */
 278   void RemoveObserver( LifeCycleObserver& observer );
 279
 280   /**
 281    * Emits the Notification event to the Dali core.
 282    */
 283   void SendNotificationEvent();
 284
 285   /**
 286    * Request adaptor to update once
 287    */
 288   void RequestUpdateOnce();
 289
 290   /**
 291    * @copydoc Dali::Adaptor::NotifyLanguageChanged()
 292    */
 293   void NotifyLanguageChanged();
 294
 295 public:  //AdaptorInternalServices
 296
 297   /**
 298    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPlatformAbstractionInterface()
 299    */
 300   virtual Dali::Integration::PlatformAbstraction& GetPlatformAbstractionInterface();
 301
 302   /**
 303    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetGlesInterface()
 304    */
 305   virtual Dali::Integration::GlAbstraction& GetGlesInterface();
 306
 307   /**
 308   * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetEGLFactoryInterface()
 309   */
 310   virtual EglFactoryInterface& GetEGLFactoryInterface() const;
 311
 312   /**
 313    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventInterface()
 314    */
 315   virtual TriggerEventInterface& GetTriggerEventInterface();
 316
 317   /**
 318    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventFactoryInterface()
 319    */
 320   virtual TriggerEventFactoryInterface& GetTriggerEventFactoryInterface();
 321
 322   /**
 323    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetRenderSurfaceInterface()
 324    */
 325   virtual RenderSurface* GetRenderSurfaceInterface();
 326
 327   /**
 328    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetVSyncMonitorInterface()
 329    */
 330   virtual VSyncMonitorInterface* GetVSyncMonitorInterface();
 331
 332   /**
 333    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPerformanceInterface()
 334    */
 335   virtual PerformanceInterface* GetPerformanceInterface();
 336
 337   /**
 338    * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetKernelTraceInterface()
 339    */
 340   virtual KernelTraceInterface& GetKernelTraceInterface();
 341
 342 public: // Stereoscopy
 343
 344   /**
 345    * @copydoc Dali::Integration::Core::SetViewMode()
 346    */
 347   void SetViewMode( ViewMode viewMode );
 348
 349   /**
 350    * @copydoc Dali::Integration::Core::GetViewMode()
 351    */
 352   ViewMode GetViewMode() const;
 353
 354   /**
 355    * @copydoc Dali::Integration::Core::SetStereoBase()
 356    */
 357   void SetStereoBase( float stereoBase );
 358
 359   /**
 360    * @copydoc Dali::Integration::Core::GetStereoBase()
 361    */
 362   float GetStereoBase() const;
 363
 364 public: // Signals
 365
 366   /**
 367    * @copydoc Dali::Adaptor::SignalResized
 368    */
 369   AdaptorSignalType& ResizedSignal()
 370   {
 371     return mResizedSignal;
 372   }
 373
 374   /**
 375    * @copydoc Dali::Adaptor::LanguageChangedSignal
 376    */
 377   AdaptorSignalType& LanguageChangedSignal()
 378   {
 379     return mLanguageChangedSignal;
 380   }
 381
 382 private: // From Dali::Internal::Adaptor::CoreEventInterface
 383
 384   /**
 385    * @copydoc Dali::Internal::Adaptor::CoreEventInterface::QueueCoreEvent()
 386    */
 387   virtual void QueueCoreEvent(const Dali::Integration::Event& event);
 388
 389   /**
 390    * @copydoc Dali::Internal::Adaptor:CoreEventInterface:::ProcessCoreEvents()
 391    */
 392   virtual void ProcessCoreEvents();
 393
 394 private: // From Dali::Integration::RenderController
 395
 396   /**
 397    * Called by the Dali core when it requires another update
 398    */
 399   virtual void RequestUpdate();
 400
 401   /**
 402    * Called by Dali core when it requires an notification event being sent on idle.
 403    * Multi-threading note: this method must be called from the main thread only.
 404    */
 405   virtual void RequestProcessEventsOnIdle();
 406
 407 private: // From Dali::Internal::Adaptor::WindowVisibilityObserver
 408
 409   /**
 410    * Called when the window becomes fully or partially visible.
 411    */
 412   virtual void OnWindowShown();
 413
 414   /**
 415    * Called when the window is fully hidden.
 416    */
 417   virtual void OnWindowHidden();
 418
 419 private: // From Dali::Internal::Adaptor::DamageObserver
 420
 421   /**
 422    * @copydoc Dali::Internal::Adaptor::DamageObserver::OnDamaged()
 423    */
 424   void OnDamaged( const DamageArea& area );
 425
 426 private:
 427
 428   // Undefined
 429   Adaptor(const Adaptor&);
 430   Adaptor& operator=(Adaptor&);
 431
 432 private:
 433
 434   /**
 435    * Helper to parse log options
 436    */
 437   void ParseEnvironmentOptions();
 438
 439   /**
 440    * Informs core the surface size has changed
 441    */
 442   void SurfaceSizeChanged(const PositionSize& positionSize);
 443
 444   /**
 445    * Assigns the render surface to the adaptor
 446    *
 447    */
 448   void SetSurface(Dali::RenderSurface *surface);
 449
 450   /**
 451    * Sends an notification message from main loop idle handler
 452    */
 453   void ProcessCoreEventsFromIdle();
 454
 455 private:
 456
 457   /**
 458    * Constructor
 459    * @param[in]  adaptor     The public adaptor
 460    * @param[in]  surface     A render surface can be one of the following
 461    *                         - Pixmap, adaptor will use existing Pixmap to draw on to
 462    *                         - Window, adaptor will use existing Window to draw on to
 463    * @param[in]  baseLayout  The base layout that the application has been written for
 464    */
 465   Adaptor( Dali::Adaptor& adaptor, RenderSurface* surface, const DeviceLayout& baseLayout );
 466
 467 private: // Types
 468
 469   enum State
 470   {
 471     READY,               ///< Initial state before Adaptor::Start is called.
 472     RUNNING,             ///< Adaptor is running.
 473     PAUSED,              ///< Adaptor has been paused.
 474     PAUSED_WHILE_HIDDEN, ///< Adaptor is paused while window is hidden (& cannot be resumed until window is shown).
 475     STOPPED,             ///< Adaptor has been stopped.
 476   };
 477
 478   typedef std::vector<LifeCycleObserver*>  ObserverContainer;
 479
 480 private: // Data
 481
 482   AdaptorSignalType                       mResizedSignal;             ///< Resized signal.
 483   AdaptorSignalType                       mLanguageChangedSignal;     ///< Language changed signal.
 484
 485   Dali::Adaptor&                        mAdaptor;                     ///< Reference to public adaptor instance.
 486   State                                 mState;                       ///< Current state of the adaptor
 487   Dali::Integration::Core*              mCore;                        ///< Dali Core
 488   UpdateRenderController*               mUpdateRenderController;      ///< Controls update/render threads
 489   VSyncMonitor*                         mVSyncMonitor;                ///< Monitors VSync events
 490   GlImplementation*                     mGLES;                        ///< GL implementation
 491   GlSyncImplementation*                 mGlSync;                      ///< GL Sync implementation
 492   EglFactory*                           mEglFactory;                  ///< EGL Factory
 493
 494   RenderSurface*                        mSurface;                     ///< Current surface
 495   SlpPlatform::SlpPlatformAbstraction*  mPlatformAbstraction;         ///< Platform abstraction
 496
 497   EventHandler*                         mEventHandler;                ///< event handler
 498   CallbackManager*                      mCallbackManager;             ///< Used to install callbacks
 499   bool                                  mNotificationOnIdleInstalled; ///< whether the idle handler is installed to send an notification event
 500   TriggerEvent*                         mNotificationTrigger;         ///< Notification event trigger
 501   GestureManager*                       mGestureManager;              ///< Gesture manager
 502   FeedbackPluginProxy*                  mDaliFeedbackPlugin;          ///< Used to access feedback support
 503   FeedbackController*                   mFeedbackController;          ///< Plays feedback effects for Dali-Toolkit UI Controls.
 504   Dali::TtsPlayer                       mTtsPlayers[Dali::TtsPlayer::MODE_NUM];                   ///< Provides TTS support
 505   ObserverContainer                     mObservers;                   ///< A list of adaptor observer pointers
 506   DragAndDropDetectorPtr                mDragAndDropDetector;         ///< The Drag & Drop detector
 507   RotationObserver*                     mDeferredRotationObserver;    ///< deferred Rotation observer needs event handler
 508   DeviceLayout                          mBaseLayout;                  ///< The base layout of the application
 509   EnvironmentOptions                    mEnvironmentOptions;          ///< environment options
 510   PerformanceInterface*                 mPerformanceInterface;        ///< Performance interface
 511   KernelTrace                           mKernelTracer;                ///< Kernel tracer
 512   TriggerEventFactory                   mTriggerEventFactory;         ///< Trigger event factory
 513   ObjectProfiler*                       mObjectProfiler;              ///< Tracks object lifetime for profiling
 514 public:
 515   inline static Adaptor& GetImplementation(Dali::Adaptor& adaptor) {return *adaptor.mImpl;}
 516 };
 517
 518 } // namespace Internal
 519
 520 } // namespace Adaptor
 521
 522 } // namespace Dali
 523
 524 #endif // __DALI_INTERNAL_ADAPTOR_IMPL_H__