scm/framework-ps.scm

   1 ;;;; framework-ps.scm --
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c)  2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   6
   7 (define-module (scm framework-ps))
   8
   9 ;;; this is still too big a mess.
  10
  11 (use-modules (ice-9 regex)
  12              (ice-9 string-fun)
  13              (ice-9 format)
  14              (guile)
  15              (srfi srfi-1)
  16              (srfi srfi-13)
  17              (lily))
  18
  19 (define framework-ps-module (current-module))
  20
  21 (define (stderr string . rest)
  22   (apply format (cons (current-error-port) (cons string rest)))
  23   (force-output (current-error-port)))
  24
  25 ;;(define pdebug stderr)
  26 (define (pdebug . rest) #f)
  27
  28 (define mm-to-bigpoint
  29   (/ 72 25.4))
  30
  31 (define-public (ps-font-command font . override-coding)
  32   (let* ((name (ly:font-file-name font))
  33          (magnify (ly:font-magnification font)))
  34
  35     (string-append
  36      "magfont" (string-encode-integer (hashq  name 1000000))
  37      "m" (string-encode-integer (inexact->exact (round (* 1000 magnify)))))))
  38
  39 (define (tex-font? fontname)
  40   (or
  41    (equal? (substring fontname 0 2) "cm")
  42    (equal? (substring fontname 0 2) "ec")))
  43
  44 (define (ps-embed-pfa body font-name version)
  45   (string-append
  46    (format
  47     "%%BeginResource: font ~a
  48 ~a
  49 %%EndResource"
  50     font-name body)))
  51
  52
  53 (define (define-fonts paper)
  54   (define font-list (ly:paper-fonts paper))
  55   (define (define-font command fontname scaling)
  56     (string-append
  57      "/" command " { /" fontname " findfont "
  58      (ly:number->string scaling) " output-scale div scalefont } bind def\n"))
  59
  60   (define (standard-tex-font? x)
  61     (or (equal? (substring x 0 2) "ms")
  62         (equal? (substring x 0 2) "cm")))
  63
  64   (define (font-load-command font)
  65     (let* ((specced-font-name (ly:font-name font))
  66            (fontname (if specced-font-name
  67                          specced-font-name
  68                          (ly:font-file-name font)))
  69            (command (ps-font-command font))
  70
  71            ;; FIXME -- see (ps-font-command )
  72            (plain (ps-font-command font #f))
  73            (designsize (ly:font-design-size font))
  74            (magnification (* (ly:font-magnification font)))
  75            (ops (ly:output-def-lookup paper 'outputscale))
  76            (scaling (* ops magnification designsize)))
  77
  78       ;; Bluesky pfbs have UPCASE names (sigh.)
  79       ;; FIXME - don't support Bluesky?
  80       (if (standard-tex-font? fontname)
  81           (set! fontname (string-upcase fontname)))
  82       (if (equal? fontname "unknown")
  83           (display (list font fontname)))
  84       (define-font plain fontname scaling)))
  85
  86
  87   (apply string-append
  88          (map (lambda (x) (font-load-command x))
  89               (filter (lambda (x) (not (ly:pango-font? x)))
  90                       font-list))))
  91
  92 ;; FIXME: duplicated in other output backends
  93 ;; FIXME: silly interface name
  94 (define (output-variables layout)
  95   ;; FIXME: duplicates output-layout's scope-entry->string, mostly
  96   (define (value->string  val)
  97     (cond
  98      ((string? val) (string-append "(" val ")"))
  99      ((symbol? val) (symbol->string val))
 100      ((number? val) (number->string val))
 101      (else "")))
 102
 103   (define (output-entry ps-key ly-key)
 104     (string-append
 105      "/" ps-key " "
 106      (value->string (ly:output-def-lookup layout ly-key)) " def\n"))
 107
 108   (string-append
 109    "/lily-output-units "
 110      (number->string mm-to-bigpoint)
 111      " def %% millimeter\n"
 112    (output-entry "staff-line-thickness" 'linethickness)
 113    (output-entry "line-width" 'linewidth)
 114    (output-entry "paper-size" 'papersizename)
 115    (output-entry "staff-height" 'staffheight)   ;junkme.
 116    "/output-scale "
 117      (number->string (ly:output-def-lookup layout 'outputscale))
 118      " def\n"
 119    (output-entry "page-height" 'vsize)
 120    (output-entry "page-width" 'hsize)))
 121
 122 (define (dump-page outputter page page-number page-count landscape?)
 123   (ly:outputter-dump-string outputter
 124                             (string-append
 125                              "%%Page: "
 126                              (number->string page-number) " " (number->string page-count) "\n"
 127
 128                              "%%BeginPageSetup\n"
 129                              (if landscape?
 130                                  "page-width output-scale mul 0 translate 90 rotate\n"
 131                                  "")
 132                              "%%EndPageSetup\n"
 133
 134                              "start-page { "
 135                              "set-ps-scale-to-lily-scale "
 136                              "\n"))
 137   (ly:outputter-dump-stencil outputter page)
 138   (ly:outputter-dump-string outputter "} stop-system \nshowpage\n"))
 139
 140
 141 (define (supplies-or-needs paper load-fonts?)
 142   (define (extract-names font)
 143     (if (ly:pango-font? font)
 144         (map car (ly:pango-font-physical-fonts font))
 145         (list (ly:font-name font))))
 146
 147   (let* ((fonts (ly:paper-fonts paper))
 148          (names (apply append (map extract-names fonts)))
 149          )
 150
 151     (apply string-append
 152            (map (lambda (f)
 153                   (format
 154                    (if load-fonts?
 155                     "%%DocumentSuppliedResources: font ~a\n"
 156                     "%%DocumentNeededResources: font ~a\n")
 157                    f))
 158                 names))))
 159
 160 (define (eps-header paper bbox load-fonts?)
 161     (string-append "%!PS-Adobe-2.0 EPSF-2.0\n"
 162                  "%%Creator: creator time-stamp\n"
 163                  "%%BoundingBox: "
 164                  (string-join (map ly:number->string bbox) " ") "\n"
 165                  "%%Orientation: "
 166                  (if (eq? (ly:output-def-lookup paper 'landscape) #t)
 167                      "Landscape\n"
 168                      "Portrait\n")
 169                  (supplies-or-needs paper load-fonts?)
 170                  "%%EndComments\n"))
 171
 172 (define (page-header paper page-count load-fonts?)
 173   (string-append "%!PS-Adobe-3.0\n"
 174                  "%%Creator: creator time-stamp\n"
 175                  "%%Pages: " (number->string page-count) "\n"
 176                  "%%PageOrder: Ascend\n"
 177                  "%%Orientation: "
 178                  (if (eq? (ly:output-def-lookup paper 'landscape) #t)
 179                      "Landscape\n"
 180                      "Portrait\n")
 181                  "%%DocumentPaperSizes: "
 182                  (ly:output-def-lookup paper 'papersizename) "\n"
 183                  (supplies-or-needs paper load-fonts?)
 184                  "%%EndComments\n"))
 185
 186 (define (procset file-name)
 187   (string-append
 188    (format
 189     "%%BeginResource: procset (~a) 1 0
 190 ~a
 191 %%EndResource
 192 "
 193     file-name (cached-file-contents file-name))))
 194
 195 (define (setup paper)
 196   (string-append
 197    "\n"
 198    "%%BeginSetup\n"
 199    (define-fonts paper)
 200    (output-variables paper)
 201    "init-lilypond-parameters\n"
 202    "%%EndSetup\n"))
 203
 204 (define (write-preamble paper load-fonts? port)
 205   (define (load-fonts paper)
 206     (let* ((fonts (ly:paper-fonts paper))
 207            (all-font-names
 208             (map
 209              (lambda (font)
 210                (cond
 211                 ((string? (ly:font-file-name font)) (list (ly:font-file-name font)))
 212                 ((ly:pango-font? font)
 213                  (map cdr  (ly:pango-font-physical-fonts font)))
 214                 (else (ly:font-sub-fonts font))))
 215
 216              fonts))
 217
 218            (font-names
 219             (uniq-list
 220              (sort (apply append all-font-names) string<?)))
 221            (pfas (map
 222                   (lambda (x)
 223                     (let* ((bare-file-name (ly:find-file x))
 224                            (cffname (string-append x ".cff.ps"))
 225                            (aname (string-append x ".pfa"))
 226                            (bname (string-append x ".pfb"))
 227                            (cff-file-name (ly:find-file cffname))
 228                            (a-file-name (ly:kpathsea-find-file aname))
 229                            (b-file-name (ly:kpathsea-find-file bname)))
 230                       (cond
 231                        (bare-file-name (if (string-match "\\.pfb" bare-file-name)
 232                                            (ly:pfb->pfa bare-file-name)
 233                                            (cached-file-contents bare-file-name)))
 234                        (cff-file-name  (cached-file-contents cff-file-name))
 235                        (a-file-name (ps-embed-pfa (cached-file-contents a-file-name) x 0))
 236                        (b-file-name (ps-embed-pfa (ly:pfb->pfa b-file-name) x 0))
 237                        (else
 238                         (ly:warn "cannot find CFF/PFA/PFB font ~S" x)
 239                         ""))))
 240                   (filter string? font-names))))
 241            pfas))
 242
 243
 244   (display (procset "music-drawing-routines.ps") port)
 245   (display (procset "lilyponddefs.ps") port)
 246   (if load-fonts?
 247       (for-each (lambda (f) (display f port)) (load-fonts paper)))
 248   (display (setup paper) port))
 249
 250 (define-public (output-framework basename book scopes fields)
 251   (let* ((filename (format "~a.ps" basename))
 252          (outputter  (ly:make-paper-outputter filename "ps"))
 253          (paper (ly:paper-book-paper book))
 254          (pages (ly:paper-book-pages book))
 255          (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
 256          (page-number (1- (ly:output-def-lookup paper 'firstpagenumber)))
 257          (page-count (length pages))
 258          (port (ly:outputter-port outputter)))
 259
 260
 261     (display (page-header paper page-count #t) port)
 262     (write-preamble paper #t  port)
 263
 264     (for-each
 265      (lambda (page)
 266        (set! page-number (1+ page-number))
 267        (dump-page outputter page page-number page-count landscape?))
 268      pages)
 269
 270     (display "%%Trailer\n%%EOF\n" port)
 271     (ly:outputter-close outputter)
 272     (postprocess-output book framework-ps-module filename (ly:output-formats))
 273 ))
 274
 275 (if (not (defined? 'nan?))
 276     (define (nan? x) #f))
 277 (if (not (defined? 'inf?))
 278     (define (inf? x) #f))
 279
 280
 281 (define-public (dump-stencil-as-EPS paper dump-me filename load-fonts?)
 282   (define (mm-to-bp-box mmbox)
 283     (let*
 284         ((scale  (ly:output-def-lookup paper 'outputscale))
 285          (box (map
 286                (lambda (x)
 287                  (inexact->exact
 288                   (round (* x scale mm-to-bigpoint)))) mmbox)))
 289
 290     (list (car box) (cadr box)
 291           (max (1+ (car box)) (caddr box))
 292           (max (1+ (cadr box)) (cadddr box)))))
 293
 294   (let*
 295       ((outputter (ly:make-paper-outputter (format "~a.eps" filename)
 296                                            "ps"))
 297
 298        (port (ly:outputter-port outputter))
 299        (xext (ly:stencil-extent dump-me X))
 300        (yext (ly:stencil-extent dump-me Y))
 301
 302        (bbox
 303         (map
 304          (lambda (x)
 305            (if (or (nan? x) (inf? x))
 306                0.0 x))
 307          (list (car xext) (car yext)
 308                (cdr xext) (cdr yext))))
 309        (rounded-bbox (mm-to-bp-box bbox))
 310        (port (ly:outputter-port outputter))
 311        (header (eps-header paper rounded-bbox load-fonts?)))
 312
 313     (display header port)
 314     (write-preamble paper load-fonts? port)
 315     (display "start-system { set-ps-scale-to-lily-scale \n" port)
 316     (ly:outputter-dump-stencil outputter dump-me)
 317     (display "} stop-system\n%%Trailer\n%%EOF\n" port)
 318     (ly:outputter-close outputter)
 319     ))
 320
 321
 322 (define-public (output-preview-framework basename book scopes fields )
 323   (let* ((paper (ly:paper-book-paper book))
 324          (systems (ly:paper-book-systems book))
 325          (scale  (ly:output-def-lookup paper 'outputscale))
 326          (titles (take-while ly:paper-system-title? systems))
 327          (non-title (find (lambda (x)
 328                             (not (ly:paper-system-title? x))) systems))
 329          (dump-me
 330           (stack-stencils Y DOWN 0.0
 331                           (map ly:paper-system-stencil
 332                                (append titles (list non-title))))))
 333     (dump-stencil-as-EPS paper dump-me
 334                          (format "~a.preview" basename)
 335                          #t)))
 336
 337
 338
 339 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 340
 341 (define-public (convert-to-pdf book name)
 342   (let* ((defs (ly:paper-book-paper book))
 343          (papersizename (ly:output-def-lookup defs 'papersizename)))
 344
 345     (if (equal? name "-")
 346         (ly:warn "Can't convert <stdout> to PDF")
 347         (postscript->pdf (if (string? papersizename) papersizename "a4")
 348                          name))))
 349
 350 (define-public (convert-to-png book name)
 351   (let* ((defs (ly:paper-book-paper book))
 352          (resolution (ly:output-def-lookup defs 'pngresolution)))
 353
 354     (postscript->png (if (number? resolution) resolution
 355
 356                          (ly:get-option 'resolution))
 357                      name)))
 358
 359 (define-public (convert-to-dvi book name)
 360   (ly:warn "Can not generate DVI via the postscript back-end"))
 361
 362 (define-public (convert-to-tex book name)
 363   (ly:warn "Can not generate TeX via the postscript back-end"))
 364
 365 (define-public (convert-to-ps book name)
 366   #t)