mirror of
https://github.com/itsjunetime/tdf.git
synced 2026-06-01 23:51:46 -04:00
Rewrite with mupdf as a backend (#50)
* Initial implementation of attempted mupdf rewrite * Change back to no resizing and don't include alpha channel in conversion * Remove some more dead code * Make features more modular and call search more easily * Switch to git dependency for my fixes * Update deps * Fix searching hehe * Remove unnecessary CI steps? * fontconfig in CI * perftools in ci * Final adjustments to conform to mupdf changes
This commit is contained in:
June
GitHub
@@ -26,25 +26,7 @@ jobs:
|
||||
- name: Install build dependencies
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y cmake libjpeg-dev libfontconfig1-dev libopenjp2-7-dev libopenjpip7 libopenjp2-7 libglib2.0-dev libnss3-dev libunwind-dev libgoogle-perftools-dev libboost-dev
|
||||
- name: Build newer poppler
|
||||
run: |
|
||||
wget https://poppler.freedesktop.org/poppler-23.10.0.tar.xz
|
||||
tar xf poppler-23.10.0.tar.xz
|
||||
cd poppler-23.10.0
|
||||
mkdir build && cd build
|
||||
cmake .. -DCMAKE_BUILD_TYPE=Release \
|
||||
-DCMAKE_C_COMPILER_LAUNCHER=sccache \
|
||||
-DCMAKE_CXX_COMPILER_LAUNCHER=sccache \
|
||||
-DENABLE_UNSTABLE_API_ABI_HEADERS=ON \
|
||||
-DENABLE_GPGME=OFF \
|
||||
-DENABLE_QT5=OFF \
|
||||
-DENABLE_QT6=OFF \
|
||||
-DENABLE_SPLASH=OFF \
|
||||
-DENABLE_LIBCURL=OFF
|
||||
make -j$(nproc)
|
||||
sudo make install
|
||||
sudo ldconfig
|
||||
sudo apt-get install -y libfontconfig1-dev libgoogle-perftools-dev google-perftools
|
||||
- uses: actions/checkout@v4
|
||||
- name: Clippy
|
||||
run: cargo clippy -- -D warnings
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
|
||||
- Update ratatui(-image) dependencies
|
||||
- Enable Ctrl+Z/Suspend functionality
|
||||
- Rewrite with mupdf as the backend for much better performance and rendering quality
|
||||
|
||||
# v0.2.0
|
||||
|
||||
|
||||
Generated
+590
-384
File diff suppressed because it is too large
Load Diff
+10
-6
@@ -7,7 +7,7 @@ description = "A terminal viewer for PDFs"
|
||||
readme = "README.md"
|
||||
homepage = "https://github.com/itsjunetime/tdf"
|
||||
repository = "https://github.com/itsjunetime/tdf"
|
||||
license = "GPL-3.0-or-later"
|
||||
license = "AGPL-3.0-only"
|
||||
keywords = ["pdf", "tui", "cli", "terminal"]
|
||||
categories = ["command-line-utilities", "text-processing", "visualization"]
|
||||
default-run = "tdf"
|
||||
@@ -21,25 +21,24 @@ path = "src/main.rs"
|
||||
name = "tdf"
|
||||
|
||||
[dependencies]
|
||||
poppler-rs = { version = "0.24.1", default-features = false, features = ["v23_7"] }
|
||||
cairo-rs = { version = "0.20.0", default-features = false, features = ["png"] }
|
||||
# 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 = { 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 Box<dyn ratatui_image::Protocol>. It also just includes a few more features that I'm waiting on main to upstream
|
||||
# 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 = { path = "./ratatui-image", features = ["vb64"], default-features = false }
|
||||
crossterm = { version = "0.28.1", features = ["event-stream"] }
|
||||
image = { version = "0.25.1", features = ["png", "rayon"], default-features = false }
|
||||
image = { version = "0.25.1", features = ["pnm", "rayon"], default-features = false }
|
||||
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 }
|
||||
glib = "0.20.0"
|
||||
itertools = "*"
|
||||
flume = { version = "0.11.0", default-features = false, features = ["async"] }
|
||||
xflags = "0.4.0-pre.2"
|
||||
mimalloc = "0.1.43"
|
||||
nix = { version = "0.29.0", features = ["signal"] }
|
||||
mupdf = { git = "https://github.com/itsjunetime/mupdf-rs", branch = "remove_debug_print", default-features = false, features = ["svg", "system-fonts", "img"] }
|
||||
rayon = { version = "*", default-features = false }
|
||||
|
||||
# for tracing with tokio-console
|
||||
console-subscriber = { version = "0.4.0", optional = true }
|
||||
@@ -52,6 +51,8 @@ lto = "fat"
|
||||
default = ["nightly"]
|
||||
nightly = ["ratatui-image/vb64"]
|
||||
tracing = ["tokio/tracing", "dep:console-subscriber"]
|
||||
epub = ["mupdf/epub"]
|
||||
cbz = ["mupdf/cbz"]
|
||||
|
||||
[dev-dependencies]
|
||||
criterion = { version = "0.5.1", features = ["async_tokio"] }
|
||||
@@ -154,3 +155,6 @@ unused_self = "warn"
|
||||
used_underscore_binding = "warn"
|
||||
used_underscore_items = "warn"
|
||||
zero_sized_map_values = "warn"
|
||||
|
||||
[patch.crates-io]
|
||||
pathfinder_simd = { git = "https://github.com/itsjunetime/pathfinder.git" }
|
||||
|
||||
@@ -1,23 +1,21 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
The GNU Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
our General Public Licenses are intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
software for all its users.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
@@ -26,44 +24,34 @@ them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
@@ -72,7 +60,7 @@ modification follow.
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
@@ -549,35 +537,45 @@ to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
under version 3 of the GNU General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
but the work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
the GNU Affero General Public License from time to time. Such new versions
|
||||
will be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Program specifies that a certain numbered version of the GNU Affero General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
GNU Affero General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
versions of the GNU Affero General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
@@ -635,40 +633,29 @@ the "copyright" line and a pointer to where the full notice is found.
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
it under the terms of the GNU Affero General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
GNU Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
If your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
@@ -14,7 +14,7 @@ Designed to be performant, very responsive, and work well with even very large P
|
||||
- Reactive layout
|
||||
|
||||
## To Build
|
||||
First, you need to install the system dependencies. This includes packages such as (but not limited to) `cairo`, `gtk`, and `poppler`. If you're on linux, these will probably show up in your package manager as something like `libcairo-devel` or `cairo-dev`.
|
||||
First, you need to install the system dependencies. This will generally only include `libfontconfig`. If you're on linux, these will probably show up in your package manager as something like `libfontconfig1-devel` or `libfontconfig-dev`.
|
||||
|
||||
If it turns out that you're missing one of these, it will fail to compile and tell you what library you're missing. Find the development package for that library in your package manager, install it, and try to build again. Now, the important steps:
|
||||
|
||||
@@ -30,4 +30,4 @@ I dunno. Just for fun, mostly.
|
||||
|
||||
Yeah, sure. Please do.
|
||||
|
||||
Please note, though, that all contributions will be treated as licensed under MPL-2.0. This is so that we can relicense to MPL-2.0 at some point in the future if we manage to move away from poppler as a backend (since that is the only dependency, at time of writing, which requires the GPLv3 license).
|
||||
Please note, though, that all contributions will be treated as licensed under MPL-2.0.
|
||||
|
||||
@@ -97,7 +97,7 @@ async fn render_all_files(path: &'static str) -> Vec<PageInfo> {
|
||||
RenderInfo::Reloaded => (),
|
||||
RenderInfo::NumPages(num) => fill_default(&mut pages, num),
|
||||
RenderInfo::Page(page) => {
|
||||
let num = page.page;
|
||||
let num = page.page_num;
|
||||
pages[num] = Some(page);
|
||||
}
|
||||
};
|
||||
|
||||
+1
-1
@@ -63,7 +63,7 @@ pub fn start_rendering_loop(
|
||||
Sender<RenderNotif>
|
||||
) {
|
||||
let pathbuf = path.as_ref().canonicalize().unwrap();
|
||||
let str_path = format!("file://{}", pathbuf.into_os_string().to_string_lossy());
|
||||
let str_path = pathbuf.into_os_string().to_string_lossy().to_string();
|
||||
|
||||
let (to_render_tx, from_main_rx) = unbounded();
|
||||
let (to_main_tx, from_render_rx) = unbounded();
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
# 1. Pull the git source of poppler
|
||||
# 2. cd poppler
|
||||
# 3. git checkout poppler-23.07.0
|
||||
# 4. mkdir build
|
||||
# 5. cd build
|
||||
# 6. cmake .. -DENABLE_GPGME=OFF -DENABLE_QT5=OFF -DENABLE_QT6=OFF -DENABLE_BOOST=OFF -DBUILD_SHARED_LIBS=OFF
|
||||
# 7. cmake --build . --parallel $(nproc)
|
||||
env SYSTEM_DEPS_POPPLER_GLIB_LINK=static \
|
||||
SYSTEM_DEPS_POPPLER_GLIB_NO_PKG_CONFIG=1 \
|
||||
SYSTEM_DEPS_POPPLER_GLIB_SEARCH_NATIVE=/path/to/poppler/build/glib \
|
||||
SYSTEM_DEPS_POPPLER_GLIB_LIB=poppler-glib \
|
||||
cargo perf --bin for_profiling --
|
||||
+24
-11
@@ -1,8 +1,9 @@
|
||||
use flume::{Receiver, SendError, Sender, TryRecvError};
|
||||
use futures_util::stream::StreamExt;
|
||||
use image::ImageFormat;
|
||||
use image::DynamicImage;
|
||||
use itertools::Itertools;
|
||||
use ratatui_image::{picker::Picker, protocol::Protocol, Resize};
|
||||
use rayon::iter::ParallelIterator;
|
||||
|
||||
use crate::renderer::{fill_default, PageInfo, RenderError};
|
||||
|
||||
@@ -54,13 +55,25 @@ pub async fn run_conversion_loop(
|
||||
return Ok(None);
|
||||
};
|
||||
|
||||
let img_area = page_info.img_data.area;
|
||||
let mut dyn_img = image::load_from_memory_with_format(
|
||||
&page_info.img_data.pixels,
|
||||
image::ImageFormat::Pnm
|
||||
)
|
||||
.map_err(|e| RenderError::Converting(format!("Can't load image: {e}")))?;
|
||||
|
||||
let dyn_img =
|
||||
image::load_from_memory_with_format(&page_info.img_data.data, ImageFormat::Png)
|
||||
.map_err(|e| {
|
||||
RenderError::Render(format!("Couldn't convert Vec<u8> to DynamicImage: {e}"))
|
||||
})?;
|
||||
match dyn_img {
|
||||
DynamicImage::ImageRgb8(ref mut img) =>
|
||||
for quad in &*page_info.result_rects {
|
||||
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 = page_info.img_data.cell_area;
|
||||
|
||||
// We don't actually want to Crop this image, but we've already
|
||||
// verified (with the ImageSurface stuff) that the image is the correct
|
||||
@@ -69,7 +82,7 @@ pub async fn run_conversion_loop(
|
||||
let txt_img = picker
|
||||
.new_protocol(dyn_img, img_area, Resize::None)
|
||||
.map_err(|e| {
|
||||
RenderError::Render(format!(
|
||||
RenderError::Converting(format!(
|
||||
"Couldn't convert DynamicImage to ratatui image: {e}"
|
||||
))
|
||||
})?;
|
||||
@@ -79,15 +92,15 @@ pub async fn run_conversion_loop(
|
||||
|
||||
Ok(Some(ConvertedPage {
|
||||
page: txt_img,
|
||||
num: page_info.page,
|
||||
num_results: page_info.search_results
|
||||
num: page_info.page_num,
|
||||
num_results: page_info.result_rects.len()
|
||||
}))
|
||||
}
|
||||
|
||||
fn handle_notif(msg: ConverterMsg, images: &mut Vec<Option<PageInfo>>, page: &mut usize) {
|
||||
match msg {
|
||||
ConverterMsg::AddImg(img) => {
|
||||
let page_num = img.page;
|
||||
let page_num = img.page_num;
|
||||
images[page_num] = Some(img);
|
||||
}
|
||||
ConverterMsg::NumPages(n_pages) => {
|
||||
|
||||
+4
-14
@@ -13,7 +13,6 @@ use crossterm::{
|
||||
}
|
||||
};
|
||||
use futures_util::{stream::StreamExt, FutureExt};
|
||||
use glib::{LogField, LogLevel, LogWriterOutput};
|
||||
use notify::{Event, EventKind, RecursiveMode, Watcher};
|
||||
use ratatui::{backend::CrosstermBackend, Terminal};
|
||||
use ratatui_image::picker::Picker;
|
||||
@@ -80,8 +79,8 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
|
||||
)?;
|
||||
|
||||
// TODO: Handle non-utf8 file names? Maybe by constructing a CString and passing that in to the
|
||||
// poppler stuff instead of a rust string?
|
||||
let file_path = format!("file://{}", path.clone().into_os_string().to_string_lossy());
|
||||
// mupdf stuff instead of a rust string?
|
||||
let file_path = path.clone().into_os_string().to_string_lossy().to_string();
|
||||
|
||||
let mut window_size = window_size()?;
|
||||
|
||||
@@ -161,11 +160,6 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
|
||||
let mut term = Terminal::new(backend)?;
|
||||
term.skip_diff(true);
|
||||
|
||||
// poppler has some annoying logging (e.g. if you request a page index out-of-bounds of a
|
||||
// document's pages, then it will return `None`, but still log to stderr with CRITICAL level),
|
||||
// so we want to just ignore all logging since this is a tui app.
|
||||
glib::log_set_writer_func(noop);
|
||||
|
||||
execute!(
|
||||
term.backend_mut(),
|
||||
EnterAlternateScreen,
|
||||
@@ -208,7 +202,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
|
||||
to_converter.send(ConverterMsg::NumPages(num))?;
|
||||
},
|
||||
RenderInfo::Page(info) => {
|
||||
tui.got_num_results_on_page(info.page, info.search_results);
|
||||
tui.got_num_results_on_page(info.page_num, info.result_rects.len());
|
||||
to_converter.send(ConverterMsg::AddImg(info))?;
|
||||
},
|
||||
RenderInfo::Reloaded => tui.set_msg(MessageSetting::Some(BottomMessage::Reloaded)),
|
||||
@@ -275,7 +269,7 @@ fn on_notify_ev(
|
||||
match ev.kind {
|
||||
EventKind::Access(_) => (),
|
||||
EventKind::Remove(_) => to_tui_tx
|
||||
.send(Err(RenderError::Render("File was deleted".into())))
|
||||
.send(Err(RenderError::Converting("File was deleted".into())))
|
||||
.unwrap(),
|
||||
// This shouldn't fail to send unless the receiver gets disconnected. If that's
|
||||
// happened, then like the main thread has panicked or something, so it doesn't matter
|
||||
@@ -286,7 +280,3 @@ fn on_notify_ev(
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn noop(_: LogLevel, _: &[LogField<'_>]) -> LogWriterOutput {
|
||||
LogWriterOutput::Handled
|
||||
}
|
||||
|
||||
+114
-142
@@ -1,10 +1,9 @@
|
||||
use std::thread;
|
||||
use std::{thread::sleep, time::Duration};
|
||||
|
||||
use cairo::{Antialias, Context, Format, Surface};
|
||||
use crossterm::terminal::WindowSize;
|
||||
use flume::{Receiver, SendError, Sender, TryRecvError};
|
||||
use itertools::Itertools;
|
||||
use poppler::{Color, Document, FindFlags, Page, Rectangle, SelectionStyle};
|
||||
use mupdf::{Colorspace, Document, Matrix, Page, Pixmap};
|
||||
use ratatui::layout::Rect;
|
||||
|
||||
pub enum RenderNotif {
|
||||
@@ -17,10 +16,8 @@ pub enum RenderNotif {
|
||||
#[derive(Debug)]
|
||||
pub enum RenderError {
|
||||
Notify(notify::Error),
|
||||
Doc(glib::Error),
|
||||
// Don't like storing an error as a string but it needs to be Send to send to the main thread,
|
||||
// and it's just going to be shown to the user, so whatever
|
||||
Render(String)
|
||||
Doc(mupdf::error::Error),
|
||||
Converting(String)
|
||||
}
|
||||
|
||||
pub enum RenderInfo {
|
||||
@@ -32,14 +29,14 @@ pub enum RenderInfo {
|
||||
#[derive(Clone)]
|
||||
pub struct PageInfo {
|
||||
pub img_data: ImageData,
|
||||
pub page: usize,
|
||||
pub search_results: usize
|
||||
pub page_num: usize,
|
||||
pub result_rects: Vec<HighlightRect>
|
||||
}
|
||||
|
||||
#[derive(Clone)]
|
||||
pub struct ImageData {
|
||||
pub data: Vec<u8>,
|
||||
pub area: Rect
|
||||
pub pixels: Vec<u8>,
|
||||
pub cell_area: Rect
|
||||
}
|
||||
|
||||
#[derive(Default)]
|
||||
@@ -56,7 +53,7 @@ pub fn fill_default<T: Default>(vec: &mut Vec<T>, size: usize) {
|
||||
}
|
||||
}
|
||||
|
||||
// this function has to be sync (non-async) because the poppler::Document needs to be held during
|
||||
// this function has to be sync (non-async) because the mupdf::Document needs to be held during
|
||||
// most of it, but that's basically just a wrapper around `*c_void` cause it's just a binding to C
|
||||
// code, so it's !Send and thus can't be held across await points. So we can't call any of the
|
||||
// async `send` or `recv` methods in this function body, since those create await points. Which
|
||||
@@ -71,7 +68,7 @@ pub fn fill_default<T: Default>(vec: &mut Vec<T>, size: usize) {
|
||||
#[allow(clippy::needless_pass_by_value)]
|
||||
pub fn start_rendering(
|
||||
path: &str,
|
||||
mut sender: Sender<Result<RenderInfo, RenderError>>,
|
||||
sender: Sender<Result<RenderInfo, RenderError>>,
|
||||
receiver: Receiver<RenderNotif>,
|
||||
size: WindowSize
|
||||
) -> Result<(), SendError<Result<RenderInfo, RenderError>>> {
|
||||
@@ -95,7 +92,7 @@ pub fn start_rendering(
|
||||
let mut stored_doc = None;
|
||||
|
||||
'reload: loop {
|
||||
let doc = match Document::from_file(path, None) {
|
||||
let doc = match Document::open(path) {
|
||||
Err(e) => {
|
||||
// if there's an error, tell the main loop
|
||||
sender.send(Err(RenderError::Doc(e)))?;
|
||||
@@ -125,7 +122,16 @@ pub fn start_rendering(
|
||||
}
|
||||
};
|
||||
|
||||
let n_pages = doc.n_pages() as usize;
|
||||
let n_pages = match doc.page_count() {
|
||||
Ok(n) => n as usize,
|
||||
Err(e) => {
|
||||
sender.send(Err(RenderError::Doc(e)))?;
|
||||
// just basic backoff i think
|
||||
sleep(Duration::from_secs(1));
|
||||
continue 'reload;
|
||||
}
|
||||
};
|
||||
|
||||
sender.send(Ok(RenderInfo::NumPages(n_pages)))?;
|
||||
|
||||
// We're using this vec of bools to indicate which page numbers have already been rendered,
|
||||
@@ -205,8 +211,8 @@ pub fn start_rendering(
|
||||
.map(|(idx, p)| (start_point - (idx + 1), p))
|
||||
);
|
||||
|
||||
let area_w = f64::from(area.width) * f64::from(col_w);
|
||||
let area_h = f64::from(area.height) * f64::from(col_h);
|
||||
let area_w = f32::from(area.width) * f32::from(col_w);
|
||||
let area_h = f32::from(area.height) * f32::from(col_h);
|
||||
|
||||
// we go through each page
|
||||
for (num, rendered) in page_iter {
|
||||
@@ -230,12 +236,12 @@ pub fn start_rendering(
|
||||
|
||||
// We know this is in range 'cause we're iterating over it but we still just want
|
||||
// to be safe
|
||||
let Some(page) = doc.page(num as i32) else {
|
||||
sender.send(Err(RenderError::Render(format!(
|
||||
"Couldn't get page {num} ({}) of doc?",
|
||||
num as i32
|
||||
))))?;
|
||||
continue;
|
||||
let page = match doc.load_page(num as i32) {
|
||||
Err(e) => {
|
||||
sender.send(Err(RenderError::Doc(e)))?;
|
||||
continue;
|
||||
}
|
||||
Ok(p) => p
|
||||
};
|
||||
|
||||
let rendered_with_no_results =
|
||||
@@ -257,26 +263,34 @@ pub fn start_rendering(
|
||||
// we make a potentially incorrect assumption here that writing the context
|
||||
// to a png won't fail, and mark that it all rendered correctly here before
|
||||
// spawning off the thread to do so and send it.
|
||||
rendered.contained_term = Some(ctx.num_results > 0);
|
||||
rendered.contained_term = Some(ctx.result_rects.is_empty());
|
||||
rendered.successful = true;
|
||||
|
||||
// if this is the page that the user is currently trying to look at, don't
|
||||
// bother spawning off a thread to render it to a png - it'll only slow
|
||||
// down the time til the user can see it (due to the overhead of creating a
|
||||
// thread), but we still want to spawn threads to render the other pages
|
||||
// since the effects of parallelizing that will be noticeable if the user
|
||||
// tries to move through pages more quickly
|
||||
if num == start_point {
|
||||
render_ctx_to_png(&ctx, &mut sender, (col_w, col_h), num)?;
|
||||
} else {
|
||||
let mut sender = sender.clone();
|
||||
thread::spawn(move || {
|
||||
render_ctx_to_png(&ctx, &mut sender, (col_w, col_h), num)
|
||||
});
|
||||
}
|
||||
let cap = (ctx.pixmap.width()
|
||||
* ctx.pixmap.height() * u32::from(ctx.pixmap.n()))
|
||||
as usize;
|
||||
let mut pixels = Vec::with_capacity(cap);
|
||||
if let Err(e) = ctx.pixmap.write_to(&mut pixels, mupdf::ImageFormat::PNM) {
|
||||
sender.send(Err(RenderError::Doc(e)))?;
|
||||
continue;
|
||||
};
|
||||
|
||||
sender.send(Ok(RenderInfo::Page(PageInfo {
|
||||
img_data: ImageData {
|
||||
pixels,
|
||||
cell_area: Rect {
|
||||
x: 0,
|
||||
y: 0,
|
||||
width: (ctx.surface_w / f32::from(col_w)) as u16,
|
||||
height: (ctx.surface_h / f32::from(col_h)) as u16
|
||||
}
|
||||
},
|
||||
page_num: num,
|
||||
result_rects: ctx.result_rects
|
||||
})))?;
|
||||
}
|
||||
// And if we got an error, then obviously we need to propagate that
|
||||
Err(e) => sender.send(Err(RenderError::Render(e)))?
|
||||
Err(e) => sender.send(Err(RenderError::Doc(e)))?
|
||||
}
|
||||
}
|
||||
|
||||
@@ -295,34 +309,37 @@ pub fn start_rendering(
|
||||
}
|
||||
|
||||
struct RenderedContext {
|
||||
surface: Surface,
|
||||
num_results: usize,
|
||||
surface_width: f64,
|
||||
surface_height: f64
|
||||
pixmap: Pixmap,
|
||||
surface_w: f32,
|
||||
surface_h: f32,
|
||||
result_rects: Vec<HighlightRect>
|
||||
}
|
||||
|
||||
/// SAFETY: I think this is safe because, although the backing struct for `Surface` does contain
|
||||
/// pointers to like the cairo_backend_t struct that all the cairo stuff is using, that struct is
|
||||
/// basically just a vtable, so accessing it from multiple threads *should* be safe since we're
|
||||
/// just calling the same functions with different data. The only other thing it holds reference to
|
||||
/// is a `cairo_device_t`, but that seems to be thread-safe because it's managed through ref counts
|
||||
/// and a mutex. Also, as far as I can tell from reading the source code, write_to_png_stream (the
|
||||
/// only function we call on this struct) doesn't access the device at all, so we should be fine
|
||||
/// there.
|
||||
/// We want this to be Send so that we can delegate the png writing to a separate thread (since
|
||||
/// that's the thing that takes the most time, by far, in this app).
|
||||
unsafe impl Send for RenderedContext {}
|
||||
|
||||
fn render_single_page_to_ctx(
|
||||
page: &Page,
|
||||
search_term: Option<&str>,
|
||||
already_rendered_no_results: bool,
|
||||
(area_w, area_h): (f64, f64)
|
||||
) -> Result<Option<RenderedContext>, String> {
|
||||
let mut result_rects = search_term
|
||||
.as_ref()
|
||||
.map(|term| page.find_text_with_options(term, FindFlags::DEFAULT | FindFlags::MULTILINE))
|
||||
.unwrap_or_default();
|
||||
(area_w, area_h): (f32, f32)
|
||||
) -> Result<Option<RenderedContext>, mupdf::error::Error> {
|
||||
let mut max_hits = 10;
|
||||
let result_rects = loop {
|
||||
let rects = search_term
|
||||
.as_ref()
|
||||
// mupdf allocates a buffer of the size we give it to try to fill it with results. If we
|
||||
// pass in u32::MAX, it allocates too much memory to function. If we pass too small of a
|
||||
// number in, we may miss out on some of the results. Ideally, we'd like to make a better
|
||||
// interface than this, but we're stuck with this kinda ugly looping until we make sure
|
||||
// that we've found every instance of it on this page.
|
||||
.map(|term| page.search(term, max_hits))
|
||||
.transpose()?
|
||||
.unwrap_or_default();
|
||||
|
||||
if rects.len() < (max_hits as usize) {
|
||||
break rects;
|
||||
}
|
||||
|
||||
max_hits *= 2;
|
||||
};
|
||||
|
||||
// If there are no search terms on this page, and we've already rendered it with no search
|
||||
// terms, then just return none to avoid this computation
|
||||
@@ -331,7 +348,8 @@ fn render_single_page_to_ctx(
|
||||
}
|
||||
|
||||
// then, get the size of the page
|
||||
let (p_width, p_height) = page.size();
|
||||
let bounds = page.bounds()?;
|
||||
let (p_width, p_height) = (bounds.x1 - bounds.x0, bounds.y1 - bounds.y0);
|
||||
|
||||
// and get its aspect ratio
|
||||
let p_aspect_ratio = p_width / p_height;
|
||||
@@ -353,93 +371,47 @@ fn render_single_page_to_ctx(
|
||||
area_h / p_height
|
||||
};
|
||||
|
||||
let surface_width = p_width * scale_factor;
|
||||
let surface_height = p_height * scale_factor;
|
||||
let surface_w = p_width * scale_factor;
|
||||
let surface_h = p_height * scale_factor;
|
||||
|
||||
let surface = cairo::ImageSurface::create(
|
||||
Format::Rgb16_565,
|
||||
// No matter how big you make these arguments, the image will be drawn at the same
|
||||
// size. So if you make them really big, the image will be drawn on a quarter of it. If
|
||||
// you make them really small, the image will cover more than all of the surface.
|
||||
//
|
||||
// However, that only stands as long as you don't scale the context that you place this
|
||||
// surface into. If you scale the dimensions of this image by n, then scale the context
|
||||
// by that same amount, then it'll still fit perfectly into the context, but be
|
||||
// rendered at higher quality.
|
||||
surface_width as i32,
|
||||
surface_height as i32
|
||||
)
|
||||
.map_err(|e| format!("Couldn't create ImageSurface: {e}"))?;
|
||||
surface.set_device_scale(scale_factor, scale_factor);
|
||||
let colorspace = Colorspace::device_rgb();
|
||||
let matrix = Matrix::new_scale(scale_factor, scale_factor);
|
||||
|
||||
let ctx = Context::new(surface).map_err(|e| format!("Couldn't create Context: {e}"))?;
|
||||
let mut pixmap = page.to_pixmap(&matrix, &colorspace, 0.0, false)?;
|
||||
|
||||
// The default background color of PDFs (at least, I think) is white, so we need to set
|
||||
// that as the background color, then paint, then render.
|
||||
ctx.set_source_rgba(1.0, 1.0, 1.0, 1.0);
|
||||
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);
|
||||
|
||||
ctx.set_antialias(Antialias::None);
|
||||
ctx.paint()
|
||||
.map_err(|e| format!("Couldn't paint Context: {e}"))?;
|
||||
page.render(&ctx);
|
||||
|
||||
let num_results = result_rects.len();
|
||||
|
||||
if !result_rects.is_empty() {
|
||||
let mut highlight_color = Color::new();
|
||||
highlight_color.set_red((u16::MAX / 5) * 4);
|
||||
highlight_color.set_green((u16::MAX / 5) * 4);
|
||||
|
||||
let mut old_rect = Rectangle::new();
|
||||
for rect in &mut result_rects {
|
||||
// According to https://gitlab.freedesktop.org/poppler/poppler/-/issues/763, these rects
|
||||
// need to be corrected since they use different references as the y-coordinate base
|
||||
rect.set_y1(p_height - rect.y1());
|
||||
rect.set_y2(p_height - rect.y2());
|
||||
|
||||
page.render_selection(
|
||||
&ctx,
|
||||
rect,
|
||||
&mut old_rect,
|
||||
SelectionStyle::Glyph,
|
||||
&mut Color::new(),
|
||||
&mut highlight_color
|
||||
);
|
||||
}
|
||||
}
|
||||
let result_rects = result_rects
|
||||
.into_iter()
|
||||
.map(|quad| {
|
||||
let ul_x = (quad.ul.x * scale_factor) as u32;
|
||||
let ul_y = (quad.ul.y * scale_factor) as u32;
|
||||
let lr_x = (quad.lr.x * scale_factor) as u32;
|
||||
let lr_y = (quad.lr.y * scale_factor) as u32;
|
||||
HighlightRect {
|
||||
ul_x,
|
||||
ul_y,
|
||||
lr_x,
|
||||
lr_y
|
||||
}
|
||||
})
|
||||
.collect::<Vec<_>>();
|
||||
|
||||
Ok(Some(RenderedContext {
|
||||
surface: ctx.target(),
|
||||
num_results,
|
||||
surface_width,
|
||||
surface_height
|
||||
pixmap,
|
||||
surface_w,
|
||||
surface_h,
|
||||
result_rects
|
||||
}))
|
||||
}
|
||||
|
||||
fn render_ctx_to_png(
|
||||
ctx: &RenderedContext,
|
||||
sender: &mut Sender<Result<RenderInfo, RenderError>>,
|
||||
(col_w, col_h): (u16, u16),
|
||||
page: usize
|
||||
) -> Result<(), SendError<Result<RenderInfo, RenderError>>> {
|
||||
let mut img_data = Vec::with_capacity((ctx.surface_height * ctx.surface_width) as usize);
|
||||
|
||||
match ctx.surface.write_to_png(&mut img_data) {
|
||||
Err(e) => sender.send(Err(RenderError::Render(format!(
|
||||
"Couldn't write surface to png: {e}"
|
||||
)))),
|
||||
Ok(()) => sender.send(Ok(RenderInfo::Page(PageInfo {
|
||||
img_data: ImageData {
|
||||
data: img_data,
|
||||
area: Rect {
|
||||
width: ctx.surface_width as u16 / col_w,
|
||||
height: ctx.surface_height as u16 / col_h,
|
||||
x: 0,
|
||||
y: 0
|
||||
}
|
||||
},
|
||||
page,
|
||||
search_results: ctx.num_results
|
||||
})))
|
||||
}
|
||||
#[derive(Clone)]
|
||||
pub struct HighlightRect {
|
||||
pub ul_x: u32,
|
||||
pub ul_y: u32,
|
||||
pub lr_x: u32,
|
||||
pub lr_y: u32
|
||||
}
|
||||
|
||||
+2
-2
@@ -569,8 +569,8 @@ impl Tui {
|
||||
pub fn show_error(&mut self, err: RenderError) {
|
||||
self.set_msg(MessageSetting::Some(BottomMessage::Error(match err {
|
||||
RenderError::Notify(e) => format!("Auto-reload failed: {e}"),
|
||||
RenderError::Doc(e) => format!("Couldn't open document: {e}"),
|
||||
RenderError::Render(e) => format!("Couldn't render page: {e}")
|
||||
RenderError::Doc(e) => format!("Couldn't process document: {e}"),
|
||||
RenderError::Converting(e) => format!("Couldn't convert page after rendering: {e}")
|
||||
})));
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user