dxpdf 0.8.1

Fast DOCX-to-PDF converter powered by Skia
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

#[cfg(feature = "capi")]
mod capi;
pub mod docx;
pub mod error;
pub mod field;
pub mod i18n;
pub mod model;
pub mod render;

pub use error::Error;
pub use render::{RenderOptions, DEFAULT_IMAGE_DPI, MIN_IMAGE_DPI};

/// Convert raw DOCX bytes into PDF bytes using default [`RenderOptions`].
pub fn convert(docx_bytes: &[u8]) -> Result<Vec<u8>, Error> {
    convert_with_options(docx_bytes, &RenderOptions::default())
}

/// Convert raw DOCX bytes into PDF bytes with caller-supplied [`RenderOptions`]
/// (e.g. a non-default embedded-image DPI).
pub fn convert_with_options(docx_bytes: &[u8], options: &RenderOptions) -> Result<Vec<u8>, Error> {
    use std::time::Instant;

    let t0 = Instant::now();
    let document = crate::docx::parse(docx_bytes)?;
    log::debug!("Parse:  {:?}", t0.elapsed());

    let t1 = Instant::now();
    let pdf_bytes = crate::render::render(document, options)?;
    log::debug!("Render: {:?}", t1.elapsed());

    log::debug!("Total:  {:?}", t0.elapsed());
    Ok(pdf_bytes)
}

// --- Python bindings (enabled with `python` feature) ---

#[cfg(feature = "python")]
mod python {
    use pyo3::exceptions::PyRuntimeError;
    use pyo3::prelude::*;

    /// Convert DOCX bytes to PDF bytes.
    ///
    /// `image_dpi` sets the target resolution (pixels per inch) embedded raster
    /// images are downsampled to; defaults to 220. Releases the GIL for the
    /// duration of the conversion, so callers can run this on a background
    /// thread rather than needing a subprocess.
    #[pyfunction]
    #[pyo3(signature = (docx_bytes, image_dpi = crate::DEFAULT_IMAGE_DPI))]
    fn convert(py: Python<'_>, docx_bytes: &[u8], image_dpi: f32) -> PyResult<Vec<u8>> {
        // Copied out while the GIL is held: `docx_bytes` zero-copy-borrows a
        // Python-owned buffer, and releasing the GIL below lets another thread
        // mutate or free it (e.g. a `bytearray`) out from under a borrow.
        let docx_bytes = docx_bytes.to_vec();
        py.detach(|| {
            let options = crate::RenderOptions::default().with_image_dpi(image_dpi);
            crate::convert_with_options(&docx_bytes, &options)
                .map_err(|e| PyRuntimeError::new_err(e.to_string()))
        })
    }

    /// Convert a DOCX file to a PDF file.
    ///
    /// `image_dpi` sets the target resolution (pixels per inch) embedded raster
    /// images are downsampled to; defaults to 220. Releases the GIL for the
    /// duration of the read, conversion and write, so callers can run this on
    /// a background thread rather than needing a subprocess.
    #[pyfunction]
    #[pyo3(signature = (input, output, image_dpi = crate::DEFAULT_IMAGE_DPI))]
    fn convert_file(py: Python<'_>, input: &str, output: &str, image_dpi: f32) -> PyResult<()> {
        // Copied out while the GIL is held, same reasoning as in `convert`.
        let input = input.to_owned();
        let output = output.to_owned();
        py.detach(|| {
            let docx_bytes = std::fs::read(&input)
                .map_err(|e| PyRuntimeError::new_err(format!("Failed to read {input}: {e}")))?;
            let options = crate::RenderOptions::default().with_image_dpi(image_dpi);
            let pdf_bytes = crate::convert_with_options(&docx_bytes, &options)
                .map_err(|e| PyRuntimeError::new_err(e.to_string()))?;
            std::fs::write(&output, &pdf_bytes)
                .map_err(|e| PyRuntimeError::new_err(format!("Failed to write {output}: {e}")))
        })
    }

    /// A fast DOCX-to-PDF converter powered by Skia.
    #[pymodule]
    fn dxpdf(m: &Bound<'_, PyModule>) -> PyResult<()> {
        m.add_function(wrap_pyfunction!(convert, m)?)?;
        m.add_function(wrap_pyfunction!(convert_file, m)?)?;
        Ok(())
    }
}