adaptors/common/adaptor-impl.h

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