summaryrefslogtreecommitdiffstats
path: root/_projects/matrix-digital-rain.md
blob: 7c5f295cf6fa15224bd0b88c46898dc83067aebc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
---
title: The Matrix digital rain
date: 2024-01-12
thumbnail: thumb.png
layout: post
---

"All I see is blonde, brunette, red head." The iconic digital rain from The
Matrix implemented in C without dependencies (not even ncurses).

<video style="max-width:100%;" controls="" poster="thumb.png">
  <source src="matrix.mp4" type="video/mp4">
</video>

## Overview

This is my fork of Domsson's beautiful <a
href="https://github.com/domsson/fakesteak" class="external" target="_blank"
rel="noopener noreferrer">Fakesteak</a>. As I was going through the fakesteak
code, I thought about what it might take to recreate the original rain from the
first Matrix movie without losing the program's minimalism and elegance.

My version of the matrix has the following features:

 - Unicode characters.
 - Fully customizable 24-bit RGB (truecolor) colors.
 - Glitches in the matrix.
 - Ghosting effect of old monochrome displays.
 - Closely resembles the one seen in the background while Neo and Cypher were
   talking in the first Matrix movie.

As there are no dependencies, you can compile and run it however you want:

```
$ cc -O3 main.c -o matrix
$ ./matrix
```

## How does it work?

The `matrix` struct makes use of two 2D arrays to encode the Matrix: the `code`
array for 32-bit Unicode characters and the `rgb` array for RGB values of the
characters (foreground color). The dimensions of these arrays depend on the
size of the terminal window. Each slot in the array corresponds to a cursor
position on the screen.

The ghosting effect, which is arguably the crowning feature of my version, is
implemented by carefully scaling and mixing the RGB channels:

```
static void mat_shade(matrix *mat, size_t row, size_t col) 
{
    unsigned char *color;
    color = mat->rgb[mat_idx(mat, row, col)].color;
    color[R] = color[R] - (color[R] - COLOR_BG_RED) / 2;
    color[G] = color[G] - (color[G] - COLOR_BG_GRN) / 2;
    color[B] = color[B] - (color[B] - COLOR_BG_BLU) / 2;
}
```

The above algorithm achieves transparency by iteratively bringing the
foreground color closer to the background color with each pass of the rain.
This approach offers multiple advantages, such as simpler and more natural
color configuration (background, foreground, and the color of the first drop)
that lends itself well to Unix ricing, and of course, recreates The Matrix rain
with high fidelity.

Rather than heavy-weight graphics tool kits, we use ANSI escape codes to
control the terminal screen. It's the effective use of the ANSI escape codes
that greatly contributes to the minimalism of the solution:

```
static void term_print(const matrix *mat, size_t row, size_t col)
{
    size_t idx;
    idx = mat_idx(mat, row, col);
    wprintf(L"\x1b[%d;%dH\x1b[38;2;%d;%d;%dm%lc",
        row, col,
        mat->rgb[idx].color[R],
        mat->rgb[idx].color[G],
        mat->rgb[idx].color[B],
        mat->code[idx]);
}
```

Finally, the glitch effect is controlled by the following code:

```
if (mat.row[i] > 0 && rand() % 6 == 0) {
    j = rand() % mat.row[i];
    if (mat.code[mat_idx(&mat, j, mat.col[i])] != ' ') {
        mat_put_code(&mat, j, mat.col[i]);
        term_print(&mat, j, mat.col[i]);
    }
}
```

The above code causes glitches in the Matrix with a probablity of 1/6.

## Customizing the rain

While you can customize almost any aspect of the rain including its speed,
glitch frequency, and the density of the rain, the most useful settings for
ricing are the color scheme and the character set used for the rain.

There are three color settings: the head, the tail, and the background. They
are configured by setting the `COLOR_*_RED`, `COLOR_*_GRN`, and `COLOR_*_BLU`
definitions in main.c. The `UNICODE_MIN` and `UNICODE_MAX` values control the
Unicode block used. For instance, setting them to `0x30A1` and `0x30F6` rains
Katakana code points:

<img style="width: 100%;" src="katakana.png" />

Files: [source.tar.gz](source.tar.gz)