Duckstation/src/core/host_interface.h

#pragma once
#include "common/string.h"
#include "common/timer.h"
#include "settings.h"
#include "types.h"
#include <chrono>
#include <deque>
#include <functional>
#include <memory>
#include <mutex>
#include <optional>
#include <string>
#include <vector>

enum LOGLEVEL;

class AudioStream;
class ByteStream;
class CDImage;
class HostDisplay;
class GameList;

struct SystemBootParameters;

namespace BIOS {
struct ImageInfo;
}

class HostInterface
{
public:
  enum : u32
  {
    AUDIO_SAMPLE_RATE = 44100,
    AUDIO_CHANNELS = 2,
    DEFAULT_AUDIO_BUFFER_SIZE = 2048
  };

  HostInterface();
  virtual ~HostInterface();

  /// Access to host display.
  ALWAYS_INLINE HostDisplay* GetDisplay() const { return m_display.get(); }

  /// Access to host audio stream.
  ALWAYS_INLINE AudioStream* GetAudioStream() const { return m_audio_stream.get(); }

  /// Initializes the emulator frontend.
  virtual bool Initialize();

  /// Shuts down the emulator frontend.
  virtual void Shutdown();

  virtual bool BootSystem(std::shared_ptr<SystemBootParameters> parameters);
  virtual void PauseSystem(bool paused);
  virtual void ResetSystem();
  virtual void DestroySystem();

  /// Loads state from the specified filename.
  bool LoadState(const char* filename);

  virtual void ReportError(const char* message);
  virtual void ReportMessage(const char* message);
  virtual void ReportDebuggerMessage(const char* message);
  virtual bool ConfirmMessage(const char* message);

  void ReportFormattedError(const char* format, ...) printflike(2, 3);
  void ReportFormattedMessage(const char* format, ...) printflike(2, 3);
  void ReportFormattedDebuggerMessage(const char* format, ...) printflike(2, 3);
  bool ConfirmFormattedMessage(const char* format, ...) printflike(2, 3);

  /// Adds OSD messages, duration is in seconds.
  virtual void AddOSDMessage(std::string message, float duration = 2.0f);
  void AddFormattedOSDMessage(float duration, const char* format, ...) printflike(3, 4);

  /// Returns the base user directory path.
  ALWAYS_INLINE const std::string& GetUserDirectory() const { return m_user_directory; }

  /// Returns a path relative to the user directory.
  std::string GetUserDirectoryRelativePath(const char* format, ...) const printflike(2, 3);

  /// Returns a path relative to the application directory (for system files).
  std::string GetProgramDirectoryRelativePath(const char* format, ...) const printflike(2, 3);

  /// Returns a string which can be used as part of a filename, based on the current date/time.
  static TinyString GetTimestampStringForFileName();

  /// Displays a loading screen with the logo, rendered with ImGui. Use when executing possibly-time-consuming tasks
  /// such as compiling shaders when starting up.
  virtual void DisplayLoadingScreen(const char* message, int progress_min = -1, int progress_max = -1,
                                    int progress_value = -1);

  /// Retrieves information about specified game from game list.
  virtual void GetGameInfo(const char* path, CDImage* image, std::string* code, std::string* title);

  /// Returns the directory where per-game memory cards will be saved.
  virtual std::string GetMemoryCardDirectory() const;

  /// Returns the default path to a memory card.
  virtual std::string GetSharedMemoryCardPath(u32 slot) const;

  /// Returns the default path to a memory card for a specific game.
  virtual std::string GetGameMemoryCardPath(const char* game_code, u32 slot) const;

  /// Returns the path to the shader cache directory.
  virtual std::string GetShaderCacheBasePath() const;

  /// Returns a setting value from the configuration.
  virtual std::string GetStringSettingValue(const char* section, const char* key, const char* default_value = "") = 0;

  /// Returns a boolean setting from the configuration.
  virtual bool GetBoolSettingValue(const char* section, const char* key, bool default_value = false);

  /// Returns an integer setting from the configuration.
  virtual int GetIntSettingValue(const char* section, const char* key, int default_value = 0);

  /// Returns a float setting from the configuration.
  virtual float GetFloatSettingValue(const char* section, const char* key, float default_value = 0.0f);

  /// Returns a string list from the configuration.
  virtual std::vector<std::string> GetSettingStringList(const char* section, const char* key) = 0;

  /// Translates a string to the current language.
  virtual TinyString TranslateString(const char* context, const char* str, const char* disambiguation = nullptr,
                                     int n = -1) const;
  virtual std::string TranslateStdString(const char* context, const char* str, const char* disambiguation = nullptr,
                                         int n = -1) const;

  /// Returns the path to the directory to search for BIOS images.
  virtual std::string GetBIOSDirectory();

  /// Loads the BIOS image for the specified region.
  std::optional<std::vector<u8>> GetBIOSImage(ConsoleRegion region);

  /// Searches for a BIOS image for the specified region in the specified directory. If no match is found, the first
  /// BIOS image within 512KB and 4MB will be used.
  std::optional<std::vector<u8>> FindBIOSImageInDirectory(ConsoleRegion region, const char* directory);

  /// Returns a list of filenames and descriptions for BIOS images in a directory.
  std::vector<std::pair<std::string, const BIOS::ImageInfo*>> FindBIOSImagesInDirectory(const char* directory);

  /// Returns true if any BIOS images are found in the configured BIOS directory.
  bool HasAnyBIOSImages();

  /// Opens a file in the DuckStation "package".
  /// This is the APK for Android builds, or the program directory for standalone builds.
  virtual std::unique_ptr<ByteStream> OpenPackageFile(const char* path, u32 flags) = 0;

  virtual void OnRunningGameChanged(const std::string& path, CDImage* image, const std::string& game_code,
                                    const std::string& game_title);
  virtual void OnSystemPerformanceCountersUpdated();

  /// Called when the display is invalidated (e.g. a state is loaded).
  virtual void OnDisplayInvalidated();

protected:
  virtual bool AcquireHostDisplay() = 0;
  virtual void ReleaseHostDisplay() = 0;
  virtual std::unique_ptr<AudioStream> CreateAudioStream(AudioBackend backend) = 0;
  virtual s32 GetAudioOutputVolume() const;

  virtual void OnSystemCreated();
  virtual void OnSystemPaused(bool paused);
  virtual void OnSystemDestroyed();
  virtual void OnSystemStateSaved(bool global, s32 slot);
  virtual void OnControllerTypeChanged(u32 slot);

  /// Restores all settings to defaults.
  virtual void SetDefaultSettings(SettingsInterface& si);

  /// Loads settings to m_settings and any frontend-specific parameters.
  virtual void LoadSettings(SettingsInterface& si);

  /// Saves current settings variables to ini.
  virtual void SaveSettings(SettingsInterface& si);

  /// Checks and fixes up any incompatible settings.
  virtual void FixIncompatibleSettings(bool display_osd_messages);

  /// Checks for settings changes, std::move() the old settings away for comparing beforehand.
  virtual void CheckForSettingsChanges(const Settings& old_settings);

  /// Switches the GPU renderer by saving state, recreating the display window, and restoring state (if needed).
  virtual void RecreateSystem();

  /// Enables "relative" mouse mode, locking the cursor position and returning relative coordinates.
  virtual void SetMouseMode(bool relative, bool hide_cursor);

  /// Call when host display size changes, use with "match display" aspect ratio setting.
  virtual void OnHostDisplayResized();

  /// Sets the user directory to the program directory, i.e. "portable mode".
  void SetUserDirectoryToProgramDirectory();

  /// Quick switch between software and hardware rendering.
  void ToggleSoftwareRendering();

  /// Adjusts the internal (render) resolution of the hardware backends.
  void ModifyResolutionScale(s32 increment);

  /// Updates software cursor state, based on controllers.
  void UpdateSoftwareCursor();

  bool SaveState(const char* filename);
  void CreateAudioStream();

  std::unique_ptr<HostDisplay> m_display;
  std::unique_ptr<AudioStream> m_audio_stream;
  std::string m_program_directory;
  std::string m_user_directory;
};

#define TRANSLATABLE(context, str) str

extern HostInterface* g_host_interface;