Merge branch 'master' into next
[paraslash.git] / compress.c
index da79b721649136e116379a2d1e152c7bdbafe240..d6f7520d6376dab4ccc9a4a580aab40d90f68c03 100644 (file)
 /*
- * 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.
  */
 
-/** \file compress.c paraslash's dynamic audio range compressor */
+/** \file compress.c Paraslash's dynamic audio range compressor. */
 
 /*
- * Based on AudioCompress, (C) 2002-2004  M. Hari Nezumi <magenta@trikuare.cx>
+ * Uses ideas of AudioCompress, (C) 2002-2004  M. Hari Nezumi <magenta@trikuare.cx>
  */
 
-#include "gcc-compat.h"
 #include "para.h"
 #include "compress_filter.cmdline.h"
 #include "list.h"
+#include "sched.h"
 #include "filter.h"
 #include "string.h"
+#include "error.h"
 
-/** how fine-grained the gain is */
-#define GAINSHIFT 10
-/** the size of the output data buffer */
+/** The size of the output data buffer. */
 #define COMPRESS_CHUNK_SIZE 40960
 
-/** data specific to the compress filter */
+extern char *stat_item_values[NUM_STAT_ITEMS];
+
+/** Data specific to the compress filter. */
 struct private_compress_data {
-       /** an array holding the previous peak values */
-       int *peaks;
-       /** current bucket number to be modified */
-       unsigned pn;
-       /** number of times clipping occured */
-       unsigned clip;
-       /** the current multiplier */
-       int current_gain;
-       /** the target multiplier */
-       int target_gain;
-       /** pointer to the configuration data for this instance of the compress filter */
-       struct gengetopt_args_info *conf;
+       /** The current multiplier. */
+       unsigned current_gain;
+       /** Points to the configuration data for this instance of the compress filter. */
+       struct compress_filter_args_info *conf;
+       /** Maximal admissible gain. */
+       unsigned max_gain;
+       /** Number of samples already seen. */
+       unsigned num_samples;
+       /** Absolute value of the maximal sample in the current block. */
+       unsigned peak;
 };
 
 static ssize_t compress(char *inbuf, size_t inbuf_len, struct filter_node *fn)
 {
-       int16_t *audio = (int16_t *) inbuf, *ip = audio, *op;
-       int peak = 1, pos = 0, i, gr, gf, gn;
-       size_t length = MIN((inbuf_len / 2) * 2, (fn->bufsize - fn->loaded) / 2 * 2);
+       size_t i, length = PARA_MIN((inbuf_len / 2) * 2,
+               (fn->bufsize - fn->loaded) / 2 * 2);
        struct private_compress_data *pcd = fn->private_data;
+       int16_t *ip = (int16_t *)inbuf, *op = (int16_t *)(fn->buf + fn->loaded);
+       unsigned gain_shift = pcd->conf->inertia_arg + pcd->conf->damp_arg,
+               mask = (1 << pcd->conf->blocksize_arg) - 1;
 
        if (!length)
                return 0;
-       /* determine peak's value and position */
-       for (i = 0; i < length / 2; i++, ip++) {
-               int val = ABS(*ip);
-               if (val > peak) {
-                       peak = val;
-                       pos = i;
-               }
-       }
-       pcd->peaks[pcd->pn] = peak;
-       for (i = 0; i < pcd->conf->buckets_arg; i++) {
-               if (pcd->peaks[i] > peak) {
-                       peak = pcd->peaks[i];
-                       pos = 0;
-               }
-       }
-       /* determine target gain */
-       gn = (1 << GAINSHIFT) * pcd->conf->target_level_arg / peak;
-       if (gn < (1 << GAINSHIFT))
-               gn = 1 << GAINSHIFT;
-       pcd->target_gain = (pcd->target_gain * ((1 << pcd->conf->gain_smooth_arg) - 1) + gn)
-               >> pcd->conf->gain_smooth_arg;
-       /* give it an extra insignificant nudge to counteract possible
-        * rounding error
-        */
-       if (gn < pcd->target_gain)
-               pcd->target_gain--;
-       else if (gn > pcd->target_gain)
-               pcd->target_gain++;
-       if (pcd->target_gain > pcd->conf->gain_max_arg << GAINSHIFT)
-               pcd->target_gain = pcd->conf->gain_max_arg << GAINSHIFT;
-       /* see if a peak is going to clip */
-       gn = (1 << GAINSHIFT) * 32768 / peak;
-       if (gn < pcd->target_gain) {
-               pcd->target_gain = gn;
-               if (pcd->conf->anticlip_given)
-                       pos = 0;
-       } else
-               /* we're ramping up, so draw it out over the whole frame */
-               pos = length;
-       /* determine gain rate necessary to make target */
-       if (!pos)
-               pos = 1;
-       gr = ((pcd->target_gain - pcd->current_gain) << 16) / pos;
-       gf = pcd->current_gain << 16;
-       ip = audio;
-       op = (int16_t *)(fn->buf + fn->loaded);
        for (i = 0; i < length / 2; i++) {
-               int sample;
-               /* interpolate the gain */
-               pcd->current_gain = gf >> 16;
-               if (i < pos)
-                       gf += gr;
-               else if (i == pos)
-                       gf = pcd->target_gain << 16;
-               /* amplify */
-               sample = (*ip++) * pcd->current_gain * pcd->conf->volume_arg / 10 >> GAINSHIFT;
-               if (sample < -32768) {
-                       pcd->clip++;
-                       sample = -32768;
-               } else if (sample > 32767) {
-                       pcd->clip++;
-                       sample = 32767;
-               }
-               *op++ = sample;
+               /* be careful in that heat, my dear */
+               int sample = *ip++, adjusted_sample = (PARA_ABS(sample) *
+                       pcd->current_gain) >> gain_shift;
+               if (unlikely(adjusted_sample > 32767)) { /* clip */
+                       PARA_NOTICE_LOG("clip: sample: %d, adjusted sample: %d\n",
+                               sample, adjusted_sample);
+                       adjusted_sample = 32767;
+                       pcd->current_gain = (3 * pcd->current_gain +
+                               (1 << pcd->conf->inertia_arg)) / 4;
+                       pcd->peak = 0;
+               } else
+                       pcd->peak = PARA_MAX(pcd->peak, adjusted_sample);
+               *op++ = sample >= 0? adjusted_sample : -adjusted_sample;
+               if (likely(++pcd->num_samples & mask))
+                       continue;
+//             PARA_DEBUG_LOG("gain: %u, peak: %u\n", pcd->current_gain,
+//                     pcd->peak);
+               if (pcd->peak < pcd->conf->target_level_arg) {
+                       if (pcd->current_gain < pcd->max_gain)
+                               pcd->current_gain++;
+               } else
+                       pcd->current_gain = PARA_MAX(pcd->current_gain - 2,
+                               1 << pcd->conf->inertia_arg);
+               pcd->peak = 0;
        }
-       pcd->pn = (pcd->pn + 1) % pcd->conf->buckets_arg;
-       PARA_DEBUG_LOG("bucket: %03i, input len: %i, length: %i, peak: %05i, "
-               "current gain: %03i, clipped: %d\n", pcd->pn, inbuf_len,
-               length, peak, pcd->current_gain, pcd->clip);
-       fn->loaded = length;
+       fn->loaded += length;
        return length;
 }
 
 static void close_compress(struct filter_node *fn)
 {
-       struct private_compress_data *pcd = fn->private_data;
-       free(pcd->peaks);
        free(fn->private_data);
        free(fn->buf);
 }
 
-static void *compress_parse_config(int argc, char **argv)
+/** TODO: Add sanity checks */
+static int compress_parse_config(int argc, char **argv, void **config)
 {
-       struct gengetopt_args_info *ret = para_calloc(sizeof(struct gengetopt_args_info));
-       if (!compress_cmdline_parser(argc, argv, ret))
-               return ret;
-       free(ret);
-       return NULL;
+       int ret;
+       struct compress_filter_args_info *compress_conf
+               = para_calloc(sizeof(*compress_conf));
+
+       ret = -E_COMPRESS_SYNTAX;
+       if (compress_cmdline_parser(argc, argv, compress_conf))
+               goto err;
+       *config = compress_conf;
+       return 1;
+err:
+       free(compress_conf);
+       return  ret;
 }
 
 static void open_compress(struct filter_node *fn)
 {
        struct private_compress_data *pcd = para_calloc(
                sizeof(struct private_compress_data));
-//     compress_cmdline_parser(fn->argc, fn->argv, &pcd->conf);
        pcd->conf = fn->conf;
-       pcd->peaks = para_calloc(pcd->conf->buckets_arg * sizeof(int));
        fn->private_data = pcd;
        fn->bufsize = COMPRESS_CHUNK_SIZE;
        fn->buf = para_malloc(fn->bufsize);
-       fn->loaded = 0;
+       pcd->current_gain = 1 << pcd->conf->inertia_arg;
+       pcd->max_gain = 1 << (pcd->conf->inertia_arg + pcd->conf->aggressiveness_arg);
 }
 
-/** the init function of the compress filter */
-void compress_init(struct filter *f)
+/**
+ * The init function of the compress filter.
+ *
+ * \param f Pointer to the struct to initialize.
+ */
+void compress_filter_init(struct filter *f)
 {
        f->open = open_compress;
        f->close = close_compress;