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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 289 by schoenebeck, Tue Oct 19 14:41:38 2004 UTC revision 2412 by schoenebeck, Mon Feb 4 21:52:56 2013 UTC
# Line 3  Line 3 
3   *   LinuxSampler - modular, streaming capable sampler                     *   *   LinuxSampler - modular, streaming capable sampler                     *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *   *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
6     *   Copyright (C) 2005 - 2013 Christian Schoenebeck                       *
7   *                                                                         *   *                                                                         *
8   *   This program is free software; you can redistribute it and/or modify  *   *   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  *   *   it under the terms of the GNU General Public License as published by  *
# Line 27  Line 28 
28    
29  #if HAVE_JACK  #if HAVE_JACK
30    
31    #ifndef HAVE_JACK_CLIENT_NAME_SIZE
32    #define jack_client_name_size() 33
33    #endif
34    
35  namespace LinuxSampler {  namespace LinuxSampler {
36    
37  // *************** ParameterName ***************      /// number of currently existing JACK audio output devices in LinuxSampler
38        static int existingJackDevices = 0;
39    
40    // *************** AudioChannelJack::ParameterName ***************
41  // *  // *
42    
43      AudioOutputDeviceJack::AudioChannelJack::ParameterName::ParameterName(AudioChannelJack* pChannel) : AudioChannel::ParameterName(ToString(pChannel->ChannelNr)) {      AudioOutputDeviceJack::AudioChannelJack::ParameterName::ParameterName(AudioChannelJack* pChannel) : AudioChannel::ParameterName(ToString(pChannel->ChannelNr)) {
# Line 42  namespace LinuxSampler { Line 50  namespace LinuxSampler {
50    
51    
52    
53  // *************** ParameterJackBindings ***************  // *************** AudioChannelJack::ParameterJackBindings ***************
54  // *  // *
55    
56      AudioOutputDeviceJack::AudioChannelJack::ParameterJackBindings::ParameterJackBindings(AudioChannelJack* pChannel) : DeviceRuntimeParameterStrings(std::vector<String>()) {      AudioOutputDeviceJack::AudioChannelJack::ParameterJackBindings::ParameterJackBindings(AudioChannelJack* pChannel) : DeviceRuntimeParameterStrings(std::vector<String>()) {
# Line 58  namespace LinuxSampler { Line 66  namespace LinuxSampler {
66      }      }
67    
68      std::vector<String> AudioOutputDeviceJack::AudioChannelJack::ParameterJackBindings::PossibilitiesAsString() {      std::vector<String> AudioOutputDeviceJack::AudioChannelJack::ParameterJackBindings::PossibilitiesAsString() {
69          const char** pPortNames = jack_get_ports(pChannel->pDevice->hJackClient, NULL, NULL, JackPortIsInput);          const char** pPortNames = jack_get_ports(pChannel->pDevice->hJackClient, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortIsInput);
70          if (!pPortNames) return std::vector<String>();          if (!pPortNames) return std::vector<String>();
71          std::vector<String> result;          std::vector<String> result;
72          for (int i = 0; pPortNames[i]; i++) result.push_back(pPortNames[i]);          for (int i = 0; pPortNames[i]; i++) result.push_back(pPortNames[i]);
73          //free(pPortNames); FIXME: pPortNames should be freed here          free(pPortNames);
74          return result;          return result;
75      }      }
76    
77      void AudioOutputDeviceJack::AudioChannelJack::ParameterJackBindings::OnSetValue(std::vector<String> vS) {      void AudioOutputDeviceJack::AudioChannelJack::ParameterJackBindings::OnSetValue(std::vector<String> vS) {
78          // TODO: we should remove all existing bindings before we connect new ones here          String src_name = ((DeviceCreationParameterString*)pChannel->pDevice->Parameters["NAME"])->ValueAsString() + ":" +
79          String src_name = "LinuxSampler:" + ((DeviceRuntimeParameterString*)pChannel->Parameters["NAME"])->ValueAsString();                            ((DeviceRuntimeParameterString*)pChannel->Parameters["NAME"])->ValueAsString();
80            // 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          for (int i = 0; i < vS.size(); i++) {          for (int i = 0; i < vS.size(); i++) {
87              String dst_name = vS[i];              String dst_name = vS[i];
88              int res = jack_connect(pChannel->pDevice->hJackClient, src_name.c_str(), dst_name.c_str());              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");              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 + "'");              else if (res)      throw AudioOutputException("Jack: Cannot connect port '" + src_name + "' to port '" + dst_name + "'");
91          }          }
92            // remember bindings
93            Bindings = vS;
94      }      }
95    
96      String AudioOutputDeviceJack::AudioChannelJack::ParameterJackBindings::Name() {      String AudioOutputDeviceJack::AudioChannelJack::ParameterJackBindings::Name() {
# Line 89  namespace LinuxSampler { Line 105  namespace LinuxSampler {
105      AudioOutputDeviceJack::AudioChannelJack::AudioChannelJack(uint ChannelNr, AudioOutputDeviceJack* pDevice) throw (AudioOutputException) : AudioChannel(ChannelNr, CreateJackPort(ChannelNr, pDevice), pDevice->uiMaxSamplesPerCycle) {      AudioOutputDeviceJack::AudioChannelJack::AudioChannelJack(uint ChannelNr, AudioOutputDeviceJack* pDevice) throw (AudioOutputException) : AudioChannel(ChannelNr, CreateJackPort(ChannelNr, pDevice), pDevice->uiMaxSamplesPerCycle) {
106          this->pDevice   = pDevice;          this->pDevice   = pDevice;
107          this->ChannelNr = ChannelNr;          this->ChannelNr = ChannelNr;
108            delete Parameters["NAME"];
109          Parameters["NAME"]          = new ParameterName(this);          Parameters["NAME"]          = new ParameterName(this);
110          Parameters["JACK_BINDINGS"] = new ParameterJackBindings(this);          Parameters["JACK_BINDINGS"] = new ParameterJackBindings(this);
111      }      }
# Line 103  namespace LinuxSampler { Line 120  namespace LinuxSampler {
120          if (!hJackPort) throw AudioOutputException("Jack: Cannot register Jack output port.");          if (!hJackPort) throw AudioOutputException("Jack: Cannot register Jack output port.");
121          return (float*) jack_port_get_buffer(hJackPort, pDevice->uiMaxSamplesPerCycle);          return (float*) jack_port_get_buffer(hJackPort, pDevice->uiMaxSamplesPerCycle);
122      }      }
123        
124        void AudioOutputDeviceJack::AudioChannelJack::UpdateJackBuffer(uint size) {
125            SetBuffer(
126               (float*)jack_port_get_buffer(hJackPort, size)
127            );
128        }
129    
130    
131    
132    // *************** AudioOutputDeviceJack::ParameterName ***************
133    // *
134    
135        AudioOutputDeviceJack::ParameterName::ParameterName() : DeviceCreationParameterString() {
136            InitWithDefault(); // use default name
137        }
138    
139        AudioOutputDeviceJack::ParameterName::ParameterName(String s) throw (Exception) : DeviceCreationParameterString(s) {
140        }
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        void AudioOutputDeviceJack::ParameterName::OnSetValue(String s) throw (Exception) {
167            // not possible, as parameter is fix
168        }
169    
170        String AudioOutputDeviceJack::ParameterName::Name() {
171            return "NAME";
172        }
173    
174    
175    
# Line 117  namespace LinuxSampler { Line 184  namespace LinuxSampler {
184       * @see AcquireChannels()       * @see AcquireChannels()
185       */       */
186      AudioOutputDeviceJack::AudioOutputDeviceJack(std::map<String,DeviceCreationParameter*> Parameters) : AudioOutputDevice(Parameters) {      AudioOutputDeviceJack::AudioOutputDeviceJack(std::map<String,DeviceCreationParameter*> Parameters) : AudioOutputDevice(Parameters) {
187          if ((hJackClient = jack_client_new("LinuxSampler")) == 0)          pJackClient = JackClient::CreateAudio(((DeviceCreationParameterString*)Parameters["NAME"])->ValueAsString());
188              throw AudioOutputException("Seems Jack server not running.");          existingJackDevices++;
189            pJackClient->SetAudioOutputDevice(this);
190          jack_set_process_callback(hJackClient, __libjack_process_callback, this);          hJackClient = pJackClient->hJackClient;
         jack_on_shutdown(hJackClient, __libjack_shutdown_callback, this);  
         if (jack_activate(hJackClient))  
             throw AudioOutputException("Jack: Cannot activate Jack client.");  
   
191          uiMaxSamplesPerCycle = jack_get_buffer_size(hJackClient);          uiMaxSamplesPerCycle = jack_get_buffer_size(hJackClient);
192    
193          // create audio channels          // create audio channels
# Line 135  namespace LinuxSampler { Line 198  namespace LinuxSampler {
198      }      }
199    
200      AudioOutputDeviceJack::~AudioOutputDeviceJack() {      AudioOutputDeviceJack::~AudioOutputDeviceJack() {
201          // destroy jack client          // destroy jack client if there is no midi device associated with it
202          jack_client_close(hJackClient);          JackClient::ReleaseAudio(((DeviceCreationParameterString*)Parameters["NAME"])->ValueAsString());
203            existingJackDevices--;
204      }      }
205    
206      /**      /**
# Line 144  namespace LinuxSampler { Line 208  namespace LinuxSampler {
208       * libjack to demand transmission of further sample points.       * libjack to demand transmission of further sample points.
209       */       */
210      int AudioOutputDeviceJack::Process(uint Samples) {      int AudioOutputDeviceJack::Process(uint Samples) {
211            int res;
212            
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          if (csIsPlaying.Pop()) {          if (csIsPlaying.Pop()) {
218              // let all connected engines render 'Samples' sample points              // let all connected engines render 'Samples' sample points
219              return RenderAudio(Samples);              res = RenderAudio(Samples);
220          }          }
221          else {          else {
222              // playback stop by zeroing output buffer(s) and not calling connected sampler engines to render audio              // playback stop by zeroing output buffer(s) and not calling connected sampler engines to render audio
223              return RenderSilence(Samples);              res = RenderSilence(Samples);
224          }          }
225            csIsPlaying.RttDone();
226            return res;
227        }
228        
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        
241        jack_client_t* AudioOutputDeviceJack::jackClientHandle() {
242            return hJackClient;
243      }      }
244    
245      void AudioOutputDeviceJack::Play() {      void AudioOutputDeviceJack::Play() {
# Line 159  namespace LinuxSampler { Line 247  namespace LinuxSampler {
247      }      }
248    
249      bool AudioOutputDeviceJack::IsPlaying() {      bool AudioOutputDeviceJack::IsPlaying() {
250          csIsPlaying.GetUnsafe();          return csIsPlaying.GetUnsafe();
251      }      }
252    
253      void AudioOutputDeviceJack::Stop() {      void AudioOutputDeviceJack::Stop() {
# Line 177  namespace LinuxSampler { Line 265  namespace LinuxSampler {
265      uint AudioOutputDeviceJack::SampleRate() {      uint AudioOutputDeviceJack::SampleRate() {
266          return jack_get_sample_rate(hJackClient);          return jack_get_sample_rate(hJackClient);
267      }      }
268        
269        void AudioOutputDeviceJack::addListener(JackListener* listener) {
270            pJackClient->addListener(listener);
271        }
272    
273      String AudioOutputDeviceJack::Name() {      String AudioOutputDeviceJack::Name() {
274          return "JACK";          return "JACK";
# Line 191  namespace LinuxSampler { Line 283  namespace LinuxSampler {
283      }      }
284    
285      String AudioOutputDeviceJack::Version() {      String AudioOutputDeviceJack::Version() {
286         String s = "$Revision: 1.14 $";         String s = "$Revision: 1.25 $";
287         return s.substr(11, s.size() - 13); // cut dollar signs, spaces and CVS macro keyword         return s.substr(11, s.size() - 13); // cut dollar signs, spaces and CVS macro keyword
288      }      }
289    
290    
291    
292    // *************** JackClient ***************
293    // *
294    
295      // libjack callback functions      // libjack callback functions
296    
297      int __libjack_process_callback(jack_nframes_t nframes, void* arg) {      int linuxsampler_libjack_process_callback(jack_nframes_t nframes, void* arg) {
298          AudioOutputDeviceJack* pAudioOutputDeviceJack = (AudioOutputDeviceJack*) arg;          return static_cast<JackClient*>(arg)->Process(nframes);
         return pAudioOutputDeviceJack->Process(nframes);  
299      }      }
300    
301      void __libjack_shutdown_callback(void* arg) {      void JackClient::libjackShutdownCallback(void* arg) {
302          AudioOutputDeviceJack* pAudioOutputDeviceJack = (AudioOutputDeviceJack*) arg;          JackClient* jackClient = static_cast<JackClient*>(arg);
303          pAudioOutputDeviceJack->Stop();          jackClient->Stop();
304          fprintf(stderr, "Jack: Jack server shutdown, exiting.\n");          fprintf(stderr, "Jack: Jack server shutdown, exiting.\n");
305            for (int i = 0; i < jackClient->jackListeners.size(); ++i) {
306                JackListener* listener = jackClient->jackListeners[i];
307                listener->onJackShutdown();
308            }
309        }
310        
311        int JackClient::libjackSampleRateCallback(jack_nframes_t nframes, void *arg) {
312            JackClient* client = static_cast<JackClient*>(arg);
313            const config_t& config = client->ConfigReader.Lock();
314            if (config.AudioDevice)
315                config.AudioDevice->ReconnectAll();
316            client->ConfigReader.Unlock();
317            return 0;
318        }
319        
320        int JackClient::libjackBufferSizeCallback(jack_nframes_t nframes, void *arg) {
321            dmsg(1,("libjackBufferSizeCallback(%d)\n",nframes));
322            JackClient* client = static_cast<JackClient*>(arg);
323            const config_t& config = client->ConfigReader.Lock();
324            if (config.AudioDevice) {
325                config.AudioDevice->UpdateJackBuffers(nframes);
326                config.AudioDevice->ReconnectAll();
327            }
328            client->ConfigReader.Unlock();
329            return 0;
330        }
331        
332        void JackClient::addListener(JackListener* listener) {
333            jackListeners.push_back(listener);
334        }
335    
336        std::map<String, JackClient*> JackClient::Clients;
337    
338        int JackClient::Process(uint Samples) {
339            const config_t& config = ConfigReader.Lock();
340    #if HAVE_JACK_MIDI
341            if (config.MidiDevice) config.MidiDevice->Process(Samples);
342    #endif
343            int res = config.AudioDevice ? config.AudioDevice->Process(Samples) : 0;
344            ConfigReader.Unlock();
345            return res;
346        }
347    
348        void JackClient::Stop() {
349            const config_t& config = ConfigReader.Lock();
350            if (config.AudioDevice) config.AudioDevice->Stop();
351            ConfigReader.Unlock();
352        }
353    
354        JackClient::JackClient(String Name) : ConfigReader(Config) {
355            {
356                config_t& config = Config.GetConfigForUpdate();
357                config.AudioDevice = 0;
358    #if HAVE_JACK_MIDI
359                config.MidiDevice = 0;
360    #endif
361            }
362            {
363                config_t& config = Config.SwitchConfig();
364                config.AudioDevice = 0;
365    #if HAVE_JACK_MIDI
366                config.MidiDevice = 0;
367    #endif
368            }
369            audio = midi = false;
370            if (Name.size() >= jack_client_name_size())
371                throw Exception("JACK client name too long");
372    #if HAVE_JACK_CLIENT_OPEN
373            hJackClient = jack_client_open(Name.c_str(), JackNullOption, NULL);
374    #else
375            hJackClient = jack_client_new(Name.c_str());
376    #endif
377            if (!hJackClient)
378                throw Exception("Seems Jack server is not running.");
379            jack_set_process_callback(hJackClient, linuxsampler_libjack_process_callback, this);
380            jack_on_shutdown(hJackClient, libjackShutdownCallback, this);
381            jack_set_buffer_size_callback(hJackClient, libjackBufferSizeCallback, this);
382            jack_set_sample_rate_callback(hJackClient, libjackSampleRateCallback, this);
383            
384            if (jack_activate(hJackClient))
385                throw Exception("Jack: Cannot activate Jack client.");
386        }
387    
388        JackClient::~JackClient() {
389            jack_client_close(hJackClient);
390        }
391    
392        void JackClient::SetAudioOutputDevice(AudioOutputDeviceJack* device) {
393            Config.GetConfigForUpdate().AudioDevice = device;
394            Config.SwitchConfig().AudioDevice = device;
395        }
396    
397    #if HAVE_JACK_MIDI
398        void JackClient::SetMidiInputDevice(MidiInputDeviceJack* device) {
399            Config.GetConfigForUpdate().MidiDevice = device;
400            Config.SwitchConfig().MidiDevice = device;
401        }
402    #endif
403    
404        JackClient* JackClient::CreateAudio(String Name) { // static
405            JackClient* client;
406            std::map<String, JackClient*>::const_iterator it = Clients.find(Name);
407            if (it == Clients.end()) {
408                client = new JackClient(Name);
409                Clients[Name] = client;
410            } else {
411                client = it->second;
412                if (client->audio) throw Exception("Jack audio device '" + Name + "' already exists");
413            }
414            client->audio = true;
415            return client;
416        }
417    
418        JackClient* JackClient::CreateMidi(String Name) { // static
419            JackClient* client;
420            std::map<String, JackClient*>::const_iterator it = Clients.find(Name);
421            if (it == Clients.end()) {
422                client = new JackClient(Name);
423                Clients[Name] = client;
424            } else {
425                client = it->second;
426                if (client->midi) throw Exception("Jack MIDI device '" + Name + "' already exists");
427            }
428            client->midi = true;
429            return client;
430        }
431    
432        void JackClient::ReleaseAudio(String Name) { // static
433            JackClient* client = Clients[Name];
434            client->SetAudioOutputDevice(0);
435            client->audio = false;
436            if (!client->midi) {
437                Clients.erase(Name);
438                delete client;
439            }
440        }
441    
442        void JackClient::ReleaseMidi(String Name) { // static
443            JackClient* client = Clients[Name];
444    #if HAVE_JACK_MIDI
445            client->SetMidiInputDevice(0);
446    #endif
447            client->midi = false;
448            if (!client->audio) {
449                Clients.erase(Name);
450                delete client;
451            }
452      }      }
453    
454  } // namespace LinuxSampler  } // namespace LinuxSampler

Legend:
Removed from v.289  
changed lines
  Added in v.2412

  ViewVC Help
Powered by ViewVC