remove misleading + incorrect documentation
[ardour.git] / 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 "midi++/types.h"
27 #include "midi++/ipmidi_port.h"
28
29 #include "ardour/async_midi_port.h"
30 #include "ardour/debug.h"
31 #include "ardour/rc_configuration.h"
32 #include "ardour/session.h"
33 #include "ardour/audioengine.h"
34 #include "ardour/async_midi_port.h"
35 #include "ardour/midiport_manager.h"
36
37 #include "controls.h"
38 #include "mackie_control_protocol.h"
39 #include "surface.h"
40 #include "surface_port.h"
41
42 #include "i18n.h"
43
44 using namespace std;
45 using namespace Mackie;
46 using namespace PBD;
47 using namespace ARDOUR;
48
49 SurfacePort::SurfacePort (Surface& s)
50         : _surface (&s)
51 {
52         if (_surface->mcp().device_info().uses_ipmidi()) {
53                 _input_port = new MIDI::IPMIDIPort (_surface->mcp().ipmidi_base() +_surface->number());
54                 _output_port = _input_port;
55         } else {
56                 _async_in  = AudioEngine::instance()->register_input_port (DataType::MIDI, string_compose (_("%1 in"),  _surface->name()), true);
57                 _async_out = AudioEngine::instance()->register_output_port (DataType::MIDI, string_compose (_("%1 out"),  _surface->name()), true);
58
59                 _input_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(_async_in).get();
60                 _output_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(_async_out).get();
61         }
62 }
63
64 SurfacePort::~SurfacePort()
65 {
66         if (_surface->mcp().device_info().uses_ipmidi()) {
67                 delete _input_port;
68         } else {
69
70                 if (_async_in) {
71                         AudioEngine::instance()->unregister_port (_async_in);
72                         _async_in.reset ();
73                 }
74                 
75                 if (_async_out) {
76                         _output_port->drain (10000);
77                         AudioEngine::instance()->unregister_port (_async_out);
78                         _async_out.reset ();
79                 }
80         }
81 }
82
83 // wrapper for one day when strerror_r is working properly
84 string fetch_errmsg (int error_number)
85 {
86         char * msg = strerror (error_number);
87         return msg;
88 }
89         
90 int 
91 SurfacePort::write (const MidiByteArray & mba)
92 {
93         if (mba.empty()) {
94                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("port %1 asked to write an empty MBA\n", output_port().name()));
95                 return 0;
96         }
97
98         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("port %1 write %2\n", output_port().name(), mba));
99
100         if (mba[0] != 0xf0 && mba.size() > 3) {
101                 std::cerr << "TOO LONG WRITE: " << mba << std::endl;
102         }
103                 
104         /* this call relies on std::vector<T> using contiguous storage. not
105          * actually guaranteed by the standard, but way, way beyond likely.
106          */
107
108         int count = output_port().write (&mba[0], mba.size(), 0);
109
110         if  (count != (int) mba.size()) {
111
112                 if (errno == 0) {
113
114                         cout << "port overflow on " << output_port().name() << ". Did not write all of " << mba << endl;
115
116                 } else if  (errno != EAGAIN) {
117                         ostringstream os;
118                         os << "Surface: couldn't write to port " << output_port().name();
119                         os << ", error: " << fetch_errmsg (errno) << "(" << errno << ")";
120                         cout << os.str() << endl;
121                 }
122
123                 return -1;
124         }
125
126         return 0;
127 }
128
129 ostream & 
130 Mackie::operator <<  (ostream & os, const SurfacePort & port)
131 {
132         os << "{ ";
133         os << "name: " << port.input_port().name() << " " << port.output_port().name();
134         os << "; ";
135         os << " }";
136         return os;
137 }
138