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