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.
25 #include "ardour/timestamps.h"
27 #include "pbd/error.h"
28 #include "pbd/enumwriter.h"
29 #include "pbd/stacktrace.h"
31 #include "ardour/ardour.h"
32 #include "ardour/configuration.h"
33 #include "ardour/audioengine.h"
34 #include "ardour/session.h"
35 #include "ardour/tempo.h"
39 using namespace ARDOUR;
45 Session::bbt_time (nframes_t when, BBT_Time& bbt)
47 _tempo_map->bbt_time (when, bbt);
52 Session::smpte_frames_per_second() const
54 switch (Config->get_smpte_format()) {
96 cerr << "Editor received unexpected smpte type" << endl;
101 Session::smpte_drop_frames() const
103 switch (Config->get_smpte_format()) {
145 cerr << "Editor received unexpected smpte type" << endl;
150 Session::sync_time_vars ()
152 _current_frame_rate = (nframes_t) round (_base_frame_rate * (1.0 + (Config->get_video_pullup()/100.0)));
153 _frames_per_smpte_frame = (double) _current_frame_rate / (double) smpte_frames_per_second();
154 if (smpte_drop_frames()) {
155 _frames_per_hour = (long)(107892 * _frames_per_smpte_frame);
157 _frames_per_hour = (long)(3600 * rint(smpte_frames_per_second()) * _frames_per_smpte_frame);
159 _smpte_frames_per_hour = (nframes_t)rint(smpte_frames_per_second() * 3600.0);
161 last_smpte_valid = false;
162 // smpte type bits are the middle two in the upper nibble
163 switch ((int) ceil (smpte_frames_per_second())) {
169 mtc_smpte_bits = 0x20;
174 if (smpte_drop_frames()) {
175 mtc_smpte_bits = 0x40;
177 mtc_smpte_bits = 0x60;
184 Session::set_smpte_format (SmpteFormat format)
186 /* this will trigger any other changes needed */
187 Config->set_smpte_format (format);
192 Session::set_smpte_offset (nframes_t off)
195 last_smpte_valid = false;
197 SMPTEOffsetChanged (); /* EMIT SIGNAL */
201 Session::set_smpte_offset_negative (bool neg)
203 _smpte_offset_negative = neg;
204 last_smpte_valid = false;
206 SMPTEOffsetChanged (); /* EMIT SIGNAL */
210 Session::smpte_to_sample( SMPTE::Time& smpte, nframes_t& sample, bool use_offset, bool use_subframes ) const
214 // The drop frame format was created to better approximate the 30000/1001 = 29.97002997002997....
215 // framerate of NTSC color TV. The used frame rate of drop frame is 29.97, which drifts by about
216 // 0.108 frame per hour, or about 1.3 frames per 12 hours. This is not perfect, but a lot better
217 // than using 30 non drop, which will drift with about 1.8 frame per minute.
218 // Using 29.97, drop frame real time can be accurate only every 10th minute (10 minutes of 29.97 fps
219 // is exactly 17982 frames). One minute is 1798.2 frames, but we count 30 frames per second
220 // (30 * 60 = 1800). This means that at the first minute boundary (at the end of 0:0:59:29) we
221 // are 1.8 frames too late relative to real time. By dropping 2 frames (jumping to 0:1:0:2) we are
222 // approx. 0.2 frames too early. This adds up with 0.2 too early for each minute until we are 1.8
223 // frames too early at 0:9:0:2 (9 * 0.2 = 1.8). The 10th minute brings us 1.8 frames later again
224 // (at end of 0:9:59:29), which sums up to 0 (we are back to zero at 0:10:0:0 :-).
228 // SMPTE value frames offset subframes offset seconds (rounded) 44100 sample (rounded)
229 // 0:00:00:00 0.0 0 0.000 0 (accurate)
230 // 0:00:59:29 1.8 144 60.027 2647177
231 // 0:01:00:02 -0.2 -16 60.060 2648648
232 // 0:01:59:29 1.6 128 120.020 5292883
233 // 0:02:00:02 -0.4 -32 120.053 5294354
234 // 0:02:59:29 1.4 112 180.013 7938588
235 // 0:03:00:02 -0.6 -48 180.047 7940060
236 // 0:03:59:29 1.2 96 240.007 10584294
237 // 0:04:00:02 -0.8 -64 240.040 10585766
238 // 0:04:59:29 1.0 80 300.000 13230000
239 // 0:05:00:02 -1.0 -80 300.033 13231471
240 // 0:05:59:29 0.8 64 359.993 15875706
241 // 0:06:00:02 -1.2 -96 360.027 15877177
242 // 0:06:59:29 0.6 48 419.987 18521411
243 // 0:07:00:02 -1.4 -112 420.020 18522883
244 // 0:07:59:29 0.4 32 478.980 21167117
245 // 0:08:00:02 -1.6 -128 480.013 21168589
246 // 0:08:59:29 0.2 16 539.973 23812823
247 // 0:09:00:02 -1.8 -144 540.007 23814294
248 // 0:09:59:29 0.0+ 0+ 599.967 26458529
249 // 0:10:00:00 0.0 0 600.000 26460000 (accurate)
251 // Per Sigmond <per@sigmond.no>
253 // Samples inside time dividable by 10 minutes (real time accurate)
254 nframes_t base_samples = (nframes_t) (((smpte.hours * 107892) + ((smpte.minutes / 10) * 17982)) * _frames_per_smpte_frame);
256 // Samples inside time exceeding the nearest 10 minutes (always offset, see above)
257 long exceeding_df_minutes = smpte.minutes % 10;
258 long exceeding_df_seconds = (exceeding_df_minutes * 60) + smpte.seconds;
259 long exceeding_df_frames = (30 * exceeding_df_seconds) + smpte.frames - (2 * exceeding_df_minutes);
260 nframes_t exceeding_samples = (nframes_t) rint(exceeding_df_frames * _frames_per_smpte_frame);
261 sample = base_samples + exceeding_samples;
264 Non drop is easy.. just note the use of
265 rint(smpte.rate) * _frames_per_smpte_frame
266 (frames per SMPTE second), which is larger than
267 frame_rate() in the non-integer SMPTE rate case.
270 sample = (nframes_t)rint((((smpte.hours * 60 * 60) + (smpte.minutes * 60) + smpte.seconds) * (rint(smpte.rate) * _frames_per_smpte_frame)) + (smpte.frames * _frames_per_smpte_frame));
274 sample += (long) (((double)smpte.subframes * _frames_per_smpte_frame) / Config->get_subframes_per_frame());
278 if (smpte_offset_negative()) {
279 if (sample >= smpte_offset()) {
280 sample -= smpte_offset();
282 /* Prevent song-time from becoming negative */
286 if (smpte.negative) {
287 if (sample <= smpte_offset()) {
288 sample = smpte_offset() - sample;
293 sample += smpte_offset();
302 Session::sample_to_smpte( nframes_t sample, SMPTE::Time& smpte, bool use_offset, bool use_subframes ) const
304 nframes_t offset_sample;
307 offset_sample = sample;
308 smpte.negative = false;
310 if (_smpte_offset_negative) {
311 offset_sample = sample + _smpte_offset;
312 smpte.negative = false;
314 if (sample < _smpte_offset) {
315 offset_sample = (_smpte_offset - sample);
316 smpte.negative = true;
318 offset_sample = sample - _smpte_offset;
319 smpte.negative = false;
324 double smpte_frames_left_exact;
325 double smpte_frames_fraction;
326 unsigned long smpte_frames_left;
328 // Extract whole hours. Do this to prevent rounding errors with
329 // high sample numbers in the calculations that follow.
330 smpte.hours = offset_sample / _frames_per_hour;
331 offset_sample = offset_sample % _frames_per_hour;
333 // Calculate exact number of (exceeding) smpte frames and fractional frames
334 smpte_frames_left_exact = (double) offset_sample / _frames_per_smpte_frame;
335 smpte_frames_fraction = smpte_frames_left_exact - floor( smpte_frames_left_exact );
336 smpte.subframes = (long) rint(smpte_frames_fraction * Config->get_subframes_per_frame());
338 // XXX Not sure if this is necessary anymore...
339 if (smpte.subframes == Config->get_subframes_per_frame()) {
340 // This can happen with 24 fps (and 29.97 fps ?)
341 smpte_frames_left_exact = ceil( smpte_frames_left_exact );
345 // Extract hour-exceeding frames for minute, second and frame calculations
346 smpte_frames_left = ((long) floor( smpte_frames_left_exact ));
348 if (smpte_drop_frames()) {
349 // See long explanation in smpte_to_sample()...
351 // Number of 10 minute chunks
352 smpte.minutes = (smpte_frames_left / 17982) * 10; // exactly 17982 frames in 10 minutes
353 // frames exceeding the nearest 10 minute barrier
354 long exceeding_df_frames = smpte_frames_left % 17982;
356 // Find minutes exceeding the nearest 10 minute barrier
357 if (exceeding_df_frames >= 1800) { // nothing to do if we are inside the first minute (0-1799)
358 exceeding_df_frames -= 1800; // take away first minute (different number of frames than the others)
359 long extra_minutes_minus_1 = exceeding_df_frames / 1798; // how many minutes after the first one
360 exceeding_df_frames -= extra_minutes_minus_1 * 1798; // take away the (extra) minutes just found
361 smpte.minutes += extra_minutes_minus_1 + 1; // update with exceeding minutes
364 // Adjust frame numbering for dropped frames (frame 0 and 1 skipped at start of every minute except every 10th)
365 if (smpte.minutes % 10) {
366 // Every minute except every 10th
367 if (exceeding_df_frames < 28) {
368 // First second, frames 0 and 1 are skipped
370 smpte.frames = exceeding_df_frames + 2;
372 // All other seconds, all 30 frames are counted
373 exceeding_df_frames -= 28;
374 smpte.seconds = (exceeding_df_frames / 30) + 1;
375 smpte.frames = exceeding_df_frames % 30;
378 // Every 10th minute, all 30 frames counted in all seconds
379 smpte.seconds = exceeding_df_frames / 30;
380 smpte.frames = exceeding_df_frames % 30;
384 smpte.minutes = smpte_frames_left / ((long) rint (smpte_frames_per_second ()) * 60);
385 smpte_frames_left = smpte_frames_left % ((long) rint (smpte_frames_per_second ()) * 60);
386 smpte.seconds = smpte_frames_left / (long) rint(smpte_frames_per_second ());
387 smpte.frames = smpte_frames_left % (long) rint(smpte_frames_per_second ());
390 if (!use_subframes) {
393 /* set frame rate and drop frame */
394 smpte.rate = smpte_frames_per_second ();
395 smpte.drop = smpte_drop_frames();
399 Session::smpte_time (nframes_t when, SMPTE::Time& smpte)
401 if (last_smpte_valid && when == last_smpte_when) {
406 sample_to_smpte( when, smpte, true /* use_offset */, false /* use_subframes */ );
408 last_smpte_when = when;
410 last_smpte_valid = true;
414 Session::smpte_time_subframes (nframes_t when, SMPTE::Time& smpte)
416 if (last_smpte_valid && when == last_smpte_when) {
421 sample_to_smpte( when, smpte, true /* use_offset */, true /* use_subframes */ );
423 last_smpte_when = when;
425 last_smpte_valid = true;
429 Session::smpte_duration (nframes_t when, SMPTE::Time& smpte) const
431 sample_to_smpte( when, smpte, false /* use_offset */, true /* use_subframes */ );
435 Session::smpte_duration_string (char* buf, nframes_t when) const
439 smpte_duration (when, smpte);
440 snprintf (buf, sizeof (buf), "%02" PRIu32 ":%02" PRIu32 ":%02" PRIu32 ":%02" PRIu32, smpte.hours, smpte.minutes, smpte.seconds, smpte.frames);
444 Session::smpte_time (SMPTE::Time &t)
447 smpte_time (_transport_frame, t);
451 Session::jack_sync_callback (jack_transport_state_t state,
452 jack_position_t* pos)
454 bool slave = synced_to_jack();
457 case JackTransportStopped:
458 if (slave && _transport_frame != pos->frame && post_transport_work == 0) {
459 request_locate (pos->frame, false);
460 // cerr << "SYNC: stopped, locate to " << pos->frame << " from " << _transport_frame << endl;
466 case JackTransportStarting:
467 // cerr << "SYNC: starting @ " << pos->frame << " a@ " << _transport_frame << " our work = " << post_transport_work << " pos matches ? " << (_transport_frame == pos->frame) << endl;
469 return _transport_frame == pos->frame && post_transport_work == 0;
475 case JackTransportRolling:
476 // cerr << "SYNC: rolling slave = " << slave << endl;
483 error << string_compose (_("Unknown JACK transport state %1 in sync callback"), state)
491 Session::jack_timebase_callback (jack_transport_state_t state,
493 jack_position_t* pos,
500 pos->frame = _transport_frame;
501 pos->valid = JackPositionTimecode;
507 TempoMap::Metric metric (_tempo_map->metric_at (_transport_frame));
508 _tempo_map->bbt_time_with_metric (_transport_frame, bbt, metric);
511 pos->beat = bbt.beats;
512 pos->tick = bbt.ticks;
514 // XXX still need to set bar_start_tick
516 pos->beats_per_bar = metric.meter().beats_per_bar();
517 pos->beat_type = metric.meter().note_divisor();
518 pos->ticks_per_beat = Meter::ticks_per_beat;
519 pos->beats_per_minute = metric.tempo().beats_per_minute();
521 pos->valid = jack_position_bits_t (pos->valid | JackPositionBBT);
524 #ifdef HAVE_JACK_VIDEO_SUPPORT
525 //poke audio video ratio so Ardour can track Video Sync
526 pos->audio_frames_per_video_frame = frame_rate() / smpte_frames_per_second();
527 pos->valid = jack_position_bits_t (pos->valid | JackAudioVideoRatio);
533 t.smpte_offset = _smpte_offset;
534 t.smpte_frame_rate = smpte_frames_per_second();
536 if (_transport_speed) {
540 Location* location = _locations.auto_loop_location();
544 t.transport_state = JackTransportLooping;
545 t.loop_start = location->start();
546 t.loop_end = location->end();
547 t.valid = jack_transport_bits_t (t.valid | JackTransportLoop);
553 t.transport_state = JackTransportRolling;
561 t.transport_state = JackTransportRolling;
571 Session::convert_to_frames_at (nframes_t position, AnyTime const & any)
577 return _tempo_map->frame_time ( any.bbt);
581 /* XXX need to handle negative values */
582 secs = any.smpte.hours * 60 * 60;
583 secs += any.smpte.minutes * 60;
584 secs += any.smpte.seconds;
585 secs += any.smpte.frames / smpte_frames_per_second();
586 if (_smpte_offset_negative)
588 return (nframes_t) floor (secs * frame_rate()) - _smpte_offset;
592 return (nframes_t) floor (secs * frame_rate()) + _smpte_offset;
596 case AnyTime::Seconds:
597 return (nframes_t) floor (any.seconds * frame_rate());
600 case AnyTime::Frames: