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