media

Documentation

Index

• Variables
• func CapImageSize(img image.Image, maxSize int) *image.RGBA
• func Draw(src image.Image, dst *image.RGBA, quality bool)
• func FlushImage(tar io.Writer, img image.Image, quality int) error
• func GeneratePhash(img image.Image, scale int) []byte
• func ImageFromReader(r io.Reader) (img image.Image, err error)
• func Is(kinds ...Kind) func(key string) bool
• func MinImageSize(img image.Image, maxSize int) *image.RGBA
• func ReduceImageSize(img image.Image, maxDimension int) *image.RGBA
• func RegisterMasks(mask Kind, keys ...string)
• func ResizeImage(img image.Image, width, height int) *image.RGBA
• type Kind
  • func GetKind(ext string) Kind

Variables

var (
	ErrNoMIME          = errors.New("no mime could be detected")
	ErrUnsupportedMIME = errors.New("detected mime is unsupported")
	ErrFFMPEGNotFound  = errors.New("ffmpeg not found in PATH")
)

var CntMasks = map[Kind][]string{
	IMAGE: {".jpg", ".jpeg", ".png", ".apng", ".gif", ".bmp", ".webp", ".avif", ".jxl", ".tiff"},
	VIDEO: {".mp4", ".m4v", ".webm", ".mkv", ".avi", ".mov", ".mpg", ".mpeg"},
	AUDIO: {".m4a", ".opus", ".ogg", ".mp3", ".flac", ".wav", ".aac"},
}

var ExtToMaskMap = map[string]Kind{}

Functions

func CapImageSize

func CapImageSize(img image.Image, maxSize int) *image.RGBA

CapImageSize creates an empty RGBA image with the same aspect ration as the input, but capped to the maxSize provided, such that neither height nor width are above that value.

edge cases:

• source file very tall, very wide, resulting in an unusable image or a very large filesize

func Draw

func Draw(src image.Image, dst *image.RGBA, quality bool)

Draw copies src to dst, using either a fast algorithm, or a quality algorithm.

func FlushImage

func FlushImage(tar io.Writer, img image.Image, quality int) error

func GeneratePhash

func GeneratePhash(img image.Image, scale int) []byte

GeneratePhash returns a basic perceptual hash of the given image.

func ImageFromReader

func ImageFromReader(r io.Reader) (img image.Image, err error)

func Is

func Is(kinds ...Kind) func(key string) bool

func MinImageSize

func MinImageSize(img image.Image, maxSize int) *image.RGBA

MinImageSize cap the smaller dimension to maxSize while maintaining aspect ration.

func ReduceImageSize

func ReduceImageSize(img image.Image, maxDimension int) *image.RGBA

func RegisterMasks

func RegisterMasks(mask Kind, keys ...string)

func ResizeImage

func ResizeImage(img image.Image, width, height int) *image.RGBA

ResizeImage resizes the given image to the specified width and height.

Types

type Kind

type Kind uint64

const (
	INVALID Kind = 1 << iota
	IMAGE
	VIDEO
	AUDIO
)

func GetKind

func GetKind(ext string) Kind