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