README.md

AetherJFX AVIF Image Decoder Plugin

Warning

This plugin is designed to be used ONLY with JavaFX fork AetherJFX. Attempting to use it with standard JavaFX will lead to an exception!

AVIF image decoding plugin for AetherJFX

Based on vavi-image-avif and integrates into JavaFX's ImageIO (IIO) instead of default one that depends on AWT

Dependency

Warning

Prebuild Windows x86-64 library is included into jar. Refer to libavif repository for installation guide for other systems

Define custom Gradle ivy repository in repositories block:

repositories {
    //...your repositories
    def github = ivy {
        url 'https://github.com/'
        patternLayout {
            artifact '/[organisation]/[module]/releases/download/[revision]/[artifact].[ext]'
        }
        metadataSources { artifact() }
    }
    exclusiveContent {
        forRepositories(github)
        filter { includeGroup("0xD3ADCODE") }
    }
}

Add dependency into dependencies block:

dependencies {
    //...your dependencies
    implementation("0xD3ADCODE:AetherJFX-ImageDecoder-AVIF:{version}") {
        artifact {
            name = 'AetherJFX-ImageDecoder-AVIF-{version}'
            type = 'jar'
        }
    }

    // JNA is required for native library
    implementation 'net.java.dev.jna:jna:5.14.0'
}

Replace {version} with latest Release tag (eg, v1.0)

Usage

Register plugin as soon as possible (before JavaFX Toolkit start) with just one line of code:

AVIFLoader.register();

After that all AVIF images will be decoded using newly installed decoder directly into JavaFX's Image without AWT

Development

To properly build jar by yourself, clone repository and create gradle.properties file with:

AETHER_JFX_SDK_PATH = <path to unpacked AetherJFX SDK folder>

Credits

AOMediaCodec for AVIF decoder
umjammer for vavi-image-avif AVIF decoder/encoder implementation for Java