summaryrefslogtreecommitdiff
path: root/libs/ardour/ardour/port.h
blob: a436722cb04cf6d11d23f55b2e691e4964a3bdec (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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/*
    Copyright (C) 2002 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.

    $Id$
*/

#ifndef __ardour_port_h__
#define __ardour_port_h__

#include <sigc++/signal.h>
#include <pbd/failed_constructor.h>
#include <ardour/ardour.h>
#include <ardour/data_type.h>
#include <jack/jack.h>

namespace ARDOUR {

class AudioEngine;
class Buffer;

/** Abstract base for all outside ports (eg Jack ports)
 */
class Port : public sigc::trackable {
   public:
	virtual ~Port() { 
		free (_port);
	}

	virtual DataType type() const = 0;

	virtual void cycle_start(jack_nframes_t nframes) {}
	virtual void cycle_end() {}

	virtual Buffer& get_buffer() = 0;
	
	/** Silence/Empty the port, output ports only */
	virtual void silence (jack_nframes_t nframes, jack_nframes_t offset) = 0;


	std::string name() const { 
		return _name;
	}

	std::string short_name() { 
		return jack_port_short_name (_port);
	}
	
	int set_name (std::string str);

	JackPortFlags flags() const {
		return _flags;
	}

	bool is_mine (jack_client_t *client) { 
		return jack_port_is_mine (client, _port);
	}

	int connected () const {
		return jack_port_connected (_port);
	}
	
	bool connected_to (const std::string& portname) const {
		return jack_port_connected_to (_port, portname.c_str());
	}

	const char ** get_connections () const {
		return jack_port_get_connections (_port);
	}

	bool receives_input() const {
		return _flags & JackPortIsInput;
	}

	bool sends_output () const {
		return _flags & JackPortIsOutput;
	}
	
	bool monitoring_input () const {
		return jack_port_monitoring_input (_port);
	}

	bool can_monitor () const {
		return _flags & JackPortCanMonitor;
	}

	void enable_metering() {
		_metering++;
	}
	
	void disable_metering () {
		if (_metering) { _metering--; }
	}
	
	void ensure_monitor_input (bool yn) {

#ifdef WITH_JACK_PORT_ENSURE_MONITOR
		jack_port_ensure_monitor (_port, yn);
#else
		jack_port_request_monitor(_port, yn);
#endif

	}

	/*XXX completely bloody useless imho*/
	void request_monitor_input (bool yn) {
		jack_port_request_monitor (_port, yn);
	}

	jack_nframes_t latency () const {
		return jack_port_get_latency (_port);
	}

	void set_latency (jack_nframes_t nframes) {
		jack_port_set_latency (_port, nframes);
	}

	bool is_silent() const { return _silent; }

	void mark_silence (bool yn) {
		_silent = yn;
	}
	
	sigc::signal<void,bool> MonitorInputChanged;
	sigc::signal<void,bool> ClockSyncChanged;

  protected:
	friend class AudioEngine;

	Port (jack_port_t *port);
	
	virtual void reset ();
	
	/* engine isn't supposed to access below here */

	/* cache these 3 from JACK so we can access them for reconnecting */
	JackPortFlags _flags;
	std::string   _type;
	std::string   _name;

	jack_port_t*  _port;

	unsigned short _metering;

	bool          _last_monitor : 1;
	bool          _silent : 1;
};
 
} // namespace ARDOUR

#endif /* __ardour_port_h__ */