File: polyfilt.h

package info (click to toggle)
libxdf 0.99.6%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 468 kB
  • sloc: ansic: 1,661; cpp: 867; makefile: 10
file content (79 lines) | stat: -rw-r--r-- 3,189 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/**
 * Smarc
 *
 * Copyright (c) 2009-2011 Institut Tlcom - Tlcom Paristech
 * Tlcom ParisTech / dept. TSI
 *
 * Authors : Benoit Mathieu, Jacques Prado
 *
 * This file is part of Smarc.
 *
 * Smarc is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Smarc 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef POLYFILTLM_H_
#define POLYFILTLM_H_

#include "smarc.h"
#include "stage_impl.h"

/**
 * Filter signal with a L/M filter (interpolation factor and decimation factor are not 1)
 * - pfilt [IN]: filter to use
 * - pstate [IN/OUT]: filter state
 * - signal [IN]: input signal
 * - signalLen [IN]: input signal length
 * - nbRead [OUT]: number of samples read from input signal
 * - output [OUT]: output array
 * - outputLen [IN]: length of output array. Maximum number of samples to write
 * - nbWritten [OUT]: number of samples effectively written
 * - w [IN]: workspace to use for temporary results.
 */
void polyfiltLM(struct PSFilter* pfilt, struct PSState* pstate,
		const double* SMARC_RESTRICT signal, const int signalLen, int* nbConsume,
		double* SMARC_RESTRICT output, const int outputLen, int* nbWritten);

/**
 * Filter signal with a decimation filter (interpolation factor L is 1)
 * - pfilt [IN]: filter to use
 * - pstate [IN/OUT]: filter state
 * - signal [IN]: input signal
 * - signalLen [IN]: input signal length
 * - nbRead [OUT]: number of samples read from input signal
 * - output [OUT]: output array
 * - outputLen [IN]: length of output array. Maximum number of samples to write
 * - nbWritten [OUT]: number of samples effectively written
 * - w [IN]: workspace to use for temporary results.
 */
void polyfiltM(struct PSFilter* pfilt, struct PSState* pstate,
		const double* SMARC_RESTRICT signal, const int signalLen, int* SMARC_RESTRICT nbConsume,
		double* SMARC_RESTRICT output, const int outputLen, int* SMARC_RESTRICT nbWritten);

/**
 * Filter signal with a interpolation filter (decimation factor M is 1)
 * - pfilt [IN]: filter to use
 * - pstate [IN/OUT]: filter state
 * - signal [IN]: input signal
 * - signalLen [IN]: input signal length
 * - nbRead [OUT]: number of samples read from input signal
 * - output [OUT]: output array
 * - outputLen [IN]: length of output array. Maximum number of samples to write
 * - nbWritten [OUT]: number of samples effectively written
 * - w [IN]: workspace to use for temporary results.
 */
void polyfiltL(struct PSFilter* pfilt, struct PSState* pstate,
		const double* SMARC_RESTRICT signal, const int signalLen, int* SMARC_RESTRICT nbConsume,
		double* SMARC_RESTRICT output, const int outputLen, int* SMARC_RESTRICT nbWritten);

#endif /* POLYFILTLM_H_ */