Improve help/man page of para_recv.

[paraslash.git] / recv.c

diff --git a/recv.c b/recv.c
index 4b84e8b600cfeeb7d3907c8b292f97c2338730f2..1df476f79c2e4c2dce5c0a78d57c8c972b4ae3af 100644 (file)
--- a/recv.c
+++ b/recv.c
@@ -1,169 +1,101 @@
 /*
 /*

- * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-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.

  */
  */

-#include "para.h"

 
 

+/** \file recv.c the stand-alone audio stream receiver */
+
+#include <sys/types.h>
+#include <dirent.h>
+
+#include "para.h"

 #include "list.h"
 #include "sched.h"
 #include "list.h"
 #include "sched.h"

+#include "ggo.h"

 #include "recv.h"
 #include "recv.cmdline.h"
 #include "fd.h"
 #include "error.h"
 #include "stdout.h"
 
 #include "recv.h"
 #include "recv.cmdline.h"
 #include "fd.h"
 #include "error.h"
 #include "stdout.h"
 

-struct gengetopt_args_info conf;
+/** the gengetopt args info struct */
+struct recv_args_info conf;
+
+/** always log to stderr */
+INIT_STDERR_LOGGING(conf.loglevel_arg);

 
 

+/** init array of error codes used by para_recv */

 INIT_RECV_ERRLISTS;
 
 INIT_RECV_ERRLISTS;
 

-__printf_2_3 void para_log(int ll, const char* fmt,...)
+__noreturn static void print_help_and_die(void)

 {
 {

-       va_list argp;
-
-       /* ignore log message if loglevel is not high enough */
-       if (ll < conf.loglevel_arg)
-               return;
-       va_start(argp, fmt);
-       vfprintf(stderr, fmt, argp);
-       va_end(argp);
+       printf("dsfsfsd\n");
+       int i, d = conf.detailed_help_given;
+       const char **p = d? recv_args_info_detailed_help
+               : recv_args_info_help;
+
+       printf_or_die("%s\n\n", RECV_CMDLINE_PARSER_PACKAGE "-"
+               RECV_CMDLINE_PARSER_VERSION);
+       printf_or_die("%s\n\n", recv_args_info_usage);
+       for (; *p; p++)
+               printf_or_die("%s\n", *p);
+
+       printf_or_die("\nAvailable receivers: \n\t");
+       FOR_EACH_RECEIVER(i)
+               printf_or_die("%s%s", i? " " : "", receivers[i].name);
+       printf_or_die("\n\n");
+       FOR_EACH_RECEIVER(i) {
+               struct receiver *r = receivers + i;
+
+               if (!r->help.short_help)
+                       continue;
+               printf_or_die("Options for %s:\n", r->name);
+               ggo_print_help(&r->help, d);
+       }
+       exit(0);

 }
 
 static void *parse_config(int argc, char *argv[], int *receiver_num)
 {
 }
 
 static void *parse_config(int argc, char *argv[], int *receiver_num)
 {

-       int i;
-
-       if (cmdline_parser(argc, argv, &conf))
+       if (recv_cmdline_parser(argc, argv, &conf))

                return NULL;
                return NULL;

-       if (conf.list_receivers_given) {
-               printf("available receivers: ");
-               for (i = 0; receivers[i].name; i++)
-                       printf("%s%s", i? " " : "", receivers[i].name);
-               printf("\nTry\n\tpara_recv -r '<receivername> -h'\n"
-                       "for help on <receivername>.\n");
-               exit(EXIT_SUCCESS);
-       }
+       HANDLE_VERSION_FLAG("recv", conf);
+       if (conf.help_given || conf.detailed_help_given)
+               print_help_and_die();

        return check_receiver_arg(conf.receiver_arg, receiver_num);
 }
 
        return check_receiver_arg(conf.receiver_arg, receiver_num);
 }
 

-#if 0
-int main(int argc, char *argv[])
-{
-       int ret, eof = 0, max, r_opened = 0, receiver_num;
-       struct timeval timeout;
-       struct  receiver *r = NULL;
-       fd_set rfds, wfds;
-       struct receiver_node rn;
-
-       memset(&rn, 0, sizeof(struct receiver_node));
-       for (ret = 0; receivers[ret].name; ret++)
-               receivers[ret].init(&receivers[ret]);
-       ret = -E_RECV_SYNTAX;
-       rn.conf = parse_config(argc, argv, &receiver_num);
-       if (!rn.conf) {
-               PARA_EMERG_LOG("%s", "parse failed\n");
-               goto out;
-       }
-       r = &receivers[receiver_num];
-       rn.receiver = r;
-       ret = r->open(&rn);
-       if (ret < 0)
-               goto out;
-       r_opened = 1;
-recv:
-       FD_ZERO(&rfds);
-       FD_ZERO(&wfds);
-       timeout.tv_sec = 0;
-       timeout.tv_usec = 999 * 1000;
-       max = -1;
-       ret = r->pre_select(&rn, &rfds, &wfds, &timeout);
-       max = PARA_MAX(max, ret);
-
-       PARA_DEBUG_LOG("timeout: %lums, max: %d\n", tv2ms(&timeout), max);
-       ret = para_select(max + 1, &rfds, &wfds, &timeout);
-       if (ret < 0) {
-               ret = -E_RECV_SELECT;
-               goto out;
-       }
-       ret = r->post_select(&rn, ret, &rfds, &wfds);
-       if (ret < 0)
-               goto out;
-       if (!ret)
-               eof = 1;
-       if (!rn.loaded) {
-               if (eof)
-                       goto out;
-               goto recv;
-       }
-       ret = write(STDOUT_FILENO, rn.buf, rn.loaded);
-       PARA_DEBUG_LOG("wrote %d/%zd\n", ret, rn.loaded);
-       if (ret < 0) {
-               ret = -E_WRITE_STDOUT;
-               goto out;
-       }
-       if (ret != rn.loaded) {
-               PARA_INFO_LOG("short write %d/%zd\n", ret, rn.loaded);
-               memmove(rn.buf, rn.buf + ret, rn.loaded - ret);
-       }
-       rn.loaded -= ret;
-       if (rn.loaded || !eof)
-               goto recv;
-out:
-       if (r_opened)
-               r->close(&rn);
-       if (r)
-               r->shutdown();
-       if (ret < 0)
-               PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
-       return ret;
-}
-#endif
-
-void rn_event_handler(struct task *t)
-{
-       PARA_ERROR_LOG("%s\n", PARA_STRERROR(-t->ret));
-       unregister_task(t);
-}
-
-void stdout_event_handler(struct task *t)
-{
-       PARA_ERROR_LOG("%s\n", PARA_STRERROR(-t->ret));
-       unregister_task(t);
-}
-
+/**
+ * the main function of para_recv
+ *
+ * \param argc number of arguments
+ * \param argv vector of arguments
+ *
+ * para_recv uses the specified receiver to receive an audio stream sent by
+ * para_server. The received data is written to stdout.
+ *
+ * \return \a EXIT_SUCCESS on success, \a EXIT_FAILURE on errors.
+ */

 int main(int argc, char *argv[])
 {
 int main(int argc, char *argv[])
 {

-       int ret, eof = 0, max, r_opened = 0, receiver_num;
-       struct timeval timeout;
-       struct  receiver *r = NULL;
-       fd_set rfds, wfds;
+       int ret, r_opened = 0, receiver_num;
+       struct receiver *r = NULL;

        struct receiver_node rn;
        struct stdout_task sot;
        struct receiver_node rn;
        struct stdout_task sot;

-       struct sched s;
+       static struct sched s;

 
 

-       init_sched();

        s.default_timeout.tv_sec = 1;
        s.default_timeout.tv_usec = 0;
 
        s.default_timeout.tv_sec = 1;
        s.default_timeout.tv_usec = 0;
 

+       memset(&sot, 0, sizeof(struct stdout_task));

        memset(&rn, 0, sizeof(struct receiver_node));
        memset(&rn, 0, sizeof(struct receiver_node));

-       for (ret = 0; receivers[ret].name; ret++)
+       FOR_EACH_RECEIVER(ret)

                receivers[ret].init(&receivers[ret]);
        ret = -E_RECV_SYNTAX;
        rn.conf = parse_config(argc, argv, &receiver_num);
        if (!rn.conf) {
                receivers[ret].init(&receivers[ret]);
        ret = -E_RECV_SYNTAX;
        rn.conf = parse_config(argc, argv, &receiver_num);
        if (!rn.conf) {

-               PARA_EMERG_LOG("%s", "parse failed\n");
+               PARA_EMERG_LOG("parse failed\n");

                goto out;
        }
        r = &receivers[receiver_num];
                goto out;
        }
        r = &receivers[receiver_num];


@@ -173,33 +105,24 @@ int main(int argc, char *argv[])
                goto out;
        r_opened = 1;
 
                goto out;
        r_opened = 1;
 

-       sot.task.private_data = &sot;
-       sot.task.pre_select = stdout_pre_select;
-       sot.task.post_select = stdout_post_select;
-       sot.task.event_handler = stdout_event_handler;
-       sot.task.flags = 0;
-       sprintf(sot.task.status, "stdout writer");
+       stdout_set_defaults(&sot);

        sot.buf = rn.buf;
        sot.loaded = &rn.loaded;
        sot.buf = rn.buf;
        sot.loaded = &rn.loaded;

-       sot.eof = &rn.eof;
+       sot.input_error = &rn.task.error;

        register_task(&sot.task);
 
        register_task(&sot.task);
 

-       rn.task.private_data = &rn;

        rn.task.pre_select = r->pre_select;
        rn.task.post_select = r->post_select;
        rn.task.pre_select = r->pre_select;
        rn.task.post_select = r->post_select;

-       rn.task.event_handler = rn_event_handler;
-       rn.task.flags = 0;

        sprintf(rn.task.status, "receiver node");
        register_task(&rn.task);
 
        sprintf(rn.task.status, "receiver node");
        register_task(&rn.task);
 

-
-       ret = sched(&s);
+       ret = schedule(&s);

 out:
        if (r_opened)
                r->close(&rn);
        if (r)
                r->shutdown();
        if (ret < 0)
 out:
        if (r_opened)
                r->close(&rn);
        if (r)
                r->shutdown();
        if (ret < 0)

-               PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
-       return ret;
+               PARA_ERROR_LOG("%s\n", para_strerror(-ret));
+       return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;

 }
 }