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)
20 (define framework-ps-module (current-module))
22 ;;(define pdebug stderr)
23 (define (pdebug . rest) #f)
25 (define mm-to-bigpoint
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)))
34 (string-regexp-substitute "[ /%]" "_" name)
35 "m" (string-encode-integer (inexact->exact (round (* 1000 magnify)))))))
37 (define (tex-font? fontname)
39 (equal? (substring fontname 0 2) "cm")
40 (equal? (substring fontname 0 2) "ec")))
42 (define (define-fonts paper)
43 (define font-list (ly:paper-fonts paper))
44 (define (define-font command fontname scaling)
46 "/" command " { /" fontname " findfont "
47 (ly:number->string scaling) " output-scale div scalefont } bind def\n"))
49 (define (standard-tex-font? x)
50 (or (equal? (substring x 0 2) "ms")
51 (equal? (substring x 0 2) "cm")))
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))
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)))
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)))
76 (map (lambda (x) (font-load-command x))
77 (filter (lambda (x) (not (ly:pango-font? x)))
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)
86 ((string? val) (string-append "(" val ")"))
87 ((symbol? val) (symbol->string val))
88 ((number? val) (number->string val))
91 (define (output-entry ps-key ly-key)
94 (value->string (ly:output-def-lookup layout ly-key)) " def\n"))
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.
105 (number->string (ly:output-def-lookup layout 'outputscale))
107 (output-entry "page-height" 'vsize)
108 (output-entry "page-width" 'hsize)))
110 (define (dump-page outputter page page-number page-count landscape?)
111 (ly:outputter-dump-string
115 (number->string page-number) " " (number->string page-count) "\n"
119 "page-width output-scale lily-output-units mul mul 0 translate 90 rotate\n"
124 "set-ps-scale-to-lily-scale "
126 (ly:outputter-dump-stencil outputter page)
127 (ly:outputter-dump-string outputter "} stop-system \nshowpage\n"))
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)))))
135 (let* ((fonts (ly:paper-fonts paper))
136 (names (apply append (map extract-names fonts))))
142 "%%DocumentSuppliedResources: font ~a\n"
143 "%%DocumentNeededResources: font ~a\n")
145 (uniq-list (sort names string<?))))))
147 (define (eps-header paper bbox load-fonts?)
148 (string-append "%!PS-Adobe-2.0 EPSF-2.0\n"
149 "%%Creator: LilyPond "
153 (string-join (map ly:number->string bbox) " ") "\n"
155 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
158 (supplies-or-needs paper load-fonts?)
161 (define (page-header paper page-count load-fonts?)
162 (string-append "%!PS-Adobe-3.0\n"
163 "%%Creator: LilyPond "
167 "%%Pages: " (number->string page-count) "\n"
168 "%%PageOrder: Ascend\n"
170 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
173 "%%DocumentPaperSizes: "
174 (ly:output-def-lookup paper 'papersizename) "\n"
175 (supplies-or-needs paper load-fonts?)
178 (define (procset file-name)
181 "%%BeginResource: procset (~a) 1 0
185 file-name (cached-file-contents file-name))))
187 (define (setup paper)
192 (output-variables paper)
195 (define-public (munge-lily-font-name name)
196 ;; FIXME: this fixes PFAPAFemmentaler.pfapfa, and also
197 ;; PFAaybabtu.otf.pfa, but the second case now produces aybabtu.otf,
198 ;; which still fails because .otf files cannot be embedded.
199 (regexp-substitute/global #f "^([eE]mmentaler|[aA]ybabtu)"
200 name 'pre "PFA" 1 'post))
202 (define (cff-font? font)
204 ((cff-string (ly:otf-font-table-data font "CFF ")))
205 (> (string-length cff-string) 0)))
207 (define-public (ps-embed-cff body font-set-name version)
210 (format "/~a ~s StartData " font-set-name (string-length body))
215 "%%BeginResource: font ~a
216 %!PS-Adobe-3.0 Resource-FontSet
217 %%DocumentNeededResources: ProcSet (FontSetInit)
218 %%Title: (FontSet/~a)
221 %%IncludeResource: ProcSet (FontSetInit)
222 %%BeginResource: FontSet (~a)
223 /FontSetInit /ProcSet findresource begin
224 %%BeginData: ~s Binary Bytes
226 font-set-name font-set-name version font-set-name
227 (string-length binary-data)))
239 (define (write-preamble paper load-fonts? port)
241 (define (load-font-via-GS font-name-filename)
242 (define (ps-load-file name)
245 "(~a) (r) file .loadfont\n"
246 "% can't find font file: ~a\n")
249 (let* ((font (car font-name-filename))
250 (name (cadr font-name-filename))
251 (file-name (caddr font-name-filename))
252 (bare-file-name (ly:find-file file-name)))
255 (munge-lily-font-name name)
257 ((string-match "^([eE]mmentaler|[Aa]ybabtu)" file-name)
258 (ps-load-file (ly:find-file
259 (format "~a.pfa" (munge-lily-font-name file-name)))))
260 ((string? bare-file-name)
261 (ps-load-file (munge-lily-font-name file-name)))
263 (ly:warning (_ "can't embed ~S=~S") name file-name)
266 (define (dir-join a b)
269 (string-append a "/" b)))
271 (define (dir-listing dir-name)
272 (define (dir-helper dir lst)
273 (let ((e (readdir dir)))
274 (if (eof-object? e) lst (dir-helper dir (cons e lst)))))
275 (reverse (dir-helper (opendir dir-name) '())))
277 (define (handle-mac-font name filename)
284 (mkdir dir-name #o700)
285 (set! status (ly:system
286 (format "cd ~a && fondu -force '~a'" dir-name filename)))
288 (set! files (dir-listing dir-name))
293 (equal? name (ly:ttf-ps-name f)))
295 (font-file-as-ps-string name (dir-join dir-name f))))
297 (if (or (equal? "." f)
300 (delete-file (dir-join dir-name f))))
306 (set! embed "% failed \n")
307 (ly:warning (_ "can't extract file matching ~a from ~a") name filename)))
310 (define (font-file-as-ps-string name file-name)
312 ((downcase-file-name (string-downcase file-name)))
315 ((and file-name (string-match "\\.pfa" downcase-file-name))
316 (cached-file-contents file-name))
317 ((and file-name (string-match "\\.pfb" downcase-file-name))
318 (ly:pfb->pfa file-name))
319 ((and file-name (string-match "\\.ttf" downcase-file-name))
320 (ly:ttf->pfa file-name))
321 ((and file-name (string-match "\\.otf" downcase-file-name))
322 (ps-embed-cff (ly:otf->cff file-name) name 0))
324 (ly:warning (_ "don't know how to embed ~S=~S") name file-name)
327 (define (load-font font-name-filename)
328 (let* ((font (car font-name-filename))
329 (name (cadr font-name-filename))
330 (file-name (caddr font-name-filename))
331 (bare-file-name (ly:find-file file-name)))
334 (munge-lily-font-name name)
336 ((string-match "^([eE]mmentaler|[Aa]ybabtu)" file-name)
337 (cached-file-contents
338 (format "~a.pfa" (munge-lily-font-name file-name))))
340 (eq? PLATFORM 'darwin)
341 bare-file-name (string-match "\\.dfont" bare-file-name))
342 (handle-mac-font name bare-file-name))
345 (eq? PLATFORM 'darwin)
346 bare-file-name (= (stat:size (stat bare-file-name)) 0))
347 (handle-mac-font name bare-file-name))
349 ((and font (cff-font? font))
350 (ps-embed-cff (ly:otf-font-table-data font "CFF ")
354 (bare-file-name (font-file-as-ps-string name bare-file-name))
356 (ly:warning (_ "don't know how to embed font ~s ~s ~s")
357 name file-name font))))))
360 (define (load-fonts paper)
361 (let* ((fonts (ly:paper-fonts paper))
366 ((string? (ly:font-file-name font))
370 (ly:font-file-name font))))
371 ((ly:pango-font? font)
373 (lambda (name-psname-pair)
375 (car name-psname-pair)
376 (cdr name-psname-pair)))
377 (ly:pango-font-physical-fonts font)))
380 (ly:font-sub-fonts font))))
385 (sort (apply append all-font-names)
386 (lambda (x y) (string<? (cadr x) (cadr y))))))
389 (font-loader (if (ly:get-option 'gs-font-load)
393 (pfas (map font-loader font-names)))
399 (format port "\n%%BeginFont: ~a\n" (car f))
400 (display (cdr f) port)
401 (display "\n%%EndFont\n" port))
404 (display (setup paper) port)
406 ;; adobe note 5002: should initialize variables before loading routines.
407 (display (procset "music-drawing-routines.ps") port)
408 (display (procset "lilyponddefs.ps") port)
409 (display "init-lilypond-parameters\n" port))
411 (define-public (output-framework basename book scopes fields)
412 (let* ((filename (format "~a.ps" basename))
413 (outputter (ly:make-paper-outputter
414 ;; FIXME: better wrap open/open-file,
415 ;; content-mangling is always bad.
416 ;; MINGW hack: need to have "b"inary for embedding CFFs
417 (open-file filename "wb")
419 (paper (ly:paper-book-paper book))
420 (pages (ly:paper-book-pages book))
421 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
422 (page-number (1- (ly:output-def-lookup paper 'firstpagenumber)))
423 (page-count (length pages))
424 (port (ly:outputter-port outputter)))
426 (output-scopes scopes fields basename)
427 (display (page-header paper page-count #t) port)
428 (write-preamble paper #t port)
432 (set! page-number (1+ page-number))
433 (dump-page outputter page page-number page-count landscape?))
436 (display "%%Trailer\n%%EOF\n" port)
437 (ly:outputter-close outputter)
438 (postprocess-output book framework-ps-module filename
439 (ly:output-formats))))
441 (if (not (defined? 'nan?))
442 (define (nan? x) #f))
444 (if (not (defined? 'inf?))
445 (define (inf? x) #f))
447 (define-public (dump-stencil-as-EPS paper dump-me filename load-fonts?)
448 (define (mm-to-bp-box mmbox)
449 (let* ((scale (ly:output-def-lookup paper 'outputscale))
453 (round (* x scale mm-to-bigpoint)))) mmbox)))
455 (list (car box) (cadr box)
456 (max (1+ (car box)) (caddr box))
457 (max (1+ (cadr box)) (cadddr box)))))
459 (let* ((outputter (ly:make-paper-outputter
460 ;; FIXME: better wrap open/open-file,
461 ;; content-mangling is always bad.
462 ;; MINGW hack: need to have "b"inary for embedding CFFs
463 (open-file (format "~a.eps" filename) "wb")
465 (port (ly:outputter-port outputter))
466 (xext (ly:stencil-extent dump-me X))
467 (yext (ly:stencil-extent dump-me Y))
471 (if (or (nan? x) (inf? x)
473 (equal? (format #f "~S" x) "+#.#")
474 (equal? (format #f "~S" x) "-#.#"))
476 ;; set left of X to 0, to prevent barnumbers
477 ;; from sticking out of margin.
478 (list 0.0 (car yext) (cdr xext) (cdr yext))))
479 (rounded-bbox (mm-to-bp-box bbox))
480 (port (ly:outputter-port outputter))
481 (header (eps-header paper rounded-bbox load-fonts?)))
483 (display header port)
484 (write-preamble paper load-fonts? port)
485 (display "start-system { set-ps-scale-to-lily-scale \n" port)
486 (ly:outputter-dump-stencil outputter dump-me)
487 (display "} stop-system\n%%Trailer\n%%EOF\n" port)
488 (ly:outputter-close outputter)))
490 (define-public (output-preview-framework basename book scopes fields)
491 (let* ((paper (ly:paper-book-paper book))
492 (systems (ly:paper-book-systems book))
493 (scale (ly:output-def-lookup paper 'outputscale))
494 (to-dump-systems '()))
498 (not (ly:get-option 'preview-include-book-title))
500 (ly:paper-system-property (car systems) 'is-book-title #f))
502 (set! systems (cdr systems)))
507 (paper-system-title? sys)
508 (not (pair? to-dump-systems))
509 (paper-system-title? (car to-dump-systems)))
510 (set! to-dump-systems (cons sys to-dump-systems))))
515 (stack-stencils Y DOWN 0.0
516 (map paper-system-stencil (reverse to-dump-systems)))
517 (format "~a.preview" basename)
520 (postprocess-output book framework-ps-module
521 (format "~a.preview.eps" basename)
522 (cons "png" (ly:output-formats)))))
524 (define-public (output-preview-framework basename book scopes fields)
526 (let* ((paper (ly:paper-book-paper book))
527 (systems (ly:paper-book-systems book))
528 (scale (ly:output-def-lookup paper 'outputscale))
529 (titles (take-while paper-system-title? systems))
530 (non-title (find (lambda (x)
531 (not (paper-system-title? x))) systems))
533 (stack-stencils Y DOWN 0.0
534 (map paper-system-stencil
535 (append titles (list non-title))))))
536 (output-scopes scopes fields basename)
537 (dump-stencil-as-EPS paper dump-me
538 (format "~a.preview" basename)
541 (postprocess-output book framework-ps-module
542 (format "~a.preview.eps" basename)
543 (ly:output-formats)))))
544 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
546 (define-public (convert-to-pdf book name)
547 (let* ((defs (ly:paper-book-paper book))
548 (papersizename (ly:output-def-lookup defs 'papersizename)))
550 (if (equal? (basename name ".ps") "-")
551 (ly:warning (_ "can't convert <stdout> to ~S" "PDF"))
552 (postscript->pdf (if (string? papersizename) papersizename "a4")
555 (define-public (convert-to-png book name)
556 (let* ((defs (ly:paper-book-paper book))
557 (defs-resolution (ly:output-def-lookup defs 'pngresolution))
558 (resolution (if (number? defs-resolution)
560 (ly:get-option 'resolution)))
561 (papersizename (ly:output-def-lookup defs 'papersizename)))
563 (postscript->png resolution
564 (if (string? papersizename) papersizename "a4")
567 (define-public (convert-to-dvi book name)
568 (ly:warning (_ "can't generate ~S using the postscript back-end") "DVI"))
570 (define-public (convert-to-tex book name)
571 (ly:warning (_ "can't generate ~S using the postscript back-end") "TeX"))
573 (define-public (convert-to-ps book name)
576 (define-public (output-classic-framework basename book scopes fields)
578 (ly:error (_ "\nThe PostScript backend does not support the 'classic'
579 framework. Use the EPS backend instead,
581 lilypond -b eps <file>
583 or remove the lilypond-book specific settings from the input.