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