rs3a 2.5.0

Animated ascii art rust library
Documentation
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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
use core::fmt;
use std::{
    io::{self, BufReader, Read},
    slice, usize,
};

use crate::{
    chars::{normalize_text, Char, SPACE, UNDERSCORE},
    colors::{trans_color, CSSColorMap, ColorPair, Palette},
    delay::Delay,
    error::{Error, Result},
    font::Font,
    header::{Header, LegacyColorMode, LegacyHeaderInfo},
    helpers::{escape_html, in_range, timing_for_svg},
    Color,
};

/// A single cell in a frame, containing a text character
/// and an optional color character.
#[derive(Debug, Clone, Copy, Eq, PartialEq, Hash)]
pub struct Cell {
    /// The text character displayed in this cell.
    pub text: Char,
    /// The color character (if any) that maps to a palette color pair.
    pub color: Option<Char>,
}

impl Default for Cell {
    fn default() -> Self {
        Self {
            text: SPACE,
            color: None,
        }
    }
}

impl Cell {
    /// Returns true if this cell has a color assigned.
    pub fn color(&self) -> bool {
        self.color != None
    }

    /// Converts the cell's color to a `ColorPair` using the given palette.
    pub fn to_pair(&self, palette: &Palette) -> ColorPair {
        if let Some(color) = self.color {
            palette.get_color(color)
        } else {
            ColorPair::default()
        }
    }

    /// Returns the ANSI escape sequence for this cell.
    pub fn ansi(&self, palette: &Palette) -> String {
        if let Some(color) = self.color {
            format!(
                "{}{}{}",
                palette.get_color(color).to_ansi(),
                self.text,
                ColorPair::default().to_ansi(),
            )
        } else {
            self.text.into()
        }
    }
}

/// A single frame of 3a art, consisting of a grid of cells.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Frame {
    pub(crate) color: usize,
    pub(crate) width: usize,
    pub(crate) rows: Vec<Vec<Cell>>,
}

/// Merges a text frame and a color frame into a single frame.
/// Returns an error if dimensions mismatch.
pub fn merge_frames(text: &Frame, color: &Frame) -> Result<Frame> {
    if text.height() != color.height() {
        return Err(Error::HeightMismatch);
    }
    if text.width() != color.width() {
        return Err(Error::WidthMismatch);
    }
    let mut frame = Frame::new(text.width(), text.height(), Cell::default());
    for r in 0..frame.height() {
        for c in 0..frame.width() {
            frame.rows[r][c] = Cell {
                text: text.rows[r][c].text,
                color: color.rows[r][c].color,
            };
        }
    }
    frame.recalc_colors();
    Ok(frame)
}

// SVG
impl Frame {
    /// Generates SVG background rectangles for colored cells.
    pub fn to_svg_frame_bg(&self, palette: &Palette, map: &CSSColorMap, font: &Font) -> String {
        let mut txt = String::new();
        for r in 0..self.height() {
            for c in 0..self.width() {
                if let Some(name) = self.rows[r][c].color {
                    let bg = palette.get_color(name).bg;
                    if bg == Color::None {
                        continue;
                    }
                    let fill = map.map(bg, false);
                    let x = font.width * c;
                    let y = font.height * r;
                    // TODO: Optimise sequences
                    txt += &format!(
                        "<rect x=\"{}\"  y=\"{}\"  width=\"{}\" height=\"{}\" fill=\"{}\"/>\n",
                        x, y, font.width, font.height, fill
                    );
                };
            }
        }
        txt
    }

    /// Generates SVG text with foreground colors.
    pub fn to_svg_frame_txt_fg(&self, palette: &Palette, map: &CSSColorMap, font: &Font) -> String {
        let mut txt =
            "<text x=\"0\" y=\"0\" xml:space=\"preserve\" dominant-baseline=\"hanging\">\n".into();
        for r in 0..self.height() {
            for c in 0..self.width() {
                let fg = if let Some(name) = self.rows[r][c].color {
                    Some(palette.get_color(name).fg)
                } else {
                    None
                };
                let fill = map.map_opt(fg, true);
                let x = font.width * c + font.fg_offset_x;
                let y = font.height * r + font.fg_offset_y;
                // TODO: Optimise sequences
                let span = format!(
                    "<tspan x=\"{}\" y=\"{}\" fill=\"{}\">{}</tspan>\n",
                    x,
                    y,
                    fill,
                    escape_html(&self.rows[r][c].text.to_string()),
                );
                txt += span.as_str();
            }
        }
        txt += "</text>\n";
        txt
    }

    /// Generates SVG text without colors.
    pub fn to_svg_frame_txt(&self, font: &Font) -> String {
        let mut txt =
            "<text x=\"0\" y=\"0\" xml:space=\"preserve\" dominant-baseline=\"hanging\">\n".into();
        for r in 0..self.height() {
            let mut row = String::new();
            for c in 0..self.width() {
                row += self.rows[r][c].text.to_string().as_str();
            }
            let x = font.fg_offset_x;
            let y = font.height * r + font.fg_offset_y;
            let row = format!(
                "<tspan x=\"{}\" y=\"{}\">{}</tspan>\n",
                x,
                y,
                escape_html(&row)
            );
            txt += row.as_str();
        }
        txt += "</text>\n";
        txt
    }

    /// Generates SVG for this frame, optionally with colors.
    pub fn to_svg_frame(
        &self,
        colors: bool,
        palette: &Palette,
        map: &CSSColorMap,
        font: &Font,
    ) -> String {
        if colors {
            self.to_svg_frame_bg(palette, map, font) + &self.to_svg_frame_txt_fg(palette, map, font)
        } else {
            self.to_svg_frame_txt(font)
        }
    }

    /// Generates a complete SVG document for this frame.
    pub fn to_svg(
        &self,
        colors: bool,
        palette: &Palette,
        map: &CSSColorMap,
        font: &Font,
    ) -> String {
        let mut svg = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n".into();
        let width = self.width() * font.width;
        let height = self.height() * font.height;
        svg += format!(
            "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"{}\" height=\"{}\" viewBox=\"0 0 {} {}\" role=\"img\">\n",
            width, height, width, height
        )
        .as_str();
        svg += font.to_style().as_str();
        if colors {
            svg += format!(
                "<rect x=\"0\"  y=\"0\"  width=\"{}\" height=\"{}\" fill=\"{}\"/>\n",
                width,
                height,
                map.map(Color::None, false)
            )
            .as_str();
        }
        svg += self.to_svg_frame(colors, palette, map, font).as_str();
        svg += "</svg>\n";
        svg
    }
}

impl Frame {
    /// Reads a color-only frame from input lines.
    pub fn read_color<R: Read>(lines: &mut io::Lines<BufReader<R>>) -> Result<Self> {
        let mut width: usize = 0;
        let mut rows: Vec<Vec<Cell>> = Vec::new();
        let mut color: usize = 0;
        for line in lines {
            let line = normalize_text(line?.as_str());
            if line.is_empty() {
                break;
            }
            let full_line: Vec<char> = line.chars().collect();
            if width != 0 && full_line.len() != width {
                return Err(Error::WidthMismatch);
            }
            width = full_line.len();
            let mut row: Vec<Cell> = Vec::new();
            for c in full_line {
                row.push(Cell {
                    text: SPACE,
                    color: Some(Char::new_must(c)),
                });
                color += 1;
            }
            rows.push(row);
        }
        Ok(Self { width, color, rows })
    }

    /// Reads a text-only frame from input lines.
    pub fn read_text<R: Read>(lines: &mut io::Lines<BufReader<R>>) -> Result<Self> {
        let mut width: usize = 0;
        let mut rows: Vec<Vec<Cell>> = Vec::new();
        for line in lines {
            let line = normalize_text(line?.as_str());
            if line.is_empty() {
                break;
            }
            let full_line: Vec<char> = line.chars().collect();
            if width != 0 && full_line.len() != width {
                return Err(Error::WidthMismatch);
            }
            width = full_line.len();
            let mut row: Vec<Cell> = Vec::new();
            for c in full_line {
                row.push(Cell {
                    text: Char::new_must(c),
                    color: None,
                });
            }
            rows.push(row);
        }
        Ok(Self {
            width,
            color: 0,
            rows,
        })
    }

    /// Reads a combined (text+color) frame from input lines.
    pub fn read_both<R: Read>(lines: &mut io::Lines<BufReader<R>>) -> Result<Self> {
        let mut width: usize = 0;
        let mut rows: Vec<Vec<Cell>> = Vec::new();
        let mut color: usize = 0;
        for line in lines {
            let line = normalize_text(line?.as_str());
            if line.is_empty() {
                break;
            }
            let full_line: Vec<char> = line.chars().collect();
            if width != 0 && full_line.len() / 2 != width {
                return Err(Error::WidthMismatch);
            }
            width = full_line.len() / 2;
            let mut row: Vec<Cell> = Vec::new();
            let text = &full_line[..full_line.len() / 2];
            let colors = &full_line[full_line.len() / 2..];
            if text.len() != colors.len() {
                return Err(Error::WidthMismatch);
            }
            for i in 0..text.len() {
                row.push(Cell {
                    text: Char::new_must(text[i]),
                    color: Some(Char::new_must(colors[i])),
                });
                color += 1;
            }
            rows.push(row);
        }
        Ok(Self { width, color, rows })
    }
}

impl Frame {
    /// Returns true if the frame contains any color cells.
    pub fn color(&self) -> bool {
        self.color > 0
    }

    /// Returns the width of the frame in cells.
    pub fn width(&self) -> usize {
        self.width
    }

    /// Returns the height of the frame in cells.
    pub fn height(&self) -> usize {
        self.rows.len()
    }

    pub fn remove_color(&mut self, color: Char) {
        for row in &mut self.rows {
            for cell in row {
                if let Some(c) = cell.color {
                    if c == color {
                        cell.color = None;
                    }
                }
            }
        }
    }

    /// Crop frame
    pub fn crop(&mut self, r_from: usize, r_to: usize, c_from: usize, c_to: usize) {
        if r_to >= self.height() {
            self.adjust_height(r_to + 1, Cell::default());
        }
        if c_to >= self.width() {
            self.adjust_width(c_to + 1, Cell::default());
        }
        let r_to = in_range(r_to, 0, self.height());
        let r_from = r_from.min(r_to);
        let c_to = in_range(c_to, 0, self.width());
        let c_from = c_from.min(c_to);

        self.rows.truncate(r_to + 1); // discard everything after `to`
        self.rows.drain(..r_from); // discard everything before `from`

        for row in &mut self.rows {
            row.truncate(c_to + 1); // discard everything after `to`
            row.drain(..c_from); // discard everything before `from`
        }

        self.width = c_to - c_from + 1;
    }

    /// Shifts all rows right by `cols`, filling new cells with `fill`.
    pub fn shift_right(&mut self, cols: usize, fill: Cell) {
        let h = self.height();
        let w = self.width();
        if h == 0 || w == 0 {
            return;
        }
        for row in self.rows.iter_mut() {
            if cols <= w {
                row.rotate_right(cols);
            }
            for c in 0..cols.min(w) {
                row[c] = fill;
            }
        }
    }

    /// Shifts all rows left by `cols`, filling vacated cells with `fill`.
    pub fn shift_left(&mut self, cols: usize, fill: Cell) {
        let h = self.height();
        let w = self.width();
        if h == 0 || w == 0 {
            return;
        }
        for row in self.rows.iter_mut() {
            for c in 0..cols.min(w) {
                row[c] = fill;
            }
            if cols <= w {
                row.rotate_left(cols);
            }
        }
    }

    /// Shifts all columns down by `rows`, filling new cells with `fill`.
    pub fn shift_down(&mut self, rows: usize, fill: Cell) {
        let h = self.height();
        if h == 0 {
            return;
        }
        if rows <= h {
            self.rows.rotate_right(rows);
        }
        for r in 0..rows.min(h) {
            self.rows[r] = vec![fill; self.width()];
        }
    }

    /// Shifts all columns up by `rows`, filling vacated cells with `fill`.
    pub fn shift_up(&mut self, rows: usize, fill: Cell) {
        let h = self.height();
        if h == 0 {
            return;
        }
        for r in 0..rows.min(h) {
            self.rows[r] = vec![fill; self.width()];
        }
        if rows <= h {
            self.rows.rotate_left(rows);
        }
    }

    /// Fills a rectangular area defined by column and row iterators with `new` cell.
    pub fn fill_area<C, R>(&mut self, columns: C, rows: R, new: Cell)
    where
        C: IntoIterator<Item = usize>,
        R: IntoIterator<Item = usize>,
    {
        let rows_vec: Vec<usize> = rows.into_iter().collect();
        for column in columns {
            for &row in &rows_vec {
                self.set(column, row, new);
            }
        }
    }

    /// Sets the cell at (column, row) to `new`.
    pub fn set(&mut self, column: usize, row: usize, new: Cell) {
        if column < self.width() && row < self.height() {
            let old = self.rows[row][column];
            self.rows[row][column] = new;
            self.adjust_color(old, new);
        }
    }

    /// Gets the cell at (column, row), returning `default` if out of bounds.
    pub fn get(&self, column: usize, row: usize, default: Cell) -> Cell {
        if column < self.width() && row < self.height() {
            self.rows[row][column]
        } else {
            default
        }
    }

    /// Adjusts frame size to at least `width` and `height`, filling new cells with `fill`.
    pub fn adjust(&mut self, width: usize, height: usize, fill: Cell) {
        self.adjust_width(width, fill);
        self.adjust_height(height, fill);
    }

    /// Adjusts frame width to at least `width`.
    pub fn adjust_width(&mut self, width: usize, fill: Cell) {
        if width > self.width() {
            self.resize_width(width, fill);
        }
    }

    /// Adjusts frame height to at least `height`.
    pub fn adjust_height(&mut self, height: usize, fill: Cell) {
        if height > self.height() {
            self.resize_height(height, fill);
        }
    }

    /// Resizes frame to exact `width` and `height`, filling new cells with `fill`.
    pub fn resize(&mut self, width: usize, height: usize, fill: Cell) {
        self.resize_width(width, fill);
        self.resize_height(height, fill);
    }

    /// Resizes width to exact `width`.
    pub fn resize_width(&mut self, width: usize, fill: Cell) {
        if self.width() != width {
            for row in &mut self.rows {
                row.resize(width, fill);
            }
            self.width = width;
        }
    }

    /// Resizes height to exact `height`.
    pub fn resize_height(&mut self, height: usize, fill: Cell) {
        if self.height() != height {
            let fill_row = vec![fill; self.width()];
            self.rows.resize(height, fill_row);
        }
    }

    /// Checks if the frame contains the given cell.
    pub fn contains(&self, cell: Cell) -> bool {
        for row in &self.rows {
            for c in row {
                if *c == cell {
                    return true;
                }
            }
        }
        false
    }

    /// Checks if the frame contains the given text character.
    pub fn contains_text(&self, ch: Char) -> bool {
        for row in &self.rows {
            for c in row {
                if c.text == ch {
                    return true;
                }
            }
        }
        false
    }

    /// Checks if the frame contains the given color character.
    pub fn contains_color(&self, col: Char) -> bool {
        for row in &self.rows {
            for c in row {
                if c.color == Some(col) {
                    return true;
                }
            }
        }
        false
    }

    /// Clears the frame: sets all text to space and color to default.
    pub fn clean(&mut self) {
        let color = if self.color() { Some(UNDERSCORE) } else { None };
        self.fill(Cell { text: SPACE, color });
    }

    /// Fills the entire frame with the given cell.
    pub fn fill(&mut self, fill: Cell) {
        self.color = if fill.color() {
            self.width() * self.height()
        } else {
            0
        };
        for row in &mut self.rows {
            for cell in row {
                *cell = fill
            }
        }
    }

    /// Fills all text cells with the given character.
    pub fn fill_text(&mut self, fill: Char) {
        for row in &mut self.rows {
            for cell in row {
                cell.text = fill
            }
        }
    }

    /// Fills all color cells with the given character (or None).
    pub fn fill_color(&mut self, fill: Option<Char>) {
        self.color = if fill == None {
            0
        } else {
            self.width() * self.height()
        };
        for row in &mut self.rows {
            for cell in row {
                cell.color = fill
            }
        }
    }

    fn adjust_color(&mut self, old: Cell, new: Cell) {
        match (old.color(), new.color()) {
            (true, true) => {}
            (true, false) => self.color -= 1,
            (false, true) => self.color += 1,
            (false, false) => {}
        }
    }

    /// Prints text to frame.
    pub fn print(&mut self, col: usize, row: usize, line: &str, color: Option<Option<Char>>) {
        let mut col = col;
        for char in line.chars() {
            if let Ok(char) = Char::new(char) {
                let mut cell = self.get(col, row, Cell::default());
                cell.text = char;
                if let Some(color) = color {
                    cell.color = color;
                }
                self.set(col, row, cell);
                col += 1;
            }
        }
    }

    /// Renders the frame as ANSI escape sequences.
    pub fn ansi(&self, palette: &Palette, color: bool) -> String {
        let mut acum = String::new();
        for r in 0..self.height() {
            let row = &self.rows[r];
            if color {
                let mut prev_col: Option<ColorPair> = None;
                for cell in row {
                    let c = cell.to_pair(palette);
                    let ansi = c.to_ansi_rel(&prev_col);
                    if ansi != "" {
                        acum += ansi.as_str();
                    }
                    prev_col = Some(c);
                    acum.push(cell.text.into());
                }
            } else {
                for cell in row {
                    acum.push(cell.text.into());
                }
            }
            if color {
                acum += &ColorPair::default().to_ansi();
            }
            if r + 1 < self.height() {
                acum += "\n";
            }
        }
        acum
    }

    /// Creates a new frame of given dimensions filled with `fill`.
    pub fn new(width: usize, height: usize, fill: Cell) -> Self {
        Self {
            color: if fill.color() { width * height } else { 0 },
            width,
            rows: vec![vec![fill; width]; height],
        }
    }

    /// Formats the frame's text channel.
    pub fn fmt_text(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        for row in &self.rows {
            let mut acum = String::new();
            for cell in row {
                acum.push(cell.text.into());
            }
            writeln!(f, "{}", acum)?;
        }
        Ok(())
    }

    /// Formats the frame's color channel.
    pub fn fmt_colors(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        for row in &self.rows {
            let mut acum = String::new();
            for cell in row {
                acum.push(cell.color.unwrap_or(UNDERSCORE).into());
            }
            writeln!(f, "{}", acum)?;
        }
        Ok(())
    }

    /// Formats both text and color channels concatenated.
    pub fn fmt_both(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        for row in &self.rows {
            let mut acum = String::new();
            for cell in row {
                acum.push(cell.text.into());
            }
            for cell in row {
                acum.push(cell.color.unwrap_or(UNDERSCORE).into());
            }
            writeln!(f, "{}", acum)?;
        }
        Ok(())
    }

    /// Formats the frame with optional color inclusion.
    pub fn fmt_with_colors(
        &self,
        f: &mut std::fmt::Formatter<'_>,
        colors: Option<bool>,
    ) -> std::fmt::Result {
        if let Some(false) = colors {
            self.fmt_text(f)
        } else {
            self.fmt_both(f)
        }
    }
    pub(crate) fn recalc_colors(&mut self) {
        self.color = 0;
        for row in &self.rows {
            for cell in row {
                if cell.color() {
                    self.color += 1;
                }
            }
        }
    }
}

/// Displays the frame in combined text+color format.
impl fmt::Display for Frame {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.fmt_both(f)
    }
}

/// A collection of frames forming an animation, with optional pinned channels.
#[derive(Default, Debug, Clone)]
pub struct Frames {
    pub(crate) text_pin: Option<Frame>,
    pub(crate) color_pin: Option<Frame>,
    pub(crate) width: usize,
    pub(crate) height: usize,
    pub(crate) frames: Vec<Frame>,
}

impl Frames {
    /// Creates a new set of `frames` frames with given dimensions, each filled with `fill`.
    pub fn new(frames: usize, width: usize, height: usize, fill: Cell) -> Self {
        let mut ret = Self {
            text_pin: None,
            color_pin: None,
            width,
            height,
            frames: Vec::with_capacity(frames),
        };
        (0..frames).for_each(|_| {
            ret.frames.push(Frame::new(width, height, fill));
        });
        ret
    }

    /// Rotate frames foth
    pub fn rot_forth(&mut self, k: usize) {
        self.frames.rotate_right(k);
    }

    /// Rotate frames back
    pub fn rot_back(&mut self, k: usize) {
        self.frames.rotate_left(k);
    }

    /// Deduplicate frames
    pub fn dedup(&mut self) {
        self.frames.dedup();
    }

    /// Reverse frames
    pub fn reverse(&mut self) {
        self.frames.reverse();
    }

    /// Swap two frames
    pub fn swap(&mut self, a: usize, b: usize) {
        if a < self.frames.len() && b < self.frames.len() {
            self.frames.swap(a, b);
        }
    }

    /// Remove all frames out of inclusive subrange
    pub fn slice(&mut self, from: usize, to: usize) {
        let to = in_range(to, 0, self.frames());
        let from = from.min(to);
        self.frames.truncate(to + 1); // discard everything after `to`
        self.frames.drain(..from); // discard everything before `from`
    }

    /// Crop frames
    pub fn crop(&mut self, r_from: usize, r_to: usize, c_from: usize, c_to: usize) {
        if r_to >= self.height() {
            self.adjust_height(r_to + 1, Cell::default());
        }
        if c_to >= self.width() {
            self.adjust_width(c_to + 1, Cell::default());
        }
        let r_to = in_range(r_to, 0, self.height());
        let r_from = r_from.min(r_to);
        let c_to = in_range(c_to, 0, self.width());
        let c_from = c_from.min(c_to);

        for frame in &mut self.frames {
            frame.crop(r_from, r_to, c_from, c_to);
        }

        self.width = c_to - c_from + 1;
        self.height = r_to - r_from + 1;
    }

    pub fn remove_color(&mut self, color: Char) {
        for frame in &mut self.frames {
            frame.remove_color(color);
        }
    }

    /// Sets a cell in a specific frame.
    pub fn set(&mut self, frame: usize, column: usize, row: usize, new: Cell) {
        if frame < self.frames() {
            self.frames[frame].set(column, row, new);
        }
    }

    /// Gets a cell from a specific frame, with default if out of bounds.
    pub fn get(&self, frame: usize, column: usize, row: usize, default: Cell) -> Cell {
        if frame < self.frames() {
            self.frames[frame].get(column, row, default)
        } else {
            default
        }
    }

    /// Ensures that the given frame index exists, extending if necessary.
    pub fn make_sure_frame_exist(&mut self, frame: usize) {
        if frame >= self.frames() {
            if self.frames() == 0 {
                for _ in 0..frame + 1 {
                    self.frames
                        .push(Frame::new(self.width, self.height, Cell::default()));
                }
            } else {
                for _ in 0..(frame + 1 - self.frames()) {
                    self.frames.push(self.frames.last().unwrap().clone());
                }
            }
        }
    }

    /// Duplicates the given frame, inserting the copy before it.
    pub fn dup_frame(&mut self, frame: usize) {
        self.make_sure_frame_exist(frame);
        self.frames.insert(frame, self.frames[frame].clone());
    }

    /// Shifts a specific frame right.
    pub fn shift_right_frame(&mut self, frame: usize, cols: usize, fill: Cell) {
        if frame < self.frames() {
            self.frames[frame].shift_right(cols, fill);
        }
    }

    /// Shifts all frames right.
    pub fn shift_right(&mut self, cols: usize, fill: Cell) {
        for frame in self.frames.iter_mut() {
            frame.shift_right(cols, fill);
        }
    }

    /// Shifts a specific frame left.
    pub fn shift_left_frame(&mut self, frame: usize, cols: usize, fill: Cell) {
        if frame < self.frames() {
            self.frames[frame].shift_left(cols, fill);
        }
    }

    /// Shifts all frames left.
    pub fn shift_left(&mut self, cols: usize, fill: Cell) {
        for frame in self.frames.iter_mut() {
            frame.shift_left(cols, fill);
        }
    }

    /// Shifts a specific frame up.
    pub fn shift_up_frame(&mut self, frame: usize, rows: usize, fill: Cell) {
        if frame < self.frames() {
            self.frames[frame].shift_up(rows, fill);
        }
    }

    /// Shifts all frames up.
    pub fn shift_up(&mut self, rows: usize, fill: Cell) {
        for frame in self.frames.iter_mut() {
            frame.shift_up(rows, fill);
        }
    }

    /// Shifts a specific frame down.
    pub fn shift_down_frame(&mut self, frame: usize, rows: usize, fill: Cell) {
        if frame < self.frames() {
            self.frames[frame].shift_down(rows, fill);
        }
    }

    /// Shifts all frames down.
    pub fn shift_down(&mut self, rows: usize, fill: Cell) {
        for frame in self.frames.iter_mut() {
            frame.shift_down(rows, fill);
        }
    }

    /// Fills an area in a specific frame.
    pub fn fill_area_frame<C, R>(&mut self, frame: usize, columns: C, rows: R, new: Cell)
    where
        C: IntoIterator<Item = usize>,
        R: IntoIterator<Item = usize>,
    {
        self.frames[frame].fill_area(columns, rows, new);
    }

    /// Fills an area in all frames.
    pub fn fill_area<C, R>(&mut self, columns: C, rows: R, new: Cell)
    where
        C: IntoIterator<Item = usize>,
        R: IntoIterator<Item = usize>,
    {
        let columns_vec: Vec<usize> = columns.into_iter().collect();
        let rows_vec: Vec<usize> = rows.into_iter().collect();
        for frame in self.frames.iter_mut() {
            frame.fill_area(columns_vec.clone(), rows_vec.clone(), new);
        }
    }

    /// Adjusts all frames to at least `width` and `height`.
    pub fn adjust(&mut self, width: usize, height: usize, fill: Cell) {
        for frame in self.frames.iter_mut() {
            frame.adjust(width, height, fill);
        }
        self.width = width;
        self.height = height;
    }

    /// Adjusts width of all frames.
    pub fn adjust_width(&mut self, width: usize, fill: Cell) {
        for frame in self.frames.iter_mut() {
            frame.adjust_width(width, fill);
        }
        self.width = width;
    }

    /// Adjusts height of all frames.
    pub fn adjust_height(&mut self, height: usize, fill: Cell) {
        for frame in self.frames.iter_mut() {
            frame.adjust_height(height, fill);
        }
        self.height = height;
    }

    /// Resizes all frames to exact dimensions.
    pub fn resize(&mut self, width: usize, height: usize, fill: Cell) {
        for frame in self.frames.iter_mut() {
            frame.resize(width, height, fill);
        }
        self.width = width;
        self.height = height;
    }

    /// Resizes width of all frames.
    pub fn resize_width(&mut self, width: usize, fill: Cell) {
        for frame in self.frames.iter_mut() {
            frame.resize_width(width, fill);
        }
        self.width = width;
    }

    /// Resizes height of all frames.
    pub fn resize_height(&mut self, height: usize, fill: Cell) {
        for frame in self.frames.iter_mut() {
            frame.resize_height(height, fill);
        }
        self.height = height;
    }

    /// Clears all frames (text to space, color to underscore if any).
    pub fn clean(&mut self) {
        for frame in self.frames.iter_mut() {
            frame.clean();
        }
    }

    /// Clears a specific frame.
    pub fn clean_frame(&mut self, frame: usize) {
        if frame < self.frames() {
            self.frames[frame].clean();
        }
    }

    /// Fills all frames with the given cell.
    pub fn fill(&mut self, fill: Cell) {
        for frame in self.frames.iter_mut() {
            frame.fill(fill);
        }
    }

    /// Fills a specific frame with the given cell.
    pub fn fill_frame(&mut self, frame: usize, fill: Cell) {
        if frame < self.frames() {
            self.frames[frame].fill(fill);
        }
    }

    /// Fills text of all frames with the given character.
    pub fn fill_text(&mut self, fill: Char) {
        for frame in self.frames.iter_mut() {
            frame.fill_text(fill);
        }
    }

    /// Fills text of a specific frame with the given character.
    pub fn fill_text_frame(&mut self, frame: usize, fill: Char) {
        if frame < self.frames() {
            self.frames[frame].fill_text(fill);
        }
    }

    /// Fills color of all frames with the given character (or None).
    pub fn fill_color(&mut self, fill: Option<Char>) {
        for frame in self.frames.iter_mut() {
            frame.fill_color(fill);
        }
    }

    /// Fills color of a specific frame with the given character (or None).
    pub fn fill_color_frame(&mut self, frame: usize, fill: Option<Char>) {
        if frame < self.frames() {
            self.frames[frame].fill_color(fill);
        }
    }

    /// Prints text to specific frame.
    pub fn print(
        &mut self,
        frame: usize,
        col: usize,
        row: usize,
        line: &str,
        color: Option<Option<Char>>,
    ) {
        if frame < self.frames() {
            self.frames[frame].print(col, row, line, color);
        }
    }

    /// Removes a specific frame.
    pub fn remove_frame(&mut self, frame: usize) {
        if frame < self.frames.len() {
            self.frames.remove(frame);
        }
    }

    /// Checks if any frame contains the given cell.
    pub fn contains(&self, cell: Cell) -> bool {
        for frame in &self.frames {
            if frame.contains(cell) {
                return true;
            }
        }
        false
    }

    /// Checks if any frame contains the given color character.
    pub fn contains_color(&self, name: Char) -> bool {
        for frame in &self.frames {
            if frame.contains_color(name) {
                return true;
            }
        }
        false
    }

    /// Checks if any frame contains the given text character.
    pub fn contains_text(&self, ch: Char) -> bool {
        for frame in &self.frames {
            if frame.contains_color(ch) {
                return true;
            }
        }
        false
    }

    /// Pins the color channel from the given frame to all frames.
    pub fn pin_color(&mut self, frame: usize) -> Result<()> {
        if frame >= self.frames.len() {
            return Ok(());
        }
        self.color_pin = Some(self.frames[frame].clone());
        self.merge()
    }

    /// Pins the text channel from the given frame to all frames.
    pub fn pin_text(&mut self, frame: usize) -> Result<()> {
        if frame >= self.frames.len() {
            return Ok(());
        }
        self.text_pin = Some(self.frames[frame].clone());
        self.merge()
    }

    /// Returns a vector frames converted to text with ANCI escape codes.
    pub fn to_ansi_frames(&self, palette: &Palette, color: bool) -> Vec<String> {
        let mut frames = Vec::new();
        for frame in &self.frames {
            frames.push(frame.ansi(palette, color));
        }
        frames
    }

    /// Returns the number of frames.
    pub fn frames(&self) -> usize {
        self.frames.len()
    }

    /// Returns the width of the frames.
    pub fn width(&self) -> usize {
        self.width
    }

    /// Returns the height of the frames.
    pub fn height(&self) -> usize {
        self.height
    }

    /// Returns true if any frame contains color.
    pub fn color(&self) -> bool {
        for frame in &self.frames {
            if frame.color() {
                return true;
            }
        }
        false
    }

    /// Returns whether text and color are pinned across frames.
    pub fn pinned(&self) -> (bool, bool) {
        if self.frames.len() < 2 {
            return (false, false);
        }
        let mut text_pinned = true;
        let mut color_pinned = true;
        for c in 0..self.width {
            for r in 0..self.height {
                let mut last_text: Option<Char> = None;
                let mut last_color: Option<Option<Char>> = None;
                for frame in &self.frames {
                    let cell = frame.rows[r][c];
                    if let Some(last_text) = last_text {
                        if last_text != cell.text {
                            text_pinned = false;
                        }
                    }
                    last_text = Some(cell.text);
                    if let Some(last_color) = last_color {
                        if last_color != cell.color {
                            color_pinned = false;
                        }
                    }
                    last_color = Some(cell.color);
                    if !text_pinned && !color_pinned {
                        return (false, false);
                    }
                }
            }
        }
        (text_pinned, color_pinned)
    }

    /// Computes total duration from delays.
    pub fn duration(&self, delays: &Delay) -> usize {
        let mut dur = 0;
        for f in 0..self.frames() {
            dur += delays.get_frame(f);
        }
        dur
    }

    /// Generates an animated SVG from all frames.
    pub fn to_svg_frames(
        &self,
        colors: bool,
        palette: &Palette,
        map: &CSSColorMap,
        font: &Font,
        delays: &Delay,
    ) -> String {
        let delays = delays.to_vec_delays(self.frames());
        let (total_s, key_times, delays) = timing_for_svg(&delays);
        let mut svg = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n".into();
        let width = self.width() * font.width;
        let height = self.height() * font.height;
        svg += format!(
            "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"{}\" height=\"{}\" viewBox=\"0 0 {} {}\" role=\"img\">\n",
            width, height, width, height
        )
        .as_str();
        svg += font.to_style().as_str();
        if colors {
            svg += format!(
                "<rect x=\"0\"  y=\"0\"  width=\"{}\" height=\"{}\" fill=\"{}\"/>\n",
                width,
                height,
                map.map(Color::None, false)
            )
            .as_str();
        }
        svg += "\n";
        let (_, color_pinned) = self.pinned();
        if colors && self.color() && color_pinned {
            svg += self.frames[0].to_svg_frame_bg(palette, map, font).as_str();
            for f in 0..self.frames() {
                svg += "<g opacity=\"0\">\n";
                svg += self.frames[f]
                    .to_svg_frame_txt_fg(palette, map, font)
                    .as_str();
                svg += format!(
                "<animate attributeName=\"opacity\" begin=\"0s\" dur=\"{}s\" repeatCount=\"indefinite\" calcMode=\"discrete\" values=\"{}\" keyTimes=\"{}\" />\n",
                total_s, delays[f], key_times
            )
            .as_str();
                svg += "</g>\n\n";
            }
        } else {
            for f in 0..self.frames() {
                svg += "<g opacity=\"0\">\n";
                svg += self.frames[f]
                    .to_svg_frame(colors, palette, map, font)
                    .as_str();
                svg += format!(
                "<animate attributeName=\"opacity\" begin=\"0s\" dur=\"{}s\" repeatCount=\"indefinite\" calcMode=\"discrete\" values=\"{}\" keyTimes=\"{}\" />\n",
                total_s, delays[f], key_times
            )
            .as_str();
                svg += "</g>\n\n";
            }
        }
        svg += "</svg>\n";
        svg
    }
}

impl Frames {
    pub(crate) fn read_text_pin<R: Read>(
        &mut self,
        lines: &mut io::Lines<BufReader<R>>,
    ) -> Result<()> {
        if self.text_pin != None {
            return Err(Error::BlockDup("text-pin".into()));
        }
        let frame = Frame::read_text(lines)?;
        if frame.width() != 0 && frame.height() != 0 {
            self.text_pin = Some(frame)
        }
        Ok(())
    }
    pub(crate) fn read_color_pin<R: Read>(
        &mut self,
        lines: &mut io::Lines<BufReader<R>>,
    ) -> Result<()> {
        if self.color_pin != None {
            return Err(Error::BlockDup("color-pin".into()));
        }
        let frame = Frame::read_color(lines)?;
        if frame.width() != 0 && frame.height() != 0 {
            self.color_pin = Some(frame)
        }
        Ok(())
    }

    pub(crate) fn merge(&mut self) -> Result<()> {
        if let Some(color_pin) = &self.color_pin {
            for i in 0..self.frames.len() {
                self.frames[i] = merge_frames(&self.frames[i], &color_pin)?;
            }
        }
        if let Some(text_pin) = &self.text_pin {
            for i in 0..self.frames.len() {
                self.frames[i] = merge_frames(&text_pin, &self.frames[i])?;
            }
        }
        self.color_pin = None;
        self.text_pin = None;
        Ok(())
    }

    pub(crate) fn check_frame(&mut self, frame: &Frame) -> Result<()> {
        if self.width != 0 && self.width != frame.width() {
            return Err(Error::WidthMismatch);
        }
        if self.height != 0 && self.height != frame.height() {
            return Err(Error::HeightMismatch);
        }
        self.width = frame.width();
        self.height = frame.height();
        Ok(())
    }

    pub(crate) fn read_body<R: Read>(
        &mut self,
        lines: &mut io::Lines<BufReader<R>>,
        header: &Header,
    ) -> Result<()> {
        if !header.get_colors() {
            self.read_body_text(lines)
        } else if self.color_pin != None {
            self.read_body_text(lines)
        } else if self.text_pin != None {
            self.read_body_color(lines)
        } else {
            self.read_body_both(lines)
        }
    }

    pub(crate) fn read_body_both<R: Read>(
        &mut self,
        lines: &mut io::Lines<BufReader<R>>,
    ) -> Result<()> {
        loop {
            let frame = Frame::read_both(lines)?;
            if frame.width() == 0 || frame.height() == 0 {
                break;
            }
            self.check_frame(&frame)?;
            self.frames.push(frame);
        }
        self.merge()
    }

    pub(crate) fn read_body_text<R: Read>(
        &mut self,
        lines: &mut io::Lines<BufReader<R>>,
    ) -> Result<()> {
        loop {
            let frame = Frame::read_text(lines)?;
            if frame.width() == 0 || frame.height() == 0 {
                break;
            }
            self.check_frame(&frame)?;
            self.frames.push(frame);
        }
        self.merge()
    }

    pub(crate) fn read_body_color<R: Read>(
        &mut self,
        lines: &mut io::Lines<BufReader<R>>,
    ) -> Result<()> {
        loop {
            let frame = Frame::read_color(lines)?;
            if frame.width() == 0 || frame.height() == 0 {
                break;
            }
            self.check_frame(&frame)?;
            self.frames.push(frame);
        }
        self.merge()
    }

    pub(crate) fn read_legacy<R: Read>(
        info: LegacyHeaderInfo,
        lines: &mut io::Lines<BufReader<R>>,
    ) -> Result<Self> {
        let mut frames = Self {
            width: info.width,
            height: info.height,
            text_pin: None,
            color_pin: None,
            frames: Vec::new(),
        };
        let mut frame: Frame = Frame {
            color: 0,
            width: info.width,
            rows: Vec::new(),
        };
        let mut row: Vec<Cell> = Vec::new();
        let mut fg_len: usize = 0;
        let mut bg_len: usize = 0;
        let mut mode = LegacyScanMode::Text;

        for line in lines {
            let mut comment = false;
            let line = line?;
            let line = match line.split_once("\t") {
                Some((a, _)) => {
                    if a.is_empty() {
                        continue;
                    }
                    a
                }
                None => &line,
            };
            let line = normalize_text(line);
            if line.is_empty() {
                continue;
            }
            for c in line.chars() {
                if comment {
                    continue;
                } else if c == '\t' {
                    comment = true;
                    continue;
                }

                match mode {
                    LegacyScanMode::Text => {
                        row.push(Cell {
                            text: Char::new_must(c),
                            color: None,
                        });
                        if row.len() == info.width {
                            mode = mode.next(info.colors);
                            if info.colors == LegacyColorMode::None {
                                frame.rows.push(row);
                                row = Vec::new();
                            }
                        }
                    }
                    LegacyScanMode::Fg => {
                        row[fg_len].color = Some(Char::new_must(trans_color(c)));
                        fg_len += 1;
                        frame.color += 1;
                        if fg_len == info.width {
                            mode = mode.next(info.colors);
                            fg_len = 0;
                            if info.colors == LegacyColorMode::FgOnly {
                                frame.rows.push(row);
                                row = Vec::new();
                            }
                        }
                    }
                    LegacyScanMode::Bg => {
                        bg_len += 1;
                        if bg_len == info.width {
                            mode = mode.next(info.colors);
                            bg_len = 0;
                            if info.colors == LegacyColorMode::BgOnly
                                || info.colors == LegacyColorMode::FgAndBg
                            {
                                frame.rows.push(row);
                                row = Vec::new();
                            }
                        }
                    }
                }
                if frame.rows.len() == info.height {
                    frames.frames.push(frame);
                    frame = Frame {
                        color: 0,
                        width: info.width,
                        rows: Vec::new(),
                    };
                }
            }
        }

        Ok(frames)
    }

    /// Formats the body with only text channels.
    pub fn fmt_body_text(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        writeln!(f, "@body")?;
        for frame in &self.frames {
            frame.fmt_text(f)?;
            writeln!(f, "")?;
        }
        Ok(())
    }

    /// Formats the body with only color channels.
    pub fn fmt_body_colors(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        writeln!(f, "@body")?;
        for frame in &self.frames {
            frame.fmt_colors(f)?;
            writeln!(f, "")?;
        }
        Ok(())
    }

    /// Formats the body with combined text+color channels.
    pub fn fmt_body_both(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        writeln!(f, "@body")?;
        for frame in &self.frames {
            frame.fmt_both(f)?;
            writeln!(f, "")?;
        }
        Ok(())
    }

    /// Formats the pinned text channel.
    pub fn fmt_pinned_text(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        writeln!(f, "@text-pin")?;
        if let Some(frame) = &self.frames.first() {
            frame.fmt_text(f)?;
            writeln!(f, "")?;
        }
        Ok(())
    }

    /// Formats the pinned color channel.
    pub fn fmt_pinned_colors(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        writeln!(f, "@color-pin")?;
        if let Some(frame) = &self.frames.first() {
            frame.fmt_colors(f)?;
            writeln!(f, "")?;
        }
        Ok(())
    }

    /// Formats with optional color inclusion, using pins if possible.
    pub fn fmt_with_color(&self, f: &mut std::fmt::Formatter<'_>, color: bool) -> std::fmt::Result {
        if color {
            let (text_pinned, colors_pinned) = self.pinned();
            if colors_pinned {
                self.fmt_pinned_colors(f)?;
                self.fmt_body_text(f)
            } else if text_pinned {
                self.fmt_pinned_text(f)?;
                self.fmt_body_colors(f)
            } else {
                self.fmt_body_both(f)
            }
        } else {
            self.fmt_body_text(f)
        }
    }
}

/// Displays the frames using optimal format (with pins if possible).
impl fmt::Display for Frames {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.fmt_with_color(f, self.color())
    }
}

#[derive(Debug, Clone, Copy)]
pub(crate) enum LegacyScanMode {
    Text,
    Fg,
    Bg,
}

impl LegacyScanMode {
    fn next(self, cm: LegacyColorMode) -> Self {
        match (self, cm) {
            (Self::Text, LegacyColorMode::None) => Self::Text,
            (Self::Text, LegacyColorMode::FgOnly) => Self::Fg,
            (Self::Text, LegacyColorMode::BgOnly) => Self::Bg,
            (Self::Text, LegacyColorMode::FgAndBg) => Self::Fg,
            (Self::Fg, LegacyColorMode::FgAndBg) => Self::Bg,
            (Self::Fg, _) => Self::Text,
            (Self::Bg, _) => Self::Text,
        }
    }
}