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