Windows compatibility #19

Hide WebP format and normalise option

Separate test runners for node and iojs

README.md

@@ -88,9 +88,12 @@ The _gettext_ dependency of _libvips_ [can lead](https://github.com/lovell/sharp
 Requires x86 32-bit Node.js or io.js (use `iojs.exe` rather than `node.exe`).
 The WebP format is currently unsupported.
 
-1. [Download](http://www.vips.ecs.soton.ac.uk/supported/current/win32/) and unzip `vips-dev.x.y.z.zip`.
+1. Ensure the [node-gyp prerequisites](https://github.com/TooTallNate/node-gyp#installation) are met.
-2. Set the `VIPS_HOME` environment variable to the full path of the `vips-dev-x.y.z` directory.
+2. [Download](http://www.vips.ecs.soton.ac.uk/supported/current/win32/) and unzip `vips-dev.x.y.z.zip`.
-3. Add `vips-dev-x.y.z\bin` to `PATH`.
+3. Set the `VIPS_HOME` environment variable to the full path of the `vips-dev-x.y.z` directory.
+4. Add `vips-dev-x.y.z\bin` to `PATH`.
+
+Versions of MSVC more recent than 2013 may require the use of `npm install --arch=ia32 --msvs_version=2013`.
 
 ### Heroku
 
@@ -678,6 +681,10 @@ A [guide for contributors](https://github.com/lovell/sharp/blob/master/CONTRIBUT
 
 [![Centos 6.5 Build Status](https://snap-ci.com/lovell/sharp/branch/master/build_image)](https://snap-ci.com/lovell/sharp/branch/master)
 
+#### Windows Server 2012
+
+[![Windows Server 2012 Build Status](https://ci.appveyor.com/api/projects/status/pgtul704nkhhg6sg)](https://ci.appveyor.com/project/lovell/sharp)
+
 ### Benchmark tests
 
 ```

appveyor.yml

@@ -1,17 +1,17 @@
 os: Visual Studio 2014 CTP4
+platform: x86
 environment:
   VIPS_VERSION_MAJOR_MINOR: 7.42
   VIPS_VERSION_PATCH: 3
+  VIPS_WARNING: 0
 install:
   - ps: $env:VIPS_VERSION = "$env:VIPS_VERSION_MAJOR_MINOR.$env:VIPS_VERSION_PATCH"
-  - ps: Write-Output "VIPS_VERSION=$env:VIPS_VERSION"
   - ps: Write-Output "Fetching http://www.vips.ecs.soton.ac.uk/supported/$env:VIPS_VERSION_MAJOR_MINOR/win32/vips-dev-$env:VIPS_VERSION.zip"
   - ps: Start-FileDownload http://www.vips.ecs.soton.ac.uk/supported/$env:VIPS_VERSION_MAJOR_MINOR/win32/vips-dev-$env:VIPS_VERSION.zip -FileName c:\vips-dev-$env:VIPS_VERSION.zip
-  - ps: Write-Output "Extracting c:\vips-dev-$env:VIPS_VERSION.zip"
   - ps: Invoke-Expression "& 7z -y x c:\vips-dev-$env:VIPS_VERSION.zip -oc:\ | FIND /V `"ing  `""
   - ps: $env:VIPS_HOME = "c:\vips-dev-$env:VIPS_VERSION"
   - ps: $env:PATH = "$env:VIPS_HOME\bin;$env:PATH"
   - ps: Install-Product node 0 x86
   - npm install --msvs_version=2013
 test_script:
-  - npm test
+  - npm run-script test-win32-node

index.js

@@ -349,10 +349,14 @@ Sharp.prototype.gamma = function(gamma) {
 };
 
 /*
-  Normalize histogram
+  Enhance output image contrast by stretching its luminance to cover the full dynamic range
 */
 Sharp.prototype.normalize = function(normalize) {
+  if (process.platform !== 'win32') {
     this.options.normalize = (typeof normalize === 'boolean') ? normalize : true;
+  } else {
+    console.error('normalize unavailable on win32 platform');
+  }
   return this;
 };
 Sharp.prototype.normalise = Sharp.prototype.normalize;

package.json

@@ -20,7 +20,9 @@
   ],
   "description": "High performance Node.js module to resize JPEG, PNG, WebP and TIFF images using the libvips library",
   "scripts": {
-    "test": "VIPS_WARNING=0 node ./node_modules/istanbul/lib/cli.js cover ./node_modules/mocha/bin/_mocha -- --slow=5000 --timeout=10000 ./test/unit/*.js"
+    "test": "VIPS_WARNING=0 node ./node_modules/istanbul/lib/cli.js cover ./node_modules/mocha/bin/_mocha -- --slow=5000 --timeout=15000 ./test/unit/*.js",
+    "test-win32-node": "node ./node_modules/mocha/bin/mocha --slow=5000 --timeout=15000 ./test/unit/*.js",
+    "test-win32-iojs": "iojs ./node_modules/mocha/bin/mocha --slow=5000 --timeout=15000 ./test/unit/*.js"
   },
   "main": "index.js",
   "repository": {

src/resize.cc

@@ -708,6 +708,7 @@ class ResizeWorker : public NanAsyncWorker {
       image = gammaDecoded;
     }
 
+#ifndef _WIN32
     // Apply normalization
     if (baton->normalize) {
       VipsInterpretation typeBeforeNormalize = image->Type;
@@ -787,6 +788,7 @@ class ResizeWorker : public NanAsyncWorker {
         image = normalized;
       }
     }
+#endif
 
     // Convert image to sRGB, if not already
     if (image->Type != VIPS_INTERPRETATION_sRGB) {

src/sharp.cc

@@ -8,6 +8,10 @@
 #include "resize.h"
 #include "utilities.h"
 
+#ifdef _WIN64
+#error Windows 64-bit currently unsupported - see https://github.com/lovell/sharp#windows
+#endif
+
 extern "C" void init(v8::Handle<v8::Object> target) {
   NanScope();
   vips_init("sharp");

test/unit/colourspace.js

@@ -31,6 +31,7 @@ describe('Colour space conversion', function() {
       .toFile(fixtures.path('output.greyscale-not.jpg'), done);
   });
 
+  if (sharp.format.webp.output.buffer) {
     it('From 1-bit TIFF to sRGB WebP [slow]', function(done) {
       sharp(fixtures.inputTiff)
         .webp()
@@ -41,6 +42,7 @@ describe('Colour space conversion', function() {
           done();
         });
     });
+  }
 
   it('From CMYK to sRGB', function(done) {
     sharp(fixtures.inputJpgWithCmykProfile)

test/unit/cpplint.js

@@ -8,6 +8,8 @@ var cpplint = require('node-cpplint/lib/');
 
 describe('cpplint', function() {
 
+  // Ignore cpplint failures, possibly newline-related, on Windows
+  if (process.platform !== 'win32') {
     // List C++ source files
     fs.readdirSync(path.join(__dirname, '..', '..', 'src')).forEach(function (source) {
       var file = path.join('src', source);
@@ -42,5 +44,6 @@ describe('cpplint', function() {
       });
 
     });
+  }
 
 });

test/unit/embed.js

@@ -28,6 +28,7 @@ describe('Embed', function() {
       });
   });
 
+  if (sharp.format.webp.output.buffer) {
     it('JPEG within WebP, to include alpha channel', function(done) {
       sharp(fixtures.inputJpg)
         .resize(320, 240)
@@ -47,5 +48,6 @@ describe('Embed', function() {
           });
         });
     });
+  }
 
 });

test/unit/extract.js

@@ -31,6 +31,7 @@ describe('Partial image extraction', function() {
       });
   });
 
+  if (sharp.format.webp.output.file) {
     it('WebP', function(done) {
       sharp(fixtures.inputWebP)
         .extract(50, 100, 125, 200)
@@ -41,6 +42,7 @@ describe('Partial image extraction', function() {
           done();
         });
     });
+  }
 
   it('TIFF', function(done) {
     sharp(fixtures.inputTiff)

test/unit/io.js

@@ -806,9 +806,11 @@ describe('Input/output', function() {
       .toBuffer(function(err) {
         sharp.queue.removeListener('change', queueListener);
         if (err) throw err;
+        process.nextTick(function() {
           assert.strictEqual(2, eventCounter);
           done();
         });
       });
+  });
 
 });

test/unit/metadata.js

@@ -82,6 +82,7 @@ describe('Image metadata', function() {
     });
   });
 
+  if (sharp.format.webp.input.file) {
     it('WebP', function(done) {
       sharp(fixtures.inputWebP).metadata(function(err, metadata) {
         if (err) throw err;
@@ -95,6 +96,7 @@ describe('Image metadata', function() {
         done();
       });
     });
+  }
 
   it('GIF via libmagick', function(done) {
     sharp(fixtures.inputGif).metadata(function(err, metadata) {

test/unit/normalize.js

@@ -13,6 +13,9 @@ describe('Normalization', function () {
     assert.strictEqual(sharp.prototype.normalize, sharp.prototype.normalise);
   });
 
+  // Normalize is currently unavailable on Windows
+  if (process.platform !== 'win32') {
+
     it('spreads rgb image values between 0 and 255', function(done) {
       sharp(fixtures.inputJpgWithLowContrast)
         .normalize()
@@ -54,7 +57,6 @@ describe('Normalization', function () {
         .normalize()
         .raw()
         .toBuffer(function (err, data, info) {
-        // raw toBuffer does not return the alpha channel (yet?)
           var min = 255, max = 0, i;
           for (i = 0; i < data.length; i++) {
             min = Math.min(min, data[i]);
@@ -89,11 +91,6 @@ describe('Normalization', function () {
             .metadata()
             .then(function (metadata) {
               assert.strictEqual(true, metadata.hasAlpha);
-            // because of complications with greyscale
-            // we return everything in srgb for now.
-            //
-            // assert.strictEqual(2, metadata.channels);
-            // assert.strictEqual('b-w', metadata.space);
               assert.strictEqual(4, metadata.channels);
               assert.strictEqual('srgb', metadata.space);
             })
@@ -113,11 +110,6 @@ describe('Normalization', function () {
         })
         .then(function (metadata) {
           assert.strictEqual(false, metadata.hasAlpha);
-        // because of complications with greyscale
-        // we return everything in srgb for now.
-        //
-        // assert.strictEqual(1, metadata.channels);
-        // assert.strictEqual('b-w', metadata.space);
           assert.strictEqual(3, metadata.channels);
           assert.strictEqual('srgb', metadata.space);
         })
@@ -127,10 +119,11 @@ describe('Normalization', function () {
             .toBuffer();
         })
         .then(function (rawData) {
-        // var blackBuffer = new Buffer([0,0,0,0]);
           var blackBuffer = new Buffer([0,0,0, 0,0,0, 0,0,0, 0,0,0]);
           assert.strictEqual(blackBuffer.toString(), rawData.toString());
         })
         .finally(done);
     });
+
+  }
 });