libsfasta 0.3.4

Better FASTA sequence compression and querying
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
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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
use crate::datatypes::structs::{default_compression_level, CompressionType};
use crate::datatypes::U64BlockStore;
use crate::*;

use std::io::{Read, Seek, SeekFrom, Write};

use flate2::write::{GzDecoder, GzEncoder};
use log::error;

#[cfg(not(target_arch = "wasm32"))]
use xz::read::{XzDecoder, XzEncoder};

pub struct SequenceBlocks<'a> {
    pub block_loc_store: U64BlockStore,
    cache: Option<(u32, Vec<u8>)>,
    cache_sbc: SequenceBlockCompressed,
    pub compression_type: CompressionType,
    pub compression_level: i8,
    caching: bool,
    block_size: usize,
    zstd_decompressor: Option<zstd::bulk::Decompressor<'a>>,
}

// TODO: Redundant code, clean it up
impl<'a> SequenceBlocks<'a> {
    pub fn new<R>(
        in_buf: &mut R,
        compression_type: CompressionType,
        compression_dict: Option<Vec<u8>>,
        block_size: usize,
        block_index_location: u64,
    ) -> Self
    where
        R: Read + Seek,
    {
        let zstd_decompressor = if compression_type == CompressionType::ZSTD {
            let mut zstd_decompressor = if let Some(dict) = &compression_dict {
                zstd::bulk::Decompressor::with_dictionary(dict)
            } else {
                zstd::bulk::Decompressor::new()
            }
            .unwrap();
            zstd_decompressor
                .include_magicbytes(false)
                .expect("Unable to disable magicbytes in decoder");
            Some(zstd_decompressor)
        } else {
            None
        };

        Self {
            cache: None,
            compression_type,
            compression_level: default_compression_level(compression_type),
            caching: false,
            block_size,
            zstd_decompressor,
            cache_sbc: SequenceBlockCompressed {
                compressed_seq: Vec::with_capacity(block_size),
            },
            block_loc_store: U64BlockStore::from_buffer(in_buf, block_index_location)
                .expect("Unable to open Block Index Store"),
        }
    }

    pub fn without_caching(mut self) -> Self {
        self.caching = false;
        self
    }

    pub fn block_locs<R>(&mut self, mut in_buf: &mut R, block: u32) -> u64
    where
        R: Read + Seek,
    {
        self.block_loc_store.get(in_buf, block as usize)
    }

    pub fn prefetch_block_locs<R>(&mut self, in_buf: &mut R) -> Result<(), String>
    where
        R: Read + Seek,
    {
        self.block_loc_store.prefetch(in_buf);
        Ok(())
    }

    pub fn _get_block<R>(&mut self, mut in_buf: &mut R, block: u32)
    where
        R: Read + Seek,
    {
        if self.cache.is_none() {
            self.cache = Some((block, vec![0; self.block_size]));
        }

        let bincode_config = bincode::config::standard().with_fixed_int_encoding();

        self.cache.as_mut().unwrap().0 = block;
        let byte_loc = self.block_locs(&mut in_buf, block);
        in_buf
            .seek(SeekFrom::Start(byte_loc))
            .expect("Unable to work with seek API");

        self.cache_sbc.compressed_seq.clear();
        self.cache_sbc.compressed_seq = bincode::decode_from_std_read(&mut *in_buf, bincode_config)
            .expect("Unable to parse SequenceBlockCompressed");

        self.cache.as_mut().unwrap().1.clear();
        self.cache_sbc.decompress_to_buffer(
            self.compression_type,
            &mut self.cache.as_mut().unwrap().1,
            self.zstd_decompressor.as_mut(),
        );
    }

    pub fn get_block<R>(&mut self, in_buf: &mut R, block: u32) -> &[u8]
    where
        R: Read + Seek,
    {
        if self.cache.is_some() && self.cache.as_ref().unwrap().0 == block {
            self.cache.as_ref().unwrap().1.as_slice()
        } else {
            self._get_block(in_buf, block);
            self.cache.as_ref().unwrap().1.as_slice()
        }
    }

    pub fn get_block_uncached<R>(&mut self, mut in_buf: &mut R, block: u32) -> Vec<u8>
    where
        R: Read + Seek,
    {
        let bincode_config = bincode::config::standard().with_fixed_int_encoding();

        let byte_loc = self.block_locs(&mut in_buf, block);
        in_buf
            .seek(SeekFrom::Start(byte_loc))
            .expect("Unable to work with seek API");

        let sbc: SequenceBlockCompressed = bincode::decode_from_std_read(in_buf, bincode_config)
            .expect("Unable to parse SequenceBlockCompressed");

        let mut buffer = Vec::with_capacity(self.block_size);
        sbc.decompress_to_buffer(
            self.compression_type,
            &mut buffer,
            self.zstd_decompressor.as_mut(),
        );

        buffer
    }
}

pub struct SequenceBlock {
    pub seq: Vec<u8>,
}

#[cfg(not(target_arch = "wasm32"))]
pub fn zstd_encoder(
    compression_level: i32,
    dict: Option<Vec<u8>>,
) -> zstd::bulk::Compressor<'static> {
    let mut encoder = if let Some(dict) = dict {
        zstd::bulk::Compressor::with_dictionary(compression_level, &dict).unwrap()
    } else {
        zstd::bulk::Compressor::new(compression_level).unwrap()
    };
    encoder.include_checksum(false).unwrap();
    encoder
        .include_magicbytes(false)
        .expect("Unable to set ZSTD MagicBytes");
    encoder
        .include_contentsize(false)
        .expect("Unable to set ZSTD Content Size Flag");
    encoder.long_distance_matching(true);
    encoder
}

#[cfg(target_arch = "wasm32")]
pub fn zstd_encoder(compression_level: i32) -> zstd::bulk::Compressor<'static> {
    unimplemented!("ZSTD encoding is not supported on wasm32");
}

impl SequenceBlock {
    pub fn compress(
        self,
        compression_type: CompressionType,
        compression_level: i8,
        zstd_compressor: Option<&mut zstd::bulk::Compressor>,
    ) -> SequenceBlockCompressed {
        #[cfg(test)]
        let mut cseq: Vec<u8> = Vec::with_capacity(512 * 1024);

        #[cfg(not(test))]
        let mut cseq: Vec<u8> = Vec::with_capacity(self.seq.len());

        // Destructure self
        let SequenceBlock { seq } = self;

        match compression_type {
            #[cfg(not(target_arch = "wasm32"))]
            CompressionType::ZSTD => {
                //let mut compressor = zstd_encoder(compression_level as i32);
                let compressor = zstd_compressor.unwrap();
                compressor.compress_to_buffer(&seq, &mut cseq).unwrap();
            }
            #[cfg(target_arch = "wasm32")]
            CompressionType::ZSTD => {
                unimplemented!("ZSTD encoding is not supported on wasm32");
            }
            CompressionType::LZ4 => {
                let mut compressor = lz4_flex::frame::FrameEncoder::new(cseq);
                compressor
                    .write_all(&seq)
                    .expect("Unable to compress with LZ4");
                cseq = compressor.finish().unwrap();
            }
            CompressionType::SNAPPY => {
                let mut compressor = snap::write::FrameEncoder::new(cseq);
                compressor
                    .write_all(&seq)
                    .expect("Unable to compress with Snappy");
                cseq = compressor.into_inner().unwrap();
            }
            CompressionType::GZIP => {
                let mut compressor =
                    GzEncoder::new(cseq, flate2::Compression::new(compression_level as u32));
                compressor
                    .write_all(&seq)
                    .expect("Unable to compress with GZIP");
                cseq = compressor.finish().unwrap();
            }
            CompressionType::NAF => {
                unimplemented!();
            }
            CompressionType::NAFLike => {
                todo!();
            }
            CompressionType::NONE => {
                cseq = seq;
            }
            #[cfg(not(target_arch = "wasm32"))]
            CompressionType::XZ => {
                let mut compressor = XzEncoder::new(&seq[..], compression_level as u32);
                compressor
                    .read_to_end(&mut cseq)
                    .expect("Unable to XZ compress");
            }
            #[cfg(target_arch = "wasm32")]
            CompressionType::XZ => {
                panic!("XZ compression is not supported on wasm32");
            }
            CompressionType::BROTLI => {
                let mut compressor = brotli::CompressorReader::new(
                    &seq[..],
                    2 * 1024 * 1024,
                    compression_level as u32,
                    22,
                );
                compressor.read_to_end(&mut cseq).unwrap();
            }
            _ => {
                error!("Unsupported compression type: {:?}", compression_type);
                panic!("Unsupported compression type: {:?}", compression_type);
            }
        }

        //debug!("Compressed sequence block to length: {}", cseq.len());

        SequenceBlockCompressed {
            compressed_seq: cseq,
        }
    }

    pub fn len(&self) -> usize {
        self.seq.len()
    }

    pub fn is_empty(&self) -> bool {
        self.seq.is_empty()
    }
}

#[derive(bincode::Encode, bincode::Decode)]
pub struct SequenceBlockCompressed {
    pub compressed_seq: Vec<u8>,
}

impl SequenceBlockCompressed {
    pub fn decompress(
        self,
        compression_type: CompressionType,
        block_size: usize,
        mut zstd_decompressor: Option<&mut zstd::bulk::Decompressor>,
    ) -> SequenceBlock {
        let mut seq: Vec<u8> = Vec::with_capacity(block_size);

        match compression_type {
            CompressionType::NAFLike => {
                todo!();
            }
            #[cfg(not(target_arch = "wasm32"))]
            CompressionType::ZSTD => {
                //let mut decoder = zstd::stream::Decoder::new(&self.compressed_seq[..]).unwrap();
                //decoder
                //    .include_magicbytes(false)
                //    .expect("Unable to disable magicbytes in decoder");

                //match decoder.read_to_end(&mut seq) {
                //    Ok(x) => x,
                //   Err(y) => panic!("Unable to decompress block: {:#?}", y),
                //};
                let zstd = zstd_decompressor.as_mut().unwrap();
                match zstd.decompress_to_buffer(&self.compressed_seq, &mut seq) {
                    Ok(_x) => _x,
                    Err(y) => panic!("Unable to decompress block: {:#?}", y),
                };
            }

            #[cfg(target_arch = "wasm32")]
            CompressionType::ZSTD => {
                let mut decoder = ruzstd::StreamingDecoder::new(&self.compressed_seq[..]).unwrap();

                match decoder.read_to_end(&mut seq) {
                    Ok(x) => x,
                    Err(y) => panic!("Unable to decompress block: {:#?}", y),
                };
            }

            #[cfg(not(target_arch = "wasm32"))]
            CompressionType::XZ => {
                let mut decompressor = XzDecoder::new(&self.compressed_seq[..]);
                decompressor
                    .read_to_end(&mut seq)
                    .expect("Unable to XZ compress");
            }
            #[cfg(target_arch = "wasm32")]
            CompressionType::XZ => {
                panic!("XZ compression is not supported on wasm32");
            }

            CompressionType::BROTLI => {
                let mut decompressor =
                    brotli::Decompressor::new(&self.compressed_seq[..], 2 * 1024 * 1024);
                decompressor.read_to_end(&mut seq).unwrap();
            }
            CompressionType::LZ4 => {
                let mut decompressor = lz4_flex::frame::FrameDecoder::new(&self.compressed_seq[..]);
                decompressor
                    .read_to_end(&mut seq)
                    .expect("Unable to decompress with LZ4");
            }
            CompressionType::SNAPPY => {
                let mut decompressor = snap::read::FrameDecoder::new(&self.compressed_seq[..]);
                decompressor
                    .read_to_end(&mut seq)
                    .expect("Unable to decompress with Snappy");
            }
            CompressionType::GZIP => {
                let mut decompressor = GzDecoder::new(&mut seq);
                decompressor
                    .write_all(&self.compressed_seq[..])
                    .expect("Unable to decompress with GZIP");
            }
            CompressionType::NONE => seq = self.compressed_seq,
            _ => {
                unimplemented!()
            }
        };

        SequenceBlock { seq }
    }

    pub fn decompress_to_buffer(
        &self,
        compression_type: CompressionType,
        buffer: &mut Vec<u8>,
        mut zstd_decompressor: Option<&mut zstd::bulk::Decompressor>,
    ) {
        buffer.clear();
        match compression_type {
            CompressionType::ZSTD => {
                let zstd = zstd_decompressor.as_mut().unwrap();
                match zstd.decompress_to_buffer(&self.compressed_seq, buffer) {
                    Ok(_x) => _x,
                    Err(y) => panic!("Unable to decompress block: {:#?}", y),
                };
            }
            CompressionType::XZ => {
                let mut decompressor = XzDecoder::new(&self.compressed_seq[..]);
                decompressor
                    .read_to_end(buffer)
                    .expect("Unable to XZ compress");
            }
            CompressionType::BROTLI => {
                let mut decompressor =
                    brotli::Decompressor::new(&self.compressed_seq[..], 2 * 1024 * 1024);
                decompressor.read_to_end(buffer).unwrap();
            }
            CompressionType::LZ4 => {
                let mut decompressor = lz4_flex::frame::FrameDecoder::new(&self.compressed_seq[..]);
                decompressor
                    .read_to_end(buffer)
                    .expect("Unable to decompress with LZ4");
            }
            CompressionType::SNAPPY => {
                let mut decompressor = snap::read::FrameDecoder::new(&self.compressed_seq[..]);
                decompressor
                    .read_to_end(buffer)
                    .expect("Unable to decompress with Snappy");
            }
            CompressionType::GZIP => {
                let mut decompressor = GzDecoder::new(buffer);
                decompressor
                    .write_all(&self.compressed_seq[..])
                    .expect("Unable to decompress with GZIP");
            }
            CompressionType::NONE => *buffer = self.compressed_seq.clone(),
            _ => {
                unimplemented!()
            }
        };
    }

    // Convenience Function
    /*    pub fn with_compression_type(mut self, compression_type: CompressionType) -> Self {
        self.compression_type = compression_type;
        self
    } */
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    pub fn test_encode_and_decode() {
        let bincode_config = bincode::config::standard().with_fixed_int_encoding();

        let test_bytes = b"abatcacgactac".to_vec();
        let x = SequenceBlockCompressed {
            compressed_seq: test_bytes.clone(),
        };

        let encoded = bincode::encode_to_vec(&x, bincode_config).unwrap();
        let decoded: SequenceBlockCompressed = bincode::decode_from_slice(&encoded, bincode_config)
            .unwrap()
            .0;
        assert!(decoded.compressed_seq == x.compressed_seq);
        assert!(decoded.compressed_seq == test_bytes);
    }

    #[test]
    pub fn test_compress_and_decompress() {
        let test_bytes = b"abatcacgactac".to_vec();
        let x = SequenceBlock {
            seq: test_bytes.clone(),
        };

        let mut compressor = zstd_encoder(3, None);

        let y = x.compress(CompressionType::ZSTD, 3, Some(&mut compressor));
        let mut zstd_decompressor = zstd::bulk::Decompressor::new().unwrap();
        zstd_decompressor.include_magicbytes(false).unwrap();
        let z = y.decompress(
            CompressionType::ZSTD,
            8 * 1024 * 1024,
            Some(zstd_decompressor).as_mut(),
        );
        assert!(z.seq == test_bytes);
    }
}