3 * Copyright 2004,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_alsa_sink.h>
28 #include <gr_io_signature.h>
36 static bool CHATTY_DEBUG = false;
39 static snd_pcm_format_t acceptable_formats[] = {
40 // these are in our preferred order...
45 #define NELEMS(x) (sizeof(x)/sizeof(x[0]))
49 default_device_name ()
51 return gr_prefs::singleton()->get_string("audio_alsa", "default_output_device", "hw:0,0");
55 default_period_time ()
57 return std::max(0.001, gr_prefs::singleton()->get_double("audio_alsa", "period_time", 0.010));
63 return std::max(2L, gr_prefs::singleton()->get_long("audio_alsa", "nperiods", 4));
66 // ----------------------------------------------------------------
69 audio_alsa_make_sink (int sampling_rate,
70 const std::string dev,
73 return gnuradio::get_initial_sptr(new audio_alsa_sink (sampling_rate, dev,
77 audio_alsa_sink::audio_alsa_sink (int sampling_rate,
78 const std::string device_name,
80 : gr_sync_block ("audio_alsa_sink",
81 gr_make_io_signature (0, 0, 0),
82 gr_make_io_signature (0, 0, 0)),
83 d_sampling_rate (sampling_rate),
84 d_device_name (device_name.empty() ? default_device_name() : device_name),
86 d_hw_params ((snd_pcm_hw_params_t *)(new char[snd_pcm_hw_params_sizeof()])),
87 d_sw_params ((snd_pcm_sw_params_t *)(new char[snd_pcm_sw_params_sizeof()])),
88 d_nperiods (default_nperiods()),
89 d_period_time_us ((unsigned int) (default_period_time() * 1e6)),
91 d_buffer_size_bytes (0), d_buffer (0),
92 d_worker (0), d_special_case_mono_to_stereo (false),
93 d_nunderuns (0), d_nsuspends (0)
95 CHATTY_DEBUG = gr_prefs::singleton()->get_bool("audio_alsa", "verbose", false);
100 // open the device for playback
101 error = snd_pcm_open(&d_pcm_handle, d_device_name.c_str (),
102 SND_PCM_STREAM_PLAYBACK, 0);
104 fprintf (stderr, "audio_alsa_sink[%s]: %s\n",
105 d_device_name.c_str(), snd_strerror(error));
106 throw std::runtime_error ("audio_alsa_sink");
109 // Fill params with a full configuration space for a PCM.
110 error = snd_pcm_hw_params_any(d_pcm_handle, d_hw_params);
112 bail ("broken configuration for playback", error);
116 gri_alsa_dump_hw_params (d_pcm_handle, d_hw_params, stdout);
119 // now that we know how many channels the h/w can handle, set input signature
120 unsigned int umin_chan, umax_chan;
121 snd_pcm_hw_params_get_channels_min (d_hw_params, &umin_chan);
122 snd_pcm_hw_params_get_channels_max (d_hw_params, &umax_chan);
123 int min_chan = std::min (umin_chan, 1000U);
124 int max_chan = std::min (umax_chan, 1000U);
126 // As a special case, if the hw's min_chan is two, we'll accept
127 // a single input and handle the duplication ourselves.
131 d_special_case_mono_to_stereo = true;
133 set_input_signature (gr_make_io_signature (min_chan, max_chan,
136 // fill in portions of the d_hw_params that we know now...
138 // Specify the access methods we implement
139 // For now, we only handle RW_INTERLEAVED...
140 snd_pcm_access_mask_t *access_mask;
141 snd_pcm_access_mask_t **access_mask_ptr = &access_mask; // FIXME: workaround for compiler warning
142 snd_pcm_access_mask_alloca (access_mask_ptr);
143 snd_pcm_access_mask_none (access_mask);
144 snd_pcm_access_mask_set (access_mask, SND_PCM_ACCESS_RW_INTERLEAVED);
145 // snd_pcm_access_mask_set (access_mask, SND_PCM_ACCESS_RW_NONINTERLEAVED);
147 if ((error = snd_pcm_hw_params_set_access_mask (d_pcm_handle,
148 d_hw_params, access_mask)) < 0)
149 bail ("failed to set access mask", error);
153 if (!gri_alsa_pick_acceptable_format (d_pcm_handle, d_hw_params,
155 NELEMS (acceptable_formats),
159 throw std::runtime_error ("audio_alsa_sink");
163 unsigned int orig_sampling_rate = d_sampling_rate;
164 if ((error = snd_pcm_hw_params_set_rate_near (d_pcm_handle, d_hw_params,
165 &d_sampling_rate, 0)) < 0)
166 bail ("failed to set rate near", error);
168 if (orig_sampling_rate != d_sampling_rate){
169 fprintf (stderr, "audio_alsa_sink[%s]: unable to support sampling rate %d\n",
170 snd_pcm_name (d_pcm_handle), orig_sampling_rate);
171 fprintf (stderr, " card requested %d instead.\n", d_sampling_rate);
175 * ALSA transfers data in units of "periods".
176 * We indirectly determine the underlying buffersize by specifying
177 * the number of periods we want (typically 4) and the length of each
178 * period in units of time (typically 1ms).
180 unsigned int min_nperiods, max_nperiods;
181 snd_pcm_hw_params_get_periods_min (d_hw_params, &min_nperiods, &dir);
182 snd_pcm_hw_params_get_periods_max (d_hw_params, &max_nperiods, &dir);
183 //fprintf (stderr, "alsa_sink: min_nperiods = %d, max_nperiods = %d\n",
184 // min_nperiods, max_nperiods);
186 unsigned int orig_nperiods = d_nperiods;
187 d_nperiods = std::min (std::max (min_nperiods, d_nperiods), max_nperiods);
189 // adjust period time so that total buffering remains more-or-less constant
190 d_period_time_us = (d_period_time_us * orig_nperiods) / d_nperiods;
192 error = snd_pcm_hw_params_set_periods (d_pcm_handle, d_hw_params,
195 bail ("set_periods failed", error);
198 error = snd_pcm_hw_params_set_period_time_near (d_pcm_handle, d_hw_params,
199 &d_period_time_us, &dir);
201 bail ("set_period_time_near failed", error);
204 error = snd_pcm_hw_params_get_period_size (d_hw_params,
205 &d_period_size, &dir);
207 bail ("get_period_size failed", error);
209 set_output_multiple (d_period_size);
214 audio_alsa_sink::check_topology (int ninputs, int noutputs)
216 // ninputs is how many channels the user has connected.
217 // Now we can finish up setting up the hw params...
222 // FIXME check_topology may be called more than once.
223 // Ensure that the pcm is in a state where we can still mess with the hw_params
225 bool special_case = nchan == 1 && d_special_case_mono_to_stereo;
229 err = snd_pcm_hw_params_set_channels (d_pcm_handle, d_hw_params, nchan);
232 output_error_msg ("set_channels failed", err);
236 // set the parameters into the driver...
237 err = snd_pcm_hw_params(d_pcm_handle, d_hw_params);
239 output_error_msg ("snd_pcm_hw_params failed", err);
243 // get current s/w params
244 err = snd_pcm_sw_params_current (d_pcm_handle, d_sw_params);
246 bail ("snd_pcm_sw_params_current", err);
248 // Tell the PCM device to wait to start until we've filled
249 // it's buffers half way full. This helps avoid audio underruns.
251 err = snd_pcm_sw_params_set_start_threshold(d_pcm_handle,
253 d_nperiods * d_period_size / 2);
255 bail ("snd_pcm_sw_params_set_start_threshold", err);
257 // store the s/w params
258 err = snd_pcm_sw_params (d_pcm_handle, d_sw_params);
260 bail ("snd_pcm_sw_params", err);
262 d_buffer_size_bytes =
263 d_period_size * nchan * snd_pcm_format_size (d_format, 1);
265 d_buffer = new char [d_buffer_size_bytes];
268 fprintf (stdout, "audio_alsa_sink[%s]: sample resolution = %d bits\n",
269 snd_pcm_name (d_pcm_handle),
270 snd_pcm_hw_params_get_sbits (d_hw_params));
273 case SND_PCM_FORMAT_S16:
275 d_worker = &audio_alsa_sink::work_s16_1x2;
277 d_worker = &audio_alsa_sink::work_s16;
280 case SND_PCM_FORMAT_S32:
282 d_worker = &audio_alsa_sink::work_s32_1x2;
284 d_worker = &audio_alsa_sink::work_s32;
294 audio_alsa_sink::~audio_alsa_sink ()
296 if (snd_pcm_state (d_pcm_handle) == SND_PCM_STATE_RUNNING)
297 snd_pcm_drop (d_pcm_handle);
299 snd_pcm_close(d_pcm_handle);
300 delete [] ((char *) d_hw_params);
301 delete [] ((char *) d_sw_params);
306 audio_alsa_sink::work (int noutput_items,
307 gr_vector_const_void_star &input_items,
308 gr_vector_void_star &output_items)
310 assert ((noutput_items % d_period_size) == 0);
312 // this is a call through a pointer to a method...
313 return (this->*d_worker)(noutput_items, input_items, output_items);
317 * Work function that deals with float to S16 conversion
320 audio_alsa_sink::work_s16 (int noutput_items,
321 gr_vector_const_void_star &input_items,
322 gr_vector_void_star &output_items)
324 typedef gr_int16 sample_t; // the type of samples we're creating
325 static const int NBITS = 16; // # of bits in a sample
327 unsigned int nchan = input_items.size ();
328 const float **in = (const float **) &input_items[0];
329 sample_t *buf = (sample_t *) d_buffer;
333 unsigned int sizeof_frame = nchan * sizeof (sample_t);
334 assert (d_buffer_size_bytes == d_period_size * sizeof_frame);
336 for (n = 0; n < noutput_items; n += d_period_size){
338 // process one period of data
340 for (unsigned int i = 0; i < d_period_size; i++){
341 for (unsigned int chan = 0; chan < nchan; chan++){
342 buf[bi++] = (sample_t) (in[chan][i] * (float) ((1L << (NBITS-1)) - 1));
346 // update src pointers
347 for (unsigned int chan = 0; chan < nchan; chan++)
348 in[chan] += d_period_size;
350 if (!write_buffer (buf, d_period_size, sizeof_frame))
351 return -1; // No fixing this problem. Say we're done.
359 * Work function that deals with float to S32 conversion
362 audio_alsa_sink::work_s32 (int noutput_items,
363 gr_vector_const_void_star &input_items,
364 gr_vector_void_star &output_items)
366 typedef gr_int32 sample_t; // the type of samples we're creating
367 static const int NBITS = 32; // # of bits in a sample
369 unsigned int nchan = input_items.size ();
370 const float **in = (const float **) &input_items[0];
371 sample_t *buf = (sample_t *) d_buffer;
375 unsigned int sizeof_frame = nchan * sizeof (sample_t);
376 assert (d_buffer_size_bytes == d_period_size * sizeof_frame);
378 for (n = 0; n < noutput_items; n += d_period_size){
380 // process one period of data
382 for (unsigned int i = 0; i < d_period_size; i++){
383 for (unsigned int chan = 0; chan < nchan; chan++){
384 buf[bi++] = (sample_t) (in[chan][i] * (float) ((1L << (NBITS-1)) - 1));
388 // update src pointers
389 for (unsigned int chan = 0; chan < nchan; chan++)
390 in[chan] += d_period_size;
392 if (!write_buffer (buf, d_period_size, sizeof_frame))
393 return -1; // No fixing this problem. Say we're done.
400 * Work function that deals with float to S16 conversion and
401 * mono to stereo kludge.
404 audio_alsa_sink::work_s16_1x2 (int noutput_items,
405 gr_vector_const_void_star &input_items,
406 gr_vector_void_star &output_items)
408 typedef gr_int16 sample_t; // the type of samples we're creating
409 static const int NBITS = 16; // # of bits in a sample
411 assert (input_items.size () == 1);
412 static const unsigned int nchan = 2;
413 const float **in = (const float **) &input_items[0];
414 sample_t *buf = (sample_t *) d_buffer;
418 unsigned int sizeof_frame = nchan * sizeof (sample_t);
419 assert (d_buffer_size_bytes == d_period_size * sizeof_frame);
421 for (n = 0; n < noutput_items; n += d_period_size){
423 // process one period of data
425 for (unsigned int i = 0; i < d_period_size; i++){
426 sample_t t = (sample_t) (in[0][i] * (float) ((1L << (NBITS-1)) - 1));
431 // update src pointers
432 in[0] += d_period_size;
434 if (!write_buffer (buf, d_period_size, sizeof_frame))
435 return -1; // No fixing this problem. Say we're done.
442 * Work function that deals with float to S32 conversion and
443 * mono to stereo kludge.
446 audio_alsa_sink::work_s32_1x2 (int noutput_items,
447 gr_vector_const_void_star &input_items,
448 gr_vector_void_star &output_items)
450 typedef gr_int32 sample_t; // the type of samples we're creating
451 static const int NBITS = 32; // # of bits in a sample
453 assert (input_items.size () == 1);
454 static unsigned int nchan = 2;
455 const float **in = (const float **) &input_items[0];
456 sample_t *buf = (sample_t *) d_buffer;
460 unsigned int sizeof_frame = nchan * sizeof (sample_t);
461 assert (d_buffer_size_bytes == d_period_size * sizeof_frame);
463 for (n = 0; n < noutput_items; n += d_period_size){
465 // process one period of data
467 for (unsigned int i = 0; i < d_period_size; i++){
468 sample_t t = (sample_t) (in[0][i] * (float) ((1L << (NBITS-1)) - 1));
473 // update src pointers
474 in[0] += d_period_size;
476 if (!write_buffer (buf, d_period_size, sizeof_frame))
477 return -1; // No fixing this problem. Say we're done.
484 audio_alsa_sink::write_buffer (const void *vbuffer,
485 unsigned nframes, unsigned sizeof_frame)
487 const unsigned char *buffer = (const unsigned char *) vbuffer;
490 int r = snd_pcm_writei (d_pcm_handle, buffer, nframes);
492 continue; // try again
494 else if (r == -EPIPE){ // underrun
496 fputs ("aU", stderr);
497 if ((r = snd_pcm_prepare (d_pcm_handle)) < 0){
498 output_error_msg ("snd_pcm_prepare failed. Can't recover from underrun", r);
501 continue; // try again
504 else if (r == -ESTRPIPE){ // h/w is suspended (whatever that means)
505 // This is apparently related to power management
507 if ((r = snd_pcm_resume (d_pcm_handle)) < 0){
508 output_error_msg ("failed to resume from suspend", r);
511 continue; // try again
515 output_error_msg ("snd_pcm_writei failed", r);
520 buffer += r * sizeof_frame;
528 audio_alsa_sink::output_error_msg (const char *msg, int err)
530 fprintf (stderr, "audio_alsa_sink[%s]: %s: %s\n",
531 snd_pcm_name (d_pcm_handle), msg, snd_strerror (err));
535 audio_alsa_sink::bail (const char *msg, int err) throw (std::runtime_error)
537 output_error_msg (msg, err);
538 throw std::runtime_error ("audio_alsa_sink");