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