~ubuntu-branches/ubuntu/wily/speech-tools/wily

« back to all changes in this revision

Viewing changes to debian/ch_wave.1

  • Committer: Bazaar Package Importer
  • Author(s): Kartik Mistry
  • Date: 2009-09-18 10:40:22 UTC
  • Revision ID: james.westby@ubuntu.com-20090918104022-166aw14eo1dellu1
Tags: 1:1.2.96~beta-5
* debian/control:
  + Updated Standards-Version to 3.8.3
  + [Lintian] Removed duplicate section for speech-tools binary
  + [Lintian] Updated package descriptions
  + Wrapped up Depends and Build-Depends
* Added debian/README.source file
* debian/*.1:
  + [Lintian] Fixed manpage warnings of undefined .P
* debian/patches/include_EST_ChannelType.diff:
  + Added missing patch description

Show diffs side-by-side

added added

removed removed

Lines of Context:
40
40
.Ar input files ...
41
41
.Sh DESCRIPTION
42
42
.Nm ch_wave
43
 
performs various operations on an input waveform file and writes it out to another file.  Among other things, it can extract subsections or individual channels, resample, rescale, mix down channels, and perform simple filtering operations.
44
 
.P
 
43
performs various operations on an input waveform file and writes it out to
 
44
another file.  Among other things, it can extract subsections or individual
 
45
channels, resample, rescale, mix down channels, and perform simple filtering
 
46
operations.
 
47
.Pp
45
48
The following option flags are recognized:
46
 
.P
 
49
.Pp
47
50
.Bl -tag -width 4n -offset indent -compact
48
51
.It Fl h
49
52
Options help
50
53
.It Fl itype Ar file type
51
 
Input file type (optional). If set to raw, this indicates that the input file does not have a header. While
52
 
this can be used to specify file types other than raw, this is rarely used for other purposes as the file type of all the existing supported types can be determined automatically from the file's header. If the input file is unheadered, files are assumed to be shorts (16bit).
53
 
Supported types are nist, est, esps, snd, riff, aiff, audlab, raw, ascii .It Fl n Ar channels Number of channels in an unheadered input file
 
54
Input file type (optional). If set to raw, this indicates that the input file
 
55
does not have a header. While this can be used to specify file types other than
 
56
raw, this is rarely used for other purposes as the file type of all the existing
 
57
supported types can be determined automatically from the file's header. If the
 
58
input file is unheadered, files are assumed to be shorts (16bit).
 
59
Supported types are nist, est, esps, snd, riff, aiff, audlab, raw, ascii
 
60
.It Fl n Ar channels Number of channels in an unheadered input file
54
61
.It Fl f Ar sample rate
55
62
Sample rate in Hertz for an unheadered input file
56
63
.It Fl ibo Ar byte order
57
 
Input byte order in an unheadered input file: possibliities are: MSB , LSB, native or nonnative. Suns, HP, SGI Mips, M68000 are MSB (big endian) Intel, Alpha, DEC Mips, Vax are LSB (little endian)
 
64
Input byte order in an unheadered input file: possibliities are: MSB , LSB,
 
65
native or nonnative. Suns, HP, SGI Mips, M68000 are MSB (big endian) Intel,
 
66
Alpha, DEC Mips, Vax are LSB (little endian)
58
67
.It Fl iswap
59
68
Swap bytes. (For use on an unheadered input file)
60
69
.It Fl istype Ar sample type
61
70
Sample type in an unheadered input file: short, alaw, mulaw, byte, ascii
62
71
.It Fl c Ar channel
63
72
Select a single channel (starts from 0).
64
 
Waveforms can have multiple channels. This option extracts a single channel for progcessing and discards the rest.
 
73
Waveforms can have multiple channels. This option extracts a single channel for
 
74
progcessing and discards the rest.
65
75
.It Fl start Ar seconds
66
76
Extract sub-wave starting at this time, specified in seconds
67
77
.It Fl end Ar seconds
73
83
.It Fl o Ar output file
74
84
Output filename. If not specified output is to stdout.
75
85
.It Fl otype Ar file type
76
 
Output file type, (optional). If no type is Specified the type of the input file is assumed.
77
 
Supported types are: nist, est, esps, snd, riff, aiff, audlab, raw, ascii
 
86
Output file type, (optional). If no type is Specified the type of the input file
 
87
is assumed. Supported types are: nist, est, esps, snd, riff, aiff, audlab, raw,
 
88
ascii
78
89
.It Fl F Ar sample rate
79
 
Output sample rate in Hz. If this is different from the input sample rate, resampling will occur
 
90
Output sample rate in Hz. If this is different from the input sample rate,
 
91
resampling will occur
80
92
.It Fl obo Ar byte order
81
 
Output byte order: MSB, LSB, native, or nonnative. Suns, HP, SGI Mips, M68000 are MSB (big endian), Intel, Alpha, DEC Mips, Vax are LSB (little endian)
 
93
Output byte order: MSB, LSB, native, or nonnative. Suns, HP, SGI Mips, M68000
 
94
are MSB (big endian), Intel, Alpha, DEC Mips, Vax are LSB (little endian)
82
95
.It Fl oswap
83
96
Swap bytes when saving to output
84
97
.It Fl ostype Ar sample type
85
98
Output sample type: short, alaw, mulaw, byte or ascii
86
99
.It Fl scale Ar factor
87
 
Scaling factor. Increase or descrease the amplitude of the whole waveform by the factor given (relative to 1.0)
88
 
.It Fl scaleN Ar factor Scaling factor with normalization. The waveform is scaled to its maximum level, after which it is scaled by the factor given (relative to 1.0)
 
100
Scaling factor. Increase or descrease the amplitude of the whole waveform by the
 
101
factor given (relative to 1.0)
 
102
.It Fl scaleN Ar factor Scaling factor with normalization. The waveform is
 
103
scaled to its maximum level, after which it is scaled by the factor given
 
104
(relative to 1.0)
89
105
.It Fl lpfilter Ar frequency
90
 
Low pass filter, with cutoff frequency in Hz Filtering is performed by a FIR filter which is built at run time. The order of the filter can be given by \-forder. The default value is 199
 
106
Low pass filter, with cutoff frequency in Hz Filtering is performed by a FIR
 
107
filter which is built at run time. The order of the filter can be given by
 
108
\-forder. The default value is 199
91
109
.It Fl hpfilter Ar freqency
92
 
High pass filter, with cutoff frequency in Hz Filtering is performed by a FIR filter which is built at run time. The order of the filter can be given by \-forder. The default value is 199.
 
110
High pass filter, with cutoff frequency in Hz Filtering is performed by a FIR
 
111
filter which is built at run time. The order of the filter can be given by
 
112
\-forder. The default value is 199.
93
113
.It Fl forder Ar order
94
 
Order of FIR filter used for lpfilter and hpfilter. This must be ODD. Sensible values range from 19 (quick but with a shallow rolloff) to 199 (slow but with a steep rolloff). The default is 199.
 
114
Order of FIR filter used for lpfilter and hpfilter. This must be ODD. Sensible
 
115
values range from 19 (quick but with a shallow rolloff) to 199 (slow but with a
 
116
steep rolloff). The default is 199.
95
117
.It Fl fafter
96
 
Do filtering after other operations such as resampling (default : filter before other operations)
 
118
Do filtering after other operations such as resampling (default : filter before
 
119
other operations)
97
120
.It Fl info
98
 
Print information about file and header. This option gives useful information such as file length, sampling rate, number of channels etc No output is produced
 
121
Print information about file and header. This option gives useful information
 
122
such as file length, sampling rate, number of channels etc No output is produced
99
123
.It Fl add
100
 
A new single channel waveform is created by adding the corresponding sample points of each input waveform
 
124
A new single channel waveform is created by adding the corresponding sample
 
125
points of each input waveform
101
126
.It Fl pc Ar LONGEST | FIRST
102
 
Combine input waveforms to form a single multichannel waveform. The argument to this option controls how long the new waveform should be. If the option is LONGEST, the output wave if the length of the longest input wave and shorter waves are padded with zeros at the end. If the option is FIRST, the length of the new waveform is the length of the first file on the command line, and subsequent waves are padded or cut to this length
 
127
Combine input waveforms to form a single multichannel waveform. The argument to
 
128
this option controls how long the new waveform should be. If the option is
 
129
LONGEST, the output wave if the length of the longest input wave and shorter
 
130
waves are padded with zeros at the end. If the option is FIRST, the length of
 
131
the new waveform is the length of the first file on the command line, and
 
132
subsequent waves are padded or cut to this length
103
133
.It Fl key Ar keylab file
104
134
Label file designating subsections, for use with
105
135
.Fl divide.
106
 
The KEYLAB file is a label file which specifies where chunks (such as individual sentences) in a waveform begin and end. See section on wave extraction.
 
136
The KEYLAB file is a label file which specifies where chunks (such as individual
 
137
sentences) in a waveform begin and end. See section on wave extraction.
107
138
.It Fl divide
108
 
Divide a single input waveform into multiple output waveforms. Each output waveform is extracted from the input waveform by using the KEYLAB file, which specifies the start and stop times for each chunk. The output files are named according to the filename in the KEYLAB file, with extension given by \-ext. See section on wave extraction
 
139
Divide a single input waveform into multiple output waveforms. Each output
 
140
waveform is extracted from the input waveform by using the KEYLAB file, which
 
141
specifies the start and stop times for each chunk. The output files are named
 
142
according to the filename in the KEYLAB file, with extension given by \-ext.
 
143
See section on wave extraction
109
144
.It Fl ext Ar file extension
110
145
File extension for divided waveforms
111
146
.It Fl extract Ar file
112
 
Used in conjunction with \-key to extract a single section of waveform from the input waveform. The argument is the name of a file given in the file column of the KEYLAB file.
 
147
Used in conjunction with \-key to extract a single section of waveform from the
 
148
input waveform. The argument is the name of a file given in the file column of
 
149
the KEYLAB file.
113
150
.El
114
151
.Sh EXAMPLES
115
152
.Sh BUGS