Release notes updated for v1.1-stable

.dockerignore

@@ -1,21 +0,0 @@
-bin/
-build/
-dist/
-include/
-lib/
-ocrmypdf.egg-info/
-staging/
-.git/
-.ruffus_history.sqlite
-MANIFEST.in
-*.sublime*
-*.pdf
-*.rst
-*.pyc
-*/*.pyc
-*/*/*.pyc
-*/*/*/*.pyc
-*/*/*/*/*.pyc
-*/*/*/*/*/*.pyc
-*/*/*/*/*/*/*.pyc
-*/*/*/*/*/*/*/*.pyc

.gitignore

@@ -1,23 +1,2 @@
 tmp/
-log/
-*.pyc
-tests/output/
-.ruffus_history.sqlite
-*.sublime-*
-/*.pdf
-build/
-dist/
-*.egg-info/
-venv/
-venv-3.4/
-venv-3.5/
-*/test/output
-bin/
-include/
-lib/
-pip-selfcheck.json
-pyvenv.cfg
-htmlcov/
-.coverage
-.cache/
-.ipynb_checkpoints/
+log/

.travis.yml

@@ -1,41 +0,0 @@
-language: python
-
-cache:
-    directories:
-        - $HOME/.cache/pip
-        - $HOME/.ccache
-        - tarballs
-
-python:
-    - 3.4
-
-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 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 
-
-    # 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
-
-install:
-    - pip install -r requirements.txt
-    - pip install -r test_requirements.txt
-
-script:
-    - python setup.py clean
-    - python setup.py install
-    - py.test
-
-os:
-    - linux

COPYRIGHT.md

@@ -0,0 +1,17 @@
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

Dockerfile

@@ -1,88 +0,0 @@
-# OCRmyPDF
-#
-# VERSION               3.0.0
-FROM      debian:stretch
-MAINTAINER James R. Barlow <jim@purplerock.ca>
-
-# Add unprivileged user
-RUN useradd docker \
-  && mkdir /home/docker \
-  && chown docker:docker /home/docker
-
-# Update system and install our dependencies
-RUN apt-get update && apt-get install -y --no-install-recommends \
-  locales \
-  ghostscript \
-  tesseract-ocr \
-  tesseract-ocr-deu tesseract-ocr-spa tesseract-ocr-eng tesseract-ocr-fra \
-  qpdf \
-  poppler-utils \
-  python3 \
-  python3-pip \
-  python3-venv \
-  python3-reportlab \
-  python3-pil
-
-# Enforce UTF-8
-# Borrowed from https://index.docker.io/u/crosbymichael/python/ 
-RUN dpkg-reconfigure locales && \
-  locale-gen C.UTF-8 && \
-  /usr/sbin/update-locale LANG=C.UTF-8
-ENV LC_ALL C.UTF-8
-
-# Build unpaper 6.1
-RUN apt-get install -y \
-  wget \
-  gcc \
-  libavformat-dev \
-  libavcodec-dev \
-  libavutil-dev \
-  autoconf \
-  automake \
-  make \
-  pkg-config \
-  xsltproc
-
-WORKDIR /root
-RUN wget -q https://github.com/Flameeyes/unpaper/archive/unpaper-6.1.tar.gz
-RUN tar xf unpaper-6.1.tar.gz
-WORKDIR /root/unpaper-unpaper-6.1
-RUN autoreconf -i
-RUN ./configure CFLAGS="-O2 -march=native -pipe -flto"
-RUN make -j install
-WORKDIR /
-
-RUN apt-get remove -y \
-  gcc \
-  autoconf \
-  automake \
-  pkg-config \
-  xsltproc \
-  make
-RUN apt-get autoremove -y && apt-get clean -y
-RUN rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* /root/*
-
-# Set up a Python virtualenv and take all of the system packages, so we can
-# rely on the platform packages rather than importing GCC and compiling them
-RUN pyvenv /appenv \
-  && pyvenv --system-site-packages /appenv
-
-COPY . /application/
-
-# Install application and dependencies
-# In this arrangement Pillow and reportlab will be provided by the system
-RUN . /appenv/bin/activate; \
-  pip install --upgrade pip \
-  && pip install --no-cache-dir /application \
-  && pip install --no-cache-dir -r /application/test_requirements.txt
-
-USER docker
-WORKDIR /home/docker
-
-ENV DEFAULT_RUFFUS_HISTORY_FILE=/tmp/.{basename}.ruffus_history.sqlite
-ENV OCRMYPDF_TEST_OUTPUT=/tmp/test-output
-ENV OCRMYPDF_IN_DOCKER=1
-
-# Must use array form of ENTRYPOINT
-# Non-array form does not append other arguments, because that is "intuitive"
-ENTRYPOINT ["/application/docker-wrapper.sh"]

LICENSE.rst

@@ -1,20 +0,0 @@
-Copyright (c) 2013-2015, The OCRmyPDF Authors
-
-Permission is hereby granted, free of charge, to any person obtaining a
-copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be included
-in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
-OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

MANIFEST.in

@@ -1,3 +0,0 @@
-recursive-exclude tests/output *
-include requirements.txt
-include test_requirements.txt

OCRmyPDF.sh

@@ -1,6 +1,363 @@
 #!/bin/sh
 ##############################################################################
-# Copyright (c) 2013-14: fritz-hh from Github (https://github.com/fritz-hh)
+# Copyright (c) 2013: fritz-hh from Github (https://github.com/fritz-hh)
 ##############################################################################
 
-python3 -m ocrmypdf.main "$@"
+TOOLNAME="OCRmyPDF"
+VERSION="v1.1-stable"
+
+START=`date +%s`
+
+usage() {
+	cat << EOF
+--------------------------------------------------------------------------------------
+Script aimed at generating a searchable PDF file from a PDF file containing only images.
+(The script performs optical character recognition of each respective page using the
+tesseract engine)
+
+Copyright: fritz from NAS4Free forum
+Version: $VERSION
+
+Usage: OCRmyPDF.sh  [-h] [-v] [-g] [-k] [-d] [-c] [-i] [-l language] [-C filename] inputfile outputfile
+
+-h : Display this help message
+-v : Increase the verbosity (this option can be used more than once)
+-k : Do not delete the temporary files
+-g : Activate debug mode:
+     - Generates a PDF file containing each page twice (once with the image, once without the image
+       but with the OCRed text as well as the detected bounding boxes)
+     - Set the verbosity to the highest possible
+     - Do not delete the temporary files
+-d : Deskew each page before performing OCR
+-c : Clean each page before performing OCR
+-i : Incorporate the cleaned image in the final PDF file (by default the original image	
+     image, or the deskewed image if the -d option is set, is incorporated)
+-l : Set the language of the PDF file in order to improve OCR results (default "eng")
+     Any language supported by tesseract is supported.
+-C : Pass an additional configuration file to the tesseract OCR engine.
+     (this option can be used more than once)
+     Note: The configuration file must be available in the "tessdata/configs" folder
+     of your tesseract installation
+inputfile  : PDF file to be OCRed
+outputfile : The PDF/A file to be generated 
+--------------------------------------------------------------------------------------
+EOF
+}
+
+
+#################################################
+# Get an absolute path from a relative path to a file
+#
+# Param1 : Relative path
+# Returns: 1 if the folder in which the file is located does not exist
+#          0 otherwise
+################################################# 
+absolutePath() {
+	local wdsave absolutepath 
+	wdsave="$(pwd)"
+	! cd "$(dirname "$1")" 1> /dev/null 2> /dev/null && return 1
+	absolutepath="$(pwd)/$(basename "$1")"
+	cd "$wdsave"
+	echo "$absolutepath"
+	return 0
+}
+
+
+
+# Initialization of constants
+EXIT_BAD_ARGS="1"		# possible exit codes
+EXIT_BAD_INPUT_FILE="2"
+EXIT_MISSING_DEPENDENCY="3"
+EXIT_INVALID_OUPUT_PDFA="4"
+EXIT_OTHER_ERROR="5"
+LOG_ERR="0"			# 0=only error messages
+LOG_INFO="1"			# 1=error messages and some infos
+LOG_DEBUG="2"			# 2=debug level logging
+SRC="./src"				# location of the source folder (except source of external tools like jhove)
+JHOVE="./jhove/bin/JhoveApp.jar"	# java SW for validating the final PDF/A
+JHOVE_CFG="./jhove/conf/jhove.conf"	# location of the jhove config file
+
+# Initialization the configuration parameters with default values
+VERBOSITY="$LOG_ERR"		# default verbosity level
+LAN="eng"			# default language of the PDF file (required to get good OCR results)
+KEEP_TMP="0"			# do not delete the temporary files (default)
+PREPROCESS_DESKEW="0"		# 0=no, 1=yes (deskew image)
+PREPROCESS_CLEAN="0"		# 0=no, 1=yes (clean image to improve OCR)
+PREPROCESS_CLEANTOPDF="0"	# 0=no, 1=yes (put cleaned image in final PDF)
+PDF_NOIMG="0"			# 0=no, 1=yes (generates each PDF page twice, with and without image)
+TESS_CFG_FILES=""		# list of additional configuration files to be used by tesseract
+
+# Parse optional command line arguments
+while getopts ":hvgkdcil:C:" opt; do
+	case $opt in
+		h) usage ; exit 0 ;;
+		v) VERBOSITY=$(($VERBOSITY+1)) ;;
+		k) KEEP_TMP="1" ;;
+		g) PDF_NOIMG="1"; VERBOSITY="10"; KEEP_TMP="1" ;;
+		d) PREPROCESS_DESKEW="1" ;;
+		c) PREPROCESS_CLEAN="1" ;;
+		i) PREPROCESS_CLEANTOPDF="1" ;;
+		l) LAN="$OPTARG" ;;
+		C) TESS_CFG_FILES="$OPTARG $TESS_CFG_FILES" ;;
+		\?)
+			echo "Invalid option: -$OPTARG" >&2
+			usage
+			exit $EXIT_BAD_ARGS ;;
+		:)
+			echo "Option -$OPTARG requires an argument" >&2
+			usage
+			exit $EXIT_BAD_ARGS ;;
+	esac
+done
+
+# Remove the optional arguments parsed above.
+shift $((OPTIND-1))
+
+# Check if the number of mandatory parameters
+# provided is as expected
+if [ "$#" -ne "2" ]; then
+	echo "Exactly two mandatory argument shall be provided ($# arguments provided)" >&2
+	usage
+	exit $EXIT_BAD_ARGS
+fi
+
+! absolutePath "$1" > /dev/null && echo "The folder in which the input file should be located does not exist. Exiting..." >&2 && exit $EXIT_BAD_ARGS
+FILE_INPUT_PDF="`absolutePath "$1"`"
+! absolutePath "$2" > /dev/null  && echo "The folder in which the output file should be generated does not exist. Exiting..." >&2 && exit $EXIT_BAD_ARGS
+FILE_OUTPUT_PDFA="`absolutePath "$2"`"
+
+
+
+# set script path as working directory
+cd "`dirname $0`"
+
+[ $VERBOSITY -ge $LOG_INFO ] && echo "$TOOLNAME version: $VERSION"
+
+# check if the required utilities are installed
+[ $VERBOSITY -ge $LOG_DEBUG ] && echo "Checking if all dependencies are installed"
+! command -v identify > /dev/null && echo "Please install ImageMagick. Exiting..." >&2 && exit $EXIT_MISSING_DEPENDENCY
+! command -v pdfimages > /dev/null && echo "Please install poppler-utils. Exiting..." >&2 && exit $EXIT_MISSING_DEPENDENCY
+! command -v pdftoppm > /dev/null && echo "Please install poppler-utils. Exiting..." >&2 && exit $EXIT_MISSING_DEPENDENCY
+! command -v pdftk > /dev/null && echo "Please install pdftk. Exiting..." >&2 && exit $EXIT_MISSING_DEPENDENCY
+[ $PREPROCESS_CLEAN -eq 1 ] && ! command -v unpaper > /dev/null && echo "Please install unpaper. Exiting..." >&2 && exit $EXIT_MISSING_DEPENDENCY
+! command -v tesseract > /dev/null && echo "Please install tesseract and tesseract-data. Exiting..." >&2 && exit $EXIT_MISSING_DEPENDENCY
+! command -v python > /dev/null && echo "Please install python, and the python libraries: reportlab, lxml. Exiting..." >&2 && exit $EXIT_MISSING_DEPENDENCY
+! command -v gs > /dev/null && echo "Please install ghostcript. Exiting..." >&2 && exit $EXIT_MISSING_DEPENDENCY
+! command -v java > /dev/null && echo "Please install java. Exiting..." >&2 && exit $EXIT_MISSING_DEPENDENCY
+
+
+
+
+# Initialize path to temporary files
+today=$(date +"%Y%m%d_%H%M")
+fld=$(basename "$FILE_INPUT_PDF" | sed 's/[.][^.]*//')
+TMP_FLD="./tmp/$today.filename.$fld"
+FILE_TMP="$TMP_FLD/tmp.txt"						# temporary file with a very short lifetime (may be used for several things)
+FILE_SIZE_PAGES="$TMP_FLD/page-sizes.txt"				# size in pt of the respective page of the input PDF file
+FILE_OUTPUT_PDF_CAT="${TMP_FLD}/ocred.pdf"				# concatenated OCRed PDF files
+FILE_OUTPUT_PDFA_WO_META="${TMP_FLD}/ocred-pdfa-wo-metadata.pdf"	# PDFA file before appending metadata
+FILE_VALIDATION_LOG="${TMP_FLD}/pdf_validation.log"			# log file containing the results of the validation of the PDF/A file
+
+# Create tmp folder
+[ $VERBOSITY -ge $LOG_DEBUG ] && echo "Creating temporary folder: \"$TMP_FLD\""
+rm -r -f "${TMP_FLD}"
+mkdir -p "${TMP_FLD}"
+
+
+
+
+# get the size of each pdf page (width / height) in pt (inch*72)
+[ $VERBOSITY -ge $LOG_DEBUG ] && echo "Input file: Extracting size of each page (in pt)"
+! identify -format "%w %h\n" "$FILE_INPUT_PDF" > "$FILE_TMP" \
+	&& echo "Could not get size of PDF pages. Exiting..." >&2 && exit $EXIT_BAD_INPUT_FILE
+# removing empty lines (last one should be) and prepend page # before each line
+sed '/^$/d' "$FILE_TMP" | awk '{printf "%04d %s\n", NR, $0}' > "$FILE_SIZE_PAGES"
+numpages=`tail -n 1 "$FILE_SIZE_PAGES" | cut -f1 -d" "`
+
+# Itterate the pages of the input pdf file
+while read pageSize ; do
+
+	page=`echo $pageSize | cut -f1 -d" "`
+	[ $VERBOSITY -ge $LOG_INFO ] && echo "Processing page $page / $numpages"
+	
+	# create the name of the required file
+	curOrigImg="$TMP_FLD/${page}_Image"			# original image available in the current PDF page 
+								# (the image file may have a different orientation than in the pdf file)
+	curHocr="$TMP_FLD/$page.hocr"				# hocr file to be generated by the OCR SW for the current page
+	curOCRedPDF="$TMP_FLD/${page}-ocred.pdf"		# PDF file containing the image + the OCRed text for the current page
+	curOCRedPDFDebug="$TMP_FLD/${page}-debug-ocred.pdf"	# PDF file containing data required to find out if OCR worked correctly
+	
+	# get width / height of PDF page (in pt)
+	widthPDF=`echo $pageSize | cut -f2 -d" "`
+	heightPDF=`echo $pageSize | cut -f3 -d" "`
+	[ $VERBOSITY -ge $LOG_DEBUG ] && echo "Page $page: size ${heightPDF}x${widthPDF} (h*w in pt)"
+	# extract raw image from pdf file to compute resolution
+	# unfortunatelly this image can have another orientation than in the pdf...
+	# so we will have to extract it again later using pdftoppm
+	pdfimages -f $page -l $page -j "$FILE_INPUT_PDF" "$curOrigImg" 1>&2	
+	# count number of extracted images
+	nbImg=`ls -1 "$curOrigImg"* | wc -l`
+	[ $nbImg -ne "1" ] && echo "Expecting exactly 1 image on page $page (found $nbImg). Exiting..." >&2 && exit $EXIT_BAD_INPUT_FILE
+	# Get characteristics of the extracted image
+	curImg=`ls -1 "$curOrigImg"*`
+	propCurImg=`identify -format "%w %h %[colorspace]" "$curImg"`
+	widthCurImg=`echo "$propCurImg" | cut -f1 -d" "`
+	heightCurImg=`echo "$propCurImg" | cut -f2 -d" "`
+	colorspaceCurImg=`echo "$propCurImg" | cut -f3 -d" "`
+	# switch height/width values if the image has not the right orientation
+	# we make here the assumption that vertical/horizontal dpi are equal
+	# we will check that later
+	if [ $((($heightPDF-$widthPDF)*($heightCurImg-$widthCurImg))) -lt 0 ]; then
+		[ $VERBOSITY -ge $LOG_DEBUG ] && echo "Page $page: Extracted image has wrong orientation. Inverting image height/width values"
+		tmpval=$heightCurImg
+		heightCurImg=$widthCurImg
+		widthCurImg=$tmpval
+	fi
+	[ $VERBOSITY -ge $LOG_DEBUG ] && echo "Page $page: size ${heightCurImg}x${widthCurImg} (h*w pixel)"	
+	# compute the resolution of the image
+	dpi_x=`echo "scale=5;$widthCurImg*72/$widthPDF" | bc`
+	dpi_y=`echo "scale=5;$heightCurImg*72/$heightPDF" | bc`
+	# compute the maximum allowed resolution difference that can be cause by:
+	# - the truncated PDF with/height in pt
+	# - the precision of dpi value
+	epsilon=`echo "scale=5;($widthCurImg*72/$widthPDF^2)+($heightCurImg*72/$heightPDF^2)+0.00002" | bc`	# max inaccuracy due to truncation of PDF size in pt
+	[ `echo "($dpi_x - $dpi_y) < $epsilon " | bc` -eq 0 -o `echo "($dpi_y - $dpi_x) < $epsilon " | bc` -eq 0 ] \
+		&& echo "Resolutions difference ($dpi_x/$dpi_y) higher than expected ($epsilon). Exiting..." >&2 && exit $EXIT_BAD_INPUT_FILE
+	dpi=`echo "scale=5;($dpi_x+$dpi_y)/2+0.5" | bc` # adding 0.5 is required for rounding
+	dpi=`echo "scale=0;$dpi/1" | bc`		# round to the nearest integer
+	
+	# Identify if page image should be saved as ppm (color) or pgm (gray)
+	ext="ppm"
+	opt=""		
+	if [ $colorspaceCurImg = "Gray" ]; then
+		ext="pgm"
+		opt="-gray"
+	fi
+	curImgPixmap="$TMP_FLD/$page.$ext"
+	curImgPixmapDeskewed="$TMP_FLD/$page.deskewed.$ext"
+	curImgPixmapClean="$TMP_FLD/$page.cleaned.$ext"
+	
+	# extract current page as image with right orientation and resoltution
+	[ $VERBOSITY -ge $LOG_DEBUG ] && echo "Page $page: Extracting image as $ext file (${dpi} dpi)"
+	! pdftoppm -f $page -l $page -r $dpi $opt "$FILE_INPUT_PDF" > "$curImgPixmap" \
+		&& echo "Could not extract page $page as $ext from \"$FILE_INPUT_PDF\". Exiting..." >&2 && exit $EXIT_OTHER_ERROR
+
+	# if requested deskew image (without changing its size in pixel)
+	if [ "$PREPROCESS_DESKEW" -eq "1" ]; then
+		[ $VERBOSITY -ge $LOG_DEBUG ] && echo "Page $page: Deskewing image"
+		! convert "$curImgPixmap" -deskew 40% -gravity center -extent ${widthCurImg}x${heightCurImg} "$curImgPixmapDeskewed" \
+			&& echo "Could not deskew \"$curImgPixmap\". Exiting..." >&2 && exit $EXIT_OTHER_ERROR
+	else
+		cp "$curImgPixmap" "$curImgPixmapDeskewed"
+	fi
+
+	# if requested clean image with unpaper to get better OCR results
+	if [ "$PREPROCESS_CLEAN" -eq "1" ]; then
+		[ $VERBOSITY -ge $LOG_DEBUG ] && echo "Page $page: Cleaning image with unpaper"
+		! unpaper --dpi $dpi --mask-scan-size 100 \
+			--no-deskew --no-grayfilter --no-blackfilter --no-mask-center --no-border-align \
+			"$curImgPixmapDeskewed" "$curImgPixmapClean" 1> /dev/null \
+			&& echo "Could not clean \"$curImgPixmapDeskewed\". Exiting..." >&2 && exit $EXIT_OTHER_ERROR
+	else
+		cp "$curImgPixmapDeskewed" "$curImgPixmapClean"
+	fi
+
+	# perform OCR
+	[ $VERBOSITY -ge $LOG_DEBUG ] && echo "Page $page: Performing OCR"
+	! tesseract -l "$LAN" "$curImgPixmapClean" "$curHocr" hocr $TESS_CFG_FILES 1> /dev/null 2> /dev/null \
+		&& echo "Could not OCR file \"$curImgPixmapClean\". Exiting..." >&2 && exit $EXIT_OTHER_ERROR
+	mv "$curHocr.html" "$curHocr"
+
+	# embed text and image to new pdf file
+	if [ "$PREPROCESS_CLEANTOPDF" -eq "1" ]; then
+		image4finalPDF="$curImgPixmapClean"
+	else
+		image4finalPDF="$curImgPixmapDeskewed"	
+	fi
+	[ $VERBOSITY -ge $LOG_DEBUG ] && echo "Page $page: Embedding text in PDF"
+	! python $SRC/hocrTransform.py -r $dpi -i "$image4finalPDF" "$curHocr" "$curOCRedPDF" \
+		&& echo "Could not create PDF file from \"$curHocr\". Exiting..." >&2 && exit $EXIT_OTHER_ERROR
+	
+	# if requested generate special debug PDF page with visible OCR text
+	if [ $PDF_NOIMG -eq "1" ] ; then
+		[ $VERBOSITY -ge $LOG_DEBUG ] && echo "Page $page: Embedding text in PDF (debug page)"
+		! python $SRC/hocrTransform.py -b -r $dpi "$curHocr" "$curOCRedPDFDebug" \
+			&& echo "Could not create PDF file from \"$curHocr\". Exiting..." >&2 && exit $EXIT_OTHER_ERROR	
+	fi
+	
+	# delete temporary files created for the current page
+	# to avoid using to much disk space in case of PDF files having many pages
+	if [ $KEEP_TMP -eq 0 ]; then
+		rm "$curOrigImg"*.*
+		rm "$curHocr"
+		rm "$curImgPixmap"
+		rm "$curImgPixmapDeskewed"
+		rm "$curImgPixmapClean"
+	fi
+	
+done < "$FILE_SIZE_PAGES"
+
+
+
+
+# concatenate all pages
+[ $VERBOSITY -ge $LOG_DEBUG ] && echo "Output file: Concatenating all pages"
+! pdftk "${TMP_FLD}/"*-ocred.pdf cat output "$FILE_OUTPUT_PDF_CAT" \
+	&& echo "Could not concatenate individual PDF pages (\"${TMP_FLD}/*-ocred.pdf\") to one file. Exiting..." >&2 && exit $EXIT_OTHER_ERROR
+
+# convert the pdf file to match PDF/A format
+[ $VERBOSITY -ge $LOG_DEBUG ] && echo "Output file: Converting to PDF/A" 
+! gs -dQUIET -dPDFA -dBATCH -dNOPAUSE -dUseCIEColor \
+	-sProcessColorModel=DeviceCMYK -sDEVICE=pdfwrite -sPDFACompatibilityPolicy=2 \
+	-sOutputFile="$FILE_OUTPUT_PDFA" "$FILE_OUTPUT_PDF_CAT" 1> /dev/null 2> /dev/null \
+	&& echo "Could not convert PDF file \"$FILE_OUTPUT_PDF_CAT\" to PDF/A. Exiting..." >&2 && exit $EXIT_OTHER_ERROR
+
+# # Write metadata
+# # Needs to be done after converting to PDF/A, as gs does not preserve metadata
+# [ $VERBOSITY -ge $LOG_DEBUG ] && echo "Output file: Update metadata (creator, producer, and title)" 
+# title=`basename "$FILE_INPUT_PDF" | sed 's/[.][^.]*//' | \
+	# sed 's/_/ /g' | sed 's/-/ /g' | \
+	# sed 's/\([[:lower:]]\)\([[:upper:]]\)/\1 \2/g' | \
+	# sed 's/\([[:alpha:]]\)\([[:digit:]]\)/\1 \2/g' | \
+	# sed 's/\([[:digit:]]\)\([[:alpha:]]\)/\1 \2/g'`	# transform the file name (with extension) into distinct words
+# pdftk "$FILE_OUTPUT_PDFA_WO_META" update_info_utf8 - output "$FILE_OUTPUT_PDFA" << EOF
+# InfoBegin
+# InfoKey: Title
+# InfoValue: $title
+# InfoBegin
+# InfoKey: Creator
+# InfoValue: $TOOLNAME $VERSION
+# InfoBegin
+# InfoKey: Producer
+# InfoValue: ghostcript `gs --version`, pdftk
+# EOF
+
+# validate generated pdf file (compliance to PDF/A)
+[ $VERBOSITY -ge $LOG_DEBUG ] && echo "Output file: Checking compliance to PDF/A standard" 
+java -jar "$JHOVE" -c "$JHOVE_CFG" -m PDF-hul "$FILE_OUTPUT_PDFA" > "$FILE_VALIDATION_LOG"
+grep -i "Status|Message" "$FILE_VALIDATION_LOG" # summary of the validation
+[ $VERBOSITY -ge $LOG_DEBUG ] && echo "The full validation log is available here: \"$FILE_VALIDATION_LOG\""
+# check the validation results
+pdf_valid=1
+grep -i 'ErrorMessage' "$FILE_VALIDATION_LOG" >&2 && pdf_valid=0
+grep -i 'Status.*not valid' "$FILE_VALIDATION_LOG" >&2 && pdf_valid=0
+grep -i 'Status.*Not well-formed' "$FILE_VALIDATION_LOG" >&2 && pdf_valid=0
+! grep -i 'Profile:.*PDF/A-1' "$FILE_VALIDATION_LOG" > /dev/null && echo "PDF file profile is not PDF/A-1" >&2 && pdf_valid=0
+[ $pdf_valid -ne 1 ] && echo "Output file: The generated PDF/A file is INVALID" >&2
+[ $pdf_valid -ne 0 ] && [ $VERBOSITY -ge $LOG_INFO ] && echo "Output file: The generated PDF/A file is VALID"
+
+
+
+
+# delete temporary files
+if [ $KEEP_TMP -eq 0 ]; then
+	[ $VERBOSITY -ge $LOG_DEBUG ] && echo "Deleting temporary files"
+	rm -r -f "${TMP_FLD}"
+fi
+
+
+END=`date +%s`
+[ $VERBOSITY -ge $LOG_DEBUG ] && echo "Script took $(($END-$START)) seconds"
+
+
+[ $pdf_valid -ne 1 ] && exit $EXIT_INVALID_OUPUT_PDFA || exit 0

README.md

@@ -0,0 +1,42 @@
+OCRmyPDF
+========
+
+OCRmyPDF adds an OCR text layer to scanned PDF files, allowing them to be searched
+
+To get the script usage, call: sh ./OCRmyPDF.sh -h
+
+Features
+--------
+
+- Generate a searchable PDF/A file from a PDF file containing only images
+- Place OCRed text accurately below the image to easy copy / paste
+- Keep the exact resolution of the original embedded images
+- If requested deskew and / or clean the image before performing OCR
+- Validate the generated file against the PDF/A specification using jhove
+- Provides debug mode to enable easy verification of the OCR results
+
+Motivation
+----------
+
+I searched the web for a free command line tool to OCR PDF files on linux/unix:
+I found many, but none of them were really satisfying.
+- Either they produced PDF files with misplaced text under the image (making copy/paste impossible)
+- Or they did not display correctly some escaped html characters located in the hocr file produced by the OCR engine
+- Or they changed the resolution of the embedded images
+- Or they generated PDF file having a ridiculous big size
+- 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 / archiving)
+
+... so I decided to develop my own tool (using various existing scripts as an inspiration)
+
+Install
+--------
+
+Download OCRmyPDF here: https://github.com/fritz-hh/OCRmyPDF/tags
+
+Copy the file in onto your linux/unix machine and extract it.
+
+Run: "sh ./OCRmyPDF.sh -h" to get the script usage
+
+If not yet installed, the script will notify you about dependencies that need to be installed

README.rst

@@ -1,260 +0,0 @@
-OCRmyPDF
-========
-
-OCRmyPDF adds an OCR text layer to scanned PDF files, allowing them to
-be searched.
-
-Main features
--------------
-
--  Generates a searchable
-   `PDF/A <https://en.wikipedia.org/?title=PDF/A>`__ file from a regular PDF
-   only containing images
--  Places OCR text accurately below the image to ease copy / paste
--  Keeps the exact resolution of the original embedded images
-
-   -  or if requested oversamples the images before OCRing so as to get
-      better results
-
--  When possible, copies input images directly to output without transcoding,
-   to preserve image quality
--  Keeps file size about the same
--  If requested deskews and/or cleans the image before performing OCR
--  Validates input and output files
--  Provides debug mode to enable easy verification of the OCR results
--  Processes pages in parallel when more than one CPU core is
-   available
--  Uses `Tesseract OCR <https://github.com/tesseract-ocr/tesseract>`__ engine
--  Supports 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>`__.
-
-Motivation
-----------
-
-I searched the web for a free command line tool to OCR PDF files on
-Linux/UNIX: I found many, but none of them were really satisfying.
-
--  Either they produced PDF files with misplaced text under the image (making copy/paste impossible) 
--  Or they did not display correctly some escaped HTML characters located in the hOCR file produced by the OCR engine 
--  Or they changed the resolution of the embedded images
--  Or they generated PDF files having a ridiculous big size
--  Or they crashed when trying to OCR some of my PDF files
--  Or they did not produce valid PDF files (even though they were readable with my current PDF reader)
--  On top of that none of them produced PDF/A files (format dedicated for long time storage)
-
-... so I decided to develop my own tool (using various existing scripts
-as an inspiration)
-
-Installation
-------------
-
-Download OCRmyPDF here: https://github.com/jbarlow83/OCRmyPDF/releases
-
-You can install it to a Python virtual environment or system-wide. 
-
-Installing the Docker container
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-For many users, installing the Docker container 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
-a Docker container 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::
-
-   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 container host, and then follow these optional steps to enable multiple CPUs::
-
-   # Optional
-   docker-machine stop "yourVM"
-   VBoxManage modifyvm "yourVM" --cpus 2  # or whatever number of core is desired
-   docker-machine start "yourVM"
-   eval $(docker-machine env "yourVM")
-
-Assuming you have a Docker engine running somewhere, you can run these commands to download
-the image::
-
-   docker pull jbarlow83/ocrmypdf
-
-Then tag it to give a more convenient name, just ocrmypdf::
-
-   docker tag jbarlow83/ocrmypdf ocrmypdf
-  
-You can then run using the command::
-
-   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::
-
-   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``:: 
-
-   docker run -v "$(pwd):/home/docker"   ocrmypdf --skip-text test.pdf output.pdf
-
-Note that ``ocrmypdf`` has its own separate ``-v VERBOSITYLEVEL`` argument to control debug verbosity. All Docker arguments should before the ``ocrmypdf`` container name and all arguments to ``ocrmypdf`` should be listed after.
-
-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/>`__.
-
-Update Homebrew::
-
-   brew update
-   
-Install or upgrade the required Homebrew packages, if any are missing::
-
-   brew install libpng openjpeg jbig2dec     # image libraries
-   brew install qpdf
-   brew install ghostscript
-   brew install python3
-   brew install libxml2
-   brew install leptonica
-   brew install tesseract
-   
-It is also recommended that install Pillow and confirm it can read and write JPEG and PNG files::
-
-   pip3 install --upgrade pip
-   pip3 install --upgrade pillow
-
-Sometimes, the Python imaging library (Pillow) can end up being compiled and installed without support for JPEG and PNG files. (Arguably, this is an unfixed bug in Pillow's installer.) To confirm that Pillow is compiled correctly and can access JPEG and PNG files, try this command::
-
-   python3 -c "from PIL import Image; im = Image.new('1', (1, 1)); im.save('test.png'); im.save('test.jpg')"
-
-If you have trouble getting Pillow to access JPEG and PNG files, `review the installation instructions <https://pillow.readthedocs.org/installation.html>`__.
-
-You can then install OCRmyPDF from PyPI::
-
-   pip3 install ocrmypdf
-
-The command line program should now be available::
-
-   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.
-
-Update apt-get::
-
-   sudo apt-get update
-   sudo apt-get upgrade
-   
-Install system dependencies::
-
-   sudo apt-get install \
-      zlib1g-dev \
-      libjpeg-dev \
-      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)::
-
-   sudo pip3 install ocrmypdf
-   
-If you wish to install OCRmyPDF to a virtual environment to isolate system Python from modified, 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>`__::
-
-   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
-   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.
-
-      
-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.
-
-First, clone the HEAD revision::
-
-   git clone -b master https://github.com/jbarlow83/OCRmyPDF.git
-   cd OCRmyPDF
-
-To install the HEAD revision from sources::
-
-   pip3 install .
-
-Or, to install in `development mode <https://pythonhosted.org/setuptools/setuptools.html#development-mode>`__, 
-allowing customization of OCRmyPDF, use the ``-e`` flag::
-
-   pip3 install -e .
-   
-On certain Linux distributions such as Ubuntu, you may need to use 
-run the install command as superuser::
-
-   sudo pip3 install [-e] .
-   
-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::
-
-   git clone -b master https://github.com/jbarlow83/OCRmyPDF.git
-   pyvenv venv
-   source venv/bin/activate
-   cd OCRmyPDF
-   pip3 install .
-
-However, ``ocrmypdf`` will only be accessible on the system PATH after
-you activate the virtual environment.
-
-To run the program::
-   
-   ocrmypdf --help
-
-If not yet installed, the script will notify you about dependencies that
-need to be installed. The script requires specific versions of the
-dependencies. Older version than the ones mentioned in the release notes
-are likely not to be compatible to OCRmyPDF.
-
-Support
--------
-
-In case you detect an issue, please:
-
--  Check if your issue is already known
--  If no problem report exists on github, please create one here:
-   https://github.com/jbarlow83/OCRmyPDF/issues
--  Describe your problem thoroughly
--  Append the console output of the script when running the debug mode
-   (``-v 1`` option)
--  If possible provide your input PDF file as well as the content of the
-   temporary folder (using a file sharing service like
-   www.file-upload.net)
-
-Press & Media
--------------
-
--  `c't 1-2014, page 59 <http://www.heise.de/ct/inhalt/2014/1/58/>`__:
-   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>`__
-
-Disclaimer
-----------
-
-The software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied.

RELEASE_NOTES.md

@@ -0,0 +1,143 @@
+RELEASE NOTES
+=============
+
+Please always read this file before installing the package
+
+Download software here: https://github.com/fritz-hh/OCRmyPDF/tags
+
+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"

RELEASE_NOTES.rst

@@ -1,539 +0,0 @@
-RELEASE NOTES
-=============
-
-Please always read this file before installing the package
-
-Download software here: https://github.com/jbarlow83/OCRmyPDF/tags
-
-
-v3.1:
-=====
-
-Changes
--------
-
--  Default output format is now PDF/A-2b instead of PDF/A-1b
--  Python 3.5 and OS X El Capitan are now supported platforms - no changes were
-   needed to implement support
--  Improved some error messages related to missing input files
--  Fixed issue #20 - uppercase .PDF extension not accepted
--  Fixed an issue where OCRmyPDF failed to text that certain pages contained previously OCR'ed text, 
-   such as OCR text produced by Tesseract 3.04
--  Inserts /Creator tag into PDFs so that errors can be traced back to this project
--  Added new option --pdf-renderer=auto, to let OCRmyPDF pick the best PDF renderer. 
-   Currently it always chooses the 'hocrtransform' renderer but that behavior may change.
--  Set up Travis CI automatic integration testing
-
-v3.0:
-=====
-
-New features
-------------
-
--  Easier installation with a Docker container or Python's ``pip`` package manager 
--  Eliminated many external dependencies, so it's easier to setup
--  Now installs ``ocrmypdf`` to ``/usr/local/bin`` or equivalent for system-wide
-   access and easier typing
--  Improved command line syntax and usage help (``--help``)
--  Tesseract 3.03+ PDF page rendering can be used instead for better positioning
-   of recognized text (``--pdf-renderer tesseract``)
--  PDF metadata (title, author, keywords) are now transferred to the 
-   output PDF
--  PDF metadata can also be set from the command line (``--title``, etc.)
--  Automatic repairs malformed input PDFs if possible
--  Added test cases to confirm everything is working
--  Added option to skip extremely large pages that take too long to OCR and are 
-   often not OCRable (e.g. large scanned maps or diagrams); other pages are still
-   processed (``--skip-big``)
--  Added option to kill Tesseract OCR process if it seems to be taking too long on
-   a page, while still processing other pages (``--tesseract-timeout``)
--  Less common colorspaces (CMYK, palette) are now supported by conversion to RGB
--  Multiple images on the same PDF page are now supported
-
-Changes
--------
-
--  New, robust rewrite in Python 3.4+ with ruffus_ pipelines
--  Now uses Ghostscript 9.14's improved color conversion model to preserve PDF colors
--  OCR text is now rendered in the PDF as invisible text. Previous versions of OCRmyPDF
-   incorrectly rendered visible text with an image on top.
--  All "tasks" in the pipeline can be executed in parallel on any
-   available CPUs, increasing performance
--  The ``-o DPI`` argument has been phased out, in favor of ``--oversample DPI``, in
-   case we need ``-o OUTPUTFILE`` in the future
--  Removed several dependencies, so it's easier to install.  We no 
-   longer use:
-   
-   - GNU parallel_
-   - ImageMagick_
-   - Python 2.7
-   - Poppler
-   - MuPDF_ tools
-   - shell scripts
-   - Java and JHOVE_
-   - libxml2
-
--  Some new external dependencies are required or optional, compared to v2.x:
-
-   - Ghostscript 9.14+
-   - qpdf_ 5.0.0+
-   - Unpaper_ 6.1 (optional)
-   - some automatically managed Python packages
-  
-.. _ruffus: http://www.ruffus.org.uk/index.html
-.. _parallel: https://www.gnu.org/software/parallel/
-.. _ImageMagick: http://www.imagemagick.org/script/index.php
-.. _MuPDF: http://mupdf.com/docs/
-.. _qpdf: http://qpdf.sourceforge.net/
-.. _Unpaper: https://github.com/Flameeyes/unpaper
-.. _JHOVE: http://jhove.sourceforge.net/
-
-Release candidates
-------------------
-
--  rc9:
-
-   - fix issue #118: report error if ghostscript iccprofiles are missing
-   - fixed another issue related to #111: PDF rasterized to palette file
-   - add support image files with a palette
-   - don't try to validate PDF file after an exception occurs
-
--  rc8:
-
-   - fix issue #111: exception thrown if PDF is missing DocumentInfo dictionary
-
--  rc7:
-
-   - fix error when installing direct from pip, "no such file 'requirements.txt'"
-
--  rc6:
-
-   - dropped libxml2 (Python lxml) since Python 3's internal XML parser is sufficient
-   - set up Docker container
-   - fix Unicode errors if recognized text contains Unicode characters and system locale is not UTF-8
-
--  rc5:
-
-   - dropped Java and JHOVE in favour of qpdf
-   - improved command line error output
-   - additional tests and bug fixes
-   - tested on Ubuntu 14.04 LTS
-
--  rc4:
-
-   - dropped MuPDF in favour of qpdf
-   - fixed some installer issues and errors in installation instructions
-   - improve performance: run Ghostscript with multithreaded rendering
-   - improve performance: use multiple cores by default
-   - bug fix: checking for wrong exception on process timeout 
-
--  rc3: skipping version number intentionally to avoid confusion with Tesseract
--  rc2: first release for public testing to test-PyPI, Github
--  rc1: testing release process
-
-Compatibility notes
--------------------
-
--  ``./OCRmyPDF.sh`` script is still available for now
--  Stacking the verbosity option like ``-vvv`` is no longer supported
-
--  The configuration file ``config.sh`` has been removed.  Instead, you can
-   feed a file to the arguments for common settings:
-
-::
-
-   ocrmypdf input.pdf output.pdf @settings.txt
-
-where ``settings.txt`` contains *one argument per line*, for example:
-
-::
-
-   -l 
-   deu 
-   --author 
-   A. Merkel 
-   --pdf-renderer 
-   tesseract
-
-
-Fixes
------
-
--  Handling of filenames containing spaces: fixed
-
-Notes and known issues
-----------------------
-
--  Some dependencies may work with lower versions than tested, so try
-   overriding dependencies if they are "in the way" to see if they work.
-
--  ``--pdf-renderer tesseract`` will output files with an incorrect page size in Tesseract 3.03,
-   due to a bug in Tesseract.
-
--  PDF files containing "inline images" are not supported and won't be for the 3.0 release. Scanned
-   images almost never contain inline images.
-
-
-v2.2-stable (2014-09-29):
-=========================
-
-New features
-------------
-
-- 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"

docker-wrapper.sh

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

jhove/COPYING

@@ -0,0 +1,502 @@
+		  GNU LESSER GENERAL PUBLIC LICENSE
+		       Version 2.1, February 1999
+
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
+     59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+[This is the first released version of the Lesser GPL.  It also counts
+ as the successor of the GNU Library Public License, version 2, hence
+ the version number 2.1.]
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+Licenses are intended to guarantee your freedom to share and change
+free software--to make sure the software is free for all its users.
+
+  This license, the Lesser General Public License, applies to some
+specially designated software packages--typically libraries--of the
+Free Software Foundation and other authors who decide to use it.  You
+can use it too, but we suggest you first think carefully about whether
+this license or the ordinary General Public License is the better
+strategy to use in any particular case, based on the explanations below.
+
+  When we speak of free software, we are referring to freedom of use,
+not price.  Our General Public Licenses are designed to make sure that
+you have the freedom to distribute copies of free software (and charge
+for this service if you wish); that you receive source code or can get
+it if you want it; that you can change the software and use pieces of
+it in new free programs; and that you are informed that you can do
+these things.
+
+  To protect your rights, we need to make restrictions that forbid
+distributors to deny you these rights or to ask you to surrender these
+rights.  These restrictions translate to certain responsibilities for
+you if you distribute copies of the library or if you modify it.
+
+  For example, if you distribute copies of the library, whether gratis
+or for a fee, you must give the recipients all the rights that we gave
+you.  You must make sure that they, too, receive or can get the source
+code.  If you link other code with the library, you must provide
+complete object files to the recipients, so that they can relink them
+with the library after making changes to the library and recompiling
+it.  And you must show them these terms so they know their rights.
+
+  We protect your rights with a two-step method: (1) we copyright the
+library, and (2) we offer you this license, which gives you legal
+permission to copy, distribute and/or modify the library.
+
+  To protect each distributor, we want to make it very clear that
+there is no warranty for the free library.  Also, if the library is
+modified by someone else and passed on, the recipients should know
+that what they have is not the original version, so that the original
+author's reputation will not be affected by problems that might be
+introduced by others.
+
+  Finally, software patents pose a constant threat to the existence of
+any free program.  We wish to make sure that a company cannot
+effectively restrict the users of a free program by obtaining a
+restrictive license from a patent holder.  Therefore, we insist that
+any patent license obtained for a version of the library must be
+consistent with the full freedom of use specified in this license.
+
+  Most GNU software, including some libraries, is covered by the
+ordinary GNU General Public License.  This license, the GNU Lesser
+General Public License, applies to certain designated libraries, and
+is quite different from the ordinary General Public License.  We use
+this license for certain libraries in order to permit linking those
+libraries into non-free programs.
+
+  When a program is linked with a library, whether statically or using
+a shared library, the combination of the two is legally speaking a
+combined work, a derivative of the original library.  The ordinary
+General Public License therefore permits such linking only if the
+entire combination fits its criteria of freedom.  The Lesser General
+Public License permits more lax criteria for linking other code with
+the library.
+
+  We call this license the "Lesser" General Public License because it
+does Less to protect the user's freedom than the ordinary General
+Public License.  It also provides other free software developers Less
+of an advantage over competing non-free programs.  These disadvantages
+are the reason we use the ordinary General Public License for many
+libraries.  However, the Lesser license provides advantages in certain
+special circumstances.
+
+  For example, on rare occasions, there may be a special need to
+encourage the widest possible use of a certain library, so that it becomes
+a de-facto standard.  To achieve this, non-free programs must be
+allowed to use the library.  A more frequent case is that a free
+library does the same job as widely used non-free libraries.  In this
+case, there is little to gain by limiting the free library to free
+software only, so we use the Lesser General Public License.
+
+  In other cases, permission to use a particular library in non-free
+programs enables a greater number of people to use a large body of
+free software.  For example, permission to use the GNU C Library in
+non-free programs enables many more people to use the whole GNU
+operating system, as well as its variant, the GNU/Linux operating
+system.
+
+  Although the Lesser General Public License is Less protective of the
+users' freedom, it does ensure that the user of a program that is
+linked with the Library has the freedom and the wherewithal to run
+that program using a modified version of the Library.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.  Pay close attention to the difference between a
+"work based on the library" and a "work that uses the library".  The
+former contains code derived from the library, whereas the latter must
+be combined with the library in order to run.
+
+		  GNU LESSER GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License Agreement applies to any software library or other
+program which contains a notice placed by the copyright holder or
+other authorized party saying it may be distributed under the terms of
+this Lesser General Public License (also called "this License").
+Each licensee is addressed as "you".
+
+  A "library" means a collection of software functions and/or data
+prepared so as to be conveniently linked with application programs
+(which use some of those functions and data) to form executables.
+
+  The "Library", below, refers to any such software library or work
+which has been distributed under these terms.  A "work based on the
+Library" means either the Library or any derivative work under
+copyright law: that is to say, a work containing the Library or a
+portion of it, either verbatim or with modifications and/or translated
+straightforwardly into another language.  (Hereinafter, translation is
+included without limitation in the term "modification".)
+
+  "Source code" for a work means the preferred form of the work for
+making modifications to it.  For a library, complete source code means
+all the source code for all modules it contains, plus any associated
+interface definition files, plus the scripts used to control compilation
+and installation of the library.
+
+  Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running a program using the Library is not restricted, and output from
+such a program is covered only if its contents constitute a work based
+on the Library (independent of the use of the Library in a tool for
+writing it).  Whether that is true depends on what the Library does
+and what the program that uses the Library does.
+  
+  1. You may copy and distribute verbatim copies of the Library's
+complete source code as you receive it, in any medium, provided that
+you conspicuously and appropriately publish on each copy an
+appropriate copyright notice and disclaimer of warranty; keep intact
+all the notices that refer to this License and to the absence of any
+warranty; and distribute a copy of this License along with the
+Library.
+
+  You may charge a fee for the physical act of transferring a copy,
+and you may at your option offer warranty protection in exchange for a
+fee.
+
+  2. You may modify your copy or copies of the Library or any portion
+of it, thus forming a work based on the Library, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) The modified work must itself be a software library.
+
+    b) You must cause the files modified to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    c) You must cause the whole of the work to be licensed at no
+    charge to all third parties under the terms of this License.
+
+    d) If a facility in the modified Library refers to a function or a
+    table of data to be supplied by an application program that uses
+    the facility, other than as an argument passed when the facility
+    is invoked, then you must make a good faith effort to ensure that,
+    in the event an application does not supply such function or
+    table, the facility still operates, and performs whatever part of
+    its purpose remains meaningful.
+
+    (For example, a function in a library to compute square roots has
+    a purpose that is entirely well-defined independent of the
+    application.  Therefore, Subsection 2d requires that any
+    application-supplied function or table used by this function must
+    be optional: if the application does not supply it, the square
+    root function must still compute square roots.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Library,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Library, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Library.
+
+In addition, mere aggregation of another work not based on the Library
+with the Library (or with a work based on the Library) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may opt to apply the terms of the ordinary GNU General Public
+License instead of this License to a given copy of the Library.  To do
+this, you must alter all the notices that refer to this License, so
+that they refer to the ordinary GNU General Public License, version 2,
+instead of to this License.  (If a newer version than version 2 of the
+ordinary GNU General Public License has appeared, then you can specify
+that version instead if you wish.)  Do not make any other change in
+these notices.
+
+  Once this change is made in a given copy, it is irreversible for
+that copy, so the ordinary GNU General Public License applies to all
+subsequent copies and derivative works made from that copy.
+
+  This option is useful when you wish to copy part of the code of
+the Library into a program that is not a library.
+
+  4. You may copy and distribute the Library (or a portion or
+derivative of it, under Section 2) in object code or executable form
+under the terms of Sections 1 and 2 above provided that you accompany
+it with the complete corresponding machine-readable source code, which
+must be distributed under the terms of Sections 1 and 2 above on a
+medium customarily used for software interchange.
+
+  If distribution of object code is made by offering access to copy
+from a designated place, then offering equivalent access to copy the
+source code from the same place satisfies the requirement to
+distribute the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  5. A program that contains no derivative of any portion of the
+Library, but is designed to work with the Library by being compiled or
+linked with it, is called a "work that uses the Library".  Such a
+work, in isolation, is not a derivative work of the Library, and
+therefore falls outside the scope of this License.
+
+  However, linking a "work that uses the Library" with the Library
+creates an executable that is a derivative of the Library (because it
+contains portions of the Library), rather than a "work that uses the
+library".  The executable is therefore covered by this License.
+Section 6 states terms for distribution of such executables.
+
+  When a "work that uses the Library" uses material from a header file
+that is part of the Library, the object code for the work may be a
+derivative work of the Library even though the source code is not.
+Whether this is true is especially significant if the work can be
+linked without the Library, or if the work is itself a library.  The
+threshold for this to be true is not precisely defined by law.
+
+  If such an object file uses only numerical parameters, data
+structure layouts and accessors, and small macros and small inline
+functions (ten lines or less in length), then the use of the object
+file is unrestricted, regardless of whether it is legally a derivative
+work.  (Executables containing this object code plus portions of the
+Library will still fall under Section 6.)
+
+  Otherwise, if the work is a derivative of the Library, you may
+distribute the object code for the work under the terms of Section 6.
+Any executables containing that work also fall under Section 6,
+whether or not they are linked directly with the Library itself.
+
+  6. As an exception to the Sections above, you may also combine or
+link a "work that uses the Library" with the Library to produce a
+work containing portions of the Library, and distribute that work
+under terms of your choice, provided that the terms permit
+modification of the work for the customer's own use and reverse
+engineering for debugging such modifications.
+
+  You must give prominent notice with each copy of the work that the
+Library is used in it and that the Library and its use are covered by
+this License.  You must supply a copy of this License.  If the work
+during execution displays copyright notices, you must include the
+copyright notice for the Library among them, as well as a reference
+directing the user to the copy of this License.  Also, you must do one
+of these things:
+
+    a) Accompany the work with the complete corresponding
+    machine-readable source code for the Library including whatever
+    changes were used in the work (which must be distributed under
+    Sections 1 and 2 above); and, if the work is an executable linked
+    with the Library, with the complete machine-readable "work that
+    uses the Library", as object code and/or source code, so that the
+    user can modify the Library and then relink to produce a modified
+    executable containing the modified Library.  (It is understood
+    that the user who changes the contents of definitions files in the
+    Library will not necessarily be able to recompile the application
+    to use the modified definitions.)
+
+    b) Use a suitable shared library mechanism for linking with the
+    Library.  A suitable mechanism is one that (1) uses at run time a
+    copy of the library already present on the user's computer system,
+    rather than copying library functions into the executable, and (2)
+    will operate properly with a modified version of the library, if
+    the user installs one, as long as the modified version is
+    interface-compatible with the version that the work was made with.
+
+    c) Accompany the work with a written offer, valid for at
+    least three years, to give the same user the materials
+    specified in Subsection 6a, above, for a charge no more
+    than the cost of performing this distribution.
+
+    d) If distribution of the work is made by offering access to copy
+    from a designated place, offer equivalent access to copy the above
+    specified materials from the same place.
+
+    e) Verify that the user has already received a copy of these
+    materials or that you have already sent this user a copy.
+
+  For an executable, the required form of the "work that uses the
+Library" must include any data and utility programs needed for
+reproducing the executable from it.  However, as a special exception,
+the materials to be distributed need not include anything that is
+normally distributed (in either source or binary form) with the major
+components (compiler, kernel, and so on) of the operating system on
+which the executable runs, unless that component itself accompanies
+the executable.
+
+  It may happen that this requirement contradicts the license
+restrictions of other proprietary libraries that do not normally
+accompany the operating system.  Such a contradiction means you cannot
+use both them and the Library together in an executable that you
+distribute.
+
+  7. You may place library facilities that are a work based on the
+Library side-by-side in a single library together with other library
+facilities not covered by this License, and distribute such a combined
+library, provided that the separate distribution of the work based on
+the Library and of the other library facilities is otherwise
+permitted, and provided that you do these two things:
+
+    a) Accompany the combined library with a copy of the same work
+    based on the Library, uncombined with any other library
+    facilities.  This must be distributed under the terms of the
+    Sections above.
+
+    b) Give prominent notice with the combined library of the fact
+    that part of it is a work based on the Library, and explaining
+    where to find the accompanying uncombined form of the same work.
+
+  8. You may not copy, modify, sublicense, link with, or distribute
+the Library except as expressly provided under this License.  Any
+attempt otherwise to copy, modify, sublicense, link with, or
+distribute the Library is void, and will automatically terminate your
+rights under this License.  However, parties who have received copies,
+or rights, from you under this License will not have their licenses
+terminated so long as such parties remain in full compliance.
+
+  9. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Library or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Library (or any work based on the
+Library), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Library or works based on it.
+
+  10. Each time you redistribute the Library (or any work based on the
+Library), the recipient automatically receives a license from the
+original licensor to copy, distribute, link with or modify the Library
+subject to these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties with
+this License.
+
+  11. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Library at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Library by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Library.
+
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply,
+and the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  12. If the distribution and/or use of the Library is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Library under this License may add
+an explicit geographical distribution limitation excluding those countries,
+so that distribution is permitted only in or among countries not thus
+excluded.  In such case, this License incorporates the limitation as if
+written in the body of this License.
+
+  13. The Free Software Foundation may publish revised and/or new
+versions of the Lesser General Public License from time to time.
+Such new versions will be similar in spirit to the present version,
+but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Library
+specifies a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation.  If the Library does not specify a
+license version number, you may choose any version ever published by
+the Free Software Foundation.
+
+  14. If you wish to incorporate parts of the Library into other free
+programs whose distribution conditions are incompatible with these,
+write to the author to ask for permission.  For software which is
+copyrighted by the Free Software Foundation, write to the Free
+Software Foundation; we sometimes make exceptions for this.  Our
+decision will be guided by the two goals of preserving the free status
+of all derivatives of our free software and of promoting the sharing
+and reuse of software generally.
+
+			    NO WARRANTY
+
+  15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
+KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+LIBRARY IS WITH YOU.  SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
+FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
+LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+           How to Apply These Terms to Your New Libraries
+
+  If you develop a new library, and you want it to be of the greatest
+possible use to the public, we recommend making it free software that
+everyone can redistribute and change.  You can do so by permitting
+redistribution under these terms (or, alternatively, under the terms of the
+ordinary General Public License).
+
+  To apply these terms, attach the following notices to the library.  It is
+safest to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the library's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+Also add information on how to contact you by electronic and paper mail.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the library, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the
+  library `Frob' (a library for tweaking knobs) written by James Random Hacker.
+
+  <signature of Ty Coon>, 1 April 1990
+  Ty Coon, President of Vice
+
+That's all there is to it!

jhove/LICENSE

@@ -0,0 +1,17 @@
+JHOVE - JSTOR/Harvard Object Validation Environment
+Copyright 2003-2008 by JSTOR and the President and Fellows of Harvard College
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU Lessor General Public License as
+published by the Free Software Foundation; either version 2.1 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+USA

jhove/README

@@ -0,0 +1,227 @@
+JHOVE - JSTOR/Harvard Object Validation Environment
+Copyright 2003-2012 by JSTOR and the President and Fellows of Harvard College
+JHOVE is made available under the GNU Lesser General Public License (LGPL;
+see the file LICENSE for details)
+
+Rev. 1.9, 2012-12-17
+
+JHOVE (the JSTOR/Harvard Object Validation Environment, pronounced "jhove")
+is an extensible software framework for performing format identification,
+validation, and characterization of digital objects.
+
+o Format identification is the process of determining the format to which a
+  digital object conforms: "I have a digital object; what format is it?"
+o Format validation is the process of determining the level of compliance of a
+  digital object to the specification for its purported format: "I have an
+  object purportedly of format F; is it?"
+o Format characterization is the process of determing the format-specific
+  significant properties of an object of a given format: "I have an object of
+  format F; what are its salient properties?"
+
+These actions are frequently necessary during routine operation of digital
+repositories and for digital preservation activities.
+
+The output from JHOVE is controlled by output handlers. JHOVE uses an
+extensible plug-in architecture; it can be configured at the time of its
+invocation to include whatever specific format modules and output handlers
+that are desired. The initial release of JHOVE includes modules for
+arbitrary byte streams, ASCII and UTF-8 encoded text, AIFF and WAVE audio,
+GIF, JPEG, JPEG 2000, TIFF, and PDF; and text and XML output handlers.
+
+The JHOVE project is a collaboration of JSTOR and the Harvard University
+Library.  Development of JHOVE was funded in part by the Andrew W. Mellon
+Foundation.  JHOVE is made available under the GNU Lesser General Public
+License (LGPL; see the file LICENSE for details).
+
+JHOVE is currently being maintained by indpendent developers.
+
+REQUIREMENTS
+
+1. Java J2SE 1.5
+(JHOVE was originally implemented using the Sun J2SE SDK 1.4.1 and has
+been tested to work with 1.5)
+
+2. If you would like to compile the JHOVE source code, then
+Apache Ant, a Java-based build tool <http://ant.apache.org/> is necessary.
+Note that the JAVA_HOME environment variable must be set appropriately for
+Ant to work properly.
+(JHOVE was implemented and tested using Ant 1.5.1.)
+
+DISTRIBUTION
+
+The JHOVE distribution package includes:
+
+    jhove/                                 # JHOVE home directory
+          COPYING                          # GNU Lesser General Public License
+          LICENSE                          # JHOVE license information
+          README
+          RELEASENOTES                     # JHOVE release notes
+          bin/
+                    jhove.jar              # JHOVE API package
+                    jhove-handler.jar      # Standard output handler package
+                    jhove-module.jar       # Standard module package
+                    JhoveApp.jar           # JHOVE command line application
+                    JhoveView.jar          # JHOVE with Swing GUI front-end
+          build.xml                        # Ant configuration file
+          classes/
+                    build.xml              # Ant configuration file
+                    edu/ ...               # JHOVE API packages
+                    ADump.*                # AIFF dump utility class
+                    GDump.*                # GIF dump utility class
+                    Jhove.*                # JHOVE main class
+                    JDump.*                # JPEG dump utility class
+                    J2Dump.*               # JPEG 2000 dump utility class
+                    PDump.*                # PDF dump utility class
+                    TDump.*                # TIFF dump utility class
+                    UserHome.*             # user.home property utility class
+                    WDump.*                # WAVE dump utility class
+          conf/
+                   jhove.conf              # JHOVE configuration file
+                   jhove.xsd               # JHOVE output schema
+                   jhoveConfig.xsd         # JHOVE configuration file schema
+          doc/
+                   *.html                  # API documentation
+                   ...
+          examples/                        # Sample files
+                   ascii/ ...
+                   gif/   ...
+                   jpeg/  ...
+                   jpeg2000/ ...
+                   pdf/   ...
+                   tiff/  ...
+                   utf-8/ ...
+          adump*                           # AIFF dump Bourne shell driver
+          adump.bat*                       # AIFF dump DOS shell driver script
+          gdump*                           # GIF dump Bourne shell driver
+          gdump.bat*                       # GIF dump DOS shell driver script
+          jdump*                           # JPEG dump Bourne shell driver
+          jdump.bat*                       # JPEG dump DOS shell driver script
+          j2dump*                          # JPEG 2000 dump Bourne shell driver
+          j2dump.bat*                      # JPEG 2000 dump DOS shell driver
+          jhove.tmpl*                      # Template for JHOVE Bourne shell driver script
+          jhove_bat.tmpl*                  # Template for JHOVE DOS shell driver script
+          pdump*                           # PDF dump Bourne shell driver
+          pdump.bat*                       # PDF dump DOS shell driver script
+          tdump*                           # TIFF dump Bourne shell driver
+          tdump.bat*                       # TIFF dump DOS shell driver script
+          userhome*                        # user.home Bourne shell driver
+          userhome.bat*                    # user.home DOS shell driver script
+          wdump*                           # WAVE dump Bourne shell driver
+          wdump.bat*                       # WAVE dump DOS shell driver script
+
+INSTALLATION
+
+Edit the configuration file, jhove/conf/jhove.conf, and set the absolute
+pathname of the JHOVE home directory and the temporary directory (in which
+temporary files are created):
+
+    <jhoveHome>jhove-home-directory</jhoveHome>
+    <tempDirectory>temporary-directory</tempDirectory>
+
+The JHOVE home directory is the top-most directory in the distribution TAR
+or ZIP file.  On Unix systems, "/var/tmp" is an appropriate temporary
+directory; on Windows, "C:\Temp".  For example, if the distribution TAR
+file is disaggregated on a Unix system in the directory "/users/stephen/
+projects", then the configuration file should read:
+
+    <jhoveHome>/users/stephen/projects/jhove</jhoveHome>
+    <tempDirectory>/var/tmp</jhoveHome>
+
+In the JHOVE home directory, copy the JHOVE Bourne shell driver script
+template, "jhove.tmpl", to "jhove" (or the equivalent Windows shell 
+script, "jhove_bat.tmpl" to "jhove.bat"), and set the
+JHOVE home directory, Java home directory, and Java interpreter:
+
+    JHOVE_HOME=jhove-home-directory
+    JAVA_HOME=java-home-directory
+    JAVA=java-interpreter
+
+The JAVA_HOME property should provide the absolute pathname of the Java
+runtime or SDK installation; JAVA should provide the absolute pathname of the
+Java interpreter.  For example:
+
+    JHOVE_HOME=/users/stephen/projects/jhove
+    JAVA_HOME=/usr/local/j2re1.4.1_02
+    JAVA=$JAVA_HOME/bin/java
+
+In the DOS shell driver script, jhove.bat, the equivalent three
+variables are:
+
+    SET JHOVE_HOME=jhove-home-directory
+    SET JAVA_HOME=java-home-directory
+    SET JAVA=%JAVA_HOME%\bin\java
+
+For example:
+
+    SET JHOVE_HOME="C:\Program Files\jhove"
+    SET JAVA_HOME="C:\Program Files\java\j2re1.4.1_02"
+    SET JAVA=%JAVA_HOME%\bin\java
+
+The quotation marks are necessary because of the embedded space characters.
+On Windows platforms it may also be necessary to add the Java bin subdirectory
+to the System PATH environment variable:
+
+    PATH=C:\Program Files\java\j2re1.4.1_02\bin;...
+
+(For information on setting a Windows environment variable, consult your local
+documentation or system administrator.)
+
+USAGE
+
+    java Jhove [-c config] [-m module] [-h handler] [-e encoding] [-H handler]
+               [-o output] [-x saxclass] [-t tempdir] [-b bufsize]
+               [-l loglevel] [[-krs] dir-file-or-uri [...]]
+
+where -c config   Configuration file pathname
+      -m module   Module name
+      -h handler  Output handler name (defaults to TEXT)
+      -e encoding Character encoding used by output handler (defaults to UTF-8)
+      -H handler  About handler name
+      -o output   Output file pathname (defaults to standard output)
+      -x saxclass SAX parser class (defaults to J2SE default)
+      -t tempdir  Temporary directory in which to create temporary files
+      -b bufsize  Buffer size for buffered I/O (defaults to J2SE 1.4 default)
+      -l loglevel Logging level
+      -k          Calculate CRC32, MD5, and SHA-1 checksums
+      -r          Display raw data flags, not textual equivalents
+      -s          Format identification based on internal signatures only
+      dir-file-or-uri Directory or file pathname or URI of formated content
+                      stream
+
+All named modules and output handlers must be found on the Java CLASSPATH at
+the time of invocation.  The JHOVE driver script, jhove/jhove, automatically
+sets the CLASSPATH and invokes the Jhove main class:
+
+    jhove [-c config] [-m module] [-h handler] [-e encoding] [-H handler]
+          [-o output] [-x saxclass] [-t tempdir] [-b bufsize] [-l loglevel]
+          [[-krs] dir-file-or-uri [...]]
+
+The following additional programs are available, primarily for testing
+and debugging purposes.  They display a minimally processed, human-readable
+version of the contents of AIFF, GIF, JPEG, JPEG 2000, PDF, TIFF, and WAVE
+files:
+
+    java ADump  aiff-file
+    java GDump  gif-file
+    java JDump  jpeg-file
+    java J2Dump jpeg2000-file
+    java PDump  pdf-file
+    java TDump  tiff-file
+    java WDump  wave-file
+
+For convenience, the following driver scripts are also available:
+
+    adump  aiff-file
+    gdump  gif-file
+    jdump  jpeg-file
+    j2dump jpeg2000-file
+    pdump  pdf-file
+    tdump  tiff-file
+    wdump  wave-file
+
+The JHOVE Swing-based GUI interface can be invoked from a command shell from
+the jhove/bin sub-directory:
+
+    java -jar JhoveView.jar -c <configFile>
+
+where <configFile> is the pathname of the JHOVE configuration file.

jhove/bin/README

@@ -0,0 +1,25 @@
+JHOVE - JSTOR/Harvard Object Validation Environment
+Copyright 2003 by JSTOR and the President and Fellows of Harvard College
+JHOVE is made available under the GNU General Public License (see the file
+LICENSE for details)
+
+Rev. 2003-11-25
+
+The following jar files are meant to be used for embedding JHOVE functionality
+into new applications or systems.
+
+  jhove.jar          Contains the JHOVE API interfaces and classes
+  jhove-module.jar   Contains the standard JHOVE modules ()
+  jhove-handler.jar  Contains the standard JHOVE output handlers (TEXT and XML)
+
+The following jar file is meant to be used with the stand-alone JHOVE
+application using a command-line interface.  It contains the main Jhove class
+and the contents of jhove.jar, jhove-module.jar, and jhove-handler.jar.
+
+  JhoveApp.jar
+
+The following jar file is meant to be used with the stand-alone JHOVE
+application using a Swing GUI interface.  It contains the main JhoveView class
+and the contents of jhove.jar, jhove-module.jar, and jhove-handler.jar.
+
+  JhoveView.jar

jhove/build.xml

@@ -0,0 +1,78 @@
+<project name="Jhove" default="dist" basedir=".">
+  <description>Project build file
+    Jhove - JSTOR/Harvard Object Validation Environment
+    Version 1.0 2004-09-10
+    Copyright 2004 by JSTOR and the President and Fellows of Harvard College
+  </description>
+
+  <!-- ant (or ant dist) Build everything
+       ant debug         Build everything with debug enabled
+       ant clean         Delete backup files
+       ant cleanclass    Delete backup and class files
+       ant cleandist     Delete backup, class, and jar files
+       ant javadoc       Build javadocs
+    -->
+
+  <!-- set global properties for this build -->
+  <property name="bin"     location="bin"/>
+  <property name="classes" location="classes"/>
+  <property name="doc"     location="doc"/>
+
+  <target name="dist" description="Create distribution">
+    <ant dir="${classes}" inheritAll="false">
+      <property name="dbg" value="off"/>
+    </ant>
+  	<chmod file="jhove" perm="ugo+x"/>
+  	<chmod file="${bin}/JhoveView.jar" perm="ugo+x"/>
+  </target>
+
+  <target name="debug" description="Create distribution with debug enabled">
+    <ant dir="${classes}" inheritAll="false">
+      <property name="dbg" value="on"/>
+    </ant>
+  </target>
+
+  <target name="view" description="Create JhoveView application">
+    <ant dir="${classes}" target="view" inheritAll="false">
+      <property name="dbs" value="on"/>
+    </ant>
+  </target>
+
+  <target name="clean" description="Delete backup files">
+    <ant dir="${classes}" target="main-clean" inheritAll="false"/>
+  </target>
+
+  <target name="cleanclass" depends="clean">
+    <ant dir="${classes}" target="main-cleanclass" inheritAll="false"/>
+  </target>
+
+  <target name="cleandist" depends="cleanclass">
+    <delete file="${bin}/jhove.jar"/>
+    <delete file="${bin}/jhove-handler.jar"/>
+    <delete file="${bin}/jhove-module.jar"/>
+    <delete file="${bin}/JhoveApp.jar"/>
+    <delete file="${bin}/JhoveView.jar"/>
+  </target>
+
+  <target name="javadoc">
+    <javadoc sourcepath="${classes}" destdir="${doc}"
+             windowtitle="JHOVE Documentation"
+             Overview="${classes}/overview.html">
+      <package name="edu.harvard.hul.ois.jhove"/>
+      <package name="edu.harvard.hul.ois.jhove.handler"/>
+      <package name="edu.harvard.hul.ois.jhove.handler.audit"/>
+      <package name="edu.harvard.hul.ois.jhove.module"/>
+      <package name="edu.harvard.hul.ois.jhove.module.aiff"/>
+      <package name="edu.harvard.hul.ois.jhove.module.gif"/>
+      <package name="edu.harvard.hul.ois.jhove.module.html"/>
+      <package name="edu.harvard.hul.ois.jhove.module.iff"/>
+      <package name="edu.harvard.hul.ois.jhove.module.jpeg"/>
+      <package name="edu.harvard.hul.ois.jhove.module.jpeg2000"/>
+      <package name="edu.harvard.hul.ois.jhove.module.pdf"/>
+      <package name="edu.harvard.hul.ois.jhove.module.tiff"/>
+      <package name="edu.harvard.hul.ois.jhove.module.wave"/>
+      <package name="edu.harvard.hul.ois.jhove.module.xml"/>
+      <package name="edu.harvard.hul.ois.jhove.viewer"/>
+    </javadoc>
+  </target>
+</project>

jhove/conf/README

@@ -0,0 +1,63 @@
+JHOVE - JSTOR/Harvard Object Validation Environment
+Copyright 2003-2007 by JSTOR and the President and Fellows of Harvard College
+JHOVE is made available under the GNU General Public License (see the file
+LICENSE for details)
+
+Rev. 2007-08-30
+
+Edit the configuration file, jhove.conf, and set the JHOVE home
+directory:
+
+    <jhoveHome>jhove-home-directory</jhoveHome>
+
+and temporary directory:
+
+    <tempDirectory>temporary-directory</tempDirectory>
+
+On most Unix systems, a reasonable temporary directory is "/var/tmp";
+on Windows, "C:\temp".
+
+The optional
+
+    <bufferSize>buffer-size</bufferSize>
+
+element defines the buffer size used for buffer I/O operations.
+
+The optional
+
+    <mixVersion>1.0</mixVersion>
+
+element specifies that the XML output handler should conform to the
+MIX 1.0 schema.  The default behavior is for handler output to conform
+to the MIX 0.2 schema.
+
+The optional
+
+    <sigBytes>n</sigBytes>
+
+element specifies that JHOVE modules will look for format signatures
+in the first <n> bytes of the file.  The default value is 1024.
+
+All class names must be fully qualified with their package name:
+
+    <module>
+      <class>fully-package-qualified-class-name</class>
+      <init>optional-initialization-argument</init>
+      <param>optional-invocation-argument</param>
+    </module>
+
+The optional <init> argument is passed to the module once at the time
+its class is instantiated.  See module-specific documentation for a
+description of any initialization options.
+
+The optional <param> argument is passed to the module every time it is
+invoked.  See module-specific documentation for a description of any
+invocation options.
+
+The order in which format modules are defined is important; when
+performing a format identification operation, JHOVE will search for a
+matching module in the order in which the modules are defined in the
+configuration file. In general, the modules for more generic formats
+should come later in the list. For example, the standard module ASCII
+should be defined before the UTF-8 module, since all ASCII objects
+are, by definition, UTF-8 objects, but not vice versa.

jhove/conf/jhove-byteoffset=true.conf

@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<jhoveConfig version="1.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns="http://hul.harvard.edu/ois/xml/ns/jhove/jhoveConfig"
+ xsi:schemaLocation="http://hul.harvard.edu/ois/xml/ns/jhove/jhoveConfig
+                     http://hul.harvard.edu/ois/xml/xsd/jhove/1.4/jhoveConfig.xsd">
+ <jhoveHome>/users/stephen/projects/jhove</jhoveHome>
+ <defaultEncoding>utf-8</defaultEncoding>
+ <tempDirectory>/var/tmp</tempDirectory>
+ <bufferSize>131072</bufferSize>
+ <mixVersion>1.0</mixVersion>
+ <sigBytes>1024</sigBytes>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.AiffModule</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.WaveModule</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.PdfModule</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.Jpeg2000Module</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.JpegModule</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.GifModule</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.TiffModule</class>
+  <param>byteoffset=true</param>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.XmlModule</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.HtmlModule</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.AsciiModule</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.Utf8Module</class>
+ </module>
+</jhoveConfig>

jhove/conf/jhove-withTextMD.conf

@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<jhoveConfig version="1.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns="http://hul.harvard.edu/ois/xml/ns/jhove/jhoveConfig"
+ xsi:schemaLocation="http://hul.harvard.edu/ois/xml/ns/jhove/jhoveConfig
+                     http://hul.harvard.edu/ois/xml/xsd/jhove/1.4/jhoveConfig.xsd">
+ <jhoveHome>/users/stephen/projects/jhove</jhoveHome>
+ <defaultEncoding>utf-8</defaultEncoding>
+ <tempDirectory>/var/tmp</tempDirectory>
+ <bufferSize>131072</bufferSize>
+ <mixVersion>1.0</mixVersion>
+ <sigBytes>1024</sigBytes>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.AiffModule</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.WaveModule</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.PdfModule</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.Jpeg2000Module</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.JpegModule</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.GifModule</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.TiffModule</class>
+  <param>byteoffset=true</param>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.XmlModule</class>
+  <param>withTextMD=true</param>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.HtmlModule</class>
+  <param>withTextMD=true</param>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.AsciiModule</class>
+  <param>withTextMD=true</param>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.Utf8Module</class>
+  <param>withTextMD=true</param>
+ </module>
+</jhoveConfig>

jhove/conf/jhove.conf

@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<jhoveConfig version="1.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns="http://hul.harvard.edu/ois/xml/ns/jhove/jhoveConfig"
+ xsi:schemaLocation="http://hul.harvard.edu/ois/xml/ns/jhove/jhoveConfig
+                     http://hul.harvard.edu/ois/xml/xsd/jhove/1.4/jhoveConfig.xsd">
+ <jhoveHome>./jhove/</jhoveHome>
+ <defaultEncoding>utf-8</defaultEncoding>
+ <tempDirectory>/var/tmp</tempDirectory>
+ <bufferSize>131072</bufferSize>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.AiffModule</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.WaveModule</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.PdfModule</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.Jpeg2000Module</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.JpegModule</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.GifModule</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.TiffModule</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.XmlModule</class>
+  <param>schema=http://www.example.com/schema;/home/schemas/exampleschema.xsd</param>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.HtmlModule</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.AsciiModule</class>
+ </module>
+ <module>
+  <class>edu.harvard.hul.ois.jhove.module.Utf8Module</class>
+ </module>
+</jhoveConfig>

jhove/configure.pl

@@ -0,0 +1,88 @@
+#!/usr/bin/perl
+
+########################################################################
+# Jhove - JSTOR/Harvard Object Validation Environment
+# Copyright 2004 by JSTOR and the President and Fellows of Harvard College
+#
+# A Perl script for plugging local path information into the
+# various script files of JHOVE, as well as conf/jhove.conf.
+#
+# This is configured only for Unix (including OS X).
+#
+#    Usage: configure.pl jhove_home_directory [java_home_directory [java_runtime_directory]]
+#
+#    If invoked with no arguments, it will output a usage message.
+#
+########################################################################
+use File::Copy;
+
+sub mung {
+    my $f = $_[0];
+    my $bak = $f . "~";
+    #If there is no backup file, copy the file to the
+    #backup.  Otherwise work from the backup.
+    if (!(-e $bak)) {
+        rename ($f, $bak);
+    }
+    open (INFILE, $bak);
+    open (OUTFILE, ">" . $f);
+
+    #Walks through each line of file, making substitutions.
+    #Remember that the JAVA_HOME and JAVA arguments are optional.
+    while (<INFILE>) {
+        s/^JHOVE_HOME=.*/JHOVE_HOME=$ARGV[0]/;
+        if ($narg >= 2) {
+            s/^JAVA_HOME=.*/JAVA_HOME=$ARGV[1]/;
+        }
+        if ($narg >= 3) {
+            s/^JAVA=.*/JAVA=$ARGV[2]/;
+        }
+        print OUTFILE;
+    }
+    close (INFILE);
+    close (OUTFILE);
+    if (-e $f) {
+        print ("Fixed " . $f . "\n");
+    }
+}
+
+
+$narg = $#ARGV + 1;
+if ($narg <= 0) {
+    print "Usage: configure.pl jhove_home_directory [java_home_directory [java_runtime_directory]]\n";
+    exit;
+}
+print "JHOVE_HOME will be set to " . $ARGV[0] . "\n";
+if ($narg >= 2) {
+    print "JAVA_HOME will be set to " . $ARGV[1] . "\n";
+}
+if ($narg >= 3) {
+    print "JAVA will be set to " . $ARGV[2] . "\n";
+}
+mung ("jhove");
+mung ("adump");
+mung ("gdump");
+mung ("jdump");
+mung ("j2dump");
+mung ("pdump");
+mung ("tdump");
+mung ("wdump");
+
+#Fix up the config file.  We assume that the <jhoveHome>
+#element is all on one line.
+if (!(-e "conf/jhove.conf~")) {
+    rename ("conf/jhove.conf", "conf/jhove.conf~");
+}
+open (INFILE, "conf/jhove.conf~");
+open (OUTFILE, ">conf/jhove.conf");
+while (<INFILE>) {
+    s!<jhoveHome>.*</jhoveHome>!<jhoveHome>$ARGV[0]</jhoveHome>!;
+    print OUTFILE;
+}
+close (INFILE);
+close (OUTFILE);
+if (-e "conf/jhove.conf") {
+    print "Fixed conf/jhove.conf\n";
+}
+exit;
+

jhove/gdump

@@ -0,0 +1,37 @@
+#!/bin/sh
+
+########################################################################
+# gdump - JSTOR/Harvard Object Validation Environment
+# Copyright 2004-2005 by the President and Fellows of Harvard College
+# JHOVE is made available under the GNU General Public License (see the
+# file LICENSE for details)
+#
+# Driver script for the GIF dump utility
+#
+# Usage: gdump file
+#
+# where  file  is a GIF file
+#
+# Configuration constants:
+
+JHOVE_HOME=/users/stephen/projects/jhove
+
+JAVA_HOME=/usr/java      # Java JRE directory
+JAVA=$JAVA_HOME/bin/java # Java interpreter
+
+EXTRA_JARS=              # Extra .jar files to add to CLASSPATH
+
+# NOTE: Nothing below this line should be edited
+########################################################################
+
+CP=${JHOVE_HOME}/bin/JhoveApp.jar:${EXTRA_JARS}
+
+# Retrieve a copy of all command line arguments to pass to the application.
+
+ARGS=""
+for ARG do
+    ARGS="$ARGS $ARG"
+done
+
+# Set the CLASSPATH and invoke the Java loader.
+${JAVA} -classpath $CP GDump $ARGS

jhove/j2dump

@@ -0,0 +1,37 @@
+#!/bin/sh
+
+########################################################################
+# j2dump - JSTOR/Harvard Object Validation Environment
+# Copyright 2004-2005 by the President and Fellows of Harvard College
+# JHOVE is made available under the GNU General Public License (see the
+# file LICENSE for details)
+#
+# Driver script for the JPEG 2000 dump utility
+#
+# Usage: j2dump file
+#
+# where  file  is a JPEG file
+#
+# Configuration constants:
+
+JHOVE_HOME=/users/stephen/projects/jhove
+
+JAVA_HOME=/usr/java      # Java JRE directory
+JAVA=$JAVA_HOME/bin/java # Java interpreter
+
+EXTRA_JARS=              # Extra .jar files to add to CLASSPATH
+
+# NOTE: Nothing below this line should be edited
+########################################################################
+
+CP=${JHOVE_HOME}/bin/JhoveApp.jar:${EXTRA_JARS}
+
+# Retrieve a copy of all command line arguments to pass to the application.
+
+ARGS=""
+for ARG do
+    ARGS="$ARGS $ARG"
+done
+
+# Set the CLASSPATH and invoke the Java loader.
+${JAVA} -classpath $CP J2Dump $ARGS

jhove/jdump

@@ -0,0 +1,37 @@
+#!/bin/sh
+
+########################################################################
+# jdump - JSTOR/Harvard Object Validation Environment
+# Copyright 2004-2005 by the President and Fellows of Harvard College
+# JHOVE is made available under the GNU General Public License (see the
+# file LICENSE for details)
+#
+# Driver script for the JPEG dump utility
+#
+# Usage: jdump file
+#
+# where  file  is a JPEG file
+#
+# Configuration constants:
+
+JHOVE_HOME=/users/stephen/projects/jhove
+
+JAVA_HOME=/usr/java      # Java JRE directory
+JAVA=$JAVA_HOME/bin/java # Java interpreter
+
+EXTRA_JARS=              # Extra .jar files to add to CLASSPATH
+
+# NOTE: Nothing below this line should be edited
+########################################################################
+
+CP=${JHOVE_HOME}/bin/JhoveApp.jar:${EXTRA_JARS}
+
+# Retrieve a copy of all command line arguments to pass to the application.
+
+ARGS=""
+for ARG do
+    ARGS="$ARGS $ARG"
+done
+
+# Set the CLASSPATH and invoke the Java loader.
+${JAVA} -classpath $CP JDump $ARGS

jhove/jhove

@@ -0,0 +1,58 @@
+#!/bin/sh
+
+########################################################################
+# JHOVE - JSTOR/Harvard Object Validation Environment
+# Copyright 2003-2005 by JSTOR and the President and Fellows of Harvard College
+# JHOVE is made available under the GNU General Public License (see the
+# file LICENSE for details)
+#
+# Usage: jhove [-c config] [-m module] [-h handler] [-e encoding] [-H handler]
+#              [-o output] [-x saxclass] [-t tempdir] [-b bufsize]
+#              [-l loglevel] [[-krs] dir-file-or-uri [...]]
+#
+# where -c config   Configuration file pathname
+#       -m module   Module name
+#       -h handler  Output handler name (defaults to TEXT)
+#       -e encoding Character encoding of output handler (defaults to UTF-8)
+#       -H handler  About handler name
+#       -o output   Output file pathname (defaults to standard output)
+#       -x saxclass SAX parser class (defaults to J2SE 1.4 default)
+#       -t tempdir  Temporary directory in which to create temporary files
+#       -b bufsize  Buffer size for buffered I/O (defaults to J2SE 1.4 default)
+#       -k          Calculate CRC32, MD5, and SHA-1 checksums
+#       -r          Display raw data flags, not textual equivalents
+#       -s          Format identification based on internal signatures only
+#       dir-file-or-uri Directory, file pathname or URI of formatted content
+#
+# CHANGE for JHOVE 1.8:
+# You no longer have to figure out where JAVA_HOME is; that's the
+# operating system's job. If the OS tells you it can't find Java, 
+# adjust your shell's path or revert to the old way (commented out).
+# Configuration constants:
+
+#JHOVE_HOME=/users/gary/dev/jhove
+JHOVE_HOME=[fill in path to jhove directory]
+
+JAVA_HOME=/usr/java      # Java JRE directory -- change to your local java home
+JAVA=$JAVA_HOME/bin/java # Java interpreter -- usually won't need change
+
+#XTRA_JARS=/users/stephen/xercesImpl.jar
+EXTRA_JARS=              # Extra .jar files to add to CLASSPATH
+
+# NOTE: Nothing below this line should be edited
+########################################################################
+
+CP=${JHOVE_HOME}/bin/JhoveApp.jar:${EXTRA_JARS}
+
+# Retrieve a copy of all command line arguments to pass to the application.
+
+ARGS=""
+for ARG do
+    ARGS="$ARGS $ARG"
+done
+
+# Set the CLASSPATH and invoke the Java loader.
+#{JAVA} -classpath $CP Jhove $ARGS -x org.apache.xerces.parsers.SAXParser
+#${JAVA} -classpath $CP Jhove $ARGS
+# New way, doesn't require you to use JAVA_HOME.
+java -classpath $CP Jhove $ARGS

jhove/jhove.tmpl

@@ -0,0 +1,54 @@
+#!/bin/sh
+
+########################################################################
+# JHOVE - JSTOR/Harvard Object Validation Environment
+# Copyright 2003-2004 by JSTOR and the President and Fellows of Harvard College
+# JHOVE is made available under the GNU General Public License (see the
+# file LICENSE for details)
+#
+# Copy jhove.tmpl to jhove, and replace the value of JHOVE_HOME with
+# the path to your jhove directory.
+#
+# Usage: jhove [-c config] [-m module [-p param]] [-h handler [-P param]]
+#              [-e encoding] [-H handler] [-o output] [-x saxclass]
+#              [-t tempdir] [-b bufsize] [[-krs] dir-file-or-uri [...]]
+#
+# where -c config   Configuration file pathname
+#       -m module   Module name
+#       -p param    Module-specific parameter
+#       -h handler  Output handler name (defaults to TEXT)
+#       -P param    Handler-specific parameter
+#       -o output   Output file pathname (defaults to standard output)
+#       -x saxclass SAX parser class (defaults to J2SE 1.4 default)
+#       -t tempdir  Temporary directory in which to create temporary files
+#       -b bufsize  Buffer size for buffered I/O (defaults to J2SE 1.4 default)
+#       -k          Calculate CRC32, MD5, and SHA-1 checksums
+#       -r          Display raw data flags, not textual equivalents
+#       -s          Format identification based on internal signatures only
+#       dir-file-or-uri Directory, file pathname or URI of formatted content
+#
+# Configuration constants:
+
+JHOVE_HOME=[your directory path]/jhove
+
+JAVA_HOME=/usr/java
+JAVA=/usr/bin/java
+
+#XTRA_JARS=/users/stephen/xercesImpl.jar
+EXTRA_JARS=              # Extra .jar files to add to CLASSPATH
+
+# NOTE: Nothing below this line should be edited
+########################################################################
+
+CP=${JHOVE_HOME}/bin/JhoveApp.jar:${EXTRA_JARS}
+
+# Retrieve a copy of all command line arguments to pass to the application.
+
+ARGS=""
+for ARG do
+    ARGS="$ARGS $ARG"
+done
+
+# Set the CLASSPATH and invoke the Java loader.
+#{JAVA} -classpath $CP Jhove $ARGS -x org.apache.xerces.parsers.SAXParser
+${JAVA} -classpath $CP Jhove $ARGS

jhove/jhove_bat.tmpl

@@ -0,0 +1,63 @@
+@ECHO OFF
+REM JHOVE - JSTOR/Harvard Object Validation Environment
+REM Copyright 2003-2005 by JSTOR and the President and Fellows of Harvard College
+REM JHOVE is made available under the GNU General Public License (see the
+REM file LICENSE for details)
+REM
+REM Usage: jhove [-c config] [-m module] [-h handler] [-e encoding]
+REM              [-H handler] [-o output] [-x saxclass] [-t tempdir]
+REM              [-b bufsize] [-l loglevel] [[-krs] dir-file-or-uri [...]]
+REM
+REM For Windows systems, copy jhove_bat.tmpl to jhove.bat and change
+REM the value of JHOVE_HOME to the path to your jhove directory.
+REM
+REM where -c config   Configuration file pathname
+REM       -m module   Module name
+REM       -h handler  Output handler name (defaults to TEXT)
+REM       -e encoding Character encoding of output handler (defaults to UTF-8)
+REM       -H handler  About handler name
+REM       -o output   Output file pathname (defaults to standard output)
+REM       -x saxclass SAX parser class (defaults to J2SE 1.4 default)
+REM       -t tempdir  Temporary directory in which to create temporary files
+REM       -b bufsize  Buffer size for buffered I/O (defaults to J2SE default)
+REM       -l loglevel Logging level
+REM       -k          Calculate CRC32, MD5, and SHA-1 checksums
+REM       -r          Display raw data flags, not textual equivalents
+REM       -s          Format identification based on internal signatures only
+REM       dir-file-or-uri Directory, file pathname, or URI of formatted content
+REM
+REM Configuration constants:
+REM JHOVE_HOME Jhove installation directory
+REM JAVA_HOME  Java JRE directory
+REM JAVA       Java interpreter
+REM EXTRA_JARS Extra jar files to add to CLASSPATH
+
+REM SET JHOVE_HOME="C:\Program Files\jhove"
+SET JHOVE_HOME="[your directory path]\jhove"
+
+SET JAVA_HOME="C:\Program Files\java\j2re1.4.1_02"
+SET JAVA=%JAVA_HOME%\bin\java
+
+SET EXTRA_JARS=
+
+REM NOTE: Nothing below this line should be edited
+REM #########################################################################
+
+
+SET CP=%JHOVE_HOME%\bin\JhoveApp.jar
+IF "%EXTRA_JARS%"=="" GOTO FI
+  SET CP=%CP%:%EXTRA_JARS
+:FI
+
+REM Retrieve a copy of all command line arguments to pass to the application
+
+SET ARGS=
+:WHILE
+IF "%1"=="" GOTO LOOP
+  SET ARGS=%ARGS% %1
+  SHIFT
+  GOTO WHILE
+:LOOP
+
+REM Set the CLASSPATH and invoke the Java loader
+%JAVA% -classpath %CP% Jhove %ARGS%

jhove/md5.pl

@@ -0,0 +1,14 @@
+#!/usr/bin/perl -w
+
+# Generate MD5 checksum
+
+use Digest::MD5;
+
+die "usage: md5.pl file\n" if $#ARGV < 0;
+
+open (FILE, "<$ARGV[0]") or die "can't open file\"$ARGV[0]\"!\n";
+$ctx = Digest::MD5->new->addfile (*FILE);
+close (FILE);
+$digest = $ctx->hexdigest;
+
+print "$digest\n";

jhove/packagejhove.sh

@@ -0,0 +1,44 @@
+#!/bin/sh
+#DO NOT RUN THIS ON A DEVELOPEMENT DIRECTORY, ONLY ON A 
+#CHECKED-OUT COPY TO BE PACKAGED!
+
+if [ "$1" = "" ]; then
+ echo "Usage: packagejhove.sh [version]"
+ echo "e.g., packagejhove.sh 1_8"
+ exit 1
+fi
+
+echo "This script will prepare your directory for uploading."
+echo "DO NOT RUN IT unless you're a developer and know what"
+echo "you are doing. "
+
+echo "Start in the top-level directory of the JHOVE checkout."
+echo "Run ant and ant javadoc and do any necessary testing and"
+echo "committing before running this script."
+echo 
+echo
+
+echo "To continue, enter the secret phrase."
+read OATH
+if [ "$OATH" != "I solemnly swear that I am up to no good" ]; then
+ exit 1
+fi
+
+cd ..
+cat >>CVSS << EOF
+CVS
+.cvsignore
+EOF
+tar cvfX jhove-$1.tar CVSS jhove
+gzip jhove-$1.tar
+cp -r jhove jhove-zip
+cd jhove-zip
+find . \( -name CVS -o -name .cvsignore \) -exec rm -r {} \;	
+cd ..
+mv jhove jhove-ok
+mv jhove-zip jhove
+zip -r jhove-$1.zip jhove
+rm -r jhove
+mv jhove-ok jhove
+jhove/md5.pl jhove-$1.tar.gz >jhove-$1.tar.gz.md5
+jhove/md5.pl jhove-$1.zip >jhove-$1.zip.md5 

jhove/pdump

@@ -0,0 +1,37 @@
+#!/bin/sh
+
+########################################################################
+# pdump - JSTOR/Harvard Object Validation Environment
+# Copyright 2003-2005 by JSTOR and the President and Fellows of Harvard College
+# JHOVE is made available under the GNU General Public License (see the
+# file LICENSE for details)
+#
+# Driver script for the PDF dump utility
+#
+# Usage: pdump file
+#
+# where  file  is a PDF file
+#
+# Configuration constants:
+
+JHOVE_HOME=/users/stephen/projects/jhove
+
+JAVA_HOME=/usr/java      # Java JRE directory
+JAVA=$JAVA_HOME/bin/java # Java interpreter
+
+EXTRA_JARS=              # Extra .jar files to add to CLASSPATH
+
+# NOTE: Nothing below this line should be edited
+########################################################################
+
+CP=${JHOVE_HOME}/bin/JhoveApp.jar:${EXTRA_JARS}
+
+# Retrieve a copy of all command line arguments to pass to the application.
+
+ARGS=""
+for ARG do
+    ARGS="$ARGS $ARG"
+done
+
+# Set the CLASSPATH and invoke the Java loader.
+${JAVA} -classpath $CP PDump $ARGS

jhove/userhome

@@ -0,0 +1,24 @@
+#!/bin/sh
+
+########################################################################
+# userhome - JSTOR/Harvard Object Validation Environment
+# Copyright 2004-2006 by the President and Fellows of Harvard College
+# JHOVE is made available under the GNU General Public License (see the
+# file LICENSE for details)
+#
+# Driver script to display the default Java user.home property
+#
+# Usage: userhome
+#
+# Configuration constants:
+
+JHOVE_HOME=/users/stephen/projects/jhove
+
+JAVA_HOME=/usr/java      # Java JRE directory
+JAVA=$JAVA_HOME/bin/java # Java interpreter
+
+# NOTE: Nothing below this line should be edited
+########################################################################
+
+# Set the CLASSPATH and invoke the Java loader.
+${JAVA} -classpath ${JHOVE_HOME}/classes UserHome

ocrmypdf/__init__.py

@@ -1,12 +0,0 @@
-from enum import IntEnum
-
-
-class ExitCode(IntEnum):
-    ok = 0
-    bad_args = 1
-    input_file = 2
-    missing_dependency = 3
-    invalid_output_pdfa = 4
-    file_access_error = 5
-    already_done_ocr = 6
-    other_error = 15

ocrmypdf/ghostscript.py

@@ -1,54 +0,0 @@
-#!/usr/bin/env python3
-# © 2015 James R. Barlow: github.com/jbarlow83
-
-from tempfile import NamedTemporaryFile
-from subprocess import Popen, PIPE, check_call
-from shutil import copy
-
-
-def rasterize_pdf(input_file, output_file, xres, yres, raster_device, log):
-    with NamedTemporaryFile(delete=True) as tmp:
-        args_gs = [
-            'gs',
-            '-dQUIET',
-            '-dBATCH',
-            '-dNOPAUSE',
-            '-sDEVICE=%s' % raster_device,
-            '-o', tmp.name,
-            '-r{0}x{1}'.format(str(xres), str(yres)),
-            input_file
-        ]
-
-        p = Popen(args_gs, close_fds=True, stdout=PIPE, stderr=PIPE,
-                  universal_newlines=True)
-        stdout, stderr = p.communicate()
-        if stdout:
-            log.debug(stdout)
-        if stderr:
-            log.error(stderr)
-
-        if p.returncode == 0:
-            copy(tmp.name, output_file)
-        else:
-            log.error('Ghostscript rendering failed')
-
-
-def generate_pdfa(pdf_pages, output_file, threads=1):
-    with NamedTemporaryFile(delete=True) as gs_pdf:
-        args_gs = [
-            "gs",
-            "-dQUIET",
-            "-dBATCH",
-            "-dNOPAUSE",
-            '-dNumRenderingThreads=' + str(threads),
-            "-sDEVICE=pdfwrite",
-            "-sColorConversionStrategy=/RGB",
-            "-sProcessColorModel=DeviceRGB",
-            "-dPDFA=2",
-            "-sPDFACompatibilityPolicy=2",
-            "-sOutputICCProfile=srgb.icc",
-            "-sOutputFile=" + gs_pdf.name,
-        ]
-        args_gs.extend(pdf_pages)
-        check_call(args_gs)
-        copy(gs_pdf.name, output_file)

ocrmypdf/hocrtransform.py

@@ -1,230 +0,0 @@
-#!/usr/local/bin/python3
-##############################################################################
-# Copyright (c) 2013-14: fritz-hh from Github
-#   (https://github.com/fritz-hh)
-#
-# Copyright (c) 2010: Jonathan Brinley from Github
-#   (https://github.com/jbrinley/HocrConverter)
-#   Initial version by Jonathan Brinley, jonathanbrinley@gmail.com
-##############################################################################
-from reportlab.pdfgen.canvas import Canvas
-from reportlab.lib.units import inch
-from xml.etree import ElementTree
-from PIL import Image
-from collections import namedtuple
-import re
-import argparse
-
-
-Rect = namedtuple('Rect', ['x1', 'y1', 'x2', 'y2'])
-
-
-class HocrTransformError(Exception):
-    pass
-
-
-class HocrTransform():
-
-    """
-    A class for converting documents from the hOCR format.
-    For details of the hOCR format, see:
-    http://docs.google.com/View?docid=dfxcv4vc_67g844kf
-    """
-
-    def __init__(self, hocrFileName, dpi):
-        self.dpi = dpi
-        self.boxPattern = re.compile(r'bbox((\s+\d+){4})')
-
-        self.hocr = ElementTree.parse(hocrFileName)
-
-        # if the hOCR file has a namespace, ElementTree requires its use to
-        # find elements
-        matches = re.match(r'({.*})html', self.hocr.getroot().tag)
-        self.xmlns = ''
-        if matches:
-            self.xmlns = matches.group(1)
-
-        # get dimension in pt (not pixel!!!!) of the OCRed image
-        self.width, self.height = None, None
-        for div in self.hocr.findall(
-                ".//%sdiv[@class='ocr_page']" % (self.xmlns)):
-            coords = self.element_coordinates(div)
-            pt_coords = self.pt_from_pixel(coords)
-            self.width = pt_coords.x2 - pt_coords.x1
-            self.height = pt_coords.y2 - pt_coords.y1
-            # there shouldn't be more than one, and if there is, we don't want
-            # it
-            break
-        if self.width is None or self.height is None:
-            raise HocrTransformError("hocr file is missing page dimensions")
-
-    def __str__(self):
-        """
-        Return the textual content of the HTML body
-        """
-        if self.hocr is None:
-            return ''
-        body = self.hocr.find(".//%sbody" % (self.xmlns))
-        if body:
-            return self._get_element_text(body)
-        else:
-            return ''
-
-    def _get_element_text(self, element):
-        """
-        Return the textual content of the element and its children
-        """
-        text = ''
-        if element.text is not None:
-            text += element.text
-        for child in element.getchildren():
-            text += self._get_element_text(child)
-        if element.tail is not None:
-            text += element.tail
-        return text
-
-    def element_coordinates(self, element):
-        """
-        Returns a tuple containing the coordinates of the bounding box around
-        an element
-        """
-        out = (0, 0, 0, 0)
-        if 'title' in element.attrib:
-            matches = self.boxPattern.search(element.attrib['title'])
-            if matches:
-                coords = matches.group(1).split()
-                out = Rect._make(int(coords[n]) for n in range(4))
-        return out
-
-    def pt_from_pixel(self, pxl):
-        """
-        Returns the quantity in PDF units (pt) given quantity in pixels
-        """
-        return Rect._make(
-            (c / self.dpi * inch) for c in pxl)
-
-    def replace_unsupported_chars(self, s):
-        """
-        Given an input string, returns the corresponding string that:
-        - is available in the helvetica facetype
-        - does not contain any ligature (to allow easy search in the PDF file)
-        """
-        # The 'u' before the character to replace indicates that it is a
-        # unicode character
-        s = s.replace(u"fl", "fl")
-        s = s.replace(u"fi", "fi")
-        return s
-
-    def to_pdf(self, outFileName, imageFileName=None, showBoundingboxes=False,
-               fontname="Helvetica", invisibleText=False):
-        """
-        Creates a PDF file with an image superimposed on top of the text.
-        Text is positioned according to the bounding box of the lines in
-        the hOCR file.
-        The image need not be identical to the image used to create the hOCR
-        file.
-        It can have a lower resolution, different color mode, etc.
-        """
-        # create the PDF file
-        # page size in points (1/72 in.)
-        pdf = Canvas(
-            outFileName, pagesize=(self.width, self.height), pageCompression=1)
-
-        # draw bounding box for each paragraph
-        # light blue for bounding box of paragraph
-        pdf.setStrokeColorRGB(0, 1, 1)
-        # light blue for bounding box of paragraph
-        pdf.setFillColorRGB(0, 1, 1)
-        pdf.setLineWidth(0)		# no line for bounding box
-        for elem in self.hocr.findall(
-                ".//%sp[@class='%s']" % (self.xmlns, "ocr_par")):
-
-            elemtxt = self._get_element_text(elem).rstrip()
-            if len(elemtxt) == 0:
-                continue
-
-            pxl_coords = self.element_coordinates(elem)
-            pt = self.pt_from_pixel(pxl_coords)
-
-            # draw the bbox border
-            if showBoundingboxes:
-                pdf.rect(
-                    pt.x1, self.height - pt.y2, pt.x2 - pt.x1, pt.y2 - pt.y1,
-                    fill=1)
-
-        # check if element with class 'ocrx_word' are available
-        # otherwise use 'ocr_line' as fallback
-        elemclass = "ocr_line"
-        if self.hocr.find(
-                ".//%sspan[@class='ocrx_word']" % (self.xmlns)) is not None:
-            elemclass = "ocrx_word"
-
-        # itterate all text elements
-        # light green for bounding box of word/line
-        pdf.setStrokeColorRGB(1, 0, 0)
-        pdf.setLineWidth(0.5)		# bounding box line width
-        pdf.setDash(6, 3)		# bounding box is dashed
-        pdf.setFillColorRGB(0, 0, 0)  # text in black
-        for elem in self.hocr.findall(
-                ".//%sspan[@class='%s']" % (self.xmlns, elemclass)):
-
-            elemtxt = self._get_element_text(elem).rstrip()
-
-            elemtxt = self.replace_unsupported_chars(elemtxt)
-
-            if len(elemtxt) == 0:
-                continue
-
-            pxl_coords = self.element_coordinates(elem)
-            pt = self.pt_from_pixel(pxl_coords)
-
-            # draw the bbox border
-            if showBoundingboxes:
-                pdf.rect(
-                    pt.x1, self.height - pt.y2, pt.x2 - pt.x1, pt.y2 - pt.y1,
-                    fill=0)
-
-            text = pdf.beginText()
-            fontsize = pt.y2 - pt.y1
-            text.setFont(fontname, fontsize)
-            if invisibleText:
-                text.setTextRenderMode(3)  # Invisible (indicates OCR text)
-
-            # set cursor to bottom left corner of bbox (adjust for dpi)
-            text.setTextOrigin(pt.x1, self.height - pt.y2)
-
-            # scale the width of the text to fill the width of the bbox
-            text.setHorizScale(
-                100 * (pt.x2 - pt.x1) / pdf.stringWidth(
-                    elemtxt, fontname, fontsize))
-
-            # write the text to the page
-            text.textLine(elemtxt)
-            pdf.drawText(text)
-
-        # put the image on the page, scaled to fill the page
-        if imageFileName is not None:
-            pdf.drawImage(imageFileName, 0, 0,
-                          width=self.width, height=self.height)
-
-        # finish up the page and save it
-        pdf.showPage()
-        pdf.save()
-
-
-if __name__ == "__main__":
-    parser = argparse.ArgumentParser(description='Convert hocr file to PDF')
-    parser.add_argument('-b', '--boundingboxes', action="store_true",
-                        default=False, help='Show bounding boxes borders')
-    parser.add_argument('-r', '--resolution', type=int,
-                        default=300,
-                        help='Resolution of the image that was OCRed')
-    parser.add_argument('-i', '--image', default=None,
-                        help='Path to the image to be placed above the text')
-    parser.add_argument('hocrfile', help='Path to the hocr file to be parsed')
-    parser.add_argument(
-        'outputfile', help='Path to the PDF file to be generated')
-    args = parser.parse_args()
-
-    hocr = HocrTransform(args.hocrfile, args.resolution)
-    hocr.to_pdf(args.outputfile, args.image, args.boundingboxes)

ocrmypdf/leptonica.py

@@ -1,331 +0,0 @@
-#!/usr/bin/env python2
-# -*- coding: utf-8 -*-
-#
-# © 2013-15: jbarlow83 from Github (https://github.com/jbarlow83)
-#
-#
-# Use Leptonica to detect find and remove page skew.  Leptonica uses the method
-# of differential square sums, which its author claim is faster and more robust
-# than the Hough transform used by ImageMagick.
-
-from __future__ import print_function, absolute_import, division
-import argparse
-import ctypes as C
-import sys
-import os
-import logging
-from tempfile import TemporaryFile
-
-logger = logging.getLogger(__name__)
-
-
-def stderr(*objs):
-    """Python 2/3 compatible print to stderr.
-    """
-    print("leptonica.py:", *objs, file=sys.stderr)
-
-
-from ctypes.util import find_library
-lept_lib = find_library('lept')
-if not lept_lib:
-    stderr("Could not find the Leptonica library")
-    sys.exit(3)
-try:
-    lept = C.cdll.LoadLibrary(lept_lib)
-except Exception:
-    stderr("Could not load the Leptonica library from %s", lept_lib)
-    sys.exit(3)
-
-
-class _PIXCOLORMAP(C.Structure):
-    """struct PixColormap from Leptonica src/pix.h
-    """
-
-    _fields_ = [
-        ("array", C.c_void_p),
-        ("depth", C.c_int32),
-        ("nalloc", C.c_int32),
-        ("n", C.c_int32)
-    ]
-
-
-class _PIX(C.Structure):
-    """struct Pix from Leptonica src/pix.h
-    """
-
-    _fields_ = [
-        ("w", C.c_uint32),
-        ("h", C.c_uint32),
-        ("d", C.c_uint32),
-        ("wpl", C.c_uint32),
-        ("refcount", C.c_uint32),
-        ("xres", C.c_int32),
-        ("yres", C.c_int32),
-        ("informat", C.c_int32),
-        ("text", C.POINTER(C.c_char)),
-        ("colormap", C.POINTER(_PIXCOLORMAP)),
-        ("data", C.POINTER(C.c_uint32))
-    ]
-
-
-PIX = C.POINTER(_PIX)
-
-lept.pixRead.argtypes = [C.c_char_p]
-lept.pixRead.restype = PIX
-lept.pixScale.argtypes = [PIX, C.c_float, C.c_float]
-lept.pixScale.restype = PIX
-lept.pixDeskew.argtypes = [PIX, C.c_int32]
-lept.pixDeskew.restype = PIX
-lept.pixFindSkew.argtypes = [PIX, C.POINTER(C.c_float), C.POINTER(C.c_float)]
-lept.pixFindSkew.restype = C.c_int32
-lept.pixWriteImpliedFormat.argtypes = [C.c_char_p, PIX, C.c_int32, C.c_int32]
-lept.pixWriteImpliedFormat.restype = C.c_int32
-lept.pixDestroy.argtypes = [C.POINTER(PIX)]
-lept.pixDestroy.restype = None
-lept.getLeptonicaVersion.argtypes = []
-lept.getLeptonicaVersion.restype = C.c_char_p
-
-
-class LeptonicaErrorTrap(object):
-    """Context manager to trap errors reported by Leptonica.
-
-    Leptonica's error return codes are unreliable to the point of being
-    almost useless.  It does, however, write errors to stderr provided that is
-    not disabled at its compile time.  Fortunately this is done using error
-    macros so it is very self-consistent.
-
-    This context manager redirects stderr to a temporary file which is then
-    read and parsed for error messages.  As a side benefit, debug messages
-    from Leptonica are also suppressed.
-
-    """
-    def __enter__(self):
-        self.tmpfile = TemporaryFile()
-
-        # Save the old stderr, and redirect stderr to temporary file
-        self.old_stderr_fileno = os.dup(sys.stderr.fileno())
-        os.dup2(self.tmpfile.fileno(), sys.stderr.fileno())
-        return
-
-    def __exit__(self, exc_type, exc_value, traceback):
-        # Restore old stderr
-        os.dup2(self.old_stderr_fileno, sys.stderr.fileno())
-
-        # Get data from tmpfile (in with block to ensure it is closed)
-        with self.tmpfile as tmpfile:
-            tmpfile.seek(0)  # Cursor will be at end, so move back to beginning
-            leptonica_output = tmpfile.read().decode(errors='replace')
-
-        # If there are Python errors, let them bubble up
-        if exc_type:
-            logger.warning(leptonica_output)
-            return False
-
-        # If there are Leptonica errors, wrap them in Python excpetions
-        if 'Error' in leptonica_output:
-            if 'image file not found' in leptonica_output:
-                raise FileNotFoundError()
-            if 'pixWrite: stream not opened' in leptonica_output:
-                raise LeptonicaIOError()
-            raise LeptonicaError(leptonica_output)
-
-        return False
-
-
-class LeptonicaError(Exception):
-    pass
-
-
-class LeptonicaIOError(LeptonicaError):
-    pass
-
-
-def pixRead(filename):
-    """Load an image file into a PIX object.
-
-    Leptonica can load TIFF, PNM (PBM, PGM, PPM), PNG, and JPEG.  If loading
-    fails then the object will wrap a C null pointer.
-
-    """
-    with LeptonicaErrorTrap():
-        return lept.pixRead(filename.encode(sys.getfilesystemencoding()))
-
-
-def pixScale(pix, scalex, scaley):
-    """Returns the pix object rescaled according to the proportions given."""
-    with LeptonicaErrorTrap():
-        return lept.pixScale(pix, scalex, scaley)
-
-
-def pixDeskew(pix, reduction_factor=0):
-    """Returns the deskewed pix object.
-
-    A clone of the original is returned when the algorithm cannot find a skew
-    angle with sufficient confidence.
-
-    reduction_factor -- amount to downsample (0 for default) when searching
-        for skew angle
-
-    """
-    with LeptonicaErrorTrap():
-        return lept.pixDeskew(pix, reduction_factor)
-
-
-def pixFindSkew(pix):
-    """Returns a tuple (deskew angle in degrees, confidence value).
-
-    Returns (None, None) if no angle is available.
-
-    """
-    with LeptonicaErrorTrap():
-        angle = C.c_float(0.0)
-        confidence = C.c_float(0.0)
-        result = lept.pixFindSkew(pix, C.byref(angle), C.byref(confidence))
-        if result == 0:
-            return (angle.value, confidence.value)
-        else:
-            return (None, None)
-
-
-def pixWriteImpliedFormat(filename, pix, jpeg_quality=0, jpeg_progressive=0):
-    """Write pix to the filename, with the extension indicating format.
-
-    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()),
-            pix, jpeg_quality, jpeg_progressive)
-
-    if fix_pnm:
-        from shutil import move
-        move(filename, filename[:-4])   # Remove .pnm suffix
-
-
-def pixDestroy(pix):
-    """Destroy the pix object.
-
-    Function signature is pixDestroy(struct Pix **), hence C.byref() to pass
-    the address of the pointer.
-
-    """
-    with LeptonicaErrorTrap():
-        lept.pixDestroy(C.byref(pix))
-
-
-def getLeptonicaVersion():
-    """Get Leptonica version string.
-
-    Caveat: Leptonica expects the caller to free this memory.  We don't,
-    since that would involve binding to libc to access libc.free(),
-    a pointless effort to reclaim 100 bytes of memory.
-
-    """
-    return lept.getLeptonicaVersion().decode()
-
-
-def deskew(infile, outfile, dpi):
-    try:
-        pix_source = pixRead(infile)
-    except LeptonicaIOError:
-        raise LeptonicaIOError("Failed to open file: %s" % infile)
-
-    if dpi < 150:
-        reduction_factor = 1  # Don't downsample too much if DPI is already low
-    else:
-        reduction_factor = 0  # Use default
-    pix_deskewed = pixDeskew(pix_source, reduction_factor)
-
-    try:
-        pixWriteImpliedFormat(outfile, pix_deskewed)
-    except LeptonicaIOError:
-        raise LeptonicaIOError("Failed to open destination file: %s" % outfile)
-    pixDestroy(pix_source)
-    pixDestroy(pix_deskewed)
-
-
-if __name__ == '__main__':
-    parser = argparse.ArgumentParser(
-        description="Python wrapper to access Leptonica")
-
-    subparsers = parser.add_subparsers(title='commands',
-                                       description='supported operations')
-
-    parser_deskew = subparsers.add_parser('deskew')
-    parser_deskew.add_argument('-r', '--dpi', dest='dpi', action='store',
-                               type=int, default=300, help='input resolution')
-    parser_deskew.add_argument('infile', help='image to deskew')
-    parser_deskew.add_argument('outfile', help='deskewed output image')
-    parser_deskew.set_defaults(func=deskew)
-
-    args = parser.parse_args()
-
-    if getLeptonicaVersion() != 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
-
-    im = Image.new(mode='1', size=(1000, 1000), color=1)
-
-    draw = ImageDraw.Draw(im)
-    for n in range(20):
-        draw.line([(50, 25 + 50*n), (950, 25 + 50*n)], width=1)
-    del draw
-
-    test_angles = [0.1 * ang for ang in range(1, 10)] + \
-                  [float(ang) for ang in range(1, 7)]
-    test_angles += [-ang for ang in test_angles]
-    test_angles = sorted(test_angles)
-
-    for rotate_angle in test_angles:
-        rotated_im = im.rotate(rotate_angle)
-        with NamedTemporaryFile(prefix='lept-skew', suffix='.png', delete=True) as tmpfile:
-            rotated_im.save(tmpfile)
-            pix = pixRead(tmpfile.name)
-            angle, confidence = pixFindSkew(pix)
-            pixDestroy(pix)
-            print('{0} {1}  {2}'.format(rotate_angle, angle, confidence), file=sys.stderr)
-
-

ocrmypdf/main.py

@@ -1,933 +0,0 @@
-#!/usr/bin/env python3
-# © 2015 James R. Barlow: github.com/jbarlow83
-
-from contextlib import suppress
-from tempfile import NamedTemporaryFile, mkdtemp
-import sys
-import os
-import re
-import shutil
-import warnings
-import multiprocessing
-import atexit
-import textwrap
-
-import PyPDF2 as pypdf
-from PIL import Image
-
-from subprocess import Popen, check_call, PIPE, CalledProcessError, \
-    TimeoutExpired, check_output, STDOUT
-try:
-    from subprocess import DEVNULL
-except ImportError:
-    DEVNULL = open(os.devnull, 'wb')
-
-
-from ruffus import transform, suffix, merge, active_if, regex, jobs_limit, \
-    formatter, follows, split, collate, check_if_uptodate
-import ruffus.ruffus_exceptions as ruffus_exceptions
-import ruffus.cmdline as cmdline
-
-from .hocrtransform import HocrTransform
-from .pageinfo import pdf_get_all_pageinfo
-from .pdfa import generate_pdfa_def
-from . import ghostscript
-from . import tesseract
-from . import ExitCode
-
-warnings.simplefilter('ignore', pypdf.utils.PdfReadWarning)
-
-
-BASEDIR = os.path.dirname(os.path.realpath(__file__))
-VERSION = '3.1'
-
-
-# -------------
-# External dependencies
-
-MINIMUM_TESS_VERSION = '3.02.02'
-
-
-def complain(message):
-    print(*textwrap.wrap(message), file=sys.stderr)
-
-
-if tesseract.version() < MINIMUM_TESS_VERSION:
-    complain(
-        "Please install tesseract {0} or newer "
-        "(currently installed version is {1})".format(
-            MINIMUM_TESS_VERSION, tesseract.version()))
-    sys.exit(ExitCode.missing_dependency)
-
-
-try:
-    import PIL.features
-    check_codec = PIL.features.check_codec
-except (ImportError, AttributeError):
-    def check_codec(codec_name):
-        if codec_name == 'jpg':
-            return 'jpeg_encoder' in dir(Image.core)
-        elif codec_name == 'zlib':
-            return 'zip_encoder' in dir(Image.core)
-        raise NotImplementedError(codec_name)
-
-
-def check_pil_encoder(codec_name, friendly_name):
-    try:
-        if check_codec(codec_name):
-            return
-    except Exception:
-        pass
-    complain(
-        "ERROR: Your version of the Python imaging library (Pillow) was "
-        "compiled without support for " + friendly_name + " encoding/decoding."
-        "\n"
-        "You will need to uninstall Pillow and reinstall it with PNG and JPEG "
-        "support (libjpeg and zlib)."
-        "\n"
-        "See installation instructions for your platform here:\n"
-        "    https://pillow.readthedocs.org/installation.html"
-    )
-    sys.exit(ExitCode.missing_dependency)
-
-
-check_pil_encoder('jpg', 'JPEG')
-check_pil_encoder('zlib', 'PNG')
-
-
-# -------------
-# Parser
-
-parser = cmdline.get_argparse(
-    prog="ocrmypdf",
-    description="Generate searchable PDF file from an image-only PDF file.",
-    version=VERSION,
-    fromfile_prefix_chars='@',
-    ignored_args=[
-        'touch_files_only', 'recreate_database', 'checksum_file_name',
-        'key_legend_in_graph', 'draw_graph_horizontally', 'flowchart_format',
-        'forced_tasks', 'target_tasks', 'use_threads'])
-
-parser.add_argument(
-    'input_file',
-    help="PDF file containing the images to be OCRed")
-parser.add_argument(
-    'output_file',
-    help="output searchable PDF file")
-parser.add_argument(
-    '-l', '--language', action='append',
-    help="languages of the file to be OCRed")
-
-metadata = parser.add_argument_group(
-    "Metadata options",
-    "Set output PDF/A metadata (default: use input document's title)")
-metadata.add_argument(
-    '--title', type=str,
-    help="set document title (place multiple words in quotes)")
-metadata.add_argument(
-    '--author', type=str,
-    help="set document author")
-metadata.add_argument(
-    '--subject', type=str,
-    help="set document")
-metadata.add_argument(
-    '--keywords', type=str,
-    help="set document keywords")
-
-
-preprocessing = parser.add_argument_group(
-    "Preprocessing options",
-    "Improve OCR quality and final image")
-preprocessing.add_argument(
-    '-d', '--deskew', action='store_true',
-    help="deskew each page before performing OCR")
-preprocessing.add_argument(
-    '-c', '--clean', action='store_true',
-    help="clean pages from scanning artifacts before performing OCR")
-preprocessing.add_argument(
-    '-i', '--clean-final', action='store_true',
-    help="incorporate the cleaned image in the final PDF file")
-preprocessing.add_argument(
-    '--oversample', metavar='DPI', type=int, default=0,
-    help="oversample images to at least the specified DPI, to improve OCR "
-         "results slightly")
-
-parser.add_argument(
-    '-f', '--force-ocr', action='store_true',
-    help="rasterize any fonts or vector images on each page and apply OCR")
-parser.add_argument(
-    '-s', '--skip-text', action='store_true',
-    help="skip OCR on any pages that already contain text, but include the"
-         " page in final output")
-parser.add_argument(
-    '--skip-big', type=float, metavar='MPixels',
-    help="skip OCR on pages larger than the specified amount of megapixels, "
-         "but include skipped pages in final output")
-# parser.add_argument(
-#     '--exact-image', action='store_true',
-#     help="Use original page from PDF without re-rendering")
-
-advanced = parser.add_argument_group(
-    "Advanced",
-    "Advanced options for power users")
-advanced.add_argument(
-    '--tesseract-config', default=[], type=list, action='append',
-    help="additional Tesseract configuration files")
-advanced.add_argument(
-    '--pdf-renderer', choices=['auto', 'tesseract', 'hocr'], default='auto',
-    help='choose OCR PDF renderer')
-advanced.add_argument(
-    '--tesseract-timeout', default=180.0, type=float,
-    help='give up on OCR after the timeout, but copy the preprocessed page '
-         'into the final output')
-
-debugging = parser.add_argument_group(
-    "Debugging",
-    "Arguments to help with troubleshooting and debugging")
-debugging.add_argument(
-    '-k', '--keep-temporary-files', action='store_true',
-    help="keep temporary files (helpful for debugging)")
-debugging.add_argument(
-    '-g', '--debug-rendering', action='store_true',
-    help="render each page twice with debug information on second page")
-
-options = parser.parse_args()
-
-
-# ----------
-# Languages
-
-if not options.language:
-    options.language = ['eng']  # Enforce English hegemony
-
-# Support v2.x "eng+deu" language syntax
-if '+' in options.language[0]:
-    options.language = options.language[0].split('+')
-
-if not set(options.language).issubset(tesseract.languages()):
-    complain(
-        "The installed version of tesseract does not have language "
-        "data for the following requested languages: ")
-    for lang in (set(options.language) - tesseract.languages()):
-        complain(lang)
-    sys.exit(ExitCode.bad_args)
-
-
-# ----------
-# Arguments
-
-if options.pdf_renderer == 'auto':
-    options.pdf_renderer = 'hocr'
-
-if any((options.deskew, options.clean, options.clean_final)):
-    try:
-        from . import unpaper
-    except ImportError:
-        complain(
-            "Install the 'unpaper' program to use --deskew or --clean.")
-        sys.exit(ExitCode.bad_args)
-else:
-    unpaper = None
-
-if options.debug_rendering and options.pdf_renderer == 'tesseract':
-    complain(
-        "Ignoring --debug-rendering because it is not supported with"
-        "--pdf-renderer=tesseract.")
-
-if options.force_ocr and options.skip_text:
-    complain(
-        "Error: --force-ocr and --skip-text are mutually incompatible.")
-    sys.exit(ExitCode.bad_args)
-
-if options.clean and not options.clean_final \
-        and options.pdf_renderer == 'tesseract':
-    complain(
-        "Tesseract PDF renderer cannot render --clean pages without "
-        "also performing --clean-final, so --clean-final is assumed.")
-
-
-# ----------
-# Logging
-
-
-_logger, _logger_mutex = cmdline.setup_logging(__name__, options.log_file,
-                                               options.verbose)
-
-
-class WrappedLogger:
-
-    def __init__(self, my_logger, my_mutex):
-        self.logger = my_logger
-        self.mutex = my_mutex
-
-    def log(self, *args, **kwargs):
-        with self.mutex:
-            self.logger.log(*args, **kwargs)
-
-    def debug(self, *args, **kwargs):
-        with self.mutex:
-            self.logger.debug(*args, **kwargs)
-
-    def info(self, *args, **kwargs):
-        with self.mutex:
-            self.logger.info(*args, **kwargs)
-
-    def warning(self, *args, **kwargs):
-        with self.mutex:
-            self.logger.warning(*args, **kwargs)
-
-    def error(self, *args, **kwargs):
-        with self.mutex:
-            self.logger.error(*args, **kwargs)
-
-    def critical(self, *args, **kwargs):
-        with self.mutex:
-            self.logger.critical(*args, **kwargs)
-
-_log = WrappedLogger(_logger, _logger_mutex)
-
-
-def re_symlink(input_file, soft_link_name, log=_log):
-    """
-    Helper function: relinks soft symbolic link if necessary
-    """
-    # Guard against soft linking to oneself
-    if input_file == soft_link_name:
-        log.debug("Warning: No symbolic link made. You are using " +
-                  "the original data directory as the working directory.")
-        return
-
-    # Soft link already exists: delete for relink?
-    if os.path.lexists(soft_link_name):
-        # do not delete or overwrite real (non-soft link) file
-        if not os.path.islink(soft_link_name):
-            raise Exception("%s exists and is not a link" % soft_link_name)
-        try:
-            os.unlink(soft_link_name)
-        except:
-            log.debug("Can't unlink %s" % (soft_link_name))
-
-    if not os.path.exists(input_file):
-        raise Exception("trying to create a broken symlink to %s" % input_file)
-
-    log.debug("os.symlink(%s, %s)" % (input_file, soft_link_name))
-
-    # Create symbolic link using absolute path
-    os.symlink(
-        os.path.abspath(input_file),
-        soft_link_name
-    )
-
-
-# -------------
-# The Pipeline
-
-manager = multiprocessing.Manager()
-_pdfinfo = manager.list()
-_pdfinfo_lock = manager.Lock()
-
-work_folder = mkdtemp(prefix="com.github.ocrmypdf.")
-
-
-@atexit.register
-def cleanup_working_files(*args):
-    if options.keep_temporary_files:
-        print("Temporary working files saved at:")
-        print(work_folder)
-    else:
-        with suppress(FileNotFoundError):
-            shutil.rmtree(work_folder)
-
-
-@transform(
-    input=options.input_file,
-    filter=formatter('(?i)\.pdf'),
-    output=work_folder + '{basename[0]}.repaired.pdf',
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def repair_pdf(
-        input_file,
-        output_file,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-    args_qpdf = [
-        'qpdf', input_file, output_file
-    ]
-    try:
-        out = check_output(args_qpdf, stderr=STDOUT, universal_newlines=True)
-    except CalledProcessError as e:
-        if e.returncode == 2:
-            print("{0}: not a valid PDF, and could not repair it.".format(
-                    options.input_file))
-            print("Details:")
-            print(e.output)
-        else:
-            print(e.output)
-        sys.exit(ExitCode.input_file)
-
-    log.debug(out)
-
-    with pdfinfo_lock:
-        pdfinfo.extend(pdf_get_all_pageinfo(output_file))
-        log.info(pdfinfo)
-
-
-def get_pageinfo(input_file, pdfinfo, pdfinfo_lock):
-    pageno = int(os.path.basename(input_file)[0:6]) - 1
-    with pdfinfo_lock:
-        pageinfo = pdfinfo[pageno].copy()
-    return pageinfo
-
-
-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(
-            "Page {0} has no images - skipping OCR".format(page)
-        )
-        ocr_required = False
-    elif pageinfo['has_text']:
-        s = "Page {0} 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)"))
-            sys.exit(ExitCode.already_done_ocr)
-        elif options.force_ocr:
-            log.info(s.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"))
-            ocr_required = False
-
-    if ocr_required and options.skip_big:
-        pixel_count = pageinfo['width_pixels'] * pageinfo['height_pixels']
-        if pixel_count > (options.skip_big * 1000000):
-            ocr_required = False
-            log.info(
-                "Page {0} is very large; skipping due to -b".format(page))
-
-    return ocr_required
-
-
-@split(
-    repair_pdf,
-    os.path.join(work_folder, '*.page.pdf'),
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def split_pages(
-        input_file,
-        output_files,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-
-    for oo in output_files:
-        with suppress(FileNotFoundError):
-            os.unlink(oo)
-
-    pages = check_output(['qpdf', '--show-npages', input_file],
-                         universal_newlines=True, close_fds=True)
-
-    for n in range(int(pages)):
-        args_qpdf = [
-            'qpdf', input_file,
-            '--pages', input_file, '{0}'.format(n + 1), '--',
-            os.path.join(work_folder, '{0:06d}.page.pdf'.format(n + 1))
-        ]
-        check_call(args_qpdf)
-
-    from glob import glob
-    for filename in glob(os.path.join(work_folder, '*.page.pdf')):
-        pageinfo = get_pageinfo(filename, pdfinfo, pdfinfo_lock)
-
-        alt_suffix = '.ocr.page.pdf' if is_ocr_required(pageinfo, log) \
-                     else '.skip.page.pdf'
-        re_symlink(
-            filename,
-            os.path.join(
-                work_folder,
-                os.path.basename(filename)[0:6] + alt_suffix))
-
-
-@transform(
-    input=split_pages,
-    filter=suffix('.ocr.page.pdf'),
-    output='.page.png',
-    output_dir=work_folder,
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def rasterize_with_ghostscript(
-        input_file,
-        output_file,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-    pageinfo = get_pageinfo(input_file, pdfinfo, pdfinfo_lock)
-
-    device = 'png16m'  # 24-bit
-    if all(image['comp'] == 1 for image in pageinfo['images']):
-        if all(image['bpc'] == 1 for image in pageinfo['images']):
-            device = 'pngmono'
-        elif all(image['bpc'] > 1 and image['color'] == 'index'
-                 for image in pageinfo['images']):
-            device = 'png256'
-        elif all(image['bpc'] > 1 and image['color'] == 'gray'
-                 for image in pageinfo['images']):
-            device = 'pnggray'
-
-    log.debug("Rendering {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)
-
-    ghostscript.rasterize_pdf(input_file, output_file, xres, yres, device, log)
-
-
-@transform(
-    input=rasterize_with_ghostscript,
-    filter=suffix(".page.png"),
-    output=".pp-deskew.png",
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def preprocess_deskew(
-        input_file,
-        output_file,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-
-    if not options.deskew:
-        re_symlink(input_file, output_file, log)
-        return
-
-    pageinfo = get_pageinfo(input_file, pdfinfo, pdfinfo_lock)
-    dpi = int(pageinfo['xres'])
-
-    unpaper.deskew(input_file, output_file, dpi, log)
-
-
-@transform(
-    input=preprocess_deskew,
-    filter=suffix(".pp-deskew.png"),
-    output=".pp-clean.png",
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def preprocess_clean(
-        input_file,
-        output_file,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-
-    if not options.clean:
-        re_symlink(input_file, output_file, log)
-        return
-
-    pageinfo = get_pageinfo(input_file, pdfinfo, pdfinfo_lock)
-    dpi = int(pageinfo['xres'])
-
-    unpaper.clean(input_file, output_file, dpi, log)
-
-
-@active_if(options.pdf_renderer == 'hocr')
-@transform(
-    input=preprocess_clean,
-    filter=suffix(".pp-clean.png"),
-    output=".hocr",
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def ocr_tesseract_hocr(
-        input_file,
-        output_file,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-
-    pageinfo = get_pageinfo(input_file, pdfinfo, pdfinfo_lock)
-
-    badxml = os.path.splitext(output_file)[0] + '.badxml'
-
-    args_tesseract = [
-        'tesseract',
-        '-l', '+'.join(options.language),
-        input_file,
-        badxml,
-        'hocr'
-    ] + options.tesseract_config
-    p = Popen(args_tesseract, close_fds=True, stdout=PIPE, stderr=PIPE,
-              universal_newlines=True)
-    try:
-        stdout, stderr = p.communicate(timeout=options.tesseract_timeout)
-    except TimeoutExpired:
-        p.kill()
-        stdout, stderr = 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_file, 'w', encoding="utf-8") as f:
-            f.write(tesseract.HOCR_TEMPLATE.format(
-                pageinfo['width_pixels'],
-                pageinfo['height_pixels']))
-    else:
-        if stdout:
-            log.info(stdout)
-        if stderr:
-            log.error(stderr)
-
-        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)
-        elif os.path.exists(badxml + '.hocr'):
-            # Tesseract 3.03 appends suffix ".hocr" on its own (.badxml.hocr)
-            shutil.move(badxml + '.hocr', badxml)
-
-        # Tesseract 3.03 inserts source filename into hocr file without
-        # escaping it, creating invalid XML and breaking the parser.
-        # As a workaround, rewrite the hocr file, replacing the filename
-        # with a space.  Don't know if Tesseract 3.02 does the same.
-
-        regex_nested_single_quotes = re.compile(
-            r"""title='image "([^"]*)";""")
-        with open(badxml, mode='r', encoding='utf-8') as f_in, \
-                open(output_file, mode='w', encoding='utf-8') as f_out:
-            for line in f_in:
-                line = regex_nested_single_quotes.sub(
-                    r"""title='image " ";""", line)
-                f_out.write(line)
-
-
-@active_if(options.pdf_renderer == 'hocr')
-@collate(
-    input=[rasterize_with_ghostscript, preprocess_deskew, preprocess_clean],
-    filter=regex(r".*/(\d{6})(?:\.page|\.pp-deskew|\.pp-clean)\.png"),
-    output=os.path.join(work_folder, r'\1.image'),
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def select_image_for_pdf(
-        infiles,
-        output_file,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-    if options.clean_final:
-        image_suffix = '.pp-clean.png'
-    elif options.deskew:
-        image_suffix = '.pp-deskew.png'
-    else:
-        image_suffix = '.page.png'
-    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 images were JPEGs originally, produce a JPEG as output
-        Image.open(image).save(output_file, format='JPEG')
-    else:
-        re_symlink(image, output_file)
-
-
-@active_if(options.pdf_renderer == 'hocr')
-@collate(
-    input=[select_image_for_pdf, ocr_tesseract_hocr],
-    filter=regex(r".*/(\d{6})(?:\.image|\.hocr)"),
-    output=os.path.join(work_folder, r'\1.rendered.pdf'),
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def render_hocr_page(
-        infiles,
-        output_file,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-    hocr = next(ii for ii in infiles if ii.endswith('.hocr'))
-    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))
-
-    hocrtransform = HocrTransform(hocr, dpi)
-    hocrtransform.to_pdf(output_file, imageFileName=image,
-                         showBoundingboxes=False, invisibleText=True)
-
-
-@active_if(options.pdf_renderer == 'hocr')
-@active_if(options.debug_rendering)
-@collate(
-    input=[select_image_for_pdf, ocr_tesseract_hocr],
-    filter=regex(r".*/(\d{6})(?:\.image|\.hocr)"),
-    output=os.path.join(work_folder, r'\1.debug.pdf'),
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def render_hocr_debug_page(
-        infiles,
-        output_file,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-    hocr = next(ii for ii in infiles if ii.endswith('.hocr'))
-    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))
-
-    hocrtransform = HocrTransform(hocr, dpi)
-    hocrtransform.to_pdf(output_file, imageFileName=None,
-                         showBoundingboxes=True, invisibleText=False)
-
-
-@active_if(options.pdf_renderer == 'tesseract')
-@collate(
-    input=[preprocess_clean, split_pages],
-    filter=regex(r".*/(\d{6})(?:\.pp-clean\.png|\.page\.pdf)"),
-    output=os.path.join(work_folder, r'\1.rendered.pdf'),
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def tesseract_ocr_and_render_pdf(
-        input_files,
-        output_file,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-
-    input_image = next((ii for ii in input_files if ii.endswith('.png')), '')
-    input_pdf = next((ii for ii in input_files if ii.endswith('.pdf')))
-    if not input_image:
-        # Skipping this page
-        re_symlink(input_pdf, output_file)
-        return
-
-    args_tesseract = [
-        'tesseract',
-        '-l', '+'.join(options.language),
-        input_image,
-        os.path.splitext(output_file)[0],  # Tesseract appends suffix
-        'pdf'
-    ] + options.tesseract_config
-    p = Popen(args_tesseract, close_fds=True, stdout=PIPE, stderr=PIPE,
-              universal_newlines=True)
-
-    try:
-        stdout, stderr = p.communicate(timeout=options.tesseract_timeout)
-        if stdout:
-            log.info(stdout)
-        if stderr:
-            log.error(stderr)
-    except TimeoutExpired:
-        p.kill()
-        log.info("Tesseract - page timed out")
-        re_symlink(input_pdf, output_file)
-
-
-@transform(
-    input=repair_pdf,
-    filter=suffix('.repaired.pdf'),
-    output='.pdfa_def.ps',
-    output_dir=work_folder,
-    extras=[_log])
-def generate_postscript_stub(
-        input_file,
-        output_file,
-        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())
-
-    generate_pdfa_def(output_file, pdfmark)
-
-
-@transform(
-    input=split_pages,
-    filter=suffix('.skip.page.pdf'),
-    output='.done.pdf',
-    output_dir=work_folder,
-    extras=[_log])
-def skip_page(
-        input_file,
-        output_file,
-        log):
-    re_symlink(input_file, output_file, log)
-
-
-@merge(
-    input=[render_hocr_page, 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(
-        input_files,
-        output_file,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-
-    def input_file_order(s):
-        '''Sort order: All rendered pages followed
-        by their debug page, if any, followed by Postscript stub.
-        Ghostscript documentation has the Postscript stub at the
-        beginning, but it works at the end and also gets document info
-        right that way.'''
-        if s.endswith('.ps'):
-            return 99999999
-        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.info(pdf_pages)
-    ghostscript.generate_pdfa(pdf_pages, output_file, options.jobs or 1)
-
-
-@transform(
-    input=merge_pages,
-    filter=formatter(),
-    output=options.output_file,
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def copy_final(
-        input_file,
-        output_file,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-    shutil.copy(input_file, output_file)
-
-
-def validate_pdfa(
-        input_file,
-        log):
-
-    args_qpdf = [
-        'qpdf',
-        '--check',
-        input_file
-    ]
-
-    try:
-        check_output(args_qpdf, stderr=STDOUT, universal_newlines=True)
-    except CalledProcessError as e:
-        if e.returncode == 2:
-            print("{0}: not a valid PDF, and could not repair it.".format(
-                    options.input_file))
-            print("Details:")
-            print(e.output)
-        elif e.returncode == 3:
-            log.info("qpdf --check returned warnings:")
-            log.info(e.output)
-        else:
-            print(e.output)
-        return False
-
-    return True
-
-
-# @active_if(ocr_required and options.exact_image)
-# @merge([render_hocr_blank_page, extract_single_page],
-#        os.path.join(work_folder, "%04i.merged.pdf") % pageno)
-# def merge_hocr_with_original_page(infiles, output_file):
-#     with open(infiles[0], 'rb') as hocr_input, \
-#             open(infiles[1], 'rb') as page_input, \
-#             open(output_file, 'wb') as output:
-#         hocr_reader = pypdf.PdfFileReader(hocr_input)
-#         page_reader = pypdf.PdfFileReader(page_input)
-#         writer = pypdf.PdfFileWriter()
-
-#         the_page = hocr_reader.getPage(0)
-#         the_page.mergePage(page_reader.getPage(0))
-#         writer.addPage(the_page)
-#         writer.write(output)
-
-
-def available_cpu_count():
-    try:
-        return multiprocessing.cpu_count()
-    except NotImplementedError:
-        pass
-
-    try:
-        import psutil
-        return psutil.cpu_count()
-    except (ImportError, AttributeError):
-        pass
-
-    complain(
-        "Could not get CPU count.  Assuming one (1) CPU."
-        "Use -j N to set manually.")
-    return 1
-
-
-def cleanup_ruffus_error_message(msg):
-    msg = re.sub(r'\s+', r' ', msg, re.MULTILINE)
-    msg = re.sub(r"\((.+?)\)", r'\1', msg)
-    msg = msg.strip()
-    return msg
-
-
-def run_pipeline():
-    if not options.jobs or options.jobs == 1:
-        options.jobs = available_cpu_count()
-    try:
-        cmdline.run(options)
-    except ruffus_exceptions.RethrownJobError as e:
-        if options.verbose:
-            print(e)
-
-        # 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
-
-        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
-
-    return ExitCode.ok
-
-
-if __name__ == '__main__':
-    sys.exit(run_pipeline())

ocrmypdf/pageinfo.py

@@ -1,166 +0,0 @@
-#!/usr/bin/env python3
-# © 2015 James R. Barlow: github.com/jbarlow83
-
-from subprocess import Popen, PIPE
-from decimal import Decimal, getcontext
-import re
-import sys
-import PyPDF2 as pypdf
-
-
-FRIENDLY_COLORSPACE = {
-    '/DeviceGray': 'gray',
-    '/CalGray': 'gray',
-    '/DeviceRGB': 'rgb',
-    '/CalRGB': 'rgb',
-    '/DeviceCMYK': 'cmyk',
-    '/Lab': 'lab',
-    '/ICCBased': 'icc',
-    '/Indexed': 'index',
-    '/Separation': 'sep',
-    '/DeviceN': 'devn',
-    '/Pattern': '-'
-}
-
-FRIENDLY_ENCODING = {
-    '/CCITTFaxDecode': 'ccitt',
-    '/DCTDecode': 'jpeg',
-    '/JPXDecode': 'jpx',
-    '/JBIG2Decode': 'jbig2',
-}
-
-FRIENDLY_COMP = {
-    'gray': 1,
-    'rgb': 3,
-    'cmyk': 4,
-    'lab': 3,
-    'index': 1
-}
-
-
-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
-
-    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
-
-
-def _find_page_images(page, pageinfo):
-    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['width'] = pdfimage['/Width']
-        image['height'] = pdfimage['/Height']
-        image['bpc'] = pdfimage['/BitsPerComponent']
-        if '/Filter' in pdfimage:
-            filter_ = pdfimage['/Filter']
-            if isinstance(filter_, pypdf.generic.ArrayObject):
-                filter_ = filter_[0]
-            image['enc'] = FRIENDLY_ENCODING.get(filter_, 'image')
-        else:
-            image['enc'] = 'image'
-        if '/ColorSpace' in pdfimage:
-            cs = pdfimage['/ColorSpace']
-            if isinstance(cs, pypdf.generic.ArrayObject):
-                cs = cs[0]
-            image['color'] = FRIENDLY_COLORSPACE.get(cs, '-')
-        else:
-            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']
-        image['dpi'] = (image['dpi_w'] * image['dpi_h']) ** Decimal(0.5)
-        yield image
-
-
-def _page_has_text(pdf, page):
-    # Simple test
-    text = page.extractText()
-    if text.strip() != '':
-        return True
-
-    # More nuanced test to deal with quirks of Tesseract PDF generation
-    # Check if there's a Glyphless font
-    try:
-        font = page['/Resources']['/Font']
-    except KeyError:
-        pass
-    else:
-        font_objects = list(font.keys())
-        for font_object in font_objects:
-            basefont = font[font_object]['/BaseFont']
-            if basefont.endswith('GlyphLessFont'):
-                return True
-
-    return False
-
-
-def _pdf_get_pageinfo(infile, page: int):
-    pageinfo = {}
-    pageinfo['pageno'] = page
-    pageinfo['images'] = []
-
-    pdf = pypdf.PdfFileReader(infile)
-    page = pdf.pages[page - 1]
-
-    pageinfo['has_text'] = _page_has_text(pdf, page)
-
-    width_pt = page['/MediaBox'][2] - page['/MediaBox'][0]
-    height_pt = page['/MediaBox'][3] - page['/MediaBox'][1]
-    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)]
-
-    # Look for inline images
-    if _page_has_inline_images(page):
-        raise NotImplementedError(
-            "Warning: input PDF contains inline images - not supported")
-
-    if pageinfo['images']:
-        xres = max(image['dpi_w'] for image in pageinfo['images'])
-        yres = max(image['dpi_h'] for image in pageinfo['images'])
-        pageinfo['xres'], pageinfo['yres'] = xres, yres
-        pageinfo['width_pixels'] = \
-            int(round(xres * pageinfo['width_inches']))
-        pageinfo['height_pixels'] = \
-            int(round(yres * pageinfo['height_inches']))
-
-    return pageinfo
-
-
-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)]

ocrmypdf/pdfa.py

@@ -1,134 +0,0 @@
-#!/usr/bin/env python3
-# © 2015 James R. Barlow: github.com/jbarlow83
-#
-# Generate a PDFA_def.ps file for Ghostscript >= 9.14
-
-from __future__ import print_function, absolute_import, division
-from string import Template
-from subprocess import Popen, PIPE
-import os
-import codecs
-
-
-# This is a template written in PostScript which is needed to create PDF/A
-# files, from the Ghostscript documentation. Lines beginning with % are
-# comments. Python substitution variables have a '$' prefix.
-pdfa_def_template = u"""%!
-% This is a sample prefix file for creating a PDF/A document.
-% Feel free to modify entries marked with "Customize".
-% This assumes an ICC profile to reside in the file (ISO Coated sb.icc),
-% unless the user modifies the corresponding line below.
-
-% Define entries in the document Info dictionary :
-/ICCProfile ($icc_profile)
-def
-
-[ /Title <$title>
-  /Author <$author>
-  /Subject <$subject>
-  /Keywords <$keywords>
-  /Creator <$creator>
-  /DOCINFO pdfmark
-
-% Define an ICC profile :
-
-[/_objdef {icc_PDFA} /type /stream /OBJ pdfmark
-[{icc_PDFA}
-<<
-  /N currentpagedevice /ProcessColorModel known {
-    currentpagedevice /ProcessColorModel get dup /DeviceGray eq
-    {pop 1} {
-      /DeviceRGB eq
-      {3}{4} ifelse
-    } ifelse
-  } {
-    (ERROR, unable to determine ProcessColorModel) == flush
-  } ifelse
->> /PUT pdfmark
-[{icc_PDFA} ICCProfile (r) file /PUT pdfmark
-
-% Define the output intent dictionary :
-
-[/_objdef {OutputIntent_PDFA} /type /dict /OBJ pdfmark
-[{OutputIntent_PDFA} <<
-  /Type /OutputIntent             % Must be so (the standard requires).
-  /S /GTS_PDFA1                   % Must be so (the standard requires).
-  /DestOutputProfile {icc_PDFA}            % Must be so (see above).
-  /OutputConditionIdentifier ($icc_identifier)
->> /PUT pdfmark
-[{Catalog} <</OutputIntents [ {OutputIntent_PDFA} ]>> /PUT pdfmark
-"""
-
-
-def encode_text_string(s: str) -> str:
-    '''Encode text string to hex string for use in a PDF
-
-    From PDF 32000-1:2008 a string object may be included in hexademical form
-    if it is enclosed in angle brackets.  For general Unicode the string should
-    be UTF-16 (big endian) with byte order marks.  A non-hexademical
-    representation is doable but this is preferable since it allows the output
-    Postscript file to be completely ASCII and no escaping of Postscript
-    characters is necessary.
-    '''
-    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()
-    return ascii_hex_str
-
-
-def _get_pdfa_def(icc_profile, icc_identifier, pdfmark):
-    pdfmark_utf16 = {k: encode_text_string(v) for k, v in pdfmark.items()}
-
-    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', ''))
-    return result
-
-
-def _get_postscript_icc_path():
-    "Parse Ghostscript's help message to find where iccprofiles are stored"
-
-    p_gs = Popen(['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')
-    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
-    with open(target_filename, 'w', encoding='ascii') as f:
-        f.write(ps)

ocrmypdf/tesseract.py

@@ -1,69 +0,0 @@
-#!/usr/bin/env python3
-# © 2015 James R. Barlow: github.com/jbarlow83
-
-from subprocess import STDOUT, CalledProcessError, check_output
-import sys
-import os
-import re
-from functools import lru_cache
-from . import ExitCode
-
-
-@lru_cache(maxsize=1)
-def version():
-    args_tess = [
-        'tesseract',
-        '--version'
-    ]
-    try:
-        versions = check_output(
-                args_tess, close_fds=True, universal_newlines=True,
-                stderr=STDOUT)
-    except CalledProcessError:
-        print("Could not find Tesseract executable on system PATH.")
-        sys.exit(ExitCode.missing_dependency)
-
-    tesseract_version = re.match(r'tesseract\s(.+)', versions).group(1)
-    return tesseract_version
-
-
-@lru_cache(maxsize=1)
-def languages():
-    args_tess = [
-        'tesseract',
-        '--list-langs'
-    ]
-    try:
-        langs = check_output(
-                args_tess, close_fds=True, universal_newlines=True,
-                stderr=STDOUT)
-    except CalledProcessError as e:
-        print("Tesseract failed to report available languages.")
-        print("Output from Tesseract:")
-        print("-" * 40)
-        print(e.output)
-        sys.exit(ExitCode.missing_dependency)
-    return set(lang.strip() for lang in langs.splitlines()[1:])
-
-
-HOCR_TEMPLATE = '''<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
-  <title></title>
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-  <meta name='ocr-system' content='tesseract 3.02.02' />
-  <meta name='ocr-capabilities' content='ocr_page ocr_carea ocr_par ocr_line ocrx_word'/>
- </head>
- <body>
-  <div class='ocr_page' id='page_1' title='image "x.tif"; bbox 0 0 {0} {1}; ppageno 0'>
-   <div class='ocr_carea' id='block_1_1' title="bbox 0 1 {0} {1}">
-    <p class='ocr_par' dir='ltr' id='par_1' title="bbox 0 1 {0} {1}">
-     <span class='ocr_line' id='line_1' title="bbox 0 1 {0} {1}"><span class='ocrx_word' id='word_1' title="bbox 0 1 {0} {1}"> </span>
-     </span>
-    </p>
-   </div>
-  </div>
- </body>
-</html>'''

ocrmypdf/test/test_pageinfo.py

@@ -1,111 +0,0 @@
-#!/usr/bin/env python3
-# © 2015 James R. Barlow: github.com/jbarlow83
-
-from ocrmypdf import pageinfo
-from reportlab.pdfgen.canvas import Canvas
-from PIL import Image
-from tempfile import NamedTemporaryFile
-from contextlib import suppress
-import os
-import shutil
-import pytest
-import img2pdf
-from pkg_resources import Requirement, resource_filename
-import pytest
-
-req = Requirement.parse('ocrmypdf')
-
-TEST_OUTPUT = os.environ.get(
-    'OCRMYPDF_TEST_OUTPUT',
-    default=os.path.join(os.path.dirname(__file__), 'output'))
-
-
-def setup_module():
-    with suppress(FileNotFoundError):
-        shutil.rmtree(TEST_OUTPUT)
-    with suppress(FileExistsError):
-        os.mkdir(TEST_OUTPUT)
-
-
-def test_single_page_text():
-    filename = os.path.join(TEST_OUTPUT, 'text.pdf')
-    pdf = Canvas(filename, pagesize=(8*72, 6*72))
-    text = pdf.beginText()
-    text.setFont('Helvetica', 12)
-    text.setTextOrigin(1*72, 3*72)
-    text.textLine("Methink'st thou art a general offence and every"
-                  " man should beat thee.")
-    pdf.drawText(text)
-    pdf.showPage()
-    pdf.save()
-
-    pdfinfo = pageinfo.pdf_get_all_pageinfo(filename)
-
-    assert len(pdfinfo) == 1
-    page = pdfinfo[0]
-
-    assert page['has_text']
-    assert len(page['images']) == 0
-
-
-def test_single_page_image():
-    filename = os.path.join(TEST_OUTPUT, 'image-mono.pdf')
-
-    with NamedTemporaryFile() as im_tmp:
-        im = Image.new('1', (8, 8), 0)
-        for n in range(8):
-            im.putpixel((n, n), 1)
-        im.save(im_tmp.name, format='PNG')
-
-        pdf_bytes = img2pdf.convert([im_tmp.name], dpi=8)
-        with open(filename, 'wb') as pdf:
-            pdf.write(pdf_bytes)
-
-    pdfinfo = pageinfo.pdf_get_all_pageinfo(filename)
-
-    assert len(pdfinfo) == 1
-    page = pdfinfo[0]
-
-    assert not page['has_text']
-    assert len(page['images']) == 1
-
-    pdfimage = page['images'][0]
-    assert pdfimage['width'] == 8
-    assert pdfimage['color'] == 'gray'
-
-    # While unexpected, this is correct
-    # PDF spec says /FlateDecode image must have /BitsPerComponent 8
-    # So mono images get upgraded to 8-bit
-    assert pdfimage['bpc'] == 8
-
-    # DPI in a 1"x1" is the image width
-    assert pdfimage['dpi_w'] == 8
-    assert pdfimage['dpi_h'] == 8
-
-
-def test_single_page_inline_image():
-    filename = os.path.join(TEST_OUTPUT, 'image-mono-inline.pdf')
-    pdf = Canvas(filename, pagesize=(8*72, 6*72))
-    with NamedTemporaryFile() as im_tmp:
-        im = Image.new('1', (8, 8), 0)
-        for n in range(8):
-            im.putpixel((n, n), 1)
-        im.save(im_tmp.name, format='PNG')
-        # Draw image in a 72x72 pt or 1"x1" area
-        pdf.drawInlineImage(im_tmp.name, 0, 0, width=72, height=72)
-        pdf.showPage()
-        pdf.save()
-
-    with pytest.raises(NotImplementedError):
-        pageinfo.pdf_get_all_pageinfo(filename)
-
-
-@pytest.mark.skipif(True, reason="need to fix packaging error")
-def test_jpeg():
-    filename = resource_filename(req, 'tests/resources/c02-22.pdf')
-
-    pdfinfo = pageinfo.pdf_get_all_pageinfo(filename)
-
-    pdfimage = pdfinfo[0]['images'][0]
-    assert pdfimage['enc'] == 'jpeg'
-

ocrmypdf/unpaper.py

@@ -1,102 +0,0 @@
-#!/usr/bin/env python3
-# © 2015 James R. Barlow: github.com/jbarlow83
-# unpaper documentation:
-# https://github.com/Flameeyes/unpaper/blob/master/doc/basic-concepts.md
-
-from subprocess import Popen, PIPE
-from tempfile import NamedTemporaryFile
-import sys
-import os
-from functools import lru_cache
-from . import ExitCode
-
-
-@lru_cache(maxsize=1)
-def version():
-    args_unpaper = [
-        'unpaper',
-        '--version'
-    ]
-    p_unpaper = Popen(args_unpaper, close_fds=True, universal_newlines=True,
-                      stdout=PIPE, stderr=PIPE)
-    version, _ = p_unpaper.communicate(timeout=5)
-
-    return version.strip()
-
-
-try:
-    from PIL import Image
-except ImportError:
-    print("Could not find Python3 imaging library", file=sys.stderr)
-    raise
-
-
-def run(input_file, output_file, dpi, log, mode_args):
-    args_unpaper = [
-        'unpaper',
-        '-v',
-        '--dpi', str(dpi)
-    ] + mode_args
-
-    SUFFIXES = {'1': '.pbm', 'L': '.pgm', 'RGB': '.ppm'}
-
-    im = Image.open(input_file)
-    if im.mode not in SUFFIXES.keys():
-        log.info("Converting image to other colorspace")
-        try:
-            if im.mode == 'P' and len(im.getcolors()) == 2:
-                im = im.convert(mode='1')
-            else:
-                im = im.convert(mode='RGB')
-        except IOError:
-            log.error(
-                    "Could not convert image with type " + im.mode)
-            sys.exit(ExitCode.missing_dependency)
-
-    try:
-        suffix = SUFFIXES[im.mode]
-    except KeyError:
-        log.error(
-                "Failed to convert image to a supported format.")
-        sys.exit(ExitCode.missing_dependency)
-
-    with NamedTemporaryFile(suffix=suffix) as input_pnm, \
-            NamedTemporaryFile(suffix=suffix, mode="r+b") as output_pnm:
-        im.save(input_pnm, format='PPM')
-        im.close()
-
-        os.unlink(output_pnm.name)
-
-        args_unpaper.extend([input_pnm.name, output_pnm.name])
-        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)
-
-
-def deskew(input_file, output_file, dpi, log):
-    run(input_file, output_file, dpi, log, [
-        '--mask-scan-size', '100',  # don't blank out narrow columns
-        '--no-border-align',  # don't align visible content to borders
-        '--no-mask-center',   # don't center visible content within page
-        '--no-grayfilter',    # don't remove light gray areas
-        '--no-blackfilter',   # don't remove solid black areas
-        '--no-noisefilter',   # don't remove salt and pepper noise
-        '--no-blurfilter'     # don't remove blurry objects/debris
-    ])
-
-
-def clean(input_file, output_file, dpi, log):
-    run(input_file, output_file, dpi, log, [
-        '--mask-scan-size', '100',  # don't blank out narrow columns
-        '--no-border-align',  # don't align visible content to borders
-        '--no-mask-center',   # don't center visible content within page
-        '--no-grayfilter',    # don't remove light gray areas
-        '--no-blackfilter',   # don't remove solid black areas
-        '--no-deskew',        # don't deskew
-    ])

pipeline.svg

@@ -1,235 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
- "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-<!-- Generated by graphviz version 2.38.0 (20140413.2041)
- -->
-<!-- Title: Pipeline: Pages: 1 -->
-<svg width="728pt" height="651pt"
- viewBox="0.00 0.00 728.00 650.53" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
-<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 646.53)">
-<title>Pipeline:</title>
-<polygon fill="white" stroke="none" points="-4,4 -4,-646.53 724,-646.53 724,4 -4,4"/>
-<g id="clust1" class="cluster"><title>clustertasks</title>
-<polygon fill="none" stroke="black" points="8,-8 8,-634.53 712,-634.53 712,-8 8,-8"/>
-<text text-anchor="middle" x="360" y="-606.53" font-family="Times,serif" font-size="30.00" fill="#ff3232">Pipeline:</text>
-</g>
-<!-- t0 -->
-<g id="node1" class="node"><title>t0</title>
-<polygon fill="#efa03b" stroke="#006000" points="481.791,-588.53 386.209,-588.53 382.209,-584.53 382.209,-552.53 477.791,-552.53 481.791,-556.53 481.791,-588.53"/>
-<polyline fill="none" stroke="#006000" points="477.791,-584.53 382.209,-584.53 "/>
-<polyline fill="none" stroke="#006000" points="477.791,-584.53 477.791,-552.53 "/>
-<polyline fill="none" stroke="#006000" points="477.791,-584.53 481.791,-588.53 "/>
-<text text-anchor="middle" x="432" y="-564.53" font-family="Times,serif" font-size="20.00" fill="#006000">repair_pdf</text>
-</g>
-<!-- t1 -->
-<g id="node2" class="node"><title>t1</title>
-<polygon fill="#efa03b" stroke="black" points="466.782,-509.564 374,-526.497 281.218,-509.564 281.304,-482.165 466.696,-482.165 466.782,-509.564"/>
-<polygon fill="none" stroke="black" points="470.799,-512.902 374,-530.569 277.201,-512.902 277.311,-478.159 470.689,-478.159 470.799,-512.902"/>
-<text text-anchor="middle" x="374" y="-495.991" font-family="Times,serif" font-size="20.00">split_pages</text>
-</g>
-<!-- t0&#45;&gt;t1 -->
-<g id="edge1" class="edge"><title>t0&#45;&gt;t1</title>
-<path fill="none" stroke="gray" d="M417.064,-552.394C412.296,-546.925 406.86,-540.689 401.493,-534.532"/>
-<polygon fill="gray" stroke="gray" points="403.996,-532.077 394.787,-526.838 398.719,-536.676 403.996,-532.077"/>
-</g>
-<!-- t10 -->
-<g id="node12" class="node"><title>t10</title>
-<polygon fill="#efa03b" stroke="#006000" points="704.338,-451.452 493.662,-451.452 489.662,-447.452 489.662,-415.452 700.338,-415.452 704.338,-419.452 704.338,-451.452"/>
-<polyline fill="none" stroke="#006000" points="700.338,-447.452 489.662,-447.452 "/>
-<polyline fill="none" stroke="#006000" points="700.338,-447.452 700.338,-415.452 "/>
-<polyline fill="none" stroke="#006000" points="700.338,-447.452 704.338,-451.452 "/>
-<text text-anchor="middle" x="597" y="-427.452" font-family="Times,serif" font-size="20.00" fill="#006000">generate_postscript_stub</text>
-</g>
-<!-- t0&#45;&gt;t10 -->
-<g id="edge16" class="edge"><title>t0&#45;&gt;t10</title>
-<path fill="none" stroke="gray" d="M453.048,-552.468C461.441,-545.654 471.185,-537.73 480,-530.53 510.227,-505.84 544.753,-477.467 568.421,-457.99"/>
-<polygon fill="gray" stroke="gray" points="570.818,-460.55 576.315,-451.493 566.369,-455.146 570.818,-460.55"/>
-</g>
-<!-- t2 -->
-<g id="node3" class="node"><title>t2</title>
-<polygon fill="#efa03b" stroke="black" points="451.555,-451.452 228.445,-451.452 224.445,-447.452 224.445,-415.452 447.555,-415.452 451.555,-419.452 451.555,-451.452"/>
-<polyline fill="none" stroke="black" points="447.555,-447.452 224.445,-447.452 "/>
-<polyline fill="none" stroke="black" points="447.555,-447.452 447.555,-415.452 "/>
-<polyline fill="none" stroke="black" points="447.555,-447.452 451.555,-451.452 "/>
-<text text-anchor="middle" x="338" y="-427.452" font-family="Times,serif" font-size="20.00">rasterize_with_ghostscript</text>
-</g>
-<!-- t1&#45;&gt;t2 -->
-<g id="edge2" class="edge"><title>t1&#45;&gt;t2</title>
-<path fill="none" stroke="#0044a0" d="M361.611,-478.092C358.514,-472.369 355.171,-466.19 352.003,-460.333"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="355.064,-458.636 347.227,-451.506 348.907,-461.967 355.064,-458.636"/>
-</g>
-<!-- t11 -->
-<g id="node10" class="node"><title>t11</title>
-<polygon fill="#efa03b" stroke="black" points="644.594,-393.452 551.406,-393.452 547.406,-389.452 547.406,-357.452 640.594,-357.452 644.594,-361.452 644.594,-393.452"/>
-<polyline fill="none" stroke="black" points="640.594,-389.452 547.406,-389.452 "/>
-<polyline fill="none" stroke="black" points="640.594,-389.452 640.594,-357.452 "/>
-<polyline fill="none" stroke="black" points="640.594,-389.452 644.594,-393.452 "/>
-<text text-anchor="middle" x="596" y="-369.452" font-family="Times,serif" font-size="20.00">skip_page</text>
-</g>
-<!-- t1&#45;&gt;t11 -->
-<g id="edge13" class="edge"><title>t1&#45;&gt;t11</title>
-<path fill="none" stroke="#0044a0" d="M425.139,-478.007C437.834,-470.731 450.731,-461.83 461,-451.452 473.874,-438.442 466.946,-427.178 481,-415.452 490.212,-407.766 513.965,-399.205 537.508,-392.067"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="538.592,-395.396 547.189,-389.203 536.607,-388.683 538.592,-395.396"/>
-</g>
-<!-- t9 -->
-<g id="node11" class="node"><title>t9</title>
-<polygon fill="#efa03b" stroke="black" points="272.496,-277.452 19.5039,-277.452 15.5039,-273.452 15.5039,-241.452 268.496,-241.452 272.496,-245.452 272.496,-277.452"/>
-<polyline fill="none" stroke="black" points="268.496,-273.452 15.5039,-273.452 "/>
-<polyline fill="none" stroke="black" points="268.496,-273.452 268.496,-241.452 "/>
-<polyline fill="none" stroke="black" points="268.496,-273.452 272.496,-277.452 "/>
-<text text-anchor="middle" x="144" y="-253.452" font-family="Times,serif" font-size="20.00">tesseract_ocr_and_render_pdf</text>
-</g>
-<!-- t1&#45;&gt;t9 -->
-<g id="edge15" class="edge"><title>t1&#45;&gt;t9</title>
-<path fill="none" stroke="#0044a0" d="M277.341,-486.044C254.708,-478.702 232.21,-467.759 215,-451.452 168.207,-407.114 152.056,-329.127 146.633,-287.855"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="150.084,-287.235 145.422,-277.721 143.133,-288.065 150.084,-287.235"/>
-</g>
-<!-- t3 -->
-<g id="node4" class="node"><title>t3</title>
-<polygon fill="#efa03b" stroke="black" points="458.999,-393.452 291.001,-393.452 287.001,-389.452 287.001,-357.452 454.999,-357.452 458.999,-361.452 458.999,-393.452"/>
-<polyline fill="none" stroke="black" points="454.999,-389.452 287.001,-389.452 "/>
-<polyline fill="none" stroke="black" points="454.999,-389.452 454.999,-357.452 "/>
-<polyline fill="none" stroke="black" points="454.999,-389.452 458.999,-393.452 "/>
-<text text-anchor="middle" x="373" y="-369.452" font-family="Times,serif" font-size="20.00">preprocess_deskew</text>
-</g>
-<!-- t2&#45;&gt;t3 -->
-<g id="edge3" class="edge"><title>t2&#45;&gt;t3</title>
-<path fill="none" stroke="#0044a0" d="M348.691,-415.346C351.337,-411.112 354.23,-406.485 357.066,-401.946"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="360.042,-403.788 362.374,-393.453 354.106,-400.078 360.042,-403.788"/>
-</g>
-<!-- t6 -->
-<g id="node6" class="node"><title>t6</title>
-<polygon fill="#efa03b" stroke="black" points="664.375,-277.452 477.625,-277.452 473.625,-273.452 473.625,-241.452 660.375,-241.452 664.375,-245.452 664.375,-277.452"/>
-<polyline fill="none" stroke="black" points="660.375,-273.452 473.625,-273.452 "/>
-<polyline fill="none" stroke="black" points="660.375,-273.452 660.375,-241.452 "/>
-<polyline fill="none" stroke="black" points="660.375,-273.452 664.375,-277.452 "/>
-<text text-anchor="middle" x="569" y="-253.452" font-family="Times,serif" font-size="20.00">select_image_for_pdf</text>
-</g>
-<!-- t2&#45;&gt;t6 -->
-<g id="edge7" class="edge"><title>t2&#45;&gt;t6</title>
-<path fill="none" stroke="#0044a0" d="M423.032,-415.374C438.812,-409.925 454.543,-402.785 468,-393.452 508.201,-365.571 539.287,-316.662 555.808,-286.558"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="559.024,-287.965 560.653,-277.496 552.851,-284.664 559.024,-287.965"/>
-</g>
-<!-- t4 -->
-<g id="node5" class="node"><title>t4</title>
-<polygon fill="#efa03b" stroke="black" points="449.705,-335.452 300.295,-335.452 296.295,-331.452 296.295,-299.452 445.705,-299.452 449.705,-303.452 449.705,-335.452"/>
-<polyline fill="none" stroke="black" points="445.705,-331.452 296.295,-331.452 "/>
-<polyline fill="none" stroke="black" points="445.705,-331.452 445.705,-299.452 "/>
-<polyline fill="none" stroke="black" points="445.705,-331.452 449.705,-335.452 "/>
-<text text-anchor="middle" x="373" y="-311.452" font-family="Times,serif" font-size="20.00">preprocess_clean</text>
-</g>
-<!-- t3&#45;&gt;t4 -->
-<g id="edge4" class="edge"><title>t3&#45;&gt;t4</title>
-<path fill="none" stroke="#0044a0" d="M373,-357.346C373,-353.655 373,-349.665 373,-345.695"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="376.5,-345.453 373,-335.453 369.5,-345.453 376.5,-345.453"/>
-</g>
-<!-- t3&#45;&gt;t6 -->
-<g id="edge6" class="edge"><title>t3&#45;&gt;t6</title>
-<path fill="none" stroke="#0044a0" d="M414.399,-357.412C428.785,-351.039 444.852,-343.405 459,-335.452 466.909,-331.007 506.49,-303.805 535.921,-283.431"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="538.073,-286.198 544.299,-277.625 534.086,-280.444 538.073,-286.198"/>
-</g>
-<!-- t4&#45;&gt;t6 -->
-<g id="edge5" class="edge"><title>t4&#45;&gt;t6</title>
-<path fill="none" stroke="#0044a0" d="M432.605,-299.422C453.701,-293.395 477.617,-286.561 499.465,-280.319"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="500.687,-283.61 509.341,-277.497 498.764,-276.879 500.687,-283.61"/>
-</g>
-<!-- t5 -->
-<g id="node7" class="node"><title>t5</title>
-<polygon fill="#efa03b" stroke="black" points="455.922,-277.452 294.078,-277.452 290.078,-273.452 290.078,-241.452 451.922,-241.452 455.922,-245.452 455.922,-277.452"/>
-<polyline fill="none" stroke="black" points="451.922,-273.452 290.078,-273.452 "/>
-<polyline fill="none" stroke="black" points="451.922,-273.452 451.922,-241.452 "/>
-<polyline fill="none" stroke="black" points="451.922,-273.452 455.922,-277.452 "/>
-<text text-anchor="middle" x="373" y="-253.452" font-family="Times,serif" font-size="20.00">ocr_tesseract_hocr</text>
-</g>
-<!-- t4&#45;&gt;t5 -->
-<g id="edge8" class="edge"><title>t4&#45;&gt;t5</title>
-<path fill="none" stroke="#0044a0" d="M373,-299.346C373,-295.655 373,-291.665 373,-287.695"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="376.5,-287.453 373,-277.453 369.5,-287.453 376.5,-287.453"/>
-</g>
-<!-- t4&#45;&gt;t9 -->
-<g id="edge14" class="edge"><title>t4&#45;&gt;t9</title>
-<path fill="none" stroke="#0044a0" d="M303.36,-299.422C278.157,-293.259 249.509,-286.253 223.521,-279.898"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="224.249,-276.473 213.704,-277.497 222.586,-283.273 224.249,-276.473"/>
-</g>
-<!-- t7 -->
-<g id="node8" class="node"><title>t7</title>
-<polygon fill="#efa03b" stroke="black" points="426.366,-219.452 269.634,-219.452 265.634,-215.452 265.634,-183.452 422.366,-183.452 426.366,-187.452 426.366,-219.452"/>
-<polyline fill="none" stroke="black" points="422.366,-215.452 265.634,-215.452 "/>
-<polyline fill="none" stroke="black" points="422.366,-215.452 422.366,-183.452 "/>
-<polyline fill="none" stroke="black" points="422.366,-215.452 426.366,-219.452 "/>
-<text text-anchor="middle" x="346" y="-195.452" font-family="Times,serif" font-size="20.00">render_hocr_page</text>
-</g>
-<!-- t6&#45;&gt;t7 -->
-<g id="edge9" class="edge"><title>t6&#45;&gt;t7</title>
-<path fill="none" stroke="#0044a0" d="M501.184,-241.422C476.75,-235.286 448.99,-228.315 423.772,-221.982"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="424.429,-218.538 413.877,-219.497 422.724,-225.328 424.429,-218.538"/>
-</g>
-<!-- t8 -->
-<g id="node9" class="node"><title>t8</title>
-<polygon fill="#efa03b" stroke="black" points="663.742,-219.452 448.258,-219.452 444.258,-215.452 444.258,-183.452 659.742,-183.452 663.742,-187.452 663.742,-219.452"/>
-<polyline fill="none" stroke="black" points="659.742,-215.452 444.258,-215.452 "/>
-<polyline fill="none" stroke="black" points="659.742,-215.452 659.742,-183.452 "/>
-<polyline fill="none" stroke="black" points="659.742,-215.452 663.742,-219.452 "/>
-<text text-anchor="middle" x="554" y="-195.452" font-family="Times,serif" font-size="20.00">render_hocr_debug_page</text>
-</g>
-<!-- t6&#45;&gt;t8 -->
-<g id="edge11" class="edge"><title>t6&#45;&gt;t8</title>
-<path fill="none" stroke="#0044a0" d="M564.418,-241.346C563.4,-237.546 562.298,-233.43 561.203,-229.345"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="564.522,-228.207 558.554,-219.453 557.761,-230.018 564.522,-228.207"/>
-</g>
-<!-- t5&#45;&gt;t7 -->
-<g id="edge10" class="edge"><title>t5&#45;&gt;t7</title>
-<path fill="none" stroke="#0044a0" d="M364.752,-241.346C362.816,-237.329 360.708,-232.958 358.629,-228.645"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="361.693,-226.941 354.197,-219.453 355.387,-229.981 361.693,-226.941"/>
-</g>
-<!-- t5&#45;&gt;t8 -->
-<g id="edge12" class="edge"><title>t5&#45;&gt;t8</title>
-<path fill="none" stroke="#0044a0" d="M428.289,-241.346C447.587,-235.375 469.416,-228.622 489.404,-222.437"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="490.53,-225.753 499.049,-219.453 488.461,-219.065 490.53,-225.753"/>
-</g>
-<!-- t12 -->
-<g id="node13" class="node"><title>t12</title>
-<polygon fill="#efa03b" stroke="black" points="473.845,-105.456 554,-78.0208 634.155,-105.456 634.08,-149.848 473.92,-149.848 473.845,-105.456"/>
-<polygon fill="none" stroke="black" points="469.836,-102.581 554,-73.7729 638.164,-102.581 638.078,-153.869 469.922,-153.869 469.836,-102.581"/>
-<text text-anchor="middle" x="554" y="-111.726" font-family="Times,serif" font-size="20.00">merge_pages</text>
-</g>
-<!-- t7&#45;&gt;t12 -->
-<g id="edge20" class="edge"><title>t7&#45;&gt;t12</title>
-<path fill="none" stroke="#0044a0" d="M389.35,-183.419C409.937,-175.33 435.398,-165.326 460.092,-155.624"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="461.479,-158.839 469.507,-151.924 458.919,-152.324 461.479,-158.839"/>
-</g>
-<!-- t8&#45;&gt;t12 -->
-<g id="edge19" class="edge"><title>t8&#45;&gt;t12</title>
-<path fill="none" stroke="#0044a0" d="M554,-183.12C554,-177.585 554,-171.177 554,-164.592"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="557.5,-164.201 554,-154.201 550.5,-164.201 557.5,-164.201"/>
-</g>
-<!-- t11&#45;&gt;t12 -->
-<g id="edge17" class="edge"><title>t11&#45;&gt;t12</title>
-<path fill="none" stroke="#0044a0" d="M615.939,-357.13C634.767,-339.333 661.745,-309.733 673,-277.452 686.754,-238.003 694.347,-219.364 673,-183.452 666.345,-172.256 656.999,-162.875 646.44,-155.047"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="648.378,-152.132 638.152,-149.36 644.417,-157.904 648.378,-152.132"/>
-</g>
-<!-- t9&#45;&gt;t12 -->
-<g id="edge18" class="edge"><title>t9&#45;&gt;t12</title>
-<path fill="none" stroke="#0044a0" d="M164.711,-241.235C186.394,-224.08 222.088,-198.224 257,-183.452 321.895,-155.994 399.893,-139.571 459.67,-130.141"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="460.504,-133.554 469.855,-128.574 459.439,-126.635 460.504,-133.554"/>
-</g>
-<!-- t10&#45;&gt;t12 -->
-<g id="edge22" class="edge"><title>t10&#45;&gt;t12</title>
-<path fill="none" stroke="gray" d="M629.379,-415.337C660.552,-396.255 703,-362.233 703,-318.452 703,-318.452 703,-318.452 703,-258.452 703,-224.066 705.581,-210.223 684,-183.452 673.976,-171.017 660.952,-160.773 647.026,-152.396"/>
-<polygon fill="gray" stroke="gray" points="648.682,-149.312 638.258,-147.419 645.227,-155.4 648.682,-149.312"/>
-</g>
-<!-- t13 -->
-<g id="node14" class="node"><title>t13</title>
-<polygon fill="#efa03b" stroke="black" points="616.338,-52 495.662,-52 491.662,-48 491.662,-16 612.338,-16 616.338,-20 616.338,-52"/>
-<polyline fill="none" stroke="black" points="612.338,-48 491.662,-48 "/>
-<polyline fill="none" stroke="black" points="612.338,-48 612.338,-16 "/>
-<polyline fill="none" stroke="black" points="612.338,-48 616.338,-52 "/>
-<text text-anchor="middle" x="554" y="-28" font-family="Times,serif" font-size="20.00">validate_pdfa</text>
-</g>
-<!-- t12&#45;&gt;t13 -->
-<g id="edge21" class="edge"><title>t12&#45;&gt;t13</title>
-<path fill="none" stroke="#0044a0" d="M554,-73.9482C554,-69.9654 554,-66.007 554,-62.2247"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="557.5,-62.1573 554,-52.1573 550.5,-62.1574 557.5,-62.1573"/>
-</g>
-</g>
-</svg>

requirements.txt

@@ -1,4 +0,0 @@
-ruffus>=2.6.3
-Pillow>=2.4.0
-reportlab>=3.1.44
-PyPDF2>=1.25.1

setup.cfg

@@ -1,4 +0,0 @@
-[bdist_wheel]
-python-tag = py34
-[pytest]
-norecursedirs = lib 

setup.py

@@ -1,214 +0,0 @@
-#!/usr/bin/env python3
-# © 2015 James R. Barlow: github.com/jbarlow83
-
-from setuptools import setup
-from subprocess import Popen, STDOUT, check_output, CalledProcessError
-from string import Template
-from collections.abc import Mapping
-import re
-import sys
-
-
-missing_program = '''
-The program '{program}' could not be executed or was not found on your
-system PATH.
-'''
-
-unknown_version = '''
-OCRmyPDF requires '{program}' {need_version} or higher.  Your system has
-'{program}' but we cannot tell what version is installed.  Contact the
-package maintainer.
-'''
-
-old_version = '''
-OCRmyPDF requires '{program}' {need_version} or higher.  Your system appears
-to have {found_version}.  Please update this program.
-'''
-
-okay_its_optional = '''
-This program is OPTIONAL, so installation of OCRmyPDF can proceed, but
-some functionality may be missing.
-'''
-
-not_okay_its_required = '''
-This program is REQUIRED for OCRmyPDF to work.  Installation will abort.
-'''
-
-osx_install_advice = '''
-If you have homebrew installed, try these command to install the missing
-packages:
-    brew update
-    brew upgrade
-    brew install {package}
-'''
-
-linux_install_advice = '''
-On systems with the aptitude package manager (Debian, Ubuntu), try these
-commands:
-    sudo apt-get update
-    sudo apt-get install {package}
-
-On RPM-based systems (Red Hat, Fedora), search for instructions on
-installing the RPM for {program}.
-'''
-
-
-def get_platform():
-    if sys.platform.startswith('freebsd'):
-        return 'freebsd'
-    elif sys.platform.startswith('linux'):
-        return 'linux'
-    return sys.platform
-
-
-def _error_trailer(program, package, optional, **kwargs):
-    if optional:
-        print(okay_its_optional.format(**locals()), file=sys.stderr)
-    else:
-        print(not_okay_its_required.format(**locals()), file=sys.stderr)
-
-    if isinstance(package, Mapping):
-        package = package[get_platform()]
-
-    if get_platform() == 'darwin':
-        print(osx_install_advice.format(**locals()), file=sys.stderr)
-    elif get_platform() == 'linux':
-        print(linux_install_advice.format(**locals()), file=sys.stderr)
-
-
-def error_missing_program(
-        program,
-        package,
-        optional
-        ):
-    print(missing_program.format(**locals()), file=sys.stderr)
-    _error_trailer(**locals())
-
-
-def error_unknown_version(
-        program,
-        package,
-        optional,
-        need_version
-        ):
-    print(unknown_version.format(**locals()), file=sys.stderr)
-    _error_trailer(**locals())
-
-
-def error_old_version(
-        program,
-        package,
-        optional,
-        need_version,
-        found_version
-        ):
-    print(old_version.format(**locals()), file=sys.stderr)
-    _error_trailer(**locals())
-
-
-def check_external_program(
-        program,
-        need_version,
-        package,
-        version_check_args=['--version'],
-        version_scrape_regex=re.compile(r'(\d+\.\d+(?:\.\d+)?)'),
-        optional=False):
-
-    print('Checking for {program} >= {need_version}...'.format(
-            program=program, need_version=need_version))
-    try:
-        result = check_output(
-                [program] + version_check_args,
-                universal_newlines=True, stderr=STDOUT)
-    except (CalledProcessError, FileNotFoundError):
-        error_missing_program(program, package, optional)
-        if not optional:
-            sys.exit(1)
-        print('Continuing install without {program}'.format(program=program))
-        return
-
-    try:
-        found_version = version_scrape_regex.search(result).group(1)
-    except AttributeError:
-        error_unknown_version(program, package, optional, need_version)
-        sys.exit(1)
-
-    if found_version < need_version:
-        error_old_version(program, package, optional, need_version,
-                          found_version)
-
-    print('Found {program} {found_version}'.format(
-            program=program, found_version=found_version))
-
-
-command = next((arg for arg in sys.argv[1:] if not arg.startswith('-')), '')
-
-
-if command.startswith('install') or \
-        command in ['check', 'test', 'nosetests', 'easy_install', 'egg_info']:
-    check_external_program(
-        program='tesseract',
-        need_version='3.02.02',
-        package={'darwin': 'tesseract', 'linux': 'tesseract-ocr'}
-    )
-    check_external_program(
-        program='gs',
-        need_version='9.14',
-        package='ghostscript'
-    )
-    check_external_program(
-        program='unpaper',
-        need_version='6.1',
-        package='unpaper',
-        optional=True
-    )
-    check_external_program(
-        program='qpdf',
-        need_version='5.0.0',
-        package='qpdf',
-        version_check_args=['--version']
-    )
-
-
-if 'upload' in sys.argv[1:]:
-    print('Use twine to upload the package - setup.py upload is insecure')
-    sys.exit(1)
-
-install_requires = open('requirements.txt').read().splitlines()
-tests_require = open('test_requirements.txt').read().splitlines()
-
-setup(
-    name='ocrmypdf',
-    version='3.1',  # also update: release notes, main.py
-    description='OCRmyPDF adds an OCR text layer to scanned PDF files, allowing them to be searched',
-    url='https://github.com/jbarlow83/OCRmyPDF',
-    author='James R. Barlow',
-    author_email='jim@purplerock.ca',
-    license='Public Domain',
-    packages=['ocrmypdf'],
-    keywords=['PDF', 'OCR', 'optical character recognition', 'PDF/A', 'scanning'],
-    classifiers=[
-        "Programming Language :: Python :: 3",
-        "Development Status :: 5 - Production/Stable",
-        "Environment :: Console",
-        "Intended Audience :: End Users/Desktop",
-        "Intended Audience :: Science/Research",
-        "Intended Audience :: System Administrators",
-        "License :: Public Domain",
-        "Operating System :: MacOS :: MacOS X",
-        "Operating System :: POSIX",
-        "Operating System :: POSIX :: BSD",
-        "Operating System :: POSIX :: Linux",
-        "Topic :: Scientific/Engineering :: Image Recognition",
-        "Topic :: Text Processing :: Indexing",
-        "Topic :: Text Processing :: Linguistic",
-        ],
-    install_requires=install_requires,
-    tests_require=tests_require,
-    entry_points={
-        'console_scripts': [
-            'ocrmypdf = ocrmypdf.main:run_pipeline'
-        ],
-    },
-    include_package_data=True,
-    zip_safe=False)

src/hocrTransform.py

@@ -0,0 +1,183 @@
+##############################################################################
+# Copyright (c) 2013: fritz-hh from Github (https://github.com/fritz-hh)
+#
+# Copyright (c) 2010: Jonathan Brinley from Github (https://github.com/jbrinley/HocrConverter)
+# Initial version by Jonathan Brinley, jonathanbrinley@gmail.com
+##############################################################################
+from reportlab.pdfgen.canvas import Canvas
+from reportlab.lib.units import inch
+from lxml import etree as ElementTree
+import Image, re, sys
+import argparse
+
+class hocrTransform():
+	"""
+	A class for converting documents from the hOCR format.
+	For details of the hOCR format, see:
+	http://docs.google.com/View?docid=dfxcv4vc_67g844kf
+	"""
+	def __init__(self, hocrFileName, dpi):
+		self.dpi = dpi
+		self.boxPattern = re.compile('bbox((\s+\d+){4})')
+
+		self.hocr = ElementTree.ElementTree()
+		self.hocr.parse(hocrFileName)
+ 
+		# if the hOCR file has a namespace, ElementTree requires its use to find elements
+		matches = re.match('({.*})html', self.hocr.getroot().tag)
+		self.xmlns = ''
+		if matches:
+			self.xmlns = matches.group(1)
+			
+		# get dimension in pt (not pixel!!!!) of the OCRed image
+		for div in self.hocr.findall(".//%sdiv[@class='ocr_page']"%(self.xmlns)):
+			coords = self.element_coordinates(div)
+			self.width = self.px2pt(coords[2]-coords[0])
+			self.height = self.px2pt(coords[3]-coords[1])
+			break # there shouldn't be more than one, and if there is, we don't want it
+			
+		# no width and heigh definition in the ocr_image element of the hocr file
+		if self.width is None:
+			print "No page dimension found in the hocr file"
+			sys.exit(1)
+
+	def __str__(self):
+		"""
+		Return the textual content of the HTML body
+		"""
+		if self.hocr is None:
+			return ''
+		body = self.hocr.find(".//%sbody"%(self.xmlns))
+		if body:
+			return self._get_element_text(body).encode('utf-8') # XML gives unicode
+		else:
+			return ''
+  
+	def _get_element_text(self, element):
+		"""
+		Return the textual content of the element and its children
+		"""
+		text = ''
+		if element.text is not None:
+			text = text + element.text
+		for child in element.getchildren():
+			text = text + self._get_element_text(child)
+		if element.tail is not None:
+			text = text + element.tail
+		return text
+    
+	def element_coordinates(self, element):
+		"""
+		Returns a tuple containing the coordinates of the bounding box around
+		an element
+		"""
+		out = (0,0,0,0)
+		if 'title' in element.attrib:
+			matches = self.boxPattern.search(element.attrib['title'])
+			if matches:
+				coords = matches.group(1).split()
+				out = (int(coords[0]),int(coords[1]),int(coords[2]),int(coords[3]))
+		return out
+    
+	def px2pt(self, pxl):
+		"""
+		Returns the length in pt given length in pxl
+		"""
+		return float(pxl)/self.dpi*inch
+			
+	def to_pdf(self, outFileName, imageFileName, showBoundingboxes, fontname="Helvetica"):
+		"""
+		Creates a PDF file with an image superimposed on top of the text.
+		Text is positioned according to the bounding box of the lines in
+		the hOCR file.
+		The image need not be identical to the image used to create the hOCR file.
+		It can have a lower resolution, different color mode, etc.
+		"""
+		# create the PDF file
+		pdf = Canvas(outFileName, pagesize=(self.width, self.height), pageCompression=1) # page size in points (1/72 in.)
+		
+		# draw bounding box for each paragraph
+		pdf.setStrokeColorRGB(0,1,1)	# light blue for bounding box of paragraph
+		pdf.setFillColorRGB(0,1,1)	# light blue for bounding box of paragraph
+		pdf.setLineWidth(0)		# no line for bounding box
+		for elem in self.hocr.findall(".//%sp[@class='%s']" % (self.xmlns, "ocr_par")):
+		
+			elemtxt=self._get_element_text(elem).rstrip()
+			if len(elemtxt) == 0:
+				continue
+
+			coords = self.element_coordinates(elem)
+			x1=self.px2pt(coords[0])
+			y1=self.px2pt(coords[1])
+			x2=self.px2pt(coords[2])
+			y2=self.px2pt(coords[3])
+			
+			# draw the bbox border
+			if showBoundingboxes == True:
+				pdf.rect(x1, self.height-y2, x2-x1, y2-y1, fill=1)		
+		
+		
+		# check if element with class 'ocrx_word' are available
+		# otherwise use 'ocr_line' as fallback
+		elemclass="ocr_line"
+		if self.hocr.find(".//%sspan[@class='ocrx_word']" %(self.xmlns)) is not None:
+			elemclass="ocrx_word"
+
+		# itterate all text elements
+		pdf.setStrokeColorRGB(1,0,0)	# light green for bounding box of word/line
+		pdf.setLineWidth(0.5)		# bounding box line width
+		pdf.setDash(6,3)		# bounding box is dashed
+		pdf.setFillColorRGB(0,0,0)	# text in black
+		for elem in self.hocr.findall(".//%sspan[@class='%s']" % (self.xmlns, elemclass)):
+
+			elemtxt=self._get_element_text(elem).rstrip()
+			if len(elemtxt) == 0:
+				continue
+
+			coords = self.element_coordinates(elem)
+			x1=self.px2pt(coords[0])
+			y1=self.px2pt(coords[1])
+			x2=self.px2pt(coords[2])
+			y2=self.px2pt(coords[3])
+			
+			# draw the bbox border
+			if showBoundingboxes == True:
+				pdf.rect(x1, self.height-y2, x2-x1, y2-y1, fill=0)
+
+			text = pdf.beginText()
+			fontsize=self.px2pt(coords[3]-coords[1])
+			text.setFont(fontname, fontsize)
+
+			# set cursor to bottom left corner of bbox (adjust for dpi)
+			text.setTextOrigin(x1, self.height-y2)
+       
+			# scale the width of the text to fill the width of the bbox
+			text.setHorizScale(100*(x2-x1)/pdf.stringWidth(elemtxt, fontname, fontsize))
+
+			# write the text to the page
+			text.textLine(elemtxt)
+			pdf.drawText(text)
+
+		# put the image on the page, scaled to fill the page
+		if imageFileName != None:
+			im = Image.open(imageFileName)		
+			pdf.drawInlineImage(im, 0, 0, width=self.width, height=self.height)
+			
+		# finish up the page and save it
+		pdf.showPage()
+		pdf.save()
+  
+if __name__ == "__main__":
+	parser = argparse.ArgumentParser(description='Convert hocr file to PDF')
+	parser.add_argument('-b', '--boundingboxes', action="store_true", default=False, help='Show bounding boxes borders')
+	parser.add_argument('-r', '--resolution', type=int, default=300, help='Resolution of the image that was OCRed')
+	parser.add_argument('-i', '--image', default=None, help='Path to the image to be placed above the text')
+	parser.add_argument('hocrfile', help='Path to the hocr file to be parsed')
+	parser.add_argument('outputfile', help='Path to the PDF file to be generated')
+	args = parser.parse_args()
+
+	hocr = hocrTransform(args.hocrfile, args.resolution)
+	hocr.to_pdf(args.outputfile, args.image, args.boundingboxes)
+
+	
+	

src/test/OCRmyPDF_severaltimes.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+#
+# Perform OCR several times in order to find how quicly the quality decreases
+
+cpt=1
+
+while [ $cpt -le 10 ] ; do
+
+	echo "------- Itteration $cpt ---------"
+
+	! ../../OCRmyPDF.sh -vv -l deu -k ../../tmp/ocred-$(($cpt-1)).pdf ../../tmp/ocred-$cpt.pdf && exit 1
+	
+	cpt=$(($cpt+1))
+	
+done

src/test/README.md

@@ -0,0 +1,4 @@
+Note
+====
+
+The file(s) located in this folder are aimed at testing the OCRmyPDF script

tess-cfg/README.md

@@ -0,0 +1,10 @@
+Note
+====
+
+The file(s) located in this folder are tesseract configuration files.
+(Tesseract configuration files enable to tune the behaviour of tesseract)
+
+If needed, these files should be copied to the "tessdata/configs" folder of your tesseract installation.
+
+To request OCRmyPDF.sh to use a configuration file, please use the -C option
+

tess-cfg/no_ligature

@@ -0,0 +1 @@
+tessedit_char_blacklist fifl

test_requirements.txt

@@ -1,2 +0,0 @@
-img2pdf>=0.1.5
-pytest>=2.7.2

tests/replace_ghostscript_nopdfa.py

@@ -1,72 +0,0 @@
-#!/usr/bin/env python3
-import sys
-import os
-
-'''
-For testing PDF/A generation failures, this wrapper calls ghostscript
-but filters out all PDF/A information so that a regular PDF will be
-created instead.
-
-It assumes that it is called from a staged system PATH where the first
-item on the PATH contains a file named 'gs' which is a symlink to this
-file.  It will strip out the first item on path to invoke the real
-'gs'.  That is, it expects this when called
-
-1.   tests/output/[...test name...]/bin/gs is a symlink to this file
-2.   tests/output/bin is the first item on PATH
-3.   The real executable is on the path
-
-OCRmyPDF also calls "gs --version" and "gs --help".  gs answers both
-on stdout so, this wrapper prints to stderr.
-
-'''
-
-
-def pdfa_param(arg):
-    if arg.startswith('-sPDFA'):
-        return True
-    if arg.startswith('-dPDFA'):
-        return True
-    if arg.endswith('.ps'):
-        return True
-    if 'ColorConversionStrategy' in arg:
-        return True
-    if 'ProcessColorModel' in arg:
-        return True
-    if 'OutputICCProfile' in arg:
-        return True
-    return False
-
-
-if __name__ == '__main__':
-    sys_args = sys.argv[1:]
-
-    print("Fake Ghostscript wrapper", file=sys.stderr)
-
-    if any(pdfa_param(arg) for arg in sys_args):
-        # We were asked to produce a PDF/A
-        # Filter out PDF/A arguments
-        args = [arg for arg in sys.argv[1:]
-                if not pdfa_param(arg)]
-
-        # Tell Ghostscript to create a PDF 1.3 instead so JHOVE won't
-        # think it's a PDF/A
-        indexof_pdfwrite = next(n for n, item in enumerate(args)
-                                if 'pdfwrite' in item)
-        args.insert(indexof_pdfwrite + 1, '-dCompatibilityLevel=1.3')
-        print("Rewrote arguments", file=sys.stderr)
-    else:
-        args = sys_args
-        print("Keeping arguments", file=sys.stderr)
-
-    exec_path = os.environ['PATH'].split(os.pathsep)
-    env = os.environ.copy()
-    env['PATH'] = os.pathsep.join(exec_path[1:])
-
-    print("Calling real Ghostscript with modified args and env",
-          file=sys.stderr)
-    print(args, file=sys.stderr)
-    print(env['PATH'], file=sys.stderr)
-
-    sys.stderr.flush()
-    os.execvpe('gs', ['gs'] + args, env)

tests/resources/NOTE.rst

@@ -1,34 +0,0 @@
-All test resources must come from free public domain sources for
-copyright reasons.
-
-Test files do not necessarily produce perfect (or even good) OCR
-results.
-
-+---------------------+--------------------------------------------------------------------------------+
-| File                | Source                                                                         |
-+=====================+================================================================================+
-| graph.pdf           | Wikimedia                                                                      |
-+---------------------+--------------------------------------------------------------------------------+
-| c02-22.pdf          | Project Gutenberg: https://www.gutenberg.org/files/76/76-h/images/c02-22.jpg   |
-+---------------------+--------------------------------------------------------------------------------+
-| LinnSequencer.jpg   | Wikimedia_                                                                     |
-+---------------------+--------------------------------------------------------------------------------+
-| congress.jpg        | http://www.baxleystamps.com/litho/meiji/courts_1871.jpg                        |
-+---------------------+--------------------------------------------------------------------------------+
-| blank.pdf           | Blank page from Adobe Illustrator CC 2015                                      |
-+---------------------+--------------------------------------------------------------------------------+
-| enormous.pdf        | PNG file saved to PDF using img2pdf                                            |
-+---------------------+--------------------------------------------------------------------------------+
-| invalid.pdf         | PDF file header followed by EOF marker; not valid                              |
-+---------------------+--------------------------------------------------------------------------------+
-| multipage.pdf       | several other files concatenated                                               |
-+---------------------+--------------------------------------------------------------------------------+
-| skew.pdf            | skewed version of c02-22.PDF                                                   |
-+---------------------+--------------------------------------------------------------------------------+
-| Test_Issue_28.pdf   | file with some syntax errors                                                   |
-+---------------------+--------------------------------------------------------------------------------+
-| missing_docinfo.pdf | file missing its DocumentInfo dictionary                                       |
-+---------------------+--------------------------------------------------------------------------------+ 
-
-
-.. _Wikimedia: https://upload.wikimedia.org/wikipedia/en/b/b7/LinnSequencer_hardware_MIDI_sequencer_brochure_page_2_300dpi.jpg

tests/resources/invalid.pdf

@@ -1,3 +0,0 @@
-%PDF-1.3
-This is not a valid PDF file
-%%EOF

tests/test_main.py

@@ -1,356 +0,0 @@
-#!/usr/bin/env python3
-# © 2015 James R. Barlow: github.com/jbarlow83
-
-from __future__ import print_function
-from subprocess import Popen, PIPE, check_output
-import os
-import shutil
-from contextlib import suppress
-import sys
-import pytest
-from ocrmypdf.pageinfo import pdf_get_all_pageinfo
-import PyPDF2 as pypdf
-from ocrmypdf import ExitCode
-
-
-if sys.version_info.major < 3:
-    print("Requires Python 3.4+")
-    sys.exit(1)
-
-TESTS_ROOT = os.path.abspath(os.path.dirname(__file__))
-PROJECT_ROOT = os.path.dirname(TESTS_ROOT)
-OCRMYPDF = os.path.join(PROJECT_ROOT, 'OCRmyPDF.sh')
-TEST_RESOURCES = os.path.join(PROJECT_ROOT, 'tests', 'resources')
-TEST_OUTPUT = os.environ.get(
-    'OCRMYPDF_TEST_OUTPUT',
-    default=os.path.join(PROJECT_ROOT, 'tests', 'output'))
-TEST_BINARY_PATH = os.path.join(TEST_OUTPUT, 'fakebin')
-
-
-def setup_module():
-    with suppress(FileNotFoundError):
-        shutil.rmtree(TEST_OUTPUT)
-    with suppress(FileExistsError):
-        os.mkdir(TEST_OUTPUT)
-
-
-def run_ocrmypdf_sh(input_file, output_file, *args):
-    sh_args = ['sh', OCRMYPDF] + list(args) + [input_file, output_file]
-    sh = Popen(
-        sh_args, close_fds=True, stdout=PIPE, stderr=PIPE,
-        universal_newlines=True)
-    out, err = sh.communicate()
-    return sh, out, err
-
-
-def _make_input(input_basename):
-    return os.path.join(TEST_RESOURCES, input_basename)
-
-
-def _make_output(output_basename):
-    return os.path.join(TEST_OUTPUT, output_basename)
-
-
-def check_ocrmypdf(input_basename, output_basename, *args):
-    input_file = _make_input(input_basename)
-    output_file = _make_output(output_basename)
-
-    sh, _, err = run_ocrmypdf_sh(input_file, output_file, *args)
-    assert sh.returncode == 0, err
-    assert os.path.exists(output_file), "Output file not created"
-    assert os.stat(output_file).st_size > 100, "PDF too small or empty"
-    return output_file
-
-
-def run_ocrmypdf_env(input_basename, output_basename, *args, env=None):
-    input_file = _make_input(input_basename)
-    output_file = _make_output(output_basename)
-
-    if env is None:
-        env = os.environ
-
-    p_args = ['ocrmypdf'] + list(args) + [input_file, output_file]
-    p = Popen(
-        p_args, close_fds=True, stdout=PIPE, stderr=PIPE,
-        universal_newlines=True, env=env)
-    out, err = p.communicate()
-    return p, out, err
-
-
-def test_quick():
-    check_ocrmypdf('c02-22.pdf', 'test_quick.pdf')
-
-
-def test_deskew():
-    # Run with deskew
-    deskewed_pdf = check_ocrmypdf('skew.pdf', 'test_deskew.pdf', '-d')
-
-    # Now render as an image again and use Leptonica to find the skew angle
-    # to confirm that it was deskewed
-    from ocrmypdf.ghostscript import rasterize_pdf
-    import logging
-    log = logging.getLogger()
-
-    deskewed_png = _make_output('deskewed.png')
-
-    rasterize_pdf(
-        deskewed_pdf,
-        deskewed_png,
-        xres=150,
-        yres=150,
-        raster_device='pngmono',
-        log=log)
-
-    from ocrmypdf.leptonica import pixRead, pixDestroy, pixFindSkew
-    pix = pixRead(deskewed_png)
-    skew_angle, skew_confidence = pixFindSkew(pix)
-    pix = pixDestroy(pix)
-
-    print(skew_angle)
-    assert -0.5 < skew_angle < 0.5, "Deskewing failed"
-
-
-def test_clean():
-    check_ocrmypdf('skew.pdf', 'test_clean.pdf', '-c')
-
-
-def check_exotic_image(pdf, renderer):
-    check_ocrmypdf(
-        pdf,
-        'test_{0}_{1}.pdf'.format(pdf, renderer),
-        '-dc',
-        '--pdf-renderer', renderer)
-
-
-def test_exotic_image():
-    yield check_exotic_image, 'palette.pdf', 'hocr'
-    yield check_exotic_image, 'palette.pdf', 'tesseract'
-    yield check_exotic_image, 'cmyk.pdf', 'hocr'
-    yield check_exotic_image, 'cmyk.pdf', 'tesseract'
-
-
-def test_preserve_metadata():
-    pdf_before = pypdf.PdfFileReader(_make_input('graph.pdf'))
-
-    output = check_ocrmypdf('graph.pdf', 'test_metadata_preserve.pdf')
-
-    pdf_after = pypdf.PdfFileReader(output)
-
-    for key in ('/Title', '/Author'):
-        assert pdf_before.documentInfo[key] == pdf_after.documentInfo[key]
-
-
-def test_override_metadata():
-    input_file = _make_input('c02-22.pdf')
-    output_file = _make_output('test_override_metadata.pdf')
-
-    german = 'Du siehst den Wald vor lauter Bäumen nicht.'
-    chinese = '孔子'
-    high_unicode = 'U+1030C is: 𐌌'
-
-    p, out, err = run_ocrmypdf_env(
-        input_file, output_file,
-        '--title', german,
-        '--author', chinese,
-        '--subject', high_unicode)
-
-    assert p.returncode == ExitCode.ok
-
-    pdf = output_file
-
-    out_pdfinfo = check_output(['pdfinfo', pdf], universal_newlines=True)
-    lines_pdfinfo = out_pdfinfo.splitlines()
-    pdfinfo = {}
-    for line in lines_pdfinfo:
-        k, v = line.strip().split(':', maxsplit=1)
-        pdfinfo[k.strip()] = v.strip()
-
-    assert pdfinfo['Title'] == german
-    assert pdfinfo['Author'] == chinese
-    assert pdfinfo['Subject'] == high_unicode
-    assert pdfinfo.get('Keywords', '') == ''
-
-
-def check_oversample(renderer):
-    oversampled_pdf = check_ocrmypdf(
-        'skew.pdf', 'test_oversample_%s.pdf' % renderer, '--oversample', '300',
-        '--pdf-renderer', renderer)
-
-    pdfinfo = pdf_get_all_pageinfo(oversampled_pdf)
-
-    print(pdfinfo[0]['xres'])
-    assert abs(pdfinfo[0]['xres'] - 300) < 1
-
-
-def test_oversample():
-    yield check_oversample, 'hocr'
-    yield check_oversample, 'tesseract'
-
-
-def test_repeat_ocr():
-    sh, _, _ = run_ocrmypdf_sh('graph_ocred.pdf', 'wontwork.pdf')
-    assert sh.returncode != 0
-
-
-def test_force_ocr():
-    out = check_ocrmypdf('graph_ocred.pdf', 'test_force.pdf', '-f')
-    pdfinfo = pdf_get_all_pageinfo(out)
-    assert pdfinfo[0]['has_text']
-
-
-def test_skip_ocr():
-    check_ocrmypdf('graph_ocred.pdf', 'test_skip.pdf', '-s')
-
-
-def test_argsfile():
-    with open(_make_output('test_argsfile.txt'), 'w') as argsfile:
-        print('--title', 'ArgsFile Test', '--author', 'Test Cases',
-              sep='\n', end='\n', file=argsfile)
-    check_ocrmypdf('graph.pdf', 'test_argsfile.pdf',
-                   '@' + _make_output('test_argsfile.txt'))
-
-
-def check_ocr_timeout(renderer):
-    out = check_ocrmypdf('skew.pdf', 'test_timeout_%s.pdf' % renderer,
-                         '--tesseract-timeout', '1.0')
-    pdfinfo = pdf_get_all_pageinfo(out)
-    assert pdfinfo[0]['has_text'] == False
-
-
-def test_ocr_timeout():
-    yield check_ocr_timeout, 'hocr'
-    yield check_ocr_timeout, 'tesseract'
-
-
-def test_skip_big():
-    out = check_ocrmypdf('enormous.pdf', 'test_enormous.pdf',
-                         '--skip-big', '10')
-    pdfinfo = pdf_get_all_pageinfo(out)
-    assert pdfinfo[0]['has_text'] == False
-
-
-def check_maximum_options(renderer):
-    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)
-
-
-def test_maximum_options():
-    yield check_maximum_options, 'hocr'
-    yield check_maximum_options, 'tesseract'
-
-
-def override_binary(binary, replacement):
-    '''Create a directory that contains a symlink named 'binary' that
-    points to replacement, another program to use in place of the
-    regular binary for testing.
-
-    override_binary('gs', 'replace_gs.py') will create an environment
-    in which "gs" will invoke replace_gs.py.
-
-    Not thread-safe with other test at the moment.
-
-    Returns the os.environ["PATH"] string under which this binary will
-    be invoked.'''
-
-    replacement_path = os.path.abspath(os.path.join(TESTS_ROOT,
-                                                    replacement))
-    subdir = os.path.splitext(os.path.basename(replacement))[0]
-    binary_path = os.path.abspath(os.path.join(TEST_BINARY_PATH,
-                                               subdir,
-                                               binary))
-    with suppress(FileExistsError):
-        os.makedirs(os.path.dirname(binary_path))
-    assert os.path.isdir(os.path.dirname(binary_path))
-    assert not os.path.lexists(binary_path)
-    print("symlink %s -> %s" % (replacement_path, binary_path))
-    os.symlink(replacement_path, binary_path)
-
-    os.chmod(replacement_path, int('755', base=8))
-
-    return os.path.dirname(binary_path) + os.pathsep + os.environ["PATH"]
-
-
-@pytest.fixture
-def break_ghostscript_pdfa():
-    return override_binary('gs', 'replace_ghostscript_nopdfa.py')
-
-
-@pytest.mark.skipif(os.environ.get('OCRMYPDF_IN_DOCKER', False),
-                    reason="Requires writable filesystem")
-def test_ghostscript_pdfa_fails(break_ghostscript_pdfa):
-    env = os.environ.copy()
-    env['PATH'] = break_ghostscript_pdfa
-
-    p, out, err = run_ocrmypdf_env(
-        'graph_ocred.pdf', 'not_a_pdfa.pdf', '-v', '1', '--skip-text', env=env)
-    assert p.returncode == ExitCode.ok, err  # no longer using JHOVE PDFA check
-
-
-def test_tesseract_missing_tessdata():
-    env = os.environ.copy()
-    env['TESSDATA_PREFIX'] = '/tmp'
-
-    p, _, err = run_ocrmypdf_env(
-        'graph_ocred.pdf', 'not_a_pdfa.pdf', '-v', '1', '--skip-text', env=env)
-    assert p.returncode == ExitCode.missing_dependency, err
-
-
-def test_invalid_input_pdf():
-    p, out, err = run_ocrmypdf_env(
-        'invalid.pdf', 'wont_be_created.pdf')
-    assert p.returncode == ExitCode.input_file, err
-
-
-def test_blank_input_pdf():
-    p, out, err = run_ocrmypdf_env(
-        'blank.pdf', 'still_blank.pdf')
-    assert p.returncode == ExitCode.ok
-
-
-def test_french():
-    p, out, err = run_ocrmypdf_env(
-        'francais.pdf', 'francais.pdf', '-l', 'fra')
-    assert p.returncode == ExitCode.ok, \
-        "This test may fail if Tesseract language packs are missing"
-
-
-def test_klingon():
-    p, out, err = run_ocrmypdf_env(
-        'francais.pdf', 'francais.pdf', '-l', 'klz')
-    assert p.returncode == ExitCode.bad_args
-
-
-def test_missing_docinfo():
-    p, out, err = run_ocrmypdf_env(
-        'missing_docinfo.pdf', 'missing_docinfo.pdf', '-l', 'eng', '-c')
-    assert p.returncode == ExitCode.ok, err
-
-
-def test_uppercase_extension():
-    shutil.copy(_make_input("skew.pdf"), _make_input("UPPERCASE.PDF"))
-    try:
-        check_ocrmypdf("UPPERCASE.PDF", "UPPERCASE_OUT.PDF")
-    finally:
-        os.unlink(_make_input("UPPERCASE.PDF"))
-
-
-def test_input_file_not_found():
-    input_file = "does not exist.pdf"
-    sh, out, err = run_ocrmypdf_sh(
-        _make_input(input_file),
-        _make_output("will not happen.pdf"))
-    assert sh.returncode == ExitCode.input_file
-    assert (input_file in out or input_file in err)
-
-
-def test_input_file_not_a_pdf():
-    input_file = __file__  # Try to OCR this file
-    sh, out, err = run_ocrmypdf_sh(
-        _make_input(input_file),
-        _make_output("will not happen.pdf"))
-    assert sh.returncode == ExitCode.input_file
-    assert (input_file in out or input_file in err)
-