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