Remove unnecessary 0 checks before delete; see http://www.parashift.com/c++-faq-lite...
[ardour.git] / libs / ardour / session_process.cc
index db6d75beeca480c9de9edea8580bbefbc785120c..c2e78df643e4203cca9abe80ffdfd7ac9949ac10 100644 (file)
@@ -15,7 +15,6 @@
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
 #include <cmath>
@@ -24,7 +23,7 @@
 #include <unistd.h>
 
 #include <pbd/error.h>
+
 #include <glibmm/thread.h>
 
 #include <ardour/ardour.h>
 #include <ardour/cycles.h>
 #include <ardour/cycle_timer.h>
 
+#include <midi++/manager.h>
+
 #include "i18n.h"
 
 using namespace ARDOUR;
 using namespace PBD;
 using namespace std;
 
+/** Called by the audio engine when there is work to be done with JACK.
+ * @param nframes Number of frames to process.
+ */
 void
-Session::process (jack_nframes_t nframes)
+Session::process (nframes_t nframes)
 {
-       if (synced_to_jack() && waiting_to_start) {
-               if ( _engine.transport_state() == AudioEngine::TransportRolling) {
-                       actually_start_transport ();
-               }
-       }
+       // This is no more the appriopriate place to call cycle
+       // start. cycle_start needs to be called at the Route::roll()
+       // where the signals which we want to mixdown have been calculated.
+       //
+       MIDI::Manager::instance()->cycle_start(nframes);
+
+       _silent = false;
 
        if (non_realtime_work_pending()) {
-               if (g_atomic_int_get (&butler_should_do_transport_work) == 0) {
+               if (!transport_work_requested ()) {
                        post_transport ();
                } 
        } 
        
        (this->*process_function) (nframes);
-
+       
+       // the ticker is for sending time information like MidiClock
+       nframes_t transport_frames = transport_frame();
+       BBT_Time  transport_bbt;
+       bbt_time(transport_frames, transport_bbt);
+       SMPTE::Time transport_smpte;
+       smpte_time(transport_frames, transport_smpte);
+       tick (transport_frames, transport_bbt, transport_smpte); /* EMIT SIGNAL */
+       
        SendFeedback (); /* EMIT SIGNAL */
+       
+       MIDI::Manager::instance()->cycle_end();
 }
 
 void
@@ -73,9 +89,9 @@ Session::prepare_diskstreams ()
 }
 
 int
-Session::no_roll (jack_nframes_t nframes, jack_nframes_t offset)
+Session::no_roll (nframes_t nframes, nframes_t offset)
 {
-       jack_nframes_t end_frame = _transport_frame + nframes;
+       nframes_t end_frame = _transport_frame + nframes; // FIXME: varispeed + no_roll ??
        int ret = 0;
        bool declick = get_transport_declick_required();
        boost::shared_ptr<RouteList> r = routes.reader ();
@@ -93,7 +109,7 @@ Session::no_roll (jack_nframes_t nframes, jack_nframes_t offset)
 
        for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
                
-               if ((*i)->hidden()) {
+               if ((*i)->is_hidden()) {
                        continue;
                }
                
@@ -111,7 +127,7 @@ Session::no_roll (jack_nframes_t nframes, jack_nframes_t offset)
 }
 
 int
-Session::process_routes (jack_nframes_t nframes, jack_nframes_t offset)
+Session::process_routes (nframes_t nframes, nframes_t offset)
 {
        bool record_active;
        int  declick = get_transport_declick_required();
@@ -125,17 +141,20 @@ Session::process_routes (jack_nframes_t nframes, jack_nframes_t offset)
 
        record_active = actively_recording(); // || (get_record_enabled() && get_punch_in());
 
+       const nframes_t start_frame = _transport_frame;
+       const nframes_t end_frame = _transport_frame + (nframes_t)floor(nframes * _transport_speed);
+
        for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
 
                int ret;
 
-               if ((*i)->hidden()) {
+               if ((*i)->is_hidden()) {
                        continue;
                }
 
                (*i)->set_pending_declick (declick);
 
-               if ((ret = (*i)->roll (nframes, _transport_frame, _transport_frame + nframes, offset, declick, record_active, rec_monitors)) < 0) {
+               if ((ret = (*i)->roll (nframes, start_frame, end_frame, offset, declick, record_active, rec_monitors)) < 0) {
 
                        /* we have to do this here. Route::roll() for an AudioTrack will have called AudioDiskstream::process(),
                           and the DS will expect AudioDiskstream::commit() to be called. but we're aborting from that
@@ -156,7 +175,7 @@ Session::process_routes (jack_nframes_t nframes, jack_nframes_t offset)
 }
 
 int
-Session::silent_process_routes (jack_nframes_t nframes, jack_nframes_t offset)
+Session::silent_process_routes (nframes_t nframes, nframes_t offset)
 {
        bool record_active = actively_recording();
        int  declick = get_transport_declick_required();
@@ -167,16 +186,19 @@ Session::silent_process_routes (jack_nframes_t nframes, jack_nframes_t offset)
                /* force a declick out */
                declick = -1;
        }
+       
+       const nframes_t start_frame = _transport_frame;
+       const nframes_t end_frame = _transport_frame + lrintf(nframes * _transport_speed);
 
        for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
 
                int ret;
 
-               if ((*i)->hidden()) {
+               if ((*i)->is_hidden()) {
                        continue;
                }
 
-               if ((ret = (*i)->silent_roll (nframes, _transport_frame, _transport_frame + nframes, offset, record_active, rec_monitors)) < 0) {
+               if ((ret = (*i)->silent_roll (nframes, start_frame, end_frame, offset, record_active, rec_monitors)) < 0) {
                        
                        /* we have to do this here. Route::roll() for an AudioTrack will have called AudioDiskstream::process(),
                           and the DS will expect AudioDiskstream::commit() to be called. but we're aborting from that
@@ -197,7 +219,7 @@ Session::silent_process_routes (jack_nframes_t nframes, jack_nframes_t offset)
 }
 
 void
-Session::commit_diskstreams (jack_nframes_t nframes, bool &needs_butler)
+Session::commit_diskstreams (nframes_t nframes, bool &needs_butler)
 {
        int dret;
        float pworst = 1.0f;
@@ -211,6 +233,9 @@ Session::commit_diskstreams (jack_nframes_t nframes, bool &needs_butler)
                }
                
                /* force all diskstreams not handled by a Route to call do their stuff.
+                  Note: the diskstreams that were handled by a route will just return zero
+                  from this call, because they know they were processed. So in fact, this
+                  also runs commit() for every diskstream.
                 */
 
                if ((dret = (*i)->process (_transport_frame, nframes, 0, actively_recording(), get_rec_monitors_input())) == 0) {
@@ -241,17 +266,18 @@ Session::commit_diskstreams (jack_nframes_t nframes, bool &needs_butler)
        }
 }
 
+/** Process callback used when the auditioner is not active */
 void
-Session::process_with_events (jack_nframes_t nframes)
+Session::process_with_events (nframes_t nframes)
 {
-       Event* ev;
-       jack_nframes_t this_nframes;
-       jack_nframes_t end_frame;
-       jack_nframes_t offset;
+       Event*         ev;
+       nframes_t this_nframes;
+       nframes_t end_frame;
+       nframes_t offset;
        bool session_needs_butler = false;
-       jack_nframes_t stop_limit;
+       nframes_t stop_limit;
        long           frames_moved;
-
+       
        /* make sure the auditioner is silent */
 
        if (auditioner) {
@@ -275,24 +301,32 @@ Session::process_with_events (jack_nframes_t nframes)
                process_event (ev);
        }
 
+       /* Events caused a transport change, send an MTC Full Frame (SMPTE) message.
+        * This is sent whether rolling or not, to give slaves an idea of ardour time
+        * on locates (and allow slow slaves to position and prepare for rolling)
+        */
+       if (_send_smpte_update) {
+               send_full_time_code(nframes);
+       }
+
        if (!process_can_proceed()) {
-               no_roll (nframes, 0);
+               _silent = true;
                return;
        }
-               
+
        if (events.empty() || next_event == events.end()) {
                process_without_events (nframes);
                return;
        }
 
-       end_frame = _transport_frame + nframes;
+       end_frame = _transport_frame + (nframes_t)abs(floor(nframes * _transport_speed));
 
        {
                Event* this_event;
                Events::iterator the_next_one;
                
-               if (post_transport_work & (PostTransportLocate|PostTransportStop)) {
-                       no_roll (nframes, 0);
+               if (!process_can_proceed()) {
+                       _silent = true;
                        return;
                }
                
@@ -306,6 +340,10 @@ Session::process_with_events (jack_nframes_t nframes)
                        no_roll (nframes, 0);
                        return;
                }
+       
+               if (!_exporting) {
+                       send_midi_time_code_for_cycle (nframes);
+               }
 
                if (actively_recording()) {
                        stop_limit = max_frames;
@@ -329,22 +367,19 @@ Session::process_with_events (jack_nframes_t nframes)
 
                offset = 0;
 
+               /* yes folks, here it is, the actual loop where we really truly
+                  process some audio */
                while (nframes) {
 
-                       if (this_event == 0 || this_event->action_frame > end_frame || this_event->action_frame < _transport_frame) {
+                       this_nframes = nframes; /* real (jack) time relative */
+                       frames_moved = (long) floor (_transport_speed * nframes); /* transport relative */
 
-                               this_nframes = nframes;
-                               
-                       } else {
-                               
-                               /* compute nframes to next event */
-
-                               if (this_event->action_frame < end_frame) {
-                                       this_nframes = nframes - (end_frame - this_event->action_frame);
-                               } else {
-                                       this_nframes = nframes;
-                               }
-                       }
+                       /* running an event, position transport precisely to its time */
+                       if (this_event && this_event->action_frame <= end_frame && this_event->action_frame >= _transport_frame) {
+                               /* this isn't quite right for reverse play */
+                               frames_moved = (long) (this_event->action_frame - _transport_frame);
+                               this_nframes = (nframes_t) abs( floor(frames_moved / _transport_speed) );
+                       } 
 
                        if (this_nframes) {
                                
@@ -363,8 +398,6 @@ Session::process_with_events (jack_nframes_t nframes)
                                nframes -= this_nframes;
                                offset += this_nframes;
                                
-                               frames_moved = (jack_nframes_t) floor (_transport_speed * this_nframes);
-                       
                                if (frames_moved < 0) {
                                        decrement_transport_position (-frames_moved);
                                } else {
@@ -396,8 +429,7 @@ Session::process_with_events (jack_nframes_t nframes)
                        }
 
                        /* this is necessary to handle the case of seamless looping */
-                       /* not sure if it will work in conjuction with varispeed */
-                       end_frame = _transport_frame + nframes;
+                       end_frame = _transport_frame + (nframes_t) floor (nframes * _transport_speed);
                        
                }
 
@@ -405,17 +437,9 @@ Session::process_with_events (jack_nframes_t nframes)
 
        } /* implicit release of route lock */
 
-
-       if (session_needs_butler) {
+       if (session_needs_butler)
                summon_butler ();
-       } 
-       
-       if (!_engine.freewheeling() && session_send_mtc) {
-               send_midi_time_code_in_another_thread ();
-       }
-
-       return;
-}              
+}
 
 void
 Session::reset_slave_state ()
@@ -439,11 +463,11 @@ Session::transport_locked () const
 }
 
 bool
-Session::follow_slave (jack_nframes_t nframes, jack_nframes_t offset)
+Session::follow_slave (nframes_t nframes, nframes_t offset)
 {
        float slave_speed;
-       jack_nframes_t slave_transport_frame;
-       jack_nframes_t this_delta;
+       nframes_t slave_transport_frame;
+       nframes_t this_delta;
        int dir;
        bool starting;
 
@@ -475,12 +499,12 @@ Session::follow_slave (jack_nframes_t nframes, jack_nframes_t offset)
        cerr << "delta = " << (int) (dir * this_delta)
             << " speed = " << slave_speed 
             << " ts = " << _transport_speed 
-            << " M@"<< slave_transport_frame << " S@" << _transport_frame 
+            << " M@ "<< slave_transport_frame << " S@ " << _transport_frame 
             << " avgdelta = " << average_slave_delta 
             << endl;
 #endif 
 
-       if (Config->get_timecode_source_is_synced()) {
+       if (_slave->is_always_synced() || Config->get_timecode_source_is_synced()) {
 
                /* if the TC source is synced, then we assume that its 
                   speed is binary: 0.0 or 1.0
@@ -503,18 +527,18 @@ Session::follow_slave (jack_nframes_t nframes, jack_nframes_t offset)
                }
 
                if (delta_accumulator_cnt != 0 || this_delta < _current_frame_rate) {
-                       delta_accumulator[delta_accumulator_cnt++] = dir*this_delta;
+                       delta_accumulator[delta_accumulator_cnt++] = long(dir) * long(this_delta);
                }
                
                if (have_first_delta_accumulator) {
-                       average_slave_delta = 0;
+                       average_slave_delta = 0L;
                        for (int i = 0; i < delta_accumulator_size; ++i) {
                                average_slave_delta += delta_accumulator[i];
                        }
-                       average_slave_delta /= delta_accumulator_size;
-                       if (average_slave_delta < 0) {
+                       average_slave_delta /= long(delta_accumulator_size);
+                       if (average_slave_delta < 0L) {
                                average_dir = -1;
-                               average_slave_delta = -average_slave_delta;
+                               average_slave_delta = abs(average_slave_delta);
                        } else {
                                average_dir = 1;
                        }
@@ -562,14 +586,13 @@ Session::follow_slave (jack_nframes_t nframes, jack_nframes_t offset)
                if (slave_state == Waiting) {
 
                        // cerr << "waiting at " << slave_transport_frame << endl;
-                       
                        if (slave_transport_frame >= slave_wait_end) {
                                // cerr << "\tstart at " << _transport_frame << endl;
 
                                slave_state = Running;
 
                                bool ok = true;
-                               jack_nframes_t frame_delta = slave_transport_frame - _transport_frame;
+                               nframes_t frame_delta = slave_transport_frame - _transport_frame;
 
                                boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
                                
@@ -591,8 +614,8 @@ Session::follow_slave (jack_nframes_t nframes, jack_nframes_t offset)
                                        /* XXX what? */
                                }
 
-                               memset (delta_accumulator, 0, sizeof (jack_nframes_t) * delta_accumulator_size);
-                               average_slave_delta = 0;
+                               memset (delta_accumulator, 0, sizeof (long) * delta_accumulator_size);
+                               average_slave_delta = 0L;
                                this_delta = 0;
                        }
                }
@@ -629,7 +652,7 @@ Session::follow_slave (jack_nframes_t nframes, jack_nframes_t offset)
                slave_state = Stopped;
        }
 
-       if (slave_state == Running && !Config->get_timecode_source_is_synced()) {
+       if (slave_state == Running && !_slave->is_always_synced() && !Config->get_timecode_source_is_synced()) {
 
 
                if (_transport_speed != 0.0f) {
@@ -652,18 +675,20 @@ Session::follow_slave (jack_nframes_t nframes, jack_nframes_t offset)
                        float adjusted_speed = slave_speed +
                                (delta / (adjust_seconds * _current_frame_rate));
                        
-                       // cerr << "adjust using " << delta
-                       // << " towards " << adjusted_speed
-                       // << " ratio = " << adjusted_speed / slave_speed
-                       // << " current = " << _transport_speed
-                       // << " slave @ " << slave_speed
-                       // << endl;
+#if 0
+                       cerr << "adjust using " << delta
+                            << " towards " << adjusted_speed
+                            << " ratio = " << adjusted_speed / slave_speed
+                            << " current = " << _transport_speed
+                            << " slave @ " << slave_speed
+                            << endl;
+#endif
                        
                        request_transport_speed (adjusted_speed);
                        
 #if 1
-                       if ((jack_nframes_t) average_slave_delta > _slave->resolution()) {
-                               // cerr << "not locked\n";
+                       if (abs(average_slave_delta) > (long) _slave->resolution()) {
+                               cerr << "average slave delta greater than slave resolution, going to silent motion\n";
                                goto silent_motion;
                        }
 #endif
@@ -701,7 +726,7 @@ Session::follow_slave (jack_nframes_t nframes, jack_nframes_t offset)
                        increment_transport_position (frames_moved);
                }
                
-               jack_nframes_t stop_limit;
+               nframes_t stop_limit;
                
                if (actively_recording()) {
                        stop_limit = max_frames;
@@ -718,97 +743,95 @@ Session::follow_slave (jack_nframes_t nframes, jack_nframes_t offset)
 
   noroll:
        /* don't move at all */
+  cerr << "********* noroll" << endl;
        no_roll (nframes, 0);
        return false;
 }
 
 void
-Session::process_without_events (jack_nframes_t nframes)
+Session::process_without_events (nframes_t nframes)
 {
        bool session_needs_butler = false;
-       jack_nframes_t stop_limit;
+       nframes_t stop_limit;
        long frames_moved;
-       jack_nframes_t offset = 0;
+       nframes_t offset = 0;
 
-       {
-               if (post_transport_work & (PostTransportLocate|PostTransportStop)) {
-                       no_roll (nframes, 0);
-                       return;
-               }
-
-               if (!_exporting && _slave) {
-                       if (!follow_slave (nframes, 0)) {
-                               return;
-                       }
-               } 
+       if (!process_can_proceed()) {
+               _silent = true;
+               return;
+       }
 
-               if (_transport_speed == 0) {
-                       no_roll (nframes, 0);
+       if (!_exporting && _slave) {
+               if (!follow_slave (nframes, 0)) {
                        return;
                }
+       } 
+
+       if (_transport_speed == 0) {
+               no_roll (nframes, 0);
+               return;
+       }
                
-               if (actively_recording()) {
-                       stop_limit = max_frames;
+       if (!_exporting) {
+               send_midi_time_code_for_cycle (nframes);
+       }
+
+       if (actively_recording()) {
+               stop_limit = max_frames;
+       } else {
+               if (Config->get_stop_at_session_end()) {
+                       stop_limit = current_end_frame();
                } else {
-                       if (Config->get_stop_at_session_end()) {
-                               stop_limit = current_end_frame();
-                       } else {
-                               stop_limit = max_frames;
-                       }
+                       stop_limit = max_frames;
                }
+       }
                
-               if (maybe_stop (stop_limit)) {
-                       no_roll (nframes, 0);
-                       return;
-               
+       if (maybe_stop (stop_limit)) {
+               no_roll (nframes, 0);
+               return;
+       } 
 
-               if (maybe_sync_start (nframes, offset)) {
-                       return;
-               }
+       if (maybe_sync_start (nframes, offset)) {
+               return;
+       }
 
-               click (_transport_frame, nframes, offset);
+       click (_transport_frame, nframes, offset);
 
-               prepare_diskstreams ();
+       prepare_diskstreams ();
        
-               frames_moved = (long) floor (_transport_speed * nframes);
+       frames_moved = (long) floor (_transport_speed * nframes);
 
-               if (process_routes (nframes, offset)) {
-                       no_roll (nframes, offset);
-                       return;
-               }
+       if (process_routes (nframes, offset)) {
+               no_roll (nframes, offset);
+               return;
+       }
 
-               commit_diskstreams (nframes, session_needs_butler);
+       commit_diskstreams (nframes, session_needs_butler);
 
-               if (frames_moved < 0) {
-                       decrement_transport_position (-frames_moved);
-               } else {
-                       increment_transport_position (frames_moved);
-               }
+       if (frames_moved < 0) {
+               decrement_transport_position (-frames_moved);
+       } else {
+               increment_transport_position (frames_moved);
+       }
 
-               maybe_stop (stop_limit);
-               check_declick_out ();
+       maybe_stop (stop_limit);
+       check_declick_out ();
 
-       } /* implicit release of route lock */
-
-       if (session_needs_butler) {
+       if (session_needs_butler)
                summon_butler ();
-       } 
-       
-       if (!_engine.freewheeling() && session_send_mtc) {
-               send_midi_time_code_in_another_thread ();
-       }
-
-       return;
-}              
+}
 
+/** Process callback used when the auditioner is active.
+ * @param nframes number of frames to process.
+ */
 void
-Session::process_audition (jack_nframes_t nframes)
+Session::process_audition (nframes_t nframes)
 {
        Event* ev;
        boost::shared_ptr<RouteList> r = routes.reader ();
 
        for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
-               if (!(*i)->hidden()) {
+               if (!(*i)->is_hidden()) {
                        (*i)->silence (nframes, 0);
                }
        }
@@ -837,33 +860,54 @@ Session::process_audition (jack_nframes_t nframes)
        }
 
        if (!auditioner->active()) {
+               /* auditioner no longer active, so go back to the normal process callback */
                process_function = &Session::process_with_events;
        }
 }
 
 bool
-Session::maybe_sync_start (jack_nframes_t& nframes, jack_nframes_t& offset)
+Session::maybe_sync_start (nframes_t& nframes, nframes_t& offset)
 {
-       jack_nframes_t sync_offset;
-       
+       nframes_t sync_offset;
+
        if (!waiting_for_sync_offset) {
                return false;
        }
 
        if (_engine.get_sync_offset (sync_offset) && sync_offset < nframes) {
 
+               /* generate silence up to the sync point, then
+                  adjust nframes + offset to reflect whatever
+                  is left to do.
+               */
+
                no_roll (sync_offset, 0);
                nframes -= sync_offset;
                offset += sync_offset;
                waiting_for_sync_offset = false;
                
                if (nframes == 0) {
-                       return true; // done
+                       return true; // done, nothing left to process
                }
                
        } else {
+
+               /* sync offset point is not within this process()
+                  cycle, so just generate silence. and don't bother 
+                  with any fancy stuff here, just the minimal silence.
+               */
+
+               g_atomic_int_inc (&processing_prohibited);
                no_roll (nframes, 0);
-               return true; // done
+               g_atomic_int_dec_and_test (&processing_prohibited);
+
+               if (Config->get_locate_while_waiting_for_sync()) {
+                       if (micro_locate (nframes)) {
+                               /* XXX ERROR !!! XXX */
+                       }
+               }
+
+               return true; // done, nothing left to process
        }
 
        return false;