@realsee/equirect-toolbox 1.0.0

package/dist/rectlinear.js

@@ -0,0 +1,128 @@
+import { dirname, extname, resolve } from "path";
+import { fileURLToPath } from "url";
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from "fs";
+import { loadImage } from "@napi-rs/canvas";
+import { Ajv2020 } from "ajv/dist/2020.js";
+import * as THREE from "three";
+import { createHeadlessRenderer } from "./lib/headless-three.js";
+const templateNames = {
+    euler: "rectlinear-euler.json",
+    matrix: "rectlinear-matrix.json",
+    quaternion: "rectlinear-quaternion.json",
+};
+export async function renderRectlinear(options) {
+    const config = readRectlinearConfig(options.config);
+    const outputFormat = getOutputFormat(options.output);
+    const quality = options.quality ?? 95;
+    const image = await loadImage(resolve(options.input));
+    const { canvas, renderer } = await createHeadlessRenderer(config.viewport.width, config.viewport.height);
+    try {
+        const texture = new THREE.Texture(image);
+        texture.minFilter = THREE.LinearFilter;
+        texture.magFilter = THREE.LinearFilter;
+        texture.needsUpdate = true;
+        const geometry = new THREE.SphereGeometry(10, 64, 40);
+        geometry.scale(-1, 1, 1);
+        const material = new THREE.MeshBasicMaterial({ map: texture });
+        const mesh = new THREE.Mesh(geometry, material);
+        const scene = new THREE.Scene();
+        scene.add(mesh);
+        const camera = new THREE.PerspectiveCamera(config.camera.vfov, config.viewport.width / config.viewport.height, 0.1, 100);
+        applyCameraPose(camera, config);
+        renderer.setSize(config.viewport.width, config.viewport.height, false);
+        renderer.render(scene, camera);
+        const buffer = outputFormat === "image/jpeg"
+            ? canvas.toBuffer(outputFormat, quality)
+            : canvas.toBuffer(outputFormat);
+        mkdirSync(dirname(resolve(options.output)), { recursive: true });
+        writeFileSync(resolve(options.output), buffer);
+        texture.dispose();
+        material.dispose();
+    }
+    finally {
+        renderer.dispose();
+    }
+}
+export function initializeRectlinearConfig(type, output) {
+    if (!isRectlinearPoseType(type)) {
+        throw new Error(`Unknown rectlinear config type: ${type}. Expected euler, matrix, or quaternion.`);
+    }
+    const templatePath = findTemplate(templateNames[type]);
+    const template = readFileSync(templatePath, "utf8");
+    mkdirSync(dirname(resolve(output)), { recursive: true });
+    writeFileSync(resolve(output), template.endsWith("\n") ? template : `${template}\n`, "utf8");
+}
+function readRectlinearConfig(path) {
+    let config;
+    try {
+        config = JSON.parse(readFileSync(resolve(path), "utf8"));
+    }
+    catch (error) {
+        throw new Error(`Unable to read rectlinear config ${path}: ${getErrorMessage(error)}`);
+    }
+    validateRectlinearConfig(config);
+    return config;
+}
+export function validateRectlinearConfig(value) {
+    let schema;
+    try {
+        schema = JSON.parse(readFileSync(findSchema(), "utf8"));
+    }
+    catch (error) {
+        throw new Error(`Unable to read rectlinear schema: ${getErrorMessage(error)}`);
+    }
+    const ajv = new Ajv2020({ allErrors: true, strict: true });
+    const validate = ajv.compile(schema);
+    if (!validate(value)) {
+        throw new Error(`Invalid rectlinear config:\n${ajv.errorsText(validate.errors, { separator: "\n" })}`);
+    }
+}
+function applyCameraPose(camera, config) {
+    const { camera: pose } = config;
+    if ("yaw" in pose) {
+        camera.rotation.set(degreesToRadians(pose.pitch), degreesToRadians(pose.yaw), degreesToRadians(pose.roll), "YXZ");
+        return;
+    }
+    if ("matrix" in pose) {
+        const matrix = pose.matrix;
+        camera.rotation.setFromRotationMatrix(new THREE.Matrix4().set(matrix[0], matrix[1], matrix[2], 0, matrix[3], matrix[4], matrix[5], 0, matrix[6], matrix[7], matrix[8], 0, 0, 0, 0, 1));
+        return;
+    }
+    camera.quaternion.set(pose.quaternion.x, pose.quaternion.y, pose.quaternion.z, pose.quaternion.w);
+}
+function getOutputFormat(output) {
+    const extension = extname(output).toLowerCase();
+    if (extension === ".jpg" || extension === ".jpeg")
+        return "image/jpeg";
+    if (extension === ".png")
+        return "image/png";
+    throw new Error(`Unsupported output format ${extension || "(missing extension)"}. Use .jpg, .jpeg, or .png.`);
+}
+function findTemplate(name) {
+    const moduleRootTemplate = resolve(dirname(fileURLToPath(import.meta.url)), "../configs/templates", name);
+    if (existsSync(moduleRootTemplate))
+        return moduleRootTemplate;
+    const workingDirectoryTemplate = resolve(process.cwd(), "configs/templates", name);
+    if (existsSync(workingDirectoryTemplate))
+        return workingDirectoryTemplate;
+    throw new Error(`Rectlinear template not found: ${name}`);
+}
+function findSchema() {
+    const moduleRootSchema = resolve(dirname(fileURLToPath(import.meta.url)), "../configs/schema/rectlinear.schema.json");
+    if (existsSync(moduleRootSchema))
+        return moduleRootSchema;
+    const workingDirectorySchema = resolve(process.cwd(), "configs/schema/rectlinear.schema.json");
+    if (existsSync(workingDirectorySchema))
+        return workingDirectorySchema;
+    throw new Error("Rectlinear schema not found: configs/schema/rectlinear.schema.json");
+}
+function isRectlinearPoseType(value) {
+    return value === "euler" || value === "matrix" || value === "quaternion";
+}
+function degreesToRadians(value) {
+    return (value * Math.PI) / 180;
+}
+function getErrorMessage(error) {
+    return error instanceof Error ? error.message : String(error);
+}
+//# sourceMappingURL=rectlinear.js.map

package/dist/rectlinear.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rectlinear.js","sourceRoot":"","sources":["../src/rectlinear.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,IAAI,CAAC;AACxE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAEjE,MAAM,aAAa,GAAuC;IACxD,KAAK,EAAE,uBAAuB;IAC9B,MAAM,EAAE,wBAAwB;IAChC,UAAU,EAAE,4BAA4B;CACzC,CAAC;AAwCF,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,OAA0B;IAC/D,MAAM,MAAM,GAAG,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACpD,MAAM,YAAY,GAAG,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACrD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;IACtC,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IACtD,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,sBAAsB,CACvD,MAAM,CAAC,QAAQ,CAAC,KAAK,EACrB,MAAM,CAAC,QAAQ,CAAC,MAAM,CACvB,CAAC;IAEF,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,IAAI,KAAK,CAAC,OAAO,CAC/B,KAAkE,CACnE,CAAC;QACF,OAAO,CAAC,SAAS,GAAG,KAAK,CAAC,YAAY,CAAC;QACvC,OAAO,CAAC,SAAS,GAAG,KAAK,CAAC,YAAY,CAAC;QACvC,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;QAE3B,MAAM,QAAQ,GAAG,IAAI,KAAK,CAAC,cAAc,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QACtD,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACzB,MAAM,QAAQ,GAAG,IAAI,KAAK,CAAC,iBAAiB,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;QAC/D,MAAM,IAAI,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAChD,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QAChC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAEhB,MAAM,MAAM,GAAG,IAAI,KAAK,CAAC,iBAAiB,CACxC,MAAM,CAAC,MAAM,CAAC,IAAI,EAClB,MAAM,CAAC,QAAQ,CAAC,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,EAC9C,GAAG,EACH,GAAG,CACJ,CAAC;QACF,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAEhC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACvE,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAE/B,MAAM,MAAM,GACV,YAAY,KAAK,YAAY;YAC3B,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;YACxC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QACpC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACjE,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;QAC/C,OAAO,CAAC,OAAO,EAAE,CAAC;QAClB,QAAQ,CAAC,OAAO,EAAE,CAAC;IACrB,CAAC;YAAS,CAAC;QACT,QAAQ,CAAC,OAAO,EAAE,CAAC;IACrB,CAAC;AACH,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,IAAY,EAAE,MAAc;IACrE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CACb,mCAAmC,IAAI,0CAA0C,CAClF,CAAC;IACJ,CAAC;IAED,MAAM,YAAY,GAAG,YAAY,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;IACvD,MAAM,QAAQ,GAAG,YAAY,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IACpD,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACzD,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,IAAI,EAAE,MAAM,CAAC,CAAC;AAC/F,CAAC;AAED,SAAS,oBAAoB,CAAC,IAAY;IACxC,IAAI,MAAe,CAAC;IACpB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IAC3D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,oCAAoC,IAAI,KAAK,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACzF,CAAC;IAED,wBAAwB,CAAC,MAAM,CAAC,CAAC;IACjC,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,KAAc;IACrD,IAAI,MAAe,CAAC;IACpB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,qCAAqC,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACjF,CAAC;IAED,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3D,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,MAAiC,CAAC,CAAC;IAChE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CACb,+BAA+B,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,CACtF,CAAC;IACJ,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CAAC,MAA+B,EAAE,MAAwB;IAChF,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;IAChC,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAClB,MAAM,CAAC,QAAQ,CAAC,GAAG,CACjB,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,EAC5B,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,EAC1B,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAC3B,KAAK,CACN,CAAC;QACF,OAAO;IACT,CAAC;IACD,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;QACrB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,MAAM,CAAC,QAAQ,CAAC,qBAAqB,CACnC,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC,GAAG,CACrB,MAAM,CAAC,CAAC,CAAC,EACT,MAAM,CAAC,CAAC,CAAC,EACT,MAAM,CAAC,CAAC,CAAC,EACT,CAAC,EACD,MAAM,CAAC,CAAC,CAAC,EACT,MAAM,CAAC,CAAC,CAAC,EACT,MAAM,CAAC,CAAC,CAAC,EACT,CAAC,EACD,MAAM,CAAC,CAAC,CAAC,EACT,MAAM,CAAC,CAAC,CAAC,EACT,MAAM,CAAC,CAAC,CAAC,EACT,CAAC,EACD,CAAC,EACD,CAAC,EACD,CAAC,EACD,CAAC,CACF,CACF,CAAC;QACF,OAAO;IACT,CAAC;IACD,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;AACpG,CAAC;AAED,SAAS,eAAe,CAAC,MAAc;IACrC,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;IAChD,IAAI,SAAS,KAAK,MAAM,IAAI,SAAS,KAAK,OAAO;QAAE,OAAO,YAAY,CAAC;IACvE,IAAI,SAAS,KAAK,MAAM;QAAE,OAAO,WAAW,CAAC;IAC7C,MAAM,IAAI,KAAK,CACb,6BAA6B,SAAS,IAAI,qBAAqB,6BAA6B,CAC7F,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,IAAY;IAChC,MAAM,kBAAkB,GAAG,OAAO,CAChC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EACvC,sBAAsB,EACtB,IAAI,CACL,CAAC;IACF,IAAI,UAAU,CAAC,kBAAkB,CAAC;QAAE,OAAO,kBAAkB,CAAC;IAE9D,MAAM,wBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,mBAAmB,EAAE,IAAI,CAAC,CAAC;IACnF,IAAI,UAAU,CAAC,wBAAwB,CAAC;QAAE,OAAO,wBAAwB,CAAC;IAE1E,MAAM,IAAI,KAAK,CAAC,kCAAkC,IAAI,EAAE,CAAC,CAAC;AAC5D,CAAC;AAED,SAAS,UAAU;IACjB,MAAM,gBAAgB,GAAG,OAAO,CAC9B,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EACvC,0CAA0C,CAC3C,CAAC;IACF,IAAI,UAAU,CAAC,gBAAgB,CAAC;QAAE,OAAO,gBAAgB,CAAC;IAE1D,MAAM,sBAAsB,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,uCAAuC,CAAC,CAAC;IAC/F,IAAI,UAAU,CAAC,sBAAsB,CAAC;QAAE,OAAO,sBAAsB,CAAC;IAEtE,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;AACxF,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAa;IACzC,OAAO,KAAK,KAAK,OAAO,IAAI,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,YAAY,CAAC;AAC3E,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAa;IACrC,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC;AACjC,CAAC;AAED,SAAS,eAAe,CAAC,KAAc;IACrC,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAChE,CAAC"}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@realsee/equirect-toolbox",
+  "version": "1.0.0",
+  "description": "Node.js CLI tools for rectlinear screenshots and equirectangular-to-cubemap conversion.",
+  "keywords": [
+    "cli",
+    "cube-map",
+    "cubemap",
+    "equirectangular",
+    "panorama",
+    "rectlinear",
+    "three.js"
+  ],
+  "bin": {
+    "equirect-toolbox": "dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "configs"
+  ],
+  "type": "module",
+  "main": "dist/cli.js",
+  "types": "dist/cli.d.ts",
+  "exports": {
+    "./rectlinear": {
+      "types": "./dist/rectlinear.d.ts",
+      "import": "./dist/rectlinear.js",
+      "default": "./dist/rectlinear.js"
+    },
+    "./cube2equirect": {
+      "types": "./dist/cube2equirect.d.ts",
+      "import": "./dist/cube2equirect.js",
+      "default": "./dist/cube2equirect.js"
+    },
+    "./equirect2cube": {
+      "types": "./dist/equirect2cube.d.ts",
+      "import": "./dist/equirect2cube.js",
+      "default": "./dist/equirect2cube.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit",
+    "lint": "oxlint",
+    "format": "oxfmt",
+    "format:check": "oxfmt --check",
+    "prepack": "npm run build",
+    "prepublishOnly": "npm run format:check && npm run typecheck && npm run lint",
+    "pack:check": "npm pack --dry-run"
+  },
+  "dependencies": {
+    "@napi-rs/canvas": "^0.1.78",
+    "ajv": "8.17.1",
+    "commander": "^15.0.0",
+    "gl": "^8.1.6",
+    "three": "0.149.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.20.1",
+    "@types/three": "0.149.0",
+    "oxfmt": "^0.64.0",
+    "oxlint": "^1.79.0",
+    "tsx": "^4.19.0",
+    "typescript": "^5.6.0"
+  },
+  "engines": {
+    "node": "^20 || ^22"
+  }
+}