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