From: Alexandre Prokoudine Date: Sat, 23 Jul 2022 20:34:56 +0000 (+0300) Subject: Sync: add initial revision of Transport Masters documentation X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?p=ardour-manual;a=commitdiff_plain;h=f18d19be15bea726c53a59dabaa3d6bf4ea8c7e7 Sync: add initial revision of Transport Masters documentation --- diff --git a/include/transport-masters.html b/include/transport-masters.html new file mode 100644 index 0000000..b68eb11 --- /dev/null +++ b/include/transport-masters.html @@ -0,0 +1,154 @@ +

+ The Transport Masters dialog allows selecting a transport master + (a timecode source) for Ardour to sync to, as well as tweaking additional + settings. +

+ +
+ Transport Masters +
+ Transport Masters +
+
+ +

+ Supported protocols are: +

+ + + +

+ For each type of supported protocol it's possible to select the port + to read timecode signal from, view sync position and drift (delta), see + when any message was received the last time, and toggle additional + options.` +

+ +

Selecting a Transport Master

+ +

+ The dialog collects all transport masters information and settings in one + place, however Ardour can sync only to one timecode source at a time. + Clicking the radio button to the left of the master's name selects that + transport master. +

+ +

+ It is neccessary to also select an audio or MIDI port (depending on the + protocol) to read timecode data from. Relevant ports are listed for each + transport master in the dropdown list in the Source section. +

+ +

Keeping Track of The Sync

+ +

+ Format displays the timecode format for each transport master + depending on the specifics of that master's protocol. E.g. while MTC and + LTC will display a frame rate such as 25 fps, MIDI Clock will be + transmitting tempo such as 120 beats per minute. +

+ +

+ Sync Position + Delta displays current location as per timecode + as well as the difference between current location in Ardour and the + location per timecode source. This difference (delta) accumulates as long + as Ardour's transport isn't rolling. +

+ +

+ Last Message + Age displays the latest location transmitted + by the timecode source, as well as the time since the last transmission + was received. +

+ +

Setting Additional Options

+ +

+ It's possible to set several additional options. +

+ +

+ Active Commands makes it possible to perform certain types + of actions in Ardour at the cost of decoupling from the transport master. + Supported options are: +

+ + + +

+ When only one command is enabled, its short name will displayed at the + button's caption (see above). When two out of three are enabled, + the button's caption will be 'Complex'. When all three options are enabled, + the caption will be 'All'. +

+ +

+ The easiest way to select two or three options at a time is to open the + drop-down menu, use arrow up/down keys to navigate to the option of interest, + the press Spacebar to toggle that option without + subsequently closing the drop-down menu. +

+ +

+ Clock Synced — when this option is enabled, the external + timecode source is assumed to be sample-clock synced to the audio interface + that is being used by Ardour +

+ +

+ 29.97/30 — when this option is enabled, the external timecode + source is assumed to use 29.97 fps exactly rather than 30000/1001 (which is + 29.97002997). +

+ +

+ Both Clock Synced and 29.97/30 options are not + applicable to MIDI Beat Clock that operates in the musical time + domain and transmits beats per minute rather that seconds and frames. +

+ +

Adding and Removing Custom Transport Masters

+ +

+ It is possible to add additional masters of the same type, e.g. + two difference sources of LTC. +

+ +

+ Clicking Add a New Transport Master opens a new + dialog. +

+ +
+ Add a new transport master +
+ Add a new transport master +
+
+ +

+ It's usually a good idea to give the custom transport master a descriptive + name, especially if there are multiple ones available using the same + protocol. +

+ +

+ The next step is selecting the audio or MIDI port where the timecode signal + will be coming from. +

+ +

+ Additional transport masters can be removed with a single click. + Every custom transport master has a button with a crosshair icon + X to the right of the window. No confirmation + will be asked upon clicking this button. +

diff --git a/master-doc.txt b/master-doc.txt index cb5e072..0d37a62 100644 --- a/master-doc.txt +++ b/master-doc.txt @@ -266,6 +266,15 @@ uri: synchronization/overview-of-timecode-related-settings part: subchapter --- +--- +title: Transport Masters +menu_title: Transport Masters +include: transport-masters.html +link: transport-masters +uri: synchronization/transport-masters.html +part: subchapter +--- + --- title: Preferences menu_title: Preferences diff --git a/source/images/add-transport-master.png b/source/images/add-transport-master.png new file mode 100644 index 0000000..95ff594 Binary files /dev/null and b/source/images/add-transport-master.png differ diff --git a/source/images/transport-masters.png b/source/images/transport-masters.png new file mode 100644 index 0000000..b763984 Binary files /dev/null and b/source/images/transport-masters.png differ