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__
25 #include <jack/types.h> /* XXX ... desirable to get rid of this but needed for
26 * now due to use of JackPortIsXXXX
31 #include "pbd/xml++.h"
32 #ifndef PLATFORM_WINDOWS
33 #include "pbd/crossthread.h"
35 #include "pbd/signals.h"
36 #include "pbd/ringbuffer.h"
38 #include "midi++/libmidi_visibility.h"
39 #include "midi++/types.h"
40 #include "midi++/parser.h"
47 class LIBMIDIPP_API Port {
50 IsInput = JackPortIsInput,
51 IsOutput = JackPortIsOutput,
54 Port (std::string const &, Flags);
55 Port (const XMLNode&);
58 virtual XMLNode& get_state () const;
59 virtual void set_state (const XMLNode&);
61 /** Write a message to port.
62 * @param msg Raw MIDI message to send
63 * @param msglen Size of @a msg
64 * @param timestamp Time stamp in frames of this message (relative to cycle start)
65 * @return number of bytes successfully written
67 virtual int write (const byte *msg, size_t msglen, timestamp_t timestamp) = 0;
69 /** Read raw bytes from a port.
70 * @param buf memory to store read data in
71 * @param bufsize size of @a buf
72 * @return number of bytes successfully read, negative if error
74 virtual int read (byte *buf, size_t bufsize) = 0;
76 /** block until the output FIFO used by non-process threads
77 * is empty, checking every @a check_interval_usecs usecs
78 * for current status. Not to be called by a thread that
79 * executes any part of a JACK process callback (will
80 * simply return immediately in that situation).
82 virtual void drain (int /* check_interval_usecs */) {}
84 /** Write a message to port.
85 * @return true on success.
86 * FIXME: describe semantics here
88 int midimsg (byte *msg, size_t len, timestamp_t timestamp) {
89 return !(write (msg, len, timestamp) == (int) len);
92 virtual void parse (framecnt_t timestamp) = 0;
94 bool clock (timestamp_t timestamp);
96 /* select(2)/poll(2)-based I/O */
98 /** Get the file descriptor for port.
99 * @return File descriptor, or -1 if not selectable.
101 virtual int selectable () const = 0;
103 Channel *channel (channel_t chn) {
104 return _channel[chn&0x7F];
111 const char *name () const { return _tagname.c_str(); }
112 bool ok () const { return _ok; }
114 virtual bool centrally_parsed() const;
115 void set_centrally_parsed (bool yn) { _centrally_parsed = yn; }
117 bool receives_input () const {
118 return _flags == IsInput;
121 bool sends_output () const {
122 return _flags == IsOutput;
129 Descriptor (const XMLNode&);
130 XMLNode& get_state();
133 static std::string state_node_name;
137 std::string _tagname;
138 Channel* _channel[16];
141 bool _centrally_parsed;
143 void init (std::string const &, Flags);
146 struct LIBMIDIPP_API PortSet {
147 PortSet (std::string str) : owner (str) { }
150 std::list<XMLNode> ports;
153 std::ostream & operator << (std::ostream& os, const Port& port);
157 #endif // __libmidi_port_base_h__