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