2 * Copyright (C) 2006-2011 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file write_common.c common functions of para_audiod and para_write */
17 #include "buffer_tree.h"
21 /** the array containing the names of all supported writers */
22 const char *writer_names[] ={WRITER_NAMES};
24 /** the array of supported writers */
25 struct writer writers[NUM_SUPPORTED_WRITERS] = {WRITER_ARRAY};
28 * Call the init function of each supported paraslash writer.
30 void writer_init(void)
35 writers[i].init(&writers[i]);
38 * Check if given string is a valid command line for any writer.
40 * \param \wa String of the form writer_name:options.
41 * \param writer_num Contains the number of the writer upon success.
43 * This function checks whether \a wa starts with the name of a supported
44 * paraslash writer, optionally followed by a colon and any options for that
45 * writer. If a valid writer name was found and further are present, the
46 * remaining part of \a wa is passed to that writer's config parser.
48 * \return On success, a pointer to the gengetopt args info struct is returned
49 * and \a writer_num contains the number of the writer. Otherwise this function
50 * prints an error message and calls exit().
52 void *check_writer_arg_or_die(const char *wa, int *writer_num)
56 PARA_INFO_LOG("checking %s\n", wa);
58 const char *name = writer_names[i];
59 size_t len = strlen(name);
63 if (strncmp(name, wa, len))
69 return writers[i].parse_config_or_die(c? wa + len + 1 : "");
71 PARA_EMERG_LOG("invalid writer %s\n", wa);
76 * Open a writer node and register the corresponding task.
78 * \param wn The writer node to open.
79 * \param parent The parent btr node (the source for the writer node).
80 * \param s The scheduler instance to register the task to.
82 * The configuration of the writer node stored in \p wn->conf must be
83 * initialized before this function may be called.
85 void register_writer_node(struct writer_node *wn, struct btr_node *parent,
88 struct writer *w = writers + wn->writer_num;
89 char *name = make_message("%s writer", writer_names[wn->writer_num]);
91 wn->btrn = btr_new_node(&(struct btr_node_description)
92 EMBRACE(.name = name, .parent = parent,
93 .handler = w->execute, .context = wn));
94 strcpy(wn->task.status, name);
96 wn->task.post_select = w->post_select;
97 wn->task.pre_select = w->pre_select;
98 register_task(s, &wn->task);
102 * Print the help text of all writers to stdout.
104 * \param detailed Whether to print the detailed help text.
106 void print_writer_helps(int detailed)
110 printf_or_die("\nAvailable writers: \n\t");
112 printf_or_die("%s%s", i? " " : "", writer_names[i]);
113 printf_or_die("\n\n");
115 struct writer *w = writers + i;
117 if (!w->help.short_help)
119 printf_or_die("Options for %s:\n", writer_names[i]);
120 ggo_print_help(&w->help, detailed);
124 static void get_btr_value(struct btr_node *btrn, const char *cmd,
128 int ret = btr_exec_up(btrn, cmd, &buf);
132 * This really should not happen. It means one of our parent
133 * nodes died unexpectedly. Proceed with fingers crossed.
135 PARA_CRIT_LOG("cmd %s: %s\n", cmd, para_strerror(-ret));
139 ret = para_atoi32(buf, result);
145 * Ask parent btr nodes for the sample rate of the current stream.
147 * \param btrn Where to start the search.
148 * \param result Filled in by this function.
150 * This function is assumed to succeed and terminates on errors.
152 void get_btr_sample_rate(struct btr_node *btrn, int32_t *result)
154 get_btr_value(btrn, "sample_rate", result);
158 * Ask parent btr nodes for the channel count of the current stream.
160 * \param btrn See \ref get_btr_sample_rate.
161 * \param result See \ref get_btr_sample_rate.
163 void get_btr_channels(struct btr_node *btrn, int32_t *result)
165 get_btr_value(btrn, "channels", result);
169 * Ask parent btr nodes for the number of bits per sample and the byte sex.
171 * \param btrn See \ref get_btr_sample_rate.
172 * \param result Contains the sample format as an enum sample_format type.
174 void get_btr_sample_format(struct btr_node *btrn, int32_t *result)
176 get_btr_value(btrn, "sample_format", result);