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-font font font-name scaling)
53 "/" (ps-font-command font)
55 " " (ly:number->string scaling) " output-scale div selectfont }"
58 ;; FIXME: duplicated in other output backends
59 ;; FIXME: silly interface name
60 (define (output-variables layout)
61 ;; FIXME: duplicates output-layout's scope-entry->string, mostly
62 (define (value->string val)
64 ((string? val) (string-append "(" val ")"))
65 ((symbol? val) (symbol->string val))
66 ((number? val) (number->string val))
69 (define (output-entry ps-key ly-key)
72 (value->string (ly:output-def-lookup layout ly-key)) " def\n"))
76 (number->string (/ (ly:bp 1))) " def %% millimeter\n"
77 (output-entry "staff-line-thickness" 'line-thickness)
78 (output-entry "line-width" 'line-width)
79 (output-entry "paper-size" 'papersizename)
80 (output-entry "staff-height" 'staff-height) ;junkme.
82 (number->string (ly:output-def-lookup layout 'output-scale)) " def\n"
83 (output-entry "page-height" 'paper-height)
84 (output-entry "page-width" 'paper-width)))
86 (define (dump-page outputter page page-number page-count landscape?)
87 (ly:outputter-dump-string
90 (format "%%Page: ~a ~a\n" page-number page-number)
93 "page-width output-scale lily-output-units mul mul 0 translate 90 rotate\n"
97 "true setstrokeadjust\n"
98 "gsave 0 paper-height translate set-ps-scale-to-lily-scale\n"))
99 (ly:outputter-dump-stencil outputter page)
100 (ly:outputter-dump-string outputter "stroke grestore\nshowpage\n"))
102 (define (supplies-or-needs paper load-fonts?)
103 (define (extract-names font)
104 (if (ly:pango-font? font)
105 (map car (ly:pango-font-physical-fonts font))
106 (list (ly:font-name font))))
108 (let* ((fonts (ly:paper-fonts paper))
109 (names (apply append (map extract-names fonts))))
114 "%%DocumentSuppliedResources: font ~a\n"
115 "%%DocumentNeededResources: font ~a\n")
117 (uniq-list (sort names string<?))))))
119 (define (eps-header paper bbox load-fonts?)
120 (string-append "%!PS-Adobe-2.0 EPSF-2.0\n"
121 "%%Creator: LilyPond " (lilypond-version) "\n"
123 (string-join (map ly:number->string bbox) " ") "\n"
125 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
128 (supplies-or-needs paper load-fonts?)
131 (define (ps-document-media paper)
133 (ly:output-def-lookup paper 'output-scale)
134 (ly:output-def-lookup paper 'paper-width)) (ly:bp 1)))
136 (ly:output-def-lookup paper 'paper-height)
137 (ly:output-def-lookup paper 'output-scale))
139 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t)))
140 (ly:format "%%DocumentMedia: ~a ~2f ~2f ~a ~a ~a\n"
141 (ly:output-def-lookup paper 'papersizename)
149 (define (file-header paper page-count load-fonts?)
150 (string-append "%!PS-Adobe-3.0\n"
151 "%%Creator: LilyPond " (lilypond-version) "\n"
152 "%%Pages: " (number->string page-count) "\n"
153 "%%PageOrder: Ascend\n"
155 (if (eq? (ly:output-def-lookup paper 'landscape) #t)
158 (ps-document-media paper)
159 (supplies-or-needs paper load-fonts?)
162 (define (procset file-name)
164 "%%BeginResource: procset (~a) 1 0
168 file-name (cached-file-contents file-name)))
170 (define (embed-document file-name)
171 (format "%%BeginDocument: ~a
175 file-name (cached-file-contents file-name)))
177 (define (setup-variables paper)
180 (define-fonts paper ps-define-font)
181 (output-variables paper)))
183 (define (cff-font? font)
184 (let* ((cff-string (ly:otf-font-table-data font "CFF ")))
185 (> (string-length cff-string) 0)))
187 (define-public (ps-embed-cff body font-set-name version)
190 (format "/~a ~s StartData " font-set-name (string-length body))
194 "%%BeginResource: font ~a
195 %!PS-Adobe-3.0 Resource-FontSet
196 %%DocumentNeededResources: ProcSet (FontSetInit)
197 %%Title: (FontSet/~a)
200 %%IncludeResource: ProcSet (FontSetInit)
201 %%BeginResource: FontSet (~a)
202 /FontSetInit /ProcSet findresource begin
203 %%BeginData: ~s Binary Bytes
205 font-set-name font-set-name version font-set-name
206 (string-length binary-data)))
210 (string-append header
214 (define (write-preamble paper load-fonts? port)
215 (define (internal-font? file-name)
216 (or (string-startswith file-name "Emmentaler")
217 (string-startswith file-name "emmentaler")
220 (define (load-font-via-GS font-name-filename)
221 (define (ps-load-file file-name)
222 (if (string? file-name)
223 (if (string-contains file-name (ly:get-option 'datadir))
225 (set! file-name (ly:string-substitute (ly:get-option 'datadir)
228 "lilypond-datadir (~a) concatstrings (r) file .loadfont\n"
230 (format "(~a) (r) file .loadfont\n" file-name))
231 (format "% cannot find font file: ~a\n" file-name)))
233 (let* ((font (car font-name-filename))
234 (name (cadr font-name-filename))
235 (file-name (caddr font-name-filename))
236 (bare-file-name (ly:find-file file-name)))
238 (if (mac-font? bare-file-name)
239 (handle-mac-font name bare-file-name)
241 ((internal-font? file-name)
242 (ps-load-file (ly:find-file
243 (format "~a.otf" file-name))))
244 ((string? bare-file-name)
245 (ps-load-file file-name))
247 (ly:warning (_ "cannot embed ~S=~S") name file-name)
250 (define (dir-join a b)
253 (string-append a "/" b)))
255 (define (dir-listing dir-name)
256 (define (dir-helper dir lst)
257 (let ((e (readdir dir)))
260 (dir-helper dir (cons e lst)))))
261 (reverse (dir-helper (opendir dir-name) '())))
263 (define (handle-mac-font name filename)
264 (let* ((dir-name (tmpnam))
268 (mkdir dir-name #o700)
269 (set! status (ly:system
270 (format "cd ~a && fondu -force '~a'" dir-name filename)))
271 (set! files (dir-listing dir-name))
274 (let* ((full-name (dir-join dir-name f)))
276 (equal? 'regular (stat:type (stat full-name)))
277 (equal? name (ly:ttf-ps-name full-name)))
278 (set! embed (font-file-as-ps-string name full-name 0)))
279 (if (or (equal? "." f)
282 (delete-file full-name))))
287 (set! embed "% failed\n")
288 (ly:warning (_ "cannot extract file matching ~a from ~a")
292 (define (font-file-as-ps-string name file-name font-index)
293 (let* ((downcase-file-name (string-downcase file-name)))
295 ((and file-name (string-endswith downcase-file-name ".pfa"))
296 (embed-document file-name))
297 ((and file-name (string-endswith downcase-file-name ".pfb"))
298 (ly:pfb->pfa file-name))
299 ((and file-name (string-endswith downcase-file-name ".ttf"))
300 (ly:ttf->pfa file-name))
301 ((and file-name (string-endswith downcase-file-name ".ttc"))
302 (ly:ttf->pfa file-name font-index))
303 ((and file-name (string-endswith downcase-file-name ".otf"))
304 (ps-embed-cff (ly:otf->cff file-name) name 0))
306 (ly:warning (_ "do not know how to embed ~S=~S") name file-name)
309 (define (mac-font? bare-file-name)
310 (and (eq? PLATFORM 'darwin)
312 (or (string-endswith bare-file-name ".dfont")
313 (= (stat:size (stat bare-file-name)) 0))))
315 (define (load-font font-psname-filename-fontindex)
316 (let* ((font (list-ref font-psname-filename-fontindex 0))
317 (name (list-ref font-psname-filename-fontindex 1))
318 (file-name (list-ref font-psname-filename-fontindex 2))
319 (font-index (list-ref font-psname-filename-fontindex 3))
320 (bare-file-name (ly:find-file file-name)))
322 (cond ((mac-font? bare-file-name)
323 (handle-mac-font name bare-file-name))
324 ((and font (cff-font? font))
325 (ps-embed-cff (ly:otf-font-table-data font "CFF ")
328 (bare-file-name (font-file-as-ps-string
329 name bare-file-name font-index))
331 (ly:warning (_ "do not know how to embed font ~s ~s ~s")
332 name file-name font))))))
334 (define (load-fonts paper)
335 (let* ((fonts (ly:paper-fonts paper))
337 ;; todo - doc format of list.
341 (cond ((string? (ly:font-file-name font))
344 (ly:font-file-name font)
346 ((ly:pango-font? font)
347 (map (lambda (psname-filename-fontindex)
349 (list-ref psname-filename-fontindex 0)
350 (list-ref psname-filename-fontindex 1)
351 (list-ref psname-filename-fontindex 2)))
352 (ly:pango-font-physical-fonts font)))
354 (ly:font-sub-fonts font))))
356 (font-names (uniq-list
357 (sort (apply append all-font-names)
358 (lambda (x y) (string<? (cadr x) (cadr y))))))
360 ;; slightly spaghetti-ish: deciding what to load where
364 (cond ((ly:get-option 'gs-load-fonts)
365 (load-font-via-GS name))
366 ((ly:get-option 'gs-load-lily-fonts)
367 (if (or (string-contains (caddr name)
368 (ly:get-option 'datadir))
369 (internal-font? (caddr name)))
370 (load-font-via-GS name)
374 (pfas (map font-loader font-names)))
377 (display "%%BeginProlog\n" port)
380 "/lilypond-datadir where {pop} {userdict /lilypond-datadir (~a) put } ifelse"
381 (ly:get-option 'datadir))
383 (for-each (lambda (f)
384 (format port "\n%%BeginFont: ~a\n" (car f))
385 (display (cdr f) port)
386 (display "%%EndFont\n" port))
388 (display (setup-variables paper) port)
390 ;; adobe note 5002: should initialize variables before loading routines.
391 (display (procset "music-drawing-routines.ps") port)
392 (display (procset "lilyponddefs.ps") port)
393 (display "%%EndProlog\n" port)
394 (display "%%BeginSetup\ninit-lilypond-parameters\n%%EndSetup\n\n" port))
396 (define-public (output-framework basename book scopes fields)
397 (let* ((filename (format "~a.ps" basename))
398 (outputter (ly:make-paper-outputter
399 ;; FIXME: better wrap open/open-file,
400 ;; content-mangling is always bad.
401 ;; MINGW hack: need to have "b"inary for embedding CFFs
402 (open-file filename "wb")
404 (paper (ly:paper-book-paper book))
405 (systems (ly:paper-book-systems book))
406 (page-stencils (map page-stencil (ly:paper-book-pages book)))
407 (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
408 (page-number (1- (ly:output-def-lookup paper 'first-page-number)))
409 (page-count (length page-stencils))
410 (port (ly:outputter-port outputter)))
411 (if (ly:get-option 'clip-systems)
412 (clip-system-EPSes basename book))
413 (if (ly:get-option 'dump-signatures)
414 (write-system-signatures basename (ly:paper-book-systems book) 1))
415 (output-scopes scopes fields basename)
416 (display (file-header paper page-count #t) port)
417 ;; don't do BeginDefaults PageMedia: A4
418 ;; not necessary and wrong
419 (write-preamble paper #t port)
422 (set! page-number (1+ page-number))
423 (dump-page outputter page page-number page-count landscape?))
425 (display "%%Trailer\n%%EOF\n" port)
426 (ly:outputter-close outputter)
427 (postprocess-output book framework-ps-module filename
428 (ly:output-formats))))
430 (define-public (dump-stencil-as-EPS paper dump-me filename
432 (let* ((xext (ly:stencil-extent dump-me X))
433 (yext (ly:stencil-extent dump-me Y))
434 (padding (ly:get-option 'eps-box-padding))
435 (left-overshoot (if (number? padding)
436 (* -1 padding (ly:output-def-lookup paper 'mm))
441 (if (or (nan? x) (inf? x)
443 (equal? (format #f "~S" x) "+#.#")
444 (equal? (format #f "~S" x) "-#.#"))
447 ;; the left-overshoot is to make sure that
448 ;; bar numbers stick out of margin uniformly.
451 (if (number? left-overshoot)
452 (min left-overshoot (car xext))
454 (car yext) (cdr xext) (cdr yext)))))
455 (dump-stencil-as-EPS-with-bbox paper dump-me filename load-fonts bbox)))
457 (define-public (dump-stencil-as-EPS-with-bbox paper dump-me filename
460 "Create an EPS file from stencil DUMP-ME to FILENAME. BBOX has
461 format (left-x, lower-y, right x, up-y). If LOAD-FONTS set, include
463 (define (to-rounded-bp-box box)
464 "Convert box to 1/72 inch with rounding to enlarge the box."
465 (let* ((scale (ly:output-def-lookup paper 'output-scale))
466 (strip-non-number (lambda (x)
471 (directed-round (lambda (x rounder)
473 (rounder (/ (* (strip-non-number x) scale)
475 (list (directed-round (car box) floor)
476 (directed-round (cadr box) floor)
477 (directed-round (max (1+ (car box)) (caddr box)) ceiling)
478 (directed-round (max (1+ (cadr box)) (cadddr box)) ceiling))))
480 (let* ((outputter (ly:make-paper-outputter
481 ;; FIXME: better wrap open/open-file,
482 ;; content-mangling is always bad.
483 ;; MINGW hack: need to have "b"inary for embedding CFFs
484 (open-file (format "~a.eps" filename) "wb")
486 (port (ly:outputter-port outputter))
487 (rounded-bbox (to-rounded-bp-box bbox))
488 (port (ly:outputter-port outputter))
489 (header (eps-header paper rounded-bbox load-fonts)))
490 (display header port)
491 (write-preamble paper load-fonts port)
492 (display "gsave set-ps-scale-to-lily-scale\n" port)
493 (ly:outputter-dump-stencil outputter dump-me)
494 (display "stroke grestore\n%%Trailer\n%%EOF\n" port)
495 (ly:outputter-close outputter)))
497 (define (clip-systems-to-region basename paper systems region do-pdf do-png)
498 (let* ((extents-system-pairs
499 (filtered-map (lambda (paper-system)
500 (let* ((x-ext (system-clipped-x-extent
501 (paper-system-system-grob paper-system)
504 (cons x-ext paper-system)
509 (lambda (ext-system-pair)
510 (let* ((xext (car ext-system-pair))
511 (paper-system (cdr ext-system-pair))
512 (yext (paper-system-extent paper-system Y))
513 (bbox (list (car xext) (car yext)
514 (cdr xext) (cdr yext)))
515 (filename (if (< 0 count)
516 (format "~a-~a" basename count)
518 (set! count (1+ count))
519 (dump-stencil-as-EPS-with-bbox paper
520 (paper-system-stencil paper-system)
522 (ly:get-option 'include-eps-fonts)
525 (postscript->pdf 0 0 (format "~a.eps" filename)))
527 (postscript->png (ly:get-option 'resolution) 0 0
528 (format "~a.eps" filename)))))
529 extents-system-pairs)))
531 (define-public (clip-system-EPSes basename paper-book)
533 (member "pdf" (ly:output-formats)))
535 (member "png" (ly:output-formats)))
537 (define (clip-score-systems basename systems)
538 (let* ((layout (ly:grob-layout (paper-system-system-grob (car systems))))
539 (regions (ly:output-def-lookup layout 'clip-regions)))
542 (clip-systems-to-region
543 (format "~a-from-~a-to-~a-clip"
545 (rhythmic-location->file-string (car region))
546 (rhythmic-location->file-string (cdr region)))
547 layout systems region
551 ;; partition in system lists sharing their layout blocks
552 (let* ((systems (ly:paper-book-systems paper-book))
554 (score-system-list '()))
556 (lambda (system last-system)
557 (if (not (and last-system
558 (equal? (paper-system-layout last-system)
559 (paper-system-layout system))))
560 (set! score-system-list (cons '() score-system-list)))
561 (if (paper-system-layout system)
562 (set-car! score-system-list (cons system (car score-system-list))))
567 (for-each (lambda (system-list)
568 ;; filter out headers and top-level markup
569 (if (pair? system-list)
572 (format "~a-~a" basename count)
577 (define-public (output-preview-framework basename book scopes fields)
578 (let* ((paper (ly:paper-book-paper book))
579 (systems (relevant-book-systems book))
580 (to-dump-systems (relevant-dump-systems systems)))
581 (dump-stencil-as-EPS paper
582 (stack-stencils Y DOWN 0.0
583 (map paper-system-stencil
584 (reverse to-dump-systems)))
585 (format "~a.preview" basename)
587 (postprocess-output book framework-ps-module
588 (format "~a.preview.eps" basename)
589 (cons "png" (ly:output-formats)))))
591 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
593 (define-public (convert-to-pdf book name)
594 (let* ((defs (ly:paper-book-paper book))
595 (landscape (ly:output-def-lookup defs 'landscape))
596 (output-scale (ly:output-def-lookup defs 'output-scale))
598 (* x output-scale (/ (ly:bp 1)))))
599 (paper-width (convert (ly:output-def-lookup defs 'paper-width)))
600 (paper-height (convert (ly:output-def-lookup defs 'paper-height)))
601 (w (if landscape paper-height paper-width))
602 (h (if landscape paper-width paper-height)))
603 (if (equal? (basename name ".ps") "-")
604 (set! name (string-append "./" name)))
605 (postscript->pdf w h name)))
607 (define-public (convert-to-png book name)
608 (let* ((defs (ly:paper-book-paper book))
609 (defs-resolution (ly:output-def-lookup defs 'pngresolution))
610 (resolution (if (number? defs-resolution)
612 (ly:get-option 'resolution)))
613 (paper-width (ly:output-def-lookup defs 'paper-width))
614 (paper-height (ly:output-def-lookup defs 'paper-height))
615 (output-scale (ly:output-def-lookup defs 'output-scale)))
616 (if (equal? (basename name ".ps") "-")
617 (set! name (string-append "./" name)))
618 (postscript->png resolution
619 (* paper-width output-scale (/ (ly:bp 1)))
620 (* paper-height output-scale (/ (ly:bp 1)))
623 (define-public (convert-to-ps book name)
626 (define-public (output-classic-framework basename book scopes fields)
627 (ly:error (_ "\nThe PostScript backend does not support the
628 system-by-system output. For that, use the EPS backend instead,
630 lilypond -dbackend=eps FILE
632 If have cut & pasted a lilypond fragment from a webpage, be sure
633 to only remove anything before
635 %% ****************************************************************
636 %% Start cut-&-pastable-section
637 %% ****************************************************************