blob_get_name_by_id(): Treat id of dummy row as invalid.
[paraslash.git] / write.h
diff --git a/write.h b/write.h
index 936d99c..c7c227e 100644 (file)
--- a/write.h
+++ b/write.h
@@ -1,5 +1,5 @@
 /*
 /*
- * Copyright (C) 2006-2009 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006 Andre Noll <maan@tuebingen.mpg.de>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -19,8 +19,11 @@ struct writer_node {
        void *private_data;
        /** The writer-specific configuration of this node. */
        void *conf;
        void *private_data;
        /** The writer-specific configuration of this node. */
        void *conf;
+       /** The buffer tree node associated with this writer node. */
        struct btr_node *btrn;
        struct btr_node *btrn;
-       struct task task;
+       /** The task of this writer node. */
+       struct task *task;
+       /** The minimal input queue size (size of one audio sample). */
        size_t min_iqs;
 };
 
        size_t min_iqs;
 };
 
@@ -36,47 +39,47 @@ struct writer {
        /**
         * The command line parser of the writer.
         *
        /**
         * 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.
+        * It should check whether the command line options given by \a argv
+        * and \a argc are valid and return a pointer to the writer-specific
+        * configuration data determined by these options. This function must
+        * either succeed or call exit(). Note that parse_config_or_die() might
+        * be called more than once with different values of \a options. \sa
+        * \ref free_config().
         */
         */
-       void *(*parse_config)(const char *options);
-       void (*free_config)(void *conf);
+       void *(*parse_config_or_die)(int argc, char **argv);
        /**
        /**
-        * Open one instance of this writer.
+        * Deallocate all configuration resources.
         *
         *
-        * This function should perform any work necessary to write the incoming
-        * stream. To this aim, it may allocate its private data structure and store
-        * a pointer to that structure via the given writer_node parameter.
+        * This should free whatever was allocated by \ref parse_config_or_die().
         */
         */
-       int (*open)(struct writer_node *);
+       void (*free_config)(void *config);
        /**
         * Prepare the fd sets for select.
         *
         * This is called from scheduler. It may use the sched pointer to add
         * any file descriptors or to decrease the select timeout.
         */
        /**
         * Prepare the fd sets for select.
         *
         * This is called from scheduler. It may use the sched pointer to add
         * any file descriptors or to decrease the select timeout.
         */
-       void (*pre_select)(struct sched *s, struct task *t);
+       void (*pre_select)(struct sched *s, void *context);
        /**
         * Write audio data.
         *
         * Called from the post_select function of the writer node's task.
         */
        /**
         * Write audio data.
         *
         * Called from the post_select function of the writer node's task.
         */
-       void (*post_select)(struct sched *s, struct task *t);
+       int (*post_select)(struct sched *s, void *context);
        /**
         * Close one instance of the writer.
         *
         * This function is assumed to succeed.
         */
        void (*close)(struct writer_node *);
        /**
         * Close one instance of the writer.
         *
         * This function is assumed to succeed.
         */
        void (*close)(struct writer_node *);
+       /** The short and the log help text of this writer. */
+       struct ggo_help help;
        /**
        /**
-        * Shutdown the writer
+        * The callback handler.
         *
         *
-        * This is a optional function pointer used for cleaning up.
+        * Each writer may provide an ->execute callback which can be used for
+        * inter-node communication.
         */
         */
-       void (*shutdown)(struct writer_node *);
-       struct ggo_help help;
        btr_command_handler execute;
 };
 
        btr_command_handler execute;
 };