refactor MIDISceneChange color property addition by moving it into SceneChange to...
[ardour.git] / libs / ardour / session_ltc.cc
index 2ce25b5a4808853754f969707b918f1db40f21fc..1ac26816410c0ce73fde17cfde0a2b1c16a885d4 100644 (file)
@@ -244,6 +244,19 @@ Session::ltc_tx_send_time_code_for_cycle (framepos_t start_frame, framepos_t end
        /* port latency compensation:
         * The _generated timecode_ is offset by the port-latency,
         * therefore the offset depends on the direction of transport.
+        *
+        * latency is compensated by adding it to the timecode to
+        * be generated. e.g. if the signal will reach the output in
+        * N samples time from now, generate the timecode for (now + N).
+        *
+        * sample-sync is achieved by further calculating the difference
+        * between the timecode and the session-transport and offsetting the
+        * buffer.
+        *
+        * The timecode is generated directly in the Session process callback
+        * using _transport_frame. It requires that the session has set the
+        * port's playback latency to worst_playback_latency() prior to
+        * calling ltc_tx_send_time_code_for_cycle().
         */
        framepos_t cycle_start_frame;