Tweak release notes

Should extend test for other Asian languages

.git_archival.txt

@@ -0,0 +1 @@
+ref-names: $Format:%D$

.gitattributes

@@ -5,4 +5,6 @@
 # (binary is a macro for -text -diff)
 *.jar	binary
 *.pdf	binary
-*.PDF	binary
+*.PDF	binary
+
+.git_archival.txt  export-subst

.gitignore

@@ -10,6 +10,7 @@ pyvenv.cfg
 .eggs/
 build/
 dist/
+wheelhouse/
 
 # Automatically generated files
 ocrmypdf/lib/_*.py

.travis.yml

@@ -1,3 +1,5 @@
+sudo: required
+dist: trusty
 language: python
 
 cache: pip
@@ -5,33 +7,30 @@ cache: pip
 cache:
     directories:
         - $HOME/.ccache
-        - tarballs
+        - packages
         - tests/cache
 
 python:
     - 3.4
+    - 3.5
 
 before_cache:
     - rm -f $HOME/.cache/pip/log/debug.log
 
 before_install:
     # Ubuntu packages
-    - sudo add-apt-repository ppa:evl.ms/precise -y  # for Ghostscript 9.15
-    - sudo add-apt-repository ppa:lyrasis/precise-backports -y  # for Tesseract 3.03
-    - sudo add-apt-repository ppa:b-eltzner/qpdfview-exp -y  # for QPDF 5
-    - sudo add-apt-repository ppa:itachi-san/ffmpeg -y  # for libav 11.2 (for unpaper)
+    - sudo add-apt-repository ppa:vshn/ghostscript -y  # for ghostscript 9.16 (trusty has 9.10)
+    - sudo add-apt-repository ppa:heyarje/libav-11 -y  # for libav11, which is for unpaper
     - sudo apt-get update -qq  # must go after all add-apt-repo
-    - sudo apt-get install -y ghostscript tesseract-ocr tesseract-ocr-deu tesseract-ocr-eng tesseract-ocr-fra qpdf poppler-utils gcc libavformat-dev libavcodec-dev libavutil-dev automake make pkg-config xsltproc libffi-dev
+    - sudo apt-get install -y ghostscript tesseract-ocr tesseract-ocr-deu tesseract-ocr-eng tesseract-ocr-fra qpdf poppler-utils libavformat56 libavcodec56 libavutil54 libffi-dev
 
     # pip
     - pip install --upgrade pip
 
     # Download, make and install unpaper (using ccache)
-    - mkdir -p tarballs
-    - "[ -f tarballs/unpaper-6.1.tar.xz ] || wget -q https://www.flameeyes.eu/files/unpaper-6.1.tar.xz -O tarballs/unpaper-6.1.tar.xz"
-    - tar -xvf tarballs/unpaper-6.1.tar.xz
-    - export PATH="/usr/lib/ccache:$PATH"
-    - pushd unpaper-6.1 && ./configure --prefix=/usr && make -j && sudo make install && popd
+    - mkdir -p packages
+    - "[ -f packages/unpaper_6.1-1.deb ] || wget -q https://dl.dropboxusercontent.com/u/28971240/unpaper_6.1-1.deb -O packages/unpaper_6.1-1.deb"
+    - sudo dpkg -i packages/unpaper_6.1-1.deb
 
 install:
     - pip install -r requirements.txt

Dockerfile

@@ -23,11 +23,8 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
 
 RUN apt-get install -y --no-install-recommends \
   unpaper \
-  ghostscript \
   qpdf \
-  poppler-utils
-
-RUN apt-get install -y --no-install-recommends \
+  poppler-utils \
   tesseract-ocr \
   tesseract-ocr-deu tesseract-ocr-spa tesseract-ocr-eng tesseract-ocr-fra
 
@@ -36,6 +33,14 @@ RUN apt-get install -qy --no-install-recommends \
   libpython3-dev \
   gcc
 
+# Install Ghostscript from Debian sid to work around JPEG 2000 issue in
+# Debian stretch libgs9 or gs 9.16~dfsg-2.1
+
+COPY ./share/etc-apt-sources.list /etc/apt/sources.list
+
+RUN apt-get update && apt-get install -y ghostscript/sid
+
+
 # Enforce UTF-8
 # Borrowed from https://index.docker.io/u/crosbymichael/python/ 
 RUN dpkg-reconfigure locales && \
@@ -63,9 +68,11 @@ RUN chmod 644 /usr/share/tesseract-ocr/tessdata/pdf.ttf
 
 # Install application and dependencies
 # In this arrangement Pillow and reportlab will be provided by the system
+# Even though ocrmypdf is locally present, pull from PyPI because
+# Dockerhub and setuptools_scm clash
 RUN . /appenv/bin/activate; \
   pip install --upgrade pip \
-  && pip install /application \
+  && pip install ocrmypdf \
   && pip install --no-cache-dir -r /application/test_requirements.txt
 
 # Remove the junk
@@ -77,7 +84,6 @@ USER docker
 WORKDIR /home/docker
 
 ENV OCRMYPDF_TEST_OUTPUT=/tmp/test-output
-ENV OCRMYPDF_IN_DOCKER=1
 ENV OCRMYPDF_SHARP_TTF=1
 
 # Must use array form of ENTRYPOINT

README.rst

@@ -8,7 +8,7 @@ Main features
 -------------
 
 -  Generates a searchable
-   `PDF/A <https://en.wikipedia.org/?title=PDF/A>`__ file from a regular PDF
+   `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
@@ -18,11 +18,11 @@ Main features
 -  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 the `39 languages <https://code.google.com/p/tesseract-ocr/downloads/list>`__ recognized by Tesseract
+-  Uses `Tesseract OCR <https://github.com/tesseract-ocr/tesseract>`_ engine
+-  Supports the `39 languages <https://code.google.com/p/tesseract-ocr/downloads/list>`_ recognized by Tesseract
 -  Battle-tested on thousands of PDFs, a test suite and continuous integration
 
-For details: please consult the `release notes <RELEASE_NOTES.rst>`__.
+For details: please consult the `release notes <RELEASE_NOTES.rst>`_.
 
 Motivation
 ----------
@@ -31,9 +31,9 @@ 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 display correctly some escaped HTML characters located in the hOCR file produced by the OCR engine 
+-  Or they did not handle accents and multilingual characters
 -  Or they changed the resolution of the embedded images
--  Or they generated PDF files having a ridiculous big size
+-  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)
@@ -46,22 +46,45 @@ Installation
 
 Download OCRmyPDF here: https://github.com/jbarlow83/OCRmyPDF/releases
 
-You can install it to a Python virtual environment or system-wide. 
+These steps describe how to install OCRmyPDF on your system.
+
+- `Installing on Debian and Ubuntu`_ (Debian stretch and Ubuntu 16.10 or later)
+- `Installing the Docker image`_
+- `Installing on Mac OS X`_
+- `Installing on Ubuntu 14.04 LTS`_
+- Installing and running on `Windows`_ using the Docker image
+
+If you prefer to install from source or install OCRmyPDF to a Python virtual environment, see steps for `Installing HEAD revision from sources`_.
+
+.. _Windows: `Installing on Windows`_
+
+
+Installing on Debian and Ubuntu
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Users of Debian 9 or later or Ubuntu 16.10 or later may simply
+``apt-get install ocrmypdf``.
+
+.. _Docker:
 
 Installing the Docker image
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 For many users, installing the Docker image will be easier than installing all of OCRmyPDF's dependencies. For Windows, it is the only option.
 
-If you have `Docker <https://docs.docker.com/>`__ installed on your system, you can install
+If you have `Docker <https://docs.docker.com/>`_ installed on your system, you can install
 a Docker image of the latest release.
 
 Follow the Docker installation instructions for your platform.  If you can run this command
-successfully, your system is ready to download and execute the image::
+successfully, your system is ready to download and execute the image:
+
+.. code-block:: bash
 
    docker run hello-world
    
-OCRmyPDF will use all available CPU cores.  By default, the VirtualBox machine instance on Windows and OS X 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::
+OCRmyPDF will use all available CPU cores.  By default, the VirtualBox machine instance on Windows and OS X 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"
@@ -70,29 +93,41 @@ OCRmyPDF will use all available CPU cores.  By default, the VirtualBox machine i
    eval $(docker-machine env "yourVM")
 
 Assuming you have a Docker engine running somewhere, you can run these commands to download
-the image::
+the image:
+
+.. code-block:: bash
 
    docker pull jbarlow83/ocrmypdf
 
-Then tag it to give a more convenient name, just ocrmypdf::
+Then tag it to give a more convenient name, just ocrmypdf:
+
+.. code-block:: bash
 
    docker tag jbarlow83/ocrmypdf ocrmypdf
 
-This image contains language packs for English, French, Spanish and German. The alternative "polyglot" image provides `all available language packs <https://github.com/tesseract-ocr/tesseract/blob/master/doc/tesseract.1.asc#languages>`__::
+This image contains language packs for English, French, Spanish and German. The alternative "polyglot" image provides `all available language packs <https://github.com/tesseract-ocr/tesseract/blob/master/doc/tesseract.1.asc#languages>`_:
+
+.. code-block:: bash
 
    # Alternative step: If you need all language packs
    docker pull jbarlow83/ocrmypdf-polyglot
    docker tag jbarlow83/ocrmypdf-polyglot ocrmypdf
 
-You can then run ocrmypdf using the command::
+You can then run ocrmypdf using the command:
+
+.. code-block:: bash
 
    docker run ocrmypdf --help
   
-To execute the OCRmyPDF on a local file, you must `provide a writable volume to the Docker image <https://docs.docker.com/userguide/dockervolumes/>`__, such as this in this template::
+To execute the OCRmyPDF on a local file, you must `provide a writable volume to the Docker image <https://docs.docker.com/userguide/dockervolumes/>`_, such as this in this template:
+
+.. code-block:: bash
 
    docker run -v "$(pwd):/home/docker" <other docker arguments>   ocrmypdf <your arguments to ocrmypdf>
 
-In this worked example, the current working directory contains an input file called ``test.pdf`` and the output will go to ``output.pdf``:: 
+In this worked example, the current working directory contains an input file called ``test.pdf`` and the output will go to ``output.pdf``: 
+
+.. code-block:: bash
 
    docker run -v "$(pwd):/home/docker"   ocrmypdf --skip-text test.pdf output.pdf
 
@@ -104,84 +139,135 @@ Installing on Mac OS X
 
 These instructions probably work on all Mac OS X versions later than 10.7 (Lion). OCRmyPDF is known to work on Yosemite and El Capitan, and regularly tested on El Capitan.
 
-If it's not already present, `install Homebrew <http://brew.sh/>`__.
+If it's not already present, `install Homebrew <http://brew.sh/>`_.
 
-Update Homebrew::
+Update Homebrew:
+
+.. code-block:: bash
 
    brew update
    
-Install or upgrade the required Homebrew packages, if any are missing::
+Install or upgrade the required Homebrew packages, if any are missing:
 
-   brew install libpng openjpeg jbig2dec     # image libraries
+.. code-block:: bash
+
+   brew install libpng openjpeg jbig2dec libtiff     # image libraries
    brew install qpdf
    brew install ghostscript
    brew install python3
-   brew install libxml2
-   brew install leptonica
-   brew install tesseract
+   brew install libxml2 libffi leptonica
+   brew install unpaper   # optional
    
-Update the homebrew pip and install Pillow::
+Install the required Tesseract OCR engine with the language packs you plan to use:
+   
+.. code-block:: bash
+
+   brew install tesseract                       # Option 1: for English, French, German, Spanish
+   
+.. code-block:: bash
+   
+   brew install tesseract --with-all-languages  # Option 2: for all language packs 
+   
+Update the homebrew pip and install Pillow:
+
+.. code-block:: bash
 
    pip3 install --upgrade pip
    pip3 install --upgrade pillow
 
-You can then install OCRmyPDF from PyPI::
+You can then install OCRmyPDF from PyPI:
+
+.. code-block:: bash
 
    pip3 install ocrmypdf
 
-The command line program should now be available::
+The command line program should now be available:
+
+.. code-block:: bash
 
    ocrmypdf --help
 
 Installing on Ubuntu 14.04 LTS
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Installing on Ubuntu 14.04 LTS (trusty) is more difficult than other options, because of certain bugs in Python package installation.
+Installing on Ubuntu 14.04 LTS (trusty) is more difficult than some other options, because of bugs in Python package installation.
 
-Update apt-get::
+Add new "apt" repositories needed for backports of Ghostscript 9.16 and libav-11, which supports unpaper 6.1. This will replace Ghostscript on your system.
+
+.. code-block:: bash
+
+   sudo add-apt-repository ppa:vshn/ghostscript -y 
+   sudo add-apt-repository ppa:heyarje/libav-11 -y
+
+Update apt-get:
+
+.. code-block:: bash
 
    sudo apt-get update
    sudo apt-get upgrade
    
-Install system dependencies::
+Install system dependencies:
+
+.. code-block:: bash
 
    sudo apt-get install \
       zlib1g-dev \
       libjpeg-dev \
+      libffi-dev \
+      libavformat56 libavcodec56 libavutil54 \
       ghostscript \
       tesseract-ocr \
       qpdf \
-      unpaper \
       python3-pip \
       python3-pil \
       python3-pytest \
       python3-reportlab
 
 If you wish install OCRmyPDF to the system Python, then install as follows (note this installs new packages
-into your system Python, which could interfere with other programs)::
+into your system Python, which could interfere with other programs):
+
+.. code-block:: bash
 
    sudo pip3 install ocrmypdf
    
-If you wish to install OCRmyPDF to a virtual environment to isolate system Python from modified, you can
+If you wish to install OCRmyPDF to a virtual environment to isolate the system Python, you can
 follow these steps.  This includes a workaround `for a known, unresolved issue in Ubuntu 14.04's ensurepip
-package <http://www.thefourtheye.in/2014/12/Python-venv-problem-with-ensurepip-in-Ubuntu.html>`__::
+package <http://www.thefourtheye.in/2014/12/Python-venv-problem-with-ensurepip-in-Ubuntu.html>`_:
+
+.. code-block:: bash
 
    sudo apt-get install python3-venv
    python3 -m venv venv-ocrmypdf --without-pip
    source venv-ocrmypdf/bin/activate
    wget -O - -o /dev/null https://bootstrap.pypa.io/get-pip.py | python
    deactivate
-   pyvenv --system-site-packages venv-ocrmypdf
+   python3 -m venv --system-site-packages venv-ocrmypdf
    source venv-ocrmypdf/bin/activate
    pip install ocrmypdf
 
-Ubuntu 14.04 only installs ``unpaper`` version 0.4.2, which is not supported by OCRmyPDF because it is produces invalid output. This program is an optional dependency, and provides page deskewing and cleaning. See `Dockerfile <Dockerfile>`__ for an example of how to building unpaper 6.1 from source. If you choose to install unpaper later, OCRmyPDF will use the foremost version on the system PATH.
+These installation instructions omit the optional dependency ``unpaper``, which is only available at version 0.4.2 in Ubuntu 14.04. The author could not find a backport of ``unpaper`` and is not motivated to figure how to set up a Ubuntu PPA to distribute it. You can create a .deb package to do the job of installing unpaper 6.1 (for x86 64-bit only):
+
+.. code-block:: bash
+
+   wget -q https://dl.dropboxusercontent.com/u/28971240/unpaper_6.1-1.deb -O unpaper_6.1-1.deb
+   sudo dpkg -i unpaper_6.1-1.deb
+
 
 Installing on Windows
 ~~~~~~~~~~~~~~~~~~~~~
 
-Direct installation on Windows is not possible.  Install the Docker container as described above.
+Direct installation on Windows is not possible.  Install the _`Docker` container as described above.  Ensure that your command prompt can run the docker "hello world" container.
 
+Running on Windows
+~~~~~~~~~~~~~~~~~~
+
+The command line syntax to run ocrmypdf from a command prompt will resemble:
+
+.. code-block:: bat
+
+   docker run -v /c/Users/sampleuser:/home/docker ocrmypdf --skip-text test.pdf output.pdf
+
+where /c/Users/sampleuser is a Unix representation of the Windows path C:\\Users\\sampleuser, assuming a user named "sampleuser" is running ocrmypdf on a file in their home directory, and the files "test.pdf" and "output.pdf" are in the sampleuser folder. The Windows user must have read and write permissions.
       
 Installing HEAD revision from sources
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -189,24 +275,32 @@ Installing HEAD revision from sources
 If you have ``git`` and ``python3.4`` or ``python3.5`` installed, you can install from source. When the ``pip`` installer runs,
 it will alert you if dependencies are missing.
 
-To install the HEAD revision from sources in the current Python 3 environment::
+To install the HEAD revision from sources in the current Python 3 environment:
+
+.. code-block:: bash
 
    pip3 install git+https://github.com/jbarlow83/OCRmyPDF.git
 
-Or, to install in `development mode <https://pythonhosted.org/setuptools/setuptools.html#development-mode>`__,  allowing customization of OCRmyPDF, use the ``-e`` flag::
+Or, to install in `development mode <https://pythonhosted.org/setuptools/setuptools.html#development-mode>`_,  allowing customization of OCRmyPDF, use the ``-e`` flag:
+
+.. code-block:: bash
 
    pip3 install -e git+https://github.com/jbarlow83/OCRmyPDF.git
    
 On certain Linux distributions such as Ubuntu, you may need to use 
-run the install command as superuser::
+run the install command as superuser:
+
+.. code-block:: bash
 
    sudo pip3 install [-e] git+https://github.com/jbarlow83/OCRmyPDF.git
    
 Note that this will alter your system's Python distribution. If you prefer 
-to not install as superuser, you can install the package in a Python virtual environment::
+to not install as superuser, you can install the package in a Python virtual environment:
+
+.. code-block:: bash
 
    git clone -b master https://github.com/jbarlow83/OCRmyPDF.git
-   pyvenv venv
+   python3 -m venv
    source venv/bin/activate
    cd OCRmyPDF
    pip3 install .
@@ -214,7 +308,9 @@ to not install as superuser, you can install the package in a Python virtual env
 However, ``ocrmypdf`` will only be accessible on the system PATH after
 you activate the virtual environment.
 
-To run the program::
+To run the program:
+
+.. code-block:: bash
    
    ocrmypdf --help
 
@@ -227,10 +323,15 @@ Languages
 ---------
 
 OCRmyPDF uses Tesseract for OCR, and relies on its language packs. For Linux users,
-you can often find packages that provide language packs::
+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
-   sudo apt-get install tesseract-ocr-chi-sim
+   sudo 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.
@@ -238,9 +339,17 @@ languages can be requested.
 Support
 -------
 
-In case you detect an issue, please:
+Once ocrmypdf is installed, the built-in help which explains the command syntax and options can be accessed via:
 
--  Check if your issue is already known
+.. code-block:: bash
+
+   ocrmypdf --help
+
+The `Wiki <https://github.com/jbarlow83/OCRmyPDF/wiki>`_ page also contains some tips and suggests.
+
+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
@@ -252,11 +361,11 @@ In case you detect an issue, please:
 Press & Media
 -------------
 
--  `c't 1-2014, page 59 <http://www.heise.de/ct/inhalt/2014/1/58/>`__:
+-  `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://www.heise.de/-2356670>`__
+   OCRmyPDF <http://heise.de/-2356670>`_
 
 Disclaimer
 ----------

RELEASE_NOTES.rst

@@ -1,9 +1,134 @@
 RELEASE NOTES
 =============
 
-Please always read this file before installing the package
 
-Download software here: https://github.com/jbarlow83/OCRmyPDF/tags
+v4.2:
+=====
+
+-  ocrmypdf will now try to convert single image files to PDFs if they are provided as input (#15)
+
+   +  This is a basic convenience feature. It only supports a single image and always makes the image fill the whole page.
+   +  For better control over image to PDF conversion, use ``img2pdf`` (one of ocrmypdf's dependencies)
+
+-  New argument ``--output-type {pdf|pdfa}`` allows disabling Ghostscript PDF/A generation
+
+   +  ``pdfa`` is the default, consistent with past behavior
+   +  ``pdf`` provides a workaround for users concerned about the increase in file size from Ghostscript forcing JBIG2 images to CCITT and transcoding JPEGs
+   +  ``pdf`` preserves as much as it can about the original file, including problems that PDF/A conversion fixes
+
+-  PDFs containing images with "non-square" pixel aspect ratios, such as 200x100 DPI, are now handled and converted properly (fixing a bug that caused to be cropped)
+-  ``--force-ocr`` rasterizes pages even if they contain no images
+
+   +  supports users who want to use OCRmyPDF to reconstruct text information in PDFs with damaged Unicode maps (copy and paste text does not match displayed text)
+   +  supports reinterpreting PDFs where text was rendered as curves for printing, and text needs to be recovered
+   +  fixes issue #82
+
+-  Fixes an issue where, with certain settings, monochrome images in PDFs would be converted to 8-bit grayscale, increasing file size (#79)
+-  Support for Ubuntu 12.04 LTS "precise" has been dropped in favor of (roughly) Ubuntu 14.04 LTS "trusty" 
+
+   +  Some Ubuntu "PPAs" (backports) are needed to make it work
+      
+-  Support for some older dependencies dropped
+
+   +  Ghostscript 9.15 or later is now required (available in Ubuntu trusty with backports)
+   +  Tesseract 3.03 or later is now required (available in Ubuntu trusty)
+
+-  Ghostscript now runs in "safer" mode where possible
+
+v4.1.4:
+=======
+
+-  Bug fix: monochrome images with an ICC profile attached were incorrectly converted to full color images if lossless reconstruction was not possible due to other settings; consequence was increased file size for these images
+
+
+v4.1.3:
+=======
+
+-  More helpful error message for PDFs with version 4 security handler
+-  Update usage instructions for Windows/Docker users
+-  Fix order of operations for matrix multiplication (no effect on most users)
+-  Add a few leptonica wrapper functions (no effect on most users)
+
+
+v4.1.2:
+=======
+
+-  Replace IEC sRGB ICC profile with Debian's sRGB (from icc-profiles-free) which is more compatible with the MIT license
+-  More helpful error message for an error related to certain types of malformed PDFs
+
+
+v4.1:
+=====
+
+-  ``--rotate-pages`` now only rotates pages when reasonably confidence in the orientation. This behavior can be adjusted with the new argument ``--rotate-pages-threshold``
+-  Fixed problems in error checking if ``unpaper`` is uninstalled or missing at run-time
+-  Fixed problems with "RethrownJobError" errors during error handling that suppressed the useful error messages
+
+
+v4.0.7:
+=======
+
+-  Minor correction to Ghostscript output settings
+
+
+v4.0.6:
+=======
+
+-  Update install instructions
+-  Provide a sRGB profile instead of using Ghostscript's
+
+
+v4.0.5:
+=======
+
+-  Remove some verbose debug messages from v4.0.4
+-  Fixed temporary that wasn't being deleted
+-  DPI is now calculated correctly for cropped images, along with other image transformations
+-  Inline images are now checked during DPI calculation instead of rejecting the image
+
+v4.0.4:
+=======
+
+Released with verbose debug message turned on. Do not use. Skip to v4.0.5.
+
+
+v4.0.3:
+=======
+
+New features
+------------
+
+-  Page orientations detected are now reported in a summary comment
+
+
+Fixes
+-----
+
+-  Show stack trace if unexpected errors occur
+-  Treat "too few characters" error message from Tesseract as a reason to skip that page rather than
+   abort the file
+-  Docker: fix blank JPEG2000 issue by insisting on Ghostscript versions that have this fixed
+
+
+v4.0.2:
+=======
+
+Fixes
+-----
+
+-  Fixed compatibility with Tesseract 3.04.01 release, particularly its different way of outputting
+   orientation information
+-  Improved handling of Tesseract errors and crashes
+-  Fixed use of chmod on Docker that broke most test cases
+
+
+v4.0.1:
+=======
+
+Fixes
+-----
+
+-  Fixed a KeyError if tesseract fails to find page orientation information
 
 
 v4.0:
@@ -15,15 +140,15 @@ New features
 -  Automatic page rotation (``-r``) is now available. It uses ignores any prior rotation information
    on PDFs and sets rotation based on the dominant orientation of detectable text. This feature is
    fairly reliable but some false positives occur especially if there is not much text to work with. (#4) 
--  Deskewing is now performed using Leptonica instead of unpaper. Leptonica deskews images faster and
-   more reliably than unpaper.
+-  Deskewing is now performed using Leptonica instead of unpaper. Leptonica is faster and more reliable
+   at image deskewing than unpaper.
 
 
 Fixes
 -----
 
 -  Fixed an issue where lossless reconstruction could cause some pages to be appear incorrectly
-   rotated in the page had a /Rotate tag applied (#50)
+   if the page was rotated by the user in Acrobat after being scanned (specifically if it a /Rotate tag)
 -  Fixed an issue where lossless reconstruction could misalign the graphics layer with respect to
    text layer if the page had been cropped such that its origin is not (0, 0) (#49)
 
@@ -31,7 +156,7 @@ Fixes
 Changes
 -------
 
--  Logging output much is now better
+-  Logging output is now much easier to read
 -  ``--deskew`` is now performed by Leptonica instead of unpaper (#25)
 -  libffi is now required
 -  Some changes were made to the Docker and Travis build environments to support libffi
@@ -252,363 +377,6 @@ Notes and known issues
 v2.2-stable (2014-09-29):
 =========================
 
-New features
-------------
+OCRmyPDF versions 1 and 2 were implemented as shell scripts. OCRmyPDF 3.0+ is a fork that gradually replaced all shell scripts with Python while maintaining the existing command line arguments. No one is maintaining old versions.
 
-- None
-
-Changes
--------
-
-- Update to jhove v1.11
-- Request the python library reportlab v3.0 or newer (So that we could remove a patch to the previous version of reportlab leading to issues for some users)
-
-Fixes
------
-
-- Fix bug on Mac OS X (resolution of simlink to OCRmyPDF.sh script) (thanks to jbarlow83)
-- Check if the input pdf file exists before to continue
-
-Tested with
------------
-
-- Operating system: FreeBSD 9.2
-- Dependencies:
-
-   - parallel 20140822
-   - poppler-utils 0.24.5
-   - ImageMagick 6.8.9-4 2014-09-17
-   - Unpaper 0.3
-   - tesseract 3.02.02
-   - Python 2.7.8
-   - ghostcript (gs): 9.06
-   - java: openjdk version "1.7.0_65"
-
-
-v2.1-stable (2014-09-20):
-=========================
-
-New features
-------------
-
--  None
-
-Changes
--------
-
--  None
-
-Fixes
------
-
--  Allow execution via simlink
--  Add support for tesseract 3.03
--  Add support for newer version of reportlab
--  Lowered minimum version of gnu parallel
--  Various typo
-
-Tested with
------------
-
--  Operating system: FreeBSD 9.1
--  Dependencies:
--  parallel 20130222
--  poppler-utils 0.22.2
--  ImageMagick 6.8.0-7 2013-03-30
--  Unpaper 0.3
--  tesseract 3.02.02
--  Python 2.7.3
--  ghoscript (gs): 9.06
--  java: openjdk version "1.7.0\_17"
-
-v2.0-stable (2014-01-25):
-=========================
-
-New features
-------------
-
--  Check if the language(s) passed using the -l option is supported by
-   tesseract (fixes #60)
-
-Changes
--------
-
--  Allow OCRmyPDF to be used with tesseract 3.02.01, even though OCR
-   might fail for few PDF file (see issue #28). Rationale: For some
-   linux distribution, no newer version than tesseract 3.02.01 is
-   available
-
-Fixes
------
-
--  More robust algorithm for checking the version of the installed
-   tesseract package
-
-Tested with
------------
-
--  Operating system: FreeBSD 9.1
--  Dependencies:
--  parallel 20130222
--  poppler-utils 0.22.2
--  ImageMagick 6.8.0-7 2013-03-30
--  Unpaper 0.3
--  tesseract 3.02.02
--  Python 2.7.3
--  ghoscript (gs): 9.06
--  java: openjdk version "1.7.0\_17"
-
-v2.0-rc2 (2014-01-16):
-======================
-
-New features
-------------
-
--  None
-
-Changes
--------
-
--  Size reduction of final PDF file: (fixes #50)
--  Support for monochrome (Black&White) images (massive size reduction
-   in final PDF: >80%)
--  Reduced size of grayscale images (by 13% on test PDF file)
--  Preventing fi, fl ligatures does not require anymore to pass an
-   additional config file to tesseract using the -C option (fixes #58)
--  Location of temporary folder according to content of environment
-   variable TMPDIR.
--  Dependency to pdftk removed
--  Check for compatible versions of dependencies: (fixes #51)
--  parallel and tesseract
--  python libraries reportlab and lxml
-
-Fixes
------
-
--  Improved portability with various shells (dash, bash, tcsh) and OS
-   (FreeBSD, MAC OSX, Linux) (fixes #59)
--  Corrected bug in case the input PDF file contains a space character
-   (fixes #48)
--  Prevent spurious error message in case there is no image in a PDF
-   page
--  Prevent collision of temporary folder names (fixes #57)
-
-Tested with
------------
-
--  Operating system: FreeBSD 9.1
--  Dependencies:
--  parallel 20130222
--  poppler-utils 0.22.2
--  ImageMagick 6.8.0-7 2013-03-30
--  Unpaper 0.3
--  tesseract 3.02.02
--  Python 2.7.3
--  ghoscript (gs): 9.06
--  java: openjdk version "1.7.0\_17"
-
-v2.0-rc1 (2014-01-07):
-======================
-
-New features
-------------
-
--  Huge performance improvement on machines having multiple CPU/cores
-   (processing of several pages concurrently) (fixes #18)
--  By default prevent from processing a PDF file already containing
-   fonts (i.e. text)(it can be overridden with the -f flag) (fixes #16)
--  Warn if the resolution is too low to get reasonable OCR results
-   (fixes #37)
--  New option (-o) to perform automatic oversampling if the image
-   resolution is too low. This can improve OCR results.
--  Warn if using a tesseract version older than v3.02.02 (as older
-   versions are known to produce invalid output) (fixes #41)
--  Echo version of the installed dependencies (e.g. tesseract) in debug
-   mode in order to ease support (fixes #35)
--  Echo the arguments passed to the script in debug mode to ease support
-
-Changes
--------
-
--  In debug mode: The debug page is now placed after the respective
-   "normal" page
--  Reduced disk space usage in temporary folder if -d (deskew) or -c
-   (cleanup) options are not selected
--  New file src/config.sh containing various configuration parameters
--  Documentation of the tesseract config file "tess-cfg/no\_ligature"
-   improved
--  Improved consistency of the temporary file names
-
-Fixes
------
-
--  Improved robustness:
--  in case vertical resolution differs from horizontal resolution (fixes
-   #38)
--  in case a PDF page contains more than one image (fixes #36)
--  Fix a problem occurring if python 3 is the standard interpreter
-   (fixes #33)
--  Fix a problem occurring if the input PDF file contains special
-   characters like "#" (fixes #34)
-
-Tested with
------------
-
--  Operating system: FreeBSD 9.1
--  Dependencies:
--  parallel 20130222
--  poppler-utils 0.22.2
--  ImageMagick 6.8.0-7 2013-03-30
--  Unpaper 0.3
--  tesseract 3.02.02
--  Python 2.7.3
--  pdftk 1.45
--  ghoscript (gs): 9.06
--  java: openjdk version "1.7.0\_17"
-
-v1.1-stable (2014-01-06):
-=========================
-
-New features
-------------
-
--  N/A
-
-Changes
--------
-
--  N/A
-
-Fixes
------
-
--  Fixed syntax error (bashism) leading to an error message on certain
-   systems (fixes #42)
-
-Tested with
------------
-
--  Operating system: FreeBSD 9.1
--  Dependencies:
--  poppler-utils 0.22.2
--  ImageMagick 6.8.0-7 2013-03-30
--  Unpaper 0.3
--  tesseract 3.02.02
--  Python 2.7.3
--  pdftk 1.45
--  ghoscript (gs): 9.06
--  java: openjdk version "1.7.0\_17"
-
-v1.0-stable (2013-05-06):
-=========================
-
-New features
-------------
-
--  In debug mode: compute and echo time required for processing (fixes
-   #26)
-
-Changes
--------
-
--  Removed feature to add metadata in final pdf file (because it lead to
-   to final PDF file that does not comply to the PDF/A-1 format)
--  Removed feature to set same owner & permissions in final PDF file
-   than in input file
--  Removed many unused jhove files (e.g. documentation, \*.java and
-   \*.class files)
-
-Fixes
------
-
--  Correction to handle correctly path and input PDF files having spaces
-   (fixes #31)
--  Resolutions (x/y) that are nearly equal are now supported (fixes #25)
--  Fix compatibility issue with Ubuntu server 12.04 / Ubuntu server
-   10.04 / Linux Mint 13 Maya and probably other Linux distributions
-   (fixes #27)
--  Commit missing jhove files (\*.jar mainly) due to wrong .gitignore
-
-Tested with
------------
-
--  Operating system: FreeBSD 9.1
--  Dependencies:
--  poppler-utils 0.22.2
--  ImageMagick 6.8.0-7 2013-03-30
--  Unpaper 0.3
--  tesseract 3.02.02
--  Python 2.7.3
--  pdftk 1.45
--  ghoscript (gs): 9.06
--  java: openjdk version "1.7.0\_17"
-
-v1.0-rc2 (2013-04-29):
-======================
-
-New features
-------------
-
--  Keep temporary files if debug mode is set (fixes #22)
--  Set same owner & permissions in final PDF file than in input file
-   (fixes #9)
--  Added metadata in final pdf file (fixes #4)
-
-Changes
--------
-
--  N/A
-
-Fixes
------
-
--  Fixed wrong image cropping when deskew option is activated
--  Exit with error message if page size is not found in hocr file (fixes
-   #21)
--  Various minor fixes in log messages
-
-Tested with
------------
-
--  Operating system: FreeBSD 9.1
--  Dependencies:
--  poppler-utils 0.22.2
--  ImageMagick 6.8.0-7 2013-03-30
--  Unpaper 0.3
--  tesseract 3.02.02
--  Python 2.7.3
--  pdftk 1.45
--  ghoscript (gs): 9.06
--  java: openjdk version "1.7.0\_17"
-
-v1.0-rc1 (2013-04-26):
-======================
-
-New features
-------------
-
--  First release candidate
-
-Changes
--------
-
--  N/A
-
-Fixes
------
-
--  N/A
-
-Tested with
------------
-
--  Operating system: FreeBSD 9.1
--  Dependencies:
--  poppler-utils 0.22.2
--  ImageMagick 6.8.0-7 2013-03-30
--  Unpaper 0.3
--  tesseract 3.02.02
--  Python 2.7.3
--  pdftk 1.45
--  ghoscript (gs): 9.06
--  java: openjdk version "1.7.0\_17"
+For details on older versions, see the `final version of its release notes <https://github.com/fritz-hh/OCRmyPDF/blob/7fd3dbdf42ca53a619412ce8add7532c5e81a9d1/RELEASE_NOTES.md>`_.

ocrmypdf/__init__.py

@@ -1,5 +1,6 @@
 from enum import IntEnum
 import os
+from collections.abc import Iterable
 
 
 class ExitCode(IntEnum):
@@ -7,10 +8,13 @@ class ExitCode(IntEnum):
     bad_args = 1
     input_file = 2
     missing_dependency = 3
-    invalid_output_pdfa = 4
+    invalid_output_pdf = 4
     file_access_error = 5
     already_done_ocr = 6
+    child_process_error = 7
+    encrypted_pdf = 8
     other_error = 15
+    ctrl_c = 130
 
 
 def get_program(name):
@@ -20,3 +24,7 @@ def get_program(name):
 
 def page_number(input_file):
     return int(os.path.basename(input_file)[0:6])
+
+
+def is_iterable_notstr(thing):
+    return isinstance(thing, Iterable) and not isinstance(thing, str)

ocrmypdf/ghostscript.py

@@ -5,6 +5,7 @@ from tempfile import NamedTemporaryFile
 from subprocess import Popen, PIPE, check_call
 from shutil import copy
 from . import get_program
+from .pdfa import SRGB_ICC_PROFILE
 
 
 def rasterize_pdf(input_file, output_file, xres, yres, raster_device, log,
@@ -13,6 +14,7 @@ def rasterize_pdf(input_file, output_file, xres, yres, raster_device, log,
         args_gs = [
             get_program('gs'),
             '-dQUIET',
+            '-dSAFER',
             '-dBATCH',
             '-dNOPAUSE',
             '-sDEVICE=%s' % raster_device,
@@ -52,7 +54,6 @@ def generate_pdfa(pdf_pages, output_file, threads=1):
             "-dJPEGQ=95",
             "-dPDFA=2",
             "-sPDFACompatibilityPolicy=2",
-            "-sOutputICCProfile=srgb.icc",
             "-sOutputFile=" + gs_pdf.name,
         ]
         args_gs.extend(pdf_pages)

ocrmypdf/leptonica.py

@@ -17,6 +17,7 @@ from tempfile import TemporaryFile
 from ctypes.util import find_library
 from .lib._leptonica import ffi
 from functools import lru_cache
+from enum import Enum
 
 lept = ffi.dlopen(find_library('lept'))
 
@@ -83,18 +84,96 @@ class LeptonicaIOError(LeptonicaError):
     pass
 
 
+class RemoveColormap(Enum):
+    to_binary = 0
+    to_grayscale = 1
+    to_full_color = 2
+    based_on_src = 3
+
+
 class Pix:
-    def __init__(self, cpix):
-        self.cpix = ffi.gc(cpix, Pix._pix_destroy)
+    """Wrapper around leptonica's PIX object.
+
+    Leptonica uses referencing counting on PIX objects. Also, many Leptonica
+    functions return the original object with an increased reference count
+    if the operation had no effect (for example, image skew was found to be 0).
+    This has complications for memory management in Python. Whenever Leptonica
+    returns a PIX object (new or old), we wrap it in this class, which
+    registers it with the FFI garbage collector. pixDestroy() decrements the
+    reference count and only destroys when the last reference is removed.
+
+    Leptonica's reference counting is not threadsafe. This class can be used
+    in a threadsafe manner if a Python threading.Lock protects the data.
+    """
+
+    def __init__(self, pix):
+        self._pix = ffi.gc(pix, Pix._pix_destroy)
 
     def __repr__(self):
-        if self.cpix:
+        if self._pix:
             s = "<leptonica.Pix image size={0}x{1} depth={2} at 0x{3:x}>"
-            return s.format(self.cpix.w, self.cpix.h, self.cpix.d,
-                            int(ffi.cast("intptr_t", self.cpix)))
+            return s.format(self._pix.w, self._pix.h, self._pix.d,
+                            int(ffi.cast("intptr_t", self._pix)))
         else:
             return "<leptonica.Pix image NULL>"
 
+    def __getstate__(self):
+        data = ffi.new('l_uint32 **')
+        size = ffi.new('size_t *')
+
+        err = lept.pixSerializeToMemory(self._pix, data, size)
+        if err != 0:
+            raise LeptonicaIOError("pixSerializeToMemory")
+
+        char_data = ffi.cast('char *', data[0])
+
+        # Copy from C bytes to python bytes()
+        data_bytes = ffi.buffer(char_data, size[0])[:]
+
+        # Can now free C bytes
+        lept.lept_free(char_data)
+        return dict(data=data_bytes)
+
+    def __setstate__(self, state):
+        cdata_bytes = ffi.new('char[]', state['data'])
+        cdata_uint32 = ffi.cast('l_uint32 *', cdata_bytes)
+
+        pix = lept.pixDeserializeFromMemory(
+            cdata_uint32, len(state['data']))
+        Pix.__init__(self, pix)
+
+    @property
+    def width(self):
+        return self._pix.w
+
+    @property
+    def height(self):
+        return self._pix.h
+
+    @property
+    def depth(self):
+        return self._pix.d
+
+    @property
+    def size(self):
+        return (self._pix.w, self._pix.h)
+
+    @property
+    def info(self):
+        return {'dpi': (self._pix.xres, self._pix.yres)}
+
+    @property
+    def mode(self):
+        "Return mode like PIL.Image"
+        if self.depth == 1:
+            return '1'
+        elif self.depth >= 16:
+            return 'RGB'
+        elif not self._pix.colormap:
+            return 'L'
+        else:
+            return 'P'
+
     @classmethod
     def read(cls, filename):
         """Load an image file into a PIX object.
@@ -113,22 +192,32 @@ class Pix:
         jpeg_quality -- quality (iff JPEG; 1 - 100, 0 for default)
         jpeg_progressive -- (iff JPEG; 0 for baseline seq., 1 for progressive)
         """
-        fileroot, extension = os.path.splitext(filename)
-        fix_pnm = False
-        if extension.lower() in ('.pbm', '.pgm', '.ppm'):
-            # Leptonica does not process handle these extensions correctly, but
-            # does handle .pnm correctly.  Add another .pnm suffix.
-            filename += '.pnm'
-            fix_pnm = True
-
         with LeptonicaErrorTrap():
             lept.pixWriteImpliedFormat(
                 filename.encode(sys.getfilesystemencoding()),
-                self.cpix, jpeg_quality, jpeg_progressive)
+                self._pix, jpeg_quality, jpeg_progressive)
 
-        if fix_pnm:
-            from shutil import move
-            move(filename, filename[:-4])   # Remove .pnm suffix
+    def topil(self):
+        "Returns a PIL.Image version of this Pix"
+        from PIL import Image
+
+        with LeptonicaErrorTrap():
+            pix_swapped = Pix(lept.pixEndianByteSwapNew(self._pix))
+
+        size = (pix_swapped._pix.wpl * 4, pix_swapped._pix.h)
+        buf = ffi.buffer(pix_swapped._pix.data, size[0] * size[1])
+
+        im_raw = Image.frombytes(self.mode, size, buf, 'raw')
+
+        # Leptonica stores images in 32-bit words
+        # Need to crop the any trailing amount
+        box = (0, 0, self.width, self.height)
+        im = im_raw.crop(box)
+
+        return im
+
+    def show(self):
+        return self.topil().show()
 
     def deskew(self, reduction_factor=0):
         """Returns the deskewed pix object.
@@ -140,16 +229,21 @@ class Pix:
             for skew angle
         """
         with LeptonicaErrorTrap():
-            return Pix(lept.pixDeskew(self.cpix, reduction_factor))
+            return Pix(lept.pixDeskew(self._pix, reduction_factor))
 
     def scale(self, scalex, scaley):
         "Returns the pix object rescaled according to the proportions given."
         with LeptonicaErrorTrap():
-            return Pix(lept.pixScale(self.cpix, scalex, scaley))
+            return Pix(lept.pixScale(self._pix, scalex, scaley))
 
     def rotate180(self):
         with LeptonicaErrorTrap():
-            return Pix(lept.pixRotate180(ffi.NULL, self.cpix))
+            return Pix(lept.pixRotate180(ffi.NULL, self._pix))
+
+    def rotate_orth(self, quads):
+        "Orthographic rotation, quads: 0-3, number of clockwise rotations"
+        with LeptonicaErrorTrap():
+            return Pix(lept.pixRotateOrth(self._pix, quads))
 
     def find_skew(self):
         """Returns a tuple (deskew angle in degrees, confidence value).
@@ -159,27 +253,126 @@ class Pix:
         with LeptonicaErrorTrap():
             angle = ffi.new('float *', 0.0)
             confidence = ffi.new('float *', 0.0)
-            result = lept.pixFindSkew(self.cpix, angle, confidence)
+            result = lept.pixFindSkew(self._pix, angle, confidence)
             if result == 0:
                 return (angle[0], confidence[0])
             else:
                 return (None, None)
 
+    def convert_rgb_to_luminance(self):
+        with LeptonicaErrorTrap():
+            gray_pix = lept.pixConvertRGBToLuminance(self._pix)
+            if gray_pix:
+                return Pix(gray_pix)
+            return None
+
+    def remove_colormap(self, removal_type):
+        """Remove a palette
+
+            removal_type - RemovalColormap()
+        """
+
+        with LeptonicaErrorTrap():
+            return Pix(lept.pixRemoveColormap(self._pix, removal_type))
+
+    def otsu_adaptive_threshold(
+            self, tile_size=(300, 300), kernel_size=(4, 4), scorefract=0.1):
+        with LeptonicaErrorTrap():
+            sx, sy = tile_size
+            smoothx, smoothy = kernel_size
+            p_pix = ffi.new('PIX **')
+
+            result = lept.pixOtsuAdaptiveThreshold(
+                self._pix,
+                sx, sy,
+                smoothx, smoothy,
+                scorefract,
+                ffi.NULL,
+                p_pix)
+            if result == 0:
+                return Pix(p_pix[0])
+            else:
+                return None
+
+    def otsu_threshold_on_background_norm(
+            self, mask=None, tile_size=(10, 15), thresh=100, mincount=50,
+            bgval=255, kernel_size=(2, 2), scorefract=0.1):
+        with LeptonicaErrorTrap():
+            sx, sy = tile_size
+            smoothx, smoothy = kernel_size
+            if mask is None:
+                mask = ffi.NULL
+            if isinstance(mask, Pix):
+                mask = mask._pix
+
+            thresh_pix = lept.pixOtsuThreshOnBackgroundNorm(
+                self._pix,
+                mask,
+                sx, sy,
+                thresh, mincount, bgval,
+                smoothx, smoothy,
+                scorefract,
+                ffi.NULL
+                )
+            if thresh_pix == ffi.NULL:
+                return None
+            return Pix(thresh_pix)
+
+    def crop_to_foreground(
+            self, threshold=128, mindist=70, erasedist=30, pagenum=0,
+            showmorph=0, display=0, pdfdir=ffi.NULL):
+        with LeptonicaErrorTrap():
+            cropbox = Box(lept.pixFindPageForeground(
+                self._pix,
+                threshold,
+                mindist,
+                erasedist,
+                pagenum,
+                showmorph,
+                display,
+                pdfdir))
+
+            print(repr(cropbox))
+
+            cropped_pix = lept.pixClipRectangle(
+                self._pix,
+                cropbox._box,
+                ffi.NULL)
+
+            return Pix(cropped_pix)
+
+    def clean_background_to_white(
+            self, mask=None, grayscale=None, gamma=1.0, black=0, white=255):
+        with LeptonicaErrorTrap():
+            return Pix(lept.pixCleanBackgroundToWhite(
+                self._pix,
+                mask or ffi.NULL,
+                grayscale or ffi.NULL,
+                gamma,
+                black,
+                white))
+
+    @staticmethod
+    @lru_cache(maxsize=1)
+    def make_pixel_sum_tab8():
+        return lept.makePixelSumTab8()
+
     @staticmethod
     def correlation_binary(pix1, pix2):
-        if getLeptonicaVersion() < 'leptonica-1.72':
+        if get_leptonica_version() < 'leptonica-1.72':
             # Older versions of Leptonica (pre-1.72) have a buggy
             # implementation of pixCorrelationBinary that overflows on larger
-            # images.
-            pix1_count = ffi.new('l_int32 *', 0)
-            pix2_count = ffi.new('l_int32 *', 0)
-            pixn_count = ffi.new('l_int32 *', 0)
-            tab8 = lept.makePixelSumTab8()  # Small memory leak on each call
+            # images.  Ubuntu trusty has 1.70. Ubuntu PPA
+            # ppa:rebuntu16/avidemux+unofficial has "leptonlib" 1.73.
+            pix1_count = ffi.new('l_int32 *')
+            pix2_count = ffi.new('l_int32 *')
+            pixn_count = ffi.new('l_int32 *')
+            tab8 = Pix.make_pixel_sum_tab8()
 
-            lept.pixCountPixels(pix1.cpix, pix1_count, tab8)
-            lept.pixCountPixels(pix2.cpix, pix2_count, tab8)
-            pixn = Pix(lept.pixAnd(ffi.NULL, pix1.cpix, pix2.cpix))
-            lept.pixCountPixels(pixn.cpix, pixn_count, tab8)
+            lept.pixCountPixels(pix1._pix, pix1_count, tab8)
+            lept.pixCountPixels(pix2._pix, pix2_count, tab8)
+            pixn = Pix(lept.pixAnd(ffi.NULL, pix1._pix, pix2._pix))
+            lept.pixCountPixels(pixn._pix, pixn_count, tab8)
 
             # Python converts these int32s to larger units as needed
             # to avoid overflow. Overflow happens easily here.
@@ -190,7 +383,7 @@ class Pix:
             return correlation
         else:
             correlation = ffi.new('float *', 0.0)
-            result = lept.pixCorrelationBinary(pix1.cpix, pix2.cpix,
+            result = lept.pixCorrelationBinary(pix1._pix, pix2._pix,
                                                correlation)
             if result != 0:
                 raise LeptonicaError("Correlation failed")
@@ -198,13 +391,50 @@ class Pix:
 
     @staticmethod
     def _pix_destroy(pix):
-        ptr_to_pix = ffi.new('PIX **', pix)
-        lept.pixDestroy(ptr_to_pix)
+        p_pix = ffi.new('PIX **', pix)
+        lept.pixDestroy(p_pix)
         # print('pix destroy ' + repr(pix))
 
 
+class Box:
+    """Wrapper around Leptonica's BOX objects.
+
+    See class Pix for notes about reference counting.
+    """
+
+    def __init__(self, box):
+        self._box = ffi.gc(box, Box._box_destroy)
+
+    def __repr__(self):
+        if self._box:
+            return '<leptonica.Box x={0} y={1} w={2} h={3}>'.format(
+                self.x, self.y, self.w, self.h)
+        return '<leptonica.Box NULL>'
+
+    @property
+    def x(self):
+        return self._box.x
+
+    @property
+    def y(self):
+        return self._box.y
+
+    @property
+    def w(self):
+        return self._box.w
+
+    @property
+    def h(self):
+        return self._box.h
+
+    @staticmethod
+    def _box_destroy(box):
+        p_box = ffi.new('BOX **', box)
+        lept.boxDestroy(p_box)
+
+
 @lru_cache(maxsize=1)
-def getLeptonicaVersion():
+def get_leptonica_version():
     """Get Leptonica version string.
 
     Caveat: Leptonica expects the caller to free this memory.  We don't,
@@ -248,39 +478,12 @@ if __name__ == '__main__':
 
     args = parser.parse_args()
 
-    if getLeptonicaVersion() != u'leptonica-1.69':
+    if get_leptonica_version() != u'leptonica-1.69':
         print("Unexpected leptonica version: %s" % getLeptonicaVersion())
 
     args.func(args)
 
 
-def _test_output(mode, extension, im_format):
-    from PIL import Image
-    from tempfile import NamedTemporaryFile
-
-    with NamedTemporaryFile(prefix='test-lept-pnm', suffix=extension, delete=True) as tmpfile:
-        im = Image.new(mode=mode, size=(100, 100))
-        im.save(tmpfile)
-
-        pix = pixRead(tmpfile.name)
-        pixWriteImpliedFormat(tmpfile.name, pix)
-        pixDestroy(pix)
-
-        im_roundtrip = Image.open(tmpfile.name)
-        assert im_roundtrip.mode == im.mode, "leptonica mode differs"
-        assert im_roundtrip.format == im_format, \
-            "{0}: leptonica produced a {1}".format(
-                extension,
-                im_roundtrip.format)
-
-
-def test_pnm_output():
-    params = [['1', '.pbm', 'PPM'], ['L', '.pgm', 'PPM'],
-              ['RGB', '.ppm', 'PPM']]
-    for param in params:
-        _test_output(*param)
-
-
 def test_skew_angle():
     from PIL import Image, ImageDraw
     from tempfile import NamedTemporaryFile

ocrmypdf/lib/compile_leptonica.py

@@ -42,6 +42,18 @@ struct PixColormap
     l_int32          n;         /* number of color entries used            */
 };
 typedef struct PixColormap  PIXCMAP;
+
+struct Box
+{
+    l_int32            x;
+    l_int32            y;
+    l_int32            w;
+    l_int32            h;
+    l_uint32           refcount;      /* reference count (1 if no clones)  */
+
+};
+typedef struct Box    BOX;
+
 """)
 
 ffi.cdef("""
@@ -50,15 +62,81 @@ PIX * pixScale ( PIX *pixs, l_float32 scalex, l_float32 scaley );
 l_int32 pixFindSkew ( PIX *pixs, l_float32 *pangle, l_float32 *pconf );
 l_int32 pixWriteImpliedFormat ( const char *filename, PIX *pix, l_int32 quality, l_int32 progressive );
 void pixDestroy ( PIX **ppix );
+
+PIX *
+pixEndianByteSwapNew(PIX  *pixs);
+
 PIX * pixDeskew ( PIX *pixs, l_int32 redsearch );
 char * getLeptonicaVersion (  );
 l_int32 pixCorrelationBinary(PIX *pix1, PIX *pix2, l_float32 *pval);
 PIX *pixRotate180(PIX *pixd, PIX *pixs);
+PIX *
+pixRotateOrth(PIX     *pixs,
+              l_int32  quads);
 
 l_int32 pixCountPixels ( PIX *pix, l_int32 *pcount, l_int32 *tab8 );
 PIX * pixAnd ( PIX *pixd, PIX *pixs1, PIX *pixs2 );
 l_int32 * makePixelSumTab8 ( void );
+
+PIX * pixDeserializeFromMemory ( const l_uint32 *data, size_t nbytes );
+l_int32 pixSerializeToMemory ( PIX *pixs, l_uint32 **pdata, size_t *pnbytes );
+
+PIX * pixConvertRGBToLuminance(PIX *pixs);
+
+PIX * pixRemoveColormap(PIX *pixs, l_int32  type);
+
+l_int32
+pixOtsuAdaptiveThreshold(PIX       *pixs,
+                         l_int32    sx,
+                         l_int32    sy,
+                         l_int32    smoothx,
+                         l_int32    smoothy,
+                         l_float32  scorefract,
+                         PIX      **ppixth,
+                         PIX      **ppixd);
+
+PIX *
+pixOtsuThreshOnBackgroundNorm(PIX       *pixs,
+                              PIX       *pixim,
+                              l_int32    sx,
+                              l_int32    sy,
+                              l_int32    thresh,
+                              l_int32    mincount,
+                              l_int32    bgval,
+                              l_int32    smoothx,
+                              l_int32    smoothy,
+                              l_float32  scorefract,
+                              l_int32   *pthresh);
+
+PIX *
+pixCleanBackgroundToWhite(PIX       *pixs,
+                          PIX       *pixim,
+                          PIX       *pixg,
+                          l_float32  gamma,
+                          l_int32    blackval,
+                          l_int32    whiteval);
+
+BOX *
+pixFindPageForeground(PIX         *pixs,
+                      l_int32      threshold,
+                      l_int32      mindist,
+                      l_int32      erasedist,
+                      l_int32      pagenum,
+                      l_int32      showmorph,
+                      l_int32      display,
+                      const char  *pdfdir);
+
+PIX *
+pixClipRectangle(PIX   *pixs,
+                 BOX   *box,
+                 BOX  **pboxc);
+
+void
+boxDestroy(BOX  **pbox);
+
+void lept_free(void *ptr);
 """)
 
+
 if __name__ == '__main__':
     ffi.compile()

ocrmypdf/main.py

@@ -27,11 +27,12 @@ import ruffus.proxy_logger as proxy_logger
 
 from .hocrtransform import HocrTransform
 from .pageinfo import pdf_get_all_pageinfo
-from .pdfa import generate_pdfa_def
+from .pdfa import generate_pdfa_def, file_claims_pdfa
 from . import ghostscript
 from . import tesseract
 from . import qpdf
-from . import ExitCode, page_number
+from . import ExitCode, page_number, is_iterable_notstr
+from collections.abc import Sequence
 
 import pkg_resources
 
@@ -42,6 +43,8 @@ warnings.simplefilter('ignore', pypdf.utils.PdfReadWarning)
 
 BASEDIR = os.path.dirname(os.path.realpath(__file__))
 
+VECTOR_PAGE_DPI = 400
+
 
 # -------------
 # External dependencies
@@ -120,6 +123,16 @@ parser.add_argument(
 parser.add_argument(
     '-j', '--jobs', metavar='N', type=int,
     help="Use up to N CPU cores simultaneously (default: use all)")
+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'], 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.")
 
 metadata = parser.add_argument_group(
     "Metadata options",
@@ -188,6 +201,10 @@ advanced.add_argument(
     '--tesseract-timeout', default=180.0, type=float, metavar='SECONDS',
     help='give up on OCR after the timeout, but copy the preprocessed page '
          'into the final output')
+advanced.add_argument(
+    '--rotate-pages-threshold', default=14.0, type=float, metavar='CONFIDENCE',
+    help="only rotate pages when confidence is above this value (arbitrary "
+         "units reported by tesseract)")
 
 debugging = parser.add_argument_group(
     "Debugging",
@@ -234,13 +251,18 @@ if options.pdf_renderer == 'tesseract' and tesseract.version() < '3.04.01' \
         "Some PDF viewers will fail to find searchable text.\n"
         "--pdf-renderer=tesseract is not recommended.")
 
-if any((options.deskew, options.clean, options.clean_final)):
+if any((options.clean, options.clean_final)):
     try:
         from . import unpaper
-    except ImportError:
+        if unpaper.version() < '6.1':
+            complain(
+                "The installed 'unpaper' is not supported. "
+                "Install version 6.1 or newer.")
+            sys.exit(ExitCode.missing_dependency)
+    except FileNotFoundError:
         complain(
             "Install the 'unpaper' program to use --deskew or --clean.")
-        sys.exit(ExitCode.bad_args)
+        sys.exit(ExitCode.missing_dependency)
 else:
     unpaper = None
 
@@ -260,6 +282,13 @@ if options.clean and not options.clean_final \
         "Tesseract PDF renderer cannot render --clean pages without "
         "also performing --clean-final, so --clean-final is assumed.")
 
+if set(options.language) & {'chi_sim', 'chi_tra'} \
+        and (options.pdf_renderer == 'hocr' or options.output_type == 'pdfa'):
+    complain(
+        "Your settings are known to cause problems with OCR of Chinese text. "
+        "Try adding these arguments: "
+        "    ocrmypdf --pdf-renderer tesseract --output-type pdf")
+
 lossless_reconstruction = False
 if options.pdf_renderer == 'hocr':
     if not options.deskew and not options.clean_final and not options.force_ocr:
@@ -375,10 +404,87 @@ def cleanup_working_files(*args):
             shutil.rmtree(work_folder)
 
 
+def triage_image_file(input_file, output_file, log):
+    try:
+        log.info("Input file is not a PDF, checking if it is an image...")
+        im = Image.open(input_file)
+    except EnvironmentError as e:
+        log.error(e)
+        sys.exit(ExitCode.input_file)
+        return
+    else:
+        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.")
+                sys.exit(ExitCode.input_file)
+        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.")
+            sys.exit(ExitCode.input_file)
+
+        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.info('Input CMYK image has no ICC profile, not usable')
+                sys.exit(ExitCode.input_file)
+        im.close()
+
+    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(
+                (options.image_dpi, options.image_dpi))
+        with open(output_file, 'wb') as outf:
+            img2pdf.convert(
+                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)
+        sys.exit(ExitCode.input_file)
+
+
 @transform(
     input=options.input_file,
-    filter=formatter('(?i)\.pdf'),
-    output=work_folder + '{basename[0]}.repaired.pdf',
+    filter=formatter('(?i)'),
+    output=os.path.join(work_folder, '{basename[0]}.pdf'),
+    extras=[_log])
+def triage(
+        input_file,
+        output_file,
+        log):
+    try:
+        with open(input_file, 'rb') as f:
+            signature = f.read(4)
+            if signature == b'%PDF':
+                re_symlink(input_file, output_file)
+                return
+    except EnvironmentError as e:
+        log.error(e)
+        sys.exit(ExitCode.input_file)
+
+    triage_image_file(input_file, output_file, log)
+
+
+@transform(
+    input=triage,
+    filter=suffix('.pdf'),
+    output='.repaired.pdf',
+    output_dir=work_folder,
     extras=[_log, _pdfinfo, _pdfinfo_lock])
 def repair_pdf(
         input_file,
@@ -400,31 +506,60 @@ def get_pageinfo(input_file, pdfinfo, pdfinfo_lock):
     return pageinfo
 
 
+def get_page_dpi(pageinfo):
+    "Get the DPI when nonsquare DPI is tolerable"
+    xres = max(pageinfo.get('xres', VECTOR_PAGE_DPI), options.oversample or 0)
+    yres = max(pageinfo.get('yres', VECTOR_PAGE_DPI), options.oversample or 0)
+    return (float(xres), float(yres))
+
+
+def get_page_square_dpi(pageinfo):
+    "Get the DPI when we require xres == yres"
+    return float(max(
+        pageinfo.get('xres', VECTOR_PAGE_DPI),
+        pageinfo.get('yres', VECTOR_PAGE_DPI),
+        options.oversample or 0))
+
+
 def is_ocr_required(pageinfo, log):
     page = pageinfo['pageno'] + 1
     ocr_required = True
     if not pageinfo['images']:
-        # If the page has no images, then it contains vector content or text
-        # or both. It seems quite unlikely that one would find meaningful text
-        # from rasterizing vector content. So skip the page.
-        log.info(
-            "{0:4d}: page has no images - skipping OCR".format(page)
-        )
-        ocr_required = False
+        if options.force_ocr and options.oversample:
+            # The user really wants to reprocess this file
+            log.info(
+                "{0:4d}: page has no images - "
+                "rasterizing at {1} DPI because "
+                "--force-ocr --oversample was specified".format(
+                    page, options.oversample))
+        elif options.force_ocr:
+            # Warn the user they might not want to do this
+            log.warning(
+                "{0:4d}: page has no images - "
+                "all vector content will be "
+                "rasterized at {1} DPI, losing some resolution and likely "
+                "increasing file size. Use --oversample to adjust the "
+                "DPI.".format(page, VECTOR_PAGE_DPI))
+        else:
+            log.info(
+                "{0:4d}: page has no images - "
+                "skipping all processing on this page".format(page))
+            ocr_required = False
+
     elif pageinfo['has_text']:
-        s = "{0:4d}: page already has text! – {1}"
+        msg = "{0:4d}: page already has text! – {1}"
 
         if not options.force_ocr and not options.skip_text:
-            log.error(s.format(page,
-                               "aborting (use --force-ocr to force OCR)"))
+            log.error(msg.format(page,
+                                 "aborting (use --force-ocr to force OCR)"))
             sys.exit(ExitCode.already_done_ocr)
         elif options.force_ocr:
-            log.info(s.format(page,
-                              "rasterizing text and running OCR anyway"))
+            log.info(msg.format(page,
+                                "rasterizing text and running OCR anyway"))
             ocr_required = True
         elif options.skip_text:
-            log.info(s.format(page,
-                              "skipping all processing on this page"))
+            log.info(msg.format(page,
+                                "skipping all processing on this page"))
             ocr_required = False
 
     if ocr_required and options.skip_big:
@@ -443,12 +578,17 @@ def is_ocr_required(pageinfo, log):
     os.path.join(work_folder, '*.page.pdf'),
     extras=[_log, _pdfinfo, _pdfinfo_lock])
 def split_pages(
-        input_file,
+        input_files,
         output_files,
         log,
         pdfinfo,
         pdfinfo_lock):
 
+    if is_iterable_notstr(input_files):
+        input_file = input_files[0]
+    else:
+        input_file = input_files
+
     for oo in output_files:
         with suppress(FileNotFoundError):
             os.unlink(oo)
@@ -524,32 +664,52 @@ def orient_page(
 
     direction = {
         0: '⇧',
-        90: '⇦',
+        90: '⇨',
         180: '⇩',
-        270: '⇨'
+        270: '⇦'
     }
 
+    apply_correction = False
+    description = ''
+    if orient_conf.confidence >= options.rotate_pages_threshold:
+        if orient_conf.angle != 0:
+            apply_correction = True
+            description = ' - will rotate'
+        else:
+            description = ' - rotation appears correct'
+    else:
+        if orient_conf.angle != 0:
+            description = ' - confidence too low to rotate'
+        else:
+            description = ' - no change'
+
     log.info(
         '{0:4d}: page is facing {1}, confidence {2:.2f}{3}'.format(
             page_number(preview),
             direction.get(orient_conf.angle, '?'),
             orient_conf.confidence,
-            ' - correcting rotation' if orient_conf.angle != 0 else '')
+            description)
     )
 
-    if orient_conf.angle == 0:
+    if not apply_correction:
         re_symlink(page_pdf, output_file)
     else:
         writer = pypdf.PdfFileWriter()
         reader = pypdf.PdfFileReader(page_pdf)
         page = reader.pages[0]
 
-        # Rotate opposite of orientation
-        rotated_page = page.rotateClockwise(orient_conf.angle)
+        # angle is a clockwise angle, so rotating ccw will correct the error
+        rotated_page = page.rotateCounterClockwise(orient_conf.angle)
         writer.addPage(rotated_page)
         with open(output_file, 'wb') as out:
             writer.write(out)
 
+        with pdfinfo_lock:
+            pageno = int(os.path.basename(page_pdf)[0:6]) - 1
+            pageinfo = pdfinfo[pageno].copy()
+            pageinfo['rotated'] = orient_conf.angle
+            pdfinfo[pageno] = pageinfo
+
 
 @transform(
     input=orient_page,
@@ -577,11 +737,14 @@ def rasterize_with_ghostscript(
             device = 'pnggray'
 
     log.debug("Rasterize {0} with {1}".format(
-            os.path.basename(input_file), device))
-    xres = max(pageinfo['xres'], options.oversample or 0)
-    yres = max(pageinfo['yres'], options.oversample or 0)
+              os.path.basename(input_file), device))
 
-    ghostscript.rasterize_pdf(input_file, output_file, xres, yres, device, log)
+    # Produce the page image with square resolution or else deskew and OCR
+    # will not work properly
+    dpi = get_page_square_dpi(pageinfo)
+    ghostscript.rasterize_pdf(
+        input_file, output_file, xres=dpi, yres=dpi, raster_device=device,
+        log=log)
 
 
 @transform(
@@ -601,7 +764,7 @@ def preprocess_deskew(
         return
 
     pageinfo = get_pageinfo(input_file, pdfinfo, pdfinfo_lock)
-    dpi = int(pageinfo['xres'])
+    dpi = get_page_square_dpi(pageinfo)
 
     from . import leptonica
     leptonica.deskew(input_file, output_file, dpi)
@@ -624,7 +787,7 @@ def preprocess_clean(
         return
 
     pageinfo = get_pageinfo(input_file, pdfinfo, pdfinfo_lock)
-    dpi = int(pageinfo['xres'])
+    dpi = get_page_square_dpi(pageinfo)
 
     unpaper.clean(input_file, output_file, dpi, log)
 
@@ -675,13 +838,20 @@ def select_image_for_pdf(
     image = next(ii for ii in infiles if ii.endswith(image_suffix))
 
     pageinfo = get_pageinfo(image, pdfinfo, pdfinfo_lock)
-    if all(image['enc'] == 'jpeg' for image in pageinfo['images']):
+    if all(orig_image['enc'] == 'jpeg' for orig_image in pageinfo['images']):
         # If all images were JPEGs originally, produce a JPEG as output
         im = Image.open(image)
-        dpi = im.info.get(
-            'dpi',
-            (int(pageinfo['xres']), int(pageinfo['yres']))
-        )
+
+        # 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 tesseract, so keep it square.
+        fallback_dpi = get_page_square_dpi(pageinfo)
+        dpi = im.info.get('dpi', (fallback_dpi, fallback_dpi))
+
+        # Pillow requires integer DPI
+        dpi = round(dpi[0]), round(dpi[1])
         im.save(output_file, format='JPEG', dpi=dpi)
     else:
         re_symlink(image, output_file)
@@ -709,18 +879,16 @@ def select_image_layer(
         re_symlink(page_pdf, output_file)
     else:
         pageinfo = get_pageinfo(image, pdfinfo, pdfinfo_lock)
-        dpi = round(max(pageinfo['xres'], pageinfo['yres'],
-                        options.oversample))
-        imgsize = ((img2pdf.ImgSize.dpi, dpi), (img2pdf.ImgSize.dpi, dpi))
-
-        layout_fun = img2pdf.get_layout_fun(None, imgsize, None, None, None)
+        dpi = get_page_dpi(pageinfo)
+        dpi = float(dpi[0]), float(dpi[1])
+        layout_fun = img2pdf.get_fixed_dpi_layout_fun(dpi)
 
         with open(image, 'rb') as imfile, \
                 open(output_file, 'wb') as pdf:
             rawdata = imfile.read()
-            pdf.write(img2pdf.convert(
-                rawdata, producer="img2pdf", with_pdfrw=False,
-                layout_fun=layout_fun))
+            img2pdf.convert(
+                rawdata, with_pdfrw=False,
+                layout_fun=layout_fun, outputstream=pdf)
 
 
 @active_if(options.pdf_renderer == 'hocr')
@@ -737,7 +905,7 @@ def render_hocr_page(
         pdfinfo_lock):
     hocr = input_file
     pageinfo = get_pageinfo(hocr, pdfinfo, pdfinfo_lock)
-    dpi = round(max(pageinfo['xres'], pageinfo['yres'], options.oversample))
+    dpi = get_page_square_dpi(pageinfo)
 
     hocrtransform = HocrTransform(hocr, dpi)
     hocrtransform.to_pdf(output_file, imageFileName=None,
@@ -761,13 +929,17 @@ def render_hocr_debug_page(
     image = next(ii for ii in infiles if ii.endswith('.image'))
 
     pageinfo = get_pageinfo(image, pdfinfo, pdfinfo_lock)
-    dpi = round(max(pageinfo['xres'], pageinfo['yres'], options.oversample))
+    dpi = get_page_square_dpi(pageinfo)
 
     hocrtransform = HocrTransform(hocr, dpi)
     hocrtransform.to_pdf(output_file, imageFileName=None,
                          showBoundingboxes=True, invisibleText=False)
 
 
+class PdfMergeFailedError(Exception):
+    pass
+
+
 @active_if(options.pdf_renderer == 'hocr')
 @collate(
     input=[render_hocr_page, select_image_layer],
@@ -788,11 +960,12 @@ def add_text_layer(
 
     page_text = pdf_text.getPage(0)
 
-    # The text page always will be oriented up
+    # The text page always will be oriented up by this stage
     # but if lossless_reconstruction, pdf_image may have a rotation applied
-    # we can't just merge the pages, because a page can only have one /Rotate
-    # tag, so the differential rotation must be corrected.
-    # Also, pdf_image may not have its mediabox nailed to (0, 0)
+    # We have to eliminate the /Rotate tag (because it applies to the whole
+    # page) and rotate the image layer to match the text page
+    # Also, pdf_image may not have its mediabox nailed to (0, 0), so may need
+    # translation
     page_image = pdf_image.getPage(0)
     rotation = page_image.get('/Rotate', 0)
 
@@ -806,7 +979,7 @@ def add_text_layer(
     y2 = page_image.mediaBox.getUpperRight_y()
 
     # Rotation occurs about the page's (0, 0). Most pages will have the media
-    # box at (0, 0) will all content in the first quadrant but some cropped
+    # box at (0, 0) with all content in the first quadrant but some cropped
     # files may have an offset mediabox. We translate the page so that its
     # bottom left corner after rotation is pinned to (0, 0) with the image
     # in the first quadrant.
@@ -825,8 +998,12 @@ def add_text_layer(
         log.info("{0:4d}: rotating image layer {1} degrees".format(
             page_number(image), rotation, tx, ty))
 
-    page_text.mergeRotatedScaledTranslatedPage(
-        page_image, rotation, 1.0, tx, ty, expand=False)
+    try:
+        page_text.mergeRotatedScaledTranslatedPage(
+            page_image, rotation, 1.0, tx, ty, expand=False)
+    except (AttributeError, ValueError) as e:
+        if 'writeToStream' in str(e) or 'invalid literal' in str(e):
+            raise PdfMergeFailedError() from e
 
     pdf_output = pypdf.PdfFileWriter()
     pdf_output.addPage(page_text)
@@ -866,6 +1043,40 @@ def tesseract_ocr_and_render_pdf(
         log=log)
 
 
+def get_pdfmark(base_pdf):
+    def from_document_info(key):
+        # pdf.documentInfo.get() DOES NOT behave as expected for a dict-like
+        # object, so call with precautions.  TypeError may occur if the PDF
+        # is missing the optional document info section.
+        try:
+            s = base_pdf.documentInfo[key]
+            return str(s)
+        except (KeyError, TypeError):
+            return ''
+
+    pdfmark = {
+        '/Title': from_document_info('/Title'),
+        '/Author': from_document_info('/Author'),
+        '/Keywords': from_document_info('/Keywords'),
+        '/Subject': from_document_info('/Subject'),
+    }
+    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
+
+    pdfmark['/Creator'] = '{0} {1} / Tesseract OCR{2} {3}'.format(
+            parser.prog, VERSION,
+            '+PDF' if options.pdf_renderer == 'tesseract' else '',
+            tesseract.version())
+    return pdfmark
+
+
+@active_if(options.output_type == 'pdfa')
 @transform(
     input=repair_pdf,
     filter=formatter(r'\.repaired\.pdf'),
@@ -877,37 +1088,7 @@ def generate_postscript_stub(
         log):
 
     pdf = pypdf.PdfFileReader(input_file)
-
-    def from_document_info(key):
-        # pdf.documentInfo.get() DOES NOT behave as expected for a dict-like
-        # object, so call with precautions.  TypeError may occur if the PDF
-        # is missing the optional document info section.
-        try:
-            s = pdf.documentInfo[key]
-            return str(s)
-        except (KeyError, TypeError):
-            return ''
-
-    pdfmark = {
-        'title': from_document_info('/Title'),
-        'author': from_document_info('/Author'),
-        'keywords': from_document_info('/Keywords'),
-        'subject': from_document_info('/Subject'),
-    }
-    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
-
-    pdfmark['creator'] = '{0} {1} / Tesseract OCR{2} {3}'.format(
-            parser.prog, VERSION,
-            '+PDF' if options.pdf_renderer == 'tesseract' else '',
-            tesseract.version())
-
+    pdfmark = get_pdfmark(pdf)
     generate_pdfa_def(output_file, pdfmark)
 
 
@@ -928,12 +1109,13 @@ def skip_page(
     re_symlink(input_file, output_file, log)
 
 
+@active_if(options.output_type == 'pdfa')
 @merge(
     input=[add_text_layer, render_hocr_debug_page, skip_page,
            tesseract_ocr_and_render_pdf, generate_postscript_stub],
     output=os.path.join(work_folder, 'merged.pdf'),
     extras=[_log, _pdfinfo, _pdfinfo_lock])
-def merge_pages(
+def merge_pages_ghostscript(
         input_files,
         output_file,
         log,
@@ -958,26 +1140,66 @@ def merge_pages(
     ghostscript.generate_pdfa(pdf_pages, output_file, options.jobs or 1)
 
 
-@transform(
-    input=merge_pages,
-    filter=formatter(),
-    output=options.output_file,
+@active_if(options.output_type == 'pdf')
+@merge(
+    input=[add_text_layer, render_hocr_debug_page, skip_page,
+           tesseract_ocr_and_render_pdf, repair_pdf],
+    output=os.path.join(work_folder, 'merged.pdf'),
     extras=[_log, _pdfinfo, _pdfinfo_lock])
-def copy_final(
-        input_file,
+def merge_pages_qpdf(
+        input_files,
         output_file,
         log,
         pdfinfo,
         pdfinfo_lock):
+
+    metadata_file = next(
+        (ii for ii in input_files if ii.endswith('.repaired.pdf')))
+    input_files.remove(metadata_file)
+
+    def input_file_order(s):
+        '''Sort order: All rendered pages followed
+        by their debug page.'''
+        key = int(os.path.basename(s)[0:6]) * 10
+        if 'debug' in os.path.basename(s):
+            key += 1
+        return key
+
+    pdf_pages = sorted(input_files, key=input_file_order)
+    log.debug("Final pages: " + "\n".join(pdf_pages))
+
+    reader_metadata = pypdf.PdfFileReader(metadata_file)
+    pdfmark = get_pdfmark(reader_metadata)
+    pdfmark['/Producer'] = 'qpdf ' + qpdf.version()
+
+    first_page = pypdf.PdfFileReader(pdf_pages[0])
+
+    writer = pypdf.PdfFileWriter()
+    writer.appendPagesFromReader(first_page)
+    writer.addMetadata(pdfmark)
+    writer_file = pdf_pages[0].replace('.pdf', '.metadata.pdf')
+    with open(writer_file, 'wb') as f:
+        writer.write(f)
+
+    pdf_pages[0] = writer_file
+
+    qpdf.merge(pdf_pages, output_file)
+
+
+@merge(
+    input=[merge_pages_ghostscript, merge_pages_qpdf],
+    output=options.output_file,
+    extras=[_log, _pdfinfo, _pdfinfo_lock])
+def copy_final(
+        input_files,
+        output_file,
+        log,
+        pdfinfo,
+        pdfinfo_lock):
+    input_file = next((ii for ii in input_files if ii.endswith('.pdf')))
     shutil.copy(input_file, output_file)
 
 
-def validate_pdfa(
-        input_file,
-        log):
-    return qpdf.check(input_file, log)
-
-
 def available_cpu_count():
     try:
         return multiprocessing.cpu_count()
@@ -1003,41 +1225,140 @@ def cleanup_ruffus_error_message(msg):
     return msg
 
 
+def do_ruffus_exception(ruffus_five_tuple):
+    """Replace the elaborate ruffus stack trace with a user friendly
+    description of the error message that occurred."""
+
+    task_name, job_name, exc_name, exc_value, exc_stack = ruffus_five_tuple
+    if exc_name == 'builtins.SystemExit':
+        match = re.search(r"\.(.+?)\)", exc_value)
+        exit_code_name = match.groups()[0]
+        exit_code = getattr(ExitCode, exit_code_name, 'other_error')
+        return exit_code
+    elif exc_name == 'ruffus.ruffus_exceptions.MissingInputFileError':
+        _log.error(cleanup_ruffus_error_message(exc_value))
+        return ExitCode.input_file
+    elif exc_name == 'builtins.TypeError':
+        # Even though repair_pdf will fail, ruffus will still try
+        # to call split_pages with no input files, likely due to a bug
+        if task_name == 'split_pages':
+            _log.error("Input file '{0}' is not a valid PDF".format(
+                options.input_file))
+            return ExitCode.input_file
+    elif exc_name == 'builtins.KeyboardInterrupt':
+        _log.error("Interrupted by user")
+        return ExitCode.ctrl_c
+    elif exc_name == 'subprocess.CalledProcessError':
+        # It's up to the subprocess handler to report something useful
+        msg = "Error occurred while running this command:"
+        _log.error(msg + '\n' + exc_value)
+        return ExitCode.child_process_error
+    elif exc_name == 'ocrmypdf.main.PdfMergeFailedError':
+        _log.error(textwrap.dedent("""\
+            Failed to merge PDF image layer with OCR layer
+
+            Usually this happens because the input PDF file is mal-formed and
+            ocrmypdf cannot automatically correct the problem on its own.
+
+            Try using
+                ocrmypdf --pdf-renderer tesseract  [..other args..]
+            """))
+        return ExitCode.input_file
+    elif exc_name == 'PyPDF2.utils.PdfReadError' and \
+            'not been decrypted' in exc_value:
+        _log.error(textwrap.dedent("""\
+            Input PDF uses either an encryption algorithm or a PDF security
+            handler that is not supported by ocrmypdf.
+
+            For information about this PDF's security use
+                qpdf --show-encryption [...input PDF...]
+
+            (Only algorithms "R = 1" and "R = 2" are supported.)
+
+            """))
+        return ExitCode.encrypted_pdf
+
+    if not options.verbose:
+        _log.error(exc_stack)
+    return ExitCode.other_error
+
+
+def traverse_ruffus_exception(e_args):
+    """Walk through a RethrownJobError and find the first exception.
+
+    The exit code will be based on this, even if multiple exceptions occurred
+    at the same time."""
+
+    if isinstance(e_args, Sequence) and isinstance(e_args[0], str) and \
+            len(e_args) == 5:
+        return do_ruffus_exception(e_args)
+    elif is_iterable_notstr(e_args):
+        for exc in e_args:
+            return traverse_ruffus_exception(exc)
+
+
 def run_pipeline():
     if not options.jobs:
         options.jobs = available_cpu_count()
     try:
-        options.history_file = os.path.join(work_folder, 'ruffus_history.sqlite')
+        options.history_file = os.path.join(
+            work_folder, 'ruffus_history.sqlite')
         cmdline.run(options)
     except ruffus_exceptions.RethrownJobError as e:
         if options.verbose:
-            print(e)
+            _log.debug(str(e))  # stringify exception so logger doesn't have to
 
-        # Yuck. Hunt through the ruffus exception to find out what the
-        # return code is supposed to be.
-        for exc in e.args:
-            task_name, job_name, exc_name, exc_value, exc_stack = exc
-            if exc_name == 'builtins.SystemExit':
-                match = re.search(r"\.(.+?)\)", exc_value)
-                exit_code_name = match.groups()[0]
-                exit_code = getattr(ExitCode, exit_code_name, 'other_error')
-                return exit_code
-            elif exc_name == 'ruffus.ruffus_exceptions.MissingInputFileError':
-                print(cleanup_ruffus_error_message(exc_value))
-                return ExitCode.input_file
-            elif exc_name == 'builtins.TypeError':
-                # Even though repair_pdf will fail, ruffus will still try
-                # to call split_pages with no input files, likely due to a bug
-                if task_name == 'split_pages':
-                    print("Input file '{0}' is not a valid PDF".format(
-                        options.input_file))
-                    return ExitCode.input_file
+        # Ruffus flattens exception to 5 element tuples. Because of a bug
+        # in <= 2.6.3 it may present either the single:
+        #   (task, job, exc, value, stack)
+        # or something like:
+        #   [[(task, job, exc, value, stack)]]
+        #
+        # Generally cross-process exception marshalling doesn't work well
+        # and ruffus doesn't support because BaseException has its own
+        # implementation of __reduce__ that attempts to reconstruct the
+        # exception based on e.__init__(e.args).
+        #
+        # Attempting to log the exception directly marshalls it to the logger
+        # which is probably in another process, so it's better to log only
+        # data from the exception at this point.
 
+        exitcode = traverse_ruffus_exception(e.args)
+        if exitcode is None:
+            _log.error("Unexpected ruffus exception: " + str(e))
+            _log.error(repr(e))
+            return ExitCode.other_error
+        else:
+            return exitcode
+    except Exception as e:
+        _log.error(e)
         return ExitCode.other_error
 
-    if not validate_pdfa(options.output_file, _log):
-        _log.warning('Output file: The generated PDF/A file is INVALID')
-        return ExitCode.invalid_output_pdfa
+    if options.output_type == 'pdfa':
+        pdfa_info = file_claims_pdfa(options.output_file)
+        if pdfa_info['pass']:
+            _log.info(pdfa_info['message'])
+        else:
+            _log.warning(pdfa_info['message'])
+            return ExitCode.invalid_output_pdf
+
+    if not qpdf.check(options.output_file, _log):
+        _log.warning('Output file: The generated PDF is INVALID')
+        return ExitCode.invalid_output_pdf
+
+    with _pdfinfo_lock:
+        _log.debug(_pdfinfo)
+        direction = {0: 'n', 90: 'e',
+                     180: 's', 270: 'w'}
+        orientations = []
+        for n, page in enumerate(_pdfinfo):
+            angle = _pdfinfo[n].get('rotated', 0)
+            if angle != 0:
+                orientations.append('{0}{1}'.format(
+                    n + 1,
+                    direction.get(angle, '')))
+        if orientations:
+            _log.info('Page orientations detected: ' + ' '.join(orientations))
 
     return ExitCode.ok
 

ocrmypdf/pageinfo.py

@@ -3,10 +3,13 @@
 
 from subprocess import Popen, PIPE
 from decimal import Decimal, getcontext
+from math import hypot
 import re
 import sys
 import PyPDF2 as pypdf
+from collections import namedtuple
 
+matrix_mult = pypdf.pdf.utils.matrixMultiply
 
 FRIENDLY_COLORSPACE = {
     '/DeviceGray': 'gray',
@@ -19,7 +22,11 @@ FRIENDLY_COLORSPACE = {
     '/Indexed': 'index',
     '/Separation': 'sep',
     '/DeviceN': 'devn',
-    '/Pattern': '-'
+    '/Pattern': '-',
+    '/G': 'gray',  # Abbreviations permitted in inline images
+    '/RGB': 'rgb',
+    '/CMYK': 'cmyk',
+    '/I': 'index',
 }
 
 FRIENDLY_ENCODING = {
@@ -27,6 +34,13 @@ FRIENDLY_ENCODING = {
     '/DCTDecode': 'jpeg',
     '/JPXDecode': 'jpx',
     '/JBIG2Decode': 'jbig2',
+    '/CCF': 'ccitt',  # Abbreviations permitted in inline images
+    '/DCT': 'jpeg',
+    '/AHx': 'asciihex',
+    '/A85': 'ascii85',
+    '/LZW': 'lzw',
+    '/Fl': 'flate',
+    '/RL': 'runlength'
 }
 
 FRIENDLY_COMP = {
@@ -38,47 +52,165 @@ FRIENDLY_COMP = {
 }
 
 
-def _page_has_inline_images(page):
-    # PDF always uses \r\n for separator regardless of platform
-    # Really basic heuristic that might trigger the odd false positive
-    # This is only finds the first image and is not quite spec compliant
-    try:
-        contents = page.getContents()
-        data = contents.getData()
-    except AttributeError:
-        # If we can't access the contents or data (empty page?) then there
-        # are no inline images
-        return False
+def _matrix_from_shorthand(shorthand):
+    """Convert from PDF matrix shorthand to full matrix
 
-    begin_image, image_data, end_image = False, False, False
-    for data in re.split(b'\s+', data):
-        if data == b'BI':
-            begin_image = True
-        elif data == b'ID':
-            image_data = True
-        elif data == b'EI':
-            end_image = True
-        if all((begin_image, image_data, end_image)):
-            return True
-    return False
+    PDF 1.7 spec defines a shorthand for describing the entries of a matrix
+    since the last column is always (0, 0, 1).
+    """
+
+    a, b, c, d, e, f = map(float, shorthand)
+    return ((a, b, 0),
+            (c, d, 0),
+            (e, f, 1))
 
 
-def _find_page_images(page, pageinfo):
+def _shorthand_from_matrix(matrix):
+    """Convert from transformation matrix to PDF shorthand."""
+    a, b = matrix[0][0], matrix[0][1]
+    c, d = matrix[1][0], matrix[1][1]
+    e, f = matrix[2][0], matrix[2][1]
+    return tuple(map(float, (a, b, c, d, e, f)))
+
+
+ContentsInfo = namedtuple('ContentsInfo', ['raster_settings', 'inline_images'])
+
+
+def _interpret_contents(contentstream):
+    operations = contentstream.operations
+    stack = []
+    ctm = _matrix_from_shorthand((1, 0, 0, 1, 0, 0))
+    image_raster_settings = []
+    inline_images = []
+
+    for op in operations:
+        operands, command = op
+        if command == b'q':
+            stack.append(ctm)
+            if len(stack) > 32:
+                raise RuntimeError("PDF graphics stack overflow")
+        elif command == b'Q':
+            ctm = stack.pop()
+        elif command == b'cm':
+            ctm = matrix_mult(
+                _matrix_from_shorthand(operands), ctm)
+        elif command == b'Do':
+            image_name = operands[0]
+            image_raster_settings.append(
+                (image_name, _shorthand_from_matrix(ctm)))
+        elif command == b'INLINE IMAGE':
+            settings = operands['settings']
+            inline_images.append(
+                (settings, _shorthand_from_matrix(ctm)))
+
+    return ContentsInfo(
+        raster_settings=image_raster_settings,
+        inline_images=inline_images)
+
+
+def _get_dpi(ctm_shorthand, image_size):
+    """Given the transformation matrix and image size, find the image DPI.
+
+    PDFs do not include image resolution information within image data.
+    Instead, the PDF page content stream describes the location where the
+    image will be rasterized, and the effective resolution is the ratio of the
+    pixel size to raster target size.
+
+    Normally a scanned PDF has the paper size set appropriately but this is
+    not guaranteed. The most common case is a cropped image will change the
+    page size (/CropBox) without altering the page content stream. That means
+    it is not sufficient to assume that the image fills the page, even though
+    that is the most common case.
+
+    A PDF image may be scaled (always), cropped, translated, rotated in place
+    to an arbitrary angle (rarely) and skewed. Only equal area mappings can
+    be expressed, that is, it is not necessary to consider distortions where
+    the effective DPI varies with position.
+
+    To determine the image scale, transform an offset axis vector v0 (0, 0),
+    width-axis vector v0 (1, 0), height-axis vector vh (0, 1) with the matrix,
+    which gives the dimensions of the image in PDF units. From there we can
+    compare to actual image dimensions. PDF uses
+    row vector * matrix_tranposed unlike the traditional
+    matrix * column vector.
+
+    The offset, width and height vectors can be combined in a matrix and
+    multiplied by the transform matrix. Then we want to calculated
+        magnitude(width_vector - offset_vector)
+    and
+        magnitude(height_vector - offset_vector)
+
+    When the above is worked out algebraically, the effect of translation
+    cancels out, and the vector magnitudes become functions of the nonzero
+    transformation matrix indices. The results of the derivation are used
+    in this code.
+
+    pdfimages -list does calculate the DPI in some way that is not completely
+    naive, but it does not get the DPI of rotated images right, so cannot be
+    used anymore to validate this. Photoshop works, or using Acrobat to
+    rotate the image back to normal.
+
+    It does not matter if the image is partially cropped, or even out of the
+    /MediaBox.
+
+    """
+
+    a, b, c, d, _, _ = ctm_shorthand
+
+    # Calculate the width and height of the image in PDF units
+    image_drawn_width = hypot(a, b)
+    image_drawn_height = hypot(c, d)
+
+    # The scale of the image is pixels per PDF unit (1/72")
+    scale_w = image_size[0] / image_drawn_width
+    scale_h = image_size[1] / image_drawn_height
+
+    # DPI = scale * 72
+    dpi_w = scale_w * 72.0
+    dpi_h = scale_h * 72.0
+
+    return (dpi_w, dpi_h)
+
+
+def _find_page_inline_images(page, pageinfo, contentsinfo):
+    "Find inline images on the page"
+
+    for n, im in enumerate(contentsinfo.inline_images):
+        settings, shorthand = im
+        image = {}
+        image['name'] = str('inline-%02d' % n)
+        image['width'] = settings['/W']
+        image['height'] = settings['/H']
+        image['bpc'] = settings['/BPC']
+        image['color'] = FRIENDLY_COLORSPACE.get(settings['/CS'], '-')
+        image['comp'] = FRIENDLY_COMP.get(image['color'], '?')
+        if '/F' in settings:
+            filter_ = settings['/F']
+            if isinstance(filter_, pypdf.generic.ArrayObject):
+                filter_ = filter_[0]
+            image['enc'] = FRIENDLY_ENCODING.get(filter_, 'image')
+        else:
+            image['enc'] = 'image'
+
+        dpi_w, dpi_h = _get_dpi(shorthand, (image['width'], image['height']))
+        image['dpi_w'], image['dpi_h'] = Decimal(dpi_w), Decimal(dpi_h)
+        yield image
+
+
+def _find_page_regular_images(page, pageinfo, contentsinfo):
+    "Find images stored in XObject resources"
+
     try:
         page['/Resources']['/XObject']
     except KeyError:
         return
-
-    # Look for XObject (out of line images)
     for xobj in page['/Resources']['/XObject']:
         # PyPDF2 returns the keys as an iterator
         pdfimage = page['/Resources']['/XObject'][xobj]
         if pdfimage['/Subtype'] != '/Image':
             continue
-        if '/ImageMask' in pdfimage:
-            if pdfimage['/ImageMask']:
-                continue
         image = {}
+        image['name'] = str(xobj)
         image['width'] = pdfimage['/Width']
         image['height'] = pdfimage['/Height']
         image['bpc'] = pdfimage['/BitsPerComponent']
@@ -98,12 +230,41 @@ def _find_page_images(page, pageinfo):
             image['color'] = 'jpx' if image['enc'] == 'jpx' else '?'
 
         image['comp'] = FRIENDLY_COMP.get(image['color'], '?')
-        image['dpi_w'] = image['width'] / pageinfo['width_inches']
-        image['dpi_h'] = image['height'] / pageinfo['height_inches']
+
+        # Bit of a hack... infer grayscale if component count is uncertain
+        # but encoding must be monochrome. This happens if a monochrome image
+        # has an ICC profile attached. Better solution would be to examine
+        # the ICC profile.
+        if image['comp'] == '?' and image['enc'] in ('ccitt', 'jbig2'):
+            image['comp'] = FRIENDLY_COMP['gray']
+
+        image['dpi_w'] = image['dpi_h'] = 0
+
+        for raster in contentsinfo.raster_settings:
+            # Loop in case the same image is display multiple times on a page
+            if raster[0] != image['name']:
+                continue
+            shorthand = raster[1]
+
+            dpi_w, dpi_h = _get_dpi(
+                shorthand, (image['width'], image['height']))
+
+            # When image is used multiple times take the highest DPI it is
+            # rendered at
+            image['dpi_w'] = max(dpi_w, image.get('dpi_w', 0))
+            image['dpi_h'] = max(dpi_h, image.get('dpi_h', 0))
+
+        image['dpi_w'] = Decimal(image['dpi_w'])
+        image['dpi_h'] = Decimal(image['dpi_h'])
         image['dpi'] = (image['dpi_w'] * image['dpi_h']) ** Decimal(0.5)
         yield image
 
 
+def _find_page_images(page, pageinfo, contentsinfo):
+    yield from _find_page_inline_images(page, pageinfo, contentsinfo)
+    yield from _find_page_regular_images(page, pageinfo, contentsinfo)
+
+
 def _page_has_text(pdf, page):
     # Simple test
     text = page.extractText()
@@ -141,12 +302,14 @@ def _pdf_get_pageinfo(infile, pageno: int):
     pageinfo['width_inches'] = width_pt / Decimal(72.0)
     pageinfo['height_inches'] = height_pt / Decimal(72.0)
 
-    pageinfo['images'] = [im for im in _find_page_images(page, pageinfo)]
+    try:
+        contentstream = pypdf.pdf.ContentStream(page.getContents(), pdf)
+    except AttributeError as e:
+        return pageinfo
 
-    # Look for inline images
-    if _page_has_inline_images(page):
-        raise NotImplementedError(
-            "Warning: input PDF contains inline images - not supported")
+    contentsinfo = _interpret_contents(contentstream)
+    pageinfo['images'] = [im for im in _find_page_images(
+                                page, pageinfo, contentsinfo)]
 
     if pageinfo['images']:
         xres = max(image['dpi_w'] for image in pageinfo['images'])
@@ -164,3 +327,17 @@ def pdf_get_all_pageinfo(infile):
     pdf = pypdf.PdfFileReader(infile)
     getcontext().prec = 6
     return [_pdf_get_pageinfo(infile, n) for n in range(pdf.numPages)]
+
+
+def main():
+    import argparse
+    parser = argparse.ArgumentParser()
+    parser.add_argument('infile')
+    args = parser.parse_args()
+    info = pdf_get_all_pageinfo(args.infile)
+    from pprint import pprint
+    pprint(info)
+
+
+if __name__ == '__main__':
+    main()

ocrmypdf/pdfa.py

@@ -5,10 +5,14 @@
 
 from __future__ import print_function, absolute_import, division
 from string import Template
-from subprocess import Popen, PIPE
-import os
 import codecs
-from . import get_program
+import pkg_resources
+import PyPDF2 as pypdf
+
+ICC_PROFILE_RELPATH = 'data/sRGB.icc'
+
+SRGB_ICC_PROFILE = pkg_resources.resource_filename(
+    'ocrmypdf', ICC_PROFILE_RELPATH)
 
 
 # This is a template written in PostScript which is needed to create PDF/A
@@ -71,8 +75,14 @@ def encode_text_string(s: str) -> str:
     Postscript file to be completely ASCII and no escaping of Postscript
     characters is necessary.
     '''
+
+    # Sometimes lazy C programmer leave their NULs at the end of strings
+    # tests/resources/aspect.pdf is one example (created by ImageMagick)
+    s = s.replace('\x00', '')
+
     if s == '':
         return ''
+
     utf16_bytes = s.encode('utf-16be')
     ascii_hex_bytes = codecs.encode(b'\xfe\xff' + utf16_bytes, 'hex')
     ascii_hex_str = ascii_hex_bytes.decode('ascii').lower()
@@ -85,52 +95,64 @@ def _get_pdfa_def(icc_profile, icc_identifier, pdfmark):
     t = Template(pdfa_def_template)
     result = t.substitute(icc_profile=icc_profile,
                           icc_identifier=icc_identifier,
-                          title=pdfmark_utf16.get('title', ''),
-                          author=pdfmark_utf16.get('author', ''),
-                          subject=pdfmark_utf16.get('subject', ''),
-                          creator=pdfmark_utf16.get('creator', ''),
-                          keywords=pdfmark_utf16.get('keywords', ''))
+                          title=pdfmark_utf16.get('/Title', ''),
+                          author=pdfmark_utf16.get('/Author', ''),
+                          subject=pdfmark_utf16.get('/Subject', ''),
+                          creator=pdfmark_utf16.get('/Creator', ''),
+                          keywords=pdfmark_utf16.get('/Keywords', ''))
     return result
 
 
-def _get_postscript_icc_path():
-    "Parse Ghostscript's help message to find where iccprofiles are stored"
-
-    p_gs = Popen([get_program('gs'), '--help'], close_fds=True,
-                 universal_newlines=True,
-                 stdout=PIPE, stderr=PIPE)
-    out, _ = p_gs.communicate()
-    lines = out.splitlines()
-
-    def search_paths(lines):
-        seeking = True
-        for line in lines:
-            if seeking:
-                if line.startswith('Search path'):
-                    seeking = False
-                    continue
-            else:
-                if line.strip().startswith('/'):
-                    yield from (
-                        path.strip() for path in line.split(':')
-                        if path.strip() != '')
-    for root in search_paths(lines):
-        path = os.path.realpath(os.path.join(root, '../iccprofiles'))
-        if os.path.exists(path):
-            return path
-
-    raise FileNotFoundError("Could not find Ghostscript's iccprofiles")
-
-
 def generate_pdfa_def(target_filename, pdfmark, icc='sRGB'):
     if icc == 'sRGB':
-        icc_profile = os.path.join(_get_postscript_icc_path(), 'srgb.icc')
+        icc_profile = SRGB_ICC_PROFILE
     else:
         raise NotImplementedError("Only supporting sRGB")
 
     ps = _get_pdfa_def(icc_profile, icc, pdfmark)
 
-    # Since PostScript might not handle UTF-8 (it's hard to get a clear
-    # answer), insist on ascii
+    # We should have encoded everything to pure ASCII by this point, and
+    # to be safe, only allow ASCII in PostScript
     with open(target_filename, 'w', encoding='ascii') as f:
         f.write(ps)
+
+
+def file_claims_pdfa(filename):
+    """Determines if the file claims to be PDF/A compliant
+
+    Checking if a file is a truly compliant PDF/A is a massive undertaking
+    that no open source tool does properly.  Some commercial tools are
+    generally reliable (Acrobat).
+
+    This checks if the XMP metadata contains a PDF/A marker.
+    """
+
+    pdf = pypdf.PdfFileReader(filename)
+    xmp = pdf.getXmpMetadata()
+
+    try:
+        pdfa_nodes = xmp.getNodesInNamespace(
+            aboutUri='',
+            namespace='http://www.aiim.org/pdfa/ns/id/')
+    except AttributeError:
+        return {'pass': False, 'output': 'pdf', 'message': 'No XMP metadata'}
+
+    pdfa_dict = {attr.localName: attr.value for attr in pdfa_nodes}
+    pdfa_dict['pass'] = False
+    pdfa_dict['output'] = 'pdf'
+    if pdfa_dict:
+        part_conformance = pdfa_dict['part'] + pdfa_dict['conformance']
+        valid_part_conforms = {'1A', '1B', '2A', '2B', '2U', '3A', '3B', '3U'}
+
+        message = 'File claims to be PDF/A-{}'.format(
+            part_conformance)
+
+        if part_conformance in valid_part_conforms:
+            pdfa_dict['pass'] = True
+            pdfa_dict['output'] = 'pdfa'
+        pdfa_dict['message'] = message
+    else:
+        pdfa_dict['message'] = 'File is a regular PDF'
+
+    return pdfa_dict
+

ocrmypdf/qpdf.py

@@ -2,12 +2,32 @@
 # © 2015 James R. Barlow: github.com/jbarlow83
 
 from subprocess import CalledProcessError, check_output, STDOUT, check_call
+from functools import lru_cache
 import sys
 import os
+import re
 
 from . import ExitCode, get_program
 
 
+@lru_cache(maxsize=1)
+def version():
+    args_qpdf = [
+        get_program('qpdf'),
+        '--version'
+    ]
+    try:
+        versions = check_output(
+            args_qpdf, close_fds=True, universal_newlines=True,
+            stderr=STDOUT)
+    except CalledProcessError:
+        print("Could not find qpdf executable on system PATH.")
+        sys.exit(ExitCode.missing_dependency)
+
+    qpdf_version = re.match(r'qpdf version (.+)', versions).group(1)
+    return qpdf_version
+
+
 def check(input_file, log):
     args_qpdf = [
         get_program('qpdf'),
@@ -20,7 +40,7 @@ def check(input_file, log):
     except CalledProcessError as e:
         if e.returncode == 2:
             log.error("{0}: not a valid PDF, and could not repair it.".format(
-                    input_file))
+                input_file))
             log.error("Details:")
             log.error(e.output)
         elif e.returncode == 3:
@@ -85,3 +105,15 @@ def split_pages(input_file, work_folder, npages):
             os.path.join(work_folder, '{0:06d}.page.pdf'.format(n + 1))
         ]
         check_call(args_qpdf)
+
+
+def merge(input_files, output_file):
+    """Merge the list of input files (all filenames) into the output file.
+
+    The input files may contain one or more pages.
+    """
+    args_qpdf = [
+        get_program('qpdf'), input_files[0], '--pages'
+    ] + input_files + ['--', output_file]
+    check_call(args_qpdf)
+

ocrmypdf/tesseract.py

@@ -90,14 +90,18 @@ def get_orientation(input_file, language: list, timeout: float, log):
         'stdout'
     ]
 
-    p = Popen(args_tesseract, close_fds=True, stdout=PIPE, stderr=STDOUT,
-              universal_newlines=True)
     try:
-        stdout, _ = p.communicate(timeout=timeout)
+        stdout = check_output(
+            args_tesseract, close_fds=True, stderr=STDOUT,
+            universal_newlines=True, timeout=timeout)
     except TimeoutExpired:
-        p.kill()
-        stdout, _ = p.communicate()
         return OrientationConfidence(angle=0, confidence=0.0)
+    except CalledProcessError as e:
+        tesseract_log_output(log, e.output, input_file)
+        if ('Too few characters. Skipping this page' in e.output or
+                'Image too large' in e.output):
+            return OrientationConfidence(0, 0)
+        raise e from e
     else:
         osd = {}
         for line in stdout.splitlines():
@@ -106,9 +110,21 @@ def get_orientation(input_file, language: list, timeout: float, log):
             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, hopefully also Tesseract > 3.04.01
+            # reports "Orientation in degrees" as a clockwise angle
+            assert 'Rotate' in osd
+
         oc = OrientationConfidence(
-            angle=int(osd['Orientation in degrees']),
-            confidence=float(osd['Orientation confidence']))
+            angle=angle,
+            confidence=float(osd.get('Orientation confidence', 0)))
         return oc
 
 
@@ -124,10 +140,24 @@ def tesseract_log_output(log, stdout, input_file):
             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())
         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, pageinfo):
+    with open(output_hocr, 'w', encoding="utf-8") as f:
+        f.write(HOCR_TEMPLATE.format(
+            pageinfo['width_pixels'],
+            pageinfo['height_pixels']))
+
+
 def generate_hocr(input_file, output_hocr, language: list, tessconfig: list,
                   timeout: float, pageinfo_getter, pagesegmode: int, log):
 
@@ -146,26 +176,25 @@ def generate_hocr(input_file, output_hocr, language: list, tessconfig: list,
         badxml,
         'hocr'
     ] + tessconfig)
-    p = Popen(args_tesseract, close_fds=True, stdout=PIPE, stderr=STDOUT,
-              universal_newlines=True)
     try:
-        stdout, _ = p.communicate(timeout=timeout)
+        stdout = check_output(
+            args_tesseract, close_fds=True, stderr=STDOUT,
+            universal_newlines=True, timeout=timeout)
     except TimeoutExpired:
-        p.kill()
-        stdout, _ = p.communicate()
         # 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.
-        with open(output_hocr, 'w', encoding="utf-8") as f:
-            pageinfo = pageinfo_getter()
-            f.write(HOCR_TEMPLATE.format(
-                pageinfo['width_pixels'],
-                pageinfo['height_pixels']))
+        page_timedout(log, input_file)
+        _generate_null_hocr(output_hocr, pageinfo_getter())
+    except CalledProcessError as e:
+        tesseract_log_output(log, e.output, input_file)
+        if 'Image too large' in e.output:
+            _generate_null_hocr(output_hocr, pageinfo_getter())
+            return
+
+        raise e from e
     else:
         tesseract_log_output(log, stdout, input_file)
-        if p.returncode != 0:
-            raise CalledProcessError(p.returncode, args_tesseract)
-
         if os.path.exists(badxml + '.html'):
             # Tesseract 3.02 appends suffix ".html" on its own (.badxml.html)
             shutil.move(badxml + '.html', badxml)
@@ -213,14 +242,19 @@ def generate_pdf(input_image, skip_pdf, output_pdf, language: list,
         os.path.splitext(output_pdf)[0],  # Tesseract appends suffix
         'pdf'
     ] + tessconfig)
-    p = Popen(args_tesseract, close_fds=True, stdout=PIPE, stderr=STDOUT,
-              universal_newlines=True)
 
     try:
-        stdout, _ = p.communicate()
+        stdout = check_output(
+            args_tesseract, close_fds=True, stderr=STDOUT,
+            universal_newlines=True, timeout=timeout)
     except TimeoutExpired:
-        p.kill()
-        log.info("Tesseract - page timed out")
+        page_timedout(log, input_image)
         shutil.copy(skip_pdf, output_pdf)
+    except CalledProcessError as e:
+        tesseract_log_output(log, e.output, input_image)
+        if 'Image too large' in e.output:
+            shutil.copy(skip_pdf, output_pdf)
+            return
+        raise e from e
     else:
         tesseract_log_output(log, stdout, input_image)

ocrmypdf/unpaper.py

@@ -3,7 +3,7 @@
 # unpaper documentation:
 # https://github.com/Flameeyes/unpaper/blob/master/doc/basic-concepts.md
 
-from subprocess import Popen, PIPE
+from subprocess import CalledProcessError, STDOUT, check_output, check_call
 from tempfile import NamedTemporaryFile
 import sys
 import os
@@ -17,10 +17,9 @@ def version():
         get_program('unpaper'),
         '--version'
     ]
-    p_unpaper = Popen(args_unpaper, close_fds=True, universal_newlines=True,
-                      stdout=PIPE, stderr=PIPE)
-    version, _ = p_unpaper.communicate(timeout=5)
-
+    version = check_output(
+        args_unpaper, close_fds=True, universal_newlines=True,
+        stderr=STDOUT, timeout=5)
     return version.strip()
 
 
@@ -68,15 +67,17 @@ def run(input_file, output_file, dpi, log, mode_args):
         os.unlink(output_pnm.name)
 
         args_unpaper.extend([input_pnm.name, output_pnm.name])
-        p_unpaper = Popen(
-            args_unpaper, close_fds=True,
-            universal_newlines=True, stdout=PIPE, stderr=PIPE
-            )
-        out, err = p_unpaper.communicate()
-        log.debug(out)
-        log.debug(err)
-
-        Image.open(output_pnm.name).save(output_file)
+        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)
+            Image.open(output_pnm.name).save(output_file)
 
 
 def deskew(input_file, output_file, dpi, log):

requirements.txt

@@ -1,6 +1,9 @@
+# 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.6.3
-Pillow==3.1.1
+Pillow==3.3.0
 reportlab==3.2.0
-PyPDF2==1.25.1
-img2pdf==0.2
+PyPDF2==1.26
+img2pdf==0.2.1
 cffi==1.5.2

setup.py

@@ -154,23 +154,23 @@ if command.startswith('install') or \
         command in ['check', 'test', 'nosetests', 'easy_install']:
     check_external_program(
         program='tesseract',
-        need_version='3.02.02',
+        need_version='3.03',  # limited by Travis CI / Ubuntu 12.04 backports
         package={'darwin': 'tesseract', 'linux': 'tesseract-ocr'}
     )
     check_external_program(
         program='gs',
-        need_version='9.14',
+        need_version='9.15',  # limited by Travis CI / Ubuntu 12.04 backports
         package='ghostscript'
     )
     check_external_program(
         program='unpaper',
-        need_version='6.1',
+        need_version='6.1',   # latest sane version
         package='unpaper',
         optional=True
     )
     check_external_program(
         program='qpdf',
-        need_version='5.0.0',
+        need_version='5.0.0',   # limited by Travis CI / Ubuntu 12.04 backports
         package='qpdf',
         version_check_args=['--version']
     )
@@ -209,7 +209,6 @@ setup(
         ],
     setup_requires=[
         'setuptools_scm',
-        'setuptools_scm_git_archive',
         'cffi>=1.5.0',
         'pytest-runner'
     ],
@@ -218,12 +217,12 @@ setup(
         'ocrmypdf/lib/compile_leptonica.py:ffi'
     ],
     install_requires=[
-        'ruffus>=2.6.3',
-        'Pillow>=3.0.0',
-        'reportlab>=3.1.44',
-        'PyPDF2>=1.25.1',
-        'img2pdf>=0.2.0',
-        'cffi>=1.5.0'
+        'ruffus==2.6.3',        # pinned - ocrmypdf implements a 2.6.3 workaround
+        'Pillow>=3.1.0',        # Pillow is pretty stable
+        'reportlab>=3.2.0',     # oldest released version with sane image handling
+        'PyPDF2>=1.26',         # pure Python, so track HEAD closely
+        'img2pdf>=0.2.1',       # pure Python, so track HEAD closely
+        'cffi>=1.5.0'           # oldest version ever tested
     ],
     tests_require=tests_require,
     entry_points={
@@ -231,5 +230,6 @@ setup(
             'ocrmypdf = ocrmypdf.main:run_pipeline'
         ],
     },
+    package_data={'ocrmypdf': ['data/sRGB.icc']},
     include_package_data=True,
     zip_safe=False)

share/etc-apt-sources.list

@@ -0,0 +1,4 @@
+deb http://httpredir.debian.org/debian stretch main
+deb http://httpredir.debian.org/debian stretch-updates main
+deb http://security.debian.org stretch/updates main
+deb http://ftp.de.debian.org/debian sid main contrib non-free

tests/resources/README.rst

@@ -14,13 +14,16 @@ In some cases they were converted from one image format to another without other
 +=====================+================================================================================+
 | c02-22.pdf          | `Project Gutenberg`_, Adventures of Huckleberry Finn, page 22                  |
 +---------------------+--------------------------------------------------------------------------------+
-| congress.jpg        | `US Congressional Records`_                                                    |
+| congress.jpg        | `US Congressional Records`_ (Public Domain)                                    |
 +---------------------+--------------------------------------------------------------------------------+
-| graph.pdf           | `Wikimedia: Pandas text analysis.png`_                                         |
+| graph.pdf           | `Wikimedia: Pandas text analysis.png`_ (Public Domain)                         |
 +---------------------+--------------------------------------------------------------------------------+
-| LinnSequencer.jpg   | `Wikimedia: LinnSequencer`_ (Creative Commons Attribution-ShareAlike 3.0)      |
+| lichtenstein.pdf    | `Wikimedia: JPEG2000 Lichtenstein`_ (Creative Commons BY-SA 3.0)               |
 +---------------------+--------------------------------------------------------------------------------+
-
+| LinnSequencer.jpg,  | `Wikimedia: LinnSequencer`_ (Creative Commons Attribution-ShareAlike 3.0)      |
+| linn.pdf, linn.txt  |                                                                                |
++---------------------+--------------------------------------------------------------------------------+
+ 
 
 Files generated for this project
 ================================
@@ -28,10 +31,12 @@ Files generated for this project
 The following test resources were crafted specifically for this project, and can be used
 under the terms of the license in LICENSE.rst.
 
+- aspect.pdf (a page with an image with 200 x 100 DPI resolution)
 - blank.pdf (a blank PDF page)
 - cmyk.pdf (a CMYK image created in Photoshop)
 - enormous.pdf (a very lage page)
 - francais.pdf (a page containing French accented characters)
+- hugemono.pdf (large monochrome JBIG2 page with pixel dimensions of 35000x35000)
 - invalid.pdf (a PDF file header followed by EOF marker)
 - missing_docinfo.pdf (PDF file with no /DocumentInfo section)
 
@@ -43,12 +48,13 @@ These test resources are assemblies from other previously mentioned files, relea
 
 - cardinal.pdf (four cardinal directions, rotated copies of LinnSequencer.jpg)
 - ccitt.pdf (LinnSequencer.jpg, converted to CCITT encoding)
+- encrypted_algo4.pdf (congress.jpg, encrypted with algorithm 4 - not supported by PyPDF2)
 - graph_ocred.pdf (from graph.pdf)
 - jbig2.pdf (congress.jpg, converted to JBIG2 encoding)
 - multipage.pdf (from several other files)
 - palette.pdf (congress.jpg, converted to a 256-color palette)
 - skew.pdf (from c02-22.pdf)
-- skew-encrypted.pdf (skew.pdf with encrypted applied)
+- skew-encrypted.pdf (skew.pdf with encryption - access supported by PyPDF2)
 
 
 .. _`Wikimedia: LinnSequencer`: https://upload.wikimedia.org/wikipedia/en/b/b7/LinnSequencer_hardware_MIDI_sequencer_brochure_page_2_300dpi.jpg
@@ -57,4 +63,6 @@ These test resources are assemblies from other previously mentioned files, relea
 
 .. _`US Congressional Records`: http://www.baxleystamps.com/litho/meiji/courts_1871.jpg
 
-.. _`Wikimedia: Pandas text analysis.png`: https://en.wikipedia.org/wiki/File:Pandas_text_analysis.png
+.. _`Wikimedia: Pandas text analysis.png`: https://en.wikipedia.org/wiki/File:Pandas_text_analysis.png
+
+.. _`Wikimedia: JPEG2000 Lichtenstein`: https://en.wikipedia.org/wiki/JPEG_2000#/media/File:Jpeg2000_2-level_wavelet_transform-lichtenstein.png

tests/resources/linn.txt

@@ -0,0 +1,123 @@
+The LinnSequencer
+32 Track MIDI Sequence Recorder
+
+The LinnSequencer is a state—of—the-art composition and performance tool for the professional musician. It is
+
+extremely powerful, yet amazingly simple to learn and use. It’s many remarkable features include:
+
+0 Operation is similar to multi-track tape recorder with PLAY, STOP, RECORD, FAST
+FORWARD, REWIND, and LOCATE controls.
+
+0 Each of the 100 sequences contains 32 simultaneous, polyphonic tracks. Each track may
+be assigned to one of 16 MIDI channels. Simultaneously plays up to 16 polyphonic
+
+synthesizers !
+
+0 Ultra-fast 3 1/2 ” disk drive stores complex songs in seconds and holds over 110,000 notes
+
+per disk!
+
+0 One or all tracks may be TRANSPOSED at the touch of a key.
+0 Exclusive real—time ERASE function makes editing FAST.
+0 Exclusive REPEAT function automatically repeats any held notes at a pre-selected
+
+rhythmic value.
+
+0 TIMING CORRECTION works during playback and operates without ‘chopping’ notes.
+
+0 Optional SMPTE time code synchronization.
+
+0 Optional remote control.
+
+Recording a Sequence
+
+To record a sequence, simply press RECORD and PLAY,
+then play your MIDI keyboard in time to the Sequencer’s
+click track. When the sequence loops back around to bar 1,
+you’ll hear what you played—only all timing errors will be
+
+corrected! (Timing correction may be adjusted 0r defeated).
+
+Any additional notes played will be added into the track
+—existing notes are not erased while recording!
+
+FAST FORWARD, REWIND, and LOCATE controls
+may be used at any time to quickly access any location in
+your sequence for spot-recording. To overdub a new part,
+select a different track and start recording—while you
+record, the first‘track will play in perfect sync (unless you
+MUTE it, or SOLO another track). In this way, up to 32
+tracks may be overdubbed! All MIDI effects are recorded
+including pitch bend, modulation, velocity, aftertouch,
+sustain pedal, and program changes!
+
+Editing
+
+To erase a wrong note, simply hold ERASE and press
+the note to be erased just before it plays in the sequence-—
+when played back, it will be gone. Notes may also be
+
+added, erased, or changed using the SINGLE STEP func-
+tion. To overdub notes at specific points within a sequence,
+
+Additional Features
+
+simply use LOCATE, FAST FORWARD, or REWIND to
+find the desired bar number, then start recording.
+
+The INSERT/ COPY function allows you to move bars
+from one location to another—in the same sequence or a
+different one. For example, you might insert a copy of the
+first verse between the second chorus and the bridge.
+DELETE BARS operates the same way to remove
+unwanted sections.
+
+Creating a Song
+
+One way to create a song is to record each track all the
+way through (up to 999 bars). Another way is to record
+each basic section (verse, chorus, etc.) in individual
+sequences, then use the CREATE SONG function to “chain”
+them together. CREATE SONG will then automatically
+copy all the parts into a new sequence. If desired, you can
+even set the last few bars to repeat infinitely, for a fadeout.
+
+Composition Without Compromise
+
+The technology you use should never be so complex that
+it interferes with the creative process. That’s precisely why
+the LinnSequencer is designed to let you compose, record
+and edit while devoting your undivided attention to your
+music. See your Linn dealer today for a demonstration!
+
+0 Simple, easy to learn operation—the 32 character LCD display clearly guides you through all operations. If needed, the
+
+HELP button displays additional explanations.
+
+0 Non-destructive recording—existing notes are not erased while recording.
+0 Two FOOTSWIT CH INPUTS may be assigned to remotely control many of the commonly used functions, including
+
+ERASE, REPEAT, PLAY/ STOP, or LOCATE.
+
+0 Two TRIGGER OUTPUTS may be programmed to output pulses at any selected note value.
+
+0 Will sync to standard LinnDrum or Linn 9000 sync tone.
+
+0 Utilizes ultra high—speed, 8 MHZ 80186 16 bit computer internally for FAST operation.
+0 TEMPO may be specified in BEATS-PER—MINUTE or FRAMES-PER—BEAT at 24, 25, or 30 frames per second,
+
+(even drop frame!)
+
+0 TEMPO may be entered numerically, adjustable in tenths of a Beat-Per-Minute increments, or by tapping quarter notes
+
+on the TAP TEMPO button.
+
+0 TEMPO CHANGES may be programmed into a sequence, with smooth transitions if desired.
+0 Any TIME SIGNATURE may be used, and may be changed within a song.
+
+EDI]
+Linn Electronics, Inc.
+
+18720 Oxnard Street, Tarzana, CA 91356
+(818) 708-8131 TELEX #298949 LINN UR
+

tests/spoof/tesseract_big_image_error.py

@@ -0,0 +1,50 @@
+#!/usr/bin/env python3
+import sys
+
+
+VERSION_STRING = '''tesseract 3.04.00
+ leptonica-1.72
+  libjpeg 8d : libpng 1.6.19 : libtiff 4.0.6 : zlib 1.2.5
+SPOOFED: return error claiming image too big
+'''
+
+"""Simulates a Tesseract crash
+
+It isn't strictly necessary to crash the process and that has unwanted
+side effects like triggering core dumps or error reporting, logging and such.
+It's enough to dump some text to stderr and return an error code.
+
+Follows the POSIX? convention of returning 128 + signal number.
+
+"""
+
+
+def main():
+    if sys.argv[1] == '--version':
+        print(VERSION_STRING, file=sys.stderr)
+        sys.exit(0)
+    elif sys.argv[1] == '--list-langs':
+        print('List of available languages (1):\neng', file=sys.stderr)
+        sys.exit(0)
+    elif sys.argv[-1] == 'hocr':
+        print("Image too large: (33830, 14959)\n"
+              "Error during processing.", file=sys.stderr)
+        sys.exit(1)
+    elif sys.argv[-1] == 'pdf':
+        print("Image too large: (33830, 14959)\n"
+              "Error during processing.", file=sys.stderr)
+        sys.exit(1)
+    elif sys.argv[-1] == 'stdout':
+        print("Image too large: (33830, 14959)\n"
+              "Error during processing.", file=sys.stderr)
+        sys.exit(1)
+    else:
+        print("Spoof doesn't understand arguments", file=sys.stderr)
+        print(sys.argv, file=sys.stderr)
+        sys.exit(1)
+
+    sys.exit(0)
+
+
+if __name__ == '__main__':
+    main()

tests/spoof/tesseract_cache.py

@@ -90,6 +90,13 @@ def main():
             universal_newlines=True)
     stdout, stderr = p.communicate()
 
+    if p.returncode != 0:
+        # Do not cache errors or crashes
+        print("Tesseract error", file=sys.stderr)
+        print(stdout, end='')
+        print(stderr, end='', file=sys.stderr)
+        return p.returncode
+
     with open(cache_name + '.stdout', 'w') as f:
         f.write(stdout)
     with open(cache_name + '.stderr', 'w') as f:

tests/spoof/tesseract_crash.py

@@ -0,0 +1,50 @@
+#!/usr/bin/env python3
+import sys
+import os
+import signal
+
+
+VERSION_STRING = '''tesseract 3.04.00
+ leptonica-1.72
+  libjpeg 8d : libpng 1.6.19 : libtiff 4.0.6 : zlib 1.2.5
+SPOOFED: CRASH ON OCR or -psm 0
+'''
+
+"""Simulates a Tesseract crash
+
+It isn't strictly necessary to crash the process and that has unwanted
+side effects like triggering core dumps or error reporting, logging and such.
+It's enough to dump some text to stderr and return an error code.
+
+Follows the POSIX? convention of returning 128 + signal number.
+
+"""
+
+
+def main():
+    if sys.argv[1] == '--version':
+        print(VERSION_STRING, file=sys.stderr)
+        sys.exit(0)
+    elif sys.argv[1] == '--list-langs':
+        print('List of available languages (1):\neng', file=sys.stderr)
+        sys.exit(0)
+    elif sys.argv[-1] == 'hocr':
+        print("KABOOM! Tesseract failed for some reason", file=sys.stderr)
+        sys.exit(128 + signal.SIGSEGV)
+    elif sys.argv[-1] == 'pdf':
+        print("KABOOM! Tesseract failed for some reason", file=sys.stderr)
+        sys.exit(128 + signal.SIGSEGV)
+    elif sys.argv[-1] == 'stdout':
+        print("libc++abi.dylib: terminating with uncaught exception of type "
+              "std::bad_alloc: std::bad_alloc", file=sys.stderr)
+        sys.exit(128 + signal.SIGABRT)
+    else:
+        print("Spoof doesn't understand arguments", file=sys.stderr)
+        print(sys.argv, file=sys.stderr)
+        sys.exit(1)
+
+    sys.exit(0)
+
+
+if __name__ == '__main__':
+    main()

tests/spoof/unpaper_oldversion.py

@@ -0,0 +1,14 @@
+#!/usr/bin/env python3
+import sys
+
+def main():
+    if sys.argv[1] == '--version':
+        print('0.5')
+        sys.exit(0)
+
+    print("Only supports --version")
+    sys.exit(1)
+
+
+if __name__ == '__main__':
+    main()

tests/test_main.py

@@ -12,6 +12,7 @@ from ocrmypdf.pageinfo import pdf_get_all_pageinfo
 import PyPDF2 as pypdf
 from ocrmypdf import ExitCode
 from ocrmypdf import leptonica
+from ocrmypdf.pdfa import file_claims_pdfa
 
 
 if sys.version_info.major < 3:
@@ -28,6 +29,11 @@ TEST_OUTPUT = os.environ.get(
     default=os.path.join(PROJECT_ROOT, 'tests', 'output', 'main'))
 
 
+def running_in_docker():
+    # Docker creates a file named /.dockerinit
+    return os.path.exists('/.dockerinit')
+
+
 def setup_module():
     with suppress(FileNotFoundError):
         shutil.rmtree(TEST_OUTPUT)
@@ -83,22 +89,41 @@ def run_ocrmypdf_env(input_basename, output_basename, *args, env=None):
     return p, out, err
 
 
+def spoof(replace_program, with_spoof):
+    """Modify environment variables to override subprocess executables
+
+    Before running any executable, ocrmypdf checks the environment variable
+    OCRMYPDF_PROGRAMNAME to override default program name/location, e.g.
+    OCRMYPDF_GS redirects from the system path Ghostscript ("gs") to elsewhere.
+    """
+    env = os.environ.copy()
+    spoofer = os.path.join(SPOOF_PATH, with_spoof)
+    if not os.access(spoofer, os.X_OK):
+        os.chmod(spoofer, 0o755)
+    env['OCRMYPDF_' + replace_program.upper()] = spoofer
+    return env
+
+
 @pytest.fixture
 def spoof_tesseract_noop():
-    env = os.environ.copy()
-    program = os.path.join(SPOOF_PATH, 'tesseract_noop.py')
-    check_call(['chmod', "+x", program])
-    env['OCRMYPDF_TESSERACT'] = program
-    return env
+    return spoof('tesseract', 'tesseract_noop.py')
 
 
 @pytest.fixture
 def spoof_tesseract_cache():
-    env = os.environ.copy()
-    program = os.path.join(SPOOF_PATH, "tesseract_cache.py")
-    check_call(['chmod', '+x', program])
-    env['OCRMYPDF_TESSERACT'] = program
-    return env
+    if running_in_docker():
+        return os.environ.copy()
+    return spoof('tesseract', "tesseract_cache.py")
+
+
+@pytest.fixture
+def spoof_tesseract_crash():
+    return spoof('tesseract', 'tesseract_crash.py')
+
+
+@pytest.fixture
+def spoof_tesseract_big_image_error():
+    return spoof('tesseract', 'tesseract_big_image_error.py')
 
 
 def test_quick(spoof_tesseract_noop):
@@ -135,32 +160,34 @@ def test_deskew(spoof_tesseract_noop):
 
 
 def test_clean(spoof_tesseract_noop):
-    check_ocrmypdf('skew.pdf', 'test_clean.pdf', '-c', env=spoof_tesseract_noop)
+    check_ocrmypdf('skew.pdf', 'test_clean.pdf', '-c',
+                   env=spoof_tesseract_noop)
 
 
-@pytest.mark.parametrize("pdf,renderer", [
-    ('palette.pdf', 'hocr'),
-    ('palette.pdf', 'tesseract'),
-    ('cmyk.pdf', 'hocr'),
-    ('cmyk.pdf', 'tesseract'),
-    ('ccitt.pdf', 'hocr'),
-    ('ccitt.pdf', 'tesseract'),
-    ('jbig2.pdf', 'hocr'),
-    ('jbig2.pdf', 'tesseract')
-])
-def test_exotic_image(spoof_tesseract_cache, pdf, renderer):
+# This will run 5 * 2 * 2 = 20 test cases
+@pytest.mark.parametrize(
+    "pdf",
+    ['palette.pdf', 'cmyk.pdf', 'ccitt.pdf', 'jbig2.pdf', 'lichtenstein.pdf'])
+@pytest.mark.parametrize("renderer", ['hocr', 'tesseract'])
+@pytest.mark.parametrize("output_type", ['pdf', 'pdfa'])
+def test_exotic_image(spoof_tesseract_cache, pdf, renderer, output_type):
     check_ocrmypdf(
         pdf,
         'test_{0}_{1}.pdf'.format(pdf, renderer),
         '-dc',
         '-v', '1',
+        '--output-type', output_type,
         '--pdf-renderer', renderer, env=spoof_tesseract_cache)
 
 
-def test_preserve_metadata(spoof_tesseract_noop):
+@pytest.mark.parametrize("output_type", [
+    'pdfa', 'pdf'
+    ])
+def test_preserve_metadata(spoof_tesseract_noop, output_type):
     pdf_before = pypdf.PdfFileReader(_infile('graph.pdf'))
 
     output = check_ocrmypdf('graph.pdf', 'test_metadata_preserve.pdf',
+                            '--output-type', output_type,
                             env=spoof_tesseract_noop)
 
     pdf_after = pypdf.PdfFileReader(output)
@@ -168,8 +195,14 @@ def test_preserve_metadata(spoof_tesseract_noop):
     for key in ('/Title', '/Author'):
         assert pdf_before.documentInfo[key] == pdf_after.documentInfo[key]
 
+    pdfa_info = file_claims_pdfa(output)
+    assert pdfa_info['output'] == output_type
 
-def test_override_metadata(spoof_tesseract_noop):
+
+@pytest.mark.parametrize("output_type", [
+    'pdfa', 'pdf'
+    ])
+def test_override_metadata(spoof_tesseract_noop, output_type):
     input_file = _infile('c02-22.pdf')
     output_file = _outfile('test_override_metadata.pdf')
 
@@ -182,6 +215,7 @@ def test_override_metadata(spoof_tesseract_noop):
         '--title', german,
         '--author', chinese,
         '--subject', high_unicode,
+        '--output-type', output_type,
         env=spoof_tesseract_noop)
 
     assert p.returncode == ExitCode.ok
@@ -200,6 +234,9 @@ def test_override_metadata(spoof_tesseract_noop):
     assert pdfinfo['Subject'] == high_unicode
     assert pdfinfo.get('Keywords', '') == ''
 
+    pdfa_info = file_claims_pdfa(output_file)
+    assert pdfa_info['output'] == output_type
+
 
 @pytest.mark.parametrize('renderer', [
     'hocr',
@@ -285,6 +322,13 @@ def test_monochrome_correlation():
         test_pageno=3,  # south facing page
         )
     assert corr < 0.10
+    corr = check_monochrome_correlation(
+        reference_pdf=_infile('cardinal.pdf'),
+        reference_pageno=2,
+        test_pdf=_infile('cardinal.pdf'),
+        test_pageno=2,
+        )
+    assert corr > 0.90
 
 
 @pytest.mark.parametrize('renderer', [
@@ -292,11 +336,6 @@ def test_monochrome_correlation():
     'tesseract',
     ])
 def test_autorotate(spoof_tesseract_cache, renderer):
-    import ocrmypdf.ghostscript as ghostscript
-    import logging
-
-    gslog = logging.getLogger()
-
     # cardinal.pdf contains four copies of an image rotated in each cardinal
     # direction - these ones are "burned in" not tagged with /Rotate
     out = check_ocrmypdf('cardinal.pdf', 'test_autorotate_%s.pdf' % renderer,
@@ -310,6 +349,36 @@ def test_autorotate(spoof_tesseract_cache, renderer):
         assert correlation > 0.80
 
 
+def test_autorotate_threshold_low(spoof_tesseract_cache):
+    out = check_ocrmypdf('cardinal.pdf', 'test_autorotate_threshold_low.pdf',
+                         '--rotate-pages-threshold', '1',
+                         '-r', '-v', '1', env=spoof_tesseract_cache)
+
+    # Low threshold -> always rotate -> expect high correlation between
+    # reference page and test page
+    correlation = check_monochrome_correlation(
+        reference_pdf=_infile('cardinal.pdf'),
+        reference_pageno=1,
+        test_pdf=out,
+        test_pageno=3)
+    assert correlation > 0.80
+
+
+def test_autorotate_threshold_high(spoof_tesseract_cache):
+    out = check_ocrmypdf('cardinal.pdf', 'test_autorotate_threshold_high.pdf',
+                         '--rotate-pages-threshold', '99',
+                         '-r', '-v', '1', env=spoof_tesseract_cache)
+
+    # High threshold -> never rotate -> expect low correlation since
+    # test page will not be rotated
+    correlation = check_monochrome_correlation(
+        reference_pdf=_infile('cardinal.pdf'),
+        reference_pageno=1,
+        test_pdf=out,
+        test_pageno=3)
+    assert correlation < 0.10
+
+
 @pytest.mark.parametrize('renderer', [
     'hocr',
     'tesseract',
@@ -328,16 +397,15 @@ def test_skip_big(spoof_tesseract_cache):
     assert not pdfinfo[0]['has_text']
 
 
-@pytest.mark.parametrize('renderer', [
-    'hocr',
-    'tesseract',
-    ])
-def test_maximum_options(spoof_tesseract_cache, renderer):
+@pytest.mark.parametrize('renderer', ['hocr', 'tesseract'])
+@pytest.mark.parametrize('output_type', ['pdf', 'pdfa'])
+def test_maximum_options(spoof_tesseract_cache, renderer, output_type):
     check_ocrmypdf(
         'multipage.pdf', 'test_multipage%s.pdf' % renderer,
         '-d', '-c', '-i', '-g', '-f', '-k', '--oversample', '300',
         '--skip-big', '10', '--title', 'Too Many Weird Files',
         '--author', 'py.test', '--pdf-renderer', renderer,
+        '--output-type', output_type,
         env=spoof_tesseract_cache)
 
 
@@ -362,6 +430,17 @@ def test_blank_input_pdf():
     assert p.returncode == ExitCode.ok
 
 
+def test_force_ocr_on_pdf_with_no_images(spoof_tesseract_crash):
+    # As a correctness test, make sure that --force-ocr on a PDF with no
+    # content still triggers tesseract. If tesseract crashes, then it was
+    # called.
+    p, _, err = run_ocrmypdf_env(
+        'blank.pdf', 'wont_be_created.pdf', '--force-ocr',
+        env=spoof_tesseract_crash)
+    assert p.returncode == ExitCode.child_process_error, err
+    assert not os.path.exists(_outfile('wontwork.pdf'))
+
+
 def test_french(spoof_tesseract_cache):
     p, out, err = run_ocrmypdf_env(
         'francais.pdf', 'francais.pdf', '-l', 'fra', env=spoof_tesseract_cache)
@@ -382,6 +461,8 @@ def test_missing_docinfo(spoof_tesseract_noop):
     assert p.returncode == ExitCode.ok, err
 
 
+@pytest.mark.skipif(running_in_docker(),
+                    reason="writes to tests/resources")
 def test_uppercase_extension(spoof_tesseract_noop):
     shutil.copy(_infile("skew.pdf"), _infile("UPPERCASE.PDF"))
     try:
@@ -438,4 +519,81 @@ def test_pagesegmode(renderer, spoof_tesseract_cache):
         '--pdf-renderer', renderer, env=spoof_tesseract_cache)
 
 
+@pytest.mark.parametrize('renderer', [
+    'hocr',
+    'tesseract',
+    ])
+def test_tesseract_crash(renderer, spoof_tesseract_crash):
+    sh, out, err = run_ocrmypdf_env(
+        'ccitt.pdf', 'wontwork.pdf', '-v', '1',
+        '--pdf-renderer', renderer, env=spoof_tesseract_crash)
+    assert sh.returncode == ExitCode.child_process_error
+    assert not os.path.exists(_outfile('wontwork.pdf'))
+    assert "ERROR" in err
 
+
+def test_tesseract_crash_autorotate(spoof_tesseract_crash):
+    sh, out, err = run_ocrmypdf_env(
+        'ccitt.pdf', 'wontwork.pdf',
+        '-r', env=spoof_tesseract_crash)
+    assert sh.returncode == ExitCode.child_process_error
+    assert not os.path.exists(_outfile('wontwork.pdf'))
+    assert "ERROR" in err
+    print(out)
+    print(err)
+
+
+@pytest.mark.parametrize('renderer', [
+    'hocr',
+    'tesseract',
+    ])
+def test_tesseract_image_too_big(renderer, spoof_tesseract_big_image_error):
+    check_ocrmypdf(
+        'hugemono.pdf', 'hugemono_%s.pdf' % renderer, '-r',
+        '--pdf-renderer', renderer, env=spoof_tesseract_big_image_error)
+
+
+def test_no_unpaper():
+    env = os.environ.copy()
+    env['OCRMYPDF_UNPAPER'] = os.path.abspath('./spoof/no_unpaper_here.py')
+    sh, out, err = run_ocrmypdf_env(
+        'c02-22.pdf', 'wont_be_created.pdf', '--clean', env=env)
+    assert sh.returncode == ExitCode.missing_dependency
+
+
+def test_old_unpaper():
+    env = os.environ.copy()
+    env['OCRMYPDF_UNPAPER'] = os.path.abspath('./spoof/unpaper_oldversion.py')
+    sh, out, err = run_ocrmypdf_env(
+        'c02-22.pdf', 'wont_be_created.pdf', '--clean', env=env)
+    assert sh.returncode == ExitCode.missing_dependency
+
+
+def test_algo4():
+    sh, _, _ = run_ocrmypdf_env('encrypted_algo4.pdf', 'wontwork.pdf')
+    assert sh.returncode == ExitCode.encrypted_pdf
+
+
+@pytest.mark.parametrize('renderer', [
+    'hocr'])  # tesseract cannot pass this test yet
+def test_non_square_resolution(renderer, spoof_tesseract_cache):
+    # Confirm input image is non-square resolution
+    in_pageinfo = pdf_get_all_pageinfo(_infile('aspect.pdf'))
+    assert in_pageinfo[0]['xres'] != in_pageinfo[0]['yres']
+
+    out = 'aspect_%s.pdf' % renderer
+    check_ocrmypdf(
+        'aspect.pdf', out,
+        '--pdf-renderer', renderer, env=spoof_tesseract_cache)
+
+    out_pageinfo = pdf_get_all_pageinfo(_outfile(out))
+
+    # Confirm resolution was kept the same
+    assert in_pageinfo[0]['xres'] == out_pageinfo[0]['xres']
+    assert in_pageinfo[0]['yres'] == out_pageinfo[0]['yres']
+
+
+def test_image_to_pdf(spoof_tesseract_noop):
+    check_ocrmypdf(
+        'LinnSequencer.jpg', 'image_to_pdf.pdf', '--image-dpi', '200',
+        env=spoof_tesseract_noop)

tests/test_pageinfo.py

@@ -103,8 +103,8 @@ def test_single_page_image():
     assert pdfimage['bpc'] == 8
 
     # DPI in a 1"x1" is the image width
-    assert pdfimage['dpi_w'] == 8
-    assert pdfimage['dpi_h'] == 8
+    assert abs(pdfimage['dpi_w'] - 8) < 1e-5
+    assert abs(pdfimage['dpi_h'] - 8) < 1e-5
 
 
 def test_single_page_inline_image():
@@ -120,8 +120,12 @@ def test_single_page_inline_image():
         pdf.showPage()
         pdf.save()
 
-    with pytest.raises(NotImplementedError):
-        pageinfo.pdf_get_all_pageinfo(filename)
+    pdfinfo = pageinfo.pdf_get_all_pageinfo(filename)
+    print(pdfinfo)
+    pdfimage = pdfinfo[0]['images'][0]
+    assert (pdfimage['dpi_w'] - 8) < 1e-5
+    assert pdfimage['color'] != '-'
+    assert pdfimage['width'] == 8
 
 
 def test_jpeg():
@@ -131,4 +135,5 @@ def test_jpeg():
 
     pdfimage = pdfinfo[0]['images'][0]
     assert pdfimage['enc'] == 'jpeg'
+    assert (pdfimage['dpi_w'] - 150) < 1e-5