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