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