/*
- * Copyright (C) 2005-2009 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2013 Andre Noll <maan@systemlinux.org>
*
* Licensed under the GPL v2. For licencing details see COPYING.
*/
* based on the vplay program by Michael Beck.
*/
+#include <regex.h>
#include <sys/types.h>
-#include <dirent.h>
#include <alsa/asoundlib.h>
#include "para.h"
#include "list.h"
#include "sched.h"
#include "ggo.h"
+#include "buffer_tree.h"
#include "write.h"
+#include "write_common.h"
#include "alsa_write.cmdline.h"
#include "error.h"
-/** always use 16 bit little endian */
-#define FORMAT SND_PCM_FORMAT_S16_LE
-
-/** data specific to the alsa writer */
+/** Data specific to the alsa writer. */
struct private_alsa_write_data {
- /** the alsa handle */
+ /** The alsa handle */
snd_pcm_t *handle;
- /** determined and set by alsa_open() */
- size_t bytes_per_frame;
- /** don't write anything until this time */
- struct timeval next_chunk;
- /** the return value of snd_pcm_hw_params_get_buffer_time_max() */
- unsigned buffer_time;
+ /** Determined and set by alsa_init(). */
+ int bytes_per_frame;
/**
- * the samplerate given by command line option or the decoder
- * of the writer node group
+ * The sample rate given by command line option or the decoder
+ * of the writer node group.
*/
- unsigned samplerate;
+ unsigned sample_rate;
+ snd_pcm_format_t sample_format;
/**
* The number of channels, given by command line option or the
* decoder of the writer node group.
*/
unsigned channels;
+ struct timeval drain_barrier;
+ /* File descriptor for select(). */
+ int poll_fd;
};
+static snd_pcm_format_t get_alsa_pcm_format(enum sample_format sf)
+{
+ switch (sf) {
+ case SF_S8: return SND_PCM_FORMAT_S8;
+ case SF_U8: return SND_PCM_FORMAT_U8;
+ case SF_S16_LE: return SND_PCM_FORMAT_S16_LE;
+ case SF_S16_BE: return SND_PCM_FORMAT_S16_BE;
+ case SF_U16_LE: return SND_PCM_FORMAT_U16_LE;
+ case SF_U16_BE: return SND_PCM_FORMAT_U16_BE;
+ default: return SND_PCM_FORMAT_S16_LE;
+ }
+}
+
/* Install PCM software and hardware configuration. */
static int alsa_init(struct private_alsa_write_data *pad,
struct alsa_write_args_info *conf)
{
snd_pcm_hw_params_t *hwparams;
snd_pcm_sw_params_t *swparams;
- snd_pcm_uframes_t buffer_size, start_threshold, stop_threshold;
- snd_pcm_uframes_t period_size;
- int err;
+ snd_pcm_uframes_t start_threshold, stop_threshold;
+ snd_pcm_uframes_t buffer_size, period_size;
+ snd_output_t *output_log;
+ unsigned buffer_time;
+ int ret;
+ const char *msg;
- err = snd_pcm_open(&pad->handle, conf->device_arg,
+ PARA_INFO_LOG("opening %s\n", conf->device_arg);
+ msg = "unable to open pcm";
+ ret = snd_pcm_open(&pad->handle, conf->device_arg,
SND_PCM_STREAM_PLAYBACK, SND_PCM_NONBLOCK);
- if (err < 0)
- return -E_PCM_OPEN;
-
+ if (ret < 0)
+ goto fail;
snd_pcm_hw_params_alloca(&hwparams);
- snd_pcm_sw_params_alloca(&swparams);
- if (snd_pcm_hw_params_any(pad->handle, hwparams) < 0)
- return -E_BROKEN_CONF;
- if (snd_pcm_hw_params_set_access(pad->handle, hwparams,
- SND_PCM_ACCESS_RW_INTERLEAVED) < 0)
- return -E_ACCESS_TYPE;
- if (snd_pcm_hw_params_set_format(pad->handle, hwparams, FORMAT) < 0)
- return -E_SAMPLE_FORMAT;
- if (snd_pcm_hw_params_set_channels(pad->handle, hwparams,
- pad->channels) < 0)
- return -E_CHANNEL_COUNT;
- if (snd_pcm_hw_params_set_rate_near(pad->handle, hwparams,
- &pad->samplerate, 0) < 0)
- return -E_SET_RATE;
- err = snd_pcm_hw_params_get_buffer_time_max(hwparams, &pad->buffer_time, 0);
- if (err < 0 || !pad->buffer_time)
- return -E_GET_BUFFER_TIME;
- PARA_INFO_LOG("buffer time: %d\n", pad->buffer_time);
- if (snd_pcm_hw_params_set_buffer_time_near(pad->handle, hwparams,
- &pad->buffer_time, 0) < 0)
- return -E_SET_BUFFER_TIME;
- if (snd_pcm_hw_params(pad->handle, hwparams) < 0)
- return -E_HW_PARAMS;
- snd_pcm_hw_params_get_period_size(hwparams, &period_size, 0);
+ msg = "Broken alsa configuration";
+ ret = snd_pcm_hw_params_any(pad->handle, hwparams);
+ if (ret < 0)
+ goto fail;
+ msg = "access type not available";
+ ret = snd_pcm_hw_params_set_access(pad->handle, hwparams,
+ SND_PCM_ACCESS_RW_INTERLEAVED);
+ if (ret < 0)
+ goto fail;
+ msg = "sample format not available";
+ ret = snd_pcm_hw_params_set_format(pad->handle, hwparams,
+ pad->sample_format);
+ if (ret < 0)
+ goto fail;
+ msg = "channels count not available";
+ ret = snd_pcm_hw_params_set_channels(pad->handle, hwparams,
+ pad->channels);
+ if (ret < 0)
+ goto fail;
+ msg = "could not set sample rate";
+ ret = snd_pcm_hw_params_set_rate_near(pad->handle, hwparams,
+ &pad->sample_rate, NULL);
+ if (ret < 0)
+ goto fail;
+ msg = "unable to get buffer time";
+ ret = snd_pcm_hw_params_get_buffer_time_max(hwparams, &buffer_time,
+ NULL);
+ if (ret < 0 || buffer_time == 0)
+ goto fail;
+ /* buffer at most 500 milliseconds */
+ buffer_time = PARA_MIN(buffer_time, 500U * 1000U);
+ msg = "could not set buffer time";
+ ret = snd_pcm_hw_params_set_buffer_time_near(pad->handle, hwparams,
+ &buffer_time, NULL);
+ if (ret < 0)
+ goto fail;
+ msg = "unable to install hw params";
+ ret = snd_pcm_hw_params(pad->handle, hwparams);
+ if (ret < 0)
+ goto fail;
+ snd_pcm_hw_params_get_period_size(hwparams, &period_size, NULL);
snd_pcm_hw_params_get_buffer_size(hwparams, &buffer_size);
- PARA_INFO_LOG("buffer size: %lu, period_size: %lu\n", buffer_size,
- period_size);
+ msg = "period size equals buffer size";
if (period_size == buffer_size)
- return -E_BAD_PERIOD;
+ goto fail;
+
+ /* software parameter setup */
+ snd_pcm_sw_params_alloca(&swparams);
snd_pcm_sw_params_current(pad->handle, swparams);
snd_pcm_sw_params_set_avail_min(pad->handle, swparams, period_size);
if (buffer_size < 1)
start_threshold = 1;
else
- start_threshold = buffer_size;
- if (snd_pcm_sw_params_set_start_threshold(pad->handle, swparams,
- start_threshold) < 0)
- return -E_START_THRESHOLD;
+ start_threshold = PARA_MIN(buffer_size,
+ (snd_pcm_uframes_t)pad->sample_rate);
+ msg = "could not set start threshold";
+ ret = snd_pcm_sw_params_set_start_threshold(pad->handle, swparams,
+ start_threshold);
+ if (ret < 0)
+ goto fail;
stop_threshold = buffer_size;
- if (snd_pcm_sw_params_set_stop_threshold(pad->handle, swparams,
- stop_threshold) < 0)
- return -E_STOP_THRESHOLD;
- if (snd_pcm_sw_params(pad->handle, swparams) < 0)
- PARA_WARNING_LOG("unable to install sw params\n");
- pad->bytes_per_frame = snd_pcm_format_physical_width(FORMAT)
- * pad->channels / 8;
- PARA_INFO_LOG("bytes per frame: %zu\n", pad->bytes_per_frame);
- if (snd_pcm_nonblock(pad->handle, 1))
- PARA_ERROR_LOG("failed to set nonblock mode\n");
+ msg = "could not set stop threshold";
+ ret = snd_pcm_sw_params_set_stop_threshold(pad->handle, swparams,
+ stop_threshold);
+ if (ret < 0)
+ goto fail;
+ msg = "unable to install sw params";
+ ret = snd_pcm_sw_params(pad->handle, swparams);
+ if (ret < 0)
+ goto fail;
+ msg = "unable to determine bytes per frame";
+ ret = snd_pcm_format_physical_width(pad->sample_format);
+ if (ret <= 0)
+ goto fail;
+ pad->bytes_per_frame = ret * pad->channels / 8;
+ msg = "failed to set alsa handle to nonblock mode";
+ ret = snd_pcm_nonblock(pad->handle, 1);
+ if (ret < 0)
+ goto fail;
+ ret = snd_output_buffer_open(&output_log);
+ if (ret == 0) {
+ char *buf, *p;
+ size_t sz;
+ PARA_INFO_LOG("dumping alsa configuration\n");
+ snd_pcm_dump(pad->handle, output_log);
+ sz = snd_output_buffer_string(output_log, &buf);
+ for (p = buf; p < buf + sz;) {
+ char *q = memchr(p, '\n', buf + sz - p);
+ if (!q)
+ break;
+ *q = '\0';
+ PARA_INFO_LOG("%s\n", p);
+ p = q + 1;
+ }
+ snd_output_close(output_log);
+ }
return 1;
+fail:
+ if (ret < 0)
+ PARA_ERROR_LOG("%s: %s\n", msg, snd_strerror(-ret));
+ else
+ PARA_ERROR_LOG("%s\n", msg);
+ return -E_ALSA;
}
-/* Open an instance of the alsa writer. */
-static int alsa_open(struct writer_node *wn)
+static void alsa_write_pre_select(struct sched *s, struct task *t)
{
- struct alsa_write_args_info *conf = wn->conf;
- struct writer_node_group *wng = wn->wng;
- struct private_alsa_write_data *pad = para_calloc(sizeof(*pad));
+ struct pollfd pfd;
+ struct writer_node *wn = container_of(t, struct writer_node, task);
+ struct private_alsa_write_data *pad = wn->private_data;
+ int ret = btr_node_status(wn->btrn, wn->min_iqs, BTR_NT_LEAF);
- wn->private_data = pad;
- if (!conf->samplerate_given && wng->samplerate)
- pad->samplerate = *wng->samplerate;
- else
- pad->samplerate = conf->samplerate_arg;
- if (!conf->channels_given && wng->channels)
- pad->channels = *wng->channels;
- else
- pad->channels = conf->channels_arg;
- PARA_INFO_LOG("%d channel(s), %dHz\n", pad->channels, pad->samplerate);
- tv_add(now, &(struct timeval){0, 100 * 1000}, &pad->next_chunk);
- return 1;
+ if (pad)
+ pad->poll_fd = -1;
+ if (ret == 0)
+ return;
+ if (!pad) {
+ sched_min_delay(s);
+ return;
+ }
+ if (ret < 0) {
+ sched_request_barrier_or_min_delay(&pad->drain_barrier, s);
+ return;
+ }
+ ret = snd_pcm_poll_descriptors(pad->handle, &pfd, 1);
+ if (ret < 0) {
+ PARA_ERROR_LOG("could not get alsa poll fd: %s\n",
+ snd_strerror(-ret));
+ t->error = -E_ALSA;
+ return;
+ }
+ pad->poll_fd = pfd.fd;
+ para_fd_set(pfd.fd, &s->rfds, &s->max_fileno);
}
-static int alsa_write_pre_select(struct sched *s, struct writer_node *wn)
+static void alsa_close(struct writer_node *wn)
{
struct private_alsa_write_data *pad = wn->private_data;
- struct writer_node_group *wng = wn->wng;
- struct timeval diff;
+ PARA_INFO_LOG("closing writer node %p\n", wn);
- if (!*wng->loaded)
- return 1;
- if (tv_diff(now, &pad->next_chunk, &diff) < 0) {
- if (tv_diff(&s->timeout, &diff, NULL) > 0)
- s->timeout = diff;
- } else {
- s->timeout.tv_sec = 0;
- s->timeout.tv_usec = 1;
- }
- return 1;
+ if (!pad)
+ return;
+ /*
+ * It's OK to have a blocking operation here because we already made
+ * sure that the PCM output buffer is (nearly) empty.
+ */
+ snd_pcm_nonblock(pad->handle, 0);
+ snd_pcm_drain(pad->handle);
+ snd_pcm_close(pad->handle);
+ snd_config_update_free_global();
+ free(pad);
}
static int alsa_write_post_select(__a_unused struct sched *s,
- struct writer_node *wn)
+ struct task *t)
{
+ struct writer_node *wn = container_of(t, struct writer_node, task);
struct private_alsa_write_data *pad = wn->private_data;
- struct writer_node_group *wng = wn->wng;
- size_t frames, bytes = *wng->loaded - wn->written;
- unsigned char *data = (unsigned char*)*wng->bufp + wn->written;
- struct timeval tv;
- snd_pcm_sframes_t ret;
+ struct btr_node *btrn = wn->btrn;
+ char *data;
+ size_t bytes;
+ snd_pcm_sframes_t frames;
+ int ret;
- if (!bytes) /* no data available */
- goto out;
- if (tv_diff(now, &pad->next_chunk, NULL) < 0)
- goto out;
- if (!pad->handle) {
- int err = alsa_init(pad, wn->conf);
- if (err < 0)
- return err;
+ ret = task_get_notification(t);
+ if (ret < 0)
+ goto err;
+again:
+ ret = btr_node_status(btrn, wn->min_iqs, BTR_NT_LEAF);
+ if (ret == 0)
+ return 0;
+ btr_merge(btrn, wn->min_iqs);
+ bytes = btr_next_buffer(btrn, &data);
+ if (ret < 0 || bytes < wn->min_iqs) { /* eof */
+ assert(btr_no_parent(btrn));
+ ret = -E_WRITE_COMMON_EOF;
+ if (!pad)
+ goto err;
+ /* wait until pending frames are played */
+ if (pad->drain_barrier.tv_sec == 0) {
+ PARA_DEBUG_LOG("waiting for device to drain\n");
+ tv_add(now, &(struct timeval)EMBRACE(0, 200 * 1000),
+ &pad->drain_barrier);
+ return 0;
+ }
+ if (tv_diff(now, &pad->drain_barrier, NULL) > 0)
+ goto err;
+ return 0;
}
- frames = bytes / pad->bytes_per_frame;
- ret = snd_pcm_writei(pad->handle, data, frames);
- if (ret == -EPIPE) {
- PARA_WARNING_LOG("EPIPE\n");
- snd_pcm_prepare(pad->handle);
- return 1;
+ if (!pad) {
+ int32_t val;
+
+ if (bytes == 0) /* no data available */
+ return 0;
+ pad = para_calloc(sizeof(*pad));
+ get_btr_sample_rate(btrn, &val);
+ pad->sample_rate = val;
+ get_btr_channels(btrn, &val);
+ pad->channels = val;
+ get_btr_sample_format(btrn, &val);
+ pad->sample_format = get_alsa_pcm_format(val);
+
+ PARA_INFO_LOG("%d channel(s), %dHz\n", pad->channels,
+ pad->sample_rate);
+ ret = alsa_init(pad, wn->conf);
+ if (ret < 0) {
+ free(pad);
+ goto err;
+ }
+ wn->private_data = pad;
+ wn->min_iqs = pad->bytes_per_frame;
+ goto again;
}
- if (ret < 0 && ret != -EAGAIN) {
- PARA_WARNING_LOG("alsa error (%zu frames, ret = %d\n",
- frames, (int)ret);
- return -E_ALSA_WRITE;
+ if (pad->poll_fd < 0 || !FD_ISSET(pad->poll_fd, &s->rfds))
+ return 0;
+ frames = bytes / pad->bytes_per_frame;
+ frames = snd_pcm_writei(pad->handle, data, frames);
+ if (frames == 0 || frames == -EAGAIN) {
+ /*
+ * The alsa poll fd was ready for IO but we failed to write to
+ * the alsa handle. This means another event is pending. We
+ * don't care about that but we have to dispatch the event in
+ * order to avoid a busy loop. So we simply read from the poll
+ * fd.
+ */
+ char buf[100];
+ if (read(pad->poll_fd, buf, 100))
+ do_nothing;
+ return 0;
}
- if (ret == -EAGAIN)
- PARA_DEBUG_LOG("EAGAIN\n");
- else
- wn->written += ret * pad->bytes_per_frame;
- if (ret == frames) /* we wrote everything, try again immediately */
- pad->next_chunk = *now;
- else {
- ms2tv(pad->buffer_time / pad->bytes_per_frame / 1000, &tv);
- tv_add(now, &tv, &pad->next_chunk);
+ if (frames > 0) {
+ btr_consume(btrn, frames * pad->bytes_per_frame);
+ goto again;
}
-out:
- if (*wng->input_error < 0) {
- wn->written = *wng->loaded;
- return *wng->input_error;
+ if (frames == -EPIPE) {
+ PARA_WARNING_LOG("underrun (tried to write %zu bytes)\n", bytes);
+ snd_pcm_prepare(pad->handle);
+ return 0;
}
- return 1;
+ PARA_ERROR_LOG("alsa write error: %s\n", snd_strerror(-frames));
+ ret = -E_ALSA;
+err:
+ assert(ret < 0);
+ btr_remove_node(&wn->btrn);
+ return ret;
}
-static void alsa_close(struct writer_node *wn)
+__malloc static void *alsa_parse_config_or_die(int argc, char **argv)
{
- struct private_alsa_write_data *pad = wn->private_data;
- PARA_INFO_LOG("closing writer node %p\n", wn);
+ struct alsa_write_args_info *conf = para_calloc(sizeof(*conf));
- if (pad->handle) {
- snd_pcm_drain(pad->handle);
- snd_pcm_close(pad->handle);
- snd_config_update_free_global();
- }
- free(pad);
+ /* exits on errors */
+ alsa_write_cmdline_parser(argc, argv, conf);
+ return conf;
}
-__malloc static void *alsa_parse_config(const char *options)
+static void alsa_free_config(void *conf)
{
- int ret;
- struct alsa_write_args_info *conf
- = para_calloc(sizeof(struct alsa_write_args_info));
-
- PARA_INFO_LOG("options: %s, %zd\n", options, strcspn(options, " \t"));
- ret = alsa_cmdline_parser_string(options, conf, "alsa_write");
- if (ret)
- goto err_out;
- PARA_INFO_LOG("help given: %d\n", conf->help_given);
- return conf;
-err_out:
- free(conf);
- return NULL;
+ alsa_write_cmdline_parser_free(conf);
}
/**
- * the init function of the alsa writer
+ * The init function of the alsa writer.
*
- * \param w pointer to the writer to initialize
+ * \param w Pointer to the writer to initialize.
*
- * \sa struct writer
+ * \sa struct \ref writer.
*/
void alsa_write_init(struct writer *w)
{
struct alsa_write_args_info dummy;
- alsa_cmdline_parser_init(&dummy);
- w->open = alsa_open;
+ alsa_write_cmdline_parser_init(&dummy);
w->close = alsa_close;
w->pre_select = alsa_write_pre_select;
w->post_select = alsa_write_post_select;
- w->parse_config = alsa_parse_config;
- w->shutdown = NULL; /* nothing to do */
- w->help = (struct ggo_help) {
- .short_help = alsa_write_args_info_help,
- .detailed_help = alsa_write_args_info_detailed_help
- };
+ w->parse_config_or_die = alsa_parse_config_or_die;
+ w->free_config = alsa_free_config;
+ w->help = (struct ggo_help)DEFINE_GGO_HELP(alsa_write);
+ alsa_write_cmdline_parser_free(&dummy);
}