lilypond-1.0.13
[lilypond.git] / TODO
blobb25fa11e4ba0f110cf9acc0d38f5f2e84dd52939
1 Features you cannot find in the doco as working, should be mentioned here.
4 This is an assorted collection of stuff that will be done, might be
5 done, or is an idea that I want to think about
7 Most of the items are marked in the code as well, with full explanation. 
8 grep for TODO and ugh/ugr/urg
10         * uniformise property names.
12         ydirection <-> yDirection
14         * 
15    \score{
16       \notes { \property Staff.defaultclef = bass    a b c d }
17       \paper{
20    Staff = \translator {
21            \type "Line_group_engraver_group";
22            \consists "Bar_engraver";
23            \consists "Clef_engraver";
24            \consists "Key_engraver";
25            \consists "Local_key_engraver";
26            \consists "Time_signature_engraver";
27            \consists "Staff_sym_engraver";
28            \consists "Collision_engraver";
29            \consists "Rest_collision_engraver";
30            \consists "Separating_line_group_engraver";
31            \accepts "Voice";
32         }
33    }
36         * typo checks on property names?
38         * egcs-1.1 support
40         * make engraver hacking robust.
42         * fix LOCALE settings, and \def\foo{2,000pt} output
44         * use streambufs and iostream
45         to provide IO handling for TeX stream, mudela stream, data-file.
47         * seriously buffer TeX output (do profile of writing .5 mb TeX file.)
49         * strip EXEs before installing
51         * zip target for binary windows dist (JBR)
53         * repeat bars: need distance after ":|" and before "|:"
55         * text continuationss
57         * revise documentation
59         * abbrev -> tremolo
61         * junking \skip req in lyrics
63         * \shape 1st dim skipped? 
65         * Choire -> Choir
67         * Language:
68         - general plet mechanism.
70                 \plet 2/3 { c8 c8 c8 }
72         ie.
74                 Music: PLET int '/' int Music
76         - \type -> \context ?
77         - \translator -> ?
78         - fix \partial 
79         - \bla {} vs \bla ; 
80         - mix engraver hacking with music ?
81         - \once\property  KEY = VAL
82         - \addtranslator, \removetranslator
83         - junk ^ and _ for scripts
84         - junk _ for lyrics.
85         - abstract grammar.
87         * install TeX stuff into tex/generic directory.
89         * percussion note heads
91         * mi2mu empty staffs.
93         * include MIDI list 
95         * make separate translation property list.
97         * make GNU style webpages.
99         * There seems to be an install error in lilypond-1.0.0.  Most of the
100         files in the "init" directory don't get installed in the
101         /usr/local/share/lilypond directory.  The files installed are of
102         the form feta*.ly.  In particular init.ly doesn't get installed.
103         I installed the files by hand and then the system seems to work.
105         * midi_instrument -> midiInstrument
107         * horizontal centering of dynamics 
109         * \font\fontA=feta20.afm (.afm?)
111         * gzip RH manpage
113         * stable make/config stuff
115         * stemup/stemdown; see test/updown.fly
116           - check examples; add \type Staff hither and thether
118         * $DEPENDENCIES_OUTPUT support
120         * use a fake-yodl.sh to mimick yodl when yodl is not installed
122         * fix BUGs
124         * fix weird behaviour when .AFMs not found.
126         * Xdvi zooming ?!
127                 gs: Error: /undefined in draw_beam
128                 gs: Operand stack:
130         * run texhash after installing .tex
132         * fix vertical alignment and stafflines
134         * GrandStaff needs more work -- I want a single word
135         `harpsichord' to the left of the grandstaff, not one on each
136         stave.  (Organ staff -- with separate pedal -- but common
137         properties may be something to think about.  Of course for
138         organ you want to be able to give stop indications on the way
139         through, so the \property Voice.Instrument would be a stop,
140         and \property GrandStaff.instrument would be PipeOrgan...)
142         * make Tie_req a "command" { <c g> ~ <c g> }
144         * bib ep1988
146         * revise the Score_priority_align_engraver concept.  It sucks. 
148         * ly2xdvi, ly2ps
150         * make new VoiceOne, VoiceTwo, VoiceThree contexts with
151 ydirection and hshift preset
153         * *.yo: fix pod manpage layout legacy
155         * text-items clash with stems/beams
157         * --include, -I option for ly2dvi (pass on to lily)
159         * fix placement of beam-less abbrev
161         * \meter 3/4;
162         <{\voiceone cis4. cis8 cis4 | cis4 cis cis | r1 }
163          {\voicetwo cis,4 r r | r2. | r1 }> |
164         }
166         * try to use template<Type> iso MACRO(Type)
168         - NEWS: ... Musical_pitch (analogous to Duration and Rhythmic_req)
169           think about, analogous to pitch: 
170            * { a4 a16 } c <-- duration of c?
171            * <a4 b8> c <-- duration of c?
173         * \tempo 4. = 90;
175         * fix audio-items (don't use (input) requests, but copy data)
177         * junk My_lily_parser::abbrev_beam_type_i_ 
179         * make sure all ex's have a mudela-version
181         * do rest-collisions for Multi_measure_rests as well.
183         * split error/warning in error/warning/non_fatal_error
185         * add a Duration_convert member to Duration_iter to set parameters.
186         Junk global duration settings. 
188         * deps for ly2dvi
190         * clean up abbrev/plet/beam/abbrevbeam/duration mess in parser.
192         * minimum length second part broken tie
194         * en-,discouraged linebreaking: 
195           - handle DISALLOW < penalty > FORCE
196           - discourage breaking of slurs
198         * multibar rest
199           - symbol(s)
201         * fix variable define/lookup parser global<->paper
203         * fix title/instrument placements; see input/test/title.ly
205         * <\voiceone c4. \voicetwo c4>
207         * add full cello suites to web site (kom op, Maarten!)
209         * Rethink Time_description
210           * \cadenza , \meter, \grouping should all be \properties
212         * rename
213           - plet -> tuplet
214           - measure -> bar
215           - abbreviation-beam -> (measured/unmeasured) tremolo
216           - partial -> anacrouse
218         * libtoolize flowerlib
220         * shared lib
222         * robustify Beam (in case of no stems, 32nd notes)
224         * decentralised spring factory
226         * move paper vars into engraver properties
228         * check for groff / troff/ nroff et
230         * more intelligent file searching
231         - use kpsepath
232         - make LilyPond fully relocatable
234         * use kpsepath to find all TeX dirs
235         - configure.in 
236         - clean-fonts.sh
238         * nicen examples:
239         - break-up heavily-nested score blocks
241         * disable spaces in TeX stuff
242         
243         * handle ^C for tmp/file creation.
245         * dots & rest collisions.
247         * documentation
248         - introduction?
249         - info?
250         - LaTeX?
251         - more manpages?
253         * versioning for Feta
255         * the warning about the negative slur/tie length appears twice
256         which is irritating.
258         * The `3' in the meter key is a one or two pixels too thin (at 600dpi)
259         in the middle:
261         * the bracket is ugly (wings are too parabolic, should be more circular)
263         * better hshift (dots, distance, head dependent)
265         * clefs (AG): The "8" should appear closer to the actual clef,
266           touching it.
268         * scoping for properties?
270         {       c4
271                 \multi 2  < { \stemup .. } { \stemdown .. } >
272                 c2 
273         }
275         this modifies \stem for the c2
277         * put errorlevel in Input class
279         * junk nesting slurs
281         * integrate midi-elts from mi2mu and lily?
283         * cautionary accidental
285         * score-bar-scripts
286         FMR: Free memory read:
287           * This is occurring while in:
288                 Bar_column::do_substitute_dependency(Score_element*,Score_element*) [bar
289         -column.cc:29]
290                 Score_element::unlink() [score-elem.cc:383]
291                 Paper_score::set_breaking(const Array<Column_x_positions>&) [p-score.cc:
292         150]
293                 Paper_score::calc_breaking() [p-score.cc:189]
294                 Paper_score::process() [p-score.cc:203]
295                 Score::run_translator(Music_output_def*) [score.cc:117]
296           * Reading 4 bytes from 0x65d3a0 in the heap.
297           * Address 0x65d3a0 is 160 bytes into a freed  block at 0x65d300 of 208 bytes.
298           * This block was allocated from:
299                 malloc         [rtlib.o]
300                 __builtin_new  [libgcc.a]
301                 Span_score_bar::clone()const [span-score-bar.hh:20]
302                 Item::copy_breakable_items() [item.cc:69]
303                 Item::do_breakable_col_processing() [item.cc:89]
304                 Score_element::calcalute_dependencies(int,int,void(Score_element::*)()*)
305          [score-elem.cc:171]
306           * There have been 22 frees since this block was freed from:
307                 free           [rtlib.o]
308                 __builtin_delete [libgcc.a]
309                 Span_score_bar::~Span_score_bar() [span-score-bar.hh:18]
310                 Paper_score::set_breaking(const Array<Column_x_positions>&) [p-score.cc:
311         156]
312                 Paper_score::calc_breaking() [p-score.cc:189]
313                 Paper_score::process() [p-score.cc:203]
314         Postprocessing elements... 
315         TeX output to score-bar-scripts.tex...
318 3RD PARTY BUGS:
320         * redhat (v?) graphical install bomb-out?
322         * egcs-1.03 ice: stem.cc:327; should localize bug (mine's still 10K)
324         * gcc 2.8.1: see ice and RESIZE_ICE
326         * xdvi: PS in magnifying glass.
328         * GNU diff 2.7: diff -rN does not see a new directory with empty file
330         * GNU patch 2.1: <must find simple example> if patch chokes on a
331           hunk, or on allegedly unsorted hunks in a diff, it may stop 
332           without a trace of failure (create .rej file, print error or 
333           dump core) and just ignore any further diffs.
335         * glibc 2.0:
337           f = fopen ("/dev/null", "r")
338           assert (feof (f))
340 3RD PARTY PROJECTS:
342         * GNU indent: handle C++
344         * GNU make: move hardcoded builtin rules to runtime ?
346         * GNU patch 
347           - 'double-fix' mode: ignore identical fix, rather than suggest 
348             to revert patch direction when (more or less? exactly) the same 
349             thing is fixed
351 PROJECTS
353         * Scripts:
354         - fix position of bar number
355         - stack scripts in chords:
356           % fingering:        footing:
357             < a-4 c-2 g-1 >   < c-\ltoe e-\lheel >
358         - script-spacing
359         - slur parts as a script
360         - stack parameterised scripts for fingering and footing:
362         * convert-mudela:
363         - automatically add  a \version if not present.
364         - better parsing
365         - make smarter
366         - convert-mudela -e empty.ly
368         * emacs mudela-mode
369         -  should handle block comments too.
370         -  handle lexer modes (\header, \melodic, \lyric) etc.
371         -  indentation
372         -  notenames?
373         -  fontlock: \melodic \melodic
376         * use properties for:
377         - plet?
378         - Staff_sym size
379         - default tempo.
380         - font size
381         - bartypes (get rid of derived Span_bar_engravers)
382         - cadenza mode? 
384         * page handling:
385         - PS output
386         - optimal pagebreaking.
388         * Unicode support? -> man 7 unicode
389         - 16 bit Strings
390         - -u switch
391         - detect of 16/8 bit files
392         - examples to go with it.
394         * Spring_spacer:
395         - write a faster Spring_spacer (without matrices if possible)
396         - use straight LP to find minimal "fitting force"
397         - relate energybound to linelen unitspace fontsize etc.
398         - used fixed point fp
400         * \header
401         - output header info to MIDI too.
403         * a musical dictionary. See Documentation/vocabulary-*, other
404         languages:
405         - explanations
406         - italian
407         - german
408         - dutch
409         - swedish
410          .. ?
412         * chords
413         - guitar chords
414         - chord names
415         - basso continuo
416         - Syntax/parser
417         - MIDI output?
418         - typesetting
420         * Debug logs:
421         - derive lily_stream, Dstream, texstream from ostream?
422         - indentable stream as baseclass for TeX stream, lily stream, Dstream.
423         - use dstream feature in mi2mu
424         - integrate IO checking into stream class
426         * input converters
427         - NIFF?
428         - ABC? 
429         - SMDL?
431         * add to MIDI output:
432         - tempo change
433         - ornaments (and trills?)
434         - repeat
435         - slurs
436         - accents
437         - dynamics
438         - account for rhythmic position in measure
439         - etc.
441         * grace notes
442         - make separate class for Grace_*_engravers 
443         (which is at Voice_gravs level)
444         - make encapsulated spacing problems.
446         * accidentals per Voice_group
448         * Output class, handles : (smallish)
449         - help text /(c) notice?
450         - version line
451         - warning /errors/progress
452         - abort on error/warning; exit status
453         - quiet/ignore-version options
454         - logfile output
456         * piano staff
458         * elaborate Staff_side baseclass:
459         - scripts
460         - text
461         - slur start/end
463         * PS 
464         - speed up PS code.
465         - PS lines to .eps files
466         - write custom prolog
469         * Output an output format independent (ofi) typeset file; and 
470           make ofi2 TeX, MusiXTex, Display PostScript, PostScript,
471           Ascii... interpreters. (difficult)
473         - NIFF ?
474         - Common Music Notation
475         - PostScript output (esp. Beams, Slurs, etc)
476         - Move all Score_elems, into libmutype.a
477         - SGML
480         * Documentation
481         - Doc (C) stuff of sheet music
482         - a better format?  SGML?  TeX?  Info?
483         - a tutorial
485         * more spanners (smallish)
486         - Glissando
487         - trill
489         * Rewrite Stem, Beam and Rhythmic_grouping (hairy)
490         - [c8. c32 c32]
491         - doc on Rhythmic_grouping
492         - general shaving on Beam and Stem
493         - use plet grouping
494         - separate visual from rhythmic info even more
495         - beams over bars
496         - endbeam req should be *after* the duration, so you can do
497         < { [c4]    }
498           { c8. c16 } >
501         * lines:
502         - Ledger lines, should be separate item: Ledger_lines, Ledger_lines
503         - set different line sizes / thicknesses
504         - beam stem showthrough, inter beam sizes (french vs german style)
506         * Collisions
507         - left/right note balls should be handled by Collision:
508         < \multi 2; { \stem 1; <b c> } { <f as b> } >
510         * Keys:
511         - merge key{item} & localkey{item}?
512         - Major/Minor
513         - spacing, national styles?
515         * Support for TAB
516         - redo Notehead to allow digits as heads
517         - add a \tablature {} lexer mode for easy entering
519         * should adjust stemlength for flag number.
521         * breaking:
522         - caching breakpoints
523         - saving them
524         - specify number of lines
526         * markers
528 INPUTLANGUAGE
530         * c4 4 4 4 for c4 c4 c4 c4?
532         * neatly (and readably) expressing concurrent
533         voices
535         * <c f a>4 ?
537         * Viola mode?
539                 @c c g e g 
540         for
541                 c g es g, 
543                 @A c g e g
544         for
545                 cis gis e gis
547         * relative mode for pitch entering
549         * bracket: volta 1,2
551         * configure pitch_byte
553         * rest name configurable
555 SMALLISH PROJECTS
557         * limit memory usage; the full coriolan takes up too much resources.
559         * fix confusing naming in Engraver vs Engraver_group_engraver (context)
561         * progress when creating MIDI elts.
563         * A range for context errors (eg. mark both { and }. )
565         * lyric in staff  (sharpsharp in staff, text below)
567         * half sharps/flats
569         * write Dynamic_line (to group dynamics horizontally)
571         * use Real for all y positions.
572         - use translate_axis( .. ,Y_AXIS)  iso separate variables.
574         * half-sharps, half-flats
576         * adaptive accidental spacing.
578         * handle EOF graciously in error messages.
580         * centered whole rest
582         * declare notenametab?
584         * midi esp.: use I32 iso int where 32 bits are needed (or assumed...)
586         * Flower types:
587         - A decent scalar type
588         - String hash
589         - Pointer hash
591         * binsearch/hash for identifiers
593         * stafftypes: voice names/ instrument names.
595         * lily \tempo
597         * C meter iso 4/4, idem for alla breve, etc.
599         * textspanner: center position
601         *   % toe to bheel   four to five
602             %   ^_u            4_5  
603             %     -                           
604             %  --|x--         --|x--
605             %  --|---         --|---
606             %  --|---         --|---
607           (where "to" is a tiny bow)
609         * auxilliary file for caching info.
611         * Text_crescendo
613         * clean solution for staffsize in items.
615         * revise calcideal
617         * volta
619 IDEAS
622         * Output data structures of Mudela in XML/SGML.
624         * create libmudela, or liblily_frontend
626         * move MIDI stuff (including Quantization) to a ANSI C libmidi library.
628         * use an embedded language: Python, Scheme
629         for: 
630                 - Score_elems
631                 - Translators
633         * y -dims in internote? Staff-space? X-dimensions?
635         * Spacing_request for manually adjusting spacing
637         * caching breakpoints
639         * breath marks 
641         * used fixedpoint arithmetic for min. energy.
643         * move towards incremental algorithms.
645         * far fetched language ideas
646         - design meta-language like TeX and Metafont
647         - programming/macros input
649         * versioning stuff (cvt mudela, mudela, etc.)
651         * Klavarskribo?
653         * lyrics in chords still fuck up.
655         * Use hooks/dependency graphs for properties