Merge branch 't/kill_udp_cq'
[paraslash.git] / write.h
1 /*
2 * Copyright (C) 2006-2010 Andre Noll <maan@systemlinux.org>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6
7 /** \file write.h Writer-related structures. */
8
9 /** The list of supported writers. */
10 enum writer_enum {WRITER_ENUM};
11
12 /**
13 * Describes one running instance of a writer.
14 */
15 struct writer_node {
16 /** The number of this writer. */
17 int writer_num;
18 /** Writer-specific data. */
19 void *private_data;
20 /** The writer-specific configuration of this node. */
21 void *conf;
22 struct btr_node *btrn;
23 struct task task;
24 size_t min_iqs;
25 };
26
27 /** Describes one supported writer. */
28 struct writer {
29 /**
30 * The init function of the writer.
31 *
32 * It must fill in all other function pointers of the given
33 * writer structure.
34 */
35 void (*init)(struct writer *w);
36 /**
37 * The command line parser of the writer.
38 *
39 * It should check whether the command line options given by \a options
40 * are valid and return a pointer to the writer-specific configuration
41 * data determined by \a options. This function must either succeed or
42 * call exit(). Note that parse_config_or_die() might be called more
43 * than once with different values of \a options. \sa \ref
44 * free_config().
45 */
46 void *(*parse_config_or_die)(const char *options);
47 /**
48 * Dellocate all configuration resources.
49 *
50 * This should free whatever was allocated by \ref parse_config_or_die().
51 */
52 void (*free_config)(void *config);
53 /**
54 * Prepare the fd sets for select.
55 *
56 * This is called from scheduler. It may use the sched pointer to add
57 * any file descriptors or to decrease the select timeout.
58 */
59 void (*pre_select)(struct sched *s, struct task *t);
60 /**
61 * Write audio data.
62 *
63 * Called from the post_select function of the writer node's task.
64 */
65 void (*post_select)(struct sched *s, struct task *t);
66 /**
67 * Close one instance of the writer.
68 *
69 * This function is assumed to succeed.
70 */
71 void (*close)(struct writer_node *);
72 /**
73 * Shutdown the writer
74 *
75 * This is a optional function pointer used for cleaning up.
76 */
77 void (*shutdown)(struct writer_node *);
78 struct ggo_help help;
79 btr_command_handler execute;
80 };
81
82 /** Loop over each supported writer. */
83 #define FOR_EACH_WRITER(i) for (i = 0; i < NUM_SUPPORTED_WRITERS; i++)
84
85 /** Declare the init functions of all supported writers. */
86 DECLARE_WRITER_INITS;
87
88 /** Array containing the name of each writer. */
89 extern const char *writer_names[];
90
91 /** The writer structure for each supported writer. */
92 extern struct writer writers[NUM_SUPPORTED_WRITERS];