basic usage, now that the mackie code is Out There

git-svn-id: svn://localhost/ardour2/trunk@1615 d708f5d6-7413-0410-9779-e7cbd77b26cf

2 files changed, 227 insertions, 0 deletions

diff --git a/manual/xml/control_surfaces.xml b/manual/xml/control_surfaces.xml
index 3d9bdd2069..fea5a7a97a 100644
--- a/manual/xml/control_surfaces.xml
+++ b/manual/xml/control_surfaces.xml
@@ -22,4 +22,6 @@
 		href="generic_midi_control_surface.xml" />
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 
 		href="configuring_usb_device_access.xml" />
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 
+		href="mackie.xml" />
 </chapter>
diff --git a/manual/xml/mackie.xml b/manual/xml/mackie.xml
new file mode 100644
index 0000000000..6917b261c2
--- /dev/null
+++ b/manual/xml/mackie.xml
@@ -0,0 +1,225 @@
+<?xml version="1.0" standalone="no"?>
+
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+
+]>
+
+<section id="sn-mackie">
+  <title>Using the Mackie driver for MCU and BCF2000</title>
+  <para>
+    This will walk you through the process of configuring and using Mackie
+		MCU, or a BCF2000 in <ulink url="http://www.behringerdownload.de/BCF2000/BCF2000_Emulation_modes.pdf">Logic Control emulation mode</ulink>.
+  </para>
+
+  <section id="mackie-connecting-device">
+    <title>Connecting Device</title>
+    <para>
+      Make sure your surface is connected and you know which <filename>/dev/snd/midi</filename>
+			entry belongs to the device. You can do this by saying
+			<command>cat /proc/asound/cards</command>
+			which should result in something like
+<screen>
+ 0 [EWS88MT        ]: ICE1712 - TerraTec EWS88MT
+                      TerraTec EWS88MT at 0x1140, irq 21
+ 1 [VirMIDI        ]: VirMIDI - VirMIDI
+                      Virtual MIDI Card 1
+ 2 [BCF2000        ]: USB-Audio - BCF2000
+                      BEHRINGER BCF2000 at usb-0000:00:1a.1-1, full speed
+</screen>
+			in this case the BCF2000 is on <filename>/dev/snd/midiC2D0</filename>.
+		</para>
+    <para>
+      While ardour is not running, edit your <filename>.ardour2/ardour.rc</filename> and add at the top, with
+			the other ports:
+<programlisting>
+&lt;MIDI-port tag="mcu" device="/dev/snd/midiC2D0" type="alsa/raw" mode="duplex"/&gt;
+</programlisting>
+			If you have a BCF2000, and you'd like to use <link linkend="mackie-bcf-mode">BCF mode</link>,
+			you can also add under the &lt;Config&gt; tag:
+<programlisting>
+&lt;Option name="mackie-emulation" value="bcf"/&gt;
+</programlisting>
+			
+    </para>
+		<para>
+			It is also possible to add MCU extenders, although this is untested
+			because nobody we know has access to one right now. To do this, add
+			the following lines to <filename>~/.ardour2/ardour.rc</filename>
+<programlisting>
+&lt;MIDI-port tag="mcu_xt_1" device="/dev/snd/midiC3D0" type="alsa/raw" mode="duplex"/&gt;
+&lt;MIDI-port tag="mcu_xt_2" device="/dev/snd/midiC4D0" type="alsa/raw" mode="duplex"/&gt;
+</programlisting>
+			and so on, one for each of your extenders, up to a maximum of 9 extenders.
+		</para>
+  </section>
+
+  <section id="mackie-connecting-to-ardour">
+    <title>Connecting to Ardour</title>
+    <para>
+      Start up ardour. Go to Options/Control Surfaces. You should see "Mackie"
+			as one of the menu items. Turn it on. The faders on the surface should
+			jump to the correct positions. The mackie should work as normal, except
+			that any buttons not on the BCF won't work.
+    </para>
+	</section>
+
+  <section id="mackie-bcf-mode">
+    <title>BCF mode</title>
+		<para>
+	    <itemizedlist>
+				<listitem>
+					<para>
+						7 of the 8 sliders are used as route sliders, the
+						remaining right-hand one is used for the master slider
+					</para>
+				</listitem>
+				<listitem>
+					<para>
+						certain buttons have been remapped from the default Behringer
+						settings, which required either both hands, or one-handed contortions
+						to do simple things like rec-enable or mute a track.
+					</para>
+				</listitem>
+				<listitem>
+					<para>
+						The display shows the number of the first switched-in bank
+						or Ar if the first bank is in place.
+					</para>
+				</listitem>
+			</itemizedlist>
+		</para>
+		
+		<para>
+		BCF mode bindings
+		<table id="tbl-mackie-bcf-key-bindings">
+			<title>BCF mode bindings</title>
+			<tgroup cols = "4">
+				<colspec colnum="1" colname="Strip" colwidth="1"/>
+				<colspec colnum="2" colname="Master Strip" colwidth= "1"/>
+				<colspec colnum="3" colname="Buttons 1" colwidth="1"/>
+				<colspec colnum="4" colname="Buttons 2" colwidth= "1"/>
+				<thead>
+					<row>
+						<entry>
+							Strips 1-7
+						</entry>
+						<entry>
+							Master Strip
+						</entry>
+						<entry namest="Buttons 1" nameend="Buttons 2">
+							Buttons
+						</entry>
+					</row>
+				</thead>
+				<tbody>
+					<row>
+						<entry>
+							pan / solo if pressed
+						</entry>
+						<entry>
+							transport
+							<footnote>
+								<para>
+									Making a pot pretend to be a shuttle wheel doesn't work very well.
+								</para>
+							</footnote>
+							/ nothing
+						</entry>
+						<entry namest="Buttons 1" nameend="Buttons 2">
+							LCD display
+						</entry>
+					</row>
+					
+					<row>
+						<entry>
+							mute
+						</entry>
+						<entry>
+							mute
+						</entry>
+						<entry>
+							shift 1
+						</entry>
+						<entry>
+							loop
+						</entry>
+					</row>
+
+					<row>
+						<entry>
+							rec
+						</entry>
+						<entry>
+							session rec
+						</entry>
+						<entry>
+							shift 2
+						</entry>
+						<entry>
+							click
+						</entry>
+					</row>
+
+					<row>
+						<entry morerows="4" valign="middle">
+							slider
+						</entry>
+						<entry morerows="4" valign="middle">
+							slider
+						</entry>
+						<entry>
+							punch in
+						</entry>
+						<entry>
+							punch out
+						</entry>
+					</row>
+
+					<row>
+						<entry>
+							home
+						</entry>
+						<entry>
+							end
+						</entry>
+					</row>
+
+					<row>
+						<entry>
+							previous bank
+							(shift 1 is previous route)
+						</entry>
+						<entry>
+							next bank
+							(shift 1 is next route)
+						</entry>
+					</row>
+
+					<row>
+						<entry>
+							previous marker
+						</entry>
+						<entry>
+							next marker
+						</entry>
+					</row>
+
+					<row>
+						<entry>
+							stop
+						</entry>
+						<entry>
+							play
+						</entry>
+					</row>
+				</tbody>
+			</tgroup>
+		</table>
+		</para>
+	</section>
+
+<!--
+	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 
+		href="Some_Subsection.xml" />
+	-->
+</section>