ratatui-image 10.0.8

An image widget for ratatui, supporting sixels, kitty, iterm2, and unicode-halfblocks
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

//! Chafa-based halfblocks implementation using compile-time linking.
//!
//! This module uses compile-time linking to libchafa.so (dyn) or libchafa.a (static).

use std::ffi::c_void;
use std::sync::OnceLock;

use image::DynamicImage;
use ratatui::{layout::Rect, style::Color};

use super::HalfBlock;

// Opaque pointer types (same as dynamic version)
type ChafaSymbolMap = *mut c_void;
type ChafaCanvasConfig = *mut c_void;
type ChafaCanvas = *mut c_void;

// Constants from chafa.h
const CHAFA_SYMBOL_TAG_ALL: u32 = 0xBFE7FFFF;
const CHAFA_PIXEL_RGB8: u32 = 8;

// FFI declarations - linked via build.rs (static or dynamic based on feature)
#[cfg_attr(feature = "chafa-dyn", link(name = "chafa"))]
unsafe extern "C" {
    fn chafa_symbol_map_new() -> ChafaSymbolMap;
    fn chafa_symbol_map_add_by_tags(symbol_map: ChafaSymbolMap, tags: u32);
    fn chafa_symbol_map_unref(symbol_map: ChafaSymbolMap);
    fn chafa_canvas_config_new() -> ChafaCanvasConfig;
    fn chafa_canvas_config_set_symbol_map(config: ChafaCanvasConfig, symbol_map: ChafaSymbolMap);
    fn chafa_canvas_config_set_geometry(config: ChafaCanvasConfig, width: i32, height: i32);
    fn chafa_canvas_config_unref(config: ChafaCanvasConfig);
    fn chafa_canvas_new(config: ChafaCanvasConfig) -> ChafaCanvas;
    fn chafa_canvas_draw_all_pixels(
        canvas: ChafaCanvas,
        pixel_type: u32,
        pixels: *const u8,
        width: i32,
        height: i32,
        rowstride: i32,
    );
    fn chafa_canvas_get_char_at(canvas: ChafaCanvas, x: i32, y: i32) -> u32;
    fn chafa_canvas_get_colors_at(canvas: ChafaCanvas, x: i32, y: i32, fg: *mut i32, bg: *mut i32);
    fn chafa_canvas_unref(canvas: ChafaCanvas);
}

/// Holds the cached symbol map for reuse across encode calls.
struct ChafaState {
    symbol_map: ChafaSymbolMap,
}

// SAFETY: The chafa library functions are thread-safe for independent canvases.
// The symbol_map is created once and only read afterwards.
unsafe impl Send for ChafaState {}
unsafe impl Sync for ChafaState {}

impl Drop for ChafaState {
    fn drop(&mut self) {
        unsafe {
            chafa_symbol_map_unref(self.symbol_map);
        }
    }
}

static CHAFA: OnceLock<ChafaState> = OnceLock::new();

fn init_chafa() -> ChafaState {
    unsafe {
        let symbol_map = chafa_symbol_map_new();
        chafa_symbol_map_add_by_tags(symbol_map, CHAFA_SYMBOL_TAG_ALL);
        ChafaState { symbol_map }
    }
}

/// Encode using chafa.
pub fn encode(img: &DynamicImage, area: Rect) -> Option<Vec<HalfBlock>> {
    let chafa = CHAFA.get_or_init(init_chafa);

    let width = area.width;
    let height = area.height;

    unsafe {
        let config = chafa_canvas_config_new();
        chafa_canvas_config_set_symbol_map(config, chafa.symbol_map);
        chafa_canvas_config_set_geometry(config, width as i32, height as i32);

        let canvas = chafa_canvas_new(config);

        let rgb = img.to_rgb8();
        let (w, h) = rgb.dimensions();

        chafa_canvas_draw_all_pixels(
            canvas,
            CHAFA_PIXEL_RGB8,
            rgb.as_ptr(),
            w as i32,
            h as i32,
            (w * 3) as i32,
        );

        let mut blocks = Vec::with_capacity((width * height) as usize);

        for y in 0..height {
            for x in 0..width {
                let c = chafa_canvas_get_char_at(canvas, x as i32, y as i32);
                let symbol = char::from_u32(c).unwrap_or(' ');

                let mut fg_color: i32 = 0;
                let mut bg_color: i32 = 0;
                chafa_canvas_get_colors_at(
                    canvas,
                    x as i32,
                    y as i32,
                    &mut fg_color,
                    &mut bg_color,
                );

                let fg = Color::Rgb(
                    ((fg_color >> 16) & 0xff) as u8,
                    ((fg_color >> 8) & 0xff) as u8,
                    (fg_color & 0xff) as u8,
                );
                let bg = Color::Rgb(
                    ((bg_color >> 16) & 0xff) as u8,
                    ((bg_color >> 8) & 0xff) as u8,
                    (bg_color & 0xff) as u8,
                );

                blocks.push(HalfBlock {
                    upper: fg,
                    lower: bg,
                    char: symbol,
                });
            }
        }

        chafa_canvas_unref(canvas);
        chafa_canvas_config_unref(config);

        Some(blocks)
    }
}