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   (string-append
 192    (format
 193     "%%BeginResource: procset (~a) 1 0
 194 ~a
 195 %%EndResource
 196 "
 197     file-name (cached-file-contents file-name))))
 198
 199 (define (setup-variables paper)
 200   (string-append
 201    "\n"
 202    (define-fonts paper)
 203    (output-variables paper)
 204    ))
 205
 206 (define (cff-font? font)
 207   (let*
 208       ((cff-string (ly:otf-font-table-data font "CFF ")))
 209     (> (string-length cff-string) 0)))
 210
 211 (define-public (ps-embed-cff body font-set-name version)
 212   (let* ((binary-data
 213           (string-append
 214            (format "/~a ~s StartData " font-set-name (string-length body))
 215            body))
 216
 217          (header
 218           (format
 219            "%%BeginResource: font ~a
 220 %!PS-Adobe-3.0 Resource-FontSet
 221 %%DocumentNeededResources: ProcSet (FontSetInit)
 222 %%Title: (FontSet/~a)
 223 %%Version: ~s
 224 %%EndComments
 225 %%IncludeResource: ProcSet (FontSetInit)
 226 %%BeginResource: FontSet (~a)
 227 /FontSetInit /ProcSet findresource begin
 228 %%BeginData: ~s Binary Bytes
 229 "
 230            font-set-name font-set-name version font-set-name
 231            (string-length binary-data)))
 232          (footer "\n%%EndData
 233 %%EndResource
 234 %%EndResource\n"))
 235
 236     (string-append
 237      header
 238      binary-data
 239      footer)))
 240
 241
 242 (define (write-preamble paper load-fonts? port)
 243
 244   (define (load-font-via-GS font-name-filename)
 245     (define (ps-load-file name)
 246       (format
 247        (if (string? name)
 248            "(~a) (r) file .loadfont\n"
 249            "% can't find font file: ~a\n")
 250        name))
 251
 252     (let* ((font (car font-name-filename))
 253            (name (cadr font-name-filename))
 254            (file-name (caddr font-name-filename))
 255            (bare-file-name (ly:find-file file-name)))
 256
 257       (cons
 258        name
 259        (cond
 260         ((string-match "^([eE]mmentaler|[Aa]ybabtu)" file-name)
 261          (ps-load-file (ly:find-file
 262                         (format "~a.otf"  file-name))))
 263         ((string? bare-file-name)
 264          (ps-load-file file-name))
 265         (else
 266          (ly:warning (_ "can't embed ~S=~S") name file-name)
 267           "")))))
 268
 269   (define (dir-join a b)
 270     (if (equal? a "")
 271         b
 272         (string-append a "/" b)))
 273
 274   (define (dir-listing dir-name)
 275     (define (dir-helper dir lst)
 276       (let ((e (readdir dir)))
 277         (if (eof-object? e) lst (dir-helper dir (cons e lst)))))
 278     (reverse (dir-helper (opendir dir-name) '())))
 279
 280   (define (handle-mac-font name filename)
 281     (let*
 282         ((dir-name  (tmpnam))
 283          (files '())
 284          (status 0)
 285          (embed #f))
 286
 287       (mkdir dir-name #o700)
 288       (set! status (ly:system
 289                     (format "cd ~a && fondu -force '~a'" dir-name filename)))
 290
 291       (set! files (dir-listing dir-name))
 292
 293       (for-each
 294        (lambda (f)
 295          (let*
 296              ((full-name  (dir-join dir-name f)))
 297
 298            (if (and (not embed)
 299                     (equal? 'regular (stat:type (stat full-name)))
 300                     (equal? name (ly:ttf-ps-name full-name)))
 301
 302                (set! embed
 303                      (font-file-as-ps-string name full-name)))
 304
 305            (if (or (equal? "." f)
 306                    (equal? ".." f))
 307                #t
 308                (delete-file full-name))))
 309
 310
 311        files)
 312       (rmdir dir-name)
 313
 314       (if (not embed)
 315           (begin
 316             (set! embed "% failed \n")
 317             (ly:warning (_ "can't extract file matching ~a from ~a") name filename)))
 318       embed))
 319
 320     (define (font-file-as-ps-string name file-name)
 321       (let*
 322           ((downcase-file-name (string-downcase file-name)))
 323
 324       (cond
 325        ((and file-name (string-match "\\.pfa" downcase-file-name))
 326         (cached-file-contents file-name))
 327        ((and file-name (string-match "\\.pfb" downcase-file-name))
 328         (ly:pfb->pfa file-name))
 329        ((and file-name (string-match "\\.ttf" downcase-file-name))
 330         (ly:ttf->pfa file-name))
 331        ((and file-name (string-match "\\.otf" downcase-file-name))
 332         (ps-embed-cff (ly:otf->cff file-name) name 0))
 333        (else
 334         (ly:warning (_ "don't know how to embed ~S=~S") name file-name)
 335         ""))))
 336
 337   (define (load-font font-name-filename)
 338     (let* ((font (car font-name-filename))
 339            (name (cadr font-name-filename))
 340            (file-name (caddr font-name-filename))
 341            (bare-file-name (ly:find-file file-name)))
 342
 343       (cons
 344        name
 345        (cond
 346
 347         ((and
 348           (eq? PLATFORM 'darwin)
 349           bare-file-name (string-match "\\.dfont" bare-file-name))
 350          (handle-mac-font name bare-file-name))
 351
 352         ((and
 353           (eq? PLATFORM 'darwin)
 354           bare-file-name (= (stat:size (stat bare-file-name)) 0))
 355          (handle-mac-font name bare-file-name))
 356
 357         ((and font (cff-font? font))
 358          (ps-embed-cff (ly:otf-font-table-data font "CFF ")
 359                        name
 360                        0))
 361
 362         (bare-file-name (font-file-as-ps-string name bare-file-name))
 363         (else
 364          (ly:warning (_ "don't know how to embed font ~s ~s ~s")
 365                      name file-name font))))))
 366
 367
 368   (define (load-fonts paper)
 369     (let* ((fonts (ly:paper-fonts paper))
 370            (all-font-names
 371             (map
 372              (lambda (font)
 373                (cond
 374                 ((string? (ly:font-file-name font))
 375                  (list (list
 376                         font
 377                         (ly:font-name font)
 378                         (ly:font-file-name font))))
 379                 ((ly:pango-font? font)
 380                  (map
 381                   (lambda (name-psname-pair)
 382                     (list #f
 383                           (car name-psname-pair)
 384                           (cdr name-psname-pair)))
 385                   (ly:pango-font-physical-fonts font)))
 386
 387                 (else
 388                  (ly:font-sub-fonts font))))
 389
 390              fonts))
 391            (font-names
 392             (uniq-list
 393              (sort (apply append all-font-names)
 394                    (lambda (x y) (string<? (cadr x) (cadr y))))))
 395
 396
 397            (font-loader (if (ly:get-option 'gs-font-load)
 398                             load-font-via-GS
 399                             load-font))
 400
 401            (pfas (map font-loader font-names)))
 402       pfas))
 403
 404   (display "%%BeginProlog\n" port)
 405   (if load-fonts?
 406       (for-each
 407        (lambda (f)
 408          (format port "\n%%BeginFont: ~a\n" (car f))
 409          (display (cdr f) port)
 410          (display "\n%%EndFont\n" port))
 411        (load-fonts paper)))
 412
 413   (display (setup-variables paper) port)
 414
 415   ;; adobe note 5002: should initialize variables before loading routines.
 416   (display (procset "music-drawing-routines.ps") port)
 417   (display (procset "lilyponddefs.ps") port)
 418
 419   (display "%%EndProlog\n" port)
 420
 421   (display "%%BeginSetup\ninit-lilypond-parameters\n%%EndSetup\n\n" port))
 422
 423 (define-public (output-framework basename book scopes fields)
 424   (let* ((filename (format "~a.ps" basename))
 425          (outputter (ly:make-paper-outputter
 426                      ;; FIXME: better wrap open/open-file,
 427                      ;; content-mangling is always bad.
 428                      ;; MINGW hack: need to have "b"inary for embedding CFFs
 429                      (open-file filename "wb")
 430                      "ps"))
 431          (paper (ly:paper-book-paper book))
 432          (page-stencils (map page-stencil (ly:paper-book-pages book)))
 433
 434          (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
 435          (page-number (1- (ly:output-def-lookup paper 'first-page-number)))
 436          (page-count (length page-stencils))
 437          (port (ly:outputter-port outputter)))
 438
 439     (output-scopes scopes fields basename)
 440     (display (file-header paper page-count #t) port)
 441     (display "\n%%BeginDefaults
 442 %%PageMedia: a4
 443 %%EndDefaults\n" port)
 444
 445     (write-preamble paper #t port)
 446
 447     (for-each
 448      (lambda (page)
 449        (set! page-number (1+ page-number))
 450        (dump-page outputter page page-number page-count landscape?))
 451      page-stencils)
 452
 453     (display "%%Trailer\n%%EOF\n" port)
 454     (ly:outputter-close outputter)
 455     (postprocess-output book framework-ps-module filename
 456                          (ly:output-formats))))
 457
 458 (define-public (dump-stencil-as-EPS paper dump-me filename load-fonts?)
 459   (define (to-bp-box mmbox)
 460     (let* ((scale (ly:output-def-lookup paper 'output-scale))
 461            (box (map
 462                  (lambda (x)
 463                    (inexact->exact
 464                     (round (/ (* x scale) (ly:bp 1))))) mmbox)))
 465
 466     (list (car box)
 467           (cadr box)
 468           (max (1+ (car box)) (caddr box))
 469           (max (1+ (cadr box)) (cadddr box))
 470           )))
 471
 472   (let* ((outputter (ly:make-paper-outputter
 473                      ;; FIXME: better wrap open/open-file,
 474                      ;; content-mangling is always bad.
 475                      ;; MINGW hack: need to have "b"inary for embedding CFFs
 476                      (open-file (format "~a.eps" filename) "wb")
 477                      "ps"))
 478
 479          (left-overshoot -3)
 480          (port (ly:outputter-port outputter))
 481          (xext (ly:stencil-extent dump-me X))
 482          (yext (ly:stencil-extent dump-me Y))
 483          (bbox
 484           (map
 485            (lambda (x)
 486              (if (or (nan? x) (inf? x)
 487                      ;; FIXME: huh?
 488                      (equal? (format #f "~S" x) "+#.#")
 489                      (equal? (format #f "~S" x) "-#.#"))
 490                  0.0 x))
 491
 492            ;; the left-overshoot is to make sure that
 493            ;; bar numbers  stick out of margin uniformly.
 494            ;;
 495            (list (min left-overshoot (car xext))
 496                  (car yext) (cdr xext) (cdr yext))))
 497          (rounded-bbox (to-bp-box bbox))
 498          (port (ly:outputter-port outputter))
 499          (header (eps-header paper rounded-bbox load-fonts?)))
 500
 501     (display header port)
 502     (write-preamble paper load-fonts? port)
 503     (display "gsave set-ps-scale-to-lily-scale \n" port)
 504     (ly:outputter-dump-stencil outputter dump-me)
 505     (display "stroke grestore\n%%Trailer\n%%EOF\n" port)
 506     (ly:outputter-close outputter)))
 507
 508 (define-public (output-preview-framework basename book scopes fields)
 509   (let* ((paper (ly:paper-book-paper book))
 510          (systems (ly:paper-book-systems book))
 511          (scale (ly:output-def-lookup paper 'output-scale))
 512          (to-dump-systems '()))
 513
 514     ;; skip booktitles.
 515     (if (and
 516          (not (ly:get-option 'preview-include-book-title))
 517          (pair? systems)
 518          (ly:prob-property (car systems) 'is-book-title #f))
 519
 520         (set! systems (cdr systems)))
 521
 522     (for-each
 523      (lambda (sys)
 524        (if (or
 525             (paper-system-title? sys)
 526             (not (pair? to-dump-systems))
 527             (paper-system-title? (car to-dump-systems)))
 528            (set! to-dump-systems (cons sys to-dump-systems))))
 529      systems)
 530
 531     (dump-stencil-as-EPS
 532      paper
 533      (stack-stencils Y DOWN 0.0
 534                      (map paper-system-stencil (reverse to-dump-systems)))
 535      (format "~a.preview" basename)
 536      #t)
 537
 538     (postprocess-output book framework-ps-module
 539                         (format "~a.preview.eps" basename)
 540                         (cons "png" (ly:output-formats)))))
 541
 542 (if #f
 543     (define-public (output-preview-framework basename book scopes fields)
 544
 545       (let* ((paper (ly:paper-book-paper book))
 546              (systems (ly:paper-book-systems book))
 547              (scale (ly:output-def-lookup paper 'output-scale))
 548              (titles (take-while paper-system-title? systems))
 549              (non-title (find (lambda (x)
 550                                 (not (paper-system-title? x))) systems))
 551              (dump-me
 552               (stack-stencils Y DOWN 0.0
 553                               (map paper-system-stencil
 554                                    (append titles (list non-title))))))
 555         (output-scopes scopes fields basename)
 556         (dump-stencil-as-EPS paper dump-me
 557                              (format "~a.preview" basename)
 558                              #t)
 559
 560         (postprocess-output book framework-ps-module
 561                             (format "~a.preview.eps" basename)
 562                              (ly:output-formats)))))
 563 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 564
 565 (define-public (convert-to-pdf book name)
 566   (let* ((defs (ly:paper-book-paper book))
 567          (papersizename (ly:output-def-lookup defs 'papersizename)))
 568
 569     (if (equal? (basename name ".ps") "-")
 570         (ly:warning (_ "can't convert <stdout> to ~S" "PDF"))
 571         (postscript->pdf (if (string? papersizename) papersizename "a4")
 572                          name))))
 573
 574 (define-public (convert-to-png book name)
 575   (let* ((defs (ly:paper-book-paper book))
 576          (defs-resolution (ly:output-def-lookup defs 'pngresolution))
 577          (resolution (if (number? defs-resolution)
 578                          defs-resolution
 579                          (ly:get-option 'resolution)))
 580          (papersizename (ly:output-def-lookup defs 'papersizename)))
 581
 582     (postscript->png resolution
 583                      (if (string? papersizename) papersizename "a4")
 584                      name)))
 585
 586 (define-public (convert-to-dvi book name)
 587   (ly:warning (_ "can't generate ~S using the postscript back-end") "DVI"))
 588
 589 (define-public (convert-to-tex book name)
 590   (ly:warning (_ "can't generate ~S using the postscript back-end") "TeX"))
 591
 592 (define-public (convert-to-ps book name)
 593   #t)
 594
 595 (define-public (output-classic-framework basename book scopes fields)
 596
 597   (ly:error (_ "\nThe PostScript backend does not support the 'classic'
 598 framework. Use the EPS backend instead,
 599
 600   lilypond -b eps <file>
 601
 602 or remove the lilypond-book specific settings from the input.
 603 ")))