/[svn]/linuxsampler/trunk/src/drivers/audio/AudioOutputDeviceJack.cpp
ViewVC logotype

Annotation of /linuxsampler/trunk/src/drivers/audio/AudioOutputDeviceJack.cpp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1682 - (hide annotations) (download)
Wed Feb 13 15:31:56 2008 UTC (12 years ago) by schoenebeck
File size: 14412 byte(s)
* fixed compilation error on systems which support JACK, but not JACK MIDI

1 schoenebeck 200 /***************************************************************************
2     * *
3     * LinuxSampler - modular, streaming capable sampler *
4     * *
5     * Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6 persson 1651 * Copyright (C) 2005 - 2008 Christian Schoenebeck *
7 schoenebeck 200 * *
8     * This program is free software; you can redistribute it and/or modify *
9     * it under the terms of the GNU General Public License as published by *
10     * the Free Software Foundation; either version 2 of the License, or *
11     * (at your option) any later version. *
12     * *
13     * This program is distributed in the hope that it will be useful, *
14     * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16     * GNU General Public License for more details. *
17     * *
18     * You should have received a copy of the GNU General Public License *
19     * along with this program; if not, write to the Free Software *
20     * Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
21     * MA 02111-1307 USA *
22     ***************************************************************************/
23    
24     #include "AudioOutputDeviceJack.h"
25     #include "AudioOutputDeviceFactory.h"
26    
27 capela 268 #include <errno.h>
28    
29 schoenebeck 200 #if HAVE_JACK
30    
31 persson 379 #ifndef HAVE_JACK_CLIENT_NAME_SIZE
32     #define jack_client_name_size() 33
33     #endif
34    
35 schoenebeck 200 namespace LinuxSampler {
36    
37 schoenebeck 374 /// number of currently existing JACK audio output devices in LinuxSampler
38     static int existingJackDevices = 0;
39    
40     // *************** AudioChannelJack::ParameterName ***************
41 schoenebeck 226 // *
42    
43     AudioOutputDeviceJack::AudioChannelJack::ParameterName::ParameterName(AudioChannelJack* pChannel) : AudioChannel::ParameterName(ToString(pChannel->ChannelNr)) {
44     this->pChannel = pChannel;
45     }
46    
47     void AudioOutputDeviceJack::AudioChannelJack::ParameterName::OnSetValue(String s) {
48 schoenebeck 227 if (jack_port_set_name(pChannel->hJackPort, s.c_str())) throw AudioOutputException("Failed to rename JACK port");
49 schoenebeck 226 }
50    
51    
52    
53 schoenebeck 374 // *************** AudioChannelJack::ParameterJackBindings ***************
54 schoenebeck 226 // *
55    
56     AudioOutputDeviceJack::AudioChannelJack::ParameterJackBindings::ParameterJackBindings(AudioChannelJack* pChannel) : DeviceRuntimeParameterStrings(std::vector<String>()) {
57     this->pChannel = pChannel;
58     }
59    
60     String AudioOutputDeviceJack::AudioChannelJack::ParameterJackBindings::Description() {
61     return "Bindings to other JACK clients";
62     }
63    
64     bool AudioOutputDeviceJack::AudioChannelJack::ParameterJackBindings::Fix() {
65     return false;
66     }
67    
68     std::vector<String> AudioOutputDeviceJack::AudioChannelJack::ParameterJackBindings::PossibilitiesAsString() {
69 persson 1651 const char** pPortNames = jack_get_ports(pChannel->pDevice->hJackClient, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortIsInput);
70 schoenebeck 226 if (!pPortNames) return std::vector<String>();
71     std::vector<String> result;
72     for (int i = 0; pPortNames[i]; i++) result.push_back(pPortNames[i]);
73 persson 1651 free(pPortNames);
74 schoenebeck 226 return result;
75     }
76    
77     void AudioOutputDeviceJack::AudioChannelJack::ParameterJackBindings::OnSetValue(std::vector<String> vS) {
78 schoenebeck 403 String src_name = ((DeviceCreationParameterString*)pChannel->pDevice->Parameters["NAME"])->ValueAsString() + ":" +
79     ((DeviceRuntimeParameterString*)pChannel->Parameters["NAME"])->ValueAsString();
80 schoenebeck 483 // disconnect all current bindings first
81     for (int i = 0; i < Bindings.size(); i++) {
82     String dst_name = Bindings[i];
83     int res = jack_disconnect(pChannel->pDevice->hJackClient, src_name.c_str(), dst_name.c_str());
84     }
85     // connect new bindings
86 schoenebeck 226 for (int i = 0; i < vS.size(); i++) {
87     String dst_name = vS[i];
88 schoenebeck 227 int res = jack_connect(pChannel->pDevice->hJackClient, src_name.c_str(), dst_name.c_str());
89     if (res == EEXIST) throw AudioOutputException("Jack: Connection to port '" + dst_name + "' already established");
90     else if (res) throw AudioOutputException("Jack: Cannot connect port '" + src_name + "' to port '" + dst_name + "'");
91 schoenebeck 226 }
92 schoenebeck 483 // remember bindings
93     Bindings = vS;
94 schoenebeck 226 }
95    
96     String AudioOutputDeviceJack::AudioChannelJack::ParameterJackBindings::Name() {
97     return "JACK_BINDINGS";
98     }
99    
100    
101    
102     // *************** AudioChannelJack ***************
103     // *
104    
105     AudioOutputDeviceJack::AudioChannelJack::AudioChannelJack(uint ChannelNr, AudioOutputDeviceJack* pDevice) throw (AudioOutputException) : AudioChannel(ChannelNr, CreateJackPort(ChannelNr, pDevice), pDevice->uiMaxSamplesPerCycle) {
106     this->pDevice = pDevice;
107     this->ChannelNr = ChannelNr;
108 persson 1248 delete Parameters["NAME"];
109 schoenebeck 226 Parameters["NAME"] = new ParameterName(this);
110     Parameters["JACK_BINDINGS"] = new ParameterJackBindings(this);
111     }
112    
113     AudioOutputDeviceJack::AudioChannelJack::~AudioChannelJack() {
114     //TODO: delete JACK port
115     }
116    
117     float* AudioOutputDeviceJack::AudioChannelJack::CreateJackPort(uint ChannelNr, AudioOutputDeviceJack* pDevice) throw (AudioOutputException) {
118 schoenebeck 227 String port_id = ToString(ChannelNr);
119 schoenebeck 226 hJackPort = jack_port_register(pDevice->hJackClient, port_id.c_str(), JACK_DEFAULT_AUDIO_TYPE, JackPortIsOutput, 0);
120     if (!hJackPort) throw AudioOutputException("Jack: Cannot register Jack output port.");
121     return (float*) jack_port_get_buffer(hJackPort, pDevice->uiMaxSamplesPerCycle);
122     }
123    
124    
125    
126 schoenebeck 374 // *************** AudioOutputDeviceJack::ParameterName ***************
127     // *
128    
129     AudioOutputDeviceJack::ParameterName::ParameterName() : DeviceCreationParameterString() {
130     InitWithDefault(); // use default name
131     }
132    
133 schoenebeck 880 AudioOutputDeviceJack::ParameterName::ParameterName(String s) throw (Exception) : DeviceCreationParameterString(s) {
134 schoenebeck 374 }
135    
136     String AudioOutputDeviceJack::ParameterName::Description() {
137     return "Arbitrary JACK client name";
138     }
139    
140     bool AudioOutputDeviceJack::ParameterName::Fix() {
141     return true;
142     }
143    
144     bool AudioOutputDeviceJack::ParameterName::Mandatory() {
145     return false;
146     }
147    
148     std::map<String,DeviceCreationParameter*> AudioOutputDeviceJack::ParameterName::DependsAsParameters() {
149     return std::map<String,DeviceCreationParameter*>(); // no dependencies
150     }
151    
152     std::vector<String> AudioOutputDeviceJack::ParameterName::PossibilitiesAsString(std::map<String,String> Parameters) {
153     return std::vector<String>();
154     }
155    
156     optional<String> AudioOutputDeviceJack::ParameterName::DefaultAsString(std::map<String,String> Parameters) {
157     return (existingJackDevices) ? "LinuxSampler" + ToString(existingJackDevices) : "LinuxSampler";
158     }
159    
160 schoenebeck 880 void AudioOutputDeviceJack::ParameterName::OnSetValue(String s) throw (Exception) {
161 schoenebeck 374 // not possible, as parameter is fix
162     }
163    
164     String AudioOutputDeviceJack::ParameterName::Name() {
165     return "NAME";
166     }
167    
168    
169    
170 schoenebeck 226 // *************** AudioOutputDeviceJack ***************
171     // *
172    
173 schoenebeck 200 /**
174     * Open and initialize connection to the JACK system.
175     *
176     * @param Parameters - optional parameters
177     * @throws AudioOutputException on error
178     * @see AcquireChannels()
179     */
180 schoenebeck 226 AudioOutputDeviceJack::AudioOutputDeviceJack(std::map<String,DeviceCreationParameter*> Parameters) : AudioOutputDevice(Parameters) {
181 persson 1651 JackClient* pJackClient = JackClient::CreateAudio(((DeviceCreationParameterString*)Parameters["NAME"])->ValueAsString());
182 schoenebeck 374 existingJackDevices++;
183 persson 1651 pJackClient->SetAudioOutputDevice(this);
184     hJackClient = pJackClient->hJackClient;
185 schoenebeck 200 uiMaxSamplesPerCycle = jack_get_buffer_size(hJackClient);
186    
187 schoenebeck 226 // create audio channels
188     AcquireChannels(((DeviceCreationParameterInt*)Parameters["CHANNELS"])->ValueAsInt());
189 schoenebeck 227
190     // finally activate device if desired
191     if (((DeviceCreationParameterBool*)Parameters["ACTIVE"])->ValueAsBool()) Play();
192 schoenebeck 200 }
193    
194     AudioOutputDeviceJack::~AudioOutputDeviceJack() {
195 persson 1651 // destroy jack client if there is no midi device associated with it
196     JackClient::ReleaseAudio(((DeviceCreationParameterString*)Parameters["NAME"])->ValueAsString());
197 schoenebeck 374 existingJackDevices--;
198 schoenebeck 200 }
199    
200     /**
201     * This method should not be called directly! It will be called by
202     * libjack to demand transmission of further sample points.
203     */
204     int AudioOutputDeviceJack::Process(uint Samples) {
205     if (csIsPlaying.Pop()) {
206     // let all connected engines render 'Samples' sample points
207     return RenderAudio(Samples);
208     }
209     else {
210     // playback stop by zeroing output buffer(s) and not calling connected sampler engines to render audio
211     return RenderSilence(Samples);
212     }
213     }
214    
215     void AudioOutputDeviceJack::Play() {
216     csIsPlaying.PushAndUnlock(true);
217     }
218    
219     bool AudioOutputDeviceJack::IsPlaying() {
220 persson 497 return csIsPlaying.GetUnsafe();
221 schoenebeck 200 }
222    
223     void AudioOutputDeviceJack::Stop() {
224     csIsPlaying.PushAndUnlock(false);
225     }
226    
227 schoenebeck 226 AudioChannel* AudioOutputDeviceJack::CreateChannel(uint ChannelNr) {
228     return new AudioChannelJack(ChannelNr, this);
229 schoenebeck 200 }
230    
231     uint AudioOutputDeviceJack::MaxSamplesPerCycle() {
232     return jack_get_buffer_size(hJackClient);
233     }
234    
235     uint AudioOutputDeviceJack::SampleRate() {
236     return jack_get_sample_rate(hJackClient);
237     }
238    
239     String AudioOutputDeviceJack::Name() {
240 schoenebeck 221 return "JACK";
241 schoenebeck 200 }
242    
243     String AudioOutputDeviceJack::Driver() {
244     return Name();
245     }
246    
247     String AudioOutputDeviceJack::Description() {
248     return "JACK Audio Connection Kit";
249     }
250    
251     String AudioOutputDeviceJack::Version() {
252 schoenebeck 1682 String s = "$Revision: 1.23 $";
253 schoenebeck 200 return s.substr(11, s.size() - 13); // cut dollar signs, spaces and CVS macro keyword
254     }
255    
256 persson 1651
257    
258     // *************** JackClient ***************
259     // *
260    
261 schoenebeck 200 // libjack callback functions
262    
263 persson 1651 int linuxsampler_libjack_process_callback(jack_nframes_t nframes, void* arg) {
264     return static_cast<JackClient*>(arg)->Process(nframes);
265 schoenebeck 200 }
266    
267 persson 1651 void linuxsampler_libjack_shutdown_callback(void* arg) {
268     static_cast<JackClient*>(arg)->Stop();
269 schoenebeck 200 fprintf(stderr, "Jack: Jack server shutdown, exiting.\n");
270     }
271    
272 persson 1651 std::map<String, JackClient*> JackClient::Clients;
273    
274     int JackClient::Process(uint Samples) {
275     const config_t& config = ConfigReader.Lock();
276     #if HAVE_JACK_MIDI
277     if (config.MidiDevice) config.MidiDevice->Process(Samples);
278     #endif
279     int res = config.AudioDevice ? config.AudioDevice->Process(Samples) : 0;
280     ConfigReader.Unlock();
281     return res;
282     }
283    
284     void JackClient::Stop() {
285     const config_t& config = ConfigReader.Lock();
286     if (config.AudioDevice) config.AudioDevice->Stop();
287     ConfigReader.Unlock();
288     }
289    
290     JackClient::JackClient(String Name) : ConfigReader(Config) {
291     {
292     config_t& config = Config.GetConfigForUpdate();
293     config.AudioDevice = 0;
294 schoenebeck 1682 #if HAVE_JACK_MIDI
295 persson 1651 config.MidiDevice = 0;
296 schoenebeck 1682 #endif
297 persson 1651 }
298     {
299     config_t& config = Config.SwitchConfig();
300     config.AudioDevice = 0;
301 schoenebeck 1682 #if HAVE_JACK_MIDI
302 persson 1651 config.MidiDevice = 0;
303 schoenebeck 1682 #endif
304 persson 1651 }
305     audio = midi = false;
306     if (Name.size() >= jack_client_name_size())
307     throw Exception("JACK client name too long");
308     if ((hJackClient = jack_client_new(Name.c_str())) == 0)
309     throw Exception("Seems Jack server is not running.");
310     jack_set_process_callback(hJackClient, linuxsampler_libjack_process_callback, this);
311     jack_on_shutdown(hJackClient, linuxsampler_libjack_shutdown_callback, this);
312     if (jack_activate(hJackClient))
313     throw Exception("Jack: Cannot activate Jack client.");
314     }
315    
316     JackClient::~JackClient() {
317     jack_client_close(hJackClient);
318     }
319    
320     void JackClient::SetAudioOutputDevice(AudioOutputDeviceJack* device) {
321     Config.GetConfigForUpdate().AudioDevice = device;
322     Config.SwitchConfig().AudioDevice = device;
323     }
324    
325 schoenebeck 1682 #if HAVE_JACK_MIDI
326 persson 1651 void JackClient::SetMidiInputDevice(MidiInputDeviceJack* device) {
327     Config.GetConfigForUpdate().MidiDevice = device;
328     Config.SwitchConfig().MidiDevice = device;
329     }
330 schoenebeck 1682 #endif
331 persson 1651
332     JackClient* JackClient::CreateAudio(String Name) { // static
333     JackClient* client;
334     std::map<String, JackClient*>::const_iterator it = Clients.find(Name);
335     if (it == Clients.end()) {
336     client = new JackClient(Name);
337     Clients[Name] = client;
338     } else {
339     client = it->second;
340     if (client->audio) throw Exception("Jack audio device '" + Name + "' already exists");
341     }
342     client->audio = true;
343     return client;
344     }
345    
346     JackClient* JackClient::CreateMidi(String Name) { // static
347     JackClient* client;
348     std::map<String, JackClient*>::const_iterator it = Clients.find(Name);
349     if (it == Clients.end()) {
350     client = new JackClient(Name);
351     Clients[Name] = client;
352     } else {
353     client = it->second;
354     if (client->midi) throw Exception("Jack MIDI device '" + Name + "' already exists");
355     }
356     client->midi = true;
357     return client;
358     }
359    
360     void JackClient::ReleaseAudio(String Name) { // static
361     JackClient* client = Clients[Name];
362     client->SetAudioOutputDevice(0);
363     client->audio = false;
364     if (!client->midi) {
365     Clients.erase(Name);
366     delete client;
367     }
368     }
369    
370     void JackClient::ReleaseMidi(String Name) { // static
371     JackClient* client = Clients[Name];
372 schoenebeck 1682 #if HAVE_JACK_MIDI
373 persson 1651 client->SetMidiInputDevice(0);
374 schoenebeck 1682 #endif
375 persson 1651 client->midi = false;
376     if (!client->audio) {
377     Clients.erase(Name);
378     delete client;
379     }
380     }
381    
382 schoenebeck 200 } // namespace LinuxSampler
383    
384     #endif // HAVE_JACK

  ViewVC Help
Powered by ViewVC