cdanesi/tdf
1
0
Fork 0
mirror of https://github.com/itsjunetime/tdf.git synced 2026-06-01 23:51:46 -04:00
Code Issues Packages Projects Releases Wiki Activity

- Added more lints to Cargo.toml (for fun I guess)

Browse Source 
- Extended benchmarking system to check all protocols, not just kitty
- Updated deps
This commit is contained in:
itsjunetime
2025-11-26 12:25:56 -06:00
parent 74def1c0a8
commit 8f57cd02c3
12 changed files with 343 additions and 193 deletions
Download Patch File Download Diff File Expand all files Collapse all files
benches/for_profiling.rs
+3 -1
View File
@@ -1,3 +1,5 @@
use ratatui_image::picker::ProtocolType;
mod utils;
const BLACK: i32 = 0;
@@ -12,5 +14,5 @@ async fn main() {
.nth(1)
.expect("Please enter a file to profile");
utils::render_doc(file, None, BLACK, WHITE).await;
utils::render_doc(file, None, BLACK, WHITE, ProtocolType::Kitty).await;
}
benches/rendering.rs
+82 -66
View File
@@ -1,17 +1,15 @@
mod utils;
use std::{
hint::black_box,
path::Path,
time::{SystemTime, UNIX_EPOCH}
};
use std::{hint::black_box, path::Path};
use criterion::{BenchmarkId, Criterion, criterion_group, criterion_main, profiler::Profiler};
use futures_util::StreamExt;
use criterion::{BenchmarkId, Criterion, criterion_group, criterion_main};
use futures_util::StreamExt as _;
use ratatui_image::picker::ProtocolType;
use tdf::{
converter::{ConvertedPage, ConverterMsg},
renderer::{PageInfo, RenderInfo, fill_default}
};
use tokio::runtime::Runtime;
use utils::{
RenderState, handle_converter_msg, handle_renderer_msg, render_doc, start_all_rendering,
start_converting_loop, start_rendering_loop
@@ -23,90 +21,103 @@ const FILES: [&str; 3] = [
"benches/geotopo.pdf"
];
const PROTOS: [ProtocolType; 3] = [
ProtocolType::Kitty,
ProtocolType::Sixel,
ProtocolType::Iterm2
];
const BLACK: i32 = 0;
const WHITE: i32 = i32::from_be_bytes([0, 0xff, 0xff, 0xff]);
fn render_full(c: &mut Criterion) {
for file in FILES {
c.bench_with_input(BenchmarkId::new("render_full", file), &file, |b, &file| {
b.to_async(tokio::runtime::Runtime::new().unwrap())
.iter(|| render_doc(file, None, BLACK, WHITE))
});
fn for_all_combos(
name: &'static str,
mut f: impl FnMut(&Runtime, BenchmarkId, &'static str, ProtocolType)
) {
let rt = tokio::runtime::Runtime::new().unwrap();
for proto in PROTOS {
for file in FILES {
f(
&rt,
BenchmarkId::new(name, format!("{file},{proto:?}")),
file,
proto
);
}
}
}
fn render_full(c: &mut Criterion) {
for_all_combos("render_full", |rt, id, file, proto| {
_ = c.bench_with_input(id, &file, |b, &file| {
b.to_async(rt)
.iter(|| render_doc(file, None, BLACK, WHITE, proto));
});
});
}
fn render_to_first_page(c: &mut Criterion) {
for file in FILES {
c.bench_with_input(
BenchmarkId::new("render_first_page", file),
&file,
|b, &file| {
b.to_async(tokio::runtime::Runtime::new().unwrap())
.iter(|| render_first_page(file, BLACK, WHITE))
}
);
}
for_all_combos("render_first_page", |rt, id, file, proto| {
c.bench_with_input(id, &file, |b, &file| {
b.to_async(rt)
.iter(|| render_first_page(file, BLACK, WHITE, proto));
});
});
}
fn only_converting(c: &mut Criterion) {
for file in FILES {
let runtime = tokio::runtime::Runtime::new().unwrap();
let all_rendered = runtime.block_on(render_all_files(file, BLACK, WHITE));
for_all_combos("only_converting", |rt, id, file, proto| {
let all_rendered = rt.block_on(render_all_files(file, BLACK, WHITE));
c.bench_with_input(
BenchmarkId::new("only_converting", file),
&(all_rendered, file),
|b, (rendered, _)| {
b.to_async(tokio::runtime::Runtime::new().unwrap())
.iter_with_setup(|| rendered.clone(), convert_all_files)
}
);
}
c.bench_with_input(id, &all_rendered, |b, rendered| {
b.to_async(rt)
.iter_with_setup(|| rendered.clone(), |f| convert_all_files(f, proto));
});
});
}
/*
fn search_short_common(c: &mut Criterion) {
for file in FILES {
c.bench_with_input(
BenchmarkId::new("search_short_common", file),
&file,
|b, &file| {
b.to_async(tokio::runtime::Runtime::new().unwrap())
.iter(|| render_doc(file, Some("an"), BLACK, WHITE))
}
);
}
for_all_combos("search_short_common", |rt, id, file, proto| {
c.bench_with_input(id, &file, |b, &file| {
b.to_async(rt)
.iter(|| render_doc(file, Some("an"), BLACK, WHITE, proto))
});
});
}
fn search_long_rare(c: &mut Criterion) {
for file in FILES {
c.bench_with_input(
BenchmarkId::new("search_long_rare", file),
&file,
|b, &file| {
b.to_async(tokio::runtime::Runtime::new().unwrap())
.iter(|| render_doc(file, Some("this is long and rare"), BLACK, WHITE))
}
);
}
for_all_combos("search_long_rare", |rt, id, file, proto| {
c.bench_with_input(id, &file, |b, &file| {
b.to_async(rt)
.iter(|| render_doc(file, Some("this is long and rare"), BLACK, WHITE, proto))
});
});
}
*/
pub async fn render_first_page(path: impl AsRef<Path>, black: i32, white: i32) {
pub async fn render_first_page(
path: impl AsRef<Path>,
black: i32,
white: i32,
proto: ProtocolType
) {
let RenderState {
mut from_render_rx,
mut from_converter_rx,
mut pages,
mut to_converter_tx,
to_converter_tx,
to_render_tx
} = start_all_rendering(path, black, white);
} = start_all_rendering(path, black, white, proto);
// we only want to render until the first page is ready to be printed
while pages.iter().all(Option::is_none) {
tokio::select! {
Some(renderer_msg) = from_render_rx.next() => {
handle_renderer_msg(renderer_msg, &mut pages, &mut to_converter_tx);
handle_renderer_msg(renderer_msg, &mut pages, &to_converter_tx);
},
Some(converter_msg) = from_converter_rx.next() => {
handle_converter_msg(converter_msg, &mut pages, &mut to_converter_tx);
handle_converter_msg(converter_msg, &mut pages, &to_converter_tx);
}
}
}
@@ -129,7 +140,7 @@ async fn render_all_files(path: &'static str, black: i32, white: i32) -> Vec<Pag
let num = page.page_num;
pages[num] = Some(page);
}
};
}
if pages.iter().all(Option::is_some) {
break;
@@ -140,9 +151,9 @@ async fn render_all_files(path: &'static str, black: i32, white: i32) -> Vec<Pag
pages.into_iter().flatten().collect()
}
async fn convert_all_files(files: Vec<PageInfo>) {
async fn convert_all_files(files: Vec<PageInfo>, proto: ProtocolType) {
let num_files = files.len();
let (mut from_converter_rx, to_converter_tx) = start_converting_loop(num_files);
let (mut from_converter_rx, to_converter_tx) = start_converting_loop(proto, num_files);
to_converter_tx
.send(ConverterMsg::NumPages(num_files))
@@ -181,10 +192,12 @@ async fn convert_all_files(files: Vec<PageInfo>) {
black_box(converted);
}
/*
struct CpuProfiler;
impl Profiler for CpuProfiler {
impl criterion::profiler::Profiler for CpuProfiler {
fn start_profiling(&mut self, benchmark_id: &str, _: &std::path::Path) {
use std::time::{SystemTime, UNIX_EPOCH}
let file = format!(
"./{}-{}.profile",
benchmark_id.replace('/', "-"),
@@ -200,10 +213,13 @@ impl Profiler for CpuProfiler {
cpuprofiler::PROFILER.lock().unwrap().stop().unwrap();
}
}
*/
criterion_group!(
name = benches;
config = Criterion::default().sample_size(40).with_profiler(CpuProfiler);
targets = render_full, render_to_first_page, only_converting, search_short_common, search_long_rare
// config = Criterion::default().sample_size(40).with_profiler(CpuProfiler);
config = Criterion::default().sample_size(40);
// targets = render_full, render_to_first_page, only_converting, search_short_common, search_long_rare
targets = render_full, render_to_first_page, only_converting
);
criterion_main!(benches);
benches/utils.rs
+23 -10
View File
@@ -13,7 +13,7 @@ use tdf::{
pub fn handle_renderer_msg(
msg: Result<RenderInfo, RenderError>,
pages: &mut Vec<Option<ConvertedPage>>,
to_converter_tx: &mut Sender<tdf::converter::ConverterMsg>
to_converter_tx: &Sender<tdf::converter::ConverterMsg>
) {
match msg {
Ok(RenderInfo::NumPages(num)) => {
@@ -30,7 +30,7 @@ pub fn handle_renderer_msg(
pub fn handle_converter_msg(
msg: Result<ConvertedPage, RenderError>,
pages: &mut [Option<ConvertedPage>],
to_converter_tx: &mut Sender<ConverterMsg>
to_converter_tx: &Sender<ConverterMsg>
) {
let page = msg.expect("Got error from converter");
let num = page.num;
@@ -106,7 +106,9 @@ pub fn start_rendering_loop(
(from_render_rx, to_render_tx)
}
#[must_use]
pub fn start_converting_loop(
proto: ProtocolType,
prerender: usize
) -> (
RecvStream<'static, Result<ConvertedPage, RenderError>>,
@@ -116,7 +118,7 @@ pub fn start_converting_loop(
let (to_main_tx, from_converter_rx) = unbounded();
let mut picker = Picker::from_fontsize(FONT_SIZE);
picker.set_protocol_type(ProtocolType::Kitty);
picker.set_protocol_type(proto);
tokio::spawn(run_conversion_loop(
to_main_tx,
@@ -131,9 +133,14 @@ pub fn start_converting_loop(
(from_converter_rx, to_converter_tx)
}
pub fn start_all_rendering(path: impl AsRef<Path>, black: i32, white: i32) -> RenderState {
pub fn start_all_rendering(
path: impl AsRef<Path>,
black: i32,
white: i32,
proto: ProtocolType
) -> RenderState {
let (from_render_rx, to_render_tx) = start_rendering_loop(path, black, white);
let (from_converter_rx, to_converter_tx) = start_converting_loop(20);
let (from_converter_rx, to_converter_tx) = start_converting_loop(proto, 20);
let pages: Vec<Option<ConvertedPage>> = Vec::new();
@@ -146,14 +153,20 @@ pub fn start_all_rendering(path: impl AsRef<Path>, black: i32, white: i32) -> Re
}
}
pub async fn render_doc(path: impl AsRef<Path>, search_term: Option<&str>, black: i32, white: i32) {
pub async fn render_doc(
path: impl AsRef<Path>,
search_term: Option<&str>,
black: i32,
white: i32,
proto: ProtocolType
) {
let RenderState {
mut from_render_rx,
mut from_converter_rx,
mut pages,
mut to_converter_tx,
to_converter_tx,
to_render_tx
} = start_all_rendering(path, black, white);
} = start_all_rendering(path, black, white, proto);
if let Some(term) = search_term {
to_render_tx
@@ -164,10 +177,10 @@ pub async fn render_doc(path: impl AsRef<Path>, search_term: Option<&str>, black
while pages.is_empty() || pages.iter().any(Option::is_none) {
tokio::select! {
Some(renderer_msg) = from_render_rx.next() => {
handle_renderer_msg(renderer_msg, &mut pages, &mut to_converter_tx);
handle_renderer_msg(renderer_msg, &mut pages, &to_converter_tx);
},
Some(converter_msg) = from_converter_rx.next() => {
handle_converter_msg(converter_msg, &mut pages, &mut to_converter_tx);
handle_converter_msg(converter_msg, &mut pages, &to_converter_tx);
}
}
}