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
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
use crate::codec::Magic;
use crate::codec::{CodecError, CodecMetadata, EncoderType, ReadCompression, ReadCompressionEnum};
use crate::SourceType::*;
use crate::{Event, PlaneSize, SourceCamera, SourceType};

// #[cfg(feature = "compression")]
// use crate::codec::compressed::adu::frame::Adu;
#[cfg(feature = "compression")]
use crate::codec::compressed::stream::CompressedInput;

use crate::codec::encoder::Encoder;
use crate::codec::header::{
    EventStreamHeader, EventStreamHeaderExtensionV1, EventStreamHeaderExtensionV2,
    EventStreamHeaderExtensionV3, MAGIC_COMPRESSED,
};
use crate::codec::raw::stream::RawInput;
use crate::codec::CodecError::Deserialize;
use crate::SourceType::U8;
use bincode::config::{FixintEncoding, WithOtherEndian, WithOtherIntEncoding};
use bincode::{DefaultOptions, Options};
use bitstream_io::{BigEndian, BitRead, BitReader};
use std::io::{Read, Seek, SeekFrom};

/// Struct for decoding [`Event`]s from a stream
pub struct Decoder<R: Read + Seek> {
    input: ReadCompressionEnum<R>,
    bincode: WithOtherEndian<
        WithOtherIntEncoding<DefaultOptions, FixintEncoding>,
        bincode::config::BigEndian,
    >,
    _phantom: std::marker::PhantomData<R>,
}

#[allow(dead_code)]
impl<R: Read + Seek> Decoder<R> {
    /// Create a new decoder with the given compression scheme
    #[cfg(feature = "compression")]
    pub fn new_compressed(
        compression: CompressedInput<R>,
        reader: &mut BitReader<R, BigEndian>,
    ) -> Result<Self, CodecError>
    where
        Self: Sized,
    {
        let mut decoder = Self {
            input: ReadCompressionEnum::CompressedInput(compression),
            bincode: DefaultOptions::new()
                .with_fixint_encoding()
                .with_big_endian(),
            _phantom: std::marker::PhantomData,
        };
        decoder.decode_header(reader)?;
        Ok(decoder)
    }

    /// Create a new decoder with the given compression scheme
    pub fn new_raw(
        compression: RawInput<R>,
        reader: &mut BitReader<R, BigEndian>,
    ) -> Result<Self, CodecError>
    where
        Self: Sized,
    {
        let mut decoder = Self {
            input: ReadCompressionEnum::RawInput(compression),
            bincode: DefaultOptions::new()
                .with_fixint_encoding()
                .with_big_endian(),
            _phantom: std::marker::PhantomData,
        };
        decoder.decode_header(reader)?;
        Ok(decoder)
    }

    /// Returns a reference to the metadata of the underlying compression scheme
    #[inline]
    pub fn meta(&self) -> &CodecMetadata {
        self.input.meta()
    }

    /// Returns a mutable reference to the metadata of the underlying compression scheme
    #[inline]
    pub fn meta_mut(&mut self) -> &mut CodecMetadata {
        self.input.meta_mut()
    }

    /// Get the source data representation, based on the source camera
    #[allow(clippy::match_same_arms)]
    pub fn get_source_type(&self) -> SourceType {
        match self.input.meta().source_camera {
            SourceCamera::FramedU8 => U8,
            SourceCamera::FramedU16 => U16,
            SourceCamera::FramedU32 => U32,
            SourceCamera::FramedU64 => U64,
            SourceCamera::FramedF32 => F32,
            SourceCamera::FramedF64 => F64,
            SourceCamera::Dvs => U8,
            SourceCamera::DavisU8 => U8,
            SourceCamera::Atis => U8,
            SourceCamera::Asint => F64,
        }
    }

    /// Decode the header and its extensions
    fn decode_header(&mut self, reader: &mut BitReader<R, BigEndian>) -> Result<usize, CodecError> {
        let header_size = bincode::serialized_size(&EventStreamHeader::default())?;
        let mut buffer: Vec<u8> = vec![0; header_size as usize];
        reader.read_bytes(&mut buffer)?;

        let header = match self
            .bincode
            .deserialize_from::<_, EventStreamHeader>(&*buffer)
        {
            Ok(header) => header,
            Err(_) => return Err(Deserialize),
        };

        {
            if header.magic != self.input.magic() {
                return Err(CodecError::WrongMagic);
            }
            let meta = self.input.meta_mut();
            *meta = CodecMetadata {
                codec_version: header.version,
                header_size: header_size as usize,
                time_mode: Default::default(),
                plane: PlaneSize::new(header.width, header.height, header.channels)?,
                tps: header.tps,
                ref_interval: header.ref_interval,
                delta_t_max: header.delta_t_max,
                event_size: header.event_size,
                source_camera: Default::default(), // Gets filled by decoding the V2 header extension
                adu_interval: Default::default(), // Gets filled by decoding the V3 header extension
            };

            // Manual fix for malformed files with old software
            if meta.event_size == 10 {
                meta.event_size = 11;
            }
        }
        self.decode_header_extension(reader)?;
        Ok(self.input.meta().header_size)
    }

    fn decode_header_extension(
        &mut self,
        reader: &mut BitReader<R, BigEndian>,
    ) -> Result<(), CodecError> {
        let codec_version = self.input.meta().codec_version;
        if codec_version == 0 {
            return Ok(());
        }
        let mut extension_size =
            bincode::serialized_size(&EventStreamHeaderExtensionV1::default())?;
        let mut buffer: Vec<u8> = vec![0; extension_size as usize];
        reader.read_bytes(&mut buffer)?;
        let extension_v1 = match self
            .bincode
            .deserialize_from::<_, EventStreamHeaderExtensionV1>(&*buffer)
        {
            Ok(header) => header,
            Err(_) => return Err(Deserialize),
        };
        self.input.meta_mut().source_camera = extension_v1.source;
        self.input.meta_mut().header_size += extension_size as usize;

        if codec_version == 1 {
            return Ok(());
        }

        extension_size = bincode::serialized_size(&EventStreamHeaderExtensionV2::default())?;
        buffer = vec![0; extension_size as usize];
        reader.read_bytes(&mut buffer)?;
        let extension_v2 = match self
            .bincode
            .deserialize_from::<_, EventStreamHeaderExtensionV2>(&*buffer)
        {
            Ok(header) => header,
            Err(_) => return Err(Deserialize),
        };
        self.input.meta_mut().time_mode = extension_v2.time_mode;
        self.input.meta_mut().header_size += extension_size as usize;

        if codec_version == 2 {
            return Ok(());
        }

        extension_size = bincode::serialized_size(&EventStreamHeaderExtensionV3::default())?;
        buffer = vec![0; extension_size as usize];
        reader.read_bytes(&mut buffer)?;
        let extension_v3 = match self
            .bincode
            .deserialize_from::<_, EventStreamHeaderExtensionV3>(&*buffer)
        {
            Ok(header) => header,
            Err(_) => return Err(Deserialize),
        };
        self.input.meta_mut().adu_interval = extension_v3.adu_interval as usize;
        self.input.meta_mut().header_size += extension_size as usize;

        if codec_version == 3 {
            return Ok(());
        }

        Err(CodecError::UnsupportedVersion(codec_version))
    }

    /// Read and decode the next event from the input stream
    #[inline]
    pub fn digest_event(
        &mut self,
        reader: &mut BitReader<R, BigEndian>,
    ) -> Result<Event, CodecError> {
        self.input.digest_event(reader)
    }

    // Read and decode the next event from the input stream
    // #[cfg(feature = "compression")]
    // #[inline]
    // pub fn digest_event_debug(
    //     &mut self,
    //     reader: &mut BitReader<R, BigEndian>,
    // ) -> Result<(Option<Adu>, Event), CodecError> {
    //     self.input.digest_event_debug(reader)
    // }

    /// Sets the input stream position to the given absolute byte position
    pub fn set_input_stream_position(
        &mut self,
        reader: &mut BitReader<R, BigEndian>,
        position: u64,
    ) -> Result<(), CodecError> {
        self.input.set_input_stream_position(reader, position)
    }

    /// Returns the current position of the input stream in bytes
    pub fn get_input_stream_position(
        &self,
        reader: &mut BitReader<R, BigEndian>,
    ) -> Result<u64, CodecError> {
        Ok(reader.position_in_bits()? / 8)
    }

    /// Returns the EOF position, in bytes. This is the position of the first byte of the raw event
    /// which demarcates the end of the stream.
    pub fn get_eof_position(
        &mut self,
        reader: &mut BitReader<R, BigEndian>,
    ) -> Result<u64, CodecError> {
        for i in self.input.meta().event_size as i64..10 {
            // TODO: Make this work differently on raw vs. compressed stream
            reader.seek_bits(SeekFrom::End(
                i * self.input.meta().plane.volume() as i64 * 8,
            ))?;
            if let Err(CodecError::Eof) = self.digest_event(reader) {
                break;
            }
        }

        Ok(self.get_input_stream_position(reader)? - self.input.meta().event_size as u64)
    }

    pub fn get_compression_type(&self) -> EncoderType {
        #[cfg(feature = "compression")]
        if self.input.magic() == MAGIC_COMPRESSED {
            return EncoderType::Compressed;
        }
        EncoderType::Raw
    }
}

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

    use crate::codec::encoder::Encoder;
    use crate::codec::raw::stream::{RawInput, RawOutput};

    use crate::codec::rate_controller::Crf;
    use crate::codec::{EncoderOptions, EventOrder};
    use crate::Coord;
    use std::io::{BufReader, BufWriter, Cursor, Write};

    fn stock_event() -> Event {
        Event {
            coord: Coord {
                x: 0,
                y: 0,
                c: None,
            },
            d: 0,
            t: 0,
        }
    }

    fn setup_encoded_raw(codec_version: u8) -> Vec<u8> {
        let output = Vec::new();

        let bufwriter = BufWriter::new(output);
        let compression = RawOutput::new(
            CodecMetadata {
                codec_version,
                header_size: 0,
                time_mode: Default::default(),
                plane: Default::default(),
                tps: 0,
                ref_interval: 255,
                delta_t_max: 255,
                event_size: 0,
                source_camera: Default::default(),
                adu_interval: 1,
            },
            bufwriter,
        );
        let mut encoder: Encoder<BufWriter<Vec<u8>>> = Encoder::new_raw(
            compression,
            EncoderOptions::default(PlaneSize {
                width: 100,
                height: 100,
                channels: 1,
            }),
        );

        let event = stock_event();
        encoder.ingest_event(event).unwrap();
        let mut writer = encoder.close_writer().unwrap().unwrap();

        writer.flush().unwrap();

        writer.into_inner().unwrap()
    }

    fn setup_encoded_raw_interleaved(codec_version: u8) -> Vec<u8> {
        let output = Vec::new();

        let bufwriter = BufWriter::new(output);
        let compression = RawOutput::new(
            CodecMetadata {
                codec_version,
                header_size: 0,
                time_mode: Default::default(),
                plane: Default::default(),
                tps: 0,
                ref_interval: 255,
                delta_t_max: 255,
                event_size: 0,
                source_camera: Default::default(),
                adu_interval: 1,
            },
            bufwriter,
        );
        let mut encoder: Encoder<BufWriter<Vec<u8>>> = Encoder::new_raw(
            compression,
            EncoderOptions {
                event_drop: Default::default(),
                event_order: EventOrder::Interleaved,
                crf: Crf::new(
                    None,
                    PlaneSize {
                        width: 100,
                        height: 100,
                        channels: 1,
                    },
                ),
            },
        );

        let event = stock_event();
        encoder.ingest_event(event).unwrap();
        let mut writer = encoder.close_writer().unwrap().unwrap();

        writer.flush().unwrap();

        writer.into_inner().unwrap()
    }

    #[cfg(feature = "compression")]
    fn setup_encoded_compressed(codec_version: u8) -> Vec<u8> {
        use crate::codec::CompressedOutput;

        let output = Vec::new();

        let bufwriter = BufWriter::new(output);
        let compression = CompressedOutput::new(
            CodecMetadata {
                codec_version,
                header_size: 0,
                time_mode: Default::default(),
                plane: Default::default(),
                tps: 0,
                ref_interval: 255,
                delta_t_max: 255,
                event_size: 0,
                source_camera: Default::default(),
                adu_interval: 1,
            },
            bufwriter,
        );
        let encoder: Encoder<BufWriter<Vec<u8>>> = Encoder::new_compressed(
            compression,
            EncoderOptions::default(PlaneSize {
                width: 100,
                height: 100,
                channels: 1,
            }),
        );

        // let event = stock_event();
        //
        // encoder.ingest_event(&event).unwrap();
        let mut writer = encoder.close_writer().unwrap().unwrap();
        writer.flush().unwrap();

        writer.into_inner().unwrap()
    }

    #[test]
    fn header_v0_raw() {
        let output = setup_encoded_raw(0);
        let tmp = Cursor::new(&*output);

        let bufreader = BufReader::new(tmp);

        let compression = RawInput::new();

        let mut bitreader = BitReader::endian(bufreader, BigEndian);
        let reader = Decoder::new_raw(compression, &mut bitreader).unwrap();
        assert_eq!(reader.input.meta().header_size, 25);
    }

    #[test]
    fn header_v1_raw() {
        let output = setup_encoded_raw(1);
        let tmp = Cursor::new(&*output);
        let bufreader = BufReader::new(tmp);
        let compression = RawInput::new();
        let mut bitreader = BitReader::endian(bufreader, BigEndian);

        let reader = Decoder::new_raw(compression, &mut bitreader).unwrap();
        assert_eq!(reader.input.meta().header_size, 29);
    }

    #[test]
    fn header_v2_raw() {
        let output = setup_encoded_raw(2);
        let tmp = Cursor::new(&*output);
        let bufreader = BufReader::new(tmp);
        let compression = RawInput::new();

        let mut bitreader = BitReader::endian(bufreader, BigEndian);
        let reader = Decoder::new_raw(compression, &mut bitreader).unwrap();
        assert_eq!(reader.input.meta().header_size, 33);
    }

    #[test]
    #[cfg(feature = "compression")]
    fn header_v0_compressed() {
        let output = setup_encoded_compressed(0);
        let tmp = Cursor::new(&*output);
        let bufreader = BufReader::new(tmp);
        let compression = CompressedInput::new(255, 255, 1);

        let mut bitreader = BitReader::endian(bufreader, BigEndian);
        let reader = Decoder::new_compressed(compression, &mut bitreader).unwrap();
        assert_eq!(reader.input.meta().header_size, 25);
    }

    #[test]
    #[cfg(feature = "compression")]
    fn header_v1_compressed() {
        let output = setup_encoded_compressed(1);
        let tmp = Cursor::new(&*output);
        let bufreader = BufReader::new(tmp);
        let compression = CompressedInput::new(255, 255, 1);

        let mut bitreader = BitReader::endian(bufreader, BigEndian);
        let reader = Decoder::new_compressed(compression, &mut bitreader).unwrap();
        assert_eq!(reader.input.meta().header_size, 29);
    }

    #[test]
    #[cfg(feature = "compression")]
    fn header_v2_compressed() {
        let output = setup_encoded_compressed(2);
        let tmp = Cursor::new(&*output);
        let bufreader = BufReader::new(tmp);
        let compression = CompressedInput::new(255, 255, 1);

        let mut bitreader = BitReader::endian(bufreader, BigEndian);
        let reader = Decoder::new_compressed(compression, &mut bitreader).unwrap();
        assert_eq!(reader.input.meta().header_size, 33);
    }

    #[test]
    fn digest_event_raw() {
        let output = setup_encoded_raw(2);
        let tmp = Cursor::new(&*output);
        let bufreader = BufReader::new(tmp);
        let compression = RawInput::new();

        let mut bitreader = BitReader::endian(bufreader, BigEndian);
        let mut reader = Decoder::new_raw(compression, &mut bitreader).unwrap();
        let event = reader.digest_event(&mut bitreader).unwrap();
        assert_eq!(event, stock_event());
    }
}