2 Copyright (C) 2012 Paul Davis
3 Written by Robin Gareus <robin@gareus.org>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include "timecode/time.h"
23 #include "ardour/audioengine.h"
24 #include "ardour/audio_port.h"
25 #include "ardour/debug.h"
26 #include "ardour/io.h"
27 #include "ardour/session.h"
28 #include "ardour/slave.h"
33 using namespace ARDOUR;
36 using namespace Timecode;
38 /* really verbose timing debug */
39 //#define LTC_GEN_FRAMEDBUG
40 //#define LTC_GEN_TXDBUG
43 Session::ltc_tx_initialize()
45 ltc_enc_tcformat = config.get_timecode_format();
47 DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX init sr: %1 fps: %2\n", nominal_frame_rate(), timecode_to_frames_per_second(ltc_enc_tcformat)));
48 ltc_encoder = ltc_encoder_create(nominal_frame_rate(),
49 timecode_to_frames_per_second(ltc_enc_tcformat),
52 ltc_encoder_set_bufsize(ltc_encoder, nominal_frame_rate(), 23.0);
54 /* buffersize for 1 LTC frame: (1 + sample-rate / fps) bytes
55 * usually returned by ltc_encoder_get_buffersize(encoder)
57 * since the fps can change and A3's min fps: 24000/1001 */
58 ltc_enc_buf = (ltcsnd_sample_t*) calloc((nominal_frame_rate() / 23), sizeof(ltcsnd_sample_t));
61 ltc_tx_resync_latency();
62 Xrun.connect_same_thread (*this, boost::bind (&Session::ltc_tx_reset, this));
63 engine().GraphReordered.connect_same_thread (*this, boost::bind (&Session::ltc_tx_resync_latency, this));
67 Session::ltc_tx_cleanup()
69 DEBUG_TRACE (DEBUG::LTC, "LTC TX cleanup\n");
70 if (ltc_enc_buf) free(ltc_enc_buf);
71 ltc_encoder_free(ltc_encoder);
76 Session::ltc_tx_resync_latency()
78 DEBUG_TRACE (DEBUG::LTC, "LTC TX resync latency\n");
79 if (!deletion_in_progress()) {
80 boost::shared_ptr<Port> ltcport = ltc_output_port();
82 ltcport->get_connected_latency_range(ltc_out_latency, true);
88 Session::ltc_tx_reset()
90 DEBUG_TRACE (DEBUG::LTC, "LTC TX reset\n");
91 ltc_enc_pos = -9999; // force re-start
99 Session::ltc_tx_recalculate_position()
103 ltc_encoder_get_timecode(ltc_encoder, &enctc);
105 a3tc.hours = enctc.hours;
106 a3tc.minutes = enctc.mins;
107 a3tc.seconds = enctc.secs;
108 a3tc.frames = enctc.frame;
109 a3tc.rate = timecode_to_frames_per_second(ltc_enc_tcformat);
110 a3tc.drop = timecode_has_drop_frames(ltc_enc_tcformat);
112 Timecode::timecode_to_sample (a3tc, ltc_enc_pos, true, false,
113 double(frame_rate()),
114 config.get_subframes_per_frame(),
115 config.get_timecode_offset_negative(), config.get_timecode_offset()
120 Session::ltc_tx_send_time_code_for_cycle (framepos_t start_frame, framepos_t end_frame,
121 double target_speed, double current_speed,
124 assert (nframes > 0);
128 boost::shared_ptr<Port> ltcport = ltc_output_port();
130 Buffer& buf (ltcport->get_buffer (nframes));
132 if (!ltc_encoder || !ltc_enc_buf) {
136 SyncSource sync_src = Config->get_sync_source();
137 if (engine().freewheeling() || !Config->get_send_ltc()
139 * decide which time-sources we can generated LTC from.
140 * Internal, JACK or sample-synced slaves should be fine.
143 || (config.get_external_sync() && sync_src == LTC)
144 || (config.get_external_sync() && sync_src == MTC)
146 ||(config.get_external_sync() && sync_src == MIDIClock)
151 out = dynamic_cast<AudioBuffer*>(&buf)->data ();
153 /* range from libltc (38..218) || - 128.0 -> (-90..90) */
154 const float ltcvol = Config->get_ltc_output_volume()/(90.0); // pow(10, db/20.0)/(90.0);
157 /* TODO read layency only on demand -> ::ltc_tx_reset()
158 * this is already prepared.
160 * ..but first fix jack2 issue with re-computing latency
161 * in the correct order. Until then, querying it in the
162 * process-callback is the only way to get the current value
164 * update: fix for this issue is known -- common/JackEngine.cpp
165 * but not yet applied to jack2 git.
167 ltcport->get_connected_latency_range(ltc_out_latency, true);
169 DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX %1 to %2 / %3 | lat: %4\n", start_frame, end_frame, nframes, ltc_out_latency.max));
171 /* all systems go. Now here's the plan:
173 * 1) check if fps has changed
174 * 2) check direction of encoding, calc speed, re-sample existing buffer
175 * 3) calculate frame and byte to send aligned to jack-period size
176 * 4) check if it's the frame/byte that is already in the queue
177 * 5) if (4) mismatch, re-calculate offset of LTC frame relative to period size
178 * 6) actual LTC audio output
179 * 6a) send remaining part of already queued frame; break on nframes
180 * 6b) encode new LTC-frame byte
186 TimecodeFormat cur_timecode = config.get_timecode_format();
187 if (cur_timecode != ltc_enc_tcformat) {
188 DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX1: TC format mismatch - reinit sr: %1 fps: %2\n", nominal_frame_rate(), timecode_to_frames_per_second(cur_timecode)));
189 if (ltc_encoder_reinit(ltc_encoder, nominal_frame_rate(), timecode_to_frames_per_second(cur_timecode), 0)) {
190 PBD::error << _("LTC encoder: invalid framerate - LTC encoding is disabled for the remainder of this session.") << endmsg;
194 ltc_enc_tcformat = cur_timecode;
198 /* LTC is max. 30 fps */
199 if (timecode_to_frames_per_second(cur_timecode) > 30) {
203 // (2) speed & direction
205 /* speed 0 aka transport stopped is interpreted as rolling forward.
206 * keep repeating current frame
208 #define SIGNUM(a) ( (a) < 0 ? -1 : 1)
209 bool speed_changed = false;
211 /* use port latency compensation */
213 /* The generated timecode is offset by the port-latency,
214 * therefore the offset depends on the direction of transport.
216 framepos_t cycle_start_frame = (current_speed < 0) ? (start_frame + ltc_out_latency.max) : (start_frame - ltc_out_latency.max);
218 /* This comes in handy when testing sync - record output on an A3 track
219 * see also http://tracker.ardour.org/view.php?id=5073
221 framepos_t cycle_start_frame = start_frame;
224 /* cycle-start may become negative due to latency compensation */
225 if (cycle_start_frame < 0) { cycle_start_frame = 0; }
227 double new_ltc_speed = double(labs(end_frame - start_frame) * SIGNUM(current_speed)) / double(nframes);
229 if (SIGNUM(new_ltc_speed) != SIGNUM (ltc_speed)) {
230 DEBUG_TRACE (DEBUG::LTC, "LTC TX2: transport changed direction\n");
234 if (ltc_speed != new_ltc_speed) {
235 /* check ./libs/ardour/interpolation.cc CubicInterpolation::interpolate
236 * if target_speed != current_speed we should interpolate, too.
238 * However, currency in A3 target_speed == current_speed for each process cycle
239 * (except for the sign and if target_speed > 8.0).
240 * Besides, above speed calculation uses the difference (end_frame - start_frame).
241 * end_frame is calculated from 'frames_moved' which includes the interpolation.
244 DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX2: speed change old: %1 cur: %2 tgt: %3 ctd: %4\n", ltc_speed, current_speed, target_speed, fabs(current_speed) - target_speed));
245 speed_changed = true;
248 if (end_frame == start_frame || fabs(current_speed) < 0.1 ) {
249 DEBUG_TRACE (DEBUG::LTC, "LTC TX2: transport is not rolling or absolute-speed < 0.1\n");
250 /* keep repeating current frame
252 * an LTC generator must be able to continue generating LTC when Ardours transport is in stop
253 * some machines do odd things if LTC goes away:
254 * e.g. a tape based machine (video or audio), some think they have gone into park if LTC goes away,
255 * so unspool the tape from the playhead. That might be inconvenient.
256 * If LTC keeps arriving they remain in a stop position with the tape on the playhead.
259 if (!Config->get_ltc_send_continuously()) {
260 ltc_speed = new_ltc_speed;
265 if (fabs(new_ltc_speed) > 10.0) {
266 DEBUG_TRACE (DEBUG::LTC, "LTC TX2: speed is out of bounds.\n");
271 if (ltc_speed == 0 && new_ltc_speed != 0) {
272 DEBUG_TRACE (DEBUG::LTC, "LTC TX2: transport started rolling - reset\n");
276 /* the timecode duration corresponding to the samples that are still
277 * in the buffer. Here, the speed of previous cycle is used to calculate
278 * the alignment at the beginning of this cycle later.
280 double poff = (ltc_buf_len - ltc_buf_off) * ltc_speed;
282 if (speed_changed && new_ltc_speed != 0) {
283 /* we need to re-sample the existing buffer.
284 * "make space for the en-coder to catch up to the new speed"
286 * since the LTC signal is a rectangular waveform we can simply squeeze it
287 * by removing samples or duplicating samples /here and there/.
289 * There may be a more elegant way to do this, in fact one could
290 * simply re-render the buffer using ltc_encoder_encode_byte()
291 * but that'd require some timecode offset buffer magic,
292 * which is left for later..
295 double oldbuflen = double(ltc_buf_len - ltc_buf_off);
296 double newbuflen = double(ltc_buf_len - ltc_buf_off) * fabs(ltc_speed / new_ltc_speed);
298 DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX2: bufOld %1 bufNew %2 | diff %3\n",
299 (ltc_buf_len - ltc_buf_off), newbuflen, newbuflen - oldbuflen
302 double bufrspdiff = rint(newbuflen - oldbuflen);
304 if (abs(bufrspdiff) > newbuflen || abs(bufrspdiff) > oldbuflen) {
305 DEBUG_TRACE (DEBUG::LTC, "LTC TX2: resampling buffer would destroy information.\n");
308 } else if (bufrspdiff != 0 && newbuflen > oldbuflen) {
310 double samples_to_insert = ceil(newbuflen - oldbuflen);
311 double avg_distance = newbuflen / samples_to_insert;
312 DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX2: resample buffer insert: %1\n", samples_to_insert));
314 for (int rp = ltc_buf_off; rp < ltc_buf_len - 1; ++rp) {
315 const int ro = rp - ltc_buf_off;
316 if (ro < (incnt*avg_distance)) continue;
317 const ltcsnd_sample_t v1 = ltc_enc_buf[rp];
318 const ltcsnd_sample_t v2 = ltc_enc_buf[rp+1];
319 if (v1 != v2 && ro < ((incnt+1)*avg_distance)) continue;
320 memmove(<c_enc_buf[rp+1], <c_enc_buf[rp], ltc_buf_len-rp);
324 } else if (bufrspdiff != 0 && newbuflen < oldbuflen) {
325 double samples_to_remove = ceil(oldbuflen - newbuflen);
326 DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX2: resample buffer - remove: %1\n", samples_to_remove));
327 if (oldbuflen <= samples_to_remove) {
328 ltc_buf_off = ltc_buf_len= 0;
330 double avg_distance = newbuflen / samples_to_remove;
332 for (int rp = ltc_buf_off; rp < ltc_buf_len - 1; ++rp) {
333 const int ro = rp - ltc_buf_off;
334 if (ro < (rmcnt*avg_distance)) continue;
335 const ltcsnd_sample_t v1 = ltc_enc_buf[rp];
336 const ltcsnd_sample_t v2 = ltc_enc_buf[rp+1];
337 if (v1 != v2 && ro < ((rmcnt+1)*avg_distance)) continue;
338 memmove(<c_enc_buf[rp], <c_enc_buf[rp+1], ltc_buf_len-rp-1);
346 ltc_speed = new_ltc_speed;
347 DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX2: transport speed %1.\n", ltc_speed));
349 // (3) bit/sample alignment
350 Timecode::Time tc_start;
351 framepos_t tc_sample_start;
353 /* calc timecode frame from current position - round down to nearest timecode */
354 sample_to_timecode(cycle_start_frame, tc_start, true, false);
356 /* convert timecode back to sample-position */
357 Timecode::timecode_to_sample (tc_start, tc_sample_start, true, false,
358 double(frame_rate()),
359 config.get_subframes_per_frame(),
360 config.get_timecode_offset_negative(), config.get_timecode_offset()
363 /* difference between current frame and TC frame in samples */
364 frameoffset_t soff = cycle_start_frame - tc_sample_start;
365 DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX3: A3cycle: %1 = A3tc: %2 +off: %3\n",
366 cycle_start_frame, tc_sample_start, soff));
369 // (4) check if alignment matches
370 const double fptcf = frames_per_timecode_frame();
372 /* maximum difference of bit alignment in audio-samples.
374 * if transport and LTC generator differs more than this, the LTC
375 * generator will be re-initialized
377 * due to rounding error and variations in LTC-bit duration depending
378 * on the speed, it can be off by +- ltc_speed audio-samples.
379 * When the playback speed changes, it can actually reach +- 2 * ltc_speed
380 * in the cycle _after_ the speed changed. The average delta however is 0.
384 if (config.get_external_sync() && slave()) {
385 maxdiff = slave()->resolution();
387 maxdiff = ceil(fabs(ltc_speed))*2.0;
390 DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX4: enc: %1 + %2 - %3 || buf-bytes: %4 enc-byte: %5\n",
391 ltc_enc_pos, ltc_enc_cnt, poff, (ltc_buf_len - ltc_buf_off), poff, ltc_enc_byte));
393 DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX4: enc-pos: %1 | d: %2\n",
394 ltc_enc_pos + ltc_enc_cnt - poff,
395 rint(ltc_enc_pos + ltc_enc_cnt - poff) - cycle_start_frame
398 if (ltc_speed != 0 && fabs(ceil(ltc_enc_pos + ltc_enc_cnt - poff) - cycle_start_frame) > maxdiff) {
403 /* set frame to encode */
405 tc.hours = tc_start.hours;
406 tc.mins = tc_start.minutes;
407 tc.secs = tc_start.seconds;
408 tc.frame = tc_start.frames;
409 ltc_encoder_set_timecode(ltc_encoder, &tc);
411 /* workaround for libltc recognizing 29.97 and 30000/1001 as drop-frame TC.
412 * In A3 30000/1001 or 30 fps can be drop-frame.
415 ltc_encoder_get_frame(ltc_encoder, <cframe);
416 ltcframe.dfbit = timecode_has_drop_frames(cur_timecode)?1:0;
417 ltc_encoder_set_frame(ltc_encoder, <cframe);
420 DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX4: now: %1 trs: %2 toff %3\n", cycle_start_frame, tc_sample_start, soff));
423 if (soff < 0 || soff >= fptcf) {
424 /* session framerate change between (2) and now */
429 if (ltc_speed < 0 ) {
430 /* calculate the byte that starts at or after the current position */
431 ltc_enc_byte = floor((10.0 * soff) / (fptcf));
432 ltc_enc_cnt = double(ltc_enc_byte * fptcf / 10.0);
434 /* calculate difference between the current position and the byte to send */
435 cyc_off = soff- ceil(ltc_enc_cnt);
438 /* calculate the byte that starts at or after the current position */
439 ltc_enc_byte = ceil((10.0 * soff) / fptcf);
440 ltc_enc_cnt = double(ltc_enc_byte * fptcf / 10.0);
442 /* calculate difference between the current position and the byte to send */
443 cyc_off = ceil(ltc_enc_cnt) - soff;
445 if (ltc_enc_byte == 10) {
447 ltc_encoder_inc_timecode(ltc_encoder);
451 DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX5 restart encoder: soff %1 byte %2 cycoff %3\n",
452 soff, ltc_enc_byte, cyc_off));
454 if (cyc_off > 0 && cyc_off <= nframes) {
455 /* offset in this cycle */
456 txf= rint(cyc_off / fabs(ltc_speed));
457 memset(out, 0, cyc_off * sizeof(Sample));
459 /* resync next cycle */
460 memset(out, 0, nframes * sizeof(Sample));
464 ltc_enc_pos = tc_sample_start;
466 DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX5 restart @ %1 + %2 - %3 | byte %4\n",
467 ltc_enc_pos, ltc_enc_cnt, cyc_off, ltc_enc_byte));
471 // (6) encode and output
473 #ifdef LTC_GEN_TXDBUG
474 DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX6.1 @%1 [ %2 / %3 ]\n", txf, ltc_buf_off, ltc_buf_len));
476 // (6a) send remaining buffer
477 while ((ltc_buf_off < ltc_buf_len) && (txf < nframes)) {
478 const float v1 = ltc_enc_buf[ltc_buf_off++] - 128.0;
479 const Sample val = (Sample) (v1*ltcvol);
482 #ifdef LTC_GEN_TXDBUG
483 DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX6.2 @%1 [ %2 / %3 ]\n", txf, ltc_buf_off, ltc_buf_len));
486 if (txf >= nframes) {
487 DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX7 enc: %1 [ %2 / %3 ] byte: %4 spd %5 fpp %6 || nf: %7\n",
488 ltc_enc_pos, ltc_buf_off, ltc_buf_len, ltc_enc_byte, ltc_speed, nframes, txf));
495 // (6b) encode LTC, bump timecode
498 ltc_enc_byte = (ltc_enc_byte + 9)%10;
499 if (ltc_enc_byte == 9) {
500 ltc_encoder_dec_timecode(ltc_encoder);
501 ltc_tx_recalculate_position();
506 if (ltc_encoder_encode_byte(ltc_encoder, ltc_enc_byte, (ltc_speed==0)?1.0:(1.0/ltc_speed))) {
507 DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX6.3 encoder error byte %1\n", ltc_enc_byte));
508 ltc_encoder_buffer_flush(ltc_encoder);
512 int enc_frames = ltc_encoder_get_buffer(ltc_encoder, &(ltc_enc_buf[ltc_buf_len]));
513 #ifdef LTC_GEN_FRAMEDBUG
514 DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX6.3 encoded %1 bytes for LTC-byte %2 at spd %3\n", enc_frames, ltc_enc_byte, ltc_speed));
516 if (enc_frames <=0) {
517 DEBUG_TRACE (DEBUG::LTC, "LTC TX6.3 encoder empty buffer.\n");
518 ltc_encoder_buffer_flush(ltc_encoder);
523 ltc_buf_len += enc_frames;
525 ltc_enc_cnt -= fptcf/10.0;
527 ltc_enc_cnt += fptcf/10.0;
529 if (ltc_speed >= 0) {
530 ltc_enc_byte = (ltc_enc_byte + 1)%10;
531 if (ltc_enc_byte == 0 && ltc_speed != 0) {
532 ltc_encoder_inc_timecode(ltc_encoder);
533 ltc_tx_recalculate_position();
535 } else if (ltc_enc_byte == 0) {
539 #ifdef LTC_GEN_FRAMEDBUG
540 DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX6.4 enc-pos: %1 + %2 [ %4 / %5 ] spd %6\n", ltc_enc_pos, ltc_enc_cnt, ltc_buf_off, ltc_buf_len, ltc_speed));
544 dynamic_cast<AudioBuffer*>(&buf)->set_written (true);