A wrapper around the GraphicsMagick cli
npm install hanul-graphicsmagickbrew install graphicsmagick.
javascript
var GraphicsMagick = require('hanul-graphicsmagick');
GraphicsMagick.readMetadata('kittens.jpg', function(err, metadata){
if (err) throw err;
console.log('Shot at '+metadata.exif.dateTimeOriginal);
})
// -> Shot at Tue, 06 Feb 2007 21:13:54 GMT
`
API
$3
Path to the convert program. Defaults to "convert".
$3
Path to the identify program. Defaults to "identify".
$3
Identify file at path and return an object features.
Example:
`javascript
im.identify('kittens.jpg', function(err, features){
if (err) throw err;
console.log(features);
// { format: 'JPEG', width: 3904, height: 2622, depth: 8 }
});
`
$3
Custom identification where args is an array of arguments. The result is returned as a raw string to output.
Example:
`javascript
im.identify(['-format', '%wx%h', 'kittens.jpg'], function(err, output){
if (err) throw err;
console.log('dimension: '+output);
// dimension: 3904x2622
});
`
$3
Read metadata (i.e. exif) in path and return an object metadata. Modelled on top of identify.
Example:
`javascript
im.readMetadata('kittens.jpg', function(err, metadata){
if (err) throw err;
console.log('Shot at '+metadata.exif.dateTimeOriginal);
// -> Shot at Tue, 06 Feb 2007 21:13:54 GMT
});
`
$3
Raw interface to convert passing arguments in the array args.
Example:
`javascript
im.convert(['kittens.jpg', '-resize', '25x120', 'kittens-small.jpg'],
function(err, stdout){
if (err) throw err;
console.log('stdout:', stdout);
});
`
$3
Convenience function for resizing an image, modelled on top of convert.
The options argument have the following default values:
`javascript
{
srcPath: undefined,
srcData: null,
srcFormat: null,
dstPath: undefined,
quality: 0.8,
format: 'jpg',
progressive: false,
width: 0,
height: 0,
strip: true,
filter: 'Lagrange',
sharpening: 0.2,
customArgs: []
}
`
srcPath, dstPath and (at least one of) width and height are required. The rest is optional.
Example:
`javascript
GraphicsMagick.resize({
srcPath: 'kittens.jpg',
dstPath: 'kittens-small.jpg',
width: 256
}, function(err, stdout, stderr){
if (err) throw err;
console.log('resized kittens.jpg to fit within 256x256px');
});
`
Example with stdin/stdout:
`javascript
var fs = require('fs');
GraphicsMagick.resize({
srcData: fs.readFileSync('kittens.jpg', 'binary'),
width: 256
}, function(err, stdout, stderr){
if (err) throw err
fs.writeFileSync('kittens-resized.jpg', stdout, 'binary');
console.log('resized kittens.jpg to fit within 256x256px')
});
`
$3
Convenience function for resizing and cropping an image. _crop_ uses the resize method, so _options_ and _callback_ are the same. _crop_ uses _options.srcPath_, so make sure you set it :) Using only _options.width_ or _options.height_ will create a square dimensioned image. Gravity can also be specified, it defaults to Center. Available gravity options are [NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast]
Example:
`javascript
GraphicsMagick.crop({
srcPath: path,
dstPath: 'cropped.jpg',
width: 800,
height: 600,
quality: 1,
gravity: "North"
}, function(err, stdout, stderr){
// foo
});
``