magick-rust/README.md
Nathan Fiedler b63f25c550 Enforce MagickWand version in build.rs
It is very easy to overlook the version of MagickWand mentioned in the
README, so make sure the build system enforces it.

Fixes #19

cargo test passes
2016-10-16 11:00:06 -07:00

1.7 KiB

magick-rust

A somewhat safe Rust interface to the ImageMagick system, in particular, the MagickWand library. Many of the functions in the MagickWand API are still missing, and those that are needed will be gradually added.

Dependenices

  • Rust (~latest release)
  • Cargo (~latest release)
  • ImageMagick (version 6.9)
    • Homebrew and FreeBSD provide this version
    • Linux may require building ImageMagick from source
  • Clang (version 3.5 or higher)
    • Or whatever version is dictated by rust-bindgen
  • rust-bindgen (version 0.19 or higher)
    • This will be installed automatically if it is missing.

See the docs/Development_Setup.md file for details particular to each platform.

Build and Test

Pretty simple for now.

$ cargo build
$ cargo test

Example Usage

MagickWand has some global state that needs to be initialized prior to using the library, but fortunately Rust makes handling this pretty easy. In the example below, we read in an image from a file and resize it to fit a square of 240 by 240 pixels, then convert the image to JPEG.

use magick_rust::{MagickWand, magick_wand_genesis};
use std::sync::{Once, ONCE_INIT};

// Used to make sure MagickWand is initialized exactly once. Note that we
// do not bother shutting down, we simply exit when we're done.
static START: Once = ONCE_INIT;

fn resize() -> Result<Vec<u8>, &'static str> {
    START.call_once(|| {
        magick_wand_genesis();
    });
    let wand = MagickWand::new();
    try!(wand.read_image("kittens.jpg"));
    wand.fit(240, 240);
    wand.write_image_blob("jpeg")
}