1 ;;;; framework-ps.scm -- structure for PostScript output
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 2004--2006 Han-Wen Nienhuys <hanwen@cs.uu.nl>
7 (define-module (scm framework-ps))
9 ;;; this is still too big a mess.
11 (use-modules (ice-9 regex)
22 (define framework-ps-module (current-module))
24 ;;(define pdebug stderr)
25 (define (pdebug . rest) #f)
27 (define-public (ps-font-command font)
28 (let* ((name (ly:font-file-name font))
29 (magnify (ly:font-magnification font)))
33 (string-regexp-substitute "[ /%]" "_" name)
34 "m" (string-encode-integer (inexact->exact (round (* 1000 magnify)))))))
36 (define (tex-font? fontname)
38 (equal? (substring fontname 0 2) "cm")
39 (equal? (substring fontname 0 2) "ec")))
41 (define (define-fonts paper)
42 (define font-list (ly:paper-fonts paper))
43 (define (define-font command fontname scaling)
45 "/" command " { /" fontname " " (ly:number->string scaling) " output-scale div selectfont } bind def\n"))
47 (define (standard-tex-font? x)
48 (or (equal? (substring x 0 2) "ms")
49 (equal? (substring x 0 2) "cm")))
51 (define (font-load-command font)
52 (let* ((specced-font-name (ly:font-name font))
53 (fontname (if specced-font-name
55 (ly:font-file-name font)))
56 (command (ps-font-command font))
58 ;; FIXME -- see (ps-font-command )
59 (plain (ps-font-command font))
60 (designsize (ly:font-design-size font))
61 (magnification (* (ly:font-magnification font)))
62 (ops (ly:output-def-lookup paper 'output-scale))
63 (scaling (* ops magnification designsize)))
65 ;; Bluesky pfbs have UPCASE names (sigh.)
66 ;; FIXME - don't support Bluesky?
67 (if (standard-tex-font? fontname)
68 (set! fontname (string-upcase fontname)))
69 (if (equal? fontname "unknown")
70 (display (list font fontname)))
71 (define-font plain fontname scaling)))
74 (map (lambda (x) (font-load-command x))
75 (filter (lambda (x) (not (ly:pango-font? x)))
78 ;; FIXME: duplicated in other output backends
79 ;; FIXME: silly interface name
80 (define (output-variables layout)
81 ;; FIXME: duplicates output-layout's scope-entry->string, mostly
82 (define (value->string val)
84 ((string? val) (string-append "(" val ")"))
85 ((symbol? val) (symbol->string val))
86 ((number? val) (number->string val))
89 (define (output-entry ps-key ly-key)
92 (value->string (ly:output-def-lookup layout ly-key)) " def\n"))
96 (number->string (/ (ly:bp 1)))
97 " def %% millimeter\n"
98 (output-entry "staff-line-thickness" 'line-thickness)
99 (output-entry "line-width" 'line-width)
100 (output-entry "paper-size" 'papersizename)
101 (output-entry "staff-height" 'staff-height) ;junkme.
103 (number->string (ly:output-def-lookup layout 'output-scale))
105 (output-entry "page-height" 'paper-height)
106 (output-entry "page-width" 'paper-width)))
108 (define (dump-page outputter page page-number page-count landscape?)
109 (ly:outputter-dump-string
112 (format "%%Page: ~a ~a\n" page-number page-number)
115 "page-width output-scale lily-output-units mul mul 0 translate 90 rotate\n"
119 "gsave 0 paper-height translate "
120 "set-ps-scale-to-lily-scale "
122 (ly:outputter-dump-stencil outputter page)
123 (ly:outputter-dump-string outputter "stroke grestore \nshowpage\n"))
125 (define (supplies-or-needs paper load-fonts?)
126 (define (extract-names font)
127 (if (ly:pango-font? font)
128 (map car (ly:pango-font-physical-fonts font))
129 (list (ly:font-name font))))
131 (let* ((fonts (ly:paper-fonts paper))
132 (names (apply append (map extract-names fonts))))
138 "%%DocumentSuppliedResources: font ~a\n"
139 "%%DocumentNeededResources: font ~a\n")
141 (uniq-list (sort names string<?))))))
143 (define (eps-header paper bbox load-fonts?)
144 (string-append "%!PS-Adobe-2.0 EPSF-2.0\n"
145 "%%Creator: LilyPond "
149 (string-join (map ly:number->string bbox) " ") "\n"
151 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
154 (supplies-or-needs paper load-fonts?)
157 (define (ps-document-media paper)
159 (ly:output-def-lookup paper 'output-scale)
160 (ly:output-def-lookup paper 'paper-width)) (ly:bp 1)))
162 (ly:output-def-lookup paper 'paper-height)
163 (ly:output-def-lookup paper 'output-scale))
165 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t)))
166 (format "%%DocumentMedia: ~a ~$ ~$ ~a ~a ~a\n"
167 (ly:output-def-lookup paper 'papersizename)
176 (define (file-header paper page-count load-fonts?)
177 (string-append "%!PS-Adobe-3.0\n"
178 "%%Creator: LilyPond "
182 "%%Pages: " (number->string page-count) "\n"
183 "%%PageOrder: Ascend\n"
185 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
188 (ps-document-media paper)
189 (supplies-or-needs paper load-fonts?)
192 (define (procset file-name)
194 "%%BeginResource: procset (~a) 1 0
198 file-name (cached-file-contents file-name)))
200 (define (embed-document file-name)
201 (format "%%BeginDocument: ~a
205 file-name (cached-file-contents file-name)))
207 (define (setup-variables paper)
211 (output-variables paper)
214 (define (cff-font? font)
216 ((cff-string (ly:otf-font-table-data font "CFF ")))
217 (> (string-length cff-string) 0)))
219 (define-public (ps-embed-cff body font-set-name version)
222 (format "/~a ~s StartData " font-set-name (string-length body))
227 "%%BeginResource: font ~a
228 %!PS-Adobe-3.0 Resource-FontSet
229 %%DocumentNeededResources: ProcSet (FontSetInit)
230 %%Title: (FontSet/~a)
233 %%IncludeResource: ProcSet (FontSetInit)
234 %%BeginResource: FontSet (~a)
235 /FontSetInit /ProcSet findresource begin
236 %%BeginData: ~s Binary Bytes
238 font-set-name font-set-name version font-set-name
239 (string-length binary-data)))
250 (define (write-preamble paper load-fonts? port)
252 (define (load-font-via-GS font-name-filename)
253 (define (ps-load-file name)
256 "(~a) (r) file .loadfont\n"
257 "% can't find font file: ~a\n")
260 (let* ((font (car font-name-filename))
261 (name (cadr font-name-filename))
262 (file-name (caddr font-name-filename))
263 (bare-file-name (ly:find-file file-name)))
268 (if (mac-font? bare-file-name)
269 (handle-mac-font name bare-file-name)
271 ((string-match "^([eE]mmentaler|[Aa]ybabtu)" file-name)
272 (ps-load-file (ly:find-file
273 (format "~a.otf" file-name))))
274 ((string? bare-file-name)
275 (ps-load-file file-name))
277 (ly:warning (_ "can't embed ~S=~S") name file-name)
282 (define (dir-join a b)
285 (string-append a "/" b)))
287 (define (dir-listing dir-name)
288 (define (dir-helper dir lst)
289 (let ((e (readdir dir)))
290 (if (eof-object? e) lst (dir-helper dir (cons e lst)))))
291 (reverse (dir-helper (opendir dir-name) '())))
293 (define (handle-mac-font name filename)
300 (mkdir dir-name #o700)
301 (set! status (ly:system
302 (format "cd ~a && fondu -force '~a'" dir-name filename)))
304 (set! files (dir-listing dir-name))
309 ((full-name (dir-join dir-name f)))
312 (equal? 'regular (stat:type (stat full-name)))
313 (equal? name (ly:ttf-ps-name full-name)))
316 (font-file-as-ps-string name full-name)))
318 (if (or (equal? "." f)
321 (delete-file full-name))))
329 (set! embed "% failed \n")
330 (ly:warning (_ "can't extract file matching ~a from ~a") name filename)))
333 (define (font-file-as-ps-string name file-name)
335 ((downcase-file-name (string-downcase file-name)))
338 ((and file-name (string-match "\\.pfa" downcase-file-name))
339 (embed-document file-name))
340 ((and file-name (string-match "\\.pfb" downcase-file-name))
341 (ly:pfb->pfa file-name))
342 ((and file-name (string-match "\\.ttf" downcase-file-name))
343 (ly:ttf->pfa file-name))
344 ((and file-name (string-match "\\.otf" downcase-file-name))
345 (ps-embed-cff (ly:otf->cff file-name) name 0))
347 (ly:warning (_ "don't know how to embed ~S=~S") name file-name)
350 (define (mac-font? bare-file-name)
352 (eq? PLATFORM 'darwin)
355 (string-match "\\.dfont" bare-file-name)
356 (= (stat:size (stat bare-file-name)) 0))))
358 (define (load-font font-name-filename)
359 (let* ((font (car font-name-filename))
360 (name (cadr font-name-filename))
361 (file-name (caddr font-name-filename))
362 (bare-file-name (ly:find-file file-name)))
368 ((mac-font? bare-file-name)
369 (handle-mac-font name bare-file-name))
371 ((and font (cff-font? font))
372 (ps-embed-cff (ly:otf-font-table-data font "CFF ")
376 (bare-file-name (font-file-as-ps-string name bare-file-name))
378 (ly:warning (_ "don't know how to embed font ~s ~s ~s")
379 name file-name font))))))
382 (define (load-fonts paper)
383 (let* ((fonts (ly:paper-fonts paper))
388 ((string? (ly:font-file-name font))
392 (ly:font-file-name font))))
393 ((ly:pango-font? font)
395 (lambda (name-psname-pair)
397 (car name-psname-pair)
398 (cdr name-psname-pair)))
399 (ly:pango-font-physical-fonts font)))
402 (ly:font-sub-fonts font))))
407 (sort (apply append all-font-names)
408 (lambda (x y) (string<? (cadr x) (cadr y))))))
411 (font-loader (if (ly:get-option 'gs-font-load)
415 (pfas (map font-loader font-names)))
418 (display "%%BeginProlog\n" port)
422 (format port "\n%%BeginFont: ~a\n" (car f))
423 (display (cdr f) port)
424 (display "\n%%EndFont\n" port))
427 (display (setup-variables paper) port)
429 ;; adobe note 5002: should initialize variables before loading routines.
430 (display (procset "music-drawing-routines.ps") port)
431 (display (procset "lilyponddefs.ps") port)
433 (display "%%EndProlog\n" port)
435 (display "%%BeginSetup\ninit-lilypond-parameters\n%%EndSetup\n\n" port))
437 (define-public (output-framework basename book scopes fields)
438 (let* ((filename (format "~a.ps" basename))
439 (outputter (ly:make-paper-outputter
440 ;; FIXME: better wrap open/open-file,
441 ;; content-mangling is always bad.
442 ;; MINGW hack: need to have "b"inary for embedding CFFs
443 (open-file filename "wb")
445 (paper (ly:paper-book-paper book))
446 (page-stencils (map page-stencil (ly:paper-book-pages book)))
448 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
449 (page-number (1- (ly:output-def-lookup paper 'first-page-number)))
450 (page-count (length page-stencils))
451 (port (ly:outputter-port outputter)))
453 (output-scopes scopes fields basename)
454 (display (file-header paper page-count #t) port)
457 ;; don't do BeginDefaults PageMedia: A4
458 ;; not necessary and wrong
461 (write-preamble paper #t port)
465 (set! page-number (1+ page-number))
466 (dump-page outputter page page-number page-count landscape?))
469 (display "%%Trailer\n%%EOF\n" port)
470 (ly:outputter-close outputter)
471 (postprocess-output book framework-ps-module filename
472 (ly:output-formats))))
474 (define-public (dump-stencil-as-EPS paper dump-me filename load-fonts?)
475 (define (to-bp-box mmbox)
476 (let* ((scale (ly:output-def-lookup paper 'output-scale))
479 (if (or (nan? x) (inf? x))
482 (round (/ (* x scale) (ly:bp 1)))))) mmbox)))
486 (max (1+ (car box)) (caddr box))
487 (max (1+ (cadr box)) (cadddr box))
490 (let* ((outputter (ly:make-paper-outputter
491 ;; FIXME: better wrap open/open-file,
492 ;; content-mangling is always bad.
493 ;; MINGW hack: need to have "b"inary for embedding CFFs
494 (open-file (format "~a.eps" filename) "wb")
498 (port (ly:outputter-port outputter))
499 (xext (ly:stencil-extent dump-me X))
500 (yext (ly:stencil-extent dump-me Y))
504 (if (or (nan? x) (inf? x)
506 (equal? (format #f "~S" x) "+#.#")
507 (equal? (format #f "~S" x) "-#.#"))
510 ;; the left-overshoot is to make sure that
511 ;; bar numbers stick out of margin uniformly.
513 (list (min left-overshoot (car xext))
514 (car yext) (cdr xext) (cdr yext))))
515 (rounded-bbox (to-bp-box bbox))
516 (port (ly:outputter-port outputter))
517 (header (eps-header paper rounded-bbox load-fonts?)))
519 (display header port)
520 (write-preamble paper load-fonts? port)
521 (display "gsave set-ps-scale-to-lily-scale \n" port)
522 (ly:outputter-dump-stencil outputter dump-me)
523 (display "stroke grestore\n%%Trailer\n%%EOF\n" port)
524 (ly:outputter-close outputter)))
526 (define-public (output-preview-framework basename book scopes fields)
527 (let* ((paper (ly:paper-book-paper book))
528 (systems (ly:paper-book-systems book))
529 (scale (ly:output-def-lookup paper 'output-scale))
530 (to-dump-systems '()))
534 (not (ly:get-option 'preview-include-book-title))
536 (ly:prob-property (car systems) 'is-book-title #f))
538 (set! systems (cdr systems)))
543 (paper-system-title? sys)
544 (not (pair? to-dump-systems))
545 (paper-system-title? (car to-dump-systems)))
546 (set! to-dump-systems (cons sys to-dump-systems))))
551 (stack-stencils Y DOWN 0.0
552 (map paper-system-stencil (reverse to-dump-systems)))
553 (format "~a.preview" basename)
556 (postprocess-output book framework-ps-module
557 (format "~a.preview.eps" basename)
558 (cons "png" (ly:output-formats)))))
561 (define-public (output-preview-framework basename book scopes fields)
563 (let* ((paper (ly:paper-book-paper book))
564 (systems (ly:paper-book-systems book))
565 (scale (ly:output-def-lookup paper 'output-scale))
566 (titles (take-while paper-system-title? systems))
567 (non-title (find (lambda (x)
568 (not (paper-system-title? x))) systems))
570 (stack-stencils Y DOWN 0.0
571 (map paper-system-stencil
572 (append titles (list non-title))))))
573 (output-scopes scopes fields basename)
574 (dump-stencil-as-EPS paper dump-me
575 (format "~a.preview" basename)
578 (postprocess-output book framework-ps-module
579 (format "~a.preview.eps" basename)
580 (ly:output-formats)))))
581 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
583 (define-public (convert-to-pdf book name)
584 (let* ((defs (ly:paper-book-paper book))
585 (papersizename (ly:output-def-lookup defs 'papersizename)))
587 (if (equal? (basename name ".ps") "-")
588 (ly:warning (_ "can't convert <stdout> to ~S" "PDF"))
589 (postscript->pdf (if (string? papersizename) papersizename "a4")
592 (define-public (convert-to-png book name)
593 (let* ((defs (ly:paper-book-paper book))
594 (defs-resolution (ly:output-def-lookup defs 'pngresolution))
595 (resolution (if (number? defs-resolution)
597 (ly:get-option 'resolution)))
598 (papersizename (ly:output-def-lookup defs 'papersizename)))
600 (postscript->png resolution
601 (if (string? papersizename) papersizename "a4")
604 (define-public (convert-to-dvi book name)
605 (ly:warning (_ "can't generate ~S using the postscript back-end") "DVI"))
607 (define-public (convert-to-tex book name)
608 (ly:warning (_ "can't generate ~S using the postscript back-end") "TeX"))
610 (define-public (convert-to-ps book name)
613 (define-public (output-classic-framework basename book scopes fields)
615 (ly:error (_ "\nThe PostScript backend does not support the 'classic'
616 framework. Use the EPS backend instead,
618 lilypond -b eps <file>
620 or remove the lilypond-book specific settings from the input.