Merge pull request #44 from liamg/sixel-mk2

Sixel support

Author: liamg

README.md

@@ -10,9 +10,14 @@ The project is experimental at the moment, so you probably won't want to rely on
 
 Ensure you have your latest graphics card drivers installed before use.
 
+Sixels are now supported.
+
+![Example sixel](sixel.png)
+
+
 ## Aims
 
-- Full unicode support
+- Unicode support
 - OpenGL rendering
 - Full customisation options
 - True colour support
@@ -23,6 +28,7 @@ Ensure you have your latest graphics card drivers installed before use.
 - Resize logic that wraps/unwraps lines _correctly_
 - Bullshit graphical effects
 - Multi platform support
+- Sixel support
 
 ## What isn't supported?
 
@@ -32,13 +38,6 @@ Ensure you have your latest graphics card drivers installed before use.
 <img alt="Overheating" src="https://imgs.xkcd.com/comics/workflow.png"/>
 </p>
 
-## Build Dependencies
-
-- Go 1.10.3+
-- On macOS, you need Xcode or Command Line Tools for Xcode (`xcode-select --install`) for required headers and libraries.
-- On Ubuntu/Debian-like Linux distributions, you need `libgl1-mesa-dev xorg-dev`.
-- On CentOS/Fedora-like Linux distributions, you need `libX11-devel libXcursor-devel libXrandr-devel libXinerama-devel mesa-libGL-devel libXi-devel`.
-
 ## Platform Support
 
 | Platform | Supported |
@@ -47,25 +46,12 @@ Ensure you have your latest graphics card drivers installed before use.
 | MacOSX   | ⏳        |
 | Windows  | ⏳        |
 
-## Planned Features
-
-| Feature                     | Done | Notes |
-|-----------------------------|------|-------|
-| Pty allocation              | ✔    | 
-| OpenGL rendering            | ✔    |
-| 8-bit (256) colour          | ✔    |
-| 24-bit (true) colour        | ✔    |
-| Resizing/content reordering | ✔    | 
-| ANSI escape codes           | ✔    | 
-| UTF-8 input                 | ✔    | 
-| UTF-8 output                | ✔    | 
-| Copy/paste                  | ✔    | 
-| Customisable colour schemes | ✔    | 
-| Config file                 | ✔    |
-| Scrolling                   | ✔    | 
-| Mouse interaction           | ✔    | 
-| Clickable URLs              | ✔    |
-| Sweet render effects        |      | 
+## Build Dependencies
+
+- Go 1.10.3+
+- On macOS, you need Xcode or Command Line Tools for Xcode (`xcode-select --install`) for required headers and libraries.
+- On Ubuntu/Debian-like Linux distributions, you need `libgl1-mesa-dev xorg-dev`.
+- On CentOS/Fedora-like Linux distributions, you need `libX11-devel libXcursor-devel libXrandr-devel libXinerama-devel mesa-libGL-devel libXi-devel`.
 
 ## Keyboard Shortcuts
 

buffer/cell.go

@@ -1,8 +1,15 @@
 package buffer
 
+import (
+	"image"
+
+	"github.com/go-gl/gl/all-core/gl"
+)
+
 type Cell struct {
-	r    rune
-	attr CellAttributes
+	r     rune
+	attr  CellAttributes
+	image *image.RGBA
 }
 
 type CellAttributes struct {
@@ -16,6 +23,64 @@ type CellAttributes struct {
 	Hidden    bool
 }
 
+func (cell *Cell) Image() *image.RGBA {
+	return cell.image
+}
+
+func (cell *Cell) SetImage(img *image.RGBA) {
+
+	cell.image = img
+
+}
+
+func (cell *Cell) DrawImage(x, y float32) {
+
+	if cell.image == nil {
+		return
+	}
+
+	var tex uint32
+	gl.Enable(gl.TEXTURE_2D)
+	gl.GenTextures(1, &tex)
+	gl.BindTexture(gl.TEXTURE_2D, tex)
+	gl.TexParameterf(gl.TEXTURE_2D, gl.TEXTURE_MIN_FILTER, gl.NEAREST)
+	gl.TexParameterf(gl.TEXTURE_2D, gl.TEXTURE_MAG_FILTER, gl.NEAREST)
+	gl.TexParameterf(gl.TEXTURE_2D, gl.TEXTURE_WRAP_S, gl.CLAMP_TO_EDGE)
+	gl.TexParameterf(gl.TEXTURE_2D, gl.TEXTURE_WRAP_T, gl.CLAMP_TO_EDGE)
+
+	gl.TexImage2D(
+		gl.TEXTURE_2D,
+		0,
+		gl.RGBA,
+		int32(cell.image.Bounds().Size().X),
+		int32(cell.image.Bounds().Size().Y),
+		0,
+		gl.RGBA,
+		gl.UNSIGNED_BYTE,
+		gl.Ptr(cell.image.Pix),
+	)
+	gl.BindTexture(gl.TEXTURE_2D, 0)
+	gl.Disable(gl.TEXTURE_2D)
+
+	gl.Disable(gl.BLEND)
+
+	var w float32 = float32(cell.image.Bounds().Size().X)
+	var h float32 = float32(cell.image.Bounds().Size().Y)
+
+	var readFboId uint32
+	gl.GenFramebuffers(1, &readFboId)
+	gl.BindFramebuffer(gl.READ_FRAMEBUFFER, readFboId)
+
+	gl.FramebufferTexture2D(gl.READ_FRAMEBUFFER, gl.COLOR_ATTACHMENT0,
+		gl.TEXTURE_2D, tex, 0)
+	gl.BlitFramebuffer(0, 0, int32(w), int32(h),
+		int32(x), int32(y), int32(x+w), int32(y+h),
+		gl.COLOR_BUFFER_BIT, gl.LINEAR)
+	gl.BindFramebuffer(gl.READ_FRAMEBUFFER, 0)
+	gl.DeleteFramebuffers(1, &readFboId)
+
+}
+
 func (cell *Cell) Attr() CellAttributes {
 	return cell.attr
 }

example.sixel

@@ -81,6 +81,8 @@ func (gui *GUI) resize(w *glfw.Window, width int, height int) {
 	gui.logger.Debugf("Setting viewport size...")
 	gl.Viewport(0, 0, int32(gui.width), int32(gui.height))
 
+	gui.terminal.SetCharSize(gui.renderer.cellWidth, gui.renderer.cellHeight)
+
 	gui.logger.Debugf("Resize complete!")
 
 }
@@ -191,6 +193,8 @@ func (gui *GUI) Render() error {
 		}
 	}()
 
+	gui.terminal.SetProgram(program)
+
 	for !gui.window.ShouldClose() {
 
 		select {
@@ -242,10 +246,20 @@ func (gui *GUI) Render() error {
 					if hasText {
 						gui.renderer.DrawCellText(cell, uint(x), uint(y), nil)
 					}
+
+					if cell.Image() != nil {
+						ix := float32(x) * gui.renderer.cellWidth
+						iy := float32(gui.height) - (float32(y+1) * gui.renderer.cellHeight)
+						iy -= float32(cell.Image().Bounds().Size().Y)
+						gl.UseProgram(program)
+						cell.DrawImage(ix, iy)
+					}
+
 				}
 			}
 
 			gui.window.SwapBuffers()
+
 		}
 
 	}

gui/gui.go

@@ -214,6 +214,7 @@ func (r *OpenGLRenderer) DrawCellBg(cell buffer.Cell, col uint, row uint, cursor
 		rect.setColour(bg)
 		rect.Draw()
 	}
+
 }
 
 func (r *OpenGLRenderer) DrawCellText(cell buffer.Cell, col uint, row uint, colour *config.Colour) {