├── .gitignore ├── test.gif ├── go.mod ├── go.sum ├── cli ├── makefile_cross ├── print.go └── cli.go ├── img ├── img_h.go └── img.go ├── bobibo_test.go ├── makefile ├── default.nix ├── util └── fp.go ├── README.md ├── bobibo.go └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *.pprof 2 | -------------------------------------------------------------------------------- /test.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orzation/bobibo/HEAD/test.gif -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/orzation/bobibo 2 | 3 | go 1.18 4 | 5 | require golang.org/x/term v0.5.0 6 | 7 | require golang.org/x/sys v0.5.0 // indirect 8 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | golang.org/x/sys v0.5.0 h1:MUK/U/4lj1t1oPg0HfuXDN/Z1wv31ZJ/YcPiGccS4DU= 2 | golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 3 | golang.org/x/term v0.5.0 h1:n2a8QNdAb0sZNpU9R1ALUXBbY+w51fCQDN+7EdxNBsY= 4 | golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= 5 | -------------------------------------------------------------------------------- /cli/makefile_cross: -------------------------------------------------------------------------------- 1 | OS = darwin 2 | ARCH = arm64 3 | EXE = bobibo_$(OS)_$(ARCH) 4 | IS_STATIC = 0 5 | VERSION=V1.2.0 6 | all: build 7 | 8 | build: cli.go 9 | CGO_ENABLED=$(IS_STATIC) GOOS=$(OS) GOARCH=$(ARCH) go build -ldflags="-X 'main.version=$(VERSION)' -s -w" -o $(EXE) 10 | @echo Build Success !!! 11 | 12 | compress: $(EXE) 13 | upx $(EXE) -o $(EXE)_cprs 14 | @echo Compress Success !!! 15 | -------------------------------------------------------------------------------- /img/img_h.go: -------------------------------------------------------------------------------- 1 | package img 2 | 3 | import ( 4 | "image" 5 | ) 6 | 7 | type Pale = *image.Paletted 8 | 9 | type Img struct { 10 | id int 11 | value image.Image 12 | } 13 | 14 | func NewImg(id int, value image.Image) Img { 15 | return Img{id: id, value: value} 16 | } 17 | 18 | type Gray struct { 19 | id int 20 | value [][]uint8 21 | } 22 | 23 | func (g Gray) Id() int { 24 | return g.id 25 | } 26 | 27 | func (g Gray) size() (int, int) { 28 | return len(g.value), len(g.value[0]) 29 | } 30 | -------------------------------------------------------------------------------- /bobibo_test.go: -------------------------------------------------------------------------------- 1 | package bobibo 2 | 3 | import ( 4 | "fmt" 5 | "os" 6 | "testing" 7 | ) 8 | 9 | func BenchmarkBobibo(b *testing.B) { 10 | f, err := os.Open("./test.gif") 11 | if err != nil { 12 | b.Error(err) 13 | } 14 | defer f.Close() 15 | b.ResetTimer() 16 | for i := 0; i < b.N; i++ { 17 | b.StopTimer() 18 | f.Seek(0, 0) 19 | b.StartTimer() 20 | arts, err := BoBiBo(f, true, false, ScaleOpt(1), ThresholdOpt(-1)) 21 | if err != nil { 22 | b.Error(err) 23 | } 24 | for { 25 | select { 26 | case _, ok := <-arts: 27 | if !ok { 28 | return 29 | } 30 | } 31 | } 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /makefile: -------------------------------------------------------------------------------- 1 | VERSION=V1.4.1 2 | EXE=bobibo 3 | DESTDIR := 4 | 5 | .PHONY: default build install uninstall block cpu mem 6 | default: build 7 | 8 | build: cli/cli.go 9 | go build -C cli -ldflags="-X 'main.version=$(VERSION)' -s -w" -o ../$(EXE) 10 | @echo Build Success !!! 11 | 12 | install: $(EXE) 13 | install -Dm755 $(EXE) $(DESTDIR)/usr/bin/$(EXE) 14 | @echo install Success !!! 15 | 16 | uninstall: 17 | rm -f $(DESTDIR)/usr/bin/$(EXE) 18 | @echo uninstall Success !!! 19 | 20 | test: 21 | go test -bench=. -cpu=4 -blockprofile=block.pprof -cpuprofile=cpu.pprof -memprofile=mem.pprof 22 | 23 | block: block.pprof 24 | go tool pprof -http=:9999 block.pprof 25 | 26 | cpu: cpu.pprof 27 | go tool pprof -http=:9999 cpu.pprof 28 | 29 | mem: mem.pprof 30 | 31 | go tool pprof -http=:9999 mem.pprof 32 | 33 | -------------------------------------------------------------------------------- /default.nix: -------------------------------------------------------------------------------- 1 | { lib 2 | , buildGoModule 3 | , fetchFromGitHub 4 | , pkg-config 5 | , nix-update-script 6 | }: 7 | buildGoModule 8 | rec { 9 | pname = "bobibo"; 10 | version = "1.4.0"; 11 | 12 | src = fetchFromGitHub { 13 | owner = "orzation"; 14 | repo = pname; 15 | rev = "v${version}"; 16 | hash = "sha256-/esS/CyjHdHMVsIdugRoggecMI//tGuCaayEiNBEocM="; 17 | }; 18 | 19 | vendorHash = "sha256-LzP2pgRheL/NRQmjluqKb8/yxAuFjbmXVU57HdrGSDU="; 20 | subPackages = [ "cli/" ]; 21 | 22 | ldflags = [ "-s" "-w" "-X main.version=${version}" ]; 23 | 24 | nativeBuildInputs = [ 25 | pkg-config 26 | ]; 27 | 28 | doCheck = false; 29 | 30 | postInstall = '' 31 | mv $out/bin/cli $out/bin/bobibo 32 | ''; 33 | 34 | passthru.updateScript = nix-update-script { }; 35 | 36 | meta = with lib; { 37 | description = "A cli-app, convert pictures to ascii arts."; 38 | homepage = "https://github.com/orzation/bobibo"; 39 | license = licenses.gpl3; 40 | mainProgram = "bobibo"; 41 | maintainers = with maintainers; [ msqtt ]; 42 | }; 43 | } 44 | 45 | -------------------------------------------------------------------------------- /util/fp.go: -------------------------------------------------------------------------------- 1 | package util 2 | 3 | import ( 4 | "sync" 5 | ) 6 | 7 | // to make a stream channel function. 8 | func GenChanFn[T any, E any](logic func(in <-chan T, out chan<- E)) func(<-chan T) <-chan E { 9 | return func(inChan <-chan T) <-chan E { 10 | outChan := make(chan E, cap(inChan)) 11 | go func() { 12 | logic(inChan, outChan) 13 | close(outChan) 14 | }() 15 | return outChan 16 | } 17 | } 18 | 19 | // multiply two functions to one, right function first. 20 | func Multiply[T, E, R any](f func(E) R, g func(T) E) func(T) R { 21 | return func(v T) R { 22 | return f(g(v)) 23 | } 24 | } 25 | 26 | // cloning stream channel function means that more goroutines will work for it. 27 | // and finally all stream will be faned in one channel. 28 | func CloneChanFn[T, E any](fn func(<-chan T) <-chan E, num int, in <-chan T) <-chan E { 29 | out := make(chan E, cap(in)) 30 | 31 | wg := sync.WaitGroup{} 32 | wg.Add(len(in)) 33 | 34 | go func() { 35 | wg.Wait() 36 | close(out) 37 | }() 38 | 39 | for i := 0; i < num; i++ { 40 | go func() { 41 | for v := range fn(in) { 42 | out <- v 43 | wg.Done() 44 | } 45 | }() 46 | } 47 | 48 | return out 49 | } 50 | 51 | // use the id to sort. 52 | type sorter interface { 53 | // start from zero will be eazier. 54 | Id() int 55 | } 56 | 57 | func SortChan[T sorter](in <-chan T) <-chan T { 58 | out := make(chan T, cap(in)) 59 | go func() { 60 | defer close(out) 61 | order := make([]T, cap(in)) 62 | for s := range in { 63 | order[s.Id()] = s 64 | } 65 | for _, v := range order { 66 | out <- v 67 | } 68 | }() 69 | return out 70 | } 71 | -------------------------------------------------------------------------------- /cli/print.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "errors" 5 | "fmt" 6 | "os" 7 | "os/signal" 8 | "time" 9 | 10 | b "github.com/orzation/bobibo" 11 | "golang.org/x/term" 12 | ) 13 | 14 | func printArts(arts <-chan b.Art, gifMode bool) error { 15 | if !gifMode { 16 | for art := range arts { 17 | for _, v := range art.Content { 18 | fmt.Println(v) 19 | } 20 | } 21 | return nil 22 | } 23 | 24 | artsBuffer := make([]b.Art, len(arts)) 25 | for a := range arts { 26 | artsBuffer = append(artsBuffer, a) 27 | } 28 | 29 | fd := int(os.Stdout.Fd()) 30 | errChan := make(chan error, 2) 31 | interrupt := make(chan os.Signal) 32 | signal.Notify(interrupt, os.Interrupt) 33 | 34 | hideCursor() 35 | defer showCursor() 36 | 37 | go func() { 38 | for { 39 | tw, th, err := term.GetSize(fd) 40 | if err != nil { 41 | errChan <- err 42 | return 43 | } 44 | 45 | clearAll() 46 | for _, art := range artsBuffer { 47 | sw, sh := len([]rune(art.Content[0])), len(art.Content) 48 | posX, posY := (tw-sw)>>1, (th-sh)>>1 49 | if posX < 0 || posY < 0 || posX > tw || posY > th { 50 | errChan <- errors.New("Image size is too large, please zoom out and try again.") 51 | return 52 | } 53 | for offset, line := range art.Content { 54 | moveCursor(posY+offset, posX) 55 | clearLine() 56 | fmt.Printf("%s", line) 57 | } 58 | time.Sleep(time.Microsecond * time.Duration(art.Delay*10000)) 59 | } 60 | } 61 | }() 62 | 63 | select { 64 | case <-interrupt: 65 | return nil 66 | case err := <-errChan: 67 | return err 68 | } 69 | } 70 | 71 | func moveCursor(y, x int) { 72 | fmt.Printf("\033[%d;%dH", y, x) 73 | } 74 | 75 | func clearAll() { 76 | fmt.Print("\033[2J") 77 | } 78 | 79 | func clearLine() { 80 | fmt.Print("\033[2K") 81 | } 82 | 83 | func hideCursor() { 84 | fmt.Print("\033[?25l") 85 | } 86 | 87 | func showCursor() { 88 | fmt.Print("\033[?25h") 89 | } 90 | -------------------------------------------------------------------------------- /cli/cli.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "flag" 5 | "fmt" 6 | "io" 7 | "net/http" 8 | "os" 9 | 10 | "github.com/orzation/bobibo" 11 | ) 12 | 13 | var ( 14 | version string 15 | 16 | gif bool 17 | inverse bool 18 | scale float64 19 | threshold int 20 | url bool 21 | ) 22 | 23 | func init() { 24 | flag.BoolVar(&gif, "g", false, "enable gif mode.") 25 | flag.BoolVar(&inverse, "v", false, "inverse the colors.") 26 | flag.Float64Var(&scale, "s", 0.5, "scale the size of arts. range: (0, +).") 27 | flag.IntVar(&threshold, "t", -1, "set the threshold of binarization. range: [-1, 255], -1 means gen by OTSU.") 28 | flag.BoolVar(&url, "l", false, "use network url to load image.") 29 | } 30 | 31 | func main() { 32 | flag.Parse() 33 | args := flag.Args() 34 | 35 | if len(args) < 1 { 36 | fmt.Fprintln(os.Stderr, "Usage: bobibo [OPTION]... PARTERNS [FILE]...") 37 | fmt.Fprintln(os.Stderr, "Try 'bobibo --help' for more information.") 38 | os.Exit(1) 39 | } 40 | 41 | opt := args[0] 42 | var imgFile io.ReadCloser 43 | 44 | switch opt { 45 | case "version": 46 | fmt.Printf("BoBiBo %s :P\n", version) 47 | return 48 | default: 49 | if url { 50 | resp, err := http.Get(opt) 51 | if err != nil { 52 | fmt.Fprintln(os.Stderr, "Fetch image error: ", err.Error()) 53 | } 54 | imgFile = resp.Body 55 | } else { 56 | f, err := os.Open(opt) 57 | if err != nil { 58 | fmt.Fprintln(os.Stderr, "Open image error: ", err.Error()) 59 | } 60 | imgFile = f 61 | } 62 | } 63 | defer imgFile.Close() 64 | arts, err := bobibo.BoBiBo( 65 | imgFile, gif, inverse, 66 | bobibo.ScaleOpt(scale), 67 | bobibo.ThresholdOpt(threshold)) 68 | if err != nil { 69 | fmt.Fprintln(os.Stderr, "Bobibo error: ", err.Error()) 70 | imgFile.Close() 71 | os.Exit(1) 72 | } 73 | 74 | err = printArts(arts, gif) 75 | if err != nil { 76 | fmt.Fprintln(os.Stderr, "Print error: ", err.Error()) 77 | imgFile.Close() 78 | os.Exit(1) 79 | } 80 | } 81 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## 🐱 Bobibo 2 | 3 | ### 😗 Introduce 4 | 5 | Bobibo is a simple cli-tool, it can convert pictures(jpeg, png, even gif) to ascii arts using 6 | braille unicode. 7 | 8 | > I wrote it, cause i need some anime ascii arts. 💩 9 | 10 | If you are looking for colorization, you might be interested in [this img2art](https://github.com/Asthestarsfalll/img2art). 11 | 12 | ### 🎞️ Screenshot 13 | 14 | | ![image](https://user-images.githubusercontent.com/94043894/223673376-f67f030c-305f-4dd1-beee-301a8da79b5d.png) | 15 | | :-------------------------------------------------------------------------------------------------------------: | 16 | | bobibobibobobibo | 17 | 18 | | ![image](https://user-images.githubusercontent.com/94043894/223674513-ed33023d-9181-4fe6-bf7e-cd059bfd0ba3.png) | 19 | | :-------------------------------------------------------------------------------------------------------------: | 20 | | ![image](https://user-images.githubusercontent.com/94043894/223675190-ecbd20a6-cf49-40a0-a36d-d7bf6b0a75ff.png) | 21 | | inverse when your background is too light. | 22 | 23 | | ![image](https://user-images.githubusercontent.com/94043894/236626257-7fb68cf0-89e7-4230-885f-f6f62b95490b.gif) | 24 | | :-------------------------------------------------------------------------------------------------------------: | 25 | | gif, not much use though. 💩 | 26 | 27 | ### 👇 Install 28 | 29 | 1. `releases` download. 30 | 2. build yourself, makefile in [makefile](makefile). 31 | 3. maybe used as sdk ? `go get github.com/orzation/bobibo`. 32 | 4. `AUR` use `yay/paru -S bobibo`. 33 | 5. `NixOS` callPackage [default.nix](default.nix). 34 | 35 | ### 🍰 How2use 36 | 37 | `bobibo [-option] /path/to/image.png ` 38 | 39 | options: 40 | 41 | - `-v` enable inverse the character color. 42 | - `-g` enable gif mode(test), print every frame of gif image. 43 | - `-l` use network url to load image. 44 | - `-s value` set the scale for images(value default 0.5, (0, +)). 45 | - `-t value` set the threshold of binarization(value default generate by OTSU, [-1, 255]). 46 | 47 | > use `bobibo -h` to print options. 48 | > use `bobibo version` to print version. 49 | 50 | ### ⚙️ Contribute 51 | 52 | > hope so 💩 53 | 54 | 1. fork 55 | 2. do your things 56 | 3. pull request 57 | 58 | ### 📄 License 59 | 60 | GPLV3.0 61 | -------------------------------------------------------------------------------- /bobibo.go: -------------------------------------------------------------------------------- 1 | package bobibo 2 | 3 | import ( 4 | "errors" 5 | "image" 6 | "io" 7 | "runtime" 8 | 9 | "github.com/orzation/bobibo/img" 10 | u "github.com/orzation/bobibo/util" 11 | ) 12 | 13 | type Params struct { 14 | Image io.Reader 15 | Gif bool 16 | Inverse bool 17 | Scale float64 18 | Threshold int 19 | } 20 | 21 | type Option func(p *Params) error 22 | 23 | func ScaleOpt(scale float64) Option { 24 | return func(p *Params) error { 25 | if scale <= 0 { 26 | return errors.New("The Value of scale must be within (0, +).") 27 | } 28 | p.Scale = scale 29 | return nil 30 | } 31 | } 32 | 33 | func ThresholdOpt(thre int) Option { 34 | return func(p *Params) error { 35 | if thre < -1 || thre > 255 { 36 | return errors.New("The Value of threshold must be within [-1, 255].") 37 | } 38 | p.Threshold = thre 39 | return nil 40 | } 41 | } 42 | 43 | type Art struct { 44 | Content []string 45 | Delay int 46 | } 47 | 48 | func BoBiBo(ima io.Reader, isGif, isInverse bool, opts ...Option) (<-chan Art, error) { 49 | params := &Params{ 50 | Image: ima, 51 | Gif: isGif, 52 | Inverse: isInverse, 53 | } 54 | for _, opt := range opts { 55 | if err := opt(params); err != nil { 56 | return nil, err 57 | } 58 | } 59 | 60 | var maxCpu = runtime.NumCPU() 61 | 62 | // clone ResizeAndGray fn then sort it. 63 | ragFns := func(in <-chan img.Img) <-chan img.Gray { 64 | num := 1 65 | if cap(in) > 1 { 66 | // test 67 | num = maxCpu - 3 68 | } 69 | return u.SortChan( 70 | u.CloneChanFn(img.ResizeAndGray(params.Scale), num, in)) 71 | } 72 | 73 | mix := u.Multiply(img.ArtotBin(params.Inverse), 74 | u.Multiply(img.BinotImg(params.Threshold), 75 | ragFns, 76 | )) 77 | 78 | inStream, delays, err := analyzeImage(params) 79 | if err != nil { 80 | return nil, err 81 | } 82 | 83 | outStream := mix(inStream) 84 | wrap := wrapOut(delays) 85 | return wrap(outStream), nil 86 | } 87 | 88 | var wrapOut = func(delays []int) func(<-chan []string) <-chan Art { 89 | flag := true 90 | if delays == nil || len(delays) == 0 { 91 | flag = false 92 | } 93 | return u.GenChanFn(func(in <-chan []string, out chan<- Art) { 94 | cnt := 0 95 | for i := range in { 96 | if flag { 97 | out <- Art{Content: i, Delay: delays[cnt]} 98 | cnt++ 99 | } else { 100 | out <- Art{Content: i, Delay: 0} 101 | } 102 | } 103 | }) 104 | } 105 | 106 | func analyzeImage(params *Params) (<-chan img.Img, []int, error) { 107 | var delays []int 108 | var inChan <-chan img.Img 109 | if params.Gif { 110 | p, dls, err := img.LoadAGif(params.Image) 111 | if err != nil { 112 | return nil, nil, err 113 | } 114 | delays = dls 115 | inChan = newInStream(p...) 116 | } else { 117 | i, err := img.LoadAImage(params.Image) 118 | if err != nil { 119 | return nil, nil, err 120 | } 121 | inChan = newInStream(i) 122 | } 123 | return inChan, delays, nil 124 | } 125 | 126 | func newInStream[T image.Image](ims ...T) <-chan img.Img { 127 | in := make(chan img.Img, len(ims)) 128 | defer close(in) 129 | for i, v := range ims { 130 | imgV := img.NewImg(i, v) 131 | in <- imgV 132 | } 133 | return in 134 | } 135 | -------------------------------------------------------------------------------- /img/img.go: -------------------------------------------------------------------------------- 1 | package img 2 | 3 | import ( 4 | "image" 5 | "image/gif" 6 | _ "image/gif" 7 | _ "image/jpeg" 8 | _ "image/png" 9 | "io" 10 | "strings" 11 | 12 | u "github.com/orzation/bobibo/util" 13 | ) 14 | 15 | // use braille chars to draw arts. 16 | const braille = "⠀⢀⡀⣀⠠⢠⡠⣠⠄⢄⡄⣄⠤⢤⡤⣤" + 17 | "⠐⢐⡐⣐⠰⢰⡰⣰⠔⢔⡔⣔⠴⢴⡴⣴⠂⢂⡂⣂⠢⢢⡢⣢⠆⢆⡆⣆⠦⢦⡦⣦⠒⢒⡒⣒⠲⢲⡲⣲⠖⢖⡖⣖⠶⢶⡶⣶" + 18 | "⠈⢈⡈⣈⠨⢨⡨⣨⠌⢌⡌⣌⠬⢬⡬⣬⠘⢘⡘⣘⠸⢸⡸⣸⠜⢜⡜⣜⠼⢼⡼⣼⠊⢊⡊⣊⠪⢪⡪⣪⠎⢎⡎⣎⠮⢮⡮⣮⠚⢚⡚⣚⠺⢺⡺⣺⠞⢞⡞⣞⠾⢾⡾⣾" + 19 | "⠁⢁⡁⣁⠡⢡⡡⣡⠅⢅⡅⣅⠥⢥⡥⣥⠑⢑⡑⣑⠱⢱⡱⣱⠕⢕⡕⣕⠵⢵⡵⣵⠃⢃⡃⣃⠣⢣⡣⣣⠇⢇⡇⣇⠧⢧⡧⣧⠓⢓⡓⣓⠳⢳⡳⣳⠗⢗⡗⣗⠷⢷⡷⣷" + 20 | "⠉⢉⡉⣉⠩⢩⡩⣩⠍⢍⡍⣍⠭⢭⡭⣭⠙⢙⡙⣙⠹⢹⡹⣹⠝⢝⡝⣝⠽⢽⡽⣽⠋⢋⡋⣋⠫⢫⡫⣫⠏⢏⡏⣏⠯⢯⡯⣯⠛⢛⡛⣛⠻⢻⡻⣻⠟⢟⡟⣟⠿⢿⡿⣿" 21 | 22 | var brailleMap = []rune(braille) 23 | 24 | // loading an image, only support png and jpeg. 25 | // if pass a gif, return the first embedded image. 26 | // if there is any thing wrong, panic. 27 | func LoadAImage(f io.Reader) (image.Image, error) { 28 | i, _, err := image.Decode(f) 29 | if err != nil { 30 | return nil, err 31 | } 32 | return i, nil 33 | } 34 | 35 | // loading a gif, return arrays of image. 36 | func LoadAGif(f io.Reader) ([]Pale, []int, error) { 37 | g, err := gif.DecodeAll(f) 38 | if err != nil { 39 | return nil, nil, err 40 | } 41 | return g.Image, g.Delay, nil 42 | } 43 | 44 | // resize the image with scale value, using nearestNeighbor. 45 | // return a stream chan function. 46 | var ResizeAndGray = func(scale float64) func(<-chan Img) <-chan Gray { 47 | return u.GenChanFn(func(in <-chan Img, out chan<- Gray) { 48 | for i := range in { 49 | out <- grayNearestNeighbor(scale, i) 50 | } 51 | }) 52 | } 53 | 54 | func grayNearestNeighbor(scale float64, src Img) Gray { 55 | DY, DX := src.value.Bounds().Dy(), src.value.Bounds().Dx() 56 | dy := int(scale * float64(DY)) 57 | dx := int(scale * float64(DX)) 58 | tgt := make([][]uint8, dy) 59 | 60 | for i := 0; i < dy; i++ { 61 | tgt[i] = make([]uint8, dx) 62 | for j := 0; j < dx; j++ { 63 | x, y := int((float64(j) / scale)), int((float64(i) / scale)) 64 | r, g, b, _ := src.value.At(x, y).RGBA() 65 | grayColor := (299*r + 587*g + 114*b) / 1000 66 | tgt[i][j] = uint8(grayColor >> 8) 67 | } 68 | } 69 | return Gray{id: src.id, value: tgt} 70 | } 71 | 72 | // turning image to 2d binary matrix. 73 | // use threshold to adjust the binarization. 74 | var BinotImg = func(threshold int) func(<-chan Gray) <-chan [][]bool { 75 | return u.GenChanFn(func(in <-chan Gray, out chan<- [][]bool) { 76 | for im := range in { 77 | out <- img2bin(im, &threshold) 78 | } 79 | }) 80 | } 81 | 82 | func img2bin(im Gray, th *int) [][]bool { 83 | if *th < 0 || *th > 255 { 84 | *th = int(otsu(im)) 85 | } 86 | dy, dx := im.size() 87 | reB := make([][]bool, dy) 88 | for i := range reB { 89 | reB[i] = make([]bool, dx) 90 | for j := range reB[i] { 91 | grayValue := im.value[i][j] 92 | reB[i][j] = grayValue >= uint8(*th) 93 | } 94 | } 95 | return reB 96 | } 97 | 98 | // return the best threshold to binarize. 99 | func otsu(im Gray) uint8 { 100 | var threshold int = 0 101 | const grayScale = 256 102 | var u float32 103 | var w0, u0 float32 104 | 105 | dy, dx := im.size() 106 | hist := make([]float32, grayScale) 107 | sumPixel := dy * dx 108 | 109 | for i := 0; i < dy; i++ { 110 | for j := 0; j < dx; j++ { 111 | grayValue := im.value[i][j] 112 | hist[grayValue]++ 113 | } 114 | } 115 | 116 | for i := range [grayScale]struct{}{} { 117 | hist[i] *= 1.0 / float32(sumPixel) 118 | u += float32(i) * hist[i] 119 | } 120 | var sigma float32 121 | for t := range [grayScale]struct{}{} { 122 | w0 += hist[t] 123 | u0 += float32(t) * hist[t] 124 | if w0 == 0 || 1-w0 == 0 { 125 | continue 126 | } 127 | 128 | tmp := u0 - u*w0 129 | tmp = tmp * tmp / (w0 * (1 - w0)) 130 | if tmp >= sigma { 131 | sigma = tmp 132 | threshold = t 133 | } 134 | } 135 | return uint8(threshold) 136 | } 137 | 138 | // turning 2d binary matrix to string array. 139 | // whether reverse color. 140 | var ArtotBin = func(w bool) func(<-chan [][]bool) <-chan []string { 141 | return u.GenChanFn(func(in <-chan [][]bool, out chan<- []string) { 142 | for e := range in { 143 | out <- bin2art(e, w) 144 | } 145 | }) 146 | } 147 | 148 | func bin2art(bin [][]bool, isWhite bool) []string { 149 | dy, dx := len(bin)/4, len(bin[0])/2 150 | bufStr := make([]strings.Builder, dy) 151 | resStr := make([]string, dy) 152 | for i := 0; i < dy; i++ { 153 | for j := 0; j < dx; j++ { 154 | bufStr[i].WriteRune(cell(i, j, bin, isWhite)) 155 | } 156 | resStr[i] = bufStr[i].String() 157 | } 158 | return resStr 159 | } 160 | 161 | func cell(y, x int, bin [][]bool, isWhite bool) rune { 162 | var reByte uint8 = 0 163 | for i := 0; i < 4; i++ { 164 | for j := 0; j < 2; j++ { 165 | if bin[y*4+i][x*2+j] { 166 | reByte += 1 167 | } 168 | if i != 3 || j != 1 { 169 | reByte <<= 1 170 | } 171 | } 172 | } 173 | if isWhite { 174 | reByte = ^reByte 175 | } 176 | return brailleMap[reByte] 177 | } 178 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------