2 * Copyright (C) 2006-2007 Andre Noll <maan@systemlinux.org>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
19 /** \file write_common.c common functions of para_audiod and para_write */
28 /** the array containing the names of all supported writers */
29 const char *writer_names[] ={WRITER_NAMES};
31 /** the array of supported writers */
32 struct writer writers[NUM_SUPPORTED_WRITERS] = {WRITER_ARRAY};
34 static void wng_pre_select(__a_unused struct sched *s, struct task *t)
36 struct writer_node_group *g = t->private_data;
39 FOR_EACH_WRITER_NODE(i, g) {
40 struct writer_node *wn = &g->writer_nodes[i];
41 t->ret = wn->writer->pre_select(s, wn);
49 static void wng_post_select(struct sched *s, struct task *t)
51 struct writer_node_group *g = t->private_data;
53 size_t min_written = 0;
55 FOR_EACH_WRITER_NODE(i, g) {
56 struct writer_node *wn = &g->writer_nodes[i];
57 t->ret = wn->writer->post_select(s, wn);
63 min_written = wn->written;
65 min_written = PARA_MIN(min_written, wn->written);
67 // PARA_INFO_LOG("loaded: %zd, min_written: %zd bytes\n", *g->loaded, min_written);
69 *g->loaded -= min_written;
70 FOR_EACH_WRITER_NODE(i, g)
71 g->writer_nodes[i].written -= min_written;
73 if (!*g->loaded && *g->input_eof) {
79 if (*g->loaded && min_written) {
80 // PARA_INFO_LOG("moving %zd bytes\n", *g->loaded);
81 memmove(g->buf, g->buf + min_written, *g->loaded);
86 * call the open function of each writer in the group
88 * \param g the writer node group
90 * \return If at least one open function returned an error, all successful
91 * writer notes get closed and this error value is returned. Upon success, a
92 * task associated with \a g is registered to the scheduler and the function
93 * returnes a positive value.
95 int wng_open(struct writer_node_group *g)
99 PARA_NOTICE_LOG("opening wng %p with %d writer(s)\n", g, g->num_writers);
100 register_task(&g->task);
101 FOR_EACH_WRITER_NODE(i, g) {
102 struct writer_node *wn = &g->writer_nodes[i];
104 ret = wn->writer->open(wn);
107 wn->chunk_bytes = ret;
108 g->max_chunk_bytes = PARA_MAX(g->max_chunk_bytes, ret);
110 sprintf(g->task.status, "%s", "writer node group");
114 unregister_task(&g->task);
116 struct writer_node *wn = &g->writer_nodes[--i];
117 wn->writer->close(wn);
126 * unregister a writer node group task
128 * \param g the group whose task is to be closed
130 void wng_unregister(struct writer_node_group *g)
132 unregister_task(&g->task);
137 * call the close function of each writer in the given group
139 * \param g the writer node group to close
141 * This function also frees all resources of the given group.
143 void wng_close(struct writer_node_group *g)
149 PARA_NOTICE_LOG("closing wng with %d writer(s)\n", g->num_writers);
150 FOR_EACH_WRITER_NODE(i, g) {
151 struct writer_node *wn = &g->writer_nodes[i];
152 wn->writer->close(wn);
154 free(g->writer_nodes);
159 * allocate and initialize a new writer_node_group struct
161 * \param num_writers the number of writer nodes for the new group
163 * \return Pointer to the new writer node group
165 struct writer_node_group *wng_new(unsigned num_writers)
167 struct writer_node_group *g = para_calloc(sizeof(struct writer_node_group));
168 g->num_writers = num_writers;
169 g->writer_nodes = para_calloc(num_writers
170 * sizeof(struct writer_node));
171 g->task.private_data = g;
172 g->task.post_select = wng_post_select;
173 g->task.pre_select = wng_pre_select;
178 * call the init function of each supported paraslash writer
180 void init_supported_writers(void)
185 writers[i].init(&writers[i]);
188 * check if given string is a valid command line for any writer
190 * \param \wa string of the form writer_name:options
191 * \param writer_num contains the number of the writer upon success
193 * This function checks whether \a wa starts with the name of a supported
194 * paraslash writer, optinally followed by a colon and any options for that
195 * writer. If a valid writer name was found and further are present, the
196 * remaining part of \a wa is passed to that writer's config parser.
198 * \return On success, a pointer to the gengetopt args info struct is returned
199 * and \a writer_num contains the number of the writer. Otherwise this function
202 void *check_writer_arg(const char *wa, int *writer_num)
206 *writer_num = -E_WRITE_COMMON_SYNTAX;
207 PARA_INFO_LOG("checking %s\n", wa);
209 const char *name = writer_names[i];
210 size_t len = strlen(name);
212 if (strlen(wa) < len)
214 if (strncmp(name, wa, len))
219 if (c && !writers[i].parse_config)
222 return writers[i].parse_config(c? wa + len + 1 : "");
224 PARA_ERROR_LOG("%s", "writer not found\n");
229 * setup a writer node group with only one writer, the default writer
231 * The writer which is set up depends on the OS. It defaults to alsa for Linux,
232 * osx_write for OS X, file writer if neither of these is supported.
234 * \return pointer to the allocated writer node group
236 struct writer_node_group *setup_default_wng(void)
238 struct writer_node_group *wng = wng_new(1);
239 wng->writer_nodes[0].writer = &writers[DEFAULT_WRITER];
240 PARA_INFO_LOG("using default writer: %s %p\n",
241 writer_names[DEFAULT_WRITER], writers[DEFAULT_WRITER].parse_config);
242 wng->writer_nodes[0].conf = writers[DEFAULT_WRITER].parse_config("");