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