1 ;;;; framework-ps.scm --
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 2004--2005 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)
19 (define framework-ps-module (current-module))
21 ;;(define pdebug stderr)
22 (define (pdebug . rest) #f)
24 (define mm-to-bigpoint
27 (define-public (ps-font-command font)
28 (let* ((name (munge-lily-font-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 " findfont "
46 (ly:number->string scaling) " output-scale div scalefont } bind def\n"))
48 (define (standard-tex-font? x)
49 (or (equal? (substring x 0 2) "ms")
50 (equal? (substring x 0 2) "cm")))
52 (define (font-load-command font)
53 (let* ((specced-font-name (ly:font-name font))
54 (fontname (if specced-font-name
55 (munge-lily-font-name specced-font-name)
56 (ly:font-file-name font)))
57 (command (ps-font-command font))
59 ;; FIXME -- see (ps-font-command )
60 (plain (ps-font-command font))
61 (designsize (ly:font-design-size font))
62 (magnification (* (ly:font-magnification font)))
63 (ops (ly:output-def-lookup paper 'outputscale))
64 (scaling (* ops magnification designsize)))
66 ;; Bluesky pfbs have UPCASE names (sigh.)
67 ;; FIXME - don't support Bluesky?
68 (if (standard-tex-font? fontname)
69 (set! fontname (string-upcase fontname)))
70 (if (equal? fontname "unknown")
71 (display (list font fontname)))
72 (define-font plain fontname scaling)))
75 (map (lambda (x) (font-load-command x))
76 (filter (lambda (x) (not (ly:pango-font? x)))
79 ;; FIXME: duplicated in other output backends
80 ;; FIXME: silly interface name
81 (define (output-variables layout)
82 ;; FIXME: duplicates output-layout's scope-entry->string, mostly
83 (define (value->string val)
85 ((string? val) (string-append "(" val ")"))
86 ((symbol? val) (symbol->string val))
87 ((number? val) (number->string val))
90 (define (output-entry ps-key ly-key)
93 (value->string (ly:output-def-lookup layout ly-key)) " def\n"))
97 (number->string mm-to-bigpoint)
98 " def %% millimeter\n"
99 (output-entry "staff-line-thickness" 'linethickness)
100 (output-entry "line-width" 'linewidth)
101 (output-entry "paper-size" 'papersizename)
102 (output-entry "staff-height" 'staffheight) ;junkme.
104 (number->string (ly:output-def-lookup layout 'outputscale))
106 (output-entry "page-height" 'vsize)
107 (output-entry "page-width" 'hsize)))
109 (define (dump-page outputter page page-number page-count landscape?)
110 (ly:outputter-dump-string
114 (number->string page-number) " " (number->string page-count) "\n"
118 "page-width output-scale lily-output-units mul mul 0 translate 90 rotate\n"
123 "set-ps-scale-to-lily-scale "
125 (ly:outputter-dump-stencil outputter page)
126 (ly:outputter-dump-string outputter "} stop-system \nshowpage\n"))
128 (define (supplies-or-needs paper load-fonts?)
129 (define (extract-names font)
130 (if (ly:pango-font? font)
131 (map car (ly:pango-font-physical-fonts font))
132 (list (munge-lily-font-name (ly:font-name font)))))
134 (let* ((fonts (ly:paper-fonts paper))
135 (names (apply append (map extract-names fonts))))
141 "%%DocumentSuppliedResources: font ~a\n"
142 "%%DocumentNeededResources: font ~a\n")
144 (uniq-list (sort names string<?))))))
146 (define (eps-header paper bbox load-fonts?)
147 (string-append "%!PS-Adobe-2.0 EPSF-2.0\n"
148 "%%Creator: LilyPond\n"
150 (string-join (map ly:number->string bbox) " ") "\n"
152 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
155 (supplies-or-needs paper load-fonts?)
158 (define (page-header paper page-count load-fonts?)
159 (string-append "%!PS-Adobe-3.0\n"
160 "%%Creator: LilyPond\n"
161 "%%Pages: " (number->string page-count) "\n"
162 "%%PageOrder: Ascend\n"
164 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
167 "%%DocumentPaperSizes: "
168 (ly:output-def-lookup paper 'papersizename) "\n"
169 (supplies-or-needs paper load-fonts?)
172 (define (procset file-name)
175 "%%BeginResource: procset (~a) 1 0
179 file-name (cached-file-contents file-name))))
181 (define (setup paper)
186 (output-variables paper)
189 (define-public (munge-lily-font-name name)
190 (regexp-substitute/global #f "([eE]mmentaler|[aA]ybabtu)"
191 name 'pre "PFA" 1 'post))
193 (define (cff-font? font)
195 ((cff-string (ly:otf-font-table-data font "CFF ")))
196 (> (string-length cff-string) 0)))
198 (define-public (ps-embed-cff body font-set-name version)
201 (format "/~a ~s StartData " font-set-name (string-length body))
206 "%%BeginResource: font ~a
207 %!PS-Adobe-3.0 Resource-FontSet
208 %%DocumentNeededResources: ProcSet (FontSetInit)
209 %%Title: (FontSet/~a)
212 %%IncludeResource: ProcSet (FontSetInit)
213 %%BeginResource: FontSet (~a)
214 /FontSetInit /ProcSet findresource begin
215 %%BeginData: ~s Binary Bytes
217 font-set-name font-set-name version font-set-name
218 (string-length binary-data)))
230 (define (write-preamble paper load-fonts? port)
232 (define (load-font-via-GS font-name-filename)
233 (define (ps-load-file name)
236 "(~a) (r) file .loadfont\n"
237 "% fontfile ~a could not be found\n")
240 (let* ((font (car font-name-filename))
241 (name (cadr font-name-filename))
242 (file-name (caddr font-name-filename))
243 (bare-file-name (ly:find-file file-name)))
246 (munge-lily-font-name name)
248 ((string-match "([eE]mmentaler|[Aa]ybabtu)" file-name)
249 (ps-load-file (ly:find-file
250 (format "~a.pfa" (munge-lily-font-name file-name)))))
251 ((string? bare-file-name)
252 (ps-load-file (munge-lily-font-name file-name)))
254 (ly:warning (_ "don't know how to embed ~S=~S") name file-name)
257 ;; ugh. posix /windows/mingw?
258 (define (path-join a b)
261 (string-append a "/" b)))
263 (define (dir-listing dir-name)
264 (define (dir-helper dir lst)
265 (let ((e (readdir dir)))
266 (if (eof-object? e) lst (dir-helper dir (cons e lst)))))
267 (reverse (dir-helper (opendir dir-name) '())))
269 (define (handle-mac-font name filename)
277 (display (list filename name))
278 (mkdir dir-name #o700)
281 (format "cd ~a && fondu -force ~a" dir-name filename)))
284 (ly:error "Fondu failed."))
286 (set! files (dir-listing dir-name))
290 (if (string-match (string-append name "\\.") f)
292 (font-file-as-ps-string name (path-join dir-name f))))
294 (if (or (equal? "." f)
297 (delete-file (path-join dir-name f))))
302 (define (font-file-as-ps-string name file-name)
304 ((and file-name (string-match "\\.pfa" file-name))
305 (cached-file-contents file-name))
306 ((and file-name (string-match "\\.pfb" file-name))
307 (ly:pfb->pfa file-name))
308 ((and file-name (string-match "\\.ttf" file-name))
309 (ly:ttf->pfa file-name))
310 ((and file-name (string-match "\\.otf" file-name))
311 (ps-embed-cff (ly:otf->cff file-name) name 0))
312 ((and file-name (string-match "\\.ttf" file-name))
313 (ly:ttf->pfa file-name))
315 (ly:warning (_ "don't know how to embed ~S=~S") name file-name)
319 (define (load-font font-name-filename)
320 (let* ((font (car font-name-filename))
321 (name (cadr font-name-filename))
322 (file-name (caddr font-name-filename))
323 (bare-file-name (ly:find-file file-name))
327 (munge-lily-font-name name)
329 ((string-match "([eE]mmentaler|[Aa]ybabtu)" file-name)
330 (cached-file-contents
331 (format "~a.pfa" (munge-lily-font-name file-name))))
333 (eq? PLATFORM 'darwin)
334 bare-file-name (string-match "\\.dfont" bare-file-name))
335 (handle-mac-font name bare-file-name))
338 (eq? PLATFORM 'darwin)
339 bare-file-name (= (stat:size (stat bare-file-name)) 0))
340 (handle-mac-font name bare-file-name))
342 ((and font (cff-font? font))
343 (ps-embed-cff (ly:otf-font-table-data font "CFF ")
347 (bare-file-name (font-file-as-ps-string name bare-file-name))
349 (ly:warning (_ "don't know how to embed font ~s ~s ~s")
350 name file-name font))))))
353 (define (load-fonts paper)
354 (let* ((fonts (ly:paper-fonts paper))
359 ((string? (ly:font-file-name font))
363 (ly:font-file-name font))))
364 ((ly:pango-font? font)
366 (lambda (name-psname-pair)
368 (car name-psname-pair)
369 (cdr name-psname-pair)))
370 (ly:pango-font-physical-fonts font)))
373 (ly:font-sub-fonts font))))
378 (sort (apply append all-font-names)
379 (lambda (x y) (string<? (cadr x) (cadr y))))))
382 (font-loader (if (assoc 'gs-font-load
383 (ly:get-option 'command-line-settings))
387 (pfas (map font-loader font-names)))
393 (format port "\n%%BeginFont: ~a\n" (car f))
394 (display (cdr f) port)
395 (display "\n%%EndFont\n" port))
398 (display (setup paper) port)
400 ;; adobe note 5002: should initialize variables before loading routines.
401 (display (procset "music-drawing-routines.ps") port)
402 (display (procset "lilyponddefs.ps") port)
403 (display "init-lilypond-parameters\n" port))
405 (define-public (output-framework basename book scopes fields)
406 (let* ((filename (format "~a.ps" basename))
407 (outputter (ly:make-paper-outputter filename "ps"))
408 (paper (ly:paper-book-paper book))
409 (pages (ly:paper-book-pages book))
410 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
411 (page-number (1- (ly:output-def-lookup paper 'firstpagenumber)))
412 (page-count (length pages))
413 (port (ly:outputter-port outputter)))
415 (output-scopes scopes fields basename)
416 (display (page-header paper page-count #t) port)
417 (write-preamble paper #t port)
421 (set! page-number (1+ page-number))
422 (dump-page outputter page page-number page-count landscape?))
425 (display "%%Trailer\n%%EOF\n" port)
426 (ly:outputter-close outputter)
427 (postprocess-output book framework-ps-module filename
428 (completize-formats (ly:output-formats)))))
430 (if (not (defined? 'nan?))
431 (define (nan? x) #f))
433 (if (not (defined? 'inf?))
434 (define (inf? x) #f))
436 (define-public (dump-stencil-as-EPS paper dump-me filename load-fonts?)
437 (define (mm-to-bp-box mmbox)
438 (let* ((scale (ly:output-def-lookup paper 'outputscale))
442 (round (* x scale mm-to-bigpoint)))) mmbox)))
444 (list (car box) (cadr box)
445 (max (1+ (car box)) (caddr box))
446 (max (1+ (cadr box)) (cadddr box)))))
448 (let* ((outputter (ly:make-paper-outputter (format "~a.eps" filename) "ps"))
449 (port (ly:outputter-port outputter))
450 (xext (ly:stencil-extent dump-me X))
451 (yext (ly:stencil-extent dump-me Y))
455 (if (or (nan? x) (inf? x)
457 (equal? (format #f "~S" x) "+#.#")
458 (equal? (format #f "~S" x) "-#.#"))
460 (list (car xext) (car yext) (cdr xext) (cdr yext))))
461 (rounded-bbox (mm-to-bp-box bbox))
462 (port (ly:outputter-port outputter))
463 (header (eps-header paper rounded-bbox load-fonts?)))
465 (display header port)
466 (write-preamble paper load-fonts? port)
467 (display "start-system { set-ps-scale-to-lily-scale \n" port)
468 (ly:outputter-dump-stencil outputter dump-me)
469 (display "} stop-system\n%%Trailer\n%%EOF\n" port)
470 (ly:outputter-close outputter)))
472 (define-public (output-preview-framework basename book scopes fields)
473 (let* ((paper (ly:paper-book-paper book))
474 (systems (ly:paper-book-systems book))
475 (scale (ly:output-def-lookup paper 'outputscale))
476 (to-dump-systems '()))
482 'preview-include-book-title
483 (ly:get-option 'command-line-settings))))
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 (completize-formats (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 (completize-formats (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 (cdr (assoc 'resolution
546 (ly:get-option 'command-line-settings)))))
547 (papersizename (ly:output-def-lookup defs 'papersizename)))
549 (postscript->png resolution
550 (if (string? papersizename) papersizename "a4")
553 (define-public (convert-to-dvi book name)
554 (ly:warning (_ "can't generate ~S using the postscript back-end") "DVI"))
556 (define-public (convert-to-tex book name)
557 (ly:warning (_ "can't generate ~S using the postscript back-end") "TeX"))
559 (define-public (convert-to-ps book name)