major clean
authorDaniel Axtens <dja@ucc.asn.au>
Sun, 31 Jul 2011 11:49:48 +0000 (19:49 +0800)
committerDaniel Axtens <dja@ucc.asn.au>
Sun, 31 Jul 2011 11:49:48 +0000 (19:49 +0800)
architecture.txt [new file with mode: 0644]
scan2pages.sh

diff --git a/architecture.txt b/architecture.txt
new file mode 100644 (file)
index 0000000..95251d3
--- /dev/null
@@ -0,0 +1,35 @@
+= How are things laid out? =
+
+1 scan page contains 2 physical pages.
+each physical page may contain either 2 or 1 logical pages
+(future: or 4 slides!)
+
+= What do we do? =
+
+0. init, process args, etc.
+1. determine page count
+2. determine depth
+3. determine dpi
+4. foreach double-page-spread (scan page)
+       4.1. extract scan page from pdf, save as png
+       4.2. run a mask over it to pull off large black areas
+       4.3. run unpaper over it, creating 2 pages (physical page)
+       4.4. foreach physical page
+               4.4.1. remask and retrim
+               4.4.2. attempt to detect if a physical page contains 2 logical pages, 
+                       4.4.2.1. if so split with unpaper
+               4.4.3. do any final processing (resize for bebook)
+5. move all the final pictures into a final picture directory
+
+In the accidentally deleted code we used ocropus's binarise stuff to do some
+extra cleaning.
+
+= What options do we need? =
+Anything we attempt to detect automatically should have the option to set manually
+ - depth
+ - dpi
+ - probably which pages we want to process
+ - how many logical pages a physical page has
+       * an option to set a default and certain exceptions would be ace.
+ - options for final output
+ - options to ignore partial products
index ccb464b..be89870 100755 (executable)
@@ -10,25 +10,19 @@ OPTIONS:
        -d depth: Use given depth. Default is 1 for black and white, 8 for colour/gray.
                Unpaper can only handle up to 8.
        -D dpi: Use given DPI. Colour scans on library scanners are usually 300, bw 400.
-       -F extension: use the output format signified by the extension. Default is png
-       -s: skip masking/trimming. Overrides -m.
-       -f: Forceably redo everything.
-       -p: Forceably redo pdf conversion. Implies options below, equivalent to -f.
-       -m: Forceably redo masking/trimming and other preprocessing. Impiles options below.
-       -u: Forceably redo unpaper processing. Implies option below.
-       -t: Forceably redo final trimming and cleaning. IGNORED
+       -e extension: use the output format signified by the extension. Default is png
        -b: Optimize for BeBook One.
+       -1: each physical page contains one logical page
+       -2: each physical page contains two logical pages
+               (neither specified: try to figure it out)
 __EOF__
 }
 
+
 ## Setup and utilities ##
 source $(dirname $0)/my_seq.sh
 
 ## Process flags ##
-forcepdf=
-forcemask=
-forceunpaper=
-forceclean=
 convertflags=
 unpaperflags=
 depthset=
@@ -38,7 +32,8 @@ skipmask=
 verbose=
 extension="png"
 bebook=
-while getopts 'vd:D:sfpmucF:b' OPTION
+logperphys=
+while getopts 'vd:D:e:b12' OPTION
 do
        case $OPTION in
        v)      verbose=1
@@ -49,21 +44,13 @@ do
                ;;
        D)      dpi=$OPTARG
                ;;
-       s)      skipmask=1;
-               ;;
-       f)      forcepdf=1; forcemask=1; forceunpaper=1; forceclean=1
-               ;;
-       p)      forcepdf=1; forcemask=1; forceunpaper=1; forceclean=1
-               ;;
-       m)      forcemask=1; forceunpaper=1; forceclean=1
-               ;;
-       u)      forceunpaper=1; forceclean=1
+       e)      extension="$OPTARG"
                ;;
-       t)      forceclean=1
+       b)      bebook=1
                ;;
-       F)      extension="$OPTARG"
+       1)      logperphys=1
                ;;
-       b)      bebook=1
+       2)      logperphys=2
                ;;
        ?)      usage
                exit 2
@@ -79,21 +66,15 @@ if [[ $# != 2 ]]; then
        exit 2
 fi
 
-file=$1
-dir=$2
+scanfile=$1
+outdir=$2
 
 filedir=$(dirname $1)
 base=$(basename $1 .pdf)
 
 # make the output dir
-mkdir -p $dir
+mkdir -p $outdir
 
-# figure out the number of pages
-dscname=$dir/${base}.dsc
-pdf2dsc $file $dscname || exit 1
-pages=$(awk '$1 ~ "%%Pages" {print $2}' $dscname)
-echo "Got $pages page(s)."
-rm $dscname
 
 # guess at DPI, unless it's been set
 # the scans do not seem to accurately reflect their resolution.
@@ -102,7 +83,7 @@ if [[ "$dpi" = "" ]]; then
        # 2 for b/w, and the scanner seems to default to 400 dpi for that
        # 256 for greyscale, which has to be selected manually (so I'm assuming 300 for no good reason)
        # 31564 for colour, which defaults to 300
-       if [[ $( convert $file[0] -format "%k" info: || exit 1 ) == 2 ]]; then
+       if [[ $( convert $scanfile[0] -format "%k" info: || exit 1 ) == 2 ]]; then
                dpi=400;
        else
                dpi=300
@@ -114,7 +95,7 @@ fi
 
 # guess at depth, unless it's been set
 if [[ "$depth" = "" ]]; then
-       if [[ $( convert $file[0] -format "%k" info: || exit 1 ) == 2 ]]; then
+       if [[ $( convert $scanfile[0] -format "%k" info: || exit 1 ) == 2 ]]; then
                depth=1;
        else
                depth=8
@@ -124,90 +105,101 @@ if [[ "$depth" = "" ]]; then
        fi
 fi
 
+# figure out the number of pages
+dscname=$outdir/${base}.dsc
+pdf2dsc $scanfile $dscname || exit 1
+pages=$(awk '$1 ~ "%%Pages" {print $2}' $dscname)
+echo "Got $pages page(s)."
+rm $dscname
+
 # process pages 1 by 1 to avoid convert gobbling all the memory
-for pg in `$my_seq 1 $pages`; do
-       echo "Processing page $pg."
+for scanpgnum in `$my_seq 1 $pages`; do
+       echo "Processing page $scanpgnum."
        
-       pgn=$(printf '%03d' $pg)
+       scanpgnum=$(printf '%03d' $scanpgnum)
        
        # convert from pdf
-       origfile=$dir/pg-${pgn}.png
-       if [ ! -e $origfile ] || [[ $forcepdf ]]; then
-               convert $convertflags -depth $depth -density $dpi $file[$(expr $pg - 1)] \
-                       $origfile || exit 1
+       scanpg=$outdir/scanpg-${scanpgnum}.png
+       if [ ! -e $scanpg ]; then
+               convert $convertflags -depth $depth -density $dpi $scanfile[$(expr $scanpgnum - 1)] \
+                       $scanpg || exit 1
        fi;
        
        # preprocess it!
-       preppnm=$dir/pg-pp-${pgn}.pnm
-       if [[ ! $skipmask ]] && ( [ ! -e $preppnm ] || [[ $forcemask ]] ); then
+       cleanscanpg=$outdir/scanpg-clean-${scanpgnum}.pnm
+       if [ ! -e $cleanscanpg ]; then
                # create mask: 
                # ... downscale, blur,
-               convert $convertflags -resize 10% -depth 8 -blur 10 -median 2 $origfile $dir/pg-mask-${pgn}.png ||exit 1
+               convert $convertflags -resize 10% -depth 8 -blur 10 -median 2 $scanpg $outdir/scanpg-mask-${scanpgnum}.png ||exit 1
 
                # ... get crop co-ords. They're off by ~2 as I don't know how to
                # properly correct for the border.
-               cropcords=$(convert -border 1x1 -bordercolor '#000' -resize 1000% -trim -fuzz 90% -format "%wx%h%O" $dir/pg-mask-${pgn}.png info: || exit 1)
+               cropcords=$(convert -border 1x1 -bordercolor '#000' -resize 1000% -trim -fuzz 90% -format "%wx%h%O" $outdir/scanpg-mask-${scanpgnum}.png info: || exit 1)
                
                # ... crop and despeckle? the final pre-prepared image
-               convert $convertflags -crop $cropcords $origfile $preppnm || exit 1
+               convert $convertflags -crop $cropcords $scanpg $cleanscanpg || exit 1
        elif [[ $skipmask ]]; then
                cp $origfile $preppnm
        fi;
        
        # check it hasn't mostly disappeared - e.g. if the scan was all black
        # (e.g. forgot to put the book down when you first hit scan)
-       if [[ $(convert  $preppnm -format '%[fx:s.w*s.h>1000]' info:) = "0" ]]; then
-               [[ $verbose == 1 ]] && echo "Discarding pg ${pgn}: not enough remains after masking."
+       if [[ $(convert  $cleanscanpg -format '%[fx:s.w*s.h>1000]' info:) = "0" ]]; then
+               [[ $verbose == 1 ]] && echo "Discarding pg ${scanpgnum}: not enough remains after masking."
                continue; 
        fi;
        
        #unpaper it
-       #names go a bit funny here
-       unppnmbase=$dir/upg-${pgn}
-       if [ ! -e ${unppnmbase}-1.pnm ] || [ ! -e ${unppnmbase}-2.pnm ] || [[ $forceunpaper ]]; then
-               unpaper $unpaperflags --layout double --overwrite -ni 10 -op 2 $preppnm ${unppnmbase}-%01d.pnm || exit 1
+       physpgbase=$outdir/physpg-${scanpgnum}
+       if [ ! -e ${physpgbase}-1.pnm ] || [ ! -e ${physpgbase}-2.pnm ]; then
+               unpaper $unpaperflags --layout double --overwrite -ni 10 -op 2 $cleanscanpg ${physpgbase}-%01d.pnm || exit 1
        fi;
        
-       for subpg in $($my_seq 1 2); do
-               echo Processing subpg ${subpg}.
+       for physpgnum in $($my_seq 1 2); do
+               echo Processing physical page ${physpgnum}.
                
-               subpgfile=${unppnmbase}-${subpg}.pnm #$unppnmbase has $dir/ already
+               physpg=${physpgbase}-${physpgnum}.pnm #$physpgbase has $outdir/ already
                
-               prepsubpnm=$dir/upg-pp-${pgn}-${subpg}.pnm
+               cleanphyspg=$outdir/physpg-clean-${scanpgnum}-${physpgnum}.pnm
                
-               # remask and retrim. FIXME: may throw off 2page detection
-               convert $convertflags -resize 10% -depth 8 -gamma 0.01 -median 2 $subpgfile $dir/spg-mask-${pgn}-${subpg}.png ||exit 1
+               if [ ! -e $cleanphyspg ]; then
+                       # remask and retrim. FIXME: may throw off 2page detection
+                       convert $convertflags -resize 10% -depth 8 -gamma 0.01 -median 2 $physpg $outdir/physpg-mask-${scanpgnum}-${physpgnum}.png ||exit 1
 
-               # Trim #-border 1x1 -bordercolor '#fff' -trim -fuzz 30% 
-               cropcords=$(convert -trim -fuzz 90%\
-                -resize 1000% -format "%wx%h%O" $dir/spg-mask-${pgn}-${subpg}.png info: || exit 1)
+                       # Trim #-border 1x1 -bordercolor '#fff' -trim -fuzz 30% 
+                       cropcords=$(convert -trim -fuzz 90%\
+                        -resize 1000% -format "%wx%h%O" $outdir/physpg-mask-${scanpgnum}-${physpgnum}.png info: || exit 1)
                
-               # ... crop and despeckle? the final pre-prepared image
-               convert $convertflags -crop $cropcords $subpgfile $prepsubpnm || exit 1
+                       # ... crop and despeckle? the final pre-prepared image
+                       convert $convertflags -crop $cropcords $physpg $cleanphyspg || exit 1
+               fi;
                
                #detect if the page is 2-up
 
-               if $(dirname $0)/detect2pages.sh ${prepsubpnm} ${pgn} ${subpg}; then
+               if [[ $logperphys == 2 ]] || ( [[ $logperphys != 1 ]] && $(dirname $0)/detect2pages.sh ${cleanphyspg} ${scanpgnum} ${physpgnum} ); then
+                       if [ ! -e ${physpgbase}-1.pnm ] || [ ! -e ${physpgbase}-2.pnm ]; then
                        if [[ $verbose == 1 ]]; then
-                               echo "Resplitting subpg ${subpg}."
+                               echo "Resplitting physical page ${physpgnum}."
                        fi
-                       unpaper $unpaperflags --pre-rotate 90 --layout double --overwrite -op 2 $prepsubpnm $dir/upg-${pgn}-${subpg}-%01d.pnm || exit 1
+                       unpaper $unpaperflags --pre-rotate 90 --layout double --overwrite \
+                        -op 2 --no-blackfilter --no-greyfilter --no-noisefilter \
+                        -no-blurfilter $cleanphyspg $outdir/logpg-${scanpgnum}-${physpgnum}-%01d.pnm || exit 1
                else
-                       cp $prepsubpnm $dir/upg-${pgn}-${subpg}-1.pnm
+                       cp $cleanphyspg $outdir/logpg-${scanpgnum}-${physpgnum}-1.pnm
                fi;
 
        
                #final convert and clean w/ bebook optimisation
                if [[ $bebook ]]; then
-                       convert $convertflags -colorspace Gray -median 1 $dir/upg-${pgn}-${subpg}-?.pnm -trim -fuzz 80% -resize 1200x1600 $dir/final-${pgn}-${subpg}-%01d.${extension} || exit 1
+                       convert $convertflags -colorspace Gray -median 1 $outdir/logpg-${scanpgnum}-${physpgnum}-?.pnm -trim -fuzz 80% -resize 1200x1600 $outdir/final-${scanpgnum}-${physpgnum}-%01d.${extension} || exit 1
                else
-                       convert $convertflags $dir/upg-${pgn}-${subpg}-?.pnm $dir/final-${pgn}-${subpg}-%01d.${extension} || exit 1
+                       convert $convertflags $outdir/logpg-${scanpgnum}-${physpgnum}-?.pnm $outdir/final-${scanpgnum}-${physpgnum}-%01d.${extension} || exit 1
                fi
        
        done;
 
 done
 
-mkdir -p $dir/pages
-mv $dir/final-*.${extension} $dir/pages
+mkdir -p $outdir/pages
+mv $outdir/final-*.${extension} $outdir/pages
        

UCC git Repository :: git.ucc.asn.au