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