Fix build with gcc 4.7
[cadence.git] / README
blob9488c2984095d69073221e121a1214b224b17477
1 -------------------------
2 -  README for Cadence  -
3 -----------------------
5 Cadence is a set of tools useful for audio production.
6 It's being developed by falkTX, using Python and Qt (and some C++ when needed).
8 The tools share the same base source code, so most of them look quite similar (which is intentional).
10 The basic modules are:
11   jack_logs -> Show JACK, A2J, LASH and LADISH logs (just like the 'ladilog' app)
12   jack_render -> Record a JACK project using jack-capture, controlled by JACK Transport; supports realtime and freewheel mode
13   jack_settings -> Configure JACK (requires jackdbus, either JACK1+DBus patch or JACK2)
15 Also, lots of custom widgets were coded when needed (like pixmapdial, pixmapkeyboard, patchcanvas and systray).
16 They can be re-used in other projects. Contact the author if you need help on that.
18 Note that the main focus goes to JACK2 (or JACK1+DBus); JACK1 (raw) and tschack are untested and may not work properly at this point.
21 ===== DESCRIPTIONS =====
22 Here's a brief description of the main tools:
24 ---> Cadence
25 The main app. It performs system checks, manages JACK, calls other tools and make system tweaks.
26 Although this is the main app, it's the one that needs more work, so don't expect it to do much right now.
28 ---> Catarina
29 A Patchbay test app.
30 Created while the patchcanvas module was being developed, it allows the user to experiment with the patchbay, without using JACK or LADISH.
31 You can save & load patchbay configurations too. Not sure how much useful this app is now though...
33 ---> Catia
34 JACK Patchbay, with some neat features like A2J bridge support and JACK Transport.
35 It's supposed to be as simple as possible (there's Claudia for advanced things), so it can work nicely on Windows and Mac too.
37 ---> Claudia
38 LADISH frontend; just like Catia, but focused at session management through LADISH.
39 It has a bit more features than the official LADISH GUI, with a pretty preview of the main canvas in the bottom-left.
40 It also implements the 'Klaudia' add-application style when using 'Klaudia' database mode.
42 ---> Carla
43 Multi-plugin host for JACK.
44 It has some nice features like automation of parameters via MIDI CCs (and send control outputs back to MIDI too) and full OSC control.
45 Currently supports LADSPA (including LRDF), DSSI, LV2, native and Windows VST.
46 This application is under heavy development and may change/break at anytime.
48 ---> Carla Control
49 An OSC Control GUI for Carla.
50 You get the OSC address from the Carla's about dialog, and connect to it.
51 Supports controlling main UI components (Dry/Wet, Vol and Balance), and all plugins parameters.
52 Peak values and control outputs are displayed as well.
53 Custom Plugin GUIs are not supported for obvious reasons...
55 ---> [JACK] XY-Controller
56 Simple XY widget that sends and receives data from Jack MIDI.
57 It can send data through specific channels and has a MIDI Keyboard too.
58 This is more of a concept of my jacklib python module usage then anything else. May not work properly under very low JACK buffer sizes.