scm/framework-ps.scm

   1 ;;;; framework-ps.scm --
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c) 2004--2005 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\n"
  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
 131  lily-output-units mul
 132  mul 0 translate 90 rotate\n"
 133                                  "")
 134                              "%%EndPageSetup\n"
 135
 136                              "start-page { "
 137                              "set-ps-scale-to-lily-scale "
 138                              "\n"))
 139   (ly:outputter-dump-stencil outputter page)
 140   (ly:outputter-dump-string outputter "} stop-system \nshowpage\n"))
 141
 142
 143 (define (supplies-or-needs paper load-fonts?)
 144   (define (extract-names font)
 145     (if (ly:pango-font? font)
 146         (map car (ly:pango-font-physical-fonts font))
 147         (list (ly:font-name font))))
 148
 149   (let* ((fonts (ly:paper-fonts paper))
 150          (names (apply append (map extract-names fonts)))
 151          )
 152
 153     (apply string-append
 154            (map (lambda (f)
 155                   (format
 156                    (if load-fonts?
 157                     "%%DocumentSuppliedResources: font ~a\n"
 158                     "%%DocumentNeededResources: font ~a\n")
 159                    f))
 160                 (uniq-list (sort names string<?))))))
 161
 162 (define (eps-header paper bbox load-fonts?)
 163     (string-append "%!PS-Adobe-2.0 EPSF-2.0\n"
 164                  "%%Creator: LilyPond\n"
 165                  "%%BoundingBox: "
 166                  (string-join (map ly:number->string bbox) " ") "\n"
 167                  "%%Orientation: "
 168                  (if (eq? (ly:output-def-lookup paper 'landscape) #t)
 169                      "Landscape\n"
 170                      "Portrait\n")
 171                  (supplies-or-needs paper load-fonts?)
 172                  "%%EndComments\n"))
 173
 174 (define (page-header paper page-count load-fonts?)
 175   (string-append "%!PS-Adobe-3.0\n"
 176                  "%%Creator: LilyPond\n"
 177                  "%%Pages: " (number->string page-count) "\n"
 178                  "%%PageOrder: Ascend\n"
 179                  "%%Orientation: "
 180                  (if (eq? (ly:output-def-lookup paper 'landscape) #t)
 181                      "Landscape\n"
 182                      "Portrait\n")
 183                  "%%DocumentPaperSizes: "
 184                  (ly:output-def-lookup paper 'papersizename) "\n"
 185                  (supplies-or-needs paper load-fonts?)
 186                  "%%EndComments\n"))
 187
 188 (define (procset file-name)
 189   (string-append
 190    (format
 191     "%%BeginResource: procset (~a) 1 0
 192 ~a
 193 %%EndResource
 194 "
 195     file-name (cached-file-contents file-name))))
 196
 197 (define (setup paper)
 198   (string-append
 199    "\n"
 200    "%%BeginSetup\n"
 201    (define-fonts paper)
 202    (output-variables paper)
 203    "init-lilypond-parameters\n"
 204    "%%EndSetup\n"))
 205
 206 (define (write-preamble paper load-fonts? port)
 207   (define (load-fonts paper)
 208     (let* ((fonts (ly:paper-fonts paper))
 209            (all-font-names
 210             (map
 211              (lambda (font)
 212                (cond
 213                 ((string? (ly:font-file-name font)) (list (ly:font-file-name font)))
 214                 ((ly:pango-font? font)
 215                  (map cdr  (ly:pango-font-physical-fonts font)))
 216                 (else (ly:font-sub-fonts font))))
 217
 218              fonts))
 219
 220            (font-names
 221             (uniq-list
 222              (sort (apply append all-font-names) string<?)))
 223            (pfas (map
 224                   (lambda (x)
 225                     (let* ((bare-file-name (ly:find-file x))
 226                            (cffname (string-append x ".cff.ps"))
 227                            (aname (string-append x ".pfa"))
 228                            (bname (string-append x ".pfb"))
 229                            (cff-file-name (ly:find-file cffname))
 230                            (a-file-name (ly:kpathsea-find-file aname))
 231                            (b-file-name (ly:kpathsea-find-file bname))
 232                            )
 233                       (display  x )(newline)
 234                       (cond
 235                        ((and bare-file-name (string-match "\\.pfb" bare-file-name))
 236                         (ly:pfb->pfa bare-file-name))
 237                        ((and bare-file-name
 238                              (string-match "\\.otf" bare-file-name))
 239
 240                         (display "HOI\n")
 241                         (cached-file-contents (string-regexp-substitute "otf" "cff.ps" bare-file-name)))
 242                        ((and bare-file-name (string-match "\\.ttf" bare-file-name))
 243                         (ly:ttf->pfa bare-file-name))
 244                        (bare-file-name (cached-file-contents bare-file-name))
 245                        (cff-file-name  (cached-file-contents cff-file-name))
 246                        (a-file-name (ps-embed-pfa (cached-file-contents a-file-name) x 0))
 247                        (b-file-name (ps-embed-pfa (ly:pfb->pfa b-file-name) x 0))
 248                        (else
 249                         (ly:warn "cannot find CFF/PFA/PFB font ~S" x)
 250                         ""))))
 251                   (filter string? font-names))))
 252            pfas))
 253
 254   (display (procset "music-drawing-routines.ps") port)
 255   (display (procset "lilyponddefs.ps") port)
 256   (if load-fonts?
 257       (for-each (lambda (f) (display f port)) (load-fonts paper)))
 258   (display (setup paper) port))
 259
 260 (define-public (output-framework basename book scopes fields)
 261   (let* ((filename (format "~a.ps" basename))
 262          (outputter  (ly:make-paper-outputter filename "ps"))
 263          (paper (ly:paper-book-paper book))
 264          (pages (ly:paper-book-pages book))
 265          (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
 266          (page-number (1- (ly:output-def-lookup paper 'firstpagenumber)))
 267          (page-count (length pages))
 268          (port (ly:outputter-port outputter)))
 269
 270
 271     (display (page-header paper page-count #t) port)
 272     (write-preamble paper #t  port)
 273
 274     (for-each
 275      (lambda (page)
 276        (set! page-number (1+ page-number))
 277        (dump-page outputter page page-number page-count landscape?))
 278      pages)
 279
 280     (display "%%Trailer\n%%EOF\n" port)
 281     (ly:outputter-close outputter)
 282     (postprocess-output book framework-ps-module filename (ly:output-formats))
 283 ))
 284
 285 (if (not (defined? 'nan?))
 286     (define (nan? x) #f))
 287 (if (not (defined? 'inf?))
 288     (define (inf? x) #f))
 289
 290
 291 (define-public (dump-stencil-as-EPS paper dump-me filename load-fonts?)
 292   (define (mm-to-bp-box mmbox)
 293     (let*
 294         ((scale  (ly:output-def-lookup paper 'outputscale))
 295          (box (map
 296                (lambda (x)
 297                  (inexact->exact
 298                   (round (* x scale mm-to-bigpoint)))) mmbox)))
 299
 300     (list (car box) (cadr box)
 301           (max (1+ (car box)) (caddr box))
 302           (max (1+ (cadr box)) (cadddr box)))))
 303
 304   (let*
 305       ((outputter (ly:make-paper-outputter (format "~a.eps" filename)
 306                                            "ps"))
 307
 308        (port (ly:outputter-port outputter))
 309        (xext (ly:stencil-extent dump-me X))
 310        (yext (ly:stencil-extent dump-me Y))
 311
 312        (bbox
 313         (map
 314          (lambda (x)
 315            (if (or (nan? x) (inf? x))
 316                0.0 x))
 317          (list (car xext) (car yext)
 318                (cdr xext) (cdr yext))))
 319        (rounded-bbox (mm-to-bp-box bbox))
 320        (port (ly:outputter-port outputter))
 321        (header (eps-header paper rounded-bbox load-fonts?)))
 322
 323     (display header port)
 324     (write-preamble paper load-fonts? port)
 325     (display "start-system { set-ps-scale-to-lily-scale \n" port)
 326     (ly:outputter-dump-stencil outputter dump-me)
 327     (display "} stop-system\n%%Trailer\n%%EOF\n" port)
 328     (ly:outputter-close outputter)
 329     ))
 330
 331
 332 (define-public (output-preview-framework basename book scopes fields )
 333   (let* ((paper (ly:paper-book-paper book))
 334          (systems (ly:paper-book-systems book))
 335          (scale  (ly:output-def-lookup paper 'outputscale))
 336          (titles (take-while ly:paper-system-title? systems))
 337          (non-title (find (lambda (x)
 338                             (not (ly:paper-system-title? x))) systems))
 339          (dump-me
 340           (stack-stencils Y DOWN 0.0
 341                           (map ly:paper-system-stencil
 342                                (append titles (list non-title))))))
 343     (dump-stencil-as-EPS paper dump-me
 344                          (format "~a.preview" basename)
 345                          #t)))
 346
 347
 348
 349 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 350
 351 (define-public (convert-to-pdf book name)
 352   (let* ((defs (ly:paper-book-paper book))
 353          (papersizename (ly:output-def-lookup defs 'papersizename)))
 354
 355     (if (equal? name "-")
 356         (ly:warn "Can't convert <stdout> to PDF")
 357         (postscript->pdf (if (string? papersizename) papersizename "a4")
 358                          name))))
 359
 360 (define-public (convert-to-png book name)
 361   (let* ((defs (ly:paper-book-paper book))
 362          (resolution (ly:output-def-lookup defs 'pngresolution)))
 363
 364     (postscript->png (if (number? resolution) resolution
 365
 366                          (ly:get-option 'resolution))
 367                      name)))
 368
 369 (define-public (convert-to-dvi book name)
 370   (ly:warn "Can not generate DVI via the postscript back-end"))
 371
 372 (define-public (convert-to-tex book name)
 373   (ly:warn "Can not generate TeX via the postscript back-end"))
 374
 375 (define-public (convert-to-ps book name)
 376   #t)