Skip to content
forked from nfnt/resize

Image resizing package for Go.

License

Notifications You must be signed in to change notification settings

rymdport/resize

This branch is 14 commits ahead of nfnt/resize:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

6fbff4f · Feb 11, 2025
Feb 8, 2025
Aug 3, 2012
Feb 11, 2025
Jan 6, 2025
Jan 6, 2025
Jan 6, 2025
Jan 6, 2025
Jan 6, 2025
Jan 6, 2025
Feb 8, 2025
Nov 15, 2016
Jan 6, 2025
Nov 27, 2013
Feb 21, 2018
Feb 11, 2025

Repository files navigation

Resize

Image resizing for the Go with common interpolation methods. This fork aims to continue maintaining the project after it was archived upstream.

Installation

Import into your Go module with the following command:

go get github.com/rymdport/resize

Usage

This package needs at least Go 1.19. Import package with:

import "github.com/rymdport/resize"

The resize package provides 2 functions:

  • resize.Resize creates a scaled image with new dimensions (width, height) using the interpolation function interp. If either width or height is set to 0, it will be set to an aspect ratio preserving value.
  • resize.Thumbnail downscales an image preserving its aspect ratio to the maximum dimensions (maxWidth, maxHeight). It will return the original image if original sizes are smaller than the provided dimensions.
resize.Resize(width, height uint, img image.Image, interp resize.InterpolationFunction) image.Image
resize.Thumbnail(maxWidth, maxHeight uint, img image.Image, interp resize.InterpolationFunction) image.Image

The provided interpolation functions are (from fast to slow execution time)

Which of these methods gives the best results depends on your use case.

Sample usage:

package main

import (
	"github.com/rymdport/resize"
	"image/jpeg"
	"log"
	"os"
)

func main() {
	// open "test.jpg"
	file, err := os.Open("test.jpg")
	if err != nil {
		log.Fatal(err)
	}

	// decode jpeg into image.Image
	img, err := jpeg.Decode(file)
	if err != nil {
		log.Fatal(err)
	}
	file.Close()

	// resize to width 1000 using Lanczos resampling
	// and preserve aspect ratio
	m := resize.Resize(1000, 0, img, resize.Lanczos3)

	out, err := os.Create("test_resized.jpg")
	if err != nil {
		log.Fatal(err)
	}
	defer out.Close()

	// write new image to file
	jpeg.Encode(out, m, nil)
}

Caveats

  • Optimized access routines are used for image.RGBA, image.NRGBA, image.RGBA64, image.NRGBA64, image.YCbCr, image.Gray, and image.Gray16 types. All other image types are accessed in a generic way that will result in slow processing speed.
  • JPEG images are stored in image.YCbCr. This image format stores data in a way that will decrease processing speed. A resize may be up to 2 times slower than with image.RGBA.

License

Copyright (c) 2012 Jan Schlicht [email protected]. Resize is released under a MIT style license.