Awesome
libheif-sys
libheif-sys
is a binding to libheif.
A high-level wrapper libheif-rs is also available.
System dependencies
libheif-dev
>= 1.18.0.clang
- to generate rust bindings forlibheif
. See bindgen requirements.
clang
wouldn't be needed if you disable use-bindgen
feature.
In this case the pre-generated file bindings.rs
will be used
instead of generating it on the fly with help of bindgen
crate.
Warning: bindings.rs
file was generated under x64 linux and may
not work as expected under x32 architectures or other operating systems.
Linux
The crate uses pkg-confing
to find installed libheif
.
You can also enable all or any of the following features to compile
libheif v1.18.2
from GitHub
and link it statically:
compile-libheif
embedded-libheif-plugins
Note: Static linked version of libheif
doesn't have statically linked
it dependencies, such as libde256
, libaom
and other.
Windows
The crate uses vcpkg crate
to find libheif
installed with help of vcpkg
.
You can use cargo-vcpkg
to install libheif
with help of cargo
command:
cargo vcpkg -v build
cargo-vcpkg
can fetch and build a vcpkg
installation of required
packages from scratch. It merges package requirements specified in
the Cargo.toml
of crates in the dependency tree.
Example of reading and decoding HEIF-image
use std::ffi;
use std::ptr;
use libheif_sys as lh;
#[test]
fn read_and_decode_heic_file() {
unsafe {
lh::heif_init(ptr::null_mut());
let ctx = lh::heif_context_alloc();
assert!(!ctx.is_null());
let c_name = ffi::CString::new("data/test.heif").unwrap();
let err = lh::heif_context_read_from_file(
ctx,
c_name.as_ptr(),
ptr::null()
);
assert_eq!(err.code, lh::heif_error_code_heif_error_Ok);
let mut handle = ptr::null_mut();
let err = lh::heif_context_get_primary_image_handle(ctx, &mut handle);
assert_eq!(err.code, lh::heif_error_code_heif_error_Ok);
assert!(!handle.is_null());
let width = lh::heif_image_handle_get_width(handle);
assert_eq!(width, 4032);
let height = lh::heif_image_handle_get_height(handle);
assert_eq!(height, 3024);
let mut image = ptr::null_mut();
let options = lh::heif_decoding_options_alloc();
let err = lh::heif_decode_image(
handle,
&mut image,
lh::heif_colorspace_heif_colorspace_RGB,
lh::heif_chroma_heif_chroma_interleaved_RGB,
options,
);
lh::heif_decoding_options_free(options);
assert_eq!(err.code, lh::heif_error_code_heif_error_Ok);
assert!(!image.is_null());
let colorspace = lh::heif_image_get_colorspace(image);
assert_eq!(colorspace, lh::heif_colorspace_heif_colorspace_RGB);
let chroma_format = lh::heif_image_get_chroma_format(image);
assert_eq!(chroma_format, lh::heif_chroma_heif_chroma_interleaved_RGB);
let width = lh::heif_image_get_width(
image,
lh::heif_channel_heif_channel_interleaved
);
assert_eq!(width, 4032);
let height = lh::heif_image_get_height(
image,
lh::heif_channel_heif_channel_interleaved
);
assert_eq!(height, 3024);
lh::heif_context_free(ctx);
lh::heif_deinit();
};
}