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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
|
use {
super::detect_support::is_kitty_graphics_protocol_supported,
crate::{
display::{
cell_size_in_pixels,
W,
},
errors::ProgramError,
},
base64,
cli_log::*,
crokey::crossterm::{
cursor,
QueueableCommand,
style::Color,
},
image::{
DynamicImage,
GenericImageView,
RgbImage,
RgbaImage,
},
std::{
io::{self, Write},
},
tempfile,
termimad::{fill_bg, Area},
};
/// How to send the image to kitty
///
/// Note that I didn't test yet the named shared memory
/// solution offered by kitty.
#[derive(Debug)]
pub enum TransmissionMedium {
/// write a temp file, then give its path to kitty
/// in the payload of the escape sequence. It's quite
/// fast on SSD but a big downside is that it doesn't
/// work if you're distant
TempFile,
/// send the whole rgb or rgba data, encoded in base64,
/// in the payloads of several escape sequence (each one
/// containing at most 4096 bytes). Works if broot runs
/// on remote.
Chunks,
}
enum ImageData<'i> {
RgbRef(&'i RgbImage),
RgbaRef(&'i RgbaImage),
Rgb(RgbImage),
}
impl<'i> From<&'i DynamicImage> for ImageData<'i> {
fn from(img: &'i DynamicImage) -> Self {
if let Some(rgb) = img.as_rgb8() {
debug!("using rgb");
Self::RgbRef(rgb)
} else if let Some(rgba) = img.as_rgba8() {
debug!("using rgba");
Self::RgbaRef(rgba)
} else {
debug!("converting to rgb8");
Self::Rgb(img.to_rgb8())
}
}
}
impl<'i> ImageData<'i> {
fn kitty_format(&self) -> &'static str {
match self {
Self::RgbaRef(_) => "32",
_ => "24",
}
}
fn bytes(&self) -> &[u8] {
match self {
Self::RgbRef(img) => img.as_raw(),
Self::RgbaRef(img) => img.as_raw(),
Self::Rgb(img) => img.as_raw(),
}
}
}
/// The max size of a data payload in a kitty escape sequence
/// according to kitty's documentation
const CHUNK_SIZE: usize = 4096;
fn div_ceil(a: u32, b: u32) -> u32 {
a / b + (0 != a % b) as u32
}
/// The image renderer, with knowledge of the console cells
/// dimensions, and built only on a compatible terminal
#[derive(Debug)]
pub struct KittyImageRenderer {
cell_width: u32,
cell_height: u32,
next_id: usize,
transmission_medium: TransmissionMedium,
}
/// An image prepared for a precise area on screen
struct KittyImage<'i> {
id: usize,
data: ImageData<'i>,
img_width: u32,
img_height: u32,
area: Area,
}
impl<'i> KittyImage<'i> {
fn new<'r>(
src: &'i DynamicImage,
available_area: &Area,
renderer: &'r mut KittyImageRenderer,
) -> Self {
let (img_width, img_height) = src.dimensions();
let area = renderer.rendering_area(img_width, img_height, available_area);
let data = src.into();
let id = renderer.new_id();
Self {
id,
data,
img_width,
img_height,
area,
}
}
/// Render the image by sending multiple kitty escape sequences, each
/// one with part of the image raw data (encoded as base64)
fn print_with_chunks(
&self,
w: &mut W,
) -> Result<(), ProgramError> {
let encoded = base64::encode(self.data.bytes());
w.queue(cursor::MoveTo(self.area.left, self.area.top))?;
let mut pos = 0;
loop {
if pos + CHUNK_SIZE < encoded.len() {
write!(
w,
"\u{1b}_Ga=T,f={},t=d,i={},s={},v={},c={},r={},m=1;{}\u{1b}\\",
self.data.kitty_format(),
self.id,
self.img_width,
self.img_height,
self.area.width,
self.area.height,
&encoded[pos..pos + CHUNK_SIZE],
)?;
pos += CHUNK_SIZE;
} else {
// last chunk
write!(w, "\u{1b}_Gm=0;{}\u{1b}\\", &encoded[pos..encoded.len()],)?;
break;
}
}
Ok(())
}
/// Render the image by writing the raw data in a temporary file
/// then giving to kitty the path to this file in the payload of
/// a unique kitty ecape sequence
pub fn print_with_temp_file(
&self,
w: &mut W,
) -> Result<(), ProgramError> {
let (mut temp_file, path) = tempfile::Builder::new()
.prefix("broot-img-preview")
.tempfile()?
.keep()
.map_err(|_| io::Error::new(
io::ErrorKind::Other,
"temp file can't be kept",
))?;
temp_file.write_all(self.data.bytes())?;
temp_file.flush()?;
let path = path.to_str()
.ok_or_else(|| io::Error::new(
io::ErrorKind::Other,
"Path can't be converted to UTF8",
))?;
let encoded_path = base64::encode(path);
debug!("temp file written: {:?}", path);
w.queue(cursor::MoveTo(self.area.left, self.area.top))?;
write!(
w,
"\u{1b}_Ga=T,f={},t=t,i={},s={},v={},c={},r={};{}\u{1b}\\",
self.data.kitty_format(),
self.id,
self.img_width,
self.img_height,
self.area.width,
self.area.height,
encoded_path,
)?;
debug!("file len: {}", temp_file.metadata().unwrap().len());
Ok(())
}
}
impl KittyImageRenderer {
/// Called only once (at most) by the KittyManager
pub fn new() -> Option<Self> {
if !is_kitty_graphics_protocol_supported() {
return None;
}
cell_size_in_pixels()
.ok()
.map(|(cell_width, cell_height)| Self {
cell_width,
cell_height,
next_id: 1,
transmission_medium: TransmissionMedium::Chunks,
})
}
/// return a new image id
fn new_id(&mut self) -> usize {
let new_id = self.next_id;
self.next_id += 1;
new_id
}
/// Clean the area, then print the dynamicImage and
/// return the KittyImageId for later removal from screen
pub fn print(
&mut self,
w: &mut W,
src: &DynamicImage,
area: &Area,
bg: Color,
) -> Result<usize, ProgramError> {
// clean the background below (and around) the image
for y in area.top..area.top + area.height {
w.queue(cursor::MoveTo(area.left, y))?;
fill_bg(w, area.width as usize, bg)?;
}
let img = KittyImage::new(src, area, self);
debug!("transmission medium: {:?}", self.transmission_medium);
match self.transmission_medium {
TransmissionMedium::TempFile => img.print_with_temp_file(w)?,
TransmissionMedium::Chunks => img.print_with_chunks(w)?,
}
Ok(img.id)
}
fn rendering_area(
&self,
img_width: u32,
img_height: u32,
area: &Area,
) -> Area {
let area_cols: u32 = area.width.into();
let area_rows: u32 = area.height.into();
let rdim = self.rendering_dim(img_width, img_height, area_cols, area_rows);
Area::new(
area.left + ((area_cols - rdim.0) / 2) as u16,
area.top + ((area_rows - rdim.1) / 2) as u16,
rdim.0 as u16,
rdim.1 as u16,
)
}
fn rendering_dim(
&self,
img_width: u32,
img_height: u32,
area_cols: u32,
area_rows: u32,
) -> (u32, u32) {
let optimal_cols = div_ceil(img_width, self.cell_width);
let optimal_rows = div_ceil(img_height,
|