X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=write.h;h=cb0beff812121b338e3749e80f63ad2cb99999db;hp=c7196dc5644614e66525b1bfa524ec346579d64d;hb=e7f035b3ad7ecc64ec87d9ce890f89365dec1411;hpb=ffb2eaa90429f6d5c3d369509efcdf91c5463dad diff --git a/write.h b/write.h index c7196dc5..cb0beff8 100644 --- a/write.h +++ b/write.h @@ -1,69 +1,40 @@ -/* - * Copyright (C) 2006-2010 Andre Noll - * - * Licensed under the GPL v2. For licencing details see COPYING. - */ +/* Copyright (C) 2006 Andre Noll , see file 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 { - /** The number of this writer. */ - int writer_num; + /** The ID of this writer. */ + int wid; /** Writer-specific data. */ void *private_data; - /** The writer-specific configuration of this node. */ - void *conf; + /** 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; - struct task task; + /** 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); - void (*free_config)(void *conf); - /** - * 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 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); + void (*pre_select)(struct sched *s, void *context); /** * Write audio data. * * Called from the post_select function of the writer node's task. */ - void (*post_select)(struct sched *s, struct task *t); + int (*post_select)(struct sched *s, void *context); /** * Close one instance of the writer. * @@ -71,23 +42,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; }; -/** 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);