new codename, reset version to git
[paraslash.git] / write.h
diff --git a/write.h b/write.h
index 3ef691a..5f8ab3a 100644 (file)
--- a/write.h
+++ b/write.h
  *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  */
 
+/** \file write.h writer-related structures */
+
+/** the list of supported writers */
 enum writer_enum {WRITER_ENUM};
 
+/**
+ * decbribes one running instance of a writer
+ */
 struct writer_node {
+/** points to the writer structure associated with this node */
        struct writer *writer;
+/** writer-specific data */
        void *private_data;
+/** send that many bytes in one go */
        int chunk_bytes;
 };
 
+/** describes one supported writer */
 struct writer {
-       void (*init)(struct writer *w);
-       int (*open)(struct writer_node *);
-       int (*write)(char *data, size_t nbytes, struct writer_node *);
-       void (*close)(struct writer_node *);
-       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);
+/**
+ *
+ * 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 *);
+/**
+ * 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 *);
 };
 
+/**
+ * describes a set of writer nodes that all write the same stream.
+ */
 struct writer_node_group {
-       unsigned num_writers;
-       struct writer_node *writer_nodes;
-       int *written;
-       size_t max_chunk_bytes;
-       int eof;
+/** number of nodes belonging to this 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 eof;
 };
 
+/** 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;
+
+/** array containing the name of each writer */
 extern const char *writer_names[];
+
+/** the writer structure for each supported writer */
 extern struct writer writers[NUM_SUPPORTED_WRITERS];