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