1 ;;;; define-music-types.scm --
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2006 Han-Wen Nienhuys <hanwen@cs.uu.nl>
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
8 ;; TODO: should link back into user manual.
10 (define (mm-rest-child-list music)
11 "Check if we have R1*4-\\markup { .. }, and if applicable convert to
12 a property set for MultiMeasureRestNumber."
13 (let ((location (ly:music-property music 'origin))
14 (duration (ly:music-property music 'duration)))
15 (list (make-music 'BarCheck
17 (make-event-chord (cons (make-music 'MultiMeasureRestEvent
20 (ly:music-property music 'articulations)))
24 (define-public music-descriptions
28 (description . "Creates a dynamic mark.
30 Syntax: @var{note}@code{\\x},
31 where x is one of \\ppp, \\pp, \\p, \\mp, \\mf, \\f, \\ff, \\fff.")
32 (types . (general-music event dynamic-event absolute-dynamic-event))
36 (description . "Call the argument with the current context during interpreting phase")
37 (types . (general-music apply-context))
38 (iterator-ctor . ,ly:apply-context-iterator::constructor)
43 Call the argument with all current grobs during interpreting phase.
47 \\applyOutput #'Context FUNC
49 arguments to func are 1. the grob, 2. the originating context,
50 3. context where FUNC is called.
53 (types . (general-music event layout-instruction))
57 (description . "Make an arpeggio on this note.
60 @var{note}-@code{\\arpeggio}")
61 (types . (general-music arpeggio-event event))
64 ;; todo: use articulation-event for slur as well.
65 ;; separate non articulation scripts
68 (description . "Adds an articulation marking to a note.
71 @var{note}@code{X}@code{Y}, where X is a direction (up @code{^}, down
72 @code{_}, or LilyPond's choice (no direction specified)), and where Y
73 is an articulation (such as @code{-.}, @code{->}, @code{\\tenuto},
74 @code{\\downbow}). See the user manual for details.")
76 (types . (general-music event articulation-event script-event))
80 (description . "Used for making voices that switch between piano staves automatically.")
81 (iterator-ctor . ,ly:auto-change-iterator::constructor)
82 (start-callback . ,ly:music-wrapper::start-callback)
83 (length-callback . ,ly:music-wrapper::length-callback)
84 (types . (general-music music-wrapper-music auto-change-instruction))
89 "Check whether this music coincides with the start of the measure.")
90 (types . (general-music bar-check))
91 (iterator-ctor . ,ly:bar-check-iterator::constructor)
95 (description . "Print a bass-figure text")
97 (types . (general-music event rhythmic-event bass-figure-event))
101 (description . "Starts or stops a beam.
103 Syntax for manual control:
105 (types . (general-music event beam-event span-event))
109 . ((description . "A drop/fall/doit jazz articulation")
110 (types . (general-music bend-after-event event))))
114 (description . "Create a line break, Syntax: \\break or page break, Syntax: \\pagebreak.")
116 (types . (general-music break-event event))
120 (description . "Creates a `breath mark' or `comma'.
123 @var{note}\\breathe.")
125 (types . (general-music event breathing-event))
129 (description . "Used internally to signal beginning and ending of notes.")
131 (types . (general-music event busy-playing-event))
135 (description . "Change staffs in Piano staff.
137 Syntax @code{\\translator Staff = @var{new-id}}.")
138 (iterator-ctor . , ly:change-iterator::constructor)
139 (types . (general-music translator-change-instruction))
143 . ((description . "A note that is part of a cluster.")
145 ;; not a note-event, to ensure that Note_engraver doesn't eat it.
146 (types . (general-music cluster-note-event melodic-event rhythmic-event event))
151 (description . "Interpret the argument music within a specific context.")
152 (iterator-ctor . ,ly:context-specced-music-iterator::constructor)
153 (length-callback . ,ly:music-wrapper::length-callback)
154 (start-callback . ,ly:music-wrapper::start-callback)
155 (types . (context-specification general-music music-wrapper-music))
160 (description . "Begins or ends a crescendo.
162 Syntax: @var{note}\\cr
163 ... @var{note}\\rc (you can also use \\<, \\!, \\cresc, and
164 \\endcresc. See the user manual for details.).")
166 (types . (general-music dynamic-event crescendo-event event))
170 (description . "See @ref{CrescendoEvent}.")
172 (types . (general-music dynamic-event decrescendo-event event))
177 (description . "Extend lyrics.")
179 (types . (general-music extender-event event))
184 (description . "Atomic music event.")
185 (types . (general-music event))
190 (description . "Internally used to group a set of events.")
191 (iterator-ctor . ,ly:event-chord-iterator::constructor)
192 (length-callback . ,ly:music-sequence::maximum-length-callback)
193 (to-relative-callback . ,ly:music-sequence::event-chord-relative-callback)
194 (types . (general-music event-chord simultaneous-music))
200 (description . "Specify what finger to use for this note.")
201 (types . (general-music fingering-event event))
205 (description . "Specify that a note may not auto-beamed ")
206 (types . (general-music event beam-forbid-event))
210 (description . "Start a glissando on this note.")
211 (types . (general-music glissando-event event))
216 (description . "Interpret the argument as grace notes. ")
217 (start-callback . ,ly:grace-music::start-callback)
218 (length . ,ZERO-MOMENT)
219 (iterator-ctor . ,ly:grace-iterator::constructor)
220 (types . (grace-music music-wrapper-music general-music))
224 (description . "Start or stop grouping brackets.")
225 (types . (general-music event note-grouping-event))
229 (description . "Mark a note as harmonic")
230 (types . (general-music event harmonic-event))
234 (description . "A hyphen between lyric syllables.")
236 (types . (general-music hyphen-event event))
241 (description . "Change the key signature.
243 Syntax: @code{\\key } @var{name} @var{scale}.")
244 (to-relative-callback . ,(lambda (x p) p))
245 (types . (general-music key-change-event event))
248 . ((description . "Don't damp this chord.
250 Syntax: @var{note}\\laissezVibrer.")
252 (types . (general-music event laissez-vibrer-event))
256 (description . "Start or end a ligature.")
257 (span-type . ligature)
258 (types . (general-music span-event ligature-event event))
262 (description . "Allow, forbid or force a line break.")
263 (types . (general-music break-event event))
268 (description . "Align lyrics to the start of notes.
270 Syntax @var{\\lyricsto }@var{voicename} @var{lyrics}.")
271 (length . ,ZERO-MOMENT)
272 (types . (general-music lyric-combine-music))
273 (iterator-ctor . ,ly:lyric-combine-music-iterator::constructor)
278 (description . "A lyric syllable. Must be entered in lyrics mode, i.e.
279 @code{\\lyrics @{ twinkle4 twinkle4 @} } .")
281 (types . (general-music rhythmic-event lyric-event event))
285 (description . "Insert a rehearsal mark.
287 Syntax: @code{\\mark} @var{marker},
288 e.g. @code{\\mark \"A\"}.")
290 (types . (general-music mark-event event))
294 (description . "Used internally to signal melismas.")
295 (types . (general-music melisma-playing-event event))
299 (description . "Start or stop a melisma.
301 Syntax: @code{c4\\melisma d\\melismaEnd}.")
302 (types . (general-music melisma-span-event event))
305 (MultiMeasureRestMusic
307 (description . "Rests that may be compressed into Multi rests.
310 @code{R2.*4} for 4 measures in 3/4 time.")
311 (iterator-ctor . ,ly:sequential-iterator::constructor)
312 (elements-callback . ,mm-rest-child-list)
313 (types . (general-music multi-measure-rest))
316 (MultiMeasureRestEvent
318 (description . "Used internally by MultiMeasureRestMusic to signal rests")
319 (types . (general-music event rhythmic-event multi-measure-rest-event))
322 (MultiMeasureTextEvent
324 (description . "Texts on mm rests.
327 @code{R-\\markup @{ \\roman \"bla\" @}}. Note the explicit font switch.")
328 (types . (general-music event multi-measure-text-event))
333 (description . "Generic type for music expressions.")
335 (types . (general-music))
339 (description . "A note.")
340 (types . (general-music event note-event rhythmic-event melodic-event))
345 (description . "Extend the definition of a graphical object.
349 @code{\\override [ @var{Ctxt} . ] @var{Obj} @var{prop} = @var{val}}
351 (types . (general-music layout-instruction))
352 (iterator-ctor . ,ly:push-property-iterator::constructor)
356 (description . "Allow, forbid or force a page break.")
357 (types . (general-music break-event event))
361 (description . "Allow, forbid or force a page turn.")
362 (types . (general-music break-event event))
366 (description . "Combine two parts on a staff, either merged or
367 as separate voices.")
368 (length-callback . ,ly:music-sequence::maximum-length-callback)
369 (start-callback . ,ly:music-sequence::minimum-start-callback)
370 (types . (general-music part-combine-music))
371 (iterator-ctor . ,ly:part-combine-iterator::constructor)
375 (description . "Start or end phrasing slur.
377 Syntax NOTE \\( and \\) NOTE")
378 (types . (general-music span-event event phrasing-slur-event))
383 (description . "Set a context property.
385 Syntax: @code{\\property @var{context}.@var{prop} = @var{scheme-val}}.")
386 (types . (layout-instruction general-music))
387 (iterator-ctor . ,ly:property-iterator::constructor)
392 (description . "Remove the definition of a context @code{\\property}.")
394 (types . (layout-instruction general-music))
395 (iterator-ctor . ,ly:property-unset-iterator::constructor)
400 (description . "Used internally to signal percent repeats.")
401 (types . (general-music event percent-event))
406 (description . "Within a ligature, mark the previous and the
407 following note to form a pes (if melody goes up) or a flexa (if melody
410 (types . (general-music pes-or-flexa-event event))
415 (description . "Quote preprocessed snippets of music. ")
416 (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
417 (length-callback . ,ly:music-wrapper::length-callback)
418 (start-callback . ,ly:music-wrapper::start-callback)
419 (types . (general-music music-wrapper-music))
423 . ((description . "Check if a pitch is in the correct octave.")
424 (to-relative-callback . ,ly:relative-octave-check::relative-callback)
425 (types . (general-music relative-octave-check))
430 (description . "Repeat music in different ways")
431 (types . (general-music repeated-music))
435 (description . "Ties for starting a second volta bracket.")
436 (types . (general-music event repeat-tie-event))
440 (description . "A Rest.
442 Syntax @code{r4} for a quarter rest. ")
444 (types . (general-music event rhythmic-event rest-event))
448 (description . "The opposite of @ref{OverrideProperty}: remove a
449 previously added property from a graphical object definition
452 (types . (general-music layout-instruction))
453 (iterator-ctor . , ly:pop-property-iterator::constructor)
458 (description . "Music expressions concatenated.
460 Syntax \\sequential @{..@} or simply @{..@} .")
462 (length-callback . ,ly:music-sequence::cumulative-length-callback)
463 (start-callback . ,ly:music-sequence::first-start-callback)
464 (elements-callback . ,(lambda (m) (ly:music-property m 'elements)))
465 (iterator-ctor . ,ly:sequential-iterator::constructor)
466 (types . (general-music sequential-music))
471 (description . "Print Solo.1")
472 (part-combine-status . solo1)
473 (types . (general-music event part-combine-event))
477 (description . "Print Solo.2")
478 (part-combine-status . solo2)
479 (types . (general-music event part-combine-event))
482 . ((description . "Print a2")
483 (part-combine-status . unisono)
484 (types . (general-music event part-combine-event))))
488 (description . "Music playing together.
492 @code{ \\simultaneous @{ .. @}} or << .. >>.")
494 (iterator-ctor . ,ly:simultaneous-music-iterator::constructor)
495 (start-callback . ,ly:music-sequence::minimum-start-callback)
496 (length-callback . ,ly:music-sequence::maximum-length-callback)
497 (to-relative-callback . ,ly:music-sequence::simultaneous-relative-callback)
499 (types . (general-music simultaneous-music))
504 (description . "Start or end slur.
506 Syntax NOTE( and NOTE) ")
508 (types . (general-music span-event event slur-event))
512 . ((description . "Start or stop a staff symbol.")
513 (types . (general-music event span-event staff-span-event))
518 (description . "Used internally to signal beginning of notes.")
520 (types . (general-music event start-playing-event))
525 (description . "Start a text spanner like 8va.....|")
526 (types . (general-music span-event event text-span-event))
531 (description . "Start a trill spanner tr~~~")
532 (types . (general-music span-event event trill-span-event))
537 (description . "Music that has been transposed.")
538 (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
539 (start-callback . ,ly:music-wrapper::start-callback)
540 (length-callback . ,ly:music-wrapper::length-callback)
541 (to-relative-callback . ,ly:relative-octave-music::no-relative-callback)
542 (types . (music-wrapper-music general-music transposed-music))
547 (description . "Multiply durations, as in tuplets.
549 Syntax @code{\\times @var{fraction} @var{music}}, e.g.
550 @code{\\times 2/3 @{ ... @}} for triplets.
552 (length-callback . ,ly:music-wrapper::length-callback)
553 (start-callback . ,ly:music-wrapper::start-callback)
554 (iterator-ctor . ,ly:time-scaled-music-iterator::constructor)
555 (types . (time-scaled-music music-wrapper-music general-music))
560 (description . "Used internally to signal where tuplet brackets start and stop.")
561 (types . (tuplet-spanner-event span-event event general-music))
566 (description . "Music that can not be converted from relative to absolute notation.
567 For example, transposed music.")
568 (to-relative-callback . ,ly:relative-octave-music::no-relative-callback)
569 (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
570 (length-callback . ,ly:music-wrapper::length-callback)
571 (types . (music-wrapper-music general-music unrelativable-music))
576 (description . "Music that was entered in relative octave notation.")
577 (to-relative-callback . ,ly:relative-octave-music::relative-callback)
578 (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
579 (length-callback . ,ly:music-wrapper::length-callback)
580 (start-callback . ,ly:music-wrapper::start-callback)
581 (types . (music-wrapper-music general-music relative-octave-music))
585 (description . "Add an articulation mark to a note. ")
587 (types . (general-music event))
592 (description . "Filler that takes up duration, does not print anything, and also
593 does not create staffs or voices implicitly.
597 Syntax: @code{\\skip }@var{duration}.")
598 (length-callback . ,ly:music-duration-length)
599 (iterator-ctor . ,ly:simple-music-iterator::constructor)
600 (types . (general-music event rhythmic-event skip-event))
605 (description . "Filler that takes up duration, but does not print anything.
609 Syntax: @code{s}@var{duration}")
611 (types . (general-music event rhythmic-event skip-event))
615 . ((description . "Start a new spacing section")
616 (types . (general-music event spacing-section-event))))
620 (description . "Event for anything that is started at a different time than stopped.")
622 (types . (general-music event))
627 (description . "Depress or release sustain pedal. ")
628 (types . (general-music event pedal-event sustain-pedal-event))
633 (description . "Depress or release sostenuto pedal. ")
634 (types . (general-music event pedal-event sostenuto-pedal-event))
639 (description . "Depress or release una-corda pedal.")
640 (types . (general-music event pedal-event una-corda-pedal-event))
645 (description . "Specify on which string to play this note.
647 Syntax: @code{\\@var{number}}.")
649 (types . (general-music string-number-event event))
652 (MetronomeChangeEvent
654 (description . "Change tempo setting (in beats per minute).")
655 (types . (general-music metronome-change-event tempo-event event))
661 (types . (general-music script-event text-script-event event))
665 (description . "A tie. Entered as @var{note}-~.")
666 (types . (general-music tie-event event))
670 (description . "Un measured tremolo.")
671 (types . (general-music event tremolo-event))
676 (description . "Tremolo over two stems")
677 (types . (general-music event span-event tremolo-span-event))
682 (description . "Separate polyphonic voices in simultaneous music.
684 Syntax: @code{\\\\}")
686 (types . (separator general-music))
691 (iterator-ctor . ,ly:volta-repeat-iterator::constructor)
693 (start-callback . ,ly:repeated-music::first-start)
694 (length-callback . ,ly:repeated-music::volta-music-length)
695 (types . (general-music repeated-music volta-repeated-music))
698 (UnfoldedRepeatedMusic
700 (iterator-ctor . ,ly:unfolded-repeat-iterator::constructor)
702 (start-callback . ,ly:repeated-music::first-start)
703 (types . (general-music repeated-music unfolded-repeated-music))
704 (length-callback . ,ly:repeated-music::unfolded-music-length)
706 (PercentRepeatedMusic
708 (description . "Repeats encoded by percents.")
709 (iterator-ctor . ,ly:percent-repeat-iterator::constructor)
710 (start-callback . ,ly:repeated-music::first-start)
711 (length-callback . ,ly:repeated-music::unfolded-music-length)
712 (types . (general-music repeated-music percent-repeated-music))
715 (TremoloRepeatedMusic
717 (iterator-ctor . ,ly:chord-tremolo-iterator::constructor)
718 (description . "Repeated notes denoted by tremolo beams.")
719 (start-callback . ,ly:repeated-music::first-start)
721 ;; the length of the repeat is handled by shifting the note logs
722 (length-callback . ,ly:repeated-music::folded-music-length)
723 (types . (general-music repeated-music tremolo-repeated-music))
729 (description . "Repeats with alternatives placed in parallel. ")
730 (iterator-ctor . ,ly:folded-repeat-iterator::constructor)
731 (start-callback . ,ly:repeated-music::minimum-start)
732 (length-callback . ,ly:repeated-music::folded-music-length)
733 (types . (general-music repeated-music folded-repeated-music))
737 (set! music-descriptions
738 (sort music-descriptions alist<?))
740 (define-public music-name-to-property-table (make-vector 59 '()))
743 ;; transport description to an object property.
747 (set-object-property! (car x)
749 (cdr (assq 'description (cdr x))))
751 (set! lst (assoc-set! lst 'name (car x)))
752 (set! lst (assq-remove! lst 'description))
753 (hashq-set! music-name-to-property-table (car x) lst)
757 (define-safe-public (make-music name . music-properties)
758 "Create a music object of given name, and set its properties
759 according to `music-properties', a list of alterning property symbols
761 (make-music 'OverrideProperty
763 'grob-property 'thickness
764 'grob-value (* 2 1.5))"
765 (if (not (symbol? name))
766 (ly:error (_ "symbol expected: ~S") name))
767 (let ((props (hashq-ref music-name-to-property-table name '())))
768 (if (not (pair? props))
769 (ly:error (_ "can't find music object: ~S") name))
770 (let ((m (ly:make-music props)))
771 (define (set-props mus-props)
772 (if (and (not (null? mus-props))
773 (not (null? (cdr mus-props))))
775 (set! (ly:music-property m (car mus-props)) (cadr mus-props))
776 (set-props (cddr mus-props)))))
777 (set-props music-properties)
780 (define-public (make-repeated-music name)
781 (let* ((handle (assoc name '(("volta" . VoltaRepeatedMusic)
782 ("unfold" . UnfoldedRepeatedMusic)
783 ("percent" . PercentRepeatedMusic)
784 ("tremolo" . TremoloRepeatedMusic)
785 ("fold" . FoldedRepeatedMusic))))
786 (music-name (if (pair? handle)
789 (ly:warning (_ "unknown repeat type `~S'") name)
790 (ly:warning (_ "See music-types.scm for supported repeats"))
791 'VoltaRepeatedMusic))))
792 (make-music music-name)))