1 ;;;; output-lib.scm -- implement Scheme output helper functions
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2007 Jan Nieuwenhuizen <janneke@gnu.org>
6 ;;;; Han-Wen Nienhuys <hanwen@xs4all.nl>
11 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
13 (define-public (grob::has-interface grob iface)
14 (memq iface (ly:grob-interfaces grob)))
16 (define-public (make-stencil-boxer thickness padding callback)
18 "Return function that adds a box around the grob passed as argument."
21 (box-stencil (callback grob) thickness padding)))
23 (define-public (make-stencil-circler thickness padding callback)
24 "Return function that adds a circle around the grob passed as argument."
26 (lambda (grob) (circle-stencil (callback grob) thickness padding)))
28 (define-public (print-circled-text-callback grob)
29 (grob-interpret-markup grob (make-circle-markup
30 (ly:grob-property grob 'text))
33 (define-public (event-cause grob)
35 ((cause (ly:grob-property grob 'cause)))
38 ((ly:stream-event? cause) cause)
39 ((ly:grob? cause) (event-cause cause))
42 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
45 ;; The TabNoteHead tablatureFormat callback.
46 ;; Compute the text grob-property
47 (define-public (fret-number-tablature-format string
50 ((tuning (ly:context-property context 'stringTunings))
51 (pitch (ly:event-property event 'pitch))
56 (eq? 'harmonic-event (ly:event-property ev 'class)))
57 (ly:event-property event 'articulations)))))
64 (- (ly:pitch-semitones pitch)
66 ;; remove 1 because list index starts at 0 and guitar string at 1.
70 ;; The 5-string banjo has got a extra string, the fifth (duh), wich
71 ;; starts at the fifth fret on the neck. Frets on the fifth string
72 ;; are referred to relative to the other frets:
73 ;; the "first fret" on the fifth string is really the sixth fret
75 ;; We solve this by defining a new fret-number-tablature function:
76 (define-public (fret-number-tablature-format-banjo string
79 ((tuning (ly:context-property context 'stringTunings))
80 (pitch (ly:event-property event 'pitch))
84 (let ((fret (- (ly:pitch-semitones pitch) (list-ref tuning (- string 1)))))
86 ((and (> fret 0) (= string 5))
92 ; default tunings for common string instruments
93 (define-public guitar-tuning '(4 -1 -5 -10 -15 -20))
94 (define-public guitar-open-g-tuning '(2 -1 -5 -10 -17 -22))
95 (define-public bass-tuning '(-17 -22 -27 -32))
96 (define-public mandolin-tuning '(16 9 2 -5))
98 ;; tunings for 5-string banjo
99 (define-public banjo-open-g-tuning '(2 -1 -5 -10 7))
100 (define-public banjo-c-tuning '(2 -1 -5 -12 7))
101 (define-public banjo-modal-tuning '(2 0 -5 -10 7))
102 (define-public banjo-open-d-tuning '(2 -3 -6 -10 9))
103 (define-public banjo-open-dm-tuning '(2 -3 -6 -10 9))
104 ;; convert 5-string banjo tuning to 4-string by removing the 5th string
105 (define-public (four-string-banjo tuning)
106 (reverse (cdr (reverse tuning))))
108 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
112 (define-public (stem::calc-duration-log grob)
114 (ly:event-property (event-cause grob) 'duration)))
116 (define-public (note-head::calc-duration-log grob)
119 (ly:event-property (event-cause grob) 'duration))))
121 (define-public (dots::calc-dot-count grob)
122 (ly:duration-dot-count
123 (ly:event-property (event-cause grob) 'duration)))
125 (define-public (dots::calc-staff-position grob)
127 ((head (ly:grob-parent grob Y))
128 (log (ly:grob-property head 'duration-log)))
131 ((or (not (grob::has-interface head 'rest-interface))
132 (not (integer? log))) 0)
140 (define (note-head::calc-tablature-stem-attachment grob)
146 (define-public (note-head::calc-glyph-name grob)
148 ((style (ly:grob-property grob 'style))
149 (log (min 2 (ly:grob-property grob 'duration-log))))
152 ;; "default" style is directly handled in note-head.cc as a
153 ;; special case (HW says, mainly for performance reasons).
154 ;; Therefore, style "default" does not appear in this case
156 ((xcircle) "2xcircle")
157 ((harmonic) "0harmonic")
158 ((harmonic-black) "2harmonic")
159 ((harmonic-mixed) (if (<= log 1) "0harmonic"
162 ;; Oops, I actually would not call this "baroque", but, for
163 ;; backwards compatibility to 1.4, this is supposed to take
164 ;; brevis, longa and maxima from the neo-mensural font and all
165 ;; other note heads from the default font. -- jr
167 (string-append (number->string log) "neomensural")
168 (number->string log)))
170 (string-append (number->string log) (symbol->string style)))
173 (string-append (number->string log) "mensural")
174 (string-append (number->string log) (symbol->string style))))
176 (string-append (number->string log) (symbol->string style)))
178 (if (string-match "vaticana*|hufnagel*|medicaea*" (symbol->string style))
179 (symbol->string style)
180 (string-append (number->string (max 0 log))
181 (symbol->string style)))))))
183 ;; TODO junk completely?
184 (define (note-head-style->attachment-coordinates grob axis)
185 "Return pair (X . Y), containing multipliers for the note head
186 bounding box, where to attach the stem. e.g.: X==0 means horizontally
187 centered, X==1 is at the right, X == -1 is at the left."
192 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
195 (define-public ((every-nth-bar-number-visible n) barnum) (= 0 (modulo barnum n)))
197 (define-public ((modulo-bar-number-visible n m) barnum) (and (> barnum 1) (= m (modulo barnum n))))
199 (define-public ((set-bar-number-visibility n) tr)
200 (let* ((bn (ly:context-property tr 'currentBarNumber)))
201 (ly:context-set-property! tr 'barNumberVisibility (modulo-bar-number-visible n (modulo bn n)))))
203 (define-public (first-bar-number-invisible barnum) (> barnum 1))
205 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
206 ;; percent repeat counters
208 (define-public ((every-nth-repeat-count-visible n) count context) (= 0 (modulo count n)))
210 (define-public (all-repeat-counts-visible count context) #t)
212 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
215 (define-public all-visible #(#t #t #t))
216 (define-public begin-of-line-invisible #(#t #t #f))
217 (define-public center-invisible #(#t #f #t))
218 (define-public end-of-line-invisible #(#f #t #t))
219 (define-public begin-of-line-visible #(#f #f #t))
220 (define-public center-visible #(#f #t #f))
221 (define-public end-of-line-visible #(#t #f #f))
222 (define-public all-invisible #(#f #f #f))
224 (define-public spanbar-begin-of-line-invisible
227 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
231 ;; How should a bar line behave at a break?
232 (define bar-glyph-alist
233 '((":|:" . (":|" . "|:"))
234 (":|.|:" . (":|" . "|:"))
235 (":|.:" . (":|" . "|:"))
236 ("||:" . ("||" . "|:"))
237 ("dashed" . ("dashed" . '()))
239 ("||:" . ("||" . "|:"))
241 ("|:" . ("|" . "|:"))
244 ;; hmm... should we end with a bar line here?
245 (".|" . ("|" . ".|"))
248 (".|." . (".|." . ()))
249 ("|.|" . ("|.|" . ()))
253 ("empty" . (() . ()))
254 ("brace" . (() . "brace"))
255 ("bracket" . (() . "bracket"))
258 (define-public (bar-line::calc-glyph-name grob)
260 (glyph (ly:grob-property grob 'glyph))
261 (dir (ly:item-break-dir grob))
262 (result (assoc glyph bar-glyph-alist))
263 (glyph-name (if (= dir CENTER)
265 (if (and result (string? (index-cell (cdr result) dir)))
266 (index-cell (cdr result) dir)
271 (define-public (bar-line::calc-break-visibility grob)
272 (let* ((glyph (ly:grob-property grob 'glyph))
273 (result (assoc glyph bar-glyph-alist)))
275 (vector (string? (cadr result)) #t (string? (cddr result)))
279 (define-public (shift-right-at-line-begin g)
280 "Shift an item to the right, but only at the start of the line."
281 (if (and (ly:item? g)
282 (equal? (ly:item-break-dir g) RIGHT))
283 (ly:grob-translate-axis! g 3.5 X)))
286 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
289 (define-public (tuplet-number::calc-denominator-text grob)
290 (number->string (ly:event-property (event-cause grob) 'denominator)))
292 (define-public (tuplet-number::calc-fraction-text grob)
294 ((ev (event-cause grob)))
297 (ly:event-property ev 'denominator)
298 (ly:event-property ev 'numerator))))
300 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
303 (define-public color? list?)
304 (define-public (rgb-color r g b) (list r g b))
307 (define-public black '(0.0 0.0 0.0))
308 (define-public white '(1.0 1.0 1.0))
309 (define-public red '(1.0 0.0 0.0))
310 (define-public green '(0.0 1.0 0.0))
311 (define-public blue '(0.0 0.0 1.0))
312 (define-public cyan '(0.0 1.0 1.0))
313 (define-public magenta '(1.0 0.0 1.0))
314 (define-public yellow '(1.0 1.0 0.0))
316 (define-public grey '(0.5 0.5 0.5))
317 (define-public darkred '(0.5 0.0 0.0))
318 (define-public darkgreen '(0.0 0.5 0.0))
319 (define-public darkblue '(0.0 0.0 0.5))
320 (define-public darkcyan '(0.0 0.5 0.5))
321 (define-public darkmagenta '(0.5 0.0 0.5))
322 (define-public darkyellow '(0.5 0.5 0.0))
324 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
328 (define-public (key-signature-interface::alteration-position step alter c0-position)
329 ;; TODO: memoize - this is mostly constant.
331 ;; fes, ges, as and bes typeset in lower octave
332 (define FLAT_TOP_PITCH 2)
334 ;; ais and bis typeset in lower octave
335 (define SHARP_TOP_PITCH 4)
338 (+ (cdr step) (* (car step) 7) c0-position)
340 ((from-bottom-pos (modulo (+ 4 49 c0-position) 7))
342 (c0 (- from-bottom-pos 4)))
345 (or (and (< alter 0) (or (> p FLAT_TOP_PITCH) (> (+ p c0) 4)) (> (+ p c0) 1))
346 (and (> alter 0) (or (> p SHARP_TOP_PITCH) (> (+ p c0) 5)) (> (+ p c0) 2))
349 ;; Typeset below c_position
352 ;; Provide for the four cases in which there's a glitch
353 ;; it's a hack, but probably not worth
354 ;; the effort of finding a nicer solution.
357 ((and (= c0 2) (= p 3) (> alter 0))
359 ((and (= c0 -3) (= p -1) (> alter 0))
361 ((and (= c0 -4) (= p -1) (< alter 0))
363 ((and (= c0 -2) (= p -3) (< alter 0))
369 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
372 (define-public (accidental-interface::calc-alteration grob)
373 (ly:pitch-alteration (ly:event-property (event-cause grob) 'pitch)))
376 (define-public cancellation-glyph-name-alist
377 '((0 . "accidentals.natural")))
379 (define-public standard-alteration-glyph-name-alist
381 ;; ordered for optimal performance.
382 (0 . "accidentals.natural")
383 (-1/2 . "accidentals.flat")
384 (1/2 . "accidentals.sharp")
386 (1 . "accidentals.doublesharp")
387 (-1 . "accidentals.flatflat")
389 (3/4 . "accidentals.sharp.slashslash.stemstemstem")
390 (1/4 . "accidentals.sharp.slashslash.stem")
391 (-1/4 . "accidentals.mirroredflat")
392 (-3/4 . "accidentals.mirroredflat.flat")
395 ;; FIXME: standard vs default, alteration-FOO vs FOO-alteration
396 (define-public alteration-default-glyph-name-alist standard-alteration-glyph-name-alist)
398 (define-public makam-alteration-glyph-name-alist
399 '((1 . "accidentals.doublesharp")
400 (8/9 . "accidentals.sharp.slashslashslash.stemstem")
401 (5/9 . "accidentals.sharp.slashslashslash.stem")
402 (4/9 . "accidentals.sharp")
403 (1/9 . "accidentals.sharp.slashslash.stem")
404 (0 . "accidentals.natural")
405 (-1/9 . "accidentals.mirroredflat")
406 (-4/9 . "accidentals.flat.slash")
407 (-5/9 . "accidentals.flat")
408 (-8/9 . "accidentals.flat.slashslash")
409 (-1 . "accidentals.flatflat")
412 (define-public alteration-hufnagel-glyph-name-alist
413 '((-1/2 . "accidentals.hufnagelM1")
414 (0 . "accidentals.vaticana0")
415 (1/2 . "accidentals.mensural1")))
417 (define-public alteration-medicaea-glyph-name-alist
418 '((-1/2 . "accidentals.medicaeaM1")
419 (0 . "accidentals.vaticana0")
420 (1/2 . "accidentals.mensural1")))
422 (define-public alteration-vaticana-glyph-name-alist
423 '((-1/2 . "accidentals.vaticanaM1")
424 (0 . "accidentals.vaticana0")
425 (1/2 . "accidentals.mensural1")))
427 (define-public alteration-mensural-glyph-name-alist
428 '((-1/2 . "accidentals.mensuralM1")
429 (0 . "accidentals.vaticana0")
430 (1/2 . "accidentals.mensural1")))
433 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
434 ;; * Pitch Trill Heads
437 (define-public (parentheses-item::calc-parenthesis-stencils grob)
438 (let* ((font (ly:grob-default-font grob))
439 (lp (ly:font-get-glyph font "accidentals.leftparen"))
440 (rp (ly:font-get-glyph font "accidentals.rightparen")))
445 (define-public (grob-interpret-markup grob text)
447 ((layout (ly:grob-layout grob))
448 (defs (ly:output-def-lookup layout 'text-font-defaults))
449 (props (ly:grob-alist-chain grob defs)))
451 (ly:text-interface::interpret-markup
454 (define-public (parentheses-item::calc-angled-bracket-stencils grob)
456 (font (ly:grob-default-font grob))
457 (lp (ly:stencil-aligned-to (ly:stencil-aligned-to (grob-interpret-markup grob (ly:wide-char->utf-8 #x2329))
459 (rp (ly:stencil-aligned-to (ly:stencil-aligned-to (grob-interpret-markup grob (ly:wide-char->utf-8 #x232A))
463 (list (stencil-whiteout lp)
464 (stencil-whiteout rp))))
466 (define (parenthesize-elements grob . rest)
468 ((refp (if (null? rest)
471 (elts (ly:grob-object grob 'elements))
472 (x-ext (ly:relative-group-extent elts refp X))
473 (stencils (ly:grob-property grob 'stencils))
476 (padding (ly:grob-property grob 'padding 0.1)))
479 (ly:stencil-translate-axis lp (- (car x-ext) padding) X)
480 (ly:stencil-translate-axis rp (+ (cdr x-ext) padding) X))
484 (define (parentheses-item::print me)
486 ((elts (ly:grob-object me 'elements))
487 (y-ref (ly:grob-common-refpoint-of-array me elts Y))
488 (x-ref (ly:grob-common-refpoint-of-array me elts X))
489 (stencil (parenthesize-elements me x-ref))
490 (elt-y-ext (ly:relative-group-extent elts y-ref Y))
491 (y-center (interval-center elt-y-ext)))
493 (ly:stencil-translate
497 (ly:grob-relative-coordinate me x-ref X))
500 (ly:grob-relative-coordinate me y-ref Y))))
505 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
508 (define-public (chain-grob-member-functions grob value . funcs)
511 (set! value (func grob value)))
516 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
519 (define-public (bend::print spanner)
521 (< (abs (- a b)) 0.01))
524 ((delta-y (* 0.5 (ly:grob-property spanner 'delta-position)))
525 (left-span (ly:spanner-bound spanner LEFT))
526 (dots (if (and (grob::has-interface left-span 'note-head-interface)
527 (ly:grob? (ly:grob-object left-span 'dot)))
528 (ly:grob-object left-span 'dot) #f))
530 (right-span (ly:spanner-bound spanner RIGHT))
531 (thickness (* (ly:grob-property spanner 'thickness)
532 (ly:output-def-lookup (ly:grob-layout spanner)
534 (padding (ly:grob-property spanner 'padding 0.5))
535 (common (ly:grob-common-refpoint right-span
536 (ly:grob-common-refpoint spanner
539 (common-y (ly:grob-common-refpoint spanner left-span Y))
541 (max (interval-end (ly:grob-robust-relative-extent
545 (close (ly:grob-relative-coordinate dots common-y Y)
546 (ly:grob-relative-coordinate spanner common-y Y)))
547 (interval-end (ly:grob-robust-relative-extent dots common X))
548 -10000) ;; TODO: use real infinity constant.
550 (right-x (- (interval-start
551 (ly:grob-robust-relative-extent right-span common X))
553 (self-x (ly:grob-relative-coordinate spanner common X))
554 (dx (- right-x left-x))
555 (exp (list 'path thickness
563 ,dx ,(* 0.66 delta-y)
569 (cons (- left-x self-x) (- right-x self-x))
570 (cons (min 0 delta-y)
573 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
577 (define-public (grace-spacing::calc-shortest-duration grob)
579 ((cols (ly:grob-object grob 'columns))
582 (ly:moment-sub (ly:grob-property
583 (ly:grob-array-ref cols (1+ idx)) 'when)
585 (ly:grob-array-ref cols idx) 'when))))
587 (moment-min (lambda (x y)
590 (if (ly:moment<? x y)
596 (fold moment-min #f (map get-difference
597 (iota (1- (ly:grob-array-length cols)))))))
601 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
604 (define-public (fingering::calc-text grob)
606 ((event (event-cause grob))
607 (digit (ly:event-property event 'digit)))
610 (ly:input-message (ly:event-property event 'origin)
611 "Warning: Fingering notation for finger number ~a" digit))
613 (number->string digit 10)
616 (define-public (string-number::calc-text grob)
618 ((digit (ly:event-property (event-cause grob) 'string-number)))
620 (number->string digit 10)
624 (define-public (stroke-finger::calc-text grob)
626 ((digit (ly:event-property (event-cause grob) 'digit))
627 (text (ly:event-property (event-cause grob) 'text)))
631 (vector-ref (ly:grob-property grob 'digit-names) (1- (max (min 5 digit) 1))))))
633 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
635 (define-public (hairpin::calc-grow-direction grob)
636 (if (eq? (ly:event-property (event-cause grob) 'class) 'decrescendo-event)
641 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
644 (define-public (lyric-text::print grob)
645 "Allow interpretation of tildes as lyric tieing marks."
648 ((text (ly:grob-property grob 'text)))
650 (grob-interpret-markup grob
652 (make-tied-lyric-markup text)
655 (define-public ((grob::calc-property-by-copy prop) grob)
656 (ly:event-property (event-cause grob) prop))
658 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
661 (define-public (fret-board::calc-stencil grob)
662 (grob-interpret-markup
664 (make-fret-diagram-verbose-markup
665 (ly:grob-property grob 'dot-placement-list))))
667 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
670 (define-public (script-interface::calc-x-offset grob)
671 (ly:grob-property grob 'positioning-done)
672 (ly:self-alignment-interface::centered-on-x-parent grob))