ProCraft for Android: An Android native painting app written in Rust
Rust
perf(save): a save keeps only the layers that changed, not every layer read back
Josh551a4b970b10
diff --git a/apps/procraft-android/src/project.rs b/apps/procraft-android/src/project.rsindex 45aad14..ba34dec 100644--- a/apps/procraft-android/src/project.rs+++ b/apps/procraft-android/src/project.rs@@ -104,11 +104,11 @@ pub(crate) fn file_error(context: &str, e: impl std::fmt::Display) -> MobileErroMobileError::File { reason: format!("{context}: {e}") }}-/// What a save writes, read under the lock: the artwork's file, every layer and the picture (if-/// shown).+/// What a save writes, read under the lock: the artwork's file, the layers not already in the+/// folder as they are (each with its hash) and the picture (if shown).pub(crate) struct SaveSnapshot {file: ArtworkFile,- layers: Vec<(LayerId, Vec<u8>)>,+ layers: Vec<(LayerId, u64, Vec<u8>)>,composite: Option<Vec<u8>>,model: Option<crate::scene3d::ModelSnapshot>,}@@ -122,6 +122,13 @@ pub(crate) struct Saved {sets: crate::scene3d::SavedSets,}+impl Saved {+ /// The hashes of the layers the last saves wrote to `dir`; none for another folder.+ pub(crate) fn known(&self, dir: &Path) -> std::collections::HashMap<LayerId, u64> {+ if self.dir == dir { self.layers.clone() } else { Default::default() }+ }+}+/// A quick hash of pixels, to tell a changed layer from one saved already.pub(crate) fn pixels_hash(rgba: &[u8]) -> u64 {const PRIME: u64 = 0x0000_0100_0000_01B3;@@ -150,8 +157,19 @@ impl crate::State {&& self.scene.as_ref().is_none_or(|s| !s.stroking)}- /// The artwork as it is now, for saving.- pub(crate) fn save_snapshot(&mut self) -> Result<SaveSnapshot, MobileError> {+ /// The artwork as it is now, for saving into `dir`: a layer already there as it is (its hash+ /// among the `known` and its file there) is let go as soon as it is read, so a save holds only+ /// the layers that changed.+ pub(crate) fn save_snapshot(+ &mut self,+ dir: &Path,+ known: &std::collections::HashMap<LayerId, u64>,+ ) -> Result<SaveSnapshot, MobileError> {+ let changed = |id: LayerId, rgba: Vec<u8>| {+ let hash = pixels_hash(&rgba);+ let there = known.get(&id) == Some(&hash) && layer_path(dir, id).exists();+ (!there).then_some((id, hash, rgba))+ };let model = self.model_snapshot()?;let file = ArtworkFile {format: FORMAT.to_owned(),@@ -176,7 +194,7 @@ impl crate::State {canvas.render(gpu, &mut self.doc, None);for layer in self.doc.layers() {let rgba = canvas.read_layer(gpu, layer.id).map_err(|e| file_error("reading a layer", e))?;- layers.push((layer.id, rgba));+ layers.extend(changed(layer.id, rgba));}// for the gallery's thumbnail: private layers left outlet private = self.doc.private_layers();@@ -187,7 +205,8 @@ impl crate::State {);} else {// not shown yet: what was opened is still what there is- layers = opened_pixels(self.pending_pixels.clone(), self.doc.width(), self.doc.height());+ let opened = opened_pixels(self.pending_pixels.clone(), self.doc.width(), self.doc.height());+ layers = opened.into_iter().filter_map(|(id, rgba)| changed(id, rgba)).collect();}Ok(SaveSnapshot { file, layers, composite, model })}@@ -204,14 +223,10 @@ fn write_artwork(saved: &mut Saved, dir: &Path, snapshot: SaveSnapshot) -> Resul}let (w, h) = (file.document.width(), file.document.height());fs::create_dir_all(dir.join("layers")).map_err(|e| file_error("making the folder", e))?;- for (id, rgba) in &layers {- let hash = pixels_hash(rgba);- let path = layer_path(dir, *id);- if saved.layers.get(id) == Some(&hash) && path.exists() {- continue;- }- write_atomically(&path, |p| write_png(p, w, h, rgba, &[]))?;- saved.layers.insert(*id, hash);+ // only those not already there as they are+ for (id, hash, rgba) in &layers {+ write_atomically(&layer_path(dir, *id), |p| write_png(p, w, h, rgba, &[]))?;+ saved.layers.insert(*id, *hash);}// layer files the document no longer hassaved.layers.retain(|id, _| file.document.layer(*id).is_some());@@ -342,7 +357,8 @@ impl CanvasSession {st.finish_stroke();st.settle();// a model saves its colour as the artwork's document- st.with_colour(crate::State::save_snapshot)?+ let known = saved.known(Path::new(&dir));+ st.with_colour(|st| st.save_snapshot(Path::new(&dir), &known))?};write_artwork(&mut saved, Path::new(&dir), snapshot)}@@ -358,7 +374,8 @@ impl CanvasSession {return Ok(false);}// a model saves its colour as the artwork's document- st.with_colour(crate::State::save_snapshot)?+ let known = saved.known(Path::new(&dir));+ st.with_colour(|st| st.save_snapshot(Path::new(&dir), &known))?};write_artwork(&mut saved, Path::new(&dir), snapshot).map(|()| true)}diff --git a/apps/procraft-android/src/tests.rs b/apps/procraft-android/src/tests.rsindex 794dec4..5f24c76 100644--- a/apps/procraft-android/src/tests.rs+++ b/apps/procraft-android/src/tests.rs@@ -1946,6 +1946,18 @@ fn saving_while_idle_writes_only_what_changed() {assert!(s.save_if_idle(path.clone()).unwrap());assert_eq!(std::fs::metadata(&file).unwrap().modified().unwrap(), written);assert_eq!(dir.join("layers").read_dir().unwrap().count(), 2);+ // a layer whose file has gone is written again, though it hasn't changed+ std::fs::remove_file(&file).unwrap();+ assert!(s.save_if_idle(path.clone()).unwrap());+ assert!(file.exists());+ // and one painted on is+ let written = std::fs::metadata(&file).unwrap().modified().unwrap();+ std::thread::sleep(std::time::Duration::from_millis(20));+ assert!(s.select_layer(first));+ s.stroke_begin(PointerKind::Finger, vec![sample(5.0, 5.0, 0.0)]);+ s.stroke_end(vec![]);+ assert!(s.save_if_idle(path.clone()).unwrap());+ assert_ne!(std::fs::metadata(&file).unwrap().modified().unwrap(), written);let t = CanvasSession::open(path).unwrap();assert_eq!(t.layers().len(), 2);assert!(t.layers().iter().any(|l| l.id == first));