scm/framework-ps.scm

   1 ;;;; framework-ps.scm --
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c) 2004--2005 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              (srfi srfi-1)
  16              (srfi srfi-13)
  17              (lily))
  18
  19 (define framework-ps-module (current-module))
  20
  21 ;;(define pdebug stderr)
  22 (define (pdebug . rest) #f)
  23
  24 (define mm-to-bigpoint
  25   (/ 72 25.4))
  26
  27 (define-public (ps-font-command font)
  28   (let* ((name (munge-lily-font-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                          (munge-lily-font-name 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 'outputscale))
  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 mm-to-bigpoint)
  98      " def %% millimeter\n"
  99    (output-entry "staff-line-thickness" 'linethickness)
 100    (output-entry "line-width" 'linewidth)
 101    (output-entry "paper-size" 'papersizename)
 102    (output-entry "staff-height" 'staffheight)   ;junkme.
 103    "/output-scale "
 104      (number->string (ly:output-def-lookup layout 'outputscale))
 105      " def\n"
 106    (output-entry "page-height" 'vsize)
 107    (output-entry "page-width" 'hsize)))
 108
 109 (define (dump-page outputter page page-number page-count landscape?)
 110   (ly:outputter-dump-string
 111    outputter
 112    (string-append
 113     "%%Page: "
 114     (number->string page-number) " " (number->string page-count) "\n"
 115
 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     "start-page { "
 123     "set-ps-scale-to-lily-scale "
 124     "\n"))
 125   (ly:outputter-dump-stencil outputter page)
 126   (ly:outputter-dump-string outputter "} stop-system \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 (munge-lily-font-name (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\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 (page-header paper page-count load-fonts?)
 159   (string-append "%!PS-Adobe-3.0\n"
 160                  "%%Creator: LilyPond\n"
 161                  "%%Pages: " (number->string page-count) "\n"
 162                  "%%PageOrder: Ascend\n"
 163                  "%%Orientation: "
 164                  (if (eq? (ly:output-def-lookup paper 'landscape) #t)
 165                      "Landscape\n"
 166                      "Portrait\n")
 167                  "%%DocumentPaperSizes: "
 168                  (ly:output-def-lookup paper 'papersizename) "\n"
 169                  (supplies-or-needs paper load-fonts?)
 170                  "%%EndComments\n"))
 171
 172 (define (procset file-name)
 173   (string-append
 174    (format
 175     "%%BeginResource: procset (~a) 1 0
 176 ~a
 177 %%EndResource
 178 "
 179     file-name (cached-file-contents file-name))))
 180
 181 (define (setup paper)
 182   (string-append
 183    "\n"
 184    "%%BeginSetup\n"
 185    (define-fonts paper)
 186    (output-variables paper)
 187    "%%EndSetup\n"))
 188
 189 (define-public (munge-lily-font-name name)
 190   (regexp-substitute/global #f "([eE]mmentaler|[aA]ybabtu)"
 191                             name 'pre "PFA" 1 'post))
 192
 193 (define (cff-font? font)
 194   (let*
 195       ((cff-string (ly:otf-font-table-data font "CFF ")))
 196     (> (string-length cff-string) 0)))
 197
 198 (define-public (ps-embed-cff body font-set-name version)
 199   (let* ((binary-data
 200           (string-append
 201            (format "/~a ~s StartData " font-set-name (string-length body))
 202            body))
 203
 204          (header
 205           (format
 206            "%%BeginResource: font ~a
 207 %!PS-Adobe-3.0 Resource-FontSet
 208 %%DocumentNeededResources: ProcSet (FontSetInit)
 209 %%Title: (FontSet/~a)
 210 %%Version: ~s
 211 %%EndComments
 212 %%IncludeResource: ProcSet (FontSetInit)
 213 %%BeginResource: FontSet (~a)
 214 /FontSetInit /ProcSet findresource begin
 215 %%BeginData: ~s Binary Bytes
 216 "
 217            font-set-name font-set-name version font-set-name
 218            (string-length binary-data)))
 219          (footer "\n%%EndData
 220 %%EndResource
 221 %%EOF
 222 %%EndResource\n"))
 223
 224     (string-append
 225      header
 226      binary-data
 227      footer)))
 228
 229
 230 (define (write-preamble paper load-fonts? port)
 231
 232   (define (load-font-via-GS font-name-filename)
 233     (define (ps-load-file name)
 234       (format
 235        (if (string? name)
 236            "(~a) (r) file .loadfont\n"
 237            "% fontfile ~a could not be found\n")
 238        name))
 239
 240     (let* ((font (car font-name-filename))
 241            (name (cadr font-name-filename))
 242            (file-name (caddr font-name-filename))
 243            (bare-file-name (ly:find-file file-name)))
 244
 245       (cons
 246        (munge-lily-font-name name)
 247        (cond
 248         ((string-match "([eE]mmentaler|[Aa]ybabtu)" file-name)
 249          (ps-load-file (ly:find-file
 250                         (format "~a.pfa" (munge-lily-font-name file-name)))))
 251         ((string? bare-file-name)
 252          (ps-load-file (munge-lily-font-name file-name)))
 253         (else
 254          (ly:warning (_ "don't know how to embed ~S=~S") name file-name)
 255           "")))))
 256
 257   ;; ugh.  posix /windows/mingw?
 258   (define (path-join a b)
 259     (if (equal? a "")
 260         b
 261         (string-append a "/" b)))
 262
 263   (define (dir-listing dir-name)
 264     (define (dir-helper dir lst)
 265       (let ((e (readdir dir)))
 266         (if (eof-object? e) lst (dir-helper dir (cons e lst)))))
 267     (reverse (dir-helper (opendir dir-name) '())))
 268
 269   (define (handle-mac-font name filename)
 270     (let*
 271         ((dir-name  (tmpnam))
 272          (files '())
 273          (status 0)
 274          (embed ""))
 275
 276
 277       (display (list filename name))
 278       (mkdir dir-name #o700)
 279
 280       (set! status (system
 281                     (format "cd ~a && fondu -force ~a" dir-name filename)))
 282
 283       (if (!= status 0)
 284           (ly:error "Fondu failed."))
 285
 286       (set! files (dir-listing dir-name))
 287
 288       (for-each
 289        (lambda (f)
 290          (if (string-match (string-append name "\\.") f)
 291              (set! embed
 292                    (font-file-as-ps-string name (path-join dir-name f))))
 293
 294          (if (or (equal? "." f)
 295                  (equal? ".." f))
 296              #t
 297              (delete-file (path-join dir-name f))))
 298        files)
 299       (rmdir dir-name)
 300       embed))
 301
 302     (define (font-file-as-ps-string name file-name)
 303       (cond
 304        ((and file-name (string-match "\\.pfa" file-name))
 305         (cached-file-contents file-name))
 306        ((and file-name (string-match "\\.pfb" file-name))
 307         (ly:pfb->pfa file-name))
 308        ((and file-name (string-match "\\.ttf" file-name))
 309         (ly:ttf->pfa file-name))
 310        ((and file-name (string-match "\\.otf" file-name))
 311         (ps-embed-cff (ly:otf->cff file-name) name 0))
 312        ((and file-name (string-match "\\.ttf" file-name))
 313         (ly:ttf->pfa file-name))
 314        (else
 315         (ly:warning (_ "don't know how to embed ~S=~S") name file-name)
 316         "")
 317        ))
 318
 319   (define (load-font font-name-filename)
 320     (let* ((font (car font-name-filename))
 321            (name (cadr font-name-filename))
 322            (file-name (caddr font-name-filename))
 323            (bare-file-name (ly:find-file file-name))
 324            )
 325
 326       (cons
 327        (munge-lily-font-name name)
 328        (cond
 329         ((string-match "([eE]mmentaler|[Aa]ybabtu)" file-name)
 330          (cached-file-contents
 331           (format "~a.pfa" (munge-lily-font-name file-name))))
 332         ((and
 333           (eq? PLATFORM 'darwin)
 334           bare-file-name (string-match "\\.dfont" bare-file-name))
 335          (handle-mac-font name bare-file-name))
 336
 337         ((and
 338           (eq? PLATFORM 'darwin)
 339           bare-file-name (= (stat:size (stat bare-file-name)) 0))
 340          (handle-mac-font name bare-file-name))
 341
 342         ((and font (cff-font? font))
 343          (ps-embed-cff (ly:otf-font-table-data font "CFF ")
 344                        name
 345                        0))
 346
 347         (bare-file-name (font-file-as-ps-string name bare-file-name))
 348         (else
 349          (ly:warning (_ "don't know how to embed font ~s ~s ~s")
 350                      name file-name font))))))
 351
 352
 353   (define (load-fonts paper)
 354     (let* ((fonts (ly:paper-fonts paper))
 355            (all-font-names
 356             (map
 357              (lambda (font)
 358                (cond
 359                 ((string? (ly:font-file-name font))
 360                  (list (list
 361                         font
 362                         (ly:font-name font)
 363                         (ly:font-file-name font))))
 364                 ((ly:pango-font? font)
 365                  (map
 366                   (lambda (name-psname-pair)
 367                     (list #f
 368                           (car name-psname-pair)
 369                           (cdr name-psname-pair)))
 370                   (ly:pango-font-physical-fonts font)))
 371
 372                 (else
 373                  (ly:font-sub-fonts font))))
 374
 375              fonts))
 376            (font-names
 377             (uniq-list
 378              (sort (apply append all-font-names)
 379                    (lambda (x y) (string<? (cadr x) (cadr y))))))
 380
 381
 382            (font-loader (if (ly:get-option 'gs-font-load)
 383                             load-font-via-GS
 384                             load-font))
 385
 386            (pfas (map font-loader font-names)))
 387       pfas))
 388
 389   (if load-fonts?
 390       (for-each
 391        (lambda (f)
 392          (format port "\n%%BeginFont: ~a\n" (car f))
 393          (display (cdr f) port)
 394          (display "\n%%EndFont\n" port))
 395        (load-fonts paper)))
 396
 397   (display (setup paper) port)
 398
 399   ;; adobe note 5002: should initialize variables before loading routines.
 400   (display (procset "music-drawing-routines.ps") port)
 401   (display (procset "lilyponddefs.ps") port)
 402   (display "init-lilypond-parameters\n" port))
 403
 404 (define-public (output-framework basename book scopes fields)
 405   (let* ((filename (format "~a.ps" basename))
 406          (outputter (ly:make-paper-outputter filename "ps"))
 407          (paper (ly:paper-book-paper book))
 408          (pages (ly:paper-book-pages book))
 409          (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
 410          (page-number (1- (ly:output-def-lookup paper 'firstpagenumber)))
 411          (page-count (length pages))
 412          (port (ly:outputter-port outputter)))
 413
 414     (output-scopes scopes fields basename)
 415     (display (page-header paper page-count #t) port)
 416     (write-preamble paper #t port)
 417
 418     (for-each
 419      (lambda (page)
 420        (set! page-number (1+ page-number))
 421        (dump-page outputter page page-number page-count landscape?))
 422      pages)
 423
 424     (display "%%Trailer\n%%EOF\n" port)
 425     (ly:outputter-close outputter)
 426     (postprocess-output book framework-ps-module filename
 427                          (ly:output-formats))))
 428
 429 (if (not (defined? 'nan?))
 430     (define (nan? x) #f))
 431
 432 (if (not (defined? 'inf?))
 433     (define (inf? x) #f))
 434
 435 (define-public (dump-stencil-as-EPS paper dump-me filename load-fonts?)
 436   (define (mm-to-bp-box mmbox)
 437     (let* ((scale (ly:output-def-lookup paper 'outputscale))
 438            (box (map
 439                  (lambda (x)
 440                    (inexact->exact
 441                     (round (* x scale mm-to-bigpoint)))) mmbox)))
 442
 443     (list (car box) (cadr box)
 444           (max (1+ (car box)) (caddr box))
 445           (max (1+ (cadr box)) (cadddr box)))))
 446
 447   (let* ((outputter (ly:make-paper-outputter (format "~a.eps" filename) "ps"))
 448          (port (ly:outputter-port outputter))
 449          (xext (ly:stencil-extent dump-me X))
 450          (yext (ly:stencil-extent dump-me Y))
 451          (bbox
 452           (map
 453            (lambda (x)
 454              (if (or (nan? x) (inf? x)
 455                      ;; FIXME: huh?
 456                      (equal? (format #f "~S" x) "+#.#")
 457                      (equal? (format #f "~S" x) "-#.#"))
 458                  0.0 x))
 459            (list (car xext) (car yext) (cdr xext) (cdr yext))))
 460          (rounded-bbox (mm-to-bp-box bbox))
 461          (port (ly:outputter-port outputter))
 462          (header (eps-header paper rounded-bbox load-fonts?)))
 463
 464     (display header port)
 465     (write-preamble paper load-fonts? port)
 466     (display "start-system { set-ps-scale-to-lily-scale \n" port)
 467     (ly:outputter-dump-stencil outputter dump-me)
 468     (display "} stop-system\n%%Trailer\n%%EOF\n" port)
 469     (ly:outputter-close outputter)))
 470
 471 (define-public (output-preview-framework basename book scopes fields)
 472   (let* ((paper (ly:paper-book-paper book))
 473          (systems (ly:paper-book-systems book))
 474          (scale (ly:output-def-lookup paper 'outputscale))
 475          (to-dump-systems '()))
 476
 477     ;; skip booktitles.
 478     (if (and
 479          (not
 480           (ly:get-option 'preview-include-book-title))
 481          (< 1 (length systems))
 482          (ly:paper-system-title? (list-ref systems 0))
 483          (ly:paper-system-title? (list-ref systems 1)))
 484         (set! systems (cdr systems)))
 485
 486     (for-each
 487      (lambda (sys)
 488        (if (or
 489             (ly:paper-system-title? sys)
 490             (not (pair? to-dump-systems))
 491             (ly:paper-system-title? (car to-dump-systems)))
 492            (set! to-dump-systems (cons sys to-dump-systems))))
 493      systems)
 494
 495     (dump-stencil-as-EPS
 496      paper
 497      (stack-stencils Y DOWN 0.0
 498                      (map ly:paper-system-stencil (reverse to-dump-systems)))
 499      (format "~a.preview" basename)
 500      #t)
 501
 502     (postprocess-output book framework-ps-module
 503                         (format "~a.preview.eps" basename)
 504                         (cons "png" (ly:output-formats)))))
 505 (if #f
 506     (define-public (output-preview-framework basename book scopes fields)
 507
 508       (let* ((paper (ly:paper-book-paper book))
 509              (systems (ly:paper-book-systems book))
 510              (scale (ly:output-def-lookup paper 'outputscale))
 511              (titles (take-while ly:paper-system-title? systems))
 512              (non-title (find (lambda (x)
 513                                 (not (ly:paper-system-title? x))) systems))
 514              (dump-me
 515               (stack-stencils Y DOWN 0.0
 516                               (map ly:paper-system-stencil
 517                                    (append titles (list non-title))))))
 518         (output-scopes scopes fields basename)
 519         (dump-stencil-as-EPS paper dump-me
 520                              (format "~a.preview" basename)
 521                              #t)
 522
 523         (postprocess-output book framework-ps-module
 524                             (format "~a.preview.eps" basename)
 525                              (ly:output-formats)))))
 526 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 527
 528 (define-public (convert-to-pdf book name)
 529   (let* ((defs (ly:paper-book-paper book))
 530          (papersizename (ly:output-def-lookup defs 'papersizename)))
 531
 532     (if (equal? (basename name ".ps") "-")
 533         (ly:warning (_ "can't convert <stdout> to ~S" "PDF"))
 534         (postscript->pdf (if (string? papersizename) papersizename "a4")
 535                          name))))
 536
 537 (define-public (convert-to-png book name)
 538   (let* ((defs (ly:paper-book-paper book))
 539          (defs-resolution (ly:output-def-lookup defs 'pngresolution))
 540          (resolution (if (number? defs-resolution)
 541                          defs-resolution
 542                          (ly:get-option 'resolution)))
 543          (papersizename (ly:output-def-lookup defs 'papersizename)))
 544
 545     (postscript->png resolution
 546                      (if (string? papersizename) papersizename "a4")
 547                      name)))
 548
 549 (define-public (convert-to-dvi book name)
 550   (ly:warning (_ "can't generate ~S using the postscript back-end") "DVI"))
 551
 552 (define-public (convert-to-tex book name)
 553   (ly:warning (_ "can't generate ~S using the postscript back-end") "TeX"))
 554
 555 (define-public (convert-to-ps book name)
 556   #t)