/*
- * 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"
-#include <sys/time.h> /* gettimeofday */
+INIT_WRITE_ERRLISTS;
-#include "error.h"
+enum check_wav_state {
+ CWS_NEED_HEADER,
+ CWS_HAVE_HEADER,
+ CWS_NO_HEADER,
+};
-#define WAV_HEADER_LEN 44
+/* Information extracted from the wav header. */
+struct check_wav_task {
+ 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;
+};
-static char *audiobuf;
-static struct timeval *start_time;
-struct gengetopt_args_info conf;
+static struct write_args_info conf;
-INIT_WRITE_ERRLISTS;
+static struct stdin_task sit;
+
+/** Length of a standard wav header. */
+#define WAV_HEADER_LEN 44
-void para_log(int ll, const char* fmt,...)
+static void check_wav_pre_select(struct sched *s, struct task *t)
{
- va_list argp;
+ struct check_wav_task *cwt = container_of(t, struct check_wav_task, task);
+ int ret;
- if (ll < conf.loglevel_arg)
- return;
- va_start(argp, fmt);
- vfprintf(stderr, fmt, argp);
- va_end(argp);
+ ret = btr_node_status(cwt->btrn, cwt->min_iqs, BTR_NT_INTERNAL);
+ if (ret != 0)
+ sched_min_delay(s);
}
-/**
- * read WAV_HEADER_LEN bytes from stdin to audio buffer
- *
- * \return -E_READ_HDR on errors and on eof before WAV_HEADER_LEN could be
- * read. A positive return value indicates success.
- */
-static int read_wav_header(void)
-{
- ssize_t ret, count = 0;
+#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; \
+ } \
- while (count < WAV_HEADER_LEN) {
- ret = read(STDIN_FILENO, audiobuf + count, WAV_HEADER_LEN - count);
- if (ret <= 0)
- return -E_READ_HDR;
- count += ret;
- }
- return 1;
-}
-/**
- * check if current time is later than start_time
- * \param diff pointer to write remaining time to
- *
- * If start_time was not given, or current time is later than given
- * start_time, return 0. Otherwise, return 1 and write the time
- * difference between current time and start_time to diff. diff may be
- * NULL.
- *
- */
-static int start_time_in_future(struct timeval *diff)
+static int check_wav_exec(struct btr_node *btrn, const char *cmd, char **result)
{
- struct timeval now;
+ struct check_wav_task *cwt = btr_context(btrn);
- if (!conf.start_time_given)
- return 0;
- gettimeofday(&now, NULL);
- return tv_diff(start_time, &now, diff) > 0? 1 : 0;
+ HANDLE_EXEC(sample_rate);
+ HANDLE_EXEC(channels);
+ HANDLE_EXEC(sample_format);
+ return -ERRNO_TO_PARA_ERROR(ENOTSUP);
}
-/**
- * sleep until time given at command line
- *
- * This is called if the initial buffer is filled. It returns
- * immediately if no start_time was given at the command line
- * or if the given start time is in the past.
- *
- */
-static void do_initial_delay(struct timeval *delay)
+static void check_wav_post_select(__a_unused struct sched *s, struct task *t)
{
- do
- para_select(1, NULL, NULL, delay);
- while (start_time_in_future(delay));
+ 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;
+ }
+ 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;
+ }
+ /*
+ * 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:
+ t->error = ret;
+ if (ret < 0)
+ btr_remove_node(btrn);
}
-static int read_stdin(char *buf, size_t bytes_to_load, size_t *loaded)
+static int loglevel;
+INIT_STDERR_LOGGING(loglevel)
+
+__noreturn static void print_help_and_die(void)
{
- ssize_t ret;
+ int d = conf.detailed_help_given;
+ const char **p = d? write_args_info_detailed_help
+ : write_args_info_help;
- while (*loaded < bytes_to_load) {
- ret = read(STDIN_FILENO, buf + *loaded, bytes_to_load - *loaded);
- if (ret <= 0) {
- if (ret < 0)
- ret = -E_READ_STDIN;
- return ret;
- }
- *loaded += ret;
- }
- return 1;
+ 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);
}
-/**
- * play raw pcm data
- * \param loaded number of bytes already loaded
+
+/*
+ * 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 start_time was given, prebuffer data until buffer is full or
- * start_time is reached. In any case, do not start playing before
- * start_time.
+ * 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.
*
- * \return positive on success, negative on errors.
+ * 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 int pcm_write(struct writer_node_group *wng, size_t loaded)
+static void setup_writer_node(const char *arg, struct btr_node *parent,
+ struct writer_node *wn, struct sched *s)
{
- size_t bufsize, prebuf_size, bytes_to_load;
- struct timeval delay;
- int ret, not_yet_started = 1;
-
- ret = wng_open(wng);
- if (ret < 0)
- goto out;
- PARA_INFO_LOG("max chunk_bytes: %zd\n", wng->max_chunk_bytes);
- bufsize = (conf.bufsize_arg * 1024 / wng->max_chunk_bytes)
- * wng->max_chunk_bytes;
- audiobuf = para_realloc(audiobuf, bufsize);
- prebuf_size = conf.prebuffer_arg * bufsize / 100;
- bytes_to_load = PARA_MIN(prebuf_size, wng->max_chunk_bytes);
- ret = read_stdin(audiobuf, bytes_to_load, &loaded);
- if (ret <= 0 || loaded < bytes_to_load) {
- if (ret >= 0)
- ret = -E_PREMATURE_END;
- goto out;
+ 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("");
}
- if (not_yet_started && start_time && start_time_in_future(&delay))
- do_initial_delay(&delay);
- not_yet_started = 0;
-again:
- ret = wng_write(wng, audiobuf, &loaded);
- if (ret <= 0)
- goto out;
- ret = -E_WRITE_OVERRUN;
- if (loaded >= bufsize)
- goto out;
- bytes_to_load = PARA_MIN(wng->max_chunk_bytes, bufsize);
- ret = read_stdin(audiobuf, bytes_to_load, &loaded);
- if (ret < 0)
- goto out;
- if (!ret)
- wng->eof = 1;
- goto again;
-out:
- wng_close(wng);
- return ret;
+ register_writer_node(wn, parent, s);
}
-static struct writer_node_group *check_args(void)
+static int setup_and_schedule(void)
{
- int i, ret = -E_WRITE_SYNTAX;
- static struct timeval tv;
- struct writer_node_group *wng = NULL;
+ 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.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;
- tv.tv_sec = sec;
- tv.tv_usec = usec;
- start_time = &tv;
- }
if (!conf.writer_given) {
- wng = setup_default_wng();
- ret = 1;
- goto out;
+ 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);
}
- wng = wng_new(conf.writer_given);
- for (i = 0; i < conf.writer_given; i++) {
- ret = check_writer_arg(conf.writer_arg[i]);
- if (ret < 0)
- goto out;
- wng->writer_nodes[i].writer = &writers[ret];
+
+ 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;
+ }
+ }
}
- ret = 1;
-out:
- if (ret > 0)
- return wng;
- free(wng);
- return NULL;
+ 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;
}
/**
- * test if audio buffer contains a valid wave header
+ * 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 If not, return 0, otherwise, store number of channels and sample rate
- * in struct conf and return WAV_HEADER_LEN.
+ * \return \p EXIT_SUCCESS or EXIT_FAILURE
*/
-static size_t check_wave(void)
-{
- unsigned char *a = (unsigned char*)audiobuf;
- if (a[0] != 'R' || a[1] != 'I' || a[2] != 'F' || a[3] != 'F')
- return WAV_HEADER_LEN;
- conf.channels_arg = (unsigned) a[22];
- conf.sample_rate_arg = a[24] + (a[25] << 8) + (a[26] << 16) + (a[27] << 24);
- return 0;
-}
-
int main(int argc, char *argv[])
{
- int ret = -E_WRITE_SYNTAX;
- struct writer_node_group *wng = NULL;
+ int ret;
- cmdline_parser(argc, argv, &conf);
- wng = check_args();
- if (!wng)
- goto out;
- init_supported_writers();
- audiobuf = para_malloc(WAV_HEADER_LEN);
- ret = read_wav_header();
- if (ret < 0)
- goto out;
- ret = pcm_write(wng, check_wave());
-out:
- wng_destroy(wng);
- free(audiobuf);
- if (ret < 0)
- PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
- return ret;
+ 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();
+
+ ret = setup_and_schedule();
+ if (ret < 0) {
+ PARA_ERROR_LOG("%s\n", para_strerror(-ret));
+ exit(EXIT_FAILURE);
+ }
+ exit(EXIT_SUCCESS);
}