[btr] Add the node type parameter to btr_node_status().
[paraslash.git] / alsa_write.c
1 /*
2 * Copyright (C) 2005-2009 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 <dirent.h>
18 #include <alsa/asoundlib.h>
19 #include <sys/time.h>
20 #include <stdbool.h>
21
22 #include "para.h"
23 #include "fd.h"
24 #include "string.h"
25 #include "list.h"
26 #include "sched.h"
27 #include "ggo.h"
28 #include "buffer_tree.h"
29 #include "write.h"
30 #include "write_common.h"
31 #include "alsa_write.cmdline.h"
32 #include "error.h"
33
34 /** always use 16 bit little endian */
35 #define FORMAT SND_PCM_FORMAT_S16_LE
36
37 /** Data specific to the alsa writer. */
38 struct private_alsa_write_data {
39 /** The alsa handle */
40 snd_pcm_t *handle;
41 /** Determined and set by alsa_open(). */
42 int bytes_per_frame; /* TODO: Kill this after btr switch */
43 /** The approximate maximum buffer duration in us. */
44 unsigned buffer_time;
45 /* Number of frames that fit into the buffer. */
46 snd_pcm_uframes_t buffer_frames;
47 /**
48 * The samplerate given by command line option or the decoder
49 * of the writer node group.
50 */
51 unsigned samplerate;
52 /**
53 * The number of channels, given by command line option or the
54 * decoder of the writer node group.
55 */
56 unsigned channels;
57 };
58
59 /* Install PCM software and hardware configuration. */
60 static int alsa_init(struct private_alsa_write_data *pad,
61 struct alsa_write_args_info *conf)
62 {
63 snd_pcm_hw_params_t *hwparams;
64 snd_pcm_sw_params_t *swparams;
65 snd_pcm_uframes_t start_threshold, stop_threshold;
66 snd_pcm_uframes_t period_size;
67 int err;
68
69 err = snd_pcm_open(&pad->handle, conf->device_arg,
70 SND_PCM_STREAM_PLAYBACK, SND_PCM_NONBLOCK);
71 if (err < 0)
72 return -E_PCM_OPEN;
73
74 snd_pcm_hw_params_alloca(&hwparams);
75 snd_pcm_sw_params_alloca(&swparams);
76 if (snd_pcm_hw_params_any(pad->handle, hwparams) < 0)
77 return -E_BROKEN_CONF;
78 if (snd_pcm_hw_params_set_access(pad->handle, hwparams,
79 SND_PCM_ACCESS_RW_INTERLEAVED) < 0)
80 return -E_ACCESS_TYPE;
81 if (snd_pcm_hw_params_set_format(pad->handle, hwparams, FORMAT) < 0)
82 return -E_SAMPLE_FORMAT;
83 if (snd_pcm_hw_params_set_channels(pad->handle, hwparams,
84 pad->channels) < 0)
85 return -E_CHANNEL_COUNT;
86 if (snd_pcm_hw_params_set_rate_near(pad->handle, hwparams,
87 &pad->samplerate, NULL) < 0)
88 return -E_SET_RATE;
89 err = snd_pcm_hw_params_get_buffer_time_max(hwparams,
90 &pad->buffer_time, NULL);
91 if (err < 0 || !pad->buffer_time)
92 return -E_GET_BUFFER_TIME;
93 PARA_INFO_LOG("buffer time: %d\n", pad->buffer_time);
94 if (snd_pcm_hw_params_set_buffer_time_near(pad->handle, hwparams,
95 &pad->buffer_time, NULL) < 0)
96 return -E_SET_BUFFER_TIME;
97 if (snd_pcm_hw_params(pad->handle, hwparams) < 0)
98 return -E_HW_PARAMS;
99 snd_pcm_hw_params_get_period_size(hwparams, &period_size, NULL);
100 snd_pcm_hw_params_get_buffer_size(hwparams, &pad->buffer_frames);
101 PARA_INFO_LOG("buffer size: %lu, period_size: %lu\n", pad->buffer_frames,
102 period_size);
103 if (period_size == pad->buffer_frames)
104 return -E_BAD_PERIOD;
105 snd_pcm_sw_params_current(pad->handle, swparams);
106 snd_pcm_sw_params_set_avail_min(pad->handle, swparams, period_size);
107 if (pad->buffer_frames < 1)
108 start_threshold = 1;
109 else
110 start_threshold = PARA_MIN(pad->buffer_frames,
111 (snd_pcm_uframes_t)pad->samplerate);
112 if (snd_pcm_sw_params_set_start_threshold(pad->handle, swparams,
113 start_threshold) < 0)
114 return -E_START_THRESHOLD;
115 stop_threshold = pad->buffer_frames;
116 if (snd_pcm_sw_params_set_stop_threshold(pad->handle, swparams,
117 stop_threshold) < 0)
118 return -E_STOP_THRESHOLD;
119 if (snd_pcm_sw_params(pad->handle, swparams) < 0)
120 PARA_WARNING_LOG("unable to install sw params\n");
121 pad->bytes_per_frame = snd_pcm_format_physical_width(FORMAT)
122 * pad->channels / 8;
123 if (pad->bytes_per_frame <= 0)
124 return -E_PHYSICAL_WIDTH;
125 PARA_INFO_LOG("bytes per frame: %d\n", pad->bytes_per_frame);
126 if (snd_pcm_nonblock(pad->handle, 1))
127 PARA_ERROR_LOG("failed to set nonblock mode\n");
128 return 1;
129 }
130
131 /* Open an instance of the alsa writer. */
132 static int alsa_open_nobtr(struct writer_node *wn)
133 {
134 struct alsa_write_args_info *conf = wn->conf;
135 struct writer_node_group *wng = wn->wng;
136 struct private_alsa_write_data *pad = para_calloc(sizeof(*pad));
137
138 wn->private_data = pad;
139 if (!conf->samplerate_given && wng->samplerate)
140 pad->samplerate = *wng->samplerate;
141 else
142 pad->samplerate = conf->samplerate_arg;
143 if (!conf->channels_given && wng->channels)
144 pad->channels = *wng->channels;
145 else
146 pad->channels = conf->channels_arg;
147 PARA_INFO_LOG("%d channel(s), %dHz\n", pad->channels, pad->samplerate);
148 return 1;
149 }
150
151 static int alsa_open_btr(struct writer_node *wn)
152 {
153 struct private_alsa_write_data *pad = para_calloc(sizeof(*pad));
154
155 wn->private_data = pad;
156 return 1;
157 }
158 static int alsa_open(struct writer_node *wn)
159 {
160 if (wn->btrn)
161 return alsa_open_btr(wn);
162 return alsa_open_nobtr(wn);
163 }
164
165 static int alsa_write_pre_select(struct sched *s, struct writer_node *wn)
166 {
167 struct private_alsa_write_data *pad = wn->private_data;
168 struct writer_node_group *wng = wn->wng;
169 struct timeval tv;
170 snd_pcm_sframes_t avail, underrun;
171
172 if (!pad->handle)
173 return 1;
174 if (wn->btrn) {
175 int ret = btr_node_status(wn->btrn, wn->min_iqs, BTR_NT_LEAF);
176 if (ret == 0)
177 return 1;
178 if (ret < 0) {
179 underrun = 10;
180 goto timeout;
181 }
182 } else {
183 if (*wng->loaded - wn->written < pad->bytes_per_frame)
184 return 1;
185 }
186 /*
187 * Data is available to be written to the alsa handle. Compute number
188 * of milliseconds until next buffer underrun would occur.
189 *
190 * snd_pcm_avail_update() updates the current available count of
191 * samples for writing. It is a light method to obtain current stream
192 * position, because it does not require the user <-> kernel context
193 * switch, but the value is less accurate, because ring buffer pointers
194 * are updated in kernel drivers only when an interrupt occurs.
195 */
196 avail = snd_pcm_avail_update(pad->handle);
197 if (avail < 0)
198 avail = 0;
199 underrun = (pad->buffer_frames - avail) * pad->buffer_time
200 / pad->buffer_frames / 1000;
201 if (underrun < 50)
202 underrun = 50;
203 underrun -= 50;
204 timeout:
205 ms2tv(underrun, &tv);
206 if (tv_diff(&s->timeout, &tv, NULL) > 0)
207 s->timeout = tv;
208 //PARA_CRIT_LOG("timout: %lu\n", tv2ms(&s->timeout));
209 return 1;
210 }
211
212 static void alsa_write_pre_select_btr(struct sched *s, struct task *t)
213 {
214 struct writer_node *wn = container_of(t, struct writer_node, task);
215 alsa_write_pre_select(s, wn);
216 }
217
218 static void xrun(snd_pcm_t *handle)
219 {
220 snd_pcm_status_t *status;
221 int ret;
222 struct timeval tv, diff;
223
224 snd_pcm_status_alloca(&status);
225 ret = snd_pcm_status(handle, status);
226 if (ret < 0)
227 return;
228 if (snd_pcm_status_get_state(status) != SND_PCM_STATE_XRUN)
229 return;
230 snd_pcm_status_get_trigger_tstamp(status, &tv);
231 tv_diff(now, &tv, &diff);
232 PARA_WARNING_LOG("underrun: %lums\n", tv2ms(&diff));
233 }
234
235 static int alsa_write_post_select(__a_unused struct sched *s,
236 struct writer_node *wn)
237 {
238 struct private_alsa_write_data *pad = wn->private_data;
239 struct writer_node_group *wng = wn->wng;
240 size_t bytes = *wng->loaded - wn->written;
241 unsigned char *data = (unsigned char*)*wng->bufp + wn->written;
242 snd_pcm_sframes_t ret, frames, avail;
243
244 if (*wng->input_error < 0 && (!pad->handle || bytes < pad->bytes_per_frame)) {
245 wn->written = *wng->loaded;
246 return *wng->input_error;
247 }
248 if (!bytes) /* no data available */
249 return 0;
250 if (!pad->handle) {
251 int err = alsa_init(pad, wn->conf);
252 if (err < 0)
253 return err;
254 }
255 frames = bytes / pad->bytes_per_frame;
256 if (!frames) /* less than a single frame available */
257 return 0;
258 avail = snd_pcm_avail_update(pad->handle);
259 if (avail <= 0)
260 return 0;
261 frames = PARA_MIN(frames, avail);
262 ret = snd_pcm_writei(pad->handle, data, frames);
263 if (ret >= 0) {
264 wn->written += ret * pad->bytes_per_frame;
265 return 1;
266 }
267 if (ret == -EPIPE) {
268 xrun(pad->handle);
269 snd_pcm_prepare(pad->handle);
270 return 0;
271 }
272 PARA_WARNING_LOG("%s\n", snd_strerror(-ret));
273 if (ret == -EAGAIN)
274 return 0;
275 return -E_ALSA_WRITE;
276 }
277
278 static void alsa_close(struct writer_node *wn)
279 {
280 struct private_alsa_write_data *pad = wn->private_data;
281 PARA_INFO_LOG("closing writer node %p\n", wn);
282
283 if (pad->handle) {
284 /*
285 * It's OK to have a blocking operation here because we already
286 * made sure that the PCM output buffer is (nearly) empty.
287 */
288 snd_pcm_nonblock(pad->handle, 0);
289 snd_pcm_drain(pad->handle);
290 snd_pcm_close(pad->handle);
291 snd_config_update_free_global();
292 }
293 alsa_cmdline_parser_free(wn->conf);
294 free(pad);
295 }
296
297 static void alsa_write_post_select_btr(__a_unused struct sched *s,
298 struct task *t)
299 {
300 struct writer_node *wn = container_of(t, struct writer_node, task);
301 struct private_alsa_write_data *pad = wn->private_data;
302 struct btr_node *btrn = wn->btrn;
303 char *data;
304 size_t bytes;
305 snd_pcm_sframes_t frames, avail;
306 int ret;
307
308 again:
309 t->error = 0;
310 ret = btr_node_status(btrn, wn->min_iqs, BTR_NT_LEAF);
311 if (ret == 0)
312 return;
313 btr_merge(btrn, wn->min_iqs);
314 bytes = btr_next_buffer(btrn, &data);
315 if (bytes < pad->bytes_per_frame) { /* eof */
316 assert(btr_no_parent(btrn));
317 ret = -E_ALSA_EOF;
318 if (!pad->handle)
319 goto err;
320 /* wait until pending frames are played */
321 avail = snd_pcm_avail_update(pad->handle);
322 if (avail + 1000 > pad->buffer_frames)
323 goto err;
324 return;
325 }
326 if (!pad->handle) {
327 struct alsa_write_args_info *conf = wn->conf;
328 if (bytes == 0) /* no data available */
329 return;
330 PARA_CRIT_LOG("alsa init\n");
331 /* defaults */
332 pad->samplerate = conf->samplerate_arg;
333 pad->channels = conf->channels_arg;
334 if (!conf->samplerate_given) { /* config option trumps btr_exec */
335 int32_t rate;
336 ret = get_btr_samplerate(btrn, &rate);
337 if (ret < 0)
338 goto err;
339 pad->samplerate = rate;
340 }
341 if (!conf->channels_given) {
342 int32_t ch;
343 ret = get_btr_channels(btrn, &ch);
344 if (ret < 0)
345 goto err;
346 pad->channels = ch;
347 }
348 PARA_INFO_LOG("%d channel(s), %dHz\n", pad->channels, pad->samplerate);
349 ret = 1;
350 ret = alsa_init(pad, wn->conf);
351 if (ret < 0)
352 goto err;
353 wn->min_iqs = pad->bytes_per_frame;
354 }
355 frames = bytes / pad->bytes_per_frame;
356 avail = snd_pcm_avail_update(pad->handle);
357 if (avail <= 0)
358 return;
359 frames = PARA_MIN(frames, avail);
360 //PARA_CRIT_LOG("writing %ld frames\n", frames);
361 frames = snd_pcm_writei(pad->handle, data, frames);
362 if (frames >= 0) {
363 btr_consume(btrn, frames * pad->bytes_per_frame);
364 goto again;
365 }
366 if (frames == -EPIPE) {
367 xrun(pad->handle);
368 snd_pcm_prepare(pad->handle);
369 return;
370 }
371 PARA_WARNING_LOG("%s\n", snd_strerror(-frames));
372 if (frames == -EAGAIN)
373 return;
374 ret = -E_ALSA_WRITE;
375 err:
376 assert(ret < 0);
377 t->error = ret;
378 }
379
380 __malloc static void *alsa_parse_config(const char *options)
381 {
382 int ret;
383 struct alsa_write_args_info *conf
384 = para_calloc(sizeof(struct alsa_write_args_info));
385
386 PARA_INFO_LOG("options: %s, %zd\n", options, strcspn(options, " \t"));
387 ret = alsa_cmdline_parser_string(options, conf, "alsa_write");
388 if (ret)
389 goto err_out;
390 PARA_INFO_LOG("help given: %d\n", conf->help_given);
391 return conf;
392 err_out:
393 free(conf);
394 return NULL;
395 }
396
397 /**
398 * the init function of the alsa writer
399 *
400 * \param w pointer to the writer to initialize
401 *
402 * \sa struct writer
403 */
404 void alsa_write_init(struct writer *w)
405 {
406 struct alsa_write_args_info dummy;
407
408 alsa_cmdline_parser_init(&dummy);
409 w->open = alsa_open;
410 w->close = alsa_close;
411 w->pre_select = alsa_write_pre_select;
412 w->pre_select_btr = alsa_write_pre_select_btr;
413 w->post_select = alsa_write_post_select;
414 w->post_select_btr = alsa_write_post_select_btr;
415 w->parse_config = alsa_parse_config;
416 w->shutdown = NULL; /* nothing to do */
417 w->help = (struct ggo_help) {
418 .short_help = alsa_write_args_info_help,
419 .detailed_help = alsa_write_args_info_detailed_help
420 };
421 alsa_cmdline_parser_free(&dummy);
422 }