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 (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
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 'output-scale))
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" 'line-thickness)
103 (output-entry "line-width" 'line-width)
104 (output-entry "paper-size" 'papersizename)
105 (output-entry "staff-height" 'staff-height) ;junkme.
107 (number->string (ly:output-def-lookup layout 'output-scale))
109 (output-entry "page-height" 'paper-height)
110 (output-entry "page-width" 'paper-width)))
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"
125 "gsave 0 paper-height translate "
126 "set-ps-scale-to-lily-scale "
128 (ly:outputter-dump-stencil outputter page)
129 (ly:outputter-dump-string outputter "stroke grestore \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 (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 (cff-font? font)
199 ((cff-string (ly:otf-font-table-data font "CFF ")))
200 (> (string-length cff-string) 0)))
202 (define-public (ps-embed-cff body font-set-name version)
205 (format "/~a ~s StartData " font-set-name (string-length body))
210 "%%BeginResource: font ~a
211 %!PS-Adobe-3.0 Resource-FontSet
212 %%DocumentNeededResources: ProcSet (FontSetInit)
213 %%Title: (FontSet/~a)
216 %%IncludeResource: ProcSet (FontSetInit)
217 %%BeginResource: FontSet (~a)
218 /FontSetInit /ProcSet findresource begin
219 %%BeginData: ~s Binary Bytes
221 font-set-name font-set-name version font-set-name
222 (string-length binary-data)))
234 (define (write-preamble paper load-fonts? port)
236 (define (load-font-via-GS font-name-filename)
237 (define (ps-load-file name)
240 "(~a) (r) file .loadfont\n"
241 "% can't find font file: ~a\n")
244 (let* ((font (car font-name-filename))
245 (name (cadr font-name-filename))
246 (file-name (caddr font-name-filename))
247 (bare-file-name (ly:find-file file-name)))
252 ((string-match "^([eE]mmentaler|[Aa]ybabtu)" file-name)
253 (ps-load-file (ly:find-file
254 (format "~a.otf" file-name))))
255 ((string? bare-file-name)
256 (ps-load-file file-name))
258 (ly:warning (_ "can't embed ~S=~S") name file-name)
261 (define (dir-join a b)
264 (string-append a "/" b)))
266 (define (dir-listing dir-name)
267 (define (dir-helper dir lst)
268 (let ((e (readdir dir)))
269 (if (eof-object? e) lst (dir-helper dir (cons e lst)))))
270 (reverse (dir-helper (opendir dir-name) '())))
272 (define (handle-mac-font name filename)
279 (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 ((full-name (dir-join dir-name f)))
291 (equal? 'regular (stat:type (stat full-name)))
292 (equal? name (ly:ttf-ps-name full-name)))
295 (font-file-as-ps-string name full-name)))
297 (if (or (equal? "." f)
300 (delete-file full-name))))
308 (set! embed "% failed \n")
309 (ly:warning (_ "can't extract file matching ~a from ~a") name filename)))
312 (define (font-file-as-ps-string name file-name)
314 ((downcase-file-name (string-downcase file-name)))
317 ((and file-name (string-match "\\.pfa" downcase-file-name))
318 (cached-file-contents file-name))
319 ((and file-name (string-match "\\.pfb" downcase-file-name))
320 (ly:pfb->pfa file-name))
321 ((and file-name (string-match "\\.ttf" downcase-file-name))
322 (ly:ttf->pfa file-name))
323 ((and file-name (string-match "\\.otf" downcase-file-name))
324 (ps-embed-cff (ly:otf->cff file-name) name 0))
326 (ly:warning (_ "don't know how to embed ~S=~S") name file-name)
329 (define (load-font font-name-filename)
330 (let* ((font (car font-name-filename))
331 (name (cadr font-name-filename))
332 (file-name (caddr font-name-filename))
333 (bare-file-name (ly:find-file file-name)))
340 (eq? PLATFORM 'darwin)
341 bare-file-name (string-match "\\.dfont" bare-file-name))
342 (handle-mac-font name bare-file-name))
345 (eq? PLATFORM 'darwin)
346 bare-file-name (= (stat:size (stat bare-file-name)) 0))
347 (handle-mac-font name bare-file-name))
349 ((and font (cff-font? font))
350 (ps-embed-cff (ly:otf-font-table-data font "CFF ")
354 (bare-file-name (font-file-as-ps-string name bare-file-name))
356 (ly:warning (_ "don't know how to embed font ~s ~s ~s")
357 name file-name font))))))
360 (define (load-fonts paper)
361 (let* ((fonts (ly:paper-fonts paper))
366 ((string? (ly:font-file-name font))
370 (ly:font-file-name font))))
371 ((ly:pango-font? font)
373 (lambda (name-psname-pair)
375 (car name-psname-pair)
376 (cdr name-psname-pair)))
377 (ly:pango-font-physical-fonts font)))
380 (ly:font-sub-fonts font))))
385 (sort (apply append all-font-names)
386 (lambda (x y) (string<? (cadr x) (cadr y))))))
389 (font-loader (if (ly:get-option 'gs-font-load)
393 (pfas (map font-loader font-names)))
399 (format port "\n%%BeginFont: ~a\n" (car f))
400 (display (cdr f) port)
401 (display "\n%%EndFont\n" port))
404 (display (setup paper) port)
406 ;; adobe note 5002: should initialize variables before loading routines.
407 (display (procset "music-drawing-routines.ps") port)
408 (display (procset "lilyponddefs.ps") port)
409 (display "init-lilypond-parameters\n" port))
411 (define-public (output-framework basename book scopes fields)
412 (let* ((filename (format "~a.ps" basename))
413 (outputter (ly:make-paper-outputter
414 ;; FIXME: better wrap open/open-file,
415 ;; content-mangling is always bad.
416 ;; MINGW hack: need to have "b"inary for embedding CFFs
417 (open-file filename "wb")
419 (paper (ly:paper-book-paper book))
420 (page-stencils (map page-stencil (ly:paper-book-pages book)))
422 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
423 (page-number (1- (ly:output-def-lookup paper 'first-page-number)))
424 (page-count (length page-stencils))
425 (port (ly:outputter-port outputter)))
427 (output-scopes scopes fields basename)
428 (display (page-header paper page-count #t) port)
429 (write-preamble paper #t port)
433 (set! page-number (1+ page-number))
434 (dump-page outputter page page-number page-count landscape?))
437 (display "%%Trailer\n%%EOF\n" port)
438 (ly:outputter-close outputter)
439 (postprocess-output book framework-ps-module filename
440 (ly:output-formats))))
442 (define-public (dump-stencil-as-EPS paper dump-me filename load-fonts?)
443 (define (mm-to-bp-box mmbox)
444 (let* ((scale (ly:output-def-lookup paper 'output-scale))
448 (round (* x scale mm-to-bigpoint)))) mmbox)))
452 (max (1+ (car box)) (caddr box))
453 (max (1+ (cadr box)) (cadddr box))
456 (let* ((outputter (ly:make-paper-outputter
457 ;; FIXME: better wrap open/open-file,
458 ;; content-mangling is always bad.
459 ;; MINGW hack: need to have "b"inary for embedding CFFs
460 (open-file (format "~a.eps" filename) "wb")
464 (port (ly:outputter-port outputter))
465 (xext (ly:stencil-extent dump-me X))
466 (yext (ly:stencil-extent dump-me Y))
470 (if (or (nan? x) (inf? x)
472 (equal? (format #f "~S" x) "+#.#")
473 (equal? (format #f "~S" x) "-#.#"))
476 ;; the left-overshoot is to make sure that
477 ;; bar numbers stick out of margin uniformly.
479 (list (min left-overshoot (car xext))
480 (car yext) (cdr xext) (cdr yext))))
481 (rounded-bbox (mm-to-bp-box bbox))
482 (port (ly:outputter-port outputter))
483 (header (eps-header paper rounded-bbox load-fonts?)))
485 (display header port)
486 (write-preamble paper load-fonts? port)
487 (display "gsave set-ps-scale-to-lily-scale \n" port)
488 (ly:outputter-dump-stencil outputter dump-me)
489 (display "stroke grestore\n%%Trailer\n%%EOF\n" port)
490 (ly:outputter-close outputter)))
492 (define-public (output-preview-framework basename book scopes fields)
493 (let* ((paper (ly:paper-book-paper book))
494 (systems (ly:paper-book-systems book))
495 (scale (ly:output-def-lookup paper 'output-scale))
496 (to-dump-systems '()))
500 (not (ly:get-option 'preview-include-book-title))
502 (ly:prob-property (car systems) 'is-book-title #f))
504 (set! systems (cdr systems)))
509 (paper-system-title? sys)
510 (not (pair? to-dump-systems))
511 (paper-system-title? (car to-dump-systems)))
512 (set! to-dump-systems (cons sys to-dump-systems))))
517 (stack-stencils Y DOWN 0.0
518 (map paper-system-stencil (reverse to-dump-systems)))
519 (format "~a.preview" basename)
522 (postprocess-output book framework-ps-module
523 (format "~a.preview.eps" basename)
524 (cons "png" (ly:output-formats)))))
527 (define-public (output-preview-framework basename book scopes fields)
529 (let* ((paper (ly:paper-book-paper book))
530 (systems (ly:paper-book-systems book))
531 (scale (ly:output-def-lookup paper 'output-scale))
532 (titles (take-while paper-system-title? systems))
533 (non-title (find (lambda (x)
534 (not (paper-system-title? x))) systems))
536 (stack-stencils Y DOWN 0.0
537 (map paper-system-stencil
538 (append titles (list non-title))))))
539 (output-scopes scopes fields basename)
540 (dump-stencil-as-EPS paper dump-me
541 (format "~a.preview" basename)
544 (postprocess-output book framework-ps-module
545 (format "~a.preview.eps" basename)
546 (ly:output-formats)))))
547 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
549 (define-public (convert-to-pdf book name)
550 (let* ((defs (ly:paper-book-paper book))
551 (papersizename (ly:output-def-lookup defs 'papersizename)))
553 (if (equal? (basename name ".ps") "-")
554 (ly:warning (_ "can't convert <stdout> to ~S" "PDF"))
555 (postscript->pdf (if (string? papersizename) papersizename "a4")
558 (define-public (convert-to-png book name)
559 (let* ((defs (ly:paper-book-paper book))
560 (defs-resolution (ly:output-def-lookup defs 'pngresolution))
561 (resolution (if (number? defs-resolution)
563 (ly:get-option 'resolution)))
564 (papersizename (ly:output-def-lookup defs 'papersizename)))
566 (postscript->png resolution
567 (if (string? papersizename) papersizename "a4")
570 (define-public (convert-to-dvi book name)
571 (ly:warning (_ "can't generate ~S using the postscript back-end") "DVI"))
573 (define-public (convert-to-tex book name)
574 (ly:warning (_ "can't generate ~S using the postscript back-end") "TeX"))
576 (define-public (convert-to-ps book name)
579 (define-public (output-classic-framework basename book scopes fields)
581 (ly:error (_ "\nThe PostScript backend does not support the 'classic'
582 framework. Use the EPS backend instead,
584 lilypond -b eps <file>
586 or remove the lilypond-book specific settings from the input.