]> Shamusworld >> Repos - ardour-manual/blob - include/transport-masters.html
Sync: add initial revision of Transport Masters documentation
[ardour-manual] / include / transport-masters.html
1 <p>
2         The <dfn>Transport Masters</dfn> dialog allows selecting a transport master
3         (a timecode source) for Ardour to sync to, as well as tweaking additional
4         settings.
5 </p>
6
7 <figure>
8   <img style="width:75%;" src="/images/transport-masters.png" alt="Transport Masters">
9   <figcaption>
10     Transport Masters
11   </figcaption>
12 </figure>
13
14 <p>
15         Supported protocols are:
16 </p>
17
18 <ul>
19         <li>JACK Transport</li>
20         <li>MIDI Time Code (MTC)</li>
21         <li>Linear (or Longitudinal) Timecode (LTC)</li>
22         <li>MIDI Beat Clock, or MIDI Clock</li>
23 </ul>
24
25 <p>
26         For each type of supported protocol it's possible to select the port
27         to read timecode signal from, view sync position and drift (delta), see
28         when any message was received the last time, and toggle additional
29         options.`
30 </p>
31
32 <h2>Selecting a Transport Master</h2>
33
34 <p>
35         The dialog collects all transport masters information and settings in one
36         place, however Ardour can sync only to one timecode source at a time.
37         Clicking the radio button to the left of the master's name selects that
38         transport master.
39 </p>
40
41 <p>
42         It is neccessary to also select an audio or MIDI port (depending on the
43         protocol) to read timecode data from. Relevant ports are listed for each
44         transport master in the dropdown list in the <dfn>Source</dfn> section.
45 </p>
46
47 <h2>Keeping Track of The Sync</h2>
48
49 <p>
50         <dfn>Format</dfn> displays the timecode format for each transport master
51         depending on the specifics of that master's protocol. E.g. while MTC and
52         LTC will display a frame rate such as 25 fps, MIDI Clock will be
53         transmitting tempo such as 120 beats per minute.
54 </p>
55
56 <p>
57         <dfn>Sync Position + Delta</dfn> displays current location as per timecode
58         as well as the difference between current location in Ardour and the
59         location per timecode source. This difference (delta) accumulates as long
60         as Ardour's transport isn't rolling.
61 </p>
62
63 <p>
64         <dfn>Last Message + Age</dfn> displays the latest location transmitted
65         by the timecode source, as well as the time since the last transmission
66         was received.
67 </p>
68
69 <h2>Setting Additional Options</h2>
70
71 <p>
72         It's possible to set several additional options.
73 </p>
74
75 <p>
76         <dfn>Active Commands</dfn> makes it possible to perform certain types
77         of actions in Ardour at the cost of decoupling from the transport master.
78         Supported options are:
79 </p>
80
81 <ul>
82         <li>Accept start/stop commands (displays 'Start/Stop' on the button)</li>
83         <li>Accept speed-changing commands (displays 'Speed' on the button)</li>
84         <li>Accept locate commands (displays 'Locate' on the button)</li>
85 </ul>
86
87 <p>
88         When only one command is enabled, its short name will displayed at the
89         button's caption (see above). When two out of three are enabled,
90         the button's caption will be 'Complex'. When all three options are enabled,
91         the caption will be 'All'.
92 </p>
93
94 <p>
95         The easiest way to select two or three options at a time is to open the
96         drop-down menu, use arrow up/down keys to navigate to the option of interest,
97         the press <kbd class="button">Spacebar</kbd> to toggle that option without
98         subsequently closing the drop-down menu.
99 </p>
100
101 <p>
102         <dfn>Clock Synced</dfn> — when this option is enabled, the external
103         timecode source is assumed to be sample-clock synced to the audio interface
104         that is being used by Ardour
105 </p>
106
107 <p>
108         <dfn>29.97/30</dfn> — when this option is enabled, the external timecode
109         source is assumed to use 29.97 fps exactly rather than 30000/1001 (which is
110         29.97002997).
111 </p>
112
113 <p>
114         Both <dfn>Clock Synced</dfn> and <dfn>29.97/30</dfn> options are not
115         applicable to <dfn>MIDI Beat Clock</dfn> that operates in the musical time
116         domain and transmits beats per minute rather that seconds and frames.
117 </p>
118
119 <h2>Adding and Removing Custom Transport Masters</h2>
120
121 <p>
122         It is possible to <dfn>add</dfn> additional masters of the same type, e.g.
123         two difference sources of LTC.
124 </p>
125
126 <p>
127         Clicking <kbd class="button">Add a New Transport Master</kbd> opens a new
128         dialog.
129 </p>
130
131 <figure>
132   <img style="width:50%;" src="/images/add-transport-master.png" alt="Add a new transport master">
133   <figcaption>
134     Add a new transport master
135   </figcaption>
136 </figure>
137
138 <p>
139         It's usually a good idea to give the custom transport master a descriptive
140         name, especially if there are multiple ones available using the same
141         protocol.
142 </p>
143
144 <p>
145         The next step is selecting the audio or MIDI port where the timecode signal
146         will be coming from.
147 </p>
148
149 <p>
150         Additional transport masters can be <dfn>removed</dfn> with a single click.
151         Every custom transport master has a button with a crosshair icon
152         <kbd class="button">X</kbd> to the right of the window. No confirmation
153         will be asked upon clicking this button.
154 </p>