3 Copyright (C) 1999-2002 Paul Davis
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.
22 #include "libardour-config.h"
29 #include "ardour/timestamps.h"
31 #include "pbd/error.h"
32 #include "pbd/enumwriter.h"
33 #include "pbd/stacktrace.h"
35 #include "ardour/ardour.h"
36 #include "ardour/configuration.h"
37 #include "ardour/audioengine.h"
38 #include "ardour/session.h"
39 #include "ardour/tempo.h"
44 using namespace ARDOUR;
50 Session::bbt_time (nframes_t when, BBT_Time& bbt)
52 _tempo_map->bbt_time (when, bbt);
57 Session::timecode_frames_per_second() const
59 switch (config.get_timecode_format()) {
80 case timecode_2997drop:
101 cerr << "Editor received unexpected timecode type" << endl;
106 Session::timecode_drop_frames() const
108 switch (config.get_timecode_format()) {
129 case timecode_2997drop:
137 case timecode_30drop:
150 error << "Editor received unexpected timecode type" << endmsg;
156 Session::sync_time_vars ()
158 _current_frame_rate = (nframes_t) round (_base_frame_rate * (1.0 + (config.get_video_pullup()/100.0)));
159 _frames_per_timecode_frame = (double) _current_frame_rate / (double) timecode_frames_per_second();
160 if (timecode_drop_frames()) {
161 _frames_per_hour = (int32_t)(107892 * _frames_per_timecode_frame);
163 _frames_per_hour = (int32_t)(3600 * rint(timecode_frames_per_second()) * _frames_per_timecode_frame);
165 _timecode_frames_per_hour = (nframes_t)rint(timecode_frames_per_second() * 3600.0);
167 last_timecode_valid = false;
168 // timecode type bits are the middle two in the upper nibble
169 switch ((int) ceil (timecode_frames_per_second())) {
171 mtc_timecode_bits = 0;
175 mtc_timecode_bits = 0x20;
180 if (timecode_drop_frames()) {
181 mtc_timecode_bits = 0x40;
183 mtc_timecode_bits = 0x60;
190 Session::set_timecode_offset (nframes_t off)
192 _timecode_offset = off;
193 last_timecode_valid = false;
195 TimecodeOffsetChanged (); /* EMIT SIGNAL */
199 Session::set_timecode_offset_negative (bool neg)
201 _timecode_offset_negative = neg;
202 last_timecode_valid = false;
204 TimecodeOffsetChanged (); /* EMIT SIGNAL */
208 Session::timecode_to_sample( Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes ) const
212 // The drop frame format was created to better approximate the 30000/1001 = 29.97002997002997....
213 // framerate of NTSC color TV. The used frame rate of drop frame is 29.97, which drifts by about
214 // 0.108 frame per hour, or about 1.3 frames per 12 hours. This is not perfect, but a lot better
215 // than using 30 non drop, which will drift with about 1.8 frame per minute.
216 // Using 29.97, drop frame real time can be accurate only every 10th minute (10 minutes of 29.97 fps
217 // is exactly 17982 frames). One minute is 1798.2 frames, but we count 30 frames per second
218 // (30 * 60 = 1800). This means that at the first minute boundary (at the end of 0:0:59:29) we
219 // are 1.8 frames too late relative to real time. By dropping 2 frames (jumping to 0:1:0:2) we are
220 // approx. 0.2 frames too early. This adds up with 0.2 too early for each minute until we are 1.8
221 // frames too early at 0:9:0:2 (9 * 0.2 = 1.8). The 10th minute brings us 1.8 frames later again
222 // (at end of 0:9:59:29), which sums up to 0 (we are back to zero at 0:10:0:0 :-).
226 // Timecode value frames offset subframes offset seconds (rounded) 44100 sample (rounded)
227 // 0:00:00:00 0.0 0 0.000 0 (accurate)
228 // 0:00:59:29 1.8 144 60.027 2647177
229 // 0:01:00:02 -0.2 -16 60.060 2648648
230 // 0:01:59:29 1.6 128 120.020 5292883
231 // 0:02:00:02 -0.4 -32 120.053 5294354
232 // 0:02:59:29 1.4 112 180.013 7938588
233 // 0:03:00:02 -0.6 -48 180.047 7940060
234 // 0:03:59:29 1.2 96 240.007 10584294
235 // 0:04:00:02 -0.8 -64 240.040 10585766
236 // 0:04:59:29 1.0 80 300.000 13230000
237 // 0:05:00:02 -1.0 -80 300.033 13231471
238 // 0:05:59:29 0.8 64 359.993 15875706
239 // 0:06:00:02 -1.2 -96 360.027 15877177
240 // 0:06:59:29 0.6 48 419.987 18521411
241 // 0:07:00:02 -1.4 -112 420.020 18522883
242 // 0:07:59:29 0.4 32 478.980 21167117
243 // 0:08:00:02 -1.6 -128 480.013 21168589
244 // 0:08:59:29 0.2 16 539.973 23812823
245 // 0:09:00:02 -1.8 -144 540.007 23814294
246 // 0:09:59:29 0.0+ 0+ 599.967 26458529
247 // 0:10:00:00 0.0 0 600.000 26460000 (accurate)
249 // Per Sigmond <per@sigmond.no>
251 // Samples inside time dividable by 10 minutes (real time accurate)
252 nframes_t base_samples = (nframes_t) (((timecode.hours * 107892) + ((timecode.minutes / 10) * 17982)) * _frames_per_timecode_frame);
254 // Samples inside time exceeding the nearest 10 minutes (always offset, see above)
255 int32_t exceeding_df_minutes = timecode.minutes % 10;
256 int32_t exceeding_df_seconds = (exceeding_df_minutes * 60) + timecode.seconds;
257 int32_t exceeding_df_frames = (30 * exceeding_df_seconds) + timecode.frames - (2 * exceeding_df_minutes);
258 nframes_t exceeding_samples = (nframes_t) rint(exceeding_df_frames * _frames_per_timecode_frame);
259 sample = base_samples + exceeding_samples;
262 Non drop is easy.. just note the use of
263 rint(timecode.rate) * _frames_per_timecode_frame
264 (frames per Timecode second), which is larger than
265 frame_rate() in the non-integer Timecode rate case.
268 sample = (nframes_t)rint((((timecode.hours * 60 * 60) + (timecode.minutes * 60) + timecode.seconds) * (rint(timecode.rate) * _frames_per_timecode_frame)) + (timecode.frames * _frames_per_timecode_frame));
272 sample += (int32_t) (((double)timecode.subframes * _frames_per_timecode_frame) / config.get_subframes_per_frame());
276 if (timecode_offset_negative()) {
277 if (sample >= timecode_offset()) {
278 sample -= timecode_offset();
280 /* Prevent song-time from becoming negative */
284 if (timecode.negative) {
285 if (sample <= timecode_offset()) {
286 sample = timecode_offset() - sample;
291 sample += timecode_offset();
300 Session::sample_to_timecode (framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes ) const
302 framepos_t offset_sample;
305 offset_sample = sample;
306 timecode.negative = false;
308 if (_timecode_offset_negative) {
309 offset_sample = sample + _timecode_offset;
310 timecode.negative = false;
312 if (sample < _timecode_offset) {
313 offset_sample = (_timecode_offset - sample);
314 timecode.negative = true;
316 offset_sample = sample - _timecode_offset;
317 timecode.negative = false;
322 double timecode_frames_left_exact;
323 double timecode_frames_fraction;
324 uint32_t timecode_frames_left;
326 // Extract whole hours. Do this to prevent rounding errors with
327 // high sample numbers in the calculations that follow.
328 timecode.hours = offset_sample / _frames_per_hour;
329 offset_sample = offset_sample % _frames_per_hour;
331 // Calculate exact number of (exceeding) timecode frames and fractional frames
332 timecode_frames_left_exact = (double) offset_sample / _frames_per_timecode_frame;
333 timecode_frames_fraction = timecode_frames_left_exact - floor( timecode_frames_left_exact );
334 timecode.subframes = (int32_t) rint(timecode_frames_fraction * config.get_subframes_per_frame());
336 // XXX Not sure if this is necessary anymore...
337 if (timecode.subframes == config.get_subframes_per_frame()) {
338 // This can happen with 24 fps (and 29.97 fps ?)
339 timecode_frames_left_exact = ceil( timecode_frames_left_exact );
340 timecode.subframes = 0;
343 // Extract hour-exceeding frames for minute, second and frame calculations
344 timecode_frames_left = (uint32_t) floor (timecode_frames_left_exact);
346 if (timecode_drop_frames()) {
347 // See int32_t explanation in timecode_to_sample()...
349 // Number of 10 minute chunks
350 timecode.minutes = (timecode_frames_left / 17982) * 10; // exactly 17982 frames in 10 minutes
351 // frames exceeding the nearest 10 minute barrier
352 int32_t exceeding_df_frames = timecode_frames_left % 17982;
354 // Find minutes exceeding the nearest 10 minute barrier
355 if (exceeding_df_frames >= 1800) { // nothing to do if we are inside the first minute (0-1799)
356 exceeding_df_frames -= 1800; // take away first minute (different number of frames than the others)
357 int32_t extra_minutes_minus_1 = exceeding_df_frames / 1798; // how many minutes after the first one
358 exceeding_df_frames -= extra_minutes_minus_1 * 1798; // take away the (extra) minutes just found
359 timecode.minutes += extra_minutes_minus_1 + 1; // update with exceeding minutes
362 // Adjust frame numbering for dropped frames (frame 0 and 1 skipped at start of every minute except every 10th)
363 if (timecode.minutes % 10) {
364 // Every minute except every 10th
365 if (exceeding_df_frames < 28) {
366 // First second, frames 0 and 1 are skipped
367 timecode.seconds = 0;
368 timecode.frames = exceeding_df_frames + 2;
370 // All other seconds, all 30 frames are counted
371 exceeding_df_frames -= 28;
372 timecode.seconds = (exceeding_df_frames / 30) + 1;
373 timecode.frames = exceeding_df_frames % 30;
376 // Every 10th minute, all 30 frames counted in all seconds
377 timecode.seconds = exceeding_df_frames / 30;
378 timecode.frames = exceeding_df_frames % 30;
382 timecode.minutes = timecode_frames_left / ((int32_t) rint (timecode_frames_per_second ()) * 60);
383 timecode_frames_left = timecode_frames_left % ((int32_t) rint (timecode_frames_per_second ()) * 60);
384 timecode.seconds = timecode_frames_left / (int32_t) rint(timecode_frames_per_second ());
385 timecode.frames = timecode_frames_left % (int32_t) rint(timecode_frames_per_second ());
388 if (!use_subframes) {
389 timecode.subframes = 0;
391 /* set frame rate and drop frame */
392 timecode.rate = timecode_frames_per_second ();
393 timecode.drop = timecode_drop_frames();
397 Session::timecode_time (nframes_t when, Timecode::Time& timecode)
399 if (last_timecode_valid && when == last_timecode_when) {
400 timecode = last_timecode;
404 sample_to_timecode( when, timecode, true /* use_offset */, false /* use_subframes */ );
406 last_timecode_when = when;
407 last_timecode = timecode;
408 last_timecode_valid = true;
412 Session::timecode_time_subframes (nframes_t when, Timecode::Time& timecode)
414 if (last_timecode_valid && when == last_timecode_when) {
415 timecode = last_timecode;
419 sample_to_timecode( when, timecode, true /* use_offset */, true /* use_subframes */ );
421 last_timecode_when = when;
422 last_timecode = timecode;
423 last_timecode_valid = true;
427 Session::timecode_duration (nframes_t when, Timecode::Time& timecode) const
429 sample_to_timecode( when, timecode, false /* use_offset */, true /* use_subframes */ );
433 Session::timecode_duration_string (char* buf, framepos_t when) const
435 Timecode::Time timecode;
437 timecode_duration (when, timecode);
438 snprintf (buf, sizeof (buf), "%02" PRIu32 ":%02" PRIu32 ":%02" PRIu32 ":%02" PRIu32, timecode.hours, timecode.minutes, timecode.seconds, timecode.frames);
442 Session::timecode_time (Timecode::Time &t)
445 timecode_time (_transport_frame, t);
449 Session::jack_sync_callback (jack_transport_state_t state,
450 jack_position_t* pos)
452 bool slave = synced_to_jack();
455 case JackTransportStopped:
456 if (slave && _transport_frame != pos->frame && post_transport_work() == 0) {
457 request_locate (pos->frame, false);
458 // cerr << "SYNC: stopped, locate to " << pos->frame << " from " << _transport_frame << endl;
464 case JackTransportStarting:
465 // cerr << "SYNC: starting @ " << pos->frame << " a@ " << _transport_frame << " our work = " << post_transport_work() << " pos matches ? " << (_transport_frame == pos->frame) << endl;
467 return _transport_frame == pos->frame && post_transport_work() == 0;
473 case JackTransportRolling:
474 // cerr << "SYNC: rolling slave = " << slave << endl;
481 error << string_compose (_("Unknown JACK transport state %1 in sync callback"), state)
489 Session::jack_timebase_callback (jack_transport_state_t /*state*/,
490 nframes_t /*nframes*/,
491 jack_position_t* pos,
492 int /*new_position*/)
496 if (pos->frame != _transport_frame) {
497 cerr << "ARDOUR says " << _transport_frame << " JACK says " << pos->frame << endl;
504 TempoMetric metric (_tempo_map->metric_at (_transport_frame));
505 _tempo_map->bbt_time_with_metric (_transport_frame, bbt, metric);
508 pos->beat = bbt.beats;
509 pos->tick = bbt.ticks;
511 // XXX still need to set bar_start_tick
513 pos->beats_per_bar = metric.meter().beats_per_bar();
514 pos->beat_type = metric.meter().note_divisor();
515 pos->ticks_per_beat = Meter::ticks_per_beat;
516 pos->beats_per_minute = metric.tempo().beats_per_minute();
518 pos->valid = jack_position_bits_t (pos->valid | JackPositionBBT);
521 #ifdef HAVE_JACK_VIDEO_SUPPORT
522 //poke audio video ratio so Ardour can track Video Sync
523 pos->audio_frames_per_video_frame = frame_rate() / timecode_frames_per_second();
524 pos->valid = jack_position_bits_t (pos->valid | JackAudioVideoRatio);
530 pos->timecode_offset = _timecode_offset;
531 t.timecode_frame_rate = timecode_frames_per_second();
532 pos->valid = jack_position_bits_t (pos->valid | JackPositionTimecode;
534 if (_transport_speed) {
538 Location* location = _locations.auto_loop_location();
542 t.transport_state = JackTransportLooping;
543 t.loop_start = location->start();
544 t.loop_end = location->end();
545 t.valid = jack_transport_bits_t (t.valid | JackTransportLoop);
551 t.transport_state = JackTransportRolling;
559 t.transport_state = JackTransportRolling;
568 Session::convert_to_frames_at (nframes_t /*position*/, AnyTime const & any)
574 return _tempo_map->frame_time ( any.bbt);
577 case AnyTime::Timecode:
578 /* XXX need to handle negative values */
579 secs = any.timecode.hours * 60 * 60;
580 secs += any.timecode.minutes * 60;
581 secs += any.timecode.seconds;
582 secs += any.timecode.frames / timecode_frames_per_second();
583 if (_timecode_offset_negative)
585 return (nframes_t) floor (secs * frame_rate()) - _timecode_offset;
589 return (nframes_t) floor (secs * frame_rate()) + _timecode_offset;
593 case AnyTime::Seconds:
594 return (nframes_t) floor (any.seconds * frame_rate());
597 case AnyTime::Frames: