X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=write.h;h=1f316fc0ece5d029e21ef5d49d9853ae9d2c8900;hp=1a3f193ddcd89369f6456a715dd56bde7650a42b;hb=57e0c93e87138fdf1c8793c3d1f3d2880d717548;hpb=c8862b9e246b4ef6ff1fe103946e18cf2537ecde diff --git a/write.h b/write.h index 1a3f193d..1f316fc0 100644 --- a/write.h +++ b/write.h @@ -1,66 +1,58 @@ /* - * Copyright (C) 2006-2008 Andre Noll + * Copyright (C) 2006-2009 Andre Noll * * Licensed under the GPL v2. For licencing details see COPYING. */ -/** \file write.h writer-related structures */ +/** \file write.h Writer-related structures. */ -/** the list of supported writers */ +/** The list of supported writers. */ enum writer_enum {WRITER_ENUM}; /** * Describes one running instance of a writer. */ struct writer_node { - /** points to the writer structure associated with this node */ - struct writer *writer; /* FIXME: Should better be only the number */ - /** writer-specific data */ + /** The number of this writer. */ + int writer_num; + /** Writer-specific data. */ void *private_data; - /** send that many bytes in one go */ - int chunk_bytes; - /** pointer to the group this node belongs to */ + /** Pointer to the group this node belongs to. */ struct writer_node_group *wng; - /** the writer-specific configuration of this node */ + /** The writer-specific configuration of this node. */ void *conf; - /** how much of the wng's buffer is already written */ + /** How much of the wng's buffer is already written. */ size_t written; }; -/** describes one supported writer */ +/** Describes one supported writer. */ struct writer { /** - * the init function of the writer + * The init function of the writer. * * It must fill in all other function pointers of the given * writer structure. - * */ void (*init)(struct writer *w); /** - * - * - * the command line parser of the writer + * The command line parser of the writer. * * It should check whether the command line options given by \a options are * valid. On success, it should return a pointer to the writer-specific * configuration data determined by \a options. Note that this might be called * more than once with different values of \a options. - * */ - void * (*parse_config)(const char *options); + void *(*parse_config)(const char *options); /** - * - * open one instance of this writer + * Open one instance of this writer. * * This function should perform any work necessary to write the incoming - * stream. If To this aim, it may allocate its private data structure and store + * stream. To this aim, it may allocate its private data structure and store * a pointer to that structure via the given writer_node parameter. */ int (*open)(struct writer_node *); /** - * - * write a chunk of audio data + * Prepare the fd sets for select. * * This is called from the writer node group task's pre_select(). It * may use the sched pointer to add any file descriptors or to decrease @@ -69,64 +61,64 @@ struct writer { */ int (*pre_select)(struct sched *s, struct writer_node *wn); /** + * Write audio data. + * * Called from the post_select function of the wng task. It must keep * track of the number of bytes consumed from the wng's buffer via - * the wn->written variable (which may be modified by the wng handling + * the \p wn->written variable (which may be modified by the wng handling * functions). This function must return positive on success and * negative on errors. */ int (*post_select)(struct sched *s, struct writer_node *wn); /** - * close one instance of the writer + * Close one instance of the writer. * * This function is assumed to succeed. */ void (*close)(struct writer_node *); /** - * shutdown the writer + * Shutdown the writer * - * This is a optional function pointer used for cleaning - * up. + * This is a optional function pointer used for cleaning up. */ void (*shutdown)(struct writer_node *); + struct ggo_help help; }; /** - * describes a set of writer nodes that all write the same stream. + * Describes a set of writer nodes that all write the same stream. */ struct writer_node_group { - /** number of nodes belonging to this group */ + /** Number of nodes belonging to this group. */ unsigned num_writers; - /** array of pointers to the corresponding writer nodes */ + /** Array of pointers to the corresponding writer nodes. */ struct writer_node *writer_nodes; - /** the maximum of the chunk_bytes values of the writer nodes in this group */ - size_t max_chunk_bytes; /** Non-zero if an error or end of file was encountered by the feeding task. */ int *input_error; - /** Non-zero if an error occurred or end of file was encountered. */ - int error; - /** current output buffer */ - char *buf; - /** number of bytes loaded in the output buffer */ + /** Current output buffer. */ + char **bufp; + /** Number of bytes loaded in the output buffer. */ size_t *loaded; - /** number of audio channels of the current stream */ + /** Number of audio channels of the current stream. */ unsigned int *channels; - /** sample rate of the current stream */ + /** Sample rate of the current stream. */ unsigned int *samplerate; - /** the task associated to this group */ + /** The task associated to this group. */ struct task task; + /** Whether the group is open, i.e. wng_open() was called. */ + int open; }; -/** loop over each writer node in a writer group */ +/** Loop over each writer node in a writer group. */ #define FOR_EACH_WRITER_NODE(i, wng) for (i = 0; i < (wng)->num_writers; i++) -/** loop over each supported writer */ +/** Loop over each supported writer. */ #define FOR_EACH_WRITER(i) for (i = 0; i < NUM_SUPPORTED_WRITERS; i++) -/** declare the init functions of all supported writers */ +/** Declare the init functions of all supported writers. */ DECLARE_WRITER_INITS; -/** array containing the name of each writer */ +/** Array containing the name of each writer. */ extern const char *writer_names[]; -/** the writer structure for each supported writer */ +/** The writer structure for each supported writer. */ extern struct writer writers[NUM_SUPPORTED_WRITERS];