v6.2.4 release notes

This feature works for gs >= 9.24, but we don't want to change behavior in
a backport, so we're disabling it unconditionally.

.coveragerc

@@ -0,0 +1,16 @@
+# Coverage isn't really compatible with subprocesses so results are unreliable
+
+[run]
+branch = True
+#concurrency = multiprocessing
+source = ocrmypdf/
+
+[report]
+exclude_lines =
+	pragma: no cover
+	def __repr__
+	raise AssertionError
+	raise NotImplementedError
+	if 0:
+	if False:
+	if __name__ == .__main__.:

.docker/Dockerfile

@@ -1,80 +1,50 @@
 # OCRmyPDF
 #
-
-FROM ubuntu:21.04 as base
-
-ENV LANG=C.UTF-8
-ENV TZ=UTC
-RUN echo 'debconf debconf/frontend select Noninteractive' | debconf-set-selections
+FROM      ubuntu:18.04
 
 RUN apt-get update && apt-get install -y --no-install-recommends \
-  python3 \
-  libqpdf-dev \
-  zlib1g \
-  liblept5
-
-FROM base as builder
-
-RUN apt-get update && apt-get install -y --no-install-recommends \
-  build-essential autoconf automake libtool \
-  libleptonica-dev \
-  zlib1g-dev \
-  python3-dev \
-  python3-distutils \
-  libffi-dev \
-  ca-certificates \
-  curl \
-  git
-
-# Get the latest pip (Ubuntu version doesn't support manylinux2010)
-RUN \
-  curl https://bootstrap.pypa.io/get-pip.py | python3
-
-# Compile and install jbig2
-# Needs libleptonica-dev, zlib1g-dev
-RUN \
-  mkdir jbig2 \
-  && curl -L https://github.com/agl/jbig2enc/archive/ea6a40a.tar.gz | \
-  tar xz -C jbig2 --strip-components=1 \
-  && cd jbig2 \
-  && ./autogen.sh && ./configure && make && make install \
-  && cd .. \
-  && rm -rf jbig2
-
-COPY . /app
-
-WORKDIR /app
-
-RUN pip3 install --no-cache-dir .[test,webservice,watcher]
-
-FROM base
-
-RUN apt-get update && apt-get install -y --no-install-recommends \
-  ghostscript \
-  img2pdf \
-  libsm6 libxext6 libxrender-dev \
-  pngquant \
-  tesseract-ocr \
-  tesseract-ocr-chi-sim \
-  tesseract-ocr-deu \
+  ocrmypdf \
+  unpaper \
   tesseract-ocr-eng \
   tesseract-ocr-fra \
-  tesseract-ocr-por \
+  tesseract-ocr-deu \
   tesseract-ocr-spa \
-  unpaper \
-  && rm -rf /var/lib/apt/lists/*
+  tesseract-ocr-por \
+  tesseract-ocr-chi-sim \
+  python3-venv \
+  python3-pip
 
-WORKDIR /app
+ENV LANG=C.UTF-8
 
-COPY --from=builder /usr/local/lib/ /usr/local/lib/
-COPY --from=builder /usr/local/bin/ /usr/local/bin/
+RUN python3 -m venv --system-site-packages /appenv
 
-COPY --from=builder /app/misc/webservice.py /app/
-COPY --from=builder /app/misc/watcher.py /app/
+# This installs the latest binary wheel instead of the code in the current
+# folder. Installing from source will fail, apparently because cffi needs
+# build-essentials (gcc) to do a source installation 
+# (i.e. "pip install ."). It's unclear to me why this is the case.
+RUN . /appenv/bin/activate; \
+  pip install --upgrade pip \
+  && pip install ocrmypdf[fitz]
 
-# Copy minimal project files to get the test suite.
-COPY --from=builder /app/setup.cfg /app/setup.py /app/README.md /app/
-COPY --from=builder /app/requirements /app/requirements
-COPY --from=builder /app/tests /app/tests
+# Now copy the application in, mainly to get the test suite.
+# Do this now to make the best use of Docker cache.
+COPY . /application
+RUN . /appenv/bin/activate; \
+  pip install -r /application/test_requirements.txt
 
-ENTRYPOINT ["/usr/local/bin/ocrmypdf"]
+# Remove the junk, including the source version of application since it was
+# already installed
+RUN rm -rf /tmp/* /var/tmp/* /root/* /application/ocrmypdf \
+  && apt-get autoremove -y \
+  && apt-get autoclean -y
+
+RUN useradd docker \
+  && mkdir /home/docker \
+  && chown docker:docker /home/docker
+
+USER docker
+WORKDIR /home/docker
+
+# Must use array form of ENTRYPOINT
+# Non-array form does not append other arguments, because that is "intuitive"
+ENTRYPOINT ["/application/.docker/docker-wrapper.sh"]

.docker/Dockerfile.polyglot

@@ -0,0 +1,17 @@
+# OCRmyPDF polyglot
+#
+FROM      jbarlow83/ocrmypdf:latest
+
+USER root
+
+# Update system and install our dependencies
+RUN apt-get update && apt-get install -y --no-install-recommends \
+  tesseract-ocr-all 
+
+RUN apt-get autoremove -y && apt-get clean -y
+
+USER docker
+
+# Must use array form of ENTRYPOINT
+# Non-array form does not append other arguments, because that is "intuitive"
+ENTRYPOINT ["/application/.docker/docker-wrapper.sh"]

.docker/docker-wrapper.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+. /appenv/bin/activate
+cd /home/docker
+exec ocrmypdf "$@"

.dockerignore

@@ -1,44 +1,25 @@
-# dotfiles
-.*
-!.coveragerc
-!.dockerignore
-!.git_archival.txt
-!.gitattributes
-!.gitignore
-!.pre-commit-config.yaml
-!.readthedocs.yml
-
-# Dev scratch
 *.ipynb
+*.pdf
+*.pyc
+*.rst
+*.sublime*
 **/*.pyc
-/*.pdf
-/*.qdf
-/*.png
-/scratch.py
-IDEAS
-log/
+.*/
+!.docker/
+.ruffus_history.sqlite
+bin/
+build/
+docs/
+dist/
+htmlcov/
+include/
+lib/
+MANIFEST.in
+ocrmypdf.egg-info/
+staging/
+tests/cache/
+tests/output/
 tests/resources/private/
 tmp/
 venv*/
-/debug_tests.py
-*.traineddata
-/private
-
-# Package building
-*.egg-info/
-build/
-dist/
 wheelhouse/
-pip-wheel-metadata/
-
-# Code coverage
-htmlcov/
-
-# Docker specific
-bin/
-docs/
-include/
-lib/
-
-# Docker include .git/
-!.git/

.gitattributes

@@ -9,6 +9,5 @@
 *.png	binary
 *.jpg	binary
 *.bin   binary
-*.afdesign  binary
 
 .git_archival.txt  export-subst

.github/FUNDING.yml

@@ -1,12 +0,0 @@
-# These are supported funding model platforms
-
-github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-patreon: # Replace with a single Patreon username
-open_collective: james-barlow
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-otechie: # Replace with a single Otechie username
-custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE

@@ -0,0 +1,5 @@
+Please include the command line and a test file with your issue report.
+
+If possible, please use a test file that we can include in future test cases (no personal information, no copyrighted material).
+
+If you wish to encrypt a test file for the OCRmyPDF maintainer only, see the [Wiki](https://github.com/jbarlow83/OCRmyPDF/wiki).

.github/ISSUE_TEMPLATE/1-general-issues.md

@@ -1,32 +0,0 @@
----
-name: General issues
-about: Installation, packages, dependencies, "nothing works", test suite failures...
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-What's the problem?
-
-**To Reproduce**
-Steps to reproduce the behavior.
-
-**Expected behavior**
-What did you expected to happen?
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**System (please complete the following information):**
- - OS:
- - Python version:
- - OCRmyPDF version:
-
-**Installation**
-How did you install OCRmyPDF? Did you install it from your operating system's
-package manager, or using pip?
-
-**Additional context**
-Add any other context about the problem here.

.github/ISSUE_TEMPLATE/2-problem-with-a-specific-input-file.md

@@ -1,40 +0,0 @@
----
-name: Problem with a specific input file
-about: Something went wrong while trying to OCR a specific file
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-What command line or API call were you trying to run?
-
-```bash
-ocrmypdf  ...arguments... input.pdf output.pdf
-```
-
-Run with verbosity or higher `-v1` to see more detailed logging. This information may be helpful.
-
-**Example file**
-If your issue is a problem that affects only certain files, and we will require an input file (PDF or image) that demonstrates your issue.
-
-Please provide an input file with no personal or confidential information. At your option you may [GPG-encrypt the file](https://github.com/jbarlow83/OCRmyPDF/wiki) for OCRmyPDF's author only.
-
-Links to files hosted elsewhere are perfectly acceptable. You could also look in ``tests/resources`` and see if any of those files reproduce your issue.
-
-*(Issues without example files usually cannot be resolved. It's like reporting an issue against a web browser without providing a URL.)*
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**System**
- - OS: [e.g. Linux, Windows, macOS]
- - OCRmyPDF Version: ``ocrmypdf --version``
- - How did you install ocrmypdf? Did you use a system package manager, `pip`, or a Docker image?

.github/ISSUE_TEMPLATE/3-feature_request.md

@@ -1,27 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered. Please include the versions of OCRmyPDF and other supporting programs (Tesseract OCR, Ghostscript) - maybe an alternative already exists in a newer version.
-
-**Example file**
-If your issue concerns how OCRmyPDF processes certain files, and please provide an example file that helps illustrate how OCRmyPDF's output could be improve.
-
-Please provide an input file with no personal or confidential information. At your option you may [GPG-encrypt the file](https://github.com/jbarlow83/OCRmyPDF/wiki) for OCRmyPDF's author only.
-
-Links to files hosted elsewhere are perfectly acceptable. You could also look in ``tests/resources`` and see if any of those files reproduce your issue.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

.github/workflows/build.yml

@@ -1,276 +0,0 @@
-name: Test and deploy
-
-on:
-  push:
-    branches:
-      - master
-      - ci
-      - release/*
-    tags:
-      - v*
-    paths-ignore:
-      - README*
-  pull_request:
-
-jobs:
-  test_linux:
-    name: Test ${{ matrix.os }} with Python ${{ matrix.python }}
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-18.04] #, ubuntu-20.04]
-        python: ["3.6"] #, "3.7", "3.8", "3.9"]
-
-    env:
-      OS: ${{ matrix.os }}
-      PYTHON: ${{ matrix.python }}
-
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: "0" # 0=all, needed for setuptools-scm to resolve version tags
-
-      - uses: actions/setup-python@v2
-        name: Install Python
-        with:
-          python-version: ${{ matrix.python }}
-
-      - name: Install common packages
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y --no-install-recommends \
-            curl \
-            ghostscript \
-            img2pdf \
-            libffi-dev \
-            liblept5 \
-            libsm6 libxext6 libxrender-dev \
-            pngquant \
-            poppler-utils \
-            tesseract-ocr \
-            tesseract-ocr-deu \
-            tesseract-ocr-eng \
-            unpaper \
-            zlib1g
-
-      - name: Install Ubuntu 18.04 packages
-        if: matrix.os == 'ubuntu-18.04'
-        run: |
-          sudo apt-get install -y --no-install-recommends \
-            libexempi3
-
-      - name: Install Ubuntu 20.04 packages
-        if: matrix.os == 'ubuntu-20.04'
-        run: |
-          sudo apt-get install -y --no-install-recommends \
-            libexempi8
-
-      - name: Install Python packages
-        run: |
-          python -m pip install .[test]
-
-      - name: Report versions
-        run: |
-          tesseract --version
-          gs --version
-          pngquant --version
-          unpaper --version
-          img2pdf --version
-
-      - name: Test
-        run: |
-          python -m pytest --cov-report xml --cov=ocrmypdf --cov=tests/ -n0 tests/
-
-      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v1
-        with:
-          files: ./coverage.xml
-          env_vars: OS,PYTHON
-
-  test_macos:
-    name: Test macOS
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [macos-latest]
-        python: ["3.9"]
-
-    env:
-      OS: ${{ matrix.os }}
-      PYTHON: ${{ matrix.python }}
-
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: "0" # 0=all, needed for setuptools-scm to resolve version tags
-
-      - uses: actions/setup-python@v2
-        name: Install Python
-        with:
-          python-version: ${{ matrix.python }}
-
-      - name: Install Homebrew deps
-        run: |
-          brew update
-          brew install \
-            exempi \
-            ghostscript \
-            jbig2enc \
-            leptonica \
-            openjpeg \
-            pngquant \
-            tesseract
-
-      - name: Install Python packages
-        run: |
-          python -m pip install --upgrade pip
-          python -m pip install .[test]
-
-      - name: Report versions
-        run: |
-          tesseract --version
-          gs --version
-          pngquant --version
-          img2pdf --version
-
-      - name: Test
-        run: |
-          python -m pytest --cov-report xml --cov=ocrmypdf --cov=tests/ -n0 tests/
-
-      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v1
-        with:
-          files: ./coverage.xml
-          env_vars: OS,PYTHON
-
-  test_windows:
-    name: Test Windows
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [windows-latest]
-        python: ["3.9"]
-
-    env:
-      OS: ${{ matrix.os }}
-      PYTHON: ${{ matrix.python }}
-
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: "0" # 0=all, needed for setuptools-scm to resolve version tags
-
-      - uses: actions/setup-python@v2
-        name: Install Python
-        with:
-          python-version: ${{ matrix.python }}
-
-      - name: Install system packages
-        run: |
-          choco install --yes --no-progress --pre tesseract
-          choco install --yes --no-progress ghostscript
-          choco install --yes --no-progress pngquant
-
-      - name: Install Python packages
-        run: |
-          python -m pip install --upgrade pip
-          python -m pip install .[test]
-
-      - name: Test
-        run: |
-          python -m pytest --cov-report xml --cov=ocrmypdf --cov=tests/ -n0 tests/
-
-      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v1
-        with:
-          files: ./coverage.xml
-          env_vars: OS,PYTHON
-
-  wheel_sdist_linux:
-    name: Build sdist and wheels
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: "0" # 0=all, needed for setuptools-scm to resolve version tags
-
-      - uses: actions/setup-python@v2
-        name: Install Python
-        with:
-          python-version: "3.6"
-
-      - name: Make wheels and sdist
-        run: |
-          python -m pip install --upgrade pip wheel
-          python setup.py sdist
-          python setup.py bdist_wheel
-
-      - uses: actions/upload-artifact@v2
-        with:
-          path: |
-            ./dist/*.whl
-            ./dist/*.tar.gz
-
-  upload_pypi:
-    name: Deploy artifacts to PyPI
-    needs: [wheel_sdist_linux, test_linux, test_macos, test_windows]
-    runs-on: ubuntu-latest
-    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags/v')
-    steps:
-      - uses: actions/download-artifact@v2
-        with:
-          name: artifact
-          path: dist
-
-      - uses: pypa/gh-action-pypi-publish@master
-        with:
-          user: __token__
-          password: ${{ secrets.TOKEN_PYPI }}
-          # repository_url: https://test.pypi.org/legacy/
-
-  docker:
-    name: Build Docker images
-    needs: [wheel_sdist_linux, test_linux, test_macos, test_windows]
-    runs-on: ubuntu-latest
-    if: github.event_name != 'pull_request'
-    steps:
-      - name: Set image tag to release or branch
-        run: echo "DOCKER_IMAGE_TAG=${GITHUB_REF##*/}" >> $GITHUB_ENV
-
-      - name: If master, set to latest
-        run: echo 'DOCKER_IMAGE_TAG=latest' >> $GITHUB_ENV
-        if: env.DOCKER_IMAGE_TAG == 'master'
-
-      - name: Set Docker Hub repository to username
-        run: echo "DOCKER_REPOSITORY=jbarlow83" >> $GITHUB_ENV
-
-      - name: Set image name
-        run: echo "DOCKER_IMAGE_NAME=ocrmypdf" >> $GITHUB_ENV
-
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: "0" # 0=all, needed for setuptools-scm to resolve version tags
-
-      - name: Login to Docker Hub
-        uses: docker/login-action@v1
-        with:
-          username: jbarlow83
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v1
-
-      - name: Set up Docker Buildx
-        id: buildx
-        uses: docker/setup-buildx-action@v1
-
-      - name: Print image tag
-        run: echo "Building image ${DOCKER_REPOSITORY}/${DOCKER_IMAGE_NAME}:${DOCKER_IMAGE_TAG}"
-
-      - name: Build
-        run: |
-          docker buildx build \
-            --push \
-            --platform linux/arm64/v8,linux/amd64  \
-            --tag "${DOCKER_REPOSITORY}/${DOCKER_IMAGE_NAME}:${DOCKER_IMAGE_TAG}" \
-            --file .docker/Dockerfile .

.gitignore

@@ -1,45 +1,47 @@
-# dotfiles
-.*
-!.coveragerc
-!.dockerignore
-!.git_archival.txt
-!.gitattributes
-!.gitignore
-!.pre-commit-config.yaml
-!.readthedocs.yaml
-!.github/
-!.docker/
-
-# Dev scratch
-*.ipynb
-**/*.pyc
-/*.pdf
-/*.qdf
-/*.png
-/scratch.py
-IDEAS
-log/
-tests/resources/private/
-tmp/
+# Development environment
+*.pyc
+*.sublime-*
 venv*/
-/debug_tests.py
-*.traineddata
-/private
-/coverage.xml
+.venv/
+pyvenv.cfg
+tasks.py
+.bash_history
+.ruffus_history.sqlite
+.idea/
+.pytest_cache/
+.pylintrc
 
 # Package building
 *.egg-info/
+.cache/
+.eggs/
 build/
 dist/
 wheelhouse/
-pip-wheel-metadata/
-
-# Code coverage
-htmlcov/
 
 # Automatically generated files
+ocrmypdf/lib/_*.py
+ocrmypdf/version.py
 docs/_build/
 docs/_static/
 docs/_templates/
 docs/Makefile
-ocrmypdf/lib/_*.py
+
+# Code coverage
+.coverage
+htmlcov/
+
+# Testing
+log/
+/*.pdf
+/*.qdf
+*.ipynb
+.ipynb_checkpoints/
+tests/output/
+tests/resources/private/
+tmp/
+pdfbox-app*.jar
+.vscode/
+IDEAS
+_Dockerfile.local
+/scratch.py

.pre-commit-config.yaml

@@ -1,23 +0,0 @@
-repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.4.0
-    hooks:
-      - id: check-case-conflict
-      - id: check-merge-conflict
-      - id: check-toml
-      - id: check-yaml
-      - id: debug-statements
-  - repo: https://github.com/asottile/seed-isort-config
-    rev: v2.2.0
-    hooks:
-      - id: seed-isort-config
-  - repo: https://github.com/pre-commit/mirrors-isort
-    rev: v5.7.0 # pick the isort version you'd like to use from https://github.com/pre-commit/mirrors-isort/releases
-    hooks:
-      - id: isort
-  - repo: https://github.com/psf/black
-    rev: 20.8b1
-    hooks:
-      - id: black
-        language_version: python
-        exclude: ^src/ocrmypdf/lib/_leptonica.py

.readthedocs.yaml

@@ -1,22 +0,0 @@
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
-version: 2
-
-# Build documentation in the docs/ directory with Sphinx
-sphinx:
-  configuration: docs/conf.py
-
-# Optionally build your docs in additional formats such as PDF
-formats:
-  - pdf
-
-# Optionally set the version of Python and requirements required to build your docs
-python:
-  version: 3.7
-  install:
-    - method: pip
-      path: .
-      extra_requirements:
-        - docs

.travis.yml

@@ -0,0 +1,98 @@
+dist: trusty
+language: python
+cache:
+  pip: true
+  directories:
+  - $HOME/Library/Caches/Homebrew
+
+addons:
+  apt:
+    update: true
+    sources:
+    - sourceline: 'ppa:alex-p/tesseract-ocr'
+    - sourceline: 'ppa:heyarje/libav-11'
+    - sourceline: 'ppa:vshn/ghostscript'
+    packages:
+    - ghostscript
+    - libavcodec56
+    - libavformat56
+    - libavutil54
+    - libffi-dev
+    - poppler-utils
+    - qpdf
+    - tesseract-ocr
+    - tesseract-ocr-deu
+    - tesseract-ocr-eng
+    - tesseract-ocr-fra
+
+matrix:
+  include:
+    - os: linux
+      sudo: required
+      language: python
+      python: "3.5"
+      env: EXTRAS=
+    - os: linux
+      sudo: required
+      language: python
+      python: "3.6"
+      env: EXTRAS=
+    - os: linux
+      sudo: required
+      language: python
+      python: "3.6"
+      env: EXTRAS=[fitz]
+    - os: linux
+      sudo: required
+      language: python
+      python: "3.7-dev"
+    - os: osx
+      osx_image: xcode8
+      language: generic
+      env: EXTRAS=
+    - os: osx
+      osx_image: xcode8
+      language: generic
+      env: EXTRAS=[fitz]
+
+before_cache:
+- rm -f $HOME/.cache/pip/log/debug.log
+
+before_install: |
+  if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then
+    pip install --upgrade pip
+    mkdir -p packages
+    wget -q 'https://www.dropbox.com/s/vaq0kbwi6e6au80/unpaper_6.1-1.deb?raw=1' -O packages/unpaper_6.1-1.deb
+    sudo dpkg -i packages/unpaper_6.1-1.deb
+  elif [[ "$TRAVIS_OS_NAME" == "osx" ]]; then
+    brew update && brew bundle --file=.travis/Brewfile
+    pip3 install --upgrade pip
+    pip3 install wheel
+  fi
+
+install:
+- pip3 install pycparser # py3.7 workaround for https://github.com/eliben/pycparser/issues/251
+- pip3 install ".$EXTRAS"
+- pip3 install -r test_requirements.txt
+
+script:
+- tesseract --version
+- qpdf --version
+- pytest -n auto
+
+deploy:
+  # release for main pypi
+  # 3.6 w/o fitz is considered the build leader and does the deploy, otherwise there is
+  # a race and all versions will try to deploy
+  # OTOH if we ever need separate binary wheels then each version needs its
+  # own deploy
+- provider: pypi
+  user: ocrmypdf-travis
+  password:
+    secure: "DTFOmmNL6olA0+yXvp4u9jXZlZeqrJsJ0526jzqf4a3gZ6jnGTq5UI6WzRsslSyoMMfXKtHQebqHM6ogSgCZinyZ3ufHJo8fn9brxbEc2gsiWkbj5o3bGwdWMT1vNNE7XW0VCpw87rZ1EEwjl4FJHFudMlPR1yfU5+uq0k0PACo="
+  distributions: "sdist bdist_wheel"
+  on:
+    branch: master
+    tags: true
+    condition: $TRAVIS_PYTHON_VERSION == "3.6" && $TRAVIS_OS_NAME == "linux" && $EXTRAS == ""
+  skip_upload_docs: true

.travis/Brewfile

@@ -0,0 +1,13 @@
+brew 'python'
+
+brew 'ghostscript'
+brew 'jbig2dec'
+brew 'leptonica'
+brew 'libffi'
+brew 'libtiff'
+brew 'libxml2'
+brew 'mupdf-tools'
+brew 'openjpeg'
+brew 'qpdf'
+brew 'tesseract'
+brew 'unpaper'

MANIFEST.in

@@ -0,0 +1,49 @@
+# requirements
+include requirements.txt
+include test_requirements.txt
+include dev_requirements.txt
+
+# git
+include .git_archival.txt
+
+# docker
+include .dockerignore
+recursive-include .docker *
+
+# tests
+include .coveragerc
+recursive-include tests *.jpg
+recursive-include tests *.png
+recursive-include tests *.pdf
+recursive-include tests *.py
+recursive-include tests *.rst
+recursive-include tests *.txt
+recursive-include tests/cache *
+recursive-exclude tests/output *
+recursive-exclude tests/output_pageinfo *
+recursive-exclude tests/resources/private *
+
+# documentation
+include LICENSE
+include *.rst
+recursive-exclude .github * 
+recursive-include docs *.py
+recursive-include docs *.rst
+recursive-include docs *.svg
+recursive-exclude docs/_build *
+
+
+# support files
+recursive-include src/ocrmypdf/data *
+include *.py
+exclude tasks.py
+recursive-exclude .travis *
+exclude .travis*
+
+
+# code
+recursive-include src/ocrmypdf *.py
+exclude ocrmypdf/lib/_leptonica.py
+
+
+

README.md

@@ -1,138 +0,0 @@
-<img src="docs/images/logo.svg" width="240" alt="OCRmyPDF">
-
-[![Build Status](https://github.com/jbarlow83/OCRmyPDF/actions/workflows/build.yml/badge.svg)](https://github.com/jbarlow83/OCRmyPDF/actions/workflows/build.yml) [![PyPI version][pypi]](https://pypi.org/project/ocrmypdf/) ![Homebrew version][homebrew] ![ReadTheDocs][docs] ![Python versions][pyversions]
-
-[azure]: https://dev.azure.com/jim0585/ocrmypdf/_apis/build/status/jbarlow83.OCRmyPDF?branchName=master
-[travis]: https://travis-ci.org/jbarlow83/OCRmyPDF.svg?branch=master "Travis build status"
-[pypi]: https://img.shields.io/pypi/v/ocrmypdf.svg "PyPI version"
-[homebrew]: https://img.shields.io/homebrew/v/ocrmypdf.svg "Homebrew version"
-[docs]: https://readthedocs.org/projects/ocrmypdf/badge/?version=latest "RTD"
-[pyversions]: https://img.shields.io/pypi/pyversions/ocrmypdf "Supported Python versions"
-
-OCRmyPDF adds an OCR text layer to scanned PDF files, allowing them to be searched or copy-pasted.
-
-```bash
-ocrmypdf                      # it's a scriptable command line program
-   -l eng+fra                 # it supports multiple languages
-   --rotate-pages             # it can fix pages that are misrotated
-   --deskew                   # it can deskew crooked PDFs!
-   --title "My PDF"           # it can change output metadata
-   --jobs 4                   # it uses multiple cores by default
-   --output-type pdfa         # it produces PDF/A by default
-   input_scanned.pdf          # takes PDF input (or images)
-   output_searchable.pdf      # produces validated PDF output
-```
-
-[See the release notes for details on the latest changes](https://ocrmypdf.readthedocs.io/en/latest/release_notes.html).
-
-## Main features
-
-- Generates a searchable [PDF/A](https://en.wikipedia.org/?title=PDF/A) file from a regular PDF
-- Places OCR text accurately below the image to ease copy / paste
-- Keeps the exact resolution of the original embedded images
-- When possible, inserts OCR information as a "lossless" operation without disrupting any other content
-- Optimizes PDF images, often producing files smaller than the input file
-- If requested, deskews and/or cleans the image before performing OCR
-- Validates input and output files
-- Distributes work across all available CPU cores
-- Uses [Tesseract OCR](https://github.com/tesseract-ocr/tesseract) engine to recognize more than [100 languages](https://github.com/tesseract-ocr/tessdata)
-- Scales properly to handle files with thousands of pages
-- Battle-tested on millions of PDFs
-
-For details: please consult the [documentation](https://ocrmypdf.readthedocs.io/en/latest/).
-
-## Motivation
-
-I searched the web for a free command line tool to OCR PDF files: I found many, but none of them were really satisfying:
-
-- Either they produced PDF files with misplaced text under the image (making copy/paste impossible)
-- Or they did not handle accents and multilingual characters
-- Or they changed the resolution of the embedded images
-- Or they generated ridiculously large PDF files
-- Or they crashed when trying to OCR
-- Or they did not produce valid PDF files
-- On top of that none of them produced PDF/A files (format dedicated for long time storage)
-
-...so I decided to develop my own tool.
-
-## Installation
-
-Linux, Windows, macOS and FreeBSD are supported. Docker images are also available, for both x64 and ARM.
-
-| Operating system              | Install command               |
-| ----------------------------- | ------------------------------|
-| Debian, Ubuntu                | ``apt install ocrmypdf``      |
-| Windows Subsystem for Linux   | ``apt install ocrmypdf``      |
-| Fedora                        | ``dnf install ocrmypdf``      |
-| macOS                         | ``brew install ocrmypdf``     |
-| LinuxBrew                     | ``brew install ocrmypdf``     |
-| FreeBSD                       | ``pkg install py37-ocrmypdf`` |
-| Conda                         | ``conda install ocrmypdf``    |
-
-For everyone else, [see our documentation](https://ocrmypdf.readthedocs.io/en/latest/installation.html) for installation steps.
-
-## Languages
-
-OCRmyPDF uses Tesseract for OCR, and relies on its language packs. For Linux users, you can often find packages that provide language packs:
-
-```bash
-# Display a list of all Tesseract language packs
-apt-cache search tesseract-ocr
-
-# Debian/Ubuntu users
-apt-get install tesseract-ocr-chi-sim  # Example: Install Chinese Simplified language pack
-
-# Arch Linux users
-pacman -S tesseract-data-eng tesseract-data-deu # Example: Install the English and German language packs
-
-# brew macOS users
-brew install tesseract-lang
-```
-
-You can then pass the `-l LANG` argument to OCRmyPDF to give a hint as to what languages it should search for. Multiple languages can be requested.
-
-## Documentation and support
-
-Once OCRmyPDF is installed, the built-in help which explains the command syntax and options can be accessed via:
-
-```bash
-ocrmypdf --help
-```
-
-Our [documentation is served on Read the Docs](https://ocrmypdf.readthedocs.io/en/latest/index.html).
-
-Please report issues on our [GitHub issues](https://github.com/jbarlow83/OCRmyPDF/issues) page, and follow the issue template for quick response.
-
-## Requirements
-
-In addition to the required Python version (3.6+), OCRmyPDF requires external program installations of Ghostscript, Tesseract OCR, QPDF, and Leptonica. OCRmyPDF is pure Python, but uses CFFI to portably generate library bindings. OCRmyPDF works on pretty much everything: Linux, macOS, Windows and FreeBSD.
-
-## Press & Media
-
-- [Going paperless with OCRmyPDF](https://medium.com/@ikirichenko/going-paperless-with-ocrmypdf-e2f36143f46a)
-- [Converting a scanned document into a compressed searchable PDF with redactions](https://medium.com/@treyharris/converting-a-scanned-document-into-a-compressed-searchable-pdf-with-redactions-63f61c34fe4c)
-- [c't 1-2014, page 59](https://heise.de/-2279695): Detailed presentation of OCRmyPDF v1.0 in the leading German IT magazine c't
-- [heise Open Source, 09/2014: Texterkennung mit OCRmyPDF](https://heise.de/-2356670)
-- [heise Durchsuchbare PDF-Dokumente mit OCRmyPDF erstellen](https://www.heise.de/ratgeber/Durchsuchbare-PDF-Dokumente-mit-OCRmyPDF-erstellen-4607592.html)
-- [Excellent Utilities: OCRmyPDF](https://www.linuxlinks.com/excellent-utilities-ocrmypdf-add-ocr-text-layer-scanned-pdfs/)
-- [LinuxUser Texterkennung mit OCRmyPDF und Scanbd automatisieren](https://www.linux-community.de/ausgaben/linuxuser/2021/06/texterkennung-mit-ocrmypdf-und-scanbd-automatisieren/)  
-
-## Business enquiries
-
-OCRmyPDF would not be the software that it is today without companies and users choosing to provide support for feature development and consulting enquiries. We are happy to discuss all enquiries, whether for extending the existing feature set, or integrating OCRmyPDF into a larger system.
-
-## License
-
-The OCRmyPDF software is licensed under the Mozilla Public License 2.0
-(MPL-2.0). This license permits integration of OCRmyPDF with other code,
-included commercial and closed source, but asks you to publish source-level
-modifications you make to OCRmyPDF.
-
-Some components of OCRmyPDF have other licenses, as noted in those files and the
-``debian/copyright`` file. Most files in ``misc/`` use the MIT license, and the
-documentation and test files are generally licensed under Creative Commons
-ShareAlike 4.0 (CC-BY-SA 4.0).
-
-## Disclaimer
-
-The software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

README.rst

@@ -0,0 +1,153 @@
+OCRmyPDF
+========
+
+.. image:: https://travis-ci.org/jbarlow83/OCRmyPDF.svg?branch=master
+    :target: https://travis-ci.org/jbarlow83/OCRmyPDF
+
+.. image:: https://img.shields.io/pypi/v/ocrmypdf.svg
+    :target: https://pypi.org/project/ocrmypdf/
+
+.. image:: https://img.shields.io/homebrew/v/ocrmypdf.svg
+    :alt: homebrew
+    :target: http://brewformulas.org/Ocrmypdf
+
+
+OCRmyPDF adds an OCR text layer to scanned PDF files, allowing them to
+be searched or copy-pasted.
+
+.. code-block:: bash
+
+   ocrmypdf                      # it's a scriptable command line program
+      -l eng+fra                 # it supports multiple languages
+      --rotate-pages             # it can fix pages that are misrotated
+      --deskew                   # it can deskew crooked PDFs!
+      --title "My PDF"           # it can change output metadata
+      --jobs 4                   # it uses multiple cores by default
+      --output-type pdfa         # it produces PDF/A by default
+      input_scanned.pdf          # takes PDF input (or images)
+      output_searchable.pdf      # produces validated PDF output
+
+
+Main features
+-------------
+
+-  Generates a searchable
+   `PDF/A <https://en.wikipedia.org/?title=PDF/A>`_ file from a regular PDF
+-  Places OCR text accurately below the image to ease copy / paste
+-  Keeps the exact resolution of the original embedded images
+-  When possible, inserts OCR information as a "lossless" operation without rendering vector information
+-  Keeps file size about the same
+-  If requested deskews and/or cleans the image before performing OCR
+-  Validates input and output files
+-  Provides debug mode to enable easy verification of the OCR results
+-  Processes pages in parallel when more than one CPU core is
+   available
+-  Uses `Tesseract OCR <https://github.com/tesseract-ocr/tesseract>`_ engine
+-  Supports more than `100 languages <https://github.com/tesseract-ocr/tessdata>`_ recognized by Tesseract
+-  Battle-tested on thousands of PDFs, a test suite and continuous integration
+
+For details: please consult the `documentation <https://ocrmypdf.readthedocs.io/en/latest/>`_.
+
+Motivation
+----------
+
+I searched the web for a free command line tool to OCR PDF files on
+Linux/UNIX: I found many, but none of them were really satisfying.
+
+-  Either they produced PDF files with misplaced text under the image (making copy/paste impossible)
+-  Or they did not handle accents and multilingual characters
+-  Or they changed the resolution of the embedded images
+-  Or they generated ridiculously large PDF files
+-  Or they crashed when trying to OCR some of my PDF files
+-  Or they did not produce valid PDF files (even though they were readable with my current PDF reader)
+-  On top of that none of them produced PDF/A files (format dedicated for long time storage)
+
+...so I decided to develop my own tool (using various existing scripts
+as an inspiration).
+
+Installation
+------------
+
+Linux, UNIX, and macOS are supported. Windows is not directly supported but there is a Docker image available that runs on Windows.
+
+Users of Debian 9 or later or Ubuntu 16.10 or later may simply
+
+.. code-block:: bash
+
+   apt-get install ocrmypdf
+
+and macOS users with Homebrew may simply
+
+.. code-block:: bash
+
+   brew install ocrmypdf
+
+For everyone else, `see our documentation <https://ocrmypdf.readthedocs.io/en/latest/installation.html>`_ for installation steps.
+
+Languages
+---------
+
+OCRmyPDF uses Tesseract for OCR, and relies on its language packs. For Linux users,
+you can often find packages that provide language packs:
+
+.. code-block:: bash
+
+   # Display a list of all Tesseract language packs
+   apt-cache search tesseract-ocr
+
+   # Debian/Ubuntu users
+   apt-get install tesseract-ocr-chi-sim  # Example: Install Chinese Simplified language back
+
+You can then pass the ``-l LANG`` argument to OCRmyPDF to give a hint as to what languages it should search for. Multiple
+languages can be requested.
+
+Documentation and support
+-------------------------
+
+Once ocrmypdf is installed, the built-in help which explains the command syntax and options can be accessed via:
+
+.. code-block:: bash
+
+   ocrmypdf --help
+
+Our `documentation is served on Read the Docs <https://ocrmypdf.readthedocs.io/en/latest/index.html>`_.
+
+If you detect an issue, please:
+
+-  Check whether your issue is already known
+-  If no problem report exists on github, please create one here:
+   https://github.com/jbarlow83/OCRmyPDF/issues
+-  Describe your problem thoroughly
+-  Append the console output of the script when running the debug mode
+   (``-v 1`` option)
+-  If possible provide your input PDF file as well as the content of the
+   temporary folder (using a file sharing service like Dropbox)
+
+Requirements
+------------
+
+Runs on CPython 3.5, 3.6 and 3.7. Requires external program installations of Ghostscript, Tesseract OCR, QPDF, and Leptonica. ocrmypdf is pure Python, but uses CFFI to portably generate library bindings.
+
+Press & Media
+-------------
+
+-  `c't 1-2014, page 59 <http://heise.de/-2279695>`_:
+   Detailed presentation of OCRmyPDF v1.0 in the leading German IT
+   magazine c't
+-  `heise Open Source, 09/2014: Texterkennung mit
+   OCRmyPDF <http://heise.de/-2356670>`_
+
+License
+-------
+
+The OCRmyPDF software is licensed under the GNU GPLv3. Certain files are covered by other licenses, as noted in their source files.
+
+The license for each test file varies, and is noted in tests/resources/README.rst. The documentation is licensed under Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA 4.0).
+
+OCRmyPDF versions prior to 6.0 were licensed under the MIT License.
+
+Disclaimer
+----------
+
+The software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied.

dev_requirements.txt

@@ -0,0 +1,4 @@
+check-manifest >= 0.35
+twine >= 1.8.1
+coverage >= 4.4
+GitPython == 2.1.3

docs/advanced.rst

@@ -1,192 +1,102 @@
-=================
 Advanced features
 =================
 
-Control of unpaper
-==================
-
-OCRmyPDF uses ``unpaper`` to provide the implementation of the
-``--clean`` and ``--clean-final`` arguments.
-`unpaper <https://github.com/Flameeyes/unpaper/blob/master/doc/basic-concepts.md>`__
-provides a variety of image processing filters to improve images.
-
-By default, OCRmyPDF uses only ``unpaper`` arguments that were found to
-be safe to use on almost all files without having to inspect every page
-of the file afterwards. This is particularly true when only ``--clean``
-is used, since that instructs OCRmyPDF to only clean the image before
-OCR and not the final image.
-
-However, if you wish to use the more aggressive options in ``unpaper``,
-you may use ``--unpaper-args '...'`` to override the OCRmyPDF's defaults
-and forward other arguments to unpaper. This option will forward
-arguments to ``unpaper`` without any knowledge of what that program
-considers to be valid arguments. The string of arguments must be quoted
-as shown in the examples below. No filename arguments may be included.
-OCRmyPDF will assume it can append input and output filename of
-intermediate images to the ``--unpaper-args`` string.
-
-In this example, we tell ``unpaper`` to expect two pages of text on a
-sheet (image), such as occurs when two facing pages of a book are
-scanned. ``unpaper`` uses this information to deskew each independently
-and clean up the margins of both.
-
-.. code-block:: bash
-
-    ocrmypdf --clean --clean-final --unpaper-args '--layout double' input.pdf output.pdf
-    ocrmypdf --clean --clean-final --unpaper-args '--layout double --no-noisefilter' input.pdf output.pdf
-
-.. warning::
-
-   Some ``unpaper`` features will reposition text within the image.
-   ``--clean-final`` is recommended to avoid this issue.
-
-.. warning::
-
-   Some ``unpaper`` features cause multiple input or output files to be
-   consumed or produced. OCRmyPDF requires ``unpaper`` to consume one
-   file and produce one file. An deviation from that condition will
-   result in errors.
-
-.. note::
-
-   ``unpaper`` uses uncompressed PBM/PGM/PPM files for its intermediate
-   files. For large images or documents, it can take a lot of temporary
-   disk space.
-
 Control of OCR options
-======================
+----------------------
 
-OCRmyPDF provides many features to control the behavior of the OCR
-engine, Tesseract.
+OCRmyPDF provides many features to control the behavior of the OCR engine, Tesseract.
 
 When OCR is skipped
--------------------
+"""""""""""""""""""
 
-If a page in a PDF seems to have text, by default OCRmyPDF will exit
-without modifying the PDF. This is to ensure that PDFs that were
-previously OCRed or were "born digital" rather than scanned are not
-processed.
+If a page in a PDF seems to have text, by default OCRmyPDF will exit without modifying the PDF. This is to ensure that PDFs that were previously OCRed or were "born digital" rather than scanned are not processed. 
 
-If ``--skip-text`` is issued, then no OCR will be performed on pages
-that already have text. The page will be copied to the output. This may
-be useful for documents that contain both "born digital" and scanned
-content, or to use OCRmyPDF to normalize and convert to PDF/A regardless
-of their contents.
+If ``--skip-text`` is issued, then no OCR will be performed on pages that already have text. The page will be copied to the output. This may be useful for documents that contain both "born digital" and scanned content, or to use OCRmyPDF to normalize and convert to PDF/A regardless of their contents.
 
-If ``--redo-ocr`` is issued, then a detailed text analysis is performed.
-Text is categorized as either visible or invisible. Invisible text (OCR)
-is stripped out. Then an image of each page is created with visible text
-masked out. The page image is sent for OCR, and any additional text is
-inserted as OCR. If a file contains a mix of text and bitmap images that
-contain text, OCRmyPDF will locate the additional text in images without
-disrupting the existing text.
+If ``--force-ocr`` is issued, then all pages will be rasterized to images, discarding any hidden OCR text, and rasterizing any printable text. This is useful for redoing OCR, for fixing OCR text with a damaged character map (text is selectable but not searchable), and destroying redacted information.
 
-If ``--force-ocr`` is issued, then all pages will be rasterized to
-images, discarding any hidden OCR text, and rasterizing any printable
-text. This is useful for redoing OCR, for fixing OCR text with a damaged
-character map (text is selectable but not searchable), and destroying
-redacted information. Any forms and vector graphics will be rasterized
-as well.
 
 Time and image size limits
---------------------------
+""""""""""""""""""""""""""
 
-By default, OCRmyPDF permits tesseract to run for three minutes (180
-seconds) per page. This is usually more than enough time to find all
-text on a reasonably sized page with modern hardware.
+By default, OCRmyPDF permits tesseract to run for three minutes (180 seconds) per page. This is usually more than enough time to find all text on a reasonably sized page with modern hardware. 
 
-If a page is skipped, it will be inserted without OCR. If preprocessing
-was requested, the preprocessed image layer will be inserted.
+If a page is skipped, it will be inserted without OCR. If preprocessing was requested, the preprocessed image layer will be inserted.
 
-If you want to adjust the amount of time spent on OCR, change
-``--tesseract-timeout``. You can also automatically skip images that
-exceed a certain number of megapixels with ``--skip-big``. (A 300 DPI,
-8.5×11" page is 8.4 megapixels.)
+If you want to adjust the amount of time spent on OCR, change ``--tesseract-timeout``.  You can also automatically skip images that exceed a certain number of megapixels with ``--skip-big``. (A 300 DPI, 8.5×11" page is 8.4 megapixels.)
 
 .. code-block:: bash
 
-    # Allow 300 seconds for OCR; skip any page larger than 50 megapixels
-    ocrmypdf --tesseract-timeout 300 --skip-big 50 bigfile.pdf output.pdf
+	# Allow 300 seconds for OCR; skip any page larger than 50 megapixels
+	ocrmypdf --tesseract-timeout 300 --skip-big 50 bigfile.pdf output.pdf
 
 Overriding default tesseract
-----------------------------
+""""""""""""""""""""""""""""
 
-OCRmyPDF checks the system ``PATH`` for the ``tesseract`` binary.
+OCRmyPDF checks the system ``PATH`` for the ``tesseract`` binary.  
 
-Some relevant environment variables that influence Tesseract's behavior
-include:
+Some relevant environment variables that influence Tesseract's behavior include:
 
 .. envvar:: TESSDATA_PREFIX
 
-   Overrides the path to Tesseract's data files. This can allow
-   simultaneous installation of the "best" and "fast" training data
-   sets. OCRmyPDF does not manage this environment variable.
+	Overrides the path to Tesseract's data files. This can allow simultaneous installation of the "best" and "fast" training data sets. OCRmyPDF does not manage this environment variable.
 
 .. envvar:: OMP_THREAD_LIMIT
 
-   Controls the number of threads Tesseract will use. OCRmyPDF will
-   manage this environment variable if it is not already set.
+	Controls the number of threads Tesseract will use. OCRmyPDF will manage this environment if it is not already set. (Currently, it will set it to 1 because this gives the best results in testing.)
 
-For example, if you have a development build of Tesseract don't wish to
-use the system installation, you can launch OCRmyPDF as follows:
+For example, if you are testing tesseract 4.00 and don't wish to use an existing tesseract 3.04 installation, you can launch OCRmyPDF as follows:
 
 .. code-block:: bash
 
-    env \
-        PATH=/home/user/src/tesseract/api:$PATH \
-        TESSDATA_PREFIX=/home/user/src/tesseract \
-        ocrmypdf input.pdf output.pdf
+	env \
+		PATH=/home/user/src/tesseract4/api:$PATH \
+		TESSDATA_PREFIX=/home/user/src/tesseract4 \
+		ocrmypdf --tesseract-oem 2 input.pdf output.pdf
+
+In this example ``TESSDATA_PREFIX`` directs Tesseract 4.0 to use LSTM training data. ``--tesseract-oem 1`` requests tesseract 4.0's new LSTM engine. (Tesseract 4.0 only.)
 
-In this example ``TESSDATA_PREFIX`` is required to redirect Tesseract to
-an alternate folder for its "tessdata" files.
 
 Overriding other support programs
----------------------------------
+"""""""""""""""""""""""""""""""""
 
 In addition to tesseract, OCRmyPDF uses the following external binaries:
 
--  ``gs`` (Ghostscript)
--  ``unpaper``
--  ``pngquant``
--  ``jbig2``
+* ``gs`` (Ghostscript)
+* ``unpaper``
+* ``qpdf``
+
+In each case OCRmyPDF will search the ``PATH`` environment variable to locate the binaries.
 
-In each case OCRmyPDF will search the ``PATH`` environment variable to
-locate the binaries.
 
 Changing tesseract configuration variables
-------------------------------------------
+""""""""""""""""""""""""""""""""""""""""""
 
-You can override tesseract's default `control
-parameters <https://github.com/tesseract-ocr/tesseract/wiki/ControlParams>`__
-with a configuration file.
+You can override tesseract's default `control parameters <https://github.com/tesseract-ocr/tesseract/wiki/ControlParams>`_ with a configuration file.
 
-As an example, this configuration will disable Tesseract's dictionary
-for current language. Normally the dictionary is helpful for
-interpolating words that are unclear, but it may interfere with OCR if
-the document does not contain many words (for example, a list of part
-numbers).
+As an example, this configuration will disable Tesseract's dictionary for current language. Normally the dictionary is helpful for interpolating words that are unclear, but it may interfere with OCR if the document does not contain many words (for example, a list of part numbers).
 
 Create a file named "no-dict.cfg" with these contents:
 
 ::
 
-    load_system_dawg 0
-    language_model_penalty_non_dict_word 0
-    language_model_penalty_non_freq_dict_word 0
+	load_system_dawg 0
+	language_model_penalty_non_dict_word 0
+	language_model_penalty_non_freq_dict_word 0
 
 then run ocrmypdf as follows (along with any other desired arguments):
 
 .. code-block:: bash
 
-    ocrmypdf --tesseract-config no-dict.cfg input.pdf output.pdf
+	ocrmypdf --tesseract-config no-dict.cfg input.pdf output.pdf
 
 .. warning::
 
-   Some combinations of control parameters will break Tesseract or break
-   assumptions that OCRmyPDF makes about Tesseract's output.
+	Some combinations of control parameters will break Tesseract or break assumptions that OCRmyPDF makes about Tesseract's output.
+
 
 Changing the PDF renderer
-=========================
+-------------------------
 
 rasterizing
   Converting a PDF to an image for display.
@@ -194,151 +104,36 @@ rasterizing
 rendering
   Creating a new PDF from other data (such as an existing PDF).
 
-OCRmyPDF has these PDF renderers: ``sandwich`` and ``hocr``. The
-renderer may be selected using ``--pdf-renderer``. The default is
-``auto`` which lets OCRmyPDF select the renderer to use. Currently,
-``auto`` always selects ``sandwich``.
+
+OCRmyPDF has three PDF renderers: ``sandwich``, ``hocr``, ``tesseract``. The renderer may be selected using ``--pdf-renderer``. The default is ``auto`` which lets OCRmyPDF select the renderer to use. Currently, ``auto`` selects ``sandwich`` for Tesseract 3.05.01 or newer, or ``hocr`` for older versions of Tesseract.
 
 The ``sandwich`` renderer
--------------------------
+"""""""""""""""""""""""""
 
-The ``sandwich`` renderer uses Tesseract's new text-only PDF feature,
-which produces a PDF page that lays out the OCR in invisible text. This
-page is then "sandwiched" onto the original PDF page, allowing lossless
-application of OCR even to PDF pages that contain other vector objects.
+The ``sandwich`` renderer uses Tesseract's new text-only PDF feature, which produces a PDF page that lays out the OCR in invisible text. This page is then "sandwiched" onto the original PDF page, allowing lossless application of OCR even to PDF pages that contain other vector objects.
 
-Currently this is the best renderer for most uses, however it is
-implemented in Tesseract so OCRmyPDF cannot influence it. Currently some
-problematic PDF viewers like Mozilla PDF.js and macOS Preview have
-problems with segmenting its text output, and
-mightrunseveralwordstogether.
+Currently this is the best renderer for most uses, however it is implemented in Tesseract so OCRmyPDF cannot influence it. Currently some problematic PDF viewers like Mozilla PDF.js and macOS Preview have problems with segmenting its text output, and mightrunseveralwordstogether.
 
-When image preprocessing features like ``--deskew`` are used, the
-original PDF will be rendered as a full page and the OCR layer will be
-placed on top.
+When image preprocessing features like ``--deskew`` are used, the original PDF will be rendered as a full page and the OCR layer will be placed on top.
+
+This renderer requires Tesseract 3.05.01 or newer.
 
 The ``hocr`` renderer
----------------------
+"""""""""""""""""""""
 
-The ``hocr`` renderer works with older versions of Tesseract. The image
-layer is copied from the original PDF page if possible, avoiding
-potentially lossy transcoding or loss of other PDF information. If
-preprocessing is specified, then the image layer is a new PDF.
+The ``hocr`` renderer works with older versions of Tesseract. The image layer is copied from the original PDF page if possible, avoiding potentially lossy transcoding or loss of other PDF information. If preprocessing is specified, then the image layer is a new PDF.
 
-Unlike ``sandwich`` this renderer is implemented within OCRmyPDF; anyone
-looking to customize how OCR is presented should look here. A major
-disadvantage of this renderer is it not capable of correctly handling
-text outside the Latin alphabet (specifically, it supports the ISO 8859-1
-character). Pull requests to improve the situation are welcome.
+Unlike ``sandwich`` this renderer is implemented within OCRmyPDF; anyone looking to customize how OCR is presented should look here. A major disadvantage of this renderer is it not capable of correctly handling text outside the Latin alphabet. Pull requests to improve the situation are welcome.
 
-Currently, this renderer has the best compatibility with Mozilla's
-PDF.js viewer.
+Currently, this renderer has the best compatibility with Mozilla's PDF.js viewer.
 
 This works in all versions of Tesseract.
 
 The ``tesseract`` renderer
---------------------------
+""""""""""""""""""""""""""
 
-The ``tesseract`` renderer was removed. OCRmyPDF's new approach to text
-layer grafting makes it functionally equivalent to ``sandwich``.
+The ``tesseract`` renderer creates a PDF with the image and text layers precomposed, meaning that it always transcodes, loses image quality and rasterizes any vector objects. It does a better job on non-Latin text and document structure than ``hocr``.
 
-Return code policy
-==================
+If a PDF created with this renderer using Tesseract versions older than 3.05.00 is then passed through Ghostscript's pdfwrite feature, the OCR text *may* be corrupted. The ``--output-type=pdfa`` argument will produce a warning in this situation.
 
-OCRmyPDF writes all messages to ``stderr``. ``stdout`` is reserved for
-piping output files. ``stdin`` is reserved for piping input files.
-
-The return codes generated by the OCRmyPDF are considered part of the
-stable user interface. They may be imported from
-``ocrmypdf.exceptions``.
-
-.. list-table:: Return codes
-    :widths: 5 35 60
-    :header-rows: 1
-
-    *	- Code
-        - Name
-        - Interpretation
-    *	- 0
-        - ``ExitCode.ok``
-        - Everything worked as expected.
-    *	- 1
-        - ``ExitCode.bad_args``
-        - Invalid arguments, exited with an error.
-    *	- 2
-        - ``ExitCode.input_file``
-        - The input file does not seem to be a valid PDF.
-    *	- 3
-        - ``ExitCode.missing_dependency``
-        - An external program required by OCRmyPDF is missing.
-    *	- 4
-        - ``ExitCode.invalid_output_pdf``
-        - An output file was created, but it does not seem to be a valid PDF. The file will be available.
-    *	- 5
-        - ``ExitCode.file_access_error``
-        - The user running OCRmyPDF does not have sufficient permissions to read the input file and write the output file.
-    *	- 6
-        - ``ExitCode.already_done_ocr``
-        - The file already appears to contain text so it may not need OCR. See output message.
-    *	- 7
-        - ``ExitCode.child_process_error``
-        - An error occurred in an external program (child process) and OCRmyPDF cannot continue.
-    *	- 8
-        - ``ExitCode.encrypted_pdf``
-        - The input PDF is encrypted. OCRmyPDF does not read encrypted PDFs. Use another program such as ``qpdf`` to remove encryption.
-    *	- 9
-        - ``ExitCode.invalid_config``
-        - A custom configuration file was forwarded to Tesseract using ``--tesseract-config``, and Tesseract rejected this file.
-    *   - 10
-        - ``ExitCode.pdfa_conversion_failed``
-        - A valid PDF was created, PDF/A conversion failed. The file will be available.
-    *	- 15
-        - ``ExitCode.other_error``
-        - Some other error occurred.
-    *	- 130
-        - ``ExitCode.ctrl_c``
-        - The program was interrupted by pressing Ctrl+C.
-
-
-Debugging the intermediate files
-================================
-
-OCRmyPDF normally saves its intermediate results to a temporary folder
-and deletes this folder when it exits, whether it succeeded or failed.
-
-If the ``-k`` argument is issued on the command line, OCRmyPDF will keep
-the temporary folder and print the location, whether it succeeded or
-failed (provided the Python interpreter did not crash). An example
-message is:
-
-.. code-block:: none
-
-    Temporary working files retained at:
-    /tmp/ocrmypdf.io.u20wpz07
-
-The organization of this folder is an implementation detail and subject
-to change between releases. However the general organization is that
-working files on a per page basis have the page number as a prefix
-(starting with page 1), an infix indicates the processing stage, and a
-suffix indicates the file type. Some important files include:
-
--  ``_rasterize.png`` - what the input page looks like
--  ``_ocr.png`` - the file that is sent to Tesseract for OCR; depending
-   on arguments this may differ from the presentation image
--  ``_pp_deskew.png`` - the image, after deskewing
--  ``_pp_clean.png`` - the image, after cleaning with unpaper
--  ``_ocr_tess.pdf`` - the OCR file; appears as a blank page with invisible
-   text embedded
--  ``_ocr_tess.txt`` - the OCR text (not necessarily all text on the page,
-   if the page is mixed format)
--  ``fix_docinfo.pdf`` - a temporary file created to fix the PDF DocumentInfo
-   data structure
--  ``graft_layers.pdf`` - the rendered PDF with OCR layers grafted on
--  ``pdfa.pdf`` - ``graft_layers.pdf`` after conversion to PDF/A
--  ``pdfa.ps`` - a PostScript file used by Ghostscript for PDF/A conversion
--  ``optimize.pdf`` - the PDF generated before optimization
--  ``optimize.out.pdf`` - the PDF generated by optimization
--  ``origin`` - the input file
--  ``origin.pdf`` - the input file or the input image converted to PDF
--  ``images/*`` - images extracted during the optimization process; here
-   the prefix indicates a PDF object ID not a page number
+*This renderer is deprecated and will be removed whenever support for older versions of Tesseract is dropped.*

docs/api.rst

@@ -1,117 +0,0 @@
-======================
-Using the OCRmyPDF API
-======================
-
-OCRmyPDF originated as a command line program and continues to have this
-legacy, but parts of it can be imported and used in other Python
-applications.
-
-Some applications may want to consider running ocrmypdf from a
-subprocess call anyway, as this provides isolation of its activities.
-
-Example
-=======
-
-OCRmyPDF one high-level function to run its main engine from an
-application. The parameters are symmetric to the command line arguments
-and largely have the same functions.
-
-.. code-block:: python
-
-    import ocrmypdf
-
-    if __name__ == '__main__':  # To ensure correct behavior on Windows and macOS
-        ocrmypdf.ocr('input.pdf', 'output.pdf', deskew=True)
-
-With a few exceptions, all of the command line arguments are available
-and may be passed as equivalent keywords.
-
-A few differences are that ``verbose`` and ``quiet`` are not available.
-Instead, output should be managed by configuring logging.
-
-Parent process requirements
----------------------------
-
-The :func:`ocrmypdf.ocr` function runs OCRmyPDF similar to command line
-execution. To do this, it will:
-
-- create a monitoring thread
-- create worker processes (on Linux, forking itself; on Windows and macOS, by
-  spawning)
-- manage the signal flags of its worker processes
-- execute other subprocesses (forking and executing other programs)
-
-The Python process that calls ``ocrmypdf.ocr()`` must be sufficiently
-privileged to perform these actions.
-
-There currently is no option to manage how jobs are scheduled other
-than the argument ``jobs=`` which will limit the number of worker
-processes.
-
-Creating a child process to call ``ocrmypdf.ocr()`` is suggested. That
-way your application will survive and remain interactive even if
-OCRmyPDF fails for any reason.
-
-Programs that call ``ocrmypdf.ocr()`` should also install a SIGBUS signal
-handler (except on Windows), to raise an exception if access to a memory
-mapped file fails. OCRmyPDF may use memory mapping.
-
-``ocrmypdf.ocr()`` will take a threading lock to prevent multiple runs of itself
-in the same Python interpreter process. This is not thread-safe, because of how
-OCRmyPDF's plugins and Python's library import system work. If you need to parallelize
-OCRmyPDF, use processes.
-
-.. warning::
-
-    On Windows and macOS, the script that calls ``ocrmypdf.ocr()`` must be
-    protected by an "ifmain" guard (``if __name__ == '__main__'``). If you do
-    not take at least one of these steps, process semantics will prevent
-    OCRmyPDF from working correctly.
-
-Logging
--------
-
-OCRmyPDF will log under loggers named ``ocrmypdf``. In addition, it
-imports ``pdfminer`` and ``PIL``, both of which post log messages under
-those logging namespaces.
-
-You can configure the logging as desired for your application or call
-:func:`ocrmypdf.configure_logging` to configure logging the same way
-OCRmyPDF itself does. The command line parameters such as ``--quiet``
-and ``--verbose`` have no equivalents in the API; you must use the
-provided configuration function or do configuration in a way that suits
-your use case.
-
-Progress monitoring
--------------------
-
-OCRmyPDF uses the ``tqdm`` package to implement its progress bars.
-:func:`ocrmypdf.configure_logging` will set up logging output to
-``sys.stderr`` in a way that is compatible with the display of the
-progress bar. Use ``ocrmypdf.ocr(...progress_bar=False)`` to disable
-the progress bar.
-
-Exceptions
-----------
-
-OCRmyPDF may throw standard Python exceptions, ``ocrmypdf.exceptions.*``
-exceptions, some exceptions related to multiprocessing, and
-``KeyboardInterrupt``. The parent process should provide an exception
-handler. OCRmyPDF will clean up its temporary files and worker processes
-automatically when an exception occurs.
-
-Programs that call OCRmyPDF should consider trapping KeyboardInterrupt
-so that they allow OCR to terminate with the whole program terminating.
-
-When OCRmyPDF succeeds conditionally, it returns an integer exit code.
-
-Reference
----------
-
-.. autofunction:: ocrmypdf.ocr
-
-.. autoclass:: ocrmypdf.Verbosity
-    :members:
-    :undoc-members:
-
-.. autofunction:: ocrmypdf.configure_logging

docs/apiref.rst

@@ -1,55 +0,0 @@
-=============
-API Reference
-=============
-
-This page summarizes the rest of the public API. Generally speaking this
-should mainly of interest to plugin developers.
-
-ocrmypdf
-========
-
-.. autoclass:: ocrmypdf.PageContext
-    :members:
-
-.. autoclass:: ocrmypdf.PdfContext
-    :members:
-
-ocrmypdf.exceptions
-===================
-
-.. automodule:: ocrmypdf.exceptions
-    :members:
-    :undoc-members:
-
-ocrmypdf.helpers
-================
-
-.. automodule:: ocrmypdf.helpers
-    :members:
-    :noindex: deprecated
-
-    .. autodecorator:: deprecated
-
-ocrmypdf.hocrtransform
-======================
-
-.. automodule:: ocrmypdf.hocrtransform
-    :members:
-
-ocrmypdf.pdfa
-=============
-
-.. automodule:: ocrmypdf.pdfa
-    :members:
-
-ocrmypdf.quality
-================
-
-.. automodule:: ocrmypdf.quality
-    :members:
-
-ocrmypdf.subprocess
-===================
-
-.. automodule:: ocrmypdf.subprocess
-    :members:

docs/batch.rst

@@ -1,217 +1,214 @@
-================
 Batch processing
 ================
 
-This article provides information about running OCRmyPDF on multiple
-files or configuring it as a service triggered by file system events.
+This article provides information about running OCRmyPDF on multiple files or configuring it as a service triggered by file system events.
 
 Batch jobs
-==========
+----------
 
-Consider using the excellent `GNU
-Parallel <https://www.gnu.org/software/parallel/>`__ to apply OCRmyPDF
-to multiple files at once.
+Consider using the excellent `GNU Parallel <https://www.gnu.org/software/parallel/>`_ to apply OCRmyPDF to multiple files at once.
 
-Both ``parallel`` and ``ocrmypdf`` will try to use all available
-processors. To maximize parallelism without overloading your system with
-processes, consider using ``parallel -j 2`` to limit parallel to running
-two jobs at once.
+Both ``parallel`` and ``ocrmypdf`` will try to use all available processors. To maximize parallelism without overloading your system with processes, consider using ``parallel -j 2`` to limit parallel to running two jobs at once.
 
-This command will run all ocrmypdf all files named ``*.pdf`` in the
-current directory and write them to the previous created ``output/``
-folder. It will not search subdirectories.
+This command will run all ocrmypdf all files named ``*.pdf`` in the current directory and write them to the previous created ``output/`` folder. It will not search subdirectories.
 
-The ``--tag`` argument tells parallel to print the filename as a prefix
-whenever a message is printed, so that one can trace any errors to the
-file that produced them.
+The ``--tag`` argument tells parallel to print the filename as a prefix whenever a message is printed, so that one can trace any errors to the file that produced them.
 
 .. code-block:: bash
 
-   parallel --tag -j 2 ocrmypdf '{}' 'output/{}' ::: *.pdf
+	parallel --tag -j 2 ocrmypdf '{}' 'output/{}' ::: *.pdf
 
-OCRmyPDF automatically repairs PDFs before parsing and gathering
-information from them.
+OCRmyPDF automatically repairs PDFs before parsing and gathering information from them.  If you are already repairing PDFs with ``qpdf`` prior to attempting OCR, or you can use ``--skip-repair`` to skip this step.  It may improve performance for large files, since repairing PDFs is single-threaded.
 
 Directory trees
-===============
-
-This will walk through a directory tree and run OCR on all files in
-place, printing the output in a way that makes
-
-.. code-block:: bash
-
-   find . -printf '%p' -name '*.pdf' -exec ocrmypdf '{}' '{}' \;
-
-Alternatively, with a docker container (mounts a volume to the container
-where the PDFs are stored):
-
-.. code-block:: bash
-
-   find . -printf '%p' -name '*.pdf' -exec docker run --rm -v <host dir>:<container dir> jbarlow83/ocrmypdf '<container dir>/{}' '<container dir>/{}' \;
-
-This only runs one ``ocrmypdf`` process at a time. This variation uses
-``find`` to create a directory list and ``parallel`` to parallelize runs
-of ``ocrmypdf``, again updating files in place.
-
-.. code-block:: bash
-
-   find . -name '*.pdf' | parallel --tag -j 2 ocrmypdf '{}' '{}'
-
-In a Windows batch file, use
-
-.. code-block:: bat
-
-   for /r %%f in (*.pdf) do ocrmypdf %%f %%f
-
-Sample script
--------------
-
-This user contributed script also provides an example of batch
-processing.
-
-.. literalinclude:: ../misc/batch.py
-    :caption: misc/batch.py
-
-Synology DiskStations
----------------------
-
-Synology DiskStations (Network Attached Storage devices) can run the
-Docker image of OCRmyPDF if the Synology `Docker
-package <https://www.synology.com/en-global/dsm/packages/Docker>`__ is
-installed. Attached is a script to address particular quirks of using
-OCRmyPDF on one of these devices.
-
-This is only possible for x86-based Synology products. Some Synology
-products use ARM or Power processors and do not support Docker. Further
-adjustments might be needed to deal with the Synology's relatively
-limited CPU and RAM.
-
-.. literalinclude:: ../misc/synology.py
-    :caption: misc/synology.py - Sample script for Synology DiskStations
-
-Huge batch jobs
 ---------------
 
-If you have thousands of files to work with, contact the author.
-Consulting work related to OCRmyPDF helps fund this open source project
-and all inquiries are appreciated.
+This will walk through a directory tree and run OCR on all files in place, printing the output in a way that makes 
+
+.. code-block:: bash
+
+	find . --printf '%p' -name '*.pdf' -exec ocrmypdf '{}' '{}' \;
+
+This only runs one ``ocrmypdf`` process at a time. This variation uses ``find`` to create a directory list and ``parallel`` to parallelize runs of ``ocrmypdf``, again updating files in place.
+
+.. code-block:: bash
+
+	find . -name '*.pdf' | parallel --tag -j 2 ocrmypdf '{}' '{}'
+
+
+Sample script
+"""""""""""""
+
+This user contributed script also provides an example of batch processing.
+
+.. code-block:: python
+
+	#!/usr/bin/env python3
+	# Walk through directory tree, replacing all files with OCR'd version
+	# Contributed by DeliciousPickle@github
+
+	import logging
+	import os
+	import subprocess
+	import sys
+
+	script_dir = os.path.dirname(os.path.realpath(__file__))
+	print(script_dir + '/ocr-tree.py: Start')
+
+	if len(sys.argv) > 1:
+	    start_dir = sys.argv[1]
+	else:
+	    start_dir = '.'
+
+	if len(sys.argv) > 2:
+	    log_file = sys.argv[2]
+	else:
+	    log_file = script_dir + '/ocr-tree.log'
+
+	logging.basicConfig(
+			level=logging.INFO, format='%(asctime)s %(message)s', 
+			filename=log_file, filemode='w')
+
+	for dir_name, subdirs, file_list in os.walk(start_dir):
+	    logging.info('\n')
+	    logging.info(dir_name + '\n')
+	    os.chdir(dir_name)
+	    for filename in file_list:
+	        file_ext = os.path.splitext(filename)[1]
+	        if file_ext == '.pdf':
+	            full_path = dir_name + '/' + filename
+	            print(full_path)
+	            cmd = ["ocrmypdf",  "--deskew", filename, filename]
+	            logging.info(cmd)
+	            proc = subprocess.Popen(
+	            	cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
+	            result = proc.stdout.read()
+	            if proc.returncode == 6:
+	                print("Skipped document because it already contained text")
+	            elif proc.returncode == 0:
+	                print("OCR complete")
+	            logging.info(result)
+
+API
+"""
+
+OCRmyPDF is currently supported as a command line interface. This means that even if you are using OCRmyPDF in a Python script, you should run it in a subprocess rather importing the ocrmypdf package.
+
+The reason for this limitation is that the `ruffus <https://github.com/bunbun/ruffus/>`_ library that OCRmyPDF depends on is unfortunately not reentrant. OCRmyPDF works by defining each operation it does as a ruffus task that takes one or more files as input and generates one or more files as output. As such ruffus is fairly fundamental.
+
+(If you find individual functions implemented in OCRmyPDF useful (such as ``ocrmypdf.pdfinfo``), you can use these if you wish to.)
+
+
+Synology DiskStations
+"""""""""""""""""""""
+
+Synology DiskStations (Network Attached Storage devices) can run the Docker image of OCRmyPDF if the Synology `Docker package <https://www.synology.com/en-global/dsm/packages/Docker>`_ is installed. Attached is a script to address particular quirks of using OCRmyPDF on one of these devices.
+
+This is only possible for x86-based Synology products. Some Synology products use ARM or Power processors and do not support Docker. Further adjustments might be needed to deal with the Synology's relatively limited CPU and RAM.
+
+.. code-block:: python
+
+	#!/bin/env python3
+	# Contributed by github.com/Enantiomerie
+
+	# script needs 2 arguments
+	# 1. source dir with *.pdf - default is location of script
+	# 2. move dir where *.pdf and *_OCR.pdf are moved to
+
+	import logging
+	import os
+	import subprocess
+	import sys
+	import time
+	import shutil
+
+	script_dir = os.path.dirname(os.path.realpath(__file__))
+	timestamp = time.strftime("%Y-%m-%d-%H%M_")
+	log_file = script_dir + '/' + timestamp + 'ocrmypdf.log'
+	logging.basicConfig(level=logging.INFO, format='%(asctime)s %(message)s', filename=log_file, filemode='w')
+
+	if len(sys.argv) > 1:
+	    start_dir = sys.argv[1]
+	else:
+	    start_dir = '.'
+
+	for dir_name, subdirs, file_list in os.walk(start_dir):
+	    logging.info('\n')
+	    logging.info(dir_name + '\n')
+	    os.chdir(dir_name)
+	    for filename in file_list:
+	        file_ext = os.path.splitext(filename)[1]
+	        if file_ext == '.pdf':
+	            full_path = dir_name + '/' + filename
+	            file_noext = os.path.splitext(filename)[0]
+	            timestamp_OCR = time.strftime("%Y-%m-%d-%H%M_OCR_")
+	            filename_OCR = timestamp_OCR + file_noext + '.pdf'
+	            docker_mount = dir_name + ':/home/docker'
+	# create string for pdf processing 
+	# diskstation needs a user:group docker:docker. find uid:gid of your diskstation docker:docker with id docker.
+	# use this uid:gid in -u flag
+	# rw rights for docker:docker at source dir are also necessary
+	# the script is processed as root user via chron 
+	            cmd = ['docker', 'run', '--rm', '-v', docker_mount, '-u=1030:65538', 'jbarlow83/ocrmypdf', , '--deskew' , filename, filename_OCR]
+	            logging.info(cmd)
+	            proc = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
+	            result = proc.stdout.read()
+	            logging.info(result)
+	            full_path_OCR = dir_name + '/' + filename_OCR
+	            os.chmod(full_path_OCR, 0o666)
+	            os.chmod(full_path, 0o666)
+	            full_path_OCR_archive = sys.argv[2]
+	            full_path_archive = sys.argv[2] + '/no_ocr'
+	            shutil.move(full_path_OCR,full_path_OCR_archive)
+	            shutil.move(full_path, full_path_archive)
+	logging.info('Finished.\n')
+
+
+
+Huge batch jobs
+"""""""""""""""
+
+If you have thousands of files to work with, contact the author. Consulting work related to OCRmyPDF helps fund this open source project and all inquiries are appreciated.
+
 
 Hot (watched) folders
-=====================
+---------------------
 
-Watched folders with watcher.py
--------------------------------
+To set up a "hot folder" that will trigger OCR for every file inserted, use a program like Python `watchdog <https://pypi.python.org/pypi/watchdog>`_ (supports all major OS).
 
-OCRmyPDF has a folder watcher called watcher.py, which is currently included in source
-distributions but not part of the main program. It may be used natively or may run
-in a Docker container. Native instances tend to give better performance. watcher.py
-works on all platforms.
-
-Users may need to customize the script to meet their requirements.
+One could then configure a scanner to automatically place scanned files in a hot folder, so that they will be queued for OCR and copied to the destination.
 
 .. code-block:: bash
 
-    pip3 install ocrmypdf[watcher]
+	pip install watchdog
 
-    env OCR_INPUT_DIRECTORY=/mnt/input-pdfs \
-        OCR_OUTPUT_DIRECTORY=/mnt/output-pdfs \
-        OCR_OUTPUT_DIRECTORY_YEAR_MONTH=1 \
-        python3 watcher.py
-
-.. csv-table:: watcher.py environment variables
-    :header: "Environment variable", "Description"
-    :widths: 50, 50
-
-    "OCR_INPUT_DIRECTORY", "Set input directory to monitor (recursive)"
-    "OCR_OUTPUT_DIRECTORY", "Set output directory (should not be under input)"
-    "OCR_ON_SUCCESS_DELETE", "This will delete the input file if the exit code is 0 (OK)"
-    "OCR_OUTPUT_DIRECTORY_YEAR_MONTH", "This will place files in the output in ``{output}/{year}/{month}/{filename}``"
-    "OCR_DESKEW", "Apply deskew to crooked input PDFs"
-    "OCR_JSON_SETTINGS", "A JSON string specifying any other arguments for ``ocrmypdf.ocr``, e.g. ``'OCR_JSON_SETTINGS={""rotate_pages"": true}'``."
-    "OCR_POLL_NEW_FILE_SECONDS", "Polling interval"
-    "OCR_LOGLEVEL", "Level of log messages to report"
-
-One could configure a networked scanner or scanning computer to drop files in the
-watched folder.
-
-Watched folders with Docker
----------------------------
-
-The watcher service is included in the OCRmyPDF Docker image. To run it:
+watchdog installs the command line program ``watchmedo``, which can be told to run ``ocrmypdf`` on any .pdf added to the current directory (``.``) and place the result in the previously created ``out/`` folder.
 
 .. code-block:: bash
 
-    docker run \
-        -v <path to files to convert>:/input \
-        -v <path to store results>:/output \
-        -e OCR_OUTPUT_DIRECTORY_YEAR_MONTH=1 \
-        -e OCR_ON_SUCCESS_DELETE=1 \
-        -e OCR_DESKEW=1 \
-        -e PYTHONUNBUFFERED=1 \
-        -it --entrypoint python3 \
-        jbarlow83/ocrmypdf \
-        watcher.py
+	cd hot-folder
+	mkdir out
+	watchmedo shell-command \
+		--patterns="*.pdf" \
+		--ignore-directories \
+		--command='ocrmypdf "${watch_src_path}" "out/${watch_src_path}" ' \
+		.  # don't forget the final dot
 
-This service will watch for a file that matches ``/input/\*.pdf`` and will
-convert it to a OCRed PDF in ``/output/``. The parameters to this image are:
+For more complex behavior you can write a Python script around to use the watchdog API.
 
-.. csv-table:: watcher.py parameters for Docker
-    :header: "Parameter", "Description"
-    :widths: 50, 50
-
-    "``-v <path to files to convert>:/input``", "Files placed in this location will be OCRed"
-    "``-v <path to store results>:/output``", "This is where OCRed files will be stored"
-    "``-e OCR_OUTPUT_DIRECTORY_YEAR_MONTH=1``", "Define environment variable OCR_OUTPUT_DIRECTORY_YEAR_MONTH=1"
-    "``-e OCR_ON_SUCCESS_DELETE=1``", "Define environment variable"
-    "``-e OCR_DESKEW=1``", "Define environment variable"
-    "``-e PYTHONBUFFERED=1``", "This will force STDOUT to be unbuffered and allow you to see messages in docker logs"
-
-This service relies on polling to check for changes to the filesystem. It
-may not be suitable for some environments, such as filesystems shared on a
-slow network.
-
-A configuration manager such as Docker Compose could be used to ensure that the
-service is always available.
-
-.. literalinclude:: ../misc/docker-compose.example.yml
-    :language: yaml
-    :caption: misc/docker-compose.example.yml
+On file servers, you could configure watchmedo as a system service so it will run all the time.
 
 Caveats
--------
+"""""""
 
--  ``watchmedo`` may not work properly on a networked file system,
-   depending on the capabilities of the file system client and server.
--  This simple recipe does not filter for the type of file system event,
-   so file copies, deletes and moves, and directory operations, will all
-   be sent to ocrmypdf, producing errors in several cases. Disable your
-   watched folder if you are doing anything other than copying files to
-   it.
--  If the source and destination directory are the same, watchmedo may
-   create an infinite loop.
--  On BSD, FreeBSD and older versions of macOS, you may need to increase
-   the number of file descriptors to monitor more files, using
-   ``ulimit -n 1024`` to watch a folder of up to 1024 files.
+* ``watchmedo`` may not work properly on a networked file system, depending on the capabilities of the file system client and server.
+* This simple recipe does not filter for the type of file system event, so file copies, deletes and moves, and directory operations, will all be sent to ocrmypdf, producing errors in several cases. Disable your watched folder if you are doing anything other than copying files to it.
+* If the source and destination directory are the same, watchmedo may create an infinite loop.
+* On BSD, FreeBSD and older versions of macOS, you may need to increase the number of file descriptors to monitor more files, using ``ulimit -n 1024`` to watch a folder of up to 1024 files.
 
 Alternatives
-------------
+""""""""""""
 
--  On Linux, `systemd user services <https://wiki.archlinux.org/index.php/Systemd/User>`__
-   can be configured to automatically perform OCR on a collection of files.
+* `Watchman <https://facebook.github.io/watchman/>`_ is a more powerful alternative to ``watchmedo``.
 
--  `Watchman <https://facebook.github.io/watchman/>`__ is a more
-   powerful alternative to ``watchmedo``.
 
-macOS Automator
-===============
-
-You can use the Automator app with macOS, to create a Workflow or Quick
-Action. Use a *Run Shell Script* action in your workflow. In the context
-of Automator, the ``PATH`` may be set differently your Terminal's
-``PATH``; you may need to explicitly set the PATH to include
-``ocrmypdf``. The following example may serve as a starting point:
-
-.. figure:: images/macos-workflow.png
-    :alt: Example macOS Automator workflow
-
-You may customize the command sent to ocrmypdf.

docs/conf.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# -*- coding: utf-8 -*-
 #
 # ocrmypdf documentation build configuration file, created by
 # sphinx-quickstart on Sun Sep  4 14:29:43 2016.
@@ -20,8 +21,6 @@
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
-"""isort:skip_file"""
-
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -31,11 +30,9 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.napoleon', 'sphinx_issues']
-
-# Extension settings
-napoleon_use_rtype = False
-issues_github_path = "jbarlow83/OCRmyPDF"
+extensions = [
+    # 'sphinx.ext.mathjax',
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -55,9 +52,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = 'ocrmypdf'
-copyright = (
-    '2020, James R. Barlow. Licensed under Creative Commons Attribution-ShareAlike 4.0.'
-)
+copyright = '2018, James R. Barlow. Licensed under Creative Commons Attribution-ShareAlike 4.0.'
 author = 'James R. Barlow'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -65,36 +60,13 @@ author = 'James R. Barlow'
 # built documents.
 #
 # The short X.Y version.
+from ocrmypdf import __version__ as OCRMYPDF_VERSION
 
-import os
-
-on_rtd = os.environ.get('READTHEDOCS') == 'True'
-
-if on_rtd:
-    # Help ReadTheDocs avoid having to install any binary extension modules
-    import sys
-    from unittest.mock import MagicMock
-
-    class Mock(MagicMock):
-        @classmethod
-        def __getattr__(cls, name):
-            return MagicMock()
-
-    MOCK_MODULES = [
-        'pikepdf',
-        'pikepdf.models',
-        'pikepdf.models.metadata',
-        'ocrmypdf.leptonica',
-    ]
-    sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
-
-
-from pkg_resources import get_distribution, DistributionNotFound
+_version_parts = OCRMYPDF_VERSION.split('.')
 
+version = '.'.join(_version_parts[0:2])
 # The full version, including alpha/beta/rc tags.
-release = get_distribution('ocrmypdf').version
-version = '.'.join(release.split('.')[:2])
-
+release = OCRMYPDF_VERSION
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -163,7 +135,9 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-html_theme_options = {'display_version': False}
+html_theme_options = {
+    'display_version': False
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
@@ -180,7 +154,7 @@ html_theme_options = {'display_version': False}
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
 #
-# html_logo = "images/logo.svg"  # looks bad
+# html_logo = None
 
 # The name of an image file (relative to this directory) to use as a favicon of
 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
@@ -276,25 +250,29 @@ htmlhelp_basename = 'ocrmypdfdoc'
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-    # The paper size ('letterpaper' or 'a4paper').
-    #
-    # 'papersize': 'letterpaper',
-    # The font size ('10pt', '11pt' or '12pt').
-    #
-    # 'pointsize': '10pt',
-    # Additional stuff for the LaTeX preamble.
-    #
-    # 'preamble': '',
-    # Latex figure (float) alignment
-    #
-    # 'figure_align': 'htbp',
+     # The paper size ('letterpaper' or 'a4paper').
+     #
+     # 'papersize': 'letterpaper',
+
+     # The font size ('10pt', '11pt' or '12pt').
+     #
+     # 'pointsize': '10pt',
+
+     # Additional stuff for the LaTeX preamble.
+     #
+     # 'preamble': '',
+
+     # Latex figure (float) alignment
+     #
+     # 'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'ocrmypdf.tex', 'ocrmypdf Documentation', 'James R. Barlow', 'manual')
+    (master_doc, 'ocrmypdf.tex', 'ocrmypdf Documentation',
+     'James R. Barlow', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -334,7 +312,10 @@ latex_documents = [
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, 'ocrmypdf', 'ocrmypdf Documentation', [author], 1)]
+man_pages = [
+    (master_doc, 'ocrmypdf', 'ocrmypdf Documentation',
+     [author], 1)
+]
 
 # If true, show URL addresses after external links.
 #
@@ -347,15 +328,9 @@ man_pages = [(master_doc, 'ocrmypdf', 'ocrmypdf Documentation', [author], 1)]
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (
-        master_doc,
-        'ocrmypdf',
-        'ocrmypdf Documentation',
-        author,
-        'ocrmypdf',
-        'One line description of project.',
-        'Miscellaneous',
-    )
+    (master_doc, 'ocrmypdf', 'ocrmypdf Documentation',
+     author, 'ocrmypdf', 'One line description of project.',
+     'Miscellaneous'),
 ]
 
 # Documents to append as an appendix to all manuals.

docs/contributing.rst

@@ -1,67 +0,0 @@
-=======================
-Contributing guidelines
-=======================
-
-Contributions are welcome!
-
-Big changes
-===========
-
-Please open a new issue to discuss or propose a major change. Not only is it fun
-to discuss big ideas, but we might save each other's time too. Perhaps some of the
-work you're contemplating is already half-done in a development branch.
-
-Code style
-==========
-
-We use PEP8, ``black`` for code formatting and ``isort`` for import sorting. The
-settings for these programs are in ``pyproject.toml`` and ``setup.cfg``. Pull
-requests should follow the style guide. One difference we use from "black" style
-is that strings shown to the user are always in double quotes (``"``) and strings
-for internal uses are in single quotes (``'``).
-
-Tests
-=====
-
-New features should come with tests that confirm their correctness.
-
-New Python dependencies
-=======================
-
-If you are proposing a change that will require a new Python dependency, we
-prefer dependencies that are already packaged by Debian or Red Hat. This makes
-life much easier for our downstream package maintainers.
-
-Python dependencies must also be license-compatible. GPLv3 or AGPLv3 are likely
-incompatible with the project's license, but LGPLv3 is compatible.
-
-New non-Python dependencies
-===========================
-
-OCRmyPDF uses several external programs (Tesseract, Ghostscript and others) for
-its functionality. In general we prefer to avoid adding new external programs.
-
-Style guide: Is it OCRmyPDF or ocrmypdf?
-========================================
-
-The program/project is OCRmyPDF and the name of the executable or library is ocrmypdf.
-
-Known ports/packagers
-=====================
-
-OCRmyPDF has been ported to many platforms already. If you are interesting in
-porting to a new platform, check with
-`Repology <https://repology.org/projects/?search=ocrmypdf>`__ to see the status
-of that platform.
-
-Packager maintainers, please ensure that the command line completion scripts in
-``misc/`` are installed.
-
-Copyright and license
-=====================
-
-For contributions over 10 lines of code, please include your name to list of
-copyright holders for that file. The core program is licensed under MPL-2.0,
-test files and documentation under CC-BY-SA 4.0, and miscellaneous files under
-MIT. Please contribute code only that you wrote and you have the permission to
-contribute or license to us.

docs/cookbook.rst

@@ -1,12 +1,11 @@
-========
 Cookbook
 ========
 
 Basic examples
-==============
+--------------
 
 Help!
------
+"""""
 
 ocrmypdf has built-in help.
 
@@ -14,29 +13,30 @@ ocrmypdf has built-in help.
 
     ocrmypdf --help
 
+
 Add an OCR layer and convert to PDF/A
--------------------------------------
+"""""""""""""""""""""""""""""""""""""
 
 .. code-block:: bash
 
     ocrmypdf input.pdf output.pdf
 
 Add an OCR layer and output a standard PDF
-------------------------------------------
+""""""""""""""""""""""""""""""""""""""""""
 
 .. code-block:: bash
 
     ocrmypdf --output-type pdf input.pdf output.pdf
 
 Create a PDF/A with all color and grayscale images converted to JPEG
---------------------------------------------------------------------
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 
 .. code-block:: bash
 
     ocrmypdf --output-type pdfa --pdfa-image-compression jpeg input.pdf output.pdf
 
 Modify a file in place
-----------------------
+""""""""""""""""""""""
 
 The file will only be overwritten if OCRmyPDF is successful.
 
@@ -45,76 +45,45 @@ The file will only be overwritten if OCRmyPDF is successful.
     ocrmypdf myfile.pdf myfile.pdf
 
 Correct page rotation
----------------------
+"""""""""""""""""""""
 
-OCR will attempt to automatic correct the rotation of each page. This
-can help fix a scanning job that contains a mix of landscape and
-portrait pages.
+OCR will attempt to automatic correct the rotation of each page. This can help fix a scanning job that contains a mix of landscape and portrait pages.
 
 .. code-block:: bash
 
     ocrmypdf --rotate-pages myfile.pdf myfile.pdf
 
-You can increase (decrease) the parameter ``--rotate-pages-threshold``
-to make page rotation more (less) aggressive. The threshold number is the ratio
-of how confidence the OCR engine is that the document image should be changed,
-compared to kept the same. The default value is quite conservative; on some files
-it may not attempt rotations at all unless it is very confident that the current
-rotation is wrong. A lower value of ``2.0`` will produce more rotations, and
-more false positives. Run with ``-v1`` to see the confidence level for each
-page to see if there may be a better value for your files.
+You can increase (decrease) the parameter ``--rotate-pages-threshold`` to make page rotation more (less) aggressive.
+
+If the page is "just a little off horizontal", like a crooked picture, then you want ``--deskew``. ``--rotate-pages`` is for when the cardinal angle is wrong.
 
-If the page is "just a little off horizontal", like a crooked picture,
-then you want ``--deskew``. ``--rotate-pages`` is for when the cardinal
-angle is wrong.
 
 OCR languages other than English
---------------------------------
+""""""""""""""""""""""""""""""""
 
-OCRmyPDF assumes the document is in English unless told otherwise. OCR
-quality may be poor if the wrong language is used.
+By default OCRmyPDF assumes the document is English. 
 
 .. code-block:: bash
 
     ocrmypdf -l fra LeParisien.pdf LeParisien.pdf
     ocrmypdf -l eng+fra Bilingual-English-French.pdf Bilingual-English-French.pdf
 
-Language packs must be installed for all languages specified. See
-:ref:`Installing additional language packs <lang-packs>`.
+Language packs must be installed for all languages specified. See :ref:`Installing additional language packs <lang-packs>`.
 
-Unfortunately, the Tesseract OCR engine has no ability to detect the
-language when it is unknown.
 
 Produce PDF and text file containing OCR text
----------------------------------------------
+"""""""""""""""""""""""""""""""""""""""""""""
 
-This produces a file named "output.pdf" and a companion text file named
-"output.txt".
+This produces a file named "output.pdf" and a companion text file named "output.txt".
 
 .. code-block:: bash
 
     ocrmypdf --sidecar output.txt input.pdf output.pdf
 
-.. note::
-
-    The sidecar file contains the **OCR text** found by OCRmyPDF. If the document
-    contains pages that already have text, that text will not appear in the
-    sidecar. If the option ``--pages`` is used, only those pages on which OCR
-    was performed will be included in the sidecar. If certain pages were skipped
-    because of options like ``--skip-big`` or ``--tesseract-timeout``, those pages
-    will not be in the sidecar.
-
-    To extract all text from a PDF, whether generated from OCR or otherwise,
-    use a program like Poppler's ``pdftotext`` or ``pdfgrep``.
-
 OCR images, not PDFs
 --------------------
 
-Option: use Tesseract
-~~~~~~~~~~~~~~~~~~~~~
-
-If you are starting with images, you can just use Tesseract directly to
-convert images to PDFs:
+If you are starting with images, you can just use Tesseract 3.04 or later directly to convert images to PDFs:
 
 .. code-block:: bash
 
@@ -125,88 +94,55 @@ convert images to PDFs:
     # When there are multiple images
     tesseract text-file-containing-list-of-image-filenames.txt output-prefix pdf
 
-Tesseract's PDF output is quite good – OCRmyPDF uses it internally, in
-some cases. However, OCRmyPDF has many features not available in
-Tesseract like image processing, metadata control, and PDF/A generation.
+Tesseract's PDF output is quite good – OCRmyPDF uses it by internally by default. However, OCRmyPDF has many features not available in Tesseract like like image processing, metadata control, and PDF/A generation.
 
-Option: use img2pdf
-~~~~~~~~~~~~~~~~~~~
-
-You can also use a program like
-`img2pdf <https://gitlab.mister-muffin.de/josch/img2pdf>`__ to convert
-your images to PDFs, and then pipe the results to run ocrmypdf. The
-``-`` tells ocrmypdf to read standard input.
+Use a program like `img2pdf <https://gitlab.mister-muffin.de/josch/img2pdf>`_ to convert your images to PDFs, and then pipe the results to run ocrmypdf.  The `-` tells ocrmypdf to read standard input.
 
 .. code-block:: bash
 
     img2pdf my-images*.jpg | ocrmypdf - myfile.pdf
 
-``img2pdf`` is recommended because it does an excellent job at
-generating PDFs without transcoding images.
+``img2pdf`` is recommended because it does an excellent job at generating PDFs without transcoding images.
 
-Option: use OCRmyPDF (single images only)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-For convenience, OCRmyPDF can also convert single images to PDFs on its
-own. If the resolution (dots per inch, DPI) of an image is not set or is
-incorrect, it can be overridden with ``--image-dpi``. (As 1 inch is 2.54
-cm, 1 dpi = 0.39 dpcm).
+For convenience, OCRmyPDF can also convert single images to PDFs on its own. If the resolution (dots per inch, DPI) of an image is not set or is incorrect, it can be overridden with ``--image-dpi``. (As 1 inch is 2.54 cm, 1 dpi = 0.39 dpcm).
 
 .. code-block:: bash
 
     ocrmypdf --image-dpi 300 image.png myfile.pdf
 
-If you have multiple images, you must use ``img2pdf`` to convert the
-images to PDF.
-
-Not recommended
-~~~~~~~~~~~~~~~
-
-We caution against using ImageMagick or Ghostscript to convert images to
-PDF, since they may transcode images or produce downsampled images,
-sometimes without warning.
-
-Image processing
-================
-
-OCRmyPDF perform some image processing on each page of a PDF, if
-desired. The same processing is applied to each page. It is suggested
-that the user review files after image processing as these commands
-might remove desirable content, especially from poor quality scans.
-
--  ``--rotate-pages`` attempts to determine the correct orientation for
-   each page and rotates the page if necessary.
--  ``--remove-background`` attempts to detect and remove a noisy
-   background from grayscale or color images. Monochrome images are
-   ignored. This should not be used on documents that contain color
-   photos as it may remove them.
--  ``--deskew`` will correct pages were scanned at a skewed angle by
-   rotating them back into place. Skew determination and correction is
-   performed using `Postl's variance of line
-   sums <http://www.leptonica.org/skew-measurement.html>`__ algorithm as
-   implemented in `Leptonica <http://www.leptonica.org/index.html>`__.
--  ``--clean`` uses
-   `unpaper <https://www.flameeyes.eu/projects/unpaper>`__ to clean up
-   pages before OCR, but does not alter the final output. This makes it
-   less likely that OCR will try to find text in background noise.
--  ``--clean-final`` uses unpaper to clean up pages before OCR and
-   inserts the page into the final output. You will want to review each
-   page to ensure that unpaper did not remove something important.
+If you have multiple images, you must use ``img2pdf`` to convert the images to PDF.
 
 .. note::
 
-   In many cases image processing will rasterize PDF pages as images,
-   potentially losing quality.
+    ImageMagick ``convert`` can also convert a group of images to PDF, but in the author's experience it takes a long time, transcodes unnecessarily and gives poor results.
+
+
+Image processing
+----------------
+
+OCRmyPDF perform some image processing on each page of a PDF, if desired.  The same processing is applied to each page.  It is suggested that the user review files after image processing as these commands might remove desirable content, especially from poor quality scans.
+
+* ``--rotate-pages`` attempts to determine the correct orientation for each page and rotates the page if necessary.
+
+* ``--remove-background`` attempts to detect and remove a noisy background from grayscale or color images.  Monochrome images are ignored. This should not be used on documents that contain color photos as it may remove them.
+
+* ``--deskew`` will correct pages were scanned at a skewed angle by rotating them back into place.  Skew determination and correction is performed using `Postl's variance of line sums <http://www.leptonica.com/skew-measurement.html>`_ algorithm as implemented in `Leptonica <http://www.leptonica.com/index.html>`_.
+  
+* ``--clean`` uses `unpaper <https://www.flameeyes.eu/projects/unpaper>`_ to clean up pages before OCR, but does not alter the final output.  This makes it less likely that OCR will try to find text in background noise.
+
+* ``--clean-final`` uses unpaper to clean up pages before OCR and inserts the page into the final output.  You will want to review each page to ensure that unpaper did not remove something important.
+
+.. note::
+
+    In many cases image processing will rasterize PDF pages as images, potentially losing quality.
 
 .. warning::
 
-   ``--clean-final`` and ``-remove-background`` may leave undesirable
-   visual artifacts in some images where their algorithms have
-   shortcomings. Files should be visually reviewed after using these
-   options.
+    ``--clean-final`` and ``-remove-background`` may leave undesirable visual artifacts in some images where their algorithms have shortcomings. Files should be visually reviewed after using these options.
 
-Example: OCR and correct document skew (crooked scan)
------------------------------------------------------
+
+OCR and correct document skew (crooked scan)
+""""""""""""""""""""""""""""""""""""""""""""
 
 Deskew:
 
@@ -214,148 +150,52 @@ Deskew:
 
     ocrmypdf --deskew input.pdf output.pdf
 
-Image processing commands can be combined. The order in which options
-are given does not matter. OCRmyPDF always applies the steps of the
-image processing pipeline in the same order (rotate, remove background,
-deskew, clean).
+Image processing commands can be combined. The order in which options are given does not matter. OCRmyPDF always applies the steps of the image processing pipeline in the same order (rotate, remove background, deskew, clean).
 
 .. code-block:: bash
 
     ocrmypdf --deskew --clean --rotate-pages input.pdf output.pdf
 
-Don't actually OCR my PDF
-=========================
 
-If you set ``--tesseract-timeout 0`` OCRmyPDF will apply its image
-processing without performing OCR, if all you want to is to apply image
-processing or PDF/A conversion.
+Don't actually OCR my PDF
+"""""""""""""""""""""""""
+
+If you set ``--tesseract-timeout 0`` OCRmyPDF will apply its image processing without performing OCR, if all you want to is to apply image processing or PDF/A conversion.
 
 .. code-block:: bash
 
     ocrmypdf --tesseract-timeout=0 --remove-background input.pdf output.pdf
 
-Optimize images without performing OCR
---------------------------------------
 
-You can also optimize all images without performing any OCR:
+Redo OCR
+""""""""
+
+To redo OCR on a file OCRed with other OCR software or a previous version of OCRmyPDF and/or Tesseract, you may use the ``--force-ocr`` argument. Normally, OCRmyPDF does not modify files that already appear to contain OCR text.
 
 .. code-block:: bash
 
-    ocrmypdf --tesseract-timeout=0 --optimize 3 --skip-text input.pdf output.pdf
+    ocrmypdf --force-ocr input.pdf output.pdf
 
-Perform OCR only certain pages
-------------------------------
+Note that the method above will force rasterization of all pages, potentially reducing quality or losing vector content. 
 
-You can ask OCRmyPDF to only apply OCR to certain pages.
+To ensure quality is preserved, one could extract all of the images and rebuild the PDF for a lossless transformation. This recipe does not work when PDFs contain multiple images per page, as many do in practice. It will also lose any page rotation information.
 
 .. code-block:: bash
 
-    ocrmypdf --pages 2,3,13-17 input.pdf output.pdf
+    pdfimages -all old-ocr.pdf prefix  # extract all images
+    img2pdf -o temp.pdf prefix*        # construct new PDF from the images
+    # review the new PDF to ensure it visually matches the old one
+    ocrmypdf --output-type pdf temp.pdf new-ocr.pdf
 
-Hyphens denote a range of pages and commas separate page numbers. If you prefer
-to use spaces, quote all of the page numbers: ``--pages '2, 3, 5, 7'``.
+``--output-type pdf`` is used here to avoid using Ghostscript which will also rasterize images.
 
-OCRmyPDF will warn if your list of page numbers contains duplicates or
-overlap pages. OCRmyPDF does not currently account for document page numbers,
-such as an introduction section of a book that uses Roman numerals. It simply
-counts the number of virtual pieces of paper since the start.
-
-Regardless of the argument to ``--pages``, OCRmyPDF will optimize all pages in
-the file and convert it to PDF/A, unless you disable those options. In this
-example, we want to OCR only the title and otherwise change the PDF as little
-as possible:
-
-.. code-block:: bash
-
-    ocrmypdf --pages 1 --output-type pdf --optimize 0 input.pdf output.pdf
-
-Redo existing OCR
-=================
-
-To redo OCR on a file OCRed with other OCR software or a previous
-version of OCRmyPDF and/or Tesseract, you may use the ``--redo-ocr``
-argument. (Normally, OCRmyPDF will exit with an error if asked to modify
-a file with OCR.)
-
-This may be helpful for users who want to take advantage of accuracy
-improvements in Tesseract 4.0 for files they previously OCRed with an
-earlier version of Tesseract and OCRmyPDF.
-
-.. code-block:: bash
-
-    ocrmypdf --redo-ocr input.pdf output.pdf
-
-This method will replace OCR without rasterizing, reducing quality or
-removing vector content. If a file contains a mix of pure digital text
-and OCR, digital text will be ignored and OCR will be replaced. As such
-this mode is incompatible with image processing options, since they
-alter the appearance of the file.
-
-In some cases, existing OCR cannot be detected or replaced. Files
-produced by OCRmyPDF v2.2 or earlier, for example, are internally
-represented as having visible text with an opaque image drawn on top.
-This situation cannot be detected.
-
-If ``--redo-ocr`` does not work, you can use ``--force-ocr``, which will
-force rasterization of all pages, potentially reducing quality or losing
-vector content.
 
 Improving OCR quality
-=====================
+---------------------
 
-The `Image processing <#image-processing>`__ features can improve OCR
-quality.
+The `Image processing`_ features can improve OCR quality.
 
-Rotating pages and deskewing helps to ensure that the page orientation
-is correct before OCR begins. Removing the background and/or cleaning
-the page can also improve results. The ``--oversample DPI`` argument can
-be specified to resample images to higher resolution before attempting
-OCR; this can improve results as well.
+Rotating pages and deskewing helps to ensure that the page orientation is correct before OCR begins. Removing the background and/or cleaning the page can also improve results. The ``--oversample DPI`` argument can be specified to resample images to higher resolution before attempting OCR; this can improve results as well.
 
-OCR quality will suffer if the resolution of input images is not correct
-(since the range of pixel sizes that will be checked for possible fonts
-will also be incorrect).
+OCR quality will suffer if the resolution of input images is not correct (since the range of pixel sizes that will be checked for possible fonts will also be incorrect).
 
-PDF optimization
-================
-
-By default OCRmyPDF will attempt to perform lossless optimizations on
-the images inside PDFs after OCR is complete. Optimization is performed
-even if no OCR text is found.
-
-The ``--optimize N`` (short form ``-O``) argument controls optimization,
-where ``N`` ranges from 0 to 3 inclusive, analogous to the optimization
-levels in the GCC compiler.
-
-.. list-table::
-    :widths: auto
-    :header-rows: 1
-
-    *   - Level
-        - Comments
-    *   - ``--optimize 0``
-        - Disables optimization.
-    *   - ``--optimize 1``
-        - Enables lossless optimizations, such as transcoding images to more
-          efficient formats. Also compress other uncompressed objects in the
-          PDF and enables the more efficient "object streams" within the PDF.
-    *   - ``--optimize 2``
-        - All of the above, and enables lossy optimizations and color quantization.
-    *   - ``--optimize 3``
-        - All of the above, and enables more aggressive optimizations and targets lower image quality.
-
-Optimization is improved when a JBIG2 encoder is available and when
-``pngquant`` is installed. If either of these components are missing,
-then some types of images cannot be optimized.
-
-The types of optimization available may expand over time. By default,
-OCRmyPDF compresses data streams inside PDFs, and will change
-inefficient compression modes to more modern versions. A program like
-``qpdf`` can be used to change encodings, e.g. to inspect the internals
-fo a PDF.
-
-.. code-block:: bash
-
-    ocrmypdf --optimize 3 in.pdf out.pdf  # Make it small
-
-Some users may consider enabling lossy JBIG2. See: :ref:`jbig2-lossy`.

docs/docker.rst

@@ -1,196 +0,0 @@
-.. _docker:
-
-=====================
-OCRmyPDF Docker image
-=====================
-
-OCRmyPDF is also available in a Docker image that packages recent
-versions of all dependencies.
-
-For users who already have Docker installed this may be an easy and
-convenient option. However, it is less performant than a system
-installation and may require Docker engine configuration.
-
-OCRmyPDF needs a generous amount of RAM, CPU cores, temporary storage
-space, whether running in a Docker container or on its own. It may be
-necessary to ensure the container is provisioned with additional
-resources.
-
-.. _docker-install:
-
-Installing the Docker image
-===========================
-
-If you have `Docker <https://docs.docker.com/>`__ installed on your
-system, you can install a Docker image of the latest release.
-
-If you can run this command successfully, your system is ready to download and
-execute the image:
-
-.. code-block:: bash
-
-   docker run hello-world
-
-The recommended OCRmyPDF Docker image is currently named ``ocrmypdf``:
-
-.. code-block:: bash
-
-   docker pull jbarlow83/ocrmypdf
-
-
-OCRmyPDF will use all available CPU cores. By default, the VirtualBox
-machine instance on Windows and macOS has only a single CPU core
-enabled. Use the VirtualBox Manager to determine the name of your Docker
-engine host, and then follow these optional steps to enable multiple
-CPUs:
-
-.. code-block:: bash
-
-   # Optional step for Mac OS X users
-   docker-machine stop "yourVM"
-   VBoxManage modifyvm "yourVM" --cpus 2  # or whatever number of core is desired
-   docker-machine start "yourVM"
-   eval $(docker-machine env "yourVM")
-
-See the Docker documentation for
-`adjusting memory and CPU on other platforms <https://docs.docker.com/config/containers/resource_constraints/>`__.
-
-Using the Docker image on the command line
-==========================================
-
-**Unlike typical Docker containers**, in this section the OCRmyPDF Docker
-container is emphemeral – it runs for one OCR job and terminates, just like a
-command line program. We are using Docker to deliver an application (as opposed
-to the more conventional case, where a Docker container runs as a server).
-
-To start a Docker container (instance of the image):
-
-.. code-block:: bash
-
-   docker tag jbarlow83/ocrmypdf ocrmypdf
-   docker run --rm -i ocrmypdf (... all other arguments here...) - -
-
-For convenience, create a shell alias to hide the Docker command. It is
-easier to send the input file as stdin and read the output from
-stdout – **this avoids the messy permission issues with Docker entirely**.
-
-.. code-block:: bash
-
-   alias docker_ocrmypdf='docker run --rm -i ocrmypdf'
-   docker_ocrmypdf --version  # runs docker version
-   docker_ocrmypdf - - <input.pdf >output.pdf
-
-Or in the wonderful `fish shell <https://fishshell.com/>`__:
-
-.. code-block:: fish
-
-   alias docker_ocrmypdf 'docker run --rm ocrmypdf'
-   funcsave docker_ocrmypdf
-
-Alternately, you could mount the local current working directory as a
-Docker volume:
-
-.. code-block:: bash
-
-   alias docker_ocrmypdf='docker run --rm  -i --user "$(id -u):$(id -g)" --workdir /data -v "$PWD:/data" ocrmypdf'
-   docker_ocrmypdf /data/input.pdf /data/output.pdf
-
-.. _docker-lang-packs:
-
-Adding languages to the Docker image
-====================================
-
-By default the Docker image includes English, German, Simplified Chinese,
-French, Portuguese and Spanish, the most popular languages for OCRmyPDF
-users based on feedback. You may add other languages by creating a new
-Dockerfile based on the public one.
-
-.. code-block:: dockerfile
-
-   FROM jbarlow83/ocrmypdf
-
-   # Example: add Italian
-   RUN apt install tesseract-ocr-ita
-
-To install language packs (training data) such as the 
-`tessdata_best <https://github.com/tesseract-ocr/tessdata_best>`_ suite or
-custom data, you first need to determine the version of Tesseract data files, which
-may differ from the Tesseract program version. Use this command to determine the data
-file version:
-
-.. code-block:: bash
-
-   docker run -i --rm --entrypoint /bin/ls jbarlow83/ocrmypdf /usr/share/tesseract-ocr
-
-As of 2021, the data file version is probably ``4.00``.
-
-You can then add new data with either a Dockerfile:
-
-.. code-block:: dockerfile
-
-   FROM jbarlow83/ocrmypdf
-
-   # Example: add a tessdata_best file
-   COPY chi_tra_vert.traineddata /usr/share/tesseract-ocr/<data version>/tessdata/
-
-Alternately, you can copy training data into a Docker container as follows:
-
-.. code-block:: bash
-
-   docker cp mycustomtraining.traineddata name_of_container:/usr/share/tesseract-ocr/<tesseract version>/tessdata/
-
-Executing the test suite
-========================
-
-The OCRmyPDF test suite is installed with image. To run it:
-
-.. code-block:: bash
-
-   docker run --entrypoint python3  jbarlow83/ocrmypdf -m pytest
-
-Accessing the shell
-===================
-
-To use the bash shell in the Docker image:
-
-.. code-block:: bash
-
-   docker run -it --entrypoint bash  jbarlow83/ocrmypdf
-
-Using the OCRmyPDF web service wrapper
-======================================
-
-The OCRmyPDF Docker image includes an example, barebones HTTP web
-service. The webservice may be launched as follows:
-
-.. code-block:: bash
-
-   docker run --entrypoint python3 -p 5000:5000  jbarlow83/ocrmypdf webservice.py
-
-This will configure the machine to listen on port 5000. On Linux machines
-this is port 5000 of localhost. On macOS or Windows machines running
-Docker, this is port 5000 of the virtual machine that runs your Docker
-images. You can find its IP address using the command ``docker-machine ip``.
-
-Unlike command line usage this program will open a socket and wait for
-connections.
-
-.. warning::
-
-   The OCRmyPDF web service wrapper is intended for demonstration or
-   development. It provides no security, no authentication, no
-   protection against denial of service attacks, and no load balancing.
-   The default Flask WSGI server is used, which is intended for
-   development only. The server is single-threaded and so can respond to
-   only one client at a time. While running OCR, it cannot respond to
-   any other clients.
-
-Clients must keep their open connection while waiting for OCR to
-complete. This may entail setting a long timeout; this interface is more
-useful for internal HTTP API calls.
-
-Unlike the rest of OCRmyPDF, this web service is licensed under the
-Affero GPLv3 (AGPLv3) since Ghostscript is also licensed in this way.
-
-In addition to the above, please read our
-:ref:`general remarks on using OCRmyPDF as a service <ocr-service>`.

docs/errors.rst

@@ -1,53 +1,33 @@
-=====================
 Common error messages
 =====================
 
 Page already has text
-=====================
+---------------------
 
-.. code-block::
+.. code::
 
-   ERROR -    1: page already has text! – aborting (use --force-ocr to force OCR)
+	ERROR -    1: page already has text! – aborting (use --force-ocr to force OCR)
 
-You ran ocrmypdf on a file that already contains printable text or a
-hidden OCR text layer (it can't quite tell the difference). You probably
-don't want to do this, because the file is already searchable.
+You ran ocrmypdf on a file that already contains printable text or a hidden OCR text layer (it can't quite tell the difference). You probably don't want to do this, because the file is already searchable.
 
 As the error message suggests, your options are:
 
--  ``ocrmypdf --force-ocr`` to :ref:`rasterize <raster-vector>` all
-   vector content and run OCR on the images. This is useful if a
-   previous OCR program failed, or if the document contains a text
-   watermark.
--  ``ocrmypdf --skip-text`` to skip OCR and other processing on any
-   pages that contain text. Text pages will be copied into the output
-   PDF without modification.
--  ``ocrmypdf --redo-ocr`` to scan the file for any existing OCR
-   (non-printing text), remove it, and do OCR again. This is one way
-   to take advantage of improvements in OCR accuracy. Printable vector
-   text is excluded from OCR, so this can be used on files that contain
-   a mix of digital and scanned files.
+- ``ocrmypdf --force-ocr`` to :ref:`rasterize <raster-vector>` all vector content and run OCR on the images. This is useful if a previous OCR program failed, or if the document contains a text watermark.
+
+- ``ocrmypdf --skip-text`` to skip OCR and other processing on any pages that contain text. Text pages will be copied into the output PDF without modification.
 
 
 Input file 'filename' is not a valid PDF
-========================================
+----------------------------------------
 
-OCRmyPDF checks files with pikepdf, a library that in turn uses libqpdf to fixes
-errors in PDFs, before it tries to work on them. In most cases this happens
-because the PDF is corrupt and truncated (incomplete file copying) and not much
-can be done.
+OCRmyPDF passes files through qpdf, a program that fixes errors in PDFs, before it tries to work on them. In most cases this happens because the PDF is corrupt and
+truncated (incomplete file copying) and not much can be done.
 
-You can try rewriting the file with Ghostscript:
+You can try rewriting the file with Ghostscript or pdftk:
 
-.. code-block:: bash
+- ``gs -o output.pdf -dSAFER -sDEVICE=pdfwrite input.pdf``
 
-    gs -o output.pdf -dSAFER -sDEVICE=pdfwrite input.pdf
+- ``pdftk input.pdf cat output output.pdf``
 
-``pdftk`` can also rewrite PDFs:
+Sometimes Acrobat can repair PDFs with its `Preflight tool <https://helpx.adobe.com/acrobat/using/correcting-problem-areas-preflight-tool.html>`_.
 
-.. code-block:: bash
-
-    pdftk input.pdf cat output output.pdf
-
-Sometimes Acrobat can repair PDFs with its `Preflight
-tool <https://helpx.adobe.com/acrobat/using/correcting-problem-areas-preflight-tool.html>`__.

docs/images/logo-square.svg

@@ -1,233 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<svg
-   xmlns:serif="http://www.serif.com/"
-   xmlns:dc="http://purl.org/dc/elements/1.1/"
-   xmlns:cc="http://creativecommons.org/ns#"
-   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
-   xmlns:svg="http://www.w3.org/2000/svg"
-   xmlns="http://www.w3.org/2000/svg"
-   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
-   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
-   width="503"
-   height="503"
-   viewBox="0 0 503 503"
-   version="1.1"
-   xml:space="preserve"
-   style="clip-rule:evenodd;fill-rule:evenodd;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:1.5"
-   id="svg270"
-   sodipodi:docname="logo-square.svg"
-   inkscape:export-filename="/home/jb/src/ocrmypdf/docs/images/logo-square.png"
-   inkscape:export-xdpi="96"
-   inkscape:export-ydpi="96"
-   inkscape:version="1.0.2 (e86c870879, 2021-01-15)"><metadata
-   id="metadata276"><rdf:RDF><cc:Work
-       rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type
-         rdf:resource="http://purl.org/dc/dcmitype/StillImage" /><dc:title></dc:title></cc:Work></rdf:RDF></metadata><defs
-   id="defs274" /><sodipodi:namedview
-   pagecolor="#ffffff"
-   bordercolor="#666666"
-   borderopacity="1"
-   objecttolerance="10"
-   gridtolerance="10"
-   guidetolerance="10"
-   inkscape:pageopacity="0"
-   inkscape:pageshadow="2"
-   inkscape:window-width="2396"
-   inkscape:window-height="1691"
-   id="namedview272"
-   showgrid="false"
-   lock-margins="false"
-   inkscape:zoom="2.0079523"
-   inkscape:cx="251.5"
-   inkscape:cy="193.18317"
-   inkscape:window-x="26"
-   inkscape:window-y="23"
-   inkscape:window-maximized="0"
-   inkscape:current-layer="svg270" />
-    <g
-   id="svg"
-   transform="matrix(0.965977,0,0,0.807602,0,138.43572)">
-        <rect
-   x="0"
-   y="0"
-   width="520"
-   height="280"
-   style="fill:#ffffff"
-   id="rect188" />
-        <g
-   transform="matrix(1.03522,0,0,1.23823,-69.7528,-83.422)"
-   id="g267">
-            <g
-   transform="translate(243.977,20.0703)"
-   id="g218">
-                <g
-   id="Page">
-                    <g
-   transform="matrix(0.961773,0,0,1.05962,6.19811,-3.01071)"
-   id="g192">
-                        <path
-   d="m 328.5,97.682 c 0,-1.217 -0.517,-2.386 -1.444,-3.264 -7.03,-6.66 -37.614,-35.638 -44.828,-42.474 -0.977,-0.925 -2.327,-1.448 -3.738,-1.448 -13.997,0 -90.407,0 -111.151,0 -2.871,0 -5.198,2.113 -5.198,4.718 0,27.837 0,170.351 0,198.186 0,2.605 2.327,4.717 5.197,4.717 24.904,0 131.821,0 156.2,0 2.74,0 4.962,-2.016 4.962,-4.504 0,-24.345 0,-139.717 0,-155.931 z"
-   style="fill:#fdfdfd;stroke:#333333;stroke-width:3.95px"
-   id="path190" />
-                    </g>
-                    <g
-   id="Dog-ear"
-   serif:id="Dog ear"
-   transform="translate(-4,2)">
-                        <path
-   d="m 277.072,48.496 v 45.352 c 0,1.324 0.526,2.593 1.462,3.529 0.936,0.936 2.205,1.462 3.529,1.462 12.485,0 44.078,0 44.078,0"
-   style="fill:#f5f5f5;stroke:#333333;stroke-width:4px"
-   id="path194" />
-                    </g>
-                </g>
-                <g
-   transform="translate(-29.6816,-0.395178)"
-   id="g216">
-                    <g
-   transform="matrix(1.00243,0,0,1.11818,-144.72,-8.80181)"
-   id="g200">
-                        <path
-   d="m 465.73,119.654 c 0,-2.049 -1.856,-3.713 -4.142,-3.713 H 310.259 c -2.286,0 -4.142,1.664 -4.142,3.713 v 63.454 c 0,2.049 1.856,3.713 4.142,3.713 h 151.329 c 2.286,0 4.142,-1.664 4.142,-3.713 z"
-   style="fill:#f80000;stroke:#ffffff;stroke-width:3.77px"
-   id="path198" />
-                    </g>
-                    <g
-   transform="matrix(1.24571,0,0,1.35864,116.812,84.3924)"
-   id="g214">
-                        <g
-   transform="matrix(64,0,0,64,42.1437,77.6203)"
-   id="g204">
-                            <path
-   d="m 0.084,0 v -0.68 h 0.213 c 0.074,0 0.137,0.017 0.19,0.05 0.053,0.034 0.079,0.09 0.079,0.168 0,0.077 -0.028,0.134 -0.085,0.17 -0.057,0.037 -0.121,0.055 -0.193,0.055 H 0.213 V 0 Z m 0.209,-0.572 h -0.08 v 0.228 h 0.082 c 0.039,0 0.07,-0.009 0.094,-0.027 0.024,-0.017 0.037,-0.045 0.04,-0.083 0,-0.044 -0.012,-0.075 -0.036,-0.092 -0.024,-0.017 -0.057,-0.026 -0.1,-0.026 z"
-   style="fill:#ffffff;fill-rule:nonzero"
-   id="path202" />
-                        </g>
-                        <g
-   transform="matrix(64,0,0,64,79.7117,77.6203)"
-   id="g208">
-                            <path
-   d="M 0.332,0 H 0.084 v -0.68 h 0.252 c 0.105,0 0.182,0.032 0.233,0.095 0.051,0.063 0.076,0.144 0.076,0.241 0,0.105 -0.027,0.189 -0.082,0.251 C 0.508,-0.031 0.431,0 0.332,0 Z M 0.337,-0.57 H 0.213 v 0.461 H 0.33 c 0.055,0 0.099,-0.018 0.132,-0.054 C 0.495,-0.199 0.511,-0.259 0.511,-0.344 0.511,-0.415 0.497,-0.47 0.469,-0.51 0.441,-0.55 0.397,-0.57 0.337,-0.57 Z"
-   style="fill:#ffffff;fill-rule:nonzero"
-   id="path206" />
-                        </g>
-                        <g
-   transform="matrix(64,0,0,64,123.424,77.6203)"
-   id="g212">
-                            <path
-   d="M 0.405,-0.288 H 0.213 V 0 H 0.084 v -0.68 h 0.385 l 0.02,0.102 H 0.213 v 0.189 h 0.173 z"
-   style="fill:#ffffff;fill-rule:nonzero"
-   id="path210" />
-                        </g>
-                    </g>
-                </g>
-            </g>
-            <g
-   transform="matrix(1,0,0,1.52217,67.3796,10.7507)"
-   id="g222">
-                <rect
-   x="23.500999"
-   y="81.300003"
-   width="162.30499"
-   height="61.77"
-   style="fill:#b4d5ff"
-   id="rect220" />
-            </g>
-            <g
-   transform="matrix(0.967536,0,0,0.961535,5.90498,47.9703)"
-   id="g236">
-                <g
-   transform="matrix(90.4804,0,0,90.4804,82.6698,167.705)"
-   id="g226">
-                    <path
-   d="m 0.057,-0.337 c 0,-0.105 0.027,-0.19 0.082,-0.257 0.055,-0.066 0.132,-0.1 0.231,-0.102 0.107,0 0.186,0.034 0.237,0.103 0.051,0.069 0.077,0.152 0.077,0.249 0,0.105 -0.027,0.191 -0.082,0.258 -0.055,0.067 -0.133,0.1 -0.232,0.1 C 0.264,0.014 0.185,-0.02 0.134,-0.089 0.083,-0.157 0.057,-0.24 0.057,-0.337 Z m 0.135,-0.001 c 0,0.071 0.014,0.13 0.043,0.175 0.029,0.045 0.073,0.068 0.134,0.068 0.055,0 0.098,-0.02 0.131,-0.061 0.033,-0.041 0.049,-0.103 0.049,-0.188 0,-0.071 -0.014,-0.129 -0.043,-0.174 -0.029,-0.045 -0.073,-0.068 -0.134,-0.068 -0.053,0 -0.097,0.022 -0.13,0.067 -0.033,0.045 -0.05,0.105 -0.05,0.181 z"
-   style="fill:#333333;fill-rule:nonzero"
-   id="path224" />
-                </g>
-                <g
-   transform="matrix(90.4804,0,0,90.4804,147.906,167.705)"
-   id="g230">
-                    <path
-   d="M 0.505,-0.557 C 0.473,-0.567 0.448,-0.574 0.429,-0.579 0.41,-0.583 0.388,-0.585 0.361,-0.585 c -0.054,0 -0.096,0.022 -0.125,0.066 -0.029,0.044 -0.044,0.104 -0.044,0.181 0,0.066 0.012,0.123 0.037,0.171 0.025,0.048 0.066,0.072 0.124,0.072 0.029,0 0.056,-0.003 0.081,-0.009 0.025,-0.006 0.047,-0.013 0.068,-0.022 L 0.551,-0.03 C 0.525,-0.017 0.494,-0.006 0.457,0.002 0.42,0.01 0.388,0.014 0.36,0.014 0.254,0.014 0.177,-0.02 0.129,-0.088 0.081,-0.156 0.057,-0.239 0.057,-0.337 c 0,-0.105 0.027,-0.19 0.08,-0.257 0.053,-0.067 0.129,-0.1 0.228,-0.1 0.02,0 0.048,0.003 0.083,0.01 0.035,0.007 0.068,0.018 0.097,0.034 z"
-   style="fill:#333333;fill-rule:nonzero"
-   id="path228" />
-                </g>
-                <g
-   transform="matrix(90.4804,0,0,90.4804,199.751,167.705)"
-   id="g234">
-                    <path
-   d="m 0.293,-0.572 h -0.08 v 0.208 h 0.082 c 0.039,0 0.071,-0.008 0.096,-0.024 0.025,-0.015 0.038,-0.041 0.038,-0.077 0,-0.038 -0.012,-0.065 -0.036,-0.082 -0.024,-0.017 -0.057,-0.025 -0.1,-0.025 z M 0.479,0 0.335,-0.26 C 0.328,-0.259 0.32,-0.259 0.312,-0.259 0.304,-0.258 0.296,-0.258 0.288,-0.258 H 0.213 V 0 H 0.084 v -0.68 h 0.213 c 0.074,0 0.137,0.017 0.19,0.051 0.053,0.034 0.079,0.087 0.079,0.158 0,0.042 -0.011,0.078 -0.032,0.108 -0.022,0.031 -0.05,0.054 -0.084,0.071 L 0.617,0 Z"
-   style="fill:#333333;fill-rule:nonzero"
-   id="path232" />
-                </g>
-            </g>
-            <g
-   transform="matrix(0.916882,0,0,1,121.475,-32.6535)"
-   id="g246">
-                <g
-   transform="matrix(86.953,0,0,86.953,152.996,241.878)"
-   id="g240">
-                    <path
-   d="M 0.479,-0.428 C 0.5,-0.451 0.527,-0.47 0.562,-0.484 c 0.034,-0.013 0.065,-0.02 0.092,-0.02 0.066,0 0.113,0.019 0.141,0.058 0.027,0.039 0.041,0.086 0.041,0.142 V 0 H 0.705 v -0.298 c 0,-0.031 -0.007,-0.054 -0.022,-0.071 -0.015,-0.016 -0.036,-0.024 -0.064,-0.024 -0.019,0 -0.038,0.005 -0.059,0.015 -0.021,0.01 -0.039,0.021 -0.056,0.034 0.001,0.007 0.001,0.013 0.002,0.02 0.001,0.007 0.001,0.013 0.001,0.02 V 0 H 0.376 v -0.298 c 0,-0.031 -0.007,-0.054 -0.022,-0.071 -0.015,-0.016 -0.036,-0.024 -0.063,-0.024 -0.017,0 -0.033,0.003 -0.05,0.01 -0.017,0.007 -0.034,0.016 -0.049,0.027 V 0 H 0.062 V -0.485 H 0.13 l 0.032,0.044 c 0.022,-0.02 0.049,-0.035 0.08,-0.047 0.031,-0.011 0.058,-0.016 0.083,-0.016 0.038,0 0.07,0.007 0.095,0.02 0.025,0.014 0.045,0.033 0.059,0.056 z"
-   style="fill:#333333;fill-rule:nonzero"
-   id="path238" />
-                </g>
-                <g
-   transform="matrix(86.953,0,0,86.953,228.906,241.878)"
-   id="g244">
-                    <path
-   d="M 0.156,0.023 0.179,-0.034 0.006,-0.467 0.14,-0.485 0.252,-0.191 0.358,-0.485 H 0.495 L 0.278,0.064 C 0.263,0.103 0.236,0.137 0.197,0.165 0.158,0.193 0.118,0.212 0.075,0.222 L 0.029,0.115 C 0.052,0.105 0.077,0.093 0.104,0.079 0.13,0.064 0.147,0.046 0.156,0.023 Z"
-   style="fill:#333333;fill-rule:nonzero"
-   id="path242" />
-                </g>
-            </g>
-            <g
-   id="Selectors"
-   transform="matrix(0.965977,0,0,0.807602,67.3796,67.3718)">
-                <g
-   id="Right-selector"
-   serif:id="Right selector">
-                    <g
-   transform="matrix(1.03522,0,0,1.23823,2.07044,0)"
-   id="g250">
-                        <path
-   d="M 185.806,161.156 V 67.132"
-   style="fill:none;stroke:#4c9fff;stroke-width:4px;stroke-linecap:butt"
-   id="path248" />
-                    </g>
-                    <g
-   transform="matrix(1.03522,0,0,1.23823,161.788,169.469)"
-   id="g254">
-                        <circle
-   cx="31.523001"
-   cy="34.313999"
-   r="10.021"
-   style="fill:#4c9fff;stroke:#4c9fff;stroke-width:4px;stroke-linecap:butt"
-   id="circle252" />
-                    </g>
-                </g>
-                <g
-   id="Left-selector"
-   serif:id="Left selector">
-                    <g
-   transform="matrix(1.03522,0,0,1.23823,-170.092,0)"
-   id="g259">
-                        <path
-   d="M 185.806,161.156 V 67.132"
-   style="fill:none;stroke:#4c9fff;stroke-width:4px;stroke-linecap:butt"
-   id="path257" />
-                    </g>
-                    <g
-   transform="matrix(1.03522,0,0,1.23823,-10.3742,28.2274)"
-   id="g263">
-                        <circle
-   cx="31.523001"
-   cy="34.313999"
-   r="10.021"
-   style="fill:#4c9fff;stroke:#4c9fff;stroke-width:4px;stroke-linecap:butt"
-   id="circle261" />
-                    </g>
-                </g>
-            </g>
-        </g>
-    </g>
-</svg>

docs/images/logo.svg

@@ -1,75 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-<svg width="100%" height="100%" viewBox="0 0 503 227" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:1.5;">
-    <g id="svg" transform="matrix(0.965977,0,0,0.807602,0,0)">
-        <rect x="0" y="0" width="520" height="280" style="fill:white;"/>
-        <g transform="matrix(1.03522,0,0,1.23823,-69.7528,-83.422)">
-            <g transform="matrix(1,0,0,1,243.977,20.0703)">
-                <g id="Page">
-                    <g transform="matrix(0.961773,0,0,1.05962,6.19811,-3.01071)">
-                        <path d="M328.5,97.682C328.5,96.465 327.983,95.296 327.056,94.418C320.026,87.758 289.442,58.78 282.228,51.944C281.251,51.019 279.901,50.496 278.49,50.496C264.493,50.496 188.083,50.496 167.339,50.496C164.468,50.496 162.141,52.609 162.141,55.214C162.141,83.051 162.141,225.565 162.141,253.4C162.141,256.005 164.468,258.117 167.338,258.117C192.242,258.117 299.159,258.117 323.538,258.117C326.278,258.117 328.5,256.101 328.5,253.613C328.5,229.268 328.5,113.896 328.5,97.682Z" style="fill:rgb(253,253,253);stroke:rgb(51,51,51);stroke-width:3.95px;"/>
-                    </g>
-                    <g id="Dog-ear" serif:id="Dog ear" transform="matrix(1,0,0,1,-4,2)">
-                        <path d="M277.072,48.496L277.072,93.848C277.072,95.172 277.598,96.441 278.534,97.377C279.47,98.313 280.739,98.839 282.063,98.839C294.548,98.839 326.141,98.839 326.141,98.839" style="fill:rgb(245,245,245);stroke:rgb(51,51,51);stroke-width:4px;"/>
-                    </g>
-                </g>
-                <g transform="matrix(1,0,0,1,-29.6816,-0.395178)">
-                    <g transform="matrix(1.00243,0,0,1.11818,-144.72,-8.80181)">
-                        <path d="M465.73,119.654C465.73,117.605 463.874,115.941 461.588,115.941L310.259,115.941C307.973,115.941 306.117,117.605 306.117,119.654L306.117,183.108C306.117,185.157 307.973,186.821 310.259,186.821L461.588,186.821C463.874,186.821 465.73,185.157 465.73,183.108L465.73,119.654Z" style="fill:rgb(248,0,0);stroke:white;stroke-width:3.77px;"/>
-                    </g>
-                    <g transform="matrix(1.24571,0,0,1.35864,116.812,84.3924)">
-                        <g transform="matrix(64,0,0,64,42.1437,77.6203)">
-                            <path d="M0.084,0L0.084,-0.68L0.297,-0.68C0.371,-0.68 0.434,-0.663 0.487,-0.63C0.54,-0.596 0.566,-0.54 0.566,-0.462C0.566,-0.385 0.538,-0.328 0.481,-0.292C0.424,-0.255 0.36,-0.237 0.288,-0.237L0.213,-0.237L0.213,0L0.084,0ZM0.293,-0.572L0.213,-0.572L0.213,-0.344L0.295,-0.344C0.334,-0.344 0.365,-0.353 0.389,-0.371C0.413,-0.388 0.426,-0.416 0.429,-0.454C0.429,-0.498 0.417,-0.529 0.393,-0.546C0.369,-0.563 0.336,-0.572 0.293,-0.572Z" style="fill:white;fill-rule:nonzero;"/>
-                        </g>
-                        <g transform="matrix(64,0,0,64,79.7117,77.6203)">
-                            <path d="M0.332,0L0.084,0L0.084,-0.68L0.336,-0.68C0.441,-0.68 0.518,-0.648 0.569,-0.585C0.62,-0.522 0.645,-0.441 0.645,-0.344C0.645,-0.239 0.618,-0.155 0.563,-0.093C0.508,-0.031 0.431,0 0.332,0ZM0.337,-0.57L0.213,-0.57L0.213,-0.109L0.33,-0.109C0.385,-0.109 0.429,-0.127 0.462,-0.163C0.495,-0.199 0.511,-0.259 0.511,-0.344C0.511,-0.415 0.497,-0.47 0.469,-0.51C0.441,-0.55 0.397,-0.57 0.337,-0.57Z" style="fill:white;fill-rule:nonzero;"/>
-                        </g>
-                        <g transform="matrix(64,0,0,64,123.424,77.6203)">
-                            <path d="M0.405,-0.288L0.213,-0.288L0.213,0L0.084,0L0.084,-0.68L0.469,-0.68L0.489,-0.578L0.213,-0.578L0.213,-0.389L0.386,-0.389L0.405,-0.288Z" style="fill:white;fill-rule:nonzero;"/>
-                        </g>
-                    </g>
-                </g>
-            </g>
-            <g transform="matrix(1,0,0,1.52217,67.3796,10.7507)">
-                <rect x="23.501" y="81.3" width="162.305" height="61.77" style="fill:rgb(180,213,255);"/>
-            </g>
-            <g transform="matrix(0.967536,0,0,0.961535,5.90498,47.9703)">
-                <g transform="matrix(90.4804,0,0,90.4804,82.6698,167.705)">
-                    <path d="M0.057,-0.337C0.057,-0.442 0.084,-0.527 0.139,-0.594C0.194,-0.66 0.271,-0.694 0.37,-0.696C0.477,-0.696 0.556,-0.662 0.607,-0.593C0.658,-0.524 0.684,-0.441 0.684,-0.344C0.684,-0.239 0.657,-0.153 0.602,-0.086C0.547,-0.019 0.469,0.014 0.37,0.014C0.264,0.014 0.185,-0.02 0.134,-0.089C0.083,-0.157 0.057,-0.24 0.057,-0.337ZM0.192,-0.338C0.192,-0.267 0.206,-0.208 0.235,-0.163C0.264,-0.118 0.308,-0.095 0.369,-0.095C0.424,-0.095 0.467,-0.115 0.5,-0.156C0.533,-0.197 0.549,-0.259 0.549,-0.344C0.549,-0.415 0.535,-0.473 0.506,-0.518C0.477,-0.563 0.433,-0.586 0.372,-0.586C0.319,-0.586 0.275,-0.564 0.242,-0.519C0.209,-0.474 0.192,-0.414 0.192,-0.338Z" style="fill:rgb(51,51,51);fill-rule:nonzero;"/>
-                </g>
-                <g transform="matrix(90.4804,0,0,90.4804,147.906,167.705)">
-                    <path d="M0.505,-0.557C0.473,-0.567 0.448,-0.574 0.429,-0.579C0.41,-0.583 0.388,-0.585 0.361,-0.585C0.307,-0.585 0.265,-0.563 0.236,-0.519C0.207,-0.475 0.192,-0.415 0.192,-0.338C0.192,-0.272 0.204,-0.215 0.229,-0.167C0.254,-0.119 0.295,-0.095 0.353,-0.095C0.382,-0.095 0.409,-0.098 0.434,-0.104C0.459,-0.11 0.481,-0.117 0.502,-0.126L0.551,-0.03C0.525,-0.017 0.494,-0.006 0.457,0.002C0.42,0.01 0.388,0.014 0.36,0.014C0.254,0.014 0.177,-0.02 0.129,-0.088C0.081,-0.156 0.057,-0.239 0.057,-0.337C0.057,-0.442 0.084,-0.527 0.137,-0.594C0.19,-0.661 0.266,-0.694 0.365,-0.694C0.385,-0.694 0.413,-0.691 0.448,-0.684C0.483,-0.677 0.516,-0.666 0.545,-0.65L0.505,-0.557Z" style="fill:rgb(51,51,51);fill-rule:nonzero;"/>
-                </g>
-                <g transform="matrix(90.4804,0,0,90.4804,199.751,167.705)">
-                    <path d="M0.293,-0.572L0.213,-0.572L0.213,-0.364L0.295,-0.364C0.334,-0.364 0.366,-0.372 0.391,-0.388C0.416,-0.403 0.429,-0.429 0.429,-0.465C0.429,-0.503 0.417,-0.53 0.393,-0.547C0.369,-0.564 0.336,-0.572 0.293,-0.572ZM0.479,0L0.335,-0.26C0.328,-0.259 0.32,-0.259 0.312,-0.259C0.304,-0.258 0.296,-0.258 0.288,-0.258L0.213,-0.258L0.213,0L0.084,0L0.084,-0.68L0.297,-0.68C0.371,-0.68 0.434,-0.663 0.487,-0.629C0.54,-0.595 0.566,-0.542 0.566,-0.471C0.566,-0.429 0.555,-0.393 0.534,-0.363C0.512,-0.332 0.484,-0.309 0.45,-0.292L0.617,0L0.479,0Z" style="fill:rgb(51,51,51);fill-rule:nonzero;"/>
-                </g>
-            </g>
-            <g transform="matrix(0.916882,0,0,1,121.475,-32.6535)">
-                <g transform="matrix(86.953,0,0,86.953,152.996,241.878)">
-                    <path d="M0.479,-0.428C0.5,-0.451 0.527,-0.47 0.562,-0.484C0.596,-0.497 0.627,-0.504 0.654,-0.504C0.72,-0.504 0.767,-0.485 0.795,-0.446C0.822,-0.407 0.836,-0.36 0.836,-0.304L0.836,0L0.705,0L0.705,-0.298C0.705,-0.329 0.698,-0.352 0.683,-0.369C0.668,-0.385 0.647,-0.393 0.619,-0.393C0.6,-0.393 0.581,-0.388 0.56,-0.378C0.539,-0.368 0.521,-0.357 0.504,-0.344C0.505,-0.337 0.505,-0.331 0.506,-0.324C0.507,-0.317 0.507,-0.311 0.507,-0.304L0.507,0L0.376,0L0.376,-0.298C0.376,-0.329 0.369,-0.352 0.354,-0.369C0.339,-0.385 0.318,-0.393 0.291,-0.393C0.274,-0.393 0.258,-0.39 0.241,-0.383C0.224,-0.376 0.207,-0.367 0.192,-0.356L0.192,0L0.062,0L0.062,-0.485L0.13,-0.485L0.162,-0.441C0.184,-0.461 0.211,-0.476 0.242,-0.488C0.273,-0.499 0.3,-0.504 0.325,-0.504C0.363,-0.504 0.395,-0.497 0.42,-0.484C0.445,-0.47 0.465,-0.451 0.479,-0.428Z" style="fill:rgb(51,51,51);fill-rule:nonzero;"/>
-                </g>
-                <g transform="matrix(86.953,0,0,86.953,228.906,241.878)">
-                    <path d="M0.156,0.023L0.179,-0.034L0.006,-0.467L0.14,-0.485L0.252,-0.191L0.358,-0.485L0.495,-0.485L0.278,0.064C0.263,0.103 0.236,0.137 0.197,0.165C0.158,0.193 0.118,0.212 0.075,0.222L0.029,0.115C0.052,0.105 0.077,0.093 0.104,0.079C0.13,0.064 0.147,0.046 0.156,0.023Z" style="fill:rgb(51,51,51);fill-rule:nonzero;"/>
-                </g>
-            </g>
-            <g id="Selectors" transform="matrix(0.965977,0,0,0.807602,67.3796,67.3718)">
-                <g id="Right-selector" serif:id="Right selector">
-                    <g transform="matrix(1.03522,0,0,1.23823,2.07044,0)">
-                        <path d="M185.806,161.156L185.806,67.132" style="fill:none;stroke:rgb(76,159,255);stroke-width:4px;stroke-linecap:butt;"/>
-                    </g>
-                    <g transform="matrix(1.03522,0,0,1.23823,161.788,169.469)">
-                        <circle cx="31.523" cy="34.314" r="10.021" style="fill:rgb(76,159,255);stroke:rgb(76,159,255);stroke-width:4px;stroke-linecap:butt;"/>
-                    </g>
-                </g>
-                <g id="Left-selector" serif:id="Left selector">
-                    <g transform="matrix(1.03522,0,0,1.23823,-170.092,0)">
-                        <path d="M185.806,161.156L185.806,67.132" style="fill:none;stroke:rgb(76,159,255);stroke-width:4px;stroke-linecap:butt;"/>
-                    </g>
-                    <g transform="matrix(1.03522,0,0,1.23823,-10.3742,28.2274)">
-                        <circle cx="31.523" cy="34.314" r="10.021" style="fill:rgb(76,159,255);stroke:rgb(76,159,255);stroke-width:4px;stroke-linecap:butt;"/>
-                    </g>
-                </g>
-            </g>
-        </g>
-    </g>
-</svg>

docs/index.rst

@@ -1,12 +1,15 @@
+.. ocrmypdf documentation master file, created by
+   sphinx-quickstart on Sun Sep  4 14:29:43 2016.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
 OCRmyPDF documentation
 ======================
 
-OCRmyPDF adds an optical character recognition (OCR) text layer to scanned PDF
-files, allowing them to be searched.
+OCRmyPDF adds an OCR text layer to scanned PDF files, allowing them to
+be searched.
 
-PDF is the best format for storing and exchanging scanned documents.
-Unfortunately, PDFs can be difficult to modify. OCRmyPDF makes it easy to apply
-image processing and OCR to existing PDFs.
+PDF is the best format for storing and exchanging scanned documents.  Unfortunately, PDFs can be difficult to modify. OCRmyPDF makes it easy to apply image processing and OCR to existing PDFs.
 
 .. toctree::
    :maxdepth: 1
@@ -14,30 +17,18 @@ image processing and OCR to existing PDFs.
    introduction
    release_notes
    installation
-   optimizer
    languages
-   jbig2
 
 .. toctree::
    :caption: Usage
    :maxdepth: 2
 
    cookbook
-   docker
    advanced
    batch
-   performance
-   pdfsecurity
+   security
    errors
 
-.. toctree::
-   :caption: Developers
-   :maxdepth: 2
-
-   api
-   plugins
-   apiref
-   contributing
 
 Indices and tables
 ==================
@@ -45,3 +36,4 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+

docs/introduction.rst

@@ -1,234 +1,115 @@
-============
 Introduction
 ============
 
-OCRmyPDF is a Python 3 application and library that adds OCR layers to PDFs.
+OCRmyPDF is a Python 3 package that adds OCR layers to PDFs.
+
 
 About OCR
-=========
+---------
 
-`Optical character
-recognition <https://en.wikipedia.org/wiki/Optical_character_recognition>`__
-is technology that converts images of typed or handwritten text, such as
-in a scanned document, to computer text that can be selected, searched and copied.
+`Optical character recognition <https://en.wikipedia.org/wiki/Optical_character_recognition>`_ is technology that converts images of typed or handwritten text, such as in a scanned document, to computer text that can be searched and copied.
 
-OCRmyPDF uses
-`Tesseract <https://github.com/tesseract-ocr/tesseract>`__, the best
-available open source OCR engine, to perform OCR.
+OCRmyPDF uses `Tesseract <https://github.com/tesseract-ocr/tesseract>`_, the best available open source OCR engine, to perform OCR.
 
 .. _raster-vector:
 
 About PDFs
-==========
+----------
 
-PDFs are page description files that attempts to preserve a layout
-exactly. They contain `vector
-graphics <http://vector-conversions.com/vectorizing/raster_vs_vector.html>`__
-that can contain raster objects such as scanned images. Because PDFs can
-contain multiple pages (unlike many image formats) and can contain fonts
-and text, it is a good formats for exchanging scanned documents.
+PDFs are page description files that attempts to preserve a layout exactly. They  contain `vector graphics <http://vector-conversions.com/vectorizing/raster_vs_vector.html>`_ that can contain raster objects such as scanned images. Because PDFs can contain multiple pages (unlike many image formats) and can contain fonts and text, it is a good formats for exchanging scanned documents.
 
-|image|
+.. image:: bitmap_vs_svg.svg
 
-A PDF page might contain multiple images, even if it only appears to
-have one image. Some scanners or scanning software will segment pages
-into monochromatic text and color regions for example, to improve the
-compression ratio and appearance of the page.
+A PDF page might contain multiple images, even if it only appears to have one image.  Some scanners or scanning software will segment pages into monochromatic text and color regions for example, to improve the compression ratio and appearance of the page.
+
+Rasterizing a PDF is the process of generating an image suitable for display or analyzing with an OCR engine.  OCR engines like Tesseract work with images, not vector objects.
 
-Rasterizing a PDF is the process of generating an image suitable for
-display or analyzing with an OCR engine. OCR engines like Tesseract work
-with images, not vector objects.
 
 About PDF/A
-===========
+-----------
 
-`PDF/A <https://en.wikipedia.org/wiki/PDF/A>`__ is an ISO-standardized
-subset of the full PDF specification that is designed for archiving (the
-'A' stands for Archive). PDF/A differs from PDF primarily by omitting
-features that would make it difficult to read the file in the future,
-such as embedded Javascript, video, audio and references to external
-fonts. All fonts and resources needed to interpret the PDF must be
-contained within it. Because PDF/A disables Javascript and other types
-of embedded content, it is probably more secure.
+`PDF/A <https://en.wikipedia.org/wiki/PDF/A>`_ is an ISO-standardized subset of the full PDF specification that is designed for archiving (the 'A' stands for Archive).  PDF/A differs from PDF primarily by omitting features that would make it difficult to read the file in the future, such as embedded Javascript, video, audio and references to external fonts.  All fonts and resources needed to interpret the PDF must be contained within it. Because PDF/A disables Javascript and other types of embedded content, it is probably more secure.
 
 There are various conformance levels and versions, such as "PDF/A-2b".
 
-Generally speaking, the best format for scanned documents is PDF/A. Some
-governments and jurisdictions, US Courts in particular, `mandate the use
-of PDF/A <https://pdfblog.com/2012/02/13/what-is-pdfa/>`__ for scanned
-documents.
+Generally speaking, the best format for scanned documents is PDF/A. Some governments and jurisdictions, US Courts in particular, `mandate the use of PDF/A <https://pdfblog.com/2012/02/13/what-is-pdfa/>`_ for scanned documents.
 
-Since most people who scan documents are interested in reading them
-indefinitely into the future, OCRmyPDF generates PDF/A-2b by default.
+Since most people who scan documents are interested in reading them indefinitely into the future, OCRmyPDF generates PDF/A-2b by default.
+
+PDF/A has a few drawbacks.  Some PDF viewers include an alert that the file is a PDF/A, which may confuse some users.  It also tends to produce larger files than PDF, because it embeds certain resources even if they are commonly available. PDF/A files can be digitally signed, but may not be encrypted, to ensure they can be read in the future.  Fortunately, converting from PDF/A to a regular PDF is trivial, and any PDF viewer can view PDF/A.
 
-PDF/A has a few drawbacks. Some PDF viewers include an alert that the
-file is a PDF/A, which may confuse some users. It also tends to produce
-larger files than PDF, because it embeds certain resources even if they
-are commonly available. PDF/A files can be digitally signed, but may not
-be encrypted, to ensure they can be read in the future. Fortunately,
-converting from PDF/A to a regular PDF is trivial, and any PDF viewer
-can view PDF/A.
 
 What OCRmyPDF does
-==================
+------------------
 
-OCRmyPDF analyzes each page of a PDF to determine the colorspace and
-resolution (DPI) needed to capture all of the information on that page
-without losing content. It uses
-`Ghostscript <http://ghostscript.com/>`__ to rasterize the page, and
-then performs on OCR on the rasterized image to create an OCR "layer".
-The layer is then grafted back onto the original PDF.
+OCRmyPDF analyzes each page of a PDF to determine the colorspace and resolution (DPI) needed to capture all of the information on that page without losing content.  It uses `Ghostscript <http://ghostscript.com/>`_ to rasterize the page, and then performs on OCR on the rasterized image to create an OCR "layer". The layer is then grafted back onto the original PDF.
 
-While one can use a program like Ghostscript or ImageMagick to get an
-image and put the image through Tesseract, that actually creates a new
-PDF and many details may be lost. OCRmyPDF can produce a minimally
-changed PDF as output.
+While one can use a program like Ghostscript or ImageMagick to get an image and put the image through Tesseract, that actually creates a new PDF and many details may be lost. OCRmyPDF can produce a minimally changed PDF as output.
 
-OCRmyPDF also some image processing options like deskew which improve
-the appearance of files and quality of OCR. When these are used, the OCR
-layer is grafted onto the processed image instead.
+OCRmyPDF also some image processing options like deskew which improve the appearance of files and quality of OCR. When these are used, the OCR layer is grafted onto the processed image instead.
+
+By default, OCRmyPDF produces archival PDFs – PDF/A, which are a stricter subset of PDF features designed for long term archives. If regular PDFs are desired, this can be disabled with ``--output-type pdf``.
 
-By default, OCRmyPDF produces archival PDFs – PDF/A, which are a
-stricter subset of PDF features designed for long term archives. If
-regular PDFs are desired, this can be disabled with
-``--output-type pdf``.
 
 Why you shouldn't do this manually
-==================================
+----------------------------------
 
-A PDF is similar to an HTML file, in that it contains document structure
-along with images. Sometimes a PDF does nothing more than present a full
-page image, but often there is additional content that would be lost.
+A PDF is similar to an HTML file, in that it contains document structure along with images.  Sometimes a PDF does nothing more than present a full page image, but often there is additional content that would be lost.
 
 A manual process could work like either of these:
 
-1. Rasterize each page as an image, OCR the images, and combine the
-   output into a PDF. This preserves the layout of each page, but
-   resamples all images (possibly losing quality, increasing file size,
-   introducing compression artifacts, etc.).
-2. Extract each image, OCR, and combine the output into a PDF. This
-   loses the context in which images are used in the PDF, meaning that
-   cropping, rotation and scaling of pages may be lost. Some scanned
-   PDFs use multiple images segmented into black and white, grayscale
-   and color regions, with stencil masks to prevent overlap, as this can
-   enhance the appearance of a file while reducing file size. Clearly,
-   reassembling these images will be easy. This also loses and text or
-   vector art on any pages in a PDF with both scanned and pure digital
-   content.
+1. Rasterize each page as an image, OCR the images, and combine the output into a PDF. This preserves the layout of each page, but resamples all images (possibly losing quality, increasing file size, introducing compression artifacts, etc.).
 
-In the case of a PDF that is nothing other than a container of images
-(no rotation, scaling, cropping, one image per page), the second
-approach can be lossless.
+2. Extract each image, OCR, and combine the output into a PDF. This loses the context in which images are used in the PDF, meaning that cropping, rotation and scaling of pages may be lost. Some scanned PDFs use multiple images segmented into black and white, grayscale and color regions, with stencil masks to prevent overlap, as this can enhance the appearance of a file while reducing file size. Clearly, reassembling these images will be easy. This also loses and text or vector art on any pages in a PDF with both scanned and pure digital content.
 
-OCRmyPDF uses several strategies depending on input options and the
-input PDF itself, but generally speaking it rasterizes a page for OCR
-and then grafts the OCR back onto the original. As such it can handle
-complex PDFs and still preserve their contents as much as possible.
+In the case of a PDF that is nothing other than a container of images (no rotation, scaling, cropping, one image per page), the second approach can be lossless.
+
+OCRmyPDF uses several strategies depending on input options and the input PDF itself, but generally speaking it rasterizes a page for OCR and then grafts the OCR back onto the original. As such it can handle complex PDFs and still preserve their contents as much as possible.
 
-OCRmyPDF also supports a many, many edge cases that have cropped over
-several years of development. We support PDF features like images inside
-of Form XObjects, and pages with UserUnit scaling. We support rare image
-formats like non-monochrome 1-bit images. We warn about files you may
-not to OCR. Thanks to pikepdf and QPDF, we auto-repair PDFs that are
-damaged. (Not that you need to know what any of these are! You should be
-able to throw any PDF at it.)
 
 Limitations
-===========
+-----------
 
-OCRmyPDF is limited by the Tesseract OCR engine. As such it experiences
-these limitations, as do any other programs that rely on Tesseract:
+OCRmyPDF is limited by the Tesseract OCR engine.  As such it experiences these limitations, as do any other programs that rely on Tesseract:
 
--  The OCR is not as accurate as commercial OCR solutions.
--  It is not capable of recognizing handwriting.
--  It may find gibberish and report this as OCR output.
--  If a document contains languages outside of those given in the
-   ``-l LANG`` arguments, results may be poor.
--  It is not always good at analyzing the natural reading order of
-   documents. For example, it may fail to recognize that a document
-   contains two columns, and may try to join text across columns.
--  Poor quality scans may produce poor quality OCR. Garbage in, garbage
-   out.
--  It does not expose information about what font family text belongs
-   to.
+* The OCR is not as accurate as commercial solutions such as Abbyy.
+* It is not capable of recognizing handwriting.
+* It may find gibberish and report this as OCR output.
+* If a document contains languages outside of those given in the ``-l LANG`` arguments, results may be poor.
+* It is not always good at analyzing the natural reading order of documents. For example, it may fail to recognize that a document contains two columns and join text across the columns.
+* Poor quality scans may produce poor quality OCR. Garbage in, garbage out.
+* PDFs that use transparent layers are not currently checked in the test suite, so they may not work correctly.
+* It does not expose information about what font family text belongs to.
 
 OCRmyPDF is also limited by the PDF specification:
 
--  PDF encodes the position of text glyphs but does not encode document
-   structure. There is no markup that divides a document in sections,
-   paragraphs, sentences, or even words (since blank spaces are not
-   represented). As such all elements of document structure including
-   the spaces between words must be derived heuristically. Some PDF
-   viewers do a better job of this than others.
--  Because some popular open source PDF viewers have a particularly hard
-   time with spaces between words, OCRmyPDF appends a space to each text
-   element as a workaround (when using ``--pdf-renderer hocr``). While
-   this mixes document structure with graphical information that ideally
-   should be left to the PDF viewer to interpret, it improves
-   compatibility with some viewers and does not cause problems for
-   better ones.
+* PDF encodes the position of text glyphs but does not encode document structure.  There is no markup that divides a document in sections, paragraphs, sentences, or even words (since blank spaces are not represented). As such all elements of document structure including the spaces between words must be derived heuristically.  Some PDF viewers do a better job of this than others.
+* Because some popular open source PDF viewers have a particularly hard time with spaces betweem words, OCRmyPDF appends a space to each text element as a workaround. While this mixes document structure with graphical information that ideally should be left to the PDF viewer to interpret, it improves compatibility with some viewers and does not cause problems for better ones.
 
 Ghostscript also imposes some limitations:
 
--  PDFs containing JBIG2-encoded content will be converted to CCITT
-   Group4 encoding, which has lower compression ratios, if Ghostscript
-   PDF/A is enabled.
--  PDFs containing JPEG 2000-encoded content will be converted to JPEG
-   encoding, which may introduce compression artifacts, if Ghostscript
-   PDF/A is enabled.
--  Ghostscript may transcode grayscale and color images, either lossy to
-   lossless or lossless to lossy, based on an internal algorithm. This
-   behavior can be suppressed by setting ``--pdfa-image-compression`` to
-   ``jpeg`` or ``lossless`` to set all images to one type or the other.
-   Ghostscript has no option to maintain the input image's format.
-   (Ghostscript 9.25+ can copy JPEG images without transcoding them;
-   earlier versions will transcode.)
--  Ghostscript's PDF/A conversion removes any XMP metadata that is not
-   one of the standard XMP metadata namespaces for PDFs. In particular,
-   PRISM Metdata is removed.
--  Ghostscript's PDF/A conversion seems to remove or deactivate
-   hyperlinks and other active content.
+* PDFs containing JBIG2-encoded content will be converted to CCITT Group4 encoding, which has lower compression ratios, if Ghostscript PDF/A is enabled.
+* PDFs containing JPEG 2000-encoded content will be converted to JPEG encoding, which may introduce compression artifacts, if Ghostscript PDF/A is enabled.
+* Ghostscript may transcode grayscale and color images, either lossy to lossless or lossless to lossy, based on an internal algorithm. This behavior can be suppressed by setting ``--pdfa-image-compression`` to ``jpeg`` or ``lossless`` to set all images to one type or the other. Ghostscript has no option to maintain the input image's format.
+  
+OCRmyPDF is currently not designed to be used as a Python API; it is designed to be run as a command line tool. ``import ocrmypf`` currently attempts to process the command line on ``sys.argv`` at import time so it has side effects that will interfere with its use as a package. The API it presents should not be considered stable.
 
-You can use ``--output-type pdf`` to disable PDF/A conversion and produce
-a standard, non-archival PDF.
-
-Regarding OCRmyPDF itself:
-
--  PDFs that use transparency are not currently represented in the test
-   suite
 
 Similar programs
-================
+----------------
 
-To the author's knowledge, OCRmyPDF is the most feature-rich and
-thoroughly tested command line OCR PDF conversion tool. If it does not
-meet your needs, contributions and suggestions are welcome. If not,
-consider one of these similar open source programs:
+To the author's knowledge, OCRmyPDF is the most feature-rich and thoroughly tested command line OCR PDF conversion tool. If it does not meet your needs, contributions and suggestions are welcome. If not, consider one of these similar open source programs:
 
--  pdf2pdfocr
--  pdfsandwich
-
-Ghostscript recently added three "pdfocr" output devices. They work by
-rasterizing all content and converting all pages to a single colour space.
+* pdf2pdfocr
+* pdfsandwich
+* pypdfocr
+* pdfbeads
 
 Web front-ends
-==============
+--------------
 
-The Docker image ``ocrmypdf`` provides a web service front-end
-that allows files to submitted over HTTP and the results "downloaded".
-This is an HTTP server intended to simplify web services deployments; it
-is not intended to be deployed on the public internet and no real
-security measures to speak of.
+* `Nextcloud OCR <https://github.com/janis91/ocr>`_ is a free software plugin for the Nextcloud private cloud software
+* `OCRmyPDF-web <https://github.com/sseemayer/OCRmyPDF-web>`_, a micro web-frontend for OCRmyPDF (third-party, not actively maintained)
 
-In addition, the following third-party integrations are available:
+Bear in mind that OCRmyPDF is not designed to be secure against malware-bearing PDFs (see `Using OCRmyPDF online`_).
 
--  `Nextcloud OCR <https://github.com/janis91/ocr>`__ is a free software
-   plugin for the Nextcloud private cloud software
-
-OCRmyPDF is not designed to be secure against malware-bearing PDFs (see
-`Using OCRmyPDF online <ocr-service>`__). Users should ensure they
-comply with OCRmyPDF's licenses and the licenses of all dependencies. In
-particular, OCRmyPDF requires Ghostscript, which is licensed under
-AGPLv3.
-
-.. |image| image:: images/bitmap_vs_svg.svg

docs/jbig2.rst

@@ -1,55 +0,0 @@
-.. _jbig2:
-
-============================
-Installing the JBIG2 encoder
-============================
-
-Most Linux distributions do not include a JBIG2 encoder since JBIG2
-encoding was patented for a long time. All known JBIG2 US patents have
-expired as of 2017, but it is possible that unknown patents exist.
-
-JBIG2 encoding is recommended for OCRmyPDF and is used to losslessly
-create smaller PDFs. If JBIG2 encoding not available, lower quality
-encodings will be used.
-
-JBIG2 decoding is not patented and is performed automatically by most
-PDF viewers. It is widely supported has been part of the PDF
-specification since 2001.
-
-On macOS, Homebrew packages jbig2enc and OCRmyPDF includes it by
-default. The Docker image for OCRmyPDF also builds its own JBIG2 encoder
-from source.
-
-For all other Linux, you must build a JBIG2 encoder from source:
-
-.. code-block:: bash
-
-   git clone https://github.com/agl/jbig2enc
-   cd jbig2enc
-   ./autogen.sh
-   ./configure && make
-   [sudo] make install
-
-.. _jbig2-lossy:
-
-Lossy mode JBIG2
-================
-
-OCRmyPDF provides lossy mode JBIG2 as an advanced feature. Users should
-`review the technical concerns with JBIG2 in lossy
-mode <https://abbyy.technology/en:kb:tip:jbig2_compression_and_ocr>`__
-and decide if this feature is acceptable for their use case.
-
-JBIG2 lossy mode does achieve higher compression ratios than any other
-monochrome (bitonal) compression technology; for large text documents
-the savings are considerable. JBIG2 lossless still gives great
-compression ratios and is a major improvement over the older CCITT G4
-standard. As explained above, there is some risk of substitution errors.
-
-To turn on JBIG2 lossy mode, add the argument ``--jbig2-lossy``.
-``--optimize {1,2,3}`` are necessary for the argument to take effect
-also required. Also, a JBIG2 encoder must be installed as described in
-the previous section.
-
-*Due to an oversight, ocrmypdf v7.0 and v7.1 used lossy mode by
-default.*

docs/languages.rst

@@ -1,76 +1,76 @@
 .. _lang-packs:
 
-====================================
 Installing additional language packs
 ====================================
 
-OCRmyPDF uses Tesseract for OCR, and relies on its language packs for all languages.
-On most platforms, English is installed with Tesseract by default, but not always.
+OCRmyPDF uses Tesseract for OCR, and relies on its language packs for languages other than English. 
 
-Tesseract supports `most
-languages <https://github.com/tesseract-ocr/tesseract/blob/master/doc/tesseract.1.asc#languages>`__.
-Languages are identified by standardized three-letter codes (called ISO 639-2 Alpha-3).
-Tesseract's documentation also lists the three-letter code for your language.
-Some are anglicized, e.g. Spanish is ``spa`` rather than ``esp``, while others
-are not, e.g. German is ``deu`` and French is ``fra``.
+Tesseract supports `most languages <https://github.com/tesseract-ocr/tesseract/blob/master/doc/tesseract.1.asc#languages>`_.
 
-After you have installed a language pack, you can use it with ``ocrmypdf -l <language>``,
-for example ``ocrmypdf -l spa``. For multilingual documents, you can specify
-all languages to be expected, e.g. ``ocrmypdf -l eng+fra`` for English and French.
-English is assumed by default unless other language(s) are specified.
-
-For Linux users, you can often find packages that provide language
-packs:
+For Linux users, you can often find packages that provide language packs:
 
 Debian and Ubuntu users
-=======================
+-----------------------
 
 .. code-block:: bash
 
    # Display a list of all Tesseract language packs
    apt-cache search tesseract-ocr
 
-   # Install Chinese Simplified language pack
-   apt-get install tesseract-ocr-chi-sim
+   # Debian/Ubuntu users
+   apt-get install tesseract-ocr-chi-sim  # Example: Install Chinese Simplified language back
+   
+You can then pass the ``-l LANG`` argument to OCRmyPDF to give a hint as to what languages it should search for. Multiple
+languages can be requested using either ``-l eng+fre`` (English and French) or ``-l eng -l fre``.
 
-You can then pass the ``-l LANG`` argument to OCRmyPDF to give a hint as
-to what languages it should search for. Multiple languages can be
-requested using either ``-l eng+fra`` (English and French) or
-``-l eng -l fra``.
+macOS users
+-----------
 
-Fedora users
-============
+You can install additional language packs by :ref:`installing Tesseract using Homebrew with all language packs <macos-all-languages>`.
+
+Docker users
+------------
+
+Users of the Docker image may use the alternative :ref:`"polyglot" container <docker-polyglot>` which includes all languages.
+
+Adding individual language packs to a Docker image
+""""""""""""""""""""""""""""""""""""""""""""""""""
+
+If you wish to add a single language pack, you could do the following:
+
+* Download the desired ``.trainedata`` file from the `tessdata <https://github.com/tesseract-ocr/tessdata>`_ repository. Let's use Hebrew in this example (``heb.traineddata``)
+
+* Copy the file to ``/home/user/downloads/heb.traineddata``.
+
+* Create a new container based on the ocrmypdf-tess4 image and jump into it with a terminal:
 
 .. code-block:: bash
 
-   # Display a list of all Tesseract language packs
-   dnf search tesseract
+	host$ docker run  -v /home/user/downloads:/home/docker -it --entrypoint /bin/bash ocrmypdf-tess4
 
-   # Install Chinese Simplified language pack
-   dnf install tesseract-langpack-chi_sim
+* Put the file where Tesseract expects it:
 
-You can then pass the ``-l LANG`` argument to OCRmyPDF to give a hint as
-to what languages it should search for. Multiple languages can be
-requested using either ``-l eng+fra`` (English and French) or
-``-l eng -l fra``.
+.. code-block:: bash
 
-macOS users
-===========
+	docker$ cp /home/docker/heb.traineddata /usr/share/tesseract-ocr/tessdata
 
-You can install additional language packs by
-:ref:`installing Tesseract using Homebrew with all language packs <macos-all-languages>`.
+* Note the container id, and save it as a new image (in this example, ``ocrmypdf-tess4-heb``)
 
-Docker users
-============
+.. code-block:: bash
 
-Users of the OCRmyPDF Docker image should install language packs into a
-derived Docker image as
-:ref:`described in that section <docker-lang-packs>`.
+    host$ docker commit <container_id> ocrmypdf-tess4-heb
 
-Windows users
-=============
 
-The Tesseract installer provided by Chocolatey currently includes only English language. 
-To install other languages, download the respective language pack (``.traineddata`` file) 
-from https://github.com/tesseract-ocr/tessdata/ and place it in 
-``C:\\Program Files\\Tesseract-OCR\\tessdata`` (or wherever Tesseract OCR is installed).
+Known limitations
+-----------------
+
+As of v4.2, users of ocrmypdf working languages outside the Latin alphabet should use the following syntax:
+
+.. code-block:: bash
+
+	ocrmypdf -l eng+gre --output-type pdf --pdf-renderer tesseract
+
+The reasons for this are:
+
+* The latest version of Ghostscript (9.19 as of this writing) has unfixed bugs in Unicode handling that generate invalid character maps, so Ghostscript cannot be used for PDF/A conversion
+* The default "hocr" PDF renderer does not handle Asian fonts properly

docs/optimizer.rst

@@ -1,75 +0,0 @@
-================
-PDF optimization
-================
-
-OCRmyPDF includes an image-oriented PDF optimizer. By default, the optimizer
-runs with safe settings with the goal of improving compression at no loss of
-quality. At higher optimization levels, lossy optimizations may be applied and
-tuned. Optimization occurs after OCR, and only if OCR succeeded.  It does not
-perform other possible optimizations such as deduplicating resources,
-consolidating fonts, simplifying vector drawings, or anything of that nature.
-
-Optimization ranges from ``-O0`` through ``-O3``, where ``0`` disables
-optimization and ``3`` implements all options. ``1``, the default, performs only
-safe and lossless optimizations. (This is similar to GCC's optimization
-parameter.) The exact type of optimizations performed will vary over time.
-
-PDF optimization requires third-party, optional tools for certain optimizations.
-If these are not installed or cannot be found by OCRmyPDF, optimization will not
-be as good.
-
-Optimizations that always occurs
-================================
-
-OCRmyPDF will automatically replace obsolete or inferior compression schemes
-such as RLE or LZW with superior schemes such as Deflate and converting
-monochrome images to CCITT G4. Since this is harmless it always occurs and there
-is no way to disable it. Other non-image compressed objects are compressed as
-well.
-
-Fast web view
-=============
-
-OCRmyPDF automatically optimizes PDFs for "fast web view" in Adobe Acrobat's
-parlance, or equivalently, linearizes PDFs so that the resources they reference
-are presented in the order a viewer needs them for sequential display. This
-reduces the latency of viewing a PDF both online and from local storage. This
-actually slightly increases the file size.
-
-To disable this optimization and all others, use ``ocrmypdf --optimize 0 ...``
-or the shorthand ``-O0``.
-
-Lossless optimizations
-======================
-
-At optimization level ``-O1`` (the default), OCRmyPDF will also attempt lossless
-image optimization.
-
-If a JBIG2 encoder is available, then monochrome images will be converted to
-JBIG2, with the potential for huge savings on large black and white images,
-since JBIG2 is far more efficient than any other monochrome (bi-level)
-compression. (All known US patents related to JBIG2 have probably expired, but
-it remains the responsibility of the user to supply a JBIG2 encoder such as
-`jbig2enc <https://github.com/agl/jbig2enc>`__. OCRmyPDF does not implement
-JBIG2 encoding on its own.)
-
-OCRmyPDF currently does not attempt to recompress losslessly compressed objects
-more aggressively.
-
-Lossy optimizations
-===================
-
-At optimization level ``-O2`` and ``-O3``, OCRmyPDF will some attempt lossy
-image optimization.
-
-If ``pngquant`` is installed, OCRmyPDF will use it to perform quantize paletted
-images to reduce their size.
-
-The quality of JPEGs may be lowered, on the assumption that a lower quality
-image may be suitable for storage after OCR.
-
-It is not possible to optimize all image types. Uncommon image types may be
-skipped by the optimizer.
-
-OCRmyPDF provides :ref:`lossy mode JBIG2 <jbig2-lossy>` as an advanced feature
-that additional requires the argument ``--jbig2-lossy``.

docs/pdfsecurity.rst

@@ -1,162 +0,0 @@
-===================
-PDF security issues
-===================
-
-   OCRmyPDF should only be used on PDFs you trust. It is not designed to
-   protect you against malware.
-
-Recognizing that many users have an interest in handling PDFs and
-applying OCR to PDFs they did not generate themselves, this article
-discusses the security implications of PDFs and how users can protect
-themselves.
-
-The disclaimer applies: this software has no warranties of any kind.
-
-PDFs may contain malware
-========================
-
-PDF is a rich, complex file format. The official PDF 1.7 specification,
-ISO 32000:2008, is hundreds of pages long and references several annexes
-each of which are similar in length. PDFs can contain video, audio, XML,
-JavaScript and other programming, and forms. In some cases, they can
-open internet connections to pre-selected URLs. All of these are possible
-attack vectors.
-
-In short, PDFs `may contain
-viruses <https://security.stackexchange.com/questions/64052/can-a-pdf-file-contain-a-virus>`__.
-
-This
-`article <https://theinvisiblethings.blogspot.ca/2013/02/converting-untrusted-pdfs-into-trusted.html>`__
-describes a high-paranoia method which allows potentially hostile PDFs
-to be viewed and rasterized safely in a disposable virtual machine. A
-trusted PDF created in this manner is converted to images and loses all
-information making it searchable and losing all compression. OCRmyPDF
-could be used to restore searchability.
-
-How OCRmyPDF processes PDFs
-===========================
-
-OCRmyPDF must open and interpret your PDF in order to insert an OCR
-layer. First, it runs all PDFs through
-`pikepdf <https://github.com/pikepdf/pikepdf>`__, a library based on
-`qpdf <https://github.com/qpdf/qpdf>`__, a program that repairs PDFs
-with syntax errors. This is done because, in the author's experience, a
-significant number of PDFs in the wild, especially those created by
-scanners, are not well-formed files. qpdf makes it more likely that
-OCRmyPDF will succeed, but offers no security guarantees. qpdf is also
-used to split the PDF into single page PDFs.
-
-Finally, OCRmyPDF rasterizes each page of the PDF using
-`Ghostscript <http://ghostscript.com/>`__ in ``-dSAFER`` mode.
-
-Depending on the options specified, OCRmyPDF may graft the OCR layer
-into the existing PDF or it may essentially reconstruct ("re-fry") a
-visually identical PDF that may be quite different at the binary level.
-That said, OCRmyPDF is not a tool designed for sanitizing PDFs.
-
-.. _ocr-service:
-
-Using OCRmyPDF online or as a service
-=====================================
-
-OCRmyPDF is not designed for use as a public web service where a
-malicious user could upload a chosen PDF. In particular, it is not
-necessarily secure against PDF malware or PDFs that cause denial of
-service. OCRmyPDF relies on Ghostscript, and therefore, if deployed
-online one should be prepared to comply with Ghostscript's Affero GPL
-license, and any other licenses.
-
-Setting aside these concerns, a side effect of OCRmyPDF is that it may
-incidentally sanitize PDFs containing certain types of malware. It
-repairs the PDF with pikepdf/libqpdf, which could correct malformed PDF
-structures that are part of an attack. When PDF/A output is selected
-(the default), the input PDF is partially reconstructed by Ghostscript.
-When ``--force-ocr`` is used, all pages are rasterized and reconverted
-to PDF, which could remove malware in embedded images.
-
-OCRmyPDF should be relatively safe to use in a trusted intranet, with
-some considerations:
-
-Limiting CPU usage
-------------------
-
-OCRmyPDF will attempt to use all available CPUs and storage, so
-executing ``nice ocrmypdf`` or limiting the number of jobs with the
-``-j`` argument may ensure the server remains available. Another option
-would be to run OCRmyPDF jobs inside a Docker container, a virtual machine,
-or a cloud instance, which can impose its own limits on CPU usage and be
-terminated "from orbit" if it fails to complete.
-
-Temporary storage requirements
-------------------------------
-
-OCRmyPDF will use a large amount of temporary storage for its work,
-proportional to the total number of pixels needed to rasterize the PDF.
-The raster image of a 8.5×11" color page at 300 DPI takes 25 MB
-uncompressed; OCRmyPDF saves its intermediates as PNG, but that still
-means it requires about 9 MB per intermediate based on average
-compression ratios. Multiple intermediates per page are also required,
-depending on the command line given. A rule of thumb would be to allow
-100 MB of temporary storage per page in a file – meaning that a small
-cloud servers or small VM partitions should be provisioned with plenty
-of extra space, if say, a 500 page file might be sent.
-
-To check temporary storage usage on actual files, run
-``ocrmypdf -k ...`` which will preserve and print the path to temporary
-storage when the job is done.
-
-To change where temporary files are stored, change the ``TMPDIR``
-environment variable for ocrmypdf's environment. (Python's
-``tempfile.gettempdir()`` returns the root directory in which temporary
-files will be stored.) For example, one could redirect ``TMPDIR`` to a
-large RAM disk to avoid wear on HDD/SSD and potentially improve
-performance. On Amazon Web Services, ``TMPDIR`` can be set to `empheral
-storage <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html>`__.
-
-Timeouts
---------
-
-To prevent excessively long OCR jobs consider setting
-``--tesseract-timeout`` and/or ``--skip-big`` arguments. ``--skip-big``
-is particularly helpful if your PDFs include documents such as reports
-on standard page sizes with large images attached - often large images
-are not worth OCR'ing anyway.
-
-Commercial alternatives
------------------------
-
-The author also provides professional services that include OCR and
-building databases around PDFs, and is happy to provide consultation.
-
-Abbyy Cloud OCR is viable commercial alternative with a web services
-API. Amazon Textract, Google Cloud Vision, and Microsoft Azure 
-Computer Vision provide advanced OCR but have less PDF rendering capability.
-
-Password protection, digital signatures and certification
-=========================================================
-
-Password protected PDFs usually have two passwords, and owner and user
-password. When the user password is set to empty, PDF readers will open
-the file automatically and marked it as "(SECURED)". While not as
-reliable as a digital signature, this indicates that whoever set the
-password approved of the file at that time. When the user password is
-set, the document cannot be viewed without the password.
-
-Either way, OCRmyPDF does not remove passwords from PDFs and exits with
-an error on encountering them.
-
-``qpdf`` can remove passwords. If the owner and user password are set, a
-password is required for ``qpdf``. If only the owner password is set, then the
-password can be stripped, even if one does not have the owner password.
-
-After OCR is applied, password protection is not permitted on PDF/A
-documents but the file can be converted to regular PDF.
-
-Many programs exist which are capable of inserting an image of someone's
-signature. On its own, this offers no security guarantees. It is trivial
-to remove the signature image and apply it to other files. This practice
-offers no real security.
-
-Important documents can be digitally signed and certified to attest to
-their authorship. OCRmyPDF cannot do this. Open source tools such as
-pdfbox (Java) have this capability as does Adobe Acrobat.

docs/performance.rst

@@ -1,22 +0,0 @@
-===========
-Performance
-===========
-
-Some users have noticed that current versions of OCRmyPDF do not run as quickly
-as some older versions (specifically 6.x and older). This is because OCRmyPDF
-added image optimization as a postprocessing step, and it is enabled by default.
-
-Speed
-=====
-
-If running OCRmyPDF quickly is your main goal, you can use settings such as:
-
-* ``--optimize 0`` to disable file size optimization
-* ``--output-type pdf`` to disable PDF/A generation
-* ``--fast-web-view 0`` to disable fast web view optimization
-* ``--skip-big`` to skip large images, if some pages have large images
-
-You can also avoid:
-
-* ``--force-ocr``
-* Image preprocessing

docs/pipeline.svg

@@ -0,0 +1,553 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
+ "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<!-- Generated by graphviz version 2.40.1 (20161225.0304)
+ -->
+<!-- Title: Pipeline: Pages: 1 -->
+<svg width="1952pt" height="1277pt"
+ viewBox="0.00 0.00 1952.00 1277.18" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 1273.1825)">
+<title>Pipeline:</title>
+<polygon fill="#ffffff" stroke="transparent" points="-4,4 -4,-1273.1825 1948,-1273.1825 1948,4 -4,4"/>
+<g id="clust1" class="cluster">
+<title>clustertasks</title>
+<polygon fill="none" stroke="#000000" points="8,-8 8,-1261.1825 1936,-1261.1825 1936,-8 8,-8"/>
+<text text-anchor="middle" x="972" y="-1233.1825" font-family="Times,serif" font-size="30.00" fill="#ff3232">Pipeline:</text>
+</g>
+<!-- t0 -->
+<g id="node1" class="node">
+<title>t0</title>
+<polygon fill="#efa03b" stroke="#000000" points="876.7053,-1215.1825 667.2947,-1215.1825 663.2947,-1211.1825 663.2947,-1179.1825 872.7053,-1179.1825 876.7053,-1183.1825 876.7053,-1215.1825"/>
+<polyline fill="none" stroke="#000000" points="872.7053,-1211.1825 663.2947,-1211.1825 "/>
+<polyline fill="none" stroke="#000000" points="872.7053,-1211.1825 872.7053,-1179.1825 "/>
+<polyline fill="none" stroke="#000000" points="872.7053,-1211.1825 876.7053,-1215.1825 "/>
+<text text-anchor="middle" x="770" y="-1191.1825" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.triage</text>
+</g>
+<!-- t1 -->
+<g id="node2" class="node">
+<title>t1</title>
+<polygon fill="#efa03b" stroke="#000000" points="941.0433,-1157.1825 602.9567,-1157.1825 598.9567,-1153.1825 598.9567,-1121.1825 937.0433,-1121.1825 941.0433,-1125.1825 941.0433,-1157.1825"/>
+<polyline fill="none" stroke="#000000" points="937.0433,-1153.1825 598.9567,-1153.1825 "/>
+<polyline fill="none" stroke="#000000" points="937.0433,-1153.1825 937.0433,-1121.1825 "/>
+<polyline fill="none" stroke="#000000" points="937.0433,-1153.1825 941.0433,-1157.1825 "/>
+<text text-anchor="middle" x="770" y="-1133.1825" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.repair_and_parse_pdf</text>
+</g>
+<!-- t0&#45;&gt;t1 -->
+<g id="edge1" class="edge">
+<title>t0&#45;&gt;t1</title>
+<path fill="none" stroke="#0044a0" d="M770,-1179.1488C770,-1175.4743 770,-1171.5242 770,-1167.5888"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="773.5001,-1167.4047 770,-1157.4047 766.5001,-1167.4047 773.5001,-1167.4047"/>
+</g>
+<!-- t2 -->
+<g id="node3" class="node">
+<title>t2</title>
+<polygon fill="#efa03b" stroke="#000000" points="1043.9447,-1078.2585 787,-1095.158 530.0553,-1078.2585 530.2951,-1050.9147 1043.7049,-1050.9147 1043.9447,-1078.2585"/>
+<polygon fill="none" stroke="#000000" points="1047.9814,-1081.9991 787,-1099.164 526.0186,-1081.9991 526.3263,-1046.9173 1047.6737,-1046.9173 1047.9814,-1081.9991"/>
+<text text-anchor="middle" x="787" y="-1064.7009" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.pre_split_pages</text>
+</g>
+<!-- t1&#45;&gt;t2 -->
+<g id="edge2" class="edge">
+<title>t1&#45;&gt;t2</title>
+<path fill="none" stroke="#0044a0" d="M774.5557,-1120.8306C775.4962,-1117.0421 776.5194,-1112.92 777.5618,-1108.7212"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="780.986,-1109.4542 779.9984,-1098.9055 774.1922,-1107.7677 780.986,-1109.4542"/>
+</g>
+<!-- t20 -->
+<g id="node22" class="node">
+<title>t20</title>
+<polygon fill="#efa03b" stroke="#000000" points="649.5156,-1020.2193 286.4844,-1020.2193 282.4844,-1016.2193 282.4844,-984.2193 645.5156,-984.2193 649.5156,-988.2193 649.5156,-1020.2193"/>
+<polyline fill="none" stroke="#000000" points="645.5156,-1016.2193 282.4844,-1016.2193 "/>
+<polyline fill="none" stroke="#000000" points="645.5156,-1016.2193 645.5156,-984.2193 "/>
+<polyline fill="none" stroke="#000000" points="645.5156,-1016.2193 649.5156,-1020.2193 "/>
+<text text-anchor="middle" x="466" y="-996.2193" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.generate_postscript_stub</text>
+</g>
+<!-- t1&#45;&gt;t20 -->
+<g id="edge31" class="edge">
+<title>t1&#45;&gt;t20</title>
+<path fill="none" stroke="#0044a0" d="M598.785,-1123.5822C563.105,-1117.7214 531.8209,-1109.8012 517,-1099.1825 493.9382,-1082.6593 480.4369,-1052.4741 473.1842,-1030.1561"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="476.5199,-1029.095 470.2797,-1020.5329 469.8185,-1031.1177 476.5199,-1029.095"/>
+</g>
+<!-- t24 -->
+<g id="node24" class="node">
+<title>t24</title>
+<polygon fill="#efa03b" stroke="#000000" points="20.4213,-156.4247 242,-129.112 463.5787,-156.4247 463.3719,-200.6177 20.6281,-200.6177 20.4213,-156.4247"/>
+<polygon fill="none" stroke="#000000" points="16.4083,-152.8864 242,-125.079 467.5917,-152.8864 467.3496,-204.6205 16.6504,-204.6205 16.4083,-152.8864"/>
+<text text-anchor="middle" x="242" y="-162.6394" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.merge_pages_mupdf</text>
+</g>
+<!-- t1&#45;&gt;t24 -->
+<g id="edge41" class="edge">
+<title>t1&#45;&gt;t24</title>
+<path fill="none" stroke="#0044a0" d="M598.6617,-1124.8567C376.4578,-1103.9215 17,-1060.9746 17,-1002.2193 17,-1002.2193 17,-1002.2193 17,-335.7123 17,-276.266 68.2524,-235.5065 121.8346,-209.1377"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="123.6227,-212.1629 131.1479,-204.7049 120.6143,-205.8423 123.6227,-212.1629"/>
+</g>
+<!-- t23 -->
+<g id="node25" class="node">
+<title>t23</title>
+<polygon fill="#efa03b" stroke="#000000" points="1006.4902,-156.4239 1218,-129.1092 1429.5098,-156.4239 1429.3124,-200.6199 1006.6876,-200.6199 1006.4902,-156.4239"/>
+<polygon fill="none" stroke="#000000" points="1002.4742,-152.9063 1218,-125.073 1433.5258,-152.9063 1433.2948,-204.623 1002.7052,-204.623 1002.4742,-152.9063"/>
+<text text-anchor="middle" x="1218" y="-162.6394" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.merge_pages_qpdf</text>
+</g>
+<!-- t1&#45;&gt;t23 -->
+<g id="edge46" class="edge">
+<title>t1&#45;&gt;t23</title>
+<path fill="none" stroke="#0044a0" d="M941.3419,-1136.2202C1263.4143,-1128.3561 1927,-1100.2573 1927,-1002.2193 1927,-1002.2193 1927,-1002.2193 1927,-335.7123 1927,-234.7734 1651.3069,-194.7548 1443.7522,-178.9295"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="1443.8443,-175.4267 1433.6111,-178.1712 1443.3223,-182.4072 1443.8443,-175.4267"/>
+</g>
+<!-- t3 -->
+<g id="node4" class="node">
+<title>t3</title>
+<polygon fill="#efa03b" stroke="#000000" points="1055.3851,-1020.2193 808.6149,-1020.2193 804.6149,-1016.2193 804.6149,-984.2193 1051.3851,-984.2193 1055.3851,-988.2193 1055.3851,-1020.2193"/>
+<polyline fill="none" stroke="#000000" points="1051.3851,-1016.2193 804.6149,-1016.2193 "/>
+<polyline fill="none" stroke="#000000" points="1051.3851,-1016.2193 1051.3851,-984.2193 "/>
+<polyline fill="none" stroke="#000000" points="1051.3851,-1016.2193 1055.3851,-1020.2193 "/>
+<text text-anchor="middle" x="930" y="-996.2193" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.split_page</text>
+</g>
+<!-- t2&#45;&gt;t3 -->
+<g id="edge3" class="edge">
+<title>t2&#45;&gt;t3</title>
+<path fill="none" stroke="#0044a0" d="M837.0145,-1046.7494C851.946,-1039.5987 868.2558,-1031.7881 882.9879,-1024.733"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="884.9035,-1027.6964 892.4109,-1020.2204 881.88,-1021.383 884.9035,-1027.6964"/>
+</g>
+<!-- t4 -->
+<g id="node5" class="node">
+<title>t4</title>
+<polygon fill="#efa03b" stroke="#000000" points="1194.5194,-941.2939 964,-958.1945 733.4806,-941.2939 733.6958,-913.948 1194.3042,-913.948 1194.5194,-941.2939"/>
+<polygon fill="none" stroke="#000000" points="1198.5491,-945.0069 964,-962.203 729.4509,-945.0069 729.7267,-909.9503 1198.2733,-909.9503 1198.5491,-945.0069"/>
+<text text-anchor="middle" x="964" y="-927.7357" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.ocr_or_skip</text>
+</g>
+<!-- t3&#45;&gt;t4 -->
+<g id="edge4" class="edge">
+<title>t3&#45;&gt;t4</title>
+<path fill="none" stroke="#0044a0" d="M939.1114,-983.867C941.197,-979.6659 943.4863,-975.0549 945.8053,-970.3839"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="948.9439,-971.9327 950.2559,-961.4194 942.6741,-968.8199 948.9439,-971.9327"/>
+</g>
+<!-- t5 -->
+<g id="node6" class="node">
+<title>t5</title>
+<polygon fill="#efa03b" stroke="#000000" points="1119.3166,-883.252 812.6834,-883.252 808.6834,-879.252 808.6834,-847.252 1115.3166,-847.252 1119.3166,-851.252 1119.3166,-883.252"/>
+<polyline fill="none" stroke="#000000" points="1115.3166,-879.252 808.6834,-879.252 "/>
+<polyline fill="none" stroke="#000000" points="1115.3166,-879.252 1115.3166,-847.252 "/>
+<polyline fill="none" stroke="#000000" points="1115.3166,-879.252 1119.3166,-883.252 "/>
+<text text-anchor="middle" x="964" y="-859.252" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.rasterize_preview</text>
+</g>
+<!-- t4&#45;&gt;t5 -->
+<g id="edge5" class="edge">
+<title>t4&#45;&gt;t5</title>
+<path fill="none" stroke="#0044a0" d="M964,-909.7834C964,-904.5184 964,-898.8955 964,-893.4799"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="967.5001,-893.4695 964,-883.4695 960.5001,-893.4695 967.5001,-893.4695"/>
+</g>
+<!-- t6 -->
+<g id="node7" class="node">
+<title>t6</title>
+<polygon fill="#efa03b" stroke="#000000" points="1269.0824,-825.252 1010.9176,-825.252 1006.9176,-821.252 1006.9176,-789.252 1265.0824,-789.252 1269.0824,-793.252 1269.0824,-825.252"/>
+<polyline fill="none" stroke="#000000" points="1265.0824,-821.252 1006.9176,-821.252 "/>
+<polyline fill="none" stroke="#000000" points="1265.0824,-821.252 1265.0824,-789.252 "/>
+<polyline fill="none" stroke="#000000" points="1265.0824,-821.252 1269.0824,-825.252 "/>
+<text text-anchor="middle" x="1138" y="-801.252" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.orient_page</text>
+</g>
+<!-- t4&#45;&gt;t6 -->
+<g id="edge7" class="edge">
+<title>t4&#45;&gt;t6</title>
+<path fill="none" stroke="#0044a0" d="M1072.6871,-909.8532C1097.768,-902.2558 1119.5887,-893.2079 1128,-883.252 1138.9559,-870.2843 1141.4763,-851.3696 1141.2475,-835.6545"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="1144.7291,-835.2052 1140.7199,-825.3983 1137.7384,-835.5649 1144.7291,-835.2052"/>
+</g>
+<!-- t5&#45;&gt;t6 -->
+<g id="edge6" class="edge">
+<title>t5&#45;&gt;t6</title>
+<path fill="none" stroke="#0044a0" d="M1018.1009,-847.2184C1035.9411,-841.2716 1055.9459,-834.6034 1074.4267,-828.4431"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="1075.5526,-831.7572 1083.9326,-825.2745 1073.3389,-825.1165 1075.5526,-831.7572"/>
+</g>
+<!-- t7 -->
+<g id="node8" class="node">
+<title>t7</title>
+<polygon fill="#efa03b" stroke="#000000" points="917.7325,-767.252 542.2675,-767.252 538.2675,-763.252 538.2675,-731.252 913.7325,-731.252 917.7325,-735.252 917.7325,-767.252"/>
+<polyline fill="none" stroke="#000000" points="913.7325,-763.252 538.2675,-763.252 "/>
+<polyline fill="none" stroke="#000000" points="913.7325,-763.252 913.7325,-731.252 "/>
+<polyline fill="none" stroke="#000000" points="913.7325,-763.252 917.7325,-767.252 "/>
+<text text-anchor="middle" x="728" y="-743.252" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.rasterize_with_ghostscript</text>
+</g>
+<!-- t6&#45;&gt;t7 -->
+<g id="edge8" class="edge">
+<title>t6&#45;&gt;t7</title>
+<path fill="none" stroke="#0044a0" d="M1010.5209,-789.2184C964.4341,-782.6988 912.2171,-775.312 865.3222,-768.6781"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="865.792,-765.2098 855.4003,-767.2745 864.8114,-772.1408 865.792,-765.2098"/>
+</g>
+<!-- t17 -->
+<g id="node15" class="node">
+<title>t17</title>
+<polygon fill="#ff69b4" stroke="#000000" points="1224.2696,-447.252 843.7304,-447.252 839.7304,-443.252 839.7304,-411.252 1220.2696,-411.252 1224.2696,-415.252 1224.2696,-447.252"/>
+<polyline fill="none" stroke="#000000" points="1220.2696,-443.252 839.7304,-443.252 "/>
+<polyline fill="none" stroke="#000000" points="1220.2696,-443.252 1220.2696,-411.252 "/>
+<polyline fill="none" stroke="#000000" points="1220.2696,-443.252 1224.2696,-447.252 "/>
+<text text-anchor="middle" x="1032" y="-423.252" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.ocr_tesseract_textonly_pdf</text>
+</g>
+<!-- t6&#45;&gt;t17 -->
+<g id="edge16" class="edge">
+<title>t6&#45;&gt;t17</title>
+<path fill="none" stroke="#0044a0" d="M1158.4397,-788.9107C1179.7261,-767.6923 1210,-730.5987 1210,-691.252 1210,-691.252 1210,-691.252 1210,-575.252 1210,-532.3545 1227.3937,-512.2638 1200,-479.252 1190.5284,-467.8379 1163.9108,-457.8666 1134.5783,-449.8944"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="1135.1079,-446.4151 1124.5475,-447.2681 1133.3349,-453.1869 1135.1079,-446.4151"/>
+</g>
+<!-- t14 -->
+<g id="node17" class="node">
+<title>t14</title>
+<polygon fill="#00cc66" stroke="#000000" points="1565,-457.252 1242.4141,-429.252 1565,-401.252 1887.5859,-429.252 1565,-457.252"/>
+<text text-anchor="middle" x="1565" y="-423.252" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.select_image_layer</text>
+</g>
+<!-- t6&#45;&gt;t14 -->
+<g id="edge22" class="edge">
+<title>t6&#45;&gt;t14</title>
+<path fill="none" stroke="#0044a0" d="M1211.6459,-789.1984C1287.5889,-768.3738 1395,-731.7602 1395,-691.252 1395,-691.252 1395,-691.252 1395,-575.252 1395,-519.4485 1448.3697,-480.3436 1495.3026,-456.7437"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="1497.1229,-459.7505 1504.5857,-452.2301 1494.0619,-453.4552 1497.1229,-459.7505"/>
+</g>
+<!-- t21 -->
+<g id="node20" class="node">
+<title>t21</title>
+<polygon fill="#efa03b" stroke="#000000" points="1414.7716,-270.1725 1169.2284,-270.1725 1165.2284,-266.1725 1165.2284,-234.1725 1410.7716,-234.1725 1414.7716,-238.1725 1414.7716,-270.1725"/>
+<polyline fill="none" stroke="#000000" points="1410.7716,-266.1725 1165.2284,-266.1725 "/>
+<polyline fill="none" stroke="#000000" points="1410.7716,-266.1725 1410.7716,-234.1725 "/>
+<polyline fill="none" stroke="#000000" points="1410.7716,-266.1725 1414.7716,-270.1725 "/>
+<text text-anchor="middle" x="1290" y="-246.1725" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.skip_page</text>
+</g>
+<!-- t6&#45;&gt;t21 -->
+<g id="edge28" class="edge">
+<title>t6&#45;&gt;t21</title>
+<path fill="none" stroke="#0044a0" d="M1269.322,-800.6326C1488.9576,-787.7851 1907,-754.9633 1907,-691.252 1907,-691.252 1907,-691.252 1907,-429.252 1907,-329.7211 1606.6136,-282.8737 1425.0278,-263.647"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="1425.1684,-260.1428 1414.8592,-262.586 1424.4419,-267.105 1425.1684,-260.1428"/>
+</g>
+<!-- t19 -->
+<g id="node21" class="node">
+<title>t19</title>
+<polygon fill="#66ccff" stroke="#000000" points="465.6739,-447.252 60.3261,-447.252 56.3261,-443.252 56.3261,-411.252 461.6739,-411.252 465.6739,-415.252 465.6739,-447.252"/>
+<polyline fill="none" stroke="#000000" points="461.6739,-443.252 56.3261,-443.252 "/>
+<polyline fill="none" stroke="#000000" points="461.6739,-443.252 461.6739,-411.252 "/>
+<polyline fill="none" stroke="#000000" points="461.6739,-443.252 465.6739,-447.252 "/>
+<text text-anchor="middle" x="261" y="-423.252" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.ocr_tesseract_and_render_pdf</text>
+</g>
+<!-- t6&#45;&gt;t19 -->
+<g id="edge30" class="edge">
+<title>t6&#45;&gt;t19</title>
+<path fill="none" stroke="#0044a0" d="M1006.6775,-802.4744C883.1032,-797.0687 693.0454,-786.4114 529,-767.252 327.1018,-743.6717 78,-894.5226 78,-691.252 78,-691.252 78,-691.252 78,-575.252 78,-532.3545 60.4757,-512.1551 88,-479.252 97.684,-467.6756 124.6714,-457.7191 154.5327,-449.8074"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="155.4872,-453.176 164.3106,-447.311 153.7556,-446.3936 155.4872,-453.176"/>
+</g>
+<!-- t8 -->
+<g id="node9" class="node">
+<title>t8</title>
+<polygon fill="#efa03b" stroke="#000000" points="942.0801,-709.252 517.9199,-709.252 513.9199,-705.252 513.9199,-673.252 938.0801,-673.252 942.0801,-677.252 942.0801,-709.252"/>
+<polyline fill="none" stroke="#000000" points="938.0801,-705.252 513.9199,-705.252 "/>
+<polyline fill="none" stroke="#000000" points="938.0801,-705.252 938.0801,-673.252 "/>
+<polyline fill="none" stroke="#000000" points="938.0801,-705.252 942.0801,-709.252 "/>
+<text text-anchor="middle" x="728" y="-685.252" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.preprocess_remove_background</text>
+</g>
+<!-- t7&#45;&gt;t8 -->
+<g id="edge9" class="edge">
+<title>t7&#45;&gt;t8</title>
+<path fill="none" stroke="#0044a0" d="M728,-731.2184C728,-727.5438 728,-723.5938 728,-719.6583"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="731.5001,-719.4742 728,-709.4743 724.5001,-719.4743 731.5001,-719.4742"/>
+</g>
+<!-- t13 -->
+<g id="node16" class="node">
+<title>t13</title>
+<polygon fill="#efa03b" stroke="#000000" points="481,-535.252 97.1874,-507.252 481,-479.252 864.8126,-507.252 481,-535.252"/>
+<text text-anchor="middle" x="481" y="-501.252" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.select_visible_page_image</text>
+</g>
+<!-- t7&#45;&gt;t13 -->
+<g id="edge20" class="edge">
+<title>t7&#45;&gt;t13</title>
+<path fill="none" stroke="#0044a0" d="M592.7552,-731.2177C555.8805,-724.9263 521.5464,-717.3855 505,-709.252 470.5499,-692.3178 456.557,-686.3456 441,-651.252 425.2764,-615.7827 441.5685,-572.6191 457.8398,-542.8513"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="460.9365,-544.4864 462.8533,-534.0664 454.8568,-541.0167 460.9365,-544.4864"/>
+</g>
+<!-- t9 -->
+<g id="node10" class="node">
+<title>t9</title>
+<polygon fill="#efa03b" stroke="#000000" points="773.6759,-651.252 454.3241,-651.252 450.3241,-647.252 450.3241,-615.252 769.6759,-615.252 773.6759,-619.252 773.6759,-651.252"/>
+<polyline fill="none" stroke="#000000" points="769.6759,-647.252 450.3241,-647.252 "/>
+<polyline fill="none" stroke="#000000" points="769.6759,-647.252 769.6759,-615.252 "/>
+<polyline fill="none" stroke="#000000" points="769.6759,-647.252 773.6759,-651.252 "/>
+<text text-anchor="middle" x="612" y="-627.252" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.preprocess_deskew</text>
+</g>
+<!-- t8&#45;&gt;t9 -->
+<g id="edge10" class="edge">
+<title>t8&#45;&gt;t9</title>
+<path fill="none" stroke="#0044a0" d="M691.9327,-673.2184C680.9122,-667.7081 668.6526,-661.5783 657.1104,-655.8072"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="658.5545,-652.6162 648.045,-651.2745 655.424,-658.8772 658.5545,-652.6162"/>
+</g>
+<!-- t8&#45;&gt;t13 -->
+<g id="edge19" class="edge">
+<title>t8&#45;&gt;t13</title>
+<path fill="none" stroke="#0044a0" d="M763.3121,-673.1037C771.2083,-667.2594 778.5531,-659.9847 783,-651.252 790.2604,-636.9942 792.214,-628.3326 783,-615.252 759.3602,-581.6921 662.7714,-550.9641 585.1057,-530.9385"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="585.806,-527.5052 575.2515,-528.4283 584.078,-534.2886 585.806,-527.5052"/>
+</g>
+<!-- t10 -->
+<g id="node11" class="node">
+<title>t10</title>
+<polygon fill="#efa03b" stroke="#000000" points="1117.8828,-593.252 816.1172,-593.252 812.1172,-589.252 812.1172,-557.252 1113.8828,-557.252 1117.8828,-561.252 1117.8828,-593.252"/>
+<polyline fill="none" stroke="#000000" points="1113.8828,-589.252 812.1172,-589.252 "/>
+<polyline fill="none" stroke="#000000" points="1113.8828,-589.252 1113.8828,-557.252 "/>
+<polyline fill="none" stroke="#000000" points="1113.8828,-589.252 1117.8828,-593.252 "/>
+<text text-anchor="middle" x="965" y="-569.252" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.preprocess_clean</text>
+</g>
+<!-- t9&#45;&gt;t10 -->
+<g id="edge11" class="edge">
+<title>t9&#45;&gt;t10</title>
+<path fill="none" stroke="#0044a0" d="M721.7564,-615.2184C760.9379,-608.7806 805.2658,-601.4973 845.2464,-594.9283"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="846.0113,-598.3496 855.3115,-593.2745 844.8763,-591.4422 846.0113,-598.3496"/>
+</g>
+<!-- t9&#45;&gt;t13 -->
+<g id="edge18" class="edge">
+<title>t9&#45;&gt;t13</title>
+<path fill="none" stroke="#0044a0" d="M593.2309,-615.1993C573.0988,-595.8356 540.6771,-564.6514 515.8453,-540.7673"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="518.0381,-538.0203 508.4046,-533.6106 513.1856,-543.0654 518.0381,-538.0203"/>
+</g>
+<!-- t11 -->
+<g id="node12" class="node">
+<title>t11</title>
+<polygon fill="#efa03b" stroke="#000000" points="1191.1094,-525.252 886.8906,-525.252 882.8906,-521.252 882.8906,-489.252 1187.1094,-489.252 1191.1094,-493.252 1191.1094,-525.252"/>
+<polyline fill="none" stroke="#000000" points="1187.1094,-521.252 882.8906,-521.252 "/>
+<polyline fill="none" stroke="#000000" points="1187.1094,-521.252 1187.1094,-489.252 "/>
+<polyline fill="none" stroke="#000000" points="1187.1094,-521.252 1191.1094,-525.252 "/>
+<text text-anchor="middle" x="1037" y="-501.252" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.select_ocr_image</text>
+</g>
+<!-- t10&#45;&gt;t11 -->
+<g id="edge12" class="edge">
+<title>t10&#45;&gt;t11</title>
+<path fill="none" stroke="#0044a0" d="M984.2947,-557.0293C992.2846,-549.4832 1001.6851,-540.6049 1010.318,-532.4517"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="1012.7851,-534.9359 1017.6521,-525.5251 1007.9787,-529.8468 1012.7851,-534.9359"/>
+</g>
+<!-- t10&#45;&gt;t13 -->
+<g id="edge17" class="edge">
+<title>t10&#45;&gt;t13</title>
+<path fill="none" stroke="#0044a0" d="M836.5676,-557.2078C770.772,-547.9638 690.4915,-536.6847 622.8731,-527.1846"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="622.9531,-523.6616 612.5634,-525.7361 621.9792,-530.5935 622.9531,-523.6616"/>
+</g>
+<!-- t12 -->
+<g id="node13" class="node">
+<title>t12</title>
+<polygon fill="#00cc66" stroke="#000000" points="822.0996,-447.252 507.9004,-447.252 503.9004,-443.252 503.9004,-411.252 818.0996,-411.252 822.0996,-415.252 822.0996,-447.252"/>
+<polyline fill="none" stroke="#000000" points="818.0996,-443.252 503.9004,-443.252 "/>
+<polyline fill="none" stroke="#000000" points="818.0996,-443.252 818.0996,-411.252 "/>
+<polyline fill="none" stroke="#000000" points="818.0996,-443.252 822.0996,-447.252 "/>
+<text text-anchor="middle" x="663" y="-423.252" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.ocr_tesseract_hocr</text>
+</g>
+<!-- t11&#45;&gt;t12 -->
+<g id="edge13" class="edge">
+<title>t11&#45;&gt;t12</title>
+<path fill="none" stroke="#0044a0" d="M950.2568,-489.1612C893.2425,-477.2705 818.5749,-461.6981 759.6569,-449.4104"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="760.1,-445.9276 749.5961,-447.3122 758.6708,-452.7802 760.1,-445.9276"/>
+</g>
+<!-- t11&#45;&gt;t17 -->
+<g id="edge15" class="edge">
+<title>t11&#45;&gt;t17</title>
+<path fill="none" stroke="#0044a0" d="M1035.8403,-489.1612C1035.2388,-479.7779 1034.4904,-468.1019 1033.8144,-457.5566"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="1037.3033,-457.2705 1033.1707,-447.5149 1030.3177,-457.7184 1037.3033,-457.2705"/>
+</g>
+<!-- t15 -->
+<g id="node14" class="node">
+<title>t15</title>
+<polygon fill="#00cc66" stroke="#000000" points="1229.0433,-353.7123 920.9567,-353.7123 916.9567,-349.7123 916.9567,-317.7123 1225.0433,-317.7123 1229.0433,-321.7123 1229.0433,-353.7123"/>
+<polyline fill="none" stroke="#000000" points="1225.0433,-349.7123 916.9567,-349.7123 "/>
+<polyline fill="none" stroke="#000000" points="1225.0433,-349.7123 1225.0433,-317.7123 "/>
+<polyline fill="none" stroke="#000000" points="1225.0433,-349.7123 1229.0433,-353.7123 "/>
+<text text-anchor="middle" x="1073" y="-329.7123" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.render_hocr_page</text>
+</g>
+<!-- t12&#45;&gt;t15 -->
+<g id="edge14" class="edge">
+<title>t12&#45;&gt;t15</title>
+<path fill="none" stroke="#0044a0" d="M754.3855,-411.2269C799.2649,-402.117 854.0781,-390.6067 903,-379.252 933.2642,-372.2277 966.3927,-363.8908 995.3012,-356.4015"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="996.5416,-359.6955 1005.3389,-353.7914 994.7799,-352.9208 996.5416,-359.6955"/>
+</g>
+<!-- t16 -->
+<g id="node19" class="node">
+<title>t16</title>
+<polygon fill="#00cc66" stroke="#000000" points="651.9202,-270.1725 284.0798,-270.1725 280.0798,-266.1725 280.0798,-234.1725 647.9202,-234.1725 651.9202,-238.1725 651.9202,-270.1725"/>
+<polyline fill="none" stroke="#000000" points="647.9202,-266.1725 280.0798,-266.1725 "/>
+<polyline fill="none" stroke="#000000" points="647.9202,-266.1725 647.9202,-234.1725 "/>
+<polyline fill="none" stroke="#000000" points="647.9202,-266.1725 651.9202,-270.1725 "/>
+<text text-anchor="middle" x="466" y="-246.1725" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.render_hocr_debug_page</text>
+</g>
+<!-- t12&#45;&gt;t16 -->
+<g id="edge27" class="edge">
+<title>t12&#45;&gt;t16</title>
+<path fill="none" stroke="#0044a0" d="M772.353,-411.2135C825.7002,-401.3017 880.0px85,-389.0648 888,-379.252 912.2169,-349.0628 914.0433,-320.8011 888,-292.1725 871.9898,-274.5731 764.4698,-264.5473 661.9779,-258.9344"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="661.9319,-255.4271 651.7593,-258.3883 661.5583,-262.4171 661.9319,-255.4271"/>
+</g>
+<!-- t25 -->
+<g id="node27" class="node">
+<title>t25</title>
+<polygon fill="#efa03b" stroke="#000000" points="488.7205,-323.495 682,-296.1762 875.2795,-323.495 875.0991,-367.6976 488.9009,-367.6976 488.7205,-323.495"/>
+<polygon fill="none" stroke="#000000" points="484.7033,-320.0193 682,-292.1327 879.2967,-320.0193 879.0858,-371.7013 484.9142,-371.7013 484.7033,-320.0193"/>
+<text text-anchor="middle" x="682" y="-329.7123" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.merge_sidecars</text>
+</g>
+<!-- t12&#45;&gt;t25 -->
+<g id="edge52" class="edge">
+<title>t12&#45;&gt;t25</title>
+<path fill="none" stroke="#0044a0" d="M666.6634,-411.2166C668.3795,-402.768 670.5105,-392.2769 672.6326,-381.8293"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="676.09,-382.3905 674.6507,-371.8939 669.2301,-380.9971 676.09,-382.3905"/>
+</g>
+<!-- t18 -->
+<g id="node18" class="node">
+<title>t18</title>
+<polygon fill="#00cc66" stroke="#000000" points="1147.2989,-270.1725 856.7011,-270.1725 852.7011,-266.1725 852.7011,-234.1725 1143.2989,-234.1725 1147.2989,-238.1725 1147.2989,-270.1725"/>
+<polyline fill="none" stroke="#000000" points="1143.2989,-266.1725 852.7011,-266.1725 "/>
+<polyline fill="none" stroke="#000000" points="1143.2989,-266.1725 1143.2989,-234.1725 "/>
+<polyline fill="none" stroke="#000000" points="1143.2989,-266.1725 1147.2989,-270.1725 "/>
+<text text-anchor="middle" x="1000" y="-246.1725" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.combine_layers</text>
+</g>
+<!-- t15&#45;&gt;t18 -->
+<g id="edge24" class="edge">
+<title>t15&#45;&gt;t18</title>
+<path fill="none" stroke="#0044a0" d="M1057.1601,-317.5854C1047.0201,-305.9814 1033.7081,-290.7474 1022.4822,-277.9007"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="1025.0247,-275.4911 1015.809,-270.264 1019.7536,-280.0972 1025.0247,-275.4911"/>
+</g>
+<!-- t17&#45;&gt;t18 -->
+<g id="edge23" class="edge">
+<title>t17&#45;&gt;t18</title>
+<path fill="none" stroke="#0044a0" d="M1160.5767,-411.2248C1195.7121,-403.5317 1227.1378,-393.066 1238,-379.252 1261.9222,-348.8288 1262.9959,-321.72 1238,-292.1725 1231.6408,-284.6553 1197.8632,-277.2656 1157.6598,-270.9231"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="1158.0117,-267.4362 1147.596,-269.3761 1156.9481,-274.3549 1158.0117,-267.4362"/>
+</g>
+<!-- t17&#45;&gt;t25 -->
+<g id="edge51" class="edge">
+<title>t17&#45;&gt;t25</title>
+<path fill="none" stroke="#0044a0" d="M964.5165,-411.2166C925.304,-400.7368 874.3329,-387.1145 826.4989,-374.3305"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="827.2267,-370.9023 816.6621,-371.7016 825.4193,-377.6649 827.2267,-370.9023"/>
+</g>
+<!-- t13&#45;&gt;t14 -->
+<g id="edge21" class="edge">
+<title>t13&#45;&gt;t14</title>
+<path fill="none" stroke="#0044a0" d="M672.8683,-493.1993C736.8314,-488.6166 808.4777,-483.5937 874,-479.252 1033.5051,-468.6828 1073.5671,-468.8587 1233,-457.252 1285.8429,-453.4051 1343.3743,-448.7264 1395.4741,-444.3037"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="1395.81,-447.7879 1405.477,-443.4521 1395.2161,-440.8131 1395.81,-447.7879"/>
+</g>
+<!-- t13&#45;&gt;t16 -->
+<g id="edge26" class="edge">
+<title>t13&#45;&gt;t16</title>
+<path fill="none" stroke="#0044a0" d="M479.4495,-479.3529C478.2545,-457.9761 476.5497,-427.7492 475,-401.252 472.546,-359.2945 469.5914,-310.7019 467.754,-280.6981"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="471.2362,-280.2988 467.1306,-270.5318 464.2493,-280.7273 471.2362,-280.2988"/>
+</g>
+<!-- t13&#45;&gt;t19 -->
+<g id="edge29" class="edge">
+<title>t13&#45;&gt;t19</title>
+<path fill="none" stroke="#0044a0" d="M415.2907,-483.9551C385.6007,-473.4286 350.7427,-461.0699 321.6782,-450.7652"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="322.6542,-447.3978 312.0595,-447.3549 320.315,-453.9954 322.6542,-447.3978"/>
+</g>
+<!-- t14&#45;&gt;t18 -->
+<g id="edge25" class="edge">
+<title>t14&#45;&gt;t18</title>
+<path fill="none" stroke="#0044a0" d="M1519.9776,-405.138C1460.3688,-374.2505 1351.1978,-321.2463 1252,-292.1725 1221.8888,-283.3473 1189.1477,-276.3434 1157.5373,-270.8287"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="1157.7641,-267.3171 1147.3187,-269.0901 1156.59,-274.2179 1157.7641,-267.3171"/>
+</g>
+<!-- t22 -->
+<g id="node23" class="node">
+<title>t22</title>
+<polygon fill="#efa03b" stroke="#000000" points="489.918,-156.4263 735,-129.1169 980.082,-156.4263 979.8532,-200.6137 490.1468,-200.6137 489.918,-156.4263"/>
+<polygon fill="none" stroke="#000000" points="485.9027,-152.8467 735,-125.09 984.0973,-152.8467 983.8293,-204.6159 486.1707,-204.6159 485.9027,-152.8467"/>
+<text text-anchor="middle" x="735" y="-162.6394" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.merge_pages_ghostscript</text>
+</g>
+<!-- t18&#45;&gt;t22 -->
+<g id="edge35" class="edge">
+<title>t18&#45;&gt;t22</title>
+<path fill="none" stroke="#0044a0" d="M942.8252,-234.1499C918.2191,-226.3936 888.4232,-217.0013 859.1708,-207.7804"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="859.8692,-204.3309 849.2796,-204.6625 857.7647,-211.007 859.8692,-204.3309"/>
+</g>
+<!-- t18&#45;&gt;t24 -->
+<g id="edge39" class="edge">
+<title>t18&#45;&gt;t24</title>
+<path fill="none" stroke="#0044a0" d="M852.4716,-245.1051C747.4645,-239.0474 603.1919,-228.6387 477,-212.1725 463.5912,-210.4229 449.788,-208.4132 435.908,-206.238"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="436.2183,-202.7434 425.7921,-204.6263 435.1168,-209.6562 436.2183,-202.7434"/>
+</g>
+<!-- t18&#45;&gt;t23 -->
+<g id="edge44" class="edge">
+<title>t18&#45;&gt;t23</title>
+<path fill="none" stroke="#0044a0" d="M1047.0344,-234.1499C1066.9243,-226.5285 1090.9364,-217.3275 1114.596,-208.2617"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="1115.9033,-211.509 1123.9889,-204.6625 1113.3986,-204.9724 1115.9033,-211.509"/>
+</g>
+<!-- t16&#45;&gt;t22 -->
+<g id="edge36" class="edge">
+<title>t16&#45;&gt;t22</title>
+<path fill="none" stroke="#0044a0" d="M524.0378,-234.1499C549.1239,-226.3599 579.5241,-216.9196 609.3422,-207.6602"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="610.4833,-210.9707 618.9955,-204.6625 608.4073,-204.2857 610.4833,-210.9707"/>
+</g>
+<!-- t16&#45;&gt;t24 -->
+<g id="edge40" class="edge">
+<title>t16&#45;&gt;t24</title>
+<path fill="none" stroke="#0044a0" d="M417.6711,-234.1499C397.2337,-226.5285 372.5607,-217.3275 348.2499,-208.2617"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="349.1912,-204.8773 338.5986,-204.6625 346.7453,-211.4361 349.1912,-204.8773"/>
+</g>
+<!-- t16&#45;&gt;t23 -->
+<g id="edge45" class="edge">
+<title>t16&#45;&gt;t23</title>
+<path fill="none" stroke="#0044a0" d="M651.7596,-235.3105C656.5547,-234.9215 661.308,-234.5415 666,-234.1725 811.2137,-222.7545 848.5512,-230.9322 993,-212.1725 1006.176,-210.4614 1019.7432,-208.4558 1033.3753,-206.2619"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="1034.0068,-209.7051 1043.3083,-204.6325 1032.8736,-202.7974 1034.0068,-209.7051"/>
+</g>
+<!-- t21&#45;&gt;t22 -->
+<g id="edge32" class="edge">
+<title>t21&#45;&gt;t22</title>
+<path fill="none" stroke="#0044a0" d="M1165.0941,-235.3973C1085.9035,-224.7541 997.501,-212.8552 993,-212.1725 980.474,-210.2728 967.615,-208.2703 954.6442,-206.2099"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="955.1339,-202.7439 944.7072,-204.6238 954.0305,-209.6564 955.1339,-202.7439"/>
+</g>
+<!-- t21&#45;&gt;t24 -->
+<g id="edge37" class="edge">
+<title>t21&#45;&gt;t24</title>
+<path fill="none" stroke="#0044a0" d="M1165.2215,-234.9906C1162.1187,-234.699 1159.041,-234.4254 1156,-234.1725 855.1023,-209.1529 777.1841,-244.6523 477,-212.1725 462.026,-210.5524 446.5737,-208.5164 431.0798,-206.2151"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="431.3094,-202.7099 420.8968,-204.6663 430.2567,-209.6303 431.3094,-202.7099"/>
+</g>
+<!-- t21&#45;&gt;t23 -->
+<g id="edge42" class="edge">
+<title>t21&#45;&gt;t23</title>
+<path fill="none" stroke="#0044a0" d="M1274.3771,-234.0471C1268.8557,-227.6412 1262.3807,-220.0px91 1255.8248,-212.5231"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="1258.4543,-210.2128 1249.2743,-204.9233 1253.152,-214.783 1258.4543,-210.2128"/>
+</g>
+<!-- t19&#45;&gt;t22 -->
+<g id="edge34" class="edge">
+<title>t19&#45;&gt;t22</title>
+<path fill="none" stroke="#0044a0" d="M260.6159,-410.9505C259.8316,-364.871 259.0249,-246.8273 271,-234.1725 302.6435,-200.7331 431.3919,-218.4498 477,-212.1725 490.4888,-210.316 504.3558,-208.2974 518.3278,-206.1801"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="519.1602,-209.5936 528.5161,-204.6219 518.1019,-202.6741 519.1602,-209.5936"/>
+</g>
+<!-- t19&#45;&gt;t24 -->
+<g id="edge38" class="edge">
+<title>t19&#45;&gt;t24</title>
+<path fill="none" stroke="#0044a0" d="M259.0498,-411.2136C258.0595,-401.7112 256.8826,-389.8585 256,-379.252 251.2976,-322.7418 247.1648,-257.5963 244.6312,-214.9019"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="248.1192,-214.5935 244.0377,-204.8165 241.1313,-215.0048 248.1192,-214.5935"/>
+</g>
+<!-- t19&#45;&gt;t23 -->
+<g id="edge43" class="edge">
+<title>t19&#45;&gt;t23</title>
+<path fill="none" stroke="#0044a0" d="M282.1528,-411.0561C318.8331,-380.6455 397.8323,-320.0855 476,-292.1725 553.979,-264.3269 579.2078,-283.062 661,-270.1725 742.8817,-257.269 762.3086,-248.2304 844,-234.1725 909.9705,-222.82 927.0119,-223.4221 993,-212.1725 1003.5851,-210.368 1014.439,-208.4601 1025.3874,-206.4907"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="1026.2474,-209.892 1035.4637,-204.666 1025,-203.004 1026.2474,-209.892"/>
+</g>
+<!-- t19&#45;&gt;t25 -->
+<g id="edge50" class="edge">
+<title>t19&#45;&gt;t25</title>
+<path fill="none" stroke="#0044a0" d="M342.173,-411.2166C389.8324,-400.6274 451.9326,-386.8297 509.989,-373.9305"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="511.0179,-377.2873 520.0207,-371.7016 509.4996,-370.4539 511.0179,-377.2873"/>
+</g>
+<!-- t20&#45;&gt;t22 -->
+<g id="edge33" class="edge">
+<title>t20&#45;&gt;t22</title>
+<path fill="none" stroke="#0044a0" d="M323.4472,-984.1943C198.6099,-964.2959 37,-926.6746 37,-865.252 37,-865.252 37,-865.252 37,-429.252 37,-211.1917 260.8906,-241.2767 477,-212.1725 490.808,-210.313 505.0108,-208.2741 519.3157,-206.1255"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="519.8697,-209.5816 529.2317,-204.6214 518.8199,-202.6608 519.8697,-209.5816"/>
+</g>
+<!-- t26 -->
+<g id="node26" class="node">
+<title>t26</title>
+<polygon fill="#efa03b" stroke="#000000" points="568.0652,-47.332 735,-20.0049 901.9348,-47.332 901.779,-91.5483 568.221,-91.5483 568.0652,-47.332"/>
+<polygon fill="none" stroke="#000000" points="564.0538,-43.9306 735,-15.9468 905.9462,-43.9306 905.7643,-95.5532 564.2357,-95.5532 564.0538,-43.9306"/>
+<text text-anchor="middle" x="735" y="-53.5531" font-family="Times,serif" font-size="20.00" fill="#000000">ocrmypdf.pipeline.copy_final</text>
+</g>
+<!-- t22&#45;&gt;t26 -->
+<g id="edge49" class="edge">
+<title>t22&#45;&gt;t26</title>
+<path fill="none" stroke="#0044a0" d="M735,-124.8984C735,-118.6708 735,-112.2475 735,-105.9711"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="738.5001,-105.6074 735,-95.6074 731.5001,-105.6075 738.5001,-105.6074"/>
+</g>
+<!-- t24&#45;&gt;t26 -->
+<g id="edge47" class="edge">
+<title>t24&#45;&gt;t26</title>
+<path fill="none" stroke="#0044a0" d="M368.6395,-140.6178C427.4047,-127.6148 498.1821,-111.9539 561.7955,-97.8781"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="562.9329,-101.2112 571.9406,-95.6333 561.4205,-94.3765 562.9329,-101.2112"/>
+</g>
+<!-- t23&#45;&gt;t26 -->
+<g id="edge48" class="edge">
+<title>t23&#45;&gt;t26</title>
+<path fill="none" stroke="#0044a0" d="M1095.1818,-140.9007C1037.3475,-127.8387 967.4279,-112.0473 904.6388,-97.8663"/>
+<polygon fill="#0044a0" stroke="#0044a0" points="905.1511,-94.3939 894.6256,-95.6048 903.6089,-101.2219 905.1511,-94.3939"/>
+</g>
+</g>
+</svg>

docs/plugins.rst

@@ -1,208 +0,0 @@
-=======
-Plugins
-=======
-
-    The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
-    NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED",  "MAY", and
-    "OPTIONAL" in this document are to be interpreted as described in
-    RFC 2119.
-
-You can use plugins to customize the behavior of OCRmyPDF at certain points of
-interest.
-
-Currently, it is possible to:
-
-- add new command line arguments
-- override the decision for whether or not to perform OCR on a particular file
-- modify the image is about to be sent for OCR
-- modify the page image before it is converted to PDF
-- replace the Tesseract OCR with another OCR engine that has similar behavior
-- replace Ghostscript with another PDF to image converter (rasterizer) or
-  PDF/A generator
-
-OCRmyPDF plugins are based on the Python ``pluggy`` package and conform to its
-conventions. Note that: plugins installed with as setuptools entrypoints are
-not checked currently, because OCRmyPDF assumes you may not want to enable
-plugins for all files.
-
-Script plugins
-==============
-
-Script plugins may be called from the command line, by specifying the name of a file.
-Script plugins may be convenient for informal or "one-off" plugins, when a certain
-batch of files needs a special processing step for example.
-
-.. code-block:: bash
-
-    ocrmypdf --plugin ocrmypdf_example_plugin.py input.pdf output.pdf
-
-Multiple plugins may be installed by issuing the ``--plugin`` argument multiple times.
-
-Packaged plugins
-================
-
-Installed plugins may be installed into the same virtual environment as OCRmyPDF
-is installed into. They may be invoked using Python standard module naming.
-If you are intending to distribute a plugin, please package it.
-
-.. code-block:: bash
-
-    ocrmypdf --plugin ocrmypdf_fancypants.pockets.contents input.pdf output.pdf
-
-OCRmyPDF does not automatically import plugins, because the assumption is that
-plugins affect different files differently and you may not want them activated
-all the time. The command line or ``ocrmypdf.ocr(plugin='...')`` must call
-for them.
-
-Third parties that wish to distribute packages for ocrmypdf should package them
-as packaged plugins, and these modules should begin with the name ``ocrmypdf_``
-similar to ``pytest`` packages such as ``pytest-cov`` (the package) and
-``pytest_cov`` (the module).
-
-.. note::
-
-    We recommend plugin authors name their plugins with the prefix
-    ``ocrmypdf-`` (for the package name on PyPI) and ``ocrmypdf_`` (for the
-    module), just like pytest plugins. At the same time, please make it clear
-    that your package is not official.
-
-Setuptools plugins
-==================
-
-You can also create a plugin that OCRmyPDF will always automatically load if both are
-installed in the same virtual environment, using a setuptools entrypoint.
-
-Your package's ``setup.py`` would need to contain the following, for a plugin
-named ``ocrmypdf-exampleplugin``:
-
-.. code-block:: python
-
-    # sample ./setup.py file
-    from setuptools import setup
-
-    setup(
-        name="ocrmypdf-exampleplugin",
-        packages=["exampleplugin"],
-        # the following makes a plugin available to pytest
-        entry_points={"ocrmypdf": ["exampleplugin = exampleplugin.pluginmodule"]},
-    )
-
-.. code-block:: ini
-
-    # equivalent setup.cfg
-    [options.entry_points]
-    ocrmypdf =
-        exampleplugin = exampleplugin.pluginmodule
-
-Plugin requirements
-===================
-
-OCRmyPDF generally uses multiple worker processes. When a new worker is started,
-Python will import all plugins again, including all plugins that were imported earlier.
-This means that the global state of a plugin in one worker will not be shared with
-other workers. As such, plugin hook implementations should be stateless, relying
-only on their inputs. Hook implementations may use their input parameters to
-to obtain a reference to shared state prepared by another hook implementation.
-Plugins must expect that other instances of the plugin will be running
-simultaneously.
-
-The ``context`` object that is passed to many hooks can be used to share information
-about a file being worked on. Plugins must write private, plugin-specific data to
-a subfolder named ``{options.work_folder}/ocrmypdf-plugin-name``. Plugins MAY
-read and write files in ``options.work_folder``, but should be aware that their
-semantics are subject to change.
-
-OCRmyPDF will delete ``options.work_folder`` when it has finished OCRing
-a file, unless invoked with ``--keep-temporary-files``.
-
-The documentation for some plugin hooks contain a detailed description of the
-execution context in which they will be called.
-
-Plugins should be prepared to work whether executed in worker threads or worker
-processes. Generally, OCRmyPDF uses processes, but has a semi-hidden threaded
-argument that simplifies debugging.
-
-
-Plugin hooks
-============
-
-A plugin may provide the following hooks. Hooks must be decorated with
-``ocrmypdf.hookimpl``, for example:
-
-.. code-block:: python
-
-    from ocrmpydf import hookimpl
-
-    @hookimpl
-    def add_options(parser):
-        pass
-
-The following is a complete list of hooks that are available, and when
-they are called.
-
-.. _firstresult:
-
-**Note on firstresult hooks**
-
-If multiple plugins install implementations for this hook, they will be called in
-the reverse of the order in which they are installed (i.e., last plugin wins).
-When each hook implementation is called in order, the first implementation that
-returns a value other than ``None`` will "win" and prevent execution of all other
-hooks. As such, you cannot "chain" a series of plugin filters together in this
-way. Instead, a single hook implementation should be responsible for any such
-chaining operations.
-
-Custom command line arguments
------------------------------
-
-.. autofunction:: ocrmypdf.pluginspec.add_options
-
-.. autofunction:: ocrmypdf.pluginspec.check_options
-
-Execution and progress reporting
---------------------------------
-
-.. autoclass: ocrmypdf.pluginspec.Executor
-    :members:
-
-.. autofunction:: ocrmypdf.pluginspec.get_logging_console
-
-.. autofunction:: ocrmypdf.pluginspec.get_executor
-
-.. autofunction:: ocrmypdf.pluginspec.get_progressbar_class
-
-Applying special behavior before processing
--------------------------------------------
-
-.. autofunction:: ocrmypdf.pluginspec.validate
-
-PDF page to image
------------------
-
-.. autofunction:: ocrmypdf.pluginspec.rasterize_pdf_page
-
-Modifying intermediate images
------------------------------
-
-.. autofunction:: ocrmypdf.pluginspec.filter_ocr_image
-
-.. autofunction:: ocrmypdf.pluginspec.filter_page_image
-
-.. autofunction:: ocrmypdf.pluginspec.filter_pdf_page
-
-OCR engine
-----------
-
-.. autofunction:: ocrmypdf.pluginspec.get_ocr_engine
-
-.. autoclass:: ocrmypdf.pluginspec.OcrEngine
-    :members:
-
-    .. automethod:: __str__
-
-.. autoclass:: ocrmypdf.pluginspec.OrientationConfidence
-
-PDF/A production
-----------------
-
-.. autofunction:: ocrmypdf.pluginspec.generate_pdfa

docs/security.rst

@@ -0,0 +1,79 @@
+PDF security issues
+===================
+
+	OCRmyPDF should only be used on PDFs you trust. It is not designed to protect you against malware. 
+
+Recognizing that many users have an interest in handling PDFs and applying OCR to PDFs they did not generate themselves, this article discusses the security implications of PDFs and how users can protect themselves.
+
+The disclaimer applies: this software has no warranties of any kind.
+
+PDFs may contain malware
+------------------------
+
+PDF is a rich, complex file format. The official PDF 1.7 specification, ISO 32000:2008, is hundreds of pages long and references several annexes each of which are similar in length. PDFs can contain video, audio, XML, JavaScript and other programming, and forms. In some cases, they can open internet connections to pre-selected URLs. All of these possible attack vectors.
+
+In short, PDFs `may contain viruses <https://security.stackexchange.com/questions/64052/can-a-pdf-file-contain-a-virus>`_.
+
+This `article <https://theinvisiblethings.blogspot.ca/2013/02/converting-untrusted-pdfs-into-trusted.html>`_ describes a high-paranoia method which allows potentially hostile PDFs to be viewed and rasterized safely in a disposable virtual machine. A trusted PDF created in this manner is converted to images and loses all information making it searchable and losing all compression. OCRmyPDF could be used restore searchability.
+
+How OCRmyPDF processes PDFs
+---------------------------
+
+OCRmyPDF must open and interpret your PDF in order to insert an OCR layer. First, it runs all PDFs through `qpdf <https://github.com/qpdf/qpdf>`_, a program that repairs PDFs with syntax errors. This is done because, in the author's experience, a significant number of PDFs in the wild especially those created by scanners are not well-formed files. qpdf makes it more likely that OCRmyPDF will succeed, but offers no security guarantees. qpdf is also used to split the PDF into single page PDFs.
+
+After qpdf, OCRmyPDF examines each page using `PyPDF2 <https://github.com/mstamy2/PyPDF2>`_. This library also has no warranties or guarantees. OCRmyPDF works with qpdf 5.0 and up, but version 7.0 is recommended because of known security vulnerabilities in early versions.
+
+Finally, OCRmyPDF rasterizes each page of the PDF using `Ghostscript <http://ghostscript.com/>`_ in ``-dSAFER`` mode.
+
+Depending on the options specified, OCRmyPDF may graft the OCR layer into the existing PDF or it may essentially reconstruct ("re-fry") a visually identical PDF that may be quite different at the binary level. That said, OCRmyPDF is not a tool designed for sanitizing PDFs.
+
+Using OCRmyPDF online or as a service
+-------------------------------------
+
+OCRmyPDF should not be deployed as a public-facing service, such as a website where a potential attacker could upload a PDF of their choice for OCR. OCRmyPDF is not designed to be secure against PDF malware. Another concern is PDFs specifically designed to be a denial of service attack: PDFs can contain recursive data structures that sometimes send parsers into infinite loops, and issue complex graphics drawing commands.
+
+Setting aside these concerns, a side effect of OCRmyPDF is it may incidentally sanitize PDFs that contain malware. It runs ``qpdf`` to repair the PDF, which could correct malformed PDF structures that are part of an attack. When PDF/A output is selected (the default), the input PDF is partially reconstructed by Ghostscript. When ``--force-ocr`` is used, all pages are rasterized and reconverted to PDF, which could remove malware in embedded images. No guarantees.
+
+OCRmyPDF should be relatively safe to use in a trusted intranet, with some considerations:
+
+Limiting CPU usage
+^^^^^^^^^^^^^^^^^^
+
+OCRmyPDF will attempt to use all available CPUs and storage, so executing ``nice ocrmypdf`` or limiting the number of jobs with the ``-j`` argument may ensure the server remains available. Another option would be run OCRmyPDF jobs inside a Docker container, a virtual machine, or a cloud instance, which can impose its own limits on CPU usage and be terminated "from orbit" if it fails to complete.
+
+Temporary storage requirements
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+OCRmyPDF will use a large amount of temporary storage for its work, proportional to the total number of pixels needed to rasterize the PDF. The raster image of a 8.5×11" color page at 300 DPI takes 25 MB uncompressed; OCRmyPDF saves its intermediates as PNG, but that still means it requires about 9 MB per intermediate based on average compression ratios. Multiple intermediates per page are also required, depending on the command line given. A rule of thumb would be to allow 100 MB of temporary storage per page in a file – meaning that a small cloud servers or small VM partitions should be provisioned with plenty of extra space, if say, a 500 page file might be sent.
+
+To check temporary storage usage on actual files, run ``ocrmypdf -k ...`` which will preserve and print the path to temporary storage when the job is done.
+
+To change where temporary files are stored, change the ``TMPDIR`` environment variable for ocrmypdf's environment. (Python's ``tempfile.gettempdir()`` returns the root directory in which temporary files will be stored.) For example, one could redirect ``TMPDIR`` to a large RAM disk to avoid wear on HDD/SSD and potentially improve performance. On Amazon Web Services, ``TMPDIR`` can be set to `empheral storage <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html>`_.
+
+Timeouts
+^^^^^^^^
+
+To prevent excessively long OCR jobs consider setting ``--tesseract-timeout`` and/or ``--skip-big`` arguments. ``--skip-big`` is particularly helpful if your PDFs include documents such as reports on standard page sizes with large images attached - often large images are not worth OCR'ing anyway.
+
+Commercial alternatives
+^^^^^^^^^^^^^^^^^^^^^^^
+
+The author also provides professional services that include OCR and building databases around PDFs, and is happy to provide consultation.
+
+Abbyy Cloud OCR is a viable commercial alternative with a web services API. 
+
+
+Password protection, digital signatures and certification
+---------------------------------------------------------
+
+Password protected PDFs usually have two passwords, and owner and user password. When the user password is set to empty, PDF readers will open the file automatically and marked it as "(SECURED)". While not as reliable as a digital signature, this indicates that whoever set the password approved of the file at that time. When the user password is set, the document cannot be viewed without the password. 
+
+Either way, OCRmyPDF does not remove passwords from PDFs and exits with an error on encountering them.
+
+``qpdf``, one of OCRmyPDF's dependencies, can remove passwords. If the owner and user password are set, a password is required for ``qpdf``. If only the owner password is set, then the password can be stripped, even if one does not have the owner password.
+
+After OCR is applied, password protection is not permitted on PDF/A documents but the file can be converted to regular PDF.
+
+Many programs exist which are capable of inserting an image of someone's signature. On its own, this offers no security guarantees. It is trivial to remove the signature image and apply it to other files. This practice offers no real security.
+
+Important documents can be digitally signed and certified to attest to their authorship. OCRmyPDF cannot do this. Open source tools such as pdfbox (Java) have this capability as does Adobe Acrobat. 

misc/batch.py

@@ -1,68 +0,0 @@
-#!/usr/bin/env python3
-# Copyright 2016 findingorder: https://github.com/findingorder
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
-# This script must be edited to meet your needs.
-
-import logging
-import os
-import sys
-
-import ocrmypdf
-
-# pylint: disable=logging-format-interpolation
-# pylint: disable=logging-not-lazy
-
-script_dir = os.path.dirname(os.path.realpath(__file__))
-print(script_dir + '/batch.py: Start')
-
-if len(sys.argv) > 1:
-    start_dir = sys.argv[1]
-else:
-    start_dir = '.'
-
-if len(sys.argv) > 2:
-    log_file = sys.argv[2]
-else:
-    log_file = script_dir + '/ocr-tree.log'
-
-logging.basicConfig(
-    level=logging.INFO,
-    format='%(asctime)s %(message)s',
-    filename=log_file,
-    filemode='w',
-)
-
-ocrmypdf.configure_logging(ocrmypdf.Verbosity.default)
-
-for dir_name, subdirs, file_list in os.walk(start_dir):
-    logging.info(dir_name + '\n')
-    os.chdir(dir_name)
-    for filename in file_list:
-        file_ext = os.path.splitext(filename)[1]
-        if file_ext == '.pdf':
-            full_path = dir_name + '/' + filename
-            print(full_path)
-            result = ocrmypdf.ocr(filename, filename, deskew=True)
-            if result == ocrmypdf.ExitCode.already_done_ocr:
-                print("Skipped document because it already contained text")
-            elif result == ocrmypdf.ExitCode.ok:
-                print("OCR complete")
-            logging.info(result)

misc/completion/ocrmypdf.bash

@@ -1,120 +0,0 @@
-# ocrmypdf completion                                     -*- shell-script -*-
-
-# Copyright 2019 Frank Pille
-# Copyright 2020 Alex Willner
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
-set -o errexit
-
-_ocrmypdf()
-{
-    local cur prev cword words split
-
-    # Homebrew on Macs have version 1.3 of bash-completion which doesn't include - see #502
-    if declare -F _init_completions >/dev/null 2>&1; then
-        _init_completion -s || return
-    else
-        COMPREPLY=()
-        _get_comp_words_by_ref cur prev words cword
-    fi
-
-    if [[ $cur == -* ]]; then
-        COMPREPLY=( $( compgen -W '--language --image-dpi --output-type
-            --sidecar --version --jobs --quiet --verbose --title --author
-            --subject --keywords --rotate-pages --remove-background --deskew
-            --clean --clean-final --unpaper-args --oversample --remove-vectors
-            --threshold --force-ocr --skip-text --redo-ocr
-            --skip-big --jpeg-quality --png-quality --jbig2-lossy
-            --max-image-mpixels --tesseract-config --tesseract-pagesegmode
-            --help --tesseract-oem --pdf-renderer --tesseract-timeout
-            --rotate-pages-threshold --pdfa-image-compression --user-words
-            --user-patterns --keep-temporary-files --output-type
-            --no-progress-bar --pages --fast-web-view' \
-            --  "$cur" ) )
-        return
-    else
-        _filedir
-        return
-    fi
-
-    case $prev in
-        --version|-h|--help)
-            return
-            ;;
-        --user-words|--user-patterns|--tesseract-config)
-            _filedir
-            return
-            ;;
-        --output-type)
-            COMPREPLY=( $( compgen -W 'pdfa pdf pdfa-1 pdfa-2 pdfa-3' -- \
-                "$cur" ) )
-            return
-            ;;
-        --pdf-renderer)
-            COMPREPLY=( $( compgen -W 'auto hocr sandwich' -- "$cur" ) )
-            return
-            ;;
-        --pdfa-image-compression)
-            COMPREPLY=( $( compgen -W 'auto jpeg lossless' -- "$cur" ) )
-            return
-            ;;
-        -O|--optimize|--tesseract-oem)
-            COMPREPLY=( $( compgen -W '{0..3}' -- "$cur" ) )
-            return
-            ;;
-        --jpeg-quality|--png-quality)
-            COMPREPLY=( $( compgen -W '{0..100}' -- "$cur" ) )
-            return
-            ;;
-        -l|--language)
-            COMPREPLY=$( command tesseract --list-langs 2>/dev/null )
-            COMPREPLY=( $( compgen -W '${COMPREPLY[@]##*:}' -- "$cur" ) )
-            return
-            ;;
-        --image-dpi|--oversample|--skip-big|--max-image-mpixels|\
-        --tesseract-timeout|--rotate-pages-threshold)
-            COMPREPLY=( $( compgen -P "$cur" -W '{0..9}' ) )
-            return
-            ;;
-        -j|--jobs)
-            COMPREPLY=( $( compgen -W '{1..'$( _ncpus )'}' -- "$cur" ) )
-            return
-            ;;
-        -v|--verbose)
-            COMPREPLY=( $( compgen -W '{0..2}' -- "$cur" ) ) # max level ?
-            return
-            ;;
-        --tesseract-pagesegmode)
-            COMPREPLY=( $( compgen -W '{1..13}' -- "$cur" ) )
-            return
-            ;;
-        --sidecar|--title|--author|--subject|--keywords|--unpaper-args|--pages|--fast-web-view)
-            # argument required but no completions available
-            return
-            ;;
-    esac
-
-    $split && return
-} &&
-complete -F _ocrmypdf ocrmypdf
-
-set +o errexit
-
-# ex: filetype=sh

misc/completion/ocrmypdf.fish

@@ -1,139 +0,0 @@
-# Copyright 2020 James R. Barlow
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
-complete -c ocrmypdf -x -n '__fish_is_first_arg' -l version
-complete -c ocrmypdf -x -n '__fish_is_first_arg' -s h -s "?" -l help
-
-complete -c ocrmypdf -r -l sidecar -d "write OCR to text file"
-complete -c ocrmypdf -x -s q -l quiet
-
-complete -c ocrmypdf -s r -l rotate-pages -d "rotate pages to correct orientation"
-complete -c ocrmypdf -s d -l deskew -d "fix small horizontal alignment skew"
-complete -c ocrmypdf -s c -l clean -d "clean document images before OCR"
-complete -c ocrmypdf -s i -l clean-final -d "clean document images and keep result"
-complete -c ocrmypdf -l remove-vectors -d "don't send vector objects to OCR"
-complete -c ocrmypdf -l threshold -d "threshold images before OCR"
-
-complete -c ocrmypdf -s f -l force-ocr -d "OCR documents that already have printable text"
-complete -c ocrmypdf -s s -l skip-ocr -d "skip OCR on pages that text, otherwise try OCR"
-complete -c ocrmypdf -l redo-ocr -d "redo OCR on any pages that seem to have OCR already"
-
-complete -c ocrmypdf -s k -l keep-temporary-files -d "keep temporary files (debug)"
-
-function __fish_ocrmypdf_languages
-    set langs (tesseract --list-langs ^/dev/null)
-    set arr (string split '\n' $langs)
-    for lang in $arr[2..-1]
-        echo $lang
-    end
-end
-complete -c ocrmypdf -x -s l -l language -a '(__fish_ocrmypdf_languages)' -d "language"
-
-complete -c ocrmypdf -x -l image-dpi -d "assume this DPI if input image DPI is unknown"
-
-function __fish_ocrmypdf_output_type
-    echo -e "pdfa\t"(_ "output a PDF/A (default)")
-    echo -e "pdf\t"(_ "output a standard PDF")
-    echo -e "pdfa-1\t"(_ "output a PDF/A-1b")
-    echo -e "pdfa-2\t"(_ "output a PDF/A-2b")
-    echo -e "pdfa-3\t"(_ "output a PDF/A-3b")
-end
-complete -c ocrmypdf -x -l output-type -a '(__fish_ocrmypdf_output_type)' -d "select PDF output options"
-
-function __fish_ocrmypdf_pdf_renderer
-    echo -e "auto\t"(_ "auto select PDF renderer")
-    echo -e "hocr\t"(_ "use hOCR renderer")
-    echo -e "hocrdebug\t"(_ "uses hOCR renderer in debug mode, showing recognized text")
-    echo -e "sandwich\t"(_ "use sandwich renderer")
-end
-complete -c ocrmypdf -x -l pdf-renderer -a '(__fish_ocrmypdf_pdf_renderer)' -d "select PDF renderer options"
-
-function __fish_ocrmypdf_optimize
-    echo -e "0\t"(_ "do not optimize")
-    echo -e "1\t"(_ "do safe, lossless optimizations (default)")
-    echo -e "2\t"(_ "do some lossy optimizations")
-    echo -e "3\t"(_ "do aggressive lossy optimizations (including lossy JBIG2)")
-end
-complete -c ocrmypdf -x -s O -l optimize -a '(__fish_ocrmypdf_optimize)' -d "select optimization level"
-
-function __fish_ocrmypdf_verbose
-    echo -e "0\t"(_ "standard output messages")
-    echo -e "1\t"(_ "troubleshooting output messages")
-    echo -e "2\t"(_ "debugging output messages")
-end
-complete -c ocrmypdf -x -s v -l verbose -a '(__fish_ocrmypdf_verbose)' -d "set verbosity level"
-
-complete -c ocrmypdf -x -l no-progress-bar -d "disable the progress bar"
-
-function __fish_ocrmypdf_pdfa_compression
-    echo -e "auto\t"(_ "let Ghostscript decide how to compress images")
-    echo -e "jpeg\t"(_ "convert color and grayscale images to JPEG")
-    echo -e "lossless\t"(_ "convert color and grayscale images to lossless (PNG)")
-end
-complete -c ocrmypdf -x -l pdfa-image-compression -a '(__fish_ocrmypdf_pdfa_compression)' -d "set PDF/A image compression options"
-
-complete -c ocrmypdf -x -s j -l jobs -d "how many worker processes to use"
-complete -c ocrmypdf -x -l title -d "set metadata"
-complete -c ocrmypdf -x -l author -d "set metadata"
-complete -c ocrmypdf -x -l subject -d "set metadata"
-complete -c ocrmypdf -x -l keywords -d "set metadata"
-complete -c ocrmypdf -x -l oversample -d "oversample images to this DPI"
-complete -c ocrmypdf -x -l skip-big -d "skip OCR on pages larger than this many MPixels"
-
-complete -c ocrmypdf -x -l jpeg-quality -d "JPEG quality [0..100]"
-complete -c ocrmypdf -x -l png-quality -d "PNG quality [0..100]"
-complete -c ocrmypdf -x -l jbig2-lossy -d "enable lossy JBIG2 (see docs)"
-complete -c ocrmypdf -x -l max-image-mpixels -d "image decompression bomb threshold"
-complete -c ocrmypdf -x -l pages -d "apply OCR to only the specified pages"
-complete -c ocrmypdf -x -l tesseract-config -d "set custom tesseract config file"
-
-function __fish_ocrmypdf_tesseract_pagesegmode
-  echo -e "0\t"(_ "orientation and script detection (OSD) only")
-  echo -e "1\t"(_ "automatic page segmentation with OSD")
-  echo -e "2\t"(_ "automatic page segmentation, but no OSD, or OCR")
-  echo -e "3\t"(_ "fully automatic page segmentation, but no OSD (default)")
-  echo -e "4\t"(_ "assume a single column of text of variable sizes")
-  echo -e "5\t"(_ "assume a single uniform block of vertically aligned text")
-  echo -e "6\t"(_ "assume a single uniform block of text")
-  echo -e "7\t"(_ "treat the image as a single text line")
-  echo -e "8\t"(_ "treat the image as a single word")
-  echo -e "9\t"(_ "treat the image as a single word in a circle")
-  echo -e "10\t"(_ "treat the image as a single character")
-  echo -e "11\t"(_ "sparse text - find as much text as possible in no particular order")
-  echo -e "12\t"(_ "sparse text with OSD")
-  echo -e "13\t"(_ "raw line - treat the image as a single text line")
-end
-complete -c ocrmypdf -x -l tesseract-pagesegmode -a '(__fish_ocrmypdf_tesseract_pagesegmode)' -d "set tesseract --psm"
-
-function __fish_ocrmypdf_tesseract_oem
-    echo -e "0\t"(_ "legacy engine only")
-    echo -e "1\t"(_ "neural nets LSTM engine only")
-    echo -e "2\t"(_ "legacy + LSTM engines")
-    echo -e "3\t"(_ "default, based on what is available")
-end
-complete -c ocrmypdf -x -l tesseract-oem -a '(__fish_ocrmypdf_tesseract_oem)' -d "set tesseract --oem"
-complete -c ocrmypdf -x -l tesseract-timeout -d "maximum number of seconds to wait for OCR"
-complete -c ocrmypdf -x -l rotate-pages-threshold -d "page rotation confidence"
-
-complete -c ocrmypdf -r -l user-words -d "specify location of user words file"
-complete -c ocrmypdf -r -l user-patterns -d "specify location of user patterns file"
-complete -c ocrmypdf -x -l fast-web-view -d "if file size if above this amount in MB, linearize PDF"
-
-complete -c ocrmypdf -x -a "(__fish_complete_suffix .pdf; __fish_complete_suffix .PDF; __fish_complete_suffix .jpg; __fish_complete_suffix .png)"

misc/docker-compose.example.yml

@@ -1,15 +0,0 @@
----
-version: "3.3"
-services:
-  ocrmypdf:
-    restart: always
-    container_name: ocrmypdf
-    image: jbarlow83/ocrmypdf
-    volumes:
-      - "/media/scan:/input"
-      - "/mnt/scan:/output"
-    environment:
-      - OCR_OUTPUT_DIRECTORY_YEAR_MONTH=0
-    user: "<SET TO YOUR USER ID>:<SET TO YOUR GROUP ID>"
-    entrypoint: python3
-    command: watcher.py

misc/example_plugin.py

@@ -1,84 +0,0 @@
-# © 2020 James R Barlow: https://github.com/jbarlow83
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
-"""
-An example of an OCRmyPDF plugin.
-
-This plugin adds two new command line arguments
-    --grayscale-ocr: converts the image to grayscale before performing OCR on it
-        (This is occasionally useful for images whose color confounds OCR. It only
-        affects the image shown to OCR. The image is not saved.)
-    --mono-page: converts pages all pages in the output file to black and white
-
-To use this from the command line:
-    ocrmypdf --plugin path/to/example_plugin.py --mono-page input.pdf output.pdf
-
-To use this as an API:
-    import ocrmypdf
-    ocrmypdf.ocr('input.pdf', 'output.pdf',
-        plugins=['path/to/example_plugin.py'], mono_page=True
-    )
-"""
-
-import logging
-
-from PIL import Image
-
-from ocrmypdf import hookimpl
-
-log = logging.getLogger(__name__)
-
-
-@hookimpl
-def add_options(parser):
-    parser.add_argument('--grayscale-ocr', action='store_true')
-    parser.add_argument('--mono-page', action='store_true')
-
-
-@hookimpl
-def prepare(options):
-    pass
-
-
-@hookimpl
-def validate(pdfinfo, options):
-    pass
-
-
-@hookimpl
-def filter_ocr_image(page, image):
-    if page.options.grayscale_ocr:
-        log.info("graying")
-        return image.convert('L')
-    return image
-
-
-@hookimpl
-def filter_page_image(page, image_filename):
-    if page.options.mono_page:
-        with Image.open(image_filename) as im:
-            im = im.convert('1')
-            im.save(image_filename)
-        return image_filename
-    else:
-        output = image_filename.with_suffix('.jpg')
-        with Image.open(image_filename) as im:
-            im.save(output)
-        return output

misc/synology.py

@@ -1,92 +0,0 @@
-#!/bin/env python3
-# Copyright 2017 github.com/Enantiomerie
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
-# This script must be edited to meet your needs.
-
-import logging
-import os
-import shutil
-import subprocess
-import sys
-import time
-
-# pylint: disable=logging-format-interpolation
-# pylint: disable=logging-not-lazy
-
-script_dir = os.path.dirname(os.path.realpath(__file__))
-timestamp = time.strftime("%Y-%m-%d-%H%M_")
-log_file = script_dir + '/' + timestamp + 'ocrmypdf.log'
-logging.basicConfig(
-    level=logging.INFO,
-    format='%(asctime)s %(message)s',
-    filename=log_file,
-    filemode='w',
-)
-
-if len(sys.argv) > 1:
-    start_dir = sys.argv[1]
-else:
-    start_dir = '.'
-
-for dir_name, subdirs, file_list in os.walk(start_dir):
-    logging.info(dir_name)
-    os.chdir(dir_name)
-    for filename in file_list:
-        file_stem, file_ext = os.path.splitext(filename)
-        if file_ext != '.pdf':
-            continue
-        full_path = os.path.join(dir_name, filename)
-        timestamp_ocr = time.strftime("%Y-%m-%d-%H%M_OCR_")
-        filename_ocr = timestamp_ocr + file_stem + '.pdf'
-        # create string for pdf processing
-        # the script is processed as root user via chron
-        cmd = [
-            'docker',
-            'run',
-            '--rm',
-            '-i',
-            'jbarlow83/ocrmypdf',
-            '--deskew',
-            '-',
-            '-',
-        ]
-        logging.info(cmd)
-        full_path_ocr = os.path.join(dir_name, filename_ocr)
-        with open(filename, 'rb') as input_file, open(
-            full_path_ocr, 'wb'
-        ) as output_file:
-            proc = subprocess.run(
-                cmd,
-                stdin=input_file,
-                stdout=output_file,
-                stderr=subprocess.PIPE,
-                check=False,
-                text=True,
-                errors='ignore',
-            )
-        logging.info(proc.stderr)
-        os.chmod(full_path_ocr, 0o664)
-        os.chmod(full_path, 0o664)
-        full_path_ocr_archive = sys.argv[2]
-        full_path_archive = sys.argv[2] + '/no_ocr'
-        shutil.move(full_path_ocr, full_path_ocr_archive)
-        shutil.move(full_path, full_path_archive)
-logging.info('Finished.\n')

misc/watcher.py

@@ -1,167 +0,0 @@
-#!/usr/bin/env python3
-# Copyright (C) 2019 Ian Alexander: https://github.com/ianalexander
-# Copyright (C) 2020 James R Barlow: https://github.com/jbarlow83
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
-import json
-import logging
-import os
-import sys
-import time
-from datetime import datetime
-from pathlib import Path
-
-import pikepdf
-from watchdog.events import PatternMatchingEventHandler
-from watchdog.observers import Observer
-from watchdog.observers.polling import PollingObserver
-
-import ocrmypdf
-
-# pylint: disable=logging-format-interpolation
-
-INPUT_DIRECTORY = os.getenv('OCR_INPUT_DIRECTORY', '/input')
-OUTPUT_DIRECTORY = os.getenv('OCR_OUTPUT_DIRECTORY', '/output')
-OUTPUT_DIRECTORY_YEAR_MONTH = bool(os.getenv('OCR_OUTPUT_DIRECTORY_YEAR_MONTH', ''))
-ON_SUCCESS_DELETE = bool(os.getenv('OCR_ON_SUCCESS_DELETE', ''))
-DESKEW = bool(os.getenv('OCR_DESKEW', ''))
-OCR_JSON_SETTINGS = json.loads(os.getenv('OCR_JSON_SETTINGS', '{}'))
-POLL_NEW_FILE_SECONDS = int(os.getenv('OCR_POLL_NEW_FILE_SECONDS', '1'))
-USE_POLLING = bool(os.getenv('OCR_USE_POLLING', ''))
-LOGLEVEL = os.getenv('OCR_LOGLEVEL', 'INFO')
-PATTERNS = ['*.pdf', '*.PDF']
-
-log = logging.getLogger('ocrmypdf-watcher')
-
-
-def get_output_dir(root, basename):
-    if OUTPUT_DIRECTORY_YEAR_MONTH:
-        today = datetime.today()
-        output_directory_year_month = (
-            Path(root) / str(today.year) / f'{today.month:02d}'
-        )
-        if not output_directory_year_month.exists():
-            output_directory_year_month.mkdir(parents=True, exist_ok=True)
-        output_path = Path(output_directory_year_month) / basename
-    else:
-        output_path = Path(OUTPUT_DIRECTORY) / basename
-    return output_path
-
-
-def wait_for_file_ready(file_path):
-    # This loop waits to make sure that the file is completely loaded on
-    # disk before attempting to read. Docker sometimes will publish the
-    # watchdog event before the file is actually fully on disk, causing
-    # pikepdf to fail.
-
-    retries = 5
-    while retries:
-        try:
-            pdf = pikepdf.open(file_path)
-        except (FileNotFoundError, pikepdf.PdfError) as e:
-            log.info(f"File {file_path} is not ready yet")
-            log.debug("Exception was", exc_info=e)
-            time.sleep(POLL_NEW_FILE_SECONDS)
-            retries -= 1
-        else:
-            pdf.close()
-            return True
-
-    return False
-
-
-def execute_ocrmypdf(file_path):
-    file_path = Path(file_path)
-    output_path = get_output_dir(OUTPUT_DIRECTORY, file_path.name)
-
-    log.info("-" * 20)
-    log.info(f'New file: {file_path}. Waiting until fully loaded...')
-    if not wait_for_file_ready(file_path):
-        log.info(f"Gave up waiting for {file_path} to become ready")
-        return
-    log.info(f'Attempting to OCRmyPDF to: {output_path}')
-    exit_code = ocrmypdf.ocr(
-        input_file=file_path,
-        output_file=output_path,
-        deskew=DESKEW,
-        **OCR_JSON_SETTINGS,
-    )
-    if exit_code == 0 and ON_SUCCESS_DELETE:
-        log.info(f'OCR is done. Deleting: {file_path}')
-        file_path.unlink()
-    else:
-        log.info('OCR is done')
-
-
-class HandleObserverEvent(PatternMatchingEventHandler):
-    def on_any_event(self, event):
-        if event.event_type in ['created']:
-            execute_ocrmypdf(event.src_path)
-
-
-def main():
-    ocrmypdf.configure_logging(
-        verbosity=(
-            ocrmypdf.Verbosity.default
-            if LOGLEVEL != 'DEBUG'
-            else ocrmypdf.Verbosity.debug
-        ),
-        manage_root_logger=True,
-    )
-    log.setLevel(LOGLEVEL)
-    log.info(
-        f"Starting OCRmyPDF watcher with config:\n"
-        f"Input Directory: {INPUT_DIRECTORY}\n"
-        f"Output Directory: {OUTPUT_DIRECTORY}\n"
-        f"Output Directory Year & Month: {OUTPUT_DIRECTORY_YEAR_MONTH}"
-    )
-    log.debug(
-        f"INPUT_DIRECTORY: {INPUT_DIRECTORY}\n"
-        f"OUTPUT_DIRECTORY: {OUTPUT_DIRECTORY}\n"
-        f"OUTPUT_DIRECTORY_YEAR_MONTH: {OUTPUT_DIRECTORY_YEAR_MONTH}\n"
-        f"ON_SUCCESS_DELETE: {ON_SUCCESS_DELETE}\n"
-        f"DESKEW: {DESKEW}\n"
-        f"ARGS: {OCR_JSON_SETTINGS}\n"
-        f"POLL_NEW_FILE_SECONDS: {POLL_NEW_FILE_SECONDS}\n"
-        f"USE_POLLING: {USE_POLLING}\n"
-        f"LOGLEVEL: {LOGLEVEL}"
-    )
-
-    if 'input_file' in OCR_JSON_SETTINGS or 'output_file' in OCR_JSON_SETTINGS:
-        log.error('OCR_JSON_SETTINGS should not specify input file or output file')
-        sys.exit(1)
-
-    handler = HandleObserverEvent(patterns=PATTERNS)
-    if USE_POLLING:
-        observer = PollingObserver()
-    else:
-        observer = Observer()
-    observer.schedule(handler, INPUT_DIRECTORY, recursive=True)
-    observer.start()
-    try:
-        while True:
-            time.sleep(1)
-    except KeyboardInterrupt:
-        observer.stop()
-    observer.join()
-
-
-if __name__ == "__main__":
-    main()

misc/webservice.py

@@ -1,118 +0,0 @@
-#!/usr/bin/env python3
-# webservice.py wrapper for OCRmyPDF
-# Copyright (C) 2019 James R. Barlow: github.com/jbarlow83
-#
-# This program is free software: you can redistribute it and/or modify
-# 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 Affero General Public License for more details.
-#
-# You should have received a copy of the GNU Affero General Public License
-# along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
-"""This is a simple web service/HTTP wrapper for OCRmyPDF
-
-This may be more convenient than the command line tool for some Docker users.
-Note that OCRmyPDF uses Ghostscript, which is licensed under AGPLv3+. While
-OCRmyPDF is under GPLv3, this file is distributed under the Affero GPLv3+ license,
-to emphasize that SaaS deployments should make sure they comply with
-Ghostscript's license as well as OCRmyPDF's.
-"""
-
-import os
-import shlex
-from subprocess import PIPE, run
-from tempfile import TemporaryDirectory
-
-from flask import Flask, Response, request, send_from_directory
-from werkzeug.utils import secure_filename
-
-app = Flask(__name__)
-app.secret_key = "secret"
-app.config['MAX_CONTENT_LENGTH'] = 50_000_000
-app.config.from_envvar("OCRMYPDF_WEBSERVICE_SETTINGS", silent=True)
-
-ALLOWED_EXTENSIONS = set(["pdf"])
-
-
-def allowed_file(filename):
-    return "." in filename and filename.rsplit(".", 1)[1].lower() in ALLOWED_EXTENSIONS
-
-
-def do_ocrmypdf(file):
-    uploaddir = TemporaryDirectory(prefix="ocrmypdf-upload")
-    downloaddir = TemporaryDirectory(prefix="ocrmypdf-download")
-
-    filename = secure_filename(file.filename)
-    up_file = os.path.join(uploaddir.name, filename)
-    file.save(up_file)
-
-    down_file = os.path.join(downloaddir.name, filename)
-
-    cmd_args = [arg for arg in shlex.split(request.form["params"])]
-    if "--sidecar" in cmd_args:
-        return Response("--sidecar not supported", 501, mimetype='text/plain')
-
-    ocrmypdf_args = ["ocrmypdf", *cmd_args, up_file, down_file]
-    proc = run(ocrmypdf_args, stdout=PIPE, stderr=PIPE, encoding="utf-8")
-    if proc.returncode != 0:
-        stderr = proc.stderr
-        return Response(stderr, 400, mimetype='text/plain')
-
-    return send_from_directory(downloaddir.name, filename)
-
-
-@app.route("/", methods=["GET", "POST"])
-def upload_file():
-    if request.method == "POST":
-        if "file" not in request.files:
-            return Response("No file in POST", 400, mimetype='text/plain')
-        file = request.files["file"]
-        if file.filename == "":
-            return Response("Empty filename", 400, mimetype='text/plain')
-        if not allowed_file(file.filename):
-            return Response("Invalid filename", 400, mimetype='text/plain')
-        if file and allowed_file(file.filename):
-            return do_ocrmypdf(file)
-        return Response("Some other problem", 400, mimetype='text/plain')
-
-    return """
-    <!doctype html>
-    <title>OCRmyPDF webservice</title>
-    <h1>Upload a PDF (debug UI)</h1>
-    <form method=post enctype=multipart/form-data>
-      <label for="args">Command line parameters</label>
-      <input type=textbox name=params>
-      <label for="file">File to upload</label>
-      <input type=file name=file>
-      <input type=submit value=Upload>
-    </form>
-    <h4>Notice</h2>
-    <div style="font-size: 70%; max-width: 34em;">
-    <p>This is a webservice wrapper for OCRmyPDF.</p>
-    <p>Copyright 2019 James R. Barlow</p>
-    <p>This program is free software: you can redistribute it and/or modify
-    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.
-    </p>
-    <p>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.
-    </p>
-    <p>
-    You should have received a copy of the GNU Affero General Public License
-    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.
-    </p>
-    </div>
-    """
-
-
-if __name__ == "__main__":
-    app.run(host='0.0.0.0', port=5000)

pyproject.toml

@@ -1,36 +0,0 @@
-[build-system]
-requires = [
-  "setuptools >= 30.3.0",
-  "wheel",
-  "cffi",
-  "setuptools_scm[toml] >= 3.4",
-  "setuptools_scm_git_archive"
-]
-build-backend = "setuptools.build_meta"
-
-[tool.setuptools_scm]
-version_scheme = "post-release"
-
-[tool.black]
-line-length = 88
-target-version = ["py36", "py37", "py38"]
-skip-string-normalization = true
-include = '\.pyi?$'
-exclude = '''
-/(
-    \.eggs
-  | \.git
-  | \.hg
-  | \.mypy_cache
-  | \.tox
-  | \.venv
-  | _build
-  | buck-out
-  | build
-  | dist
-  | docs
-  | misc
-  | \.egg-info
-  | src/ocrmypdf/lib/_leptonica.py
-)/
-'''

requirements.txt

@@ -0,0 +1,11 @@
+# requirements.txt can be used to replicate the developer's build environment
+# setup.py lists a separate set of requirements that are looser to simplify
+# installation
+ruffus == 2.7.0
+Pillow == 5.2.0
+reportlab == 3.4.0
+PyPDF2 == 1.26.0
+img2pdf == 0.2.4
+cffi == 1.11.5
+PyMuPDF == 1.12.5
+defusedxml == 0.5.0

requirements/main.txt

@@ -1,10 +0,0 @@
-# Deprecated and not maintained; use "pip install ocrmypdf" instead
-cffi == 1.14.5
-coloredlogs == 15.0  # technically optional
-img2pdf == 0.4.0
-pdfminer.six == 20201018
-pikepdf == 2.10.0
-pluggy == 0.13.1
-Pillow == 8.2.0
-reportlab == 3.5.66
-tqdm == 4.59.0

requirements/test.txt

@@ -1,7 +0,0 @@
-# Deprecated and not maintained; use "pip install ocrmypdf[test]" instead
-pytest >= 6.0.0
-pytest-xdist >= 2.2.0
-pytest-cov >= 2.11.1
-python-xmp-toolkit == 2.0.1  # requires apt-get install libexempi3
-                     # or brew install exempi
-#PyMuPDF == 1.13.4    # optional

requirements/watcher.txt

@@ -1,2 +0,0 @@
-# Deprecated and not maintained; use "pip install ocrmypdf[watcher]" instead
-watchdog == 1.0.2

requirements/webservice.txt

@@ -1,2 +0,0 @@
-# Deprecated and not maintained; use "pip install ocrmypdf[webservice]" instead
-Flask >= 1, < 2

setup.cfg

@@ -1,102 +1,8 @@
-[metadata]
-name = ocrmypdf
-description = OCRmyPDF adds an OCR text layer to scanned PDF files, allowing them to be searched
-long_description = file: README.md
-long_description_content_type = text/markdown; charset=UTF-8
-url = https://github.com/jbarlow83/OCRmyPDF
-author = James R. Barlow
-author_email = james@purplerock.ca
-license_files =
-    LICENSE
-keywords =
-    PDF
-    OCR
-    optical character recognition
-    PDF/A
-    scanning
-classifiers =
-    Programming Language :: Python :: 3.6
-    Programming Language :: Python :: 3.7
-    Programming Language :: Python :: 3.8
-    Programming Language :: Python :: 3.9
-    Development Status :: 5 - Production/Stable
-    Environment :: Console
-    Intended Audience :: End Users/Desktop
-    Intended Audience :: Science/Research
-    Intended Audience :: System Administrators
-    License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
-    Operating System :: MacOS :: MacOS X
-    Operating System :: Microsoft :: Windows :: Windows 10
-    Operating System :: POSIX
-    Operating System :: POSIX :: BSD
-    Operating System :: POSIX :: Linux
-    Topic :: Scientific/Engineering :: Image Recognition
-    Topic :: Text Processing :: Indexing
-    Topic :: Text Processing :: Linguistic
-project_urls =
-    Documentation = https://ocrmypdf.readthedocs.io/
-    Source = https://github.com/jbarlow83/ocrmypdf
-    Tracker = https://github.com/jbarlow83/ocrmypdf/issues
-
-[options]
-zip_safe = False
-packages = find:
-package_dir =
-    =src
-platforms = any
-include_package_data=True
-install_requires =
-    cffi >= 1.9.1  # must be a setup and install requirement
-    coloredlogs >= 14.0  # strictly optional
-    img2pdf >= 0.3.0, < 0.5  # pure Python, so track HEAD closely
-    pdfminer.six >= 20191110, != 20200720, <= 20201018
-    pikepdf >= 2.10.0
-    Pillow >= 8.2.0
-    pluggy >= 0.13.0, < 1.0
-    reportlab >= 3.5.66
-    setuptools
-    tqdm >= 4
-python_requires = >= 3.6
-setup_requires =  # can be removed whenever we can drop pip 9 support
-    cffi >= 1.9.1  # to build the leptonica module
-    setuptools_scm  # so that version will work
-    setuptools_scm_git_archive  # enable version from github tarballs
-
-[options.package_data]
-ocrmypdf =
-    data/sRGB.icc
-    py.typed
-
-[options.packages.find]
-where = src
-
-[options.extras_require]
-test =
-    pytest >= 6.0.0
-    pytest-xdist >= 2.2.0
-    pytest-cov >= 2.11.1
-    python-xmp-toolkit == 2.0.1  # also requires apt-get install libexempi3
-                                 # or brew install exempi
-docs =
-    sphinx
-    sphinx-rtd-theme
-    sphinx-issues
-extended_test =
-    PyMuPDF == 1.13.4
-watcher =
-    watchdog >= 1.0.2, < 3
-webservice =
-    Flask >= 1, < 3
-
-[options.entry_points]
-console_scripts =
-    ocrmypdf = ocrmypdf.__main__:run
-
 [bdist_wheel]
-python-tag = py36
+python-tag = py35
 
 [aliases]
-test = pytest
+test=pytest
 
 [check-manifest]
 ignore =
@@ -105,43 +11,6 @@ ignore =
 [tool:pytest]
 norecursedirs = lib .pc .git output cache resources
 testpaths = tests
-filterwarnings =
-	ignore:.*XMLParser.*:DeprecationWarning
-markers =
-	slow
-addopts =
-	-n auto
 
-[isort]
-multi_line_output = 3
-include_trailing_comma = True
-force_grid_wrap = 0
-use_parentheses = True
-line_length = 88
-known_first_party = ocrmypdf
-known_third_party = PIL,_cffi_backend,cffi,flask,img2pdf,pdfminer,pikepdf,pkg_resources,pluggy,pytest,reportlab,setuptools,sphinx_rtd_theme,tqdm,watchdog,werkzeug
-
-[coverage:paths]
-source =
-	src/ocrmypdf
-
-[coverage:run]
-branch = true
-parallel = true
-concurrency = multiprocessing
-
-[coverage:report]
-# Regexes for lines to exclude from consideration
-exclude_lines =
-    # Have to re-enable the standard pragma
-    pragma: no cover
-
-    # Don't complain if tests don't hit defensive assertion code:
-    raise AssertionError
-    raise NotImplementedError
-
-    # Don't complain if non-runnable code isn't run:
-    if 0:
-	if False:
-    if __name__ == .__main__.:
-	if TYPE_CHECKING:
+[metadata]
+license_file = LICENSE

setup.py

@@ -1,19 +1,265 @@
-# © 2021 James R. Barlow: github.com/jbarlow83
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# © 2015 James R. Barlow: github.com/jbarlow83
 #
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+# This file is part of OCRmyPDF.
+#
+# OCRmyPDF is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# OCRmyPDF 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.
+#
+# You should have received a copy of the GNU General Public License
+# along with OCRmyPDF.  If not, see <http://www.gnu.org/licenses/>.
+
+from __future__ import print_function, unicode_literals
+
+import sys
+if sys.version_info < (3, 5):
+    print("Python 3.5 or newer is required", file=sys.stderr)
+    sys.exit(1)
+
+from setuptools import setup, find_packages  # nopep8
+from subprocess import STDOUT, check_output, CalledProcessError  # nopep8
+from collections.abc import Mapping  # nopep8
+import re  # nopep8
 
 
-from setuptools import setup
+missing_program = '''
+The program '{program}' could not be executed or was not found on your
+system PATH.
+'''
+
+unknown_version = '''
+OCRmyPDF requires '{program}' {need_version} or higher.  Your system has
+'{program}' but we cannot tell what version is installed.  Contact the
+package maintainer.
+'''
+
+old_version = '''
+OCRmyPDF requires '{program}' {need_version} or higher.  Your system appears
+to have {found_version}.  Please update this program.
+'''
+
+okay_its_optional = '''
+This program is OPTIONAL, so installation of OCRmyPDF can proceed, but
+some functionality may be missing.
+'''
+
+not_okay_its_required = '''
+This program is REQUIRED for OCRmyPDF to work.  Installation will abort.
+'''
+
+osx_install_advice = '''
+If you have homebrew installed, try these command to install the missing
+packages:
+    brew update
+    brew upgrade
+    brew install {package}
+'''
+
+linux_install_advice = '''
+On systems with the aptitude package manager (Debian, Ubuntu), try these
+commands:
+    sudo apt-get update
+    sudo apt-get install {package}
+
+On RPM-based systems (Red Hat, Fedora), search for instructions on
+installing the RPM for {program}.
+'''
+
+
+def get_platform():
+    if sys.platform.startswith('freebsd'):
+        return 'freebsd'
+    elif sys.platform.startswith('linux'):
+        return 'linux'
+    return sys.platform
+
+
+def _error_trailer(program, package, optional, **kwargs):
+    if optional:
+        print(okay_its_optional.format(**locals()), file=sys.stderr)
+    else:
+        print(not_okay_its_required.format(**locals()), file=sys.stderr)
+
+    if isinstance(package, Mapping):
+        package = package[get_platform()]
+
+    if get_platform() == 'darwin':
+        print(osx_install_advice.format(**locals()), file=sys.stderr)
+    elif get_platform() == 'linux':
+        print(linux_install_advice.format(**locals()), file=sys.stderr)
+
+
+def error_missing_program(
+        program,
+        package,
+        optional
+        ):
+    print(missing_program.format(**locals()), file=sys.stderr)
+    _error_trailer(**locals())
+
+
+def error_unknown_version(
+        program,
+        package,
+        optional,
+        need_version
+        ):
+    print(unknown_version.format(**locals()), file=sys.stderr)
+    _error_trailer(**locals())
+
+
+def error_old_version(
+        program,
+        package,
+        optional,
+        need_version,
+        found_version
+        ):
+    print(old_version.format(**locals()), file=sys.stderr)
+    _error_trailer(**locals())
+
+
+def check_external_program(
+        program,
+        need_version,
+        package,
+        version_check_args=['--version'],
+        version_scrape_regex=re.compile(r'(\d+\.\d+(?:\.\d+)?)'),
+        optional=False):
+
+    print('Checking for {program} >= {need_version}...'.format(
+            program=program, need_version=need_version))
+    try:
+        result = check_output(
+                [program] + version_check_args,
+                universal_newlines=True, stderr=STDOUT)
+    except (CalledProcessError, FileNotFoundError):
+        error_missing_program(program, package, optional)
+        if not optional:
+            sys.exit(1)
+        print('Continuing install without {program}'.format(program=program))
+        return
+
+    try:
+        found_version = version_scrape_regex.search(result).group(1)
+    except AttributeError:
+        error_unknown_version(program, package, optional, need_version)
+        sys.exit(1)
+
+    if found_version < need_version:
+        error_old_version(program, package, optional, need_version,
+                          found_version)
+
+    print('Found {program} {found_version}'.format(
+            program=program, found_version=found_version))
+
+
+command = next((arg for arg in sys.argv[1:] if not arg.startswith('-')), '')
+forced = ('--force' in sys.argv)
+
+
+if not forced and command.startswith('install') or \
+        command in ['check', 'test', 'nosetests', 'easy_install']:
+    check_external_program(
+        program='tesseract',
+        need_version='3.04',  # using backport for Travis CI
+        package={'darwin': 'tesseract', 'linux': 'tesseract-ocr'}
+    )
+    check_external_program(
+        program='gs',
+        need_version='9.15',  # limited by Travis CI / Ubuntu 14.04 backports
+        package='ghostscript'
+    )
+    check_external_program(
+        program='unpaper',
+        need_version='6.1',   # latest sane version
+        package='unpaper',
+        optional=True
+    )
+    check_external_program(
+        program='qpdf',
+        need_version='7.0.0', # test suite known to fail on 5.1.1
+        package='qpdf',
+        version_check_args=['--version']
+    )
+
+if 'upload' in sys.argv[1:]:
+    print('Use twine to upload the package - setup.py upload is insecure')
+    sys.exit(1)
+
+tests_require = open('test_requirements.txt').read().splitlines()
+
+
+def readme():
+    with open('README.rst') as f:
+        return f.read()
 
-# Minimal setup to support older setuptools/setuptools_scm
 setup(
-    setup_requires=[  # can be removed whenever we can drop pip 9 support
-        'cffi >= 1.9.1',  # to build the leptonica module
-        'setuptools_scm',  # so that version will work
-        'setuptools_scm_git_archive',  # enable version from github tarballs
+    name='ocrmypdf',
+    description='OCRmyPDF adds an OCR text layer to scanned PDF files, allowing them to be searched',
+    long_description=readme(),
+    url='https://github.com/jbarlow83/OCRmyPDF',
+    author='James R. Barlow',
+    author_email='jim@purplerock.ca',
+    packages=find_packages('src', exclude=["tests", "tests.*"]),
+    package_dir={'': 'src'},
+    keywords=['PDF', 'OCR', 'optical character recognition', 'PDF/A', 'scanning'],
+    classifiers=[
+        "Programming Language :: Python :: 3.5",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Development Status :: 5 - Production/Stable",
+        "Environment :: Console",
+        "Intended Audience :: End Users/Desktop",
+        "Intended Audience :: Science/Research",
+        "Intended Audience :: System Administrators",
+        "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+        "Operating System :: MacOS :: MacOS X",
+        "Operating System :: POSIX",
+        "Operating System :: POSIX :: BSD",
+        "Operating System :: POSIX :: Linux",
+        "Topic :: Scientific/Engineering :: Image Recognition",
+        "Topic :: Text Processing :: Indexing",
+        "Topic :: Text Processing :: Linguistic",
+        ],
+    python_requires=' >= 3.5',
+    setup_requires=[
+        'cffi >= 1.9.1',        # to build the leptonica module
+        'pytest-runner',        # to enable python setup.py test
+        'setuptools_scm',       # so that version will work
     ],
     use_scm_version={'version_scheme': 'post-release'},
-    cffi_modules=['src/ocrmypdf/lib/compile_leptonica.py:ffibuilder'],
-)
+    cffi_modules=[
+        'src/ocrmypdf/lib/compile_leptonica.py:ffibuilder'
+    ],
+    install_requires=[
+        'cffi >= 1.9.1',          # must be a setup and install requirement
+        'defusedxml >= 0.5.0',    # pure Python, so track HEAD closely
+        'img2pdf >= 0.2.4',       # pure Python, so track HEAD closely
+        'Pillow >= 4.0.0, != 5.1.0 ; sys_platform == "darwin"',
+                                  # Pillow < 4 has BytesIO/TIFF bug w/img2pdf 0.2.3
+                                  # block 5.1.0, broken wheels
+        'PyPDF2 >= 1.26',         # pure Python, so track HEAD closely
+        'reportlab >= 3.3.0',     # oldest released version with sane image handling
+        'ruffus >= 2.7.0',
+    ],
+    extras_require={
+        'fitz': ['PyMuPDF >= 1.12.5']     # for table of contents bug
+    },
+    tests_require=tests_require,
+    entry_points={
+        'console_scripts': [
+            'ocrmypdf = ocrmypdf.__main__:run_pipeline'
+        ],
+    },
+    package_data={'ocrmypdf': ['data/sRGB.icc']},
+    include_package_data=True,
+    zip_safe=False)

src/ocrmypdf/RELEASE.md

@@ -1,35 +0,0 @@
-# Release checklist
-
-## Patch release
-
-- Check `pytest`
-
-- Update release notes
-
-## Minor release
-
-## Major release
-
-- Run `pre-commit autoupdate`
-
-- Check README.md
-
-- Check setup.py
-
-    - Are classifiers up to date?
-    - Is `python_requires` correct?
-    - Python 3.6 is EOL on December 2021-12. Could drop support then.
-    - Can we tighten any `install_requires` dependencies?
-
-- Search for old version shims we can remove
-
-    - "shim"
-    - ` pikepdf.__version__`
-
-- Search for deprecation: search all files for deprec*, etc.
-
-- Check requirements in setup.cfg
-
-- Delete `tests/cache`, do `pytest --runslow`, and update cache.
-
-- Do `pytest --cov-report html`

src/ocrmypdf/__init__.py

@@ -1,32 +1,25 @@
 # © 2017 James R. Barlow: github.com/jbarlow83
 #
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+# This file is part of OCRmyPDF.
+#
+# OCRmyPDF is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# OCRmyPDF 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.
+#
+# You should have received a copy of the GNU General Public License
+# along with OCRmyPDF.  If not, see <http://www.gnu.org/licenses/>.
 
+import pkg_resources
 
-from pluggy import HookimplMarker as _HookimplMarker
+PROGRAM_NAME = 'ocrmypdf'
 
-from ocrmypdf import helpers, hocrtransform, leptonica, pdfa, pdfinfo
-from ocrmypdf._concurrent import Executor
-from ocrmypdf._jobcontext import PageContext, PdfContext
-from ocrmypdf._version import PROGRAM_NAME, __version__
-from ocrmypdf.api import Verbosity, configure_logging, ocr
-from ocrmypdf.exceptions import (
-    BadArgsError,
-    DpiError,
-    EncryptedPdfError,
-    ExitCode,
-    ExitCodeException,
-    InputFileError,
-    MissingDependencyError,
-    OutputFileAccessError,
-    PdfMergeFailedError,
-    PriorOcrFoundError,
-    SubprocessOutputError,
-    TesseractConfigError,
-    UnsupportedImageFormatError,
-)
-from ocrmypdf.pluginspec import OcrEngine, OrientationConfidence
+# Official PEP 396
+__version__ = pkg_resources.get_distribution('ocrmypdf').version
 
-hookimpl = _HookimplMarker('ocrmypdf')
+VERSION = __version__

src/ocrmypdf/_concurrent.py

@@ -1,133 +0,0 @@
-# © 2020 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-import threading
-from abc import ABC, abstractmethod
-from typing import Callable, Iterable, Optional
-
-
-def _task_noop(*_args, **_kwargs):
-    return
-
-
-class NullProgressBar:
-    def __init__(self, **kwargs):
-        pass
-
-    def __enter__(self):
-        return self
-
-    def __exit__(self, exc_type, exc_value, traceback):
-        return False
-
-    def update(self, _arg=None):
-        return
-
-
-class Executor(ABC):
-    pool_lock = threading.Lock()
-    pbar_class = NullProgressBar
-
-    def __init__(self, *, pbar_class=None):
-        if pbar_class:
-            self.pbar_class = pbar_class
-
-    def __call__(
-        self,
-        *,
-        use_threads: bool,
-        max_workers: int,
-        tqdm_kwargs: dict,
-        worker_initializer: Optional[Callable] = None,
-        task: Optional[Callable] = None,
-        task_arguments: Optional[Iterable] = None,
-        task_finished: Optional[Callable] = None,
-    ) -> None:
-        """
-        Set up parallel execution and progress reporting.
-
-        Args:
-            use_threads: If ``False``, the workload is the sort that will benefit from
-                running in a multiprocessing context (for example, it uses Python
-                heavily, and parallelizing it with threads is not expected to be
-                performant).
-            max_workers: The maximum number of workers that should be run.
-            tdqm_kwargs: Arguments to set up the progress bar.
-            worker_initializer: Called when a worker is initialized, in the worker's
-                execution context. If the child workers are processes, it must be
-                possible to marshall/pickle the worker initializer.
-                ``functools.partial`` can be used to bind parameters.
-            task: Called when the worker starts a new task, in the worker's execution
-                context. Must be possible to marshall to the worker.
-            task_finished: Called when a worker finishes a task, in the parent's
-                context.
-            task_arguments: An iterable that generates a group of parameters for each
-                task. This runs in the parent's context, but the parameters must be
-                marshallable to the worker.
-        """
-
-        if not task_arguments:
-            return  # Nothing to do!
-        if not worker_initializer:
-            worker_initializer = _task_noop
-        if not task_finished:
-            task_finished = _task_noop
-        if not task:
-            task = _task_noop
-
-        with self.pool_lock:
-            self._execute(
-                use_threads=use_threads,
-                max_workers=max_workers,
-                tqdm_kwargs=tqdm_kwargs,
-                worker_initializer=worker_initializer,
-                task=task,
-                task_arguments=task_arguments,
-                task_finished=task_finished,
-            )
-
-    @abstractmethod
-    def _execute(
-        self,
-        *,
-        use_threads: bool,
-        max_workers: int,
-        tqdm_kwargs: dict,
-        worker_initializer: Callable,
-        task: Callable,
-        task_arguments: Iterable,
-        task_finished: Callable,
-    ):
-        """Custom executors should override this method."""
-
-
-def setup_executor(plugin_manager) -> Executor:
-    pbar_class = plugin_manager.hook.get_progressbar_class()
-    return plugin_manager.hook.get_executor(progressbar_class=pbar_class)
-
-
-class SerialExecutor(Executor):
-    """Implements a purely sequential executor using the parallel protocol.
-
-    The current process/thread will be the worker that executes all tasks
-    in order. As such, ``worker_initializer`` will never be called.
-    """
-
-    def _execute(
-        self,
-        *,
-        use_threads: bool,
-        max_workers: int,
-        tqdm_kwargs: dict,
-        worker_initializer: Callable,
-        task: Callable,
-        task_arguments: Iterable,
-        task_finished: Callable,
-    ):  # pylint: disable=unused-argument
-        with self.pbar_class(**tqdm_kwargs) as pbar:
-            for args in task_arguments:
-                result = task(args)
-                task_finished(result, pbar)

src/ocrmypdf/_exec/__init__.py

@@ -1,8 +0,0 @@
-# © 2020 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-
-"""Manage third party executables"""

src/ocrmypdf/_exec/ghostscript.py

@@ -1,270 +0,0 @@
-# © 2017 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-
-"""Interface to Ghostscript executable"""
-
-import logging
-import os
-import re
-from io import BytesIO
-from os import fspath
-from pathlib import Path
-from shutil import which
-from subprocess import PIPE, CalledProcessError
-from typing import Optional
-
-from PIL import Image
-
-from ocrmypdf.exceptions import MissingDependencyError, SubprocessOutputError
-from ocrmypdf.helpers import Resolution
-from ocrmypdf.subprocess import get_version, run, run_polling_stderr
-
-log = logging.getLogger(__name__)
-
-missing_gs_error = """
----------------------------------------------------------------------
-This error normally occurs when ocrmypdf find can't Ghostscript.
-Please ensure Ghostscript is installed and its location is added to
-the system PATH environment variable.
-
-For details see:
-    https://ocrmypdf.readthedocs.io/en/latest/installation.html
----------------------------------------------------------------------
-"""
-
-_gswin = None
-if os.name == 'nt':
-    _gswin = which('gswin64c')
-    if not _gswin:
-        _gswin = which('gswin32c')
-        if not _gswin:
-            raise MissingDependencyError(missing_gs_error)
-    _gswin = Path(_gswin).stem
-
-GS = _gswin if _gswin else 'gs'
-del _gswin
-
-
-def version():
-    return get_version(GS)
-
-
-def jpeg_passthrough_available() -> bool:
-    """Returns True if the installed version of Ghostscript supports JPEG passthru
-
-    Prior to 9.23, Ghostscript decoded and re-encoded JPEGs internally. In 9.23
-    it gained the ability to keep JPEGs unmodified. However, the 9.23
-    implementation was buggy and would deletes the last two bytes of images in
-    some cases, as reported here.
-    https://bugs.ghostscript.com/show_bug.cgi?id=699216
-
-    The issue was fixed for 9.24, hence that is the first version we consider
-    the feature available. (Ghostscript 9.24 has its own problems is blacklisted.)
-    """
-    return version() >= '9.24'
-
-
-def _gs_error_reported(stream) -> bool:
-    return True if re.search(r'error', stream, flags=re.IGNORECASE) else False
-
-
-def rasterize_pdf(
-    input_file: os.PathLike,
-    output_file: os.PathLike,
-    *,
-    raster_device: str,
-    raster_dpi: Resolution,
-    pageno: int = 1,
-    page_dpi: Optional[Resolution] = None,
-    rotation: Optional[int] = None,
-    filter_vector: bool = False,
-):
-    """Rasterize one page of a PDF at resolution raster_dpi in canvas units."""
-    raster_dpi = raster_dpi.round(6)
-    if not page_dpi:
-        page_dpi = raster_dpi
-
-    args_gs = (
-        [
-            GS,
-            '-dQUIET',
-            '-dSAFER',
-            '-dBATCH',
-            '-dNOPAUSE',
-            f'-sDEVICE={raster_device}',
-            f'-dFirstPage={pageno}',
-            f'-dLastPage={pageno}',
-            f'-r{raster_dpi.x:f}x{raster_dpi.y:f}',
-        ]
-        + (['-dFILTERVECTOR'] if filter_vector else [])
-        + [
-            '-o',
-            '-',
-            '-sstdout=%stderr',
-            '-dAutoRotatePages=/None',  # Probably has no effect on raster
-            '-f',
-            fspath(input_file),
-        ]
-    )
-
-    try:
-        p = run(args_gs, stdout=PIPE, stderr=PIPE, check=True)
-    except CalledProcessError as e:
-        log.error(e.stderr.decode(errors='replace'))
-        raise SubprocessOutputError('Ghostscript rasterizing failed')
-    else:
-        stderr = p.stderr.decode(errors='replace')
-        if _gs_error_reported(stderr):
-            log.error(stderr)
-
-    with Image.open(BytesIO(p.stdout)) as im:
-        if rotation is not None:
-            log.debug("Rotating output by %i", rotation)
-            # rotation is a clockwise angle and Image.ROTATE_* is
-            # counterclockwise so this cancels out the rotation
-            if rotation == 90:
-                im = im.transpose(Image.ROTATE_90)
-            elif rotation == 180:
-                im = im.transpose(Image.ROTATE_180)
-            elif rotation == 270:
-                im = im.transpose(Image.ROTATE_270)
-            if rotation % 180 == 90:
-                page_dpi = page_dpi.flip_axis()
-        im.save(fspath(output_file), dpi=page_dpi)
-
-
-class GhostscriptFollower:
-    re_process = re.compile(r"Processing pages \d+ through (\d+).")
-    re_page = re.compile(r"Page (\d+)")
-
-    def __init__(self, progressbar_class):
-        self.count = 0
-        self.progressbar_class = progressbar_class
-        self.progressbar = None
-
-    def __call__(self, line):
-        if not self.progressbar_class:
-            return
-        if not self.progressbar:
-            m = self.re_process.match(line.strip())
-            if m:
-                self.count = int(m.group(1))
-                self.progressbar = self.progressbar_class(
-                    total=self.count, desc="PDF/A conversion", unit='page'
-                )
-                return
-        else:
-            m = self.re_page.match(line.strip())
-            if m:
-                self.progressbar.update()
-
-
-def generate_pdfa(
-    pdf_pages,
-    output_file: os.PathLike,
-    *,
-    compression: str,
-    pdf_version: str = '1.5',
-    pdfa_part: str = '2',
-    progressbar_class=None,
-):
-    # Ghostscript's compression is all or nothing. We can either force all images
-    # to JPEG, force all to Flate/PNG, or let it decide how to encode the images.
-    # In most case it's best to let it decide.
-    compression_args = []
-    if compression == 'jpeg':
-        compression_args = [
-            "-dAutoFilterColorImages=false",
-            "-dColorImageFilter=/DCTEncode",
-            "-dAutoFilterGrayImages=false",
-            "-dGrayImageFilter=/DCTEncode",
-        ]
-    elif compression == 'lossless':
-        compression_args = [
-            "-dAutoFilterColorImages=false",
-            "-dColorImageFilter=/FlateEncode",
-            "-dAutoFilterGrayImages=false",
-            "-dGrayImageFilter=/FlateEncode",
-        ]
-    else:
-        compression_args = [
-            "-dAutoFilterColorImages=true",
-            "-dAutoFilterGrayImages=true",
-        ]
-
-    strategy = 'LeaveColorUnchanged'
-    # Older versions of Ghostscript expect a leading slash in
-    # sColorConversionStrategy, newer ones should not have it. See Ghostscript
-    # git commit fe1c025d.
-    strategy = ('/' + strategy) if version() < '9.19' else strategy
-
-    if version() == '9.23':
-        # 9.23: added JPEG passthrough as a new feature, but with a bug that
-        # incorrectly formats some images. Fixed as of 9.24. So we disable this
-        # feature for 9.23.
-        # https://bugs.ghostscript.com/show_bug.cgi?id=699216
-        compression_args.append('-dPassThroughJPEGImages=false')
-
-    # nb no need to specify ProcessColorModel when ColorConversionStrategy
-    # is set; see:
-    # https://bugs.ghostscript.com/show_bug.cgi?id=699392
-    args_gs = (
-        [
-            GS,
-            "-dBATCH",
-            "-dNOPAUSE",
-            "-dSAFER",
-            "-dCompatibilityLevel=" + str(pdf_version),
-            "-sDEVICE=pdfwrite",
-            "-dAutoRotatePages=/None",
-            "-sColorConversionStrategy=" + strategy,
-        ]
-        + compression_args
-        + [
-            "-dJPEGQ=95",
-            "-dPDFA=" + pdfa_part,
-            "-dPDFACompatibilityPolicy=1",
-            "-o",
-            "-",
-            "-sstdout=%stderr",
-        ]
-    )
-    args_gs.extend(fspath(s) for s in pdf_pages)  # Stringify Path objs
-
-    try:
-        with Path(output_file).open('wb') as output:
-            p = run_polling_stderr(
-                args_gs,
-                stdout=output,
-                stderr=PIPE,
-                check=True,
-                text=True,
-                encoding='utf-8',
-                errors='replace',
-                callback=GhostscriptFollower(progressbar_class),
-            )
-    except CalledProcessError as e:
-        # Ghostscript does not change return code when it fails to create
-        # PDF/A - check PDF/A status elsewhere
-        log.error(e.stderr)
-        raise SubprocessOutputError('Ghostscript PDF/A rendering failed') from e
-    else:
-        stderr = p.stderr
-        # If there is an error we log the whole stderr, except for filtering
-        # duplicates.
-        if _gs_error_reported(stderr):
-            last_part = None
-            repcount = 0
-            for part in stderr.split('****'):
-                if part != last_part:
-                    if repcount > 1:
-                        log.error(f"(previous error message repeated {repcount} times)")
-                        repcount = 0
-                    log.error(part)
-                else:
-                    repcount += 1
-                last_part = part

src/ocrmypdf/_exec/jbig2enc.py

@@ -1,57 +0,0 @@
-# © 2018 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-
-"""Interface to jbig2 executable"""
-
-from subprocess import PIPE
-
-from ocrmypdf.exceptions import MissingDependencyError
-from ocrmypdf.subprocess import get_version, run
-
-
-def version():
-    return get_version('jbig2', regex=r'jbig2enc (\d+(\.\d+)*).*')
-
-
-def available():
-    try:
-        version()
-    except MissingDependencyError:
-        return False
-    return True
-
-
-def convert_group(*, cwd, infiles, out_prefix):
-    args = [
-        'jbig2',
-        '-b',
-        out_prefix,
-        '-s',  # symbol mode (lossy)
-        # '-r', # refinement mode (lossless symbol mode, currently disabled in
-        # jbig2)
-        '-p',
-    ]
-    args.extend(infiles)
-    proc = run(args, cwd=cwd, stdout=PIPE, stderr=PIPE)
-    proc.check_returncode()
-    return proc
-
-
-def convert_group_mp(args):
-    return convert_group(cwd=args[0], infiles=args[1], out_prefix=args[2])
-
-
-def convert_single(*, cwd, infile, outfile):
-    args = ['jbig2', '-p', infile]
-    with open(outfile, 'wb') as fstdout:
-        proc = run(args, cwd=cwd, stdout=fstdout, stderr=PIPE)
-    proc.check_returncode()
-    return proc
-
-
-def convert_single_mp(args):
-    return convert_single(cwd=args[0], infile=args[1], outfile=args[2])

src/ocrmypdf/_exec/pngquant.py

@@ -1,65 +0,0 @@
-# © 2018 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-
-"""Interface to pngquant executable"""
-
-from contextlib import contextmanager
-from io import BytesIO
-from pathlib import Path
-from subprocess import PIPE
-
-from PIL import Image
-
-from ocrmypdf.exceptions import MissingDependencyError
-from ocrmypdf.subprocess import get_version, run
-
-
-def version():
-    return get_version('pngquant', regex=r'(\d+(\.\d+)*).*')
-
-
-def available():
-    try:
-        version()
-    except MissingDependencyError:
-        return False
-    return True
-
-
-@contextmanager
-def input_as_png(input_file: Path):
-    if not input_file.name.endswith('.png'):
-        with Image.open(input_file) as im:
-            bio = BytesIO()
-            im.save(bio, format='png')
-            bio.seek(0)
-            yield bio
-    else:
-        with open(input_file, 'rb') as f:
-            yield f
-
-
-def quantize(input_file: Path, output_file: Path, quality_min: int, quality_max: int):
-    with input_as_png(input_file) as input_stream:
-        args = [
-            'pngquant',
-            '--force',
-            '--skip-if-larger',
-            '--quality',
-            f'{quality_min}-{quality_max}',
-            '--',  # pngquant: stop processing arguments
-            '-',  # pngquant: stream input and output
-        ]
-        result = run(args, stdin=input_stream, stdout=PIPE, stderr=PIPE, check=False)
-
-    if result.returncode == 0:
-        # input_file could be the same as output_file, so we defer the write
-        output_file.write_bytes(result.stdout)
-
-
-def quantize_mp(args):
-    return quantize(*args)

src/ocrmypdf/_exec/tesseract.py

@@ -1,343 +0,0 @@
-# © 2017 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-
-"""Interface to Tesseract executable"""
-
-import logging
-import os
-import re
-import shutil
-from collections import namedtuple
-from distutils.version import StrictVersion
-from os import fspath
-from pathlib import Path
-from subprocess import PIPE, STDOUT, CalledProcessError, TimeoutExpired
-from typing import List, Optional
-
-from PIL import Image
-
-from ocrmypdf.exceptions import (
-    MissingDependencyError,
-    SubprocessOutputError,
-    TesseractConfigError,
-)
-from ocrmypdf.subprocess import get_version, run
-
-log = logging.getLogger(__name__)
-
-OrientationConfidence = namedtuple('OrientationConfidence', ('angle', 'confidence'))
-
-HOCR_TEMPLATE = """<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
-  <title></title>
-<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
-  <meta name='ocr-system' content='tesseract 4.0.0' />
-  <meta name='ocr-capabilities' content='ocr_page ocr_carea ocr_par ocr_line ocrx_word ocrp_wconf'/>
-</head>
-<body>
-  <div class='ocr_page' id='page_1' title='image "_blank.png"; bbox 0 0 {0} {1}; ppageno 0'>
-  </div>
- </body>
-</html>
-"""
-
-
-class TesseractLoggerAdapter(logging.LoggerAdapter):
-    def process(self, msg, kwargs):
-        kwargs['extra'] = self.extra
-        return '[tesseract] %s' % (msg), kwargs
-
-
-class TesseractVersion(StrictVersion):
-
-    version_re = re.compile(
-        r'''
-        ^(\d+) \. (\d+) (\. (\d+))?  # groups: 1/major, 2/minor, 3/[skip], 4/patch
-        [-]?  # optional hyphen separator
-        (?:(alpha|beta|rc|dev)?[.\-\ ]?(\d+)?)?  # 5/prerelease, 6/prerelease_num
-        (?:-(\d+)-g[0-9a-f]+)?  # untagged git version
-        $
-        ''',
-        re.VERBOSE | re.ASCII,
-    )
-
-    def parse(self, vstring):
-        try:
-            super().parse(vstring)
-        except TypeError as e:
-            if 'int() argument must be a string' in str(e):
-                super().parse(vstring + '0')
-
-
-def version():
-    return get_version('tesseract', regex=r'tesseract\s(.+)')
-
-
-def has_user_words():
-    """Does Tesseract have --user-words capability?
-
-    Not available in 4.0, but available in 4.1. Also available in 3.x, but
-    we no longer support 3.x.
-    """
-    return version() >= '4.1'
-
-
-def get_languages():
-    def lang_error(output):
-        msg = (
-            "Tesseract failed to report available languages.\n"
-            "Output from Tesseract:\n"
-            "-----------\n"
-        )
-        msg += output
-        return msg
-
-    args_tess = ['tesseract', '--list-langs']
-    try:
-        proc = run(
-            args_tess,
-            text=True,
-            stdout=PIPE,
-            stderr=STDOUT,
-            logs_errors_to_stdout=True,
-            check=True,
-        )
-        output = proc.stdout
-    except CalledProcessError as e:
-        raise MissingDependencyError(lang_error(e.output)) from e
-
-    for line in output.splitlines():
-        if line.startswith('Error'):
-            raise MissingDependencyError(lang_error(output))
-    _header, *rest = output.splitlines()
-    return set(lang.strip() for lang in rest)
-
-
-def tess_base_args(langs: List[str], engine_mode: Optional[int]) -> List[str]:
-    args = ['tesseract']
-    if langs:
-        args.extend(['-l', '+'.join(langs)])
-    if engine_mode is not None:
-        args.extend(['--oem', str(engine_mode)])
-    return args
-
-
-def get_orientation(input_file: Path, engine_mode: Optional[int], timeout: float):
-    args_tesseract = tess_base_args(['osd'], engine_mode) + [
-        '--psm',
-        '0',
-        fspath(input_file),
-        'stdout',
-    ]
-
-    try:
-        p = run(args_tesseract, stdout=PIPE, stderr=STDOUT, timeout=timeout, check=True)
-        stdout = p.stdout
-    except TimeoutExpired:
-        return OrientationConfidence(angle=0, confidence=0.0)
-    except CalledProcessError as e:
-        tesseract_log_output(e.stdout)
-        tesseract_log_output(e.stderr)
-        if (
-            b'Too few characters. Skipping this page' in e.output
-            or b'Image too large' in e.output
-        ):
-            return OrientationConfidence(0, 0)
-        raise SubprocessOutputError() from e
-    else:
-        osd = {}
-        for line in stdout.decode().splitlines():
-            line = line.strip()
-            parts = line.split(':', maxsplit=2)
-            if len(parts) == 2:
-                osd[parts[0].strip()] = parts[1].strip()
-
-        angle = int(osd.get('Orientation in degrees', 0))
-        oc = OrientationConfidence(
-            angle=angle, confidence=float(osd.get('Orientation confidence', 0))
-        )
-        return oc
-
-
-def tesseract_log_output(stream):
-    tlog = TesseractLoggerAdapter(
-        log, extra=log.extra if hasattr(log, 'extra') else None
-    )
-
-    if not stream:
-        return
-    try:
-        text = stream.decode()
-    except UnicodeDecodeError:
-        text = stream.decode('utf-8', 'ignore')
-
-    lines = text.splitlines()
-    for line in lines:
-        if line.startswith("Tesseract Open Source"):
-            continue
-        elif line.startswith("Warning in pixReadMem"):
-            continue
-        elif 'diacritics' in line:
-            tlog.warning("lots of diacritics - possibly poor OCR")
-        elif line.startswith('OSD: Weak margin'):
-            tlog.warning("unsure about page orientation")
-        elif 'Error in pixScanForForeground' in line:
-            pass  # Appears to be spurious/problem with nonwhite borders
-        elif 'Error in boxClipToRectangle' in line:
-            pass  # Always appears with pixScanForForeground message
-        elif 'parameter not found: ' in line.lower():
-            tlog.error(line.strip())
-            problem = line.split('found: ')[1]
-            raise TesseractConfigError(problem)
-        elif 'error' in line.lower() or 'exception' in line.lower():
-            tlog.error(line.strip())
-        elif 'warning' in line.lower():
-            tlog.warning(line.strip())
-        elif 'read_params_file' in line.lower():
-            tlog.error(line.strip())
-        else:
-            tlog.info(line.strip())
-
-
-def page_timedout(timeout):
-    if timeout == 0:
-        return
-    log.warning("[tesseract] took too long to OCR - skipping")
-
-
-def _generate_null_hocr(output_hocr, output_text, image):
-    """Produce a .hocr file that reports no text detected on a page that is
-    the same size as the input image."""
-    with Image.open(image) as im:
-        w, h = im.size
-
-    output_hocr.write_text(HOCR_TEMPLATE.format(w, h), encoding='utf-8')
-    output_text.write_text('[skipped page]', encoding='utf-8')
-
-
-def generate_hocr(
-    *,
-    input_file: Path,
-    output_hocr: Path,
-    output_text: Path,
-    languages: List[str],
-    engine_mode: int,
-    tessconfig: List[str],
-    timeout: float,
-    pagesegmode: int,
-    user_words,
-    user_patterns,
-):
-    prefix = output_hocr.with_suffix('')
-
-    args_tesseract = tess_base_args(languages, engine_mode)
-
-    if pagesegmode is not None:
-        args_tesseract.extend(['--psm', str(pagesegmode)])
-
-    if user_words:
-        args_tesseract.extend(['--user-words', user_words])
-
-    if user_patterns:
-        args_tesseract.extend(['--user-patterns', user_patterns])
-
-    # Reminder: test suite tesseract test plugins will break after any changes
-    # to the number of order parameters here
-    args_tesseract.extend([input_file, prefix, 'hocr', 'txt'] + tessconfig)
-    try:
-        p = run(args_tesseract, stdout=PIPE, stderr=STDOUT, timeout=timeout, check=True)
-        stdout = p.stdout
-    except TimeoutExpired:
-        # Generate a HOCR file with no recognized text if tesseract times out
-        # Temporary workaround to hocrTransform not being able to function if
-        # it does not have a valid hOCR file.
-        page_timedout(timeout)
-        _generate_null_hocr(output_hocr, output_text, input_file)
-    except CalledProcessError as e:
-        tesseract_log_output(e.output)
-        if b'Image too large' in e.output:
-            _generate_null_hocr(output_hocr, output_text, input_file)
-            return
-
-        raise SubprocessOutputError() from e
-    else:
-        tesseract_log_output(stdout)
-        # The sidecar text file will get the suffix .txt; rename it to
-        # whatever caller wants it named
-        if prefix.with_suffix('.txt').exists():
-            shutil.move(prefix.with_suffix('.txt'), output_text)
-
-
-def use_skip_page(output_pdf, output_text):
-    output_text.write_text('[skipped page]', encoding='utf-8')
-
-    # A 0 byte file to the output to indicate a skip
-    output_pdf.write_bytes(b'')
-
-
-def generate_pdf(
-    *,
-    input_file: Path,
-    output_pdf: Path,
-    output_text: Path,
-    languages: List[str],
-    engine_mode: int,
-    tessconfig: List[str],
-    timeout: float,
-    pagesegmode: int,
-    user_words,
-    user_patterns,
-):
-    """Use Tesseract to render a PDF.
-
-    input_file -- image to analyze
-    output_pdf -- file to generate
-    output_text -- OCR text file
-    languages -- list of languages to consider
-    engine_mode -- engine mode argument for tess v4
-    tessconfig -- tesseract configuration
-    timeout -- timeout (seconds)
-    """
-
-    args_tesseract = tess_base_args(languages, engine_mode)
-
-    if pagesegmode is not None:
-        args_tesseract.extend(['--psm', str(pagesegmode)])
-
-    args_tesseract.extend(['-c', 'textonly_pdf=1'])
-
-    if user_words:
-        args_tesseract.extend(['--user-words', user_words])
-
-    if user_patterns:
-        args_tesseract.extend(['--user-patterns', user_patterns])
-
-    prefix = os.path.splitext(output_pdf)[0]  # Tesseract appends suffixes
-
-    # Reminder: test suite tesseract test plugins might break after any changes
-    # to the number of order parameters here
-
-    args_tesseract.extend([input_file, prefix, 'pdf', 'txt'] + tessconfig)
-    try:
-        p = run(args_tesseract, stdout=PIPE, stderr=STDOUT, timeout=timeout, check=True)
-        stdout = p.stdout
-        if os.path.exists(prefix + '.txt'):
-            shutil.move(prefix + '.txt', output_text)
-    except TimeoutExpired:
-        page_timedout(timeout)
-        use_skip_page(output_pdf, output_text)
-    except CalledProcessError as e:
-        tesseract_log_output(e.output)
-        if b'Image too large' in e.output:
-            use_skip_page(output_pdf, output_text)
-            return
-        raise SubprocessOutputError() from e
-    else:
-        tesseract_log_output(stdout)

src/ocrmypdf/_exec/unpaper.py

@@ -1,134 +0,0 @@
-# © 2015 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-
-# unpaper documentation:
-# https://github.com/Flameeyes/unpaper/blob/master/doc/basic-concepts.md
-
-"""Interface to unpaper executable"""
-
-import logging
-import os
-import shlex
-from decimal import Decimal
-from pathlib import Path
-from subprocess import PIPE, STDOUT
-from tempfile import TemporaryDirectory
-from typing import List, Optional, Tuple, Union
-
-from PIL import Image
-
-from ocrmypdf.exceptions import MissingDependencyError, SubprocessOutputError
-from ocrmypdf.subprocess import get_version
-from ocrmypdf.subprocess import run as external_run
-
-DecFloat = Union[Decimal, float]
-
-log = logging.getLogger(__name__)
-
-
-def version() -> str:
-    return get_version('unpaper')
-
-
-def _setup_unpaper_io(tmpdir: Path, input_file: Path) -> Tuple[Path, Path]:
-    SUFFIXES = {'1': '.pbm', 'L': '.pgm', 'RGB': '.ppm'}
-    with Image.open(input_file) as im:
-        im_modified = False
-        if im.mode not in SUFFIXES:
-            log.info("Converting image to other colorspace")
-            try:
-                if im.mode == 'P' and len(im.getcolors()) == 2:
-                    im = im.convert(mode='1')
-                else:
-                    im = im.convert(mode='RGB')
-            except IOError as e:
-                raise MissingDependencyError(
-                    "Could not convert image with type " + im.mode
-                ) from e
-            else:
-                im_modified = True
-        try:
-            suffix = SUFFIXES[im.mode]
-        except KeyError:
-            raise MissingDependencyError(
-                "Failed to convert image to a supported format."
-            ) from None
-
-        if im_modified or input_file.suffix != '.pnm':
-            input_pnm = tmpdir / 'input.pnm'
-            im.save(input_pnm, format='PPM')
-        else:
-            # No changes, PNG input, just use the file we already have
-            input_pnm = input_file
-        output_pnm = tmpdir / f'output{suffix}'
-    return input_pnm, output_pnm
-
-
-def run(
-    input_file: Path, output_file: Path, *, dpi: DecFloat, mode_args: List[str]
-) -> None:
-    args_unpaper = ['unpaper', '-v', '--dpi', str(round(dpi, 6))] + mode_args
-
-    with TemporaryDirectory() as tmpdir:
-        input_pnm, output_pnm = _setup_unpaper_io(Path(tmpdir), input_file)
-
-        # To prevent any shenanigans from accepting arbitrary parameters in
-        # --unpaper-args, we:
-        # 1) run with cwd set to a tmpdir with only unpaper's files
-        # 2) forbid the use of '/' in arguments, to prevent changing paths
-        # 3) append absolute paths for the input and output file
-        # This should ensure that a user cannot clobber some other file with
-        # their unpaper arguments (whether intentionally or otherwise)
-        args_unpaper.extend([os.fspath(input_pnm), os.fspath(output_pnm)])
-        external_run(
-            args_unpaper,
-            close_fds=True,
-            check=True,
-            stderr=STDOUT,  # unpaper writes logging output to stdout and stderr
-            stdout=PIPE,  # and cannot send file output to stdout
-            cwd=tmpdir,
-            logs_errors_to_stdout=True,
-        )
-        try:
-            with Image.open(output_pnm) as imout:
-                imout.save(output_file, dpi=(dpi, dpi))
-        except (FileNotFoundError, OSError):
-            raise SubprocessOutputError(
-                "unpaper: failed to produce the expected output file. "
-                + " Called with: "
-                + str(args_unpaper)
-            ) from None
-
-
-def validate_custom_args(args: str) -> List[str]:
-    unpaper_args = shlex.split(args)
-    if any(('/' in arg or arg == '.' or arg == '..') for arg in unpaper_args):
-        raise ValueError('No filenames allowed in --unpaper-args')
-    return unpaper_args
-
-
-def clean(
-    input_file: Path,
-    output_file: Path,
-    *,
-    dpi: DecFloat,
-    unpaper_args: Optional[List[str]] = None,
-):
-    default_args = [
-        '--layout',
-        'none',
-        '--mask-scan-size',
-        '100',  # don't blank out narrow columns
-        '--no-border-align',  # don't align visible content to borders
-        '--no-mask-center',  # don't center visible content within page
-        '--no-grayfilter',  # don't remove light gray areas
-        '--no-blackfilter',  # don't remove solid black areas
-        '--no-deskew',  # don't deskew
-    ]
-    if not unpaper_args:
-        unpaper_args = default_args
-    run(input_file, output_file, dpi=dpi, mode_args=unpaper_args)

src/ocrmypdf/_graft.py

@@ -1,322 +0,0 @@
-# © 2018 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-
-import logging
-import uuid
-from contextlib import suppress
-from pathlib import Path
-from typing import Optional
-
-import pikepdf
-from pikepdf.objects import Dictionary, Name
-
-log = logging.getLogger(__name__)
-MAX_REPLACE_PAGES = 100
-
-
-def _ensure_dictionary(obj, name):
-    if name not in obj:
-        obj[name] = Dictionary({})
-    return obj[name]
-
-
-def _update_resources(*, obj, font, font_key, procset):
-    """Update this obj's fonts with a reference to the Glyphless font.
-
-    obj can be a page or Form XObject.
-    """
-
-    resources = _ensure_dictionary(obj, Name.Resources)
-    fonts = _ensure_dictionary(resources, Name.Font)
-    if font_key is not None and font_key not in fonts:
-        fonts[font_key] = font
-
-    # Reassign /ProcSet to one that just lists everything - ProcSet is
-    # obsolete and doesn't matter but recommended for old viewer support
-    if procset:
-        resources['/ProcSet'] = procset
-
-
-def strip_invisible_text(pdf, page):
-    stream = []
-    in_text_obj = False
-    render_mode = 0
-    text_objects = []
-
-    rich_page = pikepdf.Page(page)
-    rich_page.contents_coalesce()
-    for operands, operator in pikepdf.parse_content_stream(page, ''):
-        if not in_text_obj:
-            if operator == pikepdf.Operator('BT'):
-                in_text_obj = True
-                render_mode = 0
-                text_objects.append((operands, operator))
-            else:
-                stream.append((operands, operator))
-        else:
-            if operator == pikepdf.Operator('Tr'):
-                render_mode = operands[0]
-            text_objects.append((operands, operator))
-            if operator == pikepdf.Operator('ET'):
-                in_text_obj = False
-                if render_mode != 3:
-                    stream.extend(text_objects)
-                text_objects.clear()
-
-    def convert(op):
-        try:
-            return op.unparse()
-        except AttributeError:
-            return str(op).encode('ascii')
-
-    lines = []
-
-    for operands, operator in stream:
-        if operator == pikepdf.Operator('INLINE IMAGE'):
-            iim = operands[0]
-            line = iim.unparse()
-        else:
-            line = b' '.join(convert(op) for op in operands) + b' ' + operator.unparse()
-        lines.append(line)
-
-    content_stream = b'\n'.join(lines)
-    page.Contents = pikepdf.Stream(pdf, content_stream)
-
-
-class OcrGrafter:
-    def __init__(self, context):
-        self.context = context
-        self.path_base = context.origin
-
-        self.pdf_base = pikepdf.open(self.path_base)
-        self.font, self.font_key = None, None
-
-        self.pdfinfo = context.pdfinfo
-        self.output_file = context.get_path('graft_layers.pdf')
-
-        self.procset = self.pdf_base.make_indirect(
-            pikepdf.Object.parse(b'[ /PDF /Text /ImageB /ImageC /ImageI ]')
-        )
-
-        self.emplacements = 1
-        self.interim_count = 0
-
-    def graft_page(
-        self,
-        *,
-        pageno: int,
-        image: Optional[Path],
-        textpdf: Optional[Path],
-        autorotate_correction: int,
-    ):
-        if textpdf and not self.font:
-            self.font, self.font_key = self._find_font(textpdf)
-
-        emplaced_page = False
-        content_rotation = self.pdfinfo[pageno].rotation
-        path_image = Path(image).resolve() if image else None
-        if path_image is not None and path_image != self.path_base:
-            # We are updating the old page with a rasterized PDF of the new
-            # page (without changing objgen, to preserve references)
-            log.debug("Emplacement update")
-            with pikepdf.open(image) as pdf_image:
-                self.emplacements += 1
-                foreign_image_page = pdf_image.pages[0]
-                self.pdf_base.pages.append(foreign_image_page)
-                local_image_page = self.pdf_base.pages[-1]
-                self.pdf_base.pages[pageno].emplace(local_image_page)
-                del self.pdf_base.pages[-1]
-            emplaced_page = True
-
-        # Calculate if the text is misaligned compared to the content
-        if emplaced_page:
-            content_rotation = autorotate_correction
-        text_rotation = autorotate_correction
-        text_misaligned = (text_rotation - content_rotation) % 360
-        log.debug(
-            f"Text rotation: (text, autorotate, content) -> text misalignment = "
-            f"({text_rotation}, {autorotate_correction}, {content_rotation}) -> {text_misaligned}"
-        )
-
-        if textpdf and self.font:
-            # Graft the text layer onto this page, whether new or old, possibly
-            # rotating the text layer by the amount is misaligned.
-            strip_old = self.context.options.redo_ocr
-            self._graft_text_layer(
-                page_num=pageno + 1,
-                textpdf=textpdf,
-                font=self.font,
-                font_key=self.font_key,
-                text_rotation=text_misaligned,
-                procset=self.procset,
-                strip_old_text=strip_old,
-            )
-
-        # Correct the overall page rotation if needed, now that the text and content
-        # are aligned
-        page_rotation = (content_rotation - autorotate_correction) % 360
-        self.pdf_base.pages[pageno].Rotate = page_rotation
-        log.debug(
-            f"Page rotation: (content, auto) -> page = "
-            f"({content_rotation}, {autorotate_correction}) -> {page_rotation}"
-        )
-        if self.emplacements % MAX_REPLACE_PAGES == 0:
-            self.save_and_reload()
-
-    def save_and_reload(self):
-        """Save and reload the Pdf.
-
-        This will keep a lid on our memory usage for very large files. Attach
-        the font to page 1 even if page 1 doesn't use it, so we have a way to get it
-        back.
-        """
-
-        page0 = self.pdf_base.pages[0]
-        _update_resources(
-            obj=page0, font=self.font, font_key=self.font_key, procset=self.procset
-        )
-
-        # We cannot read and write the same file, that will corrupt it
-        # but we don't to keep more copies than we need to. Delete intermediates.
-        # {interim_count} is the opened file we were updating
-        # {interim_count - 1} can be deleted
-        # {interim_count + 1} is the new file will produce and open
-        old_file = self.output_file.with_suffix(f'.working{self.interim_count - 1}.pdf')
-        if not self.context.options.keep_temporary_files:
-            with suppress(FileNotFoundError):
-                old_file.unlink()
-
-        next_file = self.output_file.with_suffix(
-            f'.working{self.interim_count + 1}.pdf'
-        )
-        self.pdf_base.save(next_file)
-        self.pdf_base.close()
-
-        self.pdf_base = pikepdf.open(next_file)
-        self.procset = self.pdf_base.pages[0].Resources.ProcSet
-        self.font, self.font_key = None, None  # Ensure we reacquire this information
-        self.interim_count += 1
-
-    def finalize(self):
-        self.pdf_base.save(self.output_file)
-        self.pdf_base.close()
-        return self.output_file
-
-    def _find_font(self, text):
-        """Copy a font from the filename text into pdf_base"""
-
-        font, font_key = None, None
-        possible_font_names = ('/f-0-0', '/F1')
-        try:
-            with pikepdf.open(text) as pdf_text:
-                try:
-                    pdf_text_fonts = pdf_text.pages[0].Resources.get('/Font', {})
-                except (AttributeError, IndexError, KeyError):
-                    return None, None
-                pdf_text_font = None
-                for f in possible_font_names:
-                    pdf_text_font = pdf_text_fonts.get(f, None)
-                    if pdf_text_font is not None:
-                        font_key = f
-                        break
-                if pdf_text_font:
-                    font = self.pdf_base.copy_foreign(pdf_text_font)
-                return font, font_key
-        except (FileNotFoundError, pikepdf.PdfError):
-            # PdfError occurs if a 0-length file is written e.g. due to OCR timeout
-            return None, None
-
-    def _graft_text_layer(
-        self,
-        *,
-        page_num: int,
-        textpdf: Path,
-        font: pikepdf.Object,
-        font_key: pikepdf.Object,
-        procset: pikepdf.Object,
-        text_rotation: int,
-        strip_old_text: bool,
-    ):
-        """Insert the text layer from text page 0 on to pdf_base at page_num"""
-
-        log.debug("Grafting")
-        if Path(textpdf).stat().st_size == 0:
-            return
-
-        # This is a pointer indicating a specific page in the base file
-        with pikepdf.open(textpdf) as pdf_text:
-            pdf_text_contents = pdf_text.pages[0].Contents.read_bytes()
-
-            base_page = self.pdf_base.pages.p(page_num)
-
-            # The text page always will be oriented up by this stage but the original
-            # content may have a rotation applied. Wrap the text stream with a rotation
-            # so it will be oriented the same way as the rest of the page content.
-            # (Previous versions OCRmyPDF rotated the content layer to match the text.)
-            mediabox = [float(pdf_text.pages[0].MediaBox[v]) for v in range(4)]
-            wt, ht = mediabox[2] - mediabox[0], mediabox[3] - mediabox[1]
-
-            mediabox = [float(base_page.MediaBox[v]) for v in range(4)]
-            wp, hp = mediabox[2] - mediabox[0], mediabox[3] - mediabox[1]
-
-            translate = pikepdf.PdfMatrix().translated(-wt / 2, -ht / 2)
-            untranslate = pikepdf.PdfMatrix().translated(wp / 2, hp / 2)
-            corner = pikepdf.PdfMatrix().translated(mediabox[0], mediabox[1])
-            # -rotation because the input is a clockwise angle and this formula
-            # uses CCW
-            text_rotation = -text_rotation % 360
-            rotate = pikepdf.PdfMatrix().rotated(text_rotation)
-
-            # Because of rounding of DPI, we might get a text layer that is not
-            # identically sized to the target page. Scale to adjust. Normally this
-            # is within 0.998.
-            if text_rotation in (90, 270):
-                wt, ht = ht, wt
-            scale_x = wp / wt
-            scale_y = hp / ht
-
-            # log.debug('%r', scale_x, scale_y)
-            scale = pikepdf.PdfMatrix().scaled(scale_x, scale_y)
-
-            # Translate the text so it is centered at (0, 0), rotate it there, adjust
-            # for a size different between initial and text PDF, then untranslate, and
-            # finally move the lower left corner to match the mediabox
-            ctm = translate @ rotate @ scale @ untranslate @ corner
-
-            base_resources = _ensure_dictionary(base_page, Name.Resources)
-            base_xobjs = _ensure_dictionary(base_resources, Name.XObject)
-            text_xobj_name = Name('/' + str(uuid.uuid4()))
-            xobj = self.pdf_base.make_stream(pdf_text_contents)
-            base_xobjs[text_xobj_name] = xobj
-            xobj.Type = Name.XObject
-            xobj.Subtype = Name.Form
-            xobj.FormType = 1
-            xobj.BBox = mediabox
-            _update_resources(
-                obj=xobj, font=font, font_key=font_key, procset=[Name.PDF]
-            )
-
-            pdf_draw_xobj = (
-                (b'q %s cm\n' % ctm.encode()) + (b'%s Do\n' % text_xobj_name) + b'\nQ\n'
-            )
-            new_text_layer = pikepdf.Stream(self.pdf_base, pdf_draw_xobj)
-
-            if strip_old_text:
-                strip_invisible_text(self.pdf_base, base_page)
-
-            if hasattr(pikepdf.Page, 'contents_add'):
-                # pikepdf >= 2.14 adds this method and deprecates the one below
-                pikepdf.Page(base_page).contents_add(new_text_layer, prepend=True)
-            else:
-                # pikepdf < 2.14
-                base_page.page_contents_add(
-                    new_text_layer, prepend=True
-                )  # pragma: no cover
-
-            _update_resources(
-                obj=base_page, font=font, font_key=font_key, procset=procset
-            )

src/ocrmypdf/_jobcontext.py

@@ -1,103 +0,0 @@
-# © 2018 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-
-import os
-import shutil
-import sys
-from argparse import Namespace
-from copy import copy
-from pathlib import Path
-from typing import Iterator
-
-from pluggy import PluginManager
-
-from ocrmypdf.pdfinfo import PdfInfo
-from ocrmypdf.pdfinfo.info import PageInfo
-
-
-class PdfContext:
-    """Holds the context for a particular run of the pipeline."""
-
-    options: Namespace  #: The specified options for processing this PDF.
-    origin: Path  #: The filename of the original input file.
-    pdfinfo: PdfInfo  #: Detailed data for this PDF.
-    plugin_manager: PluginManager  #: PluginManager for processing the current PDF.
-
-    def __init__(
-        self,
-        options: Namespace,
-        work_folder: Path,
-        origin: Path,
-        pdfinfo: PdfInfo,
-        plugin_manager,
-    ):
-        self.options = options
-        self.work_folder = work_folder
-        self.origin = origin
-        self.pdfinfo = pdfinfo
-        self.plugin_manager = plugin_manager
-
-    def get_path(self, name: str) -> Path:
-        """Generate a ``Path`` for an intermediate file involved in processing.
-
-        The path will be in a temporary folder that is common for all processing
-        of this particular PDF.
-        """
-        return self.work_folder / name
-
-    def get_page_contexts(self) -> Iterator['PageContext']:
-        """Get all ``PageContext`` for this PDF."""
-        npages = len(self.pdfinfo)
-        for n in range(npages):
-            yield PageContext(self, n)
-
-
-class PageContext:
-    """Holds our context for a page.
-
-    Must be pickable, so stores only intrinsic/simple data elements or those
-    capable of their serializing themselves via ``__getstate__``.
-    """
-
-    options: Namespace  #: The specified options for processing this PDF.
-    origin: Path  #: The filename of the original input file.
-    pageno: int  #: This page number (zero-based).
-    pageinfo: PageInfo  #: Information on this page.
-    plugin_manager: PluginManager  #: PluginManager for processing the current PDF.
-
-    def __init__(self, pdf_context: PdfContext, pageno):
-        self.work_folder = pdf_context.work_folder
-        self.origin = pdf_context.origin
-        self.options = pdf_context.options
-        self.pageno = pageno
-        self.pageinfo = pdf_context.pdfinfo[pageno]
-        self.plugin_manager = pdf_context.plugin_manager
-
-    def get_path(self, name: str) -> Path:
-        """Generate a ``Path`` for a file that is part of processing this page.
-
-        The path will be based in a common temporary folder and have a prefix based
-        on the page number.
-        """
-        return self.work_folder / ("%06d_%s" % (self.pageno + 1, name))
-
-    def __getstate__(self):
-        state = self.__dict__.copy()
-
-        state['options'] = copy(self.options)
-        if not isinstance(state['options'].input_file, (str, bytes, os.PathLike)):
-            state['options'].input_file = 'stream'
-        if not isinstance(state['options'].output_file, (str, bytes, os.PathLike)):
-            state['options'].output_file = 'stream'
-        return state
-
-
-def cleanup_working_files(work_folder: Path, options: Namespace):
-    if options.keep_temporary_files:
-        print(f"Temporary working files retained at:\n{work_folder}", file=sys.stderr)
-    else:
-        shutil.rmtree(work_folder, ignore_errors=True)

src/ocrmypdf/_logging.py

@@ -1,50 +0,0 @@
-# © 2020 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-
-import logging
-import sys
-from contextlib import suppress
-
-from tqdm import tqdm
-
-
-class PageNumberFilter(logging.Filter):
-    def filter(self, record):
-        pageno = getattr(record, 'pageno', None)
-        if isinstance(pageno, int):
-            record.pageno = f'{pageno:5d} '
-        elif pageno is None:
-            record.pageno = ''
-        return True
-
-
-class TqdmConsole:
-    """Wrapper to log messages in a way that is compatible with tqdm progress bar
-
-    This routes log messages through tqdm so that it can print them above the
-    progress bar, and then refresh the progress bar, rather than overwriting
-    it which looks messy.
-
-    For some reason Python 3.6 prints extra empty messages from time to time,
-    so we suppress those.
-    """
-
-    def __init__(self, file):
-        self.file = file
-        self.py36 = sys.version_info[0:2] == (3, 6)
-
-    def write(self, msg):
-        # When no progress bar is active, tqdm.write() routes to print()
-        if self.py36:
-            if msg.strip() != '':
-                tqdm.write(msg.rstrip(), end='\n', file=self.file)
-        else:
-            tqdm.write(msg.rstrip(), end='\n', file=self.file)
-
-    def flush(self):
-        with suppress(AttributeError):
-            self.file.flush()

src/ocrmypdf/_pipeline.py

@@ -1,893 +0,0 @@
-# © 2016 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-
-import logging
-import os
-import re
-import sys
-from contextlib import suppress
-from datetime import datetime, timezone
-from pathlib import Path
-from shutil import copyfileobj
-from typing import Dict, Iterable, Optional
-
-import img2pdf
-import pikepdf
-from pikepdf.models.metadata import encode_pdf_date
-from PIL import Image, ImageColor, ImageDraw
-
-from ocrmypdf import leptonica
-from ocrmypdf._concurrent import Executor
-from ocrmypdf._exec import unpaper
-from ocrmypdf._jobcontext import PageContext, PdfContext
-from ocrmypdf._version import PROGRAM_NAME
-from ocrmypdf._version import __version__ as VERSION
-from ocrmypdf.exceptions import (
-    DpiError,
-    EncryptedPdfError,
-    InputFileError,
-    PriorOcrFoundError,
-    UnsupportedImageFormatError,
-)
-from ocrmypdf.helpers import Resolution, safe_symlink
-from ocrmypdf.hocrtransform import HocrTransform
-from ocrmypdf.optimize import optimize
-from ocrmypdf.pdfa import generate_pdfa_ps
-from ocrmypdf.pdfinfo import Colorspace, Encoding, PdfInfo
-
-log = logging.getLogger(__name__)
-
-VECTOR_PAGE_DPI = 400
-
-
-def triage_image_file(input_file, output_file, options):
-    log.info("Input file is not a PDF, checking if it is an image...")
-    try:
-        im = Image.open(input_file)
-    except EnvironmentError as e:
-        # Recover the original filename
-        log.error(str(e).replace(str(input_file), str(options.input_file)))
-        raise UnsupportedImageFormatError() from e
-
-    with im:
-        log.info("Input file is an image")
-        if 'dpi' in im.info:
-            if im.info['dpi'] <= (96, 96) and not options.image_dpi:
-                log.info("Image size: (%d, %d)", *im.size)
-                log.info("Image resolution: (%d, %d)", *im.info['dpi'])
-                log.error(
-                    "Input file is an image, but the resolution (DPI) is "
-                    "not credible.  Estimate the resolution at which the "
-                    "image was scanned and specify it using --image-dpi."
-                )
-                raise DpiError()
-        elif not options.image_dpi:
-            log.info("Image size: (%d, %d)", *im.size)
-            log.error(
-                "Input file is an image, but has no resolution (DPI) "
-                "in its metadata.  Estimate the resolution at which "
-                "image was scanned and specify it using --image-dpi."
-            )
-            raise DpiError()
-
-        if im.mode in ('RGBA', 'LA'):
-            log.error(
-                "The input image has an alpha channel. Remove the alpha "
-                "channel first."
-            )
-            raise UnsupportedImageFormatError()
-
-        if 'iccprofile' not in im.info:
-            if im.mode == 'RGB':
-                log.info("Input image has no ICC profile, assuming sRGB")
-            elif im.mode == 'CMYK':
-                log.error("Input CMYK image has no ICC profile, not usable")
-                raise UnsupportedImageFormatError()
-
-    try:
-        log.info("Image seems valid. Try converting to PDF...")
-        layout_fun = img2pdf.default_layout_fun
-        if options.image_dpi:
-            layout_fun = img2pdf.get_fixed_dpi_layout_fun(
-                Resolution(options.image_dpi, options.image_dpi)
-            )
-        with open(output_file, 'wb') as outf:
-            img2pdf.convert(
-                os.fspath(input_file),
-                layout_fun=layout_fun,
-                with_pdfrw=False,
-                outputstream=outf,
-            )
-        log.info("Successfully converted to PDF, processing...")
-    except img2pdf.ImageOpenError as e:
-        log.error(e)
-        raise UnsupportedImageFormatError() from e
-
-
-def _pdf_guess_version(input_file, search_window=1024):
-    """Try to find version signature at start of file.
-
-    Not robust enough to deal with appended files.
-
-    Returns empty string if not found, indicating file is probably not PDF.
-    """
-
-    with open(input_file, 'rb') as f:
-        signature = f.read(search_window)
-    m = re.search(br'%PDF-(\d\.\d)', signature)
-    if m:
-        return m.group(1)
-    return ''
-
-
-def triage(original_filename, input_file, output_file, options):
-    try:
-        if _pdf_guess_version(input_file):
-            if options.image_dpi:
-                log.warning(
-                    "Argument --image-dpi is being ignored because the "
-                    "input file is a PDF, not an image."
-                )
-            # Origin file is a pdf create a symlink with pdf extension
-            safe_symlink(input_file, output_file)
-            return output_file
-    except EnvironmentError as e:
-        log.debug(f"Temporary file was at: {input_file}")
-        msg = str(e).replace(str(input_file), original_filename)
-        raise InputFileError(msg) from e
-
-    triage_image_file(input_file, output_file, options)
-    return output_file
-
-
-def get_pdfinfo(
-    input_file,
-    *,
-    executor: Executor,
-    detailed_analysis=False,
-    progbar=False,
-    max_workers=None,
-    check_pages=None,
-) -> PdfInfo:
-    try:
-        return PdfInfo(
-            input_file,
-            detailed_analysis=detailed_analysis,
-            progbar=progbar,
-            max_workers=max_workers,
-            check_pages=check_pages,
-            executor=executor,
-        )
-    except pikepdf.PasswordError as e:
-        raise EncryptedPdfError() from e
-    except pikepdf.PdfError as e:
-        raise InputFileError() from e
-
-
-def validate_pdfinfo_options(context: PdfContext):
-    pdfinfo = context.pdfinfo
-    options = context.options
-
-    if pdfinfo.needs_rendering:
-        log.error(
-            "This PDF contains dynamic XFA forms created by Adobe LiveCycle "
-            "Designer and can only be read by Adobe Acrobat or Adobe Reader."
-        )
-        raise InputFileError()
-    if pdfinfo.has_userunit and options.output_type.startswith('pdfa'):
-        log.error(
-            "This input file uses a PDF feature that is not supported "
-            "by Ghostscript, so you cannot use --output-type=pdfa for this "
-            "file. (Specifically, it uses the PDF-1.6 /UserUnit feature to "
-            "support very large or small page sizes, and Ghostscript cannot "
-            "output these files.)  Use --output-type=pdf instead."
-        )
-        raise InputFileError()
-    if pdfinfo.has_acroform:
-        if options.redo_ocr:
-            log.error(
-                "This PDF has a user fillable form. --redo-ocr is not "
-                "currently possible on such files."
-            )
-            raise InputFileError()
-        else:
-            log.warning(
-                "This PDF has a fillable form. "
-                "Chances are it is a pure digital "
-                "document that does not need OCR."
-            )
-            if not options.force_ocr:
-                log.info(
-                    "Use the option --force-ocr to produce an image of the "
-                    "form and all filled form fields. The output PDF will be "
-                    "'flattened' and will no longer be fillable."
-                )
-    context.plugin_manager.hook.validate(pdfinfo=pdfinfo, options=options)
-
-
-def _vector_page_dpi(pageinfo):
-    return VECTOR_PAGE_DPI if pageinfo.has_vector or pageinfo.has_text else 0.0
-
-
-def get_page_dpi(pageinfo, options):
-    "Get the DPI when nonsquare DPI is tolerable"
-    xres = max(
-        pageinfo.dpi.x or VECTOR_PAGE_DPI,
-        options.oversample or 0.0,
-        _vector_page_dpi(pageinfo),
-    )
-    yres = max(
-        pageinfo.dpi.y or VECTOR_PAGE_DPI,
-        options.oversample or 0,
-        _vector_page_dpi(pageinfo),
-    )
-    return Resolution(float(xres), float(yres))
-
-
-def get_page_square_dpi(pageinfo, options) -> Resolution:
-    "Get the DPI when we require xres == yres, scaled to physical units"
-    xres = pageinfo.dpi.x or 0.0
-    yres = pageinfo.dpi.y or 0.0
-    userunit = float(pageinfo.userunit) or 1.0
-    units = float(
-        max(
-            (xres * userunit) or VECTOR_PAGE_DPI,
-            (yres * userunit) or VECTOR_PAGE_DPI,
-            _vector_page_dpi(pageinfo),
-            options.oversample or 0.0,
-        )
-    )
-    return Resolution(units, units)
-
-
-def get_canvas_square_dpi(pageinfo, options) -> Resolution:
-    """Get the DPI when we require xres == yres, in Postscript units"""
-    units = float(
-        max(
-            (pageinfo.dpi.x) or VECTOR_PAGE_DPI,
-            (pageinfo.dpi.y) or VECTOR_PAGE_DPI,
-            _vector_page_dpi(pageinfo),
-            options.oversample or 0.0,
-        )
-    )
-    return Resolution(units, units)
-
-
-def is_ocr_required(page_context: PageContext):
-    pageinfo = page_context.pageinfo
-    options = page_context.options
-
-    ocr_required = True
-
-    if options.pages and pageinfo.pageno not in options.pages:
-        log.debug(f"skipped {pageinfo.pageno} as requested by --pages {options.pages}")
-        ocr_required = False
-    elif pageinfo.has_text:
-        if not options.force_ocr and not (options.skip_text or options.redo_ocr):
-            raise PriorOcrFoundError(
-                "page already has text! - aborting (use --force-ocr to force OCR; "
-                " see also help for the arguments --skip-text and --redo-ocr"
-            )
-        elif options.force_ocr:
-            log.info("page already has text! - rasterizing text and running OCR anyway")
-            ocr_required = True
-        elif options.redo_ocr:
-            if pageinfo.has_corrupt_text:
-                log.warning(
-                    "some text on this page cannot be mapped to characters: "
-                    "consider using --force-ocr instead"
-                )
-            else:
-                log.info("redoing OCR")
-            ocr_required = True
-        elif options.skip_text:
-            log.info("skipping all processing on this page")
-            ocr_required = False
-    elif not pageinfo.images and not options.lossless_reconstruction:
-        # We found a page with no images and no text. That means it may
-        # have vector art that the user wants to OCR. If we determined
-        # lossless reconstruction is not possible then we have to rasterize
-        # the image. So if OCR is being forced, take that to mean YES, go
-        # ahead and rasterize. If not forced, then pretend there's no text
-        # on the page at all so we don't lose anything.
-        # This could be made smarter by explicitly searching for vector art.
-        if options.force_ocr and options.oversample:
-            # The user really wants to reprocess this file
-            log.info(
-                "page has no images - "
-                f"rasterizing at {options.oversample} DPI because "
-                "--force-ocr --oversample was specified"
-            )
-        elif options.force_ocr:
-            # Warn the user they might not want to do this
-            log.warning(
-                "page has no images - "
-                "all vector content will be "
-                f"rasterized at {VECTOR_PAGE_DPI} DPI, losing some resolution and likely "
-                "increasing file size. Use --oversample to adjust the "
-                "DPI."
-            )
-        else:
-            log.info(
-                "page has no images - "
-                "skipping all processing on this page to avoid losing detail. "
-                "Use --force-ocr if you wish to perform OCR on pages that "
-                "have vector content."
-            )
-            ocr_required = False
-
-    if ocr_required and options.skip_big and pageinfo.images:
-        pixel_count = pageinfo.width_pixels * pageinfo.height_pixels
-        if pixel_count > (options.skip_big * 1_000_000):
-            ocr_required = False
-            log.warning(
-                "page too big, skipping OCR "
-                f"({(pixel_count / 1_000_000):.1f} MPixels > {options.skip_big:.1f} MPixels --skip-big)"
-            )
-    return ocr_required
-
-
-def rasterize_preview(input_file: Path, page_context: PageContext):
-    output_file = page_context.get_path('rasterize_preview.jpg')
-    canvas_dpi = get_canvas_square_dpi(page_context.pageinfo, page_context.options)
-    page_dpi = get_page_square_dpi(page_context.pageinfo, page_context.options)
-    page_context.plugin_manager.hook.rasterize_pdf_page(
-        input_file=input_file,
-        output_file=output_file,
-        raster_device='jpeggray',
-        raster_dpi=canvas_dpi,
-        pageno=page_context.pageinfo.pageno + 1,
-        page_dpi=page_dpi,
-        rotation=0,
-        filter_vector=False,
-    )
-    return output_file
-
-
-def describe_rotation(page_context: PageContext, orient_conf, correction: int):
-    """
-    Describe the page rotation we are going to perform.
-    """
-    direction = {0: '⇧', 90: '⇨', 180: '⇩', 270: '⇦'}
-    turns = {0: ' ', 90: '⬏', 180: '↻', 270: '⬑'}
-
-    existing_rotation = page_context.pageinfo.rotation
-    action = ''
-    if orient_conf.confidence >= page_context.options.rotate_pages_threshold:
-        if correction != 0:
-            action = 'will rotate ' + turns[correction]
-        else:
-            action = 'rotation appears correct'
-    else:
-        if correction != 0:
-            action = 'confidence too low to rotate'
-        else:
-            action = 'no change'
-
-    facing = ''
-
-    if existing_rotation != 0:
-        facing = f"with existing rotation {direction.get(existing_rotation, '?')}, "
-    facing += f"page is facing {direction.get(orient_conf.angle, '?')}"
-
-    return f"{facing}, confidence {orient_conf.confidence:.2f} - {action}"
-
-
-def get_orientation_correction(preview: Path, page_context: PageContext):
-    """Work out orientation correct for each page.
-
-    We ask Ghostscript to draw a preview page, which will rasterize with the
-    current /Rotate applied, and then ask OCR which way the page is
-    oriented. If the value of /Rotate is correct (e.g., a user already
-    manually fixed rotation), then OCR will say the page is pointing
-    up and the correction is zero. Otherwise, the orientation found by
-    OCR represents the clockwise rotation, or the counterclockwise
-    correction to rotation.
-
-    When we draw the real page for OCR, we rotate it by the CCW correction,
-    which points it (hopefully) upright. _graft.py takes care of the orienting
-    the image and text layers.
-    """
-
-    orient_conf = page_context.plugin_manager.hook.get_ocr_engine().get_orientation(
-        preview, page_context.options
-    )
-
-    correction = orient_conf.angle % 360
-    log.info(describe_rotation(page_context, orient_conf, correction))
-    if (
-        orient_conf.confidence >= page_context.options.rotate_pages_threshold
-        and correction != 0
-    ):
-        return correction
-
-    return 0
-
-
-def rasterize(
-    input_file: Path,
-    page_context: PageContext,
-    correction: int = 0,
-    output_tag: str = '',
-    remove_vectors=None,
-):
-    colorspaces = ['pngmono', 'pnggray', 'png256', 'png16m']
-    device_idx = 0
-
-    if remove_vectors is None:
-        remove_vectors = page_context.options.remove_vectors
-
-    output_file = page_context.get_path(f'rasterize{output_tag}.png')
-    pageinfo = page_context.pageinfo
-
-    def at_least(cs):
-        return max(device_idx, colorspaces.index(cs))
-
-    for image in pageinfo.images:
-        if image.type_ != 'image':
-            continue  # ignore masks
-        if image.bpc > 1:
-            if image.color == Colorspace.index:
-                device_idx = at_least('png256')
-            elif image.color == Colorspace.gray:
-                device_idx = at_least('pnggray')
-            else:
-                device_idx = at_least('png16m')
-
-    if pageinfo.has_vector:
-        device_idx = at_least('png16m')
-
-    device = colorspaces[device_idx]
-
-    log.debug(f"Rasterize with {device}, rotation {correction}")
-
-    # Produce the page image with square resolution or else deskew and OCR
-    # will not work properly.
-    canvas_dpi = get_canvas_square_dpi(pageinfo, page_context.options)
-    page_dpi = get_page_square_dpi(pageinfo, page_context.options)
-
-    page_context.plugin_manager.hook.rasterize_pdf_page(
-        input_file=input_file,
-        output_file=output_file,
-        raster_device=device,
-        raster_dpi=canvas_dpi,
-        page_dpi=page_dpi,
-        pageno=pageinfo.pageno + 1,
-        rotation=correction,
-        filter_vector=remove_vectors,
-    )
-    return output_file
-
-
-def preprocess_remove_background(input_file: Path, page_context: PageContext):
-    if any(image.bpc > 1 for image in page_context.pageinfo.images):
-        output_file = page_context.get_path('pp_rm_bg.png')
-        leptonica.remove_background(input_file, output_file)
-        return output_file
-    else:
-        log.info("background removal skipped on mono page")
-        return input_file
-
-
-def preprocess_deskew(input_file: Path, page_context: PageContext):
-    output_file = page_context.get_path('pp_deskew.png')
-    dpi = get_page_square_dpi(page_context.pageinfo, page_context.options)
-    leptonica.deskew(input_file, output_file, dpi.x)
-    return output_file
-
-
-def preprocess_clean(input_file: Path, page_context: PageContext):
-    output_file = page_context.get_path('pp_clean.png')
-    dpi = get_page_square_dpi(page_context.pageinfo, page_context.options)
-    unpaper.clean(
-        input_file,
-        output_file,
-        dpi=dpi.x,
-        unpaper_args=page_context.options.unpaper_args,
-    )
-    return output_file
-
-
-def create_ocr_image(image: Path, page_context: PageContext):
-    """Create the image we send for OCR. May not be the same as the display
-    image depending on preprocessing. This image will never be shown to the
-    user."""
-
-    output_file = page_context.get_path('ocr.png')
-    options = page_context.options
-    with Image.open(image) as im:
-        white = ImageColor.getcolor('#ffffff', im.mode)
-        # pink = ImageColor.getcolor('#ff0080', im.mode)
-        draw = ImageDraw.ImageDraw(im)
-
-        log.debug('resolution %r', im.info['dpi'])
-
-        if not options.force_ocr:
-            # Do not mask text areas when forcing OCR, because we need to OCR
-            # all text areas
-            mask = None  # Exclude both visible and invisible text from OCR
-            if options.redo_ocr:
-                mask = True  # Mask visible text, but not invisible text
-
-            for textarea in page_context.pageinfo.get_textareas(
-                visible=mask, corrupt=None
-            ):
-                # Calculate resolution based on the image size and page dimensions
-                # without regard whatever resolution is in pageinfo (may differ or
-                # be None)
-                bbox = [float(v) for v in textarea]
-                xyscale = tuple(float(coord) / 72.0 for coord in im.info['dpi'])
-                pixcoords = [
-                    bbox[0] * xyscale[0],
-                    im.height - bbox[3] * xyscale[1],
-                    bbox[2] * xyscale[0],
-                    im.height - bbox[1] * xyscale[1],
-                ]
-                pixcoords = [int(round(c)) for c in pixcoords]
-                log.debug('blanking %r', pixcoords)
-                draw.rectangle(pixcoords, fill=white)
-                # draw.rectangle(pixcoords, outline=pink)
-
-        if options.threshold:
-            pix = leptonica.Pix.frompil(im)
-            pix = pix.masked_threshold_on_background_norm()
-            im_pix = pix.topil()
-            im_pix.info['dpi'] = im.info['dpi']
-            im = im_pix
-
-        del draw
-
-        filter_im = page_context.plugin_manager.hook.filter_ocr_image(
-            page=page_context, image=im
-        )
-        if filter_im is not None:
-            im = filter_im
-
-        # Pillow requires integer DPI
-        dpi = tuple(round(coord) for coord in im.info['dpi'])
-        im.save(output_file, dpi=dpi)
-    return output_file
-
-
-def ocr_engine_hocr(input_file: Path, page_context: PageContext):
-    hocr_out = page_context.get_path('ocr_hocr.hocr')
-    hocr_text_out = page_context.get_path('ocr_hocr.txt')
-    options = page_context.options
-
-    ocr_engine = page_context.plugin_manager.hook.get_ocr_engine()
-    ocr_engine.generate_hocr(
-        input_file=input_file,
-        output_hocr=hocr_out,
-        output_text=hocr_text_out,
-        options=options,
-    )
-    return (hocr_out, hocr_text_out)
-
-
-def should_visible_page_image_use_jpg(pageinfo):
-    # If all images were JPEGs originally, produce a JPEG as output
-    return pageinfo.images and all(im.enc == Encoding.jpeg for im in pageinfo.images)
-
-
-def create_visible_page_jpg(image: Path, page_context: PageContext) -> Path:
-    output_file = page_context.get_path('visible.jpg')
-    with Image.open(image) as im:
-        # At this point the image should be a .png, but deskew, unpaper
-        # might have removed the DPI information. In this case, fall back to
-        # square DPI used to rasterize. When the preview image was
-        # rasterized, it was also converted to square resolution, which is
-        # what we want to give to the OCR engine, so keep it square.
-        if 'dpi' in im.info:
-            dpi = Resolution(*im.info['dpi'])
-        else:
-            # Fallback to page-implied DPI
-            dpi = get_page_square_dpi(page_context.pageinfo, page_context.options)
-
-        # Pillow requires integer DPI
-        im.save(output_file, format='JPEG', dpi=dpi.to_int())
-    return output_file
-
-
-def create_pdf_page_from_image(
-    image: Path, page_context: PageContext, orientation_correction
-):
-    # We rasterize a square DPI version of each page because most image
-    # processing tools don't support rectangular DPI. Use the square DPI as it
-    # accurately describes the image. It would be possible to resample the image
-    # at this stage back to non-square DPI to more closely resemble the input,
-    # except that the hocr renderer does not understand non-square DPI. The
-    # sandwich renderer would be fine.
-    output_file = page_context.get_path('visible.pdf')
-
-    pageinfo = page_context.pageinfo
-    pagesize = 72.0 * float(pageinfo.width_inches), 72.0 * float(pageinfo.height_inches)
-    effective_rotation = (pageinfo.rotation - orientation_correction) % 360
-    if effective_rotation % 180 == 90:
-        pagesize = pagesize[1], pagesize[0]
-
-    # This create a single page PDF
-    with open(image, 'rb') as imfile, open(output_file, 'wb') as pdf:
-        log.debug('convert')
-
-        layout_fun = img2pdf.get_layout_fun(pagesize)
-        img2pdf.convert(
-            imfile, with_pdfrw=False, layout_fun=layout_fun, outputstream=pdf
-        )
-        log.debug('convert done')
-
-    output_file = page_context.plugin_manager.hook.filter_pdf_page(
-        page=page_context, image_filename=image, output_pdf=output_file
-    )
-
-    return output_file
-
-
-def render_hocr_page(hocr: Path, page_context: PageContext):
-    options = page_context.options
-    output_file = page_context.get_path('ocr_hocr.pdf')
-    dpi = get_page_square_dpi(page_context.pageinfo, options)
-    debug_mode = options.pdf_renderer == 'hocrdebug'
-
-    hocrtransform = HocrTransform(hocr_filename=hocr, dpi=dpi.x)  # square
-    hocrtransform.to_pdf(
-        out_filename=output_file,
-        image_filename=None,
-        show_bounding_boxes=False if not debug_mode else True,
-        invisible_text=True if not debug_mode else False,
-        interword_spaces=True,
-    )
-    return output_file
-
-
-def ocr_engine_textonly_pdf(input_image: Path, page_context: PageContext):
-    output_pdf = page_context.get_path('ocr_tess.pdf')
-    output_text = page_context.get_path('ocr_tess.txt')
-    options = page_context.options
-
-    ocr_engine = page_context.plugin_manager.hook.get_ocr_engine()
-    ocr_engine.generate_pdf(
-        input_file=input_image,
-        output_pdf=output_pdf,
-        output_text=output_text,
-        options=options,
-    )
-    return (output_pdf, output_text)
-
-
-def get_docinfo(base_pdf: pikepdf.Pdf, context: PdfContext) -> Dict[str, str]:
-    options = context.options
-
-    def from_document_info(key):
-        try:
-            s = base_pdf.docinfo[key]
-            return str(s)
-        except (KeyError, TypeError):
-            return ''
-
-    pdfmark = {
-        k: from_document_info(k)
-        for k in ('/Title', '/Author', '/Keywords', '/Subject', '/CreationDate')
-    }
-    if options is not None:
-        if options.title:
-            pdfmark['/Title'] = options.title
-        if options.author:
-            pdfmark['/Author'] = options.author
-        if options.keywords:
-            pdfmark['/Keywords'] = options.keywords
-        if options.subject:
-            pdfmark['/Subject'] = options.subject
-
-    creator_tag = context.plugin_manager.hook.get_ocr_engine().creator_tag(options)
-
-    pdfmark['/Creator'] = f'{PROGRAM_NAME} {VERSION} / {creator_tag}'
-    pdfmark['/Producer'] = f'pikepdf {pikepdf.__version__}'
-    pdfmark['/ModDate'] = encode_pdf_date(datetime.now(timezone.utc))
-    return pdfmark
-
-
-def generate_postscript_stub(context: PdfContext):
-    output_file = context.get_path('pdfa.ps')
-    generate_pdfa_ps(output_file)
-    return output_file
-
-
-def convert_to_pdfa(input_pdf: Path, input_ps_stub: Path, context: PdfContext):
-    options = context.options
-    input_pdfinfo = context.pdfinfo
-    fix_docinfo_file = context.get_path('fix_docinfo.pdf')
-    output_file = context.get_path('pdfa.pdf')
-
-    # If the DocumentInfo record contains NUL characters, Ghostscript will
-    # produce XMP metadata which contains invalid XML entities (&#0;).
-    # NULs in DocumentInfo seem to be common since older Acrobats included them.
-    # pikepdf can deal with this, but we make the world a better place by
-    # stamping them out as soon as possible.
-    modified = False
-    with pikepdf.open(input_pdf) as pdf_file:
-        try:
-            len(pdf_file.docinfo)
-        except TypeError:
-            log.error(
-                "File contains a malformed DocumentInfo block - continuing anyway"
-            )
-        else:
-            if pdf_file.docinfo:
-                for k, v in pdf_file.docinfo.items():
-                    if b'\x00' in bytes(v):
-                        pdf_file.docinfo[k] = bytes(v).replace(b'\x00', b'')
-                        modified = True
-        if modified:
-            pdf_file.save(fix_docinfo_file)
-        else:
-            safe_symlink(input_pdf, fix_docinfo_file)
-
-    context.plugin_manager.hook.generate_pdfa(
-        pdf_version=input_pdfinfo.min_version,
-        pdf_pages=[fix_docinfo_file],
-        pdfmark=input_ps_stub,
-        output_file=output_file,
-        compression=options.pdfa_image_compression,
-        pdfa_part=options.output_type[-1],  # is pdfa-1, pdfa-2, or pdfa-3
-        progressbar_class=(
-            context.plugin_manager.hook.get_progressbar_class()
-            if options.progress_bar
-            else None
-        ),
-    )
-
-    return output_file
-
-
-def should_linearize(working_file: Path, context: PdfContext):
-    filesize = os.stat(working_file).st_size
-    if filesize > (context.options.fast_web_view * 1_000_000):
-        return True
-    return False
-
-
-def get_pdf_save_settings(output_type: str):
-    if output_type == 'pdfa-1':
-        # Trigger recompression to ensure object streams are removed, because
-        # Acrobat complains about them in PDF/A-1b validation.
-        return dict(
-            preserve_pdfa=True,
-            compress_streams=True,
-            stream_decode_level=pikepdf.StreamDecodeLevel.generalized,
-            object_stream_mode=pikepdf.ObjectStreamMode.disable,
-        )
-    else:
-        return dict(
-            preserve_pdfa=True,
-            compress_streams=True,
-            object_stream_mode=(pikepdf.ObjectStreamMode.generate),
-        )
-
-
-def metadata_fixup(working_file: Path, context: PdfContext):
-    output_file = context.get_path('metafix.pdf')
-    options = context.options
-
-    def report_on_metadata(missing):
-        if not missing:
-            return
-        if options.output_type.startswith('pdfa'):
-            log.warning(
-                "Some input metadata could not be copied because it is not "
-                "permitted in PDF/A. You may wish to examine the output "
-                "PDF's XMP metadata."
-            )
-            log.debug("The following metadata fields were not copied: %r", missing)
-        else:
-            log.error(
-                "Some input metadata could not be copied."
-                "You may wish to examine the output PDF's XMP metadata."
-            )
-            log.info("The following metadata fields were not copied: %r", missing)
-
-    with pikepdf.open(context.origin) as original, pikepdf.open(working_file) as pdf:
-        docinfo = get_docinfo(original, context)
-        with pdf.open_metadata() as meta:
-            meta.load_from_docinfo(docinfo, delete_missing=False, raise_failure=False)
-            # If xmp:CreateDate is missing, set it to the modify date to
-            # match Ghostscript, for consistency
-            if 'xmp:CreateDate' not in meta:
-                meta['xmp:CreateDate'] = meta.get('xmp:ModifyDate', '')
-
-            with original.open_metadata(
-                set_pikepdf_as_editor=False, update_docinfo=False, strict=False
-            ) as meta_original:
-                if meta.get('dc:title') == 'Untitled':
-                    # Ghostscript likes to set title to Untitled if omitted from input.
-                    # Reverse this, because PDF/A TechNote 0003:Metadata in PDF/A-1
-                    # and the XMP Spec do not make this recommendation.
-                    if 'dc:title' not in meta_original:
-                        del meta['dc:title']
-                missing = set(meta_original.keys()) - set(meta.keys())
-                report_on_metadata(missing)
-
-        pdf.save(
-            output_file,
-            **get_pdf_save_settings(options.output_type),
-            linearize=(  # Don't linearize if optimize() will be linearizing too
-                should_linearize(working_file, context)
-                if options.optimize == 0
-                else False
-            ),
-        )
-
-    return output_file
-
-
-def optimize_pdf(input_file: Path, context: PdfContext, executor: Executor):
-    output_file = context.get_path('optimize.pdf')
-    save_settings = dict(
-        linearize=should_linearize(input_file, context),
-        **get_pdf_save_settings(context.options.output_type),
-    )
-    optimize(input_file, output_file, context, save_settings, executor)
-    return output_file
-
-
-def enumerate_compress_ranges(iterable):
-    skipped_from, index = None, None
-    for index, txt_file in enumerate(iterable):
-        index += 1
-        if txt_file:
-            if skipped_from is not None:
-                yield (skipped_from, index - 1), None
-                skipped_from = None
-            yield (index, index), txt_file
-        else:
-            if skipped_from is None:
-                skipped_from = index
-    if skipped_from is not None:
-        yield (skipped_from, index), None
-
-
-def merge_sidecars(txt_files: Iterable[Optional[Path]], context: PdfContext):
-    output_file = context.get_path('sidecar.txt')
-    with open(output_file, 'w', encoding="utf-8") as stream:
-        for (frm, to), txt_file in enumerate_compress_ranges(txt_files):
-            if frm != 1:
-                stream.write('\f')  # Form feed between pages
-            if txt_file:
-                with open(txt_file, 'r', encoding="utf-8") as in_:
-                    txt = in_.read()
-                    # Some OCR engines (e.g. Tesseract v4 alpha) add form feeds
-                    # between pages, and some do not. For consistency, we ignore
-                    # any added by the OCR engine and them on our own.
-                    if txt.endswith('\f'):
-                        stream.write(txt[:-1])
-                    else:
-                        stream.write(txt)
-            else:
-                if frm != to:
-                    pages = f'{frm}-{to}'
-                else:
-                    pages = f'{frm}'
-                stream.write(f'[OCR skipped on page(s) {pages}]')
-    return output_file
-
-
-def copy_final(input_file, output_file, _context: PdfContext):
-    log.debug('%s -> %s', input_file, output_file)
-    with open(input_file, 'rb') as input_stream:
-        if output_file == '-':
-            copyfileobj(input_stream, sys.stdout.buffer)
-            sys.stdout.flush()
-        elif hasattr(output_file, 'writable'):
-            output_stream = output_file
-            copyfileobj(input_stream, output_stream)
-            with suppress(AttributeError):
-                output_stream.flush()
-        else:
-            # At this point we overwrite the output_file specified by the user
-            # use copyfileobj because then we use open() to create the file and
-            # get the appropriate umask, ownership, etc.
-            with open(output_file, 'wb') as output_stream:
-                copyfileobj(input_stream, output_stream)

src/ocrmypdf/_plugin_manager.py

@@ -1,122 +0,0 @@
-# © 2020 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-
-import argparse
-import importlib
-import importlib.util
-import pkgutil
-import sys
-from pathlib import Path
-from typing import List, Tuple, Union
-
-import pluggy
-
-import ocrmypdf.builtin_plugins
-from ocrmypdf import pluginspec
-from ocrmypdf.cli import get_parser, plugins_only_parser
-
-
-class OcrmypdfPluginManager(pluggy.PluginManager):
-    """pluggy.PluginManager that can fork.
-
-    Capable of reconstructing itself in child workers.
-
-    Arguments:
-        setup_func: callback that initializes the plugin manager with all
-            standard plugins
-    """
-
-    def __init__(
-        self,
-        *args,
-        plugins: List[Union[str, Path]],
-        builtins: bool = True,
-        **kwargs,
-    ):
-        self.__init_args = args
-        self.__init_kwargs = kwargs
-        self.__plugins = plugins
-        self.__builtins = builtins
-        super().__init__(*args, **kwargs)
-        self.setup_plugins()
-
-    def __getstate__(self):
-        state = dict(
-            init_args=self.__init_args,
-            plugins=self.__plugins,
-            builtins=self.__builtins,
-            init_kwargs=self.__init_kwargs,
-        )
-        return state
-
-    def __setstate__(self, state):
-        self.__init__(
-            *state['init_args'],
-            plugins=state['plugins'],
-            builtins=state['builtins'],
-            **state['init_kwargs'],
-        )
-
-    def setup_plugins(self):
-        self.add_hookspecs(pluginspec)
-
-        # 1. Register builtins
-        if self.__builtins:
-            for module in sorted(
-                pkgutil.iter_modules(ocrmypdf.builtin_plugins.__path__)
-            ):
-                name = f'ocrmypdf.builtin_plugins.{module.name}'
-                module = importlib.import_module(name)
-                self.register(module)
-
-        # 2. Install semfree if needed
-        try:
-            # pylint: disable=import-outside-toplevel
-            from multiprocessing.synchronize import SemLock
-
-            del SemLock
-        except ImportError:
-            self.register(importlib.import_module('ocrmypdf.extra_plugins.semfree'))
-
-        # 3. Register setuptools plugins
-        self.load_setuptools_entrypoints('ocrmypdf')
-
-        # 4. Register plugins specified on command line
-        for name in self.__plugins:
-            if isinstance(name, Path) or name.endswith('.py'):
-                # Import by filename
-                module_name = Path(name).stem
-                spec = importlib.util.spec_from_file_location(module_name, name)
-                module = importlib.util.module_from_spec(spec)
-                sys.modules[module_name] = module
-                spec.loader.exec_module(module)
-            else:
-                # Import by dotted module name
-                module = importlib.import_module(name)
-            self.register(module)
-
-
-def get_plugin_manager(plugins: List[Union[str, Path]], builtins=True):
-    pm = OcrmypdfPluginManager(
-        project_name='ocrmypdf',
-        plugins=plugins,
-        builtins=builtins,
-    )
-    return pm
-
-
-def get_parser_options_plugins(
-    args,
-) -> Tuple[argparse.ArgumentParser, argparse.Namespace, pluggy.PluginManager]:
-    pre_options, _unused = plugins_only_parser.parse_known_args(args=args)
-    plugin_manager = get_plugin_manager(pre_options.plugins)
-
-    parser = get_parser()
-    plugin_manager.hook.add_options(parser=parser)  # pylint: disable=no-member
-
-    options = parser.parse_args(args=args)
-    return parser, options, plugin_manager

src/ocrmypdf/_sync.py

@@ -1,428 +0,0 @@
-# © 2016 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-
-import logging
-import logging.handlers
-import os
-import sys
-import threading
-from functools import partial
-from pathlib import Path
-from tempfile import mkdtemp
-from typing import List, NamedTuple, Optional, Tuple
-
-import PIL
-
-from ocrmypdf._concurrent import Executor, setup_executor
-from ocrmypdf._graft import OcrGrafter
-from ocrmypdf._jobcontext import PageContext, PdfContext, cleanup_working_files
-from ocrmypdf._logging import PageNumberFilter
-from ocrmypdf._pipeline import (
-    convert_to_pdfa,
-    copy_final,
-    create_ocr_image,
-    create_pdf_page_from_image,
-    create_visible_page_jpg,
-    generate_postscript_stub,
-    get_orientation_correction,
-    get_pdfinfo,
-    is_ocr_required,
-    merge_sidecars,
-    metadata_fixup,
-    ocr_engine_hocr,
-    ocr_engine_textonly_pdf,
-    optimize_pdf,
-    preprocess_clean,
-    preprocess_deskew,
-    preprocess_remove_background,
-    rasterize,
-    rasterize_preview,
-    render_hocr_page,
-    should_visible_page_image_use_jpg,
-    triage,
-    validate_pdfinfo_options,
-)
-from ocrmypdf._plugin_manager import get_plugin_manager
-from ocrmypdf._validation import (
-    check_requested_output_file,
-    create_input_file,
-    report_output_file_size,
-)
-from ocrmypdf.exceptions import ExitCode, ExitCodeException
-from ocrmypdf.helpers import (
-    NeverRaise,
-    available_cpu_count,
-    check_pdf,
-    pikepdf_enable_mmap,
-    samefile,
-)
-from ocrmypdf.pdfa import file_claims_pdfa
-
-log = logging.getLogger(__name__)
-
-
-class PageResult(NamedTuple):  # pylint: disable=inherit-non-class
-    pageno: int
-    pdf_page_from_image: Optional[Path]
-    ocr: Optional[Path]
-    text: Optional[Path]
-    orientation_correction: int
-
-
-tls = threading.local()
-tls.pageno = None
-
-
-old_factory = logging.getLogRecordFactory()
-
-
-def record_factory(*args, **kwargs):
-    record = old_factory(*args, **kwargs)
-    if hasattr(tls, 'pageno'):
-        record.pageno = tls.pageno
-    return record
-
-
-logging.setLogRecordFactory(record_factory)
-
-
-def preprocess(
-    page_context: PageContext,
-    image: Path,
-    remove_background: bool,
-    deskew: bool,
-    clean: bool,
-) -> Path:
-    if remove_background:
-        image = preprocess_remove_background(image, page_context)
-    if deskew:
-        image = preprocess_deskew(image, page_context)
-    if clean:
-        image = preprocess_clean(image, page_context)
-    return image
-
-
-def make_intermediate_images(
-    page_context: PageContext, orientation_correction: int
-) -> Tuple[Path, Optional[Path]]:
-    options = page_context.options
-
-    ocr_image = preprocess_out = None
-    rasterize_out = rasterize(
-        page_context.origin,
-        page_context,
-        correction=orientation_correction,
-        remove_vectors=False,
-    )
-
-    if not any([options.clean, options.clean_final, options.remove_vectors]):
-        ocr_image = preprocess_out = preprocess(
-            page_context,
-            rasterize_out,
-            options.remove_background,
-            options.deskew,
-            clean=False,
-        )
-    else:
-        if not options.lossless_reconstruction:
-            preprocess_out = preprocess(
-                page_context,
-                rasterize_out,
-                options.remove_background,
-                options.deskew,
-                clean=options.clean_final,
-            )
-        if options.remove_vectors:
-            rasterize_ocr_out = rasterize(
-                page_context.origin,
-                page_context,
-                correction=orientation_correction,
-                remove_vectors=True,
-                output_tag='_ocr',
-            )
-        else:
-            rasterize_ocr_out = rasterize_out
-
-        if (
-            preprocess_out
-            and rasterize_ocr_out == rasterize_out
-            and options.clean == options.clean_final
-        ):
-            # Optimization: image for OCR is identical to presentation image
-            ocr_image = preprocess_out
-        else:
-            ocr_image = preprocess(
-                page_context,
-                rasterize_ocr_out,
-                options.remove_background,
-                options.deskew,
-                clean=options.clean,
-            )
-    return ocr_image, preprocess_out
-
-
-def exec_page_sync(page_context: PageContext):
-    options = page_context.options
-    tls.pageno = page_context.pageno + 1
-
-    if not is_ocr_required(page_context):
-        return PageResult(
-            pageno=page_context.pageno,
-            pdf_page_from_image=None,
-            ocr=None,
-            text=None,
-            orientation_correction=0,
-        )
-
-    orientation_correction = 0
-    if options.rotate_pages:
-        # Rasterize
-        rasterize_preview_out = rasterize_preview(page_context.origin, page_context)
-        orientation_correction = get_orientation_correction(
-            rasterize_preview_out, page_context
-        )
-
-    ocr_image, preprocess_out = make_intermediate_images(
-        page_context, orientation_correction
-    )
-    ocr_image_out = create_ocr_image(ocr_image, page_context)
-
-    pdf_page_from_image_out = None
-    if not options.lossless_reconstruction:
-        assert preprocess_out
-        visible_image_out = preprocess_out
-        if should_visible_page_image_use_jpg(page_context.pageinfo):
-            visible_image_out = create_visible_page_jpg(visible_image_out, page_context)
-        filtered_image = page_context.plugin_manager.hook.filter_page_image(
-            page=page_context, image_filename=visible_image_out
-        )
-        if filtered_image:
-            visible_image_out = filtered_image
-        pdf_page_from_image_out = create_pdf_page_from_image(
-            visible_image_out, page_context, orientation_correction
-        )
-
-    if options.pdf_renderer.startswith('hocr'):
-        (hocr_out, text_out) = ocr_engine_hocr(ocr_image_out, page_context)
-        ocr_out = render_hocr_page(hocr_out, page_context)
-    elif options.pdf_renderer == 'sandwich':
-        (ocr_out, text_out) = ocr_engine_textonly_pdf(ocr_image_out, page_context)
-    else:
-        raise NotImplementedError(f"pdf_renderer {options.pdf_renderer}")
-
-    return PageResult(
-        pageno=page_context.pageno,
-        pdf_page_from_image=pdf_page_from_image_out,
-        ocr=ocr_out,
-        text=text_out,
-        orientation_correction=orientation_correction,
-    )
-
-
-def post_process(pdf_file, context: PdfContext, executor: Executor):
-    pdf_out = pdf_file
-    if context.options.output_type.startswith('pdfa'):
-        ps_stub_out = generate_postscript_stub(context)
-        pdf_out = convert_to_pdfa(pdf_out, ps_stub_out, context)
-
-    pdf_out = metadata_fixup(pdf_out, context)
-    return optimize_pdf(pdf_out, context, executor)
-
-
-def worker_init(max_pixels: int):
-    # In Windows, child process will not inherit our change to this value in
-    # the parent process, so ensure workers get it set. Not needed when running
-    # threaded, but harmless to set again.
-    PIL.Image.MAX_IMAGE_PIXELS = max_pixels
-    pikepdf_enable_mmap()
-
-
-def exec_concurrent(context: PdfContext, executor: Executor):
-    """Execute the pipeline concurrently"""
-
-    # Run exec_page_sync on every page context
-    options = context.options
-    max_workers = min(len(context.pdfinfo), options.jobs)
-    if max_workers > 1:
-        log.info("Start processing %d pages concurrently", max_workers)
-
-    sidecars: List[Optional[Path]] = [None] * len(context.pdfinfo)
-    ocrgraft = OcrGrafter(context)
-
-    def update_page(result: PageResult, pbar):
-        try:
-            tls.pageno = result.pageno + 1
-            sidecars[result.pageno] = result.text
-            pbar.update()
-            ocrgraft.graft_page(
-                pageno=result.pageno,
-                image=result.pdf_page_from_image,
-                textpdf=result.ocr,
-                autorotate_correction=result.orientation_correction,
-            )
-            pbar.update()
-        finally:
-            tls.pageno = None
-
-    executor(
-        use_threads=options.use_threads,
-        max_workers=max_workers,
-        tqdm_kwargs=dict(
-            total=(2 * len(context.pdfinfo)),
-            desc='OCR' if options.tesseract_timeout > 0 else 'Image processing',
-            unit='page',
-            unit_scale=0.5,
-            disable=not options.progress_bar,
-        ),
-        worker_initializer=partial(worker_init, PIL.Image.MAX_IMAGE_PIXELS),
-        task=exec_page_sync,
-        task_arguments=context.get_page_contexts(),
-        task_finished=update_page,
-    )
-
-    # Output sidecar text
-    if options.sidecar:
-        text = merge_sidecars(sidecars, context)
-        # Copy text file to destination
-        copy_final(text, options.sidecar, context)
-
-    # Merge layers to one single pdf
-    pdf = ocrgraft.finalize()
-
-    # PDF/A and metadata
-    log.info("Postprocessing...")
-    pdf = post_process(pdf, context, executor)
-
-    # Copy PDF file to destination
-    copy_final(pdf, options.output_file, context)
-
-
-def configure_debug_logging(log_filename: Path, prefix: str = ''):
-    """
-    Create a debug log file at a specified location.
-
-    Arguments:
-        log_filename: Where to the put the log file.
-        prefix: The logging domain prefix that should be sent to the log.
-    """
-    log_file_handler = logging.FileHandler(log_filename, delay=True)
-    log_file_handler.setLevel(logging.DEBUG)
-    formatter = logging.Formatter(
-        '[%(asctime)s] - %(name)s - %(levelname)7s -%(pageno)s %(message)s'
-    )
-    log_file_handler.setFormatter(formatter)
-    log_file_handler.addFilter(PageNumberFilter())
-    logging.getLogger(prefix).addHandler(log_file_handler)
-    return log_file_handler
-
-
-def run_pipeline(options, *, plugin_manager, api=False):
-    # Any changes to options will not take effect for options that are already
-    # bound to function parameters in the pipeline. (For example
-    # options.input_file, options.pdf_renderer are already bound.)
-    if not options.jobs:
-        options.jobs = available_cpu_count()
-    if not plugin_manager:
-        plugin_manager = get_plugin_manager(options.plugins)
-
-    work_folder = Path(mkdtemp(prefix="ocrmypdf.io."))
-    debug_log_handler = None
-    if (
-        (options.keep_temporary_files or options.verbose >= 1)
-        and not os.environ.get('PYTEST_CURRENT_TEST', '')
-        and not api
-    ):
-        # Debug log for command line interface only with verbose output
-        # See https://github.com/pytest-dev/pytest/issues/5502 for why we skip this
-        # when pytest is running
-        debug_log_handler = configure_debug_logging(
-            Path(work_folder) / "debug.log"
-        )  # pragma: no cover
-
-    pikepdf_enable_mmap()
-
-    executor = setup_executor(plugin_manager)
-    try:
-        check_requested_output_file(options)
-        start_input_file, original_filename = create_input_file(options, work_folder)
-
-        # Triage image or pdf
-        origin_pdf = triage(
-            original_filename, start_input_file, work_folder / 'origin.pdf', options
-        )
-
-        # Gather pdfinfo and create context
-        pdfinfo = get_pdfinfo(
-            origin_pdf,
-            executor=executor,
-            detailed_analysis=options.redo_ocr,
-            progbar=options.progress_bar,
-            max_workers=options.jobs if not options.use_threads else 1,  # To help debug
-            check_pages=options.pages,
-        )
-
-        context = PdfContext(options, work_folder, origin_pdf, pdfinfo, plugin_manager)
-
-        # Validate options are okay for this pdf
-        validate_pdfinfo_options(context)
-
-        # Execute the pipeline
-        exec_concurrent(context, executor)
-
-        if options.output_file == '-':
-            log.info("Output sent to stdout")
-        elif (
-            hasattr(options.output_file, 'writable') and options.output_file.writable()
-        ):
-            log.info("Output written to stream")
-        elif samefile(options.output_file, os.devnull):
-            pass  # Say nothing when sending to dev null
-        else:
-            if options.output_type.startswith('pdfa'):
-                pdfa_info = file_claims_pdfa(options.output_file)
-                if pdfa_info['pass']:
-                    log.info(
-                        "Output file is a %s (as expected)", pdfa_info['conformance']
-                    )
-                else:
-                    log.warning(
-                        "Output file is okay but is not PDF/A (seems to be %s)",
-                        pdfa_info['conformance'],
-                    )
-                    return ExitCode.pdfa_conversion_failed
-            if not check_pdf(options.output_file):
-                log.warning('Output file: The generated PDF is INVALID')
-                return ExitCode.invalid_output_pdf
-            report_output_file_size(options, start_input_file, options.output_file)
-
-    except (KeyboardInterrupt if not api else NeverRaise) as e:
-        if options.verbose >= 1:
-            log.exception("KeyboardInterrupt")
-        else:
-            log.error("KeyboardInterrupt")
-        return ExitCode.ctrl_c
-    except (ExitCodeException if not api else NeverRaise) as e:
-        if options.verbose >= 1:
-            log.exception("ExitCodeException")
-        elif str(e):
-            log.error("%s: %s", type(e).__name__, str(e))
-        else:
-            log.error(type(e).__name__)
-        return e.exit_code
-    except (Exception if not api else NeverRaise) as e:  # pylint: disable=broad-except
-        log.exception("An exception occurred while executing the pipeline")
-        return ExitCode.other_error
-    finally:
-        if debug_log_handler:
-            try:
-                debug_log_handler.close()
-                log.removeHandler(debug_log_handler)
-            except EnvironmentError as e:
-                print(e, file=sys.stderr)
-        cleanup_working_files(work_folder, options)
-
-    return ExitCode.ok

src/ocrmypdf/_unicodefun.py

@@ -33,12 +33,12 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
-import codecs
 import os
 import sys
+import codecs
 
 
-def verify_python3_env():  # pragma: no cover
+def verify_python3_env():
     """Ensures that the environment is good for unicode on Python 3."""
 
     # PEP 538 changes in Python 3.7 should make this wrangling unnecessary
@@ -47,7 +47,6 @@ def verify_python3_env():  # pragma: no cover
 
     try:
         import locale
-
         fs_enc = codecs.lookup(locale.getpreferredencoding()).name
     except Exception:
         fs_enc = 'ascii'
@@ -57,10 +56,8 @@ def verify_python3_env():  # pragma: no cover
     extra = ''
     if os.name == 'posix':
         import subprocess
-
-        rv = subprocess.run(
-            ['locale', '-a'], stdout=subprocess.PIPE, stderr=subprocess.PIPE
-        ).stdout
+        rv = subprocess.Popen(['locale', '-a'], stdout=subprocess.PIPE,
+                              stderr=subprocess.PIPE).communicate()[0]
         good_locales = set()
         has_c_utf8 = False
 
@@ -111,8 +108,6 @@ def verify_python3_env():  # pragma: no cover
                 'is not supported'
             ) % bad_locale
 
-    raise RuntimeError(
-        'ocrmypdf will abort further execution because Python 3 '
-        'was configured to use ASCII as encoding for the '
-        'environment.' + extra
-    )
+    raise RuntimeError('ocrmypdf will abort further execution because Python 3 '
+                       'was configured to use ASCII as encoding for the '
+                       'environment.' + extra)

src/ocrmypdf/_validation.py

@@ -1,432 +0,0 @@
-#!/usr/bin/env python3
-# © 2015-17 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-
-import locale
-import logging
-import os
-import sys
-import unicodedata
-from pathlib import Path
-from shutil import copyfileobj
-from typing import List, Set, Tuple, Union
-
-import pikepdf
-import PIL
-
-from ocrmypdf._exec import jbig2enc, pngquant, unpaper
-from ocrmypdf._unicodefun import verify_python3_env
-from ocrmypdf.exceptions import (
-    BadArgsError,
-    InputFileError,
-    MissingDependencyError,
-    OutputFileAccessError,
-)
-from ocrmypdf.helpers import (
-    is_file_writable,
-    is_iterable_notstr,
-    monotonic,
-    safe_symlink,
-)
-from ocrmypdf.hocrtransform import HOCR_OK_LANGS
-from ocrmypdf.subprocess import check_external_program
-
-# -------------
-# External dependencies
-
-DEFAULT_LANGUAGE = 'eng'  # Enforce English hegemony
-
-log = logging.getLogger(__name__)
-
-
-# --------
-# Critical environment tests
-verify_python3_env()
-
-
-def check_platform():
-    if os.name == 'nt' and sys.maxsize <= 2 ** 32:  # pragma: no cover
-        # 32-bit interpreter on Windows
-        log.error(
-            "You are running OCRmyPDF in a 32-bit (x86) Python interpreter."
-            "Please use a 64-bit (x86-64) version of Python."
-        )
-
-
-def check_options_languages(options, ocr_engine_languages):
-    if not options.languages:
-        options.languages = {DEFAULT_LANGUAGE}
-        system_lang = locale.getlocale()[0]
-        if system_lang and not system_lang.startswith('en'):
-            log.debug("No language specified; assuming --language %s", DEFAULT_LANGUAGE)
-    if not ocr_engine_languages:
-        return
-    missing_languages = options.languages - ocr_engine_languages
-    if missing_languages:
-        msg = (
-            f"OCR engine does not have language data for the following "
-            "requested languages: \n"
-        )
-        msg += '\n'.join(lang for lang in missing_languages)
-        msg += '\nNote: most languages are identified by a 3-digit ISO 639-2 Code'
-        raise MissingDependencyError(msg)
-
-
-def check_options_output(options):
-    is_latin = options.languages.issubset(HOCR_OK_LANGS)
-
-    if options.pdf_renderer.startswith('hocr') and not is_latin:
-        msg = (
-            "The 'hocr' PDF renderer is known to cause problems with one "
-            "or more of the languages in your document.  Use "
-            "--pdf-renderer auto (the default) to avoid this issue."
-        )
-        log.warning(msg)
-
-    lossless_reconstruction = False
-    if not any(
-        (
-            options.deskew,
-            options.clean_final,
-            options.force_ocr,
-            options.remove_background,
-        )
-    ):
-        lossless_reconstruction = True
-    options.lossless_reconstruction = lossless_reconstruction
-
-    if not options.lossless_reconstruction and options.redo_ocr:
-        raise BadArgsError(
-            "--redo-ocr is not currently compatible with --deskew, "
-            "--clean-final, and --remove-background"
-        )
-
-
-def check_options_sidecar(options):
-    if options.sidecar == '\0':
-        if options.output_file == '-':
-            raise BadArgsError(
-                "--sidecar filename must be specified when output file is stdout."
-            )
-        options.sidecar = options.output_file + '.txt'
-    if options.sidecar == options.input_file or options.sidecar == options.output_file:
-        raise BadArgsError(
-            "--sidecar file must be different from the input and output files"
-        )
-
-
-def check_options_preprocessing(options):
-    if options.clean_final:
-        options.clean = True
-    if options.unpaper_args and not options.clean:
-        raise BadArgsError("--clean is required for --unpaper-args")
-    if options.clean:
-        check_external_program(
-            program='unpaper',
-            package='unpaper',
-            version_checker=unpaper.version,
-            need_version='6.1',
-            required_for=['--clean, --clean-final'],
-        )
-        try:
-            if options.unpaper_args:
-                options.unpaper_args = unpaper.validate_custom_args(
-                    options.unpaper_args
-                )
-        except Exception as e:
-            raise BadArgsError("--unpaper-args: " + str(e)) from e
-
-
-def _pages_from_ranges(ranges: str) -> Set[int]:
-    if is_iterable_notstr(ranges):
-        return set(ranges)
-    pages: List[int] = []
-    page_groups = ranges.replace(' ', '').split(',')
-    for g in page_groups:
-        if not g:
-            continue
-        try:
-            start, end = g.split('-')
-        except ValueError:
-            pages.append(int(g) - 1)
-        else:
-            try:
-                new_pages = list(range(int(start) - 1, int(end)))
-                if not new_pages:
-                    raise BadArgsError(f"invalid page subrange '{start}-{end}'")
-                pages.extend(new_pages)
-            except ValueError:
-                raise BadArgsError("invalid page range") from None
-
-    if not pages:
-        raise BadArgsError(
-            f"The string of page ranges '{ranges}' did not contain any recognizable "
-            f"page ranges."
-        )
-
-    if not monotonic(pages):
-        log.warning(
-            "List of pages to process contains duplicate pages, or pages that are "
-            "out of order"
-        )
-    if any(page < 0 for page in pages):
-        raise BadArgsError("pages refers to a page number less than 1")
-
-    log.debug("OCRing only these pages: %s", pages)
-    return set(pages)
-
-
-def check_options_ocr_behavior(options):
-    exclusive_options = sum(
-        [
-            (1 if opt else 0)
-            for opt in (options.force_ocr, options.skip_text, options.redo_ocr)
-        ]
-    )
-    if exclusive_options >= 2:
-        raise BadArgsError("Choose only one of --force-ocr, --skip-text, --redo-ocr.")
-    if options.pages:
-        options.pages = _pages_from_ranges(options.pages)
-
-
-def check_options_optimizing(options):
-    if options.optimize >= 2:
-        check_external_program(
-            program='pngquant',
-            package='pngquant',
-            version_checker=pngquant.version,
-            need_version='2.0.1',
-            required_for='--optimize {2,3}',
-        )
-
-    if options.optimize >= 2:
-        # Although we use JBIG2 for optimize=1, don't nag about it unless the
-        # user is asking for more optimization
-        check_external_program(
-            program='jbig2',
-            package='jbig2enc',
-            version_checker=jbig2enc.version,
-            need_version='0.28',
-            required_for='--optimize {2,3} | --jbig2-lossy',
-            recommended=True if not options.jbig2_lossy else False,
-        )
-
-    if options.optimize == 0 and any(
-        [options.jbig2_lossy, options.png_quality, options.jpeg_quality]
-    ):
-        log.warning(
-            "The arguments --jbig2-lossy, --png-quality, and --jpeg-quality "
-            "will be ignored because --optimize=0."
-        )
-
-
-def check_options_advanced(options):
-    if options.pdfa_image_compression != 'auto' and not options.output_type.startswith(
-        'pdfa'
-    ):
-        log.warning(
-            "--pdfa-image-compression argument only applies when "
-            "--output-type is one of 'pdfa', 'pdfa-1', or 'pdfa-2'"
-        )
-
-
-def check_options_metadata(options):
-    docinfo = [options.title, options.author, options.keywords, options.subject]
-    for s in (m for m in docinfo if m):
-        for c in s:
-            if unicodedata.category(c) == 'Co' or ord(c) >= 0x10000:
-                raise ValueError(
-                    "One of the metadata strings contains "
-                    "an unsupported Unicode character: '{}' (U+{})".format(
-                        c, hex(ord(c))[2:].upper()
-                    )
-                )
-
-
-def check_options_pillow(options):
-    PIL.Image.MAX_IMAGE_PIXELS = int(options.max_image_mpixels * 1_000_000)
-    if PIL.Image.MAX_IMAGE_PIXELS == 0:
-        PIL.Image.MAX_IMAGE_PIXELS = None
-
-
-def _check_options(options, plugin_manager, ocr_engine_languages):
-    check_platform()
-    check_options_languages(options, ocr_engine_languages)
-    check_options_metadata(options)
-    check_options_output(options)
-    check_options_sidecar(options)
-    check_options_preprocessing(options)
-    check_options_ocr_behavior(options)
-    check_options_optimizing(options)
-    check_options_advanced(options)
-    check_options_pillow(options)
-    plugin_manager.hook.check_options(options=options)
-
-
-def check_options(options, plugin_manager):
-    ocr_engine_languages = plugin_manager.hook.get_ocr_engine().languages(options)
-    _check_options(options, plugin_manager, ocr_engine_languages)
-
-
-def check_closed_streams(options):  # pragma: no cover
-    """Work around Python issue with multiprocessing forking on closed streams
-
-    https://bugs.python.org/issue28326
-
-    Attempting to a fork/exec a new Python process when any of std{in,out,err}
-    are closed or not flushable for some reason may raise an exception.
-    Fix this by opening devnull if the handle seems to be closed.  Do this
-    globally to avoid tracking all places that fork.
-
-    Seems to be specific to multiprocessing.Process not all Python process
-    forkers.
-
-    The error actually occurs when the stream object is not flushable,
-    but replacing an open stream object that is not flushable with
-    /dev/null is a bad idea since it will create a silent failure.  Replacing
-    a closed handle with /dev/null seems safe.
-
-    """
-
-    if sys.version_info[0:3] >= (3, 6, 4):
-        return True  # Issued fixed in Python 3.6.4+
-
-    if sys.stderr is None:
-        sys.stderr = open(os.devnull, 'w')
-
-    if sys.stdin is None:
-        if options.input_file == '-':
-            log.error("Trying to read from stdin but stdin seems closed")
-            return False
-        sys.stdin = open(os.devnull, 'r')
-
-    if sys.stdout is None:
-        if options.output_file == '-':
-            # Can't replace stdout if the user is piping
-            # If this case can even happen, it must be some kind of weird
-            # stream.
-            log.error(
-                "Output was set to stdout '-' but the stream attached to "
-                "stdout does not support the flush() system call.  This "
-                "will fail."
-            )
-            return False
-        sys.stdout = open(os.devnull, 'w')
-
-    return True
-
-
-def create_input_file(options, work_folder: Path) -> Tuple[Path, str]:
-    if options.input_file == '-':
-        # stdin
-        log.info('reading file from standard input')
-        target = work_folder / 'stdin'
-        with open(target, 'wb') as stream_buffer:
-            copyfileobj(sys.stdin.buffer, stream_buffer)
-        return target, "stdin"
-    elif hasattr(options.input_file, 'readable'):
-        if not options.input_file.readable():
-            raise InputFileError("Input file stream is not readable")
-        log.info('reading file from input stream')
-        target = work_folder / 'stream'
-        with open(target, 'wb') as stream_buffer:
-            copyfileobj(options.input_file, stream_buffer)
-        return target, "stream"
-    else:
-        try:
-            target = work_folder / 'origin'
-            safe_symlink(options.input_file, target)
-            return target, os.fspath(options.input_file)
-        except FileNotFoundError:
-            msg = f"File not found - {options.input_file}"
-            if Path('/.dockerenv').exists():  # pragma: no cover
-                msg += (
-                    "\nDocker cannot your working directory unless you "
-                    "explicitly share it with the Docker container and set up"
-                    "permissions correctly.\n"
-                    "You may find it easier to use stdin/stdout:"
-                    "\n"
-                    "\tdocker run -i --rm jbarlow83/ocrmypdf - - <input.pdf >output.pdf\n"
-                )
-            raise InputFileError(msg)
-
-
-def check_requested_output_file(options):
-    if options.output_file == '-':
-        if sys.stdout.isatty():
-            raise BadArgsError(
-                "Output was set to stdout '-' but it looks like stdout "
-                "is connected to a terminal.  Please redirect stdout to a "
-                "file."
-            )
-    elif hasattr(options.output_file, 'writable'):
-        if not options.output_file.writable():
-            raise OutputFileAccessError("Output stream is not writable")
-    elif not is_file_writable(options.output_file):
-        raise OutputFileAccessError(
-            f"Output file location ({options.output_file}) is not a writable file."
-        )
-
-
-def report_output_file_size(options, input_file, output_file):
-    try:
-        output_size = Path(output_file).stat().st_size
-        input_size = Path(input_file).stat().st_size
-    except FileNotFoundError:
-        return  # Outputting to stream or something
-    with pikepdf.open(output_file) as p:
-        # Overhead constants obtained by estimating amount of data added by OCR
-        # PDF/A conversion, and possible XMP metadata addition, with compression
-        FILE_OVERHEAD = 4000
-        OCR_PER_PAGE_OVERHEAD = 3000
-        reasonable_overhead = FILE_OVERHEAD + OCR_PER_PAGE_OVERHEAD * len(p.pages)
-    ratio = output_size / input_size
-    reasonable_ratio = output_size / (input_size + reasonable_overhead)
-    if reasonable_ratio < 1.35 or input_size < 25000:
-        return  # Seems fine
-
-    reasons = []
-    image_preproc = {
-        'deskew',
-        'clean_final',
-        'remove_background',
-        'oversample',
-        'force_ocr',
-    }
-    for arg in image_preproc:
-        if getattr(options, arg, False):
-            reasons.append(
-                f"The argument --{arg.replace('_', '-')} was issued, causing transcoding."
-            )
-
-    if options.optimize == 0:
-        reasons.append("Optimization was disabled.")
-    else:
-        image_optimizers = {
-            'jbig2': jbig2enc.available(),
-            'pngquant': pngquant.available(),
-        }
-        for name, available in image_optimizers.items():
-            if not available:
-                reasons.append(
-                    f"The optional dependency '{name}' was not found, so some image "
-                    f"optimizations could not be attempted."
-                )
-    if options.output_type.startswith('pdfa'):
-        reasons.append("PDF/A conversion was enabled. (Try `--output-type pdf`.)")
-    if options.plugins:
-        reasons.append("Plugins were used.")
-
-    if reasons:
-        explanation = "Possible reasons for this include:\n" + '\n'.join(reasons) + "\n"
-    else:
-        explanation = "No reason for this increase is known.  Please report this issue."
-
-    log.warning(
-        f"The output file size is {ratio:.2f}× larger than the input file.\n"
-        f"{explanation}"
-    )

src/ocrmypdf/_version.py

@@ -1,13 +0,0 @@
-# © 2017 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-
-import pkg_resources
-
-PROGRAM_NAME = 'ocrmypdf'
-
-# Official PEP 396
-__version__ = pkg_resources.get_distribution('ocrmypdf').version

src/ocrmypdf/api.py

@@ -1,340 +0,0 @@
-# © 2019 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-
-import logging
-import os
-import sys
-import threading
-from enum import IntEnum
-from io import IOBase
-from pathlib import Path
-from typing import AnyStr, BinaryIO, Iterable, Optional, Union
-from warnings import warn
-
-from ocrmypdf._logging import (  # pylint: disable=unused-import
-    PageNumberFilter,
-    TqdmConsole,
-)
-from ocrmypdf._plugin_manager import get_plugin_manager
-from ocrmypdf._sync import run_pipeline
-from ocrmypdf._validation import check_options
-from ocrmypdf.cli import ArgumentParser, get_parser
-from ocrmypdf.helpers import is_iterable_notstr
-
-try:
-    import coloredlogs
-except ModuleNotFoundError:
-    coloredlogs = None
-
-
-StrPath = Union[os.PathLike, AnyStr]
-PathOrIO = Union[BinaryIO, StrPath]
-
-_api_lock = threading.Lock()
-
-
-class Verbosity(IntEnum):
-    """Verbosity level for configure_logging."""
-
-    quiet = -1  #: Suppress most messages
-    default = 0  #: Default level of logging
-    debug = 1  #: Output ocrmypdf debug messages
-    debug_all = 2  #: More detailed debugging from ocrmypdf and dependent modules
-
-
-def configure_logging(
-    verbosity: Verbosity,
-    *,
-    progress_bar_friendly: bool = True,
-    manage_root_logger: bool = False,
-    plugin_manager=None,
-):
-    """Set up logging.
-
-    Before calling :func:`ocrmypdf.ocr()`, you can use this function to
-    configure logging if you want ocrmypdf's output to look like the ocrmypdf
-    command line interface. It will register log handlers, log filters, and
-    formatters, configure color logging to standard error, and adjust the log
-    levels of third party libraries. Details of this are fine-tuned and subject
-    to change. The ``verbosity`` argument is equivalent to the argument
-    ``--verbose`` and applies those settings. If you have a wrapper
-    script for ocrmypdf and you want it to be very similar to ocrmypdf, use this
-    function; if you are using ocrmypdf as part of an application that manages
-    its own logging, you probably do not want this function.
-
-    If this function is not called, ocrmypdf will not configure logging, and it
-    is up to the caller of ``ocrmypdf.ocr()`` to set up logging as it wishes using
-    the Python standard library's logging module. If this function is called,
-    the caller may of course make further adjustments to logging.
-
-    Regardless of whether this function is called, ocrmypdf will perform all of
-    its logging under the ``"ocrmypdf"`` logging namespace. In addition,
-    ocrmypdf imports pdfminer, which logs under ``"pdfminer"``. A library user
-    may wish to configure both; note that pdfminer is extremely chatty at the
-    log level ``logging.INFO``.
-
-    This function does not set up the ``debug.log`` log file that the command
-    line interface does at certain verbosity levels. Applications should configure
-    their own debug logging.
-
-    Args:
-        verbosity: Verbosity level.
-        progress_bar_friendly: If True (the default), install a custom log handler
-            that is compatible with progress bars and colored output.
-        manage_root_logger: Configure the process's root logger.
-        plugin_manager: The plugin manager, used for obtaining the custom log handler.
-
-    Returns:
-        The toplevel logger for ocrmypdf (or the root logger, if we are managing it).
-    """
-
-    prefix = '' if manage_root_logger else 'ocrmypdf'
-
-    log = logging.getLogger(prefix)
-    log.setLevel(logging.DEBUG)
-
-    console = None
-    if plugin_manager and progress_bar_friendly:
-        console = plugin_manager.hook.get_logging_console()
-
-    if not console:
-        console = logging.StreamHandler(stream=sys.stderr)
-
-    if verbosity < 0:
-        console.setLevel(logging.ERROR)
-    elif verbosity >= 1:
-        console.setLevel(logging.DEBUG)
-    else:
-        console.setLevel(logging.INFO)
-
-    console.addFilter(PageNumberFilter())
-
-    if verbosity >= 2:
-        fmt = '%(levelname)7s %(name)s -%(pageno)s %(message)s'
-    else:
-        fmt = '%(pageno)s%(message)s'
-
-    use_colors = progress_bar_friendly
-    if not coloredlogs:
-        use_colors = False
-    if use_colors:
-        if os.name == 'nt':
-            use_colors = coloredlogs.enable_ansi_support()
-        if use_colors:
-            use_colors = coloredlogs.terminal_supports_colors()
-    if use_colors:
-        formatter = coloredlogs.ColoredFormatter(fmt=fmt)
-    else:
-        formatter = logging.Formatter(fmt=fmt)
-
-    console.setFormatter(formatter)
-    log.addHandler(console)
-
-    if verbosity <= 1:
-        pdfminer_log = logging.getLogger('pdfminer')
-        pdfminer_log.setLevel(logging.ERROR)
-        pil_log = logging.getLogger('PIL')
-        pil_log.setLevel(logging.INFO)
-
-    if manage_root_logger:
-        logging.captureWarnings(True)
-
-    return log
-
-
-def create_options(
-    *, input_file: PathOrIO, output_file: PathOrIO, parser: ArgumentParser, **kwargs
-):
-    cmdline = []
-    deferred = []
-
-    for arg, val in kwargs.items():
-        if val is None:
-            continue
-
-        # These arguments with special handling for which we bypass
-        # argparse
-        if arg in {'progress_bar', 'plugins'}:
-            deferred.append((arg, val))
-            continue
-
-        cmd_style_arg = arg.replace('_', '-')
-
-        # Booleans are special: add only if True, omit for False
-        if isinstance(val, bool):
-            if val:
-                cmdline.append(f"--{cmd_style_arg}")
-            continue
-
-        if is_iterable_notstr(val):
-            for elem in val:
-                cmdline.append(f"--{cmd_style_arg}")
-                cmdline.append(elem)
-            continue
-
-        # We have a parameter
-        cmdline.append(f"--{cmd_style_arg}")
-        if isinstance(val, (int, float)):
-            cmdline.append(str(val))
-        elif isinstance(val, str):
-            cmdline.append(val)
-        elif isinstance(val, Path):
-            cmdline.append(str(val))
-        else:
-            raise TypeError(f"{arg}: {val} ({type(val)})")
-
-    if isinstance(input_file, (BinaryIO, IOBase)):
-        cmdline.append('stream://input_file')
-    else:
-        cmdline.append(os.fspath(input_file))
-    if isinstance(output_file, (BinaryIO, IOBase)):
-        cmdline.append('stream://output_file')
-    else:
-        cmdline.append(os.fspath(output_file))
-
-    parser._api_mode = True
-    options = parser.parse_args(cmdline)
-    for keyword, val in deferred:
-        setattr(options, keyword, val)
-
-    if options.input_file == 'stream://input_file':
-        options.input_file = input_file
-    if options.output_file == 'stream://output_file':
-        options.output_file = output_file
-
-    return options
-
-
-def ocr(  # pylint: disable=unused-argument
-    input_file: PathOrIO,
-    output_file: PathOrIO,
-    *,
-    language: Iterable[str] = None,
-    image_dpi: int = None,
-    output_type=None,
-    sidecar: Optional[StrPath] = None,
-    jobs: int = None,
-    use_threads: bool = None,
-    title: str = None,
-    author: str = None,
-    subject: str = None,
-    keywords: str = None,
-    rotate_pages: bool = None,
-    remove_background: bool = None,
-    deskew: bool = None,
-    clean: bool = None,
-    clean_final: bool = None,
-    unpaper_args: str = None,
-    oversample: int = None,
-    remove_vectors: bool = None,
-    threshold: bool = None,
-    force_ocr: bool = None,
-    skip_text: bool = None,
-    redo_ocr: bool = None,
-    skip_big: float = None,
-    optimize: int = None,
-    jpg_quality: int = None,
-    png_quality: int = None,
-    jbig2_lossy: bool = None,
-    jbig2_page_group_size: int = None,
-    pages: str = None,
-    max_image_mpixels: float = None,
-    tesseract_config: Iterable[str] = None,
-    tesseract_pagesegmode: int = None,
-    tesseract_oem: int = None,
-    pdf_renderer=None,
-    tesseract_timeout: float = None,
-    rotate_pages_threshold: float = None,
-    pdfa_image_compression=None,
-    user_words: os.PathLike = None,
-    user_patterns: os.PathLike = None,
-    fast_web_view: float = None,
-    plugins: Iterable[StrPath] = None,
-    plugin_manager=None,
-    keep_temporary_files: bool = None,
-    progress_bar: bool = None,
-    **kwargs,
-):
-    """Run OCRmyPDF on one PDF or image.
-
-    For most arguments, see documentation for the equivalent command line parameter.
-    A few specific arguments are discussed here:
-
-    Args:
-        use_threads: Use worker threads instead of processes. This reduces
-            performance but may make debugging easier since it is easier to set
-            breakpoints.
-        input_file: If a :class:`pathlib.Path`, ``str`` or ``bytes``, this is
-            interpreted as file system path to the input file. If the object
-            appears to be a readable stream (with methods such as ``.read()``
-            and ``.seek()``), the object will be read in its entirety and saved to
-            a temporary file. If ``input_file`` is  ``"-"``, standard input will be
-            read.
-        output_file: If a :class:`pathlib.Path`, ``str`` or ``bytes``, this is
-            interpreted as file system path to the output file. If the object
-            appears to be a writable stream (with methods such as ``.write()`` and
-            ``.seek()``), the output will be written to this stream. If
-            ``output_file`` is ``"-"``, the output will be written to ``sys.stdout``
-            (provided that standard output does not seem to be a terminal device).
-            When a stream is used as output, whether via a writable object or
-            ``"-"``, some final validation steps are not performed (we do not read
-            back the stream after it is written).
-    Raises:
-        ocrmypdf.PdfMergeFailedError: If the input PDF is malformed, preventing merging
-            with the OCR layer.
-        ocrmypdf.MissingDependencyError: If a required dependency program is missing or
-            was not found on PATH.
-        ocrmypdf.UnsupportedImageFormatError: If the input file type was an image that
-            could not be read, or some other file type that is not a PDF.
-        ocrmypdf.DpiError: If the input file is an image, but the resolution of the
-            image is not credible (allowing it to proceed would cause poor OCR).
-        ocrmypdf.OutputFileAccessError: If an attempt to write to the intended output
-            file failed.
-        ocrmypdf.PriorOcrFoundError: If the input PDF seems to have OCR or digital
-            text already, and settings did not tell us to proceed.
-        ocrmypdf.InputFileError: Any other problem with the input file.
-        ocrmypdf.SubprocessOutputError: Any error related to executing a subprocess.
-        ocrmypdf.EncryptedPdfERror: If the input PDF is encrypted (password protected).
-            OCRmyPDF does not remove passwords.
-        ocrmypdf.TesseractConfigError: If Tesseract reported its configuration was not
-            valid.
-
-    Returns:
-        :class:`ocrmypdf.ExitCode`
-    """
-    if plugins and plugin_manager:
-        raise ValueError("plugins= and plugin_manager are mutually exclusive")
-
-    if not plugins:
-        plugins = []
-    elif isinstance(plugins, (str, Path)):
-        plugins = [plugins]
-    else:
-        plugins = list(plugins)
-
-    # No new variable names should be assigned until these two steps are run
-    create_options_kwargs = {k: v for k, v in locals().items() if k != 'kwargs'}
-    create_options_kwargs.update(kwargs)
-
-    parser = get_parser()
-    create_options_kwargs['parser'] = parser
-
-    with _api_lock:
-        # We can't allow multiple ocrmypdf.ocr() threads to run in parallel, because
-        # they might install different plugins, and generally speaking we have areas
-        # of code that use global state.
-
-        if not plugin_manager:
-            plugin_manager = get_plugin_manager(plugins)
-        plugin_manager.hook.add_options(parser=parser)  # pylint: disable=no-member
-
-        if 'verbose' in kwargs:
-            warn("ocrmypdf.ocr(verbose=) is ignored. Use ocrmypdf.configure_logging().")
-
-        options = create_options(**create_options_kwargs)
-        check_options(options, plugin_manager)
-        return run_pipeline(options=options, plugin_manager=plugin_manager, api=True)

src/ocrmypdf/builtin_plugins/__init__.py

@@ -1,9 +0,0 @@
-# © 2020 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-# This file exists only mark builtin_plugins as a package.
-# The plugin manager will not load it, so anything defined here may not be
-# processed as a module.

src/ocrmypdf/builtin_plugins/concurrency.py

@@ -1,172 +0,0 @@
-# © 2020 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-# © 2020 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-
-import logging
-import logging.handlers
-import multiprocessing
-import os
-import queue
-import signal
-import sys
-import threading
-from contextlib import suppress
-from multiprocessing import Pool as ProcessPool
-from multiprocessing.pool import ThreadPool
-from typing import Callable, Iterable, Union
-
-from tqdm import tqdm
-
-from ocrmypdf import Executor, hookimpl
-from ocrmypdf._logging import TqdmConsole
-from ocrmypdf.exceptions import InputFileError
-from ocrmypdf.helpers import remove_all_log_handlers
-
-Queue = Union[multiprocessing.Queue, queue.Queue]
-
-
-def log_listener(q: Queue):
-    """Listen to the worker processes and forward the messages to logging
-
-    For simplicity this is a thread rather than a process. Only one process
-    should actually write to sys.stderr or whatever we're using, so if this is
-    made into a process the main application needs to be directed to it.
-
-    See https://docs.python.org/3/howto/logging-cookbook.html#logging-to-a-single-file-from-multiple-processes
-    """
-
-    while True:
-        try:
-            record = q.get()
-            if record is None:
-                break
-            logger = logging.getLogger(record.name)
-            logger.handle(record)
-        except Exception:  # pylint: disable=broad-except
-            import traceback  # pylint: disable=import-outside-toplevel
-
-            print("Logging problem", file=sys.stderr)
-            traceback.print_exc(file=sys.stderr)
-
-
-def process_sigbus(*args):
-    raise InputFileError("A worker process lost access to an input file")
-
-
-def process_init(q: Queue, user_init: Callable[[], None], loglevel):
-    """Initialize a process pool worker"""
-
-    # Ignore SIGINT (our parent process will kill us gracefully)
-    signal.signal(signal.SIGINT, signal.SIG_IGN)
-
-    # Install SIGBUS handler (so our parent process can abort somewhat gracefully)
-    with suppress(AttributeError):  # Windows and Cygwin do not have SIGBUS
-        # Windows and Cygwin do not have pthread_sigmask or SIGBUS
-        signal.signal(signal.SIGBUS, process_sigbus)
-
-    # Remove any log handlers that belong to the parent process
-    root = logging.getLogger()
-    remove_all_log_handlers(root)
-
-    # Set up our single log handler to forward messages to the parent
-    root.setLevel(loglevel)
-    root.addHandler(logging.handlers.QueueHandler(q))
-
-    user_init()
-    return
-
-
-def thread_init(_queue: Queue, user_init: Callable[[], None], _loglevel):
-    # As a thread, block SIGBUS so the main thread deals with it...
-    with suppress(AttributeError):
-        signal.pthread_sigmask(signal.SIG_BLOCK, {signal.SIGBUS})
-
-    user_init()
-    return
-
-
-class StandardExecutor(Executor):
-    def _execute(
-        self,
-        *,
-        use_threads: bool,
-        max_workers: int,
-        tqdm_kwargs: dict,
-        worker_initializer: Callable,
-        task: Callable,
-        task_arguments: Iterable,
-        task_finished: Callable,
-    ):
-        if use_threads:
-            log_queue = queue.Queue(-1)
-            pool_class = ThreadPool
-            initializer = thread_init
-        else:
-            log_queue = multiprocessing.Queue(-1)
-            pool_class = ProcessPool
-            initializer = process_init
-
-        # Regardless of whether we use_threads for worker processes, the log_listener
-        # must be a thread. Make sure we create the listener after the worker pool,
-        # so that it does not get forked into the workers.
-        listener = threading.Thread(target=log_listener, args=(log_queue,))
-        listener.start()
-
-        with self.pbar_class(**tqdm_kwargs) as pbar:
-            pool = pool_class(
-                processes=max_workers,
-                initializer=initializer,
-                initargs=(log_queue, worker_initializer, logging.getLogger("").level),
-            )
-            try:
-                results = pool.imap_unordered(task, task_arguments)
-                for result in results:
-                    if task_finished:
-                        task_finished(result, pbar)
-                    else:
-                        pbar.update()
-            except KeyboardInterrupt:
-                # Terminate pool so we exit instantly
-                pool.terminate()
-                # Don't try listener.join() here, will deadlock
-                raise
-            except Exception:
-                if not os.environ.get("PYTEST_CURRENT_TEST", ""):
-                    # Unless inside pytest, exit immediately because no one wants
-                    # to wait for child processes to finalize results that will be
-                    # thrown away. Inside pytest, we want child processes to exit
-                    # cleanly so that they output an error messages or coverage data
-                    # we need from them.
-                    pool.terminate()
-                raise
-            finally:
-                # Terminate log listener
-                log_queue.put_nowait(None)
-                pool.close()
-                pool.join()
-
-        listener.join()
-
-
-@hookimpl
-def get_executor(progressbar_class):
-    return StandardExecutor(pbar_class=progressbar_class)
-
-
-@hookimpl
-def get_progressbar_class():
-    return tqdm
-
-
-@hookimpl
-def get_logging_console():
-    return logging.StreamHandler(stream=TqdmConsole(sys.stderr))

src/ocrmypdf/builtin_plugins/default_filters.py

@@ -1,14 +0,0 @@
-# © 2021 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-from ocrmypdf import hookimpl
-
-
-@hookimpl
-def filter_pdf_page(
-    page, image_filename, output_pdf
-):  # pylint: disable=unused-argument
-    return output_pdf

src/ocrmypdf/builtin_plugins/ghostscript.py

@@ -1,99 +0,0 @@
-# © 2020 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-
-import logging
-
-from ocrmypdf import hookimpl
-from ocrmypdf._exec import ghostscript
-from ocrmypdf._validation import HOCR_OK_LANGS
-from ocrmypdf.exceptions import MissingDependencyError
-from ocrmypdf.subprocess import check_external_program
-
-log = logging.getLogger(__name__)
-
-
-@hookimpl
-def check_options(options):
-    gs_version = ghostscript.version()
-    check_external_program(
-        program='gs',
-        package='ghostscript',
-        version_checker=gs_version,
-        need_version='9.15',  # limited by Travis CI / Ubuntu 14.04 backports
-    )
-    if gs_version in ('9.24', '9.51'):
-        raise MissingDependencyError(
-            f"Ghostscript {gs_version} contains serious regressions and is not "
-            "supported. Please upgrade to a newer version, or downgrade to the "
-            "previous version."
-        )
-
-    # We have these constraints to check for.
-    # 1. Ghostscript < 9.20 mangles multibyte Unicode
-    # 2. hocr doesn't work on non-Latin languages (so don't select it)
-    is_latin = options.languages.issubset(HOCR_OK_LANGS)
-    if gs_version < '9.20' and options.output_type != 'pdf' and not is_latin:
-        # https://bugs.ghostscript.com/show_bug.cgi?id=696874
-        # Ghostscript < 9.20 fails to encode multibyte characters properly
-        log.warning(
-            f"The installed version of Ghostscript ({gs_version}) does not work "
-            "correctly with the OCR languages you specified. Use --output-type pdf or "
-            "upgrade to Ghostscript 9.20 or later to avoid this issue."
-        )
-
-    if options.output_type == 'pdfa':
-        options.output_type = 'pdfa-2'
-
-    if options.output_type == 'pdfa-3' and ghostscript.version() < '9.19':
-        raise MissingDependencyError(
-            "--output-type pdfa-3 requires Ghostscript 9.19 or later"
-        )
-
-
-@hookimpl
-def rasterize_pdf_page(
-    input_file,
-    output_file,
-    raster_device,
-    raster_dpi,
-    pageno,
-    page_dpi,
-    rotation,
-    filter_vector,
-):
-    ghostscript.rasterize_pdf(
-        input_file,
-        output_file,
-        raster_device=raster_device,
-        raster_dpi=raster_dpi,
-        pageno=pageno,
-        page_dpi=page_dpi,
-        rotation=rotation,
-        filter_vector=filter_vector,
-    )
-    return output_file
-
-
-@hookimpl
-def generate_pdfa(
-    pdf_pages,
-    pdfmark,
-    output_file,
-    compression,
-    pdf_version,
-    pdfa_part,
-    progressbar_class,
-):
-    ghostscript.generate_pdfa(
-        pdf_pages=[*pdf_pages, pdfmark],
-        output_file=output_file,
-        compression=compression,
-        pdf_version=pdf_version,
-        pdfa_part=pdfa_part,
-        progressbar_class=progressbar_class,
-    )
-    return output_file

src/ocrmypdf/builtin_plugins/tesseract_ocr.py

@@ -1,179 +0,0 @@
-# © 2020 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-
-import logging
-import os
-
-from ocrmypdf import hookimpl
-from ocrmypdf._exec import tesseract
-from ocrmypdf.cli import numeric
-from ocrmypdf.exceptions import MissingDependencyError
-from ocrmypdf.helpers import clamp
-from ocrmypdf.pluginspec import OcrEngine
-from ocrmypdf.subprocess import check_external_program
-
-log = logging.getLogger(__name__)
-
-
-@hookimpl
-def add_options(parser):
-    tess = parser.add_argument_group("Tesseract", "Advanced control of Tesseract OCR")
-    tess.add_argument(
-        '--tesseract-config',
-        action='append',
-        metavar='CFG',
-        default=[],
-        help="Additional Tesseract configuration files -- see documentation",
-    )
-    tess.add_argument(
-        '--tesseract-pagesegmode',
-        action='store',
-        type=int,
-        metavar='PSM',
-        choices=range(0, 14),
-        help="Set Tesseract page segmentation mode (see tesseract --help)",
-    )
-    tess.add_argument(
-        '--tesseract-oem',
-        action='store',
-        type=int,
-        metavar='MODE',
-        choices=range(0, 4),
-        help=(
-            "Set Tesseract 4.0 OCR engine mode: "
-            "0 - original Tesseract only; "
-            "1 - neural nets LSTM only; "
-            "2 - Tesseract + LSTM; "
-            "3 - default."
-        ),
-    )
-    tess.add_argument(
-        '--tesseract-timeout',
-        default=180.0,
-        type=numeric(float, 0),
-        metavar='SECONDS',
-        help='Give up on OCR after the timeout, but copy the preprocessed page '
-        'into the final output',
-    )
-    tess.add_argument(
-        '--user-words',
-        metavar='FILE',
-        help="Specify the location of the Tesseract user words file. This is a "
-        "list of words Tesseract should consider while performing OCR in "
-        "addition to its standard language dictionaries. This can improve "
-        "OCR quality especially for specialized and technical documents.",
-    )
-    tess.add_argument(
-        '--user-patterns',
-        metavar='FILE',
-        help="Specify the location of the Tesseract user patterns file.",
-    )
-
-
-@hookimpl
-def check_options(options):
-    check_external_program(
-        program='tesseract',
-        package={'linux': 'tesseract-ocr'},
-        version_checker=tesseract.version,
-        need_version='4.0.0-beta.1',  # using backport for Travis CI
-        version_parser=tesseract.TesseractVersion,
-    )
-
-    # Decide on what renderer to use
-    if options.pdf_renderer == 'auto':
-        options.pdf_renderer = 'sandwich'
-
-    if not tesseract.has_user_words() and (options.user_words or options.user_patterns):
-        log.warning(
-            "Tesseract 4.0 ignores --user-words and --user-patterns, so these "
-            "arguments have no effect."
-        )
-    if options.tesseract_pagesegmode in (0, 2):
-        log.warning(
-            "The --tesseract-pagesegmode argument you select will disable OCR. "
-            "This may cause processing to fail."
-        )
-
-
-@hookimpl
-def validate(pdfinfo, options):
-    # Tesseract 4.x can be multithreaded, and we also run multiple workers. We want
-    # to manage how many threads it uses to avoid creating total threads than cores.
-    # Performance testing shows we're better off
-    # parallelizing ocrmypdf and forcing Tesseract to be single threaded, which we
-    # get by setting the envvar OMP_THREAD_LIMIT to 1. But if the page count of the
-    # input file is small, then we allow Tesseract to use threads, subject to the
-    # constraint: (ocrmypdf workers) * (tesseract threads) <= max_workers.
-    # As of Tesseract 4.1, 3 threads is the most effective on a 4 core/8 thread system.
-    if not os.environ.get('OMP_THREAD_LIMIT', '').isnumeric():
-        tess_threads = clamp(options.jobs // len(pdfinfo), 1, 3)
-        os.environ['OMP_THREAD_LIMIT'] = str(tess_threads)
-    else:
-        tess_threads = int(os.environ['OMP_THREAD_LIMIT'])
-    log.debug("Using Tesseract OpenMP thread limit %d", tess_threads)
-
-
-class TesseractOcrEngine(OcrEngine):
-    @staticmethod
-    def version():
-        return tesseract.version()
-
-    @staticmethod
-    def creator_tag(options):
-        tag = '-PDF' if options.pdf_renderer == 'sandwich' else ''
-        return f"Tesseract OCR{tag} {TesseractOcrEngine.version()}"
-
-    def __str__(self):
-        return f"Tesseract OCR {TesseractOcrEngine.version()}"
-
-    @staticmethod
-    def languages(options):
-        return tesseract.get_languages()
-
-    @staticmethod
-    def get_orientation(input_file, options):
-        return tesseract.get_orientation(
-            input_file,
-            engine_mode=options.tesseract_oem,
-            timeout=options.tesseract_timeout,
-        )
-
-    @staticmethod
-    def generate_hocr(input_file, output_hocr, output_text, options):
-        tesseract.generate_hocr(
-            input_file=input_file,
-            output_hocr=output_hocr,
-            output_text=output_text,
-            languages=options.languages,
-            engine_mode=options.tesseract_oem,
-            tessconfig=options.tesseract_config,
-            timeout=options.tesseract_timeout,
-            pagesegmode=options.tesseract_pagesegmode,
-            user_words=options.user_words,
-            user_patterns=options.user_patterns,
-        )
-
-    @staticmethod
-    def generate_pdf(input_file, output_pdf, output_text, options):
-        tesseract.generate_pdf(
-            input_file=input_file,
-            output_pdf=output_pdf,
-            output_text=output_text,
-            languages=options.languages,
-            engine_mode=options.tesseract_oem,
-            tessconfig=options.tesseract_config,
-            timeout=options.tesseract_timeout,
-            pagesegmode=options.tesseract_pagesegmode,
-            user_words=options.user_words,
-            user_patterns=options.user_patterns,
-        )
-
-
-@hookimpl
-def get_ocr_engine():
-    return TesseractOcrEngine()

src/ocrmypdf/cli.py

@@ -1,486 +0,0 @@
-# © 2015-19 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-
-import argparse
-from typing import Optional, Type, TypeVar
-
-from ocrmypdf._version import PROGRAM_NAME as _PROGRAM_NAME
-from ocrmypdf._version import __version__ as _VERSION
-
-T = TypeVar('T')
-
-
-def numeric(basetype: Type[T], min_: Optional[T] = None, max_: Optional[T] = None):
-    """Validator for numeric params"""
-    min_ = basetype(min_) if min_ is not None else None
-    max_ = basetype(max_) if max_ is not None else None
-
-    def _numeric(string):
-        value = basetype(string)
-        if (min_ is not None and value < min_) or (max_ is not None and value > max_):
-            msg = "%r not in valid range %r" % (string, (min_, max_))
-            raise argparse.ArgumentTypeError(msg)
-        return value
-
-    _numeric.__name__ = basetype.__name__
-    return _numeric
-
-
-class ArgumentParser(argparse.ArgumentParser):
-    """Override parser's default behavior of calling sys.exit()
-
-    https://stackoverflow.com/questions/5943249/python-argparse-and-controlling-overriding-the-exit-status-code
-    """
-
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self._api_mode = False
-
-    def error(self, message):
-        if not self._api_mode:
-            super().error(message)
-            return
-        raise ValueError(message)
-
-
-class LanguageSetAction(argparse.Action):
-    def __init__(self, option_strings, dest, default=None, **kwargs):
-        if default is None:
-            default = set()
-        super().__init__(option_strings, dest, default=default, **kwargs)
-
-    def __call__(self, parser, namespace, values, option_string=None):
-        dest = getattr(namespace, self.dest)
-        if '+' in values:
-            dest.update(lang for lang in values.split('+'))
-        else:
-            dest.add(values)
-
-
-def get_parser():
-    parser = ArgumentParser(
-        prog=_PROGRAM_NAME,
-        allow_abbrev=True,
-        fromfile_prefix_chars='@',
-        formatter_class=argparse.RawDescriptionHelpFormatter,
-        description="""\
-Generates a searchable PDF or PDF/A from a regular PDF.
-
-OCRmyPDF rasterizes each page of the input PDF, optionally corrects page
-rotation and performs image processing, runs the Tesseract OCR engine on the
-image, and then creates a PDF from the OCR information.
-""",
-        epilog="""\
-OCRmyPDF attempts to keep the output file at about the same size.  If a file
-contains losslessly compressed images, and images in the output file will be
-losslessly compressed as well.
-
-PDF is a page description file that attempts to preserve a layout exactly.
-A PDF can contain vector objects (such as text or lines) and raster objects
-(images).  A page might have multiple images.  OCRmyPDF is prepared to deal
-with the wide variety of PDFs that exist in the wild.
-
-When a PDF page contains text, OCRmyPDF assumes that the page has already
-been OCRed or is a "born digital" page that should not be OCRed.  The default
-behavior is to exit in this case without producing a file.  You can use the
-option --skip-text to ignore pages with text, or --force-ocr to rasterize
-all objects on the page and produce an image-only PDF as output.
-
-    ocrmypdf --skip-text file_with_some_text_pages.pdf output.pdf
-
-    ocrmypdf --force-ocr word_document.pdf output.pdf
-
-If you are concerned about long-term archiving of PDFs, use the default option
---output-type pdfa which converts the PDF to a standardized PDF/A-2b.  This
-removes some features from the PDF such as Javascript or forms. If you want to
-minimize the number of changes made to your PDF, use --output-type pdf.
-
-If OCRmyPDF is given an image file as input, it will attempt to convert the
-image to a PDF before processing.  For more control over the conversion of
-images to PDF, use the Python package img2pdf or other image to PDF software.
-
-For example, this command uses img2pdf to convert all .png files beginning
-with the 'page' prefix to a PDF, fitting each image on A4-sized paper, and
-sending the result to OCRmyPDF through a pipe.
-
-    img2pdf --pagesize A4 page*.png | ocrmypdf - myfile.pdf
-
-Online documentation is located at:
-    https://ocrmypdf.readthedocs.io/en/latest/introduction.html
-
-""",
-    )
-
-    parser.add_argument(
-        'input_file',
-        metavar="input_pdf_or_image",
-        help="PDF file containing the images to be OCRed (or '-' to read from "
-        "standard input)",
-    )
-    parser.add_argument(
-        'output_file',
-        metavar="output_pdf",
-        help="Output searchable PDF file (or '-' to write to standard output). "
-        "Existing files will be ovewritten. If same as input file, the "
-        "input file will be updated only if processing is successful.",
-    )
-    parser.add_argument(
-        '-l',
-        '--language',
-        dest='languages',
-        action=LanguageSetAction,
-        help="Language(s) of the file to be OCRed (see tesseract --list-langs for "
-        "all language packs installed in your system). Use -l eng+deu for "
-        "multiple languages.",
-    )
-    parser.add_argument(
-        '--image-dpi',
-        metavar='DPI',
-        type=int,
-        help="For input image instead of PDF, use this DPI instead of file's.",
-    )
-    parser.add_argument(
-        '--output-type',
-        choices=['pdfa', 'pdf', 'pdfa-1', 'pdfa-2', 'pdfa-3'],
-        default='pdfa',
-        help="Choose output type. 'pdfa' creates a PDF/A-2b compliant file for "
-        "long term archiving (default, recommended) but may not suitable "
-        "for users who want their file altered as little as possible. 'pdfa' "
-        "also has problems with full Unicode text. 'pdf' attempts to "
-        "preserve file contents as much as possible. 'pdf-a1' creates a "
-        "PDF/A1-b file. 'pdf-a2' is equivalent to 'pdfa'. 'pdf-a3' creates a "
-        "PDF/A3-b file.",
-    )
-
-    # Use null string '\0' as sentinel to indicate the user supplied no argument,
-    # since that is the only invalid character for filepaths on all platforms
-    # bool('\0') is True in Python
-    parser.add_argument(
-        '--sidecar',
-        nargs='?',
-        const='\0',
-        default=None,
-        metavar='FILE',
-        help="Generate sidecar text files that contain the same text recognized "
-        "by Tesseract. This may be useful for building a OCR text database. "
-        "If FILE is omitted, the sidecar file be named {output_file}.txt; the next "
-        "argument must NOT be the name of the input PDF. "
-        "If FILE is set to '-', the sidecar is written to stdout (a "
-        "convenient way to preview OCR quality). The output file and sidecar "
-        "may not both use stdout at the same time.",
-    )
-
-    parser.add_argument(
-        '--version',
-        action='version',
-        version=_VERSION,
-        help="Print program version and exit",
-    )
-
-    jobcontrol = parser.add_argument_group("Job control options")
-    jobcontrol.add_argument(
-        '-j',
-        '--jobs',
-        metavar='N',
-        type=numeric(int, 0, 256),
-        help="Use up to N CPU cores simultaneously (default: use all).",
-    )
-    jobcontrol.add_argument(
-        '-q', '--quiet', action='store_true', help="Suppress INFO messages"
-    )
-    jobcontrol.add_argument(
-        '-v',
-        '--verbose',
-        type=numeric(int, 0, 2),
-        default=0,
-        const=1,
-        nargs='?',
-        help="Print more verbose messages for each additional verbose level. Use "
-        "`-v 1` typically for much more detailed logging. Higher numbers "
-        "are probably only useful in debugging.",
-    )
-    jobcontrol.add_argument(
-        '--no-progress-bar',
-        action='store_false',
-        dest='progress_bar',
-        help=argparse.SUPPRESS,
-    )
-    jobcontrol.add_argument(
-        '--use-threads', action='store_true', help=argparse.SUPPRESS
-    )
-
-    metadata = parser.add_argument_group(
-        "Metadata options",
-        "Set output PDF/A metadata (default: copy input document's metadata)",
-    )
-    metadata.add_argument(
-        '--title', type=str, help="Set document title (place multiple words in quotes)"
-    )
-    metadata.add_argument('--author', type=str, help="Set document author")
-    metadata.add_argument(
-        '--subject', type=str, help="Set document subject description"
-    )
-    metadata.add_argument('--keywords', type=str, help="Set document keywords")
-
-    preprocessing = parser.add_argument_group(
-        "Image preprocessing options",
-        "Options to improve the quality of the final PDF and OCR",
-    )
-    preprocessing.add_argument(
-        '-r',
-        '--rotate-pages',
-        action='store_true',
-        help="Automatically rotate pages based on detected text orientation",
-    )
-    preprocessing.add_argument(
-        '--remove-background',
-        action='store_true',
-        help="Attempt to remove background from gray or color pages, setting it "
-        "to white ",
-    )
-    preprocessing.add_argument(
-        '-d',
-        '--deskew',
-        action='store_true',
-        help="Deskew each page before performing OCR",
-    )
-    preprocessing.add_argument(
-        '-c',
-        '--clean',
-        action='store_true',
-        help="Clean pages from scanning artifacts before performing OCR, and send "
-        "the cleaned page to OCR, but do not include the cleaned page in "
-        "the output",
-    )
-    preprocessing.add_argument(
-        '-i',
-        '--clean-final',
-        action='store_true',
-        help="Clean page as above, and incorporate the cleaned image in the final "
-        "PDF.  Might remove desired content.",
-    )
-    preprocessing.add_argument(
-        '--unpaper-args',
-        type=str,
-        default=None,
-        help="A quoted string of arguments to pass to unpaper. Requires --clean. "
-        "Example: --unpaper-args '--layout double'.",
-    )
-    preprocessing.add_argument(
-        '--oversample',
-        metavar='DPI',
-        type=numeric(int, 0, 5000),
-        default=0,
-        help="Oversample images to at least the specified DPI, to improve OCR "
-        "results slightly",
-    )
-    preprocessing.add_argument(
-        '--remove-vectors',
-        action='store_true',
-        help="EXPERIMENTAL. Mask out any vector objects in the PDF so that they "
-        "will not be included in OCR. This can eliminate false characters.",
-    )
-    preprocessing.add_argument(
-        '--threshold',
-        action='store_true',
-        help=(
-            "EXPERIMENTAL. Threshold image to 1bpp before sending it to Tesseract "
-            "for OCR. Can improve OCR quality compared to Tesseract's thresholder."
-        ),
-    )
-
-    ocrsettings = parser.add_argument_group("OCR options", "Control how OCR is applied")
-    ocrsettings.add_argument(
-        '-f',
-        '--force-ocr',
-        action='store_true',
-        help="Rasterize any text or vector objects on each page, apply OCR, and "
-        "save the rastered output (this rewrites the PDF)",
-    )
-    ocrsettings.add_argument(
-        '-s',
-        '--skip-text',
-        action='store_true',
-        help="Skip OCR on any pages that already contain text, but include the "
-        "page in final output; useful for PDFs that contain a mix of "
-        "images, text pages, and/or previously OCRed pages",
-    )
-    ocrsettings.add_argument(
-        '--redo-ocr',
-        action='store_true',
-        help="Attempt to detect and remove the hidden OCR layer from files that "
-        "were previously OCRed with OCRmyPDF or another program. Apply OCR "
-        "to text found in raster images. Existing visible text objects will "
-        "not be changed. If there is no existing OCR, OCR will be added.",
-    )
-    ocrsettings.add_argument(
-        '--skip-big',
-        type=numeric(float, 0, 5000),
-        metavar='MPixels',
-        help="Skip OCR on pages larger than the specified amount of megapixels, "
-        "but include skipped pages in final output",
-    )
-
-    optimizing = parser.add_argument_group(
-        "Optimization options", "Control how the PDF is optimized after OCR"
-    )
-    optimizing.add_argument(
-        '-O',
-        '--optimize',
-        type=int,
-        choices=range(0, 4),
-        default=1,
-        help=(
-            "Control how PDF is optimized after processing:"
-            "0 - do not optimize; "
-            "1 - do safe, lossless optimizations (default); "
-            "2 - do some lossy optimizations; "
-            "3 - do aggressive lossy optimizations (including lossy JBIG2)"
-        ),
-    )
-    optimizing.add_argument(
-        '--jpeg-quality',
-        type=numeric(int, 0, 100),
-        default=0,
-        metavar='Q',
-        help=(
-            "Adjust JPEG quality level for JPEG optimization. "
-            "100 is best quality and largest output size; "
-            "1 is lowest quality and smallest output; "
-            "0 uses the default."
-        ),
-    )
-    optimizing.add_argument(
-        '--jpg-quality',
-        type=numeric(int, 0, 100),
-        default=0,
-        metavar='Q',
-        dest='jpeg_quality',
-        help=argparse.SUPPRESS,  # Alias for --jpeg-quality
-    )
-    optimizing.add_argument(
-        '--png-quality',
-        type=numeric(int, 0, 100),
-        default=0,
-        metavar='Q',
-        help=(
-            "Adjust PNG quality level to use when quantizing PNGs. "
-            "Values have same meaning as with --jpeg-quality"
-        ),
-    )
-    optimizing.add_argument(
-        '--jbig2-lossy',
-        action='store_true',
-        help=(
-            "Enable JBIG2 lossy mode (better compression, not suitable for some "
-            "use cases - see documentation)."
-        ),
-    )
-    optimizing.add_argument(
-        '--jbig2-page-group-size',
-        type=numeric(int, 1, 10000),
-        default=0,
-        metavar='N',
-        # Adjust number of pages to consider at once for JBIG2 compression
-        help=argparse.SUPPRESS,
-    )
-
-    advanced = parser.add_argument_group(
-        "Advanced", "Advanced options to control OCRmyPDF"
-    )
-    advanced.add_argument(
-        '--pages',
-        type=str,
-        help=(
-            "Limit OCR to the specified pages (ranges or comma separated), "
-            "skipping others"
-        ),
-    )
-    advanced.add_argument(
-        '--max-image-mpixels',
-        action='store',
-        type=numeric(float, 0),
-        metavar='MPixels',
-        help="Set maximum number of pixels to unpack before treating an image as a "
-        "decompression bomb",
-        default=128.0,
-    )
-    advanced.add_argument(
-        '--pdf-renderer',
-        choices=['auto', 'hocr', 'sandwich', 'hocrdebug'],
-        default='auto',
-        help="Choose OCR PDF renderer - the default option is to let OCRmyPDF "
-        "choose.  See documentation for discussion.",
-    )
-    advanced.add_argument(
-        '--rotate-pages-threshold',
-        default=14.0,
-        type=numeric(float, 0, 1000),
-        metavar='CONFIDENCE',
-        help="Only rotate pages when confidence is above this value (arbitrary "
-        "units reported by tesseract)",
-    )
-    advanced.add_argument(
-        '--pdfa-image-compression',
-        choices=['auto', 'jpeg', 'lossless'],
-        default='auto',
-        help="Specify how to compress images in the output PDF/A. 'auto' lets "
-        "OCRmyPDF decide.  'jpeg' changes all grayscale and color images to "
-        "JPEG compression.  'lossless' uses PNG-style lossless compression "
-        "for all images.  Monochrome images are always compressed using a "
-        "lossless codec.  Compression settings "
-        "are applied to all pages, including those for which OCR was "
-        "skipped.  Not supported for --output-type=pdf ; that setting "
-        "preserves the original compression of all images.",
-    )
-    advanced.add_argument(
-        '--fast-web-view',
-        type=numeric(float, 0),
-        default=1.0,
-        metavar="MEGABYTES",
-        help="If the size of file is more than this threshold (in MB), then "
-        "linearize the PDF for fast web viewing. This allows the PDF to be "
-        "displayed before it is fully downloaded in web browsers, but increases "
-        "the space required slightly. By default we skip this for small files "
-        "which do not benefit. If the threshold is 0 it will be apply to all files. "
-        "Set the threshold very high to disable.",
-    )
-    advanced.add_argument(
-        '--plugin',
-        dest='plugins',
-        action='append',
-        default=[],
-        help="Name of plugin to import. Argument may be issued multiple times to "
-        "import multiple plugins. Plugins may be specified as module names in "
-        "Python syntax, provided they are installed in the same Python (virtual) "
-        "environment as ocrmypdf; or you may give the path to the Python file that "
-        "contains the plugin. Plugins must conform to the specification in the "
-        "OCRmyPDF documentation.",
-    )
-
-    debugging = parser.add_argument_group(
-        "Debugging", "Arguments to help with troubleshooting and debugging"
-    )
-    debugging.add_argument(
-        '-k',
-        '--keep-temporary-files',
-        action='store_true',
-        help="Keep temporary files (helpful for debugging)",
-    )
-    return parser
-
-
-plugins_only_parser = ArgumentParser(
-    prog=_PROGRAM_NAME, fromfile_prefix_chars='@', add_help=False, allow_abbrev=False
-)
-plugins_only_parser.add_argument(
-    '--plugin',
-    dest='plugins',
-    action='append',
-    default=[],
-    help="Name of plugin to import.",
-)

src/ocrmypdf/exceptions.py

@@ -1,13 +1,22 @@
 # © 2016 James R. Barlow: github.com/jbarlow83
 #
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+# This file is part of OCRmyPDF.
+#
+# OCRmyPDF is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# OCRmyPDF 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.
+#
+# You should have received a copy of the GNU General Public License
+# along with OCRmyPDF.  If not, see <http://www.gnu.org/licenses/>.
 
 
 from enum import IntEnum
-from textwrap import dedent
-
 
 class ExitCode(IntEnum):
     ok = 0
@@ -20,20 +29,12 @@ class ExitCode(IntEnum):
     child_process_error = 7
     encrypted_pdf = 8
     invalid_config = 9
-    pdfa_conversion_failed = 10
     other_error = 15
     ctrl_c = 130
 
 
 class ExitCodeException(Exception):
     exit_code = ExitCode.other_error
-    message = ""
-
-    def __str__(self):
-        super_msg = super().__str__()  # Don't do str(super())
-        if self.message:
-            return self.message.format(super_msg)
-        return super_msg
 
 
 class BadArgsError(ExitCodeException):
@@ -42,17 +43,6 @@ class BadArgsError(ExitCodeException):
 
 class PdfMergeFailedError(ExitCodeException):
     exit_code = ExitCode.input_file
-    message = dedent(
-        '''\
-        Failed to merge PDF image layer with OCR layer
-
-        Usually this happens because the input PDF file is malformed and
-        ocrmypdf cannot automatically correct the problem on its own.
-
-        Try using
-            ocrmypdf --pdf-renderer sandwich  [..other args..]
-        '''
-    )
 
 
 class MissingDependencyError(ExitCodeException):
@@ -85,20 +75,7 @@ class SubprocessOutputError(ExitCodeException):
 
 class EncryptedPdfError(ExitCodeException):
     exit_code = ExitCode.encrypted_pdf
-    message = dedent(
-        '''\
-        Input PDF is encrypted. The encryption must be removed to
-        perform OCR.
-
-        For information about this PDF's security use
-            qpdf --show-encryption infilename
-
-        You can remove the encryption using
-            qpdf --decrypt [--password=[password]] infilename
-        '''
-    )
 
 
 class TesseractConfigError(ExitCodeException):
     exit_code = ExitCode.invalid_config
-    message = "Error occurred while parsing a Tesseract configuration file"

src/ocrmypdf/exec/__init__.py

@@ -0,0 +1,60 @@
+# © 2016 James R. Barlow: github.com/jbarlow83
+#
+# This file is part of OCRmyPDF.
+#
+# OCRmyPDF is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# OCRmyPDF 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.
+#
+# You should have received a copy of the GNU General Public License
+# along with OCRmyPDF.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Wrappers to manage subprocess calls"""
+
+import os
+import re
+import sys
+from subprocess import run, STDOUT, PIPE, CalledProcessError
+from ..exceptions import MissingDependencyError
+
+
+
+def get_version(program, *,
+        version_arg='--version', regex=r'(\d+(\.\d+)*)'):
+    "Get the version of the specified program"
+    args_prog = [
+        program,
+        version_arg
+    ]
+    try:
+        proc = run(
+            args_prog, close_fds=True, universal_newlines=True,
+            stdout=PIPE, stderr=STDOUT, check=True)
+        output = proc.stdout
+    except FileNotFoundError as e:
+        raise MissingDependencyError(
+            "Could not find program '{}' on the PATH".format(
+                program)) from e
+    except CalledProcessError as e:
+        if e.returncode < 0:
+            raise MissingDependencyError(
+                "Ran program '{}' but it exited with an error:\n{}".format(
+                    program, e.output)) from e
+        raise MissingDependencyError(
+            "Could not find program '{}' on the PATH".format(
+                program)) from e
+    try:
+        version = re.match(regex, output.strip()).group(1)
+    except AttributeError as e:
+        raise MissingDependencyError(
+            ("The program '{}' did not report its version. "
+            "Message was:\n{}").format(program, output)
+        )
+
+    return version

src/ocrmypdf/exec/ghostscript.py

@@ -0,0 +1,204 @@
+# © 2017 James R. Barlow: github.com/jbarlow83
+#
+# This file is part of OCRmyPDF.
+#
+# OCRmyPDF is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# OCRmyPDF 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.
+#
+# You should have received a copy of the GNU General Public License
+# along with OCRmyPDF.  If not, see <http://www.gnu.org/licenses/>.
+
+from tempfile import NamedTemporaryFile
+from subprocess import run, PIPE, STDOUT, CalledProcessError
+from shutil import copy
+from functools import lru_cache
+import re
+import sys
+from PIL import Image
+from . import get_version
+from ..exceptions import SubprocessOutputError, MissingDependencyError
+from ..helpers import fspath
+
+
+@lru_cache(maxsize=1)
+def version():
+    return get_version('gs')
+
+
+def jpeg_passthrough_available():
+    """
+    Returns True if the installed version of Ghostscript supports JPEG passthru
+
+    Prior to 9.23, Ghostscript decode and re-encoded JPEGs internally. In 9.23
+    it gained the ability to keep JPEGs unmodified. However, the 9.23
+    implementation was buggy and would deletes the last two bytes of images in
+    some cases, as reported here.
+    https://bugs.ghostscript.com/show_bug.cgi?id=699216
+
+    The issue was fixed for 9.24, hence that is the first version we consider
+    the feature available. (However, we don't use 9.24 at all, so the first
+    version that allows JPEG passthrough is 9.25.
+
+    Regardless, in ocrmypdf 6.x we are ignoring this new feature entirely to
+    avoid new behavior.
+    """
+    return False
+
+
+def _gs_error_reported(stream):
+    return re.search(r'error', stream, flags=re.IGNORECASE)
+
+
+def rasterize_pdf(input_file, output_file, xres, yres, raster_device, log,
+                  pageno=1, page_dpi=None):
+    """
+    Rasterize one page of a PDF at resolution (xres, yres) in canvas units.
+
+    The image is sized to match the integer pixels dimensions implied by
+    (xres, yres) even if those numbers are noninteger. The image's DPI will
+     be overridden with the values in page_dpi.
+
+    :param input_file: pathlike
+    :param output_file: pathlike
+    :param xres: resolution at which to rasterize page
+    :param yres:
+    :param raster_device:
+    :param log:
+    :param pageno: page number to rasterize (beginning at page 1)
+    :param page_dpi: resolution tuple (x, y) overriding output image DPI
+    :return:
+    """
+    res = xres, yres
+    int_res = round(xres), round(yres)
+    if not page_dpi:
+        page_dpi = res
+    with NamedTemporaryFile(delete=True) as tmp:
+        args_gs = [
+            'gs',
+            '-dQUIET',
+            '-dSAFER',
+            '-dBATCH',
+            '-dNOPAUSE',
+            '-sDEVICE=%s' % raster_device,
+            '-dFirstPage=%i' % pageno,
+            '-dLastPage=%i' % pageno,
+            '-r{0}x{1}'.format(str(int_res[0]), str(int_res[1])),
+            '-o', tmp.name,
+            fspath(input_file)
+        ]
+
+        p = run(args_gs, stdout=PIPE, stderr=STDOUT,
+                universal_newlines=True)
+        if _gs_error_reported(p.stdout):
+            log.error(p.stdout)
+        else:
+            log.debug(p.stdout)
+
+        if p.returncode != 0:
+            log.error('Ghostscript rasterizing failed')
+            raise SubprocessOutputError()
+
+        # Ghostscript only accepts integers for output resolution
+        # if the resolution happens to be fractional, then the discrepancy
+        # would change the size of the output page, especially if the DPI
+        # is quite low. Resize the image to the expected size
+
+        tmp.seek(0)
+        with Image.open(tmp) as im:
+            expected_size = round(im.size[0] / int_res[0] * res[0]), \
+                            round(im.size[1] / int_res[1] * res[1])
+            if expected_size != im.size or page_dpi != (xres, yres):
+                log.debug(
+                    "Ghostscript: resize output image {} -> {}".format(
+                        im.size, expected_size))
+                im.resize(expected_size).save(
+                    fspath(output_file), dpi=page_dpi)
+            else:
+                copy(tmp.name, fspath(output_file))
+
+
+def generate_pdfa(pdf_pages, output_file, compression, log,
+                  threads=1, pdf_version='1.5', pdfa_part='2'):
+    compression_args = []
+    if compression == 'jpeg':
+        compression_args = [
+            "-dAutoFilterColorImages=false",
+            "-dColorImageFilter=/DCTEncode",
+            "-dAutoFilterGrayImages=false",
+            "-dGrayImageFilter=/DCTEncode",
+        ]
+    elif compression == 'lossless':
+        compression_args = [
+            "-dAutoFilterColorImages=false",
+            "-dColorImageFilter=/FlateEncode",
+            "-dAutoFilterGrayImages=false",
+            "-dGrayImageFilter=/FlateEncode",
+        ]
+    else:
+        compression_args = [
+            "-dAutoFilterColorImages=true",
+            "-dAutoFilterGrayImages=true",
+        ]
+
+    # Older versions of Ghostscript expect a leading slash in
+    # sColorConversionStrategy, newer ones should not have it. See Ghostscript
+    # git commit fe1c025d.
+    strategy = 'RGB' if version() >= '9.19' else '/RGB'
+
+    if version() >= '9.23':
+        # 9.23: new feature JPEG passthrough is broken in some cases, best to
+        # disable it always
+        # https://bugs.ghostscript.com/show_bug.cgi?id=699216
+        # fixed in 9.24, but to avoid changing expected behavior we disable it
+        # for ocrmypdf 6.x
+        compression_args.append('-dPassThroughJPEGImages=false')
+
+    with NamedTemporaryFile(delete=True) as gs_pdf:
+        args_gs = [
+            "gs",
+            "-dQUIET",
+            "-dBATCH",
+            "-dNOPAUSE",
+            "-dCompatibilityLevel=" + str(pdf_version),
+            "-dNumRenderingThreads=" + str(threads),
+            "-sDEVICE=pdfwrite",
+            "-dAutoRotatePages=/None",
+            "-sColorConversionStrategy=" + strategy,
+            "-sProcessColorModel=DeviceRGB"
+        ] + compression_args + [
+            "-dJPEGQ=95",
+            "-dPDFA=" + pdfa_part,
+            "-dPDFACompatibilityPolicy=1",
+            "-sOutputFile=" + gs_pdf.name,
+        ]
+        args_gs.extend(pdf_pages)
+        p = run(args_gs, stdout=PIPE, stderr=STDOUT,
+                universal_newlines=True)
+
+        if _gs_error_reported(p.stdout):
+            log.error(p.stdout)
+        elif 'overprint mode not set' in p.stdout:
+            # Unless someone is going to print PDF/A documents on a
+            # magical sRGB printer I can't see the removal of overprinting
+            # being a problem....
+            log.debug(
+                "Ghostscript had to remove PDF 'overprinting' from the "
+                "input file to complete PDF/A conversion. "
+                )
+        else:
+            log.debug(p.stdout)
+
+        if p.returncode == 0:
+            # Ghostscript does not change return code when it fails to create
+            # PDF/A - check PDF/A status elsewhere
+            copy(gs_pdf.name, output_file)
+        else:
+            log.error('Ghostscript PDF/A rendering failed')
+            raise SubprocessOutputError()

src/ocrmypdf/exec/qpdf.py

@@ -0,0 +1,227 @@
+# © 2017 James R. Barlow: github.com/jbarlow83
+#
+# This file is part of OCRmyPDF.
+#
+# OCRmyPDF is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# OCRmyPDF 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.
+#
+# You should have received a copy of the GNU General Public License
+# along with OCRmyPDF.  If not, see <http://www.gnu.org/licenses/>.
+
+from subprocess import CalledProcessError, STDOUT, PIPE, run
+from functools import lru_cache
+import sys
+import os
+import re
+import resource
+
+from ..exceptions import InputFileError, SubprocessOutputError, \
+    MissingDependencyError, EncryptedPdfError
+from . import  get_version
+from ..helpers import re_symlink
+
+
+@lru_cache(maxsize=1)
+def version():
+    return get_version('qpdf', regex=r'qpdf version (.+)')    
+
+
+def check(input_file, log=None):
+    args_qpdf = [
+        'qpdf',
+        '--check',
+        input_file
+    ]
+
+    if log is None:
+        import logging as log
+
+    try:
+        run(args_qpdf, stderr=STDOUT, stdout=PIPE, universal_newlines=True, 
+            check=True)
+    except CalledProcessError as e:
+        if e.returncode == 2:
+            log.error("{0}: not a valid PDF, and could not repair it.".format(
+                input_file))
+            log.error("Details:")
+            log.error(e.output)
+        elif e.returncode == 3:
+            log.info("qpdf --check returned warnings:")
+            log.info(e.output)
+        else:
+            log.warning(e.output)
+        return False
+    return True
+
+
+def _probably_encrypted(e):
+    """qpdf can report a false positive "file is encrypted" message for damaged
+    files - suppress this"""
+    return e.returncode == 2 and \
+        'invalid password' in e.output and \
+        'file is damaged' not in e.output
+
+
+def repair(input_file, output_file, log):
+    args_qpdf = [
+        'qpdf', input_file, output_file
+    ]
+    try:
+        run(args_qpdf, stderr=STDOUT, stdout=PIPE, universal_newlines=True, 
+            check=True)
+    except CalledProcessError as e:
+        if e.returncode == 3 and e.output.find("operation succeeded"):
+            log.debug('qpdf found and fixed errors: ' + e.output)
+            return
+
+        if _probably_encrypted(e):
+            raise EncryptedPdfError() from e
+        elif e.returncode == 2:
+            log.error("{0}: not a valid PDF, and could not repair it.".format(
+                      input_file))
+            log.error("Details: " + e.output)
+            raise InputFileError() from e
+        else:
+            log.error("{0}: unknown error".format(
+                      input_file))
+            log.error(e.output)
+            raise SubprocessOutputError() from e
+
+
+def get_npages(input_file, log):
+    try:
+        pages = run(
+            ['qpdf', '--show-npages', input_file],
+            universal_newlines=True, check=True, stdout=PIPE, stderr=STDOUT)
+    except CalledProcessError as e:
+        if e.returncode == 2 and e.output.find('No such file'):
+            log.error(e.output)
+            raise InputFileError() from e
+    return int(pages)
+
+
+def split_pages(input_file, work_folder, npages):
+    """Split multipage PDF into individual pages.
+
+    Incredibly enough, this multiple process approach is about 70 times
+    faster than using Ghostscript.
+    """
+    for n in range(int(npages)):
+        args_qpdf = [
+            'qpdf', input_file,
+            '--pages', input_file, '{0}'.format(n + 1), '--',
+            os.path.join(work_folder, '{0:06d}.page.pdf'.format(n + 1))
+        ]
+        run(args_qpdf, check=True)
+
+
+def extract_page(input_file, output_file, pageno):
+    args_qpdf = [
+        'qpdf', input_file,
+        '--pages', input_file, '{0}'.format(pageno + 1), '--',
+        output_file
+    ]
+    run(args_qpdf, check=True)
+    
+
+def _merge_inner(input_files, output_file, min_version=None, log=None):
+    """Merge the list of input files (all filenames) into the output file.
+
+    The input files may contain one or more pages.
+    """
+
+    # Single page 'merges' should still be attempted to that the same error
+    # checking is applied to single page case
+
+    version_arg = ['--min-version={}'.format(min_version)] \
+                  if min_version else []
+
+    if log is None:
+        import logging as log
+
+    args_qpdf = [
+        'qpdf'
+    ] + version_arg + [
+        input_files[0], '--pages'
+    ] + input_files + ['--', output_file]
+
+    try:
+        run(args_qpdf, check=True, stderr=PIPE, universal_newlines=True)
+    except CalledProcessError as e:
+        if e.returncode == 3 and \
+                e.stderr.find("unknown token while reading object") and \
+                e.stderr.find("operation succeeded"):
+            # Only whitelist the 'unknown token' problem (decimal/string issue)
+            # qpdf issue #165
+            log.warning('qpdf found and fixed errors: ' + e.stderr)
+            return
+        raise e from e
+
+
+def merge(input_files, output_file, min_version=None, log=None, max_files=None):
+    """Merge the list of input files (all filenames) into the output file.
+
+    The input files may contain one or more pages.
+
+    """
+    # qpdf requires that every file that contributes to the output has a file 
+    # descriptor that remains open. That means, given our approach of one 
+    # intermediate PDF per, we can practically hit the number of file 
+    # descriptors. 
+
+    if max_files is None or max_files < 2:
+        # Find out how many open file descriptors we can get away with
+        ulimits = resource.getrlimit(resource.RLIMIT_NOFILE)
+        max_open_files = ulimits[0]
+        max_files = max_open_files // 2  # Conservative guess
+
+    # We'll write things alongside the output file
+    output_dir = os.path.dirname(output_file)
+
+    import random
+    import string    
+
+    def randstr():
+        return ''.join(random.sample(string.ascii_lowercase, 6))
+
+    # How many files to grab at once, merging all their contents
+    step_size = max_files
+
+    workqueue = input_files.copy()
+    counter = 1
+    next_workqueue = []
+    while len(workqueue) > 1 or len(next_workqueue) > 0:
+        # Take n files out of the queue
+        n = min(step_size, len(workqueue))
+        job = workqueue[0:n]
+        del workqueue[0:n]
+        log.debug('merging ' + repr(job))
+
+        # Merge them into 1 file, which will contain n^depth pages
+        merge_file = os.path.join(
+            output_dir, "merge-{:06d}-{}.pdf".format(counter, randstr()))
+        counter += 1
+        _merge_inner(job, merge_file, min_version=min_version, log=log)
+
+        # On the next 
+        next_workqueue.append(merge_file)
+        log.debug('next_workqueue ' + repr(next_workqueue))
+
+        # If we're out of things to do in this queue, move on to the next
+        # queue. On the counter-th pass of the workqueue we can chew through
+        # (step_size)**N pages, so on most systems the second pass finishes
+        # the job.
+        if len(workqueue) == 0:
+            workqueue = next_workqueue
+            next_workqueue = []
+
+    re_symlink(workqueue.pop(), output_file, log)
+
+

src/ocrmypdf/exec/tesseract.py

@@ -0,0 +1,373 @@
+# © 2017 James R. Barlow: github.com/jbarlow83
+#
+# This file is part of OCRmyPDF.
+#
+# OCRmyPDF is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# OCRmyPDF 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.
+#
+# You should have received a copy of the GNU General Public License
+# along with OCRmyPDF.  If not, see <http://www.gnu.org/licenses/>.
+
+import sys
+import os
+import re
+import shutil
+from functools import lru_cache
+from collections import namedtuple
+from textwrap import dedent
+from subprocess import PIPE, CalledProcessError, \
+    TimeoutExpired, check_output, STDOUT
+from contextlib import suppress
+
+import PyPDF2 as pypdf
+
+from ..exceptions import MissingDependencyError, TesseractConfigError
+from ..helpers import page_number
+from . import get_version
+
+OrientationConfidence = namedtuple(
+    'OrientationConfidence',
+    ('angle', 'confidence'))
+
+HOCR_TEMPLATE = """<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+  <title></title>
+<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+  <meta name='ocr-system' content='tesseract 3.05.00' />
+  <meta name='ocr-capabilities' content='ocr_page ocr_carea ocr_par ocr_line ocrx_word'/>
+</head>
+<body>
+  <div class='ocr_page' id='page_1' title='image "_blank.png"; bbox 0 0 {0} {1}; ppageno 0'>
+  </div>
+ </body>
+</html>
+"""
+
+
+@lru_cache(maxsize=1)
+def version():
+    return get_version('tesseract', regex=r'tesseract\s(.+)')
+
+
+def v4():
+    "Is this Tesseract v4.0?"
+    return version() >= '4'
+
+
+@lru_cache(maxsize=1)
+def has_textonly_pdf():
+    """Does Tesseract have textonly_pdf capability?
+    
+    Available in 3.05.01, and v4.00.00alpha since January 2017. Best to 
+    parse the parameter list
+    """
+    args_tess = [
+        'tesseract',
+        '--print-parameters',
+        'pdf'
+    ]
+    params = ''
+    try:
+        params = check_output(
+                args_tess, universal_newlines=True, stderr=STDOUT)
+    except CalledProcessError as e:
+        print("Could not --print-parameters from tesseract",
+              file=sys.stderr)
+        raise MissingDependencyError from e
+    if 'textonly_pdf' in params:
+        return True
+    return False
+
+
+def psm():
+    "If Tesseract 4.0, use argument --psm instead of -psm"
+    return '--psm' if v4() else '-psm'
+
+
+@lru_cache(maxsize=1)
+def languages():
+    args_tess = [
+        'tesseract',
+        '--list-langs'
+    ]
+    try:
+        langs = check_output(
+                args_tess, universal_newlines=True, stderr=STDOUT)
+    except CalledProcessError as e:
+        msg = dedent("""Tesseract failed to report available languages.
+        Output from Tesseract:
+        -----------
+        """)
+        msg += e.output
+        print(msg, file=sys.stderr)
+        raise MissingDependencyError from e
+    return set(lang.strip() for lang in langs.splitlines()[1:])
+
+
+def tess_base_args(langs, engine_mode):
+    args = [
+        'tesseract',
+    ]
+    if langs:
+        args.extend(['-l', '+'.join(langs)])
+    if engine_mode is not None and v4():
+        args.extend(['--oem', str(engine_mode)])
+    return args
+
+
+def get_orientation(input_file, language: list, engine_mode, timeout: float,
+                    log):
+    args_tesseract = tess_base_args(['osd'], engine_mode) + [
+        psm(), '0',
+        input_file,
+        'stdout'
+    ]
+
+    try:
+        stdout = check_output(
+            args_tesseract, stderr=STDOUT, timeout=timeout)
+    except TimeoutExpired:
+        return OrientationConfidence(angle=0, confidence=0.0)
+    except CalledProcessError as e:
+        tesseract_log_output(log, e.output, input_file)
+        if (b'Too few characters. Skipping this page' in e.output or
+                b'Image too large' in e.output):
+            return OrientationConfidence(0, 0)
+        raise e from e
+    else:
+        osd = {}
+        for line in stdout.decode().splitlines():
+            line = line.strip()
+            parts = line.split(':', maxsplit=2)
+            if len(parts) == 2:
+                osd[parts[0].strip()] = parts[1].strip()
+
+        angle = int(osd.get('Orientation in degrees', 0))
+        if 'Orientation' in osd:
+            # Tesseract < 3.04.01
+            # reports "Orientation in degrees" as a counterclockwise angle
+            # We keep it clockwise
+            assert 'Rotate' not in osd
+            angle = -angle % 360
+        else:
+            # Tesseract >= 3.04.01
+            # reports "Orientation in degrees" as a clockwise angle
+            assert 'Rotate' in osd
+
+        oc = OrientationConfidence(
+            angle=angle,
+            confidence=float(osd.get('Orientation confidence', 0)))
+        return oc
+
+
+def tesseract_log_output(log, stdout, input_file):
+    prefix = "{0:4d}: [tesseract] ".format(page_number(input_file))
+
+    try:
+        text = stdout.decode()
+    except UnicodeDecodeError:
+        log.error(prefix + "command line output was not utf-8. " +
+            "This usually means Tesseract's language packs do not match "
+            "the installed version of Tesseract.")
+        text = stdout.decode('utf-8', 'backslashreplace')
+
+    lines = text.splitlines()
+    for line in lines:
+        if line.startswith("Tesseract Open Source"):
+            continue
+        elif line.startswith("Warning in pixReadMem"):
+            continue
+        elif 'diacritics' in line:
+            log.warning(prefix + "lots of diacritics - possibly poor OCR")
+        elif line.startswith('OSD: Weak margin'):
+            log.warning(prefix + "unsure about page orientation")
+        elif 'error' in line.lower() or 'exception' in line.lower():
+            log.error(prefix + line.strip())
+        elif 'warning' in line.lower():
+            log.warning(prefix + line.strip())
+        elif 'read_params_file' in line.lower():
+            log.error(prefix + line.strip())
+        else:
+            log.info(prefix + line.strip())
+
+
+def page_timedout(log, input_file):
+    prefix = "{0:4d}: [tesseract] ".format(page_number(input_file))
+    log.warning(prefix + " took too long to OCR - skipping")
+
+
+def _generate_null_hocr(output_hocr, output_sidecar, image):
+    """Produce a .hocr file that reports no text detected on a page that is
+    the same size as the input image."""
+    from PIL import Image
+
+    im = Image.open(image)
+    w, h = im.size
+
+    with open(output_hocr, 'w', encoding="utf-8") as f:
+        f.write(HOCR_TEMPLATE.format(w, h))
+    with open(output_sidecar, 'w', encoding='utf-8') as f:
+        f.write('[skipped page]')
+
+
+def generate_hocr(input_file, output_files, language: list, engine_mode,
+                  tessconfig: list,
+                  timeout: float, pagesegmode: int, user_words, user_patterns,
+                  log):
+
+    output_hocr = next(o for o in output_files if o.endswith('.hocr'))
+    output_sidecar = next(o for o in output_files if o.endswith('.txt'))
+    prefix = os.path.splitext(output_hocr)[0]
+
+    args_tesseract = tess_base_args(language, engine_mode)
+
+    if pagesegmode is not None:
+        args_tesseract.extend([psm(), str(pagesegmode)])
+
+    if user_words:
+        args_tesseract.extend(['--user-words', user_words])
+
+    if user_patterns:
+        args_tesseract.extend(['--user-patterns', user_patterns])
+
+    # Reminder: test suite tesseract spoofers will break after any changes
+    # to the number of order parameters here
+    # Tesseract 3.04 requires the order here to be "hocr txt" and will fail
+    # on "txt hocr"
+
+    args_tesseract.extend([
+        input_file,
+        prefix,
+        'hocr',
+        'txt'
+    ] + tessconfig)
+    try:
+        log.debug(args_tesseract)
+        stdout = check_output(
+            args_tesseract, stderr=STDOUT,
+            timeout=timeout)
+    except TimeoutExpired:
+        # Generate a HOCR file with no recognized text if tesseract times out
+        # Temporary workaround to hocrTransform not being able to function if
+        # it does not have a valid hOCR file.
+        page_timedout(log, input_file)
+        _generate_null_hocr(output_hocr, output_sidecar, input_file)
+    except CalledProcessError as e:
+        tesseract_log_output(log, e.output, input_file)
+        if b'read_params_file: parameter not found' in e.output:
+            raise TesseractConfigError() from e
+        if b'Image too large' in e.output:
+            _generate_null_hocr(output_hocr, output_sidecar, input_file)
+            return
+
+        raise e from e
+    else:
+        tesseract_log_output(log, stdout, input_file)
+        # The sidecar text file will get the suffix .txt; rename it to
+        # whatever caller wants it named
+        if os.path.exists(prefix + '.txt'):
+            shutil.move(prefix + '.txt', output_sidecar)
+
+
+def use_skip_page(text_only, skip_pdf, output_pdf, output_text):
+    with open(output_text, 'w') as f:
+        f.write('[skipped page]')
+
+    if not text_only:
+        with suppress(FileNotFoundError):
+            os.remove(output_pdf)  # In case it was partially created
+        os.symlink(skip_pdf, output_pdf)
+        return
+
+    # For text only we must create a blank page with dimensions identical
+    # to the skip page because this is equivalent to a page with no text
+
+    pdf_in = pypdf.PdfFileReader(skip_pdf)
+    page0 = pdf_in.pages[0]
+
+    with open(output_pdf, 'wb') as out:
+        pdf_out = pypdf.PdfFileWriter()
+        w, h = page0.mediaBox.getWidth(), page0.mediaBox.getHeight()
+        # If skip page has a /Rotate key, replicate the rotation
+        rotation = int(page0.get('/Rotate', 0))
+        if rotation % 180 == 90:
+            w, h = h, w
+        pdf_out.addBlankPage(w, h)
+        pdf_out.write(out)
+
+
+def generate_pdf(*, input_image, skip_pdf, output_pdf, output_text,
+                 language: list, engine_mode, text_only: bool,
+                 tessconfig: list, timeout: float, pagesegmode: int,
+                 user_words, user_patterns, log):
+    '''Use Tesseract to render a PDF.
+
+    input_image -- image to analyze
+    skip_pdf -- if we time out, use this file as output
+    output_pdf -- file to generate
+    output_text -- OCR text file
+    language -- list of languages to consider
+    engine_mode -- engine mode argument for tess v4
+    text_only -- enable tesseract text only mode?
+    tessconfig -- tesseract configuration
+    timeout -- timeout (seconds)
+    log -- logger object
+    '''
+
+    args_tesseract = tess_base_args(language, engine_mode)
+
+    if pagesegmode is not None:
+        args_tesseract.extend([psm(), str(pagesegmode)])
+
+    if text_only:
+        args_tesseract.extend(['-c', 'textonly_pdf=1'])
+
+    if user_words:
+        args_tesseract.extend(['--user-words', user_words])
+
+    if user_patterns:
+        args_tesseract.extend(['--user-patterns', user_patterns])
+
+    prefix = os.path.splitext(output_pdf)[0]  # Tesseract appends suffixes
+
+    # Reminder: test suite tesseract spoofers might break after any changes
+    # to the number of order parameters here
+
+    args_tesseract.extend([
+        input_image,
+        prefix,
+        'pdf',
+        'txt'
+    ] + tessconfig)
+
+    try:
+        log.debug(args_tesseract)
+        stdout = check_output(
+            args_tesseract, stderr=STDOUT,
+            timeout=timeout)
+        if os.path.exists(prefix + '.txt'):
+            shutil.move(prefix + '.txt', output_text)
+    except TimeoutExpired:
+        page_timedout(log, input_image)
+        use_skip_page(text_only, skip_pdf, output_pdf, output_text)
+    except CalledProcessError as e:
+        tesseract_log_output(log, e.output, input_image)
+        if b'read_params_file: parameter not found' in e.output:
+            raise TesseractConfigError() from e
+
+        if b'Image too large' in e.output:
+            use_skip_page(text_only, skip_pdf, output_pdf, output_text)
+            return
+        raise e from e
+    else:
+        tesseract_log_output(log, stdout, input_image)

src/ocrmypdf/exec/unpaper.py

@@ -0,0 +1,102 @@
+# © 2015 James R. Barlow: github.com/jbarlow83
+#
+# This file is part of OCRmyPDF.
+#
+# OCRmyPDF is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# OCRmyPDF 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.
+#
+# You should have received a copy of the GNU General Public License
+# along with OCRmyPDF.  If not, see <http://www.gnu.org/licenses/>.
+
+# unpaper documentation:
+# https://github.com/Flameeyes/unpaper/blob/master/doc/basic-concepts.md
+
+from subprocess import CalledProcessError, STDOUT, check_output
+from tempfile import NamedTemporaryFile
+import sys
+import os
+from functools import lru_cache
+from ..exceptions import MissingDependencyError
+from . import get_version
+
+
+try:
+    from PIL import Image
+except ImportError:
+    print("Could not find Python3 imaging library", file=sys.stderr)
+    raise
+
+
+@lru_cache(maxsize=1)
+def version():
+    return get_version('unpaper')
+
+
+def run(input_file, output_file, dpi, log, mode_args):
+    args_unpaper = [
+        'unpaper',
+        '-v',
+        '--dpi', str(dpi)
+    ] + mode_args
+
+    SUFFIXES = {'1': '.pbm', 'L': '.pgm', 'RGB': '.ppm'}
+
+    im = Image.open(input_file)
+    if im.mode not in SUFFIXES.keys():
+        log.info("Converting image to other colorspace")
+        try:
+            if im.mode == 'P' and len(im.getcolors()) == 2:
+                im = im.convert(mode='1')
+            else:
+                im = im.convert(mode='RGB')
+        except IOError as e:
+            log.error("Could not convert image with type " + im.mode)
+            im.close()
+            raise MissingDependencyError() from e
+
+    try:
+        suffix = SUFFIXES[im.mode]
+    except KeyError:
+        log.error("Failed to convert image to a supported format.")
+        im.close()
+        raise MissingDependencyError() from e
+
+    with NamedTemporaryFile(suffix=suffix) as input_pnm, \
+            NamedTemporaryFile(suffix=suffix, mode="r+b") as output_pnm:
+        im.save(input_pnm, format='PPM')
+        im.close()
+
+        os.unlink(output_pnm.name)
+
+        args_unpaper.extend([input_pnm.name, output_pnm.name])
+        try:
+            stdout = check_output(
+                args_unpaper, close_fds=True,
+                universal_newlines=True, stderr=STDOUT,
+                )
+        except CalledProcessError as e:
+            log.debug(e.output)
+            raise e from e
+        else:
+            log.debug(stdout)
+            # unpaper sets dpi to 72
+            Image.open(output_pnm.name).save(output_file, dpi=(dpi, dpi))
+
+
+def clean(input_file, output_file, dpi, log):
+    run(input_file, output_file, dpi, log, [
+        '--layout', 'none',
+        '--mask-scan-size', '100',  # don't blank out narrow columns
+        '--no-border-align',  # don't align visible content to borders
+        '--no-mask-center',   # don't center visible content within page
+        '--no-grayfilter',    # don't remove light gray areas
+        '--no-blackfilter',   # don't remove solid black areas
+        '--no-deskew',        # don't deskew
+    ])

src/ocrmypdf/extra_plugins/semfree.py

@@ -1,191 +0,0 @@
-# © 2021 James R. Barlow: github.com/jbarlow83
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-
-"""Semaphore-free alternate executor.
-
-There are two popular environments that do not fully support the standard Python
-multiprocessing module: AWS Lambda, and Termux (a terminal emulator for Android).
-
-This alternate executor divvies up work among worker processes before processing,
-rather than having each worker consume work from a shared queue when they finish
-their task. This means workers have no need to coordinate with each other. Each
-worker communicates only with the main process.
-
-This is not without drawbacks. If the tasks are not "even" in size, which cannot
-be guaranteed, some workers may end up with too much work while others are idle.
-It is less efficient than the standard implementation, so not th edefault.
-"""
-
-import logging
-import logging.handlers
-import signal
-from contextlib import suppress
-from enum import Enum, auto
-from itertools import islice, repeat, takewhile, zip_longest
-from multiprocessing import Pipe, Process
-from multiprocessing.connection import Connection, wait
-from typing import Callable, Iterable, Iterator
-
-from ocrmypdf import Executor, hookimpl
-from ocrmypdf._concurrent import NullProgressBar
-from ocrmypdf.exceptions import InputFileError
-from ocrmypdf.helpers import remove_all_log_handlers
-
-
-class MessageType(Enum):
-    exception = auto()
-    result = auto()
-    complete = auto()
-
-
-def split_every(n: int, iterable: Iterable) -> Iterator:
-    """Split iterable into groups of n.
-
-    >>> list(split_every(4, range(10)))
-    [[0, 1, 2], [3, 4, 5], [6, 7, 8], [9]]
-
-    https://stackoverflow.com/a/22919323
-    """
-    iterator = iter(iterable)
-    return takewhile(bool, (list(islice(iterator, n)) for _ in repeat(None)))
-
-
-def process_sigbus(*args):
-    raise InputFileError("A worker process lost access to an input file")
-
-
-class ConnectionLogHandler(logging.handlers.QueueHandler):
-    def __init__(self, conn: Connection) -> None:
-        super().__init__(None)
-        self.conn = conn
-
-    def enqueue(self, record):
-        self.conn.send(('log', record))
-
-
-def process_loop(
-    conn: Connection, user_init: Callable[[], None], loglevel, task, task_args
-):
-    """Initialize a process pool worker"""
-
-    # Install SIGBUS handler (so our parent process can abort somewhat gracefully)
-    with suppress(AttributeError):  # Windows and Cygwin do not have SIGBUS
-        # Windows and Cygwin do not have pthread_sigmask or SIGBUS
-        signal.signal(signal.SIGBUS, process_sigbus)
-
-    # Reconfigure the root logger for this process to send all messages to a queue
-    h = ConnectionLogHandler(conn)
-    root = logging.getLogger()
-    remove_all_log_handlers(root)
-    root.setLevel(loglevel)
-    root.addHandler(h)
-
-    user_init()
-
-    for args in task_args:
-        try:
-            result = task(args)
-        except Exception as e:
-            conn.send((MessageType.exception, e))
-            break
-        else:
-            conn.send((MessageType.result, result))
-
-    conn.send((MessageType.complete, None))
-    conn.close()
-    return
-
-
-class LambdaExecutor(Executor):
-    def _execute(
-        self,
-        *,
-        use_threads: bool,
-        max_workers: int,
-        tqdm_kwargs: dict,
-        worker_initializer: Callable,
-        task: Callable,
-        task_arguments: Iterable,
-        task_finished: Callable,
-    ):
-        if use_threads and max_workers == 1:
-            with self.pbar_class(**tqdm_kwargs) as pbar:
-                for args in task_arguments:
-                    result = task(args)
-                    task_finished(result, pbar)
-            return
-
-        task_arguments = list(task_arguments)
-        grouped_args = list(
-            zip_longest(*list(split_every(max_workers, task_arguments)))
-        )
-        if not grouped_args:
-            return
-
-        processes = []
-        connections = []
-        for chunk in grouped_args:
-            parent_conn, child_conn = Pipe()
-
-            worker_args = [args for args in chunk if args is not None]
-            process = Process(
-                target=process_loop,
-                args=(
-                    child_conn,
-                    worker_initializer,
-                    logging.getLogger("").level,
-                    task,
-                    worker_args,
-                ),
-            )
-            process.daemon = True
-            processes.append(process)
-            connections.append(parent_conn)
-
-        for process in processes:
-            process.start()
-
-        with self.pbar_class(**tqdm_kwargs) as pbar:
-            while connections:
-                for r in wait(connections):
-                    try:
-                        msg_type, msg = r.recv()
-                    except EOFError:
-                        connections.remove(r)
-                        continue
-
-                    if msg_type == MessageType.result:
-                        if task_finished:
-                            task_finished(msg, pbar)
-                    elif msg_type == 'log':
-                        record = msg
-                        logger = logging.getLogger(record.name)
-                        logger.handle(record)
-                    elif msg_type == MessageType.complete:
-                        connections.remove(r)
-                    elif msg_type == MessageType.exception:
-                        for process in processes:
-                            process.terminate()
-                        raise msg
-
-        for process in processes:
-            process.join()
-
-
-@hookimpl
-def get_executor(progressbar_class):
-    return LambdaExecutor(pbar_class=progressbar_class)
-
-
-@hookimpl
-def get_logging_console():
-    return logging.StreamHandler()
-
-
-@hookimpl
-def get_progressbar_class():
-    return NullProgressBar

src/ocrmypdf/helpers.py

@@ -1,283 +1,172 @@
 # © 2016 James R. Barlow: github.com/jbarlow83
 #
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+# This file is part of OCRmyPDF.
+#
+# OCRmyPDF is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# OCRmyPDF 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.
+#
+# You should have received a copy of the GNU General Public License
+# along with OCRmyPDF.  If not, see <http://www.gnu.org/licenses/>.
 
+from PIL import Image
 
-import logging
-import multiprocessing
-import os
-import shutil
-import warnings
-from collections import namedtuple
+from functools import partial
 from collections.abc import Iterable
-from contextlib import suppress
-from functools import wraps
-from io import StringIO
-from math import isclose, isfinite
+from contextlib import suppress, contextmanager
 from pathlib import Path
-from typing import Any, Sequence
-
-import pikepdf
-
-log = logging.getLogger(__name__)
+import sys
+import os
+import multiprocessing
+import warnings
 
 
-class Resolution(namedtuple('Resolution', ('x', 'y'))):
-    """The number of pixels per inch in each 2D direction.
-
-    Resolution objects are considered "equal" for == purposes if they are
-    equal to a reasonable tolerance.
+def re_symlink(input_file, soft_link_name, log=None):
+    """
+    Helper function: relinks soft symbolic link if necessary
     """
 
-    __slots__ = ()
-
-    # rel_tol after converting from dpi to pixels per meter and saving
-    # as integer with rounding, as many file formats
-    CONVERSION_ERROR = 0.002
-
-    def round(self, ndigits: int):
-        return Resolution(round(self.x, ndigits), round(self.y, ndigits))
-
-    def to_int(self):
-        return Resolution(int(round(self.x)), int(round(self.y)))
-
-    @classmethod
-    def _isclose(cls, a, b):
-        return isclose(a, b, rel_tol=cls.CONVERSION_ERROR)
-
-    @property
-    def is_square(self) -> bool:
-        return self._isclose(self.x, self.y)
-
-    @property
-    def is_finite(self) -> bool:
-        return isfinite(self.x) and isfinite(self.y)
-
-    def take_max(self, vals, yvals=None):
-        if yvals is not None:
-            return Resolution(max(self.x, *vals), max(self.y, *yvals))
-        max_x, max_y = self.x, self.y
-        for x, y in vals:
-            max_x = max(x, max_x)
-            max_y = max(y, max_y)
-        return Resolution(max_x, max_y)
-
-    def flip_axis(self):
-        return Resolution(self.y, self.x)
-
-    def __str__(self):
-        return f"{self.x:f}x{self.y:f}"
-
-    def __repr__(self):  # pragma: no cover
-        return f"Resolution({self.x}x{self.y} dpi)"
-
-    def __eq__(self, other):
-        if isinstance(other, tuple) and len(other) == 2:
-            other = Resolution(*other)
-        if not isinstance(other, Resolution):
-            return NotImplemented
-        return self._isclose(self.x, other.x) and self._isclose(self.y, other.y)
-
-
-class NeverRaise(Exception):
-    """An exception that is never raised"""
-
-
-def safe_symlink(input_file: os.PathLike, soft_link_name: os.PathLike):
-    """Create a symbolic link at ``soft_link_name``, which references ``input_file``.
-
-    Think of this as copying ``input_file`` to ``soft_link_name`` with less overhead.
-
-    Use symlinks safely. Self-linking loops are prevented. On Windows, file copy is
-    used since symlinks may require administrator privileges. An existing link at the
-    destination is removed.
-    """
-    input_file = os.fspath(input_file)
-    soft_link_name = os.fspath(soft_link_name)
+    if log is None:
+        prdebug = partial(print, file=sys.stderr)
+    else:
+        prdebug = log.debug
 
     # Guard against soft linking to oneself
     if input_file == soft_link_name:
-        log.warning(
-            "No symbolic link created. You are using  the original data directory "
-            "as the working directory."
-        )
+        prdebug("Warning: No symbolic link made. You are using " +
+                "the original data directory as the working directory.")
         return
 
     # Soft link already exists: delete for relink?
     if os.path.lexists(soft_link_name):
         # do not delete or overwrite real (non-soft link) file
         if not os.path.islink(soft_link_name):
-            raise FileExistsError(f"{soft_link_name} exists and is not a link")
-        os.unlink(soft_link_name)
+            raise FileExistsError(
+                "%s exists and is not a link" % soft_link_name)
+        try:
+            os.unlink(soft_link_name)
+        except OSError:
+            prdebug("Can't unlink %s" % (soft_link_name))
 
     if not os.path.exists(input_file):
-        raise FileNotFoundError(f"trying to create a broken symlink to {input_file}")
+        raise FileNotFoundError(
+            "trying to create a broken symlink to %s" % input_file)
 
-    if os.name == 'nt':
-        # Don't actually use symlinks on Windows due to permission issues
-        shutil.copyfile(input_file, soft_link_name)
-        return
-
-    log.debug("os.symlink(%s, %s)", input_file, soft_link_name)
+    prdebug("os.symlink(%s, %s)" % (input_file, soft_link_name))
 
     # Create symbolic link using absolute path
-    os.symlink(os.path.abspath(input_file), soft_link_name)
+    os.symlink(
+        os.path.abspath(input_file),
+        soft_link_name
+    )
 
 
-def samefile(f1: os.PathLike, f2: os.PathLike):
-    if os.name == 'nt':
-        return f1 == f2
-    else:
-        return os.path.samefile(f1, f2)
-
-
-def is_iterable_notstr(thing: Any) -> bool:
-    """Is this is an iterable type, other than a string?"""
+def is_iterable_notstr(thing):
     return isinstance(thing, Iterable) and not isinstance(thing, str)
 
 
-def monotonic(L: Sequence) -> bool:
-    """Does this sequence increase monotonically?"""
-    return all(b > a for a, b in zip(L, L[1:]))
+def page_number(input_file):
+    "Get one-based page number implied by filename (000002.pdf -> 2)"
+    return int(os.path.basename(fspath(input_file))[0:6])
 
 
-def page_number(input_file: os.PathLike) -> int:
-    """Get one-based page number implied by filename (000002.pdf -> 2)"""
-    return int(os.path.basename(os.fspath(input_file))[0:6])
-
-
-def available_cpu_count() -> int:
-    """Returns number of CPUs in the system."""
+def available_cpu_count():
     try:
         return multiprocessing.cpu_count()
     except NotImplementedError:
         pass
+
+    try:
+        import psutil
+        return psutil.cpu_count()
+    except (ImportError, AttributeError):
+        pass
+
     warnings.warn(
-        "Could not get CPU count.  Assuming one (1) CPU." "Use -j N to set manually."
-    )
+        "Could not get CPU count.  Assuming one (1) CPU."
+        "Use -j N to set manually.")
     return 1
 
 
-def is_file_writable(test_file: os.PathLike) -> bool:
+def is_file_writable(test_file):
     """Intentionally racy test if target is writable.
 
     We intend to write to the output file if and only if we succeed and
     can replace it atomically. Before doing the OCR work, make sure
     the location is writable.
     """
-    try:
-        p = Path(test_file)
-        if p.is_symlink():
+    p = Path(test_file)
+
+    if p.is_symlink():
+        # Python 3.5 does not accept parameters for Path.resolve() and behaves
+        # as if strict=True (throws an exception on failure). Python 3.6
+        # defaults to strict=False. This implements strict=False like behavior
+        # for Python 3.5.
+        if sys.version_info[0:2] <= (3, 5):
+            p = Path(os.path.realpath(str(p)))
+        else:
             p = p.resolve(strict=False)
 
-        # p.is_file() throws an exception in some cases
-        if p.exists() and p.is_file():
-            return os.access(
-                os.fspath(p),
-                os.W_OK,
-                effective_ids=(os.access in os.supports_effective_ids),
-            )
-        else:
-            try:
-                fp = p.open('wb')
-            except OSError:
-                return False
-            else:
-                fp.close()
-                with suppress(OSError):
-                    p.unlink()
-            return True
-    except (EnvironmentError, RuntimeError) as e:
-        log.debug(e)
-        log.error(str(e))
-        return False
-
-
-def check_pdf(input_file: Path) -> bool:
-    """Check if a PDF complies with the PDF specification.
-
-    Checks for proper formatting and proper linearization. Uses pikepdf (which in
-    turn, uses QPDF) to perform the checks.
-    """
-    try:
-        pdf = pikepdf.open(input_file)
-    except pikepdf.PdfError as e:
-        log.error(e)
-        return False
+    # p.is_file() throws an exception in some cases
+    if p.exists() and p.is_file():
+        return os.access(
+            str(p), os.W_OK,
+            effective_ids=(os.access in os.supports_effective_ids))
     else:
-        with pdf:
-            messages = pdf.check()
-            for msg in messages:
-                if 'error' in msg.lower():
-                    log.error(msg)
-                else:
-                    log.warning(msg)
-
-            sio = StringIO()
-            linearize_msgs = ''
-            try:
-                # If linearization is missing entirely, we do not complain. We do
-                # complain if linearization is present but incorrect.
-                pdf.check_linearization(sio)
-            except RuntimeError:
-                pass
-            except (
-                # Workaround for a problematic pikepdf version
-                # pragma: no cover
-                getattr(pikepdf, 'ForeignObjectError')
-                if pikepdf.__version__ == '2.1.0'
-                else NeverRaise
-            ):
-                pass
-            else:
-                linearize_msgs = sio.getvalue()
-                if linearize_msgs:
-                    log.warning(linearize_msgs)
-
-            if not messages and not linearize_msgs:
-                return True
+        try:
+            fp = p.open('wb')
+        except OSError:
             return False
+        else:
+            fp.close()
+            with suppress(OSError):
+                p.unlink()
+        return True
 
 
-def clamp(n, smallest, largest):  # mypy doesn't understand types for this
-    """Clamps the value of ``n`` to between ``smallest`` and ``largest``."""
-    return max(smallest, min(n, largest))
+if sys.version_info[0:2] <= (3, 5):
+    def universal_open(p, *args, **kwargs):
+        "Work around Python 3.5's inability to open(pathlib.Path())"
+        try:
+            return p.open(*args, **kwargs)
+        except AttributeError:
+            return open(p, *args, **kwargs)
 
 
-def remove_all_log_handlers(logger):
-    "Remove all log handlers, usually used in a child process."
-    for handler in logger.handlers[:]:
-        logger.removeHandler(handler)
-        handler.close()  # To ensure handlers with opened resources are released
+    def fspath(path):
+        import pathlib
+        '''https://www.python.org/dev/peps/pep-0519/#os'''
+        if isinstance(path, (str, bytes)):
+            return path
 
+        # Work from the object's type to match method resolution of other magic
+        # methods.
+        path_type = type(path)
+        try:
+            path = path_type.__fspath__(path)
+        except AttributeError:
+            # Added for Python 3.5 support.
+            if isinstance(path, pathlib.Path):
+                return str(path)
+            elif hasattr(path_type, '__fspath__'):
+                raise
+        else:
+            if isinstance(path, (str, bytes)):
+                return path
+            else:
+                raise TypeError("expected __fspath__() to return str or bytes, "
+                                "not " + type(path).__name__)
 
-def pikepdf_enable_mmap():
-    # try:
-    #     if pikepdf._qpdf.set_access_default_mmap(True):
-    #         log.debug("pikepdf mmap enabled")
-    # except AttributeError:
-    #     log.debug("pikepdf mmap not available")
-    # We found a race condition probably related to pybind issue #2252 that can
-    # cause a crash. For now, disable pikepdf mmap to be on the safe side.
-    # Fix is not in pybind11 2.6.0
-    # log.debug("pikepdf mmap disabled")
-    return
+        raise TypeError(
+            "expected str, bytes, pathlib.Path or os.PathLike object, not "
+            + path_type.__name__)
 
-
-def deprecated(func):
-    """Warn that function is deprecated."""
-
-    @wraps(func)
-    def new_func(*args, **kwargs):
-        warnings.simplefilter('always', DeprecationWarning)  # turn off filter
-        warnings.warn(
-            "Call to deprecated function {}.".format(func.__name__),
-            category=DeprecationWarning,
-            stacklevel=2,
-        )
-        warnings.simplefilter('default', DeprecationWarning)  # reset filter
-        return func(*args, **kwargs)
-
-    return new_func
+else:
+    universal_open = open
+    fspath = os.fspath