fix up and re-enable MTC transmission
[ardour.git] / libs / ardour / session_midi.cc
index f58098d9d1c43d0e4a5f3598afe838ff5aef7973..d877c158b85bb19c9c6ba39330ffbfc98ea94453 100644 (file)
@@ -21,6 +21,7 @@
 #include <string>
 #include <cmath>
 #include <cerrno>
+#include <cassert>
 #include <unistd.h>
 #include <fcntl.h>
 #include <poll.h>
@@ -39,6 +40,7 @@
 #include <ardour/audio_diskstream.h>
 #include <ardour/slave.h>
 #include <ardour/cycles.h>
+#include <ardour/smpte.h>
 
 #include "i18n.h"
 
@@ -50,8 +52,6 @@ using namespace MIDI;
 MachineControl::CommandSignature MMC_CommandSignature;
 MachineControl::ResponseSignature MMC_ResponseSignature;
 
-MultiAllocSingleReleasePool Session::MIDIRequest::pool ("midi", sizeof (Session::MIDIRequest), 1024);
-
 int
 Session::use_config_midi_ports ()
 {
@@ -126,17 +126,26 @@ Session::set_mtc_port (string port_tag)
 }
 
 void
-Session::set_mmc_device_id (uint32_t device_id)
+Session::set_mmc_receive_device_id (uint32_t device_id)
 {
        if (mmc) {
-               mmc->set_device_id (device_id);
+               mmc->set_receive_device_id (device_id);
+       }
+}
+
+void
+Session::set_mmc_send_device_id (uint32_t device_id)
+{
+       if (mmc) {
+               mmc->set_send_device_id (device_id);
        }
 }
 
 int
 Session::set_mmc_port (string port_tag)
 {
-       MIDI::byte old_device_id = 0;
+       MIDI::byte old_recv_device_id = 0;
+       MIDI::byte old_send_device_id = 0;
        bool reset_id = false;
 
        if (port_tag.length() == 0) {
@@ -156,7 +165,8 @@ Session::set_mmc_port (string port_tag)
        _mmc_port = port;
 
        if (mmc) {
-               old_device_id = mmc->device_id();
+               old_recv_device_id = mmc->receive_device_id();
+               old_recv_device_id = mmc->send_device_id();
                reset_id = true;
                delete mmc;
        }
@@ -166,7 +176,8 @@ Session::set_mmc_port (string port_tag)
                                        MMC_ResponseSignature);
 
        if (reset_id) {
-               mmc->set_device_id (old_device_id);
+               mmc->set_receive_device_id (old_recv_device_id);
+               mmc->set_send_device_id (old_send_device_id);
        }
 
        mmc->Play.connect 
@@ -215,6 +226,7 @@ Session::set_mmc_port (string port_tag)
 int
 Session::set_midi_port (string port_tag)
 {
+#if 0
        if (port_tag.length() == 0) {
                if (_midi_port == 0) {
                        return 0;
@@ -238,6 +250,7 @@ Session::set_midi_port (string port_tag)
        Config->set_midi_port_name (port_tag);
 
   out:
+#endif
        MIDI_PortChanged(); /* EMIT SIGNAL */
        change_midi_ports ();
        set_dirty();
@@ -379,13 +392,13 @@ void
 Session::setup_midi_control ()
 {
        outbound_mtc_smpte_frame = 0;
-       next_quarter_frame_to_send = -1;
+       next_quarter_frame_to_send = 0;
 
        /* setup the MMC buffer */
        
        mmc_buffer[0] = 0xf0; // SysEx
        mmc_buffer[1] = 0x7f; // Real Time SysEx ID for MMC
-       mmc_buffer[2] = 0x7f; // "broadcast" device ID
+       mmc_buffer[2] = (mmc ? mmc->send_device_id() : 0x7f);
        mmc_buffer[3] = 0x6;  // MCC
 
        /* Set up the qtr frame message */
@@ -400,44 +413,6 @@ Session::setup_midi_control ()
        mtc_msg[14] = 0xf1;
 }
 
-int
-Session::midi_read (MIDI::Port* port)
-{
-       MIDI::byte buf[512];
-       
-       /* reading from the MIDI port activates the Parser
-          that in turn generates signals that we care
-          about. the port is already set to NONBLOCK so that
-          can read freely here.
-       */
-       
-       while (1) {
-               
-               // cerr << "+++ READ ON " << port->name() << endl;
-               
-               int nread = port->read (buf, sizeof (buf));
-
-               // cerr << "-- READ (" << nread << " ON " << port->name() << endl;
-               
-               if (nread > 0) {
-                       if ((size_t) nread < sizeof (buf)) {
-                               break;
-                       } else {
-                               continue;
-                       }
-               } else if (nread == 0) {
-                       break;
-               } else if (errno == EAGAIN) {
-                       break;
-               } else {
-                       fatal << string_compose(_("Error reading from MIDI port %1"), port->name()) << endmsg;
-                       /*NOTREACHED*/
-               }
-       }
-
-       return 0;
-}
-
 void
 Session::spp_start (Parser& ignored)
 {
@@ -687,51 +662,6 @@ Session::mmc_record_enable (MIDI::MachineControl &mmc, size_t trk, bool enabled)
        }
 }
 
-void
-Session::send_full_time_code_in_another_thread ()
-{
-       send_time_code_in_another_thread (true);
-}
-
-void
-Session::send_midi_time_code_in_another_thread ()
-{
-       send_time_code_in_another_thread (false);
-}
-
-void
-Session::send_time_code_in_another_thread (bool full)
-{
-       nframes_t two_smpte_frames_duration;
-       nframes_t quarter_frame_duration;
-
-       /* Duration of two smpte frames */
-       two_smpte_frames_duration = ((long) _frames_per_smpte_frame) << 1;
-
-       /* Duration of one quarter frame */
-       quarter_frame_duration = ((long) _frames_per_smpte_frame) >> 2;
-
-       if (_transport_frame < (outbound_mtc_smpte_frame + (next_quarter_frame_to_send * quarter_frame_duration)))
-       {
-               /* There is no work to do.
-                  We throttle this here so that we don't overload
-                  the transport thread with requests.
-               */
-               return;
-       }
-
-       MIDIRequest* request = new MIDIRequest;
-
-       if (full) {
-               request->type = MIDIRequest::SendFullMTC;
-       } else {
-               request->type = MIDIRequest::SendMTC;
-       }
-       
-       midi_requests.write (&request, 1);
-       poke_midi_thread ();
-}
-
 void
 Session::change_midi_ports ()
 {
@@ -742,40 +672,37 @@ Session::change_midi_ports ()
        poke_midi_thread ();
 }
 
-int
-Session::send_full_time_code ()
+/** Send MTC Full Frame message (complete SMPTE time) for the start of this cycle.
+ * This resets the MTC code, the next quarter frame message that is sent will be
+ * the first one with the beginning of this cycle as the new start point.
+ */
 
+int
+Session::send_full_time_code(nframes_t nframes)
 {
+       /* This function could easily send at a given frame offset, but would
+        * that be useful?  Does ardour do sub-block accurate locating? [DR] */
+
        MIDI::byte msg[10];
        SMPTE::Time smpte;
 
+       _send_smpte_update = false;
+
        if (_mtc_port == 0 || !session_send_mtc) {
                return 0;
        }
-
+       
        // Get smpte time for this transport frame
        sample_to_smpte(_transport_frame, smpte, true /* use_offset */, false /* no subframes */);
 
-       // Check for negative smpte time and prepare for quarter frame transmission
-       if (smpte.negative) {
-               // Negative mtc is not defined, so sync slave to smpte zero.
-               // When _transport_frame gets there we will start transmitting quarter frames
-               smpte.hours = 0;
-               smpte.minutes = 0;
-               smpte.seconds = 0;
-               smpte.frames = 0;
-               smpte.subframes = 0;
-               smpte.negative = false;
-               smpte_to_sample( smpte, outbound_mtc_smpte_frame, true, false );
-               transmitting_smpte_time = smpte;
-       } else {
-               transmitting_smpte_time = smpte;
-               outbound_mtc_smpte_frame = _transport_frame;
-               if (((mtc_smpte_bits >> 5) != MIDI::MTC_25_FPS) && (transmitting_smpte_time.frames % 2)) {
-                       // start MTC quarter frame transmission on an even frame
-                       SMPTE::increment( transmitting_smpte_time );
-                       outbound_mtc_smpte_frame += (nframes_t) _frames_per_smpte_frame;
-               }
+       transmitting_smpte_time = smpte;
+       outbound_mtc_smpte_frame = _transport_frame;
+
+       // I don't understand this bit yet.. [DR]
+       if (((mtc_smpte_bits >> 5) != MIDI::MTC_25_FPS) && (transmitting_smpte_time.frames % 2)) {
+               // start MTC quarter frame transmission on an even frame
+               SMPTE::increment( transmitting_smpte_time );
+               outbound_mtc_smpte_frame += (nframes_t) _frames_per_smpte_frame;
        }
 
        // Compensate for audio latency
@@ -783,7 +710,7 @@ Session::send_full_time_code ()
 
        next_quarter_frame_to_send = 0;
 
-       // Sync slave to the same smpte time as we are on (except if negative, see above)
+       // Sync slave to the same SMPTE time as we are on
        msg[0] = 0xf0;
        msg[1] = 0x7f;
        msg[2] = 0x7f;
@@ -796,42 +723,55 @@ Session::send_full_time_code ()
        msg[7] = smpte.seconds;
        msg[8] = smpte.frames;
 
-       {
-               Glib::Mutex::Lock lm (midi_lock);
-    
-               if (_mtc_port->midimsg (msg, sizeof (msg))) {
-                       error << _("Session: could not send full MIDI time code") << endmsg;
-                       
-                       return -1;
-               }
+       cerr << "MTC: Sending full time code at " << outbound_mtc_smpte_frame << endl;
+
+       // Send message at offset 0, sent time is for the start of this cycle
+       if (!_mtc_port->midimsg (msg, sizeof (msg), 0)) {
+               error << _("Session: could not send full MIDI time code") << endmsg;
+               return -1;
        }
 
        return 0;
 }
 
+
+/** Sends MTC (quarter-frame) messages for this cycle.
+ * Must be called exactly once per cycle from the audio thread.  Realtime safe.
+ * This function assumes the state of full SMPTE is sane, eg. the slave is
+ * expecting quarter frame messages and has the right frame of reference (any
+ * full MTC SMPTE time messages that needed to be sent should have been sent
+ * earlier already this cycle by send_full_time_code)
+ */
 int
-Session::send_midi_time_code ()
-{
-       if (_mtc_port == 0 || !session_send_mtc || transmitting_smpte_time.negative || (next_quarter_frame_to_send < 0) )  {
+Session::send_midi_time_code_for_cycle(nframes_t nframes)
+{      
+       assert (next_quarter_frame_to_send >= 0);
+       assert (next_quarter_frame_to_send <= 7);
+       
+       if (_mtc_port == 0 || !session_send_mtc || transmitting_smpte_time.negative
+           /*|| (next_quarter_frame_to_send < 0)*/ ) {
+               // cerr << "(MTC) Not sending MTC\n";
                return 0;
        }
-
-       nframes_t two_smpte_frames_duration;
-       nframes_t quarter_frame_duration;
-
-       /* Duration of two smpte frames */
-       two_smpte_frames_duration = ((long) _frames_per_smpte_frame) << 1;
-
+       
        /* Duration of one quarter frame */
-       quarter_frame_duration = ((long) _frames_per_smpte_frame) >> 2;
-
-       while (_transport_frame >= (outbound_mtc_smpte_frame + (next_quarter_frame_to_send * quarter_frame_duration))) {
+       nframes_t quarter_frame_duration = ((long) _frames_per_smpte_frame) >> 2;
+       
+       // cerr << "(MTC) TR: " << _transport_frame << " - SF: " << outbound_mtc_smpte_frame
+       // << " - NQ: " << next_quarter_frame_to_send << " - FD" << quarter_frame_duration << endl;
+               
+       // FIXME: this should always be true
+       //assert((outbound_mtc_smpte_frame + (next_quarter_frame_to_send * quarter_frame_duration))
+       //              > _transport_frame);
 
-               // Send quarter frames up to current time
-               {
-                       Glib::Mutex::Lock lm (midi_lock);
+       
+       // Send quarter frames for this cycle
+       while (_transport_frame + nframes > (outbound_mtc_smpte_frame +
+                               (next_quarter_frame_to_send * quarter_frame_duration))) {
+               
+               // cerr << "(MTC) Next frame to send: " << next_quarter_frame_to_send << endl;
 
-                       switch(next_quarter_frame_to_send) {
+               switch (next_quarter_frame_to_send) {
                        case 0:
                                mtc_msg[1] =  0x00 | (transmitting_smpte_time.frames & 0xf);
                                break;
@@ -856,33 +796,49 @@ Session::send_midi_time_code ()
                        case 7:
                                mtc_msg[1] = 0x70 | (((mtc_smpte_bits|transmitting_smpte_time.hours) & 0xf0) >> 4);
                                break;
-                       }                       
-                       
-                       if (_mtc_port->midimsg (mtc_msg, 2)) {
-                               error << string_compose(_("Session: cannot send quarter-frame MTC message (%1)"), strerror (errno)) 
-                                     << endmsg;
-                               
-                               return -1;
-                       }
+               }                       
+               
+               const nframes_t msg_time = (outbound_mtc_smpte_frame
+                       + (quarter_frame_duration * next_quarter_frame_to_send));
+       
+               // This message must fall within this block or something is broken
+               assert(msg_time >= _transport_frame);
+               assert(msg_time < _transport_frame + nframes);
 
-                       //       cout << "smpte = " << transmitting_smpte_time.hours << ":" << transmitting_smpte_time.minutes << ":" << transmitting_smpte_time.seconds << ":" << transmitting_smpte_time.frames << ", qfm = " << next_quarter_frame_to_send << endl;
-
-                       // Increment quarter frame counter
-                       next_quarter_frame_to_send++;
-      
-                       if (next_quarter_frame_to_send >= 8) {
-                               // Wrap quarter frame counter
-                               next_quarter_frame_to_send = 0;
-                               // Increment smpte time twice
-                               SMPTE::increment( transmitting_smpte_time );
-                               SMPTE::increment( transmitting_smpte_time );        
-                               // Re-calculate timing of first quarter frame
-                               smpte_to_sample( transmitting_smpte_time, outbound_mtc_smpte_frame, true /* use_offset */, false );
-                               // Compensate for audio latency
-                               outbound_mtc_smpte_frame += _worst_output_latency;
-                       }
+               nframes_t out_stamp = msg_time - _transport_frame;
+               assert(out_stamp < nframes);
+
+               if (!_mtc_port->midimsg (mtc_msg, 2, out_stamp)) {
+                       error << string_compose(_("Session: cannot send quarter-frame MTC message (%1)"), strerror (errno)) 
+                               << endmsg;
+                       return -1;
+               }
+
+               /*cerr << "(MTC) SMPTE: " << transmitting_smpte_time.hours
+                       << ":" << transmitting_smpte_time.minutes
+                       << ":" << transmitting_smpte_time.seconds
+                       << ":" << transmitting_smpte_time.frames
+                       << ", qfm = " << next_quarter_frame_to_send
+                       << ", stamp = " << out_stamp
+                       << ", delta = " << _transport_frame + out_stamp - last_time << endl;*/
+               
+               // Increment quarter frame counter
+               next_quarter_frame_to_send++;
+
+               if (next_quarter_frame_to_send >= 8) {
+                       // Wrap quarter frame counter
+                       next_quarter_frame_to_send = 0;
+                       // Increment smpte time twice
+                       SMPTE::increment( transmitting_smpte_time );
+                       SMPTE::increment( transmitting_smpte_time );        
+                       // Re-calculate timing of first quarter frame
+                       //smpte_to_sample( transmitting_smpte_time, outbound_mtc_smpte_frame, true /* use_offset */, false );
+                       outbound_mtc_smpte_frame += 8 * quarter_frame_duration;
+                       // Compensate for audio latency
+                       outbound_mtc_smpte_frame += _worst_output_latency;
                }
        }
+
        return 0;
 }
 
@@ -890,24 +846,11 @@ Session::send_midi_time_code ()
  OUTBOUND MMC STUFF
 **********************************************************************/
 
-void
-Session::send_mmc_in_another_thread (MIDI::MachineControl::Command cmd, nframes_t target_frame)
-{
-       MIDIRequest* request;
-
-       if (_mtc_port == 0 || !session_send_mmc) {
-               return;
-       }
-
-       request = new MIDIRequest;
-       request->type = MIDIRequest::SendMMC;
-       request->mmc_cmd = cmd;
-       request->locate_frame = target_frame;
-
-       midi_requests.write (&request, 1);
-       poke_midi_thread ();
-}
-
+/** Send an MMC command at the given absolute timestamp (@a where).
+ *
+ * This must be called in the process thread, and @a where must fall within
+ * this process cycle or horrible things will happen.
+ */
 void
 Session::deliver_mmc (MIDI::MachineControl::Command cmd, nframes_t where)
 {
@@ -916,12 +859,13 @@ Session::deliver_mmc (MIDI::MachineControl::Command cmd, nframes_t where)
        SMPTE::Time smpte;
 
        if (_mmc_port == 0 || !session_send_mmc) {
+               //cerr << "Not delivering MMC " << _mmc_port << " - " << send_mmc << endl;
                return;
        }
 
        mmc_buffer[nbytes++] = cmd;
 
-       // cerr << "delivering MMC, cmd = " << hex << (int) cmd << dec << endl;
+       //cerr << "delivering MMC, cmd = " << hex << (int) cmd << dec << endl;
        
        switch (cmd) {
        case MachineControl::cmdLocate:
@@ -941,6 +885,7 @@ Session::deliver_mmc (MIDI::MachineControl::Command cmd, nframes_t where)
 
        case MachineControl::cmdPlay:
                /* always convert Play into Deferred Play */
+               /* Why? [DR] */
                mmc_buffer[4] = MachineControl::cmdDeferredPlay;
                break;
 
@@ -964,11 +909,13 @@ Session::deliver_mmc (MIDI::MachineControl::Command cmd, nframes_t where)
 
                mmc_buffer[nbytes++] = 0xf7; // terminate SysEx/MMC message
 
-               Glib::Mutex::Lock lm (midi_lock);
+               assert(where >= _transport_frame);
 
-               if (_mmc_port->write (mmc_buffer, nbytes) != nbytes) {
+               if (!_mmc_port->midimsg (mmc_buffer, sizeof (mmc_buffer), 0)) {
                        error << string_compose(_("MMC: cannot send command %1%2%3"), &hex, cmd, &dec) << endmsg;
-               }
+               } /*else {
+                       cerr << "Sending MMC\n";
+               }*/
        }
 }
 
@@ -1001,66 +948,6 @@ Session::mmc_step_timeout ()
        return true;
 }
 
-
-void
-Session::send_midi_message (MIDI::Port * port, MIDI::eventType ev, MIDI::channel_t ch, MIDI::EventTwoBytes data)
-{
-       // in another thread, really
-       
-       MIDIRequest* request = new MIDIRequest;
-
-       request->type = MIDIRequest::SendMessage;
-       request->port = port;
-       request->ev = ev;
-       request->chan = ch;
-       request->data = data;
-       
-       midi_requests.write (&request, 1);
-       poke_midi_thread ();
-}
-
-void
-Session::deliver_midi (MIDI::Port * port, MIDI::byte* buf, int32_t bufsize)
-{
-       // in another thread, really
-       
-       MIDIRequest* request = new MIDIRequest;
-
-       request->type = MIDIRequest::Deliver;
-       request->port = port;
-       request->buf = buf;
-       request->size = bufsize;
-       
-       midi_requests.write (&request, 1);
-       poke_midi_thread ();
-}
-
-void
-Session::deliver_midi_message (MIDI::Port * port, MIDI::eventType ev, MIDI::channel_t ch, MIDI::EventTwoBytes data)
-{
-       if (port == 0 || ev == MIDI::none) {
-               return;
-       }
-
-       midi_msg[0] = (ev & 0xF0) | (ch & 0xF); 
-       midi_msg[1] = data.controller_number;
-       midi_msg[2] = data.value;
-
-       port->write (midi_msg, 3);
-}
-
-void
-Session::deliver_data (MIDI::Port * port, MIDI::byte* buf, int32_t size)
-{
-       if (port) {
-               port->write (buf, size);
-       }
-
-       /* this is part of the semantics of the Deliver request */
-
-       delete [] buf;
-}
-
 /*---------------------------------------------------------------------------
   MIDI THREAD 
   ---------------------------------------------------------------------------*/
@@ -1088,8 +975,6 @@ Session::start_midi_thread ()
                return -1;
        }
 
-       // pthread_detach (midi_thread);
-
        return 0;
 }
 
@@ -1097,6 +982,7 @@ void
 Session::terminate_midi_thread ()
 {
        if (midi_thread) {
+
                MIDIRequest* request = new MIDIRequest;
                void* status;
                
@@ -1104,7 +990,7 @@ Session::terminate_midi_thread ()
                
                midi_requests.write (&request, 1);
                poke_midi_thread ();
-               
+
                pthread_join (midi_thread, &status);
        }
 }
@@ -1153,10 +1039,7 @@ Session::midi_thread_work ()
 
        /* set up the port vector; 4 is the largest possible size for now */
 
-       ports.push_back (0);
-       ports.push_back (0);
-       ports.push_back (0);
-       ports.push_back (0);
+       ports.assign (4, (MIDI::Port*) 0);
 
        while (1) {
 
@@ -1166,10 +1049,6 @@ Session::midi_thread_work ()
                pfd[nfds].events = POLLIN|POLLHUP|POLLERR;
                nfds++;
 
-               /* if we are using MMC control, we obviously have to listen
-                  on the appropriate port.
-               */
-
                if (Config->get_mmc_control() && _mmc_port && _mmc_port->selectable() >= 0) {
                        pfd[nfds].fd = _mmc_port->selectable();
                        pfd[nfds].events = POLLIN|POLLHUP|POLLERR;
@@ -1189,6 +1068,10 @@ Session::midi_thread_work ()
                        nfds++;
                }
 
+               /* if we are using MMC control, we obviously have to listen
+                  the relevant port.
+               */
+
                if (_midi_port && (_midi_port != _mmc_port || !Config->get_mmc_control()) && (_midi_port != _mtc_port) && _midi_port->selectable() >= 0) {
                        pfd[nfds].fd = _midi_port->selectable();
                        pfd[nfds].events = POLLIN|POLLHUP|POLLERR;
@@ -1217,7 +1100,6 @@ Session::midi_thread_work ()
                // cerr << "MIDI thread wakes at " << get_cycles () << endl;
 
                fds_ready = 0;
-               restart = false;
 
                /* check the transport request pipe */
 
@@ -1257,37 +1139,6 @@ Session::midi_thread_work ()
                        while (midi_requests.read (&request, 1) == 1) {
 
                                switch (request->type) {
-                                       
-                               case MIDIRequest::SendFullMTC:
-                                       // cerr << "send full MTC\n";
-                                       send_full_time_code ();
-                                       // cerr << "... done\n";
-                                       break;
-                                       
-                               case MIDIRequest::SendMTC:
-                                       // cerr << "send qtr MTC\n";
-                                       send_midi_time_code ();
-                                       // cerr << "... done\n";
-                                       break;
-                                       
-                               case MIDIRequest::SendMMC:
-                                       // cerr << "send MMC\n";
-                                       deliver_mmc (request->mmc_cmd, request->locate_frame);
-                                       // cerr << "... done\n";
-                                       break;
-
-                               case MIDIRequest::SendMessage:
-                                       // cerr << "send Message\n";
-                                       deliver_midi_message (request->port, request->ev, request->chan, request->data);
-                                       // cerr << "... done\n";
-                                       break;
-                                       
-                               case MIDIRequest::Deliver:
-                                       // cerr << "deliver\n";
-                                       deliver_data (_midi_port, request->buf, request->size);
-                                       // cerr << "... done\n";
-                                       break;
-                                               
                                case MIDIRequest::PortChange:
                                        /* restart poll with new ports */
                                        // cerr << "rebind\n";
@@ -1324,7 +1175,7 @@ Session::midi_thread_work ()
                        
                        if (pfd[p].revents & POLLIN) {
                                fds_ready++;
-                               midi_read (ports[p]);
+                               ports[p]->parse ();
                        }
                }