Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
-#include "ardour/debug.h"
+
#include "timecode/time.h"
-#include "ardour/session.h"
+
#include "ardour/audioengine.h"
#include "ardour/audio_port.h"
+#include "ardour/debug.h"
+#include "ardour/io.h"
+#include "ardour/session.h"
#include "ardour/slave.h"
#include "i18n.h"
using namespace std;
using namespace ARDOUR;
-using namespace MIDI;
using namespace PBD;
using namespace Timecode;
//#define LTC_GEN_FRAMEDBUG
//#define LTC_GEN_TXDBUG
+#ifndef MAX
+#define MAX(a,b) ( (a) > (b) ? (a) : (b) )
+#endif
+#ifndef MIN
+#define MIN(a,b) ( (a) < (b) ? (a) : (b) )
+#endif
+
+/* LTC signal should have a rise time of 25 us +/- 5 us.
+ * yet with most sound-cards a square-wave of 1-2 sample
+ * introduces ringing and small oscillations.
+ * https://en.wikipedia.org/wiki/Gibbs_phenomenon
+ * A low-pass filter in libltc can reduce this at
+ * the cost of being slightly out of spec WRT to rise-time.
+ *
+ * This filter is adaptive so that fast vari-speed signals
+ * will not be affected by it.
+ */
+#define LTC_RISE_TIME(speed) MIN (100, MAX(40, (4000000 / ((speed==0)?1:speed) / engine().frame_rate())))
+
+#define TV_STANDARD(tcf) \
+ (timecode_to_frames_per_second(tcf)==25.0 ? LTC_TV_625_50 : \
+ timecode_has_drop_frames(tcf)? LTC_TV_525_60 : LTC_TV_FILM_24)
+
void
Session::ltc_tx_initialize()
{
ltc_enc_tcformat = config.get_timecode_format();
+ ltc_tx_parse_offset();
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)));
ltc_encoder = ltc_encoder_create(nominal_frame_rate(),
timecode_to_frames_per_second(ltc_enc_tcformat),
- 0);
+ TV_STANDARD(ltc_enc_tcformat), 0);
ltc_encoder_set_bufsize(ltc_encoder, nominal_frame_rate(), 23.0);
+ ltc_encoder_set_filter(ltc_encoder, LTC_RISE_TIME(1.0));
/* buffersize for 1 LTC frame: (1 + sample-rate / fps) bytes
* usually returned by ltc_encoder_get_buffersize(encoder)
ltc_enc_buf = (ltcsnd_sample_t*) calloc((nominal_frame_rate() / 23), sizeof(ltcsnd_sample_t));
ltc_speed = 0;
ltc_tx_reset();
+ ltc_tx_resync_latency();
+ Xrun.connect_same_thread (*this, boost::bind (&Session::ltc_tx_reset, this));
+ engine().GraphReordered.connect_same_thread (*this, boost::bind (&Session::ltc_tx_resync_latency, this));
+ restarting = false;
}
void
Session::ltc_tx_cleanup()
{
DEBUG_TRACE (DEBUG::LTC, "LTC TX cleanup\n");
- if (ltc_enc_buf) free(ltc_enc_buf);
+ free(ltc_enc_buf);
+ ltc_enc_buf = NULL;
ltc_encoder_free(ltc_encoder);
ltc_encoder = NULL;
}
+void
+Session::ltc_tx_resync_latency()
+{
+ DEBUG_TRACE (DEBUG::LTC, "LTC TX resync latency\n");
+ if (!deletion_in_progress()) {
+ boost::shared_ptr<Port> ltcport = ltc_output_port();
+ if (ltcport) {
+ ltcport->get_connected_latency_range(ltc_out_latency, true);
+ }
+ }
+}
+
void
Session::ltc_tx_reset()
{
ltc_buf_off = 0;
ltc_enc_byte = 0;
ltc_enc_cnt = 0;
+
+ ltc_encoder_reset(ltc_encoder);
+}
+
+void
+Session::ltc_tx_parse_offset() {
+ Timecode::Time offset_tc;
+ Timecode::parse_timecode_format(config.get_timecode_generator_offset(), offset_tc);
+ offset_tc.rate = timecode_frames_per_second();
+ offset_tc.drop = timecode_drop_frames();
+ timecode_to_sample(offset_tc, ltc_timecode_offset, false, false);
+ ltc_timecode_negative_offset = !offset_tc.negative;
}
void
a3tc.drop = timecode_has_drop_frames(ltc_enc_tcformat);
Timecode::timecode_to_sample (a3tc, ltc_enc_pos, true, false,
- double(frame_rate()),
+ (double)frame_rate(),
config.get_subframes_per_frame(),
- config.get_timecode_offset_negative(), config.get_timecode_offset()
+ ltc_timecode_negative_offset, ltc_timecode_offset
);
+ restarting = false;
}
-int
+void
Session::ltc_tx_send_time_code_for_cycle (framepos_t start_frame, framepos_t end_frame,
- double target_speed, double current_speed,
- pframes_t nframes)
+ double target_speed, double current_speed,
+ pframes_t nframes)
{
- assert(nframes > 0);
+ assert (nframes > 0);
- jack_default_audio_sample_t *out;
+ Sample *out;
pframes_t txf = 0;
boost::shared_ptr<Port> ltcport = ltc_output_port();
- if (!ltc_encoder || !ltc_enc_buf || !ltcport || ! ltcport->jack_port()) return 0;
+ Buffer& buf (ltcport->get_buffer (nframes));
- out = (jack_default_audio_sample_t*) jack_port_get_buffer (ltcport->jack_port(), nframes);
- if (!out) return 0;
+ if (!ltc_encoder || !ltc_enc_buf) {
+ return;
+ }
SyncSource sync_src = Config->get_sync_source();
- if (engine().freewheeling()
- || !Config->get_send_ltc()
- /* TODO
- * decide which time-sources we can generated LTC from.
- * Internal, JACK or sample-synced slaves should be fine.
- *
- *
- || (config.get_external_sync() && sync_src == LTC)
- || (config.get_external_sync() && sync_src == MTC)
- */
- || (config.get_external_sync() && sync_src == MIDIClock)
- ) {
- memset(out, 0, nframes * sizeof(jack_default_audio_sample_t));
- return nframes;
+ if (engine().freewheeling() || !Config->get_send_ltc()
+ /* TODO
+ * decide which time-sources we can generated LTC from.
+ * Internal, JACK or sample-synced slaves should be fine.
+ * talk to oofus.
+ *
+ || (config.get_external_sync() && sync_src == LTC)
+ || (config.get_external_sync() && sync_src == MTC)
+ */
+ ||(config.get_external_sync() && sync_src == MIDIClock)
+ ) {
+ return;
}
+ out = dynamic_cast<AudioBuffer*>(&buf)->data ();
+
/* range from libltc (38..218) || - 128.0 -> (-90..90) */
const float ltcvol = Config->get_ltc_output_volume()/(90.0); // pow(10, db/20.0)/(90.0);
- jack_latency_range_t ltc_latency;
- ltcport->get_connected_latency_range(ltc_latency, true);
- DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX %1 to %2 / %3 | lat: %4\n", start_frame, end_frame, nframes, ltc_latency.max));
+ DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX %1 to %2 / %3 | lat: %4\n", start_frame, end_frame, nframes, ltc_out_latency.max));
/* all systems go. Now here's the plan:
*
TimecodeFormat cur_timecode = config.get_timecode_format();
if (cur_timecode != ltc_enc_tcformat) {
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)));
- if (ltc_encoder_reinit(ltc_encoder, nominal_frame_rate(), timecode_to_frames_per_second(cur_timecode), 0)) {
+ if (ltc_encoder_reinit(ltc_encoder, nominal_frame_rate(),
+ timecode_to_frames_per_second(cur_timecode),
+ TV_STANDARD(cur_timecode), 0
+ )) {
PBD::error << _("LTC encoder: invalid framerate - LTC encoding is disabled for the remainder of this session.") << endmsg;
ltc_tx_cleanup();
- return 0;
+ return;
}
+ ltc_encoder_set_filter(ltc_encoder, LTC_RISE_TIME(ltc_speed));
ltc_enc_tcformat = cur_timecode;
+ ltc_tx_parse_offset();
ltc_tx_reset();
}
/* LTC is max. 30 fps */
if (timecode_to_frames_per_second(cur_timecode) > 30) {
- memset(out, 0, nframes * sizeof(jack_default_audio_sample_t));
- return nframes;
+ return;
}
// (2) speed & direction
+
+ /* speed 0 aka transport stopped is interpreted as rolling forward.
+ * keep repeating current frame
+ */
#define SIGNUM(a) ( (a) < 0 ? -1 : 1)
bool speed_changed = false;
- /* use port latency compensation */
-#if 1
- /* The generated timecode is offset by the port-latency,
+ /* port latency compensation:
+ * The _generated timecode_ is offset by the port-latency,
* therefore the offset depends on the direction of transport.
*/
- framepos_t cycle_start_frame = (current_speed < 0) ? (start_frame + ltc_latency.max) : (start_frame - ltc_latency.max);
-#else
- /* This comes in handy when testing sync - record output on an A3 track
- * see also http://tracker.ardour.org/view.php?id=5073
- */
- framepos_t cycle_start_frame = start_frame;
-#endif
+ framepos_t cycle_start_frame = (current_speed < 0) ? (start_frame - ltc_out_latency.max) : (start_frame + ltc_out_latency.max);
+
+ /* LTC TV standard offset */
+ cycle_start_frame -= ltc_frame_alignment(frames_per_timecode_frame(), TV_STANDARD(cur_timecode));
/* cycle-start may become negative due to latency compensation */
if (cycle_start_frame < 0) { cycle_start_frame = 0; }
- double new_ltc_speed = double(labs(end_frame - start_frame) * SIGNUM(current_speed)) / double(nframes);
+ double new_ltc_speed = (double)(labs(end_frame - start_frame) * SIGNUM(current_speed)) / (double)nframes;
+ if (nominal_frame_rate() != frame_rate()) {
+ new_ltc_speed *= (double)nominal_frame_rate() / (double)frame_rate();
+ }
if (SIGNUM(new_ltc_speed) != SIGNUM (ltc_speed)) {
DEBUG_TRACE (DEBUG::LTC, "LTC TX2: transport changed direction\n");
*/
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));
speed_changed = true;
+ ltc_encoder_set_filter(ltc_encoder, LTC_RISE_TIME(new_ltc_speed));
}
if (end_frame == start_frame || fabs(current_speed) < 0.1 ) {
new_ltc_speed = 0;
if (!Config->get_ltc_send_continuously()) {
ltc_speed = new_ltc_speed;
- memset(out, 0, nframes * sizeof(jack_default_audio_sample_t));
- return nframes;
+ return;
}
}
if (fabs(new_ltc_speed) > 10.0) {
DEBUG_TRACE (DEBUG::LTC, "LTC TX2: speed is out of bounds.\n");
ltc_tx_reset();
- memset(out, 0, nframes * sizeof(jack_default_audio_sample_t));
- return nframes;
+ return;
}
if (ltc_speed == 0 && new_ltc_speed != 0) {
* which is left for later..
*/
- double oldbuflen = double(ltc_buf_len - ltc_buf_off);
- double newbuflen = double(ltc_buf_len - ltc_buf_off) * fabs(ltc_speed / new_ltc_speed);
+ double oldbuflen = (double)(ltc_buf_len - ltc_buf_off);
+ double newbuflen = (double)(ltc_buf_len - ltc_buf_off) * fabs(ltc_speed / new_ltc_speed);
DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX2: bufOld %1 bufNew %2 | diff %3\n",
(ltc_buf_len - ltc_buf_off), newbuflen, newbuflen - oldbuflen
ltc_speed = new_ltc_speed;
DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX2: transport speed %1.\n", ltc_speed));
-
// (3) bit/sample alignment
Timecode::Time tc_start;
framepos_t tc_sample_start;
/* calc timecode frame from current position - round down to nearest timecode */
- sample_to_timecode(cycle_start_frame, tc_start, true, false);
+ Timecode::sample_to_timecode(cycle_start_frame, tc_start, true, false,
+ timecode_frames_per_second(),
+ timecode_drop_frames(),
+ (double)frame_rate(),
+ config.get_subframes_per_frame(),
+ ltc_timecode_negative_offset, ltc_timecode_offset
+ );
/* convert timecode back to sample-position */
Timecode::timecode_to_sample (tc_start, tc_sample_start, true, false,
- double(frame_rate()),
+ (double)frame_rate(),
config.get_subframes_per_frame(),
- config.get_timecode_offset_negative(), config.get_timecode_offset()
+ ltc_timecode_negative_offset, ltc_timecode_offset
);
/* difference between current frame and TC frame in samples */
// (4) check if alignment matches
- const double fptcf = frames_per_timecode_frame(); // convenient, used a lot below.
+ const double fptcf = frames_per_timecode_frame();
/* maximum difference of bit alignment in audio-samples.
*
maxdiff = slave()->resolution();
} else {
maxdiff = ceil(fabs(ltc_speed))*2.0;
+ if (nominal_frame_rate() != frame_rate()) {
+ maxdiff *= 3.0;
+ }
+ if (ltc_enc_tcformat == Timecode::timecode_23976 || ltc_enc_tcformat == Timecode::timecode_24976) {
+ maxdiff *= 15.0;
+ }
}
DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX4: enc: %1 + %2 - %3 || buf-bytes: %4 enc-byte: %5\n",
rint(ltc_enc_pos + ltc_enc_cnt - poff) - cycle_start_frame
));
- if (ltc_speed != 0 && fabs(ceil(ltc_enc_pos + ltc_enc_cnt - poff) - cycle_start_frame) > maxdiff)
- {
+ if (ltc_enc_pos < 0
+ || (ltc_speed != 0 && fabs(ceil(ltc_enc_pos + ltc_enc_cnt - poff) - cycle_start_frame) > maxdiff)
+ ) {
+
// (5) re-align
ltc_tx_reset();
DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX4: now: %1 trs: %2 toff %3\n", cycle_start_frame, tc_sample_start, soff));
uint32_t cyc_off;
- assert(soff >= 0 && soff < fptcf);
+ if (soff < 0 || soff >= fptcf) {
+ /* session framerate change between (2) and now */
+ ltc_tx_reset();
+ return;
+ }
if (ltc_speed < 0 ) {
/* calculate the byte that starts at or after the current position */
ltc_enc_byte = floor((10.0 * soff) / (fptcf));
- ltc_enc_cnt = double(ltc_enc_byte * fptcf / 10.0);
+ ltc_enc_cnt = ltc_enc_byte * fptcf / 10.0;
/* calculate difference between the current position and the byte to send */
cyc_off = soff- ceil(ltc_enc_cnt);
} else {
/* calculate the byte that starts at or after the current position */
ltc_enc_byte = ceil((10.0 * soff) / fptcf);
- ltc_enc_cnt = double(ltc_enc_byte * fptcf / 10.0);
+ ltc_enc_cnt = ltc_enc_byte * fptcf / 10.0;
/* calculate difference between the current position and the byte to send */
cyc_off = ceil(ltc_enc_cnt) - soff;
}
}
- assert (cyc_off >= 0);
-
DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX5 restart encoder: soff %1 byte %2 cycoff %3\n",
soff, ltc_enc_byte, cyc_off));
+ if ( (ltc_speed < 0 && ltc_enc_byte !=9 ) || (ltc_speed >= 0 && ltc_enc_byte !=0 ) ) {
+ restarting = true;
+ }
+
if (cyc_off > 0 && cyc_off <= nframes) {
/* offset in this cycle */
txf= rint(cyc_off / fabs(ltc_speed));
- memset(out, 0, cyc_off * sizeof(jack_default_audio_sample_t));
+ memset(out, 0, cyc_off * sizeof(Sample));
} else {
/* resync next cycle */
- memset(out, 0, cyc_off * sizeof(jack_default_audio_sample_t));
- return nframes;
+ memset(out, 0, nframes * sizeof(Sample));
+ return;
}
ltc_enc_pos = tc_sample_start;
DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX5 restart @ %1 + %2 - %3 | byte %4\n",
ltc_enc_pos, ltc_enc_cnt, cyc_off, ltc_enc_byte));
}
+ else if (ltc_speed != 0 && (fptcf / ltc_speed / 80) > 3 ) {
+ /* reduce (low freq) jitter.
+ * The granularity of the LTC encoder speed is 1 byte =
+ * (frames-per-timecode-frame / 10) audio-samples.
+ * Thus, tiny speed changes [as produced by some slaves]
+ * may not have any effect in the cycle when they occur,
+ * but they will add up over time.
+ *
+ * This is a linear approx to compensate for this jitter
+ * and prempt re-sync when the drift builds up.
+ *
+ * However, for very fast speeds - when 1 LTC bit is
+ * <= 3 audio-sample - adjusting speed may lead to
+ * invalid frames.
+ *
+ * To do better than this, resampling (or a rewrite of the
+ * encoder) is required.
+ */
+ ltc_speed -= ((ltc_enc_pos + ltc_enc_cnt - poff) - cycle_start_frame) / engine().frame_rate();
+ }
// (6) encode and output
// (6a) send remaining buffer
while ((ltc_buf_off < ltc_buf_len) && (txf < nframes)) {
const float v1 = ltc_enc_buf[ltc_buf_off++] - 128.0;
- const jack_default_audio_sample_t val = (jack_default_audio_sample_t) (v1*ltcvol);
+ const Sample val = (Sample) (v1*ltcvol);
out[txf++] = val;
}
#ifdef LTC_GEN_TXDBUG
if (txf >= nframes) {
DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX7 enc: %1 [ %2 / %3 ] byte: %4 spd %5 fpp %6 || nf: %7\n",
ltc_enc_pos, ltc_buf_off, ltc_buf_len, ltc_enc_byte, ltc_speed, nframes, txf));
- return nframes;
+ break;
}
ltc_buf_len = 0;
}
}
- if (ltc_encoder_encode_byte(ltc_encoder, ltc_enc_byte, (ltc_speed==0)?1.0:(1.0/ltc_speed))) {
- DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX6.3 encoder error byte %1\n", ltc_enc_byte));
- ltc_encoder_buffer_flush(ltc_encoder);
- ltc_tx_reset();
- memset(out, 0, nframes * sizeof(jack_default_audio_sample_t));
- return -1;
+ int enc_frames;
+
+ if (restarting) {
+ /* write zero bytes -- don't touch encoder until we're at a frame-boundary
+ * otherwise the biphase polarity may be inverted.
+ */
+ enc_frames = fptcf / 10.0;
+ memset(<c_enc_buf[ltc_buf_len], 127, enc_frames * sizeof(ltcsnd_sample_t));
+ } else {
+ if (ltc_encoder_encode_byte(ltc_encoder, ltc_enc_byte, (ltc_speed==0)?1.0:(1.0/ltc_speed))) {
+ DEBUG_TRACE (DEBUG::LTC, string_compose("LTC TX6.3 encoder error byte %1\n", ltc_enc_byte));
+ ltc_encoder_buffer_flush(ltc_encoder);
+ ltc_tx_reset();
+ return;
+ }
+ enc_frames = ltc_encoder_get_buffer(ltc_encoder, &(ltc_enc_buf[ltc_buf_len]));
}
- int enc_frames = ltc_encoder_get_buffer(ltc_encoder, &(ltc_enc_buf[ltc_buf_len]));
+
#ifdef LTC_GEN_FRAMEDBUG
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));
#endif
DEBUG_TRACE (DEBUG::LTC, "LTC TX6.3 encoder empty buffer.\n");
ltc_encoder_buffer_flush(ltc_encoder);
ltc_tx_reset();
- memset(out, 0, nframes * sizeof(jack_default_audio_sample_t));
- return -1;
+ return;
}
ltc_buf_len += enc_frames;
ltc_enc_byte = (ltc_enc_byte + 1)%10;
if (ltc_enc_byte == 0 && ltc_speed != 0) {
ltc_encoder_inc_timecode(ltc_encoder);
+#if 0 /* force fixed parity -- scope debug */
+ LTCFrame f;
+ ltc_encoder_get_frame(ltc_encoder, &f);
+ f.biphase_mark_phase_correction=0;
+ ltc_encoder_set_frame(ltc_encoder, &f);
+#endif
ltc_tx_recalculate_position();
ltc_enc_cnt = 0;
} else if (ltc_enc_byte == 0) {
ltc_enc_cnt = 0;
+ restarting=false;
}
}
#ifdef LTC_GEN_FRAMEDBUG
#endif
}
- return nframes;
+ dynamic_cast<AudioBuffer*>(&buf)->set_written (true);
+ return;
}
projects / ardour.git / blobdiff