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