Merge ../paraslash.fml/paraslash
[paraslash.git] / write.h
diff --git a/write.h b/write.h
index cc24d35..63efbfe 100644 (file)
--- a/write.h
+++ b/write.h
@@ -26,73 +26,81 @@ enum writer_enum {WRITER_ENUM};
  */
 struct writer_node {
        /** points to the writer structure associated with this node */
-       struct writer *writer;
+       struct writer *writer; /* FIXME: Should better be only the number */
        /** 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 */
        void *conf;
+       /** how much of the wng's buffer is already written */
+       size_t written;
 };
 
 /** 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)(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 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 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
+        *
+        * 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 *);
 };
 
 /**
@@ -103,17 +111,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 */
+       /** 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;
 };