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