Update Mackie manual page to reflect latest changes.
[ardour.git] / manual / xml / mackie.xml
1 <?xml version="1.0" standalone="no"?>
2
3 <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4
5 ]>
6
7 <section id="sn-mackie">
8   <title>Using the Mackie driver for MCU and BCF2000</title>
9   <para>
10     For Ardour 2, this will walk you through the process of configuring and using Mackie
11     MCU, or a BCF2000 in
12     <ulink url="http://www.behringerdownload.de/BCF2000/BCF2000_Emulation_modes.pdf">Logic
13     Control emulation mode</ulink>.
14   </para>
15
16   <section id="mackie-connecting-device">
17     <title>Connecting Device</title>
18     <para>
19       Make sure your surface is connected and you know which
20       <filename>/dev/snd/midi</filename> entry belongs to the device. You
21       can do this by saying <command>cat /proc/asound/cards</command> which
22       should result in something like
23 <screen>
24  0 [EWS88MT        ]: ICE1712 - TerraTec EWS88MT
25                       TerraTec EWS88MT at 0x1140, irq 21
26  1 [VirMIDI        ]: VirMIDI - VirMIDI
27                       Virtual MIDI Card 1
28  2 [BCF2000        ]: USB-Audio - BCF2000
29                       BEHRINGER BCF2000 at usb-0000:00:1a.1-1, full speed
30 </screen>
31       in this case the BCF2000 is on <filename>/dev/snd/midiC2D0</filename>.
32     </para>
33
34     <para>
35       While ardour is not running, edit your
36       <filename>.ardour2/ardour.rc</filename> (and for now <filename>etc/ardour2/ardour_system.rc</filename> and <filename>etc/ardour2/ardour.rc</filename>) and add at the top, with the
37       other ports:
38 <programlisting>
39 &lt;MIDI-port tag="mcu" device="/dev/snd/midiC2D0" type="alsa/raw" mode="duplex"/&gt;
40 </programlisting>
41     </para>
42
43     <para>
44       It is also possible to add MCU extenders or other BCF2000 units,
45       although this is untested because nobody we know has access to one
46       right now. To do this, add the following lines to
47       <filename>~/.ardour2/ardour.rc</filename>
48 <programlisting>
49 &lt;MIDI-port tag="mcu_xt_1" device="/dev/snd/midiC3D0" type="alsa/raw" mode="duplex"/&gt;
50 &lt;MIDI-port tag="mcu_xt_2" device="/dev/snd/midiC4D0" type="alsa/raw" mode="duplex"/&gt;
51 </programlisting>
52       and so on, one for each of your extenders, up to a maximum of 9
53       extenders.
54     </para>
55   </section>
56
57   <section id="mackie-mackie-mode">
58     <title>Mackie Mode</title>
59     <para>
60       If you have a Mackie MCU make sure that you have the following under
61       the &lt;Config&gt; tag:
62 <programlisting>
63 &lt;Option name="mackie-emulation" value="mcu"/&gt;
64 </programlisting>
65     </para>
66
67                 <note>
68                         <para>
69                                 The Mackie must be in Logic Control mode, otherwise the LCD display
70                                 does not work. To put the unit in Logic Control mode: press and hold
71                                 channel 1+2 SELECT while turning the unit on and through calibration;
72                                 and then press the VPOT under whichever mode you wish to use. 
73                         </para>
74                 </note>
75                 
76     <para>
77       In this mode, the original mappings are used.
78                         Note that many of the
79       buttons have not yet been implemented.
80     </para>
81   </section>
82
83   <section id="mackie-bcf-mode">
84     <title>BCF mode</title>
85     <para>
86       If you have a BCF2000 you must add under the &lt;Config&gt; tag:
87 <programlisting>
88 &lt;Option name="mackie-emulation" value="bcf"/&gt;
89 </programlisting>
90     </para>
91
92     <para>
93       The following are different in BCF mode:
94       <itemizedlist>
95         <listitem>
96           <para>
97             7 of the 8 sliders are used as route sliders, the remaining
98             right-hand one is used for the master slider
99           </para>
100         </listitem>
101
102         <listitem>
103           <para>
104             certain buttons have been remapped from the default Behringer
105             settings, which required either both hands, or one-handed
106             contortions to do simple things like rec-enable or mute a track.
107           </para>
108         </listitem>
109
110         <listitem>
111           <para>
112             The display shows the number of the first switched-in bank or Ar
113             if the first bank is in place.
114           </para>
115         </listitem>
116       </itemizedlist>
117     </para>
118
119     <para>
120       BCF mode bindings
121       <table id="tbl-mackie-bcf-key-bindings">
122         <title>BCF mode bindings</title>
123         <tgroup cols = "4">
124           <colspec colnum="1" colname="Strip" colwidth="1"/>
125           <colspec colnum="2" colname="Master Strip" colwidth= "1"/>
126           <colspec colnum="3" colname="Buttons 1" colwidth="1"/>
127           <colspec colnum="4" colname="Buttons 2" colwidth= "1"/>
128           <thead>
129             <row>
130               <entry>
131                 Strips 1-7
132               </entry>
133
134               <entry>
135                 Master Strip
136               </entry>
137
138               <entry namest="Buttons 1" nameend="Buttons 2">
139                 Buttons
140               </entry>
141             </row>
142           </thead>
143           <tbody>
144             <row>
145               <entry>
146                                                                 <para>vpot: pan</para>
147                                                                 <para>button: solo</para>
148               </entry>
149
150               <entry>
151                 <para>vpot: jog wheel</para>
152                                                                 <para>button: all solo</para>
153               </entry>
154
155               <entry namest="Buttons 1" nameend="Buttons 2">
156                 LCD display
157               </entry>
158             </row>
159
160             <row>
161               <entry>
162                 mute
163               </entry>
164
165               <entry>
166                 mute
167               </entry>
168
169               <entry>
170                 shift 1
171               </entry>
172
173               <entry>
174                 <para>
175                   loop
176                 </para>
177
178                 <para>
179                   shift 1: marker
180                 </para>
181
182                 <para>
183                   shift 2: punch in
184                 </para>
185               </entry>
186             </row>
187
188             <row>
189               <entry>
190                 rec
191               </entry>
192
193               <entry>
194                 session rec
195               </entry>
196
197               <entry>
198                 shift 2
199               </entry>
200
201               <entry>
202                 <para>
203                   click
204                 </para>
205
206                 <para>
207                   shift 1: jog wheel scrub/shuttle/scroll
208                 </para>
209                                                                 
210                 <para>
211                   shift 2: punch out
212                 </para>
213               </entry>
214             </row>
215
216             <row>
217               <entry morerows="4" valign="middle">
218                 slider
219               </entry>
220
221               <entry morerows="4" valign="middle">
222                 slider
223               </entry>
224
225               <entry>
226                 rewind
227               </entry>
228
229               <entry>
230                                                                 <para>ffwd</para>
231                 <para>
232                   shift 1: jog wheel zoom
233                 </para>
234                                                                 
235               </entry>
236             </row>
237
238             <row>
239               <entry>
240                 home
241               </entry>
242
243               <entry>
244                 end
245               </entry>
246             </row>
247
248             <row>
249               <entry>
250                 <para>
251                   previous bank
252                 </para>
253
254                 <para>
255                   shift 1: previous route
256                 </para>
257               </entry>
258
259               <entry>
260                 <para>
261                   next bank
262                 </para>
263
264                 <para>
265                   shift 1: next route
266                 </para>
267               </entry>
268             </row>
269
270             <row>
271               <entry>
272                 frm_prev (previous marker)
273               </entry>
274
275               <entry>
276                 frm_next (next marker)
277               </entry>
278             </row>
279
280             <row>
281               <entry>
282                 stop
283               </entry>
284
285               <entry>
286                 play
287               </entry>
288             </row>
289           </tbody>
290         </tgroup>
291       </table>
292     </para>
293   </section>
294
295   <section id="mackie-connecting-to-ardour">
296     <title>Connecting to Ardour</title>
297                 <note>
298                         <para>
299                                 Currently (ardour-2.0.4) support for alsa/sequencer ports
300                                 is borked. You're better off using alsa/raw as documented above.
301                         </para>
302                 </note>
303     <para>
304       Start up ardour. Go to Options/Control Surfaces. You should see
305       "Mackie" as one of the menu items. Turn it on. The faders on the
306       surface should jump to the correct positions. The mackie should work
307       as normal, except that any buttons not on the BCF won't work.
308     </para>
309   </section>
310
311   <section id="mackie-usage">
312     <title>Usage</title>
313     <para>
314                         Strips (faders,pots,rec-enable,mute,solo) etc are fairly obvious.
315     </para>
316                 <para>
317                         The Jog wheel has various modes:
318       <itemizedlist>
319         <listitem>
320           <para>
321             Scroll mode. Part of the Scrub button cycle. The default. Scrolls the playhead. Displays "SC"
322                                                 in the 2 character LED.
323           </para>
324         </listitem>
325                                 
326         <listitem>
327           <para>
328             Scrub mode. Part of the Scrub button cycle.
329                                                 Rate of rotation of the Jog wheel controls
330                                                 the direction and speed of the transport.
331                                                 Displays "Sb" in the 2 character LED.
332           </para>
333         </listitem>
334
335         <listitem>
336           <para>
337             Shuttle mode. Part of the Scrub button cycle. 
338                                                 Jog wheel controls speed and direction of transport.
339                                                 Displays "Sh" in the 2 character LED.
340           </para>
341         </listitem>
342
343         <listitem>
344           <para>
345             Zoom mode. Toggled by the Zoom button. Mutually exclusive
346                                                 with the Scrub cycle.
347                                                 Jog wheel controls zoom level.
348                                                 Displays "Zm" in the 2 character LED.
349           </para>
350         </listitem>
351                         </itemizedlist>
352                 </para>
353                 
354                 <para>
355                         When holding ffwd or rew, the Jog wheel will adjust the speed.
356                 </para>
357                 
358                 <para>
359                         frm_next and frm_prev will jump to next or previous markers. Markers
360                         can be set at the current playhead position with the marker button.
361                 </para>
362                 
363                 <para>
364                         The pot will pan single panners, and linked stereo panners. It won't
365                         pan unlinked stereo panners, or 3 or more channel panners.
366                 </para>
367                 
368   </section>
369
370 <!--
371         <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 
372                 href="Some_Subsection.xml" />
373         -->
374 </section>