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_h__
20 #define __libmidi_port_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 Port (std::string const &, Flags, jack_client_t *);
51 Port (const XMLNode&, jack_client_t *);
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 void cycle_start(nframes_t nframes);
61 /* Only for use by MidiManager. Don't ever call this. */
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 int write (byte *msg, size_t msglen, timestamp_t timestamp);
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 int read (byte *buf, size_t bufsize);
79 void parse (nframes_t timestamp);
81 /** Write a message to port.
82 * @return true on success.
83 * FIXME: describe semantics here
85 int midimsg (byte *msg, size_t len, timestamp_t timestamp) {
86 return !(write (msg, len, timestamp) == (int) len);
89 bool clock (timestamp_t timestamp);
91 /* select(2)/poll(2)-based I/O */
93 /** Get the file descriptor for port.
94 * @return File descriptor, or -1 if not selectable.
96 int selectable () const {
97 return xthread.selectable();
100 Channel *channel (channel_t chn) {
101 return _channel[chn&0x7F];
108 const char *name () const { return _tagname.c_str(); }
109 bool ok () const { return _ok; }
111 bool receives_input () const {
112 return _flags == IsInput;
115 bool sends_output () const {
116 return _flags == IsOutput;
123 Descriptor (const XMLNode&);
124 XMLNode& get_state();
127 nframes_t nframes_this_cycle() const { return _nframes_this_cycle; }
129 void reestablish (jack_client_t *);
132 static void set_process_thread (pthread_t);
133 static pthread_t get_process_thread () { return _process_thread; }
134 static bool is_process_thread();
136 static std::string state_node_name;
138 static PBD::Signal0<void> MakeConnections;
139 static PBD::Signal0<void> JackHalted;
143 bool _currently_in_cycle;
144 nframes_t _nframes_this_cycle;
145 std::string _tagname;
147 Channel *_channel[16];
152 jack_client_t* _jack_client;
153 jack_port_t* _jack_port;
154 nframes_t _last_read_index;
155 timestamp_t _last_write_timestamp;
157 /** Channel used to signal to the MidiControlUI that input has arrived */
158 CrossThreadChannel xthread;
160 std::string _connections;
161 PBD::ScopedConnection connect_connection;
162 PBD::ScopedConnection halt_connection;
163 void flush (void* jack_port_buffer);
165 void make_connections ();
166 void init (std::string const &, Flags);
168 static pthread_t _process_thread;
170 RingBuffer< Evoral::Event<double> > output_fifo;
171 Evoral::EventRingBuffer<timestamp_t> input_fifo;
173 Glib::Mutex output_fifo_lock;
179 PortSet (std::string str) : owner (str) { }
182 std::list<XMLNode> ports;
185 std::ostream & operator << ( std::ostream & os, const Port & port );
189 #endif // __libmidi_port_h__