Documentation/user/converters.itely

   1 @c -*-texinfo-*-
   2
   3 @node Converting from other formats
   4 @chapter Converting from other formats
   5
   6 Music can be entered also by importing it from other formats.  This
   7 chapter documents the tools included in the distribution to do so.
   8 There are other tools that produce LilyPond input, for example GUI
   9 sequencers and XML converters. Refer to the
  10 @uref{http://lilypond.org,website} for more details.
  11
  12
  13
  14 @menu
  15 * Invoking convert-ly::         Older LilyPond versions.
  16 * Invoking midi2ly::            Importing MIDI.
  17 * Invoking etf2ly::             Importing Finale.
  18 * Invoking abc2ly::             Importing ABC.
  19 * Invoking musedata2ly::        Importing Musedata.
  20 * Invoking mup2ly::             Importing MUP.
  21 @end menu
  22
  23
  24 @node Invoking convert-ly
  25 @section Invoking convert-ly
  26
  27 Convert-ly sequentially applies different conversions to upgrade a
  28 LilyPond input file.  It uses @code{\version} statements in the file to
  29 detect the old version number.  For example, to upgrade all LilyPond
  30 files in the current directory and its subdirectories, use
  31 @example
  32         convert-ly -e --to=1.3.150 `find . -name '*.ly' -print`
  33 @end example
  34
  35 The program is invoked as follows:
  36 @example
  37         convert-ly [@var{option}]@dots{} @var{file}@dots{}
  38 @end example
  39
  40
  41 The following options can be given:
  42
  43 @table @code
  44 @item -e,--edit
  45     Do an inline edit of the input file. Overrides @code{--output}.
  46 @item -f,--from=@var{from-patchlevel}
  47     Set the level to convert from. If this is not set, convert-ly will
  48     guess this, on the basis of @code{\version} strings in the file.
  49 @item -o,--output=@var{file}
  50     Set the output file to write.
  51 @item -n,--no-version
  52     Normally, convert-ly adds a @code{\version} indicator
  53     to the output. Specifying this option suppresses this.
  54 @item -s, --show-rules
  55     Show all known conversions and exit.
  56 @item --to=@var{to-patchlevel}
  57     Set the goal version of the conversion. It defaults to the latest
  58     available version.
  59 @item -h, --help
  60     Print usage help.
  61 @end table
  62
  63
  64
  65 @refbugs
  66
  67 Not all language changes are handled. Only one output option can be specified.
  68
  69 @node Invoking midi2ly
  70 @section Invoking midi2ly
  71
  72 @cindex MIDI
  73
  74 Midi2ly translates a MIDI input file to a LilyPond source file.
  75
  76 MIDI (Music Instrument Digital Interface) is a standard for digital
  77 instruments: it specifies cabling, a serial protocol and a file
  78 format.  The MIDI file format is a de facto standard format for
  79 exporting music from other programs, so this capability may come in
  80 useful when you want to import files from a program that has no
  81 converter for its native format.
  82
  83 Midi2ly will convert tracks into @internalsref{Staff} and
  84 channels into @internalsref{Voice} contexts.  Relative mode is used
  85 for pitches, durations are only written when necessary.
  86
  87 It is possible to record a MIDI file using a digital keyboard, and
  88 then convert it to @file{.ly}. However, human players are not
  89 rhythmically exact enough to make a MIDI to LY conversion trivial.
  90 midi2ly tries to compensate for these timing errors, but is not very
  91 good at this. It is therefore not recommended to use midi2ly for
  92 human-generated midi files.
  93
  94 Hackers who know about signal processing are invited to write a more
  95 robust midi2ly.  midi2ly is written in Python, using a module written in
  96 C to parse the MIDI files.
  97
  98 It is invoked as follows:
  99 @example
 100         midi2ly [@var{option}]@dots{} @var{midi-file}
 101 @end example
 102
 103 The following options are supported by midi2ly:
 104
 105 @table @code
 106 @item -a, --absolute-pitches
 107     Print absolute pitches.
 108 @item -d, --duration-quant=@var{DUR}
 109     Quantize note durations on @var{DUR}.
 110 @item -e, --explicit-durations
 111     Print explicit durations.
 112 @item -h,--help
 113     Show summary of usage.
 114 @item -k, --key=@var{acc}[:@var{minor}]
 115     Set default key.  @var{acc} > 0 sets number of sharps; @var{acc} < 0
 116     sets number of flats.  A minor key is indicated by ":1".
 117 @item -o, --output=@var{file}
 118     Write output to @var{file}.
 119 @item -s, --start-quant=@var{DUR}
 120     Quantize note starts on DUR.
 121 @item -t, --allow-tuplet=@var{DUR}*@var{NUM}/@var{DEN}
 122     Allow tuplet durations @var{DUR}*@var{NUM}/@var{DEN}.
 123 @item -V, --verbose
 124     Be verbose.
 125 @item -v, --version
 126     Print version number.
 127 @item -w, --warranty
 128     Show warranty and copyright.
 129 @item -x, --text-lyrics
 130     Treat every text as a lyric.
 131 @end table
 132
 133
 134 @node Invoking etf2ly
 135 @section Invoking etf2ly
 136
 137 @cindex ETF
 138 @cindex enigma
 139 @cindex Finale
 140 @cindex Coda Technology
 141
 142 ETF (Enigma Transport Format) is a format used by Coda Music
 143 Technology's Finale product. etf2ly will convert part of an ETF
 144 file to a ready-to-use LilyPond file.
 145
 146 It is invoked as follows:
 147 @example
 148         etf2ly [@var{option}]@dots{} @var{etf-file}
 149 @end example
 150
 151 The following options are supported by etf2ly:
 152 @table @code
 153 @item   -h,--help
 154 this help
 155 @item  -o,--output=FILE
 156 set output filename to FILE
 157 @item  -v,--version
 158 version information
 159 @end table
 160
 161
 162 @refbugs
 163
 164 The list of articulation scripts is incomplete.  Empty measures confuse
 165 etf2ly. Sequences of grace notes are ended improperly sometimes.
 166
 167
 168 @node Invoking abc2ly
 169 @section Invoking abc2ly
 170
 171 @cindex ABC
 172
 173 ABC is a fairly simple ASCII based format. It is described at the ABC site:
 174 @quotation
 175 @uref{http://www.gre.ac.uk/~c.walshaw/abc2mtex/abc.txt}.
 176 @end quotation
 177 abc2ly translates from ABC to LilyPond. It is invoked as follows:
 178
 179 @example
 180         abc2ly [@var{option}]@dots{} @var{abc-file}
 181 @end example
 182
 183 The following options are supported by abc2ly:
 184
 185 @table @code
 186 @item   -h,--help
 187 this help
 188 @item  -o,--output=@var{file}
 189 set output filename to @var{file}.
 190 @item  -v,--version
 191 print version information.
 192 @end table
 193
 194 There is a rudimentary facility for adding LilyPond code to the ABC
 195 source file.  If you say:
 196
 197 @example
 198         %%LY voices \set autoBeaming = ##f
 199 @end example
 200
 201 This will cause the text following the keyword ``voices'' to be inserted
 202 into the current voice of the LilyPond output file.
 203
 204 Similarly,
 205
 206 @example
 207         %%LY slyrics more words
 208 @end example
 209
 210 will cause the text following the ``slyrics'' keyword to be inserted
 211 into the current line of lyrics.
 212
 213
 214 @refbugs
 215
 216 The ABC standard is not very ``standard''. For extended features
 217 (e.g. polyphonic music) different conventions exist.
 218
 219 Multiple tunes in one file cannot be converted.
 220
 221 ABC synchronizes words and notes at the beginning of a line; abc2ly does
 222 not.
 223
 224 abc2ly ignores the ABC beaming.
 225
 226 @node Invoking musedata2ly
 227 @section Invoking musedata2ly
 228
 229 @cindex MuseData
 230 @cindex CCARH
 231
 232 MuseData (see @uref{http://www.musedata.org/}) is an electronic
 233 library of classical music scores, comprising at the time of writing
 234 about 800 composition dating from 1700 to 1825.  The music is encoded
 235 in so-called MuseData format.  musedata2ly converts a set of MuseData
 236 files to one .ly file, and will include a @code{\header} field if a
 237 @file{.ref} file is supplied. It is invoked as follows:
 238
 239 @example
 240         musedata2ly [@var{option}]@dots{} @var{musedata-files}
 241 @end example
 242
 243 The following options are supported by musedata2ly:
 244
 245 @table @code
 246 @item   -h,--help
 247 print help
 248 @item  -o,--output=@var{file}
 249 set output filename to @var{file}
 250 @item  -v,--version
 251 version information
 252 @item  -r,--ref=@var{reffile}
 253  read background information from ref-file
 254 @var{reffile}
 255 @end table
 256
 257 @refbugs
 258
 259 @file{musedata2ly} converts only a small subset of MuseData.
 260
 261 @node Invoking mup2ly
 262 @section Invoking mup2ly
 263
 264 Mup (Music Publisher) is a shareware music notation program by Arkkra
 265 Enterprises.  Mup2ly will convert part of a Mup file to LilyPond
 266 format. It is invoked as follows:
 267
 268 @cindex Music Publisher
 269 @cindex Mup
 270 @cindex Arkkra
 271
 272 @example
 273         mup2ly [@var{option}]@dots{} @var{mup-file}
 274 @end example
 275
 276 The following options are supported by mup2ly:
 277
 278 @table @code
 279 @item   -d,--debug
 280 show what constructs are not converted, but skipped.
 281 @item -D, --define=@var{name}[=@code{exp}]
 282 define macro @var{name} with opt expansion @code{exp}
 283 @item   -E,--pre-process
 284 only run the pre-processor
 285 @item   -h,--help
 286 print help
 287 @item  -o,--output=@var{file}
 288 write output to @var{file}
 289 @item  -v,--version
 290 version information
 291 @item  -w,--warranty
 292 print warranty and copyright.
 293 @end table
 294
 295
 296 @refbugs
 297
 298 Only plain notes (pitches, durations), voices, and staves are
 299 converted.
 300
 301
 302