/*
- * 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. */
/*
- * Used ideas of AudioCompress, (C) 2002-2004 M. Hari Nezumi <magenta@trikuare.cx>
+ * Uses ideas of AudioCompress, (C) 2002-2004 M. Hari Nezumi <magenta@trikuare.cx>
*/
#include "para.h"
#include "filter.h"
#include "string.h"
-/** 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 */
+/** Data specific to the compress filter. */
struct private_compress_data {
- /** the current multiplier */
+ /** The current multiplier. */
unsigned current_gain;
- /** points to the configuration data for this instance of the compress filter */
+ /** Points to the configuration data for this instance of the compress filter. */
struct compress_filter_args_info *conf;
- /** minimal admissible gain */
+ /** Minimal admissible gain. */
unsigned min_gain;
- /** maximal admissible gain */
+ /** Maximal admissible gain. */
unsigned max_gain;
- /** number of samples already seen */
+ /** Number of samples already seen. */
unsigned num_samples;
- /** absolute value of the maximal sample in the current block */
+ /** Absolute value of the maximal sample in the current block. */
unsigned peak;
};
pcd->peak = 0;
} else
if (adjusted_sample > pcd->peak)
- pcd->peak = sample;
+ pcd->peak = adjusted_sample;
} else {
adjusted_sample = -((-sample * pcd->current_gain)
>> gain_shift);
pcd->max_gain = 1 << (pcd->conf->inertia_arg + pcd->conf->aggressiveness_arg);
}
-/** the init function of the compress filter */
+/**
+ * The init function of the compress filter.
+ *
+ * \param f Pointer to the struct to initialize.
+ */
void compress_init(struct filter *f)
{
f->open = open_compress;