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>
35 #include <ardour/audiofilesource.h>
39 using namespace ARDOUR;
40 //using namespace sigc;
45 Session::bbt_time (jack_nframes_t when, BBT_Time& bbt)
47 _tempo_map->bbt_time (when, bbt);
53 Session::set_smpte_type (float fps, bool drop_frames)
55 smpte_frames_per_second = fps;
56 smpte_drop_frames = drop_frames;
57 _frames_per_smpte_frame = (double) _current_frame_rate / (double) smpte_frames_per_second;
58 _frames_per_hour = _current_frame_rate * 3600;
59 _smpte_frames_per_hour = (unsigned long) (smpte_frames_per_second * 3600.0);
62 last_smpte_valid = false;
63 // smpte type bits are the middle two in the upper nibble
64 switch ((int) ceil (fps)) {
70 mtc_smpte_bits = 0x20;
76 mtc_smpte_bits = 0x40;
78 mtc_smpte_bits = 0x60;
83 SMPTETypeChanged (); /* EMIT SIGNAL */
91 Session::set_smpte_offset (jack_nframes_t off)
94 last_smpte_valid = false;
96 AudioFileSource::set_header_position_offset (_smpte_offset, _smpte_offset_negative);
98 SMPTEOffsetChanged (); /* EMIT SIGNAL */
102 Session::set_smpte_offset_negative (bool neg)
104 _smpte_offset_negative = neg;
105 last_smpte_valid = false;
107 AudioFileSource::set_header_position_offset (_smpte_offset, _smpte_offset_negative);
109 SMPTEOffsetChanged (); /* EMIT SIGNAL */
112 #define SMPTE_IS_AROUND_ZERO( sm ) (!(sm).frames && !(sm).seconds && !(sm).minutes && !(sm).hours)
113 #define SMPTE_IS_ZERO( sm ) (!(sm).frames && !(sm).seconds && !(sm).minutes && !(sm).hours && !(sm.subframes))
115 // Increment by exactly one frame (keep subframes value)
116 // Return true if seconds wrap
118 Session::smpte_increment( SMPTE_Time& smpte ) const
120 smpte_wrap_t wrap = smpte_wrap_none;
122 if (smpte.negative) {
123 if (SMPTE_IS_AROUND_ZERO(smpte) && smpte.subframes) {
124 // We have a zero transition involving only subframes
125 smpte.subframes = 80 - smpte.subframes;
126 smpte.negative = false;
127 return smpte_wrap_seconds;
130 smpte.negative = false;
131 wrap = smpte_decrement( smpte );
132 if (!SMPTE_IS_ZERO( smpte )) {
133 smpte.negative = true;
138 switch (mtc_smpte_bits >> 5) {
139 case MIDI::MTC_24_FPS:
140 if (smpte.frames == 23) {
142 wrap = smpte_wrap_seconds;
145 case MIDI::MTC_25_FPS:
146 if (smpte.frames == 24) {
148 wrap = smpte_wrap_seconds;
151 case MIDI::MTC_30_FPS_DROP:
152 if (smpte.frames == 29) {
153 if ( ((smpte.minutes + 1) % 10) && (smpte.seconds == 59) ) {
159 wrap = smpte_wrap_seconds;
162 case MIDI::MTC_30_FPS:
163 if (smpte.frames == 29) {
165 wrap = smpte_wrap_seconds;
170 if (wrap == smpte_wrap_seconds) {
171 if (smpte.seconds == 59) {
173 wrap = smpte_wrap_minutes;
174 if (smpte.minutes == 59) {
176 wrap = smpte_wrap_hours;
191 // Decrement by exactly one frame (keep subframes value)
193 Session::smpte_decrement( SMPTE_Time& smpte ) const
195 smpte_wrap_t wrap = smpte_wrap_none;
198 if (smpte.negative || SMPTE_IS_ZERO(smpte)) {
199 smpte.negative = false;
200 wrap = smpte_increment( smpte );
201 smpte.negative = true;
203 } else if (SMPTE_IS_AROUND_ZERO(smpte) && smpte.subframes) {
204 // We have a zero transition involving only subframes
205 smpte.subframes = 80 - smpte.subframes;
206 smpte.negative = true;
207 return smpte_wrap_seconds;
210 switch (mtc_smpte_bits >> 5) {
211 case MIDI::MTC_24_FPS:
212 if (smpte.frames == 0) {
214 wrap = smpte_wrap_seconds;
217 case MIDI::MTC_25_FPS:
218 if (smpte.frames == 0) {
220 wrap = smpte_wrap_seconds;
223 case MIDI::MTC_30_FPS_DROP:
224 if ((smpte.minutes % 10) && (smpte.seconds == 0)) {
225 if (smpte.frames <= 2) {
227 wrap = smpte_wrap_seconds;
229 } else if (smpte.frames == 0) {
231 wrap = smpte_wrap_seconds;
234 case MIDI::MTC_30_FPS:
235 if (smpte.frames == 0) {
237 wrap = smpte_wrap_seconds;
242 if (wrap == smpte_wrap_seconds) {
243 if (smpte.seconds == 0) {
245 wrap = smpte_wrap_minutes;
246 if (smpte.minutes == 0) {
248 wrap = smpte_wrap_hours;
261 if (SMPTE_IS_ZERO( smpte )) {
262 smpte.negative = false;
268 // Go to lowest absolute subframe value in this frame (set to 0 :-)
270 Session::smpte_frames_floor( SMPTE_Time& smpte ) const
273 if (SMPTE_IS_ZERO(smpte)) {
274 smpte.negative = false;
278 // Increment by one subframe
280 Session::smpte_increment_subframes( SMPTE_Time& smpte ) const
282 smpte_wrap_t wrap = smpte_wrap_none;
284 if (smpte.negative) {
285 smpte.negative = false;
286 wrap = smpte_decrement_subframes( smpte );
287 if (!SMPTE_IS_ZERO(smpte)) {
288 smpte.negative = true;
294 if (smpte.subframes >= 80) {
296 smpte_increment( smpte );
297 return smpte_wrap_frames;
299 return smpte_wrap_none;
303 // Decrement by one subframe
305 Session::smpte_decrement_subframes( SMPTE_Time& smpte ) const
307 smpte_wrap_t wrap = smpte_wrap_none;
309 if (smpte.negative) {
310 smpte.negative = false;
311 wrap = smpte_increment_subframes( smpte );
312 smpte.negative = true;
316 if (smpte.subframes <= 0) {
318 if (SMPTE_IS_ZERO(smpte)) {
319 smpte.negative = true;
321 return smpte_wrap_frames;
323 smpte_decrement( smpte );
324 smpte.subframes = 79;
325 return smpte_wrap_frames;
329 if (SMPTE_IS_ZERO(smpte)) {
330 smpte.negative = false;
332 return smpte_wrap_none;
337 // Go to next whole second (frames == 0 or frames == 2)
339 Session::smpte_increment_seconds( SMPTE_Time& smpte ) const
341 smpte_wrap_t wrap = smpte_wrap_none;
344 smpte_frames_floor( smpte );
346 if (smpte.negative) {
347 // Wrap second if on second boundary
348 wrap = smpte_increment(smpte);
349 // Go to lowest absolute frame value
350 smpte_seconds_floor( smpte );
351 if (SMPTE_IS_ZERO(smpte)) {
352 smpte.negative = false;
355 // Go to highest possible frame in this second
356 switch (mtc_smpte_bits >> 5) {
357 case MIDI::MTC_24_FPS:
360 case MIDI::MTC_25_FPS:
363 case MIDI::MTC_30_FPS_DROP:
364 case MIDI::MTC_30_FPS:
369 // Increment by one frame
370 wrap = smpte_increment( smpte );
376 // Go to lowest (absolute) frame value in this second
377 // Doesn't care about positive/negative
379 Session::smpte_seconds_floor( SMPTE_Time& smpte ) const
382 smpte_frames_floor( smpte );
384 // Go to lowest possible frame in this second
385 switch (mtc_smpte_bits >> 5) {
386 case MIDI::MTC_24_FPS:
387 case MIDI::MTC_25_FPS:
388 case MIDI::MTC_30_FPS:
391 case MIDI::MTC_30_FPS_DROP:
392 if ((smpte.minutes % 10) && (smpte.seconds == 0)) {
400 if (SMPTE_IS_ZERO(smpte)) {
401 smpte.negative = false;
406 // Go to next whole minute (seconds == 0, frames == 0 or frames == 2)
408 Session::smpte_increment_minutes( SMPTE_Time& smpte ) const
410 smpte_wrap_t wrap = smpte_wrap_none;
413 smpte_frames_floor( smpte );
415 if (smpte.negative) {
416 // Wrap if on minute boundary
417 wrap = smpte_increment_seconds( smpte );
418 // Go to lowest possible value in this minute
419 smpte_minutes_floor( smpte );
421 // Go to highest possible second
423 // Wrap minute by incrementing second
424 wrap = smpte_increment_seconds( smpte );
430 // Go to lowest absolute value in this minute
432 Session::smpte_minutes_floor( SMPTE_Time& smpte ) const
434 // Go to lowest possible second
436 // Go to lowest possible frame
437 smpte_seconds_floor( smpte );
439 if (SMPTE_IS_ZERO(smpte)) {
440 smpte.negative = false;
444 // Go to next whole hour (minute = 0, second = 0, frame = 0)
446 Session::smpte_increment_hours( SMPTE_Time& smpte ) const
448 smpte_wrap_t wrap = smpte_wrap_none;
451 smpte_frames_floor(smpte);
453 if (smpte.negative) {
454 // Wrap if on hour boundary
455 wrap = smpte_increment_minutes( smpte );
456 // Go to lowest possible value in this hour
457 smpte_hours_floor( smpte );
460 wrap = smpte_increment_minutes( smpte );
466 // Go to lowest absolute value in this hour
468 Session::smpte_hours_floor( SMPTE_Time& smpte ) const
475 if (SMPTE_IS_ZERO(smpte)) {
476 smpte.negative = false;
482 Session::smpte_to_sample( SMPTE_Time& smpte, jack_nframes_t& sample, bool use_offset, bool use_subframes ) const
484 if (smpte_drop_frames) {
485 // The drop frame format was created to better approximate the 30000/1001 = 29.97002997002997....
486 // framerate of NTSC color TV. The used frame rate of drop frame is 29.97, which drifts by about
487 // 0.108 frame per hour, or about 1.3 frames per 12 hours. This is not perfect, but a lot better
488 // than using 30 non drop, which will drift with about 1.8 frame per minute.
489 // Using 29.97, drop frame real time can be accurate only every 10th minute (10 minutes of 29.97 fps
490 // is exactly 17982 frames). One minute is 1798.2 frames, but we count 30 frames per second
491 // (30 * 60 = 1800). This means that at the first minute boundary (at the end of 0:0:59:29) we
492 // are 1.8 frames too late relative to real time. By dropping 2 frames (jumping to 0:1:0:2) we are
493 // approx. 0.2 frames too early. This adds up with 0.2 too early for each minute until we are 1.8
494 // frames too early at 0:9:0:2 (9 * 0.2 = 1.8). The 10th minute brings us 1.8 frames later again
495 // (at end of 0:9:59:29), which sums up to 0 (we are back to zero at 0:10:0:0 :-).
499 // SMPTE value frames offset subframes offset seconds (rounded) 44100 sample (rounded)
500 // 0:00:00:00 0.0 0 0.000 0 (accurate)
501 // 0:00:59:29 1.8 144 60.027 2647177
502 // 0:01:00:02 -0.2 -16 60.060 2648648
503 // 0:01:59:29 1.6 128 120.020 5292883
504 // 0:02:00:02 -0.4 -32 120.053 5294354
505 // 0:02:59:29 1.4 112 180.013 7938588
506 // 0:03:00:02 -0.6 -48 180.047 7940060
507 // 0:03:59:29 1.2 96 240.007 10584294
508 // 0:04:00:02 -0.8 -64 240.040 10585766
509 // 0:04:59:29 1.0 80 300.000 13230000
510 // 0:05:00:02 -1.0 -80 300.033 13231471
511 // 0:05:59:29 0.8 64 359.993 15875706
512 // 0:06:00:02 -1.2 -96 360.027 15877177
513 // 0:06:59:29 0.6 48 419.987 18521411
514 // 0:07:00:02 -1.4 -112 420.020 18522883
515 // 0:07:59:29 0.4 32 478.980 21167117
516 // 0:08:00:02 -1.6 -128 480.013 21168589
517 // 0:08:59:29 0.2 16 539.973 23812823
518 // 0:09:00:02 -1.8 -144 540.007 23814294
519 // 0:09:59:29 0.0+ 0+ 599.967 26458529
520 // 0:10:00:00 0.0 0 600.000 26460000 (accurate)
522 // Per Sigmond <per@sigmond.no>
524 // Samples inside time dividable by 10 minutes (real time accurate)
525 jack_nframes_t base_samples = ((smpte.hours * 60 * 60) + ((smpte.minutes / 10) * 10 * 60)) * frame_rate();
526 // Samples inside time exceeding the nearest 10 minutes (always offset, see above)
527 long exceeding_df_minutes = smpte.minutes % 10;
528 long exceeding_df_seconds = (exceeding_df_minutes * 60) + smpte.seconds;
529 long exceeding_df_frames = (30 * exceeding_df_seconds) + smpte.frames - (2 * exceeding_df_minutes);
530 jack_nframes_t exceeding_samples = (jack_nframes_t) rint(exceeding_df_frames * _frames_per_smpte_frame);
531 sample = base_samples + exceeding_samples;
534 sample = (((smpte.hours * 60 * 60) + (smpte.minutes * 60) + smpte.seconds) * frame_rate()) + (jack_nframes_t)rint(smpte.frames * _frames_per_smpte_frame);
538 sample += (long) (((double)smpte.subframes * _frames_per_smpte_frame) / 80.0);
542 if (smpte_offset_negative()) {
543 if (sample >= smpte_offset()) {
544 sample -= smpte_offset();
546 /* Prevent song-time from becoming negative */
550 if (smpte.negative) {
551 if (sample <= smpte_offset()) {
552 sample = smpte_offset() - sample;
557 sample += smpte_offset();
565 Session::sample_to_smpte( jack_nframes_t sample, SMPTE_Time& smpte, bool use_offset, bool use_subframes ) const
567 jack_nframes_t offset_sample;
570 offset_sample = sample;
571 smpte.negative = false;
573 if (_smpte_offset_negative) {
574 offset_sample = sample + _smpte_offset;
575 smpte.negative = false;
577 if (sample < _smpte_offset) {
578 offset_sample = (_smpte_offset - sample);
579 smpte.negative = true;
581 offset_sample = sample - _smpte_offset;
582 smpte.negative = false;
587 double smpte_frames_left_exact;
588 double smpte_frames_fraction;
589 unsigned long smpte_frames_left;
591 // Extract whole hours. Do this to prevent rounding errors with
592 // high sample numbers in the calculations that follow.
593 smpte.hours = offset_sample / _frames_per_hour;
594 offset_sample = offset_sample % _frames_per_hour;
596 // Calculate exact number of (exceeding) smpte frames and fractional frames
597 smpte_frames_left_exact = (double) offset_sample / _frames_per_smpte_frame;
598 smpte_frames_fraction = smpte_frames_left_exact - floor( smpte_frames_left_exact );
599 smpte.subframes = (long) rint(smpte_frames_fraction * 80.0);
601 // XXX Not sure if this is necessary anymore...
602 if (smpte.subframes == 80) {
603 // This can happen with 24 fps (and 29.97 fps ?)
604 smpte_frames_left_exact = ceil( smpte_frames_left_exact );
608 // Extract hour-exceeding frames for minute, second and frame calculations
609 smpte_frames_left = ((long) floor( smpte_frames_left_exact ));
611 if (smpte_drop_frames) {
612 // See long explanation in smpte_to_sample()...
614 // Number of 10 minute chunks
615 smpte.minutes = (smpte_frames_left / 17982) * 10; // exactly 17982 frames in 10 minutes
616 // frames exceeding the nearest 10 minute barrier
617 long exceeding_df_frames = smpte_frames_left % 17982;
619 // Find minutes exceeding the nearest 10 minute barrier
620 if (exceeding_df_frames >= 1800) { // nothing to do if we are inside the first minute (0-1799)
621 exceeding_df_frames -= 1800; // take away first minute (different number of frames than the others)
622 long extra_minutes_minus_1 = exceeding_df_frames / 1798; // how many minutes after the first one
623 exceeding_df_frames -= extra_minutes_minus_1 * 1798; // take away the (extra) minutes just found
624 smpte.minutes += extra_minutes_minus_1 + 1; // update with exceeding minutes
627 // Adjust frame numbering for dropped frames (frame 0 and 1 skipped at start of every minute except every 10th)
628 if (smpte.minutes % 10) {
629 // Every minute except every 10th
630 if (exceeding_df_frames < 28) {
631 // First second, frames 0 and 1 are skipped
633 smpte.frames = exceeding_df_frames + 2;
635 // All other seconds, all 30 frames are counted
636 exceeding_df_frames -= 28;
637 smpte.seconds = (exceeding_df_frames / 30) + 1;
638 smpte.frames = exceeding_df_frames % 30;
641 // Every 10th minute, all 30 frames counted in all seconds
642 smpte.seconds = exceeding_df_frames / 30;
643 smpte.frames = exceeding_df_frames % 30;
647 smpte.minutes = smpte_frames_left / ((long) smpte_frames_per_second * 60);
648 smpte_frames_left = smpte_frames_left % ((long) smpte_frames_per_second * 60);
649 smpte.seconds = smpte_frames_left / (long) smpte_frames_per_second;
650 smpte.frames = smpte_frames_left % (long) smpte_frames_per_second;
653 if (!use_subframes) {
659 Session::smpte_time (jack_nframes_t when, SMPTE_Time& smpte)
661 if (last_smpte_valid && when == last_smpte_when) {
666 sample_to_smpte( when, smpte, true /* use_offset */, false /* use_subframes */ );
668 last_smpte_when = when;
670 last_smpte_valid = true;
674 Session::smpte_time_subframes (jack_nframes_t when, SMPTE_Time& smpte)
676 if (last_smpte_valid && when == last_smpte_when) {
681 sample_to_smpte( when, smpte, true /* use_offset */, true /* use_subframes */ );
683 last_smpte_when = when;
685 last_smpte_valid = true;
689 Session::smpte_duration (jack_nframes_t when, SMPTE_Time& smpte) const
691 sample_to_smpte( when, smpte, false /* use_offset */, true /* use_subframes */ );
695 Session::smpte_duration_string (char* buf, jack_nframes_t when) const
699 smpte_duration (when, smpte);
700 snprintf (buf, sizeof (buf), "%02" PRIu32 ":%02" PRIu32 ":%02" PRIu32 ":%02" PRIu32, smpte.hours, smpte.minutes, smpte.seconds, smpte.frames);
704 Session::smpte_time (SMPTE_Time &t)
707 smpte_time (_transport_frame, t);
711 Session::jack_sync_callback (jack_transport_state_t state,
712 jack_position_t* pos)
714 bool slave = synced_to_jack();
717 case JackTransportStopped:
718 if (slave && _transport_frame != pos->frame && post_transport_work == 0) {
719 request_locate (pos->frame, false);
720 // cerr << "SYNC: stopped, locate to " << pos->frame << " from " << _transport_frame << endl;
726 case JackTransportStarting:
727 // cerr << "SYNC: starting @ " << pos->frame << " a@ " << _transport_frame << " our work = " << post_transport_work << " pos matches ? " << (_transport_frame == pos->frame) << endl;
729 return _transport_frame == pos->frame && post_transport_work == 0;
735 case JackTransportRolling:
736 // cerr << "SYNC: rolling slave = " << slave << endl;
743 error << string_compose (_("Unknown JACK transport state %1 in sync callback"), state)
751 Session::jack_timebase_callback (jack_transport_state_t state,
752 jack_nframes_t nframes,
753 jack_position_t* pos,
760 pos->frame = _transport_frame;
761 pos->valid = JackPositionTimecode;
767 TempoMap::Metric metric (_tempo_map->metric_at (_transport_frame));
768 _tempo_map->bbt_time_with_metric (_transport_frame, bbt, metric);
771 pos->beat = bbt.beats;
772 pos->tick = bbt.ticks;
774 // XXX still need to set bar_start_tick
776 pos->beats_per_bar = metric.meter().beats_per_bar();
777 pos->beat_type = metric.meter().note_divisor();
778 pos->ticks_per_beat = Meter::ticks_per_beat;
779 pos->beats_per_minute = metric.tempo().beats_per_minute();
781 pos->valid = jack_position_bits_t (pos->valid | JackPositionBBT);
787 t.smpte_offset = _smpte_offset;
788 t.smpte_frame_rate = smpte_frames_per_second;
790 if (_transport_speed) {
794 Location* location = _locations.auto_loop_location();
798 t.transport_state = JackTransportLooping;
799 t.loop_start = location->start();
800 t.loop_end = location->end();
801 t.valid = jack_transport_bits_t (t.valid | JackTransportLoop);
807 t.transport_state = JackTransportRolling;
815 t.transport_state = JackTransportRolling;
825 Session::convert_to_frames_at (jack_nframes_t position, AnyTime& any)
831 return _tempo_map->frame_time ( any.bbt);
835 /* XXX need to handle negative values */
836 secs = any.smpte.hours * 60 * 60;
837 secs += any.smpte.minutes * 60;
838 secs += any.smpte.seconds;
839 secs += any.smpte.frames / smpte_frames_per_second;
840 if (_smpte_offset_negative)
842 return (jack_nframes_t) floor (secs * frame_rate()) - _smpte_offset;
846 return (jack_nframes_t) floor (secs * frame_rate()) + _smpte_offset;
850 case AnyTime::Seconds:
851 return (jack_nframes_t) floor (any.seconds * frame_rate());
854 case AnyTime::Frames: