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-public (ps-font-command font)
28 (let* ((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
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 'output-scale))
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 (/ (ly:bp 1)))
98 " def %% millimeter\n"
99 (output-entry "staff-line-thickness" 'line-thickness)
100 (output-entry "line-width" 'line-width)
101 (output-entry "paper-size" 'papersizename)
102 (output-entry "staff-height" 'staff-height) ;junkme.
104 (number->string (ly:output-def-lookup layout 'output-scale))
106 (output-entry "page-height" 'paper-height)
107 (output-entry "page-width" 'paper-width)))
109 (define (dump-page outputter page page-number page-count landscape?)
110 (ly:outputter-dump-string
113 (format "%%Page: ~a ~a\n" page-number page-number)
116 "page-width output-scale lily-output-units mul mul 0 translate 90 rotate\n"
120 "gsave 0 paper-height translate "
121 "set-ps-scale-to-lily-scale "
123 (ly:outputter-dump-stencil outputter page)
124 (ly:outputter-dump-string outputter "stroke grestore \nshowpage\n"))
126 (define (supplies-or-needs paper load-fonts?)
127 (define (extract-names font)
128 (if (ly:pango-font? font)
129 (map car (ly:pango-font-physical-fonts font))
130 (list (ly:font-name font))))
132 (let* ((fonts (ly:paper-fonts paper))
133 (names (apply append (map extract-names fonts))))
139 "%%DocumentSuppliedResources: font ~a\n"
140 "%%DocumentNeededResources: font ~a\n")
142 (uniq-list (sort names string<?))))))
144 (define (eps-header paper bbox load-fonts?)
145 (string-append "%!PS-Adobe-2.0 EPSF-2.0\n"
146 "%%Creator: LilyPond "
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 (ps-document-media paper)
160 (ly:output-def-lookup paper 'output-scale)
161 (ly:output-def-lookup paper 'paper-width)) (ly:bp 1)))
163 (ly:output-def-lookup paper 'paper-height)
164 (ly:output-def-lookup paper 'output-scale))
166 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t)))
167 (format "%%DocumentMedia: ~a ~$ ~$ ~a ~a ~a\n"
168 (ly:output-def-lookup paper 'papersizename)
177 (define (file-header paper page-count load-fonts?)
178 (string-append "%!PS-Adobe-3.0\n"
179 "%%Creator: LilyPond "
183 "%%Pages: " (number->string page-count) "\n"
184 "%%PageOrder: Ascend\n"
186 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
189 (ps-document-media paper)
190 (supplies-or-needs paper load-fonts?)
193 (define (procset file-name)
195 "%%BeginResource: procset (~a) 1 0
199 file-name (cached-file-contents file-name)))
201 (define (embed-document file-name)
202 (format "%%BeginDocument: ~a
206 file-name (cached-file-contents file-name)))
208 (define (setup-variables paper)
212 (output-variables paper)
215 (define (cff-font? font)
217 ((cff-string (ly:otf-font-table-data font "CFF ")))
218 (> (string-length cff-string) 0)))
220 (define-public (ps-embed-cff body font-set-name version)
223 (format "/~a ~s StartData " font-set-name (string-length body))
228 "%%BeginResource: font ~a
229 %!PS-Adobe-3.0 Resource-FontSet
230 %%DocumentNeededResources: ProcSet (FontSetInit)
231 %%Title: (FontSet/~a)
234 %%IncludeResource: ProcSet (FontSetInit)
235 %%BeginResource: FontSet (~a)
236 /FontSetInit /ProcSet findresource begin
237 %%BeginData: ~s Binary Bytes
239 font-set-name font-set-name version font-set-name
240 (string-length binary-data)))
251 (define (write-preamble paper load-fonts? port)
253 (define (load-font-via-GS font-name-filename)
254 (define (ps-load-file name)
257 "(~a) (r) file .loadfont\n"
258 "% can't find font file: ~a\n")
261 (let* ((font (car font-name-filename))
262 (name (cadr font-name-filename))
263 (file-name (caddr font-name-filename))
264 (bare-file-name (ly:find-file file-name)))
269 ((string-match "^([eE]mmentaler|[Aa]ybabtu)" file-name)
270 (ps-load-file (ly:find-file
271 (format "~a.otf" file-name))))
272 ((string? bare-file-name)
273 (ps-load-file file-name))
275 (ly:warning (_ "can't embed ~S=~S") name file-name)
278 (define (dir-join a b)
281 (string-append a "/" b)))
283 (define (dir-listing dir-name)
284 (define (dir-helper dir lst)
285 (let ((e (readdir dir)))
286 (if (eof-object? e) lst (dir-helper dir (cons e lst)))))
287 (reverse (dir-helper (opendir dir-name) '())))
289 (define (handle-mac-font name filename)
296 (mkdir dir-name #o700)
297 (set! status (ly:system
298 (format "cd ~a && fondu -force '~a'" dir-name filename)))
300 (set! files (dir-listing dir-name))
305 ((full-name (dir-join dir-name f)))
308 (equal? 'regular (stat:type (stat full-name)))
309 (equal? name (ly:ttf-ps-name full-name)))
312 (font-file-as-ps-string name full-name)))
314 (if (or (equal? "." f)
317 (delete-file full-name))))
325 (set! embed "% failed \n")
326 (ly:warning (_ "can't extract file matching ~a from ~a") name filename)))
329 (define (font-file-as-ps-string name file-name)
331 ((downcase-file-name (string-downcase file-name)))
334 ((and file-name (string-match "\\.pfa" downcase-file-name))
335 (embed-document file-name))
336 ((and file-name (string-match "\\.pfb" downcase-file-name))
337 (ly:pfb->pfa file-name))
338 ((and file-name (string-match "\\.ttf" downcase-file-name))
339 (ly:ttf->pfa file-name))
340 ((and file-name (string-match "\\.otf" downcase-file-name))
341 (ps-embed-cff (ly:otf->cff file-name) name 0))
343 (ly:warning (_ "don't know how to embed ~S=~S") name file-name)
346 (define (load-font font-name-filename)
347 (let* ((font (car font-name-filename))
348 (name (cadr font-name-filename))
349 (file-name (caddr font-name-filename))
350 (bare-file-name (ly:find-file file-name)))
357 (eq? PLATFORM 'darwin)
358 bare-file-name (string-match "\\.dfont" bare-file-name))
359 (handle-mac-font name bare-file-name))
362 (eq? PLATFORM 'darwin)
363 bare-file-name (= (stat:size (stat bare-file-name)) 0))
364 (handle-mac-font name bare-file-name))
366 ((and font (cff-font? font))
367 (ps-embed-cff (ly:otf-font-table-data font "CFF ")
371 (bare-file-name (font-file-as-ps-string name bare-file-name))
373 (ly:warning (_ "don't know how to embed font ~s ~s ~s")
374 name file-name font))))))
377 (define (load-fonts paper)
378 (let* ((fonts (ly:paper-fonts paper))
383 ((string? (ly:font-file-name font))
387 (ly:font-file-name font))))
388 ((ly:pango-font? font)
390 (lambda (name-psname-pair)
392 (car name-psname-pair)
393 (cdr name-psname-pair)))
394 (ly:pango-font-physical-fonts font)))
397 (ly:font-sub-fonts font))))
402 (sort (apply append all-font-names)
403 (lambda (x y) (string<? (cadr x) (cadr y))))))
406 (font-loader (if (ly:get-option 'gs-font-load)
410 (pfas (map font-loader font-names)))
413 (display "%%BeginProlog\n" port)
417 (format port "\n%%BeginFont: ~a\n" (car f))
418 (display (cdr f) port)
419 (display "\n%%EndFont\n" port))
422 (display (setup-variables paper) port)
424 ;; adobe note 5002: should initialize variables before loading routines.
425 (display (procset "music-drawing-routines.ps") port)
426 (display (procset "lilyponddefs.ps") port)
428 (display "%%EndProlog\n" port)
430 (display "%%BeginSetup\ninit-lilypond-parameters\n%%EndSetup\n\n" port))
432 (define-public (output-framework basename book scopes fields)
433 (let* ((filename (format "~a.ps" basename))
434 (outputter (ly:make-paper-outputter
435 ;; FIXME: better wrap open/open-file,
436 ;; content-mangling is always bad.
437 ;; MINGW hack: need to have "b"inary for embedding CFFs
438 (open-file filename "wb")
440 (paper (ly:paper-book-paper book))
441 (page-stencils (map page-stencil (ly:paper-book-pages book)))
443 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
444 (page-number (1- (ly:output-def-lookup paper 'first-page-number)))
445 (page-count (length page-stencils))
446 (port (ly:outputter-port outputter)))
448 (output-scopes scopes fields basename)
449 (display (file-header paper page-count #t) port)
450 (display "\n%%BeginDefaults
452 %%EndDefaults\n" port)
454 (write-preamble paper #t port)
458 (set! page-number (1+ page-number))
459 (dump-page outputter page page-number page-count landscape?))
462 (display "%%Trailer\n%%EOF\n" port)
463 (ly:outputter-close outputter)
464 (postprocess-output book framework-ps-module filename
465 (ly:output-formats))))
467 (define-public (dump-stencil-as-EPS paper dump-me filename load-fonts?)
468 (define (to-bp-box mmbox)
469 (let* ((scale (ly:output-def-lookup paper 'output-scale))
473 (round (/ (* x scale) (ly:bp 1))))) mmbox)))
477 (max (1+ (car box)) (caddr box))
478 (max (1+ (cadr box)) (cadddr box))
481 (let* ((outputter (ly:make-paper-outputter
482 ;; FIXME: better wrap open/open-file,
483 ;; content-mangling is always bad.
484 ;; MINGW hack: need to have "b"inary for embedding CFFs
485 (open-file (format "~a.eps" filename) "wb")
489 (port (ly:outputter-port outputter))
490 (xext (ly:stencil-extent dump-me X))
491 (yext (ly:stencil-extent dump-me Y))
495 (if (or (nan? x) (inf? x)
497 (equal? (format #f "~S" x) "+#.#")
498 (equal? (format #f "~S" x) "-#.#"))
501 ;; the left-overshoot is to make sure that
502 ;; bar numbers stick out of margin uniformly.
504 (list (min left-overshoot (car xext))
505 (car yext) (cdr xext) (cdr yext))))
506 (rounded-bbox (to-bp-box bbox))
507 (port (ly:outputter-port outputter))
508 (header (eps-header paper rounded-bbox load-fonts?)))
510 (display header port)
511 (write-preamble paper load-fonts? port)
512 (display "gsave set-ps-scale-to-lily-scale \n" port)
513 (ly:outputter-dump-stencil outputter dump-me)
514 (display "stroke grestore\n%%Trailer\n%%EOF\n" port)
515 (ly:outputter-close outputter)))
517 (define-public (output-preview-framework basename book scopes fields)
518 (let* ((paper (ly:paper-book-paper book))
519 (systems (ly:paper-book-systems book))
520 (scale (ly:output-def-lookup paper 'output-scale))
521 (to-dump-systems '()))
525 (not (ly:get-option 'preview-include-book-title))
527 (ly:prob-property (car systems) 'is-book-title #f))
529 (set! systems (cdr systems)))
534 (paper-system-title? sys)
535 (not (pair? to-dump-systems))
536 (paper-system-title? (car to-dump-systems)))
537 (set! to-dump-systems (cons sys to-dump-systems))))
542 (stack-stencils Y DOWN 0.0
543 (map paper-system-stencil (reverse to-dump-systems)))
544 (format "~a.preview" basename)
547 (postprocess-output book framework-ps-module
548 (format "~a.preview.eps" basename)
549 (cons "png" (ly:output-formats)))))
552 (define-public (output-preview-framework basename book scopes fields)
554 (let* ((paper (ly:paper-book-paper book))
555 (systems (ly:paper-book-systems book))
556 (scale (ly:output-def-lookup paper 'output-scale))
557 (titles (take-while paper-system-title? systems))
558 (non-title (find (lambda (x)
559 (not (paper-system-title? x))) systems))
561 (stack-stencils Y DOWN 0.0
562 (map paper-system-stencil
563 (append titles (list non-title))))))
564 (output-scopes scopes fields basename)
565 (dump-stencil-as-EPS paper dump-me
566 (format "~a.preview" basename)
569 (postprocess-output book framework-ps-module
570 (format "~a.preview.eps" basename)
571 (ly:output-formats)))))
572 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
574 (define-public (convert-to-pdf book name)
575 (let* ((defs (ly:paper-book-paper book))
576 (papersizename (ly:output-def-lookup defs 'papersizename)))
578 (if (equal? (basename name ".ps") "-")
579 (ly:warning (_ "can't convert <stdout> to ~S" "PDF"))
580 (postscript->pdf (if (string? papersizename) papersizename "a4")
583 (define-public (convert-to-png book name)
584 (let* ((defs (ly:paper-book-paper book))
585 (defs-resolution (ly:output-def-lookup defs 'pngresolution))
586 (resolution (if (number? defs-resolution)
588 (ly:get-option 'resolution)))
589 (papersizename (ly:output-def-lookup defs 'papersizename)))
591 (postscript->png resolution
592 (if (string? papersizename) papersizename "a4")
595 (define-public (convert-to-dvi book name)
596 (ly:warning (_ "can't generate ~S using the postscript back-end") "DVI"))
598 (define-public (convert-to-tex book name)
599 (ly:warning (_ "can't generate ~S using the postscript back-end") "TeX"))
601 (define-public (convert-to-ps book name)
604 (define-public (output-classic-framework basename book scopes fields)
606 (ly:error (_ "\nThe PostScript backend does not support the 'classic'
607 framework. Use the EPS backend instead,
609 lilypond -b eps <file>
611 or remove the lilypond-book specific settings from the input.