lib/scripts/lyxpreview2bitmap.sh

   1 #! /bin/sh
   2
   3 # file lyxpreview2bitmap.sh
   4 # This file is part of LyX, the document processor.
   5 # Licence details can be found in the file COPYING.
   6 #
   7 # author Angus Leeming
   8 # with much advice from David Kastrup, david.kastrup@t-online.de.
   9 #
  10 # Full author contact details are available in file CREDITS
  11
  12 # This script takes a LaTeX file and generates bitmap image files,
  13 # one per page.
  14
  15 # The idea is to use it with preview.sty from the preview-latex project
  16 # (http://preview-latex.sourceforge.net/) to create small bitmap
  17 # previews of things like math equations.
  18
  19 # preview.sty can be obtained from
  20 # CTAN/macros/latex/contrib/supported/preview.
  21
  22 # This script takes three arguments:
  23 # TEXFILE:       the name of the .tex file to be converted.
  24 # SCALEFACTOR:   a scale factor, used to ascertain the resolution of the
  25 #                generated image which is then passed to gs.
  26 # OUTPUTFORMAT:  the format of the output bitmap image files.
  27 #                Two formats are recognised: "ppm" and "png".
  28
  29 # If successful, this script will leave in dir ${DIR}:
  30 # a (possibly large) number of image files with names like
  31 #         ${BASE}\([0-9]*\).${SUFFIX} where SUFFIX is ppm or png.
  32 # a file containing info needed by LyX to position the images correctly
  33 # on the screen.
  34 #         ${BASE}.metrics
  35 # All other files ${BASE}* will be deleted.
  36
  37 # A quick note on the choice of OUTPUTFORMAT:
  38
  39 # In general files in PPM format are 10-100 times larger than the
  40 # equivalent files in PNG format. Larger files results in longer
  41 # reading and writing times as well as greater disk usage.
  42
  43 # However, whilst the Qt image loader can load files in PNG format
  44 # without difficulty, the xforms image loader cannot. They must first
  45 # be converted to a loadable format (eg PPM!). Thus, previews will take
  46 # longer to appear if the xforms loader is used to load snippets in
  47 # PNG format.
  48
  49 # You can always experiment by adding a line to your
  50 # ${LYXUSERDIR}/preferences file
  51 #        \converter lyxpreview ${FORMAT} "lyxpreview2bitmap.sh" ""
  52 # where ${FORMAT} is either ppm or png.
  53
  54 # Three helper functions.
  55 FIND_IT () {
  56         which ${EXECUTABLE} > /dev/null ||
  57         {
  58                 echo "Unable to find \"${EXECUTABLE}\". Please install."
  59                 exit 1
  60         }
  61 }
  62
  63 BAIL_OUT () {
  64         # Remove everything except the original .tex file.
  65         FILES=`ls ${BASE}* | sed -e "/${BASE}.tex/d"`
  66         rm -f ${FILES} texput.log
  67         echo "Leaving ${BASE}.tex in ${DIR}"
  68         exit 1
  69 }
  70
  71 REQUIRED_VERSION () {
  72         echo "We require preview.sty version 0.73 or newer. You're using"
  73         grep 'Package: preview' ${LOGFILE}
  74 }
  75
  76 # Preliminary check.
  77 if [ $# -ne 3 ]; then
  78         exit 1
  79 fi
  80
  81 # Extract the params from the argument list.
  82 DIR=`dirname $1`
  83 BASE=`basename $1 .tex`
  84
  85 SCALEFACTOR=$2
  86
  87 if [ "$3" = "ppm" ]; then
  88         GSDEVICE=pnmraw
  89         GSSUFFIX=ppm
  90 elif [ "$3" = "png" ]; then
  91         GSDEVICE=png16m
  92         GSSUFFIX=png
  93 else
  94         echo "Unrecognised output format ${OUTPUTFORMAT}."
  95         echo "Expected either \"ppm\" or \"png\"."
  96         BAIL_OUT
  97 fi
  98
  99 # We use latex, dvips and gs, so check that they're all there.
 100 EXECUTABLE=latex; FIND_IT
 101 EXECUTABLE=dvips; FIND_IT
 102 EXECUTABLE=gs;    FIND_IT
 103
 104 # Initialise some variables.
 105 TEXFILE=${BASE}.tex
 106 LOGFILE=${BASE}.log
 107 DVIFILE=${BASE}.dvi
 108 PSFILE=${BASE}.ps
 109 METRICSFILE=${BASE}.metrics
 110
 111 # LaTeX -> DVI.
 112 cd ${DIR}
 113 latex ${TEXFILE} ||
 114 {
 115         echo "Failed: latex ${TEXFILE}"
 116         BAIL_OUT
 117 }
 118
 119 # Parse ${LOGFILE} to obtain bounding box info to output to
 120 # ${METRICSFILE}.
 121 # This extracts lines starting "Preview: Tightpage" and
 122 # "Preview: Snippet".
 123 grep -E 'Preview: [ST]' ${LOGFILE} > ${METRICSFILE} ||
 124 {
 125         echo "Failed: grep -E 'Preview: [ST]' ${LOGFILE}"
 126         REQUIRED_VERSION
 127         BAIL_OUT
 128 }
 129
 130 # Parse ${LOGFILE} to obtain ${RESOLUTION} for the gs process to follow.
 131 # 1. Extract font size from a line like "Preview: Fontsize 20.74pt"
 132 # Use grep for speed and because it gives an error if the line is
 133 # not found.
 134 LINE=`grep 'Preview: Fontsize' ${LOGFILE}` ||
 135 {
 136         echo "Failed: grep 'Preview: Fontsize' ${LOGFILE}"
 137         REQUIRED_VERSION
 138         BAIL_OUT
 139 }
 140 # The sed script strips out everything that won't form a decimal number
 141 # from the line. It bails out after the first match has been made in
 142 # case there are multiple lines "Preview: Fontsize". (There shouldn't
 143 # be.)
 144 # Note: use "" quotes in the echo to preserve newlines.
 145 LATEXFONT=`echo "${LINE}" | sed 's/[^0-9\.]//g; 1q'`
 146
 147 # 2. Extract magnification from a line like
 148 # "Preview: Magnification 2074"
 149 # If no such line found, default to MAGNIFICATION=1000.
 150 LINE=`grep 'Preview: Magnification' ${LOGFILE}`
 151 if LINE=`grep 'Preview: Magnification' ${LOGFILE}`; then
 152         # Strip out everything that won't form an /integer/.
 153         MAGNIFICATION=`echo "${LINE}" | sed 's/[^0-9]//g; 1q'`
 154 else
 155         MAGNIFICATION=1000
 156 fi
 157
 158 # 3. Compute resolution.
 159 # "bc" allows floating-point arithmetic, unlike "expr" or "dc".
 160 RESOLUTION=`echo "scale=2; \
 161         ${SCALEFACTOR} * (10/${LATEXFONT}) * (1000/${MAGNIFICATION})" \
 162         | bc`
 163
 164 # DVI -> PostScript
 165 dvips -o ${PSFILE} ${DVIFILE} ||
 166 {
 167         echo "Failed: dvips -o ${PSFILE} ${DVIFILE}"
 168         BAIL_OUT
 169 }
 170
 171 # PostScript -> Bitmap files
 172 # Older versions of gs have problems with a large degree of
 173 # anti-aliasing at high resolutions
 174
 175 # test expects integer arguments.
 176 # ${RESOLUTION} may be a float. Truncate it.
 177 INT_RESOLUTION=`echo "${RESOLUTION} / 1" | bc`
 178
 179 ALPHA=4
 180 if [ ${INT_RESOLUTION} -gt 150 ]; then
 181         ALPHA=2
 182 fi
 183
 184 gs -q -dNOPAUSE -dBATCH -dSAFER \
 185         -sDEVICE=${GSDEVICE} -sOutputFile=${BASE}%d.${GSSUFFIX} \
 186         -dGraphicsAlphaBit=${ALPHA} -dTextAlphaBits=${ALPHA} \
 187         -r${RESOLUTION} ${PSFILE} ||
 188 {
 189         echo "Failed: gs ${PSFILE}"
 190         BAIL_OUT
 191 }
 192
 193 # All has been successful, so remove everything except the bitmap files
 194 # and the metrics file.
 195 FILES=`ls ${BASE}* | sed -e "/${BASE}.metrics/d" \
 196                          -e "/${BASE}\([0-9]*\).${GSSUFFIX}/d"`
 197 rm -f ${FILES} texput.log
 198
 199 # The bitmap files can have large amounts of whitespace to the left and
 200 # right. This can be cropped if so desired.
 201 CROP=1
 202 which pnmcrop > /dev/null || CROP=0
 203
 204 # There's no point cropping the image if using PNG images. If you want to
 205 # crop, use PPM.
 206 # Apparently dvipng will support cropping at some stage in the future...
 207 if [ ${CROP} -eq 1 -a "${GSDEVICE}" = "pnmraw" ]; then
 208         for FILE in ${BASE}*.${GSSUFFIX}
 209         do
 210                 if pnmcrop -left ${FILE} 2> /dev/null |\
 211                    pnmcrop -right  2> /dev/null > ${BASE}.tmp; then
 212                         mv ${BASE}.tmp ${FILE}
 213                 else
 214                         rm -f ${BASE}.tmp
 215                 fi
 216         done
 217         rm -f ${BASE}.tmp
 218 fi
 219
 220 echo "Previews generated!"