Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leafo/magick
Lua bindings to ImageMagick for LuaJIT using FFI
https://github.com/leafo/magick
Last synced: about 2 months ago
JSON representation
Lua bindings to ImageMagick for LuaJIT using FFI
- Host: GitHub
- URL: https://github.com/leafo/magick
- Owner: leafo
- Created: 2013-01-26T19:14:21.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-05-17T12:00:10.000Z (4 months ago)
- Last Synced: 2024-06-24T04:55:25.930Z (3 months ago)
- Language: Lua
- Size: 238 KB
- Stars: 393
- Watchers: 27
- Forks: 78
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-resty - magick
README
# magick
Lua bindings to ImageMagick's
[MagicWand](http://www.imagemagick.org/script/magick-wand.php) or
GraphicsMagick's [Wand](http://www.graphicsmagick.org/wand/wand.html) for
LuaJIT using FFI.
## Installation
You'll need both LuaJIT (any version) and MagickWand or GraphicsMagickinstalled.
On Ubuntu, to use ImageMagick, you might run:
```bash
$ sudo apt-get install luajit
$ sudo apt-get install libmagickwand-dev
```
You can install GraphicsMagick in place of, or alongside, ImageMagick:
```bash
$ sudo apt-get install libgraphicsmagick1-dev
```
It's recommended to use LuaRocks to install **magick**.
```bash
$ sudo apt-get install luarocks
$ luarocks install magick
```
## Basic Usage
If you just need to resize/crop an image, use the `thumb` function. It provides
a shorthand syntax for common operations.
```lua
local magick = require("magick")
magick.thumb("input.png", "100x100", "output.png")
```
The second argument to `thumb` is a size string, it can have the following
kinds of values:
```lua
"500x300" -- Resize image such that the aspect ratio is kept,
-- the width does not exceed 500 and the height does
-- not exceed 300
"500x300!" -- Resize image to 500 by 300, ignoring aspect ratio
"500x" -- Resize width to 500 keep aspect ratio
"x300" -- Resize height to 300 keep aspect ratio
"50%x20%" -- Resize width to 50% and height to 20% of original
"500x300#" -- Resize image to 500 by 300, but crop either top
-- or bottom to keep aspect ratio
"500x300+10+20" -- Crop image to 500 by 300 at position 10,20
```
If you need more advanced image operations, you'll need to work with the
`Image` object. Read on.
## Functions
All functions contained in the table returned by `require("magick")`.
#### `thumb(input_fname, size_str, out_fname=nil)`
Loads and resizes image. Write output to `out_fname` if provided, otherwise a
string is returned with the binary data of the resulting image.
(`input_fname` can optionally be an instance of `Image`)
`size_str` is a described above under `thumb`.
#### `load_image(fname)`
Return a new `Image` instance, loaded from filename. Returns `nil` and error
message if image could not be loaded.
#### `load_image_from_blob(blob)`
Loads an image from a Lua string containing the binary image data.
## `Image` object
Calling `load_image` or `load_image_from_blob` returns an `Image` object.
```lua
local magick = require "magick"
local img = assert(magick.load_image("hello.png"))
print("width:", img:get_width(), "height:", img:get_height());
img:resize(200, 200)
img:write("resized.png")
```
Images are automatically freed from memory by LuaJIT's garbage collector, but
images can take up a lot of space in memory when loaded so it's recommended to
call `destroy` on the image object as soon as possible.
### Using GraphicsMagick
ImageMagick and GraphicsMagick implement (mostly) the same interface. By
default the `magick` module will include ImageMagick. You can specify which
library you use by calling `require` on the module for the appropriate library.
At the moment it's impossible to include both libraries into the same process
due to collision of function names in the C namespace.
Load ImageMagick directly:
```lua
magick = requrie "magick.wand"
local img = magick.load_image("some_image.png")
```
Load GraphicsMagick directly:
```lua
magick = requrie "magick.gmwand"
local img = magick.load_image("some_image.png")
```
### Methods
> **Note:** Not all the functionality of the respective image libraries is
> exposted on the Image interface. Pull requests welcome.
Methods mutate the current image when appropriate. Use `clone` to get an
independent copy.
#### `img:resize(w,h, f="Lanczos2", blur=1.0)`
Resizes the image, `f` is resize function, see [Filer Types](http://www.imagemagick.org/api/MagickCore/resample_8h.html#a12be80da7313b1cc5a7e1061c0c108ea)
#### `img:adaptive_resize(w,h)`
Resizes the image using [adaptive resize](http://imagemagick.org/Usage/resize/#adaptive-resize)
#### `img:crop(w,h, x=0, y=0)`
Crops image to `w`,`h` where the top left is `x`, `y`
#### `img:blur(sigma, radius=0)`
Blurs the image with specified parameters. See [Blur Arguments](http://www.imagemagick.org/Usage/blur/#blur_args)
#### `img:rotate(degrees, r=0, g=0, b)`
Rotates the image by specified number of degrees. The image dimensions will
enlarge to prevent cropping. The triangles on the corners are filled with the
color specified by `r`, `g`, `b`. The color components are specified as
floating point numbers from 0 to 1.
#### `img:sharpen(sigma, radius=0)`
Sharpens the image with specified parameters. See [Sharpening Images](http://www.imagemagick.org/Usage/blur/#sharpen)
#### `img:resize_and_crop(w,h)`
Resizes the image to `w`,`h`. The image will be cropped if necessary to
maintain its aspect ratio.
#### `img:get_blob()`
Returns Lua string containing the binary data of the image. The blob is
formatted the same as the image's current format (eg. PNG, Gif, etc.). Use
`image:set_format` to change the format.
#### `img:write(fname)`
Writes the image to the specified filename
#### `img:get_width()`
Gets the width of the image
#### `img:get_height()`
Gets the height of the image
#### `img:get_format()`
Gets the current format of image as a file extension like `"png"` or `"bmp"`.
Use `image:set_format` to change the format.
#### `img:set_format(format)`
Sets the format of the image, takes a file extension like `"png"` or `"bmp"`
#### `img:get_quality()`
Gets the image compression quality.
#### `img:set_quality(quality)`
Sets the image compression quality.
#### `img:get_gravity()`
Gets the image gravity type.
#### `img:set_gravity(gravity)`
Sets the image's gravity type:
`gravity` can be one of the values listed in [data.moon](https://github.com/leafo/magick/blob/master/magick/wand/data.moon#L77)
#### `img:get_option(magick, key)`
Returns all the option names that match the specified pattern associated with a
image (e.g `img:get_option("webp", "lossless")`)
#### `img:set_option(magick, key, value)`
Associates one or options with the img (e.g `img:set_option("webp", "lossless", "0")`)
#### `img:scale(w, h)`
Scale the size of an image to the given dimensions.
#### `img:coalesce()`
Coalesces the current image by compositing each frame on the previous frame.
This un-optimized animated images to make them suitable for other methods.
#### `img:composite(source, x, y, compose)`
Composite another image onto another at the specified offset `x`, `y`.
`compose` can be one of the values listed in [data.moon](https://github.com/leafo/magick/blob/master/magick/wand/data.moon#L5)
#### `img:strip()`
Strips image of all profiles and comments, useful for removing exif and other data
#### `r,g,b,a = img:get_pixel(x, y)`
Get the r,g,b,a color components of a pixel in the image as doubles from `0` to `1`
#### `img:clone()`
Returns a copy of the image.
#### `img:modulate(brightness=100, saturation=100, hue=100)`
Adjust the brightness, saturation, and hue of the image. See [Modulate Brightness, Saturation, and Hue](http://www.imagemagick.org/Usage/color_mods/#modulate)
#### `img:thumb(size_str)`
Mutates the image to be a thumbnail. Uses the same size string format described
at the top of this README.
#### `img:destroy()`
Immediately frees the memory associated with the image, it is invalid to use
the image after calling this method. It is unnecessary to call this method
normally as images are tracked by the garbage collector.
# Tests
Tests use [Busted](http://olivinelabs.com/busted). Install and execute the
following command to run tests. You can check the output in
`spec/output_images/`.
```bash
$ busted
```
# Changelog
### 1.6.0 - Tue Feb 2 01:18:06 PM PST 2021
* Support ImageMagick 7
* Fix memory leak with `coalesce` for ImageMagick
* Add `sharpen`, `set_quality`, `auto_orient`, `get_colorspace`, `set_colorspace`, `level_image`, `hald_clut` for GraphicsMagick
* Throw error if size string can not be parsed in `thumb`, handle case when source size is missing, more specs for `thumb`
* Update test suite to GitHub actions, remove TravisCI
* Test suite runs for LuaJIT beta and OpenResty's LuaJIT fork
* Currently runs on Ubuntu: ImageMagick 6.9.10, GraphicsMagick 1.3.35, Arch Linux: ImageMagick 7.0.10.61, GraphicsMagick 1.3.36
* Fix broken spec for `modulate`
### 1.5.0 - Tue Jun 20 13:33:41 PDT 2017
* Add `get_depth` and `set_depth` to GraphicsMagick & ImageMagick
### 1.4.0 - Tue Jun 6 22:54:12 PDT 2017
* Add `reset_page` to GraphicsMagick
* Add `get_format` and `set_format` to GraphicsMagick
### 1.3.0 - Wed Mar 8 09:49:31 PST 2017
* Add modulate (@granpc)
* Add more methods to graphics magick: composite, clone, blur (@granpc)
* Add reset page to imagemagick wand (@thierrylamarre)
* Clone method is uses the clone function provided by image magick, garbage collects new image
* Add `thumb` method on the image class
### 1.2.0 - Tue Jul 12 21:10:23 PDT 2016
* Add preliminary GraphicsMagick support
* Fix bug with gravity getter/setter (@ram-nadella)
* Add additional wand method: https://github.com/leafo/magick/pull/32 (@sergeyfedotov)
### 1.1.0 - Thu Oct 22 05:11:41 UTC 2015
* add automatic memory management with `ffi.gc`
* fix some string memory leaks when getting type and options of image
* add `coalesce`, `rotate` methods to image
* use `pkg-config` instead of `MagickWand-config` to query library
* all include paths provided by config are searched instead of first
# Contact
Author: Leaf Corcoran (leafo) ([@moonscript](http://twitter.com/moonscript))
Email: [email protected]
Homepage: