port.h

Go to the documentation of this file.

/*
    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 "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 LIBARDOUR_API Port : public boost::noncopyable
{
public:
        virtual ~Port ();

        static void set_connecting_blocked( bool yn ) {
                _connecting_blocked = yn;
        }
        static bool connecting_blocked() {
                return _connecting_blocked;
        }

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

        std::string pretty_name (bool fallback_to_name = false) const;

        int set_name (std::string const &);

        PortFlags flags () const {
                return _flags;
        }

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

        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 request_input_monitoring (bool);
        void ensure_input_monitoring (bool);
        bool monitoring_input () const;
        int reestablish ();
        int reconnect ();

        bool last_monitor() const { return _last_monitor; }
        void set_last_monitor (bool yn) { _last_monitor = yn; }

        PortEngine::PortHandle port_handle() { return _port_handle; }

        void get_connected_latency_range (LatencyRange& range, bool playback) const;

        void set_private_latency_range (LatencyRange& range, bool playback);
        const LatencyRange&  private_latency_range (bool playback) const;

        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 void set_cycle_framecnt (pframes_t n) {
                _cycle_nframes = n;
        }
        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;
        }
        static void increment_global_port_buffer_offset (pframes_t n) {
                _global_port_buffer_offset += n;
        }

        virtual void increment_port_buffer_offset (pframes_t n);

        virtual XMLNode& get_state (void) const;
        virtual int set_state (const XMLNode&, int version);

        static std::string state_node_name;

protected:

        Port (std::string const &, DataType, PortFlags);

        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 */

        framecnt_t _port_buffer_offset; /* access only from process() tree */

        LatencyRange _private_playback_latency;
        LatencyRange _private_capture_latency;

private:
        std::string _name;  
        PortFlags       _flags; 
        bool        _last_monitor;

        std::set<std::string> _connections;

       void drop ();
       PBD::ScopedConnection drop_connection;
};

}

#endif /* __ardour_port_h__ */