sharp/test/unit/tiff.js

'use strict';

const fs = require('fs');
const assert = require('assert');
const rimraf = require('rimraf');

const sharp = require('../../');
const fixtures = require('../fixtures');

describe('TIFF', function () {
  it('Load TIFF from Buffer', function (done) {
    const inputTiffBuffer = fs.readFileSync(fixtures.inputTiff);
    sharp(inputTiffBuffer)
      .resize(320, 240)
      .jpeg()
      .toBuffer(function (err, data, info) {
        if (err) throw err;
        assert.strictEqual(true, data.length > 0);
        assert.strictEqual(data.length, info.size);
        assert.strictEqual('jpeg', info.format);
        assert.strictEqual(320, info.width);
        assert.strictEqual(240, info.height);
        done();
      });
  });

  it('Load multi-page TIFF from file', function (done) {
    sharp(fixtures.inputTiffMultipage) // defaults to page 0
      .jpeg()
      .toBuffer(function (err, defaultData, defaultInfo) {
        if (err) throw err;
        assert.strictEqual(true, defaultData.length > 0);
        assert.strictEqual(defaultData.length, defaultInfo.size);
        assert.strictEqual('jpeg', defaultInfo.format);

        sharp(fixtures.inputTiffMultipage, { page: 1 }) // 50%-scale copy of page 0
          .jpeg()
          .toBuffer(function (err, scaledData, scaledInfo) {
            if (err) throw err;
            assert.strictEqual(true, scaledData.length > 0);
            assert.strictEqual(scaledData.length, scaledInfo.size);
            assert.strictEqual('jpeg', scaledInfo.format);
            assert.strictEqual(defaultInfo.width, scaledInfo.width * 2);
            assert.strictEqual(defaultInfo.height, scaledInfo.height * 2);
            done();
          });
      });
  });

  it('Load multi-page TIFF from Buffer', function (done) {
    const inputTiffBuffer = fs.readFileSync(fixtures.inputTiffMultipage);
    sharp(inputTiffBuffer) // defaults to page 0
      .jpeg()
      .toBuffer(function (err, defaultData, defaultInfo) {
        if (err) throw err;
        assert.strictEqual(true, defaultData.length > 0);
        assert.strictEqual(defaultData.length, defaultInfo.size);
        assert.strictEqual('jpeg', defaultInfo.format);

        sharp(inputTiffBuffer, { page: 1 }) // 50%-scale copy of page 0
          .jpeg()
          .toBuffer(function (err, scaledData, scaledInfo) {
            if (err) throw err;
            assert.strictEqual(true, scaledData.length > 0);
            assert.strictEqual(scaledData.length, scaledInfo.size);
            assert.strictEqual('jpeg', scaledInfo.format);
            assert.strictEqual(defaultInfo.width, scaledInfo.width * 2);
            assert.strictEqual(defaultInfo.height, scaledInfo.height * 2);
            done();
          });
      });
  });

  it('Save TIFF to Buffer', function (done) {
    sharp(fixtures.inputTiff)
      .resize(320, 240)
      .toBuffer(function (err, data, info) {
        if (err) throw err;
        assert.strictEqual(true, data.length > 0);
        assert.strictEqual(data.length, info.size);
        assert.strictEqual('tiff', info.format);
        assert.strictEqual(320, info.width);
        assert.strictEqual(240, info.height);
        done();
      });
  });

  it('Invalid TIFF quality throws error', function () {
    assert.throws(function () {
      sharp().tiff({ quality: 101 });
    });
  });

  it('Missing TIFF quality does not throw error', function () {
    assert.doesNotThrow(function () {
      sharp().tiff();
    });
  });

  it('Not squashing TIFF to a bit depth of 1 should not change the file size', function (done) {
    const startSize = fs.statSync(fixtures.inputTiff8BitDepth).size;
    sharp(fixtures.inputTiff8BitDepth)
      .toColourspace('b-w') // can only squash 1 band uchar images
      .tiff({
        squash: false,
        compression: 'none',
        predictor: 'none'
      })
      .toFile(fixtures.outputTiff, (err, info) => {
        if (err) throw err;
        assert.strictEqual('tiff', info.format);
        assert.strictEqual(startSize, info.size);
        rimraf(fixtures.outputTiff, done);
      });
  });

  it('Squashing TIFF to a bit depth of 1 should significantly reduce file size', function (done) {
    const startSize = fs.statSync(fixtures.inputTiff8BitDepth).size;
    sharp(fixtures.inputTiff8BitDepth)
      .toColourspace('b-w') // can only squash 1 band uchar images
      .tiff({
        squash: true,
        compression: 'none',
        predictor: 'none'
      })
      .toFile(fixtures.outputTiff, (err, info) => {
        if (err) throw err;
        assert.strictEqual('tiff', info.format);
        assert(info.size < (startSize / 2));
        rimraf(fixtures.outputTiff, done);
      });
  });

  it('Invalid TIFF squash value throws error', function () {
    assert.throws(function () {
      sharp().tiff({ squash: 'true' });
    });
  });

  it('TIFF setting xres and yres on file', function (done) {
    const res = 1000.0; // inputTiff has a dpi of 300 (res*2.54)
    sharp(fixtures.inputTiff)
      .tiff({
        xres: (res),
        yres: (res)
      })
      .toFile(fixtures.outputTiff, (err, info) => {
        if (err) throw err;
        assert.strictEqual('tiff', info.format);
        sharp(fixtures.outputTiff).metadata(function (err, metadata) {
          if (err) throw err;
          assert.strictEqual(metadata.density, res * 2.54); // convert to dpi
          rimraf(fixtures.outputTiff, done);
        });
      });
  });

  it('TIFF setting xres and yres on buffer', function (done) {
    const res = 1000.0; // inputTiff has a dpi of 300 (res*2.54)
    sharp(fixtures.inputTiff)
      .tiff({
        xres: (res),
        yres: (res)
      })
      .toBuffer(function (err, data, info) {
        if (err) throw err;
        sharp(data).metadata(function (err, metadata) {
          if (err) throw err;
          assert.strictEqual(metadata.density, res * 2.54); // convert to dpi
          done();
        });
      });
  });

  it('TIFF invalid xres value should throw an error', function () {
    assert.throws(function () {
      sharp().tiff({ xres: '1000.0' });
    });
  });

  it('TIFF invalid yres value should throw an error', function () {
    assert.throws(function () {
      sharp().tiff({ yres: '1000.0' });
    });
  });

  it('TIFF lzw compression with horizontal predictor shrinks test file', function (done) {
    const startSize = fs.statSync(fixtures.inputTiffUncompressed).size;
    sharp(fixtures.inputTiffUncompressed)
      .tiff({
        compression: 'lzw',
        predictor: 'horizontal'
      })
      .toFile(fixtures.outputTiff, (err, info) => {
        if (err) throw err;
        assert.strictEqual('tiff', info.format);
        assert(info.size < startSize);
        rimraf(fixtures.outputTiff, done);
      });
  });

  it('TIFF ccittfax4 compression shrinks b-w test file', function (done) {
    const startSize = fs.statSync(fixtures.inputTiff).size;
    sharp(fixtures.inputTiff)
      .toColourspace('b-w')
      .tiff({
        squash: true,
        compression: 'ccittfax4'
      })
      .toFile(fixtures.outputTiff, (err, info) => {
        if (err) throw err;
        assert.strictEqual('tiff', info.format);
        assert(info.size < startSize);
        rimraf(fixtures.outputTiff, done);
      });
  });

  it('TIFF deflate compression with horizontal predictor shrinks test file', function (done) {
    const startSize = fs.statSync(fixtures.inputTiffUncompressed).size;
    sharp(fixtures.inputTiffUncompressed)
      .tiff({
        compression: 'deflate',
        predictor: 'horizontal'
      })
      .toFile(fixtures.outputTiff, (err, info) => {
        if (err) throw err;
        assert.strictEqual('tiff', info.format);
        assert(info.size < startSize);
        rimraf(fixtures.outputTiff, done);
      });
  });

  it('TIFF deflate compression with float predictor shrinks test file', function (done) {
    const startSize = fs.statSync(fixtures.inputTiffUncompressed).size;
    sharp(fixtures.inputTiffUncompressed)
      .tiff({
        compression: 'deflate',
        predictor: 'float'
      })
      .toFile(fixtures.outputTiff, (err, info) => {
        if (err) throw err;
        assert.strictEqual('tiff', info.format);
        assert(info.size < startSize);
        rimraf(fixtures.outputTiff, done);
      });
  });

  it('TIFF deflate compression without predictor shrinks test file', function (done) {
    const startSize = fs.statSync(fixtures.inputTiffUncompressed).size;
    sharp(fixtures.inputTiffUncompressed)
      .tiff({
        compression: 'deflate',
        predictor: 'none'
      })
      .toFile(fixtures.outputTiff, (err, info) => {
        if (err) throw err;
        assert.strictEqual('tiff', info.format);
        assert(info.size < startSize);
        rimraf(fixtures.outputTiff, done);
      });
  });

  it('TIFF jpeg compression shrinks test file', function (done) {
    const startSize = fs.statSync(fixtures.inputTiffUncompressed).size;
    sharp(fixtures.inputTiffUncompressed)
      .tiff({
        compression: 'jpeg'
      })
      .toFile(fixtures.outputTiff, (err, info) => {
        if (err) throw err;
        assert.strictEqual('tiff', info.format);
        assert(info.size < startSize);
        rimraf(fixtures.outputTiff, done);
      });
  });

  it('TIFF none compression does not throw error', function () {
    assert.doesNotThrow(function () {
      sharp().tiff({ compression: 'none' });
    });
  });

  it('TIFF lzw compression does not throw error', function () {
    assert.doesNotThrow(function () {
      sharp().tiff({ compression: 'lzw' });
    });
  });

  it('TIFF deflate compression does not throw error', function () {
    assert.doesNotThrow(function () {
      sharp().tiff({ compression: 'deflate' });
    });
  });

  it('TIFF invalid compression option throws', function () {
    assert.throws(function () {
      sharp().tiff({ compression: 0 });
    });
  });

  it('TIFF invalid compression option throws', function () {
    assert.throws(function () {
      sharp().tiff({ compression: 'a' });
    });
  });

  it('TIFF invalid predictor option throws', function () {
    assert.throws(function () {
      sharp().tiff({ predictor: 'a' });
    });
  });

  it('TIFF horizontal predictor does not throw error', function () {
    assert.doesNotThrow(function () {
      sharp().tiff({ predictor: 'horizontal' });
    });
  });

  it('TIFF float predictor does not throw error', function () {
    assert.doesNotThrow(function () {
      sharp().tiff({ predictor: 'float' });
    });
  });

  it('TIFF none predictor does not throw error', function () {
    assert.doesNotThrow(function () {
      sharp().tiff({ predictor: 'none' });
    });
  });

  it('TIFF tiled pyramid image without compression enlarges test file', function (done) {
    const startSize = fs.statSync(fixtures.inputTiffUncompressed).size;
    sharp(fixtures.inputTiffUncompressed)
      .tiff({
        compression: 'none',
        pyramid: true,
        tile: true,
        tileHeight: 256,
        tileWidth: 256
      })
      .toFile(fixtures.outputTiff, (err, info) => {
        if (err) throw err;
        assert.strictEqual('tiff', info.format);
        assert(info.size > startSize);
        rimraf(fixtures.outputTiff, done);
      });
  });

  it('TIFF pyramid true value does not throw error', function () {
    assert.doesNotThrow(function () {
      sharp().tiff({ pyramid: true });
    });
  });

  it('Invalid TIFF pyramid value throws error', function () {
    assert.throws(function () {
      sharp().tiff({ pyramid: 'true' });
    });
  });

  it('Invalid TIFF tile value throws error', function () {
    assert.throws(function () {
      sharp().tiff({ tile: 'true' });
    });
  });

  it('TIFF tile true value does not throw error', function () {
    assert.doesNotThrow(function () {
      sharp().tiff({ tile: true });
    });
  });

  it('Valid TIFF tileHeight value does not throw error', function () {
    assert.doesNotThrow(function () {
      sharp().tiff({ tileHeight: 512 });
    });
  });

  it('Valid TIFF tileWidth value does not throw error', function () {
    assert.doesNotThrow(function () {
      sharp().tiff({ tileWidth: 512 });
    });
  });

  it('Invalid TIFF tileHeight value throws error', function () {
    assert.throws(function () {
      sharp().tiff({ tileHeight: '256' });
    });
  });

  it('Invalid TIFF tileWidth value throws error', function () {
    assert.throws(function () {
      sharp().tiff({ tileWidth: '256' });
    });
  });

  it('Invalid TIFF tileHeight value throws error', function () {
    assert.throws(function () {
      sharp().tiff({ tileHeight: 0 });
    });
  });

  it('Invalid TIFF tileWidth value throws error', function () {
    assert.throws(function () {
      sharp().tiff({ tileWidth: 0 });
    });
  });

  it('TIFF file input with invalid page fails gracefully', function (done) {
    sharp(fixtures.inputTiffMultipage, { page: 2 })
      .toBuffer(function (err) {
        assert.strictEqual(true, !!err);
        done();
      });
  });

  it('TIFF buffer input with invalid page fails gracefully', function (done) {
    sharp(fs.readFileSync(fixtures.inputTiffMultipage), { page: 2 })
      .toBuffer(function (err) {
        assert.strictEqual(true, !!err);
        done();
      });
  });
});