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