2 * Copyright (C) 2006-2009 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file write.h Writer-related structures. */
9 /** The list of supported writers. */
10 enum writer_enum {WRITER_ENUM};
13 * Describes one running instance of a writer.
16 /** Points to the writer structure associated with this node. */
17 struct writer *writer; /* FIXME: Should better be only the number. */
18 /** Writer-specific data. */
20 /** Send that many bytes in one go. */
22 /** Pointer to the group this node belongs to. */
23 struct writer_node_group *wng;
24 /** The writer-specific configuration of this node. */
26 /** How much of the wng's buffer is already written. */
30 /** Describes one supported writer. */
33 * The init function of the writer.
35 * It must fill in all other function pointers of the given
38 void (*init)(struct writer *w);
40 * The command line parser of the writer.
42 * It should check whether the command line options given by \a options are
43 * valid. On success, it should return a pointer to the writer-specific
44 * configuration data determined by \a options. Note that this might be called
45 * more than once with different values of \a options.
47 void *(*parse_config)(const char *options);
49 * Open one instance of this writer.
51 * This function should perform any work necessary to write the incoming
52 * stream. If To this aim, it may allocate its private data structure and store
53 * a pointer to that structure via the given writer_node parameter.
55 int (*open)(struct writer_node *);
57 * Prepare the fd sets for select.
59 * This is called from the writer node group task's pre_select(). It
60 * may use the sched pointer to add any file descriptors or to decrease
61 * the select timeout. It must return positive on success and negative
64 int (*pre_select)(struct sched *s, struct writer_node *wn);
68 * Called from the post_select function of the wng task. It must keep
69 * track of the number of bytes consumed from the wng's buffer via
70 * the \p wn->written variable (which may be modified by the wng handling
71 * functions). This function must return positive on success and
74 int (*post_select)(struct sched *s, struct writer_node *wn);
76 * Close one instance of the writer.
78 * This function is assumed to succeed.
80 void (*close)(struct writer_node *);
84 * This is a optional function pointer used for cleaning up.
86 void (*shutdown)(struct writer_node *);
91 * Describes a set of writer nodes that all write the same stream.
93 struct writer_node_group {
94 /** Number of nodes belonging to this group. */
96 /** Array of pointers to the corresponding writer nodes. */
97 struct writer_node *writer_nodes;
98 /** The maximum of the chunk_bytes values of the writer nodes in this group. */
100 /** Non-zero if an error or end of file was encountered by the feeding task. */
102 /** Current output buffer. */
104 /** Number of bytes loaded in the output buffer. */
106 /** Number of audio channels of the current stream. */
107 unsigned int *channels;
108 /** Sample rate of the current stream. */
109 unsigned int *samplerate;
110 /** The task associated to this group. */
112 /** Whether the group is open, i.e. wng_open() was called. */
116 /** Loop over each writer node in a writer group. */
117 #define FOR_EACH_WRITER_NODE(i, wng) for (i = 0; i < (wng)->num_writers; i++)
118 /** Loop over each supported writer. */
119 #define FOR_EACH_WRITER(i) for (i = 0; i < NUM_SUPPORTED_WRITERS; i++)
121 /** Declare the init functions of all supported writers. */
122 DECLARE_WRITER_INITS;
124 /** Array containing the name of each writer. */
125 extern const char *writer_names[];
127 /** The writer structure for each supported writer. */
128 extern struct writer writers[NUM_SUPPORTED_WRITERS];