-/*
- * Copyright (C) 2006-2008 Andre Noll <maan@systemlinux.org>
- *
- * Licensed under the GPL v2. For licencing details see COPYING.
- */
-
-/** \file write.h writer-related structures */
+/* Copyright (C) 2006 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
-/** the list of supported writers */
-enum writer_enum {WRITER_ENUM};
+/** \file write.h Writer-related structures. */
/**
* 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 ID of this writer. */
+ int wid;
+ /** 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 */
- 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 */
+/** 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.
+ * 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 (*init)(struct writer *w);
+ void (*pre_select)(struct sched *s, void *context);
/**
+ * Write audio data.
*
- *
- * 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.
- *
+ * Called from the post_select function of the writer node's task.
*/
- void * (*parse_config)(const char *options);
+ int (*post_select)(struct sched *s, void *context);
/**
- *
- * 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.
- */
- int (*open)(struct writer_node *);
- /**
- *
- * 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.
- */
- int (*pre_select)(struct sched *s, struct writer_node *wn);
- /**
- * 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.
- */
- 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
+ * 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 *);
+ 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 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);