X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=write.h;h=1a3f193ddcd89369f6456a715dd56bde7650a42b;hp=1c4a65fceefe4651af47f7e1df2aa14f55484c9a;hb=80e46ec589d14be2fa4b0704f613a04ecb1b64c4;hpb=9337bed6e84a4068e750fb6597646b45778eeba7

diff --git a/write.h b/write.h
index 1c4a65fc..1a3f193d 100644
--- a/write.h
+++ b/write.h
@@ -1,19 +1,7 @@
 /*
- * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2008 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 */
@@ -22,7 +10,7 @@
 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 */
@@ -31,9 +19,12 @@ struct writer_node {
 	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;
 };
 
 /** describes one supported writer */
@@ -57,27 +48,33 @@ struct writer {
 	 * more than once with different values of \a options.
 	 *
 	 */
-		void * (*parse_config)(char *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. If To this aim, it may allocate its private data structure and store
-	 * a pointer to that structure via the given writer_node paramenter.
+	 * 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 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.
-	 *
+	 * 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 (*write)(char *data, size_t nbytes, struct writer_node *);
 	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
@@ -102,17 +99,21 @@ struct writer_node_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 *input_eof;
-	int eof;
+	/** Non-zero if an error or end of file was encountered by the feeding task. */
+	int *input_error;
+	/** Non-zero if an error occurred or end of file was encountered. */
+	int 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;
-	size_t *loaded;
+	/** the task associated to this group */
 	struct task task;
 };