avif

README

avif

Go decoder for AV1 Image File Format (AVIF).

Based on libavif and dav1d 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.

Documentation

Overview

Package avif implements an AVIF image decoder based on libavif compiled to WASM.

Index

• Variables
• func Decode(r io.Reader) (image.Image, error)
• func DecodeConfig(r io.Reader) (image.Config, error)
• type AVIF
  • func DecodeAll(r io.Reader) (*AVIF, error)

Variables

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

Errors .

Functions

func Decode

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

Decode reads a AVIF 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 AVIF image without decoding the entire image.

Types

type AVIF

type AVIF struct {
	// Decoded images, NRGBA or NRGBA64.
	Image []image.Image
	// Delay times, one per frame, in seconds.
	Delay []float64
}

AVIF represents the possibly multiple images stored in a AVIF file.

func DecodeAll

func DecodeAll(r io.Reader) (*AVIF, error)

DecodeAll reads a AVIF image from r and returns the sequential frames and timing information.