{"id":1044,"date":"2016-05-06T15:11:47","date_gmt":"2016-05-06T13:11:47","guid":{"rendered":"https:\/\/esimov.com\/blog\/?p=1044"},"modified":"2019-04-29T13:02:14","modified_gmt":"2019-04-29T11:02:14","slug":"ascii-mandelbrot-renderer-in-go","status":"publish","type":"post","link":"https:\/\/esimov.com\/blog\/2016\/05\/06\/ascii-mandelbrot-renderer-in-go\/","title":{"rendered":"ASCII terminal mandelbrot fractal renderer in Go"},"content":{"rendered":"

After the previous post about the mandelbrot renderer written in Go, this article will be related to the same topic, only this time i’ll talk about a terminal based Julia set generator written again in Go language. In fact i’ve done this experiment prior to write the mandelbrot renderer. About the implementation I’ve discussed in the last article<\/a>.<\/p>\n

The whole idea came from the motivation to create something which resembles the feeling which only a terminal based application can create (something which is close enough to the pixelart technique), but at the same time it has enough visually appealing characteristics and above all it’s dynamic.<\/p>\n

Into the terminal fractals<\/h2>\n

(In preview the ASCII Mandelbrot generator running in terminal<\/em>)<\/p>\n

Because in the last few months i was pretty much delved into the fractals, i’ve started to create some small experiments, one of them being the code snippet below:<\/p>\n

https:\/\/gist.github.com\/esimov\/970a3816dda12e4059e3.js<\/a><\/p>\n

Which produce the following terminal output:<\/p>\n

\"mandelbrot\"<\/p>\n

This was nice but i wanted to be dynamic, and not something simply put in the terminal window. So i’ve started to search for methods to refresh the terminal window periodically, ideally to refresh on each mandelbrot iteration. For this reason i’ve created some utility methods to get the terminal window width and height. And another method to flush the screen buffer periodically.<\/p>\n

\r\n\/\/ Get console width<\/span>\r\nfunc<\/span> Width<\/span>(<\/span>)<\/span> int<\/span> {<\/span>\r\n\tws,<\/span> err :=<\/span> getWinsize<\/span>(<\/span>)<\/span>\r\n\r\n\tif<\/span> err !=<\/span> nil<\/span> {<\/span>\r\n\t\treturn<\/span> -<\/span>1<\/span>\r\n\t}<\/span>\r\n\r\n\treturn<\/span> int<\/span>(<\/span>ws.<\/span>Row)<\/span>\r\n}<\/span>\r\n\r\n\/\/ Get console height<\/span>\r\nfunc<\/span> Height<\/span>(<\/span>)<\/span> int<\/span> {<\/span>\r\n\tws,<\/span> err :=<\/span> getWinsize<\/span>(<\/span>)<\/span>\r\n\tif<\/span> err !=<\/span> nil<\/span> {<\/span>\r\n\t\treturn<\/span> -<\/span>1<\/span>\r\n\t}<\/span>\r\n\treturn<\/span> int<\/span>(<\/span>ws.<\/span>Col)<\/span>\r\n}<\/span>\r\n\r\n\/\/ Flush buffer and ensure that it will not overflow screen<\/span>\r\nfunc<\/span> Flush<\/span>(<\/span>)<\/span> {<\/span>\r\n\tfor<\/span> idx,<\/span> str :=<\/span> range<\/span> strings.<\/span>Split<\/span>(<\/span>Screen.<\/span>String<\/span>(<\/span>)<\/span>,<\/span> \"\\n\"<\/span>)<\/span> {<\/span>\r\n\t\tif<\/span> idx ><\/span> Height<\/span>(<\/span>)<\/span> {<\/span>\r\n\t\t\treturn<\/span>\r\n\t\t}<\/span>\r\n\r\n\t\toutput.<\/span>WriteString<\/span>(<\/span>str +<\/span> \"\\n\"<\/span>)<\/span>\r\n\t}<\/span>\r\n\r\n\toutput.<\/span>Flush<\/span>(<\/span>)<\/span>\r\n\tScreen.<\/span>Reset<\/span>(<\/span>)<\/span>\r\n}<\/span>\r\n<\/code><\/pre>\n
It was missing another ingredient: in terminal based application we need somehow to specify the cursor position where to output the desired character, some kind of pointer to a position specified by width and height coordinate. For this i’ve created another method which move the cursor to the desired place, defined by x<\/kbd> and y<\/kbd>:<\/p>\n
\/\/ Move cursor to given position<\/span>\r\nfunc MoveCursor<\/span>(<\/span>x int,<\/span> y int)<\/span> {<\/span>\r\n\tfmt.<\/span>Fprintf<\/span>(<\/span>Screen,<\/span> \"\\033[%d;%dH\"<\/span>,<\/span> x,<\/span> y)<\/span>\r\n}<\/span><\/code><\/pre>\n
To make it more attractive i used a cheap trick to zoom in and out into the fractal and to smoothly displace the fractal position by applying sine and cosine function on x and y coordinate.<\/p>\n
for<\/span> {<\/span>\r\n\tn +<\/span>=<\/span> 0.045<\/span>\r\n\tzoom +<\/span>=<\/span> 0.04<\/span> *<\/span> math.<\/span>Sin<\/span>(<\/span>n)<\/span>\r\n\tasciibrot.<\/span>DrawFractal<\/span>(<\/span>zoom,<\/span> math.<\/span>Cos<\/span>(<\/span>n)<\/span>,<\/span> math.<\/span>Sin<\/span>(<\/span>n)<\/span>\/<\/span>zoom*<\/span>0.02<\/span>,<\/span> math.<\/span>Sin<\/span>(<\/span>n)<\/span>,<\/span> MAX_IT,<\/span> true<\/span>,<\/span> isColor)<\/span> \/\/where math.Cos(n) and math.Sin(n) are x and y coordinates\t<\/span>\r\n}<\/span><\/code><\/pre>\n
But there is another issue. We need to handle differently the code responsible to obtain the terminal window size in different operating systems. In linux and darwin based operating systems here is how we can get the terminal size:<\/p>\n
func getWinsize<\/span>(<\/span>)<\/span> (<\/span>*<\/span>winsize,<\/span> error)<\/span> {<\/span>\r\n\tws :<\/span>=<\/span> new<\/span>(<\/span>winsize)<\/span>\r\n\r\n\tvar<\/span> _TIOCGWINSZ int64\r\n\r\n\tswitch<\/span> runtime.<\/span>GOOS {<\/span>\r\n\tcase<\/span> \"linux\"<\/span>:<\/span>\r\n\t\t_TIOCGWINSZ =<\/span> 0x5413<\/span>\r\n\tcase<\/span> \"darwin\"<\/span>:<\/span>\r\n\t\t_TIOCGWINSZ =<\/span> 1074295912<\/span>\r\n\t}<\/span>\r\n\r\n\tr1,<\/span> _,<\/span> errno :<\/span>=<\/span> syscall.<\/span>Syscall<\/span>(<\/span>syscall.<\/span>SYS_IOCTL,<\/span>\r\n\t\tuintptr<\/span>(<\/span>syscall.<\/span>Stdin)<\/span>,<\/span>\r\n\t\tuintptr<\/span>(<\/span>_TIOCGWINSZ)<\/span>,<\/span>\r\n\t\tuintptr<\/span>(<\/span>unsafe.<\/span>Pointer<\/span>(<\/span>ws)<\/span>)<\/span>,<\/span>\r\n\t)<\/span>\r\n\r\n\tif<\/span> int<\/span>(<\/span>r1)<\/span> ==<\/span> -<\/span>1<\/span> {<\/span>\r\n\t\tfmt.<\/span>Println<\/span>(<\/span>\"Error:\"<\/span>,<\/span> os.<\/span>NewSyscallError<\/span>(<\/span>\"GetWinsize\"<\/span>,<\/span> errno)<\/span>)<\/span>\r\n\t\treturn<\/span> nil,<\/span> os.<\/span>NewSyscallError<\/span>(<\/span>\"GetWinsize\"<\/span>,<\/span> errno)<\/span>\r\n\t}<\/span>\r\n\treturn<\/span> ws,<\/span> nil\r\n}<\/span>\r\n<\/code><\/pre>\n
In Windows operating system to obtain the terminal dimension is a little bit different:<\/p>\n
\r\ntype<\/span> (<\/span>\r\n\tcoord struct<\/span> {<\/span>\r\n\t\tx int16<\/span>\r\n\t\ty int16<\/span>\r\n\t}<\/span>\r\n\r\n\tconsoleScreenBufferInfo struct<\/span> {<\/span>\r\n\t\tsize              coord\r\n\t\tcursorPosition    coord\r\n\t\tmaximumWindowSize coord\r\n\t}<\/span>\r\n)<\/span>\r\n\/\/ ...<\/span>\r\nfunc<\/span> getWinSize<\/span>(<\/span>)<\/span> (<\/span>width,<\/span> height int<\/span>,<\/span> err error<\/span>)<\/span> {<\/span>\r\n\tvar<\/span> info consoleScreenBufferInfo\r\n\tr0,<\/span> _<\/span>,<\/span> e1 :=<\/span> syscall.<\/span>Syscall<\/span>(<\/span>procGetConsoleScreenBufferInfo.<\/span>Addr<\/span>(<\/span>)<\/span>,<\/span> 2<\/span>,<\/span> uintptr<\/span>(<\/span>out)<\/span>,<\/span> uintptr<\/span>(<\/span>unsafe.<\/span>Pointer<\/span>(<\/span>&<\/span>info)<\/span>)<\/span>,<\/span> 0<\/span>)<\/span>\r\n\tif<\/span> int<\/span>(<\/span>r0)<\/span> ==<\/span> 0<\/span> {<\/span>\r\n\t\tif<\/span> e1 !=<\/span> 0<\/span> {<\/span>\r\n\t\t\terr =<\/span> error<\/span>(<\/span>e1)<\/span>\r\n\t\t}<\/span> else<\/span> {<\/span>\r\n\t\t\terr =<\/span> syscall.<\/span>EINVAL\r\n\t\t}<\/span>\r\n\t}<\/span>\r\n\treturn<\/span> int<\/span>(<\/span>info.<\/span>size.<\/span>x)<\/span>,<\/span> int<\/span>(<\/span>info.<\/span>size.<\/span>y)<\/span>,<\/span> nil<\/span>\r\n}<\/span>\r\n<\/code><\/pre>\n
One last step remained: to clear the screen buffer on CTRL-C signal, in another words to clear the screen on control break. For this i’ve created a channel and when the CTRL-C was pressed i signaled this event and on a separate goroutine i was listening for this event, meaning i could break the operation.<\/p>\n
\r\n\/\/ On CTRL+C restore default terminal foreground and background color<\/span>\r\ngo<\/span> func<\/span>(<\/span>)<\/span> {<\/span>\r\n\t<-<\/span>c\r\n\tfmt.<\/span>Fprint<\/span>(<\/span>asciibrot.<\/span>Screen,<\/span> \"%s%s\"<\/span>,<\/span> \"\\x1b[49m\"<\/span>,<\/span> \"\\x1b[39m\"<\/span>)<\/span>\r\n\tfmt.<\/span>Fprint<\/span>(<\/span>asciibrot.<\/span>Screen,<\/span> \"\\033[2J\"<\/span>)<\/span>\r\n\tasciibrot.<\/span>Flush<\/span>(<\/span>)<\/span>\r\n\tos.<\/span>Exit<\/span>(<\/span>1<\/span>)<\/span>\r\n}<\/span>(<\/span>)<\/span>\r\n<\/code><\/pre>\n
Usage<\/h2>\n
In big that’s all. You can grab the code by running the following command:<\/p>\n

\ngo get github.com\/esimov\/asciibrot
\n<\/code><\/p>\n
To run it type:<\/p>\n

\ngo run julia.go --help
\n<\/code><\/p>\n
\n
Terminal fractal ASCII art written in Go. #golang<\/a> #fractal<\/a> #terminal<\/a> #ascii<\/a> pic.twitter.com\/WtwHkhoOPz<\/a><\/p>\n
— Sim\u00f3 Endre (@simo_endre) March 28, 2016<\/a><\/p><\/blockquote>\n
Then we can clear the screen buffer periodically. In linux based systems to move the cursor to a specific place in terminal window we can use ANSI escape codes, like: \\033[%d;%dH<\/kbd>, where %d;%d<\/kbd> we can replace with values obtained from the mandelbrot renderer. In the example provided in the project github repo<\/a> i’m moving the terminal window cursor to the mandelbrot x<\/kbd> and y<\/kbd> position, after which i’m clearing the screen.<\/p>\n