gm

GraphicsMagick for node

Image processing
aheckmann/gmaheckmann.github.com/gm/gm

README


gm Build Status  NPM Version


GraphicsMagick and ImageMagick for node

Bug Reports


When reporting bugs please include the version of graphicsmagick/imagemagick you're using (gm -version/convert -version) as well as the version of this module and copies of any images you're having problems with.

Getting started

First download and install GraphicsMagick or ImageMagick. In Mac OS X, you can simply use Homebrew and do:

    brew install imagemagick
    brew install graphicsmagick

then either use npm:

    npm install gm

or clone the repo:

    git clone git://github.com/aheckmann/gm.git


Use ImageMagick instead of gm


Subclass gm to enable ImageMagick 7+

  1. ``` js
  2. const fs = require('fs')
  3. const gm = require('gm').subClass({ imageMagick: '7+' });
  4. ```

Or, to enable ImageMagick legacy mode (for ImageMagick version < 7)

  1. ``` js
  2. const fs = require('fs')
  3. const gm = require('gm').subClass({ imageMagick: true });
  4. ```

Specify the executable path


Optionally specify the path to the executable.

  1. ``` js
  2. const fs = require('fs')
  3. const gm = require('gm').subClass({
  4.   appPath: String.raw`C:\Program Files\ImageMagick-7.1.0-Q16-HDRI\magick.exe`
  5. });
  6. ```

Basic Usage


  1. ``` js
  2. var fs = require('fs')
  3.   , gm = require('gm');

  5. // resize and remove EXIF profile data
  6. gm('/path/to/my/img.jpg')
  7. .resize(240, 240)
  8. .noProfile()
  9. .write('/path/to/resize.png', function (err) {
  10.   if (!err) console.log('done');
  11. });

  13. // some files would not be resized appropriately
  14. // http://stackoverflow.com/questions/5870466/imagemagick-incorrect-dimensions
  15. // you have two options:
  16. // use the '!' flag to ignore aspect ratio
  17. gm('/path/to/my/img.jpg')
  18. .resize(240, 240, '!')
  19. .write('/path/to/resize.png', function (err) {
  20.   if (!err) console.log('done');
  21. });

  23. // use the .resizeExact with only width and/or height arguments
  24. gm('/path/to/my/img.jpg')
  25. .resizeExact(240, 240)
  26. .write('/path/to/resize.png', function (err) {
  27.   if (!err) console.log('done');
  28. });

  30. // obtain the size of an image
  31. gm('/path/to/my/img.jpg')
  32. .size(function (err, size) {
  33.   if (!err)
  34.     console.log(size.width > size.height ? 'wider' : 'taller than you');
  35. });

  37. // output all available image properties
  38. gm('/path/to/img.png')
  39. .identify(function (err, data) {
  40.   if (!err) console.log(data)
  41. });

  43. // pull out the first frame of an animated gif and save as png
  44. gm('/path/to/animated.gif[0]')
  45. .write('/path/to/firstframe.png', function (err) {
  46.   if (err) console.log('aaw, shucks');
  47. });

  49. // auto-orient an image
  50. gm('/path/to/img.jpg')
  51. .autoOrient()
  52. .write('/path/to/oriented.jpg', function (err) {
  53.   if (err) ...
  54. })

  56. // crazytown
  57. gm('/path/to/my/img.jpg')
  58. .flip()
  59. .magnify()
  60. .rotate('green', 45)
  61. .blur(7, 3)
  62. .crop(300, 300, 150, 130)
  63. .edge(3)
  64. .write('/path/to/crazy.jpg', function (err) {
  65.   if (!err) console.log('crazytown has arrived');
  66. })

  68. // annotate an image
  69. gm('/path/to/my/img.jpg')
  70. .stroke("#ffffff")
  71. .drawCircle(10, 10, 20, 10)
  72. .font("Helvetica.ttf", 12)
  73. .drawText(30, 20, "GMagick!")
  74. .write("/path/to/drawing.png", function (err) {
  75.   if (!err) console.log('done');
  76. });

  78. // creating an image
  79. gm(200, 400, "#ddff99f3")
  80. .drawText(10, 50, "from scratch")
  81. .write("/path/to/brandNewImg.jpg", function (err) {
  82.   // ...
  83. });
  84. ```

Streams


  1. ``` js
  2. // passing a stream
  3. var readStream = fs.createReadStream('/path/to/my/img.jpg');
  4. gm(readStream, 'img.jpg')
  5. .write('/path/to/reformat.png', function (err) {
  6.   if (!err) console.log('done');
  7. });


  10. // passing a downloadable image by url

  12. var request = require('request');
  13. var url = "www.abc.com/pic.jpg"

  15. gm(request(url))
  16. .write('/path/to/reformat.png', function (err) {
  17.   if (!err) console.log('done');
  18. });


  21. // can also stream output to a ReadableStream
  22. // (can be piped to a local file or remote server)
  23. gm('/path/to/my/img.jpg')
  24. .resize('200', '200')
  25. .stream(function (err, stdout, stderr) {
  26.   var writeStream = fs.createWriteStream('/path/to/my/resized.jpg');
  27.   stdout.pipe(writeStream);
  28. });

  30. // without a callback, .stream() returns a stream
  31. // this is just a convenience wrapper for above.
  32. var writeStream = fs.createWriteStream('/path/to/my/resized.jpg');
  33. gm('/path/to/my/img.jpg')
  34. .resize('200', '200')
  35. .stream()
  36. .pipe(writeStream);

  38. // pass a format or filename to stream() and
  39. // gm will provide image data in that format
  40. gm('/path/to/my/img.jpg')
  41. .stream('png', function (err, stdout, stderr) {
  42.   var writeStream = fs.createWriteStream('/path/to/my/reformatted.png');
  43.   stdout.pipe(writeStream);
  44. });

  46. // or without the callback
  47. var writeStream = fs.createWriteStream('/path/to/my/reformatted.png');
  48. gm('/path/to/my/img.jpg')
  49. .stream('png')
  50. .pipe(writeStream);

  52. // combine the two for true streaming image processing
  53. var readStream = fs.createReadStream('/path/to/my/img.jpg');
  54. gm(readStream)
  55. .resize('200', '200')
  56. .stream(function (err, stdout, stderr) {
  57.   var writeStream = fs.createWriteStream('/path/to/my/resized.jpg');
  58.   stdout.pipe(writeStream);
  59. });

  61. // GOTCHA:
  62. // when working with input streams and any 'identify'
  63. // operation (size, format, etc), you must pass "{bufferStream: true}" if
  64. // you also need to convert (write() or stream()) the image afterwards
  65. // NOTE: this buffers the readStream in memory!
  66. var readStream = fs.createReadStream('/path/to/my/img.jpg');
  67. gm(readStream)
  68. .size({bufferStream: true}, function(err, size) {
  69.   this.resize(size.width / 2, size.height / 2)
  70.   this.write('/path/to/resized.jpg', function (err) {
  71.     if (!err) console.log('done');
  72.   });
  73. });

  75. ```

Buffers


  1. ``` js
  2. // A buffer can be passed instead of a filepath as well
  3. var buf = require('fs').readFileSync('/path/to/image.jpg');

  5. gm(buf, 'image.jpg')
  6. .noise('laplacian')
  7. .write('/path/to/out.jpg', function (err) {
  8.   if (err) return handle(err);
  9.   console.log('Created an image from a Buffer!');
  10. });

  12. /*
  13. A buffer can also be returned instead of a stream
  14. The first argument to toBuffer is optional, it specifies the image format
  15. */
  16. gm('img.jpg')
  17. .resize(100, 100)
  18. .toBuffer('PNG',function (err, buffer) {
  19.   if (err) return handle(err);
  20.   console.log('done!');
  21. })
  22. ```

Custom Arguments


If gm does not supply you with a method you need or does not work as you'd like, you can simply use gm().in() or gm().out() to set your own arguments.

- gm().command() - Custom command such as identify or convert
- gm().in() - Custom input arguments
- gm().out() - Custom output arguments

The command will be formatted in the following order:

1. command - ie convert
2. in - the input arguments
3. source - stdin or an image file
4. out - the output arguments
5. output - stdout or the image file to write to

For example, suppose you want the following command:

  1. ``` sh
  2. gm "convert" "label:Offline" "PNG:-"
  3. ```

However, using gm().label() may not work as intended for you:

  1. ``` js
  2. gm()
  3. .label('Offline')
  4. .stream();
  5. ```

would yield:

  1. ``` sh
  2. gm "convert" "-label" "\"Offline\"" "PNG:-"
  3. ```

Instead, you can use gm().out():

  1. ``` js
  2. gm()
  3. .out('label:Offline')
  4. .stream();
  5. ```

which correctly yields:

  1. ``` sh
  2. gm "convert" "label:Offline" "PNG:-"
  3. ```

Custom Identify Format String


When identifying an image, you may want to use a custom formatting string instead of using -verbose, which is quite slow.
You can use your own formatting string when usinggm().identify(format, callback).
For example,

  1. ``` js
  2. gm('img.png').format(function (err, format) {

  4. })

  6. // is equivalent to

  8. gm('img.png').identify('%m', function (err, format) {

  10. })
  11. ```

since %m is the format option for getting the image file format.

Platform differences


Please document and refer to any platform or ImageMagick/GraphicsMagick issues/differences here.

Examples:


  Check out the examples directory to play around.
  Also take a look at the extending gm
  page to see how to customize gm to your own needs.

Constructor:


  There are a few ways you can use the gm image constructor.

  - 1) gm(path) When you pass a string as the first argument it is interpreted as the path to an image you intend to manipulate.
  - 2) gm(stream || buffer, [filename]) You may also pass a ReadableStream or Buffer as the first argument, with an optional file name for format inference.
  - 3) gm(width, height, [color]) When you pass two integer arguments, gm will create a new image on the fly with the provided dimensions and an optional background color. And you can still chain just like you do with pre-existing images too. See here for an example.

The links below refer to an older version of gm but everything should still work, if anyone feels like updating them please make a PR

Methods


  - getters
    - size - returns the size (WxH) of the image
    - orientation - returns the EXIF orientation of the image
    - format - returns the image format (gif, jpeg, png, etc)
    - depth - returns the image color depth
    - color - returns the number of colors
    - res   - returns the image resolution
    - filesize - returns image filesize
    - identify - returns all image data available. Takes an optional format string.

  - manipulation
    - adjoin
    - affine
    - antialias
    - append
    - authenticate
    - autoOrient
    - average
    - backdrop
    - bitdepth
    - blackThreshold
    - bluePrimary
    - blur
    - border
    - borderColor
    - box
    - channel
    - charcoal
    - chop
    - clip
    - coalesce
    - colors
    - colorize
    - colorMap
    - colorspace
    - comment
    - compose
    - compress
    - contrast
    - convolve
    - createDirectories
    - crop
    - cycle
    - deconstruct
    - delay
    - define
    - density
    - despeckle
    - dither
    - displace
    - display
    - dispose
    - dissolve
    - edge
    - emboss
    - encoding
    - enhance
    - endian
    - equalize
    - extent
    - file
    - filter
    - flatten
    - flip
    - flop
    - foreground
    - frame
    - fuzz
    - gamma
    - gaussian
    - geometry
    - gravity
    - greenPrimary
    - highlightColor
    - highlightStyle
    - iconGeometry
    - implode
    - intent
    - interlace
    - label
    - lat
    - level
    - list
    - limit
    - log
    - loop
    - lower
    - magnify
    - map
    - matte
    - matteColor
    - mask
    - maximumError
    - median
    - minify
    - mode
    - modulate
    - monitor
    - monochrome
    - morph
    - mosaic
    - motionBlur
    - name
    - negative
    - noise
    - noop
    - normalize
    - noProfile
    - opaque
    - operator
    - orderedDither
    - outputDirectory
    - paint
    - page
    - pause
    - pen
    - ping
    - pointSize
    - preview
    - process
    - profile
    - progress
    - quality
    - raise
    - rawSize
    - randomThreshold
    - recolor
    - redPrimary
    - region
    - remote
    - render
    - repage
    - resample
    - resize
    - roll
    - rotate
    - sample
    - samplingFactor
    - scale
    - scene
    - scenes
    - screen
    - segment
    - sepia
    - set
    - setFormat
    - shade
    - shadow
    - sharedMemory
    - sharpen
    - shave
    - shear
    - silent
    - solarize
    - snaps
    - stegano
    - stereo
    - strip _imagemagick only_
    - spread
    - swirl
    - textFont
    - texture
    - threshold
    - thumb
    - tile
    - transform
    - transparent
    - treeDepth
    - trim
    - type
    - update
    - units
    - unsharp
    - usePixmap
    - view
    - virtualPixel
    - visual
    - watermark
    - wave
    - whitePoint
    - whiteThreshold
    - window
    - windowGroup

  - drawing primitives
    - draw
    - drawArc
    - drawBezier
    - drawCircle
    - drawEllipse
    - drawLine
    - drawPoint
    - drawPolygon
    - drawPolyline
    - drawRectangle
    - drawText
    - fill
    - font
    - fontSize
    - stroke
    - strokeWidth
    - setDraw

  - image output
    - write - writes the processed image data to the specified filename
    - stream - provides a ReadableStream with the processed image data
    - toBuffer - returns the image as a Buffer instead of a stream

compare


Graphicsmagicks compare command is exposed through gm.compare(). This allows us to determine if two images can be considered "equal".

Currently gm.compare only accepts file paths.

    gm.compare(path1, path2 [, options], callback)

  1. ``` js
  2. gm.compare('/path/to/image1.jpg', '/path/to/another.png', function (err, isEqual, equality, raw, path1, path2) {
  3.   if (err) return handle(err);

  5.   // if the images were considered equal, `isEqual` will be true, otherwise, false.
  6.   console.log('The images were equal: %s', isEqual);

  8.   // to see the total equality returned by graphicsmagick we can inspect the `equality` argument.
  9.   console.log('Actual equality: %d', equality);

  11.   // inspect the raw output
  12.   console.log(raw);

  14.   // print file paths
  15.   console.log(path1, path2);
  16. })
  17. ```

You may wish to pass a custom tolerance threshold to increase or decrease the default level of 0.4.


  1. ``` js
  2. gm.compare('/path/to/image1.jpg', '/path/to/another.png', 1.2, function (err, isEqual) {
  3.   ...
  4. })
  5. ```

To output a diff image, pass a configuration object to define the diff options and tolerance.


  1. ``` js
  2. var options = {
  3.   file: '/path/to/diff.png',
  4.   highlightColor: 'yellow',
  5.   tolerance: 0.02
  6. }
  7. gm.compare('/path/to/image1.jpg', '/path/to/another.png', options, function (err, isEqual, equality, raw) {
  8.   ...
  9. })
  10. ```

composite


GraphicsMagick supports compositing one image on top of another. This is exposed through gm.composite(). Its first argument is an image path with the changes to the base image, and an optional mask image.

Currently, gm.composite() only accepts file paths.

    gm.composite(other [, mask])

  1. ``` js
  2. gm('/path/to/image.jpg')
  3. .composite('/path/to/second_image.jpg')
  4. .geometry('+100+150')
  5. .write('/path/to/composite.png', function(err) {
  6.     if(!err) console.log("Written composite image.");
  7. });
  8. ```

montage


GraphicsMagick supports montage for combining images side by side. This is exposed through gm.montage(). Its only argument is an image path with the changes to the base image.

Currently, gm.montage() only accepts file paths.

    gm.montage(other)

  1. ``` js
  2. gm('/path/to/image.jpg')
  3. .montage('/path/to/second_image.jpg')
  4. .geometry('+100+150')
  5. .write('/path/to/montage.png', function(err) {
  6.     if(!err) console.log("Written montage image.");
  7. });
  8. ```

Contributors

https://github.com/aheckmann/gm/contributors

Inspiration

http://github.com/quiiver/magickal-node

Plugins

https://github.com/aheckmann/gm/wiki

Tests

npm test

To run a single test:

  1. ```
  2. npm test -- alpha.js
  3. ```

License


(The MIT License)

Copyright (c) 2010 Aaron Heckmann

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.