pngine 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +121 -0
- package/dist/cli.js +6691 -0
- package/dist/viewer.d.ts +60 -0
- package/dist/viewer.js +2 -0
- package/package.json +80 -0
package/dist/viewer.d.ts
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
export type DOMQueryString = string;
|
|
2
|
+
export type URL = string;
|
|
3
|
+
/**
|
|
4
|
+
* The JSON Code String is a JSON of an object like
|
|
5
|
+
* PngineAnimation (@see src/pngine.ts)
|
|
6
|
+
*/
|
|
7
|
+
export type JSONAnimationString = string;
|
|
8
|
+
export interface WorkerOptions {
|
|
9
|
+
/** Canvas element whose contents will be replaced with the OffscreenCanvas. */
|
|
10
|
+
canvas?: HTMLCanvasElement;
|
|
11
|
+
/** Compiled PNGine animation blob (output of buildAnimation). */
|
|
12
|
+
animation: Blob;
|
|
13
|
+
/** Optional override for the worker script URL (defaults to payload). */
|
|
14
|
+
workerURL?: string;
|
|
15
|
+
}
|
|
16
|
+
export interface WorkerController {
|
|
17
|
+
/** Draws a frame at time t (seconds) with optional inputs merged into uniforms. Fire-and-forget. */
|
|
18
|
+
draw: (t: number, frameId?: string, inputs?: Record<string, any>) => void;
|
|
19
|
+
/** Returns a promise that resolves when GPU is ready for next draw. */
|
|
20
|
+
ready: () => Promise<void>;
|
|
21
|
+
/** Reads GPU output into ImageData at the provided time/frame. */
|
|
22
|
+
read: (t: number, f?: string) => Promise<ImageData>;
|
|
23
|
+
/** Returns shader compilation info and errors. */
|
|
24
|
+
info: () => Promise<{
|
|
25
|
+
type: "info-result";
|
|
26
|
+
result: {
|
|
27
|
+
shaderModules: {
|
|
28
|
+
shaderModuleId: string;
|
|
29
|
+
messages: GPUCompilationMessage[];
|
|
30
|
+
compileMs?: number;
|
|
31
|
+
}[];
|
|
32
|
+
pipelines: {
|
|
33
|
+
pipelineId: string;
|
|
34
|
+
kind: string;
|
|
35
|
+
createMs?: number;
|
|
36
|
+
errors: {
|
|
37
|
+
scope: string;
|
|
38
|
+
message: string;
|
|
39
|
+
type: string;
|
|
40
|
+
}[];
|
|
41
|
+
}[];
|
|
42
|
+
};
|
|
43
|
+
}>;
|
|
44
|
+
/** Terminates the underlying worker and releases resources. */
|
|
45
|
+
terminate: () => void;
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Creates a stateless PNGine viewer from a compiled PNG animation.
|
|
49
|
+
*
|
|
50
|
+
* Simple API:
|
|
51
|
+
* - draw(t, frameId, inputs?) - render a frame (fire-and-forget)
|
|
52
|
+
* - ready() - await GPU completion before next draw
|
|
53
|
+
* - read(t, f?) - capture frame as ImageData
|
|
54
|
+
* - info() - get shader diagnostics
|
|
55
|
+
* - terminate() - cleanup
|
|
56
|
+
*
|
|
57
|
+
* @param options WorkerOptions object containing canvas and animation blob.
|
|
58
|
+
* @returns A Promise that resolves to a WorkerController.
|
|
59
|
+
*/
|
|
60
|
+
export declare function viewer(options: WorkerOptions): Promise<WorkerController>;
|
package/dist/viewer.js
ADDED
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
async function I(r,n="gzip"){if(typeof DecompressionStream>"u")throw new Error("DecompressionStream API is not supported in this environment.");let t=r instanceof Uint8Array?r:new Uint8Array(r),a=new Blob([t.buffer.slice(t.byteOffset,t.byteOffset+t.byteLength)]).stream(),c=new DecompressionStream(n),p=a.pipeThrough(c);return await new Response(p).arrayBuffer()}function M(r){let n=8,t=[];for(;n<r.length&&!(n+8>r.length);){let c=new DataView(r.buffer,r.byteOffset+n,8).getUint32(0,!1),p=new TextDecoder().decode(r.subarray(n+4,n+8)),l=r.subarray(n+8,n+8+c);t.push({type:p,data:l}),n+=8+c+4}return t}function A(r,n){let t={};for(let{type:a,data:c}of r)n&&!n.includes(a)||!(a[0]===a[0].toLowerCase()&&a[1]===a[1].toLowerCase())||(t[a]=c);return t}async function R(r){let n=new Response(r.buffer.slice(r.byteOffset,r.byteOffset+r.byteLength)).body,t=new DecompressionStream("gzip"),a=n.pipeThrough(t),c=await new Response(a).arrayBuffer();return new TextDecoder().decode(c)}async function V(r){return await R(r)}async function _(r){let n=null;r.canvas?n=r.canvas:n=document.querySelector("canvas");let t=n.cloneNode(!0);n.parentNode?.replaceChild(t,n);let a=globalThis.devicePixelRatio,c=t.clientWidth||t.width||800,p=t.clientHeight||t.height||600;t.width=c*a,t.height=p*a;let l,C=[],v,f,x=await r.animation.arrayBuffer(),U=M(new Uint8Array(x)),F=A(U,["anIm"]),P=await V(F.anIm);try{let{instructions:e,interpreter:s,assetsMeta:d}=JSON.parse(P);if(C=typeof e=="string"?JSON.parse(e):e,typeof s=="string"){let o=s.trim().replace(/\s+/g,"");if(o.length%4===0&&/^[A-Za-z0-9+/=]+$/.test(o))try{l=atob(o)}catch{l=s}else l=s}else if(s&&typeof s=="object"){let u=s.code;typeof u=="string"&&(l=u)}if(!l)throw new Error("PNGINE: Unsupported interpreter payload format.");if(!Array.isArray(d))throw new Error("PNGINE: Assets metadata missing from payload.");v=d}catch(e){throw new Error(`PNGINE: The provided string is not a JSON of an "{ instructions: ..., interpreter: ... }" object.
|
|
2
|
+
`+e.message)}let S=A(U,v.map(({chunkId:e})=>e)),D={},k={},E=[];for(let e of v){e.buffer=await I(S[e.chunkId]);let s=(()=>{if(!e.url||typeof e.url!="string")return e.url;try{return new URL(e.url,globalThis.location?.href).href}catch{return e.url}})();e.url=s,D[e.name]=e,e.chunkId&&e.chunkId.startsWith("vid")?k[e.name]={name:e.name,chunkId:e.chunkId,url:s,mime:e.mime,kind:"video",loop:e.loop}:(k[e.name]=e,E.push(e.buffer))}let B=new Blob([l],{type:"application/javascript"}),O=URL.createObjectURL(B);f=new Worker(O);let g=new Map,T=async()=>{let e=v.filter(s=>s.chunkId&&s.chunkId.startsWith("vid"));for(let s of e){let d=new Blob([s.buffer],{type:s.mime}),u=URL.createObjectURL(d),o=document.createElement("video");o.src=u,o.loop=s.loop||!1,o.autoplay=!0,o.muted=!0,o.playsInline=!0,g.set(s.name,{element:o,ready:!1,width:0,height:0}),await new Promise(L=>{o.addEventListener("loadedmetadata",()=>{let i=g.get(s.name);i.width=o.videoWidth,i.height=o.videoHeight,L()})}),await o.play(),g.get(s.name).ready=!0}};return new Promise(async(e,s)=>{if(t){let d=t.transferControlToOffscreen();d.width=c*a,d.height=p*a;let u=(i,w={})=>new Promise(m=>{let y=({data:h})=>{h.type===`${i}-result`&&(f.removeEventListener("message",y),m(h))};f.addEventListener("message",y),f.postMessage({action:i,...w})});f.addEventListener("message",i=>{i.data==="init-done"&&e({draw:(m,y,h)=>{f.postMessage({action:"draw",t:m,f:y,inputs:h})},ready:async()=>{await u("ready")},read:async(m,y)=>{let{result:h}=await u("read",{t:m,f:y}),b=new Uint8ClampedArray(h);return new ImageData(b,t.width,t.height)},terminate:()=>{f.terminate()},info:()=>u("info")})}),await T();let o=()=>{for(let[i,{element:w,ready:m,width:y,height:h}]of g)if(m&&!(w.readyState<w.HAVE_CURRENT_DATA))try{let b=new VideoFrame(w);f.postMessage({type:"updateVideoFrame",name:i,width:y,height:h,frame:b},[b])}catch{}};if(o(),f.postMessage({action:"init",canvas:d,animation:C,assets:k},[d,...E]),"requestVideoFrameCallback"in HTMLVideoElement.prototype&&g.size>0)g.forEach(({element:i},w)=>{let m=()=>{o(),i.requestVideoFrameCallback(m)};i.requestVideoFrameCallback(m)});else if(g.size>0){let i=()=>{o(),requestAnimationFrame(i)};requestAnimationFrame(i)}}})}export{_ as viewer};
|
package/package.json
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "pngine",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Embed interactive WebGPU scenes inside PNG files",
|
|
5
|
+
"author": "HugoDaniel",
|
|
6
|
+
"license": "CC0-1.0",
|
|
7
|
+
"type": "module",
|
|
8
|
+
"main": "dist/viewer.js",
|
|
9
|
+
"module": "dist/viewer.js",
|
|
10
|
+
"types": "dist/viewer.d.ts",
|
|
11
|
+
"bin": {
|
|
12
|
+
"pngine": "dist/cli.js"
|
|
13
|
+
},
|
|
14
|
+
"exports": {
|
|
15
|
+
".": {
|
|
16
|
+
"types": "./dist/viewer.d.ts",
|
|
17
|
+
"import": "./dist/viewer.js",
|
|
18
|
+
"default": "./dist/viewer.js"
|
|
19
|
+
}
|
|
20
|
+
},
|
|
21
|
+
"files": [
|
|
22
|
+
"dist/viewer.js",
|
|
23
|
+
"dist/viewer.d.ts",
|
|
24
|
+
"dist/cli.js"
|
|
25
|
+
],
|
|
26
|
+
"scripts": {
|
|
27
|
+
"build:viewer": "esbuild src/viewer.ts --bundle --outfile=dist/viewer.js --target=es2023 --minify --platform=neutral --define:INTERACTIVE=false --legal-comments=none --drop:console",
|
|
28
|
+
"build:cli": "pnpm run _interpreter && esbuild src/cli.ts --bundle --outfile=dist/cli.js --target=es2023 --platform=node --format=esm --define:INTERACTIVE=false --banner:js='#!/usr/bin/env node'",
|
|
29
|
+
"build:types": "tsc -p tsconfig.build.json",
|
|
30
|
+
"build:viewer:dev": "esbuild src/viewer.ts --bundle --outfile=dist/viewer.js --target=es2023 --platform=neutral --define:INTERACTIVE=true --sourcemap",
|
|
31
|
+
"build:cli:dev": "pnpm run _interpreter:dev && esbuild src/cli.ts --bundle --outfile=dist/cli.js --target=es2023 --platform=node --format=esm --define:INTERACTIVE=true --banner:js='#!/usr/bin/env node'",
|
|
32
|
+
"build": "pnpm run build:viewer && pnpm run build:cli && pnpm run build:types",
|
|
33
|
+
"build:dev": "pnpm run build:viewer:dev && pnpm run build:cli:dev",
|
|
34
|
+
"cli": "pnpm run build:cli:dev && node dist/cli.js",
|
|
35
|
+
"test": "pnpm run test:cli",
|
|
36
|
+
"test:cli": "pnpm exec tsx tests/cli.ts",
|
|
37
|
+
"test:browser": "pnpm run _wasm:test && pnpm run build:viewer && pnpm run _interpreter:dev && pnpm run _copy-mocha && esbuild tests/runner.ts --bundle --outdir=tests/js --watch=forever --servedir=tests --platform=browser --alias:mocha=./tests/shims/mocha-browser-shim.ts --alias:mocha/mocha.js=./tests/shims/mocha-browser-entry.ts --external:stream --external:util --external:node:util --external:node:path --external:node:fs --external:node:url --external:tty --external:os --external:fs --external:path",
|
|
38
|
+
"wasm:cube": "asc src/as/cube.ts --config src/as/cube.asconfig.json --target release --enable simd",
|
|
39
|
+
"wasm:cube:dev": "asc src/as/cube.ts --config src/as/cube.asconfig.json --target debug --enable simd --debug --sourceMap",
|
|
40
|
+
"wasm:mvp": "asc src/as/mvp.ts --config src/as/mvp.asconfig.json --target release --enable simd",
|
|
41
|
+
"wasm:mvp:dev": "asc src/as/mvp.ts --config src/as/mvp.asconfig.json --target debug --enable simd --debug --sourceMap",
|
|
42
|
+
"wasm:torus": "asc src/as/torus.ts --config src/as/torus.asconfig.json --target release --enable simd",
|
|
43
|
+
"wasm:camera": "asc src/as/camera.ts --config src/as/camera.asconfig.json --target release --enable simd",
|
|
44
|
+
"wasm:unitcube": "asc src/as/unitcube.ts --config src/as/unitcube.asconfig.json --target release --enable simd",
|
|
45
|
+
"wasm:primitives": "asc src/as/primitives.ts --config src/as/primitives.asconfig.json --target release --enable simd",
|
|
46
|
+
"clean": "rm -rf dist/* src/as/build src/interpreter.string.ts",
|
|
47
|
+
"_interpreter": "esbuild src/worker.ts --bundle --outfile=dist/interpreter.js --target=es2023 --minify --platform=neutral --define:INTERACTIVE=false --legal-comments=none --drop:console && pnpm run _interpreter:embed",
|
|
48
|
+
"_interpreter:dev": "esbuild src/worker.ts --bundle --outfile=dist/interpreter.js --target=es2023 --platform=neutral --define:INTERACTIVE=true && pnpm run _interpreter:embed",
|
|
49
|
+
"_interpreter:embed": "cat dist/interpreter.js | base64 > dist/interpreter.base64 && echo $'export const interpreterString=\\x60' > src/interpreter.string.ts && cat dist/interpreter.base64 >> src/interpreter.string.ts && echo $'\\x60;' >> src/interpreter.string.ts",
|
|
50
|
+
"_copy-mocha": "node tools/copy-mocha-assets.mjs",
|
|
51
|
+
"_wasm:test": "pnpm run wasm:torus && pnpm run wasm:cube && pnpm run wasm:cube:dev && pnpm run wasm:mvp && pnpm run wasm:mvp:dev && cp src/as/build/*.wasm tests/as/ && (cp src/as/build/*.wasm.map tests/as/ || true)",
|
|
52
|
+
"prepack": "node scripts/generate-package-json.mjs"
|
|
53
|
+
},
|
|
54
|
+
"keywords": [
|
|
55
|
+
"webgpu",
|
|
56
|
+
"png",
|
|
57
|
+
"graphics",
|
|
58
|
+
"shader",
|
|
59
|
+
"wgsl"
|
|
60
|
+
],
|
|
61
|
+
"devDependencies": {
|
|
62
|
+
"@types/chai": "^5.2.2",
|
|
63
|
+
"@types/mocha": "^10.0.10",
|
|
64
|
+
"@types/node": "^22.18.11",
|
|
65
|
+
"@webgpu/types": "^0.1.66",
|
|
66
|
+
"assemblyscript": "^0.28.9",
|
|
67
|
+
"chai": "^6.2.0",
|
|
68
|
+
"esbuild": "^0.25.11",
|
|
69
|
+
"jimp": "^1.6.0",
|
|
70
|
+
"json5": "^2.2.3",
|
|
71
|
+
"mocha": "^11.7.4",
|
|
72
|
+
"nyc": "^17.1.0",
|
|
73
|
+
"pixelmatch": "^7.1.0",
|
|
74
|
+
"ts-node": "^10.9.2",
|
|
75
|
+
"tsx": "^4.19.2",
|
|
76
|
+
"typescript": "^5.7.3",
|
|
77
|
+
"vscode-languageserver": "^9.0.1",
|
|
78
|
+
"vscode-languageserver-textdocument": "^1.0.8"
|
|
79
|
+
}
|
|
80
|
+
}
|