image-js 1.2.0 → 1.3.0

package/src/load/decodeTiff.ts

@@ -4,6 +4,7 @@ import type { BitDepth } from '../Image.js';
 import { Image } from '../Image.js';
 
 import { getMetadata } from './getMetadata.js';
+import type { Resolution } from './load.types.ts';
 
 type TiffIfd = ReturnType<typeof decode>[number];
 
@@ -26,7 +27,7 @@ export function getImageFromIFD(ifd: TiffIfd): Image {
   if (ifd.data instanceof Float32Array || ifd.data instanceof Float64Array) {
     throw new Error('Float TIFF data is not supported.');
   }
-
+  const resolution = getTiffResolution(ifd);
   if (ifd.type === 3) {
     const hasAlpha = ifd.samplesPerPixel === 2;
     const pixelLength = hasAlpha ? 4 : 3;
@@ -66,6 +67,7 @@ export function getImageFromIFD(ifd: TiffIfd): Image {
       colorModel: hasAlpha ? 'RGBA' : 'RGB',
       bitDepth: 16,
       meta: getMetadata(ifd),
+      resolution,
     });
   } else if (ifd.type === 1 || ifd.type === 0) {
     if (ifd.bitsPerSample !== 1) {
@@ -74,6 +76,7 @@ export function getImageFromIFD(ifd: TiffIfd): Image {
         bitDepth: ifd.bitsPerSample as BitDepth,
         colorModel: ifd.alpha ? 'GREYA' : 'GREY',
         meta: getMetadata(ifd),
+        resolution,
       });
     } else {
       return new Image(ifd.width, ifd.height, {
@@ -81,6 +84,7 @@ export function getImageFromIFD(ifd: TiffIfd): Image {
         bitDepth: 8 as BitDepth,
         colorModel: 'GREY',
         meta: getMetadata(ifd),
+        resolution,
       });
     }
   } else {
@@ -89,6 +93,39 @@ export function getImageFromIFD(ifd: TiffIfd): Image {
       bitDepth: ifd.bitsPerSample as BitDepth,
       colorModel: ifd.alpha ? 'RGBA' : 'RGB',
       meta: getMetadata(ifd),
+      resolution,
     });
   }
 }
+
+/**
+ * Gets image resolution from its metadata and converts it into Pixels per meter, when it's possible. Also keeps original resolution values and units.
+ * @param ifd - Tiff metadata.
+ * @returns Resolution object.
+ */
+function getTiffResolution(ifd: TiffIfd): Resolution | undefined {
+  if (!ifd.xResolution || !ifd.yResolution) {
+    return undefined;
+  }
+
+  switch (ifd.resolutionUnit) {
+    case 1:
+      return {
+        x: ifd.xResolution,
+        y: ifd.yResolution,
+        unit: 'unknown',
+      };
+    case 3:
+      return {
+        x: ifd.xResolution,
+        y: ifd.yResolution,
+        unit: 'centimeter',
+      };
+    default:
+      return {
+        x: ifd.xResolution,
+        y: ifd.yResolution,
+        unit: 'inch',
+      };
+  }
+}

package/src/load/load.types.ts

@@ -5,3 +5,11 @@ export interface ImageMetadata {
   };
   exif: Record<string, unknown>;
 }
+
+export interface Resolution {
+  x: number;
+  y: number;
+  unit: ResolutionUnit;
+}
+
+export type ResolutionUnit = 'inch' | 'centimeter' | 'meter' | 'unknown';