libs/surfaces/mackie/surface_port.cc

   1 /*
   2         Copyright (C) 2006,2007 John Anderson
   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 #include <sstream>
  20 #include <cstring>
  21 #include <cerrno>
  22
  23 #include <sigc++/sigc++.h>
  24 #include <boost/shared_array.hpp>
  25
  26 #include "pbd/failed_constructor.h"
  27
  28 #include "midi++/types.h"
  29 #include "midi++/ipmidi_port.h"
  30
  31 #include "ardour/async_midi_port.h"
  32 #include "ardour/debug.h"
  33 #include "ardour/rc_configuration.h"
  34 #include "ardour/session.h"
  35 #include "ardour/audioengine.h"
  36 #include "ardour/async_midi_port.h"
  37 #include "ardour/midiport_manager.h"
  38
  39 #include "controls.h"
  40 #include "mackie_control_protocol.h"
  41 #include "surface.h"
  42 #include "surface_port.h"
  43
  44 #include "i18n.h"
  45
  46 using namespace std;
  47 using namespace PBD;
  48 using namespace ARDOUR;
  49 using namespace ArdourSurface;
  50 using namespace Mackie;
  51
  52 SurfacePort::SurfacePort (Surface& s)
  53         : _surface (&s)
  54 {
  55         if (_surface->mcp().device_info().uses_ipmidi()) {
  56                 _input_port = new MIDI::IPMIDIPort (_surface->mcp().ipmidi_base() +_surface->number());
  57                 _output_port = _input_port;
  58
  59         } else {
  60
  61                 _async_in  = AudioEngine::instance()->register_input_port (DataType::MIDI, string_compose (_("%1 in"),  _surface->name()), true);
  62                 _async_out = AudioEngine::instance()->register_output_port (DataType::MIDI, string_compose (_("%1 out"),  _surface->name()), true);
  63
  64                 if (_async_in == 0 || _async_out == 0) {
  65                         throw failed_constructor();
  66                 }
  67
  68                 _input_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(_async_in).get();
  69                 _output_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(_async_out).get();
  70         }
  71 }
  72
  73 SurfacePort::~SurfacePort()
  74 {
  75         if (dynamic_cast<MIDI::IPMIDIPort*>(_input_port)) {
  76                 delete _input_port;
  77                 _input_port = 0;
  78         } else {
  79                 if (_async_in) {
  80                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("unregistering input port %1\n", _async_in->name()));
  81                         AudioEngine::instance()->unregister_port (_async_in);
  82                         _async_in.reset ((ARDOUR::Port*) 0);
  83                 }
  84
  85                 if (_async_out) {
  86                         _output_port->drain (10000);
  87                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("unregistering output port %1\n", _async_out->name()));
  88                         AudioEngine::instance()->unregister_port (_async_out);
  89                         _async_out.reset ((ARDOUR::Port*) 0);
  90                 }
  91         }
  92 }
  93
  94 XMLNode&
  95 SurfacePort::get_state ()
  96 {
  97         XMLNode* node = new XMLNode (X_("Port"));
  98
  99         if (dynamic_cast<MIDI::IPMIDIPort*>(_input_port)) {
 100                 /* no state required for IPMidi ports */
 101                 return *node;
 102         }
 103
 104         XMLNode* child;
 105
 106         child = new XMLNode (X_("Input"));
 107         child->add_child_nocopy (_async_in->get_state());
 108         node->add_child_nocopy (*child);
 109
 110
 111         child = new XMLNode (X_("Output"));
 112         child->add_child_nocopy (_async_out->get_state());
 113         node->add_child_nocopy (*child);
 114
 115         return *node;
 116 }
 117
 118 int
 119 SurfacePort::set_state (const XMLNode& node, int version)
 120 {
 121         if (dynamic_cast<MIDI::IPMIDIPort*>(_input_port)) {
 122                 return 0;
 123         }
 124         // the rest should not be run if the device-name changes outside of a session load.
 125         if ( _surface->mcp().session_load()) {
 126
 127                 XMLNode* child;
 128
 129                 if ((child = node.child (X_("Input"))) != 0) {
 130                         XMLNode* portnode = child->child (Port::state_node_name.c_str());
 131                         if (portnode) {
 132                                 _async_in->set_state (*portnode, version);
 133                         }
 134                 }
 135
 136                 if ((child = node.child (X_("Output"))) != 0) {
 137                         XMLNode* portnode = child->child (Port::state_node_name.c_str());
 138                         if (portnode) {
 139                                 _async_out->set_state (*portnode, version);
 140                         }
 141                 }
 142         }
 143
 144         return 0;
 145 }
 146
 147 std::string
 148 SurfacePort::input_name () const
 149 {
 150         return _async_in->name();
 151 }
 152
 153 std::string
 154 SurfacePort::output_name () const
 155 {
 156         return _async_out->name();
 157 }
 158
 159 // wrapper for one day when strerror_r is working properly
 160 string fetch_errmsg (int error_number)
 161 {
 162         char * msg = strerror (error_number);
 163         return msg;
 164 }
 165
 166 int
 167 SurfacePort::write (const MidiByteArray & mba)
 168 {
 169         if (mba.empty()) {
 170                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("port %1 asked to write an empty MBA\n", output_port().name()));
 171                 return 0;
 172         }
 173
 174         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("port %1 write %2\n", output_port().name(), mba));
 175
 176         if (mba[0] != 0xf0 && mba.size() > 3) {
 177                 std::cerr << "TOO LONG WRITE: " << mba << std::endl;
 178         }
 179
 180         /* this call relies on std::vector<T> using contiguous storage. not
 181          * actually guaranteed by the standard, but way, way beyond likely.
 182          */
 183
 184         int count = output_port().write (&mba[0], mba.size(), 0);
 185
 186         if  (count != (int) mba.size()) {
 187
 188                 if (errno == 0) {
 189
 190                         cout << "port overflow on " << output_port().name() << ". Did not write all of " << mba << endl;
 191
 192                 } else if  (errno != EAGAIN) {
 193                         ostringstream os;
 194                         os << "Surface: couldn't write to port " << output_port().name();
 195                         os << ", error: " << fetch_errmsg (errno) << "(" << errno << ")";
 196                         cout << os.str() << endl;
 197                 }
 198
 199                 return -1;
 200         }
 201
 202         return 0;
 203 }
 204
 205 ostream &
 206 Mackie::operator <<  (ostream & os, const SurfacePort & port)
 207 {
 208         os << "{ ";
 209         os << "name: " << port.input_port().name() << " " << port.output_port().name();
 210         os << "; ";
 211         os << " }";
 212         return os;
 213 }
 214