X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=write.h;h=8a60294dccbaef295987041acad36d69fa9f00f0;hp=e6e0a762f7e56819b37cd5bbbeb0b65347cbcea6;hb=4990334538fe7f18964a6027b22d47c7640c3ec0;hpb=0610638110061ff05670a6c497b371bf2e1d4d0f diff --git a/write.h b/write.h index e6e0a762..8a60294d 100644 --- a/write.h +++ b/write.h @@ -1,115 +1,102 @@ /* - * Copyright (C) 2006 Andre Noll + * Copyright (C) 2006-2011 Andre Noll * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA. + * 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}; /** - * decbribes one running instance of a writer + * Describes one running instance of a writer. */ struct writer_node { -/** points to the writer structure associated with this node */ - struct writer *writer; -/** 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; + /** The writer-specific configuration of this node. */ + void *conf; + /** The buffer tree node associated with this writer node. */ + struct btr_node *btrn; + /** The task of this writer node. */ struct task task; - struct writer_node_group *wng; + /** 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 - * - * It must fill in all other function pointers of the given - * writer structure. - * - */ -void (*init)(struct writer *w); -/** - * - * 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 paramenter. - */ -int (*open)(struct writer_node *); -/** - * - * write a chunk of audio data - * - * This is called from the driving application whenever a data block of \a - * chunk_bytes is available. It must return the number of bytes consumed from - * \a data on success, and negative on errors. - * - */ -int (*write)(char *data, size_t nbytes, struct writer_node *); -void (*pre_select)(struct sched *s, struct task *t); -void (*post_select)(struct sched *s, struct task *t); -/** - * close one instance of the writer - * - * This function is assumed to succeed. - */ -void (*close)(struct writer_node *); -/** - * shutdown the writer - * - * This is a optional function pointer used for cleaning - * up. - */ -void (*shutdown)(struct writer_node *); -}; - -/** - * 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; -/** keeps track of how many bytes have been written by each node */ -int *written; -/** 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 */ -int *eof; -char *buf; -size_t *loaded; -struct task task; + /** + * 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. + * + * 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_or_die)(const char *options); + /** + * Dellocate all configuration resources. + * + * This should free whatever was allocated by \ref parse_config_or_die(). + */ + void (*free_config)(void *config); + /** + * Prepare the fd sets for select. + * + * This is called from scheduler. It may use the sched pointer to add + * any file descriptors or to decrease the select timeout. + */ + void (*pre_select)(struct sched *s, struct task *t); + /** + * Write audio data. + * + * Called from the post_select function of the writer node's task. + */ + void (*post_select)(struct sched *s, struct task *t); + /** + * Close one instance of the writer. + * + * This function is assumed to succeed. + */ + void (*close)(struct writer_node *); + /** + * Shutdown the writer. + * + * 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; }; -/** 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];