scm/framework-ps.scm

   1 ;;
   2 ;; framework-ps.scm -- structure for PostScript output
   3 ;;
   4 ;;  source file of the GNU LilyPond music typesetter
   5 ;;
   6 ;; (c) 2004--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8 (define-module (scm framework-ps))
   9
  10 ;;; this is still too big a mess.
  11
  12 (use-modules (ice-9 regex)
  13              (ice-9 string-fun)
  14              (ice-9 format)
  15              (guile)
  16              (srfi srfi-1)
  17              (srfi srfi-13)
  18              (lily))
  19
  20 (define framework-ps-module (current-module))
  21
  22 ;;(define pdebug stderr)
  23 (define (pdebug . rest) #f)
  24
  25 (define mm-to-bigpoint
  26   (/ 72 25.4))
  27
  28 (define-public (ps-font-command font)
  29   (let* ((name (munge-lily-font-name (ly:font-file-name font)))
  30          (magnify (ly:font-magnification font)))
  31
  32     (string-append
  33      "magfont"
  34      (string-regexp-substitute "[ /%]" "_" name)
  35      "m" (string-encode-integer (inexact->exact (round (* 1000 magnify)))))))
  36
  37 (define (tex-font? fontname)
  38   (or
  39    (equal? (substring fontname 0 2) "cm")
  40    (equal? (substring fontname 0 2) "ec")))
  41
  42 (define (define-fonts paper)
  43   (define font-list (ly:paper-fonts paper))
  44   (define (define-font command fontname scaling)
  45     (string-append
  46      "/" command " { /" fontname " findfont "
  47      (ly:number->string scaling) " output-scale div scalefont } bind def\n"))
  48
  49   (define (standard-tex-font? x)
  50     (or (equal? (substring x 0 2) "ms")
  51         (equal? (substring x 0 2) "cm")))
  52
  53   (define (font-load-command font)
  54     (let* ((specced-font-name (ly:font-name font))
  55            (fontname (if specced-font-name
  56                          (munge-lily-font-name specced-font-name)
  57                          (ly:font-file-name font)))
  58            (command (ps-font-command font))
  59
  60            ;; FIXME -- see (ps-font-command )
  61            (plain (ps-font-command font))
  62            (designsize (ly:font-design-size font))
  63            (magnification (* (ly:font-magnification font)))
  64            (ops (ly:output-def-lookup paper 'outputscale))
  65            (scaling (* ops magnification designsize)))
  66
  67       ;; Bluesky pfbs have UPCASE names (sigh.)
  68       ;; FIXME - don't support Bluesky?
  69       (if (standard-tex-font? fontname)
  70           (set! fontname (string-upcase fontname)))
  71       (if (equal? fontname "unknown")
  72           (display (list font fontname)))
  73       (define-font plain fontname scaling)))
  74
  75   (apply string-append
  76          (map (lambda (x) (font-load-command x))
  77               (filter (lambda (x) (not (ly:pango-font? x)))
  78                       font-list))))
  79
  80 ;; FIXME: duplicated in other output backends
  81 ;; FIXME: silly interface name
  82 (define (output-variables layout)
  83   ;; FIXME: duplicates output-layout's scope-entry->string, mostly
  84   (define (value->string val)
  85     (cond
  86      ((string? val) (string-append "(" val ")"))
  87      ((symbol? val) (symbol->string val))
  88      ((number? val) (number->string val))
  89      (else "")))
  90
  91   (define (output-entry ps-key ly-key)
  92     (string-append
  93      "/" ps-key " "
  94      (value->string (ly:output-def-lookup layout ly-key)) " def\n"))
  95
  96   (string-append
  97    "/lily-output-units "
  98      (number->string mm-to-bigpoint)
  99      " def %% millimeter\n"
 100    (output-entry "staff-line-thickness" 'linethickness)
 101    (output-entry "line-width" 'linewidth)
 102    (output-entry "paper-size" 'papersizename)
 103    (output-entry "staff-height" 'staffheight)   ;junkme.
 104    "/output-scale "
 105      (number->string (ly:output-def-lookup layout 'outputscale))
 106      " def\n"
 107    (output-entry "page-height" 'vsize)
 108    (output-entry "page-width" 'hsize)))
 109
 110 (define (dump-page outputter page page-number page-count landscape?)
 111   (ly:outputter-dump-string
 112    outputter
 113    (string-append
 114     "%%Page: "
 115     (number->string page-number) " " (number->string page-count) "\n"
 116
 117     "%%BeginPageSetup\n"
 118     (if landscape?
 119         "page-width output-scale lily-output-units mul mul 0 translate 90 rotate\n"
 120         "")
 121     "%%EndPageSetup\n"
 122
 123     "start-page { "
 124     "set-ps-scale-to-lily-scale "
 125     "\n"))
 126   (ly:outputter-dump-stencil outputter page)
 127   (ly:outputter-dump-string outputter "} stop-system \nshowpage\n"))
 128
 129 (define (supplies-or-needs paper load-fonts?)
 130   (define (extract-names font)
 131     (if (ly:pango-font? font)
 132         (map car (ly:pango-font-physical-fonts font))
 133         (list (munge-lily-font-name (ly:font-name font)))))
 134
 135   (let* ((fonts (ly:paper-fonts paper))
 136          (names (apply append (map extract-names fonts))))
 137
 138     (apply string-append
 139            (map (lambda (f)
 140                   (format
 141                    (if load-fonts?
 142                     "%%DocumentSuppliedResources: font ~a\n"
 143                     "%%DocumentNeededResources: font ~a\n")
 144                    f))
 145                 (uniq-list (sort names string<?))))))
 146
 147 (define (eps-header paper bbox load-fonts?)
 148   (string-append "%!PS-Adobe-2.0 EPSF-2.0\n"
 149                  "%%Creator: LilyPond\n"
 150                  "%%BoundingBox: "
 151                  (string-join (map ly:number->string bbox) " ") "\n"
 152                  "%%Orientation: "
 153                  (if (eq? (ly:output-def-lookup paper 'landscape) #t)
 154                      "Landscape\n"
 155                      "Portrait\n")
 156                  (supplies-or-needs paper load-fonts?)
 157                  "%%EndComments\n"))
 158
 159 (define (page-header paper page-count load-fonts?)
 160   (string-append "%!PS-Adobe-3.0\n"
 161                  "%%Creator: LilyPond\n"
 162                  "%%Pages: " (number->string page-count) "\n"
 163                  "%%PageOrder: Ascend\n"
 164                  "%%Orientation: "
 165                  (if (eq? (ly:output-def-lookup paper 'landscape) #t)
 166                      "Landscape\n"
 167                      "Portrait\n")
 168                  "%%DocumentPaperSizes: "
 169                  (ly:output-def-lookup paper 'papersizename) "\n"
 170                  (supplies-or-needs paper load-fonts?)
 171                  "%%EndComments\n"))
 172
 173 (define (procset file-name)
 174   (string-append
 175    (format
 176     "%%BeginResource: procset (~a) 1 0
 177 ~a
 178 %%EndResource
 179 "
 180     file-name (cached-file-contents file-name))))
 181
 182 (define (setup paper)
 183   (string-append
 184    "\n"
 185    "%%BeginSetup\n"
 186    (define-fonts paper)
 187    (output-variables paper)
 188    "%%EndSetup\n"))
 189
 190 (define-public (munge-lily-font-name name)
 191   (regexp-substitute/global #f "([eE]mmentaler|[aA]ybabtu)"
 192                             name 'pre "PFA" 1 'post))
 193
 194 (define (cff-font? font)
 195   (let*
 196       ((cff-string (ly:otf-font-table-data font "CFF ")))
 197     (> (string-length cff-string) 0)))
 198
 199 (define-public (ps-embed-cff body font-set-name version)
 200   (let* ((binary-data
 201           (string-append
 202            (format "/~a ~s StartData " font-set-name (string-length body))
 203            body))
 204
 205          (header
 206           (format
 207            "%%BeginResource: font ~a
 208 %!PS-Adobe-3.0 Resource-FontSet
 209 %%DocumentNeededResources: ProcSet (FontSetInit)
 210 %%Title: (FontSet/~a)
 211 %%Version: ~s
 212 %%EndComments
 213 %%IncludeResource: ProcSet (FontSetInit)
 214 %%BeginResource: FontSet (~a)
 215 /FontSetInit /ProcSet findresource begin
 216 %%BeginData: ~s Binary Bytes
 217 "
 218            font-set-name font-set-name version font-set-name
 219            (string-length binary-data)))
 220          (footer "\n%%EndData
 221 %%EndResource
 222 %%EOF
 223 %%EndResource\n"))
 224
 225     (string-append
 226      header
 227      binary-data
 228      footer)))
 229
 230
 231 (define (write-preamble paper load-fonts? port)
 232
 233   (define (load-font-via-GS font-name-filename)
 234     (define (ps-load-file name)
 235       (format
 236        (if (string? name)
 237            "(~a) (r) file .loadfont\n"
 238            "% fontfile ~a could not be found\n")
 239        name))
 240
 241     (let* ((font (car font-name-filename))
 242            (name (cadr font-name-filename))
 243            (file-name (caddr font-name-filename))
 244            (bare-file-name (ly:find-file file-name)))
 245
 246       (cons
 247        (munge-lily-font-name name)
 248        (cond
 249         ((string-match "([eE]mmentaler|[Aa]ybabtu)" file-name)
 250          (ps-load-file (ly:find-file
 251                         (format "~a.pfa" (munge-lily-font-name file-name)))))
 252         ((string? bare-file-name)
 253          (ps-load-file (munge-lily-font-name file-name)))
 254         (else
 255          (ly:warning (_ "don't know how to embed ~S=~S") name file-name)
 256           "")))))
 257
 258   ;; ugh.  posix /windows/mingw?
 259   (define (path-join a b)
 260     (if (equal? a "")
 261         b
 262         (string-append a "/" b)))
 263
 264   (define (dir-listing dir-name)
 265     (define (dir-helper dir lst)
 266       (let ((e (readdir dir)))
 267         (if (eof-object? e) lst (dir-helper dir (cons e lst)))))
 268     (reverse (dir-helper (opendir dir-name) '())))
 269
 270   (define (handle-mac-font name filename)
 271     (let*
 272         ((dir-name  (tmpnam))
 273          (files '())
 274          (status 0)
 275          (embed ""))
 276
 277
 278       (display (list filename name))
 279       (mkdir dir-name #o700)
 280
 281       (set! status (system
 282                     (format "cd ~a && fondu -force ~a" dir-name filename)))
 283
 284       (if (!= status 0)
 285           (ly:error "Fondu failed."))
 286
 287       (set! files (dir-listing dir-name))
 288
 289       (for-each
 290        (lambda (f)
 291          (if (string-match (string-append name "\\.") f)
 292              (set! embed
 293                    (font-file-as-ps-string name (path-join dir-name f))))
 294
 295          (if (or (equal? "." f)
 296                  (equal? ".." f))
 297              #t
 298              (delete-file (path-join dir-name f))))
 299        files)
 300       (rmdir dir-name)
 301       embed))
 302
 303     (define (font-file-as-ps-string name file-name)
 304       (cond
 305        ((and file-name (string-match "\\.pfa" file-name))
 306         (cached-file-contents file-name))
 307        ((and file-name (string-match "\\.pfb" file-name))
 308         (ly:pfb->pfa file-name))
 309        ((and file-name (string-match "\\.ttf" file-name))
 310         (ly:ttf->pfa file-name))
 311        ((and file-name (string-match "\\.otf" file-name))
 312         (ps-embed-cff (ly:otf->cff file-name) name 0))
 313        ((and file-name (string-match "\\.ttf" file-name))
 314         (ly:ttf->pfa file-name))
 315        (else
 316         (ly:warning (_ "don't know how to embed ~S=~S") name file-name)
 317         "")
 318        ))
 319
 320   (define (load-font font-name-filename)
 321     (let* ((font (car font-name-filename))
 322            (name (cadr font-name-filename))
 323            (file-name (caddr font-name-filename))
 324            (bare-file-name (ly:find-file file-name))
 325            )
 326
 327       (cons
 328        (munge-lily-font-name name)
 329        (cond
 330         ((string-match "([eE]mmentaler|[Aa]ybabtu)" file-name)
 331          (cached-file-contents
 332           (format "~a.pfa" (munge-lily-font-name file-name))))
 333         ((and
 334           (eq? PLATFORM 'darwin)
 335           bare-file-name (string-match "\\.dfont" bare-file-name))
 336          (handle-mac-font name bare-file-name))
 337
 338         ((and
 339           (eq? PLATFORM 'darwin)
 340           bare-file-name (= (stat:size (stat bare-file-name)) 0))
 341          (handle-mac-font name bare-file-name))
 342
 343         ((and font (cff-font? font))
 344          (ps-embed-cff (ly:otf-font-table-data font "CFF ")
 345                        name
 346                        0))
 347
 348         (bare-file-name (font-file-as-ps-string name bare-file-name))
 349         (else
 350          (ly:warning (_ "don't know how to embed font ~s ~s ~s")
 351                      name file-name font))))))
 352
 353
 354   (define (load-fonts paper)
 355     (let* ((fonts (ly:paper-fonts paper))
 356            (all-font-names
 357             (map
 358              (lambda (font)
 359                (cond
 360                 ((string? (ly:font-file-name font))
 361                  (list (list
 362                         font
 363                         (ly:font-name font)
 364                         (ly:font-file-name font))))
 365                 ((ly:pango-font? font)
 366                  (map
 367                   (lambda (name-psname-pair)
 368                     (list #f
 369                           (car name-psname-pair)
 370                           (cdr name-psname-pair)))
 371                   (ly:pango-font-physical-fonts font)))
 372
 373                 (else
 374                  (ly:font-sub-fonts font))))
 375
 376              fonts))
 377            (font-names
 378             (uniq-list
 379              (sort (apply append all-font-names)
 380                    (lambda (x y) (string<? (cadr x) (cadr y))))))
 381
 382
 383            (font-loader (if (ly:get-option 'gs-font-load)
 384                             load-font-via-GS
 385                             load-font))
 386
 387            (pfas (map font-loader font-names)))
 388       pfas))
 389
 390   (if load-fonts?
 391       (for-each
 392        (lambda (f)
 393          (format port "\n%%BeginFont: ~a\n" (car f))
 394          (display (cdr f) port)
 395          (display "\n%%EndFont\n" port))
 396        (load-fonts paper)))
 397
 398   (display (setup paper) port)
 399
 400   ;; adobe note 5002: should initialize variables before loading routines.
 401   (display (procset "music-drawing-routines.ps") port)
 402   (display (procset "lilyponddefs.ps") port)
 403   (display "init-lilypond-parameters\n" port))
 404
 405 (define-public (output-framework basename book scopes fields)
 406   (let* ((filename (format "~a.ps" basename))
 407          (outputter (ly:make-paper-outputter filename "ps"))
 408          (paper (ly:paper-book-paper book))
 409          (pages (ly:paper-book-pages book))
 410          (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
 411          (page-number (1- (ly:output-def-lookup paper 'firstpagenumber)))
 412          (page-count (length pages))
 413          (port (ly:outputter-port outputter)))
 414
 415     (output-scopes scopes fields basename)
 416     (display (page-header paper page-count #t) port)
 417     (write-preamble paper #t port)
 418
 419     (for-each
 420      (lambda (page)
 421        (set! page-number (1+ page-number))
 422        (dump-page outputter page page-number page-count landscape?))
 423      pages)
 424
 425     (display "%%Trailer\n%%EOF\n" port)
 426     (ly:outputter-close outputter)
 427     (postprocess-output book framework-ps-module filename
 428                          (ly:output-formats))))
 429
 430 (if (not (defined? 'nan?))
 431     (define (nan? x) #f))
 432
 433 (if (not (defined? 'inf?))
 434     (define (inf? x) #f))
 435
 436 (define-public (dump-stencil-as-EPS paper dump-me filename load-fonts?)
 437   (define (mm-to-bp-box mmbox)
 438     (let* ((scale (ly:output-def-lookup paper 'outputscale))
 439            (box (map
 440                  (lambda (x)
 441                    (inexact->exact
 442                     (round (* x scale mm-to-bigpoint)))) mmbox)))
 443
 444     (list (car box) (cadr box)
 445           (max (1+ (car box)) (caddr box))
 446           (max (1+ (cadr box)) (cadddr box)))))
 447
 448   (let* ((outputter (ly:make-paper-outputter (format "~a.eps" filename) "ps"))
 449          (port (ly:outputter-port outputter))
 450          (xext (ly:stencil-extent dump-me X))
 451          (yext (ly:stencil-extent dump-me Y))
 452          (bbox
 453           (map
 454            (lambda (x)
 455              (if (or (nan? x) (inf? x)
 456                      ;; FIXME: huh?
 457                      (equal? (format #f "~S" x) "+#.#")
 458                      (equal? (format #f "~S" x) "-#.#"))
 459                  0.0 x))
 460            (list (car xext) (car yext) (cdr xext) (cdr yext))))
 461          (rounded-bbox (mm-to-bp-box bbox))
 462          (port (ly:outputter-port outputter))
 463          (header (eps-header paper rounded-bbox load-fonts?)))
 464
 465     (display header port)
 466     (write-preamble paper load-fonts? port)
 467     (display "start-system { set-ps-scale-to-lily-scale \n" port)
 468     (ly:outputter-dump-stencil outputter dump-me)
 469     (display "} stop-system\n%%Trailer\n%%EOF\n" port)
 470     (ly:outputter-close outputter)))
 471
 472 (define-public (output-preview-framework basename book scopes fields)
 473   (let* ((paper (ly:paper-book-paper book))
 474          (systems (ly:paper-book-systems book))
 475          (scale (ly:output-def-lookup paper 'outputscale))
 476          (to-dump-systems '()))
 477
 478     ;; skip booktitles.
 479     (if (and
 480          (not
 481           (ly:get-option 'preview-include-book-title))
 482          (< 1 (length systems))
 483          (ly:paper-system-title? (list-ref systems 0))
 484          (ly:paper-system-title? (list-ref systems 1)))
 485         (set! systems (cdr systems)))
 486
 487     (for-each
 488      (lambda (sys)
 489        (if (or
 490             (ly:paper-system-title? sys)
 491             (not (pair? to-dump-systems))
 492             (ly:paper-system-title? (car to-dump-systems)))
 493            (set! to-dump-systems (cons sys to-dump-systems))))
 494      systems)
 495
 496     (dump-stencil-as-EPS
 497      paper
 498      (stack-stencils Y DOWN 0.0
 499                      (map ly:paper-system-stencil (reverse to-dump-systems)))
 500      (format "~a.preview" basename)
 501      #t)
 502
 503     (postprocess-output book framework-ps-module
 504                         (format "~a.preview.eps" basename)
 505                         (cons "png" (ly:output-formats)))))
 506 (if #f
 507     (define-public (output-preview-framework basename book scopes fields)
 508
 509       (let* ((paper (ly:paper-book-paper book))
 510              (systems (ly:paper-book-systems book))
 511              (scale (ly:output-def-lookup paper 'outputscale))
 512              (titles (take-while ly:paper-system-title? systems))
 513              (non-title (find (lambda (x)
 514                                 (not (ly:paper-system-title? x))) systems))
 515              (dump-me
 516               (stack-stencils Y DOWN 0.0
 517                               (map ly:paper-system-stencil
 518                                    (append titles (list non-title))))))
 519         (output-scopes scopes fields basename)
 520         (dump-stencil-as-EPS paper dump-me
 521                              (format "~a.preview" basename)
 522                              #t)
 523
 524         (postprocess-output book framework-ps-module
 525                             (format "~a.preview.eps" basename)
 526                              (ly:output-formats)))))
 527 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 528
 529 (define-public (convert-to-pdf book name)
 530   (let* ((defs (ly:paper-book-paper book))
 531          (papersizename (ly:output-def-lookup defs 'papersizename)))
 532
 533     (if (equal? (basename name ".ps") "-")
 534         (ly:warning (_ "can't convert <stdout> to ~S" "PDF"))
 535         (postscript->pdf (if (string? papersizename) papersizename "a4")
 536                          name))))
 537
 538 (define-public (convert-to-png book name)
 539   (let* ((defs (ly:paper-book-paper book))
 540          (defs-resolution (ly:output-def-lookup defs 'pngresolution))
 541          (resolution (if (number? defs-resolution)
 542                          defs-resolution
 543                          (ly:get-option 'resolution)))
 544          (papersizename (ly:output-def-lookup defs 'papersizename)))
 545
 546     (postscript->png resolution
 547                      (if (string? papersizename) papersizename "a4")
 548                      name)))
 549
 550 (define-public (convert-to-dvi book name)
 551   (ly:warning (_ "can't generate ~S using the postscript back-end") "DVI"))
 552
 553 (define-public (convert-to-tex book name)
 554   (ly:warning (_ "can't generate ~S using the postscript back-end") "TeX"))
 555
 556 (define-public (convert-to-ps book name)
 557   #t)