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