1 ;;;; framework-ps.scm -- structure for PostScript output
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 2004--2008 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)))
38 "m" (string-encode-integer (inexact->exact (round (* 1000 magnify)))))))
40 (define (define-fonts paper)
41 (define font-list (ly:paper-fonts paper))
43 (define (define-font command fontname scaling)
47 " " (ly:number->string scaling) " output-scale div selectfont }"
50 (define (font-load-command font)
51 (let* ((specced-font-name (ly:font-name font))
52 (fontname (if specced-font-name
54 (ly:font-file-name font)))
55 (command (ps-font-command font))
57 ;; FIXME -- see (ps-font-command)
58 (plain (ps-font-command font))
59 (designsize (ly:font-design-size font))
60 (magnification (* (ly:font-magnification font)))
61 (ops (ly:output-def-lookup paper 'output-scale))
62 (scaling (* ops magnification designsize)))
63 (if (equal? fontname "unknown")
64 (display (list font fontname)))
65 (define-font plain fontname scaling)))
68 (map (lambda (x) (font-load-command x))
69 (filter (lambda (x) (not (ly:pango-font? x)))
72 ;; FIXME: duplicated in other output backends
73 ;; FIXME: silly interface name
74 (define (output-variables layout)
75 ;; FIXME: duplicates output-layout's scope-entry->string, mostly
76 (define (value->string val)
78 ((string? val) (string-append "(" val ")"))
79 ((symbol? val) (symbol->string val))
80 ((number? val) (number->string val))
83 (define (output-entry ps-key ly-key)
86 (value->string (ly:output-def-lookup layout ly-key)) " def\n"))
90 (number->string (/ (ly:bp 1))) " def %% millimeter\n"
91 (output-entry "staff-line-thickness" 'line-thickness)
92 (output-entry "line-width" 'line-width)
93 (output-entry "paper-size" 'papersizename)
94 (output-entry "staff-height" 'staff-height) ;junkme.
96 (number->string (ly:output-def-lookup layout 'output-scale)) " def\n"
97 (output-entry "page-height" 'paper-height)
98 (output-entry "page-width" 'paper-width)))
100 (define (dump-page outputter page page-number page-count landscape?)
101 (ly:outputter-dump-string
104 (format "%%Page: ~a ~a\n" page-number page-number)
107 "page-width output-scale lily-output-units mul mul 0 translate 90 rotate\n"
111 "true setstrokeadjust\n"
112 "gsave 0 paper-height translate set-ps-scale-to-lily-scale\n"))
113 (ly:outputter-dump-stencil outputter page)
114 (ly:outputter-dump-string outputter "stroke grestore\nshowpage\n"))
116 (define (supplies-or-needs paper load-fonts?)
117 (define (extract-names font)
118 (if (ly:pango-font? font)
119 (map car (ly:pango-font-physical-fonts font))
120 (list (ly:font-name font))))
122 (let* ((fonts (ly:paper-fonts paper))
123 (names (apply append (map extract-names fonts))))
128 "%%DocumentSuppliedResources: font ~a\n"
129 "%%DocumentNeededResources: font ~a\n")
131 (uniq-list (sort names string<?))))))
133 (define (eps-header paper bbox load-fonts?)
134 (string-append "%!PS-Adobe-2.0 EPSF-2.0\n"
135 "%%Creator: LilyPond " (lilypond-version) "\n"
137 (string-join (map ly:number->string bbox) " ") "\n"
139 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
142 (supplies-or-needs paper load-fonts?)
145 (define (ps-document-media paper)
147 (ly:output-def-lookup paper 'output-scale)
148 (ly:output-def-lookup paper 'paper-width)) (ly:bp 1)))
150 (ly:output-def-lookup paper 'paper-height)
151 (ly:output-def-lookup paper 'output-scale))
153 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t)))
154 (ly:format "%%DocumentMedia: ~a ~2f ~2f ~a ~a ~a\n"
155 (ly:output-def-lookup paper 'papersizename)
163 (define (file-header paper page-count load-fonts?)
164 (string-append "%!PS-Adobe-3.0\n"
165 "%%Creator: LilyPond " (lilypond-version) "\n"
166 "%%Pages: " (number->string page-count) "\n"
167 "%%PageOrder: Ascend\n"
169 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
172 (ps-document-media paper)
173 (supplies-or-needs paper load-fonts?)
176 (define (procset file-name)
178 "%%BeginResource: procset (~a) 1 0
182 file-name (cached-file-contents file-name)))
184 (define (embed-document file-name)
185 (format "%%BeginDocument: ~a
189 file-name (cached-file-contents file-name)))
191 (define (setup-variables paper)
195 (output-variables paper)))
197 (define (cff-font? font)
198 (let* ((cff-string (ly:otf-font-table-data font "CFF ")))
199 (> (string-length cff-string) 0)))
201 (define-public (ps-embed-cff body font-set-name version)
204 (format "/~a ~s StartData " font-set-name (string-length body))
208 "%%BeginResource: font ~a
209 %!PS-Adobe-3.0 Resource-FontSet
210 %%DocumentNeededResources: ProcSet (FontSetInit)
211 %%Title: (FontSet/~a)
214 %%IncludeResource: ProcSet (FontSetInit)
215 %%BeginResource: FontSet (~a)
216 /FontSetInit /ProcSet findresource begin
217 %%BeginData: ~s Binary Bytes
219 font-set-name font-set-name version font-set-name
220 (string-length binary-data)))
224 (string-append header
228 (define (write-preamble paper load-fonts? port)
229 (define (internal-font? file-name)
230 (or (string-startswith file-name "Emmentaler")
231 (string-startswith file-name "emmentaler")
232 (string-startswith file-name "aybabtu")
233 (string-startswith file-name "Aybabtu")))
235 (define (load-font-via-GS font-name-filename)
236 (define (ps-load-file file-name)
237 (if (string? file-name)
238 (if (string-contains file-name (ly:get-option 'datadir))
240 (set! file-name (ly:string-substitute (ly:get-option 'datadir)
243 "lilypond-datadir (~a) concatstrings (r) file .loadfont"
245 (format "(~a) (r) file .loadfont\n" file-name))
246 (format "% cannot find font file: ~a\n" file-name)))
248 (let* ((font (car font-name-filename))
249 (name (cadr font-name-filename))
250 (file-name (caddr font-name-filename))
251 (bare-file-name (ly:find-file file-name)))
253 (if (mac-font? bare-file-name)
254 (handle-mac-font name bare-file-name)
256 ((internal-font? file-name)
257 (ps-load-file (ly:find-file
258 (format "~a.otf" file-name))))
259 ((string? bare-file-name)
260 (ps-load-file file-name))
262 (ly:warning (_ "cannot embed ~S=~S") name file-name)
265 (define (dir-join a b)
268 (string-append a "/" b)))
270 (define (dir-listing dir-name)
271 (define (dir-helper dir lst)
272 (let ((e (readdir dir)))
275 (dir-helper dir (cons e lst)))))
276 (reverse (dir-helper (opendir dir-name) '())))
278 (define (handle-mac-font name filename)
279 (let* ((dir-name (tmpnam))
283 (mkdir dir-name #o700)
284 (set! status (ly:system
285 (format "cd ~a && fondu -force '~a'" dir-name filename)))
286 (set! files (dir-listing dir-name))
289 (let* ((full-name (dir-join dir-name f)))
291 (equal? 'regular (stat:type (stat full-name)))
292 (equal? name (ly:ttf-ps-name full-name)))
293 (set! embed (font-file-as-ps-string name full-name)))
294 (if (or (equal? "." f)
297 (delete-file full-name))))
302 (set! embed "% failed\n")
303 (ly:warning (_ "cannot extract file matching ~a from ~a")
307 (define (font-file-as-ps-string name file-name)
308 (let* ((downcase-file-name (string-downcase file-name)))
310 ((and file-name (string-endswith downcase-file-name ".pfa"))
311 (embed-document file-name))
312 ((and file-name (string-endswith downcase-file-name ".pfb"))
313 (ly:pfb->pfa file-name))
314 ((and file-name (string-endswith downcase-file-name ".ttf"))
315 (ly:ttf->pfa file-name))
316 ((and file-name (string-endswith downcase-file-name ".ttc"))
317 (ly:ttf->pfa file-name))
318 ((and file-name (string-endswith downcase-file-name ".otf"))
319 (ps-embed-cff (ly:otf->cff file-name) name 0))
321 (ly:warning (_ "do not know how to embed ~S=~S") name file-name)
324 (define (mac-font? bare-file-name)
325 (and (eq? PLATFORM 'darwin)
327 (or (string-endswith bare-file-name ".dfont")
328 (= (stat:size (stat bare-file-name)) 0))))
330 (define (load-font font-name-filename)
331 (let* ((font (car font-name-filename))
332 (name (cadr font-name-filename))
333 (file-name (caddr font-name-filename))
334 (bare-file-name (ly:find-file file-name)))
336 (cond ((mac-font? bare-file-name)
337 (handle-mac-font name bare-file-name))
338 ((and font (cff-font? font))
339 (ps-embed-cff (ly:otf-font-table-data font "CFF ")
342 (bare-file-name (font-file-as-ps-string
343 name bare-file-name))
345 (ly:warning (_ "do not know how to embed font ~s ~s ~s")
346 name file-name font))))))
348 (define (load-fonts paper)
349 (let* ((fonts (ly:paper-fonts paper))
351 ;; todo - doc format of list.
355 (cond ((string? (ly:font-file-name font))
358 (ly:font-file-name font))))
359 ((ly:pango-font? font)
360 (map (lambda (name-psname-pair)
362 (car name-psname-pair)
363 (cdr name-psname-pair)))
364 (ly:pango-font-physical-fonts font)))
366 (ly:font-sub-fonts font))))
368 (font-names (uniq-list
369 (sort (apply append all-font-names)
370 (lambda (x y) (string<? (cadr x) (cadr y))))))
372 ;; slightly spaghetti-ish: deciding what to load where
376 (cond ((ly:get-option 'gs-load-fonts)
377 (load-font-via-GS name))
378 ((ly:get-option 'gs-load-lily-fonts)
379 (if (or (string-contains (caddr name)
380 (ly:get-option 'datadir))
381 (internal-font? (caddr name)))
382 (load-font-via-GS name)
386 (pfas (map font-loader font-names)))
389 (display "%%BeginProlog\n" port)
392 "/lilypond-datadir where {pop} {userdict /lilypond-datadir (~a) put } ifelse"
393 (ly:get-option 'datadir))
395 (for-each (lambda (f)
396 (format port "\n%%BeginFont: ~a\n" (car f))
397 (display (cdr f) port)
398 (display "\n%%EndFont\n" port))
400 (display (setup-variables paper) port)
402 ;; adobe note 5002: should initialize variables before loading routines.
403 (display (procset "music-drawing-routines.ps") port)
404 (display (procset "lilyponddefs.ps") port)
405 (display "%%EndProlog\n" port)
406 (display "%%BeginSetup\ninit-lilypond-parameters\n%%EndSetup\n\n" port))
408 (define-public (output-framework basename book scopes fields)
409 (let* ((filename (format "~a.ps" basename))
410 (outputter (ly:make-paper-outputter
411 ;; FIXME: better wrap open/open-file,
412 ;; content-mangling is always bad.
413 ;; MINGW hack: need to have "b"inary for embedding CFFs
414 (open-file filename "wb")
416 (paper (ly:paper-book-paper book))
417 (systems (ly:paper-book-systems book))
418 (page-stencils (map page-stencil (ly:paper-book-pages book)))
420 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
421 (page-number (1- (ly:output-def-lookup paper 'first-page-number)))
422 (page-count (length page-stencils))
423 (port (ly:outputter-port outputter)))
426 (if (ly:get-option 'clip-systems)
427 (clip-system-EPSes basename book))
429 (if (ly:get-option 'dump-signatures)
430 (write-system-signatures basename (ly:paper-book-systems book) 1))
432 (output-scopes scopes fields basename)
433 (display (file-header paper page-count #t) port)
435 ;; don't do BeginDefaults PageMedia: A4
436 ;; not necessary and wrong
438 (write-preamble paper #t port)
442 (set! page-number (1+ page-number))
443 (dump-page outputter page page-number page-count landscape?))
446 (display "%%Trailer\n%%EOF\n" port)
447 (ly:outputter-close outputter)
448 (postprocess-output book framework-ps-module filename
449 (ly:output-formats))))
451 (define-public (dump-stencil-as-EPS paper dump-me filename
455 ((xext (ly:stencil-extent dump-me X))
456 (yext (ly:stencil-extent dump-me Y))
457 (padding (ly:get-option 'eps-box-padding))
458 (left-overshoot (if (number? padding)
459 (* -1 padding (ly:output-def-lookup paper 'mm))
464 (if (or (nan? x) (inf? x)
466 (equal? (format #f "~S" x) "+#.#")
467 (equal? (format #f "~S" x) "-#.#"))
470 ;; the left-overshoot is to make sure that
471 ;; bar numbers stick out of margin uniformly.
475 (if (number? left-overshoot)
476 (min left-overshoot (car xext))
478 (car yext) (cdr xext) (cdr yext)))))
480 (dump-stencil-as-EPS-with-bbox paper dump-me filename load-fonts bbox)
484 (define-public (dump-stencil-as-EPS-with-bbox paper dump-me filename
487 "Create an EPS file from stencil DUMP-ME to FILENAME. BBOX has format
488 (left-x, lower-y, right x, up-y). If LOAD-FONTS set, include fonts inline."
490 (define (to-rounded-bp-box box)
491 "Convert box to 1/72 inch with rounding to enlarge the box."
492 (let* ((scale (ly:output-def-lookup paper 'output-scale))
493 (strip-non-number (lambda (x)
494 (if (or (nan? x) (inf? x)) 0.0 x)))
495 (directed-round (lambda (x rounder)
497 (rounder (/ (* (strip-non-number x) scale)
499 (list (directed-round (car box) floor)
500 (directed-round (cadr box) floor)
501 (directed-round (max (1+ (car box)) (caddr box)) ceiling)
502 (directed-round (max (1+ (cadr box)) (cadddr box)) ceiling)
505 (let* ((outputter (ly:make-paper-outputter
506 ;; FIXME: better wrap open/open-file,
507 ;; content-mangling is always bad.
508 ;; MINGW hack: need to have "b"inary for embedding CFFs
509 (open-file (format "~a.eps" filename) "wb")
512 (port (ly:outputter-port outputter))
513 (rounded-bbox (to-rounded-bp-box bbox))
514 (port (ly:outputter-port outputter))
515 (header (eps-header paper rounded-bbox load-fonts)))
517 (display header port)
518 (write-preamble paper load-fonts port)
519 (display "gsave set-ps-scale-to-lily-scale\n" port)
520 (ly:outputter-dump-stencil outputter dump-me)
521 (display "stroke grestore\n%%Trailer\n%%EOF\n" port)
522 (ly:outputter-close outputter)))
526 (define (clip-systems-to-region
527 basename paper systems region
531 ((extents-system-pairs
533 (lambda (paper-system)
535 ((x-ext (system-clipped-x-extent
536 (paper-system-system-grob paper-system)
540 (cons x-ext paper-system)
547 (lambda (ext-system-pair)
549 ((xext (car ext-system-pair))
550 (paper-system (cdr ext-system-pair))
551 (yext (paper-system-extent paper-system Y))
552 (bbox (list (car xext) (car yext)
553 (cdr xext) (cdr yext)))
554 (filename (if (< 0 count)
555 (format "~a-~a" basename count)
558 (set! count (1+ count))
559 (dump-stencil-as-EPS-with-bbox
561 (paper-system-stencil paper-system)
563 (ly:get-option 'include-eps-fonts)
567 (postscript->pdf 0 0 (format "~a.eps" filename)))
570 extents-system-pairs)
574 (define-public (clip-system-EPSes basename paper-book)
575 (define do-pdf (member "pdf" (ly:output-formats)))
577 (define (clip-score-systems basename systems)
579 ((layout (ly:grob-layout (paper-system-system-grob (car systems))))
580 (regions (ly:output-def-lookup layout 'clip-regions)))
584 (clip-systems-to-region
585 (format "~a-from-~a-to-~a-clip"
587 (rhythmic-location->file-string (car region))
588 (rhythmic-location->file-string (cdr region)))
589 layout systems region
595 ;; partition in system lists sharing their layout blocks
597 ((systems (ly:paper-book-systems paper-book))
599 (score-system-list '()))
602 (lambda (system last-system)
605 (if (not (and last-system
606 (equal? (paper-system-layout last-system)
607 (paper-system-layout system))))
608 (set! score-system-list (cons '() score-system-list)))
610 (if (paper-system-layout system)
611 (set-car! score-system-list (cons system (car score-system-list))))
620 (lambda (system-list)
623 (format "~a-~a" basename count)
630 (define-public (output-preview-framework basename book scopes fields)
631 (let* ((paper (ly:paper-book-paper book))
632 (systems (ly:paper-book-systems book))
633 (scale (ly:output-def-lookup paper 'output-scale))
634 (to-dump-systems '()))
638 (not (ly:get-option 'include-book-title-preview))
640 (ly:prob-property (car systems) 'is-book-title #f))
642 (set! systems (cdr systems)))
647 (paper-system-title? sys)
648 (not (pair? to-dump-systems))
649 (paper-system-title? (car to-dump-systems)))
650 (set! to-dump-systems (cons sys to-dump-systems))))
655 (stack-stencils Y DOWN 0.0
656 (map paper-system-stencil (reverse to-dump-systems)))
657 (format "~a.preview" basename)
660 (postprocess-output book framework-ps-module
661 (format "~a.preview.eps" basename)
662 (cons "png" (ly:output-formats)))))
665 (define-public (output-preview-framework basename book scopes fields)
667 (let* ((paper (ly:paper-book-paper book))
668 (systems (ly:paper-book-systems book))
669 (scale (ly:output-def-lookup paper 'output-scale))
670 (titles (take-while paper-system-title? systems))
671 (non-title (find (lambda (x)
672 (not (paper-system-title? x))) systems))
674 (stack-stencils Y DOWN 0.0
675 (map paper-system-stencil
676 (append titles (list non-title))))))
677 (output-scopes scopes fields basename)
678 (dump-stencil-as-EPS paper dump-me
679 (format "~a.preview" basename)
682 (postprocess-output book framework-ps-module
683 (format "~a.preview.eps" basename)
684 (ly:output-formats)))))
686 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
688 (define-public (convert-to-pdf book name)
689 (let* ((defs (ly:paper-book-paper book))
690 (landscape (ly:output-def-lookup defs 'landscape))
691 (output-scale (ly:output-def-lookup defs 'output-scale))
692 (convert (lambda (x) (* x output-scale (/ (ly:bp 1)))))
694 (paper-width (convert (ly:output-def-lookup defs 'paper-width)))
695 (paper-height (convert (ly:output-def-lookup defs 'paper-height)))
697 (w (if landscape paper-height paper-width))
698 (h (if landscape paper-width paper-height))
701 (if (equal? (basename name ".ps") "-")
702 (ly:warning (_ "cannot convert <stdout> to ~S" "PDF"))
703 (postscript->pdf w h name))))
705 (define-public (convert-to-png book name)
706 (let* ((defs (ly:paper-book-paper book))
707 (defs-resolution (ly:output-def-lookup defs 'pngresolution))
708 (resolution (if (number? defs-resolution)
710 (ly:get-option 'resolution)))
711 (paper-width (ly:output-def-lookup defs 'paper-width))
712 (paper-height (ly:output-def-lookup defs 'paper-height))
713 (output-scale (ly:output-def-lookup defs 'output-scale)))
715 (postscript->png resolution
716 (* paper-width output-scale (/ (ly:bp 1)))
717 (* paper-height output-scale (/ (ly:bp 1)))
720 (define-public (convert-to-ps book name)
723 (define-public (output-classic-framework basename book scopes fields)
725 (ly:error (_ "\nThe PostScript backend does not support the system-by-system
726 output. For that, use the EPS backend instead,
728 lilypond -dbackend=eps FILE
730 If have cut & pasted a lilypond fragment from a webpage, be sure
731 to only remove anything before
733 %% ****************************************************************
734 %% Start cut-&-pastable-section
735 %% ****************************************************************