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