doxify acl.c.

[paraslash.git] / write_common.c

diff --git a/write_common.c b/write_common.c
index b1ab00cfa97ca9c991396a76a4fc4964eb169232..1ff03761e22ec3bd8c9b3cdfaff05ac90a4a01c9 100644 (file)
--- a/write_common.c
+++ b/write_common.c
@@ -1,19 +1,7 @@
 /*
 /*

- * Copyright (C) 2006-2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2008 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_common.c common functions of para_audiod and para_write */
  */
 
 /** \file write_common.c common functions of para_audiod and para_write */


@@ -25,7 +13,10 @@
 #include "write.h"
 #include "error.h"
 
 #include "write.h"
 #include "error.h"
 

+/** the array containing the names of all supported writers */

 const char *writer_names[] ={WRITER_NAMES};
 const char *writer_names[] ={WRITER_NAMES};

+
+/** the array of supported writers */

 struct writer writers[NUM_SUPPORTED_WRITERS] = {WRITER_ARRAY};
 
 static void wng_pre_select(__a_unused struct sched *s, struct task *t)
 struct writer writers[NUM_SUPPORTED_WRITERS] = {WRITER_ARRAY};
 
 static void wng_pre_select(__a_unused struct sched *s, struct task *t)


@@ -37,7 +28,7 @@ static void wng_pre_select(__a_unused struct sched *s, struct task *t)
                struct writer_node *wn = &g->writer_nodes[i];
                t->ret = wn->writer->pre_select(s, wn);
                if (t->ret < 0) {
                struct writer_node *wn = &g->writer_nodes[i];
                t->ret = wn->writer->pre_select(s, wn);
                if (t->ret < 0) {

-                       g->eof = 1;
+                       g->error = t->ret;

                        return;
                }
        }
                        return;
                }
        }


@@ -53,7 +44,7 @@ static void wng_post_select(struct sched *s, struct task *t)
                struct writer_node *wn = &g->writer_nodes[i];
                t->ret = wn->writer->post_select(s, wn);
                if (t->ret < 0) {
                struct writer_node *wn = &g->writer_nodes[i];
                t->ret = wn->writer->post_select(s, wn);
                if (t->ret < 0) {

-                       g->eof = 1;
+                       g->error = t->ret;

                        return;
                }
                if (!i)
                        return;
                }
                if (!i)


@@ -67,9 +58,9 @@ static void wng_post_select(struct sched *s, struct task *t)
                FOR_EACH_WRITER_NODE(i, g)
                        g->writer_nodes[i].written -= min_written;
        }
                FOR_EACH_WRITER_NODE(i, g)
                        g->writer_nodes[i].written -= min_written;
        }

-       if (!*g->loaded && *g->input_eof) {
-               g->eof = 1;
-               t->ret = -E_WNG_EOF;
+       if (!*g->loaded && *g->input_error) {
+               g->error = *g->input_error;
+               t->ret = g->error;

                return;
        }
        t->ret = 1;
                return;
        }
        t->ret = 1;


@@ -79,6 +70,16 @@ static void wng_post_select(struct sched *s, struct task *t)
        }
 }
 
        }
 }
 

+/**
+ * call the open function of each writer in the group
+ *
+ * \param g the writer node group
+ *
+ * \return If at least one open function returned an error, all successful
+ * writer notes get closed and this error value is returned. Upon success, a
+ * task associated with \a g is registered to the scheduler and the function
+ * returns a positive value.
+ * */

 int wng_open(struct writer_node_group *g)
 {
        int i, ret = 1;
 int wng_open(struct writer_node_group *g)
 {
        int i, ret = 1;


@@ -95,25 +96,38 @@ int wng_open(struct writer_node_group *g)
                g->max_chunk_bytes = PARA_MAX(g->max_chunk_bytes, ret);
        }
        sprintf(g->task.status, "%s", "writer node group");
                g->max_chunk_bytes = PARA_MAX(g->max_chunk_bytes, ret);
        }
        sprintf(g->task.status, "%s", "writer node group");

-       g->eof = 0;
+       g->error = 0;

        return 1;
 err_out:
        return 1;
 err_out:

+       PARA_ERROR_LOG("%s\n", para_strerror(-ret));

        unregister_task(&g->task);
        while (i > 0) {
                struct writer_node *wn = &g->writer_nodes[--i];
                wn->writer->close(wn);
        }
        g->num_writers = 0;
        unregister_task(&g->task);
        while (i > 0) {
                struct writer_node *wn = &g->writer_nodes[--i];
                wn->writer->close(wn);
        }
        g->num_writers = 0;

-       g->eof = 1;
+       g->error = ret;

        return ret;
 }
 
        return ret;
 }
 

+
+/**
+ * unregister a writer node group task
+ *
+ * \param g the group whose task is to be closed
+ */

 void wng_unregister(struct writer_node_group *g)
 {
        unregister_task(&g->task);
 void wng_unregister(struct writer_node_group *g)
 {
        unregister_task(&g->task);

-       g->eof = 1;

 }
 
 }
 

+/**
+ * call the close function of each writer in the given group
+ *
+ * \param g the writer node group to close
+ *
+ * This function also frees all resources of the given group.
+ */

 void wng_close(struct writer_node_group *g)
 {
        int i;
 void wng_close(struct writer_node_group *g)
 {
        int i;


@@ -129,6 +143,13 @@ void wng_close(struct writer_node_group *g)
        free(g);
 }
 
        free(g);
 }
 

+/**
+ * allocate and initialize a new writer_node_group struct
+ *
+ * \param num_writers the number of writer nodes for the new group
+ *
+ * \return Pointer to the new writer node group
+ */

 struct writer_node_group *wng_new(unsigned num_writers)
 {
        struct writer_node_group *g = para_calloc(sizeof(struct writer_node_group));
 struct writer_node_group *wng_new(unsigned num_writers)
 {
        struct writer_node_group *g = para_calloc(sizeof(struct writer_node_group));


@@ -141,6 +162,9 @@ struct writer_node_group *wng_new(unsigned num_writers)
        return g;
 }
 
        return g;
 }
 

+/**
+ * call the init function of each supported paraslash writer
+ */

 void init_supported_writers(void)
 {
        int i;
 void init_supported_writers(void)
 {
        int i;


@@ -148,7 +172,21 @@ void init_supported_writers(void)
        FOR_EACH_WRITER(i)
                writers[i].init(&writers[i]);
 }
        FOR_EACH_WRITER(i)
                writers[i].init(&writers[i]);
 }

-
+/**
+ * check if given string is a valid command line for any writer
+ *
+ * \param \wa string of the form writer_name:options
+ * \param writer_num contains the number of the writer upon success
+ *
+ * This function checks whether \a wa starts with the name of a supported
+ * paraslash writer, optionally followed by a colon and any options for that
+ * writer.  If a valid writer name was found and further are present, the
+ * remaining part of \a wa is passed to that writer's config parser.
+ *
+ * \return On success, a pointer to the gengetopt args info struct is returned
+ * and \a writer_num contains the number of the writer. Otherwise this function
+ * returns \p NULL.
+ */

 void *check_writer_arg(const char *wa, int *writer_num)
 {
        int i;
 void *check_writer_arg(const char *wa, int *writer_num)
 {
        int i;


@@ -175,18 +213,20 @@ void *check_writer_arg(const char *wa, int *writer_num)
        return NULL;
 }
 
        return NULL;
 }
 

+/**
+ * setup a writer node group with only one writer, the default writer
+ *
+ * The writer which is set up depends on the OS. It defaults to alsa for Linux,
+ * osx_write for OS X, file writer if neither of these is supported.
+ *
+ * \return pointer to the allocated writer node group
+ */

 struct writer_node_group *setup_default_wng(void)
 {
        struct writer_node_group *wng = wng_new(1);
 struct writer_node_group *setup_default_wng(void)
 {
        struct writer_node_group *wng = wng_new(1);

-       enum writer_enum default_writer;
-
-       if (NUM_SUPPORTED_WRITERS == 1)
-               default_writer = FILE_WRITE;
-       else
-               default_writer = 1;
-       wng->writer_nodes[0].writer = &writers[default_writer];
+       wng->writer_nodes[0].writer = &writers[DEFAULT_WRITER];

        PARA_INFO_LOG("using default writer: %s %p\n",
        PARA_INFO_LOG("using default writer: %s %p\n",

-               writer_names[default_writer], writers[default_writer].parse_config);
-       wng->writer_nodes[0].conf = writers[default_writer].parse_config("");
+               writer_names[DEFAULT_WRITER], writers[DEFAULT_WRITER].parse_config);
+       wng->writer_nodes[0].conf = writers[DEFAULT_WRITER].parse_config("");

        return wng;
 }
        return wng;
 }