@swf2es/player 0.0.0-stage → 0.1.1

package/dist/scripting/loads.d.ts

@@ -0,0 +1,220 @@
+import { type Swf } from "@swf2es/format";
+import { avm2 } from "@swf2es/runtime";
+import type { FetchPurpose, FetchRequest, FetchResult } from "../hosts.js";
+import type { Scripting } from "../scripting.js";
+type AsObject = avm2.AsObject;
+type Value = avm2.Value;
+export declare class Loads {
+    private readonly s;
+    /** Only loaded AVM1 movies enter this map; ordinary AS3 players create no AVM1 runtime. */
+    private readonly avm1Movies;
+    /** Loads asked for and not yet completed, in order; each prepared after the one before it. */
+    private readonly loads;
+    /** AVM1 movies from bytes, in the order asked, for the end of a frame. */
+    private readonly avm1Loads;
+    private preparing;
+    /** Host requests are independent of Loader's ordered preparation chain. */
+    private readonly pendingRequests;
+    /** Completed host byte requests delivered at the next frame, with scripts on the player thread. */
+    private readonly readyBytes;
+    /** A load from bytes was asked, and heldTime has not yet told of it ready. */
+    private holding;
+    /** How many loads from bytes there have been: each gets a URL of its own under the main SWF's. */
+    private dynamic;
+    /** The main SWF's flashvars, as the host gave them. */
+    private readonly flashvars;
+    /** What the next frame does after EXIT_FRAME, before the loads' ends: the main SWF's load events. */
+    readonly frameEnds: (() => void)[];
+    constructor(s: Scripting, options: {
+        parameters?: Readonly<Record<string, string>>;
+    });
+    tickAvm1(): void;
+    streamFrames(): number;
+    destroyAvm1(): void;
+    /** Keep an asynchronous host task visible to settled(). */
+    trackRequest(task: Promise<void>): void;
+    /** Cross a host callback into the next player frame, where scripts may run. */
+    deferHostEvent(deliver: () => void): void;
+    /**
+     * A LoaderInfo for `loader` (null for the main SWF's), empty until its
+     * content is known: what its natives read is kept on it as $ fields.
+     */
+    loaderInfo(loader: AsObject | null): AsObject;
+    /** The main SWF's loaderInfo.parameters: its URL's query, then the flashvars. */
+    mainParameters(): ReadonlyMap<string, string>;
+    /** What a LoaderInfo knows once its SWF is: the bytes, the header's version, frame rate and size. */
+    describe(info: AsObject, bytes: Uint8Array, swf: Swf): void;
+    /**
+     * The domain a load goes into: the LoaderContext's applicationDomain, or
+     * by default a new child of the domain of the code that asked, as
+     * Flash's `new ApplicationDomain(ApplicationDomain.currentDomain)`.
+     */
+    loadDomain(applicationDomain: Value): avm2.Domain;
+    /**
+     * The URL of the SWF a Loader belongs to, which its content's loaderURL
+     * reports and its relative URLs resolve against: Flash's is the SWF whose
+     * code made the Loader, which the runtime does not track, so it is the
+     * SWF the Loader is on the display list of when it loads, else the main.
+     */
+    private ownerUrl;
+    /**
+     * Whose a loadBytes' content is: the SWF whose code called it. Where the
+     * caller cannot be told, as from a timer, only while every SWF ever
+     * loaded had one origin is it that origin's, its Loader's SWF's on the
+     * display list, else the main SWF's, which then shares it; with several,
+     * no one's, an opaque URL that no check allows: never the main SWF's
+     * for a Loader nothing places, which an unloaded child may have made.
+     */
+    private bytesOwner;
+    /**
+     * A Loader's loadBytes. Flash tells the whole of the progress at once, in
+     * the call, the URL still null; the content comes in a later frame, under
+     * a URL of the bytes' own.
+     */
+    requestLoad(loader: AsObject, bytes: Uint8Array, domain?: avm2.Domain, parameters?: ReadonlyMap<string, string> | null): void;
+    /**
+     * An AVM1 SWF from bytes. Flash makes its AVM1Movie in the call, named
+     * then, and has it in the Loader at the end of the frame, after
+     * EXIT_FRAME, before the next frame begins: the last asked first, INIT
+     * and COMPLETE with each, as adl traces it (the `avm1-movie` case). A
+     * SWF with images has them decoded first, which may take frames; one
+     * whose images the decoder refuses ends in IOError #2124 there instead.
+     */
+    private requestAvm1;
+    /** An AVM1 SWF's library: its timelines play by themselves, with no AS3 objects but the root's. */
+    private avm1Library;
+    /**
+     * An AVM1 SWF's root, not yet on its first frame, as AS3 sees it: an
+     * AVM1Movie, which is no InteractiveObject, so the pointer's hits on the
+     * movie's artwork go to its Loader; its own VM picks its buttons (input/avm1.ts).
+     */
+    private avm1Movie;
+    /** The AVM1 movies from bytes ready by the end of this frame, the last asked first. */
+    deliverAvm1Loads(): void;
+    /**
+     * An AVM1 movie from bytes as the Loader's content, then its INIT and
+     * COMPLETE. It keeps its first frame through the next frame's advance,
+     * as adl shows it, then plays at the stage's frame rate.
+     */
+    private deliverAvm1;
+    /**
+     * A load begins: the one before it is dropped, pending or complete, and
+     * its LoaderInfo knows nothing again, as Flash's load() does at the call
+     * (Ruffle's `loader_reuse` trace), but the parameters its context gave,
+     * which Flash tells from the call on. The old content's REMOVED listeners
+     * may load anew themselves, and that load is then the one that counts:
+     * null tells the caller so.
+     */
+    private begin;
+    /** A Loader's close, and what a new load does first: a pending load does nothing when its turn comes, and its fetch is aborted. */
+    closeLoad(loader: AsObject): void;
+    private progress;
+    /** A Loader's load of a URL: the host fetches it, resolved, and the load completes in a frame after the bytes arrive. */
+    requestLoadUrl(loader: AsObject, request: AsObject | string, domain?: avm2.Domain, parameters?: ReadonlyMap<string, string> | null): void;
+    /**
+     * A URLStream's or a Sound's host request, delivered in a frame after the bytes arrive: a Sound's
+     * is "content", a URLStream's "data".
+     */
+    requestBytes(request: AsObject | string, signal: AbortSignal, deliver: (result: FetchResult, url: string) => void, purpose?: FetchPurpose): void;
+    /**
+     * navigateToURL's page, resolved as a load's URL is; nothing where the
+     * host opens none, or for an empty URL, which Ruffle's navigators ignore
+     * rather than open the SWF's own directory. A browser navigates only by
+     * GET or POST, so any other method goes as a GET, its data in the query,
+     * as Flash's does from a browser.
+     */
+    navigateTo(request: AsObject, window: string | null): void;
+    /** sendToURL's request, sent by the host's fetch and its response dropped, as Flash ignores it. */
+    sendTo(request: AsObject): void;
+    /** Security.loadPolicyFile's URL, resolved as a load's is, for the host to judge requests by. */
+    policyFile(url: string): void;
+    /** Snapshot a URLRequest at load time, before scripts can change its data or headers. */
+    fetchRequest(request: AsObject | string, base: string, options?: {
+        method?: string;
+        requestHeaders?: boolean | "all";
+    }): FetchRequest;
+    /** The text a failed stream reports, using Flash Player's message and the resolved URL. */
+    streamError(url: string, local?: boolean): string;
+    /**
+     * Resolves once every load asked for so far has its code linked or has
+     * failed, so that a host stepping frames by hand sees each complete in
+     * the frame after its request, as Flash's loadBytes does.
+     */
+    settled(): Promise<void>;
+    /**
+     * Whether the time since the host's last call was a load from bytes':
+     * one was asked since, or was still compiling at that call. Flash has a
+     * loadBytes' content in the frame after the call, ENTER_FRAME's,
+     * whatever the SWF's size, its code verified as it runs (the
+     * `loader-bytes-frames` case; in adl 0.5 MB of ABC and 8 MB of sounds
+     * still came in that frame), and content may count on it, as with a
+     * timer of a second, set at the call, that reads the Loader's child. True
+     * once more after the load is ready, for the call in which it came.
+     */
+    heldTime(): boolean;
+    /**
+     * Whether the next frame waits for the load due next, one from bytes
+     * whose code still compiles. Not one behind a load of a URL whose bytes
+     * have not come: that is not Flash's to time. A closed one still
+     * compiling ahead of it is passed over, as it will never come.
+     */
+    holdsFrame(): boolean;
+    private newLoad;
+    private enqueue;
+    /** "Error #id: message", as Flash's IOErrorEvent texts begin, debugger or not. */
+    private errorText;
+    /** Decode an image or link a SWF off the frame; return what the frame does with it. */
+    private prepare;
+    /** A Loader's unload: a pending load dropped, its content out of the display list, its LoaderInfo empty, the Loader kept; stopped for good if `stop`, as unloadAndStop has it, else playing on as an orphan. */
+    unload(loader: AsObject, stop?: boolean): void;
+    /**
+     * The content let go of, as unload() and a new load do: the Loader's and
+     * the LoaderInfo's first, so an unload a listener asks for finds none,
+     * then UNLOAD on the LoaderInfo with the child still attached, as Flash's
+     * trace has it (the `loads-init` case), then the child out.
+     */
+    private dropContent;
+    /**
+     * The main SWF, all of it loaded: INIT, final PROGRESS, then COMPLETE, after its first
+     * frame's scripts and EXIT_FRAME. Preloaders may subscribe in that frame's script and
+     * advance only from final progress, as AIR does for a streamed URL. Where its
+     * document class's constructor threw (`constructed` false), Flash sends
+     * COMPLETE alone (measured in adl).
+     */
+    mainLoaded(info: AsObject, constructed?: boolean): void;
+    /**
+     * Give the loads whose code is linked their content, oldest first, and
+     * stop at one still linking: they complete in the order asked. What
+     * each does at the frame's end is returned. Each delivery and each load
+     * is on its own: one whose code throws, as a loaded SWF's document
+     * class's constructor, is reported, and those after it still come.
+     */
+    completeLoads(): (() => void)[];
+    private completeLoad;
+    /** An IOErrorEvent of `text`, as a failed load ends. */
+    private ioError;
+    private loaderInfoOf;
+    /**
+     * A load's content, in the frame after its bytes came, after ENTER_FRAME
+     * and before FRAME_CONSTRUCTED, as Flash: the SWF's code run; its
+     * document class constructed, with parent and stage null; ADDED to it
+     * while it still has no parent, as Flash does; then the LoaderInfo's
+     * content, and the Loader's child, with ADDED again and ADDED_TO_STAGE
+     * if the loader is on the stage. Its first frame's script runs with
+     * the frame's, and INIT and COMPLETE follow EXIT_FRAME.
+     */
+    private complete;
+    /** URL progress precedes image metadata, while a SWF header is known at full progress. */
+    private startContent;
+    private completeImage;
+    private attachContent;
+}
+/**
+ * `url` against `base`, enough for a SWF's relative paths: one with a
+ * scheme is itself, one from the root keeps the base's origin, and any
+ * other replaces the base's last segment.
+ */
+/** `url` against `base`, as Flash resolves a load's URL: AVM1's loads resolve by it too. */
+export declare function resolve(base: string, url: string): string;
+export {};
+//# sourceMappingURL=loads.d.ts.map

package/dist/scripting/loads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loads.d.ts","sourceRoot":"","sources":["../../src/scripting/loads.ts"],"names":[],"mappings":"AAMA,OAAO,EAAkB,KAAK,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAMvC,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAG3E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAGjD,KAAK,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;AAC9B,KAAK,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;AAyCxB,qBAAa,KAAK;IAuBd,OAAO,CAAC,QAAQ,CAAC,CAAC;IAtBpB,2FAA2F;IAC3F,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAyD;IAEpF,8FAA8F;IAC9F,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAc;IACpC,0EAA0E;IAC1E,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAkB;IAC5C,OAAO,CAAC,SAAS,CAAoC;IACrD,2EAA2E;IAC3E,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA4B;IAC5D,mGAAmG;IACnG,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAsB;IACjD,8EAA8E;IAC9E,OAAO,CAAC,OAAO,CAAS;IACxB,kGAAkG;IAClG,OAAO,CAAC,OAAO,CAAK;IACpB,uDAAuD;IACvD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAmC;IAC7D,qGAAqG;IACrG,QAAQ,CAAC,SAAS,EAAE,CAAC,MAAM,IAAI,CAAC,EAAE,CAAM;IAExC,YACmB,CAAC,EAAE,SAAS,EAC7B,OAAO,EAAE;QAAE,UAAU,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;KAAE,EAG3D;IAED,QAAQ,IAAI,IAAI,CAef;IAED,YAAY,IAAI,MAAM,CAWrB;IAED,WAAW,IAAI,IAAI,CAOlB;IAED,2DAA2D;IAC3D,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAMtC;IAED,+EAA+E;IAC/E,cAAc,CAAC,OAAO,EAAE,MAAM,IAAI,GAAG,IAAI,CAExC;IAED;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,QAAQ,GAAG,IAAI,GAAG,QAAQ,CAa5C;IAED,iFAAiF;IACjF,cAAc,IAAI,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAQ5C;IAED,qGAAqG;IACrG,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,EAAE,GAAG,GAAG,IAAI,CAU1D;IAED;;;;OAIG;IACH,UAAU,CAAC,iBAAiB,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,CAGhD;IAED;;;;;OAKG;IACH,OAAO,CAAC,QAAQ;IAIhB;;;;;;;OAOG;IACH,OAAO,CAAC,UAAU;IAclB;;;;OAIG;IACH,WAAW,CACT,MAAM,EAAE,QAAQ,EAChB,KAAK,EAAE,UAAU,EACjB,MAAM,cAAwB,EAC9B,UAAU,GAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAW,GACpD,IAAI,CAiDN;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,WAAW;IA6BnB,mGAAmG;IACnG,OAAO,CAAC,WAAW;IAMnB;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAMjB,uFAAuF;IACvF,gBAAgB,IAAI,IAAI,CAcvB;IAED;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAgBnB;;;;;;;OAOG;IACH,OAAO,CAAC,KAAK;IAiBb,mIAAmI;IACnI,SAAS,CAAC,MAAM,EAAE,QAAQ,GAAG,IAAI,CAIhC;IAED,OAAO,CAAC,QAAQ;IAgBhB,yHAAyH;IACzH,cAAc,CACZ,MAAM,EAAE,QAAQ,EAChB,OAAO,EAAE,QAAQ,GAAG,MAAM,EAC1B,MAAM,cAAwB,EAC9B,UAAU,GAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAW,GACpD,IAAI,CAsBN;IAED;;;OAGG;IACH,YAAY,CACV,OAAO,EAAE,QAAQ,GAAG,MAAM,EAC1B,MAAM,EAAE,WAAW,EACnB,OAAO,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,KAAK,IAAI,EACnD,OAAO,GAAE,YAAqB,GAC7B,IAAI,CAYN;IAED;;;;;;OAMG;IACH,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAUzD;IAED,mGAAmG;IACnG,MAAM,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI,CAU9B;IAED,iGAAiG;IACjG,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAE5B;IAED,yFAAyF;IACzF,YAAY,CACV,OAAO,EAAE,QAAQ,GAAG,MAAM,EAC1B,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,cAAc,CAAC,EAAE,OAAO,GAAG,KAAK,CAAA;KAAO,GAClE,YAAY,CA6Cd;IAED,2FAA2F;IAC3F,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,MAAM,CAK9C;IAED;;;;OAIG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAEvB;IAED;;;;;;;;;OASG;IACH,QAAQ,IAAI,OAAO,CAOlB;IAED;;;;;OAKG;IACH,UAAU,IAAI,OAAO,CAKpB;IAED,OAAO,CAAC,OAAO;IAsBf,OAAO,CAAC,OAAO;IAuCf,kFAAkF;IAClF,OAAO,CAAC,SAAS;IAIjB,uFAAuF;YACzE,OAAO;IA0CrB,gNAAgN;IAChN,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,UAAQ,GAAG,IAAI,CAQ3C;IAED;;;;;OAKG;IACH,OAAO,CAAC,WAAW;IAwCnB;;;;;;OAMG;IACH,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,WAAW,UAAO,GAAG,IAAI,CASnD;IAED;;;;;;OAMG;IACH,aAAa,IAAI,CAAC,MAAM,IAAI,CAAC,EAAE,CAsB9B;IAED,OAAO,CAAC,YAAY;IAqBpB,wDAAwD;IACxD,OAAO,CAAC,OAAO;IAUf,OAAO,CAAC,YAAY;IAMpB;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAQ;IAwEhB,0FAA0F;IAC1F,OAAO,CAAC,YAAY;IA0CpB,OAAO,CAAC,aAAa;IAerB,OAAO,CAAC,aAAa;CA+BtB;AAkDD;;;;GAIG;AACH,4FAA4F;AAC5F,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAWzD"}