1 ;;;; framework-ps.scm -- structure for PostScript output
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 2004--2007 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 string-fun)
20 (define format ergonomic-simple-format)
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)))
39 "m" (string-encode-integer (inexact->exact (round (* 1000 magnify)))))))
41 (define (tex-font? fontname)
43 (equal? (substring fontname 0 2) "cm")
44 (equal? (substring fontname 0 2) "ec")))
46 (define (define-fonts paper)
47 (define font-list (ly:paper-fonts paper))
48 (define (define-font command fontname scaling)
50 "/" command " { /" fontname " " (ly:number->string scaling) " output-scale div selectfont } bind def\n"))
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 (if (equal? fontname "unknown")
67 (display (list font fontname)))
68 (define-font plain fontname scaling)))
71 (map (lambda (x) (font-load-command x))
72 (filter (lambda (x) (not (ly:pango-font? x)))
75 ;; FIXME: duplicated in other output backends
76 ;; FIXME: silly interface name
77 (define (output-variables layout)
78 ;; FIXME: duplicates output-layout's scope-entry->string, mostly
79 (define (value->string val)
81 ((string? val) (string-append "(" val ")"))
82 ((symbol? val) (symbol->string val))
83 ((number? val) (number->string val))
86 (define (output-entry ps-key ly-key)
89 (value->string (ly:output-def-lookup layout ly-key)) " def\n"))
93 (number->string (/ (ly:bp 1)))
94 " def %% millimeter\n"
95 (output-entry "staff-line-thickness" 'line-thickness)
96 (output-entry "line-width" 'line-width)
97 (output-entry "paper-size" 'papersizename)
98 (output-entry "staff-height" 'staff-height) ;junkme.
100 (number->string (ly:output-def-lookup layout 'output-scale))
102 (output-entry "page-height" 'paper-height)
103 (output-entry "page-width" 'paper-width)))
105 (define (dump-page outputter page page-number page-count landscape?)
106 (ly:outputter-dump-string
109 (format "%%Page: ~a ~a\n" page-number page-number)
112 "page-width output-scale lily-output-units mul mul 0 translate 90 rotate\n"
116 "true setstrokeadjust\n"
117 "gsave 0 paper-height translate "
118 "set-ps-scale-to-lily-scale "
120 (ly:outputter-dump-stencil outputter page)
121 (ly:outputter-dump-string outputter "stroke grestore \nshowpage\n"))
123 (define (supplies-or-needs paper load-fonts?)
124 (define (extract-names font)
125 (if (ly:pango-font? font)
126 (map car (ly:pango-font-physical-fonts font))
127 (list (ly:font-name font))))
129 (let* ((fonts (ly:paper-fonts paper))
130 (names (apply append (map extract-names fonts))))
136 "%%DocumentSuppliedResources: font ~a\n"
137 "%%DocumentNeededResources: font ~a\n")
139 (uniq-list (sort names string<?))))))
141 (define (eps-header paper bbox load-fonts?)
142 (string-append "%!PS-Adobe-2.0 EPSF-2.0\n"
143 "%%Creator: LilyPond "
147 (string-join (map ly:number->string bbox) " ") "\n"
149 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
152 (supplies-or-needs paper load-fonts?)
155 (define (ps-document-media paper)
157 (ly:output-def-lookup paper 'output-scale)
158 (ly:output-def-lookup paper 'paper-width)) (ly:bp 1)))
160 (ly:output-def-lookup paper 'paper-height)
161 (ly:output-def-lookup paper 'output-scale))
163 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t)))
164 (ly:format "%%DocumentMedia: ~a ~2f ~2f ~a ~a ~a\n"
165 (ly:output-def-lookup paper 'papersizename)
174 (define (file-header paper page-count load-fonts?)
175 (string-append "%!PS-Adobe-3.0\n"
176 "%%Creator: LilyPond "
180 "%%Pages: " (number->string page-count) "\n"
181 "%%PageOrder: Ascend\n"
183 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
186 (ps-document-media paper)
187 (supplies-or-needs paper load-fonts?)
190 (define (procset file-name)
192 "%%BeginResource: procset (~a) 1 0
196 file-name (cached-file-contents file-name)))
198 (define (embed-document file-name)
199 (format "%%BeginDocument: ~a
203 file-name (cached-file-contents file-name)))
205 (define (setup-variables paper)
209 (output-variables paper)
212 (define (cff-font? font)
214 ((cff-string (ly:otf-font-table-data font "CFF ")))
215 (> (string-length cff-string) 0)))
217 (define-public (ps-embed-cff body font-set-name version)
220 (format "/~a ~s StartData " font-set-name (string-length body))
225 "%%BeginResource: font ~a
226 %!PS-Adobe-3.0 Resource-FontSet
227 %%DocumentNeededResources: ProcSet (FontSetInit)
228 %%Title: (FontSet/~a)
231 %%IncludeResource: ProcSet (FontSetInit)
232 %%BeginResource: FontSet (~a)
233 /FontSetInit /ProcSet findresource begin
234 %%BeginData: ~s Binary Bytes
236 font-set-name font-set-name version font-set-name
237 (string-length binary-data)))
248 (define (write-preamble paper load-fonts? port)
249 (define (internal-font? file-name)
250 (or (string-startswith file-name "Emmentaler")
251 (string-startswith file-name "emmentaler")
252 (string-startswith file-name "aybabtu")
253 (string-startswith file-name "Aybabtu")))
254 (define (load-font-via-GS font-name-filename)
255 (define (ps-load-file file-name)
256 (if (string? file-name)
257 (if (string-contains file-name (ly:get-option 'datadir))
259 (set! file-name (ly:string-substitute (ly:get-option 'datadir) "" file-name))
260 (format "lilypond-datadir (~a) concatstrings (r) file .loadfont" file-name))
262 (format "(~a) (r) file .loadfont\n" file-name))
263 (format "% cannot find font file: ~a\n" file-name)))
265 (let* ((font (car font-name-filename))
266 (name (cadr font-name-filename))
267 (file-name (caddr font-name-filename))
268 (bare-file-name (ly:find-file file-name)))
273 (if (mac-font? bare-file-name)
274 (handle-mac-font name bare-file-name)
276 ((internal-font? file-name)
277 (ps-load-file (ly:find-file
278 (format "~a.otf" file-name))))
279 ((string? bare-file-name)
280 (ps-load-file file-name))
282 (ly:warning (_ "cannot embed ~S=~S") name file-name)
287 (define (dir-join a b)
290 (string-append a "/" b)))
292 (define (dir-listing dir-name)
293 (define (dir-helper dir lst)
294 (let ((e (readdir dir)))
295 (if (eof-object? e) lst (dir-helper dir (cons e lst)))))
296 (reverse (dir-helper (opendir dir-name) '())))
298 (define (handle-mac-font name filename)
305 (mkdir dir-name #o700)
306 (set! status (ly:system
307 (format "cd ~a && fondu -force '~a'" dir-name filename)))
309 (set! files (dir-listing dir-name))
314 ((full-name (dir-join dir-name f)))
317 (equal? 'regular (stat:type (stat full-name)))
318 (equal? name (ly:ttf-ps-name full-name)))
321 (font-file-as-ps-string name full-name)))
323 (if (or (equal? "." f)
326 (delete-file full-name))))
334 (set! embed "% failed \n")
335 (ly:warning (_ "cannot extract file matching ~a from ~a") name filename)))
338 (define (font-file-as-ps-string name file-name)
340 ((downcase-file-name (string-downcase file-name)))
343 ((and file-name (string-endswith downcase-file-name ".pfa"))
344 (embed-document file-name))
345 ((and file-name (string-endswith downcase-file-name ".pfb"))
346 (ly:pfb->pfa file-name))
347 ((and file-name (string-endswith downcase-file-name ".ttf"))
348 (ly:ttf->pfa file-name))
349 ((and file-name (string-endswith downcase-file-name ".otf"))
350 (ps-embed-cff (ly:otf->cff file-name) name 0))
352 (ly:warning (_ "do not know how to embed ~S=~S") name file-name)
355 (define (mac-font? bare-file-name)
357 (eq? PLATFORM 'darwin)
360 (string-endswith bare-file-name ".dfont")
361 (= (stat:size (stat bare-file-name)) 0))))
363 (define (load-font font-name-filename)
364 (let* ((font (car font-name-filename))
365 (name (cadr font-name-filename))
366 (file-name (caddr font-name-filename))
367 (bare-file-name (ly:find-file file-name)))
373 ((mac-font? bare-file-name)
374 (handle-mac-font name bare-file-name))
376 ((and font (cff-font? font))
377 (ps-embed-cff (ly:otf-font-table-data font "CFF ")
381 (bare-file-name (font-file-as-ps-string name bare-file-name))
383 (ly:warning (_ "do not know how to embed font ~s ~s ~s")
384 name file-name font))))))
387 (define (load-fonts paper)
388 (let* ((fonts (ly:paper-fonts paper))
390 ;; todo - doc format of list.
395 ((string? (ly:font-file-name font))
399 (ly:font-file-name font))))
400 ((ly:pango-font? font)
402 (lambda (name-psname-pair)
404 (car name-psname-pair)
405 (cdr name-psname-pair)))
406 (ly:pango-font-physical-fonts font)))
409 (ly:font-sub-fonts font))))
414 (sort (apply append all-font-names)
415 (lambda (x y) (string<? (cadr x) (cadr y))))))
417 ;; slightly spaghetti-ish: deciding what to load where
419 (font-loader (lambda (name)
421 ((ly:get-option 'gs-load-fonts)
422 (load-font-via-GS name))
423 ((ly:get-option 'gs-load-lily-fonts)
425 (string-contains (caddr name) (ly:get-option 'datadir))
426 (internal-font? (caddr name)))
428 (load-font-via-GS name)
430 (else (load-font name)))))
432 (pfas (map font-loader font-names)))
435 (display "%%BeginProlog\n" port)
438 "/lilypond-datadir where {pop} {userdict /lilypond-datadir (~a) put } ifelse"
439 (ly:get-option 'datadir))
444 (format port "\n%%BeginFont: ~a\n" (car f))
445 (display (cdr f) port)
446 (display "\n%%EndFont\n" port))
449 (display (setup-variables paper) port)
451 ;; adobe note 5002: should initialize variables before loading routines.
452 (display (procset "music-drawing-routines.ps") port)
453 (display (procset "lilyponddefs.ps") port)
455 (display "%%EndProlog\n" port)
457 (display "%%BeginSetup\ninit-lilypond-parameters\n%%EndSetup\n\n" port))
459 (define-public (output-framework basename book scopes fields)
460 (let* ((filename (format "~a.ps" basename))
461 (outputter (ly:make-paper-outputter
462 ;; FIXME: better wrap open/open-file,
463 ;; content-mangling is always bad.
464 ;; MINGW hack: need to have "b"inary for embedding CFFs
465 (open-file filename "wb")
467 (paper (ly:paper-book-paper book))
468 (systems (ly:paper-book-systems book))
469 (page-stencils (map page-stencil (ly:paper-book-pages book)))
471 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
472 (page-number (1- (ly:output-def-lookup paper 'first-page-number)))
473 (page-count (length page-stencils))
474 (port (ly:outputter-port outputter)))
477 (if (ly:get-option 'clip-systems)
478 (clip-system-EPSes basename book))
480 (if (ly:get-option 'dump-signatures)
481 (write-system-signatures basename (ly:paper-book-systems book) 1))
483 (output-scopes scopes fields basename)
484 (display (file-header paper page-count #t) port)
486 ;; don't do BeginDefaults PageMedia: A4
487 ;; not necessary and wrong
489 (write-preamble paper #t port)
493 (set! page-number (1+ page-number))
494 (dump-page outputter page page-number page-count landscape?))
497 (display "%%Trailer\n%%EOF\n" port)
498 (ly:outputter-close outputter)
499 (postprocess-output book framework-ps-module filename
500 (ly:output-formats))))
502 (define-public (dump-stencil-as-EPS paper dump-me filename
506 ((xext (ly:stencil-extent dump-me X))
507 (yext (ly:stencil-extent dump-me Y))
508 (padding (ly:get-option 'eps-box-padding))
509 (left-overshoot (if (number? padding)
510 (* -1 padding (ly:output-def-lookup paper 'mm))
515 (if (or (nan? x) (inf? x)
517 (equal? (format #f "~S" x) "+#.#")
518 (equal? (format #f "~S" x) "-#.#"))
521 ;; the left-overshoot is to make sure that
522 ;; bar numbers stick out of margin uniformly.
526 (if (number? left-overshoot)
527 (min left-overshoot (car xext))
529 (car yext) (cdr xext) (cdr yext)))))
531 (dump-stencil-as-EPS-with-bbox paper dump-me filename load-fonts bbox)
535 (define-public (dump-stencil-as-EPS-with-bbox paper dump-me filename
538 (define (to-bp-box mmbox)
539 (let* ((scale (ly:output-def-lookup paper 'output-scale))
542 (if (or (nan? x) (inf? x))
545 (round (/ (* x scale) (ly:bp 1)))))) mmbox)))
549 (max (1+ (car box)) (caddr box))
550 (max (1+ (cadr box)) (cadddr box))
553 (let* ((outputter (ly:make-paper-outputter
554 ;; FIXME: better wrap open/open-file,
555 ;; content-mangling is always bad.
556 ;; MINGW hack: need to have "b"inary for embedding CFFs
557 (open-file (format "~a.eps" filename) "wb")
560 (port (ly:outputter-port outputter))
561 (rounded-bbox (to-bp-box bbox))
562 (port (ly:outputter-port outputter))
563 (header (eps-header paper rounded-bbox load-fonts)))
565 (display header port)
566 (write-preamble paper load-fonts port)
567 (display "gsave set-ps-scale-to-lily-scale \n" port)
568 (ly:outputter-dump-stencil outputter dump-me)
569 (display "stroke grestore\n%%Trailer\n%%EOF\n" port)
570 (ly:outputter-close outputter)))
574 (define (clip-systems-to-region
575 basename paper systems region
579 ((extents-system-pairs
581 (lambda (paper-system)
583 ((x-ext (system-clipped-x-extent
584 (paper-system-system-grob paper-system)
588 (cons x-ext paper-system)
595 (lambda (ext-system-pair)
597 ((xext (car ext-system-pair))
598 (paper-system (cdr ext-system-pair))
599 (yext (paper-system-extent paper-system Y))
600 (bbox (list (car xext) (car yext)
601 (cdr xext) (cdr yext)))
602 (filename (if (< 0 count)
603 (format "~a-~a" basename count)
606 (set! count (1+ count))
607 (dump-stencil-as-EPS-with-bbox
609 (paper-system-stencil paper-system)
611 (ly:get-option 'include-eps-fonts)
615 (postscript->pdf 0 0 (format "~a.eps" filename)))
618 extents-system-pairs)
622 (define-public (clip-system-EPSes basename paper-book)
623 (define do-pdf (member "pdf" (ly:output-formats)))
625 (define (clip-score-systems basename systems)
627 ((layout (ly:grob-layout (paper-system-system-grob (car systems))))
628 (regions (ly:output-def-lookup layout 'clip-regions)))
632 (clip-systems-to-region
633 (format "~a-from-~a-to-~a-clip"
635 (rhythmic-location->file-string (car region))
636 (rhythmic-location->file-string (cdr region)))
637 layout systems region
643 ;; partition in system lists sharing their layout blocks
645 ((systems (ly:paper-book-systems paper-book))
647 (score-system-list '()))
650 (lambda (system last-system)
653 (if (not (and last-system
654 (equal? (paper-system-layout last-system)
655 (paper-system-layout system))))
656 (set! score-system-list (cons '() score-system-list)))
658 (if (paper-system-layout system)
659 (set-car! score-system-list (cons system (car score-system-list))))
668 (lambda (system-list)
671 (format "~a-~a" basename count)
678 (define-public (output-preview-framework basename book scopes fields)
679 (let* ((paper (ly:paper-book-paper book))
680 (systems (ly:paper-book-systems book))
681 (scale (ly:output-def-lookup paper 'output-scale))
682 (to-dump-systems '()))
686 (not (ly:get-option 'include-book-title-preview))
688 (ly:prob-property (car systems) 'is-book-title #f))
690 (set! systems (cdr systems)))
695 (paper-system-title? sys)
696 (not (pair? to-dump-systems))
697 (paper-system-title? (car to-dump-systems)))
698 (set! to-dump-systems (cons sys to-dump-systems))))
703 (stack-stencils Y DOWN 0.0
704 (map paper-system-stencil (reverse to-dump-systems)))
705 (format "~a.preview" basename)
708 (postprocess-output book framework-ps-module
709 (format "~a.preview.eps" basename)
710 (cons "png" (ly:output-formats)))))
713 (define-public (output-preview-framework basename book scopes fields)
715 (let* ((paper (ly:paper-book-paper book))
716 (systems (ly:paper-book-systems book))
717 (scale (ly:output-def-lookup paper 'output-scale))
718 (titles (take-while paper-system-title? systems))
719 (non-title (find (lambda (x)
720 (not (paper-system-title? x))) systems))
722 (stack-stencils Y DOWN 0.0
723 (map paper-system-stencil
724 (append titles (list non-title))))))
725 (output-scopes scopes fields basename)
726 (dump-stencil-as-EPS paper dump-me
727 (format "~a.preview" basename)
730 (postprocess-output book framework-ps-module
731 (format "~a.preview.eps" basename)
732 (ly:output-formats)))))
734 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
736 (define-public (convert-to-pdf book name)
737 (let* ((defs (ly:paper-book-paper book))
738 (landscape (ly:output-def-lookup defs 'landscape))
739 (output-scale (ly:output-def-lookup defs 'output-scale))
740 (convert (lambda (x) (* x output-scale (/ (ly:bp 1)))))
742 (paper-width (convert (ly:output-def-lookup defs 'paper-width)))
743 (paper-height (convert (ly:output-def-lookup defs 'paper-height)))
745 (w (if landscape paper-height paper-width))
746 (h (if landscape paper-width paper-height))
749 (if (equal? (basename name ".ps") "-")
750 (ly:warning (_ "cannot convert <stdout> to ~S" "PDF"))
751 (postscript->pdf w h name))))
753 (define-public (convert-to-png book name)
754 (let* ((defs (ly:paper-book-paper book))
755 (defs-resolution (ly:output-def-lookup defs 'pngresolution))
756 (resolution (if (number? defs-resolution)
758 (ly:get-option 'resolution)))
759 (paper-width (ly:output-def-lookup defs 'paper-width))
760 (paper-height (ly:output-def-lookup defs 'paper-height))
761 (output-scale (ly:output-def-lookup defs 'output-scale)))
763 (postscript->png resolution
764 (* paper-width output-scale (/ (ly:bp 1)))
765 (* paper-height output-scale (/ (ly:bp 1)))
768 (define-public (convert-to-dvi book name)
769 (ly:warning (_ "cannot generate ~S using the postscript back-end") "DVI"))
771 (define-public (convert-to-tex book name)
772 (ly:warning (_ "cannot generate ~S using the postscript back-end") "TeX"))
774 (define-public (convert-to-ps book name)
777 (define-public (output-classic-framework basename book scopes fields)
779 (ly:error (_ "\nThe PostScript backend does not support the system-by-system
780 output. For that, use the EPS backend instead,
782 lilypond -dbackend=eps FILE
784 If have cut & pasted a lilypond fragment from a webpage, be sure
785 to only remove anything before
787 %% ****************************************************************
788 %% Start cut-&-pastable-section
789 %% ****************************************************************