2 * Copyright (C) 2006-2009 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 /** the array containing the names of all supported writers */
18 const char *writer_names[] ={WRITER_NAMES};
20 /** the array of supported writers */
21 struct writer writers[NUM_SUPPORTED_WRITERS] = {WRITER_ARRAY};
23 static void wng_pre_select(__a_unused struct sched *s, struct task *t)
25 struct writer_node_group *g = container_of(t, struct writer_node_group, task);
28 FOR_EACH_WRITER_NODE(i, g) {
29 struct writer_node *wn = &g->writer_nodes[i];
30 t->error = wn->writer->pre_select(s, wn);
36 static void wng_post_select(struct sched *s, struct task *t)
38 struct writer_node_group *g = container_of(t, struct writer_node_group, task);
40 size_t min_written = 0;
42 FOR_EACH_WRITER_NODE(i, g) {
43 struct writer_node *wn = &g->writer_nodes[i];
44 t->error = wn->writer->post_select(s, wn);
48 min_written = wn->written;
50 min_written = PARA_MIN(min_written, wn->written);
52 //PARA_INFO_LOG("loaded: %zd, min_written: %zd bytes\n", *g->loaded, min_written);
54 *g->loaded -= min_written;
55 FOR_EACH_WRITER_NODE(i, g)
56 g->writer_nodes[i].written -= min_written;
58 if (!*g->loaded && *g->input_error) {
59 t->error = *g->input_error;
62 if (*g->loaded && min_written) {
63 // PARA_INFO_LOG("moving %zd bytes\n", *g->loaded);
64 memmove(g->buf, g->buf + min_written, *g->loaded);
69 * call the open function of each writer in the group
71 * \param g the writer node group
73 * \return If at least one open function returned an error, all successful
74 * writer notes get closed and this error value is returned. Upon success, a
75 * task associated with \a g is registered to the scheduler and the function
76 * returns a positive value.
78 int wng_open(struct writer_node_group *g)
82 PARA_NOTICE_LOG("opening wng %p with %d writer(s)\n", g, g->num_writers);
83 FOR_EACH_WRITER_NODE(i, g) {
84 struct writer_node *wn = &g->writer_nodes[i];
86 ret = wn->writer->open(wn);
90 sprintf(g->task.status, "%s", "writer node group");
91 register_task(&g->task);
95 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
97 struct writer_node *wn = &g->writer_nodes[--i];
98 wn->writer->close(wn);
105 * call the close function of each writer in the given group
107 * \param g the writer node group to close
109 * This function also frees all resources of the given group.
111 void wng_close(struct writer_node_group *g)
117 PARA_NOTICE_LOG("closing wng with %d writer(s)\n", g->num_writers);
118 FOR_EACH_WRITER_NODE(i, g) {
119 struct writer_node *wn = &g->writer_nodes[i];
120 wn->writer->close(wn);
122 free(g->writer_nodes);
127 * allocate and initialize a new writer_node_group struct
129 * \param num_writers the number of writer nodes for the new group
131 * \return Pointer to the new writer node group
133 struct writer_node_group *wng_new(unsigned num_writers)
135 struct writer_node_group *g = para_calloc(sizeof(struct writer_node_group));
136 g->num_writers = num_writers;
137 g->writer_nodes = para_calloc(num_writers
138 * sizeof(struct writer_node));
139 g->task.post_select = wng_post_select;
140 g->task.pre_select = wng_pre_select;
145 * Call the init function of each supported paraslash writer.
147 void writer_init(void)
152 writers[i].init(&writers[i]);
155 * check if given string is a valid command line for any writer
157 * \param \wa string of the form writer_name:options
158 * \param writer_num contains the number of the writer upon success
160 * This function checks whether \a wa starts with the name of a supported
161 * paraslash writer, optionally followed by a colon and any options for that
162 * writer. If a valid writer name was found and further are present, the
163 * remaining part of \a wa is passed to that writer's config parser.
165 * \return On success, a pointer to the gengetopt args info struct is returned
166 * and \a writer_num contains the number of the writer. Otherwise this function
169 void *check_writer_arg(const char *wa, int *writer_num)
173 *writer_num = -E_WRITE_COMMON_SYNTAX;
174 PARA_INFO_LOG("checking %s\n", wa);
176 const char *name = writer_names[i];
177 size_t len = strlen(name);
179 if (strlen(wa) < len)
181 if (strncmp(name, wa, len))
186 if (c && !writers[i].parse_config)
189 return writers[i].parse_config(c? wa + len + 1 : "");
191 PARA_ERROR_LOG("writer not found\n");
196 * setup a writer node group with only one writer, the default writer
198 * The writer which is set up depends on the OS. It defaults to alsa for Linux,
199 * osx_write for OS X, file writer if neither of these is supported.
201 * \return pointer to the allocated writer node group
203 struct writer_node_group *setup_default_wng(void)
205 struct writer_node_group *wng = wng_new(1);
206 wng->writer_nodes[0].writer = &writers[DEFAULT_WRITER];
207 PARA_INFO_LOG("using default writer: %s %p\n",
208 writer_names[DEFAULT_WRITER], writers[DEFAULT_WRITER].parse_config);
209 wng->writer_nodes[0].conf = writers[DEFAULT_WRITER].parse_config("");
213 void print_writer_helps(int detailed)
217 printf_or_die("\nAvailable writers: \n\t");
219 printf_or_die("%s%s", i? " " : "", writer_names[i]);
220 printf_or_die("\n\n");
222 struct writer *w = writers + i;
224 if (!w->help.short_help)
226 printf_or_die("Options for %s:\n", writer_names[i]);
227 ggo_print_help(&w->help, detailed);