"""
Copyright 2023 Ethan Christensen
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""
import string
from bruhcolor import bruhcolored
from ..bruhutil import Buffer
from ..resize import _size
from .base_effect import BaseEffect
from .settings import MatrixSettings, validated_settings
[docs]
class MatrixEffect(BaseEffect):
"""
Effect to mimic the classic cascading random-character terminal background.
"""
[docs]
def __init__(
self, buffer: Buffer, background: str, settings: MatrixSettings | None = None
):
"""
Initializes the MatrixEffect.
Args:
buffer (Buffer): Effect buffer to push changes to.
background (str): Character or string used for the background.
settings (MatrixSettings, optional): Configuration for the matrix effect. Defaults to None.
"""
s = validated_settings(settings, MatrixSettings)
super(MatrixEffect, self).__init__(buffer, background, seed=s.seed)
self.__character_choices = (
string.ascii_letters + "1234567890!@#$%^&*()_+-=<>,.:\";'{}[]?/"
)
self.__character_halt_range = s.character_halt_range
self.__color_halt_range = s.color_halt_range
self.__character_randomness_one = s.character_randomness_one
self.__character_randomness_two = s.character_randomness_two
self.__color_randomness = s.color_randomness
self.__gradient_length = s.gradient_length
self.__base_gradient = [
232,
233,
234,
235,
236,
237,
238,
239,
240,
241,
242,
243,
244,
245,
246,
247,
248,
249,
250,
251,
252,
253,
254,
255,
]
self.__gradient = [
color
for color in self.__base_gradient
for _ in range(self.__gradient_length)
]
self.__character_halts = [
self.rng.randint(
self.__character_halt_range[0], self.__character_halt_range[1]
)
for _ in range(self.buffer.height())
]
self.__color_halts = [
self.rng.randint(self.__color_halt_range[0], self.__color_halt_range[1])
for _ in range(self.buffer.height())
]
self.__character_ticks = [0 for _ in range(self.buffer.height())]
self.__color_ticks = [0 for _ in range(self.buffer.height())]
self.__buffer_characters = [
[" " for _ in range(self.buffer.width())]
for _ in range(self.buffer.height())
]
self._tick = 0
self.__pending_cells: set[tuple[int, int]] = set()
self.__pending_rows: set[int] = set()
[docs]
def resize(self, size: tuple[int, int]) -> None:
"""Resize (width, height), retaining characters, colors and row timing.
Existing cells stay at their coordinates. Cropped rows/columns are lost;
growth starts blank and initializes new cells/row intervals on the next
update. The notification does not advance ticks, reset the gradient or
consume randomness, including when several resizes happen between ticks.
"""
_size(size)
width, height = size
old_width, old_height = self.buffer.width(), self.buffer.height()
if size == (old_width, old_height):
super().resize(size)
return
rows, columns = min(height, old_height), min(width, old_width)
raster = Buffer(height, width).clear_buffer(val=self.background)
characters = [[" "] * width for _ in range(height)]
for y in range(rows):
raster.buffer[y][:columns] = self.buffer.buffer[y][:columns]
characters[y][:columns] = self.__buffer_characters[y][:columns]
new_rows = max(0, height - old_height)
self.__character_halts = (
self.__character_halts[:height]
+ [self.__character_halt_range[0]] * new_rows
)
self.__color_halts = (
self.__color_halts[:height] + [self.__color_halt_range[0]] * new_rows
)
self.__character_ticks = self.__character_ticks[:height] + [0] * new_rows
self.__color_ticks = self.__color_ticks[:height] + [0] * new_rows
self.__pending_rows = {y for y in self.__pending_rows if y < height} | set(
range(old_height, height)
)
self.__pending_cells = {
(x, y) for x, y in self.__pending_cells if x < width and y < height
} | {
(x, y)
for y in range(height)
for x in range(width)
if x >= old_width or y >= old_height
}
self.__buffer_characters = characters
self.buffer = raster
super().resize(size)
def __initialize_growth(self) -> None:
"""Acquire random state for newly exposed cells only during an update."""
for y in sorted(self.__pending_rows):
self.__character_halts[y] = self.rng.randint(*self.__character_halt_range)
self.__color_halts[y] = self.rng.randint(*self.__color_halt_range)
self.__pending_rows.clear()
# The first-ever update initializes every cell through the existing path.
if self._tick > 1:
for x, y in sorted(
self.__pending_cells, key=lambda cell: (cell[1], cell[0])
):
character = self.rng.choice(self.__character_choices)
self.__buffer_characters[y][x] = character
self.buffer.put_char(
x,
y,
bruhcolored(
character,
color=self.__gradient[
(x - self.__color_ticks[y]) % len(self.__gradient)
],
).colored,
)
self.__pending_cells.clear()
[docs]
def set_properties(
self,
character_halt_range: tuple = (1, 2),
color_halt_range: tuple = (1, 2),
character_randomness_one: float = 0.70,
character_randomness_two: float = 0.60,
color_randomness: float = 0.50,
gradient_length: int = 1,
):
"""
Updates the matrix effect properties.
Args:
character_halt_range (tuple, optional): Frame range between character updates. Defaults to (1, 2).
color_halt_range (tuple, optional): Frame range between color updates. Defaults to (1, 2).
character_randomness_one (float, optional): Probability of a row updating characters. Defaults to 0.70.
character_randomness_two (float, optional): Probability of each cell in a row updating. Defaults to 0.60.
color_randomness (float, optional): Probability of a row shifting its color gradient. Defaults to 0.50.
gradient_length (int, optional): How many times each color is repeated in the gradient. Defaults to 1.
"""
self.__character_randomness_one = character_randomness_one
self.__character_randomness_two = character_randomness_two
self.__color_randomness = color_randomness
self.__character_halt_range = character_halt_range
self.__color_halt_range = color_halt_range
self.__gradient_length = gradient_length
self.__gradient = [
color
for color in self.__base_gradient
for _ in range(self.__gradient_length)
]
self.__character_halts = [
self.rng.randint(
self.__character_halt_range[0], self.__character_halt_range[1]
)
for _ in range(self.buffer.height())
]
self.__color_halts = [
self.rng.randint(self.__color_halt_range[0], self.__color_halt_range[1])
for _ in range(self.buffer.height())
]
[docs]
def set_gradient(self, gradient: list[int]):
"""
Replaces the base color gradient.
Args:
gradient (list[int]): List of 256-color indices to use.
"""
self.__base_gradient = gradient
self.__gradient = [
color
for color in self.__base_gradient
for _ in range(self.__gradient_length)
]
[docs]
def get_gradient(self) -> list[int]:
"""
Returns the current base gradient.
Returns:
list[int]: The current base gradient.
"""
return self.__base_gradient
def __initialize_buffer(self):
for y in range(self.buffer.height()):
for x in range(self.buffer.width()):
self.__buffer_characters[y][x] = self.rng.choice(
self.__character_choices
)
for x in range(self.buffer.width()):
self.buffer.put_char(
x,
y,
bruhcolored(
self.__buffer_characters[y][x],
self.__gradient[x % len(self.__gradient)],
).colored,
)
[docs]
def update(self, dt: float) -> None:
"""Advance one tick, repainting character and color changes independently.
dt is measured in seconds. A character-only change keeps the current
gradient offset; color_randomness=0 does not freeze character updates.
"""
tick = self._tick
self._tick += 1
self.__initialize_growth()
if tick == 0:
self.__initialize_buffer()
else:
# Reuse identical styled glyphs within this tick. Keeping this cache
# local respects palette and color-environment changes between ticks.
colored_cells: dict[tuple[str, int], str] = {}
for y in range(self.buffer.height()):
changed_columns = []
if (
tick % self.__character_halts[y] == 0
and self.rng.random() < self.__character_randomness_one
):
self.__character_ticks[y] += 1
for x in range(self.buffer.width()):
if self.rng.random() < self.__character_randomness_two:
character = self.rng.choice(self.__character_choices)
if character != self.__buffer_characters[y][x]:
changed_columns.append(x)
self.__buffer_characters[y][x] = character
colors_changed = (
tick % self.__color_halts[y] == 0
and self.rng.random() < self.__color_randomness
)
if colors_changed:
self.__color_ticks[y] += 1
if changed_columns or colors_changed:
columns = (
range(self.buffer.width())
if colors_changed
else changed_columns
)
for x in columns:
character = self.__buffer_characters[y][x]
color = self.__gradient[
(x - self.__color_ticks[y]) % len(self.__gradient)
]
key = (character, color)
cell = colored_cells.get(key)
if cell is None:
cell = bruhcolored(character, color=color).colored
colored_cells[key] = cell
self.buffer.put_char(x, y, cell)