Crate pdfium_render

source · [−]
Expand description

Idiomatic Rust bindings for Pdfium

pdfium-render provides an idiomatic high-level Rust interface to Pdfium, the C++ PDF library used by the Google Chromium project. With this library, you can render pages in PDF files to bitmaps, load, edit, and extract text and images from existing PDF files, and create new PDF files from scratch.

    use pdfium_render::prelude::*;

    fn export_pdf_to_jpegs(path: &str, password: Option<&str>) -> Result<(), PdfiumError> {
        // Renders each page in the given test PDF file to a separate JPEG file.

        // Bind to a Pdfium library in the same directory as our application;
        // failing that, fall back to using a Pdfium library provided by the operating system.

        let pdfium = Pdfium::new(
            Pdfium::bind_to_library(Pdfium::pdfium_platform_library_name_at_path("./"))
                .or_else(|_| Pdfium::bind_to_system_library())?,
        );

        // Open the PDF document...

        let document = pdfium.load_pdf_from_file(path, password)?;

        // ... set rendering options that will apply to all pages...

        let bitmap_render_config = PdfBitmapConfig::new()
            .set_target_width(2000)
            .set_maximum_height(2000)
            .rotate_if_landscape(PdfBitmapRotation::Degrees90, true);

        // ... then render each page to a bitmap image, saving each image to a JPEG file.

        for (index, page) in document.pages().iter().enumerate() {
            page.get_bitmap_with_config(&bitmap_render_config)?
                .as_image() // Renders this page to an Image::DynamicImage...
                .as_rgba8() // ... then converts it to an Image::Image
                .ok_or(PdfiumError::ImageError)?
                .save_with_format(
                    format!("test-page-{}.jpg", index), 
                    image::ImageFormat::Jpeg
                )
                .map_err(|_| PdfiumError::ImageError)?;
        }

        Ok(())
    }

pdfium-render binds to a Pdfium library at run-time, allowing for run-time selection of system-provided or bundled Pdfium libraries and providing idiomatic Rust error handling in situations where a Pdfium library is not available. A key advantage of binding to Pdfium at run-time rather than compile-time is that a Rust application using pdfium-render can be compiled to WASM for running in a browser alongside a WASM-packaged build of Pdfium.

pdfium-render aims to eventually provide bindings to all non-interactive functionality provided by Pdfium. This is a work in progress that will be completed by version 1.0 of this crate.

Examples

Short, commented examples that demonstrate all the major Pdfium document handling features are available at https://github.com/ajrcarey/pdfium-render/tree/master/examples. These examples demonstrate:

  • Rendering pages to bitmaps.
  • Text extraction.
  • Page object introspection.
  • Creation of new documents.
  • Document concatenation.
  • Multi-page tiled output.
  • Watermarking.
  • Thread safety.
  • Compiling to WASM.

What’s new

Version 0.7.7 adds the thread_safe crate feature. See the “Multithreading” section below.

Binding to Pdfium

pdfium-render does not include Pdfium itself. You have several options:

  • Bind to a dynamically-built Pdfium library provided by the operating system.
  • Bind to a dynamically-built Pdfium library packaged alongside your Rust executable.
  • Bind to a statically-built Pdfium library linked to your executable at compile time.

When compiling to WASM, packaging an external build of Pdfium as a separate WASM module is essential.

Dynamic linking

Binding to a dynamically-built Pdfium library is the simplest option. On Android, a system-provided libpdfium.so is packaged as part of the operating system (although recent versions of Android no longer permit user applications to access it); alternatively, you can package a pre-built dynamic library appropriate for your operating system alongside your Rust executable.

At the time of writing, the WASM builds at https://github.com/bblanchon/pdfium-binaries/releases are compiled with a non-growable WASM heap memory allocator. This means that attempting to open a PDF document longer than just a few pages will result in an unrecoverable out of memory error. The WASM builds at https://github.com/paulocoutinhox/pdfium-lib/releases are recommended as they do not have this problem.

Static linking

If you prefer link Pdfium directly into your executable at compile time, use the optional static crate feature. This enables the Pdfium::bind_to_statically_linked_library() function which binds directly to the Pdfium functions included in your executable:

    use pdfium_render::prelude::*;

    let pdfium = Pdfium::new(Pdfium::bind_to_statically_linked_library().unwrap());

As a convenience, pdfium-render can instruct cargo to link a statically-built Pdfium library for you. Set the path to the directory containing your pre-built library using the PDFIUM_STATIC_LIB_PATH environment variable when you run cargo build, like so:

    PDFIUM_STATIC_LIB_PATH="/path/containing/your/static/pdfium/library" cargo build

pdfium-render will pass the following flags to cargo:

    cargo:rustc-link-lib=static=pdfium
    cargo:rustc-link-search=native=$PDFIUM_STATIC_LIB_PATH

This saves you writing a custom build.rs yourself. If you have your own build pipeline that links Pdfium statically into your executable, simply leave the PDFIUM_STATIC_LIB_PATH environment variable unset.

Note that the path you set in PDFIUM_STATIC_LIB_PATH should not include the filename of the library itself; it should just be the path of the containing directory. You must make sure your statically-built library is named in the appropriate way for your target platform (libpdfium.a on Linux and macOS, for example) in order for the Rust compiler to locate it.

pdfium-render will not build Pdfium for you; you must build Pdfium yourself, or source a pre-built static archive from elsewhere.

Compiling to WASM

See https://github.com/ajrcarey/pdfium-render/tree/master/examples for a full example that shows how to bundle a Rust application using pdfium-render alongside a pre-built Pdfium WASM module for inspection and rendering of PDF files in a web browser.

The Pdfium::load_pdf_from_file() and Pdfium::load_pdf_from_reader() functions are not available when running in the browser. The Pdfium::load_pdf_from_bytes() function is available, and the following additional functions are provided:

  • The Pdfium::load_pdf_from_fetch() function uses the browser’s built-in fetch() API to download a URL over the network and open it as a PDF document.
  • The Pdfium::load_pdf_from_blob() function opens a PDF document from the byte data in a Javascript Blob or File object, including File objects returned from an <input type="file"> element.

The PdfDocument::save_to_file() function is not available when running in the browser. The PdfDocument::save_to_bytes() and PdfDocument::save_to_writer() functions are available, and the following additional function is provided:

  • The PdfDocument::save_to_blob() function returns the byte data for the document as a Javascript Blob object.

The following additional function is provided during rendering:

  • The PdfBitmap::as_image_data() function renders directly to a Javascript ImageData object, ready to display in an HTML <canvas> element.

Multithreading

Pdfium makes no guarantees about thread safety and should be assumed not to be thread safe. The Pdfium authors specifically recommend that parallel processing, not multi-threading, be used to process multiple documents simultaneously.

pdfium-render achieves thread safety by locking access to Pdfium behind a mutex; each thread must acquire exclusive access to this mutex in order to make any call to Pdfium. This has the effect of sequencing all calls to Pdfium as if they were single-threaded, even when using pdfium-render from multiple threads. This approach offers no performance benefit, but it ensures that Pdfium will not crash when running as part of a multi-threaded application.

An example of safely using pdfium-render as part of a multithreaded parallel iterator is available at https://github.com/ajrcarey/pdfium-render/tree/master/examples.

Optional features

This crate provides the following optional features:

  • bindings: uses cbindgen to generate Rust bindings to the Pdfium functions defined in the include/*.h files each time cargo build is run. If cbindgen or any of its dependencies are not available then the build will fail.
  • static: enables binding to a statically-linked build of Pdfium. See the “Static linking” section above.
  • thread-safe: wraps access to Pdfium behind a mutex to ensure thread-safe access to Pdfium. See the “Multithreading” section above.

The thread-safe feature is enabled by default. All other features are disabled by default.

Porting existing Pdfium code from other languages

The high-level idiomatic Rust interface provided by pdfium-render is built on top of raw FFI bindings defined in the PdfiumLibraryBindings trait. It is completely feasible to use these raw FFI bindings directly if you wish, making porting existing code that calls FPDF_* functions trivial while still gaining the benefits of late binding and WASM compatibility. For instance, the following code snippet (taken from a C++ sample):

    string test_doc = "test.pdf";

    FPDF_InitLibrary();
    FPDF_DOCUMENT doc = FPDF_LoadDocument(test_doc, NULL);
    // ... do something with doc
    FPDF_CloseDocument(doc);
    FPDF_DestroyLibrary();

would translate to the following Rust code:

    let bindings = Pdfium::bind_to_system_library().unwrap();
    
    let test_doc = "test.pdf";

    bindings.FPDF_InitLibrary();
    let doc = bindings.FPDF_LoadDocument(test_doc, None);
    // ... do something with doc
    bindings.FPDF_CloseDocument(doc);
    bindings.FPDF_DestroyLibrary();

Pdfium’s API uses three different string types: classic C-style null-terminated char arrays, UTF-8 byte arrays, and a UTF-16LE byte array type named FPDF_WIDESTRING. For functions that take a C-style string or a UTF-8 byte array, pdfium-render’s binding will take the standard Rust &str type. For functions that take an FPDF_WIDESTRING, pdfium-render exposes two functions: the vanilla FPDF_*() function that takes an FPDF_WIDESTRING, and an additional FPDF_*_str() helper function that takes a standard Rust &str and converts it internally to an FPDF_WIDESTRING before calling Pdfium. Examples of functions with additional _str() helpers include FPDFBookmark_Find(), FPDFAnnot_SetStringValue(), and FPDFText_SetText().

The PdfiumLibraryBindings::get_pdfium_utf16le_bytes_from_str() and PdfiumLibraryBindings::get_string_from_pdfium_utf16le_bytes() utility functions are provided for converting to and from FPDF_WIDESTRING in your own code.

Development status

The initial focus of this crate was on rendering pages in a PDF file; consequently, FPDF_* functions related to page rendering were prioritised. By 1.0, the functionality of all FPDF_* functions exported by all Pdfium modules will be available, with the exception of certain functions specific to interactive scripting, user interaction, and printing.

  • Releases numbered 0.4.x added support for all page rendering Pdfium functions to pdfium-render.
  • Releases numbered 0.5.x-0.6.x added support for most read-only Pdfium functions to pdfium-render.
  • Releases numbered 0.7.x aim to progressively add support for all Pdfium page object creation and editing functions to pdfium-render.
  • Releases numbered 0.8.x aim to progressively add support for all other Pdfium editing functions to pdfium-render.
  • Releases numbered 0.9.x aim to fill any remaining gaps in the high-level interface prior to 1.0.0.

By version 0.8.0, pdfium-render should provide useful coverage for the vast majority of common use cases, whether rendering existing documents or creating new ones.

There are 368 FPDF_* functions in the Pdfium API. As of version 0.7.7, 238 (65%) have bindings available in pdfium-render, with the functionality of roughly three-quarters of these available via the pdfium-render high-level interface.

If you need a binding to a Pdfium function that is not currently available, just raise an issue.

Version history

  • 0.7.7: adds the thread_safe crate feature and the accompanying example in examples/thread_safe.rs.
  • 0.7.6: adds retrieval of text settings on a character-by-character basis to the PdfPageText and PdfPageTextObject objects; adds PdfPageTextSegment and PdfPageTextChar structs to the high-level interface; adds retrieval of current transformation settings to all page objects; adds the PdfPageTextObject::scaled_font_size() function and renames PdfPageTextObject::font_size() to PdfPageTextObject::unscaled_font_size() as these names make clearer the differences between scaled and unscaled font sizes in text objects; adds bindings for all remaining FPDFText_*() functions.
  • 0.7.5: corrects a bug in error handling on Windows. See https://github.com/ajrcarey/pdfium-render/issues/24 for more information.
  • 0.7.4: adds the PdfPageGroupObject::remove_objects_from_page() function; renamed PdfPageObjects::delete_object() and PdfPageObjects::delete_object_at_index() functions to PdfPageObjects::remove_object() and PdfPageObjects::remove_object_at_index() as these names better reflect the underlying operation that occurs.
  • 0.7.3: corrects a bug in the implementation of PdfPages::append() introduced in 0.7.2.
  • 0.7.2: adds object groups for manipulating and transforming groups of page objects as if they were a single object, and the PdfPages::watermark() function for applying individualized watermarks to any or all pages in a document. Fixes a potential double-free bug in PdfFont::drop().
  • 0.7.1: adds path segment creation to the PdfPagePathObject object, convenience functions for quickly creating rectangles, ellipses, and circles, and the PdfPageObjects::add_path_object() function.
  • 0.7.0: adds PdfPermissions collection, adds document loading and saving support, adds initial creation and editing support for documents, pages, and text objects, and improves WASM document file handling.
  • 0.6.0: fixes some typos in documentation, updates upstream Pdfium WASM package source repository name.
  • 0.5.9: corrects a bug in the statically linked bindings implementation. Adjusted tests to cover both dynamic and statically linked bindings implementations.
  • 0.5.8: corrects a bug in the WASM implementation of certain FPDFAnnot_*() functions. Resolves a potential memory leak affecting the WASM implementation of various FPDF_*() functions.
  • 0.5.7: adds support for binding to a statically-linked build of Pdfium, adds bindgen and static crate features.
  • 0.5.6: adds pdfium_render::prelude, adds bindings for FPDFAnnot_*() and FPDFPage_*Annot*() functions, adds PdfPageAnnotations collection and PdfPageAnnotation struct to the high-level interface.
  • 0.5.5: fixes two bugs in the WASM implementation, one to do with colors, one to do with text extraction. See https://github.com/ajrcarey/pdfium-render/issues/9 and https://github.com/ajrcarey/pdfium-render/issues/11 for more information.
  • 0.5.4: changes default setting of PdfBitmapConfig::set_reverse_byte_order() to true to switch from Pdfium’s default BGRA8 pixel format to RGBA8. This is necessary since the image crate dropped support for BGRA8 in version 0.24. See https://github.com/ajrcarey/pdfium-render/issues/9 for more information.
  • 0.5.3: adds bindings for FPDFBookmark_*(), FPDFPageObj_*(), FPDFText_*(), and FPDFFont_*() functions, adds PdfPageObjects, PdfPageText, and PdfBookmarks collections to the high-level interface.
  • 0.5.2: adds bindings for FPDF_GetPageBoundingBox(), FPDFDoc_GetPageMode(), FPDFPage_Get*Box(), and FPDFPage_Set*Box() functions, adds PdfPageBoundaries collection to the high-level interface.
  • 0.5.1: adds bindings for FPDFPage_GetRotation() and FPDFPage_SetRotation() functions, adds PdfMetadata collection to the high-level interface.
  • 0.5.0: adds rendering of annotations and form field elements, thanks to an excellent contribution from https://github.com/inzanez.
  • 0.4.2: bug fixes in PdfBitmapConfig implementation.
  • 0.4.1: improvements to documentation and READMEs.
  • 0.4.0: initial release of minimal page rendering functionality.

Modules

action

Defines the PdfAction struct, exposing functionality related to a single action associated with a clickable link or document bookmark.

action_destination

Defines the PdfActionDestination struct, exposing functionality related to the destination of a single PdfAction.

bindings

Defines the PdfiumLibraryBindings trait, containing run-time bindings to the FPDF_* functions exported by the Pdfium library.

bitmap

Defines the PdfBitmap struct, a lazily-generated bitmap rendering of a single PdfPage.

bitmap_config

Defines the PdfBitmapConfig struct, a builder-based approach to configuring the rendering of PdfBitmap objects from one or more PdfPage objects.

bookmark

Defines the PdfBookmark struct, exposing functionality related to a single bookmark in a PdfBookmarks collection.

bookmarks

Defines the PdfBookmarks struct, exposing functionality related to the bookmarks contained within a single PdfDocument.

color

Defines the PdfColor struct, a 32-bit RGB color value with an optional alpha channel.

document

Defines the PdfDocument struct, the entry point to all Pdfium functionality related to a single PDF file.

error

Defines the PdfiumError enum, used to wrap Pdfium errors as Err values.

font

Defines the PdfFont struct, exposing functionality related to a single font used to render text in a PdfDocument.

form

Defines the PdfForm struct, exposing functionality related to a form embedded in a PdfDocument.

metadata

Defines the PdfMetadata struct, a collection of all the metadata tags in a PdfDocument.

page

Defines the PdfPage struct, exposing functionality related to a single page in a PdfPages collection.

page_annotation

Defines the PdfPageAnnotation struct, exposing functionality related to a single annotation.

page_annotation_circle

Defines the PdfPageCircleAnnotation struct, exposing functionality related to a single user annotation of type PdfPageAnnotationType::Circle.

page_annotation_free_text

Defines the PdfPageFreeTextAnnotation struct, exposing functionality related to a single user annotation of type PdfPageAnnotationType::FreeText.

page_annotation_highlight

Defines the PdfPageHighlightAnnotation struct, exposing functionality related to a single user annotation of type PdfPageAnnotationType::Highlight.

page_annotation_ink

Defines the PdfPageInkAnnotation struct, exposing functionality related to a single user annotation of type PdfPageAnnotationType::Ink.

page_annotation_link

Defines the PdfPageLinkAnnotation struct, exposing functionality related to a single user annotation of type PdfPageAnnotationType::Link.

page_annotation_popup

Defines the PdfPagePopupAnnotation struct, exposing functionality related to a single user annotation of type PdfPageAnnotationType::Popup.

page_annotation_square

Defines the PdfPageSquareAnnotation struct, exposing functionality related to a single user annotation of type PdfPageAnnotationType::Square.

page_annotation_squiggly

Defines the PdfPageSquigglyAnnotation struct, exposing functionality related to a single user annotation of type PdfPageAnnotationType::Squiggly.

page_annotation_stamp

Defines the PdfPageStampAnnotation struct, exposing functionality related to a single user annotation of type PdfPageAnnotationType::Stamp.

page_annotation_strikeout

Defines the PdfPageStrikeoutAnnotation struct, exposing functionality related to a single user annotation of type PdfPageAnnotationType::Strikeout.

page_annotation_text

Defines the PdfPageTextAnnotation struct, exposing functionality related to a single user annotation of type PdfPageAnnotationType::Text.

page_annotation_underline

Defines the PdfPageUnderlineAnnotation struct, exposing functionality related to a single user annotation of type PdfPageAnnotationType::Underline.

page_annotation_unsupported

Defines the PdfPageUnsupportedAnnotation struct, exposing functionality related to any single annotation object of a type not supported by Pdfium.

page_annotations

Defines the PdfPageAnnotations struct, exposing functionality related to the annotations that have been added to a single PdfPage.

page_boundaries

Defines the PdfPageBoundaries struct, exposing functionality related to the boundary boxes of a single PdfPage.

page_object

Defines the PdfPageObject enum, exposing functionality related to a single page object.

page_object_form_fragment

Defines the PdfPageFormFragmentObject struct, exposing functionality related to a single page object of type PdfPageObjectType::FormFragment.

page_object_group

Defines the PdfPageGroupObject struct, exposing functionality related to a group of page objects contained in the same PdfPageObjects collection.

page_object_image

Defines the PdfPageImageObject struct, exposing functionality related to a single page object of type PdfPageObjectType::Image.

page_object_path

Defines the PdfPagePathObject struct, exposing functionality related to a single page object of type PdfPageObjectType::Path.

page_object_shading

Defines the PdfPageShadingObject struct, exposing functionality related to a single page object of type PdfPageObjectType::Shading.

page_object_text

Defines the PdfPageTextObject struct, exposing functionality related to a single page object of type PdfPageObjectType::Text.

page_object_unsupported

Defines the PdfPageUnsupportedObject struct, exposing functionality related to a single page object of type PdfPageObjectType::Unsupported.

page_objects

Defines the PdfPageObjects struct, exposing functionality related to the page objects contained within a single PdfPage.

page_size

Defines the PdfPagePaperSize enum, a set of common ANSI and ISO paper sizes.

page_text

Defines the PdfPageText struct, exposing functionality related to the collection of Unicode characters visible in a single PdfPage.

page_text_char

Defines the PdfPageTextChar struct, exposing functionality related to a single character in a PdfPageTextChars collection.

page_text_chars

Defines the PdfPageTextChars struct, a collection of all the distinct characters in a bounded rectangular region of a single PdfPage.

page_text_segment

Defines the PdfPageTextSegment struct, exposing functionality related to a single rectangular text segment in a PdfPageTextSegments collection.

page_text_segments

Defines the PdfPageTextSegments struct, a collection of all the distinct rectangular areas of a single PdfPage occupied by spans of text that share a common text style.

pages

Defines the PdfPages struct, a collection of all the PdfPage objects in a PdfDocument.

pdfium

Defines the Pdfium struct, a high-level idiomatic Rust wrapper around Pdfium.

permissions

Defines the PdfPermissions collection, containing information on the permissions and security handlers set for a single PdfDocument.

prelude

A prelude for conveniently importing all public pdfium-render definitions at once.