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