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
/// Interleaved multi-stream rANS decoder interface.
pub trait RansDecoderMulti<const N: usize> {
/// Type of a Symbol value that can be encoded using this decoder.
type Symbol: RansDecSymbol;
/// Gets the cumulative frequency for the current symbol at specified
/// channel. Note that this does not advance the data position; for
/// that, use [`Self::advance_at()`].
///
/// # Examples
/// ```
/// use rans::byte_decoder::ByteRansDecoderMulti;
/// use rans::RansDecoderMulti;
///
/// let mut decoder = ByteRansDecoderMulti::<2>::new([2, 0, 0, 1, 0, 0, 0, 1]);
/// assert_eq!(decoder.get_at(0, 2), 2);
/// assert_eq!(decoder.get_at(1, 2), 0);
/// ```
#[must_use]
fn get_at(&mut self, channel: usize, scale_bits: u32) -> u32;
/// Advances the data position after reading a symbol at given channel.
/// Equivalent to calling [`Self::advance_step_at()`] and
/// [`Self::renorm_at()`].
///
/// # Examples
/// ```
/// use rans::byte_decoder::{ByteRansDecSymbol, ByteRansDecoderMulti};
/// use rans::{RansDecSymbol, RansDecoderMulti};
///
/// let mut decoder = ByteRansDecoderMulti::<2>::new([2, 0, 0, 1, 0, 0, 0, 1]);
/// let symbol_1 = ByteRansDecSymbol::new(0, 2);
/// let symbol_2 = ByteRansDecSymbol::new(2, 2);
/// assert_eq!(decoder.get_at(0, 2), 2);
/// decoder.advance_at(0, &symbol_2, 2);
/// assert_eq!(decoder.get_at(1, 2), 0);
/// decoder.advance_at(1, &symbol_1, 2);
/// assert_eq!(decoder.get_at(0, 2), 0);
/// assert_eq!(decoder.get_at(1, 2), 0);
/// ```
fn advance_at(&mut self, channel: usize, symbol: &Self::Symbol, scale_bits: u32);
/// Pops a single symbol from the internal state, without doing
/// renormalization or modifying the internal buffer.
///
/// # Examples
/// ```
/// use rans::byte_decoder::{ByteRansDecSymbol, ByteRansDecoderMulti};
/// use rans::{RansDecSymbol, RansDecoderMulti};
///
/// let mut decoder = ByteRansDecoderMulti::<2>::new([2, 0, 0, 1, 0, 0, 0, 1]);
/// let symbol_1 = ByteRansDecSymbol::new(0, 2);
/// let symbol_2 = ByteRansDecSymbol::new(2, 2);
/// assert_eq!(decoder.get_at(0, 2), 2);
/// decoder.advance_step_at(0, &symbol_2, 2);
/// assert_eq!(decoder.get_at(1, 2), 0);
/// decoder.advance_step_at(1, &symbol_1, 2);
/// decoder.renorm_all();
/// assert_eq!(decoder.get_at(0, 2), 0);
/// assert_eq!(decoder.get_at(1, 2), 0);
/// ```
fn advance_step_at(&mut self, channel: usize, symbol: &Self::Symbol, scale_bits: u32);
/// Renormalizes the data in the internal buffer after advancing a symbol.
///
/// # Examples
/// ```
/// use rans::byte_decoder::{ByteRansDecSymbol, ByteRansDecoderMulti};
/// use rans::{RansDecSymbol, RansDecoderMulti};
///
/// let mut decoder = ByteRansDecoderMulti::<2>::new([2, 0, 0, 1, 0, 0, 0, 1]);
/// let symbol_1 = ByteRansDecSymbol::new(0, 2);
/// let symbol_2 = ByteRansDecSymbol::new(2, 2);
/// assert_eq!(decoder.get_at(0, 2), 2);
/// decoder.advance_step_at(0, &symbol_2, 2);
/// assert_eq!(decoder.get_at(1, 2), 0);
/// decoder.advance_step_at(1, &symbol_1, 2);
/// decoder.renorm_at(0);
/// decoder.renorm_at(1);
/// assert_eq!(decoder.get_at(0, 2), 0);
/// assert_eq!(decoder.get_at(1, 2), 0);
/// ```
fn renorm_at(&mut self, channel: usize);
/// Renormalizes the data in all channels' internal buffers after advancing
/// a symbol.
///
/// # Examples
/// ```
/// use rans::byte_decoder::{ByteRansDecSymbol, ByteRansDecoderMulti};
/// use rans::{RansDecSymbol, RansDecoderMulti};
///
/// let mut decoder = ByteRansDecoderMulti::<2>::new([2, 0, 0, 1, 0, 0, 0, 1]);
/// let symbol_1 = ByteRansDecSymbol::new(0, 2);
/// let symbol_2 = ByteRansDecSymbol::new(2, 2);
/// assert_eq!(decoder.get_at(0, 2), 2);
/// decoder.advance_step_at(0, &symbol_2, 2);
/// assert_eq!(decoder.get_at(1, 2), 0);
/// decoder.advance_step_at(1, &symbol_1, 2);
/// decoder.renorm_all();
/// assert_eq!(decoder.get_at(0, 2), 0);
/// assert_eq!(decoder.get_at(1, 2), 0);
/// ```
fn renorm_all(&mut self) {
for i in 0..N {
self.renorm_at(i);
}
}
}
/// Single-stream rANS decoder interface.
pub trait RansDecoder: RansDecoderMulti<1> {
/// Gets the cumulative frequency for the current symbol. Note that this
/// does not advance the data position; for that, use [`Self::advance()`].
///
/// # Examples
/// ```
/// use rans::byte_decoder::{ByteRansDecSymbol, ByteRansDecoder};
/// use rans::{RansDecSymbol, RansDecoder};
///
/// let mut decoder = ByteRansDecoder::new([2, 0, 0, 2]);
/// assert_eq!(decoder.get(4), 2);
/// assert_eq!(decoder.get(4), 2);
/// ```
#[must_use]
fn get(&mut self, scale_bits: u32) -> u32 {
self.get_at(0, scale_bits)
}
/// Advances the data position after reading a symbol.
///
/// # Examples
/// ```
/// use rans::byte_decoder::{ByteRansDecSymbol, ByteRansDecoder};
/// use rans::{RansDecSymbol, RansDecoder};
///
/// let mut decoder = ByteRansDecoder::new([2, 0, 0, 2]);
/// let symbol = ByteRansDecSymbol::new(2, 2);
/// assert_eq!(decoder.get(2), 2);
/// decoder.advance(&symbol, 2);
/// assert_eq!(decoder.get(2), 0);
/// ```
fn advance(&mut self, symbol: &Self::Symbol, scale_bits: u32) {
self.advance_at(0, symbol, scale_bits);
}
}
/// A symbol that can be decoded using a rANS decoder.
pub trait RansDecSymbol {
/// Creates a new rANS decoder symbol instance.
///
/// # Examples
/// ```
/// use rans::byte_decoder::ByteRansDecSymbol;
/// use rans::RansDecSymbol;
///
/// let _symbol = ByteRansDecSymbol::new(0, 2);
/// ```
#[must_use]
fn new(cum_freq: u32, freq: u32) -> Self;
/// Returns this symbol's cumulative frequency.
///
/// # Examples
/// ```
/// use rans::byte_decoder::ByteRansDecSymbol;
/// use rans::RansDecSymbol;
///
/// let symbol = ByteRansDecSymbol::new(0, 2);
/// assert_eq!(symbol.cum_freq(), 0);
/// ```
#[must_use]
fn cum_freq(&self) -> u32;
/// Returns this symbol's frequency.
///
/// # Examples
/// ```
/// use rans::byte_decoder::ByteRansDecSymbol;
/// use rans::RansDecSymbol;
///
/// let symbol = ByteRansDecSymbol::new(0, 2);
/// assert_eq!(symbol.freq(), 2);
/// ```
#[must_use]
fn freq(&self) -> u32;
}
macro_rules! check_dec_pointer {
($self:ident) => {
debug_assert!($self.is_ptr_valid(), "Data pointer is in an invalid state. Make sure you are not reading more symbols than originally encoded.");
}
}
pub(crate) use check_dec_pointer;
#[cfg(test)]
pub(crate) mod tests {
use std::fmt::Debug;
use crate::decoder::RansDecSymbol;
use crate::{RansDecoder, RansDecoderMulti};
pub(crate) fn test_decode_empty<T: RansDecoder>(mut decoder: T) {
assert_eq!(decoder.get(2), 0);
}
pub(crate) fn test_decode_two_symbols<T: RansDecoder>(mut decoder: T) {
let symbol1 = T::Symbol::new(0, 2);
let symbol2 = T::Symbol::new(2, 2);
let cum_freq = decoder.get(2);
assert_eq!(cum_freq, 2);
decoder.advance(&symbol2, 2);
let cum_freq = decoder.get(2);
assert_eq!(cum_freq, 0);
decoder.advance(&symbol1, 2);
}
pub(crate) fn test_decode_symbols_clone<T>(mut decoder: T)
where
T: RansDecoder,
T::Symbol: Clone,
{
let symbol1 = T::Symbol::new(0, 2);
let symbol2 = T::Symbol::new(2, 2);
let cum_freq = decoder.get(2);
assert_eq!(cum_freq, 2);
#[allow(clippy::redundant_clone)]
decoder.advance(&symbol2.clone(), 2);
let cum_freq = decoder.get(2);
assert_eq!(cum_freq, 0);
#[allow(clippy::redundant_clone)]
decoder.advance(&symbol1.clone(), 2);
}
pub(crate) fn test_decode_more_data<T: RansDecoder>(mut decoder: T) {
const SCALE_BITS: u32 = 8;
let s1 = T::Symbol::new(0, 3);
let s2 = T::Symbol::new(3, 10);
let s3 = T::Symbol::new(13, 58);
let s4 = T::Symbol::new(71, 34);
let s5 = T::Symbol::new(105, 41);
let s6 = T::Symbol::new(146, 17);
let s7 = T::Symbol::new(163, 55);
let s8 = T::Symbol::new(218, 38);
let symbols = [&s1, &s2, &s3, &s4, &s5, &s6, &s7, &s8];
let mut symbol_data = [
&s1, &s2, &s3, &s4, &s5, &s6, &s7, &s8, &s3, &s3, &s3, &s3, &s3, &s5, &s4, &s3, &s4,
&s3, &s7, &s8, &s8, &s6, &s5, &s3, &s4, &s7, &s6, &s7, &s7, &s3, &s4, &s5,
];
symbol_data.reverse();
for (i, expected_symbol) in symbol_data.iter().enumerate() {
let cum_freq = decoder.get(SCALE_BITS);
let actual_symbol = get_symbol(&symbols, cum_freq);
assert_eq!(
actual_symbol.cum_freq(),
expected_symbol.cum_freq(),
"Invalid symbol at position {} (decoded cumulative frequency: {})",
i,
cum_freq
);
decoder.advance(expected_symbol, SCALE_BITS);
}
}
#[must_use]
fn get_symbol<'a, T: RansDecSymbol>(symbols: &'a [&T], cum_freq: u32) -> &'a T {
for symbol in symbols {
if cum_freq < symbol.cum_freq() + symbol.freq() {
return symbol;
}
}
unreachable!("Invalid symbol frequency");
}
pub(crate) fn test_decode_interleaved<T: RansDecoderMulti<2>>(mut decoder: T) {
const SCALE_BITS: u32 = 4;
let symbol1 = T::Symbol::new(0, 4);
let symbol2 = T::Symbol::new(4, 4);
let symbol3 = T::Symbol::new(8, 4);
let symbol4 = T::Symbol::new(12, 4);
assert_eq!(decoder.get_at(0, SCALE_BITS), 12);
assert_eq!(decoder.get_at(1, SCALE_BITS), 0);
decoder.advance_step_at(0, &symbol4, SCALE_BITS);
decoder.advance_step_at(1, &symbol1, SCALE_BITS);
decoder.renorm_all();
assert_eq!(decoder.get_at(0, SCALE_BITS), 8);
assert_eq!(decoder.get_at(1, SCALE_BITS), 0);
decoder.advance_step_at(0, &symbol3, SCALE_BITS);
decoder.advance_step_at(1, &symbol1, SCALE_BITS);
decoder.renorm_all();
assert_eq!(decoder.get_at(0, SCALE_BITS), 4);
assert_eq!(decoder.get_at(1, SCALE_BITS), 0);
decoder.advance_step_at(0, &symbol2, SCALE_BITS);
decoder.advance_step_at(1, &symbol1, SCALE_BITS);
decoder.renorm_all();
assert_eq!(decoder.get_at(0, SCALE_BITS), 0);
assert_eq!(decoder.get_at(1, SCALE_BITS), 0);
decoder.advance_step_at(0, &symbol1, SCALE_BITS);
decoder.advance_step_at(1, &symbol1, SCALE_BITS);
decoder.renorm_all();
}
pub(crate) fn test_has_debug_output<T: RansDecoder + Debug>(decoder: T) {
assert!(!format!("{decoder:?}").is_empty());
}
}