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)
21 (define framework-ps-module (current-module))
23 ;;(define pdebug stderr)
24 (define (pdebug . rest) #f)
26 (define mm-to-bigpoint
29 (define-public (ps-font-command font)
30 (let* ((name (munge-lily-font-name (ly:font-file-name font)))
31 (magnify (ly:font-magnification font)))
35 (string-regexp-substitute "[ /%]" "_" name)
36 "m" (string-encode-integer (inexact->exact (round (* 1000 magnify)))))))
38 (define (tex-font? fontname)
40 (equal? (substring fontname 0 2) "cm")
41 (equal? (substring fontname 0 2) "ec")))
43 (define (define-fonts paper)
44 (define font-list (ly:paper-fonts paper))
45 (define (define-font command fontname scaling)
47 "/" command " { /" fontname " findfont "
48 (ly:number->string scaling) " output-scale div scalefont } bind def\n"))
50 (define (standard-tex-font? x)
51 (or (equal? (substring x 0 2) "ms")
52 (equal? (substring x 0 2) "cm")))
54 (define (font-load-command font)
55 (let* ((specced-font-name (ly:font-name font))
56 (fontname (if specced-font-name
57 (munge-lily-font-name specced-font-name)
58 (ly:font-file-name font)))
59 (command (ps-font-command font))
61 ;; FIXME -- see (ps-font-command )
62 (plain (ps-font-command font))
63 (designsize (ly:font-design-size font))
64 (magnification (* (ly:font-magnification font)))
65 (ops (ly:output-def-lookup paper 'outputscale))
66 (scaling (* ops magnification designsize)))
68 ;; Bluesky pfbs have UPCASE names (sigh.)
69 ;; FIXME - don't support Bluesky?
70 (if (standard-tex-font? fontname)
71 (set! fontname (string-upcase fontname)))
72 (if (equal? fontname "unknown")
73 (display (list font fontname)))
74 (define-font plain fontname scaling)))
77 (map (lambda (x) (font-load-command x))
78 (filter (lambda (x) (not (ly:pango-font? x)))
81 ;; FIXME: duplicated in other output backends
82 ;; FIXME: silly interface name
83 (define (output-variables layout)
84 ;; FIXME: duplicates output-layout's scope-entry->string, mostly
85 (define (value->string val)
87 ((string? val) (string-append "(" val ")"))
88 ((symbol? val) (symbol->string val))
89 ((number? val) (number->string val))
92 (define (output-entry ps-key ly-key)
95 (value->string (ly:output-def-lookup layout ly-key)) " def\n"))
99 (number->string mm-to-bigpoint)
100 " def %% millimeter\n"
101 (output-entry "staff-line-thickness" 'linethickness)
102 (output-entry "line-width" 'linewidth)
103 (output-entry "paper-size" 'papersizename)
104 (output-entry "staff-height" 'staffheight) ;junkme.
106 (number->string (ly:output-def-lookup layout 'outputscale))
108 (output-entry "page-height" 'vsize)
109 (output-entry "page-width" 'hsize)))
111 (define (dump-page outputter page page-number page-count landscape?)
112 (ly:outputter-dump-string
116 (number->string page-number) " " (number->string page-count) "\n"
120 "page-width output-scale lily-output-units mul mul 0 translate 90 rotate\n"
125 "set-ps-scale-to-lily-scale "
127 (ly:outputter-dump-stencil outputter page)
128 (ly:outputter-dump-string outputter "} stop-system \nshowpage\n"))
130 (define (supplies-or-needs paper load-fonts?)
131 (define (extract-names font)
132 (if (ly:pango-font? font)
133 (map car (ly:pango-font-physical-fonts font))
134 (list (munge-lily-font-name (ly:font-name font)))))
136 (let* ((fonts (ly:paper-fonts paper))
137 (names (apply append (map extract-names fonts))))
143 "%%DocumentSuppliedResources: font ~a\n"
144 "%%DocumentNeededResources: font ~a\n")
146 (uniq-list (sort names string<?))))))
148 (define (eps-header paper bbox load-fonts?)
149 (string-append "%!PS-Adobe-2.0 EPSF-2.0\n"
150 "%%Creator: LilyPond\n"
152 (string-join (map ly:number->string bbox) " ") "\n"
154 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
157 (supplies-or-needs paper load-fonts?)
160 (define (page-header paper page-count load-fonts?)
161 (string-append "%!PS-Adobe-3.0\n"
162 "%%Creator: LilyPond\n"
163 "%%Pages: " (number->string page-count) "\n"
164 "%%PageOrder: Ascend\n"
166 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
169 "%%DocumentPaperSizes: "
170 (ly:output-def-lookup paper 'papersizename) "\n"
171 (supplies-or-needs paper load-fonts?)
174 (define (procset file-name)
177 "%%BeginResource: procset (~a) 1 0
181 file-name (cached-file-contents file-name))))
183 (define (setup paper)
188 (output-variables paper)
191 (define-public (munge-lily-font-name name)
192 (regexp-substitute/global #f "([eE]mmentaler|[aA]ybabtu)"
193 name 'pre "PFA" 1 'post))
195 (define (cff-font? font)
197 ((cff-string (ly:otf-font-table-data font "CFF ")))
198 (> (string-length cff-string) 0)))
200 (define-public (ps-embed-cff body font-set-name version)
203 (format "/~a ~s StartData " font-set-name (string-length body))
208 "%%BeginResource: font ~a
209 %!PS-Adobe-3.0 Resource-FontSet
210 %%DocumentNeededResources: ProcSet (FontSetInit)
211 %%Title: (FontSet/~a)
214 %%IncludeResource: ProcSet (FontSetInit)
215 %%BeginResource: FontSet (~a)
216 /FontSetInit /ProcSet findresource begin
217 %%BeginData: ~s Binary Bytes
219 font-set-name font-set-name version font-set-name
220 (string-length binary-data)))
232 (define (write-preamble paper load-fonts? port)
234 (define (load-font-via-GS font-name-filename)
235 (define (ps-load-file name)
238 "(~a) (r) file .loadfont\n"
239 "% fontfile ~a could not be found\n")
242 (let* ((font (car font-name-filename))
243 (name (cadr font-name-filename))
244 (file-name (caddr font-name-filename))
245 (bare-file-name (ly:find-file file-name)))
248 (munge-lily-font-name name)
250 ((string-match "([eE]mmentaler|[Aa]ybabtu)" file-name)
251 (ps-load-file (ly:find-file
252 (format "~a.pfa" (munge-lily-font-name file-name)))))
253 ((string? bare-file-name)
254 (ps-load-file (munge-lily-font-name file-name)))
256 (ly:warning (_ "don't know how to embed ~S=~S") name file-name)
259 ;; ugh. posix /windows/mingw?
260 (define (path-join a b)
263 (string-append a "/" b)))
265 (define (dir-listing dir-name)
266 (define (dir-helper dir lst)
267 (let ((e (readdir dir)))
268 (if (eof-object? e) lst (dir-helper dir (cons e lst)))))
269 (reverse (dir-helper (opendir dir-name) '())))
271 (define (handle-mac-font name filename)
279 (mkdir dir-name #o700)
281 (set! status (ly:system
282 (format "cd ~a && fondu -force '~a'" dir-name filename)))
284 (set! files (dir-listing dir-name))
289 (string-match (string-append name "\\.") f))
291 (font-file-as-ps-string name (path-join dir-name f))))
293 (if (or (equal? "." f)
296 (delete-file (path-join dir-name f))))
302 (set! embed "% failed \n")
303 (ly:warn (_ "Couldn't extract file matching ~a from ~a") name filename)))
306 (define (font-file-as-ps-string name file-name)
308 ((downcase-file-name (string-downcase file-name)))
311 ((and file-name (string-match "\\.pfa" downcase-file-name))
312 (cached-file-contents file-name))
313 ((and file-name (string-match "\\.pfb" downcase-file-name))
314 (ly:pfb->pfa file-name))
315 ((and file-name (string-match "\\.ttf" downcase-file-name))
316 (ly:ttf->pfa file-name))
317 ((and file-name (string-match "\\.otf" downcase-file-name))
318 (ps-embed-cff (ly:otf->cff file-name) name 0))
320 (ly:warning (_ "don't know how to embed ~S=~S") name file-name)
324 (define (load-font font-name-filename)
325 (let* ((font (car font-name-filename))
326 (name (cadr font-name-filename))
327 (file-name (caddr font-name-filename))
328 (bare-file-name (ly:find-file file-name))
332 (munge-lily-font-name name)
334 ((string-match "([eE]mmentaler|[Aa]ybabtu)" file-name)
335 (cached-file-contents
336 (format "~a.pfa" (munge-lily-font-name file-name))))
338 (eq? PLATFORM 'darwin)
339 bare-file-name (string-match "\\.dfont" bare-file-name))
340 (handle-mac-font name bare-file-name))
343 (eq? PLATFORM 'darwin)
344 bare-file-name (= (stat:size (stat bare-file-name)) 0))
345 (handle-mac-font name bare-file-name))
347 ((and font (cff-font? font))
348 (ps-embed-cff (ly:otf-font-table-data font "CFF ")
352 (bare-file-name (font-file-as-ps-string name bare-file-name))
354 (ly:warning (_ "don't know how to embed font ~s ~s ~s")
355 name file-name font))))))
358 (define (load-fonts paper)
359 (let* ((fonts (ly:paper-fonts paper))
364 ((string? (ly:font-file-name font))
368 (ly:font-file-name font))))
369 ((ly:pango-font? font)
371 (lambda (name-psname-pair)
373 (car name-psname-pair)
374 (cdr name-psname-pair)))
375 (ly:pango-font-physical-fonts font)))
378 (ly:font-sub-fonts font))))
383 (sort (apply append all-font-names)
384 (lambda (x y) (string<? (cadr x) (cadr y))))))
387 (font-loader (if (ly:get-option 'gs-font-load)
391 (pfas (map font-loader font-names)))
397 (format port "\n%%BeginFont: ~a\n" (car f))
398 (display (cdr f) port)
399 (display "\n%%EndFont\n" port))
402 (display (setup paper) port)
404 ;; adobe note 5002: should initialize variables before loading routines.
405 (display (procset "music-drawing-routines.ps") port)
406 (display (procset "lilyponddefs.ps") port)
407 (display "init-lilypond-parameters\n" port))
409 (define-public (output-framework basename book scopes fields)
410 (let* ((filename (format "~a.ps" basename))
411 (outputter (ly:make-paper-outputter filename "ps"))
412 (paper (ly:paper-book-paper book))
413 (pages (ly:paper-book-pages book))
414 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
415 (page-number (1- (ly:output-def-lookup paper 'firstpagenumber)))
416 (page-count (length pages))
417 (port (ly:outputter-port outputter)))
419 (output-scopes scopes fields basename)
420 (display (page-header paper page-count #t) port)
421 (write-preamble paper #t port)
425 (set! page-number (1+ page-number))
426 (dump-page outputter page page-number page-count landscape?))
429 (display "%%Trailer\n%%EOF\n" port)
430 (ly:outputter-close outputter)
431 (postprocess-output book framework-ps-module filename
432 (ly:output-formats))))
434 (if (not (defined? 'nan?))
435 (define (nan? x) #f))
437 (if (not (defined? 'inf?))
438 (define (inf? x) #f))
440 (define-public (dump-stencil-as-EPS paper dump-me filename load-fonts?)
441 (define (mm-to-bp-box mmbox)
442 (let* ((scale (ly:output-def-lookup paper 'outputscale))
446 (round (* x scale mm-to-bigpoint)))) mmbox)))
448 (list (car box) (cadr box)
449 (max (1+ (car box)) (caddr box))
450 (max (1+ (cadr box)) (cadddr box)))))
452 (let* ((outputter (ly:make-paper-outputter (format "~a.eps" filename) "ps"))
453 (port (ly:outputter-port outputter))
454 (xext (ly:stencil-extent dump-me X))
455 (yext (ly:stencil-extent dump-me Y))
459 (if (or (nan? x) (inf? x)
461 (equal? (format #f "~S" x) "+#.#")
462 (equal? (format #f "~S" x) "-#.#"))
464 (list (car xext) (car yext) (cdr xext) (cdr yext))))
465 (rounded-bbox (mm-to-bp-box bbox))
466 (port (ly:outputter-port outputter))
467 (header (eps-header paper rounded-bbox load-fonts?)))
469 (display header port)
470 (write-preamble paper load-fonts? port)
471 (display "start-system { set-ps-scale-to-lily-scale \n" port)
472 (ly:outputter-dump-stencil outputter dump-me)
473 (display "} stop-system\n%%Trailer\n%%EOF\n" port)
474 (ly:outputter-close outputter)))
476 (define-public (output-preview-framework basename book scopes fields)
477 (let* ((paper (ly:paper-book-paper book))
478 (systems (ly:paper-book-systems book))
479 (scale (ly:output-def-lookup paper 'outputscale))
480 (to-dump-systems '()))
485 (ly:get-option 'preview-include-book-title))
486 (< 1 (length systems))
487 (ly:paper-system-title? (list-ref systems 0))
488 (ly:paper-system-title? (list-ref systems 1)))
489 (set! systems (cdr systems)))
494 (ly:paper-system-title? sys)
495 (not (pair? to-dump-systems))
496 (ly:paper-system-title? (car to-dump-systems)))
497 (set! to-dump-systems (cons sys to-dump-systems))))
502 (stack-stencils Y DOWN 0.0
503 (map ly:paper-system-stencil (reverse to-dump-systems)))
504 (format "~a.preview" basename)
507 (postprocess-output book framework-ps-module
508 (format "~a.preview.eps" basename)
509 (cons "png" (ly:output-formats)))))
511 (define-public (output-preview-framework basename book scopes fields)
513 (let* ((paper (ly:paper-book-paper book))
514 (systems (ly:paper-book-systems book))
515 (scale (ly:output-def-lookup paper 'outputscale))
516 (titles (take-while ly:paper-system-title? systems))
517 (non-title (find (lambda (x)
518 (not (ly:paper-system-title? x))) systems))
520 (stack-stencils Y DOWN 0.0
521 (map ly:paper-system-stencil
522 (append titles (list non-title))))))
523 (output-scopes scopes fields basename)
524 (dump-stencil-as-EPS paper dump-me
525 (format "~a.preview" basename)
528 (postprocess-output book framework-ps-module
529 (format "~a.preview.eps" basename)
530 (ly:output-formats)))))
531 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
533 (define-public (convert-to-pdf book name)
534 (let* ((defs (ly:paper-book-paper book))
535 (papersizename (ly:output-def-lookup defs 'papersizename)))
537 (if (equal? (basename name ".ps") "-")
538 (ly:warning (_ "can't convert <stdout> to ~S" "PDF"))
539 (postscript->pdf (if (string? papersizename) papersizename "a4")
542 (define-public (convert-to-png book name)
543 (let* ((defs (ly:paper-book-paper book))
544 (defs-resolution (ly:output-def-lookup defs 'pngresolution))
545 (resolution (if (number? defs-resolution)
547 (ly:get-option 'resolution)))
548 (papersizename (ly:output-def-lookup defs 'papersizename)))
550 (postscript->png resolution
551 (if (string? papersizename) papersizename "a4")
554 (define-public (convert-to-dvi book name)
555 (ly:warning (_ "can't generate ~S using the postscript back-end") "DVI"))
557 (define-public (convert-to-tex book name)
558 (ly:warning (_ "can't generate ~S using the postscript back-end") "TeX"))
560 (define-public (convert-to-ps book name)
563 (define-public (output-classic-framework basename book scopes fields)
565 (ly:error (_ "\nThe PostScript backend does not support the 'classic'
566 framework. Use the EPS backend instead,
568 lilypond -b eps <file>
570 or remove the lilypond-book specific settings from the input.