More README/INSTALL updates
This commit is contained in:
falkTX
parent
7d32613fa6
commit
b860d56705
79
INSTALL
79
INSTALL
|
|
@ -1,79 +0,0 @@
|
|||
--------------------------
|
||||
- INSTALL for Cadence -
|
||||
------------------------
|
||||
|
||||
To install Cadence and its tools, simply run as usual:
|
||||
$ make
|
||||
$ [sudo] make install
|
||||
|
||||
You can also run the tools without installing them, by using instead:
|
||||
$ make
|
||||
$ python3 src/<tool>.py
|
||||
(Replace '<tool>' by a proper name, in lowercase. Some distros may need to use 'python' here)
|
||||
|
||||
Packagers can make use of the 'PREFIX' and 'DESTDIR' variable during install, like this:
|
||||
$ make install PREFIX=/usr DESTDIR=./test-dir
|
||||
|
||||
|
||||
===== [BUILD] DEPENDENCIES =====
|
||||
The required build dependencies are: [devel packages of these]
|
||||
- JACK
|
||||
- liblo
|
||||
- Gtk2
|
||||
- Qt4
|
||||
- PyQt4
|
||||
|
||||
Optional but recommended:
|
||||
- FluidSynth
|
||||
- LinuxSampler
|
||||
|
||||
On Debian and Ubuntu, use this command to install all dependencies:
|
||||
$ sudo apt-get install libjack-dev liblo-dev libgtk2.0-dev libqt4-dev qt4-dev-tools python-qt4-dev pyqt4-dev-tools libfluidsynth-dev
|
||||
(NOTE: linuxsampler is not packaged in either Debian or Ubuntu, but it's available in KXStudio)
|
||||
|
||||
To run all the apps/tools, you'll additionally need:
|
||||
- python3-dbus
|
||||
- python3-liblo
|
||||
- python3-rdflib
|
||||
|
||||
Optional but recommended:
|
||||
- a2jmidid
|
||||
- jack-capture
|
||||
|
||||
The 'Cadence' and 'Catia' apps rely on a jackdbus version to work properly (either JACK2 or JACK1 + DBus patch).
|
||||
Claudia is a LADISH frontend, so it will obviously require LADISH to run.
|
||||
|
||||
The python version used is python3.
|
||||
After install, the app/tools will still work on distros with python2 as default, without any additional work.
|
||||
|
||||
|
||||
===== [RUNTIME] DEPENDENCIES =====
|
||||
All tools require Python3 and Qt4, some of them work on Windows and Mac.
|
||||
Here's the required run-time dependencies of each of the main tools:
|
||||
|
||||
---> Cadence
|
||||
Recommends a2jmidid and jackdbus
|
||||
Suggests pulseaudio
|
||||
|
||||
---> Catarina
|
||||
No special requirements
|
||||
|
||||
---> Catia
|
||||
Recommends a2jmidid and jackdbus
|
||||
|
||||
---> Claudia [Linux only]
|
||||
Requires jackdbus and ladish
|
||||
Recommends a2jmidid
|
||||
|
||||
---> Carla
|
||||
Requires liblo and Gtk2
|
||||
Recommends python3-rdflib (for LADSPA RDF support)
|
||||
|
||||
---> Carla-Control
|
||||
Requires python3-liblo
|
||||
|
||||
---> JACK-Meter
|
||||
No special requirements
|
||||
|
||||
---> XY-Controller
|
||||
No special requirements
|
||||
|
|
@ -0,0 +1,95 @@
|
|||
# --- INSTALL for Cadence ---
|
||||
|
||||
To install Cadence and its tools, simply run as usual: <br/>
|
||||
`$ make` <br/>
|
||||
`$ [sudo] make install`
|
||||
|
||||
You can also run the tools without installing them, by using instead: <br/>
|
||||
<i>(Replace '<tool>' by a proper name, in lowercase. Some distros may need to use 'python' here)</i> <br/>
|
||||
`$ make` <br/>
|
||||
`$ python3 src/<tool>.py`
|
||||
|
||||
Packagers can make use of the 'PREFIX' and 'DESTDIR' variable during install, like this: <br/>
|
||||
`$ make install PREFIX=/usr DESTDIR=./test-dir`
|
||||
|
||||
<br/>
|
||||
|
||||
===== BUILD DEPENDENCIES =====
|
||||
--------------------------------
|
||||
The required build dependencies are: <i>(devel packages of these)</i>
|
||||
|
||||
- JACK
|
||||
- liblo
|
||||
- Gtk2
|
||||
- Qt4
|
||||
- PyQt4
|
||||
|
||||
Optional but recommended:
|
||||
|
||||
- FluidSynth
|
||||
- LinuxSampler
|
||||
|
||||
On Debian and Ubuntu, use this command to install all dependencies: <br/>
|
||||
`$ sudo apt-get install libjack-dev liblo-dev libgtk2.0-dev libqt4-dev qt4-dev-tools python-qt4-dev pyqt4-dev-tools libfluidsynth-dev`
|
||||
|
||||
NOTE: linuxsampler is not packaged in either Debian or Ubuntu, but it's available in KXStudio. <br/>
|
||||
<br/>
|
||||
|
||||
To run all the apps/tools, you'll additionally need:
|
||||
|
||||
- python3-dbus
|
||||
- python3-liblo
|
||||
|
||||
Optional but recommended:
|
||||
|
||||
- a2jmidid
|
||||
- jack-capture
|
||||
- python3-rdflib
|
||||
|
||||
The 'Cadence' and 'Catia' apps rely on a jackdbus version to work properly (either JACK2 or JACK1 + DBus patch). <br/>
|
||||
Claudia is a LADISH frontend, so it will obviously require LADISH to run.
|
||||
|
||||
The python version used is python3. <br/>
|
||||
After install, the app/tools will still work on distros with python2 as default, without any additional work.
|
||||
|
||||
<br/>
|
||||
|
||||
===== RUNTIME DEPENDENCIES =====
|
||||
----------------------------------
|
||||
All tools require Python3 and Qt4, some of them work on Windows and Mac. <br/>
|
||||
Here's the required run-time dependencies of each of the main tools:
|
||||
|
||||
### Cadence
|
||||
Recommends a2jmidid and jackdbus <br/>
|
||||
Suggests pulseaudio <br/>
|
||||
<br/>
|
||||
|
||||
### Catarina
|
||||
No special requirements <br/>
|
||||
<br/>
|
||||
|
||||
### Catia
|
||||
Recommends a2jmidid and jackdbus <br/>
|
||||
<br/>
|
||||
|
||||
### Claudia [Linux only] <br/>
|
||||
Requires jackdbus and ladish <br/>
|
||||
Recommends a2jmidid <br/>
|
||||
<br/>
|
||||
|
||||
### Carla
|
||||
Requires liblo and Gtk2 <br/>
|
||||
Recommends python3-rdflib (for LADSPA RDF support) <br/>
|
||||
<br/>
|
||||
|
||||
### Carla-Control
|
||||
Requires python3-liblo <br/>
|
||||
<br/>
|
||||
|
||||
### JACK-Meter
|
||||
No special requirements <br/>
|
||||
<br/>
|
||||
|
||||
### XY-Controller
|
||||
No special requirements <br/>
|
||||
<br/>
|
||||
48
README.md
48
README.md
|
|
@ -1,6 +1,6 @@
|
|||
# --- README for Cadence ---
|
||||
|
||||
Cadence is a set of tools useful for audio production.
|
||||
Cadence is a set of tools useful for audio production. <br/>
|
||||
It's being developed by falkTX, using Python and Qt (and some C++ where needed).
|
||||
|
||||
The tools share the same base source code, so most of them look quite similar (which is intentional).
|
||||
|
|
@ -11,62 +11,60 @@ The basic modules are:
|
|||
- cadence_render -> Record (or 'render') a JACK project using jack-capture, controlled by JACK Transport; supports realtime and freewheel modes.
|
||||
- cadence_jacksettings -> Configure JACK (requires jackdbus, either JACK2 or JACK1 + DBus patch).
|
||||
|
||||
Also, lots of custom widgets were coded when needed (like pixmapdial, pixmapkeyboard, patchcanvas and systray).<br/>
|
||||
Also, lots of custom widgets were coded when needed (like pixmapdial, pixmapkeyboard, patchcanvas and systray). <br/>
|
||||
They can be re-used in other projects. Contact the author if you need help on that.
|
||||
|
||||
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.
|
||||
|
||||
<br/>
|
||||
|
||||
===== DESCRIPTIONS =====
|
||||
------------------------
|
||||
Here's a brief description of the main tools:<br/>
|
||||
<i>(Click on the tool name to open its respective documentation)</i>
|
||||
Here's a brief description of the main tools:
|
||||
|
||||
### [Cadence](http://kxstudio.sourceforge.net/KXStudio:Applications:Cadence)
|
||||
The main app. It performs system checks, manages JACK, calls other tools and make system tweaks.<br/>
|
||||
The main app. It performs system checks, manages JACK, calls other tools and make system tweaks. <br/>
|
||||
Currently under development, may change at anytime.
|
||||
|
||||
### [Catarina](http://kxstudio.sourceforge.net/KXStudio:Applications:Catarina)
|
||||
A Patchbay test app, created while the patchcanvas module was being developed.<br/>
|
||||
It allows the user to experiment with the patchbay, without using ALSA, JACK or LADISH.<br/>
|
||||
A Patchbay test app, created while the patchcanvas module was being developed. <br/>
|
||||
It allows the user to experiment with the patchbay, without using ALSA, JACK or LADISH. <br/>
|
||||
You can save & load patchbay configurations too.
|
||||
|
||||
### [Catia](http://kxstudio.sourceforge.net/KXStudio:Applications:Catia)
|
||||
JACK Patchbay, with some neat features like A2J bridge support and JACK Transport.<br/>
|
||||
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.<br/>
|
||||
JACK Patchbay, with some neat features like A2J bridge support and JACK Transport. <br/>
|
||||
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. <br/>
|
||||
Currently has ALSA-MIDI support in experimental stage (it doesn't automatically refresh the canvas when changes happen externally).
|
||||
|
||||
### [Claudia](http://kxstudio.sourceforge.net/KXStudio:Applications:Claudia)
|
||||
LADISH frontend; just like Catia, but focused at session management through LADISH.<br/>
|
||||
It has a bit more features than the official LADISH GUI, with a pretty preview of the main canvas in the bottom-left.<br/>
|
||||
LADISH frontend; just like Catia, but focused at session management through LADISH. <br/>
|
||||
It has a bit more features than the official LADISH GUI, with a pretty preview of the main canvas in the bottom-left. <br/>
|
||||
It also implements the 'Claudia-Launcher' add-application style.
|
||||
|
||||
### [Claudia-Launcher](#)
|
||||
A multimedia application launcher with LADISH support.<br/>
|
||||
It searches for installed packages (not binaries), and displays the respective content as a launcher.<br/>
|
||||
The content is got through an hardcoded database, created and/or modified to suit the target distribution.<br/>
|
||||
A multimedia application launcher with LADISH support. <br/>
|
||||
It searches for installed packages (not binaries), and displays the respective content as a launcher. <br/>
|
||||
The content is got through an hardcoded database, created and/or modified to suit the target distribution. <br/>
|
||||
Currently supports Debian and ArchLinux based distros.
|
||||
|
||||
### [Carla](http://kxstudio.sourceforge.net/KXStudio:Applications:Carla)
|
||||
Multi-plugin host for JACK.<br/>
|
||||
It has some nice features like automation of parameters via MIDI CCs (and send control outputs back to MIDI too) and full OSC control.<br/>
|
||||
Currently supports LADSPA (including LRDF), DSSI, LV2, and VST plugin formats, with additional GIG, SF2 and SFZ file support via FluidSynth and LinuxSampler.<br/>
|
||||
Multi-plugin host for JACK. <br/>
|
||||
It has some nice features like automation of parameters via MIDI CCs (and send control outputs back to MIDI too) and full OSC control. <br/>
|
||||
Currently supports LADSPA (including LRDF), DSSI, LV2, and VST plugin formats, with additional GIG, SF2 and SFZ file support via FluidSynth and LinuxSampler. <br/>
|
||||
This application is still under development and may change/break at anytime.
|
||||
|
||||
### [Carla-Control](#)
|
||||
An OSC Control GUI for Carla (you get the OSC address from the Carla's about dialog, and connect to it).<br/>
|
||||
Supports controlling main UI components (Dry/Wet, Vol and Balance), and all plugins parameters.<br/>
|
||||
Peak values and control outputs are displayed as well.<br/>
|
||||
Custom Plugin GUIs are not supported at this point.<br/>
|
||||
Supports controlling main UI components (Dry/Wet, Vol and Balance), and all plugins parameters. <br/>
|
||||
Peak values and control outputs are displayed as well. <br/>
|
||||
Custom Plugin GUIs are not supported at this point. <br/>
|
||||
NOTE: This application is not yet ported to this python3 branch
|
||||
|
||||
### [JACK-Meter](#)
|
||||
Simple JACK audio peak meter.<br/>
|
||||
Simple JACK audio peak meter. <br/>
|
||||
In the future it will be available in a plugin version, based on the DISTRHO project.
|
||||
|
||||
### [XY-Controller](#)
|
||||
Simple XY widget that sends and receives data from Jack MIDI.<br/>
|
||||
It can send data through specific channels and has a MIDI Keyboard too.<br/>
|
||||
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.<br/>
|
||||
Simple XY widget that sends and receives data from Jack MIDI. <br/>
|
||||
It can send data through specific channels and has a MIDI Keyboard too. <br/>
|
||||
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. <br/>
|
||||
In the future it will be available in a plugin version, based on the DISTRHO project.
|
||||
|
|
|
|||
Loading…
Reference in New Issue