Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davidbyttow/govips
A lightning fast image processing and resizing library for Go
https://github.com/davidbyttow/govips
gif golang heic image-processing imagemagick jpeg libvips pdf png svg tiff webp
Last synced: 3 days ago
JSON representation
A lightning fast image processing and resizing library for Go
- Host: GitHub
- URL: https://github.com/davidbyttow/govips
- Owner: davidbyttow
- License: mit
- Created: 2016-12-25T04:32:56.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T02:22:25.000Z (about 2 months ago)
- Last Synced: 2024-10-29T15:34:48.610Z (about 1 month ago)
- Topics: gif, golang, heic, image-processing, imagemagick, jpeg, libvips, pdf, png, svg, tiff, webp
- Language: Go
- Homepage:
- Size: 179 MB
- Stars: 1,283
- Watchers: 19
- Forks: 199
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - govips - A lightning fast image processing and resizing library for Go. (Images / Search and Analytic Databases)
- awesome-go - govips - A lightning fast image processing and resizing library for Go. Stars:`1.3K`. (Images / Search and Analytic Databases)
- awesome-go-extra - govips - 12-25T04:32:56Z|2022-08-05T05:13:26Z| (Images / Advanced Console UIs)
README
# 
govips
[](https://pkg.go.dev/mod/github.com/davidbyttow/govips/v2) [](https://goreportcard.com/badge/github.com/davidbyttow/govips)   [](https://github.com/davidbyttow/govips/actions) [](https://coveralls.io/github/davidbyttow/govips?branch=master)
## A lightning fast image processing and resizing library for Go
This package wraps the core functionality of [libvips](https://github.com/libvips/libvips) image processing library by exposing all image operations on first-class types in Go.
Libvips is generally 4-8x faster than other graphics processors such as GraphicsMagick and ImageMagick. Check the benchmark: [Speed and Memory Use](https://github.com/libvips/libvips/wiki/Speed-and-memory-use)
The intent for this is to enable developers to build extremely fast image processors in Go, which is suited well for concurrent requests.
## Requirements
- [libvips](https://github.com/libvips/libvips) 8.10+
- C compatible compiler such as gcc 4.6+ or clang 3.0+
- Go 1.16+
## Dependencies
### MacOS
Use [homebrew](https://brew.sh/) to install vips and pkg-config:
```bash
brew install vips pkg-config
```
### Windows
The recommended approach on Windows is to use Govips via WSL and Ubuntu.
If you need to run Govips natively on Windows, it's not difficult but will require some effort. We don't have a recommended environment or setup at the moment. Windows is also not in our list of CI/CD targets so Govips is not regularly tested for compatibility. If you would be willing to setup and maintain a robust CI/CD Windows environment, please open a PR, we would be pleased to accept your contribution and support Windows as a platform.
## Installation
```bash
go get -u github.com/davidbyttow/govips/v2/vips
```
### MacOS note
On MacOS, govips may not compile without first setting an environment variable:
```bash
export CGO_CFLAGS_ALLOW="-Xpreprocessor"
```
## Example usage
```go
package main
import (
"fmt"
"os"
"github.com/davidbyttow/govips/v2/vips"
)
func checkError(err error) {
if err != nil {
fmt.Println("error:", err)
os.Exit(1)
}
}
func main() {
vips.Startup(nil)
defer vips.Shutdown()
image1, err := vips.NewImageFromFile("input.jpg")
checkError(err)
// Rotate the picture upright and reset EXIF orientation tag
err = image1.AutoRotate()
checkError(err)
ep := vips.NewDefaultJPEGExportParams()
image1bytes, _, err := image1.Export(ep)
err = os.WriteFile("output.jpg", image1bytes, 0644)
checkError(err)
}
```
See _examples/_ folder for more examples.
## Running tests
```bash
$ make test
```
## Memory usage note
### MALLOC_ARENA_MAX
`libvips` uses GLib for memory management, and it brings GLib memory fragmentation
issues to heavily multi-threaded programs. First thing you can try if you noticed
constantly growing RSS usage without Go's sys memory growth is set `MALLOC_ARENA_MAX`:
```
MALLOC_ARENA_MAX=2 application
```
This will reduce GLib memory appetites by reducing the number of malloc arenas
that it can create. By default GLib creates one are per thread, and this would
follow to memory fragmentation.
## Contributing
Feel free to file issues or create pull requests. See this [guide on contributing](https://github.com/davidbyttow/govips/blob/master/CONTRIBUTING.md) for more information.
## Credits
Thanks to:
- [John Cupitt](https://github.com/jcupitt) for creating and maintaining libvips
- [Toni Melisma](https://github.com/tonimelisma) for pushing to a 2.x release
- [wix.com](https://wix.com/) for the govips logo and lots of great functionality
- All of our fantastic [contributors](https://github.com/davidbyttow/govips/graphs/contributors)
## License
MIT