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