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 string-fun)
20 (define (format dest . rest)
22 (apply simple-format (cons #f (cons dest rest)))
23 (apply simple-format (cons dest rest))))
25 (define framework-ps-module (current-module))
27 ;;(define pdebug stderr)
28 (define (pdebug . rest) #f)
30 (define-public (ps-font-command font)
31 (let* ((name (ly:font-file-name font))
32 (magnify (ly:font-magnification font)))
42 "m" (string-encode-integer (inexact->exact (round (* 1000 magnify)))))))
44 (define (tex-font? fontname)
46 (equal? (substring fontname 0 2) "cm")
47 (equal? (substring fontname 0 2) "ec")))
49 (define (define-fonts paper)
50 (define font-list (ly:paper-fonts paper))
51 (define (define-font command fontname scaling)
53 "/" command " { /" fontname " " (ly:number->string scaling) " output-scale div selectfont } bind def\n"))
55 (define (standard-tex-font? x)
56 (or (equal? (substring x 0 2) "ms")
57 (equal? (substring x 0 2) "cm")))
59 (define (font-load-command font)
60 (let* ((specced-font-name (ly:font-name font))
61 (fontname (if specced-font-name
63 (ly:font-file-name font)))
64 (command (ps-font-command font))
66 ;; FIXME -- see (ps-font-command )
67 (plain (ps-font-command font))
68 (designsize (ly:font-design-size font))
69 (magnification (* (ly:font-magnification font)))
70 (ops (ly:output-def-lookup paper 'output-scale))
71 (scaling (* ops magnification designsize)))
73 ;; Bluesky pfbs have UPCASE names (sigh.)
74 ;; FIXME - don't support Bluesky?
75 (if (standard-tex-font? fontname)
76 (set! fontname (string-upcase fontname)))
77 (if (equal? fontname "unknown")
78 (display (list font fontname)))
79 (define-font plain fontname scaling)))
82 (map (lambda (x) (font-load-command x))
83 (filter (lambda (x) (not (ly:pango-font? x)))
86 ;; FIXME: duplicated in other output backends
87 ;; FIXME: silly interface name
88 (define (output-variables layout)
89 ;; FIXME: duplicates output-layout's scope-entry->string, mostly
90 (define (value->string val)
92 ((string? val) (string-append "(" val ")"))
93 ((symbol? val) (symbol->string val))
94 ((number? val) (number->string val))
97 (define (output-entry ps-key ly-key)
100 (value->string (ly:output-def-lookup layout ly-key)) " def\n"))
103 "/lily-output-units "
104 (number->string (/ (ly:bp 1)))
105 " def %% millimeter\n"
106 (output-entry "staff-line-thickness" 'line-thickness)
107 (output-entry "line-width" 'line-width)
108 (output-entry "paper-size" 'papersizename)
109 (output-entry "staff-height" 'staff-height) ;junkme.
111 (number->string (ly:output-def-lookup layout 'output-scale))
113 (output-entry "page-height" 'paper-height)
114 (output-entry "page-width" 'paper-width)))
116 (define (dump-page outputter page page-number page-count landscape?)
117 (ly:outputter-dump-string
120 (format "%%Page: ~a ~a\n" page-number page-number)
123 "page-width output-scale lily-output-units mul mul 0 translate 90 rotate\n"
127 "true setstrokeadjust\n"
128 "gsave 0 paper-height translate "
129 "set-ps-scale-to-lily-scale "
131 (ly:outputter-dump-stencil outputter page)
132 (ly:outputter-dump-string outputter "stroke grestore \nshowpage\n"))
134 (define (supplies-or-needs paper load-fonts?)
135 (define (extract-names font)
136 (if (ly:pango-font? font)
137 (map car (ly:pango-font-physical-fonts font))
138 (list (ly:font-name font))))
140 (let* ((fonts (ly:paper-fonts paper))
141 (names (apply append (map extract-names fonts))))
147 "%%DocumentSuppliedResources: font ~a\n"
148 "%%DocumentNeededResources: font ~a\n")
150 (uniq-list (sort names string<?))))))
152 (define (eps-header paper bbox load-fonts?)
153 (string-append "%!PS-Adobe-2.0 EPSF-2.0\n"
154 "%%Creator: LilyPond "
158 (string-join (map ly:number->string bbox) " ") "\n"
160 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
163 (supplies-or-needs paper load-fonts?)
166 (define (ps-document-media paper)
168 (ly:output-def-lookup paper 'output-scale)
169 (ly:output-def-lookup paper 'paper-width)) (ly:bp 1)))
171 (ly:output-def-lookup paper 'paper-height)
172 (ly:output-def-lookup paper 'output-scale))
174 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t)))
175 (format "%%DocumentMedia: ~a ~a ~a ~a ~a ~a\n"
176 (ly:output-def-lookup paper 'papersizename)
177 (round2 (if landscape? h w))
178 (round2 (if landscape? w h))
185 (define (file-header paper page-count load-fonts?)
186 (string-append "%!PS-Adobe-3.0\n"
187 "%%Creator: LilyPond "
191 "%%Pages: " (number->string page-count) "\n"
192 "%%PageOrder: Ascend\n"
194 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
197 (ps-document-media paper)
198 (supplies-or-needs paper load-fonts?)
201 (define (procset file-name)
203 "%%BeginResource: procset (~a) 1 0
207 file-name (cached-file-contents file-name)))
209 (define (embed-document file-name)
210 (format "%%BeginDocument: ~a
214 file-name (cached-file-contents file-name)))
216 (define (setup-variables paper)
220 (output-variables paper)
223 (define (cff-font? font)
225 ((cff-string (ly:otf-font-table-data font "CFF ")))
226 (> (string-length cff-string) 0)))
228 (define-public (ps-embed-cff body font-set-name version)
231 (format "/~a ~s StartData " font-set-name (string-length body))
236 "%%BeginResource: font ~a
237 %!PS-Adobe-3.0 Resource-FontSet
238 %%DocumentNeededResources: ProcSet (FontSetInit)
239 %%Title: (FontSet/~a)
242 %%IncludeResource: ProcSet (FontSetInit)
243 %%BeginResource: FontSet (~a)
244 /FontSetInit /ProcSet findresource begin
245 %%BeginData: ~s Binary Bytes
247 font-set-name font-set-name version font-set-name
248 (string-length binary-data)))
259 (define (write-preamble paper load-fonts? port)
261 (define (load-font-via-GS font-name-filename)
262 (define (ps-load-file name)
265 "(~a) (r) file .loadfont\n"
266 "% cannot find font file: ~a\n")
269 (let* ((font (car font-name-filename))
270 (name (cadr font-name-filename))
271 (file-name (caddr font-name-filename))
272 (bare-file-name (ly:find-file file-name)))
277 (if (mac-font? bare-file-name)
278 (handle-mac-font name bare-file-name)
280 ((or (string-startswith file-name "Emmentaler")
281 (string-startswith file-name "emmentaler")
282 (string-startswith file-name "aybabtu")
283 (string-startswith file-name "Aybabtu"))
284 (ps-load-file (ly:find-file
285 (format "~a.otf" file-name))))
286 ((string? bare-file-name)
287 (ps-load-file file-name))
289 (ly:warning (_ "cannot embed ~S=~S") name file-name)
294 (define (dir-join a b)
297 (string-append a "/" b)))
299 (define (dir-listing dir-name)
300 (define (dir-helper dir lst)
301 (let ((e (readdir dir)))
302 (if (eof-object? e) lst (dir-helper dir (cons e lst)))))
303 (reverse (dir-helper (opendir dir-name) '())))
305 (define (handle-mac-font name filename)
312 (mkdir dir-name #o700)
313 (set! status (ly:system
314 (format "cd ~a && fondu -force '~a'" dir-name filename)))
316 (set! files (dir-listing dir-name))
321 ((full-name (dir-join dir-name f)))
324 (equal? 'regular (stat:type (stat full-name)))
325 (equal? name (ly:ttf-ps-name full-name)))
328 (font-file-as-ps-string name full-name)))
330 (if (or (equal? "." f)
333 (delete-file full-name))))
341 (set! embed "% failed \n")
342 (ly:warning (_ "cannot extract file matching ~a from ~a") name filename)))
345 (define (font-file-as-ps-string name file-name)
347 ((downcase-file-name (string-downcase file-name)))
350 ((and file-name (string-endswith downcase-file-name ".pfa"))
351 (embed-document file-name))
352 ((and file-name (string-endswith downcase-file-name ".pfb"))
353 (ly:pfb->pfa file-name))
354 ((and file-name (string-endswith downcase-file-name ".ttf"))
355 (ly:ttf->pfa file-name))
356 ((and file-name (string-endswith downcase-file-name ".otf"))
357 (ps-embed-cff (ly:otf->cff file-name) name 0))
359 (ly:warning (_ "do not know how to embed ~S=~S") name file-name)
362 (define (mac-font? bare-file-name)
364 (eq? PLATFORM 'darwin)
367 (string-endswith bare-file-name ".dfont")
368 (= (stat:size (stat bare-file-name)) 0))))
370 (define (load-font font-name-filename)
371 (let* ((font (car font-name-filename))
372 (name (cadr font-name-filename))
373 (file-name (caddr font-name-filename))
374 (bare-file-name (ly:find-file file-name)))
380 ((mac-font? bare-file-name)
381 (handle-mac-font name bare-file-name))
383 ((and font (cff-font? font))
384 (ps-embed-cff (ly:otf-font-table-data font "CFF ")
388 (bare-file-name (font-file-as-ps-string name bare-file-name))
390 (ly:warning (_ "do not know how to embed font ~s ~s ~s")
391 name file-name font))))))
394 (define (load-fonts paper)
395 (let* ((fonts (ly:paper-fonts paper))
400 ((string? (ly:font-file-name font))
404 (ly:font-file-name font))))
405 ((ly:pango-font? font)
407 (lambda (name-psname-pair)
409 (car name-psname-pair)
410 (cdr name-psname-pair)))
411 (ly:pango-font-physical-fonts font)))
414 (ly:font-sub-fonts font))))
419 (sort (apply append all-font-names)
420 (lambda (x y) (string<? (cadr x) (cadr y))))))
422 (font-loader (if (ly:get-option 'gs-load-fonts)
426 (pfas (map font-loader font-names)))
429 (display "%%BeginProlog\n" port)
433 (format port "\n%%BeginFont: ~a\n" (car f))
434 (display (cdr f) port)
435 (display "\n%%EndFont\n" port))
438 (display (setup-variables paper) port)
440 ;; adobe note 5002: should initialize variables before loading routines.
441 (display (procset "music-drawing-routines.ps") port)
442 (display (procset "lilyponddefs.ps") port)
444 (if (not (ly:get-option 'point-and-click))
445 (display "/mark_URI { pop pop pop pop pop } bind def\n" port))
447 (display "%%EndProlog\n" port)
449 (display "%%BeginSetup\ninit-lilypond-parameters\n%%EndSetup\n\n" port))
451 (define-public (output-framework basename book scopes fields)
452 (let* ((filename (format "~a.ps" basename))
453 (outputter (ly:make-paper-outputter
454 ;; FIXME: better wrap open/open-file,
455 ;; content-mangling is always bad.
456 ;; MINGW hack: need to have "b"inary for embedding CFFs
457 (open-file filename "wb")
459 (paper (ly:paper-book-paper book))
460 (systems (ly:paper-book-systems book))
461 (page-stencils (map page-stencil (ly:paper-book-pages book)))
463 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
464 (page-number (1- (ly:output-def-lookup paper 'first-page-number)))
465 (page-count (length page-stencils))
466 (port (ly:outputter-port outputter)))
469 (if (ly:get-option 'clip-systems)
470 (clip-system-EPSes basename book))
472 (if (ly:get-option 'dump-signatures)
473 (write-system-signatures basename (ly:paper-book-systems book) 1))
475 (output-scopes scopes fields basename)
476 (display (file-header paper page-count #t) port)
478 ;; don't do BeginDefaults PageMedia: A4
479 ;; not necessary and wrong
481 (write-preamble paper #t port)
485 (set! page-number (1+ page-number))
486 (dump-page outputter page page-number page-count landscape?))
489 (display "%%Trailer\n%%EOF\n" port)
490 (ly:outputter-close outputter)
491 (postprocess-output book framework-ps-module filename
492 (ly:output-formats))))
494 (define-public (dump-stencil-as-EPS paper dump-me filename
498 ((xext (ly:stencil-extent dump-me X))
499 (yext (ly:stencil-extent dump-me Y))
500 (padding (ly:get-option 'eps-box-padding))
501 (left-overshoot (if (number? padding)
502 (* -1 padding (ly:output-def-lookup paper 'mm))
507 (if (or (nan? x) (inf? x)
509 (equal? (format #f "~S" x) "+#.#")
510 (equal? (format #f "~S" x) "-#.#"))
513 ;; the left-overshoot is to make sure that
514 ;; bar numbers stick out of margin uniformly.
518 (if (number? left-overshoot)
519 (min left-overshoot (car xext))
521 (car yext) (cdr xext) (cdr yext)))))
523 (dump-stencil-as-EPS-with-bbox paper dump-me filename load-fonts bbox)
527 (define-public (dump-stencil-as-EPS-with-bbox paper dump-me filename
530 (define (to-bp-box mmbox)
531 (let* ((scale (ly:output-def-lookup paper 'output-scale))
534 (if (or (nan? x) (inf? x))
537 (round (/ (* x scale) (ly:bp 1)))))) mmbox)))
541 (max (1+ (car box)) (caddr box))
542 (max (1+ (cadr box)) (cadddr box))
545 (let* ((outputter (ly:make-paper-outputter
546 ;; FIXME: better wrap open/open-file,
547 ;; content-mangling is always bad.
548 ;; MINGW hack: need to have "b"inary for embedding CFFs
549 (open-file (format "~a.eps" filename) "wb")
552 (port (ly:outputter-port outputter))
553 (rounded-bbox (to-bp-box bbox))
554 (port (ly:outputter-port outputter))
555 (header (eps-header paper rounded-bbox load-fonts)))
557 (display header port)
558 (write-preamble paper load-fonts port)
559 (display "gsave set-ps-scale-to-lily-scale \n" port)
560 (ly:outputter-dump-stencil outputter dump-me)
561 (display "stroke grestore\n%%Trailer\n%%EOF\n" port)
562 (ly:outputter-close outputter)))
566 (define (clip-systems-to-region
567 basename paper systems region
571 ((extents-system-pairs
573 (lambda (paper-system)
575 ((x-ext (system-clipped-x-extent
576 (paper-system-system-grob paper-system)
580 (cons x-ext paper-system)
587 (lambda (ext-system-pair)
589 ((xext (car ext-system-pair))
590 (paper-system (cdr ext-system-pair))
591 (yext (paper-system-extent paper-system Y))
592 (bbox (list (car xext) (car yext)
593 (cdr xext) (cdr yext)))
594 (filename (if (< 0 count)
595 (format "~a-~a" basename count)
598 (set! count (1+ count))
599 (dump-stencil-as-EPS-with-bbox
601 (paper-system-stencil paper-system)
603 (ly:get-option 'include-eps-fonts)
607 (postscript->pdf 0 0 (format "~a.eps" filename)))
610 extents-system-pairs)
614 (define (clip-system-EPSes basename paper-book)
615 (define do-pdf (member "pdf" (ly:output-formats)))
617 (define (clip-score-systems basename systems)
619 ((layout (ly:grob-layout (paper-system-system-grob (car systems))))
620 (regions (ly:output-def-lookup layout 'clip-regions)))
624 (clip-systems-to-region
625 (format "~a-from-~a-to-~a-clip"
627 (rhythmic-location->file-string (car region))
628 (rhythmic-location->file-string (cdr region)))
629 layout systems region
635 ;; partition in system lists sharing their layout blocks
637 ((systems (ly:paper-book-systems paper-book))
639 (score-system-list '()))
642 (lambda (system last-system)
645 (if (not (and last-system
646 (equal? (paper-system-layout last-system)
647 (paper-system-layout system))))
648 (set! score-system-list (cons '() score-system-list)))
650 (if (paper-system-layout system)
651 (set-car! score-system-list (cons system (car score-system-list))))
660 (lambda (system-list)
663 (format "~a-~a" basename count)
670 (define-public (output-preview-framework basename book scopes fields)
671 (let* ((paper (ly:paper-book-paper book))
672 (systems (ly:paper-book-systems book))
673 (scale (ly:output-def-lookup paper 'output-scale))
674 (to-dump-systems '()))
678 (not (ly:get-option 'include-book-title-preview))
680 (ly:prob-property (car systems) 'is-book-title #f))
682 (set! systems (cdr systems)))
687 (paper-system-title? sys)
688 (not (pair? to-dump-systems))
689 (paper-system-title? (car to-dump-systems)))
690 (set! to-dump-systems (cons sys to-dump-systems))))
695 (stack-stencils Y DOWN 0.0
696 (map paper-system-stencil (reverse to-dump-systems)))
697 (format "~a.preview" basename)
700 (postprocess-output book framework-ps-module
701 (format "~a.preview.eps" basename)
702 (cons "png" (ly:output-formats)))))
705 (define-public (output-preview-framework basename book scopes fields)
707 (let* ((paper (ly:paper-book-paper book))
708 (systems (ly:paper-book-systems book))
709 (scale (ly:output-def-lookup paper 'output-scale))
710 (titles (take-while paper-system-title? systems))
711 (non-title (find (lambda (x)
712 (not (paper-system-title? x))) systems))
714 (stack-stencils Y DOWN 0.0
715 (map paper-system-stencil
716 (append titles (list non-title))))))
717 (output-scopes scopes fields basename)
718 (dump-stencil-as-EPS paper dump-me
719 (format "~a.preview" basename)
722 (postprocess-output book framework-ps-module
723 (format "~a.preview.eps" basename)
724 (ly:output-formats)))))
726 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
728 (define-public (convert-to-pdf book name)
729 (let* ((defs (ly:paper-book-paper book))
730 (landscape (ly:output-def-lookup defs 'landscape))
731 (output-scale (ly:output-def-lookup defs 'output-scale))
732 (convert (lambda (x) (* x output-scale (/ (ly:bp 1)))))
734 (paper-width (convert (ly:output-def-lookup defs 'paper-width)))
735 (paper-height (convert (ly:output-def-lookup defs 'paper-height)))
737 (w (if landscape paper-height paper-width))
738 (h (if landscape paper-width paper-height))
741 (if (equal? (basename name ".ps") "-")
742 (ly:warning (_ "cannot convert <stdout> to ~S" "PDF"))
743 (postscript->pdf w h name))))
745 (define-public (convert-to-png book name)
746 (let* ((defs (ly:paper-book-paper book))
747 (defs-resolution (ly:output-def-lookup defs 'pngresolution))
748 (resolution (if (number? defs-resolution)
750 (ly:get-option 'resolution)))
751 (paper-width (ly:output-def-lookup defs 'paper-width))
752 (paper-height (ly:output-def-lookup defs 'paper-height))
753 (output-scale (ly:output-def-lookup defs 'output-scale)))
755 (postscript->png resolution
756 (* paper-width output-scale (/ (ly:bp 1)))
757 (* paper-height output-scale (/ (ly:bp 1)))
760 (define-public (convert-to-dvi book name)
761 (ly:warning (_ "cannot generate ~S using the postscript back-end") "DVI"))
763 (define-public (convert-to-tex book name)
764 (ly:warning (_ "cannot generate ~S using the postscript back-end") "TeX"))
766 (define-public (convert-to-ps book name)
769 (define-public (output-classic-framework basename book scopes fields)
771 (ly:error (_ "\nThe PostScript backend does not support the system-by-system
772 output. For that, use the EPS backend instead,
774 lilypond -b eps <file>
776 If have cut & pasted a lilypond fragment from a webpage, be sure
777 to only remove anything before
779 %% ****************************************************************
780 %% Start cut-&-pastable-section
781 %% ****************************************************************