Introduce global default-fade-shape configuration variable
[ardour.git] / libs / ardour / ardour / port_manager.h
index 8a363899ea4972ea3c478a8e3b86a95e0c3f6b24..b36e98fe64504526426a5ef8aa179a668a257a5e 100644 (file)
-namespace ARDOUR
+/*
+    Copyright (C) 2013 Paul Davis
 
-class PortManager 
+    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 __libardour_port_manager_h__
+#define __libardour_port_manager_h__
+
+#include <vector>
+#include <string>
+#include <exception>
+#include <map>
+
+#include <stdint.h>
+
+#include <boost/shared_ptr.hpp>
+
+#include "pbd/rcu.h"
+
+#include "ardour/chan_count.h"
+#include "ardour/midiport_manager.h"
+#include "ardour/port.h"
+
+namespace ARDOUR {
+
+class PortEngine;
+class AudioBackend;
+
+class LIBARDOUR_API PortManager 
 {
   public:
-       PortManager() {}
-       virtual ~PortManager() {}
+    typedef std::map<std::string,boost::shared_ptr<Port> > Ports;
+    typedef std::list<boost::shared_ptr<Port> > PortList;
+    
+    PortManager ();
+    virtual ~PortManager() {}
 
-       /* Port registration */
-       
-       virtual boost::shared_ptr<Port> register_input_port (DataType, const std::string& portname) = 0;
-       virtual boost::shared_ptr<Port> register_output_port (DataType, const std::string& portname) = 0;
-       virtual int unregister_port (boost::shared_ptr<Port>) = 0;
-       
-       /* Port connectivity */
-       
-       virtual int connect (const std::string& source, const std::string& destination) = 0;
-       virtual int disconnect (const std::string& source, const std::string& destination) = 0;
-       virtual int disconnect (boost::shared_ptr<Port>) = 0;
+    PortEngine& port_engine();
+
+    uint32_t port_name_size() const;
+    std::string my_name() const;
+
+    /* Port registration */
+    
+    boost::shared_ptr<Port> register_input_port (DataType, const std::string& portname, bool async = false);
+    boost::shared_ptr<Port> register_output_port (DataType, const std::string& portname, bool async = false);
+    int unregister_port (boost::shared_ptr<Port>);
+    
+    /* Port connectivity */
+    
+    int  connect (const std::string& source, const std::string& destination);
+    int  disconnect (const std::string& source, const std::string& destination);
+    int  disconnect (boost::shared_ptr<Port>);
+    int  reestablish_ports ();
+    int  reconnect_ports ();
+
+    bool  connected (const std::string&);
+    bool  connected_to (const std::string&, const std::string&);
+    bool  physically_connected (const std::string&);
+    int   get_connections (const std::string&, std::vector<std::string>&);
+
+    /* Naming */
+
+    boost::shared_ptr<Port> get_port_by_name (const std::string &);
+    void                    port_renamed (const std::string&, const std::string&);
+    std::string             make_port_name_relative (const std::string& name) const;
+    std::string             make_port_name_non_relative (const std::string& name) const;
+    bool                    port_is_mine (const std::string& fullname) const;
+
+    /* other Port management */
+    
+    bool      port_is_physical (const std::string&) const;
+    void      get_physical_outputs (DataType type, std::vector<std::string>&);
+    void      get_physical_inputs (DataType type, std::vector<std::string>&);
+    ChanCount n_physical_outputs () const;
+    ChanCount n_physical_inputs () const;
+
+    int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&);
+    int get_ports (DataType, PortList&);
+
+    void remove_all_ports ();
+    
+    /* per-Port monitoring */
+    
+    bool can_request_input_monitoring () const;
+    void request_input_monitoring (const std::string&, bool) const;
+    void ensure_input_monitoring (const std::string&, bool) const;
+    
+    class PortRegistrationFailure : public std::exception {
+      public:
+       PortRegistrationFailure (std::string const & why = "")
+               : reason (why) {}
        
-       /* other Port management */
+       ~PortRegistrationFailure () throw () {}
        
-       virtual bool port_is_physical (const std::string&) const = 0;
-       virtual void get_physical_outputs (DataType type, std::vector<std::string>&) = 0;
-       virtual void get_physical_inputs (DataType type, std::vector<std::string>&) = 0;
-       virtual boost::shared_ptr<Port> get_port_by_name (const std::string &) = 0;
-       virtual void port_renamed (const std::string&, const std::string&) = 0;
-       virtual ChanCount n_physical_outputs () const = 0;
-       virtual ChanCount n_physical_inputs () const = 0;
-       virtual const char ** get_ports (const std::string& port_name_pattern, const std::string& type_name_pattern, uint32_t flags) = 0;
-
-       /* per-Port monitoring */
+       const char *what() const throw () { return reason.c_str(); }
        
-       virtual bool can_request_input_monitoring () const = 0;
-       virtual void request_input_monitoring (const std::string&, bool) const = 0;
+      private:
+       std::string reason;
+    };
+
+    /* the port engine will invoke these callbacks when the time is right */
+    
+    void registration_callback ();
+    int graph_order_callback ();
+    void connect_callback (const std::string&, const std::string&, bool connection);
 
-       class PortRegistrationFailure : public std::exception {
-       public:
-               PortRegistrationFailure (std::string const & why = "")
-                       : reason (why) {}
+    bool port_remove_in_progress() const { return _port_remove_in_progress; }
 
-               ~PortRegistrationFailure () throw () {}
+    /** Emitted if the backend notifies us of a graph order event */
+    PBD::Signal0<void> GraphReordered;
 
-               virtual const char *what() const throw () { return reason.c_str(); }
+    /** Emitted if a Port is registered or unregistered */
+    PBD::Signal0<void> PortRegisteredOrUnregistered;
+    
+    /** Emitted if a Port is connected or disconnected.
+     *  The Port parameters are the ports being connected / disconnected, or 0 if they are not known to Ardour.
+     *  The std::string parameters are the (long) port names.
+     *  The bool parameter is true if ports were connected, or false for disconnected.
+     */
+    PBD::Signal5<void, boost::weak_ptr<Port>, std::string, boost::weak_ptr<Port>, std::string, bool> PortConnectedOrDisconnected;
 
-       private:
-               std::string reason;
-       };
+  protected:
+    boost::shared_ptr<AudioBackend> _backend;
+    SerializedRCUManager<Ports> ports;
+    bool _port_remove_in_progress;
 
+    boost::shared_ptr<Port> register_port (DataType type, const std::string& portname, bool input, bool async = false);
+    void port_registration_failure (const std::string& portname);
+
+    /** List of ports to be used between ::cycle_start() and ::cycle_end()
+     */
+    boost::shared_ptr<Ports> _cycle_ports;
+
+    void fade_out (gain_t, gain_t, pframes_t);
+    void silence (pframes_t nframes);
+    void check_monitoring ();
+    /** Signal the start of an audio cycle.
+     * This MUST be called before any reading/writing for this cycle.
+     * Realtime safe.
+     */
+    void cycle_start (pframes_t nframes);
+       
+    /** Signal the end of an audio cycle.
+     * This signifies that the cycle began with @ref cycle_start has ended.
+     * This MUST be called at the end of each cycle.
+     * Realtime safe.
+     */
+    void cycle_end (pframes_t nframes);
 };
+
+
+       
+} // namespace
+
+#endif /* __libardour_port_manager_h__ */