alsa_write.c

   1 /*
   2  * Copyright (C) 2005-2013 Andre Noll <maan@systemlinux.org>
   3  *
   4  * Licensed under the GPL v2. For licencing details see COPYING.
   5  */
   6
   7 /** \file alsa_write.c paraslash's alsa output plugin */
   8
   9 /*
  10  * Based in parts on aplay.c from the alsa-utils-1.0.8 package,
  11  * Copyright (c) by Jaroslav Kysela <perex@suse.cz>, which is
  12  * based on the vplay program by Michael Beck.
  13  */
  14
  15 #include <regex.h>
  16 #include <sys/types.h>
  17 #include <alsa/asoundlib.h>
  18
  19 #include "para.h"
  20 #include "fd.h"
  21 #include "string.h"
  22 #include "list.h"
  23 #include "sched.h"
  24 #include "ggo.h"
  25 #include "buffer_tree.h"
  26 #include "write.h"
  27 #include "write_common.h"
  28 #include "alsa_write.cmdline.h"
  29 #include "error.h"
  30
  31 /** Data specific to the alsa writer. */
  32 struct private_alsa_write_data {
  33         /** The alsa handle */
  34         snd_pcm_t *handle;
  35         /** Determined and set by alsa_init(). */
  36         int bytes_per_frame;
  37         /*
  38          * If the sample rate is not given at the command line and no wav
  39          * header was detected, the btr exec mechanism is employed to query the
  40          * ancestor buffer tree nodes for this information. In a typical setup
  41          * the decoder passes the sample rate back to the alsa writer.
  42          *
  43          *  \sa \ref btr_exec_up().
  44          */
  45         unsigned sample_rate;
  46         /*
  47          * The sample format (8/16 bit, signed/unsigned, little/big endian) is
  48          * determined in the same way as the \a sample_rate.
  49          */
  50         snd_pcm_format_t sample_format;
  51         /* The number of channels, again determined like \a sample_rate. */
  52         unsigned channels;
  53         struct timeval drain_barrier;
  54         /* File descriptor for select(). */
  55         int poll_fd;
  56 };
  57
  58 static snd_pcm_format_t get_alsa_pcm_format(enum sample_format sf)
  59 {
  60         switch (sf) {
  61         case SF_S8: return SND_PCM_FORMAT_S8;
  62         case SF_U8: return SND_PCM_FORMAT_U8;
  63         case SF_S16_LE: return SND_PCM_FORMAT_S16_LE;
  64         case SF_S16_BE: return SND_PCM_FORMAT_S16_BE;
  65         case SF_U16_LE: return SND_PCM_FORMAT_U16_LE;
  66         case SF_U16_BE: return SND_PCM_FORMAT_U16_BE;
  67         default: return SND_PCM_FORMAT_S16_LE;
  68         }
  69 }
  70
  71 /* Install PCM software and hardware configuration. */
  72 static int alsa_init(struct private_alsa_write_data *pad,
  73                 struct alsa_write_args_info *conf)
  74 {
  75         snd_pcm_hw_params_t *hwparams;
  76         snd_pcm_sw_params_t *swparams;
  77         snd_pcm_uframes_t start_threshold, stop_threshold;
  78         snd_pcm_uframes_t buffer_size, period_size;
  79         snd_output_t *output_log;
  80         unsigned buffer_time;
  81         int ret;
  82         const char *msg;
  83
  84         PARA_INFO_LOG("opening %s\n", conf->device_arg);
  85         msg = "unable to open pcm";
  86         ret = snd_pcm_open(&pad->handle, conf->device_arg,
  87                 SND_PCM_STREAM_PLAYBACK, SND_PCM_NONBLOCK);
  88         if (ret < 0)
  89                 goto fail;
  90         snd_pcm_hw_params_alloca(&hwparams);
  91         msg = "Broken alsa configuration";
  92         ret = snd_pcm_hw_params_any(pad->handle, hwparams);
  93         if (ret < 0)
  94                 goto fail;
  95         msg = "access type not available";
  96         ret = snd_pcm_hw_params_set_access(pad->handle, hwparams,
  97                 SND_PCM_ACCESS_RW_INTERLEAVED);
  98         if (ret < 0)
  99                 goto fail;
 100         msg = "sample format not available";
 101         ret = snd_pcm_hw_params_set_format(pad->handle, hwparams,
 102                 pad->sample_format);
 103         if (ret < 0)
 104                 goto fail;
 105         msg = "channels count not available";
 106         ret = snd_pcm_hw_params_set_channels(pad->handle, hwparams,
 107                 pad->channels);
 108         if (ret < 0)
 109                 goto fail;
 110         msg = "could not set sample rate";
 111         ret = snd_pcm_hw_params_set_rate_near(pad->handle, hwparams,
 112                 &pad->sample_rate, NULL);
 113         if (ret < 0)
 114                 goto fail;
 115         msg = "unable to get buffer time";
 116         ret = snd_pcm_hw_params_get_buffer_time_max(hwparams, &buffer_time,
 117                 NULL);
 118         if (ret < 0 || buffer_time == 0)
 119                 goto fail;
 120         /* buffer at most 500 milliseconds */
 121         buffer_time = PARA_MIN(buffer_time, 500U * 1000U);
 122         msg = "could not set buffer time";
 123         ret = snd_pcm_hw_params_set_buffer_time_near(pad->handle, hwparams,
 124                 &buffer_time, NULL);
 125         if (ret < 0)
 126                 goto fail;
 127         msg = "unable to install hw params";
 128         ret = snd_pcm_hw_params(pad->handle, hwparams);
 129         if (ret < 0)
 130                 goto fail;
 131         snd_pcm_hw_params_get_period_size(hwparams, &period_size, NULL);
 132         snd_pcm_hw_params_get_buffer_size(hwparams, &buffer_size);
 133         msg = "period size equals buffer size";
 134         if (period_size == buffer_size)
 135                 goto fail;
 136
 137         /* software parameter setup */
 138         snd_pcm_sw_params_alloca(&swparams);
 139         snd_pcm_sw_params_current(pad->handle, swparams);
 140         snd_pcm_sw_params_set_avail_min(pad->handle, swparams, period_size);
 141         if (buffer_size < 1)
 142                 start_threshold = 1;
 143         else
 144                 start_threshold = PARA_MIN(buffer_size,
 145                         (snd_pcm_uframes_t)pad->sample_rate);
 146         msg = "could not set start threshold";
 147         ret = snd_pcm_sw_params_set_start_threshold(pad->handle, swparams,
 148                 start_threshold);
 149         if (ret < 0)
 150                 goto fail;
 151         stop_threshold = buffer_size;
 152         msg = "could not set stop threshold";
 153         ret = snd_pcm_sw_params_set_stop_threshold(pad->handle, swparams,
 154                 stop_threshold);
 155         if (ret < 0)
 156                 goto fail;
 157         msg = "unable to install sw params";
 158         ret = snd_pcm_sw_params(pad->handle, swparams);
 159         if (ret < 0)
 160                 goto fail;
 161         msg = "unable to determine bytes per frame";
 162         ret = snd_pcm_format_physical_width(pad->sample_format);
 163         if (ret <= 0)
 164                 goto fail;
 165         pad->bytes_per_frame = ret * pad->channels / 8;
 166         msg = "failed to set alsa handle to nonblock mode";
 167         ret = snd_pcm_nonblock(pad->handle, 1);
 168         if (ret < 0)
 169                 goto fail;
 170         ret = snd_output_buffer_open(&output_log);
 171         if (ret == 0) {
 172                 char *buf, *p;
 173                 size_t sz;
 174                 PARA_DEBUG_LOG("dumping alsa configuration\n");
 175                 snd_pcm_dump(pad->handle, output_log);
 176                 snd_pcm_hw_params_dump(hwparams, output_log);
 177                 sz = snd_output_buffer_string(output_log, &buf);
 178                 for (p = buf; p < buf + sz;) {
 179                         char *q = memchr(p, '\n', buf + sz - p);
 180                         if (!q)
 181                                 break;
 182                         *q = '\0';
 183                         PARA_DEBUG_LOG("%s\n", p);
 184                         p = q + 1;
 185                 }
 186                 snd_output_close(output_log);
 187         }
 188         return 1;
 189 fail:
 190         if (ret < 0)
 191                 PARA_ERROR_LOG("%s: %s\n", msg, snd_strerror(-ret));
 192         else
 193                 PARA_ERROR_LOG("%s\n", msg);
 194         return -E_ALSA;
 195 }
 196
 197 static void alsa_write_pre_select(struct sched *s, struct task *t)
 198 {
 199         struct pollfd pfd;
 200         struct writer_node *wn = container_of(t, struct writer_node, task);
 201         struct private_alsa_write_data *pad = wn->private_data;
 202         int ret = btr_node_status(wn->btrn, wn->min_iqs, BTR_NT_LEAF);
 203
 204         if (pad)
 205                 pad->poll_fd = -1;
 206         if (ret == 0)
 207                 return;
 208         if (!pad) {
 209                 sched_min_delay(s);
 210                 return;
 211         }
 212         if (ret < 0) {
 213                 sched_request_barrier_or_min_delay(&pad->drain_barrier, s);
 214                 return;
 215         }
 216         ret = snd_pcm_poll_descriptors(pad->handle, &pfd, 1);
 217         if (ret < 0) {
 218                 PARA_ERROR_LOG("could not get alsa poll fd: %s\n",
 219                         snd_strerror(-ret));
 220                 return;
 221         }
 222         pad->poll_fd = pfd.fd;
 223         para_fd_set(pfd.fd, &s->rfds, &s->max_fileno);
 224 }
 225
 226 static void alsa_close(struct writer_node *wn)
 227 {
 228         struct private_alsa_write_data *pad = wn->private_data;
 229         PARA_INFO_LOG("closing writer node %p\n", wn);
 230
 231         if (!pad)
 232                 return;
 233         /*
 234          * It's OK to have a blocking operation here because we already made
 235          * sure that the PCM output buffer is (nearly) empty.
 236          */
 237         snd_pcm_nonblock(pad->handle, 0);
 238         snd_pcm_drain(pad->handle);
 239         snd_pcm_close(pad->handle);
 240         snd_config_update_free_global();
 241         free(pad);
 242 }
 243
 244 static int alsa_write_post_select(__a_unused struct sched *s,
 245                 struct task *t)
 246 {
 247         struct writer_node *wn = container_of(t, struct writer_node, task);
 248         struct private_alsa_write_data *pad = wn->private_data;
 249         struct btr_node *btrn = wn->btrn;
 250         char *data;
 251         size_t bytes;
 252         snd_pcm_sframes_t frames;
 253         int ret;
 254
 255         ret = task_get_notification(t);
 256         if (ret < 0)
 257                 goto err;
 258 again:
 259         ret = btr_node_status(btrn, wn->min_iqs, BTR_NT_LEAF);
 260         if (ret == 0)
 261                 return 0;
 262         btr_merge(btrn, wn->min_iqs);
 263         bytes = btr_next_buffer(btrn, &data);
 264         if (ret < 0 || bytes < wn->min_iqs) { /* eof */
 265                 assert(btr_no_parent(btrn));
 266                 ret = -E_WRITE_COMMON_EOF;
 267                 if (!pad)
 268                         goto err;
 269                 /* wait until pending frames are played */
 270                 if (pad->drain_barrier.tv_sec == 0) {
 271                         PARA_DEBUG_LOG("waiting for device to drain\n");
 272                         tv_add(now, &(struct timeval)EMBRACE(0, 200 * 1000),
 273                                 &pad->drain_barrier);
 274                         return 0;
 275                 }
 276                 if (tv_diff(now, &pad->drain_barrier, NULL) > 0)
 277                         goto err;
 278                 return 0;
 279         }
 280         if (!pad) {
 281                 int32_t val;
 282
 283                 if (bytes == 0) /* no data available */
 284                         return 0;
 285                 pad = para_calloc(sizeof(*pad));
 286                 get_btr_sample_rate(btrn, &val);
 287                 pad->sample_rate = val;
 288                 get_btr_channels(btrn, &val);
 289                 pad->channels = val;
 290                 get_btr_sample_format(btrn, &val);
 291                 pad->sample_format = get_alsa_pcm_format(val);
 292
 293                 PARA_INFO_LOG("%d channel(s), %dHz\n", pad->channels,
 294                         pad->sample_rate);
 295                 ret = alsa_init(pad, wn->conf);
 296                 if (ret < 0) {
 297                         free(pad);
 298                         goto err;
 299                 }
 300                 wn->private_data = pad;
 301                 wn->min_iqs = pad->bytes_per_frame;
 302                 goto again;
 303         }
 304         if (pad->poll_fd < 0 || !FD_ISSET(pad->poll_fd, &s->rfds))
 305                 return 0;
 306         frames = bytes / pad->bytes_per_frame;
 307         frames = snd_pcm_writei(pad->handle, data, frames);
 308         if (frames == 0 || frames == -EAGAIN) {
 309                 /*
 310                  * The alsa poll fd was ready for IO but we failed to write to
 311                  * the alsa handle. This means another event is pending. We
 312                  * don't care about that but we have to dispatch the event in
 313                  * order to avoid a busy loop. So we simply read from the poll
 314                  * fd.
 315                  */
 316                 char buf[100];
 317                 if (read(pad->poll_fd, buf, 100))
 318                         do_nothing;
 319                 return 0;
 320         }
 321         if (frames > 0) {
 322                 btr_consume(btrn, frames * pad->bytes_per_frame);
 323                 goto again;
 324         }
 325         if (frames == -EPIPE) {
 326                 PARA_WARNING_LOG("underrun (tried to write %zu bytes)\n", bytes);
 327                 snd_pcm_prepare(pad->handle);
 328                 return 0;
 329         }
 330         PARA_ERROR_LOG("alsa write error: %s\n", snd_strerror(-frames));
 331         ret = -E_ALSA;
 332 err:
 333         assert(ret < 0);
 334         btr_remove_node(&wn->btrn);
 335         return ret;
 336 }
 337
 338 __malloc static void *alsa_parse_config_or_die(int argc, char **argv)
 339 {
 340         struct alsa_write_args_info *conf = para_calloc(sizeof(*conf));
 341
 342         /* exits on errors */
 343         alsa_write_cmdline_parser(argc, argv, conf);
 344         return conf;
 345 }
 346
 347 static void alsa_free_config(void *conf)
 348 {
 349         alsa_write_cmdline_parser_free(conf);
 350 }
 351
 352 /**
 353  * The init function of the alsa writer.
 354  *
 355  * \param w Pointer to the writer to initialize.
 356  *
 357  * \sa struct \ref writer.
 358  */
 359 void alsa_write_init(struct writer *w)
 360 {
 361         struct alsa_write_args_info dummy;
 362
 363         alsa_write_cmdline_parser_init(&dummy);
 364         w->close = alsa_close;
 365         w->pre_select = alsa_write_pre_select;
 366         w->post_select = alsa_write_post_select;
 367         w->parse_config_or_die = alsa_parse_config_or_die;
 368         w->free_config = alsa_free_config;
 369         w->help = (struct ggo_help)DEFINE_GGO_HELP(alsa_write);
 370         alsa_write_cmdline_parser_free(&dummy);
 371 }