[dali_1.4.19] Merge branch 'devel/master'
[platform/core/uifw/dali-adaptor.git] / dali / internal / adaptor / common / adaptor-impl.h
1 #ifndef DALI_INTERNAL_ADAPTOR_IMPL_H
2 #define DALI_INTERNAL_ADAPTOR_IMPL_H
3
4 /*
5  * Copyright (c) 2019 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 <dali/integration-api/adaptor.h>
31 #include <dali/integration-api/scene.h>
32
33 #ifdef DALI_ADAPTOR_COMPILATION
34 #include <dali/integration-api/scene-holder-impl.h>
35 #else
36 #include <dali/integration-api/adaptors/scene-holder-impl.h>
37 #endif
38
39 #include <dali/public-api/adaptor-framework/tts-player.h>
40 #include <dali/devel-api/adaptor-framework/clipboard.h>
41
42 #include <dali/internal/graphics/common/graphics-interface.h>
43
44 #include <dali/internal/legacy/common/tizen-platform-abstraction.h>
45 #include <dali/internal/adaptor/common/adaptor-internal-services.h>
46 #include <dali/internal/system/common/environment-options.h>
47 #include <dali/internal/system/common/core-event-interface.h>
48 #include <dali/internal/window-system/common/damage-observer.h>
49 #include <dali/internal/window-system/common/window-visibility-observer.h>
50 #include <dali/internal/system/common/kernel-trace.h>
51 #include <dali/internal/system/common/system-trace.h>
52 #include <dali/integration-api/trigger-event-factory.h>
53 #include <dali/internal/network/common/socket-factory.h>
54
55
56 namespace Dali
57 {
58
59 class RenderSurfaceInterface;
60
61 namespace Integration
62 {
63 class Core;
64 class GlAbstraction;
65 class Processor;
66 }
67
68 namespace Internal
69 {
70
71 namespace Adaptor
72 {
73 class DisplayConnection;
74 class GraphicsFactory;
75 class GestureManager;
76 class GlImplementation;
77 class GlSyncImplementation;
78 class ThreadController;
79 class TriggerEvent;
80 class CallbackManager;
81 class FeedbackPluginProxy;
82 class FeedbackController;
83 class VSyncMonitor;
84 class PerformanceInterface;
85 class LifeCycleObserver;
86 class ObjectProfiler;
87 class SceneHolder;
88
89 /**
90  * Implementation of the Adaptor class.
91  */
92 class Adaptor : public Integration::RenderController,
93                 public AdaptorInternalServices,
94                 public CoreEventInterface,
95                 public DamageObserver,
96                 public WindowVisibilityObserver
97 {
98 public:
99
100   typedef Dali::Adaptor::AdaptorSignalType AdaptorSignalType;
101
102   typedef Uint16Pair SurfaceSize;          ///< Surface size type
103
104   /**
105    * Creates a New Adaptor
106    * @param[in]  window              The window handle
107    * @param[in]  surface             A render surface can be one of the following
108    *                                  - Pixmap, adaptor will use existing Pixmap to draw on to
109    *                                  - Window, adaptor will use existing Window to draw on to
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::Integration::SceneHolder window,
114                              Dali::RenderSurfaceInterface* surface,
115                              Dali::Configuration::ContextLoss configuration,
116                              EnvironmentOptions* environmentOptions );
117
118   /**
119    * Creates a New Adaptor
120    * @param[in]  window              The window handle
121    * @param[in]  configuration       The context loss configuration ( to choose resource discard policy )
122    * @param[in]  environmentOptions  A pointer to the environment options. If NULL then one is created.
123    */
124   static Dali::Adaptor* New( Dali::Integration::SceneHolder window,
125                              Dali::Configuration::ContextLoss configuration,
126                              EnvironmentOptions* environmentOptions );
127
128   /**
129    * Creates a New Adaptor
130    * @param[in]  graphicsFactory     A factory that creates the graphics interface
131    * @param[in]  window              The window handle
132    * @param[in]  surface             A render surface can be one of the following
133    *                                  - Pixmap, adaptor will use existing Pixmap to draw on to
134    *                                  - Window, adaptor will use existing Window to draw on to
135    * @param[in]  configuration       The context loss configuration ( to choose resource discard policy )
136    * @param[in]  environmentOptions  A pointer to the environment options. If NULL then one is created.
137    */
138   static Dali::Adaptor* New( GraphicsFactory& graphicsFactory,
139                              Dali::Integration::SceneHolder window,
140                              Dali::RenderSurfaceInterface* surface,
141                              Dali::Configuration::ContextLoss configuration,
142                              EnvironmentOptions* environmentOptions );
143
144   /**
145    * Creates a New Adaptor
146    * @param[in]  graphicsFactory     A factory that creates the graphics interface
147    * @param[in]  window              The window handle
148    * @param[in]  configuration       The context loss configuration ( to choose resource discard policy )
149    * @param[in]  environmentOptions  A pointer to the environment options. If NULL then one is created.
150    */
151   static Dali::Adaptor* New( GraphicsFactory& graphicsFactory,
152                              Dali::Integration::SceneHolder window,
153                              Dali::Configuration::ContextLoss configuration,
154                              EnvironmentOptions* environmentOptions );
155
156   /**
157    * 2-step initialisation, this should be called after creating an adaptor instance.
158    * @param[in]  graphicsFactory     A factory that creates the graphics interface
159    * @param[in]  configuration       The context loss configuration ( to choose resource discard policy )
160    */
161   void Initialize( GraphicsFactory& graphicsFactory, Dali::Configuration::ContextLoss configuration );
162
163   /**
164    * Virtual destructor.
165    */
166   virtual ~Adaptor();
167
168   /**
169    * @copydoc Dali::Adaptor::Get()
170    */
171   static Dali::Adaptor& Get();
172
173   /**
174    * @copydoc Dali::Adaptor::IsAvailable()
175    */
176   static bool IsAvailable();
177
178   /**
179    * @copydoc Dali::Core::SceneCreated();
180    */
181   void SceneCreated();
182
183 public: // AdaptorInternalServices implementation
184   /**
185    * @copydoc Dali::Adaptor::Start()
186    */
187   virtual void Start();
188
189   /**
190    * @copydoc Dali::Adaptor::Pause()
191    */
192   virtual void Pause();
193
194   /**
195    * @copydoc Dali::Adaptor::Resume()
196    */
197   virtual void Resume();
198
199   /**
200    * @copydoc Dali::Adaptor::Stop()
201    */
202   virtual void Stop();
203
204   /**
205    * @copydoc Dali::Adaptor::ContextLost()
206    */
207   virtual void ContextLost();
208
209   /**
210    * @copydoc Dali::Adaptor::ContextRegained()
211    */
212   virtual void ContextRegained();
213
214   /**
215    * @copydoc Dali::EventFeeder::FeedTouchPoint()
216    */
217   virtual void FeedTouchPoint( TouchPoint& point, int timeStamp );
218
219   /**
220    * @copydoc Dali::EventFeeder::FeedWheelEvent()
221    */
222   virtual void FeedWheelEvent( WheelEvent& wheelEvent );
223
224   /**
225    * @copydoc Dali::EventFeeder::FeedKeyEvent()
226    */
227   virtual void FeedKeyEvent( KeyEvent& keyEvent );
228
229   /**
230    * @copydoc Dali::Adaptor::ReplaceSurface()
231    */
232   virtual void ReplaceSurface( Dali::Integration::SceneHolder window, Dali::RenderSurfaceInterface& surface );
233
234   /**
235    * @copydoc Dali::Adaptor::GetSurface()
236    */
237   virtual Dali::RenderSurfaceInterface& GetSurface() const;
238
239   /**
240    * @copydoc Dali::Adaptor::ReleaseSurfaceLock()
241    */
242   virtual void ReleaseSurfaceLock();
243
244   /**
245    * Retrieve the TtsPlayer.
246    * @param[in] mode The mode of TtsPlayer
247    * @return A handle to the TtsPlayer.
248    */
249   virtual Dali::TtsPlayer GetTtsPlayer(Dali::TtsPlayer::Mode mode);
250
251   /**
252    * @copydoc Dali::Adaptor::AddIdle()
253    */
254   virtual bool AddIdle( CallbackBase* callback, bool hasReturnValue, bool forceAdd );
255
256   /**
257    * Adds a new Window instance to the Adaptor
258    * @param[in]  childWindow The child window instance
259    * @param[in]  childWindowName The child window title/name
260    * @param[in]  childWindowClassName The class name that the child window belongs to
261    * @param[in]  childWindowMode The mode of the child window
262    */
263   virtual bool AddWindow( Dali::Integration::SceneHolder* childWindow,
264                           const std::string& childWindowName,
265                           const std::string& childWindowClassName,
266                           const bool& childWindowMode );
267
268   /**
269    * Removes an existing Window instance from the Adaptor
270    * @param[in]  window The Window instance
271    */
272   virtual bool RemoveWindow( Dali::Integration::SceneHolder* childWindow );
273
274   /**
275    * Removes an existing Window instance from the Adaptor
276    * @param[in]  windowName The Window name
277    * @note If two Windows have the same name, the first one that matches will be removed
278    */
279   virtual bool RemoveWindow( std::string childWindowName );
280
281   /**
282    * @copydoc Dali::Adaptor::RemoveIdle()
283    */
284   virtual void RemoveIdle( CallbackBase* callback );
285
286   /**
287    * Sets a pre-render callback.
288    */
289   void SetPreRenderCallback( CallbackBase* callback );
290
291   /**
292    * Removes an existing Window instance from the Adaptor
293    * @param[in]  childWindow The Window instance
294    */
295   bool RemoveWindow( Dali::Internal::Adaptor::SceneHolder* childWindow );
296
297   /**
298    * @brief Retrieve the window that the given actor is added to.
299    *
300    * @param[in] actor The actor
301    * @return The window the actor is added to or a null pointer if the actor is not added to any widnow.
302    */
303   Dali::Internal::Adaptor::SceneHolder* GetWindow( Dali::Actor& actor );
304
305 public:
306
307   /**
308    * @return the Core instance
309    */
310   virtual Dali::Integration::Core& GetCore();
311
312   /**
313    * @copydoc Dali::Adaptor::SetRenderRefreshRate()
314    */
315   void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
316
317   /**
318    * @copydoc Dali::Adaptor::SetUseHardwareVSync()
319    */
320   void SetUseHardwareVSync(bool useHardware);
321
322   /**
323    * Return the PlatformAbstraction.
324    * @return The PlatformAbstraction.
325    */
326   Integration::PlatformAbstraction& GetPlatformAbstraction() const;
327
328   /**
329    * Destroy the TtsPlayer of specific mode.
330    * @param[in] mode The mode of TtsPlayer to destroy
331    */
332   void DestroyTtsPlayer(Dali::TtsPlayer::Mode mode);
333
334   /**
335    * @brief Sets minimum distance in pixels that the fingers must move towards/away from each other in order to
336    * trigger a pinch gesture
337    *
338    * @param[in] distance The minimum pinch distance in pixels
339    */
340   void SetMinimumPinchDistance(float distance);
341
342   /**
343    * Gets native window handle
344    *
345    * @return native window handle
346    */
347   Any GetNativeWindowHandle();
348
349   /**
350    * Get the native display associated with the graphics backend
351    *
352    * @return A handle to the native display
353    */
354   Any GetGraphicsDisplay();
355
356   /**
357    * Sets use remote surface for Surface output
358    * @param[in] useRemoteSurface True if the remote surface is used
359    */
360   void SetUseRemoteSurface(bool useRemoteSurface);
361
362 public:
363
364   /**
365    * Adds an adaptor observer so that we can observe the adaptor's lifetime events.
366    * @param[in]  observer  The observer.
367    * @note Observers should remove themselves when they are destroyed.
368    */
369   void AddObserver( LifeCycleObserver& observer );
370
371   /**
372    * Removes the observer from the adaptor.
373    * @param[in]  observer  The observer to remove.
374    * @note Observers should remove themselves when they are destroyed.
375    */
376   void RemoveObserver( LifeCycleObserver& observer );
377
378   /**
379    * Emits the Notification event to the Dali core.
380    */
381   void SendNotificationEvent();
382
383   /**
384    * Request adaptor to update once
385    */
386   void RequestUpdateOnce();
387
388   /**
389    * @copydoc Dali::Adaptor::NotifySceneCreated()
390    */
391   void NotifySceneCreated();
392
393   /**
394    * @copydoc Dali::Adaptor::NotifyLanguageChanged()
395    */
396   void NotifyLanguageChanged();
397
398   /**
399    * Gets AppId of current application
400    */
401   void GetAppId( std::string& appId );
402
403   /**
404    * Informs core the surface size has changed
405    */
406   void SurfaceResizePrepare( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
407
408   /**
409    * Informs ThreadController the surface size has changed
410    */
411   void SurfaceResizeComplete( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
412
413   /**
414    * Sets layout direction of root by system language
415    * @param[in] locale System locale
416    */
417   void SetRootLayoutDirection( std::string locale );
418
419   /**
420    * @copydoc Dali::Adaptor::RenderOnce
421    */
422   void RenderOnce();
423
424   /**
425    * @copydoc Dali::Adaptor::GetLogFactory
426    */
427   const LogFactoryInterface& GetLogFactory();
428
429   /**
430    * @copydoc Dali::Adaptor::RegisterProcessor
431    */
432   void RegisterProcessor( Integration::Processor& processor );
433
434   /**
435    * @coydoc Dali::Adaptor::UnregisterProcessor
436    */
437   void UnregisterProcessor( Integration::Processor& processor );
438
439 public:  //AdaptorInternalServices
440
441   /**
442    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPlatformAbstractionInterface()
443    */
444   virtual Dali::Integration::PlatformAbstraction& GetPlatformAbstractionInterface();
445
446   /**
447    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetDisplayConnectionInterface()
448    */
449   virtual Dali::DisplayConnection& GetDisplayConnectionInterface();
450
451   /**
452    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetGraphicsInterface()
453    */
454   virtual GraphicsInterface& GetGraphicsInterface();
455
456   /**
457    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventInterface()
458    */
459   virtual TriggerEventInterface& GetProcessCoreEventsTrigger();
460
461   /**
462    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventFactoryInterface()
463    */
464   virtual TriggerEventFactoryInterface& GetTriggerEventFactoryInterface();
465
466   /**
467    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSocketFactoryInterface()
468    */
469   virtual SocketFactoryInterface& GetSocketFactoryInterface();
470
471   /**
472    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetRenderSurfaceInterface()
473    */
474   virtual Dali::RenderSurfaceInterface* GetRenderSurfaceInterface();
475
476   /**
477    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetVSyncMonitorInterface()
478    */
479   virtual VSyncMonitorInterface* GetVSyncMonitorInterface();
480
481   /**
482    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPerformanceInterface()
483    */
484   virtual PerformanceInterface* GetPerformanceInterface();
485
486   /**
487    * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetKernelTraceInterface()
488    */
489   virtual TraceInterface& GetKernelTraceInterface();
490
491   /**
492    * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSystemTraceInterface()
493    */
494   virtual TraceInterface& GetSystemTraceInterface();
495
496 public: // Signals
497
498   /**
499    * @copydoc Dali::Adaptor::SignalResized
500    */
501   AdaptorSignalType& ResizedSignal()
502   {
503     return mResizedSignal;
504   }
505
506   /**
507    * @copydoc Dali::Adaptor::LanguageChangedSignal
508    */
509   AdaptorSignalType& LanguageChangedSignal()
510   {
511     return mLanguageChangedSignal;
512   }
513
514   /**
515    * Gets the gesture manager.
516    * @return The GestureManager
517    */
518   GestureManager* GetGestureManager() const
519   {
520     return mGestureManager;
521   }
522
523 private: // From Dali::Internal::Adaptor::CoreEventInterface
524
525   /**
526    * @copydoc Dali::Internal::Adaptor::CoreEventInterface::QueueCoreEvent()
527    */
528   virtual void QueueCoreEvent(const Dali::Integration::Event& event);
529
530   /**
531    * @copydoc Dali::Internal::Adaptor:CoreEventInterface:::ProcessCoreEvents()
532    */
533   virtual void ProcessCoreEvents();
534
535 private: // From Dali::Integration::RenderController
536
537   /**
538    * @copydoc Dali::Integration::RenderController::RequestUpdate()
539    */
540   virtual void RequestUpdate( bool forceUpdate );
541
542   /**
543    * @copydoc Dali::Integration::RenderController::RequestProcessEventsOnIdle()
544    */
545   virtual void RequestProcessEventsOnIdle( bool forceProcess );
546
547 private: // From Dali::Internal::Adaptor::WindowVisibilityObserver
548
549   /**
550    * Called when the window becomes fully or partially visible.
551    */
552   virtual void OnWindowShown();
553
554   /**
555    * Called when the window is fully hidden.
556    */
557   virtual void OnWindowHidden();
558
559 private: // From Dali::Internal::Adaptor::DamageObserver
560
561   /**
562    * @copydoc Dali::Internal::Adaptor::DamageObserver::OnDamaged()
563    */
564   void OnDamaged( const DamageArea& area );
565
566 private:
567
568   // Undefined
569   Adaptor(const Adaptor&) = delete;
570   Adaptor& operator=(Adaptor&) = delete;
571
572 private:
573
574   /**
575    * Assigns the render surface to the adaptor
576    *
577    */
578   void SetSurface(Dali::RenderSurfaceInterface *surface);
579
580   /**
581    * called after surface is created
582    */
583   void SurfaceInitialized();
584
585   /**
586    * Sends an notification message from main loop idle handler
587    */
588   bool ProcessCoreEventsFromIdle();
589
590   /**
591    * Gets path for data/resource storage.
592    * @param[out] path Path for data/resource storage
593    */
594   void GetDataStoragePath(std::string& path);
595
596   /**
597    * Sets up system information if needs
598    */
599   void SetupSystemInformation();
600
601   /**
602    * Adds a callback to be run when entering an idle state.
603    *
604    * A callback of the following type should be used:
605    * @code
606    *   bool MyFunction();
607    * @endcode
608    * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
609    */
610   bool AddIdleEnterer( CallbackBase* callback, bool forceAdd );
611
612   /**
613    * Removes a previously added the idle enterer callback.
614    */
615   void RemoveIdleEnterer( CallbackBase* callback );
616
617 private:
618
619   /**
620    * Constructor
621    * @param[in]  window       window handle
622    * @param[in]  adaptor      The public adaptor
623    * @param[in]  surface      A render surface can be one of the following
624    *                          - Pixmap, adaptor will use existing Pixmap to draw on to
625    *                          - Window, adaptor will use existing Window to draw on to
626    * @param[in]  environmentOptions  A pointer to the environment options. If NULL then one is created.
627    */
628   Adaptor( Dali::Integration::SceneHolder window, Dali::Adaptor& adaptor, Dali::RenderSurfaceInterface* surface, EnvironmentOptions* environmentOptions );
629
630 private: // Types
631
632   enum State
633   {
634     READY,               ///< Initial state before Adaptor::Start is called.
635     RUNNING,             ///< Adaptor is running.
636     PAUSED,              ///< Adaptor has been paused.
637     PAUSED_WHILE_HIDDEN, ///< Adaptor is paused while window is hidden (& cannot be resumed until window is shown).
638     STOPPED,             ///< Adaptor has been stopped.
639   };
640
641   using SceneHolderPtr = IntrusivePtr< Dali::Internal::Adaptor::SceneHolder >;
642   using WindowContainer = std::vector<SceneHolderPtr>;
643   using ObserverContainer = std::vector<LifeCycleObserver*>;
644
645 private: // Data
646
647   AdaptorSignalType                     mResizedSignal;               ///< Resized signal.
648   AdaptorSignalType                     mLanguageChangedSignal;       ///< Language changed signal.
649
650   Dali::Adaptor&                        mAdaptor;                     ///< Reference to public adaptor instance.
651   State                                 mState;                       ///< Current state of the adaptor
652   Dali::Integration::Core*              mCore;                        ///< Dali Core
653   ThreadController*                     mThreadController;            ///< Controls the threads
654   VSyncMonitor*                         mVSyncMonitor;                ///< Monitors VSync events
655
656   GraphicsInterface*                    mGraphics;                    ///< Graphics interface
657   Dali::DisplayConnection*              mDisplayConnection;           ///< Display connection
658   WindowContainer                       mWindows;                     ///< A container of all the Windows that are currently created
659
660   TizenPlatform::TizenPlatformAbstraction* mPlatformAbstraction;      ///< Platform abstraction
661
662   CallbackManager*                      mCallbackManager;             ///< Used to install callbacks
663   bool                                  mNotificationOnIdleInstalled; ///< whether the idle handler is installed to send an notification event
664   TriggerEventInterface*                mNotificationTrigger;         ///< Notification event trigger
665   GestureManager*                       mGestureManager;              ///< Gesture manager
666   FeedbackPluginProxy*                  mDaliFeedbackPlugin;          ///< Used to access feedback support
667   FeedbackController*                   mFeedbackController;          ///< Plays feedback effects for Dali-Toolkit UI Controls.
668   Dali::TtsPlayer                       mTtsPlayers[Dali::TtsPlayer::MODE_NUM];                   ///< Provides TTS support
669   ObserverContainer                     mObservers;                   ///< A list of adaptor observer pointers
670   EnvironmentOptions*                   mEnvironmentOptions;          ///< environment options
671   PerformanceInterface*                 mPerformanceInterface;        ///< Performance interface
672   KernelTrace                           mKernelTracer;                ///< Kernel tracer
673   SystemTrace                           mSystemTracer;                ///< System tracer
674   TriggerEventFactory                   mTriggerEventFactory;         ///< Trigger event factory
675   ObjectProfiler*                       mObjectProfiler;              ///< Tracks object lifetime for profiling
676   SocketFactory                         mSocketFactory;               ///< Socket factory
677   const bool                            mEnvironmentOptionsOwned:1;   ///< Whether we own the EnvironmentOptions (and thus, need to delete it)
678   bool                                  mUseRemoteSurface;            ///< whether the remoteSurface is used or not
679
680 public:
681   inline static Adaptor& GetImplementation(Dali::Adaptor& adaptor) { return *adaptor.mImpl; }
682 };
683
684 } // namespace Internal
685
686 } // namespace Adaptor
687
688 } // namespace Dali
689
690 #endif // DALI_INTERNAL_ADAPTOR_IMPL_H