@needle-tools/engine 4.5.0-alpha.3 → 4.5.0-alpha.5

package/src/engine/engine_utils_format.ts

@@ -1,13 +1,24 @@
 import { isDevEnvironment } from "./debug/index.js";
-import { NeedleEngineModelLoader, registeredFileTypeCallbacks } from "./engine_loaders.callbacks.js";
+import { registeredMimetypeCallbacks } from "./engine_loaders.callbacks.js";
 import { getParam } from "./engine_utils.js";
 
 const debug = getParam("debugfileformat");
-
 /**
- * The supported file types that can be determined by the engine. Used in {@link tryDetermineFileTypeFromURL} and {@link tryDetermineFileTypeFromBinary}
+ * The supported file types that can be determined by the engine. Used in {@link tryDetermineMimetypeFromURL} and {@link tryDetermineMimetypeFromBinary}
  */
-export declare type FileType = "gltf" | "glb" | "vrm" | "fbx" | "obj" | "usdz" | "usd" | "usda" | "unknown" | ({} & string);
+export type NeedleMimetype = "unknown" |
+    "model/gltf+json" |
+    "model/gltf-binary" |
+    "model/vrm" |
+    "model/vnd.usdz+zip" |
+    "model/vnd.usd" |
+    "model/vnd.usda" |
+    "model/vnd.usdc" |
+    "model/fbx" |
+    "model/vnd.autodesk.fbx" |
+    "model/obj"
+    | (string & {})
+
 
 /**
  * Tries to determine the file type of a file from its URL  
@@ -21,7 +32,7 @@ export declare type FileType = "gltf" | "glb" | "vrm" | "fbx" | "obj" | "usdz" |
  * const fileType = await tryDetermineFileTypeFromURL(url);
  * console.log(fileType); // "glb"
  */
-export async function tryDetermineFileTypeFromURL(url: string, opts: { useExtension: boolean }): Promise<FileType> {
+export async function tryDetermineMimetypeFromURL(url: string, opts: { useExtension: boolean }): Promise<NeedleMimetype> {
 
     const { useExtension = true } = opts;
 
@@ -41,24 +52,24 @@ export async function tryDetermineFileTypeFromURL(url: string, opts: { useExtens
         if (!ext?.length) {
             ext = urlobj.pathname.split(".").pop()?.toUpperCase();
         }
-        if (debug) console.debug("Use file extension to determine type: " + ext);
+        if (debug) console.warn(`[Needle Engine] Try to use file extension to determine type: '${ext}'`);
         switch (ext) {
             case "GLTF":
-                return "gltf";
+                return "model/gltf+json"
             case "VRM":
-                return "vrm";
+                return "model/vrm";
             case "GLB":
-                return "glb";
+                return "model/gltf-binary";
             case "FBX":
-                return "fbx";
+                return "model/fbx";
             case "USD":
-                return "usd";
+                return "model/vnd.usd+zip";
             case "USDA":
-                return "usda";
+                return "model/vnd.usda+zip";
             case "USDZ":
-                return "usdz";
+                return "model/vnd.usdz+zip";
             case "OBJ":
-                return "obj";
+                return "model/obj";
         }
     }
 
@@ -88,8 +99,8 @@ export async function tryDetermineFileTypeFromURL(url: string, opts: { useExtens
 
     if (header?.ok) {
         const data = await header.arrayBuffer();
-        const res = tryDetermineFileTypeFromBinary(originalUrl, data, header);
-        if (debug) console.log("Determined file type from header: " + res);
+        const res = tryDetermineMimetypeFromBinary(originalUrl, data, header);
+        if (debug) console.log("[Needle Engine] Determined file type from header: " + res);
         return res;
     }
 
@@ -100,7 +111,7 @@ export async function tryDetermineFileTypeFromURL(url: string, opts: { useExtens
 /** Attempts to determine the file type of a binary file by looking at the first few bytes of the file. 
  * @hidden 
  */
-export function tryDetermineFileTypeFromBinary(url: string, data: ArrayBuffer, response: Response): FileType {
+export function tryDetermineMimetypeFromBinary(url: string, data: ArrayBuffer, response: Response): NeedleMimetype {
 
     if (data.byteLength < 4) {
         return "unknown";
@@ -109,70 +120,73 @@ export function tryDetermineFileTypeFromBinary(url: string, data: ArrayBuffer, r
     const bytes = new Uint8Array(data);
 
     if (debug) {
-        console.warn("Trying to determine file type from binary data\n", "\"" + new TextDecoder().decode(data) + "\"\n", bytes);
+        console.warn("[Needle Engine] Trying to determine file type from binary data\n", "\"" + new TextDecoder().decode(data) + "\"\n", bytes);
     }
 
-    // GLTF or GLB
-    if (bytes[0] == 103 && bytes[1] == 108 && bytes[2] == 84 && bytes[3] == 70) {
+    // GLTF
+    if (bytes[0] == 103 && bytes[1] == 108 && bytes[2] == 84 && bytes[3] == 70 && bytes[4] == 10) {
+        // GLTF
         console.debug("GLTF detected");
-        return "glb";
+        return "model/gltf+json";
+    }
+    // GLB
+    else if (bytes[0] == 103 && bytes[1] == 108 && bytes[2] == 84 && bytes[3] == 70 && bytes[4] == 98) {
+        // GLB
+        console.debug("GLB detected");
+        return "model/gltf-binary";
     }
     // USDZ
     if (bytes[0] == 80 && bytes[1] == 75 && bytes[2] == 3 && bytes[3] == 4) {
         console.debug("USDZ detected");
-        return "usdz";
+        return "model/vnd.usdz+zip";
     }
     // USD
     if (bytes[0] == 80 && bytes[1] == 88 && bytes[2] == 82 && bytes[3] == 45 && bytes[4] == 85 && bytes[5] == 83 && bytes[6] == 68 && bytes[7] == 67) {
         console.debug("Binary USD detected");
-        return "usd";
+        return "model/vnd.usd";
     }
     // USDA: check if the file starts with #usda
     else if (bytes[0] == 35 && bytes[1] == 117 && bytes[2] == 115 && bytes[3] == 100 && bytes[4] == 97) {
         console.debug("ASCII USD detected");
-        return "usda";
+        return "model/vnd.usda";
     }
     // FBX
     if (bytes[0] == 75 && bytes[1] == 97 && bytes[2] == 121 && bytes[3] == 100 && bytes[4] == 97 && bytes[5] == 114 && bytes[6] == 97 && bytes[7] == 32) {
         console.debug("Binary FBX detected");
-        return "fbx";
+        return "model/fbx";
     }
     // ASCII FBX
     else if (bytes[0] == 59 && bytes[1] == 32 && bytes[2] == 70 && bytes[3] == 66 && bytes[4] == 88 && bytes[5] == 32) {
         console.debug("ASCII FBX detected");
-        return "fbx";
+        return "model/fbx";
     }
     // OBJ - in this case exported from blender it starts with "# Blender" - we only check the first 10 bytes, technically it could still be a different file so we should do this check at the end
     else if (bytes[0] == 35 && bytes[1] == 32 && bytes[2] == 66 && bytes[3] == 108 && bytes[4] == 101 && bytes[5] == 110 && bytes[6] == 100 && bytes[7] == 101 && bytes[8] == 114 && bytes[9] == 32) {
         console.debug("OBJ detected");
-        return "obj";
+        return "model/obj";
     }
     // Check if it starts "# Alias OBJ"
     else if (bytes[0] == 35 && bytes[1] == 32 && bytes[2] == 65 && bytes[3] == 108 && bytes[4] == 105 && bytes[5] == 97 && bytes[6] == 115 && bytes[7] == 32 && bytes[8] == 79 && bytes[9] == 66 && bytes[10] == 74) {
         console.debug("OBJ detected");
-        return "obj";
+        return "model/obj";
     }
     else if (response.headers.has("content-type")) {
         const content_type = response.headers.get("content-type");
         console.debug("Content-Type: " + content_type);
         switch (content_type) {
             case "model/gltf+json":
-                return "gltf";
             case "model/gltf-binary":
-                return "glb";
             case "model/vrm":
-                return "vrm";
             case "model/vnd.usdz+zip":
-                return "usdz";
             case "model/vnd.usd+zip":
-                return "usd";
+            case "model/vnd.usd":
             case "model/vnd.usda+zip":
-                return "usda";
+            case "model/vnd.usda":
+            case "model/vnd.usdc":
             case "model/fbx":
             case "model/vnd.autodesk.fbx":
-                return "fbx";
             case "model/obj":
-                return "obj";
+                return content_type;
             // case "model/stl":
             //     return "stl";
             case "text/plain":
@@ -205,7 +219,7 @@ export function tryDetermineFileTypeFromBinary(url: string, data: ArrayBuffer, r
     //     return "gltf";
     // }
 
-    for (const callback of registeredFileTypeCallbacks) {
+    for (const callback of registeredMimetypeCallbacks) {
         const mimetype = callback({
             url: url,
             response: response,