mirx 0.46.3

MIRX binary image format — flat & chunk-based container for ahead-of-time UI assets
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

use super::*;

#[cfg(any(
    target_arch = "x86_64",
    target_arch = "aarch64",
    target_arch = "wasm32"
))]
use alloc::{vec, vec::Vec};

#[test]
fn profile_identity_and_bounds_are_exact() {
    let codec = FrameDelta::new();
    assert_eq!(FrameDelta::from_record(codec.record()), Ok(codec));
    assert_eq!(codec.encoded_bound(0), Ok(0));
    assert_eq!(codec.encoded_bound(1), Ok(2));
    assert_eq!(codec.encoded_bound(64), Ok(65));
    assert_eq!(codec.encoded_bound(65), Ok(67));
    assert!(matches!(
        FrameDelta::from_record(CodingRecord::new(CodingId::FRAME_DELTA, 2, &[])),
        Err(FrameDeltaError::UnsupportedRevision(2))
    ));
    assert!(matches!(
        FrameDelta::from_record(CodingRecord::new(CodingId::FRAME_DELTA, 1, &[1])),
        Err(FrameDeltaError::UnexpectedParameters)
    ));
}

#[test]
fn canonical_runs_and_literals_roundtrip_wrapping_residuals() {
    let reference = [250, 1, 2, 3, 4, 5, 6];
    let current = [5, 1, 2, 9, 4, 5, 7];
    let codec = FrameDelta::new();
    let mut encoded = [0xa5; 16];
    let len = codec
        .encode_into(&reference, &current, &mut encoded)
        .unwrap();
    assert_eq!(&encoded[..len], &[0x80, 11, 1, 0x80, 6, 1, 0x80, 1]);
    assert!(encoded[len..].iter().all(|&byte| byte == 0xa5));

    let plan = codec.plan(&encoded[..len], reference.len()).unwrap();
    assert_eq!(plan.decoded_len(), current.len());
    let mut decoded = [0xa5; 9];
    assert_eq!(
        plan.decode_into(&reference, &mut decoded),
        Ok(current.len())
    );
    assert_eq!(&decoded[..current.len()], &current);
    assert_eq!(&decoded[current.len()..], &[0xa5; 2]);
}

#[test]
fn all_equal_and_long_literal_boundaries_are_deterministic() {
    let reference = [7; 260];
    let codec = FrameDelta::new();
    let mut encoded = [0xa5; 265];
    let len = codec
        .encode_into(&reference, &reference, &mut encoded)
        .unwrap();
    assert_eq!(&encoded[..len], &[PATTERN, 2, 1, 0]);

    let current = [12; 260];
    let len = codec
        .encode_into(&reference, &current, &mut encoded)
        .unwrap();
    assert_eq!(&encoded[..len], &[PATTERN, 2, 1, 5]);

    let current = core::array::from_fn::<_, 260, _>(|index| index as u8);
    let len = codec
        .encode_into(&reference, &current, &mut encoded)
        .unwrap();
    assert_eq!(len, codec.encoded_bound(current.len()).unwrap());
    let mut decoded = [0; 260];
    codec
        .plan(&encoded[..len], reference.len())
        .unwrap()
        .decode_into(&reference, &mut decoded)
        .unwrap();
    assert_eq!(decoded, current);
}

#[test]
fn repeated_channel_residuals_use_one_bounded_pattern() {
    let codec = FrameDelta::new();
    let reference = [10; 40];
    let mut current = reference;
    for pixel in current.chunks_exact_mut(4) {
        pixel[3] = 3;
    }
    let mut encoded = [0xa5; 48];
    let len = codec
        .encode_into(&reference, &current, &mut encoded)
        .unwrap();
    assert_eq!(&encoded[..len], &[PATTERN | 3, 8, 0, 0, 0, 0, 249]);
    let mut decoded = [0; 40];
    codec
        .plan(&encoded[..len], decoded.len())
        .unwrap()
        .decode_into(&reference, &mut decoded)
        .unwrap();
    assert_eq!(decoded, current);
}

#[test]
fn validated_blocks_dispatch_through_the_selected_kernel() {
    #[derive(Default)]
    struct CountingKernel {
        literals: usize,
        repeats: usize,
        patterns: usize,
    }
    impl FrameDeltaKernel for CountingKernel {
        fn add_literals(&mut self, output: &mut [u8], residuals: &[u8]) {
            self.literals += 1;
            ScalarFrameDelta.add_literals(output, residuals);
        }

        fn add_repeat(&mut self, output: &mut [u8], residual: u8) {
            self.repeats += 1;
            ScalarFrameDelta.add_repeat(output, residual);
        }

        fn add_pattern(&mut self, output: &mut [u8], residuals: &[u8]) {
            self.patterns += 1;
            ScalarFrameDelta.add_pattern(output, residuals);
        }
    }

    let input = [
        1,
        REPEAT | 1,
        3,
        LITERAL | 1,
        1,
        2,
        PATTERN | 3,
        0,
        0,
        1,
        2,
        3,
        4,
    ];
    let plan = FrameDelta::new().plan(&input, 14).unwrap();
    let mut output = [10; 14];
    let mut kernel = CountingKernel::default();
    plan.apply_with(&mut output, &mut kernel).unwrap();
    assert_eq!(
        (kernel.literals, kernel.repeats, kernel.patterns),
        (1, 1, 1)
    );
    assert_eq!(
        output,
        [10, 10, 13, 13, 11, 12, 11, 12, 13, 14, 11, 12, 13, 14]
    );
}

#[cfg(any(
    target_arch = "x86_64",
    target_arch = "aarch64",
    target_arch = "wasm32"
))]
#[test]
fn portable_and_scalar_kernels_are_bit_exact_for_every_tail_and_pattern_period() {
    for len in 0..=129 {
        let reference: Vec<_> = (0..len).map(|index| (index * 47) as u8).collect();
        let literals: Vec<_> = (0..len).map(|index| (index * 29 + 7) as u8).collect();

        let mut scalar = reference.clone();
        ScalarFrameDelta.add_literals(&mut scalar, &literals);
        let mut portable = reference.clone();
        PortableFrameDelta.add_literals(&mut portable, &literals);
        assert_eq!(portable, scalar, "literal length {len}");

        let mut scalar = reference.clone();
        ScalarFrameDelta.add_repeat(&mut scalar, 251);
        let mut portable = reference.clone();
        PortableFrameDelta.add_repeat(&mut portable, 251);
        assert_eq!(portable, scalar, "repeat length {len}");

        for period in 1..=16 {
            let residuals: Vec<_> = (0..period).map(|index| (index * 19 + 3) as u8).collect();
            let mut scalar = reference.clone();
            ScalarFrameDelta.add_pattern(&mut scalar, &residuals);
            let mut portable = reference.clone();
            PortableFrameDelta.add_pattern(&mut portable, &residuals);
            assert_eq!(portable, scalar, "pattern length {len}, period {period}");
        }
    }

    let reference = core::array::from_fn::<_, 257, _>(|index| (index * 47) as u8);
    let current = core::array::from_fn::<_, 257, _>(|index| {
        reference[index].wrapping_add([0, 7, 0, 249][index % 4])
    });
    let codec = FrameDelta::new();
    let mut encoded = [0; 262];
    let len = codec
        .encode_into(&reference, &current, &mut encoded)
        .unwrap();
    let plan = codec.plan(&encoded[..len], current.len()).unwrap();
    let mut scalar = reference;
    plan.apply_with(&mut scalar, &mut ScalarFrameDelta).unwrap();
    let mut portable = reference;
    plan.apply_with(&mut portable, &mut PortableFrameDelta)
        .unwrap();
    assert_eq!(scalar, current);
    assert_eq!(portable, current);
}

#[cfg(any(
    target_arch = "x86_64",
    target_arch = "aarch64",
    target_arch = "wasm32"
))]
#[test]
fn decode_plans_select_vectors_only_for_eligible_long_blocks() {
    let codec = FrameDelta::new();

    let mut short = vec![LITERAL | 62];
    short.extend(0..63);
    assert!(!codec.plan(&short, 63).unwrap().portable);

    let mut long = vec![LITERAL | 63];
    long.extend(0..64);
    assert!(codec.plan(&long, 64).unwrap().portable);

    let incompatible_pattern = [PATTERN | 2, 20, 0, 1, 2, 3];
    assert!(!codec.plan(&incompatible_pattern, 66).unwrap().portable);

    let compatible_pattern = [PATTERN | 3, 14, 0, 1, 2, 3, 4];
    assert!(codec.plan(&compatible_pattern, 64).unwrap().portable);
}

#[test]
fn all_failures_precede_output_writes() {
    let codec = FrameDelta::new();
    let reference = [1, 2, 3];
    assert!(matches!(
        codec.encoded_len(&reference, &[1, 2]),
        Err(FrameDeltaError::LengthMismatch {
            reference: 3,
            current: 2,
        })
    ));
    let mut output = [0xa5; 4];
    assert!(matches!(
        codec.encode_into(&reference, &[4, 5, 6], &mut output[..1]),
        Err(FrameDeltaError::OutputTooSmall { .. })
    ));
    assert_eq!(output, [0xa5; 4]);

    for input in [
        &[0x82, 1, 2][..],
        &[3][..],
        &[0, 0][..],
        &[0xd0, 0, 0, 1][..],
        &[PATTERN, 0][..],
    ] {
        assert!(codec.plan(input, reference.len()).is_err());
    }
    let plan = codec.plan(&[0x82, 1, 2, 3], reference.len()).unwrap();
    assert!(matches!(
        plan.decode_into(&reference, &mut output[..2]),
        Err(FrameDeltaError::OutputTooSmall {
            needed: 3,
            available: 2,
        })
    ));
    assert_eq!(output, [0xa5; 4]);
}