path: root/dali/internal/adaptor/common/adaptor-impl.h

#ifndef DALI_INTERNAL_ADAPTOR_IMPL_H
#define DALI_INTERNAL_ADAPTOR_IMPL_H

/*
 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

// EXTERNAL INCLUDES
#include <dali/integration-api/render-controller.h>
#include <dali/public-api/common/vector-wrapper.h>
#include <dali/public-api/math/rect.h>
#include <dali/public-api/math/uint-16-pair.h>
#include <dali/public-api/signals/callback.h>

// INTERNAL INCLUDES
#include <dali/devel-api/adaptor-framework/clipboard.h>
#include <dali/integration-api/adaptor-framework/adaptor.h>
#include <dali/integration-api/adaptor-framework/scene-holder-impl.h>
#include <dali/integration-api/adaptor-framework/trigger-event-factory.h>
#include <dali/integration-api/scene.h>
#include <dali/internal/adaptor/common/adaptor-internal-services.h>
#include <dali/internal/graphics/common/graphics-interface.h>
#include <dali/internal/legacy/common/tizen-platform-abstraction.h>
#include <dali/internal/network/common/socket-factory.h>
#include <dali/internal/system/common/core-event-interface.h>
#include <dali/internal/system/common/environment-options.h>
#include <dali/internal/system/common/kernel-trace.h>
#include <dali/internal/system/common/system-trace.h>
#include <dali/internal/window-system/common/damage-observer.h>
#include <dali/internal/window-system/common/window-visibility-observer.h>
#include <dali/public-api/adaptor-framework/tts-player.h>

#include <string>

namespace Dali
{
class RenderSurfaceInterface;

namespace Accessibility
{
class Bridge;
}

namespace Integration
{
class Core;
class GlAbstraction;
class Processor;
class AddOnManager;
} // namespace Integration

namespace Internal
{
namespace Adaptor
{
class DisplayConnection;
class GraphicsFactory;
class GlImplementation;
class GlSyncImplementation;
class ThreadController;
class TriggerEvent;
class CallbackManager;
class FeedbackPluginProxy;
class FeedbackController;
class VSyncMonitor;
class PerformanceInterface;
class LifeCycleObserver;
class ObjectProfiler;
class SceneHolder;
class ConfigurationManager;
enum class ThreadMode;

/**
 * Implementation of the Adaptor class.
 */
class Adaptor : public Integration::RenderController,
                public AdaptorInternalServices,
                public CoreEventInterface,
                public DamageObserver,
                public WindowVisibilityObserver
{
public:
  using AdaptorSignalType       = Dali::Adaptor::AdaptorSignalType;
  using WindowCreatedSignalType = Dali::Adaptor::WindowCreatedSignalType;

  using SurfaceSize = Uint16Pair; ///< Surface size type

  /**
   * Creates a New Adaptor
   * @param[in]  window              The window handle
   * @param[in]  surface             A render surface can be one of the following
   *                                  - Pixmap, adaptor will use existing Pixmap to draw on to
   *                                  - Window, adaptor will use existing Window to draw on to
   * @param[in]  environmentOptions  A pointer to the environment options. If NULL then one is created.
   * @param[in]  threadMode          The thread mode
   */
  static Dali::Adaptor* New(Dali::Integration::SceneHolder window,
                            Dali::RenderSurfaceInterface*  surface,
                            EnvironmentOptions*            environmentOptions,
                            ThreadMode                     threadMode);

  /**
   * Creates a New Adaptor
   * @param[in]  window              The window handle
   * @param[in]  environmentOptions  A pointer to the environment options. If NULL then one is created.
   */
  static Dali::Adaptor* New(Dali::Integration::SceneHolder window,
                            EnvironmentOptions*            environmentOptions);

  /**
   * Creates a New Adaptor
   * @param[in]  graphicsFactory     A factory that creates the graphics interface
   * @param[in]  window              The window handle
   * @param[in]  surface             A render surface can be one of the following
   *                                  - Pixmap, adaptor will use existing Pixmap to draw on to
   *                                  - Window, adaptor will use existing Window to draw on to
   * @param[in]  environmentOptions  A pointer to the environment options. If NULL then one is created.
   * @param[in]  threadMode          The thread mode
   */
  static Dali::Adaptor* New(GraphicsFactory&               graphicsFactory,
                            Dali::Integration::SceneHolder window,
                            Dali::RenderSurfaceInterface*  surface,
                            EnvironmentOptions*            environmentOptions,
                            ThreadMode                     threadMode);

  /**
   * Creates a New Adaptor
   * @param[in]  graphicsFactory     A factory that creates the graphics interface
   * @param[in]  window              The window handle
   * @param[in]  environmentOptions  A pointer to the environment options. If NULL then one is created.
   */
  static Dali::Adaptor* New(GraphicsFactory&               graphicsFactory,
                            Dali::Integration::SceneHolder window,
                            EnvironmentOptions*            environmentOptions);

  /**
   * 2-step initialisation, this should be called after creating an adaptor instance.
   * @param[in]  graphicsFactory     A factory that creates the graphics interface
   */
  void Initialize(GraphicsFactory& graphicsFactory);

  /**
   * Virtual destructor.
   */
  ~Adaptor() override;

  /**
   * @copydoc Dali::Adaptor::Get()
   */
  static Dali::Adaptor& Get();

  /**
   * @copydoc Dali::Adaptor::IsAvailable()
   */
  static bool IsAvailable();

  /**
   * @copydoc Dali::Core::SceneCreated();
   */
  void SceneCreated();

  static std::string GetApplicationPackageName();

public: // AdaptorInternalServices implementation
  /**
   * @copydoc Dali::Adaptor::Start()
   */
  virtual void Start();

  /**
   * @copydoc Dali::Adaptor::Pause()
   */
  virtual void Pause();

  /**
   * @copydoc Dali::Adaptor::Resume()
   */
  virtual void Resume();

  /**
   * @copydoc Dali::Adaptor::Stop()
   */
  virtual void Stop();

  /**
   * @copydoc Dali::Adaptor::ContextLost()
   */
  virtual void ContextLost();

  /**
   * @copydoc Dali::Adaptor::ContextRegained()
   */
  virtual void ContextRegained();

  /**
   * @copydoc Dali::EventFeeder::FeedTouchPoint()
   */
  virtual void FeedTouchPoint(TouchPoint& point, int timeStamp);

  /**
   * @copydoc Dali::EventFeeder::FeedWheelEvent()
   */
  virtual void FeedWheelEvent(Dali::WheelEvent& wheelEvent);

  /**
   * @copydoc Dali::EventFeeder::FeedKeyEvent()
   */
  virtual void FeedKeyEvent(Dali::KeyEvent& keyEvent);

  /**
   * @copydoc Dali::Adaptor::ReplaceSurface()
   */
  virtual void ReplaceSurface(Dali::Integration::SceneHolder window, Dali::RenderSurfaceInterface& surface);

  /**
   * @copydoc Dali::Adaptor::GetSurface()
   */
  virtual Dali::RenderSurfaceInterface& GetSurface() const;

  /**
   * @copydoc Dali::Adaptor::ReleaseSurfaceLock()
   */
  virtual void ReleaseSurfaceLock();

  /**
   * Retrieve the TtsPlayer.
   * @param[in] mode The mode of TtsPlayer
   * @return A handle to the TtsPlayer.
   */
  virtual Dali::TtsPlayer GetTtsPlayer(Dali::TtsPlayer::Mode mode);

  /**
   * @copydoc Dali::Adaptor::AddIdle()
   */
  virtual bool AddIdle(CallbackBase* callback, bool hasReturnValue, bool forceAdd);

  /**
   * Adds a new Window instance to the Adaptor
   * @param[in]  childWindow The child window instance
   */
  virtual bool AddWindow(Dali::Integration::SceneHolder childWindow);

  /**
   * Removes an existing Window instance from the Adaptor
   * @param[in]  window The Window instance
   */
  virtual bool RemoveWindow(Dali::Integration::SceneHolder* childWindow);

  /**
   * Removes an existing Window instance from the Adaptor
   * @param[in]  windowName The Window name
   * @note If two Windows have the same name, the first one that matches will be removed
   */
  virtual bool RemoveWindow(std::string childWindowName);

  /**
   * @copydoc Dali::Adaptor::RemoveIdle()
   */
  virtual void RemoveIdle(CallbackBase* callback);

  /**
   * @copydoc Dali::Adaptor::ProcessIdle()
   */
  virtual void ProcessIdle();

  /**
   * Sets a pre-render callback.
   */
  void SetPreRenderCallback(CallbackBase* callback);

  /**
   * Removes an existing Window instance from the Adaptor
   * @param[in]  childWindow The Window instance
   */
  bool RemoveWindow(Dali::Internal::Adaptor::SceneHolder* childWindow);

  /**
   * @brief Deletes the rendering surface
   * @param[in] surface to delete
   */
  void DeleteSurface(Dali::RenderSurfaceInterface& surface);

  /**
   * @brief Retrieve the window that the given actor is added to.
   *
   * @param[in] actor The actor
   * @return The window the actor is added to or a null pointer if the actor is not added to any widnow.
   */
  Dali::Internal::Adaptor::SceneHolder* GetWindow(Dali::Actor& actor);

  /**
   * @copydoc Dali::Adaptor::GetWindows()
   */
  Dali::WindowContainer GetWindows() const;

  /**
   * @copydoc Dali::Adaptor::GetSceneHolders()
   */
  Dali::SceneHolderList GetSceneHolders() const;

  /**
   * @copydoc Dali::Adaptor::GetObjectRegistry()
   */
  Dali::ObjectRegistry GetObjectRegistry() const;

public:
  /**
   * @return the Core instance
   */
  Dali::Integration::Core& GetCore() override;

  /**
   * @copydoc Dali::Adaptor::SetRenderRefreshRate()
   */
  void SetRenderRefreshRate(unsigned int numberOfVSyncsPerRender);

  /**
   * Return the PlatformAbstraction.
   * @return The PlatformAbstraction.
   */
  Integration::PlatformAbstraction& GetPlatformAbstraction() const;

  /**
   * Destroy the TtsPlayer of specific mode.
   * @param[in] mode The mode of TtsPlayer to destroy
   */
  void DestroyTtsPlayer(Dali::TtsPlayer::Mode mode);

  /**
   * Gets native window handle
   *
   * @return native window handle
   */
  Any GetNativeWindowHandle();

  /**
   * @brief Retrieve native window handle that the given actor is added to.
   *
   * @param[in] actor The actor
   * @return native window handle
   */
  Any GetNativeWindowHandle(Dali::Actor actor);

  /**
   * Get the native display associated with the graphics backend
   *
   * @return A handle to the native display
   */
  Any GetGraphicsDisplay();

  /**
   * Sets use remote surface for Surface output
   * @param[in] useRemoteSurface True if the remote surface is used
   */
  void SetUseRemoteSurface(bool useRemoteSurface);

public:
  /**
   * Adds an adaptor observer so that we can observe the adaptor's lifetime events.
   * @param[in]  observer  The observer.
   * @note Observers should remove themselves when they are destroyed.
   */
  void AddObserver(LifeCycleObserver& observer);

  /**
   * Removes the observer from the adaptor.
   * @param[in]  observer  The observer to remove.
   * @note Observers should remove themselves when they are destroyed.
   */
  void RemoveObserver(LifeCycleObserver& observer);

  /**
   * Emits the Notification event to the Dali core.
   */
  void SendNotificationEvent();

  /**
   * Request adaptor to update once
   */
  void RequestUpdateOnce();

  /**
   * @copydoc Dali::Adaptor::NotifySceneCreated()
   */
  void NotifySceneCreated();

  /**
   * @copydoc Dali::Adaptor::NotifyLanguageChanged()
   */
  void NotifyLanguageChanged();

  /**
   * Gets AppId of current application
   */
  void GetAppId(std::string& appId);

  /**
   * Gets path for resource storage.
   * @param[out] path Path for resource storage
   */
  void GetResourceStoragePath(std::string& path);

  /**
   * @copydoc Dali::Adaptor::SurfaceResizePrepare
   */
  void SurfaceResizePrepare(Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize);

  /**
   * @copydoc Dali::Adaptor::SurfaceResizeComplete
   */
  void SurfaceResizeComplete(Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize);

  /**
   * Sets layout direction of root by system language
   * @param[in] locale System locale
   */
  void SetRootLayoutDirection(std::string locale);

  /**
   * @copydoc Dali::Adaptor::RenderOnce
   */
  void RenderOnce();

  /**
   * @copydoc Dali::Adaptor::GetLogFactory
   */
  const LogFactoryInterface& GetLogFactory();

  /**
   * @copydoc Dali::Adaptor::RegisterProcessor
   */
  void RegisterProcessor(Integration::Processor& processor, bool postProcessor);

  /**
   * @coydoc Dali::Adaptor::UnregisterProcessor
   */
  void UnregisterProcessor(Integration::Processor& processor, bool postProcessor);

  /**
   * Check MultipleWindow is supported
   */
  bool IsMultipleWindowSupported() const;

public: //AdaptorInternalServices
  /**
   * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPlatformAbstractionInterface()
   */
  Dali::Integration::PlatformAbstraction& GetPlatformAbstractionInterface() override;

  /**
   * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetDisplayConnectionInterface()
   */
  Dali::DisplayConnection& GetDisplayConnectionInterface() override;

  /**
   * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetGraphicsInterface()
   */
  GraphicsInterface& GetGraphicsInterface() override;

  /**
   * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventInterface()
   */
  TriggerEventInterface& GetProcessCoreEventsTrigger() override;

  /**
   * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSocketFactoryInterface()
   */
  SocketFactoryInterface& GetSocketFactoryInterface() override;

  /**
   * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetRenderSurfaceInterface()
   */
  Dali::RenderSurfaceInterface* GetRenderSurfaceInterface() override;

  /**
   * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPerformanceInterface()
   */
  PerformanceInterface* GetPerformanceInterface() override;

  /**
   * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetKernelTraceInterface()
   */
  TraceInterface& GetKernelTraceInterface() override;

  /**
   * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSystemTraceInterface()
   */
  TraceInterface& GetSystemTraceInterface() override;

  /**
   * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetWindowContainerInterface()
   */
  void GetWindowContainerInterface(WindowContainer& windows) override;

public: // Signals
  /**
   * @copydoc Dali::Adaptor::SignalResized
   */
  AdaptorSignalType& ResizedSignal()
  {
    return mResizedSignal;
  }

  /**
   * @copydoc Dali::Adaptor::LanguageChangedSignal
   */
  AdaptorSignalType& LanguageChangedSignal()
  {
    return mLanguageChangedSignal;
  }

  /**
   * @copydoc Dali::Adaptor::WindowCreatedSignal
   */
  WindowCreatedSignalType& WindowCreatedSignal()
  {
    return mWindowCreatedSignal;
  }

public: // From Dali::Internal::Adaptor::CoreEventInterface
  /**
   * @copydoc Dali::Internal::Adaptor:CoreEventInterface:::ProcessCoreEvents()
   */
  void ProcessCoreEvents() override;

private: // From Dali::Internal::Adaptor::CoreEventInterface
  /**
   * @copydoc Dali::Internal::Adaptor::CoreEventInterface::QueueCoreEvent()
   */
  void QueueCoreEvent(const Dali::Integration::Event& event) override;

private: // From Dali::Integration::RenderController
  /**
   * @copydoc Dali::Integration::RenderController::RequestUpdate()
   */
  void RequestUpdate(bool forceUpdate) override;

  /**
   * @copydoc Dali::Integration::RenderController::RequestProcessEventsOnIdle()
   */
  void RequestProcessEventsOnIdle(bool forceProcess) override;

public: // From Dali::Internal::Adaptor::WindowVisibilityObserver
  /**
   * Called when the window becomes fully or partially visible.
   */
  void OnWindowShown() override;

  /**
   * Called when the window is fully hidden.
   */
  void OnWindowHidden() override;

private: // From Dali::Internal::Adaptor::DamageObserver
  /**
   * @copydoc Dali::Internal::Adaptor::DamageObserver::OnDamaged()
   */
  void OnDamaged(const DamageArea& area) override;

private:
  // Undefined
  Adaptor(const Adaptor&) = delete;
  Adaptor& operator=(Adaptor&) = delete;

private:
  /**
   * Assigns the render surface to the adaptor
   *
   */
  void SetSurface(Dali::RenderSurfaceInterface* surface);

  /**
   * called after surface is created
   */
  void SurfaceInitialized();

  /**
   * Sends an notification message from main loop idle handler
   */
  bool ProcessCoreEventsFromIdle();

  /**
   * Gets path for data/resource storage.
   * @param[out] path Path for data/resource storage
   */
  void GetDataStoragePath(std::string& path);

  /**
   * Sets up system information if needs
   */
  void SetupSystemInformation();

  /**
   * Adds a callback to be run when entering an idle state.
   *
   * A callback of the following type should be used:
   * @code
   *   bool MyFunction();
   * @endcode
   * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
   */
  bool AddIdleEnterer(CallbackBase* callback, bool forceAdd);

  /**
   * Removes a previously added the idle enterer callback.
   */
  void RemoveIdleEnterer(CallbackBase* callback);

private:
  /**
   * Constructor
   * @param[in]  window       window handle
   * @param[in]  adaptor      The public adaptor
   * @param[in]  surface      A render surface can be one of the following
   *                          - Pixmap, adaptor will use existing Pixmap to draw on to
   *                          - Window, adaptor will use existing Window to draw on to
   * @param[in]  environmentOptions  A pointer to the environment options. If NULL then one is created.
   * @param[in]  threadMode   The ThreadMode of the Adaptor
   */
  Adaptor(Dali::Integration::SceneHolder window, Dali::Adaptor& adaptor, Dali::RenderSurfaceInterface* surface, EnvironmentOptions* environmentOptions, ThreadMode threadMode);

private: // Types
  enum State
  {
    READY,                     ///< Initial state before Adaptor::Start is called.
    RUNNING,                   ///< Adaptor is running.
    PAUSED,                    ///< Adaptor has been paused.
    PAUSED_WHILE_HIDDEN,       ///< Adaptor is paused while window is hidden (& cannot be resumed until window is shown).
    PAUSED_WHILE_INITIALIZING, ///< Adaptor is paused while application is initializing.
    STOPPED,                   ///< Adaptor has been stopped.
  };

  // There is no weak handle for BaseHandle in DALi, but we can't ref count the window here,
  // so we have to store the raw pointer.
  using WindowContainer   = std::vector<Dali::Internal::Adaptor::SceneHolder*>;
  using ObserverContainer = std::vector<LifeCycleObserver*>;

private:                                          // Data
  AdaptorSignalType       mResizedSignal;         ///< Resized signal.
  AdaptorSignalType       mLanguageChangedSignal; ///< Language changed signal.
  WindowCreatedSignalType mWindowCreatedSignal;   ///< Window created signal.

  Dali::Adaptor&           mAdaptor;          ///< Reference to public adaptor instance.
  State                    mState;            ///< Current state of the adaptor
  Dali::Integration::Core* mCore;             ///< Dali Core
  ThreadController*        mThreadController; ///< Controls the threads

  std::unique_ptr<GraphicsInterface> mGraphics;          ///< Graphics interface
  Dali::DisplayConnection*           mDisplayConnection; ///< Display connection
  WindowContainer                    mWindows;           ///< A container of all the Windows that are currently created

  std::unique_ptr<ConfigurationManager> mConfigurationManager; ///< Configuration manager

  TizenPlatform::TizenPlatformAbstraction* mPlatformAbstraction; ///< Platform abstraction

  CallbackManager*            mCallbackManager;                       ///< Used to install callbacks
  bool                        mNotificationOnIdleInstalled;           ///< whether the idle handler is installed to send an notification event
  TriggerEventInterface*      mNotificationTrigger;                   ///< Notification event trigger
  FeedbackPluginProxy*        mDaliFeedbackPlugin;                    ///< Used to access feedback support
  FeedbackController*         mFeedbackController;                    ///< Plays feedback effects for Dali-Toolkit UI Controls.
  Dali::TtsPlayer             mTtsPlayers[Dali::TtsPlayer::MODE_NUM]; ///< Provides TTS support
  ObserverContainer           mObservers;                             ///< A list of adaptor observer pointers
  EnvironmentOptions*         mEnvironmentOptions;                    ///< environment options
  PerformanceInterface*       mPerformanceInterface;                  ///< Performance interface
  KernelTrace                 mKernelTracer;                          ///< Kernel tracer
  SystemTrace                 mSystemTracer;                          ///< System tracer
  ObjectProfiler*             mObjectProfiler;                        ///< Tracks object lifetime for profiling
  SocketFactory               mSocketFactory;                         ///< Socket factory
  ThreadMode                  mThreadMode;                            ///< The thread mode
  const bool                  mEnvironmentOptionsOwned : 1;           ///< Whether we own the EnvironmentOptions (and thus, need to delete it)
  bool                        mUseRemoteSurface : 1;                  ///< whether the remoteSurface is used or not
  Dali::LayoutDirection::Type mRootLayoutDirection;                   ///< LayoutDirection of window

  std::unique_ptr<Integration::AddOnManager> mAddOnManager; ///< Pointer to the addon manager

  class AccessibilityObserver : public ConnectionTracker
  {
  public:
    void OnAccessibleKeyEvent(const Dali::KeyEvent& event);
  };
  AccessibilityObserver mAccessibilityObserver;

public:
  inline static Adaptor& GetImplementation(Dali::Adaptor& adaptor)
  {
    return *adaptor.mImpl;
  }
};

} // namespace Adaptor

} // namespace Internal

} // namespace Dali

#endif // DALI_INTERNAL_ADAPTOR_IMPL_H