brotli 4.0.0

A brotli compressor and decompressor that with an interface avoiding the rust stdlib. This makes it suitable for embedded devices and kernels. It is designed with a pluggable allocator so that the standard lib's allocator may be employed. The default build also includes a stdlib allocator and stream interface. Disable this with --features=no-stdlib. All included code is safe.
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

#![cfg(test)]
#![allow(non_upper_case_globals)]
#![allow(dead_code)]
extern crate brotli_decompressor;
extern crate core;
use super::brotli::enc::{
    compress_multi, compress_multi_no_threadpool, BrotliEncoderMaxCompressedSizeMulti,
    BrotliEncoderParams, UnionHasher,
};
use super::new_brotli_heap_alloc;
use brotli::enc::threading::{Owned, SendAlloc};
use brotli_decompressor::{SliceWrapper, SliceWrapperMut};

use super::integration_tests::UnlimitedBuffer;
static RANDOM_THEN_UNICODE: &[u8] = include_bytes!("../../testdata/random_then_unicode");
static ALICE: &[u8] = include_bytes!("../../testdata/alice29.txt");
use super::Rebox;

struct SliceRef<'a>(&'a [u8]);
impl<'a> SliceWrapper<u8> for SliceRef<'a> {
    fn slice(&self) -> &[u8] {
        self.0
    }
}

fn multi_threaded_split_compression_test(
    input_data: &'static [u8],
    num_threads: usize,
    quality: i32,
    catable: bool,
    expected_size: usize,
) {
    let mut params = BrotliEncoderParams::default();
    params.quality = quality;
    params.magic_number = true;
    if catable {
        params.catable = true;
        params.use_dictionary = false;
    }
    let mut output = Rebox::from(vec![
        0u8;
        BrotliEncoderMaxCompressedSizeMulti(
            input_data.len(),
            num_threads
        )
    ]);
    let mut alloc_per_thread = [
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
    ];
    if num_threads > alloc_per_thread.len() {
        panic!(
            "Too many threads requested {} > {}",
            num_threads,
            alloc_per_thread.len()
        );
    }
    let res = compress_multi(
        &params,
        &mut Owned::new(SliceRef(input_data)),
        output.slice_mut(),
        &mut alloc_per_thread[..num_threads],
    );
    let observed_size = res.unwrap();
    if observed_size > expected_size {
        assert_eq!(observed_size, expected_size);
    }
    assert_ne!(observed_size, 0);
    let mut compressed_version = UnlimitedBuffer::new(&output.slice()[..observed_size]);
    let mut rt = UnlimitedBuffer::new(&[]);
    match super::decompress(&mut compressed_version, &mut rt, 65536, Rebox::default()) {
        Ok(_) => {}
        Err(e) => panic!("Error {:?}", e),
    }
    assert_eq!(rt.data(), input_data);
}
#[test]
fn multi_threaded_split_compression_test_1() {
    multi_threaded_split_compression_test(RANDOM_THEN_UNICODE, 1, 3, false, 155808)
}
#[test]
fn multi_threaded_split_compression_test_2() {
    multi_threaded_split_compression_test(RANDOM_THEN_UNICODE, 2, 4, false, 151857)
}
#[test]
fn multi_threaded_split_compression_test_3() {
    multi_threaded_split_compression_test(RANDOM_THEN_UNICODE, 3, 5, false, 144325)
}
#[test]
fn multi_threaded_split_compression_test_4() {
    multi_threaded_split_compression_test(RANDOM_THEN_UNICODE, 4, 10, true, 136812)
}
#[test]
fn multi_threaded_split_compression_test_5() {
    multi_threaded_split_compression_test(RANDOM_THEN_UNICODE, 5, 9, false, 139126)
}
#[test]
fn multi_threaded_split_compression_test_1b1() {
    multi_threaded_split_compression_test(&RANDOM_THEN_UNICODE[..1], 5, 9, false, 139126)
}
#[test]
fn multi_threaded_split_compression_test_1b5() {
    multi_threaded_split_compression_test(&RANDOM_THEN_UNICODE[..1], 5, 9, false, 139125)
}

#[test]
fn multi_threaded_split_compression_test_0b1() {
    multi_threaded_split_compression_test(&[], 5, 9, false, 139125)
}
#[test]
fn multi_threaded_split_compression_test_0b5() {
    multi_threaded_split_compression_test(&[], 5, 9, false, 139125)
}

fn thread_spawn_per_job_split_compression_test(
    input_data: &'static [u8],
    num_threads: usize,
    quality: i32,
    catable: bool,
    expected_size: usize,
) {
    let mut params = BrotliEncoderParams::default();
    params.quality = quality;
    params.magic_number = true;
    if catable {
        params.catable = true;
        params.use_dictionary = false;
    }
    params.favor_cpu_efficiency = true; // this should test both paths
    let mut output = Rebox::from(vec![
        0u8;
        BrotliEncoderMaxCompressedSizeMulti(
            input_data.len(),
            num_threads
        )
    ]);
    let mut alloc_per_thread = [
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
        SendAlloc::new(new_brotli_heap_alloc(), UnionHasher::Uninit),
    ];
    if num_threads > alloc_per_thread.len() {
        panic!(
            "Too many threads requested {} > {}",
            num_threads,
            alloc_per_thread.len()
        );
    }
    let res = compress_multi_no_threadpool(
        &params,
        &mut Owned::new(SliceRef(input_data)),
        output.slice_mut(),
        &mut alloc_per_thread[..num_threads],
    );
    let observed_size = res.unwrap();
    if observed_size > expected_size {
        assert_eq!(observed_size, expected_size);
    }
    assert_ne!(observed_size, 0);
    let mut compressed_version = UnlimitedBuffer::new(&output.slice()[..observed_size]);
    let mut rt = UnlimitedBuffer::new(&[]);
    match super::decompress(&mut compressed_version, &mut rt, 65536, Rebox::default()) {
        Ok(_) => {}
        Err(e) => panic!("Error {:?}", e),
    }
    assert_eq!(rt.data(), input_data);
}
#[test]
fn thread_spawn_per_job_split_compression_test_1() {
    thread_spawn_per_job_split_compression_test(RANDOM_THEN_UNICODE, 1, 3, false, 155808)
}
#[test]
fn thread_spawn_per_job_split_compression_test_3() {
    thread_spawn_per_job_split_compression_test(RANDOM_THEN_UNICODE, 3, 5, false, 144325)
}
#[test]
fn thread_spawn_per_job_split_compression_test_1b1() {
    thread_spawn_per_job_split_compression_test(&RANDOM_THEN_UNICODE[..1], 1, 3, false, 155808)
}
#[test]
fn thread_spawn_per_job_split_compression_test_1b3() {
    thread_spawn_per_job_split_compression_test(&RANDOM_THEN_UNICODE[..1], 3, 5, false, 144325)
}
#[test]
fn thread_spawn_per_job_split_compression_test_0b1() {
    thread_spawn_per_job_split_compression_test(&[], 1, 3, false, 155808)
}
#[test]
fn thread_spawn_per_job_split_compression_test_0b3() {
    thread_spawn_per_job_split_compression_test(&[], 3, 5, false, 144325)
}