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