3 * Copyright 2005,2006,2010 Free Software Foundation, Inc.
5 * This file is part of GNU Radio
7 * GNU Radio is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3, or (at your option)
12 * GNU Radio is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with GNU Radio; see the file COPYING. If not, write to
19 * the Free Software Foundation, Inc., 51 Franklin Street,
20 * Boston, MA 02110-1301, USA.
27 #include <audio_jack_sink.h>
28 #include <gr_io_signature.h>
39 typedef jack_default_audio_sample_t sample_t;
42 // Number of jack buffers in the ringbuffer
43 // TODO: make it to match at least the quantity of items passed by work()
44 static const unsigned int N_BUFFERS = 16;
47 default_device_name ()
49 return gr_prefs::singleton()->get_string("audio_jack", "default_output_device", "gr_sink");
53 jack_sink_process (jack_nframes_t nframes, void *arg)
55 audio_jack_sink *self = (audio_jack_sink *)arg;
56 unsigned int read_size = nframes*sizeof(sample_t);
58 if (jack_ringbuffer_read_space (self->d_ringbuffer) < read_size) {
60 // FIXME: move this fputs out, we shouldn't use blocking calls in process()
65 char *buffer = (char *) jack_port_get_buffer (self->d_jack_output_port, nframes);
67 jack_ringbuffer_read (self->d_ringbuffer, buffer, read_size);
70 // Tell the sink thread there is room in the ringbuffer.
71 // If it is already running, the lock will not be available.
72 // We can't wait here in the process() thread, but we don't
73 // need to signal in that case, because the sink thread will
74 // check for room availability.
76 if (pthread_mutex_trylock (&self->d_jack_process_lock) == 0) {
77 pthread_cond_signal (&self->d_ringbuffer_ready);
78 pthread_mutex_unlock (&self->d_jack_process_lock);
85 // ----------------------------------------------------------------
88 audio_jack_make_sink(int sampling_rate, const std::string dev, bool ok_to_block)
90 return gnuradio::get_initial_sptr(new audio_jack_sink (sampling_rate, dev,
94 audio_jack_sink::audio_jack_sink (int sampling_rate,
95 const std::string device_name,
97 : gr_sync_block ("audio_jack_sink",
98 gr_make_io_signature (0, 0, 0),
99 gr_make_io_signature (0, 0, 0)),
100 d_sampling_rate (sampling_rate),
101 d_device_name (device_name.empty() ? default_device_name() : device_name),
102 d_ok_to_block (ok_to_block),
108 pthread_cond_init(&d_ringbuffer_ready, NULL);;
109 pthread_mutex_init(&d_jack_process_lock, NULL);
112 // try to become a client of the JACK server
113 if ((d_jack_client = jack_client_new (d_device_name.c_str ())) == 0) {
114 fprintf (stderr, "audio_jack_sink[%s]: jack server not running?\n",
115 d_device_name.c_str());
116 throw std::runtime_error ("audio_jack_sink");
119 // tell the JACK server to call `jack_sink_process()' whenever
120 // there is work to be done.
121 jack_set_process_callback (d_jack_client, &jack_sink_process, (void*)this);
123 // tell the JACK server to call `jack_shutdown()' if
124 // it ever shuts down, either entirely, or if it
125 // just decides to stop calling us.
127 //jack_on_shutdown (d_jack_client, &jack_shutdown, (void*)this);
130 jack_port_register (d_jack_client, "out",
131 JACK_DEFAULT_AUDIO_TYPE, JackPortIsOutput, 0);
134 d_jack_buffer_size = jack_get_buffer_size (d_jack_client);
136 set_output_multiple (d_jack_buffer_size);
139 jack_ringbuffer_create (N_BUFFERS*d_jack_buffer_size*sizeof(sample_t));
140 if (d_ringbuffer == NULL)
141 bail ("jack_ringbuffer_create failed", 0);
143 assert(sizeof(float)==sizeof(sample_t));
144 set_input_signature (gr_make_io_signature (1, 1, sizeof (sample_t)));
147 jack_nframes_t sample_rate = jack_get_sample_rate (d_jack_client);
149 if ((jack_nframes_t)sampling_rate != sample_rate){
150 fprintf (stderr, "audio_jack_sink[%s]: unable to support sampling rate %d\n",
151 d_device_name.c_str (), sampling_rate);
152 fprintf (stderr, " card requested %d instead.\n", sample_rate);
158 audio_jack_sink::check_topology (int ninputs, int noutputs)
163 // tell the JACK server that we are ready to roll
164 if (jack_activate (d_jack_client))
165 throw std::runtime_error ("audio_jack_sink");
170 audio_jack_sink::~audio_jack_sink ()
172 jack_client_close (d_jack_client);
173 jack_ringbuffer_free (d_ringbuffer);
177 audio_jack_sink::work (int noutput_items,
178 gr_vector_const_void_star &input_items,
179 gr_vector_void_star &output_items)
181 // write_size and work_size are in bytes
182 int work_size = noutput_items*sizeof(sample_t);
183 unsigned int write_size;
185 while (work_size > 0) {
186 unsigned int write_space; // bytes
189 while ((write_space=jack_ringbuffer_write_space (d_ringbuffer)) <
190 d_jack_buffer_size*sizeof(sample_t)) {
191 usleep(1000000*((d_jack_buffer_size-write_space/sizeof(sample_t))/d_sampling_rate));
194 // JACK actually requires POSIX
196 pthread_mutex_lock (&d_jack_process_lock);
197 while ((write_space=jack_ringbuffer_write_space (d_ringbuffer)) <
198 d_jack_buffer_size*sizeof(sample_t)) {
200 // wait until jack_sink_process() signals more room
201 pthread_cond_wait (&d_ringbuffer_ready, &d_jack_process_lock);
203 pthread_mutex_unlock (&d_jack_process_lock);
206 write_space -= write_space%(d_jack_buffer_size*sizeof(sample_t));
207 write_size = std::min(write_space, (unsigned int)work_size);
209 if (jack_ringbuffer_write (d_ringbuffer, (char *) input_items[0],
210 write_size) < write_size) {
211 bail ("jack_ringbuffer_write failed", 0);
213 work_size -= write_size;
216 return noutput_items;
220 audio_jack_sink::output_error_msg (const char *msg, int err)
222 fprintf (stderr, "audio_jack_sink[%s]: %s: %d\n",
223 d_device_name.c_str (), msg, err);
227 audio_jack_sink::bail (const char *msg, int err) throw (std::runtime_error)
229 output_error_msg (msg, err);
230 throw std::runtime_error ("audio_jack_sink");