* 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;
};
}
/**
- * the init function of the compress filter
+ * The init function of the compress filter.
*
- * \param f pointer to the struct to initialize
+ * \param f Pointer to the struct to initialize.
*/
void compress_init(struct filter *f)
{