imagequant/README.md

58 lines
2.2 KiB
Markdown
Raw Normal View History

2018-12-31 03:24:03 +00:00
# imagequant
2016-11-24 08:31:15 +00:00
Go bindings for libimagequant
`libimagequant` is a library for lossy recompression of PNG images to reduce their filesize. It is used by the `pngquant` tool. This `go-imagequant` project is a set of bindings for libimagequant to enable its use from the Go programming language.
This binding was written by hand. The result is somewhat more idiomatic than an automated conversion, but some `defer foo.Release()` calls are required for memory management.
Written in Golang
2018-12-31 03:24:03 +00:00
## Usage
2016-11-24 08:31:15 +00:00
Usage example is provided by a sample utility `cmd/gopngquant` which mimics some functionality of the upstream `pngquant`.
The sample utility has the following options:
2018-12-31 03:24:03 +00:00
```
Usage of gopngquant:
2016-11-24 08:31:15 +00:00
-In string
Input filename
-Out string
Output filename
-Speed int
Speed (1 slowest, 10 fastest) (default 3)
2018-12-31 03:24:03 +00:00
-Version
```
2016-11-24 08:31:15 +00:00
2018-12-31 03:24:03 +00:00
## Building
2016-11-24 08:31:15 +00:00
2018-06-09 05:28:06 +00:00
This package can be installed via go get: `go get code.ivysaur.me/imagequant`
[go-get]code.ivysaur.me/imagequant git https://git.ivysaur.me/code.ivysaur.me/imagequant.git[/go-get]
2016-11-24 08:36:11 +00:00
The expected package path is `code.ivysaur.me/imagequant`. Build via `go build`.
2016-11-24 08:31:15 +00:00
This is a CGO package and requires a C compiler installed. However, if you use `go install` then future invocations of `go build` do not require the C compiler to be present.
The `imagequant.go` file also declares a number of `CFLAGS` for GCC that allow the included libimagequant (2.8 git-a425e83) to build in an optimal way without using the upstream configure/make scripts.
2018-12-31 03:24:03 +00:00
## License
2016-11-24 08:31:15 +00:00
I am releasing this binding under the ISC license, however, `libimagequant` itself is released under GPLv3-or-later and/or commercial licenses. You must comply with the terms of such a license when using this binding in a Go project.
2018-12-31 03:24:03 +00:00
## Changelog
2016-11-24 08:36:11 +00:00
2017-03-03 05:25:21 +00:00
2017-03-03 2.9go1.1
2017-03-03 05:41:33 +00:00
- go-imagequant: Update bundled libimagequant from 2.8.0 to 2.9.0
- go-imagequant: Separate `CGO_LDFLAGS` for Linux and Windows targets
- gopngquant: Fix an issue with non-square images
2017-03-03 05:25:21 +00:00
2016-11-24 08:36:11 +00:00
2016-11-24 2.8go1.0
- Initial public release
2018-12-31 03:24:03 +00:00
## See also
2016-11-24 08:31:15 +00:00
- Pngquant homepage https://pngquant.org/
- Pngquant source code https://github.com/pornel/pngquant
- Libimagequant source code https://github.com/ImageOptim/libimagequant