scm/framework-ps.scm

   1 ;;;; framework-ps.scm -- structure for PostScript output
   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
  20 (define framework-ps-module (current-module))
  21
  22 ;;(define pdebug stderr)
  23 (define (pdebug . rest) #f)
  24
  25 (define mm-to-bigpoint
  26   (/ 72 25.4))
  27
  28 (define-public (ps-font-command font)
  29   (let* ((name (munge-lily-font-name (ly:font-file-name font)))
  30          (magnify (ly:font-magnification font)))
  31
  32     (string-append
  33      "magfont"
  34      (string-regexp-substitute "[ /%]" "_" name)
  35      "m" (string-encode-integer (inexact->exact (round (* 1000 magnify)))))))
  36
  37 (define (tex-font? fontname)
  38   (or
  39    (equal? (substring fontname 0 2) "cm")
  40    (equal? (substring fontname 0 2) "ec")))
  41
  42 (define (define-fonts paper)
  43   (define font-list (ly:paper-fonts paper))
  44   (define (define-font command fontname scaling)
  45     (string-append
  46      "/" command " { /" fontname " findfont "
  47      (ly:number->string scaling) " output-scale div scalefont } bind def\n"))
  48
  49   (define (standard-tex-font? x)
  50     (or (equal? (substring x 0 2) "ms")
  51         (equal? (substring x 0 2) "cm")))
  52
  53   (define (font-load-command font)
  54     (let* ((specced-font-name (ly:font-name font))
  55            (fontname (if specced-font-name
  56                          (munge-lily-font-name specced-font-name)
  57                          (ly:font-file-name font)))
  58            (command (ps-font-command font))
  59
  60            ;; FIXME -- see (ps-font-command )
  61            (plain (ps-font-command font))
  62            (designsize (ly:font-design-size font))
  63            (magnification (* (ly:font-magnification font)))
  64            (ops (ly:output-def-lookup paper 'outputscale))
  65            (scaling (* ops magnification designsize)))
  66
  67       ;; Bluesky pfbs have UPCASE names (sigh.)
  68       ;; FIXME - don't support Bluesky?
  69       (if (standard-tex-font? fontname)
  70           (set! fontname (string-upcase fontname)))
  71       (if (equal? fontname "unknown")
  72           (display (list font fontname)))
  73       (define-font plain fontname scaling)))
  74
  75   (apply string-append
  76          (map (lambda (x) (font-load-command x))
  77               (filter (lambda (x) (not (ly:pango-font? x)))
  78                       font-list))))
  79
  80 ;; FIXME: duplicated in other output backends
  81 ;; FIXME: silly interface name
  82 (define (output-variables layout)
  83   ;; FIXME: duplicates output-layout's scope-entry->string, mostly
  84   (define (value->string val)
  85     (cond
  86      ((string? val) (string-append "(" val ")"))
  87      ((symbol? val) (symbol->string val))
  88      ((number? val) (number->string val))
  89      (else "")))
  90
  91   (define (output-entry ps-key ly-key)
  92     (string-append
  93      "/" ps-key " "
  94      (value->string (ly:output-def-lookup layout ly-key)) " def\n"))
  95
  96   (string-append
  97    "/lily-output-units "
  98      (number->string mm-to-bigpoint)
  99      " def %% millimeter\n"
 100    (output-entry "staff-line-thickness" 'linethickness)
 101    (output-entry "line-width" 'linewidth)
 102    (output-entry "paper-size" 'papersizename)
 103    (output-entry "staff-height" 'staffheight)   ;junkme.
 104    "/output-scale "
 105      (number->string (ly:output-def-lookup layout 'outputscale))
 106      " def\n"
 107    (output-entry "page-height" 'vsize)
 108    (output-entry "page-width" 'hsize)))
 109
 110 (define (dump-page outputter page page-number page-count landscape?)
 111   (ly:outputter-dump-string
 112    outputter
 113    (string-append
 114     "%%Page: "
 115     (number->string page-number) " " (number->string page-count) "\n"
 116
 117     "%%BeginPageSetup\n"
 118     (if landscape?
 119         "page-width output-scale lily-output-units mul mul 0 translate 90 rotate\n"
 120         "")
 121     "%%EndPageSetup\n"
 122
 123     "start-page { "
 124     "set-ps-scale-to-lily-scale "
 125     "\n"))
 126   (ly:outputter-dump-stencil outputter page)
 127   (ly:outputter-dump-string outputter "} stop-system \nshowpage\n"))
 128
 129 (define (supplies-or-needs paper load-fonts?)
 130   (define (extract-names font)
 131     (if (ly:pango-font? font)
 132         (map car (ly:pango-font-physical-fonts font))
 133         (list (munge-lily-font-name (ly:font-name font)))))
 134
 135   (let* ((fonts (ly:paper-fonts paper))
 136          (names (apply append (map extract-names fonts))))
 137
 138     (apply string-append
 139            (map (lambda (f)
 140                   (format
 141                    (if load-fonts?
 142                     "%%DocumentSuppliedResources: font ~a\n"
 143                     "%%DocumentNeededResources: font ~a\n")
 144                    f))
 145                 (uniq-list (sort names string<?))))))
 146
 147 (define (eps-header paper bbox load-fonts?)
 148   (string-append "%!PS-Adobe-2.0 EPSF-2.0\n"
 149                  "%%Creator: LilyPond\n"
 150                  "%%BoundingBox: "
 151                  (string-join (map ly:number->string bbox) " ") "\n"
 152                  "%%Orientation: "
 153                  (if (eq? (ly:output-def-lookup paper 'landscape) #t)
 154                      "Landscape\n"
 155                      "Portrait\n")
 156                  (supplies-or-needs paper load-fonts?)
 157                  "%%EndComments\n"))
 158
 159 (define (page-header paper page-count load-fonts?)
 160   (string-append "%!PS-Adobe-3.0\n"
 161                  "%%Creator: LilyPond\n"
 162                  "%%Pages: " (number->string page-count) "\n"
 163                  "%%PageOrder: Ascend\n"
 164                  "%%Orientation: "
 165                  (if (eq? (ly:output-def-lookup paper 'landscape) #t)
 166                      "Landscape\n"
 167                      "Portrait\n")
 168                  "%%DocumentPaperSizes: "
 169                  (ly:output-def-lookup paper 'papersizename) "\n"
 170                  (supplies-or-needs paper load-fonts?)
 171                  "%%EndComments\n"))
 172
 173 (define (procset file-name)
 174   (string-append
 175    (format
 176     "%%BeginResource: procset (~a) 1 0
 177 ~a
 178 %%EndResource
 179 "
 180     file-name (cached-file-contents file-name))))
 181
 182 (define (setup paper)
 183   (string-append
 184    "\n"
 185    "%%BeginSetup\n"
 186    (define-fonts paper)
 187    (output-variables paper)
 188    "%%EndSetup\n"))
 189
 190 (define-public (munge-lily-font-name name)
 191   ;; FIXME: this fixes PFAPAFemmentaler.pfapfa, and also
 192   ;; PFAaybabtu.otf.pfa, but the second case now produces aybabtu.otf,
 193   ;; which still fails because .otf files cannot be embedded.
 194   (regexp-substitute/global #f "^([eE]mmentaler|[aA]ybabtu)"
 195                             name 'pre "PFA" 1 'post))
 196
 197 (define (cff-font? font)
 198   (let*
 199       ((cff-string (ly:otf-font-table-data font "CFF ")))
 200     (> (string-length cff-string) 0)))
 201
 202 (define-public (ps-embed-cff body font-set-name version)
 203   (let* ((binary-data
 204           (string-append
 205            (format "/~a ~s StartData " font-set-name (string-length body))
 206            body))
 207
 208          (header
 209           (format
 210            "%%BeginResource: font ~a
 211 %!PS-Adobe-3.0 Resource-FontSet
 212 %%DocumentNeededResources: ProcSet (FontSetInit)
 213 %%Title: (FontSet/~a)
 214 %%Version: ~s
 215 %%EndComments
 216 %%IncludeResource: ProcSet (FontSetInit)
 217 %%BeginResource: FontSet (~a)
 218 /FontSetInit /ProcSet findresource begin
 219 %%BeginData: ~s Binary Bytes
 220 "
 221            font-set-name font-set-name version font-set-name
 222            (string-length binary-data)))
 223          (footer "\n%%EndData
 224 %%EndResource
 225 %%EOF
 226 %%EndResource\n"))
 227
 228     (string-append
 229      header
 230      binary-data
 231      footer)))
 232
 233
 234 (define (write-preamble paper load-fonts? port)
 235
 236   (define (load-font-via-GS font-name-filename)
 237     (define (ps-load-file name)
 238       (format
 239        (if (string? name)
 240            "(~a) (r) file .loadfont\n"
 241            "% can't find font file: ~a\n")
 242        name))
 243
 244     (let* ((font (car font-name-filename))
 245            (name (cadr font-name-filename))
 246            (file-name (caddr font-name-filename))
 247            (bare-file-name (ly:find-file file-name)))
 248
 249       (cons
 250        (munge-lily-font-name name)
 251        (cond
 252         ((string-match "^([eE]mmentaler|[Aa]ybabtu)" file-name)
 253          (ps-load-file (ly:find-file
 254                         (format "~a.pfa" (munge-lily-font-name file-name)))))
 255         ((string? bare-file-name)
 256          (ps-load-file (munge-lily-font-name file-name)))
 257         (else
 258          (ly:warning (_ "can't embed ~S=~S") name file-name)
 259           "")))))
 260
 261   (define (dir-join a b)
 262     (if (equal? a "")
 263         b
 264         (string-append a "/" b)))
 265
 266   (define (dir-listing dir-name)
 267     (define (dir-helper dir lst)
 268       (let ((e (readdir dir)))
 269         (if (eof-object? e) lst (dir-helper dir (cons e lst)))))
 270     (reverse (dir-helper (opendir dir-name) '())))
 271
 272   (define (handle-mac-font name filename)
 273     (let*
 274         ((dir-name  (tmpnam))
 275          (files '())
 276          (status 0)
 277          (embed #f))
 278
 279
 280       (mkdir dir-name #o700)
 281
 282       (set! status (ly:system
 283                     (format "cd ~a && fondu -force '~a'" dir-name filename)))
 284
 285       (set! files (dir-listing dir-name))
 286
 287       (for-each
 288        (lambda (f)
 289          (if (and (not embed)
 290                   (string-match (string-append name "\\.") f))
 291              (set! embed
 292                    (font-file-as-ps-string name (dir-join dir-name f))))
 293
 294          (if (or (equal? "." f)
 295                  (equal? ".." f))
 296              #t
 297              (delete-file (dir-join dir-name f))))
 298        files)
 299       (rmdir dir-name)
 300
 301       (if (not embed)
 302           (begin
 303             (set! embed "% failed \n")
 304             (ly:warning (_ "can't extract file matching ~a from ~a") name filename)))
 305       embed))
 306
 307     (define (font-file-as-ps-string name file-name)
 308       (let*
 309           ((downcase-file-name (string-downcase file-name)))
 310
 311       (cond
 312        ((and file-name (string-match "\\.pfa" downcase-file-name))
 313         (cached-file-contents file-name))
 314        ((and file-name (string-match "\\.pfb" downcase-file-name))
 315         (ly:pfb->pfa file-name))
 316        ((and file-name (string-match "\\.ttf" downcase-file-name))
 317         (ly:ttf->pfa file-name))
 318        ((and file-name (string-match "\\.otf" downcase-file-name))
 319         (ps-embed-cff (ly:otf->cff file-name) name 0))
 320        (else
 321         (ly:warning (_ "don't know how to embed ~S=~S") name file-name)
 322         ""))))
 323
 324   (define (load-font font-name-filename)
 325     (let* ((font (car font-name-filename))
 326            (name (cadr font-name-filename))
 327            (file-name (caddr font-name-filename))
 328            (bare-file-name (ly:find-file file-name)))
 329
 330       (cons
 331        (munge-lily-font-name name)
 332        (cond
 333         ((string-match "^([eE]mmentaler|[Aa]ybabtu)" file-name)
 334          (cached-file-contents
 335           (format "~a.pfa" (munge-lily-font-name file-name))))
 336         ((and
 337           (eq? PLATFORM 'darwin)
 338           bare-file-name (string-match "\\.dfont" bare-file-name))
 339          (handle-mac-font name bare-file-name))
 340
 341         ((and
 342           (eq? PLATFORM 'darwin)
 343           bare-file-name (= (stat:size (stat bare-file-name)) 0))
 344          (handle-mac-font name bare-file-name))
 345
 346         ((and font (cff-font? font))
 347          (ps-embed-cff (ly:otf-font-table-data font "CFF ")
 348                        name
 349                        0))
 350
 351         (bare-file-name (font-file-as-ps-string name bare-file-name))
 352         (else
 353          (ly:warning (_ "don't know how to embed font ~s ~s ~s")
 354                      name file-name font))))))
 355
 356
 357   (define (load-fonts paper)
 358     (let* ((fonts (ly:paper-fonts paper))
 359            (all-font-names
 360             (map
 361              (lambda (font)
 362                (cond
 363                 ((string? (ly:font-file-name font))
 364                  (list (list
 365                         font
 366                         (ly:font-name font)
 367                         (ly:font-file-name font))))
 368                 ((ly:pango-font? font)
 369                  (map
 370                   (lambda (name-psname-pair)
 371                     (list #f
 372                           (car name-psname-pair)
 373                           (cdr name-psname-pair)))
 374                   (ly:pango-font-physical-fonts font)))
 375
 376                 (else
 377                  (ly:font-sub-fonts font))))
 378
 379              fonts))
 380            (font-names
 381             (uniq-list
 382              (sort (apply append all-font-names)
 383                    (lambda (x y) (string<? (cadr x) (cadr y))))))
 384
 385
 386            (font-loader (if (ly:get-option 'gs-font-load)
 387                             load-font-via-GS
 388                             load-font))
 389
 390            (pfas (map font-loader font-names)))
 391       pfas))
 392
 393   (if load-fonts?
 394       (for-each
 395        (lambda (f)
 396          (format port "\n%%BeginFont: ~a\n" (car f))
 397          (display (cdr f) port)
 398          (display "\n%%EndFont\n" port))
 399        (load-fonts paper)))
 400
 401   (display (setup paper) port)
 402
 403   ;; adobe note 5002: should initialize variables before loading routines.
 404   (display (procset "music-drawing-routines.ps") port)
 405   (display (procset "lilyponddefs.ps") port)
 406   (display "init-lilypond-parameters\n" port))
 407
 408 (define-public (output-framework basename book scopes fields)
 409   (let* ((filename (format "~a.ps" basename))
 410          (outputter (ly:make-paper-outputter
 411                      ;; FIXME: better wrap open/open-file,
 412                      ;; content-mangling is always bad.
 413                      ;; MINGW hack: need to have "b"inary for embedding CFFs
 414                      (open-file filename "wb")
 415                      "ps"))
 416          (paper (ly:paper-book-paper book))
 417          (pages (ly:paper-book-pages book))
 418          (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
 419          (page-number (1- (ly:output-def-lookup paper 'firstpagenumber)))
 420          (page-count (length pages))
 421          (port (ly:outputter-port outputter)))
 422
 423     (paper-book-write-midis book basename)
 424
 425     (output-scopes scopes fields basename)
 426     (display (page-header paper page-count #t) port)
 427     (write-preamble paper #t port)
 428
 429     (for-each
 430      (lambda (page)
 431        (set! page-number (1+ page-number))
 432        (dump-page outputter page page-number page-count landscape?))
 433      pages)
 434
 435     (display "%%Trailer\n%%EOF\n" port)
 436     (ly:outputter-close outputter)
 437     (postprocess-output book framework-ps-module filename
 438                          (ly:output-formats))))
 439
 440 (if (not (defined? 'nan?))
 441     (define (nan? x) #f))
 442
 443 (if (not (defined? 'inf?))
 444     (define (inf? x) #f))
 445
 446 (define-public (dump-stencil-as-EPS paper dump-me filename load-fonts?)
 447   (define (mm-to-bp-box mmbox)
 448     (let* ((scale (ly:output-def-lookup paper 'outputscale))
 449            (box (map
 450                  (lambda (x)
 451                    (inexact->exact
 452                     (round (* x scale mm-to-bigpoint)))) mmbox)))
 453
 454     (list (car box) (cadr box)
 455           (max (1+ (car box)) (caddr box))
 456           (max (1+ (cadr box)) (cadddr box)))))
 457
 458   (let* ((outputter (ly:make-paper-outputter
 459                      ;; FIXME: better wrap open/open-file,
 460                      ;; content-mangling is always bad.
 461                      ;; MINGW hack: need to have "b"inary for embedding CFFs
 462                      (open-file (format "~a.eps" filename) "wb")
 463                      "ps"))
 464          (port (ly:outputter-port outputter))
 465          (xext (ly:stencil-extent dump-me X))
 466          (yext (ly:stencil-extent dump-me Y))
 467          (bbox
 468           (map
 469            (lambda (x)
 470              (if (or (nan? x) (inf? x)
 471                      ;; FIXME: huh?
 472                      (equal? (format #f "~S" x) "+#.#")
 473                      (equal? (format #f "~S" x) "-#.#"))
 474                  0.0 x))
 475            (list (car xext) (car yext) (cdr xext) (cdr yext))))
 476          (rounded-bbox (mm-to-bp-box bbox))
 477          (port (ly:outputter-port outputter))
 478          (header (eps-header paper rounded-bbox load-fonts?)))
 479
 480     (display header port)
 481     (write-preamble paper load-fonts? port)
 482     (display "start-system { set-ps-scale-to-lily-scale \n" port)
 483     (ly:outputter-dump-stencil outputter dump-me)
 484     (display "} stop-system\n%%Trailer\n%%EOF\n" port)
 485     (ly:outputter-close outputter)))
 486
 487 (define-public (output-preview-framework basename book scopes fields)
 488   (let* ((paper (ly:paper-book-paper book))
 489          (systems (ly:paper-book-systems book))
 490          (scale (ly:output-def-lookup paper 'outputscale))
 491          (to-dump-systems '()))
 492
 493     ;; skip booktitles.
 494     (if (and
 495          (not
 496           (ly:get-option 'preview-include-book-title))
 497          (< 1 (length systems))
 498          (ly:paper-system-title? (list-ref systems 0))
 499          (ly:paper-system-title? (list-ref systems 1)))
 500         (set! systems (cdr systems)))
 501
 502     (for-each
 503      (lambda (sys)
 504        (if (or
 505             (ly:paper-system-title? sys)
 506             (not (pair? to-dump-systems))
 507             (ly:paper-system-title? (car to-dump-systems)))
 508            (set! to-dump-systems (cons sys to-dump-systems))))
 509      systems)
 510
 511     (dump-stencil-as-EPS
 512      paper
 513      (stack-stencils Y DOWN 0.0
 514                      (map ly:paper-system-stencil (reverse to-dump-systems)))
 515      (format "~a.preview" basename)
 516      #t)
 517
 518     (postprocess-output book framework-ps-module
 519                         (format "~a.preview.eps" basename)
 520                         (cons "png" (ly:output-formats)))))
 521 (if #f
 522     (define-public (output-preview-framework basename book scopes fields)
 523
 524       (let* ((paper (ly:paper-book-paper book))
 525              (systems (ly:paper-book-systems book))
 526              (scale (ly:output-def-lookup paper 'outputscale))
 527              (titles (take-while ly:paper-system-title? systems))
 528              (non-title (find (lambda (x)
 529                                 (not (ly:paper-system-title? x))) systems))
 530              (dump-me
 531               (stack-stencils Y DOWN 0.0
 532                               (map ly:paper-system-stencil
 533                                    (append titles (list non-title))))))
 534         (output-scopes scopes fields basename)
 535         (dump-stencil-as-EPS paper dump-me
 536                              (format "~a.preview" basename)
 537                              #t)
 538
 539         (postprocess-output book framework-ps-module
 540                             (format "~a.preview.eps" basename)
 541                              (ly:output-formats)))))
 542 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 543
 544 (define-public (convert-to-pdf book name)
 545   (let* ((defs (ly:paper-book-paper book))
 546          (papersizename (ly:output-def-lookup defs 'papersizename)))
 547
 548     (if (equal? (basename name ".ps") "-")
 549         (ly:warning (_ "can't convert <stdout> to ~S" "PDF"))
 550         (postscript->pdf (if (string? papersizename) papersizename "a4")
 551                          name))))
 552
 553 (define-public (convert-to-png book name)
 554   (let* ((defs (ly:paper-book-paper book))
 555          (defs-resolution (ly:output-def-lookup defs 'pngresolution))
 556          (resolution (if (number? defs-resolution)
 557                          defs-resolution
 558                          (ly:get-option 'resolution)))
 559          (papersizename (ly:output-def-lookup defs 'papersizename)))
 560
 561     (postscript->png resolution
 562                      (if (string? papersizename) papersizename "a4")
 563                      name)))
 564
 565 (define-public (convert-to-dvi book name)
 566   (ly:warning (_ "can't generate ~S using the postscript back-end") "DVI"))
 567
 568 (define-public (convert-to-tex book name)
 569   (ly:warning (_ "can't generate ~S using the postscript back-end") "TeX"))
 570
 571 (define-public (convert-to-ps book name)
 572   #t)
 573
 574 (define-public (output-classic-framework basename book scopes fields)
 575
 576   (ly:error (_ "\nThe PostScript backend does not support the 'classic'
 577 framework. Use the EPS backend instead,
 578
 579   lilypond -b eps <file>
 580
 581 or remove the lilypond-book specific settings from the input.
 582 ")))