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