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.
26 #include <ardour/timestamps.h>
28 #include <pbd/error.h>
30 #include <ardour/ardour.h>
31 #include <ardour/configuration.h>
32 #include <ardour/audioengine.h>
33 #include <ardour/session.h>
34 #include <ardour/tempo.h>
38 using namespace ARDOUR;
39 //using namespace sigc;
44 Session::bbt_time (jack_nframes_t when, BBT_Time& bbt)
46 _tempo_map->bbt_time (when, bbt);
52 Session::set_smpte_type (float fps, bool drop_frames)
54 smpte_frames_per_second = fps;
55 smpte_drop_frames = drop_frames;
56 _frames_per_smpte_frame = (double) _current_frame_rate / (double) smpte_frames_per_second;
57 _frames_per_hour = _current_frame_rate * 3600;
58 _smpte_frames_per_hour = (unsigned long) (smpte_frames_per_second * 3600.0);
61 last_smpte_valid = false;
62 // smpte type bits are the middle two in the upper nibble
63 switch ((int) ceil (fps)) {
69 mtc_smpte_bits = 0x20;
75 mtc_smpte_bits = 0x40;
77 mtc_smpte_bits = 0x60;
82 SMPTETypeChanged (); /* EMIT SIGNAL */
90 Session::set_smpte_offset (jack_nframes_t off)
93 last_smpte_valid = false;
94 SMPTEOffsetChanged (); /* EMIT SIGNAL */
98 Session::set_smpte_offset_negative (bool neg)
100 _smpte_offset_negative = neg;
101 last_smpte_valid = false;
102 SMPTEOffsetChanged (); /* EMIT SIGNAL */
105 #define SMPTE_IS_AROUND_ZERO( sm ) (!(sm).frames && !(sm).seconds && !(sm).minutes && !(sm).hours)
106 #define SMPTE_IS_ZERO( sm ) (!(sm).frames && !(sm).seconds && !(sm).minutes && !(sm).hours && !(sm.subframes))
108 // Increment by exactly one frame (keep subframes value)
109 // Return true if seconds wrap
111 Session::smpte_increment( SMPTE_Time& smpte ) const
113 smpte_wrap_t wrap = smpte_wrap_none;
115 if (smpte.negative) {
116 if (SMPTE_IS_AROUND_ZERO(smpte) && smpte.subframes) {
117 // We have a zero transition involving only subframes
118 smpte.subframes = 80 - smpte.subframes;
119 smpte.negative = false;
120 return smpte_wrap_seconds;
123 smpte.negative = false;
124 wrap = smpte_decrement( smpte );
125 if (!SMPTE_IS_ZERO( smpte )) {
126 smpte.negative = true;
131 switch (mtc_smpte_bits >> 5) {
132 case MIDI::MTC_24_FPS:
133 if (smpte.frames == 23) {
135 wrap = smpte_wrap_seconds;
138 case MIDI::MTC_25_FPS:
139 if (smpte.frames == 24) {
141 wrap = smpte_wrap_seconds;
144 case MIDI::MTC_30_FPS_DROP:
145 if (smpte.frames == 29) {
146 if ( ((smpte.minutes + 1) % 10) && (smpte.seconds == 59) ) {
152 wrap = smpte_wrap_seconds;
155 case MIDI::MTC_30_FPS:
156 if (smpte.frames == 29) {
158 wrap = smpte_wrap_seconds;
163 if (wrap == smpte_wrap_seconds) {
164 if (smpte.seconds == 59) {
166 wrap = smpte_wrap_minutes;
167 if (smpte.minutes == 59) {
169 wrap = smpte_wrap_hours;
184 // Decrement by exactly one frame (keep subframes value)
186 Session::smpte_decrement( SMPTE_Time& smpte ) const
188 smpte_wrap_t wrap = smpte_wrap_none;
191 if (smpte.negative || SMPTE_IS_ZERO(smpte)) {
192 smpte.negative = false;
193 wrap = smpte_increment( smpte );
194 smpte.negative = true;
196 } else if (SMPTE_IS_AROUND_ZERO(smpte) && smpte.subframes) {
197 // We have a zero transition involving only subframes
198 smpte.subframes = 80 - smpte.subframes;
199 smpte.negative = true;
200 return smpte_wrap_seconds;
203 switch (mtc_smpte_bits >> 5) {
204 case MIDI::MTC_24_FPS:
205 if (smpte.frames == 0) {
207 wrap = smpte_wrap_seconds;
210 case MIDI::MTC_25_FPS:
211 if (smpte.frames == 0) {
213 wrap = smpte_wrap_seconds;
216 case MIDI::MTC_30_FPS_DROP:
217 if ((smpte.minutes % 10) && (smpte.seconds == 0)) {
218 if (smpte.frames <= 2) {
220 wrap = smpte_wrap_seconds;
222 } else if (smpte.frames == 0) {
224 wrap = smpte_wrap_seconds;
227 case MIDI::MTC_30_FPS:
228 if (smpte.frames == 0) {
230 wrap = smpte_wrap_seconds;
235 if (wrap == smpte_wrap_seconds) {
236 if (smpte.seconds == 0) {
238 wrap = smpte_wrap_minutes;
239 if (smpte.minutes == 0) {
241 wrap = smpte_wrap_hours;
254 if (SMPTE_IS_ZERO( smpte )) {
255 smpte.negative = false;
261 // Go to lowest absolute subframe value in this frame (set to 0 :-)
263 Session::smpte_frames_floor( SMPTE_Time& smpte ) const
266 if (SMPTE_IS_ZERO(smpte)) {
267 smpte.negative = false;
271 // Increment by one subframe
273 Session::smpte_increment_subframes( SMPTE_Time& smpte ) const
275 smpte_wrap_t wrap = smpte_wrap_none;
277 if (smpte.negative) {
278 smpte.negative = false;
279 wrap = smpte_decrement_subframes( smpte );
280 if (!SMPTE_IS_ZERO(smpte)) {
281 smpte.negative = true;
287 if (smpte.subframes >= 80) {
289 smpte_increment( smpte );
290 return smpte_wrap_frames;
292 return smpte_wrap_none;
296 // Decrement by one subframe
298 Session::smpte_decrement_subframes( SMPTE_Time& smpte ) const
300 smpte_wrap_t wrap = smpte_wrap_none;
302 if (smpte.negative) {
303 smpte.negative = false;
304 wrap = smpte_increment_subframes( smpte );
305 smpte.negative = true;
309 if (smpte.subframes <= 0) {
311 if (SMPTE_IS_ZERO(smpte)) {
312 smpte.negative = true;
314 return smpte_wrap_frames;
316 smpte_decrement( smpte );
317 smpte.subframes = 79;
318 return smpte_wrap_frames;
322 if (SMPTE_IS_ZERO(smpte)) {
323 smpte.negative = false;
325 return smpte_wrap_none;
330 // Go to next whole second (frames == 0 or frames == 2)
332 Session::smpte_increment_seconds( SMPTE_Time& smpte ) const
334 smpte_wrap_t wrap = smpte_wrap_none;
337 smpte_frames_floor( smpte );
339 if (smpte.negative) {
340 // Wrap second if on second boundary
341 wrap = smpte_increment(smpte);
342 // Go to lowest absolute frame value
343 smpte_seconds_floor( smpte );
344 if (SMPTE_IS_ZERO(smpte)) {
345 smpte.negative = false;
348 // Go to highest possible frame in this second
349 switch (mtc_smpte_bits >> 5) {
350 case MIDI::MTC_24_FPS:
353 case MIDI::MTC_25_FPS:
356 case MIDI::MTC_30_FPS_DROP:
357 case MIDI::MTC_30_FPS:
362 // Increment by one frame
363 wrap = smpte_increment( smpte );
369 // Go to lowest (absolute) frame value in this second
370 // Doesn't care about positive/negative
372 Session::smpte_seconds_floor( SMPTE_Time& smpte ) const
375 smpte_frames_floor( smpte );
377 // Go to lowest possible frame in this second
378 switch (mtc_smpte_bits >> 5) {
379 case MIDI::MTC_24_FPS:
380 case MIDI::MTC_25_FPS:
381 case MIDI::MTC_30_FPS:
384 case MIDI::MTC_30_FPS_DROP:
385 if ((smpte.minutes % 10) && (smpte.seconds == 0)) {
393 if (SMPTE_IS_ZERO(smpte)) {
394 smpte.negative = false;
399 // Go to next whole minute (seconds == 0, frames == 0 or frames == 2)
401 Session::smpte_increment_minutes( SMPTE_Time& smpte ) const
403 smpte_wrap_t wrap = smpte_wrap_none;
406 smpte_frames_floor( smpte );
408 if (smpte.negative) {
409 // Wrap if on minute boundary
410 wrap = smpte_increment_seconds( smpte );
411 // Go to lowest possible value in this minute
412 smpte_minutes_floor( smpte );
414 // Go to highest possible second
416 // Wrap minute by incrementing second
417 wrap = smpte_increment_seconds( smpte );
423 // Go to lowest absolute value in this minute
425 Session::smpte_minutes_floor( SMPTE_Time& smpte ) const
427 // Go to lowest possible second
429 // Go to lowest possible frame
430 smpte_seconds_floor( smpte );
432 if (SMPTE_IS_ZERO(smpte)) {
433 smpte.negative = false;
437 // Go to next whole hour (minute = 0, second = 0, frame = 0)
439 Session::smpte_increment_hours( SMPTE_Time& smpte ) const
441 smpte_wrap_t wrap = smpte_wrap_none;
444 smpte_frames_floor(smpte);
446 if (smpte.negative) {
447 // Wrap if on hour boundary
448 wrap = smpte_increment_minutes( smpte );
449 // Go to lowest possible value in this hour
450 smpte_hours_floor( smpte );
453 wrap = smpte_increment_minutes( smpte );
459 // Go to lowest absolute value in this hour
461 Session::smpte_hours_floor( SMPTE_Time& smpte ) const
468 if (SMPTE_IS_ZERO(smpte)) {
469 smpte.negative = false;
475 Session::smpte_to_sample( SMPTE_Time& smpte, jack_nframes_t& sample, bool use_offset, bool use_subframes ) const
477 if (smpte_drop_frames) {
478 // The drop frame format was created to better approximate the 30000/1001 = 29.97002997002997....
479 // framerate of NTSC color TV. The used frame rate of drop frame is 29.97, which drifts by about
480 // 0.108 frame per hour, or about 1.3 frames per 12 hours. This is not perfect, but a lot better
481 // than using 30 non drop, which will drift with about 1.8 frame per minute.
482 // Using 29.97, drop frame real time can be accurate only every 10th minute (10 minutes of 29.97 fps
483 // is exactly 17982 frames). One minute is 1798.2 frames, but we count 30 frames per second
484 // (30 * 60 = 1800). This means that at the first minute boundary (at the end of 0:0:59:29) we
485 // are 1.8 frames too late relative to real time. By dropping 2 frames (jumping to 0:1:0:2) we are
486 // approx. 0.2 frames too early. This adds up with 0.2 too early for each minute until we are 1.8
487 // frames too early at 0:9:0:2 (9 * 0.2 = 1.8). The 10th minute brings us 1.8 frames later again
488 // (at end of 0:9:59:29), which sums up to 0 (we are back to zero at 0:10:0:0 :-).
492 // SMPTE value frames offset subframes offset seconds (rounded) 44100 sample (rounded)
493 // 0:00:00:00 0.0 0 0.000 0 (accurate)
494 // 0:00:59:29 1.8 144 60.027 2647177
495 // 0:01:00:02 -0.2 -16 60.060 2648648
496 // 0:01:59:29 1.6 128 120.020 5292883
497 // 0:02:00:02 -0.4 -32 120.053 5294354
498 // 0:02:59:29 1.4 112 180.013 7938588
499 // 0:03:00:02 -0.6 -48 180.047 7940060
500 // 0:03:59:29 1.2 96 240.007 10584294
501 // 0:04:00:02 -0.8 -64 240.040 10585766
502 // 0:04:59:29 1.0 80 300.000 13230000
503 // 0:05:00:02 -1.0 -80 300.033 13231471
504 // 0:05:59:29 0.8 64 359.993 15875706
505 // 0:06:00:02 -1.2 -96 360.027 15877177
506 // 0:06:59:29 0.6 48 419.987 18521411
507 // 0:07:00:02 -1.4 -112 420.020 18522883
508 // 0:07:59:29 0.4 32 478.980 21167117
509 // 0:08:00:02 -1.6 -128 480.013 21168589
510 // 0:08:59:29 0.2 16 539.973 23812823
511 // 0:09:00:02 -1.8 -144 540.007 23814294
512 // 0:09:59:29 0.0+ 0+ 599.967 26458529
513 // 0:10:00:00 0.0 0 600.000 26460000 (accurate)
515 // Per Sigmond <per@sigmond.no>
517 // Samples inside time dividable by 10 minutes (real time accurate)
518 jack_nframes_t base_samples = ((smpte.hours * 60 * 60) + ((smpte.minutes / 10) * 10 * 60)) * frame_rate();
519 // Samples inside time exceeding the nearest 10 minutes (always offset, see above)
520 long exceeding_df_minutes = smpte.minutes % 10;
521 long exceeding_df_seconds = (exceeding_df_minutes * 60) + smpte.seconds;
522 long exceeding_df_frames = (30 * exceeding_df_seconds) + smpte.frames - (2 * exceeding_df_minutes);
523 jack_nframes_t exceeding_samples = (jack_nframes_t) rint(exceeding_df_frames * _frames_per_smpte_frame);
524 sample = base_samples + exceeding_samples;
527 sample = (((smpte.hours * 60 * 60) + (smpte.minutes * 60) + smpte.seconds) * frame_rate()) + (jack_nframes_t)rint(smpte.frames * _frames_per_smpte_frame);
531 sample += (long) (((double)smpte.subframes * _frames_per_smpte_frame) / 80.0);
535 if (smpte_offset_negative()) {
536 if (sample >= smpte_offset()) {
537 sample -= smpte_offset();
539 /* Prevent song-time from becoming negative */
543 if (smpte.negative) {
544 if (sample <= smpte_offset()) {
545 sample = smpte_offset() - sample;
550 sample += smpte_offset();
558 Session::sample_to_smpte( jack_nframes_t sample, SMPTE_Time& smpte, bool use_offset, bool use_subframes ) const
560 jack_nframes_t offset_sample;
563 offset_sample = sample;
564 smpte.negative = false;
566 if (_smpte_offset_negative) {
567 offset_sample = sample + _smpte_offset;
568 smpte.negative = false;
570 if (sample < _smpte_offset) {
571 offset_sample = (_smpte_offset - sample);
572 smpte.negative = true;
574 offset_sample = sample - _smpte_offset;
575 smpte.negative = false;
580 double smpte_frames_left_exact;
581 double smpte_frames_fraction;
582 unsigned long smpte_frames_left;
584 // Extract whole hours. Do this to prevent rounding errors with
585 // high sample numbers in the calculations that follow.
586 smpte.hours = offset_sample / _frames_per_hour;
587 offset_sample = offset_sample % _frames_per_hour;
589 // Calculate exact number of (exceeding) smpte frames and fractional frames
590 smpte_frames_left_exact = (double) offset_sample / _frames_per_smpte_frame;
591 smpte_frames_fraction = smpte_frames_left_exact - floor( smpte_frames_left_exact );
592 smpte.subframes = (long) rint(smpte_frames_fraction * 80.0);
594 // XXX Not sure if this is necessary anymore...
595 if (smpte.subframes == 80) {
596 // This can happen with 24 fps (and 29.97 fps ?)
597 smpte_frames_left_exact = ceil( smpte_frames_left_exact );
601 // Extract hour-exceeding frames for minute, second and frame calculations
602 smpte_frames_left = ((long) floor( smpte_frames_left_exact ));
604 if (smpte_drop_frames) {
605 // See long explanation in smpte_to_sample()...
607 // Number of 10 minute chunks
608 smpte.minutes = (smpte_frames_left / 17982) * 10; // exactly 17982 frames in 10 minutes
609 // frames exceeding the nearest 10 minute barrier
610 long exceeding_df_frames = smpte_frames_left % 17982;
612 // Find minutes exceeding the nearest 10 minute barrier
613 if (exceeding_df_frames >= 1800) { // nothing to do if we are inside the first minute (0-1799)
614 exceeding_df_frames -= 1800; // take away first minute (different number of frames than the others)
615 long extra_minutes_minus_1 = exceeding_df_frames / 1798; // how many minutes after the first one
616 exceeding_df_frames -= extra_minutes_minus_1 * 1798; // take away the (extra) minutes just found
617 smpte.minutes += extra_minutes_minus_1 + 1; // update with exceeding minutes
620 // Adjust frame numbering for dropped frames (frame 0 and 1 skipped at start of every minute except every 10th)
621 if (smpte.minutes % 10) {
622 // Every minute except every 10th
623 if (exceeding_df_frames < 28) {
624 // First second, frames 0 and 1 are skipped
626 smpte.frames = exceeding_df_frames + 2;
628 // All other seconds, all 30 frames are counted
629 exceeding_df_frames -= 28;
630 smpte.seconds = (exceeding_df_frames / 30) + 1;
631 smpte.frames = exceeding_df_frames % 30;
634 // Every 10th minute, all 30 frames counted in all seconds
635 smpte.seconds = exceeding_df_frames / 30;
636 smpte.frames = exceeding_df_frames % 30;
640 smpte.minutes = smpte_frames_left / ((long) smpte_frames_per_second * 60);
641 smpte_frames_left = smpte_frames_left % ((long) smpte_frames_per_second * 60);
642 smpte.seconds = smpte_frames_left / (long) smpte_frames_per_second;
643 smpte.frames = smpte_frames_left % (long) smpte_frames_per_second;
646 if (!use_subframes) {
652 Session::smpte_time (jack_nframes_t when, SMPTE_Time& smpte)
654 if (last_smpte_valid && when == last_smpte_when) {
659 sample_to_smpte( when, smpte, true /* use_offset */, false /* use_subframes */ );
661 last_smpte_when = when;
663 last_smpte_valid = true;
667 Session::smpte_time_subframes (jack_nframes_t when, SMPTE_Time& smpte)
669 if (last_smpte_valid && when == last_smpte_when) {
674 sample_to_smpte( when, smpte, true /* use_offset */, true /* use_subframes */ );
676 last_smpte_when = when;
678 last_smpte_valid = true;
682 Session::smpte_duration (jack_nframes_t when, SMPTE_Time& smpte) const
684 sample_to_smpte( when, smpte, false /* use_offset */, true /* use_subframes */ );
688 Session::smpte_duration_string (char* buf, jack_nframes_t when) const
692 smpte_duration (when, smpte);
693 snprintf (buf, sizeof (buf), "%02ld:%02ld:%02ld:%02ld", smpte.hours, smpte.minutes, smpte.seconds, smpte.frames);
697 Session::smpte_time (SMPTE_Time &t)
700 smpte_time (_transport_frame, t);
704 Session::jack_sync_callback (jack_transport_state_t state,
705 jack_position_t* pos)
707 bool slave = synced_to_jack();
710 case JackTransportStopped:
711 if (slave && _transport_frame != pos->frame && post_transport_work == 0) {
712 request_locate (pos->frame, false);
713 // cerr << "SYNC: stopped, locate to " << pos->frame << " from " << _transport_frame << endl;
719 case JackTransportStarting:
720 // cerr << "SYNC: starting @ " << pos->frame << " a@ " << _transport_frame << " our work = " << post_transport_work << " pos matches ? " << (_transport_frame == pos->frame) << endl;
722 return _transport_frame == pos->frame && post_transport_work == 0;
728 case JackTransportRolling:
729 // cerr << "SYNC: rolling slave = " << slave << endl;
736 error << string_compose (_("Unknown JACK transport state %1 in sync callback"), state)
744 Session::jack_timebase_callback (jack_transport_state_t state,
745 jack_nframes_t nframes,
746 jack_position_t* pos,
753 pos->frame = _transport_frame;
754 pos->valid = JackPositionTimecode;
760 TempoMap::Metric metric (_tempo_map->metric_at (_transport_frame));
761 _tempo_map->bbt_time_with_metric (_transport_frame, bbt, metric);
764 pos->beat = bbt.beats;
765 pos->tick = bbt.ticks;
767 // XXX still need to set bar_start_tick
769 pos->beats_per_bar = metric.meter().beats_per_bar();
770 pos->beat_type = metric.meter().note_divisor();
771 pos->ticks_per_beat = Meter::ticks_per_beat;
772 pos->beats_per_minute = metric.tempo().beats_per_minute();
774 pos->valid = jack_position_bits_t (pos->valid | JackPositionBBT);
780 t.smpte_offset = _smpte_offset;
781 t.smpte_frame_rate = smpte_frames_per_second;
783 if (_transport_speed) {
787 Location* location = _locations.auto_loop_location();
791 t.transport_state = JackTransportLooping;
792 t.loop_start = location->start();
793 t.loop_end = location->end();
794 t.valid = jack_transport_bits_t (t.valid | JackTransportLoop);
800 t.transport_state = JackTransportRolling;
808 t.transport_state = JackTransportRolling;
818 Session::convert_to_frames_at (jack_nframes_t position, AnyTime& any)
824 return _tempo_map->frame_time ( any.bbt);
828 /* XXX need to handle negative values */
829 secs = any.smpte.hours * 60 * 60;
830 secs += any.smpte.minutes * 60;
831 secs += any.smpte.seconds;
832 secs += any.smpte.frames / smpte_frames_per_second;
833 if (_smpte_offset_negative)
835 return (jack_nframes_t) floor (secs * frame_rate()) - _smpte_offset;
839 return (jack_nframes_t) floor (secs * frame_rate()) + _smpte_offset;
843 case AnyTime::Seconds:
844 return (jack_nframes_t) floor (any.seconds * frame_rate());
847 case AnyTime::Frames: