Make INSTALL, README and README.mysql grutatext-friendly
[paraslash.git] / write.h
diff --git a/write.h b/write.h
index 79531b5..63efbfe 100644 (file)
--- a/write.h
+++ b/write.h
@@ -74,13 +74,19 @@ struct writer {
         *
         * 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 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
@@ -107,13 +113,19 @@ struct writer_node_group {
        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 end of file was encountered */
+       /** non-zero if end of file was encountered by the feeding task */
        int *input_eof;
+       /** non-zero if end of file was encountered */
        int eof;
+       /** 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;
 };