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