diff --git a/.gitattributes b/.gitattributes index a2aebd1..700d31a 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,4 +1,5 @@ * text=auto eol=lf *.bat text eol=crlf +*.cmd text eol=crlf *.jar binary *.png binary diff --git a/.gitignore b/.gitignore index 8560093..2eef23c 100644 --- a/.gitignore +++ b/.gitignore @@ -12,7 +12,14 @@ third_party/sources/ *.iml *.keystore *.jks +*.p12 +*.pfx +*.dpapi +keystore.properties +signing.properties *.apk *.aab captures/ +# Local game samples are not included in application/source releases. +*.nes OpenJDK17U-jdk_x64_windows_hotspot_17.0.17_10.zip diff --git a/README.md b/README.md index e90a632..87492f2 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,17 @@ # NESLite -NESLite 是一个面向 Android 的轻量 NES/FC 模拟器前端。它使用固定版本的 -FCEUmm libretro 内核。当前仓库已准备 0.9.15 候选基线的冻结样本、输入延迟指标、升级架构、原生对齐审计 -和候选交付脚本;荣耀 Magic8 与 X5 Lite 已由截图确认枚举,但手机未开放 ADB,且发布签名和可观察 -玩法的合法 ROM 样本尚未提供,因此 M2~M8 的完整实机验收及 G8 仍待补齐。 +NESLite 是一个面向 Android 的轻量 NES/FC 模拟器前端。当前版本为 1.0.0,内置固定提交的 +FCEUmm 和 Nestopia,可设置默认内核,也可长按游戏单独选择,下次打开游戏时生效。两个内核的存档 +独立保留。0.9.17 对已确认哈希的“龙珠英雄”自动使用 Dendy 制式,两个内核的桌面启动与菜单检查 +通过,详见 [兼容修复记录](docs/reports/long-zhu-ying-xiong-0.9.17.md)。 +0.9.18 修正 Nestopia 在原始整数缩放下被横向拉宽的问题,局部尺寸验证通过, +见 [显示修复记录](docs/reports/integer-scaling-0.9.18.md)。 -主界面固定为横屏游戏布局:中央是 4:3 游戏画面,左右为虚拟按键,左上角提供游戏列表、导入和 +源码仓库:[shen/NESLite](http://git.m3frame.com/shen/NESLite)。安装包、源码与校验值见 +[发行版](http://git.m3frame.com/shen/NESLite/releases),首次发布说明见 [1.0.0](docs/releases/1.0.0.md)。 +用户已确认产品可发布;历史测试报告中未归档的专项证据仍保留原状态,不据此宣称所有计划测试均已执行。 + +主界面固定为横屏游戏布局:中央是 4:3 游戏容器,可切换原始像素整数缩放,左右为虚拟按键,左上角提供游戏列表、导入和 设置入口;管理功能均在独立页面中完成,不再与游戏画面纵向堆叠。 ## 快速构建 @@ -13,13 +19,17 @@ FCEUmm libretro 内核。当前仓库已准备 0.9.15 候选基线的冻结样 请先阅读 [构建说明](docs/build.md),再执行: ```powershell -pwsh -NoProfile -File .\tools\check.ps1 -Scope Build +.\打包.cmd -NoPause ``` -该命令默认只生成 arm64-v8a 调试 APK,不会运行耐久或实机验收。 +也可直接双击根目录的 `打包.cmd`。默认生成可安装的 arm64-v8a 调试 APK,交付文件统一在 +`build/releases/`;中间文件、项目缓存和日志也统一在 `build/`,不自动运行测试。 +维护者配置项目外的正式签名密钥后,使用 `.\打包.cmd release -NoPause` 生成签名 APK、原生符号、 +应用和内核源码包及校验清单。详见 [发布说明](docs/publishing.md)。 日常操作见 [使用说明](docs/usage.md),存档兼容与安全边界见 [存档格式](docs/save-format.md)。 -候选版证据、静态审计和阻断项见 [M8 候选报告](docs/reports/m8-release-candidate.md)。 +双内核接入与分级验证见 [0.9.16 报告](docs/reports/core-selection-0.9.16.md);历史候选版证据见 +[M8 候选报告](docs/reports/m8-release-candidate.md)。 连接并授权目标手机后,可用 `tools/check-m1-device.ps1` 安装和启动当前调试 APK;实测步骤见 [X5 Lite 键位表](docs/controller-x5lite.md)。 diff --git a/THIRD_PARTY_NOTICES.md b/THIRD_PARTY_NOTICES.md index 256370a..7339e88 100644 --- a/THIRD_PARTY_NOTICES.md +++ b/THIRD_PARTY_NOTICES.md @@ -12,6 +12,8 @@ | Room | `androidx.room:room-runtime/room-ktx:2.7.2` | Apache-2.0 | 分发时保留许可和 NOTICE(如上游提供)。 | | DataStore Preferences | `androidx.datastore:datastore-preferences:1.1.7` | Apache-2.0 | 分发时保留许可和 NOTICE(如上游提供)。 | | FCEUmm | `236ccdfc911e84c60fea6b9d0699c2d440a8de14` | GPL-2.0-only | 对应完整源码、GPL v2 文本、原始版权/Authors、所有补丁和获取说明。 | +| Nestopia libretro | `224713b257c8620513c1c9ca28dc7f8dea711e18` | GPL-2.0-or-later | 对应完整源码、COPYING、Martin Freij 等上游版权声明及本仓库 CMake 构建适配;无上游源码补丁。 | +| nes_ntsc(随 Nestopia) | 上述提交的 `source/nes_ntsc/` | LGPL-2.1-or-later | 保留 Shay Green 版权、许可文本及对应源码,随 Nestopia 源码归档交付。 | | libretro.h | `0c9622896333ee62dc4326bbe8784a210ddeb03c` | MIT | 原始版权和 MIT 许可文本。 | | Oboe | 1.10.0 / `a81bb9f87d4105b84b682685d3bfbb5beca371d1` | Apache-2.0 | Apache 2.0 文本及上游 NOTICE(如有)。 | diff --git a/app/build.gradle.kts b/app/build.gradle.kts index cf67f52..f458fc3 100644 --- a/app/build.gradle.kts +++ b/app/build.gradle.kts @@ -21,8 +21,8 @@ android { applicationId = "org.neslite.app" minSdk = 28 targetSdk = 36 - versionCode = 9015 - versionName = "0.9.15" + versionCode = 1000000 + versionName = "1.0.0" testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner" ndk { @@ -63,6 +63,7 @@ android { cmake { path = file("src/main/cpp/CMakeLists.txt") version = "3.22.1" + buildStagingDirectory = rootProject.layout.projectDirectory.dir("build/native/app").asFile } } diff --git a/app/src/main/cpp/CMakeLists.txt b/app/src/main/cpp/CMakeLists.txt index 0192b81..22ea90b 100644 --- a/app/src/main/cpp/CMakeLists.txt +++ b/app/src/main/cpp/CMakeLists.txt @@ -6,6 +6,9 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON) set(CMAKE_CXX_EXTENSIONS OFF) set(NESLITE_COMMON_SOURCES + rom_compatibility.cpp + core_catalog.cpp + video_conversion.cpp native_smoke.cpp session_rules.cpp audio_ring_buffer.cpp @@ -13,6 +16,7 @@ set(NESLITE_COMMON_SOURCES input_latency_metrics.cpp timing_metrics.cpp video_buffer.cpp + video_viewport.cpp sha256.cpp safe_commit.cpp save_state.cpp @@ -30,8 +34,10 @@ endfunction() if(ANDROID) include(cmake/fceumm.cmake) + include(cmake/nestopia.cmake) include(cmake/oboe.cmake) add_library(neslite_jni SHARED + core_api.cpp core_identity.cpp core_session.cpp audio_engine.cpp @@ -45,7 +51,8 @@ if(ANDROID) find_library(log-lib log) find_library(gles-lib GLESv2) - target_link_libraries(neslite_jni PRIVATE fceumm_core oboe ${log-lib} ${gles-lib}) + target_link_libraries(neslite_jni PRIVATE fceumm_core oboe ${log-lib} ${gles-lib} dl) + add_dependencies(neslite_jni neslite_nestopia) else() enable_testing() add_executable(neslite_native_smoke_test @@ -55,4 +62,17 @@ else() target_include_directories(neslite_native_smoke_test PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}) neslite_enable_strict_warnings(neslite_native_smoke_test) add_test(NAME neslite_native_smoke_test COMMAND neslite_native_smoke_test) + add_executable(neslite_core_selection_test tests/core_selection_test.cpp + core_catalog.cpp video_conversion.cpp video_buffer.cpp save_package.cpp save_state.cpp sha256.cpp) + target_include_directories(neslite_core_selection_test PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}) + neslite_enable_strict_warnings(neslite_core_selection_test) + add_test(NAME neslite_core_selection_test COMMAND neslite_core_selection_test) + add_executable(neslite_rom_compatibility_test tests/rom_compatibility_test.cpp rom_compatibility.cpp) + target_include_directories(neslite_rom_compatibility_test PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}) + neslite_enable_strict_warnings(neslite_rom_compatibility_test) + add_test(NAME neslite_rom_compatibility_test COMMAND neslite_rom_compatibility_test) + add_executable(neslite_video_viewport_test tests/video_viewport_test.cpp video_buffer.cpp video_viewport.cpp) + target_include_directories(neslite_video_viewport_test PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}) + neslite_enable_strict_warnings(neslite_video_viewport_test) + add_test(NAME neslite_video_viewport_test COMMAND neslite_video_viewport_test) endif() diff --git a/app/src/main/cpp/cmake/nestopia.cmake b/app/src/main/cpp/cmake/nestopia.cmake new file mode 100644 index 0000000..f543ede --- /dev/null +++ b/app/src/main/cpp/cmake/nestopia.cmake @@ -0,0 +1,29 @@ +set(NESLITE_NESTOPIA_DIR + "${CMAKE_CURRENT_LIST_DIR}/../../../../../third_party/sources/nestopia" + CACHE PATH "Path to the pinned Nestopia libretro checkout") +if(NOT EXISTS "${NESLITE_NESTOPIA_DIR}/libretro/Makefile.common") + message(FATAL_ERROR "Nestopia source missing. Run tools/fetch-third-party.ps1.") +endif() + +# Use the source list of the pinned upstream build, rather than guessing board files. +file(STRINGS "${NESLITE_NESTOPIA_DIR}/libretro/Makefile.common" NESTOPIA_SOURCE_LINES + REGEX "^SOURCES_C(XX)? \\+=") +set(NESTOPIA_SOURCES) +foreach(line IN LISTS NESTOPIA_SOURCE_LINES) + string(REGEX REPLACE "^SOURCES_C(XX)? \\+= *" "" source "${line}") + string(REPLACE "$(LIBRETRO_COMM_DIR)" "${NESLITE_NESTOPIA_DIR}/libretro/libretro-common" source "${source}") + string(REPLACE "$(CORE_DIR)" "${NESLITE_NESTOPIA_DIR}" source "${source}") + list(APPEND NESTOPIA_SOURCES "${source}") +endforeach() +add_library(neslite_nestopia SHARED ${NESTOPIA_SOURCES}) +set_target_properties(neslite_nestopia PROPERTIES CXX_STANDARD 98 C_STANDARD 99) +target_include_directories(neslite_nestopia PRIVATE + "${NESLITE_NESTOPIA_DIR}" "${NESLITE_NESTOPIA_DIR}/source" + "${NESLITE_NESTOPIA_DIR}/libretro" + "${NESLITE_NESTOPIA_DIR}/libretro/libretro-common/include") +target_compile_definitions(neslite_nestopia PRIVATE __LIBRETRO__ NST_NO_ZLIB GIT_VERSION="224713b") +target_compile_options(neslite_nestopia PRIVATE -Wno-error "$<$:-fno-rtti>") +# Keep each core's libretro-common globals and callbacks bound to its own library. +target_link_options(neslite_nestopia PRIVATE + "-Wl,--version-script=${NESLITE_NESTOPIA_DIR}/libretro/link.T" "-Wl,-Bsymbolic") +target_link_libraries(neslite_nestopia PRIVATE m) diff --git a/app/src/main/cpp/core_api.cpp b/app/src/main/cpp/core_api.cpp new file mode 100644 index 0000000..24e290d --- /dev/null +++ b/app/src/main/cpp/core_api.cpp @@ -0,0 +1,36 @@ +#include "core_api.h" +#include + +namespace neslite { +bool select_core_api(CoreKind kind, CoreApi* api, std::string* error) { + if (api == nullptr || error == nullptr) return false; + CoreApi next; + if (kind == CoreKind::Fceumm) { +#define NESLITE_LINKED_API(name) next.name = &::name; + NESLITE_CORE_API(NESLITE_LINKED_API) +#undef NESLITE_LINKED_API + } else { + // The only dynamic library allowed is packaged with the APK. Retain its handle + // for process lifetime; game and core resources still follow unload/deinit. + static void* library = nullptr; + if (library == nullptr) library = dlopen("libneslite_nestopia.so", RTLD_NOW | RTLD_LOCAL); + if (library == nullptr) { + const char* detail = dlerror(); + *error = std::string("Cannot open bundled Nestopia: ") + (detail ? detail : "unknown error"); + return false; + } +#define NESLITE_DYNAMIC_API(name) \ + next.name = reinterpret_cast(dlsym(library, #name)); \ + if (next.name == nullptr) { *error = "Bundled Nestopia is missing " #name; return false; } + NESLITE_CORE_API(NESLITE_DYNAMIC_API) +#undef NESLITE_DYNAMIC_API + } + if (next.retro_api_version() != RETRO_API_VERSION) { + *error = "Incompatible libretro API"; + return false; + } + *api = next; + error->clear(); + return true; +} +} // namespace neslite diff --git a/app/src/main/cpp/core_api.h b/app/src/main/cpp/core_api.h new file mode 100644 index 0000000..6bf10b1 --- /dev/null +++ b/app/src/main/cpp/core_api.h @@ -0,0 +1,25 @@ +#pragma once + +#include +#include +#include "core_catalog.h" + +#define NESLITE_CORE_API(X) \ + X(retro_api_version) X(retro_init) X(retro_deinit) \ + X(retro_set_environment) X(retro_set_video_refresh) \ + X(retro_set_audio_sample) X(retro_set_audio_sample_batch) \ + X(retro_set_input_poll) X(retro_set_input_state) \ + X(retro_set_controller_port_device) X(retro_get_system_info) \ + X(retro_get_system_av_info) X(retro_load_game) X(retro_unload_game) \ + X(retro_run) X(retro_reset) X(retro_get_memory_data) X(retro_get_memory_size) \ + X(retro_serialize_size) X(retro_serialize) X(retro_unserialize) + +namespace neslite { +struct CoreApi { +#define NESLITE_API_MEMBER(name) decltype(&::name) name = nullptr; + NESLITE_CORE_API(NESLITE_API_MEMBER) +#undef NESLITE_API_MEMBER +}; +// Call only on the simulation thread, after unloading/deinitializing the previous core. +bool select_core_api(CoreKind kind, CoreApi* api, std::string* error); +} // namespace neslite diff --git a/app/src/main/cpp/core_catalog.cpp b/app/src/main/cpp/core_catalog.cpp new file mode 100644 index 0000000..9c4f3ab --- /dev/null +++ b/app/src/main/cpp/core_catalog.cpp @@ -0,0 +1,30 @@ +#include "core_catalog.h" + +namespace neslite { +const CoreDescriptor& core_descriptor(CoreKind kind) { + static constexpr CoreDescriptor fceumm{CoreKind::Fceumm, "fceumm", "FCEUmm", + "236ccdfc911e84c60fea6b9d0699c2d440a8de14"}; + static constexpr CoreDescriptor nestopia{CoreKind::Nestopia, "nestopia", "Nestopia", + "224713b257c8620513c1c9ca28dc7f8dea711e18"}; + return kind == CoreKind::Nestopia ? nestopia : fceumm; +} +bool parse_core_kind(std::string_view id, CoreKind* kind) { + if (kind == nullptr) return false; + if (id == "fceumm") *kind = CoreKind::Fceumm; + else if (id == "nestopia") *kind = CoreKind::Nestopia; + else return false; + return true; +} +std::filesystem::path core_save_base(const std::filesystem::path& saves, CoreKind kind) { + // Keep every existing FCEUmm file in its original location. + return kind == CoreKind::Fceumm ? saves : saves / "cores" / "nestopia"; +} +std::string core_package_identity(CoreKind kind) { + const auto& descriptor = core_descriptor(kind); + return std::string(descriptor.id) + "\n" + std::string(descriptor.commit) + "\n"; +} +bool core_package_compatible(std::string_view identity, CoreKind kind) { + // Packages created before core selection belong exclusively to FCEUmm. + return identity.empty() ? kind == CoreKind::Fceumm : identity == core_package_identity(kind); +} +} // namespace neslite diff --git a/app/src/main/cpp/core_catalog.h b/app/src/main/cpp/core_catalog.h new file mode 100644 index 0000000..5921f72 --- /dev/null +++ b/app/src/main/cpp/core_catalog.h @@ -0,0 +1,20 @@ +#pragma once + +#include +#include +#include + +namespace neslite { +enum class CoreKind { Fceumm, Nestopia }; +struct CoreDescriptor { + CoreKind kind; + std::string_view id; + std::string_view name; + std::string_view commit; +}; +const CoreDescriptor& core_descriptor(CoreKind kind); +bool parse_core_kind(std::string_view id, CoreKind* kind); +std::filesystem::path core_save_base(const std::filesystem::path& saves, CoreKind kind); +std::string core_package_identity(CoreKind kind); +bool core_package_compatible(std::string_view identity, CoreKind kind); +} // namespace neslite diff --git a/app/src/main/cpp/core_identity.cpp b/app/src/main/cpp/core_identity.cpp index 43f8f18..13fa90b 100644 --- a/app/src/main/cpp/core_identity.cpp +++ b/app/src/main/cpp/core_identity.cpp @@ -1,15 +1,14 @@ #include "core_identity.h" -#include +#include "core_catalog.h" namespace neslite { std::string core_identity() { - retro_system_info info{}; - retro_get_system_info(&info); - const std::string name = info.library_name != nullptr ? info.library_name : "unknown"; - const std::string version = info.library_version != nullptr ? info.library_version : "unknown"; - return name + " " + version + " / libretro API " + std::to_string(retro_api_version()); + const auto& fceumm = core_descriptor(CoreKind::Fceumm); + const auto& nestopia = core_descriptor(CoreKind::Nestopia); + return "FCEUmm " + std::string(fceumm.commit.substr(0, 7)) + " / Nestopia " + + std::string(nestopia.commit.substr(0, 7)) + " / libretro API 1"; } } // namespace neslite diff --git a/app/src/main/cpp/core_session.cpp b/app/src/main/cpp/core_session.cpp index fe90b42..e5d193f 100644 --- a/app/src/main/cpp/core_session.cpp +++ b/app/src/main/cpp/core_session.cpp @@ -1,4 +1,7 @@ #include "core_session.h" +#include "core_api.h" +#include "video_conversion.h" +#include "rom_compatibility.h" #include @@ -39,8 +42,6 @@ namespace { constexpr std::size_t kMaxCommands = 32; constexpr std::size_t kMaxRomBytes = 64U * 1024U * 1024U; constexpr std::size_t kAudioCapacityFrames = 4096; -constexpr std::string_view kCoreName = "FCEUmm"; -constexpr std::string_view kCoreCommit = "236ccdfc911e84c60fea6b9d0699c2d440a8de14"; constexpr double kBatteryIntervalSeconds = 10.0; constexpr double kAutoIntervalSeconds = 60.0; @@ -92,9 +93,14 @@ struct Command { std::string system_dir; std::string save_dir; std::string rom_hash; + std::string core_id = "fceumm"; }; struct Host { + CoreApi core; + std::atomic core_kind{CoreKind::Fceumm}; + std::atomic compatibility{RomCompatibility::Default}; + std::vector converted_pixels; std::mutex mutex; std::condition_variable wake; std::deque commands; @@ -140,7 +146,7 @@ struct Host { std::atomic abnormal_session{false}; std::string recovery_signature; - Host() : worker([this] { run(); }) {} + Host() { worker = std::thread([this] { run(); }); } ~Host() { { std::lock_guard lock(mutex); @@ -207,16 +213,16 @@ struct Host { } std::vector battery_snapshot() const { - void* memory = retro_get_memory_data(RETRO_MEMORY_SAVE_RAM); - const std::size_t size = retro_get_memory_size(RETRO_MEMORY_SAVE_RAM); + void* memory = core.retro_get_memory_data(RETRO_MEMORY_SAVE_RAM); + const std::size_t size = core.retro_get_memory_size(RETRO_MEMORY_SAVE_RAM); if (memory == nullptr || size == 0 || rom_hash.empty()) return {}; const auto* begin = static_cast(memory); return {begin, begin + size}; } void load_battery() { - void* memory = retro_get_memory_data(RETRO_MEMORY_SAVE_RAM); - const std::size_t size = retro_get_memory_size(RETRO_MEMORY_SAVE_RAM); + void* memory = core.retro_get_memory_data(RETRO_MEMORY_SAVE_RAM); + const std::size_t size = core.retro_get_memory_size(RETRO_MEMORY_SAVE_RAM); if (memory == nullptr || size == 0 || rom_hash.empty()) return; const auto path = std::filesystem::path(save_dir) / rom_hash / "battery" / "battery.sav"; std::vector bytes; @@ -243,8 +249,8 @@ struct Host { SaveStateMetadata state_metadata(const VideoFrame& frame) const { return SaveStateMetadata{ .rom_hash = rom_hash, - .core_name = std::string(kCoreName), - .core_commit = std::string(kCoreCommit), + .core_name = std::string(core_descriptor(core_kind.load()).name), + .core_commit = std::string(core_descriptor(core_kind.load()).commit), .configuration = configuration_identity(), .created_epoch_ms = wall_now_ms(), .thumbnail_width = frame.width, @@ -255,10 +261,10 @@ struct Host { } std::vector serialized_state() const { - const std::size_t size = retro_serialize_size(); + const std::size_t size = core.retro_serialize_size(); if (size == 0 || size > kMaxStateBytes) return {}; std::vector bytes(size); - if (!retro_serialize(bytes.data(), bytes.size())) return {}; + if (!core.retro_serialize(bytes.data(), bytes.size())) return {}; return bytes; } @@ -314,8 +320,8 @@ struct Host { return false; } return decode_save_state(bytes, decoded, reason) && - save_state_compatible(decoded->metadata, rom_hash, std::string(kCoreName), - std::string(kCoreCommit), configuration_identity(), reason); + save_state_compatible(decoded->metadata, rom_hash, std::string(core_descriptor(core_kind.load()).name), + std::string(core_descriptor(core_kind.load()).commit), configuration_identity(), reason); } unsigned count_recovery_candidates() { @@ -365,7 +371,8 @@ struct Host { } const auto before_state = serialized_state(); const auto before_battery = battery_snapshot(); - if (before_state.empty() || before_battery.empty()) { + const std::size_t expected_battery = core.retro_get_memory_size(RETRO_MEMORY_SAVE_RAM); + if (before_state.empty() || before_battery.size() != expected_battery) { error = "Cannot protect current progress"; return false; } @@ -373,7 +380,8 @@ struct Host { auto backup_envelope = encode_save_state(state_metadata(empty_frame), before_state, {}); const auto root = std::filesystem::path(save_dir) / rom_hash / "recovery"; if (commit_bytes(root / "before-load.nls", std::move(backup_envelope)) != CommitResult::Committed || - commit_bytes(root / "before-load.sav", before_battery) != CommitResult::Committed) { + (!before_battery.empty() && + commit_bytes(root / "before-load.sav", before_battery) != CommitResult::Committed)) { error = "Cannot commit pre-load backup"; return false; } @@ -381,28 +389,30 @@ struct Host { audio_buffer.clear(); resampler.reset(); video.clear(); - if (!retro_unserialize(decoded.state.data(), decoded.state.size())) { - if (!retro_unserialize(before_state.data(), before_state.size())) { - retro_unload_game(); + if (!core.retro_unserialize(decoded.state.data(), decoded.state.size())) { + if (!core.retro_unserialize(before_state.data(), before_state.size())) { + core.retro_unload_game(); loaded = false; retro_game_info game{}; game.path = rom_path.c_str(); game.data = rom.data(); game.size = rom.size(); - if (!retro_load_game(&game)) { + if (!core.retro_load_game(&game)) { error = "State load and rollback failed; core is not runnable"; set_state(SessionState::Error); return false; } loaded = true; - void* memory = retro_get_memory_data(RETRO_MEMORY_SAVE_RAM); - const std::size_t memory_size = retro_get_memory_size(RETRO_MEMORY_SAVE_RAM); - if (memory == nullptr || memory_size != before_battery.size()) { + void* memory = core.retro_get_memory_data(RETRO_MEMORY_SAVE_RAM); + const std::size_t memory_size = core.retro_get_memory_size(RETRO_MEMORY_SAVE_RAM); + if ((!before_battery.empty() && memory == nullptr) || memory_size != before_battery.size()) { error = "Safe reload could not restore battery memory"; set_state(SessionState::Error); return false; } - std::copy(before_battery.begin(), before_battery.end(), static_cast(memory)); + if (!before_battery.empty()) { + std::copy(before_battery.begin(), before_battery.end(), static_cast(memory)); + } } error = "State load failed; previous progress restored"; timing.reset(monotonic_now_ns()); @@ -418,6 +428,8 @@ struct Host { bool export_package(const std::filesystem::path& destination) { (void)save_battery(); std::vector entries; + const std::string identity = core_package_identity(core_kind.load()); + entries.push_back({"core.txt", {identity.begin(), identity.end()}}); const auto root = std::filesystem::path(save_dir) / rom_hash; const std::array candidates = { "battery/battery.sav", "states/slot-0.nls", "states/slot-1.nls", "states/slot-2.nls", @@ -447,8 +459,17 @@ struct Host { error = "Import package rejected: " + (reason.empty() ? std::string("rom_hash") : reason); return false; } - const std::size_t battery_size = retro_get_memory_size(RETRO_MEMORY_SAVE_RAM); + const std::size_t battery_size = core.retro_get_memory_size(RETRO_MEMORY_SAVE_RAM); + const auto identity_entry = std::find_if(package.entries.begin(), package.entries.end(), + [](const SavePackageEntry& entry) { return entry.path == "core.txt"; }); + const std::string identity = identity_entry == package.entries.end() ? "" : + std::string(identity_entry->bytes.begin(), identity_entry->bytes.end()); + if (!core_package_compatible(identity, core_kind.load())) { + error = "Import package rejected: core_mismatch"; + return false; + } for (const auto& entry : package.entries) { + if (entry.path == "core.txt") continue; if (entry.path == "battery/battery.sav") { if (entry.bytes.size() != battery_size) { error = "Import package rejected: battery_size"; @@ -457,8 +478,8 @@ struct Host { } else { DecodedSaveState decoded; if (!decode_save_state(entry.bytes, &decoded, &reason) || - !save_state_compatible(decoded.metadata, rom_hash, std::string(kCoreName), - std::string(kCoreCommit), configuration_identity(), &reason)) { + !save_state_compatible(decoded.metadata, rom_hash, std::string(core_descriptor(core_kind.load()).name), + std::string(core_descriptor(core_kind.load()).commit), configuration_identity(), &reason)) { error = "Import package rejected: " + reason; return false; } @@ -466,6 +487,7 @@ struct Host { } const auto root = std::filesystem::path(save_dir) / rom_hash; for (const auto& entry : package.entries) { + if (entry.path == "core.txt") continue; if (commit_bytes(root / entry.path, entry.bytes) != CommitResult::Committed) { error = "Import package commit failed"; return false; @@ -476,7 +498,7 @@ struct Host { return entry.path == "battery/battery.sav"; }); if (battery != package.entries.end()) { - void* memory = retro_get_memory_data(RETRO_MEMORY_SAVE_RAM); + void* memory = core.retro_get_memory_data(RETRO_MEMORY_SAVE_RAM); std::copy(battery->bytes.begin(), battery->bytes.end(), static_cast(memory)); committed_battery_hash = sha256_hex(battery->bytes); } @@ -497,14 +519,17 @@ struct Host { battery_saved = save_battery(); (void)save_auto_point(); (void)write_session_marker(false); - retro_unload_game(); + core.retro_unload_game(); loaded = false; } if (initialized) { - retro_deinit(); + core.retro_deinit(); initialized = false; } rom.clear(); + compatibility.store(RomCompatibility::Default); + video.clear(); + av = {}; joypad.store(0, std::memory_order_relaxed); turbo.store(0, std::memory_order_relaxed); effective_joypad.store(0, std::memory_order_relaxed); @@ -527,21 +552,35 @@ struct Host { bool perform_load(const Command& command) { const auto load_started = monotonic_now_ns(); unload(); - timing.reset(load_started); session_id.store(command.session_id, std::memory_order_release); + CoreKind selected; + if (!parse_core_kind(command.core_id, &selected)) { + fail(command.session_id, "Unknown built-in core"); + return false; + } + core_kind.store(selected); + std::string core_error; + if (!select_core_api(selected, &core, &core_error)) { + fail(command.session_id, core_error); + return false; + } + timing.reset(load_started); system_dir = command.system_dir; - save_dir = command.save_dir; + save_dir = core_save_base(command.save_dir, selected).string(); rom_hash = command.rom_hash; rom_path = command.rom_path; - error.clear(); + { + std::lock_guard lock(mutex); + error.clear(); + } variables.clear(); - pixel_format = RETRO_PIXEL_FORMAT_RGB565; + pixel_format = RETRO_PIXEL_FORMAT_0RGB1555; set_state(SessionState::Loading); std::error_code directory_error; std::filesystem::create_directories(system_dir, directory_error); if (!directory_error) std::filesystem::create_directories(save_dir, directory_error); - if (!required_host_capabilities_available(retro_api_version(), RETRO_API_VERSION, + if (!required_host_capabilities_available(core.retro_api_version(), RETRO_API_VERSION, !directory_error && !system_dir.empty() && !save_dir.empty())) { fail(command.session_id, "Required libretro API or private directories are unavailable"); return false; @@ -552,31 +591,32 @@ struct Host { return false; } - retro_set_environment(environment_callback); - retro_set_video_refresh(video_callback); - retro_set_audio_sample(audio_sample_callback); - retro_set_audio_sample_batch(audio_batch_callback); - retro_set_input_poll(input_poll_callback); - retro_set_input_state(input_state_callback); - retro_init(); + compatibility.store(rom_compatibility_for(sha256_hex(rom))); + core.retro_set_environment(environment_callback); + core.retro_set_video_refresh(video_callback); + core.retro_set_audio_sample(audio_sample_callback); + core.retro_set_audio_sample_batch(audio_batch_callback); + core.retro_set_input_poll(input_poll_callback); + core.retro_set_input_state(input_state_callback); + core.retro_init(); initialized = true; - retro_set_controller_port_device(0, RETRO_DEVICE_JOYPAD); + core.retro_set_controller_port_device(0, RETRO_DEVICE_JOYPAD); retro_game_info game{}; game.path = rom_path.c_str(); game.data = rom.data(); game.size = rom.size(); - if (!retro_load_game(&game)) { + if (!core.retro_load_game(&game)) { unload(); - fail(command.session_id, "FCEUmm rejected the ROM"); + fail(command.session_id, std::string(core_descriptor(selected).name) + " rejected the ROM; try another core"); return false; } loaded = true; - retro_get_system_av_info(&av); + core.retro_get_system_av_info(&av); if (av.geometry.base_width == 0 || av.geometry.base_height == 0 || av.timing.fps <= 1.0 || av.timing.sample_rate < 8000.0) { unload(); - fail(command.session_id, "FCEUmm returned invalid AV information"); + fail(command.session_id, std::string(core_descriptor(selected).name) + " returned invalid AV information"); return false; } const int core_rate = static_cast(std::lround(av.timing.sample_rate)); @@ -705,7 +745,7 @@ struct Host { } else if (command.name == "reset" && loaded && command_allowed(state.load(), command.name)) { audio_buffer.clear(); resampler.reset(); - retro_reset(); + core.retro_reset(); complete(active_id, "reset"); } else if (command.name == "stop" && (loaded || state == SessionState::Error) && command_allowed(state.load(), command.name)) { @@ -766,7 +806,7 @@ struct Host { std::memory_order_relaxed); previous_turbo_mask = requested_turbo; const auto work_started = clock::now(); - retro_run(); + core.retro_run(); save_schedule.advance(1.0 / fps); if (save_schedule.take_battery_due()) (void)save_battery(); if (save_schedule.take_auto_due()) (void)save_auto_point(); @@ -809,7 +849,8 @@ struct Host { return true; case RETRO_ENVIRONMENT_SET_PIXEL_FORMAT: { const auto format = *static_cast(data); - if (format != RETRO_PIXEL_FORMAT_RGB565) return false; + if (format != RETRO_PIXEL_FORMAT_RGB565 && format != RETRO_PIXEL_FORMAT_XRGB8888 && + format != RETRO_PIXEL_FORMAT_0RGB1555) return false; host.pixel_format = format; return true; } @@ -825,6 +866,10 @@ struct Host { value.erase(0, value.find_first_not_of(' ')); const auto pipe = value.find('|'); host.variables[variable->key] = value.substr(0, pipe); + if (const auto override = compatibility_core_option( + host.compatibility.load(), host.core_kind.load(), variable->key)) { + host.variables[variable->key] = *override; + } } return true; } @@ -880,9 +925,16 @@ struct Host { static void video_callback(const void* data, unsigned width, unsigned height, std::size_t pitch) { Host& host = instance(); - const unsigned bytes_per_pixel = host.pixel_format == RETRO_PIXEL_FORMAT_XRGB8888 ? 4U : 2U; - host.video.submit(data, width, height, pitch, bytes_per_pixel, - static_cast(host.pixel_format)); + if (data == nullptr) return; + if (host.pixel_format == RETRO_PIXEL_FORMAT_RGB565) { + host.video.submit(data, width, height, pitch, 2U, RETRO_PIXEL_FORMAT_RGB565, + host.av.geometry.base_width, host.av.geometry.base_height); + } else if (convert_to_rgb565(data, width, height, pitch, static_cast(host.pixel_format), + &host.converted_pixels)) { + host.video.submit(host.converted_pixels.data(), width, height, width * 2U, + 2U, RETRO_PIXEL_FORMAT_RGB565, + host.av.geometry.base_width, host.av.geometry.base_height); + } } static void audio_sample_callback(std::int16_t left, std::int16_t right) { @@ -915,7 +967,7 @@ struct Host { android_LogPriority priority = level == RETRO_LOG_ERROR ? ANDROID_LOG_ERROR : ANDROID_LOG_INFO; va_list arguments; va_start(arguments, format); - __android_log_vprint(priority, "NESLite/FCEUmm", format, arguments); + __android_log_vprint(priority, "NESLite/Core", format, arguments); va_end(arguments); } }; @@ -925,10 +977,13 @@ struct Host { std::uint64_t load_rom(const std::string& rom_path, const std::string& system_dir, const std::string& save_dir, - const std::string& rom_hash) { + const std::string& rom_hash, + const std::string& core_id) { + CoreKind selected; + if (!parse_core_kind(core_id, &selected)) return 0; Host& host = Host::instance(); const std::uint64_t id = host.issued_session.fetch_add(1) + 1; - if (!host.enqueue(Command{id, "load", rom_path, system_dir, save_dir, rom_hash})) return 0; + if (!host.enqueue(Command{id, "load", rom_path, system_dir, save_dir, rom_hash, core_id})) return 0; return id; } @@ -973,6 +1028,9 @@ std::string session_status_json() { const InputLatencySnapshot input_latency = host.input_latency.snapshot(); std::ostringstream json; json << "{\"sessionId\":" << host.session_id.load(std::memory_order_acquire) + << ",\"coreId\":\"" << core_descriptor(host.core_kind.load()).id << "\"" + << ",\"coreName\":\"" << core_descriptor(host.core_kind.load()).name << "\"" + << ",\"compatibilityProfile\":\"" << compatibility_profile_name(host.compatibility.load()) << "\"" << ",\"state\":\"" << session_state_name(host.state.load(std::memory_order_acquire)) << "\",\"queueDepth\":" << host.commands.size() << ",\"completionId\":" << host.completion_id diff --git a/app/src/main/cpp/core_session.h b/app/src/main/cpp/core_session.h index dfedd26..17fb434 100644 --- a/app/src/main/cpp/core_session.h +++ b/app/src/main/cpp/core_session.h @@ -12,7 +12,8 @@ namespace neslite { std::uint64_t load_rom(const std::string& rom_path, const std::string& system_dir, const std::string& save_dir, - const std::string& rom_hash); + const std::string& rom_hash, + const std::string& core_id); bool session_command(std::uint64_t session_id, const std::string& command); bool save_package_command(std::uint64_t session_id, const std::string& command, const std::string& path); diff --git a/app/src/main/cpp/gl_renderer.cpp b/app/src/main/cpp/gl_renderer.cpp index 269ec34..9f465b2 100644 --- a/app/src/main/cpp/gl_renderer.cpp +++ b/app/src/main/cpp/gl_renderer.cpp @@ -6,6 +6,7 @@ #include #include "core_session.h" +#include "video_viewport.h" namespace neslite { namespace { @@ -16,8 +17,6 @@ GLint texcoord_location = -1; int surface_width = 1; int surface_height = 1; std::uint64_t uploaded_sequence = 0; -unsigned texture_width = 0; -unsigned texture_height = 0; GLuint compile_shader(GLenum type, const char* source) { const GLuint shader = glCreateShader(type); @@ -75,28 +74,11 @@ void renderer_draw(bool integer_scale, bool linear_filter) { glTexImage2D(GL_TEXTURE_2D, 0, format, static_cast(frame.width), static_cast(frame.height), 0, format, type, frame.bytes.data()); uploaded_sequence = frame.sequence; - texture_width = frame.width; - texture_height = frame.height; } - if (texture_width == 0 || texture_height == 0) return; - - int viewport_width; - int viewport_height; - if (integer_scale) { - const int scale = std::max(1, std::min(surface_width / static_cast(texture_width), - surface_height / static_cast(texture_height))); - viewport_width = static_cast(texture_width) * scale; - viewport_height = static_cast(texture_height) * scale; - } else { - viewport_width = std::min(surface_width, surface_height * 4 / 3); - viewport_height = viewport_width * 3 / 4; - if (viewport_height > surface_height) { - viewport_height = surface_height; - viewport_width = viewport_height * 4 / 3; - } - } - glViewport((surface_width - viewport_width) / 2, (surface_height - viewport_height) / 2, - viewport_width, viewport_height); + const auto viewport = calculate_video_viewport(surface_width, surface_height, + frame.base_width, frame.base_height, integer_scale); + if (viewport.width == 0 || viewport.height == 0) return; + glViewport(viewport.x, viewport.y, viewport.width, viewport.height); constexpr GLfloat vertices[] = {-1.F, -1.F, 1.F, -1.F, -1.F, 1.F, 1.F, 1.F}; constexpr GLfloat texcoords[] = {0.F, 1.F, 1.F, 1.F, 0.F, 0.F, 1.F, 0.F}; glUseProgram(program); diff --git a/app/src/main/cpp/jni_bridge.cpp b/app/src/main/cpp/jni_bridge.cpp index b4ce76e..6082b61 100644 --- a/app/src/main/cpp/jni_bridge.cpp +++ b/app/src/main/cpp/jni_bridge.cpp @@ -45,9 +45,10 @@ std::string from_jstring(JNIEnv* env, jstring value) { extern "C" JNIEXPORT jlong JNICALL Java_org_neslite_app_NativeBridge_loadRom(JNIEnv* env, jclass, jstring path, jstring system_dir, - jstring save_dir, jstring hash) { + jstring save_dir, jstring hash, jstring core_id) { return static_cast(neslite::load_rom(from_jstring(env, path), from_jstring(env, system_dir), - from_jstring(env, save_dir), from_jstring(env, hash))); + from_jstring(env, save_dir), from_jstring(env, hash), + from_jstring(env, core_id))); } extern "C" JNIEXPORT jboolean JNICALL diff --git a/app/src/main/cpp/rom_compatibility.cpp b/app/src/main/cpp/rom_compatibility.cpp new file mode 100644 index 0000000..d6c6473 --- /dev/null +++ b/app/src/main/cpp/rom_compatibility.cpp @@ -0,0 +1,24 @@ +#include "rom_compatibility.h" + +namespace neslite { +RomCompatibility rom_compatibility_for(std::string_view sha256) { + // This exact dump jams during startup under NTSC in both pinned cores. + // Dendy reaches the Chinese title and menus without changing ROM bytes. + // Evidence: docs/reports/long-zhu-ying-xiong-0.9.17.md. + return sha256 == "f2fa5c9e40dc68e25fc9d9a4d5f2d5c9179c393d16c0d4e76f843aa17a6df981" + ? RomCompatibility::LongZhuYingXiongDendy : RomCompatibility::Default; +} + +std::string_view compatibility_profile_name(RomCompatibility profile) { + return profile == RomCompatibility::LongZhuYingXiongDendy + ? "long-zhu-ying-xiong-dendy-v1" : "default"; +} + +std::optional compatibility_core_option( + RomCompatibility profile, CoreKind core, std::string_view key) { + if (profile != RomCompatibility::LongZhuYingXiongDendy) return std::nullopt; + if (core == CoreKind::Fceumm && key == "fceumm_region") return "Dendy"; + if (core == CoreKind::Nestopia && key == "nestopia_force_system") return "dendy"; + return std::nullopt; +} +} // namespace neslite diff --git a/app/src/main/cpp/rom_compatibility.h b/app/src/main/cpp/rom_compatibility.h new file mode 100644 index 0000000..d7aae44 --- /dev/null +++ b/app/src/main/cpp/rom_compatibility.h @@ -0,0 +1,14 @@ +#pragma once + +#include +#include +#include "core_catalog.h" + +namespace neslite { +enum class RomCompatibility { Default, LongZhuYingXiongDendy }; + +RomCompatibility rom_compatibility_for(std::string_view sha256); +std::string_view compatibility_profile_name(RomCompatibility profile); +std::optional compatibility_core_option( + RomCompatibility profile, CoreKind core, std::string_view key); +} // namespace neslite diff --git a/app/src/main/cpp/save_package.cpp b/app/src/main/cpp/save_package.cpp index 872eeea..bb49d8c 100644 --- a/app/src/main/cpp/save_package.cpp +++ b/app/src/main/cpp/save_package.cpp @@ -43,6 +43,7 @@ bool fail(std::string* error, const char* message) { } // namespace bool package_path_allowed(const std::string& path) { + if (path == "core.txt") return true; if (path == "battery/battery.sav") return true; if (path.size() == 17U && path.starts_with("states/slot-") && path[12] >= '0' && path[12] <= '9' && path.substr(13) == ".nls") return true; diff --git a/app/src/main/cpp/tests/core_selection_test.cpp b/app/src/main/cpp/tests/core_selection_test.cpp new file mode 100644 index 0000000..0562b54 --- /dev/null +++ b/app/src/main/cpp/tests/core_selection_test.cpp @@ -0,0 +1,50 @@ +#include +#include +#include "core_catalog.h" +#include "save_package.h" +#include "save_state.h" +#include "video_buffer.h" +#include "video_conversion.h" + +int main() { + using namespace neslite; + CoreKind kind = CoreKind::Fceumm; + if (!parse_core_kind("nestopia", &kind) || kind != CoreKind::Nestopia || + parse_core_kind("../external.so", &kind)) return 1; + const std::filesystem::path base("saves"); + if (core_save_base(base, CoreKind::Fceumm) != base || + core_save_base(base, CoreKind::Nestopia) != base / "cores" / "nestopia") return 2; + if (!core_package_compatible("", CoreKind::Fceumm) || core_package_compatible("", CoreKind::Nestopia) || + core_package_compatible(core_package_identity(CoreKind::Nestopia), CoreKind::Fceumm)) return 3; + const std::string identity = core_package_identity(CoreKind::Nestopia); + const auto encoded = encode_save_package(std::string(64, 'a'), + {{"core.txt", {identity.begin(), identity.end()}}, {"battery/battery.sav", {1, 2}}}); + DecodedSavePackage package; + std::string error; + if (!decode_save_package(encoded, &package, &error) || package.entries.size() != 2 || + !core_package_compatible(std::string(package.entries[0].bytes.begin(), package.entries[0].bytes.end()), + CoreKind::Nestopia)) return 4; + SaveStateMetadata metadata; + metadata.rom_hash = std::string(64, 'a'); + metadata.core_name = "FCEUmm"; + metadata.core_commit = core_descriptor(CoreKind::Fceumm).commit; + if (save_state_compatible(metadata, metadata.rom_hash, "Nestopia", + std::string(core_descriptor(CoreKind::Nestopia).commit), "", &error) || error != "core_name") return 5; + const std::array xrgb{0x00ff0000, 0x0000ff00, 0x000000ff, 0}; + std::vector pixels; + if (!convert_to_rgb565(xrgb.data(), 3, 1, 16, 1, &pixels) || + pixels != std::vector{0xf800, 0x07e0, 0x001f}) return 6; + const std::array rgb1555{0x7c00, 0x03e0, 0x001f}; + if (!convert_to_rgb565(rgb1555.data(), 3, 1, 6, 0, &pixels) || + pixels != std::vector{0xf800, 0x07e0, 0x001f}) return 7; + if (convert_to_rgb565(xrgb.data(), 3, 1, 8, 1, &pixels) || + convert_to_rgb565(nullptr, 3, 1, 16, 1, &pixels)) return 8; + VideoBuffer video; + VideoFrame before, after; + if (!video.submit(rgb1555.data(), 3, 1, 6, 2, 2) || !video.latest(&before)) return 9; + video.clear(); + if (video.latest(&after) || !video.submit(rgb1555.data(), 3, 1, 6, 2, 2) || + !video.latest(&after) || after.sequence <= before.sequence) return 10; + std::cout << "Core selection, save isolation and pixel conversion passed.\n"; + return 0; +} diff --git a/app/src/main/cpp/tests/rom_compatibility_test.cpp b/app/src/main/cpp/tests/rom_compatibility_test.cpp new file mode 100644 index 0000000..12c44b8 --- /dev/null +++ b/app/src/main/cpp/tests/rom_compatibility_test.cpp @@ -0,0 +1,26 @@ +#include +#include +#include "rom_compatibility.h" + +int main() { + using namespace neslite; + const std::string hash = "f2fa5c9e40dc68e25fc9d9a4d5f2d5c9179c393d16c0d4e76f843aa17a6df981"; + const auto profile = rom_compatibility_for(hash); + if (profile != RomCompatibility::LongZhuYingXiongDendy || + compatibility_profile_name(profile) != "long-zhu-ying-xiong-dendy-v1") return 1; + if (compatibility_core_option(profile, CoreKind::Fceumm, "fceumm_region") != "Dendy" || + compatibility_core_option(profile, CoreKind::Nestopia, "nestopia_force_system") != "dendy") return 2; + // Same title is not identity; neither a filename nor a neighboring hash can opt in. + for (const auto& other : {std::string{}, std::string("Long Zhu Ying Xiong.nes"), hash.substr(1), + std::string("0") + hash.substr(1)}) { + const auto fallback = rom_compatibility_for(other); + if (fallback != RomCompatibility::Default || + compatibility_core_option(fallback, CoreKind::Fceumm, "fceumm_region") || + compatibility_core_option(fallback, CoreKind::Nestopia, "nestopia_force_system")) return 3; + } + if (compatibility_core_option(profile, CoreKind::Fceumm, "fceumm_sndquality") || + compatibility_core_option(profile, CoreKind::Nestopia, "nestopia_favored_system") || + compatibility_core_option(profile, CoreKind::Nestopia, "fceumm_region")) return 4; + std::cout << "Exact ROM compatibility and per-core option isolation passed.\n"; + return 0; +} diff --git a/app/src/main/cpp/tests/video_viewport_test.cpp b/app/src/main/cpp/tests/video_viewport_test.cpp new file mode 100644 index 0000000..2d6947a --- /dev/null +++ b/app/src/main/cpp/tests/video_viewport_test.cpp @@ -0,0 +1,56 @@ +#include +#include + +#include "video_buffer.h" +#include "video_viewport.h" + +namespace { +bool expect_viewport(const char* label, const neslite::VideoViewport& actual, + int x, int y, int width, int height) { + if (actual.x == x && actual.y == y && actual.width == width && actual.height == height) return true; + std::cerr << label << ": got " << actual.x << ',' << actual.y << ' ' << actual.width << 'x' + << actual.height << ", expected " << x << ',' << y << ' ' << width << 'x' << height << '\n'; + return false; +} +} + +int main() { + using namespace neslite; + // Nestopia composite output: 602 texture samples represent 256 NES pixels. + VideoBuffer video; + const std::vector filtered(602 * 224, 0x1234); + VideoFrame frame; + if (!video.submit(filtered.data(), 602, 224, 602 * 2, 2, 2, 256, 224) || !video.latest(&frame)) return 1; + if (frame.width != 602 || frame.height != 224 || frame.pitch != 1204 || + frame.bytes.size() != filtered.size() * 2 || frame.base_width != 256 || frame.base_height != 224) return 2; + if (!expect_viewport("filtered NES integer", calculate_video_viewport(1664, 1248, + frame.base_width, frame.base_height, true), 192, 64, 1280, 1120)) return 3; + if (!expect_viewport("switch to 4:3", calculate_video_viewport(1920, 1080, + frame.base_width, frame.base_height, false), 240, 0, 1440, 1080)) return 4; + if (!expect_viewport("resized integer", calculate_video_viewport(1000, 750, + frame.base_width, frame.base_height, true), 116, 39, 768, 672)) return 5; + const auto previous_sequence = frame.sequence; + if (video.submit(nullptr, 256, 240, 512, 2, 2, 256, 240) || !video.latest(&frame) || + frame.sequence != previous_sequence || frame.base_height != 224 || frame.width != 602) return 6; + // A newly submitted frame carries changed geometry; no dimension from the previous core survives. + video.clear(); + const std::vector native(256 * 240, 0xabcd); + if (video.latest(&frame) || !video.submit(native.data(), 256, 240, 512, 2, 2, 256, 240) || + !video.latest(&frame) || frame.sequence <= previous_sequence || frame.base_height != 240) return 7; + if (!expect_viewport("uncropped NES integer", calculate_video_viewport(1664, 1248, + frame.base_width, frame.base_height, true), 192, 24, 1280, 1200)) return 8; + // Missing/incomplete geometry falls back as a pair to the actual frame size. + if (!video.submit(native.data(), 256, 224, 512, 2, 2, 0, 240) || !video.latest(&frame) || + frame.base_width != 256 || frame.base_height != 224) return 9; + if (!expect_viewport("native NES integer", calculate_video_viewport(1664, 1248, + frame.base_width, frame.base_height, true), 192, 64, 1280, 1120)) return 10; + if (!expect_viewport("exact 1x", calculate_video_viewport(256, 224, 256, 224, true), + 0, 0, 256, 224)) return 11; + if (!expect_viewport("smaller than 1x", calculate_video_viewport(200, 150, 256, 224, true), + 14, 0, 171, 150)) return 12; + if (!expect_viewport("invalid surface", calculate_video_viewport(0, 150, 256, 224, true), + 0, 0, 0, 0) || !expect_viewport("invalid geometry", calculate_video_viewport(200, 150, 0, 224, true), + 0, 0, 0, 0)) return 13; + std::cout << "Integer/4:3 viewport, filtered geometry, frame handoff and size boundaries passed.\n"; + return 0; +} diff --git a/app/src/main/cpp/video_buffer.cpp b/app/src/main/cpp/video_buffer.cpp index 835679a..aac50d0 100644 --- a/app/src/main/cpp/video_buffer.cpp +++ b/app/src/main/cpp/video_buffer.cpp @@ -5,13 +5,17 @@ namespace neslite { bool VideoBuffer::submit(const void* data, unsigned width, unsigned height, std::size_t source_pitch, - unsigned bytes_per_pixel, int pixel_format) { + unsigned bytes_per_pixel, int pixel_format, + unsigned base_width, unsigned base_height) { if (data == nullptr) return false; // Duplicate-frame marker retains the previous frame. const std::size_t row_bytes = static_cast(width) * bytes_per_pixel; if (width == 0 || height == 0 || bytes_per_pixel == 0 || source_pitch < row_bytes) return false; VideoFrame next; next.width = width; next.height = height; + const bool has_base_geometry = base_width != 0 && base_height != 0; + next.base_width = has_base_geometry ? base_width : width; + next.base_height = has_base_geometry ? base_height : height; next.pitch = static_cast(row_bytes); next.pixel_format = pixel_format; next.bytes.resize(row_bytes * height); @@ -20,7 +24,7 @@ bool VideoBuffer::submit(const void* data, unsigned width, unsigned height, std: std::copy_n(source + row * source_pitch, row_bytes, next.bytes.data() + row * row_bytes); } std::lock_guard lock(mutex_); - next.sequence = frame_.sequence + 1; + next.sequence = ++sequence_; frame_ = std::move(next); return true; } diff --git a/app/src/main/cpp/video_buffer.h b/app/src/main/cpp/video_buffer.h index dd6c458..7179476 100644 --- a/app/src/main/cpp/video_buffer.h +++ b/app/src/main/cpp/video_buffer.h @@ -10,6 +10,9 @@ namespace neslite { struct VideoFrame { unsigned width = 0; unsigned height = 0; + // Core base geometry is the game pixel grid; filtered textures can be wider. + unsigned base_width = 0; + unsigned base_height = 0; unsigned pitch = 0; int pixel_format = 0; std::uint64_t sequence = 0; @@ -19,13 +22,15 @@ struct VideoFrame { class VideoBuffer { public: bool submit(const void* data, unsigned width, unsigned height, std::size_t source_pitch, - unsigned bytes_per_pixel, int pixel_format); + unsigned bytes_per_pixel, int pixel_format, + unsigned base_width = 0, unsigned base_height = 0); bool latest(VideoFrame* frame) const; void clear(); private: mutable std::mutex mutex_; VideoFrame frame_; + std::uint64_t sequence_ = 0; }; } // namespace neslite diff --git a/app/src/main/cpp/video_conversion.cpp b/app/src/main/cpp/video_conversion.cpp new file mode 100644 index 0000000..04c3a77 --- /dev/null +++ b/app/src/main/cpp/video_conversion.cpp @@ -0,0 +1,31 @@ +#include "video_conversion.h" +#include + +namespace neslite { +bool convert_to_rgb565(const void* source, unsigned width, unsigned height, + std::size_t pitch, int format, std::vector* pixels) { + if (source == nullptr || pixels == nullptr || width == 0 || height == 0 || + width > 2048U || height > 2048U || format < 0 || format > 2) return false; + const std::size_t bytes_per_pixel = format == 1 ? 4U : 2U; + if (pitch < width * bytes_per_pixel || pitch > 16U * 1024U) return false; + pixels->resize(static_cast(width) * height); + const auto* bytes = static_cast(source); + for (unsigned y = 0; y < height; ++y) { + for (unsigned x = 0; x < width; ++x) { + std::uint16_t color; + if (format == 1) { + std::uint32_t input; + std::memcpy(&input, bytes + y * pitch + x * 4U, sizeof(input)); + color = static_cast(((input >> 8U) & 0xf800U) | + ((input >> 5U) & 0x07e0U) | ((input >> 3U) & 0x001fU)); + } else { + std::memcpy(&color, bytes + y * pitch + x * 2U, sizeof(color)); + if (format == 0) color = static_cast(((color & 0x7fe0U) << 1U) | + ((color & 0x0200U) >> 4U) | (color & 0x001fU)); + } + (*pixels)[static_cast(y) * width + x] = color; + } + } + return true; +} +} // namespace neslite diff --git a/app/src/main/cpp/video_conversion.h b/app/src/main/cpp/video_conversion.h new file mode 100644 index 0000000..dd5802a --- /dev/null +++ b/app/src/main/cpp/video_conversion.h @@ -0,0 +1,10 @@ +#pragma once +#include +#include +#include + +namespace neslite { +// Libretro formats: 0 = 0RGB1555, 1 = XRGB8888, 2 = RGB565. +bool convert_to_rgb565(const void* source, unsigned width, unsigned height, + std::size_t pitch, int format, std::vector* pixels); +} // namespace neslite diff --git a/app/src/main/cpp/video_viewport.cpp b/app/src/main/cpp/video_viewport.cpp new file mode 100644 index 0000000..573dfd4 --- /dev/null +++ b/app/src/main/cpp/video_viewport.cpp @@ -0,0 +1,33 @@ +#include "video_viewport.h" + +#include +#include + +namespace neslite { + +VideoViewport calculate_video_viewport(int surface_width, int surface_height, + unsigned base_width, unsigned base_height, + bool integer_scale) { + if (surface_width <= 0 || surface_height <= 0 || base_width == 0 || base_height == 0) return {}; + const std::int64_t sw = surface_width; + const std::int64_t sh = surface_height; + const std::int64_t bw = integer_scale ? base_width : 4; + const std::int64_t bh = integer_scale ? base_height : 3; + const auto scale = std::min(sw / bw, sh / bh); + std::int64_t width; + std::int64_t height; + if (integer_scale && scale >= 1) { + width = bw * scale; + height = bh * scale; + } else if (sw * bh <= sh * bw) { + width = sw; + height = std::max(1, sw * bh / bw); + } else { + height = sh; + width = std::max(1, sh * bw / bh); + } + return {static_cast((sw - width) / 2), static_cast((sh - height) / 2), + static_cast(width), static_cast(height)}; +} + +} // namespace neslite diff --git a/app/src/main/cpp/video_viewport.h b/app/src/main/cpp/video_viewport.h new file mode 100644 index 0000000..99af961 --- /dev/null +++ b/app/src/main/cpp/video_viewport.h @@ -0,0 +1,18 @@ +#pragma once + +namespace neslite { + +struct VideoViewport { + int x = 0; + int y = 0; + int width = 0; + int height = 0; +}; + +// Integer scaling uses base geometry, independently of filtered texture size. +// If 1x cannot fit, shrink proportionally so the whole game remains visible. +VideoViewport calculate_video_viewport(int surface_width, int surface_height, + unsigned base_width, unsigned base_height, + bool integer_scale); + +} // namespace neslite diff --git a/app/src/main/java/org/neslite/app/MainActivity.kt b/app/src/main/java/org/neslite/app/MainActivity.kt index c2dbcb7..7df3911 100644 --- a/app/src/main/java/org/neslite/app/MainActivity.kt +++ b/app/src/main/java/org/neslite/app/MainActivity.kt @@ -78,6 +78,9 @@ import org.neslite.app.input.RoutedInputState import org.neslite.app.save.SaveCatalogReader import org.neslite.app.save.SaveSlotSummary import org.neslite.app.settings.AppSettings +import org.neslite.app.core.CorePreferences +import org.neslite.app.core.CorePreferencesStore +import org.neslite.app.core.NesCore import org.neslite.app.settings.AppSettingsStore import org.neslite.app.settings.VirtualDpadSize import org.neslite.app.settings.shouldShowVirtualGamepad @@ -164,6 +167,11 @@ class MainActivity : ComponentActivity(), InputManager.InputDeviceListener { private lateinit var appSettingsStore: AppSettingsStore private var appSettings = AppSettings() private var activeGameHash = "" + private lateinit var corePreferencesStore: CorePreferencesStore + private var corePreferences = CorePreferences() + private var corePreferencesReady = false + private var coreSelectionSaving = false + private var activeCore = NesCore.FCEUMM private var lastCompletionId = 0L private var recoveryPromptedSession = 0L private var pendingSaveExportUri: Uri? = null @@ -255,6 +263,7 @@ class MainActivity : ComponentActivity(), InputManager.InputDeviceListener { database = GameDatabase.get(this) profileStore = ControllerProfileStore(this, profileResolver) appSettingsStore = AppSettingsStore(this) + corePreferencesStore = CorePreferencesStore(this) crashLoopGuard = CrashLoopGuard(this) diagnosticLog = RotatingDiagnosticLog(File(filesDir, "diagnostics")) activeSessionId = savedInstanceState?.getLong(STATE_SESSION_ID) ?: 0L @@ -268,6 +277,7 @@ class MainActivity : ComponentActivity(), InputManager.InputDeviceListener { activeGameHash = "" } else { lastSessionState = nativeStatus?.optString("state", "Paused") ?: "Paused" + activeCore = NesCore.find(nativeStatus?.optString("coreId")) ?: NesCore.FCEUMM } } foregroundPreparePending = activeSessionId != 0L @@ -1217,6 +1227,12 @@ class MainActivity : ComponentActivity(), InputManager.InputDeviceListener { setOnClickListener { closeSettingsPage() } }) arrangeSettingsCards() + settingsPanel.addView(Button(this).apply { + text = "默认 NES 内核:${corePreferences.defaultCore.label}" + isEnabled = corePreferencesReady + setOnClickListener { showCorePicker(null) } + }) + settingsPanel.addView(body("默认内核用于未单独指定的游戏。长按游戏可单独选择;修改在下次打开时生效,各内核存档独立。")) focusFirstButton(settingsPanel) } @@ -1295,9 +1311,17 @@ class MainActivity : ComponentActivity(), InputManager.InputDeviceListener { private fun loadAppSettings() { controllerScope.launch { val loaded = appSettingsStore.load() + val loadedCores = runCatching { corePreferencesStore.load() } runOnUiThread { appSettings = loaded + loadedCores.onSuccess { + corePreferences = it + corePreferencesReady = true + }.onFailure { + showEmulatorStatus("内核设置读取失败,请重新打开应用:${it.message}") + } applyAppSettings() + renderSettings() if (!loaded.guideCompleted) showFirstUseGuide() } } @@ -1370,11 +1394,17 @@ class MainActivity : ComponentActivity(), InputManager.InputDeviceListener { private fun refreshSaveManager() { if (!::saveManagerPanel.isInitialized || saveManagerPanel.visibility != View.VISIBLE || activeGameHash.isBlank()) return val hash = activeGameHash + val core = activeCore + val session = activeSessionId libraryExecutor.execute { - val root = File(File(filesDir, "saves"), hash) + val root = File(core.saveBase(filesDir), hash) val manual = (0 until 10).associateWith { SaveCatalogReader.read(File(root, "states/slot-$it.nls")) } val automatic = (0 until 3).associateWith { SaveCatalogReader.read(File(root, "auto/auto-$it.nls")) } - runOnUiThread { renderSaveManager(manual, automatic) } + runOnUiThread { + if (activeSessionId == session && activeCore == core && activeGameHash == hash) { + renderSaveManager(manual, automatic) + } + } } } @@ -1384,7 +1414,7 @@ class MainActivity : ComponentActivity(), InputManager.InputDeviceListener { ) { if (saveManagerPanel.visibility != View.VISIBLE) return saveManagerPanel.removeAllViews() - saveManagerPanel.addView(section("存档管理")) + saveManagerPanel.addView(section("存档管理 · ${activeCore.label}")) saveManagerPanel.addView(body("手动槽显示提交时间和与状态同帧的缩略图;空槽仍可直接保存。")) manual.forEach { (slot, summary) -> addSaveSlotRow("手动 ${slot + 1}", slot, summary, false) } saveManagerPanel.addView(section("自动恢复点(按时间)")) @@ -2069,7 +2099,8 @@ class MainActivity : ComponentActivity(), InputManager.InputDeviceListener { } private fun showLibraryGameActions(game: GameEntity) { - val actions = arrayOf("查看详情", if (game.favorite) "取消收藏" else "收藏", "从列表移除") + val actions = arrayOf("查看详情", if (game.favorite) "取消收藏" else "收藏", "从列表移除", + "选择内核:${corePreferences.forGame(game.sha256).label}") AlertDialog.Builder(this) .setTitle(game.displayName) .setItems(actions) { _, which -> @@ -2085,11 +2116,50 @@ class MainActivity : ComponentActivity(), InputManager.InputDeviceListener { runOnUiThread { refreshLibrary() } } 2 -> confirmHideGame(game) + 3 -> showCorePicker(game) } } .show() } + private fun showCorePicker(game: GameEntity?) { + if (!corePreferencesReady || coreSelectionSaving) { + Toast.makeText(this, "正在读取或保存内核设置,请稍后重试。", Toast.LENGTH_SHORT).show() + return + } + val cores = NesCore.entries + val labels = if (game == null) cores.map { it.label } else + listOf("跟随默认(${corePreferences.defaultCore.label})") + cores.map { it.label } + var choice = if (game == null) cores.indexOf(corePreferences.defaultCore) else + corePreferences.games[game.sha256]?.let { cores.indexOf(it) + 1 } ?: 0 + AlertDialog.Builder(this) + .setTitle(if (game == null) "默认内核(下次启动生效)" else "${game.displayName} · 下次启动内核") + .setSingleChoiceItems(labels.toTypedArray(), choice) { _, index -> choice = index } + .setPositiveButton("保存") { _, _ -> + val selected = if (game == null) cores[choice] else cores.getOrNull(choice - 1) + coreSelectionSaving = true + controllerScope.launch { + val result = runCatching { + if (game == null) corePreferencesStore.setDefault(requireNotNull(selected)) + else corePreferencesStore.setGame(game.sha256, selected) + } + runOnUiThread { + coreSelectionSaving = false + result.onSuccess { + corePreferences = if (game == null) corePreferences.copy(defaultCore = requireNotNull(selected)) + else corePreferences.withGame(game.sha256, selected) + renderSettings() + Toast.makeText(this@MainActivity, "已保存。重新打开游戏后生效,各内核存档独立。", Toast.LENGTH_LONG).show() + }.onFailure { + showEmulatorStatus("内核设置保存失败:${it.message}") + } + } + } + } + .setNegativeButton("取消", null) + .show() + } + private fun confirmHideGame(game: GameEntity) { AlertDialog.Builder(this) .setTitle("从列表移除?") @@ -2114,16 +2184,21 @@ class MainActivity : ComponentActivity(), InputManager.InputDeviceListener { SimpleDateFormat("yyyy-MM-dd HH:mm", Locale.ROOT).format(Date(epochMs)) private fun loadGame(game: GameEntity) { + if (!corePreferencesReady || coreSelectionSaving) { + showEmulatorStatus("内核设置尚未读取完成,请稍后重试。") + return + } if (pendingSessionCommand != null) { showEmulatorStatus("正在完成会话状态交接,请稍候。") return } - if (crashLoopGuard.isBlocked(game.sha256)) { + val recoveryKey = corePreferences.forGame(game.sha256).recoveryKey(game.sha256) + if (crashLoopGuard.isBlocked(recoveryKey)) { AlertDialog.Builder(this) .setTitle("已阻止重复异常启动") .setMessage("同一游戏和恢复状态已连续异常结束。为避免启动循环,当前停留在列表;可启动其他游戏,或确认后手动重试此游戏。") .setPositiveButton("手动重试") { _, _ -> - crashLoopGuard.clear(game.sha256) + crashLoopGuard.clear(recoveryKey) loadGameUnchecked(game) } .setNegativeButton("留在列表", null) @@ -2135,17 +2210,20 @@ class MainActivity : ComponentActivity(), InputManager.InputDeviceListener { private fun loadGameUnchecked(game: GameEntity) { val path = File(File(filesDir, "roms"), game.fileName).absolutePath + val selectedCore = corePreferences.forGame(game.sha256) activeSessionId = NativeBridge.loadRom( path, File(filesDir, "system").apply { mkdirs() }.absolutePath, File(filesDir, "saves").apply { mkdirs() }.absolutePath, game.sha256, + selectedCore.id, ) activeGameHash = game.sha256 if (activeSessionId != 0L) { + activeCore = selectedCore pendingSessionCommand = "load" lastSessionState = "Loading" - recordSystemEvent("rom_load_requested", JSONObject().put("romHash", game.sha256)) + recordSystemEvent("rom_load_requested", JSONObject().put("romHash", game.sha256).put("coreId", selectedCore.id)) closeOverlayPage() } else { activeGameHash = "" @@ -2154,7 +2232,7 @@ class MainActivity : ComponentActivity(), InputManager.InputDeviceListener { database.games().markPlayed(game.sha256, System.currentTimeMillis()) runOnUiThread { refreshLibrary() } } - showEmulatorStatus(if (activeSessionId == 0L) "命令队列已满" else "正在加载会话 $activeSessionId") + showEmulatorStatus(if (activeSessionId == 0L) "命令队列已满" else "正在使用 ${selectedCore.label} 加载游戏") } private fun beginSavePackageExport(uri: Uri) { @@ -2249,7 +2327,7 @@ class MainActivity : ComponentActivity(), InputManager.InputDeviceListener { val completion = status.optString("completion") val error = status.optString("error") showEmulatorStatus( - "状态:$nextState · $completion" + + "内核:${activeCore.label} · 状态:$nextState · $completion" + (if (status.optBoolean("fastForward")) " · 2×" else "") + error.takeIf { it.isNotBlank() }?.let { "\n错误:$it;可留在暂停菜单重试或退出。" }.orEmpty(), ) @@ -2286,7 +2364,7 @@ class MainActivity : ComponentActivity(), InputManager.InputDeviceListener { activeGameHash.isNotBlank() && nextState == "Paused") { abnormalRecordedSession = activeSessionId val crashState = crashLoopGuard.recordFailure( - activeGameHash, + activeCore.recoveryKey(activeGameHash), status.optString("recoverySignature", "none"), ) recordSystemEvent( @@ -2338,7 +2416,7 @@ class MainActivity : ComponentActivity(), InputManager.InputDeviceListener { "pause" -> if (pendingPauseShowsMenu && nextState == "Paused") showPauseMenu() "pause_external" -> Unit "stop" -> if (nextState == "Idle") { - val stoppedHash = activeGameHash + val stoppedHash = activeCore.recoveryKey(activeGameHash) if (!stopPreservesCrashGuard) crashLoopGuard.clear(stoppedHash) stopPreservesCrashGuard = false activeSessionId = 0L diff --git a/app/src/main/java/org/neslite/app/NativeBridge.kt b/app/src/main/java/org/neslite/app/NativeBridge.kt index 14b4812..6d0c110 100644 --- a/app/src/main/java/org/neslite/app/NativeBridge.kt +++ b/app/src/main/java/org/neslite/app/NativeBridge.kt @@ -12,7 +12,7 @@ object NativeBridge { external fun coreInfo(): String - external fun loadRom(path: String, systemDir: String, saveDir: String, romHash: String): Long + external fun loadRom(path: String, systemDir: String, saveDir: String, romHash: String, coreId: String): Long external fun command(sessionId: Long, command: String): Boolean diff --git a/app/src/main/java/org/neslite/app/core/CorePreferences.kt b/app/src/main/java/org/neslite/app/core/CorePreferences.kt new file mode 100644 index 0000000..efa0e57 --- /dev/null +++ b/app/src/main/java/org/neslite/app/core/CorePreferences.kt @@ -0,0 +1,31 @@ +package org.neslite.app.core + +import java.io.File + +enum class NesCore(val id: String, val label: String) { + FCEUMM("fceumm", "FCEUmm"), + NESTOPIA("nestopia", "Nestopia"), + ; + + fun saveBase(filesDir: File): File = when (this) { + FCEUMM -> File(filesDir, "saves") + NESTOPIA -> File(filesDir, "saves/cores/nestopia") + } + + // Preserve the existing FCEUmm crash-guard key as well as its save directory. + fun recoveryKey(romHash: String): String = if (this == FCEUMM) romHash else "$id:$romHash" + + companion object { + fun find(id: String?): NesCore? = entries.firstOrNull { it.id == id } + } +} + +data class CorePreferences( + val defaultCore: NesCore = NesCore.FCEUMM, + val games: Map = emptyMap(), +) { + fun forGame(hash: String): NesCore = games[hash] ?: defaultCore + fun withGame(hash: String, core: NesCore?): CorePreferences = copy( + games = if (core == null) games - hash else games + (hash to core), + ) +} diff --git a/app/src/main/java/org/neslite/app/core/CorePreferencesStore.kt b/app/src/main/java/org/neslite/app/core/CorePreferencesStore.kt new file mode 100644 index 0000000..8c945dc --- /dev/null +++ b/app/src/main/java/org/neslite/app/core/CorePreferencesStore.kt @@ -0,0 +1,44 @@ +package org.neslite.app.core + +import android.content.Context +import androidx.datastore.core.DataStore +import androidx.datastore.preferences.core.Preferences +import androidx.datastore.preferences.core.edit +import androidx.datastore.preferences.core.stringPreferencesKey +import androidx.datastore.preferences.preferencesDataStore +import kotlinx.coroutines.flow.first + +private val Context.corePreferences: DataStore by preferencesDataStore(name = "core_preferences") + +class CorePreferencesStore(private val dataStore: DataStore) { + constructor(context: Context) : this(context.corePreferences) + + suspend fun load(): CorePreferences { + val values = dataStore.data.first() + val games = values.asMap().mapNotNull { (key, value) -> + val hash = key.name.removePrefix(GAME_PREFIX) + val core = NesCore.find(value as? String) + if (key.name.startsWith(GAME_PREFIX) && validHash(hash) && core != null) hash to core else null + }.toMap() + return CorePreferences(NesCore.find(values[DEFAULT]) ?: NesCore.FCEUMM, games) + } + + suspend fun setDefault(core: NesCore) { + dataStore.edit { it[DEFAULT] = core.id } + } + + suspend fun setGame(hash: String, core: NesCore?) { + require(validHash(hash)) { "Invalid ROM hash" } + dataStore.edit { + val key = stringPreferencesKey(GAME_PREFIX + hash) + if (core == null) it.remove(key) else it[key] = core.id + } + } + + private fun validHash(hash: String): Boolean = hash.length == 64 && hash.all { it in '0'..'9' || it in 'a'..'f' } + + companion object { + private const val GAME_PREFIX = "game_" + private val DEFAULT = stringPreferencesKey("default") + } +} diff --git a/app/src/test/java/org/neslite/app/BuildIdentityTest.kt b/app/src/test/java/org/neslite/app/BuildIdentityTest.kt index efd8884..de88336 100644 --- a/app/src/test/java/org/neslite/app/BuildIdentityTest.kt +++ b/app/src/test/java/org/neslite/app/BuildIdentityTest.kt @@ -7,7 +7,7 @@ class BuildIdentityTest { @Test fun debugBuildUsesTheDocumentedIdentity() { assertEquals("org.neslite.app.debug", BuildConfig.APPLICATION_ID) - assertEquals("0.9.15-debug", BuildConfig.VERSION_NAME) - assertEquals(9015, BuildConfig.VERSION_CODE) + assertEquals("1.0.0-debug", BuildConfig.VERSION_NAME) + assertEquals(1000000, BuildConfig.VERSION_CODE) } } diff --git a/app/src/test/java/org/neslite/app/core/CorePreferencesTest.kt b/app/src/test/java/org/neslite/app/core/CorePreferencesTest.kt new file mode 100644 index 0000000..8c2b56a --- /dev/null +++ b/app/src/test/java/org/neslite/app/core/CorePreferencesTest.kt @@ -0,0 +1,77 @@ +package org.neslite.app.core + +import androidx.datastore.preferences.core.PreferenceDataStoreFactory +import androidx.datastore.preferences.core.PreferencesSerializer +import androidx.datastore.core.okio.OkioStorage +import androidx.datastore.preferences.core.edit +import androidx.datastore.preferences.core.stringPreferencesKey +import java.io.File +import kotlinx.coroutines.CoroutineScope +import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.SupervisorJob +import kotlinx.coroutines.cancelAndJoin +import kotlinx.coroutines.runBlocking +import okio.FileSystem +import okio.Path.Companion.toPath +import org.junit.Assert.* +import org.junit.Rule +import org.junit.Test +import org.junit.rules.TemporaryFolder + +class CorePreferencesTest { + @get:Rule val temporary = TemporaryFolder() + + @Test fun overrideIsPerRomAndCanReturnToDefault() { + val a = "a".repeat(64) + val b = "b".repeat(64) + val initial = CorePreferences() + assertEquals(NesCore.FCEUMM, initial.forGame(a)) + val overridden = initial.withGame(a, NesCore.NESTOPIA) + assertEquals(NesCore.NESTOPIA, overridden.forGame(a)) + assertEquals(NesCore.FCEUMM, overridden.forGame(b)) + assertEquals(NesCore.FCEUMM, overridden.withGame(a, null).forGame(a)) + val changedDefault = overridden.copy(defaultCore = NesCore.NESTOPIA).withGame(a, NesCore.FCEUMM) + assertEquals(NesCore.FCEUMM, changedDefault.forGame(a)) + assertEquals(NesCore.NESTOPIA, changedDefault.forGame(b)) + } + + @Test fun legacySaveAndRecoveryKeysStayIntactWhileNewCoreIsIsolated() { + val root = File("example") + assertEquals(File(root, "saves"), NesCore.FCEUMM.saveBase(root)) + assertEquals(File(root, "saves/cores/nestopia"), NesCore.NESTOPIA.saveBase(root)) + assertEquals("rom", NesCore.FCEUMM.recoveryKey("rom")) + assertNotEquals(NesCore.FCEUMM.recoveryKey("rom"), NesCore.NESTOPIA.recoveryKey("rom")) + assertNull(NesCore.find("../../external.so")) + } + + @Test fun preferencesPersistOverridesAndIgnoreUnknownStoredCores() = runBlocking { + var job = SupervisorJob() + val path = File(temporary.root, "cores.preferences_pb").absolutePath.toPath() + // Okio replaces existing files atomically on Windows as well as Android. + fun openStore() = PreferenceDataStoreFactory.create( + storage = OkioStorage(FileSystem.SYSTEM, PreferencesSerializer, producePath = { path }), + scope = CoroutineScope(job + Dispatchers.IO), + ) + var dataStore = openStore() + try { + val hash = "a".repeat(64) + var store = CorePreferencesStore(dataStore) + store.setDefault(NesCore.NESTOPIA) + store.setGame(hash, NesCore.FCEUMM) + job.cancelAndJoin() + job = SupervisorJob() + dataStore = openStore() + store = CorePreferencesStore(dataStore) + val reloaded = store.load() + assertEquals(NesCore.FCEUMM, reloaded.forGame(hash)) + assertEquals(NesCore.NESTOPIA, reloaded.forGame("b".repeat(64))) + store.setGame(hash, null) + assertEquals(NesCore.NESTOPIA, store.load().forGame(hash)) + dataStore.edit { + it[stringPreferencesKey("default")] = "missing-core" + it[stringPreferencesKey("game_$hash")] = "missing-core" + } + assertEquals(NesCore.FCEUMM, store.load().forGame(hash)) + } finally { job.cancelAndJoin() } + } +} diff --git a/build.gradle.kts b/build.gradle.kts index 7629126..bf2abdf 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -2,3 +2,9 @@ plugins { alias(libs.plugins.android.application) apply false alias(libs.plugins.kotlin.android) apply false } + +// Keep every module's generated files under the repository build directory. +layout.buildDirectory.set(layout.projectDirectory.dir("build/root")) +subprojects { + layout.buildDirectory.set(rootProject.layout.projectDirectory.dir("build/${project.name}")) +} diff --git a/docs/acceptance.md b/docs/acceptance.md index 389670a..9988853 100644 --- a/docs/acceptance.md +++ b/docs/acceptance.md @@ -5,12 +5,12 @@ | 级别 | 用途 | 本地入口/报告 | | --- | --- | --- | | L0 | 文档、清单、版本和材料核对 | 人工核对,记录在阶段报告 | -| L1 | 单项逻辑、构建、解析器或映射 | `tools/check.ps1 -Scope Local` 或 `-Scope Module`,按项追加最小用例 | +| L1 | 单项逻辑、构建、解析器或映射 | 构建用 `打包.cmd -NoPause`;局部 Kotlin/CTest 用例按 [构建说明](build.md) 精确选择 | | L2 | 模块交接、JNI、文件、UI 或设备 | 相邻模块路径;需要设备时记录实机证据 | -| L3 | G0~G7 阶段出口 | `tools/check.ps1 -Scope Stage` 加当阶段指定路径和 H 项 | +| L3 | G0~G7 阶段出口 | 汇总当前构建、受影响模块检查和当阶段指定路径/H 项;有效证据不重复执行 | | L4 | M8/G8 候选发布 | 冻结兼容集和有效 H 项索引 | -默认命令只做 M0 有界验证;不会启动 ROM 集、30 分钟音画、100 次存读档、20 轮插拔/生命周期、 +默认打包只编译选定 APK 并检查静态对齐;不会启动单元测试、ROM 集、30 分钟音画、100 次存读档、20 轮插拔/生命周期、 2 小时长测或 1,000 次延迟采样。 ## H 专项编号 diff --git a/docs/architecture.md b/docs/architecture.md index 60cd0e8..ef24243 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -1,11 +1,11 @@ -# NESLite 架构(0.9.15 候选基线) +# NESLite 架构(1.0.0) ## 边界与线程 界面层只负责系统文件选择器、游戏列表、控制按钮、手柄事件和 GL Surface。ROM 的 `content://` 地址只在 Kotlin 导入层使用;导入完成后,原生层仅收到应用私有目录中的绝对文件路径。 -FCEUmm 由一个原生工作线程独占。JNI 调用只向容量 32 的命令队列写入 +当前选中的 FCEUmm 或 Nestopia 由一个原生工作线程独占。JNI 调用只向容量 32 的命令队列写入 `load/run/pause/reset/stop/mute/volume/audio_rebuild/fast` 命令,命令携带单调递增的会话号。旧会话、重复命令和当前状态不允许的命令不会触碰内核,并在 状态快照的完成通知中报告 `stale` 或 `ignored`。状态集合固定为 Idle、Loading、Paused、 @@ -21,20 +21,28 @@ iNES/NES 2.0 魔数并计算完整文件 SHA-256;提交文件为 `files/roms/< ## libretro 宿主 -固定 FCEUmm 提交见 `third_party/manifest.json`,构建定义在 `app/src/main/cpp/cmake/fceumm.cmake`。 +固定内核提交见 `third_party/manifest.json`,构建定义在 `app/src/main/cpp/cmake/`。 +FCEUmm 静态链接进 JNI 库;Nestopia 构建为 APK 内置的 `libneslite_nestopia.so`,以固定库名加载。 +`CoreApi` 只绑定已登记内核的 libretro 函数,检查必需入口及 API 版本;Nestopia 使用上游导出表与 +`-Bsymbolic` 隔离同名符号。库句柄保留至进程退出,每次换游戏仍执行旧内核卸载/销毁,再初始化新内核。 +所有内核调用均在同一模拟线程完成,不接受下载或外部路径。每次加载前重置选项与像素协商状态。 +`rom_compatibility` 对读取到的 ROM 字节计算完整 SHA-256 后匹配已验证规则,不按文件名推断硬件。 +0.9.17 的唯一特例是指定“龙珠英雄”哈希:注册默认选项时将 FCEUmm 的 `fceumm_region` 设为 `Dendy`, +或将 Nestopia 的 `nestopia_force_system` 设为 `dendy`。其余选项和 ROM 均维持上游默认;原文件及 +数据库身份不变。诊断 JSON 的 `compatibilityProfile` 记录规则 ID,卸载时清回默认。 环境协商清单如下;不在清单中的请求统一返回 `false`。 | 类别 | 处理 | | --- | --- | | 私有目录 | system、save、content,必须可建立,否则阻止加载 | -| 视频 | 固定核心使用的 RGB565 与重复帧;其他像素格式拒绝 | +| 视频 | RGB565、XRGB8888、0RGB1555 与重复帧;后两种转换为 RGB565 后交给显示和缩略图 | | 选项 | core-options version 0 与 `SET_VARIABLES/GET_VARIABLE` 默认值 | | 输入 | player 1 joypad、bitmask、输入/控制器描述 | | 前端信息 | 日志、英语、60 Hz/48 kHz 目标、动态 geometry/AV、消息接口 v1、性能级别、内存映射、成就/内容声明 | | 明确不支持 | VFS、扩展 game-info、硬件渲染以及未列出的请求 | -宿主在加载前核对 libretro API 版本和私有目录;必要能力缺失进入 Error。当前固定 FCEUmm 不把上述 -明确不支持的请求作为加载必要条件。 +宿主在加载前核对 libretro API 版本和私有目录;必要能力缺失进入 Error。具体 ROM 是否可运行仍需按 +各内核分别验证,不能以 API 入口存在代替兼容性结果。 加载、`retro_run`、重置、卸载和保存内存访问均在内核线程执行。时序来自 `retro_get_system_av_info`,以 `steady_clock` 调度;M3 在此边界内把核心音频转换并送往输出线程。 @@ -45,7 +53,7 @@ iNES/NES 2.0 魔数并计算完整文件 SHA-256;提交文件为 `files/roms/< 共享安全模式;每次都检查实际 float/stereo 格式、采样率、burst 和 callback 参数。全部失败时保持 内核的单调时钟调度,不因没有音频而无限追帧。 -FCEUmm 的 int16 stereo 数据先经跨批次连续的线性重采样转成设备实际采样率,再写入 4096 帧 SPSC +内核的 int16 stereo 数据先经跨批次连续的线性重采样转成设备实际采样率,再写入 4096 帧 SPSC 环形缓冲。Oboe 回调只操作预分配内存和原子计数:正常取样、应用 0~1 增益,欠载补零,满缓冲丢弃 新数据并计数;不加锁、不分配、不记录文件。暂停、失焦和快进转换均停止输出并清空旧缓冲。 @@ -60,9 +68,15 @@ Android 音频焦点丢失会暂停并清输入,重新获得焦点不会自行 ## 视频、输入和电池存档 -视频回调逐行按 pitch 复制到原生 latest-only 缓冲;`data == nullptr` 表示重复帧并保留上一完整帧。 -GL 线程只在原生侧读取最新缓冲和上传纹理,不经 JNI 逐帧复制图像。默认 4:3、最近邻显示,可切换 -原始像素整数缩放;渲染掉帧不减少内核 `retro_run` 次数。 +视频回调逐行按 pitch 复制到原生 latest-only 缓冲,同时保存该帧对应的内核基础尺寸 +`geometry.base_width/base_height`;纹理宽高独立保留用于上传。缺失基础尺寸时成对回退为纹理宽高。 +`data == nullptr` 表示重复帧并保留上一完整帧及其尺寸。 +帧序号跨缓冲清空单调递增,切换内核后不会因序号重复而跳过新帧上传。GL 线程只在原生侧读取最新缓冲 +和上传纹理,不经 JNI 逐帧复制图像。默认 4:3、最近邻显示,可切换 +原始像素整数缩放。整数模式按基础宽高选择能完整放入 Surface 的最大共同整数倍率并居中, +放不下一倍时等比例缩小;4:3 模式等比例适配 Surface。Nestopia 默认复合视频输出可能为 +602×224,但基础尺寸为 256×224,不能按 602 计算原始整数倍率。尺寸计算由 `video_viewport` +提供,GL 每次绘制均应用当前模式和 Surface 尺寸,暂停时切换也生效;渲染掉帧不减少内核 `retro_run` 次数。 M4 输入层按物理来源维护状态,来源键包含本次设备 ID、按键/轴/触屏类别、代码和轴方向。多个来源 映射到同一动作时只合成一次;释放一个来源不会清除仍按住的另一个来源。相反方向同时成立时对应轴 @@ -82,17 +96,21 @@ M4 输入层按物理来源维护状态,来源键包含本次设备 ID、按 非运行态不消费方向导航,手柄 B 可从设置返回、从暂停菜单继续。失焦、暂停、断柄和退出同步清除 来源、轴滞回、基础掩码及连发掩码。 -存档按 ROM 哈希隔离。核心线程在帧边界取得不可变电池/核心状态/缩略图快照,统一提交器在文件线程 +存档按内核及 ROM 哈希隔离,FCEUmm 保留原目录,Nestopia 使用独立子目录。核心线程在帧边界取得不可变电池/核心状态/缩略图快照,统一提交器在文件线程 以同目录临时文件、刷新、回读校验、有效备份和原子替换提交,并用单调版本阻止旧任务倒灌。变化电池 每 10 个模拟秒请求,自动恢复点每 60 秒及暂停/退出请求,手动十槽和自动三槽共用带哈希、固定内核 提交、配置、时间、长度和 SHA-256 的 v1 封装,详见 `docs/save-format.md`。 读档只在暂停态核心线程进行并先持久保护当前状态和电池,失败回滚,双重失败安全重载或进入 Error。 -活动会话标记只提示校验有效的异常恢复候选,不自动运行。SAF 存档包只允许电池、手动槽和自动槽, +活动会话标记只提示校验有效的异常恢复候选,不自动运行。SAF 存档包只允许内核标识、电池、手动槽和自动槽, 不含 ROM;原生层在写入前完成路径、单项/总大小、格式、哈希、内核提交、配置和每项校验。 ## M6 日常界面 +独立的 `core_preferences` DataStore 保存默认内核和每 ROM 的覆盖项。设置与长按游戏菜单提供选择, +写入成功后才更新界面;完成初始读取前阻止加载,防止错误使用默认值。加载命令固定本次内核,运行中 +更改偏好只影响下次加载。存档管理使用活动会话的内核和哈希,丢弃旧会话迟到的目录扫描结果。 + Room v2 在 ROM 哈希主键之上保存收藏、隐藏和最近游玩;查询只展示未隐藏项并按收藏、最近、名称排序。 隐藏不操作内部 ROM 或 `saves/`,导入器遇到相同哈希时恢复关联。显示/音频/输入偏好由独立 DataStore 保存,渲染线程只读取整数缩放和过滤快照,音频及手柄继续复用原有命令和档案。 @@ -141,7 +159,7 @@ AndroidX 返回分发先把当前页面和会话状态归一成单一决策: 优先且不会创建第二个核心线程。Activity 进程重建只接回仍存在的原生会话;失效会话直接返回游戏库, 不会凭保存的路径自动加载 ROM。 -异常标记按 ROM 哈希和最新有效自动恢复点签名计数;相同组合连续两次异常即安全结束会话并阻止自动 +异常标记按内核、ROM 哈希和最新有效自动恢复点签名计数;相同组合连续两次异常即安全结束会话并阻止自动 重复进入,用户仍可从列表明确手动重试。系统事件以最多 3 个、每个 256 KiB 的 JSONL 文件轮换。 诊断导出列出应用/设备、输入、可用显示模式及两秒运行样本、帧与音频、存档边界和原生错误,只记录 ROM 哈希,不包含 ROM 字节或文件路径。 diff --git a/docs/build.md b/docs/build.md index 8d7d129..160fe00 100644 --- a/docs/build.md +++ b/docs/build.md @@ -1,82 +1,98 @@ -# NESLite 可复现构建说明 +# NESLite 构建与打包 -本说明对应 0.9.15 候选基线。命令使用系统默认 PowerShell 7.6.6(`pwsh`)从仓库根目录执行;不需要手工复制 `.so`、 -FCEUmm 或 Oboe 文件。 +项目的 APK 打包入口统一为根目录 `打包.cmd`,项目内的编译产物、缓存、日志和交付文件统一放入 +`build/`。当前应用版本为 1.0.0,入口从 APK 构建元数据读取版本,不另写一套版本号。 -## 前置条件 +## 一键打包 -1. 安装或使用 [toolchain.md](toolchain.md) 中的 JDK 17.0.17+10、SDK Platform 36.1、 - NDK 28.2.13676358 与 Android CMake 3.22.1。 -2. 设置 `JAVA_HOME` 指向 JDK 17;不能用系统默认的 JDK 21。 -3. 设置 `ANDROID_HOME`(或在未设置时使用本机记录的 SDK 根目录)。`local.properties` 仅保存 - 本机 `sdk.dir`,不提交。 -4. 首次构建需要访问 Google Maven、Maven Central 与 Gradle 分发服务,以取得已锁定版本。 -5. M2~M4 构建原生内核、音频和输入层前,运行: +双击根目录的 **打包.cmd**。成功后窗口显示安装包完整路径,按回车关闭;失败时显示原因和日志位置。 +默认生成可直接安装的 arm64 调试版,application ID 为 `org.neslite.app.debug`。 - ```powershell - .\tools\fetch-third-party.ps1 - ``` - - 该脚本根据 `third_party/manifest.json` 检出固定提交;M4 构建需要 FCEUmm、libretro headers 与 Oboe。 - -## 构建调试 APK +也可在 PowerShell 中执行: ```powershell -pwsh -NoProfile -File .\tools\check.ps1 -Scope Build +.\打包.cmd -NoPause ``` -产物为 `app/build/outputs/apk/debug/app-debug.apk`,其中只包含 `arm64-v8a` 的 -`libneslite_jni.so`。调试包的 application ID 是 `org.neslite.app.debug`。 +当前交付文件是 `build/releases/NESLite-1.0.0-debug-arm64-v8a.apk`,旁边的 `.sha256` 保存校验值。 +入口检查工具链与固定依赖、编译选定 APK、检查原生库和 APK 的 16 KB 对齐,成功后复制产物。 +它不会自动启动单元测试、ROM 遍历、设备测试或发布回归;失败会返回非零退出码,旧交付 APK 不冒充本次成功产物。 -## 有界检查入口 - -| 命令 | 范围 | 不会执行 | -| --- | --- | --- | -| `pwsh -NoProfile -File ./tools/check.ps1 -Scope Build` | 生成调试 APK | 单元、原生、实机、长测 | -| `pwsh -NoProfile -File ./tools/check.ps1 -Scope Local` | Kotlin 本地单元测试 | APK、原生、实机、长测 | -| `pwsh -NoProfile -File ./tools/check.ps1 -Scope Module` | 原生 smoke test 与 Kotlin 本地单测 | APK、实机、长测 | -| `pwsh -NoProfile -File ./tools/check.ps1 -Scope Stage` | 当前 APK、原生 smoke test 与 Kotlin 本地单测 | 设备、ROM 兼容、耐久、H 专项 | - -`Stage` 是本地阶段入口,不是 G1~G9 的替代。实机、ROM、存档、插拔和耐久验收必须在 -相应里程碑按 [acceptance.md](acceptance.md) 执行和记录。 - -## 构建候选交付材料 - -先提交所有候选源码并保持工作区干净,然后执行: +需要 Release 编译产物时使用同一个入口: ```powershell -pwsh -NoProfile -ExecutionPolicy Bypass -File .\tools\package-rc.ps1 +.\打包.cmd release -NoPause ``` -脚本重跑 Stage 和 release lint,生成 `org.neslite.app` 的未签名 release APK、完整原生符号、应用及 -三个固定第三方依赖的源码包、许可证/说明、静态原生审计、候选清单和 SHA-256。输出位于 -`.build/rc-0.9.15/`。静态审计逐个检查 APK 内 `.so` 的 ELF LOAD 段和 APK 16 KB 对齐,并拒绝非 -arm64-v8a 库。 +该模式使用项目外的正式密钥,生成 `build/releases/NESLite-1.0.0-arm64-v8a.apk`、原生符号、应用和依赖源码 ZIP、发布清单及校验值。 +正式打包前必须提交源码并配置签名目录;入口读取 Windows 用户加密的密码,完成签名和签名验证。密钥位置与发布步骤见 [publishing.md](publishing.md)。 +一键打包不会运行原 `package-rc.ps1` 的全量 Stage/lint/设备测试包构建,也不表示发布门槛通过。 -默认 APK 刻意保持未签名;发布私钥和口令不得传入仓库或写入脚本。获得受保护的发布密钥后,在隔离 -环境签名并重新执行对齐/签名/设备检查。未签名包不能用于安装、覆盖升级或 G8 运行验收。 +## 工具链 -冻结的 12 个 CC0 最小 ROM 冒烟样本可用下列命令在忽略目录重建: +需要 PowerShell 7、JDK 17、SDK Platform 36.1、Build Tools 36.1.0、NDK 28.2.13676358 与 CMake 3.22.1, +版本记录见 [toolchain.md](toolchain.md)。 + +- JDK 优先使用 `build/toolchains/jdk-17.0.17+10`,没有时使用 `JAVA_HOME`,启动前确认 Java 主版本为 17。 +- SDK 依次读取 `local.properties` 的 `sdk.dir`、`ANDROID_HOME`、`ANDROID_SDK_ROOT`,最后尝试 + `%LOCALAPPDATA%/Android/Sdk`。SDK 是本机外部依赖,不复制进项目。 +- Gradle Wrapper 的 JAR、分发地址与校验值保留在 `gradle/wrapper/`,由新入口直接调用。 + 全局 Gradle 下载缓存仍使用用户原有配置,项目缓存放入 `build/cache/gradle`。 +- `tools/fetch-third-party.ps1` 只负责检出固定依赖,由打包入口调用;已有依赖提交不匹配时停止,不覆盖源码。 + 首次缺少依赖时需要访问固定 Git 来源、Google Maven、Maven Central 和 Gradle 分发服务。 + +## 目录约定 + +| 路径 | 内容 | +| --- | --- | +| `build/app/` | Android 中间文件、原始 APK、测试结果和原生符号 | +| `build/native/app/` | Android CMake/Ninja 编译目录 | +| `build/root/` | 根 Gradle 项目生成文件 | +| `build/cache/` | 项目级 Gradle/Kotlin 缓存 | +| `build/tmp/` | 构建时的临时文件 | +| `build/releases/` | 版本化 APK、校验值、Release 符号和许可证材料 | +| `build/logs/` | 最近一次各模式的打包日志 | +| `build/reports/` | 原生审计与保留的历史诊断记录 | +| `build/toolchains/` | 项目本地 JDK;不是可随意删除的编译缓存 | + +模块编译目录与 CMake 编译目录为并列目录,以符合 +[AGP 对 CMake staging 目录的要求](https://developer.android.com/reference/tools/gradle-api/8.13/com/android/build/api/dsl/Cmake#buildStagingDirectory)。 +Kotlin 的项目缓存通过其 +[持久化目录配置](https://kotlinlang.org/docs/gradle-configure-project.html#kotlin-gradle-plugin-data-in-a-project)迁移。 + +## 按影响选择检查 + +打包和验收分开执行,按 `todo.md` 选择最小相关范围。需要 Kotlin 局部用例时,可直接调用保留的 Wrapper: ```powershell -pwsh -NoProfile -ExecutionPolicy Bypass -File .\tools\generate-rc-roms.ps1 +$env:JAVA_HOME = (Resolve-Path build/toolchains/jdk-17.0.17+10).Path +$env:TEMP = (Resolve-Path build/tmp).Path +$env:TMP = $env:TEMP +$env:JAVA_TOOL_OPTIONS = "-Djava.io.tmpdir=`"$env:TEMP`" -Djdk.net.unixdomain.tmpdir=`"$env:TEMP`"" +& "$env:JAVA_HOME/bin/java.exe" -classpath gradle/wrapper/gradle-wrapper.jar org.gradle.wrapper.GradleWrapperMain --project-cache-dir build/cache/gradle :app:testDebugUnitTest --tests org.neslite.app.BuildIdentityTest ``` -它们不包含游戏素材,也不能替代音画、滚屏、电池进度和长稳所需的合法代表游戏样本。设备长稳采集 -入口为 `tools/collect-h-long.ps1`;默认 120 分钟、60 秒一次,只负责采集,不自动批准内存趋势。 - -## M1 诊断版安装 - -连接并授权一台目标手机后执行: +原生测试在 `build/native-tests` 配置后,只构建和运行相关目标,例如显示修复: ```powershell -pwsh -NoProfile -File .\tools\check-m1-device.ps1 +$taskCmake = "$env:LOCALAPPDATA/Android/Sdk/cmake/3.22.1/bin" +& "$taskCmake/cmake.exe" -S app/src/main/cpp -B build/native-tests +& "$taskCmake/cmake.exe" --build build/native-tests --config Debug --target neslite_video_viewport_test +& "$taskCmake/ctest.exe" --test-dir build/native-tests -C Debug --output-on-failure -R '^neslite_video_viewport_test$' ``` -脚本安装并启动 `0.1.3-debug` 诊断版;手柄操作和导出步骤见 -[controller-x5lite.md](controller-x5lite.md)。连接多台设备时传入 `-Serial `。 +单 ROM 桌面诊断见 [探针说明](../tools/rom-probe/README.md)。`tools/check-m1-device.ps1` 只安装和启动已构建 +的调试 APK,`tools/check-rc-native.ps1` 只审计现有 APK;它们不是另一个编译入口。ROM 样本生成与长稳采集 +脚本的默认输出也已改到 `build/`,专项按 [acceptance.md](acceptance.md) 执行。 -## 清理 +## 清理与历史记录 -只清理本工程生成物时删除 `build/`、`app/build/` 和 `.build/`;不要删除 SDK、NDK、 -`.toolchains/` 或用户的签名密钥。上述输出均已被 Git 忽略。 +旧的 `tools/check.ps1`、`tools/package-rc.ps1`、`gradlew`、`gradlew.bat` 已由 `打包.cmd` 替代。 +旧 `.build/`、`app/build/`、`app/.cxx/`、项目根 `.gradle/`、`.kotlin/` 及重复工具链目录已清理; +保留的本地 JDK 已迁入 `build/toolchains/`。Gradle/CMake 配置、Wrapper JAR 和锁定信息是编译依赖,继续保留。 + +历史报告中的命令和产物路径记录当时状态,不再作为现行入口。保留的旧日志、审计 JSON 与 ROM 诊断画面 +归档在 `build/reports/history/`;历史 APK 和候选发布材料迁入 `build/releases/history/`,可重新生成的旧编译目录已删除。 + +日常清理可删除 `build/app`、`build/native`、`build/root`、`build/cache`、`build/tmp` 等生成目录; +保留 `build/toolchains` 和需要留存的交付/验收记录。整个 `build/` 不进入 Git;不要删除外部 SDK、签名密钥或 ROM。 diff --git a/docs/dependencies.md b/docs/dependencies.md index 87f7447..49e3bf2 100644 --- a/docs/dependencies.md +++ b/docs/dependencies.md @@ -15,9 +15,14 @@ Gradle 版本锁见 [gradle/libs.versions.toml](../gradle/libs.versions.toml)。 | Room | 2.7.2 | Google Maven | Apache-2.0;保留 notices | M2 使用 | | DataStore Preferences | 1.1.7 | Google Maven | Apache-2.0;保留 notices | M4 使用 | | FCEUmm | `236ccdfc911e84c60fea6b9d0699c2d440a8de14` | `tools/fetch-third-party.ps1` | GPL-2.0-only;交付完整对应源码、COPYING、修改说明 | M2 使用 | +| Nestopia | `224713b257c8620513c1c9ca28dc7f8dea711e18` | `tools/fetch-third-party.ps1` | GPL-2.0-or-later;内含 nes_ntsc(LGPL-2.1-or-later),保留完整源码、许可及版权 | 0.9.16 内置可选内核 | | libretro.h | `0c9622896333ee62dc4326bbe8784a210ddeb03c` | `tools/fetch-third-party.ps1` | MIT;保留版权及许可 | M2 使用 | | Oboe | 1.10.0 / `a81bb9f87d4105b84b682685d3bfbb5beca371d1` | `tools/fetch-third-party.ps1` | Apache-2.0;保留 notices | M3 使用 | -本项目计划静态链接 GPL-2.0-only 的 FCEUmm;因此将应用和可分发的对应源码按 +Nestopia 无上游源码补丁;本仓库 CMake 读取固定提交的 `libretro/Makefile.common` 源码列表,使用 +`__LIBRETRO__`、`NST_NO_ZLIB`、C++98 和独立共享库。其内置游戏数据库随源码构建,无需用户下载 XML。 +上游来源为 [libretro/nestopia](https://github.com/libretro/nestopia/tree/224713b257c8620513c1c9ca28dc7f8dea711e18)。 + +本项目静态链接 GPL-2.0-only 的 FCEUmm;因此将应用和可分发的对应源码按 GPL-2.0-only 处理。发布前必须由发行负责人核对依赖的实际引入图、完整许可文本、版权声明、 修改源和源码提供义务;M0 的清单不构成法律意见。 diff --git a/docs/development_plan_V1.0.md b/docs/development_plan_V1.0.md index 97de2b2..15cf712 100644 --- a/docs/development_plan_V1.0.md +++ b/docs/development_plan_V1.0.md @@ -5,18 +5,19 @@ | 产品名称 | NESLite | | 文档版本 | V1.0 | | 编制日期 | 2026-09-12 | -| 需求依据 | [design.md](../design.md) | +| 最近修订 | 2026-09-14:按用户确认增加内置内核选择 F15,见第 11 节 | +| 需求依据 | [design.md](../design.md) 及第 11 节用户需求增补 | | 目标版本 | Android 应用 1.0.0 | | 首要设备 | 用户的 Honor MagicOS 10 手机+小鸡 X5 Lite 手柄 | -| 当前状态 | 规划完成,开发尚未开始;编制前目录仅有设计文档,尚无 Android 工程,也未初始化 Git 仓库 | +| 当前状态 | 用户确认产品可发布,准备 1.0.0 签名交付至 git.m3frame.com/shen/NESLite;打包入口为打包.cmd,输出统一在 build;历史专项证据与任务勾选状态见 todo.md,不将未执行项自动视为通过 | -本计划将 `design.md` 转化为可执行的任务、阶段依赖、交付物和验收门槛。产品范围以设计文档为准;工期、实现默认值和测试样本数量属于本计划提出的执行基线,尚无实机测试结果。文档版本 V1.0 不代表应用已经达到 1.0.0。 +本计划将 `design.md` 转化为可执行的任务、阶段依赖、交付物和验收门槛。产品范围以设计文档及明确记录的用户增补为准;工期、实现默认值和测试样本数量属于执行基线,不能代替验收结果。文档版本 V1.0 不代表应用已经达到 1.0.0。 ## 1. 开发目标与范围 ### 1.1 交付目标 -交付一款采用固定版本 FCEUmm 内核、自研 Android 前端、原生手柄输入的轻量 NES/FC 模拟器。用户能够完成“导入游戏 → 连接手柄 → 开始游戏 → 暂停和存档 → 退出 → 恢复进度”,并在目标手机上获得稳定的速度、声音和操作体验。 +交付一款内置固定版本 FCEUmm 和 Nestopia 内核、自研 Android 前端、原生手柄输入的轻量 NES/FC 模拟器。用户能够完成“导入游戏 → 选择内核 → 连接手柄 → 开始游戏 → 暂停和存档 → 退出 → 恢复进度”,并在目标手机上获得稳定的速度、声音和操作体验。 第一版复用内核的 CPU、PPU、APU 和 Mapper 实现,开发重心为 Android 适配、libretro 宿主、音视频调度、输入和数据可靠性。所有内核能力均需经过前端接入和测试才能算作产品功能。 @@ -40,10 +41,11 @@ | F12 | 虚拟方向键、A/B、Start、Select,基础触屏菜单操作 | M6 | 无手柄可完成基本游戏操作,支持多点触控和取消事件 | | F13 | 手柄测试、运行状态、错误日志和诊断导出 | M1 基础,M7 完成 | 能定位设备、输入、音频、存档和原生错误 | | F14 | arm64 发布、4 KB/16 KB 验证、安装升级、源码及许可证交付 | M8~M9 | 发布包、源码、符号、构建记录和验收报告对应 | +| F15 | 内置 FCEUmm/Nestopia 选择,默认值与逐游戏覆盖,独立存档 | XCORE(第 11 节),M8 汇总 | 持久选择、下次加载生效、切回原内核保留存档、同 ROM 对照验证 | ### 1.3 明确不做 -V1.0 不做联网对战、云存档、多平台模拟、在线下载游戏、复杂 CRT 滤镜、回溯、run-ahead、用户下载或切换内核。FDS、光枪、四人适配器和第二只手柄的完整体验留待 V1.1 之后。 +V1.0 不做联网对战、云存档、多平台模拟、在线下载游戏、复杂 CRT 滤镜、回溯、run-ahead、用户下载或导入外部内核。内置内核选择按 F15 纳入本轮。FDS、光枪、四人适配器和第二只手柄的完整体验留待 V1.1 之后。 导入器首版仅开放 `.nes`,不扩展到压缩包、UNIF 或固件管理。应用不附带商业游戏 ROM。首版交付以可安装 APK 为准,应用商店上架不计入本轮工期。 @@ -56,8 +58,8 @@ V1.0 不做联网对战、云存档、多平台模拟、在线下载游戏、复 | Android | `minSdk 28`,`compileSdk 36`,`targetSdk 36` | 延续设计目标;实际手机 API、ABI 和页大小在 M1 读取 | | 应用层 | Kotlin、AndroidX、原生 View | 单一 `app` 模块,按包划分职责;游戏使用独立页面 | | 数据 | Room+DataStore | Room 管理游戏元数据;DataStore 管理设置和控制器配置 | -| 内核 | FCEUmm+libretro 接口 | M0 选定完整提交 SHA;M2 编译验证后冻结 | -| 原生层 | C/C++、JNI、Android NDK、CMake | 优先将固定内核静态链接进 JNI 库;上游构建适配保留可复现脚本 | +| 内核 | 固定提交的 FCEUmm/Nestopia+libretro 接口 | 清单记录完整提交 SHA;默认 FCEUmm,Nestopia 按 F15 接入 | +| 原生层 | C/C++、JNI、Android NDK、CMake | FCEUmm 静态链接进 JNI;Nestopia 使用包内独立共享库;可复现构建并隔离同名符号 | | 视频 | `GLSurfaceView`+OpenGL ES | 原生帧缓冲交接;不经 Kotlin 每帧搬运图像 | | 音频 | Oboe | 记录实际流参数,支持请求低延迟失败后的回退 | | 构建工具 | AGP 8.13.2、Gradle 8.13、JDK 17 | 采用设计给出的兼容组合;M0 在本机完成构建验证 | @@ -141,11 +143,12 @@ Paused → Stopping → Idle ├── saves//battery/ 游戏自身存档及有效备份 ├── saves//states/ 10 个手动槽位及元数据、缩略图 ├── saves//auto/ 最近 3 份自动恢复点 +├── saves/cores/nestopia// Nestopia 独立的 battery、states、auto、recovery 与会话标记 ├── system/ 内核需要的稳定系统目录 -└── diagnostics/ 限额日志及会话标记 +└── diagnostics/ 限额日志 ``` -Room 数据库和 DataStore 使用各自标准应用目录;数据库记录游戏哈希、显示名、内部文件关联、收藏、最近游玩时间和列表可见状态。哈希按导入文件的完整字节计算,不擅自去头或改写文件;内容不同的版本分别管理。 +FCEUmm 延续 `saves//`,读档保护副本及会话标记也在各内核、各 ROM 根目录内。Room 数据库和 DataStore 使用各自标准应用目录;数据库记录游戏哈希、显示名、内部文件关联、收藏、最近游玩时间和列表可见状态。哈希按导入文件的完整字节计算,不擅自去头或改写文件;内容不同的版本分别管理。 导入按“读取 URI → 有界流式复制和头部校验 → 计算 SHA-256 → 提交内部正式文件 → 数据库事务登记”执行。取消、空间不足及提交中断必须清理临时文件;数据库和文件系统不能形成单一事务,因此需在启动时对未登记正式文件及缺失文件记录进行核对和恢复。 @@ -212,7 +215,7 @@ Room 数据库和 DataStore 使用各自标准应用目录;数据库记录游 | --- | --- | | 0.2.0/M2-01 | 编译锁定的 FCEUmm;接入 libretro API 版本检查、回调注册、初始化、目录、选项、玩家一端口和卸载 | | 0.2.1/M2-02 | SAF 导入、文件大小与头部校验、SHA-256 去重、稳定内部副本、最小 Room 索引和错误提示 | -| 0.2.2/M2-03 | 视频回调、协商像素格式、行跨度与重复帧处理;GL 显示、4:3 和整数缩放基础能力 | +| 0.2.2/M2-03 | 视频回调、协商像素格式、行跨度与重复帧处理;区分纹理宽高与内核基础尺寸,GL 按基础尺寸整数缩放并支持 4:3 适配;空间不足一倍时等比例缩小 | | 0.2.3/M2-04 | 模拟线程和会话状态机;手柄快照接入;启动、暂停、继续、重置、退出;基础电池存档读写 | **出口条件:** 至少 3 个有权使用的样本完成加载和运行,其中包含一个电池存档样本;完整操作流程通过;正常退出再加载后游戏自身进度可恢复;损坏文件加载失败不会破坏现有数据。 @@ -291,7 +294,7 @@ Room 数据库和 DataStore 使用各自标准应用目录;数据库记录游 | M8-03 | 检查全部发布原生库与 APK 的 16 KB 对齐;4 KB 和 16 KB 环境运行;API 28 基线冒烟 | | M8-04 | 同应用 ID/签名覆盖升级、Room/设置迁移和存档兼容验证;整理发布源码、许可证、符号和已知问题 | -**出口条件:** 第 7 节发布门槛全部通过,无阻断或高优先级缺陷;最终候选包而非仅调试包通过安装、加载、输入、音频、保存恢复及退出冒烟。修复后重跑受影响用例;内核、时钟或存档格式变动须重跑对应完整测试集。 +**出口条件:** 第 7 节发布门槛全部通过,无阻断或高优先级缺陷;最终候选包而非仅调试包通过安装、加载、输入、音频、保存恢复及退出冒烟。修复后重跑受影响用例;内核、时钟或存档格式变动在开发时先做局部检查,冻结候选前补齐受影响的完整测试集,按 todo.md 分级规则复用仍有效证据。 ### M9/1.0.0:正式交付 @@ -419,11 +422,11 @@ FCEUmm 上游声明采用 GNU GPL v2,并要求参考源文件头部细节, - [ ] 存档格式、内核升级兼容策略、升级安装记录和已知问题。 - [ ] `LICENSE`、`THIRD_PARTY_NOTICES` 及对应依赖许可证材料。 -只有 F01~F14 在约定范围内完成、发布指标通过且无阻断/高优先级缺陷时,才将应用标记为 1.0.0。 +只有 F01~F15 在约定范围内完成、发布指标通过且无阻断/高优先级缺陷时,才将应用标记为 1.0.0。 ## 10. 首轮启动清单 -首轮执行 M0 和 M1,先交付能安装、能加载原生库、能验证真实手柄输入的 0.1.x 诊断版。 +本节保留初始启动顺序。首轮执行 M0 和 M1,先交付能安装、能加载原生库、能验证真实手柄输入的 0.1.x 诊断版。 1. 建立 Android+JNI 最小工程,锁定工具链,生成首个可安装 APK。 2. 确定应用 ID、依赖提交、基础数据目录及版本管理方式。 @@ -433,3 +436,31 @@ FCEUmm 上游声明采用 GNU GPL v2,并要求参考源文件头部细节, 6. 完成 M1 出口检查后,进入 M2 的 ROM 导入和 FCEUmm 接入。 首轮以设备与手柄实测为目标。首次音画完整的可玩验收在 M3,可靠日常使用验收在 M6~M7,正式发布在 M8~M9 全部门槛通过后进行。 + +## 11. F15 增补:内置内核选择(2026-09-14) + +用户确认在应用内置的多个内核间切换,并反馈“龙珠英雄”无法打开、黑屏。本增补覆盖原设计中不提供 +内核切换的限制;仍不提供外部内核文件、在线下载或自动尝试所有内核。原 M0~M9 编号和已有验收证据 +保留,增加 XCORE 实现任务及 GCORE 门槛,纳入 G8 汇总。0.9.16 为开发验证版本,原工期估算不含本增补。 + +行为契约:初始默认 FCEUmm,可设 Nestopia 为默认;每个 ROM 可覆盖默认或恢复“跟随默认”。选择持久化, +只在下次打开游戏时生效;旧会话先保存/卸载/销毁,再初始化所选内核。单次只运行一个内核实例。 +FCEUmm 保留原存档目录,Nestopia 使用独立目录;电池、即时存档、备份和异常恢复计数均隔离,跨内核 +状态与存档包拒绝导入。固定提交、具体目录和封装细节以依赖清单及 `docs/save-format.md` 为准。 + +| 任务 | 交付内容 | 前置 | 最小验收 | +| --- | --- | --- | --- | +| XCORE-01 | 固定 Nestopia 来源并接入双内核宿主、像素格式转换和打包 | 现有可构建的 M2/M3 接口 | L1:arm64 构建、必需入口、局部转换用例、全部库静态对齐 | +| XCORE-02 | 默认和逐游戏选择、持久记录、下次加载生效及当前内核展示 | XCORE-01 | L1:应用编译,默认/覆盖/取消与磁盘重开读取的局部测试 | +| XCORE-03 | 按内核隔离存档与恢复标记,校验存档包身份,保留旧 FCEUmm 数据 | XCORE-01、现有 M5 格式接口 | L1:旧路径、独立路径、包往返、跨内核拒绝、旧包归属 | +| XCORE-04 | 在 Android 验证切换、重启持久化和独立进度 | XCORE-02、XCORE-03 | L2:同进程 FCEUmm→Nestopia→FCEUmm,一份带电池及一份无电池样本的相关分支 | +| XCORE-05 | 定位“龙珠英雄”黑屏,按已确认哈希修正制式选择并记录双内核结果 | XCORE-04、具体 ROM 与目标手机;桌面复现可提前独立完成 | L1:精确匹配及选项隔离;L2:记录哈希/Mapper/区域/包与内核提交,分别验证加载、进入游戏、输入及音画 | + +GCORE 为 L3 汇总门槛,依赖 XCORE-01~05;待办条目给出可勾选标准。开发时只运行受影响模块的局部 +检查和上述短路径;冻结候选时一次性补受影响内核的兼容集、H-AV、H-SAVE 和 H-NATIVE,已有仍有效证据 +按待办第 2 节复用。GCORE 与 G8 引用同一报告,不能各启动一轮重复测试。H-LONG/H-INPUT/H-UPGRADE +保留原发布节点,只有相关证据失效或尚未取得时补齐。桌面测试和静态对齐通过不代替手机加载、16 KB 运行 +或具体游戏兼容结果。 + +接入证据见 [双内核报告](reports/core-selection-0.9.16.md),具体 ROM 的制式修复见 +[0.9.17 记录](reports/long-zhu-ying-xiong-0.9.17.md),任务状态只在 [todo.md](../todo.md) 勾选。 diff --git a/docs/identity.md b/docs/identity.md index d61d56e..36e7964 100644 --- a/docs/identity.md +++ b/docs/identity.md @@ -6,7 +6,7 @@ | --- | --- | | 显示名称 | `NESLite` | | 正式 application ID/namespace | `org.neslite.app` | -| 当前候选版本 | `0.9.15`,`versionCode = 9015` | +| 当前发布版本 | `1.0.0`,`versionCode = 1000000` | | 调试 application ID | `org.neslite.app.debug` | | 发布 ABI | `arm64-v8a` | | min/target SDK | 28/36 | @@ -28,6 +28,10 @@ release keystore;私钥、口令、`*.jks`/`*.keystore` 和 CI 密钥不进 首次发布时记录别名、证书 SHA-256 指纹、有效期和保管责任人到未提交的发布保管记录。之后所有 `org.neslite.app` 更新必须使用同一签名证书;若证书不可恢复,不能以同一 ID 声明无缝升级。 +1.0.0 正式签名证书 SHA-256: +`767BDF6D6AB140B336EFCF28C5BAAC7A8515F2D760BC568283BAB4537D319191`。 +密钥别名为 `neslite-release`,RSA 3072,有效期至 2054-01-30;私钥与密码仅在维护者本机保存。 + ## 数据目录约定 应用内部 `files/` 的长期布局如下,正式 ROM 不放在 `cache/`: @@ -38,10 +42,12 @@ files/ ├── saves//battery/ ├── saves//states/ ├── saves//auto/ +├── saves/cores/nestopia// Nestopia 独立的 battery、states、auto、recovery 与标记 ├── system/ └── diagnostics/ ``` -Room 与 DataStore 使用 Android 标准私有目录。ROM 身份是导入文件完整字节的 SHA-256;同名但 +FCEUmm 保持原存档位置;Nestopia 不读取或迁移 FCEUmm 存档。`core_preferences` DataStore 保存默认 +内核及按 ROM 哈希覆盖的选择,不改变 Room 身份。Room 与 DataStore 使用 Android 标准私有目录。ROM 身份是导入文件完整字节的 SHA-256;同名但 不同内容必须独立,重新导入相同哈希才重新关联既有存档。目录本身在 M2/M5 实现,本文件只固定 数据兼容约定。 diff --git a/docs/known-issues.md b/docs/known-issues.md index 87db268..0f6d0ea 100644 --- a/docs/known-issues.md +++ b/docs/known-issues.md @@ -1,15 +1,19 @@ -# 已知问题与候选版限制 +# 已知问题与验证记录 -本清单对应 0.9.15 候选源码。优先级含义:阻断表示 G8 不可通过;高表示发布前必须处理;中/低需有 -明确接受或修复结论。 +用户于 2026-09-14 确认产品可发布,并授权准备 1.0.0 源码和签名 APK。下表保留开发期间的 +问题与证据缺口;旧优先级对应原 G8 计划,不把用户的发布决定改写成未执行专项已经通过。 +本次签名与发布记录见 [发布说明](publishing.md)。 | 编号 | 优先级 | 状态 | 问题与处理条件 | | --- | --- | --- | --- | +| CORE-H01 | 高 | 已定位/待手机复核 | 用户提供的 ROM 哈希为 `f2fa5c9e40dc68e25fc9d9a4d5f2d5c9179c393d16c0d4e76f843aa17a6df981`,Mapper 4。两个内核按 NTSC 启动均卡死;0.9.17 对该哈希自动选 Dendy,两内核各 1800 帧启动/菜单与一次核心状态往返通过,手机端和完整玩法仍待验证。见 `docs/reports/long-zhu-ying-xiong-0.9.17.md`。 | +| CORE-H02 | 高 | 待实机 | 双内核 APK 已构建并通过局部自动测试及静态对齐检查;Android 动态加载、切换、音画和存档路径尚待 XCORE-04 及 GCORE 验收。 | +| VIDEO-H01 | 高 | 已修复/待手机复核 | Nestopia 扩展纹理被误用为原始像素宽度,导致整数模式横向拉宽。0.9.18 按内核基础尺寸计算倍率,局部尺寸测试和两内核桌面尺寸检查通过;M2-03b 的手机切换复核待完成。见 `docs/reports/integer-scaling-0.9.18.md`。 | | RC-B01 | 阻断 | 开放 | 荣耀 Magic8 已通过手动安装、JNI 与设备基线并枚举 X5 Lite,但无 ADB,且按键、插拔、ROM 主链、生命周期等 G1~G7/G8 实机证据仍不完整。 | | RC-B02 | 阻断 | 开放 | 尚无满足动作/滚屏、声音和可观察电池进度要求的合法游戏样本;冻结的 12 个 CC0 最小样本只能用于加载冒烟。 | | RC-B03 | 阻断 | 开放 | H-LONG、H-INPUT、4 KB/16 KB 运行、API 28 冒烟及 H-UPGRADE 尚未在设备执行。 | -| RC-B04 | 阻断 | 开放 | 尚未提供受保护的发布签名密钥及同 ID/同签名旧版数据集;当前 RC 静态审计包为未签名 APK。 | -| RC-M01 | 中 | 开放 | Debug lint 有 46 个非阻断警告,主要是动态界面文本国际化、依赖版本提示和 Android 16 固定横屏兼容提醒;无 lint 错误。 | +| RC-B04 | 阻断 | 签名已配置/升级证据待补 | 已创建独立正式密钥,打包入口支持签名和验证;首次正式包使用 org.neslite.app,旧调试包为 org.neslite.app.debug。同 ID/同签名旧版数据集和 H-UPGRADE 记录仍未归档。 | +| RC-M01 | 中 | 开放 | 0.9.15 的历史 Debug lint 记录有 46 个非阻断警告,主要是动态界面文本国际化、依赖版本提示和 Android 16 固定横屏兼容提醒;0.9.16~0.9.18 局部修订均未重跑 lint,候选冻结时更新结果。 | 不得通过删除失败 ROM、缩短规定轮数/时长、用 x86_64 替代 arm64,或用桌面原生测试替代 Android 实机运行来关闭阻断项。每项关闭时应在 M8 报告登记设备、包哈希、ROM 哈希、命令、原始日志和结论。 diff --git a/docs/publishing.md b/docs/publishing.md new file mode 100644 index 0000000..06b4aaa --- /dev/null +++ b/docs/publishing.md @@ -0,0 +1,35 @@ +# NESLite 发布到 Gitea + +源码仓库:`http://git.m3frame.com/shen/NESLite.git`;发行页: +[shen/NESLite/releases](http://git.m3frame.com/shen/NESLite/releases)。源码放入 Git,APK、源码归档和符号放入发行附件。 + +## 正式签名 + +维护者本机默认目录为 `%USERPROFILE%/NESLite-private/signing`,可用 `NESLITE_SIGNING_DIRECTORY` 覆盖。 +目录内使用 `neslite-release.p12`、`password.dpapi`,别名 `neslite-release`。 +DPAPI 密码只供当前 Windows 用户解密;换机需从维护者自己的离线恢复材料还原,并重新加密密码。 +签名文件、密码和恢复材料均不进入 Git、源码归档或发行附件。 + +首次生成的本地恢复副本位于 `%USERPROFILE%/NESLite-private/recovery`,包含密钥副本和恢复密码。 +维护者应将其复制到受保护的离线存储;本机副本不等于异地备份。后续更新继续使用此密钥。 + +## 定版与构建 + +1. 同步应用版本、版本测试、说明和当前发布记录,提交全部源码改动。 +2. 运行 `打包.cmd release -NoPause`。正式构建要求干净工作区,固定四项源码依赖,签名并验证 APK。 +3. 检查 `build/releases/NESLite-<版本>-release.json` 与 `SHA256SUMS`:提交、版本、APK 和源码附件对应。 +4. 将最终提交推送到 `main`,为该提交建立 `v<版本>` 标签并推送。 +5. 在 Gitea 创建对应标签的发行草稿,填写 `docs/releases/<版本>.md` 的说明,上传清单中的附件和校验清单。 + 核对附件后发布。不要上传 `build` 整个目录、游戏 ROM、密钥或历史包。 + +当前站点的 HTTP Git 访问已核对可用;网页公布的 SSH 地址含 localhost,不能直接用于远程推送。 +如以后启用 HTTPS 或配置正确的 SSH 地址,应使用站点确认后的实际地址;凭据由本机 Git 凭据管理器保管。 + +## 从发行源码构建 + +可以克隆仓库并双击 `打包.cmd` 构建调试版,固定依赖由脚本取得。 +也可解压 NESLite 源码包,将四项依赖源码分别解压至 `third_party/sources/` 对应目录,然后按 `docs/build.md` +中的 Java/Wrapper 调用方式执行 `:app:assembleDebug`。该方式使用随包源码,不要求依赖目录带 Git 元数据。 +重新分发改动版时使用自己的签名密钥,不能请求或使用维护者私钥。 + +1.0.0 发布依据为产品负责人的发布确认;历史计划中未归档的设备专项不自动勾选通过。 diff --git a/docs/releases/1.0.0.md b/docs/releases/1.0.0.md new file mode 100644 index 0000000..8608044 --- /dev/null +++ b/docs/releases/1.0.0.md @@ -0,0 +1,33 @@ +# NESLite 1.0.0 + +NESLite 的首个正式版本,面向 Android 9 及以上的 arm64 设备。 + +## 主要功能 + +- 导入单个 NES 文件或扫描文件夹,支持中文名称、搜索、收藏和游戏库管理。 +- 内置 FCEUmm 与 Nestopia,可设置默认内核及逐游戏选择;两个内核独立保存进度。 +- 支持 4:3 显示、原始像素整数缩放、最近邻和线性过滤。 +- 提供横屏触控按键、外接手柄映射、软件连发和快进。 +- 支持电池存档、即时存档、自动恢复点及存档包导入导出。 +- 包含已确认“龙珠英雄”ROM 的 Dendy 制式兼容修复,以及 Nestopia 整数缩放比例修复。 + +## 安装和数据 + +下载 `NESLite-1.0.0-arm64-v8a.apk`,按 Android 提示允许对应来源安装。 +正式包名为 `org.neslite.app`;此前调试包使用 `org.neslite.app.debug`,两个应用可以共存。 +请先从调试版导出存档,在正式版导入相同 ROM 和存档包,确认进度后再处理旧应用。不同内核的存档不能互换。 + +应用不附带游戏 ROM,请自行准备有权使用的文件。当前版本仅提供 arm64-v8a。 + +## 源码与校验 + +发行附件包含签名 APK、SHA-256 清单、NESLite 源码、固定版本的 FCEUmm/Nestopia/Oboe/libretro.h +源码,以及原生调试符号、许可证和依赖清单。构建方法见源码中的 `docs/build.md`。 +正式签名证书 SHA-256: +`767BDF6D6AB140B336EFCF28C5BAAC7A8515F2D760BC568283BAB4537D319191`。 + +## 验证范围 + +产品负责人已确认可发布。本次交付核对正式包身份、签名、arm64 库和 16 KB 静态对齐,并使用局部版本测试。 +历史报告未归档的长稳、跨页大小设备运行和升级专项仍保持“未验证”,不将静态检查替代实机结果。 +兼容性与问题反馈请同时提供应用版本、当前内核、ROM 哈希和具体表现。 diff --git a/docs/reports/core-selection-0.9.16.md b/docs/reports/core-selection-0.9.16.md new file mode 100644 index 0000000..be3fb2d --- /dev/null +++ b/docs/reports/core-selection-0.9.16.md @@ -0,0 +1,72 @@ +# NESLite 0.9.16 双内核开发记录 + +本页保留 0.9.16 当时的证据;后来收到具体 ROM 后的定位与 0.9.17 修复见 +[龙珠英雄兼容记录](long-zhu-ying-xiong-0.9.17.md)。通用构建输出路径可能已被新版本覆盖。 + +日期:2026-09-14。对应 F15/XCORE;应用版本 `0.9.16-debug`、`versionCode 9016`、 +ID `org.neslite.app.debug`、ABI `arm64-v8a`。本次基于提交 +`e3842c21dcd4c00f34a740da86947c93b5b93afb` 的工作区改动构建,尚未创建新的源码提交。 +这是局部开发检查记录,不是 GCORE 或 G8 放行记录。 + +## 已实现行为 + +- 保留 FCEUmm `236ccdfc911e84c60fea6b9d0699c2d440a8de14`,新增 Nestopia + `224713b257c8620513c1c9ca28dc7f8dea711e18`,两个内核均随 APK 提供。 +- 默认 FCEUmm;设置页可改默认,长按游戏可单独指定或跟随默认。选择写入 DataStore,下一次打开 + 游戏生效;同一模拟线程先关闭旧会话再打开新会话。状态页和存档管理展示活动内核。 +- FCEUmm 的原有存档路径不变,Nestopia 使用独立路径;旧包只归 FCEUmm,新包携带内核 ID/提交, + 跨内核包与即时存档拒绝导入。异常恢复计数也按内核分开。 +- 宿主支持 XRGB8888、0RGB1555 转 RGB565,保留 pitch 处理和重复帧;清空缓冲后帧序号继续递增。 +- 修正无电池内存游戏被读档前保护误拒绝的问题:电池大小为零时保护核心状态即可,实际存在电池 + 内存时仍要求完整快照;失败后继续执行回滚。模拟线程在全部成员初始化完成后才启动。 + +## L1 结果 + +构建环境延用 JDK 17.0.17+10、AGP 8.13.2、Gradle 8.13、NDK 28.2.13676358、CMake 3.22.1。 +Windows 本地测试将 Java 临时目录定向到 `.build/java-tmp`;偏好持久化测试使用 DataStore 的 Okio +文件存储以支持 Windows 替换已有文件,并关闭后重开文件验证持久化。Android 生产存储仍使用标准 +`preferencesDataStore`。未更改业务依赖版本。 + +| 检查 | 结果 | 证据/范围 | +| --- | --- | --- | +| arm64 Debug APK | 通过 | `.build/core-selection-build.log`;原生和 Kotlin 编译、链接、打包成功 | +| Kotlin 定向测试 | 6 项通过,0 失败 | CorePreferencesTest 3 项、AppSettingsTest 2 项、BuildIdentityTest 1 项;`app/build/test-results/testDebugUnitTest/` | +| 原生局部测试 | 2 个测试程序通过 | `neslite_core_selection_test`、`neslite_native_smoke_test`;`.build/native-tests/Testing/Temporary/LastTest.log` | +| Nestopia 导出 | 21 个宿主必需入口存在 | APK 解包后检查动态符号表;运行时仍会检查入口和 API 版本 | +| APK 与 ELF 静态对齐 | 通过 | `.build/core-selection-native-audit.json`;全部 3 个原生库 LOAD 段最小对齐 16384,APK 16 KB 对齐合格 | + +局部原生用例覆盖内核 ID、旧路径保留、目录与恢复键隔离、包身份及旧包归属、跨内核状态拒绝、 +像素通道转换和 pitch 边界、清空后帧序号。原有 smoke 用例复核共享的视频和存档封装/提交行为。 +没有将 Android 动态库真正加载、内核运行或无电池游戏的完整读档路径记作自动测试通过。 + +复跑本轮局部检查(工具链配置见构建说明): + +```powershell +.\gradlew.bat :app:assembleDebug :app:testDebugUnitTest --tests org.neslite.app.core.CorePreferencesTest --tests org.neslite.app.settings.AppSettingsTest --tests org.neslite.app.BuildIdentityTest +cmake -S app/src/main/cpp -B .build/native-tests +cmake --build .build/native-tests --config Debug --target neslite_native_smoke_test neslite_core_selection_test +ctest --test-dir .build/native-tests -C Debug -R 'neslite_(native_smoke|core_selection)_test' --output-on-failure +.\tools\check-rc-native.ps1 -ApkPath app/build/outputs/apk/debug/app-debug.apk -OutputPath .build/core-selection-native-audit.json +``` + +仅文档改动无需复跑以上命令;实现修改按 todo.md 的影响映射选取相关项。本轮未执行 Stage 全量本地 +集合、发布 lint、100 次存读档、插拔轮次或 2 小时长稳。 + +## 构建产物 + +`app/build/outputs/apk/debug/app-debug.apk`,24,176,631 字节,调试签名,可覆盖同 ID/同调试签名的旧版。 +SHA-256:`3BBB41F94F64799DEF49D7A087BB36159E07F1BB6D4F67CFE4D77587E9EF9956`。 + +APK 原生库为 `libneslite_jni.so`(含 FCEUmm/Oboe)、`libneslite_nestopia.so`、 +`libdatastore_shared_counter.so`,均为 arm64-v8a;依赖检查仅出现 Android 系统库,无缺失的第三方共享库。 +静态检查通过不能代替 Android 4 KB/16 KB 运行检查。 + +## 未验证项与最短实测路径 + +ADB 未发现已连接设备;未取得用户所说“龙珠英雄”的具体 ROM、SHA-256、Mapper 或黑屏日志。 +该名称不能唯一确定游戏内容,因此不推断 Mapper,也不宣称新增 Nestopia 已解决黑屏。 + +先按 XCORE-04 完成 Android 同进程切换、重启选择记录、独立电池与即时存档的短路径,再按 XCORE-05 +对同一份“龙珠英雄”分别验证两个内核。Nestopia 也可能不兼容该 ROM;双内核都失败时保留诊断继续定位。 +候选冻结时,受影响内核的兼容集、H-AV、H-SAVE、H-NATIVE 按 GCORE/G8 共用证据安排;其余专项仅按 +原发布门槛和证据有效性补齐。实机、长测、签名和发布门槛保持未勾选。 diff --git a/docs/reports/integer-scaling-0.9.18.md b/docs/reports/integer-scaling-0.9.18.md new file mode 100644 index 0000000..f795bb9 --- /dev/null +++ b/docs/reports/integer-scaling-0.9.18.md @@ -0,0 +1,52 @@ +# 原始整数缩放比例修复(0.9.18) + +日期:2026-09-14。对应 F04/M2-03a、M2-03b。本次修复用户截图中 Nestopia 游戏画面横向拉宽的 +问题,完成 L1 局部验证并提供调试 APK;未连接 Android 设备,M2-03b 的 L2 画面复核仍待完成。 + +## 原因与改动 + +固定提交的 Nestopia 默认启用复合视频过滤,视频回调输出为 602×224, +`retro_get_system_av_info` 给出的基础尺寸仍为 256×224。原渲染器直接以纹理宽高计算整数倍率, +把横向扩展的采样宽度当成了 NES 原始像素宽度,因此整幅画面变扁。 + +- 视频缓冲同时保存纹理尺寸和基础尺寸,像素与基础尺寸在同一帧快照内交接;重复帧保留上一完整快照, + 新帧使用当时的基础尺寸,缺失基础尺寸时成对回退为纹理尺寸。 +- GL 仍按纹理实际宽高上传;整数显示改按基础宽高选择最大共同整数倍率并居中。空间不足一倍时, + 等比例缩小以完整显示。4:3 模式继续按 4:3 适配,暂停时切换模式也重新计算显示区域。 +- 沿用内核选项、固定提交、存档配置身份与存档路径;这次只修正前端显示尺寸。 + +在 1664×1248 的显示区域中,Nestopia 旧算法得到 1204×448;修复后为 1280×1120,即 +256×224 的五倍,与同基础尺寸的 FCEUmm 相同。原始整数模式保持基础像素比例,与强制 4:3 显示有区别。 + +## 分级验证 + +| 层级/检查 | 结果与范围 | +| --- | --- | +| L1/显示与缓冲 | `neslite_video_viewport_test` 通过:扩展纹理与基础尺寸分离、共同整数倍率、4:3 切换、区域大小变化、重复帧、缓冲清空与新帧尺寸、缺失基础尺寸、刚好一倍和不足一倍边界 | +| L1/共享缓冲回归 | `neslite_core_selection_test` 通过,保留原有格式转换与跨内核帧序号检查 | +| L1/真实内核尺寸 | 对已有本地“龙珠英雄”样本,两内核各采集 60 帧;FCEUmm 为纹理 256×224/基础 256×224,Nestopia 为纹理 602×224/基础 256×224,生产显示算法均计算出 1280×1120,位置 192,64 | +| L1/应用构建 | 最终 `assembleDebug` 通过;`BuildIdentityTest` 1 项和 `AspectRatioFrameLayoutTest` 3 项通过 | +| L1/最终 APK | 3 个 arm64 原生库的 ELF LOAD 段与 APK 16 KB 对齐检查通过,版本 0.9.18-debug/9018 | +| L2/手机画面 | 待复核;ADB 无已连接设备。桌面探针使用真实内核和生产尺寸算法,不启动 Android/GL,也未运行截图中的 Mario ROM | + +本次没有运行 Stage 全量、全 ROM 遍历、长稳或重新执行历史专项。桌面探针自带的一次核心状态往返 +也返回通过,仅保留在日志中,不作为本次存档验收。尺寸验证使用原样本的字节相同副本,ROM 不进入 APK。 + +日志:`.build/video-viewport-native-0.9.18.log`、`.build/video-viewport-android-0.9.18.log`、 +`.build/video-viewport-final-build-0.9.18.log`、`.build/video-viewport-native-apk-0.9.18.json`; +真实内核尺寸为 `.build/rom-probe/video-fceumm-0.9.18.log` 与 `video-nestopia-0.9.18.log`。 + +局部原生测试可在构建对应目标后用 CTest 的 +`-R '^neslite_(video_viewport|core_selection)_test$'` 选择;真实核心尺寸检查见 +[探针说明](../../tools/rom-probe/README.md),传入 60 帧即可。 + +## 安装包与待复核步骤 + +- APK:`.build/releases/NESLite-0.9.18-debug-arm64-v8a.apk`,与 + `app/build/outputs/apk/debug/app-debug.apk` 字节相同;24,176,631 字节。 +- SHA-256:`015D5C76BC8BF0E25549059DE21704470543D0A7170FB5F5D6C0BC6AEC7964E6`。 +- application ID:`org.neslite.app.debug`;`versionCode = 9018`。当前工作区构建,未创建 Git 提交。 + +安装新版后,用 Nestopia 打开原截图中的游戏,在设置中切换“原始整数缩放”和“保持 4:3”,检查人物、 +文字与场景不再横向拉宽,整数模式保留居中黑边;暂停时再切换一次确认立即生效。FCEUmm 的同类复核 +与 XCORE-04 的切换检查合并完成,不重复跑同一路径;目标手机结果记录后再完成 M2-03b。 diff --git a/docs/reports/long-zhu-ying-xiong-0.9.17.md b/docs/reports/long-zhu-ying-xiong-0.9.17.md new file mode 100644 index 0000000..599025e --- /dev/null +++ b/docs/reports/long-zhu-ying-xiong-0.9.17.md @@ -0,0 +1,78 @@ +# 龙珠英雄黑屏定位与 0.9.17 修复 + +日期:2026-09-14。用户提供了项目根目录的 `龙珠英雄.nes`。本次在两个固定内核中复现 NTSC 启动 +卡死,并加入按精确文件哈希选择 Dendy 的兼容规则;Android 调试 APK 已构建,手机端仍待复核。 +对应计划 F15/XCORE-05,不作为 GCORE 或 G8 的完整放行证据。 + +## 文件与复现结果 + +| 项目 | 实际值 | +| --- | --- | +| 文件大小 | 262,160 字节,等于 16 字节头+256 KiB PRG | +| 完整文件 SHA-256 | `f2fa5c9e40dc68e25fc9d9a4d5f2d5c9179c393d16c0d4e76f843aa17a6df981` | +| PRG CRC32 | `20d4221c` | +| iNES 头 | `4e 45 53 1a 10 00 42 00 00 00 00 00 00 00 00 00` | +| 头部声明 | Mapper 4、256 KiB PRG、无 CHR-ROM、带电池,未正确表达此文件所需的 Dendy 制式 | +| 复现平台 | Windows x64、MinGW GCC 16.1.0;同一 libretro 环境选项默认值与输入脚本 | +| FCEUmm 提交 | `236ccdfc911e84c60fea6b9d0699c2d440a8de14` | +| Nestopia 提交 | `224713b257c8620513c1c9ca28dc7f8dea711e18` | + +原始默认选项下,两个内核都成功返回加载完成,但持续输出单色画面。FCEUmm 的 600 帧检查仅有 +2 次画面变化、非零音频样本计数为 0;Nestopia 为 4 次变化、非零音频计数为 1,并报告 CPU Jam。 +临时 CPU 跟踪在 FCEUmm 第 23 帧观察到中断恢复后从错误的程序存储区取指,在 `$9020` 执行停止指令。 +该复现在桌面直接取得核心视频回调,不经过 Android 或 GL,因而可以确认黑屏已经发生在游戏执行阶段。 + +针对启动时序分别检查 PAL 与 Dendy 后,Dendy 在两个内核均能显示中文启动画面并进入菜单;选择 +Dendy 作为此文件的兼容制式。Dendy 是核心的 CPU/PPU 时序配置,不是修改手机刷新率;NES 2.0 +对该制式有独立定义,见 [NESdev 时序字段](https://www.nesdev.org/wiki/NES_2.0#CPU/PPU_Timing)。 +这里只声明已实测的文件,不按中文文件名、Mapper 4 或所有中文游戏泛化此修复。 + +原始复现日志:`.build/rom-probe/fceumm.log`、`nestopia.log`;临时跟踪记录为 +`.build/rom-probe/fceumm-trace.txt`。跟踪只用于定位,最终检查工具和 APK 使用未修改的上游核心源码。 + +## 应用改动 + +- `rom_compatibility` 在宿主读入 ROM 后用实际字节计算 SHA-256;仅上述完整哈希命中 + `long-zhu-ying-xiong-dendy-v1`,不依赖文件名或 UI 传入的身份字符串。 +- 环境回调注册选项时,FCEUmm 使用 `fceumm_region=Dendy`,Nestopia 使用 + `nestopia_force_system=dendy`。其余选项、其他 ROM 和两个内核提交保持原值。 +- 状态诊断包含 `compatibilityProfile`;卸载时重置,下一款游戏不会继承该规则。 +- 原 ROM 字节及其哈希、游戏索引和电池存档位置保留。实际制式进入现有即时存档配置元数据,因此 + 旧 NTSC 即时存档按原兼容检查拒绝加载且保留文件;本次没有自动删除、改写或迁移用户进度。 +- 新增可选 `tools/rom-probe/` 检查工具,明确传入单份本地 ROM 才运行;本地游戏样本加入 Git 忽略, + 不进入 APK 或应用源码发布包。 + +## 局部验证 + +| 检查 | 结果与边界 | +| --- | --- | +| 兼容规则单测 | `neslite_rom_compatibility_test` 通过;覆盖精确哈希、不同/缺失哈希、两个内核的键名和值、其他选项不受影响 | +| FCEUmm+生产兼容规则 | 1800 帧,约 36 模拟秒;50.007 FPS、91 次画面变化、非零音频计数 1,454,099;一次核心状态往返通过 | +| Nestopia+生产兼容规则 | 1800 帧,约 36 模拟秒;50.007 FPS、92 次画面变化、非零音频计数 1,474,223;一次核心状态往返通过 | +| 画面检查 | 两个内核均看到中文启动、剧情选择和代码输入菜单;固定 Start/A 脚本会改变菜单状态,不再持续黑屏 | +| Android 构建/版本 | `assembleDebug` 通过;BuildIdentityTest 1 项通过,版本 `0.9.17-debug`/9017 | +| 最终 APK 静态原生检查 | 全部 3 个 arm64 库 LOAD 段和 APK 的 16 KB 对齐通过;没有新增共享库依赖 | +| 原文件保护 | 修复后再次计算用户原文件 SHA-256,与输入一致 | + +核心状态往返是在 1800 帧后序列化、运行 30 帧、恢复并再运行相同 30 帧,比较画面哈希;每个内核 +只做一次,不等同于 Android 存档文件、100 次循环、听感或完整玩法验收。两次 30 帧不计入上表的 +1800 帧启动统计。尚未验证 Android 上本次自动规则、完整战斗/通关及长期运行。 + +验证日志:`.build/rom-probe/verified-fceumm.log`、`verified-nestopia.log`、 +`android-build-0.9.17.log`、`android-native-0.9.17.json`;抽样画面为同目录的 +`verified-fceumm-179.png`、`verified-fceumm-599.png`、`verified-nestopia-599.png` 等。 +复跑单 ROM 检查见 [工具说明](../../tools/rom-probe/README.md);规则单测可用 CTest 精确选择 +`^neslite_rom_compatibility_test$`。没有运行 Stage 全量、全库 ROM 遍历、长稳或重复的历史专项。 + +## 交付与手机复核 + +版本:`0.9.17-debug`,`versionCode 9017`,ID `org.neslite.app.debug`,arm64-v8a。 +源码基于 `e3842c21dcd4c00f34a740da86947c93b5b93afb` 及当前工作区改动,未创建新的 Git 提交。 +APK 为 `app/build/outputs/apk/debug/app-debug.apk`,另提供同字节的版本化副本 +`.build/releases/NESLite-0.9.17-debug-arm64-v8a.apk`,大小 24,176,631 字节。 +SHA-256:`3A08617A13F0EBBD058F3F93AA12F6CB5E65FEC8865124771E9960EA020A8540`。 + +安装新版后从游戏列表重新打开原有“龙珠英雄”即可命中规则,无需重新导入或改名。FCEUmm 和 Nestopia +均有对应设置;若用户正在旧版会话中,需重新打开游戏。ADB 当前未发现已授权手机,手机加载、输入、 +声音和完整玩法需继续按 XCORE-04/05 复核;若仍失败,诊断中的应用版本、内核、ROM 哈希及 +`compatibilityProfile` 可用于确认是否实际运行了本次修复。 diff --git a/docs/requirements.md b/docs/requirements.md index 9a66716..e7ccc1c 100644 --- a/docs/requirements.md +++ b/docs/requirements.md @@ -2,7 +2,7 @@ 本表将设计需求映射到唯一的实现和验收位置,不把规划当成已完成结果。 -## F01~F14 映射 +## F01~F15 映射 | 需求 | 功能摘要 | 实现位置 | 功能门槛 | | --- | --- | --- | --- | @@ -20,6 +20,7 @@ | F12 | 虚拟按键 | M6-04 | G6 | | F13 | 设备与运行诊断 | M1、M3、M7 | G7 | | F14 | 原生兼容和交付 | M0、M8、M9 | G8/G9 | +| F15 | 内置内核默认选择、逐游戏覆盖和存档隔离(2026-09-14 用户增补) | XCORE-01~XCORE-05,计划第 11 节 | GCORE/G8 | ## 设备待测参数 diff --git a/docs/save-format.md b/docs/save-format.md index 984dadc..a70c5a9 100644 --- a/docs/save-format.md +++ b/docs/save-format.md @@ -4,6 +4,12 @@ M5 固定两种二进制格式:即时存档 `.nls`(魔数 `NESLST01`)和 `NESLPK01`)。所有多字节整数均为无符号小端;时间为 Unix epoch 毫秒。格式解析先检查固定头、版本、 长度上限和精确总长,再分配载荷。 +## 内核与目录 + +FCEUmm 延用 `files/saves//`,既有存档无需迁移;Nestopia 使用 +`files/saves/cores/nestopia//`。下文的相对目录均位于当前内核、当前 ROM 的根目录下。 +电池存档、即时存档、恢复副本和异常会话标记均隔离;不自动复制或转换另一内核的数据。 + ## 即时存档 `.nls` 固定头依次包含格式版本、ROM 哈希/内核名/内核提交/配置文本的长度,缩略图宽、高、行距和 @@ -11,25 +17,33 @@ M5 固定两种二进制格式:即时存档 `.nls`(魔数 `NESLST01`)和 四段 UTF-8 元数据、核心状态和与该状态在同一帧边界取得的原始缩略图。 - 状态最大 64 MiB,缩略图最大 2 MiB,单段文本最大 16 KiB。 -- 读档必须匹配完整 ROM SHA-256、`FCEUmm`、固定内核提交和当前核心配置;不同内核提交默认拒绝, +- 读档必须匹配完整 ROM SHA-256、当前内核名称(`FCEUmm` 或 `Nestopia`)、固定提交和当前核心配置;不匹配则拒绝, 原文件不改名、不删除。 +- 0.9.17 的已知 ROM 制式兼容规则体现在核心配置元数据中;旧 NTSC 会话的即时存档不会自动读入 + Dendy 会话。电池文件、ROM 哈希和各内核的目录保留,不通过修改 ROM 内容或删除旧档来处理黑屏。 - 手动槽为 `states/slot-0.nls` 至 `slot-9.nls`;自动恢复点为 `auto/auto-0.nls` 至 `auto-2.nls`,仅在新文件提交成功后推进轮换。 ## 独立存档包 `.nsp` 包头保存格式版本、64 字节 ROM SHA-256 和条目数。每项保存相对路径长度、数据长度、64 字节数据 -SHA-256、路径和数据。只允许 `battery/battery.sav`、十个手动槽和三个自动槽;拒绝绝对路径、父目录、 +SHA-256、路径和数据。只允许 `core.txt`、`battery/battery.sav`、十个手动槽和三个自动槽;拒绝绝对路径、父目录、 重复路径及任何未列入白名单的名称。单项上限 64 MiB,总数据上限 128 MiB,最多 16 项。包不包含 ROM、 会话标记或读档前保护副本。 +0.9.16 起导出的包增加 `core.txt`,内容为 UTF-8 的 `内核 ID\n完整提交\n`,ID 为 `fceumm` 或 +`nestopia`。导入时先与当前内核精确匹配,再校验全部存档条目,最后写入;标识本身不落入存档目录。 +缺少标识的旧包仅允许在 FCEUmm 下导入,仍检查每个即时存档的内核元数据。新包不能导入尚不识别 +`core.txt` 的旧版应用。封装魔数及版本仍为 v1,仅扩充条目白名单;不支持跨内核存档包迁移。 + ## 提交、备份与恢复 所有文件使用同一安全提交器:不可变快照在文件线程写入目标同目录的带版本临时文件,刷新到存储后 逐字节回读校验;已有目标先以同样流程生成 `.bak`,再原子替换正式文件并同步目录。提交器按 ROM/ 目标串行,并拒绝不大于已接收版本的旧任务。替换前失败会清除临时文件,正式文件和有效备份不变。 -读档只允许在暂停态的核心线程执行。反序列化前把当前核心状态和电池内存提交到 `recovery/`;失败先 +读档只允许在暂停态的核心线程执行。反序列化前把当前核心状态和电池内存提交到 `recovery/`;内核明确 +报告电池内存大小为零时只备份核心状态,有电池内存却无法取得完整快照时拒绝读档。失败先 恢复内存快照,回滚也失败则重新载入当前 ROM 并恢复保护的电池内存,无法确定核心状态时进入 Error, 不可继续运行。成功或回滚后均清空旧音视频并重建时钟基线。 diff --git a/docs/toolchain.md b/docs/toolchain.md index 66f8a92..d1e1c80 100644 --- a/docs/toolchain.md +++ b/docs/toolchain.md @@ -7,8 +7,8 @@ | 项目 | 锁定版本 | 本机位置/状态 | 说明 | | --- | --- | --- | --- | -| PowerShell | 7.6.6 | 系统默认 `pwsh` | 仅用于运行构建入口;不影响 APK 字节码或原生 ABI。 | -| JDK | Temurin 17.0.17+10 | `E:\\Codex\\NESLite\\.toolchains\\jdk-17.0.17+10` | 供 Gradle/AGP 使用;系统默认 JDK 21 不用于本工程。 | +| PowerShell | 7.6.6 | 系统默认 `pwsh` | 用于运行打包.cmd;不影响 APK 字节码或原生 ABI。 | +| JDK | Temurin 17.0.17+10 | `E:\\Codex\\NESLite\\build\\toolchains\\jdk-17.0.17+10` | 供 Gradle/AGP 使用;系统默认 JDK 21 不用于本工程。 | | Android SDK Platform | 36.1 | `C:\\Users\\shenw_o246oq4\\AppData\\Local\\Android\\Sdk\\platforms\\android-36.1` | `compileSdk = 36`,AGP 8.13 可支持 API 36.1。 | | Android Build Tools | 36.1.0 | `C:\\Users\\shenw_o246oq4\\AppData\\Local\\Android\\Sdk\\build-tools\\36.1.0` | 由 AGP 选择,不固定使用系统 `37.0.0`。 | | NDK | 28.2.13676358 (r28c) | `C:\\Users\\shenw_o246oq4\\AppData\\Local\\Android\\Sdk\\ndk\\28.2.13676358` | `app/build.gradle.kts` 中锁定。 | diff --git a/docs/usage.md b/docs/usage.md index e9ab200..6c1e1a8 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -10,18 +10,20 @@ 相同内容不会重复。可按名称/哈希搜索、收藏或从列表隐藏。隐藏不删除 ROM 和存档,重新导入相同 内容会恢复关联。 3. 点左上角“列表”图标,在两列或三列网格中点游戏名;加载完成后会自动开始。游戏名可完整换行显示, - 长按游戏名可查看详情、收藏或从列表移除。连接外接手柄后仍可按设置选择是否显示 + 长按游戏名可查看详情、收藏、从列表移除或选择内核。连接外接手柄后仍可按设置选择是否显示 屏幕按键。多点触控支持方向与动作同时按住,滑出、取消、失焦或暂停都会释放输入。 4. 点左上角“设置”图标,在画面与声音、方向与触控、手柄与辅助三个卡片中调整选项,可切换 4:3/整数缩放、最近邻/线性过滤、音量、静音、软件连发和 RB 快进。进入 “手动设置手柄按键、摇杆与功能键”后,可启动逐项向导,也可单独点击动作修改或清除;按下物理键 或推动轴完成捕获,检查无误后点“保存”。冲突会要求确认,设置按设备特征在重启和重连后恢复。 “屏幕方向键与手柄摇杆”可切换四方向/八方向,并循环选择标准、大、特大方向键;两个位置滑块可 调整方向键的水平和垂直位置。默认八方向与大号,A、B 支持两根手指同时按住。 + “原始整数缩放”按游戏原始宽高使用同一个整数倍率并居中,保留黑边;空间不足一倍时等比例缩小。 + 它与“保持 4:3”是两种显示方式,原始模式不强制铺满中央区域。0.9.18 已修正 Nestopia 在此模式下横向拉宽的问题。 5. 游戏中点右侧“暂停”或按手柄右摇杆进入暂停菜单;“重置”需要持续按住约 650 ms,滑出会取消。 “存档管理”显示十个手动槽、三个自动恢复点、 提交时间和缩略图。只有原生层确认安全落盘后才显示保存成功。 6. 存档包通过 Android 系统文件选择器导入导出,默认不含 ROM。导入前先加载对应游戏并暂停;哈希、 - 内核提交、配置、路径、大小或校验不匹配会被拒绝并保留现有有效存档。 + 内核名称/提交、配置、路径、大小或校验不匹配会被拒绝并保留现有有效存档。 7. 用“退出游戏”正常结束。上次进程异常终止时,再次加载相同游戏只列出校验有效的自动恢复点, 不会自动运行或覆盖当前进度;同一游戏和恢复点连续异常两次后会返回列表并阻止重复启动,只有 明确点“手动重试”才再次加载。 @@ -30,5 +32,17 @@ 9. 切到后台、锁屏、来电/通知失去音频焦点时,应用会清输入、静音并请求暂停保存;回到前台后保持 暂停,由你手动继续。诊断导出会附带限额系统日志和各显示模式的短时运行样本,不包含 ROM。 +## 选择 NES 内核 + +- 设置页底部的“默认 NES 内核”可选择 FCEUmm 或 Nestopia;初始默认仍为 FCEUmm。 +- 单个游戏黑屏或无法加载时,在游戏列表长按名称,点“选择内核”,选择另一个内核并保存,然后重新 + 点开游戏。也可选“跟随默认”取消这个游戏的单独设置。选择会在重启应用后保留。 +- 修改选择只影响下次打开游戏;正在运行或暂停的会话继续使用原内核。每个内核分别保存电池进度、 + 十个手动槽和三个自动恢复点;切回原内核可继续使用它原有的存档。存档管理标题显示当前内核。 +- 0.9.17 对已确认内容的“龙珠英雄”(SHA-256 以 `f2fa5c9e40dc` 开头,精确匹配完整哈希)在两个 + 内核下自动使用 Dendy 制式,无需修改原 ROM 或再次更换内核。其他同名文件不自动套用此规则。 + 该文件已在桌面内核检查中进入中文启动及剧情选择页面,手机端仍待复核;如仍黑屏,请提供应用 + 版本、当前内核和导出的诊断信息。 + 荣耀 Magic8 截图已确认 Android 16、arm64-v8a、120 Hz 显示和 GameSir X5 Lite 枚举正常;新版三栏 布局、实际按键事件、系统手势、文件提供器、生命周期和完整游戏流程仍需在手机上复核。 diff --git a/gradle.properties b/gradle.properties index f90a875..502af39 100644 --- a/gradle.properties +++ b/gradle.properties @@ -2,3 +2,5 @@ org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8 org.gradle.parallel=true android.useAndroidX=true kotlin.code.style=official +kotlin.project.persistent.dir=build/cache/kotlin +kotlin.project.persistent.dir.gradle.disableWrite=true diff --git a/gradlew b/gradlew deleted file mode 100644 index 40ef530..0000000 --- a/gradlew +++ /dev/null @@ -1,41 +0,0 @@ -#!/bin/sh -# -# Copyright © 2015 the original authors. -# -# 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 -# -# https://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. -# - -APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit -APP_NAME="Gradle" -DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' - -CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar - -if [ -n "$JAVA_HOME" ] ; then - JAVACMD=$JAVA_HOME/bin/java -else - JAVACMD=java -fi - -if [ ! -x "$JAVACMD" ] ; then - echo "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH." >&2 - exit 1 -fi - -set -- \ - "-Dorg.gradle.appname=$APP_NAME" \ - -classpath "$CLASSPATH" \ - org.gradle.wrapper.GradleWrapperMain \ - "$@" - -exec "$JAVACMD" $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "$@" diff --git a/gradlew.bat b/gradlew.bat deleted file mode 100644 index 88136ef..0000000 --- a/gradlew.bat +++ /dev/null @@ -1,86 +0,0 @@ -@rem -@rem Copyright 2015 the original authors. -@rem -@rem Licensed under the Apache License, Version 2.0 (the "License"); -@rem you may not use this file except in compliance with the License. -@rem You may obtain a copy of the License at -@rem -@rem https://www.apache.org/licenses/LICENSE-2.0 -@rem -@rem Unless required by applicable law or agreed to in writing, software -@rem distributed under the License is distributed on an "AS IS" BASIS, -@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -@rem See the License for the specific language governing permissions and -@rem limitations under the License. -@rem - -@if "%DEBUG%"=="" @echo off -@rem ########################################################################## - -@rem Set local scope for the variables with windows NT shell -if "%OS%"=="Windows_NT" setlocal - -set DIRNAME=%~dp0 -if "%DIRNAME%"=="" set DIRNAME=. -@rem This is normally unused -set APP_BASE_NAME=%~n0 -set APP_HOME=%DIRNAME% - -@rem Resolve any ".." in APP_HOME to make it shorter. -for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi - -@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" - -@rem Find java.exe -if defined JAVA_HOME goto findJavaFromJavaHome - -set JAVA_EXE=java.exe -%JAVA_EXE% -version >NUL 2>&1 -if %ERRORLEVEL% equ 0 goto execute - -echo. 1>&2 -echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 -echo. 1>&2 -echo Please set the JAVA_HOME variable in your environment to match the 1>&2 -echo location of your Java installation. 1>&2 - -goto fail - -:findJavaFromJavaHome -set JAVA_HOME=%JAVA_HOME:"=% -set JAVA_EXE=%JAVA_HOME%/bin/java.exe - -if exist "%JAVA_EXE%" goto execute - -echo. 1>&2 -echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 -echo. 1>&2 -echo Please set the JAVA_HOME variable in your environment to match the 1>&2 -echo location of your Java installation. 1>&2 - -goto fail - -:execute -@rem Setup the command line - -set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar - -@rem Execute Gradle -"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* - -:end -@rem End local scope for the variables with windows NT shell -if %ERRORLEVEL% equ 0 goto mainEnd - -:fail -rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of the _cmd.exe /c_ return code! -set EXIT_CODE=%ERRORLEVEL% -if %EXIT_CODE% equ 0 set EXIT_CODE=1 -if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% -exit /b %EXIT_CODE% - -:mainEnd -if "%OS%"=="Windows_NT" endlocal - -:omega diff --git a/settings.gradle.kts b/settings.gradle.kts index 66bce63..f1302f2 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -15,4 +15,5 @@ dependencyResolutionManagement { } rootProject.name = "NESLite" +gradle.startParameter.projectCacheDir = file("build/cache/gradle") include(":app") diff --git a/third_party/manifest.json b/third_party/manifest.json index b1cf031..9c21bdc 100644 --- a/third_party/manifest.json +++ b/third_party/manifest.json @@ -1,7 +1,16 @@ { "format": 1, - "updated": "2026-09-12", + "updated": "2026-09-14", "sources": [ + { + "name": "Nestopia libretro core", + "directory": "nestopia", + "url": "https://github.com/libretro/nestopia.git", + "commit": "224713b257c8620513c1c9ca28dc7f8dea711e18", + "license": "GPL-2.0-or-later AND LGPL-2.1-or-later", + "purpose": "Optional bundled NES core selected per game or as the default", + "patches": [] + }, { "name": "FCEUmm libretro core", "directory": "libretro-fceumm", diff --git a/todo.md b/todo.md index b70325c..ff906e7 100644 --- a/todo.md +++ b/todo.md @@ -1,6 +1,6 @@ # NESLite V1.0 待办事项 -依据:[开发计划 V1.0](docs/development_plan_V1.0.md)。编制日期:2026-09-12。所有开发任务初始状态为未开始,本文不表示任何工程或实机验收已经完成。 +依据:[开发计划 V1.0](docs/development_plan_V1.0.md)。编制日期:2026-09-12;修订日期:2026-09-14。进度以条目和证据为准;本次增加 F15/XCORE,局部实现通过不等于实机或发布验收通过。 ## 1. 执行与勾选规则 @@ -10,7 +10,7 @@ 4. **完成实现项不等于阶段通过。** 实现、对应局部验收及必要文档更新完成后才能勾选实现项;阶段 G 项还需满足明确的集成/实机门槛。设备缺失时保留 G 项未勾选,不能以编译成功或模拟输入替代真实手柄验收。 5. **等待不阻止独立工作。** 前置未通过时,只能推进不依赖其结果的草稿或隔离实现;不能提交依赖未知接口的完成结论,也不能勾选依赖阶段的门槛。 6. **状态与证据只记一次。** 未勾选项默认“未开始”;进行中、待实机或失败时在条目末附状态和原因。通过后附源码提交及报告位置;阶段报告引用这些记录,不复制同一测试。尚未建立的文档路径是交付目标。 -7. **范围和参数不暗改。** 保留计划的 F01~F14、M0~M9 及 0.1.x~1.0.0 路线。新需求另列后续版本;快进倍率、存档周期等计划允许校准的参数,在指定阶段形成记录并同步两份文档。 +7. **范围和参数不暗改。** 保留 M0~M9 路线;用户新增内置内核选择已在计划第 11 节登记为 F15/XCORE,发布覆盖扩为 F01~F15。其他新需求先明确版本和边界;参数校准同步两份文档。 8. **未定参数也有明确交付要求。** 计划未给数值的 ROM/存档包大小上限、轴阈值、连发频率、缓冲/日志容量,由对应实现项确定并记录数值、单位、默认值及超限行为;配置、文档和验收一致后才算完成,不用“适当”“合理”等词代替实际参数。 ## 2. 分级验收与重跑规则 @@ -25,7 +25,7 @@ | L1 局部验证 | 单一逻辑、构建配置、解析器或映射规则 | 受影响目标的编译/静态检查;用最少的正常和必要边界用例验证本项行为 | 全部单元测试、整应用实机流程、耐久测试 | | L2 模块集成 | JNI、设备、文件系统、UI 或两个模块交接 | 受影响模块及直接相邻接口;一个代表样本的正常流程,加本次涉及的失败/取消分支 | 全 ROM 集、30 分钟运行、100 次存读档、20 轮循环 | | L3 阶段验收 | G1~G7 的阶段出口;G0 为构建基线检查 | 本阶段新增能力的连贯路径,以及分配到该阶段的专项指标 | 其他已通过阶段的全部测试、发布全量回归 | -| L4 发布验收 | M8 的候选发布版与 G8 | 核对 F01~F14,执行冻结的兼容集和候选包关键流程,补齐缺失/失效的专项证据 | 不分影响地重复所有历史用例、设备和长测 | +| L4 发布验收 | M8 的候选发布版与 G8 | 核对 F01~F15,执行冻结的兼容集和候选包关键流程,补齐缺失/失效的专项证据 | 不分影响地重复所有历史用例、设备和长测 | 纯文案或排版改动用 L0;布局和焦点改动用对应页面的 L2;不为低影响改动编写仅重复实现的测试。新增或修复有状态逻辑时优先增加可复现行为测试,避免每个页面各写一套相同底层测试。 @@ -41,7 +41,7 @@ | 音频缓冲、重采样、时钟、快进 | 音频/时钟 L1+切换 L2 | 时钟或持续流行为变更,重跑完整 H-AV 及对应模式切换;不自动重跑游戏库或存档包测试 | | 存档格式、提交/备份/恢复、序列化逻辑 | 存档 L1+集成 L2 | 重跑完整 H-SAVE;触及升级兼容时补 H-UPGRADE;槽位文案改动不触发 100 次循环 | | 生命周期、Surface/音频重建、异步退出 | 受影响转换的 L2 | 改变后台/锁屏恢复时重跑 H-LIFE;改变资源释放或产生内存疑点时重跑 H-LONG | -| FCEUmm 提交、内核编译选项、libretro 宿主行为 | 内核对应完整集:冻结 ROM 集、H-AV、H-SAVE 和内核控制路径 | 改动涉及原生打包则补 H-NATIVE;影响无法界定时进入 L4 | +| 内核提交、内核编译选项、libretro 宿主行为 | 开发时 L1 局部检查+L2 受影响链路;冻结时补受影响内核的冻结 ROM 集、H-AV、H-SAVE 和控制路径 | 原生打包补 H-NATIVE;L3/L4 汇总对应证据,不对每次修改重复完整集 | | 工具链、ABI、链接/原生依赖、APK 打包 | 受影响构建+H-NATIVE+实际包短路径 | 若改变运行库/优化行为,补受影响音频、状态或长时指标;仅重新签名不自动重跑 2 小时测试 | | RC 后缺陷修复 | 复现用例、受影响模块及实际新包短路径 | 多模块影响无法界定或出现广泛回归时重跑 L4 | @@ -73,7 +73,7 @@ H-SAVE 的故障注入按不同失败路径选择代表样本;共用同一提 | 主题 | 固定约定 | | --- | --- | | 工程 | NESLite;单 `app`、Kotlin+原生 View;minSdk 28,compileSdk/targetSdk 36;AGP 8.13.2、Gradle 8.13、JDK 17;NDK r28 起选精确版本;发布 arm64-v8a | -| 内核与线程 | 固定 FCEUmm;单 ROM、单实例、玩家一;改变内核状态的操作全部在模拟线程;音频回调不执行内核或阻塞 I/O | +| 内核与线程 | 固定提交的内置 FCEUmm/Nestopia,默认 FCEUmm;每次仅一个 ROM、一个活动内核实例、玩家一;内核操作全部在模拟线程;选择修改下次加载生效 | | 导入与身份 | 只导入 `.nes`;识别 iNES/NES 2.0;完整文件字节 SHA-256 作为身份;内部正式 ROM 位于 files 而非 cache | | 显示与时钟 | 默认 4:3、最近邻;原始像素整数缩放独立;模拟速度读取内核时序,与手机刷新率解耦 | | 快进 | M3 引擎支持、M4 绑定 RB、M6 提供设置;初始按住 2 倍且静音,松开/失焦/暂停/断柄取消;最终倍率在 G3 冻结 | @@ -82,7 +82,7 @@ H-SAVE 的故障注入按不同失败路径选择代表样本;共用同一提 | 存档规则 | 手动 10 槽、自动最近 3 份;变化电池存档初始每 10 秒提交、自动恢复点初始每 60 秒生成,M5 按实测冻结;暂停/退出补充提交;成功落盘才显示保存成功 | | 读档与恢复 | 读档先备份当前状态及游戏存档;失败回滚,回滚失败安全重载;不同内核提交默认不自动读入;回前台/重连后由用户继续 | | 游戏库 | M2 最小列表、M4 焦点导航、M6 完整列表;从列表移除只隐藏并保留存档,再导入同哈希恢复关联 | -| 后台与范围 | 后台不继续模拟;V1.0 不含联网、云存档、FDS、第二手柄完整体验、回溯、run-ahead 或切换内核;不增加商店上架工作 | +| 后台与范围 | 后台不继续模拟;V1.0 不含联网、云存档、FDS、第二手柄完整体验、回溯、run-ahead 或外部内核下载/导入;内置选择按 F15;不增加商店上架工作 | ## 4. 实现待办与阶段门槛 @@ -93,13 +93,13 @@ G1~G8 的共同交付物为对应阶段 APK、源码提交、构建说明、 ### M0:工程准备 - [x] **M0-02a 锁定本机构建环境**。前置:无。完成:核对 JDK/SDK/NDK/CMake,记录精确版本、安装位置和缺口;形成工具链及应用依赖版本清单。验收:L1,工具可调用且版本符合计划,清单无动态版本。证据:`docs/toolchain.md`、`docs/reports/m0-baseline.md`;Gradle 构建和原生链均已实际调用。 -- [x] **M0-01a 建立可构建的应用骨架**。前置:M0-02a。完成:初始化 Git、Wrapper、单 app、Kotlin/View 页面、CMake 和 JNI 空入口,将锁定版本写入工程配置,生成 arm64 调试 APK。验收:L1,目标构建成功且 APK 包含预期原生库。证据:`app/build/outputs/apk/debug/app-debug.apk`;确认包含 `lib/arm64-v8a/libneslite_jni.so`。 +- [x] **M0-01a 建立可构建的应用骨架**。前置:M0-02a。完成:初始化 Git、Wrapper、单 app、Kotlin/View 页面、CMake 和 JNI 空入口,将锁定版本写入工程配置,生成 arm64 调试 APK。验收:L1,目标构建成功且 APK 包含预期原生库。证据:现行产物为 `build/app/outputs/apk/debug/app-debug.apk`;确认包含 `lib/arm64-v8a/libneslite_jni.so`。 - [x] **M0-01b 固定应用与数据身份**。前置:M0-01a。完成:确定显示名、applicationId、版本号/versionCode 规则、长期测试与发布签名延续策略;在需求文档登记数据目录约定。验收:L0+受影响配置的 L1,构建配置与记录相符。证据:`docs/identity.md`;APK 为 `org.neslite.app.debug`、`0.0.1-dev-debug`、min/target SDK 28/36。 - [x] **M0-03a 固定上游来源**。前置:M0-01a。完成:登记 FCEUmm 完整提交、libretro 头文件及 Oboe 固定版本,建立依赖获取方式和本地补丁清单。验收:L1,按记录可取得对应源码;此项不要求内核已编译。证据:`third_party/manifest.json`;三个固定提交已由 `tools/fetch-third-party.ps1` 检出。 - [x] **M0-03b 建立许可证清单**。前置:M0-03a。完成:逐项记录依赖来源、版本、许可证和待交付材料,建立 LICENSE/THIRD_PARTY_NOTICES 基线。验收:L0,已引入依赖无遗漏、记录与选定源码一致。证据:`LICENSE`、`THIRD_PARTY_NOTICES.md`、`docs/dependencies.md`。 - [x] **M0-02b 编写可复现构建说明**。前置:M0-01b、M0-03a。完成:docs/build.md 记录从检出到 APK 的步骤、精确工具版本、ABI 和依赖获取;不依赖手工复制未知库。验收:L0;干净检出实际构建统一放在 G0,不在此重复。证据:`docs/build.md`;调试 APK 已构建。 - [x] **M0-04a 建立需求与验收资源表**。前置:M0-01b。完成:docs/requirements.md 映射 F01~F14;列出设备待测参数和 ROM 来源/哈希/区域/Mapper/存档类型;登记 M2 至少 3 个样本的获取安排,其中一个有电池存档。验收:L0,已取得样本有使用依据,未齐资源列明缺口和取得办法,G2 前须齐备。证据:`docs/requirements.md`、`docs/reports/rom-inventory.md`。 -- [x] **M0-04b 建立按范围执行的检查入口**。前置:M0-01a、M0-04a。完成:本地入口可选择构建、局部测试、模块集成和阶段检查;原生测试接入可运行目标;docs/acceptance.md 和报告模板使用 L/H 编号。验收:L1,执行一个最小目标可获得结果,默认命令不启动全部耐久测试。证据:`tools/check.ps1`;固定 CTest 的原生 smoke target 通过。 +- [x] **M0-04b 建立按范围执行的检查入口**。前置:M0-01a、M0-04a。完成:APK 构建统一用 `打包.cmd`;局部测试精确选择 Gradle 测试类/CTest 目标,模块和阶段验收汇总有效证据;docs/acceptance.md 和报告模板使用 L/H 编号。验收:L1,执行一个最小目标可获得结果,默认打包不启动测试。证据:现行命令见 `docs/build.md`;旧 smoke 结果保留在 M0 历史报告。 - [x] **G0 工程门槛**。前置:本阶段全部实现项。验收:L3 构建基线;从干净检出按说明构建调试 APK 一次,核对依赖可追溯、无未知库;记录资源缺口与取得办法。此处不要求产品级界面或实机运行报告。证据:提交 `8fde6e1c8854930298135ab1ba3199ecc54e89d7` 的干净克隆执行 `tools/check.ps1 -Scope Stage`,APK 构建、原生 smoke 与 Kotlin 单测全部通过;详见 `docs/reports/m0-baseline.md`。 @@ -129,8 +129,8 @@ ROM 样本,因此所有需要 L2/L3 的 M2 项和 G2 继续保持未勾选, - [ ] **M2-02a 实现 ROM 流式导入**。前置:M2-04a。完成:SAF 读取、大小上限、iNES/NES 2.0 头校验、内部临时副本和完整文件 SHA-256;取消/读取失败清理临时文件。验收:L1+SAF 的 L2,正常头、损坏头、中文文件名和取消覆盖不同路径。 - [ ] **M2-02b 提交内部文件与最小游戏索引**。前置:M2-02a。完成:正式 ROM 存在 files,Room 以哈希关联;重复内容去重、同名不同内容分开;最小列表能选择加载。验收:L2,两种重复场景不串档,content URI 不被当作原生路径。 - [ ] **M2-02c 恢复导入中断的不一致数据**。前置:M2-02b。完成:启动时核对临时/未登记文件和缺失文件记录,提供恢复或明确失败状态,不误删有效数据。验收:L2,在文件提交后数据库登记前中断、正式文件缺失各注入一次。 -- [ ] **M2-03a 实现原生视频缓冲交接**。前置:M2-01c。完成:处理协商像素格式、宽高、pitch、重复帧和有界缓冲所有权,不保存失效指针。验收:L1,选择覆盖非紧密行跨度、重复帧和缓冲切换的最小输入集。 -- [ ] **M2-03b 显示保持比例的游戏画面**。前置:M2-03a。完成:GL 线程显示最新完整帧,默认 4:3/最近邻,支持原始像素整数缩放;丢显示帧不跳模拟帧。验收:L2,一个样本切换两种缩放,比例和缓冲复用正确。 +- [ ] **M2-03a 实现原生视频缓冲交接**。前置:M2-01c。完成:处理协商像素格式、纹理宽高、内核基础尺寸、pitch、重复帧和有界缓冲所有权,不保存失效指针。验收:L1,选择覆盖非紧密行跨度、重复帧和缓冲切换的最小输入集。补充证据:0.9.18 的基础尺寸随帧交接/切换局部用例通过,见显示修复记录;不代替本条其余要求。 +- [ ] **M2-03b 显示保持比例的游戏画面**。前置:M2-03a。完成:GL 线程显示最新完整帧,默认 4:3/最近邻;整数模式按内核基础尺寸使用最大共同整数倍率并居中,空间不足一倍时等比例缩小;丢显示帧不跳模拟帧。验收:L2,两个内核各用一个样本切换两种缩放,包含 Nestopia 扩展纹理,比例和缓冲复用正确;与 XCORE-04 共用对应操作证据。状态:0.9.18 尺寸算法及两内核桌面短检查通过,手机画面待复核,见 [显示修复记录](docs/reports/integer-scaling-0.9.18.md)。 - [ ] **M2-04b 将基础手柄快照送入内核**。前置:M2-01c、M2-03b。完成:使用 M1 实测键码映射方向、A/B、Start/Select,按状态采样,跨 JNI 不逐帧搬图像。验收:L2,代表游戏可组合操作且松开生效;自定义映射留给 M4。 - [ ] **M2-04c 接通控制命令和基础生命周期**。前置:M2-04b、M2-02b。完成:UI 通过队列启动/暂停/继续/重置/退出;后台、锁屏、失焦、断柄及 Surface 丢失暂停清理;重建只重接会话;前台资源就绪后由用户继续。验收:L2,正常控制流程和相关状态转换各覆盖一次,不做 20 轮循环。 - [ ] **M2-04d 读取并提交基础电池存档**。前置:M2-04c。完成:按 ROM 哈希读取保存内存,在模拟线程取快照、文件线程写入;暂停/正常退出提交;成功写入后报告成功。验收:L2,一个电池存档样本退出再载入保留进度,另一个 ROM 不共享文件;不声明 M5 的完整故障保证。 @@ -218,7 +218,7 @@ descriptor 和事件实测;G1~G3 尚未通过且无目标手机/ROM,因此 ### M8/0.9.x:候选发布与覆盖核对 -- [ ] **M8-01a 冻结候选版和验收集合**。前置:无。完成:固定功能、源码、内核、依赖和配置;建立 F01~F14 到有效证据的索引,列出需重跑项目;冻结至少 12 个有权使用的代表样本,覆盖计划指定 Mapper/区域/文件头/电池存档维度。验收:L0,记录完整且不移除失败样本规避门槛。 +- [ ] **M8-01a 冻结候选版和验收集合**。前置:无。完成:固定功能、源码、内核、依赖和配置;建立 F01~F15 到有效证据的索引,列出需重跑项目;冻结至少 12 个有权使用的代表样本,覆盖计划指定 Mapper/区域/文件头/电池存档维度。验收:L0,记录完整且不移除失败样本规避门槛。 - [ ] **M8-01b 执行 RC 兼容集与关键路径**。前置:M8-01a。完成:在候选包运行冻结样本的预定步骤/自检,覆盖输入、音频、暂停、保存恢复、退出等产品主链;H-SAVE/H-HOT/H-LIFE 仅补 M8-01a 标记失效或缺失的项目。验收:L4 的兼容/功能部分,结果可定位到 ROM 和版本,不对每个 ROM 重复全部专项矩阵。 - [ ] **M8-02a 完成长时稳定性验收**。前置:M8-01a。完成:执行 H-LONG 并分析崩溃、ANR、内存趋势;已有满足同样口径且仍有效的记录可引用。验收:L4 的 H-LONG;如需补 H-AV,可选满足区域要求的同一会话合并采集。 - [ ] **M8-02b 完成软件输入延迟验收**。前置:M8-01a。完成:执行 H-INPUT,记录时间域、样本来源、P95 与帧时长;汇总速度/音频统计的有效性。验收:L4 的 H-INPUT 及 H-AV 证据核对,只补失效或缺失部分。 @@ -227,7 +227,7 @@ descriptor 和事件实测;G1~G3 尚未通过且无目标手机/ROM,因此 - [ ] **M8-04a 验证新安装与覆盖升级**。前置:M8-01a。完成:执行 H-UPGRADE,核对 Room/设置迁移和存档兼容;保留至少一个可复用旧版本数据集。验收:L4 的 H-UPGRADE,签名/ID/版本记录与实际包一致。 - [ ] **M8-04b 准备候选交付材料**。前置:M8-01b、M8-02a、M8-02b、M8-03b、M8-04a。完成:整理对应源码、依赖/补丁、许可证、原生符号、构建及使用说明、报告和已知问题;引用前述任务汇总后的有效专项结果。验收:L0,材料版本和测试证据一致,不在材料整理项中重跑测试。 -- [ ] **G8 发布候选门槛**。前置:本阶段全部实现项。验收:L4 汇总;F01~F14、全部 H 项、环境和发布材料均有有效结果,无阻断/高优先级缺陷,其他问题逐项记录处理结论。门槛只审查并合并证据,不再启动第二轮相同全量测试;有修复时按第 2 节确定重跑范围。 +- [ ] **G8 发布候选门槛**。前置:本阶段全部实现项及 GCORE。验收:L4 汇总;F01~F15、全部 H 项、环境和发布材料均有有效结果,无阻断/高优先级缺陷,其他问题逐项记录处理结论。门槛只审查并合并证据,不再启动第二轮相同全量测试;有修复时按第 2 节确定重跑范围。 ### M9/1.0.0:正式交付 @@ -260,5 +260,18 @@ descriptor 和事件实测;G1~G3 尚未通过且无目标手机/ROM,因此 | F12 虚拟按键 | M6-04a~M6-04b | G6 | | F13 诊断 | M1、M3-02b/M3-03b、M7-04b | G7 | | F14 原生兼容与交付 | M0 基线、M8-03a~M8-04b、M9 | G8;最终交付 G9 | +| F15 内置内核选择 | XCORE-01~XCORE-05 | GCORE;发布汇总 G8 | + +## 6. XCORE/0.9.16:用户增补的内置内核选择 + +对应计划第 11 节/F15。依赖现有 M2/M3/M5 接口的隔离实现;不要求先通过缺设备的 G2~G7 才能做 +L1 检查,也不据此勾选它们。源码基线与局部工作区改动见 `docs/reports/core-selection-0.9.16.md`。 + +- [x] **XCORE-01 接入第二个内置内核**。前置:现有可构建的 M2/M3 接口。完成:固定 Nestopia 来源、构建和通知,统一内核调用,支持它的像素输出,与 FCEUmm 一同打包。验收:L1,arm64 APK 构建成功,21 个必需导出存在,局部像素转换/帧序号测试通过,全部原生库静态对齐合格。证据:双内核报告;尚未代表 Android 动态加载通过。 +- [x] **XCORE-02 保存并应用内核选择**。前置:XCORE-01。完成:设置提供默认选择,长按游戏提供覆盖与跟随默认,持久保存后仅影响下一次加载,活动会话与存档页显示当前内核。验收:L1,应用编译通过;默认/覆盖/取消、存储重开、未知旧值回退的局部测试通过。证据:双内核报告;界面操作留给 XCORE-04。 +- [x] **XCORE-03 隔离内核进度**。前置:XCORE-01、现有 M5 格式接口。完成:FCEUmm 保持原路径,Nestopia 的电池、手动/自动槽及恢复标记独立;包带内核身份并在写入前校验。验收:L1,旧路径保留、不同内核路径/恢复键不冲突、包往返与跨内核拒绝、无标识旧包只归 FCEUmm 的测试通过。证据:双内核报告;实际存读档留给 XCORE-04。 +- [ ] **XCORE-04 验证 Android 上的切换与进度**。前置:XCORE-02、XCORE-03。完成:在同一进程按 FCEUmm→Nestopia→FCEUmm 打开同一带电池样本,分别建立并恢复进度;再用一份无电池样本检查两内核的即时存读档;重启应用确认默认和单游戏覆盖保留,取消覆盖恢复默认。验收:L2,每个不同分支一次短路径,画面、声音、输入正常,切回后原槽可读,跨内核包拒绝且旧档不变。状态:待连接 Android 手机及样本;不做 100 次循环或长稳。 +- [ ] **XCORE-05 验证龙珠英雄黑屏反馈**。前置:XCORE-04、用户实际使用的 ROM 和目标手机;桌面复现可提前独立完成。完成:记录 ROM 哈希、Mapper、区域及内核/应用版本,对确认的制式误判按精确哈希修正,两个内核各检查加载、进入游戏、输入和音画。验收:L1 检查哈希匹配与选项隔离;L2 在手机上对照验证,不以桌面检查替代。状态:0.9.17 已定位该 ROM 的 NTSC 启动卡死并自动使用 Dendy;两个内核各 1800 帧中文启动/菜单导航、一次核心状态往返及局部规则测试通过。手机与完整玩法待复核,详见 `docs/reports/long-zhu-ying-xiong-0.9.17.md`。 +- [ ] **GCORE 双内核门槛**。前置:XCORE-01~05。验收:L3 汇总,核对选择、旧数据保留和用户问题结果;冻结时按第 2 节补受影响内核的兼容集、H-AV、H-SAVE、H-NATIVE,逐项标注通过/失败/未验证。与 G8 共用一份证据,不重复跑同一轮;新增内核不能继承 FCEUmm 的运行结论。状态:L1 已完成,L2/专项实机证据未完成。 所有需求在功能阶段通过后,仍须进入 G8 的发布覆盖核对;核对复用有效证据,不等于把每项的全部历史测试重新执行一遍。 diff --git a/tools/check-m1-device.ps1 b/tools/check-m1-device.ps1 index 6c0ce14..9a27b67 100644 --- a/tools/check-m1-device.ps1 +++ b/tools/check-m1-device.ps1 @@ -7,10 +7,10 @@ $ErrorActionPreference = 'Stop' $root = Split-Path -Parent $PSScriptRoot $sdkRoot = if ($env:ANDROID_HOME) { $env:ANDROID_HOME } else { 'C:\Users\shenw_o246oq4\AppData\Local\Android\Sdk' } $adb = Join-Path $sdkRoot 'platform-tools\adb.exe' -$apk = Join-Path $root 'app\build\outputs\apk\debug\app-debug.apk' +$apk = Join-Path $root 'build\app\outputs\apk\debug\app-debug.apk' if (-not (Test-Path $adb)) { throw "adb not found: $adb" } -if (-not (Test-Path $apk)) { throw "M1 APK not found: $apk. Run tools/check.ps1 -Scope Build first." } +if (-not (Test-Path $apk)) { throw "APK not found: $apk. Run 打包.cmd first." } $devices = @(& $adb devices | Select-Object -Skip 1 | ForEach-Object { if ($_ -match '^([^\s]+)\s+device$') { $Matches[1] } diff --git a/tools/check-rc-native.ps1 b/tools/check-rc-native.ps1 index fa65c1e..5e2a72c 100644 --- a/tools/check-rc-native.ps1 +++ b/tools/check-rc-native.ps1 @@ -16,7 +16,11 @@ $resolvedApk = (Resolve-Path $ApkPath).Path if (-not (Test-Path $zipalign)) { throw "zipalign not found: $zipalign" } if (-not (Test-Path $readelf)) { throw "llvm-readelf not found: $readelf" } -$auditRoot = Join-Path $root '.build\rc-native-audit' +$auditRoot = [IO.Path]::GetFullPath((Join-Path $root 'build\native-audit')) +$expectedAuditRoot = [IO.Path]::GetFullPath((Join-Path $root 'build')) + [IO.Path]::DirectorySeparatorChar +if (-not $auditRoot.StartsWith($expectedAuditRoot, [StringComparison]::OrdinalIgnoreCase)) { + throw 'Native audit output must remain inside the repository build directory.' +} if (Test-Path $auditRoot) { Remove-Item -LiteralPath $auditRoot -Recurse -Force } $null = New-Item -ItemType Directory -Path $auditRoot Add-Type -AssemblyName System.IO.Compression.FileSystem @@ -80,7 +84,7 @@ $result = [ordered]@{ } } -if (-not $OutputPath) { $OutputPath = Join-Path $root '.build\rc-native-audit.json' } +if (-not $OutputPath) { $OutputPath = Join-Path $root 'build\reports\native-audit.json' } $outputDirectory = Split-Path -Parent $OutputPath if ($outputDirectory) { $null = New-Item -ItemType Directory -Path $outputDirectory -Force } $result | ConvertTo-Json -Depth 8 | Set-Content -LiteralPath $OutputPath -Encoding utf8NoBOM diff --git a/tools/check.ps1 b/tools/check.ps1 deleted file mode 100644 index 5f64a83..0000000 --- a/tools/check.ps1 +++ /dev/null @@ -1,75 +0,0 @@ -[CmdletBinding()] -param( - [ValidateSet('Build', 'Local', 'Module', 'Stage')] - [string]$Scope = 'Build' -) - -$ErrorActionPreference = 'Stop' -$root = Split-Path -Parent $PSScriptRoot -$sdkRoot = if ($env:ANDROID_HOME) { $env:ANDROID_HOME } else { 'C:\Users\shenw_o246oq4\AppData\Local\Android\Sdk' } -$bundledJdk = Join-Path $root '.toolchains\jdk-17.0.17+10' -$env:JAVA_HOME = if ($env:JAVA_HOME -and (Test-Path (Join-Path $env:JAVA_HOME 'bin\java.exe'))) { $env:JAVA_HOME } else { $bundledJdk } - -if (-not (Test-Path (Join-Path $env:JAVA_HOME 'bin\java.exe'))) { - throw 'JDK 17 not found. Set JAVA_HOME to the pinned JDK; see docs/build.md.' -} -$javaExecutable = Join-Path $env:JAVA_HOME 'bin\java.exe' -$javaVersionProcess = New-Object System.Diagnostics.Process -$javaVersionProcess.StartInfo = New-Object System.Diagnostics.ProcessStartInfo -$javaVersionProcess.StartInfo.FileName = $javaExecutable -$javaVersionProcess.StartInfo.Arguments = '-version' -$javaVersionProcess.StartInfo.UseShellExecute = $false -$javaVersionProcess.StartInfo.RedirectStandardError = $true -$javaVersionProcess.StartInfo.CreateNoWindow = $true -$null = $javaVersionProcess.Start() -$javaVersion = $javaVersionProcess.StandardError.ReadToEnd() -$javaVersionProcess.WaitForExit() -if ($javaVersionProcess.ExitCode -ne 0) { - throw "Could not query JDK version at ${javaExecutable}." -} -if ($javaVersion -notmatch 'version "17\.') { - throw "JDK 17 is required, but JAVA_HOME resolves to: $javaVersion" -} -if (-not (Test-Path (Join-Path $sdkRoot 'platforms\android-36.1'))) { - throw "Android SDK Platform 36.1 not found at $sdkRoot. See docs/build.md." -} - -$env:ANDROID_HOME = $sdkRoot -$env:ANDROID_SDK_ROOT = $sdkRoot -$env:Path = "$env:JAVA_HOME\bin;$env:Path" -$gradle = Join-Path $root 'gradlew.bat' -$cmake = Join-Path $sdkRoot 'cmake\3.22.1\bin\cmake.exe' - -function Invoke-AppBuild { - & $gradle ':app:assembleDebug' - if ($LASTEXITCODE -ne 0) { throw 'Debug APK build failed.' } -} - -function Invoke-LocalTest { - & $gradle ':app:testDebugUnitTest' - if ($LASTEXITCODE -ne 0) { throw 'Local unit test failed.' } -} - -function Invoke-NativeTest { - if (-not (Test-Path $cmake)) { throw "Pinned Android CMake was not found: $cmake" } - $buildDir = Join-Path $root '.build\native-tests' - $ctest = Join-Path (Split-Path -Parent $cmake) 'ctest.exe' - & $cmake -S (Join-Path $root 'app\src\main\cpp') -B $buildDir - if ($LASTEXITCODE -ne 0) { throw 'Native test configuration failed.' } - & $cmake --build $buildDir --config Debug - if ($LASTEXITCODE -ne 0) { throw 'Native test build failed.' } - & $ctest --test-dir $buildDir -C Debug --output-on-failure - if ($LASTEXITCODE -ne 0) { throw 'Native smoke test failed.' } -} - -Push-Location $root -try { - switch ($Scope) { - 'Build' { Invoke-AppBuild } - 'Local' { Invoke-LocalTest } - 'Module' { Invoke-NativeTest; Invoke-LocalTest } - 'Stage' { Invoke-AppBuild; Invoke-NativeTest; Invoke-LocalTest } - } -} finally { - Pop-Location -} diff --git a/tools/collect-h-long.ps1 b/tools/collect-h-long.ps1 index 44ac22c..297eeec 100644 --- a/tools/collect-h-long.ps1 +++ b/tools/collect-h-long.ps1 @@ -30,7 +30,7 @@ if (-not $pidValue) { throw "Package is not running: $Package" } if (-not $OutputDirectory) { $stamp = Get-Date -Format 'yyyyMMdd-HHmmss' - $OutputDirectory = Join-Path $root ".build\device-evidence\h-long-$stamp" + $OutputDirectory = Join-Path $root "build\device-evidence\h-long-$stamp" } $null = New-Item -ItemType Directory -Path $OutputDirectory -Force $rawDirectory = Join-Path $OutputDirectory 'meminfo' diff --git a/tools/fetch-third-party.ps1 b/tools/fetch-third-party.ps1 index 55dd361..6bf5de1 100644 --- a/tools/fetch-third-party.ps1 +++ b/tools/fetch-third-party.ps1 @@ -39,3 +39,4 @@ function Get-PinnedRepository { Get-PinnedRepository -Name 'libretro-fceumm' -Url 'https://github.com/libretro/libretro-fceumm.git' -Commit '236ccdfc911e84c60fea6b9d0699c2d440a8de14' Get-PinnedRepository -Name 'libretro-headers' -Url 'https://github.com/libretro/RetroArch.git' -Commit '0c9622896333ee62dc4326bbe8784a210ddeb03c' -SparsePath @('libretro-common/include/libretro.h') Get-PinnedRepository -Name 'oboe' -Url 'https://github.com/google/oboe.git' -Commit 'a81bb9f87d4105b84b682685d3bfbb5beca371d1' +Get-PinnedRepository -Name 'nestopia' -Url 'https://github.com/libretro/nestopia.git' -Commit '224713b257c8620513c1c9ca28dc7f8dea711e18' diff --git a/tools/generate-rc-roms.ps1 b/tools/generate-rc-roms.ps1 index fb2fb37..ec750f2 100644 --- a/tools/generate-rc-roms.ps1 +++ b/tools/generate-rc-roms.ps1 @@ -5,11 +5,11 @@ param( $ErrorActionPreference = 'Stop' $root = Split-Path -Parent $PSScriptRoot -if (-not $OutputDirectory) { $OutputDirectory = Join-Path $root '.build\rc-roms' } +if (-not $OutputDirectory) { $OutputDirectory = Join-Path $root 'build\rc-roms' } $resolvedOutput = [IO.Path]::GetFullPath($OutputDirectory) -$resolvedBuildRoot = [IO.Path]::GetFullPath((Join-Path $root '.build')) +$resolvedBuildRoot = [IO.Path]::GetFullPath((Join-Path $root 'build')) + [IO.Path]::DirectorySeparatorChar if (-not $resolvedOutput.StartsWith($resolvedBuildRoot, [StringComparison]::OrdinalIgnoreCase)) { - throw 'Generated ROM output must remain inside the repository .build directory.' + throw 'Generated ROM output must remain inside the repository build directory.' } if (Test-Path $resolvedOutput) { Remove-Item -LiteralPath $resolvedOutput -Recurse -Force } $null = New-Item -ItemType Directory -Path $resolvedOutput diff --git a/tools/package-rc.ps1 b/tools/package-rc.ps1 deleted file mode 100644 index 95e9663..0000000 --- a/tools/package-rc.ps1 +++ /dev/null @@ -1,152 +0,0 @@ -[CmdletBinding()] -param( - [string]$OutputDirectory = '' -) - -$ErrorActionPreference = 'Stop' -$root = Split-Path -Parent $PSScriptRoot -$sdkRoot = if ($env:ANDROID_HOME) { $env:ANDROID_HOME } else { 'C:\Users\shenw_o246oq4\AppData\Local\Android\Sdk' } -$bundledJdk = Join-Path $root '.toolchains\jdk-17.0.17+10' -$env:JAVA_HOME = if ($env:JAVA_HOME -and (Test-Path (Join-Path $env:JAVA_HOME 'bin\java.exe'))) { - $env:JAVA_HOME -} else { - $bundledJdk -} -$env:ANDROID_HOME = $sdkRoot -$env:ANDROID_SDK_ROOT = $sdkRoot -$versionName = '0.9.15' -$versionCode = 9015 -$gitStatus = @(& git -C $root status --porcelain) -if ($LASTEXITCODE -ne 0) { throw 'Cannot inspect the Git worktree.' } -if ($gitStatus.Count -ne 0) { throw 'RC packaging requires a clean committed worktree.' } -$sourceCommit = (& git -C $root rev-parse HEAD).Trim() -if ($LASTEXITCODE -ne 0) { throw 'Cannot resolve the source commit.' } - -if (-not $OutputDirectory) { $OutputDirectory = Join-Path $root ".build\rc-$versionName" } -$resolvedOutput = [IO.Path]::GetFullPath($OutputDirectory) -$resolvedBuildRoot = [IO.Path]::GetFullPath((Join-Path $root '.build')) -if (-not $resolvedOutput.StartsWith($resolvedBuildRoot, [StringComparison]::OrdinalIgnoreCase)) { - throw 'RC output must remain inside the repository .build directory.' -} -if (Test-Path $resolvedOutput) { Remove-Item -LiteralPath $resolvedOutput -Recurse -Force } -$null = New-Item -ItemType Directory -Path $resolvedOutput - -& pwsh -NoProfile -ExecutionPolicy Bypass -File (Join-Path $root 'tools\check.ps1') -Scope Stage -if ($LASTEXITCODE -ne 0) { throw 'Stage checks failed.' } -& (Join-Path $root 'gradlew.bat') ':app:assembleRelease' ':app:lintRelease' ':app:assembleDebugAndroidTest' -if ($LASTEXITCODE -ne 0) { throw 'Release build or lint failed.' } - -$builtApk = Join-Path $root 'app\build\outputs\apk\release\app-release-unsigned.apk' -$builtSymbols = Join-Path $root 'app\build\outputs\native-debug-symbols\release\native-debug-symbols.zip' -if (-not (Test-Path $builtApk)) { throw "Unsigned release APK not found: $builtApk" } -if (-not (Test-Path $builtSymbols)) { throw "Native symbols not found: $builtSymbols" } -$candidateApk = Join-Path $resolvedOutput "NESLite-$versionName-rc-arm64-v8a-unsigned.apk" -$candidateSymbols = Join-Path $resolvedOutput "NESLite-$versionName-native-debug-symbols.zip" -Copy-Item -LiteralPath $builtApk -Destination $candidateApk -Copy-Item -LiteralPath $builtSymbols -Destination $candidateSymbols -$testTools = Join-Path $resolvedOutput 'test-tools' -$null = New-Item -ItemType Directory -Path $testTools -Copy-Item -LiteralPath (Join-Path $root 'app\build\outputs\apk\debug\app-debug.apk') -Destination $testTools -Copy-Item -LiteralPath (Join-Path $root 'app\build\outputs\apk\androidTest\debug\app-debug-androidTest.apk') -Destination $testTools - -$nativeAudit = Join-Path $resolvedOutput 'native-audit.json' -& pwsh -NoProfile -ExecutionPolicy Bypass -File (Join-Path $root 'tools\check-rc-native.ps1') -ApkPath $candidateApk -OutputPath $nativeAudit -if ($LASTEXITCODE -ne 0) { throw 'Native static audit failed.' } - -$aapt = Join-Path $sdkRoot 'build-tools\36.1.0\aapt.exe' -$badging = @(& $aapt dump badging $candidateApk 2>&1) -if ($LASTEXITCODE -ne 0) { throw 'Could not inspect candidate APK identity.' } -$packageLine = $badging | Select-Object -First 1 -if ($packageLine -notmatch "name='org\.neslite\.app'.*versionCode='$versionCode'.*versionName='$versionName'") { - throw "Unexpected release identity: $packageLine" -} - -$appSourceArchive = Join-Path $resolvedOutput "NESLite-$versionName-source.zip" -& git -C $root archive --format=zip "--prefix=NESLite-$versionName/" "--output=$appSourceArchive" HEAD -if ($LASTEXITCODE -ne 0) { throw 'Application source archive failed.' } -$thirdPartyManifest = Get-Content (Join-Path $root 'third_party\manifest.json') -Raw | ConvertFrom-Json -$thirdPartyArchives = @() -foreach ($source in $thirdPartyManifest.sources) { - $sourceDirectory = Join-Path $root "third_party\sources\$($source.directory)" - if (-not (Test-Path $sourceDirectory)) { throw "Third-party source is missing: $($source.directory)" } - $actualCommit = (& git -C $sourceDirectory rev-parse HEAD).Trim() - if ($LASTEXITCODE -ne 0 -or $actualCommit -ne $source.commit) { - throw "Third-party source is not at its locked commit: $($source.directory)" - } - $archive = Join-Path $resolvedOutput "$($source.directory)-$($source.commit.Substring(0, 12))-source.zip" - & git -C $sourceDirectory archive --format=zip "--prefix=$($source.directory)/" "--output=$archive" $source.commit - if ($LASTEXITCODE -ne 0) { throw "Source archive failed: $($source.directory)" } - $thirdPartyArchives += Split-Path -Leaf $archive -} - -$materials = Join-Path $resolvedOutput 'release-materials' -$null = New-Item -ItemType Directory -Path $materials -Copy-Item -LiteralPath (Join-Path $root 'LICENSE') -Destination $materials -Copy-Item -LiteralPath (Join-Path $root 'THIRD_PARTY_NOTICES.md') -Destination $materials -Copy-Item -LiteralPath (Join-Path $root 'third_party\manifest.json') -Destination $materials -Copy-Item -LiteralPath (Join-Path $root 'third_party\sources\oboe\LICENSE') -Destination (Join-Path $materials 'APACHE-2.0.txt') -Copy-Item -LiteralPath (Join-Path $root 'third_party\sources\libretro-fceumm\Copying') -Destination (Join-Path $materials 'GPL-2.0.txt') -Copy-Item -LiteralPath (Join-Path $root 'docs\build.md') -Destination $materials -Copy-Item -LiteralPath (Join-Path $root 'docs\usage.md') -Destination $materials -Copy-Item -LiteralPath (Join-Path $root 'docs\architecture.md') -Destination $materials -Copy-Item -LiteralPath (Join-Path $root 'docs\save-format.md') -Destination $materials -Copy-Item -LiteralPath (Join-Path $root 'docs\known-issues.md') -Destination $materials -Copy-Item -LiteralPath (Join-Path $root 'docs\reports\m8-release-candidate.md') -Destination $materials - -& pwsh -NoProfile -ExecutionPolicy Bypass -File (Join-Path $root 'tools\generate-rc-roms.ps1') -if ($LASTEXITCODE -ne 0) { throw 'Frozen RC ROM generation or hash verification failed.' } -$fixtureMetadata = Join-Path $resolvedOutput 'rom-fixture-metadata' -$null = New-Item -ItemType Directory -Path $fixtureMetadata -Copy-Item -LiteralPath (Join-Path $root '.build\rc-roms\manifest.json') -Destination $fixtureMetadata -Copy-Item -LiteralPath (Join-Path $root '.build\rc-roms\LICENSE.txt') -Destination $fixtureMetadata - -$manifest = [ordered]@{ - formatVersion = 1 - generatedAt = (Get-Date).ToUniversalTime().ToString('o') - sourceCommit = $sourceCommit - versionName = $versionName - versionCode = $versionCode - applicationId = 'org.neslite.app' - abi = @('arm64-v8a') - signing = [ordered]@{ - signed = $false - status = 'BLOCKED_PENDING_RELEASE_KEY' - note = 'This static-audit candidate must be signed with the protected release key before installation or upgrade testing.' - } - native = [ordered]@{ - fceummCommit = '236ccdfc911e84c60fea6b9d0699c2d440a8de14' - libretroHeaderCommit = '0c9622896333ee62dc4326bbe8784a210ddeb03c' - oboeCommit = 'a81bb9f87d4105b84b682685d3bfbb5beca371d1' - symbols = Split-Path -Leaf $candidateSymbols - mapping = 'not generated; minification is disabled' - } - artifacts = [ordered]@{ - apk = Split-Path -Leaf $candidateApk - applicationSource = Split-Path -Leaf $appSourceArchive - thirdPartySources = $thirdPartyArchives - nativeAudit = Split-Path -Leaf $nativeAudit - materials = 'release-materials/' - romFixtureMetadata = 'rom-fixture-metadata/' - androidMigrationTest = 'test-tools/app-debug-androidTest.apk' - } - runtimeEvidence = [ordered]@{ - romCompatibility = 'BLOCKED_NO_EXECUTED_RC_COMPATIBILITY_OR_GAMEPLAY_SAMPLES' - hLong = 'BLOCKED_NO_DEVICE' - hInput = 'BLOCKED_NO_DEVICE' - fourKiB = 'BLOCKED_NO_DEVICE' - sixteenKiB = 'BLOCKED_NO_DEVICE' - api28 = 'BLOCKED_NO_DEVICE' - upgrade = 'BLOCKED_NO_SIGNED_OLD_DATASET_OR_DEVICE' - } -} -$manifestPath = Join-Path $resolvedOutput 'candidate-manifest.json' -$manifest | ConvertTo-Json -Depth 8 | Set-Content -LiteralPath $manifestPath -Encoding utf8NoBOM - -$checksumFiles = Get-ChildItem $resolvedOutput -File -Recurse | Where-Object Name -ne 'SHA256SUMS.txt' | Sort-Object FullName -$checksumLines = foreach ($file in $checksumFiles) { - $relative = [IO.Path]::GetRelativePath($resolvedOutput, $file.FullName).Replace('\', '/') - "{0} {1}" -f (Get-FileHash $file.FullName -Algorithm SHA256).Hash, $relative -} -$checksumLines | Set-Content -LiteralPath (Join-Path $resolvedOutput 'SHA256SUMS.txt') -Encoding ascii -Write-Output "RC materials created: $resolvedOutput" -Write-Output 'The APK is intentionally unsigned; device and upgrade gates remain blocked until release signing is available.' diff --git a/tools/rom-probe/CMakeLists.txt b/tools/rom-probe/CMakeLists.txt new file mode 100644 index 0000000..51a4e44 --- /dev/null +++ b/tools/rom-probe/CMakeLists.txt @@ -0,0 +1,25 @@ +cmake_minimum_required(VERSION 3.22) +project(neslite_rom_probe LANGUAGES C CXX) +set(CMAKE_C_STANDARD 99) +set(CMAKE_CXX_STANDARD 20) +set(CMAKE_CXX_STANDARD_REQUIRED ON) +if(MSVC) + message(FATAL_ERROR "Use MinGW GCC or a GNU-compatible Clang toolchain for the optional core probe.") +endif() +set(ROOT "${CMAKE_CURRENT_LIST_DIR}/../..") +set(HOST "${ROOT}/app/src/main/cpp") +include("${HOST}/cmake/fceumm.cmake") +include("${HOST}/cmake/nestopia.cmake") +if(WIN32) + # The Android ELF export script does not apply to a Windows diagnostic DLL. + set_property(TARGET neslite_nestopia PROPERTY LINK_OPTIONS "") +endif() +foreach(core IN ITEMS fceumm nestopia) + add_executable(probe_${core} probe.cpp + "${HOST}/rom_compatibility.cpp" "${HOST}/sha256.cpp" "${HOST}/video_conversion.cpp" + "${HOST}/video_viewport.cpp") + target_include_directories(probe_${core} PRIVATE "${HOST}" "${NESLITE_LIBRETRO_HEADERS_DIR}") +endforeach() +target_link_libraries(probe_fceumm PRIVATE fceumm_core) +target_link_libraries(probe_nestopia PRIVATE neslite_nestopia) +target_compile_definitions(probe_nestopia PRIVATE PROBE_NESTOPIA) diff --git a/tools/rom-probe/README.md b/tools/rom-probe/README.md new file mode 100644 index 0000000..5e8a20e --- /dev/null +++ b/tools/rom-probe/README.md @@ -0,0 +1,30 @@ +# 可选的单 ROM 桌面检查 + +用于区分 ROM/内核输出问题和 Android 显示问题。它使用项目锁定的两个内核,以及生产代码的哈希、 +兼容选项、像素转换和显示尺寸计算;不启动 Android、Oboe 或 GL,不代替实机验收。默认检查一份 ROM 的 1800 帧, +保存几个 PPM 帧和统计结果,再做一次核心状态往返;不会安装为应用或自动加入 Stage 检查。 + +本机已验证 MinGW GCC 16.1.0/Ninja。从项目根目录配置(先按 `docs/build.md` 获取固定第三方源码): + +```powershell +$taskSdkCmake = "$env:LOCALAPPDATA\Android\Sdk\cmake\3.22.1\bin" +$env:Path = "C:\gcc-16.1.0-64\bin;$env:Path" +& "$taskSdkCmake\cmake.exe" -S tools/rom-probe -B build/rom-check -G Ninja "-DCMAKE_MAKE_PROGRAM=$taskSdkCmake/ninja.exe" -DCMAKE_C_COMPILER=C:/gcc-16.1.0-64/bin/gcc.exe -DCMAKE_CXX_COMPILER=C:/gcc-16.1.0-64/bin/g++.exe -DCMAKE_BUILD_TYPE=Release +& "$taskSdkCmake\cmake.exe" --build build/rom-check --target probe_fceumm probe_nestopia -j 8 +Copy-Item -LiteralPath '龙珠英雄.nes' -Destination build/rom-check/sample.nes +& build/rom-check/probe_fceumm.exe build/rom-check/sample.nes build/rom-check/fceumm 1800 +& build/rom-check/probe_nestopia.exe build/rom-check/sample.nes build/rom-check/nestopia 1800 +``` + +Windows 的上游文件接口要求 UTF-8,而窄字符命令行编码可能不同,所以本机检查使用 ASCII 名称的 +字节相同副本;它不修改原 ROM,也不涉及应用内已经使用哈希文件名的导入路径。样本不进入 Git。 + +可在帧数后传 `original-defaults` 暂时绕过兼容规则,重现两个内核的原始选项。帧数限 60~3600。 +只核对显示尺寸时可传 60 帧;输出 `texture` 为回调纹理尺寸,`base` 为核心基础尺寸, +`integer_viewport` 为生产算法在 1664×1248 区域内计算的整数缩放结果,不是实际 Android 截图。 +固定输入脚本在第 180、420 帧按 Start,在第 720~1620 帧每隔 180 帧按一次 A,每次 3 帧;这只是 +可重复的启动/菜单操作,不是通用自动游玩或完整游戏验收。 + +输出中的非零音频计数表示核心确实产生音频样本,不代表听感测试通过。退出码为零仅表示加载及核心 +状态往返成功;仍须查看帧内容判断是否卡死/黑屏。原始 NTSC 下的 CPU 卡死也可能支持状态序列化。 +状态往返比较恢复前后再运行 30 帧的画面哈希,不触碰用户存档,也不替代应用存档封装/写盘测试。 diff --git a/tools/rom-probe/probe.cpp b/tools/rom-probe/probe.cpp new file mode 100644 index 0000000..4421425 --- /dev/null +++ b/tools/rom-probe/probe.cpp @@ -0,0 +1,188 @@ +// Opt-in ROM diagnosis. No ROM data is compiled into this program or the APK. +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "rom_compatibility.h" +#include "sha256.h" +#include "video_conversion.h" +#include "video_viewport.h" + +namespace { +#ifdef PROBE_NESTOPIA +constexpr auto core = neslite::CoreKind::Nestopia; +#else +constexpr auto core = neslite::CoreKind::Fceumm; +#endif +neslite::RomCompatibility profile = neslite::RomCompatibility::Default; +std::map variables; +std::string directory, output; +unsigned frame = 0, pixel_format = 0, video_count = 0, changes = 0; +std::uint64_t nonzero_audio = 0; +std::uint32_t video_hash = 0; +std::vector pixels; +unsigned width = 0, height = 0; +retro_system_av_info av{}; + +void logger(enum retro_log_level, const char* format, ...) { + va_list args; va_start(args, format); vfprintf(stderr, format, args); va_end(args); +} +bool environment(unsigned command, void* data) { + switch (command) { + case RETRO_ENVIRONMENT_GET_CAN_DUPE: *static_cast(data) = true; return true; + case RETRO_ENVIRONMENT_GET_INPUT_BITMASKS: return true; + case RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY: + case RETRO_ENVIRONMENT_GET_CONTENT_DIRECTORY: + case RETRO_ENVIRONMENT_GET_SAVE_DIRECTORY: + *static_cast(data) = directory.c_str(); return true; + case RETRO_ENVIRONMENT_SET_PIXEL_FORMAT: + pixel_format = *static_cast(data); return pixel_format <= 2; + case RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION: + *static_cast(data) = 0; return true; + case RETRO_ENVIRONMENT_SET_VARIABLES: { + for (auto* v = static_cast(data); v && v->key; ++v) { + std::string value = v->value ? v->value : ""; + const auto separator = value.find(';'); + if (separator != std::string::npos) value.erase(0, separator + 1); + value.erase(0, value.find_first_not_of(' ')); + variables[v->key] = value.substr(0, value.find('|')); + if (const auto override = neslite::compatibility_core_option(profile, core, v->key)) { + variables[v->key] = *override; + } + } + return true; + } + case RETRO_ENVIRONMENT_GET_VARIABLE: { + auto* v = static_cast(data); + const auto it = variables.find(v->key ? v->key : ""); + v->value = it == variables.end() ? nullptr : it->second.c_str(); + return it != variables.end(); + } + case RETRO_ENVIRONMENT_GET_VARIABLE_UPDATE: *static_cast(data) = false; return true; + case RETRO_ENVIRONMENT_SET_VARIABLE: { + const auto* v = static_cast(data); + if (!v || !v->key || !v->value) return false; + variables[v->key] = v->value; return true; + } + case RETRO_ENVIRONMENT_GET_LOG_INTERFACE: + static_cast(data)->log = logger; return true; + case RETRO_ENVIRONMENT_GET_LANGUAGE: *static_cast(data) = RETRO_LANGUAGE_ENGLISH; return true; + case RETRO_ENVIRONMENT_GET_MESSAGE_INTERFACE_VERSION: *static_cast(data) = 1; return true; + case RETRO_ENVIRONMENT_GET_TARGET_REFRESH_RATE: *static_cast(data) = 60; return true; + case RETRO_ENVIRONMENT_GET_TARGET_SAMPLE_RATE: *static_cast(data) = 48000; return true; + case RETRO_ENVIRONMENT_SET_GEOMETRY: + av.geometry = *static_cast(data); return true; + case RETRO_ENVIRONMENT_SET_SYSTEM_AV_INFO: + av = *static_cast(data); return true; + case RETRO_ENVIRONMENT_SET_PERFORMANCE_LEVEL: + case RETRO_ENVIRONMENT_SET_INPUT_DESCRIPTORS: + case RETRO_ENVIRONMENT_SET_CONTROLLER_INFO: + case RETRO_ENVIRONMENT_SET_CONTENT_INFO_OVERRIDE: + case RETRO_ENVIRONMENT_SET_SUPPORT_ACHIEVEMENTS: + case RETRO_ENVIRONMENT_SET_MEMORY_MAPS: + case RETRO_ENVIRONMENT_SET_MESSAGE: + case RETRO_ENVIRONMENT_SET_MESSAGE_EXT: return true; + default: return false; + } +} +void dump_frame(unsigned number) { + if (pixels.empty()) return; + std::ofstream file(output + "-" + std::to_string(number) + ".ppm", std::ios::binary); + file << "P6\n" << width << " " << height << "\n255\n"; + for (const auto pixel : pixels) { + const char rgb[] = {static_cast(((pixel >> 11) & 31) * 255 / 31), + static_cast(((pixel >> 5) & 63) * 255 / 63), static_cast((pixel & 31) * 255 / 31)}; + file.write(rgb, 3); + } + if (!file) throw std::runtime_error("Could not save diagnostic frame"); +} +void video(const void* data, unsigned w, unsigned h, size_t pitch) { + if (!data) return; + if (!neslite::convert_to_rgb565(data, w, h, pitch, pixel_format, &pixels)) { + throw std::runtime_error("Unsupported or invalid video frame"); + } + ++video_count; width = w; height = h; + std::uint32_t hash = 2166136261u; + for (const auto pixel : pixels) hash = (hash ^ pixel) * 16777619u; + if (hash != video_hash) ++changes; + video_hash = hash; + if (frame == 179 || frame == 599 || frame == 1199) { + std::cout << "frame=" << frame << " colors=" << std::set(pixels.begin(), pixels.end()).size() + << " hash=" << video_hash << '\n'; + dump_frame(frame); + } +} +void audio(int16_t left, int16_t right) { if (left || right) ++nonzero_audio; } +size_t batch(const int16_t* data, size_t count) { + for (size_t i = 0; i < count; ++i) audio(data[i * 2], data[i * 2 + 1]); + return count; +} +void poll() {} +int16_t input(unsigned port, unsigned, unsigned, unsigned id) { + unsigned mask = 0; + if (port == 0) { + if ((frame >= 180 && frame < 183) || (frame >= 420 && frame < 423)) mask = 1u << RETRO_DEVICE_ID_JOYPAD_START; + if (frame >= 720 && frame < 1623 && (frame - 720) % 180 < 3) mask = 1u << RETRO_DEVICE_ID_JOYPAD_A; + } + return id == RETRO_DEVICE_ID_JOYPAD_MASK ? mask : id < 16 ? (mask >> id) & 1 : 0; +} +} // namespace + +int main(int argc, char** argv) { + if (argc < 3 || argc > 5) { + std::cerr << "Usage: probe_ ASCII_ROM_PATH OUTPUT_PREFIX [frames:60..3600] [original-defaults]\n"; + return 2; + } + const unsigned frames = argc > 3 ? static_cast(std::stoul(argv[3])) : 1800; + if (frames < 60 || frames > 3600) return 2; + const std::filesystem::path rom_path = argv[1]; + const auto size = std::filesystem::file_size(rom_path); + if (size < 16 || size > 64U * 1024U * 1024U) return 3; + std::ifstream file(rom_path, std::ios::binary); + std::vector rom(size); + if (!file.read(reinterpret_cast(rom.data()), static_cast(size))) return 3; + const auto hash = neslite::sha256_hex(rom); + if (argc < 5 || std::string(argv[4]) != "original-defaults") profile = neslite::rom_compatibility_for(hash); + output = argv[2]; + directory = std::filesystem::absolute(std::filesystem::path(output).parent_path()).string(); + std::filesystem::create_directories(directory); + std::cout << "sha256=" << hash << " profile=" << neslite::compatibility_profile_name(profile) << '\n'; + retro_set_environment(environment); retro_set_video_refresh(video); + retro_set_audio_sample(audio); retro_set_audio_sample_batch(batch); + retro_set_input_poll(poll); retro_set_input_state(input); + retro_init(); retro_set_controller_port_device(0, RETRO_DEVICE_JOYPAD); + retro_game_info game{argv[1], rom.data(), rom.size(), nullptr}; + if (!retro_load_game(&game)) { retro_deinit(); return 4; } + retro_get_system_av_info(&av); + std::cout << "fps=" << av.timing.fps << " format=" << pixel_format + << " battery=" << retro_get_memory_size(RETRO_MEMORY_SAVE_RAM) << '\n'; + for (frame = 0; frame < frames; ++frame) retro_run(); + dump_frame(frames); + std::cout << "frames=" << video_count << " changes=" << changes << " audio_nonzero=" << nonzero_audio << '\n'; + const auto viewport = neslite::calculate_video_viewport(1664, 1248, + av.geometry.base_width, av.geometry.base_height, true); + std::cout << "texture=" << width << 'x' << height << " base=" << av.geometry.base_width << 'x' + << av.geometry.base_height << " integer_viewport=" << viewport.width << 'x' << viewport.height + << " at=" << viewport.x << ',' << viewport.y << " surface=1664x1248\n"; + // One deterministic core-state round trip; this is not an Android save-file test. + std::vector state(retro_serialize_size()); + bool roundtrip = !state.empty() && retro_serialize(state.data(), state.size()); + if (roundtrip) { + for (frame = frames; frame < frames + 30; ++frame) retro_run(); + const auto expected = video_hash; + roundtrip = retro_unserialize(state.data(), state.size()); + if (roundtrip) { + for (frame = frames; frame < frames + 30; ++frame) retro_run(); + roundtrip = expected == video_hash; + } + } + std::cout << "core_state_roundtrip=" << (roundtrip ? "pass" : "fail") << '\n'; + retro_unload_game(); retro_deinit(); + return roundtrip ? 0 : 5; +} diff --git a/打包.cmd b/打包.cmd new file mode 100644 index 0000000..54b4205 --- /dev/null +++ b/打包.cmd @@ -0,0 +1,199 @@ +@echo off +setlocal +set "NESLITE_PACKAGE_FILE=%~f0" +where pwsh.exe >nul 2>nul +if errorlevel 1 ( + echo PowerShell 7 is required. Install it and run this file again. + pause + exit /b 1 +) +pwsh.exe -NoLogo -NoProfile -ExecutionPolicy Bypass -Command "$text = [IO.File]::ReadAllText($env:NESLITE_PACKAGE_FILE); $body = ($text -split '(?m)^# NESLITE_POWERSHELL\r?$', 2)[1]; & ([scriptblock]::Create($body)) %*" +exit /b %errorlevel% +# NESLITE_POWERSHELL +param( + [ValidateSet('debug', 'release')] + [string]$Variant = 'debug', + [switch]$NoPause +) + +$ErrorActionPreference = 'Stop' +$PSNativeCommandUseErrorActionPreference = $false +$root = Split-Path -Parent $env:NESLITE_PACKAGE_FILE +$buildRoot = Join-Path $root 'build' +$logPath = Join-Path $buildRoot "logs\package-$Variant.log" +$exitCode = 1 +$locationPushed = $false + +try { + foreach ($directory in @('logs', 'tmp', 'cache\gradle', 'releases', 'reports')) { + $null = New-Item -ItemType Directory -Path (Join-Path $buildRoot $directory) -Force + } + "NESLite $Variant packaging - $(Get-Date -Format 'yyyy-MM-dd HH:mm:ss')" | + Set-Content -LiteralPath $logPath -Encoding utf8NoBOM + Push-Location -LiteralPath $root + $locationPushed = $true + + $bundledJdk = Join-Path $buildRoot 'toolchains\jdk-17.0.17+10' + if (Test-Path -LiteralPath (Join-Path $bundledJdk 'bin\java.exe')) { $env:JAVA_HOME = $bundledJdk } + if (-not $env:JAVA_HOME -or -not (Test-Path -LiteralPath (Join-Path $env:JAVA_HOME 'bin\java.exe'))) { + throw '未找到 JDK 17。请设置 JAVA_HOME,或将 JDK 放入 build\toolchains\jdk-17.0.17+10。' + } + $java = Join-Path $env:JAVA_HOME 'bin\java.exe' + $javaVersion = (& $java -version 2>&1 | Out-String) + if ($LASTEXITCODE -ne 0 -or $javaVersion -notmatch 'version "17\.') { + throw "构建需要 JDK 17,当前 JAVA_HOME 为 $env:JAVA_HOME。" + } + + $sdkRoot = $null + $properties = Join-Path $root 'local.properties' + if (Test-Path -LiteralPath $properties) { + foreach ($line in Get-Content -LiteralPath $properties) { + if ($line -match '^\s*sdk\.dir\s*=\s*(.+?)\s*$') { + $sdkRoot = $Matches[1].Replace('\:', ':').Replace('\\', '\').Replace('\ ', ' ') + } + } + } + if (-not $sdkRoot) { $sdkRoot = $env:ANDROID_HOME } + if (-not $sdkRoot) { $sdkRoot = $env:ANDROID_SDK_ROOT } + if (-not $sdkRoot) { $sdkRoot = Join-Path $env:LOCALAPPDATA 'Android\Sdk' } + foreach ($component in @('platforms\android-36.1', 'build-tools\36.1.0', + 'ndk\28.2.13676358', 'cmake\3.22.1')) { + if (-not (Test-Path -LiteralPath (Join-Path $sdkRoot $component))) { + throw "Android 构建组件缺失:$sdkRoot\$component。安装方法见 docs\toolchain.md。" + } + } + $env:ANDROID_HOME = $sdkRoot + $env:ANDROID_SDK_ROOT = $sdkRoot + $env:TEMP = Join-Path $buildRoot 'tmp' + $env:TMP = $env:TEMP + $env:JAVA_TOOL_OPTIONS = ($env:JAVA_TOOL_OPTIONS + + " -Djava.io.tmpdir=`"$env:TEMP`" -Djdk.net.unixdomain.tmpdir=`"$env:TEMP`"").Trim() + + if ($Variant -eq 'release') { + $signingDirectory = if ($env:NESLITE_SIGNING_DIRECTORY) { $env:NESLITE_SIGNING_DIRECTORY } else { + Join-Path $env:USERPROFILE 'NESLite-private\signing' + } + $keystore = Join-Path $signingDirectory 'neslite-release.p12' + $passwordFile = Join-Path $signingDirectory 'password.dpapi' + if (-not (Test-Path -LiteralPath $keystore) -or -not (Test-Path -LiteralPath $passwordFile)) { + throw '未找到正式签名密钥及加密密码。请配置项目外的 NESLITE_SIGNING_DIRECTORY;不会自动更换已有签名。' + } + $sourceStatus = @(& git -C $root status --porcelain) + if ($LASTEXITCODE -ne 0 -or $sourceStatus.Count -ne 0) { throw '正式打包前请提交源码,确保 APK 和源码包对应同一提交。' } + $sourceCommit = (& git -C $root rev-parse HEAD).Trim() + if ($LASTEXITCODE -ne 0) { throw '无法取得源码提交。' } + } + + Write-Host '正在检查固定依赖并编译 APK;本入口不自动运行测试。' + & (Join-Path $root 'tools\fetch-third-party.ps1') | Tee-Object -FilePath $logPath -Append + $task = if ($Variant -eq 'debug') { ':app:assembleDebug' } else { ':app:assembleRelease' } + & $java '-Xmx64m' '-Xms64m' '-classpath' (Join-Path $root 'gradle\wrapper\gradle-wrapper.jar') ` + org.gradle.wrapper.GradleWrapperMain '--project-cache-dir' (Join-Path $buildRoot 'cache\gradle') ` + '--console=plain' '--no-daemon' '-Pkotlin.compiler.execution.strategy=in-process' $task 2>&1 | + Tee-Object -FilePath $logPath -Append + if ($LASTEXITCODE -ne 0) { throw "APK 编译失败(退出码 $LASTEXITCODE)。" } + + $apkDirectory = Join-Path $buildRoot "app\outputs\apk\$Variant" + $metadata = Get-Content -LiteralPath (Join-Path $apkDirectory 'output-metadata.json') -Raw | ConvertFrom-Json + if (@($metadata.elements).Count -ne 1) { throw '预期单个 arm64 APK,构建产物数量不符。' } + $artifact = $metadata.elements[0] + $builtApk = Join-Path $apkDirectory $artifact.outputFile + if (-not (Test-Path -LiteralPath $builtApk)) { throw "APK 产物不存在:$builtApk" } + $releaseFiles = @() + if ($Variant -eq 'release') { + $signer = Join-Path $sdkRoot 'build-tools\36.1.0\lib\apksigner.jar' + $signedApk = Join-Path $buildRoot "tmp\NESLite-$($artifact.versionName)-signed.apk" + $securePassword = Get-Content -LiteralPath $passwordFile -Raw | ConvertTo-SecureString + $env:NESLITE_KEYSTORE_PASSWORD = [Net.NetworkCredential]::new('', $securePassword).Password + try { + & $java '-jar' $signer sign --ks $keystore --ks-key-alias neslite-release ` + --ks-pass env:NESLITE_KEYSTORE_PASSWORD --key-pass env:NESLITE_KEYSTORE_PASSWORD ` + --v4-signing-enabled false --out $signedApk $builtApk 2>&1 | + Tee-Object -FilePath $logPath -Append + if ($LASTEXITCODE -ne 0) { throw '正式 APK 签名失败。' } + } finally { + Remove-Item Env:NESLITE_KEYSTORE_PASSWORD -ErrorAction SilentlyContinue + $securePassword = $null + } + $signatureReport = @(& $java '-jar' $signer verify --verbose --print-certs $signedApk 2>&1) + if ($LASTEXITCODE -ne 0) { throw '正式 APK 签名验证失败。' } + $signatureReport | Set-Content -LiteralPath (Join-Path $buildRoot 'reports\release-signature.txt') -Encoding utf8NoBOM + $builtApk = $signedApk + } + $auditPath = Join-Path $buildRoot "reports\package-$Variant-native.json" + & (Join-Path $root 'tools\check-rc-native.ps1') -ApkPath $builtApk -OutputPath $auditPath | + Tee-Object -FilePath $logPath -Append | Out-Null + + $suffix = '-arm64-v8a' + $name = "NESLite-$($artifact.versionName)$suffix.apk" + $destination = Join-Path $buildRoot "releases\$name" + if ($Variant -eq 'release') { + $symbols = Join-Path $buildRoot 'app\outputs\native-debug-symbols\release\native-debug-symbols.zip' + if (-not (Test-Path -LiteralPath $symbols)) { throw 'Release 原生调试符号缺失。' } + Copy-Item -LiteralPath $symbols -Destination (Join-Path $buildRoot "releases\NESLite-$($artifact.versionName)-native-debug-symbols.zip") -Force + $releaseFiles += "NESLite-$($artifact.versionName)-native-debug-symbols.zip" + $sourceName = "NESLite-$($artifact.versionName)-source.zip" + & git -C $root archive --format=zip "--prefix=NESLite-$($artifact.versionName)/" ` + "--output=$(Join-Path $buildRoot "releases\$sourceName")" $sourceCommit + if ($LASTEXITCODE -ne 0) { throw '应用源码归档失败。' } + $releaseFiles += $sourceName + $dependencies = Get-Content -LiteralPath (Join-Path $root 'third_party\manifest.json') -Raw | ConvertFrom-Json + foreach ($dependency in $dependencies.sources) { + $dependencyDirectory = Join-Path $root "third_party\sources\$($dependency.directory)" + $actualCommit = (& git -C $dependencyDirectory rev-parse HEAD).Trim() + $dependencyStatus = @(& git -C $dependencyDirectory status --porcelain) + if ($LASTEXITCODE -ne 0 -or $actualCommit -ne $dependency.commit -or $dependencyStatus.Count -ne 0) { + throw "依赖源码与锁定版本不一致:$($dependency.directory)" + } + $dependencyName = "$($dependency.directory)-$($dependency.commit.Substring(0, 12))-source.zip" + $archiveArguments = @('-C', $dependencyDirectory, 'archive', '--format=zip', + "--prefix=$($dependency.directory)/", "--output=$(Join-Path $buildRoot "releases\$dependencyName")", $dependency.commit) + if ($dependency.directory -eq 'libretro-headers') { $archiveArguments += 'libretro-common/include/libretro.h' } + & git @archiveArguments + if ($LASTEXITCODE -ne 0) { throw "依赖源码归档失败:$($dependency.directory)" } + $releaseFiles += $dependencyName + } + } + Copy-Item -LiteralPath $builtApk -Destination $destination -Force + $hash = (Get-FileHash -LiteralPath $destination -Algorithm SHA256).Hash + "$hash $name" | Set-Content -LiteralPath "$destination.sha256" -Encoding ascii + $releaseFiles += $name, "$name.sha256" + foreach ($material in @('LICENSE', 'THIRD_PARTY_NOTICES.md', 'third_party\manifest.json')) { + Copy-Item -LiteralPath (Join-Path $root $material) -Destination (Join-Path $buildRoot 'releases') -Force + $releaseFiles += Split-Path -Leaf $material + } + if ($Variant -eq 'release') { + $notesName = "NESLite-$($artifact.versionName)-release-notes.md" + Copy-Item -LiteralPath (Join-Path $root "docs\releases\$($artifact.versionName).md") ` + -Destination (Join-Path $buildRoot "releases\$notesName") -Force + $releaseFiles += $notesName + $manifestName = "NESLite-$($artifact.versionName)-release.json" + [ordered]@{ versionName=$artifact.versionName; versionCode=$artifact.versionCode; + applicationId=$metadata.applicationId; sourceCommit=$sourceCommit; abi='arm64-v8a'; signed=$true; + apk=$name; apkSHA256=$hash; dependencies=$dependencies.sources; assets=$releaseFiles } | + ConvertTo-Json -Depth 8 | Set-Content -LiteralPath (Join-Path $buildRoot "releases\$manifestName") -Encoding utf8NoBOM + $releaseFiles += $manifestName + $checksums = foreach ($releaseFile in $releaseFiles) { + "{0} {1}" -f (Get-FileHash -LiteralPath (Join-Path $buildRoot "releases\$releaseFile") -Algorithm SHA256).Hash, $releaseFile + } + $checksums | Set-Content -LiteralPath (Join-Path $buildRoot "releases\NESLite-$($artifact.versionName)-SHA256SUMS.txt") -Encoding ascii + } + "APK: $destination`nSHA256: $hash" | Add-Content -LiteralPath $logPath -Encoding utf8NoBOM + Write-Host "`n打包完成:$destination" -ForegroundColor Green + Write-Host "构建日志:$logPath" + if ($Variant -eq 'release') { + Write-Host '正式 APK 已签名并验证,源码、符号及发布材料已输出。' + } else { + Write-Host '这是可直接安装的调试版 APK。' + } + $exitCode = 0 +} catch { + $message = $_.Exception.Message + Write-Host "`n打包失败:$message" -ForegroundColor Red + if (Test-Path -LiteralPath $logPath) { Add-Content -LiteralPath $logPath -Value "FAILED: $message" } + Write-Host "请检查日志:$logPath" +} finally { + if ($locationPushed) { Pop-Location } +} +if (-not $NoPause) { $null = Read-Host '按回车键关闭窗口' } +exit $exitCode