]> Shamusworld >> Repos - ardour-manual-diverged/blob - master-doc.txt
Sync with master branch.
[ardour-manual-diverged] / master-doc.txt
1 <!-- imploded -->
2
3 ---
4 title: Introduction to Ardour
5 part: part
6 ---
7
8
9 ---
10 title: Welcome to Ardour
11 part: chapter
12 ---
13
14 ---
15 title: About Ardour's documentation
16 part: subchapter
17 ---
18
19 <h2>Conventions Used In This Manual</h2>
20
21 <p>
22   This section covers some of the typographical and language conventions used in this manual.
23 </p>
24
25 <h3>Keyboards and Modifiers</h3>
26
27 <p>
28   <dfn>Keyboard bindings</dfn> are shown like this: <kbd>s</kbd> or <kbd class="mod1">x</kbd>.
29 </p>
30
31 <p>
32   <kbd class="mod1">x</kbd> means "press the <kbd class="mod1">&nbsp;</kbd> key, keep it pressed and then also press the <kbd>x</kbd> key.
33 </p>
34
35 <p>
36   You may also see key combinations such as <kbd class="mod12">e</kbd>, which mean that you should hold down the <kbd class="mod1">&nbsp;</kbd> key <em>and</em> the <kbd class="mod2">&nbsp;</kbd> key, and then, while keeping them both down, press the <kbd>e</kbd> key.
37 </p>
38
39 <p>
40   Note that different platforms have different conventions for which modifier key (Control or Command) to use as the primary or most common modifier. When viewing this manual from a machine identifying itself as running OS X, you will see  <kbd>Cmd&nbsp;</kbd> where appropriate (for instance in the first example above). On other machines you will see <kbd>Ctrl&nbsp;</kbd> instead.
41 </p>
42
43 <h3>Mouse Buttons</h3>
44
45 <p>
46   We refer to <a href="/setting-up-your-system/the-mouse">mouse buttons</a> as <kbd class="mouse">Left</kbd>, <kbd class="mouse">Middle</kbd> and <kbd class="mouse">Right</kbd>. Ardour can use additional buttons, but they have no default behaviour in the program.
47 </p>
48
49 <h4>Mouse click modifiers</h4>
50
51 <p>
52   Many editing functions are performed by clicking the mouse while holding a modifier key, for example <kbd class="mouse mod1">Left</kbd>.
53 </p>
54
55 <h4>Mouse wheel</h4>
56
57 <p>
58   Some GUI elements can optionally be controlled with the mouse wheel when the pointer is hovering over them. The notation for mouse wheel action is <kbd class="mouse">&uArr;</kbd> <kbd class="mouse">&lArr;</kbd> <kbd class="mouse">&dArr;</kbd> <kbd class="mouse">&rArr;</kbd>.
59 </p>
60
61 <h4>Context-click</h4>
62
63 <p>
64   The term <dfn>context-click</dfn> is used to indicate that you should (typically) <kbd class="mouse">Right</kbd>-click on a particular element of the graphical user interface. Although right-click is the common, default way to do this, there are other ways to accomplish the same thing&mdash;this term refers to any of them, and the result is always that a menu specific to the item you clicked on will be displayed.
65 </p>
66
67 <h4>"The Pointer"</h4>
68
69 <p>
70   When the manual refers to the "pointer", it means the on-screen representation of the mouse position or the location of a touch action if you are using a touch interface.
71 </p>
72
73 <h3>Other user input</h3>
74
75 <p>
76   Ardour supports hardware controllers, such as banks of <kbd class="fader">faders</kbd>, <kbd class="knob">knobs</kbd>, or <kbd class="button">buttons</kbd>.
77 </p>
78
79 <h3>Menu Items</h3>
80
81 <p>
82   Menu items are indicated like this:<br />
83   <kbd class="menu">Top &gt; Next &gt; Deeper</kbd>.<br />
84   Each "&gt;"-separated item indicates one level of a nested (sub-)menu.
85 </p>
86
87 <h3>Preference/Dialog Options</h3>
88
89 <p>
90   Choices in various dialogs, notably the Preferences and Properties dialog, are
91   indicated like this:<br />
92   <kbd class="option">Edit &gt; Preferences &gt; Audio &gt; Some
93   Option</kbd>.<br />
94   Each successive item indicates either a (sub-) menu or a tabbed dialog
95   navigation. The final item is the one to choose or select.
96 </p>
97
98 <p>
99   If you are requested to deselect an option, you will see something like
100   this:<br />
101   <kbd class="optoff">Edit &gt; Preferences &gt; Audio &gt; Some other
102   Option</kbd>.<br />
103 </p>
104
105 <h3>User Input</h3>
106
107 <p>
108   Some dialogs or features may require you to type in some <kbd class="input">data such as this</kbd>. In rare cases, you will be required to perform certain operations at the command line of your operating system:
109 </p>
110
111 <kbd class="cmd lin">cat /proc/cpuinfo</kbd>
112 <kbd class="cmd mac">sleep 3600</kbd>
113 <kbd class="cmd win">ping www.google.com</kbd>
114
115 <h3>Program Output</h3>
116
117 <p>
118   Important messages from Ardour or other programs will be displayed <samp>like this</samp>.
119 </p>
120
121 <h3>Notes</h3>
122
123 <p class="note">
124   Important notes about things that might not otherwise be obvious are shown in this format.
125 </p>
126
127 <h3>Warnings</h3>
128
129 <p class="warning">
130   Hairy issues that might cause things to go wrong, lose data, impair sound quality, or eat your proverbial goldfish, are displayed in this way.
131 </p>
132
133
134 ---
135 title: Welcome to Ardour!
136 part: subchapter
137 ---
138
139 <p>
140   <dfn>Ardour</dfn> is a professional digital workstation for working with audio and MIDI.
141 </p>
142
143 <h2>Ardour is meant for...</h2>
144
145 <h3>Audio Engineers</h3>
146
147 <p>
148   Ardour's core user group: people who want to record, edit, mix and master audio and MIDI projects. When you need complete control over your tools, when the limitations of other designs get in the way, when you plan to spend hours or days working on a session, Ardour is there to make things work the way you want them to.
149 </p>
150
151 <h3>Musicians</h3>
152
153 <p>
154   Being the best tool to record talented performers on actual instruments has always been a top priority for Ardour. Rather than being focused on electronic and pop music idioms, Ardour steps out of the way to encourage the creative process to remain where it always has been: a musician playing a carefully designed and well built instrument.
155 </p>
156
157 <h3>Soundtrack Editors</h3>
158
159 <p>
160   Sample accurate sync and shared transport control with video playback tools allows Ardour to provide a fast and natural environment for creating and editing soundtracks for film and video projects.
161 </p>
162
163 <h3>Composers</h3>
164
165 <p>
166   Arrange audio and MIDI using the same tools and same workflow. Use external hardware synthesizers or software instruments as sound sources. From sound design to electro-acoustic composition to dense multitrack MIDI editing, Ardour can help.
167 </p>
168
169 <h2>Ardour features...</h2>
170
171 <h3>Audio and MIDI Multi-Track Recording and Editing</h3>
172
173 <p>
174   Any number of tracks and busses. Non-linear editing. Non-destructive (and destructive!) recording. Any bit depth, any sample rate. Dozens of file formats.
175 </p>
176
177 <h3>Plugins with Full Sample Accurate Automation</h3>
178
179 <p>
180   AudioUnit, LV2, LinuxVST and LADSPA formats. FX plugins. Software instruments. MIDI processors. Automate any parameters. Physically manipulate them via control surfaces. Distribute processing across as many (or as few) cores as you want.
181 </p>
182
183 <h3>Transport Sync and External Control Surfaces</h3>
184
185 <p>
186   Best-in-industry sync to MIDI timecode and LTC. Send and receive MIDI Machine Control. Sync with JACK transport and MIDI clock. Dedicated Mackie Control protocol support, pre-defined mappings for many MIDI controllers plus dynamic MIDI learn. Use OSC to drive almost any operation in Ardour.
187 </p>
188
189 <h3>Powerful Anywhere-to-Anywhere Signal Routing</h3>
190
191 <p>
192   Complex signal flows are simple and elegant. Inputs and outputs connect to your hardware and/or other applications. Use sends, inserts and returns freely. Connections can be one-to-many, many-to-one or many-to-many. Tap signal flows at any point. If you can't connect in the way you want with Ardour, it probably can't be done.
193 </p>
194
195 <h3>Video Timeline</h3>
196
197 <p>
198   Import a single video and optionally extract the soundtrack from it. Display a frame-by-frame (thumbnail) timeline of the video. Use a Video-monitor window, or full-screen display, of the imported video in sync with any of the available ardour timecode sources. Lock audio-regions to the video: Move audio-regions with the video at video-frame granularity. Export the video, cut start/end, add blank frames and/or mux it with the soundtrack of the current-session.
199 </p>
200
201 ---
202 title: About Ardour
203 part: subchapter
204 ---
205
206 <p>
207   <dfn>Ardour</dfn> allows recording and editing both audio and MIDI data, addin of many different kinds of effects and mixing.
208 </p>
209
210 <p>Some things Ardour is used for include:</p>
211
212 <ul>
213 <li>Digitally record acoustic/electric instruments or vocals</li>
214 <li>Compose and arrange audio and MIDI tracks</li>
215 <li>Edit live recordings</li>
216 <li>Mix and edit movie soundtracks and dialogue</li>
217 <li>Create sound designs for an arbitrary number of output channels</li>
218 </ul>
219
220 ---
221 title: Isn't This A Really Complicated Program?
222 part: subchapter
223 ---
224
225 <p>
226  There is no point in pretending that Ardour is a simple, easy to use program. The development group has worked hard to try to make simple things reasonably easy, common tasks quick, and hard and/or uncommon things possible. There is no doubt that there is more to do in this area, as well as polishing the user interface to improve its intuitiveness and work flow characteristics.
227 </p>
228
229 <p>
230   At the same time, multi-track, multi-channel, non-linear, non-destructive audio editing is a far from simple process. Doing it right requires not only a good ear, but a solid appreciation of basic audio concepts and a robust mental model/metaphor of what one is doing. Ardour is not a simple "audio recorder"&mdash;it can certainly be used to record stereo (or even mono) material in a single track, but the program has been designed around much richer capabilities than this.
231 </p>
232
233 <p>
234   Some people complain that Ardour is not "intuitive" to use&mdash;its lead developer has <a href="http://community.ardour.org/node/3322">some thoughts on that</a>.
235 </p>
236
237 ---
238 title: Why Write a DAW for Linux?
239 part: subchapter
240 ---
241
242 <p>
243   It is fairly understandable that existing proprietary DAWs do not run on Linux, given the rather small (but growing) share of the desktop market that Linux has. However, when surveying the landscape of "popular operating systems", we find:
244 </p>
245
246 <ul>
247   <li>older versions of Windows: plagued by abysmal stability and appalling security</li>
248   <li>newer versions of Windows seem stable but still suffer from security problems</li>
249   <li>OS X: an amazing piece of engineering that is excellent for audio work but only runs on proprietary hardware and still lacks the flexibility and adaptability of Linux.</li>
250 </ul>
251
252 <p>
253   Security matters today, and will matter more in the future as more and more live or semi-live network based collaborations take place.
254 </p>
255
256 <p>
257   Let's contrast this with Linux, an operating system which:
258 </p>
259
260 <ul>
261   <li>can stay up for months (or even years) without issues</li>
262   <li>is endlessly configurable down to the tiniest detail</li>
263   <li>is not owned by any single corporate entity, ensuring its life and direction are not intertwined with that of a company (for a contrary example, consider BeOS)</li>
264   <li>is fast and efficient</li>
265   <li>runs on almost any computing platform ever created, including old "slow" systems and new "tiny" systems (e.g. Raspberry Pi)</li>
266   <li>is one of the most secure operating systems "out of the box"</li>
267 </ul>
268
269 <p>
270   More than anything, however, Ardour's primary author uses Linux and wanted a DAW that ran there.
271 </p>
272
273 <p>
274   Having written a DAW for Linux, it turned out to be relatively easy to port Ardour to OS X, mostly because of the excellent work done by the JACK OS X group that ported JACK to OS X.
275 </p>
276
277 <p>
278   Although OS X has a number of disadvantages compared to Linux, its ease of use and its presence in many studios already makes it a worthwhile platform.
279 </p>
280
281 ---
282 title: Why is it called Ardour?
283 part: subchapter
284 ---
285
286 <p>
287   The name <dfn>"Ardour"</dfn> came from considerations of how to pronounce the acronym <abbr title="Hard Disk Recorder">HDR</abbr>. The most obvious attempt sounds like a vowelless "harder" and it then was then a short step to an unrelated but slightly homophonic word:
288 </p>
289
290 <blockquote><p>
291   <dfn>ardour</dfn> n 1: a feeling of strong eagerness (usually in favor of
292   a person or cause); "they were imbued with a revolutionary ardor"; "he
293   felt a kind of religious zeal" [syn: ardor, elan, zeal]<br />
294   2: intense feeling of love [syn: ardor]<br />
295   3: feelings of great warmth and intensity; "he spoke with great ardor"
296   [syn: ardor, fervor, fervour, fervency, fire, fervidness]
297 </p></blockquote>
298
299 <p>
300   Given the work required to develop Ardour, and the personality of its primary author, the name seemed appropriate even without the vague relationship to HDR.
301 </p>
302
303 <p>
304   Years later, another interpretation of "Ardour" appeared, this time based on listening to non-native English speakers attempt to pronounce the word. Rather than "Ardour", it became "Our DAW", which seemed poetically fitting for a Digital Audio Workstation whose source code and design belongs to a group of collaborators.
305 </p>
306
307 ---
308 title: Why write another DAW?
309 part: subchapter
310 ---
311
312 <p>
313   There are already a number of excellent digital audio workstations. To mention just a few: ProTools, Nuendo, Samplitude, Digital Performer, Logic, Cubase (SX), Sonar, along with several less well known systems such as SADIE, SAWStudio and others.
314 </p>
315 <p>
316   Each of these programs has its strengths and weaknesses, although over the last few years most of them have converged on a very similar set of core features. However, each of them suffers from two problems when seen from the perspective of Ardour's development group:
317 </p>
318
319 <ul>
320   <li>they do not run natively on Linux</li>
321   <li>they are not available in source code form, making modifications, improvements, bugfixes by technically inclined users or their friends or consultants impossible.</li>
322 </ul>
323
324 ---
325 title: Additional Resources
326 part: subchapter
327 ---
328
329 <p>
330   In addition to this documentation, you may check a variety of other <dfn>resources</dfn>:
331 </p>
332
333 <ul>
334   <li>the <a href="https://ardour.org/whatsnew.html">Ardour release
335   notes</a></li>
336   <li>the <a href="https://community.ardour.org/forums">Ardour
337   Forums</a></li>
338   <li>information about <a href="https://community.ardour.org/community">Ardour
339   Support</a> via mailing lists and IRC (chat)</li>
340 </ul>
341
342 <p>
343   The <dfn>IRC channels</dfn> in particular are where most of the day-to-day development and debugging is done, and there are plenty of experienced users to help you if you run into problems.
344 </p>
345
346 <p>
347   Please be prepared to hang around for a few hours, the chat is usually busiest from 19:00&nbsp;UTC to 04:00&nbsp;UTC. If you can, keep your chat window open, so that you don't miss a belated answer. Also, don't ask for permission to ask a question, just ask your question with the understanding that the answer (from the "right" people or not) could come seconds, minutes, hours, or never.
348 </p>
349
350
351 ---
352 title: Creating Music with Ardour
353 part: subchapter
354 ---
355
356 <p class="fixme"> misplaced</p>
357 <p>
358   Ardour can be used in many different ways, from extremely simple to
359   extremely complex. Many projects will be handled using the following
360   kind of <dfn>workflow</dfn>.
361 </p>
362
363 <h2>Stage 1: Creating Your Project</h2>
364
365 <p>
366   The first step is to create a new <dfn>session</dfn>, or open an
367   existing one. A session consists of a folder containing a session file
368   that defines all the information about the session. All media files used
369   by the session can be stored within the session folder.
370 </p>
371
372 <p>
373   More details on sessions can be found in
374 <a href="/working-with-sessions">Working With Sessions</a>.
375 </p>
376
377 <h2>Stage 2: Creating and Importing Audio and MIDI data</h2>
378
379 <p>
380   Once you have a session, you will want to add some audio and/or MIDI
381   material to it, which can be done in one of 3 ways:
382 </p>
383
384 <ul>
385   <li><dfn>Record</dfn> incoming audio or MIDI data, either via audio or MIDI hardware
386   connected to your computer, or from other applications.</li>
387   <li><dfn>Create</dfn> new MIDI data using the mouse and/or various dialogs</li>
388   <li><dfn>Import</dfn> existing media files into the session</li>
389 </ul>
390 <p>
391   <dfn>MIDI recordings</dfn> consist of performance data ("play note X at
392   time T") rather than actual sound. As a result, they are more flexible
393   than actual audio, since the precise sound that they will generate when
394   played depends on where you send the MIDI to.<br />
395   Two different synthesizers may produce very different sound in response
396   to the same incoming MIDI data.
397 </p>
398 <p>
399   <dfn>Audio recordings</dfn> can be made from external instruments with
400   electrical outputs (keyboards, guitars etc.) or via microphones from
401   acoustic instruments.
402 </p>
403 <p>
404   Ardour uses the <dfn>JACK Audio Connection Kit</dfn> for all audio and
405   MIDI I/O, which means that recording audio/MIDI from other applications
406   is fundamentally identical to recording audio/MIDI from your audio/MIDI
407   hardware.
408 </p>
409
410 <h2>Stage 3: Editing and Arranging</h2>
411 <p>
412   Once you have some material within the session, you can start to arrange
413   it in time. This is done in one of the two main windows of Ardour, the
414   <dfn>Editor</dfn> window.
415 </p>
416 <p>
417   Your audio/MIDI data appears in chunks called <dfn>regions</dfn>, which
418   are arranged into horizontal lanes called <dfn>tracks</dfn>. Tracks are
419   stacked vertically in the Editor window. You can copy, shorten, move,
420   and delete regions without changing the actual data stored in the session
421   at all&mdash;Ardour is a <dfn>non-destructive</dfn> editor. (Almost)
422   nothing that you do while editing will ever modify the files stored on
423   disk (except the session file itself).
424 </p>
425 <p>
426   You can also carry out many <dfn>transformations</dfn> to the contents
427   of regions, again without altering anything on disk. You can alter,
428   move, and delete MIDI notes, and remove silence from audio regions, for
429   example.
430 </p>
431
432 <h2>Stage 4: Mixing and Adding Effects</h2>
433 <p>
434   Once you have the arrangement of your session mostly complete, you will
435   typically move on to the <dfn>mixing</dfn> phase. Mixing is a broad term
436   to cover the way the audio signals that your session generates during
437   playback and processed and added together into a final result that you
438   actually hear. It can involve altering the relative levels of various
439   parts of the session, adding effects that improve or transform certain
440   elements, and others that bring the sound of the whole session to a new
441   level.
442 </p>
443 <p>
444   Ardour will allow you to <dfn>automate</dfn> changes to any mixing
445   parameters (such as volume, panning, and effects controls)&mdash;it will
446   record the changes you make over time, using a mouse or keyboard or some
447   external control device, and can play back those changes later. This is
448   very useful because often the settings you need will vary in one part of
449   a session compared to another&mdash;rather than using a single setting
450   for the volume, you may need increases followed by decreases (for example,
451   to track the changing volume of a singer). Using automation can make all
452   of this relatively simple.
453 </p>
454
455 <h2>Stage 5: Export</h2>
456 <p>
457   Once you are really satisfied with the arrangement and mix of your
458   session, you will typically want to produce a single audio file that
459   contains a ready-to-listen to version of the work. Ardour will allow you to
460   <dfn>export</dfn> audio files in a variety of formats (simultaneously in
461   some cases). This exported file would typically be used in creating a CD,
462   or be the basis for digital distribution of the work.
463 </p>
464 <p>
465   Of course sometimes you will want to do export material that isn't finished
466   yet, for example to give a copy to someone else to try to mix on their own
467   system. Ardour will allow you to export as much of a session as you want, at
468   any time, in any supported format.
469 </p>
470
471
472 ---
473 title: Ardour Concepts
474 part: chapter
475 ---
476
477
478 ---
479 title: Understanding Basic Concepts and Terminology
480 part: subchapter
481 ---
482
483 <p>
484   This section will help you get acquainted with the basic terminology and
485   concepts associated with Ardour. More detailed information on each aspect
486   of the program is provided in later chapters.
487 </p>
488
489 <h2>Sessions</h2>
490 <p>
491   An <dfn>Ardour session</dfn> is a container for an entire project. A
492   session may contain an arbitrary number of <dfn>tracks</dfn> and
493   <dfn>busses</dfn> consisting of audio and <abbr title="Musical Instrument
494   Digital Interface">MIDI</abbr> data, along with
495   information on processing those tracks, a mix of levels, and everything
496   else related to the project. A session might typically contain a song, or
497   perhaps an entire album or a complete live recording.
498 </p>
499 <p>
500   Ardour sessions are held in directories; these directories contain one or
501   more <dfn>session files</dfn>, some or all of the audio and MIDI data and
502   a number of other state files that Ardour requires. The session file
503   describes the structure of the session, and holds automation data and
504   other details.
505 </p>
506 <p>
507   Ardour's session file is kept in
508   <abbr title="eXtensible Markup Language">XML</abbr> format, which is
509   advantageous as it is somewhat human-readable, and human-editable in a
510   crisis. Sound files are stored in one of a number of optional formats, and
511   MIDI files as <abbr title="Standard MIDI File">SMF</abbr>.
512 </p>
513 <p>
514   It is also possible for Ardour sessions to reference sound and MIDI files
515   outside the session directory, to conserve disk space and avoid
516   unnecessary copying if the data is available elsewhere on the disk.
517 </p>
518 <p>
519   Ardour has a single current session at all times; if Ardour is started
520   without specifying one, it will offer to load or create one.
521 </p>
522 <p>
523   More details can be found at
524   <a href="/working-with-sessions">Working With Sessions</a>.
525 </p>
526
527 <h2>Tracks</h2>
528 <p>
529   A <dfn>track</dfn> is a concept common to most
530   <abbr title="Digital Audio Workstation">DAWs</abbr>, and also used in
531   Ardour. Tracks can record audio or MIDI data to disk, and then replay
532   it with processing. They also allow the audio or MIDI data to be edited
533   in a variety of different ways.
534 </p>
535 <p>
536   In a typical pop production, one might use a track each for the kick
537   drum, another for the snare, more perhaps for the drum overheads and
538   others for bass, guitars and vocals.
539 </p>
540 <p>
541   Ardour can record to any number of tracks at one time, and then play
542   those tracks back. On playback, a track's recordings may be processed by
543   any number of plugins, panned, and its level altered to achieve a
544   suitable mix.
545 </p>
546 <p>
547   A track's type is really only related to the type of data that it stores
548   on disk. It is possible, for example, to have a MIDI track with a
549   synthesizer plugin which converts MIDI to audio. Even though the track
550   remains MIDI (in the sense that its on-disk recordings are MIDI), its
551   output may be audio-only.
552 </p>
553 <p>
554   More details can be found at
555   <a href="/working-with-tracks">Working With Tracks</a>.
556 </p>
557
558 <h2 id="busses">Busses</h2>
559 <p>
560   <dfn>Busses</dfn> are another common concept in both DAWs and hardware
561   mixers. They are similar in many ways to tracks; they process audio or
562   MIDI, and can run processing plugins. The only difference is that their
563   input is obtained from other tracks or busses, rather than from disk.
564 </p>
565 <p>
566   One might typically use a bus to collect together the outputs of related
567   tracks. Consider, for example, a 3-track recording of a drum-kit; given
568   kick, snare and overhead tracks, it may be helpful to connect the output
569   of each to a bus called "drums", so that the drum-kit's level can be set
570   as a unit, and processing (such as equalisation or compression) can be
571   applied to the mix of all tracks. Such buses are also called
572   <dfn>groups</dfn>.
573 </p>
574
575 <h2>Regions</h2>
576 <p>
577   A track may contain many segments of audio or MIDI. Ardour contains
578   these segments in things called <dfn>regions</dfn>, which are
579   self-contained snippets of audio or MIDI data. Any recording pass, for
580   example, generates a region on each track that is enabled for recording.
581   Regions can be subjected to many editing operations; they may be moved
582   around, split, trimmed, copied, and so on.
583 </p>
584 <p>
585   More details can be found at
586   <a href="/working-with-regions">Working With Regions</a>.
587 </p>
588
589 <h2>Playlists</h2>
590 <p>
591   The details of what exactly each track should play back is described by a
592   <dfn>playlist</dfn>. A playlist is simply a list of regions; each track
593   always has an active playlist, and can have other playlists which can be
594   switched in and out as required.
595 </p>
596 <p>
597   More details can be found at
598   <a href="/working-with-playlists">Working With Playlists</a>.
599 </p>
600
601 <h2>Plugins</h2>
602 <p>
603   Ardour allows you to process audio and MIDI using any number of
604   <dfn>plugins</dfn>. These are external pieces of code, commonly seen as
605   VST plugins on Windows or AU plugins on Mac OS X. Ardour supports
606   the following plugin standards:
607 </p>
608 <dl class="wide-table">
609   <dt><abbr title="Linux Audio Developers' Simple Plugin API">LADSPA</abbr></dt>
610   <dd>the first major plugin standard for Linux. Many LADSPA plugins are
611   available, mostly free and open-source.</dd>
612   <dt><abbr title="LADSPA Version 2">LV2</abbr></dt>
613   <dd>the successor to LADSPA. Lots of plugins have been ported from
614   LADSPA to LV2, and also many new plugins written.</dd>
615   <dt><abbr title="Virtual Studio Technology">VST</abbr></dt>
616   <dd>Ardour supports VST plugins that have been compiled for Linux.</dd>
617   <dt><abbr title="Audio Units">AU</abbr></dt>
618   <dd>Mac OS X versions of Ardour support AudioUnit plugins.</dd>
619 </dl>
620 <p>
621   Ardour has some support for running Windows VST plugins on Linux, but
622   this is rather complicated, extremely difficult for the Ardour
623   developers to debug, and generally unreliable, as it requires to run a
624   large amount of Windows code in an emulated environment.<br />
625   If it is at all possible, you are strongly advised to use native
626   LADSPA, LV2 or Linux VST plugins on Linux, or AU on Mac OS X.
627 </p>
628 <p>
629   More details can be found at
630   <a href="/working-with-plugins">Working With Plugins</a>.
631 </p>
632
633
634 ---
635 title: Basic GUI Operations
636 part: subchapter
637 ---
638
639 <p>
640   Ardour offers a number of different ways for you to interact with it.
641   This chapter provides information on basic techniques for <dfn>entering
642   text</dfn>, <dfn>making selections</dfn>, and <dfn>using shortcuts</dfn>.
643 </p>
644
645 ---
646 title: Interface Elements
647 part: subchapter
648 ---
649
650 <h2>Checkboxes</h2>
651 <h2>Buttons</h2>
652 <h2>Pull Down Menus</h2>
653 <h2>Pop Up Menus</h2>
654 <h2>Context Menus</h2>
655 <h2>Browsers</h2>
656
657 <p class="fixme">Add content</p>
658
659 ---
660 title: Key Bindings
661 part: subchapter
662 ---
663
664 <p>
665   Almost every available function in Ardour can be executed via a
666   <dfn>key binding</dfn> or <dfn><abbr title="Open Sound
667   Control">OSC</abbr></dfn> command. There are many more functions
668   available than there are keys on even the largest current computer
669   keyboards, so only a subset of them are bound to keys by default.
670 </p>
671
672 <h2>Key bindings for menu items</h2>
673
674 <p>
675   Existing key bindings in menus are listed on the right side of the
676   menu items.
677 </p>
678
679 <p>
680   To create a custom key binding for a menu item quickly, navigate to
681   the relevant (sub-) menu, hover over the item with the mouse and press
682   the desired combination of modifiers and key.
683 </p>
684
685 <p class="warning">
686   Ardour will silently re-assign the binding if you use a key
687   combination that is already in use, possibly removing a standard
688   keyboard shortcut without warning you. That might lead to confusion
689   when you ask other users for help, and they explain something in terms
690   of a standard key binding, which will then have a completely
691   different effect on your system.
692 </p>
693
694 <h2>Key binding editor</h2>
695
696 <p>
697   For a complete overview of all existing keyboard bindings, go to
698   <kbd class="menu">Window &gt; Key Bindings</kbd>. This widget will let
699   you view and edit even those functions that are not available in the menu,
700   and even remove key bindings altogether.
701 </p>
702
703 ---
704 title: Selection Techniques
705 part: subchapter
706 ---
707
708 <p>
709   Ardour follows the conventions used by most other computer software
710   (including other DAWs) for <dfn>selecting objects</dfn> in the
711   <abbr title="Graphical User Interface">GUI</abbr>.
712 </p>
713
714 <h2>Selecting individual objects</h2>
715
716 <p>
717   Clicking on an object (sometimes on a particular part of its
718   on-screen representation) will select the object, and deselect other
719   similar objects.
720 </p>
721
722 <h2>Selecting multiple (similar) objects</h2>
723
724 <p>
725   A <kbd class="mod1 mouse">left</kbd> click on an object toggles its
726   <samp>selected</samp> status, so using <kbd class="mod1 mouse">left</kbd>
727   on a series of objects will select (or deselect) each one of them. You can
728   construct completely arbitrary selections with this technique.
729 </p>
730
731 <h2>Selecting a range of objects</h2>
732
733 <p>
734   In cases where the idea of "select all objects between this one and that
735   one" makes sense, you can select one object and then click
736   <kbd class="mod3 mouse">left</kbd> on another to select both of them as
737   well as all objects in between.
738 </p>
739
740 <h2>Time range selection</h2>
741
742 <p>
743   To select a time <dfn>range</dfn> in the Editor,
744   click <kbd class="mouse">Left</kbd> and drag the mouse.
745   A <kbd class="mod1 mouse">Left</kbd> drag then lets you create other
746   ranges and a <kbd class="mod3 mouse">left</kbd> click extends a range
747   to cover a wider area.
748 </p>
749
750 <h2>Selection Undo</h2>
751
752 <p>
753   The set of objects (including time range) that are selected at any one
754   time is known as the selection.
755   Each time you select or deselect an object, the new selection is stored in an
756   undo/redo stack.
757   This stack is cleared each time the content of the timeline changes.
758   If you have built up a complex selection and then accidentally cleared it,
759   choosing <kbd class="menu">Edit &gt; Undo Selection Change</kbd> will restore your previous selection.
760   If you then decide that you had in fact made the correct change, choosing
761   <kbd class="menu">Edit &gt; Redo Selection Change</kbd> will take you back
762   to where you were before you chose <kbd class="menu">Edit &gt; Undo Selection Change</kbd>.
763 </p>
764
765 ---
766 title: Tooltips
767 part: subchapter
768 ---
769
770 <p>
771   By default, Ardour will show helpful <dfn>tooltips</dfn> about
772   the purpose and use of each <abbr title="Graphical User
773   Interface">GUI</abbr> element if you position the pointer
774   over it and hover there for a short while.
775   These little pop-up messages can be a good way to discover the
776   purpose of many aspects of the GUI.
777 </p>
778
779 <p>
780   Pop-ups can be distracting for experienced users, who may opt to
781   disable them via <kbd class="optoff">Edit &gt; Preferences &gt; GUI &gt;
782   Show tooltip if mouse hovers over a control</kbd>.
783 </p>
784
785 ---
786 title: Undo/Redo for Editing
787 part: subchapter
788 ---
789
790 <p>
791   While editing, it happens that you apply an unintended change, or make
792   a choice one that you later decide was wrong. All changes to the
793   arrangement of session components (regions, control points) along the
794   timeline can be <dfn>undone</dfn> (and <dfn>redone</dfn> if necessary).
795 </p>
796
797 <p>
798   The default keybindings are <kbd class="mod1">Z</kbd> for Undo and
799   <kbd class="mod1">R</kbd> for Redo. These match the conventions of most
800   other applications that provide undo/redo.
801 </p>
802
803 <p>
804   Changes are also saved to the <dfn>session history</dfn> file, so that
805   undo/redo is possible even if you close the session and reopen it later,
806   even if you quit Ardour in between.
807 </p>
808
809 <p>
810   The maximum number of changes that can be undone can be configured under
811   <kbd class="menu">Edit &gt; Preferences &gt; Misc &gt; Undo</kbd>.
812   The maximum number of changes stored in the history file is a separate
813   parameter, and can also be set in the same place.
814 </p>
815
816 <p class="note">
817   In addition to the normal undo (which works only on actions that change
818   the timeline), there is a <dfn>visual undo</dfn> which will revert any
819   command that affects the display of the editor window. Its shortcut is
820   <kbd class="mod3">Z</kbd>.
821   There is also an undo for selection. See
822   <a href="/ardours-interface/basic-gui-operations/selection-techniques/">Selection Techniques</a> for more information.
823 </p>
824
825 <p class="warning">
826   Note that changes made to mixer strips, such as turning knobs or changing faders, cannot be undone.
827 </p>
828
829 ---
830 title: Using the Mouse
831 part: subchapter
832 ---
833
834 <h2>Clicking</h2>
835
836 <p>
837   Throughout this manual, the term <dfn>click</dfn> refers to the act of pressing
838   and releasing the <kbd class="mouse">Left</kbd> mouse button. This action is used to select objects, activate
839   buttons, turn choices on and off, pop up menus and so forth.<br />
840   On touch surfaces, it also corresponds to a single, one-finger tap on
841   the GUI.
842 </p>
843
844 <h2>Right Clicking</h2>
845
846 <p>
847   The term <dfn>right-click</dfn> refers to the act of pressing and releasing
848   the <kbd class="mouse">Right</kbd> mouse button.
849   This action is used to pop up <dfn>context menus</dfn> (hence the term
850   "context click", which you will also see). It is also used by default in
851   combination with the shift key to delete objects within the editor
852   window.
853 </p>
854
855 <p class="note mac">
856   Some mice designed for use with Mac OS X may have only one button. By
857   convention, pressing and holding the Control key while clicking is
858   interpreted as a right-click by many application..
859 </p>
860
861 <h2>Middle Clicking</h2>
862
863 <p>
864   A <dfn>middle-click</dfn> refers to the act of pressing and releasing the
865   <kbd class="mouse">Middle</kbd> mouse button. Not all all mice have a middle click button
866   (see the <a href="/setting-up-your-system/mouse/">Mouse</a> chapter for
867   details). Sometimes the scroll wheel acts as a clickable middle button.
868   This action is used for time-constrained region copying and mapping MIDI
869   bindings.
870 </p>
871
872 <p class="note">
873   Internally, your operating system may identify the mouse buttons as
874   <kbd class="mouse">Button1</kbd>, <kbd class="mouse">Button2</kbd>, and
875   <kbd class="mouse">Button3</kbd>, respectively. It may be possible to
876   invert the order of buttons to accommodate left-handed users, or to re-assign
877   them arbitrarily. This manual assumes the canonical order.
878 </p>
879
880 <h2>Double Clicking</h2>
881
882 <p>
883   A <dfn>double click</dfn> refers to two rapid press/release cycles on the
884   leftmost mouse button. The time interval between the two actions that
885   determines whether this is seen as two clicks or one double click is
886   controlled by your system preferences, not by Ardour.
887 </p>
888
889 <h2>Dragging</h2>
890
891 <p>
892   A <dfn>drag</dfn> primarily refers to the act of pressing the leftmost
893   mouse button, moving the mouse with the button held down, and then
894   releasing the button. On touch surfaces, this term also corresponds to
895   a single one-finger touch-move-release action.
896 </p>
897
898 <p>
899   Ardour also uses the middle mouse button for certain kinds of drags,
900   which will be referred to as <dfn>middle-drag</dfn>.
901 </p>
902
903 <h2>Modifiers</h2>
904
905 <p>
906   There are many actions in Ardour that can be carried out using a mouse
907   button in combination with a <dfn>modifier key</dfn>. When the manual
908   refers to <kbd class="mod1 mouse">Left</kbd>, it means that you should first
909   press the <kbd class="mod1"></kbd> key, carry out a left click
910   while <kbd class="mod1"></kbd> is held down, and then finally release the key.
911 </p>
912
913 <p>
914   Available modifiers depend on your platform:
915 </p>
916
917 <h3>Linux Modifiers</h3>
918
919 <ul>
920   <li><kbd>Ctrl</kbd> (Control)</li>
921   <li><kbd>Shift</kbd></li>
922   <li><kbd>Alt</kbd></li>
923   <li><kbd>Mod2</kbd></li>
924   <li><kbd>Mod3</kbd></li>
925   <li><kbd>Mod4</kbd></li>
926   <li><kbd>Mod5</kbd></li>
927 </ul>
928
929 <p class="warning">
930   The following section is almost certainly wrong. Will need to be checked
931   and rewritten asap.
932 </p>
933
934 <p>
935   Mod2 typically corresponds to the <kbd>NumLock</kbd> key on many systems.
936   On most Linux systems, there are no keys that will function as modifiers
937   Mod3, Mod4 or Mod5 by default, but they can be setup using
938   <dfn>xmodmap(1)</dfn>. This can be rather useful.
939 </p>
940
941 <h3>OS X Modifiers</h3>
942
943 <ul>
944   <li><kbd>Cmd</kbd> (Command, "windmill")</li>
945   <li><kbd>Ctrl</kbd> (Control)</li>
946   <li><kbd>Alt</kbd>  (Option)</li>
947   <li><kbd>Shift</kbd></li>
948 </ul>
949
950 <h2>Scroll Wheel</h2>
951
952 <p>
953   Ardour can make good use of a <dfn>scroll wheel</dfn> on your mouse, which can be
954   utilized for a variety of purposes. Scroll wheels generate vertical
955   scroll events, <kbd class="mouse">&uArr;</kbd> (ScrollUp) and
956   <kbd class="mouse">&dArr;</kbd> (ScrollDown). Some also emit horizontal
957   events, <kbd class="mouse">&lArr;</kbd> (ScrollLeft) and
958   <kbd class="mouse">&rArr;</kbd> (ScrollRight).
959 </p>
960
961 <p>
962   When appropriate, Ardour will differentiate between these two different
963   scroll axes. Otherwise it will interpret ScrollDown and ScrollLeft as
964   equivalent and similarly interpret ScrollUp and ScrollRight as equivalent.
965 </p>
966
967 <p>
968   Typically, scroll wheel input is used to adjust
969   <dfn>continuous controls</dfn> such as faders and knobs, or to scroll
970   vertically or horizontally inside a window.
971 </p>
972
973 <p class="fixme">Should add some mention of drag &amp; drop operations; the "Dragging" section above doesn't mention it at all.</p>
974
975 ---
976 title: Cut and Paste Operations
977 part: subchapter
978 ---
979
980 <p>
981   The <dfn>clipboard</dfn> is a holder for various kinds of objects (regions,
982   control events, plugins) that is used during <dfn>cut-and-paste
983   operations</dfn>.
984 </p>
985
986 <h2>Cut</h2>
987
988 <p>
989   A <dfn>cut</dfn> operation removes selected objects and places them in the
990   clipboard. The existing contents of the clipboard are overwriten.<br />
991   The default key binding is <kbd class="mod1">x</kbd>.
992 </p>
993
994 <h2>Copy</h2>
995
996 <p>
997   A <dfn>copy</dfn> of the selected objects are placed in clipboard. There is
998   no effect on the selected objects themselves. The existing contents of the
999   clipboard are overwritten. <br />
1000   The default key binding is <kbd class="mod1">c</kbd>.
1001 </p>
1002
1003 <h2>Paste</h2>
1004
1005 <p>
1006   The current contents of the clipboard are <dfn>paste</dfn>d (inserted)
1007   into the session, using the current <dfn>edit point</dfn> as the
1008   destination. The contents of the clipboard remain unchanged&mdash;you
1009   can paste the same item multiple times. <br />
1010   The default key binding is <kbd class="mod1">v</kbd>.
1011 </p>
1012
1013 ---
1014 title: Deleting Objects
1015 part: subchapter
1016 ---
1017
1018 <p>
1019   Within the Editor window (and to some extent within the Mixer window too),
1020   there are several techniques for <dfn>deleting</dfn> objects (regions,
1021   control points, and more).
1022 </p>
1023
1024 <h2>Using the mouse and keyboard</h2>
1025 <p>
1026   Select the object(s) and then press the <kbd>Del</kbd> key.
1027   This does <strong>not</strong> put the deleted object(s) into the cut
1028   buffer, so they cannot be pasted elsewhere.
1029 </p>
1030
1031 <h2>Using normal cut and paste shortcuts</h2>
1032 <p>
1033   Select the object(s) and then press <kbd class="mod1">x</kbd>. This puts
1034   the deleted object(s) into the cut buffer so that they could be pasted
1035   elsewhere.
1036 </p>
1037
1038 <h2>Using just the mouse</h2>
1039 <p>
1040   By default, <kbd class="mouse">Shift Right</kbd> will delete the
1041   clicked-upon object. Like the Del key, this does <strong>not</strong>
1042   put the deleted object(s) into the cut buffer.
1043 </p>
1044 <p>
1045   The modifier and mouse button used for this can be controlled via
1046   <kbd class="menu">Edit &gt; Preferences &gt; User Interaction &gt;
1047   Delete using ...</kbd>. Any modifier and mouse button combination can
1048   be used.
1049 </p>
1050
1051
1052 ---
1053 title: Starting Ardour
1054 part: subchapter
1055 ---
1056
1057 <p>
1058   There are several ways of <dfn>starting Ardour</dfn>, which may vary
1059   depending on which platform you are using it.
1060 </p>
1061
1062 <ul>
1063   <li>double-click the Ardour icon in your platform's file manager (e.g.
1064   Nautilus on Linux, Finder on OS X)</li>
1065   <li>double click on an Ardour session file in your platform's file manager</li>
1066   <li>on Linux, you can also start Ardour <a
1067   href="/ardours-interface/starting-ardour/starting-ardour-from-the-command-line">on the command line</a></li>
1068 </ul>
1069
1070 <p>
1071   When Ardour is run for the very first time, a special dialog is displayed
1072   that will ask you several questions about your setup. You will not be asked
1073   these questions again, but you can always modify your choices via the
1074   <kbd class="menu">Edit &gt; Preferences</kbd> dialog.
1075 </p>
1076
1077 <p>
1078   If you want to use JACK, in general, it is sensible to start <em>before</em> you run Ardour. This is not necessary, but will provide you with more control and options over JACK's operation. You can start JACK through its <abbr title="Command Line Interface">CLI</abbr>, or using a  <abbr title="Graphical User Interface">GUI</abbr> program, like <a href="https://qjackctl.sourceforge.io/">QjackCtl</a> or <a href="http://kxstudio.linuxaudio.org/Applications:Cadence">Cadence</a>.
1079 </p>
1080
1081 <p>
1082   If you open Ardour without specifying an existing session it will display
1083   the <kbd class="menu">Session &gt; New...</kbd> dialog and the <kbd class="menu">Audio/MIDI Setup</kbd> dialog. See <a href="/working-with-sessions/new-session-dialog/">New/Open Session Dialog</a> for a description of those dialogs.
1084 </p>
1085
1086 <h2>Starting Ardour From the Command Line (Linux)</h2>
1087
1088 <p>
1089   Like (almost) any other program on Linux, Ardour can be started on the
1090   command line. Type the following command in a terminal window:
1091 </p>
1092 <kbd class="cmd lin">ardour5</kbd>
1093 <p>
1094   To start Ardour with an existing session:
1095 </p>
1096 <kbd class="cmd lin">ardour5 <em>/path/to/session</em></kbd>
1097 <p>
1098   replacing /path/to/session with the actual path to your session. You can
1099   specify either the session folder or any session file inside the folder,
1100   including snapshots.
1101 </p>
1102 <p>
1103   To start Ardour with a new, named session:
1104 </p>
1105 <kbd class="cmd lin">ardour5 -N <em>/path/to/session</em></kbd>
1106
1107
1108 ---
1109 title: Keyboard and Mouse Shortcuts
1110 part: chapter
1111 ---
1112
1113
1114 ---
1115 title: Default Keyboard Bindings
1116 menu_title: Key Bindings
1117 part: subchapter
1118 ---
1119
1120 <p>
1121   Almost every available function in Ardour can be bound to a keyboard
1122   shortcut (and those few that cannot will usually respond to an <a
1123   href="/using-control-surfaces/controlling-ardour-with-osc/"><abbr
1124   title="Open Sound Control">OSC</abbr> command</a>). Ardour comes with a
1125   rich set of default <dfn>key bindings</dfn> for the most commonly used
1126   functions.
1127 </p>
1128
1129 <p>These bindings strive to be <dfn>mnemonic</dfn>, that is, easy and intuitive
1130   to remember, and follow widely accepted conventions. As a general rule,
1131   the first letter of an operation will be used for as a shortcut, if
1132   available. This does not necessarily lead to the best ergonomics for
1133   rapid editing&mdash;there are alternative binding sets for that&mdash;but it does make it simpler for newcomers to remember some of the most
1134   useful ones, for example<br />
1135   <kbd>S</kbd> for <kbd class="menu">Region &gt; Edit &gt; Split"</kbd>
1136   or<br />
1137   <kbd>P</kbd> for <kbd class="menu">Transport &gt; Playhead &gt; Playhead to Mouse</kbd>.
1138 </p>
1139
1140 <p>
1141   Almost every key binding in Ardour can be changed in <kbd class="menu">Window &gt; Key Bindings</kbd>.
1142 </p>
1143
1144 <p>
1145   The conventions for using modifier keys (<kbd class="mod1">&zwnj;</kbd>, <kbd
1146   class="mod2">&zwnj;</kbd>, <kbd class="mod3">&zwnj;</kbd> etc.) differ among platforms, so we provide different default bindings for each.
1147 </p>
1148
1149 ---
1150 title: Mnemonic Bindings for Linux
1151 menu_title: Linux
1152 part: subchapter
1153 ---
1154
1155 <p>
1156   A printable cheat-sheet with the mnemonic bindings for <dfn>Linux</dfn>
1157   is available for download in
1158   <a href="/files/a3_mnemonic_cheatsheet.pdf">US Letter</a> and
1159   <a href="/files/a3_mnemonic_cheatsheet-a4.pdf">A4</a> paper format.
1160 </p>
1161
1162 <p>
1163   This set of bindings assumes an en_US keyboard. However, most if not all
1164   bindings will also work on other keyboards when you use the
1165   <kbd>AltGr</kbd> to compose those glyphs that are not directly accessible.
1166 </p>
1167
1168 <h2>Transport &amp; Recording Control</h2>
1169
1170 <dl class="bindings">
1171 <dt>destroy last recording</dt>
1172 <dd><kbd class="mod1">Del</kbd></dd>
1173 <dt>engage record</dt>
1174 <dd><kbd class="mod3">r</kbd></dd>
1175 <dt>fast forward</dt>
1176 <dd><kbd class="mod3">&rarr;</kbd></dd>
1177 <dt>loop play (the loop range)</dt>
1178 <dd><kbd class="">l</kbd></dd>
1179 <dt>rewind</dt>
1180 <dd><kbd class="mod3">&larr;</kbd></dd>
1181 <dt>set playhead position</dt>
1182 <dd><kbd class="">p</kbd></dd>
1183 <dt>start recording</dt>
1184 <dd><kbd class="mod3">Space</kbd></dd>
1185 <dt>stop (keep loop/range play)</dt>
1186 <dd><kbd class="mod12">Space</kbd></dd>
1187 <dt>stop and destroy</dt>
1188 <dd><kbd class="mod1">Space</kbd></dd>
1189 <dt>toggle auto play</dt>
1190 <dd><kbd class="">5</kbd></dd>
1191 <dt>toggle auto return</dt>
1192 <dd><kbd class="">6</kbd></dd>
1193 <dt>toggle click (metronome)</dt>
1194 <dd><kbd class="">7</kbd></dd>
1195 <dt>toggle playhead follows edits</dt>
1196 <dd><kbd class="mod3">F</kbd></dd>
1197 <dt>toggle playhead tracking</dt>
1198 <dd><kbd class="mod1">F</kbd></dd>
1199 <dt>toggle roll</dt>
1200 <dd><kbd class="">Space</kbd></dd>
1201 <dt>toggle selected track rec-enable </dt>
1202 <dd><kbd class="mod3">b</kbd></dd>
1203 <dt>toggle selected track solo status</dt>
1204 <dd><kbd class="mod2">s</kbd></dd>
1205 <dt>transition to reverse</dt>
1206 <dd><kbd class="mod3">&darr;</kbd></dd>
1207 <dt>transition to roll</dt>
1208 <dd><kbd class="mod3">&uarr;</kbd></dd>
1209 </dl>
1210
1211 <h2>Session &amp; File Handling</h2>
1212
1213 <dl class="bindings">
1214 <dt>add track(s) or bus(ses)</dt>
1215 <dd><kbd class="mod13">n</kbd></dd>
1216 <dt>export session</dt>
1217 <dd><kbd class="mod4">e</kbd></dd>
1218 <dt>import audio files</dt>
1219 <dd><kbd class="mod1">i</kbd></dd>
1220 <dt>open a new session</dt>
1221 <dd><kbd class="mod1">n</kbd></dd>
1222 <dt>open a recent session</dt>
1223 <dd><kbd class="mod13">o</kbd></dd>
1224 <dt>open an existing session</dt>
1225 <dd><kbd class="mod1">o</kbd></dd>
1226 <dt>quit</dt>
1227 <dd><kbd class="mod1">q</kbd></dd>
1228 <dt>save session</dt>
1229 <dd><kbd class="mod1">s</kbd></dd>
1230 <dt>snapshot session</dt>
1231 <dd><kbd class="mod13">s</kbd></dd>
1232 <dt>toggle selected track MIDI input</dt>
1233 <dd><kbd class="mod2">i</kbd></dd>
1234 </dl>
1235
1236 <h2>Changing What's Visible</h2>
1237
1238 <dl class="bindings">
1239 <dt>fit tracks vertically</dt>
1240 <dd><kbd class="">f</kbd></dd>
1241 <dt>move selected tracks down</dt>
1242 <dd><kbd class="mod1">&darr;</kbd></dd>
1243 <dt>move selected tracks up</dt>
1244 <dd><kbd class="mod1">&uarr;</kbd></dd>
1245 <dt>scroll down (page)</dt>
1246 <dd><kbd class="">PgDn</kbd></dd>
1247 <dt>scroll down (step)</dt>
1248 <dd><kbd class="">&darr;</kbd></dd>
1249 <dt>scroll up (page)</dt>
1250 <dd><kbd class="">PgUp</kbd></dd>
1251 <dt>scroll up (step)</dt>
1252 <dd><kbd class="">&uarr;</kbd></dd>
1253 <dt>toggle editor window mixer</dt>
1254 <dd><kbd class="mod3">e</kbd></dd>
1255 <dt>visual undo</dt>
1256 <dd><kbd class="mod3">z</kbd></dd>
1257 <dt>zoom height to selected region(s)</dt>
1258 <dd><kbd class="mod12">z</kbd></dd>
1259 <dt>zoom height and time to selected region</dt>
1260 <dd><kbd class="mod2">z</kbd></dd>
1261 <dt>zoom in</dt>
1262 <dd><kbd class="">=</kbd></dd>
1263 <dt>zoom out</dt>
1264 <dd><kbd class="">-</kbd></dd>
1265 </dl>
1266
1267 <h2>Window Visibility</h2>
1268
1269 <dl class="bindings">
1270 <dt>toggle locations dialog</dt>
1271 <dd><kbd class="mod2">l</kbd>(ell)</dd>
1272 <dt>focus on main clock</dt>
1273 <dd><kbd class="kp">&divide;</kbd></dd>
1274 <dt>maximise editor space</dt>
1275 <dd><kbd class="mod12">f</kbd></dd>
1276 <dt>switch between editor &amp; mixer window</dt>
1277 <dd><kbd class="mod2">m</kbd></dd>
1278 <dt>show rhythm ferret window </dt>
1279 <dd><kbd class="mod2">f</kbd></dd>
1280 <dt>toggle big clock</dt>
1281 <dd><kbd class="mod2">b</kbd></dd>
1282 <dt>toggle color manager</dt>
1283 <dd><kbd class="mod2">c</kbd></dd>
1284 <dt>toggle editor window</dt>
1285 <dd><kbd class="mod2">e</kbd></dd>
1286 <dt>toggle global audio patchbay</dt>
1287 <dd><kbd class="mod2">p</kbd></dd>
1288 <dt>toggle global midi patchbay</dt>
1289 <dd><kbd class="mod23">p</kbd></dd>
1290 <dt>toggle key bindings editor</dt>
1291 <dd><kbd class="mod2">k</kbd></dd>
1292 <dt>toggle preferences dialog</dt>
1293 <dd><kbd class="mod2">o</kbd></dd>
1294 <dt>toggle preferences dialog</dt>
1295 <dd><kbd class="mod13">p</kbd></dd>
1296 </dl>
1297
1298 <h2>Editing with Edit Point</h2>
1299
1300 <p>
1301   Most edit functions operate on a single <dfn>Edit Point</dfn> (EP). The edit
1302   point can be any of: playhead (default), the mouse or an active marker.
1303   The choice of edit point (by default) also sets the <dfn>Zoom Focus</dfn>.
1304 </p>
1305
1306 <dl class="bindings">
1307 <dt>EP to next region sync</dt>
1308 <dd><kbd class="">;</kbd></dd>
1309 <dt>EP to prev region sync</dt>
1310 <dd><kbd class="">'</kbd></dd>
1311 <dt>cycle to next grid snap mode</dt>
1312 <dd><kbd class="">2</kbd></dd>
1313 <dt>cycle to next zoom focus</dt>
1314 <dd><kbd class="">1</kbd></dd>
1315 <dt>insert from region list</dt>
1316 <dd><kbd class="">i</kbd></dd>
1317 <dt>insert time</dt>
1318 <dd><kbd class="mod1">t</kbd></dd>
1319 <dt>move EP to playhead</dt>
1320 <dd><kbd class="mod2">&crarr;</kbd></dd>
1321 <dt>next EP w/marker</dt>
1322 <dd><kbd class="mod1">`</kbd></dd>
1323 <dt>next EP w/o marker</dt>
1324 <dd><kbd class="">`</kbd></dd>
1325 <dt>trim back</dt>
1326 <dd><kbd class="">k</kbd></dd>
1327 <dt>trim front</dt>
1328 <dd><kbd class="">j</kbd></dd>
1329 <dt>trim region end to edit point</dt>
1330 <dd><kbd class="mod3">}</kbd></dd>
1331 <dt>trim region start to edit point</dt>
1332 <dd><kbd class="mod3">{</kbd></dd>
1333 <dt>trim region to end of prev region</dt>
1334 <dd><kbd class="mod1">j</kbd></dd>
1335 <dt>trim region to start of next region</dt>
1336 <dd><kbd class="mod1">k</kbd></dd>
1337 <dt>use previous grid unit</dt>
1338 <dd><kbd class="">3</kbd></dd>
1339 <dt>use next grid unit</dt>
1340 <dd><kbd class="">4</kbd></dd>
1341 <dt>use previous grid unit</dt>
1342 <dd><kbd class="mod1">3</kbd></dd>
1343 <dt>use next musical grid unit</dt>
1344 <dd><kbd class="mod1">4</kbd></dd>
1345 </dl>
1346
1347 <h2>Aligning with the Edit Point</h2>
1348
1349 <p>
1350   <dfn>Align operations</dfn> move regions so that their start/end/sync
1351   point is at the edit point. <dfn>Relative</dfn> operations just align the first
1352   region and moves other selected regions to maintain relative positioning.
1353 </p>
1354
1355 <dl class="bindings">
1356 <dt>align end(s)</dt>
1357 <dd><kbd class="mod2">a</kbd></dd>
1358 <dt>align start(s)</dt>
1359 <dd><kbd class="mod14">a</kbd></dd>
1360 <dt>align start(s) relative</dt>
1361 <dd><kbd class="mod4">a</kbd></dd>
1362 <dt>align sync points</dt>
1363 <dd><kbd class="mod3">a</kbd></dd>
1364 <dt>align sync points (relative)</dt>
1365 <dd><kbd class="">a</kbd></dd>
1366 <dt>range end to next prev edge</dt>
1367 <dd><kbd class="mod1">&gt;</kbd></dd>
1368 <dt>range end to next region edge</dt>
1369 <dd><kbd class="">&gt;</kbd></dd>
1370 <dt>range start to next region edge</dt>
1371 <dd><kbd class="mod1">&lt;</kbd></dd>
1372 <dt>range start to prev region edge</dt>
1373 <dd><kbd class="">&lt;</kbd></dd>
1374 </dl>
1375
1376 <h2>Edit Point Playback</h2>
1377
1378 <dl class="bindings">
1379 <dt>play edit range</dt>
1380 <dd><kbd class="mod2">Space</kbd></dd>
1381 <dt>play from EP &amp; return</dt>
1382 <dd><kbd class="mod4">Space</kbd></dd>
1383 <dt>play selected region(s)</dt>
1384 <dd><kbd class="">h</kbd></dd>
1385 </dl>
1386 <h2>Region Operations</h2>
1387
1388 <dl class="bindings">
1389 <dt>duplicate region (multi)</dt>
1390 <dd><kbd class="mod3">d</kbd></dd>
1391 <dt>duplicate region (once)</dt>
1392 <dd><kbd class="mod2">d</kbd></dd>
1393 <dt>export selected region(s)</dt>
1394 <dd><kbd class="mod14">e</kbd></dd>
1395 <dt>increase region gain</dt>
1396 <dd><kbd class="">^</kbd></dd>
1397 <dt>move to original position</dt>
1398 <dd><kbd class="mod2">o</kbd></dd>
1399 <dt>mute/unmute</dt>
1400 <dd><kbd class="mod1">m</kbd></dd>
1401 <dt>normalize</dt>
1402 <dd><kbd class="">n</kbd></dd>
1403 <dt>nudge backward</dt>
1404 <dd><kbd class="kp">&ndash;</kbd></dd>
1405 <dt>nudge forward</dt>
1406 <dd><kbd class="kp">+</kbd></dd>
1407 <dt>quantize MIDI notes </dt>
1408 <dd><kbd class="">q</kbd></dd>
1409 <dt>reduce region gain</dt>
1410 <dd><kbd class="">&amp;</kbd></dd>
1411 <dt>reverse</dt>
1412 <dd><kbd class="mod2">r</kbd></dd>
1413 <dt>set fade in length</dt>
1414 <dd><kbd class="">/</kbd></dd>
1415 <dt>set fade out length</dt>
1416 <dd><kbd class="">\</kbd></dd>
1417 <dt>set region sync point</dt>
1418 <dd><kbd class="">v</kbd></dd>
1419 <dt>split</dt>
1420 <dd><kbd class="">s</kbd></dd>
1421 <dt>toggle fade in active</dt>
1422 <dd><kbd class="mod1">/</kbd></dd>
1423 <dt>toggle fade out active</dt>
1424 <dd><kbd class="mod1">\</kbd></dd>
1425 <dt>transpose</dt>
1426 <dd><kbd class="mod2">t</kbd></dd>
1427 </dl>
1428
1429 <h2>Generic Editing</h2>
1430
1431 <dl class="bindings">
1432 <dt>copy</dt>
1433 <dd><kbd class="mod1">c</kbd></dd>
1434 <dt>cut</dt>
1435 <dd><kbd class="mod1">x</kbd></dd>
1436 <dt>delete</dt>
1437 <dd><kbd class="">Del</kbd></dd>
1438 <dt>paste</dt>
1439 <dd><kbd class="mod1">v</kbd></dd>
1440 <dt>redo</dt>
1441 <dd><kbd class="mod1">r</kbd></dd>
1442 <dt>undo</dt>
1443 <dd><kbd class="mod1">z</kbd></dd>
1444 </dl>
1445
1446 <h2>Selecting</h2>
1447
1448 <p class="note">
1449   There are  a few functions that refer to an <dfn>Edit Range</dfn>. The
1450   current edit range is defined using combinations of the possible edit
1451   points: <dfn>playhead</dfn>, <dfn>active marker</dfn>, or <dfn>mouse</dfn>.
1452 </p>
1453
1454 <dl class="bindings">
1455 <dt>all after playhead</dt>
1456 <dd><kbd class="mod13">p</kbd></dd>
1457 <dt>all before playhead</dt>
1458 <dd><kbd class="mod1">p</kbd></dd>
1459 <dt>all enclosed by edit range</dt>
1460 <dd><kbd class="mod1">u</kbd></dd>
1461 <dt>all present in edit range</dt>
1462 <dd><kbd class="">u</kbd></dd>
1463 <dt>convert edit range to range</dt>
1464 <dd><kbd class="">F6</kbd></dd>
1465 <dt>invert selection</dt>
1466 <dd><kbd class="mod3">i</kbd></dd>
1467 <dt>select all after EP</dt>
1468 <dd><kbd class="mod13">e</kbd></dd>
1469 <dt>select all before EP</dt>
1470 <dd><kbd class="mod1">e</kbd></dd>
1471 <dt>select all in loop range</dt>
1472 <dd><kbd class="mod1">l</kbd></dd>
1473 <dt>select all in punch range</dt>
1474 <dd><kbd class="mod1">d</kbd></dd>
1475 <dt>select everything</dt>
1476 <dd><kbd class="mod1">a</kbd></dd>
1477 <dt>select next track/bus</dt>
1478 <dd><kbd class="mod2">&darr;</kbd></dd>
1479 <dt>select previous track/bus</dt>
1480 <dd><kbd class="mod2">&uarr;</kbd></dd>
1481 </dl>
1482
1483 <h2>Defining Loop, Punch Range and Tempo Changes</h2>
1484
1485 <dl class="bindings">
1486 <dt>set loop range from edit range</dt>
1487 <dd><kbd class="">]</kbd></dd>
1488 <dt>set loop range from region(s)</dt>
1489 <dd><kbd class="mod2">]</kbd></dd>
1490 <dt>set punch range from edit range</dt>
1491 <dd><kbd class="">[</kbd></dd>
1492 <dt>set punch range from region(s)</dt>
1493 <dd><kbd class="mod2">[</kbd></dd>
1494 <dt>set tempo (1 bar) from edit range</dt>
1495 <dd><kbd class="">0</kbd></dd>
1496 <dt>set tempo (1 bar) from region(s)</dt>
1497 <dd><kbd class="">9</kbd></dd>
1498 </dl>
1499
1500 ---
1501 title: Mnemonic Bindings for OS X
1502 part: subchapter
1503 ---
1504
1505 <p>
1506   A <a href="/files/a3_mnemonic_cheat_sheet_osx.pdf">printable cheat sheet</a>
1507   for these bindings is available for download.
1508 </p>
1509
1510 <h2>Transport &amp; Recording Control</h2>
1511 <dl class="bindings">
1512 <dt>destroy last recording</dt>
1513 <dd><kbd class="mod1">Del</kbd></dd>
1514 <dt>engage record</dt>
1515 <dd><kbd class="mod3">r</kbd></dd>
1516 <dt>fast forward</dt>
1517 <dd><kbd class="mod3">→</kbd></dd>
1518 <dt>loop play (the loop range)</dt>
1519 <dd><kbd class="">l</kbd></dd>
1520 <dt>rewind</dt>
1521 <dd><kbd class="mod3">&larr;</kbd></dd>
1522 <dt>set playhead position</dt>
1523 <dd><kbd class="">p</kbd></dd>
1524 <dt>start recording</dt>
1525 <dd><kbd class="mod3">space</kbd></dd>
1526 <dt>stop (keep loop/range play)</dt>
1527 <dd><kbd class="mod12">space</kbd></dd>
1528 <dt>stop and destroy</dt>
1529 <dd><kbd class="mod1">space</kbd></dd>
1530 <dt>toggle auto play</dt>
1531 <dd><kbd class="">5</kbd></dd>
1532 <dt>toggle auto return</dt>
1533 <dd><kbd class="">6</kbd></dd>
1534 <dt>toggle click (metronome)</dt>
1535 <dd><kbd class="">7</kbd></dd>
1536 <dt>toggle playhead follows edits</dt>
1537 <dd><kbd class="mod3">f</kbd></dd>
1538 <dt>toggle playhead tracking</dt>
1539 <dd><kbd class="mod1">f</kbd></dd>
1540 <dt>toggle roll</dt>
1541 <dd><kbd class="">space</kbd></dd>
1542 <dt>toggle track rec-enable </dt>
1543 <dd><kbd class="mod3">b</kbd></dd>
1544 <dt>toggle track solo status</dt>
1545 <dd><kbd class="mod2">s</kbd></dd>
1546 <dt>transition to reverse</dt>
1547 <dd><kbd class="mod3">&darr;</kbd></dd>
1548 <dt>transition to roll</dt>
1549 <dd><kbd class="mod3">&uarr;</kbd></dd>
1550 </dl>
1551 <h2>Session &amp; File Handling</h2>
1552 <dl class="bindings">
1553 <dt>add track(s) or bus(ses)</dt>
1554 <dd><kbd class="mod13">n</kbd></dd>
1555 <dt>export session</dt>
1556 <dd><kbd class="mod1">e</kbd></dd>
1557 <dt>import audio files</dt>
1558 <dd><kbd class="mod1">i</kbd></dd>
1559 <dt>open a new session</dt>
1560 <dd><kbd class="mod1">n</kbd></dd>
1561 <dt>open a recent session</dt>
1562 <dd><kbd class="mod13">o</kbd></dd>
1563 <dt>open an existing session</dt>
1564 <dd><kbd class="mod1">o</kbd></dd>
1565 <dt>quit</dt>
1566 <dd><kbd class="mod1">q</kbd></dd>
1567 <dt>save session</dt>
1568 <dd><kbd class="mod1">s</kbd></dd>
1569 <dt>snapshot session</dt>
1570 <dd><kbd class="mod13">s</kbd></dd>
1571 <dt>toggle sel. track MIDI input</dt>
1572 <dd><kbd class="mod2">i</kbd></dd>
1573 </dl>
1574 <h2>Changing What's Visible</h2>
1575 <dl class="bindings">
1576 <dt>fit tracks vertically</dt>
1577 <dd><kbd class="">f</kbd></dd>
1578 <dt>move selected tracks down</dt>
1579 <dd><kbd class="mod1">&darr;</kbd></dd>
1580 <dt>move selected tracks up</dt>
1581 <dd><kbd class="mod1">&uarr;</kbd></dd>
1582 <dt>scroll down (page)</dt>
1583 <dd><kbd class="">PgDn</kbd></dd>
1584 <dt>scroll down (step)</dt>
1585 <dd><kbd class="">&darr;</kbd></dd>
1586 <dt>scroll up (page)</dt>
1587 <dd><kbd class="">PageUp</kbd></dd>
1588 <dt>scroll up (step)</dt>
1589 <dd><kbd class="">&uarr;</kbd></dd>
1590 <dt>toggle editor window mixer</dt>
1591 <dd><kbd class="mod3">e</kbd></dd>
1592 <dt>toggle last 2 zoom states</dt>
1593 <dd><kbd class="mod3">z</kbd></dd>
1594 <dt>zoom height to selected region(s)</dt>
1595 <dd><kbd class="mod1">Control+z</kbd></dd>
1596 <dt>zoom height and time to selected region</dt>
1597 <dd><kbd class="mod2">z</kbd></dd>
1598 <dt>zoom in</dt>
1599 <dd><kbd class="">=</kbd></dd>
1600 <dt>zoom out</dt>
1601 <dd><kbd class="">-</kbd></dd>
1602 </dl>
1603 <h2>Window Visibility</h2>
1604 <dl class="bindings">
1605 <dt>toggle locations dialog</dt>
1606 <dd><kbd class="mod2">l</kbd></dd>
1607 <dt>focus on main clock</dt>
1608 <dd><kbd class="kp">&divide;</kbd></dd>
1609 <dt>maximise editor space</dt>
1610 <dd><kbd class="mod12">f</kbd></dd>
1611 <dt>rotate editor &amp; mixer window</dt>
1612 <dd><kbd class="mod2">m</kbd></dd>
1613 <dt>show rhythm ferret window </dt>
1614 <dd><kbd class="mod2">f</kbd></dd>
1615 <dt>toggle big clock</dt>
1616 <dd><kbd class="mod2">b</kbd></dd>
1617 <dt>toggle color manager</dt>
1618 <dd><kbd class="mod2">c</kbd></dd>
1619 <dt>toggle editor window</dt>
1620 <dd><kbd class="mod2">e</kbd></dd>
1621 <dt>toggle global audio patchbay</dt>
1622 <dd><kbd class="mod2">p</kbd></dd>
1623 <dt>toggle global midi patchbay</dt>
1624 <dd><kbd class="mod23">p</kbd></dd>
1625 <dt>toggle key bindings editor</dt>
1626 <dd><kbd class="mod2">k</kbd></dd>
1627 <dt>toggle preferences dialog</dt>
1628 <dd><kbd class="mod2">o</kbd></dd>
1629 <dt>toggle preferences dialog</dt>
1630 <dd><kbd class="mod13">p</kbd></dd>
1631 </dl>
1632
1633 <h2>Editing with Edit Point</h2>
1634 <p>
1635   Most edit functions operate on a single <dfn>Edit Point</dfn> (EP). The
1636   edit
1637   point can be any of: playhead (default), the mouse or an active marker.
1638   The choice of edit point (by default) also sets the <dfn>Zoom Focus</dfn>.
1639 </p>
1640
1641 <dl class="bindings">
1642 <dt>EP to next region sync</dt>
1643 <dd><kbd class="">;</kbd></dd>
1644 <dt>EP to prev region sync</dt>
1645 <dd><kbd class="">'</kbd></dd>
1646 <dt>cycle to next grid snap mode</dt>
1647 <dd><kbd class="">2</kbd></dd>
1648 <dt>cycle to next zoom focus</dt>
1649 <dd><kbd class="">1</kbd></dd>
1650 <dt>insert from region list</dt>
1651 <dd><kbd class="">i</kbd></dd>
1652 <dt>insert time</dt>
1653 <dd><kbd class="mod1">t</kbd></dd>
1654 <dt>move EP to playhead</dt>
1655 <dd><kbd class="mod2">Return</kbd></dd>
1656 <dt>next EP w/marker</dt>
1657 <dd><kbd class="mod1">^</kbd></dd>
1658 <dt>next EP w/o marker</dt>
1659 <dd><kbd class="">`</kbd></dd>
1660 <dt>trim back</dt>
1661 <dd><kbd class="">k</kbd></dd>
1662 <dt>trim front</dt>
1663 <dd><kbd class="">j</kbd></dd>
1664 <dt>trim region end to edit point</dt>
1665 <dd><kbd class="mod3">}</kbd></dd>
1666 <dt>trim region start to edit point</dt>
1667 <dd><kbd class="mod3">{</kbd></dd>
1668 <dt>trim region to end of prev region</dt>
1669 <dd><kbd class="mod1">j</kbd></dd>
1670 <dt>trim region to start of next region</dt>
1671 <dd><kbd class="mod1">k</kbd></dd>
1672 <dt>use previous grid unit</dt>
1673 <dd><kbd class="">3</kbd></dd>
1674 <dt>use next grid unit</dt>
1675 <dd><kbd class="">4</kbd></dd>
1676 <dt>use previous grid unit</dt>
1677 <dd><kbd class="mod1">3</kbd></dd>
1678 <dt>use next musical grid unit</dt>
1679 <dd><kbd class="mod1">4</kbd></dd>
1680 </dl>
1681
1682 <h2>Aligning with the Edit Point</h2>
1683 <p>
1684   <dfn>Align operations</dfn> move regions so that their start/end/sync
1685   point is at the edit point. <dfn>Relative</dfn> operations just align
1686   the first region and moves other selected regions to maintain relative
1687   positioning.
1688 </p>
1689
1690 <dl class="bindings">
1691 <dt>align end(s)</dt>
1692 <dd><kbd class="mod2">a</kbd></dd>
1693 <dt>align start(s)</dt>
1694 <dd></dd>
1695 <dt>align start(s) relative</dt>
1696 <dd><kbd class=""></kbd></dd>
1697 <dt>align sync points</dt>
1698 <dd><kbd class="mod3">a</kbd></dd>
1699 <dt>align sync points (relative)</dt>
1700 <dd><kbd class="">a</kbd></dd>
1701 <dt>range end to next prev edge</dt>
1702 <dd><kbd class="mod1">&gt;</kbd></dd>
1703 <dt>range end to next region edge</dt>
1704 <dd><kbd class="">&gt;</kbd></dd>
1705 <dt>range start to next region edge</dt>
1706 <dd><kbd class="mod1">&lt;</kbd></dd>
1707 <dt>range start to prev region edge</dt>
1708 <dd><kbd class="">&lt;</kbd></dd>
1709 </dl>
1710
1711 <h2>Edit Point Playback</h2>
1712
1713 <dl class="bindings">
1714 <dt>play edit range</dt>
1715 <dd><kbd class="mod2">Space</kbd></dd>
1716 <dt>play from EP &amp; return</dt>
1717 <dd><kbd class="mod1">Space</kbd></dd>
1718 <dt>play selected region(s)</dt>
1719 <dd><kbd class="">h</kbd></dd>
1720 </dl>
1721 <h2>Region Operations</h2>
1722 <dl class="bindings">
1723 <dt>duplicate region (multi)</dt>
1724 <dd><kbd class="mod3">d</kbd></dd>
1725 <dt>duplicate region (once)</dt>
1726 <dd><kbd class="mod2">d</kbd></dd>
1727 <dt>export selected region(s)</dt>
1728 <dd></dd>
1729 <dt>increase region gain</dt>
1730 <dd><kbd class="">^</kbd></dd>
1731 <dt>move to original position</dt>
1732 <dd><kbd class="mod2">o</kbd></dd>
1733 <dt>mute/unmute</dt>
1734 <dd><kbd class="mod1">m</kbd></dd>
1735 <dt>normalize</dt>
1736 <dd><kbd class="">n</kbd></dd>
1737 <dt>nudge backward</dt>
1738 <dd><kbd class="kp">&ndash;</kbd></dd>
1739 <dt>nudge forward</dt>
1740 <dd><kbd class="kp">+</kbd></dd>
1741 <dt>quantize MIDI notes </dt>
1742 <dd><kbd class="">q</kbd></dd>
1743 <dt>reduce region gain</dt>
1744 <dd><kbd class="">&amp;</kbd></dd>
1745 <dt>reverse</dt>
1746 <dd><kbd class="mod2">r</kbd></dd>
1747 <dt>set fade in length</dt>
1748 <dd><kbd class="">/</kbd></dd>
1749 <dt>set fade out length</dt>
1750 <dd><kbd class="">\</kbd></dd>
1751 <dt>set region sync point</dt>
1752 <dd><kbd class="">v</kbd></dd>
1753 <dt>split</dt>
1754 <dd><kbd class="">s</kbd></dd>
1755 <dt>toggle fade in active</dt>
1756 <dd><kbd class="mod1">/</kbd></dd>
1757 <dt>toggle fade out active</dt>
1758 <dd><kbd class="mod1">\</kbd></dd>
1759 <dt>transpose</dt>
1760 <dd><kbd class="mod2">t</kbd></dd>
1761 </dl>
1762
1763 <h2>Generic Editing</h2>
1764
1765 <dl class="bindings">
1766 <dt>copy</dt>
1767 <dd><kbd class="mod1">c</kbd></dd>
1768 <dt>cut</dt>
1769 <dd><kbd class="mod1">x</kbd></dd>
1770 <dt>delete</dt>
1771 <dd><kbd class="">Del</kbd></dd>
1772 <dt>paste</dt>
1773 <dd><kbd class="mod1">v</kbd></dd>
1774 <dt>redo</dt>
1775 <dd><kbd class="mod1">r</kbd></dd>
1776 <dt>undo</dt>
1777 <dd><kbd class="mod1">z</kbd></dd>
1778 </dl>
1779
1780 <h2>Selecting</h2>
1781 <p class="note">
1782   There are  a few functions that refer to an <dfn>Edit Range</dfn>. The
1783   current edit range is defined using combinations of the possible edit
1784   points: <dfn>playhead</dfn>, <dfn>active marker</dfn>, or<dfn>mouse</dfn>.
1785 </p>
1786
1787 <dl class="bindings">
1788 <dt>all after playhead</dt>
1789 <dd><kbd class="mod13">p</kbd></dd>
1790 <dt>all before playhead</dt>
1791 <dd><kbd class="mod1">p</kbd></dd>
1792 <dt>all enclosed by edit range</dt>
1793 <dd><kbd class="mod1">u</kbd></dd>
1794 <dt>all present in edit range</dt>
1795 <dd><kbd class="">u</kbd></dd>
1796 <dt>convert edit range to range</dt>
1797 <dd><kbd class="">F6</kbd></dd>
1798 <dt>invert selection</dt>
1799 <dd><kbd class="mod3">i</kbd></dd>
1800 <dt>select all after EP</dt>
1801 <dd><kbd class="mod1">Shift+e</kbd></dd>
1802 <dt>select all before EP</dt>
1803 <dd><kbd class="mod1">e</kbd></dd>
1804 <dt>select all in loop range</dt>
1805 <dd><kbd class="mod1">l</kbd></dd>
1806 <dt>select all in punch range</dt>
1807 <dd><kbd class="mod1">d</kbd></dd>
1808 <dt>select everything</dt>
1809 <dd><kbd class="mod1">a</kbd></dd>
1810 <dt>select next track/bus</dt>
1811 <dd><kbd class="mod2">↓</kbd></dd>
1812 <dt>select previous track/bus</dt>
1813 <dd><kbd class="mod2">↑</kbd></dd>
1814 </dl>
1815 <h2>Defining Loop, Punch Range and Tempo Changes</h2>
1816 <dl class="bindings">
1817 <dt>set loop range from edit range</dt>
1818 <dd><kbd class="">]</kbd></dd>
1819 <dt>set loop range from region(s)</dt>
1820 <dd><kbd class="mod2">]</kbd></dd>
1821 <dt>set punch range from edit range</dt>
1822 <dd><kbd class="">[</kbd></dd>
1823 <dt>set punch range from region(s)</dt>
1824 <dd><kbd class="mod2">[</kbd></dd>
1825 <dt>set tempo (1 bar) from edit range</dt>
1826 <dd><kbd class="">0</kbd></dd>
1827 <dt>set tempo (1 bar) from region(s)</dt>
1828 <dd><kbd class="">9</kbd></dd>
1829 </dl>
1830
1831
1832
1833
1834 ---
1835 title: Ardour Configuration
1836 part: part
1837 ---
1838
1839
1840 ---
1841 title: Ardour Systems
1842 part: chapter
1843 ---
1844
1845
1846 ---
1847 title: The Right Computer System for Digital Audio
1848 menu_title: The Right Computer System
1849 part: subchapter
1850 ---
1851
1852 <p>
1853   It would be nice to think that you could just go and buy any computer,
1854   install a bit of software on it and start using it to record and create
1855   music. This idea isn't wrong, but there some important details that it
1856   misses.
1857 </p>
1858 <p>
1859   Any computer that you can buy today (since somewhere around the end of
1860   2012) is capable of recording and processing a lot of audio data. It
1861   will come with a builtin audio interface that can accept inputs from
1862   microphones or electrical instruments. It will have a disk with a huge
1863   amount of space for storing audio files.
1864 </p>
1865 <p>
1866   When you are recording, editing and mixing music, you generally want to
1867   work with very little <dfn>latency</dfn> between the time that
1868   a sound is generated and when you can hear it. When the audio signal
1869   flows through a computer, that means that the computer has to be able to
1870   receive the signal, process it and send it back out again as fast as
1871   possible.<br />
1872   And that is where it becomes very important <em>what</em> computer system
1873   you have, because it is <strong>absolutely not</strong> the case that any
1874   computer can do this job well.
1875 </p>
1876 <p>
1877   Routing audio through a computer will always cause some delay, but if it
1878   is small, you will generally never notice it. There are also ways to work
1879   in which the delay does not matter at all (for example, not sending the
1880   output from the computer to speakers).
1881 </p>
1882 <p>
1883   The latency that you want for working with digital audio is typically in
1884   the 1&ndash;5&nbsp;ms range. For comparison, if you are sitting 1&nbsp;m
1885   (3&nbsp;ft) from your speakers, the time the sound takes to reach your
1886   ears is about 3&nbsp;ms. Any modern computer can limit the delay to
1887   100&nbsp;ms. Most can keep it under 50&nbsp;ms. Many will be able to get
1888   down to 10&nbsp;ms without too much effort. If you try to reduce the delay
1889   on a computer that cannot meet your goal, you will get clicks and
1890   glitches in the audio, which is clearly extremely undesirable.
1891 </p>
1892
1893 <h2>Hardware-related Considerations</h2>
1894 <dl class="wide-table">
1895   <dt>Video interface</dt>
1896   <dd>Poorly engineered video interfaces (and/or their device drivers) can
1897   "steal" computer resources for a long time, preventing the audio interface
1898   from keeping up with the flow of data</dd>
1899   <dt>Wireless interface</dt>
1900   <dd>Poorly engineered wireless networking interfaces (and/or their device
1901   drivers) can also block the audio interface from keeping up with the flow
1902   of data</dd>
1903   <dt><abbr title="Universal Serial Bus">USB</abbr> ports</dt>
1904   <dd>If you are using an audio interface connected via USB, and sometimes
1905   even if you are not, the precise configuration of your system's USB ports
1906   can make a big difference. There are many cases where plugging the
1907   interface into one port will work, but using different USB port results
1908   in much worse performance. This has been seen even on Apple systems.
1909   </dd>
1910   <dt>Internal USB Hubs</dt>
1911   <dd>Ideally, you'd like your USB ports to all connect directly to the
1912   main bus inside the computer. Some laptops (and possibly some
1913   desktop systems) come wired with an internal USB hub between the
1914   ports and the system bus, which can then cause problems for various
1915   kinds of external USB devices, including some models of audio
1916   interfaces. It is very difficult to discover whether this is true or
1917   not, without simplying trying it out.</dd>
1918   <dt><abbr title="Central Processing Unit">CPU</abbr> speed control</dt>
1919   <dd>Handling audio with low latency requires that your processor keeps
1920   running at its highest speed at all times. Many portable systems try to
1921   regulate processor speed in order to save power&mdash;for low latency
1922   audio, you want this totally disabled, either in the BIOS or at the OS
1923   level.</dd>
1924   <dt>Excessive Interrupt Sharing</dt>
1925   <dd>If your audio interface is forced by your computer to share an
1926   interrupt line (basically a way to tell the CPU that something needs
1927   its attention) with too many, or the wrong, other devices, this can also
1928   prevent the audio interface from keeping up with the flow of data. In
1929   laptops it is generally impossible to do anything about this. In many
1930   desktop systems, it is possible at the BIOS level to reassign interrupts
1931   to work around the problem.</dd>
1932   <dt><abbr title="System Management Interrupt">SMI</abbr>s</dt>
1933   <dd>SMIs are interrupts sent by the motherboard to tell the computer
1934   about the state of various hardware. They cannot safely be disabled,
1935   but they can also take a relatively long time to process. It is better
1936   to have a motherboard which never sends SMIs at all&mdash; this is
1937   also a requirement for realtime stock trading systems, which have
1938   similar issues with latency.</dd>
1939   <dt>Hyperthreading</dt>
1940   <dd>This technology is becoming less common as actual multi-core CPUs
1941   become the norm, but it still exists and is generally not good for
1942   realtime performance. Sometimes you can disable this in the BIOS,
1943   sometimes you cannot. A processor that uses hyperthreading will be
1944   less stable in very low latency situations than one without.</dd>
1945   <dt>Excessive vibration</dt>
1946   <dd>This doesn't affect the flow of data to/from the audio interface,
1947   but it can cause the flow of data to/from your disk storage to become
1948   <em>much</em> slower. If you are going to use a computer in an
1949   environment with loud live sound (specifically, high bass volume),
1950   make sure to place it so that the disk is not subject to noticeable
1951   vibration. The vibrations will physically displace the head-write
1952   heads of disk, and the resulting errors will force a retry of the
1953   reading from the disk. Retrying over and over massively reduces the
1954   rate at which data can be read from the disk. Avoid this.</dd>
1955 </dl>
1956
1957 ---
1958 title: Mouse
1959 part: subchapter
1960 ---
1961
1962 <p>
1963   Ardour is designed to work best with a <dfn>three button mouse</dfn>
1964   equipped with a <dfn>scroll wheel</dfn>.
1965 </p>
1966
1967 <p>
1968   It can be used with a two button mouse or touchpad, but at least two key
1969   operations will not (easily) be available to you:
1970 </p>
1971
1972 <ul>
1973   <li>time-constrained region copying</li>
1974   <li><a href="/using-control-surfaces/midi-learn/"><abbr title="Musical
1975   Instrument Digital Interface">MIDI</abbr> bindings</a>
1976   created by "learning" them from incoming MIDI data</li>
1977 </ul>
1978
1979 <p>
1980   You are strongly encouraged to invest in a three-button mouse. You will
1981   find that a good quality mouse (especially one with a weighted,
1982   latchable scroll wheel) will make your use of Ardour vastly more
1983   efficient. They are cheap, and time is not.
1984 </p>
1985
1986 <p>
1987   For more detailed instructions, see
1988   <a href="/ardours-interface/basic-gui-operations/using-the-mouse/">Using the mouse</a>.
1989 </p>
1990
1991
1992 ---
1993 title: System Setup
1994 part: chapter
1995 ---
1996
1997
1998 ---
1999 title: Setting Up Your System
2000 part: subchapter
2001 ---
2002
2003 <p>
2004   Using a general purpose computer for recording digital audio is not
2005   trivial. This chapter will guide you through the basic steps and help
2006   you with some of the most common pitfalls on the way to a reliable and
2007   powerful audio workstation.
2008 </p>
2009
2010 ---
2011 title: Platform Specifics
2012 part: subchapter
2013 ---
2014
2015 <h2>Platform Specifics</h2>
2016
2017 <p>
2018   This section of the manual collects together the collective wisdom
2019   of the user community regarding details of using Ardour on various
2020   specific platforms
2021 </p>
2022
2023 ---
2024 title: Ubuntu Linux
2025 part: subchapter
2026 ---
2027
2028 <p>
2029   <dfn>Ubuntu Linux</dfn> is the most popular variety of Linux in use on desktop
2030   and laptop systems. It has the backing of a for-profit corporation
2031   (Canonical Inc.), a defined philosophy and a huge and
2032   worldwide user base. As a result, it is a common platform for people
2033   who want to use Ardour and other tools for music creation and
2034   pro-audio work.
2035 </p>
2036
2037 <h2>High Level Recommendations for Ubuntu Users</h2>
2038 <p>
2039   Currently, installing pro audio applications on vanilla Ubuntu requires
2040   some configuration, in order for the user to gain realtime privilege
2041   (read below).
2042   Ubuntu Studio, which is an official flavor of Ubuntu, and thus shares
2043   the repositories with Ubuntu, has this already configured.
2044   Other distributions, such as KXStudio, and Dreamstudio are largely based
2045   on Ubuntu, and like Ubuntu Studio, has these settings preconfigured, while
2046   also containing customized versions of Ubuntu packages, which often are
2047   more up to date.
2048 </p>
2049
2050 <h2>Installing Ardour</h2>
2051 <p>
2052   There may be unintended differences, and even bugs in Ubuntu native
2053   packages, as a result of a different building method. For this reason,
2054   Ardour developers highly recommend you to install the official
2055   ready-to-run version of the program that you can get from <a
2056   href="https://community.ardour.org/download">ardour.org</a>, as Ubuntu native
2057   packages are not supported in official Ardour forums or other
2058   support channels.
2059 </p>
2060 <p>
2061   Follow these steps to install the latest version of Ardour.
2062   <ol>
2063   <li>Download the latest release from <a href="https://community.ardour.org/download">
2064     ardour.org</a>.</li>
2065   <li><kbd class="mouse">Right+Click</kbd> the downloaded file and choose
2066     properties.</li>
2067   <li>Click the Permissions tab and check the option "Allow this file to
2068     run as a program"</li>
2069   <li>Close the dialog and double-click the file.</li>
2070   <li>Follow the prompts.</li>
2071 </ol>
2072 </p>
2073
2074 <h2>Problems with the interaction between PulseAudio and JACK</h2>
2075
2076 <h3>Background Info</h3>
2077 <p>
2078   Like many distributions, Ubuntu has decided to use <dfn>PulseAudio</dfn> as the
2079   default audio system. PulseAudio is a rich and capable system that
2080   provides excellent services for typical users of Linux on the
2081   desktop. However, it is not capable of the type of performance that
2082   tools like Ardour require and in particular does not offer the
2083   possibility of sending audio between applications that can make the
2084   Linux audio environment a very interesting one.
2085 </p>
2086 <p>
2087   This would not be a problem if it were not for the fact that JACK
2088   will not run correctly (if at all) if it needs to use the same
2089   soundcard/audio interface that PulseAudio is using. And since on
2090   Ubuntu, PulseAudio is configured by default to always use the
2091   (typically single) audio interface on your computer, this is a bit
2092   of a problem.
2093 </p>
2094 <p>
2095   The developers of JACK and PulseAudio got together in 2009 and
2096   agreed upon a mechanism by which PulseAudio and JACK could cooperate
2097   in their use of a single soundcard. Whether or not PulseAudio is running by
2098   default, when JACK starts up it sends out a request to use the
2099   soundcard. If PulseAudio is running, it will give up its use of the
2100   soundcard to allow JACK to take over (and can optionally be told to
2101   route its own audio through JACK). When JACK finishes, it sends out
2102   another message, and PulseAudio can once again use the soundcard
2103   directly.
2104 </p>
2105 <h3>What is the problem?</h3>
2106 <p>
2107   The specific issues known at this time for all flavors of Ubuntu
2108   12.04 and 12.10 are:
2109 </p>
2110   <ul>
2111     <li>a bug in PulseAudio that causes it not to give up the
2112       soundcard when JACK asks
2113       (<a href="https://bugs.launchpad.net/ubuntu/+source/pulseaudio/+bug/1163638">LP:
2114       #1163638</a>,
2115       fixed in Ubuntu 13.04).</li>
2116   </ul>
2117
2118 <h3>Symptoms</h3>
2119 <p>
2120     <samp>Cannot start JACK</samp> (though see the next section for other
2121       causes of this)
2122 </p>
2123
2124 <h3>How to fix</h3>
2125 <p>
2126   These bugs do not affect releases from 13.04, and earlier releases
2127   (12.04 and 12.10) are in the process of being fixed.
2128 </p>
2129
2130 <h2>Problems with JACK configuration</h2>
2131
2132 <h3>What is the problem?</h3>
2133     <p>
2134       To function as intended, JACK needs to run with access to two
2135       operating system facilities called <dfn>realtime scheduling</dfn> and
2136       <dfn>memory locking</dfn>. This means that you, the user who starts JACK, must be
2137       allowed access to these facilities. By default, Ubuntu does create a
2138       user group that has this permission but&mdash;it does not put new
2139       users into this group by default. Read more about why <a href="https://wiki.ubuntu.com/Audio/TheAudioGroup">here</a>.
2140       Consequently, you will not have permission to run JACK in the way you should.
2141     </p>
2142 <h3>Symptoms</h3>
2143     <p>
2144       A message like <samp>Cannot lock down memory</samp> in the output from JACK as
2145       it starts up. This output may be hidden in the Messages window of
2146       QJackctrl (aka JACK Control), so you should check there.
2147     </p>
2148
2149 <h3>How to fix</h3>
2150     <p>
2151       Make sure the file /etc/security/limits.d/audio.conf exists. If it is
2152       named /etc/security/limits.d/audio.conf.disabled, rename it to the former.
2153       Run the command
2154     </p>
2155     <kbd class="cmd lin">sudo usermod -a -G audio
2156     <em>YOUR-LOGIN-NAME</em></kbd>
2157     <p>
2158       Then log out and log in again. On Ubuntu Studio the user is a member of audio
2159       group by default, but not on other official flavors.
2160     </p>
2161
2162 <h2>Reporting Issues</h2>
2163
2164 <p>
2165   Given the difficulties in supporting Ubuntu and the limited time/resources
2166   of the Ardour team, the <dfn>Ubuntu Studio Project</dfn> has requested that
2167   issues and bug reports related to Ubuntu, Ubuntu Studio and other
2168   derivitives be directed to them.
2169 </p>
2170
2171 <h3>Contact Information for Ubuntu Studio</h3>
2172
2173 <p><a href="http://ubuntustudio.org">The Ubuntu Studio Homepage</a></p>
2174
2175 <p><a href="http://ubuntuforums.org/forumdisplay.php?f=335">The Ubuntu Studio Forums.</a></p>
2176
2177 <p><a href="https://help.ubuntu.com/community/UbuntuStudio/MailLists">Information on the Ubuntu Studio Mailing Lists.</a></p>
2178
2179 <p><a href="https://help.ubuntu.com/community/UbuntuStudio/IRC">Information on the Ubuntu Studio IRC channel.</a> #ubuntustudio on irc.freenode.net</p>
2180
2181 ---
2182 title: Microsoft Windows
2183 part: subchapter
2184 ---
2185
2186 <p>
2187   <dfn>Microsoft Windows</dfn> is not currently officially supported. If you are
2188   willing to live with bugs and <b>help to test</b> this platform, read on.
2189 </p>
2190
2191 <h2>Installing Ardour</h2>
2192
2193 <p>
2194   <ol>
2195     <li>Download the latest windows build from <a href="http://nightly.ardour.org/">
2196       the nightly build page</a>.</li>
2197     <li>Run the installer and follow the prompts.</li>
2198   </ol>
2199 </p>
2200
2201 <h2>How to help</h2>
2202
2203 <p>
2204   <ul>
2205     <li>Hang out in #ardour-windows on irc.freenode.net. You may ask questions
2206       there and if you can, answer questions that others have.</li>
2207     <li>Keep an eye on the <a href="https://community.ardour.org/forum/27"> Windows
2208       forum</a> and contribute to the discussions there.</li>
2209     <li>Update this manual via pull requests on <a href="https://github.com/Ardour/manual">github<a/>.</li>
2210   </ul>
2211 </p>
2212
2213 ---
2214 title: KDE Plasma 5
2215 part: subchapter
2216 ---
2217
2218 <p>
2219   Under <dfn>KDE Plasma 5</dfn>, plugin and various other windows will not stay
2220   on top of any main window; therefore a workaround is required.
2221 </p>
2222
2223 <h2>Workaround for ancillary windows not staying on top in KDE Plasma 5</h2>
2224
2225 <p>
2226   In order to force ancillary windows in Ardour to stay on top, the following
2227   steps are necessary:
2228 </p>
2229
2230 <ol>
2231   <li>Launch the <kbd class="menu">System Settings</kbd> application.</li>
2232   <li>Open <kbd class="menu">Workspace &gt; Window Managment</kbd>.</li>
2233   <li>Select <kbd class="menu">Window Rules</kbd> in the left-hand sidebar. It
2234   should default to the <kbd class="menu">Window matching</kbd> tab.</li>
2235   <li>Click on the <kbd class="button">New...</kbd> button.</li>
2236   <li>On the line that says <kbd class="menu">Window class (application)</kbd>,
2237   set the combo box to <kbd class="menu">Substring Match</kbd> and type <kbd
2238   class="user">ardour</kbd> in the text entry field.</li>
2239   <li>In the list box that is labeled <kbd class="menu">Window types:</kbd>,
2240   click on the option <kbd class="menu">Dialog Window</kbd>, then press and
2241   hold <kbd>Ctrl</kbd> while clicking on the second option <kbd
2242   class="menu">Utility Window</kbd>.</li>
2243   <li>Select the <kbd class="menu">Arrangement & Access</kbd> tab.</li>
2244   <li>Check the box next to the <kbd class="menu">Keep above</kbd> option. On
2245   the same line, select <kbd class="menu">Force</kbd> from the combo box, then
2246   click on the <kbd class="menu">Yes</kbd> radio button for that line.</li>
2247   <li>Click on the <kbd class="button">OK</kbd> button to dismiss the dialog.
2248   </li>
2249 </ol>
2250
2251 <p>
2252   At this point you can close the <kbd class="menu">System Settings</kbd>
2253   application.
2254 </p>
2255
2256 <h3>Background Info</h3>
2257
2258 <p>
2259   <a href="https://bugs.kde.org/show_bug.cgi?id=172615#c26">According to one of
2260   the lead KDE developers</a>, they are not willing to follow the <abbr
2261   title="Inter-Client Communication Conventions Manual">ICCCM</abbr> standard
2262   for utility windows. Apparently they are alone in this understanding, as
2263   plugin windows on Ardour under Linux work out of the box on every other <abbr
2264   title="Window Manager">WM</abbr> out there.
2265 </p>
2266
2267 <p>
2268   Under KDE 4, there was a workaround in Ardour (<kbd class="menu">Preferences
2269   &gt; Theme &gt; All floating windows are dialogs</kbd>) that would "trick"
2270   KDE into forcing certain window types to be on top of their parent windows,
2271   but this no longer works under KDE Plasma 5.
2272 </p>
2273
2274
2275 ---
2276 title: I/O Setup
2277 part: chapter
2278 ---
2279
2280
2281 ---
2282 title: Connecting Audio and MIDI Devices
2283 part: subchapter
2284 ---
2285
2286 <p class="fixme">Add content</p>
2287
2288 ---
2289 title: Using More Than One Audio Device
2290 part: subchapter
2291 ---
2292
2293 <p>
2294   Ardour will only ever deal with a single <dfn>audio device</dfn>. If you
2295   want to use more than one, you have two choices:
2296 </p>
2297
2298 <ul>
2299   <li>
2300     If you want to use Ardour to start JACK (which handles all
2301     audio I/O) you will need to create a "fake" audio device on your
2302     computer the represents all the multiple devices you wish to
2303     use. How to do this is platform dependent and described below.
2304   </li>
2305   <li>
2306     Use a different tool to start JACK and manage all the devices.
2307   </li>
2308 </ul>
2309
2310 <p>
2311   Ardour is fundamentally designed to be a component in a
2312   pro-audio/music creation environment. Standard operating practice
2313   for such setups involves using only a single digital <dfn>sample
2314   clock</dfn> (something counting off the time between audio samples).
2315   This means that trying to use multiple independent soundcards is
2316   problematic, because each soundcard has its own sample clock, running
2317   independently from the others. Over time, these different clocks
2318   <dfn>drift</dfn>
2319   out of sync with each other, which causes glitches in the audio. You
2320   cannot stop this drift, although in some cases the effects may be
2321   insignificant enough that some people might not care about them.
2322 </p>
2323
2324 <p>
2325   Thus in an ideal world you should not use multiple independent
2326   soundcards but instead use a single device with a single clock and all
2327   the inputs, outputs and other features that you need.
2328 </p>
2329
2330 <p>
2331   Of course, a lot of people don't live in an ideal world, and believe
2332   that software should make up for this.
2333 </p>
2334
2335 <h2>OS X</h2>
2336 <p>
2337   In CoreAudio, <dfn>aggregate devices</dfn> provide a method to use
2338   multiple soundcards as a single device. For example, you can
2339   aggregate two 8-channel devices so that you can record 16 channels
2340   into Ardour.
2341 </p>
2342 <div class="note">
2343 <p>
2344   If you are using a <em>single</em> typical 3rd party
2345   audio interface (such as those from Apogee, RME, Presonus, and many
2346   others), <em>or</em> you are using JackPilot or a similar
2347   application to start JACK, you do not need to worry about this.<br />
2348   You will need to set up an aggregate device only if either
2349   of the following conditions are true:
2350 </p>
2351 <ul>
2352   <li>You want to use two entirely separate
2353     devices <em>and</em> want to start JACK using Ardour.</li>
2354   <li>You want to use your <dfn>builtin audio device</dfn> <em>and</em>
2355     want to start JACK using Ardour.</li>
2356   <li>You want to use more than two entirely separate devices</li>
2357 </ul>
2358 </div>
2359 <p>
2360   In the case of your builtin audio device, you will need to create
2361   an aggregate device that combines "Builtin Input" and "Builtin
2362   Output" into one device.
2363 </p>
2364 <p>
2365   The precise instructions for creating an aggregate device on OS X
2366   have varied from one released to another. Please read <a href="https://support.apple.com/en-us/HT202000">https://support.apple.com/en-us/HT202000</a>
2367 </p>
2368
2369 <h2>Linux</h2>
2370 <p>
2371   Please see the instructions at <a href="http://jackaudio.org/faq" title="http://jackaudio.org/faq">http://jackaudio.org/faq</a>
2372 </p>
2373
2374
2375 ---
2376 title: Preferences
2377 part: chapter
2378 ---
2379
2380
2381 ---
2382 title: Preferences and Session Properties
2383 part: subchapter
2384 ---
2385
2386 <p>
2387   Ardour splits its configuration options into two categories:
2388 </p>
2389 <ul>
2390   <li>
2391     Global <dfn>preferences</dfn> control general workflow and system
2392     configuration, and should apply to all sessions. They are located in
2393     <kbd class="menu">Edit &gt; Preferences</kbd> and stored in
2394     Ardour's <dfn>user configuration file</dfn> in your home directory.
2395   </li>
2396   <li><dfn>Session properties</dfn> control aspects of the workflow or
2397     configuration that pertain to the current session only. You can find them
2398     in <kbd class="menu">Session &gt; Properties</kbd>, and they will be stored
2399     in the session file.
2400   </li>
2401 </ul>
2402
2403 ---
2404 title: Global Preferences Dialog
2405 menu_title: Global Preferences
2406 part: subchapter
2407 ---
2408
2409 <p>
2410   These preferences apply to all Ardour sessions.
2411 </p>
2412
2413 <img src="/images/a4_preferences_misc.png" alt="ardour preferences
2414 dialog"/>
2415
2416 ---
2417 title: Global Misc Tab
2418 menu_title: Misc Tab
2419 part: subchapter
2420 ---
2421
2422 <p>
2423   This tab contains settings that do not belong on the other tabs.
2424 </p>
2425
2426 <img src="/images/a4_preferences_misc.png" alt="preferences
2427 misc tab"/>
2428
2429 <ul>
2430   <li>
2431     <p>
2432       <strong>DSP CPU Utilization</strong> sets how many cpu processors can be
2433       used to do signal processing. It can be set to use one up to all
2434       processors.
2435     </p>
2436   </li>
2437
2438   <li>
2439     <p>
2440       <dfn>Undo</dfn>
2441     </p>
2442     <ul>
2443       <li>
2444         <p>
2445           <strong>Limit undo history</strong> sets how many commands can be
2446           undone using <kbd class="mod1">Z</kbd> or
2447           <kbd class="menu">Edit &gt; Undo</kbd>.
2448         </p>
2449       </li>
2450
2451       <li>
2452         <p>
2453           <strong>Save undo history</strong> sets how many commands are saved so
2454           they are available to be undone after reopening the session.
2455         </p>
2456       </li>
2457
2458       <li>
2459         <p>
2460           <strong>Verify removal of last capture</strong> when enabled prompts to
2461           verify removal the last recording capture when
2462           <kbd class="menu">Edit &gt; Remove Last Capture</kbd> is executed.
2463         </p>
2464       </li>
2465
2466       <li>
2467         <p>
2468           <strong>Make periodic backups of the session file</strong> will create
2469           a backup session file after changes to the timeline. The backup file is
2470           the session name followed by <em>.ardour.bak</em>. The backup can be
2471           used to recover from crashes when the session had not been explicitly
2472           saved.
2473         </p>
2474       </li>
2475     </ul>
2476   </li>
2477
2478   <li>
2479     <p>
2480       <dfn>Session Management</dfn>
2481     </p>
2482     <ul>
2483       <li>
2484         <p>
2485           <strong>Always copy imported files</strong> selects, and then disables
2486           changes to, the <em>Copy&nbsp;files to&nbsp;session</em> option in the
2487           <a href="/adding-pre-existing-material/import-dialog/">
2488             Add Existing Media</a> dialog.
2489         </p>
2490       </li>
2491
2492       <li>
2493         <p>
2494           <strong>Default folder for new sessions:</strong> defalts the folder
2495           where Ardour will create new session folders. This is used in the
2496           <em>Session&nbsp;Setup</em> dialog displayed by
2497           <kbd class="menu">Session &gt; New</kbd>.
2498         </p>
2499       </li>
2500
2501       <li>
2502         <p>
2503           <strong>Maximum number of recent sessions:</strong> determines how many
2504           of the last opened sessions shows in the
2505           <em>Recent&nbsp;Sessions</em> dialog displayed by
2506           <kbd class="menu">Session &gt; Recent</kbd>.
2507         </p>
2508       </li>
2509     </ul>
2510   </li>
2511
2512   <li>
2513     <p>
2514       <dfn>Click</dfn>
2515     </p>
2516     <ul>
2517       <li>
2518         <p>
2519           <strong>Click audio file:</strong> sets a user defined sound to be
2520           played when Ardour's metronome is enabled in the
2521           <a href="/controlling-playback/using-the-transport-bar/">
2522             Transport Bar</a>
2523         </p>
2524       </li>
2525       <li>
2526         <p>
2527           <strong>Click emphasis audio file:</strong> sets an optional different
2528           metronome sound to be played on the downbeat.
2529         </p>
2530       </li>
2531       <li>
2532         <p>
2533           <strong>Click gain level:</strong> allows the metronome's click sounds
2534           to be boosted or attenuated.
2535         </p>
2536       </li>
2537     </ul>
2538   </li>
2539
2540   <li>
2541     <p>
2542       <dfn>Automation</dfn>
2543     </p>
2544     <ul>
2545       <li>
2546         <p>
2547           <strong>Thinning factor</strong> ranges from 0 to 1000 with larger
2548           values sending fewer automation changes. Thinning is like lossy
2549           audio compression, removing data that is less likely to be noticed,
2550           although the more you remove the more likely the loss will be noticed.
2551           The advantage to thinning is reduced CPU usage.
2552         </p>
2553       </li>
2554       <li>
2555         <p>
2556           <strong>Automation sampling interval</strong> ranges from 1 to
2557           1000&nbsp;ms. Determines how frequently the automation input is
2558           sampled. The shorter the interval the higher the accuracy but also
2559           the higher the CPU requirements.
2560         </p>
2561       </li>
2562     </ul>
2563
2564 </ul>
2565
2566 ---
2567 title: Transport Tab
2568 menu_title: Transport Tab
2569 part: subchapter
2570 ---
2571
2572 <p>
2573   This tab contains settings that relate to the behavior of the
2574   <a href="/controlling-playback/using-the-transport-bar">Transport Bar</a>
2575   and <a href="/synchronization/">Synchronization</a>.
2576 </p>
2577
2578 <img src="/images/a4_preferences_transport.png" alt="preferences
2579 transport tab"/>
2580
2581 <ul>
2582   <li>
2583     <p>
2584       <strong>Keep record-enable engaged on stop</strong> leaves the global
2585       record-enable engaged after transport is stopped.  Does not affect track
2586       level record-enable which is never changed on stop.
2587     </p>
2588   </li>
2589
2590   <li>
2591     <p>
2592       <strong>Play loop is a transport mode</strong> changes the behavior of the
2593       loop button, turning it into a toggle. When enabled, the loop button does
2594       not start playback but forces playback to always play the loop.  Looping
2595       stays engaged when the transport is stopped. Playback continues where the
2596       transport stopped and continues to loop.
2597     </p>
2598     <p>
2599       When disabled, the loop button starts playing the loop but stop then
2600       cancels loop playback.
2601     </p>
2602   </li>
2603   <li>
2604     <p>
2605       <strong>Stop recording when an xrun occurs</strong> will stop the transport
2606       when an xrun occurs during recording, ensuring no audible glitches are
2607       recorded.
2608     </p>
2609   </li>
2610   <li>
2611     <p>
2612       <strong>Create markers where xruns occur</strong> will create a new
2613       <a href="/working-with-markers/">marker</a> when an xrun occurs during
2614       recording at the location of the xrun. This marks where possible xruns
2615       might produce audible glitches when stopping on xruns is disabled.
2616     </p>
2617   </li>
2618   <li>
2619     <p>
2620       <strong>Stop at the end of the session</strong> causes the transport to
2621       stop during playback when it reaches the end marker. Behavior during
2622       recording is not changed.
2623     </p>
2624   </li>
2625   <li>
2626     <p>
2627       <strong>Do seamless looping</strong> removes any clicks that might
2628       otherwise be audible when the transport moves from the end of the loop
2629       range back to the beginning.
2630     </p>
2631   </li>
2632   <li>
2633     <p>
2634       <strong>Disable per-track record disarm while rolling</strong>, when
2635       enabled, will not allow the any track's record-enable to be disarmed
2636       during record, preventing accidentally stopping the recording of a take.
2637     </p>
2638   </li>
2639   <li>
2640     <p>
2641       <strong>12dB gain reduction during fast-forward and fast-rewind</strong>
2642       when enabled will reduce the unpleasant increase in perceived volume
2643       that occurs when fast-forwarding or rewinding through some kinds of audio.
2644     </p>
2645   </li>
2646   <li>
2647     <p>
2648       <strong>Sync/Slave</strong>
2649       <ul>
2650         <li>
2651           <p>
2652             <strong>External timecode source</strong> determines which external
2653             source to use when Ardour is using an external
2654             <a href="/synchronization/">synchronization</a> source.  Depending
2655             on the timecode source chosen, additional preference options are
2656             available.
2657           </p>
2658         </li>
2659         <li>
2660           <p>
2661             <strong>Match session video frame rate to external timecode</strong>
2662             controls the value of the video frame rate <em>while chasing</em>
2663             an external timecode source.
2664           </p>
2665           <p>
2666             When enabled, the session video frame rate will be changed to match
2667             that of the selected external timecode source.
2668           </p>
2669           <p>
2670             When disabled, the session video frame rate will not be changed to
2671             match that of the selected external timecode source. Instead, the
2672             frame rate indication in the main clock will flash red and Ardour
2673             will convert between the external timecode standard and the session
2674             standard.
2675           </p>
2676         </li>
2677         <li>
2678           <p>
2679             <strong>Sync-lock timecode to clock</strong> can disable drift
2680             compensation.
2681           </p>
2682           <p>
2683             When enabled, Ardour will never varispeed when slaved to external
2684             timecode. Sync Lock indicates that the selected external timecode
2685             source shares clock-sync (Black &amp; Burst, Wordclock, etc) with
2686             the audio interface. This options disables drift compensation.
2687             The transport speed is fixed at 1.0. Vari-speed LTC will be ignored
2688             and cause drift.
2689           </p>
2690           <p>
2691             When disabled, Ardour will compensate for potential drift regardless
2692             if the timecode sources shares clock sync.
2693           </p>
2694         </li>
2695         <li>
2696           <p>
2697             <strong>Lock to 29.9700 fps instead of 30000/1001</strong>, when
2698             enabled, will force Ardour to assume the external timecode source
2699             uses 29.97 fps instead of 30000/1001.
2700             SMPTE 12M-1999 specifies 29.97&nbsp;df as 30000/1001. The spec
2701             further mentions that drop-frame timecode has an accumulated error
2702             of -86&nbsp;ms over a 24&nbsp;hour period. Drop-frame timecode would
2703             compensate exactly for an NTSC color frame rate of 30 * 0.9990 (i.e.
2704             29.970000). That is not the actual rate. However, some vendors use
2705             that rate&mdash;despite it being against the specs&mdash;because the
2706             variant of using exactly 29.97&nbsp;fps has zero timecode drift.
2707           </p>
2708       </ul>
2709     </p>
2710   </li>
2711   <li>
2712     <p>
2713       <strong>LTC Reader</strong> specifies which incoming port will provide
2714       the LTC signal.
2715     </p>
2716   </li>
2717   <li>
2718     <strong>LTC Generator</strong>
2719     <ul>
2720       <li>
2721         <p>
2722           <strong>Enable LTC generator</strong>, when enabled Ardour will
2723           output an LTC timecode signal on it's <em>LTC-out</em> port.
2724         </p>
2725       </li>
2726       <li>
2727         <p>
2728           <strong>Send LTC while stopped</strong>, when enabled Ardour will
2729           continue to send LTC information even while the transport (playhed) is
2730           not moving.
2731         </p>
2732       </li>
2733       <li>
2734         <p>
2735           <strong>LTC generator level:</strong> specifies the peak volume of
2736           the generated LTC signal in dbFS. A good value is 0dBu^=-18dbFS in an
2737           EBU calibrated system.
2738         </p>
2739       </li>
2740     </ul>
2741   </li>
2742 </ul>
2743
2744 ---
2745 title: Editor Tab
2746 menu_title: Editor Tab
2747 part: subchapter
2748 ---
2749
2750 <p>
2751   This tab contains settings that affect behavior in the <dfn>Editor</dfn>
2752   window when <a href="/editing-and-arranging">Editing and Arranging</a>.
2753 </p>
2754
2755 <img src="/images/a4_preferences_editor.png" alt="preferences
2756 editor tab"/>
2757
2758 <ul>
2759   <li>
2760     <p>
2761       <strong>Allow dragging of the playhead</strong>, when enabled, allows
2762       dragging the playhead with the mouse in the <strong>Editor</strong> window.
2763     </p>
2764   </li>
2765   <li>
2766     <p>
2767       <strong>Move relevant automation when audio regions are moved</strong>,
2768       when enabled, causes automation data to stay with a region when the
2769       region is moved inside the playlist. When disabled, the automation is
2770       not affected by movement of regions.
2771     </p>
2772   </li>
2773   <li>
2774     <p>
2775       <strong>Show meters on tracks in the editor</strong>, when enabled, shows
2776       a small meter in the <strong>Editor</strong> window with each track. The
2777       meter is shown in the left side area along with the track name and buttons.
2778     </p>
2779   </li>
2780   <li>
2781     <p>
2782       <strong>Display master-meter in the toolbar</strong> when enabled displays
2783       a small copy of the master bus meter in the toolbar.
2784     </p>
2785   </li>
2786   <li>
2787     <p>
2788       <strong>Default fade shape:</strong> sets which
2789       <a href="/editing-and-arranging/create-region-fades-and-crossfades/">
2790         fade shape</a> is the default.
2791     </p>
2792   </li>
2793   <li>
2794     <p>
2795       <strong>Regions in active edit groups are edited together:</strong> sets
2796       the criteria to see if editing actions apply to tracks grouped together
2797       in an active group.
2798     </p>
2799   </li>
2800   <li>
2801     <p>
2802       <strong>Make rubberband selection rectangle snap to the grid</strong> when
2803       enabled uses the grid when
2804       <a href="/editing-and-arranging/select-regions/">selecting regions</a>
2805       with a rubberband rectangle.
2806     </p>
2807   </li>
2808   <li>
2809     <p>
2810       <strong>Show waveforms in regions</strong> when enabled shows a visual
2811       representation of the region's audio waveform. Changes to this setting
2812       take affect after restarting Ardour.
2813     </p>
2814   </li>
2815   <li>
2816     <p>
2817       <strong>Show gain envelopes in audio regions:</strong> sets the criteria
2818       for displaying the gain envelope in audio regions.
2819     </p>
2820   </li>
2821   <li>
2822     <p>
2823       <strong>Waveform scale:</strong> when waveforms are shown in audio region
2824       they can be displayed using a <em>linear</em> or a <em>logarithmic</em>
2825       scale.
2826       See <a href="/working-with-tracks/controlling-track-appearance/waveform-display/">
2827         Waveform disply</a>.
2828     </p>
2829   </li>
2830   <li>
2831     <p>
2832       <strong>Waveform shape:</strong> when waveforms are shown in audio region
2833       they can be displayed using a <em>traditional</em> or a <em>rectified</em>
2834       shape.
2835       See <a href="/working-with-tracks/controlling-track-appearance/waveform-display/">
2836         Waveform disply</a>.
2837     </p>
2838   </li>
2839   <li>
2840     <p>
2841       <strong>Waveform Clip Level (dBFS):</strong> sets the level at which the
2842       waveform shown in an audio region will be drawn in red to indicate
2843       clipping. Setting lower than 0.0&nbsp;dBFS can be useful if any tool in
2844       the audio chain has problems near 0.0&nbsp;dBFS.
2845     </p>
2846   </li>
2847   <li>
2848     <p>
2849       <strong>Show waveform for audio while it is being recorded</strong> when
2850       enabled, will draw the audio waveform in regions being recorded.  When
2851       disabled only a region block will be drawn while recording reducing CPU
2852       requirements.
2853     </p>
2854   </li>
2855   <li>
2856     <p>
2857       <strong>Show zoom toolbar</strong> when enabled shows a toolbar for
2858       zoom functions.  When disabled the zoom commands are still available
2859       with keyboard short-cuts and the View menu. Changes to this setting
2860       take affect after restarting Ardour.
2861     </p>
2862   </li>
2863   <li>
2864     <p>
2865       <strong>Update editor window during drags of the summary</strong> when
2866       enabled the contents of the editor window will redraw the tracks area
2867       as the selection rectangle in the summary area is moved or resized. The
2868       summary area is at the bottom of the editor and shows an overview of all
2869       regions on the timelime.
2870     </p>
2871   </li>
2872   <li>
2873     <p>
2874       <strong>Name new markers</strong> when enabled, popup a dialog when a new
2875       <a href="/working-with-markers/">marker</a> is created. This allows
2876       markers to be named as they are created.
2877     </p>
2878   </li>
2879   <li>
2880     <p>
2881       <strong>Auto-scroll editor window when dragging near its edges</strong>
2882       when enabled will scroll the editor window automatically when dragging a
2883       region. This can make it easier to see where to position the region.
2884     </p>
2885   </li>
2886   <li>
2887     <p>
2888       <strong>After splitting selected regions, select</strong> determines which,
2889       if any, regions are selected after a split operation. The options are no
2890       regions, the regions created by the split, and if more than one region
2891       was selected to start with, the existing selection and the new regions.
2892       Changes to this setting take affect after restarting Ardour.
2893     </p>
2894   </li>
2895 </ul>
2896
2897 ---
2898 title: Audio Tab
2899 menu_title: Audio Tab
2900 part: subchapter
2901 ---
2902
2903 <p>
2904   This tab contains settings for handling audio.
2905 </p>
2906
2907 <img src="/images/a4_preferences_audio.png" alt="preferences
2908 audio tab"/>
2909
2910 <ul>
2911   <li>
2912     <p>
2913       <strong>Buffering</strong> settings determine how many seconds of audio
2914       off of disk will be buffered in memory. Longer settings reduce the risk
2915       of buffer under-runs but consume more memory. The default value is
2916       5.0&nbsp;seconds.
2917     </p>
2918
2919     <ul>
2920       <li>
2921         <p>
2922           <strong>Playback</strong> sets how many seconds of audio Ardour will
2923           buffer during playback.
2924         </p>
2925       </li>
2926       <li>
2927         <p>
2928           <strong>Recording</strong> sets how many seconds of audio Ardour will
2929           buffer during recording.
2930         </p>
2931       </li>
2932     </ul>
2933   </li>
2934
2935   <li>
2936     <p>
2937       <strong>Monitoring</strong>
2938     </p>
2939     <ul>
2940       <li>
2941         <p>
2942           <strong>Record monitoring handled by:</strong> determines whether
2943           Ardour provides monitoring of incoming audio or whether
2944           monitoring is provided by hardware.  See
2945           <a href="/recording/monitoring/">Monitoring</a> for more information.
2946         </p>
2947       </li>
2948       <li>
2949         <p>
2950           <strong>Tape machine mode</strong> when enabled defaults new audio
2951           tracks to tape machine mode. See
2952           <a href="/working-with-tracks/track-types/">Track Types</a>
2953           for more information.
2954         </p>
2955       </li>
2956     </ul>
2957   </li>
2958
2959   <li>
2960     <p>
2961     <strong>Conection of tracks and busses</strong>
2962     </p>
2963     <ul>
2964       <li>
2965         <p>
2966           <strong>Auto-connect master/monitor busses</strong>
2967         </p>
2968       </li>
2969       <li>
2970         <p>
2971           <strong>Connect track inputs:</strong>
2972         </p>
2973       </li>
2974       <li>
2975         <p>
2976           <strong>Connect track and bus outputs:</strong>
2977         </p>
2978       </li>
2979     </ul>
2980   </li>
2981
2982   <li>
2983     <p>
2984     <strong>Denormals</strong> are a specific type of very small numbers that
2985     can cause issues with CPU consumption when using some plugins in some
2986     circumstances.
2987     </p>
2988     <p>
2989       Ardour provides two methods of handling the issue. Try different
2990       combinations of these settings to to find the setting that minimizes CPU
2991       consumption.
2992     </p>
2993     <ul>
2994       <li>
2995         <p>
2996           <strong>Use DC bias to protect against denormals</strong> adds a small
2997           constant value to numbers to move the numbers away from zero.
2998         </p>
2999       </li>
3000       <li>
3001         <p>
3002           <strong>Processor handling</strong>, if the computer's hardware
3003           supports it, offers two methods that can be used individually or
3004           combined. Flush to zero and denormals are zero.
3005         </p>
3006       </li>
3007     </ul>
3008   </li>
3009
3010   <li>
3011     <p>
3012     <strong>Plugins</strong>
3013     </p>
3014     <ul>
3015       <li>
3016         <p>
3017           <strong>Silence plugins when the transport is stopped</strong>
3018         </p>
3019       </li>
3020       <li>
3021         <p>
3022           <strong>Make new plugins active</strong> when enabled, will activate
3023           a plugin when it is added to a track or bus
3024           <a href="/working-with-plugins/processor-box/">Processor Box</a>.
3025         </p>
3026       </li>
3027     </ul>
3028   </li>
3029
3030   <li>
3031     <p>
3032     <strong>Regions</strong>
3033     </p>
3034     <ul>
3035       <li>
3036         <p>
3037           <strong>Enable automatic analysis of audio</strong>
3038         </p>
3039       </li>
3040       <li>
3041         <p>
3042           <strong>Replicate missing region channels</strong>
3043         </p>
3044       </li>
3045     </ul>
3046   </li>
3047 </ul>
3048
3049 ---
3050 title: Solo/Mute Tab
3051 menu_title: Solo/Mute Tab
3052 part: subchapter
3053 ---
3054
3055 <p>
3056   This tab contains settings that affect the use of
3057   <a href="/mixing/muting-and-soloing/">solo, muting</a>, and
3058   <a href="/mixing/panning/">panning</a>.
3059 </p>
3060
3061 <img src="/images/a4_preferences_solomute.png" alt="preferences
3062 solo/mute tab"/>
3063
3064 <ul>
3065   <li>
3066     <p>
3067       <strong>Solo</strong>
3068     </p>
3069     <ul>
3070       <li>
3071         <p>
3072           <strong>Solo-in-place mute cut</strong> sets the attenuation of the
3073           the other tracks when another track is soloed in place. This setting
3074           is also available from the <strong>Mixer</strong> monitor section.
3075         </p>
3076       </li>
3077       <li>
3078         <p>
3079           <strong>Solo controls are Listen controls</strong> when enabled the
3080           soloed track is soloed only on the monitor bus, the master fader mix
3081           is not affected by the solo. This option can also be set by enabling
3082           pre-fader listen or after-fader listen in the <strong>Mixer</strong>
3083           monitor section.
3084         </p>
3085       </li>
3086       <li>
3087         <p>
3088           <strong>Listen Position:</strong> determines what is listened to when
3089           the solo controls are used as listen controls. The options are
3090           after-fader or pre-fader.
3091         </p>
3092       </li>
3093       <li>
3094         <p>
3095           <strong>PFL signals come from:</strong> determines whether the
3096           pre-fader listen position is before or after the pre-fader processors.
3097         </p>
3098       </li>
3099       <li>
3100         <p>
3101           <strong>AFL signals come from:</strong> determines whether the
3102           after-fader listen position is before or after the after-fader
3103           processors.
3104         </p>
3105       </li>
3106       <li>
3107         <p>
3108           <strong>Exclusive solo</strong> when enabled will only solo that last
3109           track selected for solo. Previously soloed tracks will be un-soloed.
3110           This setting is also available from the <strong>Mixer</strong> monitor
3111           section.
3112         </p>
3113       </li>
3114       <li>
3115         <p>
3116           <strong>Show solo muting</strong> when enabled outlines the mute
3117           button on tracks and busses when another track is soloed.
3118         </p>
3119       </li>
3120       <li>
3121         <p>
3122           <strong>Soloing overrides muting</strong> when enabled allows a track
3123           to be heard when it is soloed while muted. This setting is also
3124           available from the <strong>Mixer</strong> monitor section.
3125         </p>
3126       </li>
3127     </ul>
3128   </li>
3129
3130   <li>
3131     <p>
3132       <strong>Default track/bus muting options</strong> sets the muting options
3133       for a newly created tracks or bus. The mute options for an existing track
3134       or bus are changed by the right-click context menu on a mute button.
3135     </p>
3136     <ul>
3137       <li>
3138         <p>
3139           <strong>Mute affects pre-fader sends</strong> when enabled pre-fader
3140           sends will be muted by default.
3141         </p>
3142       </li>
3143       <li>
3144         <p>
3145           <strong>Mute affects post-fader sends</strong> when enabled post-fader
3146           sends will be muted by default.
3147         </p>
3148       </li>
3149       <li>
3150         <p>
3151           <strong>Mute affects control outputs</strong> when enabled control
3152           outputs are muted by default.
3153         </p>
3154       </li>
3155       <li>
3156         <p>
3157           <strong>Mute affects main outputs</strong> when enabled main outputs
3158           are muted by default.
3159         </p>
3160       </li>
3161     </ul>
3162   </li>
3163
3164   <li>
3165     <p>
3166       <strong>Send Routing</strong> affects
3167       <a href="/signal-routing/aux-sends/">aux and external sends</a>.
3168     </p>
3169     <ul>
3170       <li>
3171         <p>
3172           <strong>Link panners of Aux and External Sends with main panner by
3173             default</strong> When enabled, sends follow the channel panner.
3174         </p>
3175         <p>
3176           When disabled, sends can panned independently of the channel panner
3177           and fader. Double clicking the send in the processor box toggles
3178           the main panner and fader between the aux send and the channel.
3179         </p>
3180       </li>
3181     </ul>
3182   </li>
3183 </ul>
3184
3185 ---
3186 title: MIDI Tab
3187 menu_title: MIDI Tab
3188 part: subchapter
3189 ---
3190
3191 <p>
3192   This tab contains settings related to the use of MIDI inside Ardour.
3193 </p>
3194
3195 <img src="/images/a4_preferences_midi.png" alt="preferences
3196 MIDI tab"/>
3197
3198 <ul>
3199   <li>
3200     <p>
3201       <strong>MIDI read-ahead time</strong>
3202     </p>
3203   </li>
3204
3205   <li>
3206     <p>
3207       <strong>Send MIDI Clock</strong> when enabled Ardour will generate MIDI
3208       clock on the <code>ardour:MIDI clock out</code> JACK port.
3209     </p>
3210   </li>
3211
3212   <li>
3213     <p>
3214       <strong>Send MIDI Time Code</strong> when enabled Ardour will generate MIDI
3215       time code on the <code>ardour:MTC out</code> JACK port.
3216     </p>
3217   </li>
3218
3219   <li>
3220     <p>
3221       <strong>Percentage either side of normal transport speed to transmit MTC:</strong> MIDI time code generation will be disabled when the transport speed is
3222       greater than normal sped plus this percentage or less than normal minus
3223       this percentage.
3224     </p>
3225   </li>
3226
3227   <li>
3228     <p>
3229       <strong>Obey MIDI Machine Control commands</strong> when enabled Ardour
3230       will respond to MIDI Machine Control commands received on the
3231       <code>ardour:MMC in</code> JACK port.
3232     </p>
3233   </li>
3234
3235   <li>
3236     <p>
3237       <strong>Send MIDI Machine Control commands</strong> when enabled Ardour
3238       will send MIDI Machine Control commands on the <code>ardour:MMC out</code>
3239       JACK port.
3240     </p>
3241   </li>
3242
3243   <li>
3244     <p>
3245       <strong>Send MIDI control feedback</strong>
3246     </p>
3247   </li>
3248
3249   <li>
3250     <p>
3251       <strong>Inbound MMC device ID:</strong> is the only device ID Ardour will
3252       respond to when an MMC command is received on the
3253       <code>ardour:MMC in</code> JACK port.
3254     </p>
3255   </li>
3256
3257   <li>
3258     <p>
3259       <strong>Outbound MMC device ID:</strong> is the MIDI device ID Ardour will
3260       use when it sends MMC commands.
3261     </p>
3262   </li>
3263
3264   <li>
3265     <p>
3266       <strong>Initial program change:</strong> Ardour will send a MIDI program
3267       change message on the <code>ardour:MMC out</code> JACK port when a session
3268       is loaded and whenever this field is changed. A value of -1 is for don't
3269       send any program change message.
3270     </p>
3271   </li>
3272
3273   <li>
3274     <p>
3275       <strong>Display first MIDI bank/program as 0</strong>
3276     </p>
3277   </li>
3278
3279   <li>
3280     <p>
3281       <strong>Never display periodic MIDI messages</strong>
3282     </p>
3283   </li>
3284
3285   <li>
3286     <p>
3287       <strong>Sound MIDI notes as they are selected</strong>
3288     </p>
3289   </li>
3290
3291   <li>
3292     <p>
3293       <strong>Midi Audition Synth</strong>
3294     </p>
3295   </li>
3296 </ul>
3297
3298 ---
3299 title: User Interaction Tab
3300 menu_title: User Interaction Tab
3301 part: subchapter
3302 ---
3303
3304 <p>
3305   This tab contains settings that affect the user's interaction with
3306   <a href="/ardours-interface">Ardours interface</a>.
3307 </p>
3308
3309 <img src="/images/a4_preferences_interaction.png" alt="preferences
3310 user interaction tab"/>
3311
3312 <ul>
3313   <li>
3314     <p>
3315       <strong>Use translations</strong>
3316     </p>
3317   </li>
3318   <li>
3319     <p>
3320       <strong>Keyboard</strong>
3321     </p>
3322     <ul>
3323       <li>
3324         <p>
3325           <strong>Edit using:</strong> Use this keyboard and mouse combination
3326           to edit a region's name, and for audio, the region gain.
3327         </p>
3328       </li>
3329       <li>
3330         <p>
3331           <strong>Delete using:</strong>
3332         </p>
3333       </li>
3334       <li>
3335         <p>
3336           <strong>Insert note using</strong> Using this mouse and keyboard
3337           combination allows MIDI note drawing while the <strong>Editor</strong>
3338           is in edit mode.
3339         </p>
3340       </li>
3341       <li>
3342         <p>
3343           <strong>Ignore snap using:</strong> This mouse and keyboard combination
3344           temporarily changes the
3345           <a href="/editing-and-arranging/snap-to-the-grid/">snap mode</a> to
3346           <strong>No Grid</strong>.
3347         </p>
3348       </li>
3349       <li>
3350         <p>
3351           <strong>Keyboard layout:</strong>
3352         </p>
3353       </li>
3354     </ul>
3355   </li>
3356 </ul>
3357
3358 ---
3359 title: Control Surfaces Tab
3360 menu_title: Control Surfaces Tab
3361 part: subchapter
3362 ---
3363
3364 <p>
3365   This tab contains settings for control surfaces. Also see
3366   <a href="/using-control-surfaces/">Using Control Surfaces</a>.
3367 </p>
3368
3369 <img src="/images/a4_preferences_control_surfaces.png" alt="preferences
3370 control surfaces tab"/>
3371
3372 <p>
3373   Enable a <dfn>Control Surface Protocol</dfn> and double-click on it to edit
3374   protocol specific  settings. Enable feedback to allow Ardour to send position
3375   information back to a control surface.
3376 </p>
3377
3378 <p>
3379   <strong>Control surface remote ID:</strong> can follow the order of the mixer
3380   or be user assigned.
3381 </p>
3382
3383 ---
3384 title: Video Tab
3385 menu_title: Video Tab
3386 part: subchapter
3387 ---
3388
3389 <p>
3390   This tab contains settings related to handling of Video.
3391 </p>
3392
3393 <img src="/images/a4_preferences_video.png" alt="preferences
3394 video tab"/>
3395
3396 <ul>
3397   <li>
3398     <p>
3399       <strong>Advanced Setup (remote video server)</strong>
3400     </p>
3401     <ul>
3402       <li>
3403         <p>
3404           <strong>Video Server URL:</strong>
3405         </p>
3406       </li>
3407       <li>
3408         <p>
3409           <strong>Video Folder:</strong>
3410         </p>
3411       </li>
3412     </ul>
3413   </li>
3414   <li>
3415     <p>
3416       <strong>Show Video Export Info before export</strong>
3417     </p>
3418   </li>
3419   <li>
3420     <p>
3421       <strong>Show Video Server Startup Dialog</strong>
3422     </p>
3423   </li>
3424 </ul>
3425
3426 ---
3427 title: Plugins Tab
3428 menu_title: Plugins Tab
3429 part: subchapter
3430 ---
3431
3432 <p>
3433   This tab contains settings that control the discovery and availability of
3434   plugins.
3435 </p>
3436
3437 <img src="/images/a4_preferences_plugins.png" alt="preferences
3438 plugins tab"/>
3439
3440 <ul>
3441   <li>
3442     <p>
3443       <strong>General</strong>
3444     </p>
3445     <ul>
3446       <li>
3447         <p>
3448           <strong>Scan for Plugins</strong> will initiate an immediate scan of
3449           the system for available plugins.
3450         </p>
3451       </li>
3452       <li>
3453         <p>
3454           <strong>Always Display Plugin Scan Progress</strong> When enabled a
3455           popup window showing plugin scan progress is displayed for indexing
3456           (cache load) and discovery (detect new plugins).
3457         </p>
3458       </li>
3459       <li>
3460         <p>
3461           <strong>Scan Time Out</strong> Specify the default timeout for plugin
3462           instantiation in 1/10 seconds. Plugins that require more time to load
3463           will be blacklisted. A value of 0 disables the timeout.
3464         </p>
3465       </li>
3466     </ul>
3467   </li>
3468
3469   <li>
3470     <p>
3471       <strong>VST</strong>
3472     </p>
3473     <ul>
3474       <li>
3475         <p>
3476           <strong>Clear VST Cache</strong> Remove all VST plugins from the list
3477           of plugins available to be inserted into the processor box.
3478         </p>
3479       </li>
3480       <li>
3481         <p>
3482           <strong>Clear VST Blacklist</strong> Make blacklisted VST plugins
3483           available to be added to the processor box.
3484         </p>
3485       </li>
3486       <li>
3487         <p>
3488           <strong>Scan for [new] VST Plugins on Application Start</strong> When
3489           enabled new VST plugins are searched, tested and added to the cache
3490           index on application start. When disabled new plugins will only be
3491           available after triggering a 'Scan' manually.
3492         </p>
3493       </li>
3494       <li>
3495         <p>
3496           <strong>Linux VST Path:</strong> Launch a dialog to manage the
3497           directories that will be searched for Linux VST plugins.
3498         </p>
3499       </li>
3500     </ul>
3501   </li>
3502 </ul>
3503
3504 ---
3505 title: GUI Tab
3506 menu_title: GUI Tab
3507 part: subchapter
3508 ---
3509
3510 <p>
3511   This tab contains settings that affect
3512   <a href="/ardours-interface/">Ardour's Interface</a>.
3513 </p>
3514
3515 <img src="/images/a4_preferences_gui.png" alt="preferences
3516 gui tab"/>
3517
3518 <ul>
3519   <li>
3520     <p>
3521       <strong>Graphically indicate mouse pointer hovering</strong>
3522     </p>
3523   </li>
3524   <li>
3525     <p>
3526       <strong>Use name highlight bars in region display</strong> When enabled the
3527       region name is displayed, in the editor,  in it's own bar at the bottom of
3528       the region. When disabled, the region name is display at the top of the
3529       region, possibly over audio waveforms or MIDI notes.
3530     </p>
3531   </li>
3532   <li>
3533     <p>
3534       <strong>Font scaling</strong> allows the display size of some text in the
3535       user interface to be scaled up or down. May require a restart to take
3536       affect.
3537     </p>
3538   </li>
3539   <li>
3540     <p>
3541       <strong>Update transport clock display at FPS</strong> when enabled the transport clock
3542       will update at the synchronization framerate instead of the default 100&nbsp;ms rate.
3543     </p>
3544   </li>
3545   <li>
3546     <p>
3547       <strong>Lock timeout</strong> Lock GUI after this many idle seconds (zero to never
3548       lock). GUI may also be locked with <kbd class="menu">Session &gt; Lock</kbd>. When
3549       locked a dialog will display a &quot;Click to unlock&quot; button.
3550     </p>
3551   </li>
3552   <li>
3553     <p>
3554       <strong>Mixer Strip</strong> Enable (checked) or disable (unchecked) display of
3555       controls in the mixer strip. Controls whose display can be toggled are
3556       <strong>Input</strong>, <strong>Phase&nbsp;Invert</strong>,
3557       <strong>Record&nbsp;&amp;&nbsp;Monitor</strong>, <strong>Solo&nbsp;Iso/Lock</strong>,
3558       <strong>Output</strong>, and <strong>Comments</strong>.
3559     </p>
3560   </li>
3561   <li>
3562     <p>
3563       <strong>Use narrow strips in the mixer by default</strong> When enabled, new mixer
3564       strips are created in narrow format. When disabled, they are created in wide format.
3565       Existing mixer strips width can be toggled with the width control at the top left of
3566       the mixer stip.
3567     </p>
3568   </li>
3569 </ul>
3570
3571 ---
3572 title: Metering Tab
3573 menu_title: Metering Tab
3574 part: subchapter
3575 ---
3576
3577 <p>
3578   This tab contains settings that affect <a href="/ardours-interface/meters/">
3579     Metering</a> in Ardour.
3580 </p>
3581
3582 <img src="/images/a4_preferences_metering.png" alt="preferences
3583 metering tab"/>
3584
3585 <ul>
3586   <li>
3587     <p>
3588       <strong>Peak hold time:</strong> Some meter types that have a peak
3589       indicator that has a user controlled hold time. The options are off, short,
3590       medium, or long.
3591     </p>
3592   </li>
3593   <li>
3594     <p>
3595       <strong>DPM fall-off:</strong>
3596     </p>
3597   </li>
3598   <li>
3599     <p>
3600       <strong>Meter line-up level; 0&nbsp;dBu:</strong>
3601     </p>
3602   </li>
3603   <li>
3604     <p>
3605       <strong>IEC1/DIN Meter line-up level; 0&nbsp;dBu:</strong>
3606     </p>
3607   </li>
3608   <li>
3609     <p>
3610       <strong>VU Meter standard:</strong>
3611     </p>
3612   </li>
3613   <li>
3614     <p>
3615       <strong>Peak threshold[dBFS]:</strong>
3616     </p>
3617   </li>
3618   <li>
3619     <p>
3620       <strong>LED meter style</strong>
3621     </p>
3622   </li>
3623 </ul>
3624
3625 ---
3626 title: Theme Tab
3627 menu_title: Theme Tab
3628 part: subchapter
3629 ---
3630
3631 <p>
3632   This tab contains settings that change the visual appearence of Ardour.
3633 </p>
3634
3635 <img src="/images/a4_preferences_theme.png" alt="preferences
3636 theme tab"/>
3637
3638 <ul>
3639   <li>
3640     <p>
3641       <strong>Restore Defaults</strong> When clicked will change all settings
3642       on the Theme tab back to Ardour's default values.
3643     </p>
3644   </li>
3645   <li>
3646     <p>
3647       <strong>All floating windows are dialogs</strong> When enabled Ardour will
3648       use type &quot;Dialog&quot; for all floating windows instead of using type
3649       &quot;Utility&quot; for some of them. This may help usability with some
3650       window managers. This setting requires a restart of Ardour to take effect.
3651     </p>
3652   </li>
3653   <li>
3654     <p>
3655       <strong>Transient windows follow front window</strong> When enabled
3656       transient windows will follow the front window when toggling between the
3657       editor and mixer. This setting requires a restart of Ardour to take effect.
3658     </p>
3659   </li>
3660   <li>
3661     <p>
3662       <strong>Draw &quot;flat&quot; buttons</strong> When enabled button controls
3663       in the user interface will be drawn with a flat look. When disabled button
3664       controls will have a slight 3D appearence.
3665     </p>
3666   </li>
3667   <li>
3668     <p>
3669       <strong>Blink Rec-Arm buttons</strong> When enabled the record-armed
3670       buttons on tracks will blink when they are armed but not currently
3671       recording. When disabled the record-armed buttons on tracks will be
3672       outlined in red instead of blinking.
3673     </p>
3674   </li>
3675   <li>
3676     <p>
3677       <strong>Color regions using their track's color</strong> When enabled
3678       the background color of regions in the editor will be displayed using the
3679       the color assigned to the track. When disabled the default region
3680       background color will be used.
3681     </p>
3682   </li>
3683   <li>
3684     <p>
3685       <strong>Show waveform clipping</strong> When enalbled the waveform
3686       displayed will show peaks marked in red if they exceed the clip level. The
3687       Waveform Clip Level is set with a slider on the Preferences
3688       <a href="/preferences-and-session-properties/preferences-dialog/editor/">
3689         Editor tab</a>
3690     </p>
3691   </li>
3692   <li>
3693     <p>
3694       <strong>Icon Set</strong> Changes the mouse cursor icons used to indicate
3695       different tool modes in the editor. An example would be the icons used to
3696       indicate whether the cursor will select a region or change the length of a
3697       region.
3698     </p>
3699   </li>
3700   <li>
3701     <p>
3702       <strong>Waveforms color gradient depth</strong> Determines how much
3703       gradient effect is applied to audio waveforms displayed in the editor.
3704       Values range from 0.00, no graident effect, to 0.95, maximum effect.
3705     </p>
3706   </li>
3707   <li>
3708     <p>
3709       <strong>Timeline item gradient depth</strong> Determines how much
3710       gradient effect is applied to the backgrounds of regions displayed in the
3711       editor. Values range from 0.00, no graident effect, to 0.95, maximum
3712       effect.
3713     </p>
3714   </li>
3715   <li>
3716     <p>
3717       <strong>Colors</strong> The color of an item in the user interface is
3718       determined by which named color is assigned to it, the color displayed for
3719       each named color in the palette, and in some cases, the transparency of
3720       stacked items.
3721     </p>
3722     <ul>
3723       <li>
3724         <p>
3725           <strong>Items</strong> Each display item has a named color assigned to
3726           it from the palette. Example color names are
3727           &quot;meter&nbsp;color9&quot; and &quot;color&nbsp;4&quot;.
3728         </p>
3729         <p>
3730           Click on an item's color example to change the named color choice.
3731         </p>
3732       </li>
3733       <li>
3734         <p>
3735           <strong>Palette</strong> Hover over a color to display it's name. Click
3736           on a color to open a color chooser dialog.
3737         </p>
3738       </li>
3739       <li>
3740         <p>
3741           <strong>Transparency</strong> Some items have a transparency value.
3742           Transparency can be changed from opaque to totally transparent.
3743         </p>
3744       </li>
3745     </ul>
3746   </li>
3747 </ul>
3748
3749 ---
3750 title: Session Properties Dialog
3751 menu_title: Session Properties
3752 part: subchapter
3753 ---
3754
3755 <img src="/images/a4_session_properties_timecode.png" alt="session properties dialog"/>
3756
3757 <p>
3758   This dialog allows you to change settings for the current session. These
3759   settings are initially set from the template used to create the session. To
3760   open the dialog use <kbd class="menu">Session &gt; Properties</kbd>
3761 </p>
3762
3763 ---
3764 title: Timecode Tab
3765 menu_title: Timecode Tab
3766 part: subchapter
3767 ---
3768
3769 <img src="/images/a4_session_properties_timecode.png" alt="session properties timecode tab"/>
3770
3771 <p>
3772   This tab is used to change how Ardour interprets and manipulates timecode.
3773 </p>
3774
3775 <ul>
3776   <li>
3777     Timecode Settings lets you set the number of frames per second
3778     and pull up/down to match the timecode used other synchronized systems.
3779   </li>
3780   <li>
3781     External Timecode Offsets allows Ardour to a fixed offset from other
3782     synchronized systems. <dfn>Slave Timecode offset</dfn> adds the
3783     specified offset to the recieved timecode (MTC or LTC).
3784     <dfn>Timecode Generator offset</dfn> adds the specified offset to
3785     the timecode generated by Ardour (so far only LTC).
3786   </li>
3787   <li>
3788     Jack Transport / Time Settings determines whether Ardour controls
3789     Bar|Beat|Tick and other information for Jack.
3790   </li>
3791 </ul>
3792
3793 ---
3794 title: Sync Tab
3795 menu_title: Sync Tab
3796 part: subchapter
3797 ---
3798
3799 <img src="/images/a4_session_properties_sync.png" alt="session properties sync tab"/>
3800
3801 <p>
3802   This tab is used to modify the timecode settings when working with video to
3803   use the imported video's timecode settings instead of the session defaults.
3804 </p>
3805
3806 ---
3807 title: Fades Tab
3808 menu_title: Fades Tab
3809 part: subchapter
3810 ---
3811
3812 <img src="/images/a4_session_properties_fades.png" alt="session properties fades tab"/>
3813
3814 <p>
3815   Change how Ardour works with region crossfades.
3816 </p>
3817
3818 <ul>
3819   <li>
3820     <dfn>Destructive crossfade length</dfn> is used when an operation on a
3821     region is destructive, such as when recording in a track is in tape mode.
3822   </li>
3823   <li>
3824     When <dfn>Region fades</dfn> <strong>active</strong> is checked, the
3825     region fades set up in the mixer are used during playback.  When unchecked,
3826     the fades are ignored.
3827   </li>
3828   <li>
3829     When <strong>Region fades visible</strong> is checked the region fades are visible
3830     in the the <strong>Editor</strong>.
3831   </li>
3832 </ul>
3833
3834 ---
3835 title: Media Tab
3836 menu_title: Media Tab
3837 part: subchapter
3838 ---
3839
3840 <img src="/images/a4_session_properties_media.png" alt="session properties media tab"/>
3841
3842 <p>
3843   Change how sound is stored on disk. These options do not change how sound is handled
3844   internally.
3845 </p>
3846
3847 <ul>
3848   <li>
3849     <dfn>Sample format</dfn> defaults to 32-bit floating point, the same as
3850     the internal representation. 24 and 16-bit integer representation are
3851     also available.
3852   </li>
3853   <li>
3854     <strong>File type</strong> options are WAVE,  WAVE-64, and CAF.
3855   </li>
3856 </ul>
3857
3858 ---
3859 title: Locations Tab
3860 menu_title: Locations Tab
3861 part: subchapter
3862 ---
3863
3864 <img src="/images/a4_session_properties_locations.png" alt="session properties locations tab"/>
3865
3866 <p>
3867   These options add file locations that will be searched to find the audio and
3868   midi files used by the session. This is useful when the files have been
3869   imported into the session but not copied into the session.
3870 </p>
3871
3872 <p>
3873   To add a location, navigate to the directory where the files are stored.
3874   Drill down into the directory and then click open.  The directory will
3875   show up in the dialog.  The remove button next to the added directory can be used
3876   to remove it from the search path.
3877 </p>
3878
3879 ---
3880 title: Filenames Tab
3881 menu_title: Filenames Tab
3882 part: subchapter
3883 ---
3884
3885 <img src="/images/a4_session_properties_filenames.png" alt="session properties filenames tab"/>
3886
3887 <p>
3888   This tab is used to change how Ardour names recorded regions.
3889   If <dfn>Prefix track number</dfn> is selected a unique number will appear on each track
3890   in the <dfn>Editor</dfn> window and will prefix the region name. If the track number
3891   is 2 and the region would have been Gtr-1.1 with track number prefix turned on the region
3892   will be named 2_Gtr-1.1 instead.  See XX for base of the region name.
3893 </p>
3894
3895 <p>
3896   If <dfn>Prefix take name</dfn> is selected and the <dfn>Take name</dfn> has Take1 the region
3897   will have the name Take1_Gtr-1.1 instead.  If both boxes are checked the name will be
3898   Take1_2_Gtr-1.1 instead.
3899 </p>
3900
3901 <p>
3902   When <dfn>Prefix take name</dfn> is enabled, the first time a track is recorded it will
3903   have the specified take name.  When recording is stopped, any trailing number on the
3904   end of the take name will incremented by 1. If the track name specified doen't have
3905   a number on the end, the number 1 will be suffixed.
3906 </p>
3907
3908 ---
3909 title: Monitoring Tab
3910 menu_title: Monitoring Tab
3911 part: subchapter
3912 ---
3913
3914 <p>
3915   Provides options affecting monitoring.
3916 </p>
3917
3918 <img src="/images/a4_session_properties_monitoring.png" alt="session properties monitoring tab"/>
3919
3920 <p>
3921   The <strong>Track Input Monitoring automatically follows transport state</strong>
3922   affects how input monitoring is handling. See
3923   <a href="/recording/monitoring/monitor-setup-in-ardour/">Monitor Setup in Ardour</a>.
3924 </p>
3925
3926 <img class="left" src="/images/a4_monitoring_section.png" alt="monitoring section"/>
3927
3928 <p>
3929   The 'Use monitor section' displays an extra section in the <strong>Mixer</strong>
3930   window that is modelled on the similiarly named section on large analog consoles.
3931 </p>
3932
3933 ---
3934 title: Meterbridge Tab
3935 menu_title: Meterbridge Tab
3936 part: subchapter
3937 ---
3938
3939 <p>
3940   The meters from audio tracks always display in the <dfn>Meterbridge</dfn>.
3941   This tab changes what additional controls are also displayed.
3942 </p>
3943
3944 <img src="/images/a4_session_properties_meterbridge.png" alt="session properties meterbridge tab"/>
3945
3946 <ul>
3947   <li>
3948     <dfn>Route Display</dfn> has options for showing midi tracks, busses, and the master bus.
3949   </li>
3950   <li>
3951     <dfn>Button Area</dfn> has options for adding record enable, mute, solo, and input monitor buttons.
3952   </li>
3953   <li>
3954     <dfn>Name Labels</dfn> adds the track name and, if numbers are enabled on the filenames tab, the number.
3955   </li>
3956 </ul>
3957
3958 <img src="/images/a4_meterbridge_full.png" alt="image of meterbidge with all options on"/>
3959
3960 ---
3961 title: Session Misc Tab
3962 menu_title: Misc Tab
3963 part: subchapter
3964 ---
3965
3966 <p>
3967   This tab has several things that don't fit on the other tabs.
3968 </p>
3969
3970 <img src="/images/a4_session_properties_misc.png" alt="session properties misc tab"/>
3971
3972 <ul>
3973   <li>
3974     <dfn>MIDI Options</dfn>
3975     <ul>
3976       <li>
3977         If <dfn>MIDI region copies are independent</dfn> is selected, when a
3978         MIDI region is copied or duplicated, the new region is not linked to
3979         the region it was copied from. If it is not selected, the copied regions
3980         are linked and any editing of one of the linked regions changes all
3981         of the linked regions.
3982       </li>
3983       <li>
3984         The <dfn>Editor</dfn> can be configured to handle overlapping MIDI notes
3985         several ways.
3986         <ul>
3987           <li>never allow them</li>
3988           <li>don't do anything in particular</li>
3989           <li>replace any overlapped existing notes</li>
3990           <li>shorten the overlapped existing note</li>
3991           <li>shorten the overlapped new note</li>
3992           <li>replace both overlapping notes with a single note</li>
3993         </ul>
3994       </li>
3995     </ul>
3996   </li>
3997   <li>
3998     <dfn>Glue to bars and beats</dfn>
3999     <ul>
4000       <li>New markers can be glued to bars and beats</li>
4001       <li>New regions can be glued to bars and beats</li>
4002     </ul>
4003   </li>
4004   <li>
4005     Settings from the session properties dialogs can be saved to the
4006     default session template.
4007   </li>
4008 </ul>
4009
4010
4011 ---
4012 title: Configuring MIDI
4013 part: chapter
4014 ---
4015
4016
4017 ---
4018 title: Using External MIDI Devices
4019 part: subchapter
4020 ---
4021
4022 <p class="fixme">Add content</p>
4023
4024
4025 ---
4026 title: Setting Up MIDI
4027 part: subchapter
4028 ---
4029
4030 <h2>What Can Ardour Do With MIDI?</h2>
4031 <p>
4032   <dfn><abbr title="Musical Instrument Digital
4033   Interface">MIDI</abbr></dfn> is a way to describe musical
4034   performances and to control music hardware and software.
4035 </p>
4036 <p>Ardour can import and record MIDI data, and perform a variety of
4037   editing operations on it. Furthermore, MIDI can be used to control
4038   various functions of Ardour.
4039 </p>
4040
4041 <h2>MIDI Handling Frameworks</h2>
4042 <p>
4043   MIDI input and output for Ardour are handled by the same "engine"
4044   that handles audio input and output. Up to release 3.5, that means
4045   that all MIDI I/O takes place via JACK. JACK itself uses the
4046   native MIDI support of the operating system to receive and send
4047   MIDI data. The native MIDI support  provides device drivers for MIDI
4048   hardware and libraries needed by software applications that want to
4049   work with MIDI.
4050 </p>
4051
4052 <dl>
4053 <dt>OS X</dt>
4054 <dd>  <dfn>CoreMIDI</dfn> is the standard MIDI framework on OSX systems.
4055 </dd>
4056 <dt>Linux</dt>
4057 <dd>
4058   <dfn><abbr title="Advanced Linux Sound API">ALSA</abbr> MIDI</dfn>
4059   is the standard MIDI framework on Linux systems.
4060 </dd>
4061 </dl>
4062
4063 <p class="note">
4064   On Linux systems, <dfn>QJackCtl</dfn> control software displays ALSA MIDI
4065   ports under its "ALSA" tab (it does not currently display CoreMIDI
4066   ports).  By contrast, JACK MIDI ports show up under
4067   the <kbd class="menu">MIDI</kbd> tab in QJackCtl.
4068 </p>
4069
4070 <h2>JACK MIDI Configuration</h2>
4071 <p>
4072 By default, JACK will <strong>not</strong> automatically detect and use existing MIDI
4073 ports on your system. You must choose one of several ways
4074 of <dfn>bridging</dfn> between the native MIDI frameworks
4075 (e.g. CoreMIDI or ALSA) and JACK MIDI, as described in the sections
4076 below.
4077 </p>
4078
4079 ---
4080 title: MIDI on Linux
4081 part: subchapter
4082 ---
4083
4084 <p>The right approach for using MIDI on Linux depends on which version of
4085 JACK you use. The world divides into:</p>
4086
4087 <dl>
4088 <dt>Systems using JACK 1, versions 0.124 or later</dt>
4089 <dd>On these systems, just start JACK with the <code>-X alsa_midi</code> server argument. To support legacy control applications, you can also use the <code>-X seq</code> argument to the ALSA backend of JACK and get the exact same results.</dd>
4090 <dt>All others</dt>
4091 <dd>Use a2jmidid to act as a bridge between ALSA MIDI and JACK. Do not use the <code>-X seq</code> or <code>-X raw</code> arguments&mdash;the timing and performance of these options is not acceptable.
4092 </dd>
4093 </dl>
4094
4095 <h2>a2jmidid</h2>
4096
4097 <p>
4098   <dfn>a2jmidid</dfn> is an application that bridges between the system
4099   <abbr title="Musical Instrument Digital Interface">MIDI</abbr> ports and
4100   <abbr title="JACK Audio Connection Kit">JACK</abbr>.
4101 </p>
4102
4103 <p>
4104   First you should make sure that there is no ALSA sequencer support enabled
4105   in JACK. To do that open QJackCtl's <kbd class="menu">Setup</kbd> window.
4106 </p>
4107
4108 <p>
4109   Set <kbd class="menu">Settings &gt; MIDI Driver</kbd> to <kbd
4110   class="input">none</kbd>.
4111   Then uncheck the <kbd class="optoff">Misc &gt; Enable ALSA Sequencer
4112   support</kbd> option.<br />
4113   Now it's time to restart your jack server before going on.
4114 </p>
4115
4116 <h3>Check for a2jmidid availability</h3>
4117
4118 <p>
4119   First, check whether a2jmidid is already installed in your system. After
4120   starting your JACK server, go to the command line and type
4121 </p>
4122
4123 <kbd class="cmd lin">a2jmidid -e</kbd>
4124
4125 <p>
4126   If a2jmidid does not exist, install it with the software manager of your
4127   Linux distribution and try again.
4128 </p>
4129
4130 <h2>Check available MIDI ports</h2>
4131
4132 <p>
4133   If you have correctly configured JACK for MIDI, then your MIDI ports should appear in
4134   qjackctl under <kbd class="menu">Connections &gt; MIDI </kbd>.
4135 </p>
4136
4137 <h3>Making it automatic</h3>
4138
4139 <p>
4140 Once you've verified that the ports appear in JACK as expected, you
4141 can make this happen whenever you start JACK.
4142 </p>
4143
4144 <p>If you use a newer version of JACK 1, just make sure the -X
4145 alsa_midi or -X seq options are enabled for whatever technique you use
4146 to start JACK.
4147 </p>
4148
4149 <p>
4150 For other versions of JACK,
4151 add <kbd class="input">a2jmidid -e &amp;</kbd> as an "after start-up" script
4152 in the <kbd class="menu">Setup &gt; Options</kbd> tab of QJackCtl, so
4153 that it is started automatically whenever you start JACK.
4154 </p>
4155
4156 <p class="fixme">Is this true anymore in Ardour 5? This section may have been relevant in Ardour 3, but it might not be relevant anymore.</p>
4157
4158 ---
4159 title: MIDI on OS X
4160 part: subchapter
4161 ---
4162
4163 <p>
4164   In order for CoreMIDI to work with Jack MIDI, a CoreMIDI-to-JACK-MIDI
4165   <dfn>bridge</dfn>
4166   is required. This feature is available on versions equal to or great than
4167   version 0.89 of JackOSX.
4168 </p>
4169
4170 <h2>Routing MIDI</h2>
4171
4172 <h3>Inside Ardour</h3>
4173
4174 <p>
4175   MIDI ports show up in Ardour's MIDI connection matrix in multiple
4176   locations. Bridged CoreMIDI ports as well as JACK MIDI ports that have
4177   been created by other software clients will show up under the "Other" tab.
4178   Bridged CoreMIDI hardware ports show up under the "Hardware" tab.
4179 </p>
4180
4181 <h3>External Applications</h3>
4182
4183 <p>
4184   There are multiple options for connecting MIDI ports outside of Ardour.
4185 </p>
4186
4187 <ul>
4188   <li><a href="http://www.snoize.com/MIDIMonitor/">MIDI Monitor</a> is a handy
4189   tool for doing various MIDI-related tasks.</li>
4190   <li><a href="http://notahat.com/midi_patchbay">MIDI Patchbay</a> lets you
4191   connect ports and filters MIDI data.</li>
4192 </ul>
4193
4194
4195
4196
4197 ---
4198 title: Ardour's Interface
4199 part: part
4200 ---
4201
4202
4203 ---
4204 title: About Ardour's Interface
4205 part: chapter
4206 ---
4207
4208 <p>
4209   In Ardour, you work in two main windows: the <dfn>Editor</dfn> and the
4210   <dfn>Mixer</dfn>.
4211 </p>
4212
4213 <figure>
4214   <img src="/images/global-editor-window-split.png" alt="Ardour's editor window">
4215   <img style="margin-left:2em;" src="/images/global-mixer-window-split.png" alt="Ardour's mixer window">
4216   <figcaption>
4217   <ol class="multicol3">
4218     <li>Main menu</li>
4219     <li>Status bar</li>
4220 </ol><ol class="multicol3" start="3">
4221     <li>Transport bar & Times</li>
4222     <li>Mode switch</li>
4223 </ol><ol class="multicol3" start="5">
4224     <li>The <dfn>Mixer</dfn> window</li>
4225     <li>The <dfn>Editor</dfn> window</li>
4226   </ol>
4227   </figcaption>
4228 </figure>
4229
4230 <p>
4231   Switching between the Editor and the Mixer windows done:
4232 </p>
4233
4234 <ul>
4235   <li>with the Mode Switch buttons (#4 in the screenshot) in the upper right</li>
4236   <li>with the <kbd class="mod2">M</kbd> shortcut</li>
4237   <li>with the menu <kbd class="menu">Window &gt; Editor <em>(or Mixer)</em> &gt; Show</kbd>.</li>
4238 </ul>
4239
4240 <p>
4241   Both windows can be visible at the same time (eg. for a multi-monitor
4242   setup) using <kbd class="menu">Window &gt; Editor <em>(or Mixer)</em> &gt; Detach</kbd> option in the same submenu.
4243 </p>
4244
4245 <hr>
4246
4247 <p class="fixme">Which of these two should be there? They seem to have the same content&hellip;</p>
4248
4249 <p>
4250   In Ardour, you work in two main windows: the <dfn>Editor</dfn> and the <dfn>Mixer</dfn>. 
4251 </p>
4252
4253 <figure>
4254   <img src="/images/editor_split.png" alt="Ardour's mixer window">
4255   <img src="/images/mixer_split.png" alt="Ardour's editor window">
4256   <figcaption>
4257   <ol class="multicol4">
4258     <li>Main menu</li>
4259     <li>Status bar</li>
4260     <li>Transport bar & Times</li>
4261 </ol><ol class="multicol4" start="4">
4262     <li>Mode switch</li>
4263     <li>The <dfn>Editor</dfn> window</li>
4264     <li>a track's mixer strip</li>
4265 </ol><ol class="multicol4" start="7">
4266     <li>Editors List</li>
4267     <li>The <dfn>Mixer</dfn> window</li>
4268     <li>Favorite plugins</li>
4269 </ol><ol class="multicol4" start="10">
4270     <li>Track list</li>
4271     <li>Group list</li>
4272     <li>Master strip</li>
4273   </ol>
4274   </figcaption>
4275 </figure>
4276
4277 <p>
4278   To switch between those windows, use the buttons (#4 Mode switch in the upper right), the shortcut <kbd class="mod2">M</kbd>, or the menu <kbd class="menu">Window > Editor <em>(or Mixer)</em> > Show</kbd>. Both windows can be visible at the same time (eg. for a multi-monitor setup) using <kbd class="menu">Detach</kbd> in the same menu.
4279 </p>
4280
4281
4282 ---
4283 title: Main Menu
4284 part: chapter
4285 ---
4286
4287 <p class="fixme">Add content</p>
4288
4289
4290 ---
4291 title: Status Bar
4292 part: chapter
4293 ---
4294
4295 <img src="/images/status-bar.png" alt="The status bar">
4296
4297 <p>The status bar is an informative bar at the top of the window, showing:</p>
4298
4299 <ul>
4300   <li><dfn>File:</dfn> the file format used in the session, including when recording</li>
4301   <li><dfn>TC:</dfn> is the timecode, i.e. the number of frames per second used by the session (for videos)</li>
4302   <li><dfn>Audio:</dfn> gives the sample rate used in the session, and the latency computed from the buffer size</li>
4303   <li><dfn>Buffers:</dfn> decribe how much data is buffered, see below</li>
4304   <li><dfn>DSP:</dfn> for Digital Sound Processing, shows how much of the CPU is used by Ardour and its plugins</li>
4305   <li><dfn>X:</dfn> shows the number of xruns since Ardour's launch, see below</li>
4306   <li><dfn>Disk:</dfn> reports the remaining hard disk space as the time that can be recorded with the current session setting</li>
4307   <li><dfn>a Clock</dfn> showing the system time</li>
4308   <li><dfn>a Log button</dfn> that indicates if Ardour has encountered any warning or error.</li>
4309 </ul>
4310
4311 <p>The buffers are labeled as <kbd class="menu">p</kbd> for playback and <kbd class="menu">c</kbd> for capture. If the
4312 system is fast enough, these buffers should be 100% full at all times, showing the system has time to precompute
4313 all the data before delivering it to the audio system. A buffer constantly under 20% is a sign of an underpowered
4314 computer system or of too much processing.</p>
4315
4316 <p>An Xrun (short for buffer over- or under-run) happens when the system has been forced to skip audio frames, e.g. if the latency
4317 asked is too short for the computing power of the machine. It usually results in clicks, pops and crackles if it happens while recording.</p>
4318
4319 <p>The log button turns yellow when a warning occurs, and red when an error occurs. Clicking the log button gives acces to the log.</p>
4320
4321 ---
4322 title: Transport bar and times
4323 part: chapter
4324 ---
4325
4326 <p>
4327   Ardour offers many ways to <dfn>control playback</dfn> of your session, including the transport bar, key bindings and remote controls. You can also use markers to define locations or ranges within the session and rapidly move around between them.
4328 </p>
4329
4330 <img src="/images/transport-bar.png" alt="Ardour's transport bar" />
4331
4332 <p class="note">
4333   If you synchronize Ardour with other devices then some or all of these control methods may be unavailable&mdash;depending on the synchronization protocol, Ardour may respond only to commands sent from its master device(s).
4334 </p>
4335
4336 <p>
4337   The <dfn>Transport Bar</dfn> at the top of the window is made of:
4338 </p>
4339
4340 <ul>
4341   <li>the Transport Controls</li>
4342   <li>the Clocks</li>
4343   <li>3 status indicators:
4344     <ul>
4345       <li><dfn>Solo</dfn>: Blinks when one or more tracks are being soloed, see <a href="/mixing/muting-and-soloing/">Muting and Soloing</a>. Clicking this button disables any active explicit and implicit solo on all tracks and busses.</li>
4346       <li><dfn>Audition</dfn>: Blinks when using the import dialog to audition material.</li>
4347       <li><dfn>Feedback</dfn>: Blinks when Ardour detects a <dfn>feedback loop</dfn>, which happens when the output of an audio signal chain is plugged back to its input. This is probably not wanted and can be dangerous for the hardware and the listener.</li>
4348     </ul></li>
4349   <li>A global Meter, showing the level of the Master Output, see <a href="/introducing-ardour/meters/">Metering in Ardour</a></li>
4350   <li>the Mode Selector, allowing to switch between Editor and Mixer views, or edit the Preferences.</li>
4351 </ul>
4352
4353 ---
4354 title: The Transport Bar
4355 part: subchapter
4356 ---
4357
4358 <p>
4359   The <dfn>Transport Bar</dfn> groups all the actions regarding the control of playback and recording.
4360 </p>
4361
4362 <p class="center"><img src="/images/transport.png" alt="The transport controls" /></p>
4363
4364 <p>
4365   This bar is made of (from left to right):
4366 </p>
4367
4368 <ul>
4369   <li>
4370     <dfn>Midi Panic</dfn>: Immediately stops all midi output.
4371   </li>
4372   <li>
4373     <dfn>Enable/disable Audio Click</dfn>: Toggles (on/off) a click track (metronome) along the <a href="/tempo-meter/tempo-and-meter/">tempo</a>.
4374   </li>
4375   <li>
4376     <dfn>Go to Start of the Session</dfn>: Jumps back at the beginning of the session, as defined by the <a href="/working-with-markers/">start marker</a>.
4377   </li>
4378   <li>
4379     <dfn>Go to End of the Session</dfn>: Jumps forward to the end of the session, as defined by the <a href="/working-with-markers/">end marker</a>.
4380   </li>
4381   <li>
4382     <dfn>Play Loop Range</dfn>: Repeats the defined <a href="/controlling-playback/looping-the-transport/">loop</a> as defined by the <a href="/working-with-markers/loop-range/">Loop range</a>, until the "Stop playback" button is pressed. Clicking the "Play loop Range" button while already active switches to normal Play mode, which exits the loop without stopping and restarting playback.
4383   </li>
4384   <li>
4385     <dfn>Play Range/Selection</dfn>: If a range has been defined using the Range Mode button, plays the range; or if an audio or MIDI region is selected, plays this region. In both cases, the playback stops at the end of the range or selected region.
4386   </li>
4387   <li>
4388     <dfn>Play from playhead</dfn>: Starts the playback and optionally record (more below).
4389   </li>
4390   <li>
4391     <dfn>Stop</dfn>: Whatever the playing mode (loop, range, &hellip;) stops all playback. Depending on other settings, some effects (like chorus or reverb) might still be audible for a while.
4392   </li>
4393   <li>
4394     <dfn>Toggle Record</dfn>: Global switch button to activate/deactivate recording. While active, the button blinks red. The button doesn't start recording by itself: if one or more tracks are marked as record-enabled, pressing the "Play from Playhead" starts recording on those tracks. See <a href="/recording/">Recording</a>.
4395   </li>
4396 </ul>
4397
4398 <p class="fixme">Add default keyboard shortcuts to the above.</p>
4399
4400 <p class="note">
4401   All these actions are bound to keyboard shortcuts, which allows for speedier use and more focused work.
4402 </p>
4403
4404 <p>
4405   Under these buttons is the <dfn>Shuttle Speed Control</dfn> that allows to scrub through the audio quickly.
4406 </p>
4407
4408 <p>
4409   The Shuttle Speed Control supports 2 operating modes, that can be chosen with right click &gt; Mode:
4410 </p>
4411
4412 <ul>
4413   <li><dfn>Sprung mode</dfn> that allows for a temporary scrub: it only scubs while the mouse is left clicked on the control.</li>
4414   <li><dfn>Wheel mode</dfn> that allows to set a playback speed until the "Stop" button is pressed, which stops the playback and resets its speed.
4415 </ul>
4416
4417 <p>
4418   The mode is displayed on the right of the control. The current playback speed is shown by a green slider, that is square and centered when the playback speed is normal (1X) and becomes a circle when its changed. The further from the center the slider is set, the faster the playback will scrub in both directions, as displayed on the left of the control.
4419 <p>
4420
4421 <p>
4422   The 3 vertical buttons on the right of the transport bar control the behavior of the playhead:
4423 </p>
4424
4425 <ul>
4426   <li>
4427      The positional sync button (which might show <dfn>Internal</dfn>, or <dfn>MTC</dfn> or several other values) can be used to control whether or not the transport position and start is controlled by Ardour, or by an external positional synchronization source, such as MIDI Time Code (MTC), Linear Time Code (LTC) or JACK. (see <a href="/synchronization/timecode-generators-and-slaves/">Timecode Generators and Slaves</a>).
4428   </li>
4429   <li>
4430     <dfn>Follow Edits</dfn> is a toggle that can be used to control whether or not making a selection (range or object) will move the playhead to the start of the selection.
4431   </li>
4432   <li>
4433     <dfn>Auto Return</dfn> is a toggle switch too. When active, pressing the Stop button returns the playhead to its previous position, and when inactive, pressing Stop keeps the playhead at its current location. Activating Auto Return can be useful for hearing the same piece of audio before and after tweaking it, without having to set a loop range on it.
4434   </li>
4435 </ul>
4436
4437 <h2>Using Key Bindings</h2>
4438
4439 <p>
4440   Ardour has many available commands for playback control that can be bound 
4441   to keys. Many of them have default bindings, some do not, so the list below 
4442   shows both the default bindings and internal command names for some of them.
4443 </p>
4444
4445 <dl class="wide-table">
4446   <dt><kbd>Space</kbd></dt>
4447   <dd>switch between playback and stop.</dd>
4448   <dt><kbd>Home</kbd></dt>
4449   <dd>Move playhead to session start marker</dd>
4450   <dt><kbd>End</kbd></dt>
4451   <dd>Move playhead to session end marker</dd>
4452   <dt><kbd>&rarr;</kbd></dt>
4453   <dd>Playhead to next region boundary</dd>
4454   <dt><kbd>&larr;</kbd></dt>
4455   <dd>Playhead to previous region boundary</dd>
4456   <dt><kbd>0</kbd></dt>
4457   <dd>Move playhead to start of the timeline</dd>
4458 </dl>
4459
4460 <p>
4461   Go to the <kdb class="menu">Transport</kbd> and <kdb class="menu">Transport &gt> Playhead</kbd> to find more.
4462 </p>
4463
4464 ---
4465 title: Times
4466 part: subchapter
4467 ---
4468
4469 <p>
4470   <dfn>Clocks</dfn> in Ardour are used to display <dfn>time values</dfn> precisely. In many cases, they are also one way to edit (change) time values, and in a few cases, the only way. All clocks share the same basic appearance and functionality, which is described below, but a few clocks serve particularly important roles.
4471 </p>
4472
4473 <h2>Transport Clocks</h2>
4474
4475 <p>
4476   In the transport bar of the editor window there are two clocks (unless you
4477   are on a very small screen), that display the current position of the playhead
4478   and additional information related to transport control and the timeline. These
4479   are called the <dfn>transport clocks</dfn>; the left one is the primary
4480   transport clock and the right one is the secondary transport clock.
4481   They look like this:
4482 </p>
4483
4484 <img src="/images/a3_new_main_clocks.png" alt="An image of the transport clocks in Ardour 3" />
4485
4486 <p>
4487   Editing the time in the transport clocks will reposition the playhead in the same
4488   way that various other editing operations will.
4489 </p>
4490
4491 <h3>The Big Clock</h3>
4492
4493 <p>
4494   To show the current playhead position in a big, resizable window, activate
4495   <kbd class="menu">Window &gt; Big Clock</kbd>. The big clock is very useful
4496   when you need to work away from the screen but still want to see the playhead
4497   position clearly (such as when working with a remote control device across
4498   a room). The big clock will change its visual appearance to indicate when active
4499   recording is taking place. Below on the left is a screenshot showing a fairly
4500   large big clock window filling a good part of the display, and on the right,
4501   the same clock during active recording.
4502 </p>
4503
4504 <a href="/images/bigclock.png"><img src="/images/bigclock.png" height="100" alt="an image of the big clock filling a screen" /></a> <a href="/images/bigclock-recording.png"><img src="/images/bigclock-recording.png" height="100" alt="an image of the big clock while recording"
4505 /></a>
4506
4507 <h3>The Special Role of the Secondary Transport Clock</h3>
4508
4509 <p>
4510   On a few occasions Ardour needs to display time values to the user, but there
4511   is no obvious way to specify what units to use. The most common case is the big
4512   cursor that appears when dragging regions. For this and other similar cases,
4513   Ardour will display time using the same units as the secondary clock.
4514 </p>
4515
4516 <h4>Why are there two transport clocks?</h4>
4517
4518 <p>
4519   Having two transport clocks lets you see the playhead position in two different
4520   time units without having to change any settings. For example, you can see the
4521   playhead position in both timecode units and BBT time.
4522 </p>
4523
4524 <h3>Selection and Punch Clocks</h3>
4525
4526 <p>
4527   The transport bar also contains a set of 5 clocks that show the current
4528   <dfn>selection range</dfn> and <dfn>punch ranges</dfn>. Clicking on the punch
4529   range clocks will locate to either the beginning or end of the punch range.
4530   Similarly, clicking on the range clocks will locate to either the beginning
4531   or end of the current selection. In this screen shot there is no current
4532   selection range, so the selection clocks show an "off" state.
4533 </p>
4534
4535 <img src="/images/selectionpunchclocks.png" alt="An image of the the selection and punch clocks in Ardour 3" />
4536
4537 <h2>Clock Modes</h2>
4538
4539 <p>
4540   Every clock in Ardour has four different, selectable <dfn>clock
4541   modes</dfn>. Each mode displays time using different units.
4542   You can change the clock mode by <kbd class="mouse">Right</kbd>-clicking
4543   on the clock and selecting the desired mode from the menu. Some clocks are
4544   entirely independent of any other clock's mode; others are linked so that
4545   changing one changes all clocks in that group. The different modes are:
4546 </p>
4547 <dl>
4548   <dt>Timecode</dt>
4549   <dd>Time is shown as <dfn><abbr title="Society of Motion Picture and Television
4550   Engineers">SMPTE</abbr> timecode</dfn> in Hours:Minutes:Seconds:Frames,
4551   measured from the timecode zero point on the timeline (which may not
4552   correspond to the session start and/or absolute zero on the timeline,
4553   depending on configurable timecode offsets).
4554   The frames value is dictated by either the session <abbr title="Frames Per
4555   Second">FPS</abbr> setting, or, if slaved to an external timecode master,
4556   the master's setting. In the transport clocks, the FPS value is shown below
4557   the time display, along with an indication of the current timecode source
4558   (<samp>INT</samp> means that Ardour is its own timecode source).</dd>
4559   <dt>BBT</dt>
4560   <dd>Time is shown as Bars:Beats:Ticks, indicating <dfn>musical time</dfn> measured
4561   from the start of the session. The transport clocks show the current tempo
4562   in <abbr title="Beats Per Minute">bpm</abbr> and meter below the time
4563   display.</dd>
4564   <dt>Minutes:Seconds</dt>
4565   <dd>Time is shown as Hours:Minutes:Seconds.Milliseconds, measured from the
4566   absolute start of the timeline (ignoring the session start and any timecode
4567   offsets).</dd>
4568   <dt>Samples</dt>
4569   <dd>Time is shown as a <dfn>sample count</dfn> from the absolute start of the timeline
4570   (ignoring the session start and any timecode offsets). The number of
4571   samples per second is given by the current sample rate, and in the transport
4572   clocks, this rate is shown below the time display along with any
4573   pullup/pulldown adjustment.</dd>
4574 </dl>
4575
4576 <h3>Special Modes for the Transport Clocks</h3>
4577 <p>
4578   In addition to the time-unit modes mentioned above, each of the two transport
4579   clocks (if you work on a small screen, you may only have one) can be
4580   independently set to display <dfn>Delta to Edit Point</dfn> in whatever time
4581   units its current mode indicates. This setting means that the clock shows the
4582   distance between the playhead and the current edit point, and it may show a
4583   positive or negative value depending on the temporal order of these two points.
4584   The clocks will use a different color when in this mode to avoid confusion.
4585 </p>
4586 <p>
4587   To switch either (or both!) of the transport clocks into this mode, use
4588   <kbd class="menu"> Edit &gt; Preferences &gt; Transport</kbd> and select
4589   the relevant checkboxes.
4590 </p>
4591 <p>
4592   Note that when in <samp>Delta to Edit Point</samp> mode, the transport clocks
4593   cannot be edited.
4594 </p>
4595
4596 <h2>Changing clock values with the keyboard</h2>
4597 <p>
4598   New values for the clock can be typed in after clicking on the relevant clock.
4599   Clicking on the clock will show a thin vertical cursor bar just to the right
4600   of the next character to be overwritten. Enter time in the same order as the
4601   current clock mode&mdash;if the clock is in Timecode mode, you need to enter
4602   hours, minutes, seconds, frames. So, to change to a time of 12:15:20:15 you
4603   would type <kbd class="input">1 2 1 5 2 0 1 5</kbd>. Each number you type will
4604   appear in a different color, from right to left, overwriting the existing value.
4605   Mid-edit, after typing <kbd class="input">3 2 2 2</kbd> the clock might look like this:
4606 </p>
4607 <img src="/images/clockedit.png" alt="An image of a clock being edited in Ardour 3" />
4608 <p>
4609   To finish the edit, press <kbd>&crarr;</kbd> or <kbd>Tab</kbd>. To exit an
4610   edit without changing the clock press <kbd>ESC</kbd>. If you mis-type an entry
4611   so that the new value would be illegal (for example, resulting in more than 30
4612   frames when Timecode is set to 30 frames per second), the clock will reset at
4613   the end of the edit, and move the cursor back to the start so that you can
4614   start over.
4615 </p>
4616
4617 <h3>Avoiding the mouse entirely</h3>
4618 <p>
4619   There is a shortcut available for those who wish to be able to edit the transport
4620   clocks entirely without the mouse. It can be found in
4621   <kbd class="menu">Window &gt; Key Bindings &gt; Transport &gt; Focus On
4622   Clock</kbd>. If bound to a key (<kbd>&divide;</kbd> on the numerical
4623   keypad is the
4624   default), then pressing that key is equivalent to clicking on the primary (left)
4625   transport clock, and editing can begin immediately.
4626 </p>
4627
4628 <h3>Entering Partial Times</h3>
4629 <p>
4630   One detail of the editing design that is not immediately obvious is that it is
4631   possible to enter part of a full time value. Suppose that the clock is in BBT
4632   mode, displaying <samp>024|03|0029</samp>, and you want to alter the value to
4633   the first beat of the current bar. Click on the clock and type
4634   <kbd class="input">0 1 0 0 0 0</kbd>. Similarly, if it is in Minutes:Seconds
4635   mode, displaying <samp>02:03:04.456</samp>, and you want to get to exactly 2
4636   hours, click on the clock and type <kbd class="input">0 0 0 0 0 0 0</kbd> to
4637   reset the minutes, seconds and milliseconds fields.
4638 </p>
4639
4640 <h3>Entering Delta Times</h3>
4641 <p>
4642   You can also type values into the clock that are intended as a relative change,
4643   rather than a new absolute value. Simply end the edit by pressing
4644   <kbd>+</kbd> or <kbd>-</kbd> (the ones on any keypad will also work). The plus
4645   key will add the entered value to the current value of the clock, minus will
4646   subtract it. For example, if the clock is in Samples mode and displays
4647   <samp>2917839</samp>, you move it back 2000 samples by typing
4648   <kbd class="input">2 0 0 0</kbd> and <kbd>-</kbd>, rather than ending with
4649   Enter or Tab. </p>
4650
4651 <h2>Changing clock values with the mouse</h2>
4652
4653 <h3>Using a scroll wheel</h3>
4654
4655 <p>
4656   Position the mouse pointer over the clock, and move the scroll wheel. Moving
4657   the scroll wheel up (<kbd class="mouse">&uArr;</kbd>) increases the value
4658   shown on the clock, moving it down  (<kbd class="mouse">&uArr;</kbd>)
4659   decreases it. The step size is equal to the unit of the field
4660   you are hovering over (seconds, hours, etc.).
4661 </p>
4662
4663 <h3>Dragging the mouse</h3>
4664
4665 <p>
4666   Position the mouse pointer over the clock, press the left mouse button and drag.
4667   Dragging upwards increases the value shown on the clock, dragging downwards
4668   decreases it, again with a step size equal to the unit of the field you
4669   began the drag on.
4670 </p>
4671
4672
4673 ---
4674 title: The Editor
4675 part: chapter
4676 ---
4677
4678 <figure>
4679   <img src="/images/detailed-editor-window.png" alt="Ardour's editor windo
4680 w">
4681   <figcaption>
4682   <ol class="multicol4">
4683     <li>Toolbar</li>
4684     <li>Rulers</li>
4685 </ol><ol class="multicol4" start="3">
4686     <li>Editor's List</li>
4687     <li>a Mixer strip</li>
4688 </ol><ol class="multicol4" start="5">
4689     <li>Summary</li>
4690     <li>an audio track</li>
4691   </ol>
4692 </ol><ol class="multicol4" start="7">
4693     <li>a MIDI track</li>
4694     <li>automation</li>
4695   </ol>
4696   </figcaption>
4697 </figure>
4698
4699 <p>
4700   The <dfn>Editor</dfn> window includes the editor track <dfn>canvas</dfn>
4701   where you can arrange audio and MIDI data along a timeline. This is the
4702   window you will be in while editing and arranging a project. The window
4703   has a general "horizontal" sense to it: the timeline flows from left to
4704   right, the playhead showing the current position in the session moves
4705   from left to right&mdash;the window really represents <dfn>time</dfn>
4706   in a fairly literal way.
4707 </p>
4708
4709 <p>
4710   It is possible to show a single channel strip in the editor window, and
4711   some people find this enough to work on mixing without actually opening
4712   the mixer window. Most of the time though, you will want both of these
4713   windows at various stages of a session's lifetime&mdash;sometimes
4714   you'll be focused on editing, sometimes on mixing and possibly some of
4715   the time on both.
4716 </p>
4717
4718 <p>
4719   This section is a description of the Editor window. To learn more about the
4720   editing workflow, see <a href="fixme">Editing</a>.
4721 </p>
4722
4723
4724 ---
4725 title: The Editor - The Toolbar
4726 part: chapter
4727 ---
4728
4729 <figure>
4730         <img src="/images/toolbar_split.png" alt="Ardour's editor toolbar">
4731         <figcaption>
4732                 <ol class="multicol5">
4733                         <li>Toolbar</li>
4734     </ol><ol class="multicol5" start="2">
4735                         <li>Zoom Control</li>
4736                 </ol><ol class="multicol5" start="3">
4737                         <li>Grid Control</li>
4738                 </ol><ol class="multicol5" start="4">
4739                         <li>Edit Point</li>
4740     </ol><ol class="multicol5" start="5">
4741                         <li>Nudge</li>
4742                 </ol>
4743         </figcaption>
4744 </figure>
4745
4746 <p>
4747   The Toolbar is made of 5 parts, described in this part.
4748 </p>
4749
4750 ---
4751 title: The Toolbox
4752 part: subchapter
4753 ---
4754
4755 <img src="/images/toolbar-tools.png" alt="Editor toolbar's tools, aka toolbox">
4756
4757 <h2>Global Edit mode</h2>
4758
4759 <p>
4760   Ardour has a global <dfn>edit mode</dfn> selector at the left of the
4761   Editing toolbar, which affect how regions are moved or copied:
4762 </p>
4763
4764 <dl>
4765   <dt><kbd class="menu">Slide</kbd></dt>
4766   <dd>Regions move freely. Ardour creates overlaps when necessary.</dd>
4767   <dt><kbd class="menu">Ripple</kbd></dt>
4768   <dd>Editing affects the regions to the "right" of the edit (see below).</dd>
4769   <dt><kbd class="menu">Lock</kbd></dt>
4770   <dd>No region motion is permitted (except for "nudge").</dd>
4771 </dl>
4772
4773 <p>
4774   Ripple Edit mode provides the following conveniences:
4775   <ul>
4776     <li>Deleting a range will move later regions to compensate for the deleted time</li>
4777     <li>Deleting a region will move later regions to compensate for the deleted region's length</li>
4778     <li>Moving a region will move later regions to compensate for the length of the move</li>
4779     <li>Inserting a new region (via dragging or via Paste) will move later regions to the right to compensate</li>
4780   </ul>
4781 </p>
4782
4783 <p class="note">
4784   If <kbd class="menu">Snap To Grid</kbd> is enabled, then regions can
4785   only move so that they align with locations determined by the current
4786   snap settings (beats, or seconds, or other region boundaries, etc).
4787   See <a href="/editing-and-arranging/snap-to-the-grid">Snap To the Grid</a>
4788   for details.
4789 </p>
4790
4791 <h2>The <em>Smart</em> switch
4792
4793 <p>
4794   The <dfn>Smart Mode</dfn> button to the left of the mouse mode buttons
4795   modifies the <dfn>Grab Mode</dfn>. When enabled, the mouse behaves as if it
4796   is in "Range Mode" in the upper half of a region, and in "Grab Mode" in the
4797   lower half. This allows avoiding constant switching between these two modes.
4798 </p>
4799
4800 <h2>Mouse Modes</h2>
4801
4802 <dl class="wide-table">
4803
4804   <dt id="object">Grab Mode</dt>
4805   <dd>The <dfn>Grab Mode</dfn> is used for selecting, moving, deleting and
4806   copying objects. When in object mode, the mouse pointer appears as a hand
4807   whenever it is over the track canvas or the rulers. The mouse can now be
4808   used to select and perform operations on objects such as regions, markers etc.
4809   This is the most common mode to work in, as it allows you to select and move regions,
4810   as well as modify automation points on the automation tracks.</dd>
4811
4812   <dt>Range Mode</dt>
4813   <dd>When in <dfn>Range Mode</dfn>, the mouse pointer appears as a vertical line
4814   whenever it is over the track canvas or the rulers. The mouse will now be
4815   able to select a point or range of time. Time ranges can be selected over
4816   one or several tracks, depending on the selection of your tracks.<br>
4817   If none of your tracks are selected, the Range Tool will operate on all the
4818   session track visualized in the Editor.<br>
4819   If you want to edit only particular tracks, select them before you apply
4820   the range tool.</dd>
4821
4822   <dt>Cut Tool Mode</dt>
4823   <dd>When in <dfn>Cut Tool Mode</dfn>, the mouse pointer appears as a pair of scissors
4824   whenever it is over the track canvas or the rulers. This tools allows to cut
4825   any region into 2 regions at the mouse cursor, regardless of the Edit Point.<br>
4826   If one or more track(s) is selected, then all the regions on these tracks will
4827   be split at the mouse cursor position.<br>
4828   If no track is selected, then only the region hovered by the mouse cursor will
4829   be split.</dd>
4830
4831   <dt>Stretch Mode</dt>
4832   <dd>When in <dfn>time fx</dfn> mode, the mouse pointer appears as a
4833   distinctive expanding square symbol whenever it is over the track canvas or
4834   the rulers. This mode is used to resize regions using a timestretch
4835   algorithm. Click on an edge of a region of audio and drag it one way or the other to
4836   stretch or shrink the region.</dd>
4837
4838   <dt>Audition Tool</dt>
4839   <dd>Clicking a region using the <dfn>audition tool</dfn> will play this
4840   region to the control room outputs.<br>
4841   You can also <dfn>scrub</dfn> with this tool by clicking and dragging in
4842   the direction you wish to listen.  The amount you drag in one direction or
4843   the other will determine the playback speed.</dd>
4844
4845   <dt>Draw Tool</dt>
4846   <dd>When in <dfn>Draw Tool</dfn> mode, the mouse pointer will change to
4847   a pencil. You can then click within an audio region to change the <dfn>gain
4848   envelope</dfn> for that region. This curve is separate from fader automation
4849   for individual tracks. It will remain locked to the region's time, so if the
4850   region is moved, the region gain envelope is moved along with it.<br>
4851   The draw tool works on automation too, allowing the creation and modification
4852   of control points on the automation curves.<br>
4853   Last, it is used on a MIDI region to edit the notes.</dd>
4854
4855   <dt>Internal/Region Edit Mode</dt>
4856   <dd>When in <dfn>Internal Edit</dfn> mode, the mouse pointer will change to
4857   cross-hairs. This tool acts on gegion gain and automation as the Draw tool.<br>
4858   On a MIDI region, it allows to lasso-select multiple notes at a time.</dd>
4859 </dl>
4860
4861 <p class="fixme">Make sure the Internal Edit and Draw tool act as described</p>
4862
4863 ---
4864 title: the Zoom Controls
4865 part: subchapter
4866 ---
4867
4868 <img class="left" src="/images/toolbar-zoom.png" alt="Editor toolbar's zoom">
4869
4870 <p>The zoom controls allow to navigate the session along both the time and track axes.</p>
4871
4872 <p>The drop down <kbd class="menu">Zoom Focus</kbd> menu allows to select a focus
4873 point for the zoom, i.e. the center of the zoom. The choices are :</p>
4874
4875 <ul>
4876   <li><dfn>Left</dfn> of the screen</li>
4877   <li><dfn>Right</dfn> of the screen</li>
4878   <li><dfn>Center</dfn> of the screen</li>
4879   <li><dfn>Playhead</dfn></li>
4880   <li><dfn>Mouse</dfn></li>
4881   <li><dfn>Edit Point</dfn> as set in the <a href=" fixme ">Edit point</a> control.</li>
4882 </ul>
4883
4884 <p>The 2 leftmost zoom buttons (<kbd class="menu">&minus;</kbd> and
4885 <kbd class="menu">&plus;</kbd>) use this zoom focus to zoom out and in
4886 respectively.<p>
4887
4888 <p>The <kbd class="menu">Zoom to session</kbd> button is a handy shortcut to zoom
4889 out or in until all the session (as defined by it's <a href=" fixme ">start/end
4890 markers</a>) fits horizontally.</p>
4891
4892 <p>Changing the <kbd class="menu">Number of visible tracks</kbd> dropdown menu
4893 allows to fit this number of tracks vertically in the screen.<p>
4894
4895 <p class="note">There <em>is</em> a minimal track height to keep it visible, so
4896 according to you screen vertical size, some high number can have no effect.</p>
4897
4898 <p>Inside this menu are 2 handy choices :</p>
4899 <ul>
4900   <li><dfn>Selected tracks</dfn> that focus on the selected tracks. If the selected
4901   tracks are not contiguous, the unselected tracks inbetween will be hidden, see
4902   the <a href=" fixme ">Track and Bus list</a>.</li>
4903   <li><dfn>All</dfn> that fits all the tracks of the sessions vertically (provided
4904   there's enough screen estate).</li>
4905 </ul>
4906
4907 <p>The rightmost buttons <kbd class="menu">Shrink tracks</kbd> and
4908 <kbd class="menu">Expand tracks</kbd> reduce or expand the vertical size of the
4909 selected tracks. If no track is selected, all the tracks will be shrunk or
4910 expanded each time the button is pushed.
4911
4912 ---
4913 title: the Grid Controls
4914 part: subchapter
4915 ---
4916
4917 <img class="left" src="/images/toolbar-grid.png" alt="Editor toolbar's grid">
4918
4919 <p>
4920   Ardour's editor utilizes a <dfn>grid</dfn> to assist in the placement
4921   of regions on the timeline, or with editing functions that need to happen
4922   at a specific point in time.  You can choose if you want the cursor and
4923   various objects to snap to this grid, and how you want the snapping to
4924   behave. You can modify the grid units to fit your needs.
4925 </p>
4926
4927 <h2>About Snapping</h2>
4928
4929 <p>There are two ways to think about aligning material to a grid.
4930   The first and most obvious one is where an object's position is clamped
4931   to grid lines. In Ardour, this is called <dfn>absolute snap</dfn>
4932   and is commonly used when working with sampled material where audio
4933   begins exactly at the beginning of a file, note or region.</br>
4934   The second, <dfn>relative snap</dfn>, is used when an object's position
4935   relative to the grid lines is important. In music, this allows you to
4936   move objects around without changing the "feel" (or timing) of a performance.</br>
4937   Absolute snap is the default method of snapping in Ardour.</br>
4938   While dragging objects you may switch from absolute to relative snap by
4939   pressing the absolute snap modifier key(s).</br>
4940   You may also disable snap entirely by using the snap modifier (see below).</br>
4941   Note that in relative snap mode the reference point is taken to be the distance
4942   to the nearest grid line.</br>
4943   Note also that when an object lies exactly on a grid line, there will be no difference
4944   between relative and absolute snap modes.</br>
4945   The realtive snap and snap modifiers (along with other modifier keys) may be set in
4946   <kbd class="menu">Edit &gt; Preferences &gt; User Interaction</kbd></br>
4947   For common use patterns, it is recommended that you assign a unique key for
4948   one snap modifier and two keys for the other in such a way that they share an otherwise unused key.
4949   For example, you may choose the snap modifier to be the <kbd class="mod2">&nbsp;</kbd> key and the
4950   relative snap modifier to be the <kbd class="mod2">&nbsp;</kbd> and <kbd class="mod4">&nbsp;</kbd> keys.
4951 </p>.
4952
4953 <h2>Snap Modes</h2>
4954 <p>
4955   Using the above modifications, Ardour supports three different modes of snapping to the grid:
4956 </p>
4957
4958 <dl class="wide-table">
4959   <dt><kbd class="menu">No Grid</kbd></dt>
4960   <dd>disables the grid. All objects move freely in this mode.</br>
4961   In <kbd class="menu">No Grid</kbd> mode, you may temporarily activate the grid by pressing the
4962   snap modifier (for absolute snap) or switch to relative snap by pressing the relative snap modifier.</dd>
4963   <dt><kbd class="menu">Grid</kbd></dt>
4964   <dd>activates normal snapping. All positions of objects snap to
4965   the grid. (See <a href="#gridunits">Grid Units</a> below
4966   to change the grid). If you try to move an object in "Grid"-mode, it
4967   does not change its position until you move the mouse far enough for the
4968   object to reach the next grid line.</br>
4969   Sometimes you may wish to maintain an objects' position relative to the grid line.
4970   In order to do this, use the "snap relative" modifier.
4971   When holding down this modifier during a drag, the dragged object will jump
4972   while maintaining its original distance from the line.</br>
4973   New objects will always be created at grid points.</br>
4974   Holding down the snap modifier will disable the current grid setting and allow you to move the object freely.</br>
4975   </dd>
4976   <dt><kbd class="menu">Magnetic</kbd></dt>
4977   <dd>is a less strict type of snapping. Objects can still be moved to any
4978   position, but positions close to the relative or absolute grid points will snap.
4979   In order to move an object very close to a snap point, it may be necessary
4980   to zoom in to prevent snapping to that point, or to use the snap modifier to disable snap completely.</br>
4981   As with Grid mode, the snap modifier will disable snap completely while the
4982   absolute snap modifier will move the "notch" of Magnetic snap to the grid lines.</dd>
4983 </dl>
4984
4985 <h2>Syncing Regions to the Grid</h2>
4986 <p>
4987   By default, a region's beginning will be used as the reference for both types of snapping,
4988   but you can change this behaviour by setting a <dfn>sync point</dfn> in
4989   the region. Select the region(s) and press <kbd>V</kbd>. This will set
4990   the sync point to your edit point.</p>
4991
4992 <h2 id="gridunits">Grid Units</h2>
4993 <p>
4994   The selector next to the grid mode selector defines the size of the grid
4995   elements. You can set your grid to several different units:
4996 </p>
4997 <dl class="wide-table">
4998   <dt><kbd class="menu">CD Frames</kbd></dt>
4999   <dd>A CD Frame is 1/75th of a second. Snapping to CD Frames (using absolute snap) can be used to avoid issues with CD track
5000   lengths.</dd>
5001   <dt><kbd class="menu">Timecode Frames/Seconds/Minutes</kbd></dt>
5002   <dd>The duration of a frame depends on the timecode settings for the
5003   session.</dd>
5004   <dt><kbd class="menu">Seconds/Minutes</kbd></dt>
5005   <dd>These are absolute time units, unaffected by sample rate or timecode settings</dd>
5006   <dt><kbd class="menu">Beats/N</kbd></dt>
5007   <dd>Set the grid to units of 1/N beats, where N can be 128, 64, 32, 16, 8, 7, 6, 5, 4, 3, 2. The duration of a grid unit will depend on the tempo and meter in effect at that point in the timeline.</dd>
5008   <dt><kbd class="menu">Beats</kbd></dt>
5009   <dd>Set the grid to whole beats. The duration of a grid unit will depend on the tempo and meter in effect at that point in the timeline.</dd>
5010   <dt><kbd class="menu">Bars</kbd></dt>
5011   <dd>Set the grid to whole bars. The duration of a grid unit will depend on the tempo and meter in effect at that point in the timeline.</dd>
5012   <dt><kbd class="menu">Markers</kbd></dt>
5013   <dd>The grid lines are the markers.</dd>
5014   <dt><kbd class="menu">Region Starts</kbd></dt>
5015   <dd>The grid lines are constructed from region start points (see below).</dd>
5016   <dt><kbd class="menu">Region Ends</kbd></dt>
5017   <dd>The grid lines are constructed from region end points (see below).</dd>
5018   <dt><kbd class="menu">Region Syncs</kbd></dt>
5019   <dd>The grid lines are constructed from region sync points.</dd>
5020   <dt><kbd class="menu">Region Bounds</kbd></dt>
5021   <dd>The grid lines are constructed from region start or end points.</dd>
5022 </dl>
5023
5024 <p>
5025   To use Region starts/ends/syncs/bounds as snap choices, you must have
5026 either
5027 </p>
5028
5029 <ul>
5030   <li><em>No</em> tracks selected, which means that Ardour snaps to regions on any track, or </li>
5031   <li>Several tracks selected, which means that Ardour only snaps to regions on those selected tracks.</li>
5032 </ul>
5033
5034 <p>
5035   If you are moving items on a track, and only the current track is selected,
5036   then you will only be able to snap to other regions on the same track.
5037   This means that enabling
5038   <kbd class="menu">Edit &gt; Preferences &gt; Editor &gt; Link Selections of Regions and
5039   Tracks</kbd> will make the "Region" grid unit unusable.  Avoid the use of this option if
5040   you are going to use any of the Region grid units.
5041 </p>
5042
5043
5044 ---
5045 title: the Edit Point Control
5046 part: subchapter
5047 ---
5048
5049 <img class="left" src="/images/toolbar-editpoint.png" alt="Editor toolbar's Edit Point">
5050
5051 <p>
5052   Editing operations in a Digital Audio Workstation like Ardour can be broken
5053   down according to how many points on the timeline are required to carry the
5054   operation out. Splitting a region for example, requires just one position
5055   on the timeline (the one where the split will happen). Cutting out a time
5056   range requires two positions, one for the start of the cut and one for the end.
5057 </p>
5058
5059 <p>
5060   In Ardour the <dfn>edit point</dfn> is the location where most single-point
5061   editing operations take place. It can be set to either of the following:
5062 </p>
5063
5064 <ul>
5065   <li>the <dfn>Playhead</dfn> position</li>
5066   <li>the selected (or "active") <dfn>Marker</dfn></li>
5067   <li>the position of the <dfn>Mouse</dfn> (or touch) pointer</li>
5068 </ul>
5069
5070 <p>
5071   The default edit point is the location of the pointer.
5072 </p>
5073
5074 <p>
5075   There are 2 keybindings available to cycle through the edit point options.
5076   The most common workflow tends to involve switching back and forth between
5077   the playhead and mouse as the edit point. Press the grave accent key
5078   <kbd>`</kbd> to switch between these two. Use <kbd class="mod1">`</kbd> to
5079   cycle through all three choices (including the selected marker).  You can
5080   also switch the edit point using a combo-selector just right of the snap/grid
5081   unit selector.
5082 </p>
5083
5084
5085 ---
5086 title: The Nudge Controls
5087 part: subchapter
5088 ---
5089
5090 <img class="left" src="/images/toolbar-nudge.png" alt="Editor toolbar's Nudge">
5091
5092 <p>
5093   The <dfn>nudge controls</dfn> will move the selected region(s) by a fixed amount of time. The left and right buttons move either backward or forward in time, and the small clock to the left of these buttons sets the amount of time to nudge by. As with all other clocks, you can right-click on the clock to choose the time representation you want to use.
5094 </p>
5095
5096 <p>
5097   If there are no selected objects, the nudge controls can be used to move the playhead backward or forward by the amount shown on the clock.
5098 </p>
5099
5100 ---
5101 title: The Ruler
5102 part: subchapter
5103 ---
5104
5105 <img src="/images/ruler.png" alt="Ardour's Ruler">
5106
5107 <p>
5108   The <dfn>Ruler</dfn> scales the session along time, allows navigating, and can be marked for different uses. The main use of the Ruler is to move the playhead: clicking anywhere on the timeline will bring the playhead at this location in time.
5109 </p>
5110
5111 <p>
5112   It is made of a succession of rows, each having a special role related to time.From top to bottom, those rows are :
5113 </p>
5114
5115 <dl>
5116   <dt><dfn>Timecode</dfn></dt><dd>scaling the session whith the traditional Hours:Mins:Secs:Frames notation</dd>
5117   <dt><dfn>Bars:Beats</dfn></dt><dd>slicing the time according to the time signature ot the Meter</dd>
5118   <dt><dfn>Meter</dfb></dt><dd>shows the time signature. It can be changed along the timeline, by <kbd class="mouse">Right click</kbd> &gt; <kbd class="menu">New Meter</kbd>. The Bars:Beats ruler will reflect the change.</dd>
5119   <dt><dfn>Tempo</dfn></dt><dd>shows the BPM. It can be changed along the timeline, by <kbd class="mouse">Right click</kbd> &gt; <kbd class="menu">New Tempo</kbd>. The Bars:Beats ruler will reflect the change.</dd>
5120   <dt><dfn>Range Markers</dfn></dt><dd>allow to create and modify ranges directly on the Ruler.</dd>
5121   <dt><dfn>Loop/Punch Ranges</dfn></dt><dd>are special kind of ranges designed to be played as a loop and to do punch recording, i.e. recording on a precise section of time, respectively.</dd>
5122   <dt><dfn>CD Markers</dfn></dt><dd>are markers designed to be used while creating a recording that has to be split in time, as an audio CD</dd>
5123   <dt><dfn>Location Markers</dfn></dt><dd>is meant to receive any kind of marker, user generated or from Ardour itself.</dd>
5124 </dl>
5125
5126 <p>
5127   Most of the operations on the markers are described in <a href="/working-with-markers/">Working with Markers</a>, while the Meter, Tempo, Bars:Beats and Timecode use are described in <a href="/tempo-meter/tempo-and-meter/">Tempo and Meter</a>.
5128 </p>
5129
5130
5131 ---
5132 title: The Editor - The Editor's Lists
5133 part: chapter
5134 ---
5135
5136 <p>
5137   At the right of the editor window is an optional area which provides one of a
5138   range of useful lists of parts of your session. It is not shown by default
5139   when you first start using Ardour. The <dfn>Editor list</dfn> can be hidden
5140   or shown using <kbd class="menu">View &gt; Show Editor List</kbd>. The very
5141   right-hand side of the list gives a selection of tabs which are used to
5142   choose the list to view. The left-hand border of the list can be dragged to
5143   vary the width of the list.
5144 </p>
5145
5146 ---
5147 title: Region List
5148 part: subchapter
5149 ---
5150
5151 <p>
5152   The region list shows all the regions in the session. The left-hand column gives the region name, and there are a range of times given for information:
5153 </p>
5154
5155 <dl>
5156   <dt>Position</dt><dd>position of the start of the region on the global timeline</dd>
5157   <dt>End</dt><dd>position of the region on the global timeline</dd>
5158   <dt>Length</dt><dd>duration of the region</dd>
5159   <dt>Sync</dt><dd>position of the sync point, relative to the start of region (can be negative)</dd>
5160   <dt>Fade In</dt><dd>duration of the fade in. Can't be less than 1 ms, to avoid clipping.</dd>
5161   <dt>Fade Out</dt><dd>duration of the fade out (positive value, &ge; 1 ms).</dd>
5162 </dl>
5163
5164 <p>
5165   The units used to display those times are those used for the clock, so changing the units on the clocks change the display of this values.
5166 </p>
5167
5168 <p>
5169   At the right of the list are four columns of flags that can be altered:
5170 </p>
5171
5172 <dl>
5173   <dt>L</dt>
5174   <dd>whether the region position is locked, so that it cannot be moved.</dd>
5175   <dt>G</dt>
5176   <dd>whether the region's position is &lsquo;glued&rsquo; to bars and beats. If so, the region will stay at the same position in bars and beats even if the tempo and/or time signature change.</dd>
5177   <dt>M</dt>
5178   <dd>whether the region is muted, so that it will not be heard.</dd>
5179   <dt>O</dt>
5180   <dd>whether the region is opaque; opaque regions &lsquo;block&rsquo; regions below them from being heard, whereas &lsquo;transparent&rsquo; regions have their contents mixed with whatever is underneath. </dd>
5181 </dl>
5182
5183 <p>
5184   Hovering the mouse pointer over a column heading shows a tool-tip which can be handy to remember what the columns are for.
5185 </p>
5186
5187 <p>
5188   A handy feature of the region list is that its regions can be dragged and dropped into a suitable track in the session.
5189 </p>
5190
5191 ---
5192 title: Tracks and Busses List
5193 part: subchapter
5194 ---
5195
5196 <p>
5197   This lists the tracks and busses that are present in the session. The list order reflects the order in the editor, and you can drag-and-drop track or bus names in the editor list to re-order them in the editor. The columns in the list represent the following:
5198 </p>
5199
5200 <dl>
5201   <dt id="visible">V</dt>
5202   <dd>whether the track or bus is visible; they can be hidden, in which case they will still play, but just not be visible in the editor; this can be useful for keeping the display uncluttered.</dd>
5203   <dt id="active">A</dt>
5204   <dd>whether the track or bus is active; unactive tracks will not play, and will not consume any CPU.</dd>
5205   <dt id="input">I</dt>
5206   <dd>for MIDI tracks, whether the MIDI input is enabled; this dictates whether MIDI data from the track's inputs ports will be passed through the track.</dd>
5207   <dt id="record">R</dt>
5208   <dd>whether the track is record-enabled.</dd>
5209   <dt id="record-safe">RS</dt>
5210   <dd>whether the track is record safe; a record safe track cannot be armed for recording, to protect against a mistake.</dd>
5211   <dt id="mute">M</dt>
5212   <dd>whether the track is muted.</dd>
5213   <dt id="solo">S</dt>
5214   <dd>track solo state.</dd>
5215   <dt id="solo-isolated">SI</dt>
5216   <dd>track solo-isolated state.</dd>
5217   <dt id="solo-safe">SS</dt>
5218   <dd>solo safe state.</dd>
5219 </dl>
5220
5221 <p class="note">
5222   Each icon in these columns can be clicked to toggle the track/bus state, which is a very fast way to set multiple tracks/busses state at once.
5223 </p>
5224
5225 <p>
5226   As with the region list, hovering the mouse pointer over a column heading shows a tool-tip which can be handy to remember what the columns are for.
5227 </p>
5228
5229 ---
5230 title: Snapshot List
5231 part: subchapter
5232 ---
5233
5234 <p>
5235   This list gives the snapshots that exist of this session. Clicking on a snapshot
5236   name will load that snapshot.
5237 </p>
5238
5239 <p>
5240   See <a href="/working-with-sessions">Working with Sessions</a> for more
5241   information on snapshots.
5242 </p>
5243
5244 ---
5245 title: Track and Bus Group List
5246 part: subchapter
5247 ---
5248
5249 <p>
5250   This shows the track/bus groups that exist in the session. These groups allow related tracks to share various properties (such as mute or record enable state). For full details, see the section called <a href="/working-with-tracks/track-and-bus-groups/">Track and Bus Groups</a>.
5251 </p>
5252
5253 <p>
5254   The columns in this list are as follows:
5255 </p>
5256
5257 <dl>
5258   <dt>Col</dt>
5259   <dd>the colour that the group uses for its tab in the editor.</dd>
5260   <dt>Name</dt>
5261   <dd>the group name.</dd>
5262   <dt>V</dt>
5263   <dd>whether the tracks and busses in the group are visible.</dd>
5264   <dt>On</dt>
5265   <dd>whether the group is enabled.</dd>
5266   <dt>G</dt>
5267   <dd>ticked if the constituents of the group are sharing gain settings.</dd>
5268   <dt>Rel</dt>
5269   <dd>ticked if shared gains are relative.</dd>
5270   <dt>M</dt>
5271   <dd>ticked if the constituents share mute status.</dd>
5272   <dt>S</dt>
5273   <dd>ticked if the constituents share solo status.</dd>
5274   <dt>Rec</dt>
5275   <dd>ticked if the constituents share record-enable status.</dd>
5276   <dt>Mon</dt>
5277   <dd>whether the constituents share monitor settings.</dd>
5278   <dt>Sel</dt>
5279   <dd>whether the constituents are selected together.</dd>
5280   <dt>A</dt>
5281   <dd>whether the constituents share active status.</dd>
5282 </dl>
5283
5284 ---
5285 title: Ranges and Marks List
5286 part: subchapter
5287 ---
5288
5289 <p>
5290   The <dfn>Ranges &amp; Marks List</dfn> is a tab in the <dfn>Editor Lists</dfn> area on the right of the Editor window. If the editor list area isn't visible it can be enabled by checking <kbd class="option">View &gt; Show Editor List</kbd>. The Ranges &amp; Marks list can be used as a single point of control for all range and location markers (including the punch and loop ranges), or as a supplement to other methods of working with them.
5291 </p>
5292
5293 <h2>Common elements</h2>
5294
5295 <p>
5296   Each section has a set of <dfn>editable <a
5297   href="/ardours-interface/using-ardour-clock-displays/">clock widgets</a></dfn>
5298   which display
5299   the location of a marker, or the start, end, and duration times of a range,
5300   respectively.<br />
5301   The <kbd class="menu">Use PH</kbd> buttons allow you to set
5302   the corresponding clock to the current playhead position.
5303   A <kbd class="mouse">Middle</kbd> click on any of the clocks will move
5304   the playhead to that location. Both functions are also available from the
5305   clock context menus.<br />
5306   Right clicking on any of the clocks brings up a context menu that allows
5307   changing of the display between Timecode, Bars:Beats, Minutes:Seconds,
5308   and Samples.<br />
5309 </p>
5310
5311 <p>
5312  The <kbd class="menu">&mdash;</kbd> (subtract) button in front of each
5313  user-defined range or marker in the list allows that particular item to
5314  be removed. The name fields of custom ranges and markers can be edited.
5315 </p>
5316
5317 <p>
5318   The <kbd class="option">Hide</kbd> checkboxes make markers and ranges invisible
5319   on the respective ruler to reduce visual clutter; the markers remain
5320   active however, and can be used normally.<br />
5321   Selecting <kbd class="option">Lock</kbd> prevents the respective marker
5322   from being moved until unlocked.
5323   Where applicable, <kbd class="option">Glue</kbd> fixes the marker position
5324   relative to the current musical position expressed in bars and beats, rather
5325   than the absolute time. This will make the respective marker follow
5326   changes in the tempo map.
5327 </p>
5328
5329 <p>
5330   At the bottom of the list are buttons to add new markers or ranges.
5331 </p>
5332  <h2>List sections</h2>
5333
5334 <dl>
5335   <dt>Loop/Punch Ranges</dt>
5336   <dd>This list shows the current <dfn>loop</dfn> and <dfn>punch</dfn> range
5337   settings. Since these are built-in ranges, you cannot rename or remove them.</dd>
5338   <dt>Markers (Including CD Index)</dt>
5339   <dd>This section lists the session's <dfn>markers</dfn>. By ticking <kbd
5340   class="option">CD</kbd>, you instruct Ardour to create a <dfn>CD track
5341   index</dfn> from this marker, which will be included in the TOC or CUE file when you
5342   export.</dd>
5343   <dt>Ranges (Including CD Track Ranges)</dt>
5344   <dd>This is the list of <dfn>ranges</dfn> (including <dfn>CD track
5345   ranges</dfn>). Ticking <kbd class="option">CD</kbd> will convert
5346   the range to a <dfn>CD track</dfn>, which will again be included in
5347   exported TOC or CUE files. This is relevant for Disk-At-Once recordings
5348   that may contain audio data between tracks.</dd>
5349 </dl>
5350
5351 ---
5352 Title: The Summary
5353 part: subchapter
5354 ---
5355
5356 <img src="/images/summary.png" alt="Ardour's Summary">
5357
5358 <p>
5359   The <dfn>Summary</dfn> is a global overview of the session, allowing for a good "bird's eye" view of where in time and tracks the work happens.
5360 </p>
5361
5362 <p>
5363   Each horizontal line represents a track in the session, with the colored bars being the audio and MIDI regions, colored as per their track's color setting.
5364 </p>
5365
5366 <p>
5367   Two yellow vertical lines show the position of the <em>Start</em> and <em>End</em> markers, defining the session's length. The red line shows the playhead's position.
5368 </p>
5369
5370 <p>
5371   The transparent white rectangle represents what's actually displayed in the Editor window, i.e. what part of the session is beign looked at on screen.
5372 </p>
5373
5374 <p>
5375   The Summary also doubles as a navigator:
5376 </p>
5377
5378 <ul>
5379   <li>the arrows on the left allow to scroll the view horizontally, by 1 length of the veiw each time</li>
5380   <li>the arrows on the right allow to scroll vertically, by 1 track each time</li>
5381   <li>the white rectangle can be dragged anywhere on the session, moving the view accordingly</li>
5382   <li>each border and corner of the white square can be resized, changing the view accordingly</li>
5383 </ul>
5384
5385
5386 ---
5387 title: The Mixer
5388 part: chapter
5389 ---
5390
5391 <figure>
5392   <img src="/images/detailed-mixer-window.png" alt="Ardour's mixer window">
5393   <figcaption>
5394   <ol class="multicol3">
5395     <li>Favorite Plugins</li>
5396     <li>Strip List</li>
5397 </ol><ol class="multicol3" start="3">
5398     <li>Group list</li>
5399     <li>a track's strip</li>                        
5400 </ol><ol class="multicol3" start="5">
5401     <li>Master strip</li>
5402     <li>Monitor section</li>
5403   </ol>
5404   </figcaption>
5405 </figure>
5406
5407 <p>
5408   The <dfn>Mixer</dfn> window on the other hand represents signal flow and is the window you will probably be using most when mixing a session. It includes <dfn>channel strips</dfn> for each track and bus in your session. It has a general "vertical" sense to it: signals flow from the top of each channel strip through the processing elements in the strip to reach the output listed at the bottom.
5409 </p>
5410
5411 <p>
5412   This section describes the Mixer. To learn more about the process of mixing, see <a href="/mixing/">Mixing<a>.
5413 </p>
5414
5415 ---
5416 title: The Mixer - Favorite Plugins Window
5417 part: subchapter
5418 ---
5419
5420 <img class="right" src="/images/favorite-plugins.png" alt="Favorite Plugins window">
5421
5422 <p>
5423   The <dfn>Favorite Plugins</dfn> window is on the top-left side of the <dfn>Mixer Window</dfn>. Like other elements in that window it has variable height and can be hidden by dragging it to zero-height. If it is not visible, the top-handle can be grabbed and dragged down to reveal it.
5424 </p>
5425
5426 <p>
5427   Plugin names that have a right facing triangle next to them have presets associated with them; clicking on the triangle will cause all presets associated with the plugin to show in the list.
5428 </p>
5429
5430 <h2>Features</h2>
5431
5432 <img class="right" src="/images/mixer-to-fav-dnd.png" alt="Dragging plugin to Favorites window">
5433 <p>
5434   The Favorite Plugins window provides easy access to frequently used plugins:
5435 </p>
5436
5437 <ul>
5438   <li>Plugins can be dragged from the window to any track or bus <a href="/working-with-plugins/processor-box/"><dfn>processor box</dfn></a>, which will add the plugin to that track or bus at the given position.</li>
5439   <li>The list includes user-presets for the plugins. Dragging a preset to a given track or bus will load that preset after adding the plugin.</li>
5440   <li>Double-clicking on a plugin or preset adds the given plugin to all selected tracks/busses pre-fader. Other insert positions are available from the context menu (right click).</li>
5441   <li>Dragging a plugin from a track into the window will add it to the list and optionally create a new preset from the current settings. The horizontal line in the list shows the spot where the plugin will land.</li>
5442   <li>The context-menu allows the deletion of presets or removal of the plugin from the list.</li>
5443   <li>Plugins in the list can be re-ordered using drag &amp; drop. The custom order is saved.</li>
5444 </ul>
5445
5446 <p class="note">
5447   When favorites are added with the <a href="/working-with-plugins/plugin-manager">Plugin Manager</a>, they are appended to the bottom of the list.
5448 </p>
5449
5450 ---
5451 title: The Mixer - The Strips list
5452 part: subchapter
5453 ---
5454
5455 <p>
5456   The <dfn>Strips List</dfn> is a quick way to manage big sessions, with lots of tracks, where the mixer would otherwise be too crowded.
5457 </p>
5458
5459 <p>
5460   It is a list of all the tracks, busses and VCA in the session, with a tick to allow for hiding or showing them. This visibility status also affects the Editor view, and is exactly the same as toggling the <kbd class="option">V</kbd> checkbox in the <a href="/ardours-interface/the-editor/the-editor_s-lists/tracks-and-busses-list/">Tracks and Busses</a> panel of the Editor List.
5461 </p>
5462
5463 <p>
5464   Dragging and dropping tracks inside the Strips List allows to reorganise the tracks in the session, both in the Mixer and the Editor.
5465 </p>
5466
5467 <p>
5468   It is possible, by <kbd class="mouse">right</kbd> clicking, to act on multiple tracks at once:
5469 </p>
5470
5471 <ul>
5472   <li>Show All</li>
5473   <li>Hide All</li>
5474   <li>Show All Audio Tracks</li>
5475   <li>Hide All Audio Tracks</li>
5476   <li>Show All Audio Busses</li>
5477   <li>Hide All Audio Busses</li>
5478   <li>Show All MIDI Tracks</li>
5479   <li>Hide All MIDI Tracks</li>
5480 </ul>
5481
5482 <p>
5483   The <kbd class="menu">&plus;</kbd> button under the list is a shortcut to create a new track, bus or VCA, as in clicking <kbd class="menu">Track &gt; Add Track, Bus or VCA&hellip;</kbd>.
5484 </p>
5485
5486 ---
5487 title: The Mixer - The Groups list
5488 part: subchapter
5489 ---
5490
5491 <p>
5492   The <dfn>Goups List</dfn> allows to quickly manage the <a href="/working-with-tracks/track-and-bus-groups/">groups</a> of the session, and make use of them.
5493 </p>
5494
5495 <p>
5496   Each group has a <kbd class="option">Show</kbd> checkbox to quickly toggle their visibility. Clicking an already selected group allows to rename it.
5497 </p>
5498
5499 <p>
5500   The context menu, reached by <kbd class="mouse">right</kbd> clicking a group, allows for multiple mixing actions:
5501 </p>
5502
5503 <dl>
5504   <dt>Create New Group From...</dt><dd>Creates a new group based on some track properties. The choice is :
5505     <ul>
5506       <li><kbd class="menu">Selection...</kbd> to create a group of all selected tracks</li>
5507       <li><kbd class="menu">Record Enabled...</kbd> to create a group of all the tracks that are record enabled</li>
5508       <li><kbd class="menu">Soloed...</kbd> to create a group of all the soloed tracks</li>
5509     </ul></dd>
5510   <dt>Create New Group with Master From...</dt><dd>Acts exactly as the previous choice, but also creates a Control Master tied to these tracks.</dd>
5511   <dt>Assign Selection to Control Master...</dt><dd>Allows to link all the selected tracks to a chosen Control Master, whether or not they belong to a group.</dd>
5512   <dt>Assign Record Enabled to Control Master...</dt><dd>Allows to link all the record armed tracks to a chosen Control Master.</dd>
5513   <dt>Assign Soloed to Control Master...</dt><dd>Allows to link all the soloed tracks to a chosen Control Master.</dd>
5514   <dt>Enable All Groups</dt><dd>Enable all the groups, i.e. their selected properties are synchronized.</dd>
5515   <dt>Disable All Groups</dt><dd>Disable all the groups, i.e. changing a property in a track won't affect the others.</dd>
5516 </dl>
5517
5518 <p>
5519   When a group is selected, <kbd class="mouse">right</kbd> clicking it adds the following menu entries :
5520 </p>
5521
5522 <dl>
5523   <dt>Create New Group with Master From...</dt><dd>Acts exactly as the previous choice, but also creates a Control Master tied to these tracks.</dd>
5524   <dt>Edit Group...</dt><dd>Shows the <kbd class="menu">Track/bus Group</kbd> <a href="/working-with-tracks/track-and-bus-groups/">window</a>.</dd>
5525   <dt>Collect Group</dt><dd>Rearranges the tracks/busses order to visualy group together the tracks belonging to the same group.</dd>
5526   <dt>Remove Group</dt><dd>Deletes the group (but not the tracks/busses belongidng to this group).</dd>
5527   <dt>Assign Group to Control Master...</dt><dd>Allows to link all the tracks in the group to a chosen VCA.</dd>
5528   <dt>Add/Remove Subgroup Bus</dt><dd>Creates/removes a new bus connected to the Master, and send the output of all the tracks in the group to this new bus.</dd>
5529   <dt>Add New Aux Bus (pre/post-fader)</dt><dd>Creates a new bus connected to the Master, and create <a href="/signal-routing/aux-sends/">Aux Sends</a> (pre or post-fader) in all the tracks in the group to this new bus.</dd>
5530 </dl>
5531
5532 <p>
5533   The <kbd class="menu">&plus;</kbd> button under the list allows the creation of an (empty) group, while the <kbd class="menu">&minus;</kbd> button deletes the selected group (but not the tracks in this group).
5534 </p>
5535
5536 ---
5537 title: The Mixer - The Master Strip
5538 part: subchapter
5539 ---
5540
5541 <p class="fixme">add content</p>
5542
5543 ---
5544 title: The Mixer - The Monitor Section
5545 part: subchapter
5546 ---
5547
5548 <p class="fixme">add content</p>
5549
5550
5551 ---
5552 title: Sessions & Tracks
5553 part: part
5554 ---
5555
5556
5557 ---
5558 title: Sessions
5559 part: chapter
5560 ---
5561
5562
5563 ---
5564 title: New/Open Session Dialog
5565 part: subchapter
5566 ---
5567
5568 <p class="fixme">Info is out of date, image needs updating</p>
5569
5570 <p>
5571   The initial <dfn>Session</dfn> dialog consists of several consecutive pages:
5572 </p>
5573
5574 <h2>Open Session Page</h2>
5575 <p>
5576   On this page, you can open an <dfn>existing session</dfn>.  You can also
5577   open any <a href="/working-with-sessions/snapshots/">snapshot</a> of a
5578   particular session by clicking on the arrow next to the session name to
5579   display all snapshots, and then selecting one.  If your session is
5580   not displayed in the Recent Sessions list, the <kbd class="menu">Other
5581   Sessions</kbd> button will bring up a file selection dialog to navigate
5582   your hard drive.<br />
5583   Alternatively, you can opt to create a <kbd class="menu">New
5584   Session</kbd>.
5585 </p>
5586
5587 <h2>New Session page</h2>
5588 <p>
5589   Here you can type in the name of a session, select a folder to save in, and
5590   optionally use an existing <a href="/working-with-sessions/session-templates/">template</a>.
5591 </p>
5592 <p>
5593   Under <dfn>Advanced Options</dfn>, you can select whether you wish to create
5594   a Master Bus, or a Control Bus, and how many channels you wish either to have.
5595   You can also decide whether you want Ardour to automatically connect all inputs
5596   to the physical ports of your hardware. Ardour will do so
5597   sequentially and in round-robin fashion, connecting the first track's
5598   input to the first input of your hardware and so on. When Ardour has used
5599   all available hardware inputs, it will begin again with the first physical
5600   input.
5601   You can limit the number of channels on your physical hardware that Ardour
5602   uses.
5603 </p>
5604 <p>
5605   By default Ardour will connect all tracks and busses to the Master Bus if
5606   there is one. However you can also tell it to automatically connect each
5607   output to the physical outputs of your interface or sound card, and limit
5608   the number of physical outputs used, as above.
5609 </p>
5610
5611 <h3>Audio/MIDI Setup</h3>
5612
5613 <img class="right" src="/images/Audio-MIDI_Setup.png" alt="The Audio+MIDI
5614 Setup Dialog"/>
5615
5616 <p>
5617   This page is not displayed if <abbr title="JACK Audio Connection
5618   Kit">JACK</abbr> is already running when you start
5619   Ardour. It provides a simple interface to configure JACK, which
5620   will then be started by Ardour. For more control and options regarding
5621   JACK, it is recommended that you start JACK before using Ardour, via a
5622   JACK control application such as QJackCtl (sometimes called "Jack
5623   Control"), JackPilot, etc.
5624 </p>
5625 <dl>
5626   <dt>Audio System</dt>
5627   <dd>Currently, the only option here is <kbd class="menu">JACK</kbd>. In the future, native
5628   hardware access may be supported.</dd>
5629   <dt>Driver</dt>
5630   <dd>
5631     On Mac OS X this will typically be <kbd class="menu">CoreAudio</kbd>. On Linux usually
5632     this will be either <kbd class="menu"><abbr title="Free Firewire Audio Driver fOr
5633     linux">FFADO</abbr></kbd>
5634     or <kbd class="menu"><abbr title="Advanced Linux Sound
5635     Architecture">ALSA</abbr></kbd>, depending on whether or not you are
5636     utilizing a firewire device. Advanced users on all platforms may also
5637     use <kbd class="menu">NetJack</kbd> which provides network audio I/O.
5638   </dd>
5639   <dt>Device</dt>
5640   <dd>The selector should show all availiable interfaces provided by the
5641   driver above and which are capable of duplex operation.
5642   <p class="warning">
5643     If you are using an Intel Mac running OS X and the builtin audio
5644     interface, you must
5645     first <a href="setting-up-your-system/using_more_than_one_audio_device/">merge
5646     its separate input and output devices into a single "aggregate
5647     device"</a> before Ardour will be able to use it.
5648    </p>
5649   </dd>
5650   <dt>Sample Rate</dt>
5651   <dd>
5652     The selector will allow you to select from any sample rate
5653     supported by the device selected above it.
5654   </dd>
5655   <dt>Buffer Size</dt>
5656   <dd>
5657     You can adjust the size of the buffer used by your audio interface
5658     to allow for either lower latency, or lower CPU usage and higher
5659     latency.
5660   </dd>
5661   <dt>Input/Output Channels</dt>
5662   <dd>
5663     Here you can specify the number of hardware channels to use. The
5664     default is <kbd class="menu">all available channels</kbd>.</dd>
5665   <dt>Hardware Input/Output Latency</dt>
5666   <dd>Specify the hardware delay in samples for precise latency compensation.</dd>
5667   <dt>Calibrate</dt>
5668   <dd>
5669     This button guides you through a semi-automated process to obtain
5670     precise hardware latency measurements for the above option.</dd>
5671   <dt>MIDI System</dt>
5672   <dd>
5673     Select the MIDI driver to use. On Mac OS X, this will be <kbd
5674     class="menu">CoreMIDI</kbd>. On Linux, you can change between two legacy
5675     ALSA drivers or the (preferred) new JACK+ALSA implementation.</dd>
5676 </dl>
5677
5678 ---
5679 title: What's in a Session?
5680 part: subchapter
5681 ---
5682
5683 <p>
5684   The <dfn>Session</dfn> is the fundamental document type that is created and
5685   modified by the Ardour workstation.  A Session is a folder on your computer
5686   filesystem that contains all the items that pertain to a particular project
5687   or "recording/editing/mixing session".
5688 </p>
5689
5690 <p>
5691   The Session folder includes these files and folders:
5692 </p>
5693
5694 <ul>
5695   <li><code><em>session_name</em>.ardour</code> the main session snapshot</li>
5696   <li><code>*.ardour</code>, any additional snapshots </li>
5697   <li><code><em>session_name</em>.ardour.bak</code>, the auto-backup snapshot</li>
5698   <li><code><em>session_name</em>.history</code>, the undo history for the session </li>
5699   <li><code>instant.xml</code>, which records the last-used  zoom scale and other metadata</li>
5700   <li><code>interchange/</code>, a folder which holds your raw audio and MIDI
5701   files (whether imported or recorded)</li>
5702   <li><code>export/</code>, a folder which contains any files created by the
5703   <kbd class="menu">Session &gt; Export</kbd> function</li>
5704   <li><code>peaks/</code>, a folder which contains waveform renderings of
5705   all audio files in the session</li>
5706   <li><code>analysis/</code>, a folder which contains transient and pitch
5707   information of each audio file that has been analysed</li>
5708   <li><code>dead sounds/</code>, a folder which contains sound files which
5709   Ardour has detected are no longer used in the session (during a <kbd
5710   class="menu">Session &gt; Clean-up &gt; Clean-up Unused Sources</kbd>
5711   operation, will be purged by <kbd class="menu">Flush Waste Basket</kbd>)</li>
5712 </ul>
5713 <p>
5714   A session combines some setup information (such as audio and MIDI routing,
5715   musical tempo &amp; meter, timecode synchronization, etc.) with one or more
5716   Tracks and Buses, and all the Regions and Plug-Ins they contain.
5717 </p>
5718
5719 ---
5720 title: Where Are Sessions Stored?
5721 part: subchapter
5722 ---
5723
5724 <p>
5725   <dfn>Sessions</dfn> are stored in a single folder on your computer's filesystem.
5726 </p>
5727
5728 <p>
5729   The first time you run Ardour, you will be asked where you would like the
5730   default location for sessions to be, with the initial choice being your
5731   home folder.
5732 </p>
5733
5734 <p>
5735   After the first-run dialog, you can still change the default location at
5736   any time via <kbd class="menu">Edit &gt; Preferences &gt; Misc &gt; Session
5737   Management</kbd>. You can also specify a particular (different) location for
5738   a session when creating it, in the
5739   <a href="/working-with-sessions/new-session-dialog/">New Session dialog</a>.
5740 </p>
5741
5742 ---
5743 title: Backup and Sharing of Sessions
5744 part: subchapter
5745 ---
5746
5747 <p>
5748   An Ardour session is stored in a single folder on your computer's filesystem.
5749   This makes <dfn>backup</dfn> very easy&mdash;any tool capable of backing up
5750   a folder can be used to backup a session. You pick the location of a session
5751   when it is created&mdash;by default it will be in your default session location,
5752   which can be altered via <kbd class="menu">Edit &gt; Preferences &gt; Misc &gt; Session
5753   Management</kbd>.
5754 </p>
5755
5756 <p class="warning">
5757   There is one complication: a session may reference media files that are stored
5758   outside of the session folder, if the user has opted not to select <kbd
5759   class="optoff">Session &gt; Import &gt; Copy to Session</kbd> during
5760   import. Backing up a session with embedded files will not create a
5761   copy of the session containing those files.
5762 </p>
5763
5764 <p>
5765   The single folder approach also makes sharing a project easy. Simply copy the session
5766   folder (onto a storage device, or across a network) and another Ardour user (on any
5767   platform) will be able to use it. The limitation regarding embedded files applies to
5768   session sharing as well.
5769 </p>
5770
5771 ---
5772 title: Interchange with other DAWs
5773 part: subchapter
5774 ---
5775
5776 <p>
5777   It has never been particularly easy to move sessions or projects from one
5778   <abbr title="Digital Audio Workstation">DAW</abbr> to another. There are two
5779   <dfn>interchange standards</dfn> that have reasonably widespread support:</p>
5780 <ul>
5781   <li>OMF (Open Media Framwwork), also known as OMFI. Developed and controlled
5782   by Avid, never standardized</li>
5783   <li>AAF (Advanced Authoring Format). Developed by a consortium of media-related
5784   corporations.</li>
5785 </ul>
5786 <p>
5787   In practice both of these standards have such complex and/or incomplete
5788   specifications that different DAWs support them only partially,
5789   differently, or not at all.
5790 </p>
5791 <h2>Moving an Ardour session to another DAW</h2>
5792 <p>To move an Ardour session to another DAW, you have 3 basic choices:</p>
5793 <ul>
5794   <li>Copy the interchange folder</li>
5795   <li>Stem exports</li>
5796   <li>Use AATranslator</li>
5797 </ul>
5798 <h3>Moving another DAW session to Ardour</h3>
5799 <p>To move a session from another DAW to Ardour, you have 2 basic choices:</p>
5800 <ul>
5801 <li>Stem exports</li>
5802 <li>Use AATranslator</li>
5803 </ul>
5804
5805 ---
5806 title: Copying The Interchange Folder
5807 part: subchapter
5808 ---
5809
5810 <p>
5811   All media in a session folder is stored in a sub-folder called
5812   <samp>interchange</samp>. Below that is another folder with the name
5813   of the session. You can copy either of these to another location and
5814   use the files within them with any other application, importing them
5815   all into a project/session. You will lose all information about regions,
5816   tracks, and timeline positioning, but all the data that Ardour was working
5817   with will be present in the other DAW. Nothing below the interchange
5818   folder is specific to Ardour&mdash;any DAW or other audio/MIDI
5819   application should be able to handle the files without any issues.
5820 </p>
5821
5822 ---
5823 title: Stem Exports
5824 part: subchapter
5825 ---
5826
5827 <p>
5828   <dfn>Stem exports</dfn> are covered fully in the
5829   <a href="/exporting">Export</a> chapter. A stem export creates one file
5830   per track, starting at the beginning of the session. You can then import
5831   each track into another DAW and begin working on it. You lose all data
5832   except the actual audio/MIDI (no plugins, no automation). This is one of
5833   the most common methods of interchange because it works between all DAWs.
5834 </p>
5835
5836 ---
5837 title: Using AATranslator
5838 part: subchapter
5839 ---
5840
5841 <p>
5842   <dfn>AATranslator</dfn> is a Windows
5843   application that can convert sessions/projects from many diffferent DAWs
5844   into other formats. At the present time (December 2016), it can read and
5845   write Ardour 2.X sessions, and can read Ardour 3 sessions.
5846 </p>
5847 <p>
5848   The program runs very well on Linux using
5849   <a href="http://www.winehq.org/">Wine</a> (a Windows environment for Linux).
5850   There are equivalent solutions for running Windows applications on OS X,
5851   but we have no experience with them at this time. Ardour users have reported
5852   great results using AATranslator on Ardour 2.X sessions.</p>
5853 <p>
5854   The <a href="http://www.aatranslator.com.au/">AATranslator website</a>
5855   has full details on supported formats and DAWs. The list includes
5856   ProTools, Live, Reaper, OMF, AAF and many more.
5857 </p>
5858 <p class="warning">
5859   AATranslator is closed-source, non-free software (as of this writing, Dec. 2016, the cost is 60 USD for the "Standard" version, and 200 USD for the "Enhanced" version).
5860 </p>
5861
5862 ---
5863 title: Renaming a Session
5864 part: subchapter
5865 ---
5866
5867 <p>
5868   Use <kbd class="menu">Session &gt; Rename</kbd> to give your session a
5869   new name. A dialog will appear to ask you for the new name.
5870 </p>
5871
5872 <p>
5873   This operation does <strong>not</strong> make a new session folder &mdash;
5874    the existing session folder and relevant contents are renamed. If your
5875    session was not saved before a rename operation, it will be saved
5876    automatically and then renaming will continue.
5877 </p>
5878
5879 <p class="warning">
5880   Ardour's <kbd class="menu">Session &gt; Save As</kbd> operation will not
5881   make a new copy of the session folder and its contents. All it does is
5882   create a new session file.
5883 </p>
5884
5885 ---
5886 title: Session Templates
5887 part: subchapter
5888 ---
5889
5890 <p>
5891   <dfn>Session templates</dfn> are a way to store the setup of a session
5892   for future use. They do not store any <em>audio</em> data but can store:
5893 </p>
5894
5895 <ul>
5896   <li>The number of tracks and busses, along with their names</li>
5897   <li>The plugins present on each track or bus (if any)</li>
5898   <li>All I/O connections</li>
5899 </ul>
5900
5901 <h2>Creating a Session Template</h2>
5902
5903 <p>
5904   Choose <kbd class="menu">Session &gt; Save Template</kbd>. A dialog will ask
5905   you for the name of the new template.
5906 </p>
5907
5908 <h2>Using a Session Template</h2>
5909
5910 <p>
5911   In the New Session dialog, choose the desired template from the combo
5912   selector.
5913 </p>
5914
5915 <p>
5916   Note that you can also use an existing session as a template, without
5917   saving it as one. This is available as an option in the New Session dialog.
5918   Doing this will not alter the existing session at all, but will use its track,
5919   bus and plugin configuration just like a template.
5920 </p>
5921
5922 <p>
5923   See also <a href="/missing">Track &amp; Bus templates</a> for information
5924   on templates for individual tracks or busses.
5925 </p>
5926
5927 <p class="fixme">Broken link</p>
5928
5929 ---
5930 title: Snapshots
5931 part: subchapter
5932 ---
5933
5934 <p>
5935   Sometimes you will want to save a <dfn>snapshot</dfn> of the current state of a session for possible
5936   use in the future. For example, you may be about to change the entire
5937   arrangement of a piece, or drastically alter the signal processing, and
5938   want a reference to come back to, should that not work out.
5939 </p>
5940
5941 <p>
5942   This is easily accomplished using <kbd class="menu">Session &gt;
5943   Snapshot</kbd>.
5944   A small dialog will appear, allowing you to enter a name for the snapshot.
5945   The default name is based on the current date and time.<br />
5946   You can create any number of snapshots.
5947 </p>
5948
5949 <p class="warning">
5950   Creating a snapshot does <strong>not</strong> modify your session,
5951   nor does it save your session. Instead, it saves an alternate version
5952   of the session, within the session folder. The snapshot shares all data
5953   present in the session.
5954 </p>
5955
5956 <p>
5957   After creating a snapshot, you can continue working on the session and
5958   save it normally using <kbd class="menu">Session &gt; Save</kbd> and any
5959   existing snapshots will remain unchanged.
5960 </p>
5961
5962 <h2>Switching to a Snapshot</h2>
5963
5964 <p>
5965   If you are already working on a session and want to to switch to an
5966   existing snapshot, navigate the Snapshots tab of the
5967   <a href="/ardours-interface/introducing-the-editor-window/editor-lists">Editor List</a>.
5968   Find the name of the snapshot in the list and click it. Ardour will switch
5969   to the snapshot. If there are unsaved changes in the  current session, Ardour will
5970   ask what you want to do.
5971 </p>
5972
5973 <h2>Starting Ardour With a Snapshot</h2>
5974
5975 <p>
5976   Since a snapshot is just another session file stored within the session
5977   folder, you can specify that "version" when loading an existing session.
5978   The browser in the "Open Session" dialog will show an expander arrow for
5979   sessions that have more than 1 session file (i.e. snapshots) present&mdash;click on it to see the list, and then click on the name of the
5980   snapshot you want to load.
5981 </p>
5982
5983 <h2>Saving and Switching to a Snapshot</h2>
5984
5985 <p>
5986   Sometimes you may want to create a snapshot and then have all future
5987   edits and modifications saved to that snapshot rather than the main
5988   session. This is easily done using <kbd class="menu">Session &gt; Save
5989   As</kbd>. This does not create a new session folder,  but saves your
5990   session as a new snapshot and then switches the "current snapshot"
5991   to the newly created one. All subsequent saves of the session will
5992   be stored in this new snapshot, and existing snapshots (and the main
5993   session) will be left unaffected.
5994 </p>
5995
5996 ---
5997 title: Metadata
5998 part: subchapter
5999 ---
6000
6001 <p>
6002   Sessions can have various items of metadata attached to them, via
6003   <kbd class ="menu">Session &gt; Metadata &gt; Edit Metadata...</kbd> and
6004   <kbd class ="menu">Session &gt; Metadata &gt; Import Metadata...</kbd>.
6005 </p>
6006
6007 <h2>Edit Session Metadata Dialog</h2>
6008
6009 <img src="/images/edit-session-metadata.png" />
6010
6011 <p class="fixme">Add content</p>
6012
6013 ---
6014 title: Cleaning up Sessions
6015 part: subchapter
6016 ---
6017
6018 <p>
6019   Recording and editing any serious session might leave the session with some
6020   unused or misplaced files here and there. Ardour can help deal with this clutter thanks
6021   to the tools located in the <kbd class="menu">Session &gt; Clean-up</kbd> menu.
6022 </p>
6023
6024 <h2 id="bring_all_media_into_session_folder">Bring all media into session folder</h2>
6025
6026 <p>
6027   When <a href="/adding-pre-existing-material/">importing media files</a>, if
6028   the <kbd class="option">Copy files to session</kbd> hasn't been checked, Ardour uses
6029   the source file from its original destination, which can help avoiding file duplication.
6030   Nevertheless, when the session needs to be archived or transfered to another computer, moving
6031   the session folder won't move those <em>external</em> files as they are not in the folder, as seen
6032   in <a href="/working-with-sessions/backup-and-sharing-of-sessions/">Backup and sharing of sessions</a>.
6033 </p>
6034
6035 <p>
6036   Using the <kbd class="menu">Bring all media into session folder</kbd> menu ensures
6037   that all media files used in the session are located inside the session's folder, hence avoiding
6038   any missing files when copied.
6039 </p>
6040
6041 <h2 id="reset_peak_files">Reset Peak Files</h2>
6042
6043 <p>
6044   Ardour represents audio waveforms with peak files, that are graphical images generated from the
6045   sound files. This generation can be time and CPU consuming, so it uses a cache of the generated
6046   images to speed up the display process. To watch for files modification, Ardour relies on the file-modification
6047   time. If an external file is embedded in the session and that file changes, but the system-clock is skewed
6048   or it is stored on an external USB disk (VFAT), Ardour can't know the change happend, and will still use its
6049   deprecated peak files.
6050 </p>
6051
6052 <p>
6053   Using the <kbd class="menu">Reset Peak Files</kbd> menu allows to reset this cache, which frees up disk space,
6054   and forces the re-creation of the peak files used in the session. It can prove useful if some waveforms
6055   are not used anymore, or if a graphical or time glitch happens.
6056 </p>
6057
6058 <h2 id="clean_up_unused_sources">Clean-up Unused Sources...</h2>
6059
6060 <p>
6061   Recording usually lefts a lot of unused takes behind, be it in midi or audio form, that can clutter
6062   the Region List, and eat up a lot of hard drive space. While its generally a good practice to keep as
6063   many things as possible while recording, when transferring or archiving the session, some clean up can
6064   help a lot in reducing the sessions clutter and size.
6065 <p>
6066
6067 <p>
6068   Selecting <kbd class="menu">Clean-up Unused Sources...</kbd> will force Ardour to detect those unused waveforms
6069   by looking for unused regions, and (through a prompt) for unused playlists. The media files won't be destroyed, though.
6070   At this stage, they are just copied in a particular place of the session path (namely, in the <code>dead sounds/</code>
6071   sub-folder).
6072 </p>
6073
6074 <h2 id="flush_wastebasket">Flush Wastebasket</h2>
6075
6076 <p>
6077   Although Ardour is a <em>non-destructive</em> audio-editor, it allows for a very careful destruction of unused media materials.
6078   This function is closely linked to the previous one. When the unused sources have been cleaned up and quarantined, the
6079   <kbd class="menu">Flush Wastebasket</kbd> menu will allow for their physical destruction.
6080 </p>
6081
6082 <p>
6083   As a safeguarding mechanism though, Flushing the wastebasket in impossible in the same working session as the Cleaning up of unused sources:
6084   the user needs to close the session and reload it before flushing. It allows to test the playback of the session and ensure both that Ardour didn't commit
6085   any mistake (unlikely, but better safe than sorry), and that the user is absolutely sure of what he does.
6086 </p>
6087
6088 <p class="warning">
6089   Notice that all media destroyed this way is not sent to the system's <em>trash can</em> but permanently deleted. If a file is mistakenly destroyed this way, the user will have to rely on data recovery techniques to try getting it back.
6090 </p>
6091
6092 ---
6093 title: Copying versus Linking
6094 part: subchapter
6095 ---
6096
6097 <p>
6098   <dfn>Copying</dfn> and <dfn>linking</dfn> are two different methods of
6099   using existing audio files on your computer (or network file system)
6100   within a session. They differ in one key aspect:
6101 </p>
6102
6103 <h2>Copying</h2>
6104
6105 <p>
6106   An existing media file is copied to the session's audio folder, and
6107   if necessary converted into the session's native format.
6108 </p>
6109
6110 <p>
6111   For audio files, you can control the choice of this format (eg. WAVE
6112   or Broadcast WAVE). Audio files will also be converted to the session
6113   sample rate if necessary (which can take several minutes for larger
6114   files).
6115 </p>
6116
6117 <p>
6118   MIDI files will already be in SMF format, and are simply copied into
6119   the session's MIDI folder.
6120 </p>
6121
6122 <h2>Linking</h2>
6123
6124 <p>
6125   A link to an existing media file somewhere on the disk is used as a the
6126   source for a region, but the data is <strong>not copied or modified</strong>
6127   in any way.
6128 </p>
6129
6130 <p class="warning">
6131   While linking is handy to conserve disk space, it means that your session
6132   is <dfn>no longer self-contained</dfn>. If the external file moves, it
6133   will become unavailable, and any changes to it from elsewhere will affect
6134   the session. A backup of the session directory will miss linked files.
6135 </p>
6136
6137 <p>
6138   You can choose to copy or link files into your session with the
6139   <kbd class="option">Copy file to session</kbd> option in the Import
6140   dialog window.
6141 </p>
6142
6143 <p>
6144   <img class="left" src="/images/225-ARDOUR_1_2_1.png" />
6145   &larr; This file will be imported in the audio/MIDI folder of your session.
6146 </p>
6147
6148 <p>
6149   <img class="left" src="/images/226-ARDOUR_1_2_1.png" />
6150   &larr; This file won't be copied.
6151 </p>
6152
6153 <p class="note">
6154   There is a global preference <kbd class="menu">Edit &gt; Preferences &gt; Misc &gt; Session Management &gt; Always copy imported files</kbd>. If it is enabled, you will not be able to link a file.
6155 </p>
6156
6157 ---
6158 title: Adding Pre-existing Material
6159 part: subchapter
6160 ---
6161
6162 <p>
6163   There are several ways to importing an audio or MIDI file into a
6164   session:
6165 </p>
6166 <ul>
6167   <li><kbd class="menu">Session &gt; Import</kbd></li>
6168   <li>Region List context menu: <kbd class="menu">Import To Region List</kbd></li>
6169   <li>Track context menu: <kbd class="menu">Import Existing Media</kbd>
6170 </li>
6171 </ul>
6172 <p>
6173   These methods are all equivalent: they open the <a
6174   href="/adding-pre-existing-material/import-dialog/">Add Existing Media</a>
6175   dialog.
6176 </p>
6177 <p>
6178   Finally, you can also easily import files into your project by dragging
6179   and dropping a file from some other application (e.g. your platform's
6180   file manager). You can drag onto the
6181   <dfn>Region List</dfn>, into the desired <dfn>track</dfn> or into empty
6182   space in the editor track display.<br />
6183   The file will be imported and copied
6184   into your session, and placed at the position where the drag ended.
6185 </p>
6186
6187 ---
6188 title: Import Dialog
6189 part: subchapter
6190 ---
6191
6192 <p>
6193   Many sessions will require the use of <dfn>existing material</dfn>,
6194   whether it consists of audio and/or MIDI data. Using existing samples,
6195   loops and riffs from files stored on your system can be the basis for
6196   a new session, or a way to deepen and improve one that is already
6197   underway.
6198 </p>
6199
6200 <p>
6201   You can import audio and MIDI data into your session with the
6202   <dfn>Add Existing Media</dfn> dialog.
6203 </p>
6204
6205 <p class="fixme">Update image, possibly update content if out of date</p>
6206 <img src="/images/209-ARDOUR_1_2_1.png" />
6207
6208 <h2>The Soundfile Information Box</h2>
6209
6210 <p>
6211   This box will display information about the currently selected file:
6212 </p>
6213
6214 <ul>
6215   <li>number of channels,</li>
6216   <li>sample rate,</li>
6217   <li>file format,</li>
6218   <li>length,</li>
6219   <li>embedded timestamp (applies to some professional formats such as
6220   Broadcast WAVE), and</li>
6221   <li>tags (attached metadata to help categorize files in a library).</li>
6222 </ul>
6223
6224 <p>
6225   If the sample rate differs from the current session rate, it is displayed
6226   in red, which indicates that the file must be resampled before
6227   importing. Resampling is controlled by the <kbd class="menu">Conversion quality</kbd> option described below.
6228 </p>
6229
6230 <h2>Auditioner</h2>
6231
6232 <p>
6233   Files can be auditioned before importing. The slider under the play and
6234   stop buttons allows you to scrub around, a fader on the right side allows
6235   you to control the playback volume.
6236 </p>
6237
6238 <h2>Importing options</h2>
6239
6240 <p>
6241   You can import files into new, automatically created tracks, to the region
6242   list (from where you can manually drag them into a track), or as new
6243   <a href="/working-with-tracks/track-types/">Tape tracks</a> with the
6244   <kbd class="menu">Add new files as...</kbd> option.
6245 </p>
6246
6247 <p>
6248   New files will be inserted at either the file timestamp (if available,
6249   zero by default), at the <a href="/missing">edit point</a>, at the
6250   playhead, or at the start of the session, as specified in <kbd
6251   class="menu">Insert at...</kbd>.
6252 </p>
6253
6254 <p>
6255   The Channel <kbd class="menu">mapping</kbd> is either "one track/region per
6256   file", or "one track/region per channel". The latter splits multichannel
6257   source files into mono regions. If you have selected multiple files and are importing them into a track,
6258   you can also choose whether to sequence all files into a single track in
6259   the order of selection, or to create as many tracks as there are files to
6260   import.
6261 </p>
6262
6263 <p>
6264   The <kbd class="menu">Conversion quality</kbd> drop-down controls the
6265   quality of the resampling process, if the sampling rate of the source file
6266   differs from the session rate.
6267 </p>
6268
6269 <p>
6270   Finally, and most importantly, you can decide whether to <kbd
6271   class="option">Copy files to session</kbd>, or to link them. Please read
6272   <a href="/adding-pre-existing-material/copying-versus-linking/">Copying
6273   versus Linking</a> for details.
6274 </p>
6275
6276 ---
6277 title: Searching and Importing From Freesound
6278 menu_title: Freesound Search/Import
6279 part: subchapter
6280 ---
6281
6282 <p class="fixme">This section is irrelevant now, as the Freesound import function has been removed due to changes done on Freesound's end</p>
6283
6284 <p>
6285   <a href="http://www.freesound.org"
6286   title="http://www.freesound.org"><dfn>Freesound</dfn></a>
6287   is an online repository of searchable sound files licensed under
6288   Creative-Commons term. The <kbd class="menu">Search  Freesound</kbd> tab
6289   of the import dialog allows you to search the Freesound database,
6290   and to download and audition files directly.
6291 </p>
6292
6293 <dl>
6294   <dt>Tags</dt>
6295   <dd>Enter metadata tags that you would like to search for. You may enter
6296   multiple search terms separated by spaces. For example,
6297   <kbd class="input">drums 120bpm</kbd> will search for files that are tagged
6298   <samp>drums</samp>, <samp>120bpm</samp>, or both.</dd>
6299   <dt>Sort</dt>
6300   <dd>Choosing one of the sort options will cause Freesound to return the list
6301   of available files sorted accordingly. This can save time if you know (for
6302   example) the sound you need is very short.</dd>
6303   <dt>Search</dt>
6304   <dd>Click this button to initiate the search. Freesound will begin returning
6305   pages of information, with 20 items per page. The <kbd
6306   class="menu">Stop</kbd> button interrupts the download.</dd>
6307   <dt>The file list</dt>
6308   <dd>Click on a file to download it from Freesound. Double-click the file to
6309   auto-play it in the auditioner.</dd>
6310 </dl>
6311
6312 <p>
6313   Files imported with Freesound will automatically include any tags that are
6314   associated with the file, and these tags will be included in a search when
6315   you use the <kbd class="menu">Search Tags</kbd> tab.
6316 </p>
6317
6318 ---
6319 title: Searching for Files Using Tags
6320 part: subchapter
6321 ---
6322
6323 <p>
6324   A <dfn>tag</dfn> is bit of information, or metadata, that is associated
6325   with a data file. Specifically, tags are keywords or terms that you feel
6326   have some relevance to a particular soundfile. Ardour can store these tags
6327   in a searchable <dfn>database</dfn> so that you can quickly search for sounds
6328   based on the tags that you have assigned to them.
6329 </p>
6330
6331 <p>
6332   For example you can assign the term <kbd class="input">120bpm</kbd> to a
6333   sound, and then when you search for this tag, the file will appear in the
6334   search list. Tags are independent of the filename or anything else about
6335   the file. Tags, and the file paths that they are associated with, are
6336   stored in a file called <samp>sfdb</samp> in your Ardour user folder.
6337 </p>
6338
6339 <p>
6340   To <dfn>add tags</dfn> to a given file, open the <kbd class="menu">Session &gt;
6341   Import</kbd> dialog, select the file in the browser, and type new tags into tag
6342   area in the soundfile information box on the right. Tags are stored when the
6343   input box loses focus, there is no need to explicitly save them.
6344 </p>
6345
6346 <p>
6347   You can <dfn>search</dfn> for specific tags in the <kbd
6348   class="menu">Search Tags</kbd> tab of the same dialog. Files which have
6349   been tagged with the relevant terms will appear in the results window.
6350   Selected files can be auditioned and marked with additional tags if
6351   required.
6352 </p>
6353
6354 ---
6355 title: Supported File Formats
6356 part: subchapter
6357 ---
6358
6359 <p>
6360   The list of audio file formats that Ardour can understand is quite long.
6361   It is based on the functionality offered by <dfn>libsndfile</dfn>, an excellent and
6362   widely used software library by Australian programmer Erik de Castro Lopo.
6363   As libsndfile's capabilities expand, so will Ardour's abilities to import
6364   (and export) new formats. Ardour supports all common audio file formats,
6365   including WAV, AIFF, AIFC, CAF, W64 and BWF, with all typical sample formats
6366   (8-, 16-, 24-, 32-bit integer, floating point, and more).
6367 </p>
6368
6369 <p>
6370   You can find a full list of libsndfile's supported formats
6371   <a href="http://www.mega-nerd.com/libsndfile/#Features">here</a>.
6372 </p>
6373
6374 <p>
6375   For MIDI import, Ardour will read any Standard MIDI Format (SMF) file.
6376 </p>
6377
6378
6379 ---
6380 title: Tracks
6381 part: chapter
6382 ---
6383
6384
6385 ---
6386 title: Track Types
6387 part: subchapter
6388 ---
6389
6390 <p>
6391   Ardour offers three <dfn>track types</dfn> depending on the type of
6392   data they contain, and differentiates between three <dfn>track modes</dfn>,
6393   depending on their recording behaviour.
6394 </p>
6395
6396 <h2>Track types</h2>
6397
6398 <p>
6399   An Ardour track can be of type <dfn>audio</dfn> or <dfn>MIDI</dfn>,
6400   depending on the <dfn>data</dfn> that the track will primarily record
6401   and play back. <em>However, either type of track can pass either
6402   type of data.</em> Hence, for example, one might have a MIDI track that
6403   contains an instrument plugin; such a track would record and play back
6404   MIDI data from disk but would produce audio, since the instrument plugin
6405   would turn MIDI data into audio data.
6406 </p>
6407
6408 <p>
6409   Nevertheless, when adding tracks to a session, you typically have an idea
6410   of what you need to use the new tracks for, and Ardour offers you three
6411   choices:
6412 </p>
6413
6414 <dl class="narrower-table">
6415   <dt>Audio</dt>
6416   <dd>An <dfn>Audio Track</dfn> is created with a user-specified number of
6417   inputs. The number of outputs is defined by the master bus channel count
6418   (for details see <a href="#channelconfiguration">Channel Configuration</a>
6419   below). This is the type of track to use when planning to work with
6420   existing or newly recorded audio.</dd>
6421   <dt>MIDI</dt>
6422   <dd>A <dfn>MIDI track</dfn> is created with a single MIDI input, and a
6423   single MIDI output. This is the type of track to use when planning to
6424   record and play back MIDI. There are several methods to enable playback
6425   of a MIDI track: add an instrument plugin to the track, connect the
6426   track to a software synthesizer, or connect it to external MIDI hardware.
6427   <p class="note">
6428     If you add an instrument plugin, the MIDI track outputs audio instead
6429     of MIDI data.
6430   </p></dd>
6431   <dt>Audio/MIDI</dt>
6432   <dd>There are a few notable plugins that can usefully accept both <dfn>Audio
6433   and MIDI</dfn> data (Reaktor is one, and various "auto-tune" like plugins
6434   are another). It can be tricky to configure this type of track manually,
6435   so Ardour allows you to select this type specifically for use with such
6436   plugins. It is <em>not</em> generally the right choice when working normal
6437   MIDI tracks, and a dialog will warn you of this.</dd>
6438 </dl>
6439
6440 ---
6441 title: Adding Tracks, Busses and VCAs
6442 part: subchapter
6443 ---
6444
6445 <img class="right" src="/images/add-track-or-bus.png" alt="the add-track dialog" />
6446
6447 <p>
6448   A track, bus or VCA can be added to a session in various ways:
6449 </p>
6450
6451 <ul>
6452   <li>Choose <kbd class="menu">Track &gt; Add Track, Bus or VCA...</kbd>.</li>
6453   <li><kbd class="mouse">Right</kbd>-click in an empty part of the track controls area.</li>
6454   <li>Click the <kbd class="menu">Plus (+)</kbd> button underneath the list of tracks in the mixer.</li>
6455 </ul>
6456
6457 <p>
6458   Any of these actions will open the Add Track/Bus/VCA dialog.
6459 </p>
6460
6461 <dl>
6462   <dt>Add</dt>
6463   <dd>Here you can select the number of tracks, busses or VCAs you wish to create, and
6464   their <a href="/working-with-tracks/track-types/">types</a>.</dd>
6465   <dt>Name</dt>
6466   <dd>Defines the name of the new track(s). If multiple tracks are created, or if a track with the same name already exists, a space and number will be happened at the end (e.g.: Audio 1, Audio 2...)</dd>
6467   <dt>Configuration</dt>
6468   <dd>This menu lets you choose from a number of route templates, which determine the number of input ports and optionally contain plugins and other mixer strip configuration. The most common choices here are <em>mono</em> and <em>stereo</em>.</dd>
6469   <dt>Record mode</dt>
6470   <dd>This option is only available for audio tracks and affects how it behaves when recording. See <a href="/working-with-tracks/track-types/#trackmodes">Track Modes</a> for details.</dd>
6471   <dt>Instrument</dt>
6472   <dd>This option is only available for MIDI tracks and busses and lets you select a
6473   default instrument from the list of available plugins.</dd>
6474   <dt>Group</dt>
6475   <dd>Tracks and busses can be assigned groups so that a selected range of
6476   operations are applied to all members of a group at the same time (selecting
6477   record enable, or editing, for example). This option lets you assign to an
6478   existing group, or create a new group.</dd>
6479   <dt>Insert</dt>
6480   <dd>Defines where in the track list is the track created. The default is <em>Last</em>, i.e. after all the tracks and busses, and can also be <em>First</em>, <em>Before Selection</em> (to place it just above the selected track) or <em>After selection</em>.</dd>
6481   <dt>Output Ports</dt>
6482   <dd>Defines how the number of output responds to adding a plugin with a different number of outputs than the track itself. in <em>Strict I/O</em> mode, the track will only use a few of the plugins I/O and will keep its own number of output fixed, while in <em>lexible I/O</em> mode, it will automatically adapt to the I/O of its plugins. See <a href="/signal-routing/signal-flow/">Signal flow</a> to learn more about those options.</dd>
6483 </dl>
6484
6485 <p>
6486   New tracks appear in both the editor and mixer windows. The editor window
6487   shows the timeline, with any recorded data, and the mixer shows just the
6488   processing elements of the track (its plugins, fader and so on).
6489 </p>
6490
6491 <h2>Removing Tracks and Busses</h2>
6492
6493 <p>
6494   To <dfn>remove</dfn> tracks and busses, select them, <kbd
6495   class="mouse">right</kbd>-click and choose <kbd
6496   class="menu">Remove</kbd>
6497   from the menu. A warning dialog will pop up, as track removal cannot be undone;
6498   use this option with care!
6499 </p>
6500
6501 ---
6502 title: Selecting Tracks
6503 part: subchapter
6504 ---
6505
6506 <p>
6507   Tracks are <dfn>selected</dfn> by clicking on the Track header at the left
6508   of the Editor window. You can select multiple tracks with <kbd class="mod1
6509   mouse">Left</kbd> clicks, or a range of consecutive tracks with <kbd
6510   class="mod3 mouse">Left</kbd>.
6511 </p>
6512 <p>
6513   By default, <dfn>selecting regions</dfn> has no impact on
6514   <dfn>track selection</dfn>.
6515   You can select a track, then select a region in another track
6516   (or vice versa) and both selections will co-exist happily.
6517   Operations that are applied to tracks will use the track selection,
6518   and those that apply to regions will use the region selection.
6519   Similarly, deselecting a region will not deselect the track it
6520   is in (if that track was selected).
6521 </p>
6522 <p>
6523   In some workflows, and particularly if you have experience with
6524   other <abbr title="Digital Audio Workstation">DAW</abbr>s, this
6525   is not the most comfortable way to work. You may prefer to work
6526   in a style where selecting a region will also select the track
6527   that the region is in. Similarly, when the last selected region
6528   in a track is deselected, the track will also become unselected.
6529 </p>
6530 <p>
6531   To control this behaviour, set <kbd class="menu">Edit &gt;
6532   Preferences &gt; Editor &gt; Link selection of regions and tracks</kbd>.
6533 </p>
6534
6535 ---
6536 title: Controlling Track Appearance
6537 part: subchapter
6538 ---
6539
6540 <p>
6541   Ardour offers many options for controlling the appearance of tracks, including color, height, waveform style and more. These can all be found in the <kbd class="menu">Edit &gt; Preferences &gt; Editor</kbd> menu.
6542 </p>
6543
6544 ---
6545 title: Layering Display
6546 part: subchapter
6547 ---
6548
6549 <img class="right" style="clear:both" src="/images/track-layer-dialog.png"
6550 alt="Track layering menu" />
6551
6552 <p>
6553   Ardour allows arbitrary <dfn>layering</dfn> of regions&mdash;you can
6554   have as many regions you wish at a given position. By default, the regions are
6555   <dfn>overlaid</dfn> in the editor window, to save vertical space.
6556 </p>
6557
6558 <p>
6559   However, this display mode can be confusing for tracks with many overdubs,
6560   because its not obvious in which order the overdubs are layered. Although
6561   there are other methods of moving particular regions to the top of an
6562   overlapping set, and although Ardour also has playlists to let you manage
6563   <a href="/working-with-playlists/playlist_usecases/">takes</a> a bit more
6564   efficiently than just continually layering,
6565   there are times when being able to clearly see all regions in a track without
6566   any overlaps is reassuring and useful.
6567 </p>
6568
6569 <p>
6570   Here is an image of a track with a rather drastic overdub situation,
6571   viewed in normal <dfn>overlaid mode</dfn>:
6572 </p>
6573
6574 <img src="/images/a3_overlaps_layered.png" alt="overlapping regions in overlaid mode" />
6575
6576 <p>
6577   To change this display, right click on the track header, and you'll see
6578   the menu displayed above. There are two choices for layers. <kbd
6579   class="menu">overlaid</kbd> is currently selected. Click on <kbd
6580   class="menu">stacked</kbd> and the track display changes to this:
6581 </p>
6582
6583 <img src="/images/a3_layers_stacked.png" alt="overlapping regions in stacked mode" />
6584
6585 <p>
6586   You can still move regions around as usual, and in fact you can
6587   even drag them so that they overlay each again, but when you
6588   release the mouse button, things will flip back to them all being
6589   stacked cleanly. The number of <dfn>lanes</dfn> for the track is determined by
6590   the maximum number of regions existing in any one spot throughout
6591   the track, so if you have really stacked up 10 overdubs in one spot,
6592   you'll end up with 10 lanes. Obviously, using a large track height
6593   works much better for this than a small one.
6594 </p>
6595
6596 ---
6597 title: Track Color
6598 part: subchapter
6599 ---
6600
6601 <p>
6602   New tracks in Ardour are assigned a random color from a pastel color
6603   palette, so they should never end up being particularly bright or
6604   particularly dark.
6605 </p>
6606
6607 <h2>Changing the color of specific tracks</h2>
6608
6609 <p>
6610   Select the tracks whose color you wish to change. Context-click
6611   on the track header of one of them. From the context menu, select
6612   <kbd class="menu">Color</kbd> and pick a hue to your taste in the
6613   color dialog. Every selected track will be re-colored.
6614 </p>
6615
6616 <p>
6617   Note that if you are only changing one track, context-clicking on
6618   that track's header will be enough to select it, saving the extra
6619   mouse click.
6620 </p>
6621
6622 <h2>Changing the color of all tracks in a group</h2>
6623
6624 <p>
6625   Tracks that belong to a
6626   <a href="/working-with-tracks/track-and-bus-groups">track/bus group</a>
6627   can share a common color by enabling the <kbd
6628   class="option">Color</kbd> option for the group. With this enabled,
6629   any color change will be propagated to all group members.
6630 </p>
6631
6632 <p>
6633   You can also explicitly change the group color by context-clicking
6634   on the group tab in the Mixer, selecting <kbd class="menu">Edit
6635   Group...</kbd> and then clicking on the Color selector in that dialog
6636   that is displayed.
6637 </p>
6638
6639 ---
6640 title: Track Height
6641 part: subchapter
6642 ---
6643
6644 <p>
6645   Depending on the stage of your production, you may require a quick
6646   overview over as many tracks as possible, a detailed view into just a
6647   few, or a combination of the two. To facilitate this, the
6648   <dfn>height</dfn> may be configured individually for each track in
6649   the editor window.
6650 </p>
6651
6652 <p>
6653   A context click on a track header will display the
6654   <kbd class="menu">Height</kbd> menu, and allow you to choose from a
6655   list of standard sizes. All selected tracks will be redrawn using that
6656   height.
6657 </p>
6658
6659 <p>
6660   Alternatively, select the tracks you wish to resize. Move the pointer
6661   to the bottom edge of one track header. The cursor will change to a
6662   two-way vertical arrow shape. <kbd class="mouse">Left</kbd>-drag to
6663   dynamically resize all selected tracks.
6664 </p>
6665
6666 <h2>Fit to the Editor Window</h2>
6667
6668 <p>
6669   Select the tracks you wish to display in the Editor window.
6670   Choose <kbd class="menu">Track &gt; Height &gt; Fit Selected Tracks</kbd>
6671   or use the keyboard shortcut, <kbd>f</kbd>. Ardour adjusts the track
6672   heights and view so that the selected tracks completely fill the vertical
6673   space available, unless the tracks cannot be made to fit even at the smallest
6674   possible size.
6675 </p>
6676
6677 <p class="note">
6678   You can use <dfn>Visual Undo</dfn> (default shortcut: <kbd class="mod3">Z</kbd>
6679   to revert this operation.
6680 </p>
6681
6682 ---
6683 title: Waveform display
6684 part: subchapter
6685 ---
6686
6687 <p>
6688   The display of <dfn>waveforms</dfn> (or, more correctly, <dfn>peak
6689   envelopes</dfn>, since the actual waveform is only visible at the highest
6690   zoom levels) is configurable via the <kbd
6691   class="menu">Edit &gt; Preferences &gt; Editor</kbd> dialog, to support
6692   different usecases and user preferences. The following options are
6693   available:
6694 </p>
6695
6696 <dl class="wide-table">
6697   <dt>Show waveforms in regions</dt>
6698   <dd>By default, Ardour draws waveforms within audio regions. Disable this
6699   option to hide them.</dd>
6700   <dt>Waveform scale</dt>
6701   <dd>
6702     <dl>
6703       <dt>Linear</dt>
6704       <dd>This is the traditional <dfn>linear</dfn> (1:1) display of the
6705       peak envelope, or, at higher zoom levels, the individual samples.</dd>
6706       <dt>Logarithmic</dt>
6707       <dd>Alternatively, you can use a <dfn>logarithmic</dfn> display of the
6708       peak envelope. This will give you a better idea of program loudness (it is similar
6709       to dBs) and plot soft passages more clearly, which is useful for soft
6710       recordings or small track height.</dd>
6711     </dl>
6712   </dd>
6713   <dt>Waveform shape</dt>
6714   <dd>
6715     <dl>
6716       <dt>Traditional</dt>
6717       <dd>The <dfn>zero</dfn> line appears in the middle of the display and waveforms
6718       appear as positive and negative peaks above <em>and</em> below.</dd>
6719       <dt>Rectified</dt>
6720       <dd>The zero line appears at the bottom of the display and waveforms appear
6721       as absolute peaks <em>above</em> the line only.</dd>
6722     </dl>
6723   </dd>
6724 </dl>
6725
6726 ---
6727 title: Controlling Track Ordering
6728 part: subchapter
6729 ---
6730
6731 <p>
6732   Ardour does not impose any particular ordering of tracks and busses in
6733   either the editor or mixer windows. The default arrangements are as follows:
6734 </p>
6735
6736 <p>
6737   In the <dfn>Editor</dfn>, the Master bus will always be on top unless
6738   hidden. Tracks and busses will appear in their initial order, from top to
6739   bottom. The monitor section (if used) will never be visible in the editor
6740   window.
6741 </p>
6742
6743 <p>
6744   In the <dfn>Mixer</dfn>, the tracks and busses will be displayed in their
6745   initial order, from left to right. The Master bus is always on the far
6746   right and occupies its own pane, so that it is always visible no matter
6747   how you scroll the other mixer strips. If a Monitor section is used,
6748   it shows up at the right edge of the mixer window, from where it can be
6749   torn off into a separate window.
6750 </p>
6751
6752 ---
6753 title: Reordering Tracks
6754 part: subchapter
6755 ---
6756
6757 <p>
6758   The <dfn>track ordering</dfn> of the Editor and Mixer is <dfn>synchronized</dfn>: if you
6759   reorder in one window, the ordering in the other window will follow.
6760 </p>
6761
6762 <h2>Reordering in the Editor Window</h2>
6763
6764 <p>
6765   Select the tracks you want to move. Then use<br />
6766   <kbd class="menu">Track &gt; Move Selected Tracks Up</kbd>
6767   (shortcut: <kbd class="mod1">&uarr;</kbd>) or<br />
6768   <kbd class="menu">Track &gt; Move Selected Tracks Down</kbd>
6769   (shortcut: <kbd class="mod1">&darr;</kbd>).
6770 </p>
6771
6772 <p>
6773   Alternatively, you can use the <kbd class="menu">Tracks &amp; Busses</kbd>
6774   panel of the
6775   <a href="/ardours-interface/introducing-the-editor-window/editor-lists/">Editor
6776   Lists</a>, if visible.
6777   Here, you can freely drag-and-drop tracks and busses into any order you prefer.
6778 </p>
6779
6780 <h2>Reordering in the Mixer Window</h2>
6781
6782 <p>
6783   Within the <kbd class="menu">Strips</kbd> pane at the top left of the
6784   Mixer window, you can freely drag-and-drop tracks and busses into any
6785   desired order.
6786 </p>
6787
6788 <h2>"Collecting" Group Members</h2>
6789
6790 <p>
6791   Tracks and Busses that are members of a group can be reordered so that they
6792   display contiguously within the Editor and Mixer windows. Context-click on
6793   the group tab and choose <kbd class="menu">Collect</kbd>.
6794 </p>
6795
6796 <h2>Ordering of New Tracks</h2>
6797
6798 <p>
6799   When <dfn>adding new tracks</dfn>, the current selection determines their
6800   placement. New tracks will be placed after the rightmost (in the mixer) or
6801   bottom-most (in the editor) selected track. If no tracks are selected, new
6802   tracks will be added at the end.
6803 </p>
6804
6805 <p class="note">
6806   Because new tracks are automatically selected, you can quickly reorder them
6807   in the editor window via the keyboard shortcuts after adding them (see above).
6808 </p>
6809
6810 ---
6811 title: Track Ordering and Remote Control IDs
6812 part: subchapter
6813 ---
6814
6815 <p>
6816   Every track and bus in Ardour is assigned a <dfn>remote control ID</dfn>. When a <a href="/using-control-surfaces/">control surface</a> or any other remote control is used to control Ardour, these IDs are used to identify which track(s) or buss(es) are the intended target of incoming commands.
6817 </p>
6818
6819 <p>
6820   Remote IDs will be assigned to tracks and buses in the order that they appear in the mixer window from left to right, starting from 1. Manual assignment of remote IDs is not possible. The master bus and monitor section can be accessed by name.
6821 </p>
6822
6823 ---
6824 title: Bus Controls
6825 part: subchapter
6826 ---
6827
6828 <p>A typical control area or <dfn>bus header<dfn> is shown below:</p>
6829
6830 <img src="/images/typical-bus-controls.png" alt="bus controls" />
6831
6832 <p>
6833   At the top-left of the controls is the name of the bus, which can be
6834   edited by double-clicking on it. The new name must be unique within the
6835   session. Underneath the name is a copy of the bus' main level fader.
6836   The control buttons to the right-hand side are:
6837 </p>
6838
6839 <dl>
6840   <dt id="mute">M</dt>
6841   <dd><dfn>Mute</dfn>&mdash;click to mute the bus. Right-click to display
6842   a menu which dictates what particular parts of the bus should be muted.</dd>
6843   <dt id="solo">S</dt>
6844   <dd><dfn>Solo</dfn>&mdash;solo the bus. The behaviour of the solo system
6845   is described in detail in the section <a
6846   href="/mixing/muting-and-soloing/">Muting and Soloing</a>.</dd>
6847   <dt id="automation">A</dt>
6848   <dd><dfn>Automation</dfn>&mdash;opens the automation menu for the
6849   bus. For details see <a href="/automation/">Automation</a>.</dd>
6850   <dt id="group">G</dt>
6851   <dd><dfn>Group</dfn>&mdash;lets you assign the bus to an existing or a
6852   new group. For details see <a href="/working-with-tracks/track-and-bus-groups/">Track and bus groups</a>. </dd>
6853 </dl>
6854
6855 ---
6856 title: Audio Track Controls
6857 part: subchapter
6858 ---
6859
6860 <p>
6861   A typical control area or <dfn>track header</dfn> for an audio track is
6862   shown below:
6863 </p>
6864
6865 <img src="/images/typical-audio-track-controls.png" alt="audio track controls"
6866   />
6867
6868 <p>
6869   An audio track has the same
6870   <a href="/working-with-tracks/bus-controls">controls as a bus</a>, with the
6871   addition of two extras.
6872 </p>
6873
6874 <dl>
6875   <dt id="record" style="color:red;font-weight:bold;">[&bull;]</dt>
6876   <dd><dfn>Record</dfn>&mdash;The button with the pink circle arms the track
6877   for recording. When armed, the entire button will turn pink, and change to
6878   bright red as soon as the transport is rolling and the track is recording.</dd>
6879   <dt id="playlist">p</dt>
6880   <dd><dfn>Playlist</dfn>&mdash;Opens a playlist menu when clicked. The menu
6881   offers various operations related to the track's <a
6882   href="/working-with-playlists/">playlist</a>.
6883   </dd>
6884 </dl>
6885
6886 ---
6887 title: MIDI Track Controls
6888 part: subchapter
6889 ---
6890
6891 <p>A typical <dfn>MIDI track header</dfn> looks like this:</p>
6892
6893 <img src="/images/typical-midi-track-controls.png" alt="midi track controls"
6894   />
6895
6896 <p>
6897   To see the full set of MIDI track controls, you need to increase the
6898   <a href="/working-with-tracks/controlling-track-appearance/track-height/">track height</a>
6899   beyond the default. MIDI tracks show only a few of the control elements
6900   when there is insufficient vertical space.
6901 </p>
6902
6903 <p>
6904   A MIDI track has the same basic
6905   <a href="/working-with-tracks/audio-track-controls">controls as an audio track</a>,
6906   with the addition of two extra elements. The set of buttons below the main track
6907   controls the <dfn>MIDI channel</dfn>(s) that will be visible in the editor. A MIDI track's
6908   data may span any number of the 16 available MIDI channels, and sometimes it is
6909   useful to view only a subset of those channels; different instruments may,
6910   for example, be put on different channels. Clicking on a channel number toggles
6911   its visibility.
6912 </p>
6913
6914 <p>
6915   To the right of the MIDI track controls is a representation of a piano keyboard
6916   called the <dfn>scroomer</dfn> (a portmanteau of scrollbar and zoomer). This performs several functions:
6917 </p>
6918
6919 <ul>
6920   <li>The scrollbar controls the range of pitches that are visible on the
6921   track, as visualized by the piano keyboard.</li>
6922   <li>Dragging the body of the scrollbar up and down displays higher or lower
6923   pitches.</li>
6924   <li>Dragging the scrollbar handles zooms in and out and increases and decreases the range of visible pitches.</li>
6925   <li>Clicking on the piano plays the corresponding MIDI note for reference.</li>
6926 </ul>
6927
6928 <p>
6929   To edit the contents of a MIDI track see <a href="/editing-and-arranging/edit-midi/">Edit
6930   MIDI</a>.
6931 </p>
6932
6933 ---
6934 title: Track Context Menu
6935 part: subchapter
6936 ---
6937
6938 <p>
6939   Within the editor window, context-click (right-click) on either a region
6940   or empty space within a track to display the <dfn>track context menu</dfn>.
6941   The context menu provides easy access to many track-level operations.
6942 </p>
6943
6944 <p>
6945   If you click on a <dfn>region</dfn>, the first item in the menu is the name of the
6946   region. If you click on a
6947   <a href="/working-with-tracks/controlling-track-appearance/layering-display/">layered region</a>,
6948   the next item in the menu is <kbd class="menu">Choose Top</kbd>. If selected,
6949   you will see a dialog that allows you to change the vertical order of layers
6950   at that point. See <a href="/missing">Controlling Region Layering</a> for more details.
6951   <p class="fixme">Broken link</p>
6952 </p>
6953
6954 <p>
6955   The rest of the track context menu is structured as follows:
6956 </p>
6957
6958 <dl class="narrower-table">
6959   <dt>Play</dt>
6960   <dd>
6961     <dl class="narrower-table">
6962       <dt>Play from Edit Point</dt>
6963       <dd>Play from the location of the current <a href="/editing-and-arranging/edit-point">edit point</a>.</dd>
6964       <dt>Play from Start </dt>
6965       <dd>Play from the start of the session</dd>
6966       <dt>Play Region(s)</dt>
6967       <dd>Plays the duration of the session from the start of the earliest selected region to the end of the latest selected region</dd>
6968     </dl>
6969   </dd>
6970   <dt>Select</dt>
6971   <dd>
6972     <dl class="narrower-table">
6973       <dt>Select All in Track</dt>
6974       <dd>Selects all regions in a track</dd>
6975       <dt>Select All Objects</dt>
6976       <dd>Selects all regions in the session</dd>
6977       <dt>Invert Selection in Track</dt>
6978       <dd></dd>
6979       <dt>Invert Selection</dt>
6980       <dd></dd>
6981       <dt>Set Range to Loop Range</dt>
6982       <dd></dd>
6983       <dt>Set Range to Punch Range</dt>
6984       <dd></dd>
6985       <dt>Select All After Edit Point</dt>
6986       <dd></dd>
6987       <dt>Select All Before Edit Point</dt>
6988       <dd></dd>
6989       <dt>Select All After Playhead</dt>
6990       <dd></dd>
6991       <dt>Select All Before Playhead</dt>
6992       <dd></dd>
6993       <dt>Select All Between Playhead and Edit Point</dt>
6994       <dd></dd>
6995       <dt>Select All Within Playhead and Edit Point</dt>
6996       <dd></dd>
6997       <dt>Select Range Between Playhead and Edit Point</dt>
6998       <dd></dd>
6999     </dl>
7000   </dd>
7001   <dt>Edit</dt>
7002   <dd>
7003     <dl class="narrower-table">
7004       <dt>Cut</dt>
7005       <dd></dd>
7006       <dt>Copy</dt>
7007       <dd></dd>
7008       <dt>Paste</dt>
7009       <dd></dd>
7010       <dt>Align</dt>
7011       <dd></dd>
7012       <dt>Align Relative</dt>
7013       <dd></dd>
7014     </dl>
7015   </dd>
7016   <dt>Insert Selected Region</dt>
7017   <dd></dd>
7018   <dt>Insert Existing Media</dt>
7019   <dd></dd>
7020   <dt>Nudge</dt>
7021   <dd>
7022     <dl class="narrower-table">
7023       <dt>Nudge Entire Track Later</dt>
7024       <dd></dd>
7025       <dt>Nudge Track After Edit Point Later</dt>
7026       <dd></dd>
7027       <dt>Nudge Entire Track Earlier</dt>
7028       <dd></dd>
7029       <dt>Nudge Track After Edit Point Earlier</dt>
7030       <dd></dd>
7031     </dl>
7032   </dd>
7033   <dt>Freeze</dt>
7034   <dd></dd>
7035 </dl>
7036
7037 <p>
7038 <i>This text here to prevent following FIXME from corrupting the above table</i>
7039 </p>
7040 <p class="fixme">Add missing content</p>
7041
7042
7043 ---
7044 title: Grouping Tracks
7045 part: chapter
7046 ---
7047
7048
7049 ---
7050 title: Track and Bus Groups
7051 part: subchapter
7052 ---
7053
7054 <p>
7055   Tracks and busses can be put into <dfn>groups</dfn>. Members of a group
7056   can share various settings&mdash;useful for managing tracks that are closely
7057   related to each other. Examples might include tracks that contain
7058   multiple-microphone recordings of a single source (an acoustic guitar,
7059   perhaps, or a drum-kit).
7060 </p>
7061
7062 <p>
7063   You can group tracks and busses in various ways. In the editor window,
7064   a track's controls might look like these:
7065 </p>
7066
7067 <img class="left" src="/images/track-in-group.png" alt="track headers for a group" />
7068
7069 <p>
7070   The green tab to the left of the track header indicates that this track
7071   is in a group called <samp>Fred</samp>. You can drag these tabs to add
7072   adjacent tracks to a group.
7073 </p>
7074
7075 <h2>Create New Groups</h2>
7076
7077 <p>
7078   There are several ways to <dfn>create groups</dfn> for tracks and bussess:
7079 </p>
7080
7081 <ul>
7082   <li>Context-click on the group tab and use one of the <kbd
7083   class="menu">Create...</kbd> options there. You can create a group with
7084   no members, or one that starts with the currently selected tracks, or
7085   record-enabled tracks, or soloed tracks.</li>
7086   <li>Alternatively, click the â€˜g’ button on a track header to open the
7087   Group menu. The menu lists the available groups. Selecting one of these
7088   groups will add the track or bus to that group. The menu also lets you
7089   create a new group.</li>
7090   <li>Finally, the Groups tab of the
7091   <a href="/ardours-interface/introducing-the-editor-window/editor-lists">Editor Lists</a>
7092   or the Mixer Window has a <kbd class="menu">plus (+)</kbd> button at the
7093   bottom of the list. Click on the plus sign to create a new group.</li>
7094 </ul>
7095
7096 <h2>Remove Groups</h2>
7097
7098 <p>
7099   Context-click on a <dfn>group tab</dfn> and select <kbd class="menu">Remove
7100   Group</kbd> from the menu. Removing a group does <em>not</em> remove
7101   the members of a group.
7102 </p>
7103
7104 <p>
7105   You can also remove groups by selecting them in the Groups tab of the
7106   <a href="/ardours-interface/introducing-the-editor-window/editor-lists">Editor Lists</a>
7107   or Mixer Window and then pressing the <kbd class="menu">minus (-)</kbd>
7108   button at the bottom of the list.
7109 </p>
7110
7111 <h2>Add/Remove Tracks and Busses From a Group</h2>
7112
7113 <p>
7114   Click the <kbd class="menu">g</kbd> button to display a menu with a list
7115   of the available groups. Select one of these groups to add the track or bus
7116   to that group. Select <kbd class="menu">No Group</kbd> to remove it.
7117 </p>
7118
7119 <p>
7120   Alternatively, you can also drag a group tab to add or remove tracks from
7121   the group.
7122 </p>
7123
7124 <h2>Activate/Deactivate Groups via the Group Tab</h2>
7125
7126 <p>
7127   Clicking on a group tab toggles the group between being active and inactive.
7128   An inactive group has no effect when editing its members. An active group
7129   will share its configured properties across its members. Tabs for disabled
7130   groups are coloured grey.</p>
7131
7132 <h2>Modify Group Properties</h2>
7133
7134 <p>
7135   To edit the properties of a group, context-click on its tab and choose
7136   <kbd class="menu">Edit Group…</kbd>. This opens the track/bus group dialog,
7137   which is also used when creating new groups:
7138 </p>
7139
7140 <img class="right" src="/images/route-group-dialogue.png" alt="the track/bus group dialog" />
7141
7142 <h3>Group Color</h3>
7143
7144 <p>
7145   Click on the color selector button to change a group's colour. This affects
7146   the colour of the group's tab in the editor and mixer windows. The color does
7147   <em>not</em> affect the color of the group members unless you also enable the
7148   shared <kbd class="menu">Color</kbd> property.
7149 </p>
7150
7151 <h3>Shared Properties</h3>
7152
7153 <p>
7154   <kbd class="option">Gain</kbd> means that the track faders will be synced to
7155   always have the same value; <kbd class="option">Relative</kbd> means that the
7156   gain changes are applied relative to each member's current value. If, for
7157   example, there are two tracks in a group with relative gain sharing, and their
7158   faders are set to -3&nbsp;dB and -1&nbsp;dB, a change of the first track to a
7159   gain of -6&nbsp;dB will result in the second track having a gain of
7160   -4&nbsp;dB (the <em>difference</em> of the gains remains the same).
7161 </p>
7162
7163 <p>
7164   <a href="/working-with-tracks/bus-controls/#mute"><kbd class="option">Muting</kbd></a>,
7165   <a href="/working-with-tracks/bus-controls/#solo"><kbd class="option">Soloing</kbd></a>,
7166   <a href="/working-with-tracks/audio-track-controls/#record"><kbd class="option">record enable</kbd></a>,
7167   <a href="/ardours-interface/introducing-the-editor-window/editor-lists/tracks--busses-list/#active"><kbd class="option">active state</kbd></a>,
7168   <a href="/working-with-tracks/controlling-track-appearance/track-coloring/"><kbd class="option">colour</kbd></a> and
7169   <a href="/recording/monitoring/"><kbd class="option">monitoring</kbd></a>
7170   are all straightforward. They simply mean that all member tracks or busses will
7171   share the same settings in these respects.
7172 </p>
7173
7174 <p>
7175   <kbd class="option">Selection</kbd> means that if a region is selected or
7176   deselected on one member track, <a
7177   href="/working-with-regions/corresponding-region-selection/">corresponding
7178   regions</a> on other member tracks
7179   will be similarly selected. Since region editing operations are applied to all
7180   currently selected regions, this is the way to make edits apply across all tracks in the group.
7181 </p>
7182
7183 <p class="fixme">Broken link</p>
7184
7185 <h3>Group Tab Context Menu</h3>
7186
7187 <p>Context-clicking on the group tab offers a further menu of group-related actions. </p>
7188
7189 <dl class="wide-table">
7190         <dt>Create a New Group</dt>
7191         <dd>create a new group</dd>
7192         <dt>Create New Group from...</dt>
7193         <dd> create a new group and automatically add ...
7194         <dl class="narrower-table">
7195                 <dt>Selected</dt>
7196                 <dd>all currently selected tracks and busses</dd>
7197                 <dt>Rec-enabled</dt>
7198                 <dd>all currently record-enabled tracks</dd>
7199                 <dt>Soloed</dt>
7200                 <dd>all currently soloed tracks and busses</dd>
7201         </dl>
7202         </dd>
7203         <dt>Collect Group</dt>
7204         <dd>moves all the member tracks so that they are together in the editor window</dd>
7205         <dt>Remove Group</dt>
7206         <dd>removes the group (and only the group, not its members).</dd>
7207         <dt>Add New Subgroup Bus</dt>
7208         <dd> creates a bus (giving it the name of the group) and connects the output of each member to the new bus.
7209         </dd>
7210         <dt>Add New Aux Bus</dt>
7211         <dd>adds a bus and gives each member a send to that bus. There are two options for this, specifying whether the sends should be placed pre- or post-fader.</dd>
7212         <dt>Fit to Window</dt>
7213         <dd> will zoom the member tracks so that they fill the editor window.</dd>
7214         <dt>Enable All Groups</dt>
7215         <dd>makes all group active, including any hidden groups.</dd>
7216         <dt>Disable All Groups</dt>
7217         <dd>makes all groups inactive, including any hidden groups.</dd>
7218 </dl>
7219
7220
7221 ---
7222 title: Importing and Exporting Session Data
7223 part: chapter
7224 ---
7225
7226
7227 ---
7228 title: File and Session Management and Compatibility
7229 part: chapter
7230 ---
7231
7232
7233 ---
7234 title: Playback & Recording
7235 part: part
7236 ---
7237
7238
7239 ---
7240 title: Playing Back Track Material
7241 part: chapter
7242 ---
7243
7244
7245 ---
7246 title: Controlling Playback
7247 part: subchapter
7248 ---
7249
7250 <h2>Positioning the Playhead</h2>
7251
7252 <p>
7253   The <dfn>playhead</dfn> is a vertical line with two arrows at each end
7254   that indicates the current position of playback.
7255 </p>
7256
7257 <h3>Positioning the playhead at the current pointer position</h3>
7258
7259 <p>
7260   Pressing <kbd>P</kbd> will set the playhead to the current position of
7261   the mouse pointer, if it is within the editor track area.
7262 </p>
7263
7264 <h2>Positioning the playhead on the timeline</h2>
7265
7266 <p>
7267   A <kbd class="mouse">Left</kbd> click anywhere on the timeline (rulers)
7268   will move the playhead to that position.
7269 </p>
7270
7271 <h3>Positioning the playhead with the transport clocks</h3>
7272
7273 <p>
7274   Click on either the primary or secondary transport clock and
7275   <a href="/ardours-interface/using-ardour-clock-displays">edit their value</a>
7276   to move the playhead to a specific position.
7277 </p>
7278
7279 <h3>Positioning the playhead at a marker</h3>
7280
7281 <p>
7282   Click <kbd class="mouse">Right</kbd> on the marker and select either
7283   <kbd class="menu">Locate to here</kbd> or <kbd class="menu">Play from
7284   here</kbd>.
7285 </p>
7286
7287 <p>
7288    The playhead can also be moved backward and forward through the markers by
7289    respectively pressing the <kbd>Q</kbd> and <kbd>W</kbd> keys. Pressing
7290    <kbd>Home</kbd> and <kbd>End</kbd> will move the playhead to the special
7291    markers <dfn>start</dfn> and <dfn>end</dfn>, respectively.
7292 </p>
7293
7294 <h2>Looping the Transport</h2>
7295
7296 <p>
7297   When the <dfn>loop transport</dfn> button is pressed, the playhead will jump the start of the loop range, and continue to the end of that range before returning to the start and repeating. While looping, a light green area is displayed in the time ruler over the tracks to show the loop range.
7298 </p>
7299
7300 <p>
7301   By default, looping is bound to the <kbd>l</kbd> key.
7302 </p>
7303
7304 <p>
7305   For more information on defining and altering the loop range see <a href="/working-with-markers/the-loop-range">Loop Range Markers</a>.
7306 </p>
7307
7308 <p class="fixme">Broken link</p>
7309
7310 ---
7311 title: Using Key Bindings
7312 part: subchapter
7313 ---
7314
7315 <p>
7316   Ardour has many available commands for playback control that can be bound
7317   to keys. Many of them have default bindings, some do not, so the list below
7318   shows both the default bindings and internal command names.
7319 </p>
7320
7321 <dl class="wide-table">
7322   <dt><kbd>Space</kbd></dt>
7323   <dd>switch between playback and stop.</dd>
7324   <dt><kbd>Home</kbd></dt>
7325   <dd>Move playhead to session start marker</dd>
7326   <dt><kbd>End</kbd></dt>
7327   <dd>Move playhead to session end marker</dd>
7328   <dt><kbd>&rarr;</kbd></dt>
7329   <dd></dd>
7330   <dt><kbd>&larr;</kbd></dt>
7331   <dd></dd>
7332   <dt><kbd>0</kbd></dt>
7333   <dd>Move playhead to start of the timeline</dd>
7334 </dl>
7335
7336 <p>Commands without default bindings include:</p>
7337
7338 <p class="fixme">Add content</p>
7339
7340
7341
7342 ---
7343 title: Record Setup
7344 part: chapter
7345 ---
7346
7347
7348 ---
7349 title: Track Recording Modes
7350 part: subchapter
7351 ---
7352
7353 <p>
7354   The <dfn>Recording mode</dfn> is a per-track property (applies to audio
7355   tracks only) that affects the way that recording new material on top of
7356   existing material ("overdubbing") operates <em>in that track</em>.
7357 </p>
7358
7359 <h2 id="trackmodes">Track Modes</h2>
7360
7361 <p>
7362   Audio tracks in Ardour have a <dfn>mode</dfn> which affects how they behave
7363   when recording:
7364 </p>
7365
7366 <dl class="narrower-table">
7367   <dt>Normal</dt>
7368   <dd>Tracks in <dfn>normal mode</dfn> will record non-destructively&mdash;new
7369   data is written to new files, and when overdubbing, new regions will be
7370   layered on top of existing ones. This is the recommended mode for most
7371   workflows.
7372   </dd>
7373   <dt>Non-Layered</dt>
7374   <dd>Tracks using <dfn>non-layered mode</dfn> will record non-destructively&mdash;new data is written to new files, but when overdubbing,
7375   the existing
7376   regions are trimmed so that there are no overlaps. This does not affect
7377   the previously recorded audio data, and trimmed regions can be expanded
7378   again at will. Non-layered mode can be very useful for spoken word material,
7379   especially in combination with <a href="/editing-and-arranging/change-region-lengths/pushpull-trimming">push/pull trimming</a>.
7380
7381   <p class="fixme">Broken link</p>
7382
7383   </dd>
7384   <dt>Tape</dt>
7385   <dd><dfn>Tape-mode</dfn> tracks do <strong>destructive</strong> recording:
7386   all data is recorded to a single file and if you overdub a section of existing
7387   data, the existing data is destroyed irrevocably&mdash;there is no undo.
7388   Fixed crossfades are added at every punch in and out point. This mode can be
7389   useful for certain kinds of re-recording workflows, but it not suggested for normal
7390   use.</dd>
7391 </dl>
7392
7393 <img class="right" src="/images/a3_nonlayered_example.png" alt="normal and non-layered overdubbing comparision"
7394 />
7395
7396 <p>
7397   The screenshot on the right shows the subtle difference between an overdub
7398   in <dfn>normal mode</dfn> (upper track) and one in <dfn>non-layered mode</dfn>
7399   (lower track). Both tracks were created using identical audio data.
7400 </p>
7401
7402 <p>
7403   The upper track shows a new region which has been <dfn>layered on
7404   top</dfn> of the the existing (longer) region. You can see this if you look
7405   carefully at the region name strips. The lower track has split the existing
7406   region in two, trimmed each new region to create space for the new overdub,
7407   and inserted the overdub region in between.
7408 </p>
7409
7410 <h2 id="channelconfiguration">Channel Configuration</h2>
7411
7412 <p>
7413   Ardour tracks can have any number of inputs and any number of outputs, and
7414   the number of either can be changed at any time (subject to restrictions
7415   caused by any plugins in a track). However it is useful to not have to
7416   configure this sort of thing for the most common cases, and so the
7417   <a href="/working-with-tracks/adding-tracks">Add Tracks</a> dialog allows you
7418   to select "Mono", "Stereo" and few other typical multichannel presets.
7419   The name of the preset describes the number of <dfn>input channels</dfn>
7420   of the track or bus.
7421 </p>
7422
7423 <p>
7424   If you have configured Ardour to automatically connect new tracks and
7425   busses for you, the number of outputs will be determined by the number of
7426   inputs of the <dfn>master <a
7427   href="/introducing-ardour/understanding-basic-concepts-and-terminology/#busses">bus</a></dfn>,
7428   to which the track outputs will be connected.
7429 </p>
7430
7431 <p>
7432   For example, if you have a two-channel master bus, then a Mono track has one
7433   input and two outputs; a Stereo track has two inputs and two outputs.
7434 </p>
7435
7436 <p class="note">
7437   Setting <kbd class="menu">Edit &gt; Preferences &gt; Audio
7438   &gt; Connection of Tracks and Busses</kbd> to <kbd
7439   class="menu">manual</kbd> will leave tracks disconnected by default
7440   and there will be as many outputs as there are inputs. It is up to you to
7441   connect them as you wish. This is not a particularly useful way to work
7442   unless you are doing something fairly unusual with signal routing and
7443   processing. It is almost always preferable to allow Ardour to make
7444   connections automatically, even if some of them have to be changed manually
7445   at some point.
7446 </p>
7447
7448
7449 ---
7450 title: Audio Recording
7451 part: chapter
7452 ---
7453
7454
7455 ---
7456 title: Monitoring
7457 part: subchapter
7458 ---
7459
7460 <p>
7461   When recording, it is important that performers hear themselves, and to
7462   hear any pre-recorded tracks they are performing with.
7463   Audio recorders typically let you <dfn>monitor</dfn> (i.e. listen to)
7464   the input signal of all tracks that are armed for recording, and playing
7465   back the unarmed tracks.
7466 </p>
7467
7468 ---
7469 title: Latency Considerations
7470 menu_title: Latency
7471 part: subchapter
7472 ---
7473
7474 <p>
7475   In the days of analog tape recording, the routing of monitor signals was
7476   performed with relays and other analog audio switching devices.  Digital
7477   recorders have the same feature, but may impart some
7478   <a
7479   href="/synchronization/latency-and-latency-compensation/"><dfn>latency</dfn></a>
7480   (delay) between the time you make a noise and the time that you hear it
7481   come back from the recorder.
7482 </p>
7483
7484 <p>
7485   The latency of <em>any</em> conversion from analog to digital and back to
7486   analog is about 1.5&ndash;2&nbsp;ms. Some musicians claim that even the
7487   basic <abbr title="Analog to Digital to Analog">A/D/A</abbr> conversion
7488   time is objectionable. However even acoustic instruments such as the piano
7489   can have approximately 3&nbsp;ms of latency, due to the time the sound
7490   takes to travel from the instrument to the musician's ears. Latency below
7491   5&nbsp;ms should be suitable for a professional recording setup. Because
7492   2&nbsp;ms are already used in the A/D/A process, you must use extremely low
7493   <dfn>buffer sizes</dfn> in your workstation <abbr title="Input/Output">I/O</abbr>
7494   setup to keep the overall latency below 5ms. Not all
7495   <a href="/setting-up-your-system/the-right-computer-system-for-digital-audio">computer audio systems</a>
7496   are able to work reliably at such low buffer sizes.
7497 </p>
7498
7499 <p>
7500   For this reason it is sometimes best to route the monitor signal
7501   through an external mixing console while recording, an approach taken by
7502   most if not all professional recording studios. Many computer I/O devices
7503   have a hardware mixer built in which can route the monitor signal "around"
7504   the computer, avoiding the system latency.
7505 </p>
7506
7507 <p>
7508   In either case, the monitoring hardware may be digital or analog.  And in
7509   the digital case you will still have the A-D-A conversion latency of
7510   1&ndash;2&nbsp;ms.
7511 </p>
7512
7513 ---
7514 title: Monitor Signal Flow
7515 menu_title: Signal Flow
7516 part: subchapter
7517 ---
7518
7519 <p>
7520   There are three basic ways to approach monitoring:
7521 </p>
7522
7523 <h3>External Monitoring</h3>
7524
7525 <p><img class="right" src="/images/external-monitoring.png" /></p>
7526
7527 <p>
7528   When using <dfn>external monitoring</dfn>, Ardour plays no role in monitoring at all. Perhaps the recording set-up has an external mixer which can be used to set up monitor mixes, or perhaps the sound-card being used has a "listen to the input" feature. This approach yields zero or near-zero latency. On the other hand it requires external hardware, and the monitoring settings are less flexible and not saved with the session.
7529 </p>
7530
7531 <h3>JACK-Based Hardware Monitoring</h3>
7532
7533 <p><img class="right" src="/images/jack-monitoring.png" /></p>
7534
7535 <p>
7536   Some sound cards have the ability to mix signals from their inputs to their outputs with very low or even zero latency, a feature called <dfn>hardware monitoring</dfn>. Furthermore, on some cards this function can be controlled by JACK. This is a nice arrangement, if the sound card supports it, as it combines the convenience of having the monitoring controlled by Ardour with the low latency operation of doing it externally.
7537 </p>
7538
7539 <p class="fixme">Broken link</p>
7540
7541 <h3>Software Monitoring</h3>
7542
7543 <p><img class="right" src="/images/ardour-monitoring.png" /></p>
7544
7545 <p>
7546   With the <dfn>software monitoring</dfn> approach, all monitoring is performed by Ardour&mdash;it makes track inputs available at track outputs, governed by various controls. This approach will almost always have more routing flexibility than JACK-based monitoring. The disadvantage is that there will be some latency between the input and the output, which depends for the most part on the JACK buffer size that is being used.
7547 </p>
7548
7549 ---
7550 title: Monitor Setup in Ardour
7551 menu_title: Setup in Ardour
7552 part: subchapter
7553 ---
7554
7555 <p>
7556   Ardour has three main settings which affect how
7557   monitoring is performed. The first is
7558   <kbd class="menu">Edit &gt; Preferences &gt; Audio &gt;
7559   Record monitoring handled by</kbd>.  There are two or three
7560   options here, depending on the capabilities of your hardware.
7561 </p>
7562
7563 <p>
7564   The other two settings are more complex.  One is
7565   <kbd class="menu">Tape machine mode</kbd>, found in the
7566   same dialog, and the other is the
7567   <kbd class="option">Session &gt; Properties &gt; Monitoring
7568   automatically follows transport state</kbd> setting.
7569 </p>
7570
7571 <p>
7572   Monitoring also depends on the state of the track's record-enable button,
7573   the session record-enable button, and on whether or not the transport is
7574   rolling.
7575 </p>
7576
7577 <h2>Software or Hardware Monitoring Modes</h2>
7578
7579 <p>
7580   If Ardour is set to <dfn>external monitoring</dfn>, the explanation of
7581   Ardour's monitoring behaviour is simple: it does not do any.
7582 </p>
7583
7584 <h2>Monitoring in Non-Tape-Machine Mode</h2>
7585
7586 <p>
7587   When <dfn>Tape-Machine mode is off</dfn>, and a track is armed,
7588   Ardour <em>always</em> monitors the live input, except in one case:
7589   the transport is rolling, the session is not recording, and
7590   <dfn>auto-input</dfn>
7591   is active. In this case only, you will hear playback from an armed track.
7592 </p>
7593
7594 <p>
7595   Unarmed tracks will play back their contents from disc, unless the
7596   transport is stopped <em>and</em> <dfn>auto-input</dfn> is enabled.
7597   In this case, the track monitors its live input.
7598 </p>
7599
7600 <h2>Monitoring in Tape-Machine Mode</h2>
7601
7602 <p>
7603   In <dfn>Tape-Machine mode</dfn>, things are slightly simpler: when a
7604   track is armed, its behaviour is the same as in non-tape-machine mode.
7605 </p>
7606
7607 <p>
7608   Unarmed tracks however will always just play back their contents from
7609   disk; the live input will never be monitored.
7610 </p>
7611
7612
7613 ---
7614 title: MIDI Recording
7615 part: chapter
7616 ---
7617
7618
7619 ---
7620 title: Punch Recording Modes
7621 part: chapter
7622 ---
7623
7624
7625 ---
7626 title: Working With Markers
7627 part: subchapter
7628 ---
7629
7630 <p>
7631   It is very useful to be able to tag different locations in a session for
7632   later use when editing and mixing. Ardour supports both
7633   <dfn>locations</dfn>, which define specific positions in time,
7634   and <dfn>ranges</dfn> which define a start and end position in time.
7635 </p>
7636
7637 <p>
7638   In addition to the standard location markers, there are three kinds of
7639   special markers:
7640 </p>
7641
7642 <ul>
7643   <li>
7644     <dfn>CD markers</dfn> are locations that are restricted to legal
7645     <dfn>CD sector boundaries</dfn>. They can be used to add track index
7646     markers to compact disc images.
7647   </li>
7648   <li>
7649     The <dfn>Loop range</dfn> defines the start end end points for Looping.
7650   </li>
7651   <li>
7652     The <dfn>punch range</dfn> defines the in and out points for punch
7653     recording.
7654   </li>
7655 </ul>
7656
7657 ---
7658 title: Creating Location Markers
7659 part: subchapter
7660 ---
7661
7662 <p>
7663   <dfn>Location Markers</dfn> appear in the <dfn>Locations ruler</dfn> at the top
7664   of the timeline. The <dfn>start</dfn> and <dfn>end</dfn> markers appear
7665   automatically, but you can create custom markers at any position in a
7666   session.
7667 </p>
7668
7669 <p>
7670   To add a marker at the <strong>current playhead position</strong>, press
7671   <kbd>Num-&crarr;</kbd> (the Enter key on the numeric  keypad).
7672   Alternatively, use <kbd class="menu">Transport &gt; Markers &gt; Add
7673   Mark from Playhead</kbd>.
7674 </p>
7675
7676 <p>
7677   To add a marker at an <strong>arbitrary location</strong> on the timeline,
7678   navigate to the desired position, right-click on the Locations ruler and
7679   select <kbd class="menu">New Location Marker</kbd>.
7680   You can also go to the Editor list, click <kbd class="menu">New
7681   Marker</kbd> and use the clock widget to set its position.
7682 </p>
7683
7684 <p>
7685   For details see
7686   <a href="/working-with-markers/rangesmarks-list/">Ranges &amp; Marks
7687   List</a>
7688   and <a href="/ardours-interface/using-ardour-clock-displays/"> Using
7689   Ardour Clock Displays</a>.
7690 </p>
7691
7692 ---
7693 title: Creating Range Markers
7694 part: subchapter
7695 ---
7696
7697 <p class="fixme">Add images</a>
7698
7699 <p>
7700   <dfn>Range markers</dfn> are essentially two location markers the are grouped
7701   together to mark the beginning and end of a section in the timeline.
7702 </p>
7703
7704 <h2>Creating a Range on the timeline</h2>
7705
7706 <p>
7707   To create a new <dfn>range</dfn>, right-click on the
7708   Ranges ruler at the top of the timeline, then select
7709   <kbd class="menu">New Range</kbd>.
7710   Two markers with the same name will appear along the ruler.
7711   Both marks can be moved along the timeline by clicking and dragging
7712   them to the desired location.
7713 </p>
7714
7715 <p>
7716   It is also possible to create range markers from a selected range or
7717   region in the Editor window, or to use the <kbd class="menu">Ranges
7718   &amp; Marks List</kbd> in the Editor list.
7719 </p>
7720
7721
7722 ---
7723 title: Moving Markers
7724 part: subchapter
7725 ---
7726
7727 <h2>Single marker</h2>
7728
7729 <p>
7730   <kbd class="mouse">Left</kbd>-click and drag to move a single marker to a
7731   new location on the timeline.
7732 </p>
7733
7734 <h2>Multiple markers</h2>
7735
7736 <p>
7737   It is possible to move multiple markers by the same distance. <kbd
7738   class="mouse mod1">Left</kbd>-click each marker you want to move, then drag
7739   one of the selected markers to a new location. All selected markers will
7740   then move together. Note that the markers are bounded by the zero point on
7741   the timeline. In other words, the first marker in your selection cannot move
7742   to the left of zero on the timeline.
7743 </p>
7744
7745 <h2>Both ends of a range marker</h2>
7746
7747 <p>
7748   <kbd class="mod1 mouse">Left</kbd>-drag either end of the range marker. The
7749   other end will move by the same distance.
7750 </p>
7751
7752 ---
7753 title: The Loop Range
7754 part: subchapter
7755 ---
7756
7757 <p class="fixme">Missing content</a>
7758
7759 <p>
7760   The <dfn>loop range</dfn> is a special range that defines the start and end points
7761   for loop play, which can be enabled in the transport bar.
7762 </p>
7763
7764 <p>
7765   It can be defined via the <a href="/missing">timeline</a> or the <a
7766   href="/working-with-markers/rangesmarks-list/">Ranges &amp; Marks
7767   list</a>.
7768 </p>
7769
7770 <p class="fixme">Broken links</a>
7771
7772 ---
7773 title: Marker Context Menu
7774 part: subchapter
7775 ---
7776
7777 <p>
7778   <kbd class="mouse">Right</kbd>-clicking a marker in the timeline opens the
7779   marker context menu. From this menu, you can:
7780 </p>
7781 <dl>
7782   <dt>Locate to Here</dt>
7783   <dd>Move the playhead to this marker's position.</dd>
7784   <dt>Play from Here</dt>
7785   <dd>start playback from this marker's position.</dd>
7786   <dt>Move Mark to Playhead</dt>
7787   <dd>Move this marker to the current playhead position.</dd>
7788   <dt>Create Range to Next Marker</dt>
7789   <dd>Create a range marker between this location and the next one along on
7790   the timeline.</dd>
7791   <dt>Hide</dt>
7792   <dd>Hide this marker from the view. It can be made visible again from the
7793   <kbd class="menu">Window &gt; Locations</kbd> window or the <a
7794   href="/working-with-markers/rangesmarks-list/">Ranges &amp; Marks
7795   list</a>.</dd>
7796   <dt>Rename</dt>
7797   <dd>Change the name of the marker.</dd>
7798   <dt>Lock</dt>
7799   <dd>If this is ticked, it will be impossible to drag the marker's
7800   position; useful if you want to prevent accidental movements.</dd>
7801   <dt>Glue to Bars and Beats</dt>
7802   <dd>If this is ticked, the marker will maintain its position in bars and
7803   beats even if there are changes in tempo and meter.</dd>
7804   <dt>Remove</dt>
7805   <dd>Removes the marker. </dd>
7806 </dl>
7807
7808 <p>
7809   There are also a few options in <kbd class="menu">Transport &gt; Active
7810   Mark</kbd>. These options apply to the currently selected location marker,
7811   and move it to a nearby region boundary, region sync point, or to the
7812   playhead or mouse.
7813 </p>
7814
7815 ---
7816 title: Punch Range
7817 part: subchapter
7818 ---
7819
7820 <p class="fixme">Missing content</a>
7821
7822 <p>
7823   The <dfn>punch range</dfn> is a special range used to define where
7824   recording will start and/or stop during a <dfn>punch</dfn>.
7825 </p>
7826
7827 <p>
7828   It can be defined on the <a href="/missing">timeline</a> or in the
7829   <a href="/working-with-markers/rangesmarks-list/">Ranges &amp; Marks</a>
7830   list.
7831 </p>
7832
7833 <p class="fixme">Broken links</a>
7834
7835
7836
7837
7838 ---
7839 title: Editing
7840 part: part
7841 ---
7842
7843
7844 ---
7845 title: Editing Basics
7846 part: chapter
7847 ---
7848
7849
7850 ---
7851 title: Working With Regions
7852 part: subchapter
7853 ---
7854
7855 <h2>Working With Regions</h2>
7856
7857 <p>
7858   <dfn>Regions</dfn> are the basic elements of editing and composing in
7859   Ardour. In most cases, a region represents a single contiguous section
7860   of one or more media files. Regions are defined by a fixed set of attributes:
7861 </p>
7862 <ul>
7863   <li>the audio or
7864   <abbr title="Musical Instrument Digital Interface">MIDI</abbr>
7865   <dfn>source file(s)</dfn> they represent,</li>
7866   <li>an <dfn>offset</dfn> (the "start point") in the audio or MIDI file(s), and</li>
7867   <li>a <dfn>length</dfn>.</li>
7868 </ul>
7869 <p>
7870   When placed into a playlist, they gain additional attributes:
7871 </p>
7872 <ul>
7873   <li>a <dfn>position</dfn> along the timeline, and</li>
7874   <li>a <dfn>layer</dfn>.</li>
7875 </ul>
7876 <p>
7877   There are other attributes as well, but they do not <em>define</em> the
7878   region. Things you should know about regions:
7879 </p>
7880
7881 <h3>Regions Are Cheap</h3>
7882 <p>
7883   By themselves, regions consume very little of your computer's resources.
7884   Each region requires a small amount of memory, and represents a rather
7885   small amount of CPU work if placed into an active track. So, don't worry
7886   about creating regions whenever you need to.
7887 </p>
7888
7889 <h3>Regions Are Not Files</h3>
7890 <p>
7891   Although a region can represent an entire audio file, they are never
7892   equivalent to an audio file. Most regions represent just parts of an audio
7893   file(s) on disk, and removing a region from a track has nothing to do with
7894   removing the audio file(s) from the disk (the <kbd
7895   class="menu">Destroy</kbd> operation, one of Ardour's few destructive
7896   operations, can affect this). Changing the length of a region has no effect
7897   on the audio file(s) on disk. Splitting and copying regions does not alter
7898   the audio file in anyway, nor does it create new audio files (only
7899   <dfn>recording</dfn>,
7900   and the <kbd class="menu">Export</kbd>, <kbd class="menu">Bounce</kbd> and
7901   <kbd class="menu">Reverse</kbd> operations create new audio files).</p>
7902
7903 ---
7904 title: Region Naming
7905 part: subchapter
7906 ---
7907
7908 <p>
7909   <dfn>Region names</dfn> are initially derived from either</p>
7910 <ul>
7911   <li>the name of the playlist for which they were recorded,</li>
7912   <li>the name of the track for which they were recorded, or</li>
7913   <li>the name of the embedded/imported file they represent.</li>
7914 </ul>
7915 <p class="fixme">
7916   It appears that recorded regions are always named after the track, not the
7917   active playlist in that track.
7918 </p>
7919
7920 <h2>Whole File Region Names</h2>
7921 <p>
7922   These are not audio files, but regions that represent the full extent of an
7923   audio file. Every time a new recording is done, or a new file is imported
7924   to the session, a new region is created that represents the <dfn>entire audio
7925   file</dfn>. This region will have the name of the track/playlist/original file,
7926   followed by a "-", then a number plus a dot and then a number.
7927 </p>
7928 <p>
7929   For <dfn>recorded regions</dfn>, the number will increase each time a new recording
7930   is made. So, for example, if there is a playlist called
7931   <samp>Didgeridoo</samp>, the
7932   first recorded whole file region for that playlist will be called
7933   <samp>Digderidoo-1</samp>. The next one will be <samp>Digeridoo-2</samp> and so on.
7934 </p>
7935 <p>
7936   For <dfn>imported regions</dfn>, the region name will be based on the original file
7937   name, but with any final suffix (e.g. ".wav" or ".aiff") removed.
7938 </p>
7939 <p>
7940   Normally, whole file regions are not inserted into tracks or playlists,
7941   but regions derived from them are. The whole-file versions live in the
7942   editor region list where they act as an organizing mechanism for regions
7943   that are derived from them.
7944 </p>
7945
7946 <h2>Normal Region Names</h2>
7947 <p>
7948   When a region is inserted into a track and playlist, its initial name will
7949   end in a <dfn>version number</dfn>, such as <samp>.1</samp>. For a recorded region,
7950   if the whole file region was <samp>Hang drum-1</samp>, then the region in
7951   the track will appear with the name <samp>Hang drum-1.1</samp>. For an
7952   imported region, if the whole file region was <samp>Bach:Invention3</samp>,
7953   then the region in the track will appear with the name
7954   <samp>Bach:Invention3.1</samp>.
7955 </p>
7956
7957 <h2>Copied Region Names</h2>
7958 <p>
7959   If you <dfn>copy a region</dfn>, it initially shares the same name as the original.
7960   When you perform an operation modifies one of the copies, Ardour will
7961   increment the version number on the particular copy that changed.
7962 </p>
7963
7964 <h2>Renaming Regions</h2>
7965 <p>
7966   You can <dfn>rename a region</dfn> at any time. Use the region context menu to
7967   pop up the <kbd class="menu">Rename</kbd> dialog. The new name does not need to
7968   have a version number in it (in fact, it probably should not). Ardour will add a
7969   version number in the future if needed (e.g. if you copy or split the region).
7970 </p>
7971
7972 ---
7973 title: Corresponding Regions Selection
7974 part: subchapter
7975 ---
7976
7977 <p>
7978   <a href="/working-with-tracks/track-and-bus-groups/">Track Groups</a> have
7979   a property titled <kbd class="option">Select</kbd> which, if enabled, cause
7980   Ardour to propagate a region selection in one track of a group to the
7981   <dfn>corresponding regions</dfn> of the other tracks in that group.
7982  </p>
7983 <p>
7984   For example, let's assume you have used multiple microphones to record a
7985   drum kit to multiple tracks. You have created a track group, added all the
7986   drum tracks, enabled the group and enabled the Select property for the group.
7987   When you select a region in one of the drum tracks, Ardour will select the
7988   corresponding region in every other drum track in the group, which in turn
7989   means that a subsequent edit operation will affect all the grouped drum
7990   tracks together.
7991 </p>
7992
7993 <h2>How Ardour Decides Which Regions are "Corresponding"</h2>
7994 <p>
7995   Regions in different tracks are considered to be corresponding for the purposes
7996   of sharing <dfn>selection</dfn> if they satisfy <em>all</em> the following criteria:
7997 </p>
7998 <ol>
7999   <li>Each region starts at the <dfn>same offset</dfn> within its source file,</li>
8000   <li>each region is located at the <dfn>same position</dfn> on the timeline, and</li>
8001   <li>each region has the <dfn>same length</dfn>.</li>
8002 </ol>
8003
8004 <h2>Overlap Correspondence</h2>
8005 <p>
8006   Sometimes, the rules outlined above are too strict to get Ardour to do what you
8007   want. Regions may have been trimmed to slightly different lengths, or positioned
8008   slightly differently, and this will cause Ardour to not select regions in other
8009   grouped tracks.</p>
8010 <p>
8011   In this case, change
8012   <kbd class="menu">Edit &gt; Preferences &gt; Editor &gt; Regions in
8013   active edit groups are edited together:</kbd> to <kbd
8014   class="menu">whenever they overlap in time</kbd>. With this option enabled, r
8015   egions in different tracks will be considered equivalent for the purposes of selection if they
8016   <dfn>overlap</dfn>. This is much more flexible and will cover almost all of the
8017   cases that the fixed rules above might make cumbersome.
8018 </p>
8019
8020 ---
8021 title: Region Context Menu
8022 part: subchapter
8023 ---
8024
8025 <p class="fixme">Need to add detail to the context menu table to describe what the options do</p>
8026
8027 <p>
8028   In the editor window, right clicking (context clicking) on a region
8029   displays a menu with <dfn>track and region operations</dfn>. The menu begins with the
8030   name of the region, or <kbd class="menu">Selected Regions</kbd> if multiple
8031   regions are selected.
8032 </p>
8033 <p>
8034   If there is more than one region layered at the point where you clicked, the
8035   menu will also contain an item <kbd class="menu">Choose Top</kbd>. This
8036   dialog lets you select which region you want on the top <dfn>layer</dfn>. See
8037   <a href="manual/region_layering">Adjusting Region Layering</a> for more details.
8038 </p>
8039 <p>
8040   Below these items is the rest of the
8041   <a href="/working-with-tracks/track-context-menu">Track Context Menu</a>, which
8042   provides access to <dfn>track-level operations</dfn>. To see the contents
8043   of the region context menu, select the region name or "Selected Regions", and
8044   the following submenu structure appears:
8045 </p>
8046 <dl class="narrower-table">
8047   <dt>Play</dt>
8048   <dd></dd>
8049   <dt>Loop</dt>
8050   <dd></dd>
8051   <dt>Properties</dt>
8052   <dd></dd>
8053   <dt>Rename</dt>
8054   <dd></dd>
8055   <dt>Edit</dt>
8056   <dd>
8057     <dl class="wide-table">
8058       <dt>Combine</dt>
8059       <dd></dd>
8060       <dt>Uncombine</dt>
8061       <dd></dd>
8062       <dt>Split</dt>
8063       <dd></dd>
8064       <dt>Make Mono Regions</dt>
8065       <dd></dd>
8066       <dt>Opaque</dt>
8067       <dd></dd>
8068       <dt>Mute</dt>
8069       <dd></dd>
8070       <dt>Pitch Shift</dt>
8071       <dd></dd>
8072       <dt>Reverse</dt>
8073       <dd></dd>
8074       <dt>Close Gaps</dt>
8075       <dd></dd>
8076       <dt>Place Transients</dt>
8077       <dd></dd>
8078       <dt>Rhythm Ferret</dt>
8079       <dd></dd>
8080       <dt>Strip Silence</dt>
8081       <dd></dd>
8082     </dl>
8083   </dd>
8084   <dt>Position</dt>
8085   <dd>
8086     <dl class="wide-table">
8087       <dt>Move To Original Position</dt>
8088       <dd></dd>
8089       <dt>Lock</dt>
8090       <dd></dd>
8091       <dt>Glue to Bars and Beats</dt>
8092       <dd></dd>
8093       <dt>Snap Position to Grid</dt>
8094       <dd></dd>
8095       <dt>Set Sync Position</dt>
8096       <dd></dd>
8097       <dt>Remove Sync</dt>
8098       <dd></dd>
8099 <dt>Nudge Later</dt>
8100 <dd></dd>
8101 <dt>Nudge Earlier</dt>
8102 <dd></dd>
8103 <dt>Nudge Later by capture offset</dt>
8104 <dd></dd>
8105 <dt>Nudge Earlier by capture offset</dt>
8106 <dd></dd>
8107 </dl>
8108 </dd>
8109 <dt>Trim</dt>
8110 <dd>
8111 <dl class="wide-table">
8112 <dt>Trim Start at Edit Point</dt>
8113 <dd></dd>
8114 <dt>Trim End at Edit Point</dt>
8115 <dd></dd>
8116 <dt>Trim to Loop</dt>
8117 <dd></dd>
8118 <dt>Trim to Punch</dt>
8119 <dd></dd>
8120 <dt>Trim to Previous</dt>
8121 <dd></dd>
8122 <dt>Trim to Next</dt>
8123 <dd></dd>
8124 </dl>
8125 </dd>
8126 <dt>Layering</dt>
8127 <dd>
8128 <dl class="wide-table">
8129 <dt>Raise to Top</dt>
8130 <dd></dd>
8131 <dt>Raise</dt>
8132 <dd></dd>
8133 <dt>Lower</dt>
8134 <dd></dd>
8135 <dt>Lower to Bottom</dt>
8136 <dd></dd>
8137 </dl>
8138 </dd>
8139 <dt>Ranges</dt>
8140 <dd>
8141 <dl class="wide-table">
8142 <dt>Set Loop Range</dt>
8143 <dd></dd>
8144 <dt>Set Punch Range</dt>
8145 <dd></dd>
8146 <dt>Add Single Range Marker</dt>
8147 <dd></dd>
8148 <dt>Add Range Marker per Region</dt>
8149 <dd></dd>
8150 <dt>Set Range Selection</dt>
8151 <dd></dd>
8152 </dl>
8153 </dd>
8154 <dt>Gain</dt>
8155 <dd>
8156 <dl class="wide-table">
8157 <dt>Normalize</dt>
8158 <dd></dd>
8159 <dt>Boost</dt>
8160 <dd></dd>
8161 <dt>Cut</dt>
8162 <dd></dd>
8163 <dt>Reset Envelope</dt>
8164 <dd></dd>
8165 <dt>Envelope Active</dt>
8166 <dd></dd>
8167 </dl>
8168 </dd>
8169 <dt>Fades</dt>
8170 <dd>
8171 <dl class="wide-table">
8172 <dt>Fade In</dt>
8173 <dd></dd>
8174 <dt>Fade Out</dt>
8175 <dd></dd>
8176 <dt>Fades        </dt>
8177 <dd></dd>
8178 </dl>
8179 </dd>
8180 <dt>Duplicate</dt>
8181 <dd>
8182 <dl class="wide-table">
8183 <dt>Duplicate</dt>
8184 <dd></dd>
8185 <dt>Multi-Duplicate</dt>
8186 <dd></dd>
8187 <dt>Fill Track</dt>
8188 <dd></dd>
8189 </dl>
8190 </dd>
8191 <dt>Export</dt>
8192 <dd></dd>
8193 <dt>Bounce (without processing)</dt>
8194 <dd></dd>
8195 <dt>Bounce (with processing)</dt>
8196 <dd></dd>
8197 <dt>Spectral Analysis</dt>
8198 <dd></dd>
8199 <dt>Remove</dt>
8200 <dd></dd>
8201 </dl>
8202
8203 ---
8204 title: Common Region Edit Operations
8205 menu_title: Region Editing
8206 part: subchapter
8207 ---
8208
8209 <p>
8210   This section covers a set of <dfn>region editing operations</dfn>
8211   that you are likely to use often while working on a session.
8212   Depending on your work habits (and experience of other
8213   <abbr title="Digital Audio Workstation">DAW</abbr>s) you will find
8214   some of these operations critical while others are used only rarely.
8215 </p>
8216
8217 <p>
8218   You can carry out all of these operations from the keyboard (see
8219   <a href="/default-keyboard-bindings">Default Keyboard Shortcuts</a>
8220   for a list). Equivalent operations can be performed with the mouse
8221   in most cases.
8222 </p>
8223
8224 <p>
8225   You may want to review your understanding of
8226   <a href="/editing-and-arranging/edit-point">the edit point/range</a> and
8227   <a href="/editing-and-arranging/which-regions-are-affected">which regions will be affected by region operations</a>.
8228 </p>
8229
8230 <dl class="wide-table">
8231 <dt><kbd class="menu">Spot (Align)</kbd></dt>
8232 <dd>Move selected regions to the edit point.</dd>
8233 <dt><kbd class="menu">Split</kbd></dt>
8234 <dd>Split selected regions at the edit point.</dd>
8235 <dt><kbd class="menu">Trim Start</kbd></dt>
8236 <dd>Adjust the start of selected regions to the edit point (or as close as
8237 possible).</dd>
8238 <dt><kbd class="menu">Trim End</kbd></dt>
8239 <dd>Adjust the end of selected regions to the edit point (or as close as
8240 possible).</dd>
8241 <dt><kbd class="menu">Duplicate</kbd></dt>
8242 <dd>Make a copy of each selected region and position it immediately after the
8243 original.</dd>
8244 <dt><kbd class="menu">Crop</kbd></dt>
8245 <dd>Truncate selected regions to the edit range.</dd>
8246 <dt><kbd class="menu">Separate</kbd></dt>
8247 <dd>Split selected regions at both ends of the edit range.</dd>
8248 <dt><kbd class="menu">Set Fade In</kbd></dt>
8249 <dd>Adjust selected audio regions' fade in to end at the edit point.</dd>
8250 <dt><kbd class="menu">Set Fade Out</kbd></dt>
8251 <dd>Adjust selected audio regions' fade out to end at the edit point.</dd>
8252 <dt><kbd class="menu">Toggle Fade In</kbd></dt>
8253 <dd>Turn selected audio regions' fade in on or off.</dd>
8254 <dt><kbd class="menu">Toggle Fade Out</kbd></dt>
8255 <dd>Turn selected audio regions' fade out on or off.</dd>
8256 <dt><kbd class="menu">Play Region</kbd></dt>
8257 <dd>Play session from the start of the earliest selected region.</dd>
8258 <dt><kbd class="menu">Zoom To Region</kbd></dt>
8259 <dd>Zoom horizontally so that the selected regions span the editor track
8260 view.</dd>
8261 <dt><kbd class="menu">Set Sync Point</kbd></dt>
8262 <dd>Set the sync point of all selected regions to the edit point.</dd>
8263 <dt><kbd class="menu">Insert</kbd></dt>
8264 <dd>Inserts the currently selected regions in the Region List at the edit
8265 point.</dd>
8266 </dl>
8267
8268 ---
8269 title: Copy Regions
8270 part: subchapter
8271 ---
8272
8273 <h2>Copy a Single Region</h2>
8274
8275 <p>
8276   To copy a region, make sure you are in object mouse mode. Move the mouse
8277   pointer into the region and <kbd class="mouse mod1">left</kbd>-drag. Ardour
8278   creates a new region and follows the mouse pointer as it moves. See
8279   <a href="/editing-and-arranging/move-regions/">Move Regions</a> for more
8280   details on moving the copied region.
8281 </p>
8282
8283 <h2>Copy Multiple Regions</h2>
8284
8285 <p>
8286   To copy multiple regions, select them before copying. Then
8287   <kbd class="mouse mod1">left</kbd>-drag one of the selected regions. All the
8288   regions will be copied and as they move. The copied regions will keep their
8289   positions relative to each other.
8290 </p>
8291
8292 <h2>Fixed-Time Copying</h2>
8293
8294 <p>
8295   If you want to copy region(s) to other track(s) but keep the copies at the
8296   exact position on the timeline as the originals, simply use
8297   <kbd class="mouse mod1">Middle</kbd>-drag instead.
8298 </p>
8299
8300
8301 ---
8302 title: Move Regions With the Mouse
8303 part: subchapter
8304 ---
8305
8306 <p>
8307   To move or copy a region, make sure you are in object mode. If you are
8308   using smart mode, the pointer must be in the lower half of the region
8309   to begin a move or copy operation.
8310 </p>
8311
8312 <p>
8313   Move the pointer into the region, use a <kbd class="mouse">Left</kbd>-drag.
8314   The region will follow the pointer as you move it around. By default,
8315   the region can move freely along the timeline.
8316 </p>
8317
8318 <p>
8319   To move a region from one track to another, simply start a move as
8320   described above, but move the pointer into the desired track. The
8321   region will follow the pointer. Note that if you have other kinds of
8322   tracks visible, the region will remain where it is as the pointer
8323   moves across them, and will then jump to the new track. This serves as
8324   a visual reminder that you cannot drag an audio region into an automation
8325   track or a bus, for example.
8326 </p>
8327
8328 <h2>Move Multiple Regions</h2>
8329
8330 <p>
8331   To move multiple regions, select them before moving. Then
8332   <kbd class="mouse">Left</kbd>-drag one of the selected regions. All the
8333   regions will move, keeping their positions relative to each other.
8334 </p>
8335
8336 <h2>Fixed-Time Motion</h2>
8337
8338 <p>
8339   Sometimes, you want to move a region to another track, but keeping its
8340   position along the timeline exactly the same. To do this, use
8341   <kbd class="mouse">Middle</kbd>-drag instead.
8342 </p>
8343
8344 ---
8345 title: Align (Spot) Regions
8346 part: subchapter
8347 ---
8348
8349 <p>
8350   Aligning regions (sometimes called "spotting") means moving one or more
8351   regions based on a defined location, which in Ardour is always the
8352   <a href="/editing-and-arranging/edit-point">edit point</a>. An
8353   alignment operation moves the region(s) so that some part of the region
8354   is positioned at the edit point. Available alignment commands include:
8355 </p>
8356
8357 <dl class="wide-table">
8358   <dt>Align Region starts <kbd class="mod14">a</kbd></dt>
8359   <dd>Selected region(s) are moved so that their start is located at the current edit point</dd>
8360   <dt>Align Region ends <kbd class="mod2">a</kbd></dt>
8361   <dd>Selected region(s) are moved so that the end is located at the current edit point</dd>
8362   <dt>Align Region sync points <kbd>Shift-a</kbd></dt>
8363   <dd>Selected region(s) are moved so that their sync point is located at the current edit point</dd>
8364   <dt>Align Region starts relative <kbd class="mod4">a</kbd></dt>
8365   <dd>Selected region(s) are moved so that the start of the earliest region is located at the current edit point, and all others maintain their relative position relative to that region</dd>
8366 </dl>
8367
8368
8369 ---
8370 title: Edit Mode and Tools
8371 part: chapter
8372 ---
8373
8374
8375 ---
8376 title: Which Regions Are Affected?
8377 menu_title: Affected Regions
8378 part: subchapter
8379 ---
8380
8381 <p class="fixme">This one is alone in its chapter. Find him a place somewhere else.</p>
8382
8383 <p>
8384   This section explains the rules used to decide which regions are affected
8385   by editing operations. You don't really have to understand them&mdash;hopefully
8386   things will Just Work&trade;&mdash;but it may be useful eventually to understand the rules.
8387 </p>
8388
8389 <p>
8390   Editing operations in Ardour either operate on a single point in time
8391   (<kbd class="menu">Split</kbd> being the obvious example) or on two
8392   points (which can also be considered to be a range of sorts); <kbd
8393   class="menu">Separate</kbd> is a good example of this.
8394 </p>
8395
8396 <p>
8397   Most operations will operate on the currently selected region(s), but if
8398   no regions are selected, the region that the mouse is in will be used
8399   instead. Single-point operations will generally pick a set of regions to
8400   use based on the following rules:
8401 </p>
8402
8403 <ul>
8404   <li> If the edit point is 'mouse', then
8405     <ul>
8406      <li>if the mouse is over a selected region, or no region, use all selected
8407      regions, or</li>
8408      <li>if the mouse is over an unselected region, use just that region.</li>
8409     </ul>
8410   </li>
8411   <li> For all other edit points
8412     <ul>
8413       <li>
8414         use the selected regions <em>and</em> those that are both
8415         under the edit position <em>and</em> on a selected track,
8416         or on a track which is in the same active edit-enabled route group
8417         as a selected region.
8418       </li>
8419     </ul>
8420   </li>
8421 </ul>
8422
8423 <p>
8424   The rationale here for the two different rules is that the mouse edit point
8425   is special in that its position indicates both a time and a track; the other
8426   edit points (Playhead, Marker) indicate a time only.
8427 </p>
8428
8429
8430 ---
8431 title: Making Selections
8432 part: chapter
8433 ---
8434
8435
8436 ---
8437 title: Select Regions
8438 part: subchapter
8439 ---
8440
8441 <p class="fixme">Remove all "you" references FFS</p>
8442
8443 <p>
8444   Many editing operations in Ardour require you to first <dfn>select one or more
8445   regions</dfn> that you want to change in some way. You can select a single region,
8446   or multiple regions, including regions in different tracks. When you select
8447   a region, it will appear in a darker color than unselected regions.
8448 </p>
8449
8450 <p>
8451   Note that if a track is a member of a group that is active and has the
8452   <kbd class="option">Select</kbd> property enabled, then Ardour will attempt to
8453   match whatever selections you make in one track across every other track of the
8454   group. See
8455   <a href="/working-with-regions/corresponding-regions-selection/">Corresponding
8456   Regions Selection</a> for more information on precisely how selections will be
8457   propagated to other tracks.
8458 </p>
8459
8460 <h2>Region Selection and Track Selection</h2>
8461
8462 <p>
8463   Please read
8464   <a href="/working-with-tracks/selecting-tracks/region-and-track-selection">Region &amp; Track Selection</a>
8465   for more information on how selecting regions and selecting tracks interact.
8466 </p>
8467
8468 <p class="fixme">Broken link</p>
8469
8470 <h2>Select a Region</h2>
8471
8472 <p>
8473   Confirm that you are using the
8474   <a href="/ardours-interface/introducing-the-editor-window/the-editing-toolbar/#object">Object tool</a>,
8475   then click on a region to select it. If
8476   <a href="/ardours-interface/introducing-the-editor-window/the-editing-toolbar/#smartmode">smart mode</a>
8477   is enabled, click in the lower half of the region.
8478 </p>
8479
8480 <h2>Deselect a Region</h2>
8481
8482 <p>
8483   Confirm you are using the
8484   <a href="/ardours-interface/introducing-the-editor-window/the-editing-toolbar/#object">Object tool</a>,
8485   then <kbd class="mouse mod1">Left</kbd>-click the region. If
8486   <a href="/ardours-interface/introducing-the-editor-window/the-editing-toolbar/#smartmode">smart mode</a>
8487   is enabled, click in the lower half of the region.
8488 </p>
8489
8490 <p>
8491   Note that a <kbd class="mouse mod1">left</kbd> click simply toggles the
8492   selected status of an object, so it can be used to select unselected regions
8493   too.
8494 </p>
8495
8496 <h2>Select Multiple Regions in a Track</h2>
8497
8498 <p>Do one of the following:</p>
8499
8500 <ul>
8501   <li><kbd class="mouse mod1">Left</kbd>-click each region, or</li>
8502   <li>
8503     drag a rubberband box from an empty point in a track before the first
8504     region you wish to select to a point within or after the last region
8505     you wish to select (you can <kbd class="mouse mod1">left</kbd>-drag to do this
8506     multiple times), or,
8507   </li>
8508   <li>
8509     if the regions are all adjacent to one another, click the first region
8510     you wish to select, then <kbd class="mouse mod3">Left</kbd>-click the last
8511     region you wish to select.
8512   </li>
8513 </ul>
8514
8515 <h2>Select All Regions in a Track</h2>
8516
8517 <p>
8518   Context-click the track, and in the context menu, navigate to
8519   <kbd class="menu">Select &gt; Select All In Track</menu>.
8520 </p>
8521
8522 <p>
8523   See the <a href="/working-with-tracks/the-track-context-menu">Track Context Menu</a>
8524   for more information on other per-track selection operations that are available.
8525 </p>
8526
8527 <p class="fixme">Broken link</p>
8528
8529 <h2>Select Multiple Regions Across Different Tracks</h2>
8530
8531 <p>
8532   <kbd class="mouse mod1">Left</kbd>-click or <kbd class="mouse
8533   mod3">Left</kbd>-click the regions you wish to select.
8534 </p>
8535
8536 <h2>Select a Region From the Region List</h2>
8537
8538 <p>
8539   Click the name of the region in the
8540   <a href="/ardours-interface/introducing-the-editor-window/editor-lists/region-list/">Region List</a>.
8541   Note that this will do nothing for whole-file regions, since they do not exist
8542   anywhere in a playlist or track.
8543 </p>
8544
8545
8546 ---
8547 title: Editing Regions and Selections
8548 part: chapter
8549 ---
8550
8551 ---
8552 title: Trimming Regions
8553 part: subchapter
8554 ---
8555
8556 <p class="fixme">Add images, description of mouse cursor changes that signal this type of editing</p>
8557
8558 <p>
8559   Changing the <dfn>length</dfn> of a region is a very common editing
8560   operation, often known as <dfn>trimming</dfn>. There are several ways
8561   to accomplish this with Ardour, and some very useful specialized trimming
8562   operations.
8563 </p>
8564
8565 <h2>Drag-Trimming With the Mouse</h2>
8566
8567 <p>
8568   In object mode, move the pointer near the beginning or end of the region.
8569   The cursor will change to indicate that trimming is possible, and you then
8570   <kbd class="mouse">Left</kbd>-drag the edge of the region.
8571 </p>
8572
8573 <p>
8574   Trimming will obey <a href="/editing-and-arranging/snap-to-the-grid/">Snap settings</a>.
8575 </p>
8576
8577 <h2>Click Trimming With the Mouse</h2>
8578
8579 <p>
8580   <kbd class="mouse">Left</kbd>-click in the colored bar at the bottom of a region.
8581   If you are nearer to the start of a region, this will trim the start time to the
8582   position of the pointer. If you are nearer to the end of a region, it will trim the
8583   end time.
8584 </p>
8585
8586 <h2>Keyboard Shortcuts for Trimming</h2>
8587 <p>
8588   There are several commands for region trimming. Some use the
8589   <a href="/editing-and-arranging/edit-point">edit point</a> to determine where
8590   to trim to. Some are not bound to any keys by default (but could be via the
8591   Keybindings Editor).
8592 </p>
8593
8594 <dl class="wide-table">
8595   <dt><kbd class="menu">Region/trim-front</kbd> <kbd>j</kbd></dt>
8596   <dd>Trim selected region(s) start to edit point.</dd>
8597   <dt><kbd class="menu">Region/trim-end</kbd> <kbd>k</kbd></dt>
8598   <dd>Trim selected region(s) end to edit point.</dd>
8599 </dl>
8600
8601 <h2 id="trimtonextprevious">Trim to Next/Previous Region</h2>
8602
8603 <p>
8604   Sometimes you just want to extend the start or end of region so that it reaches
8605   the end or start of an adjacent region. There is now an operation accessible
8606   from the region context menu, under <kbd class="menu">Edit &gt;Trim &gt; Trim to
8607   Next</kbd> or <kbd class="menu">Edit &gt; Trim &gt; Trim to Previous</kbd>. This
8608   will extend the selected regions so they directly adjoin their neighbours, unless
8609   their source files are not long enough, in which case they will be extended to the
8610   maximum possible. Trim to Next will extend the end of the selected regions to the
8611   start of the next region; Trim to Previous will extend the start of the selected
8612   regions to the end of the previous region.
8613 </p>
8614
8615 <dl class="wide-table">
8616   <dt><kbd class="menu">Region/trim-to-previous-region</kbd> <kbd class="mod1">j</kbd></dt>
8617   <dd>Trim the start of selected region(s) to the end of the previous
8618   region.</dd>
8619   <dt><kbd class="menu">Region/trim-to-next-region</kbd> <kbd class="mod1">k</kbd></dt>
8620   <dd>Trim the end of selected region(s) to the start of the following
8621   region.</dd>
8622 </dl>
8623
8624 <h2>Other Possible Commands for Trimming</h2>
8625
8626 <p>
8627   These are not bound to any keys by default, but could be via the Keybindings
8628   Editor. They can also be sent via OSC or other control protocols.
8629 </p>
8630
8631 <dl class="wide-table">
8632   <dt><kbd class="menu">Region/trim-region-to-loop</kbd></dt>
8633   <dd>Trim region to match the current loop range.</dd>
8634   <dt><kbd class="menu">Region/trim-region-to-punch</kbd></dt>
8635   <dd>Trim region to match the current punch range.</dd>
8636 </dl>
8637
8638 ---
8639 title: Push/Pull Trimming
8640 part: subchapter
8641 ---
8642
8643 <p>
8644   Normally, when you trim regions by dragging with the mouse, it affects
8645   only the selected regions. Their lengths are directly affected by the
8646   trim operation, but nothing else is. Sometimes though, you might like
8647   to trim a region that directly adjoins another, and keep this relationship
8648   the same&mdash;you are not trying to make one of the regions extend
8649   over the other&mdash;you would like the junction to move in one
8650   direction or the other as part of the trim. This requires trimming both
8651   regions on either side of the junction, in opposite directions.
8652   <dfn>Push/Pull trim</dfn>, activated by pressing shift key before
8653   starting the drag, will do just that. Here's a few pictures to show the
8654   difference in the results of a normal trim and push/pull trim. First,
8655   the initial situation:
8656 </p>
8657
8658 <p class="center"><img src="/images/a3_before_trim.png" alt="region arrangement before trim" /></p>
8659
8660 <p>
8661   Here is what happens after we trim the right hand (selected) region by
8662   dragging its starting position earlier:
8663 </p>
8664
8665 <p class="center"><img src="/images/a3_after_trim.png" alt="region arrangement after a trim" /></p>
8666
8667 <p>
8668   You can see that it now overlaps the earlier region and a crossfade has
8669   been created between them.
8670 </p>
8671
8672 <p>
8673   Lets look now at what happens if we do the same trim, but <kbd
8674   class="mouse mod3">Left</kbd>-dragging to turn it into a push-pull trim instead:
8675 </p>
8676
8677 <p class="center"><img src="/images/a3_after_push_trim.png" alt="region arrangement after a push trim" /></p>
8678
8679 <p>
8680   There is no overlap, and the end of the earlier region has been moved
8681   along with the start of the later region, so that they still directly
8682   adjoin each other.
8683 </p>
8684
8685 ---
8686 title: Separate Under
8687 part: subchapter
8688 ---
8689
8690 <p>
8691   You may have a situation where you have positioned one region over another,
8692   and you just want to cut the lower region so that it directly adjoins both
8693   ends of the overlapping one, with no overlaps. To do this, select the upper
8694   region, then choose <kbd class="menu">Edit &gt; Separate &gt; Separate
8695   Under</kbd>. This will split the lower region so that it no longer overlaps
8696   the upper region at all.
8697 </p>
8698
8699 <p>
8700   Here is an example where we start with a short region placed so that it
8701   overlaps a longer region:
8702 </p>
8703
8704 <p class="center"><img src="/images/a3_before_separate_under.png" alt="region arrangement before separate under" /></p>
8705
8706 <p>
8707   When we perform the <dfn>Separate Under</dfn> edit, the lower region splits
8708   in two, with boundaries exactly positioned at the edges of the upper region:
8709 </p>
8710
8711 <p class="center"><img src="/images/a3_after_separate_under.png" alt="region arrangement after separate under" /></p>
8712
8713 <p>
8714   If the upper region covers only one end of the lower region, then this
8715   operation is equivalent to
8716   <a href="/editing-and-arranging/change-region-lengths/#trimtonextprevious">Trim to Next/Previous Region</a>, depending on which end is covered.
8717 </p>
8718
8719 ---
8720 title: Separate Range
8721 part: subchapter
8722 ---
8723
8724 <p class="fixme">Add example with images; 1p &ge; 1,000w</p>
8725
8726 <p>
8727   A final new editing feature is an operation in the context menu of a
8728   range labeled <kbd class="menu">Separate Regions Under Range</kbd>.
8729   This splits any selected regions that are covered by the range at both
8730   ends of the range (or just one, if the range only covers part of the
8731   region). This makes it easy to generate regions that correspond
8732   precisely to a range.
8733 </p>
8734
8735 ---
8736 title: Strip Silence from Audio Regions
8737 menu_title: Stripping Silence
8738 part: subchapter
8739 ---
8740
8741 <p>
8742   From the region context menu, choose <kbd class="menu">Edit &gt; Strip
8743   Silence</kbd> to detect silence (based on a user-chosen threshold in
8744   <abbr title="Decibels relative to Full Scale">dBFS</abbr>), split a
8745   region based on the boundaries of the silent segments, and remove the
8746   silence. You can also specify a minimum length for silence&mdash;useful
8747   when editing very percussive material and just needing to automatically trim
8748   the ends of a region. The dialog looks like this:
8749 </p>
8750
8751 <p class="center">
8752   <img src="/images/a3_strip_silence.png" alt="strip silence dialog" />
8753 </p>
8754
8755 <p>
8756   The edit applies to all selected regions, allowing batch processing.
8757   You can also see in the screenshot how the main editor window is used
8758   to show silent segments and report the number and durations of the
8759   shortest segments.
8760 </p>
8761
8762
8763 ---
8764 title: Fades and Crossfades
8765 part: chapter
8766 ---
8767
8768
8769 ---
8770 title: Create Region Fades and Crossfades
8771 part: subchapter
8772 ---
8773
8774 <p class="fixme">Add images--an image is worth more than 1,000 words</p>
8775
8776 <p>
8777   Every Region has a fade-in and fade-out. By default, the region fade
8778   is very short, and serves to de-click the transitions at the start and
8779   end of the region. By adjusting the regions fade length, a more
8780   gradual transition can be accomplished.
8781 </p>
8782
8783 <h2>Region Fades</h2>
8784
8785 <p>
8786   <dfn>Region fades</dfn>  are possible at the beginning and end of
8787   all audio regions. In object mode, a grip appears at the top left and
8788   top right of an audio region when the cursor hovers over it. Placing
8789   the cursor over the top of the grip displays the region fade cursor
8790   tip. Click and drag the grip left or right in the timeline to
8791   adjust the length of the fade.
8792 </p>
8793
8794 <h2>Crossfades</h2>
8795
8796 <p>
8797   <dfn>Crossfades</dfn> refer to the behavior when you want to make
8798   a smooth transition (mix) from one audio region to another on the same
8799   track. Historically, this was done by splicing 2 pieces of analog
8800   tape together, and this concept was carried forward into digital
8801   editing. Each track is a sequence of sound files (regions). If
8802   two regions are butted against each other, there needs to be a method
8803   to splice them smoothly together. The crossfade allows one region
8804   to fade smoothly out, while the next region fades smoothly in, like 2
8805   pieces of tape that have been cut at and angle, and overlapped.
8806 </p>
8807
8808 <p>
8809   But Ardour uses a more refined "layered" editing model, and
8810   therefore it is possible for multiple regions to be stacked on a single
8811   location with arbitrary overlaps between different layers. For
8812   this reason, crossfades must be implemented differently. We can't
8813   assume that a crossfade is an entitry that exists between 2 regions;
8814   instead each region must have its own associated crossfades at each
8815   end, and the topmost region must always crossfade down to the
8816   underlying region(s), if any.
8817 </p>
8818
8819 <p>
8820   Ardour solves this problem by putting a crossfade at the beginning
8821   and end of every region. The fades of the bottom-most region are
8822   first rendered, and then each region is rendered on top of the one
8823   below it, with fades at the end of each region providing a crossfade to
8824   the region(s) beneath it.
8825 </p>
8826
8827 <p>
8828   It is important to understand that region fades <em>are</em> crossfades. When one region has
8829   another region or multiple regions beneath its fade area, then you will
8830   hear the topmost region fade-out be mirrored as a fade-in on the
8831   underlying region(s). The grip for the topmost region will allow
8832   changing the length and type of the crossfade into the underlying
8833   region(s). In this way you can create a complicated series of
8834   crossfades, and then layer another region atop the others, and fade
8835   into <em>that</em> complicated series.
8836 </p>
8837 <p class="fixme">An image here would probably help.</p>
8838
8839 <p>
8840   If a region doesn't have any region(s) under it, then the region is
8841   crossfaded to silence; for convenience we call this a "fade"
8842   rather than a crossfade.
8843 </p>
8844
8845 <h2>Fade Shapes</h2>
8846 <p>
8847   To activate/deactivate or change the shape of a region's fade-in or
8848   fade-out, hover the cursor over the region fade grip till the cursor tip
8849   indicates region fade editing and context-click to bring up a context
8850   menu. In the context menu there is a list of options for the
8851   region fade. <kbd class="menu">Activate/Deactivate</kbd> enables and
8852   disables the region fade.
8853 </p>
8854
8855 <p>
8856   Because each fade is also a crossfade, it has an inverse fade shape
8857   for the audio beneath the fade. It is important to know how the
8858   shapes differ, and which are most suitable for various editing tasks.
8859 </p>
8860
8861 <p>
8862   The different types of fades are:
8863 </p>
8864
8865 <dl class="narrower-table">
8866   <dt><kbd class="menu">Linear</kbd></dt>
8867   <dd>A simple linear coefficient decrease, and its mathematical inverse. A Linear fade starts attentuating quickly and then cuts off even more abruptly at lower levels. When used as a crossfade, the signals are each -6dB attenuated at the midpoint. This is the correct crossfade to use with highly-correlated signals for a smooth transition.</dd>
8868   <dt><kbd class="menu">Constant Power</kbd></dt>
8869   <dd>The constant power curve starts fading slowly and then cuts off abruptly. When used as a crossfade between 2 audio regions, the signals are symetrically attenuated, and they each reach -3dB at the midpoint. This is the correct crossfade to use when you want to splice audio in the general (uncorrelated) case.</dd>
8870   <dt><kbd class="menu">Symmetric</kbd></dt>
8871   <dd>The Symmetric fade starts slowly, then attenuates significantly before transitioning to a slower fade-out near the end of the fade. When used as a crossfade, the Symmetric curve is not mathematically correct like the Equal Power or Linear curves, but it provides a slower fade-out at low volumes. This is sometimes useful when editing two entire works of music together so that the transition is more gradual.</dd>
8872   <dt><kbd class="menu">Fast</kbd></dt>
8873   <dd>The Fast curve is a linear decibel fade; It sounds like a perfectly smooth fader or knob moved to silence. This shape is excellent as a general-purpose fade-in. When used as a crossfade, the inverse fade curve maintains constant power but is therefore non-symmetric; so its use is limited to those cases where the user finds it appropriate.</dd>
8874   <dt><kbd class="menu">Slow</kbd></dt>
8875   <dd>The Slow curve is a modified linear decibel fade. The initial curve starts more gradually so that it has a less abrupt transition near unity. After that, it sounds like a perfectly smooth fader or knob moved to silence. This shape is excellent as a general-purpose fade-out. When used as a crossfade, the inverse fade curve maintains constant power but is therefore non-symmetric; so its use is limited to those cases where the user finds it appropriate.</dd>
8876 </dl>
8877
8878 <p>
8879   Although these fade shapes serve specific purposes, any of the shapes is usable in certain situations. The final decision is an artistic choice rather than a rigidly prescribed one.
8880 </p>
8881
8882 <p>
8883   These fade curves are developed to provide a range of common uses, and
8884   are developed with the least possible amount of changes in the "slope"
8885   of the line. This provides artifact-free crossfades. Some
8886   DAWs provide complicated fade editors with parametric "spline" controls
8887   of the fade curves. While it might be interesting to develop a
8888   fade curve with a faster cutoff, the mathematical difference between
8889   this and simply shortening the fade is vanishingly small; the
8890   amount of effort to shorten the fade is much easier than fooling around with a
8891   crossfade editor dialog.
8892 </p>
8893
8894
8895 ---
8896 title: Playlists
8897 part: chapter
8898 ---
8899
8900
8901 ---
8902 title: Understanding Playlists
8903 part: subchapter
8904 ---
8905
8906 <p>
8907   A <dfn>playlist</dfn> is a list of regions ordered in time. It defines
8908   which parts of which source files should be played and when.  Playlists
8909   are a fairly advanced topic, and can be safely ignored for many types
8910   of audio production. However, the use of playlists allows the audio
8911   engineer more flexibility for tasks like multiple takes of a single
8912   instrument, alternate edits of a given recording, parallel effects such
8913   as reverb or compression, and other tasks.
8914 </p>
8915 <p>
8916   Each audio <dfn>track</dfn> in Ardour is really just a mechanism for
8917   taking a playlist and generating the audio stream that it represents.
8918   As a result, editing a track really means modifying its playlist in
8919   some way. Since a playlist is a list of regions, most of the
8920   modifications involve manipulating regions: their position, length
8921   and so forth. This is covered in the chapter
8922   <a href="/working-with-regions/">Working With Regions</a>.<br />
8923   Here, we cover some of the things you can do with playlists as objects
8924   in their own right.
8925 </p>
8926
8927 <h2>Tracks are not Playlists</h2>
8928 <p>
8929   It is important to understand that a track <em>is not</em> a playlist.
8930   A track <em>has</em> a playlist. A track is a mechanism for generating
8931   the audio stream represented by the playlist and passing it through a
8932   signal processing pathway. At any point in time, a track has a single
8933   playlist associated with it. When the track is used to record, that
8934   playlist will have one or more new regions added to it. When the track
8935   is used for playback, the contents of the playlist will be heard.
8936   You can change the playlist associated with a track at (almost) any
8937   time, and even share playlists between tracks.
8938 </p>
8939
8940 <p>
8941   If you have some experience of other
8942   <abbr title="Digital Audio Workstation">DAW</abbr>s, then you might
8943   have come across the term <dfn>"virtual track"</dfn>, normally defined as a track
8944   that isn't actually playing or doing anything, but can be
8945   mapped/assigned to a real track. This concept is functionally
8946   identical to Ardour's playlists. We just like to be little more
8947   clear about what is actually happening rather than mixing old and
8948   new terminology ("virtual" and "track"), which might be confusing.</p>
8949
8950 <h2>Playlists are Cheap</h2>
8951
8952 <p>
8953   One thing you should be clear about is that playlists are cheap. They
8954   don't cost anything in terms of CPU consumption, and they have very
8955   minimal efforts on memory use. Don't be afraid of generating new
8956   playlists whenever you want to. They are not equivalent to tracks,
8957   which require extra CPU time and significant memory space, or audio
8958   files, which use disk space, or plugins that require extra CPU time.
8959   If a playlist is not in use, it occupies a small amount of memory, and
8960   nothing more.
8961 </p>
8962
8963 ---
8964 title: Playlist Operations
8965 part: subchapter
8966 ---
8967
8968 <p>
8969   In the track header (editor window, left pane) is a button labelled <kbd
8970   class="menu">p</kbd> (for "Playlist"). If you click on this button, Ardour
8971   displays the following menu:
8972 </p>
8973
8974 <dl class="wide-table">
8975   <dt>(Local Playlists)</dt>
8976    <dd>Shows all of the playlists associated with this track, and indicates
8977    the currently selected playlist</dd>
8978   <dt>Rename</dt>
8979   <dd>Displays a dialog to rename the current playlist</dd>
8980   <dt>New</dt>
8981   <dd>Creates a new empty playlist, and the track switches to the new playlist</dd>
8982   <dt>New Copy</dt>
8983   <dd>Creates a new playlist that is a copy of the current playlist; the track switches to the new playlist</dd>
8984   <dt>Clear Current</dt>
8985   <dd>Removes all regions from the current playlist</dd>
8986   <dt>Select From All</dt>
8987   <dd>Displays a playlist browser to manually choose which playlist this track should use. (You can even select playlists from other tracks here)</dd>
8988 </dl>
8989
8990 <h2>Renaming Playlists</h2>
8991
8992 <p>
8993   Playlists are created with the name of the track of which they are
8994   associated, plus a version number. So, the first playlist for a track
8995   called "Cowbell" will be called <samp>Cowbell.1</samp>. This name will
8996   be used to define the names of any regions added to the playlist by
8997   recording. You can change the name at any time, to anything you want.
8998   Ardour does not require that your playlist names are all unique, but it
8999   will make your life easier if they are. Suggested examples of user-assigned
9000   names for a playlist might include <kbd class="input">Lead Guitar, 2nd
9001   take</kbd>, <kbd class="input">vocals (quiet)</kbd>,
9002   and <kbd class="input">downbeat cuica</kbd>. Notice how these might be
9003   different from the associated track names, which for these examples might
9004   be <kbd class="input">Lead Guitar</kbd>,
9005   <kbd class="input">Vocals</kbd> and <kbd class="input">Cuica</kbd>. The
9006   playlist name provides more information because it is about a specific
9007   version of the material that may (or may not) end up in the final version
9008   of the track.
9009 </p>
9010
9011 <p>
9012   If you are going to rename your playlists, do so before recording new
9013   material to them.
9014 </p>
9015
9016 <p class="fixme">
9017   It appears that recorded regions are not named after the playlist, but
9018   after the track.
9019 </p>
9020
9021 <h2>Sharing Playlists</h2>
9022
9023 <p>
9024   It is entirely possible to <dfn>share playlists</dfn> between tracks. The only
9025   slightly unusual thing you may notice when sharing is that edits to the
9026   playlist made in one track will magically appear in the other. If you
9027   think about this for a moment, its an obvious consequence of sharing.
9028   One application of this attribute is parallel processing, described
9029   below.
9030 </p>
9031
9032 <p>
9033   You might not want this kind of behaviour, even though you still want
9034   two tracks to use the same (or substantially the same) playlist. To
9035   accomplish this, select the chosen playlist in the second track, and
9036   then use New Copy to generate an <dfn>independent copy</dfn> of it for
9037   that track. You can then edit this playlist without affecting the original.
9038 </p>
9039
9040 ---
9041 title: Playlist Usecases
9042 part: subchapter
9043 ---
9044
9045 <h3>Using Playlists for Parallel Processing</h3>
9046
9047 <p>
9048   One of the uses of playlists is to apply multiple effects to the same
9049   audio stream. For example, let's say you would like to apply two
9050   different non-linear effects such as distortion or compression to the
9051   same audio source (for linear effects, you could just apply them one after
9052   the other in the same track).<br />
9053   Create a new track, apply the original track's playlist, and
9054   then apply effects to both tracks independently.
9055 </p>
9056
9057 <p class="note">
9058   The same result could be achieved by feeding your track to multiple busses which
9059   then contain the processing, but this increases the overall latency,
9060   complicates routing and uses more space in the Mixer window.
9061 </p>
9062
9063 <h2>Using Playlists for "Takes"</h2>
9064
9065 <p>
9066   Using Playlists for <dfn>takes</dfn> is a good solution if you are going
9067   to need the ability to edit individual takes, and select between them.
9068 </p>
9069
9070 <p>
9071   Each time you start a new take, create a new playlist with
9072   <kbd class="menu">p &gt; New</kbd>
9073   Later, you can Select your way back to previous or later takes as
9074   desired.
9075 </p>
9076
9077 <p>
9078   If you want to create a composite edit from multiple takes, create a new
9079   track to assemble the final version, and "cherry pick" from the playlists
9080   in the original track by copying regions over as required.
9081 </p>
9082
9083 <p>
9084   Alternatively, record each successive take on top of the
9085   others in "layers" and then edit them using the layer tools, explained
9086   later.
9087 </p>
9088
9089 <h2>Using Playlists for Multi-Language Productions</h2>
9090
9091 <p>
9092   The same approach as for takes is useful when you are recording or
9093   editing content in multiple versions, such as dubbed movie dialog in
9094   several languages, and you want all versions on the same track, to
9095   get the same processing. <br />
9096   Select the appropriate language before exporting the session.
9097 </p>
9098
9099
9100 ---
9101 title: Rhythm Ferret
9102 part: chapter
9103 ---
9104
9105
9106
9107
9108 ---
9109 title: MIDI
9110 part: part
9111 ---
9112
9113
9114 ---
9115 title: MIDI Editing
9116 part: chapter
9117 ---
9118
9119
9120 ---
9121 title: Edit MIDI
9122 part: subchapter
9123 ---
9124
9125 <p>
9126   Ardour's handling of <dfn><abbr title="Musical Instrument Digital Interface">MIDI</abbr> editing</dfn> differs from most other <abbr title="Digital Audio Workstation">DAW</abbr>s and MIDI sequencers.
9127 </p>
9128
9129 <h2>Key features of Ardour MIDI handling</h2>
9130
9131 <ul>
9132   <li>
9133     All editing is done in-place, in-window. There is no separate piano roll window or pane. Edit notes right where you see them.
9134   </li>
9135   <li>
9136     All MIDI I/O is done via <abbr title="Jack Audio Connection Kit">JACK</abbr> for sample accurate timing and maximal efficiency when communicating with external software synthesizers.
9137   </li>
9138   <li>
9139     Every MIDI track has its own JACK MIDI port for input; it may have an arbitrary combination of audio and MIDI outputs, depending on the signal processing in the track; the full flexibility of JACK connectivity is present for MIDI just as it is for audio.
9140   </li>
9141   <li>
9142     Full automation for MIDI tracks, integrated with the handling of all MIDI <abbr title="Continuous Controller">CC</abbr> data for each track.
9143   </li>
9144   <li>
9145     Controllers (CC data) can be set to discrete or continuous modes (the latter will interpolate between control points and send additional data).
9146   </li>
9147   <li>
9148     There is a <em>Normal</em> and a <em>Percussive</em> mode for note data editing.
9149   </li>
9150   <li>
9151     The <dfn>scroomer</dfn> is a combination scroll/zoom tool for altering
9152     the zoom level and range of visible MIDI data.
9153   </li>
9154 </ul>
9155
9156 <h2>Notable Differences</h2>
9157
9158 <ul>
9159   <li>
9160     Fader (volume) control currently operates on transmitted MIDI data, not by sending CC #7.
9161   </li>
9162   <li>
9163     All note/data editing is per-region. There are no cross-region operations at this time.
9164   </li>
9165   <li>
9166     By default, copying a MIDI region creates a <dfn>deep link</dfn>&mdash;both regions share the same data source, and edits to the contents of one will affect the other. To break this link, select <kbd class="menu">MIDI &gt; Unlink from other copies</kbd> from the region context menu, after which the selected region(s) will have their own copies of <em>only</em> the data that they visually display on screen. You will not be able to trim the region back its original length after an Unlink operation, and the operation cannot be undone.
9167   </li>
9168 </ul>
9169
9170 ---
9171 title: Fundamental Concepts
9172 part: subchapter
9173 ---
9174
9175 <p class="fixme">Check to see if this is still true for v5</p>
9176
9177 <p>Ardour's MIDI editing is based on two basic principles:</p>
9178
9179 <ol>
9180   <li>Editing should be done without having to enter a new window</li>
9181   <li>
9182     Editing should be able to carried out completely with the keyboard,
9183     or completely with the mouse, or with any combination of the two.
9184   </li>
9185 </ol>
9186
9187 <p>
9188   Currently,  MIDI editing is primarily restricted to note data. Other
9189   kinds of data (controller events, sysex data) are present and can be
9190   added and deleted, but not actually edited.
9191 </p>
9192
9193 <h2>Fundamentals of MIDI Editing in Ardour 3</h2>
9194
9195 <p>
9196   MIDI, just like audio, exists in <dfn>regions</dfn>. MIDI regions
9197   behave like audio regions: they can be moved, trimmed, copied (cloned),
9198   or deleted. Ardour allows either editing MIDI (or audio) regions, or MIDI
9199   region content (the notes), but never both at the same time. The
9200   <kbd>e</kbd> key (by default) toggles between <dfn>region level</dfn>
9201   and <dfn>note level</dfn> editing, as will double-clicking on a MIDI region.
9202 </p>
9203
9204 <p class="note">
9205   One very important thing to note: editing note information in Ardour
9206   occurs in only a single region. There is no way currently to edit in note
9207   data for multiple regions at the same time, so for example you cannot select
9208   notes in several regions and then delete them all, nor can you copy-and-paste
9209   notes from one region to another. You can, of course, copy and paste the
9210   region(s), just as with audio.
9211 </p>
9212
9213 ---
9214 title: Create MIDI Tracks
9215 part: subchapter
9216 ---
9217
9218 <p>
9219   To create a new <dfn>MIDI track</dfn>, choose <kbd class="menu">Session &gt;
9220   Add Track/Bus</kbd>. In the Add Track/Bus dialog, pick <kbd class="menu">MIDI
9221   Track</kbd> from the combo selector at the upper right.
9222 </p>
9223
9224 <p>
9225   You may decide to use a track template if you have one. You may also know the instrument (a plugin that will generate audio in response to receiving MIDI) that you want to use in the track. The Instrument selector will show you a list of all plugins that you have which accept MIDI input and generate audio output.
9226 </p>
9227
9228 <p class="fixme">Remove "you" language</p>
9229
9230 ---
9231 title: Create MIDI Regions
9232 part: subchapter
9233 ---
9234
9235 <p>
9236   Although recording MIDI is a common way to create new MIDI regions, it is
9237   often desirable to do so as part of editing/arranging.
9238 </p>
9239
9240 <p>
9241   To create a new MIDI region, simply <kbd class="mouse">Left</kbd>-click in
9242   a MIDI track. A region will be created that is one bar long. It can
9243   <a href="/editing-and-arranging/changing-region-lengths">trimmed</a> to any
9244   length desired.
9245 </p>
9246
9247 <p class="fixme">Broken link</p>
9248
9249 <p>
9250   Once a region has been created, <a href="/editing-and-arranging/edit-midi/add-new-notes">notes can be added</a> to it.
9251 </p>
9252
9253 ---
9254 title: Add New Notes
9255 part: subchapter
9256 ---
9257
9258 <h2>Adding new notes</h2>
9259
9260 <p>
9261   In general, most MIDI editing will be done with the mouse in object mode. This allows selecting notes, copying, moving or deleting them and altering their properties (see below). <em>Adding</em> notes to a MIDI region using the mouse requires dragging with the mouse if they are to be anything other than a fixed length. Since this would normally be a selection operation if the mouse is in object mode, there needs to be some way to tell Ardour to <dfn>draw</dfn> new notes within a MIDI region. Ardour provides two ways do this: one is to leave the mouse in object mode and <kbd class="mouse mod1">Left</kbd>-drag; the other, useful if entering a lot of notes for a while, is to switch the mouse into <kbd class="menu">Draw Notes</kbd> mode, which will now interpret any drags and clicks as requests to add a new note. For obvious reasons, Draw Notes mode cannot be used while using region-level editing.
9262 </p>
9263
9264 <p>So, to summarize:</p>
9265
9266 <dl class="wide-table">
9267   <dt>Selecting, moving, copying, trimming, deleting <em>regions</em></dt>
9268   <dd>
9269     leave <kbd class="menu">Note Level Editing</kbd> disabled, use object,
9270     range or other mouse modes
9271   </dd>
9272   <dt>Selecting, moving, copying trimming, deleting <em>notes</em></dt>
9273   <dd>enable <kbd class="menu">Note Level Editing</kbd>and use mouse object mode</dd>
9274   <dt>Adding new notes</dt>
9275   <dd>
9276     enable "Note Level Editing" and then either
9277     <ul>
9278       <li>use mouse object mode and <kbd class="mouse mod1">Left</kbd>-drag,
9279       or</li>
9280       <li>use mouse draw mode.</li>
9281     </ul>
9282   </dd>
9283 </dl>
9284
9285 <!-- FIXME: This is needed to keep the table from sucking up the following note's styling. Probably need a fix in the CSS. -->
9286 <p>&nbsp;</p>
9287
9288 <p class="note">
9289   It is also a <a href="/editing-and-arranging/edit-midi/step-entry">a step entry editor</a> allowing entry of notes from a virtual keyboard, and lots more besides.
9290 </p>
9291
9292 ---
9293 title: Change Note Properties
9294 part: subchapter
9295 ---
9296
9297 <p>
9298   Details about a selected note can be viewed by context-clicking on it. The
9299   dialog that pops up will also allow modification of all the properties of the
9300   selected note(s). Individual properties can be modified more efficiently using
9301   the techniques described below:
9302 </p>
9303
9304 <dl>
9305   <dt>Moving notes</dt>
9306   <dd>
9307     Right arrow and Left arrow move the selected note(s) early and later in time.
9308   </dd>
9309   <dt>Changing pitch values</dt>
9310   <dd>
9311     <kbd>&uarr;</kbd> increases the pitch of the selected notes.<br />
9312     <kbd>&darr;</kbd> reduces the pitch of the selected notes.<br />
9313     If any of the selected notes are already at the maximum or minimum value,
9314     no changes will be made to any of the notes, to preserve relative pitches.
9315     This can be overridden with <kbd class="mod2">&zwnj;</kbd>. The default shift
9316     distance is one semitone. Use <kbd class="mod3">&zwnj;</kbd> to alter this to
9317     one octave.
9318   </dd>
9319   <dt>Changing velocity values</dt>
9320   <dd>
9321     <kbd class="mod1">&uarr;</kbd> increases the velocity of the selected notes.
9322     <br/>
9323     <kbd class="mod1">&darr;</kbd> reduces the velocity of the selected
9324     notes.<br />
9325     If any of the selected notes are already at the maximum or minumum value,
9326     no changes will be made to any of the notes, to preserve relative velocities.
9327     This can be overridden with <kbd class="mod2">&zwnj;</kbd>.
9328     Presssing <kbd>v</kbd> will popup a dialog that will allow the setting of
9329     the absolute velocity value of each selected note. Finally, the scroll wheel
9330     <kbd class="mouse">&uArr;</kbd> <kbd class="mouse">&dArr;</kbd> will also
9331     adjust notes in the same way as the arrow keys.
9332     <p class="note">Like the arrow keys, it only affects selected notes, not the note the pointer is over.</p>
9333   </dd>
9334   <dt>Changing channel</dt>
9335   <dd>
9336     Press <kbd>c</kbd> to bring up a dialog that allows viewing and altering the
9337     MIDI channel of the selected notes. If the selected notes use different
9338     channels, they will all be forced to the newly selected channel.
9339   </dd>
9340   <dt>Changing start/end/duration</dt>
9341   <dd>
9342     <kbd>,</kbd> (comma) will alter the start time of the note. <br />
9343     <kbd>.</kbd> (period) will alter the end time of the note. Both keys will by
9344     default make the note longer (either by moving the start earlier or the end
9345     later). For the opposite effect, use <kbd class="mod1">,</kbd>/<kbd
9346     class="mod1">.</kbd>. The note will be altered by the current grid setting.
9347     To change the start/end positions by 1/128th of a beat, use the <kbd
9348     class="mod2">&zwnj;</kbd> modifier in addition to these shortcuts.
9349   </dd>
9350   <dt>Quantization</dt>
9351   <dd>
9352     <kbd>q</kbd> will quantize the selected notes using the current quantize
9353     settings. If the quantize settings have not been set for this session yet,
9354     the quantize dialog will appear. <kbd class="mod2">q</kbd> will display the
9355     quantize dialog to allow resetting of the quantize settings, and then
9356     quantize the selected notes. The default quantize settings are: quantize
9357     note starts to the current grid setting, no swing, no threshold, full
9358     strength.
9359   </dd>
9360   <dt>Step Entry, Quantize etc.</dt>
9361   <dd><em>missing</em></dd>
9362 </dl>
9363
9364 <p class="fixme">Add missing content</p>
9365
9366 ---
9367 title: Handling Overlapping Notes
9368 menu_title: Overlapping Notes
9369 part: subchapter
9370 ---
9371
9372 <p>
9373   Every MIDI note consists of two messages, a NoteOn and a NoteOff. Each one
9374   has a note number and a channel (also a velocity, but that isn't relevant
9375   here). The MIDI standard stresses that it is invalid to send a second NoteOn
9376   for the same note number on the same channel before a NoteOff for the first
9377   NoteOn. It is more or less impossible to do this with a physical MIDI
9378   controller such as a keyboard, but remarkably easy to trigger when editing
9379   in a DAW&mdash;simply overlapping two instances of the same note will do it.
9380 </p>
9381
9382 <p>
9383   Ardour offers many options for how to deal with instances where you overlap
9384   two instances of the same note. Which one to use is a per-session property
9385   and can be modified from <kbd class="menu">Session &gt; Properties &gt; Misc &gt; MIDI
9386   Options</kbd>.
9387 </p>
9388
9389 <dl class="wide-table">
9390   <dt>never allow them</dt>
9391   <dd>Edits that would create note overlaps are not allowed</dd>
9392   <dt>don't do anything in particular</dt>
9393   <dd>Ardour leaves overlapping notes alone&mdash;the behaviour of a MIDI receiver (plugin or hardware) is undefined</dd>
9394   <dt>replace any overlapped existing note</dt>
9395   <dd>When one note is moved to overlap another, remove the one that wasn't being moved</dd>
9396   <dt>shorten the overlapped existing note</dt>
9397   <dd>When one note is moved to overlap another, shorten the one that wasn't moved so that there is no overlap</dd>
9398   <dt>shorten the overlapping new note</dt>
9399   <dd>When one note is moved to overlap another, shorten the one that was moved so that there is no overlap</dd>
9400   <dt>replace both overlapping notes with a single note</dt>
9401   <dd>When one note is moved to overlap another, merge them both to form one (longer) note</dd>
9402 </dl>
9403
9404 <p>
9405   Changing the option in use will not retroactively make changes&mdash;it will
9406   only affect new note overlaps created while the option remains chosen.
9407 </p>
9408
9409 <p class="warning">
9410   Ardour does not check for note overlaps across tracks or even across regions.
9411   If you create these, it is your responsibility to deal with the consequences.
9412 </p>
9413
9414 ---
9415 title: Note Cut, Copy and Paste
9416 part: subchapter
9417 ---
9418
9419 <p>
9420   While in note edit mode, selected notes can be cut using
9421   <kbd class="mod1">x</kbd>, copied with <kbd class="mod1">c</kbd> and
9422   deleted with <kbd>Delete</kbd>, just as regions can. Once cut or
9423   copied, they can be pasted at the edit point using
9424   <kbd class="mod1">v</kbd>.
9425 </p>
9426
9427 ---
9428 title: Note Selection
9429 part: subchapter
9430 ---
9431
9432 <h2>Selecting/Navigating note-by-note</h2>
9433
9434 <p>
9435   Tab selects the next note. <kbd class="mod1">Tab</kbd> selects the previous
9436   note. <kbd class="mod3">Tab</kbd> or <kbd class="mod13">Tab</kbd> adds
9437   the next/previous note to the selection.
9438 </p>
9439
9440 <h2>Selecting notes with the mouse</h2>
9441
9442 <p>
9443   While in mouse object mode, you can click on a note to select it. Once you
9444   have selected one note, <kbd class="mouse mod3">Left</kbd>-click on another
9445   to select all notes between them. To add or remove a note to/from the
9446   selection, click <kbd class="mouse mod1">Left</kbd>. You can also click and
9447   drag outside of a note to <dfn>rubberband select</dfn> a series of notes.
9448 </p>
9449
9450 <p>
9451   Three different selection operations are possible if you switch to mouse
9452   range mode:
9453 </p>
9454
9455 <ul>
9456   <li>
9457     Vertical drags within the MIDI region will select all notes within the
9458     spanned note range.
9459   </li>
9460   <li>
9461     Clicks on the piano header of the track (if visible&mdash;the track must
9462     be tall enough to display it) will select all occurences of that note.
9463   </li>
9464   <li>
9465     Drags on the piano header of the track will select all notes within the
9466     spanned note range.
9467   </li>
9468 </ul>
9469
9470 <h2>Listening to Selected Notes</h2>
9471
9472 <p>
9473   If <kbd class="menu">Edit &gt; Preferences &gt; MIDI &gt; Sound MIDI notes
9474   as they are selected</kbd> is enabled, Ardour will send a pair of
9475   NoteOn/NoteOff messages through the track, which will typically allow you to
9476   hear each note as it is selected.
9477 </p>
9478
9479 ---
9480 title: Quantize MIDI
9481 part: subchapter
9482 ---
9483
9484 <p class="fixme">Needs fleshing out; this is a bit thin at the moment</p>
9485
9486 <p><img class="right" src="/images/a3_quantize.png" alt="quantize dialog" /></p>
9487
9488 <p>Accessed via <kbd>q</kbd>, the dialog includes:</p>
9489
9490 <ul>
9491   <li>Options for grid, legato and groove quantize</li>
9492   <li>Snap note start, or end</li>
9493   <li>Snap to current grid, or many beat subdivisions</li>
9494   <li>Quantize threshold (how far away from a chosen position a note must be in order to be quantized)</li>
9495   <li>Strength (how close to move a note to its new position, as a percentage of the nominal distance)</li>
9496   <li>Swing</li>
9497 </ul>
9498
9499 ---
9500 title: Step Entry
9501 part: subchapter
9502 ---
9503
9504 <p>
9505   Sometimes editing MIDI data directly from a connected MIDI device like a musical
9506   keyboard or pad controller is desired; sometimes using the mouse is. Sometimes
9507   the fine-grained control, precision and speed of entry that comes from using a
9508   custom note entry dialog is; the <dfn>Step Entry</dfn> dialog aims to be the
9509   latter.
9510 </p>
9511
9512 <p>
9513   The step entry dialog is accessed via a right click context menu on the
9514   rec-enable button, because step entry is related to <em>recording</em> MIDI
9515   data&mdash;step editing and recording MIDI via the track's MIDI port cannot be
9516   done simultaneously.
9517 </p>
9518
9519 <p class="center"><img src="/images/a3_step_entry.png" /></p>
9520
9521 <p>The dialog (closely modeled after Logic's) contains:</p>
9522
9523 <ul>
9524   <li>
9525     Chord entry switch (successive notes are stacked in a chord until
9526     it is released)</li>
9527   <li>Note length selectors</li>
9528   <li>Triplet toggle</li>
9529   <li>Normal, single, double and triple dotted note selectors</li>
9530   <li>Sustain button</li>
9531   <li>Buttons to:
9532     <ul>
9533      <li>Insert a rest of the current selected note duration</li>
9534      <li>Insert a rest of the current grid step size</li>
9535      <li>Move back to the last inserted note</li>
9536      <li>Move forward to the next beat, or bar</li>
9537      <li>Move forward to the edit point</li>
9538     </ul>
9539   </li>
9540   <li>Dynamics controls from pianississimo to fortississimo</li>
9541   <li>Channel selector</li>
9542   <li>
9543     Explicit numerical velocity selector, for more precise control
9544     than the dynamics selectors offer
9545   </li>
9546   <li>Octave selector</li>
9547   <li>Buttons to add bank or program change events</li>
9548   <li>a full 10 octave virtual keyboard</li>
9549 </ul>
9550
9551 <p>
9552   More or less all actions in the step entry dialog can be driven directly from
9553   the keyboard, so moving back and forth from keyboard to mouse to do complex data
9554   insertion is unnecessary.
9555 </p>
9556
9557 ---
9558 title: Patch Change
9559 part: subchapter
9560 ---
9561
9562 <p>
9563   A <dfn>patch change</dfn> is Ardour's description for a combination
9564   of MIDI program change and bank select messages, that (typically)
9565   instruct a synthesizer or sampler to select a different sound to use
9566   on a particular channel.
9567 </p>
9568
9569 <p>
9570   Patch changes are shown within MIDI regions as small rectangles or
9571   <dfn>flags</dfn>, as shown below:
9572 </p>
9573
9574 <p class="fixme">Add missing images</p>
9575
9576 <h2>Inserting Patch Changes</h2>
9577
9578 <p>
9579   Ensure that the
9580   <a href="/editing-and-arranging/edit-point">edit point</a> is
9581   located where the patch change should be (within an existing
9582   MIDI region). Context click, and from the MIDI region's context menu,
9583   select <kbd class="menu">MIDI &gt; Insert Patch Change</kbd>. A
9584   dialog will appear allowing the setting of the bank and program values.
9585 </p>
9586
9587 <h2>Modifying Patch Changes</h2>
9588
9589 <p>
9590   Context-clicking on a patch change will bring up the same dialog that
9591   was used to create it, allowing the modification of the program and/or bank
9592   numbers.
9593 </p>
9594
9595 <p>
9596   The mouse wheel can also be used: <kbd class="mouse">&uArr;</kbd>/<kbd
9597   class="mouse">&dArr;</kbd> on the patch change will alter the program
9598   number, <kbd class="mouse mod1">&uArr;</kbd>/<kbd
9599   class="mouse mod1">&dArr;</kbd> will modify the bank number.
9600 </p>
9601
9602 <h2>Moving Patch Changes</h2>
9603
9604 <p>
9605   Just <kbd class="mouse">Left</kbd>-drag on the patch change to move it
9606   around.
9607 </p>
9608
9609 <h2>Removing Patch Changes</h2>
9610
9611 <p>
9612   Put the mouse pointer into the rectangular area, and press <kbd>Del</kbd>
9613   or use the delete mouse button operation. This will remove the patch change
9614   (the operation can be undone).
9615 </p>
9616
9617 <h2>Names for Patch Numbers: MIDNAM files</h2>
9618
9619 <p>
9620   &hellip;mising&hellip;
9621 </p>
9622
9623 <p class="fixme">Add missing content</p>
9624
9625 ---
9626 title: Independent and Dependent MIDI Region Copies
9627 menu_title: Copy MIDI Region
9628 part: subchapter
9629 ---
9630
9631 <p>
9632   When <dfn>copying a MIDI region</dfn>, Ardour has to decide whether to make the
9633   copy refer to the same data as the original or not. If it does refer
9634   to the same data, then editing either the copy or the original will
9635   affect the both of them. If it refers to an independent copy of the
9636   data then each one can be edited without affecting the other.
9637 </p>
9638
9639 <h2>Changing dependent/independent copying for the entire session</h2>
9640
9641 <p>
9642   <kbd class="menu">Sesson &gt; Properties &gt; Misc &gt; MIDI region copies are
9643   independent</kbd> can be used to control the default behaviour when
9644   making a copy of a MIDI region.
9645 </p>
9646
9647 <p>
9648   When enabled, every new copy of a MIDI
9649   region results in a copy being made of the MIDI data used by the
9650   region, and the new copy of the region will refer to that data.
9651 </p>
9652
9653 <p>
9654   When disabled, every new copy of a MIDI region will refer to the same
9655   MIDI data, and thus editing any copy will change the contents of all
9656   of them.
9657 </p>
9658
9659 <p>
9660   Changing the status of this option has no effect on the existing
9661   dependent/independent status of existing region copies.
9662 </p>
9663
9664 <h2>Making an existing copy of a MIDI region independent</h2>
9665
9666 <p>
9667   Context-click on the MIDI region to be made independent. From the context menu, select <kbd class="menu">MIDI &gt; Unlink From Other Copies</kbd>. The copy is now using an independent version of the data, and edits to the copy will affect only the copy. Other linked copies will continue to share data.
9668 </p>
9669
9670 <p class="note">
9671   The copied data only covers the extent of the region when the copy is made. If the region was already trimmed and then a copy is made, an independent copy will have no access to data that is earlier or later than the bounds of the region it was copied from. Put differently, if an independent copy of a trimmed MIDI region is made, it cannot be "untrimmed" to a larger size.
9672 </p>
9673
9674 ---
9675 title: Automating MIDI - Pitch bending and aftertouch
9676 menu_title: Automating MIDI
9677 part: subchapter
9678 ---
9679
9680 <p>
9681   Adding pitch bending or aftertouch can add a lot of subtlety to an otherwise plain sounding midi region and help humanize it.
9682 </p>
9683
9684 <img src="/images/MIDI_pitch_bending.png" alt="Automation: pitch bending" />
9685
9686 <p>
9687   Pitch bending and aftertouch both work the same way, through automation. Right click the MIDI track's header &gt; Automation &gt; Bender <em>(or Pressure)</em> &gt; <em>choose the channel you want to bend</em>.
9688 </p>
9689
9690 <p>
9691   Using the Draw tool, as for all the automation, allows creation of a gradual change from one drawn point to another. A line in the center produces no change to the pitch, while a line above the center will bend the pitch to a higher note (up to 4 semitones) and a line going under the middle will bend the pitch to a lower note.
9692 </p>
9693
9694 <p>
9695   The values can be anything between 0 (-4 semitones) to 16,383 (+4 semitones). No automation or a value of 8,192 means no pitch shifting.
9696 </p>
9697
9698 <p>
9699   Aftertouch works very similarly, though the values are between 0 and 127. It should be noted that aftertouch differs from velocity, as aftertouch allows to slightly change the timbre or create a vibrato, while the velocity sets the power with which the note is played (e.g. on a keyboard, the key is hit).
9700 </p>
9701
9702 ---
9703 title: Transforming MIDI - Mathematical operations
9704 menu_title: Transforming MIDI
9705 part: subchapter
9706 ---
9707
9708 <p>
9709   Considering the numerical nature of MIDI events, it can be tempting to apply mathematical transformations to our MIDI regions by using mathematical operations. Ardour makes it very easy and powerful with the Transform tool.
9710 </p>
9711
9712 <p class="center"><img src="/images/MIDI_transform.png" alt="MIDI transformation" /></p>
9713
9714 <p>
9715   To access the Transform tool, right click the MIDI region &gt; <em>name_of_the_region</em> &gt; MIDI &gt; Transform...
9716 </p>
9717
9718 <p>
9719   First, select the property you want to modify in the 'Set' field, then change the target value using the 2 following fields. If you want to add more operands, click the "+" sign to create new lines. You can remove a superfluous line using the "-" sign on the right of the newly created line.
9720 </p>
9721
9722 <p>
9723   In the picture above, we've used the Transform tool to add a bit of humanization, by slightly changing the velocity of each note of the region, by a random number between -19 and +19 from it's original velocity. So we've used 3 operations:
9724 </p>
9725
9726 <ul>
9727         <li>Set velocity to this note's velocity</li>
9728         <li>+ a random number from 1 to 20</li>
9729         <li>- a random number from 1 to 20</li>
9730 </ul>
9731
9732 <p>Each note will trigger a calculation of its own, so its velocity will be increased by a random number between 1 and 20, then decreased by a random number between 1 and 20.</p>
9733
9734 <p>
9735   The properties that can be computed are:
9736 </p>
9737
9738 <ul>
9739         <li>note number (eg C2 is note number 24, C#2 is 25 and so on)</li>
9740         <li>velocity (the global intensity of the note, between 0 and 127)</li>
9741         <li>start time (in beats)</li>
9742         <li>length (in beats)</li>
9743         <li>channel</li>
9744 </ul>
9745
9746 <p>
9747   and the calculation may be based on the following properties:
9748 </p>
9749
9750 <ul>
9751         <li>this note's</li>
9752         <li>the previous note's</li>
9753         <li>this note's index (number of the note, i.e. the first one is 0, the second is 1, etc.)</li>
9754         <li>exactly (for a constant value, between 1 and 127)</li>
9755         <li>a random number from <em>lower</em> to <em>higher</em> (<em>lower</em> and <em>higher</em> beeing constant values between 1 and 127)</li>
9756         <li>equal steps from <em>lower</em> to <em>higher</em> (<em>lower</em> and <em>higher</em> beeing constant values between 1 and 127)</li>
9757 </ul>
9758
9759 <p>
9760   The mathematical operators can be:
9761 </p>
9762
9763 <ul>
9764         <li>+ (addition)</li>
9765         <li>- (substration)</li>
9766         <li>* (multiplication)</li>
9767         <li>/ (euclidian division)</li>
9768         <li>mod (rest of the euclidian division)</li>
9769 </ul>
9770
9771 <p>
9772   All this operations can be very handy, as long as you find a mathematical way to achieve your goal. Beware though of odd "border cases": division by zero (which does nothing), using the note's index and forgetting it starts at 0 and not 1, etc.
9773 </p>
9774
9775 <p>
9776   You can nevertheless create very interesting results, like humanizing (randomizing the velocity, start time and duration of all the notes), creating arpeggios, automating tedious tasks, transposing, etc.
9777 </p>
9778
9779
9780 ---
9781 title: MIDI Editors
9782 part: chapter
9783 ---
9784
9785
9786 ---
9787 title: MIDI Scene Automation
9788 part: subchapter
9789 ---
9790
9791 <p>
9792   Ardour is capable of being used to both record and deliver MIDI
9793 "scene" automation. These are MIDI messages typically used to switch
9794 presets or "scenes" on a variety of external equipment (or
9795 software), including lighting and other audio/video tools. A common
9796 use case is to automatically change presets between songs or to change
9797 lighting conditions based on a specific position on the timeline.
9798 </p>
9799
9800 <p>
9801   Each change from one scene to another is represented by a marker in
9802 the "Marker" bar.
9803 </p>
9804
9805 <p>
9806   Technically, scene changes are delivered as a combination of bank and
9807 program change MIDI messages. MIDI allows for 16,384 banks, each with
9808 128 programs.
9809 </p>
9810
9811 <h2>Recording Scene Changes</h2>
9812
9813 <p>
9814   Ardour has a dedicated MIDI port named "Scene In". Connect this port
9815 to whatever source(s) of MIDI scene (bank/program change) messages you
9816 wish to record.
9817 </p>
9818
9819 <p>
9820   Whenever the global record enable button is engaged and Ardour's
9821   transport is rolling, a new marker will be created for each scene
9822 change message received via the "Scene In" port.
9823 </p>
9824
9825 <p>
9826   If two different scene changes are received within a certain time
9827 period, only the later one will be recorded as a new marker. The
9828 default threshold for this is one millisecond.
9829 </p>
9830
9831 <p>
9832   If a scene change message is received while the playhead is close to
9833 an existing marker with an associated scene change, the recording
9834 process will alter the scene change in the existing marker rather than
9835 adding a new one. The default threshold for this "proximity" test is one
9836 millisecond.
9837 </p>
9838
9839 <h2>Manually Creating Scene Changes</h2>
9840
9841 <p>
9842   This feature is not currently implemented.
9843 </p>
9844
9845 <h2>Playing back Scene Changes</h2>
9846
9847 <p>
9848   Ardour has a dedicated MIDI port named "Scene Out". Connect this port
9849 to wherever you wish to send MIDI scene (bank/program change) messages.
9850 </p>
9851
9852 <p>
9853   When the global record enable button is
9854 <em>not</em> enabled, the relevant message(s) will be sent via the
9855 "Scene Out" port as the playhead rolls past each marker with a scene
9856 change associated with it.
9857 </p>
9858
9859 <h2>Editing Scene Changes</h2>
9860
9861 <p>
9862   This feature is not currently implemented.
9863 </p>
9864
9865 <h2>Disabling Scene Changes</h2>
9866
9867 <p>
9868   This feature is not currently implemented.
9869 </p>
9870
9871
9872 ---
9873 title: Score Editor
9874 part: chapter
9875 ---
9876
9877
9878 ---
9879 title: MIDI Event List
9880 part: chapter
9881 ---
9882
9883
9884
9885
9886 ---
9887 title: Arranging
9888 part: part
9889 ---
9890
9891
9892 ---
9893 title: Time, Tempo and Meter
9894 part: chapter
9895 ---
9896
9897
9898 ---
9899 title: Tempo and Meter
9900 part: subchapter
9901 ---
9902
9903 <p>
9904   Tempo and meter belong together. without both, there is no way to know where a beat lies in time.
9905 </p>
9906
9907 <p>
9908   Tempo provides a musical pulse, which is divided into beats and bars by a meter. When tempo is changed or an audio-locked meter is moved, all objects on the timeline that are glued to bars and beats (locations, regions) will move in sympathy.
9909 </p>
9910
9911 <p class="note">
9912   When performing meter or tempo operations, it is advised to show the BBT ruler (available by right-clicking an existing marker or ruler name), and that the constraint modifier is set (in Preferences->User Interaction) so that no other modifiers share its key combination.
9913 </p>
9914
9915 <p>
9916   The constraint modifier is the "Constrain drags using:" setting under the "When Beginning a Drag" heading. One viable setting is <kbd class="mod1"></kbd><kbd class="mod3"></kbd>.
9917 </p>
9918
9919 <h3>Tempo</h3>
9920
9921 <p>
9922   Tempo can be adjusted in several ways:
9923 </p>
9924
9925 <ul>
9926   <li>by double clicking on a tempo marker. This opens the tempo dialog which will allow entering the tempo directly into an entry box.</li>
9927   <li>by using the constraint modifier (which is set in Preferences->User Interaction) to drag the beat/bars in the BBT ruler or the tempo/meter lines.
9928   This is the preferred way to match the tempo to previously recorded material.</li>
9929
9930   <p class ="note">
9931     When dragging the BBT ruler, musical snap has no effect, however be warned that non-musical snap is in effect if enabled. Snapping to a minute while dragging a beat may result in some verly slow tempos. Snapping a beat to a video frame however is an incredibly useful way to ensure a soundtrack is punchy and synchronised to the sample.
9932   </p>
9933
9934   <li>by holding down the constaint modifier while dragging a tempo vertically. This is used for more complex tempo solving, as it allows changing the position and tempo of a tempo marker in the same drag; it is, however, a useful way to adjust the first tempo for a quick result.</li>
9935 </ul>
9936
9937 <p>
9938   A tempo may be locked to audio or musical time. This may be changed by right-clicking on a tempo. If a tempo is locked to music, an entry will be available to lock it to audio. Similarly an audio-locked tempo may be locked to music by right clicking it an selecting the "Lock to Music" entry.
9939 </p>
9940
9941 <p>
9942   Audio locked tempo marks stay in their frame position as their neigbours positions are altered. Their pulse (musical) position will change as their neighbours move. Music locked tempo marks move their frame position as their neighbours are moved, but keep their pulse position (they will move as the music is moved).
9943 </p>
9944
9945 <p>
9946   A tempo may be ramped or constant.
9947   <ul>
9948     <li>A constant tempo will keep the sesion tempo constant until the next tempo section, at which time it will jump instantly to the next tempo. These are mostly useful abrupt changes, and is the way in which traditional DAWs deal with tempo changes (abrupt jumps in tempo).</li>
9949     <li>A ramped tempo increases its tempo over time so that when the next tempo section has arrived, the sesion tempo is the same as the second one. This is useful for matching the session tempo to music which has been recorded without a metronome. Ramps may also be used as a compositional tool, but more on this later. Note that a ramp requires two points&mdash;a start and an end tempo. The first tempo in a new session is ramped, but appears to be constant as it has no tempo to ramp to. It is only when a new tempo is added and one of them is adjusted that a ramp will be heard. The same applies to the last tempo in the session&mdash;it will always appear to be constant until a new last tempo is added and changed.
9950   </li>
9951   </ul>
9952 </p>
9953
9954 <p>
9955   <img src="/images/constant-tempo.png" alt="A constant tempo displaying the tempo at the playhead in the audio clock">
9956   <br>
9957   A series of constant tempo markers. The tempo at the playhead position is the same as the previous tempo.
9958 </p>
9959
9960 <p>
9961   <img src="/images/ramped-tempo.png" alt="A ramped tempo displaying the tempo at the playhead in the audio clock">
9962   <br>
9963   A ramped tempo marker. The tempo at the playhead position is approaching the second tempo. Because the playhead is equidistant (in beats) between the
9964   two markers, the tempo at the playhead is the average of the two.
9965 </p>
9966
9967 <p>
9968   To add a new tempo, use the primary modifier and click on the tempo line at the desired position. The new tempo will be the same as the tempo at the position of the mouse click (it will not change the shape of the ramp).
9969 </p>
9970
9971 <p>
9972   To copy a tempo, hold down the primary modifier and drag the tempo desired to be copied.
9973 </p>
9974
9975 <h3>Meter</h3>
9976
9977 <p>
9978   Meter positions beats using the musical pulse of a tempo, and groups them into bars using its number of divisions per bar.
9979 </p>
9980
9981 <p>
9982   The first meter in a new session may be moved freely. It has an associated tempo which cannot be dragged by itself (although all others can). It can be moved freely and is locked to audio.
9983 </p>
9984
9985 <p>
9986   New meters are locked to music. They may only occur on a bar line if music locked.
9987 </p>
9988
9989 <p>
9990   An audio locked meter provides a way to cope with musical passages which have no meter (rubato, pause), or to allow a film composer to insert a break in music which cannot be counted in beats.
9991 </p>
9992
9993 <p>
9994   If a meter is audio-locked, its bar number is fixed from the point at which it left the main score. That bar number cannot be changed, nor can tempo motion allow the previous bar to overlap. If another bar is needed, lock the meter to music again (right click->"Lock to Music"), drag the meter to the desired bar and re-lock to audio. The new bar may be freely moved again.
9995 </p>
9996
9997 <li>To change a meter, double click it. A dialog will appear.</li>
9998 <li>To copy a meter, hold down <kbd class="mod1"></kbd> and drag it.</li>
9999
10000 ---
10001 title: Techniques for Working with Tempo and Meter
10002 part: subchapter
10003 ---
10004
10005 <h3>Techniques </h3>
10006
10007 <p>
10008   As a general approach, the best way to control tempo ramps is to use them in pairs.
10009 </p>
10010
10011 <p>
10012   Lets imagine we want to match the click to a drum performance recorded in 'free time'.
10013 </p>
10014
10015 <p>
10016   The first thing we need to do is determine where the first beat is. Drag the first meter to that position.
10017 </p>
10018
10019 <p>
10020   Now the first click will be in time with the first beat. To get all the other beats to align, we listen to the drums and visually locate the position of bar 4. You may wish to place the playhead here.
10021 </p>
10022
10023 <p>
10024   We then locate bar 4 in the BBT ruler and while holding the constraint modifier, drag it to bar 4 in the drum performance.
10025 </p>
10026
10027 <p>
10028   We notice that the click now matches the first 4 bars, but after that it wanders off. You will see this reflected in the tempo lines.. they won't quite match the drum hits. We now locate the earliest position where the click doesn't match, and place a new tempo just before this. Two bars later, place another new tempo.
10029 </p>
10030
10031 <p>
10032   Now while dragging any beat <strong>after</strong> the second new tempo, watch the drum audio and tempo lines until they align.
10033 </p>
10034
10035 <p class="note">
10036   Notice what is happening here: the tempo previous to your mouse pointer is being changed so that the beat you grabbed aligns with the pointer. Notice that the tempo lines previous to the changed one also move. This is because the previous tempo is ramping <strong>to</strong> the tempo you are changing. Look further to the left. The tempo lines in the first four bars do not move.
10037 </p>
10038
10039 <p>
10040   Again, some time later the click will not align. I didn't say this was easy.
10041 </p>
10042
10043 <p>
10044   Repeat the same technique: add two new tempos and drag the BBT ruler <strong>after</strong> the newest tempo so that the beats align with the audio again.
10045 </p>
10046
10047 <p>
10048   In a general sense, adding tempo markers in pairs allows you to 'pin' your previous work while you move further to the right.
10049 </p>
10050
10051 <h3>Another use case: matching accelerando</h3>
10052
10053 <p>
10054   Imagine you have some video and have located where your music cue begins. Move the first meter to that frame (you may snap to TC frames, but not music with an audio locked meter).
10055 </p>
10056
10057 <p>
10058   Find a starting tempo by listening to the click while you drag the meter's tempo vertically using the constraint modifier.
10059 </p>
10060
10061 <p>
10062   You have the playhead at point where the dude slams the phone down, and your idea was that 4|1|0 would be good for this, but you want an accelerando to that point.
10063 </p>
10064
10065 <p>
10066   Add a tempo at bar 4.
10067 </p>
10068
10069 <p>
10070   Holding down the constraint modifier, and with snap set to 'TC Frames', grab the BBT ruler just <strong>after</strong> 4|1|0. Drag the ruler so that 4|1|0 snaps to the 'phone' frame.
10071 </p>
10072
10073 <p class="note">
10074   Notice what happened: The second tempo was changed.<br />
10075   You had set a musical position for the second tempo marker. It was not aligned with the frame you wanted, so you dragged the BBT ruler, making the second tempo provide enough pulses over the ramp for 4|1|0 to align with the desired frame.
10076 </p>
10077
10078 <p>
10079   If the ramp doesn't feel right, you may add more points within it and keep adjusting beat positions in a similar manner.
10080 </p>
10081
10082 <h3>General</h3>
10083
10084 <p>
10085   Audio locked meters can be useful when composing, as they allow a continuous piece of music to be worked on in isolated segments, preventing the listening fatigue of a fixed form. Reassembly is left as an excercise for the reader.
10086 </p>
10087
10088
10089 ---
10090 title: Memory Locations
10091 part: chapter
10092 ---
10093
10094
10095 ---
10096 title: Arranging Regions
10097 part: chapter
10098 ---
10099
10100
10101 ---
10102 title: Region Loops and Groups
10103 part: chapter
10104 ---
10105
10106
10107
10108
10109 ---
10110 title: Mixing
10111 part: part
10112 ---
10113
10114
10115 ---
10116 title: Basic Mixing
10117 part: chapter
10118 ---
10119
10120
10121 ---
10122 title: Metering in Ardour
10123 part: subchapter
10124 ---
10125
10126 <h2>Introduction</h2>
10127
10128 <p>
10129   An engineer reading and using audio level meters compares to a musician
10130   reading or writing sheet-music. Just like there are virtuoso musicians
10131   who can't read a single note, there are great sound-engineers who just
10132   go by their ears and produce great mixes and masters without ever looking
10133   at a single meter.
10134 </p>
10135
10136 <p>
10137   Yet, if you want to work in or with the broadcast industry, it is
10138   usually unavoidable to use meters.
10139 </p>
10140
10141 <p>
10142   Audio level meters are very powerful tools that are useful in every
10143   part of the entire production chain:
10144 </p>
10145
10146 <ul>
10147   <li>When tracking, meters are used to ensure that the input
10148   signal does not <dfn>overload</dfn> and maintains reasonable
10149   <dfn>headroom</dfn>.</li>
10150   <li>Meters offer a <dfn>quick visual indication</dfn> of a
10151   activity when working with a large number of tracks.</li>
10152   <li>During mixing, meters provide an rough estimate of the
10153   <dfn>loudness</dfn> of each track.</li>
10154   <li>At the mastering stage, meters are used to check
10155   compliance with upstream <dfn>level</dfn> and <dfn>loudness
10156   standards</dfn> and to optimize the <dfn>loudness range</dfn>
10157   for a given medium.</li>
10158 </ul>
10159
10160 <h2>Meter Types</h2>
10161
10162 <p>
10163   A general treatise on metering is beyond the scope of this
10164   manual. It is a complex subject with a history...
10165   For background information and further reading we recommend:
10166 </p>
10167
10168 <ul>
10169   <li><a href="http://www.digido.com/how-to-make-better-recordings-part-2.html">How To Make Better Recordings in the 21st Century&mdash;An Integrated Approach to Metering, Monitoring, and Leveling Practices</a> by Bob Katz. Has a good historic overview of meters and motivates the K-meter</li>
10170   <li><a href="https://en.wikipedia.org/wiki/Peak_programme_meter#Table_of_characteristics">Wikipedia: Peak programme meter</a>&mdash;overview of meter types.</li>
10171   <li>"Audio Metering: Measurements, Standards and Practice: Measurements, Standards and Practics", by Eddy Brixen. ISBN: 0240814673</li>
10172   <li>"Art of Digital Audio", by John Watkinson. ISBN: 0240515870</li>
10173 </ul>
10174
10175 <p>
10176   There are different metering standards, most of which are available in Ardour. In short:
10177 </p>
10178
10179 <dl>
10180   <dt>Digital peak-meter</dt>
10181   <dd>A <dfn>Digital Peak Meter</dfn> displays the absolute maximum signal
10182   of the raw audio PCM signal (for a given time). It is commonly used when
10183   tracking to make sure the recorded audio never clips. To that end, DPMs
10184   are always calibrated to 0&nbsp;<abbr title="DeciBel Full
10185   Scale">dBFS</abbr>, or the maximum level that can be represented digitally
10186   in a given system. This value has no musical reason whatsoever and depends
10187   only on the properties of the signal chain or target medium. There are
10188   conventions  for <dfn>fall-off-time</dfn> and <dfn>peak-hold</dfn>, but no
10189   exact specifications.
10190   <p>
10191   Various conventions for DPM fall-off times and dBFS line-up level can be
10192   chosen in <kbd class="menu">Edit &gt; Preferences &gt; GUI</kbd>.
10193   </p>
10194   </dd>
10195
10196   <dt>RMS meters</dt>
10197   <dd>An <dfn><abbr title="Root Mean Square">RMS</abbr>-type meter</dfn>
10198   is an averaging meter that looks at the energy in the signal. It
10199   provides a general indication of loudness as perceived by humans. Ardour
10200   features three RMS meters, all of which offer additonal peak indication.
10201   <ul>
10202     <li><dfn>K20</dfn>: A meter according to the K-system introduced by Bob
10203     Katz, scale aligned to -20&nbsp;dBFS, rise/fall times and color schema
10204     according to spec.</li>
10205     <li><dfn>K14</dfn>: Same as K20 with scale aligned to -14&nbsp;dBFS.</li>
10206     <li><dfn>K12</dfn>: Same as K20 with scale aligned to -12&nbsp;dBFS (since 3.5.143).</li>
10207     <li><dfn>Peak + RMS</dfn>: standard RMS, customizable via
10208     <kbd class="menu">Edit &gt; Preferences &gt; GUI &gt; Metering</kbd></li>
10209   </ul>
10210   </dd>
10211
10212   <dt>IEC PPMs</dt>
10213   <dd><dfn><abbr title="International Electrontechnical Commission">IEC</abbr>-type
10214   <abbr title="Peak Programme Meters">PPM</abbr>s</dfn> are a mix between DPMs and
10215   RMS meters, created mainly for the purpose of
10216   interoperability. Many national and institutional varieties exist (<abbr
10217   title="European Broadcasting Union">EBU</abbr>, <abbr title="British Broadcasting
10218   Corporation">BBC</abbr>, <abbr title="Deutsche Industrie-Norm">DIN</abbr>).
10219   <p>
10220   These loudness and metering standards provide a common point of
10221   reference which is used by broadcasters in particular so that the
10222   interchange of material is uniform across their sphere of influence,
10223   regardless of the equipment used to play it back.
10224   </p>
10225   <p>
10226   For home recording, there is no real need for this level of
10227   interoperability, and these meters are only strictly required when
10228   working in or with the broadcast industry. However, IEC-type meters have
10229   certain characteristics (rise-time, ballistics) that make them useful
10230   outside the context of broadcast.
10231   </p>
10232   <p>
10233   Their specification is very exact, and consquently, there are no
10234   customizable parameters.
10235   </p>
10236   </dd>
10237
10238   <dt>VU meters</dt>
10239   <dd><dfn><abbr title="Volume Unit">VU</abbr> meters</dfn> are the dinosaurs (1939)
10240   amongst the meters. They react very slowly, averaging out peaks.
10241   Their specification is very strict (300ms rise-time, 1&ndash;1.5% overshoot,
10242   flat frequency response). Ardour's VU meter adheres to that spec, but for
10243   visual consistency it is displayed as a bar-graph rather than needle-style
10244   (more below).
10245   </dd>
10246 </dl>
10247
10248 <h2>Ardour Specifics</h2>
10249
10250 <img class="right" src="/images/mixer-meter-context-menu.png" alt="mixer strip meter context menu" />
10251
10252 <p>
10253   Meters are available in various places in ardour:
10254 </p>
10255
10256 <ul>
10257   <li>The mixer window features fixed height meters for each <dfn>channel strip</dfn>.</li>
10258   <li>There are small (narrow) meters on each <dfn>track-header</dfn> in the editor window.</li>
10259   <li>There are variable height meters in the <dfn>meterbridge window</dfn>.</li>
10260   <li>Optionally, a fixed-size <dfn>master meter</dfn> can be displayed in the main toolbar.</li>
10261   <li>Various other locations (<dfn>file import</dfn>, <dfn>sends</dfn>) have level-meters.</li>
10262 </ul>
10263
10264 <p>
10265   They all share the same configuration and color-theme which is available in
10266   preferences and the theme-manager. Settings for the Peak and RMS+Peak meters
10267   as well as VU meter standards are found in
10268   <kbd class="menu">Edit &gt; Preferences &gt; GUI &gt; Metering</kbd>.
10269 </p>
10270
10271 <p>
10272   The type of meter and the <dfn>metering point</dfn> (the place in the signal chain
10273   where the meter taps the signal) are configurable in the context menu of each meter.
10274   Depending on the <kbd class="menu">Edit &gt; Preferences &gt; GUI &gt; Mixer
10275   Strip</kbd> settings, the metering point is also accessible via a button in
10276   each Mixer strip.
10277 </p>
10278
10279 <img class="right" src="/images/meter-preferences.png" alt="" />
10280
10281 <p>
10282   Regardless of meter type and standard the meter display will highlight red if
10283   the signal on the given channel exceeds the configured peak threshold.
10284 </p>
10285
10286 <p>
10287   <kbd class="mouse">Left</kbd> on the peak-indicator button resets the
10288   <dfn>peak-hold indicator</dfn> of a single channel.<br />
10289   <kbd class="mod1 mouse">Left</kbd> resets a whole <dfn>group</dfn>, and<br/>
10290   <kbd class="mod13 mouse">Left</kbd> resets all meters.
10291 </p>
10292
10293 <h2>Overview of meter types</h2>
10294
10295 <p>
10296   The figure on the left below shows all available meter-types in Ardour 3.4 when fed with a -18&nbsp;dBFS 1&nbsp;kHz sine wave.
10297 </p>
10298
10299 <img class="right" style="max-width:45%;height:400px;" src="/images/needle-meters-18.png"
10300 alt="Needle-style meters as external LV2 plugins" />
10301 <img style="max-width:45%; height:400px" src="/images/meter-types-18.png"
10302 alt="Bar-graph meters in Ardour" />
10303 <br /><br />
10304
10305 <p>
10306   Due to layout concerns and consistent look &amp; feel, all meters available in
10307   Ardour itself are bar-graph type meters. Corresponding needle-style meters&mdash;which take up more visual screen space&mdash;are available as
10308   <a href="https://github.com/x42/meters.lv2/">LV2 plugins</a> (see image on the upper right).
10309 </p>
10310
10311 ---
10312 title: Signal Routing
10313 part: subchapter
10314 ---
10315
10316 <p>
10317   Ardour does most of its internal <dfn>signal routing</dfn> via JACK:
10318   all track and bus inputs and outputs are JACK ports, as are sends and
10319   inserts&mdash;which means they can be tapped into by other JACK clients.
10320   Only the signal flow inside a track or bus (i.e. from <a
10321   href="/working-with-plugins/processor-box/">processor to processor</a>) is
10322   handled internally.
10323 </p>
10324
10325 <p>
10326   By default, Ardour will create the following connections:
10327 </p>
10328
10329 <ul>
10330   <li>
10331     <dfn>Track inputs</dfn> are optionally auto-connected to hardware inputs, in round robin order, depending on the setting you chose in the
10332     <a href="/working-with-sessions/new-session-dialog"><kbd
10333     class="menu">Session &gt; New Session</kbd> dialog</a>.
10334   </li>
10335   <li>
10336     <dfn>Bus inputs</dfn> are left disconnected.
10337   </li>
10338   <li>
10339     The number of <dfn>track and bus outputs</dfn> are equal to the number
10340     of inputs of the master bus.
10341   </li>
10342   <li>
10343     Track and bus outputs are always auto-connected to the master bus inputs.
10344   </li>
10345   <li>
10346     Master bus outputs are connected to hardware outputs.
10347   </li>
10348 </ul>
10349
10350 <p>
10351   This configuration is normally sufficient to do basic tracking and playback of sessions without any adjustments. When changing these connections, be certain that there is good reason for doing so&mdash;it is generally not necessary and can often lead to problems.
10352 </p>
10353
10354 <p>
10355   However, for many workflows during mixing, more complicated signal routing is required. Fortunately, Ardour is very flexible in the ways it offers to connect things to each other.
10356 </p>
10357
10358 ---
10359 title: Busses and VCAs
10360 part: subchapter
10361 ---
10362
10363 <p>
10364   In order to use the process of mixing, Ardour offers two tools traditionally found on hardware mixing consoles: <dfn>Busses</dfn> and <dfn><abbr title="Voltage-Controlled Amplifier">VCA</abbr></dfn>s.
10365 </p>
10366
10367 <h2>Busses</h2>
10368
10369 <p>
10370   An Ardour bus can be considered a virtual track, as in a track that doesn't have a playlist (so, no regions).
10371 </p>
10372
10373 <p>
10374   Its use is to "group" some audio signals to be treated the same way. One simple use case is to group all the audio tracks containing the different drums of a drumkit. Routing all the drums tracks outputs to a bus allows, once the different levels amongst the drums have been set, to adjust the global level of the drumkit in the mix.
10375 </p>
10376
10377 <p>
10378   Bus usage goes way beyond this simple example though: busses, as tracks, can receive plugins for common audio treatment, and be routed themselves as needed. This makes for a very useful tool that is very commonly used both for musical purposes and computing ones: instead of using e.g. 10 discrete delay plugins on 10 different tracks, busses are often used as receivers of <a href="/signal-routing/aux-sends/">sends</a>, and only 1 delay plugin is used on this bus, reducing the processing power needed.
10379 </p>
10380
10381 <p class="note">Note that the Master strip, which by default receives the output from all tracks, <em>is</em> a bus itself.</p>
10382
10383 <h3>Audio Busses vs MIDI Busses</h3>
10384
10385 <p>
10386   Ardour supports 2 types of busses: Audio and MIDI. A MIDI bus differs from an audio bus just by its input (which is 1 midi input instead of <em>n</em> audio), the fact that you can put an instrument on it at creation time, whereas you can't easily add an instrument to an audio bus.
10387 </p>
10388
10389 <p>
10390   MIDI bus are provide a particularly efficient workflow for virtual drumkits where the arrangement uses different MIDI tracks. Moreover, busses with both Audio and MIDI inputs are well suited for vocoders and similar plugins.
10391 </p>
10392
10393 <p>
10394   Depending on the user's workflow and the way busses are used, 2 possibilities exists:
10395 </p>
10396
10397 <h3>Connecting a track to a bus via outputs</h3>
10398
10399 <img class="right" src="/images/connecting_bus_output.png" alt="Connecting a bus through a track's outputs">
10400
10401 <p>
10402         Connecting the output(s) of a track to the input(s) of the bus sends <em>all</em> the audio/MIDI to the bus. In the mixer strip, select (at the bottom) the OUTPUT button (often, by default, "Master"), and in the list, choose the input of a bus. Note that only the bus able to receive this output will show up, e.g. a mono bus wont be able to be connected to the output of a stereo track).
10403 </p>
10404
10405 <p>
10406         Obviously, doing so will (by default) disconnect the output from the Master's input, which means all the        audio/MIDI will be routed to the bus. For more complex routing, the OUTPUT button allows to show the <kbd class="menu">Routing Grid</kbd> that allows to plug the output of the track to multiple outputs at once, be it busses, tracks, Master... The button will then reflect these multiple connections by showing a <em>*number*</em>, number being the number of connections made in the routing grid.
10407 </p>
10408
10409 <h3>Connecting a track to a bus via Sends</h3>
10410
10411 <img class="left" src="/images/connecting_bus_send.png" alt="Connecting a bus through a send">
10412
10413 <p>
10414         This allows not to interrupt the natural flow of the signal, i.e. the track will still output to what its connected to (e.g. Master). The signal is "tapped" at the point of insertion of the send, to be sent to the bus. Right click where in the signal flow you want the send to happen, and select <kdb class="menu">New Aux Send... &gt; name_of_the_bus</kbd>.
10415 </p>
10416
10417 <p>
10418   By <kbd class="mouse">left-clicking</kbd> the send meter, it is possible to adjust the amount of signal sent to the bus. This is often the way tracks are connected to an effect bus, like a Delay bus.
10419 </p>
10420
10421 <p class="note">
10422   Busses can be plugged to other busses, through outputs or sends. Both example workflows discussed previously, i.e. busses for grouping tracks and busses for effects, can both coexist, as e.g. a "grouping" drum bus can have a send to a reverb bus, and be connected to a compressor bus.
10423 </p>
10424
10425 <h2>VCAs</h2>
10426
10427 <p class="fixme">
10428   Reword this section to Control MAster, separate from Busses, Detail the fact a track can have multiple VCA attached
10429 </p>
10430
10431 <img class="left" src="/images/vcas.png" alt="VCAs strips">
10432
10433 <p>
10434    Although track/bus <a href="/working-with-tracks/track-and-bus-groups/">groups</a> offer a certain kind of grouped-control over gain, solo, mute and more, traditional mixing consoles have long had group master channels ("VCAs") which allows to combine both a single fader to control the group level while also allowing you to easily adjust the relative levels inside the group. For large projects, this can make mixing much easier to control.
10435 </p>
10436
10437 <p>
10438   It allows to use either or both of the conventions for combining multiple masters:
10439 </p>
10440
10441 <ul>
10442   <li>Nest VCAs (VCA 2 controls VCA 1 etc.)</li>
10443   <li>Chain VCAs (VCA 1 and VCA2 both control track or bus N)</li>
10444 </ul>
10445
10446 <h3>Using a VCA strip</h3>
10447
10448 <p>
10449   A VCA strip is made of (from top to bottom in the screenshot):
10450 </p>
10451
10452 <ul>
10453   <li><dfn>1</dfn>: number of the VCA</li>
10454   <li><dfn>X</dfn>: allows to hide the VCA strip. Left clicking this button toggles the exclusive visibility of the tracks connected to this VCA</li>
10455   <li><dfn>M</dfn>: mutes the VCA</li>
10456   <li><dfn>S</dfn>: solos the VCA</li>
10457   <li><dfn>A level meter</dfn>: allows to adjust the level of the VCA</li>
10458   <li><dfn>~vca~</dfn>: a VCA button to optionally connect to another VCA</li>
10459 </ul>
10460
10461 <p>
10462   Right-clicking the name button shows a context menus comprised of:
10463 </p>
10464
10465 <ul>
10466   <li><kbd class="menu">Rename</kbd>: Renames the VCA</li>
10467   <li><kbd class="menu">Color...</kbd>: Changes the color of the VCA button in the tracks connected to this one</li>
10468   <li><kbd class="menu">Drop All Slaves</kbd>: Deletes all connections to this VCA, i.e. no tracks are controlled by this VCA anymore</li>
10469   <li><kbd class="menu">Remove</kbd>: Deletes this VCA</li>
10470 </ul>
10471
10472 <h3>Connecting to a VCA strip</h3>
10473
10474 <img class="left" src="/images/connecting_to_vca.png" alt="Connecting to VCA">
10475
10476 <p>
10477   Connecting a track/bus/VCA to a VCA is as simple as clicking the VCA button on any mixer strip and choosing the VCA to connect to.
10478 </p>
10479
10480 <p class="note">
10481   The VCA button only shows up in mixer strips when at least 1 VCA exists, i.e., you have to first create a VCA before connecting it.
10482 </p>
10483
10484 ---
10485 title: Aux Sends
10486 part: subchapter
10487 ---
10488
10489 <p>
10490   <dfn>Auxilliary sends</dfn> are <a
10491   href="/working-with-plugins/processor-box/">processors</a> in a bus or
10492   track channel strip. They tap the signal at a specific point in the signal
10493   flow (pre-fader, post-fader, before or after EQs and other plugins, etc.)
10494   and send a copy of that signal somewhere else, without affecting the
10495   normal signal flow downwards to the channel fader.
10496 </p>
10497
10498 <p>
10499   Usually, aux sends from several tracks are collectively sent to a
10500   dedicated <dfn>Aux bus</dfn> in Ardour, to create a monitor mix for a
10501   musician, or to feed an effect unit. The output of such a bus might
10502   be routed to separate hardware outputs (in the case of headphone or monitor
10503   wedge mixes), or returned to the main mix (in the case of an effect).
10504 </p>
10505
10506 <p>
10507   Since sends are JACK ports, it is also possible to send the tapped signal
10508   somewhere else directly, which is not usually possible on hardware mixers
10509   (see <a href="/signal-routing/external-sends/">External Sends</a>).
10510 </p>
10511
10512 <p>
10513   It may be useful to
10514   <a href="/signal-routing/comparing-aux-sends-and-subgroups">compare and contrast</a>
10515   the use of aux sends with <a href="/signal-routing/subgrouping">subgrouping</a>.
10516 </p>
10517
10518 <h2>Adding a new aux bus</h2>
10519
10520 <p>
10521   Choose <kbd class="menu">Session &gt; Add New Track or Bus</kbd>. In the
10522   <kbd class="menu">New Track &amp; Bus</kbd> dialog, select "Busses" in the Track/Bus
10523   selector at the upper right.
10524 </p>
10525
10526 <h2>Adding a send to an aux bus</h2>
10527
10528 <p>
10529   Context-click on the processor box for the track you want to send to the bus, and
10530   choose <kbd class="menu">New Aux Send</kbd>. From the submenu, choose the bus you
10531   want to send to. A send will be added (and will be visible in the processor box).
10532   Note that the submenu may be empty if you have not created a bus yet.
10533 </p>
10534
10535 <h3>Pre-fader and Post-fader Aux Sends</h3>
10536
10537 <p>
10538   Depending on whether you context-click above or below the fader in the processor box,
10539   the new aux send can be placed before or after the fader in the channel strip.
10540   <dfn>Post-fader</dfn> aux sends are typically used when using an aux for shared signal
10541   processing (FX), so that the amount of effect is always proportional to
10542   the main mix fader. <dfn>Pre-fader</dfn> sends ensure that the level sent to the bus
10543   is controlled <em>only</em> by the send, not the main fader&mdash;this is typical
10544   when constructing headphone and monitor wedge mixes.
10545 </p>
10546
10547 <h2>Adding a new aux bus and sending a Track Group to it</h2>
10548
10549 <p>
10550   You can add aux sends to all members of a group and connect them to a new aux bus
10551   with a single click. After creating the track group (and adding tracks to it),
10552   context-click on the group tab and choose either
10553   <kbd class="menu">Add New Aux Bus (pre-fader)</kbd> or
10554   <kbd class="menu">Add New Aux Bus (post-fader)</kbd>. A new aux bus will be created,
10555   and a new aux send added to every member of the track group that connects to
10556   this  aux bus.
10557 </p>
10558
10559 <p class="fixme">Add images, fix factual inaccuracies</p>
10560 <h2>Altering Send Levels</h2>
10561
10562 <p>
10563   You can alter the amount of the signal received by a send that it delivers to the bus
10564   it connects to. There are three approaches to this:
10565 </p>
10566
10567 <h3>Use the Send Fader</h3>
10568
10569 <p>
10570   Every send processor has a small horizontal fader that can be adjusted in the usual way. It is
10571   not very big and so this can be a little unsatisfactory if you want very fine control
10572   over the send level.
10573 </p>
10574
10575 <h3>Mapping the Main Fader</h3>
10576
10577 <p>
10578   Double-clicking on the send in the processor box will allow you to use the
10579   big fader of the mixer strip to control the send. The visual appearance of
10580   the mixer strip will change to reflect this. Double-click the send again to
10581   revert back to normal function for the strip.
10582 </p>
10583
10584 <h3>Map Aux Sends To Main Faders</h3>
10585
10586 <p>
10587   Pressing the button marked <kbd class="menu">Aux Sends</kbd> on a aux bus will
10588   alter the channel strip for every track or bus that feeds the aux bus. Many
10589   aspects of the strip will become insensitive and/or change their visual
10590   appearance. More importantly, the main fader of the affected channel strips
10591   will now control the send level and <strong>not</strong> the track gain.
10592   This gives a larger, more configurable control to alter the level. Click the
10593   <kbd class="menu">Aux Sends</kbd> button of the aux bus again to revert the
10594   channel strips to their normal use.
10595 </p>
10596
10597 <h2>Disabling Sends</h2>
10598
10599 <p>
10600   Clicking on the small "LED" in the send display in the processor box of the
10601   channel strip will enable/disable the send. When disabled, only silence will
10602   be delivered to the aux bus by this track. When enabled, the signal arriving
10603   at the send will be delivered to the aux bus.
10604 </p>
10605
10606 <h2>Send Panning</h2>
10607
10608 <p>
10609   Send panners can be configured to either be independent of the main
10610   panner, or to follow it. The latter could be useful for Reverb effects, or
10611   for in-ear monitor mixes delivered in stereo.
10612 </p>
10613
10614 ---
10615 title: Comparing Aux Sends and Subgroups
10616 menu_title: Auxes vs. Groups
10617 part: subchapter
10618 ---
10619
10620 <p>
10621   Auxes and Subgroups share a common concept&mdash;they both provide a way
10622   for one or more tracks (or busses) to send their signal to a single bus so
10623   that common signal processing can be applied to the mix of their signals.
10624 </p>
10625
10626 <p>
10627   <dfn>Aux sends</dfn> leave the existing signal routing to the main mix in place,
10628   and are typically used to create a separate mix to send to (for example)
10629   monitors or headphones (for performer monitor mixes):
10630 </p>
10631
10632 <img width="300px" src="/images/a3_aux_routing.png" alt="aux signal routing" />
10633
10634 <p>
10635   <dfn>Subgroups</dfn> usually remove the original signal routing to the main mix and replace it with a new one that delivers the output of the subgroup bus to the main mix instead.
10636 </p>
10637
10638 <img width="300px" src="/images/a3_subgroup_routes.png" alt="sub group signal routing" />
10639
10640 ---
10641 title: External Sends
10642 part: subchapter
10643 ---
10644
10645 <p>
10646   Like a normal aux send, an <dfn>external send</dfn> taps the signal at a
10647   specific within a channel strip, but delivers it to an external application
10648   or piece of hardware rather than an Ardour bus. By itself, an external
10649   send has no effect whatsoever on the audio signals within Ardour&mdash;it is a one-way signal routing that leaves all existing signal processing
10650   just as it was.
10651 </p>
10652
10653 <p>
10654   Most people will not have much use for this, but it can be useful if you
10655   want to experiment with external applications or hardware signal processing
10656   applications.
10657 </p>
10658
10659 <h2>Adding an External Send</h2>
10660
10661 <p>
10662   Context-click on the
10663   <a href="/working-with-plugins/processor-box">processor box</a> in a
10664   channel strip (at the desired location, pre or post fader) and choose
10665   <kbd class="menu">Add new External Send</kbd>. A dialog will appear
10666   containing the standard Ardour
10667   <a href="/signal-routing/the-patchbay"><dfn>patchbay</dfn></a> to allow
10668   you to connect the send to the desired destination.
10669 </p>
10670
10671 <p class="fixme">Broken links</p>
10672
10673 <h2>Removing an External Send</h2>
10674
10675 <p>You can remove an external send in several ways:</p>
10676
10677 <ul>
10678 <li><kbd class="mouse mod3">Right</kbd>-click the send in the processor box.</li>
10679 <li>Position the pointer over the send and press the <kbd>Del</kbd> key.</li>
10680 <li>Position the pointer over the send and press <kbd class="mod1">x</kbd>.</li>
10681 <li>Context-click the send and choose either <kbd class="menu">Cut</kbd> or
10682   <kbd class="menu">Delete</kbd>.</li>
10683 </ul>
10684
10685 <h2>Altering Send Levels</h2>
10686
10687 <p>
10688   Just below the send in the processor box is a small fader that can be used
10689   like all other faders in Ardour to control the gain applied to the signal
10690   delivered by the send. Drag it to alter the level, Shift-click to restore
10691   to unity (0dB) gain.
10692 </p>
10693
10694 <h2>Disabling Sends</h2>
10695
10696 <p>
10697   Click the small "LED" in the send display within the processor box to turn
10698   it on and off. When turned off, silence will be delivered to the send. When
10699   turned on, the signal within the channel strip will be delivered.
10700 </p>
10701
10702 <h2>Editing Send Routing</h2>
10703
10704 <p>
10705   Double-clicking or Edit-clicking on the send in the processor box will
10706   redisplay the patchbay dialog that allows you full control over the routing
10707   of the send.
10708 </p>
10709
10710 ---
10711 title: Inserts
10712 part: subchapter
10713 ---
10714
10715 <p>
10716   <dfn>Inserts</dfn> are signal tap points that can be placed anywhere
10717   inside a channel strip. Unlike Auxes, they will interrupt the signal flow,
10718   feeding the signal from before the insert point to its <dfn>Insert
10719   send(s)</dfn>, and connecting the remainder of the channel strip to the
10720   <dfn>Insert return(s)</dfn>, both of which are JACK ports which are
10721   visible to other JACK applications.
10722 </p>
10723
10724 <p>
10725   Inserts are the JACK equivalents of normalized switching jacks on an
10726   analog console.
10727 </p>
10728
10729 <p>
10730   An insert allows you to either use a special external DSP JACK
10731   application that is not available as a plugin, or to splice an external
10732   analog piece of gear into your channel strip, such as a vintage
10733   compressor, tube equalizer, etc. In the latter case, you would first
10734   connect your inserts to a pair of hardware ports, which are in turn
10735   connected to the outboard gear.
10736 </p>
10737
10738 <p>
10739   To disable (bypass) an insert, click on its LED in the processor box.
10740 </p>
10741
10742 <p class="note">
10743   When you create an insert, the signal will be interrupted until you make
10744   the relevant connections to the insert ports!
10745 </p>
10746
10747 <p class="note">
10748   Inserts will incur an additional JACK period of latency, which can be
10749   measured and compensated for during mixing, but not during tracking!
10750 </p>
10751
10752 ---
10753 title: Subgrouping
10754 part: subchapter
10755 ---
10756
10757 <p>
10758   <dfn>Subgrouping</dfn> (sometimes known as "Grouping" or "Audio Grouping")
10759   is a way to collect related signals together to apply some common
10760   treatment, before sending them on to the main mix. One standard
10761   application is to group several tracks belonging to the same instrument or
10762   section (such as a drumkit or horn section), to be able to adjust their
10763   volume with a single fader, after their inner balance has been set using
10764   the track faders.
10765 </p>
10766
10767 <p>
10768   To create a subgroup from an existing Track/Bus group, context-click on
10769   the relevant <a href="/working-with-tracks/track-and-bus-groups">group tab</a>,
10770   and choose <kbd class="menu">Add new subgroup bus</kbd>. A new bus will be
10771   created and every member of the track group will have its outputs disconnected
10772   from other destinations and then connected to the new bus inputs. The bus
10773   outputs will feed the master bus unless you have selected manual connections
10774   for the session. The bus will be named after the track group name.
10775 </p>
10776
10777 <p>
10778   Alternatively, you can create a group manually, by first adding a new bus,
10779   then, for each track you want to feed the subgroup bus, disconnect its outputs
10780   from the master and connect it to the inputs of the subgroup bus instead.
10781   You can do this in the global audio patchbay or a track by track basis via the
10782   output button of each track's channel strip.
10783 </p>
10784
10785 <p>
10786   To remove a subgroup (bus), context-click on the track group tab, and select
10787   <kbd class="menu">Remove subgroup bus</kbd>. You can also simply delete the
10788   bus itself. Note that this operation will <strong>not</strong> restore signal
10789   routing to the way it was before the addition of the subgroup bus&mdash;tracks
10790   that had been subgrouped will be left with their main outputs disconncted.
10791 </p>
10792
10793 ---
10794 title: Patchbay
10795 part: subchapter
10796 ---
10797
10798 <p>
10799   The <dfn>patchbay</dfn> is the main way to make connections to, from and
10800   within Ardour's mixer.
10801 </p>
10802
10803 <p class="note">
10804   Notable exceptions are internal aux sends and connections to the monitor bus (if
10805   you are using one): these cannot be controlled from a patchbay, and are
10806   basically not under manual control at all.
10807 </p>
10808
10809 <img class="right" src="/images/connection-manager.png" alt="an example patchbay" />
10810
10811 <p>
10812   The patchbay presents two groups of ports; one set of <dfn>sources</dfn>  (which produce data), and one of <dfn>destinations</dfn> (which consume data). Depending on the relative number of each, the sources will be placed on the left or the top of the dialogue, and the destinations on the right or the bottom. Thus, in general, signal flow is from top or left to right or bottom.
10813 </p>
10814
10815 <p>
10816   Both sources and destinations are divided up into groups, with each group being given a tab:
10817 </p>
10818
10819 <dl class="narrower-table">
10820   <dt>Hardware</dt>
10821   <dd>
10822     These are ports which are connected to a physical piece of hardware (a sound card or MIDI interface).</dd>
10823   <dt>Ardour Busses</dt>
10824   <dd>All ports belonging to busses.</dd>
10825   <dt>Ardour Tracks</dt>
10826   <dd>All ports belonging to tracks.</dd>
10827   <dt>Ardour Misc</dt>
10828   <dd>
10829     These are other ports that do not fit into the previous two categories; for example, the ports on which the metronome click is output, and MIDI ports for things like control surfaces and timecode.
10830   </dd>
10831   <dt>Other</dt>
10832   <dd>
10833     If you have other JACK clients running, their ports will be found here. If there are no such ports, the tab will not exist (on one or both axes of the grid).</dd>
10834 </dl>
10835
10836 <p>
10837   The main part of the patchbay is a <dfn>matrix grid</dfn>. Within this grid, green dots represent connections, and you can click in any of the squares to make or break connections. You can also click and drag to draw a line of connections, which is sometimes useful for making many connections at once.
10838 </p>
10839
10840 <p>
10841   In the example patchbay shown above we can note various things. We are using the <kbd class="menu">Ardour Tracks</kbd> sources tab, so we see the output ports of the three tracks in our session: Fred, Jim and Foo. Our destinations are from the <kbd class="menu">Ardour Busses</kbd> tab, so we have the inputs of a session bus, Sheila, and the inputs of the master bus. Fred and Jim have stereo outputs, so have L and R connections. Foo is a MIDI track, so it only has one connection, and its squares in the grid are coloured light grey to indicate that no connection can be made between Foo (a MIDI output) and our busses (which are all audio-input).
10842 </p>
10843
10844 <p>
10845   The green dots in the example show that both Foo and Bar are connected to the master bus, left to left and right to right.
10846 </p>
10847
10848 <h2>Variants on the Patchbay</h2>
10849
10850 <p>
10851   Slightly different versions of the patchbay are available from different places in Ardour. For a global view of all JACK audio connections, use <kbd class="menu">Window &gt Audio Patchbay</kbd>, or press <kbd class="mod2">P</kbd>. A corresponding MIDI Connection Manager can be opened using <kbd class="mod23">P</kbd>.
10852 </p>
10853
10854 <p>
10855   There is also a patchbay available when connecting individual tracks; clicking on the input or output buttons of a mixer strip will open a connection manager which has the corresponding track input or output as the only destination or source, with all other ports available for connection to it.
10856 </p>
10857
10858 <h2>Other patchbay features</h2>
10859
10860 <p>
10861   Context-clicking on a port name in the connection manager opens a menu which provides a few handy options:
10862 </p>
10863
10864 <dl class="wide-table">
10865   <dt><kbd class="menu">Add audio port</kbd> and <kbd class="menu">Add MIDI port</kbd></dt>
10866   <dd>
10867     These options add audio or MIDI ports to the thing that you opened the menu over, if this is possible. In this way, for example, tracks and busses can be extended to have more inputs or outputs.
10868   </dd>
10869   <dt><kbd class="menu">Remove</dt>
10870   <dd>
10871     Removes the given port, if possible. <kbd class="mouse mod3">Right</kbd>-clicking a port will do the same.
10872   </dd>
10873   <dt><kbd class="menu">Disconnect all from…</kbd></dt>
10874   <dd>Disconnects everything from the given port.</dd>
10875   <dt><kbd class="menu">Rescan</kbd></dt>
10876   <dd>
10877     Ardour will try to keep abreast of any changes to the JACK ports on your system, and reflect them in any connection managers which are open. If for some reason this fails, use this to re-scan the list of ports and update the manager.
10878   </dd>
10879   <dt><kbd class="menu">Show individual ports</kbd></dt>
10880   <dd>
10881     If you have a session which has lots of multi-channel tracks or busses, it may be an unnecessary detail that you have to connect left to left and right to right every time you make a connection. This obviously gets worse with higher channel counts (such as for 5.1 or Ambisonics). To make life easier with such sessions, you can untick Show individual ports. After that, the channels of tracks and busses will be hidden, and any green dots you add in the connection manager will automatically connect each channel of the source to the corresponding channel of the destination (left to left, right to right and so on). In this mode, a half-circle in the connection grid indicates that some (but not all) of the source's ports are connected to the destination.
10882   </dd>
10883   <dt><kbd class="menu">Flip</kbd></dt>
10884   <dd>
10885     This will flip the visible ports on the vertical axis with those on the horizontal. If, for example, the top of the connection manager is showing <kbd class="menu">Ardour Busses</kbd> and the right is showing <kbd class="menu">Hardware</kbd>, flip will swap the view to the opposite. You can also flip by pressing <kbd>f</kbd>. Note that if there are no matching tabs on both axes, flipping will be impossible.
10886   </dd>
10887 </dl>
10888
10889 ---
10890 title: Track/Bus Signal Flow
10891 part: subchapter
10892 ---
10893
10894 <h2>Overview</h2>
10895
10896 <p>
10897 In each individual Track or Bus the signal flow is top to bottom. Consider the following diagram:
10898 </p>
10899
10900 <p class="center"><img width="360px" src="/images/track_signal_routing.png" alt="track signal routing" /></p>
10901
10902 <p>
10903   Trim, Fader and Panner are provided by Ardour. The Processor-Box can hold 3rd Party Plugins or host-provided redirects (insert, aux-send,..).
10904 </p>
10905
10906 <p class="fixme">Where is the processor box in that image?</p>
10907
10908 <p>
10909   An important aspect is that the signal flow is multi-channel and not fixed throughout the track. For example, a Track can have a mono input, a mono to stereo plugin (e.g. reverb) flowing into a surround panner with 6 outputs. The design of Ardour is that width of the signal flow is defined by the passage through plugins in the processor box, followed by panning.
10910   The number of inputs to the panner is defined by the number outputs of the last plugin in the chain. The number of panner outputs is equal to the track's outputs ports, which can be added and remove dynamically. This schema called <em>Flexible I/O</em>. It's very powerful and a distinct feature of Ardour.
10911 </p>
10912
10913 <p class="note">
10914   The golden rule of processor signal flow:<br/>The number of outputs of one link of the process chain defines the number inputs of the next, until the panner.
10915 </p>
10916
10917 <p>
10918   Due to this rule there is one very common case that is hard to achieve: Keep a mono track mono.  With <em>Flexible I/O</em>, if a stereo plugin is added on a mono track, the signal flow after that plugin becomes stereo.
10919 </p>
10920
10921 <h2>Strict I/O</h2>
10922
10923 <p>
10924   Strict I/O enforces a simple rule: Plugins have the same number of inputs as they have outputs. By induction the track will have as many output-ports as there are input ports.
10925 </p>
10926
10927 <ol>
10928         <li>Adding a Plugin will not modify the signal-flow. The number of plugin outputs is forced to the number of inputs present at the point of insertion.
10929                 If a plugin-pin is missing, it is ignored. If Plugin-pin is unconnected, it is fed with silence. Unconnected plugin outputs are ignored).</li>
10930         <li>Strict I/O enforces the number of output ports.  The number of inputs to the panner (outputs of last plugin) defines the number of track outputs (after panner).
10931                 Required ports are automatically added, excess ports are removed. The user cannot manually add/remove output ports.</li>
10932 </ol>
10933
10934 <p>
10935   Strict I/O is set when creating the track and can later be en/disabled dynamically in the context menu of every mixer strip.
10936 </p>
10937
10938 <p class="center"><img src="/images/strict_io_routing.png" alt="strict i/o routing" /></p>
10939
10940 <p>
10941   There are two exceptions to the above rule 1.
10942 </p>
10943
10944 <ul>
10945 <li>Midi Synths. When adding a synth at a point where there is a Midi port only, the synthesizer plugin will add audio-output ports,
10946   which trickle down the processor chain to all follow up plugins as inputs and in turn force their outputs to match.</li>
10947 <li>Side chain inputs are not affected by strict I/O</li>
10948 </ul>
10949
10950 <h2>Customizing the Signal Flow</h2>
10951
10952 <p>
10953   The signal flow though the mixer can be customized at every processor node via "Pin Configuration" in the context menu of every processor.
10954   User customization override all automatic (flexible/strict I/O mode) inferred output port settings for the given processor.
10955   Non-customized plugins downstream will follow suit depending on the selected route mode, e.g. adding an additional output to a plugin on a track set to strict I/O will trickle down the process chain until the output and result in the addition of an output port.  This is useful for example in case of a mono to stereo reverb.
10956 </p>
10957
10958 <p>
10959   One can also bypass plugin instances with a 'thru' connection. This connection is latency compensated. One example is separate Left/Right channel Equalization using two mono plugins on a stereo track:
10960 </p>
10961
10962 <p class="center"><img src="/images/left_right_eq.png" alt="separate left/right Eq" /></p>
10963
10964 ---
10965 title: Muting and Soloing
10966 part: subchapter
10967 ---
10968
10969 <p>
10970   Each track and bus has two buttons which have important implications
10971   for signal flow: <dfn>mute</dfn> and <dfn>solo</dfn>. The behaviour
10972   of these buttons is configurable in Ardour, to suit different studio
10973   set-ups.
10974 </p>
10975
10976 <h2>Without a monitor bus</h2>
10977
10978 <p>
10979   If you are using Ardour without a monitor bus, there is only one way
10980   in which mute and solo will work:
10981 </p>
10982
10983 <ul>
10984   <li>
10985     Mute on a track or bus will mute that track on the master bus,
10986      so that it will not be heard.
10987   </li>
10988   <li>
10989     Solo on a track or bus will solo that track or bus and mute all
10990     others. Soloing a bus will also solo any tracks or
10991     busses which feed that bus.
10992   </li>
10993 </ul>
10994
10995 <h2>With a monitor bus</h2>
10996
10997 <p>
10998   For setups with a monitor bus, you have more options, mostly
10999   governed by the setting of the
11000   <kbd class="option">Solo controls are Listen controls</kbd> option
11001   in <kbd class="menu">Edit &gt; Preferences &gt; Solo / mute.
11002 </p>
11003
11004 <p>
11005   With <kbd class="optoff">Solo controls are Listen controls</kbd>
11006   unticked, behaviour is almost exactly the same as the situation
11007   without a monitor bus. Mute and solo behave the same, and the monitor
11008   bus is fed from the master bus, so it sees the same thing.
11009 </p>
11010
11011 <p>
11012   With <kbc class="option">Solo controls are Listen controls</kbd>
11013   ticked, the master and monitor busses behave differently. In this
11014   mode, solo controls are more properly called <dfn>listen</dfn>
11015   controls, and Ardour's solo buttons will change their legend from
11016   <samp>S</samp> to either <samp>A</samp> or <samp>P</samp> to
11017   reflect this.
11018 </p>
11019
11020 <p>
11021   Now, without any mute or listen, the monitor bus remains fed by
11022   the master bus. Also:
11023 </p>
11024
11025 <ul>
11026   <li>
11027     Mute will mute the track or bus, so that it will not be heard
11028     anywhere (neither on the master nor monitor busses), much as before.
11029   </li>
11030   <li>
11031     Listen will disconnect the monitor bus from the master bus, so
11032     that the monitor bus now only receives things that are "listened to".
11033     Listen will not perform any muting, and hence the master bus will
11034     not be affected by a listened track or bus.
11035   </li>
11036 </ul>
11037
11038 <p>
11039   When solo controls are listen controls, the listening point can be set
11040   to either After-Fade Listen (AFL) or Pre-Fade Listen (PFL). The precise
11041   point to get the signal from can further be configured using the
11042   <kbd class="menu">PFL signals come from</kbd> and
11043   <kbd class="menu">AFL signals come from</kbd> options.
11044 </p>
11045
11046 <p>
11047   The solo-mute arrangement with a monitor bus is shown below:
11048 </p>
11049
11050 <img src="/images/solo-mute.png" alt="mute/solo signal flow" />
11051
11052 <p>
11053   Here we have a number of tracks or busses (in orange). Each one has an
11054   output which feeds the master bus. In addition, each has PFL and AFL
11055   outputs; we have a choice of which to use. PFL/AFL from each track or
11056   bus are mixed. Then, whenever anything is set to AFL/PFL, the monitor out
11057   becomes just those AFL/PFL feeds; the rest of the time, the monitor out is
11058   fed from the master bus.
11059 </p>
11060
11061 <p>
11062   In this scheme Solo has no effect other than to mute other non-soloed tracks;
11063   with solo (rather then listen), the monitor out is fed from the master bus.
11064 </p>
11065
11066 <h2>Other solo options</h2>
11067
11068 <p>
11069   <kbd class="menu">Edit &gt; Preferences &gt;  Solo / Mute</kbd> has some
11070   more solo options:
11071 </p>
11072
11073 <h3>Solo-in-place mute cut</h3>
11074
11075 <p>
11076   When using solo-in-place (SiP), in other words when soloed tracks are being
11077   listened to on the master bus, this fader specifies the gain that will be
11078   applied to other tracks in order to mute them. Setting this level to
11079   -∞&nbdp;dB will mean that other tracks will not be heard at all; setting to
11080   some higher value less than 0dB means that other non-soloed tracks will be h
11081   eard, just reduced in volume compared to the soloed tracks. Using a value
11082   larger than -∞dB is sometimes called "Solo-In-Front" by other DAWs, because
11083   the listener has the sense that soloed material is "in front" of other
11084   material. In Ardour, this is not a distinct mode, but instead the mute cut
11085   control offers any level of "in-front-ness" that you might want to use.
11086 </p>
11087
11088 <h3>Exclusive solo</h3>
11089
11090 <p>
11091   If this is enabled, only one track or bus will ever be soloed at once; soloing
11092   track B while track A is currently soloed will un-solo track A before soloing
11093   track B.
11094 </p>
11095
11096 <h3>Show solo muting</h3>
11097
11098 <p>
11099   If this is enabled, the mute button of tracks and busses will be drawn
11100   outlined to indicate that the track or bus is muted because something else
11101   is soloed. This is enabled by default, and we recommend that you leave it
11102   that way unless you are extremely comfortable with Ardour's mute/solo
11103   behaviour.
11104 </p>
11105
11106 <h3>Soloing overrides muting</h3>
11107
11108 <p>
11109   If this is enabled, a track or bus that is both soloed and muted will behave
11110   as if it is soloed.
11111 </p>
11112
11113 <h3>Mute affects…</h3>
11114
11115 <p>
11116   These options dictate whether muting the track will affect various routes out
11117   of the track; through the sends, through the control outputs (to the monitor
11118   bus) and to the main outputs.
11119 </p>
11120
11121 ---
11122 title: Panning
11123 part: subchapter
11124 ---
11125
11126 <p>
11127   <dfn>Panning</<dfn> is the process of distributing one or more signals
11128   across a series of outputs so that the listener will have the
11129   experience of them coming from a particular point or area of the
11130   overall listening field.
11131 </p>
11132
11133 <p>
11134   It is used to create a sense of space and/or a sense of motion in an
11135   audio mix. You can spread out different signals across the space, and
11136   make them move over time.
11137 </p>
11138
11139 <h2>Types of Panners</h2>
11140
11141 <p>
11142   The way a panner works depends a great deal on how many signals it
11143   is going to process and how many outputs it will send them to. The
11144   simplest case is distributing a single signal to 2 outputs, which is
11145   the common case when using a "mono" track and a stereo speaker
11146   setup.
11147 </p>
11148
11149 <p>
11150   But panning in Ardour could theoretically involve distributing any
11151   number of signals to any number of ouputs. In reality, Ardour does
11152   not have specific panners for each different situation. Currently,
11153   it has dedicated panners for the following situations:
11154 </p>
11155
11156 <ul>
11157   <li>1 signal distributed to 2 outputs (the mono panner)</li>
11158   <li>2 signals distributed to 2 outputs (the stereo panner)</li>
11159   <li>N signals distributed to M outputs (the VBAP panner)</li>
11160 </ul>
11161
11162 <p>
11163   Even for each of these cases, there are many different ways to
11164   implement panning. Ardour currently offers just one solution to each
11165   of these situations, but in the future will offer more.
11166 </p>
11167
11168 <p>
11169   In addition to the panners, Ardour has a balance control for subtle
11170   corrections to existing stereo images.
11171 </p>
11172
11173 ---
11174 title: Mono Panner
11175 part: subchapter
11176 ---
11177
11178 <p>
11179   The default <dfn>mono panner</dfn> distributes 1 input to 2 outputs. Its
11180   behaviour is controlled by a single parameter, the <dfn>position</dfn>. By
11181   default, the panner is centered.
11182 </p>
11183
11184 <h2>Mono Panner User Interface</h2>
11185
11186 <img src="/images/mono-panner-annotated.png" alt="image of the mono panner"/>
11187
11188 <p class="note">
11189   The mono panner looks a quite similar to the
11190   <a href="/mixing/panning/stereo_panner">stereo panner</a>
11191   interface. The difference is that the L/R labels in the lower half
11192   of the mono panner do not move because there is no "width" to
11193   control.
11194 </p>
11195
11196 <h2>Using the mouse</h2>
11197
11198 <p>To change the position smoothly, press the right button and drag
11199   anywhere within the panner. <em>Note: you do not need
11200   to grab the position indicator in order to drag</em>
11201 </p>
11202
11203 <dl class="faq">
11204
11205 <dt>Reset to defaults</dt>
11206 <dd>Click <kbd class="mod3 mouse">right</kbd></dd>
11207
11208 <dt>Change to a "hard left"</dt>
11209 <dd>Double click <kbd class="mouse">right</kbd> in the left side
11210   of the panner</dd>
11211
11212 <dt>Change to a "hard right"</dt>
11213 <dd>Double click <kbd class="mouse">right</kbd> in the right side
11214   of the panner</dd>
11215
11216 <dt>Set the position to center</dt>
11217 <dd>Double Click <kbd class="mouse">right</kbd> in the middle of the panner</dd>
11218 </dl>
11219
11220 <h2>Keyboard bindings</h2>
11221
11222 <p>
11223   When the pointer is within a mono panner user interface, the following keybindings are available to operate on that panner:
11224 </p>
11225
11226 <dl>
11227   <dt><kbd>&larr;</kbd> / <kbd class="mod1">&larr;</kbd></dt>
11228   <dd>move position 1&deg; / 5&deg; to the left</dd>
11229   <dt><kbd>&rarr;</kbd> / <kbd class="mod1">&rarr;</kbd></dt>
11230   <dd>move position 1&deg; / 5&deg; to the right</dd>
11231   <dt><kbd>0</kbd></dt>
11232   <dd>reset position to center</dd>
11233 </dl>
11234
11235 <h2>Using the scroll wheel/touch scroll</h2>
11236
11237 <p>
11238   When the pointer is within a mono panner user interface, the scroll wheel may be used as follows:
11239 </p>
11240
11241 <dl>
11242   <dt><kbd class="mouse">&uArr;</kbd> or <kbd class="mouse">&lArr;</kbd></dt>
11243   <dd>move position to the left by 1&deg;</dd>
11244   <dt><kbd class="mod1 mouse">&uArr;</kbd> or <kbd class="mod1 mouse">&lArr;</kbd></dt>
11245   <dd>move position to the left by 5&deg;</dd>
11246   <dt><kbd class="mouse">&dArr;</kbd> or <kbd class="mouse">&rArr;</kbd></dt>
11247   <dd>move position to the right by 1&deg;</dd>
11248   <dt><kbd class="mod1 mouse">&dArr;</kbd> or <kbd class="mod1 mouse">&rArr;</kbd></dt>
11249   <dd>move position to the right by 5&deg;</dd>
11250 </dl>
11251
11252 ---
11253 title: Balance Control
11254 part: subchapter
11255 ---
11256
11257 <p>
11258   For stereo tracks, you can now switch between the default stereo panner and a traditional <dfn>balance control</dfn> by right-clicking on the panner widget.
11259 </p>
11260
11261 <img class="left" src="/images/stereo-balance.png" alt="Stereo Balance
11262 control"/>
11263
11264 <p>
11265   When the balance is centered, the incoming signals will be unaffected. Moving it to one side will linearly attenuate the signal of the opposite side.
11266 </p>
11267
11268 <p class="note">
11269   While the balance control is considerably less flexible than the stereo panner, it works with arbitrary content without danger of introducing comb filter artifacts.
11270 </p>
11271
11272 ---
11273 title: Stereo Panner
11274 part: subchapter
11275 ---
11276
11277 <p>
11278   The default <dfn>stereo panner</dfn> distributes two inputs to two outputs. Its
11279   behaviour is controlled by two parameters, <dfn>width</dfn> and
11280   <dfn>position</dfn>. By default, the panner is centered at full width.
11281 </p>
11282
11283 <p>
11284   The stereo panner assumes that the signals
11285   you wish to distribute are either uncorrelated (i.e. totally
11286   independent), or that they contain a stereo image which is
11287   <dfn>mono-compatible</dfn>, such as a co-incident microphone recording, or a
11288   sound stage that has been created with pan pots.<sup><a href="#caveat">*</a></sup>
11289 </p>
11290
11291 <p class="note">
11292   With the default values it is not possible to alter the position,
11293   since the width is already spread entirely across both outputs. To
11294   alter the position, you must first reduce the width.
11295 </p>
11296
11297 <h2>Stereo Panner User Interface</h2>
11298
11299 <img src="/images/stereo-panner-annotated.png" alt=""/>
11300
11301 <p>
11302   The <dfn>panner user interface</dfn> consists of three elements, divided between
11303   the top and bottom half. Click and/or drag in the top half to
11304   control position; click and/or drag in the bottom half to control
11305   width (see below for details).
11306 </p>
11307
11308 <p>
11309   In the top half is the position indicator, which shows where the
11310   center of the stereo image is relative to the left and right
11311   edges. When this is the middle of the panner, the stereo image is
11312   centered between the left and right outputs. When it all the way to
11313   the left, the stereo image collapses to just the left speaker.
11314 </p>
11315
11316 <p>
11317   In the bottom half are two signal indicators, one marked "L" and the
11318   other "R". The distance between these two shows the width of the
11319   stereo image. If the width is reduced to zero, there will only be a
11320   single signal indicator marked "M" (for mono), whose color will
11321   change to indicate the special state.
11322 </p>
11323
11324 <p>
11325   It is possible to invert the outputs (see below) so that whatever
11326   would have gone to the right channel goes to the left and vice
11327   versa. When this happens, the entire movable part of the panner
11328   changes color to indicate clearly that this is the case.
11329 </p>
11330
11331 <h3>Position vs. L/R</h3>
11332
11333 <p>
11334   Although the implementation of the panner uses the "position"
11335   parameter, when the user interface displays it numerically, it shows
11336   a pair of numbers that will be familiar to most audio engineers.
11337 </p>
11338
11339 <table>
11340 <tr><th>Position</th><th>L/R</th><th>English</th></tr>
11341 <tr><td>0</td><td>L=50% R=50%</td><td>signal image is midway between
11342     left and right speakers</td></tr>
11343
11344 <tr><td>-1</td><td>L=100% R=0%</td><td>signal image is entirely
11345     at the left speaker</td></tr>
11346
11347 <tr><td>1</td><td>L=0% R=100%</td><td>signal image is entirely
11348     at the right speaker</td></tr>
11349 </table>
11350
11351 <p>
11352   One way to remember this sort of convention is that the middle of the
11353   USA is not Kansas, but "Los Angeles: 50% New York: 50%".
11354 </p>
11355
11356 <h3>Examples In Use</h3>
11357
11358 <table>
11359 <tr><th>Appearance</th><th>Settings</th></tr>
11360 <tr><td><img src="/images/stereo-panner.png"></td><td>Width=100%,
11361     L=50 R=50</td></tr>
11362 <tr><td><img src="/images/stereo-panner-zero.png"></td><td>Width=0%,
11363     L=50 R=50</td></tr>
11364 <tr><td><img src="/images/stereo-panner-inverted.png"></td><td>Width=-100%, Position = 0 (center)</td></tr>
11365 <tr><td><img src="/images/stereo-panner-right.png"></td><td>Width=36%,
11366     L=44 R=56</td></tr>
11367 <tr><td><img src="/images/stereo-panner-hard-right.png"></td><td>Width=0%,
11368     L=0 R=100</td></tr>
11369 </table>
11370
11371 <h4>Using the mouse</h4>
11372
11373 <p>
11374   Mouse operations in the upper half of the panner adjust the position
11375   parameter, constrained by the current width setting.
11376 </p>
11377 <p>
11378   Mouse operations in the lower half of the panner adjust the width
11379   parameter, constrained by the current position setting.
11380 </p>
11381 <p>
11382   To change the position smoothly, press the right button and drag
11383   within the top half of the panner, then release. The position will
11384   be limited by the current width setting. <em>Note: you do not need
11385   to grab the position indicator in order to drag.</em>
11386 </p>
11387 <p>
11388   To change the width smoothly, press the right button and drag
11389   within the lower half of the panner, then release. The width will be
11390   limited by the current position setting. <em>Note: you do not need to
11391   grab the L/R indicators in order to drag.</em>
11392 </p>
11393
11394 <dl class="faq">
11395
11396 <dt>Reset to defaults</dt>
11397 <dd>Click <kbd class="mod3 mouse">right</kbd></dd>
11398
11399 <dt>Change to hard left</dt>
11400 <dd>Double click <kbd class="mod2 mouse">right</kbd> in the upper left half
11401   of the panner</dd>
11402
11403 <dt>Change to a hard right</dt>
11404 <dd>Double click <kbd class="mod2 mouse">right</kbd> in the upper right half
11405   of the panner</dd>
11406
11407 <dt>Move position as far left as possible, given width</dt>
11408 <dd>Double click <kbd class="mouse">right</kbd> in the upper left half of the
11409   panner</dd>
11410
11411 <dt>Move position as far right as possible, given width</dt>
11412 <dd>Double click <kbd class="mouse">right</kbd> in the upper right half of the
11413   panner</dd>
11414
11415 <dt>Set the position to center</dt>
11416 <dd>Click <kbd class="mouse">right</kbd> in the upper middle of the panner</dd>
11417
11418 <dt>Reset to maximum possible width</dt>
11419 <dd>Double click <kbd class="mouse">right</kbd> on the lower left side</dd>
11420
11421 <dt>Invert (flip channel assignments)</dt>
11422 <dd>Double click <kbd class="mouse">right</kbd> on the lower right side</dd>
11423
11424 <dt>Set width to 0&deg;</dt>
11425 <dd>Double click <kbd class="mouse">right</kbd> in the lower middle</dd>
11426 </dl>
11427
11428 <h4>Keyboard bindings</h4>
11429
11430 <p>
11431   When the pointer is within a stereo panner user interface, the following
11432   keybindings are available to operate on that panner:
11433 </p>
11434
11435 <dl>
11436   <dt><kbd>&uarr;</kbd> / <kbd class="mod1">&uarr;</kbd></dt>
11437   <dd>increase width by 1&deg; / 5&deg;</dd>
11438   <dt><kbd>&darr;</kbd> / <kbd class="mod1">&darr;</kbd></dt>
11439   <dd>decrease width by 1&deg; / 5&deg;</dd>
11440   <dt><kbd>&larr;</kbd> / <kbd class="mod1">&larr;</kbd></dt>
11441   <dd>move position 1&deg; / 5&deg; to the left</dd>
11442   <dt><kbd>&rarr;</kbd> / <kbd class="mod1">&rarr;</kbd></dt>
11443   <dd>move position 1&deg / 5&deg; to the right</dd>
11444   <dt><kbd>0</kbd></dt>
11445   <dd>reset position to center</dd>
11446   <dt><kbd class="mod2">&uarr;</kbd></dt>
11447   <dd>reset width to full (100%)</dd>
11448 </dl>
11449
11450 <h4>Using the scroll wheel/touch scroll</h4>
11451
11452 <p>
11453   When the pointer is within a stereo panner user interface, the scroll
11454   wheel may be used as follows:
11455 </p>
11456
11457 <dl>
11458   <dt><kbd class="mouse">&lArr;</kbd> / <kbd class="mod1 mouse">&lArr;</kbd></dt>
11459   <dd>increase width by 1&deg; / 5&deg;</dd>
11460   <dt><kbd class="mouse">&rArr;</kbd> / <kbd class="mod1 mouse">&rArr;</kbd></dt>
11461   <dd>decrease width by 1&deg; / 5&deg;</dd>
11462   <dt><kbd class="mouse">&uArr;</kbd> / <kbd class="mod1 mouse">&uArr;</kbd></dt>
11463   <dd>move position 1&deg; / 5&deg; to the left</dd>
11464   <dt><kbd class="mouse">&dArr;</kbd> / <kbd class="mod1 mouse">&dArr;</kbd></dt>
11465   <dd>move position 1&deg; / 5&deg;to the right</dd>
11466 </dl>
11467
11468 <h2><a name="caveat"></a>Stereo panning caveats</h2>
11469
11470 <p class="warning">
11471   The stereo panner will introduce unwanted side effects on
11472   material that includes a time difference between the channels, such
11473   as A/B, ORTF or NOS microphone recordings, or delay-panned mixes.<br />
11474   When you reduce the width, you are effectively summing two highly
11475   correlated signals with a delay, which will cause <dfn>comb filtering</dfn>.
11476 </p>
11477
11478 <p>
11479   Let's take a closer look at what happens when you record a source at 45° to the
11480   right side with an ORTF stereo microphone array and then manipulate the width.
11481 </p>
11482
11483 <p>
11484   For testing, we apply a <dfn>pink noise</dfn> signal to both inputs of an Ardour stereo
11485   bus with the stereo panner, and feed the bus output to a two-channel analyser.
11486   Since pink noise contains equal energy per octave, the expected readout is a
11487   straight line, which would indicate that our signal chain does not color the
11488   sound:
11489 </p>
11490
11491 <img src="/images/stereo-panner-with-ORTF-fullwidth.png" />
11492
11493 <p>
11494   To simulate an ORTF, we use Robin Gareus' stereo balance
11495   control LV2 to set the level difference and time delay. Ignore the Trim/Gain&mdash;its purpose is just to align the test signal with the 0dB line of the
11496   analyser.
11497 </p>
11498
11499 <p>
11500   Recall that an <dfn>ORTF</dfn> microphone pair consists of two cardioids
11501   spaced 17&nbsp;cm apart, with an opening angle of 110°. For a far source at
11502   45° to the right, the time difference between the capsules is 350&nbsp;&mu;s
11503   or approximately 15 samples at 44.1&nbsp;kHz. The level difference due to the
11504   directivity of the microphones is about 7.5&nbsp;dB (indicated by the
11505   distance between the blue and red lines in the analyser).
11506 </p>
11507
11508 <p>
11509   Now for the interesting part: if we reduce the width of the signal to 50%,
11510   the time-delayed signals will be combined in the panner. Observe what
11511   happens to the frequency response of the left and right outputs:
11512 </p>
11513
11514 <img src="/images/stereo-panner-with-ORTF-halfwidth.png" />
11515
11516 <p>
11517   You may argue that all spaced microphone recordings will undergo comb
11518   filtering later, when the two channels recombine in the air between the speakers.
11519   Perceptually however, there is a huge of difference: our hearing system is
11520   very good at eliminating comb filters in the real world, where their component
11521   signals are spatially separated. But once you combine them
11522   inside your signal chain, this spatial separation is lost and the brain will
11523   no longer be able to sort out the timbral mess. As usual, you
11524   get to keep the pieces.
11525 </p>
11526
11527 <p class="note">
11528   Depending on your material and on how much you need to manipulate the width,
11529   some degree of comb filtering may be acceptable. Then again, it may not. Listen
11530   carefully for artefacts if you manipulate unknown stereo signals&mdash;many
11531   orchestra sample libraries for example do contain time-delay components.
11532 </p>
11533
11534
11535 ---
11536 title: Plugin and Hardware Inserts
11537 part: chapter
11538 ---
11539
11540
11541 ---
11542 title: Working With Plugins
11543 part: subchapter
11544 ---
11545
11546 <p>
11547   <dfn>Plugins</dfn> are bits of software that get loaded by Ardour in order to create various audio or MIDI effects, or generate audio by functioning as "software instruments".
11548 </p>
11549
11550 <p>
11551   Ardour supports a variety of different plugin standards:
11552 </p>
11553
11554 <dl class="narrower-table">
11555   <dt><abbr title="Linux Audio Developers' Simple Plugin API">LADSPA</abbr></dt>
11556   <dd>An early, simple, lightweight plugin <abbr title="Application
11557   Programming Interface">API</abbr>, audio effects only,
11558   plugins have no editors/GUI of their own (Ardour provides one, however).</dd>
11559   <dt><abbr title="LADSPA Version 2">LV2</abbr></dt>
11560   <dd>An extensible, full-featured plugin API, audio and <abbr
11561   title="Musical Instrument Digital Interface">MIDI</abbr>, plugins can provide their
11562   own  <abbr title="Graphical User Interface">GUI</abbr>s; the successor to LADSPA</dd>
11563   <dt><abbr title="Audio Unit">AU</abbr></dt>
11564   <dd>OS X only, full featured, audio and MIDI, plugins can provide their own GUI</dd>
11565
11566   <dt><abbr title="Virtual Studio Technology">VST</abbr></dt>
11567   <dd>Plugins using Steinberg's VST plugin standard. Varies by platform:
11568     <dl>
11569     <dt>on Linux</dt><dd>(native) Linux VST plugins fully supported (VST2.4)</dd>
11570     <dt>on Windows</dt><dd>(native) Windows VST plugins fully supported (VST2.4)</dd>
11571     <dt>on OS X</dt><dd>Not supported, unless you use a VST-to-AU
11572     bridge plugin. Similar to Apple's Logic DAW.</dd>
11573   </dl>
11574   </dd>
11575
11576   <dt>Windows VST Plugins on Linux</dt>
11577   <dd>VST plugins for Windows, but being used on Linux. <strong>Normally not supported.</strong> See <a href="/working-with-plugins/windows-vst-support">Windows VST Plugins on Linux</a> for details.
11578   </dd>
11579 </dl>
11580
11581 ---
11582 title: Processor Box
11583 part: subchapter
11584 ---
11585
11586 <p><img class="right" src="/images/processor-box.png" alt="the Processor Box" /></p>
11587
11588 <p>
11589   In Ardour terminology, a <dfn>processor</dfn> is anything which treats the signal in some way and gets plugged into a mixer strip. Ardour provides several builtin processors such as the fader or panners. Processors can also be <dfn>plugins</dfn> used for effects or as instruments, as well as sends or inserts which affect <a href="/signal-routing">signal routing</a>.
11590 </p>
11591
11592 <p>
11593   The arrangement of processors is arbitrary, and there is no limit to how
11594   many there can be. The Processor Box will automagically add a scrollbar to
11595   itself if there are more processors in it than can be shown in the given space.
11596 </p>
11597
11598 <p>
11599   The main box in the top half of a mixer strip shows the <dfn>processor
11600   box</dfn>. Processors are shown as colored rectangles, with a small "LED" beside
11601   them that lights up when the processor is enabled. The color of the
11602   processor depends on its location in the sequence; processors that are <dfn>pre-fader</dfn> are colored in red, and <dfn>post-fader</dfn> processors are colored green (in the default theme).
11603 </p>
11604
11605 <p>
11606   The <dfn>processor box</dfn> will always contain a blue <dfn>Fader</dfn> processor. This indicates where in the processor chain the main channel fader is located; this is the fader shown in the lower half of the strip. It can be enabled and disabled like any other processor.
11607 </p>
11608
11609 <h2>Adding Processors</h2>
11610 <p>
11611   Processors can be added to the chain by <kbd class="mouse">Right</kbd>-clicking in the processor list, This does three things:
11612 </p>
11613
11614 <ul>
11615   <li>A gap is opened up to indicate the location of the click. The gap shows where any new processors will be inserted.</li>
11616   <li>The processor under the click is selected.</li>
11617   <li>An options menu is presented.</li>
11618 </ul>
11619
11620 <p>
11621   From the menu, new processors can be inserted.
11622 </p>
11623
11624 <p>
11625   Processors can also be dragged and dropped from the <a href="/working-with-plugins/plugin-sidebar/"><dfn>Favorite Plugins</dfn> window</a> to an appropriate spot in the Processor Box.
11626 </p>
11627
11628 <p class="note">
11629   The <dfn>Favorite Plugins</dfn> window can be populated via the <a href="/working-with-plugins/plugin-manager/">Plugin Manager</a>, or by dragging and dropping an existing processor from the <dfn>processor box</dfn> to the <dfn>Favorite Plugins</dfn> window.
11630 </p>
11631
11632 <h2>To Reorder (Move) Processors</h2>
11633 <p>
11634   Processors can be re-ordered using drag &amp; drop. Dragging a processor
11635   allows it to be moved around within the chain, or copied to another
11636   processor list on another track or bus.
11637 </p>
11638
11639 <h2>To Enable/Disable a Processor</h2>
11640
11641 <p><img class="right" src="/images/processor.png" alt="a typical processor" /></p>
11642
11643 <p>
11644   To the left of the name of each processor is a small LED symbol; if this
11645   is lit-up, the processor is active. Clicking on it will deactivate the
11646   processor and effectively bypass it.
11647 </p>
11648
11649 <p class="note">
11650   Some processors have their own bypass controls that are independent of the one that Ardour provides; this can make it appear that the plugin is non-responsive when its independent bypass control is active.
11651 </p>
11652
11653 <h2>Selecting Processors</h2>
11654 <p>
11655   A processor in the <dfn>processor box</dfn> can be selected with a <kbd class="mouse">Left</kbd>-click on it; it will be highlighed in red. Other processors can be selected at the same time by <kbd class="mouse">Left</kbd>-clicking on them while holding down the <kbd class="mod1">&zwnj;</kbd> key, and ranges can be selected by <kbd class="mouse">Left</kbd>-clicking on them while holding down the <kbd>Shift</kbd> key
11656 </p>
11657
11658 <h2>Removing Processors</h2>
11659 <p>
11660   Context-click on the processor to be removed, and select <kbd
11661   class="menu">Delete</kbd>; or <kbd class="mod3 mouse">Right</kbd>-click on it; or <kbd class="mouse">Left</kbd>-click on it and press the <kbd>Delete</kbd> key. If multiple processors are selected, they will all be deleted at the same time.
11662 </p>
11663
11664 ---
11665 title: Plugin Manager
11666 part: subchapter
11667 ---
11668
11669 <p class="fixme">This needs updating; it was written for v3 or v4, and it's out of date</p>
11670
11671 <p>
11672   The <dfn>Plugin Manager</dfn> serves two purposes. Primarily it is used to control the display status of plugins. It can also be used to find and insert plugins into the <a href="/working-with-plugins/processor-box/">Processor Box</a>. It is displayed either by a double-click in the <dfn>Processor Box</dfn> or by choosing <kbd class="menu">New Plugin &gt; Plugin Manager...</kbd> from the <dfn>Processor Box</dfn> context menu.
11673 </p>
11674
11675 <p class="center"><img src="/images/plugin-manager.png" alt="Plugin Manager window"/></p>
11676
11677 <p>
11678   Displayed for each plugin is the status (normal, favorite, hidden),
11679   name, type, category, creator (author), and the number of audio and MIDI
11680   connections. The plugins can be sorted by clicking on a column header.
11681 </p>
11682
11683 <h2>Plugin Display Status</h2>
11684
11685 <p>
11686   Click on a Fav(orite) or Hide radio button to change a plugin's display status. Clicking on an already selected radio button will cancel it, returning the plugin to the normal display status. Plugins marked as a favorite show up in the <dfn>Processor Box</dfn> context menu under <kbd class="menu">New Plugin &gt; Favorites</kbd> and in <dfn>Favorite Plugins</dfn> pane in the Mixer window. Setting the hide radio button on a plugin will keep the plugin from showing in the <dfn>Processor Box</dfn> context menus <kbd class="menu">New Plugin &gt; By Creator</kbd> or <kbd class="menu">New Plugin &gt; By Category</kbd>.
11687 </p>
11688
11689 <h2>Filtering Listed Plugins</h2>
11690
11691 <p>
11692   The middle of the <dfn>Plugin Manager</dfn> is used to filter the listed plugins. Typing into the text-box will filter the plugins based on the filter mode selected by drop-down box. Clicking <kbd class="button">Clear</kbd> empties the text-box.
11693 </p>
11694
11695 <h2>Inserting Plugins in the Processor Box</h2>
11696
11697 <p>
11698   The bottom half of the plugin manager shows plugins that have been selected
11699   for insertion into the <dfn>Processor Box</dfn>. A plugin can be added by
11700   either double clicking the plugin entry in the top half, or, if already
11701   selected in top half, by clicking <kbd class="button">Add</kbd>.
11702 <p>
11703
11704 <p>
11705   Plugins can be removed from the bottom half with a double click, or, if
11706   already selected, by clicking <kbd class="button">Remove</kbd>.
11707 </p>
11708
11709
11710 ---
11711 title: Managing Plugin Presets
11712 part: subchapter
11713 ---
11714
11715 <p class="fixme">Add images</p>
11716
11717 <p>
11718   All plugin control widgets, whether they are created by Ardour or
11719   by the plugin, have a common set of controls at the top of the window.
11720   These include 4 controls for managing <dfn>plugin presets</dfn>.
11721 </p>
11722
11723 <h2>What Is a Plugin Preset?</h2>
11724
11725 <p>
11726   A <dfn>preset</dfn> for a plugin is simply a saved set of values for
11727   all of a plugin's parameters. If you load a preset, you are restoring
11728   all the parameters of that plugin to the values stored in the preset.
11729   This is an easy, fast way to manage your preferred settings for
11730   particular plugins.
11731 </p>
11732
11733 <h2>The Preset Selector</h2>
11734
11735 <p>
11736   The <dfn>preset selector</dfn> is a regular selector that can be
11737   clicked to display a list of all known presets for this plugin. This
11738   will include presets that you have created yourself, and for some
11739   plugin formats, presets that come with the plugin itself.
11740 </p>
11741
11742 <h2>Load a New Preset</h2>
11743
11744 <p>
11745   Click on the preset selector to pop up a menu showing the names of
11746   all available presets. Click on the name of the preset you wish to load.
11747   The preset will be loaded&mdash;you may see various controls in the
11748   plugin editor change to reflect the new value of some or all parameters.
11749 </p>
11750
11751 <h2>Create a Preset</h2>
11752
11753 <p>
11754   To save the current plugin settings as a new preset, click on the
11755   <kbd class="menu">Add</kbd> button at the top of the window. A dialog
11756   will appear to ask for the name of the preset.
11757 </p>
11758
11759 <h2>Save a Preset</h2>
11760
11761 <p>
11762   If you wish to modify the settings in an existing preset, first use
11763   the preset selector to load the preset, then adjust the settings as
11764   you wish. When done, click the <kbd class="menu">Save</kbd> button
11765   and the new values will be stored, overwriting the previous version
11766   of this preset.
11767 </p>
11768
11769 <h2>Delete a preset</h2>
11770
11771 <p>
11772   To delete an existing preset, use the preset selector to load the preset.
11773   Click the <kbd class="menu">Delete</kbd> button, and the preset will be
11774   removed. The preset selector turn blank, showing that no preset is
11775   currently loaded (although the settings will stay as they were).
11776 </p>
11777
11778 ---
11779 title: Working with Ardour-built Plugin Editors
11780 part: subchapter
11781 ---
11782
11783 <p class="fixme">This section needs expansion, and at least one image</p>
11784
11785 <p>
11786   To view a plugin editor, double-click on the plugin within the
11787   <a href="/working-with-plugins/processor-box">processor box</a>.
11788   A new window will appear showing the editor/GUI for the plugin.
11789 </p>
11790
11791 <p>
11792   If a plugin does not have its own GUI, Ardour will construct a
11793   <dfn>generic plugin editor</dfn> from a small set of common control
11794   elements. Ardour will do this even for plugins that have their
11795   own, if <kbd class="menu">Edit &gt; Preferences &gt;
11796   GUI &gt; Use Plugins' own interface instead of Ardour's</kbd> is disabled.
11797 </p>
11798
11799 <p>
11800   The generic UI can be temporarily switched to by context-clicking on
11801   a processor and selecting <kbd
11802   class="menu">Edit with generic controls</kbd>. This will be necessary to
11803   access the <a href="/automation">plugin automation controls</a>.
11804 </p>
11805
11806 <p>
11807   In the generic UI, any controller can be reset to its default by
11808   <kbd class="mod3 mouse">Left</kbd>-clicking on it.
11809 </p>
11810
11811 ---
11812 title: Plugins Bundled With Ardour
11813 part: subchapter
11814 ---
11815
11816 <p>
11817   Ardour now comes with the following plugins as part of a standard installation:
11818 </p>
11819
11820 <dl class="narrower-table">
11821   <dt>a-Amplifier</dt>
11822   <dd>A versatile &plusmn;20dB multichannel amplifier</dd>
11823   <dt>a-Compressor</dt>
11824   <dd>A side-chain enabled compressor with the usual controls. Comes in stereo and mono versions</dd>
11825   <dt>a-Delay</dt>
11826   <dd>A basic single-tap delay line, with tempo sync</dd>
11827   <dt>a-EQ</dt>
11828   <dd>A nice sounding 4-band parametric EQ with shelves</dd>
11829   <dt>a-Fluid Synth</dt>
11830   <dd>Wraps the Fluidsynth SoundFont2 synthesis engine as a new sample player</dd>
11831   <dt>a-High/Low Pass Filter</dt>
11832   <dd>Independent high and low pass filters with steepness up to 48dB/octave</dd>
11833   <dt>a-Inline Scope</dt>
11834   <dd>A mixer strip inline waveform display</dd>
11835   <dt>a-Inline Spectrogram</dt>
11836   <dd>A mixer strip inline specturm display</dd>
11837   <dt>a-MIDI Monitor</dt>
11838   <dd>A mixer strip inline display to show recent <abbr title="Musical Instrument Digital Interface">MIDI</abbr> events</dd>
11839   <dt>a-Reverb</dt>
11840   <dd>A reverb that finds a balance between sounding good, using a lot of CPU and having too many controls</dd>
11841 </dl>
11842
11843 ---
11844 title: Getting More Plugins
11845 part: subchapter
11846 ---
11847
11848 <p>
11849   The following list shows <dfn>plugin packages</dfn>. In some cases, a package contains just one or two plugins; in other cases, dozens.
11850 </p>
11851
11852 <h2>Plugins by Standard</h2>
11853
11854 <h3 id="LADSPA">LADSPA</h3>
11855
11856 <ul>
11857   <li>AMB <a href="http://kokkinizita.linuxaudio.org/linuxaudio/">http://kokkinizita.linuxaudio.org/linuxaudio/</a></li>
11858   <li>Blepvco <a href="http://smbolton.com/linux.html">http://smbolton.com/linux.html</a></li>
11859   <li>Blop <a href="http://blop.sourceforge.net">http://blop.sourceforge.net</a></li>
11860   <li>CAPS <a href="http://quitte.de/dsp/caps.html">http://quitte.de/dsp/caps.html</a></li>
11861   <li>CMT <a href="http://www.ladspa.org/cmt/">http://www.ladspa.org/cmt/</a></li>
11862   <li>FIL <a href="http://kokkinizita.linuxaudio.org/linuxaudio/">http://kokkinizita.linuxaudio.org/linuxaudio/</a></li>
11863   <li>FOO <a href="http://code.google.com/p/foo-plugins/">http://code.google.com/p/foo-plugins/</a></li>
11864   <li>MCP <a href="http://kokkinizita.linuxaudio.org/linuxaudio/">http://kokkinizita.linuxaudio.org/linuxaudio/</a></li>
11865   <li>NJL <a href="https://github.com/tialaramex/njl-plugins">https://github.com/tialaramex/njl-plugins</a></li>
11866   <li>Omins <a href="http://www.nongnu.org/om-synth/omins.html">http://www.nongnu.org/om-synth/omins.html</a></li>
11867   <li>REV <a href="http://kokkinizita.linuxaudio.org/linuxaudio/">http://kokkinizita.linuxaudio.org/linuxaudio/</a></li>
11868   <li>SWH <a href="http://plugin.org.uk/">http://plugin.org.uk/</a></li>
11869   <li>TAP <a href="http://tap-plugins.sourceforge.net/">http://tap-plugins.sourceforge.net/</a></li>
11870   <li>VCF <a href="http://users.suse.com/~mana/ladspa.html">http://users.suse.com/~mana/ladspa.html</a></li>
11871   <li>VCO <a href="http://kokkinizita.linuxaudio.org/linuxaudio/">http://kokkinizita.linuxaudio.org/linuxaudio/</a></li>
11872   <li>VLevel <a href="http://vlevel.sourceforge.net/about/">http://vlevel.sourceforge.net/about/</a></li>
11873   <li>Vocoder <a href="http://www.sirlab.de/linux/download_vocoder.html">http://www.sirlab.de/linux/download_vocoder.html</a></li>
11874   <li>WASP <a href="http://linux01.gwdg.de/~nlissne/wasp/index.html">http://linux01.gwdg.de/~nlissne/wasp/index.html</a> (mar wanted!)</li>
11875   <li>Nova <a href="http://klingt.org/~tim/nova-filters/">http://klingt.org/~tim/nova-filters/</a></li>
11876   <li>Calf <a href="http://calf.sourceforge.net/">http://calf.sourceforge.net/</a></li>
11877   <li>Socal’s LEET Plugins <a href="http://code.google.com/p/leetplugins/">http://code.google.com/p/leetplugins/</a></li>
11878   <!--<li>Holap synthesizer and DSP effects <a href="http://holap.berlios.de/">http://holap.berlios.de/</a></li>-->
11879 </ul>
11880
11881 <h3 id="LV2">LV2</h3>
11882
11883 <ul>
11884   <li>SWH <a href="http://plugin.org.uk/lv2/">http://plugin.org.uk/lv2/</a></li>
11885   <li>ll-plugins <a href="http://ll-plugins.nongnu.org/">http://ll-plugins.nongnu.org/</a></li>
11886   <li>zynadd <a href="http://home.gna.org/zyn/">http://home.gna.org/zyn/</a></li>
11887   <li>Calf <a href="http://calf.sourceforge.net/">http://calf.sourceforge.net/</a></li>
11888   <li>LinuxDSP <a href="http://www.overtonedsp.co.uk/download/linuxdsp-archive/">http://www.overtonedsp.co.uk/download/linuxdsp-archive/</a></li>
11889   <li>Invada Studio <a href="https://launchpad.net/invada-studio/">https://launchpad.net/invada-studio/</a></li>
11890 </ul>
11891
11892 <h3 id="LinuxVST">Linux VST (LXVST)</h3>
11893
11894 <ul>
11895   <li>Loomer <a href="http://www.loomer.co.uk/">http://www.loomer.co.uk/</a></li>
11896   <li>Distrho <a href="http://distrho.sourceforge.net/ports.php">http://distrho.sourceforge.net/ports.php</a></li>
11897   <li>Argotlunar <a href="http://argotlunar.info/">http://argotlunar.info/</a></li>
11898 </ul>
11899
11900 <h2>How do I install plugins?</h2>
11901
11902 <h3>Linux</h3>
11903
11904 <p>
11905   <dfn>Installation</dfn> will vary a little depending on how you get plugins.  If your repository has a particular plugin package, just install it using the normal software package management tool for your system. Most Linux distributions that are good for audio work will have most of the LADSPA and LV2 plugins mentioned above available in ready-to-use forms.
11906 </p>
11907
11908 <p>
11909   Finding them will typically require <em>searching</em> your distribution's repository to find the name of the package. The tools for doing this vary from distribution to distribution. A good place to start searching is with the name of the package (e.g. "caps" or "calf"). There are no fixed rules about what different Linux distributions call their packages for a given set of plugins.
11910 </p>
11911
11912 <p>
11913   If the package isn't available, then you can build the plugins from source (plugins are generally fairly easy to compile if you've ever done this sort of thing before).
11914 </p>
11915
11916 <p>
11917   LADSPA plugins are shared library files. They need to be installed in either /usr/lib/ladspa, /usr/local/lib/ladspa or in a directory mentioned in your LADSPA_PATH environment variable.
11918 </p>
11919
11920 <p>
11921   LV2 plugins are folders/directories. They need to installed in either /usr/lib/lv2, /usr/local/lib/lv2 or a directory mentioned in your LV2_PATH environment variable.
11922 </p>
11923
11924 <p>
11925   Linux VST (LXVST) plugins are distributed as shared library files. They are typically installed in /usr/lib/lxvst, /usr/local/lib/lxvst or a directory mentioned in your LXVST_PATH environment variable.
11926 </p>
11927
11928 <h3>OS X</h3>
11929
11930 <p>
11931   Unless you're a particularly technical computer user, building and installing plugins in the LV2 (or LADSPA) format is probably not something worth planning on.
11932 </p>
11933
11934 <p>
11935   Most of the plugins you are likely to use on OS X will be in Apple's AudioUnit format. These have their own installation process that tends to just work.
11936 </p>
11937
11938 ---
11939 title: Using Windows VST Plugins on Linux
11940 part: subchapter
11941 ---
11942
11943 <p>
11944   Thanks to the combined work of Torben Hohn, Kjetil Mattheusen, Paul
11945   Davis and a few other developers, it is possible to use Windows
11946   <dfn><abbr title="Virtual Studio Technology">VST</abbr>
11947   plugins</dfn> (that is, plugins in VST format built and distributed
11948   for the Windows platforms) on Ardour running on Linux. (Note: there
11949   is no VST support of any kind on OS X).
11950 </p>
11951
11952 <p>However, doing so has three <em>substantial</em> downsides:</p>
11953
11954 <ul>
11955   <li>It requires a special build of Ardour that is fundamentally
11956   very different from normal builds</li>
11957   <li>Support depends on <a href="http://winehq.org/">Wine</a>,
11958   a Windows "emulator"</li>
11959   <li>As usual with plugins, a crashing plugin will take Ardour down
11960   with it&mdash;and crashes in Windows VST plugins are more likely when
11961   used in this way</li>
11962 </ul>
11963
11964 <p>
11965   The dependence on Wine makes it almost impossible for the Ardour
11966   project to support this feature. Wine's functionality generally
11967   improves over time, but any given release of Wine may behave worse
11968   with some or all Windows VST plugins. It may even just crash Ardour
11969   completely.
11970 </p>
11971
11972 <p>
11973   Step back and think about what "using Windows VSTs" really means:
11974   taking bits of software written with only one idea in mind&mdash;running
11975   on the Windows platform&mdash;and then trying to use them on an entirely
11976   different platform. It is a bit of a miracle (largely thanks to the
11977   incredible work done by the Wine project) that it works at all. But is
11978   this the basis of a stable, reliable DAW for a non-Windows platform?
11979   Getting Ardour on Linux to pretend that its really a Windows
11980   application running on Windows?
11981 </p>
11982
11983 <p>
11984   We understand that there are many outstanding plugins available as
11985   Windows VSTs and that in many cases, no equivalent is available for
11986   Ardour's Linux-based users. If your workflow is so dependent on those
11987   plugins, then remain on Windows (or potentially consider using an
11988   actual Windows VST host running inside of Wine). If you can make the
11989   effort, you will get a better environment by using a normal build of
11990   Ardour and exploring the world of plugins built to run on Linux
11991   natively. This covers LADSPA, LV2 and Linux VST formats, and even some
11992   outstanding proprietary plugins such as those
11993   from <a href="http://www.loomer.co.uk/">Loomer</a>.
11994 </p>
11995
11996 <h2>A Plea To Plugin Manufacturers</h2>
11997
11998 <p>
11999   Please consider porting your plugins so that users can enjoy them on
12000   Linux too. Several other commercial plugin developers have already
12001   done this. You can choose between using "Linux VST" (which is what
12002   Loomer and others have done)&mdash;you will find toolkits like JUCE that
12003   help to make this fairly easy&mdash;or using LV2 format which is
12004   ultimately more flexible but probably more work. We have users&mdash;thousands of users&mdash;on Linux who would like to use your plugins.
12005 </p>
12006
12007
12008 ---
12009 title: Automation
12010 part: chapter
12011 ---
12012
12013
12014 ---
12015 title: Mixdown
12016 part: chapter
12017 ---
12018
12019
12020 ---
12021 title: Export Dialog
12022 part: subchapter
12023 ---
12024
12025 <p>
12026   When you have finished mixing your session, you probably want to export it to a sound file to burn to a CD, upload to the web, or whatever. <kbd class="menu">Session &gt; Export &gt; Export to Audio file(s)...</kbd> shows the Export Dialog to do this.
12027 </p>
12028
12029 <p>
12030   You can also export the outputs of multiple tracks &amp; busses all at once via
12031   <kbd class="menu">Session &gt; Export &gt; Stem Export...</kbd>.
12032 </p>
12033
12034 <h2>File Format</h2>
12035
12036 <img src="/images/export-dialog-file-format.png" />
12037
12038 <p>
12039   This tab contains controls for the format of the exported audio file. You can enable more than one format here, in which case each will be exported in turn. Ardour is supplied with a list of export formats, including:
12040   <ul>
12041     <li>CD (Red Book)</li>
12042     <li>DVD-A</li>
12043     <li>FLAC 24 bit </li>
12044     <li>FLAC 24 bit (tagged)</li>
12045     <li>Ogg_Vorbis</li>
12046     <li>Ogg_Vorbis (tagged)</li>
12047     <li>Ring Tone</li>
12048   </ul>
12049   You can edit these formats, or create your own, with the <a href="/exporting/edit-export-format-profile/">"Edit Export Format Profile"</a> dialog, which appears when you click the "Edit" or "New" button to the right of the drop-down list of formats.
12050 </p>
12051
12052 <p>
12053   You can also create a 'Preset' consisting of one or more formats. Ardour provides some ready-made presets, too:
12054   <ul>
12055     <li>CD + DVD-A</li>
12056     <li>CD + FLAC</li>
12057     <li>CD + FLAC (tagged)</li>
12058     <li>CD + Ogg_Vorbis + FLAC (tagged)</li>
12059     <li>CD + Ogg_Vorbis</li>
12060     <li>CD + Ogg_Vorbis (tagged)</li>
12061     <li>CD only</li>
12062     <li>DVD-A only</li>
12063     <li>FLAC</li>
12064     <li>FLAC (tagged)</li>
12065     <li>Ogg_Vorbis + FLAC</li>
12066     <li>Ogg_Vorbis + FLAC (tagged)</li>
12067     <li>Ogg_Vorbis </li>
12068     <li>Ogg_Vorbis (tagged)</li>
12069   </ul>
12070 </p>
12071
12072 <h3>Soundcloud upload</h3>
12073
12074 <p>
12075   When 'Upload to Soundcloud' is ticked on in any format's tab, a pane containing fields to enter in Soundcloud account details (email and password), and what should happen to the uploaded files will become visible.
12076 </p>
12077
12078 <img src="/images/soundcloud-upload.png" />
12079
12080 <p>
12081 <dl>
12082 <dt>Make files public</dt><dd>Choose whether to make uploaded files available to anyone via the Soundcloud web site.</dd>
12083 <dt>Open uploaded files in browser</dt><dd>Open each file on soundcloud in your browser after upload. If you don't enable this, you can still see the URLs in the <a href="">Log window</a>.</dd>
12084 <dt>Make files downloadable</dt><dd>Choose whether to allow downloading of files uploaded to Soundcloud.</dd>
12085 </dl>
12086 </p>
12087
12088 <h2>Time Span</h2>
12089
12090 <img src="/images/export-dialog-timespan.png" />
12091
12092 <p>
12093   This tab allows you to select the range (or ranges) of the timeline to export. By default, "session" is enabled&mdash;this will export the whole session from the start marker to the end marker.
12094 </p>
12095
12096
12097 <h2>Channels</h2>
12098
12099 <img src="/images/export-dialog-channels.png" />
12100
12101 <p>
12102   Here you can choose which outputs (tracks or busses) should be sent to the exported file.
12103 </p>
12104
12105 <h2>Stem Export</h2>
12106
12107 <img src="/images/export-dialog-stem-export.png" />
12108
12109 <p>
12110   If you chose 'Stem Export', the 'Channels' tab appears slightly differently:
12111   in this case each chosen channel (track or bus) is exported to its own file,
12112   instead of all channels being mixed together into a single file. You can
12113   choose to export either the region contents or the track output here in this
12114   case.
12115 </p>
12116
12117 ---
12118 title: Export Format Profiles
12119 part: subchapter
12120 ---
12121
12122 <h2>Export Format Profiles</h2>
12123
12124 <p>
12125   An Export Format Profile specifies the file format in which Ardour will export
12126   audio files, and also other audio file export options.
12127 </p>
12128
12129 <p>
12130   Export Format Profiles are edited via the 'Edit Export Format Profile' dialog.
12131 </p>
12132
12133 <img src="/images/edit-export-format-profile.png" />
12134
12135 <h3>Normalize</h3>
12136
12137 <p>
12138   If enabled, peak levels of exported files will be normalized to the level chosen here.
12139 </p>
12140
12141 <h3>Trim/Add silence at start/end</h3>
12142
12143 <p>
12144 </p>
12145
12146 <h3>Compatibility/Quality/File format/Sample rate</h3>
12147
12148 <h4>Compatibility</h4>
12149
12150 <p>
12151   Selecting an item in the 'Compatibility' column will display options in the
12152   other columns that are incompatible with that item in red.
12153 </p>
12154
12155 <h4>Quality</h4>
12156
12157 <p>
12158   The appropriate item in the 'Quality' column will be highlighted when you
12159   choose a file format. Clicking on items in the 'Quality' column currently
12160   doesn't seem to do anything useful.
12161 </p>
12162
12163 <h4>File format</h4>
12164
12165 <p>
12166   This column contains a list of Ardour's supported export file types. Click on
12167   the format you want to use.
12168 </p>
12169
12170 <h4>Sample rate</h4>
12171
12172 <p>
12173   You can explicitly choose the sample rate of your exported files here, or
12174   choose 'Session rate' to export in the current session's sample rate, without
12175   sample rate conversion.
12176 </p>
12177
12178 <h4>Sample rate conversion quality</h4>
12179
12180 <p>
12181   If your chosen sample rate does not match the current session's sample rate,
12182   choose the sample rate conversion quality here. Better quality options are
12183   slower.
12184 </p>
12185
12186 <h3>Options</h3>
12187
12188 <p>
12189   Options relevant to the chosen file format will appear here.
12190   Categories of audio file format are:
12191   <ul>
12192     <li>Linear encoding</li>
12193     <li>Broadcast Wave</li>
12194     <li>Ogg Vorbis</li>
12195     <li>FLAC</li>
12196   </ul>
12197 </p>
12198
12199 <p>
12200   Available options include a selection of the following:
12201 </p>
12202
12203 <h4>Sample Format</h4>
12204
12205 <p>
12206   Choose the bit depth of exported files.
12207 </p>
12208
12209 <h4>Dithering</h4>
12210
12211 <p>
12212   If the exported files bit depth is less than Ardour's native bit depth,
12213   choose the dithering algorithm to use.
12214 </p>
12215
12216 <h4>Create CUE file/Create TOC file</h4>
12217
12218 <p>
12219   As well as exporting an audio file, create a file (in CUE or TOC format
12220   respectively) containg CD track information, as defined in the
12221   <a href="/working-with-markers/rangesmarks-list/">Ranges &amp; Marks List</a>.
12222 </p>
12223
12224 <h4>Tag with session's metadata</h4>
12225
12226 <p>
12227   If the exported file format supports metadata, use data entered in the
12228   <a href="/working-with-sessions/metadata/">Session Metadata</a>
12229   window to tag the exported files.
12230 </p>
12231
12232 <h3>Label</h3>
12233
12234 <p>
12235   The 'Label' field lets you choose the name which will be shown for this format
12236   in the drop-down list of export formats in the 'File Formats' tab of the
12237   <a href="/exporting/export-dialog/">Export dialog</a>.
12238 </p>
12239
12240 <h3>Command to run post-export</h3>
12241
12242 <p>
12243   If this is not blank, it is considered as a command to be run after the export
12244   of each file. Either the command must exist in $PATH, or you can specify an
12245   absolute path to an executable file here.
12246 </p>
12247
12248 <p>
12249   Certain sequences are allowed here to stand for the exported file name and the
12250   like. Currently these are:
12251   <dl>
12252     <dt><code>%f</code></dt>
12253     <dd>Full path &amp; filename of the exported audio file</dd>
12254     <dt><code>%d</code></dt>
12255     <dd>Directory containing the exported audio file (including trailing directory separator)</dd>
12256     <dt><code>%b</code></dt>
12257     <dd>Basename of the exported audio file (without extension)</dd>
12258     <dt><code>%s</code></dt>
12259     <dd>Path to the current session file</dd>
12260     <dt><code>%n</code></dt>
12261     <dd>Name of the current session file</dd>
12262     <dt><code>%%</code></dt>
12263     <dd>A literal percent sign</dd>
12264   </dl>
12265 </p>
12266
12267 <p>
12268   Any part of the command-line enclosed in double-quotes (") will be used as-is.
12269 </p>
12270
12271
12272
12273
12274 ---
12275 title: Surround
12276 part: part
12277 ---
12278
12279
12280 ---
12281 title: Ardour Setup for Surround
12282 part: chapter
12283 ---
12284
12285
12286 ---
12287 title: Multichannel Tracks and Signal Routing
12288 part: chapter
12289 ---
12290
12291
12292 ---
12293 title: Surround Panning and Mixing
12294 part: chapter
12295 ---
12296
12297
12298 ---
12299 title: VBAP Panner
12300 part: subchapter
12301 ---
12302
12303 <p class="warning">
12304   Ardour's VBAP panner is currently in development, and its semantics may
12305   change in the near future, possibly affecting your mixes. Please do not
12306   rely on it for important production work while the dust settles.
12307 </p>
12308
12309 <p>
12310   <dfn><abbr title="Vector-base Amplitude Panning">VBAP</abbr></dfn>
12311   is a versatile and straightforward method to pan a source around over an
12312   arbitrary number of speakers on a horizontal polygon or a 3D surface,
12313   even if the speaker layout is highly irregular.
12314 </p>
12315
12316 <h2>Basic concepts</h2>
12317
12318 <p>
12319   VBAP was developed by Ville Pulkki at Aalto University, Helsinki, in 2001.
12320   It works by distributing the signal to the speakers nearest to the desired
12321   direction with appropriate weightings, aiming to create a maximally sharp
12322   phantom source by using as few speakers as possible:
12323 </p>
12324
12325 <ul>
12326   <li>one speaker, if the desired direction coincides with a speaker
12327   location,</li>
12328   <li>two speakers, if the desired direction is on the line between two
12329   speakers,</li>
12330   <li>and three speakers in the general 3D case.</li>
12331 </ul>
12332
12333 <p>
12334   Thus, if you move the panner onto a speaker, you can be sure that only
12335   this speaker will get any signal. This is handy when you need precise
12336   1:1 routing.
12337 </p>
12338
12339 <p>
12340   The drawback of VBAP is that a moving source will constantly change its
12341   apparent sharpness, as it transitions between the three states mentioned
12342   above.
12343 </p>
12344
12345 <p>
12346   A <dfn>horizontal</dfn> VBAP panner has one parameter, the <dfn>azimuth
12347   angle</dfn>. A <dfn>full-sphere</dfn> panner offers an additional
12348   <dfn>elevation angle</dfn> control.
12349 </p>
12350
12351 <p class="note">
12352   More elaborate implementations of VBAP also include a
12353   <dfn>spread</dfn> parameter, which  will distribute the signal over a
12354   greater number of speakers in order to maintain constant (but no longer
12355   maximal) sharpness, regardless of position. Ardour's VBAP panner does not
12356   currently include this feature.
12357 </p>
12358
12359 <h2>Speaker layout</h2>
12360
12361 <p>
12362   Each VBAP panner is specific to its <dfn>speaker layout</dfn>&mdash;the panner has to "know" about the precise location of all the speakers. A complete VBAP implementation must therefore include the possibility to define this layout.
12363 </p>
12364
12365 <img src="/images/VBAP-panner-5.png" class="small right" alt="The VBAP
12366 panner with 5 outputs"/>
12367
12368 <p>
12369   Ardour currently uses a simplified approach: if a track or bus has more
12370   than two output channels (which implies stereo), it assumes that you
12371   have N speakers distributed in a regular N-gon. That means that for
12372   irregular layouts such as 5.1 or 7.1, the direction you dial in will
12373   differ a bit from the actual auditory result, but you can still achieve
12374   any desired spatialisation.
12375 </p>
12376
12377 <h3>Experimental 3D VBAP</h3>
12378
12379 <img src="/images/VBAP-panner-10.png" class="small right" alt="The VBAP
12380 panner with 10 outputs, in experimental 3D mode"/>
12381
12382 <p>
12383   For tracks with 10 outputs, Ardour will currently assume a 3-dimensional
12384   speaker layout corresponding to Auro-3D 10.1, which is a horizontal 5.1
12385   system, four elevated speakers above L, R, Ls, and Rs, and an additional
12386   "voice-of-god" speaker at the zenith.
12387 </p>
12388
12389 <h2>N:M panning</h2>
12390
12391 <img src="/images/VBAP-panner-4in5.png" class="small right" alt="The VBAP
12392 panner in 4 in, 5 out mode"/>
12393
12394 <p>
12395   For tracks and busses with more than one input, Ardour will (for now) assume that
12396   you wish to distribute the inputs symmetrically along the latitude around
12397   the panner direction. The width parameter controls the opening angle of
12398   the distribution sector.
12399 </p>
12400
12401
12402
12403
12404 ---
12405 title: Sync & Video
12406 part: part
12407 ---
12408
12409
12410 ---
12411 title: Working with Synchronization
12412 part: chapter
12413 ---
12414
12415
12416 ---
12417 title: On Clock and Time
12418 part: subchapter
12419 ---
12420
12421 <p>
12422   <dfn>Synchronization</dfn> in multimedia involves two concepts which are
12423   often confused: <dfn>clock</dfn> (or speed) and <dfn>time</dfn> (location
12424   in time).
12425 </p>
12426
12427 <p>
12428   A <dfn>clock</dfn> determines the speet at which one or more systems
12429   operate. In the audio world this is generally referred to as <a href="http://en.wikipedia.org/wiki/Word_clock" title="http://en.wikipedia.org/wiki/Word_clock">Word Clock</a>. It does not carry any absolute reference to a point in time: A clock is used to keep a system's sample rate regular and accurate. Word clock is usually at the frequency of the sample rate&mdash;at 48&nbsp;kHz, its period is about 20&nbsp;μs. Word Clock is the most common sample rate based clock but other clocks do exist such as Black and Burst, Tri-Level and DARS. Sample rates can be derived from these clocks as well.
12430 </p>
12431
12432 <p>
12433   Time or <dfn>timecode</dfn> specifies an absolute  position on a timeline,
12434   such as <code>01:02:03:04</code> (expressed as Hours:Mins:Secs:Frames). It is
12435   actual <em>data</em> and not a clock <em>signal</em> per se.
12436   The granularity of timecode is <dfn>Video Frames</dfn> and is an order of
12437   magnitude lower than, say, Word Clock which is counted in
12438   <dfn>samples</dfn>. A typical frame rate is 25&nbsp;<abbr title="frames
12439   per second">fps</abbr> with a period of
12440   40&nbsp;ms.
12441   In the case of 48&nbsp;kHz and 25&nbsp;fps, there are 1,920 audio samples
12442   per video frame.
12443 </p>
12444
12445 <p>
12446   The concepts of clock and timecode are reflected in JACK and Ardour:
12447 </p>
12448
12449 <p>
12450   JACK provides clock synchronization and is not concerned with time code
12451   (this is not entirely true, more on jack-transport later).
12452   On the software side, jackd provides sample-accurate synchronization
12453   between all JACK applications.
12454   On the hardware side, JACK uses the clock of the audio-interface.
12455   Synchronization of multiple interfaces requires hardware support to sync
12456   the clocks.
12457   If two interfaces run at different clocks the only way to align the
12458   signals is via re-sampling (SRC&mdash;Sample Rate Conversion), which is
12459   expensive in terms of CPU usage and may decreases fidelity if done
12460   incorrectly.
12461 </p>
12462
12463 <p>
12464   Timecode is used to align systems already synchronized by a clock to
12465   a common point in time, this is application specific and various
12466   standards and methods exist to do this.
12467 </p>
12468
12469 <p class="note">
12470   To make things confusing, there are possibilities to synchronize clocks
12471   using timecode. e.g. using mechanism called <dfn>jam-sync</dfn> and a
12472   <dfn>phase-locked loop</dfn>.
12473 </p>
12474
12475 <p>
12476   An interesting point to note is that LTC (Linear Time Code) is a
12477   Manchester encoded, frequency modulated signal that carries both
12478   clock and time. It is possible to extract absolute position data
12479   and speed from it.
12480 </p>
12481
12482 ---
12483 title: Latency and Latency-Compensation
12484 menu_title: Latency
12485 part: subchapter
12486 ---
12487
12488 <p>
12489   <a
12490   href="http://en.wikipedia.org/wiki/Latency_%28audio%29"><dfn>Latency</dfn></a>
12491   is a system's reaction time to a given stimulus. There are many factors that
12492   contribute to the total latency of a system. In order to achieve exact time
12493   synchronization all sources of latency need to be taken into account and
12494   compensated for.
12495 </p>
12496
12497 <h2>Sources of Latency</h2>
12498
12499 <h3>Sound propagation through the air</h3>
12500
12501 <p>
12502   Since sound is a mechanical perturbation in a fluid, it travels at
12503   comparatively slow <a href="http://en.wikipedia.org/wiki/Speed_of_sound">speed</a>
12504   of about 340 m/s. As a consequence, your acoustic guitar or piano has a
12505   latency of about 1&ndash;2 ms, due to the propagation time of the sound
12506   between your instrument and your ear.
12507 </p>
12508
12509 <h3>Digital-to-Analog and Analog-to-Digital conversion</h3>
12510
12511 <p>
12512   Electric signals travel quite fast (on the order of the speed of light),
12513   so their propagation time is negligible in this context. But the conversions
12514   between the analog and digital domain take a comparatively long time to perform,
12515   so their contribution to the total latency may be considerable on
12516   otherwise very low-latency systems. Conversion delay is usually below 1&nbsp;ms.
12517 </p>
12518
12519 <h3>Digital Signal Processing</h3>
12520
12521 <p>
12522   Digital processors tend to process audio in chunks, and the size of that chunk
12523   depends on the needs of the algorithm and performance/cost considerations.
12524   This is usually the main cause of latency when you use a computer and one you
12525   can try to predict and optimize.
12526 </p>
12527
12528 <h3>Computer I/O Architecture</h3>
12529
12530 <p>
12531   A computer is a general purpose processor, not a digital audio processor.
12532   This means our audio data has to jump a lot of fences in its path from the
12533   outside to the CPU and back, contending in the process with some other parts
12534   of the system vying for the same resources (CPU time, bus bandwidth, etc.)
12535 </p>
12536
12537 <h2>The Latency chain</h2>
12538
12539 <img src="/images/latency-chain.png"  title="Latency chain" alt="Latency chain" />
12540
12541 <p>
12542   <em>Figure: Latency chain.</em>
12543   The numbers are an example for a typical PC. With professional gear and an
12544   optimized system the total roundtrip latency is usually lower. The important
12545   point is that latency is always additive and a sum of many independent factors.
12546 </p>
12547
12548 <p>
12549   Processing latency is usually divided into <dfn>capture latency</dfn> (the time
12550   it takes for the digitized audio to be available for digital processing, usually
12551   one audio period), and <dfn>playback latency</dfn> (the time it takes for
12552   In practice, the combination of both matters. It is called <dfn>roundtrip
12553   latency</dfn>: the time necessary for a certain audio event to be captured,
12554   processed and played back.
12555 </p>
12556
12557 <p class="note">
12558   It is important to note that processing latency in a jackd is a matter of
12559   choice. It can be lowered within the limits imposed by the hardware (audio
12560   device, CPU and bus speed) and audio driver. Lower latencies increase the
12561   load on the system because it needs to process the audio in smaller chunks
12562   which arrive much more frequently. The lower the latency, the more likely
12563   the system will fail to meet its processing deadline and the dreaded
12564   <dfn>xrun</dfn> (short for buffer over- or under-run) will make its
12565   appearance more often, leaving its merry trail of clicks, pops and crackles.
12566 </p>
12567
12568 <p>
12569   The digital I/O latency is usually negligible for integrated or
12570   <abbr title="Periphal Component Interface">PCI</abbr> audio devices, but
12571   for USB or FireWire interfaces the bus clocking and buffering can add some
12572   milliseconds.
12573 </p>
12574
12575
12576 <h2>Low Latency usecases</h2>
12577
12578 <p>
12579   Low latency is <strong>not</strong> always a feature you want to have. It
12580   comes with a couple of drawbacks: the most prominent is increased power
12581   consumption because the CPU needs to process many small chunks of audio data,
12582   it is constantly active and can not enter power-saving mode (think fan-noise).
12583   Since each application that is part of the signal chain must run in every
12584   audio cycle, low-latency systems will undergo<dfn>context switches</dfn>
12585   between applications more often, which incur a significant overhead.
12586   This results in a much higher system load and an increased chance of xruns.
12587 </p>
12588
12589 <p>
12590   For a few applications, low latency is critical:
12591 </p>
12592
12593 <h3>Playing virtual instruments</h3>
12594
12595 <p>
12596   A large delay between the pressing of the keys and the sound the instrument
12597   produces will throw-off the timing of most instrumentalists (save church
12598   organists, whom we believe to be awesome latency-compensation organic systems.)
12599 </p>
12600
12601 <h3>Software audio monitoring</h3>
12602
12603 <p>
12604   If a singer is hearing her own voice through two different paths, her head
12605   bones and headphones, even small latencies can be very disturbing and
12606   manifest as a tinny, irritating sound.
12607 </p>
12608
12609 <h3>Live effects</h3>
12610
12611 <p>
12612   Low latency is important when using the computer as an effect rack for
12613   inline effects such as compression or EQ. For reverbs, slightly higher
12614   latency might be tolerable, if the direct sound is not routed through the
12615   computer.
12616 </p>
12617
12618 <h3>Live mixing</h3>
12619
12620 <p>
12621   Some sound engineers use a computer for mixing live performances.
12622   Basically that is a combination of the above: monitoring on stage,
12623   effects processing and EQ.
12624 </p>
12625
12626 <p>
12627   In many other cases, such as playback, recording, overdubbing, mixing,
12628   mastering, etc. latency is not important, since it can easily be
12629   compensated for.<br />
12630   To explain that statement: During mixing or mastering you don&#039;t care
12631   if it takes 10ms or 100ms between the instant you press the play button
12632   and sound coming from the speaker. The same is true when recording with a count in.
12633 </p>
12634
12635 <h2>Latency compensation</h2>
12636
12637 <p>
12638   During tracking it is important that the sound that is currently being
12639   played back is internally aligned with the sound that is being recorded.
12640 </p>
12641
12642 <p>
12643   This is where latency-compensation comes into play. There are two ways to
12644   compensate for latency in a DAW, <dfn>read-ahead</dfn> and
12645   <dfn>write-behind</dfn>. The DAW starts playing a bit early (relative to
12646   the playhead), so that when the sound arrives at the speakers a short time
12647   later, it is exactly aligned with the material that is being recorded.
12648   Since we know that play-back has latency, the incoming audio can be delayed
12649   by the same amount to line things up again.
12650 </p>
12651
12652 <p>
12653   As you may see, the second approach is prone to various implementation
12654   issues regarding timecode and transport synchronization. Ardour uses read-ahead
12655   to compensate for latency. The time displayed in the Ardour clock corresponds
12656   to the audio-signal that you hear on the speakers (and is not where Ardour
12657   reads files from disk).
12658 </p>
12659
12660 <p>
12661   As a side note, this is also one of the reasons why many projects start at
12662   timecode <samp>01:00:00:00</samp>. When compensating for output latency the
12663   DAW will need to read data from before the start of the session, so that the
12664   audio arrives in time at the output when the timecode hits <samp>01:00:00:00</samp>.
12665   Ardour3 does handle the case of <samp>00:00:00:00</samp> properly but not all
12666   systems/software/hardware that you may inter-operate with may behave the same.
12667 </p>
12668
12669 <h2>Latency Compensation And Clock Sync</h2>
12670
12671 <p>
12672   To achieve sample accurate timecode synchronization, the latency introduced
12673   by the audio setup needs to be known and compensated for.
12674 </p>
12675
12676 <p>
12677   In order to compensate for latency, JACK or JACK applications need to know
12678   exactly how long a certain signal needs to be read-ahead or delayed:
12679 </p>
12680
12681 <img src="/images/jack-latency-excerpt.png"  title="Jack Latency Compensation" alt="Jack Latency Compensation" />
12682
12683 <p>
12684   <em>Figure: Jack Latency Compensation.</em>
12685 </p>
12686
12687 <p>
12688   In the figure above, clients A and B need to be able to answer the following
12689   two questions:
12690 </p>
12691
12692 <ul>
12693   <li>
12694     How long has it been since the data read from port Ai or Bi arrived at the
12695     edge of the JACK graph (capture)?
12696   </li>
12697   <li>
12698     How long will it be until the data writen to port Ao or Bo arrives at the
12699     edge of the JACK graph (playback)?
12700   </li>
12701 </ul>
12702
12703 <p>
12704   JACK features an <abbr title="Application Programming Interface">API</abbr>
12705   that allows applications to determine the answers to above questions.
12706   However JACK can not know about the additional latency that is introduced
12707   by the computer architecture, operating system and soundcard. These values
12708   can be specified by the JACK command line parameters <kbd class="input">-I</kbd>
12709   and <kbd class="input">-O</kbd> and vary from system
12710   to system but are constant on each. On a general purpose computer system
12711   the only way to accurately learn about the total (additional) latency is to
12712   measure it.
12713 </p>
12714
12715 <h2>Calibrating JACK Latency</h2>
12716
12717 <p>
12718   Linux DSP guru Fons Adriaensen wrote a tool called <dfn>jack_delay</dfn>
12719   to accurately measure the roundtrip latency of a closed loop audio chain,
12720   with sub-sample accuracy. JACK itself includes a variant of this tool
12721   called <dfn>jack_iodelay</dfn>.
12722 </p>
12723
12724 <p>
12725   Jack_iodelay allows you to measure the total latency of the system,
12726   subtracts the known latency of JACK itself and suggests values for
12727   jackd's audio-backend parameters.
12728 </p>
12729
12730 <p>
12731   jack_[io]delay works by emitting some rather annoying tones, capturing
12732   them again after a round trip through the whole chain, and measuring the
12733   difference in phase so it can estimate with great accuracy the time taken.
12734 </p>
12735
12736 <p>
12737   You can close the loop in a number of ways:
12738 </p>
12739
12740 <ul>
12741   <li>
12742     Putting a speaker close to a microphone. This is rarely done, as air
12743     propagation latency is well known so there is no need to measure it.
12744   </li>
12745   <li>
12746     Connecting the output of your audio interface to its input using a
12747     patch cable. This can be an analog or a digital loop, depending on
12748     the nature of the input/output you use. A digital loop will not factor
12749     in the <abbr title="Analog to Digital, Digital to Analog">AD/DA</abbr>
12750     converter latency.
12751   </li>
12752 </ul>
12753
12754 <p>
12755   Once you have closed the loop you have to:
12756 </p>
12757
12758 <ol>
12759   <li>Launch jackd with the configuration you want to test.</li>
12760   <li>Launch <kbd class="input">jack_delay</kbd> on the commandline.</li>
12761   <li>Make the appropriate connections between your jack ports so the loop is closed.</li>
12762   <li>Adjust the playback and capture levels in your mixer.</li>
12763 </ol>
12764
12765 ---
12766 title: Timecode Generators and Slaves
12767 part: subchapter
12768 ---
12769
12770 <p>
12771   Ardour supports three common timecode formats:
12772   <abbr title="Linear/Longitudinal Time Code"><dfn>LTC</dfn></abbr>,
12773   <abbr title="MIDI Time Code"><dfn>MTC</dfn></abbr>, and
12774   <dfn>MIDI Clock</dfn>, as well as
12775   <dfn>JACK-transport</dfn>, a JACK-specific timecode implementation.
12776 </p>
12777
12778 <p>
12779   Ardour can generate timecode and thus act as timecode <dfn>master</dfn>,
12780   providing timecode information to other applications. Ardour can also be
12781   <dfn>slaved</dfn> to some external source in which case the playhead
12782   follows the incoming timecode.
12783 </p>
12784
12785 <p>
12786   Combining the timecode slave and generator modes, Ardour can also
12787   <dfn>translate</dfn> timecode. e.g create LTC timecode from incoming MTC.
12788 </p>
12789
12790 <h2>Ardour Timecode Configuration</h2>
12791
12792 <p>
12793   Each Ardour session has a specific timecode frames-per-second setting which
12794   is configured in <kbd class="menu">session &gt; properties &gt;
12795   timecode</kbd>. The selected timecode affects the timecoderuler in the main
12796   window as well as the clock itself.
12797 </p>
12798
12799 <p>
12800   Note that some timecode formats do not support all of Ardour's available
12801   fps settings. MTC is limited to 24, 25, 29.97 and 30 fps.
12802 </p>
12803
12804 <p>
12805   The video pull-up modes change the effective samplerate of Ardour to allow
12806   for changing a film soundtrack from one frame rate to another. The concept is
12807   beyond the scope of this manual, but Wikipedia's entry on
12808   <a href="http://en.wikipedia.org/wiki/Telecine">Telecine</a>
12809   may get you started.
12810 </p>
12811
12812 <h2>Ardour Timecode Generator Configuration</h2>
12813
12814 <p>
12815   This is pretty straightforward: simply turn it on. The MTC and MIDI-Clock
12816   generator do not have any options. The LTC generator has a configurable
12817   output level. JACK-transport cannot be <em>generated</em>. Jack itself is
12818   always synced to its own cycle and cannot do varispeed&mdash;it will
12819   always be synced to a hardware clock or another JACK master.
12820 </p>
12821
12822 <p>
12823   The relevant settings for timecode generator can be found in
12824   <kbd class="menu">Edit &gt; Preferences &gt; MIDI Preferences</kbd> (for MTC,
12825   MC) and
12826   <kbd class="menu">Edit &gt; Preferences &gt; Transport Preferences</kbd>
12827   (for LTC).
12828 </p>
12829
12830 <p>
12831   The timecode is sent to jack-ports <code>ardour:MTC out</code>,
12832   <code>ardour:MIDI clock out</code> and <code>ardour:LTC-out</code>. Multiple
12833   generators can be active simultaneously.
12834 </p>
12835
12836 <p class="note">
12837   Note that, as of Jan 2014, only the LTC generator supports latency
12838   compensation. This is due to the fact the Ardour MIDI ports are not
12839   yet latency compensated.
12840 </p>
12841
12842 <p>
12843   In <kbd class="menu">Session &gt; Properties</kbd>, it is possible to
12844   define an offset between Ardour's internal time and the timecode sent.
12845   Currently only the LTC generator honors this offset.
12846 </p>
12847
12848 <p>
12849   Both LTC and MTC are limited to 30&nbsp;fps. Using frame rates larger
12850   than that will disable the generator. In both cases also only 24, 25,
12851   29.97df (drop-frame) and 30&nbsp;fps are well defined by specifications (such as
12852   SMPTE-12M, EU and the MIDI standard).
12853 </p>
12854
12855 <h3>MTC Generator</h3>
12856
12857 <p>
12858   The <dfn>MTC generator</dfn> has no options. Ardour sends full MTC
12859   frames whenever the transport is relocated or changes state (start/stop).
12860   MTC <dfn>quarter frames</dfn> are sent when the transport is rolling and
12861   the transport speed is within 93% and 107%.
12862 </p>
12863
12864 <h3>LTC Generator</h3>
12865
12866 <p>
12867   The level of the <dfn>LTC generator</dfn> output signal can be configured
12868   in in the <kbd class="menu">Preferences &gt; Transport</kbd> dialog. By
12869   default it is set to -18&nbsp;dBFS, which corresponds to 0dBu in an EBU
12870   calibrated system.
12871 </p>
12872
12873 <p>
12874   The LTC generator has an additional option to keep sending timecode even
12875   when the transport is stopped. This mode is intended to drive analog tape
12876   machines which unspool the tape if no LTC timecode is received.
12877 </p>
12878
12879 <p>
12880   LTC is send regardless of Ardour's transport speed. It is accurately
12881   generated even for very slow speeds (&lt;5%) and only limited by the
12882   soundcard's sampling-rate and filter (see
12883   <a
12884   href="http://en.wikipedia.org/wiki/Gibbs_phenomenon#Signal_processing_explanation">Gibbs phenomenon</a>)
12885   for high speeds.
12886 </p>
12887
12888 <h2>Ardour Slave Configuration</h2>
12889
12890 <p>
12891   The timecode source can be switched with the button just right of
12892   Ardour's main clock. By default it is set to <kbd
12893   class="menu">Internal</kbd> in which case Ardour will ignore any external
12894   timecode. The button allows to toggle between Internal and the configured
12895   timecode source which is chosen in <kbd class="menu">Edit &gt; Preferences
12896   &gt; Transport</kbd>.
12897 </p>
12898
12899 <p>
12900   When Ardour is <dfn>chasing</dfn> (synchronizing to) an external timecode
12901   source, the following cases need to be distinguished:
12902 </p>
12903
12904 <ol>
12905   <li>the timecode source shares the clock</li>
12906   <li>the timecode source is independent (no wordclock sync)</li>
12907 </ol>
12908
12909 <p>and</p>
12910
12911 <ol>
12912   <li>the timecode source uses the same FPS setting as Ardour</li>
12913   <li>the timecode source runs at different frames-per-second</li>
12914 </ol>
12915
12916 <p>
12917   In both cases the first option is preferred: clock sync + same FPS setting.
12918 </p>
12919
12920 <h3>Frames-per-second</h3>
12921
12922 <p>
12923   If the frames-per-second do not match, Ardour can either re-calculate
12924   and map the frames, or the configured FPS (<kbd class="menu">Session &gt;
12925   Properties</kbd>) can be changed automatically while the slave is active.
12926   The behavior is configured with the checkbox <kbd class="option">Edit
12927   &gt; Preferences &gt; Transport &gt; Match session video frame rate to
12928   external timecode</kbd>.
12929 </p>
12930
12931 <p>
12932   When enabled, the session video frame rate will be changed to match that
12933   of the selected external timecode source. When disabled, the session video
12934   frame rate will not be changed to match that of the selected external
12935   timecode source. Instead the frame rate indication in the main clock will
12936   flash red, and Ardour will convert between the external timecode standard
12937   and the session standard.
12938 </p>
12939
12940 <p class="warning">
12941   29.97 drop-frame timecode is another corner case. While the SMPTE 12M-1999
12942   specifies 29.97df as 30000/1001 frames per second, not all hardware devices
12943   follow that standard. The checkbox
12944   <kbd class="option">Lock to 29.9700 fps instead of 30000/1001</kbd> allows
12945   to use a compatibility mode for those devices.
12946 </p>
12947
12948 <p>
12949   When enabled, the external timecode source is assumed to use 29.970000 fps
12950   instead of 30000/1001. SMPTE 12M-1999 specifies 29.97df as 30000/1001. The
12951   <abbr title="specification">spec</abbr> further mentions that drop-frame
12952   timecode has an accumulated error of -86&nbsp;ms over a 24-hour period.
12953   Drop-frame timecode would compensate exactly for a NTSC color frame rate
12954   of 30 * 0.9990 (ie 29.970000). That is <em>not</em> the actual rate. However,
12955   some vendors use that rate&mdash;despite it being against the specs&mdash;because the variant of using exactly 29.97 fps yields zero timecode
12956   drift.
12957 </p>
12958
12959 <h3>Clock Sync Lock</h3>
12960
12961 <p>
12962   As described in the
12963   <a href="http://manual.ardour.org/synchronization/on-clock-and-time/">On Clock and Time</a>
12964   chapter, timecode and clock are independent. If the external timecode
12965   source is not in sample-sync with the audio hardware (and JACK), Ardour
12966   needs to run at varispeed to adjust for the discrepancy.
12967 </p>
12968
12969 <p>
12970   The checkbox <kbd class="option">External timecode is sync locked</kbd>
12971   allows to select the behavior according to your setup. When enabled, it
12972   indicates that the selected external timecode source shares sync (Black
12973   &amp; Burst, Wordclock, etc) with the audio interface.
12974 </p>
12975
12976 <p>
12977   In other words: if enabled, Ardour will only perform initial
12978   synchronization and keep playing at speed 1.0 instead of vari-speed
12979   adjusting to compensate for drift.
12980 </p>
12981
12982 <p class="note">
12983   Note that vari-speed is unavailable when recording in Ardour, and all
12984   tracking happens at speed 1.0. So if you want to record in sync with
12985   external timecode it must be sample-locked or it will drift over time.
12986 </p>
12987
12988 <h3>MIDI Clock</h3>
12989
12990 <p>
12991   <dfn>MIDI Clock</dfn> is not a timecode format but tempo-based time. The
12992   absolute reference point is expressed as beats-per-minute and Bar, Beat
12993   and Tick. There is no concept of sample-locking for MIDI clock signals.
12994   Ardour will vari-speed if necessary to chase the incoming signal.
12995 </p>
12996
12997 <p>
12998   Note that the MIDI Clock source must be connected to the
12999   <code>ardour:MIDI clock in</code> port.
13000 </p>
13001
13002 <h3>LTC&mdash;Linear Timecode</h3>
13003
13004 <p>
13005   The <dfn>LTC</dfn> slave decodes an incoming LTC signal on a JACK audio
13006   port. It will auto-detect the frame rate and start locking to the signal
13007    once two consecutive LTC frames have been received.
13008 </p>
13009
13010 <p>
13011   The incoming timecode signal needs to arrive at the
13012   <code>ardour:LTC-in</code> port. Port-connections are restored for each
13013   session and the preference dialog offers an option to select it for all
13014   sessions.
13015 </p>
13016
13017 <p>
13018   Ardour's transport is aligned to LTC-frame start/end positions according
13019   to the SMPTE 12M-1999 specification, which means that the first bit of an
13020   LTC-Frame is aligned to different Lines of a Video-Frame, depending on the
13021   TV standard used. Only for Film (24fps) does the LTC-Frame directly match
13022   the video Frame boundaries.
13023 </p>
13024
13025 <img src="/images/ltc-transport-alignment.png"  title="LTC frame alignment" alt="LTC frame alignment"/>
13026 <p><em>Figure: LTC frame alignment for the 525/60 TV standard</em></p>
13027
13028 <p>
13029   Ardour supports vari-speed and backwards playback but will only follow
13030   speed changes if the <kbd class="optoff">sync locked</kbd> option is
13031   disabled.
13032 </p>
13033
13034 <p>
13035   While Ardour is chasing LTC, the main transport clock will display the
13036   received Timecode as well as the delta between the incoming signal and
13037   Ardour's transport position.
13038 </p>
13039
13040 <p>
13041   A global offset between incoming timecode and Ardour's transport can be
13042   configured in <kbd class="menu">Session &gt; Properties</kbd>.
13043 </p>
13044
13045 <p>
13046   The user-bits in the received LTC frame are ignored.
13047 </p>
13048
13049 <h3>MTC&mdash;MIDI Timecode</h3>
13050
13051 <p>
13052   Ardour's MTC slave parses <dfn>full timecode messages</dfn> as well as
13053   MTC <dfn>quarter-frame messages</dfn> arriving on the
13054   <code>ardour:MTC in</code> port. The transport will only start rolling
13055   once a complete sequence of 8 quarter frames has been received.
13056 </p>
13057
13058 <p>
13059   Ardour supports vari-speed and backwards playback but will only follow
13060   MTC speed changes if the <kbd class="optoff">sync locked</kbd> option
13061   is disabled.
13062 </p>
13063
13064 <p>
13065   When Ardour is chasing MTC, the main transport clock will display the
13066   received Timecode as well as the delta between the incoming signal and
13067   Ardour's transport position.
13068 </p>
13069
13070 <h3>JACK Transport</h3>
13071
13072 <p>
13073   When slaved to jack, Ardour's transport will be identical to
13074   JACK-transport. As opposed to other slaves, Ardour can be used to control
13075   the JACK transport states (stopped/rolling). No port connections need to
13076   be made for jack-transport to work.
13077 </p>
13078
13079 <p>
13080   JACK-transport does not support vari-speed, nor offsets. Ardour does not
13081   chase the timecode but is always in perfect sample-sync with it.
13082 </p>
13083
13084 <p>
13085   JACK-transport also includes temp-based-time information in Bar:Beats:Ticks
13086   and beats-per-minute. However, only one JACK application can provide this
13087   information at a given time. The checkbox
13088   <kbd class="option">Session &gt; Properties &gt; JACK Time Master</kbd>
13089   configures Ardour to act as translator from timecode to BBT information.
13090 </p>
13091
13092 ---
13093 title: Overview of all Timecode related settings
13094 menu_title: Overview of Timecode settings
13095 part: subchapter
13096 ---
13097
13098 <p>
13099   Timecode settings are accessed from the menu in three places:
13100 </p>
13101
13102 <ul>
13103   <li><kbd class="menu">Session &gt; Properties &gt; Timecode</kbd></li>
13104   <li><kbd class="menu">Edit &gt; Preferences &gt; Transport</kbd></li>
13105   <li><kbd class="menu">Edit &gt; Preferences &gt; MIDI</kbd></li>
13106 </ul>
13107
13108 <h2>Timecode Settings</h2>
13109 <dl>
13110   <dt><kbd class="menu">Timecode frames-per-second</kbd></dt>
13111   <dd>
13112     Configure timecode frames-per-second (23.976, 24, 24.975, 25, 29.97,
13113     29.97 drop, 30, 30 drop, 59.94, 60). Note that all fractional
13114     framerates are actually fps*(1000.0/1001.0).
13115   </dd>
13116   <dt><kbd class="menu">Pull up/down</kbd></dt>
13117   <dd>
13118     Video pull-up modes change the effective samplerate of Ardour to
13119     allow for changing a film soundtrack from one frame rate to another.
13120     See <a href="http://en.wikipedia.org/wiki/Telecine">Telecine</a>
13121   </dd>
13122   <dt><kbd class="menu">Slave Timecode offset</kbd></dt>
13123   <dd>
13124     The specified offset is added to the received timecode (MTC or
13125     LTC).
13126   </dd>
13127   <dt><kbd class="menu">Timecode Generator offset</kbd></dt>
13128   <dd>
13129     Specify an offset which is added to the generated timecode (so far only LTC).
13130   </dd>
13131   <dt><kbd class="option">JACK Time Master</kbd></dt>
13132   <dd>
13133     Provide Bar|Beat|Tick and other information to JACK.
13134   </dd>
13135 </dl>
13136 <p>These settings are session specific.</p>
13137
13138
13139 <h2>Transport Preferences</h2>
13140 <dl>
13141   <dt><kbd class="menu">External timecode source</kbd></dt>
13142   <dd>
13143     Select timecode source: JACK, LTC, MTC, MIDI Clock
13144   </dd>
13145   <dt><kbd class="option">Match session video frame rate to external timecode</kbd></dt>
13146   <dd>
13147     This option controls the value of the video frame rate <em>while
13148     chasing</em> an external timecode source. When enabled, the
13149     session video frame rate will be changed to match that of the selected
13150     external timecode source. When disabled, the session video frame rate
13151     will not be changed to match that of the selected external timecode
13152     source. Instead the frame rate indication in the main clock will flash
13153     red and Ardour will convert between the external timecode standard and
13154     the session standard.
13155   </dd>
13156   <dt><kbd class="option">External timecode is sync locked</kbd></dt>
13157   <dd>
13158     Indicates that the selected external timecode source shares sync (Black
13159     &amp; Burst, Wordclock, etc) with the audio interface.
13160   </dd>
13161   <dt><kbd class="option">Lock to 29.9700 fps instead of 30000/1001</kbd></dt>
13162   <dd>
13163     The external timecode source is assumed to use 29.97 fps instead of
13164     30000/1001. SMPTE 12M-1999 specifies 29.97df as 30000/1001. The spec
13165     further mentions that drop-frame timecode has an accumulated error of -86ms
13166     over a 24-hour period. Drop-frame timecode would compensate exactly for a
13167     NTSC color frame rate of 30 * 0.9990 (ie 29.970000). That is not the actual
13168     rate. However, some vendors use that rate&mdash;despite it being against
13169     the specs&mdash;because the variant of using exactly 29.97 fps has zero
13170     timecode drift.
13171   </dd>
13172   <dt><kbd class="menu">LTC incoming port</kbd></dt>
13173   <dd>
13174     Offers a session agnostic way to retain the LTC port connection.
13175   </dd>
13176   <dt><kbd class="option">Enable LTC generator</kbd></dt>
13177   <dd>Does just what it says.</dd>
13178   <dt><kbd class="option">Send LTC while stopped</kbd></dt>
13179   <dd>
13180     Enable to continue to send LTC information even when the transport
13181     (playhead) is not moving. This mode is intended to drive analog tape
13182     machines which unspool the tape if no LTC timecode is received.
13183   </dd>
13184   <dt><kbd class="menu">LTC generator level</kbd></dt>
13185   <dd>
13186     Specify the Peak Volume of the generated LTC signal in dbFS. A good value
13187     is 0&nbsp;dBu (which is -18&nbsp;dbFS in an EBU calibrated system).
13188   </dd>
13189 </dl>
13190 <p>These settings are common to all sessions.</p>
13191
13192
13193 <h2>MIDI Preferences</h2>
13194 <dl>
13195   <dt><kbd class="option">Send MIDI Timecode</kbd></dt><dd>Enable MTC generator</dd>
13196   <dt><kbd class="option">Send MIDI Clock</kbd></dt><dd>Enable MIDI Clock generator</dd>
13197 </dl>
13198 <p>These settings are also common to all sessions.</p>
13199
13200
13201 ---
13202 title: Working with Field Recorders in Ardour
13203 part: chapter
13204 ---
13205
13206
13207 ---
13208 title: Working with Video in Ardour
13209 part: chapter
13210 ---
13211
13212
13213 ---
13214 title: Video Timeline and Monitoring
13215 part: subchapter
13216 ---
13217
13218 <p>
13219   Ardour offers a <dfn>video timeline</dfn> and <dfn>video monitoring</dfn>
13220   for convenient audio mixing and editing to video, in order to produce
13221   film soundtracks and music videos, or perform TV postproduction tasks.
13222 </p>
13223
13224 <p>
13225   The video capabilities are:
13226 </p>
13227
13228 <ul>
13229   <li>Import a single video and optionally extract the soundtrack from it.</li>
13230   <li>Provide a video monitor window, or full-screen display, of the
13231   imported video in sync with any of the available Ardour timecode
13232   sources.</li>
13233   <li>Display a frame-by-frame (thumbnail) timeline of the video.</li>
13234   <li>Allow for a configurable timecode offset.</li>
13235   <li><em>Lock</em> audio regions to the video.</li>
13236   <li>Move audio regions with the video at video-frame granularity.</li>
13237   <li>Export the video, trim start and end, add blank frames and/or
13238   multiplex it with the soundtrack of the current session.</li>
13239 </ul>
13240
13241 <p>
13242   The setup of the video subsystem is modular and can be configured
13243   in different ways, including:
13244 </p>
13245
13246 <ul>
13247   <li>One machine for all video decoding, video monitoring and audio editing
13248   tasks</li>
13249   <li>Two machines, one for video monitoring, one for Ardour</li>
13250   <li>Three machines,  separate video server (for timeline decoding
13251   and file archive), dedicated video monitor, and Ardour</li>
13252 </ul>
13253
13254 <p>
13255   Ardour does <em>not</em>:
13256 </p>
13257
13258 <ul>
13259   <li>allow for more than one video to be loaded at a time.</li>
13260   <li>provide video editing capabilities</li>
13261 </ul>
13262
13263 ---
13264 title: Video Timeline Setup
13265 part: subchapter
13266 ---
13267
13268 <p>
13269   No configuration is required if you intend to run everything on a single
13270   machine, and if you acquired Ardour from
13271   <a href="http://www.ardour.org"
13272   title="http://www.ardour.org">http://www.ardour.org</a>.
13273   Everything is pre-configured and included with the download/install.
13274 </p>
13275
13276 <h2>Single Machine</h2>
13277
13278 <p>
13279   If you compile Ardour from source, or have installed it from a 3rd party
13280   repository, three additional tools will need to be installed manually,
13281   which are used by Ardour to provide video features:
13282 </p>
13283
13284 <ul>
13285   <li>xjadeo (the video monitor application): <a href="http://xjadeo.sf.net"
13286   title="http://xjadeo.sf.net" rel="nofollow">http://xjadeo.sf.net</a></li>
13287   <li>harvid (a video decoder used for the thumbnail timeline): <a
13288   href="http://x42.github.com/harvid/" title="http://x42.github.com/harvid/"
13289   rel="nofollow">http://x42.github.com/harvid/</a></li>
13290   <li>ffmpeg, ffprobe (used to import/export video, extract soundtracks and
13291   query video information): <a href="http://ffmpeg.org" title="http://ffmpeg.org"
13292   rel="nofollow">http://ffmpeg.org</a></li>
13293 </ul>
13294
13295 <p>
13296   Ardour requires xjadeo &ge; version 0.6.4, harvid &ge; version 0.7.0 and ffmpeg (known to work versions: 1.2, 2.8.2)
13297 </p>
13298
13299 <p>
13300   The Ardour development team is in control of the first two applications. ffmpeg however can be a bit of a problem. To avoid conflicts with distribution packages, Ardour looks for <code>ffmpeg_harvid</code> and <code>ffprobe_harvid</code>.
13301 </p>
13302
13303 <p>
13304   All four applications need to be found in <code>$PATH</code> (e.g.
13305   <code>$HOME/bin</code> or <code>/usr/local/bin</code>). For convenience the
13306   binary releases of harvid include ffmpeg_harvid and ffprobe_harvid, but if
13307   your distribution provides suitable ffmpeg commands you can also just create
13308   symbolic links:
13309 </p>
13310
13311 <kbd class="cmd lin">sudo ln -s /usr/bin/ffmpeg /usr/bin/ffmpeg_harvid</kbd>
13312 <kbd class="cmd lin">sudo ln -s /usr/bin/ffprobe /usr/bin/ffprobe_harvid</kbd>
13313
13314 <p>
13315   Binary releases are available from ardour.org as well as an installer script:
13316   <a href="https://github.com/Ardour/ardour/blob/master/tools/videotimeline/install_video_tools.sh"
13317   title="https://github.com/Ardour/ardour/blob/master/tools/videotimeline/install_video_tools.sh"
13318   rel="nofollow">install_video_tools.sh</a>.
13319 </p>
13320
13321 <p>
13322   The easiest way to install the video-utilities is by running the following
13323   line in a terminal:
13324 </p>
13325
13326 <kbd class="cmd lin">sh -c &quot;$(curl -s -L http://git.io/tVUCkw)&quot;</kbd>
13327
13328 <h2>Studio Setup</h2>
13329
13330 <p>
13331   Please read the info in the previous section to familiarize yourself with
13332   the tools involved first. Setting up a proper A/V post-production studio
13333   can be a complicated task. As much as we streamline and simplify the
13334   <em>single machine</em> setup, the <dfn>studio setup</dfn> is focused on modularity.
13335 </p>
13336
13337 <ul class="fixme">
13338   <li>TODO:</li>
13339   <li>Synchronization ardour â†’ video-display-box should be accomplished by external
13340  means jack-transport(netjack), MTC, LTC
13341  (<abbr title="Open Sound Control&mdash;&quot;postmodern MIDI&quot;">OSC</abbr> and/or
13342  ssh-pipe work but introduce additional latency + jitter)</li>
13343   <li>Ardour launches <code>XJREMOTE</code> (environment variable, default &#039;xjremote&#039; which comes with xjadeo).</li>
13344   <li>Either use a custom shell script that ssh&#039;es into the remote box and launches/controls xjadeo there, selects the sync-source and passes though communication between ardour â‡” xjadeo via ssh (xjadeo is launched stopped with the session).</li>
13345   <li>..or override xjremote&#039;s behavior â€“ instead of  IPC with a local running xjadeo-process, using <abbr title="Open Sound Control&mdash;&quot;postmodern MIDI&quot;">OSC</abbr> for example. xjadeo would run permanently and Ardour will just tell it to load files and set offsets via <acronym title="Open Sound Control&mdash;&quot;postmodern MIDI&quot;">OSC</acronym>. see <a href="http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo;a=blob_plain;f=contrib/xjremote-osc" title="http://xjadeo.git.sourceforge.net/git/gitweb.cgi?p=xjadeo/xjadeo;a=blob_plain;f=contrib/xjremote-osc"  rel="nofollow">xjremote-osc</a> example script.</li>
13346   <li>If the video server runs remotely, Ardour needs to be configured in Ardour &gt; Preference &gt; Video (hostname of the video-server).</li>
13347   <li> Ideally the machines have a common shared folder (NFS or similar).  Ardour&#039;s import (audio-extract) and export (mux) functionality depends on having access to the video file.  Also Ardour's video-import transcodes the file into a suitable proxy-format that allows reliable seeking to any frame…</li>
13348 </ul>
13349
13350 ---
13351 title: Transcoding, Formats &amp; Codecs
13352 part: subchapter
13353 ---
13354
13355 <p>
13356   This chapter provides a short primer on video files, formats and
13357   codecs â€“ because it is often cause for confusion:
13358 </p>
13359
13360 <p>
13361   A video file is a <dfn>container</dfn>. It usually contains one
13362   <dfn>video track</dfn> and one or more <dfn>audio tracks</dfn>.
13363   How these tracks are stored in the file is defined by the
13364   <dfn>file format</dfn>. Common formats are
13365   avi, mov, ogg, mkv, mpeg, mpeg-ts, mp4, flv, or vob.
13366 </p>
13367
13368 <p>
13369   Each of the tracks by itself is encoded using a <abbr
13370   title="Coder-Decoder"><dfn>Codec</dfn></abbr>. Common video codecs
13371   are h264, mpeg2, mpeg4, theora, mjpeg, wmv3. Common audio codecs are
13372   mp2, mp3, dts, aac, wav/pcm.
13373 </p>
13374
13375 <p>
13376   Not all codecs can be packed into a given format. For example the
13377   mpeg format is limited to mpeg2, mpeg4 and mp3 codecs (not entirely true).
13378   DVDs do have stringent limitations as well. The opposite would be .avi;
13379   pretty much every audio/video codec combination can be contained in an avi
13380   file-format.
13381 </p>
13382
13383 <p>
13384   To make things worse, naming conventions for video codecs and formats are
13385   often identical (especially MPEG ones) which leads to confusion.
13386   All in all it is a very wide and deep field. Suffice there are different
13387   uses for different codecs and formats.
13388 </p>
13389
13390 <h2>Ardour specific issues</h2>
13391
13392 <p>
13393   Ardour supports a wide variety of video file formats codecs. More specifically, Ardour itself actually does not support any video at all but delegates handling of video files to <a href="http://ffmpeg.org">ffmpeg</a>, which supports over 350 different video codecs and more than 250 file formats.
13394 </p>
13395
13396 <p>
13397   When importing a video into Ardour, it will be <dfn>transcoded</dfn> (changed from one format and codec to another) to avi/mjpeg for internal use (this allows reliable seeking to frames at low CPU cost&mdash;the file size will increase, but hard disks are large and fast).
13398 </p>
13399
13400 <p>
13401   The export dialog includes presets for common format and codec combinations (such as DVD, web-video,..). If in doubt use one of the presets.
13402 </p>
13403
13404 <p>
13405   As last note: every time a video is transcoded, the quality can only get worse. Hence for the final mastering/<abbr title="Multiplexing Audio and Video">muxing</abbr> process, one should always to back and use the original source of the video.
13406 </p>
13407
13408 ---
13409 title: Workflow &amp; Operations
13410 part: subchapter
13411 ---
13412
13413 <h2>Overview of Operations</h2>
13414
13415 <dl class="wide-table">
13416   <dt><kbd class="menu">Session &gt; Open Video</kbd></dt>
13417   <dd>Add/replace a video to/on the timeline</dd>
13418   <dt><kbd class="menu">Window &gt; View Monitor</kbd></dt>
13419   <dd>Open/close external video monitor window</dd>
13420   <dt><kbd class="menu">View &gt; Video Monitor &gt; â€¦</kbd></dt>
13421   <dd>Various settings of the video monitor</dd>
13422   <dt><kbd class="menu">Session &gt; Export &gt; Video</kbd></dt>
13423   <dd>Export session and multiplex with video-file</dd>
13424   <dt><kbd class="mouse">Left</kbd>-drag the video in the timeline</dt>
13425   <dd>Re-align video and move 'locked' audio-regions along</dd>
13426   <dt>Context-menu on the video-timeline: <kbd class="menu"> &#039;lock&#039;</kbd></dt>
13427   <dd>Prevent accidental drags</dd>
13428   <dt>Audio region context menu: <kbd class="menu">Position &gt; Lock to video</kbd></dt>
13429   <dd>Mark audio region(s) to be moved along with the video.</dd>
13430 </dl>
13431
13432 <h2>Adding Video</h2>
13433
13434 <p>
13435   Adding video is a two-step process: select a video file, and choose
13436   import mode and optionally select an audio track to extract.
13437 </p>
13438
13439 <p>
13440   The first step is rather straight-forward. The panel on the right side
13441   allows to seek through the video and displays basic file information.
13442   It is also useful to check if the video format/codec is supported:
13443 </p>
13444
13445 <img src="/images/a3_video_open.png" alt="video-open-dialog" width="300" />
13446
13447 <p>
13448   The second step analyzes the video file in more detail and offers import options:
13449 </p>
13450
13451 <dl>
13452   <dt><kbd class="menu">Import/Transcode to Session</kbd></dt>
13453   <dd>This is the default. The video will be imported in a suitable
13454   video format/codec for the timeline and video monitor and saved inside the
13455   session folder.  A location other than the session folder can also be
13456   chosen (external disk, or network storage of the video server on a different
13457   machine).</dd>
13458   <dt><kbd class="menu">Reference from Current Location</kbd></dt>
13459   <dd>Only useful for opening files that were previously encoded (are already
13460   in a good format/codec). Use with care.</dd>
13461   <dt><kbd class="menu">Do not Import Video</kbd></dt>
13462   <dd>Useful for extracting audio only.</dd>
13463 </dl>
13464
13465 <img src="/images/a3_video_import.png" alt="Video Import Dialog" width="300" />
13466
13467 <p>
13468   By default the video is imported using the original width/height.
13469   If it is a large video (e.g. full-HD) it makes sense to scale it down
13470   to decrease the CPU load and disk I/O required to decode and play the
13471   file.<br />
13472   A small, low-quality representation of the image is usually sufficient
13473   for editing soundtracks. The default bitrate in kbit/sec is set to use
13474   0.7 bits per pixel. (Compare: the average DVD medium uses 5000&nbsp;kbit/s;
13475   at PAL resolution this is about 0.5 bits per pixel. But the DVD is
13476   using the <dfn>mpeg2</dfn>&mdash;a denser compression algorithm than the
13477   <dfn>mjpeg</dfn> codec used by Ardour.)
13478 </p>
13479
13480 <h2>Working with A/V</h2>
13481
13482 <p>
13483   Well now...
13484 </p>
13485
13486 <img src="/images/a3_videotimeline.png" alt="Video Timeline" width="600" />
13487
13488 <h2 id="export">Exporting Video</h2>
13489
13490 <p>
13491   The video export will take audio from the current Ardour session and
13492   multiplex it with a video file. The soundtrack of the video is taken from
13493   an audio export of Ardour's master bus.
13494 </p>
13495
13496 <p>
13497   An arbitrary video file can be chosen. For high quality exports, the
13498   original file (before it was imported into the timeline) should be used.
13499   This is the default behaviour if that file can be found. If not, Ardour
13500   will fall back to the imported proxy-video which is currently in use
13501   on the timeline.  Any existing audio tracks on this video file are stripped.
13502 </p>
13503
13504 <p>
13505   The range selection allows to cut or extend the video. If the session is
13506   longer than the video duration, black frames are prefixed or appended to
13507   the video. (Note: this process may fail with non-standard pixel aspect
13508   ratios). If Ardour's session range is shorter, the video will be cut accordingly.
13509 </p>
13510
13511 <p>
13512   Audio samplerate and normalization are options for Ardour's audio exporter.
13513   The remaining settings are options that are directly passed on to ffmpeg.
13514 </p>
13515
13516 <p>
13517   The file format is determined by the extension that you choose for it
13518   (.avi, .mov, .flv, .ogv, .webm,...)
13519   Note: not all combinations of format, codec, and settings produce files
13520   which are according to specifications. For example, flv files require
13521   sample rates of 22.1&nbsp;kHz or 44.1&nbsp;kHz, mpeg containers can not
13522   be used with ac3 audio-codec, etc. If in doubt, use one of the built-in
13523   presets.
13524 </p>
13525
13526 <img src="/images/a3_video_export.png" alt="Video Export Dialog" width="300" />
13527
13528 <p>
13529   Ardour video export is not recommended for mastering! While ffmpeg (which is used by Ardour) can produce high-quality files, this export lacks the possibility to tweak many settings. We recommend to use winff, devede or dvdauthor to mux &amp; master. Nevertheless this video-export comes in handy to do quick snapshots, intermediates, dailies or online videos.
13530 </p>
13531
13532
13533 ---
13534 title: Open Sound Control (OSC)
13535 part: part
13536 ---
13537
13538
13539 ---
13540 title: Controlling Ardour with OSC
13541 include: controlling-ardour-with-osc.html
13542 part: chapter
13543 ---
13544
13545 ---
13546 title: OSC&#58; Controlling Ardour with OSC
13547 include: osc-control.html
13548 part: subchapter
13549 ---
13550
13551 ---
13552 title: OSC&#58; Using the Setup Dialog
13553 include: osc-setup-dialog.html
13554 part: subchapter
13555 ---
13556
13557 ---
13558 title: OSC&#58; Querying Ardour
13559 include: querying-ardour-with-osc.html
13560 part: subchapter
13561 ---
13562
13563 ---
13564 title: OSC&#58; Feedback
13565 include: feedback-in-osc.html
13566 part: subchapter
13567 ---
13568
13569 ---
13570 title: OSC&#58; Feedback and Strip-types Values
13571 include: calculating-feedback-and-strip-types-values.html
13572 part: subchapter
13573 ---
13574
13575 ---
13576 title: OSC&#58; Personal Monitoring Control
13577 include: osc-personal-monitoring.html
13578 part: subchapter
13579 ---
13580
13581 ---
13582 title: OSC&#58; Parameter Types
13583 include: parameter-types-in-osc.html
13584 part: subchapter
13585 ---
13586
13587 ---
13588 title: OSC&#58; Selection and Expansion Considerations
13589 include: selection-considerations-in-osc.html
13590 part: subchapter
13591 ---
13592
13593 ---
13594 title: OSC control for Ardour 4.7 and Prior
13595 include: osc-control-in-ardour-4.7-and-prior.html
13596 part: subchapter
13597 ---
13598
13599
13600 ---
13601 title: Devices using Mackie/Logic Control Protocol
13602 include: devices-using-mackielogic-control-protocol.html
13603 part: chapter
13604 ---
13605
13606 ---
13607 title: Behringer devices in Mackie/Logic Control Mode
13608 menu_title: Behringer devices
13609 include: behringer-devices-in-mackielogic-control-mode.html
13610 part: subchapter
13611 ---
13612
13613 ---
13614 title: SSL Nucleus
13615 include: ssl-nucleus.html
13616 part: subchapter
13617 ---
13618
13619 ---
13620 title: Mackie Control Setup on Linux
13621 include: mackie-control-setup-on-linux.html
13622 part: subchapter
13623 ---
13624
13625 ---
13626 title: What to do if your Device is not Listed
13627 menu_title: Unlisted devices
13628 include: devices-not-listed.html
13629 part: subchapter
13630 ---
13631
13632 ---
13633 title: Working With Extenders
13634 menu_title: Working With Extenders
13635 include: working-with-extenders.html
13636 part: subchapter
13637 ---
13638
13639
13640 ---
13641 title: MIDI Binding Maps
13642 include: midi-binding-maps.html
13643 part: chapter
13644 ---
13645
13646 ---
13647 title: Working With Encoders in Ardour
13648 menu_title: Working With Encoders
13649 include: working-with-encoders.html
13650 part: subchapter
13651 ---
13652
13653
13654 ---
13655 title: MIDI Learn
13656 include: midi-learn.html
13657 part: chapter
13658 ---
13659
13660 ---
13661 title: Using the Presonus Faderport
13662 menu_title: Presonus Faderport
13663 include: presonus-faderport.html
13664 part: chapter
13665 ---
13666
13667 ---
13668 title: Using the Ableton Push 2
13669 menu_title: Ableton Push 2
13670 include: ableton-push2.html
13671 part: chapter
13672 ---
13673
13674
13675 ---
13676 title: Scripting
13677 part: part
13678 ---
13679
13680
13681 ---
13682 title: Lua Scripting in Ardour
13683 part: chapter
13684 ---
13685
13686
13687 ---
13688 title: Lua Scripting
13689 part: subchapter
13690 ---
13691
13692 <p>
13693   Starting with version 4.7.213, Ardour supports Lua scripts.
13694 </p>
13695
13696 <p class="warning">
13697   Lua Integration is Work in Progress and far from complete.
13698 </p>
13699
13700 ---
13701 title: Scripting Documentation
13702 part: subchapter
13703 ---
13704
13705 <p class="warning">
13706  This Documentation is Work in Progress and far from complete. Also the documented API may be subject to change.
13707 </p>
13708
13709 <h2>Preface</h2>
13710
13711 <p>
13712   There are cases that a Ardour cannot reasonably cater for with core functionality by itself, either because they're session specific or user specific edge cases.
13713 </p>
13714
13715 <p>
13716   Examples for these include voice-activate (record-arm specific tracks and roll transport depending on signal levels), rename all regions after a specific timecode, launch an external application when a certain track is soloed, generate automation curves or simply provide a quick shortcut for a custom batch operation.
13717 </p>
13718
13719 <p>
13720   Cases like this call for means to extend the DAW without actually changing the DAW itself. This is where scripting comes in.
13721 </p>
13722
13723 <p>
13724   "Scripting" refers to tasks that could alternatively be executed step-by-step by a human operator.
13725 </p>
13726
13727 <p>
13728   Lua is a tiny and simple language which is easy to learn, yet allows for comprehensive solutions. Lua is also a glue language it allows to tie existing component in Ardour together in unprecedented ways, and most importantly Lua is one of the few scripting-languages which can be safely used in a real-time environment.
13729 </p>
13730
13731 <p>
13732   A good introduction to Lua is the book <a href="http://www.lua.org/pil/">Programming in Lua</a>. The first edition is available online, but if you have the means buy a copy of the book, it not only helps to support the Lua project, but provides for a much nicer reading and learning experience.
13733 </p>
13734
13735 <h2>Overview</h2>
13736
13737 <p>
13738   The core of ardour is a real-time audio engine that runs and processes audio. One interfaces with than engine by sending it commands. Scripting can be used to interact with or modify active Ardour session. Just like a user uses the Editor/Mixer GUI to modify the state or parameters of the session.
13739 </p>
13740
13741 <p>
13742   Doing this programmatically requires some knowledge about the objects used internally. Most Ardour C++ objects and their methods are directly exposed to Lua and one can call functions or modify variables:
13743 </p>
13744
13745 <div style="width:80%; margin:.5em auto;">
13746         <div style="width:45%; float:left;">
13747                 C++<br/>
13748                 <code class="cxx">
13749                         session-&gt;set_transport_speed (1.0);
13750                 </code>
13751         </div>
13752         <div style="width:45%; float:right;">
13753                 Lua<br/>
13754                 <code class="lua">
13755                         Session:set_transport_speed (1.0)
13756                 </code>
13757         </div>
13758 </div>
13759
13760 <div style="clear:both;"></div>
13761
13762 <p>
13763   You may notice that there is only a small syntactic difference, in this case. While C++ requires recompiling the application for every change, Lua script can be loaded, written or modified while the application is running. Lua also abstracts away many of the C++ complexities such as object lifetime, type conversion and null-pointer checks.
13764 </p>
13765
13766 <p>
13767   Close ties with the underlying C++ components is where the power of scripting comes from. A script can orchestrate interaction of lower-level components which take the bulk of the CPU time of the final program.
13768 </p>
13769
13770 <p>
13771   At the time of writing Ardour integrates Lua 5.3.2: <a href="http://www.lua.org/manual/5.3/manual.html">Lua 5.3 reference manual</a>.
13772 </p>
13773
13774 <h2>Integration</h2>
13775
13776 <p>
13777   Like Control surfaces and the GUI, Lua Scripts are confined to certain aspects of the program. Ardour provides the framework and runs Lua (not the other way around).
13778 </p>
13779
13780
13781 <p>
13782   In Ardour's case Lua is available:
13783 </p>
13784
13785 <dl>
13786         <dt>Editor Action Scripts</dt><dd>User initiated actions (menu, shortcuts) for batch processing</dd>
13787         <dt>Editor Hooks/Callbacks</dt><dd>Event triggered actions for the Editor/Mixer GUI</dd>
13788         <dt>Session Scripts</dt><dd>Scripts called at the start of every audio cycle (session, real-time)</dd>
13789         <dt>DSP Scripts</dt><dd>Audio/Midi processor&mdash;plugins with access to the Ardour session (per track/bus, real-time)</dd>
13790         <dt>Script Console</dt><dd>Action Script commandline</dd>
13791 </dl>
13792
13793 <p>
13794   There are is also a special mode:
13795 </p>
13796
13797 <dl>
13798         <dt>Commandline Tool</dt><dd>Replaces the complete Editor GUI, direct access to libardour (no GUI) from the commandline.<br/>
13799         <em>Be aware that the vast majority of complex functionality is provided by the Editor UI.</em></dd>
13800 </dl>
13801
13802 <h2>Managing Scripts</h2>
13803
13804 <p>
13805   Ardour searches for Lua scripts in the <code>scripts</code> folder in <code>$ARDOUR_DATA_PATH</code>, Apart from scripts included directly with Ardour, this includes
13806 </p>
13807
13808 <table>
13809         <tr><th>GNU/Linux</th><td><code>$HOME/.config/ardour5/scripts</code></td></tr>
13810         <tr><th>Mac OS X</th><td><code>$HOME/Library/Preferences/Ardour5/scripts</code></td></tr>
13811         <tr><th>Windows</th><td><code>%localappdata%\ardour5\scripts</code></td></tr>
13812 </table>
13813
13814 <p>Files must end with <code>.lua</code> file extension.</p>
13815
13816 <p>Scripts are managed via the GUI</p>
13817
13818 <dl>
13819         <dt>Editor Action Scripts</dt><dd>Menu &rarr; Edit &rarr; Scripted Actions &rarr; Manage</dd>
13820         <dt>Editor Hooks/Callbacks</dt><dd>Menu &rarr; Edit &rarr; Scripted Actions &rarr; Manage</dd>
13821         <dt>Session Scripts</dt><dd>Menu &rarr; Session &rarr; Scripting &rarr; Add/Remove Script</dd>
13822         <dt>DSP Scripts</dt><dd>Mixer-strip &rarr; context menu (right click) &rarr; New Lua Proc</dd>
13823         <dt>Script Console</dt><dd>Menu &rarr; Window &rarr; Scripting</dd>
13824 </dl>
13825
13826 <h2>Script Layout</h2>
13827
13828 <ul>
13829         <li>Every script must include an <code>ardour</code> descriptor table. Required fields are "Name" and "Type".</li>
13830         <li>A script must provide a <em>Factory method</em>: A function with optional instantiation parameters which returns the actual script.</li>
13831         <li>[optional]: list of parameters for the "factory".</li>
13832         <li>in case of DSP scripts, an optional list of automatable parameters and possible audio/midi port configurations, and a <code>dsp_run</code> function, more on that later.</li>
13833 </ul>
13834
13835 <p>A minimal example script looks like:</p>
13836
13837 <div>
13838 <pre><code class="lua">
13839         ardour {
13840           ["type"]    = "EditorAction",
13841           name        = "Rewind",
13842         }
13843
13844         function factory (unused_params)
13845           return function ()
13846            Session:goto_start()  -- rewind the transport
13847           end
13848         end
13849 </code></pre>
13850 </div>
13851
13852 <p>
13853   The common part for all scripts is the "Descriptor". It's a Lua function which returns a table (key/values) with the following keys (the keys are case-sensitive):
13854 </p>
13855
13856 <dl>
13857         <dt>type [required]</dt><dd>one of "<code>DSP</code>", "<code>Session</code>", "<code>EditorHook</code>", "<code>EditorAction</code>" (the type is not case-sensitive)</dd>
13858         <dt>name [required]</dt><dd>Name/Title of the script</dd>
13859         <dt>author</dt><dd>Your Name</dd>
13860         <dt>license</dt><dd>The license of the script (e.g. "GPL" or "MIT")</dd>
13861         <dt>description</dt><dd>A longer text explaining to the user what the script does</dd>
13862 </dl>
13863
13864 <p class="note">
13865   Scripts that come with Ardour (currently mostly examples) can be found in the <a href="https://github.com/Ardour/ardour/tree/master/scripts">Source Tree</a>.
13866 </p>
13867
13868 <h3>Action Scripts</h3>
13869
13870 <p>
13871   Action scripts are the simplest form. An anonymous Lua function is called whenever the action is triggered. A simple action script is shown above.
13872 </p>
13873 <p>
13874   There are 10 action script slots available, each of which is a standard GUI action available from the menu and hence can be bound to a keyboard shortcut.
13875 </p>
13876
13877 <h3>Session Scripts</h3>
13878
13879 <p>
13880   Session scripts similar to Actions Scripts, except the anonymous function is called periodically every process cycle. The function receives a single parameter&mdash;the number of audio samples which are processed in the given cycle
13881 </p>
13882
13883 <div>
13884 <pre><code class="lua">
13885 ardour {
13886   ["type"]    = "session",
13887   name        = "Example Session Script",
13888   description = [[
13889   An Example Ardour Session Script.
13890   This example stops the transport after rolling for a specific time.]]
13891 }
13892
13893 -- instantiation options, these are passed to the "factory" method below
13894 function sess_params ()
13895   return
13896   {
13897     ["print"]  = { title = "Debug Print (yes/no)", default = "no", optional = true },
13898     ["time"] = { title = "Timeout (sec)", default = "90", optional = false },
13899   }
13900 end
13901
13902 function factory (params)
13903   return function (n_samples)
13904     local p = params["print"] or "no"
13905     local timeout = params["time"] or 90
13906     a = a or 0
13907     if p ~= "no" then print (a, n_samples, Session:frame_rate (), Session:transport_rolling ()) end -- debug output (not rt safe)
13908     if (not Session:transport_rolling()) then
13909       a = 0
13910       return
13911     end
13912     a = a + n_samples
13913     if (a &gt; timeout * Session:frame_rate()) then
13914       Session:request_transport_speed(0.0, true)
13915     end
13916   end
13917 end
13918 </code></pre>
13919 </div>
13920
13921 <h3>Action Hooks</h3>
13922
13923 <p>
13924   Action hook scripts must define an additional function which returns a <em>Set</em> of Signal that which trigger the callback (documenting available slots and their parameters remains to be done).
13925 </p>
13926
13927 <div>
13928 <pre><code class="lua">
13929 ardour {
13930   ["type"]    = "EditorHook",
13931   name        = "Hook Example",
13932   description = "Rewind On Solo Change, Write a file when regions are moved.",
13933 }
13934
13935 function signals ()
13936   s = LuaSignal.Set()
13937   s:add (
13938     {
13939       [LuaSignal.SoloActive] = true,
13940       [LuaSignal.RegionPropertyChanged] = true
13941     }
13942   )
13943   return s
13944 end
13945
13946 function factory (params)
13947   return function (signal, ref, ...)
13948     -- print (signal, ref, ...)
13949
13950     if (signal == LuaSignal.SoloActive) then
13951       Session:goto_start()
13952     end
13953
13954     if (signal == LuaSignal.RegionPropertyChanged) then
13955       obj,pch = ...
13956       file = io.open ("/tmp/test" ,"a")
13957       io.output (file
13958       io.write (string.format ("Region: '%s' pos-changed: %s, length-changed: %s\n",
13959         obj:name (),
13960         tostring (pch:containsFramePos (ARDOUR.Properties.Start)),
13961         tostring (pch:containsFramePos (ARDOUR.Properties.Length))
13962         ))
13963       io.close (file)
13964     end
13965   end
13966 end
13967 </code></pre>
13968 </div>
13969
13970 <h3>DSP Scripts</h3>
13971
13972 <p>See the scripts folder for examples for now.</p>
13973
13974 <p>Some notes for further doc:</p>
13975
13976 <ul>
13977         <li>required function: <code>dsp_ioconfig ()</code>: return a list of possible audio I/O configurations&mdash;follows Audio Unit conventions.</li>
13978         <li>optional function: <code>dsp_dsp_midi_input ()</code>: return true if the plugin can receive midi input</li>
13979         <li>optional function: <code>dsp_params ()</code>: return a table of possible parameters (automatable)</li>
13980         <li>optional function: <code>dsp_init (samplerate)</code>: called when instantiation the plugin with given samplerate.</li>
13981         <li>optional function: <code>dsp_configure (in, out)</code>: called after instantiation with configured plugin i/o.</li>
13982         <li>required function: <code>dsp_run (ins, outs, n_samples)</code> OR <code>dsp_runmap (bufs, in_map, out_map, n_samples, offset)</code>: DSP process callback. The former is a convenient abstraction that passes mapped buffers (as table). The latter is a direct pass-through matching Ardour's internal <code>::connect_and_run()</code> API, which requires the caller to map and offset raw buffers.</li>
13983         <li>plugin parameters are handled via the global variable <code>CtrlPorts</code>.</li>
13984         <li>midi data is passed via the global variable <code>mididata</code> which is valid during <code>dsp_run</code> only. (dsp_runmap requires the script to pass raw data from the buffers according to in_map)</li>
13985         <li>The script has access to the current session via the global variable Session, but access to the session methods are limited to realtime safe functions</li>
13986 </ul>
13987
13988 <h2>Accessing Ardour Objects</h2>
13989
13990 <p>
13991   The top most object in Ardour is the <code>ARDOUR::Session</code>. Fundamentally, a Session is just a collection of other things: Routes (tracks, busses), Sources (Audio/Midi), Regions, Playlists, Locations, Tempo map, Undo/Redo history, Ports, Transport state &amp; controls, etc.
13992 </p>
13993
13994 <p>
13995   Every Lua interpreter can access it via the global variable <code>Session</code>.
13996 </p>
13997
13998 <p>
13999   GUI context interpreters also have an additional object in the global environment: The Ardour <code>Editor</code>. The Editor provides access to high level functionality which is otherwise triggered via GUI interaction such as undo/redo, open/close windows, select objects, drag/move regions. It also holds the current UI state: snap-mode, zoom-range, etc. The Editor also provides complex operations such as "import audio" which under the hood, creates a new Track, adds a new Source Objects (for every channel) with optional resampling, creates both playlist and regions and loads the region onto the Track all the while displaying a progress information to the user.
14000 </p>
14001
14002 <p class="note">
14003   Documenting the bound C++ methods and class hierarchy is somewhere on the ToDo list. Meanwhile <a href="https://github.com/Ardour/ardour/blob/master/libs/ardour/luabindings.cc">luabindings.cc</a> is the best we can offer.
14004 </p>
14005
14006 <h2>Concepts</h2>
14007
14008 <ul>
14009         <li>There are no bound constructors: Lua asks Ardour to create objects (e.g. add a new track), then receives a reference to the object to modify it.</li>
14010         <li>Scripts, once loaded, are saved with the Session (no reference to external files). This provides for portable Sessions.</li>
14011         <li>Lua Scripts are never executed directly. They provide a "factory" method which can have optional instantiation parameters, which returns a lua closure.</li>
14012         <li>No external lua modules/libraries can be used, scripts need to be self contained (portable across different systems (libs written in Lua can be used, and important c-libs/functions can be included with ardour if needed).</li>
14013 </ul>
14014
14015 <p>
14016   Ardour is a highly multithreaded application and interaction between the different threads, particularly real-time threads, needs to to be done with care. This part has been abstracted away by providing separate Lua interpreters in different contexts and restricting available interaction:
14017 </p>
14018
14019 <ul>
14020         <li>Editor Actions run in a single instance interpreter in the GUI thread.</li>
14021         <li>Editor Hooks connect to libardour signals. Every Callback uses a dedicated lua interpreter which is in the GUI thread context.</li>
14022         <li>All Session scripts run in a single instance in the main real-time thread (audio callback)</li>
14023         <li>DSP scripts have a separate instance per script and run in one of the DSP threads.</li>
14024 </ul>
14025
14026 <p>
14027   The available interfaces differ between contexts. e.g. it is not possible to create new tracks or import audio from real-time context; while it is not possible to modify audio buffers from the GUI thread.
14028 </p>
14029
14030 <h2>Current State</h2>
14031
14032 <p>Fully functional, yet still in a prototyping stage:</p>
14033
14034 <ul>
14035         <li>The GUI to add/configure scripts is rather minimalistic.</li>
14036         <li>The interfaces may change (particularly DSP, and Session script <code>run()</code>.</li>
14037         <li>Further planned work includes:
14038                 <ul>
14039                         <li>Built-in Script editor (customize/modify Scripts in-place)</li>
14040                         <li>convenience methods (wrap more complex Ardour actions into a library). e.g set plugin parameters, write automation lists from a lua table</li>
14041                         <li>Add some useful scripts and more examples</li>
14042                         <li>Documentation (Ardour API), also usable for tab-exansion, syntax highlighting</li>
14043                         <li>bindings for GUI Widgets (plugin UIs, message boxes, etc)</li>
14044                 </ul>
14045                 <li>
14046 </ul>
14047
14048 <h2>Examples</h2>
14049
14050 <p>
14051   Apart from the <a href="https://github.com/Ardour/ardour/tree/master/scripts">scripts included with the source-code</a> here are a few examples without further comments...
14052 </p>
14053
14054 <h3>Editor Console Examples</h3>
14055
14056 <div>
14057 <pre><code class="lua">
14058 print (Session:route_by_remote_id(1):name())
14059
14060 a = Session:route_by_remote_id(1);
14061 print (a:name());
14062
14063 print(Session:get_tracks():size())
14064
14065 for i, v in ipairs(Session:unknown_processors():table()) do print(v) end
14066 for i, v in ipairs(Session:get_tracks():table()) do print(v:name()) end
14067
14068 for t in Session:get_tracks():iter() do print(t:name()) end
14069 for r in Session:get_routes():iter() do print(r:name()) end
14070
14071
14072 Session:tempo_map():add_tempo(ARDOUR.Tempo(100,4), Timecode.BBT_TIME(4,1,0))
14073
14074
14075 Editor:set_zoom_focus(Editing.ZoomFocusRight)
14076 print(Editing.ZoomFocusRight);
14077 Editor:set_zoom_focus(1)
14078
14079
14080 files = C.StringVector();
14081 files:push_back("/home/rgareus/data/coding/ltc-tools/smpte.wav")
14082 pos = -1
14083 Editor:do_import(files, Editing.ImportDistinctFiles, Editing.ImportAsTrack, ARDOUR.SrcQuality.SrcBest, pos, ARDOUR.PluginInfo())
14084
14085 #or in one line:
14086 Editor:do_import(C.StringVector():add({"/path/to/file.wav"}), Editing.ImportDistinctFiles, Editing.ImportAsTrack, ARDOUR.SrcQuality.SrcBest, -1, ARDOUR.PluginInfo())
14087
14088 # called when a new session is loaded:
14089 function new_session (name) print("NEW SESSION:", name) end
14090
14091
14092 # read/set/describe a plugin parameter
14093 route = Session:route_by_remote_id(1)
14094 processor = route:nth_plugin(0)
14095 plugininsert = processor:to_insert()
14096
14097 plugin = plugininsert:plugin(0)
14098 print (plugin:label())
14099 print (plugin:parameter_count())
14100
14101 x = ARDOUR.ParameterDescriptor ()
14102 _, t = plugin:get_parameter_descriptor(2, x) -- port #2
14103 paramdesc = t[2]
14104 print (paramdesc.lower)
14105
14106 ctrl = Evoral.Parameter(ARDOUR.AutomationType.PluginAutomation, 0, 2)
14107 ac = plugininsert:automation_control(ctrl, false)
14108 print (ac:get_value ())
14109 ac:set_value(1.0, PBD.GroupControlDisposition.NoGroup)
14110
14111 # the same using a convenience wrapper:
14112 route = Session:route_by_remote_id(1)
14113 proc = t:nth_plugin (i)
14114 ARDOUR.LuaAPI.set_processor_param (proc, 2, 1.0)
14115
14116 </code></pre>
14117 </div>
14118
14119 <h3>Commandline Session</h3>
14120
14121 <p>
14122   The standalone tool <code>luasession</code> allows one to access an Ardour session directly from the commandline. Interaction is limited by the fact that most actions in Ardour are provided by the Editor GUI.
14123 </p>
14124
14125 <p>
14126   <code>luasession</code> provides only two special functions <code>load_session</code> and <code>close_session</code> and exposes the <code>AudioEngine</code> instance as global variable.
14127 </p>
14128
14129 <div>
14130 <pre><code class="lua">
14131 for i,_ in AudioEngine:available_backends():iter() do print (i.name) end
14132
14133 backend = AudioEngine:set_backend("ALSA", "", "")
14134 print (AudioEngine:current_backend_name())
14135
14136 for i,_ in backend:enumerate_devices():iter() do print (i.name) end
14137
14138 backend:set_input_device_name("HDA Intel PCH")
14139 backend:set_output_device_name("HDA Intel PCH")
14140
14141 print (backend:buffer_size())
14142 print (AudioEngine:get_last_backend_error())
14143
14144 s = load_session ("/home/rgareus/Documents/ArdourSessions/lua2/", "lua2")
14145 s:request_transport_speed (1.0)
14146 print (s:transport_rolling())
14147 s:goto_start()
14148 close_session()
14149
14150 </code></pre>
14151 </div>
14152
14153 ---
14154 title: Class Reference
14155 include: class_reference.html
14156 exclude: yes
14157 part: subchapter
14158 ---
14159
14160
14161 ---
14162 title: Appendix
14163 part: part
14164 ---
14165
14166
14167 ---
14168 title: List of Menu Actions
14169 part: chapter
14170 include: menu-actions-list.html
14171 ---
14172