Merge branch 't/makefile_cleanups'
[paraslash.git] / filter_common.c
index 7c71ff3..1233c9a 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2009 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2011 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -8,13 +8,14 @@
 
 #include <regex.h>
 #include <sys/types.h>
-#include <dirent.h>
+#include <stdbool.h>
 
 #include "para.h"
 #include "list.h"
 #include "sched.h"
 #include "fd.h"
 #include "ggo.h"
+#include "buffer_tree.h"
 #include "filter.h"
 #include "error.h"
 #include "string.h"
@@ -34,153 +35,6 @@ void filter_init(void)
                filters[i].init(filters + i);
 }
 
-/**
- * Close and destroy a filter callback.
- *
- * \param fcb The filter callback to close.
- *
- * This removes \a fcb from the list of filter callbacks and calls
- * the close callback associated with \a fcb.
- */
-static void close_filter_callback(struct filter_callback *fcb)
-{
-       PARA_NOTICE_LOG("closing filter_callback %p\n", fcb);
-       list_del(&fcb->node);
-       fcb->close(fcb);
-}
-
-/**
- * Close all callbacks of a filter node.
- *
- * \param fn The filter node which contains the filter callbacks to be closed.
- *
- * Call close_filter_callback() for each entry in the filter callback list
- * of \a fn.
- */
-static void close_callbacks(struct filter_node *fn)
-{
-       struct filter_callback *fcb, *tmp;
-
-       list_for_each_entry_safe(fcb, tmp, &fn->callbacks, node) {
-               PARA_INFO_LOG("closing %s filter callback\n",
-                       filters[fn->filter_num].name);
-               close_filter_callback(fcb);
-       }
-}
-
-static void call_callbacks(struct filter_node *fn, char *inbuf, size_t inlen,
-       char *outbuf, size_t outlen)
-{
-       struct filter_callback *fcb, *tmp;
-       list_for_each_entry_safe(fcb, tmp, &fn->callbacks, node) {
-               int ret;
-               if (inlen && fcb->input_cb) {
-                       ret = fcb->input_cb(inbuf, inlen, fcb);
-                       if (ret < 0) {
-                               close_filter_callback(fcb);
-                               continue;
-                       }
-               }
-               if (!outlen || !fcb->output_cb)
-                       continue;
-               ret = fcb->output_cb(outbuf, outlen, fcb);
-               if (ret < 0)
-                       close_filter_callback(fcb);
-       }
-}
-
-/**
- * Call the convert function of each filter.
- *
- * \param s Unused.
- * \param t The task identifying the filter chain.
- *
- * This is the core function of the filter subsystem. It loops over the list of
- * filter nodes determined by \a t and calls the filter's convert function if
- * there is input available for the filter node in question. If the convert
- * function consumed some or all of its input data, all registered input
- * callbacks are called.  Similarly, if a convert function produced output, all
- * registered output callbacks get called.
- *
- * On errors a (negative) error code is stored in t->error.
- *
- * \sa filter_node, filter#convert, filter_callback.
- */
-void filter_post_select(__a_unused struct sched *s, struct task *t)
-{
-       struct filter_chain *fc = container_of(t, struct filter_chain, task);
-       struct filter_node *fn;
-       char *ib;
-       size_t *loaded;
-       int i, conv, conv_total = 0;
-
-       if (fc->output_error && *fc->output_error < 0) {
-               t->error =  *fc->output_error;
-               return;
-       }
-again:
-       ib = *fc->inbufp;
-       loaded = fc->in_loaded;
-       conv = 0;
-       FOR_EACH_FILTER_NODE(fn, fc, i) {
-               struct filter *f = filters + fn->filter_num;
-               if (fn->loaded < fn->bufsize) {
-                       size_t size, old_fn_loaded = fn->loaded;
-                       t->error = f->convert(ib, *loaded, fn);
-                       if (t->error < 0)
-                               return;
-                       size = t->error;
-                       call_callbacks(fn, ib, size, fn->buf + old_fn_loaded,
-                               fn->loaded - old_fn_loaded);
-                       *loaded -= size;
-                       conv += size + fn->loaded - old_fn_loaded;
-                       if (*loaded && size)
-                               memmove(ib, ib + size, *loaded);
-               }
-               ib = fn->buf;
-               loaded = &fn->loaded;
-       }
-       conv_total += conv;
-       if (conv)
-               goto again;
-       if (*fc->input_error >= 0)
-               return;
-       if (*fc->out_loaded)
-               return;
-       if (*fc->in_loaded && conv_total)
-               return;
-       t->error = -E_FC_EOF;
-}
-
-/**
- * Close all filter nodes and their callbacks.
- *
- * \param fc The filter chain to close.
- *
- * For each filter node determined by \a fc, call the close function of each
- * registered filter callback as well as the close function of the
- * corresponding filter.  Free all resources and destroy all callback lists and
- * the filter node list.
- *
- * \sa filter::close, filter_callback::close
- */
-void close_filters(struct filter_chain *fc)
-{
-       struct filter_node *fn;
-       int i;
-
-       if (!fc)
-               return;
-       PARA_NOTICE_LOG("closing filter chain %p\n", fc);
-       FOR_EACH_FILTER_NODE(fn, fc, i) {
-               struct filter *f = filters + fn->filter_num;
-               close_callbacks(fn);
-               PARA_INFO_LOG("closing %s filter\n", f->name);
-               f->close(fn);
-       }
-       free(fc->filter_nodes);
-}
-
 /*
  * If the filter has a command line parser and options is not NULL, run it.
  * Returns filter_num on success, negative on errors
@@ -254,6 +108,11 @@ int check_filter_arg(char *fa, void **conf)
        return -E_UNSUPPORTED_FILTER;
 }
 
+/**
+ * Print help text of each filter to stdout.
+ *
+ * \param detailed If non-zero, print detailed help.
+ */
 void print_filter_helps(int detailed)
 {
        int i;
@@ -271,5 +130,66 @@ void print_filter_helps(int detailed)
                printf_or_die("Options for %s:\n", f->name);
                ggo_print_help(&f->help, detailed);
        }
+}
 
+/**
+ * Set select timeout of the the scheduler.
+ *
+ * \param s The scheduler.
+ * \param t The task struct of this filter.
+ *
+ * This looks at the status of the btr node of the filter. If data is available
+ * in the input queue of the filter, or if an error occured, a minimal timeout
+ * for the next select call is requested from the scheduler. Otherwise the
+ * scheduler timeout is left unchanged.
+ */
+void generic_filter_pre_select(struct sched *s, struct task *t)
+{
+       struct filter_node *fn = container_of(t, struct filter_node, task);
+
+       t->error = 0;
+       if (btr_node_status(fn->btrn, fn->min_iqs, BTR_NT_INTERNAL) != 0)
+               sched_min_delay(s);
+}
+
+#ifdef WORDS_BIGENDIAN
+#define DECODER_SAMPLE_FORMAT SF_S16_BE
+#else
+#define DECODER_SAMPLE_FORMAT SF_S16_LE
+#endif
+
+/**
+ * Execute a btr command for a decoder.
+ *
+ * The buffer tree nodes of the writers ask the parent nodes about sample_rate,
+ * channels count and sample format. This function is called by all decoders to
+ * answer these queries.
+ *
+ * \param cmd The command to be executed by the child node.
+ * \param sample_rate Known to the decoder.
+ * \param channels Known to the decoder.
+ * \param result Ascii representation on the answer is stored here.
+ *
+ * \return Standard.
+ */
+int decoder_execute(const char *cmd, unsigned sample_rate, unsigned channels,
+               char **result)
+{
+       if (!strcmp(cmd, "sample_rate")) {
+               if (sample_rate == 0)
+                       return -E_BTR_NAVAIL;
+               *result = make_message("%u", sample_rate);
+               return 1;
+       }
+       if (!strcmp(cmd, "channels")) {
+               if (channels == 0)
+                       return -E_BTR_NAVAIL;
+               *result = make_message("%u", channels);
+               return 1;
+       }
+       if (!strcmp(cmd, "sample_format")) {
+               *result = make_message("%u", DECODER_SAMPLE_FORMAT);
+               return 1;
+       }
+       return -ERRNO_TO_PARA_ERROR(ENOTSUP);
 }