mattn / go-sixel Goto Github PK

View Code? Open in Web Editor NEW

144.0 9.0 11.0 118 KB

DRCS/Sixel Encoder/Decoder

License: MIT License

Go 100.00%

golang sixel sixel-graphics

go-sixel's Introduction

go-sixel

DRCS Sixel Encoder/Decoder

Installation

$ go get github.com/mattn/go-sixel

You can install gosr (go sixel renderer), gosd (go sixel decoder) with following installation instruction.

$ go get github.com/mattn/go-sixel/cmd/gosr
$ go get github.com/mattn/go-sixel/cmd/gosd

Command	Description
gosr	Image renderer
gosd	Decoder to png
goscat	Render cats
gosgif	Render animation GIF
gosl	Run SL

Usage

Encode

$ cat foo.png | gosr -

Decode

$ cat foo.drcs | gosd > foo.png

Use as library

img, _, _ := image.Decode(filename)
sixel.NewEncoder(os.Stdout).Encode(img)

License

MIT

Author

Yasuhiro Matsumoto (a.k.a mattn)

go-sixel's People

Contributors

Stargazers

Watchers

Forkers

fumiyas saitoha happy-ferret mewbak mortdeus yoichi diamondburned hnw reynoldsme usernamer3042 vithnilica

go-sixel's Issues

mintty-2.9.5 works only sometimes

Not sure if this is an issue with go-sixel or rather mintty, or the environment.
gosr image.png sometimes works, somtimes it prints text to the terminal.
This is windows 7, mintty-2.9.5 on msys-2 installed and updated today.

Which setup do you use on windows? Have you seen this as well?

gosr shows an extra highlight '%' at the end of the output

Hi, I tried to show the xkcd pic in the terminator with gosr, but I found a highlight '%', is it as expected?

wget https://imgs.xkcd.com/comics/barrel_cropped_\(1\).jpg
gosr barrel_cropped_\(1\).jpg

gosr can't show image in Mac terminal

Hi, I tried to use gosr in Mac Terminal, the image couldn't show, like:

But using iTerm worked fine:

gosr produces jagged up images, img2sixel works

gosr

img2sixel

Reproducing

git clone https://github.com/vizs/stixel && cd stixel
git checkout 1d19252
make
./st
gosr astolfo.png

This does not happen with a patched xterm.

Original image: https://media.discordapp.net/attachments/361916911682060289/569426543777153044/astolfo.png

gosgif: position is not restored

Gosgif does not restore the position (at least on mintty).
This can be seen when playing small gifs, e.g. (64x64):
https://thumbs.gfycat.com/AdorableFlawedAdouri-max-1mb.gif

During the animation the old frames are shown on top and the console scrolls.
The current frame is always on the bottom.

Is this expected behaviour, or should the old frames be erased?

Add a LICENSE file

Would you add a LICENSE file to this library? It will help some automation collecting LICENSE files.

Minor note about palette handling in encode

Here you state to reserve color slot 0 for transparent (aka background color):

go-sixel/sixel.go

Line 38 in 8aa94a3

nc := 255 // (>= 2, 8bit, index 0 is reserved for transparent key color)

Following the SIXEL spec in DEC STD 070 this is actually not needed, there is no link or notion in the spec of slot 0 being reserved for unencoded pixels. The addressable color slots are independent from the background color (thus you can use all 256 slots). The background color itself is something a device might provide by other means (prolly startup color or BCE).

Can't install

The command go get github.com/mattn/go-sixel/cmd/gosr on my go version 1.19.5 complains that go get is no longer supported outside a module.
So I try: go install github.com/mattn/go-sixel/cmd/gosr@latest but that says:
The go.mod file for the module providing named packages contains one or more replace directives. It must not contain directives that would cause it to be interpreted differently than if it were the main module.

What would be the best way to install gosr for me?

broken alpha?

I'm trying to fix one problem.

When encode with go-sixel, image has some black pixels

@saitoha can you figure out cause of this issue?