libs/ardour/ardour/jack_portengine.h

   1 /*
   2     Copyright (C) 2013 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __libardour_jack_portengine_h__
  21 #define __libardour_jack_portengine_h__
  22
  23 #include <string>
  24 #include <vector>
  25
  26 #include <stdint.h>
  27
  28 #include <boost/shared_ptr.hpp>
  29
  30 #include "ardour/port_engine.h"
  31 #include "ardour/types.h"
  32
  33 namespace ARDOUR {
  34
  35 class JackConnection;
  36
  37 class JACKPortEngine : public PortEngine
  38 {
  39   public:
  40     JACKPortEngine (PortManager&, boost::shared_ptr<JackConnection>);
  41     ~JACKPortEngine();
  42
  43     void* private_handle() const;
  44
  45     const std::string& my_name() const;
  46
  47     uint32_t port_name_size() const;
  48
  49     int         set_port_name (PortHandle, const std::string&);
  50     std::string get_port_name (PortHandle) const;
  51     PortHandle* get_port_by_name (const std::string&) const;
  52
  53     int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
  54
  55     DataType port_data_type (PortHandle) const;
  56
  57     PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
  58     void  unregister_port (PortHandle);
  59
  60     bool  connected (PortHandle);
  61     bool  connected_to (PortHandle, const std::string&);
  62     bool  physically_connected (PortHandle);
  63     int   get_connections (PortHandle, std::vector<std::string>&);
  64     int   connect (PortHandle, const std::string&);
  65     int   disconnect (PortHandle, const std::string&);
  66     int   disconnect_all (PortHandle);
  67     int   connect (const std::string& src, const std::string& dst);
  68     int   disconnect (const std::string& src, const std::string& dst);
  69
  70     /* MIDI */
  71
  72     int      midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
  73     int      midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
  74     uint32_t get_midi_event_count (void* port_buffer);
  75     void     midi_clear (void* port_buffer);
  76
  77     /* Monitoring */
  78
  79     bool  can_monitor_input() const;
  80     int   request_input_monitoring (PortHandle, bool);
  81     int   ensure_input_monitoring (PortHandle, bool);
  82     bool  monitoring_input (PortHandle);
  83
  84     /* Latency management
  85      */
  86
  87     void          set_latency_range (PortHandle, bool for_playback, LatencyRange);
  88     LatencyRange  get_latency_range (PortHandle, bool for_playback);
  89
  90     /* Physical ports */
  91
  92     bool      port_is_physical (PortHandle) const;
  93     void      get_physical_outputs (DataType type, std::vector<std::string>&);
  94     void      get_physical_inputs (DataType type, std::vector<std::string>&);
  95     ChanCount n_physical_outputs () const;
  96     ChanCount n_physical_inputs () const;
  97
  98     /* Getting access to the data buffer for a port */
  99
 100     void* get_buffer (PortHandle, pframes_t);
 101
 102     /* Miscellany */
 103
 104     pframes_t sample_time_at_cycle_start ();
 105
 106   private:
 107     boost::shared_ptr<JackConnection> _jack_connection;
 108
 109     static int  _graph_order_callback (void *arg);
 110     static void _registration_callback (jack_port_id_t, int, void *);
 111     static void _connect_callback (jack_port_id_t, jack_port_id_t, int, void *);
 112
 113     void connect_callback (jack_port_id_t, jack_port_id_t, int);
 114
 115     ChanCount n_physical (unsigned long flags) const;
 116     void get_physical (DataType type, unsigned long flags, std::vector<std::string>& phy) const;
 117
 118 };
 119
 120 } // namespace
 121
 122 #endif /* __libardour_jack_portengine_h__ */