/*
- Copyright (C) 2002 Paul Davis
+ 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
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 <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;
-
-/** Abstract base for all outside ports (eg Jack ports)
- */
-class Port : public sigc::trackable {
- public:
- virtual ~Port() {
- free (_port);
- }
+class Buffer;
- virtual DataType type() const = 0;
+class Port : public sigc::trackable, public boost::noncopyable
+{
+public:
+ enum Flags {
+ IsInput = JackPortIsInput,
+ IsOutput = JackPortIsOutput,
+ };
- virtual void cycle_start(jack_nframes_t nframes) {}
- virtual void cycle_end() {}
+ virtual ~Port ();
- virtual Buffer& get_buffer() = 0;
-
- /** Silence/Empty the port, output ports only */
- virtual void silence (jack_nframes_t nframes, jack_nframes_t offset) = 0;
+ 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;
+ }
- std::string name() const {
+ /** @return Port short name */
+ std::string name () const {
return _name;
}
- std::string short_name() {
- return jack_port_short_name (_port);
- }
-
- int set_name (std::string str);
+ int set_name (std::string const &);
- JackPortFlags flags() const {
+ /** @return flags */
+ Flags flags () const {
return _flags;
}
- bool is_mine (jack_client_t *client) {
- return jack_port_is_mine (client, _port);
+ /** @return true if this Port receives input, otherwise false */
+ bool receives_input () const {
+ return _flags & IsInput;
}
- 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());
+ /** @return true if this Port sends output, otherwise false */
+ bool sends_output () const {
+ return _flags & IsOutput;
}
- const char ** get_connections () const {
- return jack_port_get_connections (_port);
- }
+ bool connected () const;
+ int disconnect_all ();
+ int get_connections (std::vector<std::string> &) const;
- bool receives_input() const {
- return _flags & JackPortIsInput;
- }
+ /* connection by name */
+ bool connected_to (std::string const &) const;
+ int connect (std::string const &);
+ int disconnect (std::string const &);
- bool sends_output () const {
- return _flags & JackPortIsOutput;
- }
-
- bool monitoring_input () const {
- return jack_port_monitoring_input (_port);
- }
+ /* connection by Port* */
+ bool connected_to (Port *) const;
+ virtual int connect (Port *);
+ int disconnect (Port *);
- bool can_monitor () const {
- return _flags & JackPortCanMonitor;
- }
+ 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);
- void enable_metering() {
- _metering++;
- }
+ virtual void reset ();
- void disable_metering () {
- if (_metering) { _metering--; }
- }
+ /** @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 ensure_monitor_input (bool yn) {
- jack_port_ensure_monitor (_port, yn);
- }
+ static void set_engine (AudioEngine *);
- /*XXX completely bloody useless imho*/
- void request_monitor_input (bool yn) {
- jack_port_request_monitor (_port, yn);
- }
+ sigc::signal<void, bool> MonitorInputChanged;
- jack_nframes_t latency () const {
- return jack_port_get_latency (_port);
- }
+protected:
+
+ Port (std::string const &, DataType, Flags);
- void set_latency (jack_nframes_t nframes) {
- jack_port_set_latency (_port, nframes);
- }
+ jack_port_t* _jack_port; ///< JACK port
- bool is_silent() const { return _silent; }
+ static nframes_t _port_offset;
+ static nframes_t _buffer_size;
- void mark_silence (bool yn) {
- _silent = yn;
- }
-
- sigc::signal<void,bool> MonitorInputChanged;
- sigc::signal<void,bool> ClockSyncChanged;
+ static AudioEngine* _engine; ///< the AudioEngine
- protected:
+private:
friend class AudioEngine;
- Port (jack_port_t *port);
-
- virtual void reset ();
+ void recompute_total_latency () const;
- /* 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;
+ /* XXX */
+ bool _last_monitor;
- jack_port_t* _port;
+ std::string _name; ///< port short name
+ Flags _flags; ///< flags
- unsigned short _metering;
-
- bool _last_monitor : 1;
- bool _silent : 1;
+ /** ports that we are connected to, kept so that we can
+ reconnect to JACK when required */
+ std::set<std::string> _connections;
};
-
-} // namespace ARDOUR
+
+}
#endif /* __ardour_port_h__ */
projects / ardour.git / blobdiff