/*
- * Copyright (C) 2005-2010 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>
*
* Licensed under the GPL v2. For licencing details see COPYING.
*/
#include <regex.h>
#include <sys/types.h>
-#include <dirent.h>
#include <alsa/asoundlib.h>
-#include <sys/time.h>
-#include <stdbool.h>
#include "para.h"
#include "fd.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. */
struct private_alsa_write_data {
/** The alsa handle */
snd_pcm_t *handle;
- /** Determined and set by alsa_open(). */
+ /** Determined and set by alsa_init(). */
int bytes_per_frame;
- /** The approximate maximum buffer duration in us. */
- unsigned buffer_time;
- /* Number of frames that fit into the buffer. */
- snd_pcm_uframes_t buffer_frames;
- /**
- * The sample rate given by command line option or the decoder
- * of the writer node group.
+ /*
+ * If the sample rate is not given at the command line and no wav
+ * header was detected, the btr exec mechanism is employed to query the
+ * ancestor buffer tree nodes for this information. In a typical setup
+ * the decoder passes the sample rate back to the alsa writer.
+ *
+ * \sa \ref btr_exec_up().
*/
unsigned sample_rate;
- /**
- * The number of channels, given by command line option or the
- * decoder of the writer node group.
+ /*
+ * The sample format (8/16 bit, signed/unsigned, little/big endian) is
+ * determined in the same way as the \a sample_rate.
*/
+ snd_pcm_format_t sample_format;
+ /* The number of channels, again determined like \a sample_rate. */
unsigned channels;
+ /* time until buffer underrun occurs, in milliseconds */
+ unsigned buffer_time;
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_hw_params_t *hwparams = NULL;
+ snd_pcm_sw_params_t *swparams = NULL;
snd_pcm_uframes_t start_threshold, stop_threshold;
- snd_pcm_uframes_t period_size;
- int err;
+ snd_pcm_uframes_t buffer_size, period_size;
+ snd_output_t *output_log;
+ int ret;
+ const char *msg;
+ unsigned period_time;
PARA_INFO_LOG("opening %s\n", conf->device_arg);
- err = snd_pcm_open(&pad->handle, 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;
-
- 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->sample_rate, NULL) < 0)
- return -E_SET_RATE;
- err = snd_pcm_hw_params_get_buffer_time_max(hwparams,
+ if (ret < 0)
+ goto fail;
+ ret = snd_pcm_hw_params_malloc(&hwparams);
+ assert(ret >= 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;
+ /* alsa wants microseconds */
+ pad->buffer_time = conf->buffer_time_arg * 1000;
+ msg = "could not set buffer time";
+ ret = snd_pcm_hw_params_set_buffer_time_near(pad->handle, hwparams,
&pad->buffer_time, NULL);
- 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, NULL) < 0)
- return -E_SET_BUFFER_TIME;
- if (snd_pcm_hw_params(pad->handle, hwparams) < 0)
- return -E_HW_PARAMS;
+ if (ret < 0)
+ goto fail;
+ pad->buffer_time /= 1000; /* we prefer milliseconds */
+ period_time = pad->buffer_time * 250; /* buffer time / 4 */
+ msg = "could not set period time";
+ ret = snd_pcm_hw_params_set_period_time_near(pad->handle, hwparams,
+ &period_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, &pad->buffer_frames);
- PARA_INFO_LOG("buffer size: %lu, period_size: %lu\n", pad->buffer_frames,
- period_size);
- if (period_size == pad->buffer_frames)
- return -E_BAD_PERIOD;
+ snd_pcm_hw_params_get_buffer_size(hwparams, &buffer_size);
+ msg = "period size equals buffer size";
+ if (period_size == buffer_size)
+ goto fail;
+
+ /* software parameter setup */
+ ret = snd_pcm_sw_params_malloc(&swparams);
+ assert(ret >= 0);
snd_pcm_sw_params_current(pad->handle, swparams);
snd_pcm_sw_params_set_avail_min(pad->handle, swparams, period_size);
- if (pad->buffer_frames < 1)
+ if (buffer_size < 1)
start_threshold = 1;
else
- start_threshold = PARA_MIN(pad->buffer_frames,
+ start_threshold = PARA_MIN(buffer_size,
(snd_pcm_uframes_t)pad->sample_rate);
- if (snd_pcm_sw_params_set_start_threshold(pad->handle, swparams,
- start_threshold) < 0)
- return -E_START_THRESHOLD;
- stop_threshold = pad->buffer_frames;
- 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;
- if (pad->bytes_per_frame <= 0)
- return -E_PHYSICAL_WIDTH;
- PARA_INFO_LOG("bytes per frame: %d\n", pad->bytes_per_frame);
- if (snd_pcm_nonblock(pad->handle, 1))
- PARA_ERROR_LOG("failed to set nonblock mode\n");
- return 1;
-}
-
-/* Open an instance of the alsa writer. */
-static int alsa_open(struct writer_node *wn)
-{
- wn->private_data = para_calloc(sizeof(struct private_alsa_write_data));
- return 1;
+ 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;
+ 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_DEBUG_LOG("dumping alsa configuration\n");
+ snd_pcm_dump(pad->handle, output_log);
+ snd_pcm_hw_params_dump(hwparams, 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_DEBUG_LOG("%s\n", p);
+ p = q + 1;
+ }
+ snd_output_close(output_log);
+ }
+ ret = 1;
+ goto out;
+fail:
+ if (ret < 0)
+ PARA_ERROR_LOG("%s: %s\n", msg, snd_strerror(-ret));
+ else
+ PARA_ERROR_LOG("%s\n", msg);
+ ret = -E_ALSA;
+out:
+ snd_pcm_hw_params_free(hwparams);
+ snd_pcm_sw_params_free(swparams);
+ return ret;
}
-static void alsa_write_pre_select(struct sched *s, struct task *t)
+static void alsa_write_pre_select(struct sched *s, void *context)
{
- struct writer_node *wn = container_of(t, struct writer_node, task);
+ struct pollfd pfd;
+ struct writer_node *wn = context;
struct private_alsa_write_data *pad = wn->private_data;
- struct timeval tv;
- snd_pcm_sframes_t avail, underrun;
- int ret;
+ int ret = btr_node_status(wn->btrn, wn->min_iqs, BTR_NT_LEAF);
- if (!pad->handle)
+ if (pad)
+ pad->poll_fd = -1;
+ if (ret == 0)
return;
- ret = btr_node_status(wn->btrn, wn->min_iqs, BTR_NT_LEAF);
- if (ret < 0)
- sched_request_timeout_ms(20, s);
- if (ret <= 0)
+ if (!pad) {
+ sched_min_delay(s);
return;
- /*
- * Data is available to be written to the alsa handle. Compute number
- * of milliseconds until next buffer underrun would occur.
- *
- * snd_pcm_avail_update() updates the current available count of
- * samples for writing. It is a light method to obtain current stream
- * position, because it does not require the user <-> kernel context
- * switch, but the value is less accurate, because ring buffer pointers
- * are updated in kernel drivers only when an interrupt occurs.
- */
- avail = snd_pcm_avail_update(pad->handle);
- if (avail < 0)
- avail = 0;
- underrun = (pad->buffer_frames - avail) * pad->buffer_time
- / pad->buffer_frames / 1000;
- if (underrun < 50)
- underrun = 50;
- underrun -= 50;
- ms2tv(underrun, &tv);
- if (tv_diff(&s->timeout, &tv, NULL) > 0)
- s->timeout = tv;
+ }
+ if (ret < 0) {
+ sched_request_barrier_or_min_delay(&pad->drain_barrier, s);
+ return;
+ }
+ /* wait at most 50% of the buffer time */
+ sched_request_timeout_ms(pad->buffer_time / 2, s);
+ 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));
+ return;
+ }
+ pad->poll_fd = pfd.fd;
+ para_fd_set(pfd.fd, &s->rfds, &s->max_fileno);
}
static void alsa_close(struct writer_node *wn)
struct private_alsa_write_data *pad = wn->private_data;
PARA_INFO_LOG("closing writer node %p\n", wn);
- if (pad->handle) {
- /*
- * 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();
- }
+ 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 void alsa_write_post_select(__a_unused struct sched *s,
- struct task *t)
+static int alsa_write_post_select(__a_unused struct sched *s, void *context)
{
- struct writer_node *wn = container_of(t, struct writer_node, task);
+ struct writer_node *wn = context;
struct private_alsa_write_data *pad = wn->private_data;
struct btr_node *btrn = wn->btrn;
char *data;
snd_pcm_sframes_t frames;
int ret;
+ ret = task_get_notification(wn->task);
+ if (ret < 0)
+ goto err;
again:
- t->error = 0;
ret = btr_node_status(btrn, wn->min_iqs, BTR_NT_LEAF);
if (ret == 0)
- return;
+ return 0;
btr_merge(btrn, wn->min_iqs);
bytes = btr_next_buffer(btrn, &data);
- if (ret < 0 || bytes < pad->bytes_per_frame) { /* eof */
+ if (ret < 0 || bytes < wn->min_iqs) { /* eof */
assert(btr_no_parent(btrn));
- ret = -E_ALSA_EOF;
- if (!pad->handle)
+ 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;
+ return 0;
}
if (tv_diff(now, &pad->drain_barrier, NULL) > 0)
goto err;
- return;
+ return 0;
}
- if (!pad->handle) {
+ if (!pad) {
int32_t val;
+
if (bytes == 0) /* no data available */
- return;
- ret = get_btr_sample_rate(btrn, &val);
- if (ret < 0)
- goto err;
+ return 0;
+ pad = para_calloc(sizeof(*pad));
+ get_btr_sample_rate(btrn, &val);
pad->sample_rate = val;
- ret = get_btr_channels(btrn, &val);
- if (ret < 0)
- goto err;
+ 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)
+ if (ret < 0) {
+ free(pad);
goto err;
+ }
+ wn->private_data = pad;
wn->min_iqs = pad->bytes_per_frame;
+ goto again;
}
frames = bytes / pad->bytes_per_frame;
frames = snd_pcm_writei(pad->handle, data, frames);
- if (frames >= 0) {
+ if (frames == 0 || frames == -EAGAIN) {
+ char buf[100];
+ if (pad->poll_fd >= 0 && FD_ISSET(pad->poll_fd, &s->rfds))
+ if (read(pad->poll_fd, buf, 100))
+ do_nothing;
+ return 0;
+ }
+ if (frames > 0) {
btr_consume(btrn, frames * pad->bytes_per_frame);
goto again;
}
if (frames == -EPIPE) {
PARA_WARNING_LOG("underrun (tried to write %zu bytes)\n", bytes);
snd_pcm_prepare(pad->handle);
- return;
+ return 0;
}
- if (frames == -EAGAIN)
- return;
- PARA_WARNING_LOG("%s\n", snd_strerror(-frames));
- ret = -E_ALSA_WRITE;
+ PARA_ERROR_LOG("alsa write error: %s\n", snd_strerror(-frames));
+ ret = -E_ALSA;
err:
assert(ret < 0);
- btr_remove_node(btrn);
- t->error = ret;
+ btr_remove_node(&wn->btrn);
+ return ret;
}
-__malloc static void *alsa_parse_config(const char *options)
+__malloc static void *alsa_parse_config_or_die(int argc, char **argv)
{
- int ret;
- struct alsa_write_args_info *conf
- = para_calloc(sizeof(struct alsa_write_args_info));
+ struct alsa_write_args_info *conf = para_calloc(sizeof(*conf));
- 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);
+ /* exits on errors */
+ alsa_write_cmdline_parser(argc, argv, conf);
return conf;
-err_out:
- free(conf);
- return NULL;
}
static void alsa_free_config(void *conf)
{
- alsa_cmdline_parser_free(conf);
+ alsa_write_cmdline_parser_free(conf);
}
/**
{
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->parse_config_or_die = alsa_parse_config_or_die;
w->free_config = alsa_free_config;
- w->help = (struct ggo_help) {
- .short_help = alsa_write_args_info_help,
- .detailed_help = alsa_write_args_info_detailed_help
- };
- alsa_cmdline_parser_free(&dummy);
+ w->help = (struct ggo_help)DEFINE_GGO_HELP(alsa_write);
+ alsa_write_cmdline_parser_free(&dummy);
}