libs/ardour/session_process.cc

   1 /*
   2     Copyright (C) 1999-2002 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <cmath>
  21 #include <cerrno>
  22 #include <algorithm>
  23 #include <unistd.h>
  24
  25 #include "pbd/error.h"
  26 #include "pbd/enumwriter.h"
  27
  28 #include <glibmm/threads.h>
  29
  30 #include "ardour/audioengine.h"
  31 #include "ardour/auditioner.h"
  32 #include "ardour/butler.h"
  33 #include "ardour/cycle_timer.h"
  34 #include "ardour/debug.h"
  35 #include "ardour/graph.h"
  36 #include "ardour/port.h"
  37 #include "ardour/process_thread.h"
  38 #include "ardour/session.h"
  39 #include "ardour/slave.h"
  40 #include "ardour/ticker.h"
  41 #include "ardour/types.h"
  42
  43 #include "midi++/manager.h"
  44 #include "midi++/mmc.h"
  45
  46 #include "i18n.h"
  47
  48 #include <xmmintrin.h>
  49
  50 using namespace ARDOUR;
  51 using namespace PBD;
  52 using namespace std;
  53
  54 /** Called by the audio engine when there is work to be done with JACK.
  55  * @param nframes Number of frames to process.
  56  */
  57
  58 void
  59 Session::process (pframes_t nframes)
  60 {
  61         framepos_t transport_at_start = _transport_frame;
  62
  63         _silent = false;
  64
  65         if (processing_blocked()) {
  66                 _silent = true;
  67                 return;
  68         }
  69
  70         if (non_realtime_work_pending()) {
  71                 if (!_butler->transport_work_requested ()) {
  72                         post_transport ();
  73                 }
  74         }
  75
  76         _engine.main_thread()->get_buffers ();
  77
  78         (this->*process_function) (nframes);
  79
  80         _engine.main_thread()->drop_buffers ();
  81
  82         /* deliver MIDI clock. Note that we need to use the transport frame
  83          * position at the start of process(), not the value at the end of
  84          * it. We may already have ticked() because of a transport state
  85          * change, for example.
  86          */
  87
  88         try {
  89                 if (!_engine.freewheeling() && Config->get_send_midi_clock() && transport_speed() == 1.0f && midi_clock->has_midi_port()) {
  90                         midi_clock->tick (transport_at_start);
  91                 }
  92         } catch (...) {
  93                 /* don't bother with a message */
  94         }
  95
  96         SendFeedback (); /* EMIT SIGNAL */
  97 }
  98
  99 int
 100 Session::fail_roll (pframes_t nframes)
 101 {
 102         return no_roll (nframes);
 103 }
 104
 105 int
 106 Session::no_roll (pframes_t nframes)
 107 {
 108         PT_TIMING_CHECK (4);
 109
 110         framepos_t end_frame = _transport_frame + nframes; // FIXME: varispeed + no_roll ??
 111         int ret = 0;
 112         int declick = get_transport_declick_required();
 113         boost::shared_ptr<RouteList> r = routes.reader ();
 114
 115         if (_click_io) {
 116                 _click_io->silence (nframes);
 117         }
 118
 119         ltc_tx_send_time_code_for_cycle (_transport_frame, end_frame, _target_transport_speed, _transport_speed, nframes);
 120
 121         if (_process_graph) {
 122                 DEBUG_TRACE(DEBUG::ProcessThreads,"calling graph/no-roll\n");
 123                 _process_graph->routes_no_roll( nframes, _transport_frame, end_frame, non_realtime_work_pending(), declick);
 124         } else {
 125                 PT_TIMING_CHECK (10);
 126                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
 127
 128                         if ((*i)->is_hidden()) {
 129                                 continue;
 130                         }
 131
 132                         (*i)->set_pending_declick (declick);
 133
 134                         if ((*i)->no_roll (nframes, _transport_frame, end_frame, non_realtime_work_pending())) {
 135                                 error << string_compose(_("Session: error in no roll for %1"), (*i)->name()) << endmsg;
 136                                 ret = -1;
 137                                 break;
 138                         }
 139                 }
 140                 PT_TIMING_CHECK (11);
 141         }
 142
 143         PT_TIMING_CHECK (5);
 144         return ret;
 145 }
 146
 147 /** @param need_butler to be set to true by this method if it needs the butler,
 148  *  otherwise it must be left alone.
 149  */
 150 int
 151 Session::process_routes (pframes_t nframes, bool& need_butler)
 152 {
 153         int  declick = get_transport_declick_required();
 154         boost::shared_ptr<RouteList> r = routes.reader ();
 155
 156         if (transport_sub_state & StopPendingCapture) {
 157                 /* force a declick out */
 158                 declick = -1;
 159         }
 160
 161         const framepos_t start_frame = _transport_frame;
 162         const framepos_t end_frame = _transport_frame + floor (nframes * _transport_speed);
 163
 164         if (_process_graph) {
 165                 DEBUG_TRACE(DEBUG::ProcessThreads,"calling graph/process-routes\n");
 166                 _process_graph->process_routes (nframes, start_frame, end_frame, declick, need_butler);
 167         } else {
 168
 169                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
 170
 171                         int ret;
 172
 173                         if ((*i)->is_hidden()) {
 174                                 continue;
 175                         }
 176
 177                         (*i)->set_pending_declick (declick);
 178
 179                         bool b = false;
 180
 181                         if ((ret = (*i)->roll (nframes, start_frame, end_frame, declick, b)) < 0) {
 182                                 stop_transport ();
 183                                 return -1;
 184                         }
 185
 186                         if (b) {
 187                                 need_butler = true;
 188                         }
 189                 }
 190         }
 191
 192         return 0;
 193 }
 194
 195 /** @param need_butler to be set to true by this method if it needs the butler,
 196  *  otherwise it must be left alone.
 197  */
 198 int
 199 Session::silent_process_routes (pframes_t nframes, bool& need_butler)
 200 {
 201         boost::shared_ptr<RouteList> r = routes.reader ();
 202
 203         const framepos_t start_frame = _transport_frame;
 204         const framepos_t end_frame = _transport_frame + lrintf(nframes * _transport_speed);
 205
 206         if (_process_graph) {
 207                 _process_graph->silent_process_routes (nframes, start_frame, end_frame, need_butler);
 208         } else {
 209                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
 210
 211                         int ret;
 212
 213                         if ((*i)->is_hidden()) {
 214                                 continue;
 215                         }
 216
 217                         bool b = false;
 218
 219                         if ((ret = (*i)->silent_roll (nframes, start_frame, end_frame, b)) < 0) {
 220                                 stop_transport ();
 221                                 return -1;
 222                         }
 223
 224                         if (b) {
 225                                 need_butler = true;
 226                         }
 227                 }
 228         }
 229
 230         return 0;
 231 }
 232
 233 void
 234 Session::get_track_statistics ()
 235 {
 236         float pworst = 1.0f;
 237         float cworst = 1.0f;
 238
 239         boost::shared_ptr<RouteList> rl = routes.reader();
 240         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
 241
 242                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
 243
 244                 if (!tr || tr->hidden()) {
 245                         continue;
 246                 }
 247
 248                 pworst = min (pworst, tr->playback_buffer_load());
 249                 cworst = min (cworst, tr->capture_buffer_load());
 250         }
 251
 252         g_atomic_int_set (&_playback_load, (uint32_t) floor (pworst * 100.0f));
 253         g_atomic_int_set (&_capture_load, (uint32_t) floor (cworst * 100.0f));
 254
 255         if (actively_recording()) {
 256                 set_dirty();
 257         }
 258 }
 259
 260 /** Process callback used when the auditioner is not active */
 261 void
 262 Session::process_with_events (pframes_t nframes)
 263 {
 264         PT_TIMING_CHECK (3);
 265
 266         SessionEvent*  ev;
 267         pframes_t      this_nframes;
 268         framepos_t     end_frame;
 269         bool           session_needs_butler = false;
 270         framecnt_t     frames_moved;
 271
 272         /* make sure the auditioner is silent */
 273
 274         if (auditioner) {
 275                 auditioner->silence (nframes);
 276         }
 277
 278         /* handle any pending events */
 279
 280         while (pending_events.read (&ev, 1) == 1) {
 281                 merge_event (ev);
 282         }
 283
 284         /* if we are not in the middle of a state change,
 285            and there are immediate events queued up,
 286            process them.
 287         */
 288
 289         while (!non_realtime_work_pending() && !immediate_events.empty()) {
 290                 SessionEvent *ev = immediate_events.front ();
 291                 immediate_events.pop_front ();
 292                 process_event (ev);
 293         }
 294
 295         /* Decide on what to do with quarter-frame MTC during this cycle */
 296
 297         bool const was_sending_qf_mtc = _send_qf_mtc;
 298         double const tolerance = Config->get_mtc_qf_speed_tolerance() / 100.0;
 299
 300         if (_transport_speed != 0) {
 301                 _send_qf_mtc = (
 302                         Config->get_send_mtc () &&
 303                         _transport_speed >= (1 - tolerance) &&
 304                         _transport_speed <= (1 + tolerance)
 305                         );
 306
 307                 if (_send_qf_mtc && !was_sending_qf_mtc) {
 308                         /* we will re-start quarter-frame MTC this cycle, so send a full update to set things up */
 309                         _send_timecode_update = true;
 310                 }
 311
 312                 if (Config->get_send_mtc() && !_send_qf_mtc && _pframes_since_last_mtc > (frame_rate () / 4)) {
 313                         /* we're sending MTC, but we're not sending QF MTC at the moment, and it's been
 314                            a quarter of a second since we sent anything at all, so send a full MTC update
 315                            this cycle.
 316                         */
 317                         _send_timecode_update = true;
 318                 }
 319
 320                 _pframes_since_last_mtc += nframes;
 321         }
 322
 323         /* Events caused a transport change (or we re-started sending
 324          * MTC), so send an MTC Full Frame (Timecode) message.  This
 325          * is sent whether rolling or not, to give slaves an idea of
 326          * ardour time on locates (and allow slow slaves to position
 327          * and prepare for rolling)
 328          */
 329         if (_send_timecode_update) {
 330                 send_full_time_code (_transport_frame);
 331         }
 332
 333         if (!process_can_proceed()) {
 334                 _silent = true;
 335                 return;
 336         }
 337
 338         if (events.empty() || next_event == events.end()) {
 339                 process_without_events (nframes);
 340                 return;
 341         }
 342
 343         if (_transport_speed == 1.0) {
 344                 frames_moved = (framecnt_t) nframes;
 345         } else {
 346                 interpolation.set_target_speed (_target_transport_speed);
 347                 interpolation.set_speed (_transport_speed);
 348                 frames_moved = (framecnt_t) interpolation.interpolate (0, nframes, 0, 0);
 349         }
 350
 351         end_frame = _transport_frame + frames_moved;
 352
 353         {
 354                 SessionEvent* this_event;
 355                 Events::iterator the_next_one;
 356
 357                 if (!process_can_proceed()) {
 358                         _silent = true;
 359                         return;
 360                 }
 361
 362                 if (!_exporting && _slave) {
 363                         if (!follow_slave (nframes)) {
 364                                 return;
 365                         }
 366                 }
 367
 368                 if (_transport_speed == 0) {
 369                         no_roll (nframes);
 370                         return;
 371                 }
 372
 373                 if (!_exporting && !timecode_transmission_suspended()) {
 374                         send_midi_time_code_for_cycle (_transport_frame, end_frame, nframes);
 375                 }
 376
 377                 framepos_t stop_limit = compute_stop_limit ();
 378
 379                 if (maybe_stop (stop_limit)) {
 380                         no_roll (nframes);
 381                         return;
 382                 }
 383
 384                 this_event = *next_event;
 385                 the_next_one = next_event;
 386                 ++the_next_one;
 387
 388                 /* yes folks, here it is, the actual loop where we really truly
 389                    process some audio
 390                 */
 391
 392                 while (nframes) {
 393
 394                         this_nframes = nframes; /* real (jack) time relative */
 395                         frames_moved = (framecnt_t) floor (_transport_speed * nframes); /* transport relative */
 396
 397                         /* running an event, position transport precisely to its time */
 398                         if (this_event && this_event->action_frame <= end_frame && this_event->action_frame >= _transport_frame) {
 399                                 /* this isn't quite right for reverse play */
 400                                 frames_moved = (framecnt_t) (this_event->action_frame - _transport_frame);
 401                                 this_nframes = abs (floor(frames_moved / _transport_speed));
 402                         }
 403
 404                         if (this_nframes) {
 405
 406                                 click (_transport_frame, this_nframes);
 407
 408                                 if (process_routes (this_nframes, session_needs_butler)) {
 409                                         fail_roll (nframes);
 410                                         return;
 411                                 }
 412
 413                                 get_track_statistics ();
 414
 415                                 nframes -= this_nframes;
 416
 417                                 if (frames_moved < 0) {
 418                                         decrement_transport_position (-frames_moved);
 419                                 } else {
 420                                         increment_transport_position (frames_moved);
 421                                 }
 422
 423                                 maybe_stop (stop_limit);
 424                                 check_declick_out ();
 425                         }
 426
 427                         _engine.split_cycle (this_nframes);
 428
 429                         /* now handle this event and all others scheduled for the same time */
 430
 431                         while (this_event && this_event->action_frame == _transport_frame) {
 432                                 process_event (this_event);
 433
 434                                 if (the_next_one == events.end()) {
 435                                         this_event = 0;
 436                                 } else {
 437                                         this_event = *the_next_one;
 438                                         ++the_next_one;
 439                                 }
 440                         }
 441
 442                         /* if an event left our state changing, do the right thing */
 443
 444                         if (nframes && non_realtime_work_pending()) {
 445                                 no_roll (nframes);
 446                                 break;
 447                         }
 448
 449                         /* this is necessary to handle the case of seamless looping */
 450                         end_frame = _transport_frame + floor (nframes * _transport_speed);
 451                 }
 452
 453                 set_next_event ();
 454
 455         } /* implicit release of route lock */
 456
 457         if (session_needs_butler) {
 458                 _butler->summon ();
 459         }
 460 }
 461
 462 void
 463 Session::reset_slave_state ()
 464 {
 465         average_slave_delta = 1800;
 466         delta_accumulator_cnt = 0;
 467         have_first_delta_accumulator = false;
 468         _slave_state = Stopped;
 469 }
 470
 471 bool
 472 Session::transport_locked () const
 473 {
 474         Slave* sl = _slave;
 475
 476         if (!locate_pending() && (!config.get_external_sync() || (sl && sl->ok() && sl->locked()))) {
 477                 return true;
 478         }
 479
 480         return false;
 481 }
 482
 483 bool
 484 Session::follow_slave (pframes_t nframes)
 485 {
 486         double slave_speed;
 487         framepos_t slave_transport_frame;
 488         framecnt_t this_delta;
 489         int dir;
 490
 491         if (!_slave->ok()) {
 492                 stop_transport ();
 493                 config.set_external_sync (false);
 494                 goto noroll;
 495         }
 496
 497         _slave->speed_and_position (slave_speed, slave_transport_frame);
 498
 499         DEBUG_TRACE (DEBUG::Slave, string_compose ("Slave position %1 speed %2\n", slave_transport_frame, slave_speed));
 500
 501         if (!_slave->locked()) {
 502                 DEBUG_TRACE (DEBUG::Slave, "slave not locked\n");
 503                 goto noroll;
 504         }
 505
 506         if (slave_transport_frame > _transport_frame) {
 507                 this_delta = slave_transport_frame - _transport_frame;
 508                 dir = 1;
 509         } else {
 510                 this_delta = _transport_frame - slave_transport_frame;
 511                 dir = -1;
 512         }
 513
 514         if (_slave->starting()) {
 515                 slave_speed = 0.0f;
 516         }
 517
 518         if (_slave->is_always_synced() || Config->get_timecode_source_is_synced()) {
 519
 520                 /* if the TC source is synced, then we assume that its
 521                    speed is binary: 0.0 or 1.0
 522                 */
 523
 524                 if (slave_speed != 0.0f) {
 525                         slave_speed = 1.0f;
 526                 }
 527
 528         } else {
 529
 530                 /* if we are chasing and the average delta between us and the
 531                    master gets too big, we want to switch to silent
 532                    motion. so keep track of that here.
 533                 */
 534
 535                 if (_slave_state == Running) {
 536                         calculate_moving_average_of_slave_delta(dir, this_delta);
 537                 }
 538         }
 539
 540         track_slave_state (slave_speed, slave_transport_frame, this_delta);
 541
 542         DEBUG_TRACE (DEBUG::Slave, string_compose ("slave state %1 @ %2 speed %3 cur delta %4 avg delta %5\n",
 543                                                    _slave_state, slave_transport_frame, slave_speed, this_delta, average_slave_delta));
 544
 545
 546         if (_slave_state == Running && !_slave->is_always_synced() && !Config->get_timecode_source_is_synced()) {
 547
 548                 if (_transport_speed != 0.0f) {
 549
 550                         /*
 551                            note that average_dir is +1 or -1
 552                         */
 553
 554                         float delta;
 555
 556                         if (average_slave_delta == 0) {
 557                                 delta = this_delta;
 558                                 delta *= dir;
 559                         } else {
 560                                 delta = average_slave_delta;
 561                                 delta *= average_dir;
 562                         }
 563
 564 #ifndef NDEBUG
 565                         if (slave_speed != 0.0) {
 566                                 DEBUG_TRACE (DEBUG::Slave, string_compose ("delta = %1 speed = %2 ts = %3 M@%4 S@%5 avgdelta %6\n",
 567                                                                            (int) (dir * this_delta),
 568                                                                            slave_speed,
 569                                                                            _transport_speed,
 570                                                                            _transport_frame,
 571                                                                            slave_transport_frame,
 572                                                                            average_slave_delta));
 573                         }
 574 #endif
 575
 576                         if (_slave->give_slave_full_control_over_transport_speed()) {
 577                                 set_transport_speed (slave_speed, false, false);
 578                                 //std::cout << "set speed = " << slave_speed << "\n";
 579                         } else {
 580                                 float adjusted_speed = slave_speed + (1.5 * (delta /  float(_current_frame_rate)));
 581                                 request_transport_speed (adjusted_speed);
 582                                 DEBUG_TRACE (DEBUG::Slave, string_compose ("adjust using %1 towards %2 ratio %3 current %4 slave @ %5\n",
 583                                                                            delta, adjusted_speed, adjusted_speed/slave_speed, _transport_speed,
 584                                                                            slave_speed));
 585                         }
 586
 587 #if 1
 588                         if (!actively_recording() && (framecnt_t) abs(average_slave_delta) > _slave->resolution()) {
 589                                 cerr << "average slave delta greater than slave resolution (" << _slave->resolution() << "), going to silent motion\n";
 590                                 goto silent_motion;
 591                         }
 592 #endif
 593                 }
 594         }
 595
 596
 597         if (_slave_state == Running && !non_realtime_work_pending()) {
 598                 /* speed is set, we're locked, and good to go */
 599                 return true;
 600         }
 601
 602   silent_motion:
 603         DEBUG_TRACE (DEBUG::Slave, "silent motion\n")
 604         follow_slave_silently (nframes, slave_speed);
 605
 606   noroll:
 607         /* don't move at all */
 608         DEBUG_TRACE (DEBUG::Slave, "no roll\n")
 609         no_roll (nframes);
 610         return false;
 611 }
 612
 613 void
 614 Session::calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta)
 615 {
 616         if (delta_accumulator_cnt >= delta_accumulator_size) {
 617                 have_first_delta_accumulator = true;
 618                 delta_accumulator_cnt = 0;
 619         }
 620
 621         if (delta_accumulator_cnt != 0 || this_delta < _current_frame_rate) {
 622                 delta_accumulator[delta_accumulator_cnt++] = (framecnt_t) dir *  (framecnt_t) this_delta;
 623         }
 624
 625         if (have_first_delta_accumulator) {
 626                 average_slave_delta = 0L;
 627                 for (int i = 0; i < delta_accumulator_size; ++i) {
 628                         average_slave_delta += delta_accumulator[i];
 629                 }
 630                 average_slave_delta /= (int32_t) delta_accumulator_size;
 631                 if (average_slave_delta < 0L) {
 632                         average_dir = -1;
 633                         average_slave_delta = abs(average_slave_delta);
 634                 } else {
 635                         average_dir = 1;
 636                 }
 637         }
 638 }
 639
 640 void
 641 Session::track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t /*this_delta*/)
 642 {
 643         if (slave_speed != 0.0f) {
 644
 645                 /* slave is running */
 646
 647                 switch (_slave_state) {
 648                 case Stopped:
 649                         if (_slave->requires_seekahead()) {
 650                                 slave_wait_end = slave_transport_frame + _slave->seekahead_distance ();
 651                                 DEBUG_TRACE (DEBUG::Slave, string_compose ("slave stopped, but running, requires seekahead to %1\n", slave_wait_end));
 652                                 /* we can call locate() here because we are in process context */
 653                                 locate (slave_wait_end, false, false);
 654                                 _slave_state = Waiting;
 655
 656                         } else {
 657
 658                                 DEBUG_TRACE (DEBUG::Slave, string_compose ("slave stopped -> running at %1\n", slave_transport_frame));
 659
 660                                 memset (delta_accumulator, 0, sizeof (int32_t) * delta_accumulator_size);
 661                                 average_slave_delta = 0L;
 662
 663                                 Location* al = _locations->auto_loop_location();
 664
 665                                 if (al && play_loop && (slave_transport_frame < al->start() || slave_transport_frame > al->end())) {
 666                                         // cancel looping
 667                                         request_play_loop(false);
 668                                 }
 669
 670                                 if (slave_transport_frame != _transport_frame) {
 671                                         DEBUG_TRACE (DEBUG::Slave, string_compose ("require locate to run. eng: %1 -> sl: %2\n", _transport_frame, slave_transport_frame));
 672                                         locate (slave_transport_frame, false, false);
 673                                 }
 674                                 _slave_state = Running;
 675                         }
 676                         break;
 677
 678                 case Waiting:
 679                 default:
 680                         break;
 681                 }
 682
 683                 if (_slave_state == Waiting) {
 684
 685                         DEBUG_TRACE (DEBUG::Slave, string_compose ("slave waiting at %1\n", slave_transport_frame));
 686
 687                         if (slave_transport_frame >= slave_wait_end) {
 688
 689                                 DEBUG_TRACE (DEBUG::Slave, string_compose ("slave start at %1 vs %2\n", slave_transport_frame, _transport_frame));
 690
 691                                 _slave_state = Running;
 692
 693                                 /* now perform a "micro-seek" within the disk buffers to realign ourselves
 694                                    precisely with the master.
 695                                 */
 696
 697
 698                                 bool ok = true;
 699                                 framecnt_t frame_delta = slave_transport_frame - _transport_frame;
 700
 701                                 boost::shared_ptr<RouteList> rl = routes.reader();
 702                                 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
 703                                         boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
 704                                         if (tr && !tr->can_internal_playback_seek (frame_delta)) {
 705                                                 ok = false;
 706                                                 break;
 707                                         }
 708                                 }
 709
 710                                 if (ok) {
 711                                         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
 712                                                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
 713                                                 if (tr) {
 714                                                         tr->internal_playback_seek (frame_delta);
 715                                                 }
 716                                         }
 717                                         _transport_frame += frame_delta;
 718
 719                                 } else {
 720                                         cerr << "cannot micro-seek\n";
 721                                         /* XXX what? */
 722                                 }
 723                         }
 724                 }
 725
 726                 if (_slave_state == Running && _transport_speed == 0.0f) {
 727                         DEBUG_TRACE (DEBUG::Slave, "slave starts transport\n");
 728                         start_transport ();
 729                 }
 730
 731         } else { // slave_speed is 0
 732
 733                 /* slave has stopped */
 734
 735                 if (_transport_speed != 0.0f) {
 736                         DEBUG_TRACE (DEBUG::Slave, string_compose ("slave stops transport: %1 frame %2 tf %3\n", slave_speed, slave_transport_frame, _transport_frame));
 737                         stop_transport ();
 738                 }
 739
 740                 if (slave_transport_frame != _transport_frame) {
 741                         DEBUG_TRACE (DEBUG::Slave, string_compose ("slave stopped, move to %1\n", slave_transport_frame));
 742                         force_locate (slave_transport_frame, false);
 743                 }
 744
 745                 reset_slave_state();
 746         }
 747 }
 748
 749 void
 750 Session::follow_slave_silently (pframes_t nframes, float slave_speed)
 751 {
 752         if (slave_speed && _transport_speed) {
 753
 754                 /* something isn't right, but we should move with the master
 755                    for now.
 756                 */
 757
 758                 bool need_butler;
 759
 760                 silent_process_routes (nframes, need_butler);
 761
 762                 get_track_statistics ();
 763
 764                 if (need_butler) {
 765                         _butler->summon ();
 766                 }
 767
 768                 int32_t frames_moved = (int32_t) floor (_transport_speed * nframes);
 769
 770                 if (frames_moved < 0) {
 771                         decrement_transport_position (-frames_moved);
 772                 } else {
 773                         increment_transport_position (frames_moved);
 774                 }
 775
 776                 framepos_t const stop_limit = compute_stop_limit ();
 777                 maybe_stop (stop_limit);
 778         }
 779 }
 780
 781 void
 782 Session::process_without_events (pframes_t nframes)
 783 {
 784         bool session_needs_butler = false;
 785         framecnt_t frames_moved;
 786
 787         if (!process_can_proceed()) {
 788                 _silent = true;
 789                 return;
 790         }
 791
 792         if (!_exporting && _slave) {
 793                 if (!follow_slave (nframes)) {
 794                         ltc_tx_send_time_code_for_cycle (_transport_frame, _transport_frame, 0, 0 , nframes);
 795                         return;
 796                 }
 797         }
 798
 799         if (_transport_speed == 0) {
 800                 fail_roll (nframes);
 801                 return;
 802         }
 803
 804         if (_transport_speed == 1.0) {
 805                 frames_moved = (framecnt_t) nframes;
 806         } else {
 807                 interpolation.set_target_speed (_target_transport_speed);
 808                 interpolation.set_speed (_transport_speed);
 809                 frames_moved = (framecnt_t) interpolation.interpolate (0, nframes, 0, 0);
 810         }
 811
 812         if (!_exporting && !timecode_transmission_suspended()) {
 813                 send_midi_time_code_for_cycle (_transport_frame, _transport_frame + frames_moved, nframes);
 814         }
 815
 816         ltc_tx_send_time_code_for_cycle (_transport_frame, _transport_frame + frames_moved, _target_transport_speed, _transport_speed, nframes);
 817
 818         framepos_t const stop_limit = compute_stop_limit ();
 819
 820         if (maybe_stop (stop_limit)) {
 821                 fail_roll (nframes);
 822                 return;
 823         }
 824
 825         if (maybe_sync_start (nframes)) {
 826                 return;
 827         }
 828
 829         click (_transport_frame, nframes);
 830
 831         if (process_routes (nframes, session_needs_butler)) {
 832                 fail_roll (nframes);
 833                 return;
 834         }
 835
 836         get_track_statistics ();
 837
 838         if (frames_moved < 0) {
 839                 decrement_transport_position (-frames_moved);
 840         } else {
 841                 increment_transport_position (frames_moved);
 842         }
 843
 844         maybe_stop (stop_limit);
 845         check_declick_out ();
 846
 847         if (session_needs_butler) {
 848                 _butler->summon ();
 849         }
 850 }
 851
 852 /** Process callback used when the auditioner is active.
 853  * @param nframes number of frames to process.
 854  */
 855 void
 856 Session::process_audition (pframes_t nframes)
 857 {
 858         SessionEvent* ev;
 859         boost::shared_ptr<RouteList> r = routes.reader ();
 860
 861         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
 862                 if (!(*i)->is_hidden()) {
 863                         (*i)->silence (nframes);
 864                 }
 865         }
 866
 867         /* run the auditioner, and if it says we need butler service, ask for it */
 868
 869         if (auditioner->play_audition (nframes) > 0) {
 870                 _butler->summon ();
 871         }
 872
 873         /* if using a monitor section, run it because otherwise we don't hear anything */
 874
 875         if (auditioner->needs_monitor()) {
 876                 _monitor_out->monitor_run (_transport_frame, _transport_frame + nframes, nframes, false);
 877         }
 878
 879         /* handle pending events */
 880
 881         while (pending_events.read (&ev, 1) == 1) {
 882                 merge_event (ev);
 883         }
 884
 885         /* if we are not in the middle of a state change,
 886            and there are immediate events queued up,
 887            process them.
 888         */
 889
 890         while (!non_realtime_work_pending() && !immediate_events.empty()) {
 891                 SessionEvent *ev = immediate_events.front ();
 892                 immediate_events.pop_front ();
 893                 process_event (ev);
 894         }
 895
 896         if (!auditioner->auditioning()) {
 897                 /* auditioner no longer active, so go back to the normal process callback */
 898                 process_function = &Session::process_with_events;
 899         }
 900 }
 901
 902 bool
 903 Session::maybe_sync_start (pframes_t & nframes)
 904 {
 905         pframes_t sync_offset;
 906
 907         if (!waiting_for_sync_offset) {
 908                 return false;
 909         }
 910
 911         if (_engine.get_sync_offset (sync_offset) && sync_offset < nframes) {
 912
 913                 /* generate silence up to the sync point, then
 914                    adjust nframes + offset to reflect whatever
 915                    is left to do.
 916                 */
 917
 918                 no_roll (sync_offset);
 919                 nframes -= sync_offset;
 920                 Port::increment_global_port_buffer_offset (sync_offset);
 921                 waiting_for_sync_offset = false;
 922
 923                 if (nframes == 0) {
 924                         return true; // done, nothing left to process
 925                 }
 926
 927         } else {
 928
 929                 /* sync offset point is not within this process()
 930                    cycle, so just generate silence. and don't bother
 931                    with any fancy stuff here, just the minimal silence.
 932                 */
 933
 934                 _silent = true;
 935
 936                 if (Config->get_locate_while_waiting_for_sync()) {
 937                         if (micro_locate (nframes)) {
 938                                 /* XXX ERROR !!! XXX */
 939                         }
 940                 }
 941
 942                 return true; // done, nothing left to process
 943         }
 944
 945         return false;
 946 }
 947
 948 void
 949 Session::queue_event (SessionEvent* ev)
 950 {
 951         if (_state_of_the_state & Deletion) {
 952                 return;
 953         } else if (_state_of_the_state & Loading) {
 954                 merge_event (ev);
 955         } else {
 956                 pending_events.write (&ev, 1);
 957         }
 958 }
 959
 960 void
 961 Session::set_next_event ()
 962 {
 963         if (events.empty()) {
 964                 next_event = events.end();
 965                 return;
 966         }
 967
 968         if (next_event == events.end()) {
 969                 next_event = events.begin();
 970         }
 971
 972         if ((*next_event)->action_frame > _transport_frame) {
 973                 next_event = events.begin();
 974         }
 975
 976         for (; next_event != events.end(); ++next_event) {
 977                 if ((*next_event)->action_frame >= _transport_frame) {
 978                         break;
 979                 }
 980         }
 981 }
 982
 983 void
 984 Session::process_event (SessionEvent* ev)
 985 {
 986         bool remove = true;
 987         bool del = true;
 988
 989         /* if we're in the middle of a state change (i.e. waiting
 990            for the butler thread to complete the non-realtime
 991            part of the change), we'll just have to queue this
 992            event for a time when the change is complete.
 993         */
 994
 995         if (non_realtime_work_pending()) {
 996
 997                 /* except locates, which we have the capability to handle */
 998
 999                 if (ev->type != SessionEvent::Locate) {
1000                         immediate_events.insert (immediate_events.end(), ev);
1001                         _remove_event (ev);
1002                         return;
1003                 }
1004         }
1005
1006         DEBUG_TRACE (DEBUG::SessionEvents, string_compose ("Processing event: %1 @ %2\n", enum_2_string (ev->type), _transport_frame));
1007
1008         switch (ev->type) {
1009         case SessionEvent::SetLoop:
1010                 set_play_loop (ev->yes_or_no);
1011                 break;
1012
1013         case SessionEvent::AutoLoop:
1014                 if (play_loop) {
1015                         /* roll after locate, do not flush, set "with loop"
1016                            true only if we are seamless looping
1017                         */
1018                         start_locate (ev->target_frame, true, false, Config->get_seamless_loop());
1019                 }
1020                 remove = false;
1021                 del = false;
1022                 break;
1023
1024         case SessionEvent::AutoLoopDeclick:
1025                 if (play_loop) {
1026                         /* Request a declick fade-out and a fade-in; the fade-out will happen
1027                            at the end of the loop, and the fade-in at the start.
1028                         */
1029                         transport_sub_state |= (PendingLoopDeclickOut | PendingLoopDeclickIn);
1030                 }
1031                 remove = false;
1032                 del = false;
1033                 break;
1034
1035         case SessionEvent::Locate:
1036                 if (ev->yes_or_no) {
1037                         /* args: do not roll after locate, do flush, not with loop */
1038                         locate (ev->target_frame, false, true, false);
1039                 } else {
1040                         /* args: do not roll after locate, do flush, not with loop */
1041                         start_locate (ev->target_frame, false, true, false);
1042                 }
1043                 _send_timecode_update = true;
1044                 break;
1045
1046         case SessionEvent::LocateRoll:
1047                 if (ev->yes_or_no) {
1048                         /* args: roll after locate, do flush, not with loop */
1049                         locate (ev->target_frame, true, true, false);
1050                 } else {
1051                         /* args: roll after locate, do flush, not with loop */
1052                         start_locate (ev->target_frame, true, true, false);
1053                 }
1054                 _send_timecode_update = true;
1055                 break;
1056
1057         case SessionEvent::LocateRollLocate:
1058                 // locate is handled by ::request_roll_at_and_return()
1059                 _requested_return_frame = ev->target_frame;
1060                 request_locate (ev->target2_frame, true);
1061                 break;
1062
1063
1064         case SessionEvent::SetTransportSpeed:
1065                 set_transport_speed (ev->speed, ev->yes_or_no, ev->second_yes_or_no, ev->third_yes_or_no);
1066                 break;
1067
1068         case SessionEvent::PunchIn:
1069                 // cerr << "PunchIN at " << transport_frame() << endl;
1070                 if (config.get_punch_in() && record_status() == Enabled) {
1071                         enable_record ();
1072                 }
1073                 remove = false;
1074                 del = false;
1075                 break;
1076
1077         case SessionEvent::PunchOut:
1078                 // cerr << "PunchOUT at " << transport_frame() << endl;
1079                 if (config.get_punch_out()) {
1080                         step_back_from_record ();
1081                 }
1082                 remove = false;
1083                 del = false;
1084                 break;
1085
1086         case SessionEvent::StopOnce:
1087                 if (!non_realtime_work_pending()) {
1088                         stop_transport (ev->yes_or_no);
1089                         _clear_event_type (SessionEvent::StopOnce);
1090                 }
1091                 remove = false;
1092                 del = false;
1093                 break;
1094
1095         case SessionEvent::RangeStop:
1096                 if (!non_realtime_work_pending()) {
1097                         stop_transport (ev->yes_or_no);
1098                 }
1099                 remove = false;
1100                 del = false;
1101                 break;
1102
1103         case SessionEvent::RangeLocate:
1104                 /* args: roll after locate, do flush, not with loop */
1105                 start_locate (ev->target_frame, true, true, false);
1106                 remove = false;
1107                 del = false;
1108                 break;
1109
1110         case SessionEvent::Overwrite:
1111                 overwrite_some_buffers (static_cast<Track*>(ev->ptr));
1112                 break;
1113
1114         case SessionEvent::SetTrackSpeed:
1115                 set_track_speed (static_cast<Track*> (ev->ptr), ev->speed);
1116                 break;
1117
1118         case SessionEvent::SetSyncSource:
1119                 DEBUG_TRACE (DEBUG::Slave, "seen request for new slave\n");
1120                 use_sync_source (ev->slave);
1121                 break;
1122
1123         case SessionEvent::Audition:
1124                 set_audition (ev->region);
1125                 // drop reference to region
1126                 ev->region.reset ();
1127                 break;
1128
1129         case SessionEvent::InputConfigurationChange:
1130                 add_post_transport_work (PostTransportInputChange);
1131                 _butler->schedule_transport_work ();
1132                 break;
1133
1134         case SessionEvent::SetPlayAudioRange:
1135                 set_play_range (ev->audio_range, (ev->speed == 1.0f));
1136                 break;
1137
1138         case SessionEvent::RealTimeOperation:
1139                 process_rtop (ev);
1140                 del = false; // other side of RT request needs to clean up
1141                 break;
1142
1143         case SessionEvent::AdjustPlaybackBuffering:
1144                 schedule_playback_buffering_adjustment ();
1145                 break;
1146
1147         case SessionEvent::AdjustCaptureBuffering:
1148                 schedule_capture_buffering_adjustment ();
1149                 break;
1150
1151         case SessionEvent::SetTimecodeTransmission:
1152                 g_atomic_int_set (&_suspend_timecode_transmission, ev->yes_or_no ? 0 : 1);
1153                 break;
1154
1155         default:
1156           fatal << string_compose(_("Programming error: illegal event type in process_event (%1)"), ev->type) << endmsg;
1157                 /*NOTREACHED*/
1158                 break;
1159         };
1160
1161         if (remove) {
1162                 del = del && !_remove_event (ev);
1163         }
1164
1165         if (del) {
1166                 delete ev;
1167         }
1168 }
1169
1170 framepos_t
1171 Session::compute_stop_limit () const
1172 {
1173         if (!Config->get_stop_at_session_end ()) {
1174                 return max_framepos;
1175         }
1176
1177         if (_slave) {
1178                 return max_framepos;
1179         }
1180
1181
1182         bool const punching_in = (config.get_punch_in () && _locations->auto_punch_location());
1183         bool const punching_out = (config.get_punch_out () && _locations->auto_punch_location());
1184
1185         if (actively_recording ()) {
1186                 /* permanently recording */
1187                 return max_framepos;
1188         } else if (punching_in && !punching_out) {
1189                 /* punching in but never out */
1190                 return max_framepos;
1191         } else if (punching_in && punching_out && _locations->auto_punch_location()->end() > current_end_frame()) {
1192                 /* punching in and punching out after session end */
1193                 return max_framepos;
1194         }
1195
1196         return current_end_frame ();
1197 }