midnam test: don't clutter up output.
[ardour.git] / libs / midi++2 / port.cc
index c2fd4c99e2e9b346beb529d8f395662d1bcfe4c2..90ec260eae1cb8822a0e12f2bfdbb66d715d2275 100644 (file)
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
+    $Id: port.cc 11871 2012-04-10 16:27:01Z paul $
 */
 #include <iostream>
 #include <cstdio>
 #include <fcntl.h>
 #include <errno.h>
 
-#include <jack/jack.h>
-#include <jack/midiport.h>
-
 #include "pbd/xml++.h"
 #include "pbd/error.h"
 #include "pbd/failed_constructor.h"
 #include "pbd/convert.h"
 #include "pbd/strsplit.h"
+#include "pbd/stacktrace.h"
 
 #include "midi++/types.h"
 #include "midi++/port.h"
@@ -39,147 +37,50 @@ using namespace MIDI;
 using namespace std;
 using namespace PBD;
 
-size_t Port::nports = 0;
-pthread_t Port::_process_thread;
-Signal0<void> Port::JackHalted;
-Signal0<void> Port::MakeConnections;
-
-Port::Port (string const & name, int mode, jack_client_t* jack_client)
-       : _currently_in_cycle (false)
-       , _nframes_this_cycle (0)
-       , _jack_client (jack_client)
-       , _jack_input_port (0)
-       , _jack_output_port (0)
-       , _last_read_index (0)
-       , output_fifo (512)
-       , input_fifo (1024)
+string Port::state_node_name = "MIDI-port";
+
+Port::Port (string const & name, Flags flags)
+       : _flags (flags)
+       , _centrally_parsed (true)
 {
-       init (name, mode);
+       init (name, flags);
 }
 
-Port::Port (const XMLNode& node, jack_client_t* jack_client)
-       : _currently_in_cycle (false)
-       , _nframes_this_cycle (0)
-       , _jack_client (jack_client)
-       , _jack_input_port (0)
-       , _jack_output_port (0)
-       , _last_read_index (0)
-       , output_fifo (512)
-       , input_fifo (1024)
+Port::Port (const XMLNode& node)
+       : _centrally_parsed (true)
 {
        Descriptor desc (node);
 
-       init (desc.tag, desc.mode);
+       init (desc.tag, desc.flags);
 
-       set_state (node);
+       /* derived class must call ::set_state() */
 }
 
 void
-Port::init (string const & name, int mode)
+Port::init (string const & name, Flags flags)
 {
        _ok = false;  /* derived class must set to true if constructor
                         succeeds.
                      */
 
-       input_parser = 0;
-       output_parser = 0;
+       _parser = 0;
 
        _tagname = name;
-       _mode = mode;
-
-       if (_mode == O_RDONLY || _mode == O_RDWR) {
-               input_parser = new Parser (*this);
-       } else {
-               input_parser = 0;
-       }
+       _flags = flags;
 
-       if (_mode == O_WRONLY || _mode == O_RDWR) {
-               output_parser = new Parser (*this);
-       } else {
-               output_parser = 0;
-       }
+       _parser = new Parser ();
 
        for (int i = 0; i < 16; i++) {
-               _channel[i] =  new Channel (i, *this);
-
-               if (input_parser) {
-                       _channel[i]->connect_input_signals ();
-               }
-
-               if (output_parser) {
-                       _channel[i]->connect_output_signals ();
-               }
+               _channel[i] = new Channel (i, *this);
+               _channel[i]->connect_signals ();
        }
-
-       create_port_names ();
-       
-       if (!create_ports ()) {
-               _ok = true;
-       }
-
-       MakeConnections.connect_same_thread (connect_connection, boost::bind (&Port::make_connections, this));
-       JackHalted.connect_same_thread (halt_connection, boost::bind (&Port::jack_halted, this));
 }
 
-
 Port::~Port ()
 {
        for (int i = 0; i < 16; i++) {
                delete _channel[i];
        }
-
-       if (_jack_input_port) {
-               if (_jack_client && _jack_input_port) {
-                       jack_port_unregister (_jack_client, _jack_input_port);
-               }
-               _jack_input_port = 0;
-       }
-
-       if (_jack_output_port) {
-               if (_jack_client && _jack_output_port) {
-                       jack_port_unregister (_jack_client, _jack_output_port);
-               }
-               _jack_output_port = 0;
-       }
-}
-
-void
-Port::parse (nframes_t timestamp)
-{
-       byte buf[512];
-
-       /* NOTE: parsing is done (if at all) by initiating a read from 
-          the port. Each port implementation calls on the parser
-          once it has data ready.
-       */
-       
-       if (input_parser) {
-               input_parser->set_timestamp (timestamp);
-       }
-
-       while (1) {
-               
-               // cerr << "+++ READ ON " << name() << endl;
-
-               int nread = read (buf, sizeof (buf));
-
-               // cerr << "-- READ (" << nread << " ON " << 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 << "Error reading from MIDI port " << name() << endmsg;
-                       /*NOTREACHED*/
-               }
-       }
 }
 
 /** Send a clock tick message.
@@ -190,68 +91,19 @@ Port::clock (timestamp_t timestamp)
 {
        static byte clockmsg = 0xf8;
        
-       if (_mode != O_RDONLY) {
+       if (sends_output()) {
                return midimsg (&clockmsg, 1, timestamp);
        }
        
        return false;
 }
 
-void
-Port::cycle_start (nframes_t nframes)
-{
-       _currently_in_cycle = true;
-       _nframes_this_cycle = nframes;
-
-       assert(_nframes_this_cycle == nframes);
-       _last_read_index = 0;
-       _last_write_timestamp = 0;
-
-       if (_jack_output_port != 0) {
-               // output
-               void *buffer = jack_port_get_buffer (_jack_output_port, nframes);
-               jack_midi_clear_buffer (buffer);
-               flush (buffer); 
-       }
-       
-       if (_jack_input_port != 0) {
-               // input
-               void* jack_buffer = jack_port_get_buffer(_jack_input_port, nframes);
-               const nframes_t event_count = jack_midi_get_event_count(jack_buffer);
-
-               jack_midi_event_t ev;
-               timestamp_t cycle_start_frame = jack_last_frame_time (_jack_client);
-
-               for (nframes_t i = 0; i < event_count; ++i) {
-                       jack_midi_event_get (&ev, jack_buffer, i);
-                       input_fifo.write (cycle_start_frame + ev.time, (Evoral::EventType) 0, ev.size, ev.buffer);
-               }       
-               
-               if (event_count) {
-                       xthread.wakeup ();
-               }
-       }
-}
-
-void
-Port::cycle_end ()
-{
-       if (_jack_output_port != 0) {
-               flush (jack_port_get_buffer (_jack_output_port, _nframes_this_cycle));
-       }
-
-       _currently_in_cycle = false;
-       _nframes_this_cycle = 0;
-}
-
 std::ostream & MIDI::operator << ( std::ostream & os, const MIDI::Port & port )
 {
        using namespace std;
        os << "MIDI::Port { ";
        os << "name: " << port.name();
        os << "; ";
-       os << "mode: " << port.mode();
-       os << "; ";
        os << "ok: " << port.ok();
        os << "; ";
        os << " }";
@@ -271,12 +123,10 @@ Port::Descriptor::Descriptor (const XMLNode& node)
 
        if ((prop = node.property ("mode")) != 0) {
 
-               mode = O_RDWR;
-
                if (strings_equal_ignore_case (prop->value(), "output") || strings_equal_ignore_case (prop->value(), "out")) {
-                       mode = O_WRONLY;
+                       flags = IsOutput;
                } else if (strings_equal_ignore_case (prop->value(), "input") || strings_equal_ignore_case (prop->value(), "in")) {
-                       mode = O_RDONLY;
+                       flags = IsInput;
                }
 
                have_mode = true;
@@ -287,202 +137,16 @@ Port::Descriptor::Descriptor (const XMLNode& node)
        }
 }
 
-void
-Port::jack_halted ()
-{
-       _jack_client = 0;
-       _jack_input_port = 0;
-       _jack_output_port = 0;
-}
-
-int
-Port::write(byte * msg, size_t msglen, timestamp_t timestamp)
-{
-       int ret = 0;
-
-       if (!_jack_output_port) {
-               return ret;
-       }
-       
-       if (!is_process_thread()) {
-
-               Glib::Mutex::Lock lm (output_fifo_lock);
-               RingBuffer< Evoral::Event<double> >::rw_vector vec = { { 0, 0 }, { 0, 0} };
-               
-               output_fifo.get_write_vector (&vec);
-
-               if (vec.len[0] + vec.len[1] < 1) {
-                       error << "no space in FIFO for non-process thread MIDI write" << endmsg;
-                       return 0;
-               }
-
-               if (vec.len[0]) {
-                        if (!vec.buf[0]->owns_buffer()) {
-                                vec.buf[0]->set_buffer (0, 0, true);
-                        }
-                       vec.buf[0]->set (msg, msglen, timestamp);
-               } else {
-                        if (!vec.buf[1]->owns_buffer()) {
-                                vec.buf[1]->set_buffer (0, 0, true);
-                        }
-                       vec.buf[1]->set (msg, msglen, timestamp);
-               }
-
-               output_fifo.increment_write_idx (1);
-               
-               ret = msglen;
-
-       } else {
-
-               // XXX This had to be temporarily commented out to make export work again
-               if (!(timestamp < _nframes_this_cycle)) {
-                       std::cerr << "assertion timestamp < _nframes_this_cycle failed!" << std::endl;
-               }
-
-               if (_currently_in_cycle) {
-                       if (timestamp == 0) {
-                               timestamp = _last_write_timestamp;
-                       } 
-
-                       if (jack_midi_event_write (jack_port_get_buffer (_jack_output_port, _nframes_this_cycle), 
-                                               timestamp, msg, msglen) == 0) {
-                               ret = msglen;
-                               _last_write_timestamp = timestamp;
-
-                       } else {
-                               ret = 0;
-                               cerr << "write of " << msglen << " failed, port holds "
-                                       << jack_midi_get_event_count (jack_port_get_buffer (_jack_output_port, _nframes_this_cycle))
-                                       << endl;
-                       }
-               } else {
-                       cerr << "write to JACK midi port failed: not currently in a process cycle." << endl;
-               }
-       }
-
-       if (ret > 0 && output_parser) {
-               // ardour doesn't care about this and neither should your app, probably
-               // output_parser->raw_preparse (*output_parser, msg, ret);
-               for (int i = 0; i < ret; i++) {
-                       output_parser->scanner (msg[i]);
-               }
-               // ardour doesn't care about this and neither should your app, probably
-               // output_parser->raw_postparse (*output_parser, msg, ret);
-       }       
-
-       return ret;
-}
-
-void
-Port::flush (void* jack_port_buffer)
-{
-       RingBuffer< Evoral::Event<double> >::rw_vector vec = { { 0, 0 }, { 0, 0 } };
-       size_t written;
-
-       output_fifo.get_read_vector (&vec);
-
-       if (vec.len[0] + vec.len[1]) {
-               // cerr << "Flush " << vec.len[0] + vec.len[1] << " events from non-process FIFO\n";
-       }
-
-       if (vec.len[0]) {
-               Evoral::Event<double>* evp = vec.buf[0];
-               
-               for (size_t n = 0; n < vec.len[0]; ++n, ++evp) {
-                       jack_midi_event_write (jack_port_buffer,
-                                              (timestamp_t) evp->time(), evp->buffer(), evp->size());
-               }
-       }
-       
-       if (vec.len[1]) {
-               Evoral::Event<double>* evp = vec.buf[1];
-
-               for (size_t n = 0; n < vec.len[1]; ++n, ++evp) {
-                       jack_midi_event_write (jack_port_buffer,
-                                              (timestamp_t) evp->time(), evp->buffer(), evp->size());
-               }
-       }
-       
-       if ((written = vec.len[0] + vec.len[1]) != 0) {
-               output_fifo.increment_read_idx (written);
-       }
-}
-
-int
-Port::read (byte *, size_t)
-{
-       timestamp_t time;
-       Evoral::EventType type;
-       uint32_t size;
-       byte buffer[input_fifo.capacity()];
-
-       while (input_fifo.read (&time, &type, &size, buffer)) {
-               if (input_parser) {
-                       input_parser->set_timestamp (time);
-                       for (uint32_t i = 0; i < size; ++i) {
-                               input_parser->scanner (buffer[i]);
-                       }
-               }
-       }
-
-       return 0;
-}
-
-void
-Port::create_port_names ()
-{
-       assert(!_jack_input_port);
-       assert(!_jack_output_port);
-       
-       if (_mode == O_RDWR || _mode == O_WRONLY) {
-               _jack_output_port_name = _tagname.append ("_out");
-       }
-
-       if (_mode == O_RDWR || _mode == O_RDONLY) {
-               _jack_input_port_name = _tagname.append ("_in");
-       }
-}
-
-int
-Port::create_ports ()
-{
-       bool ret = true;
-
-       jack_nframes_t nframes = jack_get_buffer_size(_jack_client);
-
-       if (!_jack_output_port_name.empty()) {
-               _jack_output_port = jack_port_register(_jack_client, _jack_output_port_name.c_str(),
-                                                      JACK_DEFAULT_MIDI_TYPE, JackPortIsOutput, 0);
-               if (_jack_output_port) {
-                       jack_midi_clear_buffer(jack_port_get_buffer(_jack_output_port, nframes));
-               }
-               ret = ret && (_jack_output_port != NULL);
-       }
-       
-       if (!_jack_input_port_name.empty()) {
-               _jack_input_port = jack_port_register(_jack_client, _jack_input_port_name.c_str(),
-                                                     JACK_DEFAULT_MIDI_TYPE, JackPortIsInput, 0);
-               if (_jack_input_port) {
-                       jack_midi_clear_buffer(jack_port_get_buffer(_jack_input_port, nframes));
-               }
-               ret = ret && (_jack_input_port != NULL);
-       }
-
-       return ret ? 0 : -1;
-}
-
 XMLNode& 
 Port::get_state () const
 {
-       XMLNode* root = new XMLNode ("MIDI-port");
+       XMLNode* root = new XMLNode (state_node_name);
        root->add_property ("tag", _tagname);
 
-       if (_mode == O_RDONLY) {
+       if (_flags == IsInput) {
                root->add_property ("mode", "input");
-       } else if (_mode == O_WRONLY) {
-               root->add_property ("mode", "output");
        } else {
-               root->add_property ("mode", "duplex");
+               root->add_property ("mode", "output");
        }
        
 #if 0
@@ -498,52 +162,6 @@ Port::get_state () const
        write (device_inquiry, sizeof (device_inquiry), 0);
 #endif
 
-       if (_jack_output_port) {
-               
-               const char** jc = jack_port_get_connections (_jack_output_port);
-               string connection_string;
-               if (jc) {
-                       for (int i = 0; jc[i]; ++i) {
-                               if (i > 0) {
-                                       connection_string += ',';
-                               }
-                               connection_string += jc[i];
-                       }
-                       free (jc);
-               }
-               
-               if (!connection_string.empty()) {
-                       root->add_property ("outbound", connection_string);
-               }
-       } else {
-               if (!_outbound_connections.empty()) {
-                       root->add_property ("outbound", _outbound_connections);
-               }
-       }
-
-       if (_jack_input_port) {
-
-               const char** jc = jack_port_get_connections (_jack_input_port);
-               string connection_string;
-               if (jc) {
-                       for (int i = 0; jc[i]; ++i) {
-                               if (i > 0) {
-                                       connection_string += ',';
-                               }
-                               connection_string += jc[i];
-                       }
-                       free (jc);
-               }
-
-               if (!connection_string.empty()) {
-                       root->add_property ("inbound", connection_string);
-               }
-       } else {
-               if (!_inbound_connections.empty()) {
-                       root->add_property ("inbound", _inbound_connections);
-               }
-       }
-
        return *root;
 }
 
@@ -552,67 +170,13 @@ Port::set_state (const XMLNode& node)
 {
        const XMLProperty* prop;
 
-       if ((prop = node.property ("inbound")) != 0 && _jack_input_port) {
-               _inbound_connections = prop->value ();
-       }
-
-       if ((prop = node.property ("outbound")) != 0 && _jack_output_port) {
-               _outbound_connections = prop->value();
-       }
-}
-
-void
-Port::make_connections ()
-{
-       if (!_inbound_connections.empty()) {
-               vector<string> ports;
-               split (_inbound_connections, ports, ',');
-               for (vector<string>::iterator x = ports.begin(); x != ports.end(); ++x) {
-                       if (_jack_client) {
-                               jack_connect (_jack_client, (*x).c_str(), jack_port_name (_jack_input_port));
-                               /* ignore failures */
-                       }
-               }
-       }
-
-       if (!_outbound_connections.empty()) {
-               vector<string> ports;
-               split (_outbound_connections, ports, ',');
-               for (vector<string>::iterator x = ports.begin(); x != ports.end(); ++x) {
-                       if (_jack_client) {
-                               jack_connect (_jack_client, jack_port_name (_jack_output_port), (*x).c_str());
-                               /* ignore failures */
-                       }
-               }
+       if ((prop = node.property ("tag")) == 0 || prop->value() != _tagname) {
+               return;
        }
-       connect_connection.disconnect ();
-}
-
-void
-Port::set_process_thread (pthread_t thr)
-{
-       _process_thread = thr;
 }
 
 bool
-Port::is_process_thread()
-{
-       return (pthread_self() == _process_thread);
-}
-
-void
-Port::reestablish (void* jack)
-{
-       _jack_client = static_cast<jack_client_t*> (jack);
-       int const r = create_ports ();
-
-       if (r) {
-               PBD::error << "could not reregister ports for " << name() << endmsg;
-       }
-}
-
-void
-Port::reconnect ()
+Port::centrally_parsed() const
 {
-       make_connections ();
+       return _centrally_parsed;
 }