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