/*
- * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2012 Andre Noll <maan@systemlinux.org>
*
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
+ * Licensed under the GPL v2. For licencing details see COPYING.
*/
+/** \file write.c Paraslash's standalone wav/raw player. */
+
+#include <regex.h>
+#include <sys/types.h>
+
#include "para.h"
#include "string.h"
#include "write.cmdline.h"
#include "list.h"
#include "sched.h"
+#include "ggo.h"
#include "stdin.h"
+#include "buffer_tree.h"
#include "write.h"
#include "write_common.h"
#include "fd.h"
#include "error.h"
+#include "version.h"
INIT_WRITE_ERRLISTS;
+enum check_wav_state {
+ CWS_NEED_HEADER,
+ CWS_HAVE_HEADER,
+ CWS_NO_HEADER,
+};
+
+/* Information extracted from the wav header. */
struct check_wav_task {
- char *buf;
- size_t *loaded;
- int *eof;
+ int state;
+ /** Number of channels. */
unsigned channels;
+ unsigned sample_format;
+ /** Sample rate specified in wav header given by \a buf. */
unsigned sample_rate;
+ /** The task structure used by the scheduler. */
struct task task;
+ struct btr_node *btrn;
+ size_t min_iqs;
};
-struct initial_delay_task {
- struct timeval start_time;
- struct task task;
-};
+static struct write_args_info conf;
-static struct gengetopt_args_info conf;
-struct stdin_task sit;
-struct check_wav_task cwt;
-struct initial_delay_task idt;
-static struct writer_node_group *wng;
+static struct stdin_task sit;
+/** Length of a standard wav header. */
#define WAV_HEADER_LEN 44
-/**
- * test if audio buffer contains a valid wave header
- *
- * \return If not, return -E_NO_WAV_HEADER, otherwise, return zero. If
- * there is less than WAV_HEADER_LEN bytes awailable, return one.
- */
-static void check_wav_pre_select(__a_unused struct sched *s, struct task *t)
+static void check_wav_pre_select(struct sched *s, struct task *t)
{
- struct check_wav_task *cwt = t->private_data;
- unsigned char *a;
+ struct check_wav_task *cwt = container_of(t, struct check_wav_task, task);
+ int ret;
- if (*cwt->loaded < WAV_HEADER_LEN) {
- t->ret = *cwt->eof? -E_PREMATURE_END : 1;
- return;
- }
- cwt->channels = 2;
- cwt->sample_rate = 44100;
- a = (unsigned char*)cwt->buf;
- t->ret = -E_NO_WAV_HEADER;
- if (a[0] != 'R' || a[1] != 'I' || a[2] != 'F' || a[3] != 'F')
- return;
- cwt->channels = (unsigned) a[22];
- cwt->sample_rate = a[24] + (a[25] << 8) + (a[26] << 16) + (a[27] << 24);
- *cwt->loaded -= WAV_HEADER_LEN;
- memmove(cwt->buf, cwt->buf + WAV_HEADER_LEN, *cwt->loaded);
- t->ret = -E_WAV_HEADER_SUCCESS;
- PARA_INFO_LOG("channels: %d, sample_rate: %d\n", cwt->channels, cwt->sample_rate);
+ ret = btr_node_status(cwt->btrn, cwt->min_iqs, BTR_NT_INTERNAL);
+ if (ret != 0)
+ sched_min_delay(s);
}
-static void initial_delay_pre_select(struct sched *s, struct task *t)
-{
- struct initial_delay_task *idt = t->private_data;
- struct timeval diff;
-
- t->ret = -E_NO_DELAY;
- if (!idt->start_time.tv_sec && !idt->start_time.tv_usec)
- return;
- t->ret = -E_DELAY_TIMEOUT;
- if (tv_diff(&s->now, &idt->start_time, &diff) > 0)
- return;
- t->ret = 1;
- if (tv_diff(&s->timeout , &diff, NULL) > 0)
- s->timeout = diff;
-}
+#define HANDLE_EXEC(_cmd) \
+ if (!strcmp(cmd, #_cmd)) { \
+ if (!conf._cmd ## _given && cwt->state == CWS_NEED_HEADER) \
+ return -E_BTR_NAVAIL; \
+ *result = make_message("%d", cwt->state == CWS_NO_HEADER || conf._cmd ## _given? \
+ conf._cmd ## _arg : cwt->_cmd); \
+ return 1; \
+ } \
+
-void para_log(int ll, const char* fmt,...)
+static int check_wav_exec(struct btr_node *btrn, const char *cmd, char **result)
{
- va_list argp;
+ struct check_wav_task *cwt = btr_context(btrn);
- if (ll < conf.loglevel_arg)
- return;
- va_start(argp, fmt);
- vfprintf(stderr, fmt, argp);
- va_end(argp);
+ HANDLE_EXEC(sample_rate);
+ HANDLE_EXEC(channels);
+ HANDLE_EXEC(sample_format);
+ return -ERRNO_TO_PARA_ERROR(ENOTSUP);
}
-static struct writer_node_group *check_args(void)
+static void check_wav_post_select(__a_unused struct sched *s, struct task *t)
{
- int i, ret = -E_WRITE_SYNTAX;
- struct writer_node_group *wng = NULL;
-
- if (conf.list_writers_given) {
- char *msg = NULL;
- FOR_EACH_WRITER(i) {
- char *tmp = make_message("%s%s%s",
- i? msg : "",
- i? " " : "",
- writer_names[i]);
- free(msg);
- msg = tmp;
- }
- fprintf(stderr, "%s\n", msg);
- free(msg);
- exit(EXIT_SUCCESS);
- }
-// if (conf.prebuffer_arg < 0 || conf.prebuffer_arg > 100)
-// goto out;
- if (conf.start_time_given) {
- long unsigned sec, usec;
- if (sscanf(conf.start_time_arg, "%lu:%lu",
- &sec, &usec) != 2)
- goto out;
- idt.start_time.tv_sec = sec;
- idt.start_time.tv_usec = usec;
- }
- if (!conf.writer_given) {
- wng = setup_default_wng();
- ret = 1;
+ struct check_wav_task *cwt = container_of(t, struct check_wav_task, task);
+ struct btr_node *btrn = cwt->btrn;
+ unsigned char *a;
+ size_t sz;
+ int ret;
+ uint16_t bps; /* bits per sample */
+ const char *sample_formats[] = {SAMPLE_FORMATS};
+
+ t->error = 0;
+ ret = btr_node_status(btrn, cwt->min_iqs, BTR_NT_INTERNAL);
+ if (ret <= 0)
+ goto out;
+ if (cwt->state != CWS_NEED_HEADER)
+ goto pushdown;
+ btr_merge(btrn, cwt->min_iqs);
+ sz = btr_next_buffer(btrn, (char **)&a);
+ if (sz < cwt->min_iqs) /* file size less than WAV_HEADER_SIZE */
+ goto pushdown;
+ cwt->min_iqs = 0;
+ /*
+ * The default byte ordering assumed for WAVE data files is
+ * little-endian. Files written using the big-endian byte ordering
+ * scheme have the identifier RIFX instead of RIFF.
+ */
+ if (a[0] != 'R' || a[1] != 'I' || a[2] != 'F' ||
+ (a[3] != 'F' && a[3] != 'X')) {
+ PARA_NOTICE_LOG("wav header not found\n");
+ cwt->state = CWS_NO_HEADER;
+ sprintf(t->status, "check wav: no header");
goto out;
}
- wng = wng_new(conf.writer_given);
- ret = -E_WRITE_SYNTAX;
- for (i = 0; i < conf.writer_given; i++) {
- int writer_num;
- wng->writer_nodes[i].conf = check_writer_arg(
- conf.writer_arg[i], &writer_num);
- if (!wng->writer_nodes[i].conf)
- goto out;
- wng->writer_nodes[i].writer = &writers[writer_num];
- sprintf(wng->writer_nodes[i].task.status, "%s",
- writer_names[writer_num]);
+ PARA_INFO_LOG("found wav header\n");
+ cwt->state = CWS_HAVE_HEADER;
+ sprintf(t->status, "check wav: have header");
+ cwt->channels = (unsigned) a[22];
+ cwt->sample_rate = a[24] + (a[25] << 8) + (a[26] << 16) + (a[27] << 24);
+ bps = a[34] + ((unsigned)a[35] << 8);
+ if (bps != 8 && bps != 16) {
+ PARA_WARNING_LOG("%u bps not supported, assuming 16\n", bps);
+ bps = 16;
}
- ret = 1;
+ /*
+ * 8-bit samples are stored as unsigned bytes, ranging from 0 to 255.
+ * 16-bit samples are stored as 2's-complement signed integers, ranging
+ * from -32768 to 32767.
+ */
+ if (bps == 8)
+ cwt->sample_format = SF_U8;
+ else
+ cwt->sample_format = (a[3] == 'F')? SF_S16_LE : SF_S16_BE;
+ PARA_NOTICE_LOG("%dHz, %s, %s\n", cwt->sample_rate,
+ cwt->channels == 1? "mono" : "stereo",
+ sample_formats[cwt->sample_format]);
+ btr_consume(btrn, WAV_HEADER_LEN);
+pushdown:
+ btr_pushdown(btrn);
out:
- if (ret > 0)
- return wng;
- free(wng);
- return NULL;
+ t->error = ret;
+ if (ret < 0)
+ btr_remove_node(btrn);
}
-static void wng_event_handler(struct task *t)
+static int loglevel;
+INIT_STDERR_LOGGING(loglevel)
+
+__noreturn static void print_help_and_die(void)
{
- struct writer_node_group *g = t->private_data;
+ int d = conf.detailed_help_given;
+ const char **p = d? write_args_info_detailed_help
+ : write_args_info_help;
- PARA_INFO_LOG("%s\n", PARA_STRERROR(-t->ret));
- unregister_task(t);
- wng_close(g);
- wng_destroy(g);
+ printf_or_die("%s\n\n", WRITE_CMDLINE_PARSER_PACKAGE "-"
+ WRITE_CMDLINE_PARSER_VERSION);
+ printf_or_die("%s\n\n", write_args_info_usage);
+ for (; *p; p++)
+ printf_or_die("%s\n", *p);
+ print_writer_helps(d);
+ exit(0);
}
-
-static void idt_event_handler(struct task *t)
+/*
+ * Parse config and register a task for a writer node.
+ *
+ * \param arg Command line arguments.
+ * \param parent The new node will be a child of \a parent.
+ * \param wn The writer node.
+ *
+ * If arg is \p NULL, the OS-dependent default writer is used with no
+ * arguments. The default writers are alsa for Linux, osx for OS X, oss for
+ * *BSD, and the file writer if the default writer is not supported.
+ *
+ * Once the writer configuration has been retrieved from the ->parse_config
+ * callback a writer node is created, its buffer tree node is added to the
+ * buffer tree as a child of the given parent.
+ *
+ * Finally, the new writer node's task structure is initialized and registered
+ * to the paraslash scheduler.
+ *
+ * \return Standard.
+ */
+static void setup_writer_node(const char *arg, struct btr_node *parent,
+ struct writer_node *wn, struct sched *s)
{
- int ret;
-
- PARA_INFO_LOG("%s\n", PARA_STRERROR(-t->ret));
- unregister_task(t);
- wng->buf = sit.buf;
- wng->loaded = &sit.loaded;
- wng->input_eof = &sit.eof;
- wng->task.event_handler = wng_event_handler;
- ret = wng_open(wng);
- if (ret < 0) {
- PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
- exit(EXIT_FAILURE);
+ if (arg)
+ wn->conf = check_writer_arg_or_die(arg, &wn->writer_num);
+ else {
+ wn->writer_num = DEFAULT_WRITER;
+ wn->conf = writers[DEFAULT_WRITER].parse_config_or_die("");
}
+ register_writer_node(wn, parent, s);
}
-static void cwt_event_handler(struct task *t)
+static int setup_and_schedule(void)
{
- if (t->ret != -E_NO_WAV_HEADER && t->ret != -E_WAV_HEADER_SUCCESS) {
- PARA_ERROR_LOG("%s\n", PARA_STRERROR(-t->ret));
- exit(EXIT_FAILURE);
+ int i, ret;
+ struct check_wav_task _cwt, *cwt = &_cwt;
+ struct writer_node *wns;
+ static struct sched s;
+
+ loglevel = get_loglevel_by_name(conf.loglevel_arg);
+ sit.btrn = btr_new_node(&(struct btr_node_description)
+ EMBRACE(.name = "stdin"));
+ stdin_set_defaults(&sit);
+ register_task(&s, &sit.task);
+
+ cwt->state = CWS_NEED_HEADER;
+ cwt->min_iqs = WAV_HEADER_LEN;
+ cwt->btrn = btr_new_node(&(struct btr_node_description)
+ EMBRACE(.name = "check_wav", .parent = sit.btrn,
+ .handler = check_wav_exec, .context = cwt));
+ sprintf(cwt->task.status, "check_wav");
+ cwt->task.pre_select = check_wav_pre_select;
+ cwt->task.post_select = check_wav_post_select;
+ cwt->task.error = 0;
+ register_task(&s, &cwt->task);
+
+ if (!conf.writer_given) {
+ wns = para_calloc(sizeof(*wns));
+ setup_writer_node(NULL, cwt->btrn, wns, &s);
+ i = 1;
+ } else {
+ wns = para_calloc(conf.writer_given * sizeof(*wns));
+ for (i = 0; i < conf.writer_given; i++)
+ setup_writer_node(conf.writer_arg[i], cwt->btrn,
+ wns + i, &s);
+ }
+
+ s.default_timeout.tv_sec = 10;
+ s.default_timeout.tv_usec = 50000;
+ ret = schedule(&s);
+ if (ret >= 0) {
+ int j;
+ for (j = 0; j < i; j++) {
+ struct task *t = &wns[j].task;
+ assert(t->error < 0);
+ if (t->error != -E_WRITE_COMMON_EOF
+ && t->error != -E_BTR_EOF) {
+ PARA_ERROR_LOG("%s: %s\n", t->status,
+ para_strerror(-t->error));
+ if (ret >= 0)
+ ret = t->error;
+ }
+ }
}
- PARA_INFO_LOG("%s\n", PARA_STRERROR(-t->ret));
- unregister_task(t);
-// if (t->ret == -E_WAV_HEADER_SUCCESS) {
-// conf.channels_arg = cwt.channels;
-// conf.sample_rate_arg = cwt.sample_rate;
-// }
- idt.task.pre_select = initial_delay_pre_select;
- idt.task.private_data = &idt;
- idt.task.event_handler = idt_event_handler;
- sprintf(idt.task.status, "initial_delay");
- register_task(&idt.task);
+ for (i--; i >= 0; i--) {
+ struct writer_node *wn = wns + i;
+ struct writer *w = writers + wn->writer_num;
+
+ w->close(wn);
+ btr_free_node(wn->btrn);
+ w->free_config(wn->conf);
+ free(wn->conf);
+ }
+ free(wns);
+ btr_free_node(cwt->btrn);
+ return ret;
}
+/**
+ * Para_write's main function.
+ *
+ * \param argc The usual argument counter.
+ * \param argv The usual argument vector.
+ *
+ * It sets up and starts the tasks and the buffer tree nodes determined by
+ * command line options.
+ *
+ * \return \p EXIT_SUCCESS or EXIT_FAILURE
+ */
int main(int argc, char *argv[])
{
- int ret = -E_WRITE_SYNTAX;
- struct sched s;
-
- cmdline_parser(argc, argv, &conf);
- init_supported_writers();
- init_sched();
+ int ret;
- wng = check_args();
- if (!wng)
- goto out;
- stdin_set_defaults(&sit);
- if (conf.bufsize_given)
- sit.bufsize = conf.bufsize_arg;
- sit.buf = para_malloc(sit.bufsize),
- register_task(&sit.task);
-
- cwt.task.pre_select = check_wav_pre_select;
- cwt.task.private_data = &cwt;
- cwt.task.event_handler = cwt_event_handler;
- cwt.buf = sit.buf;
- cwt.loaded = &sit.loaded;
- cwt.eof = &sit.eof;
- sprintf(cwt.task.status, "check wav");
- register_task(&cwt.task);
-
- s.default_timeout.tv_sec = 1;
- s.default_timeout.tv_usec = 0;
- ret = sched(&s);
+ writer_init();
+ write_cmdline_parser(argc, argv, &conf);
+ HANDLE_VERSION_FLAG("write", conf);
+ if (conf.help_given || conf.detailed_help_given)
+ print_help_and_die();
-out:
+ ret = setup_and_schedule();
if (ret < 0) {
- PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
- ret = EXIT_FAILURE;
- } else
- ret = EXIT_SUCCESS;
- return ret;
+ PARA_ERROR_LOG("%s\n", para_strerror(-ret));
+ exit(EXIT_FAILURE);
+ }
+ exit(EXIT_SUCCESS);
}