1 @c -*- coding: utf-8; mode: texinfo; -*-
4 Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
6 When revising a translation, copy the HEAD committish of the
7 version that you are working on. For details, see the Contributors'
8 Guide, node Updating translation committishes..
13 @node General input and output
14 @chapter General input and output
16 This section deals with general LilyPond input and output issues,
17 rather than specific notation.
21 * Titles and headers::
22 * Working with input files::
23 * Controlling output::
25 * Extracting musical information::
30 @section Input structure
32 The main format of input for LilyPond are text files. By convention,
33 these files end with @file{.ly}.
36 * Structure of a score::
37 * Multiple scores in a book::
38 * Multiple output files from one input file::
44 @node Structure of a score
45 @subsection Structure of a score
49 A @code{\score} block must contain a single music expression
50 delimited by curly brackets:
58 @warning{There must be @strong{only one} outer music expression in
59 a @code{\score} block, and it @strong{must} be surrounded by
62 This single music expression may be of any size, and may contain
63 other music expressions to any complexity. All of these examples
64 are music expressions:
70 @lilypond[verbatim,quote]
77 @lilypond[verbatim,quote]
79 \new Staff { c'4 c' c' c' }
80 \new Staff { d'4 d' d' d' }
88 \new Staff @{ \flute @}
89 \new Staff @{ \oboe @}
92 \new Staff @{ \violinI @}
93 \new Staff @{ \violinII @}
99 Comments are one exception to this general rule. (For others see
100 @ref{File structure}.) Both single-line comments and comments
101 delimited by @code{%@{ .. %@}} may be placed anywhere within an
102 input file. They may be placed inside or outside a @code{\score}
103 block, and inside or outside the single music expression within a
106 Remember that even in a file containing only a @code{\score} block, it
107 is implicitly enclosed in a \book block. A \book block in a source
108 file produces at least one output file, and by default the name of the
109 output file produced is derived from the name of the input file, so
110 @file{fandangoforelephants.ly} will produce
111 @file{fandangoforelephants.pdf}.
113 (For more details about @code{\book} blocks, see
114 @ref{Multiple scores in a book},
115 @ref{Multiple output files from one input file} @ref{File structure}.)
119 @rlearning{Working on input files},
120 @rlearning{Music expressions explained},
121 @rlearning{Score is a (single) compound musical expression}.
124 @node Multiple scores in a book
125 @subsection Multiple scores in a book
128 @cindex movements, multiple
130 A document may contain multiple pieces of music and text. Examples
131 of these are an etude book, or an orchestral part with multiple
132 movements. Each movement is entered with a @code{\score} block,
140 and texts are entered with a @code{\markup} block,
150 All the movements and texts which appear in the same @file{.ly} file
151 will normally be typeset in the form of a single output file.
165 One important exception is within lilypond-book documents,
166 where you explicitly have to add a @code{\book} block, otherwise only
167 the first @code{\score} or @code{\markup} will appear in the output.
169 The header for each piece of music can be put inside the @code{\score}
170 block. The @code{piece} name from the header will be printed before
171 each movement. The title for the entire book can be put inside the
172 @code{\book}, but if it is not present, the @code{\header} which is at
173 the top of the file is inserted.
177 title = "Eight miniatures"
178 composer = "Igor Stravinsky"
182 \header @{ piece = "Romanze" @}
185 ..text of second verse..
188 ..text of third verse..
192 \header @{ piece = "Menuetto" @}
198 Pieces of music may be grouped into book parts using @code{\bookpart}
199 blocks. Book parts are separated by a page break, and can start with a
200 title, like the book itself, by specifying a @code{\header} block.
206 subtitle = "First part"
213 subtitle = "Second part"
220 @node Multiple output files from one input file
221 @subsection Multiple output files from one input file
223 If you want multiple output files from the same @file{.ly} file,
224 then you can add multiple @code{\book} blocks, where each
225 such \book block will result in a separate output file.
226 If you do not specify any @code{\book} block in the
227 input file, LilyPond will implicitly treat the whole
228 file as a single \book block, see
229 @ref{File structure}.
231 When producing multiple files from a single source file, Lilypond
232 ensures that none of the output files from any @code{\book} block
233 overwrites the output file produced by a preceding @code{\book} from
236 It does this by adding a suffix to the output name for each
237 @code{\book} which uses the default output file name derived from the
240 The default behaviour is to append a version-number suffix for each
241 name which may clash, so
246 \layout @{ @dots{} @}
250 \layout @{ @dots{} @}
254 \layout @{ @dots{} @}
258 in source file @file{eightminiatures.ly}
263 @file{eightminiatures.pdf},
265 @file{eightminiatures-1.pdf} and
267 @file{eightminiatures-2.pdf}.
270 @node Output file names
271 @subsection Output file names
273 @funindex \bookOutputSuffix
274 @funindex \bookOutputName
276 Lilypond provides facilities to allow you to control what file names
277 are used by the various back-ends when producing output files.
279 In the previous section, we saw how Lilypond prevents name-clashes when
280 producing several ouputs from a single source file. You also have the
281 ability to specify your own suffixes for each @code{\book} block, so
282 for example you can produce files called
283 @file{eightminiatures-Romanze.pdf}, @file{eightminiatures-Menuetto.pdf}
284 and @file{eightminiatures-Nocturne.pdf} by adding a
285 @code{\bookOutputSuffix} declaration inside each @code{\book} block.
289 \bookOutputSuffix "Romanze"
291 \layout @{ @dots{} @}
294 \bookOutputSuffix "Menuetto"
296 \layout @{ @dots{} @}
299 \bookOutputSuffix "Nocturne"
301 \layout @{ @dots{} @}
305 You can also specify a different output filename for @code{book} block,
306 by using @code{\bookOutputName} declarations
310 \bookOutputName "Romanze"
312 \layout @{ @dots{} @}
315 \bookOutputName "Menuetto"
317 \layout @{ @dots{} @}
320 \bookOutputName "Nocturne"
322 \layout @{ @dots{} @}
326 The file above will produce these output files:
332 @file{Menuetto.pdf} and
339 @subsection File structure
349 A @file{.ly} file may contain any number of toplevel expressions, where a
350 toplevel expression is one of the following:
354 An output definition, such as @code{\paper}, @code{\midi}, and
355 @code{\layout}. Such a definition at the toplevel changes the default
356 book-wide settings. If more than one such definition of
357 the same type is entered at the top level any definitions in the later
358 expressions have precedence.
361 A direct scheme expression, such as
362 @code{#(set-default-paper-size "a7" 'landscape)} or
363 @code{#(ly:set-option 'point-and-click #f)}.
366 A @code{\header} block. This sets the global header block. This
367 is the block containing the definitions for book-wide settings, like
368 composer, title, etc.
371 A @code{\score} block. This score will be collected with other
372 toplevel scores, and combined as a single @code{\book}.
373 This behavior can be changed by setting the variable
374 @code{toplevel-score-handler} at toplevel. The default handler is
375 defined in the init file @file{../scm/lily.scm}.
378 A @code{\book} block logically combines multiple movements
379 (i.e., multiple @code{\score} blocks) in one document. If there
380 are a number of @code{\score}s, one output file will be created
381 for each @code{\book} block, in which all corresponding movements
382 are concatenated. The only reason to explicitly specify
383 @code{\book} blocks in a @file{.ly} file is if you wish to create
384 multiple output files from a single input file. One exception is
385 within lilypond-book documents, where you explicitly have to add
386 a @code{\book} block if you want more than a single @code{\score}
387 or @code{\markup} in the same example. This behavior can be
388 changed by setting the variable @code{toplevel-book-handler} at
389 toplevel. The default handler is defined in the init file
390 @file{../scm/lily.scm}.
393 A @code{\bookpart} block. A book may be divided into several parts,
394 using @code{\bookpart} blocks, in order to ease the page breaking,
395 or to use different @code{\paper} settings in different parts.
398 A compound music expression, such as
403 This will add the piece in a @code{\score} and format it in a
404 single book together with all other toplevel @code{\score}s and music
405 expressions. In other words, a file containing only the above
406 music expression will be translated into
422 This behavior can be changed by setting the variable
423 @code{toplevel-music-handler} at toplevel. The default handler is
424 defined in the init file @file{../scm/lily.scm}.
427 A markup text, a verse for example
430 2. The first line verse two.
434 Markup texts are rendered above, between or below the scores or music
435 expressions, wherever they appear.
445 This can be used later on in the file by entering @code{\foo}. The
446 name of a variable should have alphabetic characters only; no
447 numbers, underscores or dashes.
451 The following example shows three things that may be entered at
456 % Don't justify the output
468 At any point in a file, any of the following lexical instructions can
472 @item @code{\version}
473 @item @code{\include}
474 @item @code{\sourcefilename}
475 @item @code{\sourcefileline}
477 A single-line comment, introduced by a leading @code{%} sign.
480 A multi-line comment delimited by @code{%@{ .. %@}}.
486 Whitespace between items in the input stream is generally ignored,
487 and may be freely omitted or extended to enhance readability.
488 However, whitespace should always be used in the following
489 circumstances to avoid errors:
492 @item Around every opening and closing curly bracket.
493 @item After every command or variable, i.e. every item that
494 begins with a @code{\} sign.
495 @item After every item that is to be interpreted as a Scheme
496 expression, i.e. every item that begins with a @code{#}@tie{}sign.
497 @item To separate all elements of a Scheme expression.
498 @item In @code{lyricmode} to separate all the terms in both
499 @code{\override} and @code{\set} commands. In particular, spaces
500 must be used around the dot and the equals sign in commands like
501 @code{\override Score . LyricText #'font-size = #5} and before and
502 after the entire command.
509 @rlearning{How LilyPond input files work}.
512 @node Titles and headers
513 @section Titles and headers
515 Almost all printed music includes a title and the composer's name;
516 some pieces include a lot more information.
519 * Creating titles headers and footers::
520 * Custom headers footers and titles::
521 * Reference to page numbers::
522 * Table of contents::
526 @node Creating titles headers and footers
527 @subsection Creating titles headers and footers
530 * Title blocks explained::
531 * Default layout of book and score title blocks::
532 * Default layout of headers and footers::
536 @node Title blocks explained
537 @unnumberedsubsubsec Title blocks explained
539 @c TODO: figure out how \bookpart titles work
541 There are two types of title blocks: the main title block that appears
542 above of the first @code{\score} of a book, and individual title
543 blocks that appear within each @code{\score} block. Text fields for
544 both types are entered using a @code{\header} block.
546 If the book only has a single score, the @code{\header} block may be
547 placed inside or outside of the @code{\score} block.
549 @warning{Remember when adding a @bs{}@code{header} block inside a
550 @bs{}@code{score} block, that the music expression must come before the
551 @bs{}@code{header} block.}
553 @lilypond[papersize=a5,quote,verbatim,noragged-right]
556 composer = "J. S. Bach."
560 \new Staff \relative g, {
563 \repeat unfold 2 { g16( d' b') a b d, b' d, } |
564 \repeat unfold 2 { g,16( e' c') b c e, c' e, } |
572 \new Staff \relative b {
576 <g, d' b'~>4 b'16 a( g fis) g( d e fis) g( a b c) |
577 d16( b g fis) g( e d c) b(c d e) fis( g a b) |
585 Text fields from the main title block of a book can be displayed in all
586 @code{\score} blocks, or manually suppressed:
588 @lilypond[papersize=a5,quote,verbatim,noragged-right]
591 print-all-headers = ##t
594 title = "DAS WOHLTEMPERIRTE CLAVIER"
596 % Do not display the tagline for this book
599 \markup { \vspace #1 }
603 \new Staff { \clef "bass" s1 }
606 title = "PRAELUDIUM I"
608 % Do not display the subtitle for this score
615 \new Staff { \clef "bass" s1 }
619 subsubtitle = "A 4 VOCI"
621 % Do not display the subtitle for this score
630 @ref{File structure},
631 @ref{Custom layout for title blocks}.
634 @node Default layout of book and score title blocks
635 @unnumberedsubsubsec Default layout of book and score title blocks
637 The layout and formatting of title blocks are controlled by two
638 @code{\paper} variables; @code{bookTitleMarkup} for the main
639 @code{\header} title block and @code{scoreTitleMarkup} for individual
640 @code{\header} blocks within a @code{\score}.
642 @lilypond[papersize=a6,quote,verbatim,noragged-right]
644 % The following fields are centered
645 dedication = "Dedication"
647 subtitle = "Subtitle"
648 subsubtitle = "Subsubtitle"
649 instrument = "Instrument"
651 % The following fields are left-aligned on the left side
655 % The following fields are right-aligned on the right side
656 composer = "Composer"
657 arranger = "Arranger"
663 % The following fields are placed at opposite ends of the same line
670 @c Is the bit about \null markups true? -mp
672 Text fields left unset in a @code{\header} block are replaced with
673 @code{\null} markups so that the space is not wasted.
675 The default settings for @code{scoreTitleMarkup} place the @code{piece}
676 and @code{opus} text fields at opposite ends of the same line.
680 Use the @code{breakbefore} variable inside a @code{\header} block
681 that is itself in a @code{\score} block, to make the top-level
682 @code{\header} block titles appear on the first page on their own, with
683 the music (defined in the @code{\score} block) starting on the next.
685 @lilypond[papersize=a8landscape,verbatim,noragged-right]
688 title = "This is my Title"
689 subtitle = "This is my Subtitle"
690 copyright = "This is the bottom of the first page"
693 \repeat unfold 4 { e'' e'' e'' e'' }
695 piece = "This is the Music"
704 @rlearning{How LilyPond input files work},
707 @ref{File structure}.
710 @file{ly/titling-init.ly}.
712 @node Default layout of headers and footers
713 @unnumberedsubsubsec Default layout of headers and footers
715 @emph{Headers} and @emph{footers} are lines of text appearing at
716 the top and bottom of pages, separate from the main text of a book.
717 They are controlled by the following @code{\paper} variables:
720 @item @code{oddHeaderMarkup}
721 @item @code{evenHeaderMarkup}
722 @item @code{oddFooterMarkup}
723 @item @code{evenFooterMarkup}
726 These markup variables can only access text fields from top-level
727 @code{\header} blocks (which apply to all scores in the book) and are
728 defined in @file{ly/titling-init.ly}. By default:
733 page numbers are automatically placed on the top far left (if even) or
734 top far right (if odd), starting from the second page.
737 the @code{instrument} text field is placed in the center of every
738 page, starting from the second page.
741 the @code{copyright} text is centered on the bottom of the first page.
744 the @code{tagline} is centered on the bottom of the last page, and below
745 the @code{copyright} text if there is only a single page.
749 @lilypond[papersize=a8landscape]
759 The default tagline can be changed by adding a @code{tagline} in the
760 top-level @code{\header} block.
762 @lilypond[papersize=a8landscape,verbatim]
765 tagline = "... music notation for Everyone"
775 To remove the @code{tagline} set the value to @code{##f}.
778 @node Custom headers footers and titles
779 @subsection Custom headers footers and titles
781 @c TODO: somewhere put a link to header spacing info
782 @c (you'll have to explain it more in NR 4).
785 * Custom text formatting for title blocks::
786 * Custom layout for title blocks::
787 * Custom layout for headers and footers::
791 @node Custom text formatting for title blocks
792 @unnumberedsubsubsec Custom text formatting for title blocks
794 Standard @code{\markup} commands can be used to customize any header,
795 footer and title text within the @code{\header} block.
797 @lilypond[quote,verbatim,noragged-right]
801 piece = \markup { \fontsize #4 \bold "PRAELUDIUM I" }
802 subtitle = \markup { \italic "(Excerpt)" }
809 @ref{Formatting text}.
812 @node Custom layout for title blocks
813 @unnumberedsubsubsec Custom layout for title blocks
815 @code{\markup} commands in the @code{\header} block are useful for
816 simple text formatting, but they do not allow precise control over the
817 placement of titles. To customize the placement of the text fields,
818 use either or both of the following @code{\paper} variables:
821 @item @code{bookTitleMarkup}
822 @item @code{scoreTitleMarkup}
825 These markup variables are discussed in
826 @ref{Default layout of book and score title blocks}.
828 The default settings for @code{scoreTitleMarkup} as defined in
829 @file{ly/titling-init.ly} are:
832 scoreTitleMarkup = \markup @{ \column @{
833 \on-the-fly #print-all-headers @{ \bookTitleMarkup \hspace #1 @}
835 \fromproperty #'header:piece
836 \fromproperty #'header:opus
842 This places the @code{piece} and @code{opus} text fields at opposite
843 ends of the same line:
845 @lilypond[quote,verbatim,noragged-right]
849 piece = "PRAELUDIUM I"
855 This example redefines @code{scoreTitleMarkup} so that the @code{piece}
856 text field is centered and in a large, bold font.
858 @lilypond[papersize=a5,quote,verbatim,noragged-right]
862 scoreTitleMarkup = \markup {
865 \fontsize #4 \bold \fromproperty #'header:piece
866 \fromproperty #'header:opus
870 \header { tagline = ##f }
874 piece = "PRAELUDIUM I"
881 Text fields normally reserved for the main title block can be included
882 in individual score title blocks with the @code{print-all-headers}
883 placed inside the @code{\paper} block. A disadvantage of using this
884 method is that the text fields that are intended specifically for the
885 top-level @code{\header} block need to be manually suppressed in every
886 @code{\score} block. See @ref{Title blocks explained}.
888 To avoid this, add the desired text field to the @code{scoreTitleMarkup}
889 definition. In the following example, the @code{composer} text field
890 (normally associated with @code{bookTitleMarkup}) is added to
891 @code{scoreTitleMarkup}, allowing each score to list a different
894 @lilypond[papersize=a5,quote,verbatim,noragged-right]
898 scoreTitleMarkup = \markup {
901 \fontsize #4 \bold \fromproperty #'header:piece
902 \fromproperty #'header:composer
906 \header { tagline = ##f }
911 composer = "Christian Petzold"
918 composer = "François Couperin"
924 It is also possible to create your own custom text fields, and refer to
925 them in the markup definition.
927 @lilypond[papersize=a5,quote,verbatim,noragged-right]
931 scoreTitleMarkup = \markup {
934 \override #`(direction . ,UP) {
936 \center-align \fontsize #-1 \bold
937 \fromproperty #'header:mycustomtext %% User-defined field
938 \center-align \fontsize #4 \bold
939 \fromproperty #'header:piece
942 \fromproperty #'header:opus
946 \header { tagline = ##f }
951 mycustomtext = "A 4 VOCI" %% User-defined field
960 @ref{Title blocks explained}.
963 @node Custom layout for headers and footers
964 @unnumberedsubsubsec Custom layout for headers and footers
966 @c can make-header and make-footer be removed from
967 @c paper-defaults-init.ly? -mp
969 @code{\markup} commands in the @code{\header} block are useful for
970 simple text formatting, but they do not allow precise control over the
971 placement of headers and footers. To customize the placement of
972 the text fields, use either or both of the following @code{\paper}
976 @item @code{oddHeaderMarkup}
977 @item @code{evenHeaderMarkup}
978 @item @code{oddFooterMarkup}
979 @item @code{evenFooterMarkup}
982 The following example centers page numbers at the bottom of every
983 page. First, the default settings for @code{oddHeaderMarkup} and
984 @code{evenHeaderMarkup} are removed by defining each as a @emph{null}
985 markup. Then, @code{oddFooterMarkup} is redefined with the page
986 number centered. Finally, @code{evenFooterMarkup} is given the
987 same layout by defining it as @code{\oddFooterMarkup}:
989 @lilypond[papersize=a8,quote,verbatim,noragged-right]
992 print-page-number = ##t
993 print-first-page-number = ##t
994 oddHeaderMarkup = \markup \null
995 evenHeaderMarkup = \markup \null
996 oddFooterMarkup = \markup {
998 \on-the-fly #print-page-number-check-first
999 \fromproperty #'page:page-number-string
1002 evenFooterMarkup = \oddFooterMarkup
1005 \new Staff { s1 \break s1 \break s1 }
1012 @ref{Title blocks explained},
1013 @ref{Default layout of book and score title blocks}.
1016 @node Reference to page numbers
1017 @subsection Reference to page numbers
1019 A particular place of a score can be marked using the @code{\label}
1020 command, either at top-level or inside music. This label can then be
1021 referred to in a markup, to get the number of the page where the marked
1022 point is placed, using the @code{\page-ref} markup command.
1025 \header { tagline = ##f }
1031 \pageBreak \mark A \label #'markA
1035 \markup { The first score begins on page \page-ref #'firstScore "0" "?" }
1036 \markup { Mark A is on page \page-ref #'markA "0" "?" }
1040 The @code{\page-ref} markup command takes three arguments:
1042 @item the label, a scheme symbol, eg. @code{#'firstScore};
1043 @item a markup that will be used as a gauge to estimate the dimensions
1045 @item a markup that will be used in place of the page number if the label
1049 The reason why a gauge is needed is that, at the time markups are
1050 interpreted, the page breaking has not yet occurred, so the page numbers
1051 are not yet known. To work around this issue, the actual markup
1052 interpretation is delayed to a later time; however, the dimensions of
1053 the markup have to be known before, so a gauge is used to decide these
1054 dimensions. If the book has between 10 and 99 pages, it may be "00",
1055 ie. a two digit number.
1066 @node Table of contents
1067 @subsection Table of contents
1068 A table of contents is included using the @code{\markuplines \table-of-contents}
1069 command. The elements which should appear in the table of contents are
1070 entered with the @code{\tocItem} command, which may be used either at
1071 top-level, or inside a music expression.
1074 \markuplines \table-of-contents
1077 \tocItem \markup "First score"
1081 \tocItem \markup "Some particular point in the first score"
1086 \tocItem \markup "Second score"
1094 The markups which are used to format the table of contents are defined
1095 in the @code{\paper} block. The default ones are @code{tocTitleMarkup},
1096 for formatting the title of the table, and @code{tocItemMarkup}, for
1097 formatting the toc elements, composed of the element title and page
1098 number. These variables may be changed by the user:
1102 %% Translate the toc title into French:
1103 tocTitleMarkup = \markup \huge \column {
1104 \fill-line { \null "Table des matières" \null }
1107 %% use larger font size
1108 tocItemMarkup = \markup \large \fill-line {
1109 \fromproperty #'toc:text \fromproperty #'toc:page
1114 Note how the toc element text and page number are referred to in
1115 the @code{tocItemMarkup} definition.
1117 New commands and markups may also be defined to build more elaborated
1120 @item first, define a new markup variable in the @code{\paper} block
1121 @item then, define a music function which aims at adding a toc element
1122 using this markup paper variable.
1125 In the following example, a new style is defined for entering act names
1126 in the table of contents of an opera:
1130 tocActMarkup = \markup \large \column {
1132 \fill-line { \null \italic \fromproperty #'toc:text \null }
1138 #(define-music-function (parser location text) (markup?)
1139 (add-toc-item! 'tocActMarkup text))
1142 @lilypond[line-width=11.0\cm]
1143 \header { tagline = ##f }
1145 tocActMarkup = \markup \large \column {
1147 \fill-line { \null \italic \fromproperty #'toc:text \null }
1153 #(define-music-function (parser location text) (markup?)
1154 (add-toc-item! 'tocActMarkup text))
1157 \markuplines \table-of-contents
1158 \tocAct \markup { Atto Primo }
1159 \tocItem \markup { Coro. Viva il nostro Alcide }
1160 \tocItem \markup { Cesare. Presti omai l'Egizzia terra }
1161 \tocAct \markup { Atto Secondo }
1162 \tocItem \markup { Sinfonia }
1163 \tocItem \markup { Cleopatra. V'adoro, pupille, saette d'Amore }
1168 Dots can be added to fill the line between an item and its page number:
1170 @lilypond[verbatim,quote]
1171 \header { tagline = ##f }
1173 tocItemMarkup = \tocItemWithDotsMarkup
1177 \markuplines \table-of-contents
1178 \tocItem \markup { Allegro }
1179 \tocItem \markup { Largo }
1186 Init files: @file{../ly/toc-init.ly}.
1190 @funindex \table-of-contents
1191 @code{\table-of-contents},
1197 @node Working with input files
1198 @section Working with input files
1201 * Including LilyPond files::
1202 * Different editions from one source::
1207 @node Including LilyPond files
1208 @subsection Including LilyPond files
1211 @cindex including files
1213 A large project may be split up into separate files. To refer to
1217 \include "otherfile.ly"
1220 The line @code{\include "otherfile.ly"} is equivalent to pasting the
1221 contents of @file{otherfile.ly} into the current file at the place
1222 where the @code{\include} appears. For example, in a large
1223 project you might write separate files for each instrument part
1224 and create a @qq{full score} file which brings together the
1225 individual instrument files. Normally the included file will
1226 define a number of variables which then become available
1227 for use in the full score file. Tagged sections can be
1228 marked in included files to assist in making them usable in
1229 different places in a score, see @ref{Different editions from
1232 Files in the current working directory may be referenced by
1233 specifying just the file name after the @code{\include} command.
1234 Files in other locations may be included by giving either a full
1235 path reference or a relative path reference (but use the UNIX
1236 forward slash, /, rather than the DOS/Windows back slash, \, as the
1237 directory separator.) For example, if @file{stuff.ly} is located
1238 one directory higher than the current working directory, use
1241 \include "../stuff.ly"
1245 or if the included orchestral parts files are all located in a
1246 subdirectory called @file{parts} within the current directory, use
1249 \include "parts/VI.ly"
1250 \include "parts/VII.ly"
1254 Files which are to be included can also contain @code{\include}
1255 statements of their own. By default, these second-level
1256 @code{\include} statements are not interpreted until they have
1257 been brought into the main file, so the file names they specify
1258 must all be relative to the directory containing the main file,
1259 not the directory containing the included file. However,
1260 this behavior can be changed by passing the option
1261 @option{-drelative-includes} option at the command line
1262 (or by adding @code{#(ly:set-option 'relative-includes #t)}
1263 at the top of the main input file). With @code{relative-includes}
1264 set, the path for each @code{\include} command will be taken
1265 relative to the file containing that command. This behavior is
1266 recommended and it will become the default behavior in a future
1267 version of lilypond.
1269 Files can also be included from a directory in a search path
1270 specified as an option when invoking LilyPond from the command
1271 line. The included files are then specified using just their
1272 file name. For example, to compile @file{main.ly} which includes
1273 files located in a subdirectory called @file{parts} by this method,
1274 cd to the directory containing @file{main.ly} and enter
1277 lilypond --include=parts main.ly
1280 and in main.ly write
1288 Files which are to be included in many scores may be placed in
1289 the LilyPond directory @file{../ly}. (The location of this
1290 directory is installation-dependent - see
1291 @rlearning{Other sources of information}). These files can then
1292 be included simply by naming them on an @code{\include} statement.
1293 This is how the language-dependent files like @file{english.ly} are
1296 LilyPond includes a number of files by default when you start
1297 the program. These includes are not apparent to the user, but the
1298 files may be identified by running @code{lilypond --verbose} from
1299 the command line. This will display a list of paths and files that
1300 LilyPond uses, along with much other information. Alternatively,
1301 the more important of these files are discussed in
1302 @rlearning{Other sources of information}. These files may be
1303 edited, but changes to them will be lost on installing a new
1304 version of LilyPond.
1306 Some simple examples of using @code{\include} are shown in
1307 @rlearning{Scores and parts}.
1311 @rlearning{Other sources of information},
1312 @rlearning{Scores and parts}.
1315 If an included file is given a name which is the same as one in
1316 LilyPond's installation files, LilyPond's file from the
1317 installation files takes precedence.
1320 @node Different editions from one source
1321 @subsection Different editions from one source
1323 Several methods can be used to generate different versions of a score
1324 from the same music source. Variables are perhaps the most useful for
1325 combining lengthy sections of music and/or annotation. Tags are more
1326 useful for selecting one section from several alternative shorter
1327 sections of music, and can also be used for splicing pieces of music
1328 together at different points.
1330 Whichever method is used, separating the notation from the structure of
1331 the score will make it easier to change the structure while leaving the
1337 * Using global settings::
1340 @node Using variables
1341 @unnumberedsubsubsec Using variables
1343 @cindex variables, use of
1345 If sections of the music are defined in variables they can be
1346 reused in different parts of the score, see @rlearning{Organizing
1347 pieces with variables}. For example, an @notation{a cappella}
1348 vocal score frequently includes a piano reduction of the parts
1349 for rehearsal purposes which is identical to the vocal music, so
1350 the music need be entered only once. Music from two variables
1351 may be combined on one staff, see @ref{Automatic part combining}.
1354 @lilypond[verbatim,quote]
1355 sopranoMusic = \relative c'' { a4 b c b8( a) }
1356 altoMusic = \relative g' { e4 e e f }
1357 tenorMusic = \relative c' { c4 b e d8( c) }
1358 bassMusic = \relative c' { a4 gis a d, }
1359 allLyrics = \lyricmode {King of glo -- ry }
1361 \new Staff = "Soprano" \sopranoMusic
1362 \new Lyrics \allLyrics
1363 \new Staff = "Alto" \altoMusic
1364 \new Lyrics \allLyrics
1365 \new Staff = "Tenor" {
1369 \new Lyrics \allLyrics
1370 \new Staff = "Bass" {
1374 \new Lyrics \allLyrics
1377 \set Staff.printPartCombineTexts = ##f
1383 \set Staff.printPartCombineTexts = ##f
1393 Separate scores showing just the vocal parts or just the piano
1394 part can be produced by changing just the structural statements,
1395 leaving the musical notation unchanged.
1397 For lengthy scores, the variable definitions may be placed in
1398 separate files which are then included, see @ref{Including
1402 @unnumberedsubsubsec Using tags
1405 @funindex \keepWithTag
1406 @funindex \removeWithTag
1407 @funindex \pushToTag
1408 @funindex \appendToTag
1410 @cindex keep tagged music
1411 @cindex remove tagged music
1412 @cindex splice into tagged music
1414 The @code{\tag #'@var{partA}} command marks a music expression
1415 with the name @var{partA}.
1416 Expressions tagged in this way can be selected or filtered out by
1417 name later, using either @code{\keepWithTag #'@var{name}} or
1418 @code{\removeWithTag #'@var{name}}. The result of applying these filters
1419 to tagged music is as follows:
1420 @multitable @columnfractions .5 .5
1424 Tagged music preceded by @code{\keepWithTag #'@var{name}}
1425 @tab Untagged music and music tagged with @var{name} is included;
1426 music tagged with any other tag name is excluded.
1428 Tagged music preceded by @code{\removeWithTag #'@var{name}}
1429 @tab Untagged music and music tagged with any tag name other than
1430 @var{name} is included; music tagged with @var{name} is
1433 Tagged music not preceded by either @code{\keepWithTag} or
1434 @code{\removeWithTag}
1435 @tab All tagged and untagged music is included.
1438 The arguments of the @code{\tag}, @code{\keepWithTag} and
1439 @code{\removeWithTag} commands should be a symbol
1440 (such as @code{#'score} or @code{#'part}), followed
1441 by a music expression.
1443 In the following example, we see two versions of a piece of music,
1444 one showing trills with the usual notation, and one with trills
1445 explicitly expanded:
1447 @lilypond[verbatim,quote]
1448 music = \relative g' {
1450 \tag #'trills { d8.\trill }
1451 \tag #'expand { \repeat unfold 3 { e32 d } }
1456 \keepWithTag #'trills \music
1459 \keepWithTag #'expand \music
1464 Alternatively, it is sometimes easier to exclude sections of music:
1466 @lilypond[verbatim,quote]
1467 music = \relative g' {
1469 \tag #'trills { d8.\trill }
1470 \tag #'expand {\repeat unfold 3 { e32 d } }
1475 \removeWithTag #'expand
1479 \removeWithTag #'trills
1484 Tagged filtering can be applied to articulations, texts, etc. by
1488 -\tag #'@var{your-tag}
1491 to an articulation. For example, this would define a note with a
1492 conditional fingering indication and a note with a conditional
1497 c1-\tag #'warn ^"Watch!"
1500 Multiple tags may be placed on expressions with multiple
1501 @code{\tag} entries:
1503 @lilypond[quote,verbatim]
1504 music = \relative c'' {
1505 \tag #'a \tag #'both { a4 a a a }
1506 \tag #'b \tag #'both { b4 b b b }
1509 \keepWithTag #'a \music
1510 \keepWithTag #'b \music
1511 \keepWithTag #'both \music
1515 Multiple @code{\removeWithTag} filters may be applied to a single
1516 music expression to remove several differently named tagged sections:
1518 @lilypond[verbatim,quote]
1519 music = \relative c'' {
1520 \tag #'A { a4 a a a }
1521 \tag #'B { b4 b b b }
1522 \tag #'C { c4 c c c }
1523 \tag #'D { d4 d d d }
1532 Two or more @code{\keepWithTag} filters applied to a single music
1533 expression will cause @emph{all} tagged sections to be removed, as
1534 the first filter will remove all tagged sections except the one
1535 named, and the second filter will remove even that tagged section.
1537 Sometimes you want to splice some music at a particular place in an
1538 existing music expression. You can use @code{\pushToTag} and
1539 @code{\appendToTag} for adding material at the front or end of the
1540 @code{elements} of an existing music construct. Not every music
1541 construct has @code{elements}, but sequential and simultaneous music are
1544 @lilypond[verbatim,quote]
1545 test = { \tag #'here { \tag #'here <<c''>> } }
1548 \pushToTag #'here \pushToTag #'here
1549 \pushToTag #'here \test g' e' c'
1550 \appendToTag #'here \appendToTag #'here
1551 \appendToTag #'here \test g' e' c'
1555 Both commands get a tag, the tagged expression, and finally the material
1556 you want to splice in at every given tag. The commands make sure to
1557 copy everything that they change so that the original @code{\test}
1558 retains its meaning.
1562 @rlearning{Organizing pieces with variables}.
1565 @ref{Automatic part combining},
1566 @ref{Including LilyPond files}.
1570 @c This warning is more general than this placement implies.
1571 @c Rests are not merged whether or not they come from tagged sections.
1572 @c Should be deleted? -td
1576 Multiple rests are not merged if you create a score with more
1577 than one tagged section at the same place.
1581 @node Using global settings
1582 @unnumberedsubsubsec Using global settings
1584 @cindex include-settings
1586 Global settings can be included from a separate file:
1589 lilypond -dinclude-settings=MY_SETTINGS.ly MY_SCORE.ly
1592 Groups of settings such as page size, font or type face can be stored
1593 in separate files. This allows different editions from the same score
1594 as well as standard settings to be applied to many scores, simply by
1595 specifying the proper settings file.
1597 This technique also works well with the use of style sheets, as
1598 discussed in @rlearning{Style sheets}.
1602 @rlearning{Organizing pieces with variables},
1603 @rlearning{Style sheets}.
1606 @ref{Including LilyPond files}.
1609 @subsection Text encoding
1613 @cindex non-ASCII characters
1615 LilyPond uses the character repertoire defined by the Unicode
1616 consortium and ISO/IEC 10646. This defines a unique name and
1617 code point for the character sets used in virtually all modern
1618 languages and many others too. Unicode can be implemented using
1619 several different encodings. LilyPond uses the UTF-8 encoding
1620 (UTF stands for Unicode Transformation Format) which represents
1621 all common Latin characters in one byte, and represents other
1622 characters using a variable length format of up to four bytes.
1624 The actual appearance of the characters is determined by the
1625 glyphs defined in the particular fonts available - a font defines
1626 the mapping of a subset of the Unicode code points to glyphs.
1627 LilyPond uses the Pango library to layout and render multi-lingual
1630 LilyPond does not perform any input-encoding conversions. This
1631 means that any text, be it title, lyric text, or musical
1632 instruction containing non-ASCII characters, must be encoded in
1633 UTF-8. The easiest way to enter such text is by using a
1634 Unicode-aware editor and saving the file with UTF-8 encoding. Most
1635 popular modern editors have UTF-8 support, for example, vim, Emacs,
1636 jEdit, and GEdit do. All MS Windows systems later than NT use
1637 Unicode as their native character encoding, so even Notepad can
1638 edit and save a file in UTF-8 format. A more functional
1639 alternative for Windows is BabelPad.
1641 If a LilyPond input file containing a non-ASCII character is not
1642 saved in UTF-8 format the error message
1645 FT_Get_Glyph_Name () error: invalid argument
1650 Here is an example showing Cyrillic, Hebrew and Portuguese
1654 %c No verbatim here as the code does not display correctly in PDF
1656 bulgarian = \lyricmode {
1657 Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
1661 hebrew = \lyricmode {
1662 זה כיף סתם לשמוע איך תנצח קרפד עץ טוב בגן.
1666 portuguese = \lyricmode {
1667 à vo -- cê uma can -- ção legal
1673 \addlyrics { \bulgarian }
1674 \addlyrics { \hebrew }
1675 \addlyrics { \portuguese }
1678 To enter a single character for which the Unicode code point is
1679 known but which is not available in the editor being used, use
1680 either @code{\char ##xhhhh} or @code{\char #dddd} within a
1681 @code{\markup} block, where @code{hhhh} is the hexadecimal code for
1682 the character required and @code{dddd} is the corresponding decimal
1683 value. Leading zeroes may be omitted, but it is usual to specify
1684 all four characters in the hexadecimal representation. (Note that
1685 the UTF-8 encoding of the code point should @emph{not} be used
1686 after @code{\char}, as UTF-8 encodings contain extra bits indicating
1687 the number of octets.) Unicode code charts and a character name
1688 index giving the code point in hexadecimal for any character can be
1689 found on the Unicode Consortium website,
1690 @uref{http://www.unicode.org/}.
1692 For example, @code{\char ##x03BE} and @code{\char #958} would both
1693 enter the Unicode U+03BE character, which has the Unicode name
1694 @qq{Greek Small Letter Xi}.
1696 Any Unicode code point may be entered in this way and if all special
1697 characters are entered in this format it is not necessary to save
1698 the input file in UTF-8 format. Of course, a font containing all
1699 such encoded characters must be installed and available to LilyPond.
1701 The following example shows Unicode hexadecimal values being entered
1702 in four places -- in a rehearsal mark, as articulation text, in
1703 lyrics and as stand-alone text below the score:
1705 @lilypond[quote,verbatim]
1708 c1 \mark \markup { \char ##x03EE }
1709 c1_\markup { \tiny { \char ##x03B1 " to " \char ##x03C9 } }
1711 \addlyrics { O \markup { \concat { Ph \char ##x0153 be! } } }
1713 \markup { "Copyright 2008--2011" \char ##x00A9 }
1716 @cindex copyright sign
1718 To enter the copyright sign in the copyright notice use:
1722 copyright = \markup @{ \char ##x00A9 "2008" @}
1728 @node Controlling output
1729 @section Controlling output
1732 * Extracting fragments of music::
1733 * Skipping corrected music::
1734 * Alternative output formats::
1735 * Replacing the notation font::
1738 @node Extracting fragments of music
1739 @subsection Extracting fragments of music
1741 It is possible to quote small fragments of a large score directly from
1742 the output. This can be compared to clipping a piece of a paper score
1745 This is done by defining the measures that need to be cut out
1746 separately. For example, including the following definition
1754 (make-rhythmic-location 5 1 2)
1755 (make-rhythmic-location 7 3 4)))
1760 will extract a fragment starting halfway the fifth measure, ending in
1761 the seventh measure. The meaning of @code{5 1 2} is: after a 1/2 note
1762 in measure 5, and @code{7 3 4} after 3 quarter notes in measure 7.
1764 More clip regions can be defined by adding more pairs of
1765 rhythmic-locations to the list.
1767 In order to use this feature, LilyPond must be invoked with
1768 @option{-dclip-systems}. The clips are output as EPS files, and are
1769 converted to PDF and PNG if these formats are switched on as well.
1771 For more information on output formats, see @rprogram{Invoking lilypond}.
1773 @node Skipping corrected music
1774 @subsection Skipping corrected music
1777 @funindex skipTypesetting
1778 @funindex showFirstLength
1779 @funindex showLastLength
1781 When entering or copying music, usually only the music near the end (where
1783 are adding notes) is interesting to view and correct. To speed up
1784 this correction process, it is possible to skip typesetting of all but
1785 the last few measures. This is achieved by putting
1788 showLastLength = R1*5
1793 in your source file. This will render only the last 5 measures
1794 (assuming 4/4 time signature) of every @code{\score} in the input
1795 file. For longer pieces, rendering only a small part is often an order
1796 of magnitude quicker than rendering it completely. When working on the
1797 beginning of a score you have already typeset (e.g. to add a new part),
1798 the @code{showFirstLength} property may be useful as well.
1800 Skipping parts of a score can be controlled in a more fine-grained
1801 fashion with the property @code{Score.skipTypesetting}. When it is
1802 set, no typesetting is performed at all.
1804 This property is also used to control output to the MIDI file. Note that
1805 it skips all events, including tempo and instrument changes. You have
1808 @lilypond[quote,relative=2,ragged-right,verbatim]
1810 \set Score.skipTypesetting = ##t
1812 \set Score.skipTypesetting = ##f
1816 In polyphonic music, @code{Score.skipTypesetting} will affect all
1817 voices and staves, saving even more time.
1819 @node Alternative output formats
1820 @subsection Alternative output formats
1822 @cindex scalable vector graphics output
1824 @cindex encapsulated postscript output
1827 The default output formats for the printed score are Portable
1828 Document Format (PDF) and PostScript (PS). Scalable Vector
1829 Graphics (SVG), Encapsulated PostScript (EPS) and Portable
1830 Network Graphics (PNG) output formats are also available through
1831 command line options, see @rprogram{Command line options for
1835 @node Replacing the notation font
1836 @subsection Replacing the notation font
1838 Gonville is an alternative to the Feta font used in LilyPond and can
1841 @uref{http://www.chiark.greenend.org.uk/~sgtatham/gonville/ ,http://www.chiark.greenend.org.uk/~sgtatham/gonville/}
1844 Here are a few sample bars of music set in Gonville:
1846 @c NOTE: these images are a bit big, but that's important
1847 @c for the font comparison. -gp
1848 @sourceimage{Gonville_after,,,}
1850 Here are a few sample bars of music set in LilyPond's Feta font:
1852 @sourceimage{Gonville_before,,,}
1854 @subsubheading Installation Instructions for MacOS
1856 Download and extract the zip file. Copy the @code{lilyfonts}
1857 directory to @file{@var{SHARE_DIR}/lilypond/current}; for more
1858 information, see @rlearning{Other sources of information}. Rename the
1859 existing @code{fonts} directory to @code{fonts_orig} and the
1860 @code{lilyfonts} directory to @code{fonts}. To revert back to Feta,
1861 reverse the process.
1864 Learning Manual: @rlearning{Other sources of information}.
1867 Gonville cannot be used to typeset @q{Ancient Music} notation and it is
1868 likely newer glyphs in later releases of LilyPond may not exist in the
1869 Gonville font family. Please refer to the author's website for more
1870 information on these and other specifics, including licensing of
1875 @section MIDI output
1880 MIDI (Musical Instrument Digital Interface) is a standard for
1881 connecting and controlling digital instruments. A MIDI file is a
1882 series of notes in a number of tracks. It is not an actual
1883 sound file; you need special software to translate between the
1884 series of notes and actual sounds.
1886 Pieces of music can be converted to MIDI files, so you can listen to
1887 what was entered. This is convenient for checking the music; octaves
1888 that are off or accidentals that were mistyped stand out very much
1889 when listening to the MIDI output.
1891 Standard MIDI oputput is somewhat crude; optionally, an enhanced and
1892 more realistic MIDI output is available by means of
1893 @ref{The Articulate script}.
1896 The midi output allocates a channel for each staff, and one for global
1897 settings. Therefore the midi file should not have more than 15 staves
1898 (or 14 if you do not use drums). Other staves will remain silent.
1901 * Creating MIDI files::
1903 * What goes into the MIDI output?::
1905 * Controlling MIDI dynamics::
1906 * Percussion in MIDI::
1907 * The Articulate script::
1910 @node Creating MIDI files
1911 @subsection Creating MIDI files
1913 To create a MIDI output file from a LilyPond input file, add a
1914 @code{\midi} block to a score, for example,
1923 If there is a @code{\midi} block in a @code{\score} with no
1924 @code{\layout} block, only MIDI output will be produced. When
1925 notation is needed too, a @code{\layout} block must also be
1936 Pitches, rhythms, ties, dynamics, and tempo changes are interpreted
1937 and translated correctly to the MIDI output. Dynamic marks,
1938 crescendi and decrescendi translate into MIDI volume levels.
1939 Dynamic marks translate to a fixed fraction of the available MIDI
1940 volume range. Crescendi and decrescendi make the volume vary
1941 linearly between their two extremes. The effect of dynamic markings
1942 on the MIDI output can be removed completely, see @ref{MIDI block}.
1944 The initial tempo and later tempo changes can be specified
1945 with the @code{\tempo} command within the music notation. These
1946 are reflected in tempo changes in the MIDI output. This command
1947 will normally result in the metronome mark being printed, but this
1948 can be suppressed, see @ref{Metronome marks}. An alternative way
1949 of specifying the initial or overall MIDI tempo is described below,
1950 see @ref{MIDI block}.
1952 Due to some limitations on Windows, the default extension for
1953 MIDI files on Windows is @code{.mid}. Other operating systems still
1954 use the extension @code{.midi}. If a different extension is preferred,
1955 insert the following line at the top-level of the input file,
1956 before the start of any @code{\book}, @code{\bookpart} or @code{\score} blocks:
1959 #(ly:set-option 'midi-extension "midi")
1962 The line above will set the default extension for MIDI files to
1965 Alternatively, this option can also be supplied on the command line:
1968 lilypond … -dmidi-extension=midi lilyFile.ly
1972 @unnumberedsubsubsec Instrument names
1974 @cindex instrument names
1975 @funindex Staff.midiInstrument
1977 The MIDI instrument to be used is specified by setting the
1978 @code{Staff.midiInstrument} property to the instrument name.
1979 The name should be chosen from the list in @ref{MIDI instruments}.
1983 \set Staff.midiInstrument = #"glockenspiel"
1989 \new Staff \with @{midiInstrument = #"cello"@} @{
1994 If the selected instrument does not exactly match an instrument from
1995 the list of MIDI instruments, the Grand Piano (@code{"acoustic grand"})
2001 @lilypondfile[verbatim,quote,ragged-right,texidoc,doctitle]
2002 {changing-midi-output-to-one-channel-per-voice.ly}
2006 @c In 2.11 the following no longer seems to be a problem -td
2008 Unterminated (de)crescendos will not render properly in the midi file,
2009 resulting in silent passages of music. The workaround is to explicitly
2010 terminate the (de)crescendo. For example,
2017 will not work properly but
2020 @{ a4\< b c d\!\f @}
2027 Changes in the MIDI volume take place only on starting a note, so
2028 crescendi and decrescendi cannot affect the volume of a
2031 Not all midi players correctly handle tempo changes in the midi
2032 output. Players that are known to work include MS Windows Media
2033 Player and @uref{http://@/timidity@/.sourceforge@/.net/,timidity}.
2036 @subsection MIDI block
2039 A @code{\midi} block must appear within a score block if MIDI output
2040 is required. It is analogous to the layout block, but somewhat
2041 simpler. Often, the @code{\midi} block is left empty, but it
2042 can contain context rearrangements, new context definitions or code
2043 to set the values of properties. For example, the following will
2044 set the initial tempo exported to a MIDI file without causing a tempo
2045 indication to be printed:
2053 tempoWholesPerMinute = #(ly:make-moment 72 4)
2059 In this example the tempo is set to 72 quarter note
2060 beats per minute. This kind of tempo specification cannot take
2061 a dotted note length as an argument. If one is required, break
2062 the dotted note into smaller units. For example, a tempo of 90
2063 dotted quarter notes per minute can be specified as 270 eighth
2067 tempoWholesPerMinute = #(ly:make-moment 270 8)
2070 @cindex MIDI context definitions
2072 Context definitions follow precisely the same syntax as those
2073 within a @code{\layout} block. Translation modules for sound are
2074 called performers. The contexts for MIDI output are defined in
2075 @file{../ly/performer-init.ly},
2076 see @rlearning{Other sources of information}.
2077 For example, to remove the effect of dynamics
2078 from the MIDI output, insert the following lines in the
2079 @code{\midi@{ @}} block.
2086 \remove "Dynamic_performer"
2091 MIDI output is created only when a @code{\midi} block is included
2092 within a score block defined with a @code{\score} command.
2096 @{ @dots{}notes@dots{} @}
2101 @node What goes into the MIDI output?
2102 @subsection What goes into the MIDI output?
2104 @c TODO Check grace notes - timing is suspect?
2106 @unnumberedsubsubsec Supported in MIDI
2108 @cindex Pitches in MIDI
2109 @cindex MIDI, Pitches
2110 @cindex Quarter tones in MIDI
2111 @cindex MIDI, quarter tones
2112 @cindex Microtones in MIDI
2113 @cindex MIDI, microtones
2114 @cindex Chord names in MIDI
2115 @cindex MIDI, chord names
2116 @cindex Rhythms in MIDI
2117 @cindex MIDI, Rhythms
2118 @cindex Articlulate scripts
2119 @cindex MIDI, articulations
2120 @cindex articulations in MIDI
2121 @cindex trills in MIDI
2122 @cindex turns in MIDI
2123 @cindex rallentando in MIDI
2124 @cindex accelerando in MIDI
2127 The following items of notation are reflected in the MIDI output:
2131 @item Microtones (See @ref{Accidentals}. Rendering needs a
2132 player that supports pitch bend.)
2133 @item Chords entered as chord names
2134 @item Rhythms entered as note durations, including tuplets
2135 @item Tremolos entered without @q{@code{:}[@var{number}]}
2138 @item Crescendi, decrescendi over multiple notes
2139 @item Tempo changes entered with a tempo marking
2143 Using @ref{The Articulate script}, a number of items are added to the
2147 @item Articulations (slurs, staccato, etc)
2149 @item Rallentando and accelerando
2153 @unnumberedsubsubsec Unsupported in MIDI
2155 @c TODO index as above
2157 The following items of notation have no effect on the MIDI output,
2158 unless you use @ref{The Articulate script}:
2161 @item Rhythms entered as annotations, e.g. swing
2162 @item Tempo changes entered as annotations with no tempo marking
2163 @item Staccato and other articulations and ornamentations
2164 @item Slurs and Phrasing slurs
2165 @item Crescendi, decrescendi over a single note
2166 @item Tremolos entered with @q{@code{:}[@var{number}]}
2168 @item Microtonal chords
2172 @node Repeats in MIDI
2173 @subsection Repeats in MIDI
2175 @cindex repeats in MIDI
2176 @funindex \unfoldRepeats
2178 With a few minor additions, all types of repeats can be represented
2179 in the MIDI output. This is achieved by applying the
2180 @code{\unfoldRepeats} music function. This function changes all
2181 repeats to unfold repeats.
2183 @lilypond[quote,verbatim]
2185 \repeat tremolo 8 { c'32 e' }
2186 \repeat percent 2 { c''8 d'' }
2187 \repeat volta 2 { c'4 d' e' f' }
2196 In scores containing multiple voices, unfolding of repeats in MIDI
2197 output will only occur correctly if @emph{each} voice contains fully
2198 notated repeat indications.
2200 When creating a score file using @code{\unfoldRepeats} for MIDI,
2201 it is necessary to make two @code{\score} blocks: one for MIDI
2202 (with unfolded repeats) and one for notation (with volta, tremolo,
2203 and percent repeats). For example,
2211 \unfoldRepeats @var{..music..}
2216 @node Controlling MIDI dynamics
2217 @subsection Controlling MIDI dynamics
2219 MIDI dynamics are implemented by the Dynamic_performer which lives
2220 by default in the Voice context. It is possible to control the
2221 overall MIDI volume, the relative volume of dynamic markings and
2222 the relative volume of different instruments.
2224 @unnumberedsubsubsec Dynamic marks
2226 Dynamic marks are translated to a fixed fraction of the available
2227 MIDI volume range. The default fractions range from 0.25 for
2228 @notation{ppppp} to 0.95 for @notation{fffff}. The set of dynamic
2229 marks and the associated fractions can be seen in
2230 @file{../scm/midi.scm}, see @rlearning{Other sources of information}.
2231 This set of fractions may be changed or extended by providing a
2232 function which takes a dynamic mark as its argument and returns the
2233 required fraction, and setting
2234 @code{Score.dynamicAbsoluteVolumeFunction} to this function.
2236 For example, if a @notation{rinforzando} dynamic marking,
2237 @code{\rfz}, is required, this will not by default
2238 have any effect on the MIDI volume, as this dynamic marking is not
2239 included in the default set. Similarly, if a new dynamic marking
2240 has been defined with @code{make-dynamic-script} that too will not
2241 be included in the default set. The following example shows how the
2242 MIDI volume for such dynamic markings might be added. The Scheme
2243 function sets the fraction to 0.9 if a dynamic mark of rfz is
2244 found, or calls the default function otherwise.
2246 @lilypond[verbatim,quote]
2247 #(define (myDynamics dynamic)
2248 (if (equal? dynamic "rfz")
2250 (default-dynamic-absolute-volume dynamic)))
2254 \set Staff.midiInstrument = #"cello"
2255 \set Score.dynamicAbsoluteVolumeFunction = #myDynamics
2267 Alternatively, if the whole table of fractions needs to be
2268 redefined, it would be better to use the
2269 @notation{default-dynamic-absolute-volume} procedure in
2270 @file{../scm/midi.scm} and the associated table as a model.
2271 The final example in this section shows how this might be done.
2273 @unnumberedsubsubsec Overall MIDI volume
2275 The minimum and maximum overall volume of MIDI dynamic markings is
2276 controlled by setting the properties @code{midiMinimumVolume} and
2277 @code{midiMaximumVolume} at the @code{Score} level. These
2278 properties have an effect only on dynamic marks, so if they
2279 are to apply from the start of the score a dynamic mark must be
2280 placed there. The fraction corresponding to each dynamic mark is
2281 modified with this formula
2284 midiMinimumVolume + (midiMaximumVolume - midiMinimumVolume) * fraction
2287 In the following example the dynamic range of the overall MIDI
2288 volume is limited to the range 0.2 - 0.5.
2290 @lilypond[verbatim,quote]
2296 \set Staff.midiInstrument = #"flute"
2297 \new Voice \relative c''' {
2305 \set Staff.midiInstrument = #"clarinet"
2306 \new Voice \relative c'' {
2317 tempoWholesPerMinute = #(ly:make-moment 72 2)
2318 midiMinimumVolume = #0.2
2319 midiMaximumVolume = #0.5
2325 @unnumberedsubsubsec Equalizing different instruments (i)
2327 If the minimum and maximum MIDI volume properties are set in
2328 the @code{Staff} context the relative volumes of the MIDI
2329 instruments can be controlled. This gives a basic instrument
2330 equalizer, which can enhance the quality of the MIDI output
2333 In this example the volume of the clarinet is reduced relative
2334 to the volume of the flute. There must be a dynamic
2335 mark on the first note of each instrument for this to work
2338 @lilypond[verbatim,quote]
2344 \set Staff.midiInstrument = #"flute"
2345 \set Staff.midiMinimumVolume = #0.7
2346 \set Staff.midiMaximumVolume = #0.9
2347 \new Voice \relative c''' {
2355 \set Staff.midiInstrument = #"clarinet"
2356 \set Staff.midiMinimumVolume = #0.3
2357 \set Staff.midiMaximumVolume = #0.6
2358 \new Voice \relative c'' {
2369 tempoWholesPerMinute = #(ly:make-moment 72 2)
2375 @unnumberedsubsubsec Equalizing different instruments (ii)
2377 If the MIDI minimum and maximum volume properties are not set
2378 LilyPond will, by default, apply a small degree of equalization
2379 to a few instruments. The instruments and the equalization
2380 applied are shown in the table @notation{instrument-equalizer-alist}
2381 in @file{../scm/midi.scm}.
2383 This basic default equalizer can be replaced by setting
2384 @code{instrumentEqualizer} in the @code{Score} context to a new
2385 Scheme procedure which accepts a MIDI instrument name as its only
2386 argument and returns a pair of fractions giving the minimum and
2387 maximum volumes to be applied to that instrument. This replacement
2388 is done in the same way as shown for resetting the
2389 @code{dynamicAbsoluteVolumeFunction} at the start of this section.
2390 The default equalizer, @notation{default-instrument-equalizer}, in
2391 @file{../scm/midi.scm} shows how such a procedure might be written.
2393 The following example sets the relative flute and clarinet volumes
2394 to the same values as the previous example.
2396 @lilypond[verbatim,quote]
2397 #(define my-instrument-equalizer-alist '())
2399 #(set! my-instrument-equalizer-alist
2402 ("flute" . (0.7 . 0.9))
2403 ("clarinet" . (0.3 . 0.6)))
2404 my-instrument-equalizer-alist))
2406 #(define (my-instrument-equalizer s)
2407 (let ((entry (assoc s my-instrument-equalizer-alist)))
2416 \set Score.instrumentEqualizer = #my-instrument-equalizer
2417 \set Staff.midiInstrument = #"flute"
2418 \new Voice \relative c''' {
2426 \set Staff.midiInstrument = #"clarinet"
2427 \new Voice \relative c'' {
2438 tempoWholesPerMinute = #(ly:make-moment 72 2)
2445 @c Delete when satisfied this is adequately covered elsewhere -td
2447 @n ode Microtones in MIDI
2448 @s ubsection Microtones in MIDI
2450 @cindex microtones in MIDI
2452 Microtones consisting of half sharps and half flats are exported
2453 to the MIDI file and render correctly in MIDI players which support
2454 pitch bending. See @ref{Note names in other languages}. Here is
2455 an example showing all the half sharps and half flats. It can be
2456 copied out and compiled to test microtones in your MIDI player.
2458 @lilypond[verbatim,quote]
2475 @node Percussion in MIDI
2476 @subsection Percussion in MIDI
2478 Percussion instruments are generally notated in a @code{DrumStaff}
2479 context and when notated in this way they are outputted correctly
2480 to MIDI channel@tie{}10, but some pitched percussion instruments,
2481 like the xylophone, marimba, vibraphone, timpani, etc., are
2482 treated like @qq{normal} instruments and music for these instruments
2483 should be entered in a normal @code{Staff} context, not a
2484 @code{DrumStaff} context, to obtain the correct MIDI output.
2486 Some non-pitched percussion sounds included in the general MIDI
2487 standard, like melodic tom, taiko drum, synth drum, etc., cannot
2488 be reached via MIDI channel@tie{}10, so the notation for such
2489 instruments should also be entered in a normal @code{Staff}
2490 context, using suitable normal pitches.
2492 Many percussion instruments are not included in the general MIDI
2493 standard, e.g. castanets. The easiest, although unsatisfactory,
2494 method of producing some MIDI output when writing for such
2495 instruments is to substitute the nearest sound from the standard
2498 @c TODO Expand with examples, and any other issues
2502 Because the general MIDI standard does not contain rim shots, the
2503 sidestick is used for this purpose instead.
2505 @node The Articulate script
2506 @subsection The Articulate script
2508 A more realistic MIDI output is possible when using the Articulate
2509 script. It tries to take articulations (slurs, staccato, etc) into
2510 account, by replacing notes with sequential music of suitably
2511 time-scaled note plus skip. It also tries to unfold trills turns
2512 etc., and take rallentando and accelerando into account.
2514 To use the Articulate script, you have to include it at the top of
2518 \include "articulate.ly"
2521 and in the @code{\score} section do
2524 \unfoldRepeats \articulate <<
2525 all the rest of the score...
2529 After altering your input file this way, the visual output is heavily
2530 altered, but the standard @code{\midi} block will produce a better
2533 Although not essential for the Articulate script to work, you may want
2534 to insert the @code{\unfoldRepeats} command as it appears in the
2535 example shown above as it enables performing abbreviatures such as
2540 Articulate shortens chords and some music (esp. organ music) could
2544 @node Extracting musical information
2545 @section Extracting musical information
2547 In addition to creating graphical output and MIDI, LilyPond can
2548 display musical information as text.
2551 * Displaying LilyPond notation::
2552 * Displaying scheme music expressions::
2553 * Saving music events to a file::
2556 @node Displaying LilyPond notation
2557 @subsection Displaying LilyPond notation
2559 @funindex \displayLilyMusic
2560 Displaying a music expression in LilyPond notation can be
2561 done with the music function @code{\displayLilyMusic} but only when
2562 using the command line. For example,
2566 \displayLilyMusic \transpose c a, @{ c4 e g a bes @}
2573 @{ a,4 cis e fis g @}
2576 By default, LilyPond will print these messages to the console
2577 along with all the other LilyPond compilation messages. To split
2578 up these messages and save the results of @code{\display@{STUFF@}},
2579 redirect the output to a file.
2582 lilypond file.ly >display.txt
2586 @node Displaying scheme music expressions
2587 @subsection Displaying scheme music expressions
2589 See @rextend{Displaying music expressions}.
2592 @node Saving music events to a file
2593 @subsection Saving music events to a file
2595 Music events can be saved to a file on a per-staff basis by
2596 including a file in your main score.
2599 \include "event-listener.ly"
2602 This will create file(s) called @file{FILENAME-STAFFNAME.notes} or
2603 @file{FILENAME-unnamed-staff.notes} for each staff. Note that if
2604 you have multiple unnamed staves, the events for all staves will
2605 be mixed together in the same file. The output looks like this:
2608 0.000 note 57 4 p-c 2 12
2610 0.250 note 62 4 p-c 7 12
2611 0.500 note 66 8 p-c 9 12
2612 0.625 note 69 8 p-c 14 12
2617 The syntax is a tab-delimited line, with two fixed fields on each
2618 line followed by optional parameters.
2621 @var{time} @var{type} @var{...params...}
2624 This information can easily be read into other programs such as
2625 python scripts, and can be very useful for researchers wishing to
2626 perform musical analysis or playback experiments with LilyPond.
2631 Not all lilypond music events are supported by
2632 @file{event-listener.ly}. It is intended to be a well-crafted
2633 @qq{proof of concept}. If some events that you want to see are
2634 not included, copy @file{event-listener.ly} into your lilypond
2635 directory and modify the file so that it outputs the information