X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=write.h;h=8a60294dccbaef295987041acad36d69fa9f00f0;hp=2eb4e3db8315ba1baedabbbfcefff369a6f3f058;hb=4990334538fe7f18964a6027b22d47c7640c3ec0;hpb=51dde9efab2d662cf5813d26d5c9aebce6e197e7 diff --git a/write.h b/write.h index 2eb4e3db..8a60294d 100644 --- a/write.h +++ b/write.h @@ -1,132 +1,102 @@ /* - * Copyright (C) 2006-2007 Andre Noll + * Copyright (C) 2006-2011 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 */ - 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 */ - size_t written; + /** The buffer tree node associated with this writer node. */ + struct btr_node *btrn; + /** The task of this writer node. */ + struct task task; + /** The minimal input queue size (size of one audio sample). */ + size_t min_iqs; }; -/** 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. - * + * It should check whether the command line options given by \a options + * are valid and return a pointer to the writer-specific configuration + * data determined by \a options. This function must either succeed or + * call exit(). Note that parse_config_or_die() might be called more + * than once with different values of \a options. \sa \ref + * free_config(). */ - void * (*parse_config)(const char *options); + void *(*parse_config_or_die)(const char *options); /** + * Dellocate all configuration resources. * - * 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 - * a pointer to that structure via the given writer_node parameter. + * This should free whatever was allocated by \ref parse_config_or_die(). */ - int (*open)(struct writer_node *); + void (*free_config)(void *config); /** + * Prepare the fd sets for select. * - * write a chunk of audio data - * - * 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 - * the select timeout. It must return positive on success and negative - * on errors. + * This is called from scheduler. It may use the sched pointer to add + * any file descriptors or to decrease the select timeout. */ - int (*pre_select)(struct sched *s, struct writer_node *wn); + void (*pre_select)(struct sched *s, struct task *t); /** - * 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 - * functions). This function must return positive on success and - * negative on errors. + * Write audio data. + * + * Called from the post_select function of the writer node's task. */ - int (*post_select)(struct sched *s, struct writer_node *wn); + void (*post_select)(struct sched *s, struct task *t); /** - * 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 *); + /** The short and the log help text of this writer. */ + struct ggo_help help; + /** + * The callback handler. + * + * Each writer may provide an ->execute callback which can be used for + * inter-node communication. + */ + btr_command_handler execute; }; -/** - * describes a set of writer nodes that all write the same stream. - */ -struct writer_node_group { - /** number of nodes belonging to this group */ - unsigned num_writers; - /** 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 end of file was encountered by the feeding task */ - int *input_eof; - /** non-zero if end of file was encountered */ - int eof; - /** current output buffer */ - char *buf; - /** number of bytes loaded in the output buffer */ - size_t *loaded; - /** number of audio channels of the current stream */ - unsigned int *channels; - /** sample rate of the current stream */ - unsigned int *samplerate; - /** the task associated to this group */ - struct task task; -}; - -/** 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];