X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=write.h;h=fd3983ddf262f1edec986680c856c1d7f7c9c511;hp=71938a9ca5d7d22957b099047d96d2f7e8dee95f;hb=173091699461dc4c08cb34bdb692cf001d8b578f;hpb=4213f76d961629c7996c9d8c95171197f963e2f4 diff --git a/write.h b/write.h index 71938a9c..fd3983dd 100644 --- a/write.h +++ b/write.h @@ -1,75 +1,44 @@ /* - * Copyright (C) 2006-2009 Andre Noll + * Copyright (C) 2006 Andre Noll * * Licensed under the GPL v2. For licencing details see COPYING. */ /** \file write.h Writer-related structures. */ -/** 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. */ + /** The ID of this writer. */ + int wid; /** Writer-specific data. */ void *private_data; - /** Pointer to the group this node belongs to. */ - struct writer_node_group *wng; - /** The writer-specific configuration of this node. */ - void *conf; - /** How much of the wng's buffer is already written. */ - size_t written; + /** The parsed command line, merged with options given in the config file. */ + struct lls_parse_result *lpr; + /** 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. */ 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); - /** - * 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); - /** - * Open one instance of this writer. - * - * This function should perform any work necessary to write the incoming - * 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 *); /** * 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 - * 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, void *context); /** * 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 \p wn->written variable (which may be modified by the wng handling - * functions). This function must return positive on success and - * negative on errors. + * Called from the post_select function of the writer node's task. */ - int (*post_select)(struct sched *s, struct writer_node *wn); + int (*post_select)(struct sched *s, void *context); /** * Close one instance of the writer. * @@ -77,48 +46,31 @@ struct writer { */ void (*close)(struct writer_node *); /** - * Shutdown the writer + * The callback handler. * - * This is a optional function pointer used for cleaning up. + * Each writer may provide an ->execute callback which can be used for + * inter-node communication. */ - void (*shutdown)(struct writer_node *); - struct ggo_help help; + 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; - /** Non-zero if an error or end of file was encountered by the feeding task. */ - int *input_error; - /** 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; - /** Whether the group is open, i.e. wng_open() was called. */ - int open; -}; - -/** 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. */ -#define FOR_EACH_WRITER(i) for (i = 0; i < NUM_SUPPORTED_WRITERS; i++) - -/** Declare the init functions of all supported writers. */ -DECLARE_WRITER_INITS; +#define WRITE_CMD(_num) (lls_cmd(_num, write_cmd_suite)) -/** Array containing the name of each writer. */ -extern const char *writer_names[]; +#define WRITE_CMD_OPT_RESULT(_cmd, _opt, _lpr) \ + (lls_opt_result(LSG_WRITE_CMD_ ## _cmd ## _OPT_ ## _opt, _lpr)) +#define WRITE_CMD_OPT_GIVEN(_cmd, _opt, _lpr) \ + (lls_opt_given(WRITE_CMD_OPT_RESULT(_cmd, _opt, _lpr))) +#define WRITE_CMD_OPT_UINT32_VAL(_cmd, _opt, _lpr) \ + (lls_uint32_val(0, WRITE_CMD_OPT_RESULT(_cmd, _opt, (_lpr)))) +#define WRITE_CMD_OPT_STRING_VAL(_cmd, _opt, _lpr) \ + (lls_string_val(0, WRITE_CMD_OPT_RESULT(_cmd, _opt, (_lpr)))) -/** The writer structure for each supported writer. */ -extern struct writer writers[NUM_SUPPORTED_WRITERS]; +int check_writer_arg_or_die(const char *wa, struct lls_parse_result **lprp); +const struct writer *writer_get(int wid); +const char *writer_name(int wid); +void register_writer_node(struct writer_node *wn, struct btr_node *parent, + struct sched *s); +void get_btr_sample_rate(struct btr_node *btrn, int32_t *result); +void get_btr_channels(struct btr_node *btrn, int32_t *result); +void get_btr_sample_format(struct btr_node *btrn, int32_t *result); +void print_writer_helps(bool detailed);