@bb-studio/ocio 0.0.2 → 0.0.4

package/README.md

@@ -12,15 +12,44 @@ The native module links against OpenColorIO C++ and runs the OCIO CPU processor
 npm install @bb-studio/ocio
 ```
 
-The npm package exposes the JavaScript API from `@bb-studio/ocio` and a direct wasm loader from `@bb-studio/ocio/wasm`.
+The npm package exposes the JavaScript API from `@bb-studio/ocio`. `createOCIO()` selects the correct WebAssembly loader for the current runtime and resolves the bundled wasm file automatically.
 
-It ships three prebuilt Emscripten artifacts:
+The package ships three internal Emscripten artifacts:
 
 - `dist/ocio-wasm.js`
 - `dist/ocio-wasm.node.js`
 - `dist/ocio-wasm.wasm`
 
-Node.js resolves `@bb-studio/ocio/wasm` to `dist/ocio-wasm.node.js`. Browsers, workers, and other runtimes resolve it to `dist/ocio-wasm.js`. Both wrappers load the same `dist/ocio-wasm.wasm` binary. The browser wrapper is built without Node.js runtime branches, so browser bundlers do not see Node.js built-in imports such as `node:module`.
+Node.js uses `dist/ocio-wasm.node.js`. Browsers, workers, and other runtimes use `dist/ocio-wasm.js`. Both wrappers load the same `dist/ocio-wasm.wasm` binary. The browser wrapper is built without Node.js runtime branches, so browser bundlers do not see Node.js built-in imports such as `node:module`.
+
+## WASM URL Resolution
+
+By default, `createOCIO()` resolves the bundled wasm file with the standard `new URL('../dist/ocio-wasm.wasm', import.meta.url)` pattern.
+
+Vite apps can keep the same import and opt into the built-in Vite asset URL adapter with a resolver condition:
+
+```js
+// vite.config.js
+export default {
+  resolve: {
+    conditions: ['vite', 'module', 'browser', 'development|production']
+  }
+};
+```
+
+Then `createOCIO()` automatically uses the Vite-compatible wasm URL in dev and production builds.
+
+If your app serves static assets from a CDN or public assets directory, pass the wasm URL directly:
+
+```js
+import { createOCIO } from '@bb-studio/ocio';
+
+const ocio = await createOCIO({
+  wasmUrl: '/assets/ocio-wasm.wasm'
+});
+```
+
+Advanced Emscripten users can pass `locateFile` for full control over every auxiliary file lookup.
 
 ## Usage
 

package/THIRD_PARTY_NOTICES.md

@@ -9,6 +9,10 @@ This package includes WebAssembly builds of OpenColorIO.
 - Website: https://opencolorio.org/
 - Source: https://github.com/AcademySoftwareFoundation/OpenColorIO
 
+The bundled WebAssembly build applies a local WebGL GLSL ES compatibility
+patch to OpenColorIO's fixed-function GPU shader generation. See
+`patches/opencolorio/0001-webgl-glsl-es-float-literals.patch`.
+
 Copyright Contributors to the OpenColorIO Project.
 
 Redistribution and use in source and binary forms, with or without

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bb-studio/ocio",
-  "version": "0.0.2",
-  "description": "Real OpenColorIO 2.5 WebAssembly bindings for browser and Node.js.",
+  "version": "0.0.4",
+  "description": "OpenColorIO 2.5 WebAssembly bindings for browser and Node.js.",
   "type": "module",
   "types": "./src/ocio-js.d.ts",
   "imports": {
@@ -13,13 +13,9 @@
   "exports": {
     ".": {
       "types": "./src/ocio-js.d.ts",
+      "vite": "./src/index.vite.js",
       "default": "./src/index.js"
     },
-    "./wasm": {
-      "node": "./dist/ocio-wasm.node.js",
-      "default": "./dist/ocio-wasm.js"
-    },
-    "./wasm.wasm": "./dist/ocio-wasm.wasm",
     "./package.json": "./package.json"
   },
   "scripts": {
@@ -53,10 +49,15 @@
     "dist/ocio-wasm.node.js",
     "dist/ocio-wasm.wasm",
     "src/index.js",
+    "src/index.vite.js",
+    "src/wasm-url.js",
+    "src/wasm-url.vite.js",
     "src/ocio-js.d.ts",
     "README.md",
     "LICENSE",
-    "THIRD_PARTY_NOTICES.md"
+    "THIRD_PARTY_NOTICES.md",
+    "patches/opencolorio/0001-webgl-glsl-es-float-literals.patch",
+    "patches/opencolorio/README.md"
   ],
   "engines": {
     "node": ">=20"

package/patches/opencolorio/0001-webgl-glsl-es-float-literals.patch

@@ -0,0 +1,47 @@
+diff --git a/src/OpenColorIO/ops/fixedfunction/FixedFunctionOpGPU.cpp b/src/OpenColorIO/ops/fixedfunction/FixedFunctionOpGPU.cpp
+index 0ead67f..cfcccd7 100644
+--- a/src/OpenColorIO/ops/fixedfunction/FixedFunctionOpGPU.cpp
++++ b/src/OpenColorIO/ops/fixedfunction/FixedFunctionOpGPU.cpp
+@@ -559,18 +559,18 @@ std::string _Add_Reach_table(
+     ss.indent();
+ 
+     ss.newLine() << ss.floatDecl("i_base") << " = floor(h);";
+-    ss.newLine() << ss.floatDecl("i_lo") << " = i_base + " << table.base_index << ";";
+-    ss.newLine() << ss.floatDecl("i_hi") << " = i_lo + 1;";
++    ss.newLine() << ss.floatDecl("i_lo") << " = i_base + float(" << table.base_index << ");";
++    ss.newLine() << ss.floatDecl("i_hi") << " = i_lo + 1.0;";
+ 
+     if (dimensions == GpuShaderDesc::TEXTURE_1D)
+     {
+-        ss.newLine() << ss.floatDecl("lo") << " = " << ss.sampleTex1D(name, "(i_lo + 0.5) / " + std::to_string(table.total_size)) << ".r;";
+-        ss.newLine() << ss.floatDecl("hi") << " = " << ss.sampleTex1D(name, "(i_hi + 0.5) / " + std::to_string(table.total_size)) << ".r;";
++        ss.newLine() << ss.floatDecl("lo") << " = " << ss.sampleTex1D(name, "(i_lo + 0.5) / " + std::to_string(table.total_size) + ".0") << ".r;";
++        ss.newLine() << ss.floatDecl("hi") << " = " << ss.sampleTex1D(name, "(i_hi + 0.5) / " + std::to_string(table.total_size) + ".0") << ".r;";
+     }
+     else
+     {
+-        ss.newLine() << ss.floatDecl("lo") << " = " << ss.sampleTex2D(name, ss.float2Const("(i_lo + 0.5) / " + std::to_string(table.total_size), "0.0")) << ".r;";
+-        ss.newLine() << ss.floatDecl("hi") << " = " << ss.sampleTex2D(name, ss.float2Const("(i_hi + 0.5) / " + std::to_string(table.total_size), "0.5")) << ".r;";
++        ss.newLine() << ss.floatDecl("lo") << " = " << ss.sampleTex2D(name, ss.float2Const("(i_lo + 0.5) / " + std::to_string(table.total_size) + ".0", "0.0")) << ".r;";
++        ss.newLine() << ss.floatDecl("hi") << " = " << ss.sampleTex2D(name, ss.float2Const("(i_hi + 0.5) / " + std::to_string(table.total_size) + ".0", "0.5")) << ".r;";
+     }
+ 
+     ss.newLine() << ss.floatDecl("t") << " = h - i_base;"; // Hardcoded single degree spacing
+@@ -892,13 +892,13 @@ std::string _Add_Cusp_table(
+ 
+     if (dimensions == GpuShaderDesc::TEXTURE_1D)
+     {
+-        ss.newLine() << ss.float3Decl("lo") << " = " << ss.sampleTex1D(name, std::string("(i_hi - 1 + 0.5) / ") + std::to_string(g.gamut_cusp_table.total_size)) << ".rgb;";
+-        ss.newLine() << ss.float3Decl("hi") << " = " << ss.sampleTex1D(name, std::string("(i_hi + 0.5) / ") + std::to_string(g.gamut_cusp_table.total_size)) << ".rgb;";
++        ss.newLine() << ss.float3Decl("lo") << " = " << ss.sampleTex1D(name, std::string("(float(i_hi) - 1.0 + 0.5) / ") + std::to_string(g.gamut_cusp_table.total_size) + ".0") << ".rgb;";
++        ss.newLine() << ss.float3Decl("hi") << " = " << ss.sampleTex1D(name, std::string("(float(i_hi) + 0.5) / ") + std::to_string(g.gamut_cusp_table.total_size) + ".0") << ".rgb;";
+     }
+     else
+     {
+-        ss.newLine() << ss.float3Decl("lo") << " = " << ss.sampleTex2D(name, ss.float2Const(std::string("(i_hi - 1 + 0.5) / ") + std::to_string(g.gamut_cusp_table.total_size), "0.5")) << ".rgb;";
+-        ss.newLine() << ss.float3Decl("hi") << " = " << ss.sampleTex2D(name, ss.float2Const(std::string("(i_hi + 0.5) / ") + std::to_string(g.gamut_cusp_table.total_size), "0.5")) << ".rgb;";
++        ss.newLine() << ss.float3Decl("lo") << " = " << ss.sampleTex2D(name, ss.float2Const(std::string("(float(i_hi) - 1.0 + 0.5) / ") + std::to_string(g.gamut_cusp_table.total_size) + ".0", "0.5")) << ".rgb;";
++        ss.newLine() << ss.float3Decl("hi") << " = " << ss.sampleTex2D(name, ss.float2Const(std::string("(float(i_hi) + 0.5) / ") + std::to_string(g.gamut_cusp_table.total_size) + ".0", "0.5")) << ".rgb;";
+     }
+ 
+     ss.newLine() << ss.floatDecl("t") << " = (h - " << hues_array_name << "[i_hi - 1]) / "

package/patches/opencolorio/README.md

@@ -0,0 +1,11 @@
+# OpenColorIO Patches
+
+These patches are applied to `OCIO_SOURCE_DIR` by `scripts/build-wasm.sh` before building the WebAssembly OpenColorIO library.
+
+## `0001-webgl-glsl-es-float-literals.patch`
+
+OpenColorIO 2.5 generates GLSL for ACES fixed-function gamut tables in `FixedFunctionOpGPU.cpp`. Some generated expressions mix integer and floating-point values, such as `i_base + 12` or `(i_hi + 0.5) / 360`.
+
+WebGL GLSL ES compilers are stricter than desktop GLSL and may reject those implicit int/float conversions. This patch makes the generated shader code use explicit float casts and float literals, such as `i_base + float(12)` and `/ 360.0`.
+
+Keep this patch small and remove it once the equivalent fix is available in the OpenColorIO version used by this package.

package/src/index.js

@@ -1,3 +1,6 @@
+import OcioWasmModule from '#ocio-wasm';
+import DEFAULT_WASM_URL from './wasm-url.js';
+
 export const ACES_CG_V2_CONFIG = 'ocio://cg-config-v2.2.0_aces-v1.3_ocio-v2.4';
 export const ACES_STUDIO_V2_CONFIG = 'ocio://studio-config-v2.2.0_aces-v1.3_ocio-v2.4';
 export const ACES_CG_V4_CONFIG = 'ocio://cg-config-v4.0.0_aces-v2.0_ocio-v2.5';
@@ -17,7 +20,6 @@ export const OptimizationFlags = Object.freeze({
   DRAFT: -1
 });
 
-const DEFAULT_MODULE_PATH = '#ocio-wasm';
 const DEFAULT_GPU_SHADER_FUNCTION = 'OCIODisplay';
 const DEFAULT_GPU_RESOURCE_PREFIX = 'ocio';
 const GPU_UNIFORM_TYPES = Object.freeze([
@@ -82,16 +84,17 @@ function toPositiveInteger(value, name) {
 }
 
 export async function createOCIO(options = {}) {
-  const moduleFactory = options.moduleFactory ?? (await import(options.modulePath ?? DEFAULT_MODULE_PATH)).default;
+  const moduleFactory = options.moduleFactory ?? OcioWasmModule;
   const userLocateFile = options.locateFile;
+  const wasmUrl = options.wasmUrl == null ? DEFAULT_WASM_URL : String(options.wasmUrl);
   const moduleOptions = {
     ...options.moduleOptions,
     locateFile(path, prefix) {
       if (userLocateFile) {
         return userLocateFile(path, prefix);
       }
-      if (path.endsWith('.wasm')) {
-        return new URL(`../dist/${path}`, import.meta.url).href;
+      if (path === 'ocio-wasm.wasm') {
+        return wasmUrl;
       }
       return prefix + path;
     }

package/src/index.vite.js

@@ -0,0 +1,11 @@
+import { createOCIO as createDefaultOCIO } from './index.js';
+import wasmUrl from './wasm-url.vite.js';
+
+export * from './index.js';
+
+export function createOCIO(options = {}) {
+  if (options.locateFile || options.wasmUrl != null) {
+    return createDefaultOCIO(options);
+  }
+  return createDefaultOCIO({ ...options, wasmUrl });
+}

package/src/ocio-js.d.ts

@@ -19,8 +19,8 @@ export const OptimizationFlags: Readonly<{
 
 export interface CreateOCIOOptions {
   moduleFactory?: (options?: unknown) => Promise<unknown>;
-  modulePath?: string;
   moduleOptions?: Record<string, unknown>;
+  wasmUrl?: string;
   locateFile?: (path: string, prefix: string) => string;
 }
 

package/src/wasm-url.js

@@ -0,0 +1 @@
+export default new URL('../dist/ocio-wasm.wasm', import.meta.url).href;

package/src/wasm-url.vite.js

@@ -0,0 +1,3 @@
+import wasmUrl from '../dist/ocio-wasm.wasm?url';
+
+export default wasmUrl;