2 Copyright (C) 2011 Tim Mayberry
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.
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.
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.
28 // Names for the drivers on all possible systems
29 extern const char * const portaudio_driver_name;
30 extern const char * const coreaudio_driver_name;
31 extern const char * const alsa_driver_name;
32 extern const char * const oss_driver_name;
33 extern const char * const freebob_driver_name;
34 extern const char * const ffado_driver_name;
35 extern const char * const netjack_driver_name;
36 extern const char * const dummy_driver_name;
39 * Get a list of possible JACK audio driver names based on platform
41 void get_jack_audio_driver_names (std::vector<std::string>& driver_names);
44 * Get the default JACK audio driver based on platform
46 void get_jack_default_audio_driver_name (std::string& driver_name);
49 * Get a list of possible JACK midi driver names based on platform
51 void get_jack_midi_system_names (const std::string& driver, std::vector<std::string>& driver_names);
54 * Get the default JACK midi driver based on platform
56 void get_jack_default_midi_system_name (const std::string& driver_name, std::string& midi_system);
59 * Get a list of possible samplerates supported be JACK
61 void get_jack_sample_rate_strings (std::vector<std::string>& sample_rates);
64 * @return The default samplerate
66 std::string get_jack_default_sample_rate ();
69 * @return true if sample rate string was able to be converted
71 bool get_jack_sample_rate_value_from_string (const std::string& srs, uint32_t& srv);
74 * Get a list of possible period sizes supported be JACK
76 void get_jack_period_size_strings (std::vector<std::string>& samplerates);
79 * @return The default period size
81 std::string get_jack_default_period_size ();
84 * @return true if period size string was able to be converted
86 bool get_jack_period_size_value_from_string (const std::string& pss, uint32_t& psv);
89 * These are driver specific I think, so it may require a driver arg
92 void get_jack_dither_mode_strings (const std::string& driver, std::vector<std::string>& dither_modes);
95 * @return The default dither mode
97 std::string get_jack_default_dither_mode (const std::string& driver);
100 * @return Estimate of latency
102 * API matches current use in GUI
104 std::string get_jack_latency_string (std::string samplerate, float periods, std::string period_size);
107 * Key being a readable name to display in a GUI
108 * Value being name used in a jack commandline
110 typedef std::map<std::string, std::string> device_map_t;
113 * Use library specific code to find out what what devices exist for a given
114 * driver that might work in JACK. There is no easy way to find out what
115 * modules the JACK server supports so guess based on platform. For instance
116 * portaudio is cross-platform but we only return devices if built for
119 void get_jack_alsa_device_names (device_map_t& devices);
120 void get_jack_portaudio_device_names (device_map_t& devices);
121 void get_jack_coreaudio_device_names (device_map_t& devices);
122 void get_jack_oss_device_names (device_map_t& devices);
123 void get_jack_freebob_device_names (device_map_t& devices);
124 void get_jack_ffado_device_names (device_map_t& devices);
125 void get_jack_netjack_device_names (device_map_t& devices);
126 void get_jack_dummy_device_names (device_map_t& devices);
129 * @return true if there were devices found for the driver
131 * @param driver The driver name returned by get_jack_audio_driver_names
132 * @param devices The map used to insert the drivers into, devices will be cleared before
133 * adding the available drivers
135 bool get_jack_device_names_for_audio_driver (const std::string& driver, device_map_t& devices);
138 * @return a list of readable device names for a specific driver.
140 std::vector<std::string> get_jack_device_names_for_audio_driver (const std::string& driver);
143 * @return true if the driver supports playback and recording
144 * on separate devices
146 bool get_jack_audio_driver_supports_two_devices (const std::string& driver);
148 bool get_jack_audio_driver_supports_latency_adjustment (const std::string& driver);
150 bool get_jack_audio_driver_supports_setting_period_count (const std::string& driver);
153 * The possible names to use to try and find servers, this includes
154 * any file extensions like .exe on Windows
156 * @return true if the JACK application names for this platform could be guessed
158 bool get_jack_server_application_names (std::vector<std::string>& server_names);
161 * Sets the PATH environment variable to contain directories likely to contain
162 * JACK servers so that if the JACK server is auto-started it can find the server
165 * This is only modifies PATH on the mac at the moment.
167 void set_path_env_for_jack_autostart (const std::vector<std::string>&);
170 * Get absolute paths to directories that might contain JACK servers on the system
172 * @return true if !server_paths.empty()
174 bool get_jack_server_dir_paths (std::vector<std::string>& server_dir_paths);
177 * Get absolute paths to JACK servers on the system
179 * @return true if a server was found
181 bool get_jack_server_paths (const std::vector<std::string>& server_dir_paths,
182 const std::vector<std::string>& server_names,
183 std::vector<std::string>& server_paths);
186 bool get_jack_server_paths (std::vector<std::string>& server_paths);
189 * Get absolute path to default JACK server
191 bool get_jack_default_server_path (std::string& server_path);
194 * @return The name of the jack server config file
196 std::string get_jack_server_config_file_name ();
198 std::string get_jack_server_user_config_dir_path ();
200 std::string get_jack_server_user_config_file_path ();
202 bool write_jack_config_file (const std::string& config_file_path, const std::string& command_line);
204 struct JackCommandLineOptions {
206 // see implementation for defaults
207 JackCommandLineOptions ();
212 std::string server_path;
218 bool unlock_gui_libs;
224 std::string input_device;
225 std::string output_device;
226 uint32_t num_periods;
227 uint32_t period_size;
229 uint32_t input_latency;
230 uint32_t output_latency;
231 bool hardware_metering;
232 bool hardware_monitoring;
233 std::string dither_mode;
236 std::string midi_driver;
240 * @return true if able to build a valid command line based on options
242 bool get_jack_command_line_string (const JackCommandLineOptions& options, std::string& command_line);