Add arithmetic-coding dependency (with modifications) locally (#68)

* Add arithmetic-coding locally

* add artih license

* Clippy fixes

* Clippy fixes

* Set arithmetic dependency by path

* Set arithmetic dependency by path

* Update rust_action_test_and_docs.yml

* Update rust_action_test_and_docs.yml

* Update rust_action_test_and_docs.yml

Author: ac-freeman

.github/workflows/rust_action_test_and_docs.yml

@@ -38,25 +38,25 @@ jobs:
         run: sudo apt-get install -y portaudio19-dev build-essential libpulse-dev libdbus-1-dev pkg-config libx11-dev libatk1.0-dev libgtk-3-dev libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libwayland-dev libxkbcommon-dev
 
       - name: Check project
-        run: cargo check
+        run: cargo check -p adder-codec-core -p adder-codec-rs -p adder-info -p adder-to-dvs -p adder-viz
 
       - name: Build binaries for testing
         run: cargo build -p adder-info
 
       - name: Test project
-        run: cargo test -vv
+        run: cargo test -vv -p adder-codec-core -p adder-codec-rs -p adder-info -p adder-to-dvs -p adder-viz
 
-      - name: Install cargo-llvm-cov
-        uses: taiki-e/install-action@cargo-llvm-cov
-      - uses: Swatinem/rust-cache@v2
-      - name: run llvm-cov test
-        # should test with --all-features if gpu support.
-        run: cargo llvm-cov --workspace --lcov --output-path lcov.info
-      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v3
-        with:
-          files: lcov.info
-          fail_ci_if_error: false
+      # - name: Install cargo-llvm-cov
+      #   uses: taiki-e/install-action@cargo-llvm-cov
+      # - uses: Swatinem/rust-cache@v2
+      # - name: run llvm-cov test
+      #   # should test with --all-features if gpu support.
+      #   run: cargo llvm-cov -p adder-codec-core -p adder-codec-rs -p adder-info -p adder-to-dvs -p adder-viz --lcov --output-path lcov.info
+      # - name: Upload coverage to Codecov
+      #   uses: codecov/codecov-action@v3
+      #   with:
+      #     files: lcov.info
+      #     fail_ci_if_error: false
       - name: Run a documentation generation test
         run: cargo doc -vv -p adder-codec-rs --features=docs-only
   check_windows:
@@ -100,5 +100,5 @@ jobs:
           export OPENCV_LINK_PATHS="/C/tools/opencv/build/x64/vc15/lib"
           export OPENCV_LINK_LIBS="opencv_world${OPENCV_VERSION//./}"
           export OPENCV_INCLUDE_PATHS="/C/tools/opencv/build/include"
-          cargo test -vv
+          cargo test -vv -p adder-codec-core -p adder-codec-rs -p adder-info -p adder-to-dvs -p adder-viz
         shell: bash

Cargo.toml

@@ -5,6 +5,9 @@ members = [
     "adder-info",
     "adder-to-dvs",
     "adder-viz",
+    "arithmetic-coding",
+    "arithmetic-coding/arithmetic-coding-core",
+    "arithmetic-coding/fenwick-model",
 ]
 
 [profile.release]

adder-codec-core/Cargo.toml

@@ -18,7 +18,7 @@ default = []
 compression = ["dep:arithmetic-coding"]
 
 [dependencies]
-arithmetic-coding = { git = "https://github.com/ac-freeman/arithmetic-coding.git", optional = true }
+arithmetic-coding = { path = "../arithmetic-coding", version = "0.3.1", optional = true }
 bincode = "1.3.3"
 bitstream-io = "1.6.0"
 itertools = "0.10.5"

adder-codec-core/src/codec/encoder.rs

@@ -240,7 +240,7 @@ mod tests {
     use crate::codec::{CodecMetadata, LATEST_CODEC_VERSION};
 
     use crate::{Coord, PlaneSize};
-    use bitstream_io::{BigEndian, BitWriter};
+    
     use std::io::BufWriter;
 
     #[test]

adder-codec-core/src/codec/raw/stream.rs

@@ -2,7 +2,7 @@
 use crate::codec::compressed::adu::frame::Adu;
 use crate::codec::header::{Magic, MAGIC_RAW};
 use crate::codec::{CodecError, CodecMetadata, ReadCompression, WriteCompression};
-use crate::{Coord, DeltaT, Event, EventSingle, EOF_PX_ADDRESS};
+use crate::{Coord, Event, EventSingle, EOF_PX_ADDRESS};
 use bincode::config::{FixintEncoding, WithOtherEndian, WithOtherIntEncoding};
 use bincode::{DefaultOptions, Options};
 use bitstream_io::{BigEndian, BitRead, BitReader};
@@ -98,7 +98,7 @@ impl<W: Write> WriteCompression<W> for RawOutput<W> {
         };
         self.bincode.serialize_into(self.stream(), &eof).unwrap();
         self.flush_writer().unwrap();
-        std::mem::replace(&mut self.stream, None)
+        self.stream.take()
     }
 
     fn flush_writer(&mut self) -> std::io::Result<()> {
@@ -209,7 +209,7 @@ impl<W: Write> WriteCompression<W> for RawOutputInterleaved<W> {
         };
         self.bincode.serialize_into(self.stream(), &eof).unwrap();
         self.flush_writer().unwrap();
-        std::mem::replace(&mut self.stream, None)
+        self.stream.take()
     }
 
     fn flush_writer(&mut self) -> std::io::Result<()> {
@@ -256,6 +256,12 @@ impl<W: Write> WriteCompression<W> for RawOutputInterleaved<W> {
     }
 }
 
+impl<R: Read + Seek> Default for RawInput<R> {
+    fn default() -> Self {
+        Self::new()
+    }
+}
+
 impl<R: Read + Seek> RawInput<R> {
     /// Create a new raw input stream.
     pub fn new() -> Self

adder-codec-core/src/lib.rs

@@ -11,7 +11,7 @@ pub mod codec;
 mod codec_old;
 pub use bitstream_io;
 use bitstream_io::{BigEndian, BitReader};
-use std::cmp::{max, min, Ordering};
+use std::cmp::{Ordering};
 use std::fs::File;
 use std::io::BufReader;
 use std::ops::Add;
@@ -54,7 +54,7 @@ use crate::codec::compressed::blocks::{DeltaTResidual, EventResidual};
 use crate::codec::compressed::stream::CompressedInput;
 use crate::codec::decoder::Decoder;
 use crate::codec::raw::stream::RawInput;
-use crate::codec::{CodecError, ReadCompression};
+use crate::codec::{CodecError};
 use serde::{Deserialize, Serialize};
 
 /// The type of time used in the ADΔER representation
@@ -535,7 +535,7 @@ pub fn open_file_decoder(
     ),
     CodecError,
 > {
-    let mut bufreader = BufReader::new(File::open(file_path)?);
+    let bufreader = BufReader::new(File::open(file_path)?);
     let compression = RawInput::new();
     let mut bitreader = BitReader::endian(bufreader, BigEndian);
 

adder-codec-rs/src/framer/scale_intensity.rs

@@ -92,7 +92,7 @@ impl FrameValue for u8 {
             }
             FramedViewMode::SAE => {
                 // Convert deltaT to absolute time
-                ((delta_t_max / 255 as u32) - (delta_t_max as f64 / sae_time_since) as u32) as u8
+                ((delta_t_max / 255_u32) - (delta_t_max as f64 / sae_time_since) as u32) as u8
                 // We assume that the dt component is an absolute_t in this case
             }
         }
@@ -113,7 +113,7 @@ impl FrameValue for u16 {
         practical_d_max: f32,
         delta_t_max: DeltaT,
         view_mode: FramedViewMode,
-        sae_time_since: f64,
+        _sae_time_since: f64,
     ) -> Self::Output {
         match view_mode {
             FramedViewMode::Intensity => {
@@ -166,7 +166,7 @@ impl FrameValue for u32 {
         practical_d_max: f32,
         delta_t_max: DeltaT,
         view_mode: FramedViewMode,
-        sae_time_since: f64,
+        _sae_time_since: f64,
     ) -> Self::Output {
         match view_mode {
             FramedViewMode::Intensity => {
@@ -217,7 +217,7 @@ impl FrameValue for u64 {
         practical_d_max: f32,
         delta_t_max: DeltaT,
         view_mode: FramedViewMode,
-        sae_time_since: f64,
+        _sae_time_since: f64,
     ) -> Self::Output {
         match view_mode {
             FramedViewMode::Intensity => {

adder-codec-rs/src/transcoder/source/davis.rs

@@ -415,7 +415,7 @@ impl<W: Write + 'static> Integration<W> {
 
         let db = match video.instantaneous_frame.data_bytes_mut() {
             Ok(db) => db,
-            Err(e) => return Err(CodecError::MalformedEncoder), // TODO: Wrong type of error
+            Err(_e) => return Err(CodecError::MalformedEncoder), // TODO: Wrong type of error
         };
 
         // TODO: split off into separate function
@@ -843,7 +843,7 @@ impl<W: Write + 'static + std::marker::Send> Source<W> for Davis<W> {
                 // };
                 self.integration.dvs_events_last_after = self.integration.dvs_events_after.clone();
                 self.integration.end_of_last_frame_timestamp =
-                    self.integration.end_of_frame_timestamp.clone();
+                    self.integration.end_of_frame_timestamp;
 
                 self.integration.dvs_last_timestamps.par_map_inplace(|ts| {
                     debug_assert!(*ts < end_of_frame_timestamp);
@@ -889,7 +889,7 @@ impl<W: Write + 'static + std::marker::Send> Source<W> for Davis<W> {
 }
 
 impl<W: Write + 'static> VideoBuilder<W> for Davis<W> {
-    fn contrast_thresholds(mut self, c_thresh_pos: u8, c_thresh_neg: u8) -> Self {
+    fn contrast_thresholds(mut self, c_thresh_pos: u8, _c_thresh_neg: u8) -> Self {
         self.video = self.video.c_thresh_pos(c_thresh_pos);
         // self.video = self.video.c_thresh_neg(c_thresh_neg);
         self
@@ -900,7 +900,7 @@ impl<W: Write + 'static> VideoBuilder<W> for Davis<W> {
         self
     }
 
-    fn c_thresh_neg(mut self, c_thresh_neg: u8) -> Self {
+    fn c_thresh_neg(self, _c_thresh_neg: u8) -> Self {
         // self.video = self.video.c_thresh_neg(c_thresh_neg);
         self
     }

adder-codec-rs/src/transcoder/source/framed.rs

@@ -184,7 +184,7 @@ impl<W: Write + 'static> Source<W> for Framed<W> {
 }
 
 impl<W: Write + 'static> VideoBuilder<W> for Framed<W> {
-    fn contrast_thresholds(mut self, c_thresh_pos: u8, c_thresh_neg: u8) -> Self {
+    fn contrast_thresholds(mut self, c_thresh_pos: u8, _c_thresh_neg: u8) -> Self {
         self.video = self.video.c_thresh_pos(c_thresh_pos);
         // self.video = self.video.c_thresh_neg(c_thresh_neg);
         self