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@xs4all.nl>
7 (define-module (scm framework-ps))
9 ;;; this is still too big a mess.
11 (use-modules (ice-9 regex)
23 (define framework-ps-module (current-module))
25 ;;(define pdebug stderr)
26 (define (pdebug . rest) #f)
28 (define-public (ps-font-command font)
29 (let* ((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 " " (ly:number->string scaling) " output-scale div selectfont } 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 "true setstrokeadjust\n"
121 "gsave 0 paper-height translate "
122 "set-ps-scale-to-lily-scale "
124 (ly:outputter-dump-stencil outputter page)
125 (ly:outputter-dump-string outputter "stroke grestore \nshowpage\n"))
127 (define (supplies-or-needs paper load-fonts?)
128 (define (extract-names font)
129 (if (ly:pango-font? font)
130 (map car (ly:pango-font-physical-fonts font))
131 (list (ly:font-name font))))
133 (let* ((fonts (ly:paper-fonts paper))
134 (names (apply append (map extract-names fonts))))
140 "%%DocumentSuppliedResources: font ~a\n"
141 "%%DocumentNeededResources: font ~a\n")
143 (uniq-list (sort names string<?))))))
145 (define (eps-header paper bbox load-fonts?)
146 (string-append "%!PS-Adobe-2.0 EPSF-2.0\n"
147 "%%Creator: LilyPond "
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 (ps-document-media paper)
161 (ly:output-def-lookup paper 'output-scale)
162 (ly:output-def-lookup paper 'paper-width)) (ly:bp 1)))
164 (ly:output-def-lookup paper 'paper-height)
165 (ly:output-def-lookup paper 'output-scale))
167 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t)))
168 (format "%%DocumentMedia: ~a ~$ ~$ ~a ~a ~a\n"
169 (ly:output-def-lookup paper 'papersizename)
178 (define (file-header paper page-count load-fonts?)
179 (string-append "%!PS-Adobe-3.0\n"
180 "%%Creator: LilyPond "
184 "%%Pages: " (number->string page-count) "\n"
185 "%%PageOrder: Ascend\n"
187 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
190 (ps-document-media paper)
191 (supplies-or-needs paper load-fonts?)
194 (define (procset file-name)
196 "%%BeginResource: procset (~a) 1 0
200 file-name (cached-file-contents file-name)))
202 (define (embed-document file-name)
203 (format "%%BeginDocument: ~a
207 file-name (cached-file-contents file-name)))
209 (define (setup-variables paper)
213 (output-variables paper)
216 (define (cff-font? font)
218 ((cff-string (ly:otf-font-table-data font "CFF ")))
219 (> (string-length cff-string) 0)))
221 (define-public (ps-embed-cff body font-set-name version)
224 (format "/~a ~s StartData " font-set-name (string-length body))
229 "%%BeginResource: font ~a
230 %!PS-Adobe-3.0 Resource-FontSet
231 %%DocumentNeededResources: ProcSet (FontSetInit)
232 %%Title: (FontSet/~a)
235 %%IncludeResource: ProcSet (FontSetInit)
236 %%BeginResource: FontSet (~a)
237 /FontSetInit /ProcSet findresource begin
238 %%BeginData: ~s Binary Bytes
240 font-set-name font-set-name version font-set-name
241 (string-length binary-data)))
252 (define (write-preamble paper load-fonts? port)
254 (define (load-font-via-GS font-name-filename)
255 (define (ps-load-file name)
258 "(~a) (r) file .loadfont\n"
259 "% cannot find font file: ~a\n")
262 (let* ((font (car font-name-filename))
263 (name (cadr font-name-filename))
264 (file-name (caddr font-name-filename))
265 (bare-file-name (ly:find-file file-name)))
270 (if (mac-font? bare-file-name)
271 (handle-mac-font name bare-file-name)
273 ((string-match "^([eE]mmentaler|[Aa]ybabtu)" file-name)
274 (ps-load-file (ly:find-file
275 (format "~a.otf" file-name))))
276 ((string? bare-file-name)
277 (ps-load-file file-name))
279 (ly:warning (_ "cannot embed ~S=~S") name file-name)
284 (define (dir-join a b)
287 (string-append a "/" b)))
289 (define (dir-listing dir-name)
290 (define (dir-helper dir lst)
291 (let ((e (readdir dir)))
292 (if (eof-object? e) lst (dir-helper dir (cons e lst)))))
293 (reverse (dir-helper (opendir dir-name) '())))
295 (define (handle-mac-font name filename)
302 (mkdir dir-name #o700)
303 (set! status (ly:system
304 (format "cd ~a && fondu -force '~a'" dir-name filename)))
306 (set! files (dir-listing dir-name))
311 ((full-name (dir-join dir-name f)))
314 (equal? 'regular (stat:type (stat full-name)))
315 (equal? name (ly:ttf-ps-name full-name)))
318 (font-file-as-ps-string name full-name)))
320 (if (or (equal? "." f)
323 (delete-file full-name))))
331 (set! embed "% failed \n")
332 (ly:warning (_ "cannot extract file matching ~a from ~a") name filename)))
335 (define (font-file-as-ps-string name file-name)
337 ((downcase-file-name (string-downcase file-name)))
340 ((and file-name (string-match "\\.pfa" downcase-file-name))
341 (embed-document file-name))
342 ((and file-name (string-match "\\.pfb" downcase-file-name))
343 (ly:pfb->pfa file-name))
344 ((and file-name (string-match "\\.ttf" downcase-file-name))
345 (ly:ttf->pfa file-name))
346 ((and file-name (string-match "\\.otf" downcase-file-name))
347 (ps-embed-cff (ly:otf->cff file-name) name 0))
349 (ly:warning (_ "do not know how to embed ~S=~S") name file-name)
352 (define (mac-font? bare-file-name)
354 (eq? PLATFORM 'darwin)
357 (string-match "\\.dfont" bare-file-name)
358 (= (stat:size (stat bare-file-name)) 0))))
360 (define (load-font font-name-filename)
361 (let* ((font (car font-name-filename))
362 (name (cadr font-name-filename))
363 (file-name (caddr font-name-filename))
364 (bare-file-name (ly:find-file file-name)))
370 ((mac-font? bare-file-name)
371 (handle-mac-font name bare-file-name))
373 ((and font (cff-font? font))
374 (ps-embed-cff (ly:otf-font-table-data font "CFF ")
378 (bare-file-name (font-file-as-ps-string name bare-file-name))
380 (ly:warning (_ "do not know how to embed font ~s ~s ~s")
381 name file-name font))))))
384 (define (load-fonts paper)
385 (let* ((fonts (ly:paper-fonts paper))
390 ((string? (ly:font-file-name font))
394 (ly:font-file-name font))))
395 ((ly:pango-font? font)
397 (lambda (name-psname-pair)
399 (car name-psname-pair)
400 (cdr name-psname-pair)))
401 (ly:pango-font-physical-fonts font)))
404 (ly:font-sub-fonts font))))
409 (sort (apply append all-font-names)
410 (lambda (x y) (string<? (cadr x) (cadr y))))))
412 (font-loader (if (ly:get-option 'gs-load-fonts)
416 (pfas (map font-loader font-names)))
419 (display "%%BeginProlog\n" port)
423 (format port "\n%%BeginFont: ~a\n" (car f))
424 (display (cdr f) port)
425 (display "\n%%EndFont\n" port))
428 (display (setup-variables paper) port)
430 ;; adobe note 5002: should initialize variables before loading routines.
431 (display (procset "music-drawing-routines.ps") port)
432 (display (procset "lilyponddefs.ps") port)
434 (if (not (ly:get-option 'point-and-click))
435 (display "/mark_URI { pop pop pop pop pop } bind def\n" port))
437 (display "%%EndProlog\n" port)
439 (display "%%BeginSetup\ninit-lilypond-parameters\n%%EndSetup\n\n" port))
441 (define-public (output-framework basename book scopes fields)
442 (let* ((filename (format "~a.ps" basename))
443 (outputter (ly:make-paper-outputter
444 ;; FIXME: better wrap open/open-file,
445 ;; content-mangling is always bad.
446 ;; MINGW hack: need to have "b"inary for embedding CFFs
447 (open-file filename "wb")
449 (paper (ly:paper-book-paper book))
450 (systems (ly:paper-book-systems book))
451 (page-stencils (map page-stencil (ly:paper-book-pages book)))
453 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
454 (page-number (1- (ly:output-def-lookup paper 'first-page-number)))
455 (page-count (length page-stencils))
456 (port (ly:outputter-port outputter)))
459 (if (ly:get-option 'clip-systems)
460 (clip-system-EPSes basename book))
462 (if (ly:get-option 'dump-signatures)
463 (write-system-signatures basename (ly:paper-book-systems book) 1))
465 (output-scopes scopes fields basename)
466 (display (file-header paper page-count #t) port)
468 ;; don't do BeginDefaults PageMedia: A4
469 ;; not necessary and wrong
471 (write-preamble paper #t port)
475 (set! page-number (1+ page-number))
476 (dump-page outputter page page-number page-count landscape?))
479 (display "%%Trailer\n%%EOF\n" port)
480 (ly:outputter-close outputter)
481 (postprocess-output book framework-ps-module filename
482 (ly:output-formats))))
484 (define-public (dump-stencil-as-EPS paper dump-me filename
488 ((xext (ly:stencil-extent dump-me X))
489 (yext (ly:stencil-extent dump-me Y))
490 (left-overshoot (ly:get-option 'eps-box-padding))
494 (if (or (nan? x) (inf? x)
496 (equal? (format #f "~S" x) "+#.#")
497 (equal? (format #f "~S" x) "-#.#"))
500 ;; the left-overshoot is to make sure that
501 ;; bar numbers stick out of margin uniformly.
505 (if (number? left-overshoot)
506 (min left-overshoot (car xext))
508 (car yext) (cdr xext) (cdr yext)))))
510 (dump-stencil-as-EPS-with-bbox paper dump-me filename load-fonts bbox)
514 (define-public (dump-stencil-as-EPS-with-bbox paper dump-me filename
517 (define (to-bp-box mmbox)
518 (let* ((scale (ly:output-def-lookup paper 'output-scale))
521 (if (or (nan? x) (inf? x))
524 (round (/ (* x scale) (ly:bp 1)))))) mmbox)))
528 (max (1+ (car box)) (caddr box))
529 (max (1+ (cadr box)) (cadddr box))
532 (let* ((outputter (ly:make-paper-outputter
533 ;; FIXME: better wrap open/open-file,
534 ;; content-mangling is always bad.
535 ;; MINGW hack: need to have "b"inary for embedding CFFs
536 (open-file (format "~a.eps" filename) "wb")
539 (port (ly:outputter-port outputter))
540 (rounded-bbox (to-bp-box bbox))
541 (port (ly:outputter-port outputter))
542 (header (eps-header paper rounded-bbox load-fonts)))
544 (display header port)
545 (write-preamble paper load-fonts port)
546 (display "gsave set-ps-scale-to-lily-scale \n" port)
547 (ly:outputter-dump-stencil outputter dump-me)
548 (display "stroke grestore\n%%Trailer\n%%EOF\n" port)
549 (ly:outputter-close outputter)))
553 (define (clip-systems-to-region
554 basename paper systems region
558 ((extents-system-pairs
560 (lambda (paper-system)
562 ((x-ext (system-clipped-x-extent
563 (paper-system-system-grob paper-system)
567 (cons x-ext paper-system)
574 (lambda (ext-system-pair)
576 ((xext (car ext-system-pair))
577 (paper-system (cdr ext-system-pair))
578 (yext (paper-system-extent paper-system Y))
579 (bbox (list (car xext) (car yext)
580 (cdr xext) (cdr yext)))
581 (filename (if (< 0 count)
582 (format "~a-~a" basename count)
585 (set! count (1+ count))
586 (dump-stencil-as-EPS-with-bbox
588 (paper-system-stencil paper-system)
590 (ly:get-option 'include-eps-fonts)
594 (postscript->pdf 0 0 (format "~a.eps" filename)))
597 extents-system-pairs)
601 (define (clip-system-EPSes basename paper-book)
602 (define do-pdf (member "pdf" (ly:output-formats)))
604 (define (clip-score-systems basename systems)
606 ((layout (ly:grob-layout (paper-system-system-grob (car systems))))
607 (regions (ly:output-def-lookup layout 'clip-regions)))
611 (clip-systems-to-region
612 (format "~a-from-~a-to-~a-clip"
614 (rhythmic-location->file-string (car region))
615 (rhythmic-location->file-string (cdr region)))
616 layout systems region
622 ;; partition in system lists sharing their layout blocks
624 ((systems (ly:paper-book-systems paper-book))
626 (score-system-list '()))
629 (lambda (system last-system)
632 (if (not (and last-system
633 (equal? (paper-system-layout last-system)
634 (paper-system-layout system))))
635 (set! score-system-list (cons '() score-system-list)))
637 (if (paper-system-layout system)
638 (set-car! score-system-list (cons system (car score-system-list))))
647 (lambda (system-list)
650 (format "~a-~a" basename count)
657 (define-public (output-preview-framework basename book scopes fields)
658 (let* ((paper (ly:paper-book-paper book))
659 (systems (ly:paper-book-systems book))
660 (scale (ly:output-def-lookup paper 'output-scale))
661 (to-dump-systems '()))
665 (not (ly:get-option 'include-book-title-preview))
667 (ly:prob-property (car systems) 'is-book-title #f))
669 (set! systems (cdr systems)))
674 (paper-system-title? sys)
675 (not (pair? to-dump-systems))
676 (paper-system-title? (car to-dump-systems)))
677 (set! to-dump-systems (cons sys to-dump-systems))))
682 (stack-stencils Y DOWN 0.0
683 (map paper-system-stencil (reverse to-dump-systems)))
684 (format "~a.preview" basename)
687 (postprocess-output book framework-ps-module
688 (format "~a.preview.eps" basename)
689 (cons "png" (ly:output-formats)))))
692 (define-public (output-preview-framework basename book scopes fields)
694 (let* ((paper (ly:paper-book-paper book))
695 (systems (ly:paper-book-systems book))
696 (scale (ly:output-def-lookup paper 'output-scale))
697 (titles (take-while paper-system-title? systems))
698 (non-title (find (lambda (x)
699 (not (paper-system-title? x))) systems))
701 (stack-stencils Y DOWN 0.0
702 (map paper-system-stencil
703 (append titles (list non-title))))))
704 (output-scopes scopes fields basename)
705 (dump-stencil-as-EPS paper dump-me
706 (format "~a.preview" basename)
709 (postprocess-output book framework-ps-module
710 (format "~a.preview.eps" basename)
711 (ly:output-formats)))))
713 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
715 (define-public (convert-to-pdf book name)
716 (let* ((defs (ly:paper-book-paper book))
717 (landscape (ly:output-def-lookup defs 'landscape))
718 (output-scale (ly:output-def-lookup defs 'output-scale))
719 (convert (lambda (x) (* x output-scale (/ (ly:bp 1)))))
721 (paper-width (convert (ly:output-def-lookup defs 'paper-width)))
722 (paper-height (convert (ly:output-def-lookup defs 'paper-height)))
724 (w (if landscape paper-height paper-width))
725 (h (if landscape paper-width paper-height))
728 (if (equal? (basename name ".ps") "-")
729 (ly:warning (_ "cannot convert <stdout> to ~S" "PDF"))
730 (postscript->pdf w h name))))
732 (define-public (convert-to-png book name)
733 (let* ((defs (ly:paper-book-paper book))
734 (defs-resolution (ly:output-def-lookup defs 'pngresolution))
735 (resolution (if (number? defs-resolution)
737 (ly:get-option 'resolution)))
738 (paper-width (ly:output-def-lookup defs 'paper-width))
739 (paper-height (ly:output-def-lookup defs 'paper-height))
740 (output-scale (ly:output-def-lookup defs 'output-scale)))
742 (postscript->png resolution
743 (* paper-width output-scale (/ (ly:bp 1)))
744 (* paper-height output-scale (/ (ly:bp 1)))
747 (define-public (convert-to-dvi book name)
748 (ly:warning (_ "cannot generate ~S using the postscript back-end") "DVI"))
750 (define-public (convert-to-tex book name)
751 (ly:warning (_ "cannot generate ~S using the postscript back-end") "TeX"))
753 (define-public (convert-to-ps book name)
756 (define-public (output-classic-framework basename book scopes fields)
758 (ly:error (_ "\nThe PostScript backend does not support the 'classic'
759 framework. Use the EPS backend instead,
761 lilypond -b eps <file>
763 or remove the lilypond-book specific settings from the input.