summaryrefslogtreecommitdiff
path: root/libs/ardour/ardour/port.h
blob: 5ac7cb90caceb679d5203ebf01bbe1a277e3725c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/*
    Copyright (C) 2009 Paul Davis 

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef __ardour_port_h__
#define __ardour_port_h__

#include <set>
#include <string>
#include <vector>
#include <jack/jack.h>
#include <boost/utility.hpp>
#include <sigc++/trackable.h>
#include "ardour/data_type.h"
#include "ardour/types.h"

namespace ARDOUR {

class AudioEngine;
class Buffer;	

class Port : public sigc::trackable, public boost::noncopyable
{
public:
	enum Flags {
		IsInput = JackPortIsInput,
		IsOutput = JackPortIsOutput,
	};

	virtual ~Port ();

	static nframes_t port_offset() { return _port_offset; }

	static void set_port_offset (nframes_t off) {
		_port_offset = off;
	}
	static void increment_port_offset (nframes_t n) {
		_port_offset += n;
	}
	static void set_buffer_size (nframes_t sz) {
		_buffer_size = sz;
	}

	/** @return Port short name */
	std::string name () const {
		return _name;
	}

	int set_name (std::string const &);

	/** @return flags */
	Flags flags () const {
		return _flags;
	}

	/** @return true if this Port receives input, otherwise false */
	bool receives_input () const {
		return _flags & IsInput;
	}

	/** @return true if this Port sends output, otherwise false */
	bool sends_output () const {
		return _flags & IsOutput;
	}

	bool connected () const;
	int disconnect_all ();
	int get_connections (std::vector<std::string> &) const;

	/* connection by name */
	bool connected_to (std::string const &) const;
	int connect (std::string const &);
	int disconnect (std::string const &);

	/* connection by Port* */
	bool connected_to (Port *) const;
	virtual int connect (Port *);
	int disconnect (Port *);

	void ensure_monitor_input (bool);
	bool monitoring_input () const;
	nframes_t total_latency () const;
	int reestablish ();
	int reconnect ();
	void request_monitor_input (bool);
	void set_latency (nframes_t);

	virtual void reset ();
	
	/** @return the size of the raw buffer (bytes) for duration @a nframes (audio frames) */
	virtual size_t raw_buffer_size(jack_nframes_t nframes) const = 0;

	virtual DataType type () const = 0;
	virtual void cycle_start (nframes_t) = 0;
	virtual void cycle_end (nframes_t) = 0;
	virtual void cycle_split () = 0;
	virtual Buffer& get_buffer (nframes_t nframes, nframes_t offset = 0) = 0;
	virtual void flush_buffers (nframes_t, nframes_t offset = 0) {
		(void) offset;
	}
	
	static void set_engine (AudioEngine *);

	sigc::signal<void, bool> MonitorInputChanged;

protected:
	
	Port (std::string const &, DataType, Flags);

	jack_port_t* _jack_port; ///< JACK port

	static nframes_t _port_offset;
	static nframes_t _buffer_size;

	static AudioEngine* _engine; ///< the AudioEngine

private:
	friend class AudioEngine;

	void recompute_total_latency () const;
	
	/* XXX */
	bool _last_monitor;

	std::string _name;  ///< port short name
	Flags       _flags; ///< flags

	/** ports that we are connected to, kept so that we can
	    reconnect to JACK when required */
	std::set<std::string> _connections;
};

}

#endif /* __ardour_port_h__ */