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