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