https://github.com/livesense-inc/fanlin
Fast ANd LIghtweight Natural image processor
https://github.com/livesense-inc/fanlin
golang image-processing linux neural-network
Last synced: 12 months ago
JSON representation
Fast ANd LIghtweight Natural image processor
- Host: GitHub
- URL: https://github.com/livesense-inc/fanlin
- Owner: livesense-inc
- License: mit
- Created: 2016-06-08T07:43:19.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2025-05-14T01:15:01.000Z (about 1 year ago)
- Last Synced: 2025-05-14T02:55:38.221Z (about 1 year ago)
- Topics: golang, image-processing, linux, neural-network
- Language: Go
- Homepage: https://deepwiki.com/livesense-inc/fanlin
- Size: 2.68 MB
- Stars: 30
- Watchers: 37
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.ja.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# fanlin
[](LICENSE)
[](https://deepwiki.com/livesense-inc/fanlin)
[English](README.md) | 日本語
## 概要
fanlinはGo言語で作られた軽量画像プロキシです.
Amazon S3と外部HTTPサーバー上の画像をリアルタイムで加工することができます.
## 環境
### OS
* Linux (x86 and amd64)
* macOS
### Go Versions
* `go.mod` ファイル参照
## 対応画像フォーマット
* JPEG
* PNG
* GIF
* WebP
* AVIF (エンコードのみ)
## macOS の環境構築
## master pushの悲劇を防ぐために
[ここを参考に設定すること](http://ganmacs.hatenablog.com/entry/2014/06/18/224132)
## 依存ライブラリ
AVIFフォーマットのエンコードのためにlibaomが必要です。事前にインストールしておいてください。
```
$ sudo apt install libaom-dev
```
また、ICCプロファイルを利用してCMYKをRGBに変換するための以下も必要です。
```
$ sudo apt install liblcms2-dev
```
## Linux用にクロスコンパイルする
```
$ GOOS=linux GOARCH=amd64 go build github.com/livesense-inc/fanlin/cmd/fanlin
```
## サーバーに配布するもの
ビルドして作った実行ファイル
設定ファイル
## API
getパラメータに値を渡して操作する
`w`画像の横幅
`h`画像の縦幅
色を指定しない時`w`と`h`を指定した時は小さい方に合わせて縮尺を変更する
この時アスペクト比は維持する
また一方が`0`の時は`0`ではない値を基準に縮尺を変更する
`w`及び`h`が`0`であるときは元のサイズで表示する
あまりにも大きいサイズが指定された時は設定ファイルにかかれている上限の大きさで拡大する
`rgb`で色を指定した場合`w`と`h`で指定された大きさの画像を生成する
この時画像のアスペクト比が違うときは隙間を指定した色で塗りつぶす
`quality`で`0`から`100`までの数値を指定した場合その数値にクオリティを設定した画像を生成する
それ以外の数値が指定された場合は`jpeg.DefaultQuality`の値(`75`)が指定される
`crop`で`true`が指定された場合`w`と`h`で指定した比に合わせて、画像中央を基準としてはみ出した部分クロッピングして画像を生成する
例:
```
http://localhost:8080/path/to/image/?h=400&w=400&rgb=100,100,100&quality=80&crop=true
```
## testing
```
$ go test -cover ./...
```
## 設定項目に関して
だいたいこんな感じでかけます
```json
{
"port": 8080,
"max_width": 1000,
"max_height": 1000,
"404_img_path": "/path/to/404/image",
"access_log_path": "/path/to/access/log",
"error_log_path": "/path/to/error/log",
"use_server_timing": true,
"providers": [
{
"/alias/0" : {
"type" : "web",
"src" : "http://aaa.com/bbb",
"priority" : 10
}
},
{
"/alias/1" : {
"type" : "web",
"src" : "https://ccc.com",
"priority" : 20
}
},
{
"/alias/3" : {
"type" : "s3",
"src" : "s3://bucket/path",
"region" : "ap-northeast-1",
"priority" : 30
}
}
]
}
```
## ログの出力先を制御する
設定項目の`access_log_path`/`error_log_path`/`debug_log_path`にパスを指定することで、それぞれのログをファイルに出力できます。
標準出力にログを出力したい場合は、`/dev/stdout`を指定してください。
## WebPフォーマットの利用方法と制限事項
fanlinへのリクエストに `webp=true` getパラメータを付与することで、WebPフォーマットの画像を返すことが出来ます.
例:
- JPG画像のURL:
- http://localhost:8080/abc.jpg?h=400&w=400&quality=80
- WebPに変換した画像のURL:
- http://localhost:8080/abc.jpg?h=400&w=400&quality=80&webp=true
また、以下の条件の場合は、Lossless WebPフォーマットで変換します.
- getパラメータにて `quality=100` を指定かつ元画像のフォーマットが PNG / GIF / WebP のいずれか
### 制限事項
- アニメーションには対応していません
## Server-Timingのサポートに関して
設定ファイルのグローバル設定値に `"use_server_timing": true` を入れることで[Server-Timing](https://www.w3.org/TR/server-timing/)が出力されます.
Server-Timingの出力によって、システムの内部構成やパフォーマンスがエンドユーザーに見えてしまう可能性があります.利用に際してはご注意ください.
現在の出力項目は以下:
- f_load: ソース画像のロード時間
- f_decode: ソース画像のデコードと加工時間
- f_encode: 最終出力フォーマットへのエンコード時間
## モックサーバーを利用してAmazon S3バックエンドの動作確認を手元でする
`providers` directive にて `use_mock` 属性を `true` に指定すると fanlin はローカルのモックサーバーを参照するように動作します。
```json
{
"port": 3000,
"max_width": 2000,
"max_height": 1000,
"404_img_path": "img/404.png",
"access_log_path": "/dev/stdout",
"error_log_path": "/dev/stderr",
"max_clients": 50,
"providers": [
{
"/foo": {
"type": "s3",
"src": "s3://local-test/images",
"region": "ap-northeast-1",
"norm_form": "nfd",
"use_mock": true
}
},
{
"/bar": {
"type": "web",
"src": "http://localhost:3000/foo"
}
},
{
"/baz": {
"type": "local",
"src": "img"
}
}
]
}
```
fanlin 起動前に Docker compose でモックサーバーを起動しておいてください。
```
$ docker compose up
$ make create-s3-bucket
$ make copy-object SRC=img/Lenna.jpg DEST=images/Lenna.jpg
$ make run
```
これでローカルで動作確認ができます。
```
$ curl -I 'http://localhost:3000/foo/Lenna.jpg?w=300&h=200&rgb=64,64,64'
$ curl -I 'http://localhost:3000/bar/Lenna.jpg?w=300&h=200&rgb=64,64,64'
$ curl -I 'http://localhost:3000/baz/Lenna.jpg?w=300&h=200&rgb=64,64,64'
```