Kelsidavis-WoWee/tools/editor/cli_voiceovers_catalog.cpp
Kelsi 78555a79b0 feat(editor): add WVOX (Voiceover Audio) — 114th open format
Novel replacement for the implicit per-NPC voice dialog
system vanilla WoW encoded across CreatureTextSounds
(server-side aggro/death barks), npc_text (gossip audio
cross-references), and per-quest dialog blobs. Each
entry binds one NPC to one voice clip for one
triggering event with metadata covering audio path,
duration, volume, gender hint for randomized casts,
variant index for multiple lines per event, and a
transcript field for accessibility (TTS engines + chat-
bubble subtitles).

Nine eventKind values cover the full NPC dialog
surface: Greeting / Aggro / Death / QuestStart /
QuestProgress / QuestComplete / Goodbye / Special /
Phase. The Phase kind specifically supports boss-fight
percentage milestones (75%/50%/25% transitions) where
multiple Phase entries with distinct variantIndex
disambiguate the boss-encounter scripting.

Three preset emitters: makeQuestgiver (5-clip canonical
quest dialog flow), makeBoss (6-clip Lich King fight
with phase milestones at 75/50/25%, special mechanic
call at +5dB for raid audibility, death line),
makeVendor (4-clip vendor interaction).

Validator's most novel check is per-(npcId, eventKind,
variantIndex) triple uniqueness — two clips with all
three matching would be ambiguous when the trigger
handler picks one randomly. The vendor preset
originally bound both Buy and Sell to (Special, 0)
which the validator caught and flagged before commit;
fix uses variantIndex 0 for Buy and 1 for Sell so the
trigger handler can distinguish.

Validator also warns on durationMs=0 with non-empty
audioPath (subtitle sync impossible), volumeDb outside
[-20,+6] (clip risk), and empty transcript (TTS +
chat-bubble subtitle would be blank).

Format count 113 -> 114. CLI flag count 1220 -> 1225.
2026-05-10 02:25:34 -07:00

312 lines
11 KiB
C++

#include "cli_voiceovers_catalog.hpp"
#include "cli_arg_parse.hpp"
#include "cli_box_emitter.hpp"
#include "pipeline/wowee_voiceovers.hpp"
#include <nlohmann/json.hpp>
#include <cstdint>
#include <cstdio>
#include <cstring>
#include <fstream>
#include <set>
#include <string>
#include <vector>
namespace wowee {
namespace editor {
namespace cli {
namespace {
std::string stripWvoxExt(std::string base) {
stripExt(base, ".wvox");
return base;
}
const char* eventKindName(uint8_t k) {
using V = wowee::pipeline::WoweeVoiceovers;
switch (k) {
case V::Greeting: return "greeting";
case V::Aggro: return "aggro";
case V::Death: return "death";
case V::QuestStart: return "queststart";
case V::QuestProgress: return "questprogress";
case V::QuestComplete: return "questcomplete";
case V::Goodbye: return "goodbye";
case V::Special: return "special";
case V::Phase: return "phase";
default: return "unknown";
}
}
const char* genderHintName(uint8_t g) {
using V = wowee::pipeline::WoweeVoiceovers;
switch (g) {
case V::Male: return "male";
case V::Female: return "female";
case V::Both: return "both";
default: return "unknown";
}
}
bool saveOrError(const wowee::pipeline::WoweeVoiceovers& c,
const std::string& base, const char* cmd) {
if (!wowee::pipeline::WoweeVoiceoversLoader::save(c, base)) {
std::fprintf(stderr, "%s: failed to save %s.wvox\n",
cmd, base.c_str());
return false;
}
return true;
}
void printGenSummary(const wowee::pipeline::WoweeVoiceovers& c,
const std::string& base) {
std::printf("Wrote %s.wvox\n", base.c_str());
std::printf(" catalog : %s\n", c.name.c_str());
std::printf(" voices : %zu\n", c.entries.size());
}
int handleGenQuest(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "QuestgiverVoices";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWvoxExt(base);
auto c = wowee::pipeline::WoweeVoiceoversLoader::makeQuestgiver(name);
if (!saveOrError(c, base, "gen-vox")) return 1;
printGenSummary(c, base);
return 0;
}
int handleGenBoss(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "LichKingVoices";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWvoxExt(base);
auto c = wowee::pipeline::WoweeVoiceoversLoader::makeBoss(name);
if (!saveOrError(c, base, "gen-vox-boss")) return 1;
printGenSummary(c, base);
return 0;
}
int handleGenVendor(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "VendorVoices";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWvoxExt(base);
auto c = wowee::pipeline::WoweeVoiceoversLoader::makeVendor(name);
if (!saveOrError(c, base, "gen-vox-vendor")) return 1;
printGenSummary(c, base);
return 0;
}
int handleInfo(int& i, int argc, char** argv) {
std::string base = argv[++i];
bool jsonOut = consumeJsonFlag(i, argc, argv);
base = stripWvoxExt(base);
if (!wowee::pipeline::WoweeVoiceoversLoader::exists(base)) {
std::fprintf(stderr, "WVOX not found: %s.wvox\n", base.c_str());
return 1;
}
auto c = wowee::pipeline::WoweeVoiceoversLoader::load(base);
if (jsonOut) {
nlohmann::json j;
j["wvox"] = base + ".wvox";
j["name"] = c.name;
j["count"] = c.entries.size();
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::printf("%s\n", j.dump(2).c_str());
return 0;
}
std::printf("WVOX: %s.wvox\n", base.c_str());
std::printf(" catalog : %s\n", c.name.c_str());
std::printf(" voices : %zu\n", c.entries.size());
if (c.entries.empty()) return 0;
std::printf(" id npc event gender var dur(ms) dB name\n");
for (const auto& e : c.entries) {
std::printf(" %4u %5u %-13s %-6s %2u %5u %+3d %s\n",
e.voiceId, e.npcId,
eventKindName(e.eventKind),
genderHintName(e.genderHint),
e.variantIndex, e.durationMs,
e.volumeDb, e.name.c_str());
if (!e.transcript.empty()) {
std::printf(" > \"%s\"\n",
e.transcript.c_str());
}
}
return 0;
}
int handleValidate(int& i, int argc, char** argv) {
std::string base = argv[++i];
bool jsonOut = consumeJsonFlag(i, argc, argv);
base = stripWvoxExt(base);
if (!wowee::pipeline::WoweeVoiceoversLoader::exists(base)) {
std::fprintf(stderr,
"validate-wvox: WVOX not found: %s.wvox\n",
base.c_str());
return 1;
}
auto c = wowee::pipeline::WoweeVoiceoversLoader::load(base);
std::vector<std::string> errors;
std::vector<std::string> warnings;
if (c.entries.empty()) {
warnings.push_back("catalog has zero entries");
}
std::set<uint32_t> idsSeen;
// Per-(npcId, eventKind, variantIndex) triple
// uniqueness — two voice clips with all three
// matching would be ambiguous (which one plays?).
std::set<uint64_t> tripleSeen;
auto tripleKey = [](uint32_t npc, uint8_t event,
uint8_t variant) {
return (static_cast<uint64_t>(npc) << 32) |
(static_cast<uint64_t>(event) << 8) |
variant;
};
for (size_t k = 0; k < c.entries.size(); ++k) {
const auto& e = c.entries[k];
std::string ctx = "entry " + std::to_string(k) +
" (id=" + std::to_string(e.voiceId);
if (!e.name.empty()) ctx += " " + e.name;
ctx += ")";
if (e.voiceId == 0)
errors.push_back(ctx + ": voiceId is 0");
if (e.name.empty())
errors.push_back(ctx + ": name is empty");
if (e.npcId == 0) {
errors.push_back(ctx +
": npcId is 0 — voice clip is unbound to "
"any creature");
}
if (e.eventKind > 8) {
errors.push_back(ctx + ": eventKind " +
std::to_string(e.eventKind) +
" out of range (must be 0..8)");
}
if (e.genderHint > 2) {
errors.push_back(ctx + ": genderHint " +
std::to_string(e.genderHint) +
" out of range (must be 0..2)");
}
if (e.audioPath.empty()) {
errors.push_back(ctx +
": audioPath is empty — voice clip would "
"play no audio");
}
if (e.durationMs == 0 && !e.audioPath.empty()) {
warnings.push_back(ctx +
": durationMs=0 but audioPath set — "
"trigger handler can't subtitle-sync "
"without duration; consider populating "
"from the audio file's actual length");
}
if (e.volumeDb < -20 || e.volumeDb > 6) {
warnings.push_back(ctx + ": volumeDb " +
std::to_string(e.volumeDb) +
" outside [-20, +6] typical range — "
"extreme values may clip or be inaudible");
}
if (e.transcript.empty()) {
warnings.push_back(ctx +
": transcript is empty — accessibility "
"TTS engines + chat-bubble subtitles "
"have no text to display");
}
// Triple uniqueness: same NPC + event + variant
// would pick non-deterministically.
if (e.npcId != 0) {
uint64_t key = tripleKey(e.npcId, e.eventKind,
e.variantIndex);
if (!tripleSeen.insert(key).second) {
errors.push_back(ctx +
": (npcId=" + std::to_string(e.npcId) +
", eventKind=" +
std::string(eventKindName(e.eventKind)) +
", variantIndex=" +
std::to_string(e.variantIndex) +
") triple already bound by another "
"voice clip — random pick at trigger "
"time would be ambiguous");
}
}
if (!idsSeen.insert(e.voiceId).second) {
errors.push_back(ctx + ": duplicate voiceId");
}
}
bool ok = errors.empty();
if (jsonOut) {
nlohmann::json j;
j["wvox"] = base + ".wvox";
j["ok"] = ok;
j["errors"] = errors;
j["warnings"] = warnings;
std::printf("%s\n", j.dump(2).c_str());
return ok ? 0 : 1;
}
std::printf("validate-wvox: %s.wvox\n", base.c_str());
if (ok && warnings.empty()) {
std::printf(" OK — %zu voice clips, all voiceIds + "
"(npc,event,variant) triples unique\n",
c.entries.size());
return 0;
}
if (!warnings.empty()) {
std::printf(" warnings (%zu):\n", warnings.size());
for (const auto& w : warnings)
std::printf(" - %s\n", w.c_str());
}
if (!errors.empty()) {
std::printf(" ERRORS (%zu):\n", errors.size());
for (const auto& e : errors)
std::printf(" - %s\n", e.c_str());
}
return ok ? 0 : 1;
}
} // namespace
bool handleVoiceoversCatalog(int& i, int argc, char** argv,
int& outRc) {
if (std::strcmp(argv[i], "--gen-vox") == 0 && i + 1 < argc) {
outRc = handleGenQuest(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--gen-vox-boss") == 0 && i + 1 < argc) {
outRc = handleGenBoss(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--gen-vox-vendor") == 0 &&
i + 1 < argc) {
outRc = handleGenVendor(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--info-wvox") == 0 && i + 1 < argc) {
outRc = handleInfo(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--validate-wvox") == 0 && i + 1 < argc) {
outRc = handleValidate(i, argc, argv); return true;
}
return false;
}
} // namespace cli
} // namespace editor
} // namespace wowee