/* * Copyright (C) 2013-2018 Paul Davis * Copyright (C) 2013 Tim Mayberry * Copyright (C) 2014-2018 Robin Gareus * * 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., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ #ifndef __libardour_jack_audiobackend_h__ #define __libardour_jack_audiobackend_h__ #include #include #include #include #include #include #include "weak_libjack.h" #include "ardour/audio_backend.h" namespace ARDOUR { class JackConnection; class JACKSession; class JackPort : public ProtoPort { public: JackPort (jack_port_t* p) : jack_ptr (p) {} ~JackPort() { } private: friend class JACKAudioBackend; jack_port_t* jack_ptr; }; class JACKAudioBackend : public AudioBackend { public: JACKAudioBackend (AudioEngine& e, AudioBackendInfo& info, std::shared_ptr); ~JACKAudioBackend (); /* AUDIOBACKEND API */ std::string name() const; void* private_handle() const; bool is_realtime () const; bool is_jack () const { return true; } bool requires_driver_selection() const; std::vector enumerate_drivers () const; int set_driver (const std::string&); std::vector enumerate_devices () const; std::vector available_sample_rates (const std::string& device) const; std::vector available_buffer_sizes (const std::string& device) const; std::vector available_period_sizes (const std::string& driver, const std::string& device) const; bool can_change_sample_rate_when_running() const; bool can_change_buffer_size_when_running() const; int set_device_name (const std::string&); int set_sample_rate (float); int set_buffer_size (uint32_t); int set_peridod_size (uint32_t); int set_interleaved (bool yn); int set_systemic_input_latency (uint32_t); int set_systemic_output_latency (uint32_t); int set_systemic_midi_input_latency (std::string const, uint32_t) { return 0; } int set_systemic_midi_output_latency (std::string const, uint32_t) { return 0; } int reset_device (); std::string device_name () const; float sample_rate () const; uint32_t buffer_size () const; uint32_t period_size () const; bool interleaved () const; uint32_t systemic_input_latency () const; uint32_t systemic_output_latency () const; uint32_t systemic_midi_input_latency (std::string const) const { return 0; } uint32_t systemic_midi_output_latency (std::string const) const { return 0; } std::string driver_name() const; std::string control_app_name () const; void launch_control_app (); int stop (); int freewheel (bool); float dsp_load() const; samplepos_t sample_time (); samplepos_t sample_time_at_cycle_start (); pframes_t samples_since_cycle_start (); size_t raw_buffer_size (DataType t); int create_process_thread (std::function func); int join_process_threads (); bool in_process_thread (); uint32_t process_thread_count (); int client_real_time_priority (); void transport_start (); void transport_stop (); void transport_locate (samplepos_t /*pos*/); TransportState transport_state () const; samplepos_t transport_sample() const; int set_time_master (bool /*yn*/); bool get_sync_offset (pframes_t& /*offset*/) const; void update_latencies (); static bool already_configured(); /* PORTENGINE API */ const std::string& my_name() const; uint32_t port_name_size() const; int set_port_name (PortHandle, const std::string&); std::string get_port_name (PortHandle) const; PortFlags get_port_flags (PortHandle) const; PortPtr get_port_by_name (const std::string&) const; int get_port_property (PortHandle, const std::string& key, std::string& value, std::string& type) const; int set_port_property (PortHandle, const std::string& key, const std::string& value, const std::string& type); int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector&) const; DataType port_data_type (PortHandle) const; PortPtr register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags); void unregister_port (PortHandle); bool connected (PortHandle, bool process_callback_safe); bool connected_to (PortHandle, const std::string&, bool process_callback_safe); bool physically_connected (PortHandle, bool process_callback_safe); bool externally_connected (PortHandle, bool process_callback_safe); int get_connections (PortHandle, std::vector&, bool process_callback_safe); int connect (PortHandle, const std::string&); int disconnect (PortHandle, const std::string&); int disconnect_all (PortHandle); int connect (const std::string& src, const std::string& dst); int disconnect (const std::string& src, const std::string& dst); /* MIDI */ std::vector enumerate_midi_options () const; int set_midi_option (const std::string&); std::string midi_option () const; std::vector enumerate_midi_devices () const { return std::vector (); } int set_midi_device_enabled (std::string const, bool) { return 0; } bool midi_device_enabled (std::string const) const { return true; } bool can_set_systemic_midi_latencies () const { return false; } bool can_set_period_size () const { return true; } bool can_measure_systemic_latency () const { return true; } int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t const** buf, void* port_buffer, uint32_t event_index); int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size); uint32_t get_midi_event_count (void* port_buffer); void midi_clear (void* port_buffer); /* Monitoring */ bool can_monitor_input() const; int request_input_monitoring (PortHandle, bool); int ensure_input_monitoring (PortHandle, bool); bool monitoring_input (PortHandle); /* Latency management */ void set_latency_range (PortHandle, bool for_playback, LatencyRange); LatencyRange get_latency_range (PortHandle, bool for_playback); /* Physical ports */ bool port_is_physical (PortHandle) const; void get_physical_outputs (DataType type, std::vector&); void get_physical_inputs (DataType type, std::vector&); ChanCount n_physical_outputs () const; ChanCount n_physical_inputs () const; /* Getting access to the data buffer for a port */ void* get_buffer (PortHandle, pframes_t); /* transport sync */ bool speed_and_position (double& sp, samplepos_t& pos); private: std::shared_ptr _jack_connection; bool _running; bool _freewheeling; std::map _raw_buffer_sizes; std::vector _jack_threads; jack_native_thread_t _main_thread; static int _xrun_callback (void *arg); static void* _process_thread (void *arg); static int _sample_rate_callback (pframes_t nframes, void *arg); static int _bufsize_callback (pframes_t nframes, void *arg); static void _jack_timebase_callback (jack_transport_state_t, pframes_t, jack_position_t*, int, void*); static int _jack_sync_callback (jack_transport_state_t, jack_position_t*, void *arg); static void _freewheel_callback (int , void *arg); static void _latency_callback (jack_latency_callback_mode_t, void*); static void _session_callback (jack_session_event_t *event, void *arg); void jack_timebase_callback (jack_transport_state_t, pframes_t, jack_position_t*, int); int jack_sync_callback (jack_transport_state_t, jack_position_t*); int jack_bufsize_callback (pframes_t); int jack_sample_rate_callback (pframes_t); void freewheel_callback (int); int process_callback (pframes_t nframes); void jack_latency_callback (jack_latency_callback_mode_t); void disconnected (const char*); void set_jack_callbacks (); int reconnect_to_jack (); bool available() const; struct ThreadData { JACKAudioBackend* engine; std::function f; size_t stacksize; ThreadData (JACKAudioBackend* e, std::function fp, size_t stacksz) : engine (e) , f (fp) , stacksize (stacksz) {} }; void* process_thread (); static void* _start_process_thread (void*); void setup_jack_startup_command (bool for_latency_measurement); /* pffooo */ std::string _target_driver; std::string _target_device; float _target_sample_rate; uint32_t _target_buffer_size; uint32_t _target_num_periods; SampleFormat _target_sample_format; bool _target_interleaved; uint32_t _target_input_channels; uint32_t _target_output_channels; uint32_t _target_systemic_input_latency; uint32_t _target_systemic_output_latency; uint32_t _current_sample_rate; uint32_t _current_buffer_size; std::string _target_midi_option; typedef std::set DeviceList; typedef std::map DriverDeviceMap; mutable DriverDeviceMap all_devices; PBD::ScopedConnection disconnect_connection; /* PORTENGINE RELATED */ static int _graph_order_callback (void *arg); static void _registration_callback (jack_port_id_t, int, void *); static void _connect_callback (jack_port_id_t, jack_port_id_t, int, void *); /* used to manage _jack_ports, specifically for ports belonging to the JACK backend or other clients. */ void jack_registration_callback (jack_port_id_t, int); typedef std::map > JackPorts; mutable SerializedRCUManager _jack_ports; /* can be modified in ::get_port_by_name () */ void connect_callback (jack_port_id_t, jack_port_id_t, int); ChanCount n_physical (unsigned long flags) const; void get_physical (DataType type, unsigned long flags, std::vector& phy) const; void when_connected_to_jack (); PBD::ScopedConnection jack_connection_connection; /* Object to manage interactions with Session in a way that keeps JACK out of libardour directly */ JACKSession* _session; mutable Glib::Threads::Mutex server_call_mutex; protected: int _start (bool for_latency_measurement); }; } // namespace #endif /* __ardour_audiobackend_h__ */