1 ;;;; define-music-types.scm --
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
8 ;; TODO: should link back into user manual.
10 (define (mm-rest-child-list music)
11 "Generate events for multimeasure rests, to be used by the sequential-iterator"
12 (let ((location (ly:music-property music 'origin))
13 (duration (ly:music-property music 'duration)))
14 (list (make-music 'BarCheck
16 (make-event-chord (cons (make-music 'MultiMeasureRestEvent
19 (ly:music-property music 'articulations)))
23 (define-public music-descriptions
27 (description . "Creates a dynamic mark.
29 Syntax: @var{note}@code{\\x},
30 where x is one of \\ppp, \\pp, \\p, \\mp, \\mf, \\f, \\ff, \\fff.")
31 (types . (general-music event dynamic-event absolute-dynamic-event))
35 . ((description . "Print an annotation of an output element.")
36 (types . (general-music event annotate-output-event))
41 (description . "Call the argument with the current context during interpreting phase")
42 (types . (general-music apply-context))
43 (iterator-ctor . ,ly:apply-context-iterator::constructor)
49 Call the argument with all current grobs during interpreting phase.
53 \\applyOutput #'Context FUNC
55 arguments to func are 1. the grob, 2. the originating context,
56 3. context where FUNC is called.
59 (types . (general-music event apply-output-event))
63 (description . "Make an arpeggio on this note.
66 @var{note}-@code{\\arpeggio}")
67 (types . (general-music arpeggio-event event))
70 ;; todo: use articulation-event for slur as well.
71 ;; separate non articulation scripts
74 (description . "Adds an articulation marking to a note.
77 @var{note}@code{X}@code{Y}, where X is a direction (up @code{^}, down
78 @code{_}, or LilyPond's choice (no direction specified)), and where Y
79 is an articulation (such as @code{-.}, @code{->}, @code{\\tenuto},
80 @code{\\downbow}). See the user manual for details.")
82 (types . (general-music event articulation-event script-event))
86 (description . "Used for making voices that switch between piano staves automatically.")
87 (iterator-ctor . ,ly:auto-change-iterator::constructor)
88 (start-callback . ,ly:music-wrapper::start-callback)
89 (length-callback . ,ly:music-wrapper::length-callback)
90 (types . (general-music music-wrapper-music auto-change-instruction))
95 "Check whether this music coincides with the start of the measure.")
96 (types . (general-music bar-check))
97 (iterator-ctor . ,ly:bar-check-iterator::constructor)
101 (description . "Print a bass-figure text")
103 (types . (general-music event rhythmic-event bass-figure-event))
108 (description . "Starts or stops a beam.
110 Syntax for manual control:
112 (types . (general-music event beam-event span-event))
115 . ((description . "A drop/fall/doit jazz articulation")
116 (types . (general-music bend-after-event event))))
120 (description . "Creates a `breath mark' or `comma'.
123 @var{note}\\breathe.")
125 (types . (general-music event breathing-event))
129 (description . "Change staffs in Piano staff.
131 Syntax @code{\\translator Staff = @var{new-id}}.")
132 (iterator-ctor . , ly:change-iterator::constructor)
133 (types . (general-music translator-change-instruction))
137 . ((description . "A note that is part of a cluster.")
139 ;; not a note-event, to ensure that Note_engraver doesn't eat it.
140 (types . (general-music cluster-note-event melodic-event rhythmic-event event))
145 (description . "Interpret the argument music within a specific context.")
146 (iterator-ctor . ,ly:context-specced-music-iterator::constructor)
147 (length-callback . ,ly:music-wrapper::length-callback)
148 (start-callback . ,ly:music-wrapper::start-callback)
149 (types . (context-specification general-music music-wrapper-music))
154 (description . "Begins or ends a crescendo.
156 Syntax: @var{note}\\cr
157 ... @var{note}\\rc (you can also use \\<, \\!, \\cresc, and
158 \\endcresc. See the user manual for details.).")
160 (types . (general-music span-event span-dynamic-event crescendo-event event))
164 (description . "See @ref{CrescendoEvent}.")
166 (types . (general-music span-event span-dynamic-event decrescendo-event event))
171 (description . "Extend lyrics.")
173 (types . (general-music extender-event event))
178 (description . "Atomic music event.")
179 (types . (general-music event))
184 (description . "Internally used to group a set of events.")
185 (iterator-ctor . ,ly:event-chord-iterator::constructor)
186 (length-callback . ,ly:music-sequence::maximum-length-callback)
187 (to-relative-callback . ,ly:music-sequence::event-chord-relative-callback)
188 (types . (general-music event-chord simultaneous-music))
194 (description . "Specify what finger to use for this note.")
195 (types . (general-music fingering-event event))
199 (description . "Specify that a note may not auto-beamed ")
200 (types . (general-music event beam-forbid-event))
204 (description . "Start a glissando on this note.")
205 (types . (general-music glissando-event event))
210 (description . "Interpret the argument as grace notes. ")
211 (start-callback . ,ly:grace-music::start-callback)
212 (length . ,ZERO-MOMENT)
213 (iterator-ctor . ,ly:grace-iterator::constructor)
214 (types . (grace-music music-wrapper-music general-music))
218 (description . "Start or stop grouping brackets.")
219 (types . (general-music event note-grouping-event))
223 (description . "Mark a note as harmonic")
224 (types . (general-music event harmonic-event))
228 (description . "A hyphen between lyric syllables.")
230 (types . (general-music hyphen-event event))
235 (description . "Change the key signature.
237 Syntax: @code{\\key } @var{name} @var{scale}.")
238 (to-relative-callback . ,(lambda (x p) p))
239 (types . (general-music key-change-event event))
242 . ((description . "Don't damp this chord.
244 Syntax: @var{note}\\laissezVibrer.")
246 (types . (general-music event laissez-vibrer-event))
250 (description . "Start or end a ligature.")
251 (span-type . ligature)
252 (types . (general-music span-event ligature-event event))
256 (description . "Allow, forbid or force a line break.")
257 (types . (general-music line-break-event break-event event))
262 (description . "Align lyrics to the start of notes.
264 Syntax @var{\\lyricsto }@var{voicename} @var{lyrics}.")
265 (length . ,ZERO-MOMENT)
266 (types . (general-music lyric-combine-music))
267 (iterator-ctor . ,ly:lyric-combine-music-iterator::constructor)
272 (description . "A lyric syllable. Must be entered in lyrics mode, i.e.
273 @code{\\lyrics @{ twinkle4 twinkle4 @} } .")
275 (types . (general-music rhythmic-event lyric-event event))
279 (description . "Insert a rehearsal mark.
281 Syntax: @code{\\mark} @var{marker},
282 e.g. @code{\\mark \"A\"}.")
284 (types . (general-music mark-event event))
286 (MultiMeasureRestMusic
288 (description . "Rests that may be compressed into Multi rests.
291 @code{R2.*4} for 4 measures in 3/4 time.")
292 (iterator-ctor . ,ly:sequential-iterator::constructor)
293 (elements-callback . ,mm-rest-child-list)
294 (types . (general-music multi-measure-rest))
297 (MultiMeasureRestEvent
299 (description . "Used internally by MultiMeasureRestMusic to signal rests")
300 (types . (general-music event rhythmic-event multi-measure-rest-event))
303 (MultiMeasureTextEvent
305 (description . "Texts on mm rests.
308 @code{R-\\markup @{ \\roman \"bla\" @}}. Note the explicit font switch.")
309 (types . (general-music event multi-measure-text-event))
314 (description . "Generic type for music expressions.")
316 (types . (general-music))
320 (description . "A note.")
321 (types . (general-music event note-event rhythmic-event melodic-event))
326 (description . "Extend the definition of a graphical object.
330 @code{\\override [ @var{Ctxt} . ] @var{Obj} @var{prop} = @var{val}}
332 (types . (general-music layout-instruction-event override-property-event))
333 (iterator-ctor . ,ly:push-property-iterator::constructor)
337 (description . "Allow, forbid or force a page break.")
338 (types . (general-music break-event page-break-event event))
342 (description . "Allow, forbid or force a page turn.")
343 (types . (general-music break-event page-turn-event event))
347 (description . "Combine two parts on a staff, either merged or
348 as separate voices.")
349 (length-callback . ,ly:music-sequence::maximum-length-callback)
350 (start-callback . ,ly:music-sequence::minimum-start-callback)
351 (types . (general-music part-combine-music))
352 (iterator-ctor . ,ly:part-combine-iterator::constructor)
356 (description . "Start or end phrasing slur.
358 Syntax NOTE \\( and \\) NOTE")
359 (types . (general-music span-event event phrasing-slur-event))
364 (description . "Set a context property.
366 Syntax: @code{\\property @var{context}.@var{prop} = @var{scheme-val}}.")
367 (types . (layout-instruction-event general-music))
368 (iterator-ctor . ,ly:property-iterator::constructor)
373 (description . "Remove the definition of a context @code{\\property}.")
375 (types . (layout-instruction-event general-music))
376 (iterator-ctor . ,ly:property-unset-iterator::constructor)
381 (description . "Used internally to signal percent repeats.")
382 (types . (general-music event percent-event rhythmic-event))
387 (description . "Within a ligature, mark the previous and the
388 following note to form a pes (if melody goes up) or a flexa (if melody
391 (types . (general-music pes-or-flexa-event event))
396 (description . "Quote preprocessed snippets of music. ")
397 (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
398 (length-callback . ,ly:music-wrapper::length-callback)
399 (start-callback . ,ly:music-wrapper::start-callback)
400 (types . (general-music music-wrapper-music))
404 . ((description . "Check if a pitch is in the correct octave.")
405 (to-relative-callback . ,ly:relative-octave-check::relative-callback)
406 (types . (general-music relative-octave-check))
411 (description . "Repeat music in different ways")
412 (types . (general-music repeated-music))
416 (description . "Ties for starting a second volta bracket.")
417 (types . (general-music event repeat-tie-event))
421 (description . "A Rest.
423 Syntax @code{r4} for a quarter rest. ")
425 (types . (general-music event rhythmic-event rest-event))
429 (description . "The opposite of @ref{OverrideProperty}: remove a
430 previously added property from a graphical object definition
433 (types . (general-music layout-instruction-event))
434 (iterator-ctor . , ly:pop-property-iterator::constructor)
439 (description . "Music expressions concatenated.
441 Syntax \\sequential @{..@} or simply @{..@} .")
443 (length-callback . ,ly:music-sequence::cumulative-length-callback)
444 (start-callback . ,ly:music-sequence::first-start-callback)
445 (elements-callback . ,(lambda (m) (ly:music-property m 'elements)))
446 (iterator-ctor . ,ly:sequential-iterator::constructor)
447 (types . (general-music sequential-music))
452 (description . "Print Solo.1")
453 (part-combine-status . solo1)
454 (types . (general-music event part-combine-event solo-one-event))
458 (description . "Print Solo.2")
459 (part-combine-status . solo2)
460 (types . (general-music event part-combine-event solo-two-event))
463 . ((description . "Print a2")
464 (part-combine-status . unisono)
465 (types . (general-music event part-combine-event unisono-event))))
469 (description . "Music playing together.
473 @code{ \\simultaneous @{ .. @}} or << .. >>.")
475 (iterator-ctor . ,ly:simultaneous-music-iterator::constructor)
476 (start-callback . ,ly:music-sequence::minimum-start-callback)
477 (length-callback . ,ly:music-sequence::maximum-length-callback)
478 (to-relative-callback . ,ly:music-sequence::simultaneous-relative-callback)
480 (types . (general-music simultaneous-music))
485 (description . "Start or end slur.
487 Syntax NOTE( and NOTE) ")
489 (types . (general-music span-event event slur-event))
493 . ((description . "Start or stop a staff symbol.")
494 (types . (general-music event span-event staff-span-event))
499 (description . "Start a text spanner like 8va.....|")
500 (types . (general-music span-event event text-span-event))
505 (description . "Start a trill spanner tr~~~")
506 (types . (general-music span-event event trill-span-event))
511 (description . "Music that has been transposed.")
512 (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
513 (start-callback . ,ly:music-wrapper::start-callback)
514 (length-callback . ,ly:music-wrapper::length-callback)
515 (to-relative-callback . ,ly:relative-octave-music::no-relative-callback)
516 (types . (music-wrapper-music general-music transposed-music))
521 (description . "Multiply durations, as in tuplets.
523 Syntax @code{\\times @var{fraction} @var{music}}, e.g.
524 @code{\\times 2/3 @{ ... @}} for triplets.
526 (length-callback . ,ly:music-wrapper::length-callback)
527 (start-callback . ,ly:music-wrapper::start-callback)
528 (iterator-ctor . ,ly:time-scaled-music-iterator::constructor)
529 (types . (time-scaled-music music-wrapper-music general-music))
534 (description . "Used internally to signal where tuplet brackets start and stop.")
535 (types . (tuplet-span-event span-event event general-music))
540 (description . "Music that can not be converted from relative to absolute notation.
541 For example, transposed music.")
542 (to-relative-callback . ,ly:relative-octave-music::no-relative-callback)
543 (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
544 (length-callback . ,ly:music-wrapper::length-callback)
545 (types . (music-wrapper-music general-music unrelativable-music))
550 (description . "Music that was entered in relative octave notation.")
551 (to-relative-callback . ,ly:relative-octave-music::relative-callback)
552 (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
553 (length-callback . ,ly:music-wrapper::length-callback)
554 (start-callback . ,ly:music-wrapper::start-callback)
555 (types . (music-wrapper-music general-music relative-octave-music))
559 (description . "Add an articulation mark to a note. ")
561 (types . (general-music event))
566 (description . "Filler that takes up duration, does not print anything, and also
567 does not create staffs or voices implicitly.
571 Syntax: @code{\\skip }@var{duration}.")
572 (length-callback . ,ly:music-duration-length)
573 (iterator-ctor . ,ly:simple-music-iterator::constructor)
574 (types . (general-music event rhythmic-event skip-event))
579 (description . "Filler that takes up duration, but does not print anything.
583 Syntax: @code{s}@var{duration}")
585 (types . (general-music event rhythmic-event skip-event))
589 . ((description . "Start a new spacing section")
590 (types . (general-music event spacing-section-event))))
594 (description . "Event for anything that is started at a different time than stopped.")
596 (types . (general-music event))
601 (description . "Depress or release sustain pedal. ")
602 (types . (general-music event pedal-event sustain-event))
607 (description . "Depress or release sostenuto pedal. ")
608 (types . (general-music event pedal-event sostenuto-event))
613 (description . "Depress or release una-corda pedal.")
614 (types . (general-music event pedal-event una-corda-event))
619 (description . "Specify on which string to play this note.
621 Syntax: @code{\\@var{number}}.")
623 (types . (general-music string-number-event event))
628 (description . "Specify with which finger to pluck a string.
630 Syntax: @code{\\rightHandFinger @var{text}}.")
632 (types . (general-music stroke-finger-event event))
638 (types . (general-music script-event text-script-event event))
642 (description . "A tie. Entered as @var{note}-~.")
643 (types . (general-music tie-event event))
647 (description . "Un measured tremolo.")
648 (types . (general-music event tremolo-event))
653 (description . "Tremolo over two stems")
654 (types . (general-music event span-event tremolo-span-event))
659 (description . "Separate polyphonic voices in simultaneous music.
661 Syntax: @code{\\\\}")
663 (types . (separator general-music))
668 (iterator-ctor . ,ly:volta-repeat-iterator::constructor)
670 (start-callback . ,ly:repeated-music::first-start)
671 (length-callback . ,ly:repeated-music::volta-music-length)
672 (types . (general-music repeated-music volta-repeated-music))
675 (UnfoldedRepeatedMusic
677 (iterator-ctor . ,ly:unfolded-repeat-iterator::constructor)
679 (start-callback . ,ly:repeated-music::first-start)
680 (types . (general-music repeated-music unfolded-repeated-music))
681 (length-callback . ,ly:repeated-music::unfolded-music-length)
683 (PercentRepeatedMusic
685 (description . "Repeats encoded by percents.")
686 (iterator-ctor . ,ly:percent-repeat-iterator::constructor)
687 (start-callback . ,ly:repeated-music::first-start)
688 (length-callback . ,ly:repeated-music::unfolded-music-length)
689 (types . (general-music repeated-music percent-repeated-music))
692 (TremoloRepeatedMusic
694 (iterator-ctor . ,ly:chord-tremolo-iterator::constructor)
695 (description . "Repeated notes denoted by tremolo beams.")
696 (start-callback . ,ly:repeated-music::first-start)
698 ;; the length of the repeat is handled by shifting the note logs
699 (length-callback . ,ly:repeated-music::folded-music-length)
700 (types . (general-music repeated-music tremolo-repeated-music))
706 (description . "Repeats with alternatives placed in parallel. ")
707 (iterator-ctor . ,ly:folded-repeat-iterator::constructor)
708 (start-callback . ,ly:repeated-music::minimum-start)
709 (length-callback . ,ly:repeated-music::folded-music-length)
710 (types . (general-music repeated-music folded-repeated-music))
714 (set! music-descriptions
715 (sort music-descriptions alist<?))
717 (define-public music-name-to-property-table (make-vector 59 '()))
720 ;; transport description to an object property.
724 (set-object-property! (car x)
726 (cdr (assq 'description (cdr x))))
728 (set! lst (assoc-set! lst 'name (car x)))
729 (set! lst (assq-remove! lst 'description))
730 (hashq-set! music-name-to-property-table (car x) lst)
734 (define-safe-public (make-music name . music-properties)
735 "Create a music object of given name, and set its properties
736 according to `music-properties', a list of alterning property symbols
738 (make-music 'OverrideProperty
740 'grob-property 'thickness
741 'grob-value (* 2 1.5))"
742 (if (not (symbol? name))
743 (ly:error (_ "symbol expected: ~S") name))
744 (let ((props (hashq-ref music-name-to-property-table name '())))
745 (if (not (pair? props))
746 (ly:error (_ "cannot find music object: ~S") name))
747 (let ((m (ly:make-music props)))
748 (define (set-props mus-props)
749 (if (and (not (null? mus-props))
750 (not (null? (cdr mus-props))))
752 (set! (ly:music-property m (car mus-props)) (cadr mus-props))
753 (set-props (cddr mus-props)))))
754 (set-props music-properties)
757 (define-public (make-repeated-music name)
758 (let* ((handle (assoc name '(("volta" . VoltaRepeatedMusic)
759 ("unfold" . UnfoldedRepeatedMusic)
760 ("percent" . PercentRepeatedMusic)
761 ("tremolo" . TremoloRepeatedMusic)
762 ("fold" . FoldedRepeatedMusic))))
763 (music-name (if (pair? handle)
766 (ly:warning (_ "unknown repeat type `~S'") name)
767 (ly:warning (_ "See music-types.scm for supported repeats"))
768 'VoltaRepeatedMusic))))
769 (make-music music-name)))