/*
- 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
#ifndef __ardour_port_h__
#define __ardour_port_h__
-#include <sigc++/signal.h>
-#include <pbd/failed_constructor.h>
-#include <ardour/ardour.h>
-#include <jack/jack.h>
+#include "libardour-config.h"
+
+#include <set>
+#include <string>
+#include <vector>
+#include <boost/utility.hpp>
+#include "pbd/signals.h"
+
+#include "ardour/data_type.h"
+#include "ardour/port_engine.h"
+#include "ardour/libardour_visibility.h"
+#include "ardour/types.h"
namespace ARDOUR {
class AudioEngine;
+class Buffer;
-class Port : public sigc::trackable {
- public:
- virtual ~Port() {
- free (_port);
- }
+class LIBARDOUR_API Port : public boost::noncopyable
+{
+public:
+ virtual ~Port ();
- Sample *get_buffer (nframes_t nframes) {
- if (_flags & JackPortIsOutput) {
- return _buffer;
- } else {
- return (Sample *) jack_port_get_buffer (_port, nframes);
- }
+ static void set_connecting_blocked( bool yn ) {
+ _connecting_blocked = yn;
}
-
- void reset_buffer () {
- if (_flags & JackPortIsOutput) {
- _buffer = (Sample *) jack_port_get_buffer (_port, 0);
- } else {
- _buffer = 0; /* catch illegal attempts to use it */
- }
- _silent = false;
+ static bool connecting_blocked() {
+ return _connecting_blocked;
}
- std::string name() {
+ /** @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);
+ /** @return Port human readable name */
+ std::string pretty_name (bool fallback_to_name = false) const;
+ bool set_pretty_name (const std::string&);
+
+ int set_name (std::string const &);
- JackPortFlags flags() const {
+ /** @return flags */
+ PortFlags 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;
}
- const char* type() const {
- return _type.c_str();
+ /** @return true if this Port sends output, otherwise false */
+ bool sends_output () const {
+ return _flags & IsOutput;
}
- 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());
- }
+ bool connected () const;
+ int disconnect_all ();
+ int get_connections (std::vector<std::string> &) const;
- const char ** get_connections () const {
- return jack_port_get_connections (_port);
- }
+ /* connection by name */
+ bool connected_to (std::string const &) const;
+ int connect (std::string const &);
+ int disconnect (std::string const &);
- void reset_overs () {
- _short_overs = 0;
- _long_overs = 0;
- _overlen = 0;
- }
+ /* connection by Port* */
+ bool connected_to (Port *) const;
+ virtual int connect (Port *);
+ int disconnect (Port *);
- void reset_peak_meter () {
- _peak = 0;
- }
-
- void reset_meters () {
- reset_peak_meter ();
- reset_overs ();
- }
+ void request_input_monitoring (bool);
+ void ensure_input_monitoring (bool);
+ bool monitoring_input () const;
+ int reestablish ();
+ int reconnect ();
- void enable_metering() {
- _metering++;
- }
-
- void disable_metering () {
- if (_metering) { _metering--; }
- }
+ bool last_monitor() const { return _last_monitor; }
+ void set_last_monitor (bool yn) { _last_monitor = yn; }
- float peak_db() const { return _peak_db; }
- jack_default_audio_sample_t peak() const { return _peak; }
+ PortEngine::PortHandle port_handle() { return _port_handle; }
- uint32_t short_overs () const { return _short_overs; }
- uint32_t long_overs () const { return _long_overs; }
-
- static void set_short_over_length (nframes_t);
- static void set_long_over_length (nframes_t);
+ void get_connected_latency_range (LatencyRange& range, bool playback) const;
- bool receives_input() const {
- return _flags & JackPortIsInput;
- }
+ void set_private_latency_range (LatencyRange& range, bool playback);
+ const LatencyRange& private_latency_range (bool playback) const;
- bool sends_output () const {
- return _flags & JackPortIsOutput;
+ void set_public_latency_range (LatencyRange& range, bool playback) const;
+ LatencyRange public_latency_range (bool playback) const;
+
+ virtual void reset ();
+
+ virtual DataType type () const = 0;
+ virtual void cycle_start (pframes_t);
+ virtual void cycle_end (pframes_t) = 0;
+ virtual void cycle_split () = 0;
+ virtual Buffer& get_buffer (pframes_t nframes) = 0;
+ virtual void flush_buffers (pframes_t /*nframes*/) {}
+ virtual void transport_stopped () {}
+ virtual void realtime_locate () {}
+
+ bool physically_connected () const;
+
+ PBD::Signal1<void,bool> MonitorInputChanged;
+ static PBD::Signal2<void,boost::shared_ptr<Port>,boost::shared_ptr<Port> > PostDisconnect;
+ static PBD::Signal0<void> PortDrop;
+ static PBD::Signal0<void> PortSignalDrop;
+
+ static void set_cycle_framecnt (pframes_t n) {
+ _cycle_nframes = n;
}
-
- bool monitoring_input () const {
- return jack_port_monitoring_input (_port);
+ static framecnt_t port_offset() { return _global_port_buffer_offset; }
+ static void set_global_port_buffer_offset (pframes_t off) {
+ _global_port_buffer_offset = off;
}
-
- bool can_monitor () const {
- return _flags & JackPortCanMonitor;
+ static void increment_global_port_buffer_offset (pframes_t n) {
+ _global_port_buffer_offset += n;
}
-
- void ensure_monitor_input (bool yn) {
-#ifdef HAVE_JACK_PORT_ENSURE_MONITOR
- jack_port_ensure_monitor (_port, yn);
-#else
- jack_port_request_monitor(_port, yn);
-#endif
+ virtual void increment_port_buffer_offset (pframes_t n);
- }
+ virtual XMLNode& get_state (void) const;
+ virtual int set_state (const XMLNode&, int version);
- /*XXX completely bloody useless imho*/
- void request_monitor_input (bool yn) {
- jack_port_request_monitor (_port, yn);
- }
+ static std::string state_node_name;
- nframes_t latency () const {
- return jack_port_get_latency (_port);
- }
+protected:
- void set_latency (nframes_t nframes) {
- jack_port_set_latency (_port, nframes);
- }
+ Port (std::string const &, DataType, PortFlags);
- sigc::signal<void,bool> MonitorInputChanged;
- sigc::signal<void,bool> ClockSyncChanged;
-
- bool is_silent() const { return _silent; }
-
- /** Assumes that the port is an audio output port */
- void silence (nframes_t nframes, nframes_t offset) {
- if (!_silent) {
- memset (_buffer + offset, 0, sizeof (Sample) * nframes);
- if (offset == 0) {
- /* XXX this isn't really true, but i am not sure
- how to set this correctly. we really just
- want to set it true when the entire port
- buffer has been overrwritten.
- */
- _silent = true;
- }
- }
- }
-
- void mark_silence (bool yn) {
- _silent = yn;
- }
+ PortEngine::PortHandle _port_handle;
+
+ static bool _connecting_blocked;
+ static pframes_t _global_port_buffer_offset; /* access only from process() tree */
+ static pframes_t _cycle_nframes; /* access only from process() tree */
- private:
- friend class AudioEngine;
+ framecnt_t _port_buffer_offset; /* access only from process() tree */
- Port (jack_port_t *port);
- void reset ();
-
- /* engine isn't supposed to below here */
+ LatencyRange _private_playback_latency;
+ LatencyRange _private_capture_latency;
- Sample *_buffer;
+private:
+ std::string _name; ///< port short name
+ PortFlags _flags; ///< flags
+ bool _last_monitor;
- /* cache these 3 from JACK so that we can
- access them for reconnecting.
+ /** ports that we are connected to, kept so that we can
+ reconnect to the backend when required
*/
+ std::set<std::string> _connections;
- JackPortFlags _flags;
- std::string _type;
- std::string _name;
-
- bool _last_monitor : 1;
- bool _silent : 1;
- jack_port_t *_port;
- nframes_t _overlen;
- jack_default_audio_sample_t _peak;
- float _peak_db;
- uint32_t _short_overs;
- uint32_t _long_overs;
- unsigned short _metering;
-
- static nframes_t _long_over_length;
- static nframes_t _short_over_length;
+ void port_connected_or_disconnected (boost::weak_ptr<Port>, boost::weak_ptr<Port>, bool);
+ void signal_drop ();
+ void drop ();
+ PBD::ScopedConnection drop_connection;
+ PBD::ScopedConnection engine_connection;
};
-
-} // namespace ARDOUR
+
+}
#endif /* __ardour_port_h__ */
projects / ardour.git / blobdiff