1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 2004--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>
5 ;;;; LilyPond is free software: you can redistribute it and/or modify
6 ;;;; it under the terms of the GNU General Public License as published by
7 ;;;; the Free Software Foundation, either version 3 of the License, or
8 ;;;; (at your option) any later version.
10 ;;;; LilyPond is distributed in the hope that it will be useful,
11 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
12 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 ;;;; GNU General Public License for more details.
15 ;;;; You should have received a copy of the GNU General Public License
16 ;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
18 (define-module (scm framework-ps))
20 ;;; this is still too big a mess.
22 (use-modules (ice-9 string-fun)
31 (define format ergonomic-simple-format)
33 (define framework-ps-module (current-module))
35 ;;(define pdebug stderr)
36 (define (pdebug . rest) #f)
38 (define-public (ps-font-command font)
39 (let* ((name (ly:font-file-name font))
40 (magnify (ly:font-magnification font)))
49 "m" (string-encode-integer (inexact->exact (round (* 1000 magnify)))))))
51 (define (ps-define-pango-pf pango-pf font-name scaling)
54 (define (ps-define-font font font-name scaling)
56 "/" (ps-font-command font)
58 " " (ly:number->string scaling) " output-scale div selectfont }"
61 ;; FIXME: duplicated in other output backends
62 ;; FIXME: silly interface name
63 (define (output-variables layout)
64 ;; FIXME: duplicates output-layout's scope-entry->string, mostly
65 (define (value->string val)
67 ((string? val) (string-append "(" val ")"))
68 ((symbol? val) (symbol->string val))
69 ((number? val) (number->string val))
72 (define (output-entry ps-key ly-key)
75 (value->string (ly:output-def-lookup layout ly-key)) " def\n"))
79 (number->string (/ (ly:bp 1))) " def %% millimeter\n"
80 (output-entry "staff-line-thickness" 'line-thickness)
81 (output-entry "line-width" 'line-width)
82 (output-entry "paper-size" 'papersizename)
83 (output-entry "staff-height" 'staff-height) ;junkme.
85 (number->string (ly:output-def-lookup layout 'output-scale)) " def\n"
86 (output-entry "page-height" 'paper-height)
87 (output-entry "page-width" 'paper-width)))
89 (define (dump-page outputter page page-number page-count landscape?)
90 (ly:outputter-dump-string
93 (format "%%Page: ~a ~a\n" page-number page-number)
96 "page-width output-scale lily-output-units mul mul 0 translate 90 rotate\n"
100 "true setstrokeadjust\n"
101 "gsave 0 paper-height translate set-ps-scale-to-lily-scale\n"))
102 (ly:outputter-dump-stencil outputter page)
103 (ly:outputter-dump-string outputter "stroke grestore\nshowpage\n"))
105 (define (supplies-or-needs paper load-fonts?)
106 (define (extract-names font)
107 (if (ly:pango-font? font)
108 (map car (ly:pango-font-physical-fonts font))
109 (list (ly:font-name font))))
111 (let* ((fonts (ly:paper-fonts paper))
112 (names (apply append (map extract-names fonts))))
117 "%%DocumentSuppliedResources: font ~a\n"
118 "%%DocumentNeededResources: font ~a\n")
120 (uniq-list (sort names string<?))))))
122 (define (eps-header paper bbox load-fonts?)
123 (string-append "%!PS-Adobe-2.0 EPSF-2.0\n"
124 "%%Creator: LilyPond " (lilypond-version) "\n"
126 (string-join (map ly:number->string bbox) " ") "\n"
128 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
131 (supplies-or-needs paper load-fonts?)
134 (define (ps-document-media paper)
136 (ly:output-def-lookup paper 'output-scale)
137 (ly:output-def-lookup paper 'paper-width)) (ly:bp 1)))
139 (ly:output-def-lookup paper 'paper-height)
140 (ly:output-def-lookup paper 'output-scale))
142 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t)))
143 (ly:format "%%DocumentMedia: ~a ~2f ~2f ~a ~a ~a\n"
144 (ly:output-def-lookup paper 'papersizename)
152 (define (file-header paper page-count load-fonts?)
153 (string-append "%!PS-Adobe-3.0\n"
154 "%%Creator: LilyPond " (lilypond-version) "\n"
155 "%%Pages: " (number->string page-count) "\n"
156 "%%PageOrder: Ascend\n"
158 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
161 (ps-document-media paper)
162 (supplies-or-needs paper load-fonts?)
165 (define (procset file-name)
167 "%%BeginResource: procset (~a) 1 0
171 file-name (cached-file-contents file-name)))
173 (define (embed-document file-name)
174 (format "%%BeginDocument: ~a
178 file-name (cached-file-contents file-name)))
180 (define (setup-variables paper)
183 (define-fonts paper ps-define-font ps-define-pango-pf)
184 (output-variables paper)))
186 (define (cff-font? font)
187 (let* ((cff-string (ly:otf-font-table-data font "CFF ")))
188 (> (string-length cff-string) 0)))
190 (define-public (ps-embed-cff body font-set-name version)
193 (format "/~a ~s StartData " font-set-name (string-length body))
197 "%%BeginResource: font ~a
198 %!PS-Adobe-3.0 Resource-FontSet
199 %%DocumentNeededResources: ProcSet (FontSetInit)
200 %%Title: (FontSet/~a)
203 %%IncludeResource: ProcSet (FontSetInit)
204 %%BeginResource: FontSet (~a)
205 /FontSetInit /ProcSet findresource begin
206 %%BeginData: ~s Binary Bytes
208 font-set-name font-set-name version font-set-name
209 (string-length binary-data)))
213 (string-append header
217 (define (write-preamble paper load-fonts? port)
218 (define (internal-font? file-name)
219 (or (string-startswith file-name "Emmentaler")
220 (string-startswith file-name "emmentaler")
223 (define (load-font-via-GS font-name-filename)
224 (define (ps-load-file file-name)
225 (if (string? file-name)
226 (if (string-contains file-name (ly:get-option 'datadir))
228 (set! file-name (ly:string-substitute (ly:get-option 'datadir)
231 "lilypond-datadir (~a) concatstrings (r) file .loadfont\n"
233 (format "(~a) (r) file .loadfont\n" file-name))
234 (format "% cannot find font file: ~a\n" file-name)))
236 (let* ((font (car font-name-filename))
237 (name (cadr font-name-filename))
238 (file-name (caddr font-name-filename))
239 (bare-file-name (ly:find-file file-name)))
241 (if (mac-font? bare-file-name)
242 (handle-mac-font name bare-file-name)
244 ((internal-font? file-name)
245 (ps-load-file (ly:find-file
246 (format "~a.otf" file-name))))
247 ((string? bare-file-name)
248 (ps-load-file file-name))
250 (ly:warning (_ "cannot embed ~S=~S") name file-name)
253 (define (dir-join a b)
256 (string-append a "/" b)))
258 (define (dir-listing dir-name)
259 (define (dir-helper dir lst)
260 (let ((e (readdir dir)))
263 (dir-helper dir (cons e lst)))))
264 (reverse (dir-helper (opendir dir-name) '())))
266 (define (handle-mac-font name filename)
267 (let* ((dir-name (tmpnam))
271 (mkdir dir-name #o700)
272 (set! status (ly:system
273 (format "cd ~a && fondu -force '~a'" dir-name filename)))
274 (set! files (dir-listing dir-name))
277 (let* ((full-name (dir-join dir-name f)))
279 (equal? 'regular (stat:type (stat full-name)))
280 (equal? name (ly:ttf-ps-name full-name)))
281 (set! embed (font-file-as-ps-string name full-name 0)))
282 (if (or (equal? "." f)
285 (delete-file full-name))))
290 (set! embed "% failed\n")
291 (ly:warning (_ "cannot extract file matching ~a from ~a")
295 (define (font-file-as-ps-string name file-name font-index)
296 (let* ((downcase-file-name (string-downcase file-name)))
298 ((and file-name (string-endswith downcase-file-name ".pfa"))
299 (embed-document file-name))
300 ((and file-name (string-endswith downcase-file-name ".pfb"))
301 (ly:pfb->pfa file-name))
302 ((and file-name (string-endswith downcase-file-name ".ttf"))
303 (ly:ttf->pfa file-name))
304 ((and file-name (string-endswith downcase-file-name ".ttc"))
305 (ly:ttf->pfa file-name font-index))
306 ((and file-name (string-endswith downcase-file-name ".otf"))
307 (ps-embed-cff (ly:otf->cff file-name) name 0))
309 (ly:warning (_ "do not know how to embed ~S=~S") name file-name)
312 (define (mac-font? bare-file-name)
313 (and (eq? PLATFORM 'darwin)
315 (or (string-endswith bare-file-name ".dfont")
316 (= (stat:size (stat bare-file-name)) 0))))
318 (define (load-font font-psname-filename-fontindex)
319 (let* ((font (list-ref font-psname-filename-fontindex 0))
320 (name (list-ref font-psname-filename-fontindex 1))
321 (file-name (list-ref font-psname-filename-fontindex 2))
322 (font-index (list-ref font-psname-filename-fontindex 3))
323 (bare-file-name (ly:find-file file-name)))
325 (cond ((mac-font? bare-file-name)
326 (handle-mac-font name bare-file-name))
327 ((and font (cff-font? font))
328 (ps-embed-cff (ly:otf-font-table-data font "CFF ")
331 (bare-file-name (font-file-as-ps-string
332 name bare-file-name font-index))
334 (ly:warning (_ "do not know how to embed font ~s ~s ~s")
335 name file-name font))))))
337 (define (load-fonts paper)
338 (let* ((fonts (ly:paper-fonts paper))
340 ;; todo - doc format of list.
344 (cond ((string? (ly:font-file-name font))
347 (ly:font-file-name font)
349 ((ly:pango-font? font)
350 (map (lambda (psname-filename-fontindex)
352 (list-ref psname-filename-fontindex 0)
353 (list-ref psname-filename-fontindex 1)
354 (list-ref psname-filename-fontindex 2)))
355 (ly:pango-font-physical-fonts font)))
357 (ly:font-sub-fonts font))))
359 (font-names (uniq-list
360 (sort (apply append all-font-names)
361 (lambda (x y) (string<? (cadr x) (cadr y))))))
363 ;; slightly spaghetti-ish: deciding what to load where
367 (cond ((ly:get-option 'gs-load-fonts)
368 (load-font-via-GS name))
369 ((ly:get-option 'gs-load-lily-fonts)
370 (if (or (string-contains (caddr name)
371 (ly:get-option 'datadir))
372 (internal-font? (caddr name)))
373 (load-font-via-GS name)
377 (pfas (map font-loader font-names)))
380 (display "%%BeginProlog\n" port)
383 "/lilypond-datadir where {pop} {userdict /lilypond-datadir (~a) put } ifelse"
384 (ly:get-option 'datadir))
386 (for-each (lambda (f)
387 (format port "\n%%BeginFont: ~a\n" (car f))
388 (display (cdr f) port)
389 (display "%%EndFont\n" port))
391 (display (setup-variables paper) port)
393 ;; adobe note 5002: should initialize variables before loading routines.
394 (display (procset "music-drawing-routines.ps") port)
395 (display (procset "lilyponddefs.ps") port)
396 (display "%%EndProlog\n" port)
397 (display "%%BeginSetup\ninit-lilypond-parameters\n%%EndSetup\n\n" port))
399 (define-public (output-framework basename book scopes fields)
400 (let* ((filename (format "~a.ps" basename))
401 (outputter (ly:make-paper-outputter
402 ;; FIXME: better wrap open/open-file,
403 ;; content-mangling is always bad.
404 ;; MINGW hack: need to have "b"inary for embedding CFFs
405 (open-file filename "wb")
407 (paper (ly:paper-book-paper book))
408 (systems (ly:paper-book-systems book))
409 (page-stencils (map page-stencil (ly:paper-book-pages book)))
410 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
411 (page-number (1- (ly:output-def-lookup paper 'first-page-number)))
412 (page-count (length page-stencils))
413 (port (ly:outputter-port outputter)))
414 (if (ly:get-option 'clip-systems)
415 (clip-system-EPSes basename book))
416 (if (ly:get-option 'dump-signatures)
417 (write-system-signatures basename (ly:paper-book-systems book) 1))
418 (output-scopes scopes fields basename)
419 (display (file-header paper page-count #t) port)
420 ;; don't do BeginDefaults PageMedia: A4
421 ;; not necessary and wrong
422 (write-preamble paper #t port)
425 (set! page-number (1+ page-number))
426 (dump-page outputter page page-number page-count landscape?))
428 (display "%%Trailer\n%%EOF\n" port)
429 (ly:outputter-close outputter)
430 (postprocess-output book framework-ps-module filename
431 (ly:output-formats))))
433 (define-public (dump-stencil-as-EPS paper dump-me filename
435 (let* ((xext (ly:stencil-extent dump-me X))
436 (yext (ly:stencil-extent dump-me Y))
437 (padding (ly:get-option 'eps-box-padding))
438 (left-overshoot (if (number? padding)
439 (* -1 padding (ly:output-def-lookup paper 'mm))
444 (if (or (nan? x) (inf? x)
446 (equal? (format #f "~S" x) "+#.#")
447 (equal? (format #f "~S" x) "-#.#"))
450 ;; the left-overshoot is to make sure that
451 ;; bar numbers stick out of margin uniformly.
454 (if (number? left-overshoot)
455 (min left-overshoot (car xext))
457 (car yext) (cdr xext) (cdr yext)))))
458 (dump-stencil-as-EPS-with-bbox paper dump-me filename load-fonts bbox)))
460 (define-public (dump-stencil-as-EPS-with-bbox paper dump-me filename
463 "Create an EPS file from stencil DUMP-ME to FILENAME. BBOX has
464 format (left-x, lower-y, right x, up-y). If LOAD-FONTS set, include
466 (define (to-rounded-bp-box box)
467 "Convert box to 1/72 inch with rounding to enlarge the box."
468 (let* ((scale (ly:output-def-lookup paper 'output-scale))
469 (strip-non-number (lambda (x)
474 (directed-round (lambda (x rounder)
476 (rounder (/ (* (strip-non-number x) scale)
478 (list (directed-round (car box) floor)
479 (directed-round (cadr box) floor)
480 (directed-round (max (1+ (car box)) (caddr box)) ceiling)
481 (directed-round (max (1+ (cadr box)) (cadddr box)) ceiling))))
483 (let* ((outputter (ly:make-paper-outputter
484 ;; FIXME: better wrap open/open-file,
485 ;; content-mangling is always bad.
486 ;; MINGW hack: need to have "b"inary for embedding CFFs
487 (open-file (format "~a.eps" filename) "wb")
489 (port (ly:outputter-port outputter))
490 (rounded-bbox (to-rounded-bp-box bbox))
491 (port (ly:outputter-port outputter))
492 (header (eps-header paper rounded-bbox load-fonts)))
493 (display header port)
494 (write-preamble paper load-fonts port)
495 (display "gsave set-ps-scale-to-lily-scale\n" port)
496 (ly:outputter-dump-stencil outputter dump-me)
497 (display "stroke grestore\n%%Trailer\n%%EOF\n" port)
498 (ly:outputter-close outputter)))
500 (define (clip-systems-to-region basename paper systems region do-pdf do-png)
501 (let* ((extents-system-pairs
502 (filtered-map (lambda (paper-system)
503 (let* ((x-ext (system-clipped-x-extent
504 (paper-system-system-grob paper-system)
507 (cons x-ext paper-system)
512 (lambda (ext-system-pair)
513 (let* ((xext (car ext-system-pair))
514 (paper-system (cdr ext-system-pair))
515 (yext (paper-system-extent paper-system Y))
516 (bbox (list (car xext) (car yext)
517 (cdr xext) (cdr yext)))
518 (filename (if (< 0 count)
519 (format "~a-~a" basename count)
521 (set! count (1+ count))
522 (dump-stencil-as-EPS-with-bbox paper
523 (paper-system-stencil paper-system)
525 (ly:get-option 'include-eps-fonts)
528 (postscript->pdf 0 0 (format "~a.eps" filename)))
530 (postscript->png (ly:get-option 'resolution) 0 0
531 (format "~a.eps" filename)))))
532 extents-system-pairs)))
534 (define-public (clip-system-EPSes basename paper-book)
536 (member "pdf" (ly:output-formats)))
538 (member "png" (ly:output-formats)))
540 (define (clip-score-systems basename systems)
541 (let* ((layout (ly:grob-layout (paper-system-system-grob (car systems))))
542 (regions (ly:output-def-lookup layout 'clip-regions)))
545 (clip-systems-to-region
546 (format "~a-from-~a-to-~a-clip"
548 (rhythmic-location->file-string (car region))
549 (rhythmic-location->file-string (cdr region)))
550 layout systems region
554 ;; partition in system lists sharing their layout blocks
555 (let* ((systems (ly:paper-book-systems paper-book))
557 (score-system-list '()))
559 (lambda (system last-system)
560 (if (not (and last-system
561 (equal? (paper-system-layout last-system)
562 (paper-system-layout system))))
563 (set! score-system-list (cons '() score-system-list)))
564 (if (paper-system-layout system)
565 (set-car! score-system-list (cons system (car score-system-list))))
570 (for-each (lambda (system-list)
571 ;; filter out headers and top-level markup
572 (if (pair? system-list)
575 (format "~a-~a" basename count)
580 (define-public (output-preview-framework basename book scopes fields)
581 (let* ((paper (ly:paper-book-paper book))
582 (systems (relevant-book-systems book))
583 (to-dump-systems (relevant-dump-systems systems)))
584 (dump-stencil-as-EPS paper
585 (stack-stencils Y DOWN 0.0
586 (map paper-system-stencil
587 (reverse to-dump-systems)))
588 (format "~a.preview" basename)
590 (postprocess-output book framework-ps-module
591 (format "~a.preview.eps" basename)
592 (cons "png" (ly:output-formats)))))
594 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
596 (define (output-width-height defs)
597 (let* ((landscape (ly:output-def-lookup defs 'landscape))
598 (output-scale (ly:output-def-lookup defs 'output-scale))
600 (* x output-scale (/ (ly:bp 1)))))
601 (paper-width (convert (ly:output-def-lookup defs 'paper-width)))
602 (paper-height (convert (ly:output-def-lookup defs 'paper-height)))
603 (w (if landscape paper-height paper-width))
604 (h (if landscape paper-width paper-height)))
607 (define (output-resolution defs)
608 (let ((defs-resolution (ly:output-def-lookup defs 'pngresolution)))
609 (if (number? defs-resolution)
611 (ly:get-option 'resolution))))
613 (define (output-filename name)
614 (if (equal? (basename name ".ps") "-")
615 (string-append "./" name)
618 (define-public (convert-to-pdf book name)
619 (let* ((defs (ly:paper-book-paper book))
620 (width-height (output-width-height defs))
621 (width (car width-height))
622 (height (cdr width-height))
623 (filename (output-filename name)))
624 (postscript->pdf width height filename)))
626 (define-public (convert-to-png book name)
627 (let* ((defs (ly:paper-book-paper book))
628 (resolution (output-resolution defs))
629 (width-height (output-width-height defs))
630 (width (car width-height))
631 (height (cdr width-height))
632 (filename (output-filename name)))
633 (postscript->png resolution width height filename)))
635 (define-public (convert-to-ps book name)
638 (define-public (output-classic-framework basename book scopes fields)
639 (ly:error (_ "\nThe PostScript backend does not support the
640 system-by-system output. For that, use the EPS backend instead,
642 lilypond -dbackend=eps FILE
644 If have cut & pasted a lilypond fragment from a webpage, be sure
645 to only remove anything before
647 %% ****************************************************************
648 %% Start cut-&-pastable-section
649 %% ****************************************************************