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 #f))
 276
 277
 278       (mkdir dir-name #o700)
 279
 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          (if (and (not embed)
 288                   (string-match (string-append name "\\.") f))
 289              (set! embed
 290                    (font-file-as-ps-string name (path-join dir-name f))))
 291
 292          (if (or (equal? "." f)
 293                  (equal? ".." f))
 294              #t
 295              (delete-file (path-join dir-name f))))
 296        files)
 297       (rmdir dir-name)
 298
 299       (if (not embed)
 300           (begin
 301             (set! embed "% failed \n")
 302             (ly:warn (_ "Couldn't extract file matching ~a from ~a") name filename)))
 303       embed))
 304
 305     (define (font-file-as-ps-string name file-name)
 306       (let*
 307           ((downcase-file-name (string-downcase file-name)))
 308
 309       (cond
 310        ((and file-name (string-match "\\.pfa" downcase-file-name))
 311         (cached-file-contents file-name))
 312        ((and file-name (string-match "\\.pfb" downcase-file-name))
 313         (ly:pfb->pfa file-name))
 314        ((and file-name (string-match "\\.ttf" downcase-file-name))
 315         (ly:ttf->pfa file-name))
 316        ((and file-name (string-match "\\.otf" downcase-file-name))
 317         (ps-embed-cff (ly:otf->cff file-name) name 0))
 318        (else
 319         (ly:warning (_ "don't know how to embed ~S=~S") name file-name)
 320         "")
 321        )))
 322
 323   (define (load-font font-name-filename)
 324     (let* ((font (car font-name-filename))
 325            (name (cadr font-name-filename))
 326            (file-name (caddr font-name-filename))
 327            (bare-file-name (ly:find-file file-name))
 328            )
 329
 330       (cons
 331        (munge-lily-font-name name)
 332        (cond
 333         ((string-match "([eE]mmentaler|[Aa]ybabtu)" file-name)
 334          (cached-file-contents
 335           (format "~a.pfa" (munge-lily-font-name file-name))))
 336         ((and
 337           (eq? PLATFORM 'darwin)
 338           bare-file-name (string-match "\\.dfont" bare-file-name))
 339          (handle-mac-font name bare-file-name))
 340
 341         ((and
 342           (eq? PLATFORM 'darwin)
 343           bare-file-name (= (stat:size (stat bare-file-name)) 0))
 344          (handle-mac-font name bare-file-name))
 345
 346         ((and font (cff-font? font))
 347          (ps-embed-cff (ly:otf-font-table-data font "CFF ")
 348                        name
 349                        0))
 350
 351         (bare-file-name (font-file-as-ps-string name bare-file-name))
 352         (else
 353          (ly:warning (_ "don't know how to embed font ~s ~s ~s")
 354                      name file-name font))))))
 355
 356
 357   (define (load-fonts paper)
 358     (let* ((fonts (ly:paper-fonts paper))
 359            (all-font-names
 360             (map
 361              (lambda (font)
 362                (cond
 363                 ((string? (ly:font-file-name font))
 364                  (list (list
 365                         font
 366                         (ly:font-name font)
 367                         (ly:font-file-name font))))
 368                 ((ly:pango-font? font)
 369                  (map
 370                   (lambda (name-psname-pair)
 371                     (list #f
 372                           (car name-psname-pair)
 373                           (cdr name-psname-pair)))
 374                   (ly:pango-font-physical-fonts font)))
 375
 376                 (else
 377                  (ly:font-sub-fonts font))))
 378
 379              fonts))
 380            (font-names
 381             (uniq-list
 382              (sort (apply append all-font-names)
 383                    (lambda (x y) (string<? (cadr x) (cadr y))))))
 384
 385
 386            (font-loader (if (ly:get-option 'gs-font-load)
 387                             load-font-via-GS
 388                             load-font))
 389
 390            (pfas (map font-loader font-names)))
 391       pfas))
 392
 393   (if load-fonts?
 394       (for-each
 395        (lambda (f)
 396          (format port "\n%%BeginFont: ~a\n" (car f))
 397          (display (cdr f) port)
 398          (display "\n%%EndFont\n" port))
 399        (load-fonts paper)))
 400
 401   (display (setup paper) port)
 402
 403   ;; adobe note 5002: should initialize variables before loading routines.
 404   (display (procset "music-drawing-routines.ps") port)
 405   (display (procset "lilyponddefs.ps") port)
 406   (display "init-lilypond-parameters\n" port))
 407
 408 (define-public (output-framework basename book scopes fields)
 409   (let* ((filename (format "~a.ps" basename))
 410          (outputter (ly:make-paper-outputter filename "ps"))
 411          (paper (ly:paper-book-paper book))
 412          (pages (ly:paper-book-pages book))
 413          (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
 414          (page-number (1- (ly:output-def-lookup paper 'firstpagenumber)))
 415          (page-count (length pages))
 416          (port (ly:outputter-port outputter)))
 417
 418     (output-scopes scopes fields basename)
 419     (display (page-header paper page-count #t) port)
 420     (write-preamble paper #t port)
 421
 422     (for-each
 423      (lambda (page)
 424        (set! page-number (1+ page-number))
 425        (dump-page outputter page page-number page-count landscape?))
 426      pages)
 427
 428     (display "%%Trailer\n%%EOF\n" port)
 429     (ly:outputter-close outputter)
 430     (postprocess-output book framework-ps-module filename
 431                          (ly:output-formats))))
 432
 433 (if (not (defined? 'nan?))
 434     (define (nan? x) #f))
 435
 436 (if (not (defined? 'inf?))
 437     (define (inf? x) #f))
 438
 439 (define-public (dump-stencil-as-EPS paper dump-me filename load-fonts?)
 440   (define (mm-to-bp-box mmbox)
 441     (let* ((scale (ly:output-def-lookup paper 'outputscale))
 442            (box (map
 443                  (lambda (x)
 444                    (inexact->exact
 445                     (round (* x scale mm-to-bigpoint)))) mmbox)))
 446
 447     (list (car box) (cadr box)
 448           (max (1+ (car box)) (caddr box))
 449           (max (1+ (cadr box)) (cadddr box)))))
 450
 451   (let* ((outputter (ly:make-paper-outputter (format "~a.eps" filename) "ps"))
 452          (port (ly:outputter-port outputter))
 453          (xext (ly:stencil-extent dump-me X))
 454          (yext (ly:stencil-extent dump-me Y))
 455          (bbox
 456           (map
 457            (lambda (x)
 458              (if (or (nan? x) (inf? x)
 459                      ;; FIXME: huh?
 460                      (equal? (format #f "~S" x) "+#.#")
 461                      (equal? (format #f "~S" x) "-#.#"))
 462                  0.0 x))
 463            (list (car xext) (car yext) (cdr xext) (cdr yext))))
 464          (rounded-bbox (mm-to-bp-box bbox))
 465          (port (ly:outputter-port outputter))
 466          (header (eps-header paper rounded-bbox load-fonts?)))
 467
 468     (display header port)
 469     (write-preamble paper load-fonts? port)
 470     (display "start-system { set-ps-scale-to-lily-scale \n" port)
 471     (ly:outputter-dump-stencil outputter dump-me)
 472     (display "} stop-system\n%%Trailer\n%%EOF\n" port)
 473     (ly:outputter-close outputter)))
 474
 475 (define-public (output-preview-framework basename book scopes fields)
 476   (let* ((paper (ly:paper-book-paper book))
 477          (systems (ly:paper-book-systems book))
 478          (scale (ly:output-def-lookup paper 'outputscale))
 479          (to-dump-systems '()))
 480
 481     ;; skip booktitles.
 482     (if (and
 483          (not
 484           (ly:get-option 'preview-include-book-title))
 485          (< 1 (length systems))
 486          (ly:paper-system-title? (list-ref systems 0))
 487          (ly:paper-system-title? (list-ref systems 1)))
 488         (set! systems (cdr systems)))
 489
 490     (for-each
 491      (lambda (sys)
 492        (if (or
 493             (ly:paper-system-title? sys)
 494             (not (pair? to-dump-systems))
 495             (ly:paper-system-title? (car to-dump-systems)))
 496            (set! to-dump-systems (cons sys to-dump-systems))))
 497      systems)
 498
 499     (dump-stencil-as-EPS
 500      paper
 501      (stack-stencils Y DOWN 0.0
 502                      (map ly:paper-system-stencil (reverse to-dump-systems)))
 503      (format "~a.preview" basename)
 504      #t)
 505
 506     (postprocess-output book framework-ps-module
 507                         (format "~a.preview.eps" basename)
 508                         (cons "png" (ly:output-formats)))))
 509 (if #f
 510     (define-public (output-preview-framework basename book scopes fields)
 511
 512       (let* ((paper (ly:paper-book-paper book))
 513              (systems (ly:paper-book-systems book))
 514              (scale (ly:output-def-lookup paper 'outputscale))
 515              (titles (take-while ly:paper-system-title? systems))
 516              (non-title (find (lambda (x)
 517                                 (not (ly:paper-system-title? x))) systems))
 518              (dump-me
 519               (stack-stencils Y DOWN 0.0
 520                               (map ly:paper-system-stencil
 521                                    (append titles (list non-title))))))
 522         (output-scopes scopes fields basename)
 523         (dump-stencil-as-EPS paper dump-me
 524                              (format "~a.preview" basename)
 525                              #t)
 526
 527         (postprocess-output book framework-ps-module
 528                             (format "~a.preview.eps" basename)
 529                              (ly:output-formats)))))
 530 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 531
 532 (define-public (convert-to-pdf book name)
 533   (let* ((defs (ly:paper-book-paper book))
 534          (papersizename (ly:output-def-lookup defs 'papersizename)))
 535
 536     (if (equal? (basename name ".ps") "-")
 537         (ly:warning (_ "can't convert <stdout> to ~S" "PDF"))
 538         (postscript->pdf (if (string? papersizename) papersizename "a4")
 539                          name))))
 540
 541 (define-public (convert-to-png book name)
 542   (let* ((defs (ly:paper-book-paper book))
 543          (defs-resolution (ly:output-def-lookup defs 'pngresolution))
 544          (resolution (if (number? defs-resolution)
 545                          defs-resolution
 546                          (ly:get-option 'resolution)))
 547          (papersizename (ly:output-def-lookup defs 'papersizename)))
 548
 549     (postscript->png resolution
 550                      (if (string? papersizename) papersizename "a4")
 551                      name)))
 552
 553 (define-public (convert-to-dvi book name)
 554   (ly:warning (_ "can't generate ~S using the postscript back-end") "DVI"))
 555
 556 (define-public (convert-to-tex book name)
 557   (ly:warning (_ "can't generate ~S using the postscript back-end") "TeX"))
 558
 559 (define-public (convert-to-ps book name)
 560   #t)