para.h: Fix typo in comment.
[paraslash.git] / alsa_write.c
1 /*
2 * Copyright (C) 2005-2010 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 /** Data specific to the alsa writer. */
35 struct private_alsa_write_data {
36 /** The alsa handle */
37 snd_pcm_t *handle;
38 /** Determined and set by alsa_open(). */
39 int bytes_per_frame;
40 /** The approximate maximum buffer duration in us. */
41 unsigned buffer_time;
42 /* Number of frames that fit into the buffer. */
43 snd_pcm_uframes_t buffer_frames;
44 /**
45 * The sample rate given by command line option or the decoder
46 * of the writer node group.
47 */
48 unsigned sample_rate;
49 snd_pcm_format_t sample_format;
50 /**
51 * The number of channels, given by command line option or the
52 * decoder of the writer node group.
53 */
54 unsigned channels;
55 struct timeval drain_barrier;
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 period_size;
79 int err;
80
81 PARA_INFO_LOG("opening %s\n", conf->device_arg);
82 err = snd_pcm_open(&pad->handle, conf->device_arg,
83 SND_PCM_STREAM_PLAYBACK, SND_PCM_NONBLOCK);
84 if (err < 0)
85 return -E_PCM_OPEN;
86
87 snd_pcm_hw_params_alloca(&hwparams);
88 snd_pcm_sw_params_alloca(&swparams);
89 if (snd_pcm_hw_params_any(pad->handle, hwparams) < 0)
90 return -E_BROKEN_CONF;
91 if (snd_pcm_hw_params_set_access(pad->handle, hwparams,
92 SND_PCM_ACCESS_RW_INTERLEAVED) < 0)
93 return -E_ACCESS_TYPE;
94 if (snd_pcm_hw_params_set_format(pad->handle, hwparams,
95 pad->sample_format) < 0)
96 return -E_SAMPLE_FORMAT;
97 if (snd_pcm_hw_params_set_channels(pad->handle, hwparams,
98 pad->channels) < 0)
99 return -E_CHANNEL_COUNT;
100 if (snd_pcm_hw_params_set_rate_near(pad->handle, hwparams,
101 &pad->sample_rate, NULL) < 0)
102 return -E_SET_RATE;
103 err = snd_pcm_hw_params_get_buffer_time_max(hwparams,
104 &pad->buffer_time, NULL);
105 if (err < 0 || !pad->buffer_time)
106 return -E_GET_BUFFER_TIME;
107 PARA_INFO_LOG("buffer time: %d\n", pad->buffer_time);
108 if (snd_pcm_hw_params_set_buffer_time_near(pad->handle, hwparams,
109 &pad->buffer_time, NULL) < 0)
110 return -E_SET_BUFFER_TIME;
111 if (snd_pcm_hw_params(pad->handle, hwparams) < 0)
112 return -E_HW_PARAMS;
113 snd_pcm_hw_params_get_period_size(hwparams, &period_size, NULL);
114 snd_pcm_hw_params_get_buffer_size(hwparams, &pad->buffer_frames);
115 PARA_INFO_LOG("buffer size: %lu, period_size: %lu\n", pad->buffer_frames,
116 period_size);
117 if (period_size == pad->buffer_frames)
118 return -E_BAD_PERIOD;
119 snd_pcm_sw_params_current(pad->handle, swparams);
120 snd_pcm_sw_params_set_avail_min(pad->handle, swparams, period_size);
121 if (pad->buffer_frames < 1)
122 start_threshold = 1;
123 else
124 start_threshold = PARA_MIN(pad->buffer_frames,
125 (snd_pcm_uframes_t)pad->sample_rate);
126 if (snd_pcm_sw_params_set_start_threshold(pad->handle, swparams,
127 start_threshold) < 0)
128 return -E_START_THRESHOLD;
129 stop_threshold = pad->buffer_frames;
130 if (snd_pcm_sw_params_set_stop_threshold(pad->handle, swparams,
131 stop_threshold) < 0)
132 return -E_STOP_THRESHOLD;
133 if (snd_pcm_sw_params(pad->handle, swparams) < 0)
134 PARA_WARNING_LOG("unable to install sw params\n");
135 pad->bytes_per_frame = snd_pcm_format_physical_width(pad->sample_format)
136 * pad->channels / 8;
137 if (pad->bytes_per_frame <= 0)
138 return -E_PHYSICAL_WIDTH;
139 PARA_INFO_LOG("bytes per frame: %d\n", pad->bytes_per_frame);
140 if (snd_pcm_nonblock(pad->handle, 1))
141 PARA_ERROR_LOG("failed to set nonblock mode\n");
142 return 1;
143 }
144
145 /* Open an instance of the alsa writer. */
146 static int alsa_open(struct writer_node *wn)
147 {
148 wn->private_data = para_calloc(sizeof(struct private_alsa_write_data));
149 return 1;
150 }
151
152 static void alsa_write_pre_select(struct sched *s, struct task *t)
153 {
154 struct writer_node *wn = container_of(t, struct writer_node, task);
155 struct private_alsa_write_data *pad = wn->private_data;
156 struct timeval tv;
157 snd_pcm_sframes_t avail, underrun;
158 int ret;
159
160 if (!pad->handle)
161 return;
162 ret = btr_node_status(wn->btrn, wn->min_iqs, BTR_NT_LEAF);
163 if (ret < 0)
164 sched_request_timeout_ms(20, s);
165 if (ret <= 0)
166 return;
167 /*
168 * Data is available to be written to the alsa handle. Compute number
169 * of milliseconds until next buffer underrun would occur.
170 *
171 * snd_pcm_avail_update() updates the current available count of
172 * samples for writing. It is a light method to obtain current stream
173 * position, because it does not require the user <-> kernel context
174 * switch, but the value is less accurate, because ring buffer pointers
175 * are updated in kernel drivers only when an interrupt occurs.
176 */
177 avail = snd_pcm_avail_update(pad->handle);
178 if (avail < 0)
179 avail = 0;
180 underrun = (pad->buffer_frames - avail) * pad->buffer_time
181 / pad->buffer_frames / 1000;
182 if (underrun < 50)
183 underrun = 50;
184 underrun -= 50;
185 ms2tv(underrun, &tv);
186 if (tv_diff(&s->timeout, &tv, NULL) > 0)
187 s->timeout = tv;
188 }
189
190 static void alsa_close(struct writer_node *wn)
191 {
192 struct private_alsa_write_data *pad = wn->private_data;
193 PARA_INFO_LOG("closing writer node %p\n", wn);
194
195 if (pad->handle) {
196 /*
197 * It's OK to have a blocking operation here because we already
198 * made sure that the PCM output buffer is (nearly) empty.
199 */
200 snd_pcm_nonblock(pad->handle, 0);
201 snd_pcm_drain(pad->handle);
202 snd_pcm_close(pad->handle);
203 snd_config_update_free_global();
204 }
205 free(pad);
206 }
207
208 static void alsa_write_post_select(__a_unused struct sched *s,
209 struct task *t)
210 {
211 struct writer_node *wn = container_of(t, struct writer_node, task);
212 struct private_alsa_write_data *pad = wn->private_data;
213 struct btr_node *btrn = wn->btrn;
214 char *data;
215 size_t bytes;
216 snd_pcm_sframes_t frames;
217 int ret;
218
219 again:
220 t->error = 0;
221 ret = btr_node_status(btrn, wn->min_iqs, BTR_NT_LEAF);
222 if (ret == 0)
223 return;
224 btr_merge(btrn, wn->min_iqs);
225 bytes = btr_next_buffer(btrn, &data);
226 if (ret < 0 || bytes < pad->bytes_per_frame) { /* eof */
227 assert(btr_no_parent(btrn));
228 ret = -E_ALSA_EOF;
229 if (!pad->handle)
230 goto err;
231 /* wait until pending frames are played */
232 if (pad->drain_barrier.tv_sec == 0) {
233 PARA_DEBUG_LOG("waiting for device to drain\n");
234 tv_add(now, &(struct timeval)EMBRACE(0, 200 * 1000),
235 &pad->drain_barrier);
236 return;
237 }
238 if (tv_diff(now, &pad->drain_barrier, NULL) > 0)
239 goto err;
240 return;
241 }
242 if (!pad->handle) {
243 int32_t val;
244
245 if (bytes == 0) /* no data available */
246 return;
247 get_btr_sample_rate(btrn, &val);
248 pad->sample_rate = val;
249 get_btr_channels(btrn, &val);
250 pad->channels = val;
251 get_btr_sample_format(btrn, &val);
252 pad->sample_format = get_alsa_pcm_format(val);
253
254 PARA_INFO_LOG("%d channel(s), %dHz\n", pad->channels,
255 pad->sample_rate);
256 ret = alsa_init(pad, wn->conf);
257 if (ret < 0)
258 goto err;
259 wn->min_iqs = pad->bytes_per_frame;
260 goto again;
261 }
262 frames = bytes / pad->bytes_per_frame;
263 frames = snd_pcm_writei(pad->handle, data, frames);
264 if (frames >= 0) {
265 btr_consume(btrn, frames * pad->bytes_per_frame);
266 goto again;
267 }
268 if (frames == -EPIPE) {
269 PARA_WARNING_LOG("underrun (tried to write %zu bytes)\n", bytes);
270 snd_pcm_prepare(pad->handle);
271 return;
272 }
273 if (frames == -EAGAIN)
274 return;
275 PARA_WARNING_LOG("%s\n", snd_strerror(-frames));
276 ret = -E_ALSA_WRITE;
277 err:
278 assert(ret < 0);
279 btr_remove_node(btrn);
280 t->error = ret;
281 }
282
283 __malloc static void *alsa_parse_config(const char *options)
284 {
285 int ret;
286 struct alsa_write_args_info *conf
287 = para_calloc(sizeof(struct alsa_write_args_info));
288
289 PARA_INFO_LOG("options: %s, %zd\n", options, strcspn(options, " \t"));
290 ret = alsa_cmdline_parser_string(options, conf, "alsa_write");
291 if (ret)
292 goto err_out;
293 PARA_INFO_LOG("help given: %d\n", conf->help_given);
294 return conf;
295 err_out:
296 free(conf);
297 return NULL;
298 }
299
300 static void alsa_free_config(void *conf)
301 {
302 alsa_cmdline_parser_free(conf);
303 }
304
305 /**
306 * The init function of the alsa writer.
307 *
308 * \param w Pointer to the writer to initialize.
309 *
310 * \sa struct \ref writer.
311 */
312 void alsa_write_init(struct writer *w)
313 {
314 struct alsa_write_args_info dummy;
315
316 alsa_cmdline_parser_init(&dummy);
317 w->open = alsa_open;
318 w->close = alsa_close;
319 w->pre_select = alsa_write_pre_select;
320 w->post_select = alsa_write_post_select;
321 w->parse_config = alsa_parse_config;
322 w->shutdown = NULL; /* nothing to do */
323 w->free_config = alsa_free_config;
324 w->help = (struct ggo_help) {
325 .short_help = alsa_write_args_info_help,
326 .detailed_help = alsa_write_args_info_detailed_help
327 };
328 alsa_cmdline_parser_free(&dummy);
329 }