inline pnm decoder instead of using generalized load fn

* Simpler tokio runtime; 3 threads and no io driver

* switch benches over to other runtime

.github/workflows/rust.yml

@@ -3,31 +3,56 @@ name: Rust
 on:
   push:
     branches: ["main"]
+    tags: ["v*.*.*"]
   pull_request:
     branches: ["main"]
+  workflow_dispatch:
+  workflow_call:
 
 env:
   CARGO_TERM_COLOR: always
 
 jobs:
-  build:
+  test-build:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { os: "macos-latest", target: "aarch64-apple-darwin" }
+          - { os: "ubuntu-latest", target: "x86_64-unknown-linux-gnu" }
+          - {
+              os: "windows-latest",
+              target: "x86_64-pc-windows-msvc",
+              ext: ".exe",
+            }
+          - { os: "ubuntu-24.04-arm", target: "aarch64-unknown-linux-gnu" }
 
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
 
     steps:
+      - uses: actions/checkout@v6
+
       - name: Setup sccache
         if: github.event_name != 'release' && github.event_name != 'workflow_dispatch'
         uses: mozilla-actions/sccache-action@v0.0.8
       - name: Configure sccache
         if: github.event_name != 'release' && github.event_name != 'workflow_dispatch'
         run: |
-        echo "SCCACHE_GHA_ENABLED=true" >> $GITHUB_ENV
+          echo "SCCACHE_GHA_ENABLED=true" >> "$GITHUB_ENV"
-        echo "RUSTC_WRAPPER=sccache" >> $GITHUB_ENV
+          echo "RUSTC_WRAPPER=sccache" >> "$GITHUB_ENV"
-    - name: Install build dependencies
+
-      run: |
+      - name: Setup rust cache action
-        sudo apt-get update
+        uses: swatinem/rust-cache@v2
-        sudo apt-get install -y libfontconfig1-dev libgoogle-perftools-dev google-perftools
+        with:
-    - uses: actions/checkout@v4
+          cache-on-failure: true
+
+      - name: install build dependencies on ubuntu and cache
+        if: contains(matrix.os, 'ubuntu')
+        uses: awalsh128/cache-apt-pkgs-action@latest
+        with:
+          packages: libfontconfig1-dev libgoogle-perftools-dev google-perftools
+          version: latest # could be anything
+
       - name: Install clippy and fmt
         run: rustup component add clippy rustfmt
       - name: Clippy
@@ -38,5 +63,46 @@ jobs:
         run: cargo fmt -- --check
       - name: Run benchmarks as tests
         run: cargo test --locked --benches -- adobe_example
-    - name: Build
+
-      run: cargo build --locked
+      - name: Set build mode
+        shell: bash
+        run: if [ "${{github.ref_type}}" == "tag" ] || [ ${{ github.event_name == 'push' && github.ref_name == 'main' }} ]; then echo "BMODE=production">>"$GITHUB_ENV"; fi
+
+      - name: Build in ${{env.BMODE || 'debug'}} mode
+        run: cargo build --verbose --locked --profile ${{env.BMODE || 'dev'}}
+
+      - name: Prepare artifact
+        shell: bash
+        run: |
+          mkdir -p dist
+          cp "target/${{env.BMODE || 'debug'}}/tdf${{ matrix.ext }}" dist/tdf-${{ matrix.target }}${{ matrix.ext }}
+          tree dist || ls -la dist
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v5
+        with:
+          name: tdf-${{ matrix.target }}
+          path: dist/tdf*
+
+  tag-release:
+    name: Release on tag push
+    runs-on: ubuntu-slim
+    if: github.ref_type == 'tag'
+    needs: test-build
+    steps:
+      - uses: actions/download-artifact@v6
+        with:
+          pattern: "**/tdf-*"
+          path: release-artifacts
+          merge-multiple: true
+
+      - name: What's up?
+        run: tree release-artifacts # beautiful!
+
+      - name: Create a GitHub release
+        uses: softprops/action-gh-release@v2
+        with:
+          draft: true
+          generate_release_notes: true
+          files: release-artifacts/*
+          prerelease: ${{ contains(github.ref, 'alpha') || contains(github.ref, 'beta') || contains(github.ref, 'rc') }}

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Unreleased
 
+- Added windows support! (thank you to [@jarjk](https://github.com/jarjk) for helping out!)
 - Added keybindings (`0`/`$`) to scroll to left or right side of zoomed-in image ([#131](https://github.com/itsjunetime/tdf/pull/131), thank you [@IshDeshpa](https://github.com/IshDeshpa)!)
+- (Internal) decreased runtime footprint of tokio runtime
 
 # v0.5.0
 

Cargo.toml

@@ -23,10 +23,10 @@ name = "tdf"
 
 [dependencies]
 # we're using this branch because it has significant performance fixes that I'm waiting on responses from the upstream devs to get upstreamed. See https://github.com/ratatui-org/ratatui/issues/1116
-ratatui = { git = "https://github.com/itsjunetime/ratatui.git" }
+ratatui = { git = "https://github.com/itsjunetime/ratatui.git", rev = "720ac2d0cad1ac6424364fea74856fec9c100cb1", default-features = false, features = [ "crossterm", "layout-cache" ] }
 # ratatui = { path = "./ratatui/ratatui/" }
 # We're using this to have the vb64 feature (for faster base64 encoding, since that does take up a good bit of time when converting images to the `Protocol`. It also just includes a few more features that I'm waiting on main to upstream
-ratatui-image = { git = "https://github.com/itsjunetime/ratatui-image.git", branch = "vb64_on_personal", default-features = false }
+ratatui-image = { git = "https://github.com/itsjunetime/ratatui-image.git", rev = "a276a87cb8e2976442c6cc59db831db81551da89", default-features = false }
 # ratatui-image = { path = "./ratatui-image", default-features = false }
 crossterm = { version = "0.29.0", features = ["event-stream"] }
 # crossterm = { path = "../crossterm", features = ["event-stream"] }
@@ -34,16 +34,17 @@ image = { version = "0.25.1", features = ["pnm", "rayon", "png"], default-featur
 notify = { version = "8.0.0", features = ["crossbeam-channel"] }
 tokio = { version = "1.37.0", features = ["rt-multi-thread", "macros"] }
 futures-util = { version = "0.3.30", default-features = false }
-flume = { version = "0.11.0", default-features = false, features = ["async"] }
+flume = { version = "0.12.0", default-features = false, features = ["async"] }
 xflags = "0.4.0-pre.2"
 mimalloc = "0.1.43"
-nix = { version = "0.30.0", features = ["signal"] }
+nix = { version = "0.31.0", features = ["signal"] }
-mupdf = { git = "https://github.com/messense/mupdf-rs.git", rev = "2e0fae910fac8048c7008211fc4d3b9f5d227a07", default-features = false, features = ["svg", "system-fonts", "img"] }
+mupdf = { git = "https://github.com/messense/mupdf-rs.git", rev = "d7441b9998c92135e329559c0aa71d9dc92cf4de", default-features = false, features = ["svg", "system-fonts", "img"] }
 rayon = { version = "1", default-features = false }
 # kittage = { path = "../kittage/", features = ["crossterm-tokio", "image-crate", "log"] }
-kittage = { version = "0.1.1", features = ["crossterm-tokio", "image-crate", "log"] }
+kittage = { version = "0.3.4", features = ["crossterm-tokio", "image-crate", "log"] }
 memmap2 = "0"
 csscolorparser = { version = "0.8.0", default-features = false }
+debounce = "0.2.2"
 
 # logging
 log = "0.4.27"
@@ -51,7 +52,6 @@ flexi_logger = "0.31"
 
 # for tracing with tokio-console
 console-subscriber = { version = "0.5.0", optional = true }
-debounce = "0.2.2"
 
 [profile.production]
 inherits = "release"
@@ -64,7 +64,7 @@ epub = ["mupdf/epub"]
 cbz = ["mupdf/cbz"]
 
 [dev-dependencies]
-criterion = { version = "0.7.0", features = ["async_tokio"] }
+criterion = { version = "0.8.0", features = ["async_tokio"] }
 cpuprofiler = "0.0.4"
 
 [[bench]]

benches/rendering.rs

@@ -34,7 +34,12 @@ fn for_all_combos(
 	name: &'static str,
 	mut f: impl FnMut(&Runtime, BenchmarkId, &'static str, ProtocolType)
 ) {
-	let rt = tokio::runtime::Runtime::new().unwrap();
+	let rt = tokio::runtime::Builder::new_multi_thread()
+		.worker_threads(3)
+		.enable_time()
+		.build()
+		.unwrap();
+
 	for proto in PROTOS {
 		for file in FILES {
 			f(

benches/utils.rs

@@ -116,6 +116,7 @@ pub fn start_converting_loop(
 	let (to_converter_tx, from_main_rx) = unbounded();
 	let (to_main_tx, from_converter_rx) = unbounded();
 
+	#[expect(deprecated)]
 	let mut picker = Picker::from_fontsize(FONT_SIZE);
 	picker.set_protocol_type(proto);
 

src/converter.rs

@@ -1,11 +1,12 @@
 use std::{
+	io::Cursor,
 	num::NonZeroUsize,
 	time::{SystemTime, UNIX_EPOCH}
 };
 
 use flume::{Receiver, SendError, Sender, TryRecvError};
 use futures_util::stream::StreamExt as _;
-use image::DynamicImage;
+use image::{DynamicImage, codecs::pnm::PnmDecoder};
 use kittage::{NumberOrId, action::NONZERO_ONE};
 use ratatui::layout::Rect;
 use ratatui_image::{
@@ -111,22 +112,26 @@ pub async fn run_conversion_loop(
 			return Ok(None);
 		};
 
-		let mut dyn_img = image::load_from_memory_with_format(
+		let decoder = PnmDecoder::new(Cursor::new(&page_info.img_data.pixels)).map_err(|e| {
-			&page_info.img_data.pixels,
+			RenderError::Converting(format!(
-			image::ImageFormat::Pnm
+				"The image data provided from mupdf was not in pnm format ({e}); don't know how to convert"
-		)
+			))
-		.map_err(|e| RenderError::Converting(format!("Can't load image: {e}")))?;
+		})?;
+
+		// The image we get should always already be `ImageRgb8`, so this `into` shouldn't do any
+		// conversions or anything, but just in case some underlying detail of mupdf or image
+		// changes, we do the `into` instead of just `match + unreachable!()` to avoid panicking
+		let mut dyn_img = DynamicImage::from_decoder(decoder)
+			.map_err(|e| RenderError::Converting(format!("Can't load image: {e}")))?
+			.into_rgb8();
 
-		match dyn_img {
-			DynamicImage::ImageRgb8(ref mut img) =>
 		for quad in &*page_info.result_rects {
-					img.par_enumerate_pixels_mut()
+			dyn_img
+				.par_enumerate_pixels_mut()
 				.filter(|(x, y, _)| {
 					*x > quad.ul_x && *x < quad.lr_x && *y > quad.ul_y && *y < quad.lr_y
 				})
 				.for_each(|(_, _, px)| px.0[2] = px.0[2].saturating_sub(u8::MAX / 2));
-				},
-			_ => unreachable!()
 		}
 
 		let img_area = Rect {
@@ -136,6 +141,8 @@ pub async fn run_conversion_loop(
 			y: 0
 		};
 
+		let dyn_img = DynamicImage::ImageRgb8(dyn_img);
+
 		let txt_img = match picker.protocol_type() {
 			ProtocolType::Kitty => {
 				let rn = SystemTime::now()
@@ -144,9 +151,13 @@ pub async fn run_conversion_loop(
 					.as_nanos() % 1_000_000;
 
 				let mut img = if shms_work {
-					kittage::image::Image::shm_from(dyn_img, &format!("/tdf_{pid}_{rn}_{page_num}"))
+					let shm_name = format!("/tdf_{pid}_{rn}_{page_num}");
-						.map_err(|e| {
+
-							RenderError::Converting(format!("Couldn't write to shm: {e:?}"))
+					#[cfg(unix)]
+					let shm_name = &*shm_name;
+
+					kittage::image::Image::shm_from(dyn_img, shm_name).map_err(|e| {
+						RenderError::Converting(format!("Couldn't create shm: {e:?}"))
 					})?
 				} else {
 					kittage::image::Image::from(dyn_img)

src/kitty.rs

@@ -78,7 +78,12 @@ pub async fn run_action<'es>(
 pub async fn do_shms_work(ev_stream: &mut EventStream) -> bool {
 	let img = DynamicImage::new_rgb8(1, 1);
 	let pid = std::process::id();
-	let Ok(mut k_img) = kittage::image::Image::shm_from(img, &format!("tdf_test_{pid}")) else {
+	let shm_name = format!("tdf_test_{pid}");
+
+	#[cfg(unix)]
+	let shm_name = &*shm_name;
+
+	let Ok(mut k_img) = kittage::image::Image::shm_from(img, shm_name) else {
 		return false;
 	};
 

src/lib.rs

@@ -42,7 +42,7 @@ pub fn scale_img_for_area(
 
 	// and get the ratio that this page would have to be scaled by to fit perfectly within the
 	// area provided to us.
-	// we do this first by comparing the aspec ratio of the page with the aspect ratio of the
+	// we do this first by comparing the aspect ratio of the page with the aspect ratio of the
 	// area to fit it within. If the aspect ratio of the page is larger, then we need to scale
 	// the width of the page to fill perfectly within the height of the area. Otherwise, we
 	// scale the height to fit perfectly. The dimension that _is not_ scaled to fit perfectly

src/main.rs

@@ -70,11 +70,18 @@ fn reset_term() {
 	);
 }
 
-#[tokio::main]
+fn main() -> Result<(), WrappedErr> {
-async fn main() -> Result<(), WrappedErr> {
+	let rt = tokio::runtime::Builder::new_multi_thread()
+		.worker_threads(3)
+		.enable_time()
+		.build()
+		.unwrap();
+
+	rt.block_on(async move {
 		let result = inner_main().await;
 		reset_term();
 		result
+	})
 }
 
 async fn inner_main() -> Result<(), WrappedErr> {
@@ -246,8 +253,13 @@ async fn inner_main() -> Result<(), WrappedErr> {
 				window_size.width != 0
 				&& window_size.height != 0
 				&& window_size.columns != 0
-				&& window_size.rows != 0
+				&& window_size.rows != 0 =>
-					=> Ok(Picker::from_fontsize((cell_width_px, cell_height_px))),
+			{
+				// the 'equivalent' that is suggested instead is not the same. We need to keep
+				// calling this.
+				#[expect(deprecated)]
+				Ok(Picker::from_fontsize((cell_width_px, cell_height_px)))
+			},
 			ratatui_image::errors::Errors::NoFontSize => Err(WrappedErr(
 				"Unable to detect your terminal's font size; this is an issue with your terminal emulator.\nPlease use a different terminal emulator or report this bug to tdf.".into()
 			)),
@@ -396,6 +408,7 @@ async fn enter_redraw_loop(
 						},
 						InputAction::Search(term) => to_renderer.send(RenderNotif::Search(term))?,
 						InputAction::Invert => to_renderer.send(RenderNotif::Invert)?,
+						InputAction::Rotate => to_renderer.send(RenderNotif::Rotate)?,
 						InputAction::Fullscreen => fullscreen = !fullscreen,
 						InputAction::SwitchRenderZoom(f_or_f) => {
 							to_renderer.send(RenderNotif::SwitchFitOrFill(f_or_f)).unwrap();

src/renderer.rs

@@ -20,7 +20,8 @@ pub enum RenderNotif {
 	Search(String),
 	SwitchFitOrFill(FitOrFill),
 	Reload,
-	Invert
+	Invert,
+	Rotate
 }
 
 #[derive(Debug)]
@@ -37,6 +38,14 @@ pub enum RenderInfo {
 	Reloaded
 }
 
+#[derive(Debug, Copy, Clone)]
+pub enum RotateDirection {
+	Deg0,
+	Deg90,
+	Deg180,
+	Deg270
+}
+
 #[derive(Clone)]
 pub struct PageInfo {
 	pub img_data: ImageData,
@@ -98,13 +107,21 @@ pub fn start_rendering(
 
 	let mut stored_doc = None;
 	let mut invert = false;
+	let mut rotate = RotateDirection::Deg0;
 	let mut preserved_area = None;
 	let mut fit_or_fill = FitOrFill::Fit;
 
 	let mut need_rerender = VecDeque::new();
 
+	#[cfg(windows)]
+	let path = path.to_string_lossy();
+
 	'reload: loop {
-		let doc = match Document::open(path) {
+		// Need to do this weird borrow thing so that we convert `Cow<'_, str>` -> `&str` on windows
+		// and keep unix a `&Path` -> `&Path` 'cause there are different requirements within mupdf
+		// about file paths per-platform
+		#[cfg_attr(unix, expect(clippy::borrow_deref_ref))]
+		let doc = match Document::open(&*path) {
 			Err(e) => {
 				// if there's an error, tell the main loop
 				sender.send(Err(RenderError::Doc(e)))?;
@@ -238,6 +255,18 @@ pub fn start_rendering(
 							}
 							continue 'render_pages;
 						}
+						RenderNotif::Rotate => {
+							rotate = match rotate {
+								RotateDirection::Deg0 => RotateDirection::Deg90,
+								RotateDirection::Deg90 => RotateDirection::Deg180,
+								RotateDirection::Deg180 => RotateDirection::Deg270,
+								RotateDirection::Deg270 => RotateDirection::Deg0
+							};
+							for page in &mut rendered {
+								page.successful = false;
+							}
+							continue 'render_pages;
+						}
 					}
 				}};
 			}
@@ -301,6 +330,7 @@ pub fn start_rendering(
 					black,
 					white,
 					fit_or_fill,
+					rotate,
 					(area_w, area_h)
 				) {
 					// If that fn returned Some, that means it needed to be re-rendered for some
@@ -455,6 +485,7 @@ fn render_single_page_to_ctx(
 	black: i32,
 	white: i32,
 	fit_or_fill: FitOrFill,
+	rotate: RotateDirection,
 	(area_w, area_h): (f32, f32)
 ) -> Result<RenderedContext, mupdf::error::Error> {
 	let result_rects = match prev_render.num_search_found {
@@ -465,7 +496,12 @@ fn render_single_page_to_ctx(
 
 	// then, get the size of the page
 	let bounds = page.bounds()?;
-	let page_dim = (bounds.x1 - bounds.x0, bounds.y1 - bounds.y0);
+	let page_dim = match rotate {
+		RotateDirection::Deg0 | RotateDirection::Deg180 =>
+			(bounds.x1 - bounds.x0, bounds.y1 - bounds.y0),
+		RotateDirection::Deg90 | RotateDirection::Deg270 =>
+			(bounds.y1 - bounds.y0, bounds.x1 - bounds.x0),
+	};
 
 	let scaled = scale_img_for_area(page_dim, (area_w, area_h), fit_or_fill);
 	let ScaledResult {
@@ -482,7 +518,13 @@ fn render_single_page_to_ctx(
 	}
 
 	let colorspace = Colorspace::device_rgb();
-	let matrix = Matrix::new_scale(scale_factor, scale_factor);
+	let mut matrix = Matrix::new_scale(scale_factor, scale_factor);
+	match rotate {
+		RotateDirection::Deg0 => matrix.rotate(0.0),
+		RotateDirection::Deg90 => matrix.rotate(90.0),
+		RotateDirection::Deg180 => matrix.rotate(180.0),
+		RotateDirection::Deg270 => matrix.rotate(270.0)
+	};
 
 	let mut pixmap = page.to_pixmap(&matrix, &colorspace, false, false)?;
 	if invert {
@@ -494,6 +536,7 @@ fn render_single_page_to_ctx(
 	let (x_res, y_res) = pixmap.resolution();
 	let new_x = (x_res as f32 * scale_factor) as i32;
 	let new_y = (y_res as f32 * scale_factor) as i32;
+
 	pixmap.set_resolution(new_x, new_y);
 
 	let result_rects = result_rects

src/tui.rs

@@ -9,10 +9,6 @@ use crossterm::{
 	}
 };
 use kittage::display::DisplayLocation;
-use nix::{
-	sys::signal::{Signal::SIGSTOP, kill},
-	unistd::Pid
-};
 use ratatui::{
 	Frame,
 	layout::{Constraint, Flex, Layout, Position, Rect},
@@ -801,10 +797,17 @@ impl Tui {
 								.unwrap();
 								disable_raw_mode().unwrap();
 
+								#[cfg(unix)]
+								{
 									// This process will hang after the SIGSTOP call until we get
 									// foregrounded again by something else, at which point we need to
 									// re-setup everything so that it all gets drawn again.
-								kill(Pid::this(), SIGSTOP).unwrap();
+									nix::sys::signal::kill(
+										nix::unistd::Pid::this(),
+										nix::sys::signal::Signal::SIGSTOP
+									)
+									.unwrap();
+								}
 
 								enable_raw_mode().unwrap();
 								execute!(
@@ -836,6 +839,7 @@ impl Tui {
 							'G' if can_zoom => self.update_zoom(Zoom::pan_top),
 							'0' if can_zoom => self.update_zoom(Zoom::pan_left),
 							'$' if can_zoom => self.update_zoom(Zoom::pan_right),
+							'r' => Some(InputAction::Rotate),
 							_ => None
 						}
 					}
@@ -1107,6 +1111,8 @@ H, J, K, L (when zoomed in):
     Pan direction around page
 0/$ (when on fill-screen):
     Scroll to left/right side of page
+r:
+		Rotate by 90 degrees
 ";
 
 pub enum InputAction {
@@ -1115,6 +1121,7 @@ pub enum InputAction {
 	Search(String),
 	QuitApp,
 	Invert,
+	Rotate,
 	Fullscreen,
 	SwitchRenderZoom(crate::FitOrFill)
 }