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