FileOnQ.Imaging.Heif

A C#/.NET wrapper around libheif to simplify opening heic images and retrieving thumbnails.

Contributing

⭐ Pull Requests and Issues are always welcomed ⭐

• Contributing
• Developer Guide
• Building
• CI Builds

Setup

Install the NuGet package into your target head and any shared projects.

The NuGet package must be included in the entry point or target head, otherwise the native assemblies won't be copied over to the bin directory correctly.

Windows

Any Windows device running an application using this library requires the Visual C++ Redistributable package installed. See the Microsoft Visual C++ Redistributable Latest Supported Downloads. You will need to install the correct CPU Architecture(s) that your application supports.

• vc_redist.arm64.exe
• vc_redist.x86.exe
• vc_redist.x64.exe

Supported Target Frameworks

FileOnQ.Imaging.Heif is available for use in the following target frameworks

Platform	Supported	Version
net48	✅	1.0.0
net5.0	✅	1.0.0
Xamarin.iOS	❌	Planned
Xamarin.Mac	❌	Planned
MonoAndroid	❌	Planned

Supported Runtime Identifiers

FileOnQ.Imaging.Heif is available for use in the following runtime identifiers

Platform	Supported	Version
win-x86	✅	1.0.0
win-x64	✅	1.0.0
win-ARM64	❌	Planned
osx-x64	❌	Planned
linux-x64	❌	Planned

Usage

Saves the primary image as a jpeg

using (var image = new HeifImage("image.heic"))
using (var primary = image.Primary())
{
    primary.Write("output.jpeg", 90);
}

Saves the embedded thumbnail as a jpeg

using (var image = new HeifImage("image.heic"))
using (var thumbnail = image.Thumbnail())
{
    thumbnail.Write("output.jpeg", 90);
}

Documentation

We don't have a wiki or full API documentation. If you are interested in helping, create an issue so we can discuss.

Dependencies

FileOnQ.Imaging.Heif uses several native C/C++ dependent libraries

• libheif
• dav1d
• libjpeg-turbo
• libde265

Created By FileOnQ

This library was created by FileOnQ and donated to the open source community.