2 Copyright (C) 1998-2010 Paul Barton-Davis
3 This program is free software; you can redistribute it and/or modify
4 it under the terms of the GNU General Public License as published by
5 the Free Software Foundation; either version 2 of the License, or
6 (at your option) any later version.
8 This program is distributed in the hope that it will be useful,
9 but WITHOUT ANY WARRANTY; without even the implied warranty of
10 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 GNU General Public License for more details.
13 You should have received a copy of the GNU General Public License
14 along with this program; if not, write to the Free Software
15 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 #ifndef __libmidi_port_base_h__
20 #define __libmidi_port_base_h__
27 #include "pbd/xml++.h"
28 #ifndef PLATFORM_WINDOWS
29 #include "pbd/crossthread.h"
31 #include "pbd/signals.h"
32 #include "pbd/ringbuffer.h"
34 #include "midi++/libmidi_visibility.h"
35 #include "midi++/types.h"
36 #include "midi++/parser.h"
43 class LIBMIDIPP_API Port {
46 IsInput = 0x1, /* MUST MATCH JACK's JackPortIsInput */
47 IsOutput = 0x2, /* MUST MATCH JACK's JackPortIsOutput */
50 Port (std::string const &, Flags);
51 Port (const XMLNode&);
54 virtual XMLNode& get_state () const;
55 virtual void set_state (const XMLNode&);
57 /** Write a message to port.
58 * @param msg Raw MIDI message to send
59 * @param msglen Size of @a msg
60 * @param timestamp Time stamp in frames of this message (relative to cycle start)
61 * @return number of bytes successfully written
63 virtual int write (const byte *msg, size_t msglen, timestamp_t timestamp) = 0;
65 /** Read raw bytes from a port.
66 * @param buf memory to store read data in
67 * @param bufsize size of @a buf
68 * @return number of bytes successfully read, negative if error
70 virtual int read (byte *buf, size_t bufsize) = 0;
72 /** block until the output FIFO used by non-process threads
73 * is empty, checking every @a check_interval_usecs usecs
74 * for current status. Not to be called by a thread that
75 * executes any part of a JACK process callback (will
76 * simply return immediately in that situation).
78 virtual void drain (int /* check_interval_usecs */, int /* total_usecs_to_wait */) {}
80 /** Write a message to port.
81 * @return true on success.
82 * FIXME: describe semantics here
84 int midimsg (byte *msg, size_t len, timestamp_t timestamp) {
85 return !(write (msg, len, timestamp) == (int) len);
88 virtual void parse (framecnt_t timestamp) = 0;
90 bool clock (timestamp_t timestamp);
92 /* select(2)/poll(2)-based I/O */
94 /** Get the file descriptor for port.
95 * @return File descriptor, or -1 if not selectable.
97 virtual int selectable () const = 0;
99 Channel *channel (channel_t chn) {
100 return _channel[chn&0x7F];
107 const char *name () const { return _tagname.c_str(); }
108 bool ok () const { return _ok; }
110 virtual bool centrally_parsed() const;
111 void set_centrally_parsed (bool yn) { _centrally_parsed = yn; }
113 bool receives_input () const {
114 return _flags == IsInput;
117 bool sends_output () const {
118 return _flags == IsOutput;
125 Descriptor (const XMLNode&);
126 XMLNode& get_state();
129 static std::string state_node_name;
133 std::string _tagname;
134 Channel* _channel[16];
137 bool _centrally_parsed;
139 void init (std::string const &, Flags);
142 struct LIBMIDIPP_API PortSet {
143 PortSet (std::string str) : owner (str) { }
146 std::list<XMLNode> ports;
149 std::ostream & operator << (std::ostream& os, const Port& port);
153 #endif // __libmidi_port_base_h__