MIDClock_Slave: Introduce a 3% deadzone around speed 1.0 to lock in the speed
[ardour.git] / libs / ardour / midi_clock_slave.cc
index ef3aacb4c66f15c74f7220a67d4a2be5c7c7a52f..16f45440620f85b921e3e56f32fcd6a8c81f1a73 100644 (file)
 #include <poll.h>
 #include <sys/types.h>
 #include <unistd.h>
-#include <pbd/error.h>
-#include <pbd/failed_constructor.h>
-#include <pbd/pthread_utils.h>
+#include "pbd/error.h"
+#include "pbd/failed_constructor.h"
+#include "pbd/pthread_utils.h"
 
-#include <midi++/port.h>
-#include <midi++/jack.h>
-#include <ardour/slave.h>
-#include <ardour/session.h>
-#include <ardour/audioengine.h>
-#include <ardour/cycles.h>
-#include <ardour/tempo.h>
+#include "midi++/port.h"
+#include "midi++/jack.h"
+#include "ardour/slave.h"
+#include "ardour/session.h"
+#include "ardour/audioengine.h"
+#include "ardour/cycles.h"
+#include "ardour/tempo.h"
 
 
 #include "i18n.h"
 
+using namespace std;
 using namespace ARDOUR;
-using namespace sigc;
 using namespace MIDI;
 using namespace PBD;
 
+#define DEBUG_MIDI_CLOCK 1
+
 MIDIClock_Slave::MIDIClock_Slave (Session& s, MIDI::Port& p, int ppqn)
-       : session (s)
-       , ppqn (ppqn)
-       , bandwidth (30.0 / 60.0) // 1 BpM = 1 / 60 Hz
+       : ppqn (ppqn)
+       , bandwidth (1.0 / 60.0) // 1 BpM = 1 / 60 Hz
 {
+       session = (ISlaveSessionProxy *) new SlaveSessionProxy(s);
        rebind (p);
        reset ();
 }
 
+MIDIClock_Slave::MIDIClock_Slave (ISlaveSessionProxy* session_proxy, int ppqn)
+       : session(session_proxy)
+       , ppqn (ppqn)
+       , bandwidth (1.0 / 60.0) // 1 BpM = 1 / 60 Hz
+{
+       reset ();
+}
+
 MIDIClock_Slave::~MIDIClock_Slave()
 {
+       delete session;
 }
 
 void
 MIDIClock_Slave::rebind (MIDI::Port& p)
 {
-       for (vector<sigc::connection>::iterator i = connections.begin(); i != connections.end(); ++i) {
-               (*i).disconnect ();
-       }
+       port_connections.drop_connections();
 
        port = &p;
 
-       #ifdef DEBUG_MIDI_CLOCK         
-               std::cerr << "MIDIClock_Slave: connecting to port " << port->name() << std::endl;
-       #endif
+#ifdef DEBUG_MIDI_CLOCK
+       std::cerr << "MIDIClock_Slave: connecting to port " << port->name() << std::endl;
+#endif
 
-       connections.push_back (port->input()->timing.connect   (mem_fun (*this, &MIDIClock_Slave::update_midi_clock)));
-       connections.push_back (port->input()->start.connect    (mem_fun (*this, &MIDIClock_Slave::start)));
-       connections.push_back (port->input()->contineu.connect (mem_fun (*this, &MIDIClock_Slave::contineu)));
-       connections.push_back (port->input()->stop.connect     (mem_fun (*this, &MIDIClock_Slave::stop)));
-       connections.push_back (port->input()->position.connect (mem_fun (*this, &MIDIClock_Slave::position)));
+       port->input()->timing.connect_same_thread (port_connections, boost::bind (&MIDIClock_Slave::update_midi_clock, this, _1, _2));
+       port->input()->start.connect_same_thread (port_connections, boost::bind (&MIDIClock_Slave::start, this, _1, _2));
+       port->input()->contineu.connect_same_thread (port_connections, boost::bind (&MIDIClock_Slave::contineu, this, _1, _2));
+       port->input()->stop.connect_same_thread (port_connections, boost::bind (&MIDIClock_Slave::stop, this, _1, _2));
+       port->input()->position.connect_same_thread (port_connections, boost::bind (&MIDIClock_Slave::position, this, _1, _2, 3));
 }
 
-void 
-MIDIClock_Slave::calculate_one_ppqn_in_frames_at(nframes_t time)
+void
+MIDIClock_Slave::calculate_one_ppqn_in_frames_at(nframes64_t time)
 {
-       const Tempo& current_tempo = session.tempo_map().tempo_at(time);
-       const Meter& current_meter = session.tempo_map().meter_at(time);
+       const Tempo& current_tempo = session->tempo_map().tempo_at(time);
+       const Meter& current_meter = session->tempo_map().meter_at(time);
        double frames_per_beat =
-               current_tempo.frames_per_beat(session.frame_rate(),
+               current_tempo.frames_per_beat(session->frame_rate(),
                                              current_meter);
 
        double quarter_notes_per_beat = 4.0 / current_tempo.note_type();
@@ -90,101 +99,109 @@ MIDIClock_Slave::calculate_one_ppqn_in_frames_at(nframes_t time)
        one_ppqn_in_frames = frames_per_quarter_note / double (ppqn);
 }
 
-ARDOUR::nframes_t 
+ARDOUR::nframes64_t
 MIDIClock_Slave::calculate_song_position(uint16_t song_position_in_sixteenth_notes)
 {
-       nframes_t song_position_frames = 0;
+       nframes64_t song_position_frames = 0;
        for (uint16_t i = 1; i <= song_position_in_sixteenth_notes; ++i) {
                // one quarter note contains ppqn pulses, so a sixteenth note is ppqn / 4 pulses
                calculate_one_ppqn_in_frames_at(song_position_frames);
-               song_position_frames += one_ppqn_in_frames * nframes_t(ppqn / 4);
+               song_position_frames += one_ppqn_in_frames * (nframes64_t)(ppqn / 4);
        }
-       
+
        return song_position_frames;
 }
 
-void 
+void
 MIDIClock_Slave::calculate_filter_coefficients()
 {
        // omega = 2 * PI * Bandwidth / MIDI clock frame frequency in Hz
-       omega = 2.0 * 3.14159265358979323846 * bandwidth * one_ppqn_in_frames / session.frame_rate();
+       omega = 2.0 * 3.14159265358979323846 * bandwidth * one_ppqn_in_frames / session->frame_rate();
        b = 1.4142135623730950488 * omega;
-       c = omega * omega;      
+       c = omega * omega;
 }
 
 void
-MIDIClock_Slave::update_midi_clock (Parser& parser, nframes_t timestamp)
-{                                      
-       // the number of midi clock messages (zero-based)
-       static long midi_clock_count;
-       
-       calculate_one_ppqn_in_frames_at(last_position);
-       
-       nframes_t timestamp_relative_to_transport = timestamp - first_timestamp;
-       
+MIDIClock_Slave::update_midi_clock (Parser& /*parser*/, nframes64_t timestamp)
+{
+       // some pieces of hardware send MIDI Clock all the time
+       if ( (!_starting) && (!_started) ) {
+               return;
+       }
+
+       calculate_one_ppqn_in_frames_at(should_be_position);
+
+       nframes64_t elapsed_since_start = timestamp - first_timestamp;
+       double error = 0;
+
        if (_starting || last_timestamp == 0) {
                midi_clock_count = 0;
-               
+
                first_timestamp = timestamp;
-               timestamp_relative_to_transport = last_position;
-               
+               elapsed_since_start = should_be_position;
+
                // calculate filter coefficients
                calculate_filter_coefficients();
-               
+
                // initialize DLL
-               e2 = double(one_ppqn_in_frames) / double(session.frame_rate());
-               t0 = double(timestamp_relative_to_transport) / double(session.frame_rate());
+               e2 = double(one_ppqn_in_frames) / double(session->frame_rate());
+               t0 = double(elapsed_since_start) / double(session->frame_rate());
                t1 = t0 + e2;
-               
+
                // let ardour go after first MIDI Clock Event
                _starting = false;
-       } else {                
+       } else {
                midi_clock_count++;
-               last_position  += one_ppqn_in_frames;
+               should_be_position  += one_ppqn_in_frames;
                calculate_filter_coefficients();
 
                // calculate loop error
-               // we use session.transport_frame() instead of t1 here
+               // we use session->transport_frame() instead of t1 here
                // because t1 is used to calculate the transport speed,
                // so the loop will compensate for accumulating rounding errors
-               e = (double(last_position) - double(session.transport_frame())) 
-                   / double(session.frame_rate());
-               
+               error = (double(should_be_position) - double(session->audible_frame()));
+               e = error / double(session->frame_rate());
+
                // update DLL
                t0 = t1;
                t1 += b * e + e2;
-               e2 += c * e;                    
-       }       
-       
-       #ifdef DEBUG_MIDI_CLOCK         
-               std::cerr 
+               e2 += c * e;
+       }
+
+       #ifdef DEBUG_MIDI_CLOCK
+               cerr
                                  << "MIDI Clock #" << midi_clock_count
-                                 //<< "@" << timestamp  
-                                 << " (transport-relative: " << timestamp_relative_to_transport << " should be: " << last_position << ", delta: " << (double(last_position) - double(session.transport_frame())) <<" )"
-                                 << " transport: " << session.transport_frame()
-                                 //<< " engine: " << session.engine().frame_time() 
-                                 << " real delta: " << timestamp - last_timestamp 
-                                 << " reference: " << one_ppqn_in_frames
-                                 << " t1-t0: " << (t1 -t0) * session.frame_rate()
-                                 << " t0: " << t0 * session.frame_rate()
-                                 << " t1: " << t1 * session.frame_rate() 
-                                 << " frame-rate: " << session.frame_rate() 
-                                 << std::endl;
+                                 //<< "@" << timestamp
+                                 << " arrived at: " << elapsed_since_start << " (elapsed time) "
+                                 << " should-be transport: " << should_be_position
+                                 << " audible: " << session->audible_frame()
+                                 << " real transport: " << session->transport_frame()
+                                 << " error: " << error
+                                 //<< " engine: " << session->frame_time()
+                                 << " real delta: " << timestamp - last_timestamp
+                                 << " should-be delta: " << one_ppqn_in_frames
+                                 << " t1-t0: " << (t1 -t0) * session->frame_rate()
+                                 << " t0: " << t0 * session->frame_rate()
+                                 << " t1: " << t1 * session->frame_rate()
+                                 << " frame-rate: " << session->frame_rate()
+                                 << endl;
+
+               //cerr      << "frames since cycle start: " << session->frames_since_cycle_start() << endl;
        #endif // DEBUG_MIDI_CLOCK
 
        last_timestamp = timestamp;
 }
 
 void
-MIDIClock_Slave::start (Parser& parser, nframes_t timestamp)
-{      
-       #ifdef DEBUG_MIDI_CLOCK 
-               cerr << "MIDIClock_Slave got start message at time "  <<  timestamp << " session time: " << session.engine().frame_time() << endl;
+MIDIClock_Slave::start (Parser& /*parser*/, nframes64_t timestamp)
+{
+       #ifdef DEBUG_MIDI_CLOCK
+               cerr << "MIDIClock_Slave got start message at time "  <<  timestamp << " engine time: " << session->frame_time() << endl;
        #endif
-       
+
        if (!_started) {
                reset();
-               
+
                _started = true;
                _starting = true;
        }
@@ -194,65 +211,85 @@ void
 MIDIClock_Slave::reset ()
 {
 
-       last_position = 0;              
+       should_be_position = 0;
        last_timestamp = 0;
-       
+
        _starting = false;
        _started  = false;
-       
-       session.request_locate(0, false);
+
+        if (session) session->request_locate(0, false);
 }
 
 void
-MIDIClock_Slave::contineu (Parser& parser, nframes_t timestamp)
+MIDIClock_Slave::contineu (Parser& /*parser*/, nframes64_t /*timestamp*/)
 {
-       #ifdef DEBUG_MIDI_CLOCK 
+       #ifdef DEBUG_MIDI_CLOCK
                std::cerr << "MIDIClock_Slave got continue message" << endl;
        #endif
        if (!_started) {
                _starting = true;
-               _started  = true; 
+               _started  = true;
        }
 }
 
 
 void
-MIDIClock_Slave::stop (Parser& parser, nframes_t timestamp)
+MIDIClock_Slave::stop (Parser& /*parser*/, nframes64_t /*timestamp*/)
 {
-       #ifdef DEBUG_MIDI_CLOCK 
+       #ifdef DEBUG_MIDI_CLOCK
                std::cerr << "MIDIClock_Slave got stop message" << endl;
        #endif
-       
+
        if (_started || _starting) {
                _starting = false;
                _started  = false;
                // locate to last MIDI clock position
-               session.request_transport_speed(0.0);
-               session.request_locate(last_position, false);
+               session->request_transport_speed(0.0);
+
+               // we need to go back to the last MIDI beat (6 ppqn)
+               // and lets hope the tempo didnt change in the meantime :)
+
+               // begin at the should be position, because
+               // that is the position of the last MIDI Clock
+               // message and that is probably what the master
+               // expects where we are right now
+               nframes64_t stop_position = should_be_position;
+
+               // find out the last MIDI beat: go back #midi_clocks mod 6
+               // and lets hope the tempo didnt change in those last 6 beats :)
+               stop_position -= (midi_clock_count % 6) * one_ppqn_in_frames;
+
+               session->request_locate(stop_position, false);
+               should_be_position = stop_position;
                last_timestamp = 0;
        }
 }
 
 void
-MIDIClock_Slave::position (Parser& parser, byte* message, size_t size)
+MIDIClock_Slave::position (Parser& /*parser*/, byte* message, size_t size)
 {
        // we are note supposed to get position messages while we are running
        // so lets be robust and ignore those
        if (_started || _starting) {
                return;
        }
-       
+
        assert(size == 3);
-       byte lsb = message[0];
-       byte msb = message[1];
+       byte lsb = message[1];
+       byte msb = message[2];
        assert((lsb <= 0x7f) && (msb <= 0x7f));
-       
+
        uint16_t position_in_sixteenth_notes = (uint16_t(msb) << 7) | uint16_t(lsb);
-       nframes_t position_in_frames = calculate_song_position(position_in_sixteenth_notes);
-       session.request_locate(position_in_frames, false);
-       last_position  = position_in_frames;
+       nframes64_t position_in_frames = calculate_song_position(position_in_sixteenth_notes);
+
+       #ifdef DEBUG_MIDI_CLOCK
+       cerr << "Song Position: " << position_in_sixteenth_notes << " frames: " << position_in_frames << endl;
+       #endif
+
+       session->request_locate(position_in_frames, false);
+       should_be_position  = position_in_frames;
        last_timestamp = 0;
-       
+
 }
 
 bool
@@ -274,18 +311,18 @@ MIDIClock_Slave::starting() const
 }
 
 bool
-MIDIClock_Slave::stop_if_no_more_clock_events(nframes_t& pos, nframes_t now)
+MIDIClock_Slave::stop_if_no_more_clock_events(nframes64_t& pos, nframes64_t now)
 {
        /* no timecode for 1/4 second ? conclude that its stopped */
-       if (last_timestamp && 
-           now > last_timestamp && 
-           now - last_timestamp > session.frame_rate() / 4) {
-        #ifdef DEBUG_MIDI_CLOCK                        
+       if (last_timestamp &&
+           now > last_timestamp &&
+           now - last_timestamp > session->frame_rate() / 4) {
+        #ifdef DEBUG_MIDI_CLOCK
                        cerr << "No MIDI Clock frames received for some time, stopping!" << endl;
-        #endif         
-               pos = last_position;
-               session.request_transport_speed (0);
-               session.request_locate (last_position, false);
+        #endif
+               pos = should_be_position;
+               session->request_transport_speed (0);
+               session->request_locate (should_be_position, false);
                return true;
        } else {
                return false;
@@ -293,34 +330,42 @@ MIDIClock_Slave::stop_if_no_more_clock_events(nframes_t& pos, nframes_t now)
 }
 
 bool
-MIDIClock_Slave::speed_and_position (double& speed, nframes_t& pos)
+MIDIClock_Slave::speed_and_position (double& speed, nframes64_t& pos)
 {
        if (!_started || _starting) {
                speed = 0.0;
-               pos   = last_position;
+               pos   = should_be_position;
                return true;
        }
-               
-       nframes_t engine_now = session.engine().frame_time();
+
+       nframes64_t engine_now = session->frame_time();
 
        if (stop_if_no_more_clock_events(pos, engine_now)) {
                return false;
        }
 
        // calculate speed
-       speed = ((t1 - t0) * session.frame_rate()) / one_ppqn_in_frames;
+       speed = ((t1 - t0) * session->frame_rate()) / one_ppqn_in_frames;
        
+       // provide a 3% deadzone to lock the speed
+       if (fabs(speed - 1.0) <= 0.03)
+               speed = 1.0;
+
        // calculate position
        if (engine_now > last_timestamp) {
                // we are in between MIDI clock messages
                // so we interpolate position according to speed
-               nframes_t elapsed = engine_now - last_timestamp;
-               pos = nframes_t (last_position + double(elapsed) * speed);
+               nframes64_t elapsed = engine_now - last_timestamp;
+               pos = (nframes64_t) (should_be_position + double(elapsed) * speed);
        } else {
                // A new MIDI clock message has arrived this cycle
-               pos = last_position;
+               pos = should_be_position;
        }
 
+       #ifdef DEBUG_MIDI_CLOCK
+       cerr << "speed_and_position: " << speed << " & " << pos << " <-> " << session->transport_frame() << " (transport)" << endl;
+       #endif
+
        return true;
 }