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