write_common.c

   1 /*
   2  * Copyright (C) 2006-2010 Andre Noll <maan@systemlinux.org>
   3  *
   4  * Licensed under the GPL v2. For licencing details see COPYING.
   5  */
   6
   7 /** \file write_common.c common functions of para_audiod and para_write */
   8
   9 #include <regex.h>
  10 #include <stdbool.h>
  11
  12 #include "para.h"
  13 #include "string.h"
  14 #include "list.h"
  15 #include "sched.h"
  16 #include "ggo.h"
  17 #include "buffer_tree.h"
  18 #include "write.h"
  19 #include "error.h"
  20
  21 /** the array containing the names of all supported writers */
  22 const char *writer_names[] ={WRITER_NAMES};
  23
  24 /** the array of supported writers */
  25 struct writer writers[NUM_SUPPORTED_WRITERS] = {WRITER_ARRAY};
  26
  27 /**
  28  * Call the init function of each supported paraslash writer.
  29  */
  30 void writer_init(void)
  31 {
  32         int i;
  33
  34         FOR_EACH_WRITER(i)
  35                 writers[i].init(&writers[i]);
  36 }
  37 /**
  38  * check if given string is a valid command line for any writer
  39  *
  40  * \param \wa string of the form writer_name:options
  41  * \param writer_num contains the number of the writer upon success
  42  *
  43  * This function checks whether \a wa starts with the name of a supported
  44  * paraslash writer, optionally followed by a colon and any options for that
  45  * writer.  If a valid writer name was found and further are present, the
  46  * remaining part of \a wa is passed to that writer's config parser.
  47  *
  48  * \return On success, a pointer to the gengetopt args info struct is returned
  49  * and \a writer_num contains the number of the writer. Otherwise this function
  50  * returns \p NULL.
  51  */
  52 void *check_writer_arg(const char *wa, int *writer_num)
  53 {
  54         int i;
  55
  56         *writer_num = -E_WRITE_COMMON_SYNTAX;
  57         PARA_INFO_LOG("checking  %s\n", wa);
  58         FOR_EACH_WRITER(i) {
  59                 const char *name = writer_names[i];
  60                 size_t len = strlen(name);
  61                 char c;
  62                 if (strlen(wa) < len)
  63                         continue;
  64                 if (strncmp(name, wa, len))
  65                         continue;
  66                 c = wa[len];
  67                 if (c && c != ' ')
  68                         continue;
  69                 *writer_num = i;
  70                 return writers[i].parse_config_or_die(c? wa + len + 1 : "");
  71         }
  72         PARA_ERROR_LOG("writer not found\n");
  73         return NULL;
  74 }
  75
  76 /**
  77  * Open a writer node and register the corresponding task.
  78  *
  79  * \param wn The writer node to open.
  80  * \param parent The parent btr node (the source for the writer node).
  81  *
  82  * The configuration of the writer node stored in \p wn->conf must be
  83  * initialized before this function may be called.
  84  */
  85 void register_writer_node(struct writer_node *wn, struct btr_node *parent)
  86 {
  87         struct writer *w = writers + wn->writer_num;
  88         char *name = make_message("%s writer", writer_names[wn->writer_num]);
  89
  90         wn->btrn = btr_new_node(&(struct btr_node_description)
  91                 EMBRACE(.name = name, .parent = parent,
  92                 .handler = w->execute, .context = wn));
  93         strcpy(wn->task.status, name);
  94         free(name);
  95         w->open(wn);
  96         wn->task.post_select = w->post_select;
  97         wn->task.pre_select = w->pre_select;
  98         register_task(&wn->task);
  99 }
 100
 101 /**
 102  * Setup a writer node with the default writer.
 103  *
 104  * If arg is \p NULL, the OS-dependent default writer is used with an empty
 105  * configuration string.  It defaults to alsa for Linux, osx for OS X, oss for
 106  * *BSD and the file writer if neither of these is supported.
 107  *
 108  * Once the writer configuration has been retrieved, a writer node is created,
 109  * its buffer tree node is added to the buffer tree as a child of the given
 110  * parent.
 111  *
 112  * Finally, the new writer node's taks structure is initialized and registered
 113  * to the paraslash scheduler.
 114  *
 115  * \return A pointer to the allocated writer node group.
 116  */
 117 int setup_writer_node(const char *arg, struct btr_node *parent,
 118                 struct writer_node *wn)
 119 {
 120         if (arg)
 121                 wn->conf = check_writer_arg(arg, &wn->writer_num);
 122         else {
 123                 wn->writer_num = DEFAULT_WRITER;
 124                 wn->conf = writers[DEFAULT_WRITER].parse_config_or_die("");
 125         }
 126         if (!wn->conf)
 127                 return -E_WRITE_COMMON_SYNTAX;
 128         register_writer_node(wn, parent);
 129         return 1;
 130 }
 131
 132 /**
 133  * Print the help text of all writers to stdout.
 134  *
 135  * \param detailed Whether to print the detailed help text.
 136  */
 137 void print_writer_helps(int detailed)
 138 {
 139         int i;
 140
 141         printf_or_die("\nAvailable writers: \n\t");
 142         FOR_EACH_WRITER(i)
 143                 printf_or_die("%s%s", i? " " : "", writer_names[i]);
 144         printf_or_die("\n\n");
 145         FOR_EACH_WRITER(i) {
 146                 struct writer *w = writers + i;
 147
 148                 if (!w->help.short_help)
 149                         continue;
 150                 printf_or_die("Options for %s:\n", writer_names[i]);
 151                 ggo_print_help(&w->help, detailed);
 152         }
 153 }
 154
 155 static void get_btr_value(struct btr_node *btrn, const char *cmd,
 156                 int32_t *result)
 157 {
 158         char *buf = NULL;
 159         int ret = btr_exec_up(btrn, cmd, &buf);
 160
 161         assert(ret >= 0);
 162         ret = para_atoi32(buf, result);
 163         assert(ret >= 0);
 164         free(buf);
 165 }
 166
 167 /**
 168  * Ask parent btr nodes for the sample rate of the current stream.
 169  *
 170  * \param btrn Where to start the search.
 171  * \param result Filled in by this function.
 172  *
 173  * This function is assumed to succeed and terminates on errors.
 174  */
 175 void get_btr_sample_rate(struct btr_node *btrn, int32_t *result)
 176 {
 177         get_btr_value(btrn, "sample_rate", result);
 178 }
 179
 180 /**
 181  * Ask parent btr nodes for the channel count of the current stream.
 182  *
 183  * \param btrn See \ref get_btr_sample_rate.
 184  * \param result See \ref get_btr_sample_rate.
 185  */
 186 void get_btr_channels(struct btr_node *btrn, int32_t *result)
 187 {
 188         get_btr_value(btrn, "channels", result);
 189 }
 190
 191 /**
 192  * Ask parent btr nodes for the number of bits per sample and the byte sex.
 193  *
 194  * \param btrn See \ref get_btr_sample_rate.
 195  * \param result Contains the sample format as an enum sample_format type.
 196  */
 197 void get_btr_sample_format(struct btr_node *btrn, int32_t *result)
 198 {
 199         get_btr_value(btrn, "sample_format", result);
 200 }