using Age.Engine.Model;
namespace Age.Engine.Sys4;
///
/// Typed facade over the runtime SYS4 catalog. Graphics, voice, movie, SFX, and cursor operands use
/// universal packed ids; BGM uses direct names.
/// See docs/asset-resolution-re.md.
///
public sealed class ResourceMap
{
private readonly Sys4AssetCatalog _catalog;
private readonly IAssetStore _store;
private readonly Action? _diagnostic;
private readonly HashSet _reportedDiagnostics = new(StringComparer.Ordinal);
private readonly object _diagnosticLock = new();
public ResourceMap(Sys4AssetCatalog catalog, IAssetStore? store = null,
Action? diagnostic = null)
{
_catalog = catalog;
_store = store ?? new Sys4AssetStore(catalog, Paths.GameDir, Paths.GameDir);
_diagnostic = diagnostic;
}
public static ResourceMap Load(Action? diagnostic = null)
=> new(Sys4AssetCatalog.Load(Paths.Sys4Ini), diagnostic: diagnostic);
/// Resolve a universal packed SYS4INI/AAI id to an AGF texture record.
public AssetEntry? ResolveTexture(long resourceId)
=> ResolveTypedPacked(resourceId, "texture", "an AGF record",
entry => entry.Name.EndsWith(".AGF", StringComparison.OrdinalIgnoreCase));
/// Resolve a universal packed SYS4INI/AAI id to a voice audio record.
public AssetEntry? ResolveVoice(long resourceId)
=> ResolveTypedPacked(resourceId, "voice", "an OGG/WAV record", IsAudio);
/// Resolve a universal packed SYS4INI/AAI id to an AGF-named movie record. ReadMovie
/// validates the MPEG signature because still images use the same extension.
public AssetEntry? ResolveMovie(long resourceId)
=> ResolveTypedPacked(resourceId, "movie", "an AGF record",
entry => entry.Name.EndsWith(".AGF", StringComparison.OrdinalIgnoreCase));
/// Decode an AGF directly from loose-first VFS bytes.
public RgbaImage DecodeTexture(AssetEntry entry) => AgfDecoder.Decode(_store, entry);
/// Resolve a native packed raw id to one of AGE's Windows cursor resources.
public AssetEntry? ResolveCursor(long resourceId)
=> ResolveTypedPacked(resourceId, "cursor", "a CUR record",
entry => entry.Name.EndsWith(".CUR", StringComparison.OrdinalIgnoreCase));
public CursorImage DecodeCursor(AssetEntry entry)
{
if (!entry.Name.EndsWith(".CUR", StringComparison.OrdinalIgnoreCase))
throw new InvalidDataException($"not a CUR asset: {entry.Name}");
return CurDecoder.Decode(_store.ReadAll(entry), entry.Name);
}
public AssetEntry? ResolveName(string name) => _catalog.ResolveName(name);
///
/// Resolve a BGM id to its catalog entry. BGM is addressed by DIRECT LITERAL NAME (BGM{id:D3}.OGG), NOT the
/// universal packed resource table used by voices/textures. Confirmed by ear (play-bgm 5->BGM005, 8->BGM008)
/// and by the play-bgm 0x23->BGM035 case: BGM035 is a real standalone track (the BGM set skips 030-034),
/// which the manifest mis-resolved to a graphics entry. See docs/asset-resolution-re.md.
///
public AssetEntry? ResolveBgm(long id)
{
var name = $"BGM{id:D3}.OGG";
var entry = _catalog.ResolveName(name);
return entry is { IsPlaceholder: false } && IsAudio(entry) ? entry : null;
}
/// Resolve opcode 0xb4's universal packed SYS4INI/AAI id to an audio entry.
public AssetEntry? ResolveSoundEffect(long packedRawId)
=> ResolveTypedPacked(packedRawId, "sound effect", "an OGG/WAV record", IsAudio);
/// Read a catalog-resolved OGG/WAV payload through the loose-first ALF/AAI byte store.
public AudioPayload ReadAudio(AssetEntry entry)
{
if (entry.IsPlaceholder || !IsAudio(entry))
throw new InvalidDataException($"not an OGG/WAV asset: {entry.Name}");
return new AudioPayload(entry.Name, _store.ReadAll(entry));
}
/// Read a catalog-resolved MPEG program-stream movie through the same loose-first VFS as
/// scripts, graphics, and audio. AGE uses an .AGF basename for these payloads; the MPEG pack start
/// code, rather than the extension, distinguishes them from still-image AGF.
public MoviePayload ReadMovie(AssetEntry entry)
{
if (entry.IsPlaceholder)
throw new InvalidDataException($"placeholder movie asset: {entry.Name}");
byte[] bytes = _store.ReadAll(entry);
if (bytes.Length < 4 || bytes[0] != 0 || bytes[1] != 0 || bytes[2] != 1 || bytes[3] != 0xba)
throw new InvalidDataException($"not an MPEG program stream: {entry.Name}");
return new MoviePayload(entry.Name, bytes);
}
private static bool IsAudio(AssetEntry entry)
=> entry.Name.EndsWith(".OGG", StringComparison.OrdinalIgnoreCase)
|| entry.Name.EndsWith(".WAV", StringComparison.OrdinalIgnoreCase);
private AssetEntry? ResolveTypedPacked(long resourceId, string kind, string expected,
Func matches)
{
AssetEntry? entry = _catalog.ResolvePacked(resourceId);
if (entry == null)
{
ReportOnce($"[asset-resolution] {kind} resource {FormatResourceId(resourceId)} " +
"does not select a mounted SYS4INI/AAI record");
return null;
}
if (entry.IsPlaceholder)
{
ReportOnce($"[asset-resolution] {kind} resource {FormatResourceId(resourceId)} " +
"selects a placeholder catalog record");
return null;
}
if (!matches(entry))
{
ReportOnce($"[asset-resolution] {kind} resource {FormatResourceId(resourceId)} " +
$"selects {entry.Name}, expected {expected}");
return null;
}
return entry;
}
private void ReportOnce(string message)
{
if (_diagnostic == null) return;
bool report;
lock (_diagnosticLock)
report = _reportedDiagnostics.Add(message);
if (report) _diagnostic(message);
}
private static string FormatResourceId(long resourceId)
=> resourceId < 0 ? resourceId.ToString() : $"0x{resourceId:x}";
}
public sealed record AudioPayload(string Name, byte[] Bytes);
public sealed record MoviePayload(string Name, byte[] Bytes);