more echo params, doc updates and more - alex
[terminatorX.git] / ChangeLog
1 terminatorX - ChangeLog
2 All changes were done by me (Alexander König) if not stated otherwise.
3 This is not a GNU-style ChangeLog but you sort of get the idea what was
4 changed.
5
6 [v3.71]
7 - applied a big patch from Adrian Reber (adrian@lisas.de). This patch includes:
8   o compile fixes for the newer gcc releases
9   o enhancements to the commandline switches (try --help for more details)
10   o bug fixes for tX_global.c
11 - the bigNewThang (TM) is STEREO output. The Pan-Buttons now actually do what
12   you'd expect them to. Therefore your soundcard must have stereo support of
13   course but I guess in 2001 this really shouldn't be a problem, right? 
14   The recorded wavfiles will now be stereo wavfiles of course.
15   Note that stereo output means double audio-bandwith, so if you tuned your
16   old terminatorX setup to smallest latency you might get clicks now. You can
17   easily fix this by increasing the buffer size in the options dialog by one - 
18   this will result in the same latency as before btw.
19 - The echo effect has undergone some enhancements to profit from the new stereo
20   output. It's signal will now be mixed seperately so you can choose a different
21   stereo panorama position for the echo signal. So the new echo effect now 
22   features it's own PAN-knob. This does have some sideeffects though, for more
23   details on this check the manual.
24   Additionally the echo effect now has it's own volume setting to influence
25   the dry/wet ratio of this effect.
26 - Some LADSPA effects tend to create NAN (Not A Number) float values under
27   certain conditions. This is bad as all following operations will result in 
28   NANs, so there will be no audio output no more. Now I will not introduce code
29   to check for NANs as this is a waste of CPU-power, producing NANs is IMHO
30   a faulty behaviour for LADSPA plugins and it should be fixed in there.
31   Now a problem with the previous release was that the echo and lowpass effects
32   "ate" those NANs resulting in NANs in those effects' buffers. So once a NAN
33   got in there these effects caused the whole audio output to mute (forever). 
34   Which is why I now introduced some code to clear the buffers in echo and
35   lowpass whenever you dis- and reenable them.
36 - The GUI does have two master vu-meters now. The turntable's still have one
37   vu-meter only. Note that the echo-signal is *not* included in the turntable's
38   vu-meter now, as it's mixed seperately.
39 - The 3DNow!-Optimizations are gone. And they'll proabably never come back as
40   I don't have time to maintain the same algorithm twice.
41 - The documentation has been updated to meet the new features. A lot of typos
42   have been fixed as well.
43
44 [v3.70]
45 - this list may be incomplete
46 - This release brings support for LADSPA plugins. These plugins can be inserted
47   into any turntable's effect chain at any position. You can edit the the
48   effect sequence with the two tiny blue arrows. The builtin effects reside in
49   the same effect chain as LADSPA plugins, but unlike LADSPA plugins they cannot
50   be removed (nor multi-instanciated).
51   The LADSPA plugins have to "fit" into the effect chain, which is why
52   terminatorX supports *mono* plugins (plugins that have one audio-in and one
53   audio-out port) only. For the plugin's control ports, termintatorX supports
54   all HINTS except for LADSPA_HINT_LOGARITHMIC. Some control ports might be 
55   hard to handle as LAPDSA control ports can have very wide value ranges. It is
56   possible to enter precise values though.
57   Get LADSPA and the CMT plugins from http://www.ladspa.org
58   All parameters for LADSPA-plugins are "sequencable parameters", so you can
59   record parameter-change events for the plugin's knobs just as for the
60   standard parameters.
61 - GUI re-design to support dynamic plugin GUIs. The audiofile-display is now 
62   seperated from the turntable's controls. The groups are split in to panels
63   which can be minimized if not required (orange arrow). The panels'
64   minimized-status will be saved within the set files.
65   To add a plugin effect into the turntables effect chain click on the "FX"-
66   button and choose the plugin of your choice. To get more info on the
67   plugin effects click on their panel's label.
68   NOTE: The panning-control is not working yet. It'll work as soon as stereo
69   is done.
70 - As always when introducing something new, the set-file file-format has
71   changed.
72 - The parameter-to-mouse-axis mapping has been moved from hardcoded to
73   dynamic. You can now map any parameter that's considered "mappable" to the
74   mouse-axis of your choice (for each turntable separately). This is true
75   for the control ports of LADSPA-plugins, too.
76 - Josh Steiner <joschi@eds.org> has joined terminatorX development. For this 
77   release he has added some startup parameters for terminatorX, some of them
78   aiming for future MIDI support, and therefor not functional yet. Run
79   "terminatorX --help" to get more details.
80 - I know write the "manual" in SGML with the DocBook DTD. The distribution
81   contains the HTML and the postscript version. These transformation have been
82   created using James Clark's jade (DSSSL-processor) and Norman Walsh's DSSSL
83   stylesheets for DocBook.
84 - Removed obsolete "number of vtts"-option from the options dialog.
85 - Applied a patch from Josh that fixes running the soundfile editor for files
86   including a blank in their filename.
87 - New tooltips for the complete GUI.
88
89 [v3.61] (unreleased)
90 - applied a tiny patch from Atsushi Yamagata <yamagata@plathome.co.jp>
91   to set locale on startup.
92
93 [v3.60]
94 - terminatorX has a sequencer now. Warning: with the current design the
95   sequencer will correctly play back recorded events only when the buffer size
96   (of the audio device) is set to the same size as it was when recording the
97   events. I know this is annoying and I will try to find a solution to this. 
98   Please take a look at the README to find out how the sequencer works.
99 - fixed a bug causing the lowpass filter produce a constant signal
100 - fixed the load file / drag'n'drop segfault bug
101 - fixed the prelisten zombie processes bug
102 - fixed the segfault on termination bug (with the audio engine running)
103 - hacked the mixer code to use 3DNow! too. This improves 3DNow! performance gain
104   from previously ~6% to more than 20% (depending on compiler optimizations)
105 - extended the set-file-format to allow storing of sequencer events. This
106   release allows loading old tX-sets too.
107 - some gui icons. Choose Text/Icon / Icon only / Text only display of these
108   icons in the Options dialog. You'll have to restart tX to see the changes
109   though.
110 - "soundfile-editor support": Enter the soundfile-editor of your choice in the
111   tX-Options dialog (Still looking for an editor? Checkout Dave's Linux
112   Sound and MIDI Pages: http://www.bright.net/~dlphilp/linuxsound/).
113   Click the edit button in the Main-Panel to start your editor with the
114   turntable's soundfile - edit ;) - save and click the reload button.
115 - big endian bug fixes by Scott C. Knight <scknight@indiana.edu>
116 - --enable-benchmark will now produce a benchmark binary. This takes a set file
117   as a parameter (that set file should autotrigger all tables, else the
118   benchmark will measure how fast tX can generate zeros ;) WARNING: the
119   benchmark binary is not a usable terminatorX binary.
120 - a new dial-widget. I created this for the upcoming GUI-redesign - and decided
121   I let you debug it right now ;) If you don't want it run configure with the
122   --disable-dial switch.
123 - some gui redesign. The volume scales are now located near their corresponding
124   "flash"-widget. This release fits into very small windows - so it should be
125   usable on smaller displays as well.
126 - Adrian told me configure doesn´t have to check for glib after checking for
127   gtk+ - I guess he´s right so the glib-test has gone.
128 - more minor fixes
129   
130 [v3.55]
131 - implemented "sequenceable parameters" (see tX_seqpar.*). This means the
132   groundwork for the sequencer is done. Although this release does not yet
133   feature a sequencer - there's still a profit: you can now see the GUI (e.g.
134   the lowpass-freq slider) update while you change that value with your mouse in
135   dga grab mode (e.g. up/down with the default X/Y-Control settings).
136 - fixed (libmmx) mmx.h to work with gcc 2.95 and above
137 - fixed compilation problems for big endian machines. still runtime probs
138   reported though.
139 - fixed configure-script as the new bash complains about == in string compares
140 - fixed some gui segfaults
141 - added an ugly GNOME-mimetype installer. This installs the ".tX"-mime type, an
142   terminatorX-application icon and a ".tX"-icon. I could use some hints on how
143   I could make automake install that instead of an extra script.
144   (see README.GNOME)
145 - added Drag'n Drop support. Works with the great gmc. Drop an audio file over 
146   the filename-button or the wavdisplay of a turntable to load it into that
147   table. Drop an audiofile over the "Add Turntable" Button to create a new 
148   turntable and load that file into that turntable. Drop a tX-set file over the
149   "Load Set" button to load the set. 
150
151 [v3.51]
152 - fixes the load_piped() compilation error if you use neither sox nor mpg123.
153   Note that you have no "pre-listening" without mpg123 for mp3s and no 
154   "pre-listening" for any other file without sox.
155
156 [v3.5]
157 - Yet another redesign ;) Oh well this project moved from c++/multithreaded
158   to c++/singlethreaded, to c/multithreaded and now, finally, back to
159   c++/multithreaded. This shows quite some foresight, I'd say ;)
160 - Due to the redesign I had to change a lot (everything?) again so this document
161   can impossibly hold all changes. but let's see:
162 - tX now uses floats instead of doubles for a lot of parameters. Therefore the
163   old .terminatorXrc.bin is now called .terminatorX3rc.bin to allow parallel
164   use of older releases. But you'll have to configure the new release again
165   the first time you run it.
166 - tX now supports an unlimited no of turntables. The only limit is your display
167   really.
168 - Each of these turntables has their own pitch / volume settings and a 
169   dedicated lowpass and echo effect section.
170 - You can now map mouse motion to a function of your choice (scratching/
171   volume/cutoff/echo-feedback and nothing)
172 - Recording will now happen straight to disk. You'll have to specify a filename
173   before you start recording.
174 - You can sync the turntables to one master turntable.
175 - There are two master settings for pitch and volume available to modify all
176   turntables. The turntable pitch is relative to the master pitch.
177 - You can save a complete set (of turntables and settings) to a .tX set file.
178   The audiofile data will *not* be saved within that file, but it'll contain
179   the absolut filename to these files. I know this makes the act of exchanging
180   sets over the net more complex so if somebody wants to code set files with
181   integrated audio data... ;)
182 - The way audiofiles are loaded has been redesigned too: the builtin wav
183   routines, the sox support and mpg123 are no longer connected. This means
184   you can use mpg123 support without sox support and still have the builtin
185   wav routines enabled. If you have the builtin wav reader and sox enabled, tX
186   will try try to use the builtin routines first, and if they fail sox will be
187   used as a fallback which is of course slower as you know... There's some 
188   support for Benno Senoner's brilliant 3.2-mmap() patch but the patch still
189   needs to be ported.
190 - You can now select which parameter to map to a mouse axis.
191 - experimental 3DNow! support (works with gcc < 2.95 only)
192 - tX-windows now have an icon, thanks Michael!
193
194 [v3.2]
195 - implemented 2D-Scratching ;) You can now use the other axis of your mouse
196   two modify the cutoff frequency of the lowpass filter (if enabled). The
197   resonance factor can be set via the slider underneath "LP Filter". Seems
198   to eat quite some CPU power though...
199 - Updated THANKS, AUTHORS
200 - as most people seem to use sox/mpg123 anyway and as I still get "I want mp3"
201   emails I changed the configure script slightly: It now automatically enables
202   the use of sox and mpg123 if these are available. If you still want 'em good
203   old 16Bit/44.1Khz/Mono builtin routines you have to specify --enable-wavonly
204   with your configure cmdline.
205 - Prepared the tarball for the Win32 port. You can now compile tX with cygwin
206   and the Makefile.cygwin in the src directory if you have all the required
207   libs (gtk, pthreads etc...). The resulting exe will run BUT is completely
208   unusable for now... Stou Sandalski <tangui@cell2000.net> and I are planning
209   to make it usable in the future.
210 - The About-Dialog now contains some info on how the binary was compiled
211
212 [v3.1]
213 - Optimized audio-rendering code for speed (might run on some machines
214   with smaller buffsize (-> lower latency) than pre-3.1) - Hey, tX now uses
215   less than 10% CPU (says kpm) with mixing enabled on my i586-200MMX machine!!  
216 - "fixed" stdout-output. Due to the pipe-buffering realtime schratching can
217   not be considered usable for now :(
218 - Added config option --enable-scheduler, which will cause the terminatorX
219   engine-thread to run with FIFO scheduling policy and highest priority. This
220   might enable some machines to use smaller buffsizes. It requries root
221   privileges though - either run terminatorX as root - or make terminatorX
222   suid root WHICH IS A BAD IDEA FOR MULTI-USER SYSTEMS IF OTHER USERS CAN
223   ACCESS THE BINARY ;) You only have to think about this when you experience
224   buffer underruns with your desired latency. And it might not even help...
225 - Rehacked the de-clicking (fading) code. The old one tried to be much more
226   intelligent - and failed fading out the signal sometimes. The new code
227   is much simpler (faster) and is much more reliable.
228 - added common sense to the warp feature (f-key in scratch mode). The warping
229   speed is still connected to the mouse speed but it's now adjusted to the
230   sample size as well: you can warp through any sample completely with the same
231   mouse distance.
232 - added debug configure switch. Enables (very few) debug messages for now. I
233   decided not to enable the old V2.X messages as they are sent to stdout, which
234   would sound pretty strange to people who use the stdout-option.
235     
236 [v3.02] (unreleased)
237 - Fixed Adrian's name in the THANKS file. Sorry, Adrian.
238 - Corrected Makefile.am for license.c that did not build correctly on some 
239   systems - Thanks to Michael Pruett <mikep@ugcs.caltech.edu>
240
241 [v3.01]
242 - fixed a bug that caused terminatorX to crash without --enable-sox or
243   mpg123input.
244
245 [v3.0]
246 - Changed everything ;)
247 - switched from C++ to C for gtk's sake
248 - switched back two multithreading
249 - implemented new gtk+ gui and dialogs
250 - new mouse-sampling code now uses DGA's DirectMouse
251 - implemented "initalizing"-support for XInput devices.
252 - new (alpha) "pre-listening" feature in scratch/loop dialogs
253 - hacked vtt for click-free audio. Might be problematic with big
254   kernel level buffersizes but scratching with big buffsize is no
255   fun anyway.
256 - options are now stored in ~/.terminatorXrc.bin automatically (on exit)
257   as well as windowsize and the last used filenames
258 - terminatorX now comes with a configure script - no more Makefile hacking
259   required (nor a good idea ;) )
260 - new wavdisplay-widget update frequency is now configureable
261 - new position-display is much more visible which allows more precise
262   scratching
263 - new mute-feature allows you to silence the scratch-playback completely
264   while the loop keeps playing (press either <m>-key or right mouse-button.
265 - support for mouse buttons:
266   o 1. (left) button: same as <SPACE>, do scratch
267   o 2. (right) button: mute scratch
268   o 3. (middle) button: stop
269 - wrote support for sox and mpg123. This enables terminatorX to read close
270   to any audiofile. You need to have sox and mp3 and this feature (as it is
271   still alpha) needs to be enabled via configure-switches see INSTALL
272 - licmak now is an awk script. Thanks Christian! I was also received two perl
273   scripts (Thanks, guys!) but I now use the awk script as it is the smallest.
274 - introduced <F>-key to "warp" through scratch-sample (just check it out)
275 - dropped commandline arguments
276 - dropped old X-Code + Mouse warping madness
277 - bug fixes (less than bug introduces though ;) )
278
279
280 [v2.4] (unreleased)
281 - implemented a time counter
282 - licmak now finally is what it should be: a perl script (licmak.pl)
283   it was contributed by: Adam Sjøgren <asjo@diku.dk>. Thanks!
284
285 [v2.3]
286 - X-Window background fixed
287 - wavfile overreading fixed by Andrew C. Bul+hac?k (acb@zikzak.net)
288 - Using portable type definitions now where required. If you don't
289   have a <sys/types.h> on your system and your machines type sizes
290   equal those of an X86-machine you can specify -DUSE_X86_TYPES in
291   Makefile to compile without <sys/types.h>
292 - Slight change in audiodevice-handling that fixes improper buffsize
293   settings on some soundcards (e.g. GUS)
294 - Implemented "keep device open"-feature. Needs to be enabled via the
295   -DKEEP_DEV_OPEN switch in Makefile
296 - Added some comments to the Makefile for easier editing
297 - Added Big Endian support. Use -DBIG_ENDIAN_MACHINE for big endian hosts
298   like ultrapenguin suns or linux ppc. There's also -DBIG_ENDIAN_AUDIO
299   for big endian audio hardware (rare?) available, although proabably
300   nobody will need this.
301 - Changed mix behaviour: Mix is now automatically turned on on startup if
302   the user has specified a proper loop file. (with the --loop or -l switch)
303 - New mixing routine. You can now set the loop to scratch volume ratio with
304   the cursor keys (left/right). If you modify the volumes while recording
305   these action's will not be recorded. Saving happens with the currently
306   set level.
307 - Fixed README-Bug said <m> instead of <x>
308   
309 [v2.2]
310 - first released version
311 - added colors. more standard use of X11.
312 - added loop support.
313 - added statusbar with mode/status display
314 - added commandline options and help (on usage and keys)
315 - added raw/mixed save scratch feature
316 - added licmak to include license into binary
317 - new handling of XAutoRepeat, only turned off now when SPACE pressed.
318 - modified wave display (faster + nicer + incorrect (who cares anyway))
319 - Makefile fixed by Adrian Reber (adreit00@fht-esslingen.de)
320 - bug fixes
321
322 [prerelease]
323
324 [v2.1]
325 - added recording, playback of recording functionality
326
327 [v2.0]
328 - moved from multithreaded to singlethreaded
329 - position feedback
330 - bug fixes
331
332 [v1.0]
333 - mouse support
334 - no more position display due to pthread/X probs
335 - bug fixes
336
337 [v0.5]
338 - first version
339 - no mouse handling
340 - accelerating vtt via sinus
341 - multithreaded
342 - sound aliasing