]> Shamusworld >> Repos - ardour-manual/blob - include/preferences.html
Regrouped all the session properties in one page (as for the Preferences)
[ardour-manual] / include / preferences.html
1 <figure class="right">
2   <img src="/images/preferences.png" alt="The Preferences window">
3   <figcaption>
4     The Preferences window
5   </figcaption>
6 </figure>
7
8 <p>
9   Global <dfn>preferences</dfn> control general workflow and system
10   configuration, and should apply to all sessions. They are located in <kbd
11   class="menu">Edit &gt; Preferences</kbd> and stored in Ardour's <dfn>user
12   configuration file</dfn> in the user's home directory.
13 </p>
14
15 <p>
16         Preferences are conveniently grouped by category:
17 </p>
18
19 <ul>
20         <li><a href="#general">General</a></li>
21         <li><a href="#editor">Editor</a></li>
22         <li><a href="#mixer">Mixer</a></li>
23         <li><a href="#signal_flow">Signal Flow</a></li>
24         <li><a href="#audio">Audio</a></li>
25         <li><a href="#midi">MIDI</a></li>
26         <li><a href="#metronome">Metronome</a></li>
27         <li><a href="#metering">Metering</a></li>
28         <li><a href="#transport">Transport</a></li>
29         <li><a href="#sync">Sync</a></li>
30         <li><a href="#control_surfaces">Control Surfaces</a></li>
31         <li><a href="#midi_ports">MIDI Ports</a></li>
32         <li><a href="#plugins">Plugins</a></li>
33         <li><a href="#appearance">Appearance</a></li>
34         <li><a href="#video">Video</a></li>
35 </ul>
36
37 <h2 id="general">General</h2>
38
39 <ul>
40   <li>
41     <dfn>DSP CPU Utilization</dfn>
42     <ul>
43       <li>
44         <dfn>Signal processing uses:</dfn> sets how many cpu processors can be
45           used to do signal processing. It can be set to use one up to all
46           processors.
47       </li>
48     </ul>
49   </li>
50   <li>
51     <dfn>Memory Usage</dfn>
52     <ul>
53       <li>
54         <dfn>Waveform image cache (megabytes):</dfn> sets the maximum amount of ram that
55         can be used to store the images representing the waveforms in the editor. Past
56         this amount, the images will be regenerated when needed, which can significantly
57         decrease the system's performance.
58       </li>
59     </ul>
60   </li>
61   <li>
62     <dfn>Engine</dfn>
63     <ul>
64       <li>
65         <dfn>Try to auto-launch audio/midi engine</dfn> allows Ardour to try to
66         automatically launch the audio and MIDI system, driver and device, thus not
67         showing the <a href="@@newopen-session-dialog">Audio/MIDI Setup</a> dialog. This
68         can save a little time if the system is always used the same way.
69       </li>
70     </ul>
71   </li>
72   <li>
73     <dfn>Automation</dfn>
74     <ul>
75       <li>
76           <strong>Thinning factor</strong> ranges from 0 to 1000 with larger
77           values sending fewer automation changes. Thinning is like lossy
78           audio compression, removing data that is less likely to be noticed,
79           although the more is removed, the more likely the loss will be noticed.
80           The advantage to thinning is reduced CPU usage.
81             </li>
82       <li>
83                   <strong>Automation sampling interval</strong> ranges from 1 to
84           1000&nbsp;ms. Determines how frequently the automation input is
85           sampled. The shorter the interval the higher the accuracy but also
86           the higher the CPU requirements.
87       </li>
88     </ul>
89   </li>
90   <li>
91     <dfn>Tempo</dfn>
92     <ul>
93       <li>
94         <dfn>Allow non quarter-note pulse</dfn>: by default, Ardour understands the <a
95         href="@@tempo-and-meter">tempo</a> as the number of quarter notes in a minute.
96         Checking this option allows to set the tempo based on any division of the note,
97         from whole to 1/128th. This is reflected in the <kbd class="menu">Edit
98         Tempo</kbd> window (accessed by double clicking a tempo marker) that shows a
99         "Pulse" menu when this option is checked.
100       </li>
101     </ul>
102   </li>
103   <li>
104     <dfn>GUI Lock</dfn>
105     <ul>
106       <li>
107         <dfn>Lock timeout (seconds):</dfn>locks the <abbr title="Graphical User
108         Interface">GUI</abbr> after this many idle seconds (zero being 'never lock').
109         The GUI can also be locked with <kbd class="menu">Session &gt; Lock</kbd>. When
110         locked, a dialog will display a &quot;Click to unlock&quot; button.
111       </li>
112     </ul>
113   </li>
114 </ul>
115
116 <h3 id="session">Session</h3>
117
118 <ul>
119   <li>
120     <dfn>Undo</dfn> defines the behaviour of the Undo operations:
121     <ul>
122       <li>
123          <strong>Limit undo history</strong> sets how many commands can be
124                undone using <kbd class="mod1">Z</kbd> or <kbd class="menu">Edit &gt; Undo</kbd>.
125          Unchecking will keep an endless memory of operations to undo, at the
126          expense of memory.
127       </li>
128       <li>
129                <strong>Save undo history</strong> sets how many commands are saved so
130                they are available to be undone after reopening the session. This can
131          also be unchecked to keep all actions undoable, at the cost of bigger
132          session files.
133       </li>
134       <li>
135                <strong>Verify removal of last capture</strong> when enabled prompts to
136                verify removal the last recording capture when
137                <kbd class="menu">Edit &gt; Remove Last Capture</kbd> is executed.
138       </li>
139     </ul>
140   </li>
141   <li>
142     <dfn>Session Management</dfn>:
143     <ul>
144       <li>
145         <strong>Make periodic backups of the session file</strong> will create
146         a backup session file after changes to the timeline. The backup file is
147         the session name followed by <em>.ardour.bak</em>. The backup can be
148         used to recover from crashes when the session had not been explicitly
149         saved.
150       </li>
151       <li>
152         <strong>Always copy imported files</strong> selects, and then disables
153           changes to, the <em>Copy&nbsp;files to&nbsp;session</em> option in the
154           <a href="@@import-dialog">Add Existing Media</a> dialog.
155       </li>
156       <li>
157         <strong>Default folder for new sessions:</strong> defaults the folder
158           where Ardour will create new session folders. This is used in the
159           <em>Session&nbsp;Setup</em> dialog displayed by
160           <kbd class="menu">Session &gt; New</kbd>.
161       </li>
162       <li>
163         <strong>Maximum number of recent sessions:</strong> determines how many
164           of the last opened sessions shows in the
165           <em>Recent&nbsp;Sessions</em> dialog displayed by
166           <kbd class="menu">Session &gt; Recent</kbd>.
167       </li>
168     </ul>
169   </li>
170 </ul>
171
172 <h3 id="translation">Translation</h3>
173 <ul>
174   <li>
175     <dfn>Internationalization</dfn>
176     <ul>
177       <li>
178         <dfn>Use translations</dfn> sets if Ardour should use a translated
179         version of all the messages. The default (unchecked) is English (US). When
180         checked, and if a language file exists for the system language, this file
181         will be used to translate Ardour.
182       </li>
183     </ul>
184   </li>
185 </ul>
186
187 <h2 id="editor">Editor</h2>
188
189 <ul>
190   <li>
191     <dfn>General</dfn>
192     <ul>
193       <li>
194         <dfn>Snap rubberband to grid</dfn> when
195         enabled uses the grid when <a href="@@select-regions">selecting regions</a>
196         with a rubberband rectangle.
197       </li>
198       <li>
199         <dfn>Prompt for new marker names</dfn> when enabled, popup a dialog
200         when a new <a href="@@working-with-markers">marker</a> is created. This allows
201         markers to be named as they are created.
202       </li>
203       <li>
204         <dfn>Allow dragging of the playhead</dfn>, when enabled, allows
205         dragging the playhead with the mouse in the <strong>Editor</strong> window.
206       </li>
207       <li>
208         <dfn>Playhead dragging speed (%):</dfn> chooses how fast the canvas
209         scrolls when dragging the playhead outside of the visible canvas.
210       </li>
211       <li>
212         <dfn>Limit zooming &amp; summary view to X minutes beyond session extents</dfn>
213         prevents the zoom out both in the editor and the summary, to show anything past
214         the chosen time after the end marker, restraining the vision to only useful
215         content.
216       </li>
217       <li>
218         <dfn>Zoom to mouse position when zooming with scroll wheel</dfn>: by default,
219         Ardour zooms to the <a href="@@edit-point-control">edit point</a>. When this
220         option is checked, and the zoom is done with <kbd class="mod1n"></kbd> + mousewheel,
221         the zoom will happen at the mouse cursor position regardless of the edit point
222         chosen.
223       </li>
224       <li>
225         <dfn>Zoom with vertical drag in rulers</dfn> allows, when checked, to click
226         anywhere in an empty zone of the <a href="@@ruler">ruler</a> zone and drag
227         up to zoom in or down to zoom out.
228       </li>
229       <li>
230         <dfn>Double click zooms to selection</dfn> allows by double clicking, to zoom
231         on the selection, both on the time and tracks axes. If the selection has been
232         done with <kbd class="mod1n"></kbd> or <kbd class="mod3n"></kbd>, then this
233         key should still be pressed when double clicking for this to work, otherwise
234         the first click breaks the group selection.
235       </li>
236       <li>
237         <dfn>Update editor window during drags of the summary</dfn>: when
238         enabled the contents of the editor window will redraw the tracks area
239         as the selection rectangle in the <a href="@@summary">summary</a> area is
240         moved or resized.
241       </li>
242       <li>
243         <dfn>Auto-scroll editor window when dragging near its edges</dfn>
244         when enabled will scroll the editor window automatically when dragging a
245         region. This can make it easier to see where to position the region.
246       </li>
247       <li>
248         <dfn>Show gain envelopes in audio regions:</dfn> sets in which
249         <a href="@@toolbox">modes</a> the gain envelope is displayed in audio regions.
250         The gain envelope is superimposed over the region in the selected modes, and
251         hidden otherwise for a better legibility.
252       </li>
253     </ul>
254   </li>
255
256   <li>
257     <dfn>Editor Behaviour</dfn>
258     <ul>
259       <li>
260         <dfn>Move relevant automation when audio regions are moved</dfn>,
261         when enabled, causes automation data to stay with a region when the
262         region is moved inside the playlist. When disabled, the automation is
263         not affected by movement of regions.
264       </li>
265       <li>
266         <dfn>Ignore Y-axis click position when adding new automation-points</dfn>
267         allows to create new automation points at the x-position of the mouse, without
268         using the Y-position as the value, hence creating a new automation point at
269         its present value.
270       </li>
271       <li>
272         <dfn>Default fade shape:</dfn> sets which <a href="@@create-region-fades-and-crossfades">
273         fade shape</a> is the default.
274       </li>
275       <li>
276         <dfn>Regions in edit groups are edited together:</dfn> sets
277         the criteria to see if editing actions apply to tracks grouped together
278         in an group.
279       </li>
280       <li>
281         <dfn>Layering model:</dfn> Ardour allows <a href="@@layering-display">layering</a>
282         multiple regions in the same track. This selector defines how these layers are
283         managed, either manually or by placing the latest on top.
284       </li>
285       <li>
286         <dfn>After splitting selected regions, select:</dfn> determines which,
287         if any, regions are selected after a split operation. The options are no
288         regions, the regions created by the split, and if more than one region
289         was selected to start with, the existing selection and the new regions.
290       </li>
291     </ul>
292   </li>
293 </ul>
294
295 <h3 id="modifiers">Modifiers</h3>
296
297 <p>
298   This page allows to choose how things are done in the editor. This is a very
299   flexible way for Ardour to match an existing workflow, or speed up the editing
300   process based on the user's most used actions.
301 </p>
302 <p>
303   The <kbd class="menu">Reset to recommended defaults</kbd> button at the bottom
304   provides a way to revert any user made change to its default value.
305 </p>
306
307 <h2 id="mixer">Mixer</h2>
308
309 <ul>
310   <li>
311     <dfn>Solo</dfn> contains settings that affect the use of
312     <a href="@@muting-and-soloing">solo, muting</a>, and
313     <a href="@@panning">panning</a>.
314     <ul>
315       <li>
316         <dfn>Solo controls are Listen controls</dfn>: when enabled, the
317           soloed track is soloed only on the monitor bus, the master fader mix
318           is not affected by the solo. This option can also be set by enabling
319           pre-fader listen or after-fader listen in the <strong>Mixer</strong>
320           monitor section.
321       </li>
322       <li>
323         <dfn>Exclusive solo</dfn> when enabled will only solo the last
324           track selected for solo. Previously soloed tracks will be un-soloed.
325           This setting is also available from the <strong>Mixer</strong> monitor
326           section.
327       </li>
328       <li>
329         <dfn>Show solo muting</dfn> when enabled outlines the mute
330           button on tracks and busses when another track is soloed.
331       </li>
332       <li>
333         <dfn>Soloing overrides muting</dfn> when enabled allows a track
334           to be heard when it is soloed while muted. This setting is also
335           available from the <strong>Mixer</strong> monitor section.
336       </li>
337       <li>
338         <dfn>Solo-in-place mute cut (dB):</dfn> sets the attenuation of
339           the other tracks when another track is soloed in place. This setting
340           is also available from the <strong>Mixer</strong> monitor section. The
341         default is "&minus;inf" for &minus;&infin;, meaning the other tracks are
342         totally muted.
343       </li>
344       <li>
345         <dfn>Listen Position:</dfn> determines what is listened to when
346           the solo controls are used as listen controls. The options are
347           after-fader or pre-fader.
348       </li>
349       <li>
350         <dfn>PFL signals come from:</dfn> determines whether the
351           pre-fader listen position is before or after the pre-fader processors.
352       </li>
353       <li>
354         <dfn>AFL signals come from:</dfn> determines whether the
355           after-fader listen position is before or after the after-fader
356           processors.
357       </li>
358     </ul>
359   </li>
360
361   <li>
362     <dfn>Default Track / Bus Muting Options</dfn> sets the muting options
363     for a newly created tracks or bus. The mute options for an existing track
364     or bus are changed by the right-click context menu on a mute button.
365     <ul>
366       <li>
367         <dfn>Mute affects pre-fader sends</dfn> when enabled pre-fader
368           sends will be muted by default.
369       </li>
370       <li>
371           <dfn>Mute affects post-fader sends</dfn> when enabled post-fader
372           sends will be muted by default.
373       </li>
374       <li>
375           <dfn>Mute affects control outputs</dfn> when enabled control
376           outputs are muted by default.
377       </li>
378       <li>
379           <dfn>Mute affects main outputs</dfn> when enabled main outputs
380           are muted by default.
381       </li>
382     </ul>
383   </li>
384
385   <li>
386     <dfn>Send Routing</dfn> affects <a href="@@aux-sends">aux and external sends</a>.
387     <ul>
388       <li>
389         <dfn>Link panners of Aux and External Sends with main panner by default</dfn>
390         when enabled, sends follow the channel panner. When disabled, sends can panned
391         independently of the channel panner and fader. Double clicking the send in the
392         processor box toggles the main panner and fader between the aux send and the
393         channel.
394       </li>
395     </ul>
396   </li>
397
398 </ul>
399
400 <h2 id="signal_flow">Signal Flow</h2>
401
402 <ul>
403   <li>
404     <dfn>Monitoring</dfn>
405     <ul>
406       <li>
407         <dfn>Record monitoring handled by:</dfn> determines whether Ardour provides
408         monitoring of incoming audio or whether monitoring is provided by hardware.
409         See <a href="@@monitoring">Monitoring</a> for more information.
410       </li>
411       <li>
412         <dfn>Tape machine mode</dfn> when enabled defaults new audio tracks to
413         tape machine mode. See <a href="@@track-types">Track Types</a> for more
414         information.
415       </li>
416     </ul>
417   </li>
418
419   <li>
420     <dfn>Track and Bus Connections</dfn>
421     <ul>
422       <li>
423         <dfn>Auto-connect main output (master or monitor) bus to physical ports</dfn>
424         auto-connects the outputs to the first N physical ports. In a session without a
425         <a href="@@monitor-section">monitor section</a>, the master-bus is
426         connected to the system's playback ports, and if a monitor section exists,
427         the monitor-bus' output are connected.
428       </li>
429       <li>
430         <dfn>Connect track inputs:</dfn> allows to choose when a new track is
431         created whether its inputs will be automatically connected to the physical
432         inputs of the system or not (hence the user has to manually connect it).
433       </li>
434       <li>
435         <dfn>Connect track and bus outputs:</dfn> allows to choose, for any new
436         track or bus created, whether its output will automatically be connected
437         to the master bus, directly to the physical outputs or to nothing (the
438         user has to manually connect it).
439       </li>
440       <li>
441         <dfn>Use 'Strict-I/O' for new tracks or busses</dfn> determines the default
442         choice for the <a href="@@trackbus-signal-flow">signal flow</a> of a newly created track or bus.
443         This can be overridden in the <a href="@@adding-tracks-busses-and-vcas">
444         Add Track/Bus/VCA</a> dialog
445       </li>
446     </ul>
447   </li>
448 </ul>
449
450 <h2 id="audio">Audio</h2>
451
452 <ul>
453   <li>
454     <dfn>Buffering</dfn> settings determine how many seconds of audio off of disk
455     will be buffered in memory. Longer settings reduce the risk of buffer
456     under-runs but consume more memory.
457     <ul>
458       <li>
459               <dfn>Preset:</dfn> will automatically choose the values for the playback
460         and recording buffer based on the chosen size of the session. The
461         <strong>Custom</strong> option allows to manually select the buffers with
462         the two sliders below.
463       </li>
464       <li>
465               <dfn>Playback (seconds of buffering):</dfn> sets how many seconds of
466         audio Ardour will buffer during playback.
467       </li>
468       <li>
469                <dfn>Recording (seconds of buffering):</dfn> sets how many seconds of
470          audio Ardour will buffer during recording.
471       </li>
472     </ul>
473   </li>
474
475   <li>
476     <dfn>Denormals</dfn> are a specific type of very small numbers that
477     can cause issues with CPU consumption when using some plugins in some
478     circumstances.
479     Ardour provides two methods of handling the issue. Trying different
480     combinations of these settings may minimize CPU consumption.
481     <ul>
482       <li>
483                <dfn>Use DC bias to protect against denormals</dfn> adds a small
484                constant value to numbers to move the numbers away from zero.
485             </li>
486       <li>
487                      <dfn>Processor handling:</dfn>, if the computer's hardware
488                supports it, offers two methods that can be used individually or
489                combined. Flush to zero and denormals are zero.
490       </li>
491     </ul>
492   </li>
493
494   <li>
495     <dfn>Regions</dfn>
496     <ul>
497       <li>
498         <dfn>Enable automatic analysis of audio</dfn> generates the transient
499         values (used in e.g. the <a href="@@rhythm-ferret">Rhythm Ferret</a>)
500         automatically. When unchecked, the transient values will be generated
501         on demand.
502       </li>
503       <li>
504         <dfn>Replicate missing region channels</dfn>: if a track is N-channel,
505         and the region has fewer channels, this option copies the existing
506         channel's data for this non-existent one. If left unchecked, the missing
507         channels will stay silent.
508       </li>
509     </ul>
510   </li>
511 </ul>
512
513 <h2 id="midi">MIDI</h2>
514
515 <ul>
516   <li>
517     <dfn>Buffering</dfn>
518     <ul>
519       <li>
520         <dfn>MIDI read-ahead time (seconds):</dfn> defines how much time of MIDI data
521         must be read in advance by Ardour and put in the buffer. More time means more
522         stability while playing back, at the expense of more time to buffer the data.
523         This should be set to a low value for a reasonably capable machine.
524       </li>
525     </ul>
526   </li>
527
528   <li>
529     <dfn>Session</dfn>
530     <ul>
531       <li>
532         <dfn>Initial program change:</dfn> Ardour will send a MIDI program
533         change message on the <code>ardour:MMC out</code> JACK port when a session
534         is loaded and whenever this field is changed. A value of -1 means don't
535         send any program change message.
536       </li>
537     </ul>
538   </li>
539
540   <li>
541     <dfn>Audition</dfn>
542     <ul>
543       <li>
544         <dfn>Sound MIDI notes as they are selected in the editor</dfn> will play
545         any selected or added MIDI note when in Draw or Internal Edit modes. The
546         note is sent as MIDI as if Ardour was playing it withe the session, so the
547         processors and signal routing will be applied.
548       </li>
549       <li>
550         <dfn>Midi Audition Synth (LV2):</dfn> allows to select in the list of LV2
551         instruments, which one will be used to audition MIDI when e.g. in the
552         <a href="@@import-dialog">import dialog</a>.
553       </li>
554     </ul>
555   </li>
556 </ul>
557
558 <h2 id="metronome">Metronome</h2>
559
560 <ul>
561   <li>
562     <dfn>Metronome</dfn> handles the way Ardour's metronome is played when
563     enabled in the <a href="@@transport-bar">Transport Bar</a>.
564     <ul>
565       <li>
566         <dfn>Emphasis on first beat</dfn> plays a different sound when the first
567         beat is played (e.g. 1/4 in 4/4, 1/3 in 3/4,&hellip;). When unchecked, all
568         the beats are indistinguishable.
569       </li>
570       <li>
571         <dfn>Use built-in default sounds</dfn> when checked, uses Ardour's own
572         sounds for the metronome click. Unchecking this allows to set some custom
573         sounds below.
574       </li>
575       <li>
576         <dfn>Audio file:</dfn> selects an audio file for the beats, in any
577         <a href="@@supported-file-formats">format</a> Ardour supports.
578       </li>
579       <li>
580         <dfn>Emphasis audio file:</dfn> in conjunction with
581         <kbd class="option">Emphasis on first beat</kbd>, selects an audio file
582         for the first beats of each bar.
583       </li>
584       <li>
585         <dfn>Gain level:</dfn> allows the metronome's click sounds to be boosted
586         or attenuated.
587       </li>
588     </ul>
589   </li>
590
591   <li>
592     <dfn>Options</dfn>
593     <ul>
594       <li>
595         <dfn>Enable Metronome only while recording</dfn>: when enabled, the
596         metronome will remain silent unless Ardour is recording.
597       </li>
598     </ul>
599   </li>
600 </ul>
601
602 <h2 id="metering">Metering</h2>
603
604 <ul>
605   <li>
606     <dfn>Metering</dfn>
607     <ul>
608       <li>
609         <dfn>Peak hold time:</dfn> allows the meter to keep displaying the highest
610         signal level for a period of time before reverting to showing the actual
611         instantaneous value (unless an even higher peak occurs). The longer this
612         time is, the easier it is to spot peaks, at the expense of instantaneous
613         accuracy.
614       </li>
615       <li>
616         <dfn>DPM fall-off:</dfn> describes how fast the Digital Peak Meters can
617         go from a high value to a lower one. Faster values are more accurate but
618         less readable.
619       </li>
620       <li>
621         <dfn>Meter line-up level; 0&nbsp;dBu:</dfn> chooses a standard for the
622         conversion between dBFS (Full Scale) which represent the numeric signal
623         level, and dBu which represents the analog signal level. This value is used
624         to configure meter-marks and color knee-points, or set the reference levels
625         for various meter-types.
626       </li>
627       <li>
628         <dfn>IEC1/DIN Meter line-up level; 0&nbsp;dBu:</dfn> sets the reference
629         level for the IEC1/DIN Meter
630       </li>
631       <li>
632         <dfn>VU Meter standard:</dfn> selects which standard to use for the zero
633         value of the vu-meters, i.e. the analog dBu value that will show as 0 on the
634         VU-meter.
635       </li>
636       <li>
637         <dfn>Peak indicator threshold [dBFS]:</dfn> at that value and over, the
638         signal will make the peak meter to turn red, indicating a level too high.
639       </li>
640     </ul>
641   </li>
642
643   <li>
644     <dfn>Default Meter Types</dfn> sets the default meters when creating a session
645     or track. These meters can be changed afterwards by
646     <kbd class="mouse">right</kbd>-clicking a meter.
647     <ul>
648       <li>
649         <dfn>Default Meter Type for Master Bus:</dfn> defines which kind of
650         <a href="@@metering-in-ardour">meter</a> will be used when creating a new
651         session (does not apply to the current session).
652       </li>
653       <li>
654         <dfn>Default Meter Type for busses:</dfn> defines which kind of
655         meter will be used when creating a new bus (applies to the bus created
656         after changing the value).
657       </li>
658       <li>
659         <dfn>Default Meter Type for tracks:</dfn> same as above, for tracks.
660       </li>
661     </ul>
662   </li>
663
664   <li>
665     <dfn>Post Export Analysis</dfn>
666     <ul>
667       <li>
668         <dfn>Save loudness analysis as image file</dfn> allows, when the
669         <kbd class="option">Analyze Exported Audio</kbd> is checked in the
670         <a href="@@export-dialog">Export dialog</a>, to save the analysis graph
671         as a file named <code>session.png</code> alongside the exported audio
672         file(s) (in the same folder).
673       </li>
674     </ul>
675   </li>
676 </ul>
677
678 <h2 id="transport">Transport</h2>
679
680 <ul>
681   <li>
682     <dfn>General</dfn>
683     <ul>
684       <li>
685         <dfn>Stop at the end of the session</dfn> causes the transport to
686         stop during playback when it reaches the end marker. Behavior during
687         recording is not changed.
688       </li>
689       <li>
690         <dfn>Keep record-enable engaged on stop</dfn> leaves the global
691         record-enable engaged after transport is stopped.  Does not affect track
692         level record-enable which is never changed on stop.
693       </li>
694       <li>
695         <dfn>Disable per-track record disarm while rolling</dfn>, when
696         enabled, will not allow the any track's record-enable to be disarmed
697         during record, preventing accidentally stopping the recording of a take.
698       </li>
699       <li>
700         <dfn>12dB gain reduction during fast-forward and fast-rewind</dfn>
701         when enabled will reduce the unpleasant increase in perceived volume
702         that occurs when fast-forwarding or rewinding through some kinds of audio.
703       </li>
704       <li>
705         <dfn>Preroll:</dfn> sets the duration of the preroll for playing and
706         recording when using a preroll. Can be a musical duration (in bars) or a
707         duration in seconds.
708       </li>
709     </ul>
710   </li>
711
712   <li>
713     <dfn>Looping</dfn>
714     <ul>
715       <li>
716         <dfn>Play loop is a transport mode</dfn> changes the behavior of the
717         loop button, turning it into a toggle. When enabled, the loop button does
718         not start playback but forces playback to always play the loop. Looping
719         stays engaged when the transport is stopped. Playback continues where the
720         transport stopped and continues to loop. When disabled, the loop button
721         starts playing the loop but stop then cancels loop playback.
722       </li>
723       <li>
724         <dfn>Do seamless looping</dfn> removes any clicks that might
725         otherwise be audible when the transport moves from the end of the loop
726         range back to the beginning.
727       </li>
728     </ul>
729   </li>
730
731   <li>
732     <dfn>Dropout (xrun) Handling</dfn>
733     <ul>
734       <li>
735         <dfn>Stop recording when an xrun occurs</dfn> will stop the transport
736         when an xrun occurs during recording, ensuring no audible glitches are
737         recorded.
738       </li>
739       <li>
740         <dfn>Create markers where xruns occur</dfn> will create a new
741         <a href="@@working-with-markers">marker</a> when an xrun occurs during
742         recording at the location of the xrun. This marks where possible xruns
743         might produce audible glitches.
744       </li>
745     </ul>
746   </li>
747 </ul>
748
749 <h2 id="sync">Sync</h2>
750
751 <ul>
752   <li>
753     <dfn>External Synchronization</dfn>
754     <ul>
755       <li>
756         <dfn>External timecode source</dfn> determines which external source to
757         use when Ardour is using an external
758         <a href="@@working-with-synchronization">synchronization</a> source.
759         Depending on the timecode source chosen, the additional preference options
760         below are available.
761       </li>
762       <li>
763         <dfn>Match session video frame rate to external timecode</dfn>
764             controls the value of the video frame rate <em>while chasing</em>
765             an external timecode source. When enabled, the session video frame rate will be
766         changed to match that of the selected external timecode source. When disabled,
767         the session video frame rate will not be changed to match that of the selected
768         external timecode source. Instead, the frame rate indication in the main clock
769         will flash red and Ardour will convert between the external timecode standard
770         and the session standard.
771       </li>
772       <li>
773         <dfn>Sync-lock timecode to clock (disable drift compensation)</dfn>
774             When enabled, Ardour will never varispeed when slaved to external
775             timecode. Sync Lock indicates that the selected external timecode
776             source shares clock-sync (Black &amp; Burst, Wordclock, etc) with
777             the audio interface. This options disables drift compensation.
778             The transport speed is fixed at 1.0. Vari-speed LTC will be ignored
779             and cause drift. When disabled, Ardour will compensate for potential
780         drift regardless if the timecode sources shares clock sync.
781           </li>
782           <li>
783             <dfn>Lock to 29.9700 fps instead of 30000/1001</dfn>, when
784             enabled, will force Ardour to assume the external timecode source
785             uses 29.97 fps instead of 30000/1001.
786             SMPTE 12M-1999 specifies 29.97&nbsp;df as 30000/1001. The spec
787             further mentions that drop-frame timecode has an accumulated error
788             of -86&nbsp;ms over a 24&nbsp;hour period. Drop-frame timecode would
789             compensate exactly for an NTSC color frame rate of 30 &times; 0.9990 (i.e.
790             29.970000). That is not the actual rate. However, some vendors use
791             that rate&mdash;despite it being against the specs&mdash;because the
792             variant of using exactly 29.97&nbsp;fps has zero timecode drift.
793       </li>
794     </ul>
795   </li>
796 </ul>
797
798 <h3 id="ltc">LTC</h3>
799
800 <ul>
801   <li>
802     <dfn>Linear Timecode (LTC) Reader</dfn>
803     <ul>
804       <li>
805         <dfn>LTC incoming port:</dfn> specifies which physical incoming port of
806         the system will provide the LTC signal.
807       </li>
808     </ul>
809   </li>
810
811   <li>
812     <dfn>Linear Timecode (LTC) Generator</dfn>
813     <ul>
814       <li>
815         <dfn>Enable LTC generator</dfn> when enabled Ardour will
816         output an LTC timecode signal on its <em>LTC-out</em> port.
817         If this option is checked, the two options below are active:
818       </li>
819       <li>
820         <dfn>Send LTC while stopped</dfn>, when enabled Ardour will
821         continue to send LTC information even while the transport (playhead) is
822         not moving.
823       </li>
824       <li>
825         <dfn>LTC generator level [dBFS]:</dfn> specifies the peak volume of
826         the generated LTC signal in dbFS. A good value is 0dBu&equals;&minus;18dbFS
827         in an EBU calibrated system.
828       </li>
829     </ul>
830   </li>
831 </ul>
832
833 <h3 id="sync_midi">MIDI</h3>
834
835 <ul>
836   <li>
837     <dfn>MIDI Beat Clock (Mclk) Generator</dfn>
838     <ul>
839       <li>
840         <dfn>Enable Mclk generator</dfn> when enabled Ardour will generate a
841         (tempo dependant) beat clock at a rate of 24 pulses per quarter note on
842         the <code>ardour:MIDI clock out</code> JACK port.
843       </li>
844     </ul>
845   </li>
846
847   <li>
848     <dfn>MIDI Time Code (MTC) Generator</dfn>
849     <ul>
850       <li>
851         <dfn>Enable MTC Generator</dfn> when enabled Ardour will generate MIDI
852         time code on the <code>ardour:MTC out</code> JACK port.
853       </li>
854       <li>
855         <dfn>Percentage either side of normal transport speed to transmit MTC:</dfn>
856         MIDI time code generation will be disabled when the transport speed is
857         greater than normal speed plus this percentage or less than normal minus
858         this percentage.
859       </li>
860     </ul>
861   </li>
862
863   <li>
864     <dfn>MIDI Machine Control (MMC)</dfn>
865     <ul>
866       <li>
867         <dfn>Respond to MMC commands</dfn> when enabled Ardour will respond
868         to MIDI Machine Control commands received on the <code>ardour:MMC in</code>
869         JACK port.
870       </li>
871       <li>
872         <dfn>Send MMC commands</dfn> when enabled Ardour will send MIDI Machine
873         Control commands on the <code>ardour:MMC out</code>
874         JACK port.
875       </li>
876       <li>
877         <dfn>Inbound MMC device ID:</dfn> is the only device ID Ardour will
878         respond to when an MMC command is received on the <code>ardour:MMC in</code>
879         JACK port.
880       </li>
881       <li>
882         <dfn>Outbound MMC device ID:</dfn> is the MIDI device ID Ardour will
883         use when it sends MMC commands.
884       </li>
885     </ul>
886   </li>
887 </ul>
888
889 <h2 id="control_surfaces">Control Surfaces</h2>
890
891 <p>
892   This tab contains settings for <a href="@@control-surfaces">control surfaces</a>.
893 </p>
894 <p>
895   It lists all the Control Surface protocols Ardour knows. To enable a
896   <dfn>Control Surface Protocol</dfn>, the <kbd class="option">Enable</kbd> checkbox
897   next to its name should be ticked. Editing the settings related to this protocol
898   can be done by double-clicking its name or clicking the <kbd class="menu">Show
899   protocol settings</kbd> (only for Generic MIDI and Open Sound Control).
900 </p>
901
902 <h2 id="midi_ports">MIDI Ports</h2>
903
904 <ul>
905   <li>
906     <dfn>MIDI Port Options</dfn>
907     <ul>
908       <li>
909         <dfn>MIDI input follows MIDI track selection</dfn> allows Ardour to automatically
910         connect the MIDI input to the selected track. Selecting a different MIDI
911         track results in Ardour disconnecting the MIDI device from the former track
912         and connecting it to the newly selected one, so that the MIDI device is
913         always connected to the selected track. Which MIDI device will follow
914         selection can be chosen below.
915       </li>
916     </ul>
917   </li>
918
919   <li>
920     <dfn>MIDI Inputs</dfn> This is a list of all the MIDI devices connected as
921     inputs (capture devices) to Ardour. For each devices, there are 3 checkboxes:
922     <ul>
923       <li>
924         <dfn>Music Data</dfn> if checked, Ardour will consider this device as a source
925         for musical data input (notes, etc&hellip;)
926       </li>
927       <li>
928         <dfn>Control Data</dfn> if checked, Ardour will consider this device as a source
929         for control data input (play/stop, etc&hellip;)
930       </li>
931       <li>
932         <dfn>Follow selection</dfn> if the above
933         <kbd class="option">MIDI input follows MIDI track selection</kbd> is
934         checked, Ardour will make this device follow track selection.
935       </li>
936     </ul>
937   </li>
938
939   <li>
940     <dfn>MIDI Outputs</dfn> This is a list of all the MIDI devices connected as
941     outputs (playback devices) to Ardour. For each devices, there are 2 checkboxes:
942     <ul>
943       <li>
944         <dfn>Music Data</dfn> if checked, Ardour will consider this device as a target
945         for musical data output (notes, etc&hellip;)
946       </li>
947       <li>
948         <dfn>Control Data</dfn> if checked, Ardour will take this device as a target
949         for control data output (play/stop, etc&hellip;)
950       </li>
951     </ul>
952   </li>
953 </ul>
954
955 <h2 id="plugins">Plugins</h2>
956
957 <p class="note">
958   The content of this preference page varies heavily between versions or Ardour:
959   both the platform and the build-time options can make Ardour support some types
960   of plugins and not others. While this documentation tries to show all possible
961   options, most systems will only show a subset of the options hereunder, e.g.
962   AudioUnits are macOS only&hellip;
963 </p>
964
965 <ul>
966   <li>
967     <dfn>Scan/Discover</dfn>
968     <ul>
969       <li>
970         <dfn>Scan for Plugins</dfn> will initiate an immediate scan of the system
971         for available plugins. Useful to get a newly installed plugin recognised
972         by Ardour.
973       </li>
974     </ul>
975   </li>
976
977   <li>
978     <dfn>General</dfn>
979     <ul>
980       <li>
981         <dfn>Always Display Plugin Scan Progress</dfn> When enabled a
982         popup window showing plugin scan progress is displayed for indexing
983         (cache load) and discovery (detect new plugins).
984       </li>
985       <li>
986         <dfn>Silence plugins when the transport is stopped</dfn> when stopping
987         playback or recording, if this option is checked, the plugins that still
988         emit sound (reverbs, etc&hellip;) will be stopped. If unchecked, the plugins
989         will continue playing after the transport stop.
990       </li>
991       <li>
992         <dfn>Make new plugins active</dfn> when enabled, any plugin added to a track
993         will be in active mode. If unchecked, the plugins will be added in inactive
994         mode by default, hence have no processing effect on the track/bus.
995       </li>
996       <li>
997         <dfn>Limit automatable parameters per plugin</dfn>: as some plugins
998         (synthesizers, &hellip;) have a lot of parameters, and those parameters
999         can be automated by Ardour, checking this will limit the number of parameters
1000         that are listed as automatable, hence making the lists shorter and the GUI
1001         more responsive.
1002       </li>
1003     </ul>
1004   </li>
1005
1006   <li>
1007     <dfn>Plugin GUI</dfn>
1008     <ul>
1009       <li>
1010         <dfn>Automatically open the plugin GUI when adding a new plugin</dfn>
1011         shows the plugins GUI as soon as it is added to the processing box. If
1012         unchecked, the plugin will be added in the processor box but the GUI will
1013         only be shown when <kbd class="mouse">double clicking</kbd> it.
1014       </li>
1015       <li>
1016         <dfn>Show Plugin Inline Display on Mixer strip by default</dfn> allows Ardour
1017         to show, in the <a href="@@audiomidi-mixer-strips">mixer strips</a>, a
1018         visual rendering of the effect. These Inline Display are a special feature
1019         of Ardour, so not all plugins are able to show this display. Most of Ardour's
1020         <a href="@@plugins-bundled-with-ardour">own plugins</a> have an Inline Display.
1021         At any time, the plugin's Inline Display can be toggled on or off by
1022         <kbd class="mod3n"></kbd>double-clicking it.
1023       </li>
1024       <li>
1025         <dfn>Don't automatically open the plugin GUI when the plugin has an inline
1026         display mode</dfn>: this option, available only if
1027         <kbd class="option">Automatically open the plugin GUI when adding a new plugin</kbd>
1028         is checked, supercedes it and hides the plugin GUI at creation if it has an
1029         Inline Display, like Ardour's own <code>a-*</code> plugins.
1030       </li>
1031     </ul>
1032   </li>
1033
1034   <li>
1035     <dfn>Instrument</dfn>
1036     <ul>
1037       <li>
1038         <dfn>Ask to replace existing instrument plugin</dfn>: if a MIDI track already
1039         has an instrument (i.e. MIDI to audio converter of some sort) and this
1040         option is checked, Ardour will detect it and offer to replace the existing
1041         instrument with the newly added one, avoiding a possible conflict.
1042       </li>
1043       <li>
1044         <dfn>Interactively configure instrument plugins on insert</dfn>: when inserting
1045         a multichannel instrument plugin, if this option is checked, prompts the
1046         user for the channel configuration for this plugin.
1047       </li>
1048     </ul>
1049   </li>
1050 </ul>
1051
1052 <h3 id="vst">VST</h3>
1053
1054 <ul>
1055   <li>
1056     <dfn>VST</dfn>
1057     <ul>
1058       <li>
1059         <dfn>Enable Mac VST support (requires restart or re-scan)</dfn> makes a
1060         MacOs system able to run VST-Mac plugins. As stated, a new scan for plugins
1061         is required, be it manually or by restarting Ardour.
1062       </li>
1063       <li>
1064         <dfn>Scan for [new] VST Plugins on Application Start</dfn> When
1065           enabled new VST plugins are searched, tested and added to the cache
1066           index on application start. When disabled new plugins will only be
1067           available after triggering a 'Scan' manually.
1068       </li>
1069       <li>
1070         <dfn>Verbose Plugin Scan</dfn>: adds information about the plugin in the
1071         <a href="@@status-bar">Log window</a>.
1072       </li>
1073       <li>
1074         <dfn>Scan Time Out</dfn> Specifies the default timeout for plugin
1075           instantiation. Plugins that require more time to load will be
1076         blacklisted. A value of &infin; disables the timeout.
1077       </li>
1078       <li>
1079         <dfn>VST Cache:</dfn> Clicking the <kbd class="menu">Clear</kbd> button
1080         removes all VST plugins from the list of plugins available to be
1081         inserted into the processor box. A new VST plugin scan is then required.
1082       </li>
1083       <li>
1084         <dfn>VST Blacklist:</dfn> Clicking the <kbd class="menu">Clear</kbd>
1085         button makes blacklisted VST plugins available to be added to the processor
1086         box.
1087       </li>
1088       <li>
1089         <dfn>Linux VST Path:</dfn> Clicking the <kbd class="menu">Edit</kbd> button
1090         pops up a dialog to manage the directories that will be searched for Linux
1091         VST plugins. When modified, Ardour will offer to scan those paths for plugins.
1092       </li>
1093       <li>
1094         <dfn>Path:</dfn> are the paths chosen above.
1095       </li>
1096       <li>
1097         <dfn>Windows VST Path:</dfn> Clicking the <kbd class="menu">Edit</kbd> button
1098         pops up a dialog to manage the directories that will be searched for Windows
1099         VST plugins. When modified, Ardour will offer to scan those paths for plugins.
1100       </li>
1101       <li>
1102         <dfn>Path:</dfn> are the paths chosen above.
1103       </li>
1104     </ul>
1105   </li>
1106 </ul>
1107
1108 <h3 id="audio_unit">Audio Unit</h3>
1109
1110 <ul>
1111   <li>
1112     <dfn>Audio Unit</dfn>
1113     <ul>
1114       <li>
1115         <dfn>Scan for [new] AudioUnit Plugins on Application Start</dfn> When
1116         enabled, new AU plugins are searched, tested and added to the cache
1117         index on application start. When disabled, new plugins will only be
1118         available after triggering a 'Scan' manually.
1119       </li>
1120       <li>
1121         <dfn>AU Cache:</dfn> Clicking the <kbd class="menu">Clear</kbd> button
1122         removes all AU plugins from the list of plugins available to be
1123         inserted into the processor box. A new AU plugins scan is then required.
1124       </li>
1125       <li>
1126         <dfn>AU Blacklist:</dfn> Clicking the <kbd class="menu">Clear</kbd>
1127         button makes blacklisted AU plugins available to be added to the processor
1128         box.
1129       </li>
1130     </ul>
1131   </li>
1132 </ul>
1133
1134 <h2 id="appearance">Appearance</h2>
1135
1136 <ul>
1137   <li>
1138     <dfn>Graphics Acceleration</dfn>
1139     <ul>
1140       <li>
1141         <dfn>Possibly improve slow graphical performance (requires restart)</dfn>
1142         Ardour uses hardware accelerated gradient creation by default for speed.
1143         Sometimes though, a buggy driver can cause this to make the system slow or
1144         unstable. Checking this will make Ardour draw its own gradients without
1145         hardware acceleration, improving stability and responsiveness on those
1146         buggy systems.
1147       </li>
1148     </ul>
1149   </li>
1150
1151   <li>
1152     <dfn>Graphical User Interface</dfn>
1153     <ul>
1154       <li>
1155         <dfn>Highlight widgets on mouseover</dfn>, when checked, makes Ardour's
1156         widgets (buttons, sliders, &hellip;) slightly change color when the mouse
1157         hovers them, visually indicating what a mouse action would interact with.
1158       </li>
1159       <li>
1160         <dfn>Show tooltips if mouse hovers over a control</dfn> when checked,
1161         displays a little help bubble about the control the mouse hovers. The mouse
1162         pointer needs to stay idle for about 1 sec for the tooltip to appear.
1163       </li>
1164       <li>
1165         <dfn>Update clocks at TC Frame rate</dfn>: Ardour updates its clocks every
1166         100&nbsp;ms. Checking this will make the clock refresh at every TimeCode
1167         frame which is more responsive, at the cost of a bit more system stress.
1168       </li>
1169       <li>
1170         <dfn>Blink Rec-Arm buttons</dfn>: when enabled, the record-armed
1171         buttons on tracks will blink when they are armed but not currently recording.
1172         When disabled, the record-armed buttons on tracks will be outlined in red
1173         instead of blinking. The global record-arm button in the
1174         <a href="@@transport-bar">Transport bar</a> is unaffected.
1175       </li>
1176       <li>
1177         <dfn>Blink Alert indicators</dfn>: when enabled, the Alert indicators (like
1178         the <kbd class="menu">Error Log</kbd> or the <kbd class="menu">Feedback</kbd>
1179         button) will blink when they are active (when an error or feedback
1180         has been detected, respectively). When disabled, the indicators will turn red instead of
1181         blinking.
1182       </li>
1183       <li>
1184         <dfn>GUI and Font scaling:</dfn> allows the display size of most of the
1185         text and buttons in the user interface to be scaled up or down. May
1186         require a restart to take effect.
1187       </li>
1188     </ul>
1189   </li>
1190 </ul>
1191
1192 <h3 id="appearance_editor">Editor</h3>
1193
1194 <ul>
1195   <li>
1196     <dfn>General</dfn>
1197     <ul>
1198       <li>
1199         <dfn>Use name highlight bars in region displays (requires a restart)</dfn>:
1200         when enabled, the region name is displayed, in the editor, in its own opaque bar
1201         at the bottom of the region. When disabled, the region name is overlaid
1202         at the top of the region, possibly over audio waveforms or MIDI notes.
1203       </li>
1204       <li>
1205         <dfn>Region color follows track color</dfn>: when enabled,
1206         the background color of regions in the editor will be displayed using
1207         the color assigned to the track. When disabled the default region
1208         background color will be used.
1209       </li>
1210     </ul>
1211   </li>
1212
1213   <li>
1214     <dfn>Waveforms</dfn>
1215     <ul>
1216       <li>
1217         <dfn>Show waveforms in regions</dfn> when enabled shows a visual
1218         representation of the region's audio waveform.
1219       </li>
1220       <li>
1221         <dfn>Show waveform while recording</dfn> when
1222         enabled, will draw the audio waveform in regions being recorded, in near
1223         real time. When disabled, only a region block will be drawn while recording,
1224         reducing CPU requirements.
1225       </li>
1226       <li>
1227         <dfn>Show waveform clipping</dfn>: when enabled the waveform
1228         displayed will show peaks marked in red if they exceed the clip level.
1229       </li>
1230       <li>
1231         <dfn>Waveform Clip Level (dBFS):</dfn> sets the level at which the
1232         waveform shown in an audio region will be drawn in red to indicate
1233         clipping. Setting lower than 0.0&nbsp;dBFS can be useful if any tool in
1234         the audio chain has problems near 0.0&nbsp;dBFS.
1235       </li>
1236       <li>
1237         <dfn>Waveform scale:</dfn> when waveforms are shown in audio regions,
1238         they can be displayed using a <em>linear</em> or a <em>logarithmic</em>
1239         scale. See <a href="@@waveform-display">Waveform display</a>.
1240       </li>
1241       <li>
1242         <dfn>Waveform shape:</dfn> when waveforms are shown in audio regions,
1243         they can be displayed using a <em>traditional</em> or a <em>rectified</em>
1244         shape. See <a href="@@waveform-display">Waveform display</a>.
1245       </li>
1246     </ul>
1247   </li>
1248
1249   <li>
1250     <dfn>Editor Meters</dfn>
1251     <ul>
1252       <li>
1253         <dfn>Show meters in track headers</dfn>, when enabled, shows
1254         a small meter in the Editor's <a href="@@audio-track-controls">track headers</a>.
1255         The meter is shown on the right side area of the header and provides an
1256         instant, if unprecise, view of the levels on this track/bus.
1257       </li>
1258       <li>
1259         <dfn>Limit track header meters to stereo</dfn>: if a track has more than
1260         two outputs (e.g. with a drum plugin), limits the number of meters in the
1261         track header to the first two ones. Only affects audio meters, not MIDI.
1262       </li>
1263     </ul>
1264   </li>
1265
1266   <li>
1267     <dfn>MIDI Regions</dfn>
1268     <ul>
1269       <li>
1270         <dfn>Display first MIDI bank/program as 0</dfn>: when patches and bank changes
1271         are displayed in the editor, if this option is checked, the numbering will
1272         be zero-based instead of one-based, i.e. banks/programs will be numbered
1273         O, 1 ,2&hellip; instead of 1, 2, 3&hellip;
1274       </li>
1275       <li>
1276         <dfn>Don't display periodic (MTC, MMC) SysEx messages in MIDI Regions</dfn>:
1277         if checked, will hide these control messages from the MIDI regions for better
1278         legibility.
1279       </li>
1280     </ul>
1281   </li>
1282 </ul>
1283
1284 <h3 id="appearance_mixer">Mixer</h3>
1285
1286 <ul>
1287   <li>
1288     <dfn>Mixer Strip</dfn>
1289     <ul>
1290       <li>
1291         This table enables (checked) or disables (unchecked) the display of controls
1292         in the <a href="@@audiomidi-mixer-strips">mixer strip</a>. Controls whose
1293         display can be toggled are:
1294         <strong>Input</strong>, <strong>Phase&nbsp;Invert</strong>,
1295         <strong>Record&nbsp;&amp;&nbsp;Monitor</strong>, <strong>Solo&nbsp;Iso/Lock</strong>,
1296         <strong>Output</strong>, <strong>Comments</strong> and VCA Assigns.
1297       </li>
1298       <li>
1299         <dfn>Use narrow strips in the mixer for new strips by default</dfn> When
1300         enabled, new mixer strips are created in narrow format. When disabled,
1301         they are created in wide format. Existing mixer strips width can be toggled
1302         with the width control at the top left of the mixer strip.
1303       </li>
1304     </ul>
1305   </li>
1306 </ul>
1307
1308 <h3 id="toolbar">Toolbar</h3>
1309
1310 <ul>
1311   <li>
1312     <dfn>Main Transport Toolbar Items</dfn>: this section allows to toggle the
1313     visibility of some elements of the main toolbar:
1314     <ul>
1315       <li>
1316         <dfn>Display Record/Punch Options</dfn> toggles the visibility of the
1317         <a href="@@selection-and-punch-clocks#punch_controls">punch and record</a> slice of
1318         the main toolbar.
1319       </li>
1320       <li>
1321         <dfn>Display Monitor Options</dfn> toggles the visibility of the
1322         <a href="@@other-toolbar-items#monitor-options">monitor options</a> slice of
1323         the main toolbar.
1324       </li>
1325       <li>
1326         <dfn>Display Selection Clock</dfn> toggles the visibility of the
1327         <a href="@@selection-and-punch-clocks#selection_clocks">selection clocks</a> slice of
1328         the main toolbar.
1329       </li>
1330       <li>
1331         <dfn>Display Secondary Clock</dfn> toggles the visibility of the
1332         <a href="@@transport-clocks">secondary clocks</a> slice of
1333         the main toolbar.
1334       </li>
1335       <li>
1336         <dfn>Display Navigation Timeline</dfn> toggles the visibility of the
1337         <a href="@@mini-timeline">navigation/mini timeline</a> slice of
1338         the main toolbar.
1339       </li>
1340       <li>
1341         <dfn>Display Master Level Meter</dfn> toggles the visibility of the
1342         <a href="@@other-toolbar-items#mode_selector">selection clocks</a> slice of
1343         the main toolbar.
1344       </li>
1345     </ul>
1346   </li>
1347
1348   <li>
1349     <dfn>Lua Action Script Button Visibility</dfn> enables or disables the visibility
1350     of the four columns of <a href="@@other-toolbar-items#mode_selector">Lua script buttons</a>.
1351     Each columns contains two user-assignable buttons.
1352   </li>
1353 </ul>
1354
1355 <h3 id="theme">Theme</h3>
1356
1357 <ul>
1358   <li>
1359     <dfn>Theme</dfn>
1360     <ul>
1361       <li>
1362         <dfn>Draw &quot;flat&quot; buttons</dfn>: when enabled, button controls
1363         in the user interface will be drawn with a flat look. When disabled button
1364         controls will have a slight 3D appearance.
1365       </li>
1366       <li>
1367         <dfn>LED meter style</dfn> if checked, the bar meters in the editor and
1368         mixer will be styled to look like if they were made of LEDs, with a dotted
1369         bar. Unchecking this option makes the bars flat and continuous.
1370       </li>
1371       <li>
1372         <dfn>Waveforms color gradient depth:</dfn> determines how much gradient
1373         effect is applied to the inner of audio waveforms displayed in the editor.
1374         Values range from 0.0, no gradient effect, to 1.0, maximum effect.
1375       </li>
1376       <li>
1377         <dfn>Timeline item gradient depth:</dfn> Determines how much
1378         gradient effect is applied to the backgrounds of regions displayed in the
1379         editor. Values range from 0.0, no gradient effect, to 1.0, maximum effect.
1380       </li>
1381       <li>
1382         <dfn>Icon Set:</dfn> Changes the mouse cursor icons used to indicate
1383         different tool modes in the editor. An example would be the icons used to
1384         indicate whether the cursor will select a region or change the length of a
1385         region.
1386       </li>
1387     </ul>
1388   </li>
1389 </ul>
1390
1391 <h3 id="colors">Colors</h3>
1392
1393 <ul>
1394   <li>
1395     <dfn>Colors</dfn>
1396     <ul>
1397       <li>
1398         <dfn>Color Theme</dfn> allows to switch between some presets bundled with
1399         Ardour, changing both the palette and items colors, hence styling Ardour
1400         all at once.
1401       </li>
1402       <li>
1403         The table allows to change the color settings in Ardour by acting on three
1404         parameters:
1405         <ul>
1406           <li>
1407             <dfn>Items</dfn> that allow to choose any color from the palette (see below)
1408             to color a UI element. Clicking on a color sample in the <strong>Color</strong>
1409             column bring up the Palette, to choose from.
1410           </li>
1411           <li>
1412             <dfn>Palette</dfn> that allows to create a set of colors that will be used
1413             in the UI. Using a palette allows for better consistency, instead of
1414             picking "free" colors for each UI element. Clicking on a color patch brings
1415             up a full color selector, to assign this color to this patch of the palette.
1416           </li>
1417           <li>
1418             <dfn>Transparency</dfn> where possible, allows to select, with a slider,
1419             the transparency of the UI element, with 0 (slider to the left) being
1420             fully opaque.
1421           </li>
1422         </ul>
1423       </li>
1424       <li>
1425         <dfn>Restore Defaults</dfn> turns all the palette, item colors and transparency
1426         back to Ardour's default base setting, in case Ardour's appearance has turned
1427         into a toddler's toy.
1428       </li>
1429     </ul>
1430   </li>
1431 </ul>
1432
1433 <h3 id="quirks">Quirks</h3>
1434
1435 <ul>
1436   <li>
1437     <dfn>Various Workarounds for Windowing Systems</dfn>: As Ardour is available
1438     on a number of platforms and windowing systems, some specific workarounds are
1439     sometimes required to provide a smooth experience to the user.
1440     <ul>
1441       <li>
1442         <dfn>Use visibility information provided by your Window Manager/Desktop</dfn>
1443         allows the system window manager's rules for the windows visibility to
1444         supercede Ardour's.
1445       </li>
1446       <li>
1447         <dfn>All floating windows are dialogs</dfn>: when enabled, Ardour will
1448         use type &quot;Dialog&quot; for all floating windows instead of using type
1449         &quot;Utility&quot; for some of them. This may help usability with some
1450         window managers. This setting requires a restart of Ardour to take effect.
1451       </li>
1452       <li>
1453         <dfn>Transient windows follow front window.</dfn>: when enabled,
1454         transient windows will follow the front window when toggling between the
1455         editor and mixer. This setting requires a restart of Ardour to take effect.
1456       </li>
1457       <li>
1458         <dfn>Float detached monitor-section window</dfn>: as the <a href="@@monitor-section">
1459         monitor section</a> can be detached from the mixer, this option makes it a
1460         floating window, which may be handled differently by the windowing system
1461         and easier to access.
1462       </li>
1463     </ul>
1464   </li>
1465 </ul>
1466
1467 <h2 id="video">Video</h2>
1468
1469 <ul>
1470   <li>
1471     <dfn>Video Server</dfn>
1472     <ul>
1473       <li>
1474         <dfn>Show Video Export Info before export</dfn> Shows a warning message
1475         when exporting a video about licensing and offers to open the
1476         <a href="@@workflow-amp-operations#export">export video</a> section of
1477         this manual.
1478       </li>
1479       <li>
1480         <dfn>Show Video Server Startup Dialog</dfn>: when using video inside Ardour,
1481         this video is accessed via Xjadeo from a source file through a Video Server.
1482         This options shows the server's startup dialog (useful for debugging a
1483         malfunctioning video).
1484       </li>
1485       <li>
1486         <dfn>Advanced Setup (remote video server)</dfn> can be used when the setup
1487         is more complex than opening a local file with Ardour. The tools used behind
1488         the scene by Ardour allow a lot of flexibility, so for a competent user,
1489         the options below are provided to access a distant file (i.e. on another
1490         machine). The default options for the two following fields ("http://localhost:1554"
1491         and "/") are suitable for local files.
1492       </li>
1493       <li>
1494         <dfn>Video Server URL:</dfn> Base URL of the video server delivering the video
1495         through the network (<code>http://IP-or-address:port</code>).
1496       </li>
1497       <li>
1498         <dfn>Video folder</dfn> is the server's local path to the document-root,
1499         i.e. the files that can be delivered by the server.
1500       </li>
1501     </ul>
1502   </li>
1503
1504   <li>
1505     <dfn>Video Monitor</dfn>
1506     <ul>
1507       <li>
1508         <dfn>Custom Path to Video Monitor (xjadeo) - leave empty for default:</dfn>
1509         Ardour bundles offer xjadeo bundled, so it should run flawlessly. Though,
1510         for custom builds or if a newer version of xjadeo is available, one can
1511         specify a path to the wanted version of xjadeo.
1512       </li>
1513     </ul>
1514   </li>
1515 </ul>