]> Shamusworld >> Repos - ardour-manual/blob - include/session-properties.html
Adding PDF generation
[ardour-manual] / include / session-properties.html
1 <figure class="right">
2   <img src="/images/session_properties.png" alt="The Session Properties window">
3   <figcaption>
4     The Session Properties window
5   </figcaption>
6 </figure>
7
8 <p>
9   <dfn>Session properties</dfn> control aspects of the workflow or
10   configuration that pertain to the current session only; these settings are
11   initially set from the template used to create the session. They can be found
12   in <kbd class="menu">Session &gt; Properties</kbd>, and are stored in the
13   session file.
14 </p>
15
16 <p>
17         Preferences are grouped by category:
18 </p>
19
20 <ul>
21         <li><a href="#properties-timecode">Timecode</a></li>
22         <li><a href="#properties-sync">Sync</a></li>
23         <li><a href="#properties-fade">Fades</a></li>
24         <li><a href="#properties-media">Media</a></li>
25         <li><a href="#properties-locations">Locations</a></li>
26         <li><a href="#properties-filenames">Filenames</a></li>
27         <li><a href="#properties-monitoring">Monitoring</a></li>
28         <li><a href="#properties-meterbridge">Meterbridge</a></li>
29         <li><a href="#properties-misc">Misc</a></li>
30 </ul>
31
32
33
34
35 <h2 id="properties-timecode">Timecode</h2>
36
37 <ul>
38   <li>
39     <dfn>Timecode Settings</dfn>
40     <ul>
41                         <li>
42                                 <dfn>Timecode frames-per-second:</dfn> defines how many frames of
43                                 timecode are in one second. This can differ from the actual frame rate
44                                 depending on the standard used.
45                         </li>
46                         <li>
47                                 <dfn>Pull-up / pull-down:</dfn> sets the speed correction to match one
48                                 actual second, e.g. a 4.1667 pull-up matches a 24fps cinema movie to a
49                                 25 fps PAL TV broadcast format.
50                         </li>
51     </ul>
52         </li>
53         <li>
54                 <dfn>Ext Timecode Offsets</dfn>
55                 <ul>
56                         <li>
57                                 <dfn>Slave Timecode offset:</dfn> when an external timecode source is used,
58                                 adds or substracts the specified offset to the received timecode (MTC or LTC).
59                         </li>
60                         <li>
61                                 <dfn>Timecode Generator offset:</dfn> adds the specified offset to
62                                 the timecode generated by Ardour (so far only LTC) before sending it to
63                                 the external synchronized system.
64                         </li>
65                 </ul>
66   </li>
67   <li>
68                 <dfn>JACK Transport/Time Settings</dfn>
69                 <ul>
70                         <li>
71                                 <dfn>Ardour is JACK Time Master (provides Bar|Beat|Tick and other information
72                                 to JACK)</dfn> Aside from synchronizing any JACK slave, Ardour can also
73                                 provide musical time information (Bar/Beat/Tick) for the current absolute
74                                 position for all the JACK-aware clients (N.B. the first jack client that
75                                 asks for this wins).
76                         </li>
77                 </ul>
78   </li>
79 </ul>
80
81 <h2 id="properties-sync">Sync</h2>
82
83 <ul>
84         <li>
85                 <dfn>A/V Synchronization</dfn>
86                 <ul>
87                         <li>
88                                 <dfn>Use Video File's FPS Instead of Timecode Value for Timeline and Video
89                                 Monitor</dfn> when checked, uses the timecode FPS value of the standard
90                                 used by the video file instead of forcing the FPS set in the <a href="#properties-timecode">
91                                 Timecode tab</a>.
92                         </li>
93                         <li>
94                                 <dfn>Apply Pull-Up/Down to Video Timeline and Video Monitor (Unless using
95                                 JACK-sync)</dfn> allows to apply the pull-up/down as set in the <a href="#properties-timecode">
96                                 Timecode tab</a> to the <a href="@@video-timeline-and-monitoring">video
97                                 timeline</a> as displayed in the editor and to the Video Monitor, resulting
98                                 in a shorter/longer video in the editor and a speed-up/down in the Video
99                                 Monitor.
100                         </li>
101                 </ul>
102         </li>
103 </ul>
104
105 <h2 id="properties-fade">Fades</h2>
106
107 <ul>
108         <li>
109                 <dfn>Audio Fades</dfn>
110                 <ul>
111                         <li>
112                                 <dfn>Destructive crossfade length:</dfn> sets the duration of the crossfade
113                                 Ardour automatically creates when an operation on a region is destructive,
114                                 such as when recording in a track in tape mode.<br>
115                                 This does not change the length of the crossfade Ardour automatically creates
116                                 at regions boundaries on non-destructive operations (recording, slicing etc...)
117                                 which is set to 1&nbsp;ms.
118                         </li>
119                         <li>
120                                 <dfn>Declick when transport starts and stops</dfn> creates an artificial
121                                 fade in/out when starting or stopping playback, to avoid the 'click' sound
122                                 resulting in starting it at a non zero value.
123                         </li>
124                         <li>
125                                 <dfn>Declick when monitor state changes</dfn> also creates an artificial
126                                 fade in/out to avoid clicks when a parameter in the monitor changes.
127                         </li>
128                         <li>
129                                 <dfn>Region fades active</dfn> when checked, Ardour applies the region
130                                 <a href="@@create-region-fades-and-crossfades">crossfades</a> to each
131                                 region's start and end. When unchecked, no fades are applied, and clicks
132                                 may be heard at regions boundaries.
133                         </li>
134                         <li>
135                                 <dfn>Region fades visible</dfn> when checked, the region fades are visible
136                                 in the the Editor. Unchecking may increase readability for sessions made
137                                 of a lot of tiny regions.
138                         </li>
139                 </ul>
140         </li>
141 </ul>
142
143 <h2 id="properties-media">Media</h2>
144
145 <p>
146         Change how sound is stored on disk. These options do not change how sound is handled
147   internally.
148 </p>
149
150 <ul>
151         <li>
152                 <dfn>Audio File Format</dfn>
153                 <ul>
154                         <li>
155                                 <dfn>Sample format:</dfn> defaults to 32-bit floating point, the same as
156                                 the internal representation. 24 and 16-bit integer representation are
157                                 also available, for more lightweight sessions at the cost of a reduced
158                                 audio definition.
159                         </li>
160                         <li>
161                                 <dfn>File type:</dfn> defines what format is used to store the audio
162                                 files. The default is WAVE, and can be changed to Broadcast Wave to
163                                 store metadata and timecodes, <abbr title="Core Audio
164                                 Format">CAF</abbr> to overcome WAVE's limitation to 4Gb in size, RF64
165                                 to add more channels, etc. The chosen format is usually very
166                                 workflow-specific.
167                         </li>
168                 </ul>
169         </li>
170 </ul>
171
172 <h2 id="properties-locations">Locations</h2>
173
174 <p>
175         These options add file locations that will be searched to find the audio and
176   midi files used by the session. This is useful when the files have been
177   imported into the session but not copied into the session.
178 </p>
179
180 <ul>
181         <li>
182                 <dfn>File Locations</dfn>
183                 <ul>
184                         <li>
185                                 <dfn>Search for audio files in:</dfn> allows to add a location to look
186                                 for audio files. Adding a location is done by navigating to the
187                                 directory where the files are stored, selecting it and clicking <kbd
188                                 class="menu">Open</kbd>. The directory will show up in the dialog. The
189                                 <kbd class="menu">Remove</kbd> button next to the added directory can
190                                 be used to remove it from the search path. Multiple paths can be added
191                                 this way.
192                         </li>
193                         <li>
194                                 <dfn>Search for MIDI files in:</dfn> is exactly the same, but for MIDI files.
195                         </li>
196                 </ul>
197         </li>
198 </ul>
199
200 <h2 id="properties-filenames">Filenames</h2>
201
202 <p>
203          This tab is used to change how Ardour names recorded regions.
204 </p>
205
206 <ul>
207         <li>
208                 <dfn>File Naming</dfn>
209                 <ul>
210                         <li>
211                                 <dfn>Prefix Track number</dfn> when checked, a unique number will
212                                 appear on each track in the Editor window and will prefix the region
213                                 name. If the track number is <samp>2</samp> and the region would have
214                                 been named <samp>Gtr-1.1</samp>, with track number prefix turned on the
215                                 region will be named <samp>2_Gtr-1.1</samp> instead. See <a
216                                 href="@@region-naming">Region Naming</a>.
217                         </li>
218                         <li>
219                                 <dfn>Prefix Take Name</dfn> when enabled, the first time a track is
220                                 recorded it will have the specified take name. When recording is
221                                 stopped, any trailing number on the end of the take name will be
222                                 incremented by 1. If the specified track name doesn't have a number on
223                                 the end, the number <samp>1</samp> will be suffixed.
224                         </li>
225                         <li>
226                                 <dfn>Take name</dfn> specifies what name is prefixed if <kbd
227                                 class="option">Prefix Take Name</kbd> is checked.
228                         </li>
229                 </ul>
230         </li>
231 </ul>
232
233
234 <h2 id="properties-monitoring">Monitoring</h2>
235
236 <p>
237          Provides options affecting monitoring.
238 </p>
239
240 <ul>
241         <li>
242                 <dfn>Monitoring</dfn>
243                 <ul>
244                         <li>
245                                 <dfn>Track Input Monitoring automatically follows transport state
246                                 ("auto-input")</dfn> affects how input monitoring is handling. See <a
247                                 href="@@monitor-setup-in-ardour">Monitor Setup in Ardour</a>
248                         </li>
249                         <li>
250                                 <dfn>Use monitor section in this session</dfn> when enabled, displays
251                                 an extra section in the Mixer window that is modelled on the similarly
252                                 named section on large analog consoles. More information can be found
253                                 on the <a href="@@monitor-section">Monitor Section</a> page.
254                         </li>
255                 </ul>
256         </li>
257 </ul>
258
259
260 <h2 id="properties-meterbridge">Meterbridge</h2>
261
262 <p>
263         This tab changes what controls are displayed in the Meterbridge that is
264         available in the <kbd class="menu">Window &gt; Meterbridge</kbd> menu.
265 </p>
266
267 <ul>
268         <li>
269                 <dfn>Route Display</dfn>
270                 <ul>
271                         <li>
272                                 <dfn>Show Midi Tracks</dfn> displays/hides MIDI tracks (even when no
273                                 synth, hence no audio output exists)
274                         </li>
275                         <li>
276                                 <dfn>Show Busses</dfn> displays/hides <a
277                                 href="@@track-types">Busses</a> tracks
278                         </li>
279                         <li>
280                                 <dfn>Include Master Bus</dfn> displays/hides the <a
281                                 href="@@master-bus-strip">Master Bus</a>
282                         </li>
283                 </ul>
284         </li>
285         <li>
286                 <dfn>Button Area</dfn>
287                 <ul>
288                         <li>
289                                 <dfn>Rec-enable Button</dfn> displays/hides the record arm button (for audio
290                                 and MIDI tracks only)
291                         </li>
292                         <li>
293                                 <dfn>Mute Button</dfn> displays/hides the mute button (for all
294                                 tracks/busses types)
295                         </li>
296                         <li>
297                                 <dfn>Solo Button</dfn> same for solo
298                         </li>
299                         <li>
300                                 <dfn>Monitor Buttons</dfn> displays/hides the two (input and playback)<a
301                                 href="@@monitoring">monitoring</a> buttons, selecting what is played at
302                                 record and playback time.
303                         </li>
304                 </ul>
305         </li>
306         <li>
307                 <dfn>Name Labels</dfn>
308                 <ul>
309                         <li>
310                                 <dfn>Track Name</dfn> adds the tracks' names bellow the buttons.
311                         </li>
312                 </ul>
313         </li>
314 </ul>
315
316 <h2 id="properties-misc">Misc</h2>
317
318 <p>
319         This tab has several things that don't fit on the other tabs.
320 </p>
321
322 <ul>
323         <li>
324                 <dfn>MIDI Options</dfn>
325                 <ul>
326                         <li>
327                                 <dfn>MIDI region copies are independent</dfn> if selected, when a MIDI
328                                 region is copied or duplicated, the new region is not linked to the
329                                 region it was copied from. If it is not selected, the copied regions
330                                 are linked and any editing done on one of the linked regions changes
331                                 all of the linked regions.
332                         </li>
333                         <li>
334                                 <dfn>Policy for handling overlapping notes on the same MIDI channel:</dfn>
335                                 Selects how Ardour reacts to possibly conflicting MIDI notes:
336                                         <ul>
337                                                 <li>never allow them</li>
338                                                 <li>don't do anything in particular</li>
339                                                 <li>replace any overlapped existing     notes</li>
340                                                 <li>shorten the overlapped existing note</li>
341                                                 <li>shorten     the overlapping new note</li>
342                                                 <li>replace both overlapping notes with a       single note</li>
343                                         </ul>
344                         </li>
345                 </ul>
346         </li>
347         <li>
348                 <dfn>Glue to Bars and Beats</dfn>
349                 <ul>
350                         <li>
351                                 <dfn>Glue new markers to bars and beats</dfn> if checked, a newly
352                                 created marker will always be placed at the nearest musical time
353                                 instead of right where the mouse pointer is.
354                         </li>
355                         <li>
356                                 <dfn>Glue new regions to bars and beats</dfn> same as above, for regions.
357                         </li>
358                 </ul>
359         </li>
360         <li>
361                 <dfn>Metronome</dfn>
362                 <ul>
363                         <li>
364                                 <dfn>Always count-in when recording</dfn> when checked, waits for two
365                                 bars before the actual recording begins. The Metronome will tick (even if
366                                 disabled) during the count-in. Same as recording with <kbd
367                                 class="menu">Transport &gt; Record w/Count-In</kbd>.
368                         </li>
369                 </ul>
370         </li>
371         <li>
372                 <dfn>Defaults</dfn>
373                 <ul>
374                         <li>
375                                 <dfn>Use these settings as defaults</dfn> clicking this buttons makes all
376                                 the present Session Properties default, by recording them in the
377                                 default session template.
378                         </li>
379                 </ul>
380         </li>
381
382 </ul>
383