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