http_send.c: Trivial whitespace and spelling cleanups.
[paraslash.git] / write.h
diff --git a/write.h b/write.h
index aece231..be5f745 100644 (file)
--- a/write.h
+++ b/write.h
@@ -1,19 +1,7 @@
 /*
- * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2007 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 */
@@ -25,79 +13,108 @@ 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 */
+       /** points to the writer structure associated with this node */
+       struct writer *writer; /* FIXME: Should better be only the number */
+       /** writer-specific data */
        void *private_data;
-/** send that many bytes in one go */
+       /** 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);
-/**
- *
- * 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. 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 *);
 };
 
 /**
  * describes a set of writer nodes that all write the same stream.
  */
 struct writer_node_group {
-/** 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;
-char *buf;
-size_t *loaded;
-struct task task;
+       /** number of nodes belonging to this group */
+       unsigned num_writers;
+       /** array of pointers to the corresponding writer nodes */
+       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 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;
+       /** the task associated to this group */
+       struct task task;
 };
 
 /** loop over each writer node in a writer group */