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