/usr/include/speech_tools/sigpr/EST_Window.h is in libestools2.1-dev 1:2.1~release-8.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 | /************************************************************************/
/* */
/* Centre for Speech Technology Research */
/* University of Edinburgh, UK */
/* Copyright (c) 1996,1997 */
/* All Rights Reserved. */
/* */
/* Permission is hereby granted, free of charge, to use and distribute */
/* this software and its documentation without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of this work, and to */
/* permit persons to whom this work is furnished to do so, subject to */
/* the following conditions: */
/* 1. The code must retain the above copyright notice, this list of */
/* conditions and the following disclaimer. */
/* 2. Any modifications must be clearly marked as such. */
/* 3. Original authors' names are not deleted. */
/* 4. The authors' names are not used to endorse or promote products */
/* derived from this software without specific prior written */
/* permission. */
/* */
/* THE UNIVERSITY OF EDINBURGH AND THE CONTRIBUTORS TO THIS WORK */
/* DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING */
/* ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT */
/* SHALL THE UNIVERSITY OF EDINBURGH NOR THE CONTRIBUTORS BE LIABLE */
/* FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES */
/* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN */
/* AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, */
/* ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF */
/* THIS SOFTWARE. */
/* */
/************************************************************************/
/* */
/* Author: Richard Caley and Paul Taylor */
/* Date: May 1997, April 98 */
/* ------------------------------------------------------------------- */
/* Class for windowing speech waveforms */
/* */
/************************************************************************/
#ifndef __EST_WINDOW_H__
#define __EST_WINDOW_H__
#include "EST_TBuffer.h"
#include "EST_Wave.h"
/**@defgroup Function types used for parameters to functions.
*/
///@{
/// Function which creates a window.
typedef void EST_WindowFunc(int size, EST_TBuffer<float> &r_window, int window_centre );
///@}
/** \class EST_Window
\brief The EST_Window class provides functions for the creation and use of signal processing windows.
Signal processing algorithms often work by on small sections of the
speech waveform known as *frames*. A full signal must first be
divided into these frames before these algorithms can work. While it
would be simple to just "cut out" the required frames from the
waveforms, this is usually undesirable as large discontinuities can
occur at the frame edges. Instead it is customary to cut out the frame
by means of a *window* function, which tapers the signal in the
frame so that it has high values in the middle and low or zero values
near the frame edges. The EST_Window class provides a wrap
around for such windowing operations.
There are several types of window function, including:
- **Rectangular**, which is used to give a simple copy of the the
values between the window limits.
\f[w_{n} = \left\{ \begin{array}{ll}
1 & \mbox{$0 \leq n \leq N$} \\
0 & \mbox{otherwise}
\end{array}
\right. \f]
- **Hanning**: The rectangular window can cause sharp discontinuities
at window edges. The hanning window solves this by ensuring that the
window edges taper to 0.
\f[w_{n} = \left\{ \begin{array}{ll}
0.5 - 0.5 \cos(2\pi n / (N-1)) & \mbox{$0 \leq n \leq N$} \\
0 & \mbox{otherwise}
\end{array}
\right. \f]
- **Hamming**: The hanning window causes considerable energy
loss, which the hamming window attempts to rectify.
\f[w_{n} = \left\{ \begin{array}{ll}
0.54 - 0.46 \cos(2\pi n / (N-1)) & \mbox{$0 \leq n \leq N$} \\
0 & \mbox{otherwise}
\end{array}
\right. \f]
The particular choice of window depends on the application. For
instance in most speech synthesis applications Hanning windows are the
most suitable as they don't have time domain discontinuities. For
analysis applications hamming windows are normally used.
For example code, see \ref sigpr-windowing
*/
class EST_Window {
public:
/// A function which creates a window
typedef EST_WindowFunc Func;
/**@name Functions for making windows.
*/
///@{
/** Make a Buffer of containing a window function of specified type.
If window_centre < 0 (default -1), then a symmetric window is
returned. For positive values of the window_centre argument,
asymmetric windows are returned.
*/
static void make_window(EST_TBuffer<float> &window_vals, int size,
const char *name, int window_centre);
/** Make a EST_FVector containing a window function of specified type.
If window_centre < 0 (default -1), then a symmetric window is
returned. For positive values of the window_centre argument,
asymmetric windows are returned.
*/
static void make_window(EST_FVector &window_vals, int size,
const char *name, int window_centre);
/// Return the creation function for the given window type.
static Func *creator(const char *name, bool report_error = false);
///@}
/** @name Performing windowing on a section of speech.
*/
///@{
/** Window the waveform `sig` starting at point `start` for
a duration of `size` samples. The windowing function required
is given as a function pointer `*make_window` which has
already been created by a function such as EST_Window::creator.
The output windowed frame is placed in the buffer `frame` which
will have been resized accordingly within the function.
*/
static void window_signal(const EST_Wave &sig,
EST_WindowFunc *make_window,
int start, int size,
EST_TBuffer<float> &frame);
/** Window the waveform `sig` starting at point `start` for
a duration of `size` samples. The windowing function required
is given as a function pointer `*make_window` which has
already been created by a function such as \ref creator .
The output windowed frame is placed in the EST_FVector `frame`.
By default, it is assumed that this is already the correct size
(i.e. `size` samples long), but if resizing is required the
last argument should be set to 1.
*/
static void window_signal(const EST_Wave &sig,
EST_WindowFunc *make_window,
int start, int size,
EST_FVector &frame,int resize=0);
/** Window the waveform `sig` starting at point `start` for
a duration of `size` samples. The windowing function required
is given as a string: this function will make a temporary window
of this type. The output windowed frame is placed in the
EST_FVector `frame`. By default, it is assumed that this is
already the correct size (i.e. `size` samples long), but if
resizing is required the last argument should be set to 1. */
static void window_signal(const EST_Wave &sig,
const EST_String &window_name,
int start, int size,
EST_FVector &frame, int resize=0);
/** Window the waveform `sig` starting at point `start` for
a duration of `size` samples. The window shape required
is given as an array of floats. The output windowed frame is placed in the
EST_FVector `frame`. By default, it is assumed that this is
already the correct size (i.e. `size` samples long), but if
resizing is required the last argument should be set to 1. */
static void window_signal(const EST_Wave &sig,
EST_TBuffer<float> &window_vals,
int start, int size,
EST_FVector &frame, int resize=0);
///@}
/**@name Utility window functions.
*/
///@{
/// Return the description for a given window type.
static EST_String description(const char *name);
/// Return a paragraph describing the available windows.
static EST_String options_supported(void);
/// Return a comma separated list of the available window types.
static EST_String options_short(void);
///@}
};
///For example code, see \ref Windowing .
///@see Windowing mechanisms
#endif
|