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 mm-to-bigpoint
30 (define-public (ps-font-command font)
31 (let* ((name (munge-lily-font-name (ly:font-file-name font)))
32 (magnify (ly:font-magnification font)))
36 (string-regexp-substitute "[ /%]" "_" name)
37 "m" (string-encode-integer (inexact->exact (round (* 1000 magnify)))))))
39 (define (tex-font? fontname)
41 (equal? (substring fontname 0 2) "cm")
42 (equal? (substring fontname 0 2) "ec")))
44 (define (define-fonts paper)
45 (define font-list (ly:paper-fonts paper))
46 (define (define-font command fontname scaling)
48 "/" command " { /" fontname " findfont "
49 (ly:number->string scaling) " output-scale div scalefont } bind def\n"))
51 (define (standard-tex-font? x)
52 (or (equal? (substring x 0 2) "ms")
53 (equal? (substring x 0 2) "cm")))
55 (define (font-load-command font)
56 (let* ((specced-font-name (ly:font-name font))
57 (fontname (if specced-font-name
58 (munge-lily-font-name specced-font-name)
59 (ly:font-file-name font)))
60 (command (ps-font-command font))
62 ;; FIXME -- see (ps-font-command )
63 (plain (ps-font-command font))
64 (designsize (ly:font-design-size font))
65 (magnification (* (ly:font-magnification font)))
66 (ops (ly:output-def-lookup paper 'outputscale))
67 (scaling (* ops magnification designsize)))
69 ;; Bluesky pfbs have UPCASE names (sigh.)
70 ;; FIXME - don't support Bluesky?
71 (if (standard-tex-font? fontname)
72 (set! fontname (string-upcase fontname)))
73 (if (equal? fontname "unknown")
74 (display (list font fontname)))
75 (define-font plain fontname scaling)))
78 (map (lambda (x) (font-load-command x))
79 (filter (lambda (x) (not (ly:pango-font? x)))
82 ;; FIXME: duplicated in other output backends
83 ;; FIXME: silly interface name
84 (define (output-variables layout)
85 ;; FIXME: duplicates output-layout's scope-entry->string, mostly
86 (define (value->string val)
88 ((string? val) (string-append "(" val ")"))
89 ((symbol? val) (symbol->string val))
90 ((number? val) (number->string val))
93 (define (output-entry ps-key ly-key)
96 (value->string (ly:output-def-lookup layout ly-key)) " def\n"))
100 (number->string mm-to-bigpoint)
101 " def %% millimeter\n"
102 (output-entry "staff-line-thickness" 'linethickness)
103 (output-entry "line-width" 'linewidth)
104 (output-entry "paper-size" 'papersizename)
105 (output-entry "staff-height" 'staffheight) ;junkme.
107 (number->string (ly:output-def-lookup layout 'outputscale))
109 (output-entry "page-height" 'vsize)
110 (output-entry "page-width" 'hsize)))
112 (define (dump-page outputter page page-number page-count landscape?)
113 (ly:outputter-dump-string
117 (number->string page-number) " " (number->string page-count) "\n"
121 "page-width output-scale lily-output-units mul mul 0 translate 90 rotate\n"
126 "set-ps-scale-to-lily-scale "
128 (ly:outputter-dump-stencil outputter page)
129 (ly:outputter-dump-string outputter "} stop-system \nshowpage\n"))
131 (define (supplies-or-needs paper load-fonts?)
132 (define (extract-names font)
133 (if (ly:pango-font? font)
134 (map car (ly:pango-font-physical-fonts font))
135 (list (munge-lily-font-name (ly:font-name font)))))
137 (let* ((fonts (ly:paper-fonts paper))
138 (names (apply append (map extract-names fonts))))
144 "%%DocumentSuppliedResources: font ~a\n"
145 "%%DocumentNeededResources: font ~a\n")
147 (uniq-list (sort names string<?))))))
149 (define (eps-header paper bbox load-fonts?)
150 (string-append "%!PS-Adobe-2.0 EPSF-2.0\n"
151 "%%Creator: LilyPond "
155 (string-join (map ly:number->string bbox) " ") "\n"
157 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
160 (supplies-or-needs paper load-fonts?)
163 (define (page-header paper page-count load-fonts?)
164 (string-append "%!PS-Adobe-3.0\n"
165 "%%Creator: LilyPond "
169 "%%Pages: " (number->string page-count) "\n"
170 "%%PageOrder: Ascend\n"
172 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
175 "%%DocumentPaperSizes: "
176 (ly:output-def-lookup paper 'papersizename) "\n"
177 (supplies-or-needs paper load-fonts?)
180 (define (procset file-name)
183 "%%BeginResource: procset (~a) 1 0
187 file-name (cached-file-contents file-name))))
189 (define (setup paper)
194 (output-variables paper)
197 (define-public (munge-lily-font-name name)
198 ;; FIXME: this fixes PFAPAFemmentaler.pfapfa, and also
199 ;; PFAaybabtu.otf.pfa, but the second case now produces aybabtu.otf,
200 ;; which still fails because .otf files cannot be embedded.
201 (regexp-substitute/global #f "^([eE]mmentaler|[aA]ybabtu)"
202 name 'pre "PFA" 1 'post))
204 (define (cff-font? font)
206 ((cff-string (ly:otf-font-table-data font "CFF ")))
207 (> (string-length cff-string) 0)))
209 (define-public (ps-embed-cff body font-set-name version)
212 (format "/~a ~s StartData " font-set-name (string-length body))
217 "%%BeginResource: font ~a
218 %!PS-Adobe-3.0 Resource-FontSet
219 %%DocumentNeededResources: ProcSet (FontSetInit)
220 %%Title: (FontSet/~a)
223 %%IncludeResource: ProcSet (FontSetInit)
224 %%BeginResource: FontSet (~a)
225 /FontSetInit /ProcSet findresource begin
226 %%BeginData: ~s Binary Bytes
228 font-set-name font-set-name version font-set-name
229 (string-length binary-data)))
241 (define (write-preamble paper load-fonts? port)
243 (define (load-font-via-GS font-name-filename)
244 (define (ps-load-file name)
247 "(~a) (r) file .loadfont\n"
248 "% can't find font file: ~a\n")
251 (let* ((font (car font-name-filename))
252 (name (cadr font-name-filename))
253 (file-name (caddr font-name-filename))
254 (bare-file-name (ly:find-file file-name)))
257 (munge-lily-font-name name)
259 ((string-match "^([eE]mmentaler|[Aa]ybabtu)" file-name)
260 (ps-load-file (ly:find-file
261 (format "~a.pfa" (munge-lily-font-name file-name)))))
262 ((string? bare-file-name)
263 (ps-load-file (munge-lily-font-name file-name)))
265 (ly:warning (_ "can't embed ~S=~S") name file-name)
268 (define (dir-join a b)
271 (string-append a "/" b)))
273 (define (dir-listing dir-name)
274 (define (dir-helper dir lst)
275 (let ((e (readdir dir)))
276 (if (eof-object? e) lst (dir-helper dir (cons e lst)))))
277 (reverse (dir-helper (opendir dir-name) '())))
279 (define (handle-mac-font name filename)
286 (mkdir dir-name #o700)
287 (set! status (ly:system
288 (format "cd ~a && fondu -force '~a'" dir-name filename)))
290 (set! files (dir-listing dir-name))
295 ((full-name (dir-join dir-name f)))
298 (equal? 'regular (stat:type (stat full-name)))
299 (equal? name (ly:ttf-ps-name full-name)))
302 (font-file-as-ps-string name full-name)))
304 (if (or (equal? "." f)
307 (delete-file full-name))))
315 (set! embed "% failed \n")
316 (ly:warning (_ "can't extract file matching ~a from ~a") name filename)))
319 (define (font-file-as-ps-string name file-name)
321 ((downcase-file-name (string-downcase file-name)))
324 ((and file-name (string-match "\\.pfa" downcase-file-name))
325 (cached-file-contents file-name))
326 ((and file-name (string-match "\\.pfb" downcase-file-name))
327 (ly:pfb->pfa file-name))
328 ((and file-name (string-match "\\.ttf" downcase-file-name))
329 (ly:ttf->pfa file-name))
330 ((and file-name (string-match "\\.otf" downcase-file-name))
331 (ps-embed-cff (ly:otf->cff file-name) name 0))
333 (ly:warning (_ "don't know how to embed ~S=~S") name file-name)
336 (define (load-font font-name-filename)
337 (let* ((font (car font-name-filename))
338 (name (cadr font-name-filename))
339 (file-name (caddr font-name-filename))
340 (bare-file-name (ly:find-file file-name)))
343 (munge-lily-font-name name)
345 ((string-match "^([eE]mmentaler|[Aa]ybabtu)" file-name)
346 (cached-file-contents
347 (format "~a.pfa" (munge-lily-font-name file-name))))
349 (eq? PLATFORM 'darwin)
350 bare-file-name (string-match "\\.dfont" bare-file-name))
351 (handle-mac-font name bare-file-name))
354 (eq? PLATFORM 'darwin)
355 bare-file-name (= (stat:size (stat bare-file-name)) 0))
356 (handle-mac-font name bare-file-name))
358 ((and font (cff-font? font))
359 (ps-embed-cff (ly:otf-font-table-data font "CFF ")
363 (bare-file-name (font-file-as-ps-string name bare-file-name))
365 (ly:warning (_ "don't know how to embed font ~s ~s ~s")
366 name file-name font))))))
369 (define (load-fonts paper)
370 (let* ((fonts (ly:paper-fonts paper))
375 ((string? (ly:font-file-name font))
379 (ly:font-file-name font))))
380 ((ly:pango-font? font)
382 (lambda (name-psname-pair)
384 (car name-psname-pair)
385 (cdr name-psname-pair)))
386 (ly:pango-font-physical-fonts font)))
389 (ly:font-sub-fonts font))))
394 (sort (apply append all-font-names)
395 (lambda (x y) (string<? (cadr x) (cadr y))))))
398 (font-loader (if (ly:get-option 'gs-font-load)
402 (pfas (map font-loader font-names)))
408 (format port "\n%%BeginFont: ~a\n" (car f))
409 (display (cdr f) port)
410 (display "\n%%EndFont\n" port))
413 (display (setup paper) port)
415 ;; adobe note 5002: should initialize variables before loading routines.
416 (display (procset "music-drawing-routines.ps") port)
417 (display (procset "lilyponddefs.ps") port)
418 (display "init-lilypond-parameters\n" port))
420 (define-public (output-framework basename book scopes fields)
421 (let* ((filename (format "~a.ps" basename))
422 (outputter (ly:make-paper-outputter
423 ;; FIXME: better wrap open/open-file,
424 ;; content-mangling is always bad.
425 ;; MINGW hack: need to have "b"inary for embedding CFFs
426 (open-file filename "wb")
428 (paper (ly:paper-book-paper book))
429 (page-stencils (map page-stencil (ly:paper-book-pages book)))
431 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
432 (page-number (1- (ly:output-def-lookup paper 'firstpagenumber)))
433 (page-count (length page-stencils))
434 (port (ly:outputter-port outputter)))
436 (output-scopes scopes fields basename)
437 (display (page-header paper page-count #t) port)
438 (write-preamble paper #t port)
442 (set! page-number (1+ page-number))
443 (dump-page outputter page page-number page-count landscape?))
446 (display "%%Trailer\n%%EOF\n" port)
447 (ly:outputter-close outputter)
448 (postprocess-output book framework-ps-module filename
449 (ly:output-formats))))
451 (if (not (defined? 'nan?))
452 (define (nan? x) #f))
454 (if (not (defined? 'inf?))
455 (define (inf? x) #f))
457 (define-public (dump-stencil-as-EPS paper dump-me filename load-fonts?)
458 (define (mm-to-bp-box mmbox)
459 (let* ((scale (ly:output-def-lookup paper 'outputscale))
463 (round (* x scale mm-to-bigpoint)))) mmbox)))
465 (list (car box) (cadr box)
466 (max (1+ (car box)) (caddr box))
467 (max (1+ (cadr box)) (cadddr box)))))
469 (let* ((outputter (ly:make-paper-outputter
470 ;; FIXME: better wrap open/open-file,
471 ;; content-mangling is always bad.
472 ;; MINGW hack: need to have "b"inary for embedding CFFs
473 (open-file (format "~a.eps" filename) "wb")
475 (port (ly:outputter-port outputter))
476 (xext (ly:stencil-extent dump-me X))
477 (yext (ly:stencil-extent dump-me Y))
481 (if (or (nan? x) (inf? x)
483 (equal? (format #f "~S" x) "+#.#")
484 (equal? (format #f "~S" x) "-#.#"))
486 ;; set left of X to 0, to prevent barnumbers
487 ;; from sticking out of margin.
488 (list 0.0 (car yext) (cdr xext) (cdr yext))))
489 (rounded-bbox (mm-to-bp-box bbox))
490 (port (ly:outputter-port outputter))
491 (header (eps-header paper rounded-bbox load-fonts?)))
493 (display header port)
494 (write-preamble paper load-fonts? port)
495 (display "start-system { set-ps-scale-to-lily-scale \n" port)
496 (ly:outputter-dump-stencil outputter dump-me)
497 (display "} stop-system\n%%Trailer\n%%EOF\n" port)
498 (ly:outputter-close outputter)))
500 (define-public (output-preview-framework basename book scopes fields)
501 (let* ((paper (ly:paper-book-paper book))
502 (systems (ly:paper-book-systems book))
503 (scale (ly:output-def-lookup paper 'outputscale))
504 (to-dump-systems '()))
508 (not (ly:get-option 'preview-include-book-title))
510 (ly:prob-property (car systems) 'is-book-title #f))
512 (set! systems (cdr systems)))
517 (paper-system-title? sys)
518 (not (pair? to-dump-systems))
519 (paper-system-title? (car to-dump-systems)))
520 (set! to-dump-systems (cons sys to-dump-systems))))
525 (stack-stencils Y DOWN 0.0
526 (map paper-system-stencil (reverse to-dump-systems)))
527 (format "~a.preview" basename)
530 (postprocess-output book framework-ps-module
531 (format "~a.preview.eps" basename)
532 (cons "png" (ly:output-formats)))))
534 (define-public (output-preview-framework basename book scopes fields)
536 (let* ((paper (ly:paper-book-paper book))
537 (systems (ly:paper-book-systems book))
538 (scale (ly:output-def-lookup paper 'outputscale))
539 (titles (take-while paper-system-title? systems))
540 (non-title (find (lambda (x)
541 (not (paper-system-title? x))) systems))
543 (stack-stencils Y DOWN 0.0
544 (map paper-system-stencil
545 (append titles (list non-title))))))
546 (output-scopes scopes fields basename)
547 (dump-stencil-as-EPS paper dump-me
548 (format "~a.preview" basename)
551 (postprocess-output book framework-ps-module
552 (format "~a.preview.eps" basename)
553 (ly:output-formats)))))
554 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
556 (define-public (convert-to-pdf book name)
557 (let* ((defs (ly:paper-book-paper book))
558 (papersizename (ly:output-def-lookup defs 'papersizename)))
560 (if (equal? (basename name ".ps") "-")
561 (ly:warning (_ "can't convert <stdout> to ~S" "PDF"))
562 (postscript->pdf (if (string? papersizename) papersizename "a4")
565 (define-public (convert-to-png book name)
566 (let* ((defs (ly:paper-book-paper book))
567 (defs-resolution (ly:output-def-lookup defs 'pngresolution))
568 (resolution (if (number? defs-resolution)
570 (ly:get-option 'resolution)))
571 (papersizename (ly:output-def-lookup defs 'papersizename)))
573 (postscript->png resolution
574 (if (string? papersizename) papersizename "a4")
577 (define-public (convert-to-dvi book name)
578 (ly:warning (_ "can't generate ~S using the postscript back-end") "DVI"))
580 (define-public (convert-to-tex book name)
581 (ly:warning (_ "can't generate ~S using the postscript back-end") "TeX"))
583 (define-public (convert-to-ps book name)
586 (define-public (output-classic-framework basename book scopes fields)
588 (ly:error (_ "\nThe PostScript backend does not support the 'classic'
589 framework. Use the EPS backend instead,
591 lilypond -b eps <file>
593 or remove the lilypond-book specific settings from the input.