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 (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 (if (equal? fontname "unknown")
70 (display (list font fontname)))
71 (define-font plain fontname scaling)))
74 (map (lambda (x) (font-load-command x))
75 (filter (lambda (x) (not (ly:pango-font? x)))
78 ;; FIXME: duplicated in other output backends
79 ;; FIXME: silly interface name
80 (define (output-variables layout)
81 ;; FIXME: duplicates output-layout's scope-entry->string, mostly
82 (define (value->string val)
84 ((string? val) (string-append "(" val ")"))
85 ((symbol? val) (symbol->string val))
86 ((number? val) (number->string val))
89 (define (output-entry ps-key ly-key)
92 (value->string (ly:output-def-lookup layout ly-key)) " def\n"))
96 (number->string (/ (ly:bp 1)))
97 " def %% millimeter\n"
98 (output-entry "staff-line-thickness" 'line-thickness)
99 (output-entry "line-width" 'line-width)
100 (output-entry "paper-size" 'papersizename)
101 (output-entry "staff-height" 'staff-height) ;junkme.
103 (number->string (ly:output-def-lookup layout 'output-scale))
105 (output-entry "page-height" 'paper-height)
106 (output-entry "page-width" 'paper-width)))
108 (define (dump-page outputter page page-number page-count landscape?)
109 (ly:outputter-dump-string
112 (format "%%Page: ~a ~a\n" page-number page-number)
115 "page-width output-scale lily-output-units mul mul 0 translate 90 rotate\n"
119 "true setstrokeadjust\n"
120 "gsave 0 paper-height translate "
121 "set-ps-scale-to-lily-scale "
123 (ly:outputter-dump-stencil outputter page)
124 (ly:outputter-dump-string outputter "stroke grestore \nshowpage\n"))
126 (define (supplies-or-needs paper load-fonts?)
127 (define (extract-names font)
128 (if (ly:pango-font? font)
129 (map car (ly:pango-font-physical-fonts font))
130 (list (ly:font-name font))))
132 (let* ((fonts (ly:paper-fonts paper))
133 (names (apply append (map extract-names fonts))))
139 "%%DocumentSuppliedResources: font ~a\n"
140 "%%DocumentNeededResources: font ~a\n")
142 (uniq-list (sort names string<?))))))
144 (define (eps-header paper bbox load-fonts?)
145 (string-append "%!PS-Adobe-2.0 EPSF-2.0\n"
146 "%%Creator: LilyPond "
150 (string-join (map ly:number->string bbox) " ") "\n"
152 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
155 (supplies-or-needs paper load-fonts?)
158 (define (ps-document-media paper)
160 (ly:output-def-lookup paper 'output-scale)
161 (ly:output-def-lookup paper 'paper-width)) (ly:bp 1)))
163 (ly:output-def-lookup paper 'paper-height)
164 (ly:output-def-lookup paper 'output-scale))
166 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t)))
167 (ly:format "%%DocumentMedia: ~a ~2f ~2f ~a ~a ~a\n"
168 (ly:output-def-lookup paper 'papersizename)
177 (define (file-header paper page-count load-fonts?)
178 (string-append "%!PS-Adobe-3.0\n"
179 "%%Creator: LilyPond "
183 "%%Pages: " (number->string page-count) "\n"
184 "%%PageOrder: Ascend\n"
186 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
189 (ps-document-media paper)
190 (supplies-or-needs paper load-fonts?)
193 (define (procset file-name)
195 "%%BeginResource: procset (~a) 1 0
199 file-name (cached-file-contents file-name)))
201 (define (embed-document file-name)
202 (format "%%BeginDocument: ~a
206 file-name (cached-file-contents file-name)))
208 (define (setup-variables paper)
212 (output-variables paper)
215 (define (cff-font? font)
217 ((cff-string (ly:otf-font-table-data font "CFF ")))
218 (> (string-length cff-string) 0)))
220 (define-public (ps-embed-cff body font-set-name version)
223 (format "/~a ~s StartData " font-set-name (string-length body))
228 "%%BeginResource: font ~a
229 %!PS-Adobe-3.0 Resource-FontSet
230 %%DocumentNeededResources: ProcSet (FontSetInit)
231 %%Title: (FontSet/~a)
234 %%IncludeResource: ProcSet (FontSetInit)
235 %%BeginResource: FontSet (~a)
236 /FontSetInit /ProcSet findresource begin
237 %%BeginData: ~s Binary Bytes
239 font-set-name font-set-name version font-set-name
240 (string-length binary-data)))
251 (define (write-preamble paper load-fonts? port)
253 (define (load-font-via-GS font-name-filename)
254 (define (ps-load-file name)
257 "(~a) (r) file .loadfont\n"
258 "% cannot find font file: ~a\n")
261 (let* ((font (car font-name-filename))
262 (name (cadr font-name-filename))
263 (file-name (caddr font-name-filename))
264 (bare-file-name (ly:find-file file-name)))
269 (if (mac-font? bare-file-name)
270 (handle-mac-font name bare-file-name)
272 ((or (string-startswith file-name "Emmentaler")
273 (string-startswith file-name "emmentaler")
274 (string-startswith file-name "aybabtu")
275 (string-startswith file-name "Aybabtu"))
276 (ps-load-file (ly:find-file
277 (format "~a.otf" file-name))))
278 ((string? bare-file-name)
279 (ps-load-file file-name))
281 (ly:warning (_ "cannot embed ~S=~S") name file-name)
286 (define (dir-join a b)
289 (string-append a "/" b)))
291 (define (dir-listing dir-name)
292 (define (dir-helper dir lst)
293 (let ((e (readdir dir)))
294 (if (eof-object? e) lst (dir-helper dir (cons e lst)))))
295 (reverse (dir-helper (opendir dir-name) '())))
297 (define (handle-mac-font name filename)
304 (mkdir dir-name #o700)
305 (set! status (ly:system
306 (format "cd ~a && fondu -force '~a'" dir-name filename)))
308 (set! files (dir-listing dir-name))
313 ((full-name (dir-join dir-name f)))
316 (equal? 'regular (stat:type (stat full-name)))
317 (equal? name (ly:ttf-ps-name full-name)))
320 (font-file-as-ps-string name full-name)))
322 (if (or (equal? "." f)
325 (delete-file full-name))))
333 (set! embed "% failed \n")
334 (ly:warning (_ "cannot extract file matching ~a from ~a") name filename)))
337 (define (font-file-as-ps-string name file-name)
339 ((downcase-file-name (string-downcase file-name)))
342 ((and file-name (string-endswith downcase-file-name ".pfa"))
343 (embed-document file-name))
344 ((and file-name (string-endswith downcase-file-name ".pfb"))
345 (ly:pfb->pfa file-name))
346 ((and file-name (string-endswith downcase-file-name ".ttf"))
347 (ly:ttf->pfa file-name))
348 ((and file-name (string-endswith downcase-file-name ".otf"))
349 (ps-embed-cff (ly:otf->cff file-name) name 0))
351 (ly:warning (_ "do not know how to embed ~S=~S") name file-name)
354 (define (mac-font? bare-file-name)
356 (eq? PLATFORM 'darwin)
359 (string-endswith bare-file-name ".dfont")
360 (= (stat:size (stat bare-file-name)) 0))))
362 (define (load-font font-name-filename)
363 (let* ((font (car font-name-filename))
364 (name (cadr font-name-filename))
365 (file-name (caddr font-name-filename))
366 (bare-file-name (ly:find-file file-name)))
372 ((mac-font? bare-file-name)
373 (handle-mac-font name bare-file-name))
375 ((and font (cff-font? font))
376 (ps-embed-cff (ly:otf-font-table-data font "CFF ")
380 (bare-file-name (font-file-as-ps-string name bare-file-name))
382 (ly:warning (_ "do not know how to embed font ~s ~s ~s")
383 name file-name font))))))
386 (define (load-fonts paper)
387 (let* ((fonts (ly:paper-fonts paper))
392 ((string? (ly:font-file-name font))
396 (ly:font-file-name font))))
397 ((ly:pango-font? font)
399 (lambda (name-psname-pair)
401 (car name-psname-pair)
402 (cdr name-psname-pair)))
403 (ly:pango-font-physical-fonts font)))
406 (ly:font-sub-fonts font))))
411 (sort (apply append all-font-names)
412 (lambda (x y) (string<? (cadr x) (cadr y))))))
414 (font-loader (if (ly:get-option 'gs-load-fonts)
418 (pfas (map font-loader font-names)))
421 (display "%%BeginProlog\n" port)
425 (format port "\n%%BeginFont: ~a\n" (car f))
426 (display (cdr f) port)
427 (display "\n%%EndFont\n" port))
430 (display (setup-variables paper) port)
432 ;; adobe note 5002: should initialize variables before loading routines.
433 (display (procset "music-drawing-routines.ps") port)
434 (display (procset "lilyponddefs.ps") port)
436 (if (not (ly:get-option 'point-and-click))
437 (display "/mark_URI { pop pop pop pop pop } bind def\n" port))
439 (display "%%EndProlog\n" port)
441 (display "%%BeginSetup\ninit-lilypond-parameters\n%%EndSetup\n\n" port))
443 (define-public (output-framework basename book scopes fields)
444 (let* ((filename (format "~a.ps" basename))
445 (outputter (ly:make-paper-outputter
446 ;; FIXME: better wrap open/open-file,
447 ;; content-mangling is always bad.
448 ;; MINGW hack: need to have "b"inary for embedding CFFs
449 (open-file filename "wb")
451 (paper (ly:paper-book-paper book))
452 (systems (ly:paper-book-systems book))
453 (page-stencils (map page-stencil (ly:paper-book-pages book)))
455 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
456 (page-number (1- (ly:output-def-lookup paper 'first-page-number)))
457 (page-count (length page-stencils))
458 (port (ly:outputter-port outputter)))
461 (if (ly:get-option 'clip-systems)
462 (clip-system-EPSes basename book))
464 (if (ly:get-option 'dump-signatures)
465 (write-system-signatures basename (ly:paper-book-systems book) 1))
467 (output-scopes scopes fields basename)
468 (display (file-header paper page-count #t) port)
470 ;; don't do BeginDefaults PageMedia: A4
471 ;; not necessary and wrong
473 (write-preamble paper #t port)
477 (set! page-number (1+ page-number))
478 (dump-page outputter page page-number page-count landscape?))
481 (display "%%Trailer\n%%EOF\n" port)
482 (ly:outputter-close outputter)
483 (postprocess-output book framework-ps-module filename
484 (ly:output-formats))))
486 (define-public (dump-stencil-as-EPS paper dump-me filename
490 ((xext (ly:stencil-extent dump-me X))
491 (yext (ly:stencil-extent dump-me Y))
492 (padding (ly:get-option 'eps-box-padding))
493 (left-overshoot (if (number? padding)
494 (* -1 padding (ly:output-def-lookup paper 'mm))
499 (if (or (nan? x) (inf? x)
501 (equal? (format #f "~S" x) "+#.#")
502 (equal? (format #f "~S" x) "-#.#"))
505 ;; the left-overshoot is to make sure that
506 ;; bar numbers stick out of margin uniformly.
510 (if (number? left-overshoot)
511 (min left-overshoot (car xext))
513 (car yext) (cdr xext) (cdr yext)))))
515 (dump-stencil-as-EPS-with-bbox paper dump-me filename load-fonts bbox)
519 (define-public (dump-stencil-as-EPS-with-bbox paper dump-me filename
522 (define (to-bp-box mmbox)
523 (let* ((scale (ly:output-def-lookup paper 'output-scale))
526 (if (or (nan? x) (inf? x))
529 (round (/ (* x scale) (ly:bp 1)))))) mmbox)))
533 (max (1+ (car box)) (caddr box))
534 (max (1+ (cadr box)) (cadddr box))
537 (let* ((outputter (ly:make-paper-outputter
538 ;; FIXME: better wrap open/open-file,
539 ;; content-mangling is always bad.
540 ;; MINGW hack: need to have "b"inary for embedding CFFs
541 (open-file (format "~a.eps" filename) "wb")
544 (port (ly:outputter-port outputter))
545 (rounded-bbox (to-bp-box bbox))
546 (port (ly:outputter-port outputter))
547 (header (eps-header paper rounded-bbox load-fonts)))
549 (display header port)
550 (write-preamble paper load-fonts port)
551 (display "gsave set-ps-scale-to-lily-scale \n" port)
552 (ly:outputter-dump-stencil outputter dump-me)
553 (display "stroke grestore\n%%Trailer\n%%EOF\n" port)
554 (ly:outputter-close outputter)))
558 (define (clip-systems-to-region
559 basename paper systems region
563 ((extents-system-pairs
565 (lambda (paper-system)
567 ((x-ext (system-clipped-x-extent
568 (paper-system-system-grob paper-system)
572 (cons x-ext paper-system)
579 (lambda (ext-system-pair)
581 ((xext (car ext-system-pair))
582 (paper-system (cdr ext-system-pair))
583 (yext (paper-system-extent paper-system Y))
584 (bbox (list (car xext) (car yext)
585 (cdr xext) (cdr yext)))
586 (filename (if (< 0 count)
587 (format "~a-~a" basename count)
590 (set! count (1+ count))
591 (dump-stencil-as-EPS-with-bbox
593 (paper-system-stencil paper-system)
595 (ly:get-option 'include-eps-fonts)
599 (postscript->pdf 0 0 (format "~a.eps" filename)))
602 extents-system-pairs)
606 (define-public (clip-system-EPSes basename paper-book)
607 (define do-pdf (member "pdf" (ly:output-formats)))
609 (define (clip-score-systems basename systems)
611 ((layout (ly:grob-layout (paper-system-system-grob (car systems))))
612 (regions (ly:output-def-lookup layout 'clip-regions)))
616 (clip-systems-to-region
617 (format "~a-from-~a-to-~a-clip"
619 (rhythmic-location->file-string (car region))
620 (rhythmic-location->file-string (cdr region)))
621 layout systems region
627 ;; partition in system lists sharing their layout blocks
629 ((systems (ly:paper-book-systems paper-book))
631 (score-system-list '()))
634 (lambda (system last-system)
637 (if (not (and last-system
638 (equal? (paper-system-layout last-system)
639 (paper-system-layout system))))
640 (set! score-system-list (cons '() score-system-list)))
642 (if (paper-system-layout system)
643 (set-car! score-system-list (cons system (car score-system-list))))
652 (lambda (system-list)
655 (format "~a-~a" basename count)
662 (define-public (output-preview-framework basename book scopes fields)
663 (let* ((paper (ly:paper-book-paper book))
664 (systems (ly:paper-book-systems book))
665 (scale (ly:output-def-lookup paper 'output-scale))
666 (to-dump-systems '()))
670 (not (ly:get-option 'include-book-title-preview))
672 (ly:prob-property (car systems) 'is-book-title #f))
674 (set! systems (cdr systems)))
679 (paper-system-title? sys)
680 (not (pair? to-dump-systems))
681 (paper-system-title? (car to-dump-systems)))
682 (set! to-dump-systems (cons sys to-dump-systems))))
687 (stack-stencils Y DOWN 0.0
688 (map paper-system-stencil (reverse to-dump-systems)))
689 (format "~a.preview" basename)
692 (postprocess-output book framework-ps-module
693 (format "~a.preview.eps" basename)
694 (cons "png" (ly:output-formats)))))
697 (define-public (output-preview-framework basename book scopes fields)
699 (let* ((paper (ly:paper-book-paper book))
700 (systems (ly:paper-book-systems book))
701 (scale (ly:output-def-lookup paper 'output-scale))
702 (titles (take-while paper-system-title? systems))
703 (non-title (find (lambda (x)
704 (not (paper-system-title? x))) systems))
706 (stack-stencils Y DOWN 0.0
707 (map paper-system-stencil
708 (append titles (list non-title))))))
709 (output-scopes scopes fields basename)
710 (dump-stencil-as-EPS paper dump-me
711 (format "~a.preview" basename)
714 (postprocess-output book framework-ps-module
715 (format "~a.preview.eps" basename)
716 (ly:output-formats)))))
718 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
720 (define-public (convert-to-pdf book name)
721 (let* ((defs (ly:paper-book-paper book))
722 (landscape (ly:output-def-lookup defs 'landscape))
723 (output-scale (ly:output-def-lookup defs 'output-scale))
724 (convert (lambda (x) (* x output-scale (/ (ly:bp 1)))))
726 (paper-width (convert (ly:output-def-lookup defs 'paper-width)))
727 (paper-height (convert (ly:output-def-lookup defs 'paper-height)))
729 (w (if landscape paper-height paper-width))
730 (h (if landscape paper-width paper-height))
733 (if (equal? (basename name ".ps") "-")
734 (ly:warning (_ "cannot convert <stdout> to ~S" "PDF"))
735 (postscript->pdf w h name))))
737 (define-public (convert-to-png book name)
738 (let* ((defs (ly:paper-book-paper book))
739 (defs-resolution (ly:output-def-lookup defs 'pngresolution))
740 (resolution (if (number? defs-resolution)
742 (ly:get-option 'resolution)))
743 (paper-width (ly:output-def-lookup defs 'paper-width))
744 (paper-height (ly:output-def-lookup defs 'paper-height))
745 (output-scale (ly:output-def-lookup defs 'output-scale)))
747 (postscript->png resolution
748 (* paper-width output-scale (/ (ly:bp 1)))
749 (* paper-height output-scale (/ (ly:bp 1)))
752 (define-public (convert-to-dvi book name)
753 (ly:warning (_ "cannot generate ~S using the postscript back-end") "DVI"))
755 (define-public (convert-to-tex book name)
756 (ly:warning (_ "cannot generate ~S using the postscript back-end") "TeX"))
758 (define-public (convert-to-ps book name)
761 (define-public (output-classic-framework basename book scopes fields)
763 (ly:error (_ "\nThe PostScript backend does not support the system-by-system
764 output. For that, use the EPS backend instead,
766 lilypond -b eps <file>
768 If have cut & pasted a lilypond fragment from a webpage, be sure
769 to only remove anything before
771 %% ****************************************************************
772 %% Start cut-&-pastable-section
773 %% ****************************************************************