@bb-studio/ocio 0.0.3 → 0.0.5

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_WASM_URL = new URL('../dist/ocio-wasm.wasm', import.meta.url).href;
 const DEFAULT_GPU_SHADER_FUNCTION = 'OCIODisplay';
 const DEFAULT_GPU_RESOURCE_PREFIX = 'ocio';
 const GPU_UNIFORM_TYPES = Object.freeze([
@@ -82,8 +84,9 @@ function toPositiveInteger(value, name) {
 }
 
 export async function createOCIO(options = {}) {
-  const moduleFactory = options.moduleFactory ?? (await import('#ocio-wasm')).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) {
@@ -91,7 +94,7 @@ export async function createOCIO(options = {}) {
         return userLocateFile(path, prefix);
       }
       if (path === 'ocio-wasm.wasm') {
-        return DEFAULT_WASM_URL;
+        return wasmUrl;
       }
       return prefix + path;
     }
@@ -297,6 +300,79 @@ export class Config {
     });
   }
 
+  getFileRule(index) {
+    const ruleIndex = Number(index);
+    if (!Number.isInteger(ruleIndex) || ruleIndex < 0) {
+      throw new RangeError('OCIO file rule index must be a non-negative integer');
+    }
+
+    const customKeyCount = this.ocio.module._ocio_config_get_file_rule_custom_key_count(
+      this.handle,
+      ruleIndex
+    );
+    const custom = {};
+    for (let keyIndex = 0; keyIndex < customKeyCount; keyIndex += 1) {
+      const name = this.ocio._string(
+        'ocio_config_get_file_rule_custom_key_name',
+        this.handle,
+        ruleIndex,
+        keyIndex
+      );
+      custom[name] = this.ocio._string(
+        'ocio_config_get_file_rule_custom_key_value',
+        this.handle,
+        ruleIndex,
+        keyIndex
+      );
+    }
+
+    return {
+      index: ruleIndex,
+      name: this.ocio._string('ocio_config_get_file_rule_name', this.handle, ruleIndex),
+      colorSpace: this.ocio._string('ocio_config_get_file_rule_color_space', this.handle, ruleIndex),
+      pattern: this.ocio._string('ocio_config_get_file_rule_pattern', this.handle, ruleIndex),
+      extension: this.ocio._string('ocio_config_get_file_rule_extension', this.handle, ruleIndex),
+      regex: this.ocio._string('ocio_config_get_file_rule_regex', this.handle, ruleIndex),
+      custom
+    };
+  }
+
+  listFileRules() {
+    const count = this.ocio.module._ocio_config_get_num_file_rules(this.handle);
+    return Array.from({ length: count }, (_, index) => this.getFileRule(index));
+  }
+
+  matchFileRule(filePath) {
+    return this.ocio._withCString(filePath, (filePathPtr) => {
+      const colorSpace = this.ocio._string(
+        'ocio_config_get_color_space_from_filepath',
+        this.handle,
+        filePathPtr
+      );
+      if (!colorSpace) {
+        return null;
+      }
+
+      const ruleIndex = this.ocio.module._ocio_config_get_file_rule_index_from_filepath(
+        this.handle,
+        filePathPtr
+      );
+      const rule = this.getFileRule(ruleIndex);
+      const isDefaultRule =
+        this.ocio.module._ocio_config_filepath_only_matches_default_rule(
+          this.handle,
+          filePathPtr
+        ) === 1;
+      return {
+        colorSpace,
+        ruleIndex,
+        ruleName: rule.name,
+        isDefaultRule,
+        custom: rule.custom
+      };
+    });
+  }
+
   listDisplays() {
     const count = this.ocio.module._ocio_config_get_num_displays(this.handle);
     return Array.from({ length: count }, (_, index) => this.ocio._string('ocio_config_get_display', this.handle, index));

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

@@ -20,6 +20,7 @@ export const OptimizationFlags: Readonly<{
 export interface CreateOCIOOptions {
   moduleFactory?: (options?: unknown) => Promise<unknown>;
   moduleOptions?: Record<string, unknown>;
+  wasmUrl?: string;
   locateFile?: (path: string, prefix: string) => string;
 }
 
@@ -54,6 +55,24 @@ export interface ViewInfo {
   description: string;
 }
 
+export interface FileRuleInfo {
+  index: number;
+  name: string;
+  colorSpace: string;
+  pattern: string;
+  extension: string;
+  regex: string;
+  custom: Record<string, string>;
+}
+
+export interface FileRuleMatch {
+  colorSpace: string;
+  ruleIndex: number;
+  ruleName: string;
+  isDefaultRule: boolean;
+  custom: Record<string, string>;
+}
+
 export interface DisplayViewProcessorOptions {
   source: string;
   display: string;
@@ -136,6 +155,9 @@ export class Config {
   listRoles(): RoleInfo[];
   listColorSpaces(): ColorSpaceInfo[];
   getColorSpace(name: string): ColorSpaceInfo;
+  getFileRule(index: number): FileRuleInfo;
+  listFileRules(): FileRuleInfo[];
+  matchFileRule(filePath: string): FileRuleMatch | null;
   listDisplays(): string[];
   getDefaultDisplay(): string;
   listViews(display: string): ViewInfo[];

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;