libs/ardour/session_time.cc

   1
   2 /*
   3   Copyright (C) 1999-2002 Paul Davis
   4
   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.
   9
  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.
  14
  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.
  18
  19   $Id$
  20 */
  21
  22 #include <iostream>
  23 #include <cmath>
  24 #include <unistd.h>
  25
  26 #include <ardour/timestamps.h>
  27
  28 #include <pbd/error.h>
  29 #include <pbd/stacktrace.h>
  30
  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>
  36
  37 #include "i18n.h"
  38
  39 using namespace ARDOUR;
  40 using namespace PBD;
  41
  42 /* BBT TIME*/
  43
  44 void
  45 Session::bbt_time (nframes_t when, BBT_Time& bbt)
  46 {
  47         _tempo_map->bbt_time (when, bbt);
  48 }
  49
  50 /* SMPTE TIME */
  51
  52 void
  53 Session::sync_time_vars ()
  54 {
  55         _current_frame_rate = (nframes_t) round (_base_frame_rate * (1.0 + (Config->get_video_pullup()/100.0)));
  56         _frames_per_hour = _current_frame_rate * 3600;
  57         _frames_per_smpte_frame = (double) _current_frame_rate / (double) Config->get_smpte_frames_per_second();
  58         _smpte_frames_per_hour = (unsigned long) (Config->get_smpte_frames_per_second() * 3600.0);
  59 }
  60
  61 int
  62 Session::set_smpte_type (float fps, bool drop_frames)
  63 {
  64         Config->set_smpte_frames_per_second (fps);
  65         Config->set_smpte_drop_frames (drop_frames);
  66
  67         last_smpte_valid = false;
  68         // smpte type bits are the middle two in the upper nibble
  69         switch ((int) ceil (fps)) {
  70         case 24:
  71                 mtc_smpte_bits = 0;
  72                 break;
  73
  74         case 25:
  75                 mtc_smpte_bits = 0x20;
  76                 break;
  77
  78         case 30:
  79         default:
  80                 if (drop_frames) {
  81                         mtc_smpte_bits = 0x40;
  82                 } else {
  83                         mtc_smpte_bits =  0x60;
  84                 }
  85                 break;
  86         };
  87
  88         return 0;
  89 }
  90
  91 void
  92 Session::set_smpte_offset (nframes_t off)
  93 {
  94         _smpte_offset = off;
  95         last_smpte_valid = false;
  96
  97         SMPTEOffsetChanged (); /* EMIT SIGNAL */
  98 }
  99
 100 void
 101 Session::set_smpte_offset_negative (bool neg)
 102 {
 103         _smpte_offset_negative = neg;
 104         last_smpte_valid = false;
 105
 106         SMPTEOffsetChanged (); /* EMIT SIGNAL */
 107 }
 108
 109 void
 110 Session::smpte_to_sample( SMPTE::Time& smpte, nframes_t& sample, bool use_offset, bool use_subframes ) const
 111 {
 112         if (Config->get_smpte_drop_frames()) {
 113                 // The drop frame format was created to better approximate the 30000/1001 = 29.97002997002997....
 114                 // framerate of NTSC color TV. The used frame rate of drop frame is 29.97, which drifts by about
 115                 // 0.108 frame per hour, or about 1.3 frames per 12 hours. This is not perfect, but a lot better
 116                 // than using 30 non drop, which will drift with about 1.8 frame per minute.
 117                 // Using 29.97, drop frame real time can be accurate only every 10th minute (10 minutes of 29.97 fps
 118                 // is exactly 17982 frames). One minute is 1798.2 frames, but we count 30 frames per second
 119                 // (30 * 60 = 1800). This means that at the first minute boundary (at the end of 0:0:59:29) we
 120                 // are 1.8 frames too late relative to real time. By dropping 2 frames (jumping to 0:1:0:2) we are
 121                 // approx. 0.2 frames too early. This adds up with 0.2 too early for each minute until we are 1.8
 122                 // frames too early at 0:9:0:2 (9 * 0.2 = 1.8). The 10th minute brings us 1.8 frames later again
 123                 // (at end of 0:9:59:29), which sums up to 0 (we are back to zero at 0:10:0:0 :-).
 124                 //
 125                 // In table form:
 126                 //
 127                 // SMPTE value    frames offset   subframes offset   seconds (rounded)  44100 sample (rounded)
 128                 //  0:00:00:00        0.0             0                     0.000                0 (accurate)
 129                 //  0:00:59:29        1.8           144                    60.027          2647177
 130                 //  0:01:00:02       -0.2           -16                    60.060          2648648
 131                 //  0:01:59:29        1.6           128                   120.020          5292883
 132                 //  0:02:00:02       -0.4           -32                   120.053          5294354
 133                 //  0:02:59:29        1.4           112                   180.013          7938588
 134                 //  0:03:00:02       -0.6           -48                   180.047          7940060
 135                 //  0:03:59:29        1.2            96                   240.007         10584294
 136                 //  0:04:00:02       -0.8           -64                   240.040         10585766
 137                 //  0:04:59:29        1.0            80                   300.000         13230000
 138                 //  0:05:00:02       -1.0           -80                   300.033         13231471
 139                 //  0:05:59:29        0.8            64                   359.993         15875706
 140                 //  0:06:00:02       -1.2           -96                   360.027         15877177
 141                 //  0:06:59:29        0.6            48                   419.987         18521411
 142                 //  0:07:00:02       -1.4          -112                   420.020         18522883
 143                 //  0:07:59:29        0.4            32                   478.980         21167117
 144                 //  0:08:00:02       -1.6          -128                   480.013         21168589
 145                 //  0:08:59:29        0.2            16                   539.973         23812823
 146                 //  0:09:00:02       -1.8          -144                   540.007         23814294
 147                 //  0:09:59:29        0.0+            0+                  599.967         26458529
 148                 //  0:10:00:00        0.0             0                   600.000         26460000 (accurate)
 149                 //
 150                 //  Per Sigmond <per@sigmond.no>
 151
 152                 // Samples inside time dividable by 10 minutes (real time accurate)
 153                 nframes_t base_samples = ((smpte.hours * 60 * 60) + ((smpte.minutes / 10) * 10 * 60)) * frame_rate();
 154                 // Samples inside time exceeding the nearest 10 minutes (always offset, see above)
 155                 long exceeding_df_minutes = smpte.minutes % 10;
 156                 long exceeding_df_seconds = (exceeding_df_minutes * 60) + smpte.seconds;
 157                 long exceeding_df_frames = (30 * exceeding_df_seconds) + smpte.frames - (2 * exceeding_df_minutes);
 158                 nframes_t exceeding_samples = (nframes_t) rint(exceeding_df_frames * _frames_per_smpte_frame);
 159                 sample = base_samples + exceeding_samples;
 160         } else {
 161                 // Non drop is easy:
 162                 sample = (((smpte.hours * 60 * 60) + (smpte.minutes * 60) + smpte.seconds) * frame_rate()) + (nframes_t)rint(smpte.frames * _frames_per_smpte_frame);
 163         }
 164
 165         if (use_subframes) {
 166                 sample += (long) (((double)smpte.subframes * _frames_per_smpte_frame) / 80.0);
 167         }
 168
 169         if (use_offset) {
 170                 if (smpte_offset_negative()) {
 171                         if (sample >= smpte_offset()) {
 172                                 sample -= smpte_offset();
 173                         } else {
 174                                 /* Prevent song-time from becoming negative */
 175                                 sample = 0;
 176                         }
 177                 } else {
 178                         if (smpte.negative) {
 179                                 if (sample <= smpte_offset()) {
 180                                         sample = smpte_offset() - sample;
 181                                 } else {
 182                                         sample = 0;
 183                                 }
 184                         } else {
 185                                 sample += smpte_offset();
 186                         }
 187                 }
 188         }
 189 }
 190
 191
 192 void
 193 Session::sample_to_smpte( nframes_t sample, SMPTE::Time& smpte, bool use_offset, bool use_subframes ) const
 194 {
 195         nframes_t offset_sample;
 196
 197         if (!use_offset) {
 198                 offset_sample = sample;
 199                 smpte.negative = false;
 200         } else {
 201                 if (_smpte_offset_negative) {
 202                         offset_sample =  sample + _smpte_offset;
 203                         smpte.negative = false;
 204                 } else {
 205                         if (sample < _smpte_offset) {
 206                                 offset_sample = (_smpte_offset - sample);
 207                                 smpte.negative = true;
 208                         } else {
 209                                 offset_sample =  sample - _smpte_offset;
 210                                 smpte.negative = false;
 211                         }
 212                 }
 213         }
 214
 215         double smpte_frames_left_exact;
 216         double smpte_frames_fraction;
 217         unsigned long smpte_frames_left;
 218
 219         // Extract whole hours. Do this to prevent rounding errors with
 220         // high sample numbers in the calculations that follow.
 221         smpte.hours = offset_sample / _frames_per_hour;
 222         offset_sample = offset_sample % _frames_per_hour;
 223
 224         // Calculate exact number of (exceeding) smpte frames and fractional frames
 225         smpte_frames_left_exact = (double) offset_sample / _frames_per_smpte_frame;
 226         smpte_frames_fraction = smpte_frames_left_exact - floor( smpte_frames_left_exact );
 227         smpte.subframes = (long) rint(smpte_frames_fraction * 80.0);
 228
 229         // XXX Not sure if this is necessary anymore...
 230         if (smpte.subframes == 80) {
 231                 // This can happen with 24 fps (and 29.97 fps ?)
 232                 smpte_frames_left_exact = ceil( smpte_frames_left_exact );
 233                 smpte.subframes = 0;
 234         }
 235
 236         // Extract hour-exceeding frames for minute, second and frame calculations
 237         smpte_frames_left = ((long) floor( smpte_frames_left_exact ));
 238
 239         if (Config->get_smpte_drop_frames()) {
 240                 // See long explanation in smpte_to_sample()...
 241
 242                 // Number of 10 minute chunks
 243                 smpte.minutes = (smpte_frames_left / 17982) * 10; // exactly 17982 frames in 10 minutes
 244                 // frames exceeding the nearest 10 minute barrier
 245                 long exceeding_df_frames = smpte_frames_left % 17982;
 246
 247                 // Find minutes exceeding the nearest 10 minute barrier
 248                 if (exceeding_df_frames >= 1800) { // nothing to do if we are inside the first minute (0-1799)
 249                         exceeding_df_frames -= 1800; // take away first minute (different number of frames than the others)
 250                         long extra_minutes_minus_1 = exceeding_df_frames / 1798; // how many minutes after the first one
 251                         exceeding_df_frames -= extra_minutes_minus_1 * 1798; // take away the (extra) minutes just found
 252                         smpte.minutes += extra_minutes_minus_1 + 1; // update with exceeding minutes
 253                 }
 254
 255                 // Adjust frame numbering for dropped frames (frame 0 and 1 skipped at start of every minute except every 10th)
 256                 if (smpte.minutes % 10) {
 257                         // Every minute except every 10th
 258                         if (exceeding_df_frames < 28) {
 259                                 // First second, frames 0 and 1 are skipped
 260                                 smpte.seconds = 0;
 261                                 smpte.frames = exceeding_df_frames + 2;
 262                         } else {
 263                                 // All other seconds, all 30 frames are counted
 264                                 exceeding_df_frames -= 28;
 265                                 smpte.seconds = (exceeding_df_frames / 30) + 1;
 266                                 smpte.frames = exceeding_df_frames % 30;
 267                         }
 268                 } else {
 269                         // Every 10th minute, all 30 frames counted in all seconds
 270                         smpte.seconds = exceeding_df_frames / 30;
 271                         smpte.frames = exceeding_df_frames % 30;
 272                 }
 273         } else {
 274                 // Non drop is easy
 275                 smpte.minutes = smpte_frames_left / ((long) Config->get_smpte_frames_per_second () * 60);
 276                 smpte_frames_left = smpte_frames_left % ((long) Config->get_smpte_frames_per_second () * 60);
 277                 smpte.seconds = smpte_frames_left / (long) Config->get_smpte_frames_per_second ();
 278                 smpte.frames = smpte_frames_left % (long) Config->get_smpte_frames_per_second ();
 279         }
 280
 281         if (!use_subframes) {
 282                 smpte.subframes = 0;
 283         }
 284 }
 285
 286 void
 287 Session::smpte_time (nframes_t when, SMPTE::Time& smpte)
 288 {
 289         if (last_smpte_valid && when == last_smpte_when) {
 290                 smpte = last_smpte;
 291                 return;
 292         }
 293
 294         sample_to_smpte( when, smpte, true /* use_offset */, false /* use_subframes */ );
 295
 296         last_smpte_when = when;
 297         last_smpte = smpte;
 298         last_smpte_valid = true;
 299 }
 300
 301 void
 302 Session::smpte_time_subframes (nframes_t when, SMPTE::Time& smpte)
 303 {
 304         if (last_smpte_valid && when == last_smpte_when) {
 305                 smpte = last_smpte;
 306                 return;
 307         }
 308
 309         sample_to_smpte( when, smpte, true /* use_offset */, true /* use_subframes */ );
 310
 311         last_smpte_when = when;
 312         last_smpte = smpte;
 313         last_smpte_valid = true;
 314 }
 315
 316 void
 317 Session::smpte_duration (nframes_t when, SMPTE::Time& smpte) const
 318 {
 319         sample_to_smpte( when, smpte, false /* use_offset */, true /* use_subframes */ );
 320 }
 321
 322 void
 323 Session::smpte_duration_string (char* buf, nframes_t when) const
 324 {
 325         SMPTE::Time smpte;
 326
 327         smpte_duration (when, smpte);
 328         snprintf (buf, sizeof (buf), "%02" PRIu32 ":%02" PRIu32 ":%02" PRIu32 ":%02" PRIu32, smpte.hours, smpte.minutes, smpte.seconds, smpte.frames);
 329 }
 330
 331 void
 332 Session::smpte_time (SMPTE::Time &t)
 333
 334 {
 335         smpte_time (_transport_frame, t);
 336 }
 337
 338 int
 339 Session::jack_sync_callback (jack_transport_state_t state,
 340                              jack_position_t* pos)
 341 {
 342         bool slave = synced_to_jack();
 343
 344         switch (state) {
 345         case JackTransportStopped:
 346                 if (slave && _transport_frame != pos->frame && post_transport_work == 0) {
 347                         request_locate (pos->frame, false);
 348                         // cerr << "SYNC: stopped, locate to " << pos->frame << " from " << _transport_frame << endl;
 349                         return false;
 350                 } else {
 351                         return true;
 352                 }
 353
 354         case JackTransportStarting:
 355                 // cerr << "SYNC: starting @ " << pos->frame << " a@ " << _transport_frame << " our work = " <<  post_transport_work << " pos matches ? " << (_transport_frame == pos->frame) << endl;
 356                 if (slave) {
 357                         return _transport_frame == pos->frame && post_transport_work == 0;
 358                 } else {
 359                         return true;
 360                 }
 361                 break;
 362
 363         case JackTransportRolling:
 364                 // cerr << "SYNC: rolling slave = " << slave << endl;
 365                 if (slave) {
 366                         start_transport ();
 367                 }
 368                 break;
 369
 370         default:
 371                 error << string_compose (_("Unknown JACK transport state %1 in sync callback"), state)
 372                       << endmsg;
 373         }
 374
 375         return true;
 376 }
 377
 378 void
 379 Session::jack_timebase_callback (jack_transport_state_t state,
 380                                  nframes_t nframes,
 381                                  jack_position_t* pos,
 382                                  int new_position)
 383 {
 384         BBT_Time bbt;
 385
 386         /* frame info */
 387
 388         pos->frame = _transport_frame;
 389         pos->valid = JackPositionTimecode;
 390
 391         /* BBT info */
 392
 393         if (_tempo_map) {
 394
 395                 TempoMap::Metric metric (_tempo_map->metric_at (_transport_frame));
 396                 _tempo_map->bbt_time_with_metric (_transport_frame, bbt, metric);
 397
 398                 pos->bar = bbt.bars;
 399                 pos->beat = bbt.beats;
 400                 pos->tick = bbt.ticks;
 401
 402                 // XXX still need to set bar_start_tick
 403
 404                 pos->beats_per_bar = metric.meter().beats_per_bar();
 405                 pos->beat_type = metric.meter().note_divisor();
 406                 pos->ticks_per_beat = Meter::ticks_per_beat;
 407                 pos->beats_per_minute = metric.tempo().beats_per_minute();
 408
 409                 pos->valid = jack_position_bits_t (pos->valid | JackPositionBBT);
 410         }
 411
 412 #ifdef HAVE_JACK_VIDEO_SUPPORT
 413         //poke audio video ratio so Ardour can track Video Sync
 414         pos->audio_frames_per_video_frame = frame_rate() / Config->get_smpte_frames_per_second ();
 415         pos->valid = jack_position_bits_t (pos->valid | JackAudioVideoRatio);
 416 #endif
 417
 418 #if 0
 419         /* SMPTE info */
 420
 421         t.smpte_offset = _smpte_offset;
 422         t.smpte_frame_rate = Config->get_smpte_frames_per_second ();
 423
 424         if (_transport_speed) {
 425
 426                 if (play_loop) {
 427
 428                         Location* location = _locations.auto_loop_location();
 429
 430                         if (location) {
 431
 432                                 t.transport_state = JackTransportLooping;
 433                                 t.loop_start = location->start();
 434                                 t.loop_end = location->end();
 435                                 t.valid = jack_transport_bits_t (t.valid | JackTransportLoop);
 436
 437                         } else {
 438
 439                                 t.loop_start = 0;
 440                                 t.loop_end = 0;
 441                                 t.transport_state = JackTransportRolling;
 442
 443                         }
 444
 445                 } else {
 446
 447                         t.loop_start = 0;
 448                         t.loop_end = 0;
 449                         t.transport_state = JackTransportRolling;
 450
 451                 }
 452
 453         }
 454
 455 #endif
 456 }
 457
 458 nframes_t
 459 Session::convert_to_frames_at (nframes_t position, AnyTime& any)
 460 {
 461         double secs;
 462
 463         switch (any.type) {
 464         case AnyTime::BBT:
 465                 return _tempo_map->frame_time ( any.bbt);
 466                 break;
 467
 468         case AnyTime::SMPTE:
 469                 /* XXX need to handle negative values */
 470                 secs = any.smpte.hours * 60 * 60;
 471                 secs += any.smpte.minutes * 60;
 472                 secs += any.smpte.seconds;
 473                 secs += any.smpte.frames / Config->get_smpte_frames_per_second ();
 474                 if (_smpte_offset_negative)
 475                 {
 476                         return (nframes_t) floor (secs * frame_rate()) - _smpte_offset;
 477                 }
 478                 else
 479                 {
 480                         return (nframes_t) floor (secs * frame_rate()) + _smpte_offset;
 481                 }
 482                 break;
 483
 484         case AnyTime::Seconds:
 485                 return (nframes_t) floor (any.seconds * frame_rate());
 486                 break;
 487
 488         case AnyTime::Frames:
 489                 return any.frames;
 490                 break;
 491         }
 492
 493         return any.frames;
 494 }