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