fcc13811b252812e787cbc23328eda9fe16d6602
[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                         Optionally, there is a way to get udev to assign an attached BCF2000 a consistent
45                         name under /dev/ however, by adding the following line to the udev rules. On some
46                         systems, these reside in <filename>/etc/udev/rules.d/</filename>:
47
48 <programlisting>
49 KERNEL=="midiC[0-9]D0", ATTRS{product}=="BCF2000", SYMLINK+="midi-bcf2000"
50 </programlisting>
51
52                         This will cause udev to create a <filename>/dev/midi-bcf2000</filename>
53                         for any BCF attached to the system, regardless of which alsa card number
54                         it gets assigned. Obviously you'd use <filename>/dev/midi-bcf2000</filename>
55                         instead of <filename>/dev/snd/midiC2D0</filename>.
56                 </para>
57                 <para>
58                         See also <ulink url="http://reactivated.net/writing_udev_rules.html">Writing udev rules</ulink>
59                 </para>
60   </section>
61
62         <section id="sn-mackie-extenders">
63                 <title>Extenders</title>
64                 <para>
65                         The Logic protocol allows the use of
66                         <ulink url="http://www.mackie.com/products/mcupro/index.html">extenders</ulink>
67                         or <ulink url="http://www.mackie.com/home/showimage.html?u=/products/mcupro/images/MCU-ExtPro-Top.jpg">Extender image</ulink>.
68                         Extenders are essentially banks of 8 faders without the jog wheel and buttons.
69                         Once the code is fixed, it will be possible to
70                         use either the mackie extenders, or BCF2000 units as extenders.
71                 </para>
72 <!--
73                 <para>
74       To do this, add the following lines to
75       <filename>~/.ardour2/ardour.rc</filename>
76 <programlisting>
77 &lt;MIDI-port tag="mcu_xt_1" device="/dev/snd/midiC3D0" type="alsa/raw" mode="duplex"/&gt;
78 &lt;MIDI-port tag="mcu_xt_2" device="/dev/snd/midiC4D0" type="alsa/raw" mode="duplex"/&gt;
79 </programlisting>
80       and so on, one for each of your extenders, up to a maximum of 9
81       extenders.
82     </para>
83 -->
84         </section>
85
86   <section id="mackie-mackie-mode">
87     <title>Mackie Mode</title>
88     <para>
89       If you have a Mackie MCU make sure that you have the following under
90       the &lt;Config&gt; tag:
91 <programlisting>
92 &lt;Option name="mackie-emulation" value="mcu"/&gt;
93 </programlisting>
94     </para>
95
96                 <note>
97                         <para>
98                                 The Mackie must be in Logic Control mode, otherwise the LCD display
99                                 does not work. To put the unit in Logic Control mode: press and hold
100                                 channel 1+2 SELECT while turning the unit on and through calibration;
101                                 and then press the VPOT under whichever mode you wish to use. 
102                         </para>
103                 </note>
104                 
105     <para>
106       In this mode, the original mappings are used.
107                         Note that many of the
108       buttons have not yet been implemented.
109     </para>
110   </section>
111
112   <section id="mackie-bcf-mode">
113     <title>BCF mode</title>
114     <para>
115       If you have a BCF2000 you must add under the &lt;Config&gt; tag:
116 <programlisting>
117 &lt;Option name="mackie-emulation" value="bcf"/&gt;
118 </programlisting>
119     </para>
120
121     <para>
122       The following are different in BCF mode:
123       <itemizedlist>
124         <listitem>
125           <para>
126             7 of the 8 sliders are used as route sliders, the remaining
127             right-hand one is used for the master slider
128           </para>
129         </listitem>
130
131         <listitem>
132           <para>
133             certain buttons have been remapped from the default Behringer
134             settings, which required either both hands, or one-handed
135             contortions to do simple things like rec-enable or mute a track.
136           </para>
137         </listitem>
138
139         <listitem>
140           <para>
141             The display shows the number of the first switched-in bank or Ar
142             if the first bank is in place.
143           </para>
144         </listitem>
145       </itemizedlist>
146     </para>
147
148     <para>
149       BCF mode bindings
150       <table id="tbl-mackie-bcf-key-bindings">
151         <title>BCF mode bindings</title>
152         <tgroup cols = "4">
153           <colspec colnum="1" colname="Strip" colwidth="1"/>
154           <colspec colnum="2" colname="Master Strip" colwidth= "1"/>
155           <colspec colnum="3" colname="Buttons 1" colwidth="1"/>
156           <colspec colnum="4" colname="Buttons 2" colwidth= "1"/>
157           <thead>
158             <row>
159               <entry>
160                 Strips 1-7
161               </entry>
162
163               <entry>
164                 Master Strip
165               </entry>
166
167               <entry namest="Buttons 1" nameend="Buttons 2">
168                 Buttons
169               </entry>
170             </row>
171           </thead>
172           <tbody>
173             <row>
174               <entry>
175                                                                 <para>vpot: pan</para>
176                                                                 <para>button: solo</para>
177               </entry>
178
179               <entry>
180                 <para>vpot: jog wheel</para>
181                                                                 <para>button: all solo</para>
182               </entry>
183
184               <entry namest="Buttons 1" nameend="Buttons 2">
185                 LCD display
186               </entry>
187             </row>
188
189             <row>
190               <entry>
191                 mute
192               </entry>
193
194               <entry>
195                 mute
196               </entry>
197
198               <entry>
199                 shift 1
200               </entry>
201
202               <entry>
203                 <para>
204                   loop
205                 </para>
206
207                 <para>
208                   shift 1: marker
209                 </para>
210
211                 <para>
212                   shift 2: punch in
213                 </para>
214               </entry>
215             </row>
216
217             <row>
218               <entry>
219                 rec
220               </entry>
221
222               <entry>
223                 session rec
224               </entry>
225
226               <entry>
227                 shift 2
228               </entry>
229
230               <entry>
231                 <para>
232                   click
233                 </para>
234
235                 <para>
236                   shift 1: jog wheel scrub/shuttle/scroll
237                 </para>
238                                                                 
239                 <para>
240                   shift 2: punch out
241                 </para>
242               </entry>
243             </row>
244
245             <row>
246               <entry morerows="4" valign="middle">
247                 slider
248               </entry>
249
250               <entry morerows="4" valign="middle">
251                 slider
252               </entry>
253
254               <entry>
255                 rewind
256               </entry>
257
258               <entry>
259                                                                 <para>ffwd</para>
260                 <para>
261                   shift 1: jog wheel zoom
262                 </para>
263                                                                 
264               </entry>
265             </row>
266
267             <row>
268               <entry>
269                 home
270               </entry>
271
272               <entry>
273                 end
274               </entry>
275             </row>
276
277             <row>
278               <entry>
279                 <para>
280                   previous bank
281                 </para>
282
283                 <para>
284                   shift 1: previous route
285                 </para>
286               </entry>
287
288               <entry>
289                 <para>
290                   next bank
291                 </para>
292
293                 <para>
294                   shift 1: next route
295                 </para>
296               </entry>
297             </row>
298
299             <row>
300               <entry>
301                 frm_prev (previous marker)
302               </entry>
303
304               <entry>
305                 frm_next (next marker)
306               </entry>
307             </row>
308
309             <row>
310               <entry>
311                 stop
312               </entry>
313
314               <entry>
315                 play
316               </entry>
317             </row>
318           </tbody>
319         </tgroup>
320       </table>
321     </para>
322   </section>
323
324   <section id="mackie-connecting-to-ardour">
325     <title>Connecting to Ardour</title>
326                 <note>
327                         <para>
328                                 Currently, support for the mackie using alsa/sequencer ports
329                                 is borked. You're better off using alsa/raw as documented above.
330                         </para>
331                 </note>
332     <para>
333       Start up ardour. Go to Options/Control Surfaces. You should see
334       "Mackie" as one of the menu items. Turn it on. The faders on the
335       surface should jump to the correct positions. The mackie should work
336       as normal, except that any buttons not on the BCF won't work.
337     </para>
338   </section>
339
340   <section id="mackie-usage">
341     <title>Usage</title>
342     <para>
343                         Strips (faders,pots,rec-enable,mute,solo) etc are fairly obvious.
344     </para>
345                 <para>
346                         The Jog wheel has various modes:
347       <itemizedlist>
348         <listitem>
349           <para>
350             Scroll mode. Part of the Scrub button cycle. The default. Scrolls the playhead. Displays "SC"
351                                                 in the 2 character LED.
352           </para>
353         </listitem>
354                                 
355         <listitem>
356           <para>
357             Scrub mode. Part of the Scrub button cycle.
358                                                 Rate of rotation of the Jog wheel controls
359                                                 the direction and speed of the transport.
360                                                 Displays "Sb" in the 2 character LED.
361           </para>
362         </listitem>
363
364         <listitem>
365           <para>
366             Shuttle mode. Part of the Scrub button cycle. 
367                                                 Jog wheel controls speed and direction of transport.
368                                                 Displays "Sh" in the 2 character LED.
369           </para>
370         </listitem>
371
372         <listitem>
373           <para>
374             Zoom mode. Toggled by the Zoom button. Mutually exclusive
375                                                 with the Scrub cycle.
376                                                 Jog wheel controls zoom level.
377                                                 Displays "Zm" in the 2 character LED.
378           </para>
379         </listitem>
380                         </itemizedlist>
381                 </para>
382                 
383                 <para>
384                         When holding ffwd or rew, the Jog wheel will adjust the speed.
385                 </para>
386                 
387                 <para>
388                         frm_next and frm_prev will jump to next or previous markers. Markers
389                         can be set at the current playhead position with the marker button.
390                 </para>
391                 
392                 <para>
393                         The pot will pan single panners, and linked stereo panners. It won't
394                         pan unlinked stereo panners, or 3 or more channel panners.
395                 </para>
396                 
397   </section>
398         
399         <section id="mackie-thanks">
400                 <title>Thanks</title>
401                 <para>Thomas Vecchione for help debugging the mackie LCD display, and functionality suggestions.</para>
402                 <para>Giso Grimm for help debugging various BCF issues, and functionality suggestions.</para>
403                 <para>Josh Parsons for the udev configuration and links.</para>
404                 <para>Various other people who provided good bug reports and suggestions and feedback.</para>
405         </section>
406
407 <!--
408         <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 
409                 href="Some_Subsection.xml" />
410         -->
411 </section>