para_play -> para_write documentation update
[paraslash.git] / write.h
1 /*
2 * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
3 *
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.
8 *
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.
13 *
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.
17 */
18
19 enum writer_enum {WRITER_ENUM};
20
21 struct writer_node {
22 struct writer *writer;
23 void *private_data;
24 int chunk_bytes;
25 };
26
27 struct writer {
28 void (*init)(struct writer *w);
29 int (*open)(struct writer_node *);
30 int (*write)(char *data, size_t nbytes, struct writer_node *);
31 void (*close)(struct writer_node *);
32 void (*shutdown)(struct writer_node *);
33 };
34
35 struct writer_node_group {
36 unsigned num_writers;
37 struct writer_node *writer_nodes;
38 int *written;
39 size_t max_chunk_bytes;
40 int eof;
41 };
42
43 #define FOR_EACH_WRITER_NODE(i, wng) for (i = 0; i < (wng)->num_writers; i++)
44 #define FOR_EACH_WRITER(i) for (i = 0; i < NUM_SUPPORTED_WRITERS; i++)
45
46 DECLARE_WRITER_INITS;
47 const char *writer_names[NUM_SUPPORTED_WRITERS];
48 struct writer writers[NUM_SUPPORTED_WRITERS];