1 @c -*- coding: utf-8; mode: texinfo; -*-
2 @c This file is part of lilypond.tely
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. See TRANSLATION for details.
12 @node General input and output
13 @chapter General input and output
15 This section deals with general LilyPond input and output issues,
16 rather than specific notation.
20 * Titles and headers::
21 * Working with input files::
22 * Controlling output::
28 @section Input structure
30 The main format of input for LilyPond are text files. By convention,
31 these files end with @code{.ly}.
34 * Structure of a score::
35 * Multiple scores in a book::
40 @node Structure of a score
41 @subsection Structure of a score
45 A @code{\score} block must contain a single music expression
46 delimited by curly brackets:
54 @warning{There must be @strong{only one} outer music expression in
55 a @code{\score} block, and it @strong{must} be surrounded by
58 This single music expression may be of any size, and may contain
59 other music expressions to any complexity. All of these examples
60 are music expressions:
66 @lilypond[verbatim,quote]
73 @lilypond[verbatim,quote]
75 \new Staff { c'4 c' c' c' }
76 \new Staff { d'4 d' d' d' }
84 \new Staff @{ \flute @}
85 \new Staff @{ \oboe @}
88 \new Staff @{ \violinI @}
89 \new Staff @{ \violinII @}
95 Comments are one exception to this general rule. (For others see
96 @ref{File structure}.) Both single-line comments and comments
97 delimited by @code{%@{ .. %@}} may be placed anywhere within an
98 input file. They may be placed inside or outside a @code{\score}
99 block, and inside or outside the single music expression within a
105 @rlearning{Working on input files},
106 @rlearning{Music expressions explained},
107 @rlearning{Score is a (single) compound musical expression}.
110 @node Multiple scores in a book
111 @subsection Multiple scores in a book
114 @cindex movements, multiple
116 A document may contain multiple pieces of music and text. Examples
117 of these are an etude book, or an orchestral part with multiple
118 movements. Each movement is entered with a @code{\score} block,
126 and texts are entered with a @code{\markup} block,
136 All the movements and texts which appear in the same @code{.ly} file
137 will normally be typeset in the form of a single output file.
151 However, if you want multiple output files from the same @code{.ly}
152 file, then you can add multiple @code{\book} blocks, where each such
153 @code{\book} block will result in a separate output. If you do not
154 specify any @code{\book} block in the file, LilyPond will implicitly
155 treat the full file as a single @code{\book} block, see @ref{File
156 structure}. One important exception is within lilypond-book documents,
157 where you explicitly have to add a @code{\book} block, otherwise only
158 the first @code{\score} or @code{\markup} will appear in the output.
160 The header for each piece of music can be put inside the @code{\score}
161 block. The @code{piece} name from the header will be printed before
162 each movement. The title for the entire book can be put inside the
163 @code{\book}, but if it is not present, the @code{\header} which is at
164 the top of the file is inserted.
168 title = "Eight miniatures"
169 composer = "Igor Stravinsky"
173 \header @{ piece = "Romanze" @}
176 ..text of second verse..
179 ..text of third verse..
183 \header @{ piece = "Menuetto" @}
189 Pieces of music may be grouped into book parts using @code{\bookpart}
190 blocks. Book parts are separated by a page break, and can start with a
191 title, like the book itself, by specifying a @code{\header} block.
197 subtitle = "First part"
204 subtitle = "Second part"
212 @subsection File structure
222 A @code{.ly} file may contain any number of toplevel expressions, where a
223 toplevel expression is one of the following:
227 An output definition, such as @code{\paper}, @code{\midi}, and
228 @code{\layout}. Such a definition at the toplevel changes the default
229 book-wide settings. If more than one such definition of
230 the same type is entered at the top level any definitions in the later
231 expressions have precedence.
234 A direct scheme expression, such as
235 @code{#(set-default-paper-size "a7" 'landscape)} or
236 @code{#(ly:set-option 'point-and-click #f)}.
239 A @code{\header} block. This sets the global header block. This
240 is the block containing the definitions for book-wide settings, like
241 composer, title, etc.
244 A @code{\score} block. This score will be collected with other
245 toplevel scores, and combined as a single @code{\book}.
246 This behavior can be changed by setting the variable
247 @code{toplevel-score-handler} at toplevel. The default handler is
248 defined in the init file @file{../scm/@/lily@/.scm}.
251 A @code{\book} block logically combines multiple movements
252 (i.e., multiple @code{\score} blocks) in one document. If there
253 are a number of @code{\score}s, one output file will be created
254 for each @code{\book} block, in which all corresponding movements
255 are concatenated. The only reason to explicitly specify
256 @code{\book} blocks in a @code{.ly} file is if you wish to create
257 multiple output files from a single input file. One exception is
258 within lilypond-book documents, where you explicitly have to add
259 a @code{\book} block if you want more than a single @code{\score}
260 or @code{\markup} in the same example. This behavior can be
261 changed by setting the variable @code{toplevel-book-handler} at
262 toplevel. The default handler is defined in the init file
263 @file{../scm/@/lily@/.scm}.
266 A @code{\bookpart} block. A book may be divided into several parts,
267 using @code{\bookpart} blocks, in order to ease the page breaking,
268 or to use different @code{\paper} settings in different parts.
271 A compound music expression, such as
276 This will add the piece in a @code{\score} and format it in a
277 single book together with all other toplevel @code{\score}s and music
278 expressions. In other words, a file containing only the above
279 music expression will be translated into
295 This behavior can be changed by setting the variable
296 @code{toplevel-music-handler} at toplevel. The default handler is
297 defined in the init file @file{../scm/@/lily@/.scm}.
300 A markup text, a verse for example
303 2. The first line verse two.
307 Markup texts are rendered above, between or below the scores or music
308 expressions, wherever they appear.
318 This can be used later on in the file by entering @code{\foo}. The
319 name of a variable should have alphabetic characters only; no
320 numbers, underscores or dashes.
324 The following example shows three things that may be entered at
329 % Don't justify the output
341 At any point in a file, any of the following lexical instructions can
345 @item @code{\version}
346 @item @code{\include}
347 @item @code{\sourcefilename}
348 @item @code{\sourcefileline}
350 A single-line comment, introduced by a leading @code{%} sign.
353 A multi-line comment delimited by @code{%@{ .. %@}}.
360 @rlearning{How LilyPond input files work}.
363 @node Titles and headers
364 @section Titles and headers
366 Almost all printed music includes a title and the composer's name;
367 some pieces include a lot more information.
372 * Reference to page numbers::
373 * Table of contents::
377 @node Creating titles
378 @subsection Creating titles
380 Titles are created for each @code{\score} block, as well as for the full
381 input file (or @code{\book} block) and book parts (created by
382 @code{\bookpart} blocks).
384 The contents of the titles are taken from the @code{\header} blocks.
385 The header block for a book supports the following
391 The dedicatee of the music, centered at the top of the first page.
395 The title of the music, centered just below the dedication.
399 Subtitle, centered below the title.
401 @funindex subsubtitle
403 Subsubtitle, centered below the subtitle.
407 Name of the poet, flush-left below the subsubtitle.
411 Name of the instrument, centered below the subsubtitle. Also
412 centered at the top of pages (other than the first page).
416 Name of the composer, flush-right below the subsubtitle.
420 Meter string, flush-left below the poet.
424 Name of the arranger, flush-right below the composer.
428 Name of the piece, flush-left below the meter.
432 Name of the opus, flush-right below the arranger.
434 @cindex page breaks, forcing
435 @funindex breakbefore
437 This forces the title to start on a new page (set to ##t or ##f).
441 Copyright notice, centered at the bottom of the first page. To
442 insert the copyright symbol, see @ref{Text encoding}.
446 Centered at the bottom of the last page.
450 Here is a demonstration of the fields available. Note that you
451 may use any @ref{Formatting text}, commands in the header.
453 @lilypond[quote,verbatim,line-width=11.0\cm]
456 paper-height = 10.0\cm
461 dedication = "dedicated to me"
462 title = \markup \center-column { "Title first line" "Title second line,
464 subtitle = "the subtitle,"
465 subsubtitle = #(string-append "subsubtitle LilyPond version "
468 composer = \markup \center-column { "composer" \small "(1847-1973)" }
469 texttranslator = "Text Translator"
470 meter = \markup { \teeny "m" \tiny "e" \normalsize "t" \large "e" \huge
472 arranger = \markup { \fontsize #8.5 "a" \fontsize #2.5 "r" \fontsize
473 #-2.5 "r" \fontsize #-5.3 "a" \fontsize #7.5 "nger" }
474 instrument = \markup \bold \italic "instrument"
498 As demonstrated before, you can use multiple @code{\header} blocks.
499 When same fields appear in different blocks, the latter is used.
500 Here is a short example.
504 composer = "Composer"
512 piece = "New piece" % overwrite previous one
517 If you define the @code{\header} inside the @code{\score} block, then
518 normally only the @code{piece} and @code{opus} headers will be printed.
519 Note that the music expression must come before the @code{\header}.
521 @lilypond[quote,verbatim,line-width=11.0\cm]
525 title = "title" % not printed
532 @funindex print-all-headers
534 You may change this behavior (and print all the headers when defining
535 @code{\header} inside @code{\score}) by using
539 print-all-headers = ##t
546 The default footer is empty, except for the first page, where the
547 @code{copyright} field from @code{\header} is inserted, and the last
548 page, where @code{tagline} from @code{\header} is added. The default
549 tagline is @qq{Music engraving by LilyPond (@var{version})}.@footnote{Nicely
550 printed parts are good PR for us, so please leave the tagline if you
553 Headers may be completely removed by setting them to false.
564 @subsection Custom titles
566 A more advanced option is to change the definitions of the following
567 variables in the @code{\paper} block. The init file
568 @file{../ly/titling-init.ly} lists the default layout.
571 @funindex bookTitleMarkup
572 @item bookTitleMarkup
573 This is the title added at the top of the entire output document.
574 Typically, it has the composer and the title of the piece
576 @funindex scoreTitleMarkup
577 @item scoreTitleMarkup
578 This is the title put over a @code{\score} block. Typically, it has
579 the name of the movement (@code{piece} field).
581 @funindex oddHeaderMarkup
582 @item oddHeaderMarkup
583 This is the page header for odd-numbered pages.
585 @funindex evenHeaderMarkup
586 @item evenHeaderMarkup
587 This is the page header for even-numbered pages. If unspecified,
588 the odd header is used instead.
590 By default, headers are defined such that the page number is on the
591 outside edge, and the instrument is centered.
593 @funindex oddFooterMarkup
594 @item oddFooterMarkup
595 This is the page footer for odd-numbered pages.
597 @funindex evenFooterMarkup
598 @item evenFooterMarkup
599 This is the page footer for even-numbered pages. If unspecified,
600 the odd header is used instead.
602 By default, the footer has the copyright notice on the first, and
603 the tagline on the last page.
613 The following definition will put the title flush left, and the
614 composer flush right on a single line.
618 bookTitleMarkup = \markup {
620 \fromproperty #'header:title
621 \fromproperty #'header:composer
627 @node Reference to page numbers
628 @subsection Reference to page numbers
630 A particular place of a score can be marked using the @code{\label}
631 command, either at top-level or inside music. This label can then be
632 referred to in a markup, to get the number of the page where the marked
633 point is placed, using the @code{\page-ref} markup command.
635 @lilypond[verbatim,line-width=11.0\cm]
636 \header { tagline = ##f }
642 \pageBreak \mark A \label #'markA
647 \markup { The first score begins on page \page-ref #'firstScore "0" "?" }
648 \markup { Mark A is on page \page-ref #'markA "0" "?" }
652 The @code{\page-ref} markup command takes three arguments:
654 @item the label, a scheme symbol, eg. @code{#'firstScore};
655 @item a markup that will be used as a gauge to estimate the dimensions
657 @item a markup that will be used in place of the page number if the label
661 The reason why a gauge is needed is that, at the time markups are
662 interpreted, the page breaking has not yet occurred, so the page numbers
663 are not yet known. To work around this issue, the actual markup
664 interpretation is delayed to a later time; however, the dimensions of
665 the markup have to be known before, so a gauge is used to decide these
666 dimensions. If the book has between 10 and 99 pages, it may be "00",
667 ie. a two digit number.
678 @node Table of contents
679 @subsection Table of contents
680 A table of contents is included using the @code{\markuplines \table-of-contents}
681 command. The elements which should appear in the table of contents are
682 entered with the @code{\tocItem} command, which may be used either at
683 top-level, or inside a music expression.
686 \markuplines \table-of-contents
689 \tocItem \markup "First score"
693 \tocItem \markup "Some particular point in the first score"
698 \tocItem \markup "Second score"
706 The markups which are used to format the table of contents are defined
707 in the @code{\paper} block. The default ones are @code{tocTitleMarkup},
708 for formatting the title of the table, and @code{tocItemMarkup}, for
709 formatting the toc elements, composed of the element title and page
710 number. These variables may be changed by the user:
714 %% Translate the toc title into French:
715 tocTitleMarkup = \markup \huge \column {
716 \fill-line { \null "Table des matières" \null }
719 %% use larger font size
720 tocItemMarkup = \markup \large \fill-line {
721 \fromproperty #'toc:text \fromproperty #'toc:page
726 Note how the toc element text and page number are referred to in
727 the @code{tocItemMarkup} definition.
729 New commands and markups may also be defined to build more elaborated
732 @item first, define a new markup variable in the @code{\paper} block
733 @item then, define a music function which aims at adding a toc element
734 using this markup paper variable.
737 In the following example, a new style is defined for entering act names
738 in the table of contents of an opera:
742 tocActMarkup = \markup \large \column {
744 \fill-line { \null \italic \fromproperty #'toc:text \null }
750 #(define-music-function (parser location text) (markup?)
751 (add-toc-item! 'tocActMarkup text))
754 @lilypond[line-width=11.0\cm]
755 \header { tagline = ##f }
757 tocActMarkup = \markup \large \column {
759 \fill-line { \null \italic \fromproperty #'toc:text \null }
765 #(define-music-function (parser location text) (markup?)
766 (add-toc-item! 'tocActMarkup text))
769 \markuplines \table-of-contents
770 \tocAct \markup { Atto Primo }
771 \tocItem \markup { Coro. Viva il nostro Alcide }
772 \tocItem \markup { Cesare. Presti omai l'Egizzia terra }
773 \tocAct \markup { Atto Secondo }
774 \tocItem \markup { Sinfonia }
775 \tocItem \markup { Cleopatra. V'adoro, pupille, saette d'Amore }
782 Init files: @file{../ly/@/toc@/-init@/.ly}.
786 @funindex \table-of-contents
787 @code{\table-of-contents},
793 @node Working with input files
794 @section Working with input files
797 * Including LilyPond files::
798 * Different editions from one source::
800 * Displaying LilyPond notation::
804 @node Including LilyPond files
805 @subsection Including LilyPond files
808 @cindex including files
810 A large project may be split up into separate files. To refer to
814 \include "otherfile.ly"
817 The line @code{\include "otherfile.ly"} is equivalent to pasting the
818 contents of @file{otherfile.ly} into the current file at the place
819 where the @code{\include} appears. For example, in a large
820 project you might write separate files for each instrument part
821 and create a @qq{full score} file which brings together the
822 individual instrument files. Normally the included file will
823 define a number of variables which then become available
824 for use in the full score file. Tagged sections can be
825 marked in included files to assist in making them usable in
826 different places in a score, see @ref{Different editions from
829 Files in the current working directory may be referenced by
830 specifying just the file name after the @code{\include} command.
831 Files in other locations may be included by giving either a full
832 path reference or a relative path reference (but use the UNIX
833 forward slash, /, rather than the DOS/Windows back slash, \, as the
834 directory separator.) For example, if @file{stuff.ly} is located
835 one directory higher than the current working directory, use
838 \include "../stuff.ly"
842 or if the included orchestral parts files are all located in a
843 subdirectory called @file{parts} within the current directory, use
846 \include "parts/VI.ly"
847 \include "parts/VII.ly"
851 Files which are to be included can also contain @code{\include}
852 statements of their own. By default, these second-level
853 @code{\include} statements are not interpreted until they have
854 been brought into the main file, so the file names they specify
855 must all be relative to the directory containing the main file,
856 not the directory containing the included file. However,
857 this behavior can be changed by passing the option
858 @code{-drelative-includes} option at the command line
859 (or by adding @code{#(ly:set-option 'relative-includes #t)}
860 at the top of the main input file). With @code{relative-includes}
861 set, the path for each @code{\include} command will be taken
862 relative to the file containing that command. This behavior is
863 recommended and it will become the default behavior in a future
866 Files can also be included from a directory in a search path
867 specified as an option when invoking LilyPond from the command
868 line. The included files are then specified using just their
869 file name. For example, to compile @file{main.ly} which includes
870 files located in a subdirectory called @file{parts} by this method,
871 cd to the directory containing @file{main.ly} and enter
874 lilypond --include=parts main.ly
885 Files which are to be included in many scores may be placed in
886 the LilyPond directory @file{../ly}. (The location of this
887 directory is installation-dependent - see
888 @rlearning{Other sources of information}). These files can then
889 be included simply by naming them on an @code{\include} statement.
890 This is how the language-dependent files like @file{english.ly} are
893 LilyPond includes a number of files by default when you start
894 the program. These includes are not apparent to the user, but the
895 files may be identified by running @code{lilypond --verbose} from
896 the command line. This will display a list of paths and files that
897 LilyPond uses, along with much other information. Alternatively,
898 the more important of these files are discussed in
899 @rlearning{Other sources of information}. These files may be
900 edited, but changes to them will be lost on installing a new
903 Some simple examples of using @code{\include} are shown in
904 @rlearning{Scores and parts}.
909 @rlearning{Other sources of information},
910 @rlearning{Scores and parts}.
915 If an included file is given a name which is the same as one in
916 LilyPond's installation files, LilyPond's file from the
917 installation files takes precedence.
921 @node Different editions from one source
922 @subsection Different editions from one source
924 Several mechanisms are available to facilitate the generation
925 of different versions of a score from the same music source.
926 Variables are perhaps most useful for combining lengthy sections
927 of music and/or annotation in various ways, while tags are more
928 useful for selecting one from several alternative shorter sections
929 of music. Whichever method is used, separating the notation from
930 the structure of the score will make it easier to change the
931 structure while leaving the notation untouched.
938 @node Using variables
939 @unnumberedsubsubsec Using variables
941 @cindex variables, use of
943 If sections of the music are defined in variables they can be
944 reused in different parts of the score, see @rlearning{Organizing
945 pieces with variables}. For example, an @notation{a cappella}
946 vocal score frequently includes a piano reduction of the parts
947 for rehearsal purposes which is identical to the vocal music, so
948 the music need be entered only once. Music from two variables
949 may be combined on one staff, see @ref{Automatic part combining}.
952 @lilypond[verbatim,quote]
953 sopranoMusic = \relative c'' { a4 b c b8( a)}
954 altoMusic = \relative g' { e4 e e f }
955 tenorMusic = \relative c' { c4 b e d8( c) }
956 bassMusic = \relative c' { a4 gis a d, }
957 allLyrics = \lyricmode {King of glo -- ry }
959 \new Staff = "Soprano" \sopranoMusic
960 \new Lyrics \allLyrics
961 \new Staff = "Alto" \altoMusic
962 \new Lyrics \allLyrics
963 \new Staff = "Tenor" {
967 \new Lyrics \allLyrics
968 \new Staff = "Bass" {
972 \new Lyrics \allLyrics
975 \set Staff.printPartCombineTexts = ##f
981 \set Staff.printPartCombineTexts = ##f
991 Separate scores showing just the vocal parts or just the piano
992 part can be produced by changing just the structural statements,
993 leaving the musical notation unchanged.
995 For lengthy scores, the variable definitions may be placed in
996 separate files which are then included, see @ref{Including
1000 @unnumberedsubsubsec Using tags
1003 @funindex \keepWithTag
1004 @funindex \removeWithTag
1006 @cindex keep tagged music
1007 @cindex remove tagged music
1009 The @code{\tag #'@var{partA}} command marks a music expression
1010 with the name @var{partA}.
1011 Expressions tagged in this way can be selected or filtered out by
1012 name later, using either @code{\keepWithTag #'@var{name}} or
1013 @code{\removeWithTag #'@var{name}}. The result of applying these filters
1014 to tagged music is as follows:
1015 @multitable @columnfractions .5 .5
1019 Tagged music preceded by @code{\keepWithTag #'@var{name}}
1020 @tab Untagged music and music tagged with @var{name} is included;
1021 music tagged with any other tag name is excluded.
1023 Tagged music preceded by @code{\removeWithTag #'@var{name}}
1024 @tab Untagged music and music tagged with any tag name other than
1025 @var{name} is included; music tagged with @var{name} is
1028 Tagged music not preceded by either @code{\keepWithTag} or
1029 @code{\removeWithTag}
1030 @tab All tagged and untagged music is included.
1033 The arguments of the @code{\tag}, @code{\keepWithTag} and
1034 @code{\removeWithTag} commands should be a symbol
1035 (such as @code{#'score} or @code{#'part}), followed
1036 by a music expression.
1038 In the following example, we see two versions of a piece of music,
1039 one showing trills with the usual notation, and one with trills
1040 explicitly expanded:
1042 @lilypond[verbatim,quote]
1043 music = \relative g' {
1045 \tag #'trills {d8.\trill }
1046 \tag #'expand {\repeat unfold 3 {e32 d} }
1051 \keepWithTag #'trills \music
1054 \keepWithTag #'expand \music
1059 Alternatively, it is sometimes easier to exclude sections of music:
1061 @lilypond[verbatim,quote]
1062 music = \relative g' {
1064 \tag #'trills {d8.\trill }
1065 \tag #'expand {\repeat unfold 3 {e32 d} }
1070 \removeWithTag #'expand
1074 \removeWithTag #'trills
1079 Tagged filtering can be applied to articulations, texts, etc. by
1083 -\tag #'@var{your-tag}
1086 to an articulation. For example, this would define a note with a
1087 conditional fingering indication and a note with a conditional
1092 c1-\tag #'warn ^"Watch!"
1095 Multiple tags may be placed on expressions with multiple
1096 @code{\tag} entries:
1098 @lilypond[quote,verbatim]
1099 music = \relative c'' {
1100 \tag #'a \tag #'both { a a a a }
1101 \tag #'b \tag #'both { b b b b }
1104 \keepWithTag #'a \music
1105 \keepWithTag #'b \music
1106 \keepWithTag #'both \music
1110 Multiple @code{\removeWithTag} filters may be applied to a single
1111 music expression to remove several differently named tagged sections:
1113 @lilypond[verbatim,quote]
1114 music = \relative c'' {
1115 \tag #'A { a a a a }
1116 \tag #'B { b b b b }
1117 \tag #'C { c c c c }
1118 \tag #'D { d d d d }
1127 Two or more @code{\keepWithTag} filters applied to a single music
1128 expression will cause @emph{all} tagged sections to be removed, as
1129 the first filter will remove all tagged sections except the one
1130 named, and the second filter will remove even that tagged section.
1135 @rlearning{Organizing pieces with variables}.
1138 @ref{Automatic part combining},
1139 @ref{Including LilyPond files}.
1143 @c This warning is more general than this placement implies.
1144 @c Rests are not merged whether or not they come from tagged sections.
1145 @c Should be deleted? -td
1149 Multiple rests are not merged if you create a score with more
1150 than one tagged section at the same place.
1155 @subsection Text encoding
1157 LilyPond uses the character repertoire defined by the Unicode
1158 consortium and ISO/IEC 10646. This defines a unique name and
1159 code point for the character sets used in virtually all modern
1160 languages and many others too. Unicode can be implemented using
1161 several different encodings. LilyPond uses the UTF-8 encoding
1162 (UTF stands for Unicode Transformation Format) which represents
1163 all common Latin characters in one byte, and represents other
1164 characters using a variable length format of up to four bytes.
1166 The actual appearance of the characters is determined by the
1167 glyphs defined in the particular fonts available - a font defines
1168 the mapping of a subset of the Unicode code points to glyphs.
1169 LilyPond uses the Pango library to layout and render multi-lingual
1172 Lilypond does not perform any input-encoding conversions. This
1173 means that any text, be it title, lyric text, or musical
1174 instruction containing non-ASCII characters, must be encoded in
1175 UTF-8. The easiest way to enter such text is by using a
1176 Unicode-aware editor and saving the file with UTF-8 encoding. Most
1177 popular modern editors have UTF-8 support, for example, vim, Emacs,
1178 jEdit, and GEdit do. All MS Windows systems later than NT use
1179 Unicode as their native character encoding, so even Notepad can
1180 edit and save a file in UTF-8 format. A more functional
1181 alternative for Windows is BabelPad.
1183 If a LilyPond input file containing a non-ASCII character is not
1184 saved in UTF-8 format the error message
1187 FT_Get_Glyph_Name () error: invalid argument
1192 Here is an example showing Cyrillic, Hebrew and Portuguese
1196 %c No verbatim here as the code does not display correctly in PDF
1198 bulgarian = \lyricmode {
1199 Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
1203 hebrew = \lyricmode {
1204 זה כיף סתם לשמוע איך תנצח קרפד עץ טוב בגן.
1208 portuguese = \lyricmode {
1209 à vo -- cê uma can -- ção legal
1215 \addlyrics { \bulgarian }
1216 \addlyrics { \hebrew }
1217 \addlyrics { \portuguese }
1220 To enter a single character for which the Unicode code point is
1221 known but which is not available in the editor being used, use
1222 either @code{\char ##xhhhh} or @code{\char #dddd} within a
1223 @code{\markup} block, where @code{hhhh} is the hexadecimal code for
1224 the character required and @code{dddd} is the corresponding decimal
1225 value. Leading zeroes may be omitted, but it is usual to specify
1226 all four characters in the hexadecimal representation. (Note that
1227 the UTF-8 encoding of the code point should @emph{not} be used
1228 after @code{\char}, as UTF-8 encodings contain extra bits indicating
1229 the number of octets.)
1231 For example, @code{\char ##x03BE} and @code{\char #958} would both
1232 enter the Unicode U+03BE character, which has the Unicode name
1233 @qq{Greek Small Letter Xi}.
1235 Any Unicode code point may be entered in this way and if all special
1236 characters are entered in this format it is not necessary to save
1237 the input file in UTF-8 format. Of course, a font containing all
1238 such encoded characters must be installed and available to LilyPond.
1240 The following example shows Unicode hexadecimal values being entered
1241 in four places -- in a rehearsal mark, as articulation text, in
1242 lyrics and as stand-alone text below the score:
1244 @lilypond[quote,verbatim]
1247 c1 \mark \markup { \char ##x03EE }
1248 c1_\markup { \tiny { \char ##x03B1 " to " \char ##x03C9 } }
1250 \addlyrics { O \markup { \concat{ Ph \char ##x0153 be! } } }
1252 \markup { "Copyright 2008--2009" \char ##x00A9 }
1255 To enter the copyright sign in the copyright notice use:
1259 copyright = \markup @{ \char ##x00A9 "2008" @}
1263 @node Displaying LilyPond notation
1264 @subsection Displaying LilyPond notation
1266 @funindex \displayLilyMusic
1267 Displaying a music expression in LilyPond notation can be
1268 done using the music function @code{\displayLilyMusic}. For example,
1272 \displayLilyMusic \transpose c a, @{ c e g a bes @}
1279 @{ a, cis e fis g @}
1282 By default, LilyPond will print these messages to the console along
1283 with all the other messages. To split up these messages and save
1284 the results of @code{\display@{STUFF@}}, redirect the output to
1287 @c TODO What happens under Windows?
1290 lilypond file.ly >display.txt
1295 @node Controlling output
1296 @section Controlling output
1299 * Extracting fragments of music::
1300 * Skipping corrected music::
1303 @node Extracting fragments of music
1304 @subsection Extracting fragments of music
1306 It is possible to quote small fragments of a large score directly from
1307 the output. This can be compared to clipping a piece of a paper score
1310 This is done by defining the measures that need to be cut out
1311 separately. For example, including the following definition
1319 (make-rhythmic-location 5 1 2)
1320 (make-rhythmic-location 7 3 4)))
1325 will extract a fragment starting halfway the fifth measure, ending in
1326 the seventh measure. The meaning of @code{5 1 2} is: after a 1/2 note
1327 in measure 5, and @code{7 3 4} after 3 quarter notes in measure 7.
1329 More clip regions can be defined by adding more pairs of
1330 rhythmic-locations to the list.
1332 In order to use this feature, LilyPond must be invoked with
1333 @code{-dclip-systems}. The clips are output as EPS files, and are
1334 converted to PDF and PNG if these formats are switched on as well.
1336 For more information on output formats, see @rprogram{Invoking lilypond}.
1338 @node Skipping corrected music
1339 @subsection Skipping corrected music
1342 @funindex skipTypesetting
1343 @funindex showFirstLength
1344 @funindex showLastLength
1346 When entering or copying music, usually only the music near the end (where
1348 are adding notes) is interesting to view and correct. To speed up
1349 this correction process, it is possible to skip typesetting of all but
1350 the last few measures. This is achieved by putting
1353 showLastLength = R1*5
1358 in your source file. This will render only the last 5 measures
1359 (assuming 4/4 time signature) of every @code{\score} in the input
1360 file. For longer pieces, rendering only a small part is often an order
1361 of magnitude quicker than rendering it completely. When working on the
1362 beginning of a score you have already typeset (e.g. to add a new part),
1363 the @code{showFirstLength} property may be useful as well.
1365 Skipping parts of a score can be controlled in a more fine-grained
1366 fashion with the property @code{Score.skipTypesetting}. When it is
1367 set, no typesetting is performed at all.
1369 This property is also used to control output to the MIDI file. Note that
1370 it skips all events, including tempo and instrument changes. You have
1373 @lilypond[quote,fragment,ragged-right,verbatim]
1376 \set Score.skipTypesetting = ##t
1378 \set Score.skipTypesetting = ##f
1382 In polyphonic music, @code{Score.skipTypesetting} will affect all
1383 voices and staves, saving even more time.
1388 @section MIDI output
1393 MIDI (Musical Instrument Digital Interface) is a standard for
1394 connecting and controlling digital instruments. A MIDI file is a
1395 series of notes in a number of tracks. It is not an actual
1396 sound file; you need special software to translate between the
1397 series of notes and actual sounds.
1399 Pieces of music can be converted to MIDI files, so you can listen to
1400 what was entered. This is convenient for checking the music; octaves
1401 that are off or accidentals that were mistyped stand out very much
1402 when listening to the MIDI output.
1405 The midi output allocates a channel for each staff, and one for global
1406 settings. Therefore the midi file should not have more than 15 staves
1407 (or 14 if you do not use drums). Other staves will remain silent.
1410 * Creating MIDI files::
1412 * What goes into the MIDI output?::
1414 * Controlling MIDI dynamics::
1415 * Percussion in MIDI::
1418 @node Creating MIDI files
1419 @subsection Creating MIDI files
1421 To create a MIDI output file from a LilyPond input file, add a
1422 @code{\midi} block to a score, for example,
1431 If there is a @code{\midi} block in a @code{\score} with no
1432 @code{\layout} block, only MIDI output will be produced. When
1433 notation is needed too, a @code{\layout} block must be also be
1444 Pitches, rhythms, ties, dynamics, and tempo changes are interpreted
1445 and translated correctly to the MIDI output. Dynamic marks,
1446 crescendi and decrescendi translate into MIDI volume levels.
1447 Dynamic marks translate to a fixed fraction of the available MIDI
1448 volume range. Crescendi and decrescendi make the volume vary
1449 linearly between their two extremes. The effect of dynamic markings
1450 on the MIDI output can be removed completely, see @ref{MIDI block}.
1452 The initial tempo and later tempo changes can be specified
1453 with the @code{\tempo} command within the music notation. These
1454 are reflected in tempo changes in the MIDI output. This command
1455 will normally result in the metronome mark being printed, but this
1456 can be suppressed, see @ref{Metronome marks}. An alternative way
1457 of specifying the inital or overall MIDI tempo is described below,
1458 see @ref{MIDI block}.
1460 Due to limitations on some platforms, the default extension for
1461 MIDI files is @code{.mid}. If a different extension is preferred,
1462 insert the following line before the start of the @code{\score} block:
1465 #(ly:set-option 'midi-extension "midi")
1468 The line above will set the default extension for MIDI files to
1471 @unnumberedsubsubsec Instrument names
1473 @cindex instrument names
1474 @funindex Staff.midiInstrument
1476 The MIDI instrument to be used is specified by setting the
1477 @code{Staff.midiInstrument} property to the instrument name.
1478 The name should be chosen from the list in @ref{MIDI instruments}.
1482 \set Staff.midiInstrument = #"glockenspiel"
1488 \new Staff \with @{midiInstrument = #"cello"@} @{
1493 If the selected instrument does not exactly match an instrument from
1494 the list of MIDI instruments, the Grand Piano (@code{"acoustic grand"})
1500 @lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
1501 {changing-midi-output-to-one-channel-per-voice.ly}
1505 @c In 2.11 the following no longer seems to be a problem -td
1507 Unterminated (de)crescendos will not render properly in the midi file,
1508 resulting in silent passages of music. The workaround is to explicitly
1509 terminate the (de)crescendo. For example,
1516 will not work properly but
1526 Changes in the MIDI volume take place only on starting a note, so
1527 crescendi and decrescendi cannot affect the volume of a
1530 Not all midi players correctly handle tempo changes in the midi
1531 output. Players that are known to work include MS Windows Media
1532 Player and @uref{http://@/timidity@/.sourceforge@/.net/,timidity}.
1535 @subsection MIDI block
1538 A @code{\midi} block must appear within a score block if MIDI output
1539 is required. It is analogous to the layout block, but somewhat
1540 simpler. Often, the @code{\midi} block is left empty, but it
1541 can contain context rearrangements, new context definitions or code
1542 to set the values of properties. For example, the following will
1543 set the initial tempo exported to a MIDI file without causing a tempo
1544 indication to be printed:
1552 tempoWholesPerMinute = #(ly:make-moment 72 4)
1558 In this example the tempo is set to 72 quarter note
1559 beats per minute. This kind of tempo specification cannot take
1560 a dotted note length as an argument. If one is required, break
1561 the dotted note into smaller units. For example, a tempo of 90
1562 dotted quarter notes per minute can be specified as 270 eighth
1566 tempoWholesPerMinute = #(ly:make-moment 270 8)
1569 @cindex MIDI context definitions
1571 Context definitions follow precisely the same syntax as those
1572 within a @code{\layout} block. Translation modules for sound are
1573 called performers. The contexts for MIDI output are defined in
1574 @file{../ly/@/performer@/-init@/.ly},
1575 see @rlearning{Other sources of information}.
1576 For example, to remove the effect of dynamics
1577 from the MIDI output, insert the following lines in the
1578 @code{\midi@{ @}} block.
1585 \remove "Dynamic_performer"
1590 MIDI output is created only when a @code{\midi} block is included
1591 within a score block defined with a @code{\score} command. If it
1592 is placed within an explicitly instantiated score context (i.e.
1593 within a @code{\new Score} block) the file will fail. To solve
1594 this, enclose the @code{\new Score} and the @code{\midi} commands
1595 in a @code{\score} block.
1599 \new Score @{ @dots{}notes@dots{} @}
1604 @node What goes into the MIDI output?
1605 @subsection What goes into the MIDI output?
1607 @c TODO Check grace notes - timing is suspect?
1609 @unnumberedsubsubsec Supported in MIDI
1611 @cindex Pitches in MIDI
1612 @cindex MIDI, Pitches
1613 @cindex Quarter tones in MIDI
1614 @cindex MIDI, quarter tones
1615 @cindex Microtones in MIDI
1616 @cindex MIDI, microtones
1617 @cindex Chord names in MIDI
1618 @cindex MIDI, chord names
1619 @cindex Rhythms in MIDI
1620 @cindex MIDI, Rhythms
1623 The following items of notation are reflected in the MIDI output:
1627 @item Microtones (See @ref{Accidentals}. Rendering needs a
1628 player that supports pitch bend.)
1629 @item Chords entered as chord names
1630 @item Rhythms entered as note durations, including tuplets
1631 @item Tremolos entered without @q{@code{:}[@var{number}]}
1634 @item Crescendi, decrescendi over multiple notes
1635 @item Tempo changes entered with a tempo marking
1639 @unnumberedsubsubsec Unsupported in MIDI
1641 @c TODO index as above
1643 The following items of notation have no effect on the MIDI output:
1646 @item Rhythms entered as annotations, e.g. swing
1647 @item Tempo changes entered as annotations with no tempo marking
1648 @item Staccato and other articulations and ornamentations
1649 @item Slurs and Phrasing slurs
1650 @item Crescendi, decrescendi over a single note
1651 @item Tremolos entered with @q{@code{:}[@var{number}]}
1653 @item Microtonal chords
1657 @node Repeats in MIDI
1658 @subsection Repeats in MIDI
1660 @cindex repeats in MIDI
1661 @funindex \unfoldRepeats
1663 With a few minor additions, all types of repeats can be represented
1664 in the MIDI output. This is achieved by applying the
1665 @code{\unfoldRepeats} music function. This function changes all
1666 repeats to unfold repeats.
1668 @lilypond[quote,verbatim]
1670 \repeat tremolo 8 {c'32 e' }
1671 \repeat percent 2 { c''8 d'' }
1672 \repeat volta 2 {c'4 d' e' f'}
1681 When creating a score file using @code{\unfoldRepeats} for MIDI,
1682 it is necessary to make two @code{\score} blocks: one for MIDI
1683 (with unfolded repeats) and one for notation (with volta, tremolo,
1684 and percent repeats). For example,
1692 \unfoldRepeats @var{..music..}
1697 @node Controlling MIDI dynamics
1698 @subsection Controlling MIDI dynamics
1700 MIDI dynamics are implemented by the Dynamic_performer which lives
1701 by default in the Voice context. It is possible to control the
1702 overall MIDI volume, the relative volume of dynamic markings and
1703 the relative volume of different instruments.
1705 @unnumberedsubsubsec Dynamic marks
1707 Dynamic marks are translated to a fixed fraction of the available
1708 MIDI volume range. The default fractions range from 0.25 for
1709 @notation{ppppp} to 0.95 for @notation{fffff}. The set of dynamic
1710 marks and the associated fractions can be seen in
1711 @file{../scm/midi.scm}, see @rlearning{Other sources of information}.
1712 This set of fractions may be changed or extended by providing a
1713 function which takes a dynamic mark as its argument and returns the
1714 required fraction, and setting
1715 @code{Score.dynamicAbsoluteVolumeFunction} to this function.
1717 For example, if a @notation{rinforzando} dynamic marking,
1718 @code{\rfz}, is required, this will not by default
1719 have any effect on the MIDI volume, as this dynamic marking is not
1720 included in the default set. Similarly, if a new dynamic marking
1721 has been defined with @code{make-dynamic-script} that too will not
1722 be included in the default set. The following example shows how the
1723 MIDI volume for such dynamic markings might be added. The Scheme
1724 function sets the fraction to 0.9 if a dynamic mark of rfz is
1725 found, or calls the default function otherwise.
1727 @lilypond[verbatim,quote]
1728 #(define (myDynamics dynamic)
1729 (if (equal? dynamic "rfz")
1731 (default-dynamic-absolute-volume dynamic)))
1735 \set Staff.midiInstrument = #"cello"
1736 \set Score.dynamicAbsoluteVolumeFunction = #myDynamics
1748 Alternatively, if the whole table of fractions needs to be
1749 redefined, it would be better to use the
1750 @notation{default-dynamic-absolute-volume} procedure in
1751 @file{../scm/midi.scm} and the associated table as a model.
1752 The final example in this section shows how this might be done.
1754 @unnumberedsubsubsec Overall MIDI volume
1756 The minimum and maximum overall volume of MIDI dynamic markings is
1757 controlled by setting the properties @code{midiMinimumVolume} and
1758 @code{midiMaximumVolume} at the @code{Score} level. These
1759 properties have an effect only on dynamic marks, so if they
1760 are to apply from the start of the score a dynamic mark must be
1761 placed there. The fraction corresponding to each dynamic mark is
1762 modified with this formula
1765 midiMinimumVolume + (midiMaximumVolume - midiMinimumVolume) * fraction
1768 In the following example the dynamic range of the overall MIDI
1769 volume is limited to the range 0.2 - 0.5.
1771 @lilypond[verbatim,quote]
1777 \set Staff.midiInstrument = #"flute"
1778 \new Voice \relative c''' {
1786 \set Staff.midiInstrument = #"clarinet"
1787 \new Voice \relative c'' {
1798 tempoWholesPerMinute = #(ly:make-moment 72 2)
1799 midiMinimumVolume = #0.2
1800 midiMaximumVolume = #0.5
1806 @unnumberedsubsubsec Equalizing different instruments (i)
1808 If the minimum and maximum MIDI volume properties are set in
1809 the @code{Staff} context the relative volumes of the MIDI
1810 instruments can be controlled. This gives a basic instrument
1811 equalizer, which can enhance the quality of the MIDI output
1814 In this example the volume of the clarinet is reduced relative
1815 to the volume of the flute. There must be a dynamic
1816 mark on the first note of each instrument for this to work
1819 @lilypond[verbatim,quote]
1825 \set Staff.midiInstrument = #"flute"
1826 \set Staff.midiMinimumVolume = #0.7
1827 \set Staff.midiMaximumVolume = #0.9
1828 \new Voice \relative c''' {
1836 \set Staff.midiInstrument = #"clarinet"
1837 \set Staff.midiMinimumVolume = #0.3
1838 \set Staff.midiMaximumVolume = #0.6
1839 \new Voice \relative c'' {
1850 tempoWholesPerMinute = #(ly:make-moment 72 2)
1856 @unnumberedsubsubsec Equalizing different instruments (ii)
1858 If the MIDI minimum and maximum volume properties are not set
1859 LilyPond will, by default, apply a small degree of equalization
1860 to a few instruments. The instruments and the equalization
1861 applied are shown in the table @notation{instrument-equalizer-alist}
1862 in @file{../scm/midi.scm}.
1864 This basic default equalizer can be replaced by setting
1865 @code{instrumentEqualizer} in the @code{Score} context to a new
1866 Scheme procedure which accepts a MIDI instrument name as its only
1867 argument and returns a pair of fractions giving the minimum and
1868 maximum volumes to be applied to that instrument. This replacement
1869 is done in the same way as shown for resetting the
1870 @code{dynamicAbsoluteVolumeFunction} at the start of this section.
1871 The default equalizer, @notation{default-instrument-equalizer}, in
1872 @file{../scm/midi.scm} shows how such a procedure might be written.
1874 The following example sets the relative flute and clarinet volumes
1875 to the same values as the previous example.
1877 @lilypond[verbatim,quote]
1878 #(define my-instrument-equalizer-alist '())
1880 #(set! my-instrument-equalizer-alist
1883 ("flute" . (0.7 . 0.9))
1884 ("clarinet" . (0.3 . 0.6)))
1885 my-instrument-equalizer-alist))
1887 #(define (my-instrument-equalizer s)
1888 (let ((entry (assoc s my-instrument-equalizer-alist)))
1897 \set Score.instrumentEqualizer = #my-instrument-equalizer
1898 \set Staff.midiInstrument = #"flute"
1899 \new Voice \relative c''' {
1907 \set Staff.midiInstrument = #"clarinet"
1908 \new Voice \relative c'' {
1919 tempoWholesPerMinute = #(ly:make-moment 72 2)
1926 @c Delete when satisfied this is adequately covered elsewhere -td
1928 @n ode Microtones in MIDI
1929 @s ubsection Microtones in MIDI
1931 @cindex microtones in MIDI
1933 Microtones consisting of half sharps and half flats are exported
1934 to the MIDI file and render correctly in MIDI players which support
1935 pitch bending. See @ref{Note names in other languages}. Here is
1936 an example showing all the half sharps and half flats. It can be
1937 copied out and compiled to test microtones in your MIDI player.
1939 @lilypond[verbatim,quote]
1956 @node Percussion in MIDI
1957 @subsection Percussion in MIDI
1959 Percussion instruments are generally notated in a @code{DrumStaff}
1960 context and when notated in this way they are outputted correctly
1961 to MIDI channel@tie{}10, but some pitched percussion instruments,
1962 like the xylophone, marimba, vibraphone, timpani, etc., are
1963 treated like @qq{normal} instruments and music for these instruments
1964 should be entered in a normal @code{Staff} context, not a
1965 @code{DrumStaff} context, to obtain the correct MIDI output.
1967 Some non-pitched percussion sounds included in the general MIDI
1968 standard, like melodic tom, taiko drum, synth drum, etc., cannot
1969 be reached via MIDI channel@tie{}10, so the notation for such
1970 instruments should also be entered in a normal @code{Staff}
1971 context, using suitable normal pitches.
1973 Many percussion instruments are not included in the general MIDI
1974 standard, e.g. castanets. The easiest, although unsatisfactory,
1975 method of producing some MIDI output when writing for such
1976 instruments is to substitute the nearest sound from the standard
1979 @c TODO Expand with examples, and any other issues
1983 Because the general MIDI standard does not contain rim shots, the
1984 sidestick is used for this purpose instead.