#include "host_interface.h" #include "bios.h" #include "cdrom.h" #include "common/audio_stream.h" #include "common/byte_stream.h" #include "common/file_system.h" #include "common/log.h" #include "common/string_util.h" #include "dma.h" #include "game_list.h" #include "gpu.h" #include "host_display.h" #include "mdec.h" #include "save_state_version.h" #include "spu.h" #include "system.h" #include "timers.h" #include #include #include #include Log_SetChannel(HostInterface); #ifdef WIN32 #include "common/windows_headers.h" #include #endif HostInterface::HostInterface() { // we can get the program directory at construction time const std::string program_path = FileSystem::GetProgramPath(); m_program_directory = FileSystem::GetPathDirectory(program_path.c_str()); } HostInterface::~HostInterface() { // system should be shut down prior to the destructor Assert(!m_system && !m_audio_stream && !m_display); } bool HostInterface::Initialize() { SetUserDirectory(); InitializeUserDirectory(); LoadSettings(); UpdateLogSettings(m_settings.log_level, m_settings.log_filter.empty() ? nullptr : m_settings.log_filter.c_str(), m_settings.log_to_console, m_settings.log_to_debug, m_settings.log_to_window, m_settings.log_to_file); m_game_list = std::make_unique(); m_game_list->SetCacheFilename(GetUserDirectoryRelativePath("cache/gamelist.cache")); m_game_list->SetDatabaseFilename(GetUserDirectoryRelativePath("cache/redump.dat")); m_game_list->SetCompatibilityFilename(GetProgramDirectoryRelativePath("database/compatibility.xml")); return true; } void HostInterface::Shutdown() {} void HostInterface::CreateAudioStream() { Log_InfoPrintf("Creating '%s' audio stream, sample rate = %u, channels = %u, buffer size = %u, buffer count = %u", Settings::GetAudioBackendName(m_settings.audio_backend), AUDIO_SAMPLE_RATE, AUDIO_CHANNELS, m_settings.audio_buffer_size, m_settings.audio_buffer_count); m_audio_stream = CreateAudioStream(m_settings.audio_backend); if (!m_audio_stream || !m_audio_stream->Reconfigure(AUDIO_SAMPLE_RATE, AUDIO_CHANNELS, m_settings.audio_buffer_size, m_settings.audio_buffer_count)) { ReportFormattedError("Failed to create or configure audio stream, falling back to null output."); m_audio_stream.reset(); m_audio_stream = AudioStream::CreateNullAudioStream(); m_audio_stream->Reconfigure(AUDIO_SAMPLE_RATE, AUDIO_CHANNELS, m_settings.audio_buffer_size, m_settings.audio_buffer_count); } m_audio_stream->SetOutputVolume(m_settings.audio_output_muted ? 0 : m_settings.audio_output_volume); } bool HostInterface::BootSystem(const SystemBootParameters& parameters) { if (parameters.filename.empty()) Log_InfoPrintf("Boot Filename: "); else Log_InfoPrintf("Boot Filename: %s", parameters.filename.c_str()); if (!parameters.state_filename.empty()) Log_InfoPrintf("Save State Filename: %s", parameters.filename.c_str()); if (!AcquireHostDisplay()) { ReportFormattedError("Failed to acquire host display"); return false; } // set host display settings m_display->SetDisplayLinearFiltering(m_settings.display_linear_filtering); m_display->SetDisplayIntegerScaling(m_settings.display_integer_scaling); // create the audio stream. this will never fail, since we'll just fall back to null CreateAudioStream(); m_system = System::Create(this); if (!m_system->Boot(parameters)) { ReportFormattedError("System failed to boot. The log may contain more information."); DestroySystem(); return false; } if (!parameters.state_filename.empty()) LoadState(parameters.state_filename.c_str()); OnSystemCreated(); m_paused = m_settings.start_paused; m_audio_stream->PauseOutput(m_paused); UpdateSpeedLimiterState(); if (m_paused) OnSystemPaused(true); if (m_settings.audio_dump_on_boot) StartDumpingAudio(); return true; } void HostInterface::PauseSystem(bool paused) { if (paused == m_paused || !m_system) return; m_paused = paused; m_audio_stream->PauseOutput(m_paused); OnSystemPaused(paused); UpdateSpeedLimiterState(); if (!paused) m_system->ResetPerformanceCounters(); } void HostInterface::ResetSystem() { m_system->Reset(); m_system->ResetPerformanceCounters(); AddOSDMessage("System reset."); } void HostInterface::PowerOffSystem() { if (!m_system) return; if (m_settings.save_state_on_exit) SaveResumeSaveState(); DestroySystem(); } void HostInterface::DestroySystem() { if (!m_system) return; SetTimerResolutionIncreased(false); m_paused = false; m_system.reset(); m_audio_stream.reset(); ReleaseHostDisplay(); OnSystemDestroyed(); OnRunningGameChanged(); } void HostInterface::ReportError(const char* message) { Log_ErrorPrint(message); } void HostInterface::ReportMessage(const char* message) { Log_InfoPrintf(message); } bool HostInterface::ConfirmMessage(const char* message) { Log_WarningPrintf("ConfirmMessage(\"%s\") -> Yes"); return true; } void HostInterface::ReportFormattedError(const char* format, ...) { std::va_list ap; va_start(ap, format); std::string message = StringUtil::StdStringFromFormatV(format, ap); va_end(ap); ReportError(message.c_str()); } void HostInterface::ReportFormattedMessage(const char* format, ...) { std::va_list ap; va_start(ap, format); std::string message = StringUtil::StdStringFromFormatV(format, ap); va_end(ap); ReportMessage(message.c_str()); } bool HostInterface::ConfirmFormattedMessage(const char* format, ...) { std::va_list ap; va_start(ap, format); std::string message = StringUtil::StdStringFromFormatV(format, ap); va_end(ap); return ConfirmMessage(message.c_str()); } void HostInterface::DrawImGuiWindows() { if (m_system) { DrawDebugWindows(); DrawFPSWindow(); } DrawOSDMessages(); } void HostInterface::DrawFPSWindow() { if (!(m_settings.display_show_fps | m_settings.display_show_vps | m_settings.display_show_speed)) return; const ImVec2 window_size = ImVec2(175.0f * ImGui::GetIO().DisplayFramebufferScale.x, 16.0f * ImGui::GetIO().DisplayFramebufferScale.y); ImGui::SetNextWindowPos(ImVec2(ImGui::GetIO().DisplaySize.x - window_size.x, 0.0f), ImGuiCond_Always); ImGui::SetNextWindowSize(window_size); if (!ImGui::Begin("FPSWindow", nullptr, ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoScrollbar | ImGuiWindowFlags_NoCollapse | ImGuiWindowFlags_NoBackground | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoMouseInputs | ImGuiWindowFlags_NoBringToFrontOnFocus | ImGuiWindowFlags_NoNav)) { ImGui::End(); return; } bool first = true; if (m_settings.display_show_fps) { ImGui::Text("%.2f", m_system->GetFPS()); first = false; } if (m_settings.display_show_vps) { if (first) { first = false; } else { ImGui::SameLine(); ImGui::Text("/"); ImGui::SameLine(); } ImGui::Text("%.2f", m_system->GetVPS()); } if (m_settings.display_show_speed) { if (first) { first = false; } else { ImGui::SameLine(); ImGui::Text("/"); ImGui::SameLine(); } const float speed = m_system->GetEmulationSpeed(); const u32 rounded_speed = static_cast(std::round(speed)); if (speed < 90.0f) ImGui::TextColored(ImVec4(1.0f, 0.4f, 0.4f, 1.0f), "%u%%", rounded_speed); else if (speed < 110.0f) ImGui::TextColored(ImVec4(1.0f, 1.0f, 1.0f, 1.0f), "%u%%", rounded_speed); else ImGui::TextColored(ImVec4(0.4f, 1.0f, 0.4f, 1.0f), "%u%%", rounded_speed); } ImGui::End(); } void HostInterface::AddOSDMessage(const char* message, float duration /*= 2.0f*/) { OSDMessage msg; msg.text = message; msg.duration = duration; std::unique_lock lock(m_osd_messages_lock); m_osd_messages.push_back(std::move(msg)); } void HostInterface::AddFormattedOSDMessage(float duration, const char* format, ...) { std::va_list ap; va_start(ap, format); std::string message = StringUtil::StdStringFromFormatV(format, ap); va_end(ap); OSDMessage msg; msg.text = std::move(message); msg.duration = duration; std::unique_lock lock(m_osd_messages_lock); m_osd_messages.push_back(std::move(msg)); } void HostInterface::DrawOSDMessages() { constexpr ImGuiWindowFlags window_flags = ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoInputs | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_NoScrollbar | ImGuiWindowFlags_NoNav | ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoFocusOnAppearing; std::unique_lock lock(m_osd_messages_lock); if (m_osd_messages.empty()) return; const float scale = ImGui::GetIO().DisplayFramebufferScale.x; auto iter = m_osd_messages.begin(); float position_x = 10.0f * scale; float position_y = (10.0f + (static_cast(m_display->GetDisplayTopMargin()))) * scale; u32 index = 0; while (iter != m_osd_messages.end()) { const OSDMessage& msg = *iter; const double time = msg.time.GetTimeSeconds(); const float time_remaining = static_cast(msg.duration - time); if (time_remaining <= 0.0f) { iter = m_osd_messages.erase(iter); continue; } if (!m_settings.display_show_osd_messages) continue; const float opacity = std::min(time_remaining, 1.0f); ImGui::SetNextWindowPos(ImVec2(position_x, position_y)); ImGui::SetNextWindowSize(ImVec2(0.0f, 0.0f)); ImGui::PushStyleVar(ImGuiStyleVar_Alpha, opacity); char buf[64]; std::snprintf(buf, sizeof(buf), "osd_%u", index++); if (ImGui::Begin(buf, nullptr, window_flags)) { ImGui::TextUnformatted(msg.text.c_str()); position_y += ImGui::GetWindowSize().y + (4.0f * scale); } ImGui::End(); ImGui::PopStyleVar(); ++iter; } } void HostInterface::DrawDebugWindows() { const Settings::DebugSettings& debug_settings = m_system->GetSettings().debugging; if (debug_settings.show_gpu_state) m_system->GetGPU()->DrawDebugStateWindow(); if (debug_settings.show_cdrom_state) m_system->GetCDROM()->DrawDebugWindow(); if (debug_settings.show_timers_state) m_system->GetTimers()->DrawDebugStateWindow(); if (debug_settings.show_spu_state) m_system->GetSPU()->DrawDebugStateWindow(); if (debug_settings.show_mdec_state) m_system->GetMDEC()->DrawDebugStateWindow(); } std::optional> HostInterface::GetBIOSImage(ConsoleRegion region) { // Try the other default filenames in the directory of the configured BIOS. #define TRY_FILENAME(filename) \ do \ { \ String try_filename = filename; \ std::optional found_image = BIOS::LoadImageFromFile(try_filename.GetCharArray()); \ if (found_image) \ { \ BIOS::Hash found_hash = BIOS::GetHash(*found_image); \ Log_DevPrintf("Hash for BIOS '%s': %s", try_filename.GetCharArray(), found_hash.ToString().c_str()); \ if (BIOS::IsValidHashForRegion(region, found_hash)) \ { \ Log_InfoPrintf("Using BIOS from '%s' for region '%s'", try_filename.GetCharArray(), \ Settings::GetConsoleRegionName(region)); \ return found_image; \ } \ } \ } while (0) // Try the configured image. TRY_FILENAME(m_settings.bios_path.c_str()); // Try searching in the same folder for other region's images. switch (region) { case ConsoleRegion::NTSC_J: TRY_FILENAME(FileSystem::BuildPathRelativeToFile(m_settings.bios_path.c_str(), "scph1000.bin", false, false)); TRY_FILENAME(FileSystem::BuildPathRelativeToFile(m_settings.bios_path.c_str(), "ps-10j.bin", false, false)); TRY_FILENAME(FileSystem::BuildPathRelativeToFile(m_settings.bios_path.c_str(), "scph3000.bin", false, false)); TRY_FILENAME(FileSystem::BuildPathRelativeToFile(m_settings.bios_path.c_str(), "ps-11j.bin", false, false)); TRY_FILENAME(FileSystem::BuildPathRelativeToFile(m_settings.bios_path.c_str(), "scph5500.bin", false, false)); TRY_FILENAME(FileSystem::BuildPathRelativeToFile(m_settings.bios_path.c_str(), "ps-30j.bin", false, false)); break; case ConsoleRegion::NTSC_U: TRY_FILENAME(FileSystem::BuildPathRelativeToFile(m_settings.bios_path.c_str(), "scph1001.bin", false, false)); TRY_FILENAME(FileSystem::BuildPathRelativeToFile(m_settings.bios_path.c_str(), "ps-22a.bin", false, false)); TRY_FILENAME(FileSystem::BuildPathRelativeToFile(m_settings.bios_path.c_str(), "scph5501.bin", false, false)); TRY_FILENAME(FileSystem::BuildPathRelativeToFile(m_settings.bios_path.c_str(), "ps-30a.bin", false, false)); break; case ConsoleRegion::PAL: TRY_FILENAME(FileSystem::BuildPathRelativeToFile(m_settings.bios_path.c_str(), "scph1002.bin", false, false)); TRY_FILENAME(FileSystem::BuildPathRelativeToFile(m_settings.bios_path.c_str(), "ps-21e.bin", false, false)); TRY_FILENAME(FileSystem::BuildPathRelativeToFile(m_settings.bios_path.c_str(), "scph5502.bin", false, false)); TRY_FILENAME(FileSystem::BuildPathRelativeToFile(m_settings.bios_path.c_str(), "ps-30e.bin", false, false)); break; default: break; } #undef RELATIVE_PATH #undef TRY_FILENAME // Fall back to the default image. Log_WarningPrintf("No suitable BIOS image for region %s could be located, using configured image '%s'. This may " "result in instability.", Settings::GetConsoleRegionName(region), m_settings.bios_path.c_str()); return BIOS::LoadImageFromFile(m_settings.bios_path); } bool HostInterface::LoadState(const char* filename) { std::unique_ptr stream = FileSystem::OpenFile(filename, BYTESTREAM_OPEN_READ | BYTESTREAM_OPEN_STREAMED); if (!stream) return false; AddFormattedOSDMessage(2.0f, "Loading state from '%s'...", filename); if (m_system) { if (!m_system->LoadState(stream.get())) { ReportFormattedError("Loading state from '%s' failed. Resetting.", filename); m_system->Reset(); return false; } } else { SystemBootParameters boot_params; if (!BootSystem(boot_params)) { ReportFormattedError("Failed to boot system to load state from '%s'.", filename); return false; } if (!m_system->LoadState(stream.get())) { ReportFormattedError("Failed to load state. The log may contain more information. Shutting down system."); DestroySystem(); return false; } } m_system->ResetPerformanceCounters(); return true; } bool HostInterface::LoadState(bool global, s32 slot) { if (!global && (!m_system || m_system->GetRunningCode().empty())) { ReportFormattedError("Can't save per-game state without a running game code."); return false; } std::string save_path = global ? GetGlobalSaveStateFileName(slot) : GetGameSaveStateFileName(m_system->GetRunningCode().c_str(), slot); return LoadState(save_path.c_str()); } bool HostInterface::SaveState(const char* filename) { std::unique_ptr stream = FileSystem::OpenFile(filename, BYTESTREAM_OPEN_CREATE | BYTESTREAM_OPEN_WRITE | BYTESTREAM_OPEN_TRUNCATE | BYTESTREAM_OPEN_ATOMIC_UPDATE | BYTESTREAM_OPEN_STREAMED); if (!stream) return false; const bool result = m_system->SaveState(stream.get()); if (!result) { ReportFormattedError("Saving state to '%s' failed.", filename); stream->Discard(); } else { AddFormattedOSDMessage(2.0f, "State saved to '%s'.", filename); stream->Commit(); } return result; } bool HostInterface::SaveState(bool global, s32 slot) { const std::string& code = m_system->GetRunningCode(); if (!global && code.empty()) { ReportFormattedError("Can't save per-game state without a running game code."); return false; } std::string save_path = global ? GetGlobalSaveStateFileName(slot) : GetGameSaveStateFileName(code.c_str(), slot); if (!SaveState(save_path.c_str())) return false; OnSystemStateSaved(global, slot); return true; } bool HostInterface::ResumeSystemFromState(const char* filename, bool boot_on_failure) { SystemBootParameters boot_params; boot_params.filename = filename; if (!BootSystem(boot_params)) return false; const bool global = m_system->GetRunningCode().empty(); if (m_system->GetRunningCode().empty()) { ReportFormattedError("Cannot resume system with undetectable game code from '%s'.", filename); if (!boot_on_failure) { DestroySystem(); return true; } } else { const std::string path = GetGameSaveStateFileName(m_system->GetRunningCode().c_str(), -1); if (FileSystem::FileExists(path.c_str())) { if (!LoadState(path.c_str()) && !boot_on_failure) { DestroySystem(); return false; } } else if (!boot_on_failure) { ReportFormattedError("Resume save state not found for '%s' ('%s').", m_system->GetRunningCode().c_str(), m_system->GetRunningTitle().c_str()); DestroySystem(); return false; } } return true; } bool HostInterface::ResumeSystemFromMostRecentState() { const std::string path = GetMostRecentResumeSaveStatePath(); if (path.empty()) { ReportError("No resume save state found."); return false; } return LoadState(path.c_str()); } void HostInterface::UpdateSpeedLimiterState() { m_speed_limiter_enabled = m_settings.speed_limiter_enabled && !m_speed_limiter_temp_disabled; const bool is_non_standard_speed = (std::abs(m_settings.emulation_speed - 1.0f) > 0.05f); const bool audio_sync_enabled = !m_system || m_paused || (m_speed_limiter_enabled && m_settings.audio_sync_enabled && !is_non_standard_speed); const bool video_sync_enabled = !m_system || m_paused || (m_speed_limiter_enabled && m_settings.video_sync_enabled && !is_non_standard_speed); Log_InfoPrintf("Syncing to %s%s", audio_sync_enabled ? "audio" : "", (audio_sync_enabled && video_sync_enabled) ? " and video" : (video_sync_enabled ? "video" : "")); m_audio_stream->SetSync(audio_sync_enabled); if (audio_sync_enabled) m_audio_stream->EmptyBuffers(); m_display->SetVSync(video_sync_enabled); if (m_settings.increase_timer_resolution) SetTimerResolutionIncreased(m_speed_limiter_enabled); m_system->ResetPerformanceCounters(); } void HostInterface::OnSystemCreated() {} void HostInterface::OnSystemPaused(bool paused) { ReportFormattedMessage("System %s.", paused ? "paused" : "resumed"); } void HostInterface::OnSystemDestroyed() { ReportFormattedMessage("System shut down."); } void HostInterface::OnSystemPerformanceCountersUpdated() {} void HostInterface::OnSystemStateSaved(bool global, s32 slot) {} void HostInterface::OnRunningGameChanged() {} void HostInterface::OnControllerTypeChanged(u32 slot) {} void HostInterface::UpdateLogSettings(LOGLEVEL level, const char* filter, bool log_to_console, bool log_to_debug, bool log_to_window, bool log_to_file) { Log::SetFilterLevel(level); Log::SetConsoleOutputParams(m_settings.log_to_console, filter, level); Log::SetDebugOutputParams(m_settings.log_to_debug, filter, level); if (log_to_file) { Log::SetFileOutputParams(m_settings.log_to_file, GetUserDirectoryRelativePath("duckstation.log").c_str(), true, filter, level); } else { Log::SetFileOutputParams(false, nullptr); } } void HostInterface::SetUserDirectory() { if (!m_user_directory.empty()) return; std::fprintf(stdout, "Program directory \"%s\"\n", m_program_directory.c_str()); if (FileSystem::FileExists(StringUtil::StdStringFromFormat("%s%c%s", m_program_directory.c_str(), FS_OSPATH_SEPERATOR_CHARACTER, "portable.txt") .c_str())) { std::fprintf(stdout, "portable.txt found, using program directory as user directory.\n"); m_user_directory = m_program_directory; } else { #ifdef WIN32 // On Windows, use the path to the program. We might want to use My Documents in the future. m_user_directory = m_program_directory; #elif __linux__ // On Linux, use .local/share/duckstation as a user directory by default. const char* xdg_data_home = getenv("XDG_DATA_HOME"); if (xdg_data_home && xdg_data_home[0] == '/') { m_user_directory = StringUtil::StdStringFromFormat("%s/duckstation", xdg_data_home); } else { const char* home_path = getenv("HOME"); if (!home_path) m_user_directory = m_program_directory; else m_user_directory = StringUtil::StdStringFromFormat("%s/.local/share/duckstation", home_path); } #elif __APPLE__ // On macOS, default to ~/Library/Application Support/DuckStation. const char* home_path = getenv("HOME"); if (!home_path) m_user_directory = m_program_directory; else m_user_directory = StringUtil::StdStringFromFormat("%s/Library/Application Support/DuckStation", home_path); #endif } } void HostInterface::SetUserDirectoryToProgramDirectory() { const std::string program_path = FileSystem::GetProgramPath(); const std::string program_directory = FileSystem::GetPathDirectory(program_path.c_str()); m_user_directory = program_directory; } void HostInterface::InitializeUserDirectory() { std::fprintf(stdout, "User directory: \"%s\"\n", m_user_directory.c_str()); if (m_user_directory.empty()) Panic("Cannot continue without user directory set."); if (!FileSystem::DirectoryExists(m_user_directory.c_str())) { std::fprintf(stderr, "User directory \"%s\" does not exist, creating.\n", m_user_directory.c_str()); if (!FileSystem::CreateDirectory(m_user_directory.c_str(), true)) std::fprintf(stderr, "Failed to create user directory \"%s\".\n", m_user_directory.c_str()); } bool result = true; result &= FileSystem::CreateDirectory(GetUserDirectoryRelativePath("bios").c_str(), false); result &= FileSystem::CreateDirectory(GetUserDirectoryRelativePath("cache").c_str(), false); result &= FileSystem::CreateDirectory(GetUserDirectoryRelativePath("dump").c_str(), false); result &= FileSystem::CreateDirectory(GetUserDirectoryRelativePath("dump/audio").c_str(), false); result &= FileSystem::CreateDirectory(GetUserDirectoryRelativePath("inputprofiles").c_str(), false); result &= FileSystem::CreateDirectory(GetUserDirectoryRelativePath("savestates").c_str(), false); result &= FileSystem::CreateDirectory(GetUserDirectoryRelativePath("screenshots").c_str(), false); result &= FileSystem::CreateDirectory(GetUserDirectoryRelativePath("memcards").c_str(), false); if (!result) ReportError("Failed to create one or more user directories. This may cause issues at runtime."); } std::string HostInterface::GetUserDirectoryRelativePath(const char* format, ...) const { std::va_list ap; va_start(ap, format); std::string formatted_path = StringUtil::StdStringFromFormatV(format, ap); va_end(ap); if (m_user_directory.empty()) { return formatted_path; } else { return StringUtil::StdStringFromFormat("%s%c%s", m_user_directory.c_str(), FS_OSPATH_SEPERATOR_CHARACTER, formatted_path.c_str()); } } std::string HostInterface::GetProgramDirectoryRelativePath(const char* format, ...) const { std::va_list ap; va_start(ap, format); std::string formatted_path = StringUtil::StdStringFromFormatV(format, ap); va_end(ap); if (m_program_directory.empty()) { return formatted_path; } else { return StringUtil::StdStringFromFormat("%s%c%s", m_program_directory.c_str(), FS_OSPATH_SEPERATOR_CHARACTER, formatted_path.c_str()); } } TinyString HostInterface::GetTimestampStringForFileName() { const Timestamp ts(Timestamp::Now()); TinyString str; ts.ToString(str, "%Y-%m-%d_%H-%M-%S"); return str; } std::string HostInterface::GetSettingsFileName() const { return GetUserDirectoryRelativePath("settings.ini"); } std::string HostInterface::GetGameSaveStateFileName(const char* game_code, s32 slot) const { if (slot < 0) return GetUserDirectoryRelativePath("savestates/%s_resume.sav", game_code); else return GetUserDirectoryRelativePath("savestates/%s_%d.sav", game_code, slot); } std::string HostInterface::GetGlobalSaveStateFileName(s32 slot) const { if (slot < 0) return GetUserDirectoryRelativePath("savestates/resume.sav"); else return GetUserDirectoryRelativePath("savestates/savestate_%d.sav", slot); } std::string HostInterface::GetSharedMemoryCardPath(u32 slot) const { return GetUserDirectoryRelativePath("memcards/shared_card_%d.mcd", slot + 1); } std::string HostInterface::GetGameMemoryCardPath(const char* game_code, u32 slot) const { return GetUserDirectoryRelativePath("memcards/%s_%d.mcd", game_code, slot + 1); } std::vector HostInterface::GetAvailableSaveStates(const char* game_code) const { std::vector si; std::string path; auto add_path = [&si](std::string path, s32 slot, bool global) { FILESYSTEM_STAT_DATA sd; if (!FileSystem::StatFile(path.c_str(), &sd)) return; si.push_back(SaveStateInfo{std::move(path), sd.ModificationTime.AsUnixTimestamp(), static_cast(slot), global}); }; if (game_code && std::strlen(game_code) > 0) { add_path(GetGameSaveStateFileName(game_code, -1), -1, false); for (s32 i = 1; i <= PER_GAME_SAVE_STATE_SLOTS; i++) add_path(GetGameSaveStateFileName(game_code, i), i, false); } for (s32 i = 1; i <= GLOBAL_SAVE_STATE_SLOTS; i++) add_path(GetGlobalSaveStateFileName(i), i, true); return si; } std::optional HostInterface::GetSaveStateInfo(const char* game_code, s32 slot) { const bool global = (!game_code || game_code[0] == 0); std::string path = global ? GetGlobalSaveStateFileName(slot) : GetGameSaveStateFileName(game_code, slot); FILESYSTEM_STAT_DATA sd; if (!FileSystem::StatFile(path.c_str(), &sd)) return std::nullopt; return SaveStateInfo{std::move(path), sd.ModificationTime.AsUnixTimestamp(), slot, global}; } std::optional HostInterface::GetExtendedSaveStateInfo(const char* game_code, s32 slot) { const bool global = (!game_code || game_code[0] == 0); std::string path = global ? GetGlobalSaveStateFileName(slot) : GetGameSaveStateFileName(game_code, slot); FILESYSTEM_STAT_DATA sd; if (!FileSystem::StatFile(path.c_str(), &sd)) return std::nullopt; std::unique_ptr stream = FileSystem::OpenFile(path.c_str(), BYTESTREAM_OPEN_READ | BYTESTREAM_OPEN_SEEKABLE); if (!stream) return std::nullopt; SAVE_STATE_HEADER header; if (!stream->Read(&header, sizeof(header)) || header.magic != SAVE_STATE_MAGIC) return std::nullopt; ExtendedSaveStateInfo ssi; ssi.path = std::move(path); ssi.timestamp = sd.ModificationTime.AsUnixTimestamp(); ssi.slot = slot; ssi.global = global; if (header.version != SAVE_STATE_VERSION) { ssi.title = StringUtil::StdStringFromFormat("Invalid version %u (expected %u)", header.version, header.magic, SAVE_STATE_VERSION); return ssi; } header.title[sizeof(header.title) - 1] = 0; ssi.title = header.title; header.game_code[sizeof(header.game_code) - 1] = 0; ssi.game_code = header.game_code; if (header.screenshot_width > 0 && header.screenshot_height > 0 && header.screenshot_size > 0 && (static_cast(header.offset_to_screenshot) + static_cast(header.screenshot_size)) <= stream->GetSize()) { ssi.screenshot_data.resize((header.screenshot_size + 3u) / 4u); if (stream->Read2(ssi.screenshot_data.data(), header.screenshot_size)) { ssi.screenshot_width = header.screenshot_width; ssi.screenshot_height = header.screenshot_height; } else { decltype(ssi.screenshot_data)().swap(ssi.screenshot_data); } } return ssi; } void HostInterface::DeleteSaveStates(const char* game_code, bool resume) { const std::vector states(GetAvailableSaveStates(game_code)); for (const SaveStateInfo& si : states) { if (si.global || (!resume && si.slot < 0)) continue; Log_InfoPrintf("Removing save state at '%s'", si.path.c_str()); if (!FileSystem::DeleteFile(si.path.c_str())) Log_ErrorPrintf("Failed to delete save state file '%s'", si.path.c_str()); } } std::string HostInterface::GetMostRecentResumeSaveStatePath() const { std::vector files; if (!FileSystem::FindFiles(GetUserDirectoryRelativePath("savestates").c_str(), "*resume.sav", FILESYSTEM_FIND_FILES, &files) || files.empty()) { return {}; } FILESYSTEM_FIND_DATA* most_recent = &files[0]; for (FILESYSTEM_FIND_DATA& file : files) { if (file.ModificationTime > most_recent->ModificationTime) most_recent = &file; } return std::move(most_recent->FileName); } void HostInterface::CheckSettings(SettingsInterface& si) { const int settings_version = si.GetIntValue("Main", "SettingsVersion", -1); if (settings_version == SETTINGS_VERSION) return; ReportFormattedError("Settings version %d does not match expected version %d, resetting", settings_version, SETTINGS_VERSION); si.Clear(); si.SetIntValue("Main", "SettingsVersion", SETTINGS_VERSION); SetDefaultSettings(si); } void HostInterface::SetDefaultSettings(SettingsInterface& si) { si.SetStringValue("Console", "Region", Settings::GetConsoleRegionName(ConsoleRegion::Auto)); si.SetFloatValue("Main", "EmulationSpeed", 1.0f); si.SetBoolValue("Main", "SpeedLimiterEnabled", true); si.SetBoolValue("Main", "IncreaseTimerResolution", true); si.SetBoolValue("Main", "StartPaused", false); si.SetBoolValue("Main", "SaveStateOnExit", true); si.SetBoolValue("Main", "ConfirmPowerOff", true); si.SetStringValue("CPU", "ExecutionMode", Settings::GetCPUExecutionModeName(CPUExecutionMode::Interpreter)); si.SetStringValue("GPU", "Renderer", Settings::GetRendererName(Settings::DEFAULT_GPU_RENDERER)); si.SetIntValue("GPU", "ResolutionScale", 1); si.SetBoolValue("GPU", "UseDebugDevice", false); si.SetBoolValue("GPU", "TrueColor", false); si.SetBoolValue("GPU", "ScaledDithering", true); si.SetBoolValue("GPU", "TextureFiltering", false); si.SetBoolValue("GPU", "DisableInterlacing", true); si.SetBoolValue("GPU", "ForceNTSCTimings", false); si.SetStringValue("Display", "CropMode", "Overscan"); si.SetStringValue("Display", "PixelAspectRatio", "4:3"); si.SetBoolValue("Display", "LinearFiltering", true); si.SetBoolValue("Display", "IntegerScaling", false); si.SetBoolValue("Display", "ShowOSDMessages", true); si.SetBoolValue("Display", "ShowFPS", false); si.SetBoolValue("Display", "ShowVPS", false); si.SetBoolValue("Display", "ShowSpeed", false); si.SetBoolValue("Display", "Fullscreen", false); si.SetBoolValue("Display", "VSync", true); si.SetBoolValue("CDROM", "ReadThread", true); si.SetBoolValue("CDROM", "RegionCheck", true); si.SetStringValue("Audio", "Backend", Settings::GetAudioBackendName(AudioBackend::Cubeb)); si.SetIntValue("Audio", "OutputVolume", 100); si.SetIntValue("Audio", "BufferSize", DEFAULT_AUDIO_BUFFER_SIZE); si.SetIntValue("Audio", "BufferCount", DEFAULT_AUDIO_BUFFER_COUNT); si.SetIntValue("Audio", "OutputMuted", false); si.SetBoolValue("Audio", "Sync", true); si.SetBoolValue("Audio", "DumpOnBoot", false); si.SetStringValue("BIOS", "Path", "bios/scph1001.bin"); si.SetBoolValue("BIOS", "PatchTTYEnable", false); si.SetBoolValue("BIOS", "PatchFastBoot", false); si.SetStringValue("Controller1", "Type", Settings::GetControllerTypeName(ControllerType::DigitalController)); si.SetStringValue("Controller2", "Type", Settings::GetControllerTypeName(ControllerType::None)); si.SetStringValue("MemoryCards", "Card1Type", Settings::GetMemoryCardTypeName(MemoryCardType::PerGameTitle)); si.SetStringValue("MemoryCards", "Card1Path", "memcards/shared_card_1.mcd"); si.SetStringValue("MemoryCards", "Card2Type", "None"); si.SetStringValue("MemoryCards", "Card2Path", "memcards/shared_card_2.mcd"); si.SetStringValue("Logging", "LogLevel", Settings::GetLogLevelName(LOGLEVEL_INFO)); si.SetStringValue("Logging", "LogFilter", ""); si.SetBoolValue("Logging", "LogToConsole", false); si.SetBoolValue("Logging", "LogToDebug", false); si.SetBoolValue("Logging", "LogToWindow", false); si.SetBoolValue("Logging", "LogToFile", false); si.SetBoolValue("Debug", "ShowVRAM", false); si.SetBoolValue("Debug", "DumpCPUToVRAMCopies", false); si.SetBoolValue("Debug", "DumpVRAMToCPUCopies", false); si.SetBoolValue("Debug", "ShowGPUState", false); si.SetBoolValue("Debug", "ShowCDROMState", false); si.SetBoolValue("Debug", "ShowSPUState", false); si.SetBoolValue("Debug", "ShowTimersState", false); si.SetBoolValue("Debug", "ShowMDECState", false); } void HostInterface::ApplySettings(SettingsInterface& si) { m_settings.Load(si); } void HostInterface::ExportSettings(SettingsInterface& si) { m_settings.Save(si); } void HostInterface::UpdateSettings(SettingsInterface& si) { Settings old_settings(std::move(m_settings)); ApplySettings(si); if (m_system) { if (m_settings.gpu_renderer != old_settings.gpu_renderer || m_settings.gpu_use_debug_device != old_settings.gpu_use_debug_device) { ReportFormattedMessage("Switching to %s%s GPU renderer.", Settings::GetRendererName(m_settings.gpu_renderer), m_settings.gpu_use_debug_device ? " (debug)" : ""); RecreateSystem(); } if (m_settings.audio_backend != old_settings.audio_backend || m_settings.audio_buffer_size != old_settings.audio_buffer_size || m_settings.audio_buffer_count != old_settings.audio_buffer_count) { if (m_settings.audio_backend != old_settings.audio_backend) ReportFormattedMessage("Switching to %s audio backend.", Settings::GetAudioBackendName(m_settings.audio_backend)); DebugAssert(m_audio_stream); m_audio_stream.reset(); CreateAudioStream(); m_audio_stream->PauseOutput(m_paused); UpdateSpeedLimiterState(); } if (m_settings.video_sync_enabled != old_settings.video_sync_enabled || m_settings.audio_sync_enabled != old_settings.audio_sync_enabled || m_settings.speed_limiter_enabled != old_settings.speed_limiter_enabled || m_settings.increase_timer_resolution != old_settings.increase_timer_resolution) { UpdateSpeedLimiterState(); } if (m_settings.emulation_speed != old_settings.emulation_speed) { m_system->UpdateThrottlePeriod(); UpdateSpeedLimiterState(); } if (m_settings.cpu_execution_mode != old_settings.cpu_execution_mode) { ReportFormattedMessage("Switching to %s CPU execution mode.", Settings::GetCPUExecutionModeName(m_settings.cpu_execution_mode)); m_system->SetCPUExecutionMode(m_settings.cpu_execution_mode); } m_audio_stream->SetOutputVolume(m_settings.audio_output_muted ? 0 : m_settings.audio_output_volume); if (m_settings.gpu_resolution_scale != old_settings.gpu_resolution_scale || m_settings.gpu_fifo_size != old_settings.gpu_fifo_size || m_settings.gpu_max_run_ahead != old_settings.gpu_max_run_ahead || m_settings.gpu_true_color != old_settings.gpu_true_color || m_settings.gpu_scaled_dithering != old_settings.gpu_scaled_dithering || m_settings.gpu_texture_filtering != old_settings.gpu_texture_filtering || m_settings.gpu_disable_interlacing != old_settings.gpu_disable_interlacing || m_settings.gpu_force_ntsc_timings != old_settings.gpu_force_ntsc_timings || m_settings.display_crop_mode != old_settings.display_crop_mode || m_settings.display_aspect_ratio != old_settings.display_aspect_ratio) { m_system->UpdateGPUSettings(); } if (m_settings.cdrom_read_thread != old_settings.cdrom_read_thread) m_system->GetCDROM()->SetUseReadThread(m_settings.cdrom_read_thread); if (m_settings.memory_card_types != old_settings.memory_card_types || m_settings.memory_card_paths != old_settings.memory_card_paths) { m_system->UpdateMemoryCards(); } m_system->GetDMA()->SetMaxSliceTicks(m_settings.dma_max_slice_ticks); m_system->GetDMA()->SetHaltTicks(m_settings.dma_halt_ticks); } bool controllers_updated = false; for (u32 i = 0; i < NUM_CONTROLLER_AND_CARD_PORTS; i++) { if (m_settings.controller_types[i] != old_settings.controller_types[i]) { if (m_system && !controllers_updated) { m_system->UpdateControllers(); controllers_updated = true; } OnControllerTypeChanged(i); } } if (m_display && m_settings.display_linear_filtering != old_settings.display_linear_filtering) m_display->SetDisplayLinearFiltering(m_settings.display_linear_filtering); if (m_display && m_settings.display_integer_scaling != old_settings.display_integer_scaling) m_display->SetDisplayIntegerScaling(m_settings.display_integer_scaling); if (m_settings.log_level != old_settings.log_level || m_settings.log_filter != old_settings.log_filter || m_settings.log_to_console != old_settings.log_to_console || m_settings.log_to_window != old_settings.log_to_window || m_settings.log_to_file != old_settings.log_to_file) { UpdateLogSettings(m_settings.log_level, m_settings.log_filter.empty() ? nullptr : m_settings.log_filter.c_str(), m_settings.log_to_console, m_settings.log_to_debug, m_settings.log_to_window, m_settings.log_to_file); } } void HostInterface::ToggleSoftwareRendering() { if (!m_system || m_settings.gpu_renderer == GPURenderer::Software) return; const GPURenderer new_renderer = m_system->GetGPU()->IsHardwareRenderer() ? GPURenderer::Software : m_settings.gpu_renderer; AddFormattedOSDMessage(2.0f, "Switching to %s renderer...", Settings::GetRendererDisplayName(new_renderer)); m_system->RecreateGPU(new_renderer); } void HostInterface::ModifyResolutionScale(s32 increment) { const u32 new_resolution_scale = std::clamp( static_cast(static_cast(m_settings.gpu_resolution_scale) + increment), 1, GPU::MAX_RESOLUTION_SCALE); if (new_resolution_scale == m_settings.gpu_resolution_scale) return; m_settings.gpu_resolution_scale = new_resolution_scale; AddFormattedOSDMessage(2.0f, "Resolution scale set to %ux (%ux%u)", m_settings.gpu_resolution_scale, GPU::VRAM_WIDTH * m_settings.gpu_resolution_scale, GPU::VRAM_HEIGHT * m_settings.gpu_resolution_scale); if (m_system) m_system->GetGPU()->UpdateSettings(); } void HostInterface::RecreateSystem() { const bool was_paused = m_paused; std::unique_ptr stream = ByteStream_CreateGrowableMemoryStream(nullptr, 8 * 1024); if (!m_system->SaveState(stream.get()) || !stream->SeekAbsolute(0)) { ReportError("Failed to save state before system recreation. Shutting down."); DestroySystem(); return; } DestroySystem(); SystemBootParameters boot_params; if (!BootSystem(boot_params)) { ReportError("Failed to boot system after recreation."); return; } if (!m_system->LoadState(stream.get())) { ReportError("Failed to load state after system recreation. Shutting down."); DestroySystem(); return; } m_system->ResetPerformanceCounters(); PauseSystem(was_paused); } void HostInterface::SetTimerResolutionIncreased(bool enabled) { if (m_timer_resolution_increased == enabled) return; m_timer_resolution_increased = enabled; #ifdef WIN32 if (enabled) timeBeginPeriod(1); else timeEndPeriod(1); #endif } void HostInterface::DisplayLoadingScreen(const char* message, int progress_min /*= -1*/, int progress_max /*= -1*/, int progress_value /*= -1*/) { const auto& io = ImGui::GetIO(); const float scale = io.DisplayFramebufferScale.x; const float width = (400.0f * scale); const bool has_progress = (progress_min < progress_max); // eat the last imgui frame, it might've been partially rendered by the caller. ImGui::EndFrame(); ImGui::NewFrame(); ImGui::SetNextWindowSize(ImVec2(width, (has_progress ? 50.0f : 30.0f) * scale), ImGuiCond_Always); ImGui::SetNextWindowPos(ImVec2(io.DisplaySize.x * 0.5f, io.DisplaySize.y * 0.5f), ImGuiCond_Always, ImVec2(0.5f, 0.5f)); if (ImGui::Begin("LoadingScreen", nullptr, ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoInputs | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_NoScrollbar | ImGuiWindowFlags_NoNav | ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoFocusOnAppearing)) { if (has_progress) { ImGui::Text("%s: %d/%d", message, progress_value, progress_max); ImGui::ProgressBar(static_cast(progress_value) / static_cast(progress_max - progress_min), ImVec2(-1.0f, 0.0f), ""); Log_InfoPrintf("%s: %d/%d", message, progress_value, progress_max); } else { const ImVec2 text_size(ImGui::CalcTextSize(message)); ImGui::SetCursorPosX((width - text_size.x) / 2.0f); ImGui::TextUnformatted(message); Log_InfoPrintf("%s", message); } } ImGui::End(); m_display->Render(); } bool HostInterface::SaveResumeSaveState() { if (!m_system) return false; const bool global = m_system->GetRunningCode().empty(); return SaveState(global, -1); } bool HostInterface::IsDumpingAudio() const { return m_system ? m_system->GetSPU()->IsDumpingAudio() : false; } bool HostInterface::StartDumpingAudio(const char* filename) { if (!m_system) return false; std::string auto_filename; if (!filename) { const auto& code = m_system->GetRunningCode(); if (code.empty()) { auto_filename = GetUserDirectoryRelativePath("dump/audio/%s.wav", GetTimestampStringForFileName().GetCharArray()); } else { auto_filename = GetUserDirectoryRelativePath("dump/audio/%s_%s.wav", code.c_str(), GetTimestampStringForFileName().GetCharArray()); } filename = auto_filename.c_str(); } if (m_system->GetSPU()->StartDumpingAudio(filename)) { AddFormattedOSDMessage(5.0f, "Started dumping audio to '%s'.", filename); return true; } else { AddFormattedOSDMessage(10.0f, "Failed to start dumping audio to '%s'.", filename); return false; } } void HostInterface::StopDumpingAudio() { if (!m_system || !m_system->GetSPU()->StopDumpingAudio()) return; AddOSDMessage("Stopped dumping audio.", 5.0f); } bool HostInterface::SaveScreenshot(const char* filename /* = nullptr */, bool full_resolution /* = true */, bool apply_aspect_ratio /* = true */) { if (!m_system) return false; std::string auto_filename; if (!filename) { const auto& code = m_system->GetRunningCode(); const char* extension = "png"; if (code.empty()) { auto_filename = GetUserDirectoryRelativePath("screenshots/%s.%s", GetTimestampStringForFileName().GetCharArray(), extension); } else { auto_filename = GetUserDirectoryRelativePath("screenshots/%s_%s.%s", code.c_str(), GetTimestampStringForFileName().GetCharArray(), extension); } filename = auto_filename.c_str(); } if (!m_display->WriteDisplayTextureToFile(filename, full_resolution, apply_aspect_ratio)) { AddFormattedOSDMessage(10.0f, "Failed to save screenshot to '%s'", filename); return false; } AddFormattedOSDMessage(5.0f, "Screenshot saved to '%s'.", filename); return true; }