Implement Sixel encoder/decoder support #381

aymanbagabas · 2025-02-20T23:52:55Z

PR originally implemented by @CannibalVox

Ref: #352

Most of this PR changes are just updates on the implementation per requests

Supersedes: #380

Co-authored-by: Ayman Bagabas <ayman.bagabas@gmail.com>

optimization

Should be enabled by default and name should reflect that.

raphamorim · 2025-02-21T00:03:01Z

ansi/go.mod

 	github.com/rivo/uniseg v0.4.7
+	github.com/soniakeys/quant v1.0.0 // indirect; go:build benchthis


not github.com/aymanbagabas/quant?

this is just for the bench?

raphamorim · 2025-02-21T00:03:16Z

ansi/go.mod

 )
+
+require github.com/aymanbagabas/quant v0.0.0-20250220224823-9dea6ec382b5


would be good to move to the first require no?

raphamorim · 2025-02-21T00:07:05Z

.gitignore

@@ -18,3 +18,6 @@

 testdata
 *.png
+
+# Allow graphics used for bench test
+!ansi/fixtures/graphics/*.png


I added ansi/fixtures/graphics/JigokudaniMonkeyPark.png originally but i have a concern if it would come along when someone would install x/ansi, i assume not right?

I think they wont as long as we use git-lfs

Only writes Sixel images for now

raphamorim · 2025-02-21T00:09:41Z

examples/img2term/main.go

+	}
+}
+
+func writeSixel(w io.Writer, img image.Image) (int, error) {


fancy! loved you added an example :D

raphamorim · 2025-02-21T00:10:55Z

examples/img2term/main.go

+	"github.com/charmbracelet/x/ansi/sixel"
+)
+
+func main() {


nit: is up to you, but would be nice to add a comment somewhere to a quick example (could be even using the png image we have in the source code)

raphamorim · 2025-02-21T00:13:07Z

ansi/sixel/util.go

@@ -0,0 +1,8 @@
+package sixel
+
+func max(a, b int) int {


this function seems quite simple do we need this? (doesn't exist in std?)

and I wonder if actually make sense to have in util.go if isn't used in more than 1 file

it does in go1.20+ I think

Go 1.21, actually. I know it seems silly but this was standard practice prior to that release (and generally not a big deal).

raphamorim · 2025-02-21T00:14:45Z

ansi/sixel/encoder.go

+		// make adaptive palette using median cut alogrithm
+		q := e.Quantizer
+		if q == nil {
+			q = median.Quantizer(nc)


raphamorim · 2025-02-21T13:55:20Z

@aymanbagabas tested locally and this branch had a regression in performance compared to #380 and #352

ansi/sixel feat-sixel-support-pp - go test -bench=. -benchmem -count 10
goos: darwin
goarch: arm64
pkg: github.com/charmbracelet/x/ansi/sixel
cpu: Apple M4 Pro
BenchmarkEncodingGoSixel-14    	       4	 295443552 ns/op	11894708 B/op	 1035163 allocs/op
BenchmarkEncodingGoSixel-14    	       4	 293885792 ns/op	11896036 B/op	 1035164 allocs/op
BenchmarkEncodingGoSixel-14    	       4	 304176646 ns/op	11894780 B/op	 1035164 allocs/op
BenchmarkEncodingGoSixel-14    	       4	 301280604 ns/op	11894680 B/op	 1035163 allocs/op
BenchmarkEncodingGoSixel-14    	       4	 299805969 ns/op	11894680 B/op	 1035163 allocs/op
BenchmarkEncodingGoSixel-14    	       4	 301399333 ns/op	11894688 B/op	 1035163 allocs/op
BenchmarkEncodingGoSixel-14    	       4	 300609573 ns/op	11894736 B/op	 1035163 allocs/op
BenchmarkEncodingGoSixel-14    	       4	 300067042 ns/op	11894688 B/op	 1035163 allocs/op
BenchmarkEncodingGoSixel-14    	       4	 300933344 ns/op	11894696 B/op	 1035163 allocs/op
BenchmarkEncodingGoSixel-14    	       4	 302264438 ns/op	11894728 B/op	 1035163 allocs/op
BenchmarkEncodingXSixel-14     	       4	 297760062 ns/op	43927074 B/op	  636054 allocs/op
BenchmarkEncodingXSixel-14     	       4	 298991354 ns/op	43927074 B/op	  636054 allocs/op
BenchmarkEncodingXSixel-14     	       4	 298944302 ns/op	43927074 B/op	  636054 allocs/op
BenchmarkEncodingXSixel-14     	       4	 301061729 ns/op	43927102 B/op	  636054 allocs/op
BenchmarkEncodingXSixel-14     	       4	 299697396 ns/op	43927106 B/op	  636054 allocs/op
BenchmarkEncodingXSixel-14     	       4	 302270990 ns/op	43927070 B/op	  636054 allocs/op
BenchmarkEncodingXSixel-14     	       4	 299696969 ns/op	43926950 B/op	  636052 allocs/op
BenchmarkEncodingXSixel-14     	       4	 302977177 ns/op	43926986 B/op	  636053 allocs/op
BenchmarkEncodingXSixel-14     	       4	 301184490 ns/op	43927074 B/op	  636054 allocs/op
BenchmarkEncodingXSixel-14     	       4	 300504781 ns/op	43927050 B/op	  636054 allocs/op
PASS
ok  	github.com/charmbracelet/x/ansi/sixel	48.628s

CannibalVox and others added 30 commits January 30, 2025 08:26

feat: Add sixels to ansi package

ed43f81

scanSize tests

d44fac5

Update ansi/sixel/encoder.go

16b7248

Co-authored-by: Ayman Bagabas <ayman.bagabas@gmail.com>

Update ansi/graphics.go

f672bee

Co-authored-by: Ayman Bagabas <ayman.bagabas@gmail.com>

pr comments

9734d1f

raster/parseraster

41a4558

repeat/parserepeat

8705df7

remove sixel.Options and address pX conditional

01e9042

remove WriteSixelGraphics func

59b7744

ignore p3

693be27

move back to ;q

0f4f102

use byte instead of rune

2a70985

remove WriteString

ce91bcb

remove slices

af13a23

use Compare and isNan from 1.24

d68cbad

fixup! use Compare and isNan from 1.24

e3b8780

fixup! fixup! use Compare and isNan from 1.24

394b145

fixup! fixup! fixup! use Compare and isNan from 1.24

39755ba

remove code

d53c02c

chore: merge branch 'main' into feat-sixel-support

38f4f5a

add bench

226b4c2

rename file

3653b43

add palette_sort

f1a551f

remove stableCmpFunc

49ef044

remove unnecessary stuff

eb42d4e

remove comments

53d8da5

feat(ansi): sixel: implement types and use io.Reader

83cc248

refactor(ansi): sixel: clean up and refactor, use quant

5735ce9

feat: use aymanbagabas/quant instead of soniakeys/quant for sort

92f58dc

optimization

feat(ansi): sixel: support transparent color in encoder

eec3c2c

feat(ansi): sixel: add dithering support

bd0387e

aymanbagabas requested a review from raphamorim February 20, 2025 23:52

aymanbagabas changed the base branch from feat-sixel-support to main February 20, 2025 23:53

aymanbagabas changed the title ~~Feat sixel support pp~~ Implement Sixel encoder/decoder support Feb 20, 2025

aymanbagabas added 2 commits February 20, 2025 18:56

chore(ansi): sixel: use unix line endings

1271e57

fix(ansi): sixel: rename AddTransparent to NoTransparency

db2c579

Should be enabled by default and name should reflect that.

aymanbagabas force-pushed the feat-sixel-support-pp branch from d3ee822 to db2c579 Compare February 20, 2025 23:56

aymanbagabas added 2 commits February 20, 2025 19:02

chore(ansi): sixel: remove unused and expose default color palette

d226daa

fix(ansi): sixel: lint errors

73138de

raphamorim reviewed Feb 21, 2025

View reviewed changes

feat(ansi): sixel: add Palette field to Decoder

e46a2b7

raphamorim reviewed Feb 21, 2025

View reviewed changes

feat(examples): add img2term example

fdb1448

Only writes Sixel images for now

raphamorim reviewed Feb 21, 2025

View reviewed changes

examples/img2term/main.go

}

}

func writeSixel(w io.Writer, img image.Image) (int, error) {

Copy link

Member

raphamorim Feb 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fancy! loved you added an example :D

raphamorim reviewed Feb 21, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement Sixel encoder/decoder support #381

Implement Sixel encoder/decoder support #381

aymanbagabas commented Feb 20, 2025 •

edited

Loading

raphamorim Feb 21, 2025

raphamorim Feb 21, 2025

raphamorim Feb 21, 2025

caarlos0 Feb 21, 2025

raphamorim Feb 21, 2025

raphamorim Feb 21, 2025

raphamorim Feb 21, 2025

caarlos0 Feb 21, 2025

meowgorithm Feb 21, 2025

raphamorim Feb 21, 2025

raphamorim commented Feb 21, 2025

		github.com/rivo/uniseg v0.4.7
		github.com/soniakeys/quant v1.0.0 // indirect; go:build benchthis

		)

		require github.com/aymanbagabas/quant v0.0.0-20250220224823-9dea6ec382b5

Implement Sixel encoder/decoder support #381

Are you sure you want to change the base?

Implement Sixel encoder/decoder support #381

Conversation

aymanbagabas commented Feb 20, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raphamorim commented Feb 21, 2025

aymanbagabas commented Feb 20, 2025 •

edited

Loading