using AcDream.Content;
using DatReaderWriter;
using DatReaderWriter.DBObjs;

namespace AcDream.App.Audio;

/// <summary>
/// Resolves the DID of retail's interface sound bank by walking the dats, the
/// way retail does, instead of carrying a literal.
///
/// <para>
/// <c>ClientUISystem::GetUISoundTable</c> @ <c>0x00563FB0</c> calls
/// <c>DBObj::GetByEnum</c> @ <c>0x00415490</c>, and
/// <c>DBCache::GetDIDFromEnum</c> @ <c>0x00413940</c> resolves the answer with
/// two <c>EnumIDMap</c> hops off <c>m_MasterMapID</c>: keyed first by the enum
/// INDEX (7 for the UI bank), then by the type key. Same chain and same helper
/// shape as <see cref="AcDream.App.Rendering.RetailCursorResolver"/> and the
/// portal tunnel's setup/animation lookup — the master id comes from the portal
/// dat header rather than being searched for.
/// </para>
///
/// <para>
/// Against the shipped dats this resolves to <c>0x2000004B</c>, a table holding
/// exactly the 32 <c>UI_*</c> slots.
/// <c>UiSoundTableResolutionTests</c> pins the walk, the DID, and the content.
/// </para>
/// </summary>
public static class UiSoundTableResolver
{
    /// <summary>The enum index the UI sound bank lives at.</summary>
    public const uint UiSoundTableEnumSlot = 7u;

    /// <summary>
    /// The type key the second hop uses. <c>GetByEnum(type, idx, cache)</c> hands
    /// <c>(type, idx)</c> to the enum chain and the resolved DID to
    /// <c>DBCache::Get(did, cache)</c>; a SoundTable's CACHE type is <c>0x22</c>
    /// (<c>CLOCache(cache, CSoundTable::Allocator, 0x22)</c>), which is not this
    /// key. The lane-5 research note transposed the two arguments.
    /// </summary>
    public const uint UiSoundTableTypeKey = 0x10000003u;

    /// <summary>
    /// Resolve the bank's DID, or 0 when the dats carry no such chain (in which
    /// case interface sounds stay silent rather than playing a guessed table).
    /// </summary>
    public static uint Resolve(IDatReaderWriter dats)
    {
        if (dats is null)
            return 0u;

        uint masterDid = (uint)dats.Portal.Db.Header.MasterMapId;
        if (masterDid == 0)
            return 0u;

        if (!dats.Portal.TryGet<EnumIDMap>(masterDid, out var master) || master is null)
            return 0u;

        if (!master.ClientEnumToID.TryGetValue(UiSoundTableEnumSlot, out uint perSlotDid)
            || perSlotDid == 0)
        {
            return 0u;
        }

        if (!dats.Portal.TryGet<EnumIDMap>(perSlotDid, out var perSlot) || perSlot is null)
            return 0u;

        return perSlot.ClientEnumToID.TryGetValue(UiSoundTableTypeKey, out uint did) ? did : 0u;
    }
}