pdftract/crates/pdftract-core
jedarden 9a3e4ce514 feat(pdftract-axcri): record inline images as ImageXObject entries
Add structures and functions to record inline images (BI/ID/EI sequences)
as ImageXObject entries in a page's image list. This enables Phase 4.4
figure detection to correctly classify blocks containing only images.

Changes:
- Add InlineImageHeader struct for inline image metadata
- Add ImageBytesRef enum for image byte references
- Add ImageXObject struct unifying XObject and inline images
- Add collect_image_xobjects() to collect all images with bboxes
- Add parse_inline_image() to parse BI/ID/EI sequences
- Add compute_unit_square_bbox() for bbox computation from CTM
- Add comprehensive unit tests for all acceptance criteria

Acceptance criteria:
- Inline image with no CTM: bbox == [0,0,1,1] 
- Inline image with CTM 100 0 0 50 200 300: bbox == [200,300,300,350] 
- Page with 3 images: page_image_list has 3 entries with correct bboxes 
- Image mask: recorded with is_mask flag 
- Rotation normalization: handled via CTM 

Closes: pdftract-axcri
2026-05-24 07:41:50 -04:00
..
benches feat(pdftract-3s2i): implement Phase 5.5.2 validation filter 2026-05-24 04:57:17 -04:00
build feat(pdftract-43ry): implement predefined CMap registry 2026-05-23 23:00:59 -04:00
examples feat(pdftract-3s2i): implement Phase 5.5.2 validation filter 2026-05-24 04:57:17 -04:00
proptest-regressions/parser/lexer feat(pdftract-1jjn): implement PDF numeric literal lexer with full edge case support 2026-05-23 23:17:04 -04:00
src feat(pdftract-axcri): record inline images as ImageXObject entries 2026-05-24 07:41:50 -04:00
tests feat(pdftract-3s2i): implement Phase 5.5.2 validation filter 2026-05-24 04:57:17 -04:00
__test__.pdf feat(pdftract-15pz8): implement multi-process safe cache operations 2026-05-23 05:31:11 -04:00
build.rs feat(pdftract-e5lli): fix health endpoint JSON response and streaming endpoint 2026-05-24 06:49:21 -04:00
Cargo.toml feat(pdftract-kdp6): implement profile loader secret key hardening 2026-05-24 04:41:04 -04:00
pdftract-core.cdx.json feat(pdftract-67tm8): implement MCP stdio transport with integration tests 2026-05-23 00:16:42 -04:00
README.md docs(pdftract-49f8): establish Cargo.lock policy and documentation 2026-05-20 18:13:14 -04:00

pdftract-core

The core Rust library for PDF text extraction. This crate provides the parsing, layout analysis, font encoding recovery, and text extraction primitives used by the CLI (pdftract-cli) and Python bindings (pdftract-py).

Cargo.lock Policy

This workspace checks in Cargo.lock at the repository root. This is unconventional for library crates—the Cargo Book historically suggested that only binary crates should check in lockfiles, allowing library consumers to resolve their own dependency versions.

pdftract departs from this convention for release reproducibility:

  1. SLSA Level 3 provenance requires that every milestone tag produces byte-identical artifacts across builds. Without a checked-in lockfile, two runs of cargo build on the same commit can resolve different transitive dependency versions, producing different binary hashes.

  2. Multi-output artifacts—this workspace produces Rust crates (pdftract-core, pdftract-cli), Python wheels (pdftract-py), and Docker images. All must be built from the same dependency tree.

  3. Supply-chain security—the lockfile pins checksums for all transitive dependencies, enabling cargo audit to detect yanked or compromised crates.

  4. Downstream consumers can still ignore the lockfile if needed. Cargo allows cargo build --frozen with a local lockfile override, or consumers can vendor the crate with their own dependency resolution.

The tradeoff—occasional merge conflicts when PRs update overlapping dependencies—is worth the guarantee of reproducible releases. See CONTRIBUTING.md for the lockfile-update workflow.

Modules

  • parser: PDF spec parsing (xref, trailer, object streams, indirect references)
  • font: Font encoding recovery, glyph name lookup, fingerprinting
  • layout: Page layout analysis, region segmentation, reading order
  • extract: Text extraction with provenance (bounding boxes, confidence scores)
  • ocr: Tesseract integration for raster pages

Usage

use pdftract_core::{extract_text, ExtractOptions};

let options = ExtractOptions::default();
let result = extract_text("document.pdf", &options)?;
println!("{}", result.text);