/*
- * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2009 Andre Noll <maan@systemlinux.org>
*
- * 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;
- struct task task;
+ /** 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;
};
-/** 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);
-/**
- *
- *
- * 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)(char *options);
-/**
- *
- * 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 *);
+ /**
+ * 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.
+ */
+ int (*pre_select)(struct sched *s, struct writer_node *wn);
+ /**
+ * 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.
+ */
+ int (*post_select)(struct sched *s, struct writer_node *wn);
+ /**
+ * 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 *);
+ struct ggo_help help;
};
/**
- * describes a set of writer nodes that all write the same stream.
+ * Describes a set of writer nodes that all write the same stream.
*/
struct writer_node_group {
- /** number of nodes belonging to this group */
+ /** Number of nodes belonging to this group. */
unsigned num_writers;
- /** array of pointers to the corresponding writer nodes */
+ /** 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 *input_eof;
- int eof;
- char *buf;
+ /** Non-zero if an error or end of file was encountered by the feeding task. */
+ int *input_error;
+ /** Current output buffer. */
+ char **bufp;
+ /** 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;
+ /** Max number of bytes written in the previous post_select() call. */
+ int last_written;
};
-/** loop over each writer node in a writer group */
+/** 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];
projects / paraslash.git / blobdiff