2 * Copyright (C) 2011-2014 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file ao_write.c Paraslash's libao output plugin. */
19 #include "buffer_tree.h"
21 #include "write_common.h"
22 #include "ao_write.cmdline.h"
25 struct private_aow_data {
31 /* The mutex and the condition variable serialize access to ->btrn */
32 pthread_mutex_t mutex;
33 pthread_cond_t data_available;
34 struct btr_node *thread_btrn;
37 static void aow_close(struct writer_node *wn)
39 struct private_aow_data *pawd = wn->private_data;
43 if (pawd->thread_btrn) {
44 pthread_cancel(pawd->thread);
45 pthread_join(pawd->thread, NULL);
49 wn->private_data = NULL;
53 static void aow_pre_select(struct sched *s, struct task *t)
55 struct writer_node *wn = container_of(t, struct writer_node, task);
56 struct private_aow_data *pawd = wn->private_data;
59 if (!pawd) { /* not yet started */
61 ret = btr_node_status(wn->btrn, wn->min_iqs, BTR_NT_LEAF);
64 return; /* no data available */
66 if (!wn->btrn) { /* EOF */
67 if (!pawd->thread_btrn) /* ready to exit */
69 /* wait for the play thread to terminate */
72 pthread_mutex_lock(&pawd->mutex);
73 ret = btr_node_status(wn->btrn, wn->min_iqs, BTR_NT_LEAF);
74 pthread_mutex_unlock(&pawd->mutex);
78 * Even though the node status is zero, we might have data available,
79 * but the output buffer is full. If we don't set a timeout here, we
80 * are woken up only if new data arrives, which might be too late and
81 * result in a buffer underrun in the playing thread. To avoid this we
82 * never sleep longer than the (default) buffer time.
85 return sched_request_timeout_ms(20, s);
90 static int aow_set_sample_format(unsigned sample_rate, unsigned channels,
91 int sample_format, ao_sample_format *result)
93 memset(result, 0, sizeof(*result));
94 switch (sample_format) {
98 return -E_AO_BAD_SAMPLE_FORMAT;
100 /* no need to set byte_format */
105 result->byte_format = AO_FMT_LITTLE;
109 result->byte_format = AO_FMT_BIG;
112 PARA_EMERG_LOG("bug: invalid sample format\n");
115 result->channels = channels;
116 result->rate = sample_rate;
120 static int aow_open_device(int id, ao_sample_format *asf, ao_option *options,
124 ao_device *dev = ao_open_live(id, asf, options);
132 msg = "No driver corresponds to driver_id";
135 msg = "This driver is not a live output device";
138 msg = "A valid option key has an invalid value";
141 msg = "Cannot open the device";
144 msg = "General libao error";
147 msg = "Unknown ao error";
150 PARA_ERROR_LOG("%s\n", msg);
151 return -E_AO_OPEN_LIVE;
154 static int aow_init(struct writer_node *wn, unsigned sample_rate,
155 unsigned channels, int sample_format)
158 ao_option *aoo = NULL;
159 ao_sample_format asf;
161 struct private_aow_data *pawd = para_malloc(sizeof(*pawd));
162 struct ao_write_args_info *conf = wn->conf;
165 if (conf->driver_given) {
166 ret = -E_AO_BAD_DRIVER;
167 id = ao_driver_id(conf->driver_arg);
169 ret = -E_AO_DEFAULT_DRIVER;
170 id = ao_default_driver_id();
174 info = ao_driver_info(id);
175 assert(info && info->short_name);
176 if (info->type == AO_TYPE_FILE) {
177 ret = -E_AO_FILE_NOT_SUPP;
180 PARA_INFO_LOG("using %s driver\n", info->short_name);
181 for (i = 0; i < conf->ao_option_given; i++) {
182 char *o = para_strdup(conf->ao_option_arg[i]), *value;
184 ret = -E_AO_BAD_OPTION;
185 value = strchr(o, ':');
192 PARA_INFO_LOG("appending option: key=%s, value=%s\n", o, value);
193 ret = ao_append_option(&aoo, o, value);
196 ret = -E_AO_APPEND_OPTION;
200 ret = aow_set_sample_format(sample_rate, channels, sample_format, &asf);
203 if (sample_format == SF_S8 || sample_format == SF_U8)
204 pawd->bytes_per_frame = channels;
206 pawd->bytes_per_frame = channels * 2;
207 ret = aow_open_device(id, &asf, aoo, &pawd->dev);
210 PARA_INFO_LOG("successfully opened %s\n", info->short_name);
211 wn->private_data = pawd;
218 __noreturn static void *aow_play(void *priv)
220 struct writer_node *wn = priv;
221 struct private_aow_data *pawd = wn->private_data;
222 struct btr_node *btrn = pawd->thread_btrn;
223 size_t frames, bytes;
228 pthread_mutex_lock(&pawd->mutex);
230 ret = btr_node_status(btrn, wn->min_iqs, BTR_NT_LEAF);
234 btr_merge(btrn, wn->min_iqs);
235 bytes = btr_next_buffer(btrn, &data);
236 frames = bytes / pawd->bytes_per_frame;
239 /* eof and less than a single frame available */
240 ret = -E_WRITE_COMMON_EOF;
244 * No data available, go to sleep and wait for the main
245 * thread to wake us up. pthread_cond_wait() unlocks
246 * the mutex while it waits and locks it again upon
249 ret = pthread_cond_wait(&pawd->data_available,
251 /* pthread_cond_wait() can never fail here */
254 pthread_mutex_unlock(&pawd->mutex);
256 bytes = frames * pawd->bytes_per_frame;
258 if (ao_play(pawd->dev, data, bytes) == 0) /* failure */
260 pthread_mutex_lock(&pawd->mutex);
261 btr_consume(btrn, bytes);
262 pthread_mutex_unlock(&pawd->mutex);
265 pthread_mutex_unlock(&pawd->mutex);
268 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
269 btr_remove_node(&pawd->thread_btrn);
273 static int aow_create_thread(struct writer_node *wn)
275 struct private_aow_data *pawd = wn->private_data;
279 /* initialize with default attributes */
280 msg = "could not init mutex";
281 ret = pthread_mutex_init(&pawd->mutex, NULL);
285 msg = "could not initialize condition variable";
286 ret = pthread_cond_init(&pawd->data_available, NULL);
290 msg = "could not initialize thread attributes";
291 ret = pthread_attr_init(&pawd->attr);
295 /* schedule this thread under the real-time policy SCHED_FIFO */
296 msg = "could not set sched policy";
297 ret = pthread_attr_setschedpolicy(&pawd->attr, SCHED_FIFO);
301 msg = "could not set detach state to joinable";
302 ret = pthread_attr_setdetachstate(&pawd->attr, PTHREAD_CREATE_JOINABLE);
306 msg = "could not create thread";
307 ret = pthread_create(&pawd->thread, &pawd->attr, aow_play, wn);
312 PARA_ERROR_LOG("%s (%s)\n", msg, strerror(ret));
313 return -E_AO_PTHREAD;
316 static int aow_post_select(__a_unused struct sched *s,
319 struct writer_node *wn = container_of(t, struct writer_node, task);
320 struct private_aow_data *pawd = wn->private_data;
324 int32_t rate, ch, format;
325 struct btr_node_description bnd;
327 ret = btr_node_status(wn->btrn, wn->min_iqs, BTR_NT_LEAF);
332 get_btr_sample_rate(wn->btrn, &rate);
333 get_btr_channels(wn->btrn, &ch);
334 get_btr_sample_format(wn->btrn, &format);
335 ret = aow_init(wn, rate, ch, format);
338 pawd = wn->private_data;
340 /* set up thread btr node */
341 bnd.name = "ao_thread_btrn";
342 bnd.parent = wn->btrn;
346 pawd->thread_btrn = btr_new_node(&bnd);
347 wn->private_data = pawd;
349 ret = aow_create_thread(wn);
351 goto remove_thread_btrn;
355 if (!pawd->thread_btrn)
357 PARA_INFO_LOG("waiting for play thread to terminate\n");
360 pthread_mutex_lock(&pawd->mutex);
361 ret = btr_node_status(wn->btrn, wn->min_iqs, BTR_NT_LEAF);
363 btr_pushdown(wn->btrn);
364 if (pthread_cond_signal(&pawd->data_available) != 0) {
366 PARA_ERROR_LOG("pthread_cond_signal() failed\n");
367 goto remove_thread_btrn;
370 pthread_mutex_unlock(&pawd->mutex);
373 pthread_mutex_lock(&pawd->mutex);
374 btr_remove_node(&wn->btrn);
375 pthread_cond_signal(&pawd->data_available);
376 pthread_mutex_unlock(&pawd->mutex);
379 btr_remove_node(&pawd->thread_btrn);
381 btr_remove_node(&wn->btrn);
386 __malloc static void *aow_parse_config_or_die(int argc, char **argv)
388 struct ao_write_args_info *conf = para_calloc(sizeof(*conf));
390 /* exits on errors */
391 ao_write_cmdline_parser(argc, argv, conf);
395 static void aow_free_config(void *conf)
397 ao_write_cmdline_parser_free(conf);
401 * The init function of the ao writer.
403 * \param w Pointer to the writer to initialize.
407 void ao_write_init(struct writer *w)
409 struct ao_write_args_info dummy;
410 int i, j, num_drivers, num_lines;
411 ao_info **driver_list;
412 char **dh; /* detailed help */
414 ao_write_cmdline_parser_init(&dummy);
415 w->close = aow_close;
416 w->pre_select = aow_pre_select;
417 w->post_select = aow_post_select;
418 w->parse_config_or_die = aow_parse_config_or_die;
419 w->free_config = aow_free_config;
420 w->help = (struct ggo_help)DEFINE_GGO_HELP(ao_write);
421 /* create detailed help containing all supported drivers/options */
422 for (i = 0; ao_write_args_info_detailed_help[i]; i++)
425 dh = para_malloc((num_lines + 3) * sizeof(char *));
426 for (i = 0; i < num_lines; i++)
427 dh[i] = para_strdup(ao_write_args_info_detailed_help[i]);
428 dh[num_lines++] = para_strdup("libao drivers available on this host:");
429 dh[num_lines++] = para_strdup("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~");
432 driver_list = ao_driver_info_list(&num_drivers);
434 for (i = 0; i < num_drivers; i++) {
435 ao_info *info = driver_list[i];
436 char *keys = NULL, *tmp = NULL;
438 if (info->type == AO_TYPE_FILE)
440 for (j = 0; j < info->option_count; j++) {
441 tmp = make_message("%s%s%s", keys? keys : "",
447 dh = para_realloc(dh, (num_lines + 6) * sizeof(char *));
448 dh[num_lines++] = make_message("%s: %s", info->short_name, info->name);
449 dh[num_lines++] = make_message("priority: %d", info->priority);
450 dh[num_lines++] = make_message("keys: %s", keys? keys : "[none]");
451 dh[num_lines++] = make_message("comment: %s", info->comment?
452 info->comment : "[none]");
453 dh[num_lines++] = para_strdup(NULL);
456 dh[num_lines] = NULL;
457 w->help.detailed_help = (const char **)dh;
458 ao_write_cmdline_parser_free(&dummy);