summaryrefslogtreecommitdiff
path: root/libs/ardour/ardour/port.h
blob: cf62429db30a4946e8e7ef2ba4a3632a8a12cdde (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
/*
    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 "ardour/data_type.h"
#include "ardour/types.h"
#include <sigc++/trackable.h>
#include <jack/jack.h>
#include <string>
#include <set>
#include <vector>

namespace ARDOUR {

class AudioEngine;
class Buffer;	

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

	virtual ~Port ();

	/** @return Port name (excluding prefix) */
	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;
	}

	/* @return true if this port is visible outside Ardour (via JACK) */
	bool external () const {
		return _jack_port != 0;
	}

	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;
	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 set_latency (nframes_t);
	void request_monitor_input (bool);
	void make_external ();

	virtual void reset ();

	virtual DataType type () const = 0;
	virtual void cycle_start (nframes_t, nframes_t) = 0;
	virtual void cycle_end (nframes_t, nframes_t) = 0;
	virtual Buffer& get_buffer (nframes_t, nframes_t) = 0;
	virtual void flush_buffers (nframes_t, nframes_t) {}

	static void set_engine (AudioEngine *);

	sigc::signal<void, bool> MonitorInputChanged;

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

	jack_port_t* _jack_port; ///< JACK port, or 0 if we don't have one
	std::set<Port*> _connections; ///< internal Ports that we are connected to

	static AudioEngine* _engine; ///< the AudioEngine
	
private:
	friend class AudioEngine;

	void recompute_total_latency () const;
	void do_make_external (DataType);
	
	/* XXX */
	bool _last_monitor;
	nframes_t _latency;

	std::string _name; ///< port name (excluding prefix)
	Flags _flags; ///< flags

	/// list of JACK ports that we are connected to; we only keep this around
	/// so that we can implement ::reconnect ()
	std::set<std::string> _named_connections;
};

}

#endif