This AVIF coder plugin currently support AVIF still image decoding. Including alpha channel, as well as 10bit/12bit/16bit HDR images.
The AVIF encoding is also supported now. Which always encode as 8-bit depth images.
AVIF image spec is still in evolve. And the current upstream AVIF codec is a simple implementation. The encoding time may be long for large images.
Since we rely on the external codec libavif. We may periodically update the dependency and bump version. Make sure you're using the latest version as possible as you can :)
libavif is a still image codec. But AVIF is based on the AV1 Video standard. So it need a AV1 codec for support. This relationship is just like HEIF(image) and HEVC(video) codec.
By default, libavif is built with aom codec support. aom is the first AV1 codec during the standard draft implementation.
dav1d is the new and next generation AV1 codec, focused on speed and correctness.
From v0.3.0, libavif can built with dav1d. For CocoaPods user, you can simply use the subspec for this. Carthage for optional dav1d codec is not supported currently.
rav1e is the fastest and safest AV1 encoder. Which use Rust programming to provide fast and safe codec compared to aom. Its current form it is most suitable for cases where libaom (the reference encoder) is too slow.
See more about performance
From v0.4.3, libavif can built with rav1e. For CocoaPods user, you can simply use the subspec for this. Carthage for optional rav1c codec is not supported currently.
Note rav1e currently only support iOS && macOS. watchOS and tvOS supports need Rust community upstream support.
Note that for CocoaPods user, rav1e is prebuilt binary (to avoid developer to install rust toolchain) and hosted on GitHub Git LFS. Make sure you have git-lfs installed.
brew install git-lfs git lfs install
SDWebImageAVIFCoder is available through CocoaPods. To install it with default aom AV1 codec, simply add the following line to your Podfile:
Note: From version 0.4.0, if you want to use rav1e or dav1e instead aom for faster AV1 codec, control the subspec of libavif instead:
pod 'SDWebImageAVIFCoder' pod 'libavif', :subpsecs => [ 'libdav1d', 'librav1e' ]
Note: From version 0.2.0, the dependency libavif and libaom use the portable C implementation to works on Apple platforms. If you need the pre-built library with SIMD/AVX and assembly optimization, try the 0.1.0 version.
SDWebImageAVIFCoder is available through Carthage.
Carthage does not support like CocoaPods' subspec, it only supports libaom for AVIF decoding && encoding.
SDWebImageAVIFCoder is available through Swift Package Manager.
The framework through SwiftPM only supports libaom for AVIF decoding && encoding.
let package = Package( dependencies: [ .package(url: "https://github.com/SDWebImage/SDWebImageAVIF.git", from: "0.5") ] )
To use AVIF coder, you should firstly add the
SDImageAVIFCoder.sharedCoder to the coders manager. Then you can call the View Category method to start load AVIF images.
SDImageAVIFCoder *AVIFCoder = SDImageAVIFCoder.sharedCoder; [[SDImageCodersManager sharedManager] addCoder:AVIFCoder]; UIImageView *imageView; [imageView sd_setImageWithURL:url];
let AVIFCoder = SDImageAVIFCoder.shared SDImageCodersManager.shared.addCoder(AVIFCoder) let imageView: UIImageView imageView.sd_setImage(with: url)
The images are from AV1 Still Image File Format Specification Test Files.
AVIF is a new image format, which lack of related toolchains like Browser or Desktop Viewer support.
You can try AVIFQuickLook QuickLook plugin on macOS to view it in Finder.
You can also try using avif.js to view it online by using Chrome's AV1 codec.
SDWebImageAVIFCoder use GitHub Actions for testing. Each merge request will run the test cases to ensure the AVIF decoding/encoding function works.
Current test cases use macOS command line tools, to compare the AVIF sample decoding result with ImageMagick.
We have also the XCTest unit test target, you can run it by using Xcode's Test action.
SDWebImageAVIFCoder is available under the MIT license. See the LICENSE file for more info.
|Last commit: 13 weeks ago|