From 65c51a272f0d0cc1232df9fd992d6aaf98635a61 Mon Sep 17 00:00:00 2001 From: Kelsi Date: Sun, 10 May 2026 02:27:03 -0700 Subject: [PATCH] feat(editor): add WVOX JSON round-trip (--export/--import-wvox-json) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Dual encoding for both WVOX enums via the readEnumField template: eventKind (int 0..8 OR token "greeting"/ "aggro"/"death"/"queststart"/"questprogress"/ "questcomplete"/"goodbye"/"special"/"phase") and genderHint (int 0..2 OR token "male"/"female"/"both"). volumeDb serializes as signed int8 since boss-call clips use +5dB above ambient and quiet whisper clips can use -10dB or lower. transcript serializes as a plain JSON string — operators editing the JSON sidecar can rewrite voice transcripts for accessibility (TTS engines and chat- bubble subtitles) without binary tooling. All 3 presets (questgiver/boss/vendor) byte-identical roundtrip OK. CLI flag count 1225 -> 1227. --- tools/editor/cli_arg_required.cpp | 1 + tools/editor/cli_help.cpp | 4 + tools/editor/cli_voiceovers_catalog.cpp | 184 ++++++++++++++++++++++++ 3 files changed, 189 insertions(+) diff --git a/tools/editor/cli_arg_required.cpp b/tools/editor/cli_arg_required.cpp index eb825688..1b4f0ff1 100644 --- a/tools/editor/cli_arg_required.cpp +++ b/tools/editor/cli_arg_required.cpp @@ -352,6 +352,7 @@ const char* const kArgRequired[] = { "--export-wspv-json", "--import-wspv-json", "--gen-vox", "--gen-vox-boss", "--gen-vox-vendor", "--info-wvox", "--validate-wvox", + "--export-wvox-json", "--import-wvox-json", "--gen-weather-temperate", "--gen-weather-arctic", "--gen-weather-desert", "--gen-weather-stormy", "--gen-zone-atmosphere", diff --git a/tools/editor/cli_help.cpp b/tools/editor/cli_help.cpp index 261e2193..7e25d65d 100644 --- a/tools/editor/cli_help.cpp +++ b/tools/editor/cli_help.cpp @@ -2359,6 +2359,10 @@ void printUsage(const char* argv0) { std::printf(" Print WVOX entries (id / npcId / eventKind / gender / variant / duration ms / volume dB / name) plus per-entry transcript\n"); std::printf(" --validate-wvox [--json]\n"); std::printf(" Static checks: id+name+npcId required, eventKind 0..8, genderHint 0..2, audioPath non-empty, no duplicate voiceIds, no two clips at same (npcId, eventKind, variantIndex) triple (random pick at trigger time would be ambiguous); warns on durationMs=0 (subtitle sync impossible), volumeDb outside [-20,+6] (clip risk), empty transcript (TTS+chat-bubble blank)\n"); + std::printf(" --export-wvox-json [out.json]\n"); + std::printf(" Export binary .wvox to a human-editable JSON sidecar (defaults to .wvox.json; emits eventKind and genderHint as both int AND name string; transcript as plain string for accessibility editing)\n"); + std::printf(" --import-wvox-json [out-base]\n"); + std::printf(" Import a .wvox.json sidecar back into binary .wvox (eventKind int OR \"greeting\"/\"aggro\"/\"death\"/\"queststart\"/\"questprogress\"/\"questcomplete\"/\"goodbye\"/\"special\"/\"phase\"; genderHint int OR \"male\"/\"female\"/\"both\"; volumeDb is signed int8)\n"); std::printf(" --catalog-pluck [--json]\n"); std::printf(" Extract one entry by id from any registered catalog format. Auto-detects magic, dispatches to the per-format --info-* handler internally, then prints just the matching entry. Primary-key field is auto-detected (first *Id field, or first numeric)\n"); std::printf(" --catalog-find [--magic ] [--json]\n"); diff --git a/tools/editor/cli_voiceovers_catalog.cpp b/tools/editor/cli_voiceovers_catalog.cpp index ab9f8106..96484ec6 100644 --- a/tools/editor/cli_voiceovers_catalog.cpp +++ b/tools/editor/cli_voiceovers_catalog.cpp @@ -157,6 +157,184 @@ int handleInfo(int& i, int argc, char** argv) { return 0; } +int parseEventKindToken(const std::string& s) { + using V = wowee::pipeline::WoweeVoiceovers; + if (s == "greeting") return V::Greeting; + if (s == "aggro") return V::Aggro; + if (s == "death") return V::Death; + if (s == "queststart") return V::QuestStart; + if (s == "questprogress") return V::QuestProgress; + if (s == "questcomplete") return V::QuestComplete; + if (s == "goodbye") return V::Goodbye; + if (s == "special") return V::Special; + if (s == "phase") return V::Phase; + return -1; +} + +int parseGenderHintToken(const std::string& s) { + using V = wowee::pipeline::WoweeVoiceovers; + if (s == "male") return V::Male; + if (s == "female") return V::Female; + if (s == "both") return V::Both; + return -1; +} + +template +bool readEnumField(const nlohmann::json& je, + const char* intKey, + const char* nameKey, + ParseFn parseFn, + const char* label, + uint32_t entryId, + uint8_t& outValue) { + if (je.contains(intKey)) { + const auto& v = je[intKey]; + if (v.is_string()) { + int parsed = parseFn(v.get()); + if (parsed < 0) { + std::fprintf(stderr, + "import-wvox-json: unknown %s token " + "'%s' on entry id=%u\n", + label, v.get().c_str(), + entryId); + return false; + } + outValue = static_cast(parsed); + return true; + } + if (v.is_number_integer()) { + outValue = static_cast(v.get()); + return true; + } + } + if (je.contains(nameKey) && je[nameKey].is_string()) { + int parsed = parseFn(je[nameKey].get()); + if (parsed >= 0) { + outValue = static_cast(parsed); + return true; + } + } + return true; +} + +int handleExportJson(int& i, int argc, char** argv) { + std::string base = argv[++i]; + std::string out; + if (parseOptArg(i, argc, argv)) out = argv[++i]; + base = stripWvoxExt(base); + if (out.empty()) out = base + ".wvox.json"; + if (!wowee::pipeline::WoweeVoiceoversLoader::exists(base)) { + std::fprintf(stderr, + "export-wvox-json: WVOX not found: %s.wvox\n", + base.c_str()); + return 1; + } + auto c = wowee::pipeline::WoweeVoiceoversLoader::load(base); + nlohmann::json j; + j["magic"] = "WVOX"; + j["version"] = 1; + j["name"] = c.name; + nlohmann::json arr = nlohmann::json::array(); + for (const auto& e : c.entries) { + arr.push_back({ + {"voiceId", e.voiceId}, + {"name", e.name}, + {"description", e.description}, + {"npcId", e.npcId}, + {"eventKind", e.eventKind}, + {"eventKindName", eventKindName(e.eventKind)}, + {"genderHint", e.genderHint}, + {"genderHintName", genderHintName(e.genderHint)}, + {"variantIndex", e.variantIndex}, + {"audioPath", e.audioPath}, + {"transcript", e.transcript}, + {"durationMs", e.durationMs}, + {"volumeDb", e.volumeDb}, + {"iconColorRGBA", e.iconColorRGBA}, + }); + } + j["entries"] = arr; + std::ofstream os(out); + if (!os) { + std::fprintf(stderr, + "export-wvox-json: failed to open %s for write\n", + out.c_str()); + return 1; + } + os << j.dump(2) << "\n"; + std::printf("Wrote %s (%zu voice clips)\n", + out.c_str(), c.entries.size()); + return 0; +} + +int handleImportJson(int& i, int argc, char** argv) { + std::string in = argv[++i]; + std::string outBase; + if (parseOptArg(i, argc, argv)) outBase = argv[++i]; + if (outBase.empty()) { + outBase = in; + if (outBase.size() >= 10 && + outBase.substr(outBase.size() - 10) == ".wvox.json") { + outBase.resize(outBase.size() - 10); + } else { + stripExt(outBase, ".json"); + stripExt(outBase, ".wvox"); + } + } + std::ifstream is(in); + if (!is) { + std::fprintf(stderr, + "import-wvox-json: cannot open %s\n", in.c_str()); + return 1; + } + nlohmann::json j; + try { + is >> j; + } catch (const std::exception& ex) { + std::fprintf(stderr, + "import-wvox-json: JSON parse error: %s\n", ex.what()); + return 1; + } + wowee::pipeline::WoweeVoiceovers c; + c.name = j.value("name", std::string{}); + if (!j.contains("entries") || !j["entries"].is_array()) { + std::fprintf(stderr, + "import-wvox-json: missing or non-array 'entries'\n"); + return 1; + } + for (const auto& je : j["entries"]) { + wowee::pipeline::WoweeVoiceovers::Entry e; + e.voiceId = je.value("voiceId", 0u); + e.name = je.value("name", std::string{}); + e.description = je.value("description", std::string{}); + e.npcId = je.value("npcId", 0u); + if (!readEnumField(je, "eventKind", "eventKindName", + parseEventKindToken, "eventKind", + e.voiceId, e.eventKind)) return 1; + if (!readEnumField(je, "genderHint", "genderHintName", + parseGenderHintToken, "genderHint", + e.voiceId, e.genderHint)) return 1; + e.variantIndex = static_cast( + je.value("variantIndex", 0u)); + e.audioPath = je.value("audioPath", std::string{}); + e.transcript = je.value("transcript", std::string{}); + e.durationMs = je.value("durationMs", 0u); + e.volumeDb = static_cast( + je.value("volumeDb", 0)); + e.iconColorRGBA = je.value("iconColorRGBA", 0xFFFFFFFFu); + c.entries.push_back(e); + } + if (!wowee::pipeline::WoweeVoiceoversLoader::save(c, outBase)) { + std::fprintf(stderr, + "import-wvox-json: failed to save %s.wvox\n", + outBase.c_str()); + return 1; + } + std::printf("Wrote %s.wvox (%zu voice clips)\n", + outBase.c_str(), c.entries.size()); + return 0; +} + int handleValidate(int& i, int argc, char** argv) { std::string base = argv[++i]; bool jsonOut = consumeJsonFlag(i, argc, argv); @@ -304,6 +482,12 @@ bool handleVoiceoversCatalog(int& i, int argc, char** argv, if (std::strcmp(argv[i], "--validate-wvox") == 0 && i + 1 < argc) { outRc = handleValidate(i, argc, argv); return true; } + if (std::strcmp(argv[i], "--export-wvox-json") == 0 && i + 1 < argc) { + outRc = handleExportJson(i, argc, argv); return true; + } + if (std::strcmp(argv[i], "--import-wvox-json") == 0 && i + 1 < argc) { + outRc = handleImportJson(i, argc, argv); return true; + } return false; }