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