TODO

   1 -*-outline-layout:(2 (-1 -1 0 :) 0);outline-stylish-prefixes:nil -*-
   2
   3 * GNU LilyPond TODO
   4 Features you cannot find in the documentation as working, should be
   5 mentioned here.  This is an assorted collection of stuff that will be
   6 done, might be done, or is an idea that we want to think about.
   7
   8 Most of the items are marked in the code as well
   9 Grep -i for TODO, FIXME and ugh/ugr/urg.
  10
  11 .* TODO before 1.2
  12 . * Break_req handling is silly (break_forbid () + \break fucks up.)
  13 . * chord names.
  14
  15 .* Cleanups needed
  16 . * \$ and $ identifier syntax in examples.
  17 . * Junk ghost positioning objects eg, Script leans on  Staffside
  18     leans on Staff.
  19 . * bracket ps code.
  20 . * mudela-book.
  21 . * Key_engraver, Local_key_item
  22 . * Think of comprehensive solution for "if (grace_b == self_grace_b_)"
  23 . * String[String.length] doesn't trap.
  24 . * y dimension units: staffspace vs. Point
  25 . * Beam
  26 . * Stem
  27 . * Rhythmic_column and interaction stem/rhythmic_column/note_head/dots.
  28 . * Duration
  29 . * clef engraver
  30 . * parser
  31 . * Lookup::text -> needs  to be TeX independent.
  32 . * junk Music_iterator::first_b_
  33 . * Bezier
  34
  35 .* BUGS
  36 . * [c8. c16 c16 c16] in 6/8 timesig.
  37 . *
  38 > \context Staff <
  39 >   {\voiceone c''4. r8}
  40 >   {\voicetwo c,4 r4}
  41 > >
  42
  43 .* STUFF
  44 . * We need feta-din*.mf files for more sizes than 10.
  45 . * align left edge of broken (de)cresc/slur/tie/tuplet/volta
  46 . * fix dynamics decently, ie. use kerning & ligatures.
  47 . * key restorations & repeats
  48 . * paperXX.ly \quartwidth, font setting not up to date. (Should read from AFM?)
  49 . * * auto melismaBusy for beams.
  50 . *In Caro Mio Ben, bar 8, there's a syllable that starts on a note, and
  51 ends on a pair of grace notes.  Standard practice is to mark this with
  52 a slur starting on the main note and ending on the grace note, so a
  53 singer knows where to break the words.
  54
  55 In bar 27, there's a crescendo that's supposed to start at the start
  56 of the grace notes and extend to the note after the grace notes.
  57 . * 5. Sometimes lyrics extend past the right end of the staff. I guess that
  58 this is a similar problem (if not another symptom of the same problem) as
  59 one of the spacing bugs mentioned in the TODO.
  60 . * 4.  Lyrics and grace sections don't go too well together.
  61         The words are aligned with the main note, not the start of the
  62         grace note.  This is usually wrong, but is sometimes right.
  63 . * decimal point in \paper {}
  64 . * tie-direction
  65 . * repeats and partial measures.
  66 . * rhythmic staff & accidentals.
  67 . * use melismaBusy in Lyric context to typeset melismata correctly.
  68 . * ly2dvi/lilypond logfile.
  69 . * def stem dir.
  70 . * hang Item on Spanner
  71 . * do --safe for PS output?
  72 . * msgfmt -o check?
  73 . * collision of lyrics with span_bars. See star-spangled.
  74 . * Auto_beam debugging output (waarom/wanneer heb jij die weggehaald?)
  75 . * It is impossible to typeset two textual scripts that are stacked
  76   on top of eachother and avoids note collisions and at the same
  77   time are typeset with different textStyle. I tried to move around
  78   the text_engraver and other engravers between Voice and Thread
  79   but the granularity is not fine enough, the scripts have to
  80   share the same engraver in order to be get correct vertical
  81   position but than they cannot have different style.
  82   In my opinion, all scripts that share the same staff, should
  83   be stacked vertically, avoiding collisions with the notes
  84   in all voices.
  85
  86 . * break priority setting from SCM.
  87 . * Matanya's tips:
  88 .  * don't  shorten stems/staffs closer to each other.
  89 .  * accidentals closer to note head
  90 .  * to space the staffs/staffgroups contained in the score.
  91 .  * heavier beams?
  92
  93 . * tuplets that are written as "number : note", for example
  94    "3 : [image of a half note here]".  possible?
  95 . * a note with a circle after it, meaning:
  96
  97    note + circle = note + 1/4 of its length
  98
  99    the circle is like a dot that's not filled in.  for example, on
 100    page three, the c-sharp on the second line should be a quarter with
 101    a circle, not a quarter tied to a sixteenth.  is this at all
 102    possible with lily?
 103 . * scm-ify \property values.
 104 . * make dependencies () a virtual function.
 105 . * deprecate hangOnClef.
 106 . * Abstraction for engravers:
 107 .  * make "in-between" engraver (Tie)
 108 .  * make wide_spanner_engraver (line_group_spanner, staff_symbol)
 109 . * store req -> element, element -> element causes for warnings
 110 . * compulsory hshift
 111 . *  My wish list for lyrics. I dream of a time when I will have enough time to
 112 become familiar enough with the source code to be able to implement some of
 113 these myself, but I don't know when that will be, so I thought I'd "publish"
 114 my suggestions in case someone else is in a position to give them some
 115 priority. Otherwise, perhaps they could go on the todo list?
 116
 117 If any of these are already implemented, please let me what the syntax is to
 118 use them!
 119
 120 1. Stanza numbering. Numbering at the beginning of a song with the number
 121 set to the left of the first note. It would also be nice (but not as
 122 important) to be able to have some form of automatic numbering at the
 123 beginning of each new line. This would make it easier to follow songs with a
 124 large number of stanzas.
 125
 126 3. Notes centred above/below lyrics rather than left-aligned.
 127
 128 4. It would be very nice to be able to build some kind of phrasing into the
 129 lyrics of hymns, etc, so that the first words of a phrase are left aligned
 130 with each other, the last words are right aligned, and the words in between
 131 are centred.
 132
 133 5. In a song, with (say) four stanzas and a chorus, it would be nice to be
 134 able to vertically align the chorus midway between the staves.
 135
 136 6. It would be nice to be able to put vertical brackets either side of a
 137 repeated section with different words for each repeat.
 138
 139 . * Give # lines in linebreaking.
 140 . * arrows on slurs.
 141 . * rewrite context defs using Scheme
 142 . * junk TeX specifics from internal code.
 143 . * \selectmusic to cut pieces from music.
 144 . * formatting of input stuff.
 145 .  * deps for ly2dvi
 146 . * TODO: merge atom & molecule; make  tree from molecule.
 147 . * Align_element::padding  ?
 148 . * typo checks on property names?
 149 . * use streambufs and iostream
 150         to provide IO handling for TeX stream, mudela stream, data-file.
 151 . * seriously buffer TeX output (do profile of writing .5 mb TeX file.)
 152 . * strip EXEs before installing
 153 . * zip target for binary windows dist (JBR)
 154 . * fix partial measures in meaningful way.
 155 . * uniformise recent feta contributions.
 156 .  * bigger and fatter 4/4 C
 157 . * relative mode for midi2ly
 158 . * junking \skip req in lyrics
 159 . * midi2ly empty staffs.
 160 . * use Fourier transformation for rhythmic quantisation.
 161 . * horizontal centering of dynamics
 162 . * $DEPENDENCIES_OUTPUT support
 163 . * turn slope-damping on/off
 164 . * sort out directory stuff.
 165 .  * --prefix option?
 166 .  * -I option per filetype?
 167 .  * kpathsea?
 168 . * fix vertical alignment and stafflines
 169 . * declaring Performers
 170 . * *.yo: fix pod manpage layout legacy
 171 . * text-items clash with stems/beams
 172 . * --include, -I option for ly2dvi (pass on to lily)
 173 . * fix placement of beam-less abbrev
 174 . * \meter 3/4;
 175         <{\voiceone cis4. cis8 cis4 | cis4 cis cis | r1 }
 176          {\voicetwo cis,4 r r | r2. | r1 }> |
 177         }
 178 . * Musical_pitch (analogous to Duration and Rhythmic_req)
 179           think about, analogous to pitch:
 180            * { a4 a16 } c <-- duration of c?
 181            * < a4 b8 > c <-- duration of c?
 182 . * \tempo 4. = 90;
 183 . * make sure all ex's have a mudela-version
 184 . * do rest-collisions for Multi_measure_rests as well.
 185 . * split error/warning in error/warning/non_fatal_error
 186 . * add a Duration_convert member to Duration_iter to set parameters.
 187         Junk global duration settings.
 188 . * en-,discouraged linebreaking:
 189 .  * handle DISALLOW < penalty > FORCE
 190 .  * discourage breaking of slurs
 191 . * fix variable define/lookup parser global<->paper
 192 . * fix title/instrument placements; see input/test/title.ly
 193 . * <\voiceone c4. \voicetwo c4>
 194 . *  I'd like to change the \repetitions command to Jan's suggested
 195   syntax: \repeat "repeatsymbol" 2 {...}, but I'm not sure that
 196   I understand the implementation of repeats well enough.
 197 . * add full cello suites to web site (kom op, Maarten!)
 198 . * rename 'staff_line_leading' (who is being lead where?) to
 199 staff_space, interline; (or other meaningful name) and use throughout
 200 lily
 201
 202 [-> leading are the lead strips between the sticks (lines) of
 203 typeface. ie. leading is vertical space  --hwn]
 204 . * add mudela-book-doc source to webstie.
 205 . * Rethink Time_description
 206 \cadenza , \meter,  should all be \properties
 207 . * fix singleStaffBracket
 208 . * rename
 209 .  * partial -> anacrouse
 210 . * move paper vars into engraver properties
 211 . * add new glyphs to font.ly
 212 . * check for groff / troff/ nroff et
 213 . * more intelligent file searching
 214 . * disable spaces in TeX stuff
 215 . * handle ^C for tmp/file creation.
 216 . * make LilyPond RPM fully relocatable
 217 . * better hshift (dots, distance, head dependent)
 218 . * didot / big point.
 219 . * clefs (AG): The "8" should appear closer to the actual clef,
 220 touching it.
 221 . * put errorlevel in Input class
 222 . * junk nesting slurs
 223 . * distinguish between unset and empty properties.
 224
 225 .* FONT
 226 . * the bracket is ugly (wings are too parabolic, should be more circular)
 227 . * versioning for Feta
 228 . * rewrite dynamic signs.  They're kind of spaghetti now.
 229 . * The `3' in the meter key is a one or two pixels too thin (at 600dpi)
 230         in the middle:
 231 . * design macro for penstroke with rounded endings
 232 . * timesig C: fat yet less curved.  Check out relations.
 233 . * design decent macro for bulbed endings
 234 . * printer dependencies.
 235 . * versioning
 236 . * lo-res fixes.
 237 . * work out sizes of character fonts.
 238 . * more symbols
 239 .  * piano pedals: Ped/*
 240 .  * maxima notehead
 241 .  * coda signs: Segno, O+
 242 .  * glissando, arpeggio
 243 .  * lengthened trill
 244 . * include important spacing dims in fetalog
 245 . * scalability: use blot_diameter everywhere, make font chubbier for
 246     small sizes.
 247
 248 .* 3RD PARTY BUGS
 249 . * UMR: Uninitialized memory read
 250       This is occurring while in:
 251             qst            [qsort.c]
 252             qsort          [libc.so.1]
 253             Keyword_table::Keyword_table(Keyword_ent*) [keyword.cc:28]
 254             My_lily_lexer::My_lily_lexer() [my-lily-lexer.cc:78]
 255             My_lily_parser::parse_file(String,String) [my-lily-parser.cc:54]
 256             do_one_file(String,String) [scores.cc:124]
 257       Reading 4 bytes from 0xefffeca8 on the stack.
 258       Address 0xefffeca8 is 728 bytes below frame pointer in function
 259 . * GNU diff 2.7: diff -rN does not see a new directory with empty file
 260 . * patch: don't touch timestamp if all patches fail.
 261 . * MetaPost: should not generate setgray for unfill
 262 . * mfplain.ini not in tetex 0.9
 263 . * mf-to-table -> add space 'before ; in AFM output.  (-> check AFM
 264 spec. Is this a bug in afm2tfm?)
 265 . * check out GCC signatures?
 266 . * glibc 2.0:
 267           f = fopen ("/dev/null", "r")
 268           assert (feof (f))
 269 . * tetex: mfplain.mem
 270
 271 .* PROJECTS
 272 . * Scripts:
 273 .  * stack scripts in chords:
 274           % fingering:        footing:
 275             < a-4 c-2 g-1 >   < c-\ltoe e-\lheel >
 276 .  * script-spacing
 277 .  * slur parts as a script
 278 .  * stack parameterised scripts for fingering and footing:
 279
 280 . * convert-mudela:
 281 .  * automatically add  a \version if not present.
 282 .  * better parsing
 283 .  * make smarter
 284 .  * convert-mudela -e empty.ly
 285
 286 . * emacs mudela-mode
 287 .  *  should handle block comments too.
 288 .  *  handle lexer modes (\header, \melodic, \lyric) etc.
 289 .  *  indentation
 290 .  *  notenames?
 291 .  *  fontlock: \melodic \melodic
 292
 293 . * use properties for:
 294 .  * default tempo.
 295 .  * cadenza mode?
 296
 297 . * page handling:
 298 .  * PS output
 299 .  * optimal pagebreaking.
 300
 301 . * internationalisation for input.
 302 .  * Unicode support? -> man 7 unicode
 303 .  * (The explanation below is mostly intended for Han-Wen and Jan)
 304 > Before, the font was changed with macros declared separately for
 305 > pure TeX and LaTeX, but now all the fonts are declared directly in
 306 > the generated code using the low-level TeX commands. This circumvents
 307 > the fontencoding mechanism of LaTeX and is a potential source of
 308 > problems also for us users of the Latin-1 character set.
 309 > I think it still works since the inputencoding latin1 is
 310 > declared by ly2dvi, but it still means that e.g. an o with
 311 > umlaut is typeset as a combination of the two symbols 'o' and
 312 > 'umlaut' instead of as a single character, as would be the case
 313 > if fontencoding OT1 had been used. This shouldn't give any
 314 > difference in layout, though. One of the main argument for using
 315 > fontencoding OT1 is for the hyphenation mechanism to work, an
 316 > argument that's clearly irrelevant in our application. Yet we
 317 > see the problem for August.
 318
 319 . * \header
 320 .  * output header info to MIDI too.
 321
 322 . * a musical dictionary. See Documentation/vocabulary-*, other
 323 languages:
 324 .  * explanations
 325 .  * italian
 326 .  * german
 327 .  * dutch
 328 .  * swedish
 329          .. ?
 330
 331 . * chords
 332 .  * guitar chords (fret diagrams)
 333 .  * other chord name styles (american(?) style)
 334 .  * basso continuo
 335 .  * MIDI output?
 336
 337 . * Debug logs:
 338 .  * derive lily_stream, Dstream, texstream from ostream?
 339 .  * indentable stream as baseclass for TeX stream, lily stream, Dstream.
 340 .  * use dstream feature in midi2ly
 341 .  * integrate IO checking into stream class
 342
 343 . * input converters
 344 .  * NIFF?
 345 .  * ABC?
 346 .  * SMDL?
 347
 348 . * add to MIDI output:
 349 .  * sharp / flat on trills (in MIDI ??)
 350 .  * ornaments (and trills?)
 351 .  * slurs
 352 .  * accents
 353 .  * dynamics
 354 > Would it be hard to add support for proper dynamics in MIDI output?  I
 355 > would really like to have this feature...
 356
 357 Concretely spoken, for dynamics you have to write a performer
 358 (Dynamics_performer), that will take the input requests. If I
 359 understand correctly, every MIDI note played must have its dynamic
 360 strength set separately.  That means the the Dynamics_performer must
 361 set the strength of every Audio_note it finds.  This means that one
 362 has to modify existing Audio items.  The best way of doing this is
 363 with a broadcast/acknowledge process.
 364
 365 So the best way of handling this, is
 366
 367   1 supporting dynamic settings in Audio_note
 368
 369   2 Write a Dynamics_performer that will modify
 370   any notes it finds to set appropriate strengths.
 371
 372 I'd say that the work involved is not hard, but you have to be fluent
 373 with C++ and need some insight into the working of Notation Contexts
 374 and friends.  I guess I could do it in a day or so, but if you are not
 375 so fluent with the inner workings of LilyPond, it could take you some
 376 more time (A few more days?).
 377
 378 Please note, that I am *not* going to code this myself: my days are
 379 valuable, and I think I have more interesting things to do than fixing
 380 the MIDI output (I don't even have a soundcard).  But I *do* want to help
 381 you or other people with implementing this, so if you need help, don't
 382 hesitate to ask.
 383 .  * account for rhythmic position in measure
 384 .  * etc.
 385
 386
 387 . * Output class, handles : (smallish)
 388 .  * help text /(c) notice?
 389 .  * version line
 390 .  * warning /errors/progress
 391 .  * abort on error/warning; exit status
 392 .  * quiet/ignore-version options
 393 .  * logfile output
 394
 395 . * PS
 396 .  * speed up PS code.
 397 .  * PS lines to .eps files
 398 .  * write custom prolog
 399
 400 . * SGML input
 401
 402 . * Documentation
 403 .  * remove links to non-free SW.
 404 .  * internal documentation
 405 .  * a general paper.
 406 .  * \properties
 407 .   * left/rightbeamcount
 408 .   * various other new properties.
 409 .  * introduction?
 410 .  * info?
 411 .  * LaTeX?
 412 .  * more manpages?
 413 .  * Doc (C) stuff of sheet music
 414 .  * a better format?  SGML?  TeX?  Info?
 415 .  * a better tutorial
 416
 417 . * more spanners (smallish)
 418 .  * Glissando
 419 .  * trill
 420
 421 . * Rewrite Stem, Beam (hairy)
 422 .  * general shaving on Beam and Stem
 423 .  * use plet grouping
 424 .  * beams over bars
 425
 426 . * lines:
 427 .  * Ledger lines, should be separate item: Ledger_lines
 428 .  * set different line sizes / thicknesses
 429 .  * beam stem showthrough, inter beam sizes (french vs german style)
 430
 431 . * Collisions
 432 .  * left/right note balls should be handled by Collision:
 433         < \multi 2; { \stem 1; <b c> } { <f as b> } >
 434
 435 . * Keys:
 436 .  * merge key{item} & localkey{item}?
 437 .  * spacing, national styles?
 438
 439 . * Support for TAB
 440 .  * redo Notehead to allow digits as heads
 441 .  * add a \tablature {} lexer mode for easy entering
 442
 443 . * should adjust stemlength for flag number.
 444
 445 . * breaking:
 446 .  * caching breakpoints
 447 .  * saving them
 448 .  * specify number of lines
 449
 450 .* INPUTLANGUAGE
 451 . * convention for slurs vs. phrasing marks.
 452 . * Language:
 453 .  * \translator -> ?
 454 .  * fix \partial
 455 .  * \bla {} vs \bla ;
 456 .  * mix engraver hacking with music ?
 457 .  * \once\property  KEY = VAL
 458 .  * input property
 459 .  * abstract grammar.
 460 . * Figure out semicolons.
 461 . * <c f a>4 ?
 462 . * Viola mode?
 463
 464                 @c c g e g
 465         for
 466                 c g es g,
 467
 468                 @A c g e g
 469         for
 470                 cis gis e gis
 471 . * configure pitch_byte
 472 . * rest name configurable
 473
 474
 475 .* SMALLISH PROJECTS
 476
 477 . * fix confusing naming in Engraver vs Engraver_group_engraver (context)
 478
 479 . * A range for context errors (eg. mark both { and }. )
 480
 481 . * lyric in staff  (sharpsharp in staff, text below)
 482
 483 . * write Dynamic_line (to group dynamics horizontally)
 484
 485 . * use Real for all y positions.
 486
 487 . * half-sharps, half-flats
 488
 489 . * adaptive accidental spacing.
 490
 491 . * handle EOF graciously in error messages.
 492
 493 . * midi esp.: use I32 iso int where 32 bits are needed (or assumed...)
 494
 495 . * lily \tempo
 496
 497 . *   % toe to bheel   four to five
 498             %   ^_u            4_5
 499             %     -
 500             %  --|x--         --|x--
 501             %  --|---         --|---
 502             %  --|---         --|---
 503           (where "to" is a tiny bow)
 504
 505 . * auxilliary file for caching info.
 506 . * Text_crescendo
 507
 508 .* IDEAS
 509 . * Output data structures of Mudela in XML/SGML.
 510 . * create libmudela, or liblily_frontend
 511 . * move MIDI stuff (including Quantization) to a ANSI C libmidi library.
 512 . * Spacing_request for manually adjusting spacing
 513 . * caching breakpoints
 514 . * used fixedpoint arithmetic for min. energy.
 515
 516 * OUTLINE SETUP
 517 .* .EMACS
 518 ;;; from outline.el
 519 (defvar outline-font-lock-keywords
 520   '(;; Highlight headings according to the level.
 521     ;; must change this to allout node layout
 522     ;;("^\\(\\*+\\)[ \t]*\\(.+\\)?[ \t]*$"
 523     ("^\\([.]*[ ]*[*]\\)[ \t]*\\(.*\\)$"
 524      (1 font-lock-string-face)
 525      (2 (let ((len (- (match-end 1) (match-beginning 1))))
 526           (or (cdr (assq len '((1 . font-lock-function-name-face)
 527                                (2 . font-lock-keyword-face)
 528                                (3 . font-lock-comment-face))))
 529               font-lock-variable-name-face))
 530         nil t))
 531     ;; Highlight citations of the form [1] and [Mar94].
 532     ("\\[\\([A-Z][A-Za-z]+\\)*[0-9]+\\]" . font-lock-type-face))
 533   "Additional expressions to highlight in Outline mode.")
 534
 535 (add-hook 'outline-mode-hook
 536           '(lambda ()
 537             (setq font-lock-maximum-decoration t)
 538             (setq font-lock-maximum-decoration t)
 539             (make-local-variable 'font-lock-defaults)
 540             (setq font-lock-defaults '(outline-font-lock-keywords t))
 541             (font-lock-mode global-font-lock-mode)
 542         ))
 543
 544 (require 'allout)
 545 (outline-init 't)
 546
 547