libs/ardour/session_process.cc

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