non/mixer/doc/MANUAL.html

291 lines
14 KiB
HTML
Raw Normal View History

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head>
<meta name="generator" content="Generated by MUP v3.5">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link type="text/css" rel="stylesheet" href="mup.css">
<title>Non Mixer User Manual</title>
</head>
<body>
<div id=cover>
<h1>Non Mixer User Manual</h1>
<h3></h3>
<address>
Jonathan Moore Liles <a href="mailto:male@tuxfamily.org">&lt;male@tuxfamily.org&gt;</a><br>
January 21, 2010<br>
</address><hr></div>
<div id=body>
<div id=toc>
<h1 id=toc>Table Of Contents</h1>
<ul>
<li><a href="#n:1.">1. User Manual</a>
<ul><li><a href="#n:1.1.">1.1. The Mixer</a>
2010-01-31 08:41:33 +01:00
<ul><li><a href="#n:1.1.1.">1.1.1. Display Options</a>
2010-01-31 08:41:33 +01:00
<li><a href="#n:1.1.2.">1.1.2. Mixer Strips</a>
2010-01-31 08:41:33 +01:00
<ul><li><a href="#n:1.1.2.1.">1.1.2.1. Navigation</a>
2010-01-31 08:41:33 +01:00
<li><a href="#n:1.1.2.2.">1.1.2.2. Control</a>
2010-01-31 08:41:33 +01:00
<li><a href="#n:1.1.2.3.">1.1.2.3. Signal Chain</a>
2010-01-31 08:41:33 +01:00
<ul><li><a href="#n:1.1.2.3.1.">1.1.2.3.1. Modules</a>
<ul><li><a href="#n:1.1.2.3.1.1.">1.1.2.3.1.1. OSC Control</a>
<li><a href="#n:1.1.2.3.1.2.">1.1.2.3.1.2. Manipulation</a>
2010-01-31 08:41:33 +01:00
<li><a href="#n:1.1.2.3.1.3.">1.1.2.3.1.3. Module Parameter Editor</a>
2010-01-31 08:41:33 +01:00
<li><a href="#n:1.1.2.3.1.4.">1.1.2.3.1.4. Controls</a>
<ul><li><a href="#n:1.1.2.3.1.4.1.">1.1.2.3.1.4.1. Control Voltages</a>
2010-01-31 08:41:33 +01:00
</ul></ul></ul></ul><li><a href="#n:1.1.3.">1.1.3. Projects</a>
<ul><li><a href="#n:1.1.3.1.">1.1.3.1. JACK I/O</a>
</ul></ul></ul></ul></ul><hr></div>
<h1 id="n:1.">1. User Manual</h1>
<h2 id="n:1.1.">1.1. The Mixer</h2>
<center><div class="fig image"><table id="Fig.1.1" border=1>
<caption>
<strong>Fig. 1.1.</strong> Mixer
</caption>
<tr><td><img src="non-mixer-complex.png" alt="fig. 1.1"></td></tr>
</table></div></center>
<p>
The Non-Mixer is a stand-alone audio mixer, utilizing JACK as an audio subsystem. At the time of writing, the architecture of Non-Mixer is unique. By making the mixer stand-alone, concepts such as busses, sends, and inserts are eliminated, as the same goals can be achieved by simply adding more strips to the mixer.
</p>
<p>
2010-02-01 02:04:47 +01:00
Start by creating a new project (menu item <tt>Project/New</tt>).
</p>
<center><div class="fig image"><table id="Fig.1.2" border=1>
<caption>
<strong>Fig. 1.2.</strong> New Project
</caption>
<tr><td><img src="new-project.png" alt="fig. 1.2"></td></tr>
</table></div></center>
<p>
2010-01-31 08:41:33 +01:00
After the project has been created. Hit <tt>a</tt> or choose <tt>Mixer/Add Strip</tt> from the menu to add a new strip to the mixer.
</p>
<h3 id="n:1.1.1.">1.1.1. Display Options</h3>
<p>
The display options, found in the <tt>Options/Display</tt> submenu may be adjusted to suit your needs. Set the color scheme, widget style, and other graphic options to your liking. These options are global and affect all projects.
</p>
<h3 id="n:1.1.2.">1.1.2. Mixer Strips</h3>
<center><div class="fig image"><table id="Fig.1.3" border=1>
<caption>
<strong>Fig. 1.3.</strong> Mixer Strip
</caption>
<tr><td><img src="single-strip.png" alt="fig. 1.3"></td></tr>
</table></div></center>
<p>
Each mixer strip has a name and color, each of which may be defined by the user. Names, but not colors, must be unique. In addition, each strip has controls to move it left or right (the arrows) in the display and to remove it entirely (the 'X').
</p>
<p>
Strips start out in <i>narrow</i> mode, with the <i>fader</i> view enabled. Click the desired button to toggle the mode or view.
</p>
<p>
2010-01-31 08:41:33 +01:00
<p>
The fader view comprises a large gain control and digital peak meter indicator. These are automatically connected to the default gain and meter modules of the strip's signal chain.
</p>
<p>
To see how an audio signal traveling through this strip will be processed, switch to its <i>signal</i> view.
</p>
2010-01-31 08:41:33 +01:00
<h4 id="n:1.1.2.1.">1.1.2.1. Navigation</h4>
<p>
2010-02-01 02:04:47 +01:00
A strip is focused when you click on it. Focus can be moved among strips with the <tt>Tab</tt> and <tt>Shift-Tab</tt> keys.
2010-01-31 08:41:33 +01:00
</p>
<h4 id="n:1.1.2.2.">1.1.2.2. Control</h4>
<p>
The focused strip can be moved in the display order via the <tt>[</tt> and <tt>]</tt> keys. <tt>Delete</tt> removes a strip (with confirmation dialog). <tt>n</tt> and <tt>w</tt> set the focused strip's width to <i>narrow</i> or <i>wide</i>, respectively, and <tt>f</tt> and <tt>s</tt> switch between <i>fader</i> and <i>signal</i> views. The strip's context menu can be invoked without the mouse by hitting the <tt>Menu</tt> key (assuming your keyboard has one).
</p>
<h4 id="n:1.1.2.3.">1.1.2.3. Signal Chain</h4>
<p>
The signal chain view of a mixer strip provides a way to view and manipulate the signal processing of a mixer strip.
</p>
2010-01-31 08:41:33 +01:00
<h5 id="n:1.1.2.3.1.">1.1.2.3.1. Modules</h5>
<center><div class="fig image"><table id="Fig.1.4" border=1>
<caption>
<strong>Fig. 1.4.</strong> Modules
</caption>
<tr><td><img src="modules.png" alt="fig. 1.4"></td></tr>
</table></div></center>
<p>
2010-01-31 08:41:33 +01:00
All signal processing in Non Mixer occurs in <i>Modules</i>. Modules are signal processing abstractions providing ports for audio and control I/O and, in addition, some simple user interface. Sink and source modules carry audio out of and into JACK.
</p>
<p>
2010-01-31 08:41:33 +01:00
Modules are displayed as named blocks. Some modules (e.g. the Meter module) may have additional GUI components.
</p>
<p>
2010-01-31 08:41:33 +01:00
Each module has zero or more audio I/O ports and zero or more control ports. Audio routing between modules is handled automatically. Modules with mono audio configurations (one channel in, one channel out) can be automatically adjusted to support any number of discrete channels. Modules with more (related) channels, however, introduce restrictions on the order in which modules can be chained.
</p>
<p>
An indicator in the upper left-hand corner of each module block indicates whether the module has any parameters bound to controls.
</p>
<p>
Non Mixer has several built-in modules. They are:
</p>
<dl>
<dt><em>JACK</em></dt>
<dd>Performs JACK I/O</dd>
<dt><em>Gain</em></dt>
<dd>Applies gain in dB</dd>
<dt><em>Meter</em></dt>
<dd>Digital Peak Meter</dd>
<dt><em>Mono Pan</em></dt>
<dd>Performs intensity panning of a mono signal into a stereo signal.</dd>
<dt><em>Plugin</em></dt>
<dd>Hosts a LADSPA plugin</dd>
</dl>
<h6 id="n:1.1.2.3.1.1.">1.1.2.3.1.1. OSC Control</h6>
<p>
The input parameters of all modules are controllable via OSC, regardless of whether the parameter is set as controllable.
</p>
<p>
The format of the automatically generated OSC path names is as follows:
</p>
<div class="fig example"><table width=100%><tr><td><pre>
/mixer/strip/[STRIP_NAME]/control/[MODULE_NAME]/[PARAMETER_NAME]
</pre></td></tr>
</table></div>
<p>
The UDP port that the OSC server binds to can be set by providing the <tt>--osc-port</tt> command-line option. Without this option, a random port will be bound automatically (the exact OSC URL will always be printed to the console as a line beginning with "OSC: ").
</p>
<p>
The default path accepts a float value between 0.0 and 1.0 (a Control Voltage) which will be scaled to the allowable range of the control.
</p>
<p>
A path ending in /unscaled is also available, which accepts exact values, which will be clamped to the allowable range. For example:
</p>
<div class="fig example"><table width=100%><tr><td><pre>
/mixer/strip/[STRIP_NAME]/control/[MODULE_NAME]/[PARAMETER_NAME]/unscaled
</pre></td></tr>
</table></div>
<p>
If same module/plugin is used twice in a signal chain (e.g. multiple Gain stages), then a position dependent sequence number will be appended to the module name. For example, a path might look like the following:
</p>
<div class="fig example"><table width=100%><tr><td><pre>
/mixer/strip/Foo/control/Gain.1/Gain_(dB)
</pre></td></tr>
</table></div>
<p>
For the second instance of the Gain module on the strip named 'Foo'.
</p>
<p>
For each OSC parameter change message received, a reply will be sent to the same path at the sender with the new value as the only parameter. Changes to the control value initatied in the GUI will <b>not</b> generate any OSC messages.
</p>
<h6 id="n:1.1.2.3.1.2.">1.1.2.3.1.2. Manipulation</h6>
<p>
2010-01-31 08:41:33 +01:00
Left-clicking on a module brings up a Module Parameter Editor window for the selected module.
</p>
<p>
2010-01-31 08:41:33 +01:00
Right-clicking on a module brings up a context menu allowing you manipulate the module, as well as to pick a new module to insert before the selected one in the chain.
</p>
<p>
Middle-clicking on a module toggles its activation state (the audio signal will bypass inactive modules).
</p>
<p>
Control+Right-clicking on a module causes it to be removed from the chain (modules added by default cannot be removed).
</p>
2010-02-01 02:04:47 +01:00
<p>
The focused module may also be controlled via the keyboard. <tt>Menu</tt> brings up the context menu for the focused module. <tt>Space</tt> opens the module parameter editor, <tt>b</tt> toggles the bypassed state, and <tt>Delete</tt> removes the module from the chain (without confirmation!). <tt>Control-X</tt>, <tt>Control-C</tt> and <tt>Control-V</tt>, cut, copy, and paste modules, respectively. Modules may be copied within or across chain boundaries. The normal module I/O constraints also apply to pasted modules.
2010-02-01 02:04:47 +01:00
</p>
<h6 id="n:1.1.2.3.1.3.">1.1.2.3.1.3. Module Parameter Editor</h6>
<center><div class="fig image"><table id="Fig.1.5" border=1>
<caption>
<strong>Fig. 1.5.</strong> Module Parameter Editor
</caption>
<tr><td><img src="gverb-parameters-knobs.png" alt="fig. 1.5"></td></tr>
</table></div></center>
<p>
2010-02-01 02:04:47 +01:00
The Module Parameter Editor is used to alter the values of a module's parameters, and in addition, to bind its parameters to controls. A menu button in the upper left-hand corner allows you to select between knob, vertical slider and horizontal slider controls.
</p>
<center><div class="fig image"><table id="Fig.1.6" border=1>
<caption>
<strong>Fig. 1.6.</strong> Horizontal Sliders
</caption>
<tr><td><img src="gverb-parameters-hsliders.png" alt="fig. 1.6"></td></tr>
</table></div></center>
<center><div class="fig image"><table id="Fig.1.7" border=1>
<caption>
<strong>Fig. 1.7.</strong> Vertical Sliders
</caption>
<tr><td><img src="gverb-parameters-vsliders.png" alt="fig. 1.7"></td></tr>
</table></div></center>
<p>
Underneath each control is a bind button. Clicking adds a new control to the chain's <i>Controls</i> view and binds it to the parameter in question. For simplicity, only one control at a time may be bound to a given parameter.
</p>
<h6 id="n:1.1.2.3.1.4.">1.1.2.3.1.4. Controls</h6>
<center><div class="fig image"><table id="Fig.1.8" border=1>
<caption>
<strong>Fig. 1.8.</strong> Control View
</caption>
<tr><td><img src="controls.png" alt="fig. 1.8"></td></tr>
</table></div></center>
<p>
2010-01-31 08:41:33 +01:00
The control view of a chain groups together all of the controls bound to parameters of modules in that chain. The default mode of controls is <i>Manual</i>. Right click on a control to bring up a menu which will allow you to select one of the available control I/O methods to use. When <i>Control Voltage</i> (CV) is selected, a CV input port will be created on the containing mixer strip's JACK client. The control will now accept values from that input. A control bound and configured in this way can then be connected to the output of a Non-DAW control sequence using your favorite connection manager.
</p>
<div class=admonition>
<table width=100%>
<tr><td>NOTE:
All knob and slider controls respond to mousewheel
events. Hold down the `Ctrl` key while scrolling the mousewheel to
achieve finer resolution.
</td></table>
</div>
<h7 id="n:1.1.2.3.1.4.1.">1.1.2.3.1.4.1. Control Voltages</h7>
<p>
2010-01-31 08:41:33 +01:00
The control voltage concept should be familiar to anyone who has experience with analog modular synthesizers. MIDI, while having definite advantages in many respects, multiplexes control data in such a way as to make connecting one MIDI control to a parameter involve a significant inconvenience, usually requiring the adjustment of settings on both ends of the connection in order to separate the control data streams.
</p>
<p>
2010-01-31 08:41:33 +01:00
Control Voltages, on the other hand, provide a simple 1:1 source to sink relationship and offer much higher resolution, both in time and value, than can be natively expressed through MIDI. The chief advantage of CV in the context of Non-DAW is the ease with which an control sequence can be connected to a mixer module parameter. If you have a MIDI controller that you'd like to use to control parameters of Non-Mixer, consider <i>jm2cv</i>, a JACK MIDI to Control Voltage daemon which was written by Peter Nelson specifically for use with Non-Mixer. jm2cv can be acquired by:
</p>
<div class="fig example"><table width=100%><tr><td><pre>
git clone git://fuzzle.org/jm2cv.git
</pre></td></tr>
</table></div>
2010-01-31 08:41:33 +01:00
<h3 id="n:1.1.3.">1.1.3. Projects</h3>
<p>
2010-02-01 02:04:47 +01:00
A Non-Mixer project is a directory where Non-Mixer keeps the strip settings, project specific settings, and some meta-data. A project is completely self-contained. You can rename a project as simply as:
2010-01-31 08:41:33 +01:00
</p>
<div class="fig example"><table width=100%><tr><td><pre>
$ mv Project-A Project-B
</pre></td></tr>
</table></div>
<h4 id="n:1.1.3.1.">1.1.3.1. JACK I/O</h4>
<p>
Each mixer strip is presented as a separate JACK "client". This helps to avoid the necessity of internally duplicating JACK's routing logic and, with JACK2, permits the possibility of parallel execution of mixer strip signal chains.
</p>
<p>
The JACK client name of each strip will correspond to the name of the strip.
</p>
<div class=admonition>
<table width=100%>
<tr><td>NOTE:
The JACK API makes implementing this far more difficult and kludgey than it should have to be.
Please petition your local JACK developer to accept jack_client_set_name() into the API.
</td></table>
</div>
<center><div class="fig image"><table id="Fig.1.9" border=1>
<caption>
<strong>Fig. 1.9.</strong> Patchage
</caption>
<tr><td><img src="non-mixer-and-non-daw-in-patchage.png" alt="fig. 1.9"></td></tr>
</table></div></center>
</div>
</body>
</html>