2 ;; framework-ps.scm -- structure for PostScript output
4 ;; source file of the GNU LilyPond music typesetter
6 ;; (c) 2004--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
8 (define-module (scm framework-ps))
10 ;;; this is still too big a mess.
12 (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\n"
151 (string-join (map ly:number->string bbox) " ") "\n"
153 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
156 (supplies-or-needs paper load-fonts?)
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"
165 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
168 "%%DocumentPaperSizes: "
169 (ly:output-def-lookup paper 'papersizename) "\n"
170 (supplies-or-needs paper load-fonts?)
173 (define (procset file-name)
176 "%%BeginResource: procset (~a) 1 0
180 file-name (cached-file-contents file-name))))
182 (define (setup paper)
187 (output-variables paper)
190 (define-public (munge-lily-font-name name)
191 (regexp-substitute/global #f "([eE]mmentaler|[aA]ybabtu)"
192 name 'pre "PFA" 1 'post))
194 (define (cff-font? font)
196 ((cff-string (ly:otf-font-table-data font "CFF ")))
197 (> (string-length cff-string) 0)))
199 (define-public (ps-embed-cff body font-set-name version)
202 (format "/~a ~s StartData " font-set-name (string-length body))
207 "%%BeginResource: font ~a
208 %!PS-Adobe-3.0 Resource-FontSet
209 %%DocumentNeededResources: ProcSet (FontSetInit)
210 %%Title: (FontSet/~a)
213 %%IncludeResource: ProcSet (FontSetInit)
214 %%BeginResource: FontSet (~a)
215 /FontSetInit /ProcSet findresource begin
216 %%BeginData: ~s Binary Bytes
218 font-set-name font-set-name version font-set-name
219 (string-length binary-data)))
231 (define (write-preamble paper load-fonts? port)
233 (define (load-font-via-GS font-name-filename)
234 (define (ps-load-file name)
237 "(~a) (r) file .loadfont\n"
238 "% fontfile ~a could not be found\n")
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)))
247 (munge-lily-font-name name)
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)))
255 (ly:warning (_ "don't know how to embed ~S=~S") name file-name)
258 ;; ugh. posix /windows/mingw?
259 (define (path-join a b)
262 (string-append a "/" b)))
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) '())))
270 (define (handle-mac-font name filename)
278 (mkdir dir-name #o700)
280 (set! status (ly:system
281 (format "cd ~a && fondu -force '~a'" dir-name filename)))
283 (set! files (dir-listing dir-name))
288 (string-match (string-append name "\\.") f))
290 (font-file-as-ps-string name (path-join dir-name f))))
292 (if (or (equal? "." f)
295 (delete-file (path-join dir-name f))))
301 (set! embed "% failed \n")
302 (ly:warn (_ "Couldn't extract file matching ~a from ~a") name filename)))
305 (define (font-file-as-ps-string name file-name)
307 ((and file-name (string-match "\\.pfa" file-name))
308 (cached-file-contents file-name))
309 ((and file-name (string-match "\\.pfb" file-name))
310 (ly:pfb->pfa file-name))
311 ((and file-name (string-match "\\.ttf" file-name))
312 (ly:ttf->pfa file-name))
313 ((and file-name (string-match "\\.otf" file-name))
314 (ps-embed-cff (ly:otf->cff file-name) name 0))
315 ((and file-name (string-match "\\.ttf" file-name))
316 (ly:ttf->pfa file-name))
318 (ly:warning (_ "don't know how to embed ~S=~S") name file-name)
322 (define (load-font font-name-filename)
323 (let* ((font (car font-name-filename))
324 (name (cadr font-name-filename))
325 (file-name (caddr font-name-filename))
326 (bare-file-name (ly:find-file file-name))
330 (munge-lily-font-name name)
332 ((string-match "([eE]mmentaler|[Aa]ybabtu)" file-name)
333 (cached-file-contents
334 (format "~a.pfa" (munge-lily-font-name file-name))))
336 (eq? PLATFORM 'darwin)
337 bare-file-name (string-match "\\.dfont" bare-file-name))
338 (handle-mac-font name bare-file-name))
341 (eq? PLATFORM 'darwin)
342 bare-file-name (= (stat:size (stat bare-file-name)) 0))
343 (handle-mac-font name bare-file-name))
345 ((and font (cff-font? font))
346 (ps-embed-cff (ly:otf-font-table-data font "CFF ")
350 (bare-file-name (font-file-as-ps-string name bare-file-name))
352 (ly:warning (_ "don't know how to embed font ~s ~s ~s")
353 name file-name font))))))
356 (define (load-fonts paper)
357 (let* ((fonts (ly:paper-fonts paper))
362 ((string? (ly:font-file-name font))
366 (ly:font-file-name font))))
367 ((ly:pango-font? font)
369 (lambda (name-psname-pair)
371 (car name-psname-pair)
372 (cdr name-psname-pair)))
373 (ly:pango-font-physical-fonts font)))
376 (ly:font-sub-fonts font))))
381 (sort (apply append all-font-names)
382 (lambda (x y) (string<? (cadr x) (cadr y))))))
385 (font-loader (if (ly:get-option 'gs-font-load)
389 (pfas (map font-loader font-names)))
395 (format port "\n%%BeginFont: ~a\n" (car f))
396 (display (cdr f) port)
397 (display "\n%%EndFont\n" port))
400 (display (setup paper) port)
402 ;; adobe note 5002: should initialize variables before loading routines.
403 (display (procset "music-drawing-routines.ps") port)
404 (display (procset "lilyponddefs.ps") port)
405 (display "init-lilypond-parameters\n" port))
407 (define-public (output-framework basename book scopes fields)
408 (let* ((filename (format "~a.ps" basename))
409 (outputter (ly:make-paper-outputter filename "ps"))
410 (paper (ly:paper-book-paper book))
411 (pages (ly:paper-book-pages book))
412 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
413 (page-number (1- (ly:output-def-lookup paper 'firstpagenumber)))
414 (page-count (length pages))
415 (port (ly:outputter-port outputter)))
417 (output-scopes scopes fields basename)
418 (display (page-header paper page-count #t) port)
419 (write-preamble paper #t port)
423 (set! page-number (1+ page-number))
424 (dump-page outputter page page-number page-count landscape?))
427 (display "%%Trailer\n%%EOF\n" port)
428 (ly:outputter-close outputter)
429 (postprocess-output book framework-ps-module filename
430 (ly:output-formats))))
432 (if (not (defined? 'nan?))
433 (define (nan? x) #f))
435 (if (not (defined? 'inf?))
436 (define (inf? x) #f))
438 (define-public (dump-stencil-as-EPS paper dump-me filename load-fonts?)
439 (define (mm-to-bp-box mmbox)
440 (let* ((scale (ly:output-def-lookup paper 'outputscale))
444 (round (* x scale mm-to-bigpoint)))) mmbox)))
446 (list (car box) (cadr box)
447 (max (1+ (car box)) (caddr box))
448 (max (1+ (cadr box)) (cadddr box)))))
450 (let* ((outputter (ly:make-paper-outputter (format "~a.eps" filename) "ps"))
451 (port (ly:outputter-port outputter))
452 (xext (ly:stencil-extent dump-me X))
453 (yext (ly:stencil-extent dump-me Y))
457 (if (or (nan? x) (inf? x)
459 (equal? (format #f "~S" x) "+#.#")
460 (equal? (format #f "~S" x) "-#.#"))
462 (list (car xext) (car yext) (cdr xext) (cdr yext))))
463 (rounded-bbox (mm-to-bp-box bbox))
464 (port (ly:outputter-port outputter))
465 (header (eps-header paper rounded-bbox load-fonts?)))
467 (display header port)
468 (write-preamble paper load-fonts? port)
469 (display "start-system { set-ps-scale-to-lily-scale \n" port)
470 (ly:outputter-dump-stencil outputter dump-me)
471 (display "} stop-system\n%%Trailer\n%%EOF\n" port)
472 (ly:outputter-close outputter)))
474 (define-public (output-preview-framework basename book scopes fields)
475 (let* ((paper (ly:paper-book-paper book))
476 (systems (ly:paper-book-systems book))
477 (scale (ly:output-def-lookup paper 'outputscale))
478 (to-dump-systems '()))
483 (ly:get-option 'preview-include-book-title))
484 (< 1 (length systems))
485 (ly:paper-system-title? (list-ref systems 0))
486 (ly:paper-system-title? (list-ref systems 1)))
487 (set! systems (cdr systems)))
492 (ly:paper-system-title? sys)
493 (not (pair? to-dump-systems))
494 (ly:paper-system-title? (car to-dump-systems)))
495 (set! to-dump-systems (cons sys to-dump-systems))))
500 (stack-stencils Y DOWN 0.0
501 (map ly:paper-system-stencil (reverse to-dump-systems)))
502 (format "~a.preview" basename)
505 (postprocess-output book framework-ps-module
506 (format "~a.preview.eps" basename)
507 (cons "png" (ly:output-formats)))))
509 (define-public (output-preview-framework basename book scopes fields)
511 (let* ((paper (ly:paper-book-paper book))
512 (systems (ly:paper-book-systems book))
513 (scale (ly:output-def-lookup paper 'outputscale))
514 (titles (take-while ly:paper-system-title? systems))
515 (non-title (find (lambda (x)
516 (not (ly:paper-system-title? x))) systems))
518 (stack-stencils Y DOWN 0.0
519 (map ly:paper-system-stencil
520 (append titles (list non-title))))))
521 (output-scopes scopes fields basename)
522 (dump-stencil-as-EPS paper dump-me
523 (format "~a.preview" basename)
526 (postprocess-output book framework-ps-module
527 (format "~a.preview.eps" basename)
528 (ly:output-formats)))))
529 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
531 (define-public (convert-to-pdf book name)
532 (let* ((defs (ly:paper-book-paper book))
533 (papersizename (ly:output-def-lookup defs 'papersizename)))
535 (if (equal? (basename name ".ps") "-")
536 (ly:warning (_ "can't convert <stdout> to ~S" "PDF"))
537 (postscript->pdf (if (string? papersizename) papersizename "a4")
540 (define-public (convert-to-png book name)
541 (let* ((defs (ly:paper-book-paper book))
542 (defs-resolution (ly:output-def-lookup defs 'pngresolution))
543 (resolution (if (number? defs-resolution)
545 (ly:get-option 'resolution)))
546 (papersizename (ly:output-def-lookup defs 'papersizename)))
548 (postscript->png resolution
549 (if (string? papersizename) papersizename "a4")
552 (define-public (convert-to-dvi book name)
553 (ly:warning (_ "can't generate ~S using the postscript back-end") "DVI"))
555 (define-public (convert-to-tex book name)
556 (ly:warning (_ "can't generate ~S using the postscript back-end") "TeX"))
558 (define-public (convert-to-ps book name)