English | 中文
This project is based on the following open-source libraries: [imaging](disintegration/imaging: Imaging is a simple image processing package for Go (github.com)) About Imaging is a simple image processing package for Go
webp WebP decoder and encoder for Go (Zero Dependencies).
gg Go Graphics - 2D rendering in Go with a simple API.
Imageprocessis a simple Go image processing package that supports WEBP, JPG, JPEG, PNG, BMP, TIFF, and GIF. It provides image processing capabilities similar to those of Alibaba Cloud's OSS, suitable for building a local file OSS image processing system.
go get github.com/AndsGo/imageprocessHere is an example of how to use the API in code:
// Resize the image to a height of 100px and a width of 300px, with the mode being proportional scaling to match the largest side
img = imageprocess.ResizeImage(img, ResizeOption{ResizeMode: Lfit, Width: 10, Height: 100)
// Scale the original image to a width and height of 100px: `resize,h_100,w_100` scaling mode fill: `m_fill`
img = imageprocess.ResizeImage(img, ResizeOption{ResizeMode: Fill, Width: 10, Height: 100)
// Scale the original image to a width and height of 100px: `resize,h_100,w_100` scaling mode pad: `m_pad`. Fill with red: `color_FF0000`
img = imageprocess.ResizeImage(img, ResizeOption{ResizeMode: Pad, Width: 10, Height: 100 Color: &color.RGBA{R: 255, G: 0, B: 0, A: 255}})
// Thumbnail example.jpg to a width and height of 300: `resize,w_300,h_300` watermark content "Hello World": `text_Hello%20World` watermark text color is white, font size is 30: `color_FFFFFF,size_30` watermark text position is bottom right, horizontal margin 10, vertical offset from the center 10: `g_se,x_10,y_10`
// Multiple mode serial processing can be done using the Process or (ProcessGif) method, and you can also use all the Process or (ProcessGif) methods for processing
options := make([]Option, 0)
options = append(options, Option{Resize, ResizeOption{Width: 300, Height: 300)
options = append(options, Option{Watermark, TextWatermarkOption{WatermarkOption: WatermarkOption{
Opacity: 20, Position: Center, X: 10, Y: 10,
}, Color: &color.RGBA{255, 255, 255, 1}, Size: 30, Text: "Hello World"}})
imageprocess.Process(img, file, options)
// Crop the image starting at coordinates (800,500) with a crop area of 300 pixels by 300 pixels.
img = imageprocess.CropImage(img, CropOption{X: 800, Y: 500, Width: 300, Height: 300})
// Crop the image starting at the bottom right corner of the original image with a crop area of 900 pixels by 900 pixels.
img = imageprocess.CropImage(img, CropOption{Position: SouthEast, Width: 900, Height: 900})
// Resize the original image to a width of 100 pixels and set the image quality to 80%.
options := make([]Option, 0)
options = append(options, Option{Resize, ResizeOption{Width: 100, Height: 100}})
// Append quality adjustment to the options with a quality setting of 80%.
options = append(options, Option{Quality, QualityOption{Quality: 80}})
// Convert the format of the image to PNG and append this to the options.
options = append(options, Option{FormatType, FormatOption{Format: PNG}})
// Process the image with the specified options.
imageprocess.Process(img, file, options)
// Rotate the original image 90 degrees clockwise.
img = imageprocess.AddjustRotate(img, RotateOption{Value: 90})
// Increase the brightness of the image by 50 units.
img = imageprocess.AddjustBright(img, BrightnessOption{Value: 50})
// Apply sharpening to the original image with a sharpening parameter of 100.
img = imageprocess.AddjustSharpen(img, SharpenOption{Value: 100})
// Increase the contrast of the image by 50 units.
img = imageprocess.AddjustContrast(img, ContrastOption{Value: 50}) For a comprehensive code example, see process_test.go
package imageprocess
import (
"image/color"
"os"
"testing"
)
func Test_Process(t *testing.T) {
img, f, err := LoadImage("examples/example.jpg")
if err != nil {
t.Error(err)
}
file, _ := os.Create("examples/out.PNG")
options := make([]Option, 0)
// Convert to PNG
options = append(options, Option{FormatType, FormatOption{Format: PNG}})
// Resize
options = append(options, Option{Resize, ResizeOption{ResizeMode: Pad, Width: 300, Height: 300, Color: &color.RGBA{R: 255, G: 255, B: 0, A: 255}}})
// Crop
options = append(options, Option{Crop, CropOption{Width: 200, Height: 200, X: 0, Y: 0, Position: Center}})
// Watermark
options = append(options, Option{Watermark, TextWatermarkOption{WatermarkOption: WatermarkOption{
Opacity: 100, Position: South, X: 10, Y: 10,
}, Color: &color.RGBA{111, 222, 111, 1}, Size: 40, Text: "hello watermark"}})
// Blur
options = append(options, Option{Blur, GammaOption{Value: 5}})
// Quality
options = append(options, Option{Quality, QualityOption{Quality: 500}})
err = Process(img, file, f, options)
if err != nil {
t.Error(err)
}
}
func Test_ProcessGif(t *testing.T) {
img, err := LoadGif("examples/example.gif")
if err != nil {
t.Error(err)
}
file, _ := os.Create("examples/out.gif")
options := make([]Option, 0)
// Convert to GIF
options = append(options, Option{FormatType, FormatOption{Format: GIF}})
options = append(options, Option{Gamma, GammaOption{Value: 500}})
options = append(options, Option{Resize, ResizeOption{ResizeMode: Pad, Width: 300, Height: 300, Color: &color.RGBA{R: 255, G: 255, B: 255, A: 1}}})
options = append(options, Option{Crop, CropOption{Width: 200, Height: 200, X: 0, Y: 0, Position: Center}})
options = append(options, Option{Watermark, TextWatermarkOption{WatermarkOption: WatermarkOption{
Opacity: 20, Position: Center, X: 10, Y: 10,
}, Color: &color.RGBA{0, 0, 0, 1}, Size: 40, Text: "hello watermark"}})
err = ProcessGif(img, file, options)
if err != nil {
t.Error(err)
}
}
func Test_UrlOptions(t *testing.T) {
img, f, err := LoadImage("examples/example.jpg")
if err != nil {
t.Error(err)
}
file, _ := os.Create("examples/out.jpg")
// Add a watermark and then modify the size
options, err := ParseOptions("image/watermark,t_30,g_center,x_10,y_10,text_hello watermark,color_1366ec,size_200/resize,m_pad,h_100,w_100,color_FF0000")
if err != nil {
t.Error(err)
}
err = Process(img, file, f, options)
if err != nil {
t.Error(err)
}
}| Meaning | Image |
|---|---|
| Change size, height 100px, width 300px, mode proportional scaling to match the maximum edge |  |
Scale the original image to 100 px in width and height: resize,h_100,w_100 Scaling mode fill: m_fill |
 |
Scale the original image to 100 px in width and height: resize,h_100,w_100 Scaling mode pad: m_pad. Fill with red: color_FF0000 |
 |
Reduce example.jpg to 300 in width and height: resize,w_300,h_300 Watermark content is "Hello World": text_Hello%20World Watermark text color is white, font size is 30: color_FFFFFF,size_30 Watermark text position is lower right, horizontal margin is 10, center line vertical offset is 10: g_se,x_10,y_10 |
 |
Cropping start point is (800,500): crop,x_800,y_500 Cropping range 300 px*300 px: w_300,h_300 |
 |
Cropping start point is the lower right corner of the original image: crop,g_se Cropping range 900 px*900 px: w_900,h_900 |
 |
The original image is scaled to 100 in width px: resize,w_100,h_100 Set the relative image quality to 80%: quality,q_80 |
 |
| Convert the original image to PNG format |  |
| Rotate the original image 90° clockwise |  |
| Increase the image brightness by 50 |  |
| Sharpen the original image with a sharpening parameter of 100 |  |
| Increase the contrast by 50 |  |
URL parameter example
Format conversion can be tested in process_test, the test code is as follows
func Test_UrlOptions(t *testing.T) {
img, f, err := LoadImage("examples/example.jpg")
if err != nil {
t.Error(err)
}
file, _ := os.Create("examples/out.jpg")
// Add watermark and then modify the size
options, err := ParseOptions("image/watermark,t_30,g_center,x_10,y_10,text_hello watermark,color_1366ec,size_200/resize,m_pad,h_100,w_100,color_FF0000")
if err != nil {
t.Error(err)
}
// Prcocess image
err = Process(img, file, f, options)
if err != nil {
t.Error(err)
}
}| Options | Meaning | Image |
|---|---|---|
| resize,h_100,w_300,m_lfit | Change the size, height 100px, width 300px, mode proportional scaling to match the maximum edge | |
| resize,m_fill,h_100,w_100 | Scale the original image to 100 px in width and height: resize,h_100,w_100 Scaling mode fill: m_fill |
|
| resize,m_pad,h_100,w_100,color_FF0000 | Scale the original image to 100 px in width and height: resize,h_100,w_100 Scaling mode pad: m_pad. Fill with red: color_FF0000 |
|
| resize,w_300,h_300/watermark,size_30,text_Hello%20World,color_FFFFFF,g_se,x_10,y_10 | Reduce example.jpg to 300 in width and height: resize,w_300,h_300 Watermark content is "Hello World": text_Hello%20World Watermark text color is white, font size is 30: color_FFFFFF,size_30 Watermark text position is lower right, horizontal margin is 10, center line vertical offset is 10: g_se,x_10,y_10 |
|
| crop,x_800,y_500,w_300,h_300 | The cropping start point is (800,500): crop,x_800,y_500 The cropping range is 300 px*300 px: w_300,h_300 |
|
| crop,w_900,h_900,g_se | The cropping start point is the lower right corner of the original image: crop,g_se Crop range 900 px*900 px: w_900,h_900 |
|
| resize,w_100/quality,q_80 | Scale the original image to 100 px wide: resize,w_100 Set the image relative quality to 80%: quality,q_80 |
|
| format,png | Convert the original image to PNG format | |
| rotate,90 | Rotate the original image 90° clockwise | |
| bright,50 | Increase the image brightness by 50 | |
| sharpen,100 | Sharpen the original image with a sharpening parameter of 100 | |
| contrast,-50 | Increase contrast by 50 | |
This is an Comprehensive exampleof a simple file server. The code is located in the examples folder
cd examples
go run example.goOriginal image: 2500*1875 
Visit:
Reult: 400*300 65.4k
Conversion code means:
resize,w_500,h_300Convert width 500, height 300
watermark,t_80,g_se,x_10,y_10,text_hello,color_FFFFFF,size_40Add watermark, the watermark position is located in the lower right, the distance from the edge is 10, the watermark content is hello, the color is FFFFFF, and the text size is 40
format,webpFormat conversion to webp
Sample code (you need to modify fileFolders when testing your own pictures):
package main
import (
"fmt"
"image/gif"
"io"
"net/http"
"os"
"strings"
"github.com/AndsGo/imageprocess"
)
// You need change it
var fileFolders = "./"
func main() {
http.HandleFunc("/file/", fileHandler)
fmt.Println("Starting server on :8080")
if err := http.ListenAndServe(":8080", nil); err != nil {
fmt.Println("Server failed:", err)
}
}
func fileHandler(w http.ResponseWriter, r *http.Request) {
// Get the file name
fileName := strings.TrimPrefix(r.URL.Path, "/file/")
// Open the file
file, err := os.Open(fmt.Sprintf("%s%s", fileFolders, fileName))
if err != nil {
http.Error(w, "File not found", http.StatusNotFound)
return
}
defer file.Close()
// Get parameters
// Get the file suffix
f, err := imageprocess.FormatFromExtension(fileName)
if err != nil {
// Write the processed file content to the response
if _, err := io.Copy(w, file); err != nil {
http.Error(w, "Failed to send file", http.StatusInternalServerError)
}
return
}
// Processing parameters ossParameter
ossParams := r.URL.Query().Get("x-oss-process")
if ossParams == "" {
// nothing to do
if _, err := io.Copy(w, file); err != nil {
http.Error(w, "Failed to send file", http.StatusInternalServerError)
}
return
}
options, err := imageprocess.ParseOptions(ossParams)
if err != nil {
http.Error(w, fmt.Sprintf("ParseOptions %s", err.Error()), http.StatusInternalServerError)
return
}
if len(options) == 0 {
// nothing to do
if _, err := io.Copy(w, file); err != nil {
http.Error(w, "Failed to send file", http.StatusInternalServerError)
}
return
}
// Process the image
err = processImg(file, w, f, options)
if err != nil {
http.Error(w, fmt.Sprintf("processFile %s", err.Error()), http.StatusInternalServerError)
}
}
// Convert
func processImg(file io.Reader, w io.Writer, f imageprocess.Format, options []imageprocess.Option) error {
if f == imageprocess.GIF {
imgGif, err := gif.DecodeAll(file)
if err != nil {
return err
}
return imageprocess.ProcessGif(imgGif, w, options)
} else {
img, err := imageprocess.DecodeImage(file, f)
if err != nil {
return err
}
return imageprocess.Process(img, w, f, options)
}
}