1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 1998--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
4 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
6 ;;;; LilyPond is free software: you can redistribute it and/or modify
7 ;;;; it under the terms of the GNU General Public License as published by
8 ;;;; the Free Software Foundation, either version 3 of the License, or
9 ;;;; (at your option) any later version.
11 ;;;; LilyPond is distributed in the hope that it will be useful,
12 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
13 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 ;;;; GNU General Public License for more details.
16 ;;;; You should have received a copy of the GNU General Public License
17 ;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
19 ;; TODO: should link back into user manual.
21 (define-public music-descriptions
24 . ((description . "Create a dynamic mark.
26 Syntax: @var{note}@code{\\x}, where @code{\\x} is a dynamic mark like
27 @code{\\ppp} or @code{\\sfz}. A complete list is in file
28 @file{ly/@/dynamic-scripts-init.ly}.")
29 (types . (general-music event dynamic-event absolute-dynamic-event))
33 . ((description . "Print an annotation of an output element.")
34 (types . (general-music event annotate-output-event))
38 . ((description . "Call the argument with the current context during
40 (types . (general-music apply-context))
41 (iterator-ctor . ,ly:apply-context-iterator::constructor)
45 . ((description . "Call the argument with all current grobs during
48 Syntax: @code{\\applyOutput #'@var{context} @var{func}}
50 Arguments to @var{func} are 1.@tie{}the grob, 2.@tie{}the originating
51 context, and 3.@tie{}the context where @var{func} is called.")
52 (types . (general-music event apply-output-event))
56 . ((description . "Make an arpeggio on this note.
58 Syntax: @var{note}@code{-\\arpeggio}")
59 (types . (general-music arpeggio-event event))
62 ;; todo: use articulation-event for slur as well.
63 ;; separate non articulation scripts
65 . ((description . "Add an articulation marking to a note.
67 Syntax: @var{note}@code{x}@code{y}, where @code{x} is a direction
68 (@code{^} for up or @code{_} for down), or LilyPond's choice
69 (no direction specified), and where @code{y} is an articulation
70 (such as @code{-.}, @code{->}, @code{\\tenuto}, @code{\\downbow}).
71 See the Notation Reference for details.")
72 (types . (general-music event articulation-event script-event))
76 . ((description . "Used for making voices that switch between
77 piano staves automatically.")
78 (iterator-ctor . ,ly:auto-change-iterator::constructor)
79 (start-callback . ,ly:music-wrapper::start-callback)
80 (length-callback . ,ly:music-wrapper::length-callback)
81 (types . (general-music music-wrapper-music auto-change-instruction))
85 . ((description . "Check whether this music coincides with
86 the start of the measure.")
87 (types . (general-music bar-check))
88 (iterator-ctor . ,ly:bar-check-iterator::constructor)
92 . ((description . "Print a bass-figure text.")
93 (types . (general-music event rhythmic-event bass-figure-event))
97 . ((description . "Start or stop a beam.
99 Syntax for manual control: @code{c8-[ c c-] c8}")
100 (types . (general-music event beam-event span-event))
104 . ((description . "Specify that a note may not auto-beamed.")
105 (types . (general-music event beam-forbid-event))
108 (BreakDynamicSpanEvent
109 . ((description . "End an alignment spanner for dynamics here.")
110 (types . (general-music break-span-event break-dynamic-span-event event))
114 . ((description . "A drop/fall/doit jazz articulation.")
115 (types . (general-music bend-after-event event))))
118 . ((description . "Create a @q{breath mark} or @q{comma}.
120 Syntax: @var{note}@code{\\breathe}")
122 (types . (general-music event breathing-event))
126 . ((description . "A note that is part of a cluster.")
127 ;; not a note-event, to ensure that Note_heads_engraver doesn't eat it.
128 (types . (general-music cluster-note-event melodic-event
129 rhythmic-event event))
132 (CompletizeExtenderEvent
133 . ((description . "Used internally to signal the end of a lyrics block to
134 ensure extenders are completed correctly when a @code{Lyrics} context ends
135 before its associated @code{Voice} context.")
136 (types . (general-music completize-extender-event event))
140 . ((description . "Change staves in Piano staff.
142 Syntax: @code{\\change Staff = @var{new-id}}")
143 (iterator-ctor . ,ly:change-iterator::constructor)
144 (types . (general-music translator-change-instruction))
148 . ((description . "Interpret the argument music within a
150 (iterator-ctor . ,ly:context-specced-music-iterator::constructor)
151 (length-callback . ,ly:music-wrapper::length-callback)
152 (start-callback . ,ly:music-wrapper::start-callback)
153 (types . (context-specification general-music music-wrapper-music))
157 . ((description . "Begin or end a crescendo.
159 Syntax: @var{note}@code{\\<} @dots{} @var{note}@code{\\!}
161 An alternative syntax is @var{note}@code{\\cr} @dots{}
162 @var{note}@code{\\endcr}.")
163 (types . (general-music span-event span-dynamic-event crescendo-event
168 . ((description . "Begin or end a decrescendo.
170 Syntax: @var{note}@code{\\>} @dots{} @var{note}@code{\\!}
172 An alternative syntax is @var{note}@code{\\decr} @dots{}
173 @var{note}@code{\\enddecr}.")
174 (types . (general-music span-event span-dynamic-event decrescendo-event
179 . ((description . "Used internally to signal double percent repeats.")
180 (types . (general-music event double-percent-event rhythmic-event))
184 . ((description . "Begin or end an episema.")
185 (types . (general-music span-event event episema-event))
189 . ((description . "Atomic music event.")
190 (types . (general-music event))
194 . ((description . "Internally used to group a set of events.")
195 (iterator-ctor . ,ly:event-chord-iterator::constructor)
196 (length-callback . ,ly:music-sequence::maximum-length-callback)
197 (to-relative-callback .
198 ,ly:music-sequence::event-chord-relative-callback)
199 (types . (general-music event-chord simultaneous-music))
203 . ((description . "Extend lyrics.")
204 (types . (general-music extender-event event))
208 . ((description . "Specify what finger to use for this note.")
209 (types . (general-music fingering-event event))
213 . ((description . "Start a glissando on this note.")
214 (types . (general-music glissando-event event))
218 . ((description . "Interpret the argument as grace notes.")
219 (start-callback . ,ly:grace-music::start-callback)
220 (length . ,ZERO-MOMENT)
221 (iterator-ctor . ,ly:grace-iterator::constructor)
222 (types . (grace-music music-wrapper-music general-music))
226 . ((description . "Mark a note as harmonic.")
227 (types . (general-music event harmonic-event))
231 . ((description . "A hyphen between lyric syllables.")
232 (types . (general-music hyphen-event event))
236 . ((description . "Change the key signature.
238 Syntax: @code{\\key} @var{name} @var{scale}")
239 (to-relative-callback . ,(lambda (x p) p))
240 (types . (general-music key-change-event event))
244 . ((description . "Place a bookmarking label.")
245 (types . (general-music label-event event))
249 . ((description . "Don't damp this chord.
251 Syntax: @var{note}@code{\\laissezVibrer}")
252 (types . (general-music event laissez-vibrer-event))
256 . ((description . "Start or end a ligature.")
257 (types . (general-music span-event ligature-event event))
261 . ((description . "Allow, forbid or force a line break.")
262 (types . (general-music line-break-event break-event event))
266 . ((description . "Align lyrics to the start of notes.
268 Syntax: @code{\\lyricsto} @var{voicename} @var{lyrics}")
269 (length . ,ZERO-MOMENT)
270 (types . (general-music lyric-combine-music))
271 (iterator-ctor . ,ly:lyric-combine-music-iterator::constructor)
275 . ((description . "A lyric syllable. Must be entered in lyrics mode,
276 i.e., @code{\\lyrics @{ twinkle4 twinkle4 @} }.")
277 (types . (general-music rhythmic-event lyric-event event))
281 . ((description . "Insert a rehearsal mark.
283 Syntax: @code{\\mark} @var{marker}
285 Example: @code{\\mark \"A\"}")
286 (types . (general-music mark-event event))
289 (MultiMeasureRestEvent
290 . ((description . "Used internally by @code{MultiMeasureRestMusic}
292 (types . (general-music event rhythmic-event
293 multi-measure-rest-event))
296 (MultiMeasureRestMusic
297 . ((description . "Rests that may be compressed into Multi rests.
299 Syntax: @code{R2.*4} for 4 measures in 3/4 time.")
300 (iterator-ctor . ,ly:sequential-iterator::constructor)
301 (elements-callback . ,mm-rest-child-list)
302 (types . (general-music multi-measure-rest))
305 (MultiMeasureTextEvent
306 . ((description . "Texts on multi measure rests.
308 Syntax: @code{R-\\markup @{ \\roman \"bla\" @}}
310 Note the explicit font switch.")
311 (types . (general-music event multi-measure-text-event))
315 . ((description . "Generic type for music expressions.")
316 (types . (general-music))
320 . ((description . "A note.")
321 (types . (general-music event note-event rhythmic-event
326 . ((description . "Start or stop grouping brackets.")
327 (types . (general-music event note-grouping-event))
331 . ((description . "Start or stop an ottava bracket.")
332 (iterator-ctor . ,ly:sequential-iterator::constructor)
333 (elements-callback . ,make-ottava-set)
334 (types . (general-music ottava-music))
338 . ((description . "Extend the definition of a graphical object.
340 Syntax: @code{\\override} [ @var{context} @code{.} ]
341 @var{object} @var{property} @code{=} @var{value}")
342 (types . (general-music layout-instruction-event
343 override-property-event))
344 (iterator-ctor . ,ly:push-property-iterator::constructor)
348 . ((description . "Allow, forbid or force a page break.")
349 (types . (general-music break-event page-break-event event))
353 . ((description . "Allow, forbid or force a page turn.")
354 (types . (general-music break-event page-turn-event event))
357 (PartCombineForceEvent
358 . ((description . "Override the part-combiner's strategy.")
359 (types . (general-music part-combine-force-event event))
363 . ((description . "Create an anacrusis or upbeat (partial measure).")
364 (iterator-ctor . ,ly:partial-iterator::constructor)
365 (types . (general-music partial-set))
369 . ((description . "Combine two parts on a staff, either merged or
370 as separate voices.")
371 (length-callback . ,ly:music-sequence::maximum-length-callback)
372 (start-callback . ,ly:music-sequence::minimum-start-callback)
373 (types . (general-music part-combine-music))
374 (iterator-ctor . ,ly:part-combine-iterator::constructor)
378 . ((description . "Used internally to signal percent repeats.")
379 (types . (general-music event percent-event rhythmic-event))
382 (PercentRepeatedMusic
383 . ((description . "Repeats encoded by percents and slashes.")
384 (iterator-ctor . ,ly:percent-repeat-iterator::constructor)
385 (start-callback . ,ly:repeated-music::first-start)
386 (length-callback . ,ly:repeated-music::unfolded-music-length)
387 (types . (general-music repeated-music percent-repeated-music))
391 . ((description . "Within a ligature, mark the previous and the
392 following note to form a pes (if melody goes up) or a flexa (if melody
394 (types . (general-music pes-or-flexa-event event))
398 . ((description . "Start or end phrasing slur.
400 Syntax: @var{note}@code{\\(} and @var{note}@code{\\)}")
401 (types . (general-music span-event event phrasing-slur-event))
405 . ((description . "Set a context property.
407 Syntax: @code{\\set @var{context}.@var{prop} = @var{scheme-val}}")
408 (types . (layout-instruction-event general-music))
409 (iterator-ctor . ,ly:property-iterator::constructor)
413 . ((description . "Restore the default setting for a context
414 property. See @ref{PropertySet}.
416 Syntax: @code{\\unset @var{context}.@var{prop}}")
417 (types . (layout-instruction-event general-music))
418 (iterator-ctor . ,ly:property-unset-iterator::constructor)
422 . ((description . "Quote preprocessed snippets of music.")
423 (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
424 (length-callback . ,ly:music-wrapper::length-callback)
425 (start-callback . ,ly:music-wrapper::start-callback)
426 (types . (general-music music-wrapper-music))
430 . ((description . "Check if a pitch is in the correct octave.")
431 (to-relative-callback . ,ly:relative-octave-check::relative-callback)
432 (types . (general-music relative-octave-check))
436 . ((description . "Music that was entered in relative octave notation.")
437 (to-relative-callback . ,ly:relative-octave-music::relative-callback)
438 (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
439 (length-callback . ,ly:music-wrapper::length-callback)
440 (start-callback . ,ly:music-wrapper::start-callback)
441 (types . (music-wrapper-music general-music relative-octave-music))
445 . ((description . "A chord repetition")
446 (to-relative-callback . ,ly:music-sequence::repeated-chord-relative-callback)
447 (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
448 (start-callback . ,ly:music-wrapper::start-callback)
449 (length-callback . ,ly:music-wrapper::length-callback)
450 (types . (general-music music-wrapper-music))
454 . ((description . "Repeat music in different ways.")
455 (types . (general-music repeated-music))
459 . ((description . "Used internally to signal beat repeats.")
460 (types . (general-music event repeat-slash-event rhythmic-event))
464 . ((description . "Ties for starting a second volta bracket.")
465 (types . (general-music event repeat-tie-event))
469 . ((description . "A Rest.
471 Syntax: @code{r4} for a quarter rest.")
472 (types . (general-music event rhythmic-event rest-event))
476 . ((description . "The opposite of @ref{OverrideProperty}: remove a
477 previously added property from a graphical object definition.")
478 (types . (general-music layout-instruction-event))
479 (iterator-ctor . ,ly:pop-property-iterator::constructor)
483 . ((description . "Add an articulation mark to a note.")
484 (types . (general-music event))
488 . ((description . "Music expressions concatenated.
490 Syntax: @code{\\sequential @{ @dots{} @}} or simply @code{@{ @dots{} @}}")
491 (length-callback . ,ly:music-sequence::cumulative-length-callback)
492 (start-callback . ,ly:music-sequence::first-start-callback)
493 (elements-callback . ,(lambda (m) (ly:music-property m 'elements)))
494 (iterator-ctor . ,ly:sequential-iterator::constructor)
495 (types . (general-music sequential-music))
499 . ((description . "Music playing together.
501 Syntax: @code{\\simultaneous @{ @dots{} @}} or @code{<< @dots{} >>}")
502 (iterator-ctor . ,ly:simultaneous-music-iterator::constructor)
503 (start-callback . ,ly:music-sequence::minimum-start-callback)
504 (length-callback . ,ly:music-sequence::maximum-length-callback)
505 (to-relative-callback .
506 ,ly:music-sequence::simultaneous-relative-callback)
507 (types . (general-music simultaneous-music))
511 . ((description . "Filler that takes up duration, but does not
514 Syntax: @code{s4} for a skip equivalent to a quarter rest.")
515 (types . (general-music event rhythmic-event skip-event))
519 . ((description . "Filler that takes up duration, does not
520 print anything, and also does not create staves or voices implicitly.
522 Syntax: @code{\\skip} @var{duration}")
523 (length-callback . ,ly:music-duration-length)
524 (iterator-ctor . ,ly:simple-music-iterator::constructor)
525 (types . (general-music event rhythmic-event skip-event))
529 . ((description . "Start or end slur.
531 Syntax: @var{note}@code{(} and @var{note}@code{)}")
532 (types . (general-music span-event event slur-event))
536 . ((description . "Print @q{Solo@tie{}1}.")
537 (part-combine-status . solo1)
538 (types . (general-music event part-combine-event solo-one-event))
542 . ((description . "Print @q{Solo@tie{}2}.")
543 (part-combine-status . solo2)
544 (types . (general-music event part-combine-event solo-two-event))
548 . ((description . "Depress or release sostenuto pedal.")
549 (types . (general-music event pedal-event sostenuto-event))
553 . ((description . "Start a new spacing section.")
554 (types . (general-music event spacing-section-event))))
557 . ((description . "Event for anything that is started at a
558 different time than stopped.")
559 (types . (general-music event))
563 . ((description . "Start or stop a staff symbol.")
564 (types . (general-music event span-event staff-span-event))
568 . ((description . "Specify on which string to play this note.
570 Syntax: @code{\\@var{number}}")
571 (types . (general-music string-number-event event))
575 . ((description . "Specify with which finger to pluck a string.
577 Syntax: @code{\\rightHandFinger @var{text}}")
578 (types . (general-music stroke-finger-event event))
582 . ((description . "Depress or release sustain pedal.")
583 (types . (general-music event pedal-event sustain-event))
587 . ((description . "A metronome mark or tempo indication.")
588 (types . (general-music event tempo-change-event))
592 . ((description . "Print text.")
593 (types . (general-music script-event text-script-event event))
597 . ((description . "Start a text spanner, for example, an
599 (types . (general-music span-event event text-span-event))
603 . ((description . "A tie.
605 Syntax: @var{note}@code{-~}")
606 (types . (general-music tie-event event))
610 . ((description . "Multiply durations, as in tuplets.
612 Syntax: @code{\\times @var{fraction} @var{music}}, e.g.,
613 @code{\\times 2/3 @{ @dots{} @}} for triplets.")
614 (length-callback . ,ly:music-wrapper::length-callback)
615 (start-callback . ,ly:music-wrapper::start-callback)
616 (iterator-ctor . ,ly:tuplet-iterator::constructor)
617 (types . (time-scaled-music music-wrapper-music general-music))
621 . ((description . "Set a new time signature")
622 (iterator-ctor . ,ly:sequential-iterator::constructor)
623 (elements-callback . ,make-time-signature-set)
624 (types . (general-music time-signature-music))
628 . ((description . "Music that has been transposed.")
629 (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
630 (start-callback . ,ly:music-wrapper::start-callback)
631 (length-callback . ,ly:music-wrapper::length-callback)
632 (to-relative-callback .
633 ,ly:relative-octave-music::no-relative-callback)
634 (types . (music-wrapper-music general-music transposed-music))
638 . ((description . "Unmeasured tremolo.")
639 (types . (general-music event tremolo-event))
642 (TremoloRepeatedMusic
643 . ((description . "Repeated notes denoted by tremolo beams.")
644 (iterator-ctor . ,ly:chord-tremolo-iterator::constructor)
645 (start-callback . ,ly:repeated-music::first-start)
646 ;; the length of the repeat is handled by shifting the note logs
647 (length-callback . ,ly:repeated-music::folded-music-length)
648 (types . (general-music repeated-music tremolo-repeated-music))
652 . ((description . "Tremolo over two stems.")
653 (types . (general-music event span-event tremolo-span-event))
657 . ((description . "Start a trill spanner.")
658 (types . (general-music span-event event trill-span-event))
662 . ((description . "Used internally to signal where tuplet
663 brackets start and stop.")
664 (types . (tuplet-span-event span-event event general-music))
668 . ((description . "Depress or release una-corda pedal.")
669 (types . (general-music event pedal-event una-corda-event))
672 (UnfoldedRepeatedMusic
673 . ((description . "Repeated music which is fully written
675 (iterator-ctor . ,ly:unfolded-repeat-iterator::constructor)
676 (start-callback . ,ly:repeated-music::first-start)
677 (types . (general-music repeated-music unfolded-repeated-music))
678 (length-callback . ,ly:repeated-music::unfolded-music-length)
682 . ((description . "Print @q{a@tie{}2}.")
683 (part-combine-status . unisono)
684 (types . (general-music event part-combine-event unisono-event))))
687 . ((description . "Music that cannot be converted from relative
688 to absolute notation. For example, transposed music.")
689 (to-relative-callback . ,ly:relative-octave-music::no-relative-callback)
690 (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
691 (length-callback . ,ly:music-wrapper::length-callback)
692 (types . (music-wrapper-music general-music unrelativable-music))
696 . ((description . "Separate polyphonic voices in simultaneous music.
698 Syntax: @code{\\\\}")
699 (types . (separator general-music))
703 . ((description . "Repeats with alternatives placed sequentially.")
704 (iterator-ctor . ,ly:volta-repeat-iterator::constructor)
705 (start-callback . ,ly:repeated-music::first-start)
706 (length-callback . ,ly:repeated-music::volta-music-length)
707 (types . (general-music repeated-music volta-repeated-music))
711 (set! music-descriptions
712 (sort music-descriptions alist<?))
714 (define-public music-name-to-property-table (make-hash-table 59))
717 ;; transport description to an object property.
721 (set-object-property! (car x)
723 (cdr (assq 'description (cdr x))))
725 (set! lst (assoc-set! lst 'name (car x)))
726 (set! lst (assq-remove! lst 'description))
727 (hashq-set! music-name-to-property-table (car x) lst)
731 (define-safe-public (make-music name . music-properties)
732 "Create a music object of given name, and set its properties
733 according to @code{music-properties}, a list of alternating property symbols
735 (make-music 'OverrideProperty
737 'grob-property 'thickness
738 'grob-value (* 2 1.5))"
739 (if (not (symbol? name))
740 (ly:error (_ "symbol expected: ~S") name))
741 (let ((props (hashq-ref music-name-to-property-table name '())))
742 (if (not (pair? props))
743 (ly:error (_ "cannot find music object: ~S") name))
744 (let ((m (ly:make-music props)))
745 (define (set-props mus-props)
746 (if (and (not (null? mus-props))
747 (not (null? (cdr mus-props))))
749 (set! (ly:music-property m (car mus-props)) (cadr mus-props))
750 (set-props (cddr mus-props)))))
751 (set-props music-properties)
754 (define-public (make-repeated-music name)
755 (let* ((repeated-music (assoc-get name '(("volta" . VoltaRepeatedMusic)
756 ("unfold" . UnfoldedRepeatedMusic)
757 ("percent" . PercentRepeatedMusic)
758 ("tremolo" . TremoloRepeatedMusic))))
759 (repeated-music-name (if repeated-music
762 (ly:warning (_ "unknown repeat type `~S'") name)
763 (ly:warning (_ "See define-music-types.scm for supported repeats"))
764 'VoltaRepeatedMusic))))
765 (make-music repeated-music-name)))