22 stable releases

new 3.0.0+1.18.2 Nov 7, 2024
2.1.1+1.17.4 May 8, 2024
2.1.0+1.17.4 Nov 28, 2023
1.16.2 Sep 8, 2023
1.4.2 Jul 16, 2019

#325 in Images

Download history 557/week @ 2024-07-18 800/week @ 2024-07-25 795/week @ 2024-08-01 715/week @ 2024-08-08 745/week @ 2024-08-15 688/week @ 2024-08-22 853/week @ 2024-08-29 601/week @ 2024-09-05 922/week @ 2024-09-12 1170/week @ 2024-09-19 1467/week @ 2024-09-26 1369/week @ 2024-10-03 1353/week @ 2024-10-10 983/week @ 2024-10-17 717/week @ 2024-10-24 1027/week @ 2024-10-31

4,303 downloads per month
Used in 13 crates (2 directly)

MIT license

295KB
3K SLoC

libheif-sys is bindings to libheif

CHANGELOG

System dependencies

  • libheif-dev >= 1.18.0 (any version if use-bindgen feature is enabled).
  • clang - to generate rust bindings for libheif. 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.

Also, you can enable all or one of next features to compile libheif 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();
    };
}

Dependencies