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
//! QuickTime Animation (`rle `) 8-bit decoder, pure Rust.
//!
//! Each frame updates a contiguous band of scanlines (`startLine`..`+numLines`)
//! of a persistent indexed frame; skipped lines and skipped pixels keep their
//! previous values, so the decoder retains its frame buffer between calls.
//!
//! QuickTime RLE processes 8-bit images in units of **four** pixels: skip
//! counts and run/literal lengths are all multiplied by four. Per line, an
//! initial skip byte is followed by opcodes until a `-1` terminator: `0` =
//! another skip, negative = a 4-pixel group repeated `-code` times, positive =
//! `code` literal 4-pixel groups.
//!
//! Behavioural reference: FFmpeg `qtrle.c` (reimplemented from the format).
/// Persistent QuickTime Animation decoder producing 8-bit palette indices.
#[derive(Clone, Debug)]
pub(crate) struct QtRleDecoder {
width: usize,
height: usize,
/// Reconstructed frame as palette indices, one byte per pixel.
indices: Vec<u8>,
}
impl QtRleDecoder {
pub(crate) fn new(width: usize, height: usize) -> Self {
Self {
width,
height,
indices: vec![0; width.saturating_mul(height)],
}
}
/// Decode one sample and return the reconstructed indexed frame
/// (`width * height` bytes). Inter frames composite onto the prior frame.
pub(crate) fn decode(&mut self, data: &[u8]) -> Result<&[u8], &'static str> {
if self.width == 0 || self.height == 0 {
return Err("qtrle: zero dimensions");
}
if data.len() < 8 {
return Err("qtrle: frame too short");
}
let header = u16::from_be_bytes([data[4], data[5]]);
let (start_line, num_lines, mut p) = if header & 0x0008 != 0 {
if data.len() < 14 {
return Err("qtrle: truncated header");
}
let start = u16::from_be_bytes([data[6], data[7]]) as usize;
let lines = u16::from_be_bytes([data[10], data[11]]) as usize;
(start, lines, 14usize)
} else {
(0usize, self.height, 6usize)
};
let w = self.width;
let end = data.len();
let get = |p: &mut usize| -> Option<u8> {
if *p >= end {
None
} else {
let b = data[*p];
*p += 1;
Some(b)
}
};
let mut row = start_line;
for _ in 0..num_lines {
if row >= self.height {
break;
}
let row_base = row * w;
let mut x: isize = 0;
// Initial per-line skip.
let Some(skip) = get(&mut p) else { break };
x += (skip as isize - 1) * 4;
loop {
let Some(code) = get(&mut p) else { break };
if code == 0xFF {
break; // -1: end of line
}
let code = code as i8;
if code == 0 {
// Additional skip.
let Some(skip) = get(&mut p) else { break };
x += (skip as isize - 1) * 4;
} else if code < 0 {
// A single 4-pixel group repeated (-code) times.
let count = (-(code as isize)) as usize;
let (Some(a), Some(b), Some(c), Some(d)) =
(get(&mut p), get(&mut p), get(&mut p), get(&mut p))
else {
break;
};
let group = [a, b, c, d];
for _ in 0..count {
for &v in &group {
if x >= 0 && (x as usize) < w {
self.indices[row_base + x as usize] = v;
}
x += 1;
}
}
} else {
// `code` literal 4-pixel groups.
for _ in 0..code as usize {
for _ in 0..4 {
let Some(v) = get(&mut p) else { break };
if x >= 0 && (x as usize) < w {
self.indices[row_base + x as usize] = v;
}
x += 1;
}
}
}
}
row += 1;
}
Ok(&self.indices)
}
}
/// Persistent QuickTime Animation decoder producing 16-bit RGB555 pixels.
#[derive(Clone, Debug)]
pub(crate) struct QtRle16Decoder {
width: usize,
height: usize,
/// Reconstructed frame as RGB555 words.
pixels: Vec<u16>,
}
impl QtRle16Decoder {
pub(crate) fn new(width: usize, height: usize) -> Self {
Self {
width,
height,
pixels: vec![0; width.saturating_mul(height)],
}
}
/// Decode one sample and return the reconstructed frame (RGB555).
pub(crate) fn decode(&mut self, data: &[u8]) -> Result<&[u16], &'static str> {
if self.width == 0 || self.height == 0 {
return Err("qtrle: zero dimensions");
}
if data.len() < 8 {
return Err("qtrle: frame too short");
}
let header = u16::from_be_bytes([data[4], data[5]]);
let (start_line, num_lines, mut p) = if header & 0x0008 != 0 {
if data.len() < 14 {
return Err("qtrle: truncated header");
}
let start = u16::from_be_bytes([data[6], data[7]]) as usize;
let lines = u16::from_be_bytes([data[10], data[11]]) as usize;
(start, lines, 14usize)
} else {
(0usize, self.height, 6usize)
};
let w = self.width;
let end = data.len();
let get = |p: &mut usize| -> Option<u8> {
if *p >= end {
None
} else {
let b = data[*p];
*p += 1;
Some(b)
}
};
let get_u16 = |p: &mut usize| -> Option<u16> {
if *p + 2 > end {
None
} else {
let val = u16::from_be_bytes([data[*p], data[*p + 1]]);
*p += 2;
Some(val)
}
};
let mut row = start_line;
for _ in 0..num_lines {
if row >= self.height {
break;
}
let row_base = row * w;
let mut x: isize = 0;
// Initial per-line skip (pixels, not groups of 4).
let Some(skip) = get(&mut p) else { break };
x += (skip as isize) - 1;
loop {
let Some(code) = get(&mut p) else { break };
if code == 0xFF {
break; // -1: end of line
}
let code = code as i8;
if code == 0 {
// Additional skip.
let Some(skip) = get(&mut p) else { break };
x += (skip as isize) - 1;
} else if code < 0 {
// A single 16-bit RGB555 pixel repeated (-code) times.
let count = (-(code as isize)) as usize;
let Some(pixel) = get_u16(&mut p) else { break };
for _ in 0..count {
if x >= 0 && (x as usize) < w {
self.pixels[row_base + x as usize] = pixel;
}
x += 1;
}
} else {
// `code` literal 16-bit RGB555 pixels.
for _ in 0..code as usize {
let Some(pixel) = get_u16(&mut p) else { break };
if x >= 0 && (x as usize) < w {
self.pixels[row_base + x as usize] = pixel;
}
x += 1;
}
}
}
row += 1;
}
Ok(&self.pixels)
}
}
#[cfg(test)]
mod tests {
use super::*;
/// Build an rle sample with a full-frame (flag 8) header and a raw line
/// body. `body` is the per-line opcode stream.
fn sample(start_line: u16, num_lines: u16, body: &[u8]) -> Vec<u8> {
let mut v = Vec::new();
let size = 14 + body.len();
v.extend_from_slice(&(size as u32).to_be_bytes());
v.extend_from_slice(&0x0008u16.to_be_bytes()); // flag: lines present
v.extend_from_slice(&start_line.to_be_bytes());
v.extend_from_slice(&0u16.to_be_bytes());
v.extend_from_slice(&num_lines.to_be_bytes());
v.extend_from_slice(&0u16.to_be_bytes());
v.extend_from_slice(body);
v
}
#[test]
fn literal_groups_fill_four_pixels_each() {
// 8×1 image. One line: skip=1 (no skip), code=2 (two literal groups =
// 8 pixels), then indices 10..17, then -1 terminator.
let mut body = vec![1u8, 2u8];
body.extend_from_slice(&[10, 11, 12, 13, 14, 15, 16, 17]);
body.push(0xFF);
let s = sample(0, 1, &body);
let mut dec = QtRleDecoder::new(8, 1);
let out = dec.decode(&s).expect("decode");
assert_eq!(out, &[10, 11, 12, 13, 14, 15, 16, 17]);
}
#[test]
fn negative_code_repeats_group() {
// 8×1. skip=1, code=-2 => one 4-pixel group [1,2,3,4] repeated twice.
let body = vec![1u8, (-2i8) as u8, 1, 2, 3, 4, 0xFF];
let s = sample(0, 1, &body);
let mut dec = QtRleDecoder::new(8, 1);
let out = dec.decode(&s).expect("decode");
assert_eq!(out, &[1, 2, 3, 4, 1, 2, 3, 4]);
}
#[test]
fn initial_skip_offsets_start() {
// 8×1. skip=2 => (2-1)*4 = 4 pixels skipped, then one literal group.
let mut body = vec![2u8, 1u8];
body.extend_from_slice(&[20, 21, 22, 23]);
body.push(0xFF);
let s = sample(0, 1, &body);
let mut dec = QtRleDecoder::new(8, 1);
let out = dec.decode(&s).expect("decode");
// First four pixels untouched (0), next four are the literal group.
assert_eq!(out, &[0, 0, 0, 0, 20, 21, 22, 23]);
}
#[test]
fn inter_frame_keeps_unwritten_lines() {
// Frame 0: two lines, both filled with a literal group.
let mut body0 = Vec::new();
for _ in 0..2 {
body0.push(1u8); // skip
body0.push(1u8); // one literal group
body0.extend_from_slice(&[5, 5, 5, 5]);
body0.push(0xFF);
}
let f0 = sample(0, 2, &body0);
let mut dec = QtRleDecoder::new(4, 2);
dec.decode(&f0).expect("f0");
assert_eq!(dec.indices, vec![5, 5, 5, 5, 5, 5, 5, 5]);
// Frame 1: update only line 1 (start_line=1, num_lines=1) to 9s.
let mut body1 = vec![1u8, 1u8];
body1.extend_from_slice(&[9, 9, 9, 9]);
body1.push(0xFF);
let f1 = sample(1, 1, &body1);
dec.decode(&f1).expect("f1");
// Line 0 preserved, line 1 updated.
assert_eq!(dec.indices, vec![5, 5, 5, 5, 9, 9, 9, 9]);
}
#[test]
fn rle16_literal_pixels() {
// 4×1 image. One line: skip=1 (no skip), code=2 (two literal pixels), then [0x1234, 0x5678], terminator 0xFF.
let mut body = vec![1u8, 2u8];
body.extend_from_slice(&0x1234u16.to_be_bytes());
body.extend_from_slice(&0x5678u16.to_be_bytes());
body.push(0xFF);
let s = sample(0, 1, &body);
let mut dec = QtRle16Decoder::new(4, 1);
let out = dec.decode(&s).expect("decode");
assert_eq!(out, &[0x1234, 0x5678, 0, 0]);
}
#[test]
fn rle16_negative_repeat_and_skips() {
// 6×1 image. skip=2 (skip 1), code=-2 (repeat 0x7FFF twice), code=0 (additional skip=2: skip 1), code=1 (literal 0x001F), terminator 0xFF.
let mut body = vec![2u8, (-2i8) as u8];
body.extend_from_slice(&0x7FFFu16.to_be_bytes());
body.extend_from_slice(&[0, 2, 1]);
body.extend_from_slice(&0x001Fu16.to_be_bytes());
body.push(0xFF);
let s = sample(0, 1, &body);
let mut dec = QtRle16Decoder::new(6, 1);
let out = dec.decode(&s).expect("decode");
assert_eq!(out, &[0, 0x7FFF, 0x7FFF, 0, 0x001F, 0]);
}
}