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