@swf2es/context3d 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 The swf2es authors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

package/README.md

@@ -1,3 +1,220 @@
-# Temporary Holding Version
+# Experimental Context3D backend
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+`@swf2es/context3d` provides resource/lifecycle contracts and AGAL v1 to GLSL
+translation. Its core has no dependencies or browser types. The optional
+`@swf2es/context3d/webgl` entry exports `WebGLContext3D`, which owns the supplied
+WebGL2 context exclusively. It does not share GL state or resources with the
+display list's renderer.
+
+The WebGL entry re-exports the context owner from `webgl/context.ts`. That owner
+keeps resource maps, byte accounting, bindings and draw/present ordering together.
+`buffers.ts` and `textures.ts` handle uploads; `programs.ts` handles shader linking
+and uniform locations; `targets.ts` handles framebuffer allocation and resolves. Limits
+and render-state constants live beside those modules. These are internal splits;
+the package entries and ownership contracts stay the same.
+
+This package does not enable Stage3D playback. The separate
+`@swf2es/player/context3d` entry installs experimental Flash bindings, and
+`@swf2es/player-hosts/stage3d` places canvases and attaches browser loss/restoration
+listeners. Install the bindings before loading playerglobal, and call their
+returned teardown before destroying Scripting. Default playback still reports
+unavailable Context3D through ErrorEvent #3702.
+
+The host supplies a positioned, clipped stage container, with the transparent
+display-list canvas above Stage3D slots 0..3. Supply a surface factory to
+`stage3DCanvasHost`; it returns a canvas and a backend for each requested slot.
+Create the WebGL2 context with `alpha: false`, `antialias: false`, `depth: false`,
+`stencil: false` and `preserveDrawingBuffer: true`. The backend manages its own
+back-buffer attachments and copies to the canvas only at `present()`.
+
+An optional second constructor argument sets resource budgets, for example
+`new WebGLContext3D(gl, { maxTextureBytes: 32 * 1024 * 1024 })`.
+Default counts match AIR's 4,096 resources independently for vertex buffers,
+index buffers, programs, 2D textures, rectangle textures and cube textures.
+`maxVertexBuffers`, `maxIndexBuffers`, `maxPrograms`, `max2DTextures`,
+`maxRectangleTextures` and `maxCubeTextures` change those limits. `maxBuffers`
+and `maxTextures` retain aggregate caps, defaulting to 8,192 and 12,288; an
+explicit lower cap still limits the combined types.
+
+Byte limits are independent by resource type and follow the observed AIR baseline
+allowances for buffers and BGRA textures:
+
+| Resource | Default | Constructor option |
+| --- | --- | --- |
+| Vertex buffers | 256 MiB | `maxVertexBufferBytes` |
+| Index buffers | 128 MiB | `maxIndexBufferBytes` |
+| 2D textures | 512 MiB | `max2DTextureBytes` |
+| Rectangle textures | 512 MiB | `maxRectangleTextureBytes` |
+| Cube textures | 256 MiB | `maxCubeTextureBytes` |
+
+AIR probes with BGRA textures at multiple sizes show a mip reservation of half the base size
+for ordinary and cube textures. Their per-type quota charge uses that reservation;
+rectangles charge only their base level. The aggregate `maxTextureBytes` budget
+still tracks the complete mip chains actually allocated, defaulting to 1,280 MiB.
+`maxBufferBytes` defaults to 384 MiB. Explicit lower aggregate overrides continue
+to bound combined storage independently of these allowances.
+
+Target depth/stencil and multisample color storage retain separate 64 MiB host
+policies (`maxTargetDepthBytes`, `maxTargetColorBytes`); equivalent AIR attachment
+accounting remains unverified. Multisample storage counts actual samples and cube
+targets include their cached single-sample resolve surface. All options must be
+nonnegative safe integers, are copied at creation and allocate nothing eagerly.
+Disposal returns both quota and storage capacity. These are logical allocation
+accounts, not physical driver VRAM, and exclude back-buffer attachments.
+Compressed textures ("compressed", "compressedAlpha") hold S3TC's DXT1 and
+DXT5, which `Texture3D.uploadCompressed` takes as blocks; the player decodes
+ATF to them (`@swf2es/native/atf`). The backend stores them with
+`WEBGL_compressed_texture_s3tc` where the context has it, DXT1 with its bit of
+alpha, as AIR draws a three-colour block's fourth texel transparent, and
+decodes them to RGBA on the CPU (`dxt.ts`) where it has not. AIR charges their
+quota at DXT1's eighth of the BGRA reservation and DXT5's quarter (a 2048
+texture 3 MiB and 6 MiB: 170 and 85 fit), and the aggregate counts their
+chains as S3TC's blocks even where the CPU decodes them to RGBA, so that every
+GPU allocates alike. Compressed textures are at least 4x4 (Error #3745, here
+`compressedSize`). A compressed texture also takes pixels, as AIR's does, and as AIR
+compresses them, they are encoded to its blocks (`dxt.ts`), so that a GPU with
+S3TC and one without draw them alike. The player injects its native whole-level
+encoder through `setDxtEncoder`; standalone backends and native refusals use the
+TypeScript encoder. `context3d` retains no dependency on `native`.
+The RGBA staging array a texture uploads
+through is made at its first pixel upload or CPU decoding, so compressed
+textures uploaded as blocks on S3TC have none. Samplers must
+read a texture as what it is, AGAL's format DXT1 or DXT5 for a compressed one
+(#3763), where `samplerFormats` is set, as the player sets it for content from
+SWF 17 on. `rgbaHalfFloat` and the packed formats remain unsupported and return
+Error #3708 before backend allocation.
+
+Core failures carry typed reasons. The Flash adapter maps them to catchable AS3
+errors, including resource limits (#3691), disposed objects (#3694), draw bounds
+and AGAL validation/linkage. Known unavailable modes or profiles report an
+asynchronous ErrorEvent #3702 so content can retry baseline. Concurrent requests
+coalesce; requesting again after creation retires the preceding context and
+creates a new one. Broader unchecked-error precedence remains experimental.
+The constructor rejects antialiased host contexts before allocating GPU handles:
+its explicit resolve/present path requires `antialias: false`.
+
+The adapter disposes GPU resources before the host removes the surface. After
+browser context loss, the old surface stays attached so restoration can trigger
+creation of a new context. The host detaches both listeners when removing it.
+Uploads copy source storage before returning; `read()` reuses its output until
+the next read. No AS objects or DOM objects cross the backend's core interface.
+Bitmap uploads for 2D, rectangle and cube textures copy the top-left source
+region and clear uncovered pixels without scaling. A mip upload can reuse a
+larger bitmap; the backend preserves its row stride and reuses the texture's
+base-sized staging array. Cube uploads update only the selected face and mip.
+ByteArray uploads keep their exact selected-mip byte requirements.
+An optional `Stage3DSurface.destroy` hook runs once when the surface is removed,
+after backend disposal and listener removal; it also runs after failed attachment.
+Use it to release the browser context without interfering with loss/restoration.
+
+Sampler filters include nearest, linear and 2×/4×/8×/16× anisotropic filtering.
+WebGL uses cached sampler objects and clamps anisotropy to the extension's
+hardware limit. Without `EXT_texture_filter_anisotropic`, those requests use
+linear filtering with the requested mip mode. Capability queries happen only on
+the first anisotropic draw; warmed sampler changes allocate no new GPU objects.
+
+Texture targets support hardware-dependent antialiasing requests up to 4×,
+falling back to single-sample rendering when no compatible count is available.
+The backend caches target attachments, retains color/depth across rebindings,
+and resolves changed color before generating mipmaps. Warm target switches
+allocate no GPU handles. Cube resolves use a cached 2D surface and a GPU copy,
+which avoids corrupted direct multisample-to-cube blits in SwiftShader.
+
+The Flash adapter reclaims resources after their AS wrappers become unreachable.
+Active vertex, program, texture and render-target bindings keep their wrappers
+alive until replaced, cleared or disposed. Explicit disposal and context teardown
+release storage immediately. Allocation failures also reclaim already collected
+wrappers whose finalizers have not run, then retry once. Garbage collection is
+not prompt or guaranteed; explicit disposal remains preferable, and the hard
+resource budgets still apply. Direct backend callers own their resources and
+must dispose them or the context.
+
+The current API and validation are experimental. Supported operations, AIR
+references, unsupported formats/profiles and lifecycle stress tests are tracked
+in [tests/context3d](../../tests/context3d/README.md). Stage3D playback remains off
+by default. A web host can explicitly opt in before loading its first player:
+
+```ts
+import { configure } from "@swf2es/web";
+import { WebGLContext3D } from "@swf2es/context3d/webgl";
+
+configure({
+  stage3D: () => {
+    const canvas = document.createElement("canvas");
+    const gl = canvas.getContext("webgl2", {
+      alpha: false, antialias: false, depth: false, stencil: false,
+      preserveDrawingBuffer: true,
+    });
+    if (!gl) {
+      throw new Error("WebGL2 is unavailable");
+    }
+
+    return {
+      canvas,
+      context: new WebGLContext3D(gl, {
+        maxBufferBytes: 64 * 1024 * 1024,
+        maxTextureBytes: 128 * 1024 * 1024,
+        maxTargetDepthBytes: 16 * 1024 * 1024,
+        maxTargetColorBytes: 16 * 1024 * 1024,
+      }),
+      destroy: () => gl.getExtension("WEBGL_lose_context")?.loseContext(),
+    };
+  },
+});
+```
+
+Each requested slot needs a fresh surface. `configure({ stage3D: null })` disables
+the experiment for subsequent loads. The web element owns native installation,
+composition, cancellation, restoration and teardown for each load. GPU backend
+selection stays with the host; the default web entry does not eagerly import
+the optional bindings or a backend. No new dependencies are required by `web`.
+
+The web package sets no backend budgets: a factory using `new WebGLContext3D(gl)`
+inherits the larger AIR-sized defaults, as the desktop factory does. This browser
+example explicitly selects lower aggregate and attachment budgets per context;
+they are host policy, not AIR limits or a guarantee against context loss. Tune
+them for the workload and account for concurrent slots and players. The limits
+exclude driver overhead and back-buffer attachments, so the browser can still
+lose a context before a logical allocation limit is reached. The public demo
+keeps Stage3D off by default; its experimental checkbox opts in with these lower budgets.
+
+Stage3D positions follow the embedding's `scale`/`salign` placement. Configured
+buffer sizes remain in pixels; resizing or changing device pixel ratio never
+implicitly reallocates them. The host clips the viewports, makes the display
+list transparent while contexts exist, and keeps overlapping players' canvases
+in separate stacks. With Stage3D opted in, the web host honors ActionScript
+changes to `Stage.scaleMode` and `Stage.align`. Ordinary playback retains dev's
+fixed Stage getters, ignored setters and authored dimensions, including its
+existing embedding alignment when both opposite edges are named. In `noScale`, Stage dimensions follow the
+embedding's CSS size and resize events are synchronous after placement updates;
+other modes report the authored dimensions. Display-list pixels and input use
+the same viewport, including coordinates outside the authored rectangle.
+A DPR change affects display-list resolution without changing Stage dimensions
+or reallocating Stage3D buffers. Script settings override embedding defaults
+independently. The desktop app offers the same host through View › Stage3D
+(Experimental), off by default, with a remembered choice that restarts the
+movie when changed. It uses the backend's per-type resource count limits and
+byte budgets. The public demo lazily loads the backend when Stage3D is selected
+and restarts the current SWF when the option changes. Its Restart and Close
+controls release the preceding contexts. Best-resolution buffers remain later
+work. None of this changes the ActionScript Worker API.
+
+A future WebGPU backend can reuse the Flash adapter, resource contracts and AIR
+fixtures. It still needs AGAL-to-WGSL translation, GPU resource/binding handling,
+render-pipeline caching and device-loss recovery. Immediate readback needs a
+separate execution design: `Context3D.read()` returns synchronously to Flash,
+while WebGPU's [`GPUBuffer.mapAsync`](https://gpuweb.github.io/types/interfaces/GPUBuffer.html#mapAsync)
+provides CPU access asynchronously. A worker bridge or another way to suspend
+Flash execution would need validation before full compatibility could be claimed.
+
+The display list and Stage3D use separate canvases. Display-list blend effects
+sample the transparent 2D back buffer rather than Stage3D color, so blending
+across those layers is an experimental limitation. `Playback.destroy()` disposes
+the display-list scene before the renderer on ordinary loads as well as Stage3D
+loads; this intentional shared cleanup releases cached text-style listeners.
+
+Draw validation caches index-range summaries by upload version. Fully uploaded
+vertex prefixes need no per-attribute index scan; sparse validation caches also
+include the vertex version. Uploads, changed ranges/bindings and disposal
+invalidate the relevant records. Warm draws add no validation arrays or GPU
+handles.

package/dist/agal.d.ts

@@ -0,0 +1,23 @@
+export type ProgramType = "vertex" | "fragment";
+export interface SamplerSource {
+    index: number;
+    /** What the sampler reads: 0 RGBA, 1 DXT1 ("compressed"), 2 DXT5 ("compressedAlpha"). */
+    format: number;
+    filter: number;
+    repeat: boolean;
+    mip: number;
+    cube: boolean;
+    ignore: boolean;
+    bias: number;
+}
+export interface ShaderSource {
+    source: string;
+    /** Written lanes for vertex programs, read lanes for fragment programs. */
+    varyings: Uint8Array;
+    attributes: number[];
+    constants: number[];
+    indirect: boolean;
+    samplers: SamplerSource[];
+}
+export declare function translate(bytes: Uint8Array, stage: ProgramType): ShaderSource;
+//# sourceMappingURL=agal.d.ts.map

package/dist/agal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"agal.d.ts","sourceRoot":"","sources":["../src/agal.ts"],"names":[],"mappings":"AAKA,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAC;AAEhD,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,yFAAyF;IACzF,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,2EAA2E;IAC3E,QAAQ,EAAE,UAAU,CAAC;IACrB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,aAAa,EAAE,CAAC;CAC3B;AAQD,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW,GAAG,YAAY,CA4c7E"}