heic

package module

v0.4.8 Latest Latest Go to latest Published: Dec 28, 2025 License: MIT Imports: 18 Imported by: 9

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/gen2brain/heic

Links

Open Source Insights

README ¶

heic

Go decoder for HEIC Image File Format (HEVC in HEIF).

Based on libheif and libde265 compiled to WASM and used with wazero runtime (CGo-free).

The library will first try to use a dynamic/shared library (if installed) via purego and will fall back to WASM.

Build tags

nodynamic - do not use dynamic/shared library (use only WASM)

Documentation ¶

Rendered for

Overview ¶

Package heic implements an HEIC image decoder based on libheif/libde265 compiled to WASM.

Index ¶

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrMemRead  = errors.New("heic: mem read failed")
	ErrMemWrite = errors.New("heic: mem write failed")
	ErrDecode   = errors.New("heic: decode failed")
)

Errors .

View Source

var ForceWasmMode bool

ForceWasmMode, if true, forces using the WASM-based decoder even if a dynamic/shared library is available.

This exists mainly for testing purposes.

It is not safe to change this concurrently with any other use of this package.

Functions ¶

func Decode ¶

func Decode(r io.Reader) (image.Image, error)

Decode reads a HEIC image from r and returns it as an image.Image.

func DecodeConfig ¶

func DecodeConfig(r io.Reader) (image.Config, error)

DecodeConfig returns the color model and dimensions of a HEIC image without decoding the entire image.

func Dynamic ¶ added in v0.2.1

func Dynamic() error

Dynamic returns error (if there was any) during opening dynamic/shared library.

func Init ¶ added in v0.4.0

func Init()

Init initializes wazero runtime and compiles the module. This function does nothing if a dynamic/shared library is used and Dynamic() returns nil. There is no need to explicitly call this function, first Decode will initialize the runtime.

Types ¶

This section is empty.

Source Files ¶

View all Source files