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