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