https://github.com/tirr-c/jxl-oxide

Pure Rust implementation of JPEG XL decoder
https://github.com/tirr-c/jxl-oxide

image jpeg-xl jxl rust

Last synced: about 8 hours ago
JSON representation

Pure Rust implementation of JPEG XL decoder

• Host: GitHub
• URL: https://github.com/tirr-c/jxl-oxide
• Owner: tirr-c
• License: apache-2.0
• Created: 2022-11-28T10:19:34.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T09:19:11.000Z (3 months ago)
• Last Synced: 2024-10-29T09:22:46.282Z (3 months ago)
• Topics: image, jpeg-xl, jxl, rust
• Language: Rust
• Homepage:
• Size: 1.92 MB
• Stars: 296
• Watchers: 12
• Forks: 13
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# jxl-oxide

[![crates.io](https://img.shields.io/crates/v/jxl-oxide.svg)](https://crates.io/crates/jxl-oxide)

[![docs.rs](https://docs.rs/jxl-oxide/badge.svg)](https://docs.rs/crate/jxl-oxide/)

[![Build Status](https://img.shields.io/github/actions/workflow/status/tirr-c/jxl-oxide/build.yml?branch=main)](https://github.com/tirr-c/jxl-oxide/actions/workflows/build.yml?query=branch%3Amain)

A spec-conforming JPEG XL decoder written in pure Rust[^1].

If you want to use it as a library, add `jxl-oxide` in `Cargo.toml`. `jxl-oxide` is a blanket crate

which covers various components of jxl-oxide.

```toml

[dependencies]

jxl-oxide = "0.11.1"

```

## Installing command line tool

Install `jxl-oxide-cli` using `cargo install`. It will install a binary named `jxl-oxide`.

```

cargo install jxl-oxide-cli

```

## Feature flags

`jxl-oxide` and `jxl-oxide-cli` have different sets of feature flags.

**For `jxl-oxide`:**

- `rayon` (default): Enable multithreading using `rayon`.

- `lcms2`: Integrate into Little CMS 2 which supports arbitrary ICC profiles and enables CMYK to RGB

  conversion. (Note that this will add dependencies written in C.)

- `image`: Integrate into the `image` crate. `jxl_oxide::integration::JxlDecoder` will be made

  available.

**For `jxl-oxide-cli`:**

- `rayon` (default): Enable multithreading using `rayon`.

- `mimalloc` (default): Use mimalloc as memory allocator.

- `__devtools` (unstable): Enable devtool subcommands.

- `__ffmpeg` (unstable): Link to FFmpeg and enable video encoding in devtool subcommands.

---

Dual-licensed under MIT and Apache 2.0.

[^1]: Integration with Little CMS 2, which is written in C, can be enabled with `lcms2` feature.

[conformance]: https://github.com/libjxl/conformance