Rust bindings for TurboJPEG, which provides simple and fast compression/decompression of JPEG images.
TurboJPEG is a high-level API provided by [libjpeg-turbo].
To quickly encode and decode images from the image
crate, add this
to the [dependencies]
section in your Cargo.toml
:
turbojpeg = {version = "0.2", features = ["image"]}
and then use the functions turbojpeg::decompress_image
and
turbojpeg::compress_image
. For more details, please see the
documentation.
The low-level binding to libturbojpeg
is provided by the crate
turbojpeg-sys
, which needs:
bindgen
.rustc
will use to link against libturbojpeg
.By default, the turbojpeg-sys
crate uses a pregenerated Rust binding code (so
you don't need the C headers) and the default linker flags -l turbojpeg
.
However, this behavior can be altered in several ways:
pkg-config
uses the pkg-config
tool to find the linker flags
and the include paths for C headers that are specific for your system.TURBOJPEG_INCLUDE_PATH
, if specified, adds an extra
include path for C headers.bindgen
uses the bindgen
tool to generate Rust binding code
at build time, instead of using the pregenerated code. If no include paths
are specified (using pkg-config
or TURBOJPEG_INCLUDE_PATH
), we use
headers that are bundled with turbojpeg-sys
.All this magic is implemented in the build.rs
script in turbojpeg-sys
. If
you think that it could be improved, or if you encounter an error on your
system, please open an issue or a pull request.
All contributions are welcome! Please contact me (@honzasp) or open a pull request. This crate is rather minimal, the main areas of improvement are:
turbojpeg
crate.turbojpeg-sys
crate, so that it works
seamlessly on a wide range of systems.This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.