gojxl

README

go-jxl-decode

A Golang wrapper for libjxl.

Building

On Windows, download the latest release of libjxl and extract the DLLs to the same directory as your application. You need all of them.

After building, the application might be statically linked? I'm not sure about that but it seems to be the case.

On Linux, install libbrotli-dev and, if your distro has it, libjxl-dev. (If not, get the package from the above link.)

Usage

This library registers itself with image and additionally exports Decode, DecodeConfig and Encode, which work as you might expect. For more complex usage, such as multi-frame JXLs, use the JxlEncoder and JxlDecoder objects.

Note that only Gray, RGBA, and NRGBA color models and their 16-bit counterparts are identitifed by the library.

Documentation

Index

• func Decode(r io.Reader) (image.Image, error)
• func DecodeConfig(r io.Reader) (image.Config, error)
• func Encode(w io.Writer, img image.Image) error
• type DecodeError
  • func (e DecodeError) Error() string
• type EncodeError
  • func (e EncodeError) Error() string
• type JxlDecoder
  • func NewJxlDecoder(r io.Reader) *JxlDecoder
  • func (d *JxlDecoder) Destroy()
  • func (d *JxlDecoder) FrameDuration() time.Duration
  • func (d *JxlDecoder) Info() (JxlInfo, error)
  • func (d *JxlDecoder) Read() ([]byte, error)
  • func (d *JxlDecoder) Reset(r io.Reader)
  • func (d *JxlDecoder) Rewind()
• type JxlEncoder
  • func NewJxlEncoder(w io.Writer) *JxlEncoder
  • func (e *JxlEncoder) Destroy()
  • func (e *JxlEncoder) NextIsLast()
  • func (e *JxlEncoder) SetInfo(x, y int, m color.Model, fps float64) bool
  • func (e *JxlEncoder) Write(b []byte) error
• type JxlInfo

Functions

func Decode

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

func DecodeConfig

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

func Encode

func Encode(w io.Writer, img image.Image) error

Types

type DecodeError

type DecodeError string

const DecodeDataError DecodeError = "invalid body"

const DecodeHeaderError DecodeError = "invalid header"

const DecodeInputError DecodeError = "unable to set input"

func (DecodeError) Error

func (e DecodeError) Error() string

type EncodeError

type EncodeError string

const EncodeClosedError EncodeError = "encoder is closed"

const EncodeDataError EncodeError = "unknown"

const EncodeInfoError EncodeError = "failed to set info"

const EncodeInputError EncodeError = "failed to set input"

const EncodeUninitializedError EncodeError = "info not set before writing"

const EncodeUnsupportedError EncodeError = "image type not supported"

func (EncodeError) Error

func (e EncodeError) Error() string

type JxlDecoder

type JxlDecoder struct {
	// contains filtered or unexported fields
}

func NewJxlDecoder

func NewJxlDecoder(r io.Reader) *JxlDecoder

func (*JxlDecoder) Destroy

func (d *JxlDecoder) Destroy()

func (*JxlDecoder) FrameDuration

func (d *JxlDecoder) FrameDuration() time.Duration

func (*JxlDecoder) Info

func (d *JxlDecoder) Info() (JxlInfo, error)

func (*JxlDecoder) Read

func (d *JxlDecoder) Read() ([]byte, error)

func (*JxlDecoder) Reset

func (d *JxlDecoder) Reset(r io.Reader)

func (*JxlDecoder) Rewind

func (d *JxlDecoder) Rewind()

type JxlEncoder

type JxlEncoder struct {
	// contains filtered or unexported fields
}

func NewJxlEncoder

func NewJxlEncoder(w io.Writer) *JxlEncoder

func (*JxlEncoder) Destroy

func (e *JxlEncoder) Destroy()

func (*JxlEncoder) NextIsLast

func (e *JxlEncoder) NextIsLast()

func (*JxlEncoder) SetInfo

func (e *JxlEncoder) SetInfo(x, y int, m color.Model, fps float64) bool

func (*JxlEncoder) Write

func (e *JxlEncoder) Write(b []byte) error

type JxlInfo

type JxlInfo struct {
	H, W               int
	BitDepth           int
	Channels           int
	Alpha              int
	AlphaPremult       bool
	Orientation        int
	PreviewH, PreviewW int
	Animated           bool
}