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
/// Interleaved multi-stream rANS encoder interface.
pub trait RansEncoderMulti<const N: usize> {
/// Type of a Symbol value that can be encoded using this encoder.
type Symbol: RansEncSymbol;
/// Resets this encoder's internal state, so that the internal buffer
/// becomes empty.
///
/// # Examples
/// ```
/// use rans::byte_encoder::{ByteRansEncSymbol, ByteRansEncoderMulti};
/// use rans::{RansEncSymbol, RansEncoderMulti};
///
/// let mut encoder = ByteRansEncoderMulti::<2>::new(1024);
/// let symbol = ByteRansEncSymbol::new(0, 1, 4);
/// encoder.put_at(0, &symbol);
/// encoder.flush_all();
/// encoder.reset();
/// assert_eq!(encoder.data(), []);
/// ```
fn reset(&mut self);
/// Puts a symbol into the specified channel.
///
/// # Examples
/// ```
/// use rans::byte_encoder::{ByteRansEncSymbol, ByteRansEncoderMulti};
/// use rans::{RansEncSymbol, RansEncoderMulti};
///
/// let mut encoder = ByteRansEncoderMulti::<2>::new(1024);
/// let symbol = ByteRansEncSymbol::new(0, 1, 4);
/// encoder.put_at(0, &symbol);
/// encoder.put_at(1, &symbol);
/// encoder.flush_all();
/// assert_eq!(encoder.data(), [0, 0, 0, 8, 0, 0, 0, 8]);
/// ```
fn put_at(&mut self, channel: usize, symbol: &Self::Symbol);
/// Flushes the encoder's intermediate data at given channel into the
/// buffer.
///
/// # Examples
/// ```
/// use rans::byte_encoder::ByteRansEncoderMulti;
/// use rans::RansEncoderMulti;
///
/// let mut encoder = ByteRansEncoderMulti::<2>::new(1024);
/// assert_eq!(encoder.data(), []);
/// encoder.flush_at(0);
/// assert_eq!(encoder.data(), [0, 0, 128, 0]);
/// ```
fn flush_at(&mut self, channel: usize);
/// Flushes the encoder's intermediate data at all channels into the buffer.
///
/// # Examples
/// ```
/// use rans::byte_encoder::ByteRansEncoderMulti;
/// use rans::RansEncoderMulti;
///
/// let mut encoder = ByteRansEncoderMulti::<2>::new(1024);
/// assert_eq!(encoder.data(), []);
/// encoder.flush_all();
/// assert_eq!(encoder.data(), [0, 0, 128, 0, 0, 0, 128, 0]);
/// ```
fn flush_all(&mut self) {
for i in 0..N {
self.flush_at(i);
}
}
/// Returns this encoder's internal buffer content.
///
/// # Examples
/// ```
/// use rans::byte_encoder::ByteRansEncoderMulti;
/// use rans::RansEncoderMulti;
///
/// let encoder = ByteRansEncoderMulti::<2>::new(1024);
/// assert_eq!(encoder.data(), []);
/// ```
#[must_use]
fn data(&self) -> &[u8];
/// Returns this encoder's internal buffer current length in bytes.
///
/// # Examples
/// ```
/// use rans::byte_encoder::ByteRansEncoderMulti;
/// use rans::RansEncoderMulti;
///
/// let encoder = ByteRansEncoderMulti::<2>::new(1024);
/// assert_eq!(encoder.len(), 0);
/// ```
#[must_use]
#[inline]
fn len(&self) -> usize {
self.data().len()
}
/// Returns whether this encoder's internal buffer is empty.
///
/// # Examples
/// ```
/// use rans::byte_encoder::ByteRansEncoderMulti;
/// use rans::RansEncoderMulti;
///
/// let encoder = ByteRansEncoderMulti::<2>::new(1024);
/// assert!(encoder.is_empty());
/// ```
#[must_use]
#[inline]
fn is_empty(&self) -> bool {
self.data().is_empty()
}
}
/// Single-stream rANS encoder interface.
pub trait RansEncoder: RansEncoderMulti<1> {
/// Puts the specified symbol into this encoder.
///
/// # Examples
/// ```
/// use rans::byte_encoder::{ByteRansEncSymbol, ByteRansEncoder};
/// use rans::{RansEncSymbol, RansEncoder, RansEncoderMulti};
///
/// let mut encoder = ByteRansEncoder::new(1024);
/// let symbol = ByteRansEncSymbol::new(0, 1, 4);
/// encoder.put(&symbol);
/// encoder.flush();
/// assert_eq!(encoder.data(), [0, 0, 0, 8]);
/// ```
fn put(&mut self, symbol: &Self::Symbol) {
self.put_at(0, symbol);
}
/// Flushes the encoder's intermediate data into the buffer.
///
/// # Examples
/// ```
/// use rans::byte_encoder::ByteRansEncoder;
/// use rans::{RansEncoder, RansEncoderMulti};
///
/// let mut encoder = ByteRansEncoder::new(1024);
/// assert_eq!(encoder.data(), []);
/// encoder.flush();
/// assert_eq!(encoder.data(), [0, 0, 128, 0]);
/// ```
fn flush(&mut self) {
self.flush_at(0);
}
}
/// A symbol that can be encoded using a rANS encoder.
pub trait RansEncSymbol {
/// Creates a new rANS encoder symbol instance.
///
/// # Examples
/// ```
/// use rans::byte_encoder::ByteRansEncSymbol;
/// use rans::RansEncSymbol;
///
/// let _symbol = ByteRansEncSymbol::new(0, 1, 4);
/// ```
#[must_use]
fn new(cum_freq: u32, freq: u32, scale_bits: u32) -> Self;
}
macro_rules! check_enc_pointer {
($self:ident) => {
debug_assert!($self.is_ptr_valid(), "Data pointer is in an invalid state. Consider calling reset() earlier or increasing `max_len` when constructing the encoder.");
}
}
pub(crate) use check_enc_pointer;
#[cfg(test)]
pub(crate) mod tests {
use std::fmt::Debug;
use crate::encoder::{RansEncSymbol, RansEncoder, RansEncoderMulti};
pub(crate) fn test_encode_nothing<T: RansEncoder>(encoder: T) {
assert_eq!(encoder.len(), 0);
assert!(encoder.is_empty());
assert!(encoder.data().is_empty());
}
pub(crate) fn test_encode_empty_data<T: RansEncoder>(mut encoder: T, data: &[u8]) {
encoder.flush();
assert_eq!(encoder.data(), data);
}
pub(crate) fn test_encode_two_symbols<T: RansEncoder>(mut encoder: T, data: &[u8]) {
const SCALE_BITS: u32 = 2;
let symbol1 = T::Symbol::new(0, 2, SCALE_BITS);
let symbol2 = T::Symbol::new(2, 2, SCALE_BITS);
encoder.put(&symbol1);
encoder.put(&symbol2);
encoder.flush();
assert_eq!(encoder.len(), data.len());
assert!(!encoder.is_empty());
assert_eq!(encoder.data(), data);
}
pub(crate) fn test_encode_symbols_clone<T>(mut encoder: T, data: &[u8])
where
T: RansEncoder,
T::Symbol: Clone,
{
const SCALE_BITS: u32 = 2;
let symbol1 = T::Symbol::new(0, 2, SCALE_BITS);
let symbol2 = T::Symbol::new(2, 2, SCALE_BITS);
#[allow(clippy::redundant_clone)]
encoder.put(&symbol1.clone());
#[allow(clippy::redundant_clone)]
encoder.put(&symbol2.clone());
encoder.flush();
assert_eq!(encoder.len(), data.len());
assert!(!encoder.is_empty());
assert_eq!(encoder.data(), data);
}
pub(crate) fn test_encode_and_reset<T: RansEncoder>(
mut encoder: T,
data1: &[u8],
data2: &[u8],
) {
const SCALE_BITS: u32 = 2;
let symbol1 = T::Symbol::new(0, 2, SCALE_BITS);
let symbol2 = T::Symbol::new(2, 2, SCALE_BITS);
encoder.put(&symbol1);
encoder.flush();
assert_eq!(encoder.len(), data1.len());
assert!(!encoder.is_empty());
assert_eq!(encoder.data(), data1);
encoder.reset();
encoder.put(&symbol2);
encoder.flush();
assert_eq!(encoder.len(), data2.len());
assert!(!encoder.is_empty());
assert_eq!(encoder.data(), data2);
}
pub(crate) fn test_encode_more_data<T: RansEncoder>(mut encoder: T, data: &[u8]) {
const SCALE_BITS: u32 = 8;
let s1 = T::Symbol::new(0, 3, SCALE_BITS);
let s2 = T::Symbol::new(3, 10, SCALE_BITS);
let s3 = T::Symbol::new(13, 58, SCALE_BITS);
let s4 = T::Symbol::new(71, 34, SCALE_BITS);
let s5 = T::Symbol::new(105, 41, SCALE_BITS);
let s6 = T::Symbol::new(146, 17, SCALE_BITS);
let s7 = T::Symbol::new(163, 55, SCALE_BITS);
let s8 = T::Symbol::new(218, 38, SCALE_BITS);
let symbols = [
&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,
];
for symbol in symbols {
encoder.put(symbol);
}
encoder.flush();
assert_eq!(encoder.data(), data);
}
pub(crate) fn encode_interleaved<T: RansEncoderMulti<2>>(mut encoder: T, data: &[u8]) {
const SCALE_BITS: u32 = 4;
let symbol1 = T::Symbol::new(0, 4, SCALE_BITS);
let symbol2 = T::Symbol::new(4, 4, SCALE_BITS);
let symbol3 = T::Symbol::new(8, 4, SCALE_BITS);
let symbol4 = T::Symbol::new(12, 4, SCALE_BITS);
encoder.put_at(0, &symbol1);
encoder.put_at(1, &symbol1);
encoder.put_at(0, &symbol1);
encoder.put_at(1, &symbol2);
encoder.put_at(0, &symbol1);
encoder.put_at(1, &symbol3);
encoder.put_at(0, &symbol1);
encoder.put_at(1, &symbol4);
encoder.flush_all();
assert_eq!(encoder.data(), data);
}
pub(crate) fn test_has_debug_output<T: RansEncoder + Debug>(encoder: T) {
assert!(!format!("{encoder:?}").is_empty());
}
}