drivers/audio/AudioOutputDeviceJack.cpp

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
 *   Copyright (C) 2005 - 2013 Christian Schoenebeck                       *
 *                                                                         *
 *   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., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 ***************************************************************************/

#include "AudioOutputDeviceJack.h"
#include "AudioOutputDeviceFactory.h"

#include <errno.h>

#if HAVE_JACK

#ifndef HAVE_JACK_CLIENT_NAME_SIZE
#define jack_client_name_size() 33
#endif

namespace LinuxSampler {

    /// number of currently existing JACK audio output devices in LinuxSampler
    static int existingJackDevices = 0;

// *************** AudioChannelJack::ParameterName ***************
// *

    AudioOutputDeviceJack::AudioChannelJack::ParameterName::ParameterName(AudioChannelJack* pChannel) : AudioChannel::ParameterName(ToString(pChannel->ChannelNr)) {
        this->pChannel = pChannel;
    }

    void AudioOutputDeviceJack::AudioChannelJack::ParameterName::OnSetValue(String s) {
        if (jack_port_set_name(pChannel->hJackPort, s.c_str())) throw AudioOutputException("Failed to rename JACK port");
    }


// *************** AudioChannelJack::ParameterJackBindings ***************
// *

    AudioOutputDeviceJack::AudioChannelJack::ParameterJackBindings::ParameterJackBindings(AudioChannelJack* pChannel) : DeviceRuntimeParameterStrings(std::vector<String>()) {
        this->pChannel = pChannel;
    }

    String AudioOutputDeviceJack::AudioChannelJack::ParameterJackBindings::Description() {
        return "Bindings to other JACK clients";
    }

    bool AudioOutputDeviceJack::AudioChannelJack::ParameterJackBindings::Fix() {
        return false;
    }

    std::vector<String> AudioOutputDeviceJack::AudioChannelJack::ParameterJackBindings::PossibilitiesAsString() {
        const char** pPortNames = jack_get_ports(pChannel->pDevice->hJackClient, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortIsInput);
        if (!pPortNames) return std::vector<String>();
        std::vector<String> result;
        for (int i = 0; pPortNames[i]; i++) result.push_back(pPortNames[i]);
        free(pPortNames);
        return result;
    }

    void AudioOutputDeviceJack::AudioChannelJack::ParameterJackBindings::OnSetValue(std::vector<String> vS) {
        String src_name = ((DeviceCreationParameterString*)pChannel->pDevice->Parameters["NAME"])->ValueAsString() + ":" +
                          ((DeviceRuntimeParameterString*)pChannel->Parameters["NAME"])->ValueAsString();
        // disconnect all current bindings first
        for (int i = 0; i < Bindings.size(); i++) {
            String dst_name = Bindings[i];
            int res = jack_disconnect(pChannel->pDevice->hJackClient, src_name.c_str(), dst_name.c_str());
        }
        // connect new bindings
        for (int i = 0; i < vS.size(); i++) {
            String dst_name = vS[i];
            int res = jack_connect(pChannel->pDevice->hJackClient, src_name.c_str(), dst_name.c_str());
            if (res == EEXIST) throw AudioOutputException("Jack: Connection to port '" + dst_name + "' already established");
            else if (res)      throw AudioOutputException("Jack: Cannot connect port '" + src_name + "' to port '" + dst_name + "'");
        }
        // remember bindings
        Bindings = vS;
    }

    String AudioOutputDeviceJack::AudioChannelJack::ParameterJackBindings::Name() {
        return "JACK_BINDINGS";
    }


// *************** AudioChannelJack ***************
// *

    AudioOutputDeviceJack::AudioChannelJack::AudioChannelJack(uint ChannelNr, AudioOutputDeviceJack* pDevice) throw (AudioOutputException) : AudioChannel(ChannelNr, CreateJackPort(ChannelNr, pDevice), pDevice->uiMaxSamplesPerCycle) {
        this->pDevice   = pDevice;
        this->ChannelNr = ChannelNr;
        delete Parameters["NAME"];
        Parameters["NAME"]          = new ParameterName(this);
        Parameters["JACK_BINDINGS"] = new ParameterJackBindings(this);
    }

    AudioOutputDeviceJack::AudioChannelJack::~AudioChannelJack() {
        //TODO: delete JACK port
    }

    float* AudioOutputDeviceJack::AudioChannelJack::CreateJackPort(uint ChannelNr, AudioOutputDeviceJack* pDevice) throw (AudioOutputException) {
        String port_id = ToString(ChannelNr);
        hJackPort = jack_port_register(pDevice->hJackClient, port_id.c_str(), JACK_DEFAULT_AUDIO_TYPE, JackPortIsOutput, 0);
        if (!hJackPort) throw AudioOutputException("Jack: Cannot register Jack output port.");
        return (float*) jack_port_get_buffer(hJackPort, pDevice->uiMaxSamplesPerCycle);
    }
    
    void AudioOutputDeviceJack::AudioChannelJack::UpdateJackBuffer(uint size) {
        SetBuffer(
           (float*)jack_port_get_buffer(hJackPort, size)
        );
    }


// *************** AudioOutputDeviceJack::ParameterName ***************
// *

    AudioOutputDeviceJack::ParameterName::ParameterName() : DeviceCreationParameterString() {
        InitWithDefault(); // use default name
    }

    AudioOutputDeviceJack::ParameterName::ParameterName(String s) throw (Exception) : DeviceCreationParameterString(s) {
    }

    String AudioOutputDeviceJack::ParameterName::Description() {
        return "Arbitrary JACK client name";
    }

    bool AudioOutputDeviceJack::ParameterName::Fix() {
        return true;
    }

    bool AudioOutputDeviceJack::ParameterName::Mandatory() {
        return false;
    }

    std::map<String,DeviceCreationParameter*> AudioOutputDeviceJack::ParameterName::DependsAsParameters() {
        return std::map<String,DeviceCreationParameter*>(); // no dependencies
    }

    std::vector<String> AudioOutputDeviceJack::ParameterName::PossibilitiesAsString(std::map<String,String> Parameters) {
        return std::vector<String>();
    }

    optional<String> AudioOutputDeviceJack::ParameterName::DefaultAsString(std::map<String,String> Parameters) {
        return (existingJackDevices) ? "LinuxSampler" + ToString(existingJackDevices) : "LinuxSampler";
    }

    void AudioOutputDeviceJack::ParameterName::OnSetValue(String s) throw (Exception) {
        // not possible, as parameter is fix
    }

    String AudioOutputDeviceJack::ParameterName::Name() {
        return "NAME";
    }


// *************** AudioOutputDeviceJack ***************
// *

    /**
     * Open and initialize connection to the JACK system.
     *
     * @param Parameters - optional parameters
     * @throws AudioOutputException  on error
     * @see AcquireChannels()
     */
    AudioOutputDeviceJack::AudioOutputDeviceJack(std::map<String,DeviceCreationParameter*> Parameters) : AudioOutputDevice(Parameters) {
        JackClient* pJackClient = JackClient::CreateAudio(((DeviceCreationParameterString*)Parameters["NAME"])->ValueAsString());
        existingJackDevices++;
        pJackClient->SetAudioOutputDevice(this);
        hJackClient = pJackClient->hJackClient;
        uiMaxSamplesPerCycle = jack_get_buffer_size(hJackClient);

        // create audio channels
        AcquireChannels(((DeviceCreationParameterInt*)Parameters["CHANNELS"])->ValueAsInt());

        // finally activate device if desired
        if (((DeviceCreationParameterBool*)Parameters["ACTIVE"])->ValueAsBool()) Play();
    }

    AudioOutputDeviceJack::~AudioOutputDeviceJack() {
        // destroy jack client if there is no midi device associated with it
        JackClient::ReleaseAudio(((DeviceCreationParameterString*)Parameters["NAME"])->ValueAsString());
        existingJackDevices--;
    }

    /**
     * This method should not be called directly! It will be called by
     * libjack to demand transmission of further sample points.
     */
    int AudioOutputDeviceJack::Process(uint Samples) {
        int res;
        
        // in recent versions of JACK2 and JACk1, we are forced to
        // re-retrieve the audio buffer pointers in each process period
        UpdateJackBuffers(Samples);
        
        if (csIsPlaying.Pop()) {
            // let all connected engines render 'Samples' sample points
            res = RenderAudio(Samples);
        }
        else {
            // playback stop by zeroing output buffer(s) and not calling connected sampler engines to render audio
            res = RenderSilence(Samples);
        }
        csIsPlaying.RttDone();
        return res;
    }
    
    void AudioOutputDeviceJack::UpdateJackBuffers(uint size) {
        for (int i = 0; i < Channels.size(); ++i)
            static_cast<AudioChannelJack*>(Channels[i])->UpdateJackBuffer(size);
    }
    
    float AudioOutputDeviceJack::latency() {
        if (!hJackClient) return -1;
        const float size = jack_get_buffer_size(hJackClient);
        const float rate = jack_get_sample_rate(hJackClient);
        return size / rate;
    }

    void AudioOutputDeviceJack::Play() {
        csIsPlaying.PushAndUnlock(true);
    }

    bool AudioOutputDeviceJack::IsPlaying() {
        return csIsPlaying.GetUnsafe();
    }

    void AudioOutputDeviceJack::Stop() {
        csIsPlaying.PushAndUnlock(false);
    }

    AudioChannel* AudioOutputDeviceJack::CreateChannel(uint ChannelNr) {
        return new AudioChannelJack(ChannelNr, this);
    }

    uint AudioOutputDeviceJack::MaxSamplesPerCycle() {
        return jack_get_buffer_size(hJackClient);
    }

    uint AudioOutputDeviceJack::SampleRate() {
        return jack_get_sample_rate(hJackClient);
    }

    String AudioOutputDeviceJack::Name() {
        return "JACK";
    }

    String AudioOutputDeviceJack::Driver() {
        return Name();
    }

    String AudioOutputDeviceJack::Description() {
        return "JACK Audio Connection Kit";
    }

    String AudioOutputDeviceJack::Version() {
       String s = "$Revision: 1.25 $";
       return s.substr(11, s.size() - 13); // cut dollar signs, spaces and CVS macro keyword
    }


// *************** JackClient ***************
// *

    // libjack callback functions

    int linuxsampler_libjack_process_callback(jack_nframes_t nframes, void* arg) {
        return static_cast<JackClient*>(arg)->Process(nframes);
    }

    void linuxsampler_libjack_shutdown_callback(void* arg) {
        static_cast<JackClient*>(arg)->Stop();
        fprintf(stderr, "Jack: Jack server shutdown, exiting.\n");
    }
    
    int JackClient::libjackSampleRateCallback(jack_nframes_t nframes, void *arg) {
        JackClient* client = static_cast<JackClient*>(arg);
        const config_t& config = client->ConfigReader.Lock();
        if (config.AudioDevice)
            config.AudioDevice->ReconnectAll();
        client->ConfigReader.Unlock();
        return 0;
    }
    
    int JackClient::libjackBufferSizeCallback(jack_nframes_t nframes, void *arg) {
        dmsg(1,("libjackBufferSizeCallback(%d)\n",nframes));
        JackClient* client = static_cast<JackClient*>(arg);
        const config_t& config = client->ConfigReader.Lock();
        if (config.AudioDevice) {
            config.AudioDevice->UpdateJackBuffers(nframes);
            config.AudioDevice->ReconnectAll();
        }
        client->ConfigReader.Unlock();
        return 0;
    }

    std::map<String, JackClient*> JackClient::Clients;

    int JackClient::Process(uint Samples) {
        const config_t& config = ConfigReader.Lock();
#if HAVE_JACK_MIDI
        if (config.MidiDevice) config.MidiDevice->Process(Samples);
#endif
        int res = config.AudioDevice ? config.AudioDevice->Process(Samples) : 0;
        ConfigReader.Unlock();
        return res;
    }

    void JackClient::Stop() {
        const config_t& config = ConfigReader.Lock();
        if (config.AudioDevice) config.AudioDevice->Stop();
        ConfigReader.Unlock();
    }

    JackClient::JackClient(String Name) : ConfigReader(Config) {
        {
            config_t& config = Config.GetConfigForUpdate();
            config.AudioDevice = 0;
#if HAVE_JACK_MIDI
            config.MidiDevice = 0;
#endif
        }
        {
            config_t& config = Config.SwitchConfig();
            config.AudioDevice = 0;
#if HAVE_JACK_MIDI
            config.MidiDevice = 0;
#endif
        }
        audio = midi = false;
        if (Name.size() >= jack_client_name_size())
            throw Exception("JACK client name too long");
#if HAVE_JACK_CLIENT_OPEN
        hJackClient = jack_client_open(Name.c_str(), JackNullOption, NULL);
#else
        hJackClient = jack_client_new(Name.c_str());
#endif
        if (!hJackClient)
            throw Exception("Seems Jack server is not running.");
        jack_set_process_callback(hJackClient, linuxsampler_libjack_process_callback, this);
        jack_on_shutdown(hJackClient, linuxsampler_libjack_shutdown_callback, this);
        jack_set_buffer_size_callback(hJackClient, libjackBufferSizeCallback, this);
        jack_set_sample_rate_callback(hJackClient, libjackSampleRateCallback, this);
        
        if (jack_activate(hJackClient))
            throw Exception("Jack: Cannot activate Jack client.");
    }

    JackClient::~JackClient() {
        jack_client_close(hJackClient);
    }

    void JackClient::SetAudioOutputDevice(AudioOutputDeviceJack* device) {
        Config.GetConfigForUpdate().AudioDevice = device;
        Config.SwitchConfig().AudioDevice = device;
    }

#if HAVE_JACK_MIDI
    void JackClient::SetMidiInputDevice(MidiInputDeviceJack* device) {
        Config.GetConfigForUpdate().MidiDevice = device;
        Config.SwitchConfig().MidiDevice = device;
    }
#endif

    JackClient* JackClient::CreateAudio(String Name) { // static
        JackClient* client;
        std::map<String, JackClient*>::const_iterator it = Clients.find(Name);
        if (it == Clients.end()) {
            client = new JackClient(Name);
            Clients[Name] = client;
        } else {
            client = it->second;
            if (client->audio) throw Exception("Jack audio device '" + Name + "' already exists");
        }
        client->audio = true;
        return client;
    }

    JackClient* JackClient::CreateMidi(String Name) { // static
        JackClient* client;
        std::map<String, JackClient*>::const_iterator it = Clients.find(Name);
        if (it == Clients.end()) {
            client = new JackClient(Name);
            Clients[Name] = client;
        } else {
            client = it->second;
            if (client->midi) throw Exception("Jack MIDI device '" + Name + "' already exists");
        }
        client->midi = true;
        return client;
    }

    void JackClient::ReleaseAudio(String Name) { // static
        JackClient* client = Clients[Name];
        client->SetAudioOutputDevice(0);
        client->audio = false;
        if (!client->midi) {
            Clients.erase(Name);
            delete client;
        }
    }

    void JackClient::ReleaseMidi(String Name) { // static
        JackClient* client = Clients[Name];
#if HAVE_JACK_MIDI
        client->SetMidiInputDevice(0);
#endif
        client->midi = false;
        if (!client->audio) {
            Clients.erase(Name);
            delete client;
        }
    }

} // namespace LinuxSampler

#endif // HAVE_JACK
1	schoenebeck	200	/***************************************************************************
2			* *
3			* LinuxSampler - modular, streaming capable sampler *
4			* *
5			* Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6	schoenebeck	2410	* Copyright (C) 2005 - 2013 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	schoenebeck	2410
124			void AudioOutputDeviceJack::AudioChannelJack::UpdateJackBuffer(uint size) {
125			SetBuffer(
126			(float*)jack_port_get_buffer(hJackPort, size)
127			);
128			}
129	schoenebeck	226
130
131
132	schoenebeck	374	// ************* AudioOutputDeviceJack::ParameterName *************
133			// *
134
135			AudioOutputDeviceJack::ParameterName::ParameterName() : DeviceCreationParameterString() {
136			InitWithDefault(); // use default name
137			}
138
139	schoenebeck	880	AudioOutputDeviceJack::ParameterName::ParameterName(String s) throw (Exception) : DeviceCreationParameterString(s) {
140	schoenebeck	374	}
141
142			String AudioOutputDeviceJack::ParameterName::Description() {
143			return "Arbitrary JACK client name";
144			}
145
146			bool AudioOutputDeviceJack::ParameterName::Fix() {
147			return true;
148			}
149
150			bool AudioOutputDeviceJack::ParameterName::Mandatory() {
151			return false;
152			}
153
154			std::map<String,DeviceCreationParameter*> AudioOutputDeviceJack::ParameterName::DependsAsParameters() {
155			return std::map<String,DeviceCreationParameter*>(); // no dependencies
156			}
157
158			std::vector<String> AudioOutputDeviceJack::ParameterName::PossibilitiesAsString(std::map<String,String> Parameters) {
159			return std::vector<String>();
160			}
161
162			optional<String> AudioOutputDeviceJack::ParameterName::DefaultAsString(std::map<String,String> Parameters) {
163			return (existingJackDevices) ? "LinuxSampler" + ToString(existingJackDevices) : "LinuxSampler";
164			}
165
166	schoenebeck	880	void AudioOutputDeviceJack::ParameterName::OnSetValue(String s) throw (Exception) {
167	schoenebeck	374	// not possible, as parameter is fix
168			}
169
170			String AudioOutputDeviceJack::ParameterName::Name() {
171			return "NAME";
172			}
173
174
175
176	schoenebeck	226	// ************* AudioOutputDeviceJack *************
177			// *
178
179	schoenebeck	200	/**
180			* Open and initialize connection to the JACK system.
181			*
182			* @param Parameters - optional parameters
183			* @throws AudioOutputException on error
184			* @see AcquireChannels()
185			*/
186	schoenebeck	226	AudioOutputDeviceJack::AudioOutputDeviceJack(std::map<String,DeviceCreationParameter*> Parameters) : AudioOutputDevice(Parameters) {
187	persson	1651	JackClient* pJackClient = JackClient::CreateAudio(((DeviceCreationParameterString*)Parameters["NAME"])->ValueAsString());
188	schoenebeck	374	existingJackDevices++;
189	persson	1651	pJackClient->SetAudioOutputDevice(this);
190			hJackClient = pJackClient->hJackClient;
191	schoenebeck	200	uiMaxSamplesPerCycle = jack_get_buffer_size(hJackClient);
192
193	schoenebeck	226	// create audio channels
194			AcquireChannels(((DeviceCreationParameterInt*)Parameters["CHANNELS"])->ValueAsInt());
195	schoenebeck	227
196			// finally activate device if desired
197			if (((DeviceCreationParameterBool*)Parameters["ACTIVE"])->ValueAsBool()) Play();
198	schoenebeck	200	}
199
200			AudioOutputDeviceJack::~AudioOutputDeviceJack() {
201	persson	1651	// destroy jack client if there is no midi device associated with it
202			JackClient::ReleaseAudio(((DeviceCreationParameterString*)Parameters["NAME"])->ValueAsString());
203	schoenebeck	374	existingJackDevices--;
204	schoenebeck	200	}
205
206			/**
207			* This method should not be called directly! It will be called by
208			* libjack to demand transmission of further sample points.
209			*/
210			int AudioOutputDeviceJack::Process(uint Samples) {
211	persson	1764	int res;
212	schoenebeck	2410
213			// in recent versions of JACK2 and JACk1, we are forced to
214			// re-retrieve the audio buffer pointers in each process period
215			UpdateJackBuffers(Samples);
216
217	schoenebeck	200	if (csIsPlaying.Pop()) {
218			// let all connected engines render 'Samples' sample points
219	persson	1764	res = RenderAudio(Samples);
220	schoenebeck	200	}
221			else {
222			// playback stop by zeroing output buffer(s) and not calling connected sampler engines to render audio
223	persson	1764	res = RenderSilence(Samples);
224	schoenebeck	200	}
225	persson	1764	csIsPlaying.RttDone();
226			return res;
227	schoenebeck	200	}
228	schoenebeck	2410
229			void AudioOutputDeviceJack::UpdateJackBuffers(uint size) {
230			for (int i = 0; i < Channels.size(); ++i)
231			static_cast<AudioChannelJack*>(Channels[i])->UpdateJackBuffer(size);
232			}
233
234			float AudioOutputDeviceJack::latency() {
235			if (!hJackClient) return -1;
236			const float size = jack_get_buffer_size(hJackClient);
237			const float rate = jack_get_sample_rate(hJackClient);
238			return size / rate;
239			}
240	schoenebeck	200
241			void AudioOutputDeviceJack::Play() {
242			csIsPlaying.PushAndUnlock(true);
243			}
244
245			bool AudioOutputDeviceJack::IsPlaying() {
246	persson	497	return csIsPlaying.GetUnsafe();
247	schoenebeck	200	}
248
249			void AudioOutputDeviceJack::Stop() {
250			csIsPlaying.PushAndUnlock(false);
251			}
252
253	schoenebeck	226	AudioChannel* AudioOutputDeviceJack::CreateChannel(uint ChannelNr) {
254			return new AudioChannelJack(ChannelNr, this);
255	schoenebeck	200	}
256
257			uint AudioOutputDeviceJack::MaxSamplesPerCycle() {
258			return jack_get_buffer_size(hJackClient);
259			}
260
261			uint AudioOutputDeviceJack::SampleRate() {
262			return jack_get_sample_rate(hJackClient);
263			}
264
265			String AudioOutputDeviceJack::Name() {
266	schoenebeck	221	return "JACK";
267	schoenebeck	200	}
268
269			String AudioOutputDeviceJack::Driver() {
270			return Name();
271			}
272
273			String AudioOutputDeviceJack::Description() {
274			return "JACK Audio Connection Kit";
275			}
276
277			String AudioOutputDeviceJack::Version() {
278	persson	1764	String s = "$Revision: 1.25 $";
279	schoenebeck	200	return s.substr(11, s.size() - 13); // cut dollar signs, spaces and CVS macro keyword
280			}
281
282	persson	1651
283
284			// ************* JackClient *************
285			// *
286
287	schoenebeck	200	// libjack callback functions
288
289	persson	1651	int linuxsampler_libjack_process_callback(jack_nframes_t nframes, void* arg) {
290			return static_cast<JackClient*>(arg)->Process(nframes);
291	schoenebeck	200	}
292
293	persson	1651	void linuxsampler_libjack_shutdown_callback(void* arg) {
294			static_cast<JackClient*>(arg)->Stop();
295	schoenebeck	200	fprintf(stderr, "Jack: Jack server shutdown, exiting.\n");
296			}
297	schoenebeck	2410
298			int JackClient::libjackSampleRateCallback(jack_nframes_t nframes, void *arg) {
299			JackClient* client = static_cast<JackClient*>(arg);
300			const config_t& config = client->ConfigReader.Lock();
301			if (config.AudioDevice)
302			config.AudioDevice->ReconnectAll();
303			client->ConfigReader.Unlock();
304			return 0;
305			}
306
307			int JackClient::libjackBufferSizeCallback(jack_nframes_t nframes, void *arg) {
308			dmsg(1,("libjackBufferSizeCallback(%d)\n",nframes));
309			JackClient* client = static_cast<JackClient*>(arg);
310			const config_t& config = client->ConfigReader.Lock();
311			if (config.AudioDevice) {
312			config.AudioDevice->UpdateJackBuffers(nframes);
313			config.AudioDevice->ReconnectAll();
314			}
315			client->ConfigReader.Unlock();
316			return 0;
317			}
318	schoenebeck	200
319	persson	1651	std::map<String, JackClient*> JackClient::Clients;
320
321			int JackClient::Process(uint Samples) {
322			const config_t& config = ConfigReader.Lock();
323			#if HAVE_JACK_MIDI
324			if (config.MidiDevice) config.MidiDevice->Process(Samples);
325			#endif
326			int res = config.AudioDevice ? config.AudioDevice->Process(Samples) : 0;
327			ConfigReader.Unlock();
328			return res;
329			}
330
331			void JackClient::Stop() {
332			const config_t& config = ConfigReader.Lock();
333			if (config.AudioDevice) config.AudioDevice->Stop();
334			ConfigReader.Unlock();
335			}
336
337			JackClient::JackClient(String Name) : ConfigReader(Config) {
338			{
339			config_t& config = Config.GetConfigForUpdate();
340			config.AudioDevice = 0;
341	schoenebeck	1682	#if HAVE_JACK_MIDI
342	persson	1651	config.MidiDevice = 0;
343	schoenebeck	1682	#endif
344	persson	1651	}
345			{
346			config_t& config = Config.SwitchConfig();
347			config.AudioDevice = 0;
348	schoenebeck	1682	#if HAVE_JACK_MIDI
349	persson	1651	config.MidiDevice = 0;
350	schoenebeck	1682	#endif
351	persson	1651	}
352			audio = midi = false;
353			if (Name.size() >= jack_client_name_size())
354			throw Exception("JACK client name too long");
355	persson	1748	#if HAVE_JACK_CLIENT_OPEN
356			hJackClient = jack_client_open(Name.c_str(), JackNullOption, NULL);
357			#else
358			hJackClient = jack_client_new(Name.c_str());
359			#endif
360			if (!hJackClient)
361	persson	1651	throw Exception("Seems Jack server is not running.");
362			jack_set_process_callback(hJackClient, linuxsampler_libjack_process_callback, this);
363			jack_on_shutdown(hJackClient, linuxsampler_libjack_shutdown_callback, this);
364	schoenebeck	2410	jack_set_buffer_size_callback(hJackClient, libjackBufferSizeCallback, this);
365			jack_set_sample_rate_callback(hJackClient, libjackSampleRateCallback, this);
366
367	persson	1651	if (jack_activate(hJackClient))
368			throw Exception("Jack: Cannot activate Jack client.");
369			}
370
371			JackClient::~JackClient() {
372			jack_client_close(hJackClient);
373			}
374
375			void JackClient::SetAudioOutputDevice(AudioOutputDeviceJack* device) {
376			Config.GetConfigForUpdate().AudioDevice = device;
377			Config.SwitchConfig().AudioDevice = device;
378			}
379
380	schoenebeck	1682	#if HAVE_JACK_MIDI
381	persson	1651	void JackClient::SetMidiInputDevice(MidiInputDeviceJack* device) {
382			Config.GetConfigForUpdate().MidiDevice = device;
383			Config.SwitchConfig().MidiDevice = device;
384			}
385	schoenebeck	1682	#endif
386	persson	1651
387			JackClient* JackClient::CreateAudio(String Name) { // static
388			JackClient* client;
389			std::map<String, JackClient*>::const_iterator it = Clients.find(Name);
390			if (it == Clients.end()) {
391			client = new JackClient(Name);
392			Clients[Name] = client;
393			} else {
394			client = it->second;
395			if (client->audio) throw Exception("Jack audio device '" + Name + "' already exists");
396			}
397			client->audio = true;
398			return client;
399			}
400
401			JackClient* JackClient::CreateMidi(String Name) { // static
402			JackClient* client;
403			std::map<String, JackClient*>::const_iterator it = Clients.find(Name);
404			if (it == Clients.end()) {
405			client = new JackClient(Name);
406			Clients[Name] = client;
407			} else {
408			client = it->second;
409			if (client->midi) throw Exception("Jack MIDI device '" + Name + "' already exists");
410			}
411			client->midi = true;
412			return client;
413			}
414
415			void JackClient::ReleaseAudio(String Name) { // static
416			JackClient* client = Clients[Name];
417			client->SetAudioOutputDevice(0);
418			client->audio = false;
419			if (!client->midi) {
420			Clients.erase(Name);
421			delete client;
422			}
423			}
424
425			void JackClient::ReleaseMidi(String Name) { // static
426			JackClient* client = Clients[Name];
427	schoenebeck	1682	#if HAVE_JACK_MIDI
428	persson	1651	client->SetMidiInputDevice(0);
429	schoenebeck	1682	#endif
430	persson	1651	client->midi = false;
431			if (!client->audio) {
432			Clients.erase(Name);
433			delete client;
434			}
435			}
436
437	schoenebeck	200	} // namespace LinuxSampler
438
439			#endif // HAVE_JACK