calipers/src/index.ts

The fastest Node.js library for measuring image and PDF dimensions.

import * as fs from 'fs'

// HEADER_LENGTH is the number of bytes to initially read to determine the type
// of the given file. We read more than needed for this task, because for some
// image formats, like PNG, the dimension metadata lives close to the beginning
// of the file and we can avoid a second file read.
const HEADER_LENGTH = 24

// Format designates a supported file type for measurement.
export const enum Format {
  UNKNOWN = 0,
  PNG = 1 << 0
}

// Result is describes the result of measuring an image file.
export interface Result {
  readonly format: Format;
  readonly width: number;
  readonly height: number;
}

// measure returns the image dimensions of the file at the given path.
export async function measure (input: string | Buffer, formats: Format): Promise<Result> {
  if (Buffer.isBuffer(input)) {
    return measureBuffer(input)
  }

  let fd
  try {
    fd = await fs.promises.open(input, 'r')

    const b = Buffer.alloc(HEADER_LENGTH)
    await fd.read(b, 0, HEADER_LENGTH, 0)

    return measureBuffer(b)
  } finally {
    if (fd) {
      fd.close()
    }
  }
}

function measureBuffer (b: Buffer): Result {
  const format = detect(b)
  if (format === Format.PNG) {
    return measurePNG(b)
  }
  throw new Error('file type not supported')
}

// measurePNG returns the dimenions of a PNG file.
function measurePNG (header: Buffer): Result {
  const offset = 16
  return {
    format: Format.PNG,
    width: header.readUInt32BE(offset),
    height: header.readUInt32BE(4 + offset)
  }
}

// detect returns the file format of the given header buffer. Format.UNKNOWN is
// returned if the file type is not supported.
function detect (header: Buffer): Format {
  // PNG
  if (
    // _PNG\r\n\x1a\n
    header[0] === 0x89 &&
    header[1] === 0x50 &&
    header[2] === 0x4e &&
    header[3] === 0x47 &&
    header[4] === 0x0d &&
    header[5] === 0x0a &&
    header[6] === 0x1a &&
    header[7] === 0x0a &&
    // IHDR
    header[12] === 0x49 &&
    header[13] === 0x48 &&
    header[14] === 0x44 &&
    header[15] === 0x52
  ) {
    return Format.PNG
  }

  return Format.UNKNOWN
}