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 pthread_mutex_t mutex;
32 pthread_cond_t data_available;
33 struct btr_node *thread_btrn;
36 static void aow_close(struct writer_node *wn)
38 struct private_aow_data *pawd = wn->private_data;
44 wn->private_data = NULL;
48 static void aow_pre_select(struct sched *s, struct task *t)
50 struct writer_node *wn = container_of(t, struct writer_node, task);
51 struct private_aow_data *pawd = wn->private_data;
54 if (!pawd) { /* not yet started */
56 ret = btr_node_status(wn->btrn, wn->min_iqs, BTR_NT_LEAF);
59 return; /* no data available */
61 if (!wn->btrn) { /* EOF */
62 if (!pawd->thread_btrn) /* ready to exit */
64 /* wait for the play thread to terminate */
67 pthread_mutex_lock(&pawd->mutex);
68 ret = btr_node_status(wn->btrn, wn->min_iqs, BTR_NT_LEAF);
69 pthread_mutex_unlock(&pawd->mutex);
73 * Even though the node status is zero, we might have data available,
74 * but the output buffer is full. If we don't set a timeout here, we
75 * are woken up only if new data arrives, which might be too late and
76 * result in a buffer underrun in the playing thread. To avoid this we
77 * never sleep longer than the (default) buffer time.
80 return sched_request_timeout_ms(20, s);
85 static int aow_set_sample_format(unsigned sample_rate, unsigned channels,
86 int sample_format, ao_sample_format *result)
88 memset(result, 0, sizeof(*result));
89 switch (sample_format) {
93 return -E_AO_BAD_SAMPLE_FORMAT;
95 /* no need to set byte_format */
100 result->byte_format = AO_FMT_LITTLE;
104 result->byte_format = AO_FMT_BIG;
107 PARA_EMERG_LOG("bug: invalid sample format\n");
110 result->channels = channels;
111 result->rate = sample_rate;
115 static int aow_open_device(int id, ao_sample_format *asf, ao_option *options,
119 ao_device *dev = ao_open_live(id, asf, options);
127 msg = "No driver corresponds to driver_id";
130 msg = "This driver is not a live output device";
133 msg = "A valid option key has an invalid value";
136 msg = "Cannot open the device";
139 msg = "General libao error";
142 msg = "Unknown ao error";
145 PARA_ERROR_LOG("%s\n", msg);
146 return -E_AO_OPEN_LIVE;
149 static int aow_init(struct writer_node *wn, unsigned sample_rate,
150 unsigned channels, int sample_format)
153 ao_option *aoo = NULL;
154 ao_sample_format asf;
156 struct private_aow_data *pawd = para_malloc(sizeof(*pawd));
157 struct ao_write_args_info *conf = wn->conf;
160 if (conf->driver_given) {
161 ret = -E_AO_BAD_DRIVER;
162 id = ao_driver_id(conf->driver_arg);
164 ret = -E_AO_DEFAULT_DRIVER;
165 id = ao_default_driver_id();
169 info = ao_driver_info(id);
170 assert(info && info->short_name);
171 if (info->type == AO_TYPE_FILE) {
172 ret = -E_AO_FILE_NOT_SUPP;
175 PARA_INFO_LOG("using %s driver\n", info->short_name);
176 for (i = 0; i < conf->ao_option_given; i++) {
177 char *o = para_strdup(conf->ao_option_arg[i]), *value;
179 ret = -E_AO_BAD_OPTION;
180 value = strchr(o, ':');
187 PARA_INFO_LOG("appending option: key=%s, value=%s\n", o, value);
188 ret = ao_append_option(&aoo, o, value);
191 ret = -E_AO_APPEND_OPTION;
195 ret = aow_set_sample_format(sample_rate, channels, sample_format, &asf);
198 if (sample_format == SF_S8 || sample_format == SF_U8)
199 pawd->bytes_per_frame = channels;
201 pawd->bytes_per_frame = channels * 2;
202 ret = aow_open_device(id, &asf, aoo, &pawd->dev);
205 PARA_INFO_LOG("successfully opened %s\n", info->short_name);
206 wn->private_data = pawd;
213 __noreturn static void *aow_play(void *priv)
215 struct writer_node *wn = priv;
216 struct private_aow_data *pawd = wn->private_data;
217 struct btr_node *btrn = pawd->thread_btrn;
218 size_t frames, bytes;
224 * Lock mutex and wait for signal. pthread_cond_wait() will
225 * automatically and atomically unlock mutex while it waits.
227 pthread_mutex_lock(&pawd->mutex);
229 ret = btr_node_status(btrn, wn->min_iqs, BTR_NT_LEAF);
233 btr_merge(btrn, wn->min_iqs);
234 bytes = btr_next_buffer(btrn, &data);
235 frames = bytes / pawd->bytes_per_frame;
238 /* eof and less than a single frame available */
239 ret = -E_WRITE_COMMON_EOF;
242 //PARA_CRIT_LOG("waiting for data\n");
244 //pthread_mutex_unlock(&pawd->mutex);
245 pthread_cond_wait(&pawd->data_available, &pawd->mutex);
247 pthread_mutex_unlock(&pawd->mutex);
249 bytes = frames * pawd->bytes_per_frame;
251 if (ao_play(pawd->dev, data, bytes) == 0) /* failure */
253 pthread_mutex_lock(&pawd->mutex);
254 btr_consume(btrn, bytes);
255 pthread_mutex_unlock(&pawd->mutex);
258 pthread_mutex_unlock(&pawd->mutex);
261 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
262 btr_remove_node(&pawd->thread_btrn);
266 static int aow_create_thread(struct writer_node *wn)
268 struct private_aow_data *pawd = wn->private_data;
272 /* initialize with default attributes */
273 msg = "could not init mutex";
274 ret = pthread_mutex_init(&pawd->mutex, NULL);
278 msg = "could not initialize condition variable";
279 ret = pthread_cond_init(&pawd->data_available, NULL);
283 msg = "could not initialize thread attributes";
284 ret = pthread_attr_init(&pawd->attr);
288 /* schedule this thread under the real-time policy SCHED_FIFO */
289 msg = "could not set sched policy";
290 ret = pthread_attr_setschedpolicy(&pawd->attr, SCHED_FIFO);
294 msg = "could not set detach state to joinable";
295 ret = pthread_attr_setdetachstate(&pawd->attr, PTHREAD_CREATE_JOINABLE);
299 msg = "could not create thread";
300 ret = pthread_create(&pawd->thread, &pawd->attr, aow_play, wn);
305 PARA_ERROR_LOG("%s (%s)\n", msg, strerror(ret));
306 return -E_AO_PTHREAD;
309 static int aow_post_select(__a_unused struct sched *s,
312 struct writer_node *wn = container_of(t, struct writer_node, task);
313 struct private_aow_data *pawd = wn->private_data;
317 int32_t rate, ch, format;
318 struct btr_node_description bnd;
320 ret = btr_node_status(wn->btrn, wn->min_iqs, BTR_NT_LEAF);
325 get_btr_sample_rate(wn->btrn, &rate);
326 get_btr_channels(wn->btrn, &ch);
327 get_btr_sample_format(wn->btrn, &format);
328 ret = aow_init(wn, rate, ch, format);
331 pawd = wn->private_data;
333 /* set up thread btr node */
334 bnd.name = "ao_thread_btrn";
335 bnd.parent = wn->btrn;
339 pawd->thread_btrn = btr_new_node(&bnd);
340 wn->private_data = pawd;
342 ret = aow_create_thread(wn);
344 goto remove_thread_btrn;
348 if (!pawd->thread_btrn)
350 PARA_INFO_LOG("waiting for play thread to terminate\n");
353 pthread_mutex_lock(&pawd->mutex);
354 ret = btr_node_status(wn->btrn, wn->min_iqs, BTR_NT_LEAF);
356 btr_pushdown(wn->btrn);
357 pthread_cond_signal(&pawd->data_available);
359 pthread_mutex_unlock(&pawd->mutex);
362 pthread_mutex_lock(&pawd->mutex);
363 btr_remove_node(&wn->btrn);
364 pthread_cond_signal(&pawd->data_available);
365 pthread_mutex_unlock(&pawd->mutex);
368 btr_remove_node(&pawd->thread_btrn);
370 btr_remove_node(&wn->btrn);
375 __malloc static void *aow_parse_config_or_die(int argc, char **argv)
377 struct ao_write_args_info *conf = para_calloc(sizeof(*conf));
379 /* exits on errors */
380 ao_write_cmdline_parser(argc, argv, conf);
384 static void aow_free_config(void *conf)
386 ao_write_cmdline_parser_free(conf);
390 * The init function of the ao writer.
392 * \param w Pointer to the writer to initialize.
396 void ao_write_init(struct writer *w)
398 struct ao_write_args_info dummy;
399 int i, j, num_drivers, num_lines;
400 ao_info **driver_list;
401 char **dh; /* detailed help */
403 ao_write_cmdline_parser_init(&dummy);
404 w->close = aow_close;
405 w->pre_select = aow_pre_select;
406 w->post_select = aow_post_select;
407 w->parse_config_or_die = aow_parse_config_or_die;
408 w->free_config = aow_free_config;
409 w->help = (struct ggo_help)DEFINE_GGO_HELP(ao_write);
410 /* create detailed help containing all supported drivers/options */
411 for (i = 0; ao_write_args_info_detailed_help[i]; i++)
414 dh = para_malloc((num_lines + 3) * sizeof(char *));
415 for (i = 0; i < num_lines; i++)
416 dh[i] = para_strdup(ao_write_args_info_detailed_help[i]);
417 dh[num_lines++] = para_strdup("libao drivers available on this host:");
418 dh[num_lines++] = para_strdup("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~");
421 driver_list = ao_driver_info_list(&num_drivers);
423 for (i = 0; i < num_drivers; i++) {
424 ao_info *info = driver_list[i];
425 char *keys = NULL, *tmp = NULL;
427 if (info->type == AO_TYPE_FILE)
429 for (j = 0; j < info->option_count; j++) {
430 tmp = make_message("%s%s%s", keys? keys : "",
436 dh = para_realloc(dh, (num_lines + 6) * sizeof(char *));
437 dh[num_lines++] = make_message("%s: %s", info->short_name, info->name);
438 dh[num_lines++] = make_message("priority: %d", info->priority);
439 dh[num_lines++] = make_message("keys: %s", keys? keys : "[none]");
440 dh[num_lines++] = make_message("comment: %s", info->comment?
441 info->comment : "[none]");
442 dh[num_lines++] = para_strdup(NULL);
445 dh[num_lines] = NULL;
446 w->help.detailed_help = (const char **)dh;
447 ao_write_cmdline_parser_free(&dummy);