adaptors/common/adaptor-impl.h

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