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>
27 #include "pbd/xml++.h"
28 #include "pbd/crossthread.h"
29 #include "pbd/signals.h"
30 #include "pbd/ringbuffer.h"
32 #include "evoral/Event.hpp"
33 #include "evoral/EventRingBuffer.hpp"
35 #include "midi++/types.h"
36 #include "midi++/parser.h"
46 IsInput = JackPortIsInput,
47 IsOutput = JackPortIsOutput,
50 PortBase (std::string const &, Flags);
51 PortBase (const XMLNode&);
54 XMLNode& get_state () const;
55 void set_state (const XMLNode&);
57 // FIXME: make Manager a friend of port so these can be hidden?
59 /* Only for use by MidiManager. Don't ever call this. */
60 virtual void cycle_start (pframes_t nframes) {}
61 /* Only for use by MidiManager. Don't ever call this. */
62 virtual void cycle_end () {}
64 /** Write a message to port.
65 * @param msg Raw MIDI message to send
66 * @param msglen Size of @a msg
67 * @param timestamp Time stamp in frames of this message (relative to cycle start)
68 * @return number of bytes successfully written
70 virtual int write (byte *msg, size_t msglen, timestamp_t timestamp) = 0;
72 /** Read raw bytes from a port.
73 * @param buf memory to store read data in
74 * @param bufsize size of @a buf
75 * @return number of bytes successfully read, negative if error
77 virtual int read (byte *buf, size_t bufsize) = 0;
79 /** block until the output FIFO used by non-process threads
80 * is empty, checking every @a check_interval_usecs usecs
81 * for current status. Not to be called by a thread that
82 * executes any part of a JACK process callback (will
83 * simply return immediately in that situation).
85 virtual void drain (int check_interval_usecs) {}
87 /** Write a message to port.
88 * @return true on success.
89 * FIXME: describe semantics here
91 int midimsg (byte *msg, size_t len, timestamp_t timestamp) {
92 return !(write (msg, len, timestamp) == (int) len);
95 bool clock (timestamp_t timestamp);
97 /* select(2)/poll(2)-based I/O */
99 /** Get the file descriptor for port.
100 * @return File descriptor, or -1 if not selectable.
102 virtual int selectable () const = 0;
104 Channel *channel (channel_t chn) {
105 return _channel[chn&0x7F];
112 const char *name () const { return _tagname.c_str(); }
113 bool ok () const { return _ok; }
115 virtual bool centrally_parsed() const;
116 void set_centrally_parsed (bool yn) { _centrally_parsed = yn; }
118 bool receives_input () const {
119 return _flags == IsInput;
122 bool sends_output () const {
123 return _flags == IsOutput;
130 Descriptor (const XMLNode&);
131 XMLNode& get_state();
134 static std::string state_node_name;
138 std::string _tagname;
139 Channel* _channel[16];
142 bool _centrally_parsed;
144 virtual void init (std::string const &, Flags);
148 PortSet (std::string str) : owner (str) { }
151 std::list<XMLNode> ports;
154 std::ostream & operator << (std::ostream& os, const PortBase& port);
158 #endif // __libmidi_port_base_h__