Shamusworld >> Repos - ardour-manual/blob - include/patchbay.html

   1 <figure class="right">
   2   <img src="/images/connection-manager.png" alt="An example patchbay">
   3   <figcaption>
   4     An example patchbay
   5   </figcaption>
   6 </figure>
   7
   8 <p>
   9   The <dfn>patchbay</dfn> is the main way to make connections to, from and
  10   within Ardour's mixer.
  11 </p>
  12 <p class="note">
  13   Notable exceptions are internal aux sends and connections to the monitor bus
  14   (when using one): these cannot be controlled from a patchbay, and are
  15   basically not under manual control at all.
  16 </p>
  17 <p>
  18   The patchbay presents two groups of ports; one set of <dfn>sources</dfn>
  19   (which produce data), and one of <dfn>destinations</dfn> (which consume data).
  20   Depending on the relative number of each, the sources will be placed on the
  21   left or the top of the dialogue, and the destinations on the right or the
  22   bottom. Thus, in general, signal flow is from top or left to right or bottom.
  23 </p>
  24 <p>
  25   Both sources and destinations are divided up into groups, with each group
  26   being given a tab:
  27 </p>
  28
  29 <table class="dl">
  30   <tr><th>Hardware</th>
  31       <td>These are ports which are connected to a physical piece of hardware
  32       (a sound card or MIDI interface).</td></tr>
  33   <tr><th>Ardour Busses</th>
  34       <td>All ports belonging to busses.</td></tr>
  35   <tr><th>Ardour Tracks</th>
  36       <td>All ports belonging to tracks.</td></tr>
  37   <tr><th>Ardour Misc</th>
  38       <td>These are other ports that do not fit into the previous two
  39       categories; for example, the ports on which the metronome click
  40       is output, and MIDI ports for things like control surfaces and
  41       timecode.</td></tr>
  42   <tr><th>Other</th>
  43       <td>
  44       If there are other JACK clients running, their ports will be found
  45       here. If there are no such ports, the tab will not exist (on one or
  46       both axes of the grid).</td></tr>
  47 </table>
  48 <p>
  49   The main part of the patchbay is a <dfn>matrix grid</dfn>. Within this grid,
  50   green dots represent connections, and any of the squares can be clicked on to
  51   make or break connections. Clicking and dragging draws a line of connections,
  52   which is sometimes useful for making many connections at once.
  53 </p>
  54 <p>
  55   In the example patchbay shown above we can note various things. We are
  56   using the <kbd class="menu">Ardour Tracks</kbd> sources tab, so we see
  57   the output ports of the three tracks in our session: Fred, Jim and Foo.
  58   Our destinations are from the <kbd class="menu">Ardour Busses</kbd> tab,
  59   so we have the inputs of a session bus, Sheila, and the inputs of the
  60   master bus. Fred and Jim have stereo outputs, so have L and R connections.
  61   Foo is a MIDI track, so it only has one connection, and its squares in
  62   the grid are coloured light grey to indicate that no connection can be
  63   made between Foo (a MIDI output) and our busses (which are all audio-input).
  64 </p>
  65 <p>
  66   The green dots in the example show that both Fred and Jim are connected
  67   to the master bus, left to left and right to right.
  68 </p>
  69
  70 <h2>Variants on the Patchbay</h2>
  71 <p>
  72   Slightly different versions of the patchbay are available from different
  73   places in Ardour. A global view of all JACK audio connections is available, in
  74   <kbd class="menu">Window &gt Audio Connections</kbd>, or by pressing
  75   <kbd class="mod2">P</kbd>. A corresponding MIDI Connection Manager can
  76   be opened using <kbd class="mod23">P</kbd>.</p>
  77 <p>
  78   There is also a patchbay available when connecting individual tracks;
  79   clicking on the input or output buttons of a mixer strip will open a
  80   connection manager which has the corresponding track input or output as
  81   the only destination or source, with all other ports available for
  82   connection to it.
  83 </p>
  84
  85 <h2>Other patchbay features</h2>
  86 <p>
  87   <kbd class="mouse">right</kbd>-clicking on a port name in the connection manager
  88   opens a context menu which provides a few handy options:
  89 </p>
  90 <table class="dl">
  91   <tr><th><kbd class="menu">Add audio port</kbd> and <kbd class="menu">Add MIDI port</kbd></th>
  92   <td>
  93     These options add audio or MIDI ports to the clicked source, if this is
  94     possible. In this way, for example, tracks and busses can be extended to have
  95     more inputs or outputs.
  96   </td></tr>
  97   <tr><th><kbd class="menu">Remove <em>port_name</em></th>
  98   <td>
  99     Removes the given port, if possible. <kbd class="mouse mod3">Right</kbd>-clicking
 100     a port will do the same.
 101   </td></tr>
 102   <tr><th><kbd class="menu">Disconnect all from <em>port_name</em></kbd></th>
 103   <td>Disconnects everything from the given port.</td></tr>
 104   <tr><th><kbd class="menu">Rescan</kbd></th>
 105   <td>
 106     Ardour will try to keep abreast of any changes to the JACK ports on
 107     the system, and reflect them in any connection managers which are open.
 108     If for some reason this fails, this can be used to re-scan the list of ports and
 109     update the manager.
 110   </td></tr>
 111   <tr><th><kbd class="menu">Show individual ports</kbd></th>
 112   <td>
 113     If a session has lots of multi-channel tracks or busses, it may be an
 114     unnecessary detail that left has to be connected to left and right to right
 115     every time a connection is made. This obviously gets worse with higher
 116     channel counts (such as for 5.1 or Ambisonics). To make life easier with
 117     such sessions, Show individual ports can be unticked. After that, the
 118     channels of tracks and busses will be hidden, and any green dots added in
 119     the connection manager will automatically connect each channel of the source
 120     to the corresponding channel of the destination (left to left, right to
 121     right and so on). In this mode, a half-circle in the connection grid
 122     indicates that some (but not all) of the source's ports are connected to the
 123     destination.
 124   </td></tr>
 125   <tr><th><kbd class="menu">Flip</kbd></th>
 126   <td>
 127     This will flip the visible ports on the vertical axis with those on the
 128     horizontal. If, for example, the top of the connection manager is showing
 129     <kbd class="menu">Ardour Busses</kbd> and the right is showing
 130     <kbd class="menu">Hardware</kbd>, flip will swap the view to the
 131     opposite. Flipping can also be done by pressing <kbd>f</kbd>. Note that if
 132     there are no matching tabs on both axes, flipping will be impossible.
 133   </td></tr>
 134 </table>