Revert "[Tizen] Revert "Not ref counting the windows in the adaptor""
[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 GlImplementation;
76 class GlSyncImplementation;
77 class ThreadController;
78 class TriggerEvent;
79 class CallbackManager;
80 class FeedbackPluginProxy;
81 class FeedbackController;
82 class VSyncMonitor;
83 class PerformanceInterface;
84 class LifeCycleObserver;
85 class ObjectProfiler;
86 class SceneHolder;
87
88 /**
89  * Implementation of the Adaptor class.
90  */
91 class Adaptor : public Integration::RenderController,
92                 public AdaptorInternalServices,
93                 public CoreEventInterface,
94                 public DamageObserver,
95                 public WindowVisibilityObserver
96 {
97 public:
98
99   using AdaptorSignalType =  Dali::Adaptor::AdaptorSignalType;
100   using WindowCreatedSignalType = Dali::Adaptor::WindowCreatedSignalType;
101
102   using SurfaceSize = Uint16Pair;          ///< 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                           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   /**
306    * @copydoc Dali::Adaptor::GetWindows()
307    */
308   Dali::WindowContainer GetWindows() const;
309
310 public:
311
312   /**
313    * @return the Core instance
314    */
315   virtual Dali::Integration::Core& GetCore();
316
317   /**
318    * @copydoc Dali::Adaptor::SetRenderRefreshRate()
319    */
320   void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
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    * Gets native window handle
336    *
337    * @return native window handle
338    */
339   Any GetNativeWindowHandle();
340
341   /**
342    * Get the native display associated with the graphics backend
343    *
344    * @return A handle to the native display
345    */
346   Any GetGraphicsDisplay();
347
348   /**
349    * Sets use remote surface for Surface output
350    * @param[in] useRemoteSurface True if the remote surface is used
351    */
352   void SetUseRemoteSurface(bool useRemoteSurface);
353
354 public:
355
356   /**
357    * Adds an adaptor observer so that we can observe the adaptor's lifetime events.
358    * @param[in]  observer  The observer.
359    * @note Observers should remove themselves when they are destroyed.
360    */
361   void AddObserver( LifeCycleObserver& observer );
362
363   /**
364    * Removes the observer from the adaptor.
365    * @param[in]  observer  The observer to remove.
366    * @note Observers should remove themselves when they are destroyed.
367    */
368   void RemoveObserver( LifeCycleObserver& observer );
369
370   /**
371    * Emits the Notification event to the Dali core.
372    */
373   void SendNotificationEvent();
374
375   /**
376    * Request adaptor to update once
377    */
378   void RequestUpdateOnce();
379
380   /**
381    * @copydoc Dali::Adaptor::NotifySceneCreated()
382    */
383   void NotifySceneCreated();
384
385   /**
386    * @copydoc Dali::Adaptor::NotifyLanguageChanged()
387    */
388   void NotifyLanguageChanged();
389
390   /**
391    * Gets AppId of current application
392    */
393   void GetAppId( std::string& appId );
394
395   /**
396    * @copydoc Dali::Adaptor::SurfaceResizePrepare
397    */
398   void SurfaceResizePrepare( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
399
400   /**
401    * @copydoc Dali::Adaptor::SurfaceResizeComplete
402    */
403   void SurfaceResizeComplete( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
404
405   /**
406    * Sets layout direction of root by system language
407    * @param[in] locale System locale
408    */
409   void SetRootLayoutDirection( std::string locale );
410
411   /**
412    * @copydoc Dali::Adaptor::RenderOnce
413    */
414   void RenderOnce();
415
416   /**
417    * @copydoc Dali::Adaptor::GetLogFactory
418    */
419   const LogFactoryInterface& GetLogFactory();
420
421   /**
422    * @copydoc Dali::Adaptor::RegisterProcessor
423    */
424   void RegisterProcessor( Integration::Processor& processor );
425
426   /**
427    * @coydoc Dali::Adaptor::UnregisterProcessor
428    */
429   void UnregisterProcessor( Integration::Processor& processor );
430
431 public:  //AdaptorInternalServices
432
433   /**
434    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPlatformAbstractionInterface()
435    */
436   virtual Dali::Integration::PlatformAbstraction& GetPlatformAbstractionInterface();
437
438   /**
439    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetDisplayConnectionInterface()
440    */
441   virtual Dali::DisplayConnection& GetDisplayConnectionInterface();
442
443   /**
444    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetGraphicsInterface()
445    */
446   virtual GraphicsInterface& GetGraphicsInterface();
447
448   /**
449    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventInterface()
450    */
451   virtual TriggerEventInterface& GetProcessCoreEventsTrigger();
452
453   /**
454    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventFactoryInterface()
455    */
456   virtual TriggerEventFactoryInterface& GetTriggerEventFactoryInterface();
457
458   /**
459    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSocketFactoryInterface()
460    */
461   virtual SocketFactoryInterface& GetSocketFactoryInterface();
462
463   /**
464    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetRenderSurfaceInterface()
465    */
466   virtual Dali::RenderSurfaceInterface* GetRenderSurfaceInterface();
467
468   /**
469    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPerformanceInterface()
470    */
471   virtual PerformanceInterface* GetPerformanceInterface();
472
473   /**
474    * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetKernelTraceInterface()
475    */
476   virtual TraceInterface& GetKernelTraceInterface();
477
478   /**
479    * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSystemTraceInterface()
480    */
481   virtual TraceInterface& GetSystemTraceInterface();
482
483 public: // Signals
484
485   /**
486    * @copydoc Dali::Adaptor::SignalResized
487    */
488   AdaptorSignalType& ResizedSignal()
489   {
490     return mResizedSignal;
491   }
492
493   /**
494    * @copydoc Dali::Adaptor::LanguageChangedSignal
495    */
496   AdaptorSignalType& LanguageChangedSignal()
497   {
498     return mLanguageChangedSignal;
499   }
500
501   /**
502    * @copydoc Dali::Adaptor::WindowCreatedSignal
503    */
504   WindowCreatedSignalType& WindowCreatedSignal()
505   {
506     return mWindowCreatedSignal;
507   }
508
509 public: // From Dali::Internal::Adaptor::CoreEventInterface
510
511   /**
512    * @copydoc Dali::Internal::Adaptor:CoreEventInterface:::ProcessCoreEvents()
513    */
514   virtual void ProcessCoreEvents();
515
516 private: // From Dali::Internal::Adaptor::CoreEventInterface
517
518   /**
519    * @copydoc Dali::Internal::Adaptor::CoreEventInterface::QueueCoreEvent()
520    */
521   virtual void QueueCoreEvent(const Dali::Integration::Event& event);
522
523 private: // From Dali::Integration::RenderController
524
525   /**
526    * @copydoc Dali::Integration::RenderController::RequestUpdate()
527    */
528   virtual void RequestUpdate( bool forceUpdate );
529
530   /**
531    * @copydoc Dali::Integration::RenderController::RequestProcessEventsOnIdle()
532    */
533   virtual void RequestProcessEventsOnIdle( bool forceProcess );
534
535 public: // From Dali::Internal::Adaptor::WindowVisibilityObserver
536
537   /**
538    * Called when the window becomes fully or partially visible.
539    */
540   virtual void OnWindowShown();
541
542   /**
543    * Called when the window is fully hidden.
544    */
545   virtual void OnWindowHidden();
546
547 private: // From Dali::Internal::Adaptor::DamageObserver
548
549   /**
550    * @copydoc Dali::Internal::Adaptor::DamageObserver::OnDamaged()
551    */
552   void OnDamaged( const DamageArea& area );
553
554 private:
555
556   // Undefined
557   Adaptor(const Adaptor&) = delete;
558   Adaptor& operator=(Adaptor&) = delete;
559
560 private:
561
562   /**
563    * Assigns the render surface to the adaptor
564    *
565    */
566   void SetSurface(Dali::RenderSurfaceInterface *surface);
567
568   /**
569    * called after surface is created
570    */
571   void SurfaceInitialized();
572
573   /**
574    * Sends an notification message from main loop idle handler
575    */
576   bool ProcessCoreEventsFromIdle();
577
578   /**
579    * Gets path for data/resource storage.
580    * @param[out] path Path for data/resource storage
581    */
582   void GetDataStoragePath(std::string& path);
583
584   /**
585    * Sets up system information if needs
586    */
587   void SetupSystemInformation();
588
589   /**
590    * Adds a callback to be run when entering an idle state.
591    *
592    * A callback of the following type should be used:
593    * @code
594    *   bool MyFunction();
595    * @endcode
596    * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
597    */
598   bool AddIdleEnterer( CallbackBase* callback, bool forceAdd );
599
600   /**
601    * Removes a previously added the idle enterer callback.
602    */
603   void RemoveIdleEnterer( CallbackBase* callback );
604
605 private:
606
607   /**
608    * Constructor
609    * @param[in]  window       window handle
610    * @param[in]  adaptor      The public adaptor
611    * @param[in]  surface      A render surface can be one of the following
612    *                          - Pixmap, adaptor will use existing Pixmap to draw on to
613    *                          - Window, adaptor will use existing Window to draw on to
614    * @param[in]  environmentOptions  A pointer to the environment options. If NULL then one is created.
615    */
616   Adaptor( Dali::Integration::SceneHolder window, Dali::Adaptor& adaptor, Dali::RenderSurfaceInterface* surface, EnvironmentOptions* environmentOptions );
617
618 private: // Types
619
620   enum State
621   {
622     READY,                     ///< Initial state before Adaptor::Start is called.
623     RUNNING,                   ///< Adaptor is running.
624     PAUSED,                    ///< Adaptor has been paused.
625     PAUSED_WHILE_HIDDEN,       ///< Adaptor is paused while window is hidden (& cannot be resumed until window is shown).
626     PAUSED_WHILE_INITIALIZING, ///< Adaptor is paused while application is initializing.
627     STOPPED,                   ///< Adaptor has been stopped.
628   };
629
630   // There is no weak handle for BaseHandle in DALi, but we can't ref count the window here,
631   // so we have to store the raw pointer.
632   using WindowContainer = std::vector<Dali::Internal::Adaptor::SceneHolder*>;
633   using ObserverContainer = std::vector<LifeCycleObserver*>;
634
635 private: // Data
636
637   AdaptorSignalType                     mResizedSignal;               ///< Resized signal.
638   AdaptorSignalType                     mLanguageChangedSignal;       ///< Language changed signal.
639   WindowCreatedSignalType               mWindowCreatedSignal;         ///< Window created signal.
640
641   Dali::Adaptor&                        mAdaptor;                     ///< Reference to public adaptor instance.
642   State                                 mState;                       ///< Current state of the adaptor
643   Dali::Integration::Core*              mCore;                        ///< Dali Core
644   ThreadController*                     mThreadController;            ///< Controls the threads
645
646   GraphicsInterface*                    mGraphics;                    ///< Graphics interface
647   Dali::DisplayConnection*              mDisplayConnection;           ///< Display connection
648   WindowContainer                       mWindows;                     ///< A container of all the Windows that are currently created
649
650   TizenPlatform::TizenPlatformAbstraction* mPlatformAbstraction;      ///< Platform abstraction
651
652   CallbackManager*                      mCallbackManager;             ///< Used to install callbacks
653   bool                                  mNotificationOnIdleInstalled; ///< whether the idle handler is installed to send an notification event
654   TriggerEventInterface*                mNotificationTrigger;         ///< Notification event trigger
655   FeedbackPluginProxy*                  mDaliFeedbackPlugin;          ///< Used to access feedback support
656   FeedbackController*                   mFeedbackController;          ///< Plays feedback effects for Dali-Toolkit UI Controls.
657   Dali::TtsPlayer                       mTtsPlayers[Dali::TtsPlayer::MODE_NUM];                   ///< Provides TTS support
658   ObserverContainer                     mObservers;                   ///< A list of adaptor observer pointers
659   EnvironmentOptions*                   mEnvironmentOptions;          ///< environment options
660   PerformanceInterface*                 mPerformanceInterface;        ///< Performance interface
661   KernelTrace                           mKernelTracer;                ///< Kernel tracer
662   SystemTrace                           mSystemTracer;                ///< System tracer
663   TriggerEventFactory                   mTriggerEventFactory;         ///< Trigger event factory
664   ObjectProfiler*                       mObjectProfiler;              ///< Tracks object lifetime for profiling
665   SocketFactory                         mSocketFactory;               ///< Socket factory
666   const bool                            mEnvironmentOptionsOwned:1;   ///< Whether we own the EnvironmentOptions (and thus, need to delete it)
667   bool                                  mUseRemoteSurface;            ///< whether the remoteSurface is used or not
668
669 public:
670   inline static Adaptor& GetImplementation(Dali::Adaptor& adaptor) { return *adaptor.mImpl; }
671 };
672
673 } // namespace Internal
674
675 } // namespace Adaptor
676
677 } // namespace Dali
678
679 #endif // DALI_INTERNAL_ADAPTOR_IMPL_H