mwg API
    Preparing search index...

    Interface DecoderLimits

    Guards for decoders of formats that carry machine code or compressed payloads (NSF, SID, SPC, a tracker with a packed sample bank, an LHA or DEFLATE archive): all of them are untrusted input, and "it ran a long time" or "it grew enormous" is a failure the format itself cannot be asked to prevent. Every limit is named, defaulted and raised by the caller, and every breach is one DecodeBudgetError that says which limit and why, never a hang or a crash.

    interface DecoderLimits {
        maxInputBytes: number;
        maxInstructionsPerSecond: number;
        maxOutputBytes: number;
        maxRealtimeRatio: number;
        maxSeconds: number;
        maxStarvedReads: number;
    }
    Index
    maxInputBytes maxInstructionsPerSecond maxOutputBytes maxRealtimeRatio maxSeconds maxStarvedReads
    maxInputBytes: number

    refuse input larger than this many bytes; 16 MiB

    maxInstructionsPerSecond: number

    emulated instructions allowed per second of sound produced; 4 million

    maxOutputBytes: number

    refuse to inflate past this many bytes of output, the bound on a zip bomb; 64 MiB

    maxRealtimeRatio: number

    a read that takes longer than this multiple of the audio it produced counts as starved; 1

    maxSeconds: number

    stop a stream after this many seconds of output, whatever the file says; 3600

    maxStarvedReads: number

    consecutive starved reads before the stream is cut; 8

    Settings
    Member Visibility

    On This Page
    Properties