Updated TODO.
[ahxm.git] / TODO
blobde0644e218021dc3e68d298dae0c48f5c5746b09
1 Ann Hell Ex Machina TODO / Bug List
2 ===================================
4 Release Critical Bugs
5 ---------------------
7  * 1017: mp_doccer documentation is severely outdated.
8  * 1022: Add file name to compiler errors.
9  * 1030: Refactorize the output system to always use a forked process.
10  * 1032: Refactorize input, ss_gen and ss_ins to always use pointers to
11    struct ss_wave instead of copies of them.
12  * 1040: Get rid of all _ prefixed symbols.
13  * 1041: Get rid of CHANNELS and always use dynamic structures or buffers.
14  * 1042: Add multiple MIDI devices; a configuration file will match device
15    numbers to real addresses in /dev. Then each track in the song file could
16    have a command to set which MIDI device will the events be sent to.
17  * 1043: The same as the multiple MIDI devices, there should exist multiple
18    dsp devices. This way, a unique computer with more than one sound card
19    can output multichannel songs at a time.
20  * 1045: Line numbers in compiler errors are incorrectly reported when
21    inserting a block at the end of the line; when the block is inserted,
22    the linefeed has already been read and yyline incremented. This probably
23    occurs also with other directives.
24  * 1048: ss_wave must be dynamic.
25  * 1050: New ss_ins is flawed; volumes are never used.
27 Open Bugs
28 ---------
30  * 1034: tempo_from_wave() will never work; when the wave is loaded, it's
31    too late for the tempo to be set, as the ss_song stream has no tempo
32    information. The only solution is to just print the optimal tempo, for
33    the ahxm programmer to change it manually.
34  * 1046: When a compilation error occurs inside a named block, the reported
35    line number is the one where the insertion occurs, not the one where the
36    block is defined.
38 Pending Enhancements
39 --------------------
41  * 1002: Build an audio filtering tool to test effects.
42  * 1003: There should exist 'some kind' of effect for note volumes
43    to add a random variation, to add 'humanity'. This cannot
44    be a standard digital effect as it should be different
45    for each note.
46  * 1005: Vibrato should be variable (from 'no-vibrato' to 'some-vibrato'
47    in the same note).
48  * 1006: A 'choose' option, to take randomly one block or another
49    (blocks seem appropriate, but further study is necessary). A random
50    seed script command is also necessary.
51  * 1007: Support for 'tonalities'; fixed transpositions for each note of
52    the octave so that, for example, a 'f' is always a 'f#'.
53  * 1008: Support for 'keyboard splits': ranges of notes that a track will
54    ignore. This should allow to have multiple tracks playing the same
55    notes but with different channel maps and, for example, having a
56    guitar glissando pan from left to right.
57  * 1010: Loop stretching ('stretch wave without pitch change to last
58    exactly N time units').
59  * 1011: Loop matching ('change wave pitch to last exactly N time units').
60  * 1020: When a source file includes multiple songs, there should exist a
61    way to mark song / track changes. This should be used to include text
62    messages as ID3 tags or even to generate .cue / .toc files.
64 Closed
65 ------
67  * 1000: Convert current event queue to two event queues. The first
68    stage queue should store notes and the second note on / note off
69    events (Tue, 17 Aug 2004 12:00:00 +0200).
70  * 1004: Vibrato for generators (Fri, 13 Aug 2004 11:05:00 +0200).
71  * 1009: Set tempo from a sample loop ('set tempo so that this wave
72    will match exactly one/N measures') (Fri, 16 Aug 2004 18:08:00 +0200).
73  * 1013: Volume should be a command ('v', for example) and not be
74    inherited from previous notes. There should also be settable as
75    relative inc/decrements (as octaves) (Mon, 30 Aug 2004 14:37:59 +0200).
76  * 1014: doc/language.txt is severely outdated
77    (Mon, 30 Aug 2004 15:13:00 +0200)
78  * 1015: Upgrade build system (new config.sh, makefile.in, etc.).
79    (Thu, 09 Sep 2004 18:56:29 +0200).
80  * 1016: Integrate the new compiler (Sun, 12 Sep 2004 16:13:11 +0200).
81  * 1001: Generator should use queues of active / free generators.
82    (Sun, 17 Oct 2004 12:50:10 +0200).
83  * 1012: Portamento should not have a 'time', only a frequency
84    inc/decrement per time unit (Sun, 17 Oct 2004 13:18:04 +0200).
85  * 1018: The 'default' driver should not be bound to the first usable
86    one, but be a sequential try of all available drivers
87    (Thu, 11 Nov 2004 12:18:12 +0100).
88  * 1019: Add libartsc support (Thu, 11 Nov 2004 12:30:02 +0100).
89  * 1023: The SS_FRAMES lex/yacc token should be SS_MSECS, that is,
90    the compiler should not use frames but milliseconds
91    (Tue, 19 Apr 2005 20:05:46 +0200).
92  * 1024: The 'event1' and 'event2' stuff is ugly. It should be called,
93    respectively, 'note stream' (as it's, more or less, device independent)
94    and 'ss stream', which depends of softsynth, frames and such. In the
95    future, there could exist a 'midi stream' if MIDI output is supported
96    (Closed by #1025; Wed, 20 Apr 2005 17:30:31 +0200).
97  * 1033: SONG_EV_SS_NOTE won't work, because freq can't be calculated
98    on compilation time; instead, it should be a generic message
99    (Sat, 23 Apr 2005 10:52:35 +0200).
100  * 1026: Get rid of event.c and event.h (Sat, 23 Apr 2005 12:28:47 +0200).
101  * 1027: Get rid of effect.c and effect.h (Sat, 23 Apr 2005 12:28:51 +0200).
102  * 1031: Add lex/yacc code for processing absolute notes (A1, C#4, F&3)
103    (Sat, 23 Apr 2005 16:14:21 +0200).
104  * 1036: Unify song event types; ss_song should use the same event types
105    (Sun, 24 Apr 2005 10:29:22 +0200).
106  * 1035: The number of compiled tracks should be available somewhere
107    (Sun, 24 Apr 2005 10:35:19 +0200).
108  * 1037: ss_ins_frame() is flawed; as it directly mixes into frame[],
109    each intrument's ss effects affect the previous ones
110    (Mon, 25 Apr 2005 16:42:28 +0200).
111  * 1025: 'event1' has been moved to song.c (generic song event stream)
112    and 'event2' has been moved to ss_song.c (softsynth song event stream),
113    but due to almost all of ss_song.c being private, there is no way to
114    order the instruments and the effects to do anything until a way of
115    storing them is decided. So, project state is really critical now as
116    nothing works (last working version was 'cvs update -D 20050419').
117    (Mon, 25 Apr 2005 18:16:48 +0200).
118  * 1039: Volumes can't be set as integer numbers (0 and 1 should be valid)
119    (Mon, 25 Apr 2005 18:26:06 +0200).
120  * 1038: Comments can't be written inside extended commands
121    (Mon, 25 Apr 2005 18:31:55 +0200).
122  * 1021: Add line number to compiler errors (Mon, 25 Apr 2005 19:11:01 +0200).
123  * 1028: input.c should be ss_input.c (Wed, 27 Apr 2005 08:08:49 +0200).
124  * 1029: output.c should be ss_output.c (Wed, 27 Apr 2005 16:59:34 +0200).
125  * 1044: Line numbers in compiler errors don't work if the error is inside
126    a block or after inserting one
127    (Closed by #1045; Sun, 08 May 2005 10:22:43 +0200).
128  * 1047: Change generators to use just one volume and not a channel map
129    (Mon, 09 May 2005 16:24:13 +0200).
130  * 1049: Since the closing of #1047, the channel map in ss_ins is
131    completely broken (Tue, 10 May 2005 18:27:28 +0200).
133 Email bugs to angel@triptico.com